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')
39 class configmanager(object):
40 def __init__(self, fname=None):
43 'interface': '', # this will bind the server to all interfaces
58 'translate_out': None,
61 'admin_passwd': 'admin',
62 'csv_internal_sep': ',',
70 'smtp_server': 'localhost',
74 'smtp_password': False,
75 'stop_after_init': False, # this will stop the server after initialization
79 'log_level': logging.INFO,
80 'assert_exit_level': logging.WARNING, # level above which a failed assert will be raised
81 'cache_timeout': 100000,
82 'login_message': False,
84 'timezone' : False, # to override the default TZ
91 self._LOGLEVELS = dict([(getattr(netsvc, 'LOG_%s' % x), getattr(logging, x))
92 for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'TEST', 'DEBUG', 'DEBUG_RPC', 'NOTSET')])
94 version = "%s %s" % (release.description, release.version)
95 parser = optparse.OptionParser(version=version)
97 parser.add_option("-c", "--config", dest="config", help="specify alternate config file")
98 parser.add_option("-s", "--save", action="store_true", dest="save", default=False,
99 help="save configuration to ~/.openerp_serverrc")
100 parser.add_option("--pidfile", dest="pidfile", help="file where the server pid will be stored")
102 parser.add_option("-n", "--interface", dest="interface", help="specify the TCP IP address")
103 parser.add_option("-p", "--port", dest="port", help="specify the TCP port", type="int")
104 parser.add_option("--net_interface", dest="netinterface", help="specify the TCP IP address for netrpc")
105 parser.add_option("--net_port", dest="netport", help="specify the TCP port for netrpc", type="int")
106 parser.add_option("--no-netrpc", dest="netrpc", action="store_false", help="disable netrpc")
107 parser.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", help="disable xmlrpc")
108 parser.add_option("-i", "--init", dest="init", help="init a module (use \"all\" for all modules)")
109 parser.add_option("--without-demo", dest="without_demo",
110 help="load demo data for a module (use \"all\" for all modules)", default=False)
111 parser.add_option("-u", "--update", dest="update",
112 help="update a module (use \"all\" for all modules)")
113 parser.add_option("--cache-timeout", dest="cache_timeout",
114 help="set the timeout for the cache system", default=100000, type="int")
115 parser.add_option("-t", "--timezone", dest="timezone", help="specify reference timezone for the server (e.g. Europe/Brussels")
117 # stops the server from launching after initialization
118 parser.add_option("--stop-after-init", action="store_true", dest="stop_after_init", default=False,
119 help="stop the server after it initializes")
120 parser.add_option('--debug', dest='debug_mode', action='store_true', default=False, help='enable debug mode')
121 parser.add_option("--assert-exit-level", dest='assert_exit_level', type="choice", choices=self._LOGLEVELS.keys(),
122 help="specify the level at which a failed assertion will stop the server. Accepted values: %s" % (self._LOGLEVELS.keys(),))
123 parser.add_option('--price_accuracy', dest='price_accuracy', default='2', help='deprecated since v6.0, replaced by module decimal_precision')
124 parser.add_option('--no-database-list', action="store_false", dest='list_db', default=True, help="disable the ability to return the list of databases")
127 group = optparse.OptionGroup(parser, "SSL Configuration")
128 group.add_option("-S", "--secure", dest="secure",
129 help="launch server over https instead of http")
130 group.add_option("--cert-file", dest="secure_cert_file",
131 default="server.cert",
132 help="specify the certificate file for the SSL connection")
133 group.add_option("--pkey-file", dest="secure_pkey_file",
134 default="server.pkey",
135 help="specify the private key file for the SSL connection")
136 parser.add_option_group(group)
139 group = optparse.OptionGroup(parser, "Logging Configuration")
140 group.add_option("--logfile", dest="logfile", help="file where the server log will be stored")
141 group.add_option("--no-logrotate", dest="logrotate", action="store_false",
142 default=None, help="do not rotate the logfile")
143 group.add_option("--syslog", action="store_true", dest="syslog",
144 default=False, help="Send the log to the syslog server")
145 group.add_option('--log-level', dest='log_level', type='choice', choices=self._LOGLEVELS.keys(),
146 help='specify the level of the logging. Accepted values: ' + str(self._LOGLEVELS.keys()))
147 parser.add_option_group(group)
150 group = optparse.OptionGroup(parser, "SMTP Configuration")
151 group.add_option('--email-from', dest='email_from', default='', help='specify the SMTP email address for sending email')
152 group.add_option('--smtp', dest='smtp_server', default='', help='specify the SMTP server for sending email')
153 group.add_option('--smtp-port', dest='smtp_port', default='25', help='specify the SMTP port', type="int")
155 group.add_option('--smtp-ssl', dest='smtp_ssl', default='', help='specify the SMTP server support SSL or not')
156 group.add_option('--smtp-user', dest='smtp_user', default='', help='specify the SMTP username for sending email')
157 group.add_option('--smtp-password', dest='smtp_password', default='', help='specify the SMTP password for sending email')
158 parser.add_option_group(group)
160 group = optparse.OptionGroup(parser, "Database related options")
161 group.add_option("-d", "--database", dest="db_name", help="specify the database name")
162 group.add_option("-r", "--db_user", dest="db_user", help="specify the database user name")
163 group.add_option("-w", "--db_password", dest="db_password", help="specify the database password")
164 group.add_option("--pg_path", dest="pg_path", help="specify the pg executable path")
165 group.add_option("--db_host", dest="db_host", help="specify the database host")
166 group.add_option("--db_port", dest="db_port", help="specify the database port", type="int")
167 group.add_option("--db_maxconn", dest="db_maxconn", default='64',
168 help="specify the the maximum number of physical connections to posgresql")
169 group.add_option("-P", "--import-partial", dest="import_partial",
170 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)
171 parser.add_option_group(group)
173 group = optparse.OptionGroup(parser, "Internationalisation options",
174 "Use these options to translate OpenERP to another language."
175 "See i18n section of the user manual. Option '-d' is mandatory."
176 "Option '-l' is mandatory in case of importation"
179 group.add_option('-l', "--language", dest="language",
180 help="specify the language of the translation file. Use it with --i18n-export or --i18n-import")
181 group.add_option("--i18n-export", dest="translate_out",
182 help="export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit")
183 group.add_option("--i18n-import", dest="translate_in",
184 help="import a CSV or a PO file with translations and exit. The '-l' option is required.")
185 group.add_option("--modules", dest="translate_modules",
186 help="specify modules to export. Use in combination with --i18n-export")
187 group.add_option("--addons-path", dest="addons_path",
188 help="specify an alternative addons path.",
189 action="callback", callback=self._check_addons_path, nargs=1, type="string")
190 parser.add_option_group(group)
192 (opt, args) = parser.parse_args()
199 die(bool(opt.syslog) and bool(opt.logfile),
200 "the syslog and logfile options are exclusive")
202 die(opt.translate_in and (not opt.language or not opt.db_name),
203 "the i18n-import option cannot be used without the language (-l) and the database (-d) options")
205 die(opt.translate_out and (not opt.db_name),
206 "the i18n-export option cannot be used without the database (-d) option")
208 # Check if the config file exists (-c used, but not -s)
209 die(not opt.save and opt.config and not os.path.exists(opt.config),
210 "The config file '%s' selected with -c/--config doesn't exist, "\
211 "use -s/--save if you want to generate it"%(opt.config))
213 # place/search the config file on Win32 near the server installation
214 # (../etc from the server)
215 # 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,
216 # else he won't be able to save the configurations, or even to start the server...
218 rcfilepath = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 'openerp-server.conf')
220 rcfilepath = os.path.expanduser('~/.openerp_serverrc')
222 self.rcfile = os.path.abspath(
223 fname or opt.config or os.environ.get('OPENERP_SERVER') or rcfilepath)
227 # Verify that we want to log or not, if not the output will go to stdout
228 if self.options['logfile'] in ('None', 'False'):
229 self.options['logfile'] = False
230 # the same for the pidfile
231 if self.options['pidfile'] in ('None', 'False'):
232 self.options['pidfile'] = False
234 keys = ['interface', 'port', 'db_name', 'db_user', 'db_password', 'db_host',
235 'db_port', 'list_db', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout',
236 'email_from', 'smtp_server', 'smtp_user', 'smtp_password', 'price_accuracy',
237 'netinterface', 'netport', 'db_maxconn', 'import_partial', 'addons_path',
238 'netrpc', 'xmlrpc', 'syslog', 'without_demo', 'timezone',]
241 keys.extend(['smtp_ssl', 'secure_cert_file', 'secure_pkey_file'])
242 keys.append('secure')
245 if getattr(opt, arg):
246 self.options[arg] = getattr(opt, arg)
248 keys = ['language', 'translate_out', 'translate_in', 'debug_mode',
249 'stop_after_init', 'logrotate', 'without_demo', 'netrpc', 'xmlrpc', 'syslog', 'list_db']
251 if hasSSL and not self.options['secure']:
252 keys.append('secure')
255 if getattr(opt, arg) is not None:
256 self.options[arg] = getattr(opt, arg)
258 if opt.assert_exit_level:
259 self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
261 self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
264 self.options['log_level'] = self._LOGLEVELS[opt.log_level]
266 self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
268 if not self.options['root_path'] or self.options['root_path']=='None':
269 self.options['root_path'] = os.path.abspath(os.path.dirname(sys.argv[0]))
270 if not self.options['addons_path'] or self.options['addons_path']=='None':
271 self.options['addons_path'] = os.path.join(self.options['root_path'], 'addons')
273 self.options['init'] = opt.init and dict.fromkeys(opt.init.split(','), 1) or {}
274 self.options["demo"] = not opt.without_demo and self.options['init'] or {}
275 self.options['update'] = opt.update and dict.fromkeys(opt.update.split(','), 1) or {}
277 self.options['translate_modules'] = opt.translate_modules and map(lambda m: m.strip(), opt.translate_modules.split(',')) or ['all']
278 self.options['translate_modules'].sort()
280 if self.options['timezone']:
281 # If an explicit TZ was provided in the config, make sure it is known
284 tz = pytz.timezone(self.options['timezone'])
285 except pytz.UnknownTimeZoneError:
286 die(True, "The specified timezone (%s) is invalid" % self.options['timezone'])
288 # If pytz is missing, don't check the provided TZ, it will be ignored anyway.
292 self.options['pg_path'] = opt.pg_path
294 if self.options.get('language', False):
295 if len(self.options['language']) > 5:
296 raise Exception('ERROR: The Lang name must take max 5 chars, Eg: -lfr_BE')
298 if not self.options['db_user']:
301 self.options['db_user'] = getpass.getuser()
303 self.options['db_user'] = None
305 die(not self.options['db_user'], 'ERROR: No user specified for the connection to the database')
307 if self.options['db_password']:
308 if sys.platform == 'win32' and not self.options['db_host']:
309 self.options['db_host'] = 'localhost'
310 #if self.options['db_host']:
311 # self._generate_pgpassfile()
316 def _generate_pgpassfile(self):
318 Generate the pgpass file with the parameters from the command line (db_host, db_user,
321 Used because pg_dump and pg_restore can not accept the password on the command line.
323 is_win32 = sys.platform == 'win32'
325 filename = os.path.join(os.environ['APPDATA'], 'pgpass.conf')
327 filename = os.path.join(os.environ['HOME'], '.pgpass')
329 text_to_add = "%(db_host)s:*:*:%(db_user)s:%(db_password)s" % self.options
331 if os.path.exists(filename):
332 content = [x.strip() for x in file(filename, 'r').readlines()]
333 if text_to_add in content:
336 fp = file(filename, 'a+')
337 fp.write(text_to_add + "\n")
342 x=_winreg.ConnectRegistry(None,_winreg.HKEY_LOCAL_MACHINE)
343 y = _winreg.OpenKey(x, r"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", 0,_winreg.KEY_ALL_ACCESS)
344 _winreg.SetValueEx(y,"PGPASSFILE", 0, _winreg.REG_EXPAND_SZ, filename )
349 os.chmod(filename, stat.S_IRUSR + stat.S_IWUSR)
351 def _check_addons_path(self, option, opt, value, parser):
352 res = os.path.abspath(os.path.expanduser(value))
353 if not os.path.exists(res):
354 raise optparse.OptionValueError("option %s: no such directory: %r" % (opt, value))
356 contains_addons = False
357 for f in os.listdir(res):
358 modpath = os.path.join(res, f)
359 if os.path.isdir(modpath) and \
360 os.path.exists(os.path.join(modpath, '__init__.py')) and \
361 (os.path.exists(os.path.join(modpath, '__openerp__.py')) or \
362 os.path.exists(os.path.join(modpath, '__terp__.py'))):
364 contains_addons = True
367 if not contains_addons:
368 raise optparse.OptionValueError("option %s: The addons-path %r does not seem to a be a valid Addons Directory!" % (opt, value))
370 setattr(parser.values, option.dest, res)
373 p = ConfigParser.ConfigParser()
375 p.read([self.rcfile])
376 for (name,value) in p.items('options'):
377 if value=='True' or value=='true':
379 if value=='False' or value=='false':
381 self.options[name] = value
382 #parse the other sections, as well
383 for sec in p.sections():
386 if not self.misc.has_key(sec):
388 for (name, value) in p.items(sec):
389 if value=='True' or value=='true':
391 if value=='False' or value=='false':
393 self.misc[sec][name] = value
396 except ConfigParser.NoSectionError:
400 p = ConfigParser.ConfigParser()
401 loglevelnames = dict(zip(self._LOGLEVELS.values(), self._LOGLEVELS.keys()))
402 p.add_section('options')
403 for opt in self.options.keys():
404 if opt in ('version', 'language', 'translate_out', 'translate_in', 'init', 'update'):
406 if opt in ('log_level', 'assert_exit_level'):
407 p.set('options', opt, loglevelnames.get(self.options[opt], self.options[opt]))
409 p.set('options', opt, self.options[opt])
411 for sec in self.misc.keys():
412 for opt in self.misc[sec].keys():
413 p.set(sec,opt,self.misc[sec][opt])
415 # try to create the directories and write the file
417 if not os.path.exists(os.path.dirname(self.rcfile)):
418 os.makedirs(os.path.dirname(self.rcfile))
420 p.write(file(self.rcfile, 'w'))
421 os.chmod(self.rcfile, 0600)
423 sys.stderr.write("ERROR: couldn't write the config file\n")
426 # what to do if impossible?
427 sys.stderr.write("ERROR: couldn't create the config directory\n")
429 def get(self, key, default=None):
430 return self.options.get(key, default)
432 def get_misc(self, sect, key, default=None):
433 return self.misc.get(sect,{}).get(key, default)
435 def __setitem__(self, key, value):
436 self.options[key] = value
438 def __getitem__(self, key):
439 return self.options[key]
441 config = configmanager()
445 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: