CRM/Core/BAO/Address.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28 */
  29
  30 /**
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2013
  34  * $Id$
  35  *
  36  */
  37
  38 /**
  39  * This is class to handle address related functions
  40  */
  41 class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
  42
  43   /**
  44    * takes an associative array and creates a address
  45    *
  46    * @param array  $params (reference ) an assoc array of name/value pairs
  47    * @param boolean  $fixAddress   true if you need to fix (format) address values
  48    *                               before inserting in db
  49    *
  50    * @return array $blocks array of created address
  51    * @access public
  52    * @static
  53    */
  54   static function create(&$params, $fixAddress, $entity = NULL) {
  55     if (!isset($params['address']) || !is_array($params['address'])) {
  56       return;
  57     }
  58     CRM_Core_BAO_Block::sortPrimaryFirst($params['address']);
  59     $addresses = array();
  60     $contactId = NULL;
  61
  62     $updateBlankLocInfo = CRM_Utils_Array::value('updateBlankLocInfo', $params, FALSE);
  63     if (!$entity) {
  64       $contactId = $params['contact_id'];
  65       //get all the addresses for this contact
  66       $addresses = self::allAddress($contactId, $updateBlankLocInfo);
  67     }
  68     else {
  69       // get all address from location block
  70       $entityElements = array(
  71         'entity_table' => $params['entity_table'],
  72         'entity_id' => $params['entity_id'],
  73       );
  74       $addresses = self::allEntityAddress($entityElements);
  75     }
  76
  77     $isPrimary = $isBilling = TRUE;
  78     $blocks = array();
  79     foreach ($params['address'] as $key => $value) {
  80       if (!is_array($value)) {
  81         continue;
  82       }
  83
  84       $addressExists = self::dataExists($value);
  85       if ( !CRM_Utils_Array::value('id', $value) ) {
  86         if ($updateBlankLocInfo) {
  87           if ((!empty($addresses) || !$addressExists) && array_key_exists($key, $addresses)) {
  88             $value['id'] = $addresses[$key];
  89           }
  90         }
  91         else {
  92           if (!empty($addresses) && array_key_exists(CRM_Utils_Array::value('location_type_id', $value), $addresses)) {
  93             $value['id'] = $addresses[CRM_Utils_Array::value('location_type_id', $value)];
  94           }
  95         }
  96       }
  97
  98       // Note there could be cases when address info already exist ($value[id] is set) for a contact/entity
  99       // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
 100       // $updateBlankLocInfo will help take appropriate decision. CRM-5969
 101       if (isset($value['id']) && !$addressExists && $updateBlankLocInfo) {
 102         //delete the existing record
 103         CRM_Core_BAO_Block::blockDelete('Address', array('id' => $value['id']));
 104         continue;
 105       }
 106       elseif (!$addressExists) {
 107         continue;
 108       }
 109
 110       if ($isPrimary && CRM_Utils_Array::value('is_primary', $value)) {
 111         $isPrimary = FALSE;
 112       }
 113       else {
 114         $value['is_primary'] = 0;
 115       }
 116
 117       if ($isBilling && CRM_Utils_Array::value('is_billing', $value)) {
 118         $isBilling = FALSE;
 119       }
 120       else {
 121         $value['is_billing'] = 0;
 122       }
 123
 124       if (!CRM_Utils_Array::value('manual_geo_code', $value)) {
 125         $value['manual_geo_code'] = 0;
 126       }
 127       $value['contact_id'] = $contactId;
 128       $blocks[] = self::add($value, $fixAddress);
 129     }
 130
 131     return $blocks;
 132   }
 133
 134   /**
 135    * takes an associative array and adds address
 136    *
 137    * @param array  $params         (reference ) an assoc array of name/value pairs
 138    * @param boolean  $fixAddress   true if you need to fix (format) address values
 139    *                               before inserting in db
 140    *
 141    * @return object       CRM_Core_BAO_Address object on success, null otherwise
 142    * @access public
 143    * @static
 144    */
 145   static function add(&$params, $fixAddress) {
 146     static $customFields = NULL;
 147     $address = new CRM_Core_DAO_Address();
 148
 149     // fixAddress mode to be done
 150     if ($fixAddress) {
 151       CRM_Core_BAO_Address::fixAddress($params);
 152     }
 153
 154     $hook = empty($params['id']) ? 'create' : 'edit';
 155     CRM_Utils_Hook::pre($hook, 'Address', CRM_Utils_Array::value('id', $params), $params);
 156
 157     // if id is set & is_primary isn't we can assume no change
 158     if (is_numeric(CRM_Utils_Array::value('is_primary', $params)) || empty($params['id'])) {
 159       CRM_Core_BAO_Block::handlePrimary($params, get_class());
 160     }
 161     $config = CRM_Core_Config::singleton();
 162     $address->copyValues($params);
 163
 164     $address->save();
 165
 166     if ($address->id) {
 167       if (!$customFields) {
 168         $customFields = CRM_Core_BAO_CustomField::getFields('Address', FALSE, TRUE);
 169       }
 170       if (!empty($customFields)) {
 171         $addressCustom = CRM_Core_BAO_CustomField::postProcess($params,
 172           $customFields,
 173           $address->id,
 174           'Address',
 175           TRUE
 176         );
 177       }
 178       if (!empty($addressCustom)) {
 179         CRM_Core_BAO_CustomValueTable::store($addressCustom, 'civicrm_address', $address->id);
 180       }
 181
 182       //call the function to sync shared address
 183       self::processSharedAddress($address->id, $params);
 184
 185       // call the function to create shared relationships
 186       // we only create create relationship if address is shared by Individual
 187       if ($address->master_id != 'null') {
 188         self::processSharedAddressRelationship($address->master_id, $params);
 189       }
 190
 191       // lets call the post hook only after we've done all the follow on processing
 192       CRM_Utils_Hook::post($hook, 'Address', $address->id, $address);
 193     }
 194
 195     return $address;
 196   }
 197
 198   /**
 199    * format the address params to have reasonable values
 200    *
 201    * @param array  $params         (reference ) an assoc array of name/value pairs
 202    *
 203    * @return void
 204    * @access public
 205    * @static
 206    */
 207   static function fixAddress(&$params) {
 208     if (CRM_Utils_Array::value('billing_street_address', $params)) {
 209       //Check address is comming from online contribution / registration page
 210       //Fixed :CRM-5076
 211       $billing = array(
 212         'street_address' => 'billing_street_address',
 213         'city' => 'billing_city',
 214         'postal_code' => 'billing_postal_code',
 215         'state_province' => 'billing_state_province',
 216         'state_province_id' => 'billing_state_province_id',
 217         'country' => 'billing_country',
 218         'country_id' => 'billing_country_id',
 219       );
 220
 221       foreach ($billing as $key => $val) {
 222         if ($value = CRM_Utils_Array::value($val, $params)) {
 223           if (CRM_Utils_Array::value($key, $params)) {
 224             unset($params[$val]);
 225           }
 226           else {
 227             //add new key and removed old
 228             $params[$key] = $value;
 229             unset($params[$val]);
 230           }
 231         }
 232       }
 233     }
 234
 235     /* Split the zip and +4, if it's in US format */
 236     if (CRM_Utils_Array::value('postal_code', $params) &&
 237       preg_match('/^(\d{4,5})[+-](\d{4})$/',
 238         $params['postal_code'],
 239         $match
 240       )
 241     ) {
 242       $params['postal_code'] = $match[1];
 243       $params['postal_code_suffix'] = $match[2];
 244     }
 245
 246     // add country id if not set
 247     if ((!isset($params['country_id']) || !is_numeric($params['country_id'])) &&
 248       isset($params['country'])
 249     ) {
 250       $country = new CRM_Core_DAO_Country();
 251       $country->name = $params['country'];
 252       if (!$country->find(TRUE)) {
 253         $country->name = NULL;
 254         $country->iso_code = $params['country'];
 255         $country->find(TRUE);
 256       }
 257       $params['country_id'] = $country->id;
 258     }
 259
 260     // add state_id if state is set
 261     if ((!isset($params['state_province_id']) || !is_numeric($params['state_province_id']))
 262       && isset($params['state_province'])
 263     ) {
 264       if (!empty($params['state_province'])) {
 265         $state_province = new CRM_Core_DAO_StateProvince();
 266         $state_province->name = $params['state_province'];
 267
 268         // add country id if present
 269         if (!empty($params['country_id'])) {
 270           $state_province->country_id = $params['country_id'];
 271         }
 272
 273         if (!$state_province->find(TRUE)) {
 274           unset($state_province->name);
 275           $state_province->abbreviation = $params['state_province'];
 276           $state_province->find(TRUE);
 277         }
 278         $params['state_province_id'] = $state_province->id;
 279         if (empty($params['country_id'])) {
 280           // set this here since we have it
 281           $params['country_id'] = $state_province->country_id;
 282         }
 283       }
 284       else {
 285         $params['state_province_id'] = 'null';
 286       }
 287     }
 288
 289     // add county id if county is set
 290     // CRM-7837
 291     if ((!isset($params['county_id']) || !is_numeric($params['county_id']))
 292       && isset($params['county']) && !empty($params['county'])
 293     ) {
 294       $county = new CRM_Core_DAO_County();
 295       $county->name = $params['county'];
 296
 297       if (isset($params['state_province_id'])) {
 298         $county->state_province_id = $params['state_province_id'];
 299       }
 300
 301       if ($county->find(TRUE)) {
 302         $params['county_id'] = $county->id;
 303       }
 304     }
 305
 306     // currently copy values populates empty fields with the string "null"
 307     // and hence need to check for the string null
 308     if (isset($params['state_province_id']) &&
 309       is_numeric($params['state_province_id']) &&
 310       (!isset($params['country_id']) || empty($params['country_id']))
 311     ) {
 312       // since state id present and country id not present, hence lets populate it
 313       // jira issue http://issues.civicrm.org/jira/browse/CRM-56
 314       $params['country_id'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_StateProvince',
 315         $params['state_province_id'],
 316         'country_id'
 317       );
 318     }
 319
 320     //special check to ignore non numeric values if they are not
 321     //detected by formRule(sometimes happens due to internet latency), also allow user to unselect state/country
 322     if (isset($params['state_province_id'])) {
 323       if (empty($params['state_province_id'])) {
 324         $params['state_province_id'] = 'null';
 325       }
 326       elseif (!is_numeric($params['state_province_id']) ||
 327         ((int ) $params['state_province_id'] < 1000)
 328       ) {
 329         // CRM-3393 ( the hacky 1000 check)
 330         $params['state_province_id'] = 'null';
 331       }
 332     }
 333
 334     if (isset($params['country_id'])) {
 335       if (empty($params['country_id'])) {
 336         $params['country_id'] = 'null';
 337       }
 338       elseif (!is_numeric($params['country_id']) ||
 339         ((int ) $params['country_id'] < 1000)
 340       ) {
 341         // CRM-3393 ( the hacky 1000 check)
 342         $params['country_id'] = 'null';
 343       }
 344     }
 345
 346     // add state and country names from the ids
 347     if (isset($params['state_province_id']) && is_numeric($params['state_province_id'])) {
 348       $params['state_province'] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($params['state_province_id']);
 349     }
 350
 351     if (isset($params['country_id']) && is_numeric($params['country_id'])) {
 352       $params['country'] = CRM_Core_PseudoConstant::country($params['country_id']);
 353     }
 354
 355     $config = CRM_Core_Config::singleton();
 356
 357     $asp = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::ADDRESS_STANDARDIZATION_PREFERENCES_NAME,
 358       'address_standardization_provider'
 359     );
 360     // clean up the address via USPS web services if enabled
 361     if ($asp === 'USPS' &&
 362       $params['country_id'] == 1228
 363     ) {
 364       CRM_Utils_Address_USPS::checkAddress($params);
 365
 366       // do street parsing again if enabled, since street address might have changed
 367       $parseStreetAddress = CRM_Utils_Array::value('street_address_parsing',
 368         CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 369           'address_options'
 370         ),
 371         FALSE
 372       );
 373
 374       if ($parseStreetAddress && !empty($params['street_address'])) {
 375         foreach (array(
 376           'street_number', 'street_name', 'street_unit', 'street_number_suffix') as $fld) {
 377           unset($params[$fld]);
 378         }
 379         // main parse string.
 380         $parseString = CRM_Utils_Array::value('street_address', $params);
 381         $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($parseString);
 382
 383         // merge parse address in to main address block.
 384         $params = array_merge($params, $parsedFields);
 385       }
 386     }
 387
 388     // add latitude and longitude and format address if needed
 389     if (!empty($config->geocodeMethod) && ($config->geocodeMethod != 'CRM_Utils_Geocode_OpenStreetMaps') && empty($params['manual_geo_code'])) {
 390       $class = $config->geocodeMethod;
 391       $class::format($params);
 392     }
 393   }
 394
 395   /**
 396    * Check if there is data to create the object
 397    *
 398    * @param array  $params    (reference ) an assoc array of name/value pairs
 399    *
 400    * @return boolean
 401    *
 402    * @access public
 403    * @static
 404    */
 405   static function dataExists(&$params) {
 406     //check if location type is set if not return false
 407     if (!isset($params['location_type_id'])) {
 408       return FALSE;
 409     }
 410
 411     $config = CRM_Core_Config::singleton();
 412     foreach ($params as $name => $value) {
 413       if (in_array($name, array(
 414         'is_primary', 'location_type_id', 'id', 'contact_id', 'is_billing', 'display', 'master_id'))) {
 415         continue;
 416       }
 417       elseif (!CRM_Utils_System::isNull($value)) {
 418         // name could be country or country id
 419         if (substr($name, 0, 7) == 'country') {
 420           // make sure its different from the default country
 421           // iso code
 422           $defaultCountry = $config->defaultContactCountry();
 423           // full name
 424           $defaultCountryName = $config->defaultContactCountryName();
 425
 426           if ($defaultCountry) {
 427             if ($value == $defaultCountry ||
 428               $value == $defaultCountryName ||
 429               $value == $config->defaultContactCountry
 430             ) {
 431               // do nothing
 432             }
 433             else {
 434               return TRUE;
 435             }
 436           }
 437           else {
 438             // return if null default
 439             return TRUE;
 440           }
 441         }
 442         else {
 443           return TRUE;
 444         }
 445       }
 446     }
 447
 448     return FALSE;
 449   }
 450
 451   /**
 452    * Given the list of params in the params array, fetch the object
 453    * and store the values in the values array
 454    *
 455    * @param array   $entityBlock   associated array of fields
 456    * @param boolean $microformat   if microformat output is required
 457    * @param int     $fieldName     conditional field name
 458    *
 459    * @return array  $addresses     array with address fields
 460    * @access public
 461    * @static
 462    */
 463   static function &getValues(&$entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
 464     if (empty($entityBlock)) {
 465       return NULL;
 466     }
 467     $addresses = array();
 468     $address = new CRM_Core_BAO_Address();
 469
 470     if (!CRM_Utils_Array::value('entity_table', $entityBlock)) {
 471       $address->$fieldName = CRM_Utils_Array::value($fieldName, $entityBlock);
 472     }
 473     else {
 474       $addressIds = array();
 475       $addressIds = self::allEntityAddress($entityBlock);
 476
 477       if (!empty($addressIds[1])) {
 478         $address->id = $addressIds[1];
 479       }
 480       else {
 481         return $addresses;
 482       }
 483     }
 484     //get primary address as a first block.
 485     $address->orderBy('is_primary desc, id');
 486
 487     $address->find();
 488
 489     $count = 1;
 490     while ($address->fetch()) {
 491       // deprecate reference.
 492       if ($count > 1) {
 493         foreach (array(
 494           'state', 'state_name', 'country', 'world_region') as $fld) {
 495           if (isset($address->$fld))unset($address->$fld);
 496         }
 497       }
 498       $stree = $address->street_address;
 499       $values = array();
 500       CRM_Core_DAO::storeValues($address, $values);
 501
 502       // add state and country information: CRM-369
 503       if (!empty($address->state_province_id)) {
 504         $address->state = CRM_Core_PseudoConstant::stateProvinceAbbreviation($address->state_province_id, FALSE);
 505         $address->state_name = CRM_Core_PseudoConstant::stateProvince($address->state_province_id, FALSE);
 506       }
 507
 508       if (!empty($address->country_id)) {
 509         $address->country = CRM_Core_PseudoConstant::country($address->country_id);
 510
 511         //get world region
 512         $regionId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Country', $address->country_id, 'region_id');
 513
 514         $address->world_region = CRM_Core_PseudoConstant::worldregion($regionId);
 515       }
 516
 517       $address->addDisplay($microformat);
 518
 519       $values['display'] = $address->display;
 520       $values['display_text'] = $address->display_text;
 521
 522       if (is_numeric($address->master_id)) {
 523         $values['use_shared_address'] = 1;
 524       }
 525
 526       $addresses[$count] = $values;
 527
 528       //unset is_primary after first block. Due to some bug in earlier version
 529       //there might be more than one primary blocks, hence unset is_primary other than first
 530       if ($count > 1) {
 531         unset($addresses[$count]['is_primary']);
 532       }
 533
 534       $count++;
 535     }
 536
 537     return $addresses;
 538   }
 539
 540   /**
 541    * Add the formatted address to $this-> display
 542    *
 543    * @param NULL
 544    *
 545    * @return void
 546    *
 547    * @access public
 548    *
 549    */
 550   function addDisplay($microformat = FALSE) {
 551     $fields = array(
 552       // added this for CRM 1200
 553       'address_id' => $this->id,
 554       // CRM-4003
 555       'address_name' => str_replace('\ 1', ' ', $this->name),
 556       'street_address' => $this->street_address,
 557       'supplemental_address_1' => $this->supplemental_address_1,
 558       'supplemental_address_2' => $this->supplemental_address_2,
 559       'city' => $this->city,
 560       'state_province_name' => isset($this->state_name) ? $this->state_name : "",
 561       'state_province' => isset($this->state) ? $this->state : "",
 562       'postal_code' => isset($this->postal_code) ? $this->postal_code : "",
 563       'postal_code_suffix' => isset($this->postal_code_suffix) ? $this->postal_code_suffix : "",
 564       'country' => isset($this->country) ? $this->country : "",
 565       'world_region' => isset($this->world_region) ? $this->world_region : "",
 566     );
 567
 568     if (isset($this->county_id) && $this->county_id) {
 569       $fields['county'] = CRM_Core_PseudoConstant::county($this->county_id);
 570     }
 571     else {
 572       $fields['county'] = NULL;
 573     }
 574
 575     $this->display = CRM_Utils_Address::format($fields, NULL, $microformat);
 576     $this->display_text = CRM_Utils_Address::format($fields);
 577   }
 578
 579   /**
 580    * Get all the addresses for a specified contact_id, with the primary address being first
 581    *
 582    * @param int $id the contact id
 583    *
 584    * @return array  the array of adrress data
 585    * @access public
 586    * @static
 587    */
 588   static function allAddress($id, $updateBlankLocInfo = FALSE) {
 589     if (!$id) {
 590       return NULL;
 591     }
 592
 593     $query = "
 594 SELECT civicrm_address.id as address_id, civicrm_address.location_type_id as location_type_id
 595 FROM civicrm_contact, civicrm_address
 596 WHERE civicrm_address.contact_id = civicrm_contact.id AND civicrm_contact.id = %1
 597 ORDER BY civicrm_address.is_primary DESC, address_id ASC";
 598     $params = array(1 => array($id, 'Integer'));
 599
 600     $addresses = array();
 601     $dao = CRM_Core_DAO::executeQuery($query, $params);
 602     $count = 1;
 603     while ($dao->fetch()) {
 604       if ($updateBlankLocInfo) {
 605         $addresses[$count++] = $dao->address_id;
 606       }
 607       else {
 608         $addresses[$dao->location_type_id] = $dao->address_id;
 609       }
 610     }
 611     return $addresses;
 612   }
 613
 614   /**
 615    * Get all the addresses for a specified location_block id, with the primary address being first
 616    *
 617    * @param array $entityElements the array containing entity_id and
 618    * entity_table name
 619    *
 620    * @return array  the array of adrress data
 621    * @access public
 622    * @static
 623    */
 624   static function allEntityAddress(&$entityElements) {
 625     if (empty($entityElements)) {
 626       return $addresses;
 627     }
 628
 629     $entityId = $entityElements['entity_id'];
 630     $entityTable = $entityElements['entity_table'];
 631
 632     $sql = "
 633 SELECT civicrm_address.id as address_id
 634 FROM civicrm_loc_block loc, civicrm_location_type ltype, civicrm_address, {$entityTable} ev
 635 WHERE ev.id = %1
 636   AND loc.id = ev.loc_block_id
 637   AND civicrm_address.id IN (loc.address_id, loc.address_2_id)
 638   AND ltype.id = civicrm_address.location_type_id
 639 ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, address_id ASC ";
 640
 641     $params = array(1 => array($entityId, 'Integer'));
 642     $addresses = array();
 643     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 644     $locationCount = 1;
 645     while ($dao->fetch()) {
 646       $addresses[$locationCount] = $dao->address_id;
 647       $locationCount++;
 648     }
 649     return $addresses;
 650   }
 651
 652   static function addStateCountryMap(&$stateCountryMap, $defaults = NULL) {
 653     // first fix the statecountry map if needed
 654     if (empty($stateCountryMap)) {
 655       return;
 656     }
 657
 658     $config = CRM_Core_Config::singleton();
 659     if (!isset($config->stateCountryMap)) {
 660       $config->stateCountryMap = array();
 661     }
 662
 663     $config->stateCountryMap = array_merge($config->stateCountryMap, $stateCountryMap);
 664   }
 665
 666   static function fixAllStateSelects(&$form, $defaults, $batchFieldNames = false) {
 667     $config = CRM_Core_Config::singleton();
 668
 669     $map = null;
 670     if (is_array($batchFieldNames)) {
 671       $map = $batchFieldNames;
 672     }
 673     else if (!empty($config->stateCountryMap)) {
 674       $map = $config->stateCountryMap;
 675     }
 676
 677     if (!empty($map)) {
 678       foreach ($map as $index => $match) {
 679         if (
 680           array_key_exists('state_province', $match) &&
 681           array_key_exists('country', $match)
 682         ) {
 683           CRM_Contact_Form_Edit_Address::fixStateSelect(
 684             $form,
 685             $match['country'],
 686             $match['state_province'],
 687             CRM_Utils_Array::value('county', $match),
 688             CRM_Utils_Array::value($match['country'], $defaults),
 689             CRM_Utils_Array::value($match['state_province'], $defaults)
 690           );
 691         }
 692         else {
 693           unset($config->stateCountryMap[$index]);
 694         }
 695       }
 696     }
 697   }
 698
 699   /**
 700    * Function to get address sequence
 701    *
 702    * @return  array of address sequence.
 703    */
 704   static function addressSequence() {
 705     $config = CRM_Core_Config::singleton();
 706     $addressSequence = $config->addressSequence();
 707
 708     $countryState = $cityPostal = FALSE;
 709     foreach ($addressSequence as $key => $field) {
 710       if (
 711         in_array($field, array('country', 'state_province')) &&
 712         !$countryState
 713       ) {
 714         $countryState = TRUE;
 715         $addressSequence[$key] = 'country_state_province';
 716       }
 717       elseif (
 718         in_array($field, array('city', 'postal_code')) &&
 719         !$cityPostal
 720       ) {
 721         $cityPostal = TRUE;
 722         $addressSequence[$key] = 'city_postal_code';
 723       }
 724       elseif (
 725         in_array($field, array('country', 'state_province', 'city', 'postal_code'))
 726       ) {
 727         unset($addressSequence[$key]);
 728       }
 729     }
 730
 731     return $addressSequence;
 732   }
 733
 734   /**
 735    * Parse given street address string in to street_name,
 736    * street_unit, street_number and street_number_suffix
 737    * eg "54A Excelsior Ave. Apt 1C", or "917 1/2 Elm Street"
 738    *
 739    * NB: civic street formats for en_CA and fr_CA used by default if those locales are active
 740    *     otherwise en_US format is default action
 741    *
 742    * @param  string   Street address including number and apt
 743    * @param  string   Locale - to set locale used to parse address
 744    *
 745    * @return array    $parseFields    parsed fields values.
 746    * @access public
 747    * @static
 748    */
 749   static function parseStreetAddress($streetAddress, $locale = NULL) {
 750     $config = CRM_Core_Config::singleton();
 751
 752     /* locales supported include:
 753      *  en_US - http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf
 754      *  en_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp
 755      *  fr_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-f.asp
 756      *          NB: common use of comma after street number also supported
 757      *  default is en_US
 758      */
 759
 760     $supportedLocalesForParsing = array('en_US', 'en_CA', 'fr_CA');
 761     if (!$locale) {
 762       $locale = $config->lcMessages;
 763     }
 764     // as different locale explicitly requested but is not available, display warning message and set $locale = 'en_US'
 765     if (!in_array($locale, $supportedLocalesForParsing)) {
 766       CRM_Core_Session::setStatus(ts('Unsupported locale specified to parseStreetAddress: %1. Proceeding with en_US locale.', array(1 => $locale)), ts('Unsupported Locale'), 'alert');
 767       $locale = 'en_US';
 768     }
 769     $parseFields = array(
 770       'street_name' => '',
 771       'street_unit' => '',
 772       'street_number' => '',
 773       'street_number_suffix' => '',
 774     );
 775
 776     if (empty($streetAddress)) {
 777       return $parseFields;
 778     }
 779
 780     $streetAddress = trim($streetAddress);
 781
 782     $matches = array();
 783     if (in_array($locale, array(
 784       'en_CA', 'fr_CA')) && preg_match('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', $streetAddress, $matches)) {
 785       $parseFields['street_unit'] = $matches[1];
 786       // unset from rest of street address
 787       $streetAddress = preg_replace('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', '', $streetAddress);
 788     }
 789
 790     // get street number and suffix.
 791     $matches = array();
 792     //alter street number/suffix handling so that we accept -digit
 793     if (preg_match('/^[A-Za-z0-9]+([\S]+)/', $streetAddress, $matches)) {
 794       // check that $matches[0] is numeric, else assume no street number
 795       if (preg_match('/^(\d+)/', $matches[0])) {
 796         $streetNumAndSuffix = $matches[0];
 797
 798         // get street number.
 799         $matches = array();
 800         if (preg_match('/^(\d+)/', $streetNumAndSuffix, $matches)) {
 801           $parseFields['street_number'] = $matches[0];
 802           $suffix = preg_replace('/^(\d+)/', '', $streetNumAndSuffix);
 803           $parseFields['street_number_suffix'] = trim($suffix);
 804         }
 805
 806         // unset from main street address.
 807         $streetAddress = preg_replace('/^[A-Za-z0-9]+([\S]+)/', '', $streetAddress);
 808         $streetAddress = trim($streetAddress);
 809       }
 810     }
 811     elseif (preg_match('/^(\d+)/', $streetAddress, $matches)) {
 812       $parseFields['street_number'] = $matches[0];
 813       // unset from main street address.
 814       $streetAddress = preg_replace('/^(\d+)/', '', $streetAddress);
 815       $streetAddress = trim($streetAddress);
 816     }
 817
 818     // suffix might be like 1/2
 819     $matches = array();
 820     if (preg_match('/^\d\/\d/', $streetAddress, $matches)) {
 821       $parseFields['street_number_suffix'] .= $matches[0];
 822
 823       // unset from main street address.
 824       $streetAddress = preg_replace('/^\d+\/\d+/', '', $streetAddress);
 825       $streetAddress = trim($streetAddress);
 826     }
 827
 828     // now get the street unit.
 829     // supportable street unit formats.
 830     $streetUnitFormats = array(
 831       'APT', 'APARTMENT', 'BSMT', 'BASEMENT', 'BLDG', 'BUILDING',
 832       'DEPT', 'DEPARTMENT', 'FL', 'FLOOR', 'FRNT', 'FRONT',
 833       'HNGR', 'HANGER', 'LBBY', 'LOBBY', 'LOWR', 'LOWER',
 834       'OFC', 'OFFICE', 'PH', 'PENTHOUSE', 'TRLR', 'TRAILER',
 835       'UPPR', 'RM', 'ROOM', 'SIDE', 'SLIP', 'KEY',
 836       'LOT', 'PIER', 'REAR', 'SPC', 'SPACE',
 837       'STOP', 'STE', 'SUITE', 'UNIT', '#',
 838     );
 839
 840     // overwriting $streetUnitFormats for 'en_CA' and 'fr_CA' locale
 841     if (in_array($locale, array(
 842       'en_CA', 'fr_CA'))) {
 843       $streetUnitFormats = array('APT', 'APP', 'SUITE', 'BUREAU', 'UNIT');
 844     }
 845
 846     $streetUnitPreg = '/(' . implode('|\s', $streetUnitFormats) . ')(.+)?/i';
 847     $matches = array();
 848     if (preg_match($streetUnitPreg, $streetAddress, $matches)) {
 849       $parseFields['street_unit'] = trim($matches[0]);
 850       $streetAddress = str_replace($matches[0], '', $streetAddress);
 851       $streetAddress = trim($streetAddress);
 852     }
 853
 854     // consider remaining string as street name.
 855     $parseFields['street_name'] = $streetAddress;
 856
 857     //run parsed fields through stripSpaces to clean
 858     foreach ($parseFields as $parseField => $value) {
 859       $parseFields[$parseField] = CRM_Utils_String::stripSpaces($value);
 860     }
 861
 862     return $parseFields;
 863   }
 864
 865   /**
 866    * Validate the address fields based on the address options enabled
 867    * in the Address Settings
 868    *
 869    * @param  array   $fields an array of importable/exportable contact fields
 870    *
 871    * @return array   $fields an array of contact fields and only the enabled address options
 872    * @access public
 873    * @static
 874    */
 875   static function validateAddressOptions($fields) {
 876     static $addressOptions = NULL;
 877     if (!$addressOptions) {
 878       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 879         'address_options', TRUE, NULL, TRUE
 880       );
 881     }
 882
 883     if (is_array($fields) && !empty($fields)) {
 884       foreach ($addressOptions as $key => $value) {
 885         if (!$value && isset($fields[$key])) {
 886           unset($fields[$key]);
 887         }
 888       }
 889     }
 890     return $fields;
 891   }
 892
 893   /**
 894    * Check if current address is used by any other contacts
 895    *
 896    * @param int $addressId address id
 897    *
 898    * @return count of contacts that use this shared address
 899    * @access public
 900    * @static
 901    */
 902   static function checkContactSharedAddress($addressId) {
 903     $query = 'SELECT count(id) FROM civicrm_address WHERE master_id = %1';
 904     return CRM_Core_DAO::singleValueQuery($query, array(1 => array($addressId, 'Integer')));
 905   }
 906
 907   /**
 908    * Function to check if current address fields are shared with any other address
 909    *
 910    * @param array    $fields    address fields in profile
 911    * @param int      $contactId contact id
 912    *
 913    * @access public
 914    * @static
 915    */
 916   static function checkContactSharedAddressFields(&$fields, $contactId) {
 917     if (!$contactId || !is_array($fields) || empty($fields)) {
 918       return;
 919     }
 920
 921     $sharedLocations = array();
 922
 923     $query = "
 924 SELECT is_primary,
 925        location_type_id
 926   FROM civicrm_address
 927  WHERE contact_id = %1
 928    AND master_id IS NOT NULL";
 929
 930     $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($contactId, 'Positive')));
 931     while ($dao->fetch()) {
 932       $sharedLocations[$dao->location_type_id] = $dao->location_type_id;
 933       if ($dao->is_primary) {
 934         $sharedLocations['Primary'] = 'Primary';
 935       }
 936     }
 937
 938     //no need to process further.
 939     if (empty($sharedLocations)) {
 940       return;
 941     }
 942
 943     $addressFields = array(
 944       'city',
 945       'county',
 946       'country',
 947       'geo_code_1',
 948       'geo_code_2',
 949       'postal_code',
 950       'address_name',
 951       'state_province',
 952       'street_address',
 953       'postal_code_suffix',
 954       'supplemental_address_1',
 955       'supplemental_address_2',
 956     );
 957
 958     foreach ($fields as $name => & $values) {
 959       if (!is_array($values) || empty($values)) {
 960         continue;
 961       }
 962
 963       $nameVal = explode('-', $values['name']);
 964       $fldName = CRM_Utils_Array::value(0, $nameVal);
 965       $locType = CRM_Utils_Array::value(1, $nameVal);
 966       if (CRM_Utils_Array::value('location_type_id', $values)) {
 967         $locType = $values['location_type_id'];
 968       }
 969
 970       if (in_array($fldName, $addressFields) &&
 971         in_array($locType, $sharedLocations)
 972       ) {
 973         $values['is_shared'] = TRUE;
 974       }
 975     }
 976   }
 977
 978   /**
 979    * Function to update the shared addresses if master address is modified
 980    *
 981    * @param int    $addressId address id
 982    * @param array  $params    associated array of address params
 983    *
 984    * @return void
 985    * @access public
 986    * @static
 987    */
 988   static function processSharedAddress($addressId, $params) {
 989     $query = 'SELECT id FROM civicrm_address WHERE master_id = %1';
 990     $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($addressId, 'Integer')));
 991
 992     // unset contact id
 993     $skipFields = array('is_primary', 'location_type_id', 'is_billing', 'master_id', 'contact_id');
 994     foreach ($skipFields as $value) {
 995       unset($params[$value]);
 996     }
 997
 998     $addressDAO = new CRM_Core_DAO_Address();
 999     while ($dao->fetch()) {
1000       $addressDAO->copyValues($params);
1001       $addressDAO->id = $dao->id;
1002       $addressDAO->save();
1003       $addressDAO->free();
1004     }
1005   }
1006
1007   /**
1008    * Function to create relationship between contacts who share an address
1009    *
1010    * Note that currently we create relationship only for Individual contacts
1011    * Individual + Household and Individual + Orgnization
1012    *
1013    * @param int    $masterAddressId master address id
1014    * @param array  $params          associated array of submitted values
1015    *
1016    * @return void
1017    * @access public
1018    * @static
1019    */
1020   static function processSharedAddressRelationship($masterAddressId, $params) {
1021     if (!$masterAddressId) {
1022       return;
1023     }
1024     // get the contact type of contact being edited / created
1025     $currentContactType = CRM_Contact_BAO_Contact::getContactType($params['contact_id']);
1026     $currentContactId = $params['contact_id'];
1027
1028     // if current contact is not of type individual return
1029     if ($currentContactType != 'Individual') {
1030       return;
1031     }
1032
1033     // get the contact id and contact type of shared contact
1034     // check the contact type of shared contact, return if it is of type Individual
1035
1036     $query = 'SELECT cc.id, cc.contact_type
1037                  FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1038                  WHERE ca.id = %1';
1039
1040     $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($masterAddressId, 'Integer')));
1041
1042     $dao->fetch();
1043
1044     // if current contact is not of type individual return, since we don't create relationship between
1045     // 2 individuals
1046     if ($dao->contact_type == 'Individual') {
1047       return;
1048     }
1049     $sharedContactType = $dao->contact_type;
1050     $sharedContactId = $dao->id;
1051
1052     // create relationship between ontacts who share an address
1053     if ($sharedContactType == 'Organization') {
1054       return CRM_Contact_BAO_Contact_Utils::createCurrentEmployerRelationship($currentContactId, $sharedContactId);
1055     }
1056     else {
1057       // get the relationship type id of "Household Member of"
1058       $relationshipType = 'Household Member of';
1059     }
1060
1061     $cid = array('contact' => $currentContactId);
1062
1063     $relTypeId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', $relationshipType, 'id', 'name_a_b');
1064
1065     if (!$relTypeId) {
1066       CRM_Core_Error::fatal(ts("You seem to have deleted the relationship type '%1'", array(1 => $relationshipType)));
1067     }
1068
1069     // create relationship
1070     $relationshipParams = array(
1071       'is_active' => TRUE,
1072       'relationship_type_id' => $relTypeId . '_a_b',
1073       'contact_check' => array($sharedContactId => TRUE),
1074     );
1075
1076     list($valid, $invalid, $duplicate,
1077       $saved, $relationshipIds
1078     ) = CRM_Contact_BAO_Relationship::create($relationshipParams, $cid);
1079   }
1080
1081   /**
1082    * Function to check and set the status for shared address delete
1083    *
1084    * @param int     $addressId address id
1085    * @param int     $contactId contact id
1086    * @param boolean $returnStatus by default false
1087    *
1088    * @return string $statusMessage
1089    * @access public
1090    * @static
1091    */
1092   static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
1093     // check if address that is being deleted has any shared
1094     if ($addressId) {
1095       $entityId = $addressId;
1096       $query = 'SELECT cc.id, cc.display_name
1097                  FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1098                  WHERE ca.master_id = %1';
1099     }
1100     else {
1101       $entityId = $contactId;
1102       $query = 'SELECT cc.id, cc.display_name
1103                 FROM civicrm_address ca1
1104                     INNER JOIN civicrm_address ca2 ON ca1.id = ca2.master_id
1105                     INNER JOIN civicrm_contact cc  ON ca2.contact_id = cc.id
1106                 WHERE ca1.contact_id = %1';
1107     }
1108
1109     $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($entityId, 'Integer')));
1110
1111     $deleteStatus = array();
1112     $sharedContactList = array();
1113     $statusMessage = NULL;
1114     $addressCount = 0;
1115     while ($dao->fetch()) {
1116       if (empty($deleteStatus)) {
1117         $deleteStatus[] = ts('The following contact(s) have address records which were shared with the address you removed from this contact. These address records are no longer shared - but they have not been removed or altered.');
1118       }
1119
1120       $contactViewUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$dao->id}");
1121       $sharedContactList[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1122       $deleteStatus[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1123
1124       $addressCount++;
1125     }
1126
1127     if (!empty($deleteStatus)) {
1128       $statusMessage = implode('<br/>', $deleteStatus) . '<br/>';
1129     }
1130
1131     if (!$returnStatus) {
1132       CRM_Core_Session::setStatus($statusMessage, '', 'info');
1133     }
1134     else {
1135       return array(
1136         'contactList' => $sharedContactList,
1137         'count' => $addressCount,
1138       );
1139     }
1140   }
1141
1142   /**
1143    * Call common delete function
1144    */
1145   static function del($id) {
1146     return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Address', $id);
1147   }
1148 }