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