bin/tools/config.py

   1 # -*- encoding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
   6 #    $Id$
   7 #
   8 #    This program is free software: you can redistribute it and/or modify
   9 #    it under the terms of the GNU General Public License as published by
  10 #    the Free Software Foundation, either version 3 of the License, or
  11 #    (at your option) any later version.
  12 #
  13 #    This program is distributed in the hope that it will be useful,
  14 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #    GNU General Public License for more details.
  17 #
  18 #    You should have received a copy of the GNU General Public License
  19 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 #
  21 ##############################################################################
  22
  23 import ConfigParser
  24 import optparse
  25 import os
  26 import sys
  27 import netsvc
  28 import logging
  29 import release
  30
  31 def check_ssl():
  32     try:
  33         from OpenSSL import SSL
  34         import socket
  35
  36         return hasattr(socket, 'ssl')
  37     except:
  38         return False
  39
  40 class configmanager(object):
  41     def __init__(self, fname=None):
  42         self.options = {
  43             'email_from':False,
  44             'interface': '',    # this will bind the server to all interfaces
  45             'port': 8069,
  46             'netinterface': '',
  47             'netport': 8070,
  48             'db_host': False,
  49             'db_port': False,
  50             'db_name': False,
  51             'db_user': False,
  52             'db_password': False,
  53             'db_maxconn': 64,
  54             'reportgz': False,
  55             'netrpc': True,
  56             'xmlrpc': True,
  57             'soap': False,
  58             'translate_in': None,
  59             'translate_out': None,
  60             'language': None,
  61             'pg_path': None,
  62             'admin_passwd': 'admin',
  63             'csv_internal_sep': ',',
  64             'addons_path': None,
  65             'root_path': None,
  66             'debug_mode': False,
  67             'import_partial': "",
  68             'pidfile': None,
  69             'logfile': None,
  70             'smtp_server': 'localhost',
  71             'smtp_user': False,
  72             'smtp_port':25,
  73             'smtp_password': False,
  74             'stop_after_init': False,   # this will stop the server after initialization
  75             'price_accuracy': 2,
  76             'secure' : False,
  77             'syslog' : False,
  78             'log_level': logging.INFO,
  79             'assert_exit_level': logging.WARNING, # level above which a failed assert will be raise
  80             'cache_timeout': 100000,
  81             'login_message': False,
  82             'list_db': True,
  83         }
  84
  85         hasSSL = check_ssl()
  86
  87         self._LOGLEVELS = dict([(getattr(netsvc, 'LOG_%s' % x), getattr(logging, x))
  88                           for x in ('CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'DEBUG_RPC', 'NOTSET')])
  89
  90         version = "%s %s" % (release.description, release.version)
  91         parser = optparse.OptionParser(version=version)
  92
  93         parser.add_option("-c", "--config", dest="config", help="specify alternate config file")
  94         parser.add_option("-s", "--save", action="store_true", dest="save", default=False,
  95                           help="save configuration to ~/.openerp_serverrc")
  96         parser.add_option("--pidfile", dest="pidfile", help="file where the server pid will be stored")
  97
  98         parser.add_option("-n", "--interface", dest="interface", help="specify the TCP IP address")
  99         parser.add_option("-p", "--port", dest="port", help="specify the TCP port", type="int")
 100         parser.add_option("--net_interface", dest="netinterface", help="specify the TCP IP address for netrpc")
 101         parser.add_option("--net_port", dest="netport", help="specify the TCP port for netrpc", type="int")
 102         parser.add_option("--no-netrpc", dest="netrpc", action="store_false", default=True, help="disable netrpc")
 103         parser.add_option("--no-xmlrpc", dest="xmlrpc", action="store_false", default=True, help="disable xmlrpc")
 104         parser.add_option("-i", "--init", dest="init", help="init a module (use \"all\" for all modules)")
 105         parser.add_option("--without-demo", dest="without_demo",
 106                           help="load demo data for a module (use \"all\" for all modules)", default=False)
 107         parser.add_option("-u", "--update", dest="update",
 108                           help="update a module (use \"all\" for all modules)")
 109         parser.add_option("--cache-timeout", dest="cache_timeout",
 110                           help="set the timeout for the cache system", default=100000, type="int")
 111
 112         # stops the server from launching after initialization
 113         parser.add_option("--stop-after-init", action="store_true", dest="stop_after_init", default=False,
 114                           help="stop the server after it initializes")
 115         parser.add_option('--debug', dest='debug_mode', action='store_true', default=False, help='enable debug mode')
 116         parser.add_option("--assert-exit-level", dest='assert_exit_level', type="choice", choices=self._LOGLEVELS.keys(),
 117                           help="specify the level at which a failed assertion will stop the server. Accepted values: %s" % (self._LOGLEVELS.keys(),))
 118         parser.add_option('--price_accuracy', dest='price_accuracy', default='2', help='specify the price accuracy')
 119         parser.add_option('--no-database-list', action="store_false", dest='list_db', default=True, help="disable the ability to return the list of databases")
 120
 121         if hasSSL:
 122             group = optparse.OptionGroup(parser, "SSL Configuration")
 123             group.add_option("-S", "--secure", dest="secure",
 124                              help="launch server over https instead of http")
 125             group.add_option("--cert-file", dest="secure_cert_file",
 126                               default="server.cert",
 127                               help="specify the certificate file for the SSL connection")
 128             group.add_option("--pkey-file", dest="secure_pkey_file",
 129                               default="server.pkey",
 130                               help="specify the private key file for the SSL connection")
 131             parser.add_option_group(group)
 132
 133         # Logging Group
 134         group = optparse.OptionGroup(parser, "Logging Configuration")
 135         group.add_option("--logfile", dest="logfile", help="file where the server log will be stored")
 136         group.add_option("--syslog", action="store_true", dest="syslog",
 137                          default=False, help="Send the log to the syslog server")
 138         group.add_option('--log-level', dest='log_level', type='choice', choices=self._LOGLEVELS.keys(),
 139                          help='specify the level of the logging. Accepted values: ' + str(self._LOGLEVELS.keys()))
 140         parser.add_option_group(group)
 141
 142         # SMTP Group
 143         group = optparse.OptionGroup(parser, "SMTP Configuration")
 144         group.add_option('--email-from', dest='email_from', default='', help='specify the SMTP email address for sending email')
 145         group.add_option('--smtp', dest='smtp_server', default='', help='specify the SMTP server for sending email')
 146         group.add_option('--smtp-port', dest='smtp_port', default='25', help='specify the SMTP port', type="int")
 147         if hasSSL:
 148             group.add_option('--smtp-ssl', dest='smtp_ssl', default='', help='specify the SMTP server support SSL or not')
 149         group.add_option('--smtp-user', dest='smtp_user', default='', help='specify the SMTP username for sending email')
 150         group.add_option('--smtp-password', dest='smtp_password', default='', help='specify the SMTP password for sending email')
 151         parser.add_option_group(group)
 152
 153         group = optparse.OptionGroup(parser, "Database related options")
 154         group.add_option("-d", "--database", dest="db_name", help="specify the database name")
 155         group.add_option("-r", "--db_user", dest="db_user", help="specify the database user name")
 156         group.add_option("-w", "--db_password", dest="db_password", help="specify the database password")
 157         group.add_option("--pg_path", dest="pg_path", help="specify the pg executable path")
 158         group.add_option("--db_host", dest="db_host", help="specify the database host")
 159         group.add_option("--db_port", dest="db_port", help="specify the database port", type="int")
 160         group.add_option("--db_maxconn", dest="db_maxconn", default='64',
 161                          help="specify the the maximum number of physical connections to posgresql")
 162         group.add_option("-P", "--import-partial", dest="import_partial",
 163                          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)
 164         parser.add_option_group(group)
 165
 166         group = optparse.OptionGroup(parser, "Internationalisation options",
 167             "Use these options to translate OpenERP to another language."
 168             "See i18n section of the user manual. Option '-d' is mandatory."
 169             "Option '-l' is mandatory in case of importation"
 170             )
 171
 172         group.add_option('-l', "--language", dest="language",
 173                          help="specify the language of the translation file. Use it with --i18n-export or --i18n-import")
 174         group.add_option("--i18n-export", dest="translate_out",
 175                          help="export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit")
 176         group.add_option("--i18n-import", dest="translate_in",
 177                          help="import a CSV or a PO file with translations and exit. The '-l' option is required.")
 178         group.add_option("--modules", dest="translate_modules",
 179                          help="specify modules to export. Use in combination with --i18n-export")
 180         group.add_option("--addons-path", dest="addons_path",
 181                          help="specify an alternative addons path.",
 182                          action="callback", callback=self._check_addons_path, nargs=1, type="string")
 183         parser.add_option_group(group)
 184
 185         (opt, args) = parser.parse_args()
 186
 187         def die(cond, msg):
 188             if cond:
 189                 print msg
 190                 sys.exit(1)
 191
 192         die(bool(opt.syslog) and bool(opt.logfile),
 193             "the syslog and logfile options are exclusive")
 194
 195         die(opt.translate_in and (not opt.language or not opt.db_name),
 196             "the i18n-import option cannot be used without the language (-l) and the database (-d) options")
 197
 198         die(opt.translate_out and (not opt.db_name),
 199             "the i18n-export option cannot be used without the database (-d) option")
 200
 201         # place/search the config file on Win32 near the server installation
 202         # (../etc from the server)
 203         # 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,
 204         # else he won't be able to save the configurations, or even to start the server...
 205         if os.name == 'nt':
 206             rcfilepath = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 'openerp-server.conf')
 207         else:
 208             rcfilepath = os.path.expanduser('~/.openerp_serverrc')
 209
 210         self.rcfile = fname or opt.config or os.environ.get('OPENERP_SERVER') or rcfilepath
 211         self.load()
 212
 213
 214         # Verify that we want to log or not, if not the output will go to stdout
 215         if self.options['logfile'] in ('None', 'False'):
 216             self.options['logfile'] = False
 217         # the same for the pidfile
 218         if self.options['pidfile'] in ('None', 'False'):
 219             self.options['pidfile'] = False
 220
 221         keys = ['interface', 'port', 'db_name', 'db_user', 'db_password', 'db_host',
 222                 'db_port', 'logfile', 'pidfile', 'smtp_port', 'cache_timeout',
 223                 'email_from', 'smtp_server', 'smtp_user', 'smtp_password', 'price_accuracy',
 224                 'netinterface', 'netport', 'db_maxconn', 'import_partial', 'addons_path']
 225
 226         if hasSSL:
 227             keys.extend(['smtp_ssl', 'secure_cert_file', 'secure_pkey_file'])
 228
 229         for arg in keys:
 230             if getattr(opt, arg):
 231                 self.options[arg] = getattr(opt, arg)
 232
 233         keys = ['language', 'translate_out', 'translate_in', 'debug_mode',
 234                 'stop_after_init', 'without_demo', 'netrpc', 'xmlrpc', 'syslog', 'list_db']
 235
 236         if hasSSL and not  self.options['secure']:
 237             keys.append('secure')
 238
 239         for arg in keys:
 240             if getattr(opt, arg) is not None:
 241                 self.options[arg] = getattr(opt, arg)
 242
 243         if opt.assert_exit_level:
 244             self.options['assert_exit_level'] = self._LOGLEVELS[opt.assert_exit_level]
 245         else:
 246             self.options['assert_exit_level'] = self._LOGLEVELS.get(self.options['assert_exit_level']) or int(self.options['assert_exit_level'])
 247
 248         if opt.log_level:
 249             self.options['log_level'] = self._LOGLEVELS[opt.log_level]
 250         else:
 251             self.options['log_level'] = self._LOGLEVELS.get(self.options['log_level']) or int(self.options['log_level'])
 252
 253         if not self.options['root_path'] or self.options['root_path']=='None':
 254             self.options['root_path'] = os.path.abspath(os.path.dirname(sys.argv[0]))
 255         if not self.options['addons_path'] or self.options['addons_path']=='None':
 256             self.options['addons_path'] = os.path.join(self.options['root_path'], 'addons')
 257
 258         self.options['init'] = opt.init and dict.fromkeys(opt.init.split(','), 1) or {}
 259         self.options["demo"] = not opt.without_demo and self.options['init'] or {}
 260         self.options['update'] = opt.update and dict.fromkeys(opt.update.split(','), 1) or {}
 261
 262         self.options['translate_modules'] = opt.translate_modules and map(lambda m: m.strip(), opt.translate_modules.split(',')) or ['all']
 263         self.options['translate_modules'].sort()
 264
 265         if opt.pg_path:
 266             self.options['pg_path'] = opt.pg_path
 267
 268         if self.options.get('language', False):
 269             if len(self.options['language']) > 5:
 270                 raise Exception('ERROR: The Lang name must take max 5 chars, Eg: -lfr_BE')
 271
 272         if not self.options['db_user']:
 273             try:
 274                 import getpass
 275                 self.options['db_user'] = getpass.getuser()
 276             except:
 277                 self.options['db_user'] = None
 278
 279         die(not self.options['db_user'], 'ERROR: No user specified for the connection to the database')
 280
 281         if self.options['db_password']:
 282             if sys.platform == 'win32' and not self.options['db_host']:
 283                 self.options['db_host'] = 'localhost'
 284             #if self.options['db_host']:
 285             #    self._generate_pgpassfile()
 286
 287         if opt.save:
 288             self.save()
 289
 290     def _generate_pgpassfile(self):
 291         """
 292         Generate the pgpass file with the parameters from the command line (db_host, db_user,
 293         db_password)
 294
 295         Used because pg_dump and pg_restore can not accept the password on the command line.
 296         """
 297         is_win32 = sys.platform == 'win32'
 298         if is_win32:
 299             filename = os.path.join(os.environ['APPDATA'], 'pgpass.conf')
 300         else:
 301             filename = os.path.join(os.environ['HOME'], '.pgpass')
 302
 303         text_to_add = "%(db_host)s:*:*:%(db_user)s:%(db_password)s" % self.options
 304
 305         if os.path.exists(filename):
 306             content = [x.strip() for x in file(filename, 'r').readlines()]
 307             if text_to_add in content:
 308                 return
 309
 310         fp = file(filename, 'a+')
 311         fp.write(text_to_add + "\n")
 312         fp.close()
 313
 314         if is_win32:
 315             import _winreg
 316             x=_winreg.ConnectRegistry(None,_winreg.HKEY_LOCAL_MACHINE)
 317             y = _winreg.OpenKey(x, r"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", 0,_winreg.KEY_ALL_ACCESS)
 318             _winreg.SetValueEx(y,"PGPASSFILE", 0, _winreg.REG_EXPAND_SZ, filename )
 319             _winreg.CloseKey(y)
 320             _winreg.CloseKey(x)
 321         else:
 322             import stat
 323             os.chmod(filename, stat.S_IRUSR + stat.S_IWUSR)
 324
 325     def _check_addons_path(self, option, opt, value, parser):
 326         res = os.path.abspath(os.path.expanduser(value))
 327         if not os.path.exists(res):
 328             raise optparse.OptionValueError("option %s: no such directory: %r" % (opt, value))
 329         setattr(parser.values, option.dest, res)
 330
 331     def load(self):
 332         p = ConfigParser.ConfigParser()
 333         try:
 334             p.read([self.rcfile])
 335             for (name,value) in p.items('options'):
 336                 if value=='True' or value=='true':
 337                     value = True
 338                 if value=='False' or value=='false':
 339                     value = False
 340                 self.options[name] = value
 341         except IOError:
 342             pass
 343         except ConfigParser.NoSectionError:
 344             pass
 345
 346     def save(self):
 347         p = ConfigParser.ConfigParser()
 348         loglevelnames = dict(zip(self._LOGLEVELS.values(), self._LOGLEVELS.keys()))
 349         p.add_section('options')
 350         for opt in self.options.keys():
 351             if opt in ('version', 'language', 'translate_out', 'translate_in', 'init', 'update'):
 352                 continue
 353             if opt in ('log_level', 'assert_exit_level'):
 354                 p.set('options', opt, loglevelnames.get(self.options[opt], self.options[opt]))
 355             else:
 356                 p.set('options', opt, self.options[opt])
 357
 358         # try to create the directories and write the file
 359         try:
 360             if not os.path.exists(os.path.dirname(self.rcfile)):
 361                 os.makedirs(os.path.dirname(self.rcfile))
 362             try:
 363                 p.write(file(self.rcfile, 'w'))
 364                 os.chmod(self.rcfile, 0600)
 365             except IOError:
 366                 sys.stderr.write("ERROR: couldn't write the config file\n")
 367
 368         except OSError:
 369             # what to do if impossible?
 370             sys.stderr.write("ERROR: couldn't create the config directory\n")
 371
 372     def get(self, key, default=None):
 373         return self.options.get(key, default)
 374
 375     def __setitem__(self, key, value):
 376         self.options[key] = value
 377
 378     def __getitem__(self, key):
 379         return self.options[key]
 380
 381 config = configmanager()
 382
 383
 384
 385 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 386