workos-office / ToolGateway /components.py
dellweb3's picture
Close real-file skill lifecycle and improve readable logs and meeting layout
287e3a1 verified
Raw History Blame Contribute Delete
11.5 kB
"""Registered file skills and environment-aware component provisioning."""
import hashlib,importlib,importlib.util,io,json,os,re,subprocess,sys,threading,uuid
from pathlib import Path
from datetime import datetime,timezone
from sqlalchemy import select
from APIGateway.app.errors import GatewayError
from observability import traced
COMPONENT='pdf-delete-pages'
MANIFEST=json.dumps({'runtime':'registered-file-component-v1','component_id':COMPONENT,'version':1},sort_keys=True)
INPUT_SCHEMA={'type':'object','properties':{'attachment_id':{'type':'string','title':'PDF 文件'},'delete_pages':{'type':'string','title':'删除页码','description':'从1开始,例如2,5-7'}},'required':['attachment_id','delete_pages'],'additionalProperties':False}
_install_lock=threading.RLock()
def component_id(code):
return COMPONENT if code==MANIFEST else None
def requested_component(text):
return COMPONENT if re.search(r'pdf',text,re.I) and re.search(r'删除|删去|移除|去掉|delete|remove',text,re.I) and re.search(r'页|page',text,re.I) else None
def page_numbers(value,count):
if isinstance(value,str):
if not value.strip():raise GatewayError(422,'PDF_PAGES_REQUIRED','请填写要删除的页码,例如2,5-7。')
parts=re.split(r'[,,、\s]+',value.strip());numbers=[]
for part in parts:
if re.fullmatch(r'\d+',part):numbers.append(int(part))
elif re.fullmatch(r'\d+\s*[--~至]\s*\d+',part):
a,b=map(int,re.split(r'\s*[--~至]\s*',part))
if b<a or b-a>500:raise GatewayError(422,'PDF_PAGE_RANGE_INVALID','页码范围应从小到大,单次最多500页。')
numbers.extend(range(a,b+1))
else:raise GatewayError(422,'PDF_PAGE_RANGE_INVALID','页码格式不正确,请填写例如2,5-7。')
elif isinstance(value,list) and all(type(x) is int for x in value):numbers=value
else:raise GatewayError(422,'PDF_PAGE_RANGE_INVALID','请填写页码或页码范围。')
if not numbers:raise GatewayError(422,'PDF_PAGES_REQUIRED','至少指定一个删除页码。')
if len(numbers)>500 or any(x<1 or x>count for x in numbers):raise GatewayError(422,'PDF_PAGE_OUT_OF_RANGE',f'文件共有{count}页,请填写1至{count}之间的页码。')
numbers=sorted(set(numbers))
if len(numbers)==count:raise GatewayError(422,'PDF_ALL_PAGES_SELECTED','不能删除全部页面,请至少保留一页。')
return numbers
def delete_pdf(content,pages):
from pypdf import PdfReader,PdfWriter
try:
reader=PdfReader(io.BytesIO(content))
if reader.is_encrypted:raise GatewayError(422,'PDF_ENCRYPTED','此PDF已加密,请上传已解密的文件。')
count=len(reader.pages)
if not 1<=count<=500:raise GatewayError(422,'PDF_PAGE_LIMIT','当前技能支持1至500页PDF。')
deleted=page_numbers(pages,count);writer=PdfWriter()
for index,page in enumerate(reader.pages,1):
if index not in deleted:writer.add_page(page)
out=io.BytesIO();writer.write(out);data=out.getvalue()
if len(PdfReader(io.BytesIO(data)).pages)!=count-len(deleted):raise ValueError('Output page count mismatch')
return data,{'original_pages':count,'remaining_pages':count-len(deleted),'deleted_pages':deleted}
except GatewayError:raise
except Exception as exc:raise GatewayError(422,'PDF_INVALID','文件不是可读取的PDF,或文件已损坏;原始文件未修改。') from exc
class Components:
def __init__(self,providers):self.p=providers;self.Session=providers.workspace.Session
def mode(self):return os.getenv('WORKOS_DEPENDENCY_MODE','external' if os.getenv('WORKOS_PUBLIC_DEMO')=='1' else 'intranet')
def request(self,user,reason,component=COMPONENT,package='pypdf',version='6.10.0',requirement=None):
from CollaborationService.models import OrganizationAudit
with self.Session.begin() as db:
rows=db.scalars(select(OrganizationAudit).where(OrganizationAudit.tenant==user['tenant_id'],OrganizationAudit.action=='dependency.request'))
old=next((r for r in rows if r.actor==user['user_id'] and r.detail.get('component_id')==component and r.detail.get('status')=='pending'),None)
if old:return {'request_id':old.id,**old.detail}
detail={'component_id':component,'package':package,'version':version,'status':'pending','environment':self.mode(),'reason':reason,'requirement':requirement or 'PDF页面删除,需要读取真实附件并输出修改后的PDF','installation':('在受控容器中安装 '+package+'=='+version+',安装后重试组件检查。') if package else '补齐此文件操作适配器,并用实际文件验收输入和输出后再启用。'}
row=OrganizationAudit(id='dependency-'+uuid.uuid4().hex[:20],tenant=user['tenant_id'],actor=user['user_id'],group_id=COMPONENT,action='dependency.request',detail=detail,created_at=datetime.now(timezone.utc).isoformat());db.add(row);return {'request_id':row.id,**detail}
def requests(self,user,admin=False):
from CollaborationService.models import OrganizationAudit
if admin:self.p.organization.admin(user)
with self.Session() as db:
rows=db.scalars(select(OrganizationAudit).where(OrganizationAudit.tenant==user['tenant_id'],OrganizationAudit.action=='dependency.request').order_by(OrganizationAudit.created_at.desc()))
return {'environment':self.mode(),'items':[{'request_id':r.id,'owner_user_id':r.actor,'created_at':r.created_at,**r.detail} for r in rows if admin or r.actor==user['user_id']]}
def ready(self,user,source):
from CollaborationService.models import OrganizationAudit
with self.Session.begin() as db:
rows=db.scalars(select(OrganizationAudit).where(OrganizationAudit.tenant==user['tenant_id'],OrganizationAudit.action=='dependency.request'))
for row in rows:
if row.detail.get('component_id')==COMPONENT and row.detail.get('status')=='pending':row.detail={**row.detail,'status':'resolved','resolved_at':datetime.now(timezone.utc).isoformat(),'resolution':'组件已检测可用,可重新试运行技能。'}
return {'component_id':COMPONENT,'package':'pypdf','status':'ready','source':source,'environment':self.mode()}
@traced('Tool Gateway','check or provision file component')
def ensure(self,user):
if importlib.util.find_spec('pypdf'):return self.ready(user,'local-container')
if self.mode()=='external':
with _install_lock:
if importlib.util.find_spec('pypdf'):return self.ready(user,'local-container')
target=Path(os.getenv('WORKOS_COMPONENT_DIR',str(Path(os.getenv('WORKOS_WORKSPACE_DATA_DIR','/tmp/workos-components')).parent/'workos-components'))).resolve();target.mkdir(parents=True,exist_ok=True)
try:
result=subprocess.run([sys.executable,'-m','pip','install','--no-deps','--only-binary=:all:','--disable-pip-version-check','--index-url','https://pypi.org/simple','--target',str(target),'pypdf==6.10.0'],capture_output=True,timeout=90,check=False)
if result.returncode:raise ValueError('Install failed')
if str(target) not in sys.path:sys.path.insert(0,str(target))
importlib.invalidate_caches()
if not importlib.util.find_spec('pypdf'):raise ValueError('Module unavailable')
return self.ready(user,'installed-from-pypi')
except (OSError,ValueError,subprocess.SubprocessError):reason='外网自动安装未完成,已生成组件需求单。'
else:reason='内网环境未发现PDF组件,不访问外网,已生成安装需求单。'
return {'component_id':COMPONENT,'status':'dependency_required','request':self.request(user,reason),'environment':self.mode()}
def self_test(self,user):
dependency=self.ensure(user)
if dependency['status']!='ready':return {'passed':False,'cases':[],'runtime':'registered-file-component-v1','component_id':COMPONENT,'dependency':dependency,'error':dependency['request']['reason']}
from pypdf import PdfWriter,PdfReader
writer=PdfWriter()
for _ in range(4):writer.add_blank_page(width=300,height=400)
stream=io.BytesIO();writer.write(stream);raw=stream.getvalue();cases=[]
for pages,expected in [('2,4',2),('2-3',2),([2,2],3)]:
result,meta=delete_pdf(raw,pages);cases.append({'input':{'pages':pages},'expected':{'remaining_pages':expected},'passed':len(PdfReader(io.BytesIO(result)).pages)==expected})
for pages in ['0','5','1-4','abc']:
try:delete_pdf(raw,pages);passed=False
except GatewayError:passed=True
cases.append({'input':{'pages':pages},'expected':'validation error','passed':passed})
return {'passed':all(c['passed'] for c in cases),'cases':cases,'runtime':'registered-file-component-v1','component_id':COMPONENT,'dependency':dependency,'input_schema':INPUT_SCHEMA,'limitations':'原PDF保留;页码从1开始,单次最多500页,不接受加密PDF;试验实际文件后才能申请发布。'}
def program(self,code,user,wid):
if not component_id(code):raise GatewayError(422,'COMPONENT_NOT_REGISTERED','组件未登记。')
manager=self
class FileProgram:
runtime='registered-file-component-v1'
def run(self,data):return manager.execute(user,wid,data)
return FileProgram()
@traced('Internal Tool','delete real PDF pages and save output')
def execute(self,user,wid,data):
if not isinstance(data,dict) or set(data)-{'attachment_id','delete_pages'}:raise GatewayError(422,'PDF_INPUT_INVALID','PDF技能只接受文件编号和删除页码。')
aid=data.get('attachment_id')
if not isinstance(aid,str) or not aid:raise GatewayError(422,'PDF_FILE_REQUIRED','请先选择或上传PDF文件。')
info=self.p.workspace.attachment_info(user,aid)
if info['workspace_id']!=wid:raise GatewayError(404,'RESOURCE_NOT_FOUND','文件不属于当前对话。')
if not info['filename'].lower().endswith('.pdf'):raise GatewayError(415,'PDF_FILE_REQUIRED','此技能只接受真实PDF文件。')
dependency=self.ensure(user)
if dependency['status']!='ready':raise GatewayError(409,'COMPONENT_DEPENDENCY_REQUIRED',dependency['request']['reason'],dependency)
original=self.p.workspace.attachment_content(user,aid);result,meta=delete_pdf(original,data.get('delete_pages'))
from OfficeService.service import GeneratedFile
identity='pdf-edit-'+uuid.uuid4().hex[:24];name=Path(info['filename']).stem[:180]+'-已删除指定页.pdf'
with self.Session.begin() as db:
db.add(GeneratedFile(id=identity,tenant=user['tenant_id'],owner=user['user_id'],workspace=wid,run_id='component-'+identity,artifact_id='',artifact_version=1,filename=name,content_hash=hashlib.sha256(result).hexdigest(),content=result))
return {**meta,'file':{'file_id':identity,'filename':name,'content_hash':hashlib.sha256(result).hexdigest()},'source_attachment_id':aid,'source_unchanged':hashlib.sha256(self.p.workspace.attachment_content(user,aid)).hexdigest()==info['sha256'],'dependency':dependency,'message':f'已删除{len(meta["deleted_pages"])}页,剩余{meta["remaining_pages"]}页。原始文件已保留,可下载处理后的PDF。'}