openerp/modules/loading.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   6 #    Copyright (C) 2010-2011 OpenERP s.a. (<http://openerp.com>).
   7 #
   8 #    This program is free software: you can redistribute it and/or modify
   9 #    it under the terms of the GNU Affero General Public License as
  10 #    published by the Free Software Foundation, either version 3 of the
  11 #    License, or (at your option) any later version.
  12 #
  13 #    This program is distributed in the hope that it will be useful,
  14 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #    GNU Affero General Public License for more details.
  17 #
  18 #    You should have received a copy of the GNU Affero General Public License
  19 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 #
  21 ##############################################################################
  22
  23 """ Modules (also called addons) management.
  24
  25 """
  26
  27 import base64
  28 import imp
  29 import itertools
  30 import logging
  31 import os
  32 import re
  33 import sys
  34 import threading
  35 import zipfile
  36 import zipimport
  37
  38 from cStringIO import StringIO
  39 from os.path import join as opj
  40 from zipfile import PyZipFile, ZIP_DEFLATED
  41
  42
  43 import openerp
  44 import openerp.modules.db
  45 import openerp.modules.graph
  46 import openerp.modules.migration
  47 import openerp.netsvc as netsvc
  48 import openerp.osv as osv
  49 import openerp.pooler as pooler
  50 import openerp.release as release
  51 import openerp.tools as tools
  52 import openerp.tools.osutil as osutil
  53
  54 from openerp.tools.safe_eval import safe_eval as eval
  55 from openerp.tools.translate import _
  56 from openerp.modules.module import \
  57     get_modules, get_modules_with_version, \
  58     load_information_from_description_file, \
  59     get_module_resource, zip_directory, \
  60     get_module_path, initialize_sys_path, \
  61     load_openerp_module, init_module_models
  62
  63 _logger = logging.getLogger(__name__)
  64
  65 def open_openerp_namespace():
  66     # See comment for open_openerp_namespace.
  67     if openerp.conf.deprecation.open_openerp_namespace:
  68         for k, v in list(sys.modules.items()):
  69             if k.startswith('openerp.') and sys.modules.get(k[8:]) is None:
  70                 sys.modules[k[8:]] = v
  71
  72
  73 def load_module_graph(cr, graph, status=None, perform_checks=True, skip_modules=None, report=None):
  74     """Migrates+Updates or Installs all module nodes from ``graph``
  75        :param graph: graph of module nodes to load
  76        :param status: status dictionary for keeping track of progress
  77        :param perform_checks: whether module descriptors should be checked for validity (prints warnings
  78                               for same cases, and even raise osv_except if certificate is invalid)
  79        :param skip_modules: optional list of module names (packages) which have previously been loaded and can be skipped
  80        :return: list of modules that were installed or updated
  81     """
  82     def process_sql_file(cr, fp):
  83         queries = fp.read().split(';')
  84         for query in queries:
  85             new_query = ' '.join(query.split())
  86             if new_query:
  87                 cr.execute(new_query)
  88
  89     load_init_xml = lambda *args: _load_data(cr, *args, kind='init_xml')
  90     load_update_xml = lambda *args: _load_data(cr, *args, kind='update_xml')
  91     load_demo_xml = lambda *args: _load_data(cr, *args, kind='demo_xml')
  92     load_data = lambda *args: _load_data(cr, *args, kind='data')
  93     load_demo = lambda *args: _load_data(cr, *args, kind='demo')
  94
  95     def load_test(module_name, idref, mode):
  96         cr.commit()
  97         if not tools.config.options['test_disable']:
  98             try:
  99                 threading.currentThread().testing = True
 100                 _load_data(cr, module_name, idref, mode, 'test')
 101             except Exception, e:
 102                 _logger.exception(
 103                     'Tests failed to execute in module %s', module_name)
 104             finally:
 105                 threading.currentThread().testing = False
 106                 if tools.config.options['test_commit']:
 107                     cr.commit()
 108                 else:
 109                     cr.rollback()
 110
 111     def _load_data(cr, module_name, idref, mode, kind):
 112         """
 113
 114         kind: data, demo, test, init_xml, update_xml, demo_xml.
 115
 116         noupdate is False, unless it is demo data or it is csv data in
 117         init mode.
 118
 119         """
 120         for filename in package.data[kind]:
 121             _logger.info("module %s: loading %s", module_name, filename)
 122             _, ext = os.path.splitext(filename)
 123             pathname = os.path.join(module_name, filename)
 124             fp = tools.file_open(pathname)
 125             noupdate = False
 126             if kind in ('demo', 'demo_xml'):
 127                 noupdate = True
 128             try:
 129                 if ext == '.csv':
 130                     if kind in ('init', 'init_xml'):
 131                         noupdate = True
 132                     tools.convert_csv_import(cr, module_name, pathname, fp.read(), idref, mode, noupdate)
 133                 elif ext == '.sql':
 134                     process_sql_file(cr, fp)
 135                 elif ext == '.yml':
 136                     tools.convert_yaml_import(cr, module_name, fp, idref, mode, noupdate)
 137                 else:
 138                     tools.convert_xml_import(cr, module_name, fp, idref, mode, noupdate, report)
 139             finally:
 140                 fp.close()
 141
 142     if status is None:
 143         status = {}
 144
 145     processed_modules = []
 146     loaded_modules = []
 147     pool = pooler.get_pool(cr.dbname)
 148     migrations = openerp.modules.migration.MigrationManager(cr, graph)
 149     _logger.debug('loading %d packages...', len(graph))
 150
 151     # get db timestamp
 152     cr.execute("select now()::timestamp")
 153     dt_before_load = cr.fetchone()[0]
 154
 155     # register, instantiate and initialize models for each modules
 156     for index, package in enumerate(graph):
 157         module_name = package.name
 158         module_id = package.id
 159
 160         if skip_modules and module_name in skip_modules:
 161             continue
 162
 163         _logger.info('module %s: loading objects', package.name)
 164         migrations.migrate_module(package, 'pre')
 165         load_openerp_module(package.name)
 166
 167         models = pool.load(cr, package)
 168         loaded_modules.append(package.name)
 169         if hasattr(package, 'init') or hasattr(package, 'update') or package.state in ('to install', 'to upgrade'):
 170             init_module_models(cr, package.name, models)
 171
 172         status['progress'] = float(index) / len(graph)
 173
 174         # Can't put this line out of the loop: ir.module.module will be
 175         # registered by init_module_models() above.
 176         modobj = pool.get('ir.module.module')
 177
 178         if perform_checks:
 179             modobj.check(cr, 1, [module_id])
 180
 181         idref = {}
 182
 183         mode = 'update'
 184         if hasattr(package, 'init') or package.state == 'to install':
 185             mode = 'init'
 186
 187         if hasattr(package, 'init') or hasattr(package, 'update') or package.state in ('to install', 'to upgrade'):
 188             if package.state=='to upgrade':
 189                 # upgrading the module information
 190                 modobj.write(cr, 1, [module_id], modobj.get_values_from_terp(package.data))
 191             load_init_xml(module_name, idref, mode)
 192             load_update_xml(module_name, idref, mode)
 193             load_data(module_name, idref, mode)
 194             if hasattr(package, 'demo') or (package.dbdemo and package.state != 'installed'):
 195                 status['progress'] = (index + 0.75) / len(graph)
 196                 load_demo_xml(module_name, idref, mode)
 197                 load_demo(module_name, idref, mode)
 198                 cr.execute('update ir_module_module set demo=%s where id=%s', (True, module_id))
 199
 200                 # launch tests only in demo mode, as most tests will depend
 201                 # on demo data. Other tests can be added into the regular
 202                 # 'data' section, but should probably not alter the data,
 203                 # as there is no rollback.
 204                 load_test(module_name, idref, mode)
 205
 206             processed_modules.append(package.name)
 207
 208             migrations.migrate_module(package, 'post')
 209
 210             ver = release.major_version + '.' + package.data['version']
 211             # Set new modules and dependencies
 212             modobj.write(cr, 1, [module_id], {'state': 'installed', 'latest_version': ver})
 213             # Update translations for all installed languages
 214             modobj.update_translations(cr, 1, [module_id], None)
 215
 216             package.state = 'installed'
 217             for kind in ('init', 'demo', 'update'):
 218                 if hasattr(package, kind):
 219                     delattr(package, kind)
 220
 221         cr.commit()
 222
 223     # mark new res_log records as read
 224     cr.execute("update res_log set read=True where create_date >= %s", (dt_before_load,))
 225
 226     cr.commit()
 227
 228     return loaded_modules, processed_modules
 229
 230 def _check_module_names(cr, module_names):
 231     mod_names = set(module_names)
 232     if 'base' in mod_names:
 233         # ignore dummy 'all' module
 234         if 'all' in mod_names:
 235             mod_names.remove('all')
 236     if mod_names:
 237         cr.execute("SELECT count(id) AS count FROM ir_module_module WHERE name in %s", (tuple(mod_names),))
 238         if cr.dictfetchone()['count'] != len(mod_names):
 239             # find out what module name(s) are incorrect:
 240             cr.execute("SELECT name FROM ir_module_module")
 241             incorrect_names = mod_names.difference([x['name'] for x in cr.dictfetchall()])
 242             _logger.warning('invalid module names, ignored: %s', ", ".join(incorrect_names))
 243
 244 def load_marked_modules(cr, graph, states, force, progressdict, report, loaded_modules):
 245     """Loads modules marked with ``states``, adding them to ``graph`` and
 246        ``loaded_modules`` and returns a list of installed/upgraded modules."""
 247     processed_modules = []
 248     while True:
 249         cr.execute("SELECT name from ir_module_module WHERE state IN %s" ,(tuple(states),))
 250         module_list = [name for (name,) in cr.fetchall() if name not in graph]
 251         new_modules_in_graph = graph.add_modules(cr, module_list, force)
 252         _logger.debug('Updating graph with %d more modules', len(module_list))
 253         loaded, processed = load_module_graph(cr, graph, progressdict, report=report, skip_modules=loaded_modules)
 254         processed_modules.extend(processed)
 255         loaded_modules.extend(loaded)
 256         if not processed: break
 257     return processed_modules
 258
 259
 260 def load_modules(db, force_demo=False, status=None, update_module=False):
 261     # TODO status['progress'] reporting is broken: used twice (and reset each
 262     # time to zero) in load_module_graph, not fine-grained enough.
 263     # It should be a method exposed by the pool.
 264     initialize_sys_path()
 265
 266     open_openerp_namespace()
 267
 268     force = []
 269     if force_demo:
 270         force.append('demo')
 271
 272     cr = db.cursor()
 273     try:
 274         if not openerp.modules.db.is_initialized(cr):
 275             _logger.info("init db")
 276             openerp.modules.db.initialize(cr)
 277             tools.config["init"]["all"] = 1
 278             tools.config['update']['all'] = 1
 279             if not tools.config['without_demo']:
 280                 tools.config["demo"]['all'] = 1
 281
 282         # This is a brand new pool, just created in pooler.get_db_and_pool()
 283         pool = pooler.get_pool(cr.dbname)
 284
 285         report = tools.assertion_report()
 286         if 'base' in tools.config['update'] or 'all' in tools.config['update']:
 287             cr.execute("update ir_module_module set state=%s where name=%s and state=%s", ('to upgrade', 'base', 'installed'))
 288
 289         # STEP 1: LOAD BASE (must be done before module dependencies can be computed for later steps)
 290         graph = openerp.modules.graph.Graph()
 291         graph.add_module(cr, 'base', force)
 292         if not graph:
 293             _logger.critical('module base cannot be loaded! (hint: verify addons-path)')
 294             raise osv.osv.except_osv(_('Could not load base module'), _('module base cannot be loaded! (hint: verify addons-path)'))
 295
 296         # processed_modules: for cleanup step after install
 297         # loaded_modules: to avoid double loading
 298         loaded_modules, processed_modules = load_module_graph(cr, graph, status, perform_checks=(not update_module), report=report)
 299
 300         if tools.config['load_language']:
 301             for lang in tools.config['load_language'].split(','):
 302                 tools.load_language(cr, lang)
 303
 304         # STEP 2: Mark other modules to be loaded/updated
 305         if update_module:
 306             modobj = pool.get('ir.module.module')
 307             if ('base' in tools.config['init']) or ('base' in tools.config['update']):
 308                 _logger.info('updating modules list')
 309                 modobj.update_list(cr, 1)
 310
 311             _check_module_names(cr, itertools.chain(tools.config['init'].keys(), tools.config['update'].keys()))
 312
 313             mods = [k for k in tools.config['init'] if tools.config['init'][k]]
 314             if mods:
 315                 ids = modobj.search(cr, 1, ['&', ('state', '=', 'uninstalled'), ('name', 'in', mods)])
 316                 if ids:
 317                     modobj.button_install(cr, 1, ids)
 318
 319             mods = [k for k in tools.config['update'] if tools.config['update'][k]]
 320             if mods:
 321                 ids = modobj.search(cr, 1, ['&', ('state', '=', 'installed'), ('name', 'in', mods)])
 322                 if ids:
 323                     modobj.button_upgrade(cr, 1, ids)
 324
 325             cr.execute("update ir_module_module set state=%s where name=%s", ('installed', 'base'))
 326
 327
 328         # STEP 3: Load marked modules (skipping base which was done in STEP 1)
 329         # IMPORTANT: this is done in two parts, first loading all installed or
 330         #            partially installed modules (i.e. installed/to upgrade), to
 331         #            offer a consistent system to the second part: installing
 332         #            newly selected modules.
 333         states_to_load = ['installed', 'to upgrade']
 334         processed = load_marked_modules(cr, graph, states_to_load, force, status, report, loaded_modules)
 335         processed_modules.extend(processed)
 336         if update_module:
 337             states_to_load = ['to install']
 338             processed = load_marked_modules(cr, graph, states_to_load, force, status, report, loaded_modules)
 339             processed_modules.extend(processed)
 340
 341         # load custom models
 342         cr.execute('select model from ir_model where state=%s', ('manual',))
 343         for model in cr.dictfetchall():
 344             pool.get('ir.model').instanciate(cr, 1, model['model'], {})
 345
 346         # STEP 4: Finish and cleanup
 347         if processed_modules:
 348             cr.execute("""select model,name from ir_model where id NOT IN (select distinct model_id from ir_model_access)""")
 349             for (model, name) in cr.fetchall():
 350                 model_obj = pool.get(model)
 351                 if model_obj and not model_obj.is_transient():
 352                     _logger.warning('Model %s (%s) has no access rules!', model, name)
 353
 354             # Temporary warning while we remove access rights on osv_memory objects, as they have
 355             # been replaced by owner-only access rights
 356             cr.execute("""select distinct mod.model, mod.name from ir_model_access acc, ir_model mod where acc.model_id = mod.id""")
 357             for (model, name) in cr.fetchall():
 358                 model_obj = pool.get(model)
 359                 if model_obj and model_obj.is_transient():
 360                     _logger.warning('The transient model %s (%s) should not have explicit access rules!', model, name)
 361
 362             cr.execute("SELECT model from ir_model")
 363             for (model,) in cr.fetchall():
 364                 obj = pool.get(model)
 365                 if obj:
 366                     obj._check_removed_columns(cr, log=True)
 367                 else:
 368                     _logger.warning("Model %s is declared but cannot be loaded! (Perhaps a module was partially removed or renamed)", model)
 369
 370             # Cleanup orphan records
 371             pool.get('ir.model.data')._process_end(cr, 1, processed_modules)
 372
 373         for kind in ('init', 'demo', 'update'):
 374             tools.config[kind] = {}
 375
 376         cr.commit()
 377         if update_module:
 378             # Remove records referenced from ir_model_data for modules to be
 379             # removed (and removed the references from ir_model_data).
 380             #cr.execute("select id,name from ir_module_module where state=%s", ('to remove',))
 381             #remove_modules = map(lambda x: x['name'], cr.dictfetchall())
 382             # Cleanup orphan records
 383             #print "pooler", pool.get('mrp.bom')
 384             #pool.get('ir.model.data')._process_end(cr, 1, remove_modules, noupdate=None)
 385 #            for mod_id, mod_name in cr.fetchall():
 386 #                cr.execute('select model,res_id from ir_model_data where noupdate=%s and module=%s order by id desc', (False, mod_name,))
 387 #                for rmod, rid in cr.fetchall():
 388 #                    uid = 1
 389 #                    rmod_module= pool.get(rmod)
 390 #                    if rmod_module:
 391 #                        rmod_module.unlink(cr, uid, [rid])
 392 #                    else:
 393 #                        _logger.error('Could not locate %s to remove res=%d' % (rmod,rid))
 394 #                cr.execute('delete from ir_model_data where  module=%s', (mod_name,))
 395 #                cr.commit()
 396
 397             # Remove menu items that are not referenced by any of other
 398             # (child) menu item, ir_values, or ir_model_data.
 399             # This code could be a method of ir_ui_menu.
 400             # TODO: remove menu without actions of children
 401             while True:
 402                 cr.execute('''delete from
 403                         ir_ui_menu
 404                     where
 405                         (id not IN (select parent_id from ir_ui_menu where parent_id is not null))
 406                     and
 407                         (id not IN (select res_id from ir_values where model='ir.ui.menu'))
 408                     and
 409                         (id not IN (select res_id from ir_model_data where model='ir.ui.menu'))''')
 410                 cr.commit()
 411                 if not cr.rowcount:
 412                     break
 413                 else:
 414                     _logger.info('removed %d unused menus', cr.rowcount)
 415
 416             # Pretend that modules to be removed are actually uninstalled.
 417             #cr.execute("update ir_module_module set state=%s where state=%s", ('uninstalled', 'to remove',))
 418             #cr.commit()
 419
 420         _logger.info('Modules loaded.')
 421     finally:
 422         cr.close()
 423
 424
 425 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: