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 it's 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     )),
 534     ("tracker", (
 535         (Option, "name", "Roundup issue tracker",
 536             "A descriptive name for your roundup instance."),
 537         (Option, "web", NODEFAULT,
 538             "The web address that the tracker is viewable at.\n"
 539             "This will be included in information"
 540             " sent to users of the tracker.\n"
 541             "The URL MUST include the cgi-bin part or anything else\n"
 542             "that is required to get to the home page of the tracker.\n"
 543             "You MUST include a trailing '/' in the URL."),
 544         (MailAddressOption, "email", "issue_tracker",
 545             "Email address that mail to roundup should go to.\n"
 546             "If no domain is specified then mail_domain is added."),
 547         (NullableOption, "language", "",
 548             "Default locale name for this tracker.\n"
 549             "If this option is not set, the language is determined\n"
 550             "by OS environment variable LANGUAGE, LC_ALL, LC_MESSAGES,\n"
 551             "or LANG, in that order of preference."),
 552     )),
 553     ("web", (
 554         (BooleanOption, 'http_auth', "yes",
 555             "Whether to use HTTP Basic Authentication, if present.\n"
 556             "Roundup will use either the REMOTE_USER or HTTP_AUTHORIZATION\n"
 557             "variables supplied by your web server (in that order).\n"
 558             "Set this option to 'no' if you do not wish to use HTTP Basic\n"
 559             "Authentication in your web interface."),
 560         (BooleanOption, 'use_browser_language', "yes",
 561             "Whether to use HTTP Accept-Language, if present.\n"
 562             "Browsers send a language-region preference list.\n"
 563             "It's usually set in the client's browser or in their\n"
 564             "Operating System.\n"
 565             "Set this option to 'no' if you want to ignore it."),
 566         (BooleanOption, "debug", "no",
 567             "Setting this option makes Roundup display error tracebacks\n"
 568             "in the user's browser rather than emailing them to the\n"
 569             "tracker admin."),
 570     )),
 571     ("rdbms", (
 572         (Option, 'name', 'roundup',
 573             "Name of the database to use.",
 574             ['MYSQL_DBNAME']),
 575         (NullableOption, 'host', 'localhost',
 576             "Database server host.",
 577             ['MYSQL_DBHOST']),
 578         (NullableOption, 'port', '',
 579             "TCP port number of the database server.\n"
 580             "Postgresql usually resides on port 5432 (if any),\n"
 581             "for MySQL default port number is 3306.\n"
 582             "Leave this option empty to use backend default"),
 583         (NullableOption, 'user', 'roundup',
 584             "Database user name that Roundup should use.",
 585             ['MYSQL_DBUSER']),
 586         (NullableOption, 'password', 'roundup',
 587             "Database user password.",
 588             ['MYSQL_DBPASSWORD']),
 589         (NullableOption, 'read_default_file', '~/.my.cnf',
 590             "Name of the MySQL defaults file.\n"
 591             "Only used in MySQL connections."),
 592         (NullableOption, 'read_default_group', 'roundup',
 593             "Name of the group to use in the MySQL defaults file (.my.cnf).\n"
 594             "Only used in MySQL connections."),
 595     ), "Settings in this section are used"
 596         " by Postgresql and MySQL backends only"
 597     ),
 598     ("logging", (
 599         (FilePathOption, "config", "",
 600             "Path to configuration file for standard Python logging module.\n"
 601             "If this option is set, logging configuration is loaded\n"
 602             "from specified file; options 'filename' and 'level'\n"
 603             "in this section are ignored."),
 604         (FilePathOption, "filename", "",
 605             "Log file name for minimal logging facility built into Roundup.\n"
 606             "If no file name specified, log messages are written on stderr.\n"
 607             "If above 'config' option is set, this option has no effect."),
 608         (Option, "level", "ERROR",
 609             "Minimal severity level of messages written to log file.\n"
 610             "If above 'config' option is set, this option has no effect.\n"
 611             "Allowed values: DEBUG, INFO, WARNING, ERROR"),
 612     )),
 613     ("mail", (
 614         (Option, "domain", NODEFAULT,
 615             "The email domain that admin_email, issue_tracker and\n"
 616             "dispatcher_email belong to.\n"
 617             "This domain is added to those config items if they don't\n"
 618             "explicitly include a domain.\n"
 619             "Do not include the '@' symbol."),
 620         (Option, "host", NODEFAULT,
 621             "SMTP mail host that roundup will use to send mail",
 622             ["MAILHOST"],),
 623         (Option, "username", "", "SMTP login name.\n"
 624             "Set this if your mail host requires authenticated access.\n"
 625             "If username is not empty, password (below) MUST be set!"),
 626         (Option, "password", NODEFAULT, "SMTP login password.\n"
 627             "Set this if your mail host requires authenticated access."),
 628         (IntegerNumberOption, "port", smtplib.SMTP_PORT,
 629             "Default port to send SMTP on.\n"
 630             "Set this if your mail server runs on a different port."),
 631         (NullableOption, "local_hostname", '',
 632             "The local hostname to use during SMTP transmission.\n"
 633             "Set this if your mail server requires something specific."),
 634         (BooleanOption, "tls", "no",
 635             "If your SMTP mail host provides or requires TLS\n"
 636             "(Transport Layer Security) then set this option to 'yes'."),
 637         (NullableFilePathOption, "tls_keyfile", "",
 638             "If TLS is used, you may set this option to the name\n"
 639             "of a PEM formatted file that contains your private key."),
 640         (NullableFilePathOption, "tls_certfile", "",
 641             "If TLS is used, you may set this option to the name\n"
 642             "of a PEM formatted certificate chain file."),
 643         (Option, "charset", "utf-8",
 644             "Character set to encode email headers with.\n"
 645             "We use utf-8 by default, as it's the most flexible.\n"
 646             "Some mail readers (eg. Eudora) can't cope with that,\n"
 647             "so you might need to specify a more limited character set\n"
 648             "(eg. iso-8859-1).",
 649             ["EMAIL_CHARSET"]),
 650         (FilePathOption, "debug", "",
 651             "Setting this option makes Roundup to write all outgoing email\n"
 652             "messages to this file *instead* of sending them.\n"
 653             "This option has the same effect as environment variable"
 654             " SENDMAILDEBUG.\nEnvironment variable takes precedence."),
 655         (BooleanOption, "add_authorinfo", "yes",
 656             "Add a line with author information at top of all messages\n"
 657             "sent by roundup"),
 658         (BooleanOption, "add_authoremail", "yes",
 659             "Add the mail address of the author to the author information at\n"
 660             "the top of all messages.\n"
 661             "If this is false but add_authorinfo is true, only the name\n"
 662             "of the actor is added which protects the mail address of the\n"
 663             "actor from being exposed at mail archives, etc."),
 664     ), "Outgoing email options.\nUsed for nozy messages and approval requests"),
 665     ("mailgw", (
 666         (BooleanOption, "keep_quoted_text", "yes",
 667             "Keep email citations when accepting messages.\n"
 668             "Setting this to \"no\" strips out \"quoted\" text"
 669             " from the message.\n"
 670             "Signatures are also stripped.",
 671             ["EMAIL_KEEP_QUOTED_TEXT"]),
 672         (BooleanOption, "leave_body_unchanged", "no",
 673             "Preserve the email body as is - that is,\n"
 674             "keep the citations _and_ signatures.",
 675             ["EMAIL_LEAVE_BODY_UNCHANGED"]),
 676         (Option, "default_class", "issue",
 677             "Default class to use in the mailgw\n"
 678             "if one isn't supplied in email subjects.\n"
 679             "To disable, leave the value blank.",
 680             ["MAIL_DEFAULT_CLASS"]),
 681         (NullableOption, "language", "",
 682             "Default locale name for the tracker mail gateway.\n"
 683             "If this option is not set, mail gateway will use\n"
 684             "the language of the tracker instance."),
 685         (Option, "subject_prefix_parsing", "strict",
 686             "Controls the parsing of the [prefix] on subject\n"
 687             "lines in incoming emails. \"strict\" will return an\n"
 688             "error to the sender if the [prefix] is not recognised.\n"
 689             "\"loose\" will attempt to parse the [prefix] but just\n"
 690             "pass it through as part of the issue title if not\n"
 691             "recognised. \"none\" will always pass any [prefix]\n"
 692             "through as part of the issue title."),
 693         (Option, "subject_suffix_parsing", "strict",
 694             "Controls the parsing of the [suffix] on subject\n"
 695             "lines in incoming emails. \"strict\" will return an\n"
 696             "error to the sender if the [suffix] is not recognised.\n"
 697             "\"loose\" will attempt to parse the [suffix] but just\n"
 698             "pass it through as part of the issue title if not\n"
 699             "recognised. \"none\" will always pass any [suffix]\n"
 700             "through as part of the issue title."),
 701         (Option, "subject_suffix_delimiters", "[]",
 702             "Defines the brackets used for delimiting the prefix and \n"
 703             'suffix in a subject line. The presence of "suffix" in\n'
 704             "the config option name is a historical artifact and may\n"
 705             "be ignored."),
 706         (Option, "subject_content_match", "always",
 707             "Controls matching of the incoming email subject line\n"
 708             "against issue titles in the case where there is no\n"
 709             "designator [prefix]. \"never\" turns off matching.\n"
 710             "\"creation + interval\" or \"activity + interval\"\n"
 711             "will match an issue for the interval after the issue's\n"
 712             "creation or last activity. The interval is a standard\n"
 713             "Roundup interval."),
 714         (RegExpOption, "refwd_re", "(\s*\W?\s*(fw|fwd|re|aw|sv|ang)\W)+",
 715             "Regular expression matching a single reply or forward\n"
 716             "prefix prepended by the mailer. This is explicitly\n"
 717             "stripped from the subject during parsing."),
 718         (RegExpOption, "origmsg_re",
 719             "^[>|\s]*-----\s?Original Message\s?-----$",
 720             "Regular expression matching start of an original message\n"
 721             "if quoted the in body."),
 722         (RegExpOption, "sign_re", "^[>|\s]*-- ?$",
 723             "Regular expression matching the start of a signature\n"
 724             "in the message body."),
 725         (RegExpOption, "eol_re", r"[\r\n]+",
 726             "Regular expression matching end of line."),
 727         (RegExpOption, "blankline_re", r"[\r\n]+\s*[\r\n]+",
 728             "Regular expression matching a blank line."),
 729         (BooleanOption, "ignore_alternatives", "no",
 730             "When parsing incoming mails, roundup uses the first\n"
 731             "text/plain part it finds. If this part is inside a\n"
 732             "multipart/alternative, and this option is set, all other\n"
 733             "parts of the multipart/alternative are ignored. The default\n"
 734             "is to keep all parts and attach them to the issue."),
 735     ), "Roundup Mail Gateway options"),
 736     ("pgp", (
 737         (BooleanOption, "enable", "no",
 738             "Enable PGP processing. Requires pyme."),
 739         (NullableOption, "roles", "",
 740             "If specified, a comma-separated list of roles to perform\n"
 741             "PGP processing on. If not specified, it happens for all\n"
 742             "users."),
 743         (NullableOption, "homedir", "",
 744             "Location of PGP directory. Defaults to $HOME/.gnupg if\n"
 745             "not specified."),
 746     ), "OpenPGP mail processing options"),
 747     ("nosy", (
 748         (RunDetectorOption, "messages_to_author", "no",
 749             "Send nosy messages to the author of the message.",
 750             ["MESSAGES_TO_AUTHOR"]),
 751         (Option, "signature_position", "bottom",
 752             "Where to place the email signature.\n"
 753             "Allowed values: top, bottom, none",
 754             ["EMAIL_SIGNATURE_POSITION"]),
 755         (RunDetectorOption, "add_author", "new",
 756             "Does the author of a message get placed on the nosy list\n"
 757             "automatically?  If 'new' is used, then the author will\n"
 758             "only be added when a message creates a new issue.\n"
 759             "If 'yes', then the author will be added on followups too.\n"
 760             "If 'no', they're never added to the nosy.\n",
 761             ["ADD_AUTHOR_TO_NOSY"]),
 762         (RunDetectorOption, "add_recipients", "new",
 763             "Do the recipients (To:, Cc:) of a message get placed on the\n"
 764             "nosy list?  If 'new' is used, then the recipients will\n"
 765             "only be added when a message creates a new issue.\n"
 766             "If 'yes', then the recipients will be added on followups too.\n"
 767             "If 'no', they're never added to the nosy.\n",
 768             ["ADD_RECIPIENTS_TO_NOSY"]),
 769         (Option, "email_sending", "single",
 770             "Controls the email sending from the nosy reactor. If\n"
 771             "\"multiple\" then a separate email is sent to each\n"
 772             "recipient. If \"single\" then a single email is sent with\n"
 773             "each recipient as a CC address."),
 774         (IntegerNumberOption, "max_attachment_size", sys.maxint,
 775             "Attachments larger than the given number of bytes\n"
 776             "won't be attached to nosy mails. They will be replaced by\n"
 777             "a link to the tracker's download page for the file.")
 778     ), "Nosy messages sending"),
 779 )
 780
 781 ### Configuration classes
 782
 783 class Config:
 784
 785     """Base class for configuration objects.
 786
 787     Configuration options may be accessed as attributes or items
 788     of instances of this class.  All option names are uppercased.
 789
 790     """
 791
 792     # Config file name
 793     INI_FILE = "config.ini"
 794
 795     # Object attributes that should not be taken as common configuration
 796     # options in __setattr__ (most of them are initialized in constructor):
 797     # builtin pseudo-option - package home directory
 798     HOME = "."
 799     # names of .ini file sections, in order
 800     sections = None
 801     # section comments
 802     section_descriptions = None
 803     # lists of option names for each section, in order
 804     section_options = None
 805     # mapping from option names and aliases to Option instances
 806     options = None
 807     # actual name of the config file.  set on load.
 808     filepath = os.path.join(HOME, INI_FILE)
 809
 810     def __init__(self, config_path=None, layout=None, settings={}):
 811         """Initialize confing instance
 812
 813         Parameters:
 814             config_path:
 815                 optional directory or file name of the config file.
 816                 If passed, load the config after processing layout (if any).
 817                 If config_path is a directory name, use default base name
 818                 of the config file.
 819             layout:
 820                 optional configuration layout, a sequence of
 821                 section definitions suitable for .add_section()
 822             settings:
 823                 optional setting overrides (dictionary).
 824                 The overrides are applied after loading config file.
 825
 826         """
 827         # initialize option containers:
 828         self.sections = []
 829         self.section_descriptions = {}
 830         self.section_options = {}
 831         self.options = {}
 832         # add options from the layout structure
 833         if layout:
 834             for section in layout:
 835                 self.add_section(*section)
 836         if config_path is not None:
 837             self.load(config_path)
 838         for (name, value) in settings.items():
 839             self[name.upper()] = value
 840
 841     def add_section(self, section, options, description=None):
 842         """Define new config section
 843
 844         Parameters:
 845             section - name of the config.ini section
 846             options - a sequence of Option definitions.
 847                 Each Option definition is a sequence
 848                 containing class object and constructor
 849                 parameters, starting from the setting name:
 850                 setting, default, [description, [aliases]]
 851             description - optional section comment
 852
 853         Note: aliases should only exist in historical options
 854         for backwards compatibility - new options should
 855         *not* have aliases!
 856
 857         """
 858         if description or not self.section_descriptions.has_key(section):
 859             self.section_descriptions[section] = description
 860         for option_def in options:
 861             klass = option_def[0]
 862             args = option_def[1:]
 863             option = klass(self, section, *args)
 864             self.add_option(option)
 865
 866     def add_option(self, option):
 867         """Adopt a new Option object"""
 868         _section = option.section
 869         _name = option.setting
 870         if _section not in self.sections:
 871             self.sections.append(_section)
 872         _options = self._get_section_options(_section)
 873         if _name not in _options:
 874             _options.append(_name)
 875         # (section, name) key is used for writing .ini file
 876         self.options[(_section, _name)] = option
 877         # make the option known under all of it's A.K.A.s
 878         for _name in option.aliases:
 879             self.options[_name] = option
 880
 881     def update_option(self, name, klass,
 882         default=NODEFAULT, description=None
 883     ):
 884         """Override behaviour of early created option.
 885
 886         Parameters:
 887             name:
 888                 option name
 889             klass:
 890                 one of the Option classes
 891             default:
 892                 optional default value for the option
 893             description:
 894                 optional new description for the option
 895
 896         Conversion from current option value to new class value
 897         is done via string representation.
 898
 899         This method may be used to attach some brains
 900         to options autocreated by UserConfig.
 901
 902         """
 903         # fetch current option
 904         option = self._get_option(name)
 905         # compute constructor parameters
 906         if default is NODEFAULT:
 907             default = option.default
 908         if description is None:
 909             description = option.description
 910         value = option.value2str(current=1)
 911         # resurrect the option
 912         option = klass(self, option.section, option.setting,
 913             default=default, description=description)
 914         # apply the value
 915         option.set(value)
 916         # incorporate new option
 917         del self[name]
 918         self.add_option(option)
 919
 920     def reset(self):
 921         """Set all options to their default values"""
 922         for _option in self.items():
 923             _option.reset()
 924
 925     # Meant for commandline tools.
 926     # Allows automatic creation of configuration files like this:
 927     #  roundup-server -p 8017 -u roundup --save-config
 928     def getopt(self, args, short_options="", long_options=(),
 929         config_load_options=("C", "config"), **options
 930     ):
 931         """Apply options specified in command line arguments.
 932
 933         Parameters:
 934             args:
 935                 command line to parse (sys.argv[1:])
 936             short_options:
 937                 optional string of letters for command line options
 938                 that are not config options
 939             long_options:
 940                 optional list of names for long options
 941                 that are not config options
 942             config_load_options:
 943                 two-element sequence (letter, long_option) defining
 944                 the options for config file.  If unset, don't load
 945                 config file; otherwise config file is read prior
 946                 to applying other options.  Short option letter
 947                 must not have a colon and long_option name must
 948                 not have an equal sign or '--' prefix.
 949             options:
 950                 mapping from option names to command line option specs.
 951                 e.g. server_port="p:", server_user="u:"
 952                 Names are forced to lower case for commandline parsing
 953                 (long options) and to upper case to find config options.
 954                 Command line options accepting no value are assumed
 955                 to be binary and receive value 'yes'.
 956
 957         Return value: same as for python standard getopt(), except that
 958         processed options are removed from returned option list.
 959
 960         """
 961         # take a copy of long_options
 962         long_options = list(long_options)
 963         # build option lists
 964         cfg_names = {}
 965         booleans = []
 966         for (name, letter) in options.items():
 967             cfg_name = name.upper()
 968             short_opt = "-" + letter[0]
 969             name = name.lower().replace("_", "-")
 970             cfg_names.update({short_opt: cfg_name, "--" + name: cfg_name})
 971
 972             short_options += letter
 973             if letter[-1] == ":":
 974                 long_options.append(name + "=")
 975             else:
 976                 booleans.append(short_opt)
 977                 long_options.append(name)
 978
 979         if config_load_options:
 980             short_options += config_load_options[0] + ":"
 981             long_options.append(config_load_options[1] + "=")
 982             # compute names that will be searched in getopt return value
 983             config_load_options = (
 984                 "-" + config_load_options[0],
 985                 "--" + config_load_options[1],
 986             )
 987         # parse command line arguments
 988         optlist, args = getopt.getopt(args, short_options, long_options)
 989         # load config file if requested
 990         if config_load_options:
 991             for option in optlist:
 992                 if option[0] in config_load_options:
 993                     self.load_ini(option[1])
 994                     optlist.remove(option)
 995                     break
 996         # apply options
 997         extra_options = []
 998         for (opt, arg) in optlist:
 999             if (opt in booleans): # and not arg
1000                 arg = "yes"
1001             try:
1002                 name = cfg_names[opt]
1003             except KeyError:
1004                 extra_options.append((opt, arg))
1005             else:
1006                 self[name] = arg
1007         return (extra_options, args)
1008
1009     # option and section locators (used in option access methods)
1010
1011     def _get_option(self, name):
1012         try:
1013             return self.options[name]
1014         except KeyError:
1015             raise InvalidOptionError(name)
1016
1017     def _get_section_options(self, name):
1018         return self.section_options.setdefault(name, [])
1019
1020     def _get_unset_options(self):
1021         """Return options that need manual adjustments
1022
1023         Return value is a dictionary where keys are section
1024         names and values are lists of option names as they
1025         appear in the config file.
1026
1027         """
1028         need_set = {}
1029         for option in self.items():
1030             if not option.isset():
1031                 need_set.setdefault(option.section, []).append(option.setting)
1032         return need_set
1033
1034     def _adjust_options(self, config):
1035         """Load ad-hoc option definitions from ConfigParser instance."""
1036         pass
1037
1038     def _get_name(self):
1039         """Return the service name for config file heading"""
1040         return ""
1041
1042     # file operations
1043
1044     def load_ini(self, config_path, defaults=None):
1045         """Set options from config.ini file in given home_dir
1046
1047         Parameters:
1048             config_path:
1049                 directory or file name of the config file.
1050                 If config_path is a directory name, use default
1051                 base name of the config file
1052             defaults:
1053                 optional dictionary of defaults for ConfigParser
1054
1055         Note: if home_dir does not contain config.ini file,
1056         no error is raised.  Config will be reset to defaults.
1057
1058         """
1059         if os.path.isdir(config_path):
1060             home_dir = config_path
1061             config_path = os.path.join(config_path, self.INI_FILE)
1062         else:
1063             home_dir = os.path.dirname(config_path)
1064         # parse the file
1065         config_defaults = {"HOME": home_dir}
1066         if defaults:
1067             config_defaults.update(defaults)
1068         config = ConfigParser.ConfigParser(config_defaults)
1069         config.read([config_path])
1070         # .ini file loaded ok.
1071         self.HOME = home_dir
1072         self.filepath = config_path
1073         self._adjust_options(config)
1074         # set the options, starting from HOME
1075         self.reset()
1076         for option in self.items():
1077             option.load_ini(config)
1078
1079     def load(self, home_dir):
1080         """Load configuration settings from home_dir"""
1081         self.load_ini(home_dir)
1082
1083     def save(self, ini_file=None):
1084         """Write current configuration to .ini file
1085
1086         'ini_file' argument, if passed, must be valid full path
1087         to the file to write.  If omitted, default file in current
1088         HOME is created.
1089
1090         If the file to write already exists, it is saved with '.bak'
1091         extension.
1092
1093         """
1094         if ini_file is None:
1095             ini_file = self.filepath
1096         _tmp_file = os.path.splitext(ini_file)[0]
1097         _bak_file = _tmp_file + ".bak"
1098         _tmp_file = _tmp_file + ".tmp"
1099         _fp = file(_tmp_file, "wt")
1100         _fp.write("# %s configuration file\n" % self._get_name())
1101         _fp.write("# Autogenerated at %s\n" % time.asctime())
1102         need_set = self._get_unset_options()
1103         if need_set:
1104             _fp.write("\n# WARNING! Following options need adjustments:\n")
1105             for section, options in need_set.items():
1106                 _fp.write("#  [%s]: %s\n" % (section, ", ".join(options)))
1107         for section in self.sections:
1108             comment = self.section_descriptions.get(section, None)
1109             if comment:
1110                 _fp.write("\n# ".join([""] + comment.split("\n")) +"\n")
1111             else:
1112                 # no section comment - just leave a blank line between sections
1113                 _fp.write("\n")
1114             _fp.write("[%s]\n" % section)
1115             for option in self._get_section_options(section):
1116                 _fp.write("\n" + self.options[(section, option)].format())
1117         _fp.close()
1118         if os.access(ini_file, os.F_OK):
1119             if os.access(_bak_file, os.F_OK):
1120                 os.remove(_bak_file)
1121             os.rename(ini_file, _bak_file)
1122         os.rename(_tmp_file, ini_file)
1123
1124     # container emulation
1125
1126     def __len__(self):
1127         return len(self.items())
1128
1129     def __getitem__(self, name):
1130         if name == "HOME":
1131             return self.HOME
1132         else:
1133             return self._get_option(name).get()
1134
1135     def __setitem__(self, name, value):
1136         if name == "HOME":
1137             self.HOME = value
1138         else:
1139             self._get_option(name).set(value)
1140
1141     def __delitem__(self, name):
1142         _option = self._get_option(name)
1143         _section = _option.section
1144         _name = _option.setting
1145         self._get_section_options(_section).remove(_name)
1146         del self.options[(_section, _name)]
1147         for _alias in _option.aliases:
1148             del self.options[_alias]
1149
1150     def items(self):
1151         """Return the list of Option objects, in .ini file order
1152
1153         Note that HOME is not included in this list
1154         because it is builtin pseudo-option, not a real Option
1155         object loaded from or saved to .ini file.
1156
1157         """
1158         return [self.options[(_section, _name)]
1159             for _section in self.sections
1160             for _name in self._get_section_options(_section)
1161         ]
1162
1163     def keys(self):
1164         """Return the list of "canonical" names of the options
1165
1166         Unlike .items(), this list also includes HOME
1167
1168         """
1169         return ["HOME"] + [_option.name for _option in self.items()]
1170
1171     # .values() is not implemented because i am not sure what should be
1172     # the values returned from this method: Option instances or config values?
1173
1174     # attribute emulation
1175
1176     def __setattr__(self, name, value):
1177         if self.__dict__.has_key(name) or hasattr(self.__class__, name):
1178             self.__dict__[name] = value
1179         else:
1180             self._get_option(name).set(value)
1181
1182     # Note: __getattr__ is not symmetric to __setattr__:
1183     #   self.__dict__ lookup is done before calling this method
1184     def __getattr__(self, name):
1185         return self[name]
1186
1187 class UserConfig(Config):
1188
1189     """Configuration for user extensions.
1190
1191     Instances of this class have no predefined configuration layout.
1192     Options are created on the fly for each setting present in the
1193     config file.
1194
1195     """
1196
1197     def _adjust_options(self, config):
1198         # config defaults appear in all sections.
1199         # we'll need to filter them out.
1200         defaults = config.defaults().keys()
1201         # see what options are already defined and add missing ones
1202         preset = [(option.section, option.setting) for option in self.items()]
1203         for section in config.sections():
1204             for name in config.options(section):
1205                 if ((section, name) not in preset) \
1206                 and (name not in defaults):
1207                     self.add_option(Option(self, section, name))
1208
1209 class CoreConfig(Config):
1210
1211     """Roundup instance configuration.
1212
1213     Core config has a predefined layout (see the SETTINGS structure),
1214     supports loading of old-style pythonic configurations and holds
1215     three additional attributes:
1216         logging:
1217             instance logging engine, from standard python logging module
1218             or minimalistic logger implemented in Roundup
1219         detectors:
1220             user-defined configuration for detectors
1221         ext:
1222             user-defined configuration for extensions
1223
1224     """
1225
1226     # module name for old style configuration
1227     PYCONFIG = "config"
1228     # user configs
1229     ext = None
1230     detectors = None
1231
1232     def __init__(self, home_dir=None, settings={}):
1233         Config.__init__(self, home_dir, layout=SETTINGS, settings=settings)
1234         # load the config if home_dir given
1235         if home_dir is None:
1236             self.init_logging()
1237
1238     def _get_unset_options(self):
1239         need_set = Config._get_unset_options(self)
1240         # remove MAIL_PASSWORD if MAIL_USER is empty
1241         if "password" in need_set.get("mail", []):
1242             if not self["MAIL_USERNAME"]:
1243                 settings = need_set["mail"]
1244                 settings.remove("password")
1245                 if not settings:
1246                     del need_set["mail"]
1247         return need_set
1248
1249     def _get_name(self):
1250         return self["TRACKER_NAME"]
1251
1252     def reset(self):
1253         Config.reset(self)
1254         if self.ext:
1255             self.ext.reset()
1256         if self.detectors:
1257             self.detectors.reset()
1258         self.init_logging()
1259
1260     def init_logging(self):
1261         _file = self["LOGGING_CONFIG"]
1262         if _file and os.path.isfile(_file):
1263             logging.config.fileConfig(_file)
1264             return
1265
1266         _file = self["LOGGING_FILENAME"]
1267         # set file & level on the root logger
1268         logger = logging.getLogger()
1269         if _file:
1270             hdlr = logging.FileHandler(_file)
1271         else:
1272             hdlr = logging.StreamHandler(sys.stdout)
1273         formatter = logging.Formatter(
1274             '%(asctime)s %(levelname)s %(message)s')
1275         hdlr.setFormatter(formatter)
1276         # no logging API to remove all existing handlers!?!
1277         logger.handlers = [hdlr]
1278         logger.setLevel(logging._levelNames[self["LOGGING_LEVEL"] or "ERROR"])
1279
1280     def load(self, home_dir):
1281         """Load configuration from path designated by home_dir argument"""
1282         if os.path.isfile(os.path.join(home_dir, self.INI_FILE)):
1283             self.load_ini(home_dir)
1284         else:
1285             self.load_pyconfig(home_dir)
1286         self.init_logging()
1287         self.ext = UserConfig(os.path.join(home_dir, "extensions"))
1288         self.detectors = UserConfig(os.path.join(home_dir, "detectors"))
1289
1290     def load_ini(self, home_dir, defaults=None):
1291         """Set options from config.ini file in given home_dir directory"""
1292         config_defaults = {"TRACKER_HOME": home_dir}
1293         if defaults:
1294             config_defaults.update(defaults)
1295         Config.load_ini(self, home_dir, config_defaults)
1296
1297     def load_pyconfig(self, home_dir):
1298         """Set options from config.py file in given home_dir directory"""
1299         # try to locate and import the module
1300         _mod_fp = None
1301         try:
1302             try:
1303                 _module = imp.find_module(self.PYCONFIG, [home_dir])
1304                 _mod_fp = _module[0]
1305                 _config = imp.load_module(self.PYCONFIG, *_module)
1306             except ImportError:
1307                 raise NoConfigError(home_dir)
1308         finally:
1309             if _mod_fp is not None:
1310                 _mod_fp.close()
1311         # module loaded ok.  set the options, starting from HOME
1312         self.reset()
1313         self.HOME = home_dir
1314         for _option in self.items():
1315             _option.load_pyconfig(_config)
1316         # backward compatibility:
1317         # SMTP login parameters were specified as a tuple in old style configs
1318         # convert them to new plain string options
1319         _mailuser = getattr(_config, "MAILUSER", ())
1320         if len(_mailuser) > 0:
1321             self.MAIL_USERNAME = _mailuser[0]
1322         if len(_mailuser) > 1:
1323             self.MAIL_PASSWORD = _mailuser[1]
1324
1325     # in this config, HOME is also known as TRACKER_HOME
1326     def __getitem__(self, name):
1327         if name == "TRACKER_HOME":
1328             return self.HOME
1329         else:
1330             return Config.__getitem__(self, name)
1331
1332     def __setitem__(self, name, value):
1333         if name == "TRACKER_HOME":
1334             self.HOME = value
1335         else:
1336             self._get_option(name).set(value)
1337
1338     def __setattr__(self, name, value):
1339         if name == "TRACKER_HOME":
1340             self.__dict__["HOME"] = value
1341         else:
1342             Config.__setattr__(self, name, value)
1343
1344 # vim: set et sts=4 sw=4 :