PLC/Addresses.py

   1 from PLC.Faults import *
   2 from PLC.Parameter import Parameter
   3 from PLC.Table import Row, Table
   4 from PLC.AddressTypes import AddressType, AddressTypes
   5
   6 class Address(Row):
   7     """
   8     Representation of a row in the addresses table. To use, instantiate
   9     with a dict of values.
  10     """
  11
  12     table_name = 'addresses'
  13     primary_key = 'address_id'
  14     fields = {
  15         'address_id': Parameter(int, "Address identifier"),
  16         'line1': Parameter(str, "Address line 1", max = 254, optional = False),
  17         'line2': Parameter(str, "Address line 2", max = 254),
  18         'line3': Parameter(str, "Address line 3", max = 254),
  19         'city': Parameter(str, "City", max = 254, optional = False),
  20         'state': Parameter(str, "State or province", max = 254, optional = False),
  21         'postalcode': Parameter(str, "Postal code", max = 64, optional = False),
  22         'country': Parameter(str, "Country", max = 128, optional = False),
  23         'site_id': Parameter(str, "Site identifier"),
  24         'address_type_ids': Parameter([int], "Address type identifiers", ro = True),
  25         'address_types': Parameter([str], "Address types", ro = True),
  26         }
  27
  28     def __init__(self, api, fields = {}):
  29         Row.__init__(self, fields)
  30         self.api = api
  31
  32     def add_address_type(self, address_type, commit = True):
  33         """
  34         Add address type to existing address.
  35         """
  36
  37         assert 'address_id' in self
  38         assert isinstance(address_type, AddressType)
  39         assert 'address_type_id' in address_type
  40
  41         address_id = self['address_id']
  42         address_type_id = address_type['address_type_id']
  43
  44         if address_type_id not in self['address_type_ids']:
  45             assert address_type['name'] not in self['address_types']
  46
  47             self.api.db.do("INSERT INTO address_address_type (address_id, address_type_id)" \
  48                            " VALUES(%(address_id)d, %(address_type_id)d)",
  49                            locals())
  50
  51             if commit:
  52                 self.api.db.commit()
  53
  54             self['address_type_ids'].append(address_type_id)
  55             self['address_types'].append(address_type['name'])
  56
  57     def remove_address_type(self, address_type, commit = True):
  58         """
  59         Add address type to existing address.
  60         """
  61
  62         assert 'address_id' in self
  63         assert isinstance(address_type, AddressType)
  64         assert 'address_type_id' in address_type
  65
  66         address_id = self['address_id']
  67         address_type_id = address_type['address_type_id']
  68
  69         if address_type_id in self['address_type_ids']:
  70             assert address_type['name'] in self['address_types']
  71
  72             self.api.db.do("DELETE FROM address_address_type" \
  73                            " WHERE address_id = %(address_id)d" \
  74                            " AND address_type_id = %(address_type_id)d",
  75                            locals())
  76
  77             if commit:
  78                 self.api.db.commit()
  79
  80             self['address_type_ids'].remove(address_type_id)
  81             self['address_types'].remove(address_type['name'])
  82
  83     def delete(self, commit = True):
  84         """
  85         Delete existing address from the database.
  86         """
  87
  88         assert 'address_id' in self
  89
  90         # Clean up miscellaneous join tables
  91         for table in ['address_address_type', 'addresses']:
  92             self.api.db.do("DELETE FROM %s" \
  93                            " WHERE address_id = %d" % \
  94                            (table, self['address_id']), self)
  95
  96         if commit:
  97             self.api.db.commit()
  98
  99 class Addresses(Table):
 100     """
 101     Representation of row(s) from the addresses table in the
 102     database.
 103     """
 104
 105     def __init__(self, api, address_id_list = None):
 106         self.api = api
 107
 108         sql = "SELECT %s FROM view_addresses" % \
 109               ", ".join(Address.fields)
 110
 111         if address_id_list:
 112             sql += " WHERE address_id IN (%s)" % ", ".join(map(str, address_id_list))
 113
 114         rows = self.api.db.selectall(sql)
 115
 116         for row in rows:
 117             self[row['address_id']] = address = Address(api, row)
 118             for aggregate in 'address_type_ids', 'address_types':
 119                 if not address.has_key(aggregate) or address[aggregate] is None:
 120                     address[aggregate] = []
 121                 else:
 122                     elements = address[aggregate].split(',')
 123                     try:
 124                         address[aggregate] = map(int, elements)
 125                     except ValueError:
 126                         address[aggregate] = elements