1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
32 from OpenSSL import SSL
35 return hasattr(socket, 'ssl') and hasattr(SSL, "Connection")
39 class configmanager(object):
40 def __init__(self, fname=None):
43 'xmlrpc_interface': '', # this will bind the server to all interfaces
45 'netrpc_interface': '',
47 'xmlrpcs_interface': '', # this will bind the server to all interfaces
60 'translate_out': None,
61 'overwrite_existing_translations': False,
62 'load_language': None,
65 'admin_passwd': 'admin',
66 'csv_internal_sep': ',',
74 'smtp_server': 'localhost',
78 'smtp_password': False,
79 'stop_after_init': False, # this will stop the server after initialization
81 'log_level': logging.INFO,
82 'assert_exit_level': logging.ERROR, # level above which a failed assert will be raised
83 'cache_timeout': 100000,
84 'login_message': False,
86 'timezone' : False, # to override the default TZ
88 'test_report_directory' : False,
89 'test_disable' : False,
90 'test_commit' : False,
91 'static_http_enable': False,
92 'static_http_document_root': None,
93 'static_http_url_prefix': None,
94 'secure_cert_file': 'server.cert',
95 'secure_pkey_file': 'server.pkey',
96 'publisher_warranty_url': 'http://services.openerp.com/publisher-warranty/',
99 self.blacklist_for_save = set(["publisher_warranty_url", "load_language"])
102 self.config_file = fname
103 self.has_ssl = check_ssl()
105 self._LOGLEVELS = dict([(getattr(netsvc, 'LOG_%s' % x), getattr(logging, x))
106 for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'TEST', 'DEBUG', 'DEBUG_RPC', 'DEBUG_SQL', 'DEBUG_RPC_ANSWER','NOTSET')])
108 version = "%s %s" % (release.description, release.version)
109 self.parser = parser = optparse.OptionParser(version=version)
111 parser.add_option("-c", "--config", dest="config", help="specify alternate config file")
112 parser.add_option("-s", "--save", action="store_true", dest="save", default=False,
113 help="save configuration to ~/.openerp_serverrc")
114 parser.add_option("--pidfile", dest="pidfile", help="file where the server pid will be stored")
116 group = optparse.OptionGroup(parser, "XML-RPC Configuration")
117 group.add_option("--xmlrpc-interface", dest="xmlrpc_interface", help="specify the TCP IP address for the XML-RPC protocol")
118 group.add_option("--xmlrpc-port", dest="xmlrpc_port", help="specify the TCP port for the XML-RPC protocol", type="int")
119 group.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", help="disable the XML-RPC protocol")
120 parser.add_option_group(group)
122 title = "XML-RPC Secure Configuration"
124 title += " (disabled as ssl is unavailable)"
126 group = optparse.OptionGroup(parser, title)
127 group.add_option("--xmlrpcs-interface", dest="xmlrpcs_interface", help="specify the TCP IP address for the XML-RPC Secure protocol")
128 group.add_option("--xmlrpcs-port", dest="xmlrpcs_port", help="specify the TCP port for the XML-RPC Secure protocol", type="int")
129 group.add_option("--no-xmlrpcs", dest="xmlrpcs", action="store_false", help="disable the XML-RPC Secure protocol")
130 group.add_option("--cert-file", dest="secure_cert_file", help="specify the certificate file for the SSL connection")
131 group.add_option("--pkey-file", dest="secure_pkey_file", help="specify the private key file for the SSL connection")
132 parser.add_option_group(group)
135 group = optparse.OptionGroup(parser, "NET-RPC Configuration")
136 group.add_option("--netrpc-interface", dest="netrpc_interface", help="specify the TCP IP address for the NETRPC protocol")
137 group.add_option("--netrpc-port", dest="netrpc_port", help="specify the TCP port for the NETRPC protocol", type="int")
138 group.add_option("--no-netrpc", dest="netrpc", action="store_false", help="disable the NETRPC protocol")
139 parser.add_option_group(group)
142 group = optparse.OptionGroup(parser, "Static HTTP service")
143 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")
144 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/')")
145 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 '/')")
146 parser.add_option_group(group)
148 parser.add_option("-i", "--init", dest="init", help="init a module (use \"all\" for all modules)")
149 parser.add_option("--without-demo", dest="without_demo",
150 help="load demo data for a module (use \"all\" for all modules)", default=False)
151 parser.add_option("-u", "--update", dest="update",
152 help="update a module (use \"all\" for all modules)")
153 parser.add_option("--cache-timeout", dest="cache_timeout",
154 help="set the timeout for the cache system", type="int")
155 parser.add_option("-t", "--timezone", dest="timezone", help="specify reference timezone for the server (e.g. Europe/Brussels")
157 # stops the server from launching after initialization
158 parser.add_option("--stop-after-init", action="store_true", dest="stop_after_init", default=False,
159 help="stop the server after it initializes")
160 parser.add_option('--debug', dest='debug_mode', action='store_true', default=False, help='enable debug mode')
161 parser.add_option("--assert-exit-level", dest='assert_exit_level', type="choice", choices=self._LOGLEVELS.keys(),
162 help="specify the level at which a failed assertion will stop the server. Accepted values: %s" % (self._LOGLEVELS.keys(),))
165 group = optparse.OptionGroup(parser, "Testing Configuration")
166 group.add_option("--test-file", dest="test_file", help="Launch a YML test file.")
167 group.add_option("--test-report-directory", dest="test_report_directory", help="If set, will save sample of all reports in this directory.")
168 group.add_option("--test-disable", action="store_true", dest="test_disable",
169 default=False, help="Disable loading test files.")
170 group.add_option("--test-commit", action="store_true", dest="test_commit",
171 default=False, help="Commit database changes performed by tests.")
172 parser.add_option_group(group)
175 group = optparse.OptionGroup(parser, "Logging Configuration")
176 group.add_option("--logfile", dest="logfile", help="file where the server log will be stored")
177 group.add_option("--no-logrotate", dest="logrotate", action="store_false",
178 help="do not rotate the logfile")
179 group.add_option("--syslog", action="store_true", dest="syslog",
180 default=False, help="Send the log to the syslog server")
181 group.add_option('--log-level', dest='log_level', type='choice', choices=self._LOGLEVELS.keys(),
182 help='specify the level of the logging. Accepted values: ' + str(self._LOGLEVELS.keys()))
183 parser.add_option_group(group)
186 group = optparse.OptionGroup(parser, "SMTP Configuration")
187 group.add_option('--email-from', dest='email_from', help='specify the SMTP email address for sending email')
188 group.add_option('--smtp', dest='smtp_server', help='specify the SMTP server for sending email')
189 group.add_option('--smtp-port', dest='smtp_port', help='specify the SMTP port', type="int")
190 group.add_option('--smtp-ssl', dest='smtp_ssl', action='store_true', help='specify the SMTP server support SSL or not')
191 group.add_option('--smtp-user', dest='smtp_user', help='specify the SMTP username for sending email')
192 group.add_option('--smtp-password', dest='smtp_password', help='specify the SMTP password for sending email')
193 parser.add_option_group(group)
195 group = optparse.OptionGroup(parser, "Database related options")
196 group.add_option("-d", "--database", dest="db_name", help="specify the database name")
197 group.add_option("-r", "--db_user", dest="db_user", help="specify the database user name")
198 group.add_option("-w", "--db_password", dest="db_password", help="specify the database password")
199 group.add_option("--pg_path", dest="pg_path", help="specify the pg executable path")
200 group.add_option("--db_host", dest="db_host", help="specify the database host")
201 group.add_option("--db_port", dest="db_port", help="specify the database port", type="int")
202 group.add_option("--db_maxconn", dest="db_maxconn", type='int',
203 help="specify the the maximum number of physical connections to posgresql")
204 group.add_option("-P", "--import-partial", dest="import_partial",
205 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.", default=False)
206 parser.add_option_group(group)
208 group = optparse.OptionGroup(parser, "Internationalisation options",
209 "Use these options to translate OpenERP to another language."
210 "See i18n section of the user manual. Option '-d' is mandatory."
211 "Option '-l' is mandatory in case of importation"
214 group.add_option('--load-language', dest="load_language",
215 help="specifies the languages for the translations you want to be loaded")
216 group.add_option('-l', "--language", dest="language",
217 help="specify the language of the translation file. Use it with --i18n-export or --i18n-import")
218 group.add_option("--i18n-export", dest="translate_out",
219 help="export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit")
220 group.add_option("--i18n-import", dest="translate_in",
221 help="import a CSV or a PO file with translations and exit. The '-l' option is required.")
222 group.add_option("--i18n-overwrite", dest="overwrite_existing_translations", action="store_true", default=False,
223 help="overwrites existing translation terms on importing a CSV or a PO file.")
224 group.add_option("--modules", dest="translate_modules",
225 help="specify modules to export. Use in combination with --i18n-export")
226 group.add_option("--addons-path", dest="addons_path",
227 help="specify an alternative addons path.",
228 action="callback", callback=self._check_addons_path, nargs=1, type="string")
229 parser.add_option_group(group)
231 security = optparse.OptionGroup(parser, 'Security-related options')
232 security.add_option('--no-database-list', action="store_false", dest='list_db', help="disable the ability to return the list of databases")
233 parser.add_option_group(security)
235 def parse_config(self):
236 opt = self.parser.parse_args()[0]
243 die(bool(opt.syslog) and bool(opt.logfile),
244 "the syslog and logfile options are exclusive")
246 die(opt.translate_in and (not opt.language or not opt.db_name),
247 "the i18n-import option cannot be used without the language (-l) and the database (-d) options")
249 die(opt.overwrite_existing_translations and (not opt.translate_in),
250 "the i18n-overwrite option cannot be used without the i18n-import option")
252 die(opt.translate_out and (not opt.db_name),
253 "the i18n-export option cannot be used without the database (-d) option")
255 # Check if the config file exists (-c used, but not -s)
256 die(not opt.save and opt.config and not os.path.exists(opt.config),
257 "The config file '%s' selected with -c/--config doesn't exist, "\
258 "use -s/--save if you want to generate it"%(opt.config))
260 # place/search the config file on Win32 near the server installation
261 # (../etc from the server)
262 # if the server is run by an unprivileged user, he has to specify location of a config file where he has the rights to write,
263 # else he won't be able to save the configurations, or even to start the server...
265 rcfilepath = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 'openerp-server.conf')
267 rcfilepath = os.path.expanduser('~/.openerp_serverrc')
269 self.rcfile = os.path.abspath(
270 self.config_file or opt.config \
271 or os.environ.get('OPENERP_SERVER') or rcfilepath)
275 # Verify that we want to log or not, if not the output will go to stdout
276 if self.options['logfile'] in ('None', 'False'):
277 self.options['logfile'] = False
278 # the same for the pidfile
279 if self.options['pidfile'] in ('None', 'False'):
280 self.options['pidfile'] = False
282 keys = ['xmlrpc_interface', 'xmlrpc_port', 'db_name', 'db_user', 'db_password', 'db_host',
283 'db_port', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout',
284 'email_from', 'smtp_server', 'smtp_user', 'smtp_password',
285 'netrpc_interface', 'netrpc_port', 'db_maxconn', 'import_partial', 'addons_path',
286 'netrpc', 'xmlrpc', 'syslog', 'without_demo', 'timezone',
287 'xmlrpcs_interface', 'xmlrpcs_port', 'xmlrpcs',
288 'secure_cert_file', 'secure_pkey_file',
289 'static_http_enable', 'static_http_document_root', 'static_http_url_prefix'
293 if getattr(opt, arg):
294 self.options[arg] = getattr(opt, arg)
297 'language', 'translate_out', 'translate_in', 'overwrite_existing_translations',
298 'debug_mode', 'smtp_ssl', 'load_language',
299 'stop_after_init', 'logrotate', 'without_demo', 'netrpc', 'xmlrpc', 'syslog',
300 'list_db', 'xmlrpcs',
301 'test_file', 'test_disable', 'test_commit', 'test_report_directory'
305 if getattr(opt, arg) is not None:
306 self.options[arg] = getattr(opt, arg)
308 if opt.assert_exit_level:
309 self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
311 self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
314 self.options['log_level'] = self._LOGLEVELS[opt.log_level]
316 self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
318 if not self.options['root_path'] or self.options['root_path']=='None':
319 self.options['root_path'] = os.path.abspath(os.path.dirname(sys.argv[0]))
320 if not self.options['addons_path'] or self.options['addons_path']=='None':
321 self.options['addons_path'] = os.path.join(self.options['root_path'], 'addons')
323 self.options['init'] = opt.init and dict.fromkeys(opt.init.split(','), 1) or {}
324 self.options["demo"] = not opt.without_demo and self.options['init'] or {}
325 self.options['update'] = opt.update and dict.fromkeys(opt.update.split(','), 1) or {}
326 self.options['translate_modules'] = opt.translate_modules and map(lambda m: m.strip(), opt.translate_modules.split(',')) or ['all']
327 self.options['translate_modules'].sort()
329 if self.options['timezone']:
330 # If an explicit TZ was provided in the config, make sure it is known
333 pytz.timezone(self.options['timezone'])
334 except pytz.UnknownTimeZoneError:
335 die(True, "The specified timezone (%s) is invalid" % self.options['timezone'])
337 # If pytz is missing, don't check the provided TZ, it will be ignored anyway.
341 self.options['pg_path'] = opt.pg_path
343 if self.options.get('language', False):
344 if len(self.options['language']) > 5:
345 raise Exception('ERROR: The Lang name must take max 5 chars, Eg: -lfr_BE')
347 if not self.options['db_user']:
350 self.options['db_user'] = getpass.getuser()
352 self.options['db_user'] = None
354 die(not self.options['db_user'], 'ERROR: No user specified for the connection to the database')
356 if self.options['db_password']:
357 if sys.platform == 'win32' and not self.options['db_host']:
358 self.options['db_host'] = 'localhost'
359 #if self.options['db_host']:
360 # self._generate_pgpassfile()
365 def _generate_pgpassfile(self):
367 Generate the pgpass file with the parameters from the command line (db_host, db_user,
370 Used because pg_dump and pg_restore can not accept the password on the command line.
372 is_win32 = sys.platform == 'win32'
374 filename = os.path.join(os.environ['APPDATA'], 'pgpass.conf')
376 filename = os.path.join(os.environ['HOME'], '.pgpass')
378 text_to_add = "%(db_host)s:*:*:%(db_user)s:%(db_password)s" % self.options
380 if os.path.exists(filename):
381 content = [x.strip() for x in file(filename, 'r').readlines()]
382 if text_to_add in content:
385 fp = file(filename, 'a+')
386 fp.write(text_to_add + "\n")
394 x=_winreg.ConnectRegistry(None,_winreg.HKEY_LOCAL_MACHINE)
395 y = _winreg.OpenKey(x, r"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", 0,_winreg.KEY_ALL_ACCESS)
396 _winreg.SetValueEx(y,"PGPASSFILE", 0, _winreg.REG_EXPAND_SZ, filename )
401 os.chmod(filename, stat.S_IRUSR + stat.S_IWUSR)
403 def _check_addons_path(self, option, opt, value, parser):
404 res = os.path.abspath(os.path.expanduser(value))
405 if not os.path.exists(res):
406 raise optparse.OptionValueError("option %s: no such directory: %r" % (opt, value))
408 contains_addons = False
409 for f in os.listdir(res):
410 modpath = os.path.join(res, f)
411 if os.path.isdir(modpath) and \
412 os.path.exists(os.path.join(modpath, '__init__.py')) and \
413 (os.path.exists(os.path.join(modpath, '__openerp__.py')) or \
414 os.path.exists(os.path.join(modpath, '__terp__.py'))):
416 contains_addons = True
419 if not contains_addons:
420 raise optparse.OptionValueError("option %s: The addons-path %r does not seem to a be a valid Addons Directory!" % (opt, value))
422 setattr(parser.values, option.dest, res)
425 p = ConfigParser.ConfigParser()
427 p.read([self.rcfile])
428 for (name,value) in p.items('options'):
429 if value=='True' or value=='true':
431 if value=='False' or value=='false':
433 self.options[name] = value
434 #parse the other sections, as well
435 for sec in p.sections():
438 if not self.misc.has_key(sec):
440 for (name, value) in p.items(sec):
441 if value=='True' or value=='true':
443 if value=='False' or value=='false':
445 self.misc[sec][name] = value
448 except ConfigParser.NoSectionError:
452 p = ConfigParser.ConfigParser()
453 loglevelnames = dict(zip(self._LOGLEVELS.values(), self._LOGLEVELS.keys()))
454 p.add_section('options')
455 for opt in sorted(self.options.keys()):
456 if opt in ('version', 'language', 'translate_out', 'translate_in', 'overwrite_existing_translations', 'init', 'update'):
458 if opt in self.blacklist_for_save:
460 if opt in ('log_level', 'assert_exit_level'):
461 p.set('options', opt, loglevelnames.get(self.options[opt], self.options[opt]))
463 p.set('options', opt, self.options[opt])
465 for sec in sorted(self.misc.keys()):
466 for opt in sorted(self.misc[sec].keys()):
467 p.set(sec,opt,self.misc[sec][opt])
469 # try to create the directories and write the file
471 rc_exists = os.path.exists(self.rcfile)
472 if not rc_exists and not os.path.exists(os.path.dirname(self.rcfile)):
473 os.makedirs(os.path.dirname(self.rcfile))
475 p.write(file(self.rcfile, 'w'))
477 os.chmod(self.rcfile, 0600)
479 sys.stderr.write("ERROR: couldn't write the config file\n")
482 # what to do if impossible?
483 sys.stderr.write("ERROR: couldn't create the config directory\n")
485 def get(self, key, default=None):
486 return self.options.get(key, default)
488 def get_misc(self, sect, key, default=None):
489 return self.misc.get(sect,{}).get(key, default)
491 def __setitem__(self, key, value):
492 self.options[key] = value
494 def __getitem__(self, key):
495 return self.options[key]
497 config = configmanager()
499 # FIXME:following line should be called explicitly by the server
500 # when it starts, to allow doing 'import tools.config' from
501 # other python executables without parsing *their* args.
502 config.parse_config()