PLC/Nodes.py

   1 #
   2 # Functions for interacting with the nodes table in the database
   3 #
   4 # Mark Huang <mlhuang@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7 # $Id: Nodes.py,v 1.19 2006/11/09 03:07:42 mlhuang Exp $
   8 #
   9
  10 from types import StringTypes
  11 import re
  12
  13 from PLC.Faults import *
  14 from PLC.Parameter import Parameter
  15 from PLC.Filter import Filter
  16 from PLC.Debug import profile
  17 from PLC.Table import Row, Table
  18 from PLC.NodeNetworks import NodeNetwork, NodeNetworks
  19 from PLC.BootStates import BootStates
  20
  21 def valid_hostname(hostname):
  22     # 1. Each part begins and ends with a letter or number.
  23     # 2. Each part except the last can contain letters, numbers, or hyphens.
  24     # 3. Each part is between 1 and 64 characters, including the trailing dot.
  25     # 4. At least two parts.
  26     # 5. Last part can only contain between 2 and 6 letters.
  27     good_hostname = r'^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+' \
  28                     r'[a-z]{2,6}$'
  29     return hostname and \
  30            re.match(good_hostname, hostname, re.IGNORECASE)
  31
  32 class Node(Row):
  33     """
  34     Representation of a row in the nodes table. To use, optionally
  35     instantiate with a dict of values. Update as you would a
  36     dict. Commit to the database with sync().
  37     """
  38
  39     table_name = 'nodes'
  40     primary_key = 'node_id'
  41     join_tables = ['nodegroup_node', 'conf_file_node', 'nodenetworks', 'pcu_node', 'slice_node', 'slice_attribute', 'node_session']
  42     fields = {
  43         'node_id': Parameter(int, "Node identifier"),
  44         'hostname': Parameter(str, "Fully qualified hostname", max = 255),
  45         'site_id': Parameter(int, "Site at which this node is located"),
  46         'boot_state': Parameter(str, "Boot state", max = 20),
  47         'model': Parameter(str, "Make and model of the actual machine", max = 255, nullok = True),
  48         'boot_nonce': Parameter(str, "(Admin only) Random value generated by the node at last boot", max = 128),
  49         'version': Parameter(str, "Apparent Boot CD version", max = 64),
  50         'ssh_rsa_key': Parameter(str, "Last known SSH host key", max = 1024),
  51         'date_created': Parameter(int, "Date and time when node entry was created", ro = True),
  52         'last_updated': Parameter(int, "Date and time when node entry was created", ro = True),
  53         'key': Parameter(str, "(Admin only) Node key", max = 256),
  54         'session': Parameter(str, "(Admin only) Node session value", max = 256, ro = True),
  55         'nodenetwork_ids': Parameter([int], "List of network interfaces that this node has"),
  56         'nodegroup_ids': Parameter([int], "List of node groups that this node is in"),
  57         'conf_file_ids': Parameter([int], "List of configuration files specific to this node"),
  58         # 'root_person_ids': Parameter([int], "(Admin only) List of people who have root access to this node"),
  59         'slice_ids': Parameter([int], "List of slices on this node"),
  60         'pcu_ids': Parameter([int], "List of PCUs that control this node"),
  61         'ports': Parameter([int], "List of PCU ports that this node is connected to"),
  62         }
  63
  64     def validate_hostname(self, hostname):
  65         if not valid_hostname(hostname):
  66             raise PLCInvalidArgument, "Invalid hostname"
  67
  68         conflicts = Nodes(self.api, [hostname])
  69         for node in conflicts:
  70             if 'node_id' not in self or self['node_id'] != node['node_id']:
  71                 raise PLCInvalidArgument, "Hostname already in use"
  72
  73         return hostname
  74
  75     def validate_boot_state(self, boot_state):
  76         boot_states = [row['boot_state'] for row in BootStates(self.api)]
  77         if boot_state not in boot_states:
  78             raise PLCInvalidArgument, "Invalid boot state"
  79
  80         return boot_state
  81
  82     def delete(self, commit = True):
  83         """
  84         Delete existing node.
  85         """
  86
  87         assert 'node_id' in self
  88
  89         # Clean up miscellaneous join tables
  90         for table in self.join_tables:
  91             self.api.db.do("DELETE FROM %s WHERE node_id = %d" % \
  92                            (table, self['node_id']))
  93
  94         # Mark as deleted
  95         self['deleted'] = True
  96         self.sync(commit)
  97
  98 class Nodes(Table):
  99     """
 100     Representation of row(s) from the nodes table in the
 101     database.
 102     """
 103
 104     def __init__(self, api, node_filter = None, columns = None):
 105         Table.__init__(self, api, Node, columns)
 106
 107         sql = "SELECT %s FROM view_nodes WHERE deleted IS False" % \
 108               ", ".join(self.columns)
 109
 110         if node_filter is not None:
 111             if isinstance(node_filter, (list, tuple, set)):
 112                 # Separate the list into integers and strings
 113                 ints = filter(lambda x: isinstance(x, (int, long)), node_filter)
 114                 strs = filter(lambda x: isinstance(x, StringTypes), node_filter)
 115                 node_filter = Filter(Node.fields, {'node_id': ints, 'hostname': strs})
 116                 sql += " AND (%s)" % node_filter.sql(api, "OR")
 117             elif isinstance(node_filter, dict):
 118                 node_filter = Filter(Node.fields, node_filter)
 119                 sql += " AND (%s)" % node_filter.sql(api, "AND")
 120
 121         self.selectall(sql)