1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
25 from operator import attrgetter
27 from osv import osv, fields
29 from tools.translate import _
35 class res_config_configurable(osv.osv_memory):
36 ''' Base classes for new-style configuration items
38 Configuration items should inherit from this class, implement
39 the execute method (and optionally the cancel one) and have
40 their view inherit from the related res_config_view_base view.
43 logger = netsvc.Logger()
45 def _progress(self, cr, uid, context=None):
46 total = self.pool.get('ir.actions.todo')\
47 .search_count(cr, uid, [], context)
48 open = self.pool.get('ir.actions.todo')\
49 .search_count(cr, uid, [('state','<>','open')], context)
51 return round(open*100./total)
54 def _get_image(self, cr, uid, context=None):
55 file_no = str(random.randint(1,3))
56 path = os.path.join('base','res','config_pixmaps/%s.png'%file_no)
57 file_data = tools.file_open(path,'rb').read()
58 return base64.encodestring(file_data)
61 progress = fields.float('Configuration Progress', readonly=True),
62 config_logo = fields.binary('Image', readonly=True),
66 config_logo = _get_image
69 def _next_action(self, cr, uid):
70 todos = self.pool.get('ir.actions.todo')
71 self.logger.notifyChannel('actions', netsvc.LOG_INFO,
72 'getting next %s' % todos)
73 active_todos = todos.search(cr, uid, [('state','=','open')],
77 todo_obj = todos.browse(cr, uid, active_todos[0], context=None)
78 todo_groups = map(lambda x:x.id, todo_obj.groups_id)
80 cr.execute("select 1 from res_groups_users_rel where uid=%s and gid=ANY(%s)",(uid, todo_groups,))
81 dont_skip_todo = bool(cr.fetchone())
83 return todos.browse(cr, uid, active_todos[0], context=None)
85 todos.write(cr, uid, active_todos[0], {'state':'skip'}, context=None)
86 return self._next_action(cr, uid)
89 def _set_previous_todo(self, cr, uid, state):
90 """ lookup the previous (which is still the next at this point)
91 ir.actions.todo, set it to whatever state was provided.
94 `LookupError`: if we couldn't find *any* previous todo
95 `ValueError`: if no state is provided
96 anything ir_actions_todo.write can throw
98 # this is ultra brittle, but apart from storing the todo id
99 # into the res.config view, I'm not sure how to get the
101 previous_todo = self._next_action(cr, uid)
102 if not previous_todo:
103 raise LookupError(_("Couldn't find previous ir.actions.todo"))
105 raise ValueError(_("Can't set an ir.actions.todo's state to "
107 previous_todo.write({'state':state})
109 def _next(self, cr, uid):
110 self.logger.notifyChannel('actions', netsvc.LOG_INFO,
111 'getting next operation')
112 next = self._next_action(cr, uid)
113 self.logger.notifyChannel('actions', netsvc.LOG_INFO,
114 'next action is %s' % next)
116 action = next.action_id
118 'view_mode': action.view_mode,
119 'view_type': action.view_type,
120 'view_id': action.view_id and [action.view_id.id] or False,
121 'res_model': action.res_model,
123 'target': action.target,
125 self.logger.notifyChannel(
126 'actions', netsvc.LOG_INFO,
127 'all configuration actions have been executed')
129 current_user_menu = self.pool.get('res.users')\
130 .browse(cr, uid, uid).menu_id
131 # return the action associated with the menu
132 return self.pool.get(current_user_menu.type)\
133 .read(cr, uid, current_user_menu.id)
135 def start(self, cr, uid, ids, context=None):
136 ids2 = self.pool.get('ir.actions.todo').search(cr, uid, [], context=context)
137 for todo in self.pool.get('ir.actions.todo').browse(cr, uid, ids2, context=context):
138 if (todo.restart=='always') or (todo.restart=='onskip' and (todo.state in ('skip','cancel'))):
139 todo.write({'state':'open'})
140 return self.next(cr, uid, ids, context)
142 def next(self, cr, uid, ids, context=None):
143 """ Returns the next todo action to execute (using the default
146 return self._next(cr, uid)
148 def execute(self, cr, uid, ids, context=None):
149 """ Method called when the user clicks on the ``Next`` button.
151 Execute *must* be overloaded unless ``action_next`` is overloaded
152 (which is something you generally don't need to do).
154 If ``execute`` returns an action dictionary, that action is executed
155 rather than just going to the next configuration item.
157 raise NotImplementedError(
158 'Configuration items need to implement execute')
159 def cancel(self, cr, uid, ids, context=None):
160 """ Method called when the user click on the ``Skip`` button.
162 ``cancel`` should be overloaded instead of ``action_skip``. As with
163 ``execute``, if it returns an action dictionary that action is
164 executed in stead of the default (going to the next configuration item)
166 The default implementation is a NOOP.
168 ``cancel`` is also called by the default implementation of
173 def action_next(self, cr, uid, ids, context=None):
174 """ Action handler for the ``next`` event.
176 Sets the status of the todo the event was sent from to
177 ``done``, calls ``execute`` and -- unless ``execute`` returned
178 an action dictionary -- executes the action provided by calling
181 self._set_previous_todo(cr, uid, state='done')
182 next = self.execute(cr, uid, ids, context=None)
184 return self.next(cr, uid, ids, context=context)
186 def action_skip(self, cr, uid, ids, context=None):
187 """ Action handler for the ``skip`` event.
189 Sets the status of the todo the event was sent from to
190 ``skip``, calls ``cancel`` and -- unless ``cancel`` returned
191 an action dictionary -- executes the action provided by calling
194 self._set_previous_todo(cr, uid, state='skip')
195 next = self.cancel(cr, uid, ids, context=None)
197 return self.next(cr, uid, ids, context=context)
199 def action_cancel(self, cr, uid, ids, context=None):
200 """ Action handler for the ``cancel`` event. That event isn't
201 generated by the res.config.view.base inheritable view, the
202 inherited view has to overload one of the buttons (or add one
205 Sets the status of the todo the event was sent from to
206 ``cancel``, calls ``cancel`` and -- unless ``cancel`` returned
207 an action dictionary -- executes the action provided by calling
210 self._set_previous_todo(cr, uid, state='cancel')
211 next = self.cancel(cr, uid, ids, context=None)
213 return self.next(cr, uid, ids, context=context)
215 res_config_configurable()
217 class res_config_installer(osv.osv_memory):
218 """ New-style configuration base specialized for addons selection
224 Subclasses can simply define a number of _columns as
225 fields.boolean objects. The keys (column names) should be the
226 names of the addons to install (when selected). Upon action
227 execution, selected boolean fields (and those only) will be
228 interpreted as addons to install, and batch-installed.
233 It is also possible to require the installation of an additional
234 addon set when a specific preset of addons has been marked for
235 installation (in the basic usage only, additionals can't depend on
238 These additionals are defined through the ``_install_if``
239 property. This property is a mapping of a collection of addons (by
240 name) to a collection of addons (by name) [#]_, and if all the *key*
241 addons are selected for installation, then the *value* ones will
242 be selected as well. For example::
245 ('sale','crm'): ['sale_crm'],
248 This will install the ``sale_crm`` addon if and only if both the
249 ``sale`` and ``crm`` addons are selected for installation.
251 You can define as many additionals as you wish, and additionals
252 can overlap in key and value. For instance::
255 ('sale','crm'): ['sale_crm'],
256 ('sale','project'): ['project_mrp'],
259 will install both ``sale_crm`` and ``project_mrp`` if all of
260 ``sale``, ``crm`` and ``project`` are selected for installation.
265 Subclasses might also need to express dependencies more complex
266 than that provided by additionals. In this case, it's possible to
267 define methods of the form ``_if_%(name)s`` where ``name`` is the
268 name of a boolean field. If the field is selected, then the
269 corresponding module will be marked for installation *and* the
270 hook method will be executed.
272 Hook methods take the usual set of parameters (cr, uid, ids,
273 context) and can return a collection of additional addons to
274 install (if they return anything, otherwise they should not return
275 anything, though returning any "falsy" value such as None or an
276 empty collection will have the same effect).
281 The last hook is to simply overload the ``modules_to_install``
282 method, which implements all the mechanisms above. This method
283 takes the usual set of parameters (cr, uid, ids, context) and
284 returns a ``set`` of addons to install (addons selected by the
285 above methods minus addons from the *basic* set which are already
286 installed) [#]_ so an overloader can simply manipulate the ``set``
287 returned by ``res_config_installer.modules_to_install`` to add or
290 Skipping the installer
291 ----------------------
293 Unless it is removed from the view, installers have a *skip*
294 button which invokes ``action_skip`` (and the ``cancel`` hook from
295 ``res.config``). Hooks and additionals *are not run* when skipping
296 installation, even for already installed addons.
298 Again, setup your hooks accordinly.
300 .. [#] note that since a mapping key needs to be hashable, it's
301 possible to use a tuple or a frozenset, but not a list or a
304 .. [#] because the already-installed modules are only pruned at
305 the very end of ``modules_to_install``, additionals and
306 hooks depending on them *are guaranteed to execute*. Setup
307 your hooks accordingly.
309 _name = 'res.config.installer'
310 _inherit = 'res.config'
314 def _already_installed(self, cr, uid, context=None):
315 """ For each module (boolean fields in a res.config.installer),
316 check if it's already installed (neither uninstallable nor uninstalled)
317 and if it is, check it by default
319 modules = self.pool.get('ir.module.module')
321 selectable = [field for field in self._columns
322 if type(self._columns[field]) is fields.boolean]
323 return modules.browse(
325 modules.search(cr, uid,
326 [('name','in',selectable),
327 ('state','not in',['uninstallable', 'uninstalled'])],
332 def modules_to_install(self, cr, uid, ids, context=None):
333 """ selects all modules to install:
335 * checked boolean fields
336 * return values of hook methods. Hook methods are of the form
337 ``_if_%(addon_name)s``, and are called if the corresponding
338 addon is marked for installation. They take the arguments
339 cr, uid, ids and context, and return an iterable of addon
341 * additionals, additionals are setup through the ``_install_if``
342 class variable. ``_install_if`` is a dict of {iterable:iterable}
343 where key and value are iterables of addon names.
345 If all the addons in the key are selected for installation
346 (warning: addons added through hooks don't count), then the
347 addons in the value are added to the set of modules to install
348 * not already installed
350 base = set(module_name
351 for installer in self.read(cr, uid, ids, context=context)
352 for module_name, to_install in installer.iteritems()
353 if module_name != 'id'
354 if type(self._columns[module_name]) is fields.boolean
357 hooks_results = set()
359 hook = getattr(self, '_if_%s'%(module), None)
361 hooks_results.update(hook(cr, uid, ids, context=None) or set())
364 module for requirements, consequences \
365 in self._install_if.iteritems()
366 if base.issuperset(requirements)
367 for module in consequences)
369 return (base | hooks_results | additionals) - set(
370 map(attrgetter('name'), self._already_installed(cr, uid, context)))
372 def default_get(self, cr, uid, fields_list, context=None):
373 ''' If an addon is already installed, check it by default
375 defaults = super(res_config_installer, self).default_get(
376 cr, uid, fields_list, context=context)
378 return dict(defaults,
380 map(attrgetter('name'),
381 self._already_installed(cr, uid, context=context)),
384 def fields_get(self, cr, uid, fields=None, context=None, read_access=True):
385 """ If an addon is already installed, set it to readonly as
386 res.config.installer doesn't handle uninstallations of already
389 fields = super(res_config_installer, self).fields_get(
390 cr, uid, fields, context, read_access)
392 for module in self._already_installed(cr, uid, context=context):
393 fields[module.name].update(
395 help=fields[module.name].get('help', '') +
396 _('\n\nThis addon is already installed on your system'))
400 def execute(self, cr, uid, ids, context=None):
401 modules = self.pool.get('ir.module.module')
402 to_install = list(self.modules_to_install(
403 cr, uid, ids, context=context))
404 self.logger.notifyChannel(
405 'installer', netsvc.LOG_INFO,
406 'Selecting addons %s to install'%to_install)
407 modules.state_update(
409 modules.search(cr, uid, [('name','in',to_install)]),
410 'to install', ['uninstalled'], context=context)
413 pooler.restart_pool(cr.dbname, update_module=True)
414 res_config_installer()
416 DEPRECATION_MESSAGE = 'You are using an addon using old-style configuration '\
417 'wizards (ir.actions.configuration.wizard). Old-style configuration '\
418 'wizards have been deprecated.\n'\
419 'The addon should be migrated to res.config objects.'
420 class ir_actions_configuration_wizard(osv.osv_memory):
421 ''' Compatibility configuration wizard
423 The old configuration wizard has been replaced by res.config, but in order
424 not to break existing but not-yet-migrated addons, the old wizard was
425 reintegrated and gutted.
427 _name='ir.actions.configuration.wizard'
428 _inherit = 'res.config'
430 def _next_action_note(self, cr, uid, ids, context=None):
431 next = self._next_action(cr, uid)
433 # if the next one is also an old-style extension, you never know...
436 return "Click 'Continue' to configure the next addon..."
437 return "Your database is now fully configured.\n\n"\
438 "Click 'Continue' and enjoy your OpenERP experience..."
441 'note': fields.text('Next Wizard', readonly=True),
444 'note': _next_action_note,
447 def execute(self, cr, uid, ids, context=None):
448 self.logger.notifyChannel(
449 'configuration', netsvc.LOG_WARNING, DEPRECATION_MESSAGE)
451 ir_actions_configuration_wizard()
453 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: