[REF] openerp-server: streamlining startup script.

bzr revid: vmt@openerp.com-20110823103343-rvy2zkre8bo9cq6g

openerp-server

@@ -30,9 +30,6 @@ GNU Public Licence.
 (c) 2003-TODAY, Fabien Pinckaers - OpenERP s.a.
 """
 
-#----------------------------------------------------------
-# python imports
-#----------------------------------------------------------
 import logging
 import os
 import signal
@@ -45,139 +42,128 @@ import openerp
 __author__ = openerp.release.author
 __version__ = openerp.release.version
 
-if os.name == 'posix':
+def check_root_user():
-    import pwd
+    """ Exit if the process’s user is 'root' (on POSIX system)."""
-    # We DON't log this using the standard logger, because we might mess
+    if os.name == 'posix':
-    # with the logfile's permissions. Just do a quick exit here.
+        import pwd
-    if pwd.getpwuid(os.getuid())[0] == 'root' :
+        if pwd.getpwuid(os.getuid())[0] == 'root' :
-        sys.stderr.write("Attempted to run OpenERP server as root. This is not good, aborting.\n")
+            sys.stderr.write("Running as user 'root' is a security risk, aborting.\n")
+            sys.exit(1)
+
+def check_postgres_user():
+    """ Exit if the configured database user is 'postgres'."""
+    config = openerp.tools.config
+    logger = logging.getLogger('server')
+    if config['db_user'] == 'postgres':
+        sys.stderr.write("Using the database user 'postgres' is a security risk, aborting.")
         sys.exit(1)
 
-#-----------------------------------------------------------------------
+def report_configuration():
-# parse the command line
+    """ Log the server version and some configuration values."""
-#-----------------------------------------------------------------------
+    config = openerp.tools.config
-openerp.tools.config.parse_config(sys.argv[1:])
+    logger = logging.getLogger('server')
-config = openerp.tools.config
+    logger.info("OpenERP version %s", __version__)
+    for name, value in [('addons paths', config['addons_path']),
+                        ('database hostname', config['db_host'] or 'localhost'),
+                        ('database port', config['db_port'] or '5432'),
+                        ('database user', config['db_user'])]:
+        logger.info("%s: %s", name, value)
 
-#----------------------------------------------------------
+# TODO is a \n better?
-# get logger
+def setup_pid_file():
-#----------------------------------------------------------
+    config = openerp.tools.config
-openerp.netsvc.init_logger()
+    if config['pidfile']:
-logger = logging.getLogger('server')
+        fd = open(config['pidfile'], 'w')
+        pidtext = "%d" % (os.getpid())
+        fd.write(pidtext)
+        fd.close()
 
-logger.info("OpenERP version - %s", __version__)
+def run_registry(dbname):
-for name, value in [('addons_path', config['addons_path']),
+    """ Preload a registry, possibly run a test file, and start the cron."""
-                    ('database hostname', config['db_host'] or 'localhost'),
+    db, pool = openerp.pooler.get_db_and_pool(dbname, update_module=config['init'] or config['update'], pooljobs=False)
-                    ('database port', config['db_port'] or '5432'),
-                    ('database user', config['db_user'])]:
-    logger.info("%s - %s", name, value)
 
-# Don't allow if the connection to PostgreSQL done by postgres user
+    if config["test_file"]:
-if config['db_user'] == 'postgres':
+        cr = db.cursor()
-    logger.error("Connecting to the database as 'postgres' user is forbidden, as it present major security issues. Shutting down.")
+        logger = logging.getLogger('server')
-    sys.exit(1)
+        logger.info('loading test file %s', config["test_file"])
+        openerp.tools.convert_yaml_import(cr, 'base', file(config["test_file"]), {}, 'test', True)
+        cr.rollback()
+        cr.close()
 
-#----------------------------------------------------------
+    pool.get('ir.cron').restart(db.dbname)
-# init net service
-#----------------------------------------------------------
-logger.info('initialising distributed objects services')
 
-#----------------------------------------------------------
+def export_translation():
-# Load and update databases if requested
+    config = openerp.tools.config
-#----------------------------------------------------------
+    dbname = config['db_name']
+    logger = logging.getLogger('server')
 
-if not ( config["stop_after_init"] or \
+    if config["language"]:
-    config["translate_in"] or \
+        msg = "language %s" % (config["language"],)
-    config["translate_out"] ):
+    else:
-    openerp.osv.osv.start_object_proxy()
+        msg = "new language"
-    openerp.service.web_services.start_web_services()
+    logger.info('writing translation file for %s to %s', msg,
+        config["translate_out"])
+
+    fileformat = os.path.splitext(config["translate_out"])[-1][1:].lower()
+    buf = file(config["translate_out"], "w")
+    cr = openerp.pooler.get_db(dbname).cursor()
+    openerp.tools.trans_export(config["language"],
+        config["translate_modules"] or ["all"], buf, fileformat, cr)
+    cr.close()
+    buf.close()
+
+    logger.info('translation file written successfully')
+
+def import_translation():
+    config = openerp.tools.config
+    context = {'overwrite': config["overwrite_existing_translations"]}
+    dbname = config['db_name']
+
+    cr = openerp.pooler.get_db(dbname).cursor()
+    openerp.tools.trans_load( cr, config["translate_in"], config["language"],
+        context=context)
+    openerp.tools.trans_update_res_ids(cr)
+    cr.commit()
+    cr.close()
+
+def start_services():
     http_server = openerp.service.http_server
     netrpc_server = openerp.service.netrpc_server
+
+    # Instantiate local services (this is a legacy design).
+    openerp.osv.osv.start_object_proxy()
+    # Export (for RPC) services.
+    openerp.service.web_services.start_web_services()
+
+    # Initialize the HTTP stack.
     http_server.init_servers()
     http_server.init_xmlrpc()
     http_server.init_static_http()
     netrpc_server.init_servers()
 
-if config['db_name']:
+    # Start the main cron thread.
-    for dbname in config['db_name'].split(','):
+    openerp.netsvc.start_agent()
-        db, pool = openerp.pooler.get_db_and_pool(dbname, update_module=config['init'] or config['update'], pooljobs=False)
-        cr = db.cursor()
 
-        if config["test_file"]:
+    # Start the top-level servers threads (normally HTTP, HTTPS, and NETRPC).
-            logger.info('loading test file %s', config["test_file"])
+    openerp.netsvc.Server.startAll()
-            openerp.tools.convert_yaml_import(cr, 'base', file(config["test_file"]), {}, 'test', True)
-            cr.rollback()
-
-        pool.get('ir.cron').restart(db.dbname)
-
-        cr.close()
-
-#----------------------------------------------------------
-# translation stuff
-#----------------------------------------------------------
-if config["translate_out"]:
-    if config["language"]:
-        msg = "language %s" % (config["language"],)
-    else:
-        msg = "new language"
-    logger.info('writing translation file for %s to %s', msg, config["translate_out"])
-
-    fileformat = os.path.splitext(config["translate_out"])[-1][1:].lower()
-    buf = file(config["translate_out"], "w")
-    dbname = config['db_name']
-    cr = openerp.pooler.get_db(dbname).cursor()
-    openerp.tools.trans_export(config["language"], config["translate_modules"] or ["all"], buf, fileformat, cr)
-    cr.close()
-    buf.close()
-
-    logger.info('translation file written successfully')
-    sys.exit(0)
-
-if config["translate_in"]:
-    context = {'overwrite': config["overwrite_existing_translations"]}
-    dbname = config['db_name']
-    cr = openerp.pooler.get_db(dbname).cursor()
-    openerp.tools.trans_load(cr,
-                     config["translate_in"], 
-                     config["language"],
-                     context=context)
-    openerp.tools.trans_update_res_ids(cr)
-    cr.commit()
-    cr.close()
-    sys.exit(0)
-
-#----------------------------------------------------------------------------------
-# if we don't want the server to continue to run after initialization, we quit here
-#----------------------------------------------------------------------------------
-if config["stop_after_init"]:
-    sys.exit(0)
-
-openerp.netsvc.start_agent()
-
-#----------------------------------------------------------
-# Launch Servers
-#----------------------------------------------------------
-
-LST_SIGNALS = ['SIGINT', 'SIGTERM']
-
-SIGNALS = dict(
-    [(getattr(signal, sign), sign) for sign in LST_SIGNALS]
-)
 
 quit_signals_received = 0
 
-def handler(signum, frame):
+def signal_handler(sig, frame):
-    """
+    """ Signal handler: exit ungracefully on the second handled signal.
-    :param signum: the signal number
+
+    :param sig: the signal number
     :param frame: the interrupted stack frame or None
     """
     global quit_signals_received
     quit_signals_received += 1
     if quit_signals_received > 1:
+        # logging.shutdown was already called at this point.
         sys.stderr.write("Forced shutdown.\n")
         os._exit(0)
 
-def dumpstacks(signum, frame):
+def dumpstacks(sig, frame):
+    """ Signal handler: dump a stack trace for each existing thread."""
     # code from http://stackoverflow.com/questions/132058/getting-stack-trace-from-a-running-python-application#answer-2569696
     # modified for python 2.5 compatibility
     thread_map = dict(threading._active, **threading._limbo)
@@ -191,20 +177,32 @@ def dumpstacks(signum, frame):
                 code.append("  %s" % (line.strip()))
     logging.getLogger('dumpstacks').info("\n".join(code))
 
-for signum in SIGNALS:
+def setup_signal_handlers():
-    signal.signal(signum, handler)
+    SIGNALS = map(lambda x: getattr(signal, "SIG%s" % x), "INT TERM".split())
+    map(lambda sig: signal.signal(sig, signal_handler), SIGNALS)
+    if os.name == 'posix':
+        signal.signal(signal.SIGQUIT, dumpstacks)
 
-if os.name == 'posix':
+def quit_on_signals():
-    signal.signal(signal.SIGQUIT, dumpstacks)
+    """ Wait for one or two signals then shutdown the server.
+
+    The first SIGINT or SIGTERM signal will initiate a graceful shutdown while
+    a second one if any will force an immediate exit.
+
+    """
+    # Wait for a first signal to be handled. (time.sleep will be interrupted
+    # by the signal handler.)
+    while quit_signals_received == 0:
+        time.sleep(60)
 
-def quit():
     openerp.netsvc.Agent.quit()
     openerp.netsvc.Server.quitAll()
+    config = openerp.tools.config
     if config['pidfile']:
         os.unlink(config['pidfile'])
-    logger = logging.getLogger('shutdown')
+    logger = logging.getLogger('server')
-    logger.info("Initiating OpenERP Server shutdown")
+    logger.info("Initiating shutdown")
-    logger.info("Hit CTRL-C again or send a second signal to immediately terminate the server...")
+    logger.info("Hit CTRL-C again or send a second signal to force the sutdown.")
     logging.shutdown()
 
     # manually join() all threads before calling sys.exit() to allow a second signal
@@ -219,19 +217,36 @@ def quit():
                 time.sleep(0.05)
     sys.exit(0)
 
-if config['pidfile']:
+if __name__ == "__main__":
-    fd = open(config['pidfile'], 'w')
-    pidtext = "%d" % (os.getpid())
-    fd.write(pidtext)
-    fd.close()
 
-openerp.netsvc.Server.startAll()
+    check_root_user()
+    openerp.tools.config.parse_config(sys.argv[1:])
+    check_postgres_user()
+    openerp.netsvc.init_logger()
+    report_configuration()
 
-logger.info('OpenERP server is running, waiting for connections...')
+    config = openerp.tools.config
 
-while quit_signals_received == 0:
+    if config["translate_out"]:
-    time.sleep(60)
+        export_translation()
+        sys.exit(0)
 
-quit()
+    if config["translate_in"]:
+        import_translation()
+        sys.exit(0)
+
+    if config['db_name']:
+        for dbname in config['db_name'].split(','):
+            run_registry(dbname)
+
+    if config["stop_after_init"]:
+        sys.exit(0)
+
+    setup_pid_file()
+    setup_signal_handlers()
+    start_services()
+    logger = logging.getLogger('server')
+    logger.info('OpenERP server is running, waiting for connections...')
+    quit_on_signals()
 
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:

openerp/tools/translate.py

@@ -458,7 +458,8 @@ def trans_export(lang, modules, buffer, format, cr):
             tar.close()
 
         else:
-            raise Exception(_('Bad file format'))
+            raise Exception(_('Unrecognized extension: must be one of '
+                '.csv, .po, or .tgz (received .%s).' % format))
 
     newlang = not bool(lang)
     if newlang: