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