roundup/templates/extended/instance_config.py

   1 #
   2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   3 # This module is free software, and you may redistribute it and/or modify
   4 # under the same terms as Python, so long as this copyright message and
   5 # disclaimer are retained in their original form.
   6 #
   7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
   8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
   9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  10 # POSSIBILITY OF SUCH DAMAGE.
  11 #
  12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  14 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  17 #
  18 # $Id: instance_config.py,v 1.17 2002-05-22 00:32:34 richard Exp $
  19
  20 MAIL_DOMAIN=MAILHOST=HTTP_HOST=None
  21 HTTP_PORT=0
  22
  23 try:
  24     from localconfig import *
  25 except ImportError:
  26     localconfig = None
  27
  28 import os
  29
  30 # roundup home is this package's directory
  31 INSTANCE_HOME=os.path.split(__file__)[0]
  32
  33 # The SMTP mail host that roundup will use to send mail
  34 if not MAILHOST:
  35     MAILHOST = 'localhost'
  36
  37 # The domain name used for email addresses.
  38 if not MAIL_DOMAIN:
  39     MAIL_DOMAIN = 'your.tracker.email.domain.example'
  40
  41 # the next two are only used for the standalone HTTP server.
  42 if not HTTP_HOST:
  43     HTTP_HOST = ''
  44 if not HTTP_PORT:
  45     HTTP_PORT = 9080
  46
  47 # This is the directory that the database is going to be stored in
  48 DATABASE = os.path.join(INSTANCE_HOME, 'db')
  49
  50 # This is the directory that the HTML templates reside in
  51 TEMPLATES = os.path.join(INSTANCE_HOME, 'html')
  52
  53 # A descriptive name for your roundup instance
  54 INSTANCE_NAME = 'Roundup issue tracker'
  55
  56 # The email address that mail to roundup should go to
  57 ISSUE_TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
  58
  59 # The web address that the instance is viewable at
  60 ISSUE_TRACKER_WEB = 'http://your.tracker.url.example/'
  61
  62 # The email address that roundup will complain to if it runs into trouble
  63 ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
  64
  65 # Somewhere for roundup to log stuff internally sent to stdout or stderr
  66 LOG = os.path.join(INSTANCE_HOME, 'roundup.log')
  67
  68 # Where to place the web filtering HTML on the index page
  69 FILTER_POSITION = 'bottom'          # one of 'top', 'bottom', 'top and bottom'
  70
  71 # Deny or allow anonymous access to the web interface
  72 ANONYMOUS_ACCESS = 'deny'           # either 'deny' or 'allow'
  73
  74 # Deny or allow anonymous users to register through the web interface
  75 ANONYMOUS_REGISTER = 'deny'         # either 'deny' or 'allow'
  76
  77 # Deny or allow anonymous users to register through the mail interface
  78 ANONYMOUS_REGISTER_MAIL = 'deny'    # either 'deny' or 'allow'
  79
  80 # Send nosy messages to the author of the message
  81 MESSAGES_TO_AUTHOR = 'no'           # either 'yes' or 'no'
  82
  83 # Does the author of a message get placed on the nosy list automatically?
  84 # If 'new' is used, then the author will only be added when a message
  85 # creates a new issue. If 'yes', then the author will be added on followups
  86 # too. If 'no', they're never added to the nosy.
  87 ADD_AUTHOR_TO_NOSY = 'new'          # one of 'yes', 'no', 'new'
  88
  89 # Do the recipients (To:, Cc:) of a message get placed on the nosy list?
  90 # If 'new' is used, then the recipients will only be added when a message
  91 # creates a new issue. If 'yes', then the recipients will be added on followups
  92 # too. If 'no', they're never added to the nosy.
  93 ADD_RECIPIENTS_TO_NOSY = 'new'      # either 'yes', 'no', 'new'
  94
  95 # Where to place the email signature
  96 EMAIL_SIGNATURE_POSITION = 'bottom' # one of 'top', 'bottom', 'none'
  97
  98 # Keep email citations
  99 EMAIL_KEEP_QUOTED_TEXT = 'no'       # either 'yes' or 'no'
 100
 101 # Preserve the email body as is
 102 EMAIL_LEAVE_BODY_UNCHANGED = 'no'   # either 'yes' or 'no'
 103
 104 # Default class to use in the mailgw if one isn't supplied in email
 105 # subjects. To disable, comment out the variable below or leave it blank.
 106 # Examples:
 107 MAIL_DEFAULT_CLASS = 'issue'   # use "issue" class by default
 108 #MAIL_DEFAULT_CLASS = ''        # disable (or just comment the var out)
 109
 110 # Define what index links are available in the header, and what their
 111 # labels are. Each key is used to look up one of the index specifications
 112 # below - so 'DEFAULT' will use 'DEFAULT_INDEX'.
 113 # Where the FILTERSPEC has 'assignedto' with a value of None, it will be
 114 # replaced by the id of the logged-in user.
 115 HEADER_INDEX_LINKS = ['DEFAULT', 'ALL_SUPPORT', 'UNASSIGNED_ISSUE',
 116         'UNASSIGNED_SUPPORT', 'MY_ISSUE', 'MY_SUPPORT']
 117
 118 # list the classes that users are able to add nodes to
 119 HEADER_ADD_LINKS = ['issue', 'support']
 120
 121 # Now the DEFAULT display specifications. TODO: describe format
 122 DEFAULT_INDEX = {
 123   'LABEL': 'All Issues',
 124   'CLASS': 'issue',
 125   'SORT': ['-activity'],
 126   'GROUP': ['priority'],
 127   'FILTER': ['status'],
 128   'COLUMNS': ['id','activity','title','creator','assignedto'],
 129   'FILTERSPEC': {
 130     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 131   },
 132 }
 133
 134 ALL_SUPPORT_INDEX = {
 135   'LABEL': 'All Support',
 136   'CLASS': 'support',
 137   'SORT': ['-activity'],
 138   'GROUP': ['customername'],
 139   'FILTER': ['status'],
 140   'COLUMNS': ['id','activity','title','creator','assignedto'],
 141   'FILTERSPEC': {
 142     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 143   },
 144 }
 145
 146 # The "unsassigned issues" indexes
 147 UNASSIGNED_ISSUE_INDEX = {
 148   'LABEL': 'Unassigned Issues',
 149   'CLASS': 'issue',
 150   'SORT': ['-activity'],
 151   'GROUP': ['priority'],
 152   'FILTER': ['status', 'assignedto'],
 153   'COLUMNS': ['id','activity','title','creator','status'],
 154   'FILTERSPEC': {
 155     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 156     'assignedto': ['-1'],
 157   },
 158 }
 159 UNASSIGNED_SUPPORT_INDEX = {
 160   'LABEL': 'Unassigned Support',
 161   'CLASS': 'support',
 162   'SORT': ['-activity'],
 163   'GROUP': ['customername'],
 164   'FILTER': ['status', 'assignedto'],
 165   'COLUMNS': ['id','activity','title','creator','status'],
 166   'FILTERSPEC': {
 167     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 168     'assignedto': ['-1'],
 169   },
 170 }
 171
 172 # The "my issues" index -- note that the user's id will replace the
 173 # 'CURRENT USER' value of the "assignedto" filterspec
 174 MY_ISSUE_INDEX = {
 175   'LABEL': 'My Issues',
 176   'CLASS': 'issue',
 177   'SORT': ['-activity'],
 178   'GROUP': ['priority'],
 179   'FILTER': ['status', 'assignedto'],
 180   'COLUMNS': ['id','activity','title','creator','status'],
 181   'FILTERSPEC': {
 182     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 183     'assignedto': 'CURRENT USER',
 184   },
 185 }
 186
 187 MY_SUPPORT_INDEX = {
 188   'LABEL': 'My Support',
 189   'CLASS': 'support',
 190   'SORT': ['-activity'],
 191   'GROUP': ['customername'],
 192   'FILTER': ['status', 'assignedto'],
 193   'COLUMNS': ['id','activity','title','creator','status'],
 194   'FILTERSPEC': {
 195     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 196     'assignedto': 'CURRENT USER',
 197   },
 198 }
 199
 200 #
 201 # $Log: not supported by cvs2svn $
 202 # Revision 1.16  2002/05/21 06:05:54  richard
 203 #  . #551483 ] assignedto in Client.make_index_link
 204 #
 205 # Revision 1.15  2002/05/02 07:56:34  richard
 206 # . added option to automatically add the authors and recipients of messages
 207 #   to the nosy lists with the options ADD_AUTHOR_TO_NOSY (default 'new') and
 208 #   ADD_RECIPIENTS_TO_NOSY (default 'new'). These settings emulate the current
 209 #   behaviour. Setting them to 'yes' will add the author/recipients to the nosy
 210 #   on messages that create issues and followup messages.
 211 # . added missing documentation for a few of the config option values
 212 #
 213 # Revision 1.14  2002/04/23 15:46:49  rochecompaan
 214 #  . stripping of the email message body can now be controlled through
 215 #    the config variables EMAIL_KEEP_QUOTED_TEST and
 216 #    EMAIL_LEAVE_BODY_UNCHANGED.
 217 #
 218 # Revision 1.13  2002/03/14 23:59:24  richard
 219 #  . #517734 ] web header customisation is obscure
 220 #
 221 # Revision 1.12  2002/02/15 00:13:38  richard
 222 #  . #503204 ] mailgw needs a default class
 223 #     - partially done - the setting of additional properties can wait for a
 224 #       better configuration system.
 225 #
 226 # Revision 1.11  2002/02/14 23:46:02  richard
 227 # . #516883 ] mail interface + ANONYMOUS_REGISTER
 228 #
 229 # Revision 1.10  2001/11/26 22:55:56  richard
 230 # Feature:
 231 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 232 #    the instance.
 233 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 234 #    signature info in e-mails.
 235 #  . Some more flexibility in the mail gateway and more error handling.
 236 #  . Login now takes you to the page you back to the were denied access to.
 237 #
 238 # Fixed:
 239 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 240 #
 241 # Revision 1.9  2001/10/30 00:54:45  richard
 242 # Features:
 243 #  . #467129 ] Lossage when username=e-mail-address
 244 #  . #473123 ] Change message generation for author
 245 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
 246 #
 247 # Revision 1.8  2001/10/23 01:00:18  richard
 248 # Re-enabled login and registration access after lopping them off via
 249 # disabling access for anonymous users.
 250 # Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
 251 # a couple of bugs while I was there. Probably introduced a couple, but
 252 # things seem to work OK at the moment.
 253 #
 254 # Revision 1.7  2001/10/22 03:25:01  richard
 255 # Added configuration for:
 256 #  . anonymous user access and registration (deny/allow)
 257 #  . filter "widget" location on index page (top, bottom, both)
 258 # Updated some documentation.
 259 #
 260 # Revision 1.6  2001/10/01 06:10:42  richard
 261 # stop people setting up roundup with our addresses as default - need to
 262 # handle this better in the init
 263 #
 264 # Revision 1.5  2001/08/07 00:24:43  richard
 265 # stupid typo
 266 #
 267 # Revision 1.4  2001/08/07 00:15:51  richard
 268 # Added the copyright/license notice to (nearly) all files at request of
 269 # Bizar Software.
 270 #
 271 # Revision 1.3  2001/08/02 06:38:17  richard
 272 # Roundupdb now appends "mailing list" information to its messages which
 273 # include the e-mail address and web interface address. Templates may
 274 # override this in their db classes to include specific information (support
 275 # instructions, etc).
 276 #
 277 # Revision 1.2  2001/07/29 07:01:39  richard
 278 # Added vim command to all source so that we don't get no steenkin' tabs :)
 279 #
 280 # Revision 1.1  2001/07/23 04:33:21  anthonybaxter
 281 # split __init__.py into 2. dbinit and instance_config.
 282 #
 283 #
 284 # vim: set filetype=python ts=4 sw=4 et si