classes/address.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2014 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 /** Class Address is meant to perform most of the access to the table profile_addresses.
  23  *
  24  * profile_addresses describes an Address, which can be related to either a
  25  * Profile, a Job or a Company:
  26  * - for a Profile:
  27  *   - `type` is set to 'home'
  28  *   - `pid` is set to the related profile pid (in profiles)
  29  *   - `id` is the id of the address in the list of those related to that profile
  30  *   - `jobid` is set to 0
  31  *
  32  * - for a Company:
  33  *   - `type` is set to 'hq'
  34  *   - `pid` is set to 0
  35  *   - `jobid` is set to the id of the company (in profile_job_enum)
  36  *   - `id` is set to 0 (only one address per Company)
  37  *
  38  * - for a Job:
  39  *   - `type` is set to 'job'
  40  *   - `pid` is set to the pid of the Profile of the related Job (in both profiles and profile_job)
  41  *   - `id` is the id of the job to which we refer (in profile_job)
  42  *   - `jobid` is set to 0
  43  *
  44  * - for a Group:
  45  *  - `type` is set to 'group'
  46  *  - `pid` is set to 0
  47  *  - `jobid` is set to 0
  48  *  - `groupid` is set to the group id
  49  *
  50  * Thus an Address can be linked to a Company, a Profile, or a Job.
  51  */
  52 class Address
  53 {
  54     const LINK_JOB     = 'job';
  55     const LINK_COMPANY = 'hq';
  56     const LINK_PROFILE = 'home';
  57     const LINK_GROUP   = 'group';
  58
  59     // List of all available postal formattings.
  60     private static $formattings = array('FRANCE' => 'FR');
  61
  62     // Abbreviations to be used to format French postal addresses.
  63     private static $streetAbbreviations = array(
  64         'ALLEE'                        => 'ALL',
  65         'AVENUE'                       => 'AV',
  66         'BOULEVARD'                    => 'BD',
  67         'CENTRE'                       => 'CTRE',
  68         'CENTRE COMMERCIAL'            => 'CCAL',
  69         'IMMEUBLE'                     => 'IMM',
  70         'IMMEUBLES'                    => 'IMM',
  71         'IMPASSE'                      => 'IMP',
  72         'LIEU-DIT'                     => 'LD',
  73         'LOTISSEMENT'                  => 'LOT',
  74         'PASSAGE'                      => 'PAS',
  75         'PLACE'                        => 'PL',
  76         'RESIDENCE'                    => 'RES',
  77         'ROND-POINT'                   => 'RPT',
  78         'ROUTE'                        => 'RTE',
  79         'SQUARE'                       => 'SQ',
  80         'VILLAGE'                      => 'VLGE',
  81         'ZONE D\'ACTIVITE'             => 'ZA',
  82         'ZONE D\'AMENAGEMENT CONCERTE' => 'ZAC',
  83         'ZONE D\'AMENAGEMENT DIFFERE'  => 'ZAD',
  84         'ZONE INDUSTRIELLE'            => 'ZI'
  85     );
  86     private static $otherAbbreviations = array(
  87         'ADJUDANT'               => 'ADJ',
  88         'AERODROME'              => 'AERD',
  89         'AEROGARE'               => 'AERG',
  90         'AERONAUTIQUE'           => 'AERN',
  91         'AEROPORT'               => 'AERP',
  92         'AGENCE'                 => 'AGCE',
  93         'AGRICOLE'               => 'AGRIC',
  94         'ANCIEN'                 => 'ANC',
  95         'ANCIENNEMENT'           => 'ANC',
  96         'APPARTEMENT'            => 'APP',
  97         'APPARTEMENTS'           => 'APP',
  98         'ARMEMENT'               => 'ARMT',
  99         'ARRONDISSEMENT'         => 'ARR',
 100         'ASPIRANT'               => 'ASP',
 101         'ASSOCIATION'            => 'ASSOC',
 102         'ASSURANCE'              => 'ASSUR',
 103         'ATELIER'                => 'AT',
 104         'BARAQUEMENT'            => 'BRQ',
 105         'BAS'                    => 'BAS',
 106         'BASSE'                  => 'BAS',
 107         'BASSES'                 => 'BAS',
 108         'BATAILLON'              => 'BTN',
 109         'BATAILLONS'             => 'BTN',
 110         'BATIMENT'               => 'BAT',
 111         'BATIMENTS'              => 'BAT',
 112         'BIS'                    => 'B',
 113         'BOITE POSTALE'          => 'BP',
 114         'CABINET'                => 'CAB',
 115         'CANTON'                 => 'CANT',
 116         'CARDINAL'               => 'CDL',
 117         'CASE POSTALE'           => 'CP',
 118         'CHAMBRE'                => 'CHBR',
 119         'CITADELLE'              => 'CTD',
 120         'COLLEGE'                => 'COLL',
 121         'COLONEL'                => 'CNL',
 122         'COLONIE'                => 'COLO',
 123         'COMITE'                 => 'CTE',
 124         'COMMANDANT'             => 'CDT',
 125         'COMMERCIAL'             => 'CIAL',
 126         'COMMUNE'                => 'COM',
 127         'COMMUNAL'               => 'COM',
 128         'COMMUNAUX'              => 'COM',
 129         'COMPAGNIE'              => 'CIE',
 130         'COMPAGNON'              => 'COMP',
 131         'COMPAGNONS'             => 'COMP',
 132         'COOPERATIVE'            => 'COOP',
 133         'COURSE SPECIALE'        => 'CS',
 134         'CROIX'                  => 'CRX',
 135         'DELEGATION'             => 'DELEG',
 136         'DEPARTEMENTAL'          => 'DEP',
 137         'DEPARTEMENTAUX'         => 'DEP',
 138         'DIRECTEUR'              => 'DIR',
 139         'DIRECTECTION'           => 'DIR',
 140         'DIVISION'               => 'DIV',
 141         'DOCTEUR'                => 'DR',
 142         'ECONOMIE'               => 'ECO',
 143         'ECONOMIQUE'             => 'ECO',
 144         'ECRIVAIN'               => 'ECRIV',
 145         'ECRIVAINS'              => 'ECRIV',
 146         'ENSEIGNEMENT'           => 'ENST',
 147         'ENSEMBLE'               => 'ENS',
 148         'ENTREE'                 => 'ENT',
 149         'ENTREES'                => 'ENT',
 150         'ENTREPRISE'             => 'ENTR',
 151         'EPOUX'                  => 'EP',
 152         'EPOUSE'                 => 'EP',
 153         'ETABLISSEMENT'          => 'ETS',
 154         'ETAGE'                  => 'ETG',
 155         'ETAT MAJOR'             => 'EM',
 156         'EVEQUE'                 => 'EVQ',
 157         'FACULTE'                => 'FAC',
 158         'FORET'                  => 'FOR',
 159         'FORESTIER'              => 'FOR',
 160         'FRANCAIS'               => 'FR',
 161         'FRANCAISE'              => 'FR',
 162         'FUSILIER'               => 'FUS',
 163         'GENDARMERIE'            => 'GEND',
 164         'GENERAL'                => 'GAL',
 165         'GOUVERNEMENTAL'         => 'GOUV',
 166         'GOUVERNEUR'             => 'GOU',
 167         'GRAND'                  => 'GD',
 168         'GRANDE'                 => 'GDE',
 169         'GRANDES'                => 'GDES',
 170         'GRANDS'                 => 'GDS',
 171         'HAUT'                   => 'HT',
 172         'HAUTE'                  => 'HTE',
 173         'HAUTES'                 => 'HTES',
 174         'HAUTS'                  => 'HTS',
 175         'HOPITAL'                => 'HOP',
 176         'HOPITAUX'               => 'HOP',
 177         'HOSPICE'                => 'HOSP',
 178         'HOSPITALIER'            => 'HOSP',
 179         'HOTEL'                  => 'HOT',
 180         'INFANTERIE'             => 'INFANT',
 181         'INFERIEUR'              => 'INF',
 182         'INFERIEUR'              => 'INF',
 183         'INGENIEUR'              => 'ING',
 184         'INSPECTEUR'             => 'INSP',
 185         'INSTITUT'               => 'INST',
 186         'INTERNATIONAL'          => 'INTERN',
 187         'INTERNATIONALE'         => 'INTERN',
 188         'LABORATOIRE'            => 'LABO',
 189         'LIEUTENANT'             => 'LT',
 190         'LIEUTENANT DE VAISSEAU' => 'LTDV',
 191         'MADAME'                 => 'MME',
 192         'MADEMOISELLE'           => 'MLLE',
 193         'MAGASIN'                => 'MAG',
 194         'MAISON'                 => 'MAIS',
 195         'MAITRE'                 => 'ME',
 196         'MARECHAL'               => 'MAL',
 197         'MARITIME'               => 'MAR',
 198         'MEDECIN'                => 'MED',
 199         'MEDICAL'                => 'MED',
 200         'MESDAMES'               => 'MMES',
 201         'MESDEMOISELLES'         => 'MLLES',
 202         'MESSIEURS'              => 'MM',
 203         'MILITAIRE'              => 'MIL',
 204         'MINISTERE'              => 'MIN',
 205         'MONSEIGNEUR'            => 'MGR',
 206         'MONSIEUR'               => 'M',
 207         'MUNICIPAL'              => 'MUN',
 208         'MUTUEL'                 => 'MUT',
 209         'NATIONAL'               => 'NAL',
 210         'NOTRE DAME'             => 'ND',
 211         'NOUVEAU'                => 'NOUV',
 212         'NOUVEL'                 => 'NOUV',
 213         'NOUVELLE'               => 'NOUV',
 214         'OBSERVATOIRE'           => 'OBS',
 215         'PASTEUR'                => 'PAST',
 216         'PETIT'                  => 'PT',
 217         'PETITE'                 => 'PTE',
 218         'PETITES'                => 'PTES',
 219         'PETITS'                 => 'PTS',
 220         'POLICE'                 => 'POL',
 221         'PREFET'                 => 'PREF',
 222         'PREFECTURE'             => 'PREF',
 223         'PRESIDENT'              => 'PDT',
 224         'PROFESSEUR'             => 'PR',
 225         'PROFESSIONNEL'          => 'PROF',
 226         'PROFESSIONNELE'         => 'PROF',
 227         'PROLONGE'               => 'PROL',
 228         'PROLONGEE'              => 'PROL',
 229         'PROPRIETE'              => 'PROP',
 230         'QUATER'                 => 'Q',
 231         'QUINQUIES'              => 'C',
 232         'RECTEUR'                => 'RECT',
 233         'REGIMENT'               => 'RGT',
 234         'REGION'                 => 'REG',
 235         'REGIONAL'               => 'REG',
 236         'REGIONALE'              => 'REG',
 237         'REPUBLIQUE'             => 'REP',
 238         'RESTAURANT'             => 'REST',
 239         'SAINT'                  => 'ST',
 240         'SAINTE'                 => 'STE',
 241         'SAINTES'                => 'STES',
 242         'SAINTS'                 => 'STS',
 243         'SANATORIUM'             => 'SANA',
 244         'SERGENT'                => 'SGT',
 245         'SERVICE'                => 'SCE',
 246         'SOCIETE'                => 'SOC',
 247         'SOUS COUVERT'           => 'SC',
 248         'SOUS-PREFET'            => 'SPREF',
 249         'SUPERIEUR'              => 'SUP',
 250         'SUPERIEURE'             => 'SUP',
 251         'SYNDICAT'               => 'SYND',
 252         'TECHNICIEN'             => 'TECH',
 253         'TECHNICIENNE'           => 'TECH',
 254         'TECHNICIQUE'            => 'TECH',
 255         'TER'                    => 'T',
 256         'TRI SERVICE ARRIVEE'    => 'TSA',
 257         'TUNNEL'                 => 'TUN',
 258         'UNIVERSITAIRE'          => 'UNVT',
 259         'UNIVERSITE'             => 'UNIV',
 260         'VELODROME'              => 'VELOD',
 261         'VEUVE'                  => 'VVE',
 262         'VIEILLE'                => 'VIEL',
 263         'VIEILLES'               => 'VIEL',
 264         'VIEUX'                  => 'VX'
 265     );
 266     private static $entrepriseAbbreviations = array(
 267         'COOPERATIVE D\'UTILISATION DE MATERIEL AGRICOLE EN COMMUN' => 'CUMA',
 268         'ETABLISSEMENT PUBLIC A CARACTERE INDUSTRIEL ET COMMERCIAL' => 'EPIC',
 269         'ETABLISSEMENT PUBLIC ADMINISTRATIF'                        => 'EPA',
 270         'GROUPEMENT AGRICOLE D\'EXPLOITATION EN COMMUN'             => 'GAEC',
 271         'GROUPEMENT D\'INTERET ECONOMIQUE'                          => 'GIE',
 272         'GROUPEMENT D\'INTERET PUBLIC'                              => 'GIP',
 273         'GROUPEMENT EUROPEEN D\'INTERET ECONOMIQUE'                 => 'GEIE',
 274         'OFFICE PUBLIC D\'HABITATION A LOYER MODERE'                => 'OPHLM',
 275         'SOCIETE A RESPONSABILITE LIMITEE'                          => 'SARL',
 276         'SOCIETE ANONYME'                                           => 'SA',
 277         'SOCIETE CIVILE DE PLACEMENT COLLECTIF IMMOBILIER'          => 'SCPI',
 278         'SOCIETE CIVILE PROFESSIONNELLE'                            => 'SCP',
 279         'SOCIETE COOPERATIVE OUVRIERE DE PRODUCTION ET DE CREDIT'   => 'SCOP',
 280         'SOCIETE D\'AMENAGEMENT FONCIER ET D\'EQUIPEMENT RURAL'     => 'SAFER',
 281         'SOCIETE D\'ECONOMIE MIXTE'                                 => 'SEM',
 282         'SOCIETE D\'INTERET COLLECTIF AGRICOLE'                     => 'SICA',
 283         'SOCIETE D\'INVESTISSEMENT A CAPITAL VARIABLE'              => 'SICAV',
 284         'SOCIETE EN NOM COLLECTIF'                                  => 'SNC',
 285         'SOCIETE IMMOBILIERE POUR LE COMMERCE ET L\'INDUSTRIE'      => 'SICOMI',
 286         'SOCIETE MIXTE D\'INTERET AGRICOLE'                         => 'SMIA',
 287         'SYNDICAT INTERCOMMUNAL A VOCATION MULTIPLE'                => 'SIVOM',
 288         'SYNDICAT INTERCOMMUNAL A VOCATION UNIQUE'                  => 'SIVU'
 289     );
 290
 291     // Primary key fields: the quadruplet ($pid, $jobid, $type, $id) defines a unique address.
 292     public $pid = 0;
 293     public $jobid = 0;
 294     public $groupid = 0;
 295     public $type = Address::LINK_PROFILE;
 296     public $id = 0;
 297
 298     // Geocoding fields.
 299     public $text = '';
 300     public $postalText = '';
 301     public $postal_code_fr = null;
 302     public $types = '';
 303     public $formatted_address = '';
 304     public $components = array();
 305     public $latitude = null;
 306     public $longitude = null;
 307     public $southwest_latitude = null;
 308     public $southwest_longitude = null;
 309     public $northeast_latitude = null;
 310     public $northeast_longitude = null;
 311     public $location_type = '';
 312     public $partial_match = false;
 313     public $componentsIds = '';
 314     public $request = false;
 315     public $geocoding_date = null;
 316     public $geocoding_calls = 0;
 317
 318     // Database's field required for both 'home' and 'job' addresses.
 319     public $pub = 'ax';
 320
 321     // Database's fields required for 'home' addresses.
 322     public $flags = null; // 'current', 'temporary', 'secondary', 'mail', 'cedex', 'deliveryIssue'
 323     public $comment = null;
 324     public $current = null;
 325     public $temporary = null;
 326     public $secondary = null;
 327     public $mail = null;
 328     public $deliveryIssue = null;
 329
 330     // Remaining fields that do not belong to profile_addresses.
 331     public $phones = array();
 332     public $error = false;
 333     public $changed = 0;
 334     public $removed = 0;
 335
 336     public function __construct(array $data = array())
 337     {
 338         if (count($data) > 0) {
 339             foreach ($data as $key => $val) {
 340                 $this->$key = $val;
 341             }
 342         }
 343
 344         if (!is_null($this->flags)) {
 345             $this->flags = new PlFlagSet($this->flags);
 346         } else {
 347             static $flags = array('current', 'temporary', 'secondary', 'mail', 'deliveryIssue');
 348
 349             $this->flags = new PlFlagSet();
 350             foreach ($flags as $flag) {
 351                 if (!is_null($this->$flag) && ($this->$flag == 1 || $this->$flag == 'on')) {
 352                     $this->flags->addFlag($flag, 1);
 353                     $this->$flag = null;
 354                 }
 355                 $this->flags->addFlag('cedex', (strpos(strtoupper(preg_replace(array("/[0-9,\"'#~:;_\- ]/", "/\r\n/"),
 356                                                                                array('', "\n"), $this->text)), 'CEDEX')) !== false);
 357             }
 358         }
 359         $this->request = ($this->request || !is_null(AddressReq::get_request($this->pid, $this->jobid, $this->groupid, $this->type, $this->id)));
 360     }
 361
 362     public function setId($id)
 363     {
 364         $this->id = $id;
 365     }
 366
 367     public function phones()
 368     {
 369         return $this->phones;
 370     }
 371
 372     public function addPhone(Phone $phone)
 373     {
 374         if ($phone->link_type == Phone::LINK_ADDRESS && $phone->pid == $this->pid) {
 375             $this->phones[$phone->uniqueId()] = $phone;
 376         }
 377     }
 378
 379     public function hasFlag($flag)
 380     {
 381         return ($this->flags != null && $this->flags->hasFlag($flag));
 382     }
 383
 384     public function addFlag($flag)
 385     {
 386         $this->flags->addFlag($flag);
 387     }
 388
 389     /** Auxilary function for formatting postal addresses.
 390      * If the needle is found in the haystack, it notifies the substitution's
 391      * success, modifies the length accordingly and returns either the matching
 392      * substitution or the needle.
 393      */
 394     private function substitute($needle, $haystack, &$length, &$success, $trim = false)
 395     {
 396         if (array_key_exists($needle, $haystack)) {
 397             $success = true;
 398             $length -= (strlen($needle) - strlen($haystack[$needle]));
 399             return $haystack[$needle];
 400         } elseif ($trim) {
 401             $success = true;
 402             if (strlen($needle) > 4) {
 403                 $length -= (strlen($needle) - 4);
 404                 $needle = $needle{4};
 405             }
 406         }
 407         return $needle;
 408     }
 409
 410     /** Checks if the line corresponds to a French street line.
 411      * A line is considered a French street line if it starts by between 1 and 4 numbers.
 412      */
 413     private function isStreetFR($line)
 414     {
 415         return preg_match('/^\d{1,4}\D/', $line);
 416     }
 417
 418     /** Retrieves a French street number and slit the rest of the line into an array.
 419      * @param $words: array containing the rest of the line (a word per cell).
 420      * @param $line: line to consider.
 421      * Returns the street number.
 422      */
 423     private function getStreetNumberFR(&$line)
 424     {
 425         // First we define numbers and separators.
 426         $numberReq = '(\d{1,4})\s*(BIS|TER|QUATER|[A-Z])?';
 427         $separatorReq = '\s*(?:\\\\|\/|-|&|A|ET)?\s*';
 428
 429         // Then we retrieve the number(s) and the rest of the line.
 430         // $matches contains:
 431         //  -0: the full patern, here the given line,
 432         //  -1: the number,
 433         //  -2: its optionnal quantifier,
 434         //  -3: an optionnal second number,
 435         //  -4: the second number's optionnal quantifier,
 436         //  -5: the rest of the line.
 437         preg_match('/^' . $numberReq . '(?:' . $separatorReq . $numberReq . ')?\s+(.*)/', $line, $matches);
 438         $number = $matches[1];
 439         $line = $matches[5];
 440
 441         // If there is a precision on the address, we concatenate it to the number.
 442         if ($matches[2] != '') {
 443             $number .= $matches[2]{0};
 444         } elseif ($matches[4] != '') {
 445             $number .= $matches[4]{0};
 446         }
 447
 448         return $number;
 449     }
 450
 451     /** Checks if the line corresponds to a French locality line.
 452      * A line is considered a French locality line if it starts by exactly a
 453      * postal code of exactly 5 numbers.
 454      */
 455     private function isLocalityFR($line)
 456     {
 457         return preg_match('/^\d{5}\D/', $line);
 458     }
 459
 460     /** Retrieves a French postal code and slit the rest of the line into an array.
 461      * @param $words: array containing the rest of the line (a word per cell).
 462      * @param $line: line to consider.
 463      * Returns the postal code, and cuts it out from the line.
 464      */
 465     private function getPostalCodeFR(&$line)
 466     {
 467         $number = substr($line, 0, 5);
 468         $line = trim(substr($line, 5));
 469         return $number;
 470     }
 471
 472     /** Returns the address formated for French postal use (cf AFNOR XPZ 10-011).
 473      * A postal addresse containts at most 6 lines of at most 38 characters each:
 474      *  - addressee's identification ("MONSIEUR JEAN DURAND", "DURAND SA"…),
 475      *  - delivery point identification ("CHEZ TOTO APPARTEMENT 2", "SERVICE ACHAT"…),
 476      *  - building localisation complement ("ENTREE A BATIMENT DES JONQUILLES", "ZONE INDUSTRIELLE OUEST"…),
 477      *  - N° and street name ("25 RUE DES FLEURS", "LES VIGNES"…),
 478      *  - delivery service, street localisation complement ("BP 40122", "BP 40112 AREYRES"…),
 479      *  - postal code and locality or cedex code and cedex ("33500 LIBOURNE", "33506 LIBOURNE CEDEX"…).
 480      * Punctuation must be removed, all leters must be uppercased.
 481      * Both locality and street name must not take more than 32 characters.
 482      *
 483      * @param $arrayText: array containing the address to be formated, one
 484      * address line per array line.
 485      * @param $count: array size.
 486      */
 487     private function formatPostalAddressFR($arrayText)
 488     {
 489         // First removes country if any.
 490         $count = count($arrayText);
 491         if ($arrayText[$count - 1] == 'FRANCE') {
 492             unset($arrayText[$count - 1]);
 493             --$count;
 494         }
 495
 496         $postal_code = null;
 497         // All the lines must have less than 38 characters but street and
 498         // locality lines whose limit is 32 characters.
 499         foreach ($arrayText as $lineNumber => $line) {
 500             if ($isStreetLine = $this->isStreetFR($line)) {
 501                 $formattedLine = $this->getStreetNumberFR($line) . ' ';
 502                 $limit = 32;
 503             } elseif ($this->isLocalityFR($line)) {
 504                 $postal_code = $this->getPostalCodeFR($line);
 505                 $formattedLine = $postal_code . ' ';
 506                 $limit = 32;
 507             } else {
 508                 $formattedLine = '';
 509                 $limit = 38;
 510             }
 511
 512             $words = explode(' ', $line);
 513             $count = count($words);
 514             $length = $count - 1;
 515             foreach ($words as $word) {
 516                 $length += strlen($word);
 517             }
 518
 519             // Checks is length is ok. Otherwise, we try to shorten words and
 520             // update the length of the current line accordingly.
 521             for ($i = 0; $i < $count && $length > $limit; ++$i) {
 522                 $success = false;
 523                 if ($isStreetLine) {
 524                     $sub = $this->substitute($words[$i], Address::$streetAbbreviations, $length, $success, ($i == 0));
 525                 }
 526                 // Entreprises' substitution are only suitable for the first two lines.
 527                 if ($lineNumber <= 2 && !$success) {
 528                     $sub = $this->substitute($words[$i], Address::$entrepriseAbbreviations, $length, $success);
 529                 }
 530                 if (!$success) {
 531                     $sub = $this->substitute($words[$i], Address::$otherAbbreviations, $length, $success);
 532                 }
 533
 534                 $formattedLine .= $sub . ' ';
 535             }
 536             for (; $i < $count; ++$i) {
 537                 $formattedLine .= $words[$i] . ' ';
 538             }
 539             $arrayText[$lineNumber] = trim($formattedLine);
 540         }
 541
 542         $this->postal_code_fr = $postal_code;
 543         return implode("\n", $arrayText);
 544     }
 545
 546     // Formats postal addresses.
 547     // First erases punctuation, accents… Then uppercase the address and finally
 548     // calls the country's dedicated formatting function.
 549     public function formatPostalAddress()
 550     {
 551         // Performs rough formatting.
 552         $text = mb_strtoupper(replace_accent($this->text));
 553         $text = str_replace(array(',', ';', '.', ':', '!', '?', '"', '«', '»'), '', $text);
 554         $text = preg_replace('/( |\t)+/', ' ', $text);
 555         $arrayText = explode("\n", $text);
 556         $arrayText = array_map('trim', $arrayText);
 557
 558         // Formats according to country rules. Thus we first identify the
 559         // country, then apply corresponding formatting or translate country
 560         // into default language.
 561         $count = count($arrayText);
 562         list($countryId, $country) = XDB::fetchOneRow('SELECT  gc.iso_3166_1_a2, gc.country
 563                                                          FROM  geoloc_countries AS gc
 564                                                    INNER JOIN  geoloc_languages AS gl ON (gc.iso_3166_1_a2 = gl.iso_3166_1_a2)
 565                                                         WHERE  gl.countryPlain = {?} OR gc.countryPlain = {?}',
 566                                                       $arrayText[$count - 1], $arrayText[$count - 1]);
 567         if (is_null($countryId)) {
 568             $text = $this->formatPostalAddressFR($arrayText);
 569         } elseif (in_array(strtoupper($countryId), Address::$formattings)) {
 570             $text = call_user_func(array($this, 'formatPostalAddress' . strtoupper($countryId)), $arrayText);
 571         } else {
 572             $arrayText[$count - 1] = mb_strtoupper(replace_accent($country));
 573             $text = implode("\n", $arrayText);
 574         }
 575
 576         $this->postalText = $text;
 577     }
 578
 579     public function format()
 580     {
 581         $this->text = trim($this->text);
 582         $this->phones = Phone::formatFormArray($this->phones, $this->error, $this->pub);
 583         if ($this->removed == 1) {
 584             if (!S::user()->checkPerms('directory_private') && Phone::hasPrivate($this->phones)) {
 585                 Platal::page()->trigWarning("L'adresse ne peut être supprimée car elle contient des informations pour lesquelles vous n'avez le droit d'édition.");
 586             } else  {
 587                 $this->text = '';
 588                 return true;
 589             }
 590         }
 591
 592         $this->formatPostalAddress();
 593         if ($this->changed == 1) {
 594             $gmapsGeocoder = new GMapsGeocoder();
 595             $gmapsGeocoder->getGeocodedAddress($this);
 596
 597             $componants = array();
 598             foreach ($this->components as $component) {
 599                 $componants[] = Geocoder::getComponentId($component);
 600             }
 601             $this->componentsIds = implode(',', $componants);
 602         }
 603         if ($this->componentsIds == '') {
 604             $this->latitude = null;
 605             $this->longitude = null;
 606         }
 607
 608         return true;
 609     }
 610
 611     public function toFormArray()
 612     {
 613         $address = array(
 614             'text'                => $this->text,
 615             'postalText'          => $this->postalText,
 616             'types'               => $this->types,
 617             'formatted_address'   => $this->formatted_address,
 618             'latitude'            => $this->latitude,
 619             'longitude'           => $this->longitude,
 620             'southwest_latitude'  => $this->southwest_latitude,
 621             'southwest_longitude' => $this->southwest_longitude,
 622             'northeast_latitude'  => $this->northeast_latitude,
 623             'northeast_longitude' => $this->northeast_longitude,
 624             'location_type'       => $this->location_type,
 625             'partial_match'       => $this->partial_match,
 626             'componentsIds'       => $this->componentsIds,
 627             'geocoding_date'      => $this->geocoding_date,
 628             'geocoding_calls'     => $this->geocoding_calls,
 629             'request'             => $this->request
 630         );
 631
 632         if ($this->type == self::LINK_JOB) {
 633             $address['pub']  = $this->pub;
 634             $address['mail'] = $this->flags->hasFlag('mail');
 635         }
 636         if ($this->type == self::LINK_PROFILE) {
 637             static $flags = array('current', 'temporary', 'secondary', 'mail', 'cedex', 'deliveryIssue');
 638             foreach ($flags as $flag) {
 639                 $address[$flag] = $this->flags->hasFlag($flag);
 640             }
 641             $address['pub']     = $this->pub;
 642             $address['comment'] = $this->comment;
 643             $address['phones']  = Phone::formatFormArray($this->phones);
 644         }
 645
 646         return $address;
 647     }
 648
 649     private function toString()
 650     {
 651         $address = $this->text;
 652         if ($this->type == self::LINK_PROFILE || $this->type == self::LINK_JOB) {
 653             static $pubs = array('public' => 'publique', 'ax' => 'annuaire papier', 'private' => 'privé', 'hidden' => 'administrateurs');
 654             $address .= ' (affichage ' . $pubs[$this->pub];
 655         }
 656         if ($this->type == self::LINK_PROFILE) {
 657             static $flags = array(
 658                 'current'       => 'actuelle',
 659                 'temporary'     => 'temporaire',
 660                 'secondary'     => 'secondaire',
 661                 'mail'          => 'conctactable par courier',
 662                 'deliveryIssue' => 'n\'habite pas à l\'adresse indiquée',
 663                 'cedex'         => 'type cédex',
 664             );
 665
 666             if (!$this->flags->hasFlag('temporary')) {
 667                 $address .= ', permanente';
 668             }
 669             if (!$this->flags->hasFlag('secondary')) {
 670                 $address .= ', principale';
 671             }
 672             foreach ($flags as $flag => $flagName) {
 673                 if ($this->flags->hasFlag($flag)) {
 674                     $address .= ', ' . $flagName;
 675                 }
 676             }
 677             if ($this->comment) {
 678                 $address .= ', commentaire : ' . $this->comment;
 679             }
 680             if ($phones = Phone::formArrayToString($this->phones)) {
 681                 $address .= ', ' . $phones;
 682             }
 683         } elseif ($this->type == self::LINK_JOB) {
 684             $address .= ')';
 685         }
 686         return $address;
 687     }
 688
 689     private function isEmpty()
 690     {
 691         return (!$this->text || $this->text == '');
 692     }
 693
 694     public function save($notify_ungeocoded = true)
 695     {
 696         if (!$this->isEmpty()) {
 697             XDB::execute('INSERT IGNORE INTO  profile_addresses (pid, jobid, groupid, type, id, flags, text, postalText, pub, comment,
 698                                                                  types, formatted_address, location_type, partial_match, latitude, longitude,
 699                                                                  southwest_latitude, southwest_longitude, northeast_latitude, northeast_longitude,
 700                                                                  geocoding_date, geocoding_calls, postal_code_fr)
 701                                       VALUES  ({?}, {?}, {?}, {?}, {?}, {?}, {?}, {?}, {?}, {?},
 702                                                {?}, {?}, {?}, {?}, {?}, {?}, {?}, {?}, {?}, {?}, NOW(), {?}, {?})',
 703                          $this->pid, $this->jobid, $this->groupid, $this->type, $this->id, $this->flags, $this->text, $this->postalText, $this->pub, $this->comment,
 704                          $this->types, $this->formatted_address, $this->location_type, $this->partial_match, $this->latitude, $this->longitude,
 705                          $this->southwest_latitude, $this->southwest_longitude, $this->northeast_latitude, $this->northeast_longitude, $this->geocoding_calls, $this->postal_code_fr);
 706
 707             // In an ideal world there would not be any components to clean up before insertion.
 708             // In real world, it happens that some addresses are badly removed and this query removes the leaked trash.
 709             XDB::execute('DELETE FROM  profile_addresses_components
 710                                 WHERE  pid = {?} AND jobid = {?} AND groupid = {?} AND type = {?} AND id = {?}',
 711                          $this->pid, $this->jobid, $this->groupid, $this->type, $this->id);
 712             if ($this->componentsIds) {
 713                 foreach (explode(',', $this->componentsIds) as $component_id) {
 714                     XDB::execute('INSERT IGNORE INTO  profile_addresses_components (pid, jobid, groupid, type, id, component_id)
 715                                               VALUES  ({?}, {?}, {?}, {?}, {?}, {?})',
 716                                  $this->pid, $this->jobid, $this->groupid, $this->type, $this->id, $component_id);
 717                 }
 718             } elseif ($notify_ungeocoded) {
 719                 // If the address was not geocoded, notifies it to the appropriate ML.
 720                 $mailer = new PlMailer('profile/no_geocoding.mail.tpl');
 721                 $mailer->assign('text', $this->text);
 722                 $mailer->assign('primary_key', $this->pid . '-' . $this->jobid . '-' . $this->groupid . '-' . $this->type . '-' . $this->id);
 723                 $mailer->send();
 724             }
 725
 726             if ($this->type == self::LINK_PROFILE) {
 727                 Phone::savePhones($this->phones, $this->pid, Phone::LINK_ADDRESS, $this->id);
 728             }
 729
 730             if ($this->request) {
 731                 $req = new AddressReq(S::user(), $this->toFormArray(), $this->pid, $this->jobid, $this->groupid, $this->type, $this->id);
 732                 $req->submit();
 733             }
 734
 735             if ($this->pid != 0) {
 736                 self::updateBestMail($this->pid);
 737             }
 738         }
 739     }
 740
 741     /**
 742      * Upate the denormalized flag which is used to mark the best mail to use
 743      * when sending postal mail
 744      *
 745      * Call with $fake to true to only get which address would be selected,
 746      * without updating anything in the database.
 747      * Returns an array describing the selected profile address
 748      */
 749     static public function updateBestMail($pid, $fake=false)
 750     {
 751         if (!$fake) {
 752             XDB::execute("UPDATE  profile_addresses
 753                              SET  flags = REPLACE(flags, 'dn_best_mail', '')
 754                            WHERE  pid = {?}",
 755                          $pid);
 756         }
 757
 758         /* Following order is selected to find the best mail:
 759          *  * Use addresses without the deliveryIssue flag if possible.
 760          *  * Among these, use addresses flagged as "current".
 761          *  * If there is no such addresses or several ones, prefer those
 762          *    without "secondary" flag.
 763          *  * If there are still several addresses in the selection, try not
 764          *    to select the ones with "job" type.
 765          */
 766         $best_mail = XDB::fetchOneAssoc("SELECT  pid, jobid, groupid, type, id, flags
 767                                          FROM  profile_addresses
 768                                         WHERE  FIND_IN_SET('mail', flags) AND pid = {?}
 769                                      ORDER BY  FIND_IN_SET('deliveryIssue', flags),
 770                                                NOT FIND_IN_SET('current', flags),
 771                                                FIND_IN_SET('secondary', flags), type = 'job'
 772                                         LIMIT  1",
 773                                       $pid);
 774
 775         if (!$fake && $best_mail) {
 776             XDB::execute("UPDATE  profile_addresses
 777                              SET  flags = CONCAT(flags, ',dn_best_mail')
 778                            WHERE  pid = {?} AND jobid = {?} AND groupid = {?} AND type = {?} AND id = {?}",
 779                          $best_mail['pid'], $best_mail['jobid'], $best_mail['groupid'], $best_mail['type'], $best_mail['id']);
 780         }
 781         return $best_mail;
 782     }
 783
 784     public function updateGeocoding()
 785     {
 786         XDB::execute('UPDATE  profile_addresses
 787                          SET  text = {?}, postalText = {?}, types = {?}, formatted_address = {?},
 788                               location_type = {?}, partial_match = {?}, latitude = {?}, longitude = {?},
 789                               southwest_latitude = {?}, southwest_longitude = {?}, northeast_latitude = {?}, northeast_longitude = {?},
 790                               geocoding_date = NOW(), geocoding_calls = {?}
 791                        WHERE  pid = {?} AND jobid = {?} AND groupid = {?} AND type = {?} AND id = {?}',
 792                      $this->text, $this->postalText, $this->types, $this->formatted_address,
 793                      $this->location_type, $this->partial_match, $this->latitude, $this->longitude,
 794                      $this->southwest_latitude, $this->southwest_longitude, $this->northeast_latitude, $this->northeast_longitude, $this->geocoding_calls,
 795                      $this->pid, $this->jobid, $this->groupid, $this->type, $this->id);
 796
 797         XDB::execute('DELETE FROM  profile_addresses_components
 798                             WHERE  pid = {?} AND jobid = {?} AND groupid = {?} AND type = {?} AND id = {?}',
 799                      $this->pid, $this->jobid, $this->groupid, $this->type, $this->id);
 800         if ($this->componentsIds) {
 801             foreach (explode(',', $this->componentsIds) as $component_id) {
 802                 XDB::execute('INSERT IGNORE INTO  profile_addresses_components (pid, jobid, groupid, type, id, component_id)
 803                                           VALUES  ({?}, {?}, {?}, {?}, {?}, {?})',
 804                              $this->pid, $this->jobid, $this->groupid, $this->type, $this->id, $component_id);
 805             }
 806         }
 807     }
 808
 809     public function delete()
 810     {
 811         XDB::execute('DELETE FROM  profile_addresses_components
 812                             WHERE  pid = {?} AND jobid = {?} AND groupid = {?} AND type = {?} AND id = {?}',
 813                      $this->pid, $this->jobid, $this->groupid, $this->type, $this->id);
 814         XDB::execute('DELETE FROM  profile_addresses
 815                             WHERE  pid = {?} AND jobid = {?} AND groupid = {?} AND type = {?} AND id = {?}',
 816                      $this->pid, $this->jobid, $this->groupid, $this->type, $this->id);
 817
 818         return XDB::affectedRows();
 819     }
 820
 821     static public function deleteAddresses($pid, $type, $jobid = null, $groupid = null, $deletePrivate = true)
 822     {
 823         $where = '';
 824         if (!is_null($pid)) {
 825             $where .= XDB::format(' AND pid = {?}', $pid);
 826         }
 827         if (!is_null($jobid)) {
 828             $where .= XDB::format(' AND jobid = {?}', $jobid);
 829         }
 830         if (!is_null($groupid)) {
 831             $where .= XDB::format(' AND groupid = {?}', $groupid);
 832         }
 833         // Prevent buggy callers from accidentally dropping profile_addresses
 834         if (!$where) {
 835             throw new Exception("Unable to delete all addresses of the given type, the request was too generic");
 836         }
 837         XDB::execute('DELETE FROM  profile_addresses
 838                             WHERE  type = {?}' . $where . (($deletePrivate) ? '' : ' AND pub IN (\'public\', \'ax\')'),
 839                      $type);
 840         if ($type == self::LINK_PROFILE) {
 841             Phone::deletePhones($pid, Phone::LINK_ADDRESS, null, $deletePrivate);
 842         }
 843     }
 844
 845     /** Saves addresses into the database.
 846      * @param $data: an array of form formatted addresses.
 847      * @param $pid, $type, $linkid: pid, type and id concerned by the update.
 848      */
 849     static public function saveFromArray(array $data, $pid, $type = self::LINK_PROFILE, $linkid = null, $savePrivate = true)
 850     {
 851         foreach ($data as $id => $value) {
 852             if ($value['pub'] != 'private' || $savePrivate) {
 853                 if (!is_null($linkid)) {
 854                     $value['id'] = $linkid;
 855                 } else {
 856                     $value['id'] = $id;
 857                 }
 858                 if (!is_null($pid)) {
 859                     $value['pid'] = $pid;
 860                 }
 861                 if (!is_null($type)) {
 862                     $value['type'] = $type;
 863                 }
 864                 $address = new Address($value);
 865                 $address->save();
 866             }
 867         }
 868     }
 869
 870     static private function formArrayWalk(array $data, $function, &$success = true, $requiresEmptyAddress = false)
 871     {
 872         $addresses = array();
 873         foreach ($data as $item) {
 874             $address = new Address($item);
 875             $success = ($address->format() && $success);
 876             if (!$address->isEmpty()) {
 877                 $addresses[] = call_user_func(array($address, $function));
 878             }
 879         }
 880         if (count($address) == 0 && $requiresEmptyAddress) {
 881             $address = new Address();
 882             $addresses[] = call_user_func(array($address, $function));
 883         }
 884         return $addresses;
 885     }
 886
 887     // Compares two addresses. First sort by publicity, then place primary
 888     // addresses before secondary addresses.
 889     static private function compare(array $a, array $b)
 890     {
 891         $value = Visibility::comparePublicity($a, $b);
 892         if ($value == 0) {
 893             if ($a['secondary'] != $b['secondary']) {
 894                 $value = $a['secondary'] ? 1 : -1;
 895             }
 896         }
 897         return $value;
 898     }
 899
 900     // Formats an array of form addresses into an array of form formatted addresses.
 901     static public function formatFormArray(array $data, &$success = true)
 902     {
 903         $addresses = self::formArrayWalk($data, 'toFormArray', $success, true);
 904
 905         // Only a single address can be the profile's current address and she must have one.
 906         $hasCurrent = false;
 907         foreach ($addresses as $key => &$address) {
 908             if (isset($address['current']) && $address['current']) {
 909                 if ($hasCurrent) {
 910                     $address['current'] = false;
 911                 } else {
 912                     $hasCurrent = true;
 913                 }
 914             }
 915         }
 916         if (!$hasCurrent && count($value) > 0) {
 917             foreach ($value as &$address) {
 918                 $address['current'] = true;
 919                 break;
 920             }
 921         }
 922
 923         usort($addresses, 'Address::compare');
 924         return $addresses;
 925     }
 926
 927     static public function formArrayToString(array $data)
 928     {
 929         return implode(', ', self::formArrayWalk($data, 'toString'));
 930     }
 931
 932     static public function hasPrivate(array $addresses)
 933     {
 934         foreach ($addresses as $address) {
 935             if ($address['pub'] == 'private') {
 936                 return true;
 937             }
 938         }
 939         return false;
 940     }
 941
 942     static public function iterate(array $pids = array(), array $types = array(),
 943                                    array $jobids = array(), $visibility = null, $where = null)
 944     {
 945         return new AddressIterator($pids, $types, $jobids, $visibility, $where);
 946     }
 947 }
 948
 949 /** Iterator over a set of Addresses
 950  *
 951  * @param $pid, $type, $jobid, $pub
 952  *
 953  * The iterator contains the addresses that correspond to the value stored in
 954  * the parameters' arrays.
 955  */
 956 class AddressIterator implements PlIterator
 957 {
 958     private $dbiter;
 959     private $visibility;
 960
 961     public function __construct(array $pids, array $types, array $jobids, $visibility, $_where)
 962     {
 963         $where = array();
 964         if (!is_null($_where)) {
 965             $where[] = $_where;
 966         }
 967         if (count($pids) != 0) {
 968             $where[] = XDB::format('(pa.pid IN {?})', $pids);
 969         }
 970         if (count($types) != 0) {
 971             $where[] = XDB::format('(pa.type IN {?})', $types);
 972         }
 973         if (count($jobids) != 0) {
 974             $where[] = XDB::format('(pa.jobid IN {?})', $jobids);
 975         }
 976         if ($visibility == null || !($visibility instanceof Visibility)) {
 977             $visibility = Visibility::defaultForRead();
 978         }
 979         $where[] = 'pve.best_display_level+0 <= pa.pub+0';
 980
 981         $sql = 'SELECT  pa.pid, pa.jobid, pa.groupid, pa.type, pa.id, pa.flags, pa.text, pa.postalText, pa.pub, pa.comment,
 982                         pa.types, pa.formatted_address, pa.location_type, pa.partial_match, pa.latitude, pa.longitude,
 983                         pa.southwest_latitude, pa.southwest_longitude, pa.northeast_latitude, pa.northeast_longitude,
 984                         pa.geocoding_date, pa.geocoding_calls,
 985                         GROUP_CONCAT(DISTINCT pc.component_id SEPARATOR \',\') AS componentsIds,
 986                         GROUP_CONCAT(pace1.long_name) AS postalCode, GROUP_CONCAT(pace2.long_name) AS locality,
 987                         GROUP_CONCAT(pace3.long_name) AS administrativeArea, GROUP_CONCAT(pace4.long_name) AS country
 988                   FROM  profile_addresses                 AS pa
 989              LEFT JOIN  profile_addresses_components      AS pc    ON (pa.pid = pc.pid AND pa.jobid = pc.jobid AND pa.groupid = pc.groupid
 990                                                                        AND pa.type = pc.type AND pa.id = pc.id)
 991              LEFT JOIN  profile_addresses_components_enum AS pace1 ON (FIND_IN_SET(\'postal_code\', pace1.types) AND pace1.id = pc.component_id)
 992              LEFT JOIN  profile_addresses_components_enum AS pace2 ON (FIND_IN_SET(\'locality\', pace2.types) AND pace2.id = pc.component_id)
 993              LEFT JOIN  profile_addresses_components_enum AS pace3 ON (FIND_IN_SET(\'administrative_area_level_1\', pace3.types) AND pace3.id = pc.component_id)
 994              LEFT JOIN  profile_addresses_components_enum AS pace4 ON (FIND_IN_SET(\'country\', pace4.types) AND pace4.id = pc.component_id)
 995              LEFT JOIN  profile_visibility_enum AS pve ON (pve.access_level = {?})
 996                  WHERE  ' . implode(' AND ', $where) . '
 997               GROUP BY  pa.pid, pa.jobid, pa.groupid, pa.type, pa.id
 998               ORDER BY  pa.pid, pa.jobid, pa.id';
 999         $this->dbiter = XDB::iterator($sql, $visibility->level());
1000         $this->visibility = $visibility;
1001     }
1002
1003     public function next()
1004     {
1005         if (is_null($this->dbiter)) {
1006             return null;
1007         }
1008         $data = $this->dbiter->next();
1009         if (is_null($data)) {
1010             return null;
1011         }
1012         // Adds phones to addresses.
1013         $it = Phone::iterate(array($data['pid']), array(Phone::LINK_ADDRESS), array($data['id']), $this->visibility);
1014         while ($phone = $it->next()) {
1015             $data['phones'][$phone->id] = $phone->toFormArray();
1016         }
1017         return new Address($data);
1018     }
1019
1020     public function total()
1021     {
1022         return $this->dbiter->total();
1023     }
1024
1025     public function first()
1026     {
1027         return $this->dbiter->first();
1028     }
1029
1030     public function last()
1031     {
1032         return $this->dbiter->last();
1033     }
1034
1035     public function value()
1036     {
1037         return $this->dbiter;
1038     }
1039 }
1040
1041 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
1042 ?>