GeographicAddress.py 4.34 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo

31
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33
from Products.ERP5Type.Base import Base

34
from Products.ERP5.Document.Coordinate import Coordinate
Nicolas Delaby's avatar
Nicolas Delaby committed
35 36

import string
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

class GeographicAddress(Coordinate, Base):
    """
        A geographic address holds a complete set of
        geographic coordinates including street, number,
        city, zip code, region.

        Geographic address is a terminating leaf
        in the OFS. It can not contain anything.

        Geographic address inherits from Base and
        from the mix-in Coordinate
    """
    meta_type = 'ERP5 Geographic Address'
    portal_type = 'Address'
52
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55 56 57
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
58
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61 62

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.SimpleItem
63
                      , PropertySheet.SortIndex
64
                      , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65 66 67 68
                      , PropertySheet.GeographicAddress
                      )


69
    security.declareProtected(Permissions.AccessContentsInformation, 'asText')
70
    def asText(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71 72 73 74
        """
          Returns the address as a complete formatted string
          with street address, zip, city and region
        """
75 76
        result = Coordinate.asText(self)
        if result is None:
77 78
          result = ('%s\n%s %s') % (self.getStreetAddress() or '',
                      self.getCity() or '', self.getZipCode() or '')
79 80
        if not result.strip():
          return ''
81
        return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
82 83 84 85 86 87

    security.declareProtected(Permissions.ModifyPortalContent, 'fromText')
    def fromText(self, coordinate_text):
        """
          Tries to recognize the coordinate_text to update
          this address
88 89 90 91
          XXX fromText will be removed.
          Instead, store text value as user filled in text attribute,
          then display text value through a configurable output filter, suitable
          for all addresses patterns.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
92
        """
Nicolas Delaby's avatar
Nicolas Delaby committed
93
        lines = string.split(coordinate_text, '\n')
94 95 96
        self.setStreetAddress('')
        self.setZipCode('')
        self.setCity('')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
97
        zip_city = None
Nicolas Delaby's avatar
Nicolas Delaby committed
98 99 100 101
        if len(lines ) > 1:
          self.setStreetAddress(lines[0:-1])
          zip_city = string.split(lines[-1])
        elif len(lines ) > 0:
102
          self.setStreetAddress('')
Nicolas Delaby's avatar
Nicolas Delaby committed
103
          zip_city = string.split(lines[-1])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
104
        if zip_city:
105
          self.setZipCode(zip_city[0])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
106
          if len(zip_city) > 1:
Nicolas Delaby's avatar
Nicolas Delaby committed
107
            self.setCity(string.join(zip_city[1:]))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
108

109 110
    security.declareProtected(Permissions.AccessContentsInformation,
                              'standardTextFormat')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
111 112 113 114 115 116 117 118 119 120 121
    def standardTextFormat(self):
        """
          Returns the standard text format for geographic addresses
        """
        return ("""\
c/o Jean-Paul Sartre
43, avenue Kleber
75118 Paris Cedex 5
""",
)