Mercurial > p > roundup > code

comparison roundup/configuration.py @ 2627:ce6a965a86f4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move around some option groupings as I see them. The charset option is used in contexts other than nosy, so it belongs in the general mail group.
author Richard Jones <richard@users.sourceforge.net>
date Mon, 26 Jul 2004 00:23:16 +0000
parents 8e4c7a3217d6
children ac377478769d
comparison
equal deleted inserted replaced
2626:e49e6c7b14fb 2627:ce6a965a86f4
1 # Roundup Issue Tracker configuration support 1 # Roundup Issue Tracker configuration support
2 # 2 #
3 # $Id: configuration.py,v 1.7 2004-07-25 15:22:54 a1s Exp $ 3 # $Id: configuration.py,v 1.8 2004-07-26 00:23:16 richard Exp $
4 # 4 #
5 __docformat__ = "restructuredtext" 5 __docformat__ = "restructuredtext"
6 6
7 import imp 7 import imp
8 import os 8 import os
375 # where each section name is followed by a sequence 375 # where each section name is followed by a sequence
376 # of Option definitions. Each Option definition 376 # of Option definitions. Each Option definition
377 # is a sequence containing class name and constructor 377 # is a sequence containing class name and constructor
378 # parameters, starting from the setting name: 378 # parameters, starting from the setting name:
379 # setting, default, [description, [aliases]] 379 # setting, default, [description, [aliases]]
380 # Note: aliases should only exist in historical options for backwards
381 # compatibility - new options should *not* have aliases!
380 SETTINGS = ( 382 SETTINGS = (
381 ("main", ( 383 ("main", (
382 (FilePathOption, "database", "db", "Database directory path"), 384 (FilePathOption, "database", "db", "Database directory path"),
383 (FilePathOption, "templates", "html", 385 (FilePathOption, "templates", "html",
384 "Path to the HTML templates directory"), 386 "Path to the HTML templates directory"),
451 (Option, "level", "ERROR", 453 (Option, "level", "ERROR",
452 "Minimal severity level of messages written to log file.\n" 454 "Minimal severity level of messages written to log file.\n"
453 "If above 'config' option is set, this option has no effect.\n" 455 "If above 'config' option is set, this option has no effect.\n"
454 "Allowed values: DEBUG, INFO, WARNING, ERROR"), 456 "Allowed values: DEBUG, INFO, WARNING, ERROR"),
455 )), 457 )),
456 # XXX This section covers two service areas:
457 # outgoing mail (domain, smtp parameters)
458 # and creation of issues from incoming mail.
459 # These things should be separated.
460 # In addition, 'charset' option is used in nosy messages only,
461 # so this option actually belongs to the 'nosy' section.
462 ("mail", ( 458 ("mail", (
463 (Option, "domain", NODEFAULT, "Domain name used for email addresses."), 459 (Option, "domain", NODEFAULT, "Domain name used for email addresses."),
464 (Option, "host", NODEFAULT, 460 (Option, "host", NODEFAULT,
465 "SMTP mail host that roundup will use to send mail"), 461 "SMTP mail host that roundup will use to send mail"),
466 (Option, "username", "", "SMTP login name\n" 462 (Option, "username", "", "SMTP login name\n"
475 "If TLS is used, you may set this option to the name\n" 471 "If TLS is used, you may set this option to the name\n"
476 "of a PEM formatted file that contains your private key"), 472 "of a PEM formatted file that contains your private key"),
477 (NullableFilePathOption, "tls_certfile", "", 473 (NullableFilePathOption, "tls_certfile", "",
478 "If TLS is used, you may set this option to the name\n" 474 "If TLS is used, you may set this option to the name\n"
479 "of a PEM formatted certificate chain file"), 475 "of a PEM formatted certificate chain file"),
476 (Option, "charset", "utf-8",
477 "Character set to encode email headers with.\n"
478 "We use utf-8 by default, as it's the most flexible.\n"
479 "Some mail readers (eg. Eudora) can't cope with that,\n"
480 "so you might need to specify a more limited character set\n"
481 "(eg. iso-8859-1)",
482 ["EMAIL_CHARSET"]),
483 (FilePathOption, "debug", "",
484 "Setting this option makes Roundup to write all outgoing email\n"
485 "messages to this file *instead* of sending them.\n"
486 "This option has the same effect as environment variable"
487 " SENDMAILDEBUG.\nEnvironment variable takes precedence."),
488 )),
489 ("mailgw", (
480 (BooleanOption, "keep_quoted_text", "yes", 490 (BooleanOption, "keep_quoted_text", "yes",
481 "Keep email citations when accepting messages.\n" 491 "Keep email citations when accepting messages.\n"
482 "Setting this to \"no\" strips out \"quoted\" text" 492 "Setting this to \"no\" strips out \"quoted\" text"
483 " from the message.\n" 493 " from the message.\n"
484 "Signatures are also stripped.", 494 "Signatures are also stripped.",
485 ["EMAIL_KEEP_QUOTED_TEXT"]), 495 ["EMAIL_KEEP_QUOTED_TEXT"]),
486 (FilePathOption, "debug", "",
487 "Setting this option makes Roundup to write all outgoing email\n"
488 "messages to this file *instead* of sending them.\n"
489 "This option has the same effect as environment variable"
490 " SENDMAILDEBUG.\nEnvironment variable takes precedence."),
491 (BooleanOption, "leave_body_unchanged", "no", 496 (BooleanOption, "leave_body_unchanged", "no",
492 "Preserve the email body as is - that is,\n" 497 "Preserve the email body as is - that is,\n"
493 "keep the citations _and_ signatures.", 498 "keep the citations _and_ signatures.",
494 ["EMAIL_LEAVE_BODY_UNCHANGED"]), 499 ["EMAIL_LEAVE_BODY_UNCHANGED"]),
495 (Option, "default_class", "issue", 500 (Option, "default_class", "issue",
496 "Default class to use in the mailgw\n" 501 "Default class to use in the mailgw\n"
497 "if one isn't supplied in email subjects.\n" 502 "if one isn't supplied in email subjects.\n"
498 "To disable, leave the value blank."), 503 "To disable, leave the value blank.",
499 (Option, "charset", "utf-8", 504 ["MAIL_DEFAULT_CLASS"]),
500 "Character set to encode email headers with.\n"
501 "We use utf-8 by default, as it's the most flexible.\n"
502 "Some mail readers (eg. Eudora) can't cope with that,\n"
503 "so you might need to specify a more limited character set\n"
504 "(eg. iso-8859-1)",
505 ["EMAIL_CHARSET"]),
506 )), 505 )),
507 ("nosy", ( 506 ("nosy", (
508 (BooleanOption, "messages_to_author", "no", 507 (BooleanOption, "messages_to_author", "no",
509 "Send nosy messages to the author of the message", 508 "Send nosy messages to the author of the message",
510 ["MESSAGES_TO_AUTHOR"]), 509 ["MESSAGES_TO_AUTHOR"]),
Roundup Issue Tracker: http://roundup-tracker.org/