PLC/Sites.py

   1 from types import StringTypes
   2 import string
   3
   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
  13 import PLC.Persons
  14
  15 class Site(Row):
  16     """
  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().
  20     """
  21
  22     fields = {
  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         'deleted': Parameter(bool, "Has been deleted"),
  34         'max_slices': Parameter(int, "Maximum number of slices that the site is able to create"),
  35         'max_slivers': Parameter(int, "Maximum number of slivers that the site is able to create"),
  36         'person_ids': Parameter([int], "List of account identifiers"),
  37         'slice_ids': Parameter([int], "List of slice identifiers"),
  38         'address_ids': Parameter([int], "List of address identifiers"),
  39         # 'pcu_ids': Parameter([int], "List of PCU identifiers"),
  40         'node_ids': Parameter([int], "List of site node identifiers"),
  41         }
  42
  43     def __init__(self, api, fields):
  44         Row.__init__(self, fields)
  45         self.api = api
  46
  47     def validate_login_base(self, login_base):
  48         if not set(login_base).issubset(string.ascii_letters):
  49             raise PLCInvalidArgument, "Login base must consist only of ASCII letters"
  50
  51         login_base = login_base.lower()
  52         conflicts = Sites(self.api, [login_base])
  53         for site_id, site in conflicts.iteritems():
  54             if not site['deleted'] and ('site_id' not in self or self['site_id'] != site_id):
  55                 raise PLCInvalidArgument, "login_base already in use"
  56
  57         return login_base
  58
  59     def validate_latitude(self, latitude):
  60         if not self.has_key('longitude') or \
  61            self['longitude'] is None:
  62             raise PLCInvalidArgument, "Longitude must also be specified"
  63
  64         return latitude
  65
  66     def validate_longitude(self, longitude):
  67         if not self.has_key('latitude') or \
  68            self['latitude'] is None:
  69             raise PLCInvalidArgument, "Latitude must also be specified"
  70
  71         return longitude
  72
  73     def add_person(self, person, commit = True):
  74         """
  75         Add person to existing site.
  76         """
  77
  78         assert 'site_id' in self
  79         assert isinstance(person, PLC.Persons.Person)
  80         assert 'person_id' in person
  81
  82         site_id = self['site_id']
  83         person_id = person['person_id']
  84         self.api.db.do("INSERT INTO person_site (person_id, site_id)" \
  85                        " VALUES(%(person_id)d, %(site_id)d)",
  86                        locals())
  87
  88         if commit:
  89             self.api.db.commit()
  90
  91         if 'person_ids' in self and person_id not in self['person_ids']:
  92             self['person_ids'].append(person_id)
  93
  94         if 'site_ids' in person and site_id not in person['site_ids']:
  95             person['site_ids'].append(site_id)
  96
  97     def remove_person(self, person, commit = True):
  98         """
  99         Remove person from existing site.
 100         """
 101
 102         assert 'site_id' in self
 103         assert isinstance(person, PLC.Persons.Person)
 104         assert 'person_id' in person
 105
 106         site_id = self['site_id']
 107         person_id = person['person_id']
 108         self.api.db.do("DELETE FROM person_site" \
 109                        " WHERE person_id = %(person_id)d" \
 110                        " AND site_id = %(site_id)d",
 111                        locals())
 112
 113         if commit:
 114             self.api.db.commit()
 115
 116         if 'person_ids' in self and person_id in self['person_ids']:
 117             self['person_ids'].remove(person_id)
 118
 119         if 'site_ids' in person and site_id in person['site_ids']:
 120             person['site_ids'].remove(site_id)
 121
 122     def sync(self, commit = True):
 123         """
 124         Flush changes back to the database.
 125         """
 126
 127         self.validate()
 128
 129         try:
 130             if not self['name'] or \
 131                not self['abbreviated_name'] or \
 132                not self['login_base']:
 133                 raise KeyError
 134         except KeyError:
 135             raise PLCInvalidArgument, "name, abbreviated_name, and login_base must all be specified"
 136
 137         # Fetch a new site_id if necessary
 138         if 'site_id' not in self:
 139             rows = self.api.db.selectall("SELECT NEXTVAL('sites_site_id_seq') AS site_id")
 140             if not rows:
 141                 raise PLCDBError, "Unable to fetch new site_id"
 142             self['site_id'] = rows[0]['site_id']
 143             insert = True
 144         else:
 145             insert = False
 146
 147         # Filter out fields that cannot be set or updated directly
 148         sites_fields = self.api.db.fields('sites')
 149         fields = dict(filter(lambda (key, value): key in sites_fields,
 150                              self.items()))
 151         for ro_field in 'date_created', 'last_updated':
 152             if ro_field in fields:
 153                 del fields[ro_field]
 154
 155         # Parameterize for safety
 156         keys = fields.keys()
 157         values = [self.api.db.param(key, value) for (key, value) in fields.items()]
 158
 159         if insert:
 160             # Insert new row in sites table
 161             sql = "INSERT INTO sites (%s) VALUES (%s)" % \
 162                   (", ".join(keys), ", ".join(values))
 163         else:
 164             # Update existing row in sites table
 165             columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
 166             sql = "UPDATE sites SET " + \
 167                   ", ".join(columns) + \
 168                   " WHERE site_id = %(site_id)d"
 169
 170         self.api.db.do(sql, fields)
 171
 172         if commit:
 173             self.api.db.commit()
 174
 175     def delete(self, commit = True):
 176         """
 177         Delete existing site.
 178         """
 179
 180         assert 'site_id' in self
 181
 182         # Delete accounts of all people at the site who are not
 183         # members of at least one other non-deleted site.
 184         persons = PLC.Persons.Persons(self.api, self['person_ids'])
 185         for person_id, person in persons.iteritems():
 186             delete = True
 187
 188             person_sites = Sites(self.api, person['site_ids'])
 189             for person_site_id, person_site in person_sites.iteritems():
 190                 if person_site_id != self['site_id'] and \
 191                    not person_site['deleted']:
 192                     delete = False
 193                     break
 194
 195             if delete:
 196                 person.delete(commit = False)
 197
 198         # Delete all site addresses
 199         addresses = Addresses(self.api, self['address_ids'])
 200         for address in addresses.values():
 201            address.delete(commit = False)
 202
 203         # Delete all site slices
 204         slices = Slices(self.api, self['slice_ids'])
 205         for slice in slices.values():
 206            slice.delete(commit = False)
 207
 208         # Delete all site PCUs
 209         # pcus = PCUs(self.api, self['pcu_ids'])
 210         # for pcu in pcus.values():
 211         #    pcu.delete(commit = False)
 212
 213         # Delete all site nodes
 214         nodes = Nodes(self.api, self['node_ids'])
 215         for node in nodes.values():
 216             node.delete(commit = False)
 217
 218         # Clean up miscellaneous join tables
 219         for table in ['person_site']:
 220             self.api.db.do("DELETE FROM %s" \
 221                            " WHERE site_id = %d" % \
 222                            (table, self['site_id']), self)
 223
 224         # Mark as deleted
 225         self['deleted'] = True
 226         self.sync(commit)
 227
 228 class Sites(Table):
 229     """
 230     Representation of row(s) from the sites table in the
 231     database. Specify fields to limit columns to just the specified
 232     fields.
 233     """
 234
 235     def __init__(self, api, site_id_or_login_base_list = None, fields = Site.fields):
 236         self.api = api
 237
 238         sql = "SELECT %s FROM view_sites WHERE deleted IS False" % \
 239               ", ".join(fields)
 240
 241         if site_id_or_login_base_list:
 242             # Separate the list into integers and strings
 243             site_ids = filter(lambda site_id: isinstance(site_id, (int, long)),
 244                               site_id_or_login_base_list)
 245             login_bases = filter(lambda login_base: isinstance(login_base, StringTypes),
 246                                  site_id_or_login_base_list)
 247             sql += " AND (False"
 248             if site_ids:
 249                 sql += " OR site_id IN (%s)" % ", ".join(map(str, site_ids))
 250             if login_bases:
 251                 sql += " OR login_base IN (%s)" % ", ".join(api.db.quote(login_bases))
 252             sql += ")"
 253
 254         rows = self.api.db.selectall(sql)
 255
 256         for row in rows:
 257             self[row['site_id']] = site = Site(api, row)
 258             for aggregate in ['person_ids', 'slice_ids', 'address_ids',
 259                               'pcu_ids', 'node_ids']:
 260                 if not site.has_key(aggregate) or site[aggregate] is None:
 261                     site[aggregate] = []
 262                 else:
 263                     site[aggregate] = map(int, site[aggregate].split(','))