bin/tools/config.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19 #
  20 ##############################################################################
  21
  22 import ConfigParser
  23 import optparse
  24 import os
  25 import sys
  26 import netsvc
  27 import logging
  28 import release
  29
  30 def check_ssl():
  31     try:
  32         from OpenSSL import SSL
  33         import socket
  34
  35         return hasattr(socket, 'ssl')
  36     except:
  37         return False
  38
  39 class configmanager(object):
  40     def __init__(self, fname=None):
  41         self.options = {
  42             'email_from':False,
  43             'interface': '',    # this will bind the server to all interfaces
  44             'port': 8069,
  45             'netinterface': '',
  46             'netport': 8070,
  47             'db_host': False,
  48             'db_port': False,
  49             'db_name': False,
  50             'db_user': False,
  51             'db_password': False,
  52             'db_maxconn': 64,
  53             'reportgz': False,
  54             'netrpc': True,
  55             'xmlrpc': True,
  56             'soap': False,
  57             'translate_in': None,
  58             'translate_out': None,
  59             'language': None,
  60             'pg_path': None,
  61             'admin_passwd': 'admin',
  62             'csv_internal_sep': ',',
  63             'addons_path': None,
  64             'root_path': None,
  65             'debug_mode': False,
  66             'import_partial': "",
  67             'pidfile': None,
  68             'logfile': None,
  69             'logrotate': '1',
  70             'smtp_server': 'localhost',
  71             'smtp_user': False,
  72             'smtp_port':25,
  73             'smtp_ssl':False,
  74             'smtp_password': False,
  75             'stop_after_init': False,   # this will stop the server after initialization
  76             'price_accuracy': 2,
  77             'secure' : False,
  78             'syslog' : False,
  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,
  83             'list_db' : True,
  84             'timezone' : False, # to override the default TZ
  85         }
  86
  87         self.misc = {}
  88
  89         hasSSL = check_ssl()
  90
  91         self._LOGLEVELS = dict([(getattr(netsvc, 'LOG_%s' % x), getattr(logging, x))
  92                           for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'DEBUG_RPC', 'NOTSET')])
  93
  94         version = "%s %s" % (release.description, release.version)
  95         parser = optparse.OptionParser(version=version)
  96
  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")
 101
 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", default=True, help="disable netrpc")
 107         parser.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", default=True, 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")
 116
 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='specify the price accuracy')
 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")
 125
 126         if hasSSL:
 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)
 137
 138         # Logging 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)
 148
 149         # SMTP 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")
 154         if hasSSL:
 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)
 159
 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)
 172
 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"
 177             )
 178
 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)
 191
 192         (opt, args) = parser.parse_args()
 193
 194         def die(cond, msg):
 195             if cond:
 196                 print msg
 197                 sys.exit(1)
 198
 199         die(bool(opt.syslog) and bool(opt.logfile),
 200             "the syslog and logfile options are exclusive")
 201
 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")
 204
 205         die(opt.translate_out and (not opt.db_name),
 206             "the i18n-export option cannot be used without the database (-d) option")
 207
 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))
 212
 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...
 217         if os.name == 'nt':
 218             rcfilepath = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 'openerp-server.conf')
 219         else:
 220             rcfilepath = os.path.expanduser('~/.openerp_serverrc')
 221
 222         self.rcfile = os.path.abspath(
 223             fname or opt.config or os.environ.get('OPENERP_SERVER') or rcfilepath)
 224         self.load()
 225
 226
 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
 233
 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',]
 239
 240         if hasSSL:
 241             keys.extend(['smtp_ssl', 'secure_cert_file', 'secure_pkey_file'])
 242             keys.append('secure')
 243
 244         for arg in keys:
 245             if getattr(opt, arg):
 246                 self.options[arg] = getattr(opt, arg)
 247
 248         keys = ['language', 'translate_out', 'translate_in', 'debug_mode',
 249                 'stop_after_init', 'logrotate', 'without_demo', 'netrpc', 'xmlrpc', 'syslog', 'list_db']
 250
 251         if hasSSL and not  self.options['secure']:
 252             keys.append('secure')
 253
 254         for arg in keys:
 255             if getattr(opt, arg) is not None:
 256                 self.options[arg] = getattr(opt, arg)
 257
 258         if opt.assert_exit_level:
 259             self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
 260         else:
 261             self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
 262
 263         if opt.log_level:
 264             self.options['log_level'] = self._LOGLEVELS[opt.log_level]
 265         else:
 266             self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
 267
 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')
 272
 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 {}
 276
 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()
 279
 280         if self.options['timezone']:
 281             # If an explicit TZ was provided in the config, make sure it is known
 282             try:
 283                 import pytz
 284                 tz = pytz.timezone(self.options['timezone'])
 285             except pytz.UnknownTimeZoneError:
 286                 die(True, "The specified timezone (%s) is invalid" % self.options['timezone'])
 287             except:
 288                 # If pytz is missing, don't check the provided TZ, it will be ignored anyway.
 289                 pass
 290
 291         if opt.pg_path:
 292             self.options['pg_path'] = opt.pg_path
 293
 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')
 297
 298         if not self.options['db_user']:
 299             try:
 300                 import getpass
 301                 self.options['db_user'] = getpass.getuser()
 302             except:
 303                 self.options['db_user'] = None
 304
 305         die(not self.options['db_user'], 'ERROR: No user specified for the connection to the database')
 306
 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()
 312
 313         if opt.save:
 314             self.save()
 315
 316     def _generate_pgpassfile(self):
 317         """
 318         Generate the pgpass file with the parameters from the command line (db_host, db_user,
 319         db_password)
 320
 321         Used because pg_dump and pg_restore can not accept the password on the command line.
 322         """
 323         is_win32 = sys.platform == 'win32'
 324         if is_win32:
 325             filename = os.path.join(os.environ['APPDATA'], 'pgpass.conf')
 326         else:
 327             filename = os.path.join(os.environ['HOME'], '.pgpass')
 328
 329         text_to_add = "%(db_host)s:*:*:%(db_user)s:%(db_password)s" % self.options
 330
 331         if os.path.exists(filename):
 332             content = [x.strip() for x in file(filename, 'r').readlines()]
 333             if text_to_add in content:
 334                 return
 335
 336         fp = file(filename, 'a+')
 337         fp.write(text_to_add + "\n")
 338         fp.close()
 339
 340         if is_win32:
 341             import _winreg
 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 )
 345             _winreg.CloseKey(y)
 346             _winreg.CloseKey(x)
 347         else:
 348             import stat
 349             os.chmod(filename, stat.S_IRUSR + stat.S_IWUSR)
 350
 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))
 355         contains_addons = False
 356         for f in os.listdir(res):
 357             modpath = os.path.join(res, f)
 358             if os.path.isdir(modpath) and os.path.exists(os.path.join(modpath, '__init__.py')) and \
 359             os.path.exists(os.path.join(modpath, '__terp__.py')):
 360                 contains_addons = True
 361                 break
 362
 363         if not contains_addons:
 364             raise optparse.OptionValueError("option %s: The addons-path %r does not seem to a be a valid Addons Directory!" % (opt, value))
 365
 366         setattr(parser.values, option.dest, res)
 367
 368     def load(self):
 369         p = ConfigParser.ConfigParser()
 370         try:
 371             p.read([self.rcfile])
 372             for (name,value) in p.items('options'):
 373                 if value=='True' or value=='true':
 374                     value = True
 375                 if value=='False' or value=='false':
 376                     value = False
 377                 self.options[name] = value
 378             #parse the other sections, as well
 379             for sec in p.sections():
 380                 if sec == 'options':
 381                     continue
 382                 if not self.misc.has_key(sec):
 383                     self.misc[sec]= {}
 384                 for (name, value) in p.items(sec):
 385                     if value=='True' or value=='true':
 386                         value = True
 387                     if value=='False' or value=='false':
 388                         value = False
 389                     self.misc[sec][name] = value
 390         except IOError:
 391             pass
 392         except ConfigParser.NoSectionError:
 393             pass
 394
 395     def save(self):
 396         p = ConfigParser.ConfigParser()
 397         loglevelnames = dict(zip(self._LOGLEVELS.values(), self._LOGLEVELS.keys()))
 398         p.add_section('options')
 399         for opt in self.options.keys():
 400             if opt in ('version', 'language', 'translate_out', 'translate_in', 'init', 'update'):
 401                 continue
 402             if opt in ('log_level', 'assert_exit_level'):
 403                 p.set('options', opt, loglevelnames.get(self.options[opt], self.options[opt]))
 404             else:
 405                 p.set('options', opt, self.options[opt])
 406
 407         for sec in self.misc.keys():
 408             for opt in self.misc[sec].keys():
 409                 p.set(sec,opt,self.misc[sec][opt])
 410
 411         # try to create the directories and write the file
 412         try:
 413             if not os.path.exists(os.path.dirname(self.rcfile)):
 414                 os.makedirs(os.path.dirname(self.rcfile))
 415             try:
 416                 p.write(file(self.rcfile, 'w'))
 417                 os.chmod(self.rcfile, 0600)
 418             except IOError:
 419                 sys.stderr.write("ERROR: couldn't write the config file\n")
 420
 421         except OSError:
 422             # what to do if impossible?
 423             sys.stderr.write("ERROR: couldn't create the config directory\n")
 424
 425     def get(self, key, default=None):
 426         return self.options.get(key, default)
 427
 428     def get_misc(self, sect, key, default=None):
 429         return self.misc.get(sect,{}).get(key, default)
 430
 431     def __setitem__(self, key, value):
 432         self.options[key] = value
 433
 434     def __getitem__(self, key):
 435         return self.options[key]
 436
 437 config = configmanager()
 438
 439
 440
 441 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 442