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