97d6b893bb5188af14728cc24e4be065c409006d
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: back_anydbm.py,v 1.67 2002-09-03 02:53:53 richard Exp $
19 '''
20 This module defines a backend that saves the hyperdatabase in a database
21 chosen by anydbm. It is guaranteed to always be available in python
22 versions >2.1.1 (the dumbdbm fallback in 2.1.1 and earlier has several
23 serious bugs, and is not available)
24 '''
26 import whichdb, anydbm, os, marshal, re, weakref, string, copy
27 from roundup import hyperdb, date, password, roundupdb, security
28 from blobfiles import FileStorage
29 from sessions import Sessions
30 from roundup.indexer import Indexer
31 from locking import acquire_lock, release_lock
32 from roundup.hyperdb import String, Password, Date, Interval, Link, \
33 Multilink, DatabaseError, Boolean, Number
35 #
36 # Now the database
37 #
38 class Database(FileStorage, hyperdb.Database, roundupdb.Database):
39 '''A database for storing records containing flexible data types.
41 Transaction stuff TODO:
42 . check the timestamp of the class file and nuke the cache if it's
43 modified. Do some sort of conflict checking on the dirty stuff.
44 . perhaps detect write collisions (related to above)?
46 '''
47 def __init__(self, config, journaltag=None):
48 '''Open a hyperdatabase given a specifier to some storage.
50 The 'storagelocator' is obtained from config.DATABASE.
51 The meaning of 'storagelocator' depends on the particular
52 implementation of the hyperdatabase. It could be a file name,
53 a directory path, a socket descriptor for a connection to a
54 database over the network, etc.
56 The 'journaltag' is a token that will be attached to the journal
57 entries for any edits done on the database. If 'journaltag' is
58 None, the database is opened in read-only mode: the Class.create(),
59 Class.set(), and Class.retire() methods are disabled.
60 '''
61 self.config, self.journaltag = config, journaltag
62 self.dir = config.DATABASE
63 self.classes = {}
64 self.cache = {} # cache of nodes loaded or created
65 self.dirtynodes = {} # keep track of the dirty nodes by class
66 self.newnodes = {} # keep track of the new nodes by class
67 self.destroyednodes = {}# keep track of the destroyed nodes by class
68 self.transactions = []
69 self.indexer = Indexer(self.dir)
70 self.sessions = Sessions(self.config)
71 self.security = security.Security(self)
72 # ensure files are group readable and writable
73 os.umask(0002)
75 def post_init(self):
76 '''Called once the schema initialisation has finished.'''
77 # reindex the db if necessary
78 if self.indexer.should_reindex():
79 self.reindex()
81 def reindex(self):
82 for klass in self.classes.values():
83 for nodeid in klass.list():
84 klass.index(nodeid)
85 self.indexer.save_index()
87 def __repr__(self):
88 return '<back_anydbm instance at %x>'%id(self)
90 #
91 # Classes
92 #
93 def __getattr__(self, classname):
94 '''A convenient way of calling self.getclass(classname).'''
95 if self.classes.has_key(classname):
96 if __debug__:
97 print >>hyperdb.DEBUG, '__getattr__', (self, classname)
98 return self.classes[classname]
99 raise AttributeError, classname
101 def addclass(self, cl):
102 if __debug__:
103 print >>hyperdb.DEBUG, 'addclass', (self, cl)
104 cn = cl.classname
105 if self.classes.has_key(cn):
106 raise ValueError, cn
107 self.classes[cn] = cl
109 def getclasses(self):
110 '''Return a list of the names of all existing classes.'''
111 if __debug__:
112 print >>hyperdb.DEBUG, 'getclasses', (self,)
113 l = self.classes.keys()
114 l.sort()
115 return l
117 def getclass(self, classname):
118 '''Get the Class object representing a particular class.
120 If 'classname' is not a valid class name, a KeyError is raised.
121 '''
122 if __debug__:
123 print >>hyperdb.DEBUG, 'getclass', (self, classname)
124 return self.classes[classname]
126 #
127 # Class DBs
128 #
129 def clear(self):
130 '''Delete all database contents
131 '''
132 if __debug__:
133 print >>hyperdb.DEBUG, 'clear', (self,)
134 for cn in self.classes.keys():
135 for dummy in 'nodes', 'journals':
136 path = os.path.join(self.dir, 'journals.%s'%cn)
137 if os.path.exists(path):
138 os.remove(path)
139 elif os.path.exists(path+'.db'): # dbm appends .db
140 os.remove(path+'.db')
142 def getclassdb(self, classname, mode='r'):
143 ''' grab a connection to the class db that will be used for
144 multiple actions
145 '''
146 if __debug__:
147 print >>hyperdb.DEBUG, 'getclassdb', (self, classname, mode)
148 return self.opendb('nodes.%s'%classname, mode)
150 def determine_db_type(self, path):
151 ''' determine which DB wrote the class file
152 '''
153 db_type = ''
154 if os.path.exists(path):
155 db_type = whichdb.whichdb(path)
156 if not db_type:
157 raise hyperdb.DatabaseError, "Couldn't identify database type"
158 elif os.path.exists(path+'.db'):
159 # if the path ends in '.db', it's a dbm database, whether
160 # anydbm says it's dbhash or not!
161 db_type = 'dbm'
162 return db_type
164 def opendb(self, name, mode):
165 '''Low-level database opener that gets around anydbm/dbm
166 eccentricities.
167 '''
168 if __debug__:
169 print >>hyperdb.DEBUG, 'opendb', (self, name, mode)
171 # figure the class db type
172 path = os.path.join(os.getcwd(), self.dir, name)
173 db_type = self.determine_db_type(path)
175 # new database? let anydbm pick the best dbm
176 if not db_type:
177 if __debug__:
178 print >>hyperdb.DEBUG, "opendb anydbm.open(%r, 'n')"%path
179 return anydbm.open(path, 'n')
181 # open the database with the correct module
182 try:
183 dbm = __import__(db_type)
184 except ImportError:
185 raise hyperdb.DatabaseError, \
186 "Couldn't open database - the required module '%s'"\
187 " is not available"%db_type
188 if __debug__:
189 print >>hyperdb.DEBUG, "opendb %r.open(%r, %r)"%(db_type, path,
190 mode)
191 return dbm.open(path, mode)
193 def lockdb(self, name):
194 ''' Lock a database file
195 '''
196 path = os.path.join(os.getcwd(), self.dir, '%s.lock'%name)
197 return acquire_lock(path)
199 #
200 # Node IDs
201 #
202 def newid(self, classname):
203 ''' Generate a new id for the given class
204 '''
205 # open the ids DB - create if if doesn't exist
206 lock = self.lockdb('_ids')
207 db = self.opendb('_ids', 'c')
208 if db.has_key(classname):
209 newid = db[classname] = str(int(db[classname]) + 1)
210 else:
211 # the count() bit is transitional - older dbs won't start at 1
212 newid = str(self.getclass(classname).count()+1)
213 db[classname] = newid
214 db.close()
215 release_lock(lock)
216 return newid
218 def setid(self, classname, setid):
219 ''' Set the id counter: used during import of database
220 '''
221 # open the ids DB - create if if doesn't exist
222 lock = self.lockdb('_ids')
223 db = self.opendb('_ids', 'c')
224 db[classname] = str(setid)
225 db.close()
226 release_lock(lock)
228 #
229 # Nodes
230 #
231 def addnode(self, classname, nodeid, node):
232 ''' add the specified node to its class's db
233 '''
234 if __debug__:
235 print >>hyperdb.DEBUG, 'addnode', (self, classname, nodeid, node)
236 self.newnodes.setdefault(classname, {})[nodeid] = 1
237 self.cache.setdefault(classname, {})[nodeid] = node
238 self.savenode(classname, nodeid, node)
240 def setnode(self, classname, nodeid, node):
241 ''' change the specified node
242 '''
243 if __debug__:
244 print >>hyperdb.DEBUG, 'setnode', (self, classname, nodeid, node)
245 self.dirtynodes.setdefault(classname, {})[nodeid] = 1
247 # can't set without having already loaded the node
248 self.cache[classname][nodeid] = node
249 self.savenode(classname, nodeid, node)
251 def savenode(self, classname, nodeid, node):
252 ''' perform the saving of data specified by the set/addnode
253 '''
254 if __debug__:
255 print >>hyperdb.DEBUG, 'savenode', (self, classname, nodeid, node)
256 self.transactions.append((self.doSaveNode, (classname, nodeid, node)))
258 def getnode(self, classname, nodeid, db=None, cache=1):
259 ''' get a node from the database
260 '''
261 if __debug__:
262 print >>hyperdb.DEBUG, 'getnode', (self, classname, nodeid, db)
263 if cache:
264 # try the cache
265 cache_dict = self.cache.setdefault(classname, {})
266 if cache_dict.has_key(nodeid):
267 if __debug__:
268 print >>hyperdb.TRACE, 'get %s %s cached'%(classname,
269 nodeid)
270 return cache_dict[nodeid]
272 if __debug__:
273 print >>hyperdb.TRACE, 'get %s %s'%(classname, nodeid)
275 # get from the database and save in the cache
276 if db is None:
277 db = self.getclassdb(classname)
278 if not db.has_key(nodeid):
279 raise IndexError, "no such %s %s"%(classname, nodeid)
281 # check the uncommitted, destroyed nodes
282 if (self.destroyednodes.has_key(classname) and
283 self.destroyednodes[classname].has_key(nodeid)):
284 raise IndexError, "no such %s %s"%(classname, nodeid)
286 # decode
287 res = marshal.loads(db[nodeid])
289 # reverse the serialisation
290 res = self.unserialise(classname, res)
292 # store off in the cache dict
293 if cache:
294 cache_dict[nodeid] = res
296 return res
298 def destroynode(self, classname, nodeid):
299 '''Remove a node from the database. Called exclusively by the
300 destroy() method on Class.
301 '''
302 if __debug__:
303 print >>hyperdb.DEBUG, 'destroynode', (self, classname, nodeid)
305 # remove from cache and newnodes if it's there
306 if (self.cache.has_key(classname) and
307 self.cache[classname].has_key(nodeid)):
308 del self.cache[classname][nodeid]
309 if (self.newnodes.has_key(classname) and
310 self.newnodes[classname].has_key(nodeid)):
311 del self.newnodes[classname][nodeid]
313 # see if there's any obvious commit actions that we should get rid of
314 for entry in self.transactions[:]:
315 if entry[1][:2] == (classname, nodeid):
316 self.transactions.remove(entry)
318 # add to the destroyednodes map
319 self.destroyednodes.setdefault(classname, {})[nodeid] = 1
321 # add the destroy commit action
322 self.transactions.append((self.doDestroyNode, (classname, nodeid)))
324 def serialise(self, classname, node):
325 '''Copy the node contents, converting non-marshallable data into
326 marshallable data.
327 '''
328 if __debug__:
329 print >>hyperdb.DEBUG, 'serialise', classname, node
330 properties = self.getclass(classname).getprops()
331 d = {}
332 for k, v in node.items():
333 # if the property doesn't exist, or is the "retired" flag then
334 # it won't be in the properties dict
335 if not properties.has_key(k):
336 d[k] = v
337 continue
339 # get the property spec
340 prop = properties[k]
342 if isinstance(prop, Password):
343 d[k] = str(v)
344 elif isinstance(prop, Date) and v is not None:
345 d[k] = v.serialise()
346 elif isinstance(prop, Interval) and v is not None:
347 d[k] = v.serialise()
348 else:
349 d[k] = v
350 return d
352 def unserialise(self, classname, node):
353 '''Decode the marshalled node data
354 '''
355 if __debug__:
356 print >>hyperdb.DEBUG, 'unserialise', classname, node
357 properties = self.getclass(classname).getprops()
358 d = {}
359 for k, v in node.items():
360 # if the property doesn't exist, or is the "retired" flag then
361 # it won't be in the properties dict
362 if not properties.has_key(k):
363 d[k] = v
364 continue
366 # get the property spec
367 prop = properties[k]
369 if isinstance(prop, Date) and v is not None:
370 d[k] = date.Date(v)
371 elif isinstance(prop, Interval) and v is not None:
372 d[k] = date.Interval(v)
373 elif isinstance(prop, Password):
374 p = password.Password()
375 p.unpack(v)
376 d[k] = p
377 else:
378 d[k] = v
379 return d
381 def hasnode(self, classname, nodeid, db=None):
382 ''' determine if the database has a given node
383 '''
384 if __debug__:
385 print >>hyperdb.DEBUG, 'hasnode', (self, classname, nodeid, db)
387 # try the cache
388 cache = self.cache.setdefault(classname, {})
389 if cache.has_key(nodeid):
390 if __debug__:
391 print >>hyperdb.TRACE, 'has %s %s cached'%(classname, nodeid)
392 return 1
393 if __debug__:
394 print >>hyperdb.TRACE, 'has %s %s'%(classname, nodeid)
396 # not in the cache - check the database
397 if db is None:
398 db = self.getclassdb(classname)
399 res = db.has_key(nodeid)
400 return res
402 def countnodes(self, classname, db=None):
403 if __debug__:
404 print >>hyperdb.DEBUG, 'countnodes', (self, classname, db)
406 count = 0
408 # include the uncommitted nodes
409 if self.newnodes.has_key(classname):
410 count += len(self.newnodes[classname])
411 if self.destroyednodes.has_key(classname):
412 count -= len(self.destroyednodes[classname])
414 # and count those in the DB
415 if db is None:
416 db = self.getclassdb(classname)
417 count = count + len(db.keys())
418 return count
420 def getnodeids(self, classname, db=None):
421 if __debug__:
422 print >>hyperdb.DEBUG, 'getnodeids', (self, classname, db)
424 res = []
426 # start off with the new nodes
427 if self.newnodes.has_key(classname):
428 res += self.newnodes[classname].keys()
430 if db is None:
431 db = self.getclassdb(classname)
432 res = res + db.keys()
434 # remove the uncommitted, destroyed nodes
435 if self.destroyednodes.has_key(classname):
436 for nodeid in self.destroyednodes[classname].keys():
437 if db.has_key(nodeid):
438 res.remove(nodeid)
440 return res
443 #
444 # Files - special node properties
445 # inherited from FileStorage
447 #
448 # Journal
449 #
450 def addjournal(self, classname, nodeid, action, params):
451 ''' Journal the Action
452 'action' may be:
454 'create' or 'set' -- 'params' is a dictionary of property values
455 'link' or 'unlink' -- 'params' is (classname, nodeid, propname)
456 'retire' -- 'params' is None
457 '''
458 if __debug__:
459 print >>hyperdb.DEBUG, 'addjournal', (self, classname, nodeid,
460 action, params)
461 self.transactions.append((self.doSaveJournal, (classname, nodeid,
462 action, params)))
464 def getjournal(self, classname, nodeid):
465 ''' get the journal for id
467 Raise IndexError if the node doesn't exist (as per history()'s
468 API)
469 '''
470 if __debug__:
471 print >>hyperdb.DEBUG, 'getjournal', (self, classname, nodeid)
472 # attempt to open the journal - in some rare cases, the journal may
473 # not exist
474 try:
475 db = self.opendb('journals.%s'%classname, 'r')
476 except anydbm.error, error:
477 if str(error) == "need 'c' or 'n' flag to open new db":
478 raise IndexError, 'no such %s %s'%(classname, nodeid)
479 elif error.args[0] != 2:
480 raise
481 raise IndexError, 'no such %s %s'%(classname, nodeid)
482 try:
483 journal = marshal.loads(db[nodeid])
484 except KeyError:
485 db.close()
486 raise IndexError, 'no such %s %s'%(classname, nodeid)
487 db.close()
488 res = []
489 for nodeid, date_stamp, user, action, params in journal:
490 res.append((nodeid, date.Date(date_stamp), user, action, params))
491 return res
493 def pack(self, pack_before):
494 ''' Delete all journal entries except "create" before 'pack_before'.
495 '''
496 if __debug__:
497 print >>hyperdb.DEBUG, 'packjournal', (self, pack_before)
499 for classname in self.getclasses():
500 # get the journal db
501 db_name = 'journals.%s'%classname
502 path = os.path.join(os.getcwd(), self.dir, classname)
503 db_type = self.determine_db_type(path)
504 db = self.opendb(db_name, 'w')
506 for key in db.keys():
507 # get the journal for this db entry
508 journal = marshal.loads(db[key])
509 l = []
510 last_set_entry = None
511 for entry in journal:
512 # unpack the entry
513 (nodeid, date_stamp, self.journaltag, action,
514 params) = entry
515 date_stamp = date.Date(date_stamp)
516 # if the entry is after the pack date, _or_ the initial
517 # create entry, then it stays
518 if date_stamp > pack_before or action == 'create':
519 l.append(entry)
520 elif action == 'set':
521 # grab the last set entry to keep information on
522 # activity
523 last_set_entry = entry
524 if last_set_entry:
525 date_stamp = last_set_entry[1]
526 # if the last set entry was made after the pack date
527 # then it is already in the list
528 if date_stamp < pack_before:
529 l.append(last_set_entry)
530 db[key] = marshal.dumps(l)
531 if db_type == 'gdbm':
532 db.reorganize()
533 db.close()
536 #
537 # Basic transaction support
538 #
539 def commit(self):
540 ''' Commit the current transactions.
541 '''
542 if __debug__:
543 print >>hyperdb.DEBUG, 'commit', (self,)
544 # TODO: lock the DB
546 # keep a handle to all the database files opened
547 self.databases = {}
549 # now, do all the transactions
550 reindex = {}
551 for method, args in self.transactions:
552 reindex[method(*args)] = 1
554 # now close all the database files
555 for db in self.databases.values():
556 db.close()
557 del self.databases
558 # TODO: unlock the DB
560 # reindex the nodes that request it
561 for classname, nodeid in filter(None, reindex.keys()):
562 print >>hyperdb.DEBUG, 'commit.reindex', (classname, nodeid)
563 self.getclass(classname).index(nodeid)
565 # save the indexer state
566 self.indexer.save_index()
568 # all transactions committed, back to normal
569 self.cache = {}
570 self.dirtynodes = {}
571 self.newnodes = {}
572 self.destroyednodes = {}
573 self.transactions = []
575 def getCachedClassDB(self, classname):
576 ''' get the class db, looking in our cache of databases for commit
577 '''
578 # get the database handle
579 db_name = 'nodes.%s'%classname
580 if not self.databases.has_key(db_name):
581 self.databases[db_name] = self.getclassdb(classname, 'c')
582 return self.databases[db_name]
584 def doSaveNode(self, classname, nodeid, node):
585 if __debug__:
586 print >>hyperdb.DEBUG, 'doSaveNode', (self, classname, nodeid,
587 node)
589 db = self.getCachedClassDB(classname)
591 # now save the marshalled data
592 db[nodeid] = marshal.dumps(self.serialise(classname, node))
594 # return the classname, nodeid so we reindex this content
595 return (classname, nodeid)
597 def getCachedJournalDB(self, classname):
598 ''' get the journal db, looking in our cache of databases for commit
599 '''
600 # get the database handle
601 db_name = 'journals.%s'%classname
602 if not self.databases.has_key(db_name):
603 self.databases[db_name] = self.opendb(db_name, 'c')
604 return self.databases[db_name]
606 def doSaveJournal(self, classname, nodeid, action, params):
607 # handle supply of the special journalling parameters (usually
608 # supplied on importing an existing database)
609 if isinstance(params, type({})):
610 if params.has_key('creator'):
611 journaltag = self.user.get(params['creator'], 'username')
612 del params['creator']
613 else:
614 journaltag = self.journaltag
615 if params.has_key('created'):
616 journaldate = params['created'].serialise()
617 del params['created']
618 else:
619 journaldate = date.Date().serialise()
620 if params.has_key('activity'):
621 del params['activity']
623 # serialise the parameters now
624 if action in ('set', 'create'):
625 params = self.serialise(classname, params)
626 else:
627 journaltag = self.journaltag
628 journaldate = date.Date().serialise()
630 # create the journal entry
631 entry = (nodeid, journaldate, journaltag, action, params)
633 if __debug__:
634 print >>hyperdb.DEBUG, 'doSaveJournal', entry
636 db = self.getCachedJournalDB(classname)
638 # now insert the journal entry
639 if db.has_key(nodeid):
640 # append to existing
641 s = db[nodeid]
642 l = marshal.loads(s)
643 l.append(entry)
644 else:
645 l = [entry]
647 db[nodeid] = marshal.dumps(l)
649 def doDestroyNode(self, classname, nodeid):
650 if __debug__:
651 print >>hyperdb.DEBUG, 'doDestroyNode', (self, classname, nodeid)
653 # delete from the class database
654 db = self.getCachedClassDB(classname)
655 if db.has_key(nodeid):
656 del db[nodeid]
658 # delete from the database
659 db = self.getCachedJournalDB(classname)
660 if db.has_key(nodeid):
661 del db[nodeid]
663 # return the classname, nodeid so we reindex this content
664 return (classname, nodeid)
666 def rollback(self):
667 ''' Reverse all actions from the current transaction.
668 '''
669 if __debug__:
670 print >>hyperdb.DEBUG, 'rollback', (self, )
671 for method, args in self.transactions:
672 # delete temporary files
673 if method == self.doStoreFile:
674 self.rollbackStoreFile(*args)
675 self.cache = {}
676 self.dirtynodes = {}
677 self.newnodes = {}
678 self.destroyednodes = {}
679 self.transactions = []
681 _marker = []
682 class Class(hyperdb.Class):
683 '''The handle to a particular class of nodes in a hyperdatabase.'''
685 def __init__(self, db, classname, **properties):
686 '''Create a new class with a given name and property specification.
688 'classname' must not collide with the name of an existing class,
689 or a ValueError is raised. The keyword arguments in 'properties'
690 must map names to property objects, or a TypeError is raised.
691 '''
692 if (properties.has_key('creation') or properties.has_key('activity')
693 or properties.has_key('creator')):
694 raise ValueError, '"creation", "activity" and "creator" are '\
695 'reserved'
697 self.classname = classname
698 self.properties = properties
699 self.db = weakref.proxy(db) # use a weak ref to avoid circularity
700 self.key = ''
702 # should we journal changes (default yes)
703 self.do_journal = 1
705 # do the db-related init stuff
706 db.addclass(self)
708 self.auditors = {'create': [], 'set': [], 'retire': []}
709 self.reactors = {'create': [], 'set': [], 'retire': []}
711 def enableJournalling(self):
712 '''Turn journalling on for this class
713 '''
714 self.do_journal = 1
716 def disableJournalling(self):
717 '''Turn journalling off for this class
718 '''
719 self.do_journal = 0
721 # Editing nodes:
723 def create(self, **propvalues):
724 '''Create a new node of this class and return its id.
726 The keyword arguments in 'propvalues' map property names to values.
728 The values of arguments must be acceptable for the types of their
729 corresponding properties or a TypeError is raised.
731 If this class has a key property, it must be present and its value
732 must not collide with other key strings or a ValueError is raised.
734 Any other properties on this class that are missing from the
735 'propvalues' dictionary are set to None.
737 If an id in a link or multilink property does not refer to a valid
738 node, an IndexError is raised.
740 These operations trigger detectors and can be vetoed. Attempts
741 to modify the "creation" or "activity" properties cause a KeyError.
742 '''
743 if propvalues.has_key('id'):
744 raise KeyError, '"id" is reserved'
746 if self.db.journaltag is None:
747 raise DatabaseError, 'Database open read-only'
749 if propvalues.has_key('creation') or propvalues.has_key('activity'):
750 raise KeyError, '"creation" and "activity" are reserved'
752 self.fireAuditors('create', None, propvalues)
754 # new node's id
755 newid = self.db.newid(self.classname)
757 # validate propvalues
758 num_re = re.compile('^\d+$')
759 for key, value in propvalues.items():
760 if key == self.key:
761 try:
762 self.lookup(value)
763 except KeyError:
764 pass
765 else:
766 raise ValueError, 'node with key "%s" exists'%value
768 # try to handle this property
769 try:
770 prop = self.properties[key]
771 except KeyError:
772 raise KeyError, '"%s" has no property "%s"'%(self.classname,
773 key)
775 if value is not None and isinstance(prop, Link):
776 if type(value) != type(''):
777 raise ValueError, 'link value must be String'
778 link_class = self.properties[key].classname
779 # if it isn't a number, it's a key
780 if not num_re.match(value):
781 try:
782 value = self.db.classes[link_class].lookup(value)
783 except (TypeError, KeyError):
784 raise IndexError, 'new property "%s": %s not a %s'%(
785 key, value, link_class)
786 elif not self.db.getclass(link_class).hasnode(value):
787 raise IndexError, '%s has no node %s'%(link_class, value)
789 # save off the value
790 propvalues[key] = value
792 # register the link with the newly linked node
793 if self.do_journal and self.properties[key].do_journal:
794 self.db.addjournal(link_class, value, 'link',
795 (self.classname, newid, key))
797 elif isinstance(prop, Multilink):
798 if type(value) != type([]):
799 raise TypeError, 'new property "%s" not a list of ids'%key
801 # clean up and validate the list of links
802 link_class = self.properties[key].classname
803 l = []
804 for entry in value:
805 if type(entry) != type(''):
806 raise ValueError, '"%s" link value (%s) must be '\
807 'String'%(key, value)
808 # if it isn't a number, it's a key
809 if not num_re.match(entry):
810 try:
811 entry = self.db.classes[link_class].lookup(entry)
812 except (TypeError, KeyError):
813 raise IndexError, 'new property "%s": %s not a %s'%(
814 key, entry, self.properties[key].classname)
815 l.append(entry)
816 value = l
817 propvalues[key] = value
819 # handle additions
820 for nodeid in value:
821 if not self.db.getclass(link_class).hasnode(nodeid):
822 raise IndexError, '%s has no node %s'%(link_class,
823 nodeid)
824 # register the link with the newly linked node
825 if self.do_journal and self.properties[key].do_journal:
826 self.db.addjournal(link_class, nodeid, 'link',
827 (self.classname, newid, key))
829 elif isinstance(prop, String):
830 if type(value) != type(''):
831 raise TypeError, 'new property "%s" not a string'%key
833 elif isinstance(prop, Password):
834 if not isinstance(value, password.Password):
835 raise TypeError, 'new property "%s" not a Password'%key
837 elif isinstance(prop, Date):
838 if value is not None and not isinstance(value, date.Date):
839 raise TypeError, 'new property "%s" not a Date'%key
841 elif isinstance(prop, Interval):
842 if value is not None and not isinstance(value, date.Interval):
843 raise TypeError, 'new property "%s" not an Interval'%key
845 elif value is not None and isinstance(prop, Number):
846 try:
847 float(value)
848 except ValueError:
849 raise TypeError, 'new property "%s" not numeric'%key
851 elif value is not None and isinstance(prop, Boolean):
852 try:
853 int(value)
854 except ValueError:
855 raise TypeError, 'new property "%s" not boolean'%key
857 # make sure there's data where there needs to be
858 for key, prop in self.properties.items():
859 if propvalues.has_key(key):
860 continue
861 if key == self.key:
862 raise ValueError, 'key property "%s" is required'%key
863 if isinstance(prop, Multilink):
864 propvalues[key] = []
865 else:
866 propvalues[key] = None
868 # done
869 self.db.addnode(self.classname, newid, propvalues)
870 if self.do_journal:
871 self.db.addjournal(self.classname, newid, 'create', propvalues)
873 self.fireReactors('create', newid, None)
875 return newid
877 def export_list(self, propnames, nodeid):
878 ''' Export a node - generate a list of CSV-able data in the order
879 specified by propnames for the given node.
880 '''
881 properties = self.getprops()
882 l = []
883 for prop in propnames:
884 proptype = properties[prop]
885 value = self.get(nodeid, prop)
886 # "marshal" data where needed
887 if isinstance(proptype, hyperdb.Date):
888 value = value.get_tuple()
889 elif isinstance(proptype, hyperdb.Interval):
890 value = value.get_tuple()
891 elif isinstance(proptype, hyperdb.Password):
892 value = str(value)
893 l.append(repr(value))
894 return l
896 def import_list(self, propnames, proplist):
897 ''' Import a node - all information including "id" is present and
898 should not be sanity checked. Triggers are not triggered. The
899 journal should be initialised using the "creator" and "created"
900 information.
902 Return the nodeid of the node imported.
903 '''
904 if self.db.journaltag is None:
905 raise DatabaseError, 'Database open read-only'
906 properties = self.getprops()
908 # make the new node's property map
909 d = {}
910 for i in range(len(propnames)):
911 # Use eval to reverse the repr() used to output the CSV
912 value = eval(proplist[i])
914 # Figure the property for this column
915 propname = propnames[i]
916 prop = properties[propname]
918 # "unmarshal" where necessary
919 if propname == 'id':
920 newid = value
921 continue
922 elif isinstance(prop, hyperdb.Date):
923 value = date.Date(value)
924 elif isinstance(prop, hyperdb.Interval):
925 value = date.Interval(value)
926 elif isinstance(prop, hyperdb.Password):
927 pwd = password.Password()
928 pwd.unpack(value)
929 value = pwd
930 if value is not None:
931 d[propname] = value
933 # add
934 self.db.addnode(self.classname, newid, d)
935 self.db.addjournal(self.classname, newid, 'create', d)
936 return newid
938 def get(self, nodeid, propname, default=_marker, cache=1):
939 '''Get the value of a property on an existing node of this class.
941 'nodeid' must be the id of an existing node of this class or an
942 IndexError is raised. 'propname' must be the name of a property
943 of this class or a KeyError is raised.
945 'cache' indicates whether the transaction cache should be queried
946 for the node. If the node has been modified and you need to
947 determine what its values prior to modification are, you need to
948 set cache=0.
950 Attempts to get the "creation" or "activity" properties should
951 do the right thing.
952 '''
953 if propname == 'id':
954 return nodeid
956 if propname == 'creation':
957 if not self.do_journal:
958 raise ValueError, 'Journalling is disabled for this class'
959 journal = self.db.getjournal(self.classname, nodeid)
960 if journal:
961 return self.db.getjournal(self.classname, nodeid)[0][1]
962 else:
963 # on the strange chance that there's no journal
964 return date.Date()
965 if propname == 'activity':
966 if not self.do_journal:
967 raise ValueError, 'Journalling is disabled for this class'
968 journal = self.db.getjournal(self.classname, nodeid)
969 if journal:
970 return self.db.getjournal(self.classname, nodeid)[-1][1]
971 else:
972 # on the strange chance that there's no journal
973 return date.Date()
974 if propname == 'creator':
975 if not self.do_journal:
976 raise ValueError, 'Journalling is disabled for this class'
977 journal = self.db.getjournal(self.classname, nodeid)
978 if journal:
979 name = self.db.getjournal(self.classname, nodeid)[0][2]
980 else:
981 return None
982 return self.db.user.lookup(name)
984 # get the property (raises KeyErorr if invalid)
985 prop = self.properties[propname]
987 # get the node's dict
988 d = self.db.getnode(self.classname, nodeid, cache=cache)
990 if not d.has_key(propname):
991 if default is _marker:
992 if isinstance(prop, Multilink):
993 return []
994 else:
995 return None
996 else:
997 return default
999 # return a dupe of the list so code doesn't get confused
1000 if isinstance(prop, Multilink):
1001 return d[propname][:]
1003 return d[propname]
1005 # XXX not in spec
1006 def getnode(self, nodeid, cache=1):
1007 ''' Return a convenience wrapper for the node.
1009 'nodeid' must be the id of an existing node of this class or an
1010 IndexError is raised.
1012 'cache' indicates whether the transaction cache should be queried
1013 for the node. If the node has been modified and you need to
1014 determine what its values prior to modification are, you need to
1015 set cache=0.
1016 '''
1017 return Node(self, nodeid, cache=cache)
1019 def set(self, nodeid, **propvalues):
1020 '''Modify a property on an existing node of this class.
1022 'nodeid' must be the id of an existing node of this class or an
1023 IndexError is raised.
1025 Each key in 'propvalues' must be the name of a property of this
1026 class or a KeyError is raised.
1028 All values in 'propvalues' must be acceptable types for their
1029 corresponding properties or a TypeError is raised.
1031 If the value of the key property is set, it must not collide with
1032 other key strings or a ValueError is raised.
1034 If the value of a Link or Multilink property contains an invalid
1035 node id, a ValueError is raised.
1037 These operations trigger detectors and can be vetoed. Attempts
1038 to modify the "creation" or "activity" properties cause a KeyError.
1039 '''
1040 if not propvalues:
1041 return propvalues
1043 if propvalues.has_key('creation') or propvalues.has_key('activity'):
1044 raise KeyError, '"creation" and "activity" are reserved'
1046 if propvalues.has_key('id'):
1047 raise KeyError, '"id" is reserved'
1049 if self.db.journaltag is None:
1050 raise DatabaseError, 'Database open read-only'
1052 self.fireAuditors('set', nodeid, propvalues)
1053 # Take a copy of the node dict so that the subsequent set
1054 # operation doesn't modify the oldvalues structure.
1055 try:
1056 # try not using the cache initially
1057 oldvalues = copy.deepcopy(self.db.getnode(self.classname, nodeid,
1058 cache=0))
1059 except IndexError:
1060 # this will be needed if somone does a create() and set()
1061 # with no intervening commit()
1062 oldvalues = copy.deepcopy(self.db.getnode(self.classname, nodeid))
1064 node = self.db.getnode(self.classname, nodeid)
1065 if node.has_key(self.db.RETIRED_FLAG):
1066 raise IndexError
1067 num_re = re.compile('^\d+$')
1069 # if the journal value is to be different, store it in here
1070 journalvalues = {}
1072 for propname, value in propvalues.items():
1073 # check to make sure we're not duplicating an existing key
1074 if propname == self.key and node[propname] != value:
1075 try:
1076 self.lookup(value)
1077 except KeyError:
1078 pass
1079 else:
1080 raise ValueError, 'node with key "%s" exists'%value
1082 # this will raise the KeyError if the property isn't valid
1083 # ... we don't use getprops() here because we only care about
1084 # the writeable properties.
1085 prop = self.properties[propname]
1087 # if the value's the same as the existing value, no sense in
1088 # doing anything
1089 if node.has_key(propname) and value == node[propname]:
1090 del propvalues[propname]
1091 continue
1093 # do stuff based on the prop type
1094 if isinstance(prop, Link):
1095 link_class = prop.classname
1096 # if it isn't a number, it's a key
1097 if value is not None and not isinstance(value, type('')):
1098 raise ValueError, 'property "%s" link value be a string'%(
1099 propname)
1100 if isinstance(value, type('')) and not num_re.match(value):
1101 try:
1102 value = self.db.classes[link_class].lookup(value)
1103 except (TypeError, KeyError):
1104 raise IndexError, 'new property "%s": %s not a %s'%(
1105 propname, value, prop.classname)
1107 if (value is not None and
1108 not self.db.getclass(link_class).hasnode(value)):
1109 raise IndexError, '%s has no node %s'%(link_class, value)
1111 if self.do_journal and prop.do_journal:
1112 # register the unlink with the old linked node
1113 if node[propname] is not None:
1114 self.db.addjournal(link_class, node[propname], 'unlink',
1115 (self.classname, nodeid, propname))
1117 # register the link with the newly linked node
1118 if value is not None:
1119 self.db.addjournal(link_class, value, 'link',
1120 (self.classname, nodeid, propname))
1122 elif isinstance(prop, Multilink):
1123 if type(value) != type([]):
1124 raise TypeError, 'new property "%s" not a list of'\
1125 ' ids'%propname
1126 link_class = self.properties[propname].classname
1127 l = []
1128 for entry in value:
1129 # if it isn't a number, it's a key
1130 if type(entry) != type(''):
1131 raise ValueError, 'new property "%s" link value ' \
1132 'must be a string'%propname
1133 if not num_re.match(entry):
1134 try:
1135 entry = self.db.classes[link_class].lookup(entry)
1136 except (TypeError, KeyError):
1137 raise IndexError, 'new property "%s": %s not a %s'%(
1138 propname, entry,
1139 self.properties[propname].classname)
1140 l.append(entry)
1141 value = l
1142 propvalues[propname] = value
1144 # figure the journal entry for this property
1145 add = []
1146 remove = []
1148 # handle removals
1149 if node.has_key(propname):
1150 l = node[propname]
1151 else:
1152 l = []
1153 for id in l[:]:
1154 if id in value:
1155 continue
1156 # register the unlink with the old linked node
1157 if self.do_journal and self.properties[propname].do_journal:
1158 self.db.addjournal(link_class, id, 'unlink',
1159 (self.classname, nodeid, propname))
1160 l.remove(id)
1161 remove.append(id)
1163 # handle additions
1164 for id in value:
1165 if not self.db.getclass(link_class).hasnode(id):
1166 raise IndexError, '%s has no node %s'%(link_class, id)
1167 if id in l:
1168 continue
1169 # register the link with the newly linked node
1170 if self.do_journal and self.properties[propname].do_journal:
1171 self.db.addjournal(link_class, id, 'link',
1172 (self.classname, nodeid, propname))
1173 l.append(id)
1174 add.append(id)
1176 # figure the journal entry
1177 l = []
1178 if add:
1179 l.append(('+', add))
1180 if remove:
1181 l.append(('-', remove))
1182 if l:
1183 journalvalues[propname] = tuple(l)
1185 elif isinstance(prop, String):
1186 if value is not None and type(value) != type(''):
1187 raise TypeError, 'new property "%s" not a string'%propname
1189 elif isinstance(prop, Password):
1190 if not isinstance(value, password.Password):
1191 raise TypeError, 'new property "%s" not a Password'%propname
1192 propvalues[propname] = value
1194 elif value is not None and isinstance(prop, Date):
1195 if not isinstance(value, date.Date):
1196 raise TypeError, 'new property "%s" not a Date'% propname
1197 propvalues[propname] = value
1199 elif value is not None and isinstance(prop, Interval):
1200 if not isinstance(value, date.Interval):
1201 raise TypeError, 'new property "%s" not an '\
1202 'Interval'%propname
1203 propvalues[propname] = value
1205 elif value is not None and isinstance(prop, Number):
1206 try:
1207 float(value)
1208 except ValueError:
1209 raise TypeError, 'new property "%s" not numeric'%propname
1211 elif value is not None and isinstance(prop, Boolean):
1212 try:
1213 int(value)
1214 except ValueError:
1215 raise TypeError, 'new property "%s" not boolean'%propname
1217 node[propname] = value
1219 # nothing to do?
1220 if not propvalues:
1221 return propvalues
1223 # do the set, and journal it
1224 self.db.setnode(self.classname, nodeid, node)
1226 if self.do_journal:
1227 propvalues.update(journalvalues)
1228 self.db.addjournal(self.classname, nodeid, 'set', propvalues)
1230 self.fireReactors('set', nodeid, oldvalues)
1232 return propvalues
1234 def retire(self, nodeid):
1235 '''Retire a node.
1237 The properties on the node remain available from the get() method,
1238 and the node's id is never reused.
1240 Retired nodes are not returned by the find(), list(), or lookup()
1241 methods, and other nodes may reuse the values of their key properties.
1243 These operations trigger detectors and can be vetoed. Attempts
1244 to modify the "creation" or "activity" properties cause a KeyError.
1245 '''
1246 if self.db.journaltag is None:
1247 raise DatabaseError, 'Database open read-only'
1249 self.fireAuditors('retire', nodeid, None)
1251 node = self.db.getnode(self.classname, nodeid)
1252 node[self.db.RETIRED_FLAG] = 1
1253 self.db.setnode(self.classname, nodeid, node)
1254 if self.do_journal:
1255 self.db.addjournal(self.classname, nodeid, 'retired', None)
1257 self.fireReactors('retire', nodeid, None)
1259 def is_retired(self, nodeid):
1260 '''Return true if the node is retired.
1261 '''
1262 node = self.db.getnode(cn, nodeid, cldb)
1263 if node.has_key(self.db.RETIRED_FLAG):
1264 return 1
1265 return 0
1267 def destroy(self, nodeid):
1268 '''Destroy a node.
1270 WARNING: this method should never be used except in extremely rare
1271 situations where there could never be links to the node being
1272 deleted
1273 WARNING: use retire() instead
1274 WARNING: the properties of this node will not be available ever again
1275 WARNING: really, use retire() instead
1277 Well, I think that's enough warnings. This method exists mostly to
1278 support the session storage of the cgi interface.
1279 '''
1280 if self.db.journaltag is None:
1281 raise DatabaseError, 'Database open read-only'
1282 self.db.destroynode(self.classname, nodeid)
1284 def history(self, nodeid):
1285 '''Retrieve the journal of edits on a particular node.
1287 'nodeid' must be the id of an existing node of this class or an
1288 IndexError is raised.
1290 The returned list contains tuples of the form
1292 (date, tag, action, params)
1294 'date' is a Timestamp object specifying the time of the change and
1295 'tag' is the journaltag specified when the database was opened.
1296 '''
1297 if not self.do_journal:
1298 raise ValueError, 'Journalling is disabled for this class'
1299 return self.db.getjournal(self.classname, nodeid)
1301 # Locating nodes:
1302 def hasnode(self, nodeid):
1303 '''Determine if the given nodeid actually exists
1304 '''
1305 return self.db.hasnode(self.classname, nodeid)
1307 def setkey(self, propname):
1308 '''Select a String property of this class to be the key property.
1310 'propname' must be the name of a String property of this class or
1311 None, or a TypeError is raised. The values of the key property on
1312 all existing nodes must be unique or a ValueError is raised. If the
1313 property doesn't exist, KeyError is raised.
1314 '''
1315 prop = self.getprops()[propname]
1316 if not isinstance(prop, String):
1317 raise TypeError, 'key properties must be String'
1318 self.key = propname
1320 def getkey(self):
1321 '''Return the name of the key property for this class or None.'''
1322 return self.key
1324 def labelprop(self, default_to_id=0):
1325 ''' Return the property name for a label for the given node.
1327 This method attempts to generate a consistent label for the node.
1328 It tries the following in order:
1329 1. key property
1330 2. "name" property
1331 3. "title" property
1332 4. first property from the sorted property name list
1333 '''
1334 k = self.getkey()
1335 if k:
1336 return k
1337 props = self.getprops()
1338 if props.has_key('name'):
1339 return 'name'
1340 elif props.has_key('title'):
1341 return 'title'
1342 if default_to_id:
1343 return 'id'
1344 props = props.keys()
1345 props.sort()
1346 return props[0]
1348 # TODO: set up a separate index db file for this? profile?
1349 def lookup(self, keyvalue):
1350 '''Locate a particular node by its key property and return its id.
1352 If this class has no key property, a TypeError is raised. If the
1353 'keyvalue' matches one of the values for the key property among
1354 the nodes in this class, the matching node's id is returned;
1355 otherwise a KeyError is raised.
1356 '''
1357 if not self.key:
1358 raise TypeError, 'No key property set'
1359 cldb = self.db.getclassdb(self.classname)
1360 try:
1361 for nodeid in self.db.getnodeids(self.classname, cldb):
1362 node = self.db.getnode(self.classname, nodeid, cldb)
1363 if node.has_key(self.db.RETIRED_FLAG):
1364 continue
1365 if node[self.key] == keyvalue:
1366 cldb.close()
1367 return nodeid
1368 finally:
1369 cldb.close()
1370 raise KeyError, keyvalue
1372 # XXX: change from spec - allows multiple props to match
1373 def find(self, **propspec):
1374 '''Get the ids of nodes in this class which link to the given nodes.
1376 'propspec' consists of keyword args propname={nodeid:1,}
1377 'propname' must be the name of a property in this class, or a
1378 KeyError is raised. That property must be a Link or Multilink
1379 property, or a TypeError is raised.
1381 Any node in this class whose 'propname' property links to any of the
1382 nodeids will be returned. Used by the full text indexing, which knows
1383 that "foo" occurs in msg1, msg3 and file7, so we have hits on these issues:
1384 db.issue.find(messages={'1':1,'3':1}, files={'7':1})
1385 '''
1386 propspec = propspec.items()
1387 for propname, nodeids in propspec:
1388 # check the prop is OK
1389 prop = self.properties[propname]
1390 if not isinstance(prop, Link) and not isinstance(prop, Multilink):
1391 raise TypeError, "'%s' not a Link/Multilink property"%propname
1393 # ok, now do the find
1394 cldb = self.db.getclassdb(self.classname)
1395 l = []
1396 try:
1397 for id in self.db.getnodeids(self.classname, db=cldb):
1398 node = self.db.getnode(self.classname, id, db=cldb)
1399 if node.has_key(self.db.RETIRED_FLAG):
1400 continue
1401 for propname, nodeids in propspec:
1402 # can't test if the node doesn't have this property
1403 if not node.has_key(propname):
1404 continue
1405 if type(nodeids) is type(''):
1406 nodeids = {nodeids:1}
1407 prop = self.properties[propname]
1408 value = node[propname]
1409 if isinstance(prop, Link) and nodeids.has_key(value):
1410 l.append(id)
1411 break
1412 elif isinstance(prop, Multilink):
1413 hit = 0
1414 for v in value:
1415 if nodeids.has_key(v):
1416 l.append(id)
1417 hit = 1
1418 break
1419 if hit:
1420 break
1421 finally:
1422 cldb.close()
1423 return l
1425 def stringFind(self, **requirements):
1426 '''Locate a particular node by matching a set of its String
1427 properties in a caseless search.
1429 If the property is not a String property, a TypeError is raised.
1431 The return is a list of the id of all nodes that match.
1432 '''
1433 for propname in requirements.keys():
1434 prop = self.properties[propname]
1435 if isinstance(not prop, String):
1436 raise TypeError, "'%s' not a String property"%propname
1437 requirements[propname] = requirements[propname].lower()
1438 l = []
1439 cldb = self.db.getclassdb(self.classname)
1440 try:
1441 for nodeid in self.db.getnodeids(self.classname, cldb):
1442 node = self.db.getnode(self.classname, nodeid, cldb)
1443 if node.has_key(self.db.RETIRED_FLAG):
1444 continue
1445 for key, value in requirements.items():
1446 if node[key] is None or node[key].lower() != value:
1447 break
1448 else:
1449 l.append(nodeid)
1450 finally:
1451 cldb.close()
1452 return l
1454 def list(self):
1455 ''' Return a list of the ids of the active nodes in this class.
1456 '''
1457 l = []
1458 cn = self.classname
1459 cldb = self.db.getclassdb(cn)
1460 try:
1461 for nodeid in self.db.getnodeids(cn, cldb):
1462 node = self.db.getnode(cn, nodeid, cldb)
1463 if node.has_key(self.db.RETIRED_FLAG):
1464 continue
1465 l.append(nodeid)
1466 finally:
1467 cldb.close()
1468 l.sort()
1469 return l
1471 def filter(self, search_matches, filterspec, sort, group,
1472 num_re = re.compile('^\d+$')):
1473 ''' Return a list of the ids of the active nodes in this class that
1474 match the 'filter' spec, sorted by the group spec and then the
1475 sort spec.
1477 "filterspec" is {propname: value(s)}
1478 "sort" and "group" are (dir, prop) where dir is '+', '-' or None
1479 and prop is a prop name or None
1480 "search_matches" is {nodeid: marker}
1481 '''
1482 cn = self.classname
1484 # optimise filterspec
1485 l = []
1486 props = self.getprops()
1487 LINK = 0
1488 MULTILINK = 1
1489 STRING = 2
1490 OTHER = 6
1491 for k, v in filterspec.items():
1492 propclass = props[k]
1493 if isinstance(propclass, Link):
1494 if type(v) is not type([]):
1495 v = [v]
1496 # replace key values with node ids
1497 u = []
1498 link_class = self.db.classes[propclass.classname]
1499 for entry in v:
1500 if entry == '-1': entry = None
1501 elif not num_re.match(entry):
1502 try:
1503 entry = link_class.lookup(entry)
1504 except (TypeError,KeyError):
1505 raise ValueError, 'property "%s": %s not a %s'%(
1506 k, entry, self.properties[k].classname)
1507 u.append(entry)
1509 l.append((LINK, k, u))
1510 elif isinstance(propclass, Multilink):
1511 if type(v) is not type([]):
1512 v = [v]
1513 # replace key values with node ids
1514 u = []
1515 link_class = self.db.classes[propclass.classname]
1516 for entry in v:
1517 if not num_re.match(entry):
1518 try:
1519 entry = link_class.lookup(entry)
1520 except (TypeError,KeyError):
1521 raise ValueError, 'new property "%s": %s not a %s'%(
1522 k, entry, self.properties[k].classname)
1523 u.append(entry)
1524 l.append((MULTILINK, k, u))
1525 elif isinstance(propclass, String):
1526 # simple glob searching
1527 v = re.sub(r'([\|\{\}\\\.\+\[\]\(\)])', r'\\\1', v)
1528 v = v.replace('?', '.')
1529 v = v.replace('*', '.*?')
1530 l.append((STRING, k, re.compile(v, re.I)))
1531 elif isinstance(propclass, Boolean):
1532 if type(v) is type(''):
1533 bv = v.lower() in ('yes', 'true', 'on', '1')
1534 else:
1535 bv = v
1536 l.append((OTHER, k, bv))
1537 elif isinstance(propclass, Number):
1538 l.append((OTHER, k, int(v)))
1539 else:
1540 l.append((OTHER, k, v))
1541 filterspec = l
1543 # now, find all the nodes that are active and pass filtering
1544 l = []
1545 cldb = self.db.getclassdb(cn)
1546 try:
1547 # TODO: only full-scan once (use items())
1548 for nodeid in self.db.getnodeids(cn, cldb):
1549 node = self.db.getnode(cn, nodeid, cldb)
1550 if node.has_key(self.db.RETIRED_FLAG):
1551 continue
1552 # apply filter
1553 for t, k, v in filterspec:
1554 # make sure the node has the property
1555 if not node.has_key(k):
1556 # this node doesn't have this property, so reject it
1557 break
1559 # now apply the property filter
1560 if t == LINK:
1561 # link - if this node's property doesn't appear in the
1562 # filterspec's nodeid list, skip it
1563 if node[k] not in v:
1564 break
1565 elif t == MULTILINK:
1566 # multilink - if any of the nodeids required by the
1567 # filterspec aren't in this node's property, then skip
1568 # it
1569 have = node[k]
1570 for want in v:
1571 if want not in have:
1572 break
1573 else:
1574 continue
1575 break
1576 elif t == STRING:
1577 # RE search
1578 if node[k] is None or not v.search(node[k]):
1579 break
1580 elif t == OTHER:
1581 # straight value comparison for the other types
1582 if node[k] != v:
1583 break
1584 else:
1585 l.append((nodeid, node))
1586 finally:
1587 cldb.close()
1588 l.sort()
1590 # filter based on full text search
1591 if search_matches is not None:
1592 k = []
1593 for v in l:
1594 if search_matches.has_key(v[0]):
1595 k.append(v)
1596 l = k
1598 # now, sort the result
1599 def sortfun(a, b, sort=sort, group=group, properties=self.getprops(),
1600 db = self.db, cl=self):
1601 a_id, an = a
1602 b_id, bn = b
1603 # sort by group and then sort
1604 for dir, prop in group, sort:
1605 if dir is None: continue
1607 # sorting is class-specific
1608 propclass = properties[prop]
1610 # handle the properties that might be "faked"
1611 # also, handle possible missing properties
1612 try:
1613 if not an.has_key(prop):
1614 an[prop] = cl.get(a_id, prop)
1615 av = an[prop]
1616 except KeyError:
1617 # the node doesn't have a value for this property
1618 if isinstance(propclass, Multilink): av = []
1619 else: av = ''
1620 try:
1621 if not bn.has_key(prop):
1622 bn[prop] = cl.get(b_id, prop)
1623 bv = bn[prop]
1624 except KeyError:
1625 # the node doesn't have a value for this property
1626 if isinstance(propclass, Multilink): bv = []
1627 else: bv = ''
1629 # String and Date values are sorted in the natural way
1630 if isinstance(propclass, String):
1631 # clean up the strings
1632 if av and av[0] in string.uppercase:
1633 av = an[prop] = av.lower()
1634 if bv and bv[0] in string.uppercase:
1635 bv = bn[prop] = bv.lower()
1636 if (isinstance(propclass, String) or
1637 isinstance(propclass, Date)):
1638 # it might be a string that's really an integer
1639 try:
1640 av = int(av)
1641 bv = int(bv)
1642 except:
1643 pass
1644 if dir == '+':
1645 r = cmp(av, bv)
1646 if r != 0: return r
1647 elif dir == '-':
1648 r = cmp(bv, av)
1649 if r != 0: return r
1651 # Link properties are sorted according to the value of
1652 # the "order" property on the linked nodes if it is
1653 # present; or otherwise on the key string of the linked
1654 # nodes; or finally on the node ids.
1655 elif isinstance(propclass, Link):
1656 link = db.classes[propclass.classname]
1657 if av is None and bv is not None: return -1
1658 if av is not None and bv is None: return 1
1659 if av is None and bv is None: continue
1660 if link.getprops().has_key('order'):
1661 if dir == '+':
1662 r = cmp(link.get(av, 'order'),
1663 link.get(bv, 'order'))
1664 if r != 0: return r
1665 elif dir == '-':
1666 r = cmp(link.get(bv, 'order'),
1667 link.get(av, 'order'))
1668 if r != 0: return r
1669 elif link.getkey():
1670 key = link.getkey()
1671 if dir == '+':
1672 r = cmp(link.get(av, key), link.get(bv, key))
1673 if r != 0: return r
1674 elif dir == '-':
1675 r = cmp(link.get(bv, key), link.get(av, key))
1676 if r != 0: return r
1677 else:
1678 if dir == '+':
1679 r = cmp(av, bv)
1680 if r != 0: return r
1681 elif dir == '-':
1682 r = cmp(bv, av)
1683 if r != 0: return r
1685 # Multilink properties are sorted according to how many
1686 # links are present.
1687 elif isinstance(propclass, Multilink):
1688 if dir == '+':
1689 r = cmp(len(av), len(bv))
1690 if r != 0: return r
1691 elif dir == '-':
1692 r = cmp(len(bv), len(av))
1693 if r != 0: return r
1694 elif isinstance(propclass, Number) or isinstance(propclass, Boolean):
1695 if dir == '+':
1696 r = cmp(av, bv)
1697 elif dir == '-':
1698 r = cmp(bv, av)
1700 # end for dir, prop in sort, group:
1701 # if all else fails, compare the ids
1702 return cmp(a[0], b[0])
1704 l.sort(sortfun)
1705 return [i[0] for i in l]
1707 def count(self):
1708 '''Get the number of nodes in this class.
1710 If the returned integer is 'numnodes', the ids of all the nodes
1711 in this class run from 1 to numnodes, and numnodes+1 will be the
1712 id of the next node to be created in this class.
1713 '''
1714 return self.db.countnodes(self.classname)
1716 # Manipulating properties:
1718 def getprops(self, protected=1):
1719 '''Return a dictionary mapping property names to property objects.
1720 If the "protected" flag is true, we include protected properties -
1721 those which may not be modified.
1723 In addition to the actual properties on the node, these
1724 methods provide the "creation" and "activity" properties. If the
1725 "protected" flag is true, we include protected properties - those
1726 which may not be modified.
1727 '''
1728 d = self.properties.copy()
1729 if protected:
1730 d['id'] = String()
1731 d['creation'] = hyperdb.Date()
1732 d['activity'] = hyperdb.Date()
1733 d['creator'] = hyperdb.Link("user")
1734 return d
1736 def addprop(self, **properties):
1737 '''Add properties to this class.
1739 The keyword arguments in 'properties' must map names to property
1740 objects, or a TypeError is raised. None of the keys in 'properties'
1741 may collide with the names of existing properties, or a ValueError
1742 is raised before any properties have been added.
1743 '''
1744 for key in properties.keys():
1745 if self.properties.has_key(key):
1746 raise ValueError, key
1747 self.properties.update(properties)
1749 def index(self, nodeid):
1750 '''Add (or refresh) the node to search indexes
1751 '''
1752 # find all the String properties that have indexme
1753 for prop, propclass in self.getprops().items():
1754 if isinstance(propclass, String) and propclass.indexme:
1755 try:
1756 value = str(self.get(nodeid, prop))
1757 except IndexError:
1758 # node no longer exists - entry should be removed
1759 self.db.indexer.purge_entry((self.classname, nodeid, prop))
1760 else:
1761 # and index them under (classname, nodeid, property)
1762 self.db.indexer.add_text((self.classname, nodeid, prop),
1763 value)
1765 #
1766 # Detector interface
1767 #
1768 def audit(self, event, detector):
1769 '''Register a detector
1770 '''
1771 l = self.auditors[event]
1772 if detector not in l:
1773 self.auditors[event].append(detector)
1775 def fireAuditors(self, action, nodeid, newvalues):
1776 '''Fire all registered auditors.
1777 '''
1778 for audit in self.auditors[action]:
1779 audit(self.db, self, nodeid, newvalues)
1781 def react(self, event, detector):
1782 '''Register a detector
1783 '''
1784 l = self.reactors[event]
1785 if detector not in l:
1786 self.reactors[event].append(detector)
1788 def fireReactors(self, action, nodeid, oldvalues):
1789 '''Fire all registered reactors.
1790 '''
1791 for react in self.reactors[action]:
1792 react(self.db, self, nodeid, oldvalues)
1794 class FileClass(Class):
1795 '''This class defines a large chunk of data. To support this, it has a
1796 mandatory String property "content" which is typically saved off
1797 externally to the hyperdb.
1799 The default MIME type of this data is defined by the
1800 "default_mime_type" class attribute, which may be overridden by each
1801 node if the class defines a "type" String property.
1802 '''
1803 default_mime_type = 'text/plain'
1805 def create(self, **propvalues):
1806 ''' snaffle the file propvalue and store in a file
1807 '''
1808 content = propvalues['content']
1809 del propvalues['content']
1810 newid = Class.create(self, **propvalues)
1811 self.db.storefile(self.classname, newid, None, content)
1812 return newid
1814 def import_list(self, propnames, proplist):
1815 ''' Trap the "content" property...
1816 '''
1817 # dupe this list so we don't affect others
1818 propnames = propnames[:]
1820 # extract the "content" property from the proplist
1821 i = propnames.index('content')
1822 content = proplist[i]
1823 del propnames[i]
1824 del proplist[i]
1826 # do the normal import
1827 newid = Class.import_list(self, propnames, proplist)
1829 # save off the "content" file
1830 self.db.storefile(self.classname, newid, None, content)
1831 return newid
1833 def get(self, nodeid, propname, default=_marker, cache=1):
1834 ''' trap the content propname and get it from the file
1835 '''
1837 poss_msg = 'Possibly a access right configuration problem.'
1838 if propname == 'content':
1839 try:
1840 return self.db.getfile(self.classname, nodeid, None)
1841 except IOError, (strerror):
1842 # BUG: by catching this we donot see an error in the log.
1843 return 'ERROR reading file: %s%s\n%s\n%s'%(
1844 self.classname, nodeid, poss_msg, strerror)
1845 if default is not _marker:
1846 return Class.get(self, nodeid, propname, default, cache=cache)
1847 else:
1848 return Class.get(self, nodeid, propname, cache=cache)
1850 def getprops(self, protected=1):
1851 ''' In addition to the actual properties on the node, these methods
1852 provide the "content" property. If the "protected" flag is true,
1853 we include protected properties - those which may not be
1854 modified.
1855 '''
1856 d = Class.getprops(self, protected=protected).copy()
1857 if protected:
1858 d['content'] = hyperdb.String()
1859 return d
1861 def index(self, nodeid):
1862 ''' Index the node in the search index.
1864 We want to index the content in addition to the normal String
1865 property indexing.
1866 '''
1867 # perform normal indexing
1868 Class.index(self, nodeid)
1870 # get the content to index
1871 content = self.get(nodeid, 'content')
1873 # figure the mime type
1874 if self.properties.has_key('type'):
1875 mime_type = self.get(nodeid, 'type')
1876 else:
1877 mime_type = self.default_mime_type
1879 # and index!
1880 self.db.indexer.add_text((self.classname, nodeid, 'content'), content,
1881 mime_type)
1883 # XXX deviation from spec - was called ItemClass
1884 class IssueClass(Class, roundupdb.IssueClass):
1885 # Overridden methods:
1886 def __init__(self, db, classname, **properties):
1887 '''The newly-created class automatically includes the "messages",
1888 "files", "nosy", and "superseder" properties. If the 'properties'
1889 dictionary attempts to specify any of these properties or a
1890 "creation" or "activity" property, a ValueError is raised.
1891 '''
1892 if not properties.has_key('title'):
1893 properties['title'] = hyperdb.String(indexme='yes')
1894 if not properties.has_key('messages'):
1895 properties['messages'] = hyperdb.Multilink("msg")
1896 if not properties.has_key('files'):
1897 properties['files'] = hyperdb.Multilink("file")
1898 if not properties.has_key('nosy'):
1899 # note: journalling is turned off as it really just wastes
1900 # space. this behaviour may be overridden in an instance
1901 properties['nosy'] = hyperdb.Multilink("user", do_journal="no")
1902 if not properties.has_key('superseder'):
1903 properties['superseder'] = hyperdb.Multilink(classname)
1904 Class.__init__(self, db, classname, **properties)
1906 #
1907 #$Log: not supported by cvs2svn $
1908 #Revision 1.66 2002/09/01 04:32:30 richard
1909 #. Lots of cleanup in the classic html (stylesheet, search page, index page, ...)
1910 #. Reinstated searching, but not query saving yet
1911 #. Filtering only allows sorting and grouping by one property - all backends
1912 # now implement this behaviour.
1913 #. Nosy list journalling turned off by default, everything else is on.
1914 #. Added some convenience methods (reverse, propchanged, [item] accesses, ...)
1915 #. Did I mention the stylesheet is much cleaner now? :)
1916 #
1917 #Revision 1.65 2002/08/30 08:35:45 richard
1918 #minor edits
1919 #
1920 #Revision 1.64 2002/08/22 07:57:11 richard
1921 #Consistent quoting
1922 #
1923 #Revision 1.63 2002/08/22 04:42:28 richard
1924 #use more robust date stamp comparisons in pack(), make journal smaller too
1925 #
1926 #Revision 1.62 2002/08/21 07:07:27 richard
1927 #In preparing to turn back on link/unlink journal events (by default these
1928 #are turned off) I've:
1929 #- fixed back_anydbm so it can journal those events again (had broken it
1930 # with recent changes)
1931 #- changed the serialisation format for dates and intervals to use a
1932 # numbers-only (and sign for Intervals) string instead of tuple-of-ints.
1933 # Much smaller.
1934 #
1935 #Revision 1.61 2002/08/19 02:53:27 richard
1936 #full database export and import is done
1937 #
1938 #Revision 1.60 2002/08/19 00:23:19 richard
1939 #handle "unset" initial Link values (!)
1940 #
1941 #Revision 1.59 2002/08/16 04:28:13 richard
1942 #added is_retired query to Class
1943 #
1944 #Revision 1.58 2002/08/01 15:06:24 gmcm
1945 #Use same regex to split search terms as used to index text.
1946 #Fix to back_metakit for not changing journaltag on reopen.
1947 #Fix htmltemplate's do_link so [No <whatever>] strings are href'd.
1948 #Fix bogus "nosy edited ok" msg - the **d syntax does NOT share d between caller and callee.
1949 #
1950 #Revision 1.57 2002/07/31 23:57:36 richard
1951 # . web forms may now unset Link values (like assignedto)
1952 #
1953 #Revision 1.56 2002/07/31 22:04:33 richard
1954 #cleanup
1955 #
1956 #Revision 1.55 2002/07/30 08:22:38 richard
1957 #Session storage in the hyperdb was horribly, horribly inefficient. We use
1958 #a simple anydbm wrapper now - which could be overridden by the metakit
1959 #backend or RDB backend if necessary.
1960 #Much, much better.
1961 #
1962 #Revision 1.54 2002/07/26 08:26:59 richard
1963 #Very close now. The cgi and mailgw now use the new security API. The two
1964 #templates have been migrated to that setup. Lots of unit tests. Still some
1965 #issue in the web form for editing Roles assigned to users.
1966 #
1967 #Revision 1.53 2002/07/25 07:14:06 richard
1968 #Bugger it. Here's the current shape of the new security implementation.
1969 #Still to do:
1970 # . call the security funcs from cgi and mailgw
1971 # . change shipped templates to include correct initialisation and remove
1972 # the old config vars
1973 #... that seems like a lot. The bulk of the work has been done though. Honest :)
1974 #
1975 #Revision 1.52 2002/07/19 03:36:34 richard
1976 #Implemented the destroy() method needed by the session database (and possibly
1977 #others). At the same time, I removed the leading underscores from the hyperdb
1978 #methods that Really Didn't Need Them.
1979 #The journal also raises IndexError now for all situations where there is a
1980 #request for the journal of a node that doesn't have one. It used to return
1981 #[] in _some_ situations, but not all. This _may_ break code, but the tests
1982 #pass...
1983 #
1984 #Revision 1.51 2002/07/18 23:07:08 richard
1985 #Unit tests and a few fixes.
1986 #
1987 #Revision 1.50 2002/07/18 11:50:58 richard
1988 #added tests for number type too
1989 #
1990 #Revision 1.49 2002/07/18 11:41:10 richard
1991 #added tests for boolean type, and fixes to anydbm backend
1992 #
1993 #Revision 1.48 2002/07/18 11:17:31 gmcm
1994 #Add Number and Boolean types to hyperdb.
1995 #Add conversion cases to web, mail & admin interfaces.
1996 #Add storage/serialization cases to back_anydbm & back_metakit.
1997 #
1998 #Revision 1.47 2002/07/14 23:18:20 richard
1999 #. fixed the journal bloat from multilink changes - we just log the add or
2000 # remove operations, not the whole list
2001 #
2002 #Revision 1.46 2002/07/14 06:06:34 richard
2003 #Did some old TODOs
2004 #
2005 #Revision 1.45 2002/07/14 04:03:14 richard
2006 #Implemented a switch to disable journalling for a Class. CGI session
2007 #database now uses it.
2008 #
2009 #Revision 1.44 2002/07/14 02:05:53 richard
2010 #. all storage-specific code (ie. backend) is now implemented by the backends
2011 #
2012 #Revision 1.43 2002/07/10 06:30:30 richard
2013 #...except of course it's nice to use valid Python syntax
2014 #
2015 #Revision 1.42 2002/07/10 06:21:38 richard
2016 #Be extra safe
2017 #
2018 #Revision 1.41 2002/07/10 00:21:45 richard
2019 #explicit database closing
2020 #
2021 #Revision 1.40 2002/07/09 04:19:09 richard
2022 #Added reindex command to roundup-admin.
2023 #Fixed reindex on first access.
2024 #Also fixed reindexing of entries that change.
2025 #
2026 #Revision 1.39 2002/07/09 03:02:52 richard
2027 #More indexer work:
2028 #- all String properties may now be indexed too. Currently there's a bit of
2029 # "issue" specific code in the actual searching which needs to be
2030 # addressed. In a nutshell:
2031 # + pass 'indexme="yes"' as a String() property initialisation arg, eg:
2032 # file = FileClass(db, "file", name=String(), type=String(),
2033 # comment=String(indexme="yes"))
2034 # + the comment will then be indexed and be searchable, with the results
2035 # related back to the issue that the file is linked to
2036 #- as a result of this work, the FileClass has a default MIME type that may
2037 # be overridden in a subclass, or by the use of a "type" property as is
2038 # done in the default templates.
2039 #- the regeneration of the indexes (if necessary) is done once the schema is
2040 # set up in the dbinit.
2041 #
2042 #Revision 1.38 2002/07/08 06:58:15 richard
2043 #cleaned up the indexer code:
2044 # - it splits more words out (much simpler, faster splitter)
2045 # - removed code we'll never use (roundup.roundup_indexer has the full
2046 # implementation, and replaces roundup.indexer)
2047 # - only index text/plain and rfc822/message (ideas for other text formats to
2048 # index are welcome)
2049 # - added simple unit test for indexer. Needs more tests for regression.
2050 #
2051 #Revision 1.37 2002/06/20 23:52:35 richard
2052 #More informative error message
2053 #
2054 #Revision 1.36 2002/06/19 03:07:19 richard
2055 #Moved the file storage commit into blobfiles where it belongs.
2056 #
2057 #Revision 1.35 2002/05/25 07:16:24 rochecompaan
2058 #Merged search_indexing-branch with HEAD
2059 #
2060 #Revision 1.34 2002/05/15 06:21:21 richard
2061 # . node caching now works, and gives a small boost in performance
2062 #
2063 #As a part of this, I cleaned up the DEBUG output and implemented TRACE
2064 #output (HYPERDBTRACE='file to trace to') with checkpoints at the start of
2065 #CGI requests. Run roundup with python -O to skip all the DEBUG/TRACE stuff
2066 #(using if __debug__ which is compiled out with -O)
2067 #
2068 #Revision 1.33 2002/04/24 10:38:26 rochecompaan
2069 #All database files are now created group readable and writable.
2070 #
2071 #Revision 1.32 2002/04/15 23:25:15 richard
2072 #. node ids are now generated from a lockable store - no more race conditions
2073 #
2074 #We're using the portalocker code by Jonathan Feinberg that was contributed
2075 #to the ASPN Python cookbook. This gives us locking across Unix and Windows.
2076 #
2077 #Revision 1.31 2002/04/03 05:54:31 richard
2078 #Fixed serialisation problem by moving the serialisation step out of the
2079 #hyperdb.Class (get, set) into the hyperdb.Database.
2080 #
2081 #Also fixed htmltemplate after the showid changes I made yesterday.
2082 #
2083 #Unit tests for all of the above written.
2084 #
2085 #Revision 1.30.2.1 2002/04/03 11:55:57 rochecompaan
2086 # . Added feature #526730 - search for messages capability
2087 #
2088 #Revision 1.30 2002/02/27 03:40:59 richard
2089 #Ran it through pychecker, made fixes
2090 #
2091 #Revision 1.29 2002/02/25 14:34:31 grubert
2092 # . use blobfiles in back_anydbm which is used in back_bsddb.
2093 # change test_db as dirlist does not work for subdirectories.
2094 # ATTENTION: blobfiles now creates subdirectories for files.
2095 #
2096 #Revision 1.28 2002/02/16 09:14:17 richard
2097 # . #514854 ] History: "User" is always ticket creator
2098 #
2099 #Revision 1.27 2002/01/22 07:21:13 richard
2100 #. fixed back_bsddb so it passed the journal tests
2101 #
2102 #... it didn't seem happy using the back_anydbm _open method, which is odd.
2103 #Yet another occurrance of whichdb not being able to recognise older bsddb
2104 #databases. Yadda yadda. Made the HYPERDBDEBUG stuff more sane in the
2105 #process.
2106 #
2107 #Revision 1.26 2002/01/22 05:18:38 rochecompaan
2108 #last_set_entry was referenced before assignment
2109 #
2110 #Revision 1.25 2002/01/22 05:06:08 rochecompaan
2111 #We need to keep the last 'set' entry in the journal to preserve
2112 #information on 'activity' for nodes.
2113 #
2114 #Revision 1.24 2002/01/21 16:33:20 rochecompaan
2115 #You can now use the roundup-admin tool to pack the database
2116 #
2117 #Revision 1.23 2002/01/18 04:32:04 richard
2118 #Rollback was breaking because a message hadn't actually been written to the file. Needs
2119 #more investigation.
2120 #
2121 #Revision 1.22 2002/01/14 02:20:15 richard
2122 # . changed all config accesses so they access either the instance or the
2123 # config attriubute on the db. This means that all config is obtained from
2124 # instance_config instead of the mish-mash of classes. This will make
2125 # switching to a ConfigParser setup easier too, I hope.
2126 #
2127 #At a minimum, this makes migration a _little_ easier (a lot easier in the
2128 #0.5.0 switch, I hope!)
2129 #
2130 #Revision 1.21 2002/01/02 02:31:38 richard
2131 #Sorry for the huge checkin message - I was only intending to implement #496356
2132 #but I found a number of places where things had been broken by transactions:
2133 # . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
2134 # for _all_ roundup-generated smtp messages to be sent to.
2135 # . the transaction cache had broken the roundupdb.Class set() reactors
2136 # . newly-created author users in the mailgw weren't being committed to the db
2137 #
2138 #Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
2139 #on when I found that stuff :):
2140 # . #496356 ] Use threading in messages
2141 # . detectors were being registered multiple times
2142 # . added tests for mailgw
2143 # . much better attaching of erroneous messages in the mail gateway
2144 #
2145 #Revision 1.20 2001/12/18 15:30:34 rochecompaan
2146 #Fixed bugs:
2147 # . Fixed file creation and retrieval in same transaction in anydbm
2148 # backend
2149 # . Cgi interface now renders new issue after issue creation
2150 # . Could not set issue status to resolved through cgi interface
2151 # . Mail gateway was changing status back to 'chatting' if status was
2152 # omitted as an argument
2153 #
2154 #Revision 1.19 2001/12/17 03:52:48 richard
2155 #Implemented file store rollback. As a bonus, the hyperdb is now capable of
2156 #storing more than one file per node - if a property name is supplied,
2157 #the file is called designator.property.
2158 #I decided not to migrate the existing files stored over to the new naming
2159 #scheme - the FileClass just doesn't specify the property name.
2160 #
2161 #Revision 1.18 2001/12/16 10:53:38 richard
2162 #take a copy of the node dict so that the subsequent set
2163 #operation doesn't modify the oldvalues structure
2164 #
2165 #Revision 1.17 2001/12/14 23:42:57 richard
2166 #yuck, a gdbm instance tests false :(
2167 #I've left the debugging code in - it should be removed one day if we're ever
2168 #_really_ anal about performace :)
2169 #
2170 #Revision 1.16 2001/12/12 03:23:14 richard
2171 #Cor blimey this anydbm/whichdb stuff is yecchy. Turns out that whichdb
2172 #incorrectly identifies a dbm file as a dbhash file on my system. This has
2173 #been submitted to the python bug tracker as issue #491888:
2174 #https://sourceforge.net/tracker/index.php?func=detail&aid=491888&group_id=5470&atid=105470
2175 #
2176 #Revision 1.15 2001/12/12 02:30:51 richard
2177 #I fixed the problems with people whose anydbm was using the dbm module at the
2178 #backend. It turns out the dbm module modifies the file name to append ".db"
2179 #and my check to determine if we're opening an existing or new db just
2180 #tested os.path.exists() on the filename. Well, no longer! We now perform a
2181 #much better check _and_ cope with the anydbm implementation module changing
2182 #too!
2183 #I also fixed the backends __init__ so only ImportError is squashed.
2184 #
2185 #Revision 1.14 2001/12/10 22:20:01 richard
2186 #Enabled transaction support in the bsddb backend. It uses the anydbm code
2187 #where possible, only replacing methods where the db is opened (it uses the
2188 #btree opener specifically.)
2189 #Also cleaned up some change note generation.
2190 #Made the backends package work with pydoc too.
2191 #
2192 #Revision 1.13 2001/12/02 05:06:16 richard
2193 #. We now use weakrefs in the Classes to keep the database reference, so
2194 # the close() method on the database is no longer needed.
2195 # I bumped the minimum python requirement up to 2.1 accordingly.
2196 #. #487480 ] roundup-server
2197 #. #487476 ] INSTALL.txt
2198 #
2199 #I also cleaned up the change message / post-edit stuff in the cgi client.
2200 #There's now a clearly marked "TODO: append the change note" where I believe
2201 #the change note should be added there. The "changes" list will obviously
2202 #have to be modified to be a dict of the changes, or somesuch.
2203 #
2204 #More testing needed.
2205 #
2206 #Revision 1.12 2001/12/01 07:17:50 richard
2207 #. We now have basic transaction support! Information is only written to
2208 # the database when the commit() method is called. Only the anydbm
2209 # backend is modified in this way - neither of the bsddb backends have been.
2210 # The mail, admin and cgi interfaces all use commit (except the admin tool
2211 # doesn't have a commit command, so interactive users can't commit...)
2212 #. Fixed login/registration forwarding the user to the right page (or not,
2213 # on a failure)
2214 #
2215 #Revision 1.11 2001/11/21 02:34:18 richard
2216 #Added a target version field to the extended issue schema
2217 #
2218 #Revision 1.10 2001/10/09 23:58:10 richard
2219 #Moved the data stringification up into the hyperdb.Class class' get, set
2220 #and create methods. This means that the data is also stringified for the
2221 #journal call, and removes duplication of code from the backends. The
2222 #backend code now only sees strings.
2223 #
2224 #Revision 1.9 2001/10/09 07:25:59 richard
2225 #Added the Password property type. See "pydoc roundup.password" for
2226 #implementation details. Have updated some of the documentation too.
2227 #
2228 #Revision 1.8 2001/09/29 13:27:00 richard
2229 #CGI interfaces now spit up a top-level index of all the instances they can
2230 #serve.
2231 #
2232 #Revision 1.7 2001/08/12 06:32:36 richard
2233 #using isinstance(blah, Foo) now instead of isFooType
2234 #
2235 #Revision 1.6 2001/08/07 00:24:42 richard
2236 #stupid typo
2237 #
2238 #Revision 1.5 2001/08/07 00:15:51 richard
2239 #Added the copyright/license notice to (nearly) all files at request of
2240 #Bizar Software.
2241 #
2242 #Revision 1.4 2001/07/30 01:41:36 richard
2243 #Makes schema changes mucho easier.
2244 #
2245 #Revision 1.3 2001/07/25 01:23:07 richard
2246 #Added the Roundup spec to the new documentation directory.
2247 #
2248 #Revision 1.2 2001/07/23 08:20:44 richard
2249 #Moved over to using marshal in the bsddb and anydbm backends.
2250 #roundup-admin now has a "freshen" command that'll load/save all nodes (not
2251 # retired - mod hyperdb.Class.list() so it lists retired nodes)
2252 #
2253 #