![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/hyperdb.py b/roundup/hyperdb.py
index 252194c0c93636a041f3a316d733841848c0f9a8..8c6ed345fcda4f734512c2d78ace2981f7a8bc92 100644 (file)
--- a/roundup/hyperdb.py
+++ b/roundup/hyperdb.py
-# $Id: hyperdb.py,v 1.9 2001-07-29 09:28:23 richard Exp $
+#
+# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+# This module is free software, and you may redistribute it and/or modify
+# under the same terms as Python, so long as this copyright message and
+# disclaimer are retained in their original form.
+#
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+#
+# $Id: hyperdb.py,v 1.29 2001-10-27 00:17:41 richard Exp $
# standard python modules
import cPickle, re, string
# roundup modules
-import date
+import date, password
#
# Types
#
-class BaseType:
- isStringType = 0
- isDateType = 0
- isIntervalType = 0
- isLinkType = 0
- isMultilinkType = 0
-
-class String(BaseType):
- def __init__(self):
- """An object designating a String property."""
- pass
+class String:
+ """An object designating a String property."""
def __repr__(self):
return '<%s>'%self.__class__
- isStringType = 1
-class Date(BaseType, String):
- isDateType = 1
+class Password:
+ """An object designating a Password property."""
+ def __repr__(self):
+ return '<%s>'%self.__class__
-class Interval(BaseType, String):
- isIntervalType = 1
+class Date:
+ """An object designating a Date property."""
+ def __repr__(self):
+ return '<%s>'%self.__class__
-class Link(BaseType):
+class Interval:
+ """An object designating an Interval property."""
+ def __repr__(self):
+ return '<%s>'%self.__class__
+
+class Link:
+ """An object designating a Link property that links to a
+ node in a specified class."""
def __init__(self, classname):
- """An object designating a Link property that links to
- nodes in a specified class."""
self.classname = classname
def __repr__(self):
return '<%s to "%s">'%(self.__class__, self.classname)
- isLinkType = 1
-class Multilink(BaseType, Link):
+class Multilink:
"""An object designating a Multilink property that links
to nodes in a specified class.
"""
- isMultilinkType = 1
+ def __init__(self, classname):
+ self.classname = classname
+ def __repr__(self):
+ return '<%s to "%s">'%(self.__class__, self.classname)
class DatabaseError(ValueError):
pass
RETIRED_FLAG = '__hyperdb_retired'
+_marker = []
#
# The base Class class
#
else:
raise ValueError, 'node with key "%s" exists'%value
- prop = self.properties[key]
+ # try to handle this property
+ try:
+ prop = self.properties[key]
+ except KeyError:
+ raise KeyError, '"%s" has no property "%s"'%(self.classname,
+ key)
- if prop.isLinkType:
+ if isinstance(prop, Link):
if type(value) != type(''):
raise ValueError, 'link value must be String'
-# value = str(value)
link_class = self.properties[key].classname
# if it isn't a number, it's a key
if not num_re.match(value):
self.db.addjournal(link_class, value, 'link',
(self.classname, newid, key))
- elif prop.isMultilinkType:
+ elif isinstance(prop, Multilink):
if type(value) != type([]):
raise TypeError, 'new property "%s" not a list of ids'%key
link_class = self.properties[key].classname
self.db.addjournal(link_class, id, 'link',
(self.classname, newid, key))
- elif prop.isStringType:
+ elif isinstance(prop, String):
if type(value) != type(''):
raise TypeError, 'new property "%s" not a string'%key
- elif prop.isDateType:
- if not hasattr(value, 'isDate'):
- raise TypeError, 'new property "%s" not a Date'% key
+ elif isinstance(prop, Password):
+ if not isinstance(value, password.Password):
+ raise TypeError, 'new property "%s" not a Password'%key
- elif prop.isIntervalType:
- if not hasattr(value, 'isInterval'):
- raise TypeError, 'new property "%s" not an Interval'% key
+ elif isinstance(prop, Date):
+ if not isinstance(value, date.Date):
+ raise TypeError, 'new property "%s" not a Date'%key
+ elif isinstance(prop, Interval):
+ if not isinstance(value, date.Interval):
+ raise TypeError, 'new property "%s" not an Interval'%key
+
+ # make sure there's data where there needs to be
for key, prop in self.properties.items():
if propvalues.has_key(key):
continue
- if prop.isMultilinkType:
+ if key == self.key:
+ raise ValueError, 'key property "%s" is required'%key
+ if isinstance(prop, Multilink):
propvalues[key] = []
else:
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()
+ elif isinstance(prop, Interval):
+ propvalues[key] = propvalues[key].get_tuple()
+ elif isinstance(prop, Password):
+ propvalues[key] = str(propvalues[key])
+
# done
self.db.addnode(self.classname, newid, propvalues)
self.db.addjournal(self.classname, newid, 'create', propvalues)
return newid
- def get(self, nodeid, propname):
+ def get(self, nodeid, propname, default=_marker):
"""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.
"""
+ d = self.db.getnode(self.classname, nodeid)
+
+ # convert the marshalled data to instances
+ for key, prop in self.properties.items():
+ if isinstance(prop, Date):
+ d[key] = date.Date(d[key])
+ elif isinstance(prop, Interval):
+ d[key] = date.Interval(d[key])
+ elif isinstance(prop, Password):
+ p = password.Password()
+ p.unpack(d[key])
+ d[key] = p
+
if propname == 'id':
return nodeid
-# nodeid = str(nodeid)
- d = self.db.getnode(self.classname, nodeid)
+ if not d.has_key(propname) and default is not _marker:
+ return default
return d[propname]
# XXX not in spec
if self.db.journaltag is None:
raise DatabaseError, 'Database open read-only'
-# nodeid = str(nodeid)
node = self.db.getnode(self.classname, nodeid)
if node.has_key(self.db.RETIRED_FLAG):
raise IndexError
if not node.has_key(key):
raise KeyError, key
- if key == self.key:
+ # check to make sure we're not duplicating an existing key
+ if key == self.key and node[key] != value:
try:
self.lookup(value)
except KeyError:
prop = self.properties[key]
- if prop.isLinkType:
-# value = str(value)
+ if isinstance(prop, Link):
link_class = self.properties[key].classname
# if it isn't a number, it's a key
if type(value) != type(''):
self.db.addjournal(link_class, value, 'link',
(self.classname, nodeid, key))
- elif prop.isMultilinkType:
+ elif isinstance(prop, Multilink):
if type(value) != type([]):
raise TypeError, 'new property "%s" not a list of ids'%key
link_class = self.properties[key].classname
(self.classname, nodeid, key))
l.append(id)
- elif prop.isStringType:
+ elif isinstance(prop, String):
if value is not None and type(value) != type(''):
raise TypeError, 'new property "%s" not a string'%key
- elif prop.isDateType:
- if not hasattr(value, 'isDate'):
+ elif isinstance(prop, Password):
+ if not isinstance(value, password.Password):
+ raise TypeError, 'new property "%s" not a Password'% key
+ propvalues[key] = value = str(value)
+
+ elif 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 prop.isIntervalType:
- if not hasattr(value, 'isInterval'):
+ elif isinstance(prop, Interval):
+ if not isinstance(value, date.Interval):
raise TypeError, 'new property "%s" not an Interval'% key
+ propvalues[key] = value = value.get_tuple()
node[key] = value
Retired nodes are not returned by the find(), list(), or lookup()
methods, and other nodes may reuse the values of their key properties.
"""
-# nodeid = str(nodeid)
if self.db.journaltag is None:
raise DatabaseError, 'Database open read-only'
node = self.db.getnode(self.classname, nodeid)
None, or a TypeError is raised. The values of the key property on
all existing nodes must be unique or a ValueError is raised.
"""
+ # TODO: validate that the property is a String!
self.key = propname
def getkey(self):
"""Return the name of the key property for this class or None."""
return self.key
- def labelprop(self):
+ def labelprop(self, default_to_id=0):
''' Return the property name for a label for the given node.
This method attempts to generate a consistent label for the node.
return 'name'
elif props.has_key('title'):
return 'title'
+ if default_to_id:
+ return 'id'
props = props.keys()
props.sort()
return props[0]
"""
propspec = propspec.items()
for propname, nodeid in propspec:
-# nodeid = str(nodeid)
# check the prop is OK
prop = self.properties[propname]
- if not prop.isLinkType and not prop.isMultilinkType:
+ if not isinstance(prop, Link) and not isinstance(prop, Multilink):
raise TypeError, "'%s' not a Link/Multilink property"%propname
if not self.db.hasnode(prop.classname, nodeid):
raise ValueError, '%s has no node %s'%(link_class, nodeid)
if node.has_key(self.db.RETIRED_FLAG):
continue
for propname, nodeid in propspec:
-# nodeid = str(nodeid)
property = node[propname]
- if prop.isLinkType and nodeid == property:
+ if isinstance(prop, Link) and nodeid == property:
l.append(id)
- elif prop.isMultilinkType and nodeid in property:
+ elif isinstance(prop, Multilink) and nodeid in property:
l.append(id)
cldb.close()
return l
def stringFind(self, **requirements):
- """Locate a particular node by matching a set of its String properties.
+ """Locate a particular node by matching a set of its String
+ properties in a caseless search.
If the property is not a String property, a TypeError is raised.
"""
for propname in requirements.keys():
prop = self.properties[propname]
- if not prop.isStringType:
+ if isinstance(not prop, String):
raise TypeError, "'%s' not a String property"%propname
+ requirements[propname] = requirements[propname].lower()
l = []
cldb = self.db.getclassdb(self.classname)
for nodeid in self.db.getnodeids(self.classname, cldb):
if node.has_key(self.db.RETIRED_FLAG):
continue
for key, value in requirements.items():
- if node[key] != value:
+ if node[key].lower() != value:
break
else:
l.append(nodeid)
props = self.getprops()
for k, v in filterspec.items():
propclass = props[k]
- if propclass.isLinkType:
+ if isinstance(propclass, Link):
if type(v) is not type([]):
v = [v]
# replace key values with node ids
u = []
link_class = self.db.classes[propclass.classname]
for entry in v:
- if not num_re.match(entry):
+ if entry == '-1': entry = None
+ elif not num_re.match(entry):
try:
entry = link_class.lookup(entry)
except:
- raise ValueError, 'new property "%s": %s not a %s'%(
+ raise ValueError, 'property "%s": %s not a %s'%(
k, entry, self.properties[k].classname)
u.append(entry)
l.append((0, k, u))
- elif propclass.isMultilinkType:
+ elif isinstance(propclass, Multilink):
if type(v) is not type([]):
v = [v]
# replace key values with node ids
k, entry, self.properties[k].classname)
u.append(entry)
l.append((1, k, u))
- elif propclass.isStringType:
- if '*' in v or '?' in v:
- # simple glob searching
- v = v.replace('?', '.')
- v = v.replace('*', '.*?')
- v = re.compile(v)
- l.append((2, k, v))
- elif v[0] == '^':
- # start-anchored
- if v[-1] == '$':
- # _and_ end-anchored
- l.append((6, k, v[1:-1]))
- l.append((3, k, v[1:]))
- elif v[-1] == '$':
- # end-anchored
- l.append((4, k, v[:-1]))
- else:
- # substring
- l.append((5, k, v))
+ elif isinstance(propclass, String):
+ # simple glob searching
+ v = re.sub(r'([\|\{\}\\\.\+\[\]\(\)])', r'\\\1', v)
+ v = v.replace('?', '.')
+ v = v.replace('*', '.*?')
+ l.append((2, k, re.compile(v, re.I)))
else:
l.append((6, k, v))
filterspec = l
elif t == 2 and not v.search(node[k]):
# RE search
break
- elif t == 3 and node[k][:len(v)] != v:
- # start anchored
- break
- elif t == 4 and node[k][-len(v):] != v:
- # end anchored
- break
- elif t == 5 and node[k].find(v) == -1:
- # substring search
- break
elif t == 6 and node[k] != v:
# straight value comparison for the other types
break
propclass = properties[prop]
# String and Date values are sorted in the natural way
- if propclass.isStringType:
+ if isinstance(propclass, String):
# clean up the strings
if av and av[0] in string.uppercase:
av = an[prop] = av.lower()
if bv and bv[0] in string.uppercase:
bv = bn[prop] = bv.lower()
- if propclass.isStringType or propclass.isDateType:
+ if (isinstance(propclass, String) or
+ isinstance(propclass, Date)):
+ # it might be a string that's really an integer
+ try:
+ av = int(av)
+ bv = int(bv)
+ except:
+ pass
if dir == '+':
r = cmp(av, bv)
if r != 0: return r
# the "order" property on the linked nodes if it is
# present; or otherwise on the key string of the linked
# nodes; or finally on the node ids.
- elif propclass.isLinkType:
+ elif isinstance(propclass, Link):
link = db.classes[propclass.classname]
if av is None and bv is not None: return -1
if av is not None and bv is None: return 1
# Multilink properties are sorted according to how many
# links are present.
- elif propclass.isMultilinkType:
+ elif isinstance(propclass, Multilink):
if dir == '+':
r = cmp(len(av), len(bv))
if r != 0: return r
# Manipulating properties:
- def getprops(self):
- """Return a dictionary mapping property names to property objects."""
+ def getprops(self, protected=1):
+ """Return a dictionary mapping property names to property objects.
+ If the "protected" flag is true, we include protected properties -
+ those which may not be modified."""
d = self.properties.copy()
- d['id'] = String()
+ if protected:
+ d['id'] = String()
return d
def addprop(self, **properties):
def __init__(self, cl, nodeid):
self.__dict__['cl'] = cl
self.__dict__['nodeid'] = nodeid
- def keys(self):
- return self.cl.getprops().keys()
+ 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))
+ 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)))
+ return l
def has_key(self, name):
return self.cl.getprops().has_key(name)
def __getattr__(self, name):
if self.__dict__.has_key(name):
- return self.__dict__['name']
+ return self.__dict__[name]
try:
return self.cl.get(self.nodeid, name)
except KeyError, value:
#
# $Log: not supported by cvs2svn $
+# Revision 1.28 2001/10/21 04:44:50 richard
+# bug #473124: UI inconsistency with Link fields.
+# This also prompted me to fix a fairly long-standing usability issue -
+# that of being able to turn off certain filters.
+#
+# Revision 1.27 2001/10/20 23:44:27 richard
+# Hyperdatabase sorts strings-that-look-like-numbers as numbers now.
+#
+# Revision 1.26 2001/10/16 03:48:01 richard
+# admin tool now complains if a "find" is attempted with a non-link property.
+#
+# Revision 1.25 2001/10/11 00:17:51 richard
+# Reverted a change in hyperdb so the default value for missing property
+# values in a create() is None and not '' (the empty string.) This obviously
+# breaks CSV import/export - the string 'None' will be created in an
+# export/import operation.
+#
+# Revision 1.24 2001/10/10 03:54:57 richard
+# Added database importing and exporting through CSV files.
+# Uses the csv module from object-craft for exporting if it's available.
+# Requires the csv module for importing.
+#
+# Revision 1.23 2001/10/09 23:58:10 richard
+# Moved the data stringification up into the hyperdb.Class class' get, set
+# and create methods. This means that the data is also stringified for the
+# journal call, and removes duplication of code from the backends. The
+# backend code now only sees strings.
+#
+# Revision 1.22 2001/10/09 07:25:59 richard
+# Added the Password property type. See "pydoc roundup.password" for
+# implementation details. Have updated some of the documentation too.
+#
+# Revision 1.21 2001/10/05 02:23:24 richard
+# . roundup-admin create now prompts for property info if none is supplied
+# on the command-line.
+# . hyperdb Class getprops() method may now return only the mutable
+# properties.
+# . Login now uses cookies, which makes it a whole lot more flexible. We can
+# now support anonymous user access (read-only, unless there's an
+# "anonymous" user, in which case write access is permitted). Login
+# handling has been moved into cgi_client.Client.main()
+# . The "extended" schema is now the default in roundup init.
+# . The schemas have had their page headings modified to cope with the new
+# login handling. Existing installations should copy the interfaces.py
+# file from the roundup lib directory to their instance home.
+# . Incorrectly had a Bizar Software copyright on the cgitb.py module from
+# Ping - has been removed.
+# . Fixed a whole bunch of places in the CGI interface where we should have
+# been returning Not Found instead of throwing an exception.
+# . Fixed a deviation from the spec: trying to modify the 'id' property of
+# an item now throws an exception.
+#
+# Revision 1.20 2001/10/04 02:12:42 richard
+# Added nicer command-line item adding: passing no arguments will enter an
+# interactive more which asks for each property in turn. While I was at it, I
+# fixed an implementation problem WRT the spec - I wasn't raising a
+# ValueError if the key property was missing from a create(). Also added a
+# protected=boolean argument to getprops() so we can list only the mutable
+# properties (defaults to yes, which lists the immutables).
+#
+# Revision 1.19 2001/08/29 04:47:18 richard
+# Fixed CGI client change messages so they actually include the properties
+# changed (again).
+#
+# Revision 1.18 2001/08/16 07:34:59 richard
+# better CGI text searching - but hidden filter fields are disappearing...
+#
+# Revision 1.17 2001/08/16 06:59:58 richard
+# all searches use re now - and they're all case insensitive
+#
+# Revision 1.16 2001/08/15 23:43:18 richard
+# Fixed some isFooTypes that I missed.
+# Refactored some code in the CGI code.
+#
+# Revision 1.15 2001/08/12 06:32:36 richard
+# using isinstance(blah, Foo) now instead of isFooType
+#
+# Revision 1.14 2001/08/07 00:24:42 richard
+# stupid typo
+#
+# Revision 1.13 2001/08/07 00:15:51 richard
+# Added the copyright/license notice to (nearly) all files at request of
+# Bizar Software.
+#
+# Revision 1.12 2001/08/02 06:38:17 richard
+# Roundupdb now appends "mailing list" information to its messages which
+# include the e-mail address and web interface address. Templates may
+# override this in their db classes to include specific information (support
+# instructions, etc).
+#
+# Revision 1.11 2001/08/01 04:24:21 richard
+# mailgw was assuming certain properties existed on the issues being created.
+#
+# Revision 1.10 2001/07/30 02:38:31 richard
+# get() now has a default arg - for migration only.
+#
+# Revision 1.9 2001/07/29 09:28:23 richard
+# Fixed sorting by clicking on column headings.
+#
# Revision 1.8 2001/07/29 08:27:40 richard
# Fixed handling of passed-in values in form elements (ie. during a
# drill-down)