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.13 2002-03-14 23:59:24 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 = 'fill.me.in.'
  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://some.useful.url/'
  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 # Where to place the email signature
  84 EMAIL_SIGNATURE_POSITION = 'bottom'
  85
  86 # Default class to use in the mailgw if one isn't supplied in email
  87 # subjects. To disable, comment out the variable below or leave it blank.
  88 # Examples:
  89 MAIL_DEFAULT_CLASS = 'issue'   # use "issue" class by default
  90 #MAIL_DEFAULT_CLASS = ''        # disable (or just comment the var out)
  91
  92 # Define what index links are available in the header, and what their
  93 # labels are. Each key is used to look up one of the index specifications
  94 # below - so 'DEFAULT' will use 'DEFAULT_INDEX'.
  95 # Where the FILTERSPEC has 'assignedto' with a value of None, it will be
  96 # replaced by the id of the logged-in user.
  97 HEADER_INDEX_LINKS = ['DEFAULT', 'ALL_SUPPORT', 'UNASSIGNED_ISSUE',
  98         'UNASSIGNED_SUPPORT', 'MY_ISSUE', 'MY_SUPPORT']
  99
 100 # list the classes that users are able to add nodes to
 101 HEADER_ADD_LINKS = ['issue', 'support']
 102
 103 # Now the DEFAULT display specifications. TODO: describe format
 104 DEFAULT_INDEX = {
 105   'LABEL': 'All Issues',
 106   'CLASS': 'issue',
 107   'SORT': ['-activity'],
 108   'GROUP': ['priority'],
 109   'FILTER': ['status'],
 110   'COLUMNS': ['id','activity','title','creator','assignedto'],
 111   'FILTERSPEC': {
 112     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 113   },
 114 }
 115
 116 ALL_SUPPORT_INDEX = {
 117   'LABEL': 'All Support',
 118   'CLASS': 'support',
 119   'SORT': ['-activity'],
 120   'GROUP': ['customername'],
 121   'FILTER': ['status'],
 122   'COLUMNS': ['id','activity','title','creator','assignedto'],
 123   'FILTERSPEC': {
 124     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 125   },
 126 }
 127
 128 # The "unsassigned issues" indexes
 129 UNASSIGNED_ISSUE_INDEX = {
 130   'LABEL': 'Unassigned Issues',
 131   'CLASS': 'issue',
 132   'SORT': ['-activity'],
 133   'GROUP': ['priority'],
 134   'FILTER': ['status', 'assignedto'],
 135   'COLUMNS': ['id','activity','title','creator','status'],
 136   'FILTERSPEC': {
 137     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 138     'assignedto': ['-1'],
 139   },
 140 }
 141 UNASSIGNED_SUPPORT_INDEX = {
 142   'LABEL': 'Unassigned Support',
 143   'CLASS': 'support',
 144   'SORT': ['-activity'],
 145   'GROUP': ['customername'],
 146   'FILTER': ['status', 'assignedto'],
 147   'COLUMNS': ['id','activity','title','creator','status'],
 148   'FILTERSPEC': {
 149     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 150     'assignedto': ['-1'],
 151   },
 152 }
 153
 154 # The "my issues" indexes -- note that the user's id will replace the None
 155 # valud of the "assignedto" filterspec
 156 MY_ISSUE_INDEX = {
 157   'LABEL': 'My Issues',
 158   'CLASS': 'issue',
 159   'SORT': ['-activity'],
 160   'GROUP': ['priority'],
 161   'FILTER': ['status', 'assignedto'],
 162   'COLUMNS': ['id','activity','title','creator','status'],
 163   'FILTERSPEC': {
 164     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 165     'assignedto': None,
 166   },
 167 }
 168
 169 MY_SUPPORT_INDEX = {
 170   'LABEL': 'My Support',
 171   'CLASS': 'support',
 172   'SORT': ['-activity'],
 173   'GROUP': ['customername'],
 174   'FILTER': ['status', 'assignedto'],
 175   'COLUMNS': ['id','activity','title','creator','status'],
 176   'FILTERSPEC': {
 177     'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
 178     'assignedto': None,
 179   },
 180 }
 181
 182 #
 183 # $Log: not supported by cvs2svn $
 184 # Revision 1.12  2002/02/15 00:13:38  richard
 185 #  . #503204 ] mailgw needs a default class
 186 #     - partially done - the setting of additional properties can wait for a
 187 #       better configuration system.
 188 #
 189 # Revision 1.11  2002/02/14 23:46:02  richard
 190 # . #516883 ] mail interface + ANONYMOUS_REGISTER
 191 #
 192 # Revision 1.10  2001/11/26 22:55:56  richard
 193 # Feature:
 194 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 195 #    the instance.
 196 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 197 #    signature info in e-mails.
 198 #  . Some more flexibility in the mail gateway and more error handling.
 199 #  . Login now takes you to the page you back to the were denied access to.
 200 #
 201 # Fixed:
 202 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 203 #
 204 # Revision 1.9  2001/10/30 00:54:45  richard
 205 # Features:
 206 #  . #467129 ] Lossage when username=e-mail-address
 207 #  . #473123 ] Change message generation for author
 208 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
 209 #
 210 # Revision 1.8  2001/10/23 01:00:18  richard
 211 # Re-enabled login and registration access after lopping them off via
 212 # disabling access for anonymous users.
 213 # Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
 214 # a couple of bugs while I was there. Probably introduced a couple, but
 215 # things seem to work OK at the moment.
 216 #
 217 # Revision 1.7  2001/10/22 03:25:01  richard
 218 # Added configuration for:
 219 #  . anonymous user access and registration (deny/allow)
 220 #  . filter "widget" location on index page (top, bottom, both)
 221 # Updated some documentation.
 222 #
 223 # Revision 1.6  2001/10/01 06:10:42  richard
 224 # stop people setting up roundup with our addresses as default - need to
 225 # handle this better in the init
 226 #
 227 # Revision 1.5  2001/08/07 00:24:43  richard
 228 # stupid typo
 229 #
 230 # Revision 1.4  2001/08/07 00:15:51  richard
 231 # Added the copyright/license notice to (nearly) all files at request of
 232 # Bizar Software.
 233 #
 234 # Revision 1.3  2001/08/02 06:38:17  richard
 235 # Roundupdb now appends "mailing list" information to its messages which
 236 # include the e-mail address and web interface address. Templates may
 237 # override this in their db classes to include specific information (support
 238 # instructions, etc).
 239 #
 240 # Revision 1.2  2001/07/29 07:01:39  richard
 241 # Added vim command to all source so that we don't get no steenkin' tabs :)
 242 #
 243 # Revision 1.1  2001/07/23 04:33:21  anthonybaxter
 244 # split __init__.py into 2. dbinit and instance_config.
 245 #
 246 #
 247 # vim: set filetype=python ts=4 sw=4 et si