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