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.20 2002-08-16 04:28:41 richard Exp $
20 MAIL_DOMAIN=MAILHOST=HTTP_HOST=None
21 HTTP_PORT=0
23 try:
24 from localconfig import *
25 except ImportError:
26 localconfig = None
28 import os
30 # roundup home is this package's directory
31 INSTANCE_HOME=os.path.split(__file__)[0]
33 # The SMTP mail host that roundup will use to send mail
34 if not MAILHOST:
35 MAILHOST = 'localhost'
37 # The domain name used for email addresses.
38 if not MAIL_DOMAIN:
39 MAIL_DOMAIN = 'your.tracker.email.domain.example'
41 # This is the directory that the database is going to be stored in
42 DATABASE = os.path.join(INSTANCE_HOME, 'db')
44 # This is the directory that the HTML templates reside in
45 TEMPLATES = os.path.join(INSTANCE_HOME, 'html')
47 # A descriptive name for your roundup instance
48 INSTANCE_NAME = 'Roundup issue tracker'
50 # The email address that mail to roundup should go to
51 ISSUE_TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
53 # The web address that the instance is viewable at
54 ISSUE_TRACKER_WEB = 'http://your.tracker.url.example/'
56 # The email address that roundup will complain to if it runs into trouble
57 ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
59 # Where to place the web filtering HTML on the index page
60 FILTER_POSITION = 'bottom' # one of 'top', 'bottom', 'top and bottom'
62 #
63 # SECURITY DEFINITIONS
64 #
65 # define the Roles that a user gets when they register with the tracker
66 # these are a comma-separated string of role names (e.g. 'Admin,User')
67 NEW_WEB_USER_ROLES = 'User'
68 NEW_EMAIL_USER_ROLES = 'User'
70 # Send nosy messages to the author of the message
71 MESSAGES_TO_AUTHOR = 'no' # either 'yes' or 'no'
73 # Does the author of a message get placed on the nosy list automatically?
74 # If 'new' is used, then the author will only be added when a message
75 # creates a new issue. If 'yes', then the author will be added on followups
76 # too. If 'no', they're never added to the nosy.
77 ADD_AUTHOR_TO_NOSY = 'new' # one of 'yes', 'no', 'new'
79 # Do the recipients (To:, Cc:) of a message get placed on the nosy list?
80 # If 'new' is used, then the recipients will only be added when a message
81 # creates a new issue. If 'yes', then the recipients will be added on followups
82 # too. If 'no', they're never added to the nosy.
83 ADD_RECIPIENTS_TO_NOSY = 'new' # either 'yes', 'no', 'new'
85 # Where to place the email signature
86 EMAIL_SIGNATURE_POSITION = 'bottom' # one of 'top', 'bottom', 'none'
88 # Keep email citations
89 EMAIL_KEEP_QUOTED_TEXT = 'no' # either 'yes' or 'no'
91 # Preserve the email body as is
92 EMAIL_LEAVE_BODY_UNCHANGED = 'no' # either 'yes' or 'no'
94 # Default class to use in the mailgw if one isn't supplied in email
95 # subjects. To disable, comment out the variable below or leave it blank.
96 # Examples:
97 MAIL_DEFAULT_CLASS = 'issue' # use "issue" class by default
98 #MAIL_DEFAULT_CLASS = '' # disable (or just comment the var out)
100 # Define what index links are available in the header, and what their
101 # labels are. Each key is used to look up one of the index specifications
102 # below - so 'DEFAULT' will use 'DEFAULT_INDEX'.
103 # Where the FILTERSPEC has 'assignedto' with a value of None, it will be
104 # replaced by the id of the logged-in user.
105 HEADER_INDEX_LINKS = ['DEFAULT', 'UNASSIGNED', 'USER']
107 # list the classes that users are able to add nodes to
108 HEADER_ADD_LINKS = ['issue']
110 # list the classes that users can search
111 HEADER_SEARCH_LINKS = ['issue']
113 # list search filters per class
114 SEARCH_FILTERS = ['ISSUE_FILTER', 'SUPPORT_FILTER']
116 # Now the DEFAULT display specification. TODO: describe format
117 DEFAULT_INDEX = {
118 'LABEL': 'All Issues',
119 'CLASS': 'issue',
120 'SORT': ['-activity'],
121 'GROUP': ['priority'],
122 'FILTER': ['status'],
123 'COLUMNS': ['id','activity','title','creator','assignedto'],
124 'FILTERSPEC': {
125 'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
126 },
127 }
129 # The "unsassigned issues" index
130 UNASSIGNED_INDEX = {
131 'LABEL': 'Unassigned Issues',
132 'CLASS': 'issue',
133 'SORT': ['-activity'],
134 'GROUP': ['priority'],
135 'FILTER': ['status', 'assignedto'],
136 'COLUMNS': ['id','activity','title','creator','status'],
137 'FILTERSPEC': {
138 'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
139 'assignedto': ['-1'],
140 },
141 }
143 # The "my issues" index -- note that the user's id will replace the
144 # 'CURRENT USER' value of the "assignedto" filterspec
145 USER_INDEX = {
146 'LABEL': 'My Issues',
147 'CLASS': 'issue',
148 'SORT': ['-activity'],
149 'GROUP': ['priority'],
150 'FILTER': ['status', 'assignedto'],
151 'COLUMNS': ['id','activity','title','creator','status'],
152 'FILTERSPEC': {
153 'status': ['-1', '1', '2', '3', '4', '5', '6', '7'],
154 'assignedto': 'CURRENT USER',
155 },
156 }
158 ISSUE_FILTER = {
159 'CLASS': 'issue',
160 'FILTER': ['status', 'priority', 'assignedto', 'creator']
161 }
163 SUPPORT_FILTER = {
164 'CLASS': 'issue',
165 'FILTER': ['status', 'priority', 'assignedto', 'creator']
166 }
169 #
170 # $Log: not supported by cvs2svn $
171 # Revision 1.19 2002/07/26 08:26:59 richard
172 # Very close now. The cgi and mailgw now use the new security API. The two
173 # templates have been migrated to that setup. Lots of unit tests. Still some
174 # issue in the web form for editing Roles assigned to users.
175 #
176 # Revision 1.18 2002/05/25 07:16:25 rochecompaan
177 # Merged search_indexing-branch with HEAD
178 #
179 # Revision 1.17 2002/05/22 00:32:33 richard
180 # . changed the default message list in issues to display the message body
181 # . made backends.__init__ be more specific about which ImportErrors it really
182 # wants to ignore
183 # . fixed the example addresses in the templates to use correct example domains
184 # . cleaned out the template stylesheets, removing a bunch of junk that really
185 # wasn't necessary (font specs, styles never used) and added a style for
186 # message content
187 #
188 # Revision 1.16 2002/05/21 06:05:54 richard
189 # . #551483 ] assignedto in Client.make_index_link
190 #
191 # Revision 1.15 2002/05/02 07:56:34 richard
192 # . added option to automatically add the authors and recipients of messages
193 # to the nosy lists with the options ADD_AUTHOR_TO_NOSY (default 'new') and
194 # ADD_RECIPIENTS_TO_NOSY (default 'new'). These settings emulate the current
195 # behaviour. Setting them to 'yes' will add the author/recipients to the nosy
196 # on messages that create issues and followup messages.
197 # . added missing documentation for a few of the config option values
198 #
199 # Revision 1.14 2002/04/23 15:46:49 rochecompaan
200 # . stripping of the email message body can now be controlled through
201 # the config variables EMAIL_KEEP_QUOTED_TEST and
202 # EMAIL_LEAVE_BODY_UNCHANGED.
203 #
204 # Revision 1.13.2.2 2002/05/02 11:49:19 rochecompaan
205 # Allow customization of the search filters that should be displayed
206 # on the search page.
207 #
208 # Revision 1.13.2.1 2002/04/20 13:23:33 rochecompaan
209 # We now have a separate search page for nodes. Search links for
210 # different classes can be customized in instance_config similar to
211 # index links.
212 #
213 # Revision 1.13 2002/03/14 23:59:24 richard
214 # . #517734 ] web header customisation is obscure
215 #
216 # Revision 1.12 2002/02/15 00:13:38 richard
217 # . #503204 ] mailgw needs a default class
218 # - partially done - the setting of additional properties can wait for a
219 # better configuration system.
220 #
221 # Revision 1.11 2002/02/14 23:46:02 richard
222 # . #516883 ] mail interface + ANONYMOUS_REGISTER
223 #
224 # Revision 1.10 2001/11/26 22:55:56 richard
225 # Feature:
226 # . Added INSTANCE_NAME to configuration - used in web and email to identify
227 # the instance.
228 # . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
229 # signature info in e-mails.
230 # . Some more flexibility in the mail gateway and more error handling.
231 # . Login now takes you to the page you back to the were denied access to.
232 #
233 # Fixed:
234 # . Lots of bugs, thanks Roché and others on the devel mailing list!
235 #
236 # Revision 1.9 2001/10/30 00:54:45 richard
237 # Features:
238 # . #467129 ] Lossage when username=e-mail-address
239 # . #473123 ] Change message generation for author
240 # . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
241 #
242 # Revision 1.8 2001/10/23 01:00:18 richard
243 # Re-enabled login and registration access after lopping them off via
244 # disabling access for anonymous users.
245 # Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
246 # a couple of bugs while I was there. Probably introduced a couple, but
247 # things seem to work OK at the moment.
248 #
249 # Revision 1.7 2001/10/22 03:25:01 richard
250 # Added configuration for:
251 # . anonymous user access and registration (deny/allow)
252 # . filter "widget" location on index page (top, bottom, both)
253 # Updated some documentation.
254 #
255 # Revision 1.6 2001/10/01 06:10:42 richard
256 # stop people setting up roundup with our addresses as default - need to
257 # handle this better in the init
258 #
259 # Revision 1.5 2001/08/07 00:24:43 richard
260 # stupid typo
261 #
262 # Revision 1.4 2001/08/07 00:15:51 richard
263 # Added the copyright/license notice to (nearly) all files at request of
264 # Bizar Software.
265 #
266 # Revision 1.3 2001/08/02 06:38:17 richard
267 # Roundupdb now appends "mailing list" information to its messages which
268 # include the e-mail address and web interface address. Templates may
269 # override this in their db classes to include specific information (support
270 # instructions, etc).
271 #
272 # Revision 1.2 2001/07/29 07:01:39 richard
273 # Added vim command to all source so that we don't get no steenkin' tabs :)
274 #
275 # Revision 1.1 2001/07/23 23:28:43 richard
276 # Adding the classic template
277 #
278 # Revision 1.1 2001/07/23 04:33:21 anthonybaxter
279 # split __init__.py into 2. dbinit and instance_config.
280 #
281 #
282 # vim: set filetype=python ts=4 sw=4 et si