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 primary_key = 'site_id'
25 'site_id': Parameter(int, "Site identifier"),
26 'name': Parameter(str, "Full site name", max = 254),
27 'abbreviated_name': Parameter(str, "Abbreviated site name", max = 50),
28 'login_base': Parameter(str, "Site slice prefix", max = 20),
29 'is_public': Parameter(bool, "Publicly viewable site"),
30 'latitude': Parameter(float, "Decimal latitude of the site", min = -90.0, max = 90.0),
31 'longitude': Parameter(float, "Decimal longitude of the site", min = -180.0, max = 180.0),
32 'url': Parameter(str, "URL of a page that describes the site", max = 254),
33 'date_created': Parameter(int, "Date and time when site entry was created, in seconds since UNIX epoch", ro = True),
34 'last_updated': Parameter(int, "Date and time when site entry was last updated, in seconds since UNIX epoch", ro = True),
35 'max_slices': Parameter(int, "Maximum number of slices that the site is able to create"),
36 'max_slivers': Parameter(int, "Maximum number of slivers that the site is able to create"),
37 'person_ids': Parameter([int], "List of account identifiers", ro = True),
38 'slice_ids': Parameter([int], "List of slice identifiers", ro = True),
39 'address_ids': Parameter([int], "List of address identifiers", ro = True),
40 # 'pcu_ids': Parameter([int], "List of PCU identifiers", ro = True),
41 'node_ids': Parameter([int], "List of site node identifiers", ro = True),
44 def __init__(self, api, fields = {}):
45 Row.__init__(self, fields)
48 def validate_name(self, name):
51 raise PLCInvalidArgument, "Name must be specified"
55 validate_abbreviated_name = validate_name
57 def validate_login_base(self, login_base):
58 login_base = login_base.strip().lower()
61 raise PLCInvalidArgument, "Login base must be specified"
63 if not set(login_base).issubset(string.ascii_letters):
64 raise PLCInvalidArgument, "Login base must consist only of ASCII letters"
66 conflicts = Sites(self.api, [login_base])
67 for site_id, site in conflicts.iteritems():
68 if 'site_id' not in self or self['site_id'] != site_id:
69 raise PLCInvalidArgument, "login_base already in use"
73 def validate_latitude(self, latitude):
74 if not self.has_key('longitude') or \
75 self['longitude'] is None:
76 raise PLCInvalidArgument, "Longitude must also be specified"
80 def validate_longitude(self, longitude):
81 if not self.has_key('latitude') or \
82 self['latitude'] is None:
83 raise PLCInvalidArgument, "Latitude must also be specified"
87 def add_person(self, person, commit = True):
89 Add person to existing site.
92 assert 'site_id' in self
93 assert isinstance(person, PLC.Persons.Person)
94 assert 'person_id' in person
96 site_id = self['site_id']
97 person_id = person['person_id']
98 self.api.db.do("INSERT INTO person_site (person_id, site_id)" \
99 " VALUES(%(person_id)d, %(site_id)d)",
105 if 'person_ids' in self and person_id not in self['person_ids']:
106 self['person_ids'].append(person_id)
108 if 'site_ids' in person and site_id not in person['site_ids']:
109 person['site_ids'].append(site_id)
111 def remove_person(self, person, commit = True):
113 Remove person from existing site.
116 assert 'site_id' in self
117 assert isinstance(person, PLC.Persons.Person)
118 assert 'person_id' in person
120 site_id = self['site_id']
121 person_id = person['person_id']
122 self.api.db.do("DELETE FROM person_site" \
123 " WHERE person_id = %(person_id)d" \
124 " AND site_id = %(site_id)d",
130 if 'person_ids' in self and person_id in self['person_ids']:
131 self['person_ids'].remove(person_id)
133 if 'site_ids' in person and site_id in person['site_ids']:
134 person['site_ids'].remove(site_id)
136 def delete(self, commit = True):
138 Delete existing site.
141 assert 'site_id' in self
143 # Delete accounts of all people at the site who are not
144 # members of at least one other non-deleted site.
145 persons = PLC.Persons.Persons(self.api, self['person_ids'])
146 for person_id, person in persons.iteritems():
149 person_sites = Sites(self.api, person['site_ids'])
150 for person_site_id, person_site in person_sites.iteritems():
151 if person_site_id != self['site_id']:
156 person.delete(commit = False)
158 # Delete all site addresses
159 addresses = Addresses(self.api, self['address_ids'])
160 for address in addresses.values():
161 address.delete(commit = False)
163 # Delete all site slices
164 slices = Slices(self.api, self['slice_ids'])
165 for slice in slices.values():
166 slice.delete(commit = False)
168 # Delete all site PCUs
169 # pcus = PCUs(self.api, self['pcu_ids'])
170 # for pcu in pcus.values():
171 # pcu.delete(commit = False)
173 # Delete all site nodes
174 nodes = Nodes(self.api, self['node_ids'])
175 for node in nodes.values():
176 node.delete(commit = False)
178 # Clean up miscellaneous join tables
179 for table in ['person_site']:
180 self.api.db.do("DELETE FROM %s" \
181 " WHERE site_id = %d" % \
182 (table, self['site_id']), self)
185 self['deleted'] = True
190 Representation of row(s) from the sites table in the
191 database. Specify fields to limit columns to just the specified
195 def __init__(self, api, site_id_or_login_base_list = None):
198 sql = "SELECT %s FROM view_sites WHERE deleted IS False" % \
199 ", ".join(Site.fields)
201 if site_id_or_login_base_list:
202 # Separate the list into integers and strings
203 site_ids = filter(lambda site_id: isinstance(site_id, (int, long)),
204 site_id_or_login_base_list)
205 login_bases = filter(lambda login_base: isinstance(login_base, StringTypes),
206 site_id_or_login_base_list)
209 sql += " OR site_id IN (%s)" % ", ".join(map(str, site_ids))
211 sql += " OR login_base IN (%s)" % ", ".join(api.db.quote(login_bases))
214 rows = self.api.db.selectall(sql)
217 self[row['site_id']] = site = Site(api, row)
218 for aggregate in ['person_ids', 'slice_ids', 'address_ids',
219 'pcu_ids', 'node_ids']:
220 if not site.has_key(aggregate) or site[aggregate] is None:
223 site[aggregate] = map(int, site[aggregate].split(','))