The whole source code is distributed under the terms of the
GNU Public Licence.
-(c) 2003-TODAY, Fabien Pinckaers - OpenERP s.a.
+(c) 2003-TODAY, Fabien Pinckaers - OpenERP SA
"""
-#----------------------------------------------------------
-# python imports
-#----------------------------------------------------------
import logging
import os
import signal
import traceback
import time
-import openerp.release as release
-__author__ = release.author
-__version__ = release.version
+import openerp
+__author__ = openerp.release.author
+__version__ = openerp.release.version
-if os.name == 'posix':
- import pwd
- # We DON't log this using the standard logger, because we might mess
- # with the logfile's permissions. Just do a quick exit here.
- if pwd.getpwuid(os.getuid())[0] == 'root' :
- sys.stderr.write("Attempted to run OpenERP server as root. This is not good, aborting.\n")
- sys.exit(1)
+# Also use the `openerp` logger for the main script.
+_logger = logging.getLogger('openerp')
-#-----------------------------------------------------------------------
-# import the tools module so that the commandline parameters are parsed
-#-----------------------------------------------------------------------
-import openerp.tools as tools
-tools.config.parse_config(sys.argv[1:])
-
-#----------------------------------------------------------
-# get logger
-#----------------------------------------------------------
-import openerp.netsvc as netsvc
-netsvc.init_logger()
-logger = logging.getLogger('server')
-
-logger.info("OpenERP version - %s", release.version)
-for name, value in [('addons_path', tools.config['addons_path']),
- ('database hostname', tools.config['db_host'] or 'localhost'),
- ('database port', tools.config['db_port'] or '5432'),
- ('database user', tools.config['db_user'])]:
- logger.info("%s - %s", name, value)
-
-# Don't allow if the connection to PostgreSQL done by postgres user
-if tools.config['db_user'] == 'postgres':
- logger.error("Connecting to the database as 'postgres' user is forbidden, as it present major security issues. Shutting down.")
- sys.exit(1)
-
-#----------------------------------------------------------
-# init net service
-#----------------------------------------------------------
-logger.info('initialising distributed objects services')
-
-#---------------------------------------------------------------
-# connect to the database and initialize it with base if needed
-#---------------------------------------------------------------
-import openerp.pooler as pooler
-
-#----------------------------------------------------------
-# Load and update databases if requested
-#----------------------------------------------------------
-
-import openerp.service.http_server as http_server
-import openerp.service.netrpc_server as netrpc_server
-
-if not ( tools.config["stop_after_init"] or \
- tools.config["translate_in"] or \
- tools.config["translate_out"] ):
- http_server.init_servers()
- http_server.init_xmlrpc()
- http_server.init_static_http()
- netrpc_server.init_servers()
-
-if tools.config['db_name']:
- for dbname in tools.config['db_name'].split(','):
- db,pool = pooler.get_db_and_pool(dbname, update_module=tools.config['init'] or tools.config['update'], pooljobs=False)
- cr = db.cursor()
+def check_root_user():
+ """ Exit if the process's user is 'root' (on POSIX system)."""
+ if os.name == 'posix':
+ import pwd
+ if pwd.getpwuid(os.getuid())[0] == 'root' :
+ 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'.
- if tools.config["test_file"]:
- logger.info('loading test file %s', tools.config["test_file"])
- tools.convert_yaml_import(cr, 'base', file(tools.config["test_file"]), {}, 'test', True)
- cr.rollback()
+ This function assumes the configuration has been initialized.
+ """
+ config = openerp.tools.config
+ if config['db_user'] == 'postgres':
+ sys.stderr.write("Using the database user 'postgres' is a security risk, aborting.")
+ sys.exit(1)
- pool.get('ir.cron')._poolJobs(db.dbname)
+def report_configuration():
+ """ Log the server version and some configuration values.
+ This function assumes the configuration has been initialized.
+ """
+ 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)
+
+def setup_pid_file():
+ """ Create a file with the process id written in it.
+
+ This function assumes the configuration has been initialized.
+ """
+ config = openerp.tools.config
+ if config['pidfile']:
+ fd = open(config['pidfile'], 'w')
+ pidtext = "%d" % (os.getpid())
+ fd.write(pidtext)
+ fd.close()
+
+def preload_registry(dbname):
+ """ Preload a registry, and start the cron."""
+ try:
+ db, registry = openerp.pooler.get_db_and_pool(dbname, update_module=openerp.tools.config['init'] or openerp.tools.config['update'], pooljobs=False)
+
+ # jobs will start to be processed later, when openerp.cron.start_master_thread() is called by openerp.service.start_services()
+ registry.schedule_cron_jobs()
+ except Exception:
+ _logger.exception('Failed to initialize database `%s`.', dbname)
+
+def run_test_file(dbname, test_file):
+ """ Preload a registry, possibly run a test file, and start the cron."""
+ try:
+ db, registry = openerp.pooler.get_db_and_pool(dbname, update_module=config['init'] or config['update'], pooljobs=False)
+ cr = db.cursor()
+ _logger.info('loading test file %s', test_file)
+ openerp.tools.convert_yaml_import(cr, 'base', file(test_file), 'test', {}, 'test', True)
+ cr.rollback()
cr.close()
+ except Exception:
+ _logger.exception('Failed to initialize database `%s` and run test file `%s`.', dbname, test_file)
+
+def export_translation():
+ config = openerp.tools.config
+ dbname = config['db_name']
-#----------------------------------------------------------
-# translation stuff
-#----------------------------------------------------------
-if tools.config["translate_out"]:
- if tools.config["language"]:
- msg = "language %s" % (tools.config["language"],)
+ if config["language"]:
+ msg = "language %s" % (config["language"],)
else:
msg = "new language"
- logger.info('writing translation file for %s to %s', msg, tools.config["translate_out"])
-
- fileformat = os.path.splitext(tools.config["translate_out"])[-1][1:].lower()
- buf = file(tools.config["translate_out"], "w")
- dbname = tools.config['db_name']
- cr = pooler.get_db(dbname).cursor()
- tools.trans_export(tools.config["language"], tools.config["translate_modules"] or ["all"], buf, fileformat, cr)
+ _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')
- sys.exit(0)
+ _logger.info('translation file written successfully')
+
+def import_translation():
+ config = openerp.tools.config
+ context = {'overwrite': config["overwrite_existing_translations"]}
+ dbname = config['db_name']
-if tools.config["translate_in"]:
- context = {'overwrite': tools.config["overwrite_existing_translations"]}
- dbname = tools.config['db_name']
- cr = pooler.get_db(dbname).cursor()
- tools.trans_load(cr,
- tools.config["translate_in"],
- tools.config["language"],
- context=context)
- tools.trans_update_res_ids(cr)
+ cr = openerp.pooler.get_db(dbname).cursor()
+ openerp.tools.trans_load( cr, config["translate_in"], config["language"],
+ context=context)
cr.commit()
cr.close()
- sys.exit(0)
-
-#----------------------------------------------------------------------------------
-# if we don't want the server to continue to run after initialization, we quit here
-#----------------------------------------------------------------------------------
-if tools.config["stop_after_init"]:
- sys.exit(0)
-
-#----------------------------------------------------------
-# Launch Servers
-#----------------------------------------------------------
-
-LST_SIGNALS = ['SIGINT', 'SIGTERM']
-
-SIGNALS = dict(
- [(getattr(signal, sign), sign) for sign in LST_SIGNALS]
-)
+# Variable keeping track of the number of calls to the signal handler defined
+# below. This variable is monitored by ``quit_on_signals()``.
quit_signals_received = 0
-def handler(signum, frame):
- """
- :param signum: the signal number
+def signal_handler(sig, frame):
+ """ Signal handler: exit ungracefully on the second handled signal.
+
+ :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)
- id2name = dict([(threadId, thread.getName()) for threadId, thread in thread_map.items()])
+ threads_info = dict([(th.ident, {'name': th.name,
+ 'uid': getattr(th,'uid','n/a')})
+ for th in threading.enumerate()])
code = []
for threadId, stack in sys._current_frames().items():
- code.append("\n# Thread: %s(%d)" % (id2name[threadId], threadId))
+ thread_info = threads_info.get(threadId)
+ code.append("\n# Thread: %s (id:%s) (uid:%s)" % \
+ (thread_info and thread_info['name'] or 'n/a',
+ threadId,
+ thread_info and thread_info['uid'] or 'n/a'))
for filename, lineno, name, line in traceback.extract_stack(stack):
code.append('File: "%s", line %d, in %s' % (filename, lineno, name))
if line:
code.append(" %s" % (line.strip()))
- logging.getLogger('dumpstacks').info("\n".join(code))
-
-for signum in SIGNALS:
- signal.signal(signum, handler)
-
-if os.name == 'posix':
- signal.signal(signal.SIGQUIT, dumpstacks)
-
-def quit():
- netsvc.Agent.quit()
- netsvc.Server.quitAll()
- if tools.config['pidfile']:
- os.unlink(tools.config['pidfile'])
- logger = logging.getLogger('shutdown')
- logger.info("Initiating OpenERP Server shutdown")
- logger.info("Hit CTRL-C again or send a second signal to immediately terminate the server...")
- logging.shutdown()
-
- # manually join() all threads before calling sys.exit() to allow a second signal
- # to trigger _force_quit() in case some non-daemon threads won't exit cleanly.
- # threading.Thread.join() should not mask signals (at least in python 2.5)
- for thread in threading.enumerate():
- if thread != threading.currentThread() and not thread.isDaemon():
- while thread.isAlive():
- # need a busyloop here as thread.join() masks signals
- # and would present the forced shutdown
- thread.join(0.05)
- time.sleep(0.05)
+ _logger.info("\n".join(code))
+
+def setup_signal_handlers():
+ """ Register the signal handler defined above. """
+ SIGNALS = map(lambda x: getattr(signal, "SIG%s" % x), "INT TERM".split())
+ if os.name == 'posix':
+ map(lambda sig: signal.signal(sig, signal_handler), SIGNALS)
+ signal.signal(signal.SIGQUIT, dumpstacks)
+ elif os.name == 'nt':
+ import win32api
+ win32api.SetConsoleCtrlHandler(lambda sig: signal_handler(sig, None), 1)
+
+def quit_on_signals():
+ """ 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.) The try/except is for the win32 case.
+ try:
+ while quit_signals_received == 0:
+ time.sleep(60)
+ except KeyboardInterrupt:
+ pass
+
+ config = openerp.tools.config
+ if config['pidfile']:
+ os.unlink(config['pidfile'])
+
+ openerp.service.stop_services()
sys.exit(0)
-if tools.config['pidfile']:
- fd = open(tools.config['pidfile'], 'w')
- pidtext = "%d" % (os.getpid())
- fd.write(pidtext)
- fd.close()
+def configure_babel_localedata_path():
+ # Workaround: py2exe and babel.
+ if hasattr(sys, 'frozen'):
+ import babel
+ babel.localedata._dirname = os.path.join(os.path.dirname(sys.executable), 'localedata')
+
+def main():
+ os.environ["TZ"] = "UTC"
+
+ check_root_user()
+ openerp.tools.config.parse_config(sys.argv[1:])
+
+ check_postgres_user()
+ openerp.netsvc.init_logger()
+ report_configuration()
+
+ config = openerp.tools.config
+
+ configure_babel_localedata_path()
+
+ setup_signal_handlers()
+
+ if config["test_file"]:
+ run_test_file(config['db_name'], config['test_file'])
+ sys.exit(0)
+
+ if config["translate_out"]:
+ export_translation()
+ sys.exit(0)
+
+ if config["translate_in"]:
+ import_translation()
+ sys.exit(0)
+
+ if not config["stop_after_init"]:
+ setup_pid_file()
+ # Some module register themselves when they are loaded so we need the
+ # services to be running before loading any registry.
+ if config['workers']:
+ openerp.service.start_services_workers()
+ else:
+ openerp.service.start_services()
-netsvc.Server.startAll()
+ if config['db_name']:
+ for dbname in config['db_name'].split(','):
+ preload_registry(dbname)
-logger.info('OpenERP server is running, waiting for connections...')
+ if config["stop_after_init"]:
+ sys.exit(0)
-while quit_signals_received == 0:
- time.sleep(60)
+ _logger.info('OpenERP server is running, waiting for connections...')
+ quit_on_signals()
-quit()
+if __name__ == "__main__":
+ main()
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: