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