1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
##############################################################################
#
# 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.4 2001/09/05 14:17:01 shane Exp $
'''
__version__='$Revision: 1.4 $'[11:-2]
from Products.CMFCore.WorkflowTool import addWorkflowFactory
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 setupDefaultWorkflowRev2(wf):
'''
Sets up a DCWorkflow with the addition of a visible state,
the show and hide transitions, and corresponding changes.
wf is a DCWorkflow instance.
'''
wf.setProperties(title='CMF default workflow [Revision 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/getId|nothing',
for_status=1)
vdef = wf.variables['actor']
vdef.setProperties(description='The ID of the user who performed '
'the last transition',
default_expr='user/getUserName',
for_status=1)
vdef = wf.variables['comments']
vdef.setProperties(description='Comments about the last transition',
default_expr="python:state_change.kwargs.get('comment', '')",
for_status=1)
vdef = wf.variables['review_history']
vdef.setProperties(description='Provides access to workflow history',
default_expr="state_change/getHistory",
props={'guard_permissions':
p_request + ';' + p_review})
vdef = wf.variables['time']
vdef.setProperties(description='Time of the last transition',
default_expr="state_change/getDateTime",
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 createDefaultWorkflowRev2(id):
'''
'''
ob = DCWorkflowDefinition(id)
setupDefaultWorkflowRev2(ob)
return ob
addWorkflowFactory(createDefaultWorkflowRev2, id='default_workflow',
title='Web-configurable workflow [Revision 2]')
def setupDefaultWorkflowClassic(wf):
'''
Sets up a DCWorkflow as close as possible to the old DefaultWorkflow,
with only the private, pending, and published states.
wf is a DCWorkflow instance.
'''
wf.setProperties(title='CMF default workflow [Classic]')
for s in ('private', 'pending', 'published'):
wf.states.addState(s)
for t in ('publish', 'reject', 'retract', 'submit'):
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('private')
sdef = wf.states['private']
sdef.setProperties(
title='Non-visible and editable only by owner',
transitions=('submit', 'publish',))
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=('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))
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='private',
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='private',
actbox_name='Retract',
actbox_url='%(content_url)s/content_retract_form',
props={'guard_permissions':p_request})
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/getId|nothing',
for_status=1)
vdef = wf.variables['actor']
vdef.setProperties(description='The ID of the user who performed '
'the last transition',
default_expr='user/getUserName',
for_status=1)
vdef = wf.variables['comments']
vdef.setProperties(description='Comments about the last transition',
default_expr="python:state_change.kwargs.get('comment', '')",
for_status=1)
vdef = wf.variables['review_history']
vdef.setProperties(description='Provides access to workflow history',
default_expr="state_change/getHistory",
props={'guard_permissions':
p_request + ';' + p_review})
vdef = wf.variables['time']
vdef.setProperties(description='Time of the last transition',
default_expr="state_change/getDateTime",
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 createDefaultWorkflowClassic(id):
'''
'''
ob = DCWorkflowDefinition(id)
setupDefaultWorkflowClassic(ob)
return ob
addWorkflowFactory(createDefaultWorkflowClassic, id='default_workflow',
title='Web-configurable workflow [Classic]')
|
