added create_network(), delete_network(), create_subnet(), delete_subnet(), process_t...
[plcapi.git] / PLC / NodeGroups.py
index 35746a3..8c669d2 100644 (file)
 #
 # Functions for interacting with the nodegroups table in the database
 #
-# Mark Huang <mlhuang@cs.princeton.edu>
-# Copyright (C) 2006 The Trustees of Princeton University
-#
-# $Id: NodeGroups.py,v 1.11 2006/10/03 19:25:30 mlhuang Exp $
 #
 
 from types import StringTypes
 
 from PLC.Faults import *
-from PLC.Parameter import Parameter
+from PLC.Parameter import Parameter, Mixed
 from PLC.Debug import profile
-from PLC.Table import Row, Table
-from PLC.Nodes import Node, Nodes
+from PLC.Storage.AlchemyObject import AlchemyObj
 
-class NodeGroup(Row):
+class NodeGroup(AlchemyObj):
     """
     Representation of a row in the nodegroups table. To use, optionally
     instantiate with a dict of values. Update as you would a
     dict. Commit to the database with sync().
     """
 
-    table_name = 'nodegroups'
-    primary_key = 'nodegroup_id'
+    tablename = 'nodegroups'
+    join_tables = ['conf_file_nodegroup']
     fields = {
-        'nodegroup_id': Parameter(int, "Node group identifier"),
-        'name': Parameter(str, "Node group name", max = 50),
-        'description': Parameter(str, "Node group description", max = 200),
-        'node_ids': Parameter([int], "List of nodes in this node group"),
+        'nodegroup_id': Parameter(int, "Node group identifier", primary_key=True),
+        'groupname': Parameter(str, "Node group name", max = 50),
+        'tag_type_id': Parameter (int, "Node tag type id"),
+        'value' : Parameter(str, "value that the nodegroup definition is based upon"),
+        'tagname' : Parameter(str, "Tag name that the nodegroup definition is based upon"),
+        'conf_file_ids': Parameter([int], "List of configuration files specific to this node group", joined=True),
+        'node_ids' : Parameter([int], "List of node_ids that belong to this nodegroup", joined=True),
         }
 
-    def __init__(self, api, fields = {}):
-        Row.__init__(self, fields)
-        self.api = api
-
     def validate_name(self, name):
-       # Remove leading and trailing spaces
-       name = name.strip()
-
-       # Make sure name is not blank after we removed the spaces
-        if not len(name) > 0:
-                raise PLCInvalidArgument, "Invalid node group name"
-       
-       # Make sure node group does not alredy exist
-       conflicts = NodeGroups(self.api, [name])
-       for nodegroup_id in conflicts:
-            if 'nodegroup_id' not in self or self['nodegroup_id'] != nodegroup_id:
-               raise PLCInvalidArgument, "Node group name already in use"
-
-       return name
-
-    def add_node(self, node, commit = True):
-        """
-        Add node to existing nodegroup.
-        """
-
-        assert 'nodegroup_id' in self
-        assert isinstance(node, Node)
-        assert 'node_id' in node
-
-        node_id = node['node_id']
-        nodegroup_id = self['nodegroup_id']
-
-        if node_id not in self['node_ids']:
-            assert nodegroup_id not in node['nodegroup_ids']
-
-            self.api.db.do("INSERT INTO nodegroup_node (nodegroup_id, node_id)" \
-                           " VALUES(%(nodegroup_id)d, %(node_id)d)",
-                           locals())
-
-            if commit:
-                self.api.db.commit()
-
-            self['node_ids'].append(node_id)
-            node['nodegroup_ids'].append(nodegroup_id)
-
-    def remove_node(self, node, commit = True):
-        """
-        Remove node from existing nodegroup.
-        """
-
+        # Make sure name is not blank
+        if not len(name):
+            raise PLCInvalidArgument, "Invalid node group name"
+
+        # Make sure node group does not alredy exist
+        conflicts = NodeGroups(self.api, name)
+        for nodegroup in conflicts:
+            if 'nodegroup_id' not in self or self['nodegroup_id'] != nodegroup['nodegroup_id']:
+                raise PLCInvalidArgument, "Node group name already in use"
+
+        return name
+
+    def sync(self, commit=True, validate=True):
+        AlchemyObj.sync(self, commit, validate)
+        if 'nodegroup_id' not in self:
+            AlchemyObj.insert(self, dict(self))
+        else:
+            AlchemyObj.update(self, {'nodegroup_id': self['nodegroup_id']}, dict(self))
+
+    def delete(self, commit=True):
         assert 'nodegroup_id' in self
-        assert isinstance(node, Node)
-        assert 'node_id' in node
+        AlchemyObj.delete(self, dict(self))
 
-        node_id = node['node_id']
-        nodegroup_id = self['nodegroup_id']
-
-        if node_id in self['node_ids']:
-            assert nodegroup_id in node['nodegroup_ids']
-
-            self.api.db.do("DELETE FROM nodegroup_node" \
-                           " WHERE nodegroup_id = %(nodegroup_id)d" \
-                           " AND node_id = %(node_id)d",
-                           locals())
-
-            if commit:
-                self.api.db.commit()
-
-            self['node_ids'].remove(node_id)
-            node['nodegroup_ids'].remove(nodegroup_id)
-
-    def delete(self, commit = True):
-        """
-        Delete existing nodegroup from the database.
-        """
-
-        assert 'nodegroup_id' in self
-
-        # Clean up miscellaneous join tables
-        for table in ['nodegroup_node', 'nodegroups']:
-            self.api.db.do("DELETE FROM %s" \
-                           " WHERE nodegroup_id = %d" % \
-                           (table, self['nodegroup_id']), self)
-
-        if commit:
-            self.api.db.commit()
-
-class NodeGroups(Table):
+class NodeGroups(list):
     """
     Representation of row(s) from the nodegroups table in the
     database.
     """
 
-    def __init__(self, api, nodegroup_id_or_name_list = None):
-       self.api = api
+    def __init__(self, api, nodegroup_filter = None, columns = None):
 
-        sql = "SELECT %s FROM view_nodegroups" % \
-              ", ".join(NodeGroup.fields)
-
-        if nodegroup_id_or_name_list:
+        if not nodegroup_filter is not None:
+            nodegroups = NodeGroup().select()
+        if isinstance(nodegroup_filter, (list, tuple, set)):
             # Separate the list into integers and strings
-            nodegroup_ids = filter(lambda nodegroup_id: isinstance(nodegroup_id, (int, long)),
-                                   nodegroup_id_or_name_list)
-            names = filter(lambda name: isinstance(name, StringTypes),
-                           nodegroup_id_or_name_list)
-            sql += " WHERE (False"
-            if nodegroup_ids:
-                sql += " OR nodegroup_id IN (%s)" % ", ".join(map(str, nodegroup_ids))
-            if names:
-                sql += " OR name IN (%s)" % ", ".join(api.db.quote(names))
-            sql += ")"
-
-        rows = self.api.db.selectall(sql)
-
-        for row in rows:
-            self[row['nodegroup_id']] = nodegroup = NodeGroup(api, row)
-            for aggregate in ['node_ids']:
-                if not nodegroup.has_key(aggregate) or nodegroup[aggregate] is None:
-                    nodegroup[aggregate] = []
-                else:
-                    nodegroup[aggregate] = map(int, nodegroup[aggregate].split(','))
+            ints = filter(lambda x: isinstance(x, (int, long)), nodegroup_filter)
+            strs = filter(lambda x: isinstance(x, StringTypes), nodegroup_filter)
+            nodegroups = NodeGroup().select(filter={'nodegroup_id': ints, 'groupname': strs})
+        elif isinstance(nodegroup_filter, dict):
+            nodegroups = NodeGroup().select(filter=nodegroup_filter)
+        elif isinstance(nodegroup_filter, (int, long)):
+            nodegroups = NodeGroup().select(filter={'nodegroup_id': nodegroup_filter})
+        elif isinstance(nodegroup_filter, StringTypes):
+            nodegroups = NodeGroup().select(filter={'groupname': nodegroup_filter})
+        else:
+            raise PLCInvalidArgument, "Wrong node group filter %r"%nodegroup_filter
+
+        for nodegroup in nodegroups:
+            self.append(nodegroup)