Transitive-property support.

- Fixed some of the pet-peeves from pep8
- Better parameter names for new _subselect method
- use new-style class for support.Proptree but needed a new-style class
  for the property I introduced anyway.
- Fix a bug where searching did the wrong thing (interestingly enough
  the same wrong thing for all backends): A search for
  {'messages': ['1'], 'messages.author': ['2']}
  would ignore the 'messages' part (messages being non-leaf node in
  proptree). Fixed and added a regression test for this.
- Added the transitive searching to the SearchAction. New method
  get_transitive_prop introduced in hyperdb that does the transitive
  version of getprops()[name]. Fixed two tests to use the (faked) method
  instead of getprop.

Now searching for transitive props via the web-interface works for me.
Thanks to alexander smishlajev for pointing me at the coding style.
Sorry for stepping on the peeves -- I'm using a different coding style
in most other projects I'm doing ...

Author: Ralf Schlatterbeck

roundup/backends/back_mysql.py

@@ -1,4 +1,4 @@
-#$Id: back_mysql.py,v 1.69 2006-07-07 15:04:28 schlatterbeck Exp $
+#$Id: back_mysql.py,v 1.70 2006-07-13 10:14:56 schlatterbeck Exp $
 #
 # Copyright (c) 2003 Martynas Sklyzmantas, Andrey Lebedev <[email protected]>
 #
@@ -550,13 +550,13 @@ def sql_close(self):
                 raise
 
 class MysqlClass:
-    def _subselect (self, cn, tn) :
+    def _subselect(self, classname, multilink_table):
         ''' "I can't believe it's not a toy RDBMS"
            see, even toy RDBMSes like gadfly and sqlite can do sub-selects...
         '''
-        self.db.sql('select nodeid from %s'%tn)
+        self.db.sql('select nodeid from %s'%multilink_table)
         s = ','.join([x[0] for x in self.db.sql_fetchall()])
-        return '_%s.id not in (%s)'%(cn, s)
+        return '_%s.id not in (%s)'%(classname, s)
 
 class Class(MysqlClass, rdbms_common.Class):
     pass

roundup/backends/rdbms_common.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-#$Id: rdbms_common.py,v 1.172 2006-07-08 18:28:18 schlatterbeck Exp $
+#$Id: rdbms_common.py,v 1.173 2006-07-13 10:14:56 schlatterbeck Exp $
 ''' Relational database (SQL) backend common code.
 
 Basics:
@@ -2014,13 +2014,14 @@ def getnodeids(self, retired=None):
         ids = [str(x[0]) for x in self.db.cursor.fetchall()]
         return ids
 
-    def _subselect (self, cn, tn) :
+    def _subselect(self, classname, multilink_table):
         '''Create a subselect. This is factored out because some
            databases (hmm only one, so far) doesn't support subselects
            look for "I can't believe it's not a toy RDBMS" in the mysql
            backend.
         '''
-        return '_%s.id not in (select nodeid from %s)'%(cn, tn)
+        return '_%s.id not in (select nodeid from %s)'%(classname,
+            multilink_table)
 
     def filter(self, search_matches, filterspec, sort=(None,None),
             group=(None,None)):
@@ -2059,29 +2060,20 @@ def filter(self, search_matches, filterspec, sort=(None,None),
 
         # figure the WHERE clause from the filterspec
         mlfilt = 0      # are we joining with Multilink tables?
-        proptree = self._proptree (filterspec)
-        for p in proptree :
+        proptree = self._proptree(filterspec)
+        for p in proptree:
             cn = p.classname
             ln = p.uniqname
             pln = p.parent.uniqname
             pcn = p.parent.classname
             k = p.name
             v = p.val
             propclass = p.prcls
-            if p.children :
-                if isinstance (propclass, Multilink) :
-                    mlfilt = 1
-                    mn = '%s_%s'%(pcn, p.name)
-                    frum.append(mn)
-                    frum.append('_%s as _%s' % (cn, ln))
-                    where.append('_%s.id=%s.nodeid and %s.linkid=_%s.id'%(pln,
-                        mn, mn, ln))
-                else :
-                    if not isinstance (propclass, Link) :
-                        raise ValueError,"%s must be Link/Multilink property"%k
-                    frum.append('_%s as _%s' % (cn, ln))
-                    where.append('_%s._%s=_%s.id'%(pln, k, ln))
-                continue
+            if p.children and not isinstance(propclass, Multilink):
+                if not isinstance(propclass, Link):
+                    raise ValueError,"%s must be Link/Multilink property"%k
+                frum.append('_%s as _%s' % (cn, ln))
+                where.append('_%s._%s=_%s.id'%(pln, k, ln))
             # now do other where clause stuff
             elif isinstance(propclass, Multilink):
                 mlfilt = 1
@@ -2090,17 +2082,20 @@ def filter(self, search_matches, filterspec, sort=(None,None),
                     # only match rows that have count(linkid)=0 in the
                     # corresponding multilink table)
                     where.append(self._subselect(pcn, tn))
-                elif isinstance(v, type([])):
-                    frum.append(tn)
-                    s = ','.join([a for x in v])
-                    where.append('_%s.id=%s.nodeid and %s.linkid in (%s)'%(pln,
-                        tn, tn, s))
-                    args = args + v
                 else:
                     frum.append(tn)
-                    where.append('_%s.id=%s.nodeid and %s.linkid=%s'%(pln, tn,
-                        tn, a))
-                    args.append(v)
+                    where.append('_%s.id=%s.nodeid'%(pln,tn))
+                    if p.children:
+                        frum.append('_%s as _%s' % (cn, ln))
+                        where.append('%s.linkid=_%s.id'%(tn, ln))
+                    if v:
+                        if isinstance(v, type([])):
+                            s = ','.join([a for x in v])
+                            where.append('%s.linkid in (%s)'%(tn, s))
+                            args = args + v
+                        else:
+                            where.append('%s.linkid=%s'%(tn, a))
+                            args.append(v)
             elif k == 'id':
                 if isinstance(v, type([])):
                     s = ','.join([a for x in v])

roundup/cgi/actions.py

@@ -1,4 +1,4 @@
-#$Id: actions.py,v 1.60 2006-04-27 03:44:47 richard Exp $
+#$Id: actions.py,v 1.61 2006-07-13 10:14:56 schlatterbeck Exp $
 
 import re, cgi, StringIO, urllib, Cookie, time, random, csv, codecs
 
@@ -221,9 +221,10 @@ def handle(self):
 
     def fakeFilterVars(self):
         """Add a faked :filter form variable for each filtering prop."""
-        props = self.db.classes[self.classname].getprops()
+        cls = self.db.classes[self.classname]
         for key in self.form.keys():
-            if not props.has_key(key):
+            prop = cls.get_transitive_prop(key)
+            if not prop:
                 continue
             if isinstance(self.form[key], type([])):
                 # search for at least one entry which is not empty
@@ -235,7 +236,7 @@ def fakeFilterVars(self):
             else:
                 if not self.form[key].value:
                     continue
-                if isinstance(props[key], hyperdb.String):
+                if isinstance(prop, hyperdb.String):
                     v = self.form[key].value
                     l = token.token_split(v)
                     if len(l) > 1 or l[0] != v:

roundup/cgi/templating.py

@@ -2132,11 +2132,11 @@ def _post_init(self):
         self.filterspec = {}
         db = self.client.db
         if self.classname is not None:
-            props = db.getclass(self.classname).getprops()
+            cls = db.getclass (self.classname)
             for name in self.filter:
                 if not self.form.has_key(name):
                     continue
-                prop = props[name]
+                prop = cls.get_transitive_prop (name)
                 fv = self.form[name]
                 if (isinstance(prop, hyperdb.Link) or
                         isinstance(prop, hyperdb.Multilink)):
@@ -2314,11 +2314,12 @@ def indexargs_url(self, url, args):
 
         # finally, the remainder of the filter args in the request
         if self.classname and self.filterspec:
-            props = self.client.db.getclass(self.classname).getprops()
+            cls = self.client.db.getclass(self.classname)
             for k,v in self.filterspec.items():
                 if not args.has_key(k):
                     if type(v) == type([]):
-                        if isinstance(props[k], hyperdb.String):
+                        prop = cls.get_transitive_prop(k)
+                        if isinstance(prop, hyperdb.String):
                             l.append('%s=%s'%(k, '%20'.join([q(i) for i in v])))
                         else:
                             l.append('%s=%s'%(k, ','.join([q(i) for i in v])))

roundup/hyperdb.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-# $Id: hyperdb.py,v 1.121 2006-07-08 18:28:18 schlatterbeck Exp $
+# $Id: hyperdb.py,v 1.122 2006-07-13 10:14:56 schlatterbeck Exp $
 
 """Hyperdatabase implementation, especially field types.
 """
@@ -713,30 +713,50 @@ def _filter(self, search_matches, filterspec, sort=(None,None),
         """
         raise NotImplementedError
 
-    def _proptree (self, filterspec) :
+    def _proptree (self, filterspec):
         """Build a tree of all transitive properties in the given
         filterspec.
         """
         proptree = Proptree (self.db, self, '', self.getprops ())
-        for key, v in filterspec.iteritems () :
+        for key, v in filterspec.iteritems ():
             keys = key.split ('.')
             p = proptree
-            for k in keys :
+            for k in keys:
                 p = p.append (k)
             p.val = v
         return proptree
 
-    def _propsearch (self, search_matches, proptree, sort, group) :
+    def _propsearch (self, search_matches, proptree, sort, group):
         """ Recursively search for the given properties in proptree.
         Once all properties are non-transitive, the search generates a
         simple _filter call which does the real work
         """
-        for p in proptree.children :
-            if not p.children : continue
+        for p in proptree.children:
+            if not p.children:
+                continue
             p.val = p.cls._propsearch (None, p, (None, None), (None, None))
         filterspec = dict ([(p.name, p.val) for p in proptree.children])
         return self._filter (search_matches, filterspec, sort, group)
 
+    def get_transitive_prop (self, propname_path, default = None) :
+        """Expand a transitive property (individual property names
+        separated by '.' into a new property at the end of the path. If
+        one of the names does not refer to a valid property, we return
+        None.
+        Example propname_path (for class issue): "messages.author"
+        """
+        props = self.db.getclass(self.classname).getprops()
+        for k in propname_path.split('.'):
+            try :
+                prop = props[k]
+            except KeyError, TypeError:
+                return default
+            cl = getattr (prop, 'classname', None)
+            props = None
+            if cl:
+                props = self.db.getclass (cl).getprops()
+        return prop
+
     def filter(self, search_matches, filterspec, sort=(None,None),
             group=(None,None)):
         """Return a list of the ids of the active nodes in this class that

roundup/support.py

@@ -7,6 +7,8 @@
 import os, time, sys
 import hyperdb
 
+from sets import Set
+
 class TruthDict:
     '''Returns True for valid keys, False for others.
     '''
@@ -32,11 +34,11 @@ class PrioList:
     full list interface.
     Implementation: We manage a "sorted" status and sort on demand.
     Appending to the list will require re-sorting before use.
-    >>> p = PrioList ()
-    >>> for i in 5,7,1,-1 :
-    ...  p.append (i)
+    >>> p = PrioList()
+    >>> for i in 5,7,1,-1:
+    ...  p.append(i)
     ...
-    >>> for k in p :
+    >>> for k in p:
     ...  print k
     ...
     -1
@@ -50,14 +52,14 @@ def __init__(self):
         self.sorted = True
 
     def append(self, item):
-        self.list.append (item)
+        self.list.append(item)
         self.sorted = False
 
     def __iter__(self):
-        if not self.sorted :
-            self.list.sort ()
+        if not self.sorted:
+            self.list.sort()
             self.sorted = True
-        return iter (self.list)
+        return iter(self.list)
 
 class Progress:
     '''Progress display for console applications.
@@ -119,54 +121,73 @@ def display(self):
         sys.stdout.write(s + ' '*(75-len(s)) + '\r')
         sys.stdout.flush()
 
-class Proptree :
+class Proptree(object):
     ''' Simple tree data structure for optimizing searching of properties
     '''
 
-    def __init__ (self, db, cls, name, props, parent = None, val = None) :
-        self.db        = db
-        self.name      = name
-        self.props     = props
-        self.parent    = parent
-        self.val       = val
-        self.cls       = cls
+    def __init__(self, db, cls, name, props, parent = None, val = None):
+        self.db = db
+        self.name = name
+        self.props = props
+        self.parent = parent
+        self._val = val
+        self.cls = cls
         self.classname = None
-        self.uniqname  = None
-        self.children  = []
+        self.uniqname = None
+        self.children = []
         self.propnames = {}
-        if parent :
-            self.root  = parent.root
+        if parent:
+            self.root = parent.root
             self.prcls = self.parent.props [name]
-        else :
-            self.root  = self
+        else:
+            self.root = self
             self.seqno = 1
         self.id = self.root.seqno
         self.root.seqno += 1
-        if self.cls :
+        if self.cls:
             self.classname = self.cls.classname
-            self.uniqname  = '%s%s' % (self.cls.classname, self.id)
-        if not self.parent :
-            self.uniqname  = self.cls.classname
-
-    def append (self, name) :
-        if name in self.propnames :
+            self.uniqname = '%s%s' % (self.cls.classname, self.id)
+        if not self.parent:
+            self.uniqname = self.cls.classname
+
+    def append(self, name):
+        """Append a property to self.children. Will create a new
+        propclass for the child.
+        """
+        if name in self.propnames:
             return self.propnames [name]
         propclass = self.props [name]
-        cls   = None
+        cls = None
         props = None
-        if isinstance (propclass, (hyperdb.Link, hyperdb.Multilink)) :
-            cls   = self.db.getclass (propclass.classname)
-            props = cls.getprops ()
-        child = self.__class__ (self.db, cls, name, props, parent = self)
-        self.children.append (child)
+        if isinstance(propclass, (hyperdb.Link, hyperdb.Multilink)):
+            cls = self.db.getclass(propclass.classname)
+            props = cls.getprops()
+        child = self.__class__(self.db, cls, name, props, parent = self)
+        self.children.append(child)
         self.propnames [name] = child
         return child
 
-    def __iter__ (self) :
+    def _set_val(self, val):
+        """Check if self._val is already defined. If yes, we compute the
+        intersection of the old and the new value(s)
+        """
+        if self._val:
+            v = self._val
+            if not isinstance(self._val, type([])):
+                v = [self._val]
+            vals = Set(v)
+            vals.intersection_update(val)
+            self._val = [v for v in vals]
+        else:
+            self._val = val
+    
+    val = property(lambda self: self._val, _set_val)
+
+    def __iter__(self):
         """ Yield nodes in depth-first order -- visited nodes first """
-        for p in self.children :
+        for p in self.children:
             yield p
-            for c in p :
+            for c in p:
                 yield c
 
 # vim: set et sts=4 sw=4 :