PLC/Addresses.py

   1 from PLC.Faults import *
   2 from PLC.Parameter import Parameter
   3 from PLC.Storage.AlchemyObject import AlchemyObj
   4 from PLC.AddressTypes import AddressType, AddressTypes
   5
   6 class Address(AlchemyObj):
   7     """
   8     Representation of a row in the addresses table. To use, instantiate
   9     with a dict of values.
  10     """
  11
  12     tablename = 'addresses'
  13     join_tables = ['address_address_type', 'site_address']
  14     fields = {
  15         'address_id': Parameter(int, "Address identifier", primary_key=True),
  16         'line1': Parameter(str, "Address line 1", max = 254),
  17         'line2': Parameter(str, "Address line 2", max = 254, nullok = True),
  18         'line3': Parameter(str, "Address line 3", max = 254, nullok = True),
  19         'city': Parameter(str, "City", max = 254),
  20         'state': Parameter(str, "State or province", max = 254),
  21         'postalcode': Parameter(str, "Postal code", max = 64),
  22         'country': Parameter(str, "Country", max = 128),
  23         'address_type_ids': Parameter([int], "Address type identifiers", joined=True),
  24         'address_types': Parameter([str], "Address types", joined=True),
  25         }
  26
  27     def add_address_type(self, address_type, commit = True):
  28         """
  29         Add address type to existing address.
  30         """
  31
  32         assert 'address_id' in self
  33         assert isinstance(address_type, AddressType)
  34         assert 'address_type_id' in address_type
  35
  36         address_id = self['address_id']
  37         address_type_id = address_type['address_type_id']
  38
  39         if address_type_id not in self['address_type_ids']:
  40             assert address_type['name'] not in self['address_types']
  41
  42             self.api.db.do("INSERT INTO address_address_type (address_id, address_type_id)" \
  43                            " VALUES(%(address_id)d, %(address_type_id)d)",
  44                            locals())
  45
  46             if commit:
  47                 self.api.db.commit()
  48
  49             self['address_type_ids'].append(address_type_id)
  50             self['address_types'].append(address_type['name'])
  51
  52     def remove_address_type(self, address_type, commit = True):
  53         """
  54         Add address type to existing address.
  55         """
  56
  57         assert 'address_id' in self
  58         assert isinstance(address_type, AddressType)
  59         assert 'address_type_id' in address_type
  60
  61         address_id = self['address_id']
  62         address_type_id = address_type['address_type_id']
  63
  64         if address_type_id in self['address_type_ids']:
  65             assert address_type['name'] in self['address_types']
  66
  67             self.api.db.do("DELETE FROM address_address_type" \
  68                            " WHERE address_id = %(address_id)d" \
  69                            " AND address_type_id = %(address_type_id)d",
  70                            locals())
  71
  72             if commit:
  73                 self.api.db.commit()
  74
  75             self['address_type_ids'].remove(address_type_id)
  76             self['address_types'].remove(address_type['name'])
  77
  78     def sync(self, insert=False, validate=True):
  79         AlchemyObj.sync(self, insert, validate)
  80         if insert == True or 'id' not in self:
  81             AlchemyObj.insert(self, dict(self))
  82         else:
  83             AlchemyObj.update(self, {'address_id': self['address_id']}, dict(self))
  84
  85     def delete(self, commit=True):
  86         assert 'address_id' in self
  87         AlchemyObj.delete(self, dict(self))
  88
  89 class Addresses(list):
  90     """
  91     Representation of row(s) from the addresses table in the
  92     database.
  93     """
  94
  95     def __init__(self, api, address_filter = None, columns = None):
  96         if address_filter is None:
  97             addresses = Address().select()
  98         elif isinstance(address_filter, (list, tuple, set, int, long)):
  99             addresses = Address().select(filter={'address_id': address_filter})
 100         elif isinstance(address_filter, dict):
 101             addresses = Address().select(filter=address_filter)
 102         else:
 103             raise PLCInvalidArgument, "Wrong address filter %r" % address_filter
 104
 105         for address in addresses:
 106             self.append(address)