Coordinate.py 6.71 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
#
# 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.
#
##############################################################################

29
import zope.interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31
from AccessControl import ClassSecurityInfo

32
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33
from Products.ERP5Type.Base import Base
34
from Products.ERP5Type.Utils import deprecated, formatRFC822Headers
35 36
import re

37 38
_marker = object()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
class Coordinate(Base):
40
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
        Coordinates is a mix-in class which is used to store elementary
        coordinates of an Entity (ex. Person, Organisation)

        UNKNOWN Coordinates are treated as a document
        with a subject (to find a given type of coordinate).

        Coordinates use a URL approach. Any coordinate can
        be rendered in a URL style. For example::

            - tel:+33(0)662057614

            - fax:+33(0)153010929

            - mailto:jp@nexedi.com

            - naf:722Z

Romain Courteaud's avatar
Romain Courteaud committed
58
            - smail://Nexedi/Jean-Paul Smets/943, av de la Republique/59700
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
                        Marcq-en-Baroeul/France

        Coordinates are stored as content within an Entity. Coordinate ids
        are generated as a combination of a so-called role (ex. shipping,
        billing, etc.) and a class string. This way, coordinates can
        be accessed as attributes of the containing Entity::

            - default_phone

            - default_fax

            - billing_address

            - shipping_address

        In order to be able to list all coordinates of an Entity,
        a list of Coordinate metatypes has to be defined and
        stored somewhere. (TODO)
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
  """

  meta_type = 'ERP5 Coordinate'
  portal_type = 'Coordinate'
  add_permission = Permissions.AddPortalContent

  # Declarative interface
  zope.interface.implements(interfaces.ICoordinate, )

  # Declarative security (replaces __ac_permissions__)
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
                    , PropertySheet.Coordinate
                    )

  ### helper methods
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getRegularExpressionFindAll')
  def getRegularExpressionFindAll(self, regular_expression, string):
    """
    allows call of re.findall in a python script used for Coordinate
    """
    return re.findall(regular_expression, string)

  security.declareProtected( Permissions.AccessContentsInformation,
                             'getRegularExpressionGroups')
  def getRegularExpressionGroups(self, regular_expression, string):
    """
    allows call of re.search.groups in a python script used for Coordinate
    """
    match = re.search(regular_expression, string)
    if match is None:
      return ()
    return re.search(regular_expression, string).groups()

  ### Mix-in methods
  security.declareProtected( Permissions.AccessContentsInformation,
                             'asText' )
  def asText(self):
    """
    returns the coordinate as a text string
    """
    script = self._getTypeBasedMethod('asText')
    if script is not None:
      return script()

  security.declareProtected( Permissions.AccessContentsInformation,
                             'getText')
  def getText(self):
    """
    calls asText
    """
    return self.asText()

  security.declareProtected( Permissions.AccessContentsInformation,
                             'hasText')
  def hasText(self):
    """
    calls asText
    """
    return bool(self.asText())

  security.declareProtected(Permissions.AccessContentsInformation, 'getCoordinateText')
  def getCoordinateText(self, default=_marker):
    """Fallback on splitted values (old API)
    """
    if not self.hasCoordinateText() and self.isDetailed():
      # Display old values (parsed ones)
      # empty value is None, not ''
      value = self.asText()
      if value:
        return value
153
      if default is _marker:
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
        return None
      else:
        return default
    if default is _marker:
      return self._baseGetCoordinateText()
    return self._baseGetCoordinateText(default)

  security.declareProtected( Permissions.ModifyPortalContent, 'fromText' )
  @deprecated
  def fromText(self, coordinate_text):
    """
    modifies the coordinate according to the input text
    must be implemented by subclasses
    """
    script = self._getTypeBasedMethod('fromText')
    if script is not None:
      return script(text=coordinate_text)

  security.declareProtected(Permissions.ModifyPortalContent, '_setText')
  def _setText(self, value):
    """
    calls fromText
    """
    return self.fromText(value)

  security.declareProtected( Permissions.AccessContentsInformation,
                             'standardTextFormat')
  def standardTextFormat(self):
    """
    Returns the standard text formats for telephone numbers
    """
    pass

  security.declareProtected(Permissions.AccessContentsInformation, 'isDetailed')
  def isDetailed(self):
    return False

  security.declareProtected( Permissions.View, 'manage_FTPget' )
  def manage_FTPget(self):
    """
    Get the coordinate as text for WebDAV src / FTP download.
    """
    hdrlist = self.getMetadataHeaders()
    hdrtext = formatRFC822Headers( hdrlist )
    bodytext = '%s\n\n%s' % ( hdrtext, self.asText() )

    return bodytext

  security.declareProtected( Permissions.View, 'get_size' )
  def get_size( self ):
    """
    Used for FTP and apparently the ZMI now too
    """
    return len(self.manage_FTPget())