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: dbinit.py,v 1.23 2002-08-30 08:30:45 richard Exp $
20 import os
22 import instance_config
23 from select_db import Database, Class, FileClass, IssueClass
25 def open(name=None):
26 ''' as from the roundupdb method openDB
27 '''
28 from roundup.hyperdb import String, Password, Date, Link, Multilink
30 # open the database
31 db = Database(instance_config, name)
33 #
34 # Now initialise the schema. Must do this each time the database is
35 # opened.
36 #
38 # Class automatically gets these properties:
39 # creation = Date()
40 # activity = Date()
41 # creator = Link('user')
42 pri = Class(db, "priority",
43 name=String(), order=String())
44 pri.setkey("name")
46 stat = Class(db, "status",
47 name=String(), order=String())
48 stat.setkey("name")
50 keyword = Class(db, "keyword",
51 name=String())
52 keyword.setkey("name")
54 query = Class(db, "query",
55 klass=String(), name=String(),
56 url=String())
57 query.setkey("name")
59 # Note: roles is a comma-separated string of Role names
60 user = Class(db, "user",
61 username=String(), password=Password(),
62 address=String(), realname=String(),
63 phone=String(), organisation=String(),
64 alternate_addresses=String(),
65 queries=Multilink('query'), roles=String())
66 user.setkey("username")
68 # FileClass automatically gets these properties:
69 # content = String() [saved to disk in <instance home>/db/files/]
70 # (it also gets the Class properties creation, activity and creator)
71 msg = FileClass(db, "msg",
72 author=Link("user"), recipients=Multilink("user"),
73 date=Date(), summary=String(),
74 files=Multilink("file"),
75 messageid=String(), inreplyto=String())
77 file = FileClass(db, "file",
78 name=String(), type=String())
80 # IssueClass automatically gets these properties:
81 # title = String()
82 # messages = Multilink("msg")
83 # files = Multilink("file")
84 # nosy = Multilink("user")
85 # superseder = Multilink("issue")
86 # (it also gets the Class properties creation, activity and creator)
87 issue = IssueClass(db, "issue",
88 assignedto=Link("user"), topic=Multilink("keyword"),
89 priority=Link("priority"), status=Link("status"))
91 #
92 # SECURITY SETTINGS
93 #
94 # new permissions for this schema
95 for cl in 'issue', 'file', 'msg', 'user':
96 db.security.addPermission(name="Edit", klass=cl,
97 description="User is allowed to edit "+cl)
98 db.security.addPermission(name="View", klass=cl,
99 description="User is allowed to access "+cl)
101 # Assign the access and edit permissions for issue, file and message
102 # to regular users now
103 for cl in 'issue', 'file', 'msg':
104 p = db.security.getPermission('View', cl)
105 db.security.addPermissionToRole('User', p)
106 p = db.security.getPermission('Edit', cl)
107 db.security.addPermissionToRole('User', p)
108 # and give the regular users access to the web and email interface
109 p = db.security.getPermission('Web Access')
110 db.security.addPermissionToRole('User', p)
111 p = db.security.getPermission('Email Access')
112 db.security.addPermissionToRole('User', p)
114 # Assign the appropriate permissions to the anonymous user's Anonymous
115 # Role. Choices here are:
116 # - Allow anonymous users to register through the web
117 p = db.security.getPermission('Web Registration')
118 db.security.addPermissionToRole('Anonymous', p)
119 # - Allow anonymous (new) users to register through the email gateway
120 p = db.security.getPermission('Email Registration')
121 db.security.addPermissionToRole('Anonymous', p)
122 # - Allow anonymous users access to the "issue" class of data
123 # Note: this also grants access to related information like files,
124 # messages, statuses etc that are linked to issues
125 #p = db.security.getPermission('View', 'issue')
126 #db.security.addPermissionToRole('Anonymous', p)
127 # - Allow anonymous users access to edit the "issue" class of data
128 # Note: this also grants access to create related information like
129 # files and messages etc that are linked to issues
130 #p = db.security.getPermission('Edit', 'issue')
131 #db.security.addPermissionToRole('Anonymous', p)
133 # oh, g'wan, let anonymous access the web interface too
134 p = db.security.getPermission('Web Access')
135 db.security.addPermissionToRole('Anonymous', p)
137 import detectors
138 detectors.init(db)
140 # schema is set up - run any post-initialisation
141 db.post_init()
142 return db
144 def init(adminpw):
145 ''' as from the roundupdb method initDB
147 Open the new database, and add new nodes - used for initialisation. You
148 can edit this before running the "roundup-admin initialise" command to
149 change the initial database entries.
150 '''
151 dbdir = os.path.join(instance_config.DATABASE, 'files')
152 if not os.path.isdir(dbdir):
153 os.makedirs(dbdir)
155 db = open("admin")
156 db.clear()
158 #
159 # INITIAL PRIORITY AND STATUS VALUES
160 #
161 pri = db.getclass('priority')
162 pri.create(name="critical", order="1")
163 pri.create(name="urgent", order="2")
164 pri.create(name="bug", order="3")
165 pri.create(name="feature", order="4")
166 pri.create(name="wish", order="5")
168 stat = db.getclass('status')
169 stat.create(name="unread", order="1")
170 stat.create(name="deferred", order="2")
171 stat.create(name="chatting", order="3")
172 stat.create(name="need-eg", order="4")
173 stat.create(name="in-progress", order="5")
174 stat.create(name="testing", order="6")
175 stat.create(name="done-cbb", order="7")
176 stat.create(name="resolved", order="8")
178 # create the two default users
179 user = db.getclass('user')
180 user.create(username="admin", password=adminpw,
181 address=instance_config.ADMIN_EMAIL, roles='Admin')
182 user.create(username="anonymous", roles='Anonymous')
184 db.commit()
186 #
187 # $Log: not supported by cvs2svn $
188 # Revision 1.22 2002/08/01 00:56:22 richard
189 # Added the web access and email access permissions, so people can restrict
190 # access to users who register through the email interface (for example).
191 # Also added "security" command to the roundup-admin interface to display the
192 # Role/Permission config for an instance.
193 #
194 # Revision 1.21 2002/07/26 08:26:59 richard
195 # Very close now. The cgi and mailgw now use the new security API. The two
196 # templates have been migrated to that setup. Lots of unit tests. Still some
197 # issue in the web form for editing Roles assigned to users.
198 #
199 # Revision 1.20 2002/07/17 12:39:10 gmcm
200 # Saving, running & editing queries.
201 #
202 # Revision 1.19 2002/07/14 02:05:54 richard
203 # . all storage-specific code (ie. backend) is now implemented by the backends
204 #
205 # Revision 1.18 2002/07/09 03:02:53 richard
206 # More indexer work:
207 # - all String properties may now be indexed too. Currently there's a bit of
208 # "issue" specific code in the actual searching which needs to be
209 # addressed. In a nutshell:
210 # + pass 'indexme="yes"' as a String() property initialisation arg, eg:
211 # file = FileClass(db, "file", name=String(), type=String(),
212 # comment=String(indexme="yes"))
213 # + the comment will then be indexed and be searchable, with the results
214 # related back to the issue that the file is linked to
215 # - as a result of this work, the FileClass has a default MIME type that may
216 # be overridden in a subclass, or by the use of a "type" property as is
217 # done in the default templates.
218 # - the regeneration of the indexes (if necessary) is done once the schema is
219 # set up in the dbinit.
220 #
221 # Revision 1.17 2002/05/24 04:03:23 richard
222 # Added commentage to the dbinit files to help people with their
223 # customisation.
224 #
225 # Revision 1.16 2002/02/16 08:06:14 richard
226 # Removed the key property restriction on title of the classic issue class.
227 #
228 # Revision 1.15 2002/02/15 07:08:44 richard
229 # . Alternate email addresses are now available for users. See the MIGRATION
230 # file for info on how to activate the feature.
231 #
232 # Revision 1.14 2002/01/14 02:20:15 richard
233 # . changed all config accesses so they access either the instance or the
234 # config attriubute on the db. This means that all config is obtained from
235 # instance_config instead of the mish-mash of classes. This will make
236 # switching to a ConfigParser setup easier too, I hope.
237 #
238 # At a minimum, this makes migration a _little_ easier (a lot easier in the
239 # 0.5.0 switch, I hope!)
240 #
241 # Revision 1.13 2002/01/02 02:31:38 richard
242 # Sorry for the huge checkin message - I was only intending to implement #496356
243 # but I found a number of places where things had been broken by transactions:
244 # . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
245 # for _all_ roundup-generated smtp messages to be sent to.
246 # . the transaction cache had broken the roundupdb.Class set() reactors
247 # . newly-created author users in the mailgw weren't being committed to the db
248 #
249 # Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
250 # on when I found that stuff :):
251 # . #496356 ] Use threading in messages
252 # . detectors were being registered multiple times
253 # . added tests for mailgw
254 # . much better attaching of erroneous messages in the mail gateway
255 #
256 # Revision 1.12 2001/12/02 05:06:16 richard
257 # . We now use weakrefs in the Classes to keep the database reference, so
258 # the close() method on the database is no longer needed.
259 # I bumped the minimum python requirement up to 2.1 accordingly.
260 # . #487480 ] roundup-server
261 # . #487476 ] INSTALL.txt
262 #
263 # I also cleaned up the change message / post-edit stuff in the cgi client.
264 # There's now a clearly marked "TODO: append the change note" where I believe
265 # the change note should be added there. The "changes" list will obviously
266 # have to be modified to be a dict of the changes, or somesuch.
267 #
268 # More testing needed.
269 #
270 # Revision 1.11 2001/12/01 07:17:50 richard
271 # . We now have basic transaction support! Information is only written to
272 # the database when the commit() method is called. Only the anydbm
273 # backend is modified in this way - neither of the bsddb backends have been.
274 # The mail, admin and cgi interfaces all use commit (except the admin tool
275 # doesn't have a commit command, so interactive users can't commit...)
276 # . Fixed login/registration forwarding the user to the right page (or not,
277 # on a failure)
278 #
279 # Revision 1.10 2001/11/26 22:55:56 richard
280 # Feature:
281 # . Added INSTANCE_NAME to configuration - used in web and email to identify
282 # the instance.
283 # . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
284 # signature info in e-mails.
285 # . Some more flexibility in the mail gateway and more error handling.
286 # . Login now takes you to the page you back to the were denied access to.
287 #
288 # Fixed:
289 # . Lots of bugs, thanks Roché and others on the devel mailing list!
290 #
291 # Revision 1.9 2001/10/30 00:54:45 richard
292 # Features:
293 # . #467129 ] Lossage when username=e-mail-address
294 # . #473123 ] Change message generation for author
295 # . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
296 #
297 # Revision 1.8 2001/10/09 07:25:59 richard
298 # Added the Password property type. See "pydoc roundup.password" for
299 # implementation details. Have updated some of the documentation too.
300 #
301 # Revision 1.7 2001/08/07 00:24:43 richard
302 # stupid typo
303 #
304 # Revision 1.6 2001/08/07 00:15:51 richard
305 # Added the copyright/license notice to (nearly) all files at request of
306 # Bizar Software.
307 #
308 # Revision 1.5 2001/08/02 06:38:17 richard
309 # Roundupdb now appends "mailing list" information to its messages which
310 # include the e-mail address and web interface address. Templates may
311 # override this in their db classes to include specific information (support
312 # instructions, etc).
313 #
314 # Revision 1.4 2001/07/29 07:01:39 richard
315 # Added vim command to all source so that we don't get no steenkin' tabs :)
316 #
317 # Revision 1.3 2001/07/24 10:46:22 anthonybaxter
318 # Added templatebuilder module. two functions - one to pack up the html base,
319 # one to unpack it. Packed up the two standard templates into htmlbases.
320 # Modified __init__ to install them.
321 #
322 # __init__.py magic was needed for the rather high levels of wierd import magic.
323 # Reducing level of import magic == (good, future)
324 #
325 # Revision 1.2 2001/07/24 01:06:43 richard
326 # Oops - accidentally duped the keywords class
327 #
328 # Revision 1.1 2001/07/23 23:28:43 richard
329 # Adding the classic template
330 #
331 # Revision 1.4 2001/07/23 08:45:28 richard
332 # ok, so now "./roundup-admin init" will ask questions in an attempt to get a
333 # workable instance_home set up :)
334 # _and_ anydbm has had its first test :)
335 #
336 # Revision 1.3 2001/07/23 07:14:41 richard
337 # Moved the database backends off into backends.
338 #
339 # Revision 1.2 2001/07/23 06:25:50 richard
340 # relfected the move to roundup/backends
341 #
342 # Revision 1.1 2001/07/23 04:33:21 anthonybaxter
343 # split __init__.py into 2. dbinit and instance_config.
344 #
345 # Revision 1.1 2001/07/23 03:50:46 anthonybaxter
346 # moved templates to proper location
347 #
348 # Revision 1.2 2001/07/22 12:09:32 richard
349 # Final commit of Grande Splite
350 #
351 #
352 # vim: set filetype=python ts=4 sw=4 et si