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
|
# Copyright (C) 2015 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Generic workflow."""
__all__ = [
'Workflow',
]
import json
import logging
from collections import deque
from mailman.interfaces.workflow import IWorkflowStateManager
from zope.component import getUtility
COMMASPACE = ', '
log = logging.getLogger('mailman.error')
class Workflow:
"""Generic workflow."""
SAVE_KEY = ''
SAVE_ATTRIBUTES = ()
INITIAL_STATE = None
def __init__(self):
self._next = deque()
self.push(self.INITIAL_STATE)
def __iter__(self):
return self
def push(self, step):
self._next.append(step)
def _pop(self):
name = self._next.popleft()
step = getattr(self, '_step_{}'.format(name))
return name, step
def __next__(self):
try:
name, step = self._pop()
return step()
except IndexError:
raise StopIteration
except:
log.exception('deque: {}'.format(COMMASPACE.join(self._next)))
raise
def save(self):
assert self.SAVE_KEY, 'Workflow SAVE_KEY must be set'
state_manager = getUtility(IWorkflowStateManager)
data = {attr: getattr(self, attr) for attr in self.SAVE_ATTRIBUTES}
# Note: only the next step is saved, not the whole stack. This is not
# an issue in practice, since there's never more than a single step in
# the queue anyway. If we want to support more than a single step in
# the queue *and* want to support state saving/restoring, change this
# method and the restore() method.
if len(self._next) == 0:
step = None
elif len(self._next) == 1:
step = self._next[0]
else:
raise AssertionError(
"Can't save a workflow state with more than one step "
"in the queue")
state_manager.save(
self.__class__.__name__,
self.SAVE_KEY,
step,
json.dumps(data))
def restore(self):
state_manager = getUtility(IWorkflowStateManager)
state = state_manager.restore(self.__class__.__name__, self.SAVE_KEY)
if state is not None:
self._next.clear()
if state.step:
self._next.append(state.step)
if state.data is not None:
for attr, value in json.loads(state.data).items():
setattr(self, attr, value)
|
