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.32 2007/04/03 19:14:45 tmack 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', 'peer_node']
  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         'last_contact': Parameter(int, "Date and time when node last contacted plc", ro = True),
  54         'key': Parameter(str, "(Admin only) Node key", max = 256),
  55         'session': Parameter(str, "(Admin only) Node session value", max = 256, ro = True),
  56         'nodenetwork_ids': Parameter([int], "List of network interfaces that this node has"),
  57         'nodegroup_ids': Parameter([int], "List of node groups that this node is in"),
  58         'conf_file_ids': Parameter([int], "List of configuration files specific to this node"),
  59         # 'root_person_ids': Parameter([int], "(Admin only) List of people who have root access to this node"),
  60         'slice_ids': Parameter([int], "List of slices on this node"),
  61         'pcu_ids': Parameter([int], "List of PCUs that control this node"),
  62         'ports': Parameter([int], "List of PCU ports that this node is connected to"),
  63         'peer_id': Parameter(int, "Peer to which this node belongs", nullok = True),
  64         'peer_node_id': Parameter(int, "Foreign node identifier at peer", nullok = True),
  65         }
  66
  67     # for Cache
  68     class_key = 'hostname'
  69     foreign_fields = ['boot_state','model','version']
  70     # forget about these ones, they are read-only anyway
  71     # handling them causes Cache to re-sync all over again
  72     # 'date_created','last_updated'
  73     foreign_xrefs = [
  74         # in this case, we dont need the 'table' but Cache will look it up, so...
  75         {'field' : 'site_id' , 'class' : 'Site' , 'table' : 'unused-on-direct-refs' } ,
  76         ]
  77
  78     def validate_hostname(self, hostname):
  79         if not valid_hostname(hostname):
  80             raise PLCInvalidArgument, "Invalid hostname"
  81
  82         conflicts = Nodes(self.api, [hostname])
  83         for node in conflicts:
  84             if 'node_id' not in self or self['node_id'] != node['node_id']:
  85                 raise PLCInvalidArgument, "Hostname already in use"
  86
  87         return hostname
  88
  89     def validate_boot_state(self, boot_state):
  90         boot_states = [row['boot_state'] for row in BootStates(self.api)]
  91         if boot_state not in boot_states:
  92             raise PLCInvalidArgument, "Invalid boot state"
  93
  94         return boot_state
  95
  96     validate_date_created = Row.validate_timestamp
  97     validate_last_updated = Row.validate_timestamp
  98     validate_last_contact = Row.validate_timestamp
  99
 100     def update_last_contact(self, commit = True):
 101         """
 102         Update last_contact field with current time
 103         """
 104
 105         assert 'node_id' in self
 106         assert self.table_name
 107
 108         self.api.db.do("UPDATE %s SET last_contact = CURRENT_TIMESTAMP " % (self.table_name) + \
 109                        " where node_id = %d" % ( self['node_id']) )
 110         self.sync(commit)
 111
 112     def delete(self, commit = True):
 113         """
 114         Delete existing node.
 115         """
 116
 117         assert 'node_id' in self
 118
 119         # Clean up miscellaneous join tables
 120         for table in self.join_tables:
 121             self.api.db.do("DELETE FROM %s WHERE node_id = %d" % \
 122                            (table, self['node_id']))
 123
 124         # Mark as deleted
 125         self['deleted'] = True
 126         self.sync(commit)
 127
 128
 129 class Nodes(Table):
 130     """
 131     Representation of row(s) from the nodes table in the
 132     database.
 133     """
 134
 135     def __init__(self, api, node_filter = None, columns = None):
 136         Table.__init__(self, api, Node, columns)
 137
 138         sql = "SELECT %s FROM view_nodes WHERE deleted IS False" % \
 139               ", ".join(self.columns)
 140
 141         if node_filter is not None:
 142             if isinstance(node_filter, (list, tuple, set)):
 143                 # Separate the list into integers and strings
 144                 ints = filter(lambda x: isinstance(x, (int, long)), node_filter)
 145                 strs = filter(lambda x: isinstance(x, StringTypes), node_filter)
 146                 node_filter = Filter(Node.fields, {'node_id': ints, 'hostname': strs})
 147                 sql += " AND (%s)" % node_filter.sql(api, "OR")
 148             elif isinstance(node_filter, dict):
 149                 node_filter = Filter(Node.fields, node_filter)
 150                 sql += " AND (%s)" % node_filter.sql(api, "AND")
 151
 152         self.selectall(sql)