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