roundup/configuration.py

   1 # Roundup Issue Tracker configuration support
   2 #
   3 # $Id: configuration.py,v 1.51 2008-09-01 02:30:06 richard Exp $
   4 #
   5 __docformat__ = "restructuredtext"
   6
   7 import ConfigParser
   8 import getopt
   9 import imp
  10 import logging, logging.config
  11 import os
  12 import re
  13 import sys
  14 import time
  15 import smtplib
  16
  17 import roundup.date
  18
  19 # XXX i don't think this module needs string translation, does it?
  20
  21 ### Exceptions
  22
  23 class ConfigurationError(Exception):
  24     pass
  25
  26 class NoConfigError(ConfigurationError):
  27
  28     """Raised when configuration loading fails
  29
  30     Constructor parameters: path to the directory that was used as HOME
  31
  32     """
  33
  34     def __str__(self):
  35         return "No valid configuration files found in directory %s" \
  36             % self.args[0]
  37
  38 class InvalidOptionError(ConfigurationError, KeyError, AttributeError):
  39
  40     """Attempted access to non-existing configuration option
  41
  42     Configuration options may be accessed as configuration object
  43     attributes or items.  So this exception instances also are
  44     instances of KeyError (invalid item access) and AttributeError
  45     (invalid attribute access).
  46
  47     Constructor parameter: option name
  48
  49     """
  50
  51     def __str__(self):
  52         return "Unsupported configuration option: %s" % self.args[0]
  53
  54 class OptionValueError(ConfigurationError, ValueError):
  55
  56     """Raised upon attempt to assign an invalid value to config option
  57
  58     Constructor parameters: Option instance, offending value
  59     and optional info string.
  60
  61     """
  62
  63     def __str__(self):
  64         _args = self.args
  65         _rv = "Invalid value for %(option)s: %(value)r" % {
  66             "option": _args[0].name, "value": _args[1]}
  67         if len(_args) > 2:
  68             _rv += "\n".join(("",) + _args[2:])
  69         return _rv
  70
  71 class OptionUnsetError(ConfigurationError):
  72
  73     """Raised when no Option value is available - neither set, nor default
  74
  75     Constructor parameters: Option instance.
  76
  77     """
  78
  79     def __str__(self):
  80         return "%s is not set and has no default" % self.args[0].name
  81
  82 class UnsetDefaultValue:
  83
  84     """Special object meaning that default value for Option is not specified"""
  85
  86     def __str__(self):
  87         return "NO DEFAULT"
  88
  89 NODEFAULT = UnsetDefaultValue()
  90
  91 ### Option classes
  92
  93 class Option:
  94
  95     """Single configuration option.
  96
  97     Options have following attributes:
  98
  99         config
 100             reference to the containing Config object
 101         section
 102             name of the section in the tracker .ini file
 103         setting
 104             option name in the tracker .ini file
 105         default
 106             default option value
 107         description
 108             option description.  Makes a comment in the tracker .ini file
 109         name
 110             "canonical name" of the configuration option.
 111             For items in the 'main' section this is uppercased
 112             'setting' name.  For other sections, the name is
 113             composed of the section name and the setting name,
 114             joined with underscore.
 115         aliases
 116             list of "also known as" names.  Used to access the settings
 117             by old names used in previous Roundup versions.
 118             "Canonical name" is also included.
 119
 120     The name and aliases are forced to be uppercase.
 121     The setting name is forced to lowercase.
 122
 123     """
 124
 125     class_description = None
 126
 127     def __init__(self, config, section, setting,
 128         default=NODEFAULT, description=None, aliases=None
 129     ):
 130         self.config = config
 131         self.section = section
 132         self.setting = setting.lower()
 133         self.default = default
 134         self.description = description
 135         self.name = setting.upper()
 136         if section != "main":
 137             self.name = "_".join((section.upper(), self.name))
 138         if aliases:
 139             self.aliases = [alias.upper() for alias in list(aliases)]
 140         else:
 141             self.aliases = []
 142         self.aliases.insert(0, self.name)
 143         # convert default to internal representation
 144         if default is NODEFAULT:
 145             _value = default
 146         else:
 147             _value = self.str2value(default)
 148         # value is private.  use get() and set() to access
 149         self._value = self._default_value = _value
 150
 151     def str2value(self, value):
 152         """Return 'value' argument converted to internal representation"""
 153         return value
 154
 155     def _value2str(self, value):
 156         """Return 'value' argument converted to external representation
 157
 158         This is actual conversion method called only when value
 159         is not NODEFAULT.  Heirs with different conversion rules
 160         override this method, not the public .value2str().
 161
 162         """
 163         return str(value)
 164
 165     def value2str(self, value=NODEFAULT, current=0):
 166         """Return 'value' argument converted to external representation
 167
 168         If 'current' is True, use current option value.
 169
 170         """
 171         if current:
 172             value = self._value
 173         if value is NODEFAULT:
 174             return str(value)
 175         else:
 176             return self._value2str(value)
 177
 178     def get(self):
 179         """Return current option value"""
 180         if self._value is NODEFAULT:
 181             raise OptionUnsetError(self)
 182         return self._value
 183
 184     def set(self, value):
 185         """Update the value"""
 186         self._value = self.str2value(value)
 187
 188     def reset(self):
 189         """Reset the value to default"""
 190         self._value = self._default_value
 191
 192     def isdefault(self):
 193         """Return True if current value is the default one"""
 194         return self._value == self._default_value
 195
 196     def isset(self):
 197         """Return True if the value is available (either set or default)"""
 198         return self._value != NODEFAULT
 199
 200     def __str__(self):
 201         return self.value2str(self._value)
 202
 203     def __repr__(self):
 204         if self.isdefault():
 205             _format = "<%(class)s %(name)s (default): %(value)s>"
 206         else:
 207             _format = "<%(class)s %(name)s (default: %(default)s): %(value)s>"
 208         return _format % {
 209             "class": self.__class__.__name__,
 210             "name": self.name,
 211             "default": self.value2str(self._default_value),
 212             "value": self.value2str(self._value),
 213         }
 214
 215     def format(self):
 216         """Return .ini file fragment for this option"""
 217         _desc_lines = []
 218         for _description in (self.description, self.class_description):
 219             if _description:
 220                 _desc_lines.extend(_description.split("\n"))
 221         # comment out the setting line if there is no value
 222         if self.isset():
 223             _is_set = ""
 224         else:
 225             _is_set = "#"
 226         _rv = "# %(description)s\n# Default: %(default)s\n" \
 227             "%(is_set)s%(name)s = %(value)s\n" % {
 228                 "description": "\n# ".join(_desc_lines),
 229                 "default": self.value2str(self._default_value),
 230                 "name": self.setting,
 231                 "value": self.value2str(self._value),
 232                 "is_set": _is_set
 233             }
 234         return _rv
 235
 236     def load_ini(self, config):
 237         """Load value from ConfigParser object"""
 238         if config.has_option(self.section, self.setting):
 239             self.set(config.get(self.section, self.setting))
 240
 241     def load_pyconfig(self, config):
 242         """Load value from old-style config (python module)"""
 243         for _name in self.aliases:
 244             if hasattr(config, _name):
 245                 self.set(getattr(config, _name))
 246                 break
 247
 248 class BooleanOption(Option):
 249
 250     """Boolean option: yes or no"""
 251
 252     class_description = "Allowed values: yes, no"
 253
 254     def _value2str(self, value):
 255         if value:
 256             return "yes"
 257         else:
 258             return "no"
 259
 260     def str2value(self, value):
 261         if type(value) == type(""):
 262             _val = value.lower()
 263             if _val in ("yes", "true", "on", "1"):
 264                 _val = 1
 265             elif _val in ("no", "false", "off", "0"):
 266                 _val = 0
 267             else:
 268                 raise OptionValueError(self, value, self.class_description)
 269         else:
 270             _val = value and 1 or 0
 271         return _val
 272
 273 class WordListOption(Option):
 274
 275     """List of strings"""
 276
 277     class_description = "Allowed values: comma-separated list of words"
 278
 279     def _value2str(self, value):
 280         return ','.join(value)
 281
 282     def str2value(self, value):
 283         return value.split(',')
 284
 285 class RunDetectorOption(Option):
 286
 287     """When a detector is run: always, never or for new items only"""
 288
 289     class_description = "Allowed values: yes, no, new"
 290
 291     def str2value(self, value):
 292         _val = value.lower()
 293         if _val in ("yes", "no", "new"):
 294             return _val
 295         else:
 296             raise OptionValueError(self, value, self.class_description)
 297
 298 class MailAddressOption(Option):
 299
 300     """Email address
 301
 302     Email addresses may be either fully qualified or local.
 303     In the latter case MAIL_DOMAIN is automatically added.
 304
 305     """
 306
 307     def get(self):
 308         _val = Option.get(self)
 309         if "@" not in _val:
 310             _val = "@".join((_val, self.config["MAIL_DOMAIN"]))
 311         return _val
 312
 313 class FilePathOption(Option):
 314
 315     """File or directory path name
 316
 317     Paths may be either absolute or relative to the HOME.
 318
 319     """
 320
 321     class_description = "The path may be either absolute or relative\n" \
 322         "to the directory containig this config file."
 323
 324     def get(self):
 325         _val = Option.get(self)
 326         if _val and not os.path.isabs(_val):
 327             _val = os.path.join(self.config["HOME"], _val)
 328         return _val
 329
 330 class FloatNumberOption(Option):
 331
 332     """Floating point numbers"""
 333
 334     def str2value(self, value):
 335         try:
 336             return float(value)
 337         except ValueError:
 338             raise OptionValueError(self, value,
 339                 "Floating point number required")
 340
 341     def _value2str(self, value):
 342         _val = str(value)
 343         # strip fraction part from integer numbers
 344         if _val.endswith(".0"):
 345             _val = _val[:-2]
 346         return _val
 347
 348 class IntegerNumberOption(Option):
 349
 350     """Integer numbers"""
 351
 352     def str2value(self, value):
 353         try:
 354             return int(value)
 355         except ValueError:
 356             raise OptionValueError(self, value, "Integer number required")
 357
 358 class OctalNumberOption(Option):
 359
 360     """Octal Integer numbers"""
 361
 362     def str2value(self, value):
 363         try:
 364             return int(value, 8)
 365         except ValueError:
 366             raise OptionValueError(self, value, "Octal Integer number required")
 367
 368     def _value2str(self, value):
 369         return oct(value)
 370
 371 class NullableOption(Option):
 372
 373     """Option that is set to None if its string value is one of NULL strings
 374
 375     Default nullable strings list contains empty string only.
 376     There is constructor parameter allowing to specify different nullables.
 377
 378     Conversion to external representation returns the first of the NULL
 379     strings list when the value is None.
 380
 381     """
 382
 383     NULL_STRINGS = ("",)
 384
 385     def __init__(self, config, section, setting,
 386         default=NODEFAULT, description=None, aliases=None,
 387         null_strings=NULL_STRINGS
 388     ):
 389         self.null_strings = list(null_strings)
 390         Option.__init__(self, config, section, setting, default,
 391             description, aliases)
 392
 393     def str2value(self, value):
 394         if value in self.null_strings:
 395             return None
 396         else:
 397             return value
 398
 399     def _value2str(self, value):
 400         if value is None:
 401             return self.null_strings[0]
 402         else:
 403             return value
 404
 405 class NullableFilePathOption(NullableOption, FilePathOption):
 406
 407     # .get() and class_description are from FilePathOption,
 408     get = FilePathOption.get
 409     class_description = FilePathOption.class_description
 410     # everything else taken from NullableOption (inheritance order)
 411
 412 class TimezoneOption(Option):
 413
 414     class_description = \
 415         "If pytz module is installed, value may be any valid\n" \
 416         "timezone specification (e.g. EET or Europe/Warsaw).\n" \
 417         "If pytz is not installed, value must be integer number\n" \
 418         "giving local timezone offset from UTC in hours."
 419
 420     def str2value(self, value):
 421         try:
 422             roundup.date.get_timezone(value)
 423         except KeyError:
 424             raise OptionValueError(self, value,
 425                     "Timezone name or numeric hour offset required")
 426         return value
 427
 428 class RegExpOption(Option):
 429
 430     """Regular Expression option (value is Regular Expression Object)"""
 431
 432     class_description = "Value is Python Regular Expression (UTF8-encoded)."
 433
 434     RE_TYPE = type(re.compile(""))
 435
 436     def __init__(self, config, section, setting,
 437         default=NODEFAULT, description=None, aliases=None,
 438         flags=0,
 439     ):
 440         self.flags = flags
 441         Option.__init__(self, config, section, setting, default,
 442             description, aliases)
 443
 444     def _value2str(self, value):
 445         assert isinstance(value, self.RE_TYPE)
 446         return value.pattern
 447
 448     def str2value(self, value):
 449         if not isinstance(value, unicode):
 450             value = str(value)
 451             # if it is 7-bit ascii, use it as string,
 452             # otherwise convert to unicode.
 453             try:
 454                 value.decode("ascii")
 455             except UnicodeError:
 456                 value = value.decode("utf-8")
 457         return re.compile(value, self.flags)
 458
 459 ### Main configuration layout.
 460 # Config is described as a sequence of sections,
 461 # where each section name is followed by a sequence
 462 # of Option definitions.  Each Option definition
 463 # is a sequence containing class name and constructor
 464 # parameters, starting from the setting name:
 465 # setting, default, [description, [aliases]]
 466 # Note: aliases should only exist in historical options for backwards
 467 # compatibility - new options should *not* have aliases!
 468 SETTINGS = (
 469     ("main", (
 470         (FilePathOption, "database", "db", "Database directory path."),
 471         (FilePathOption, "templates", "html",
 472             "Path to the HTML templates directory."),
 473         (NullableFilePathOption, "static_files", "",
 474             "Path to directory holding additional static files\n"
 475             "available via Web UI.  This directory may contain\n"
 476             "sitewide images, CSS stylesheets etc. and is searched\n"
 477             "for these files prior to the TEMPLATES directory\n"
 478             "specified above.  If this option is not set, all static\n"
 479             "files are taken from the TEMPLATES directory"),
 480         (MailAddressOption, "admin_email", "roundup-admin",
 481             "Email address that roundup will complain to if it runs\n"
 482             "into trouble.\n"
 483             "If no domain is specified then the config item\n"
 484             "mail -> domain is added."),
 485         (MailAddressOption, "dispatcher_email", "roundup-admin",
 486             "The 'dispatcher' is a role that can get notified\n"
 487             "of new items to the database.\n"
 488             "It is used by the ERROR_MESSAGES_TO config setting.\n"
 489             "If no domain is specified then the config item\n"
 490             "mail -> domain is added."),
 491         (Option, "email_from_tag", "",
 492             "Additional text to include in the \"name\" part\n"
 493             "of the From: address used in nosy messages.\n"
 494             "If the sending user is \"Foo Bar\", the From: line\n"
 495             "is usually: \"Foo Bar\" <issue_tracker@tracker.example>\n"
 496             "the EMAIL_FROM_TAG goes inside the \"Foo Bar\" quotes like so:\n"
 497             "\"Foo Bar EMAIL_FROM_TAG\" <issue_tracker@tracker.example>"),
 498         (Option, "new_web_user_roles", "User",
 499             "Roles that a user gets when they register"
 500             " with Web User Interface.\n"
 501             "This is a comma-separated string of role names"
 502             " (e.g. 'Admin,User')."),
 503         (Option, "new_email_user_roles", "User",
 504             "Roles that a user gets when they register"
 505             " with Email Gateway.\n"
 506             "This is a comma-separated string of role names"
 507             " (e.g. 'Admin,User')."),
 508         (Option, "error_messages_to", "user",
 509             # XXX This description needs better wording,
 510             #   with explicit allowed values list.
 511             "Send error message emails to the dispatcher, user, or both?\n"
 512             "The dispatcher is configured using the DISPATCHER_EMAIL"
 513             " setting."),
 514         (Option, "html_version", "html4",
 515             "HTML version to generate. The templates are html4 by default.\n"
 516             "If you wish to make them xhtml, then you'll need to change this\n"
 517             "var to 'xhtml' too so all auto-generated HTML is compliant.\n"
 518             "Allowed values: html4, xhtml"),
 519         (TimezoneOption, "timezone", "UTC", "Default timezone offset,"
 520             " applied when user's timezone is not set.",
 521             ["DEFAULT_TIMEZONE"]),
 522         (BooleanOption, "instant_registration", "no",
 523             "Register new users instantly, or require confirmation via\n"
 524             "email?"),
 525         (BooleanOption, "email_registration_confirmation", "yes",
 526             "Offer registration confirmation by email or only through the web?"),
 527         (WordListOption, "indexer_stopwords", "",
 528             "Additional stop-words for the full-text indexer specific to\n"
 529             "your tracker. See the indexer source for the default list of\n"
 530             "stop-words (eg. A,AND,ARE,AS,AT,BE,BUT,BY, ...)"),
 531         (OctalNumberOption, "umask", "02",
 532             "Defines the file creation mode mask."),
 533         (IntegerNumberOption, 'csv_field_size', '131072',
 534             "Maximum size of a csv-field during import. Roundups export\n"
 535             "format is a csv (comma separated values) variant. The csv\n"
 536             "reader has a limit on the size of individual fields\n"
 537             "starting with python 2.5. Set this to a higher value if you\n"
 538             "get the error 'Error: field larger than field limit' during\n"
 539             "import."),
 540         (IntegerNumberOption, 'password_pbkdf2_default_rounds', '10000',
 541             "Sets the default number of rounds used when encoding passwords\n"
 542             "using the PBKDF2 scheme. Set this to a higher value on faster\n"
 543             "systems which want more security."),
 544     )),
 545     ("tracker", (
 546         (Option, "name", "Roundup issue tracker",
 547             "A descriptive name for your roundup instance."),
 548         (Option, "web", NODEFAULT,
 549             "The web address that the tracker is viewable at.\n"
 550             "This will be included in information"
 551             " sent to users of the tracker.\n"
 552             "The URL MUST include the cgi-bin part or anything else\n"
 553             "that is required to get to the home page of the tracker.\n"
 554             "You MUST include a trailing '/' in the URL."),
 555         (MailAddressOption, "email", "issue_tracker",
 556             "Email address that mail to roundup should go to.\n"
 557             "If no domain is specified then mail_domain is added."),
 558         (NullableOption, "language", "",
 559             "Default locale name for this tracker.\n"
 560             "If this option is not set, the language is determined\n"
 561             "by OS environment variable LANGUAGE, LC_ALL, LC_MESSAGES,\n"
 562             "or LANG, in that order of preference."),
 563     )),
 564     ("web", (
 565         (BooleanOption, "allow_html_file", "no",
 566             "Setting this option enables Roundup to serve uploaded HTML\n"
 567             "file content *as HTML*. This is a potential security risk\n"
 568             "and is therefore disabled by default. Set to 'yes' if you\n"
 569             "trust *all* users uploading content to your tracker."),
 570         (BooleanOption, 'http_auth', "yes",
 571             "Whether to use HTTP Basic Authentication, if present.\n"
 572             "Roundup will use either the REMOTE_USER or HTTP_AUTHORIZATION\n"
 573             "variables supplied by your web server (in that order).\n"
 574             "Set this option to 'no' if you do not wish to use HTTP Basic\n"
 575             "Authentication in your web interface."),
 576         (BooleanOption, 'use_browser_language', "yes",
 577             "Whether to use HTTP Accept-Language, if present.\n"
 578             "Browsers send a language-region preference list.\n"
 579             "It's usually set in the client's browser or in their\n"
 580             "Operating System.\n"
 581             "Set this option to 'no' if you want to ignore it."),
 582         (BooleanOption, "debug", "no",
 583             "Setting this option makes Roundup display error tracebacks\n"
 584             "in the user's browser rather than emailing them to the\n"
 585             "tracker admin."),
 586         (BooleanOption, "migrate_passwords", "yes",
 587             "Setting this option makes Roundup migrate passwords with\n"
 588             "an insecure password-scheme to a more secure scheme\n"
 589             "when the user logs in via the web-interface."),
 590     )),
 591     ("rdbms", (
 592         (Option, 'name', 'roundup',
 593             "Name of the database to use.",
 594             ['MYSQL_DBNAME']),
 595         (NullableOption, 'host', 'localhost',
 596             "Database server host.",
 597             ['MYSQL_DBHOST']),
 598         (NullableOption, 'port', '',
 599             "TCP port number of the database server.\n"
 600             "Postgresql usually resides on port 5432 (if any),\n"
 601             "for MySQL default port number is 3306.\n"
 602             "Leave this option empty to use backend default"),
 603         (NullableOption, 'user', 'roundup',
 604             "Database user name that Roundup should use.",
 605             ['MYSQL_DBUSER']),
 606         (NullableOption, 'password', 'roundup',
 607             "Database user password.",
 608             ['MYSQL_DBPASSWORD']),
 609         (NullableOption, 'read_default_file', '~/.my.cnf',
 610             "Name of the MySQL defaults file.\n"
 611             "Only used in MySQL connections."),
 612         (NullableOption, 'read_default_group', 'roundup',
 613             "Name of the group to use in the MySQL defaults file (.my.cnf).\n"
 614             "Only used in MySQL connections."),
 615         (IntegerNumberOption, 'sqlite_timeout', '30',
 616             "Number of seconds to wait when the SQLite database is locked\n"
 617             "Default: use a 30 second timeout (extraordinarily generous)\n"
 618             "Only used in SQLite connections."),
 619         (IntegerNumberOption, 'cache_size', '100',
 620             "Size of the node cache (in elements)"),
 621         (BooleanOption, "allow_create", "yes",
 622             "Setting this option to 'no' protects the database against table creations."),
 623         (BooleanOption, "allow_alter", "yes",
 624             "Setting this option to 'no' protects the database against table alterations."),
 625         (BooleanOption, "allow_drop", "yes",
 626             "Setting this option to 'no' protects the database against table drops."),
 627         (NullableOption, 'template', '',
 628             "Name of the PostgreSQL template for database creation.\n"
 629             "For database creation the template used has to match\n"
 630             "the character encoding used (UTF8), there are different\n"
 631             "PostgreSQL installations using different templates with\n"
 632             "different encodings. If you get an error:\n"
 633             "  new encoding (UTF8) is incompatible with the encoding of\n"
 634             "  the template database (SQL_ASCII)\n"
 635             "  HINT:  Use the same encoding as in the template database,\n"
 636             "  or use template0 as template.\n"
 637             "then set this option to the template name given in the\n"
 638             "error message."),
 639     ), "Settings in this section are used"
 640         " by RDBMS backends only"
 641     ),
 642     ("logging", (
 643         (FilePathOption, "config", "",
 644             "Path to configuration file for standard Python logging module.\n"
 645             "If this option is set, logging configuration is loaded\n"
 646             "from specified file; options 'filename' and 'level'\n"
 647             "in this section are ignored."),
 648         (FilePathOption, "filename", "",
 649             "Log file name for minimal logging facility built into Roundup.\n"
 650             "If no file name specified, log messages are written on stderr.\n"
 651             "If above 'config' option is set, this option has no effect."),
 652         (Option, "level", "ERROR",
 653             "Minimal severity level of messages written to log file.\n"
 654             "If above 'config' option is set, this option has no effect.\n"
 655             "Allowed values: DEBUG, INFO, WARNING, ERROR"),
 656     )),
 657     ("mail", (
 658         (Option, "domain", NODEFAULT,
 659             "The email domain that admin_email, issue_tracker and\n"
 660             "dispatcher_email belong to.\n"
 661             "This domain is added to those config items if they don't\n"
 662             "explicitly include a domain.\n"
 663             "Do not include the '@' symbol."),
 664         (Option, "host", NODEFAULT,
 665             "SMTP mail host that roundup will use to send mail",
 666             ["MAILHOST"],),
 667         (Option, "username", "", "SMTP login name.\n"
 668             "Set this if your mail host requires authenticated access.\n"
 669             "If username is not empty, password (below) MUST be set!"),
 670         (Option, "password", NODEFAULT, "SMTP login password.\n"
 671             "Set this if your mail host requires authenticated access."),
 672         (IntegerNumberOption, "port", smtplib.SMTP_PORT,
 673             "Default port to send SMTP on.\n"
 674             "Set this if your mail server runs on a different port."),
 675         (NullableOption, "local_hostname", '',
 676             "The local hostname to use during SMTP transmission.\n"
 677             "Set this if your mail server requires something specific."),
 678         (BooleanOption, "tls", "no",
 679             "If your SMTP mail host provides or requires TLS\n"
 680             "(Transport Layer Security) then set this option to 'yes'."),
 681         (NullableFilePathOption, "tls_keyfile", "",
 682             "If TLS is used, you may set this option to the name\n"
 683             "of a PEM formatted file that contains your private key."),
 684         (NullableFilePathOption, "tls_certfile", "",
 685             "If TLS is used, you may set this option to the name\n"
 686             "of a PEM formatted certificate chain file."),
 687         (Option, "charset", "utf-8",
 688             "Character set to encode email headers with.\n"
 689             "We use utf-8 by default, as it's the most flexible.\n"
 690             "Some mail readers (eg. Eudora) can't cope with that,\n"
 691             "so you might need to specify a more limited character set\n"
 692             "(eg. iso-8859-1).",
 693             ["EMAIL_CHARSET"]),
 694         (FilePathOption, "debug", "",
 695             "Setting this option makes Roundup to write all outgoing email\n"
 696             "messages to this file *instead* of sending them.\n"
 697             "This option has the same effect as environment variable"
 698             " SENDMAILDEBUG.\nEnvironment variable takes precedence."),
 699         (BooleanOption, "add_authorinfo", "yes",
 700             "Add a line with author information at top of all messages\n"
 701             "sent by roundup"),
 702         (BooleanOption, "add_authoremail", "yes",
 703             "Add the mail address of the author to the author information at\n"
 704             "the top of all messages.\n"
 705             "If this is false but add_authorinfo is true, only the name\n"
 706             "of the actor is added which protects the mail address of the\n"
 707             "actor from being exposed at mail archives, etc."),
 708     ), "Outgoing email options.\nUsed for nozy messages and approval requests"),
 709     ("mailgw", (
 710         (BooleanOption, "keep_quoted_text", "yes",
 711             "Keep email citations when accepting messages.\n"
 712             "Setting this to \"no\" strips out \"quoted\" text"
 713             " from the message.\n"
 714             "Signatures are also stripped.",
 715             ["EMAIL_KEEP_QUOTED_TEXT"]),
 716         (BooleanOption, "leave_body_unchanged", "no",
 717             "Preserve the email body as is - that is,\n"
 718             "keep the citations _and_ signatures.",
 719             ["EMAIL_LEAVE_BODY_UNCHANGED"]),
 720         (Option, "default_class", "issue",
 721             "Default class to use in the mailgw\n"
 722             "if one isn't supplied in email subjects.\n"
 723             "To disable, leave the value blank.",
 724             ["MAIL_DEFAULT_CLASS"]),
 725         (NullableOption, "language", "",
 726             "Default locale name for the tracker mail gateway.\n"
 727             "If this option is not set, mail gateway will use\n"
 728             "the language of the tracker instance."),
 729         (Option, "subject_prefix_parsing", "strict",
 730             "Controls the parsing of the [prefix] on subject\n"
 731             "lines in incoming emails. \"strict\" will return an\n"
 732             "error to the sender if the [prefix] is not recognised.\n"
 733             "\"loose\" will attempt to parse the [prefix] but just\n"
 734             "pass it through as part of the issue title if not\n"
 735             "recognised. \"none\" will always pass any [prefix]\n"
 736             "through as part of the issue title."),
 737         (Option, "subject_suffix_parsing", "strict",
 738             "Controls the parsing of the [suffix] on subject\n"
 739             "lines in incoming emails. \"strict\" will return an\n"
 740             "error to the sender if the [suffix] is not recognised.\n"
 741             "\"loose\" will attempt to parse the [suffix] but just\n"
 742             "pass it through as part of the issue title if not\n"
 743             "recognised. \"none\" will always pass any [suffix]\n"
 744             "through as part of the issue title."),
 745         (Option, "subject_suffix_delimiters", "[]",
 746             "Defines the brackets used for delimiting the prefix and \n"
 747             'suffix in a subject line. The presence of "suffix" in\n'
 748             "the config option name is a historical artifact and may\n"
 749             "be ignored."),
 750         (Option, "subject_content_match", "always",
 751             "Controls matching of the incoming email subject line\n"
 752             "against issue titles in the case where there is no\n"
 753             "designator [prefix]. \"never\" turns off matching.\n"
 754             "\"creation + interval\" or \"activity + interval\"\n"
 755             "will match an issue for the interval after the issue's\n"
 756             "creation or last activity. The interval is a standard\n"
 757             "Roundup interval."),
 758         (BooleanOption, "subject_updates_title", "yes",
 759             "Update issue title if incoming subject of email is different.\n"
 760             "Setting this to \"no\" will ignore the title part of"
 761             " the subject\nof incoming email messages.\n"),
 762         (RegExpOption, "refwd_re", "(\s*\W?\s*(fw|fwd|re|aw|sv|ang)\W)+",
 763             "Regular expression matching a single reply or forward\n"
 764             "prefix prepended by the mailer. This is explicitly\n"
 765             "stripped from the subject during parsing."),
 766         (RegExpOption, "origmsg_re",
 767             "^[>|\s]*-----\s?Original Message\s?-----$",
 768             "Regular expression matching start of an original message\n"
 769             "if quoted the in body."),
 770         (RegExpOption, "sign_re", "^[>|\s]*-- ?$",
 771             "Regular expression matching the start of a signature\n"
 772             "in the message body."),
 773         (RegExpOption, "eol_re", r"[\r\n]+",
 774             "Regular expression matching end of line."),
 775         (RegExpOption, "blankline_re", r"[\r\n]+\s*[\r\n]+",
 776             "Regular expression matching a blank line."),
 777         (BooleanOption, "unpack_rfc822", "no",
 778             "Unpack attached messages (encoded as message/rfc822 in MIME)\n"
 779             "as multiple parts attached as files to the issue, if not\n"
 780             "set we handle message/rfc822 attachments as a single file."),
 781         (BooleanOption, "ignore_alternatives", "no",
 782             "When parsing incoming mails, roundup uses the first\n"
 783             "text/plain part it finds. If this part is inside a\n"
 784             "multipart/alternative, and this option is set, all other\n"
 785             "parts of the multipart/alternative are ignored. The default\n"
 786             "is to keep all parts and attach them to the issue."),
 787     ), "Roundup Mail Gateway options"),
 788     ("pgp", (
 789         (BooleanOption, "enable", "no",
 790             "Enable PGP processing. Requires pyme."),
 791         (NullableOption, "roles", "",
 792             "If specified, a comma-separated list of roles to perform\n"
 793             "PGP processing on. If not specified, it happens for all\n"
 794             "users."),
 795         (NullableOption, "homedir", "",
 796             "Location of PGP directory. Defaults to $HOME/.gnupg if\n"
 797             "not specified."),
 798     ), "OpenPGP mail processing options"),
 799     ("nosy", (
 800         (RunDetectorOption, "messages_to_author", "no",
 801             "Send nosy messages to the author of the message.",
 802             ["MESSAGES_TO_AUTHOR"]),
 803         (Option, "signature_position", "bottom",
 804             "Where to place the email signature.\n"
 805             "Allowed values: top, bottom, none",
 806             ["EMAIL_SIGNATURE_POSITION"]),
 807         (RunDetectorOption, "add_author", "new",
 808             "Does the author of a message get placed on the nosy list\n"
 809             "automatically?  If 'new' is used, then the author will\n"
 810             "only be added when a message creates a new issue.\n"
 811             "If 'yes', then the author will be added on followups too.\n"
 812             "If 'no', they're never added to the nosy.\n",
 813             ["ADD_AUTHOR_TO_NOSY"]),
 814         (RunDetectorOption, "add_recipients", "new",
 815             "Do the recipients (To:, Cc:) of a message get placed on the\n"
 816             "nosy list?  If 'new' is used, then the recipients will\n"
 817             "only be added when a message creates a new issue.\n"
 818             "If 'yes', then the recipients will be added on followups too.\n"
 819             "If 'no', they're never added to the nosy.\n",
 820             ["ADD_RECIPIENTS_TO_NOSY"]),
 821         (Option, "email_sending", "single",
 822             "Controls the email sending from the nosy reactor. If\n"
 823             "\"multiple\" then a separate email is sent to each\n"
 824             "recipient. If \"single\" then a single email is sent with\n"
 825             "each recipient as a CC address."),
 826         (IntegerNumberOption, "max_attachment_size", sys.maxint,
 827             "Attachments larger than the given number of bytes\n"
 828             "won't be attached to nosy mails. They will be replaced by\n"
 829             "a link to the tracker's download page for the file.")
 830     ), "Nosy messages sending"),
 831 )
 832
 833 ### Configuration classes
 834
 835 class Config:
 836
 837     """Base class for configuration objects.
 838
 839     Configuration options may be accessed as attributes or items
 840     of instances of this class.  All option names are uppercased.
 841
 842     """
 843
 844     # Config file name
 845     INI_FILE = "config.ini"
 846
 847     # Object attributes that should not be taken as common configuration
 848     # options in __setattr__ (most of them are initialized in constructor):
 849     # builtin pseudo-option - package home directory
 850     HOME = "."
 851     # names of .ini file sections, in order
 852     sections = None
 853     # section comments
 854     section_descriptions = None
 855     # lists of option names for each section, in order
 856     section_options = None
 857     # mapping from option names and aliases to Option instances
 858     options = None
 859     # actual name of the config file.  set on load.
 860     filepath = os.path.join(HOME, INI_FILE)
 861
 862     def __init__(self, config_path=None, layout=None, settings={}):
 863         """Initialize confing instance
 864
 865         Parameters:
 866             config_path:
 867                 optional directory or file name of the config file.
 868                 If passed, load the config after processing layout (if any).
 869                 If config_path is a directory name, use default base name
 870                 of the config file.
 871             layout:
 872                 optional configuration layout, a sequence of
 873                 section definitions suitable for .add_section()
 874             settings:
 875                 optional setting overrides (dictionary).
 876                 The overrides are applied after loading config file.
 877
 878         """
 879         # initialize option containers:
 880         self.sections = []
 881         self.section_descriptions = {}
 882         self.section_options = {}
 883         self.options = {}
 884         # add options from the layout structure
 885         if layout:
 886             for section in layout:
 887                 self.add_section(*section)
 888         if config_path is not None:
 889             self.load(config_path)
 890         for (name, value) in settings.items():
 891             self[name.upper()] = value
 892
 893     def add_section(self, section, options, description=None):
 894         """Define new config section
 895
 896         Parameters:
 897             section - name of the config.ini section
 898             options - a sequence of Option definitions.
 899                 Each Option definition is a sequence
 900                 containing class object and constructor
 901                 parameters, starting from the setting name:
 902                 setting, default, [description, [aliases]]
 903             description - optional section comment
 904
 905         Note: aliases should only exist in historical options
 906         for backwards compatibility - new options should
 907         *not* have aliases!
 908
 909         """
 910         if description or not self.section_descriptions.has_key(section):
 911             self.section_descriptions[section] = description
 912         for option_def in options:
 913             klass = option_def[0]
 914             args = option_def[1:]
 915             option = klass(self, section, *args)
 916             self.add_option(option)
 917
 918     def add_option(self, option):
 919         """Adopt a new Option object"""
 920         _section = option.section
 921         _name = option.setting
 922         if _section not in self.sections:
 923             self.sections.append(_section)
 924         _options = self._get_section_options(_section)
 925         if _name not in _options:
 926             _options.append(_name)
 927         # (section, name) key is used for writing .ini file
 928         self.options[(_section, _name)] = option
 929         # make the option known under all of its A.K.A.s
 930         for _name in option.aliases:
 931             self.options[_name] = option
 932
 933     def update_option(self, name, klass,
 934         default=NODEFAULT, description=None
 935     ):
 936         """Override behaviour of early created option.
 937
 938         Parameters:
 939             name:
 940                 option name
 941             klass:
 942                 one of the Option classes
 943             default:
 944                 optional default value for the option
 945             description:
 946                 optional new description for the option
 947
 948         Conversion from current option value to new class value
 949         is done via string representation.
 950
 951         This method may be used to attach some brains
 952         to options autocreated by UserConfig.
 953
 954         """
 955         # fetch current option
 956         option = self._get_option(name)
 957         # compute constructor parameters
 958         if default is NODEFAULT:
 959             default = option.default
 960         if description is None:
 961             description = option.description
 962         value = option.value2str(current=1)
 963         # resurrect the option
 964         option = klass(self, option.section, option.setting,
 965             default=default, description=description)
 966         # apply the value
 967         option.set(value)
 968         # incorporate new option
 969         del self[name]
 970         self.add_option(option)
 971
 972     def reset(self):
 973         """Set all options to their default values"""
 974         for _option in self.items():
 975             _option.reset()
 976
 977     # Meant for commandline tools.
 978     # Allows automatic creation of configuration files like this:
 979     #  roundup-server -p 8017 -u roundup --save-config
 980     def getopt(self, args, short_options="", long_options=(),
 981         config_load_options=("C", "config"), **options
 982     ):
 983         """Apply options specified in command line arguments.
 984
 985         Parameters:
 986             args:
 987                 command line to parse (sys.argv[1:])
 988             short_options:
 989                 optional string of letters for command line options
 990                 that are not config options
 991             long_options:
 992                 optional list of names for long options
 993                 that are not config options
 994             config_load_options:
 995                 two-element sequence (letter, long_option) defining
 996                 the options for config file.  If unset, don't load
 997                 config file; otherwise config file is read prior
 998                 to applying other options.  Short option letter
 999                 must not have a colon and long_option name must
1000                 not have an equal sign or '--' prefix.
1001             options:
1002                 mapping from option names to command line option specs.
1003                 e.g. server_port="p:", server_user="u:"
1004                 Names are forced to lower case for commandline parsing
1005                 (long options) and to upper case to find config options.
1006                 Command line options accepting no value are assumed
1007                 to be binary and receive value 'yes'.
1008
1009         Return value: same as for python standard getopt(), except that
1010         processed options are removed from returned option list.
1011
1012         """
1013         # take a copy of long_options
1014         long_options = list(long_options)
1015         # build option lists
1016         cfg_names = {}
1017         booleans = []
1018         for (name, letter) in options.items():
1019             cfg_name = name.upper()
1020             short_opt = "-" + letter[0]
1021             name = name.lower().replace("_", "-")
1022             cfg_names.update({short_opt: cfg_name, "--" + name: cfg_name})
1023
1024             short_options += letter
1025             if letter[-1] == ":":
1026                 long_options.append(name + "=")
1027             else:
1028                 booleans.append(short_opt)
1029                 long_options.append(name)
1030
1031         if config_load_options:
1032             short_options += config_load_options[0] + ":"
1033             long_options.append(config_load_options[1] + "=")
1034             # compute names that will be searched in getopt return value
1035             config_load_options = (
1036                 "-" + config_load_options[0],
1037                 "--" + config_load_options[1],
1038             )
1039         # parse command line arguments
1040         optlist, args = getopt.getopt(args, short_options, long_options)
1041         # load config file if requested
1042         if config_load_options:
1043             for option in optlist:
1044                 if option[0] in config_load_options:
1045                     self.load_ini(option[1])
1046                     optlist.remove(option)
1047                     break
1048         # apply options
1049         extra_options = []
1050         for (opt, arg) in optlist:
1051             if (opt in booleans): # and not arg
1052                 arg = "yes"
1053             try:
1054                 name = cfg_names[opt]
1055             except KeyError:
1056                 extra_options.append((opt, arg))
1057             else:
1058                 self[name] = arg
1059         return (extra_options, args)
1060
1061     # option and section locators (used in option access methods)
1062
1063     def _get_option(self, name):
1064         try:
1065             return self.options[name]
1066         except KeyError:
1067             raise InvalidOptionError(name)
1068
1069     def _get_section_options(self, name):
1070         return self.section_options.setdefault(name, [])
1071
1072     def _get_unset_options(self):
1073         """Return options that need manual adjustments
1074
1075         Return value is a dictionary where keys are section
1076         names and values are lists of option names as they
1077         appear in the config file.
1078
1079         """
1080         need_set = {}
1081         for option in self.items():
1082             if not option.isset():
1083                 need_set.setdefault(option.section, []).append(option.setting)
1084         return need_set
1085
1086     def _adjust_options(self, config):
1087         """Load ad-hoc option definitions from ConfigParser instance."""
1088         pass
1089
1090     def _get_name(self):
1091         """Return the service name for config file heading"""
1092         return ""
1093
1094     # file operations
1095
1096     def load_ini(self, config_path, defaults=None):
1097         """Set options from config.ini file in given home_dir
1098
1099         Parameters:
1100             config_path:
1101                 directory or file name of the config file.
1102                 If config_path is a directory name, use default
1103                 base name of the config file
1104             defaults:
1105                 optional dictionary of defaults for ConfigParser
1106
1107         Note: if home_dir does not contain config.ini file,
1108         no error is raised.  Config will be reset to defaults.
1109
1110         """
1111         if os.path.isdir(config_path):
1112             home_dir = config_path
1113             config_path = os.path.join(config_path, self.INI_FILE)
1114         else:
1115             home_dir = os.path.dirname(config_path)
1116         # parse the file
1117         config_defaults = {"HOME": home_dir}
1118         if defaults:
1119             config_defaults.update(defaults)
1120         config = ConfigParser.ConfigParser(config_defaults)
1121         config.read([config_path])
1122         # .ini file loaded ok.
1123         self.HOME = home_dir
1124         self.filepath = config_path
1125         self._adjust_options(config)
1126         # set the options, starting from HOME
1127         self.reset()
1128         for option in self.items():
1129             option.load_ini(config)
1130
1131     def load(self, home_dir):
1132         """Load configuration settings from home_dir"""
1133         self.load_ini(home_dir)
1134
1135     def save(self, ini_file=None):
1136         """Write current configuration to .ini file
1137
1138         'ini_file' argument, if passed, must be valid full path
1139         to the file to write.  If omitted, default file in current
1140         HOME is created.
1141
1142         If the file to write already exists, it is saved with '.bak'
1143         extension.
1144
1145         """
1146         if ini_file is None:
1147             ini_file = self.filepath
1148         _tmp_file = os.path.splitext(ini_file)[0]
1149         _bak_file = _tmp_file + ".bak"
1150         _tmp_file = _tmp_file + ".tmp"
1151         _fp = file(_tmp_file, "wt")
1152         _fp.write("# %s configuration file\n" % self._get_name())
1153         _fp.write("# Autogenerated at %s\n" % time.asctime())
1154         need_set = self._get_unset_options()
1155         if need_set:
1156             _fp.write("\n# WARNING! Following options need adjustments:\n")
1157             for section, options in need_set.items():
1158                 _fp.write("#  [%s]: %s\n" % (section, ", ".join(options)))
1159         for section in self.sections:
1160             comment = self.section_descriptions.get(section, None)
1161             if comment:
1162                 _fp.write("\n# ".join([""] + comment.split("\n")) +"\n")
1163             else:
1164                 # no section comment - just leave a blank line between sections
1165                 _fp.write("\n")
1166             _fp.write("[%s]\n" % section)
1167             for option in self._get_section_options(section):
1168                 _fp.write("\n" + self.options[(section, option)].format())
1169         _fp.close()
1170         if os.access(ini_file, os.F_OK):
1171             if os.access(_bak_file, os.F_OK):
1172                 os.remove(_bak_file)
1173             os.rename(ini_file, _bak_file)
1174         os.rename(_tmp_file, ini_file)
1175
1176     # container emulation
1177
1178     def __len__(self):
1179         return len(self.items())
1180
1181     def __getitem__(self, name):
1182         if name == "HOME":
1183             return self.HOME
1184         else:
1185             return self._get_option(name).get()
1186
1187     def __setitem__(self, name, value):
1188         if name == "HOME":
1189             self.HOME = value
1190         else:
1191             self._get_option(name).set(value)
1192
1193     def __delitem__(self, name):
1194         _option = self._get_option(name)
1195         _section = _option.section
1196         _name = _option.setting
1197         self._get_section_options(_section).remove(_name)
1198         del self.options[(_section, _name)]
1199         for _alias in _option.aliases:
1200             del self.options[_alias]
1201
1202     def items(self):
1203         """Return the list of Option objects, in .ini file order
1204
1205         Note that HOME is not included in this list
1206         because it is builtin pseudo-option, not a real Option
1207         object loaded from or saved to .ini file.
1208
1209         """
1210         return [self.options[(_section, _name)]
1211             for _section in self.sections
1212             for _name in self._get_section_options(_section)
1213         ]
1214
1215     def keys(self):
1216         """Return the list of "canonical" names of the options
1217
1218         Unlike .items(), this list also includes HOME
1219
1220         """
1221         return ["HOME"] + [_option.name for _option in self.items()]
1222
1223     # .values() is not implemented because i am not sure what should be
1224     # the values returned from this method: Option instances or config values?
1225
1226     # attribute emulation
1227
1228     def __setattr__(self, name, value):
1229         if self.__dict__.has_key(name) or hasattr(self.__class__, name):
1230             self.__dict__[name] = value
1231         else:
1232             self._get_option(name).set(value)
1233
1234     # Note: __getattr__ is not symmetric to __setattr__:
1235     #   self.__dict__ lookup is done before calling this method
1236     def __getattr__(self, name):
1237         return self[name]
1238
1239 class UserConfig(Config):
1240
1241     """Configuration for user extensions.
1242
1243     Instances of this class have no predefined configuration layout.
1244     Options are created on the fly for each setting present in the
1245     config file.
1246
1247     """
1248
1249     def _adjust_options(self, config):
1250         # config defaults appear in all sections.
1251         # we'll need to filter them out.
1252         defaults = config.defaults().keys()
1253         # see what options are already defined and add missing ones
1254         preset = [(option.section, option.setting) for option in self.items()]
1255         for section in config.sections():
1256             for name in config.options(section):
1257                 if ((section, name) not in preset) \
1258                 and (name not in defaults):
1259                     self.add_option(Option(self, section, name))
1260
1261 class CoreConfig(Config):
1262
1263     """Roundup instance configuration.
1264
1265     Core config has a predefined layout (see the SETTINGS structure),
1266     supports loading of old-style pythonic configurations and holds
1267     three additional attributes:
1268         logging:
1269             instance logging engine, from standard python logging module
1270             or minimalistic logger implemented in Roundup
1271         detectors:
1272             user-defined configuration for detectors
1273         ext:
1274             user-defined configuration for extensions
1275
1276     """
1277
1278     # module name for old style configuration
1279     PYCONFIG = "config"
1280     # user configs
1281     ext = None
1282     detectors = None
1283
1284     def __init__(self, home_dir=None, settings={}):
1285         Config.__init__(self, home_dir, layout=SETTINGS, settings=settings)
1286         # load the config if home_dir given
1287         if home_dir is None:
1288             self.init_logging()
1289
1290     def copy(self):
1291         new = CoreConfig()
1292         new.sections = list(self.sections)
1293         new.section_descriptions = dict(self.section_descriptions)
1294         new.section_options = dict(self.section_options)
1295         new.options = dict(self.options)
1296         return new
1297
1298     def _get_unset_options(self):
1299         need_set = Config._get_unset_options(self)
1300         # remove MAIL_PASSWORD if MAIL_USER is empty
1301         if "password" in need_set.get("mail", []):
1302             if not self["MAIL_USERNAME"]:
1303                 settings = need_set["mail"]
1304                 settings.remove("password")
1305                 if not settings:
1306                     del need_set["mail"]
1307         return need_set
1308
1309     def _get_name(self):
1310         return self["TRACKER_NAME"]
1311
1312     def reset(self):
1313         Config.reset(self)
1314         if self.ext:
1315             self.ext.reset()
1316         if self.detectors:
1317             self.detectors.reset()
1318         self.init_logging()
1319
1320     def init_logging(self):
1321         _file = self["LOGGING_CONFIG"]
1322         if _file and os.path.isfile(_file):
1323             logging.config.fileConfig(_file)
1324             return
1325
1326         _file = self["LOGGING_FILENAME"]
1327         # set file & level on the roundup logger
1328         logger = logging.getLogger('roundup')
1329         if _file:
1330             hdlr = logging.FileHandler(_file)
1331         else:
1332             hdlr = logging.StreamHandler(sys.stdout)
1333         formatter = logging.Formatter(
1334             '%(asctime)s %(levelname)s %(message)s')
1335         hdlr.setFormatter(formatter)
1336         # no logging API to remove all existing handlers!?!
1337         for h in logger.handlers:
1338             h.close()
1339             logger.removeHandler(hdlr)
1340         logger.handlers = [hdlr]
1341         logger.setLevel(logging._levelNames[self["LOGGING_LEVEL"] or "ERROR"])
1342
1343     def load(self, home_dir):
1344         """Load configuration from path designated by home_dir argument"""
1345         if os.path.isfile(os.path.join(home_dir, self.INI_FILE)):
1346             self.load_ini(home_dir)
1347         else:
1348             self.load_pyconfig(home_dir)
1349         self.init_logging()
1350         self.ext = UserConfig(os.path.join(home_dir, "extensions"))
1351         self.detectors = UserConfig(os.path.join(home_dir, "detectors"))
1352
1353     def load_ini(self, home_dir, defaults=None):
1354         """Set options from config.ini file in given home_dir directory"""
1355         config_defaults = {"TRACKER_HOME": home_dir}
1356         if defaults:
1357             config_defaults.update(defaults)
1358         Config.load_ini(self, home_dir, config_defaults)
1359
1360     def load_pyconfig(self, home_dir):
1361         """Set options from config.py file in given home_dir directory"""
1362         # try to locate and import the module
1363         _mod_fp = None
1364         try:
1365             try:
1366                 _module = imp.find_module(self.PYCONFIG, [home_dir])
1367                 _mod_fp = _module[0]
1368                 _config = imp.load_module(self.PYCONFIG, *_module)
1369             except ImportError:
1370                 raise NoConfigError(home_dir)
1371         finally:
1372             if _mod_fp is not None:
1373                 _mod_fp.close()
1374         # module loaded ok.  set the options, starting from HOME
1375         self.reset()
1376         self.HOME = home_dir
1377         for _option in self.items():
1378             _option.load_pyconfig(_config)
1379         # backward compatibility:
1380         # SMTP login parameters were specified as a tuple in old style configs
1381         # convert them to new plain string options
1382         _mailuser = getattr(_config, "MAILUSER", ())
1383         if len(_mailuser) > 0:
1384             self.MAIL_USERNAME = _mailuser[0]
1385         if len(_mailuser) > 1:
1386             self.MAIL_PASSWORD = _mailuser[1]
1387
1388     # in this config, HOME is also known as TRACKER_HOME
1389     def __getitem__(self, name):
1390         if name == "TRACKER_HOME":
1391             return self.HOME
1392         else:
1393             return Config.__getitem__(self, name)
1394
1395     def __setitem__(self, name, value):
1396         if name == "TRACKER_HOME":
1397             self.HOME = value
1398         else:
1399             self._get_option(name).set(value)
1400
1401     def __setattr__(self, name, value):
1402         if name == "TRACKER_HOME":
1403             self.__dict__["HOME"] = value
1404         else:
1405             Config.__setattr__(self, name, value)
1406
1407 # vim: set et sts=4 sw=4 :