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