This commit was manufactured by cvs2svn to create branch

[plcapi.git] / PLC / Filter.py

diff --git a/PLC/Filter.py b/PLC/Filter.py
index 66e9aee..c20fd9c 100644 (file)
--- a/PLC/Filter.py
+++ b/PLC/Filter.py
@@ -1,11 +1,21 @@
+from types import StringTypes
+try:
+    set
+except NameError:
+    from sets import Set
+    set = Set
+
+import time
+
 from PLC.Faults import *
 from PLC.Parameter import Parameter, Mixed, python_type
 
 class Filter(Parameter, dict):
     """
     A type of parameter that represents a filter on one or more
-    columns of a database table. fields should be a dictionary of
-    field names and types, e.g.
+    columns of a database table.
+
+    field should be a dictionary of field names and types, e.g.
 
     {'node_id': Parameter(int, "Node identifier"),
      'hostname': Parameter(int, "Fully qualified hostname", max = 255),
@@ -17,6 +27,21 @@ class Filter(Parameter, dict):
     representing an intersection (if join_with is AND) or union (if
     join_with is OR) filter. If a value is a sequence type, then it
     should represent a list of possible values for that field.
+
+    Special forms:
+    * a field starting with the ~ character means negation.
+    example :  { '~peer_id' : None }
+    * a field starting with < [  ] or > means lower than or greater than
+      < > uses strict comparison
+      [ ] is for using <= or >= instead
+    example :  { '>time' : 1178531418 }
+    example :  { ']event_id' : 2305 }
+    * a field starting with [ or ] means older than or more recent than
+      the associated value should be a given unix timestamp
+    * a (string) value containing either a * or a % character is
+      treated as a (sql) pattern; * are replaced with % that is the
+      SQL wildcard character.
+    example :  { 'hostname' : '*.jp' } 
     """
 
     def __init__(self, fields = {}, filter = {}, doc = "Attribute filter"):
@@ -36,7 +61,17 @@ class Filter(Parameter, dict):
             # Accept either a value or a list of values of the specified type
             self.fields[field] = Mixed(expected, [expected])
 
-        Parameter.__init__(self, self.fields, doc = doc)
+        # Null filter means no filter
+        Parameter.__init__(self, self.fields, doc = doc, nullok = True)
+
+    # this code is not used anymore
+    # at some point the select in the DB for event objects was done on
+    # the events table directly, that is stored as a timestamp, thus comparisons
+    # needed to be done based on SQL timestamps as well
+    def unix2timestamp (self,unix):
+       s = time.gmtime(unix)
+       return "TIMESTAMP'%04d-%02d-%02d %02d:%02d:%02d'" % (s.tm_year,s.tm_mon,s.tm_mday,
+                                                            s.tm_hour,s.tm_min,s.tm_sec)
 
     def sql(self, api, join_with = "AND"):
         """
@@ -52,7 +87,22 @@ class Filter(Parameter, dict):
             assert join_with in ("AND", "OR")
 
         for field, value in self.iteritems():
+           # handle negation, numeric comparisons
+           # simple, 1-depth only mechanism
+
+           modifiers={'~' : False, 
+                      '<' : False, '>' : False,
+                      '[' : False, ']' : False,
+                      }
+
+           for char in modifiers.keys():
+               if field[0] == char:
+                   modifiers[char]=True;
+                   field = field[1:]
+                   break
+
             if field not in self.fields:
+#              print 'current fields',self.fields
                 raise PLCInvalidArgument, "Invalid filter field '%s'" % field
 
             if isinstance(value, (list, tuple, set)):
@@ -67,10 +117,29 @@ class Filter(Parameter, dict):
                 if value is None:
                     operator = "IS"
                     value = "NULL"
-                else:
+                elif isinstance(value, StringTypes) and \
+                     (value.find("*") > -1 or value.find("%") > -1):
+                   operator = "LIKE"
+                    value = str(api.db.quote(value.replace("*", "%")))
+               else:
                     operator = "="
-                    value = str(api.db.quote(value))
+                   if modifiers['<']:
+                       operator='<'
+                   if modifiers['>']:
+                       operator='>'
+                   if modifiers['[']:
+                       operator='<='
+                   if modifiers[']']:
+                       operator='>='
+                   else:
+                       value = str(api.db.quote(value))
+
+            clause = "%s %s %s" % (field, operator, value)
+
+           if modifiers['~']:
+               clause = " ( NOT %s ) " % (clause)
 
-            conditionals.append("%s %s %s" % (field, operator, value))
+            conditionals.append(clause)
 
+#      print 'sql=',(" %s " % join_with).join(conditionals)
         return (" %s " % join_with).join(conditionals)