1 # -*- encoding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ##############################################################################
33 from OpenSSL import SSL
36 return hasattr(socket, 'ssl')
40 class configmanager(object):
41 def __init__(self, fname=None):
44 'interface': '', # this will bind the server to all interfaces
59 'translate_out': None,
62 'admin_passwd': 'admin',
63 'csv_internal_sep': ',',
70 'smtp_server': 'localhost',
73 'smtp_password': False,
74 'stop_after_init': False, # this will stop the server after initialization
78 'log_level': logging.INFO,
79 'assert_exit_level': logging.WARNING, # level above which a failed assert will be raise
80 'cache_timeout': 100000,
81 'login_message': False,
86 self._LOGLEVELS = dict([(getattr(netsvc, 'LOG_%s' % x), getattr(logging, x))
87 for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'DEBUG_RPC', 'NOTSET')])
89 version = "%s %s" % (release.description, release.version)
90 parser = optparse.OptionParser(version=version)
92 parser.add_option("-c", "--config", dest="config", help="specify alternate config file")
93 parser.add_option("-s", "--save", action="store_true", dest="save", default=False,
94 help="save configuration to ~/.openerp_serverrc")
95 parser.add_option("--pidfile", dest="pidfile", help="file where the server pid will be stored")
97 parser.add_option("-n", "--interface", dest="interface", help="specify the TCP IP address")
98 parser.add_option("-p", "--port", dest="port", help="specify the TCP port", type="int")
99 parser.add_option("--net_interface", dest="netinterface", help="specify the TCP IP address for netrpc")
100 parser.add_option("--net_port", dest="netport", help="specify the TCP port for netrpc", type="int")
101 parser.add_option("--no-netrpc", dest="netrpc", action="store_false", default=True, help="disable netrpc")
102 parser.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", default=True, help="disable xmlrpc")
103 parser.add_option("-i", "--init", dest="init", help="init a module (use \"all\" for all modules)")
104 parser.add_option("--without-demo", dest="without_demo",
105 help="load demo data for a module (use \"all\" for all modules)", default=False)
106 parser.add_option("-u", "--update", dest="update",
107 help="update a module (use \"all\" for all modules)")
108 parser.add_option("--cache-timeout", dest="cache_timeout",
109 help="set the timeout for the cache system", default=100000, type="int")
111 # stops the server from launching after initialization
112 parser.add_option("--stop-after-init", action="store_true", dest="stop_after_init", default=False,
113 help="stop the server after it initializes")
114 parser.add_option('--debug', dest='debug_mode', action='store_true', default=False, help='enable debug mode')
115 parser.add_option("--assert-exit-level", dest='assert_exit_level', type="choice", choices=self._LOGLEVELS.keys(),
116 help="specify the level at which a failed assertion will stop the server. Accepted values: %s" % (self._LOGLEVELS.keys(),))
117 parser.add_option('--price_accuracy', dest='price_accuracy', default='2', help='specify the price accuracy')
119 group = optparse.OptionGroup(parser, "SSL Configuration")
120 group.add_option("-S", "--secure", dest="secure",
121 help="launch server over https instead of http")
122 group.add_option("--cert-file", dest="secure_cert_file",
123 default="server.cert",
124 help="specify the certificate file for the SSL connection")
125 group.add_option("--pkey-file", dest="secure_pkey_file",
126 default="server.pkey",
127 help="specify the private key file for the SSL connection")
128 parser.add_option_group(group)
131 group = optparse.OptionGroup(parser, "Logging Configuration")
132 group.add_option("--logfile", dest="logfile", help="file where the server log will be stored")
133 group.add_option("--syslog", action="store_true", dest="syslog",
134 default=False, help="Send the log to the syslog server")
135 group.add_option('--log-level', dest='log_level', type='choice', choices=self._LOGLEVELS.keys(),
136 help='specify the level of the logging. Accepted values: ' + str(self._LOGLEVELS.keys()))
137 parser.add_option_group(group)
140 group = optparse.OptionGroup(parser, "SMTP Configuration")
141 group.add_option('--email-from', dest='email_from', default='', help='specify the SMTP email address for sending email')
142 group.add_option('--smtp', dest='smtp_server', default='', help='specify the SMTP server for sending email')
143 group.add_option('--smtp-port', dest='smtp_port', default='25', help='specify the SMTP port', type="int")
145 group.add_option('--smtp-ssl', dest='smtp_ssl', default='', help='specify the SMTP server support SSL or not')
146 group.add_option('--smtp-user', dest='smtp_user', default='', help='specify the SMTP username for sending email')
147 group.add_option('--smtp-password', dest='smtp_password', default='', help='specify the SMTP password for sending email')
148 parser.add_option_group(group)
150 group = optparse.OptionGroup(parser, "Database related options")
151 group.add_option("-d", "--database", dest="db_name", help="specify the database name")
152 group.add_option("-r", "--db_user", dest="db_user", help="specify the database user name")
153 group.add_option("-w", "--db_password", dest="db_password", help="specify the database password")
154 group.add_option("--pg_path", dest="pg_path", help="specify the pg executable path")
155 group.add_option("--db_host", dest="db_host", help="specify the database host")
156 group.add_option("--db_port", dest="db_port", help="specify the database port", type="int")
157 group.add_option("--db_maxconn", dest="db_maxconn", default='64',
158 help="specify the the maximum number of physical connections to posgresql")
159 group.add_option("-P", "--import-partial", dest="import_partial",
160 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)
161 parser.add_option_group(group)
163 group = optparse.OptionGroup(parser, "Internationalisation options",
164 "Use these options to translate OpenERP to another language."
165 "See i18n section of the user manual. Option '-d' is mandatory."
166 "Option '-l' is mandatory in case of importation"
169 group.add_option('-l', "--language", dest="language",
170 help="specify the language of the translation file. Use it with --i18n-export or --i18n-import")
171 group.add_option("--i18n-export", dest="translate_out",
172 help="export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit")
173 group.add_option("--i18n-import", dest="translate_in",
174 help="import a CSV or a PO file with translations and exit. The '-l' option is required.")
175 group.add_option("--modules", dest="translate_modules",
176 help="specify modules to export. Use in combination with --i18n-export")
177 group.add_option("--addons-path", dest="addons_path",
178 help="specify an alternative addons path.",
179 action="callback", callback=self._check_addons_path, nargs=1, type="string")
180 parser.add_option_group(group)
182 (opt, args) = parser.parse_args()
189 die(bool(opt.syslog) and bool(opt.logfile),
190 "the syslog and logfile options are exclusive")
192 die(opt.translate_in and (not opt.language or not opt.db_name),
193 "the i18n-import option cannot be used without the language (-l) and the database (-d) options")
195 die(opt.translate_out and (not opt.db_name),
196 "the i18n-export option cannot be used without the database (-d) option")
198 # place/search the config file on Win32 near the server installation
199 # (../etc from the server)
200 # 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,
201 # else he won't be able to save the configurations, or even to start the server...
203 rcfilepath = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 'openerp-server.conf')
205 rcfilepath = os.path.expanduser('~/.openerp_serverrc')
207 self.rcfile = os.path.abspath(
208 fname or opt.config or os.environ.get('OPENERP_SERVER') or rcfilepath)
212 # Verify that we want to log or not, if not the output will go to stdout
213 if self.options['logfile'] in ('None', 'False'):
214 self.options['logfile'] = False
215 # the same for the pidfile
216 if self.options['pidfile'] in ('None', 'False'):
217 self.options['pidfile'] = False
219 keys = ['interface', 'port', 'db_name', 'db_user', 'db_password', 'db_host',
220 'db_port', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout',
221 'email_from', 'smtp_server', 'smtp_user', 'smtp_password', 'price_accuracy',
222 'netinterface', 'netport', 'db_maxconn', 'import_partial', 'addons_path']
225 keys.extend(['smtp_ssl', 'secure_cert_file', 'secure_pkey_file'])
228 if getattr(opt, arg):
229 self.options[arg] = getattr(opt, arg)
231 keys = ['language', 'translate_out', 'translate_in', 'debug_mode',
232 'stop_after_init', 'without_demo', 'netrpc', 'xmlrpc', 'syslog']
234 if hasSSL and not self.options['secure']:
235 keys.append('secure')
238 if getattr(opt, arg) is not None:
239 self.options[arg] = getattr(opt, arg)
241 if opt.assert_exit_level:
242 self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
244 self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
247 self.options['log_level'] = self._LOGLEVELS[opt.log_level]
249 self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
251 if not self.options['root_path'] or self.options['root_path']=='None':
252 self.options['root_path'] = os.path.abspath(os.path.dirname(sys.argv[0]))
253 if not self.options['addons_path'] or self.options['addons_path']=='None':
254 self.options['addons_path'] = os.path.join(self.options['root_path'], 'addons')
256 self.options['init'] = opt.init and dict.fromkeys(opt.init.split(','), 1) or {}
257 self.options["demo"] = not opt.without_demo and self.options['init'] or {}
258 self.options['update'] = opt.update and dict.fromkeys(opt.update.split(','), 1) or {}
260 self.options['translate_modules'] = opt.translate_modules and map(lambda m: m.strip(), opt.translate_modules.split(',')) or ['all']
261 self.options['translate_modules'].sort()
264 self.options['pg_path'] = opt.pg_path
266 if self.options.get('language', False):
267 if len(self.options['language']) > 5:
268 raise Exception('ERROR: The Lang name must take max 5 chars, Eg: -lfr_BE')
270 if not self.options['db_user']:
273 self.options['db_user'] = getpass.getuser()
275 self.options['db_user'] = None
277 die(not self.options['db_user'], 'ERROR: No user specified for the connection to the database')
279 if self.options['db_password']:
280 if sys.platform == 'win32' and not self.options['db_host']:
281 self.options['db_host'] = 'localhost'
282 #if self.options['db_host']:
283 # self._generate_pgpassfile()
288 def _generate_pgpassfile(self):
290 Generate the pgpass file with the parameters from the command line (db_host, db_user,
293 Used because pg_dump and pg_restore can not accept the password on the command line.
295 is_win32 = sys.platform == 'win32'
297 filename = os.path.join(os.environ['APPDATA'], 'pgpass.conf')
299 filename = os.path.join(os.environ['HOME'], '.pgpass')
301 text_to_add = "%(db_host)s:*:*:%(db_user)s:%(db_password)s" % self.options
303 if os.path.exists(filename):
304 content = [x.strip() for x in file(filename, 'r').readlines()]
305 if text_to_add in content:
308 fp = file(filename, 'a+')
309 fp.write(text_to_add + "\n")
314 x=_winreg.ConnectRegistry(None,_winreg.HKEY_LOCAL_MACHINE)
315 y = _winreg.OpenKey(x, r"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", 0,_winreg.KEY_ALL_ACCESS)
316 _winreg.SetValueEx(y,"PGPASSFILE", 0, _winreg.REG_EXPAND_SZ, filename )
321 os.chmod(filename, stat.S_IRUSR + stat.S_IWUSR)
323 def _check_addons_path(self, option, opt, value, parser):
324 res = os.path.abspath(os.path.expanduser(value))
325 if not os.path.exists(res):
326 raise optparse.OptionValueError("option %s: no such directory: %r" % (opt, value))
327 setattr(parser.values, option.dest, res)
330 p = ConfigParser.ConfigParser()
332 p.read([self.rcfile])
333 for (name,value) in p.items('options'):
334 if value=='True' or value=='true':
336 if value=='False' or value=='false':
338 self.options[name] = value
341 except ConfigParser.NoSectionError:
345 p = ConfigParser.ConfigParser()
346 loglevelnames = dict(zip(self._LOGLEVELS.values(), self._LOGLEVELS.keys()))
347 p.add_section('options')
348 for opt in self.options.keys():
349 if opt in ('version', 'language', 'translate_out', 'translate_in', 'init', 'update'):
351 if opt in ('log_level', 'assert_exit_level'):
352 p.set('options', opt, loglevelnames.get(self.options[opt], self.options[opt]))
354 p.set('options', opt, self.options[opt])
356 # try to create the directories and write the file
358 if not os.path.exists(os.path.dirname(self.rcfile)):
359 os.makedirs(os.path.dirname(self.rcfile))
361 p.write(file(self.rcfile, 'w'))
362 os.chmod(self.rcfile, 0600)
364 sys.stderr.write("ERROR: couldn't write the config file\n")
367 # what to do if impossible?
368 sys.stderr.write("ERROR: couldn't create the config directory\n")
370 def get(self, key, default=None):
371 return self.options.get(key, default)
373 def __setitem__(self, key, value):
374 self.options[key] = value
376 def __getitem__(self, key):
377 return self.options[key]
379 config = configmanager()
383 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: