#
# OpenERP, Open Source Management Solution
# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+# Copyright (C) 2010-2012 OpenERP s.a. (<http://openerp.com>).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
import os
import sys
import openerp
+import openerp.conf
import openerp.loglevels as loglevels
import logging
import openerp.release as release
+class MyOption (optparse.Option, object):
+ """ optparse Option with two additional attributes.
+
+ The list of command line options (getopt.Option) is used to create the
+ list of the configuration file options. When reading the file, and then
+ reading the command line arguments, we don't want optparse.parse results
+ to override the configuration file values. But if we provide default
+ values to optparse, optparse will return them and we can't know if they
+ were really provided by the user or not. A solution is to not use
+ optparse's default attribute, but use a custom one (that will be copied
+ to create the default values of the configuration file).
+
+ """
+ def __init__(self, *opts, **attrs):
+ self.my_default = attrs.pop('my_default', None)
+ super(MyOption, self).__init__(*opts, **attrs)
+
+#.apidoc title: Server Configuration Loader
+
def check_ssl():
try:
from OpenSSL import SSL
except:
return False
+DEFAULT_LOG_HANDLER = [':INFO']
+
class configmanager(object):
def __init__(self, fname=None):
# Options not exposed on the command line. Command line options will be added
# Not exposed in the configuration file.
self.blacklist_for_save = set(
['publisher_warranty_url', 'load_language', 'root_path',
- 'init', 'save', 'config', 'update'])
+ 'init', 'save', 'config', 'update', 'stop_after_init'])
+
+ # dictionary mapping option destination (keys in self.options) to MyOptions.
+ self.casts = {}
self.misc = {}
self.config_file = fname
self.has_ssl = check_ssl()
- self._LOGLEVELS = dict([(getattr(loglevels, 'LOG_%s' % x), getattr(logging, x))
- for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'TEST', 'DEBUG', 'DEBUG_RPC', 'DEBUG_SQL', 'DEBUG_RPC_ANSWER','NOTSET')])
+ self._LOGLEVELS = dict([(getattr(loglevels, 'LOG_%s' % x), getattr(logging, x)) for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'TEST', 'DEBUG', 'NOTSET')])
version = "%s %s" % (release.description, release.version)
- self.parser = parser = optparse.OptionParser(version=version)
+ self.parser = parser = optparse.OptionParser(version=version, option_class=MyOption)
# Server startup config
group = optparse.OptionGroup(parser, "Common options")
help="update one or more modules (comma-separated list, use \"all\" for all modules). Requires -d.")
group.add_option("--without-demo", dest="without_demo",
help="disable loading demo data for modules to be installed (comma-separated, use \"all\" for all modules). Requires -d and -i. Default is %default",
- default=False)
- group.add_option("-P", "--import-partial", dest="import_partial", default='',
+ my_default=False)
+ group.add_option("-P", "--import-partial", dest="import_partial", my_default='',
help="Use this for big data importation, if it crashes you will be able to continue at the current state. Provide a filename to store intermediate importation states.")
group.add_option("--pidfile", dest="pidfile", help="file where the server pid will be stored")
+ group.add_option("--addons-path", dest="addons_path",
+ help="specify additional addons paths (separated by commas).",
+ action="callback", callback=self._check_addons_path, nargs=1, type="string")
+ group.add_option("--load", dest="server_wide_modules", help="Comma-separated list of server-wide modules default=web")
parser.add_option_group(group)
+ # XML-RPC / HTTP
group = optparse.OptionGroup(parser, "XML-RPC Configuration")
- group.add_option("--xmlrpc-interface", dest="xmlrpc_interface", default='',
+ group.add_option("--xmlrpc-interface", dest="xmlrpc_interface", my_default='',
help="Specify the TCP IP address for the XML-RPC protocol. The empty string binds to all interfaces.")
- group.add_option("--xmlrpc-port", dest="xmlrpc_port", default=8069,
+ group.add_option("--xmlrpc-port", dest="xmlrpc_port", my_default=8069,
help="specify the TCP port for the XML-RPC protocol", type="int")
- group.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", default=True,
+ group.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", my_default=True,
help="disable the XML-RPC protocol")
+ group.add_option("--proxy-mode", dest="proxy_mode", action="store_true", my_default=False,
+ help="Enable correct behavior when behind a reverse proxy")
parser.add_option_group(group)
+ # XML-RPC / HTTPS
title = "XML-RPC Secure Configuration"
if not self.has_ssl:
title += " (disabled as ssl is unavailable)"
group = optparse.OptionGroup(parser, title)
- group.add_option("--xmlrpcs-interface", dest="xmlrpcs_interface", default='',
+ group.add_option("--xmlrpcs-interface", dest="xmlrpcs_interface", my_default='',
help="Specify the TCP IP address for the XML-RPC Secure protocol. The empty string binds to all interfaces.")
- group.add_option("--xmlrpcs-port", dest="xmlrpcs_port", default=8071,
+ group.add_option("--xmlrpcs-port", dest="xmlrpcs_port", my_default=8071,
help="specify the TCP port for the XML-RPC Secure protocol", type="int")
- group.add_option("--no-xmlrpcs", dest="xmlrpcs", action="store_false", default=True,
+ group.add_option("--no-xmlrpcs", dest="xmlrpcs", action="store_false", my_default=True,
help="disable the XML-RPC Secure protocol")
- group.add_option("--cert-file", dest="secure_cert_file", default='server.cert',
+ group.add_option("--cert-file", dest="secure_cert_file", my_default='server.cert',
help="specify the certificate file for the SSL connection")
- group.add_option("--pkey-file", dest="secure_pkey_file", default='server.pkey',
+ group.add_option("--pkey-file", dest="secure_pkey_file", my_default='server.pkey',
help="specify the private key file for the SSL connection")
parser.add_option_group(group)
# NET-RPC
group = optparse.OptionGroup(parser, "NET-RPC Configuration")
- group.add_option("--netrpc-interface", dest="netrpc_interface", default='',
+ group.add_option("--netrpc-interface", dest="netrpc_interface", my_default='',
help="specify the TCP IP address for the NETRPC protocol")
- group.add_option("--netrpc-port", dest="netrpc_port", default=8070,
+ group.add_option("--netrpc-port", dest="netrpc_port", my_default=8070,
help="specify the TCP port for the NETRPC protocol", type="int")
- group.add_option("--no-netrpc", dest="netrpc", action="store_false", default=True,
+ group.add_option("--no-netrpc", dest="netrpc", action="store_false", my_default=True,
help="disable the NETRPC protocol")
parser.add_option_group(group)
+ # WEB
+ # TODO move to web addons after MetaOption merge
+ group = optparse.OptionGroup(parser, "Web interface Configuration")
+ group.add_option("--db-filter", dest="dbfilter", default='.*',
+ help="Filter listed database", metavar="REGEXP")
+ parser.add_option_group(group)
+
# Static HTTP
group = optparse.OptionGroup(parser, "Static HTTP service")
- group.add_option("--static-http-enable", dest="static_http_enable", action="store_true", default=False, help="enable static HTTP service for serving plain HTML files")
+ group.add_option("--static-http-enable", dest="static_http_enable", action="store_true", my_default=False, help="enable static HTTP service for serving plain HTML files")
group.add_option("--static-http-document-root", dest="static_http_document_root", help="specify the directory containing your static HTML files (e.g '/var/www/')")
group.add_option("--static-http-url-prefix", dest="static_http_url_prefix", help="specify the URL root prefix where you want web browsers to access your static HTML files (e.g '/')")
parser.add_option_group(group)
# Testing Group
group = optparse.OptionGroup(parser, "Testing Configuration")
- group.add_option("--test-file", dest="test_file", default=False,
+ group.add_option("--test-file", dest="test_file", my_default=False,
help="Launch a YML test file.")
- group.add_option("--test-report-directory", dest="test_report_directory", default=False,
+ group.add_option("--test-report-directory", dest="test_report_directory", my_default=False,
help="If set, will save sample of all reports in this directory.")
group.add_option("--test-disable", action="store_true", dest="test_disable",
- default=False, help="Disable loading test files.")
+ my_default=False, help="Disable loading test files.")
group.add_option("--test-commit", action="store_true", dest="test_commit",
- default=False, help="Commit database changes performed by tests.")
+ my_default=False, help="Commit database changes performed by tests.")
group.add_option("--assert-exit-level", dest='assert_exit_level', type="choice", choices=self._LOGLEVELS.keys(),
- default='error',
+ my_default='error',
help="specify the level at which a failed assertion will stop the server. Accepted values: %s" % (self._LOGLEVELS.keys(),))
parser.add_option_group(group)
# Logging Group
group = optparse.OptionGroup(parser, "Logging Configuration")
group.add_option("--logfile", dest="logfile", help="file where the server log will be stored")
- group.add_option("--no-logrotate", dest="logrotate", action="store_false", default=True,
- help="do not rotate the logfile")
- group.add_option("--syslog", action="store_true", dest="syslog",
- default=False, help="Send the log to the syslog server")
- group.add_option('--log-level', dest='log_level', type='choice', choices=self._LOGLEVELS.keys(),
- default='info',
- help='specify the level of the logging. Accepted values: ' + str(self._LOGLEVELS.keys()))
+ group.add_option("--no-logrotate", dest="logrotate", action="store_false", my_default=True, help="do not rotate the logfile")
+ group.add_option("--syslog", action="store_true", dest="syslog", my_default=False, help="Send the log to the syslog server")
+ group.add_option('--log-handler', action="append", default=DEFAULT_LOG_HANDLER, my_default=DEFAULT_LOG_HANDLER, metavar="PREFIX:LEVEL", help='setup a handler at LEVEL for a given PREFIX. An empty PREFIX indicates the root logger. This option can be repeated. Example: "openerp.orm:DEBUG" or "werkzeug:CRITICAL" (default: ":INFO")')
+ group.add_option('--log-request', action="append_const", dest="log_handler", const="openerp.netsvc.rpc.request:DEBUG", help='shortcut for --log-handler=openerp.netsvc.rpc.request:DEBUG')
+ group.add_option('--log-response', action="append_const", dest="log_handler", const="openerp.netsvc.rpc.response:DEBUG", help='shortcut for --log-handler=openerp.netsvc.rpc.response:DEBUG')
+ group.add_option('--log-web', action="append_const", dest="log_handler", const="openerp.addons.web.common.http:DEBUG", help='shortcut for --log-handler=openerp.addons.web.common.http:DEBUG')
+ group.add_option('--log-sql', action="append_const", dest="log_handler", const="openerp.sql_db:DEBUG", help='shortcut for --log-handler=openerp.sql_db:DEBUG')
+ # For backward-compatibility, map the old log levels to something
+ # quite close.
+ levels = ['info', 'debug_rpc', 'warn', 'test', 'critical',
+ 'debug_sql', 'error', 'debug', 'debug_rpc_answer', 'notset']
+ group.add_option('--log-level', dest='log_level', type='choice', choices=levels,
+ my_default='info', help='specify the level of the logging. Accepted values: ' + str(levels) + ' (deprecated option).')
+
parser.add_option_group(group)
# SMTP Group
group = optparse.OptionGroup(parser, "SMTP Configuration")
- group.add_option('--email-from', dest='email_from', default=False,
+ group.add_option('--email-from', dest='email_from', my_default=False,
help='specify the SMTP email address for sending email')
- group.add_option('--smtp', dest='smtp_server', default='localhost',
+ group.add_option('--smtp', dest='smtp_server', my_default='localhost',
help='specify the SMTP server for sending email')
- group.add_option('--smtp-port', dest='smtp_port', default=25,
+ group.add_option('--smtp-port', dest='smtp_port', my_default=25,
help='specify the SMTP port', type="int")
- group.add_option('--smtp-ssl', dest='smtp_ssl', action='store_true', default=False,
+ group.add_option('--smtp-ssl', dest='smtp_ssl', action='store_true', my_default=False,
help='specify the SMTP server support SSL or not')
- group.add_option('--smtp-user', dest='smtp_user', default=False,
+ group.add_option('--smtp-user', dest='smtp_user', my_default=False,
help='specify the SMTP username for sending email')
- group.add_option('--smtp-password', dest='smtp_password', default=False,
+ group.add_option('--smtp-password', dest='smtp_password', my_default=False,
help='specify the SMTP password for sending email')
parser.add_option_group(group)
group = optparse.OptionGroup(parser, "Database related options")
- group.add_option("-d", "--database", dest="db_name", default=False,
+ group.add_option("-d", "--database", dest="db_name", my_default=False,
help="specify the database name")
- group.add_option("-r", "--db_user", dest="db_user", default=False,
+ group.add_option("-r", "--db_user", dest="db_user", my_default=False,
help="specify the database user name")
- group.add_option("-w", "--db_password", dest="db_password", default=False,
+ group.add_option("-w", "--db_password", dest="db_password", my_default=False,
help="specify the database password")
group.add_option("--pg_path", dest="pg_path", help="specify the pg executable path")
- group.add_option("--db_host", dest="db_host", default=False,
+ group.add_option("--db_host", dest="db_host", my_default=False,
help="specify the database host")
- group.add_option("--db_port", dest="db_port", default=False,
+ group.add_option("--db_port", dest="db_port", my_default=False,
help="specify the database port", type="int")
- group.add_option("--db_maxconn", dest="db_maxconn", type='int', default=64,
+ group.add_option("--db_maxconn", dest="db_maxconn", type='int', my_default=64,
help="specify the the maximum number of physical connections to posgresql")
+ group.add_option("--db-template", dest="db_template", my_default="template0",
+ help="specify a custom database template to create a new database")
parser.add_option_group(group)
group = optparse.OptionGroup(parser, "Internationalisation options",
group.add_option('--load-language', dest="load_language",
help="specifies the languages for the translations you want to be loaded")
group.add_option('-l', "--language", dest="language",
- default=None,
help="specify the language of the translation file. Use it with --i18n-export or --i18n-import")
group.add_option("--i18n-export", dest="translate_out",
help="export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit")
group.add_option("--i18n-import", dest="translate_in",
help="import a CSV or a PO file with translations and exit. The '-l' option is required.")
- group.add_option("--i18n-overwrite", dest="overwrite_existing_translations", action="store_true", default=False,
+ group.add_option("--i18n-overwrite", dest="overwrite_existing_translations", action="store_true", my_default=False,
help="overwrites existing translation terms on updating a module or importing a CSV or a PO file.")
group.add_option("--modules", dest="translate_modules",
help="specify modules to export. Use in combination with --i18n-export")
- group.add_option("--addons-path", dest="addons_path",
- help="specify additional addons paths (separated by commas).",
- action="callback", callback=self._check_addons_path, nargs=1, type="string")
parser.add_option_group(group)
security = optparse.OptionGroup(parser, 'Security-related options')
- security.add_option('--no-database-list', action="store_false", dest='list_db', default=True,
+ security.add_option('--no-database-list', action="store_false", dest='list_db', my_default=True,
help="disable the ability to return the list of databases")
parser.add_option_group(security)
# Advanced options
group = optparse.OptionGroup(parser, "Advanced options")
- group.add_option("--cache-timeout", dest="cache_timeout", default=100000,
+ group.add_option("--cache-timeout", dest="cache_timeout", my_default=100000,
help="set the timeout for the cache system", type="int")
- group.add_option('--debug', dest='debug_mode', action='store_true', default=False, help='enable debug mode')
- group.add_option("--stop-after-init", action="store_true", dest="stop_after_init", default=False,
+ group.add_option('--debug', dest='debug_mode', action='store_true', my_default=False, help='enable debug mode')
+ group.add_option("--stop-after-init", action="store_true", dest="stop_after_init", my_default=False,
help="stop the server after its initialization")
- group.add_option("-t", "--timezone", dest="timezone", default=False,
+ group.add_option("-t", "--timezone", dest="timezone", my_default=False,
help="specify reference timezone for the server (e.g. Europe/Brussels")
- group.add_option("--osv-memory-count-limit", dest="osv_memory_count_limit", default=False,
+ group.add_option("--osv-memory-count-limit", dest="osv_memory_count_limit", my_default=False,
help="Force a limit on the maximum number of records kept in the virtual "
"osv_memory tables. The default is False, which means no count-based limit.",
type="int")
- group.add_option("--osv-memory-age-limit", dest="osv_memory_age_limit", default=1.0,
+ group.add_option("--osv-memory-age-limit", dest="osv_memory_age_limit", my_default=1.0,
help="Force a limit on the maximum age of records kept in the virtual "
"osv_memory tables. This is a decimal value expressed in hours, "
"and the default is 1 hour.",
type="float")
+ group.add_option("--max-cron-threads", dest="max_cron_threads", my_default=4,
+ help="Maximum number of threads processing concurrently cron jobs.",
+ type="int")
+ # TODO sensible default for the three following limits.
+ group.add_option("--virtual-memory-limit", dest="virtual_memory_limit", my_default=768 * 1024 * 1024,
+ help="Maximum allowed virtual memory per Gunicorn process. "
+ "When the limit is reached, any memory allocation will fail.",
+ type="int")
+ group.add_option("--virtual-memory-reset", dest="virtual_memory_reset", my_default=640 * 1024 * 1024,
+ help="Maximum allowed virtual memory per Gunicorn process. "
+ "When the limit is reached, the worker will be reset after "
+ "the current request.",
+ type="int")
+ group.add_option("--cpu-time-limit", dest="cpu_time_limit", my_default=60,
+ help="Maximum allowed CPU time per Gunicorn process. "
+ "When the limit is reached, an exception is raised.",
+ type="int")
+ group.add_option("--unaccent", dest="unaccent", my_default=False, action="store_true",
+ help="Use the unaccent function provided by the database when available.")
+
parser.add_option_group(group)
- # Copy all optparse options into self.options.
+ # Copy all optparse options (i.e. MyOption) into self.options.
for group in parser.option_groups:
for option in group.option_list:
- if option.default == ('NO', 'DEFAULT'):
- self.options[option.dest] = None
- else:
- self.options[option.dest] = option.default
+ if option.dest not in self.options:
+ self.options[option.dest] = option.my_default
+ self.casts[option.dest] = option
+
+ self.parse_config(None, False)
+
+ def parse_config(self, args=None, complete=True):
+ """ Parse the configuration file (if any) and the command-line
+ arguments.
+
+ This method initializes openerp.tools.config and openerp.conf (the
+ former should be removed in the furture) with library-wide
+ configuration values.
- self.parse_config()
+ This method must be called before proper usage of this library can be
+ made.
- def parse_config(self, args=[]):
- opt, args = self.parser.parse_args()
+ Typical usage of this method:
+
+ openerp.tools.config.parse_config(sys.argv[1:])
+
+ :param complete: this is a hack used in __init__(), leave it to True.
+
+ """
+ if args is None:
+ args = []
+ opt, args = self.parser.parse_args(args)
def die(cond, msg):
if cond:
if self.options['pidfile'] in ('None', 'False'):
self.options['pidfile'] = False
+ # if defined dont take the configfile value even if the defined value is None
keys = ['xmlrpc_interface', 'xmlrpc_port', 'db_name', 'db_user', 'db_password', 'db_host',
- 'db_port', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout',
+ 'db_port', 'db_template', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout',
'email_from', 'smtp_server', 'smtp_user', 'smtp_password',
'netrpc_interface', 'netrpc_port', 'db_maxconn', 'import_partial', 'addons_path',
'netrpc', 'xmlrpc', 'syslog', 'without_demo', 'timezone',
'xmlrpcs_interface', 'xmlrpcs_port', 'xmlrpcs',
- 'secure_cert_file', 'secure_pkey_file',
- 'static_http_enable', 'static_http_document_root', 'static_http_url_prefix'
+ 'static_http_enable', 'static_http_document_root', 'static_http_url_prefix',
+ 'secure_cert_file', 'secure_pkey_file', 'dbfilter', 'log_handler', 'log_level'
]
for arg in keys:
- if getattr(opt, arg):
+ # Copy the command-line argument (except the special case for log_handler, due to
+ # action=append requiring a real default, so we cannot use the my_default workaround)
+ if getattr(opt, arg) and getattr(opt, arg) != DEFAULT_LOG_HANDLER:
self.options[arg] = getattr(opt, arg)
+ # ... or keep, but cast, the config file value.
+ elif isinstance(self.options[arg], basestring) and self.casts[arg].type in optparse.Option.TYPE_CHECKER:
+ self.options[arg] = optparse.Option.TYPE_CHECKER[self.casts[arg].type](self.casts[arg], arg, self.options[arg])
+
+ if isinstance(self.options['log_handler'], basestring):
+ self.options['log_handler'] = self.options['log_handler'].split(',')
+
+ # if defined but None take the configfile value
keys = [
'language', 'translate_out', 'translate_in', 'overwrite_existing_translations',
'debug_mode', 'smtp_ssl', 'load_language',
'stop_after_init', 'logrotate', 'without_demo', 'netrpc', 'xmlrpc', 'syslog',
- 'list_db', 'xmlrpcs',
+ 'list_db', 'xmlrpcs', 'proxy_mode',
'test_file', 'test_disable', 'test_commit', 'test_report_directory',
- 'osv_memory_count_limit', 'osv_memory_age_limit',
+ 'osv_memory_count_limit', 'osv_memory_age_limit', 'max_cron_threads',
+ 'virtual_memory_limit', 'virtual_memory_reset', 'cpu_time_limit', 'unaccent',
]
for arg in keys:
+ # Copy the command-line argument...
if getattr(opt, arg) is not None:
self.options[arg] = getattr(opt, arg)
+ # ... or keep, but cast, the config file value.
+ elif isinstance(self.options[arg], basestring) and self.casts[arg].type in optparse.Option.TYPE_CHECKER:
+ self.options[arg] = optparse.Option.TYPE_CHECKER[self.casts[arg].type](self.casts[arg], arg, self.options[arg])
if opt.assert_exit_level:
self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
else:
self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
- if opt.log_level:
- self.options['log_level'] = self._LOGLEVELS[opt.log_level]
- else:
- self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
-
self.options['root_path'] = os.path.abspath(os.path.expanduser(os.path.expandvars(os.path.dirname(openerp.__file__))))
if not self.options['addons_path'] or self.options['addons_path']=='None':
self.options['addons_path'] = os.path.join(self.options['root_path'], 'addons')
if opt.save:
self.save()
+ openerp.conf.max_cron_threads = self.options['max_cron_threads']
+
+ openerp.conf.addons_paths = self.options['addons_path'].split(',')
+ if opt.server_wide_modules:
+ openerp.conf.server_wide_modules = map(lambda m: m.strip(), opt.server_wide_modules.split(','))
+ else:
+ openerp.conf.server_wide_modules = ['web']
+ if complete:
+ openerp.modules.module.initialize_sys_path()
+ openerp.modules.loading.open_openerp_namespace()
+
def _generate_pgpassfile(self):
"""
Generate the pgpass file with the parameters from the command line (db_host, db_user,
p.set('options', opt, self.options[opt])
for sec in sorted(self.misc.keys()):
+ p.add_section(sec)
for opt in sorted(self.misc[sec].keys()):
p.set(sec,opt,self.misc[sec][opt])
def __setitem__(self, key, value):
self.options[key] = value
+ if key in self.options and isinstance(self.options[key], basestring) and \
+ key in self.casts and self.casts[key].type in optparse.Option.TYPE_CHECKER:
+ self.options[key] = optparse.Option.TYPE_CHECKER[self.casts[key].type](self.casts[key], key, self.options[key])
def __getitem__(self, key):
return self.options[key]
config = configmanager()
+
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
projects / odoo / odoo.git / blobdiff