openerp-server

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 ##############################################################################
   4 #
   5 #    OpenERP, Open Source Management Solution
   6 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   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 """
  24 OpenERP - Server
  25 OpenERP is an ERP+CRM program for small and medium businesses.
  26
  27 The whole source code is distributed under the terms of the
  28 GNU Public Licence.
  29
  30 (c) 2003-TODAY, Fabien Pinckaers - OpenERP SA
  31 """
  32
  33 import logging
  34 import os
  35 import signal
  36 import sys
  37 import threading
  38 import traceback
  39 import time
  40
  41 import openerp
  42 __author__ = openerp.release.author
  43 __version__ = openerp.release.version
  44
  45 import sys
  46 import imp
  47
  48 def check_root_user():
  49     """ Exit if the process's user is 'root' (on POSIX system)."""
  50     if os.name == 'posix':
  51         import pwd
  52         if pwd.getpwuid(os.getuid())[0] == 'root' :
  53             sys.stderr.write("Running as user 'root' is a security risk, aborting.\n")
  54             sys.exit(1)
  55
  56 def check_postgres_user():
  57     """ Exit if the configured database user is 'postgres'.
  58
  59     This function assumes the configuration has been initialized.
  60     """
  61     config = openerp.tools.config
  62     if config['db_user'] == 'postgres':
  63         sys.stderr.write("Using the database user 'postgres' is a security risk, aborting.")
  64         sys.exit(1)
  65
  66 def report_configuration():
  67     """ Log the server version and some configuration values.
  68
  69     This function assumes the configuration has been initialized.
  70     """
  71     config = openerp.tools.config
  72     logger = logging.getLogger('server')
  73     logger.info("OpenERP version %s", __version__)
  74     for name, value in [('addons paths', config['addons_path']),
  75                         ('database hostname', config['db_host'] or 'localhost'),
  76                         ('database port', config['db_port'] or '5432'),
  77                         ('database user', config['db_user'])]:
  78         logger.info("%s: %s", name, value)
  79
  80 def setup_pid_file():
  81     """ Create a file with the process id written in it.
  82
  83     This function assumes the configuration has been initialized.
  84     """
  85     config = openerp.tools.config
  86     if config['pidfile']:
  87         fd = open(config['pidfile'], 'w')
  88         pidtext = "%d" % (os.getpid())
  89         fd.write(pidtext)
  90         fd.close()
  91
  92 def preload_registry(dbname):
  93     """ Preload a registry, and start the cron."""
  94     try:
  95         db, registry = openerp.pooler.get_db_and_pool(dbname, update_module=config['init'] or config['update'], pooljobs=False)
  96
  97         # jobs will start to be processed later, when openerp.cron.start_master_thread() is called by openerp.service.start_services()
  98         registry.schedule_cron_jobs()
  99     except Exception:
 100         logging.exception('Failed to initialize database `%s`.', dbname)
 101
 102 def run_test_file(dbname, test_file):
 103     """ Preload a registry, possibly run a test file, and start the cron."""
 104     try:
 105         db, registry = openerp.pooler.get_db_and_pool(dbname, update_module=config['init'] or config['update'], pooljobs=False)
 106         cr = db.cursor()
 107         logger = logging.getLogger('server')
 108         logger.info('loading test file %s', test_file)
 109         openerp.tools.convert_yaml_import(cr, 'base', file(test_file), {}, 'test', True)
 110         cr.rollback()
 111         cr.close()
 112     except Exception:
 113         logging.exception('Failed to initialize database `%s` and run test file `%s`.', dbname, test_file)
 114
 115
 116 def export_translation():
 117     config = openerp.tools.config
 118     dbname = config['db_name']
 119     logger = logging.getLogger('server')
 120
 121     if config["language"]:
 122         msg = "language %s" % (config["language"],)
 123     else:
 124         msg = "new language"
 125     logger.info('writing translation file for %s to %s', msg,
 126         config["translate_out"])
 127
 128     fileformat = os.path.splitext(config["translate_out"])[-1][1:].lower()
 129     buf = file(config["translate_out"], "w")
 130     cr = openerp.pooler.get_db(dbname).cursor()
 131     openerp.tools.trans_export(config["language"],
 132         config["translate_modules"] or ["all"], buf, fileformat, cr)
 133     cr.close()
 134     buf.close()
 135
 136     logger.info('translation file written successfully')
 137
 138 def import_translation():
 139     config = openerp.tools.config
 140     context = {'overwrite': config["overwrite_existing_translations"]}
 141     dbname = config['db_name']
 142
 143     cr = openerp.pooler.get_db(dbname).cursor()
 144     openerp.tools.trans_load( cr, config["translate_in"], config["language"],
 145         context=context)
 146     cr.commit()
 147     cr.close()
 148
 149 # Variable keeping track of the number of calls to the signal handler defined
 150 # below. This variable is monitored by ``quit_on_signals()``.
 151 quit_signals_received = 0
 152
 153 def signal_handler(sig, frame):
 154     """ Signal handler: exit ungracefully on the second handled signal.
 155
 156     :param sig: the signal number
 157     :param frame: the interrupted stack frame or None
 158     """
 159     global quit_signals_received
 160     quit_signals_received += 1
 161     if quit_signals_received > 1:
 162         # logging.shutdown was already called at this point.
 163         sys.stderr.write("Forced shutdown.\n")
 164         os._exit(0)
 165
 166 def dumpstacks(sig, frame):
 167     """ Signal handler: dump a stack trace for each existing thread."""
 168     # code from http://stackoverflow.com/questions/132058/getting-stack-trace-from-a-running-python-application#answer-2569696
 169     # modified for python 2.5 compatibility
 170     thread_map = dict(threading._active, **threading._limbo)
 171     id2name = dict([(threadId, thread.getName()) for threadId, thread in thread_map.items()])
 172     code = []
 173     for threadId, stack in sys._current_frames().items():
 174         code.append("\n# Thread: %s(%d)" % (id2name[threadId], threadId))
 175         for filename, lineno, name, line in traceback.extract_stack(stack):
 176             code.append('File: "%s", line %d, in %s' % (filename, lineno, name))
 177             if line:
 178                 code.append("  %s" % (line.strip()))
 179     logging.getLogger('dumpstacks').info("\n".join(code))
 180
 181 def setup_signal_handlers():
 182     """ Register the signal handler defined above. """
 183     SIGNALS = map(lambda x: getattr(signal, "SIG%s" % x), "INT TERM".split())
 184     if os.name == 'posix':
 185         map(lambda sig: signal.signal(sig, signal_handler), SIGNALS)
 186         signal.signal(signal.SIGQUIT, dumpstacks)
 187     elif os.name == 'nt':
 188         import win32api
 189         win32api.SetConsoleCtrlHandler(lambda sig: signal_handler(sig, None), 1)
 190
 191 def quit_on_signals():
 192     """ Wait for one or two signals then shutdown the server.
 193
 194     The first SIGINT or SIGTERM signal will initiate a graceful shutdown while
 195     a second one if any will force an immediate exit.
 196
 197     """
 198     # Wait for a first signal to be handled. (time.sleep will be interrupted
 199     # by the signal handler.) The try/except is for the win32 case.
 200     try:
 201         while quit_signals_received == 0:
 202             time.sleep(60)
 203     except KeyboardInterrupt, e:
 204         pass
 205
 206     if config['pidfile']:
 207         os.unlink(config['pidfile'])
 208
 209     openerp.service.stop_services()
 210     sys.exit(0)
 211
 212 if __name__ == "__main__":
 213
 214     os.environ["TZ"] = "UTC"
 215
 216     check_root_user()
 217     openerp.tools.config.parse_config(sys.argv[1:])
 218
 219     check_postgres_user()
 220     openerp.netsvc.init_logger()
 221     report_configuration()
 222
 223     config = openerp.tools.config
 224
 225     setup_signal_handlers()
 226
 227     if config["test_file"]:
 228         run_test_file(config['db_name'], config['test_file'])
 229         sys.exit(0)
 230
 231     if config["translate_out"]:
 232         export_translation()
 233         sys.exit(0)
 234
 235     if config["translate_in"]:
 236         import_translation()
 237         sys.exit(0)
 238
 239     if not config["stop_after_init"]:
 240         # Some module register themselves when they are loaded so we need the
 241         # services to be running before loading any registry.
 242         openerp.service.start_services()
 243
 244     for m in openerp.conf.server_wide_modules:
 245         try:
 246             __import__(m)
 247             # Call any post_load hook.
 248             info = openerp.modules.module.load_information_from_description_file(m)
 249             if info['post_load']:
 250                 getattr(sys.modules[m], info['post_load'])()
 251         except Exception:
 252             msg = ''
 253             if m == 'web':
 254                 msg = """
 255 The `web` module is provided by the addons found in the `openerp-web` project.
 256 Maybe you forgot to add those addons in your addons_path configuration."""
 257             logging.exception('Failed to load server-wide module `%s`.%s', m, msg)
 258
 259     if config['db_name']:
 260         for dbname in config['db_name'].split(','):
 261             preload_registry(dbname)
 262
 263     if config["stop_after_init"]:
 264         sys.exit(0)
 265
 266     setup_pid_file()
 267     logger = logging.getLogger('server')
 268     logger.info('OpenERP server is running, waiting for connections...')
 269     quit_on_signals()
 270
 271 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: