[CMF-checkins] CVS: CMF - CHANGES.txt:1.1 ContainerTab.py:1.1 DCWorkflow.py:1.1 Default.py:1.1 Expression.py:1.1 Guard.py:1.1 README.txt:1.1 Scripts.py:1.1 States.py:1.1 Transitions.py:1.1 Variables.py:1.1 WorkflowUIMixin.py:1.1 Worklists.py:1.1 __init__.py:1.1 refresh.txt:1.1 utils.py:1.1 version.txt:1.1
shane@digicool.com
shane@digicool.com
Mon, 11 Jun 2001 15:33:50 -0400 (EDT)
Update of /cvs-repository/CMF/DCWorkflow
In directory korak.digicool.com:/tmp/cvs-serv30200
Added Files:
CHANGES.txt ContainerTab.py DCWorkflow.py Default.py
Expression.py Guard.py README.txt Scripts.py States.py
Transitions.py Variables.py WorkflowUIMixin.py Worklists.py
__init__.py refresh.txt utils.py version.txt
Log Message:
Added DCWorkflow product to public CVS.
--- Added File CHANGES.txt in package CMF ---
Version 0.2
- As suggested by Seb Bacon, simplified by making transitions trigger on
their own IDs. Thanks!
- Added script invocation just before execution of a transition. Scripts
are passed an expression namespace as the first parameter.
- Replaced the name "action_or_method" with "transition".
Version 0.1
- Initial release.
--- Added File ContainerTab.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
A convenient base class for representing a container as a management tab.
$Id: ContainerTab.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from OFS.Folder import Folder
from OFS.SimpleItem import Item_w__name__
from Acquisition import aq_base, aq_inner, aq_parent
_marker = [] # Create a new marker object.
class ContainerTab (Folder):
def __init__(self, id):
self.id = id
self._mapping = {}
def getId(self):
return self.id
def manage_options(self):
parent = aq_parent(aq_inner(self))
res = []
options = parent.manage_options
if callable(options):
options = options()
for item in options:
item = item.copy()
item['action'] = '../' + item['action']
res.append(item)
return res
def manage_workspace(self, RESPONSE):
'''
Redirects to the primary option.
'''
RESPONSE.redirect(self.absolute_url() + '/manage_main')
def _checkId(self, id, allow_dup=0):
if not allow_dup:
if self._mapping.has_key(id):
raise 'Bad Request', 'The id "%s" is already in use.' % id
return Folder._checkId(self, id, allow_dup)
def _getOb(self, name, default=_marker):
mapping = self._mapping
if mapping.has_key(name):
res = mapping[name]
if hasattr(res, '__of__'):
res = res.__of__(self)
return res
else:
if default is _marker:
raise KeyError, name
return default
def _setOb(self, name, value):
mapping = self._mapping
mapping[name] = aq_base(value)
self._mapping = mapping # Trigger persistence.
def _delOb(self, name):
mapping = self._mapping
del mapping[name]
self._mapping = mapping # Trigger persistence.
def get(self, name, default=None):
if self._mapping.has_key(name):
return self[name]
else:
return default
def objectIds(self, spec=None):
# spec is not important for now...
return self._mapping.keys()
def keys(self):
return self._mapping.keys()
def items(self):
return map(lambda id, self=self: (id, self._getOb(id)),
self._mapping.keys())
def values(self):
return map(lambda id, self=self: self._getOb(id),
self._mapping.keys())
def manage_renameObjects(self, ids=[], new_ids=[], REQUEST=None):
"""Rename several sub-objects"""
if len(ids) != len(new_ids):
raise 'Bad Request', 'Please rename each listed object.'
for i in range(len(ids)):
if ids[i] != new_ids[i]:
self.manage_renameObject(ids[i], new_ids[i])
if REQUEST is not None:
return self.manage_main(REQUEST)
return None
--- Added File DCWorkflow.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Web-configurable workflow.
$Id: DCWorkflow.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
# Python library
from string import join
# Zope
from ZODB import Persistent
from AccessControl import getSecurityManager, ClassSecurityInfo
from OFS.Folder import Folder
from OFS.ObjectManager import bad_id
from OFS.Traversable import Traversable
from Globals import DTMLFile, PersistentMapping
import Acquisition
from Acquisition import aq_inner, aq_parent
import Globals
import App
from DocumentTemplate.DT_Util import TemplateDict
# CMFCore
from Products.CMFCore.WorkflowCore import WorkflowException
from Products.CMFCore.WorkflowTool import addWorkflowClass
from Products.CMFCore.CMFCorePermissions import ManagePortal
from Products.CMFCore.utils import getToolByName
# DCWorkflow
from utils import _dtmldir, modifyRolesForPermission
from WorkflowUIMixin import WorkflowUIMixin
from Transitions import TRIGGER_AUTOMATIC, TRIGGER_USER_ACTION, \
TRIGGER_WORKFLOW_METHOD
from Expression import exprNamespace
Unauthorized = 'Unauthorized'
def checkId(id):
res = bad_id(id)
if res != -1 and res is not None:
raise ValueError, 'Illegal ID'
return 1
class DCWorkflowDefinition (WorkflowUIMixin, Folder):
'''
This class is the workflow engine and the container for the
workflow definition.
UI methods are in WorkflowUIMixin.
'''
meta_type = 'Workflow'
title = 'DC Workflow Definition'
id = 'dc_workflow'
_isAWorkflow = 1
state_var = 'state'
initial_state = None
states = None
transitions = None
vars = None
worklists = None
scripts = None
permissions = ()
manage_options = (
{'label': 'Properties', 'action': 'manage_properties'},
{'label': 'States', 'action': 'states/manage_main'},
{'label': 'Transitions', 'action': 'transitions/manage_main'},
{'label': 'Variables', 'action': 'variables/manage_main'},
{'label': 'Worklists', 'action': 'worklists/manage_main'},
{'label': 'Scripts', 'action': 'scripts/manage_main'},
{'label': 'Permissions', 'action': 'manage_permissions'},
) + App.Undo.UndoSupport.manage_options
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
def __init__(self, id):
self.id = id
from States import States
self._addObject(States('states'))
from Transitions import Transitions
self._addObject(Transitions('transitions'))
from Variables import Variables
self._addObject(Variables('variables'))
from Worklists import Worklists
self._addObject(Worklists('worklists'))
from Scripts import Scripts
self._addObject(Scripts('scripts'))
def _addObject(self, ob):
id = ob.getId()
setattr(self, id, ob)
self._objects = self._objects + (
{'id': id, 'meta_type': ob.meta_type},)
#
# Workflow engine.
#
def _getStatusOf(self, ob):
tool = aq_parent(aq_inner(self))
status = tool.getStatusOf(self.id, ob)
if status is None:
return {}
else:
return status
def _getWorkflowStateOf(self, ob, id_only=0):
tool = aq_parent(aq_inner(self))
status = tool.getStatusOf(self.id, ob)
if status is None:
state = self.initial_state
else:
state = status.get(self.state_var, None)
if state is None:
state = self.initial_state
if id_only:
return state
else:
return self.states.get(state, None)
def _getPortalRoot(self):
return aq_parent(aq_inner(aq_parent(aq_inner(self))))
security.declarePrivate('getCatalogVariablesFor')
def getCatalogVariablesFor(self, ob):
'''
Allows this workflow to make workflow-specific variables
available to the catalog, making it possible to implement
worklists in a simple way.
Returns a mapping containing the catalog variables
that apply to ob.
'''
res = {}
status = self._getStatusOf(ob)
for id, vdef in self.variables.items():
if vdef.for_catalog:
if status.has_key(id):
value = status[id]
# Not set yet. Use a default.
elif vdef.default_expr is not None:
md = exprNamespace(ob, self, status)
value = vdef.default_expr(md)
else:
value = vdef.default_value
res[id] = value
# Always provide the state variable.
state_var = self.state_var
res[state_var] = status.get(state_var, self.initial_state)
return res
security.declarePrivate('listObjectActions')
def listObjectActions(self, info):
'''
Allows this workflow to
include actions to be displayed in the actions box.
Called only when this workflow is applicable to
info.content.
Returns the actions to be displayed to the user.
'''
ob = info.content
sdef = self._getWorkflowStateOf(ob)
if sdef is None:
return None
sm = getSecurityManager()
res = []
for tid in sdef.transitions:
tdef = self.transitions.get(tid, None)
if tdef is not None and tdef.trigger_type == TRIGGER_USER_ACTION:
if tdef.actbox_name:
if self._checkTransitionGuard(tdef, ob):
res.append((tid, {
'name': tdef.actbox_name % info,
'url': tdef.actbox_url % info,
'permissions': (), # Predetermined.
'category': tdef.actbox_category}))
res.sort()
return map((lambda (id, val): val), res)
security.declarePrivate('listGlobalActions')
def listGlobalActions(self, info):
'''
Allows this workflow to
include actions to be displayed in the actions box.
Called on every request.
Returns the actions to be displayed to the user.
'''
if not self.worklists:
return None # Optimization
sm = getSecurityManager()
portal = self._getPortalRoot()
res = []
fmt_data = None
for id, qdef in self.worklists.items():
if qdef.actbox_name:
guard = qdef.guard
if guard is None or guard.check(sm, self, portal):
searchres = None
if qdef.var_matches:
# Check the catalog for items in the worklist.
catalog = getToolByName(self, 'portal_catalog')
dict = {}
for k, v in qdef.var_matches.items():
dict[k] = v
searchres = apply(catalog.searchResults, (), dict)
if not searchres:
continue
if fmt_data is None:
fmt_data = TemplateDict()
fmt_data._push(info)
searchres_len = lambda searchres=searchres: len(searchres)
fmt_data._push({'count': searchres_len})
res.append((id, {'name': qdef.actbox_name % fmt_data,
'url': qdef.actbox_url % fmt_data,
'permissions': (), # Predetermined.
'category': qdef.actbox_category}))
fmt_data._pop()
res.sort()
return map((lambda (id, val): val), res)
security.declarePrivate('isActionSupported')
def isActionSupported(self, ob, action):
'''
Returns a true value if the given action name
is possible in the current state.
'''
sdef = self._getWorkflowStateOf(ob)
if sdef is None:
return 0
if action in sdef.transitions:
tdef = self.transitions.get(action, None)
if (tdef is not None and
tdef.trigger_type == TRIGGER_USER_ACTION and
self._checkTransitionGuard(tdef, ob)):
return 1
return 0
security.declarePrivate('doActionFor')
def doActionFor(self, ob, action, **kw):
'''
Allows the user to request a workflow action. This method
must perform its own security checks.
'''
sdef = self._getWorkflowStateOf(ob)
if sdef is None:
raise WorkflowException, 'Object is in an undefined state'
if action not in sdef.transitions:
raise Unauthorized
tdef = self.transitions.get(action, None)
if tdef is None or tdef.trigger_type != TRIGGER_USER_ACTION:
raise WorkflowException, (
'Transition %s is not triggered by a user action' % action)
if not self._checkTransitionGuard(tdef, ob):
raise Unauthorized
self._changeStateOf(ob, tdef, kw)
security.declarePrivate('isWorkflowMethodSupported')
def isWorkflowMethodSupported(self, ob, method_id):
'''
Returns a true value if the given workflow method
is supported in the current state.
'''
sdef = self._getWorkflowStateOf(ob)
if sdef is None:
return 0
if method_id in sdef.transitions:
tdef = self.transitions.get(method_id, None)
if (tdef is not None and
tdef.trigger_type == TRIGGER_WORKFLOW_METHOD and
self._checkTransitionGuard(tdef, ob)):
return 1
return 0
security.declarePrivate('wrapWorkflowMethod')
def wrapWorkflowMethod(self, ob, method_id, func, args, kw):
'''
Allows the user to request a workflow action. This method
must perform its own security checks.
'''
sdef = self._getWorkflowStateOf(ob)
if sdef is None:
raise WorkflowException, 'Object is in an undefined state'
if method_id not in sdef.transitions:
raise Unauthorized
tdef = self.transitions.get(method_id, None)
if tdef is None or tdef.trigger_type != TRIGGER_WORKFLOW_METHOD:
raise WorkflowException, (
'Transition %s is not triggered by a workflow method'
% method_id)
if not self._checkTransitionGuard(tdef, ob):
raise Unauthorized
res = apply(func, args, kw)
self._changeStateOf(ob, tdef)
security.declarePrivate('isInfoSupported')
def isInfoSupported(self, ob, name):
'''
Returns a true value if the given info name is supported.
'''
if name == self.state_var:
return 1
vdef = self.variables.get(name, None)
if vdef is None:
return 0
return 1
security.declarePrivate('getInfoFor')
def getInfoFor(self, ob, name, default):
'''
Allows the user to request information provided by the
workflow. This method must perform its own security checks.
'''
if name == self.state_var:
return self._getWorkflowStateOf(ob, 1)
vdef = self.variables[name]
if vdef.info_guard is not None and not vdef.info_guard.check(
getSecurityManager(), self, ob):
return default
status = self._getStatusOf(ob)
if status is not None and status.has_key(id):
value = status[id]
# Not set yet. Use a default.
elif vdef.default_expr is not None:
md = exprNamespace(ob, self, status)
value = vdef.default_expr(md)
else:
value = vdef.default_value
return value
security.declarePrivate('notifyCreated')
def notifyCreated(self, ob):
'''
Notifies this workflow after an object has been created
and put in its new place.
'''
self._changeStateOf(ob, None)
security.declarePrivate('notifyBefore')
def notifyBefore(self, ob, action):
'''
Notifies this workflow of an action before it happens,
allowing veto by exception. Unless an exception is thrown, either
a notifySuccess() or notifyException() can be expected later on.
The action usually corresponds to a method name.
'''
pass
security.declarePrivate('notifySuccess')
def notifySuccess(self, ob, action, result):
'''
Notifies this workflow that an action has taken place.
'''
pass
security.declarePrivate('notifyException')
def notifyException(self, ob, action, exc):
'''
Notifies this workflow that an action failed.
'''
pass
def _checkTransitionGuard(self, t, ob):
guard = t.guard
if guard is None:
return 1
if guard.check(getSecurityManager(), self, ob):
return 1
return 0
def _changeStateOf(self, ob, tdef=None, kwargs=None):
'''
Changes state. Can execute multiple transitions if there are
automatic transitions. tdef set to None means the object
was just created.
'''
while 1:
sdef = self._executeTransition(ob, tdef, kwargs)
if sdef is None:
break
tdef = None
for tid in sdef.transitions:
t = self.transitions.get(tid, None)
if t is not None and t.trigger_type == TRIGGER_AUTOMATIC:
if self._checkTransitionGuard(t, ob):
tdef = t
break
if tdef is None:
# No more automatic transitions.
break
# Else continue.
def _executeTransition(self, ob, tdef=None, kwargs=None):
'''
Private method.
Puts object in a new state.
'''
if tdef is None:
state = self.initial_state
former_status = {}
action = ''
else:
state = tdef.new_state_id
if not state:
# Stay in same state.
state = self._getWorkflowStateOf(ob, 1)
former_status = self._getStatusOf(ob)
action = tdef.id
# Execute a script if specified.
if tdef.script_name:
script = self.scripts[tdef.script_name]
# Pass lots of info to the script in a single parameter.
md = exprNamespace(ob, self, former_status,
action, state, kwargs)
script(md) # May throw an exception.
sdef = self.states.get(state, None)
if sdef is None:
raise WorkflowException, 'Destination state undefined: ' + state
# Update variables.
state_values = sdef.var_values
if state_values is None: state_values = {}
tdef_exprs = None
if tdef is not None: tdef_exprs = tdef.var_exprs
if tdef_exprs is None: tdef_exprs = {}
status = {}
for id, vdef in self.variables.items():
if not vdef.for_status:
continue
if state_values.has_key(id):
value = state_values[id]
elif tdef_exprs.has_key(id):
md = exprNamespace(ob, self, former_status,
action, state, kwargs)
value = tdef_exprs[id](md)
elif vdef.default_expr is not None:
md = exprNamespace(ob, self, former_status,
action, state, kwargs)
value = vdef.default_expr(md)
else:
value = vdef.default_value
status[id] = value
# Update role to permission assignments.
if self.permissions:
for p in self.permissions:
roles = []
if sdef.permission_roles is not None:
roles = sdef.permission_roles.get(p, roles)
modifyRolesForPermission(ob, p, roles)
# Update state.
status[self.state_var] = state
tool = aq_parent(aq_inner(self))
tool.setStatusOf(self.id, ob, status)
return sdef
Globals.InitializeClass(DCWorkflowDefinition)
addWorkflowClass(DCWorkflowDefinition)
--- Added File Default.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Programmatically creates a workflow.
$Id: Default.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from Products.DCWorkflow.DCWorkflow import DCWorkflowDefinition
p_access = 'Access contents information'
p_modify = 'Modify portal content'
p_view = 'View'
p_review = 'Review portal content'
p_request = 'Request review'
r_anon = 'Anonymous'
r_manager = 'Manager'
r_reviewer = 'Reviewer'
r_owner = 'Owner'
r_member = 'Member'
def setupDefaultWorkflow(wf):
'''
wf is a DCWorkflow instance.
'''
wf.setProperties(title='CMF default workflow rev 2')
for s in ('private', 'visible', 'pending', 'published'):
wf.states.addState(s)
for t in ('publish', 'reject', 'retract', 'submit', 'hide', 'show'):
wf.transitions.addTransition(t)
for v in ('action', 'actor', 'comments', 'review_history', 'time'):
wf.variables.addVariable(v)
for l in ('reviewer_queue',):
wf.worklists.addWorklist(l)
for p in (p_access, p_modify, p_view):
wf.addManagedPermission(p)
wf.states.setInitialState('visible')
sdef = wf.states['private']
sdef.setProperties(
title='Visible and editable only by owner',
transitions=('show',))
sdef.setPermission(p_access, 0, (r_manager, r_owner))
sdef.setPermission(p_view, 0, (r_manager, r_owner))
sdef.setPermission(p_modify, 0, (r_manager, r_owner))
sdef = wf.states['pending']
sdef.setProperties(
title='Waiting for reviewer',
transitions=('hide', 'publish', 'reject', 'retract',))
sdef.setPermission(p_access, 1, (r_anon, r_manager, r_reviewer))
sdef.setPermission(p_view, 1, (r_anon, r_manager, r_reviewer))
sdef.setPermission(p_modify, 0, (r_manager, r_reviewer))
sdef = wf.states['published']
sdef.setProperties(
title='Public',
transitions=('reject', 'retract',))
sdef.setPermission(p_access, 1, (r_anon, r_manager))
sdef.setPermission(p_view, 1, (r_anon, r_manager))
sdef.setPermission(p_modify, 0, (r_manager))
sdef = wf.states['visible']
sdef.setProperties(
title='Visible but not published',
transitions=('hide', 'publish', 'submit',))
sdef.setPermission(p_access, 1, (r_anon, r_manager, r_reviewer))
sdef.setPermission(p_view, 1, (r_anon, r_manager, r_reviewer))
sdef.setPermission(p_modify, 0, (r_manager, r_owner))
tdef = wf.transitions['hide']
tdef.setProperties(
title='Member makes content private',
new_state_id='private',
actbox_name='Make private',
actbox_url='%(content_url)s/content_hide_form',
props={'guard_roles':r_owner})
tdef = wf.transitions['publish']
tdef.setProperties(
title='Reviewer publishes content',
new_state_id='published',
actbox_name='Publish',
actbox_url='%(content_url)s/content_publish_form',
props={'guard_permissions':p_review})
tdef = wf.transitions['reject']
tdef.setProperties(
title='Reviewer rejects submission',
new_state_id='visible',
actbox_name='Reject',
actbox_url='%(content_url)s/content_reject_form',
props={'guard_permissions':p_review})
tdef = wf.transitions['retract']
tdef.setProperties(
title='Member retracts submission',
new_state_id='visible',
actbox_name='Retract',
actbox_url='%(content_url)s/content_retract_form',
props={'guard_permissions':p_request})
tdef = wf.transitions['show']
tdef.setProperties(
title='Member makes content visible',
new_state_id='visible',
actbox_name='Make visible',
actbox_url='%(content_url)s/content_show_form',
props={'guard_roles':r_owner})
tdef = wf.transitions['submit']
tdef.setProperties(
title='Member requests publishing',
new_state_id='pending',
actbox_name='Submit',
actbox_url='%(content_url)s/content_submit_form',
props={'guard_permissions':p_request})
wf.variables.setStateVar('review_state')
vdef = wf.variables['action']
vdef.setProperties(description='The last transition',
default_expr='transition',
for_status=1)
vdef = wf.variables['actor']
vdef.setProperties(description='The ID of the user who performed '
'the last transition',
default_expr='_.SecurityGetUser().getUserName()',
for_status=1)
vdef = wf.variables['comments']
vdef.setProperties(description='Comments about the last transition',
default_expr="kwargs.get('comment', '')",
for_status=1)
vdef = wf.variables['review_history']
vdef.setProperties(description='Provides access to workflow history',
default_expr="getHistory()",
props={'guard_permissions':
p_request + ';' + p_review})
vdef = wf.variables['time']
vdef.setProperties(description='Time of the last transition',
default_expr="_.DateTime()",
for_status=1)
ldef = wf.worklists['reviewer_queue']
ldef.setProperties(description='Reviewer tasks',
actbox_name='Pending (%(count)d)',
actbox_url='%(portal_url)s/search?review_state=pending',
props={'var_match_review_state':'pending',
'guard_permissions':p_review})
def manage_addDefaultWorkflow(self):
'''
'''
ob = DCWorkflowDefinition('default_workflow_rev2')
self._setObject(ob.id, ob)
setupDefaultWorkflow(self.this()._getOb(ob.id))
return self.manage_main(self, self.REQUEST)
--- Added File Expression.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Expressions in a web-configurable workflow.
$Id: Expression.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
import Globals
from Globals import Persistent
from Acquisition import aq_inner, aq_parent
from AccessControl import getSecurityManager, ClassSecurityInfo
from DocumentTemplate.DT_Util import TemplateDict, InstanceDict, Eval
try:
# Zope 2.3.x
from DocumentTemplate.DT_Util import expr_globals
except ImportError:
expr_globals = None
try:
# Zope 2.4.x
from AccessControl import full_read_guard
except ImportError:
full_read_guard = None
class Expression (Persistent):
text = ''
_v_eval = None
security = ClassSecurityInfo()
def __init__(self, text):
self.text = text
if expr_globals is not None:
eval = Eval(text, expr_globals)
else:
eval = Eval(text)
self._v_eval = eval
security.declarePrivate('validate')
def validate(self, inst, parent, name, value, md):
# Zope 2.3.x
return getSecurityManager().validate(inst, parent, name, value)
security.declarePrivate('read_guard')
def read_guard(self, ob):
# Zope 2.4.x
return full_read_guard(ob)
def __call__(self, md):
# md is a TemplateDict instance.
eval = self._v_eval
if eval is None:
text = self.text
if expr_globals is not None:
eval = Eval(text, expr_globals)
else:
eval = Eval(text)
self._v_eval = eval
md.validate = self.validate # Zope 2.3.x
md.read_guard = self.read_guard # Zope 2.4.x
return eval.eval(md)
Globals.InitializeClass(Expression)
def exprNamespace(object, workflow, status,
transition=None, new_state=None, kwargs=None):
md = TemplateDict()
if kwargs is None:
kwargs = {}
md._push(status)
md._push(ExprVars(object, workflow))
d = {'object': object,
'workflow': workflow,
'transition': transition,
'new_state': new_state,
'kwargs': kwargs,
}
md._push(d)
md._push(workflow.scripts) # Make scripts automatically available.
return md
class ExprVars:
'''
Provides names that depend on both the workflow and the object.
'''
def __init__(self, ob, wf):
self._ob = ob
self._wf = wf
def __getitem__(self, name):
if name[:1] != '_' and hasattr(self, name):
return getattr(self, name)
raise KeyError, name
def getHistory(self):
wf = self._wf
tool = aq_parent(aq_inner(wf))
wf_id = wf.id
h = tool.getHistoryOf(wf_id, self._ob)
if h:
return map(lambda dict: dict.copy(), h) # Don't allow mutation
else:
return ()
--- Added File Guard.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Guard conditions in a web-configurable workflow.
$Id: Guard.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from string import split, strip, join
from cgi import escape
import Globals
from Globals import DTMLFile, Persistent
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from Expression import Expression
from utils import _dtmldir
class Guard (Persistent):
permissions = ()
roles = ()
expr = None
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
guardForm = DTMLFile('guard', _dtmldir)
def check(self, sm, wf_def, ob):
'''
Checks conditions in this guard.
'''
pp = self.permissions
if pp:
found = 0
for p in pp:
if sm.checkPermission(p, ob):
found = 1
break
if not found:
return 0
roles = self.roles
if roles:
# Require at least one of the given roles.
found = 0
u_roles = sm.getUser().getRolesInContext(ob)
for role in roles:
if role in u_roles:
found = 1
break
if not found:
return 0
expr = self.expr
if expr is not None:
res = expr(ob, wf_def)
if not res:
return 0
return 1
def getSummary(self):
# Perhaps ought to be in DTML.
res = []
if self.permissions:
res.append('Requires permission:')
for idx in range(len(self.permissions)):
p = self.permissions[idx]
if idx > 0:
if idx < len(self.permissions) - 1:
res.append(';')
else:
res.append('or')
res.append('<code>' + escape(p) + '</code>')
if self.roles:
if res:
res.append(', role:')
else:
res.append('Requires role:')
for idx in range(len(self.roles)):
r = self.roles[idx]
if idx > 0:
if idx < len(self.roles) - 1:
res.append(';')
else:
res.append('or')
res.append('<code>' + escape(r) + '</code>')
if self.expr is not None:
if res:
res.append(', expr:')
else:
res.append('Requires expr:')
res.append('<code>' + escape(self.expr.text) + '</code>')
return join(res, ' ')
def changeFromProperties(self, props):
'''
Returns 1 if changes were specified.
'''
if props is None:
return 0
res = 0
s = props.get('guard_permissions', None)
if s:
res = 1
p = map(strip, split(s, ';'))
self.permissions = tuple(p)
s = props.get('guard_roles', None)
if s:
res = 1
r = map(strip, split(s, ';'))
self.roles = tuple(r)
s = props.get('guard_expr', None)
if s:
res = 1
self.expr = Expression(s)
return res
def getPermissionsText(self):
if not self.permissions:
return ''
return join(self.permissions, '; ')
def getRolesText(self):
if not self.roles:
return ''
return join(self.roles, '; ')
def getExprText(self):
if not self.expr:
return ''
return str(self.expr.text)
Globals.InitializeClass(Guard)
--- Added File README.txt in package CMF ---
There is some documentation in the 'doc' directory.
I encourage you to experiment with what's available and invite you to
ask questions about the tool on zope-cmf@zope.org. Future development
depends entirely on people's needs, so speak up!
Shane Hathaway
Digital Creations
shane@digicool.com
--- Added File Scripts.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Scripts in a web-configurable workflow.
$Id: Scripts.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from OFS.Folder import Folder
import Globals
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from ContainerTab import ContainerTab
class Scripts (ContainerTab):
meta_type = 'Workflow Scripts'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
def manage_main(self, client=None, REQUEST=None, **kw):
'''
'''
kw['management_view'] = 'Scripts'
return apply(Folder.manage_main, (self, client, REQUEST), kw)
Globals.InitializeClass(Scripts)
--- Added File States.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
States in a web-configurable workflow.
$Id: States.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from string import join
from Acquisition import aq_inner, aq_parent
import Globals
from Globals import DTMLFile, PersistentMapping
from OFS.SimpleItem import SimpleItem
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from ContainerTab import ContainerTab
from utils import _dtmldir
TupleType = type(())
class StateDefinition (SimpleItem):
meta_type = 'Workflow State'
manage_options = (
{'label': 'Properties', 'action': 'manage_properties'},
{'label': 'Permissions', 'action': 'manage_permissions'},
{'label': 'Variables', 'action': 'manage_vars'},
)
title = ''
transitions = () # The ids of possible transitions.
permission_roles = None
var_values = None # PersistentMapping if set. Overrides transition exprs.
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
def __init__(self, id):
self.id = id
def getId(self):
return self.id
def getVarValues(self):
vv = self.var_values
if vv is None:
return []
else:
return vv.items()
def getWorkflow(self):
return aq_parent(aq_inner(aq_parent(aq_inner(self))))
def getTransitions(self):
return list(self.transitions)
def getTransitionTitle(self, tid):
t = self.getWorkflow().transitions.get(tid, None)
if t is not None:
return t.title
return ''
def getAvailableTransitionIds(self):
return self.getWorkflow().transitions.keys()
def getAvailableVarIds(self):
return self.getWorkflow().vars.keys()
def getManagedPermissions(self):
return list(self.getWorkflow().permissions)
def getAvailableRoles(self):
return list(self.valid_roles())
def getPermissionInfo(self, p):
roles = None
if self.permission_roles:
roles = self.permission_roles.get(p, None)
if roles is None:
return {'acquired':1, 'roles':[]}
else:
if type(roles) is TupleType:
acq = 0
else:
acq = 1
return {'acquired':acq, 'roles':list(roles)}
_properties_form = DTMLFile('state_properties', _dtmldir)
def manage_properties(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._properties_form(REQUEST,
management_view='Properties',
manage_tabs_message=manage_tabs_message,
)
def setProperties(self, title='', transitions=(), REQUEST=None):
'''
'''
self.title = str(title)
self.transitions = tuple(map(str, transitions))
if REQUEST is not None:
return self.manage_properties(REQUEST, 'Properties changed.')
_permissions_form = DTMLFile('state_permissions', _dtmldir)
def manage_permissions(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._permissions_form(REQUEST,
management_view='Permissions',
manage_tabs_message=manage_tabs_message,
)
def setPermissions(self, REQUEST):
'''
'''
pr = self.permission_roles
if pr is None:
self.permission_roles = pr = PersistentMapping()
for p in self.getManagedPermissions():
roles = []
acquired = REQUEST.get('acquire_' + p, 0)
for r in self.getAvailableRoles():
if REQUEST.get('%s|%s' % (p, r), 0):
roles.append(r)
if not acquired:
roles = tuple(roles)
pr[p] = roles
return self.manage_permissions(REQUEST, 'Permissions changed.')
def setPermission(self, permission, acquired, roles):
'''
'''
pr = self.permission_roles
if pr is None:
self.permission_roles = pr = PersistentMapping()
if acquired:
roles = list(roles)
else:
roles = tuple(roles)
pr[permission] = roles
Globals.InitializeClass(StateDefinition)
class States (ContainerTab):
meta_type = 'Workflow States'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
all_meta_types = ({'name':StateDefinition.meta_type,
'action':'addState',
},)
_manage_states = DTMLFile('states', _dtmldir)
def manage_main(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._manage_states(REQUEST,
management_view='States',
manage_tabs_message=manage_tabs_message,
)
def addState(self, id, REQUEST=None):
'''
'''
sdef = StateDefinition(id)
self._setObject(id, sdef)
if REQUEST is not None:
return self.manage_main(REQUEST, 'State added.')
def deleteStates(self, ids, REQUEST=None):
'''
'''
for id in ids:
self._delObject(id)
if REQUEST is not None:
return self.manage_main(REQUEST, 'State(s) removed.')
def setInitialState(self, id=None, ids=None, REQUEST=None):
'''
'''
if not id:
if len(ids) != 1:
raise ValueError, 'One and only one state must be selected'
id = ids[0]
id = str(id)
aq_parent(aq_inner(self)).initial_state = id
if REQUEST is not None:
return self.manage_main(REQUEST, 'Initial state selected.')
Globals.InitializeClass(States)
--- Added File Transitions.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Transitions in a web-configurable workflow.
$Id: Transitions.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from string import join, split, strip
from OFS.SimpleItem import SimpleItem
from Globals import DTMLFile
from Acquisition import aq_inner, aq_parent
import Globals
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from ContainerTab import ContainerTab
from Guard import Guard
from utils import _dtmldir
TRIGGER_AUTOMATIC = 0
TRIGGER_USER_ACTION = 1
TRIGGER_WORKFLOW_METHOD = 2
class TransitionDefinition (SimpleItem):
meta_type = 'Workflow Transition'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
title = ''
new_state_id = ''
trigger_type = TRIGGER_USER_ACTION
guard = None
actbox_name = ''
actbox_url = ''
actbox_category = 'workflow'
var_exprs = None # A mapping.
script_name = None
manage_options = (
{'label': 'Properties', 'action': 'manage_properties'},
{'label': 'Variables', 'action': 'manage_variables'},
)
def __init__(self, id):
self.id = id
def getGuardSummary(self):
res = None
if self.guard is not None:
res = self.guard.getSummary()
return res
def getGuard(self):
if self.guard is not None:
return self.guard
else:
return Guard() # Create a temporary guard.
def getVarExprText(self, id):
if not self.var_exprs:
return ''
else:
return self.var_exprs.get(id, '')
def getWorkflow(self):
return aq_parent(aq_inner(aq_parent(aq_inner(self))))
def getAvailableStateIds(self):
return self.getWorkflow().states.keys()
def getAvailableScriptIds(self):
return self.getWorkflow().scripts.keys()
_properties_form = DTMLFile('transition_properties', _dtmldir)
def manage_properties(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._properties_form(REQUEST,
management_view='Properties',
manage_tabs_message=manage_tabs_message,
)
def setProperties(self, title, new_state_id,
trigger_type=TRIGGER_USER_ACTION, script_name='',
actbox_name='', actbox_url='',
actbox_category='workflow',
props=None, REQUEST=None):
'''
'''
self.title = str(title)
self.new_state_id = str(new_state_id)
self.trigger_type = int(trigger_type)
self.script_name = str(script_name)
g = Guard()
if g.changeFromProperties(props or REQUEST):
self.guard = g
else:
self.guard = None
self.actbox_name = str(actbox_name)
self.actbox_url = str(actbox_url)
self.actbox_category = str(actbox_category)
if REQUEST is not None:
return self.manage_properties(REQUEST, 'Properties changed.')
Globals.InitializeClass(TransitionDefinition)
class Transitions (ContainerTab):
meta_type = 'Workflow Transitions'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
all_meta_types = ({'name':TransitionDefinition.meta_type,
'action':'addTransition',
},)
_manage_transitions = DTMLFile('transitions', _dtmldir)
def manage_main(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._manage_transitions(
REQUEST,
management_view='Transitions',
manage_tabs_message=manage_tabs_message,
)
def addTransition(self, id, REQUEST=None): #, RESPONSE=None):
'''
'''
tdef = TransitionDefinition(id)
self._setObject(id, tdef)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Transition added.')
def deleteTransitions(self, ids, REQUEST=None):
'''
'''
for id in ids:
self._delObject(id)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Transition(s) removed.')
Globals.InitializeClass(Transitions)
--- Added File Variables.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Variables in a web-configurable workflow.
$Id: Variables.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from string import join, split, strip
from OFS.SimpleItem import SimpleItem
from Globals import DTMLFile
from Acquisition import aq_inner, aq_parent
import Globals
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from ContainerTab import ContainerTab
from Guard import Guard
from Expression import Expression
from utils import _dtmldir
class VariableDefinition (SimpleItem):
meta_type = 'Workflow Variable'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
description = ''
for_catalog = 1
for_status = 1
default_value = ''
default_expr = None # Overrides default_value if set
info_guard = None
manage_options = (
{'label': 'Properties', 'action': 'manage_properties'},
)
def __init__(self, id):
self.id = id
def getDefaultExprText(self):
if not self.default_expr:
return ''
else:
return self.default_expr.text
def getInfoGuard(self):
if self.info_guard is not None:
return self.info_guard
else:
return Guard() # Create a temporary guard.
def getInfoGuardSummary(self):
res = None
if self.info_guard is not None:
res = self.info_guard.getSummary()
return res
_properties_form = DTMLFile('variable_properties', _dtmldir)
def manage_properties(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._properties_form(REQUEST,
management_view='Properties',
manage_tabs_message=manage_tabs_message,
)
def setProperties(self, description,
default_value='', default_expr='',
for_catalog=0, for_status=0,
props=None, REQUEST=None):
'''
'''
self.description = str(description)
self.default_value = str(default_value)
if default_expr:
self.default_expr = Expression(default_expr)
g = Guard()
if g.changeFromProperties(props or REQUEST):
self.info_guard = g
else:
self.info_guard = None
self.for_catalog = not not for_catalog # Pure boolean value
self.for_status = not not for_status
if REQUEST is not None:
return self.manage_properties(REQUEST, 'Properties changed.')
Globals.InitializeClass(VariableDefinition)
class Variables (ContainerTab):
meta_type = 'Workflow Variables'
all_meta_types = ({'name':VariableDefinition.meta_type,
'action':'addVariable',
},)
_manage_variables = DTMLFile('variables', _dtmldir)
def manage_main(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._manage_variables(
REQUEST,
management_view='Variables',
manage_tabs_message=manage_tabs_message,
)
def addVariable(self, id, REQUEST=None):
'''
'''
vdef = VariableDefinition(id)
self._setObject(id, vdef)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Variable added.')
def deleteVariables(self, ids, REQUEST=None):
'''
'''
for id in ids:
self._delObject(id)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Variable(s) removed.')
def _checkId(self, id, allow_dup=0):
wf_def = aq_parent(aq_inner(self))
if id == wf_def.state_var:
raise 'Bad Request', '"%s" is used for keeping state.' % id
return ContainerTab._checkId(self, id, allow_dup)
def getStateVar(self):
wf_def = aq_parent(aq_inner(self))
return wf_def.state_var
def setStateVar(self, id, REQUEST=None):
'''
'''
wf_def = aq_parent(aq_inner(self))
if id != wf_def.state_var:
self._checkId(id)
wf_def.state_var = str(id)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Set state variable.')
Globals.InitializeClass(Variables)
--- Added File WorkflowUIMixin.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Web-configurable workflow UI.
$Id: WorkflowUIMixin.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from Globals import DTMLFile
import Globals
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from utils import _dtmldir
class WorkflowUIMixin:
'''
'''
security = ClassSecurityInfo()
security.declareProtected(ManagePortal, 'manage_properties')
manage_properties = DTMLFile('workflow_properties', _dtmldir)
security.declareProtected(ManagePortal, 'setProperties')
def setProperties(self, title, REQUEST=None):
'''
'''
self.title = str(title)
if REQUEST is not None:
return self.manage_properties(
REQUEST, manage_tabs_message='Properties changed.')
_permissions_form = DTMLFile('workflow_permissions', _dtmldir)
security.declareProtected(ManagePortal, 'manage_permissions')
def manage_permissions(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._permissions_form(REQUEST,
management_view='Permissions',
manage_tabs_message=manage_tabs_message,
)
security.declareProtected(ManagePortal, 'addManagedPermission')
def addManagedPermission(self, p, REQUEST=None):
'''
'''
if p in self.permissions:
raise ValueError, 'Already a managed permission: ' + p
if p not in self.getPossiblePermissions():
raise ValueError, 'Not a valid permission name:' + p
self.permissions = self.permissions + (p,)
if REQUEST is not None:
return self.manage_permissions(
REQUEST, manage_tabs_message='Permission added.')
security.declareProtected(ManagePortal, 'delManagedPermissions')
def delManagedPermissions(self, ps, REQUEST=None):
'''
'''
if ps:
l = list(self.permissions)
for p in ps:
l.remove(p)
self.permissions = tuple(l)
if REQUEST is not None:
return self.manage_permissions(
REQUEST, manage_tabs_message='Permission(s) removed.')
security.declareProtected(ManagePortal, 'getPossiblePermissions')
def getPossiblePermissions(self):
'''
'''
# possible_permissions is in AccessControl.Role.RoleManager.
return list(self.possible_permissions())
Globals.InitializeClass(WorkflowUIMixin)
--- Added File Worklists.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Worklists in a web-configurable workflow.
$Id: Worklists.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from OFS.SimpleItem import SimpleItem
from Globals import DTMLFile, PersistentMapping
from Acquisition import aq_inner, aq_parent
import Globals
from AccessControl import ClassSecurityInfo
from Products.CMFCore.CMFCorePermissions import ManagePortal
from ContainerTab import ContainerTab
from Guard import Guard
from utils import _dtmldir
class WorklistDefinition (SimpleItem):
meta_type = 'Worklist'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
description = ''
var_matches = None # Compared with catalog when set.
actbox_name = ''
actbox_url = ''
actbox_category = 'global'
guard = None
manage_options = (
{'label': 'Properties', 'action': 'manage_properties'},
)
def __init__(self, id):
self.id = id
def getGuard(self):
if self.guard is not None:
return self.guard
else:
return Guard() # Create a temporary guard.
def getGuardSummary(self):
res = None
if self.guard is not None:
res = self.guard.getSummary()
return res
def getWorkflow(self):
return aq_parent(aq_inner(aq_parent(aq_inner(self))))
def getAvailableCatalogVars(self):
res = []
res.append(self.getWorkflow().state_var)
for id, vdef in self.getWorkflow().variables.items():
if vdef.for_catalog:
res.append(id)
res.sort()
return res
def getVarMatch(self, id):
if self.var_matches:
return self.var_matches.get(id, '')
else:
return ''
_properties_form = DTMLFile('worklist_properties', _dtmldir)
def manage_properties(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._properties_form(REQUEST,
management_view='Properties',
manage_tabs_message=manage_tabs_message,
)
def setProperties(self, description,
actbox_name='', actbox_url='', actbox_category='global',
props=None, REQUEST=None):
'''
'''
if props is None:
props = REQUEST
self.description = str(description)
for key in self.getAvailableCatalogVars():
# Populate var_matches.
fieldname = 'var_match_%s' % key
v = props.get(fieldname, '')
if v:
if not self.var_matches:
self.var_matches = PersistentMapping()
self.var_matches[key] = str(v)
else:
if self.var_matches and self.var_matches.has_key(key):
del self.var_matches[key]
self.actbox_name = str(actbox_name)
self.actbox_url = str(actbox_url)
self.actbox_category = str(actbox_category)
g = Guard()
if g.changeFromProperties(props or REQUEST):
self.guard = g
else:
self.guard = None
if REQUEST is not None:
return self.manage_properties(REQUEST, 'Properties changed.')
Globals.InitializeClass(WorklistDefinition)
class Worklists (ContainerTab):
meta_type = 'Worklists'
security = ClassSecurityInfo()
security.declareObjectProtected(ManagePortal)
all_meta_types = ({'name':WorklistDefinition.meta_type,
'action':'addWorklist',
},)
_manage_worklists = DTMLFile('worklists', _dtmldir)
def manage_main(self, REQUEST, manage_tabs_message=None):
'''
'''
return self._manage_worklists(
REQUEST,
management_view='Worklists',
manage_tabs_message=manage_tabs_message,
)
def addWorklist(self, id, REQUEST=None):
'''
'''
qdef = WorklistDefinition(id)
self._setObject(id, qdef)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Worklist added.')
def deleteWorklists(self, ids, REQUEST=None):
'''
'''
for id in ids:
self._delObject(id)
if REQUEST is not None:
return self.manage_main(REQUEST, 'Worklist(s) removed.')
Globals.InitializeClass(Worklists)
--- Added File __init__.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Web-configurable workflow.
$Id: __init__.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
from Products.CMFCore.utils import registerIcon
import DCWorkflow, States, Transitions, Variables, Worklists, Scripts
from Default import manage_addDefaultWorkflow
def initialize(context):
registerIcon(DCWorkflow.DCWorkflowDefinition,
'images/workflow.gif', globals())
registerIcon(States.States,
'images/state.gif', globals())
States.StateDefinition.icon = States.States.icon
registerIcon(Transitions.Transitions,
'images/transition.gif', globals())
Transitions.TransitionDefinition.icon = Transitions.Transitions.icon
registerIcon(Variables.Variables,
'images/variable.gif', globals())
Variables.VariableDefinition.icon = Variables.Variables.icon
registerIcon(Worklists.Worklists,
'images/worklist.gif', globals())
Worklists.WorklistDefinition.icon = Worklists.Worklists.icon
registerIcon(Scripts.Scripts,
'images/script.gif', globals())
context.registerClass(constructors=(manage_addDefaultWorkflow,),
meta_type='CMF default workflow (rev 2)')
--- Added File refresh.txt in package CMF ---
--- Added File utils.py in package CMF ---
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
'''
Some common utilities.
$Id: utils.py,v 1.1 2001/06/11 19:33:47 shane Exp $
'''
__version__='$Revision: 1.1 $'[11:-2]
import os
from App.Common import package_home
_dtmldir = os.path.join( package_home( globals() ), 'dtml' )
from AccessControl.Role import gather_permissions
from AccessControl.Permission import Permission
def ac_inherited_permissions(ob, all=0):
# Get all permissions not defined in ourself that are inherited
# This will be a sequence of tuples with a name as the first item and
# an empty tuple as the second.
d = {}
perms = getattr(ob, '__ac_permissions__', ())
for p in perms: d[p[0]] = None
r = gather_permissions(ob.__class__, [], d)
if all:
if hasattr(ob, '_subobject_permissions'):
for p in ob._subobject_permissions():
pname=p[0]
if not d.has_key(pname):
d[pname]=1
r.append(p)
r = list(perms) + r
return r
def modifyRolesForPermission(ob, pname, roles):
'''
Modifies multiple role to permission mappings. roles is a list to
acquire, a tuple to not acquire.
'''
# This mimics what AccessControl/Role.py does.
data = ()
for perm in ac_inherited_permissions(ob, 1):
name, value = perm[:2]
if name == pname:
data = value
break
p = Permission(pname, data, ob)
p.setRoles(roles)
--- Added File version.txt in package CMF ---
DCWorkflow-0.2