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             'xmlrpc_interface': '',    # this will bind the server to all interfaces
  44             'xmlrpc_port': 8069,
  45             'netrpc_interface': '',
  46             'netrpc_port': 8070,
  47             'xmlrpcs_interface': '',    # this will bind the server to all interfaces
  48             'xmlrpcs_port': 8071,
  49             'db_host': False,
  50             'db_port': False,
  51             'db_name': False,
  52             'db_user': False,
  53             'db_password': False,
  54             'db_maxconn': 64,
  55             'reportgz': False,
  56             'netrpc': True,
  57             'xmlrpc': True,
  58             'xmlrpcs': True,
  59             'translate_in': None,
  60             'translate_out': None,
  61             'language': None,
  62             'pg_path': None,
  63             'admin_passwd': 'admin',
  64             'csv_internal_sep': ',',
  65             'addons_path': None,
  66             'root_path': None,
  67             'debug_mode': False,
  68             'import_partial': "",
  69             'pidfile': None,
  70             'logfile': None,
  71             'logrotate': '1',
  72             'smtp_server': 'localhost',
  73             'smtp_user': False,
  74             'smtp_port':25,
  75             'smtp_ssl':False,
  76             'smtp_password': False,
  77             'stop_after_init': False,   # this will stop the server after initialization
  78             'price_accuracy': 2,
  79             'syslog' : False,
  80             'log_level': logging.INFO,
  81             'assert_exit_level': logging.ERROR, # level above which a failed assert will be raised
  82             'cache_timeout': 100000,
  83             'login_message': False,
  84             'list_db' : True,
  85             'timezone' : False, # to override the default TZ
  86             'test-disable' : False,
  87             'test-commit' : False,
  88         }
  89
  90         self.misc = {}
  91         self.config_file = fname
  92         self.has_ssl = check_ssl()
  93
  94         self._LOGLEVELS = dict([(getattr(netsvc, 'LOG_%s' % x), getattr(logging, x))
  95                           for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'TEST', 'DEBUG', 'DEBUG_RPC', 'NOTSET')])
  96
  97         version = "%s %s" % (release.description, release.version)
  98         self.parser = parser = optparse.OptionParser(version=version)
  99
 100         parser.add_option("-c", "--config", dest="config", help="specify alternate config file")
 101         parser.add_option("-s", "--save", action="store_true", dest="save", default=False,
 102                           help="save configuration to ~/.openerp_serverrc")
 103         parser.add_option("--pidfile", dest="pidfile", help="file where the server pid will be stored")
 104
 105         group = optparse.OptionGroup(parser, "XML-RPC Configuration")
 106         group.add_option("--xmlrpc-interface", dest="xmlrpc_interface", help="specify the TCP IP address for the XML-RPC protocol")
 107         group.add_option("--xmlrpc-port", dest="xmlrpc_port", help="specify the TCP port for the XML-RPC protocol", type="int")
 108         group.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", help="disable the XML-RPC protocol")
 109         parser.add_option_group(group)
 110
 111         title = "XML-RPC Secure Configuration"
 112         if not self.has_ssl:
 113             title += " (disabled as ssl is unavailable)"
 114
 115         group = optparse.OptionGroup(parser, title)
 116         group.add_option("--xmlrpcs-interface", dest="xmlrpcs_interface", help="specify the TCP IP address for the XML-RPC Secure protocol")
 117         group.add_option("--xmlrpcs-port", dest="xmlrpcs_port", help="specify the TCP port for the XML-RPC Secure protocol", type="int")
 118         group.add_option("--no-xmlrpcs", dest="xmlrpcs", action="store_false", help="disable the XML-RPC Secure protocol")
 119         group.add_option("--cert-file", dest="secure_cert_file", default="server.cert", help="specify the certificate file for the SSL connection")
 120         group.add_option("--pkey-file", dest="secure_pkey_file", default="server.pkey", help="specify the private key file for the SSL connection")
 121         parser.add_option_group(group)
 122
 123         group = optparse.OptionGroup(parser, "NET-RPC Configuration")
 124         group.add_option("--netrpc-interface", dest="netrpc_interface", help="specify the TCP IP address for the NETRPC protocol")
 125         group.add_option("--netrpc-port", dest="netrpc_port", help="specify the TCP port for the NETRPC protocol", type="int")
 126         group.add_option("--no-netrpc", dest="netrpc", action="store_false", help="disable the NETRPC protocol")
 127         parser.add_option_group(group)
 128
 129         parser.add_option("-i", "--init", dest="init", help="init a module (use \"all\" for all modules)")
 130         parser.add_option("--without-demo", dest="without_demo",
 131                           help="load demo data for a module (use \"all\" for all modules)", default=False)
 132         parser.add_option("-u", "--update", dest="update",
 133                           help="update a module (use \"all\" for all modules)")
 134         parser.add_option("--cache-timeout", dest="cache_timeout",
 135                           help="set the timeout for the cache system", default=100000, type="int")
 136         parser.add_option("-t", "--timezone", dest="timezone", help="specify reference timezone for the server (e.g. Europe/Brussels")
 137
 138         # stops the server from launching after initialization
 139         parser.add_option("--stop-after-init", action="store_true", dest="stop_after_init", default=False,
 140                           help="stop the server after it initializes")
 141         parser.add_option('--debug', dest='debug_mode', action='store_true', default=False, help='enable debug mode')
 142         parser.add_option("--assert-exit-level", dest='assert_exit_level', type="choice", choices=self._LOGLEVELS.keys(),
 143                           help="specify the level at which a failed assertion will stop the server. Accepted values: %s" % (self._LOGLEVELS.keys(),))
 144         parser.add_option('--price_accuracy', dest='price_accuracy', default='2', help='deprecated since v6.0, replaced by module decimal_precision')
 145
 146         # Testing Group
 147         group = optparse.OptionGroup(parser, "Testing Configuration")
 148         group.add_option("--test-disable", action="store_true", dest="test_disable",
 149                          default=False, help="Disable loading test files.")
 150         group.add_option("--test-commit", action="store_true", dest="test_commit",
 151                          default=False, help="Commit database changes performed by tests.")
 152         parser.add_option_group(group)
 153
 154         # Logging Group
 155         group = optparse.OptionGroup(parser, "Logging Configuration")
 156         group.add_option("--logfile", dest="logfile", help="file where the server log will be stored")
 157         group.add_option("--no-logrotate", dest="logrotate", action="store_false",
 158                          default=None, help="do not rotate the logfile")
 159         group.add_option("--syslog", action="store_true", dest="syslog",
 160                          default=False, help="Send the log to the syslog server")
 161         group.add_option('--log-level', dest='log_level', type='choice', choices=self._LOGLEVELS.keys(),
 162                          help='specify the level of the logging. Accepted values: ' + str(self._LOGLEVELS.keys()))
 163         parser.add_option_group(group)
 164
 165         # SMTP Group
 166         group = optparse.OptionGroup(parser, "SMTP Configuration")
 167         group.add_option('--email-from', dest='email_from', default='', help='specify the SMTP email address for sending email')
 168         group.add_option('--smtp', dest='smtp_server', default='', help='specify the SMTP server for sending email')
 169         group.add_option('--smtp-port', dest='smtp_port', default='25', help='specify the SMTP port', type="int")
 170         group.add_option('--smtp-ssl', dest='smtp_ssl', default='', help='specify the SMTP server support SSL or not')
 171         group.add_option('--smtp-user', dest='smtp_user', default='', help='specify the SMTP username for sending email')
 172         group.add_option('--smtp-password', dest='smtp_password', default='', help='specify the SMTP password for sending email')
 173         parser.add_option_group(group)
 174
 175         group = optparse.OptionGroup(parser, "Database related options")
 176         group.add_option("-d", "--database", dest="db_name", help="specify the database name")
 177         group.add_option("-r", "--db_user", dest="db_user", help="specify the database user name")
 178         group.add_option("-w", "--db_password", dest="db_password", help="specify the database password")
 179         group.add_option("--pg_path", dest="pg_path", help="specify the pg executable path")
 180         group.add_option("--db_host", dest="db_host", help="specify the database host")
 181         group.add_option("--db_port", dest="db_port", help="specify the database port", type="int")
 182         group.add_option("--db_maxconn", dest="db_maxconn", default='64',
 183                          help="specify the the maximum number of physical connections to posgresql")
 184         group.add_option("-P", "--import-partial", dest="import_partial",
 185                          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)
 186         parser.add_option_group(group)
 187
 188         group = optparse.OptionGroup(parser, "Internationalisation options",
 189             "Use these options to translate OpenERP to another language."
 190             "See i18n section of the user manual. Option '-d' is mandatory."
 191             "Option '-l' is mandatory in case of importation"
 192             )
 193
 194         group.add_option('-l', "--language", dest="language",
 195                          help="specify the language of the translation file. Use it with --i18n-export or --i18n-import")
 196         group.add_option("--i18n-export", dest="translate_out",
 197                          help="export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit")
 198         group.add_option("--i18n-import", dest="translate_in",
 199                          help="import a CSV or a PO file with translations and exit. The '-l' option is required.")
 200         group.add_option("--modules", dest="translate_modules",
 201                          help="specify modules to export. Use in combination with --i18n-export")
 202         group.add_option("--addons-path", dest="addons_path",
 203                          help="specify an alternative addons path.",
 204                          action="callback", callback=self._check_addons_path, nargs=1, type="string")
 205         parser.add_option_group(group)
 206
 207         security = optparse.OptionGroup(parser, 'Security-related options')
 208         security.add_option('--no-database-list', action="store_false", dest='list_db', default=True, help="disable the ability to return the list of databases")
 209         security.add_option('--enable-code-actions', action='store_true',
 210                             dest='server_actions_allow_code', default=False,
 211                             help='Enables server actions of state "code". Warning, this is a security risk.')
 212         parser.add_option_group(security)
 213
 214     def parse_config(self):
 215         (opt, args) = self.parser.parse_args()
 216
 217         def die(cond, msg):
 218             if cond:
 219                 print msg
 220                 sys.exit(1)
 221
 222         die(bool(opt.syslog) and bool(opt.logfile),
 223             "the syslog and logfile options are exclusive")
 224
 225         die(opt.translate_in and (not opt.language or not opt.db_name),
 226             "the i18n-import option cannot be used without the language (-l) and the database (-d) options")
 227
 228         die(opt.translate_out and (not opt.db_name),
 229             "the i18n-export option cannot be used without the database (-d) option")
 230
 231         # Check if the config file exists (-c used, but not -s)
 232         die(not opt.save and opt.config and not os.path.exists(opt.config),
 233             "The config file '%s' selected with -c/--config doesn't exist, "\
 234             "use -s/--save if you want to generate it"%(opt.config))
 235
 236         # place/search the config file on Win32 near the server installation
 237         # (../etc from the server)
 238         # 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,
 239         # else he won't be able to save the configurations, or even to start the server...
 240         if os.name == 'nt':
 241             rcfilepath = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 'openerp-server.conf')
 242         else:
 243             rcfilepath = os.path.expanduser('~/.openerp_serverrc')
 244
 245         self.rcfile = os.path.abspath(
 246             self.config_file or opt.config \
 247                 or os.environ.get('OPENERP_SERVER') or rcfilepath)
 248         self.load()
 249
 250
 251         # Verify that we want to log or not, if not the output will go to stdout
 252         if self.options['logfile'] in ('None', 'False'):
 253             self.options['logfile'] = False
 254         # the same for the pidfile
 255         if self.options['pidfile'] in ('None', 'False'):
 256             self.options['pidfile'] = False
 257
 258         keys = ['xmlrpc_interface', 'xmlrpc_port', 'db_name', 'db_user', 'db_password', 'db_host',
 259                 'db_port', 'list_db', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout','smtp_ssl',
 260                 'email_from', 'smtp_server', 'smtp_user', 'smtp_password', 'price_accuracy',
 261                 'netrpc_interface', 'netrpc_port', 'db_maxconn', 'import_partial', 'addons_path',
 262                 'netrpc', 'xmlrpc', 'syslog', 'without_demo', 'timezone',
 263                 'xmlrpcs_interface', 'xmlrpcs_port', 'xmlrpcs',
 264                 'secure_cert_file', 'secure_pkey_file'
 265                 ]
 266
 267         for arg in keys:
 268             if getattr(opt, arg):
 269                 self.options[arg] = getattr(opt, arg)
 270
 271         keys = ['language', 'translate_out', 'translate_in', 'debug_mode',
 272                 'stop_after_init', 'logrotate', 'without_demo', 'netrpc', 'xmlrpc', 'syslog',
 273                 'list_db', 'server_actions_allow_code']
 274
 275         keys.append('xmlrpcs')
 276
 277         for arg in keys:
 278             if getattr(opt, arg) is not None:
 279                 self.options[arg] = getattr(opt, arg)
 280
 281         if opt.assert_exit_level:
 282             self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
 283         else:
 284             self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
 285
 286         if opt.log_level:
 287             self.options['log_level'] = self._LOGLEVELS[opt.log_level]
 288         else:
 289             self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
 290
 291         if not self.options['root_path'] or self.options['root_path']=='None':
 292             self.options['root_path'] = os.path.abspath(os.path.dirname(sys.argv[0]))
 293         if not self.options['addons_path'] or self.options['addons_path']=='None':
 294             self.options['addons_path'] = os.path.join(self.options['root_path'], 'addons')
 295
 296         self.options['init'] = opt.init and dict.fromkeys(opt.init.split(','), 1) or {}
 297         self.options["demo"] = not opt.without_demo and self.options['init'] or {}
 298         self.options["test-disable"] =  opt.test_disable
 299         self.options["test-commit"] =  opt.test_commit
 300         self.options['update'] = opt.update and dict.fromkeys(opt.update.split(','), 1) or {}
 301
 302         self.options['translate_modules'] = opt.translate_modules and map(lambda m: m.strip(), opt.translate_modules.split(',')) or ['all']
 303         self.options['translate_modules'].sort()
 304
 305         if self.options['timezone']:
 306             # If an explicit TZ was provided in the config, make sure it is known
 307             try:
 308                 import pytz
 309                 tz = pytz.timezone(self.options['timezone'])
 310             except pytz.UnknownTimeZoneError:
 311                 die(True, "The specified timezone (%s) is invalid" % self.options['timezone'])
 312             except:
 313                 # If pytz is missing, don't check the provided TZ, it will be ignored anyway.
 314                 pass
 315
 316         if opt.pg_path:
 317             self.options['pg_path'] = opt.pg_path
 318
 319         if self.options.get('language', False):
 320             if len(self.options['language']) > 5:
 321                 raise Exception('ERROR: The Lang name must take max 5 chars, Eg: -lfr_BE')
 322
 323         if not self.options['db_user']:
 324             try:
 325                 import getpass
 326                 self.options['db_user'] = getpass.getuser()
 327             except:
 328                 self.options['db_user'] = None
 329
 330         die(not self.options['db_user'], 'ERROR: No user specified for the connection to the database')
 331
 332         if self.options['db_password']:
 333             if sys.platform == 'win32' and not self.options['db_host']:
 334                 self.options['db_host'] = 'localhost'
 335             #if self.options['db_host']:
 336             #    self._generate_pgpassfile()
 337
 338         if opt.save:
 339             self.save()
 340
 341     def _generate_pgpassfile(self):
 342         """
 343         Generate the pgpass file with the parameters from the command line (db_host, db_user,
 344         db_password)
 345
 346         Used because pg_dump and pg_restore can not accept the password on the command line.
 347         """
 348         is_win32 = sys.platform == 'win32'
 349         if is_win32:
 350             filename = os.path.join(os.environ['APPDATA'], 'pgpass.conf')
 351         else:
 352             filename = os.path.join(os.environ['HOME'], '.pgpass')
 353
 354         text_to_add = "%(db_host)s:*:*:%(db_user)s:%(db_password)s" % self.options
 355
 356         if os.path.exists(filename):
 357             content = [x.strip() for x in file(filename, 'r').readlines()]
 358             if text_to_add in content:
 359                 return
 360
 361         fp = file(filename, 'a+')
 362         fp.write(text_to_add + "\n")
 363         fp.close()
 364
 365         if is_win32:
 366             import _winreg
 367             x=_winreg.ConnectRegistry(None,_winreg.HKEY_LOCAL_MACHINE)
 368             y = _winreg.OpenKey(x, r"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", 0,_winreg.KEY_ALL_ACCESS)
 369             _winreg.SetValueEx(y,"PGPASSFILE", 0, _winreg.REG_EXPAND_SZ, filename )
 370             _winreg.CloseKey(y)
 371             _winreg.CloseKey(x)
 372         else:
 373             import stat
 374             os.chmod(filename, stat.S_IRUSR + stat.S_IWUSR)
 375
 376     def _check_addons_path(self, option, opt, value, parser):
 377         res = os.path.abspath(os.path.expanduser(value))
 378         if not os.path.exists(res):
 379             raise optparse.OptionValueError("option %s: no such directory: %r" % (opt, value))
 380
 381         contains_addons = False
 382         for f in os.listdir(res):
 383             modpath = os.path.join(res, f)
 384             if os.path.isdir(modpath) and \
 385                os.path.exists(os.path.join(modpath, '__init__.py')) and \
 386                (os.path.exists(os.path.join(modpath, '__openerp__.py')) or \
 387                 os.path.exists(os.path.join(modpath, '__terp__.py'))):
 388
 389                 contains_addons = True
 390                 break
 391
 392         if not contains_addons:
 393             raise optparse.OptionValueError("option %s: The addons-path %r does not seem to a be a valid Addons Directory!" % (opt, value))
 394
 395         setattr(parser.values, option.dest, res)
 396
 397     def load(self):
 398         p = ConfigParser.ConfigParser()
 399         try:
 400             p.read([self.rcfile])
 401             for (name,value) in p.items('options'):
 402                 if value=='True' or value=='true':
 403                     value = True
 404                 if value=='False' or value=='false':
 405                     value = False
 406                 self.options[name] = value
 407             #parse the other sections, as well
 408             for sec in p.sections():
 409                 if sec == 'options':
 410                     continue
 411                 if not self.misc.has_key(sec):
 412                     self.misc[sec]= {}
 413                 for (name, value) in p.items(sec):
 414                     if value=='True' or value=='true':
 415                         value = True
 416                     if value=='False' or value=='false':
 417                         value = False
 418                     self.misc[sec][name] = value
 419         except IOError:
 420             pass
 421         except ConfigParser.NoSectionError:
 422             pass
 423
 424     def save(self):
 425         p = ConfigParser.ConfigParser()
 426         loglevelnames = dict(zip(self._LOGLEVELS.values(), self._LOGLEVELS.keys()))
 427         p.add_section('options')
 428         for opt in self.options.keys():
 429             if opt in ('version', 'language', 'translate_out', 'translate_in', 'init', 'update'):
 430                 continue
 431             if opt in ('log_level', 'assert_exit_level'):
 432                 p.set('options', opt, loglevelnames.get(self.options[opt], self.options[opt]))
 433             else:
 434                 p.set('options', opt, self.options[opt])
 435
 436         for sec in self.misc.keys():
 437             for opt in self.misc[sec].keys():
 438                 p.set(sec,opt,self.misc[sec][opt])
 439
 440         # try to create the directories and write the file
 441         try:
 442             if not os.path.exists(os.path.dirname(self.rcfile)):
 443                 os.makedirs(os.path.dirname(self.rcfile))
 444             try:
 445                 p.write(file(self.rcfile, 'w'))
 446                 os.chmod(self.rcfile, 0600)
 447             except IOError:
 448                 sys.stderr.write("ERROR: couldn't write the config file\n")
 449
 450         except OSError:
 451             # what to do if impossible?
 452             sys.stderr.write("ERROR: couldn't create the config directory\n")
 453
 454     def get(self, key, default=None):
 455         return self.options.get(key, default)
 456
 457     def get_misc(self, sect, key, default=None):
 458         return self.misc.get(sect,{}).get(key, default)
 459
 460     def __setitem__(self, key, value):
 461         self.options[key] = value
 462
 463     def __getitem__(self, key):
 464         return self.options[key]
 465
 466 config = configmanager()
 467
 468 # FIXME:following line should be called explicitly by the server
 469 # when it starts, to allow doing 'import tools.config' from
 470 # other python executables without parsing *their* args.
 471 config.parse_config()
 472
 473 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 474