zms.ZMSFilterManager.ZMSFilterManager

class documentation

class ZMSFilterManager(ZMSItem.ZMSItem): (source)

Constructor: ZMSFilterManager(filters, processes)

Implements interfaces: Products.zms.IZMSConfigurationProvider.IZMSConfigurationProvider, Products.zms.IZMSRepositoryProvider.IZMSRepositoryProvider

View In Hierarchy

Manage reusable content filters and their executable process chains.

The filter manager persists local filter definitions, optional uploaded process assets, and repository import/export payloads used for sync.

Method	`__init__`	Initialize the manager from serialized filters and processes.
Method	`delFilter`	Delete a filter definition and its uploaded assets.
Method	`delFilterProcess`	Remove a process from a filter and renumber stored assets.
Method	`delProcess`	Delete a process definition and its backing Zope object.
Method	`exportXml`	Export selected filters and processes as an XML download.
Method	`getFilter`	Return a filter definition, falling back to the portal master.
Method	`getFilterIds`	Return the available filter ids, including acquired ones.
Method	`getFilterProcesses`	Return process definitions attached to a filter.
Method	`getProcess`	Return a process definition, falling back to the portal master.
Method	`getProcessIds`	Return the available process ids, including acquired ones.
Method	`importXml`	Import one or more filter manager entries from XML data.
Method	`manage_changeFilter`	Handle ZMI actions for filters and filter-process assignments.
Method	`manage_changeProcess`	Handle ZMI actions for creating, editing, and deleting processes.
Method	`manage_options`	Return parent management tabs with local relative actions.
Method	`manage_sub_options`	Return the filter manager sub tabs shown in the ZMI.
Method	`moveFilterProcess`	Move a filter process to a new position in the pipeline.
Method	`provideRepository`	Build a repository export mapping for filters and processes.
Method	`setFilter`	Create or update a filter definition.
Method	`setFilterProcess`	Append a process to a filter and persist its optional file asset.
Method	`setProcess`	Create or update an executable process definition.
Method	`updateRepository`	Apply one repository item to the local filter manager state.
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__administratorPermissions__`	Undocumented
Class Variable	`manage`	Undocumented
Class Variable	`manage_main`	Undocumented
Class Variable	`manage_options_default_action`	Undocumented
Class Variable	`manage_sub_options__roles__`	Undocumented
Class Variable	`meta_type`	Undocumented
Class Variable	`zmi_icon`	Undocumented
Instance Variable	`filters`	Undocumented
Instance Variable	`id`	Undocumented
Instance Variable	`processes`	Undocumented
Method	`_importXml`	Import a single parsed XML item.

def __init__(self, filters={}, processes={}): (source) ¶

Initialize the manager from serialized filters and processes.

Parameters
filters:`list`	Persisted filter definitions.
processes:`list`	Persisted process definitions.

def delFilter(self, id): (source) ¶

Delete a filter definition and its uploaded assets.

Parameters
id:`str`	Filter identifier.
Returns
`str`	Empty string for legacy callers.

def delFilterProcess(self, id, index): (source) ¶

Remove a process from a filter and renumber stored assets.

Parameters
id:`str`	Filter identifier.
index:`int`	Process position to remove.
Returns
`int`	Legacy sentinel value.

def delProcess(self, id): (source) ¶

Delete a process definition and its backing Zope object.

Parameters
id:`str`	Process identifier.
Returns
`str`	Empty string for legacy callers.

def exportXml(self, REQUEST, RESPONSE): (source) ¶

Export selected filters and processes as an XML download.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
RESPONSE:`ZPublisher.HTTPResponse`	The active HTTP response.
Returns
`str`	Serialized XML export data.

def getFilter(self, id): (source) ¶

Return a filter definition, falling back to the portal master.

Parameters
id:`str`	Filter identifier.
Returns
`dict`	Filter metadata.

def getFilterIds(self, sort=True): (source) ¶

Return the available filter ids, including acquired ones.

Parameters
sort:`bool`	Sort by display name when true.
Returns
`list`	Filter ids.

def getFilterProcesses(self, id): (source) ¶

Return process definitions attached to a filter.

Parameters
id:`str`	Filter identifier.
Returns
`list`	Filter process descriptors with optional uploaded files.

def getProcess(self, id): (source) ¶

Return a process definition, falling back to the portal master.

Parameters
id:`str`	Process identifier.
Returns
`dict`	Process metadata and synchronized command data.

def getProcessIds(self, sort=True): (source) ¶

Return the available process ids, including acquired ones.

Parameters
sort:`bool`	Sort by display name when true.
Returns
`list`	Process ids.

def importXml(self, xml): (source) ¶

Import one or more filter manager entries from XML data.

Parameters
xml:`str`	XML string or uploaded file-like object.

def manage_changeFilter(self, lang, btn='', key='', REQUEST=None, RESPONSE=None): (source) ¶

Handle ZMI actions for filters and filter-process assignments.

Parameters
lang:`str`	Active UI language.
btn:`str`	Submitted button id.
key:`str`	Secondary action key.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
RESPONSE:`ZPublisher.HTTPResponse`	The active HTTP response.
Returns
`object`	Redirect response or export payload.

def manage_changeProcess(self, lang, btn='', key='', REQUEST=None, RESPONSE=None): (source) ¶

Handle ZMI actions for creating, editing, and deleting processes.

Parameters
lang:`str`	Active UI language.
btn:`str`	Submitted button id.
key:`str`	Secondary action key.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
RESPONSE:`ZPublisher.HTTPResponse`	The active HTTP response.
Returns
`object`	Redirect response or export payload.

def manage_options(self): (source) ¶

Return parent management tabs with local relative actions.

def manage_sub_options(self): (source) ¶

Return the filter manager sub tabs shown in the ZMI.

def moveFilterProcess(self, id, index, pos): (source) ¶

Move a filter process to a new position in the pipeline.

Parameters
id:`str`	Filter identifier.
index:`int`	Current process position.
pos:`int`	Target process position.
Returns
`int`	The new position.

def provideRepository(self, r, ids=None): (source) ¶

Build a repository export mapping for filters and processes.

Parameters
r:`dict`	Repository accumulator passed by the caller.
ids:`list`	Optional subset of ids to export.
Returns
`dict`	Repository data keyed by object id.

def setFilter(self, oldId, newId, newAcquired=0, newName='', newFormat='', newContentType='', newDescription='', newRoles=[], newMetaTypes=[]): (source) ¶

Create or update a filter definition.

Parameters
oldId:`str`	Existing filter id to replace.
newId:`str`	Target filter id.
newAcquired:`int`	Whether the filter is acquired from a master portal.
newName:`str`	Display name.
newFormat:`str`	Filter input format.
newContentType:`str`	Filter output content type.
newDescription:`str`	Descriptive help text.
newRoles:`list`	Allowed roles.
newMetaTypes:`list`	Supported content meta types.
Returns
`str`	The persisted filter id.

def setFilterProcess(self, id, index, newProcessId, newProcessFile=None): (source) ¶

Append a process to a filter and persist its optional file asset.

Parameters
id:`str`	Filter identifier.
index:`int`	Process position inside the filter pipeline.
newProcessId:`str`	Linked process id.
newProcessFile:`_blobfields.MyBlob`	Optional uploaded process file.
Returns
`int`	The appended process index.

def setProcess(self, oldId, newId, newAcquired=0, newName='', newType='process', newCommand=None): (source) ¶

Create or update an executable process definition.

Parameters
oldId:`str`	Existing process id to replace.
newId:`str`	Target process id.
newAcquired:`int`	Whether the process is acquired from a master portal.
newName:`str`	Display name.
newType:`str`	Backing Zope object type.
newCommand:`object`	Source text or uploaded blob for the process.
Returns
`str`	The persisted process id.