/usr/lib/python2.7/dist-packages/trytond/wizard/wizard.py is in tryton-server 3.0.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #This file is part of Tryton. The COPYRIGHT file at the top level of
#this repository contains the full copyright notices and license terms.
__all__ = ['Wizard', 'StateView', 'StateTransition', 'StateAction', 'Button']
try:
import simplejson as json
except ImportError:
import json
import copy
from trytond.pool import Pool, PoolBase
from trytond.transaction import Transaction
from trytond.error import WarningErrorMixin
from trytond.url import URLMixin
from trytond.protocols.jsonrpc import object_hook, JSONEncoder
from trytond.model.fields import states_validate
from trytond.pyson import PYSONEncoder
from trytond.rpc import RPC
class Button(object):
'''
Define a button on wizard.
'''
def __init__(self, string, state, icon='', default=False, states=None):
self.string = string
self.state = state
self.icon = icon
self.default = bool(default)
self.__states = None
self.states = states or {}
@property
def states(self):
return self.__states
@states.setter
def states(self, value):
states_validate(value)
self.__states = value
class State(object):
'''
A State of a wizard.
'''
name = None
class StateView(State):
'''
A view state of a wizard.
'''
def __init__(self, model_name, view, buttons):
'''
model_name is the name of the model
view is the xml id of the view
buttons is a list of Button
'''
self.model_name = model_name
self.view = view
self.buttons = buttons
assert len(self.buttons) == len(set(b.state for b in self.buttons))
assert len([b for b in self.buttons if b.default]) <= 1
def get_view(self):
'''
Returns the view definition
'''
Model_ = Pool().get(self.model_name)
ModelData = Pool().get('ir.model.data')
module, fs_id = self.view.split('.')
view_id = ModelData.get_id(module, fs_id)
return Model_.fields_view_get(view_id=view_id, view_type='form')
def get_defaults(self, wizard, state_name, fields):
'''
Returns defaults values for the fields
'''
Model_ = Pool().get(self.model_name)
defaults = Model_.default_get(fields)
default = getattr(wizard, 'default_%s' % state_name, None)
if default:
defaults.update(default(fields))
return defaults
def get_buttons(self, wizard, state_name):
'''
Returns button definitions translated
'''
Translation = Pool().get('ir.translation')
def translation_key(button):
return (','.join((wizard.__name__, state_name, button.state)),
'wizard_button', Transaction().language, button.string)
translation_keys = [translation_key(button) for button in self.buttons]
translations = Translation.get_sources(translation_keys)
encoder = PYSONEncoder()
result = []
for button in self.buttons:
result.append({
'state': button.state,
'icon': button.icon,
'default': button.default,
'string': (translations.get(translation_key(button))
or button.string),
'states': encoder.encode(button.states),
})
return result
class StateTransition(State):
'''
A transition state of a wizard.
'''
class StateAction(StateTransition):
'''
An action state of a wizard.
'''
def __init__(self, action_id):
'''
action_id is a string containing ``module.xml_id``
'''
super(StateAction, self).__init__()
self.action_id = action_id
def get_action(self):
"Returns action definition"
pool = Pool()
ModelData = pool.get('ir.model.data')
Action = pool.get('ir.action')
module, fs_id = self.action_id.split('.')
action_id = Action.get_action_id(
ModelData.get_id(module, fs_id))
action = Action(action_id)
return Action.get_action_values(action.type, [action.id])[0]
class Wizard(WarningErrorMixin, URLMixin, PoolBase):
start_state = 'start'
end_state = 'end'
@classmethod
def __setup__(cls):
super(Wizard, cls).__setup__()
cls.__rpc__ = {
'create': RPC(readonly=False),
'delete': RPC(readonly=False),
'execute': RPC(readonly=False),
}
cls._error_messages = {}
# Copy states
for attr in dir(cls):
if isinstance(getattr(cls, attr), State):
setattr(cls, attr, copy.deepcopy(getattr(cls, attr)))
@classmethod
def __post_setup__(cls):
super(Wizard, cls).__post_setup__()
# Set states
cls.states = {}
for attr in dir(cls):
if attr.startswith('_'):
continue
if isinstance(getattr(cls, attr), State):
cls.states[attr] = getattr(cls, attr)
@classmethod
def __register__(cls, module_name):
super(Wizard, cls).__register__(module_name)
pool = Pool()
Translation = pool.get('ir.translation')
Translation.register_wizard(cls, module_name)
Translation.register_error_messages(cls, module_name)
@classmethod
def create(cls):
"Create a session"
Session = Pool().get('ir.session.wizard')
return (Session.create([{}])[0].id, cls.start_state, cls.end_state)
@classmethod
def delete(cls, session_id):
"Delete the session"
Session = Pool().get('ir.session.wizard')
Session.delete([Session(session_id)])
@classmethod
def execute(cls, session_id, data, state_name):
'''
Execute the wizard state.
session_id is a Session id
data is a dictionary with the session data to update
state_name is the name of state to execute
Returns a dictionary with:
- ``actions``: a list of Action to execute
- ``view``: a dictionary with:
- ``fields_view``: a fields/view definition
- ``defaults``: a dictionary with default values
- ``buttons``: a list of buttons
'''
wizard = cls(session_id)
for key, values in data.iteritems():
record = getattr(wizard, key)
for field, value in values.iteritems():
if field == 'id':
continue
setattr(record, field, value)
return wizard._execute(state_name)
def _execute(self, state_name):
if state_name == self.end_state:
return {}
state = self.states[state_name]
result = {}
if isinstance(state, StateView):
view = state.get_view()
defaults = state.get_defaults(self, state_name,
view['fields'].keys())
buttons = state.get_buttons(self, state_name)
result['view'] = {
'fields_view': view,
'defaults': defaults,
'buttons': buttons,
'state': state_name,
}
elif isinstance(state, StateTransition):
do_result = None
if isinstance(state, StateAction):
action = state.get_action()
do = getattr(self, 'do_%s' % state_name, None)
if do:
do_result = do(action)
else:
do_result = action, {}
transition = getattr(self, 'transition_%s' % state_name, None)
if transition:
result = self._execute(transition())
if do_result:
result.setdefault('actions', []).append(do_result)
self._save()
return result
def __init__(self, session_id):
pool = Pool()
Session = pool.get('ir.session.wizard')
self._session_id = session_id
session = Session(session_id)
data = json.loads(session.data.encode('utf-8'),
object_hook=object_hook)
for state_name, state in self.states.iteritems():
if isinstance(state, StateView):
Target = pool.get(state.model_name)
data.setdefault(state_name, {})
setattr(self, state_name, Target(**data[state_name]))
def _save(self):
"Save the session in database"
Session = Pool().get('ir.session.wizard')
data = {}
for state_name, state in self.states.iteritems():
if isinstance(state, StateView):
data[state_name] = getattr(self, state_name)._default_values
session = Session(self._session_id)
data = json.dumps(data, cls=JSONEncoder)
if data != session.data.encode('utf-8'):
Session.write([session], {
'data': data,
})
|