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