CRM/Contact/Import/Parser/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 use Civi\Api4\Contact;
  13
  14 require_once 'CRM/Utils/DeprecatedUtils.php';
  15 require_once 'api/v3/utils.php';
  16
  17 /**
  18  *
  19  * @package CRM
  20  * @copyright CiviCRM LLC https://civicrm.org/licensing
  21  */
  22
  23 /**
  24  * class to parse contact csv files
  25  */
  26 class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser {
  27
  28   use CRM_Contact_Import_MetadataTrait;
  29
  30   protected $_mapperKeys = [];
  31   protected $_mapperLocType = [];
  32   protected $_mapperPhoneType;
  33   protected $_mapperImProvider;
  34   protected $_mapperWebsiteType;
  35   protected $_mapperRelated;
  36   protected $_mapperRelatedContactType;
  37   protected $_mapperRelatedContactDetails;
  38   protected $_mapperRelatedContactEmailType;
  39   protected $_mapperRelatedContactImProvider;
  40   protected $_mapperRelatedContactWebsiteType;
  41   protected $_relationships;
  42
  43   protected $_emailIndex;
  44   protected $_firstNameIndex;
  45   protected $_lastNameIndex;
  46
  47   protected $_householdNameIndex;
  48   protected $_organizationNameIndex;
  49
  50   protected $_allEmails;
  51
  52   protected $_phoneIndex;
  53
  54   /**
  55    * Is update only permitted on an id match.
  56    *
  57    * Note this historically was true for when id or external identifier was
  58    * present. However, CRM-17275 determined that a dedupe-match could over-ride
  59    * external identifier.
  60    *
  61    * @var bool
  62    */
  63   protected $_updateWithId;
  64   protected $_retCode;
  65
  66   protected $_externalIdentifierIndex;
  67   protected $_allExternalIdentifiers;
  68   protected $_parseStreetAddress;
  69
  70   /**
  71    * Array of successfully imported contact id's
  72    *
  73    * @var array
  74    */
  75   protected $_newContacts;
  76
  77   /**
  78    * Line count id.
  79    *
  80    * @var int
  81    */
  82   protected $_lineCount;
  83
  84   /**
  85    * Array of successfully imported related contact id's
  86    *
  87    * @var array
  88    */
  89   protected $_newRelatedContacts;
  90
  91   /**
  92    * Array of all the contacts whose street addresses are not parsed.
  93    * of this import process
  94    * @var array
  95    */
  96   protected $_unparsedStreetAddressContacts;
  97
  98   /**
  99    * Class constructor.
 100    *
 101    * @param array $mapperKeys
 102    * @param array $mapperLocType
 103    * @param array $mapperPhoneType
 104    * @param array $mapperImProvider
 105    * @param array $mapperRelated
 106    * @param array $mapperRelatedContactType
 107    * @param array $mapperRelatedContactDetails
 108    * @param array $mapperRelatedContactLocType
 109    * @param array $mapperRelatedContactPhoneType
 110    * @param array $mapperRelatedContactImProvider
 111    * @param array $mapperWebsiteType
 112    * @param array $mapperRelatedContactWebsiteType
 113    */
 114   public function __construct(
 115     $mapperKeys, $mapperLocType = [], $mapperPhoneType = [], $mapperImProvider = [], $mapperRelated = [], $mapperRelatedContactType = [], $mapperRelatedContactDetails = [], $mapperRelatedContactLocType = [], $mapperRelatedContactPhoneType = [], $mapperRelatedContactImProvider = [],
 116     $mapperWebsiteType = [], $mapperRelatedContactWebsiteType = []
 117   ) {
 118     parent::__construct();
 119     $this->_mapperKeys = $mapperKeys;
 120     $this->_mapperLocType = &$mapperLocType;
 121     $this->_mapperPhoneType = &$mapperPhoneType;
 122     $this->_mapperWebsiteType = $mapperWebsiteType;
 123     // get IM service provider type id for contact
 124     $this->_mapperImProvider = &$mapperImProvider;
 125     $this->_mapperRelated = &$mapperRelated;
 126     $this->_mapperRelatedContactType = &$mapperRelatedContactType;
 127     $this->_mapperRelatedContactDetails = &$mapperRelatedContactDetails;
 128     $this->_mapperRelatedContactLocType = &$mapperRelatedContactLocType;
 129     $this->_mapperRelatedContactPhoneType = &$mapperRelatedContactPhoneType;
 130     $this->_mapperRelatedContactWebsiteType = $mapperRelatedContactWebsiteType;
 131     // get IM service provider type id for related contact
 132     $this->_mapperRelatedContactImProvider = &$mapperRelatedContactImProvider;
 133   }
 134
 135   /**
 136    * The initializer code, called before processing.
 137    */
 138   public function init() {
 139     $this->setFieldMetadata();
 140     foreach ($this->getImportableFieldsMetadata() as $name => $field) {
 141       $this->addField($name, $field['title'], CRM_Utils_Array::value('type', $field), CRM_Utils_Array::value('headerPattern', $field), CRM_Utils_Array::value('dataPattern', $field), CRM_Utils_Array::value('hasLocationType', $field));
 142     }
 143
 144     $this->_newContacts = [];
 145
 146     $this->setActiveFields($this->_mapperKeys);
 147     $this->setActiveFieldLocationTypes($this->_mapperLocType);
 148     $this->setActiveFieldPhoneTypes($this->_mapperPhoneType);
 149     $this->setActiveFieldWebsiteTypes($this->_mapperWebsiteType);
 150     //set active fields of IM provider of contact
 151     $this->setActiveFieldImProviders($this->_mapperImProvider);
 152
 153     //related info
 154     $this->setActiveFieldRelated($this->_mapperRelated);
 155     $this->setActiveFieldRelatedContactType($this->_mapperRelatedContactType);
 156     $this->setActiveFieldRelatedContactDetails($this->_mapperRelatedContactDetails);
 157     $this->setActiveFieldRelatedContactLocType($this->_mapperRelatedContactLocType);
 158     $this->setActiveFieldRelatedContactPhoneType($this->_mapperRelatedContactPhoneType);
 159     $this->setActiveFieldRelatedContactWebsiteType($this->_mapperRelatedContactWebsiteType);
 160     //set active fields of IM provider of related contact
 161     $this->setActiveFieldRelatedContactImProvider($this->_mapperRelatedContactImProvider);
 162
 163     $this->_phoneIndex = -1;
 164     $this->_emailIndex = -1;
 165     $this->_firstNameIndex = -1;
 166     $this->_lastNameIndex = -1;
 167     $this->_householdNameIndex = -1;
 168     $this->_organizationNameIndex = -1;
 169     $this->_externalIdentifierIndex = -1;
 170
 171     $index = 0;
 172     foreach ($this->_mapperKeys as $key) {
 173       if (substr($key, 0, 5) == 'email' && substr($key, 0, 14) != 'email_greeting') {
 174         $this->_emailIndex = $index;
 175         $this->_allEmails = [];
 176       }
 177       if (substr($key, 0, 5) == 'phone') {
 178         $this->_phoneIndex = $index;
 179       }
 180       if ($key == 'first_name') {
 181         $this->_firstNameIndex = $index;
 182       }
 183       if ($key == 'last_name') {
 184         $this->_lastNameIndex = $index;
 185       }
 186       if ($key == 'household_name') {
 187         $this->_householdNameIndex = $index;
 188       }
 189       if ($key == 'organization_name') {
 190         $this->_organizationNameIndex = $index;
 191       }
 192
 193       if ($key == 'external_identifier') {
 194         $this->_externalIdentifierIndex = $index;
 195         $this->_allExternalIdentifiers = [];
 196       }
 197       $index++;
 198     }
 199
 200     $this->_updateWithId = FALSE;
 201     if (in_array('id', $this->_mapperKeys) || ($this->_externalIdentifierIndex >= 0 && in_array($this->_onDuplicate, [
 202       CRM_Import_Parser::DUPLICATE_UPDATE,
 203       CRM_Import_Parser::DUPLICATE_FILL,
 204     ]))) {
 205       $this->_updateWithId = TRUE;
 206     }
 207
 208     $this->_parseStreetAddress = CRM_Utils_Array::value('street_address_parsing', CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'address_options'), FALSE);
 209   }
 210
 211   /**
 212    * Handle the values in mapField mode.
 213    *
 214    * @param array $values
 215    *   The array of values belonging to this line.
 216    *
 217    * @return bool
 218    */
 219   public function mapField(&$values) {
 220     return CRM_Import_Parser::VALID;
 221   }
 222
 223   /**
 224    * Handle the values in preview mode.
 225    *
 226    * @param array $values
 227    *   The array of values belonging to this line.
 228    *
 229    * @return bool
 230    *   the result of this processing
 231    */
 232   public function preview(&$values) {
 233     return $this->summary($values);
 234   }
 235
 236   /**
 237    * Handle the values in summary mode.
 238    *
 239    * @param array $values
 240    *   The array of values belonging to this line.
 241    *
 242    * @return bool
 243    *   the result of this processing
 244    */
 245   public function summary(&$values): int {
 246     $erroneousField = NULL;
 247     $this->setActiveFieldValues($values, $erroneousField);
 248     $rowNumber = (int) ($values[count($values) - 1]);
 249     $errorMessage = NULL;
 250     $errorRequired = FALSE;
 251     switch ($this->_contactType) {
 252       case 'Individual':
 253         $missingNames = [];
 254         if ($this->_firstNameIndex < 0 || empty($values[$this->_firstNameIndex])) {
 255           $errorRequired = TRUE;
 256           $missingNames[] = ts('First Name');
 257         }
 258         if ($this->_lastNameIndex < 0 || empty($values[$this->_lastNameIndex])) {
 259           $errorRequired = TRUE;
 260           $missingNames[] = ts('Last Name');
 261         }
 262         if ($errorRequired) {
 263           $and = ' ' . ts('and') . ' ';
 264           $errorMessage = ts('Missing required fields:') . ' ' . implode($and, $missingNames);
 265         }
 266         break;
 267
 268       case 'Household':
 269         if ($this->_householdNameIndex < 0 || empty($values[$this->_householdNameIndex])) {
 270           $errorRequired = TRUE;
 271           $errorMessage = ts('Missing required fields:') . ' ' . ts('Household Name');
 272         }
 273         break;
 274
 275       case 'Organization':
 276         if ($this->_organizationNameIndex < 0 || empty($values[$this->_organizationNameIndex])) {
 277           $errorRequired = TRUE;
 278           $errorMessage = ts('Missing required fields:') . ' ' . ts('Organization Name');
 279         }
 280         break;
 281     }
 282
 283     if ($this->_emailIndex >= 0) {
 284       /* If we don't have the required fields, bail */
 285
 286       if ($this->_contactType === 'Individual' && !$this->_updateWithId) {
 287         if ($errorRequired && empty($values[$this->_emailIndex])) {
 288           if ($errorMessage) {
 289             $errorMessage .= ' ' . ts('OR') . ' ' . ts('Email Address');
 290           }
 291           else {
 292             $errorMessage = ts('Missing required field:') . ' ' . ts('Email Address');
 293           }
 294           array_unshift($values, $errorMessage);
 295           $this->setImportStatus($rowNumber, 'ERROR', $errorMessage);
 296
 297           return CRM_Import_Parser::ERROR;
 298         }
 299       }
 300
 301       $email = $values[$this->_emailIndex] ?? NULL;
 302       if ($email) {
 303         /* If the email address isn't valid, bail */
 304
 305         if (!CRM_Utils_Rule::email($email)) {
 306           $errorMessage = ts('Invalid Email address');
 307           array_unshift($values, $errorMessage);
 308           $this->setImportStatus($rowNumber, 'ERROR', $errorMessage);
 309
 310           return CRM_Import_Parser::ERROR;
 311         }
 312
 313         /* otherwise, count it and move on */
 314         $this->_allEmails[$email] = $this->_lineCount;
 315       }
 316     }
 317     elseif ($errorRequired && !$this->_updateWithId) {
 318       if ($errorMessage) {
 319         $errorMessage .= ' ' . ts('OR') . ' ' . ts('Email Address');
 320       }
 321       else {
 322         $errorMessage = ts('Missing required field:') . ' ' . ts('Email Address');
 323       }
 324       array_unshift($values, $errorMessage);
 325       $this->setImportStatus($rowNumber, 'ERROR', $errorMessage);
 326
 327       return CRM_Import_Parser::ERROR;
 328     }
 329
 330     //check for duplicate external Identifier
 331     $externalID = $values[$this->_externalIdentifierIndex] ?? NULL;
 332     if ($externalID) {
 333       /* If it's a dupe,external Identifier  */
 334
 335       if ($externalDupe = CRM_Utils_Array::value($externalID, $this->_allExternalIdentifiers)) {
 336         $errorMessage = ts('External ID conflicts with record %1', [1 => $externalDupe]);
 337         array_unshift($values, $errorMessage);
 338         $this->setImportStatus($rowNumber, 'ERROR', $errorMessage);
 339         return CRM_Import_Parser::ERROR;
 340       }
 341       //otherwise, count it and move on
 342       $this->_allExternalIdentifiers[$externalID] = $this->_lineCount;
 343     }
 344
 345     //Checking error in custom data
 346     $params = &$this->getActiveFieldParams();
 347     $params['contact_type'] = $this->_contactType;
 348     //date-format part ends
 349
 350     $errorMessage = NULL;
 351
 352     //CRM-5125
 353     //add custom fields for contact sub type
 354     $csType = NULL;
 355     if (!empty($this->_contactSubType)) {
 356       $csType = $this->_contactSubType;
 357     }
 358
 359     //checking error in custom data
 360     $this->isErrorInCustomData($params, $errorMessage, $csType, $this->_relationships);
 361
 362     //checking error in core data
 363     $this->isErrorInCoreData($params, $errorMessage);
 364     if ($errorMessage) {
 365       $tempMsg = "Invalid value for field(s) : $errorMessage";
 366       $this->setImportStatus($rowNumber, 'ERROR', $tempMsg);
 367       array_unshift($values, $tempMsg);
 368       $errorMessage = NULL;
 369       return CRM_Import_Parser::ERROR;
 370     }
 371     $this->setImportStatus($rowNumber, 'NEW', '');
 372
 373     return CRM_Import_Parser::VALID;
 374   }
 375
 376   /**
 377    * Get Array of all the fields that could potentially be part
 378    * import process
 379    *
 380    * @return array
 381    */
 382   public function getAllFields() {
 383     return $this->_fields;
 384   }
 385
 386   /**
 387    * Handle the values in import mode.
 388    *
 389    * @param int $onDuplicate
 390    *   The code for what action to take on duplicates.
 391    * @param array $values
 392    *   The array of values belonging to this line.
 393    *
 394    * @param bool $doGeocodeAddress
 395    *
 396    * @return bool
 397    *   the result of this processing
 398    *
 399    * @throws \CiviCRM_API3_Exception
 400    * @throws \CRM_Core_Exception
 401    * @throws \API_Exception
 402    */
 403   public function import($onDuplicate, &$values, $doGeocodeAddress = FALSE) {
 404     $this->_unparsedStreetAddressContacts = [];
 405     if (!$doGeocodeAddress) {
 406       // CRM-5854, reset the geocode method to null to prevent geocoding
 407       CRM_Utils_GeocodeProvider::disableForSession();
 408     }
 409
 410     // first make sure this is a valid line
 411     //$this->_updateWithId = false;
 412     $response = $this->summary($values);
 413     $statusFieldName = $this->_statusFieldName;
 414
 415     if ($response != CRM_Import_Parser::VALID) {
 416       $importRecordParams = [
 417         $statusFieldName => 'INVALID',
 418         "${statusFieldName}Msg" => "Invalid (Error Code: $response)",
 419       ];
 420       $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
 421       return $response;
 422     }
 423
 424     $params = &$this->getActiveFieldParams();
 425     $formatted = [
 426       'contact_type' => $this->_contactType,
 427     ];
 428
 429     $contactFields = CRM_Contact_DAO_Contact::import();
 430
 431     //check if external identifier exists in database
 432     if (!empty($params['external_identifier']) && (!empty($params['id']) || in_array($onDuplicate, [
 433       CRM_Import_Parser::DUPLICATE_SKIP,
 434       CRM_Import_Parser::DUPLICATE_NOCHECK,
 435     ]))) {
 436
 437       $extIDResult = civicrm_api3('Contact', 'get', [
 438         'external_identifier' => $params['external_identifier'],
 439         'showAll' => 'all',
 440         'return' => ['id', 'contact_is_deleted'],
 441       ]);
 442       if (isset($extIDResult['id'])) {
 443         // record with matching external identifier does exist.
 444         $internalCid = $extIDResult['id'];
 445         if ($internalCid != CRM_Utils_Array::value('id', $params)) {
 446           if ($extIDResult['values'][$internalCid]['contact_is_deleted'] == 1) {
 447             // And it is deleted. What to do? If we skip it, they user
 448             // will be under the impression that the record exists in
 449             // the database, yet they won't be able to find it. If we
 450             // don't skip it, the database will try to insert a new record
 451             // with an external_identifier that is non-unique. So...
 452             // we will update this contact to remove the external_identifier
 453             // and let a new record be created.
 454             $update_params = ['id' => $internalCid, 'external_identifier' => ''];
 455             civicrm_api3('Contact', 'create', $update_params);
 456           }
 457           else {
 458             $errorMessage = ts('External ID already exists in Database.');
 459             array_unshift($values, $errorMessage);
 460             $importRecordParams = [
 461               $statusFieldName => 'ERROR',
 462               "${statusFieldName}Msg" => $errorMessage,
 463             ];
 464             $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
 465             return CRM_Import_Parser::DUPLICATE;
 466           }
 467         }
 468       }
 469     }
 470
 471     if (!empty($this->_contactSubType)) {
 472       $params['contact_sub_type'] = $this->_contactSubType;
 473     }
 474
 475     if ($subType = CRM_Utils_Array::value('contact_sub_type', $params)) {
 476       if (CRM_Contact_BAO_ContactType::isExtendsContactType($subType, $this->_contactType, FALSE, 'label')) {
 477         $subTypes = CRM_Contact_BAO_ContactType::subTypePairs($this->_contactType, FALSE, NULL);
 478         $params['contact_sub_type'] = array_search($subType, $subTypes);
 479       }
 480       elseif (!CRM_Contact_BAO_ContactType::isExtendsContactType($subType, $this->_contactType)) {
 481         $message = "Mismatched or Invalid Contact Subtype.";
 482         array_unshift($values, $message);
 483         return CRM_Import_Parser::NO_MATCH;
 484       }
 485     }
 486
 487     // Get contact id to format common data in update/fill mode,
 488     // prioritising a dedupe rule check over an external_identifier check, but falling back on ext id.
 489     if ($this->_updateWithId && empty($params['id'])) {
 490       try {
 491         $possibleMatches = $this->getPossibleContactMatches($params);
 492       }
 493       catch (CRM_Core_Exception $e) {
 494         $errorMessage = $e->getMessage();
 495         array_unshift($values, $errorMessage);
 496
 497         $importRecordParams = [
 498           $statusFieldName => 'ERROR',
 499           "${statusFieldName}Msg" => $errorMessage,
 500         ];
 501         $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
 502         return CRM_Import_Parser::ERROR;
 503       }
 504       foreach ($possibleMatches as $possibleID) {
 505         $params['id'] = $formatted['id'] = $possibleID;
 506       }
 507     }
 508     //format common data, CRM-4062
 509     $this->formatCommonData($params, $formatted, $contactFields);
 510
 511     $relationship = FALSE;
 512     $createNewContact = TRUE;
 513     // Support Match and Update Via Contact ID
 514     if ($this->_updateWithId && isset($params['id'])) {
 515       $createNewContact = FALSE;
 516       // @todo - it feels like all the rows from here to the end of the IF
 517       // could be removed in favour of a simple check for whether the contact_type & id match
 518       $matchedIDs = $this->getIdsOfMatchingContacts($formatted);
 519       if (!empty($matchedIDs)) {
 520         if (count($matchedIDs) >= 1) {
 521           $updateflag = TRUE;
 522           foreach ($matchedIDs as $contactId) {
 523             if ($params['id'] == $contactId) {
 524               $contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params['id'], 'contact_type');
 525               if ($formatted['contact_type'] == $contactType) {
 526                 //validation of subtype for update mode
 527                 //CRM-5125
 528                 $contactSubType = NULL;
 529                 if (!empty($params['contact_sub_type'])) {
 530                   $contactSubType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params['id'], 'contact_sub_type');
 531                 }
 532
 533                 if (!empty($contactSubType) && (!CRM_Contact_BAO_ContactType::isAllowEdit($params['id'], $contactSubType) && $contactSubType != CRM_Utils_Array::value('contact_sub_type', $formatted))) {
 534
 535                   $message = "Mismatched contact SubTypes :";
 536                   array_unshift($values, $message);
 537                   $updateflag = FALSE;
 538                   $this->_retCode = CRM_Import_Parser::NO_MATCH;
 539                 }
 540                 else {
 541                   $updateflag = FALSE;
 542                   $this->_retCode = CRM_Import_Parser::VALID;
 543                 }
 544               }
 545               else {
 546                 $message = "Mismatched contact Types :";
 547                 array_unshift($values, $message);
 548                 $updateflag = FALSE;
 549                 $this->_retCode = CRM_Import_Parser::NO_MATCH;
 550               }
 551             }
 552           }
 553           if ($updateflag) {
 554             $message = "Mismatched contact IDs OR Mismatched contact Types :";
 555             array_unshift($values, $message);
 556             $this->_retCode = CRM_Import_Parser::NO_MATCH;
 557           }
 558         }
 559       }
 560       else {
 561         $contactType = NULL;
 562         if (!empty($params['id'])) {
 563           $contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params['id'], 'contact_type');
 564           if ($contactType) {
 565             if ($formatted['contact_type'] == $contactType) {
 566               //validation of subtype for update mode
 567               //CRM-5125
 568               $contactSubType = NULL;
 569               if (!empty($params['contact_sub_type'])) {
 570                 $contactSubType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params['id'], 'contact_sub_type');
 571               }
 572
 573               if (!empty($contactSubType) && (!CRM_Contact_BAO_ContactType::isAllowEdit($params['id'], $contactSubType) && $contactSubType != CRM_Utils_Array::value('contact_sub_type', $formatted))) {
 574
 575                 $message = "Mismatched contact SubTypes :";
 576                 array_unshift($values, $message);
 577                 $this->_retCode = CRM_Import_Parser::NO_MATCH;
 578               }
 579               else {
 580                 $newContact = $this->createContact($formatted, $contactFields, $onDuplicate, $params['id'], FALSE, $this->_dedupeRuleGroupID);
 581                 $this->_retCode = CRM_Import_Parser::VALID;
 582               }
 583             }
 584             else {
 585               $message = "Mismatched contact Types :";
 586               array_unshift($values, $message);
 587               $this->_retCode = CRM_Import_Parser::NO_MATCH;
 588             }
 589           }
 590           else {
 591             // we should avoid multiple errors for single record
 592             // since we have already retCode and we trying to force again.
 593             if ($this->_retCode != CRM_Import_Parser::NO_MATCH) {
 594               $message = "No contact found for this contact ID:" . $params['id'];
 595               array_unshift($values, $message);
 596               $this->_retCode = CRM_Import_Parser::NO_MATCH;
 597             }
 598           }
 599         }
 600         else {
 601           //CRM-4148
 602           //now we want to create new contact on update/fill also.
 603           $createNewContact = TRUE;
 604         }
 605       }
 606
 607       if (isset($newContact) && is_a($newContact, 'CRM_Contact_BAO_Contact')) {
 608         $relationship = TRUE;
 609       }
 610     }
 611
 612     //fixed CRM-4148
 613     //now we create new contact in update/fill mode also.
 614     $contactID = NULL;
 615     if ($createNewContact || ($this->_retCode != CRM_Import_Parser::NO_MATCH && $this->_updateWithId)) {
 616       // @todo - there are multiple places where formatting is done that need consolidation.
 617       // This handles where the label has been passed in and it has gotten this far.
 618       // probably a bunch of hard-coded stuff could be removed to rely on this.
 619       $fields = Contact::getFields(FALSE)
 620         ->addWhere('options', '=', TRUE)
 621         ->setLoadOptions(TRUE)
 622         ->execute()->indexBy('name');
 623       foreach ($fields as $fieldName => $fieldSpec) {
 624         if (isset($formatted[$fieldName]) && is_array($formatted[$fieldName])) {
 625           // If we have an array at this stage, it's probably a multi-select
 626           // field that has already been parsed properly into the value that
 627           // should be inserted into the database.
 628           continue;
 629         }
 630         if (!empty($formatted[$fieldName])
 631           && empty($fieldSpec['options'][$formatted[$fieldName]])) {
 632           $formatted[$fieldName] = array_search($formatted[$fieldName], $fieldSpec['options'], TRUE) ?? $formatted[$fieldName];
 633         }
 634       }
 635       //CRM-4430, don't carry if not submitted.
 636       if ($this->_updateWithId && !empty($params['id'])) {
 637         $contactID = $params['id'];
 638       }
 639       $newContact = $this->createContact($formatted, $contactFields, $onDuplicate, $contactID, TRUE, $this->_dedupeRuleGroupID);
 640     }
 641
 642     if (isset($newContact) && is_object($newContact) && ($newContact instanceof CRM_Contact_BAO_Contact)) {
 643       $relationship = TRUE;
 644       $newContact = clone($newContact);
 645       $contactID = $newContact->id;
 646       $this->_newContacts[] = $contactID;
 647
 648       //get return code if we create new contact in update mode, CRM-4148
 649       if ($this->_updateWithId) {
 650         $this->_retCode = CRM_Import_Parser::VALID;
 651       }
 652     }
 653     elseif (isset($newContact) && CRM_Core_Error::isAPIError($newContact, CRM_Core_Error::DUPLICATE_CONTACT)) {
 654       // if duplicate, no need of further processing
 655       if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) {
 656         $errorMessage = "Skipping duplicate record";
 657         array_unshift($values, $errorMessage);
 658         $importRecordParams = [
 659           $statusFieldName => 'DUPLICATE',
 660           "${statusFieldName}Msg" => $errorMessage,
 661         ];
 662         $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
 663         return CRM_Import_Parser::DUPLICATE;
 664       }
 665
 666       $relationship = TRUE;
 667       // CRM-10433/CRM-20739 - IDs could be string or array; handle accordingly
 668       if (!is_array($dupeContactIDs = $newContact['error_message']['params'][0])) {
 669         $dupeContactIDs = explode(',', $dupeContactIDs);
 670       }
 671       $dupeCount = count($dupeContactIDs);
 672       $contactID = array_pop($dupeContactIDs);
 673       // check to see if we had more than one duplicate contact id.
 674       // if we have more than one, the record will be rejected below
 675       if ($dupeCount == 1) {
 676         // there was only one dupe, we will continue normally...
 677         if (!in_array($contactID, $this->_newContacts)) {
 678           $this->_newContacts[] = $contactID;
 679         }
 680       }
 681     }
 682
 683     if ($contactID) {
 684       // call import hook
 685       $currentImportID = end($values);
 686
 687       $hookParams = [
 688         'contactID' => $contactID,
 689         'importID' => $currentImportID,
 690         'importTempTable' => $this->_tableName,
 691         'fieldHeaders' => $this->_mapperKeys,
 692         'fields' => $this->_activeFields,
 693       ];
 694
 695       CRM_Utils_Hook::import('Contact', 'process', $this, $hookParams);
 696     }
 697
 698     if ($relationship) {
 699       $primaryContactId = NULL;
 700       if (CRM_Core_Error::isAPIError($newContact, CRM_Core_ERROR::DUPLICATE_CONTACT)) {
 701         if ($dupeCount == 1 && CRM_Utils_Rule::integer($contactID)) {
 702           $primaryContactId = $contactID;
 703         }
 704       }
 705       else {
 706         $primaryContactId = $newContact->id;
 707       }
 708
 709       if ((CRM_Core_Error::isAPIError($newContact, CRM_Core_ERROR::DUPLICATE_CONTACT) || is_a($newContact, 'CRM_Contact_BAO_Contact')) && $primaryContactId) {
 710
 711         //relationship contact insert
 712         foreach ($params as $key => $field) {
 713           [$id, $first, $second] = CRM_Utils_System::explode('_', $key, 3);
 714           if (!($first == 'a' && $second == 'b') && !($first == 'b' && $second == 'a')) {
 715             continue;
 716           }
 717
 718           $relationType = new CRM_Contact_DAO_RelationshipType();
 719           $relationType->id = $id;
 720           $relationType->find(TRUE);
 721           $direction = "contact_sub_type_$second";
 722
 723           $formatting = [
 724             'contact_type' => $params[$key]['contact_type'],
 725           ];
 726
 727           //set subtype for related contact CRM-5125
 728           if (isset($relationType->$direction)) {
 729             //validation of related contact subtype for update mode
 730             if ($relCsType = CRM_Utils_Array::value('contact_sub_type', $params[$key]) && $relCsType != $relationType->$direction) {
 731               $errorMessage = ts("Mismatched or Invalid contact subtype found for this related contact.");
 732               array_unshift($values, $errorMessage);
 733               return CRM_Import_Parser::NO_MATCH;
 734             }
 735             else {
 736               $formatting['contact_sub_type'] = $relationType->$direction;
 737             }
 738           }
 739
 740           $contactFields = NULL;
 741           $contactFields = CRM_Contact_DAO_Contact::import();
 742
 743           //Relation on the basis of External Identifier.
 744           if (empty($params[$key]['id']) && !empty($params[$key]['external_identifier'])) {
 745             $params[$key]['id'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params[$key]['external_identifier'], 'id', 'external_identifier');
 746           }
 747           // check for valid related contact id in update/fill mode, CRM-4424
 748           if (in_array($onDuplicate, [
 749             CRM_Import_Parser::DUPLICATE_UPDATE,
 750             CRM_Import_Parser::DUPLICATE_FILL,
 751           ]) && !empty($params[$key]['id'])) {
 752             $relatedContactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params[$key]['id'], 'contact_type');
 753             if (!$relatedContactType) {
 754               $errorMessage = ts("No contact found for this related contact ID: %1", [1 => $params[$key]['id']]);
 755               array_unshift($values, $errorMessage);
 756               return CRM_Import_Parser::NO_MATCH;
 757             }
 758
 759             //validation of related contact subtype for update mode
 760             //CRM-5125
 761             $relatedCsType = NULL;
 762             if (!empty($formatting['contact_sub_type'])) {
 763               $relatedCsType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $params[$key]['id'], 'contact_sub_type');
 764             }
 765
 766             if (!empty($relatedCsType) && (!CRM_Contact_BAO_ContactType::isAllowEdit($params[$key]['id'], $relatedCsType) &&
 767                 $relatedCsType != CRM_Utils_Array::value('contact_sub_type', $formatting))
 768             ) {
 769               $errorMessage = ts("Mismatched or Invalid contact subtype found for this related contact.") . ' ' . ts("ID: %1", [1 => $params[$key]['id']]);
 770               array_unshift($values, $errorMessage);
 771               return CRM_Import_Parser::NO_MATCH;
 772             }
 773             // get related contact id to format data in update/fill mode,
 774             //if external identifier is present, CRM-4423
 775             $formatting['id'] = $params[$key]['id'];
 776           }
 777
 778           //format common data, CRM-4062
 779           $this->formatCommonData($field, $formatting, $contactFields);
 780
 781           //do we have enough fields to create related contact.
 782           $allowToCreate = $this->checkRelatedContactFields($key, $formatting);
 783
 784           if (!$allowToCreate) {
 785             $errorMessage = ts('Related contact required fields are missing.');
 786             array_unshift($values, $errorMessage);
 787             return CRM_Import_Parser::NO_MATCH;
 788           }
 789
 790           //fixed for CRM-4148
 791           if (!empty($params[$key]['id'])) {
 792             $contact = [
 793               'contact_id' => $params[$key]['id'],
 794             ];
 795             $defaults = [];
 796             $relatedNewContact = CRM_Contact_BAO_Contact::retrieve($contact, $defaults);
 797           }
 798           else {
 799             $relatedNewContact = $this->createContact($formatting, $contactFields, $onDuplicate, NULL, FALSE);
 800           }
 801
 802           if (is_object($relatedNewContact) || ($relatedNewContact instanceof CRM_Contact_BAO_Contact)) {
 803             $relatedNewContact = clone($relatedNewContact);
 804           }
 805
 806           $matchedIDs = [];
 807           // To update/fill contact, get the matching contact Ids if duplicate contact found
 808           // otherwise get contact Id from object of related contact
 809           if (is_array($relatedNewContact) && civicrm_error($relatedNewContact)) {
 810             if (CRM_Core_Error::isAPIError($relatedNewContact, CRM_Core_ERROR::DUPLICATE_CONTACT)) {
 811               $matchedIDs = $relatedNewContact['error_message']['params'][0];
 812               if (!is_array($matchedIDs)) {
 813                 $matchedIDs = explode(',', $matchedIDs);
 814               }
 815             }
 816             else {
 817               $errorMessage = $relatedNewContact['error_message'];
 818               array_unshift($values, $errorMessage);
 819               $importRecordParams = [
 820                 $statusFieldName => 'ERROR',
 821                 "${statusFieldName}Msg" => $errorMessage,
 822               ];
 823               $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
 824               return CRM_Import_Parser::ERROR;
 825             }
 826           }
 827           else {
 828             $matchedIDs[] = $relatedNewContact->id;
 829           }
 830           // update/fill related contact after getting matching Contact Ids, CRM-4424
 831           if (in_array($onDuplicate, [
 832             CRM_Import_Parser::DUPLICATE_UPDATE,
 833             CRM_Import_Parser::DUPLICATE_FILL,
 834           ])) {
 835             //validation of related contact subtype for update mode
 836             //CRM-5125
 837             $relatedCsType = NULL;
 838             if (!empty($formatting['contact_sub_type'])) {
 839               $relatedCsType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $matchedIDs[0], 'contact_sub_type');
 840             }
 841
 842             if (!empty($relatedCsType) && (!CRM_Contact_BAO_ContactType::isAllowEdit($matchedIDs[0], $relatedCsType) && $relatedCsType != CRM_Utils_Array::value('contact_sub_type', $formatting))) {
 843               $errorMessage = ts("Mismatched or Invalid contact subtype found for this related contact.");
 844               array_unshift($values, $errorMessage);
 845               return CRM_Import_Parser::NO_MATCH;
 846             }
 847             else {
 848               $updatedContact = $this->createContact($formatting, $contactFields, $onDuplicate, $matchedIDs[0]);
 849             }
 850           }
 851           static $relativeContact = [];
 852           if (CRM_Core_Error::isAPIError($relatedNewContact, CRM_Core_ERROR::DUPLICATE_CONTACT)) {
 853             if (count($matchedIDs) >= 1) {
 854               $relContactId = $matchedIDs[0];
 855               //add relative contact to count during update & fill mode.
 856               //logic to make count distinct by contact id.
 857               if ($this->_newRelatedContacts || !empty($relativeContact)) {
 858                 $reContact = array_keys($relativeContact, $relContactId);
 859
 860                 if (empty($reContact)) {
 861                   $this->_newRelatedContacts[] = $relativeContact[] = $relContactId;
 862                 }
 863               }
 864               else {
 865                 $this->_newRelatedContacts[] = $relativeContact[] = $relContactId;
 866               }
 867             }
 868           }
 869           else {
 870             $relContactId = $relatedNewContact->id;
 871             $this->_newRelatedContacts[] = $relativeContact[] = $relContactId;
 872           }
 873
 874           if (CRM_Core_Error::isAPIError($relatedNewContact, CRM_Core_ERROR::DUPLICATE_CONTACT) || ($relatedNewContact instanceof CRM_Contact_BAO_Contact)) {
 875             //fix for CRM-1993.Checks for duplicate related contacts
 876             if (count($matchedIDs) >= 1) {
 877               //if more than one duplicate contact
 878               //found, create relationship with first contact
 879               // now create the relationship record
 880               $relationParams = [];
 881               $relationParams = [
 882                 'relationship_type_id' => $key,
 883                 'contact_check' => [
 884                   $relContactId => 1,
 885                 ],
 886                 'is_active' => 1,
 887                 'skipRecentView' => TRUE,
 888               ];
 889
 890               // we only handle related contact success, we ignore failures for now
 891               // at some point wold be nice to have related counts as separate
 892               $relationIds = [
 893                 'contact' => $primaryContactId,
 894               ];
 895
 896               [$valid, $invalid, $duplicate, $saved, $relationshipIds] = CRM_Contact_BAO_Relationship::legacyCreateMultiple($relationParams, $relationIds);
 897
 898               if ($valid || $duplicate) {
 899                 $relationIds['contactTarget'] = $relContactId;
 900                 $action = ($duplicate) ? CRM_Core_Action::UPDATE : CRM_Core_Action::ADD;
 901                 CRM_Contact_BAO_Relationship::relatedMemberships($primaryContactId, $relationParams, $relationIds, $action);
 902               }
 903
 904               //handle current employer, CRM-3532
 905               if ($valid) {
 906                 $allRelationships = CRM_Core_PseudoConstant::relationshipType('name');
 907                 $relationshipTypeId = str_replace([
 908                   '_a_b',
 909                   '_b_a',
 910                 ], [
 911                   '',
 912                   '',
 913                 ], $key);
 914                 $relationshipType = str_replace($relationshipTypeId . '_', '', $key);
 915                 $orgId = $individualId = NULL;
 916                 if ($allRelationships[$relationshipTypeId]["name_{$relationshipType}"] == 'Employee of') {
 917                   $orgId = $relContactId;
 918                   $individualId = $primaryContactId;
 919                 }
 920                 elseif ($allRelationships[$relationshipTypeId]["name_{$relationshipType}"] == 'Employer of') {
 921                   $orgId = $primaryContactId;
 922                   $individualId = $relContactId;
 923                 }
 924                 if ($orgId && $individualId) {
 925                   $currentEmpParams[$individualId] = $orgId;
 926                   CRM_Contact_BAO_Contact_Utils::setCurrentEmployer($currentEmpParams);
 927                 }
 928               }
 929             }
 930           }
 931         }
 932       }
 933     }
 934     if ($this->_updateWithId) {
 935       //return warning if street address is unparsed, CRM-5886
 936       return $this->processMessage($values, $statusFieldName, $this->_retCode);
 937     }
 938     //dupe checking
 939     if (is_array($newContact) && civicrm_error($newContact)) {
 940       $code = NULL;
 941
 942       if (($code = CRM_Utils_Array::value('code', $newContact['error_message'])) && ($code == CRM_Core_Error::DUPLICATE_CONTACT)) {
 943         return $this->handleDuplicateError($newContact, $statusFieldName, $values, $onDuplicate, $formatted, $contactFields);
 944       }
 945       // Not a dupe, so we had an error
 946       $errorMessage = $newContact['error_message'];
 947       array_unshift($values, $errorMessage);
 948       $importRecordParams = [
 949         $statusFieldName => 'ERROR',
 950         "${statusFieldName}Msg" => $errorMessage,
 951       ];
 952       $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
 953       return CRM_Import_Parser::ERROR;
 954
 955     }
 956     // sleep(3);
 957     return $this->processMessage($values, $statusFieldName, CRM_Import_Parser::VALID);
 958   }
 959
 960   /**
 961    * Get the array of successfully imported contact id's
 962    *
 963    * @return array
 964    */
 965   public function getImportedContacts() {
 966     return $this->_newContacts;
 967   }
 968
 969   /**
 970    * Get the array of successfully imported related contact id's
 971    *
 972    * @return array
 973    */
 974   public function &getRelatedImportedContacts() {
 975     return $this->_newRelatedContacts;
 976   }
 977
 978   /**
 979    * The initializer code, called before the processing.
 980    */
 981   public function fini() {
 982   }
 983
 984   /**
 985    * Check if an error in custom data.
 986    *
 987    * @param array $params
 988    * @param string $errorMessage
 989    *   A string containing all the error-fields.
 990    *
 991    * @param null $csType
 992    * @param null $relationships
 993    */
 994   public static function isErrorInCustomData($params, &$errorMessage, $csType = NULL, $relationships = NULL) {
 995     $dateType = CRM_Core_Session::singleton()->get("dateTypes");
 996
 997     if (!empty($params['contact_sub_type'])) {
 998       $csType = $params['contact_sub_type'] ?? NULL;
 999     }
1000
1001     if (empty($params['contact_type'])) {
1002       $params['contact_type'] = 'Individual';
1003     }
1004
1005     // get array of subtypes - CRM-18708
1006     if (in_array($csType, ['Individual', 'Organization', 'Household'])) {
1007       $csType = self::getSubtypes($params['contact_type']);
1008     }
1009
1010     if (is_array($csType)) {
1011       // fetch custom fields for every subtype and add it to $customFields array
1012       // CRM-18708
1013       $customFields = [];
1014       foreach ($csType as $cType) {
1015         $customFields += CRM_Core_BAO_CustomField::getFields($params['contact_type'], FALSE, FALSE, $cType);
1016       }
1017     }
1018     else {
1019       $customFields = CRM_Core_BAO_CustomField::getFields($params['contact_type'], FALSE, FALSE, $csType);
1020     }
1021
1022     $addressCustomFields = CRM_Core_BAO_CustomField::getFields('Address');
1023     $customFields = $customFields + $addressCustomFields;
1024     foreach ($params as $key => $value) {
1025       if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
1026         /* check if it's a valid custom field id */
1027
1028         if (!array_key_exists($customFieldID, $customFields)) {
1029           self::addToErrorMsg(ts('field ID'), $errorMessage);
1030         }
1031         // validate null values for required custom fields of type boolean
1032         if (!empty($customFields[$customFieldID]['is_required']) && (empty($params['custom_' . $customFieldID]) && !is_numeric($params['custom_' . $customFieldID])) && $customFields[$customFieldID]['data_type'] == 'Boolean') {
1033           self::addToErrorMsg($customFields[$customFieldID]['label'] . '::' . $customFields[$customFieldID]['groupTitle'], $errorMessage);
1034         }
1035
1036         //For address custom fields, we do get actual custom field value as an inner array of
1037         //values so need to modify
1038         if (array_key_exists($customFieldID, $addressCustomFields)) {
1039           $value = $value[0][$key];
1040         }
1041         /* validate the data against the CF type */
1042
1043         if ($value) {
1044           $dataType = $customFields[$customFieldID]['data_type'];
1045           $htmlType = $customFields[$customFieldID]['html_type'];
1046           $isSerialized = CRM_Core_BAO_CustomField::isSerialized($customFields[$customFieldID]);
1047           if ($dataType == 'Date') {
1048             if (array_key_exists($customFieldID, $addressCustomFields) && CRM_Utils_Date::convertToDefaultDate($params[$key][0], $dateType, $key)) {
1049               $value = $params[$key][0][$key];
1050             }
1051             elseif (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
1052               $value = $params[$key];
1053             }
1054             else {
1055               self::addToErrorMsg($customFields[$customFieldID]['label'], $errorMessage);
1056             }
1057           }
1058           elseif ($dataType == 'Boolean') {
1059             if (CRM_Utils_String::strtoboolstr($value) === FALSE) {
1060               self::addToErrorMsg($customFields[$customFieldID]['label'] . '::' . $customFields[$customFieldID]['groupTitle'], $errorMessage);
1061             }
1062           }
1063           // need not check for label filed import
1064           $selectHtmlTypes = [
1065             'CheckBox',
1066             'Select',
1067             'Radio',
1068           ];
1069           if ((!$isSerialized && !in_array($htmlType, $selectHtmlTypes)) || $dataType == 'Boolean' || $dataType == 'ContactReference') {
1070             $valid = CRM_Core_BAO_CustomValue::typecheck($dataType, $value);
1071             if (!$valid) {
1072               self::addToErrorMsg($customFields[$customFieldID]['label'], $errorMessage);
1073             }
1074           }
1075
1076           // check for values for custom fields for checkboxes and multiselect
1077           if ($isSerialized && $dataType != 'ContactReference') {
1078             $value = trim($value);
1079             $value = str_replace('|', ',', $value);
1080             $mulValues = explode(',', $value);
1081             $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
1082             foreach ($mulValues as $v1) {
1083               if (strlen($v1) == 0) {
1084                 continue;
1085               }
1086
1087               $flag = FALSE;
1088               foreach ($customOption as $v2) {
1089                 if ((strtolower(trim($v2['label'])) == strtolower(trim($v1))) || (strtolower(trim($v2['value'])) == strtolower(trim($v1)))) {
1090                   $flag = TRUE;
1091                 }
1092               }
1093
1094               if (!$flag) {
1095                 self::addToErrorMsg($customFields[$customFieldID]['label'], $errorMessage);
1096               }
1097             }
1098           }
1099           elseif ($htmlType == 'Select' || ($htmlType == 'Radio' && $dataType != 'Boolean')) {
1100             $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
1101             $flag = FALSE;
1102             foreach ($customOption as $v2) {
1103               if ((strtolower(trim($v2['label'])) == strtolower(trim($value))) || (strtolower(trim($v2['value'])) == strtolower(trim($value)))) {
1104                 $flag = TRUE;
1105               }
1106             }
1107             if (!$flag) {
1108               self::addToErrorMsg($customFields[$customFieldID]['label'], $errorMessage);
1109             }
1110           }
1111           elseif ($isSerialized && $dataType === 'StateProvince') {
1112             $mulValues = explode(',', $value);
1113             foreach ($mulValues as $stateValue) {
1114               if ($stateValue) {
1115                 if (self::in_value(trim($stateValue), CRM_Core_PseudoConstant::stateProvinceAbbreviation()) || self::in_value(trim($stateValue), CRM_Core_PseudoConstant::stateProvince())) {
1116                   continue;
1117                 }
1118                 else {
1119                   self::addToErrorMsg($customFields[$customFieldID]['label'], $errorMessage);
1120                 }
1121               }
1122             }
1123           }
1124           elseif ($isSerialized && $dataType == 'Country') {
1125             $mulValues = explode(',', $value);
1126             foreach ($mulValues as $countryValue) {
1127               if ($countryValue) {
1128                 CRM_Core_PseudoConstant::populate($countryNames, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active');
1129                 CRM_Core_PseudoConstant::populate($countryIsoCodes, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
1130                 $limitCodes = CRM_Core_BAO_Country::countryLimit();
1131
1132                 $error = TRUE;
1133                 foreach ([
1134                   $countryNames,
1135                   $countryIsoCodes,
1136                   $limitCodes,
1137                 ] as $values) {
1138                   if (in_array(trim($countryValue), $values)) {
1139                     $error = FALSE;
1140                     break;
1141                   }
1142                 }
1143
1144                 if ($error) {
1145                   self::addToErrorMsg($customFields[$customFieldID]['label'], $errorMessage);
1146                 }
1147               }
1148             }
1149           }
1150         }
1151       }
1152       elseif (is_array($params[$key]) && isset($params[$key]["contact_type"])) {
1153         //CRM-5125
1154         //supporting custom data of related contact subtypes
1155         $relation = NULL;
1156         if ($relationships) {
1157           if (array_key_exists($key, $relationships)) {
1158             $relation = $key;
1159           }
1160           elseif (CRM_Utils_Array::key($key, $relationships)) {
1161             $relation = CRM_Utils_Array::key($key, $relationships);
1162           }
1163         }
1164         if (!empty($relation)) {
1165           [$id, $first, $second] = CRM_Utils_System::explode('_', $relation, 3);
1166           $direction = "contact_sub_type_$second";
1167           $relationshipType = new CRM_Contact_BAO_RelationshipType();
1168           $relationshipType->id = $id;
1169           if ($relationshipType->find(TRUE)) {
1170             if (isset($relationshipType->$direction)) {
1171               $params[$key]['contact_sub_type'] = $relationshipType->$direction;
1172             }
1173           }
1174         }
1175
1176         self::isErrorInCustomData($params[$key], $errorMessage, $csType, $relationships);
1177       }
1178     }
1179   }
1180
1181   /**
1182    * Check if value present in all genders or.
1183    * as a substring of any gender value, if yes than return corresponding gender.
1184    * eg value might be  m/M, ma/MA, mal/MAL, male return 'Male'
1185    * but if value is 'maleabc' than return false
1186    *
1187    * @param string $gender
1188    *   Check this value across gender values.
1189    *
1190    * retunr gender value / false
1191    *
1192    * @return bool
1193    */
1194   public function checkGender($gender) {
1195     $gender = trim($gender, '.');
1196     if (!$gender) {
1197       return FALSE;
1198     }
1199
1200     $allGenders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
1201     foreach ($allGenders as $key => $value) {
1202       if (strlen($gender) > strlen($value)) {
1203         continue;
1204       }
1205       if ($gender == $value) {
1206         return $value;
1207       }
1208       if (substr_compare($value, $gender, 0, strlen($gender), TRUE) === 0) {
1209         return $value;
1210       }
1211     }
1212
1213     return FALSE;
1214   }
1215
1216   /**
1217    * Check if an error in Core( non-custom fields ) field
1218    *
1219    * @param array $params
1220    * @param string $errorMessage
1221    *   A string containing all the error-fields.
1222    */
1223   public function isErrorInCoreData($params, &$errorMessage) {
1224     foreach ($params as $key => $value) {
1225       if ($value) {
1226         $session = CRM_Core_Session::singleton();
1227         $dateType = $session->get("dateTypes");
1228
1229         switch ($key) {
1230           case 'birth_date':
1231             if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
1232               if (!CRM_Utils_Rule::date($params[$key])) {
1233                 self::addToErrorMsg(ts('Birth Date'), $errorMessage);
1234               }
1235             }
1236             else {
1237               self::addToErrorMsg(ts('Birth-Date'), $errorMessage);
1238             }
1239             break;
1240
1241           case 'deceased_date':
1242             if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
1243               if (!CRM_Utils_Rule::date($params[$key])) {
1244                 self::addToErrorMsg(ts('Deceased Date'), $errorMessage);
1245               }
1246             }
1247             else {
1248               self::addToErrorMsg(ts('Deceased Date'), $errorMessage);
1249             }
1250             break;
1251
1252           case 'is_deceased':
1253             if (CRM_Utils_String::strtoboolstr($value) === FALSE) {
1254               self::addToErrorMsg(ts('Deceased'), $errorMessage);
1255             }
1256             break;
1257
1258           case 'gender_id':
1259             if (!self::checkGender($value)) {
1260               self::addToErrorMsg(ts('Gender'), $errorMessage);
1261             }
1262             break;
1263
1264           case 'preferred_communication_method':
1265             $preffComm = [];
1266             $preffComm = explode(',', $value);
1267             foreach ($preffComm as $v) {
1268               if (!self::in_value(trim($v), CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method'))) {
1269                 self::addToErrorMsg(ts('Preferred Communication Method'), $errorMessage);
1270               }
1271             }
1272             break;
1273
1274           case 'preferred_mail_format':
1275             if (!array_key_exists(strtolower($value), array_change_key_case(CRM_Core_SelectValues::pmf(), CASE_LOWER))) {
1276               self::addToErrorMsg(ts('Preferred Mail Format'), $errorMessage);
1277             }
1278             break;
1279
1280           case 'individual_prefix':
1281           case 'prefix_id':
1282             if (!self::in_value($value, CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id'))) {
1283               self::addToErrorMsg(ts('Individual Prefix'), $errorMessage);
1284             }
1285             break;
1286
1287           case 'individual_suffix':
1288           case 'suffix_id':
1289             if (!self::in_value($value, CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id'))) {
1290               self::addToErrorMsg(ts('Individual Suffix'), $errorMessage);
1291             }
1292             break;
1293
1294           case 'state_province':
1295             if (!empty($value)) {
1296               foreach ($value as $stateValue) {
1297                 if ($stateValue['state_province']) {
1298                   if (self::in_value($stateValue['state_province'], CRM_Core_PseudoConstant::stateProvinceAbbreviation()) ||
1299                     self::in_value($stateValue['state_province'], CRM_Core_PseudoConstant::stateProvince())
1300                   ) {
1301                     continue;
1302                   }
1303                   else {
1304                     self::addToErrorMsg(ts('State/Province'), $errorMessage);
1305                   }
1306                 }
1307               }
1308             }
1309             break;
1310
1311           case 'country':
1312             if (!empty($value)) {
1313               foreach ($value as $stateValue) {
1314                 if ($stateValue['country']) {
1315                   CRM_Core_PseudoConstant::populate($countryNames, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active');
1316                   CRM_Core_PseudoConstant::populate($countryIsoCodes, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
1317                   $limitCodes = CRM_Core_BAO_Country::countryLimit();
1318                   //If no country is selected in
1319                   //localization then take all countries
1320                   if (empty($limitCodes)) {
1321                     $limitCodes = $countryIsoCodes;
1322                   }
1323
1324                   if (self::in_value($stateValue['country'], $limitCodes) || self::in_value($stateValue['country'], CRM_Core_PseudoConstant::country())) {
1325                     continue;
1326                   }
1327                   if (self::in_value($stateValue['country'], $countryIsoCodes) || self::in_value($stateValue['country'], $countryNames)) {
1328                     self::addToErrorMsg(ts('Country input value is in table but not "available": "This Country is valid but is NOT in the list of Available Countries currently configured for your site. This can be viewed and modifed from Administer > Localization > Languages Currency Locations." '), $errorMessage);
1329                   }
1330                   else {
1331                     self::addToErrorMsg(ts('Country input value not in country table: "The Country value appears to be invalid. It does not match any value in CiviCRM table of countries."'), $errorMessage);
1332                   }
1333                 }
1334               }
1335             }
1336             break;
1337
1338           case 'county':
1339             if (!empty($value)) {
1340               foreach ($value as $county) {
1341                 if ($county['county']) {
1342                   $countyNames = CRM_Core_PseudoConstant::county();
1343                   if (!empty($county['county']) && !in_array($county['county'], $countyNames)) {
1344                     self::addToErrorMsg(ts('County input value not in county table: The County value appears to be invalid. It does not match any value in CiviCRM table of counties.'), $errorMessage);
1345                   }
1346                 }
1347               }
1348             }
1349             break;
1350
1351           case 'geo_code_1':
1352             if (!empty($value)) {
1353               foreach ($value as $codeValue) {
1354                 if (!empty($codeValue['geo_code_1'])) {
1355                   if (CRM_Utils_Rule::numeric($codeValue['geo_code_1'])) {
1356                     continue;
1357                   }
1358                   self::addToErrorMsg(ts('Geo code 1'), $errorMessage);
1359                 }
1360               }
1361             }
1362             break;
1363
1364           case 'geo_code_2':
1365             if (!empty($value)) {
1366               foreach ($value as $codeValue) {
1367                 if (!empty($codeValue['geo_code_2'])) {
1368                   if (CRM_Utils_Rule::numeric($codeValue['geo_code_2'])) {
1369                     continue;
1370                   }
1371                   self::addToErrorMsg(ts('Geo code 2'), $errorMessage);
1372                 }
1373               }
1374             }
1375             break;
1376
1377           //check for any error in email/postal greeting, addressee,
1378           //custom email/postal greeting, custom addressee, CRM-4575
1379
1380           case 'email_greeting':
1381             $emailGreetingFilter = [
1382               'contact_type' => $this->_contactType,
1383               'greeting_type' => 'email_greeting',
1384             ];
1385             if (!self::in_value($value, CRM_Core_PseudoConstant::greeting($emailGreetingFilter))) {
1386               self::addToErrorMsg(ts('Email Greeting must be one of the configured format options. Check Administer >> System Settings >> Option Groups >> Email Greetings for valid values'), $errorMessage);
1387             }
1388             break;
1389
1390           case 'postal_greeting':
1391             $postalGreetingFilter = [
1392               'contact_type' => $this->_contactType,
1393               'greeting_type' => 'postal_greeting',
1394             ];
1395             if (!self::in_value($value, CRM_Core_PseudoConstant::greeting($postalGreetingFilter))) {
1396               self::addToErrorMsg(ts('Postal Greeting must be one of the configured format options. Check Administer >> System Settings >> Option Groups >> Postal Greetings for valid values'), $errorMessage);
1397             }
1398             break;
1399
1400           case 'addressee':
1401             $addresseeFilter = [
1402               'contact_type' => $this->_contactType,
1403               'greeting_type' => 'addressee',
1404             ];
1405             if (!self::in_value($value, CRM_Core_PseudoConstant::greeting($addresseeFilter))) {
1406               self::addToErrorMsg(ts('Addressee must be one of the configured format options. Check Administer >> System Settings >> Option Groups >> Addressee for valid values'), $errorMessage);
1407             }
1408             break;
1409
1410           case 'email_greeting_custom':
1411             if (array_key_exists('email_greeting', $params)) {
1412               $emailGreetingLabel = key(CRM_Core_OptionGroup::values('email_greeting', TRUE, NULL, NULL, 'AND v.name = "Customized"'));
1413               if (CRM_Utils_Array::value('email_greeting', $params) != $emailGreetingLabel) {
1414                 self::addToErrorMsg(ts('Email Greeting - Custom'), $errorMessage);
1415               }
1416             }
1417             break;
1418
1419           case 'postal_greeting_custom':
1420             if (array_key_exists('postal_greeting', $params)) {
1421               $postalGreetingLabel = key(CRM_Core_OptionGroup::values('postal_greeting', TRUE, NULL, NULL, 'AND v.name = "Customized"'));
1422               if (CRM_Utils_Array::value('postal_greeting', $params) != $postalGreetingLabel) {
1423                 self::addToErrorMsg(ts('Postal Greeting - Custom'), $errorMessage);
1424               }
1425             }
1426             break;
1427
1428           case 'addressee_custom':
1429             if (array_key_exists('addressee', $params)) {
1430               $addresseeLabel = key(CRM_Core_OptionGroup::values('addressee', TRUE, NULL, NULL, 'AND v.name = "Customized"'));
1431               if (CRM_Utils_Array::value('addressee', $params) != $addresseeLabel) {
1432                 self::addToErrorMsg(ts('Addressee - Custom'), $errorMessage);
1433               }
1434             }
1435             break;
1436
1437           case 'url':
1438             if (is_array($value)) {
1439               foreach ($value as $values) {
1440                 if (!empty($values['url']) && !CRM_Utils_Rule::url($values['url'])) {
1441                   self::addToErrorMsg(ts('Website'), $errorMessage);
1442                   break;
1443                 }
1444               }
1445             }
1446             break;
1447
1448           case 'do_not_email':
1449           case 'do_not_phone':
1450           case 'do_not_mail':
1451           case 'do_not_sms':
1452           case 'do_not_trade':
1453             if (CRM_Utils_Rule::boolean($value) == FALSE) {
1454               $key = ucwords(str_replace("_", " ", $key));
1455               self::addToErrorMsg($key, $errorMessage);
1456             }
1457             break;
1458
1459           case 'email':
1460             if (is_array($value)) {
1461               foreach ($value as $values) {
1462                 if (!empty($values['email']) && !CRM_Utils_Rule::email($values['email'])) {
1463                   self::addToErrorMsg($key, $errorMessage);
1464                   break;
1465                 }
1466               }
1467             }
1468             break;
1469
1470           default:
1471             if (is_array($params[$key]) && isset($params[$key]["contact_type"])) {
1472               //check for any relationship data ,FIX ME
1473               self::isErrorInCoreData($params[$key], $errorMessage);
1474             }
1475         }
1476       }
1477     }
1478   }
1479
1480   /**
1481    * Ckeck a value present or not in a array.
1482    *
1483    * @param $value
1484    * @param $valueArray
1485    *
1486    * @return bool
1487    */
1488   public static function in_value($value, $valueArray) {
1489     foreach ($valueArray as $key => $v) {
1490       //fix for CRM-1514
1491       if (strtolower(trim($v, ".")) == strtolower(trim($value, "."))) {
1492         return TRUE;
1493       }
1494     }
1495     return FALSE;
1496   }
1497
1498   /**
1499    * Build error-message containing error-fields
1500    *
1501    * Once upon a time there was a dev who hadn't heard of implode. That dev wrote this function.
1502    *
1503    * @todo just say no!
1504    *
1505    * @param string $errorName
1506    *   A string containing error-field name.
1507    * @param string $errorMessage
1508    *   A string containing all the error-fields, where the new errorName is concatenated.
1509    *
1510    */
1511   public static function addToErrorMsg($errorName, &$errorMessage) {
1512     if ($errorMessage) {
1513       $errorMessage .= "; $errorName";
1514     }
1515     else {
1516       $errorMessage = $errorName;
1517     }
1518   }
1519
1520   /**
1521    * Method for creating contact.
1522    *
1523    * @param array $formatted
1524    * @param array $contactFields
1525    * @param int $onDuplicate
1526    * @param int $contactId
1527    * @param bool $requiredCheck
1528    * @param int $dedupeRuleGroupID
1529    *
1530    * @return array|bool|\CRM_Contact_BAO_Contact|\CRM_Core_Error|null
1531    */
1532   public function createContact(&$formatted, &$contactFields, $onDuplicate, $contactId = NULL, $requiredCheck = TRUE, $dedupeRuleGroupID = NULL) {
1533     $dupeCheck = FALSE;
1534     $newContact = NULL;
1535
1536     if (is_null($contactId) && ($onDuplicate != CRM_Import_Parser::DUPLICATE_NOCHECK)) {
1537       $dupeCheck = (bool) ($onDuplicate);
1538     }
1539
1540     //get the prefix id etc if exists
1541     CRM_Contact_BAO_Contact::resolveDefaults($formatted, TRUE);
1542
1543     //@todo direct call to API function not supported.
1544     // setting required check to false, CRM-2839
1545     // plus we do our own required check in import
1546     try {
1547       $error = $this->deprecated_contact_check_params($formatted, $dupeCheck, $dedupeRuleGroupID);
1548       if ($error) {
1549         return $error;
1550       }
1551       $this->deprecated_validate_formatted_contact($formatted);
1552     }
1553     catch (CRM_Core_Exception $e) {
1554       return ['error_message' => $e->getMessage(), 'is_error' => 1, 'code' => $e->getCode()];
1555     }
1556
1557     if ($contactId) {
1558       $this->formatParams($formatted, $onDuplicate, (int) $contactId);
1559     }
1560
1561     // Resetting and rebuilding cache could be expensive.
1562     CRM_Core_Config::setPermitCacheFlushMode(FALSE);
1563
1564     // If a user has logged in, or accessed via a checksum
1565     // Then deliberately 'blanking' a value in the profile should remove it from their record
1566     // @todo this should either be TRUE or FALSE in the context of import - once
1567     // we figure out which we can remove all the rest.
1568     // Also note the meaning of this parameter is less than it used to
1569     // be following block cleanup.
1570     $formatted['updateBlankLocInfo'] = TRUE;
1571     if ((CRM_Core_Session::singleton()->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0) {
1572       $formatted['updateBlankLocInfo'] = FALSE;
1573     }
1574
1575     [$data, $contactDetails] = CRM_Contact_BAO_Contact::formatProfileContactParams($formatted, $contactFields, $contactId, NULL, $formatted['contact_type']);
1576
1577     // manage is_opt_out
1578     if (array_key_exists('is_opt_out', $contactFields) && array_key_exists('is_opt_out', $formatted)) {
1579       $wasOptOut = $contactDetails['is_opt_out'] ?? FALSE;
1580       $isOptOut = $formatted['is_opt_out'];
1581       $data['is_opt_out'] = $isOptOut;
1582       // on change, create new civicrm_subscription_history entry
1583       if (($wasOptOut != $isOptOut) && !empty($contactDetails['contact_id'])) {
1584         $shParams = [
1585           'contact_id' => $contactDetails['contact_id'],
1586           'status' => $isOptOut ? 'Removed' : 'Added',
1587           'method' => 'Web',
1588         ];
1589         CRM_Contact_BAO_SubscriptionHistory::create($shParams);
1590       }
1591     }
1592
1593     $contact = civicrm_api3('Contact', 'create', $data);
1594     $cid = $contact['id'];
1595
1596     CRM_Core_Config::setPermitCacheFlushMode(TRUE);
1597
1598     $contact = [
1599       'contact_id' => $cid,
1600     ];
1601
1602     $defaults = [];
1603     $newContact = CRM_Contact_BAO_Contact::retrieve($contact, $defaults);
1604
1605     //get the id of the contact whose street address is not parsable, CRM-5886
1606     if ($this->_parseStreetAddress && is_object($newContact) && property_exists($newContact, 'address') && $newContact->address) {
1607       foreach ($newContact->address as $address) {
1608         if (!empty($address['street_address']) && (empty($address['street_number']) || empty($address['street_name']))) {
1609           $this->_unparsedStreetAddressContacts[] = [
1610             'id' => $newContact->id,
1611             'streetAddress' => $address['street_address'],
1612           ];
1613         }
1614       }
1615     }
1616     return $newContact;
1617   }
1618
1619   /**
1620    * Format params for update and fill mode.
1621    *
1622    * @param array $params
1623    *   reference to an array containing all the.
1624    *   values for import
1625    * @param int $onDuplicate
1626    * @param int $cid
1627    *   contact id.
1628    */
1629   public function formatParams(&$params, $onDuplicate, $cid) {
1630     if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) {
1631       return;
1632     }
1633
1634     $contactParams = [
1635       'contact_id' => $cid,
1636     ];
1637
1638     $defaults = [];
1639     $contactObj = CRM_Contact_BAO_Contact::retrieve($contactParams, $defaults);
1640
1641     $modeFill = ($onDuplicate == CRM_Import_Parser::DUPLICATE_FILL);
1642
1643     $groupTree = CRM_Core_BAO_CustomGroup::getTree($params['contact_type'], NULL, $cid, 0, NULL);
1644     CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $defaults, FALSE, FALSE);
1645
1646     $locationFields = [
1647       'email' => 'email',
1648       'phone' => 'phone',
1649       'im' => 'name',
1650       'website' => 'website',
1651       'address' => 'address',
1652     ];
1653
1654     $contact = get_object_vars($contactObj);
1655
1656     foreach ($params as $key => $value) {
1657       if ($key == 'id' || $key == 'contact_type') {
1658         continue;
1659       }
1660
1661       if (array_key_exists($key, $locationFields)) {
1662         continue;
1663       }
1664       if (in_array($key, [
1665         'email_greeting',
1666         'postal_greeting',
1667         'addressee',
1668       ])) {
1669         // CRM-4575, need to null custom
1670         if ($params["{$key}_id"] != 4) {
1671           $params["{$key}_custom"] = 'null';
1672         }
1673         unset($params[$key]);
1674       }
1675       else {
1676         if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($key)) {
1677           $custom_params = ['id' => $contact['id'], 'return' => $key];
1678           $getValue = civicrm_api3('Contact', 'getvalue', $custom_params);
1679           if (empty($getValue)) {
1680             unset($getValue);
1681           }
1682         }
1683         else {
1684           $getValue = CRM_Utils_Array::retrieveValueRecursive($contact, $key);
1685         }
1686         if ($key == 'contact_source') {
1687           $params['source'] = $params[$key];
1688           unset($params[$key]);
1689         }
1690
1691         if ($modeFill && isset($getValue)) {
1692           unset($params[$key]);
1693           if ($customFieldId) {
1694             // Extra values must be unset to ensure the values are not
1695             // imported.
1696             unset($params['custom'][$customFieldId]);
1697           }
1698         }
1699       }
1700     }
1701
1702     foreach ($locationFields as $locKeys) {
1703       if (isset($params[$locKeys]) && is_array($params[$locKeys])) {
1704         foreach ($params[$locKeys] as $key => $value) {
1705           if ($modeFill) {
1706             $getValue = CRM_Utils_Array::retrieveValueRecursive($contact, $locKeys);
1707
1708             if (isset($getValue)) {
1709               foreach ($getValue as $cnt => $values) {
1710                 if ($locKeys == 'website') {
1711                   if (($getValue[$cnt]['website_type_id'] == $params[$locKeys][$key]['website_type_id'])) {
1712                     unset($params[$locKeys][$key]);
1713                   }
1714                 }
1715                 else {
1716                   if ((!empty($getValue[$cnt]['location_type_id']) && !empty($params[$locKeys][$key]['location_type_id'])) && $getValue[$cnt]['location_type_id'] == $params[$locKeys][$key]['location_type_id']) {
1717                     unset($params[$locKeys][$key]);
1718                   }
1719                 }
1720               }
1721             }
1722           }
1723         }
1724         if (count($params[$locKeys]) == 0) {
1725           unset($params[$locKeys]);
1726         }
1727       }
1728     }
1729   }
1730
1731   /**
1732    * Convert any given date string to default date array.
1733    *
1734    * @param array $params
1735    *   Has given date-format.
1736    * @param array $formatted
1737    *   Store formatted date in this array.
1738    * @param int $dateType
1739    *   Type of date.
1740    * @param string $dateParam
1741    *   Index of params.
1742    */
1743   public static function formatCustomDate(&$params, &$formatted, $dateType, $dateParam) {
1744     //fix for CRM-2687
1745     CRM_Utils_Date::convertToDefaultDate($params, $dateType, $dateParam);
1746     $formatted[$dateParam] = CRM_Utils_Date::processDate($params[$dateParam]);
1747   }
1748
1749   /**
1750    * Generate status and error message for unparsed street address records.
1751    *
1752    * @param array $values
1753    *   The array of values belonging to each row.
1754    * @param array $statusFieldName
1755    *   Store formatted date in this array.
1756    * @param $returnCode
1757    *
1758    * @return int
1759    */
1760   public function processMessage(&$values, $statusFieldName, $returnCode) {
1761     if (empty($this->_unparsedStreetAddressContacts)) {
1762       $importRecordParams = [
1763         $statusFieldName => 'IMPORTED',
1764       ];
1765     }
1766     else {
1767       $errorMessage = ts("Record imported successfully but unable to parse the street address: ");
1768       foreach ($this->_unparsedStreetAddressContacts as $contactInfo => $contactValue) {
1769         $contactUrl = CRM_Utils_System::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contactValue['id'], TRUE, NULL, FALSE);
1770         $errorMessage .= "\n Contact ID:" . $contactValue['id'] . " <a href=\"$contactUrl\"> " . $contactValue['streetAddress'] . "</a>";
1771       }
1772       array_unshift($values, $errorMessage);
1773       $importRecordParams = [
1774         $statusFieldName => 'ERROR',
1775         "${statusFieldName}Msg" => $errorMessage,
1776       ];
1777       $returnCode = CRM_Import_Parser::UNPARSED_ADDRESS_WARNING;
1778     }
1779     $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
1780     return $returnCode;
1781   }
1782
1783   /**
1784    * @param $relKey
1785    * @param array $params
1786    *
1787    * @return bool
1788    */
1789   public function checkRelatedContactFields($relKey, $params) {
1790     //avoid blank contact creation.
1791     $allowToCreate = FALSE;
1792
1793     //build the mapper field array.
1794     static $relatedContactFields = [];
1795     if (!isset($relatedContactFields[$relKey])) {
1796       foreach ($this->_mapperRelated as $key => $name) {
1797         if (!$name) {
1798           continue;
1799         }
1800
1801         if (!empty($relatedContactFields[$name]) && !is_array($relatedContactFields[$name])) {
1802           $relatedContactFields[$name] = [];
1803         }
1804         $fldName = $this->_mapperRelatedContactDetails[$key] ?? NULL;
1805         if ($fldName == 'url') {
1806           $fldName = 'website';
1807         }
1808         if ($fldName) {
1809           $relatedContactFields[$name][] = $fldName;
1810         }
1811       }
1812     }
1813
1814     //validate for passed data.
1815     if (is_array($relatedContactFields[$relKey])) {
1816       foreach ($relatedContactFields[$relKey] as $fld) {
1817         if (!empty($params[$fld])) {
1818           $allowToCreate = TRUE;
1819           break;
1820         }
1821       }
1822     }
1823
1824     return $allowToCreate;
1825   }
1826
1827   /**
1828    * get subtypes given the contact type
1829    *
1830    * @param string $contactType
1831    * @return array $subTypes
1832    */
1833   public static function getSubtypes($contactType) {
1834     $subTypes = [];
1835     $types = CRM_Contact_BAO_ContactType::subTypeInfo($contactType);
1836
1837     if (count($types) > 0) {
1838       foreach ($types as $type) {
1839         $subTypes[] = $type['name'];
1840       }
1841     }
1842     return $subTypes;
1843   }
1844
1845   /**
1846    * Get the possible contact matches.
1847    *
1848    * 1) the chosen dedupe rule falling back to
1849    * 2) a check for the external ID.
1850    *
1851    * @see https://issues.civicrm.org/jira/browse/CRM-17275
1852    *
1853    * @param array $params
1854    *
1855    * @return array
1856    *   IDs of possible matches.
1857    *
1858    * @throws \CRM_Core_Exception
1859    * @throws \CiviCRM_API3_Exception
1860    */
1861   protected function getPossibleContactMatches($params) {
1862     $extIDMatch = NULL;
1863
1864     if (!empty($params['external_identifier'])) {
1865       // Check for any match on external id, deleted or otherwise.
1866       $extIDContact = civicrm_api3('Contact', 'get', [
1867         'external_identifier' => $params['external_identifier'],
1868         'showAll' => 'all',
1869         'return' => ['id', 'contact_is_deleted'],
1870       ]);
1871       if (isset($extIDContact['id'])) {
1872         $extIDMatch = $extIDContact['id'];
1873
1874         if ($extIDContact['values'][$extIDMatch]['contact_is_deleted'] == 1) {
1875           // If the contact is deleted, update external identifier to be blank
1876           // to avoid key error from MySQL.
1877           $params = ['id' => $extIDMatch, 'external_identifier' => ''];
1878           civicrm_api3('Contact', 'create', $params);
1879
1880           // And now it is no longer a match.
1881           $extIDMatch = NULL;
1882         }
1883       }
1884     }
1885     $checkParams = ['check_permissions' => FALSE, 'match' => $params];
1886     $checkParams['match']['contact_type'] = $this->_contactType;
1887
1888     $possibleMatches = civicrm_api3('Contact', 'duplicatecheck', $checkParams);
1889     if (!$extIDMatch) {
1890       return array_keys($possibleMatches['values']);
1891     }
1892     if ($possibleMatches['count']) {
1893       if (array_key_exists($extIDMatch, $possibleMatches['values'])) {
1894         return [$extIDMatch];
1895       }
1896       throw new CRM_Core_Exception(ts(
1897         'Matching this contact based on the de-dupe rule would cause an external ID conflict'));
1898     }
1899     return [$extIDMatch];
1900   }
1901
1902   /**
1903    * Format the form mapping parameters ready for the parser.
1904    *
1905    * @param int $count
1906    *   Number of rows.
1907    *
1908    * @return array $parserParameters
1909    */
1910   public static function getParameterForParser($count) {
1911     $baseArray = [];
1912     for ($i = 0; $i < $count; $i++) {
1913       $baseArray[$i] = NULL;
1914     }
1915     $parserParameters['mapperLocType'] = $baseArray;
1916     $parserParameters['mapperPhoneType'] = $baseArray;
1917     $parserParameters['mapperImProvider'] = $baseArray;
1918     $parserParameters['mapperWebsiteType'] = $baseArray;
1919     $parserParameters['mapperRelated'] = $baseArray;
1920     $parserParameters['relatedContactType'] = $baseArray;
1921     $parserParameters['relatedContactDetails'] = $baseArray;
1922     $parserParameters['relatedContactLocType'] = $baseArray;
1923     $parserParameters['relatedContactPhoneType'] = $baseArray;
1924     $parserParameters['relatedContactImProvider'] = $baseArray;
1925     $parserParameters['relatedContactWebsiteType'] = $baseArray;
1926
1927     return $parserParameters;
1928
1929   }
1930
1931   /**
1932    * Set field metadata.
1933    */
1934   protected function setFieldMetadata() {
1935     $this->setImportableFieldsMetadata($this->getContactImportMetadata());
1936     // Probably no longer needed but here for now.
1937     $this->_relationships = $this->getRelationships();
1938   }
1939
1940   /**
1941    * @param array $newContact
1942    * @param $statusFieldName
1943    * @param array $values
1944    * @param int $onDuplicate
1945    * @param array $formatted
1946    * @param array $contactFields
1947    *
1948    * @return int
1949    *
1950    * @throws \CRM_Core_Exception
1951    * @throws \CiviCRM_API3_Exception
1952    * @throws \Civi\API\Exception\UnauthorizedException
1953    */
1954   protected function handleDuplicateError(array $newContact, $statusFieldName, array $values, int $onDuplicate, array $formatted, array $contactFields): int {
1955     $urls = [];
1956     // need to fix at some stage and decide if the error will return an
1957     // array or string, crude hack for now
1958     if (is_array($newContact['error_message']['params'][0])) {
1959       $cids = $newContact['error_message']['params'][0];
1960     }
1961     else {
1962       $cids = explode(',', $newContact['error_message']['params'][0]);
1963     }
1964
1965     foreach ($cids as $cid) {
1966       $urls[] = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $cid, TRUE);
1967     }
1968
1969     $url_string = implode("\n", $urls);
1970
1971     // If we duplicate more than one record, skip no matter what
1972     if (count($cids) > 1) {
1973       $errorMessage = ts('Record duplicates multiple contacts');
1974       $importRecordParams = [
1975         $statusFieldName => 'ERROR',
1976         "${statusFieldName}Msg" => $errorMessage,
1977       ];
1978
1979       //combine error msg to avoid mismatch between error file columns.
1980       $errorMessage .= "\n" . $url_string;
1981       array_unshift($values, $errorMessage);
1982       $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
1983       return CRM_Import_Parser::ERROR;
1984     }
1985
1986     // Params only had one id, so shift it out
1987     $contactId = array_shift($cids);
1988     $cid = NULL;
1989
1990     $vals = ['contact_id' => $contactId];
1991
1992     if ($onDuplicate == CRM_Import_Parser::DUPLICATE_REPLACE) {
1993       civicrm_api('contact', 'delete', $vals);
1994       $cid = CRM_Contact_BAO_Contact::createProfileContact($formatted, $contactFields, $contactId, NULL, NULL, $formatted['contact_type']);
1995     }
1996     if (in_array((int) $onDuplicate, [CRM_Import_Parser::DUPLICATE_UPDATE, CRM_Import_Parser::DUPLICATE_FILL], TRUE)) {
1997       $newContact = $this->createContact($formatted, $contactFields, $onDuplicate, $contactId);
1998     }
1999     // else skip does nothing and just returns an error code.
2000     if ($cid) {
2001       $contact = [
2002         'contact_id' => $cid,
2003       ];
2004       $defaults = [];
2005       $newContact = CRM_Contact_BAO_Contact::retrieve($contact, $defaults);
2006     }
2007
2008     if (civicrm_error($newContact)) {
2009       if (empty($newContact['error_message']['params'])) {
2010         // different kind of error other than DUPLICATE
2011         $errorMessage = $newContact['error_message'];
2012         array_unshift($values, $errorMessage);
2013         $importRecordParams = [
2014           $statusFieldName => 'ERROR',
2015           "${statusFieldName}Msg" => $errorMessage,
2016         ];
2017         $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
2018         return CRM_Import_Parser::ERROR;
2019       }
2020
2021       $contactID = $newContact['error_message']['params'][0];
2022       if (is_array($contactID)) {
2023         $contactID = array_pop($contactID);
2024       }
2025       if (!in_array($contactID, $this->_newContacts)) {
2026         $this->_newContacts[] = $contactID;
2027       }
2028     }
2029     //CRM-262 No Duplicate Checking
2030     if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) {
2031       array_unshift($values, $url_string);
2032       $importRecordParams = [
2033         $statusFieldName => 'DUPLICATE',
2034         "${statusFieldName}Msg" => "Skipping duplicate record",
2035       ];
2036       $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
2037       return CRM_Import_Parser::DUPLICATE;
2038     }
2039
2040     $importRecordParams = [
2041       $statusFieldName => 'IMPORTED',
2042     ];
2043     $this->updateImportRecord($values[count($values) - 1], $importRecordParams);
2044     //return warning if street address is not parsed, CRM-5886
2045     return $this->processMessage($values, $statusFieldName, CRM_Import_Parser::VALID);
2046   }
2047
2048   /**
2049    * Validate a formatted contact parameter list.
2050    *
2051    * @param array $params
2052    *   Structured parameter list (as in crm_format_params).
2053    *
2054    * @throw CRM_Core_Error
2055    */
2056   public function deprecated_validate_formatted_contact(&$params): void {
2057     // Look for offending email addresses
2058
2059     if (array_key_exists('email', $params)) {
2060       foreach ($params['email'] as $count => $values) {
2061         if (!is_array($values)) {
2062           continue;
2063         }
2064         if ($email = CRM_Utils_Array::value('email', $values)) {
2065           // validate each email
2066           if (!CRM_Utils_Rule::email($email)) {
2067             throw new CRM_Core_Exception('No valid email address');
2068           }
2069
2070           // check for loc type id.
2071           if (empty($values['location_type_id'])) {
2072             throw new CRM_Core_Exception('Location Type Id missing.');
2073           }
2074         }
2075       }
2076     }
2077
2078     // Validate custom data fields
2079     if (array_key_exists('custom', $params) && is_array($params['custom'])) {
2080       foreach ($params['custom'] as $key => $custom) {
2081         if (is_array($custom)) {
2082           foreach ($custom as $fieldId => $value) {
2083             $valid = CRM_Core_BAO_CustomValue::typecheck(CRM_Utils_Array::value('type', $value),
2084               CRM_Utils_Array::value('value', $value)
2085             );
2086             if (!$valid && $value['is_required']) {
2087               throw new CRM_Core_Exception('Invalid value for custom field \'' .
2088                 $custom['name'] . '\''
2089               );
2090             }
2091             if (CRM_Utils_Array::value('type', $custom) == 'Date') {
2092               $params['custom'][$key][$fieldId]['value'] = str_replace('-', '', $params['custom'][$key][$fieldId]['value']);
2093             }
2094           }
2095         }
2096       }
2097     }
2098   }
2099
2100   /**
2101    * @param array $params
2102    * @param bool $dupeCheck
2103    * @param null|int $dedupeRuleGroupID
2104    *
2105    * @throws \CRM_Core_Exception
2106    */
2107   public function deprecated_contact_check_params(
2108     &$params,
2109     $dupeCheck = TRUE,
2110     $dedupeRuleGroupID = NULL) {
2111
2112     $requiredCheck = TRUE;
2113
2114     if (isset($params['id']) && is_numeric($params['id'])) {
2115       $requiredCheck = FALSE;
2116     }
2117     if ($requiredCheck) {
2118       if (isset($params['id'])) {
2119         $required = ['Individual', 'Household', 'Organization'];
2120       }
2121       $required = [
2122         'Individual' => [
2123           ['first_name', 'last_name'],
2124           'email',
2125         ],
2126         'Household' => [
2127           'household_name',
2128         ],
2129         'Organization' => [
2130           'organization_name',
2131         ],
2132       ];
2133
2134       // contact_type has a limited number of valid values
2135       if (empty($params['contact_type'])) {
2136         throw new CRM_Core_Exception("No Contact Type");
2137       }
2138       $fields = $required[$params['contact_type']] ?? NULL;
2139       if ($fields == NULL) {
2140         throw new CRM_Core_Exception("Invalid Contact Type: {$params['contact_type']}");
2141       }
2142
2143       if ($csType = CRM_Utils_Array::value('contact_sub_type', $params)) {
2144         if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($csType, $params['contact_type']))) {
2145           throw new CRM_Core_Exception("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $csType));
2146         }
2147       }
2148
2149       if (empty($params['contact_id']) && !empty($params['id'])) {
2150         $valid = FALSE;
2151         $error = '';
2152         foreach ($fields as $field) {
2153           if (is_array($field)) {
2154             $valid = TRUE;
2155             foreach ($field as $element) {
2156               if (empty($params[$element])) {
2157                 $valid = FALSE;
2158                 $error .= $element;
2159                 break;
2160               }
2161             }
2162           }
2163           else {
2164             if (!empty($params[$field])) {
2165               $valid = TRUE;
2166             }
2167           }
2168           if ($valid) {
2169             break;
2170           }
2171         }
2172
2173         if (!$valid) {
2174           throw new CRM_Core_Exception("Required fields not found for {$params['contact_type']} : $error");
2175         }
2176       }
2177     }
2178
2179     if ($dupeCheck) {
2180       // @todo switch to using api version
2181       // $dupes = civicrm_api3('Contact', 'duplicatecheck', (array('match' => $params, 'dedupe_rule_id' => $dedupeRuleGroupID)));
2182       // $ids = $dupes['count'] ? implode(',', array_keys($dupes['values'])) : NULL;
2183       $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised', [], CRM_Utils_Array::value('check_permissions', $params), $dedupeRuleGroupID);
2184       if ($ids != NULL) {
2185         $error = CRM_Core_Error::createError("Found matching contacts: " . implode(',', $ids),
2186           CRM_Core_Error::DUPLICATE_CONTACT,
2187           'Fatal', $ids
2188         );
2189         return civicrm_api3_create_error($error->pop());
2190       }
2191     }
2192
2193     // check for organisations with same name
2194     if (!empty($params['current_employer'])) {
2195       $organizationParams = ['organization_name' => $params['current_employer']];
2196       $dupeIds = CRM_Contact_BAO_Contact::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', [], FALSE);
2197
2198       // check for mismatch employer name and id
2199       if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)
2200       ) {
2201         throw new CRM_Core_Exception('Employer name and Employer id Mismatch');
2202       }
2203
2204       // show error if multiple organisation with same name exist
2205       if (empty($params['employer_id']) && (count($dupeIds) > 1)
2206       ) {
2207         return civicrm_api3_create_error('Found more than one Organisation with same Name.');
2208       }
2209     }
2210   }
2211
2212 }