2 # Functions for interacting with the nodes table in the database
4 # Mark Huang <mlhuang@cs.princeton.edu>
5 # Copyright (C) 2006 The Trustees of Princeton University
7 # $Id: Nodes.py,v 1.28 2006/12/05 16:45:03 thierry Exp $
10 from types import StringTypes
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
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])?\.)+' \
30 re.match(good_hostname, hostname, re.IGNORECASE)
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().
40 primary_key = 'node_id'
41 join_tables = ['nodegroup_node', 'conf_file_node', 'nodenetworks', 'pcu_node', 'slice_node', 'slice_attribute', 'node_session']
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 'peer_id': Parameter(int, "Peer at which this node is managed", nullok = True),
66 class_key = 'hostname'
67 foreign_fields = ['boot_state','model','version']
68 # forget about these ones, they are read-only anyway
69 # handling them causes Cache to re-sync all over again
70 # 'date_created','last_updated'
72 # in this case, we dont need the 'table' but Cache will look it up, so...
73 {'field' : 'site_id' , 'class' : 'Site' , 'table' : 'unused-on-direct-refs' } ,
76 def validate_hostname(self, hostname):
77 if not valid_hostname(hostname):
78 raise PLCInvalidArgument, "Invalid hostname"
80 conflicts = Nodes(self.api, [hostname])
81 for node in conflicts:
82 if 'node_id' not in self or self['node_id'] != node['node_id']:
83 raise PLCInvalidArgument, "Hostname already in use"
87 def validate_boot_state(self, boot_state):
88 boot_states = [row['boot_state'] for row in BootStates(self.api)]
89 if boot_state not in boot_states:
90 raise PLCInvalidArgument, "Invalid boot state"
95 def validate_date_created (self, timestamp):
96 return self.validate_timestamp (timestamp)
97 def validate_last_updated (self, timestamp):
98 return self.validate_timestamp (timestamp)
100 def delete(self, commit = True):
102 Delete existing node.
105 assert 'node_id' in self
107 # Clean up miscellaneous join tables
108 for table in self.join_tables:
109 self.api.db.do("DELETE FROM %s WHERE node_id = %d" % \
110 (table, self['node_id']))
113 self['deleted'] = True
119 Representation of row(s) from the nodes table in the
123 def __init__(self, api, node_filter = None, columns = None):
124 Table.__init__(self, api, Node, columns)
126 sql = "SELECT %s FROM view_nodes WHERE deleted IS False" % \
127 ", ".join(self.columns)
129 if node_filter is not None:
130 if isinstance(node_filter, (list, tuple, set)):
131 # Separate the list into integers and strings
132 ints = filter(lambda x: isinstance(x, (int, long)), node_filter)
133 strs = filter(lambda x: isinstance(x, StringTypes), node_filter)
134 node_filter = Filter(Node.fields, {'node_id': ints, 'hostname': strs})
135 sql += " AND (%s)" % node_filter.sql(api, "OR")
136 elif isinstance(node_filter, dict):
137 node_filter = Filter(Node.fields, node_filter)
138 sql += " AND (%s)" % node_filter.sql(api, "AND")