CRM/Contact/Form/Contact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class generates form components generic to all the contact types.
  20  *
  21  * It delegates the work to lower level subclasses and integrates the changes
  22  * back in. It also uses a lot of functionality with the CRM API's, so any change
  23  * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
  24  *
  25  */
  26 class CRM_Contact_Form_Contact extends CRM_Core_Form {
  27
  28   /**
  29    * The contact type of the form.
  30    *
  31    * @var string
  32    */
  33   public $_contactType;
  34
  35   /**
  36    * The contact type of the form.
  37    *
  38    * @var string
  39    */
  40   public $_contactSubType;
  41
  42   /**
  43    * The contact id, used when editing the form
  44    *
  45    * @var int
  46    */
  47   public $_contactId;
  48
  49   /**
  50    * The default group id passed in via the url.
  51    *
  52    * @var int
  53    */
  54   public $_gid;
  55
  56   /**
  57    * The default tag id passed in via the url.
  58    *
  59    * @var int
  60    */
  61   public $_tid;
  62
  63   /**
  64    * Name of de-dupe button
  65    *
  66    * @var string
  67    */
  68   protected $_dedupeButtonName;
  69
  70   /**
  71    * Name of optional save duplicate button.
  72    *
  73    * @var string
  74    */
  75   protected $_duplicateButtonName;
  76
  77   protected $_editOptions = [];
  78
  79   protected $_oldSubtypes = [];
  80
  81   public $_blocks;
  82
  83   public $_values = [];
  84
  85   public $_action;
  86
  87   public $_customValueCount;
  88   /**
  89    * The array of greetings with option group and filed names.
  90    *
  91    * @var array
  92    */
  93   public $_greetings;
  94
  95   /**
  96    * Do we want to parse street address.
  97    * @var bool
  98    */
  99   public $_parseStreetAddress;
 100
 101   /**
 102    * Check contact has a subtype or not.
 103    * @var bool
 104    */
 105   public $_isContactSubType;
 106
 107   /**
 108    * Lets keep a cache of all the values that we retrieved.
 109    * THis is an attempt to avoid the number of update statements
 110    * during the write phase
 111    * @var array
 112    */
 113   public $_preEditValues;
 114
 115   /**
 116    * Explicitly declare the entity api name.
 117    */
 118   public function getDefaultEntity() {
 119     return 'Contact';
 120   }
 121
 122   /**
 123    * Explicitly declare the form context.
 124    */
 125   public function getDefaultContext() {
 126     return 'create';
 127   }
 128
 129   /**
 130    * Build all the data structures needed to build the form.
 131    */
 132   public function preProcess() {
 133     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 134
 135     $this->_dedupeButtonName = $this->getButtonName('refresh', 'dedupe');
 136     $this->_duplicateButtonName = $this->getButtonName('upload', 'duplicate');
 137
 138     CRM_Core_Resources::singleton()
 139       ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header');
 140
 141     $session = CRM_Core_Session::singleton();
 142     if ($this->_action == CRM_Core_Action::ADD) {
 143       // check for add contacts permissions
 144       if (!CRM_Core_Permission::check('add contacts')) {
 145         CRM_Utils_System::permissionDenied();
 146         CRM_Utils_System::civiExit();
 147       }
 148       $this->_contactType = CRM_Utils_Request::retrieve('ct', 'String',
 149         $this, TRUE, NULL, 'REQUEST'
 150       );
 151       if (!in_array($this->_contactType,
 152         ['Individual', 'Household', 'Organization']
 153       )
 154       ) {
 155         CRM_Core_Error::statusBounce(ts('Could not get a contact id and/or contact type'));
 156       }
 157
 158       $this->_isContactSubType = FALSE;
 159       if ($this->_contactSubType = CRM_Utils_Request::retrieve('cst', 'String', $this)) {
 160         $this->_isContactSubType = TRUE;
 161       }
 162
 163       if (
 164         $this->_contactSubType &&
 165         !(CRM_Contact_BAO_ContactType::isExtendsContactType($this->_contactSubType, $this->_contactType, TRUE))
 166       ) {
 167         CRM_Core_Error::statusBounce(ts("Could not get a valid contact subtype for contact type '%1'", [1 => $this->_contactType]));
 168       }
 169
 170       $this->_gid = CRM_Utils_Request::retrieve('gid', 'Integer',
 171         CRM_Core_DAO::$_nullObject,
 172         FALSE, NULL, 'GET'
 173       );
 174       $this->_tid = CRM_Utils_Request::retrieve('tid', 'Integer',
 175         CRM_Core_DAO::$_nullObject,
 176         FALSE, NULL, 'GET'
 177       );
 178       $typeLabel = CRM_Contact_BAO_ContactType::contactTypePairs(TRUE, $this->_contactSubType ?
 179           $this->_contactSubType : $this->_contactType
 180       );
 181       $typeLabel = implode(' / ', $typeLabel);
 182
 183       CRM_Utils_System::setTitle(ts('New %1', [1 => $typeLabel]));
 184       $session->pushUserContext(CRM_Utils_System::url('civicrm/dashboard', 'reset=1'));
 185       $this->_contactId = NULL;
 186     }
 187     else {
 188       //update mode
 189       if (!$this->_contactId) {
 190         $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 191       }
 192
 193       if ($this->_contactId) {
 194         $defaults = [];
 195         $params = ['id' => $this->_contactId];
 196         $returnProperities = ['id', 'contact_type', 'contact_sub_type', 'modified_date', 'is_deceased'];
 197         CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Contact', $params, $defaults, $returnProperities);
 198
 199         if (empty($defaults['id'])) {
 200           CRM_Core_Error::statusBounce(ts('A Contact with that ID does not exist: %1', [1 => $this->_contactId]));
 201         }
 202
 203         $this->_contactType = $defaults['contact_type'] ?? NULL;
 204         $this->_contactSubType = $defaults['contact_sub_type'] ?? NULL;
 205
 206         // check for permissions
 207         $session = CRM_Core_Session::singleton();
 208         if (!CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
 209           CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
 210         }
 211
 212         $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 213         if ($defaults['is_deceased']) {
 214           $displayName .= '  <span class="crm-contact-deceased">(' . ts('deceased') . ')</span>';
 215         }
 216         $displayName = ts('Edit %1', [1 => $displayName]);
 217
 218         // Check if this is default domain contact CRM-10482
 219         if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactId)) {
 220           $displayName .= ' (' . ts('default organization') . ')';
 221         }
 222
 223         // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 224         CRM_Utils_System::setTitle($displayName);
 225         $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 226         $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
 227
 228         $urlParams = 'reset=1&cid=' . $this->_contactId;
 229         if ($context) {
 230           $urlParams .= "&context=$context";
 231         }
 232
 233         if (CRM_Utils_Rule::qfKey($qfKey)) {
 234
 235           $urlParams .= "&key=$qfKey";
 236
 237         }
 238         $session->pushUserContext(CRM_Utils_System::url('civicrm/contact/view', $urlParams));
 239
 240         $values = $this->get('values');
 241         // get contact values.
 242         if (!empty($values)) {
 243           $this->_values = $values;
 244         }
 245         else {
 246           $params = [
 247             'id' => $this->_contactId,
 248             'contact_id' => $this->_contactId,
 249             'noRelationships' => TRUE,
 250             'noNotes' => TRUE,
 251             'noGroups' => TRUE,
 252           ];
 253
 254           $contact = CRM_Contact_BAO_Contact::retrieve($params, $this->_values, TRUE);
 255           $this->set('values', $this->_values);
 256         }
 257       }
 258       else {
 259         CRM_Core_Error::statusBounce(ts('Could not get a contact_id and/or contact_type'));
 260       }
 261     }
 262
 263     // parse street address, CRM-5450
 264     $this->_parseStreetAddress = $this->get('parseStreetAddress');
 265     if (!isset($this->_parseStreetAddress)) {
 266       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 267         'address_options'
 268       );
 269       $this->_parseStreetAddress = FALSE;
 270       if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
 271         $this->_parseStreetAddress = TRUE;
 272       }
 273       $this->set('parseStreetAddress', $this->_parseStreetAddress);
 274     }
 275     $this->assign('parseStreetAddress', $this->_parseStreetAddress);
 276
 277     $this->_editOptions = $this->get('contactEditOptions');
 278     if (CRM_Utils_System::isNull($this->_editOptions)) {
 279       $this->_editOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 280         'contact_edit_options', TRUE, NULL,
 281         FALSE, 'name', TRUE, 'AND v.filter = 0'
 282       );
 283       $this->set('contactEditOptions', $this->_editOptions);
 284     }
 285
 286     // build demographics only for Individual contact type
 287     if ($this->_contactType != 'Individual' &&
 288       array_key_exists('Demographics', $this->_editOptions)
 289     ) {
 290       unset($this->_editOptions['Demographics']);
 291     }
 292
 293     // in update mode don't show notes
 294     if ($this->_contactId && array_key_exists('Notes', $this->_editOptions)) {
 295       unset($this->_editOptions['Notes']);
 296     }
 297
 298     $this->assign('editOptions', $this->_editOptions);
 299     $this->assign('contactType', $this->_contactType);
 300     $this->assign('contactSubType', $this->_contactSubType);
 301
 302     // get the location blocks.
 303     $this->_blocks = $this->get('blocks');
 304     if (CRM_Utils_System::isNull($this->_blocks)) {
 305       $this->_blocks = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 306         'contact_edit_options', TRUE, NULL,
 307         FALSE, 'name', TRUE, 'AND v.filter = 1'
 308       );
 309       $this->set('blocks', $this->_blocks);
 310     }
 311     $this->assign('blocks', $this->_blocks);
 312
 313     // this is needed for custom data.
 314     $this->assign('entityID', $this->_contactId);
 315
 316     // also keep the convention.
 317     $this->assign('contactId', $this->_contactId);
 318
 319     // location blocks.
 320     CRM_Contact_Form_Location::preProcess($this);
 321
 322     // retain the multiple count custom fields value
 323     if (!empty($_POST['hidden_custom'])) {
 324       $customGroupCount = $_POST['hidden_custom_group_count'] ?? NULL;
 325
 326       if ($contactSubType = CRM_Utils_Array::value('contact_sub_type', $_POST)) {
 327         $paramSubType = implode(',', $contactSubType);
 328       }
 329
 330       $this->_getCachedTree = FALSE;
 331       unset($customGroupCount[0]);
 332       foreach ($customGroupCount as $groupID => $groupCount) {
 333         if ($groupCount > 1) {
 334           $this->set('groupID', $groupID);
 335           //loop the group
 336           for ($i = 0; $i <= $groupCount; $i++) {
 337             CRM_Custom_Form_CustomData::preProcess($this, NULL, $contactSubType,
 338               $i, $this->_contactType, $this->_contactId
 339             );
 340             CRM_Contact_Form_Edit_CustomData::buildQuickForm($this);
 341           }
 342         }
 343       }
 344
 345       //reset all the ajax stuff, for normal processing
 346       if (isset($this->_groupTree)) {
 347         $this->_groupTree = NULL;
 348       }
 349       $this->set('groupID', NULL);
 350       $this->_getCachedTree = TRUE;
 351     }
 352
 353     // execute preProcess dynamically by js else execute normal preProcess
 354     if (array_key_exists('CustomData', $this->_editOptions)) {
 355       //assign a parameter to pass for sub type multivalue
 356       //custom field to load
 357       if ($this->_contactSubType || isset($paramSubType)) {
 358         $paramSubType = (isset($paramSubType)) ? $paramSubType :
 359           str_replace(CRM_Core_DAO::VALUE_SEPARATOR, ',', trim($this->_contactSubType, CRM_Core_DAO::VALUE_SEPARATOR));
 360
 361         $this->assign('paramSubType', $paramSubType);
 362       }
 363
 364       if (CRM_Utils_Request::retrieve('type', 'String')) {
 365         CRM_Contact_Form_Edit_CustomData::preProcess($this);
 366       }
 367       else {
 368         $contactSubType = $this->_contactSubType;
 369         // need contact sub type to build related grouptree array during post process
 370         if (!empty($_POST['qfKey'])) {
 371           $contactSubType = $_POST['contact_sub_type'] ?? NULL;
 372         }
 373         //only custom data has preprocess hence directly call it
 374         CRM_Custom_Form_CustomData::preProcess($this, NULL, $contactSubType,
 375           1, $this->_contactType, $this->_contactId
 376         );
 377         $this->assign('customValueCount', $this->_customValueCount);
 378       }
 379     }
 380   }
 381
 382   /**
 383    * Set default values for the form.
 384    *
 385    * Note that in edit/view mode the default values are retrieved from the database
 386    */
 387   public function setDefaultValues() {
 388     $defaults = $this->_values;
 389
 390     if ($this->_action & CRM_Core_Action::ADD) {
 391       if (array_key_exists('TagsAndGroups', $this->_editOptions)) {
 392         // set group and tag defaults if any
 393         if ($this->_gid) {
 394           $defaults['group'][] = $this->_gid;
 395         }
 396         if ($this->_tid) {
 397           $defaults['tag'][$this->_tid] = 1;
 398         }
 399       }
 400       if ($this->_contactSubType) {
 401         $defaults['contact_sub_type'] = $this->_contactSubType;
 402       }
 403     }
 404     else {
 405       foreach ($defaults['email'] as $dontCare => & $val) {
 406         if (isset($val['signature_text'])) {
 407           $val['signature_text_hidden'] = $val['signature_text'];
 408         }
 409         if (isset($val['signature_html'])) {
 410           $val['signature_html_hidden'] = $val['signature_html'];
 411         }
 412       }
 413
 414       if (!empty($defaults['contact_sub_type'])) {
 415         $defaults['contact_sub_type'] = $this->_oldSubtypes;
 416       }
 417     }
 418     // set defaults for blocks ( custom data, address, communication preference, notes, tags and groups )
 419     foreach ($this->_editOptions as $name => $label) {
 420       if (!in_array($name, ['Address', 'Notes'])) {
 421         $className = 'CRM_Contact_Form_Edit_' . $name;
 422         $className::setDefaultValues($this, $defaults);
 423       }
 424     }
 425
 426     //set address block defaults
 427     CRM_Contact_Form_Edit_Address::setDefaultValues($defaults, $this);
 428
 429     if (!empty($defaults['image_URL'])) {
 430       $this->assign("imageURL", CRM_Utils_File::getImageURL($defaults['image_URL']));
 431     }
 432
 433     //set location type and country to default for each block
 434     $this->blockSetDefaults($defaults);
 435
 436     $this->_preEditValues = $defaults;
 437     return $defaults;
 438   }
 439
 440   /**
 441    * Do the set default related to location type id, primary location,  default country.
 442    *
 443    * @param array $defaults
 444    */
 445   public function blockSetDefaults(&$defaults) {
 446     $locationTypeKeys = array_filter(array_keys(CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id')), 'is_int');
 447     sort($locationTypeKeys);
 448
 449     // get the default location type
 450     $locationType = CRM_Core_BAO_LocationType::getDefault();
 451
 452     // unset primary location type
 453     $primaryLocationTypeIdKey = CRM_Utils_Array::key($locationType->id, $locationTypeKeys);
 454     unset($locationTypeKeys[$primaryLocationTypeIdKey]);
 455
 456     // reset the array sequence
 457     $locationTypeKeys = array_values($locationTypeKeys);
 458
 459     // get default phone and im provider id.
 460     $defPhoneTypeId = key(CRM_Core_OptionGroup::values('phone_type', FALSE, FALSE, FALSE, ' AND is_default = 1'));
 461     $defIMProviderId = key(CRM_Core_OptionGroup::values('instant_messenger_service',
 462       FALSE, FALSE, FALSE, ' AND is_default = 1'
 463     ));
 464     $defWebsiteTypeId = key(CRM_Core_OptionGroup::values('website_type',
 465       FALSE, FALSE, FALSE, ' AND is_default = 1'
 466     ));
 467
 468     $allBlocks = $this->_blocks;
 469     if (array_key_exists('Address', $this->_editOptions)) {
 470       $allBlocks['Address'] = $this->_editOptions['Address'];
 471     }
 472
 473     $config = CRM_Core_Config::singleton();
 474     foreach ($allBlocks as $blockName => $label) {
 475       $name = strtolower($blockName);
 476       $hasPrimary = $updateMode = FALSE;
 477
 478       // user is in update mode.
 479       if (array_key_exists($name, $defaults) &&
 480         !CRM_Utils_System::isNull($defaults[$name])
 481       ) {
 482         $updateMode = TRUE;
 483       }
 484
 485       for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++) {
 486         // make we require one primary block, CRM-5505
 487         if ($updateMode) {
 488           if (!$hasPrimary) {
 489             $hasPrimary = CRM_Utils_Array::value(
 490               'is_primary',
 491               CRM_Utils_Array::value($instance, $defaults[$name])
 492             );
 493           }
 494           continue;
 495         }
 496
 497         //set location to primary for first one.
 498         if ($instance == 1) {
 499           $hasPrimary = TRUE;
 500           $defaults[$name][$instance]['is_primary'] = TRUE;
 501           $defaults[$name][$instance]['location_type_id'] = $locationType->id;
 502         }
 503         else {
 504           $locTypeId = $locationTypeKeys[$instance - 1] ?? $locationType->id;
 505           $defaults[$name][$instance]['location_type_id'] = $locTypeId;
 506         }
 507
 508         //set default country
 509         if ($name == 'address' && $config->defaultContactCountry) {
 510           $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry;
 511         }
 512
 513         //set default state/province
 514         if ($name == 'address' && $config->defaultContactStateProvince) {
 515           $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince;
 516         }
 517
 518         //set default phone type.
 519         if ($name == 'phone' && $defPhoneTypeId) {
 520           $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
 521         }
 522         //set default website type.
 523         if ($name == 'website' && $defWebsiteTypeId) {
 524           $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
 525         }
 526
 527         //set default im provider.
 528         if ($name == 'im' && $defIMProviderId) {
 529           $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
 530         }
 531       }
 532
 533       if (!$hasPrimary) {
 534         $defaults[$name][1]['is_primary'] = TRUE;
 535       }
 536     }
 537   }
 538
 539   /**
 540    * add the rules (mainly global rules) for form.
 541    * All local rules are added near the element
 542    *
 543    * @see valid_date
 544    */
 545   public function addRules() {
 546     // skip adding formRules when custom data is build
 547     if ($this->_addBlockName || ($this->_action & CRM_Core_Action::DELETE)) {
 548       return;
 549     }
 550
 551     $this->addFormRule(['CRM_Contact_Form_Edit_' . $this->_contactType, 'formRule'], $this->_contactId);
 552
 553     // Call Locking check if editing existing contact
 554     if ($this->_contactId) {
 555       $this->addFormRule(['CRM_Contact_Form_Edit_Lock', 'formRule'], $this->_contactId);
 556     }
 557
 558     if (array_key_exists('Address', $this->_editOptions)) {
 559       $this->addFormRule(['CRM_Contact_Form_Edit_Address', 'formRule'], $this);
 560     }
 561
 562     if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
 563       $this->addFormRule(['CRM_Contact_Form_Edit_CommunicationPreferences', 'formRule'], $this);
 564     }
 565   }
 566
 567   /**
 568    * Global validation rules for the form.
 569    *
 570    * @param array $fields
 571    *   Posted values of the form.
 572    * @param array $errors
 573    *   List of errors to be posted back to the form.
 574    * @param int $contactId
 575    *   Contact id if doing update.
 576    * @param string $contactType
 577    *
 578    * @return bool
 579    *   email/openId
 580    */
 581   public static function formRule($fields, &$errors, $contactId, $contactType) {
 582     $config = CRM_Core_Config::singleton();
 583
 584     // validations.
 585     //1. for each block only single value can be marked as is_primary = true.
 586     //2. location type id should be present if block data present.
 587     //3. check open id across db and other each block for duplicate.
 588     //4. at least one location should be primary.
 589     //5. also get primaryID from email or open id block.
 590
 591     // take the location blocks.
 592     $blocks = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 593       'contact_edit_options', TRUE, NULL,
 594       FALSE, 'name', TRUE, 'AND v.filter = 1'
 595     );
 596
 597     $otherEditOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 598       'contact_edit_options', TRUE, NULL,
 599       FALSE, 'name', TRUE, 'AND v.filter = 0'
 600     );
 601     //get address block inside.
 602     if (array_key_exists('Address', $otherEditOptions)) {
 603       $blocks['Address'] = $otherEditOptions['Address'];
 604     }
 605
 606     $website_types = [];
 607     $openIds = [];
 608     $primaryID = FALSE;
 609     foreach ($blocks as $name => $label) {
 610       $hasData = $hasPrimary = [];
 611       $name = strtolower($name);
 612       if (!empty($fields[$name]) && is_array($fields[$name])) {
 613         foreach ($fields[$name] as $instance => $blockValues) {
 614           $dataExists = self::blockDataExists($blockValues);
 615
 616           if (!$dataExists && $name == 'address') {
 617             $dataExists = $fields['address'][$instance]['use_shared_address'] ?? NULL;
 618           }
 619
 620           if ($dataExists) {
 621             if ($name == 'website') {
 622               if (!empty($blockValues['website_type_id'])) {
 623                 if (empty($website_types[$blockValues['website_type_id']])) {
 624                   $website_types[$blockValues['website_type_id']] = $blockValues['website_type_id'];
 625                 }
 626                 else {
 627                   $errors["{$name}[1][website_type_id]"] = ts('Contacts may only have one website of each type at most.');
 628                 }
 629               }
 630
 631               // skip remaining checks for website
 632               continue;
 633             }
 634
 635             $hasData[] = $instance;
 636             if (!empty($blockValues['is_primary'])) {
 637               $hasPrimary[] = $instance;
 638               if (!$primaryID &&
 639                 in_array($name, [
 640                   'email',
 641                   'openid',
 642                 ]) && !empty($blockValues[$name])
 643               ) {
 644                 $primaryID = $blockValues[$name];
 645               }
 646             }
 647
 648             if (empty($blockValues['location_type_id'])) {
 649               $errors["{$name}[$instance][location_type_id]"] = ts('The Location Type should be set if there is  %1 information.', [1 => $label]);
 650             }
 651           }
 652
 653           if ($name == 'openid' && !empty($blockValues[$name])) {
 654             $oid = new CRM_Core_DAO_OpenID();
 655             $oid->openid = $openIds[$instance] = $blockValues[$name];
 656             $cid = $contactId ?? 0;
 657             if ($oid->find(TRUE) && ($oid->contact_id != $cid)) {
 658               $errors["{$name}[$instance][openid]"] = ts('%1 already exist.', [1 => $blocks['OpenID']]);
 659             }
 660           }
 661         }
 662
 663         if (empty($hasPrimary) && !empty($hasData)) {
 664           $errors["{$name}[1][is_primary]"] = ts('One %1 should be marked as primary.', [1 => $label]);
 665         }
 666
 667         if (count($hasPrimary) > 1) {
 668           $errors["{$name}[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one %1 can be marked as primary.',
 669             [1 => $label]
 670           );
 671         }
 672       }
 673     }
 674
 675     //do validations for all opend ids they should be distinct.
 676     if (!empty($openIds) && (count(array_unique($openIds)) != count($openIds))) {
 677       foreach ($openIds as $instance => $value) {
 678         if (!array_key_exists($instance, array_unique($openIds))) {
 679           $errors["openid[$instance][openid]"] = ts('%1 already used.', [1 => $blocks['OpenID']]);
 680         }
 681       }
 682     }
 683
 684     // street number should be digit + suffix, CRM-5450
 685     $parseStreetAddress = CRM_Utils_Array::value('street_address_parsing',
 686       CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 687         'address_options'
 688       )
 689     );
 690     if ($parseStreetAddress) {
 691       if (isset($fields['address']) &&
 692         is_array($fields['address'])
 693       ) {
 694         $invalidStreetNumbers = [];
 695         foreach ($fields['address'] as $cnt => $address) {
 696           if ($streetNumber = CRM_Utils_Array::value('street_number', $address)) {
 697             $parsedAddress = CRM_Core_BAO_Address::parseStreetAddress($address['street_number']);
 698             if (empty($parsedAddress['street_number'])) {
 699               $invalidStreetNumbers[] = $cnt;
 700             }
 701           }
 702         }
 703
 704         if (!empty($invalidStreetNumbers)) {
 705           $first = $invalidStreetNumbers[0];
 706           foreach ($invalidStreetNumbers as & $num) {
 707             $num = CRM_Contact_Form_Contact::ordinalNumber($num);
 708           }
 709           $errors["address[$first][street_number]"] = ts('The street number you entered for the %1 address block(s) is not in an expected format. Street numbers may include numeric digit(s) followed by other characters. You can still enter the complete street address (unparsed) by clicking "Edit Complete Street Address".', [1 => implode(', ', $invalidStreetNumbers)]);
 710         }
 711       }
 712     }
 713
 714     // Check for duplicate contact if it wasn't already handled by ajax or disabled
 715     if (!Civi::settings()->get('contact_ajax_check_similar') || !empty($fields['_qf_Contact_refresh_dedupe'])) {
 716       self::checkDuplicateContacts($fields, $errors, $contactId, $contactType);
 717     }
 718
 719     return $primaryID;
 720   }
 721
 722   /**
 723    * Build the form object.
 724    */
 725   public function buildQuickForm() {
 726     //load form for child blocks
 727     if ($this->_addBlockName) {
 728       $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName;
 729       return $className::buildQuickForm($this);
 730     }
 731
 732     if ($this->_action == CRM_Core_Action::UPDATE) {
 733       $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.'));
 734       $deleteURL = [
 735         CRM_Core_Action::DELETE => [
 736           'name' => ts('Delete Contact Image'),
 737           'url' => 'civicrm/contact/image',
 738           'qs' => 'reset=1&cid=%%id%%&action=delete',
 739           'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"',
 740         ],
 741       ];
 742       $deleteURL = CRM_Core_Action::formLink($deleteURL,
 743         CRM_Core_Action::DELETE,
 744         [
 745           'id' => $this->_contactId,
 746         ],
 747         ts('more'),
 748         FALSE,
 749         'contact.image.delete',
 750         'Contact',
 751         $this->_contactId
 752       );
 753       $this->assign('deleteURL', $deleteURL);
 754     }
 755
 756     //build contact type specific fields
 757     $className = 'CRM_Contact_Form_Edit_' . $this->_contactType;
 758     $className::buildQuickForm($this);
 759
 760     // Ajax duplicate checking
 761     $checkSimilar = Civi::settings()->get('contact_ajax_check_similar');
 762     $this->assign('checkSimilar', $checkSimilar);
 763     if ($checkSimilar == 1) {
 764       $ruleParams = ['used' => 'Supervised', 'contact_type' => $this->_contactType];
 765       $this->assign('ruleFields', CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams));
 766     }
 767
 768     // build Custom data if Custom data present in edit option
 769     $buildCustomData = 'noCustomDataPresent';
 770     if (array_key_exists('CustomData', $this->_editOptions)) {
 771       $buildCustomData = "customDataPresent";
 772     }
 773
 774     // subtype is a common field. lets keep it here
 775     $subtypes = CRM_Contact_BAO_Contact::buildOptions('contact_sub_type', 'create', ['contact_type' => $this->_contactType]);
 776     if (!empty($subtypes)) {
 777       $this->addField('contact_sub_type', [
 778         'label' => ts('Contact Type'),
 779         'options' => $subtypes,
 780         'class' => $buildCustomData,
 781         'multiple' => 'multiple',
 782         'option_url' => NULL,
 783       ]);
 784     }
 785
 786     // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
 787     foreach ($this->_editOptions as $name => $label) {
 788       if ($name == 'Address') {
 789         $this->_blocks['Address'] = $this->_editOptions['Address'];
 790         continue;
 791       }
 792       if ($name == 'TagsAndGroups') {
 793         continue;
 794       }
 795       $className = 'CRM_Contact_Form_Edit_' . $name;
 796       $className::buildQuickForm($this);
 797     }
 798
 799     // build tags and groups
 800     CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups::ALL,
 801       FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
 802
 803     // build location blocks.
 804     CRM_Contact_Form_Edit_Lock::buildQuickForm($this);
 805     CRM_Contact_Form_Location::buildQuickForm($this);
 806
 807     // add attachment
 808     $this->addField('image_URL', ['maxlength' => '255', 'label' => ts('Browse/Upload Image')]);
 809
 810     // add the dedupe button
 811     $this->addElement('xbutton',
 812       $this->_dedupeButtonName,
 813       ts('Check for Matching Contact(s)'),
 814       [
 815         'type' => 'submit',
 816         'value' => 1,
 817         'class' => "crm-button crm-button{$this->_dedupeButtonName}",
 818       ]
 819     );
 820     $this->addElement('xbutton',
 821       $this->_duplicateButtonName,
 822       ts('Save Matching Contact'),
 823       [
 824         'type' => 'submit',
 825         'value' => 1,
 826         'class' => "crm-button crm-button{$this->_duplicateButtonName}",
 827       ]
 828     );
 829     $this->addElement('xbutton',
 830       $this->getButtonName('next', 'sharedHouseholdDuplicate'),
 831       ts('Save With Duplicate Household'),
 832       [
 833         'type' => 'submit',
 834         'value' => 1,
 835       ]
 836     );
 837
 838     $buttons = [
 839       [
 840         'type' => 'upload',
 841         'name' => ts('Save'),
 842         'subName' => 'view',
 843         'isDefault' => TRUE,
 844       ],
 845     ];
 846     if (CRM_Core_Permission::check('add contacts')) {
 847       $buttons[] = [
 848         'type' => 'upload',
 849         'name' => ts('Save and New'),
 850         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 851         'subName' => 'new',
 852       ];
 853     }
 854     $buttons[] = [
 855       'type' => 'cancel',
 856       'name' => ts('Cancel'),
 857     ];
 858
 859     if (!empty($this->_values['contact_sub_type'])) {
 860       $this->_oldSubtypes = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 861         trim($this->_values['contact_sub_type'], CRM_Core_DAO::VALUE_SEPARATOR)
 862       );
 863     }
 864     $this->assign('oldSubtypes', json_encode($this->_oldSubtypes));
 865
 866     $this->addButtons($buttons);
 867   }
 868
 869   /**
 870    * Form submission of new/edit contact is processed.
 871    */
 872   public function postProcess() {
 873     // check if dedupe button, if so return.
 874     $buttonName = $this->controller->getButtonName();
 875     if ($buttonName == $this->_dedupeButtonName) {
 876       return;
 877     }
 878
 879     //get the submitted values in an array
 880     $params = $this->controller->exportValues($this->_name);
 881     if (!isset($params['preferred_communication_method'])) {
 882       // If this field is empty QF will trim it so we have to add it in.
 883       $params['preferred_communication_method'] = 'null';
 884     }
 885
 886     $group = $params['group'] ?? NULL;
 887     $params['group'] = ($params['group'] == '') ? [] : $params['group'];
 888     if (!empty($group)) {
 889       $group = is_array($group) ? $group : explode(',', $group);
 890       $params['group'] = [];
 891       foreach ($group as $key => $value) {
 892         $params['group'][$value] = 1;
 893       }
 894     }
 895
 896     if (!empty($params['image_URL'])) {
 897       CRM_Contact_BAO_Contact::processImageParams($params);
 898     }
 899
 900     if (is_numeric(CRM_Utils_Array::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
 901       $params['current_employer'] = $params['current_employer_id'];
 902     }
 903
 904     // don't carry current_employer_id field,
 905     // since we don't want to directly update DAO object without
 906     // handling related business logic ( eg related membership )
 907     if (isset($params['current_employer_id'])) {
 908       unset($params['current_employer_id']);
 909     }
 910
 911     $params['contact_type'] = $this->_contactType;
 912     if (empty($params['contact_sub_type']) && $this->_isContactSubType) {
 913       $params['contact_sub_type'] = [$this->_contactSubType];
 914     }
 915
 916     if ($this->_contactId) {
 917       $params['contact_id'] = $this->_contactId;
 918     }
 919
 920     //make deceased date null when is_deceased = false
 921     if ($this->_contactType == 'Individual' && !empty($this->_editOptions['Demographics']) && empty($params['is_deceased'])) {
 922       $params['is_deceased'] = FALSE;
 923       $params['deceased_date'] = NULL;
 924     }
 925
 926     // action is taken depending upon the mode
 927     if ($this->_action & CRM_Core_Action::UPDATE) {
 928       CRM_Utils_Hook::pre('edit', $params['contact_type'], $params['contact_id'], $params);
 929     }
 930     else {
 931       CRM_Utils_Hook::pre('create', $params['contact_type'], NULL, $params);
 932     }
 933
 934     //CRM-5143
 935     //if subtype is set, send subtype as extend to validate subtype customfield
 936     $customFieldExtends = (CRM_Utils_Array::value('contact_sub_type', $params)) ? $params['contact_sub_type'] : $params['contact_type'];
 937
 938     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 939       $this->_contactId,
 940       $customFieldExtends,
 941       TRUE
 942     );
 943     if ($this->_contactId && !empty($this->_oldSubtypes)) {
 944       CRM_Contact_BAO_ContactType::deleteCustomSetForSubtypeMigration($this->_contactId,
 945         $params['contact_type'],
 946         $this->_oldSubtypes,
 947         $params['contact_sub_type']
 948       );
 949     }
 950
 951     if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
 952       // this is a chekbox, so mark false if we dont get a POST value
 953       $params['is_opt_out'] = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
 954     }
 955
 956     // process shared contact address.
 957     CRM_Contact_BAO_Contact_Utils::processSharedAddress($params['address']);
 958
 959     if (!array_key_exists('TagsAndGroups', $this->_editOptions)) {
 960       unset($params['group']);
 961     }
 962     elseif (!empty($params['contact_id']) && ($this->_action & CRM_Core_Action::UPDATE)) {
 963       // figure out which all groups are intended to be removed
 964       $contactGroupList = CRM_Contact_BAO_GroupContact::getContactGroup($params['contact_id'], 'Added');
 965       if (is_array($contactGroupList)) {
 966         foreach ($contactGroupList as $key) {
 967           if ((!array_key_exists($key['group_id'], $params['group']) || $params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
 968             $params['group'][$key['group_id']] = -1;
 969           }
 970         }
 971       }
 972     }
 973
 974     // parse street address, CRM-5450
 975     $parseStatusMsg = NULL;
 976     if ($this->_parseStreetAddress) {
 977       $parseResult = self::parseAddress($params);
 978       $parseStatusMsg = self::parseAddressStatusMsg($parseResult);
 979     }
 980
 981     $blocks = ['email', 'phone', 'im', 'openid', 'address', 'website'];
 982     foreach ($blocks as $block) {
 983       if (!empty($this->_preEditValues[$block]) && is_array($this->_preEditValues[$block])) {
 984         foreach ($this->_preEditValues[$block] as $count => $value) {
 985           if (!empty($value['id'])) {
 986             $params[$block][$count]['id'] = $value['id'];
 987             $params[$block]['isIdSet'] = TRUE;
 988           }
 989         }
 990       }
 991     }
 992
 993     // Allow un-setting of location info, CRM-5969
 994     $params['updateBlankLocInfo'] = TRUE;
 995
 996     $contact = CRM_Contact_BAO_Contact::create($params, TRUE, FALSE, TRUE);
 997
 998     // status message
 999     if ($this->_contactId) {
1000       $message = ts('%1 has been updated.', [1 => $contact->display_name]);
1001     }
1002     else {
1003       $message = ts('%1 has been created.', [1 => $contact->display_name]);
1004     }
1005
1006     // set the contact ID
1007     $this->_contactId = $contact->id;
1008
1009     if (array_key_exists('TagsAndGroups', $this->_editOptions)) {
1010       //add contact to tags
1011       if (isset($params['tag'])) {
1012         $params['tag'] = array_flip(explode(',', $params['tag']));
1013         CRM_Core_BAO_EntityTag::create($params['tag'], 'civicrm_contact', $params['contact_id']);
1014       }
1015       //save free tags
1016       if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
1017         CRM_Core_Form_Tag::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1018       }
1019     }
1020
1021     if (!empty($parseStatusMsg)) {
1022       $message .= "<br />$parseStatusMsg";
1023     }
1024
1025     $session = CRM_Core_Session::singleton();
1026     $session->setStatus($message, ts('Contact Saved'), 'success');
1027
1028     // add the recently viewed contact
1029     $recentOther = [];
1030     if (($session->get('userID') == $contact->id) ||
1031       CRM_Contact_BAO_Contact_Permission::allow($contact->id, CRM_Core_Permission::EDIT)
1032     ) {
1033       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id);
1034     }
1035
1036     if (($session->get('userID') != $this->_contactId) && CRM_Core_Permission::check('delete contacts')) {
1037       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id);
1038     }
1039
1040     CRM_Utils_Recent::add($contact->display_name,
1041       CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id),
1042       $contact->id,
1043       $this->_contactType,
1044       $contact->id,
1045       $contact->display_name,
1046       $recentOther
1047     );
1048
1049     // here we replace the user context with the url to view this contact
1050     $buttonName = $this->controller->getButtonName();
1051     if ($buttonName == $this->getButtonName('upload', 'new')) {
1052       $contactSubTypes = array_filter(explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_contactSubType));
1053       $resetStr = "reset=1&ct={$contact->contact_type}";
1054       $resetStr .= (count($contactSubTypes) == 1) ? "&cst=" . array_pop($contactSubTypes) : '';
1055       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/add', $resetStr));
1056     }
1057     else {
1058       $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
1059       $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
1060       //validate the qfKey
1061       $urlParams = 'reset=1&cid=' . $contact->id;
1062       if ($context) {
1063         $urlParams .= "&context=$context";
1064       }
1065       if (CRM_Utils_Rule::qfKey($qfKey)) {
1066         $urlParams .= "&key=$qfKey";
1067       }
1068
1069       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view', $urlParams));
1070     }
1071
1072     // now invoke the post hook
1073     if ($this->_action & CRM_Core_Action::UPDATE) {
1074       CRM_Utils_Hook::post('edit', $params['contact_type'], $contact->id, $contact);
1075     }
1076     else {
1077       CRM_Utils_Hook::post('create', $params['contact_type'], $contact->id, $contact);
1078     }
1079   }
1080
1081   /**
1082    * Is there any real significant data in the hierarchical location array.
1083    *
1084    * @param array $fields
1085    *   The hierarchical value representation of this location.
1086    *
1087    * @return bool
1088    *   true if data exists, false otherwise
1089    */
1090   public static function blockDataExists(&$fields) {
1091     if (!is_array($fields)) {
1092       return FALSE;
1093     }
1094
1095     static $skipFields = [
1096       'location_type_id',
1097       'is_primary',
1098       'phone_type_id',
1099       'provider_id',
1100       'country_id',
1101       'website_type_id',
1102       'master_id',
1103     ];
1104     foreach ($fields as $name => $value) {
1105       $skipField = FALSE;
1106       foreach ($skipFields as $skip) {
1107         if (strpos("[$skip]", $name) !== FALSE) {
1108           if ($name == 'phone') {
1109             continue;
1110           }
1111           $skipField = TRUE;
1112           break;
1113         }
1114       }
1115       if ($skipField) {
1116         continue;
1117       }
1118       if (is_array($value)) {
1119         if (self::blockDataExists($value)) {
1120           return TRUE;
1121         }
1122       }
1123       else {
1124         if (!empty($value)) {
1125           return TRUE;
1126         }
1127       }
1128     }
1129
1130     return FALSE;
1131   }
1132
1133   /**
1134    * That checks for duplicate contacts.
1135    *
1136    * @param array $fields
1137    *   Fields array which are submitted.
1138    * @param $errors
1139    * @param int $contactID
1140    *   Contact id.
1141    * @param string $contactType
1142    *   Contact type.
1143    */
1144   public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1145     // if this is a forced save, ignore find duplicate rule
1146     if (empty($fields['_qf_Contact_upload_duplicate'])) {
1147
1148       $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($fields, $contactType, 'Supervised', [$contactID]);
1149       if ($ids) {
1150
1151         $contactLinks = CRM_Contact_BAO_Contact_Utils::formatContactIDSToLinks($ids, TRUE, TRUE, $contactID);
1152
1153         $duplicateContactsLinks = '<div class="matching-contacts-found">';
1154         $duplicateContactsLinks .= ts('One matching contact was found. ', [
1155           'count' => count($contactLinks['rows']),
1156           'plural' => '%count matching contacts were found.<br />',
1157         ]);
1158         if ($contactLinks['msg'] == 'view') {
1159           $duplicateContactsLinks .= ts('You can View the existing contact', [
1160             'count' => count($contactLinks['rows']),
1161             'plural' => 'You can View the existing contacts',
1162           ]);
1163         }
1164         else {
1165           $duplicateContactsLinks .= ts('You can View or Edit the existing contact', [
1166             'count' => count($contactLinks['rows']),
1167             'plural' => 'You can View or Edit the existing contacts',
1168           ]);
1169         }
1170         if ($contactLinks['msg'] == 'merge') {
1171           // We should also get a merge link if this is for an existing contact
1172           $duplicateContactsLinks .= ts(', or Merge this contact with an existing contact');
1173         }
1174         $duplicateContactsLinks .= '.';
1175         $duplicateContactsLinks .= '</div>';
1176         $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
1177         $row = '';
1178         for ($i = 0; $i < count($contactLinks['rows']); $i++) {
1179           $row .= '  <tr>   ';
1180           $row .= '    <td class="matching-contacts-name"> ';
1181           $row .= CRM_Utils_Array::value('display_name', $contactLinks['rows'][$i]);
1182           $row .= '    </td>';
1183           $row .= '    <td class="matching-contacts-email"> ';
1184           $row .= CRM_Utils_Array::value('primary_email', $contactLinks['rows'][$i]);
1185           $row .= '    </td>';
1186           $row .= '    <td class="action-items"> ';
1187           $row .= CRM_Utils_Array::value('view', $contactLinks['rows'][$i]);
1188           $row .= CRM_Utils_Array::value('edit', $contactLinks['rows'][$i]);
1189           $row .= CRM_Utils_Array::value('merge', $contactLinks['rows'][$i]);
1190           $row .= '    </td>';
1191           $row .= '  </tr>   ';
1192         }
1193
1194         $duplicateContactsLinks .= $row . '</table>';
1195         $duplicateContactsLinks .= ts("If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.");
1196
1197         $errors['_qf_default'] = $duplicateContactsLinks;
1198
1199         // let smarty know that there are duplicates
1200         $template = CRM_Core_Smarty::singleton();
1201         $template->assign('isDuplicate', 1);
1202       }
1203       elseif (!empty($fields['_qf_Contact_refresh_dedupe'])) {
1204         // add a session message for no matching contacts
1205         CRM_Core_Session::setStatus(ts('No matching contact found.'), ts('None Found'), 'info');
1206       }
1207     }
1208   }
1209
1210   /**
1211    * Use the form name to create the tpl file name.
1212    *
1213    * @return string
1214    */
1215   public function getTemplateFileName() {
1216     if ($this->_contactSubType) {
1217       $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
1218       $template = CRM_Core_Form::getTemplate();
1219       if ($template->template_exists($templateFile)) {
1220         return $templateFile;
1221       }
1222     }
1223     return parent::getTemplateFileName();
1224   }
1225
1226   /**
1227    * Parse all address blocks present in given params
1228    * and return parse result for all address blocks,
1229    * This function either parse street address in to child
1230    * elements or build street address from child elements.
1231    *
1232    * @param array $params
1233    *   of key value consist of address blocks.
1234    *
1235    * @return array
1236    *   as array of success/fails for each address block
1237    */
1238   public function parseAddress(&$params) {
1239     $parseSuccess = $parsedFields = [];
1240     if (!is_array($params['address']) ||
1241       CRM_Utils_System::isNull($params['address'])
1242     ) {
1243       return $parseSuccess;
1244     }
1245
1246     foreach ($params['address'] as $instance => & $address) {
1247       $buildStreetAddress = FALSE;
1248       $parseFieldName = 'street_address';
1249       foreach ([
1250         'street_number',
1251         'street_name',
1252         'street_unit',
1253       ] as $fld) {
1254         if (!empty($address[$fld])) {
1255           $parseFieldName = 'street_number';
1256           $buildStreetAddress = TRUE;
1257           break;
1258         }
1259       }
1260
1261       // main parse string.
1262       $parseString = $address[$parseFieldName] ?? NULL;
1263
1264       // parse address field.
1265       $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($parseString);
1266
1267       if ($buildStreetAddress) {
1268         //hack to ignore spaces between number and suffix.
1269         //here user gives input as street_number so it has to
1270         //be street_number and street_number_suffix, but
1271         //due to spaces though preg detect string as street_name
1272         //consider it as 'street_number_suffix'.
1273         $suffix = $parsedFields['street_number_suffix'];
1274         if (!$suffix) {
1275           $suffix = $parsedFields['street_name'];
1276         }
1277         $address['street_number_suffix'] = $suffix;
1278         $address['street_number'] = $parsedFields['street_number'];
1279
1280         $streetAddress = NULL;
1281         foreach ([
1282           'street_number',
1283           'street_number_suffix',
1284           'street_name',
1285           'street_unit',
1286         ] as $fld) {
1287           if (in_array($fld, [
1288             'street_name',
1289             'street_unit',
1290           ])) {
1291             $streetAddress .= ' ';
1292           }
1293           // CRM-17619 - if the street number suffix begins with a number, add a space
1294           $thesuffix = $address['street_number_suffix'] ?? NULL;
1295           if ($fld === 'street_number_suffix' && $thesuffix) {
1296             if (ctype_digit(substr($thesuffix, 0, 1))) {
1297               $streetAddress .= ' ';
1298             }
1299           }
1300           $streetAddress .= CRM_Utils_Array::value($fld, $address);
1301         }
1302         $address['street_address'] = trim($streetAddress);
1303         $parseSuccess[$instance] = TRUE;
1304       }
1305       else {
1306         $success = TRUE;
1307         // consider address is automatically parseable,
1308         // when we should found street_number and street_name
1309         if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) {
1310           $success = FALSE;
1311         }
1312
1313         // check for original street address string.
1314         if (empty($parseString)) {
1315           $success = TRUE;
1316         }
1317
1318         $parseSuccess[$instance] = $success;
1319
1320         // we do not reset element values, but keep what we've parsed
1321         // in case of partial matches: CRM-8378
1322
1323         // merge parse address in to main address block.
1324         $address = array_merge($address, $parsedFields);
1325       }
1326     }
1327
1328     return $parseSuccess;
1329   }
1330
1331   /**
1332    * Check parse result and if some address block fails then this
1333    * function return the status message for all address blocks.
1334    *
1335    * @param array $parseResult
1336    *   An array of address blk instance and its status.
1337    *
1338    * @return null|string
1339    *   $statusMsg   string status message for all address blocks.
1340    */
1341   public static function parseAddressStatusMsg($parseResult) {
1342     $statusMsg = NULL;
1343     if (!is_array($parseResult) || empty($parseResult)) {
1344       return $statusMsg;
1345     }
1346
1347     $parseFails = [];
1348     foreach ($parseResult as $instance => $success) {
1349       if (!$success) {
1350         $parseFails[] = self::ordinalNumber($instance);
1351       }
1352     }
1353
1354     if (!empty($parseFails)) {
1355       $statusMsg = ts("Complete street address(es) have been saved. However we were unable to split the address in the %1 address block(s) into address elements (street number, street name, street unit) due to an unrecognized address format. You can set the address elements manually by clicking 'Edit Address Elements' next to the Street Address field while in edit mode.",
1356         [1 => implode(', ', $parseFails)]
1357       );
1358     }
1359
1360     return $statusMsg;
1361   }
1362
1363   /**
1364    * Convert normal number to ordinal number format.
1365    * like 1 => 1st, 2 => 2nd and so on...
1366    *
1367    * @param int $number
1368    *   number to convert in to ordinal number.
1369    *
1370    * @return string
1371    *   ordinal number for given number.
1372    */
1373   public static function ordinalNumber($number) {
1374     if (empty($number)) {
1375       return NULL;
1376     }
1377
1378     $str = 'th';
1379     switch (floor($number / 10) % 10) {
1380       case 1:
1381       default:
1382         switch ($number % 10) {
1383           case 1:
1384             $str = 'st';
1385             break;
1386
1387           case 2:
1388             $str = 'nd';
1389             break;
1390
1391           case 3:
1392             $str = 'rd';
1393             break;
1394         }
1395     }
1396
1397     return "$number$str";
1398   }
1399
1400 }