- return slice_ids
[plcapi.git] / 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.5 2006/09/25 18:11:10 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.Debug import profile
16 from PLC.Table import Row, Table
17 from PLC.NodeNetworks import NodeNetwork, NodeNetworks
18 from PLC.BootStates import BootStates
19
20 class Node(Row):
21     """
22     Representation of a row in the nodes table. To use, optionally
23     instantiate with a dict of values. Update as you would a
24     dict. Commit to the database with sync().
25     """
26
27     fields = {
28         'node_id': Parameter(int, "Node identifier"),
29         'hostname': Parameter(str, "Fully qualified hostname", max = 255),
30         'site_id': Parameter(int, "Site at which this node is located"),
31         'boot_state': Parameter(str, "Boot state", max = 20),
32         'model': Parameter(str, "Make and model of the actual machine", max = 255),
33         'boot_nonce': Parameter(str, "(Admin only) Random value generated by the node at last boot", max = 128),
34         'version': Parameter(str, "Apparent Boot CD version", max = 64),
35         'ssh_rsa_key': Parameter(str, "Last known SSH host key", max = 1024),
36         'date_created': Parameter(str, "Date and time when node entry was created"),
37         'last_updated': Parameter(str, "Date and time when node entry was created"),
38         'deleted': Parameter(bool, "Has been deleted"),
39         'key': Parameter(str, "(Admin only) Node key", max = 256),
40         'session': Parameter(str, "(Admin only) Node session value", max = 256),
41         'nodenetwork_ids': Parameter([int], "List of network interfaces that this node has"),
42         'nodegroup_ids': Parameter([int], "List of node groups that this node is in"),
43         # 'conf_file_ids': Parameter([int], "List of configuration files specific to this node"),
44         # 'root_person_ids': Parameter([int], "(Admin only) List of people who have root access to this node"),
45         'slice_ids': Parameter([int], "List of slices on this node"),
46         # 'pcu_ids': Parameter([int], "List of PCUs that control this node"),
47         }
48
49     def __init__(self, api, fields):
50         Row.__init__(self, fields)
51         self.api = api
52
53     def validate_hostname(self, hostname):
54         # 1. Each part begins and ends with a letter or number.
55         # 2. Each part except the last can contain letters, numbers, or hyphens.
56         # 3. Each part is between 1 and 64 characters, including the trailing dot.
57         # 4. At least two parts.
58         # 5. Last part can only contain between 2 and 6 letters.
59         good_hostname = r'^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+' \
60                         r'[a-z]{2,6}$'
61         if not hostname or \
62            not re.match(good_hostname, hostname, re.IGNORECASE):
63             raise PLCInvalidArgument, "Invalid hostname"
64
65         conflicts = Nodes(self.api, [hostname])
66         for node_id, node in conflicts.iteritems():
67             if not node['deleted'] and ('node_id' not in self or self['node_id'] != node_id):
68                 raise PLCInvalidArgument, "Hostname already in use"
69
70         # Check for conflicts with a nodenetwork hostname
71         conflicts = NodeNetworks(self.api, [hostname])
72         for nodenetwork_id in conflicts:
73             if 'nodenetwork_ids' not in self or nodenetwork_id not in self['nodenetwork_ids']:
74                 raise PLCInvalidArgument, "Hostname already in use"
75
76         return hostname
77
78     def validate_boot_state(self, boot_state):
79         if boot_state not in BootStates(self.api):
80             raise PLCInvalidArgument, "Invalid boot state"
81
82         return boot_state
83
84     def sync(self, commit = True):
85         """
86         Flush changes back to the database.
87         """
88
89         self.validate()
90
91         # Fetch a new node_id if necessary
92         if 'node_id' not in self:
93             rows = self.api.db.selectall("SELECT NEXTVAL('nodes_node_id_seq') AS node_id")
94             if not rows:
95                 raise PLCDBError, "Unable to fetch new node_id"
96             self['node_id'] = rows[0]['node_id']
97             insert = True
98         else:
99             insert = False
100
101         # Filter out fields that cannot be set or updated directly
102         nodes_fields = self.api.db.fields('nodes')
103         fields = dict(filter(lambda (key, value): key in nodes_fields,
104                              self.items()))
105         for ro_field in 'date_created', 'last_updated':
106             if ro_field in fields:
107                 del fields[ro_field]
108
109         # Parameterize for safety
110         keys = fields.keys()
111         values = [self.api.db.param(key, value) for (key, value) in fields.items()]
112
113         if insert:
114             # Insert new row in nodes table
115             sql = "INSERT INTO nodes (%s) VALUES (%s)" % \
116                   (", ".join(keys), ", ".join(values))
117         else:
118             # Update existing row in nodes table
119             columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
120             sql = "UPDATE nodes SET " + \
121                   ", ".join(columns) + \
122                   " WHERE node_id = %(node_id)d"
123
124         self.api.db.do(sql, fields)
125
126         if commit:
127             self.api.db.commit()
128
129     def delete(self, commit = True):
130         """
131         Delete existing node.
132         """
133
134         assert 'node_id' in self
135
136         # Delete all nodenetworks
137         nodenetworks = NodeNetworks(self.api, self['nodenetwork_ids'])
138         for nodenetwork in nodenetworks.values():
139             nodenetwork.delete(commit = False)
140
141         # Clean up miscellaneous join tables
142         for table in ['nodegroup_node', 'slice_node', 'slice_attribute']:
143             self.api.db.do("DELETE FROM %s" \
144                            " WHERE node_id = %d" % \
145                            (table, self['node_id']))
146
147         # Mark as deleted
148         self['deleted'] = True
149         self.sync(commit)
150
151 class Nodes(Table):
152     """
153     Representation of row(s) from the nodes table in the
154     database.
155     """
156
157     def __init__(self, api, node_id_or_hostname_list = None, fields = Node.fields.keys()):
158         self.api = api
159
160         sql = "SELECT %s FROM view_nodes WHERE deleted IS False" % \
161               ", ".join(fields)
162
163         if node_id_or_hostname_list:
164             # Separate the list into integers and strings
165             node_ids = filter(lambda node_id: isinstance(node_id, (int, long)),
166                               node_id_or_hostname_list)
167             hostnames = filter(lambda hostname: isinstance(hostname, StringTypes),
168                                node_id_or_hostname_list)
169             sql += " AND (False"
170             if node_ids:
171                 sql += " OR node_id IN (%s)" % ", ".join(map(str, node_ids))
172             if hostnames:
173                 sql += " OR hostname IN (%s)" % ", ".join(api.db.quote(hostnames)).lower()
174             sql += ")"
175
176         rows = self.api.db.selectall(sql)
177
178         for row in rows:
179             self[row['node_id']] = node = Node(api, row)
180             for aggregate in ['nodenetwork_ids', 'nodegroup_ids',
181                               'conf_file_ids', 'root_person_ids', 'slice_ids',
182                               'pcu_ids']:
183                 if not node.has_key(aggregate) or node[aggregate] is None:
184                     node[aggregate] = []
185                 else:
186                     node[aggregate] = map(int, node[aggregate].split(','))