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     join_tables = ['address_address_type', 'site_address']
  15     fields = {
  16         'address_id': Parameter(int, "Address identifier"),
  17         'line1': Parameter(str, "Address line 1", max = 254),
  18         'line2': Parameter(str, "Address line 2", max = 254, nullok = True),
  19         'line3': Parameter(str, "Address line 3", max = 254, nullok = True),
  20         'city': Parameter(str, "City", max = 254),
  21         'state': Parameter(str, "State or province", max = 254),
  22         'postalcode': Parameter(str, "Postal code", max = 64),
  23         'country': Parameter(str, "Country", max = 128),
  24         'address_type_ids': Parameter([int], "Address type identifiers", ro = True),
  25         'address_types': Parameter([str], "Address types", ro = True),
  26         }
  27
  28     def add_address_type(self, address_type, commit = True):
  29         """
  30         Add address type to existing address.
  31         """
  32
  33         assert 'address_id' in self
  34         assert isinstance(address_type, AddressType)
  35         assert 'address_type_id' in address_type
  36
  37         address_id = self['address_id']
  38         address_type_id = address_type['address_type_id']
  39
  40         if address_type_id not in self['address_type_ids']:
  41             assert address_type['name'] not in self['address_types']
  42
  43             self.api.db.do("INSERT INTO address_address_type (address_id, address_type_id)" \
  44                            " VALUES(%(address_id)d, %(address_type_id)d)",
  45                            locals())
  46
  47             if commit:
  48                 self.api.db.commit()
  49
  50             self['address_type_ids'].append(address_type_id)
  51             self['address_types'].append(address_type['name'])
  52
  53     def remove_address_type(self, address_type, commit = True):
  54         """
  55         Add address type to existing address.
  56         """
  57
  58         assert 'address_id' in self
  59         assert isinstance(address_type, AddressType)
  60         assert 'address_type_id' in address_type
  61
  62         address_id = self['address_id']
  63         address_type_id = address_type['address_type_id']
  64
  65         if address_type_id in self['address_type_ids']:
  66             assert address_type['name'] in self['address_types']
  67
  68             self.api.db.do("DELETE FROM address_address_type" \
  69                            " WHERE address_id = %(address_id)d" \
  70                            " AND address_type_id = %(address_type_id)d",
  71                            locals())
  72
  73             if commit:
  74                 self.api.db.commit()
  75
  76             self['address_type_ids'].remove(address_type_id)
  77             self['address_types'].remove(address_type['name'])
  78
  79 class Addresses(Table):
  80     """
  81     Representation of row(s) from the addresses table in the
  82     database.
  83     """
  84
  85     def __init__(self, api, address_id_list = None):
  86         self.api = api
  87
  88         sql = "SELECT %s FROM view_addresses" % \
  89               ", ".join(Address.fields)
  90
  91         if address_id_list:
  92             sql += " WHERE address_id IN (%s)" % ", ".join(map(str, address_id_list))
  93
  94         rows = self.api.db.selectall(sql)
  95
  96         for row in rows:
  97             self[row['address_id']] = address = Address(api, row)
  98             for aggregate in 'address_type_ids', 'address_types':
  99                 if not address.has_key(aggregate) or address[aggregate] is None:
 100                     address[aggregate] = []
 101                 else:
 102                     elements = address[aggregate].split(',')
 103                     try:
 104                         address[aggregate] = map(int, elements)
 105                     except ValueError:
 106                         address[aggregate] = elements