![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/hyperdb.py b/roundup/hyperdb.py
index 26d324aa4f8e2dd722f244f979bfa59b35c0fe3c..15f5c80d217a47d666d6c61348c81ed9deda0ac5 100644 (file)
--- a/roundup/hyperdb.py
+++ b/roundup/hyperdb.py
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
-# $Id: hyperdb.py,v 1.43 2001-12-20 06:13:24 rochecompaan Exp $
+# $Id: hyperdb.py,v 1.50 2002-01-19 13:16:04 rochecompaan Exp $
__doc__ = """
Hyperdatabase implementation, especially field types.
class Link:
"""An object designating a Link property that links to a
node in a specified class."""
- def __init__(self, classname):
+ def __init__(self, classname, do_journal='no'):
self.classname = classname
+ self.do_journal = do_journal == 'yes'
def __repr__(self):
return '<%s to "%s">'%(self.__class__, self.classname)
"""An object designating a Multilink property that links
to nodes in a specified class.
"""
- def __init__(self, classname):
+ def __init__(self, classname, do_journal='no'):
self.classname = classname
+ self.do_journal = do_journal == 'yes'
def __repr__(self):
return '<%s to "%s">'%(self.__class__, self.classname)
# the base Database class
#
class Database:
+ '''A database for storing records containing flexible data types.
+
+This class defines a hyperdatabase storage layer, which the Classes use to
+store their data.
+
+
+Transactions
+------------
+The Database should support transactions through the commit() and
+rollback() methods. All other Database methods should be transaction-aware,
+using data from the current transaction before looking up the database.
+
+An implementation must provide an override for the get() method so that the
+in-database value is returned in preference to the in-transaction value.
+This is necessary to determine if any values have changed during a
+transaction.
+
+'''
+
# flag to set on retired entries
RETIRED_FLAG = '__hyperdb_retired'
+ # XXX deviates from spec: storagelocator is obtained from the config
+ def __init__(self, config, journaltag=None):
+ """Open a hyperdatabase given a specifier to some storage.
+
+ The 'storagelocator' is obtained from config.DATABASE.
+ The meaning of 'storagelocator' depends on the particular
+ implementation of the hyperdatabase. It could be a file name,
+ a directory path, a socket descriptor for a connection to a
+ database over the network, etc.
+
+ The 'journaltag' is a token that will be attached to the journal
+ entries for any edits done on the database. If 'journaltag' is
+ None, the database is opened in read-only mode: the Class.create(),
+ Class.set(), and Class.retire() methods are disabled.
+ """
+ raise NotImplementedError
+
+ def __getattr__(self, classname):
+ """A convenient way of calling self.getclass(classname)."""
+ raise NotImplementedError
+
+ def addclass(self, cl):
+ '''Add a Class to the hyperdatabase.
+ '''
+ raise NotImplementedError
+
+ def getclasses(self):
+ """Return a list of the names of all existing classes."""
+ raise NotImplementedError
+
+ def getclass(self, classname):
+ """Get the Class object representing a particular class.
+
+ If 'classname' is not a valid class name, a KeyError is raised.
+ """
+ raise NotImplementedError
+
+ def clear(self):
+ '''Delete all database contents.
+ '''
+ raise NotImplementedError
+
+ def getclassdb(self, classname, mode='r'):
+ '''Obtain a connection to the class db that will be used for
+ multiple actions.
+ '''
+ raise NotImplementedError
+
+ def addnode(self, classname, nodeid, node):
+ '''Add the specified node to its class's db.
+ '''
+ raise NotImplementedError
+
+ def setnode(self, classname, nodeid, node):
+ '''Change the specified node.
+ '''
+ raise NotImplementedError
+
+ def getnode(self, classname, nodeid, db=None, cache=1):
+ '''Get a node from the database.
+ '''
+ raise NotImplementedError
+
+ def hasnode(self, classname, nodeid, db=None):
+ '''Determine if the database has a given node.
+ '''
+ raise NotImplementedError
+
+ def countnodes(self, classname, db=None):
+ '''Count the number of nodes that exist for a particular Class.
+ '''
+ raise NotImplementedError
+
+ def getnodeids(self, classname, db=None):
+ '''Retrieve all the ids of the nodes for a particular Class.
+ '''
+ raise NotImplementedError
+
+ def storefile(self, classname, nodeid, property, content):
+ '''Store the content of the file in the database.
+
+ The property may be None, in which case the filename does not
+ indicate which property is being saved.
+ '''
+ raise NotImplementedError
+
+ def getfile(self, classname, nodeid, property):
+ '''Store the content of the file in the database.
+ '''
+ raise NotImplementedError
+
+ def addjournal(self, classname, nodeid, action, params):
+ ''' Journal the Action
+ 'action' may be:
+
+ 'create' or 'set' -- 'params' is a dictionary of property values
+ 'link' or 'unlink' -- 'params' is (classname, nodeid, propname)
+ 'retire' -- 'params' is None
+ '''
+ raise NotImplementedError
+
+ def getjournal(self, classname, nodeid):
+ ''' get the journal for id
+ '''
+ raise NotImplementedError
+
+ def commit(self):
+ ''' Commit the current transactions.
+
+ Save all data changed since the database was opened or since the
+ last commit() or rollback().
+ '''
+ raise NotImplementedError
+
+ def rollback(self):
+ ''' Reverse all actions from the current transaction.
+
+ Undo all the changes made since the database was opened or the last
+ commit() or rollback() was performed.
+ '''
+ raise NotImplementedError
_marker = []
#
propvalues[key] = value
# register the link with the newly linked node
- self.db.addjournal(link_class, value, 'link',
- (self.classname, newid, key))
+ if self.properties[key].do_journal:
+ self.db.addjournal(link_class, value, 'link',
+ (self.classname, newid, key))
elif isinstance(prop, Multilink):
if type(value) != type([]):
if not self.db.hasnode(link_class, id):
raise IndexError, '%s has no node %s'%(link_class, id)
# register the link with the newly linked node
- self.db.addjournal(link_class, id, 'link',
- (self.classname, newid, key))
+ if self.properties[key].do_journal:
+ self.db.addjournal(link_class, id, 'link',
+ (self.classname, newid, key))
elif isinstance(prop, String):
if type(value) != type(''):
raise TypeError, 'new property "%s" not a Password'%key
elif isinstance(prop, Date):
- if not isinstance(value, date.Date):
+ if value is not None and not isinstance(value, date.Date):
raise TypeError, 'new property "%s" not a Date'%key
elif isinstance(prop, Interval):
- if not isinstance(value, date.Interval):
+ if value is not None and not isinstance(value, date.Interval):
raise TypeError, 'new property "%s" not an Interval'%key
# make sure there's data where there needs to be
if isinstance(prop, Multilink):
propvalues[key] = []
else:
+ # TODO: None isn't right here, I think...
propvalues[key] = None
# convert all data to strings
for key, prop in self.properties.items():
if isinstance(prop, Date):
- propvalues[key] = propvalues[key].get_tuple()
+ if propvalues[key] is not None:
+ propvalues[key] = propvalues[key].get_tuple()
elif isinstance(prop, Interval):
- propvalues[key] = propvalues[key].get_tuple()
+ if propvalues[key] is not None:
+ propvalues[key] = propvalues[key].get_tuple()
elif isinstance(prop, Password):
propvalues[key] = str(propvalues[key])
self.db.addjournal(self.classname, newid, 'create', propvalues)
return newid
- def get(self, nodeid, propname, default=_marker):
+ def get(self, nodeid, propname, default=_marker, cache=1):
"""Get the value of a property on an existing node of this class.
'nodeid' must be the id of an existing node of this class or an
IndexError is raised. 'propname' must be the name of a property
of this class or a KeyError is raised.
+
+ 'cache' indicates whether the transaction cache should be queried
+ for the node. If the node has been modified and you need to
+ determine what its values prior to modification are, you need to
+ set cache=0.
"""
if propname == 'id':
return nodeid
+ # get the property (raises KeyErorr if invalid)
+ prop = self.properties[propname]
+
# get the node's dict
- d = self.db.getnode(self.classname, nodeid)
- if not d.has_key(propname) and default is not _marker:
- return default
+ d = self.db.getnode(self.classname, nodeid, cache=cache)
- # get the value
- prop = self.properties[propname]
+ if not d.has_key(propname):
+ if default is _marker:
+ if isinstance(prop, Multilink):
+ return []
+ else:
+ # TODO: None isn't right here, I think...
+ return None
+ else:
+ return default
# possibly convert the marshalled data to instances
if isinstance(prop, Date):
+ if d[propname] is None:
+ return None
return date.Date(d[propname])
elif isinstance(prop, Interval):
+ if d[propname] is None:
+ return None
return date.Interval(d[propname])
elif isinstance(prop, Password):
p = password.Password()
return d[propname]
# XXX not in spec
- def getnode(self, nodeid):
- ''' Return a convenience wrapper for the node
+ def getnode(self, nodeid, cache=1):
+ ''' Return a convenience wrapper for the node.
+
+ 'nodeid' must be the id of an existing node of this class or an
+ IndexError is raised.
+
+ 'cache' indicates whether the transaction cache should be queried
+ for the node. If the node has been modified and you need to
+ determine what its values prior to modification are, you need to
+ set cache=0.
'''
- return Node(self, nodeid)
+ return Node(self, nodeid, cache=cache)
def set(self, nodeid, **propvalues):
"""Modify a property on an existing node of this class.
if not self.db.hasnode(link_class, value):
raise IndexError, '%s has no node %s'%(link_class, value)
- # register the unlink with the old linked node
- if node[key] is not None:
- self.db.addjournal(link_class, node[key], 'unlink',
- (self.classname, nodeid, key))
+ if self.properties[key].do_journal:
+ # register the unlink with the old linked node
+ if node[key] is not None:
+ self.db.addjournal(link_class, node[key], 'unlink',
+ (self.classname, nodeid, key))
- # register the link with the newly linked node
- if value is not None:
- self.db.addjournal(link_class, value, 'link',
- (self.classname, nodeid, key))
+ # register the link with the newly linked node
+ if value is not None:
+ self.db.addjournal(link_class, value, 'link',
+ (self.classname, nodeid, key))
elif isinstance(prop, Multilink):
if type(value) != type([]):
value = l
propvalues[key] = value
- #handle removals
- l = node[key]
+ # handle removals
+ if node.has_key(key):
+ l = node[key]
+ else:
+ l = []
for id in l[:]:
if id in value:
continue
# register the unlink with the old linked node
- self.db.addjournal(link_class, id, 'unlink',
- (self.classname, nodeid, key))
+ if self.properties[key].do_journal:
+ self.db.addjournal(link_class, id, 'unlink',
+ (self.classname, nodeid, key))
l.remove(id)
# handle additions
for id in value:
if not self.db.hasnode(link_class, id):
- raise IndexError, '%s has no node %s'%(link_class, id)
+ raise IndexError, '%s has no node %s'%(
+ link_class, id)
if id in l:
continue
# register the link with the newly linked node
- self.db.addjournal(link_class, id, 'link',
- (self.classname, nodeid, key))
+ if self.properties[key].do_journal:
+ self.db.addjournal(link_class, id, 'link',
+ (self.classname, nodeid, key))
l.append(id)
elif isinstance(prop, String):
raise TypeError, 'new property "%s" not a Password'% key
propvalues[key] = value = str(value)
- elif isinstance(prop, Date):
+ elif value is not None and isinstance(prop, Date):
if not isinstance(value, date.Date):
raise TypeError, 'new property "%s" not a Date'% key
propvalues[key] = value = value.get_tuple()
- elif isinstance(prop, Interval):
+ elif value is not None and isinstance(prop, Interval):
if not isinstance(value, date.Interval):
raise TypeError, 'new property "%s" not an Interval'% key
propvalues[key] = value = value.get_tuple()
class Node:
''' A convenience wrapper for the given node
'''
- def __init__(self, cl, nodeid):
+ def __init__(self, cl, nodeid, cache=1):
self.__dict__['cl'] = cl
self.__dict__['nodeid'] = nodeid
+ self.__dict__['cache'] = cache
def keys(self, protected=1):
return self.cl.getprops(protected=protected).keys()
def values(self, protected=1):
l = []
for name in self.cl.getprops(protected=protected).keys():
- l.append(self.cl.get(self.nodeid, name))
+ l.append(self.cl.get(self.nodeid, name, cache=self.cache))
return l
def items(self, protected=1):
l = []
for name in self.cl.getprops(protected=protected).keys():
- l.append((name, self.cl.get(self.nodeid, name)))
+ l.append((name, self.cl.get(self.nodeid, name, cache=self.cache)))
return l
def has_key(self, name):
return self.cl.getprops().has_key(name)
if self.__dict__.has_key(name):
return self.__dict__[name]
try:
- return self.cl.get(self.nodeid, name)
+ return self.cl.get(self.nodeid, name, cache=self.cache)
except KeyError, value:
# we trap this but re-raise it as AttributeError - all other
# exceptions should pass through untrapped
# nope, no such attribute
raise AttributeError, str(value)
def __getitem__(self, name):
- return self.cl.get(self.nodeid, name)
+ return self.cl.get(self.nodeid, name, cache=self.cache)
def __setattr__(self, name, value):
try:
return self.cl.set(self.nodeid, **{name: value})
#
# $Log: not supported by cvs2svn $
+# Revision 1.49 2002/01/16 07:02:57 richard
+# . lots of date/interval related changes:
+# - more relaxed date format for input
+#
+# Revision 1.48 2002/01/14 06:32:34 richard
+# . #502951 ] adding new properties to old database
+#
+# Revision 1.47 2002/01/14 02:20:15 richard
+# . changed all config accesses so they access either the instance or the
+# config attriubute on the db. This means that all config is obtained from
+# instance_config instead of the mish-mash of classes. This will make
+# switching to a ConfigParser setup easier too, I hope.
+#
+# At a minimum, this makes migration a _little_ easier (a lot easier in the
+# 0.5.0 switch, I hope!)
+#
+# Revision 1.46 2002/01/07 10:42:23 richard
+# oops
+#
+# Revision 1.45 2002/01/02 04:18:17 richard
+# hyperdb docstrings
+#
+# Revision 1.44 2002/01/02 02:31:38 richard
+# Sorry for the huge checkin message - I was only intending to implement #496356
+# but I found a number of places where things had been broken by transactions:
+# . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
+# for _all_ roundup-generated smtp messages to be sent to.
+# . the transaction cache had broken the roundupdb.Class set() reactors
+# . newly-created author users in the mailgw weren't being committed to the db
+#
+# Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
+# on when I found that stuff :):
+# . #496356 ] Use threading in messages
+# . detectors were being registered multiple times
+# . added tests for mailgw
+# . much better attaching of erroneous messages in the mail gateway
+#
+# Revision 1.43 2001/12/20 06:13:24 rochecompaan
+# Bugs fixed:
+# . Exception handling in hyperdb for strings-that-look-like numbers got
+# lost somewhere
+# . Internet Explorer submits full path for filename - we now strip away
+# the path
+# Features added:
+# . Link and multilink properties are now displayed sorted in the cgi
+# interface
+#
# Revision 1.42 2001/12/16 10:53:37 richard
# take a copy of the node dict so that the subsequent set
# operation doesn't modify the oldvalues structure