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.66 2002-09-01 04:32:30 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 d[propname]
1001 # XXX not in spec
1002 def getnode(self, nodeid, cache=1):
1003 ''' Return a convenience wrapper for the node.
1005 'nodeid' must be the id of an existing node of this class or an
1006 IndexError is raised.
1008 'cache' indicates whether the transaction cache should be queried
1009 for the node. If the node has been modified and you need to
1010 determine what its values prior to modification are, you need to
1011 set cache=0.
1012 '''
1013 return Node(self, nodeid, cache=cache)
1015 def set(self, nodeid, **propvalues):
1016 '''Modify a property on an existing node of this class.
1018 'nodeid' must be the id of an existing node of this class or an
1019 IndexError is raised.
1021 Each key in 'propvalues' must be the name of a property of this
1022 class or a KeyError is raised.
1024 All values in 'propvalues' must be acceptable types for their
1025 corresponding properties or a TypeError is raised.
1027 If the value of the key property is set, it must not collide with
1028 other key strings or a ValueError is raised.
1030 If the value of a Link or Multilink property contains an invalid
1031 node id, a ValueError is raised.
1033 These operations trigger detectors and can be vetoed. Attempts
1034 to modify the "creation" or "activity" properties cause a KeyError.
1035 '''
1036 if not propvalues:
1037 return propvalues
1039 if propvalues.has_key('creation') or propvalues.has_key('activity'):
1040 raise KeyError, '"creation" and "activity" are reserved'
1042 if propvalues.has_key('id'):
1043 raise KeyError, '"id" is reserved'
1045 if self.db.journaltag is None:
1046 raise DatabaseError, 'Database open read-only'
1048 self.fireAuditors('set', nodeid, propvalues)
1049 # Take a copy of the node dict so that the subsequent set
1050 # operation doesn't modify the oldvalues structure.
1051 try:
1052 # try not using the cache initially
1053 oldvalues = copy.deepcopy(self.db.getnode(self.classname, nodeid,
1054 cache=0))
1055 except IndexError:
1056 # this will be needed if somone does a create() and set()
1057 # with no intervening commit()
1058 oldvalues = copy.deepcopy(self.db.getnode(self.classname, nodeid))
1060 node = self.db.getnode(self.classname, nodeid)
1061 if node.has_key(self.db.RETIRED_FLAG):
1062 raise IndexError
1063 num_re = re.compile('^\d+$')
1065 # if the journal value is to be different, store it in here
1066 journalvalues = {}
1068 for propname, value in propvalues.items():
1069 # check to make sure we're not duplicating an existing key
1070 if propname == self.key and node[propname] != value:
1071 try:
1072 self.lookup(value)
1073 except KeyError:
1074 pass
1075 else:
1076 raise ValueError, 'node with key "%s" exists'%value
1078 # this will raise the KeyError if the property isn't valid
1079 # ... we don't use getprops() here because we only care about
1080 # the writeable properties.
1081 prop = self.properties[propname]
1083 # if the value's the same as the existing value, no sense in
1084 # doing anything
1085 if node.has_key(propname) and value == node[propname]:
1086 del propvalues[propname]
1087 continue
1089 # do stuff based on the prop type
1090 if isinstance(prop, Link):
1091 link_class = prop.classname
1092 # if it isn't a number, it's a key
1093 if value is not None and not isinstance(value, type('')):
1094 raise ValueError, 'property "%s" link value be a string'%(
1095 propname)
1096 if isinstance(value, type('')) and not num_re.match(value):
1097 try:
1098 value = self.db.classes[link_class].lookup(value)
1099 except (TypeError, KeyError):
1100 raise IndexError, 'new property "%s": %s not a %s'%(
1101 propname, value, prop.classname)
1103 if (value is not None and
1104 not self.db.getclass(link_class).hasnode(value)):
1105 raise IndexError, '%s has no node %s'%(link_class, value)
1107 if self.do_journal and prop.do_journal:
1108 # register the unlink with the old linked node
1109 if node[propname] is not None:
1110 self.db.addjournal(link_class, node[propname], 'unlink',
1111 (self.classname, nodeid, propname))
1113 # register the link with the newly linked node
1114 if value is not None:
1115 self.db.addjournal(link_class, value, 'link',
1116 (self.classname, nodeid, propname))
1118 elif isinstance(prop, Multilink):
1119 if type(value) != type([]):
1120 raise TypeError, 'new property "%s" not a list of'\
1121 ' ids'%propname
1122 link_class = self.properties[propname].classname
1123 l = []
1124 for entry in value:
1125 # if it isn't a number, it's a key
1126 if type(entry) != type(''):
1127 raise ValueError, 'new property "%s" link value ' \
1128 'must be a string'%propname
1129 if not num_re.match(entry):
1130 try:
1131 entry = self.db.classes[link_class].lookup(entry)
1132 except (TypeError, KeyError):
1133 raise IndexError, 'new property "%s": %s not a %s'%(
1134 propname, entry,
1135 self.properties[propname].classname)
1136 l.append(entry)
1137 value = l
1138 propvalues[propname] = value
1140 # figure the journal entry for this property
1141 add = []
1142 remove = []
1144 # handle removals
1145 if node.has_key(propname):
1146 l = node[propname]
1147 else:
1148 l = []
1149 for id in l[:]:
1150 if id in value:
1151 continue
1152 # register the unlink with the old linked node
1153 if self.do_journal and self.properties[propname].do_journal:
1154 self.db.addjournal(link_class, id, 'unlink',
1155 (self.classname, nodeid, propname))
1156 l.remove(id)
1157 remove.append(id)
1159 # handle additions
1160 for id in value:
1161 if not self.db.getclass(link_class).hasnode(id):
1162 raise IndexError, '%s has no node %s'%(link_class, id)
1163 if id in l:
1164 continue
1165 # register the link with the newly linked node
1166 if self.do_journal and self.properties[propname].do_journal:
1167 self.db.addjournal(link_class, id, 'link',
1168 (self.classname, nodeid, propname))
1169 l.append(id)
1170 add.append(id)
1172 # figure the journal entry
1173 l = []
1174 if add:
1175 l.append(('+', add))
1176 if remove:
1177 l.append(('-', remove))
1178 if l:
1179 journalvalues[propname] = tuple(l)
1181 elif isinstance(prop, String):
1182 if value is not None and type(value) != type(''):
1183 raise TypeError, 'new property "%s" not a string'%propname
1185 elif isinstance(prop, Password):
1186 if not isinstance(value, password.Password):
1187 raise TypeError, 'new property "%s" not a Password'%propname
1188 propvalues[propname] = value
1190 elif value is not None and isinstance(prop, Date):
1191 if not isinstance(value, date.Date):
1192 raise TypeError, 'new property "%s" not a Date'% propname
1193 propvalues[propname] = value
1195 elif value is not None and isinstance(prop, Interval):
1196 if not isinstance(value, date.Interval):
1197 raise TypeError, 'new property "%s" not an '\
1198 'Interval'%propname
1199 propvalues[propname] = value
1201 elif value is not None and isinstance(prop, Number):
1202 try:
1203 float(value)
1204 except ValueError:
1205 raise TypeError, 'new property "%s" not numeric'%propname
1207 elif value is not None and isinstance(prop, Boolean):
1208 try:
1209 int(value)
1210 except ValueError:
1211 raise TypeError, 'new property "%s" not boolean'%propname
1213 node[propname] = value
1215 # nothing to do?
1216 if not propvalues:
1217 return propvalues
1219 # do the set, and journal it
1220 self.db.setnode(self.classname, nodeid, node)
1222 if self.do_journal:
1223 propvalues.update(journalvalues)
1224 self.db.addjournal(self.classname, nodeid, 'set', propvalues)
1226 self.fireReactors('set', nodeid, oldvalues)
1228 return propvalues
1230 def retire(self, nodeid):
1231 '''Retire a node.
1233 The properties on the node remain available from the get() method,
1234 and the node's id is never reused.
1236 Retired nodes are not returned by the find(), list(), or lookup()
1237 methods, and other nodes may reuse the values of their key properties.
1239 These operations trigger detectors and can be vetoed. Attempts
1240 to modify the "creation" or "activity" properties cause a KeyError.
1241 '''
1242 if self.db.journaltag is None:
1243 raise DatabaseError, 'Database open read-only'
1245 self.fireAuditors('retire', nodeid, None)
1247 node = self.db.getnode(self.classname, nodeid)
1248 node[self.db.RETIRED_FLAG] = 1
1249 self.db.setnode(self.classname, nodeid, node)
1250 if self.do_journal:
1251 self.db.addjournal(self.classname, nodeid, 'retired', None)
1253 self.fireReactors('retire', nodeid, None)
1255 def is_retired(self, nodeid):
1256 '''Return true if the node is retired.
1257 '''
1258 node = self.db.getnode(cn, nodeid, cldb)
1259 if node.has_key(self.db.RETIRED_FLAG):
1260 return 1
1261 return 0
1263 def destroy(self, nodeid):
1264 '''Destroy a node.
1266 WARNING: this method should never be used except in extremely rare
1267 situations where there could never be links to the node being
1268 deleted
1269 WARNING: use retire() instead
1270 WARNING: the properties of this node will not be available ever again
1271 WARNING: really, use retire() instead
1273 Well, I think that's enough warnings. This method exists mostly to
1274 support the session storage of the cgi interface.
1275 '''
1276 if self.db.journaltag is None:
1277 raise DatabaseError, 'Database open read-only'
1278 self.db.destroynode(self.classname, nodeid)
1280 def history(self, nodeid):
1281 '''Retrieve the journal of edits on a particular node.
1283 'nodeid' must be the id of an existing node of this class or an
1284 IndexError is raised.
1286 The returned list contains tuples of the form
1288 (date, tag, action, params)
1290 'date' is a Timestamp object specifying the time of the change and
1291 'tag' is the journaltag specified when the database was opened.
1292 '''
1293 if not self.do_journal:
1294 raise ValueError, 'Journalling is disabled for this class'
1295 return self.db.getjournal(self.classname, nodeid)
1297 # Locating nodes:
1298 def hasnode(self, nodeid):
1299 '''Determine if the given nodeid actually exists
1300 '''
1301 return self.db.hasnode(self.classname, nodeid)
1303 def setkey(self, propname):
1304 '''Select a String property of this class to be the key property.
1306 'propname' must be the name of a String property of this class or
1307 None, or a TypeError is raised. The values of the key property on
1308 all existing nodes must be unique or a ValueError is raised. If the
1309 property doesn't exist, KeyError is raised.
1310 '''
1311 prop = self.getprops()[propname]
1312 if not isinstance(prop, String):
1313 raise TypeError, 'key properties must be String'
1314 self.key = propname
1316 def getkey(self):
1317 '''Return the name of the key property for this class or None.'''
1318 return self.key
1320 def labelprop(self, default_to_id=0):
1321 ''' Return the property name for a label for the given node.
1323 This method attempts to generate a consistent label for the node.
1324 It tries the following in order:
1325 1. key property
1326 2. "name" property
1327 3. "title" property
1328 4. first property from the sorted property name list
1329 '''
1330 k = self.getkey()
1331 if k:
1332 return k
1333 props = self.getprops()
1334 if props.has_key('name'):
1335 return 'name'
1336 elif props.has_key('title'):
1337 return 'title'
1338 if default_to_id:
1339 return 'id'
1340 props = props.keys()
1341 props.sort()
1342 return props[0]
1344 # TODO: set up a separate index db file for this? profile?
1345 def lookup(self, keyvalue):
1346 '''Locate a particular node by its key property and return its id.
1348 If this class has no key property, a TypeError is raised. If the
1349 'keyvalue' matches one of the values for the key property among
1350 the nodes in this class, the matching node's id is returned;
1351 otherwise a KeyError is raised.
1352 '''
1353 if not self.key:
1354 raise TypeError, 'No key property set'
1355 cldb = self.db.getclassdb(self.classname)
1356 try:
1357 for nodeid in self.db.getnodeids(self.classname, cldb):
1358 node = self.db.getnode(self.classname, nodeid, cldb)
1359 if node.has_key(self.db.RETIRED_FLAG):
1360 continue
1361 if node[self.key] == keyvalue:
1362 cldb.close()
1363 return nodeid
1364 finally:
1365 cldb.close()
1366 raise KeyError, keyvalue
1368 # XXX: change from spec - allows multiple props to match
1369 def find(self, **propspec):
1370 '''Get the ids of nodes in this class which link to the given nodes.
1372 'propspec' consists of keyword args propname={nodeid:1,}
1373 'propname' must be the name of a property in this class, or a
1374 KeyError is raised. That property must be a Link or Multilink
1375 property, or a TypeError is raised.
1377 Any node in this class whose 'propname' property links to any of the
1378 nodeids will be returned. Used by the full text indexing, which knows
1379 that "foo" occurs in msg1, msg3 and file7, so we have hits on these issues:
1380 db.issue.find(messages={'1':1,'3':1}, files={'7':1})
1381 '''
1382 propspec = propspec.items()
1383 for propname, nodeids in propspec:
1384 # check the prop is OK
1385 prop = self.properties[propname]
1386 if not isinstance(prop, Link) and not isinstance(prop, Multilink):
1387 raise TypeError, "'%s' not a Link/Multilink property"%propname
1389 # ok, now do the find
1390 cldb = self.db.getclassdb(self.classname)
1391 l = []
1392 try:
1393 for id in self.db.getnodeids(self.classname, db=cldb):
1394 node = self.db.getnode(self.classname, id, db=cldb)
1395 if node.has_key(self.db.RETIRED_FLAG):
1396 continue
1397 for propname, nodeids in propspec:
1398 # can't test if the node doesn't have this property
1399 if not node.has_key(propname):
1400 continue
1401 if type(nodeids) is type(''):
1402 nodeids = {nodeids:1}
1403 prop = self.properties[propname]
1404 value = node[propname]
1405 if isinstance(prop, Link) and nodeids.has_key(value):
1406 l.append(id)
1407 break
1408 elif isinstance(prop, Multilink):
1409 hit = 0
1410 for v in value:
1411 if nodeids.has_key(v):
1412 l.append(id)
1413 hit = 1
1414 break
1415 if hit:
1416 break
1417 finally:
1418 cldb.close()
1419 return l
1421 def stringFind(self, **requirements):
1422 '''Locate a particular node by matching a set of its String
1423 properties in a caseless search.
1425 If the property is not a String property, a TypeError is raised.
1427 The return is a list of the id of all nodes that match.
1428 '''
1429 for propname in requirements.keys():
1430 prop = self.properties[propname]
1431 if isinstance(not prop, String):
1432 raise TypeError, "'%s' not a String property"%propname
1433 requirements[propname] = requirements[propname].lower()
1434 l = []
1435 cldb = self.db.getclassdb(self.classname)
1436 try:
1437 for nodeid in self.db.getnodeids(self.classname, cldb):
1438 node = self.db.getnode(self.classname, nodeid, cldb)
1439 if node.has_key(self.db.RETIRED_FLAG):
1440 continue
1441 for key, value in requirements.items():
1442 if node[key] is None or node[key].lower() != value:
1443 break
1444 else:
1445 l.append(nodeid)
1446 finally:
1447 cldb.close()
1448 return l
1450 def list(self):
1451 ''' Return a list of the ids of the active nodes in this class.
1452 '''
1453 l = []
1454 cn = self.classname
1455 cldb = self.db.getclassdb(cn)
1456 try:
1457 for nodeid in self.db.getnodeids(cn, cldb):
1458 node = self.db.getnode(cn, nodeid, cldb)
1459 if node.has_key(self.db.RETIRED_FLAG):
1460 continue
1461 l.append(nodeid)
1462 finally:
1463 cldb.close()
1464 l.sort()
1465 return l
1467 def filter(self, search_matches, filterspec, sort, group,
1468 num_re = re.compile('^\d+$')):
1469 ''' Return a list of the ids of the active nodes in this class that
1470 match the 'filter' spec, sorted by the group spec and then the
1471 sort spec.
1473 "filterspec" is {propname: value(s)}
1474 "sort" and "group" are (dir, prop) where dir is '+', '-' or None
1475 and prop is a prop name or None
1476 "search_matches" is {nodeid: marker}
1477 '''
1478 cn = self.classname
1480 # optimise filterspec
1481 l = []
1482 props = self.getprops()
1483 LINK = 0
1484 MULTILINK = 1
1485 STRING = 2
1486 OTHER = 6
1487 for k, v in filterspec.items():
1488 propclass = props[k]
1489 if isinstance(propclass, Link):
1490 if type(v) is not type([]):
1491 v = [v]
1492 # replace key values with node ids
1493 u = []
1494 link_class = self.db.classes[propclass.classname]
1495 for entry in v:
1496 if entry == '-1': entry = None
1497 elif not num_re.match(entry):
1498 try:
1499 entry = link_class.lookup(entry)
1500 except (TypeError,KeyError):
1501 raise ValueError, 'property "%s": %s not a %s'%(
1502 k, entry, self.properties[k].classname)
1503 u.append(entry)
1505 l.append((LINK, k, u))
1506 elif isinstance(propclass, Multilink):
1507 if type(v) is not type([]):
1508 v = [v]
1509 # replace key values with node ids
1510 u = []
1511 link_class = self.db.classes[propclass.classname]
1512 for entry in v:
1513 if not num_re.match(entry):
1514 try:
1515 entry = link_class.lookup(entry)
1516 except (TypeError,KeyError):
1517 raise ValueError, 'new property "%s": %s not a %s'%(
1518 k, entry, self.properties[k].classname)
1519 u.append(entry)
1520 l.append((MULTILINK, k, u))
1521 elif isinstance(propclass, String):
1522 # simple glob searching
1523 v = re.sub(r'([\|\{\}\\\.\+\[\]\(\)])', r'\\\1', v)
1524 v = v.replace('?', '.')
1525 v = v.replace('*', '.*?')
1526 l.append((STRING, k, re.compile(v, re.I)))
1527 elif isinstance(propclass, Boolean):
1528 if type(v) is type(''):
1529 bv = v.lower() in ('yes', 'true', 'on', '1')
1530 else:
1531 bv = v
1532 l.append((OTHER, k, bv))
1533 elif isinstance(propclass, Number):
1534 l.append((OTHER, k, int(v)))
1535 else:
1536 l.append((OTHER, k, v))
1537 filterspec = l
1539 # now, find all the nodes that are active and pass filtering
1540 l = []
1541 cldb = self.db.getclassdb(cn)
1542 try:
1543 # TODO: only full-scan once (use items())
1544 for nodeid in self.db.getnodeids(cn, cldb):
1545 node = self.db.getnode(cn, nodeid, cldb)
1546 if node.has_key(self.db.RETIRED_FLAG):
1547 continue
1548 # apply filter
1549 for t, k, v in filterspec:
1550 # make sure the node has the property
1551 if not node.has_key(k):
1552 # this node doesn't have this property, so reject it
1553 break
1555 # now apply the property filter
1556 if t == LINK:
1557 # link - if this node's property doesn't appear in the
1558 # filterspec's nodeid list, skip it
1559 if node[k] not in v:
1560 break
1561 elif t == MULTILINK:
1562 # multilink - if any of the nodeids required by the
1563 # filterspec aren't in this node's property, then skip
1564 # it
1565 have = node[k]
1566 for want in v:
1567 if want not in have:
1568 break
1569 else:
1570 continue
1571 break
1572 elif t == STRING:
1573 # RE search
1574 if node[k] is None or not v.search(node[k]):
1575 break
1576 elif t == OTHER:
1577 # straight value comparison for the other types
1578 if node[k] != v:
1579 break
1580 else:
1581 l.append((nodeid, node))
1582 finally:
1583 cldb.close()
1584 l.sort()
1586 # filter based on full text search
1587 if search_matches is not None:
1588 k = []
1589 for v in l:
1590 if search_matches.has_key(v[0]):
1591 k.append(v)
1592 l = k
1594 # now, sort the result
1595 def sortfun(a, b, sort=sort, group=group, properties=self.getprops(),
1596 db = self.db, cl=self):
1597 a_id, an = a
1598 b_id, bn = b
1599 # sort by group and then sort
1600 for dir, prop in group, sort:
1601 if dir is None: continue
1603 # sorting is class-specific
1604 propclass = properties[prop]
1606 # handle the properties that might be "faked"
1607 # also, handle possible missing properties
1608 try:
1609 if not an.has_key(prop):
1610 an[prop] = cl.get(a_id, prop)
1611 av = an[prop]
1612 except KeyError:
1613 # the node doesn't have a value for this property
1614 if isinstance(propclass, Multilink): av = []
1615 else: av = ''
1616 try:
1617 if not bn.has_key(prop):
1618 bn[prop] = cl.get(b_id, prop)
1619 bv = bn[prop]
1620 except KeyError:
1621 # the node doesn't have a value for this property
1622 if isinstance(propclass, Multilink): bv = []
1623 else: bv = ''
1625 # String and Date values are sorted in the natural way
1626 if isinstance(propclass, String):
1627 # clean up the strings
1628 if av and av[0] in string.uppercase:
1629 av = an[prop] = av.lower()
1630 if bv and bv[0] in string.uppercase:
1631 bv = bn[prop] = bv.lower()
1632 if (isinstance(propclass, String) or
1633 isinstance(propclass, Date)):
1634 # it might be a string that's really an integer
1635 try:
1636 av = int(av)
1637 bv = int(bv)
1638 except:
1639 pass
1640 if dir == '+':
1641 r = cmp(av, bv)
1642 if r != 0: return r
1643 elif dir == '-':
1644 r = cmp(bv, av)
1645 if r != 0: return r
1647 # Link properties are sorted according to the value of
1648 # the "order" property on the linked nodes if it is
1649 # present; or otherwise on the key string of the linked
1650 # nodes; or finally on the node ids.
1651 elif isinstance(propclass, Link):
1652 link = db.classes[propclass.classname]
1653 if av is None and bv is not None: return -1
1654 if av is not None and bv is None: return 1
1655 if av is None and bv is None: continue
1656 if link.getprops().has_key('order'):
1657 if dir == '+':
1658 r = cmp(link.get(av, 'order'),
1659 link.get(bv, 'order'))
1660 if r != 0: return r
1661 elif dir == '-':
1662 r = cmp(link.get(bv, 'order'),
1663 link.get(av, 'order'))
1664 if r != 0: return r
1665 elif link.getkey():
1666 key = link.getkey()
1667 if dir == '+':
1668 r = cmp(link.get(av, key), link.get(bv, key))
1669 if r != 0: return r
1670 elif dir == '-':
1671 r = cmp(link.get(bv, key), link.get(av, key))
1672 if r != 0: return r
1673 else:
1674 if dir == '+':
1675 r = cmp(av, bv)
1676 if r != 0: return r
1677 elif dir == '-':
1678 r = cmp(bv, av)
1679 if r != 0: return r
1681 # Multilink properties are sorted according to how many
1682 # links are present.
1683 elif isinstance(propclass, Multilink):
1684 if dir == '+':
1685 r = cmp(len(av), len(bv))
1686 if r != 0: return r
1687 elif dir == '-':
1688 r = cmp(len(bv), len(av))
1689 if r != 0: return r
1690 elif isinstance(propclass, Number) or isinstance(propclass, Boolean):
1691 if dir == '+':
1692 r = cmp(av, bv)
1693 elif dir == '-':
1694 r = cmp(bv, av)
1696 # end for dir, prop in sort, group:
1697 # if all else fails, compare the ids
1698 return cmp(a[0], b[0])
1700 l.sort(sortfun)
1701 return [i[0] for i in l]
1703 def count(self):
1704 '''Get the number of nodes in this class.
1706 If the returned integer is 'numnodes', the ids of all the nodes
1707 in this class run from 1 to numnodes, and numnodes+1 will be the
1708 id of the next node to be created in this class.
1709 '''
1710 return self.db.countnodes(self.classname)
1712 # Manipulating properties:
1714 def getprops(self, protected=1):
1715 '''Return a dictionary mapping property names to property objects.
1716 If the "protected" flag is true, we include protected properties -
1717 those which may not be modified.
1719 In addition to the actual properties on the node, these
1720 methods provide the "creation" and "activity" properties. If the
1721 "protected" flag is true, we include protected properties - those
1722 which may not be modified.
1723 '''
1724 d = self.properties.copy()
1725 if protected:
1726 d['id'] = String()
1727 d['creation'] = hyperdb.Date()
1728 d['activity'] = hyperdb.Date()
1729 d['creator'] = hyperdb.Link("user")
1730 return d
1732 def addprop(self, **properties):
1733 '''Add properties to this class.
1735 The keyword arguments in 'properties' must map names to property
1736 objects, or a TypeError is raised. None of the keys in 'properties'
1737 may collide with the names of existing properties, or a ValueError
1738 is raised before any properties have been added.
1739 '''
1740 for key in properties.keys():
1741 if self.properties.has_key(key):
1742 raise ValueError, key
1743 self.properties.update(properties)
1745 def index(self, nodeid):
1746 '''Add (or refresh) the node to search indexes
1747 '''
1748 # find all the String properties that have indexme
1749 for prop, propclass in self.getprops().items():
1750 if isinstance(propclass, String) and propclass.indexme:
1751 try:
1752 value = str(self.get(nodeid, prop))
1753 except IndexError:
1754 # node no longer exists - entry should be removed
1755 self.db.indexer.purge_entry((self.classname, nodeid, prop))
1756 else:
1757 # and index them under (classname, nodeid, property)
1758 self.db.indexer.add_text((self.classname, nodeid, prop),
1759 value)
1761 #
1762 # Detector interface
1763 #
1764 def audit(self, event, detector):
1765 '''Register a detector
1766 '''
1767 l = self.auditors[event]
1768 if detector not in l:
1769 self.auditors[event].append(detector)
1771 def fireAuditors(self, action, nodeid, newvalues):
1772 '''Fire all registered auditors.
1773 '''
1774 for audit in self.auditors[action]:
1775 audit(self.db, self, nodeid, newvalues)
1777 def react(self, event, detector):
1778 '''Register a detector
1779 '''
1780 l = self.reactors[event]
1781 if detector not in l:
1782 self.reactors[event].append(detector)
1784 def fireReactors(self, action, nodeid, oldvalues):
1785 '''Fire all registered reactors.
1786 '''
1787 for react in self.reactors[action]:
1788 react(self.db, self, nodeid, oldvalues)
1790 class FileClass(Class):
1791 '''This class defines a large chunk of data. To support this, it has a
1792 mandatory String property "content" which is typically saved off
1793 externally to the hyperdb.
1795 The default MIME type of this data is defined by the
1796 "default_mime_type" class attribute, which may be overridden by each
1797 node if the class defines a "type" String property.
1798 '''
1799 default_mime_type = 'text/plain'
1801 def create(self, **propvalues):
1802 ''' snaffle the file propvalue and store in a file
1803 '''
1804 content = propvalues['content']
1805 del propvalues['content']
1806 newid = Class.create(self, **propvalues)
1807 self.db.storefile(self.classname, newid, None, content)
1808 return newid
1810 def import_list(self, propnames, proplist):
1811 ''' Trap the "content" property...
1812 '''
1813 # dupe this list so we don't affect others
1814 propnames = propnames[:]
1816 # extract the "content" property from the proplist
1817 i = propnames.index('content')
1818 content = proplist[i]
1819 del propnames[i]
1820 del proplist[i]
1822 # do the normal import
1823 newid = Class.import_list(self, propnames, proplist)
1825 # save off the "content" file
1826 self.db.storefile(self.classname, newid, None, content)
1827 return newid
1829 def get(self, nodeid, propname, default=_marker, cache=1):
1830 ''' trap the content propname and get it from the file
1831 '''
1833 poss_msg = 'Possibly a access right configuration problem.'
1834 if propname == 'content':
1835 try:
1836 return self.db.getfile(self.classname, nodeid, None)
1837 except IOError, (strerror):
1838 # BUG: by catching this we donot see an error in the log.
1839 return 'ERROR reading file: %s%s\n%s\n%s'%(
1840 self.classname, nodeid, poss_msg, strerror)
1841 if default is not _marker:
1842 return Class.get(self, nodeid, propname, default, cache=cache)
1843 else:
1844 return Class.get(self, nodeid, propname, cache=cache)
1846 def getprops(self, protected=1):
1847 ''' In addition to the actual properties on the node, these methods
1848 provide the "content" property. If the "protected" flag is true,
1849 we include protected properties - those which may not be
1850 modified.
1851 '''
1852 d = Class.getprops(self, protected=protected).copy()
1853 if protected:
1854 d['content'] = hyperdb.String()
1855 return d
1857 def index(self, nodeid):
1858 ''' Index the node in the search index.
1860 We want to index the content in addition to the normal String
1861 property indexing.
1862 '''
1863 # perform normal indexing
1864 Class.index(self, nodeid)
1866 # get the content to index
1867 content = self.get(nodeid, 'content')
1869 # figure the mime type
1870 if self.properties.has_key('type'):
1871 mime_type = self.get(nodeid, 'type')
1872 else:
1873 mime_type = self.default_mime_type
1875 # and index!
1876 self.db.indexer.add_text((self.classname, nodeid, 'content'), content,
1877 mime_type)
1879 # XXX deviation from spec - was called ItemClass
1880 class IssueClass(Class, roundupdb.IssueClass):
1881 # Overridden methods:
1882 def __init__(self, db, classname, **properties):
1883 '''The newly-created class automatically includes the "messages",
1884 "files", "nosy", and "superseder" properties. If the 'properties'
1885 dictionary attempts to specify any of these properties or a
1886 "creation" or "activity" property, a ValueError is raised.
1887 '''
1888 if not properties.has_key('title'):
1889 properties['title'] = hyperdb.String(indexme='yes')
1890 if not properties.has_key('messages'):
1891 properties['messages'] = hyperdb.Multilink("msg")
1892 if not properties.has_key('files'):
1893 properties['files'] = hyperdb.Multilink("file")
1894 if not properties.has_key('nosy'):
1895 # note: journalling is turned off as it really just wastes
1896 # space. this behaviour may be overridden in an instance
1897 properties['nosy'] = hyperdb.Multilink("user", do_journal="no")
1898 if not properties.has_key('superseder'):
1899 properties['superseder'] = hyperdb.Multilink(classname)
1900 Class.__init__(self, db, classname, **properties)
1902 #
1903 #$Log: not supported by cvs2svn $
1904 #Revision 1.65 2002/08/30 08:35:45 richard
1905 #minor edits
1906 #
1907 #Revision 1.64 2002/08/22 07:57:11 richard
1908 #Consistent quoting
1909 #
1910 #Revision 1.63 2002/08/22 04:42:28 richard
1911 #use more robust date stamp comparisons in pack(), make journal smaller too
1912 #
1913 #Revision 1.62 2002/08/21 07:07:27 richard
1914 #In preparing to turn back on link/unlink journal events (by default these
1915 #are turned off) I've:
1916 #- fixed back_anydbm so it can journal those events again (had broken it
1917 # with recent changes)
1918 #- changed the serialisation format for dates and intervals to use a
1919 # numbers-only (and sign for Intervals) string instead of tuple-of-ints.
1920 # Much smaller.
1921 #
1922 #Revision 1.61 2002/08/19 02:53:27 richard
1923 #full database export and import is done
1924 #
1925 #Revision 1.60 2002/08/19 00:23:19 richard
1926 #handle "unset" initial Link values (!)
1927 #
1928 #Revision 1.59 2002/08/16 04:28:13 richard
1929 #added is_retired query to Class
1930 #
1931 #Revision 1.58 2002/08/01 15:06:24 gmcm
1932 #Use same regex to split search terms as used to index text.
1933 #Fix to back_metakit for not changing journaltag on reopen.
1934 #Fix htmltemplate's do_link so [No <whatever>] strings are href'd.
1935 #Fix bogus "nosy edited ok" msg - the **d syntax does NOT share d between caller and callee.
1936 #
1937 #Revision 1.57 2002/07/31 23:57:36 richard
1938 # . web forms may now unset Link values (like assignedto)
1939 #
1940 #Revision 1.56 2002/07/31 22:04:33 richard
1941 #cleanup
1942 #
1943 #Revision 1.55 2002/07/30 08:22:38 richard
1944 #Session storage in the hyperdb was horribly, horribly inefficient. We use
1945 #a simple anydbm wrapper now - which could be overridden by the metakit
1946 #backend or RDB backend if necessary.
1947 #Much, much better.
1948 #
1949 #Revision 1.54 2002/07/26 08:26:59 richard
1950 #Very close now. The cgi and mailgw now use the new security API. The two
1951 #templates have been migrated to that setup. Lots of unit tests. Still some
1952 #issue in the web form for editing Roles assigned to users.
1953 #
1954 #Revision 1.53 2002/07/25 07:14:06 richard
1955 #Bugger it. Here's the current shape of the new security implementation.
1956 #Still to do:
1957 # . call the security funcs from cgi and mailgw
1958 # . change shipped templates to include correct initialisation and remove
1959 # the old config vars
1960 #... that seems like a lot. The bulk of the work has been done though. Honest :)
1961 #
1962 #Revision 1.52 2002/07/19 03:36:34 richard
1963 #Implemented the destroy() method needed by the session database (and possibly
1964 #others). At the same time, I removed the leading underscores from the hyperdb
1965 #methods that Really Didn't Need Them.
1966 #The journal also raises IndexError now for all situations where there is a
1967 #request for the journal of a node that doesn't have one. It used to return
1968 #[] in _some_ situations, but not all. This _may_ break code, but the tests
1969 #pass...
1970 #
1971 #Revision 1.51 2002/07/18 23:07:08 richard
1972 #Unit tests and a few fixes.
1973 #
1974 #Revision 1.50 2002/07/18 11:50:58 richard
1975 #added tests for number type too
1976 #
1977 #Revision 1.49 2002/07/18 11:41:10 richard
1978 #added tests for boolean type, and fixes to anydbm backend
1979 #
1980 #Revision 1.48 2002/07/18 11:17:31 gmcm
1981 #Add Number and Boolean types to hyperdb.
1982 #Add conversion cases to web, mail & admin interfaces.
1983 #Add storage/serialization cases to back_anydbm & back_metakit.
1984 #
1985 #Revision 1.47 2002/07/14 23:18:20 richard
1986 #. fixed the journal bloat from multilink changes - we just log the add or
1987 # remove operations, not the whole list
1988 #
1989 #Revision 1.46 2002/07/14 06:06:34 richard
1990 #Did some old TODOs
1991 #
1992 #Revision 1.45 2002/07/14 04:03:14 richard
1993 #Implemented a switch to disable journalling for a Class. CGI session
1994 #database now uses it.
1995 #
1996 #Revision 1.44 2002/07/14 02:05:53 richard
1997 #. all storage-specific code (ie. backend) is now implemented by the backends
1998 #
1999 #Revision 1.43 2002/07/10 06:30:30 richard
2000 #...except of course it's nice to use valid Python syntax
2001 #
2002 #Revision 1.42 2002/07/10 06:21:38 richard
2003 #Be extra safe
2004 #
2005 #Revision 1.41 2002/07/10 00:21:45 richard
2006 #explicit database closing
2007 #
2008 #Revision 1.40 2002/07/09 04:19:09 richard
2009 #Added reindex command to roundup-admin.
2010 #Fixed reindex on first access.
2011 #Also fixed reindexing of entries that change.
2012 #
2013 #Revision 1.39 2002/07/09 03:02:52 richard
2014 #More indexer work:
2015 #- all String properties may now be indexed too. Currently there's a bit of
2016 # "issue" specific code in the actual searching which needs to be
2017 # addressed. In a nutshell:
2018 # + pass 'indexme="yes"' as a String() property initialisation arg, eg:
2019 # file = FileClass(db, "file", name=String(), type=String(),
2020 # comment=String(indexme="yes"))
2021 # + the comment will then be indexed and be searchable, with the results
2022 # related back to the issue that the file is linked to
2023 #- as a result of this work, the FileClass has a default MIME type that may
2024 # be overridden in a subclass, or by the use of a "type" property as is
2025 # done in the default templates.
2026 #- the regeneration of the indexes (if necessary) is done once the schema is
2027 # set up in the dbinit.
2028 #
2029 #Revision 1.38 2002/07/08 06:58:15 richard
2030 #cleaned up the indexer code:
2031 # - it splits more words out (much simpler, faster splitter)
2032 # - removed code we'll never use (roundup.roundup_indexer has the full
2033 # implementation, and replaces roundup.indexer)
2034 # - only index text/plain and rfc822/message (ideas for other text formats to
2035 # index are welcome)
2036 # - added simple unit test for indexer. Needs more tests for regression.
2037 #
2038 #Revision 1.37 2002/06/20 23:52:35 richard
2039 #More informative error message
2040 #
2041 #Revision 1.36 2002/06/19 03:07:19 richard
2042 #Moved the file storage commit into blobfiles where it belongs.
2043 #
2044 #Revision 1.35 2002/05/25 07:16:24 rochecompaan
2045 #Merged search_indexing-branch with HEAD
2046 #
2047 #Revision 1.34 2002/05/15 06:21:21 richard
2048 # . node caching now works, and gives a small boost in performance
2049 #
2050 #As a part of this, I cleaned up the DEBUG output and implemented TRACE
2051 #output (HYPERDBTRACE='file to trace to') with checkpoints at the start of
2052 #CGI requests. Run roundup with python -O to skip all the DEBUG/TRACE stuff
2053 #(using if __debug__ which is compiled out with -O)
2054 #
2055 #Revision 1.33 2002/04/24 10:38:26 rochecompaan
2056 #All database files are now created group readable and writable.
2057 #
2058 #Revision 1.32 2002/04/15 23:25:15 richard
2059 #. node ids are now generated from a lockable store - no more race conditions
2060 #
2061 #We're using the portalocker code by Jonathan Feinberg that was contributed
2062 #to the ASPN Python cookbook. This gives us locking across Unix and Windows.
2063 #
2064 #Revision 1.31 2002/04/03 05:54:31 richard
2065 #Fixed serialisation problem by moving the serialisation step out of the
2066 #hyperdb.Class (get, set) into the hyperdb.Database.
2067 #
2068 #Also fixed htmltemplate after the showid changes I made yesterday.
2069 #
2070 #Unit tests for all of the above written.
2071 #
2072 #Revision 1.30.2.1 2002/04/03 11:55:57 rochecompaan
2073 # . Added feature #526730 - search for messages capability
2074 #
2075 #Revision 1.30 2002/02/27 03:40:59 richard
2076 #Ran it through pychecker, made fixes
2077 #
2078 #Revision 1.29 2002/02/25 14:34:31 grubert
2079 # . use blobfiles in back_anydbm which is used in back_bsddb.
2080 # change test_db as dirlist does not work for subdirectories.
2081 # ATTENTION: blobfiles now creates subdirectories for files.
2082 #
2083 #Revision 1.28 2002/02/16 09:14:17 richard
2084 # . #514854 ] History: "User" is always ticket creator
2085 #
2086 #Revision 1.27 2002/01/22 07:21:13 richard
2087 #. fixed back_bsddb so it passed the journal tests
2088 #
2089 #... it didn't seem happy using the back_anydbm _open method, which is odd.
2090 #Yet another occurrance of whichdb not being able to recognise older bsddb
2091 #databases. Yadda yadda. Made the HYPERDBDEBUG stuff more sane in the
2092 #process.
2093 #
2094 #Revision 1.26 2002/01/22 05:18:38 rochecompaan
2095 #last_set_entry was referenced before assignment
2096 #
2097 #Revision 1.25 2002/01/22 05:06:08 rochecompaan
2098 #We need to keep the last 'set' entry in the journal to preserve
2099 #information on 'activity' for nodes.
2100 #
2101 #Revision 1.24 2002/01/21 16:33:20 rochecompaan
2102 #You can now use the roundup-admin tool to pack the database
2103 #
2104 #Revision 1.23 2002/01/18 04:32:04 richard
2105 #Rollback was breaking because a message hadn't actually been written to the file. Needs
2106 #more investigation.
2107 #
2108 #Revision 1.22 2002/01/14 02:20:15 richard
2109 # . changed all config accesses so they access either the instance or the
2110 # config attriubute on the db. This means that all config is obtained from
2111 # instance_config instead of the mish-mash of classes. This will make
2112 # switching to a ConfigParser setup easier too, I hope.
2113 #
2114 #At a minimum, this makes migration a _little_ easier (a lot easier in the
2115 #0.5.0 switch, I hope!)
2116 #
2117 #Revision 1.21 2002/01/02 02:31:38 richard
2118 #Sorry for the huge checkin message - I was only intending to implement #496356
2119 #but I found a number of places where things had been broken by transactions:
2120 # . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
2121 # for _all_ roundup-generated smtp messages to be sent to.
2122 # . the transaction cache had broken the roundupdb.Class set() reactors
2123 # . newly-created author users in the mailgw weren't being committed to the db
2124 #
2125 #Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
2126 #on when I found that stuff :):
2127 # . #496356 ] Use threading in messages
2128 # . detectors were being registered multiple times
2129 # . added tests for mailgw
2130 # . much better attaching of erroneous messages in the mail gateway
2131 #
2132 #Revision 1.20 2001/12/18 15:30:34 rochecompaan
2133 #Fixed bugs:
2134 # . Fixed file creation and retrieval in same transaction in anydbm
2135 # backend
2136 # . Cgi interface now renders new issue after issue creation
2137 # . Could not set issue status to resolved through cgi interface
2138 # . Mail gateway was changing status back to 'chatting' if status was
2139 # omitted as an argument
2140 #
2141 #Revision 1.19 2001/12/17 03:52:48 richard
2142 #Implemented file store rollback. As a bonus, the hyperdb is now capable of
2143 #storing more than one file per node - if a property name is supplied,
2144 #the file is called designator.property.
2145 #I decided not to migrate the existing files stored over to the new naming
2146 #scheme - the FileClass just doesn't specify the property name.
2147 #
2148 #Revision 1.18 2001/12/16 10:53:38 richard
2149 #take a copy of the node dict so that the subsequent set
2150 #operation doesn't modify the oldvalues structure
2151 #
2152 #Revision 1.17 2001/12/14 23:42:57 richard
2153 #yuck, a gdbm instance tests false :(
2154 #I've left the debugging code in - it should be removed one day if we're ever
2155 #_really_ anal about performace :)
2156 #
2157 #Revision 1.16 2001/12/12 03:23:14 richard
2158 #Cor blimey this anydbm/whichdb stuff is yecchy. Turns out that whichdb
2159 #incorrectly identifies a dbm file as a dbhash file on my system. This has
2160 #been submitted to the python bug tracker as issue #491888:
2161 #https://sourceforge.net/tracker/index.php?func=detail&aid=491888&group_id=5470&atid=105470
2162 #
2163 #Revision 1.15 2001/12/12 02:30:51 richard
2164 #I fixed the problems with people whose anydbm was using the dbm module at the
2165 #backend. It turns out the dbm module modifies the file name to append ".db"
2166 #and my check to determine if we're opening an existing or new db just
2167 #tested os.path.exists() on the filename. Well, no longer! We now perform a
2168 #much better check _and_ cope with the anydbm implementation module changing
2169 #too!
2170 #I also fixed the backends __init__ so only ImportError is squashed.
2171 #
2172 #Revision 1.14 2001/12/10 22:20:01 richard
2173 #Enabled transaction support in the bsddb backend. It uses the anydbm code
2174 #where possible, only replacing methods where the db is opened (it uses the
2175 #btree opener specifically.)
2176 #Also cleaned up some change note generation.
2177 #Made the backends package work with pydoc too.
2178 #
2179 #Revision 1.13 2001/12/02 05:06:16 richard
2180 #. We now use weakrefs in the Classes to keep the database reference, so
2181 # the close() method on the database is no longer needed.
2182 # I bumped the minimum python requirement up to 2.1 accordingly.
2183 #. #487480 ] roundup-server
2184 #. #487476 ] INSTALL.txt
2185 #
2186 #I also cleaned up the change message / post-edit stuff in the cgi client.
2187 #There's now a clearly marked "TODO: append the change note" where I believe
2188 #the change note should be added there. The "changes" list will obviously
2189 #have to be modified to be a dict of the changes, or somesuch.
2190 #
2191 #More testing needed.
2192 #
2193 #Revision 1.12 2001/12/01 07:17:50 richard
2194 #. We now have basic transaction support! Information is only written to
2195 # the database when the commit() method is called. Only the anydbm
2196 # backend is modified in this way - neither of the bsddb backends have been.
2197 # The mail, admin and cgi interfaces all use commit (except the admin tool
2198 # doesn't have a commit command, so interactive users can't commit...)
2199 #. Fixed login/registration forwarding the user to the right page (or not,
2200 # on a failure)
2201 #
2202 #Revision 1.11 2001/11/21 02:34:18 richard
2203 #Added a target version field to the extended issue schema
2204 #
2205 #Revision 1.10 2001/10/09 23:58:10 richard
2206 #Moved the data stringification up into the hyperdb.Class class' get, set
2207 #and create methods. This means that the data is also stringified for the
2208 #journal call, and removes duplication of code from the backends. The
2209 #backend code now only sees strings.
2210 #
2211 #Revision 1.9 2001/10/09 07:25:59 richard
2212 #Added the Password property type. See "pydoc roundup.password" for
2213 #implementation details. Have updated some of the documentation too.
2214 #
2215 #Revision 1.8 2001/09/29 13:27:00 richard
2216 #CGI interfaces now spit up a top-level index of all the instances they can
2217 #serve.
2218 #
2219 #Revision 1.7 2001/08/12 06:32:36 richard
2220 #using isinstance(blah, Foo) now instead of isFooType
2221 #
2222 #Revision 1.6 2001/08/07 00:24:42 richard
2223 #stupid typo
2224 #
2225 #Revision 1.5 2001/08/07 00:15:51 richard
2226 #Added the copyright/license notice to (nearly) all files at request of
2227 #Bizar Software.
2228 #
2229 #Revision 1.4 2001/07/30 01:41:36 richard
2230 #Makes schema changes mucho easier.
2231 #
2232 #Revision 1.3 2001/07/25 01:23:07 richard
2233 #Added the Roundup spec to the new documentation directory.
2234 #
2235 #Revision 1.2 2001/07/23 08:20:44 richard
2236 #Moved over to using marshal in the bsddb and anydbm backends.
2237 #roundup-admin now has a "freshen" command that'll load/save all nodes (not
2238 # retired - mod hyperdb.Class.list() so it lists retired nodes)
2239 #
2240 #