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