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     table_name = 'sites'
  23     primary_key = 'site_id'
  24     fields = {
  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),
  42         }
  43
  44     def __init__(self, api, fields = {}):
  45         Row.__init__(self, fields)
  46         self.api = api
  47
  48     def validate_name(self, name):
  49         name = name.strip()
  50         if not name:
  51             raise PLCInvalidArgument, "Name must be specified"
  52
  53         return name
  54
  55     validate_abbreviated_name = validate_name
  56
  57     def validate_login_base(self, login_base):
  58         login_base = login_base.strip().lower()
  59
  60         if not login_base:
  61             raise PLCInvalidArgument, "Login base must be specified"
  62
  63         if not set(login_base).issubset(string.ascii_letters):
  64             raise PLCInvalidArgument, "Login base must consist only of ASCII letters"
  65
  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"
  70
  71         return login_base
  72
  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"
  77
  78         return latitude
  79
  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"
  84
  85         return longitude
  86
  87     def add_person(self, person, commit = True):
  88         """
  89         Add person to existing site.
  90         """
  91
  92         assert 'site_id' in self
  93         assert isinstance(person, PLC.Persons.Person)
  94         assert 'person_id' in person
  95
  96         site_id = self['site_id']
  97         person_id = person['person_id']
  98
  99         if person_id not in self['person_ids']:
 100             assert site_id not in person['site_ids']
 101
 102             self.api.db.do("INSERT INTO person_site (person_id, site_id)" \
 103                            " VALUES(%(person_id)d, %(site_id)d)",
 104                            locals())
 105
 106             if commit:
 107                 self.api.db.commit()
 108
 109             self['person_ids'].append(person_id)
 110             person['site_ids'].append(site_id)
 111
 112     def remove_person(self, person, commit = True):
 113         """
 114         Remove person from existing site.
 115         """
 116
 117         assert 'site_id' in self
 118         assert isinstance(person, PLC.Persons.Person)
 119         assert 'person_id' in person
 120
 121         site_id = self['site_id']
 122         person_id = person['person_id']
 123
 124         if person_id in self['person_ids']:
 125             assert site_id in person['site_ids']
 126
 127             self.api.db.do("DELETE FROM person_site" \
 128                            " WHERE person_id = %(person_id)d" \
 129                            " AND site_id = %(site_id)d",
 130                            locals())
 131
 132             if commit:
 133                 self.api.db.commit()
 134
 135             self['person_ids'].remove(person_id)
 136             person['site_ids'].remove(site_id)
 137
 138     def delete(self, commit = True):
 139         """
 140         Delete existing site.
 141         """
 142
 143         assert 'site_id' in self
 144
 145         # Delete accounts of all people at the site who are not
 146         # members of at least one other non-deleted site.
 147         persons = PLC.Persons.Persons(self.api, self['person_ids'])
 148         for person_id, person in persons.iteritems():
 149             delete = True
 150
 151             person_sites = Sites(self.api, person['site_ids'])
 152             for person_site_id, person_site in person_sites.iteritems():
 153                 if person_site_id != self['site_id']:
 154                     delete = False
 155                     break
 156
 157             if delete:
 158                 person.delete(commit = False)
 159
 160         # Delete all site addresses
 161         addresses = Addresses(self.api, self['address_ids'])
 162         for address in addresses.values():
 163            address.delete(commit = False)
 164
 165         # Delete all site slices
 166         slices = Slices(self.api, self['slice_ids'])
 167         for slice in slices.values():
 168            slice.delete(commit = False)
 169
 170         # Delete all site PCUs
 171         pcus = PCUs(self.api, self['pcu_ids'])
 172         for pcu in pcus.values():
 173            pcu.delete(commit = False)
 174
 175         # Delete all site nodes
 176         nodes = Nodes(self.api, self['node_ids'])
 177         for node in nodes.values():
 178             node.delete(commit = False)
 179
 180         # Clean up miscellaneous join tables
 181         for table in ['person_site']:
 182             self.api.db.do("DELETE FROM %s" \
 183                            " WHERE site_id = %d" % \
 184                            (table, self['site_id']), self)
 185
 186         # Mark as deleted
 187         self['deleted'] = True
 188         self.sync(commit)
 189
 190 class Sites(Table):
 191     """
 192     Representation of row(s) from the sites table in the
 193     database. Specify fields to limit columns to just the specified
 194     fields.
 195     """
 196
 197     def __init__(self, api, site_id_or_login_base_list = None):
 198         self.api = api
 199
 200         sql = "SELECT %s FROM view_sites WHERE deleted IS False" % \
 201               ", ".join(Site.fields)
 202
 203         if site_id_or_login_base_list:
 204             # Separate the list into integers and strings
 205             site_ids = filter(lambda site_id: isinstance(site_id, (int, long)),
 206                               site_id_or_login_base_list)
 207             login_bases = filter(lambda login_base: isinstance(login_base, StringTypes),
 208                                  site_id_or_login_base_list)
 209             sql += " AND (False"
 210             if site_ids:
 211                 sql += " OR site_id IN (%s)" % ", ".join(map(str, site_ids))
 212             if login_bases:
 213                 sql += " OR login_base IN (%s)" % ", ".join(api.db.quote(login_bases))
 214             sql += ")"
 215
 216         rows = self.api.db.selectall(sql)
 217
 218         for row in rows:
 219             self[row['site_id']] = site = Site(api, row)
 220             for aggregate in ['person_ids', 'slice_ids', 'address_ids',
 221                               'pcu_ids', 'node_ids']:
 222                 if not site.has_key(aggregate) or site[aggregate] is None:
 223                     site[aggregate] = []
 224                 else:
 225                     site[aggregate] = map(int, site[aggregate].split(','))