unset None fields, if allowed
[plcapi.git] / PLC / Nodes.py
index fd20c2d..16c63cb 100644 (file)
@@ -4,7 +4,7 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2006 The Trustees of Princeton University
 #
-# $Id: Nodes.py,v 1.3 2006/09/19 19:28:39 mlhuang Exp $
+# $Id: Nodes.py,v 1.15 2006/10/27 15:32:43 mlhuang Exp $
 #
 
 from types import StringTypes
@@ -17,6 +17,17 @@ from PLC.Table import Row, Table
 from PLC.NodeNetworks import NodeNetwork, NodeNetworks
 from PLC.BootStates import BootStates
 
+def valid_hostname(hostname):
+    # 1. Each part begins and ends with a letter or number.
+    # 2. Each part except the last can contain letters, numbers, or hyphens.
+    # 3. Each part is between 1 and 64 characters, including the trailing dot.
+    # 4. At least two parts.
+    # 5. Last part can only contain between 2 and 6 letters.
+    good_hostname = r'^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+' \
+                    r'[a-z]{2,6}$'
+    return hostname and \
+           re.match(good_hostname, hostname, re.IGNORECASE)
+
 class Node(Row):
     """
     Representation of a row in the nodes table. To use, optionally
@@ -24,53 +35,37 @@ class Node(Row):
     dict. Commit to the database with sync().
     """
 
+    table_name = 'nodes'
+    primary_key = 'node_id'
     fields = {
         'node_id': Parameter(int, "Node identifier"),
         'hostname': Parameter(str, "Fully qualified hostname", max = 255),
         'site_id': Parameter(int, "Site at which this node is located"),
         'boot_state': Parameter(str, "Boot state", max = 20),
-        'model': Parameter(str, "Make and model of the actual machine", max = 255),
+        'model': Parameter(str, "Make and model of the actual machine", max = 255, nullok = True),
         'boot_nonce': Parameter(str, "(Admin only) Random value generated by the node at last boot", max = 128),
         'version': Parameter(str, "Apparent Boot CD version", max = 64),
         'ssh_rsa_key': Parameter(str, "Last known SSH host key", max = 1024),
-        'date_created': Parameter(str, "Date and time when node entry was created"),
-        'last_updated': Parameter(str, "Date and time when node entry was created"),
-        'deleted': Parameter(bool, "Has been deleted"),
+        'date_created': Parameter(int, "Date and time when node entry was created", ro = True),
+        'last_updated': Parameter(int, "Date and time when node entry was created", ro = True),
         'key': Parameter(str, "(Admin only) Node key", max = 256),
-        'session': Parameter(str, "(Admin only) Node session value", max = 256),
-        'nodenetwork_ids': Parameter([int], "List of network interfaces that this node has"),
-        'nodegroup_ids': Parameter([int], "List of node groups that this node is in"),
-        # 'conf_file_ids': Parameter([int], "List of configuration files specific to this node"),
-        # 'root_person_ids': Parameter([int], "(Admin only) List of people who have root access to this node"),
-        # 'slice_ids': Parameter([int], "List of slices on this node"),
-        # 'pcu_ids': Parameter([int], "List of PCUs that control this node"),
+        'session': Parameter(str, "(Admin only) Node session value", max = 256, ro = True),
+        'nodenetwork_ids': Parameter([int], "List of network interfaces that this node has", ro = True),
+        'nodegroup_ids': Parameter([int], "List of node groups that this node is in", ro = True),
+        'conf_file_ids': Parameter([int], "List of configuration files specific to this node", ro = True),
+        # 'root_person_ids': Parameter([int], "(Admin only) List of people who have root access to this node", ro = True),
+        'slice_ids': Parameter([int], "List of slices on this node", ro = True),
+        'pcu_ids': Parameter([int], "List of PCUs that control this node", ro = True),
+        'ports': Parameter([int], "List of PCU ports that this node is connected to", ro = True),
         }
 
-    def __init__(self, api, fields):
-        Row.__init__(self, fields)
-        self.api = api
-
     def validate_hostname(self, hostname):
-        # 1. Each part begins and ends with a letter or number.
-        # 2. Each part except the last can contain letters, numbers, or hyphens.
-        # 3. Each part is between 1 and 64 characters, including the trailing dot.
-        # 4. At least two parts.
-        # 5. Last part can only contain between 2 and 6 letters.
-        good_hostname = r'^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+' \
-                        r'[a-z]{2,6}$'
-        if not hostname or \
-           not re.match(good_hostname, hostname, re.IGNORECASE):
+        if not valid_hostname(hostname):
             raise PLCInvalidArgument, "Invalid hostname"
 
         conflicts = Nodes(self.api, [hostname])
         for node_id, node in conflicts.iteritems():
-            if not node['deleted'] and ('node_id' not in self or self['node_id'] != node_id):
-                raise PLCInvalidArgument, "Hostname already in use"
-
-        # Check for conflicts with a nodenetwork hostname
-        conflicts = NodeNetworks(self.api, [hostname])
-        for nodenetwork_id in conflicts:
-            if 'nodenetwork_ids' not in self or nodenetwork_id not in self['nodenetwork_ids']:
+            if 'node_id' not in self or self['node_id'] != node_id:
                 raise PLCInvalidArgument, "Hostname already in use"
 
         return hostname
@@ -81,96 +76,6 @@ class Node(Row):
 
         return boot_state
 
-    def add_node_network(self, nodenetwork, commit = True):
-        """
-        Add node network to this node.
-        """
-
-        assert 'node_id' in self
-        assert isinstance(nodenetwork, NodeNetwork)
-        assert 'nodenetwork_id' in nodenetwork
-
-        nodenetwork_id = nodenetwork['nodenetwork_id']
-        nodenetwork['node_id'] = self['node_id']
-
-        self.api.db.do("INSERT INTO node_nodenetwork (node_id, nodenetwork_id, is_primary)" \
-                       " VALUES(%(node_id)d, %(nodenetwork_id)d, False)",
-                       nodenetwork)
-
-        if commit:
-            self.api.db.commit()
-
-        if 'nodenetwork_ids' in self and nodenetwork_id not in self['nodenetwork_ids']:
-            self['nodenetwork_ids'].append(nodenetwork_id)
-
-    def set_primary_node_network(self, nodenetwork, commit = True):
-        """
-        Remove node network from this node.
-        """
-
-        assert 'node_id' in self
-        assert isinstance(nodenetwork, NodeNetwork)
-        assert 'nodenetwork_id' in nodenetwork
-
-        node_id = self['node_id']
-        nodenetwork_id = nodenetwork['nodenetwork_id']
-
-        self.api.db.do("UPDATE node_nodenetwork SET is_primary = False" \
-                       " WHERE node_id = %(node_id)d",
-                       locals())
-
-        self.api.db.do("UPDATE node_nodenetwork SET is_primary = True" \
-                       " WHERE node_id = %(node_id)d" \
-                       " AND nodenetwork_id = %(nodenetwork_id)d",
-                       locals())
-
-        if commit:
-            self.api.db.commit()
-
-        nodenetwork['is_primary'] = True
-
-    def sync(self, commit = True):
-        """
-        Flush changes back to the database.
-        """
-
-        self.validate()
-
-        # Fetch a new node_id if necessary
-        if 'node_id' not in self:
-            rows = self.api.db.selectall("SELECT NEXTVAL('nodes_node_id_seq') AS node_id")
-            if not rows:
-                raise PLCDBError, "Unable to fetch new node_id"
-            self['node_id'] = rows[0]['node_id']
-            insert = True
-        else:
-            insert = False
-
-        # Filter out fields that cannot be set or updated directly
-        nodes_fields = self.api.db.fields('nodes')
-        fields = dict(filter(lambda (key, value): key in nodes_fields,
-                             self.items()))
-
-        # Parameterize for safety
-        keys = fields.keys()
-        values = [self.api.db.param(key, value) for (key, value) in fields.items()]
-
-        if insert:
-            # Insert new row in nodes table
-            sql = "INSERT INTO nodes (%s) VALUES (%s)" % \
-                  (", ".join(keys), ", ".join(values))
-        else:
-            # Update existing row in nodes table
-            columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
-            sql = "UPDATE nodes SET " + \
-                  ", ".join(columns) + \
-                  " WHERE node_id = %(node_id)d"
-
-        self.api.db.do(sql, fields)
-
-        if commit:
-            self.api.db.commit()
-
     def delete(self, commit = True):
         """
         Delete existing node.
@@ -184,7 +89,7 @@ class Node(Row):
             nodenetwork.delete(commit = False)
 
         # Clean up miscellaneous join tables
-        for table in ['nodegroup_node']:
+        for table in ['nodegroup_node', 'slice_node', 'slice_attribute', 'node_session']:
             self.api.db.do("DELETE FROM %s" \
                            " WHERE node_id = %d" % \
                            (table, self['node_id']))
@@ -199,11 +104,11 @@ class Nodes(Table):
     database.
     """
 
-    def __init__(self, api, node_id_or_hostname_list = None, fields = Node.fields.keys()):
+    def __init__(self, api, node_id_or_hostname_list = None):
         self.api = api
 
         sql = "SELECT %s FROM view_nodes WHERE deleted IS False" % \
-              ", ".join(fields)
+              ", ".join(Node.fields)
 
         if node_id_or_hostname_list:
             # Separate the list into integers and strings