2 # Functions for interacting with the nodegroups table in the database
4 # Mark Huang <mlhuang@cs.princeton.edu>
5 # Copyright (C) 2006 The Trustees of Princeton University
7 # $Id: NodeGroups.py,v 1.7 2006/09/14 15:45:24 tmack Exp $
10 from types import StringTypes
12 from PLC.Faults import *
13 from PLC.Parameter import Parameter
14 from PLC.Debug import profile
15 from PLC.Table import Row, Table
16 from PLC.Nodes import Node, Nodes
20 Representation of a row in the nodegroups table. To use, optionally
21 instantiate with a dict of values. Update as you would a
22 dict. Commit to the database with flush().
26 'nodegroup_id': Parameter(int, "Node group identifier"),
27 'name': Parameter(str, "Node group name"),
28 'description': Parameter(str, "Node group description"),
29 'is_custom': Parameter(bool, "Is a custom node group (i.e., is not a site node group)")
32 # These fields are derived from join tables and are not
33 # actually in the nodegroups table.
35 'node_ids': Parameter([int], "List of nodes in this node group"),
38 all_fields = dict(fields.items() + join_fields.items())
40 def __init__(self, api, fields):
41 Row.__init__(self, fields)
44 def validate_name(self, name):
45 #remove leading and trailing spaces
48 #make sure name is not blank after we removed the spaces
50 raise PLCInvalidArgument, "Invalid Node Group Name"
52 #make sure name doenst alredy exist
53 conflicts = NodeGroups(self.api, [name])
54 for nodegroup_id in conflicts:
55 if 'nodegroup_id' not in self or self['nodegroup_id'] != nodegroup_id:
56 raise PLCInvalidArgument, "Node group name already in use"
60 def validate_description(self, description):
61 #remove trailing and leading spaces
62 description = description.strip()
64 #make sure decription is not blank after we removed the spaces
65 if not len(description) > 0:
66 raise PLCInvalidArgument, "Invalid Node Group Description"
70 def add_node(self, node, commit = True):
72 Add node to existing nodegroup.
75 assert 'nodegroup_id' in self
76 assert isinstance(node, Node)
77 assert 'node_id' in node
79 node_id = node['node_id']
80 nodegroup_id = self['nodegroup_id']
81 self.api.db.do("INSERT INTO nodegroup_nodes (nodegroup_id, node_id)" \
82 " VALUES(%(nodegroup_id)d, %(node_id)d)",
88 if 'node_ids' in self and node_id not in self['node_ids']:
89 self['node_ids'].append(node_id)
91 if 'nodegroup_ids' in node and nodegroup_id not in node['nodegroup_ids']:
92 node['nodegroup_ids'].append(nodegroup_id)
94 def remove_node(self, node, commit = True):
96 Remove node from existing nodegroup.
99 assert 'nodegroup_id' in self
100 assert isinstance(node, Node)
101 assert 'node_id' in node
103 node_id = node['node_id']
104 nodegroup_id = self['nodegroup_id']
105 self.api.db.do("INSERT INTO nodegroup_nodes (nodegroup_id, node_id)" \
106 " VALUES(%(nodegroup_id)d, %(node_id)d)",
112 if 'node_ids' in self and node_id not in self['node_ids']:
113 self['node_ids'].append(node_id)
115 if 'nodegroup_ids' in node and nodegroup_id not in node['nodegroup_ids']:
116 node['nodegroup_ids'].append(nodegroup_id)
118 def flush(self, commit = True):
120 Flush changes back to the database.
125 # Fetch a new nodegroup_id if necessary
126 if 'nodegroup_id' not in self:
127 rows = self.api.db.selectall("SELECT NEXTVAL('nodegroups_nodegroup_id_seq') AS nodegroup_id")
129 raise PLCDBError, "Unable to fetch new nodegroup_id"
130 self['nodegroup_id'] = rows[0]['nodegroup_id']
135 # Filter out fields that cannot be set or updated directly
136 fields = dict(filter(lambda (key, value): key in self.fields,
139 # Parameterize for safety
141 values = [self.api.db.param(key, value) for (key, value) in fields.items()]
144 # Insert new row in nodegroups table
145 sql = "INSERT INTO nodegroups (%s) VALUES (%s)" % \
146 (", ".join(keys), ", ".join(values))
148 # Update existing row in nodegroups table
149 columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
150 sql = "UPDATE nodegroups SET " + \
151 ", ".join(columns) + \
152 " WHERE nodegroup_id = %(nodegroup_id)d"
154 self.api.db.do(sql, fields)
160 def delete(self, commit = True):
162 Delete existing nodegroup from the database.
165 assert 'nodegroup_id' in self
166 assert self is not {}
168 tables = ['nodegroup_nodes', 'override_bootscripts',
169 'conf_assoc', 'node_root_access']
171 if self['is_custom']:
172 tables.append('nodegroups')
174 # XXX Cannot delete site node groups yet
178 self.api.db.do("DELETE FROM %s" \
179 " WHERE nodegroup_id = %d" % \
180 (table, self['nodegroup_id']), self)
185 class NodeGroups(Table):
187 Representation of row(s) from the nodegroups table in the
191 def __init__(self, api, nodegroup_id_or_name_list = None):
194 # N.B.: Node IDs returned may be deleted.
195 sql = "SELECT nodegroups.*, nodegroup_nodes.node_id" \
197 " LEFT JOIN nodegroup_nodes USING (nodegroup_id)"
199 if nodegroup_id_or_name_list:
200 # Separate the list into integers and strings
201 nodegroup_ids = filter(lambda nodegroup_id: isinstance(nodegroup_id, (int, long)),
202 nodegroup_id_or_name_list)
203 names = filter(lambda name: isinstance(name, StringTypes),
204 nodegroup_id_or_name_list)
205 sql += " WHERE (False"
207 sql += " OR nodegroup_id IN (%s)" % ", ".join(map(str, nodegroup_ids))
209 sql += " OR name IN (%s)" % ", ".join(api.db.quote(names)).lower()
212 rows = self.api.db.selectall(sql)
214 if self.has_key(row['nodegroup_id']):
215 nodegroup = self[row['nodegroup_id']]
216 nodegroup.update(row)
218 self[row['nodegroup_id']] = NodeGroup(api, row)