Code

Added dummy hooks for I18N and some preliminary (test) markup of
[roundup.git] / roundup / hyperdb.py
index 32729f19d2e9d91fc662c7f6bd3ffddbcc2a7176..f19ed358d2475a96e853e1f9d5878a779f9db558 100644 (file)
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: hyperdb.py,v 1.21 2001-10-05 02:23:24 richard Exp $
+# $Id: hyperdb.py,v 1.34 2001-11-21 04:04:43 richard Exp $
 
 # standard python modules
 import cPickle, re, string
 
 # roundup modules
-import date
+import date, password
 
 
 #
@@ -32,6 +32,11 @@ class String:
     def __repr__(self):
         return '<%s>'%self.__class__
 
+class Password:
+    """An object designating a Password property."""
+    def __repr__(self):
+        return '<%s>'%self.__class__
+
 class Date:
     """An object designating a Date property."""
     def __repr__(self):
@@ -189,14 +194,19 @@ class Class:
                 if type(value) != type(''):
                     raise TypeError, 'new property "%s" not a string'%key
 
+            elif isinstance(prop, Password):
+                if not isinstance(value, password.Password):
+                    raise TypeError, 'new property "%s" not a Password'%key
+
             elif isinstance(prop, Date):
                 if not isinstance(value, date.Date):
-                    raise TypeError, 'new property "%s" not a Date'% key
+                    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
+                    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
@@ -207,6 +217,15 @@ class Class:
             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)
@@ -220,6 +239,18 @@ class Class:
         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
         if not d.has_key(propname) and default is not _marker:
@@ -264,9 +295,6 @@ class Class:
             raise IndexError
         num_re = re.compile('^\d+$')
         for key, value in propvalues.items():
-            if not node.has_key(key):
-                raise KeyError, key
-
             # check to make sure we're not duplicating an existing key
             if key == self.key and node[key] != value:
                 try:
@@ -276,6 +304,9 @@ class Class:
                 else:
                     raise ValueError, 'node with key "%s" exists'%value
 
+            # this will raise the KeyError if the property isn't valid
+            # ... we don't use getprops() here because we only care about
+            # the writeable properties.
             prop = self.properties[key]
 
             if isinstance(prop, Link):
@@ -347,13 +378,20 @@ class Class:
                 if value is not None and type(value) != type(''):
                     raise TypeError, 'new property "%s" not a string'%key
 
+            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 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
 
@@ -400,6 +438,7 @@ class Class:
         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):
@@ -468,7 +507,7 @@ class Class:
             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)
+                raise ValueError, '%s has no node %s'%(prop.classname, nodeid)
 
         # ok, now do the find
         cldb = self.db.getclassdb(self.classname)
@@ -487,7 +526,8 @@ class Class:
         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.
         
@@ -497,6 +537,7 @@ class Class:
             prop = self.properties[propname]
             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):
@@ -504,7 +545,7 @@ class Class:
             if node.has_key(self.db.RETIRED_FLAG):
                 continue
             for key, value in requirements.items():
-                if node[key] != value:
+                if node[key] and node[key].lower() != value:
                     break
             else:
                 l.append(nodeid)
@@ -545,11 +586,12 @@ class Class:
                 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)
 
@@ -605,15 +647,6 @@ class Class:
                 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
@@ -647,17 +680,28 @@ class Class:
             # sort by group and then sort
             for list in group, sort:
                 for dir, prop in list:
-                    # handle the properties that might be "faked"
-                    if not an.has_key(prop):
-                        an[prop] = cl.get(a_id, prop)
-                    av = an[prop]
-                    if not bn.has_key(prop):
-                        bn[prop] = cl.get(b_id, prop)
-                    bv = bn[prop]
-
                     # sorting is class-specific
                     propclass = properties[prop]
 
+                    # handle the properties that might be "faked"
+                    # also, handle possible missing properties
+                    try:
+                        if not an.has_key(prop):
+                            an[prop] = cl.get(a_id, prop)
+                        av = an[prop]
+                    except KeyError:
+                        # the node doesn't have a value for this property
+                        if isinstance(propclass, Multilink): av = []
+                        else: av = ''
+                    try:
+                        if not bn.has_key(prop):
+                            bn[prop] = cl.get(b_id, prop)
+                        bv = bn[prop]
+                    except KeyError:
+                        # the node doesn't have a value for this property
+                        if isinstance(propclass, Multilink): bv = []
+                        else: bv = ''
+
                     # String and Date values are sorted in the natural way
                     if isinstance(propclass, String):
                         # clean up the strings
@@ -667,6 +711,12 @@ class Class:
                             bv = bn[prop] = bv.lower()
                     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
@@ -766,13 +816,23 @@ class Node:
     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:
@@ -800,6 +860,73 @@ def Choice(name, *options):
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.33  2001/11/21 03:40:54  richard
+# more new property handling
+#
+# Revision 1.32  2001/11/21 03:11:28  richard
+# Better handling of new properties.
+#
+# Revision 1.31  2001/11/12 22:01:06  richard
+# Fixed issues with nosy reaction and author copies.
+#
+# Revision 1.30  2001/11/09 10:11:08  richard
+#  . roundup-admin now handles all hyperdb exceptions
+#
+# Revision 1.29  2001/10/27 00:17:41  richard
+# Made Class.stringFind() do caseless matching.
+#
+# 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