1 from types import StringTypes
4 from PLC.Faults import *
5 from PLC.Parameter import Parameter
6 from PLC.Debug import profile
7 from PLC.Table import Row, Table
8 from PLC.Slices import Slice, Slices
9 from PLC.PCUs import PCU, PCUs
10 from PLC.Nodes import Node, Nodes
11 from PLC.NodeGroups import NodeGroup, NodeGroups
12 from PLC.Addresses import Address, Addresses
17 Representation of a row in the sites table. To use, optionally
18 instantiate with a dict of values. Update as you would a
19 dict. Commit to the database with sync().
23 'site_id': Parameter(int, "Site identifier"),
24 'name': Parameter(str, "Full site name", max = 254),
25 'abbreviated_name': Parameter(str, "Abbreviated site name", max = 50),
26 'login_base': Parameter(str, "Site slice prefix", max = 20),
27 'is_public': Parameter(bool, "Publicly viewable site"),
28 'latitude': Parameter(float, "Decimal latitude of the site", min = -90.0, max = 90.0),
29 'longitude': Parameter(float, "Decimal longitude of the site", min = -180.0, max = 180.0),
30 'url': Parameter(str, "URL of a page that describes the site", max = 254),
31 'date_created': Parameter(int, "Date and time when site entry was created, in seconds since UNIX epoch"),
32 'last_updated': Parameter(int, "Date and time when site entry was last updated, in seconds since UNIX epoch"),
33 'max_slices': Parameter(int, "Maximum number of slices that the site is able to create"),
34 'max_slivers': Parameter(int, "Maximum number of slivers that the site is able to create"),
35 'person_ids': Parameter([int], "List of account identifiers"),
36 'slice_ids': Parameter([int], "List of slice identifiers"),
37 'address_ids': Parameter([int], "List of address identifiers"),
38 # 'pcu_ids': Parameter([int], "List of PCU identifiers"),
39 'node_ids': Parameter([int], "List of site node identifiers"),
42 def __init__(self, api, fields):
43 Row.__init__(self, fields)
46 def validate_login_base(self, login_base):
47 if not set(login_base).issubset(string.ascii_letters):
48 raise PLCInvalidArgument, "Login base must consist only of ASCII letters"
50 login_base = login_base.lower()
51 conflicts = Sites(self.api, [login_base])
52 for site_id, site in conflicts.iteritems():
53 if 'site_id' not in self or self['site_id'] != site_id:
54 raise PLCInvalidArgument, "login_base already in use"
58 def validate_latitude(self, latitude):
59 if not self.has_key('longitude') or \
60 self['longitude'] is None:
61 raise PLCInvalidArgument, "Longitude must also be specified"
65 def validate_longitude(self, longitude):
66 if not self.has_key('latitude') or \
67 self['latitude'] is None:
68 raise PLCInvalidArgument, "Latitude must also be specified"
72 def add_person(self, person, commit = True):
74 Add person to existing site.
77 assert 'site_id' in self
78 assert isinstance(person, PLC.Persons.Person)
79 assert 'person_id' in person
81 site_id = self['site_id']
82 person_id = person['person_id']
83 self.api.db.do("INSERT INTO person_site (person_id, site_id)" \
84 " VALUES(%(person_id)d, %(site_id)d)",
90 if 'person_ids' in self and person_id not in self['person_ids']:
91 self['person_ids'].append(person_id)
93 if 'site_ids' in person and site_id not in person['site_ids']:
94 person['site_ids'].append(site_id)
96 def remove_person(self, person, commit = True):
98 Remove person from existing site.
101 assert 'site_id' in self
102 assert isinstance(person, PLC.Persons.Person)
103 assert 'person_id' in person
105 site_id = self['site_id']
106 person_id = person['person_id']
107 self.api.db.do("DELETE FROM person_site" \
108 " WHERE person_id = %(person_id)d" \
109 " AND site_id = %(site_id)d",
115 if 'person_ids' in self and person_id in self['person_ids']:
116 self['person_ids'].remove(person_id)
118 if 'site_ids' in person and site_id in person['site_ids']:
119 person['site_ids'].remove(site_id)
121 def sync(self, commit = True):
123 Flush changes back to the database.
129 if not self['name'] or \
130 not self['abbreviated_name'] or \
131 not self['login_base']:
134 raise PLCInvalidArgument, "name, abbreviated_name, and login_base must all be specified"
136 # Fetch a new site_id if necessary
137 if 'site_id' not in self:
138 rows = self.api.db.selectall("SELECT NEXTVAL('sites_site_id_seq') AS site_id")
140 raise PLCDBError, "Unable to fetch new site_id"
141 self['site_id'] = rows[0]['site_id']
146 # Filter out fields that cannot be set or updated directly
147 sites_fields = self.api.db.fields('sites')
148 fields = dict(filter(lambda (key, value): key in sites_fields,
150 for ro_field in 'date_created', 'last_updated':
151 if ro_field in fields:
154 # Parameterize for safety
156 values = [self.api.db.param(key, value) for (key, value) in fields.items()]
159 # Insert new row in sites table
160 sql = "INSERT INTO sites (%s) VALUES (%s)" % \
161 (", ".join(keys), ", ".join(values))
163 # Update existing row in sites table
164 columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
165 sql = "UPDATE sites SET " + \
166 ", ".join(columns) + \
167 " WHERE site_id = %(site_id)d"
169 self.api.db.do(sql, fields)
174 def delete(self, commit = True):
176 Delete existing site.
179 assert 'site_id' in self
181 # Delete accounts of all people at the site who are not
182 # members of at least one other non-deleted site.
183 persons = PLC.Persons.Persons(self.api, self['person_ids'])
184 for person_id, person in persons.iteritems():
187 person_sites = Sites(self.api, person['site_ids'])
188 for person_site_id, person_site in person_sites.iteritems():
189 if person_site_id != self['site_id']:
194 person.delete(commit = False)
196 # Delete all site addresses
197 addresses = Addresses(self.api, self['address_ids'])
198 for address in addresses.values():
199 address.delete(commit = False)
201 # Delete all site slices
202 slices = Slices(self.api, self['slice_ids'])
203 for slice in slices.values():
204 slice.delete(commit = False)
206 # Delete all site PCUs
207 # pcus = PCUs(self.api, self['pcu_ids'])
208 # for pcu in pcus.values():
209 # pcu.delete(commit = False)
211 # Delete all site nodes
212 nodes = Nodes(self.api, self['node_ids'])
213 for node in nodes.values():
214 node.delete(commit = False)
216 # Clean up miscellaneous join tables
217 for table in ['person_site']:
218 self.api.db.do("DELETE FROM %s" \
219 " WHERE site_id = %d" % \
220 (table, self['site_id']), self)
223 self['deleted'] = True
228 Representation of row(s) from the sites table in the
229 database. Specify fields to limit columns to just the specified
233 def __init__(self, api, site_id_or_login_base_list = None, fields = Site.fields):
236 sql = "SELECT %s FROM view_sites WHERE deleted IS False" % \
239 if site_id_or_login_base_list:
240 # Separate the list into integers and strings
241 site_ids = filter(lambda site_id: isinstance(site_id, (int, long)),
242 site_id_or_login_base_list)
243 login_bases = filter(lambda login_base: isinstance(login_base, StringTypes),
244 site_id_or_login_base_list)
247 sql += " OR site_id IN (%s)" % ", ".join(map(str, site_ids))
249 sql += " OR login_base IN (%s)" % ", ".join(api.db.quote(login_bases))
252 rows = self.api.db.selectall(sql)
255 self[row['site_id']] = site = Site(api, row)
256 for aggregate in ['person_ids', 'slice_ids', 'address_ids',
257 'pcu_ids', 'node_ids']:
258 if not site.has_key(aggregate) or site[aggregate] is None:
261 site[aggregate] = map(int, site[aggregate].split(','))