Telephone.py 19.2 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 31 32 33
#
# 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

from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.Base import Base

34
from Products.ERP5.Document.Coordinate import Coordinate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

import re

class Telephone(Coordinate, Base):
    """
        A telephone is a coordinate which stores a telephone number
        The telephone class may be used by multiple content types (ex. Fax,
        Mobile Phone, Fax, Remote Access, etc.).

        A telephone is a terminating leaf
        in the OFS. It can not contain anything.

        Telephone inherits from Base and
        from the mix-in Coordinate

        A list of I18N telephone codes can be found here::
          http://kropla.com/dialcode.htm
    """

    meta_type = 'ERP5 Telephone'
    portal_type = 'Telephone'
56
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57 58 59 60 61
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
62
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63 64 65 66 67 68

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.SimpleItem
                      , PropertySheet.Telephone
                      )
69 70 71 72 73
    
    # The notation always need to have:
    # <country> or <area> or <number> or <ext>
    # If uses a different tag it will be ignored.
    standard_dict = {
74 75 76 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
      # France
      '33' : {
        "regex_input_list" : [          
          # Country, Area, Number, Extension*
          # +33(0)2-27224896/999 or +33(0)2-27224896/ or +33(0)2-27224896
          "\+(?P<country>\d+)\(0\)(?P<area>\d+)\-(?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)", 
        
          # Missing country
          # +(0)2-27224896/999" or +(0)2-27224896/ or +(0)2-27224896
          "\+\(0\)(?P<area>\d+)\-(?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",

          # Missing area
          # +33(0)-27224896/999" or +33(0)-27224896/ or +33(0)-27224896
          "\+(?P<country>\d+)\(0\)\-(?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)", 

          # Missing Country and Area 
          # +(0)-27224896/999" or +(0)-27224896/ or +(0)-27224896
          "\+\(0\)\-(?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number, Extension*
          # The area between parenthesis.
          # +33(629)024425/222 or +33(629)024425/ or +33(629)024425
          "^\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ ]+)/?(?P<ext>\d+|)$", 
          # Area, Number Extension*
          # Area between parenthesis.
          # (22)27224897/333 or (22)27224897/ or (22)27224897
          "\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Area, Number, Extension*
          # Area followed by '-'
          # (22)-12345678/222 or (22)-12345678/ or (22)-12345678
          "\((?P<area>\d+)\)\-?(?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number and Extension*
          # Country space area space number slash extension or not
          # +33 2 098765432/1 or +33 2 098765432/ or +33 2 098765432
          "\+(?P<country>\d+)\ (?P<area>\d+)\ (?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
        
          # This regex is to handle two inputs very similar
          # but with different behavior
          # 631 22 43/999 or 631 22 43 or 631 22 43 
          # will result in {'area':'', 'country':'631 22 43', 'ext':'999 or empty'}
          #
          # 631-22 43/999 or 631-22 43 or 631-22 43 
          # will result in {'area':'631', 'country':'22 43', 'ext':'999 or empty'} 
          "^(?:0)?((?P<area>\d+)-)?(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047-336-5411/999 or 047-336-5411/ or 047-336-5411
          "^0(?P<area>\d+)-(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047(336)5411/999 or 047(336)5411/ or 047(336)5411
          "^0(?P<area>\d+)\((?P<number>[\d\)\(\ \-]*)(?:\/)?(?P<ext>\d+|)$"
        ],
129 130
        "notation" : "+<country>(0)<area>-<number>/<ext>"
      },
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 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
      # Brazil
      '55' : {
        "regex_input_list" : [
          # Country, Area, Number, Extension*
          # +55(2)27224896/999 or +55(2)27224896/ or +55(2)27224896
          "\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)", 
          
          # Country, Area, Number, Extension*
          # +55-2-27224896/999 or +55-2-27224896/ or +55-2-27224896
          "\+(?P<country>\d+)-(?P<area>\d+)-(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)", 
        
          # Missing country
          # +(2)27224896/999 or +(2)27224896/ or +(2)27224896
          "\+\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",

          # Missing area
          # +55()-27224896/999 or +55()-27224896/ or +55()-27224896
          # +55()27224896/999 or +55()27224896/ or +55()27224896
          "\+(?P<country>\d+)\(\)(?:\-)?(?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
          
          # Missing Country and Area 
          # +()27224896/999 or +()27224896/ or +()27224896
          "\+\(\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number, Extension*
          # The area between parenthesis.
          # +55(629)024425/222 or +55(629)024425/ or +55(629)024425
          "^\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ ]+)/?(?P<ext>\d+|)$", 

          # Area, Number Extension*
          # Area between parenthesis.
          # (22)27224897/333 or (22)27224897/ or (22)27224897
          "\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number and Extension*
          # Country space area space number slash extension or not
          # +55 2 098765432/1 or +55 2 098765432/ or +55 2 098765432
          "\+(?P<country>\d+)\ (?P<area>\d+)\ (?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
        
          # This regex is to handle two inputs very similar
          # but with different behavior
          # 631 22 43/999 or 631 22 43 or 631 22 43 
          # will result in {'area':'', 'country':'631 22 43', 'ext':'999 or empty'}
          #
          # 631-22 43/999 or 631-22 43 or 631-22 43 
          # will result in {'area':'631', 'country':'22 43', 'ext':'999 or empty'} 
          "^((?P<area>\d+)-)?(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047-336-5411/999 or 047-336-5411/ or 047-336-5411
          "^(?P<area>\d+)-(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047(336)5411/999 or 047(336)5411/ or 047(336)5411
          "^(?P<area>\d+)\((?P<number>[\d\)\(\ \-]*)(?:\/)?(?P<ext>\d+|)$"
        ],
187 188
        "notation" : "+<country>(<area>)<number>/<ext>",
      },
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
       # Senegal
      '221' : {
        "regex_input_list" : [
          # Country, Area, Number, Extension*
          # +221(2)27224896/999 or +221(2)27224896/ or +221(2)27224896
          "\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)", 
          
          # Country, Area, Number, Extension*
          # +221-2-27224896/999 or +221-2-27224896/ or +221-2-27224896
          "\+(?P<country>\d+)-(?P<area>\d+)-(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)", 
        
          # Missing country
          # +(2)27224896/999" or +(2)27224896/ or +(2)27224896
          "\+\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",

          # Missing area
          # +221()27224896/999" or +221()27224896/ or +221()27224896
          "\+(?P<country>\d+)\(\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
          
          # Missing Country and Area 
          # +()27224896/999" or +()27224896/ or +()27224896
          "\+\(\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number, Extension*
          # The area between parenthesis.
          # +221(629)024425/222 or +221(629)024425/ or +221(629)024425
          "^\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ ]+)/?(?P<ext>\d+|)$", 
          # Area, Number Extension*
          # Area between parenthesis.
          # (22)27224897/333 or (22)27224897/ or (22)27224897
          "\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number and Extension*
          # Country space area space number slash extension or not
          # +221 2 098765432/1 or +221 2 098765432/ or +221 2 098765432
          "\+(?P<country>\d+)\ (?P<area>\d+)\ (?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
        
          # This regex is to handle two inputs very similar
          # but with different behavior
          # 631 22 43/999 or 631 22 43 or 631 22 43 
          # will result in {'area':'', 'country':'631 22 43', 'ext':'999 or empty'}
          #
          # 631-22 43/999 or 631-22 43 or 631-22 43 
          # will result in {'area':'631', 'country':'22 43', 'ext':'999 or empty'} 
          "^((?P<area>\d+)-)?(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047-336-5411/999 or 047-336-5411/ or 047-336-5411
          "^(?P<area>\d+)-(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047(336)5411/999 or 047(336)5411/ or 047(336)5411
          "^(?P<area>\d+)\((?P<number>[\d\)\(\ \-]*)(?:\/)?(?P<ext>\d+|)$"
        ],
        "notation" : "+<country>(<area>)<number>/<ext>",
244
      },
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
      # Japan
      '81' : {
        "regex_input_list" : [
          # Country, Area, Number, Extension*
          # +81(2)27224896/999 or +81(2)27224896/ or +81(2)27224896
          "\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)", 
          
          # Country, Area, Number, Extension*
          # +81-2-27224896/999 or +81-2-27224896/ or +81-2-27224896
          "\+(?P<country>\d+)-(?P<area>\d+)-(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)", 
        
          # Missing country
          # +(2)27224896/999" or +(2)27224896/ or +(2)27224896
          "\+\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
          
          # Missing Country and Area 
          # +()27224896/999" or +()27224896/ or +()27224896
          "\+\(\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number, Extension*
          # The area between parenthesis.
          # +81(629)024425/222 or +81(629)024425/ or +81(629)024425
          "^\+(?P<country>\d+)\((?P<area>\d+)\)(?P<number>[\d\ ]+)/?(?P<ext>\d+|)$", 
          # Area, Number Extension*
          # Area between parenthesis.
          # (22)27224897/333 or (22)27224897/ or (22)27224897
          "\((?P<area>\d+)\)(?P<number>[\d\ \-]*)(?:\/)?(?P<ext>\d+|)",
        
          # Country, Area, Number and Extension*
          # Country space area space number slash extension or not
          # +81 2 098765432/1 or +81 2 098765432/ or +81 2 098765432
          "\+(?P<country>\d+)\ (?P<area>\d+)\ (?P<number>[\d\ ]*)(?:\/)?(?P<ext>\d+|)",
        
          # This regex is to handle two inputs very similar
          # but with different behavior
          # 631 22 43/999 or 631 22 43 or 631 22 43 
          # will result in {'area':'', 'country':'631 22 43', 'ext':'999 or empty'}
          #
          # 631-22 43/999 or 631-22 43 or 631-22 43 
          # will result in {'area':'631', 'country':'22 43', 'ext':'999 or empty'} 
          "^((?P<area>\d+)-)?(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047-336-5411/999 or 047-336-5411/ or 047-336-5411
          "^(?P<area>\d+)-(?P<number>[\d\-\ ]*)(?:\/)?(?P<ext>\d+|)$",
        
          # Area, Number, Extension*
          # 047(336)5411/999 or 047(336)5411/ or 047(336)5411
          "^(?P<area>\d+)\((?P<number>[\d\)\(\ \-]*)(?:\/)?(?P<ext>\d+|)$"
        ],
295 296 297 298
        "notation" : "+<country>(<area>)<number>/<ext>",
      }
    }
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
299
    security.declareProtected(Permissions.ModifyPortalContent, 'fromText')
300
    def fromText(self, coordinate_text):
301 302 303 304 305 306 307 308
      """ See ICoordinate.fromText """
      method = self._getTypeBasedMethod('fromText')
      if method is not None:
        return method(text=coordinate_text)
      
      if coordinate_text is None:
        coordinate_text = ''

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
      # This regexp get the coordinate text 
      # and extract number and letters
      input_regex_without_markup = '[0-9A-Za-z]'
      input_without_markup = ''.join(re.findall(input_regex_without_markup,\
                                                coordinate_text))
      # Test if coordinate_text has or not markups.
      if len(coordinate_text) > len(input_without_markup):
        # Trying to get the regex list.
        input_parser_list = self._getRegexList(coordinate_text=coordinate_text)
        number_match = None
        for input_parser in input_parser_list:
          possible_number_match = re.match(input_parser, coordinate_text)
          if possible_number_match not in [None]:
            number_match = possible_number_match
            break
        if number_match == None:
          from zLOG import LOG, WARNING
          msg = "Doesn't exist a regex to handle this telephone: ", coordinate_text
          LOG('*** Telephone ***',WARNING,msg)
328 329
          return
        number_dict = number_match.groupdict()
330
      else:
331
        number_dict = {'number' : coordinate_text}
332

333 334 335 336 337 338 339 340 341
      country=number_dict.get('country','')
      area=number_dict.get('area','')
      number=number_dict.get('number','')
      ext=number_dict.get('ext','')

      if ((country in ['', None]) and \
          (area in ['', None]) and \
          (number in ['', None]) and \
          (ext in ['', None])):
342
        country = area = number = extension = ''
343
      else:
344 345
        # The country and area is trying to get from dict, 
        # but if it fails must be get from preference
346 347 348
        country_default_number = self.portal_preferences.getPreferredTelephoneDefaultCountryNumber()
        area_default_number = self.portal_preferences.getPreferredTelephoneDefaultAreaNumber()

349
        country = (number_dict.get('country') or \
350
                   country_default_number or \
351 352
                   '').strip()
        area = (number_dict.get('area') or \
353
                area_default_number or 
354
                '').strip()
355 356 357 358 359 360 361 362 363
        number = (number_dict.get('number') or '').strip()

        # Formating the number.
        # Removing any ")", "(", "-" and " "
        number = number.replace('-', '')
        number = number.replace(' ','')
        number = number.replace(')','')
        number = number.replace('(','')

364 365 366 367 368 369 370
        extension = (number_dict.get('ext') or '').strip()

      self.edit(telephone_country = country,
                telephone_area = area,
                telephone_number = number, 
                telephone_extension = extension)
     
371 372
    security.declareProtected(Permissions.ModifyPortalContent, '_setText')
    _setText = fromText
Jean-Paul Smets's avatar
Jean-Paul Smets committed
373 374 375

    security.declareProtected(Permissions.View, 'asText')
    def asText(self):
376 377 378 379 380 381 382 383 384 385 386 387
      """
        Returns the telephone number in standard format
      """
      script = self._getTypeBasedMethod('asText')
      if script is not None:
        return script()
      
      telephone_country = self.getTelephoneCountry() or ''
      telephone_area = self.getTelephoneArea() or ''
      telephone_number = self.getTelephoneNumber() or ''
      telephone_extension = self.getTelephoneExtension() or ''
     
388 389
      # If country, area, number, extension are blank 
      # the method should to return blank.
390 391 392 393 394
      if ((telephone_country == '') and \
          (telephone_area == '') and \
          (telephone_number == '') and \
          (telephone_extension == '')): 
        return ''
395 396 397
 
      # Trying to get the notation
      notation = self._getNotation(telephone_country=telephone_country)
398 399 400 401 402 403 404
      if notation not in [None, '']:
        notation=notation.replace('<country>',telephone_country)
        notation=notation.replace('<area>',telephone_area)
        notation=notation.replace('<number>',telephone_number)
        notation=notation.replace('<ext>',telephone_extension)

      return notation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
405

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    security.declareProtected(Permissions.AccessContentsInformation,
                              'asURL')
    def asURL(self):
      """Returns a text representation of the Url if defined
      or None else.
      """
      telephone_country = self.getTelephoneCountry()
      if telephone_country is not None:
        url_string = '+%s' % telephone_country
      else :
        url_string = '0'

      telephone_area = self.getTelephoneArea()
      if telephone_area is not None:
        url_string += telephone_area

      telephone_number = self.getTelephoneNumber()
      if telephone_number is not None:
        url_string += telephone_number

      if url_string == '0':
        return None
      return 'tel:%s' % (url_string.replace(' ',''))

430 431
    security.declareProtected(Permissions.View, 'getText')
    getText = asText
Jean-Paul Smets's avatar
Jean-Paul Smets committed
432 433 434

    security.declareProtected(Permissions.View, 'standardTextFormat')
    def standardTextFormat(self):
435 436 437 438 439
      """
        Returns the standard text formats for telephone numbers
      """
      return ("+33(0)6-62 05 76 14",)

440
    def _getRegexDict(self, index=None):
441 442 443 444
      """
        Returns a dict with Regex and Notations based from 
        country or region
      """
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
      # Trying to get the Regex Dict
      if index not in self.standard_dict.keys():
        index = self.portal_preferences.getPreferredTelephoneDefaultCountryNumber() or '33'
           
      return self.standard_dict.get(index)
    
    def _getRegexList(self, coordinate_text):
      """
        Returns the regex list.
      """
      # Trying to get a possible contry number
      country_regex = '((\+|)(?P<country>\d*))'
      country = re.match(country_regex, \
                       coordinate_text).groupdict().get('country','')
      regex_dict = self._getRegexDict(index=country)
      input_parser = regex_dict.get('regex_input_list')
      return input_parser
  
    def _getNotation(self, telephone_country):
      """
        Returns the notation that will be used by asText method.
      """
      regex_dict = self._getRegexDict(index=telephone_country)
      notation = regex_dict.get('notation')
      return notation