CRM/Contact/Import/Parser.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
  18
  19   protected $_tableName;
  20
  21   /**
  22    * Total number of lines in file
  23    *
  24    * @var int
  25    */
  26   protected $_rowCount;
  27
  28   /**
  29    * Running total number of un-matched Contacts.
  30    *
  31    * @var int
  32    */
  33   protected $_unMatchCount;
  34
  35   /**
  36    * Array of unmatched lines.
  37    *
  38    * @var array
  39    */
  40   protected $_unMatch;
  41
  42   /**
  43    * Total number of contacts with unparsed addresses
  44    * @var int
  45    */
  46   protected $_unparsedAddressCount;
  47
  48   /**
  49    * Filename of mismatch data
  50    *
  51    * @var string
  52    */
  53   protected $_misMatchFilemName;
  54
  55   protected $_primaryKeyName;
  56   protected $_statusFieldName;
  57
  58   protected $fieldMetadata = [];
  59   /**
  60    * On duplicate
  61    *
  62    * @var int
  63    */
  64   public $_onDuplicate;
  65
  66   /**
  67    * Dedupe rule group id to use if set
  68    *
  69    * @var int
  70    */
  71   public $_dedupeRuleGroupID = NULL;
  72
  73   /**
  74    * Run import.
  75    *
  76    * @param string $tableName
  77    * @param array $mapper
  78    * @param int $mode
  79    * @param int $contactType
  80    * @param string $primaryKeyName
  81    * @param string $statusFieldName
  82    * @param int $onDuplicate
  83    * @param int $statusID
  84    * @param int $totalRowCount
  85    * @param bool $doGeocodeAddress
  86    * @param int $timeout
  87    * @param string $contactSubType
  88    * @param int $dedupeRuleGroupID
  89    *
  90    * @return mixed
  91    */
  92   public function run(
  93     $tableName,
  94     $mapper = [],
  95     $mode = self::MODE_PREVIEW,
  96     $contactType = self::CONTACT_INDIVIDUAL,
  97     $primaryKeyName = '_id',
  98     $statusFieldName = '_status',
  99     $onDuplicate = self::DUPLICATE_SKIP,
 100     $statusID = NULL,
 101     $totalRowCount = NULL,
 102     $doGeocodeAddress = FALSE,
 103     $timeout = CRM_Contact_Import_Parser::DEFAULT_TIMEOUT,
 104     $contactSubType = NULL,
 105     $dedupeRuleGroupID = NULL
 106   ) {
 107
 108     // TODO: Make the timeout actually work
 109     $this->_onDuplicate = $onDuplicate;
 110     $this->_dedupeRuleGroupID = $dedupeRuleGroupID;
 111
 112     switch ($contactType) {
 113       case CRM_Import_Parser::CONTACT_INDIVIDUAL:
 114         $this->_contactType = 'Individual';
 115         break;
 116
 117       case CRM_Import_Parser::CONTACT_HOUSEHOLD:
 118         $this->_contactType = 'Household';
 119         break;
 120
 121       case CRM_Import_Parser::CONTACT_ORGANIZATION:
 122         $this->_contactType = 'Organization';
 123     }
 124
 125     $this->_contactSubType = $contactSubType;
 126
 127     $this->init();
 128
 129     $this->_rowCount = $this->_warningCount = 0;
 130     $this->_invalidRowCount = $this->_validCount = 0;
 131     $this->_totalCount = $this->_conflictCount = 0;
 132
 133     $this->_errors = [];
 134     $this->_warnings = [];
 135     $this->_conflicts = [];
 136     $this->_unparsedAddresses = [];
 137
 138     $this->_tableName = $tableName;
 139     $this->_primaryKeyName = $primaryKeyName;
 140     $this->_statusFieldName = $statusFieldName;
 141
 142     if ($mode == self::MODE_MAPFIELD) {
 143       $this->_rows = [];
 144     }
 145     else {
 146       $this->_activeFieldCount = count($this->_activeFields);
 147     }
 148
 149     if ($mode == self::MODE_IMPORT) {
 150       //get the key of email field
 151       foreach ($mapper as $key => $value) {
 152         if (strtolower($value) == 'email') {
 153           $emailKey = $key;
 154           break;
 155         }
 156       }
 157     }
 158
 159     if ($statusID) {
 160       $this->progressImport($statusID);
 161       $startTimestamp = $currTimestamp = $prevTimestamp = time();
 162     }
 163     // get the contents of the temp. import table
 164     $query = "SELECT * FROM $tableName";
 165     if ($mode == self::MODE_IMPORT) {
 166       $query .= " WHERE $statusFieldName = 'NEW'";
 167     }
 168
 169     $result = CRM_Core_DAO::executeQuery($query);
 170
 171     while ($result->fetch()) {
 172       $values = array_values($result->toArray());
 173       $this->_rowCount++;
 174
 175       /* trim whitespace around the values */
 176       foreach ($values as $k => $v) {
 177         $values[$k] = trim($v, " \t\r\n");
 178       }
 179       if (CRM_Utils_System::isNull($values)) {
 180         continue;
 181       }
 182
 183       $this->_totalCount++;
 184
 185       if ($mode == self::MODE_MAPFIELD) {
 186         $returnCode = $this->mapField($values);
 187       }
 188       elseif ($mode == self::MODE_PREVIEW) {
 189         $returnCode = $this->preview($values);
 190       }
 191       elseif ($mode == self::MODE_SUMMARY) {
 192         $returnCode = $this->summary($values);
 193       }
 194       elseif ($mode == self::MODE_IMPORT) {
 195         //print "Running parser in import mode<br/>\n";
 196         $returnCode = $this->import($onDuplicate, $values, $doGeocodeAddress);
 197         if ($statusID && (($this->_rowCount % 50) == 0)) {
 198           $prevTimestamp = $this->progressImport($statusID, FALSE, $startTimestamp, $prevTimestamp, $totalRowCount);
 199         }
 200       }
 201       else {
 202         $returnCode = self::ERROR;
 203       }
 204
 205       // note that a line could be valid but still produce a warning
 206       if ($returnCode & self::VALID) {
 207         $this->_validCount++;
 208         if ($mode == self::MODE_MAPFIELD) {
 209           $this->_rows[] = $values;
 210           $this->_activeFieldCount = max($this->_activeFieldCount, count($values));
 211         }
 212       }
 213
 214       if ($returnCode & self::WARNING) {
 215         $this->_warningCount++;
 216         if ($this->_warningCount < $this->_maxWarningCount) {
 217           $this->_warningCount[] = $line;
 218         }
 219       }
 220
 221       if ($returnCode & self::ERROR) {
 222         $this->_invalidRowCount++;
 223         array_unshift($values, $this->_rowCount);
 224         $this->_errors[] = $values;
 225       }
 226
 227       if ($returnCode & self::CONFLICT) {
 228         $this->_conflictCount++;
 229         array_unshift($values, $this->_rowCount);
 230         $this->_conflicts[] = $values;
 231       }
 232
 233       if ($returnCode & self::NO_MATCH) {
 234         $this->_unMatchCount++;
 235         array_unshift($values, $this->_rowCount);
 236         $this->_unMatch[] = $values;
 237       }
 238
 239       if ($returnCode & self::DUPLICATE) {
 240         if ($returnCode & self::MULTIPLE_DUPE) {
 241           /* TODO: multi-dupes should be counted apart from singles
 242            * on non-skip action */
 243         }
 244         $this->_duplicateCount++;
 245         array_unshift($values, $this->_rowCount);
 246         $this->_duplicates[] = $values;
 247         if ($onDuplicate != self::DUPLICATE_SKIP) {
 248           $this->_validCount++;
 249         }
 250       }
 251
 252       if ($returnCode & self::UNPARSED_ADDRESS_WARNING) {
 253         $this->_unparsedAddressCount++;
 254         array_unshift($values, $this->_rowCount);
 255         $this->_unparsedAddresses[] = $values;
 256       }
 257       // we give the derived class a way of aborting the process
 258       // note that the return code could be multiple code or'ed together
 259       if ($returnCode & self::STOP) {
 260         break;
 261       }
 262
 263       // if we are done processing the maxNumber of lines, break
 264       if ($this->_maxLinesToProcess > 0 && $this->_validCount >= $this->_maxLinesToProcess) {
 265         break;
 266       }
 267
 268       // see if we've hit our timeout yet
 269       /* if ( $the_thing_with_the_stuff ) {
 270       do_something( );
 271       } */
 272     }
 273
 274     if ($mode == self::MODE_PREVIEW || $mode == self::MODE_IMPORT) {
 275       $customHeaders = $mapper;
 276
 277       $customfields = CRM_Core_BAO_CustomField::getFields($this->_contactType);
 278       foreach ($customHeaders as $key => $value) {
 279         if ($id = CRM_Core_BAO_CustomField::getKeyID($value)) {
 280           $customHeaders[$key] = $customfields[$id][0];
 281         }
 282       }
 283
 284       if ($this->_invalidRowCount) {
 285         // removed view url for invlaid contacts
 286         $headers = array_merge([
 287           ts('Line Number'),
 288           ts('Reason'),
 289         ], $customHeaders);
 290         $this->_errorFileName = self::errorFileName(self::ERROR);
 291         self::exportCSV($this->_errorFileName, $headers, $this->_errors);
 292       }
 293       if ($this->_conflictCount) {
 294         $headers = array_merge([
 295           ts('Line Number'),
 296           ts('Reason'),
 297         ], $customHeaders);
 298         $this->_conflictFileName = self::errorFileName(self::CONFLICT);
 299         self::exportCSV($this->_conflictFileName, $headers, $this->_conflicts);
 300       }
 301       if ($this->_duplicateCount) {
 302         $headers = array_merge([
 303           ts('Line Number'),
 304           ts('View Contact URL'),
 305         ], $customHeaders);
 306
 307         $this->_duplicateFileName = self::errorFileName(self::DUPLICATE);
 308         self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates);
 309       }
 310       if ($this->_unMatchCount) {
 311         $headers = array_merge([
 312           ts('Line Number'),
 313           ts('Reason'),
 314         ], $customHeaders);
 315
 316         $this->_misMatchFilemName = self::errorFileName(self::NO_MATCH);
 317         self::exportCSV($this->_misMatchFilemName, $headers, $this->_unMatch);
 318       }
 319       if ($this->_unparsedAddressCount) {
 320         $headers = array_merge([
 321           ts('Line Number'),
 322           ts('Contact Edit URL'),
 323         ], $customHeaders);
 324         $this->_errorFileName = self::errorFileName(self::UNPARSED_ADDRESS_WARNING);
 325         self::exportCSV($this->_errorFileName, $headers, $this->_unparsedAddresses);
 326       }
 327     }
 328     //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
 329     return $this->fini();
 330   }
 331
 332   /**
 333    * Given a list of the importable field keys that the user has selected.
 334    * set the active fields array to this list
 335    *
 336    * @param array $fieldKeys
 337    *   Mapped array of values.
 338    */
 339   public function setActiveFields($fieldKeys) {
 340     $this->_activeFieldCount = count($fieldKeys);
 341     foreach ($fieldKeys as $key) {
 342       if (empty($this->_fields[$key])) {
 343         $this->_activeFields[] = new CRM_Contact_Import_Field('', ts('- do not import -'));
 344       }
 345       else {
 346         $this->_activeFields[] = clone($this->_fields[$key]);
 347       }
 348     }
 349   }
 350
 351   /**
 352    * @param $elements
 353    */
 354   public function setActiveFieldLocationTypes($elements) {
 355     for ($i = 0; $i < count($elements); $i++) {
 356       $this->_activeFields[$i]->_hasLocationType = $elements[$i];
 357     }
 358   }
 359
 360   /**
 361    * @param $elements
 362    */
 363
 364   /**
 365    * @param $elements
 366    */
 367   public function setActiveFieldPhoneTypes($elements) {
 368     for ($i = 0; $i < count($elements); $i++) {
 369       $this->_activeFields[$i]->_phoneType = $elements[$i];
 370     }
 371   }
 372
 373   /**
 374    * @param $elements
 375    */
 376   public function setActiveFieldWebsiteTypes($elements) {
 377     for ($i = 0; $i < count($elements); $i++) {
 378       $this->_activeFields[$i]->_websiteType = $elements[$i];
 379     }
 380   }
 381
 382   /**
 383    * Set IM Service Provider type fields.
 384    *
 385    * @param array $elements
 386    *   IM service provider type ids.
 387    */
 388   public function setActiveFieldImProviders($elements) {
 389     for ($i = 0; $i < count($elements); $i++) {
 390       $this->_activeFields[$i]->_imProvider = $elements[$i];
 391     }
 392   }
 393
 394   /**
 395    * @param $elements
 396    */
 397   public function setActiveFieldRelated($elements) {
 398     for ($i = 0; $i < count($elements); $i++) {
 399       $this->_activeFields[$i]->_related = $elements[$i];
 400     }
 401   }
 402
 403   /**
 404    * @param $elements
 405    */
 406   public function setActiveFieldRelatedContactType($elements) {
 407     for ($i = 0; $i < count($elements); $i++) {
 408       $this->_activeFields[$i]->_relatedContactType = $elements[$i];
 409     }
 410   }
 411
 412   /**
 413    * @param $elements
 414    */
 415   public function setActiveFieldRelatedContactDetails($elements) {
 416     for ($i = 0; $i < count($elements); $i++) {
 417       $this->_activeFields[$i]->_relatedContactDetails = $elements[$i];
 418     }
 419   }
 420
 421   /**
 422    * @param $elements
 423    */
 424   public function setActiveFieldRelatedContactLocType($elements) {
 425     for ($i = 0; $i < count($elements); $i++) {
 426       $this->_activeFields[$i]->_relatedContactLocType = $elements[$i];
 427     }
 428   }
 429
 430   /**
 431    * Set active field for related contact's phone type.
 432    *
 433    * @param array $elements
 434    */
 435   public function setActiveFieldRelatedContactPhoneType($elements) {
 436     for ($i = 0; $i < count($elements); $i++) {
 437       $this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i];
 438     }
 439   }
 440
 441   /**
 442    * @param $elements
 443    */
 444   public function setActiveFieldRelatedContactWebsiteType($elements) {
 445     for ($i = 0; $i < count($elements); $i++) {
 446       $this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i];
 447     }
 448   }
 449
 450   /**
 451    * Set IM Service Provider type fields for related contacts.
 452    *
 453    * @param array $elements
 454    *   IM service provider type ids of related contact.
 455    */
 456   public function setActiveFieldRelatedContactImProvider($elements) {
 457     for ($i = 0; $i < count($elements); $i++) {
 458       $this->_activeFields[$i]->_relatedContactImProvider = $elements[$i];
 459     }
 460   }
 461
 462   /**
 463    * Format the field values for input to the api.
 464    *
 465    * @return array
 466    *   (reference ) associative array of name/value pairs
 467    */
 468   public function &getActiveFieldParams() {
 469     $params = [];
 470
 471     for ($i = 0; $i < $this->_activeFieldCount; $i++) {
 472       if ($this->_activeFields[$i]->_name == 'do_not_import') {
 473         continue;
 474       }
 475
 476       if (isset($this->_activeFields[$i]->_value)) {
 477         if (isset($this->_activeFields[$i]->_hasLocationType)) {
 478           if (!isset($params[$this->_activeFields[$i]->_name])) {
 479             $params[$this->_activeFields[$i]->_name] = [];
 480           }
 481
 482           $value = [
 483             $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value,
 484             'location_type_id' => $this->_activeFields[$i]->_hasLocationType,
 485           ];
 486
 487           if (isset($this->_activeFields[$i]->_phoneType)) {
 488             $value['phone_type_id'] = $this->_activeFields[$i]->_phoneType;
 489           }
 490
 491           // get IM service Provider type id
 492           if (isset($this->_activeFields[$i]->_imProvider)) {
 493             $value['provider_id'] = $this->_activeFields[$i]->_imProvider;
 494           }
 495
 496           $params[$this->_activeFields[$i]->_name][] = $value;
 497         }
 498         elseif (isset($this->_activeFields[$i]->_websiteType)) {
 499           $value = [
 500             $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value,
 501             'website_type_id' => $this->_activeFields[$i]->_websiteType,
 502           ];
 503
 504           $params[$this->_activeFields[$i]->_name][] = $value;
 505         }
 506
 507         if (!isset($params[$this->_activeFields[$i]->_name])) {
 508           if (!isset($this->_activeFields[$i]->_related)) {
 509             $params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value;
 510           }
 511         }
 512
 513         //minor fix for CRM-4062
 514         if (isset($this->_activeFields[$i]->_related)) {
 515           if (!isset($params[$this->_activeFields[$i]->_related])) {
 516             $params[$this->_activeFields[$i]->_related] = [];
 517           }
 518
 519           if (!isset($params[$this->_activeFields[$i]->_related]['contact_type']) && !empty($this->_activeFields[$i]->_relatedContactType)) {
 520             $params[$this->_activeFields[$i]->_related]['contact_type'] = $this->_activeFields[$i]->_relatedContactType;
 521           }
 522
 523           if (isset($this->_activeFields[$i]->_relatedContactLocType) && !empty($this->_activeFields[$i]->_value)) {
 524             if (!empty($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails]) &&
 525               !is_array($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails])
 526             ) {
 527               $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = [];
 528             }
 529             $value = [
 530               $this->_activeFields[$i]->_relatedContactDetails => $this->_activeFields[$i]->_value,
 531               'location_type_id' => $this->_activeFields[$i]->_relatedContactLocType,
 532             ];
 533
 534             if (isset($this->_activeFields[$i]->_relatedContactPhoneType)) {
 535               $value['phone_type_id'] = $this->_activeFields[$i]->_relatedContactPhoneType;
 536             }
 537
 538             // get IM service Provider type id for related contact
 539             if (isset($this->_activeFields[$i]->_relatedContactImProvider)) {
 540               $value['provider_id'] = $this->_activeFields[$i]->_relatedContactImProvider;
 541             }
 542
 543             $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = $value;
 544           }
 545           elseif (isset($this->_activeFields[$i]->_relatedContactWebsiteType)) {
 546             $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = [
 547               'url' => $this->_activeFields[$i]->_value,
 548               'website_type_id' => $this->_activeFields[$i]->_relatedContactWebsiteType,
 549             ];
 550           }
 551           elseif (empty($this->_activeFields[$i]->_value) && isset($this->_activeFields[$i]->_relatedContactLocType)) {
 552             if (empty($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails])) {
 553               $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = [];
 554             }
 555           }
 556           else {
 557             $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = $this->_activeFields[$i]->_value;
 558           }
 559         }
 560       }
 561     }
 562
 563     return $params;
 564   }
 565
 566   /**
 567    * @param string $name
 568    * @param $title
 569    * @param int $type
 570    * @param string $headerPattern
 571    * @param string $dataPattern
 572    * @param bool $hasLocationType
 573    */
 574   public function addField(
 575     $name, $title, $type = CRM_Utils_Type::T_INT,
 576     $headerPattern = '//', $dataPattern = '//',
 577     $hasLocationType = FALSE
 578   ) {
 579     $this->_fields[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
 580     if (empty($name)) {
 581       $this->_fields['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
 582     }
 583   }
 584
 585   /**
 586    * Store parser values.
 587    *
 588    * @param CRM_Core_Session $store
 589    *
 590    * @param int $mode
 591    */
 592   public function set($store, $mode = self::MODE_SUMMARY) {
 593     $store->set('rowCount', $this->_rowCount);
 594     $store->set('fields', $this->getSelectValues());
 595     $store->set('fieldTypes', $this->getSelectTypes());
 596
 597     $store->set('columnCount', $this->_activeFieldCount);
 598
 599     $store->set('totalRowCount', $this->_totalCount);
 600     $store->set('validRowCount', $this->_validCount);
 601     $store->set('invalidRowCount', $this->_invalidRowCount);
 602     $store->set('conflictRowCount', $this->_conflictCount);
 603     $store->set('unMatchCount', $this->_unMatchCount);
 604
 605     switch ($this->_contactType) {
 606       case 'Individual':
 607         $store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL);
 608         break;
 609
 610       case 'Household':
 611         $store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD);
 612         break;
 613
 614       case 'Organization':
 615         $store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION);
 616     }
 617
 618     if ($this->_invalidRowCount) {
 619       $store->set('errorsFileName', $this->_errorFileName);
 620     }
 621     if ($this->_conflictCount) {
 622       $store->set('conflictsFileName', $this->_conflictFileName);
 623     }
 624     if (isset($this->_rows) && !empty($this->_rows)) {
 625       $store->set('dataValues', $this->_rows);
 626     }
 627
 628     if ($this->_unMatchCount) {
 629       $store->set('mismatchFileName', $this->_misMatchFilemName);
 630     }
 631
 632     if ($mode == self::MODE_IMPORT) {
 633       $store->set('duplicateRowCount', $this->_duplicateCount);
 634       $store->set('unparsedAddressCount', $this->_unparsedAddressCount);
 635       if ($this->_duplicateCount) {
 636         $store->set('duplicatesFileName', $this->_duplicateFileName);
 637       }
 638       if ($this->_unparsedAddressCount) {
 639         $store->set('errorsFileName', $this->_errorFileName);
 640       }
 641     }
 642     //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
 643   }
 644
 645   /**
 646    * Export data to a CSV file.
 647    *
 648    * @param string $fileName
 649    * @param array $header
 650    * @param array $data
 651    */
 652   public static function exportCSV($fileName, $header, $data) {
 653
 654     if (file_exists($fileName) && !is_writable($fileName)) {
 655       CRM_Core_Error::movedSiteError($fileName);
 656     }
 657     //hack to remove '_status', '_statusMsg' and '_id' from error file
 658     $errorValues = [];
 659     $dbRecordStatus = ['IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW'];
 660     foreach ($data as $rowCount => $rowValues) {
 661       $count = 0;
 662       foreach ($rowValues as $key => $val) {
 663         if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) {
 664           break;
 665         }
 666         $errorValues[$rowCount][$key] = $val;
 667         $count++;
 668       }
 669     }
 670     $data = $errorValues;
 671
 672     $output = [];
 673     $fd = fopen($fileName, 'w');
 674
 675     foreach ($header as $key => $value) {
 676       $header[$key] = "\"$value\"";
 677     }
 678     $config = CRM_Core_Config::singleton();
 679     $output[] = implode($config->fieldSeparator, $header);
 680
 681     foreach ($data as $datum) {
 682       foreach ($datum as $key => $value) {
 683         $datum[$key] = "\"$value\"";
 684       }
 685       $output[] = implode($config->fieldSeparator, $datum);
 686     }
 687     fwrite($fd, implode("\n", $output));
 688     fclose($fd);
 689   }
 690
 691   /**
 692    * Update the record with PK $id in the import database table.
 693    *
 694    * @deprecated - call setImportStatus directly as the parameters are simpler,
 695    *
 696    * @param int $id
 697    * @param array $params
 698    */
 699   public function updateImportRecord($id, $params): void {
 700     $this->setImportStatus((int) $id, $params[$this->_statusFieldName] ?? '', $params["{$this->_statusFieldName}Msg"] ?? '');
 701   }
 702
 703   /**
 704    * Set the import status for the given record.
 705    *
 706    * If this is a sql import then the sql table will be used and the update
 707    * will not happen as the relevant fields don't exist in the table - hence
 708    * the checks that statusField & primary key are set.
 709    *
 710    * @param int $id
 711    * @param string $status
 712    * @param string $message
 713    */
 714   public function setImportStatus(int $id, string $status, string $message): void {
 715     if ($this->_statusFieldName && $this->_primaryKeyName) {
 716       CRM_Core_DAO::executeQuery("
 717         UPDATE $this->_tableName
 718         SET $this->_statusFieldName = %1,
 719           {$this->_statusFieldName}Msg = %2
 720         WHERE  $this->_primaryKeyName = %3
 721       ", [
 722         1 => [$status, 'String'],
 723         2 => [$message, 'String'],
 724         3 => [$id, 'Integer'],
 725       ]);
 726     }
 727   }
 728
 729   /**
 730    * Format contact parameters.
 731    *
 732    * @todo this function needs re-writing & re-merging into the main function.
 733    *
 734    * Here be dragons.
 735    *
 736    * @param array $values
 737    * @param array $params
 738    *
 739    * @return bool
 740    */
 741   protected function formatContactParameters(&$values, &$params) {
 742     // Crawl through the possible classes:
 743     // Contact
 744     //      Individual
 745     //      Household
 746     //      Organization
 747     //          Location
 748     //              Address
 749     //              Email
 750     //              Phone
 751     //              IM
 752     //      Note
 753     //      Custom
 754
 755     // first add core contact values since for other Civi modules they are not added
 756     $contactFields = CRM_Contact_DAO_Contact::fields();
 757     _civicrm_api3_store_values($contactFields, $values, $params);
 758
 759     if (isset($values['contact_type'])) {
 760       // we're an individual/household/org property
 761
 762       $fields[$values['contact_type']] = CRM_Contact_DAO_Contact::fields();
 763
 764       _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params);
 765       return TRUE;
 766     }
 767
 768     // Cache the various object fields
 769     // @todo - remove this after confirming this is just a compilation of other-wise-cached fields.
 770     static $fields = [];
 771
 772     if (isset($values['individual_prefix'])) {
 773       if (!empty($params['prefix_id'])) {
 774         $prefixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id');
 775         $params['prefix'] = $prefixes[$params['prefix_id']];
 776       }
 777       else {
 778         $params['prefix'] = $values['individual_prefix'];
 779       }
 780       return TRUE;
 781     }
 782
 783     if (isset($values['individual_suffix'])) {
 784       if (!empty($params['suffix_id'])) {
 785         $suffixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id');
 786         $params['suffix'] = $suffixes[$params['suffix_id']];
 787       }
 788       else {
 789         $params['suffix'] = $values['individual_suffix'];
 790       }
 791       return TRUE;
 792     }
 793
 794     // CRM-4575
 795     if (isset($values['email_greeting'])) {
 796       if (!empty($params['email_greeting_id'])) {
 797         $emailGreetingFilter = [
 798           'contact_type' => $params['contact_type'] ?? NULL,
 799           'greeting_type' => 'email_greeting',
 800         ];
 801         $emailGreetings = CRM_Core_PseudoConstant::greeting($emailGreetingFilter);
 802         $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']];
 803       }
 804       else {
 805         $params['email_greeting'] = $values['email_greeting'];
 806       }
 807
 808       return TRUE;
 809     }
 810
 811     if (isset($values['postal_greeting'])) {
 812       if (!empty($params['postal_greeting_id'])) {
 813         $postalGreetingFilter = [
 814           'contact_type' => $params['contact_type'] ?? NULL,
 815           'greeting_type' => 'postal_greeting',
 816         ];
 817         $postalGreetings = CRM_Core_PseudoConstant::greeting($postalGreetingFilter);
 818         $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']];
 819       }
 820       else {
 821         $params['postal_greeting'] = $values['postal_greeting'];
 822       }
 823       return TRUE;
 824     }
 825
 826     if (isset($values['addressee'])) {
 827       $params['addressee'] = $values['addressee'];
 828       return TRUE;
 829     }
 830
 831     if (isset($values['gender'])) {
 832       if (!empty($params['gender_id'])) {
 833         $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
 834         $params['gender'] = $genders[$params['gender_id']];
 835       }
 836       else {
 837         $params['gender'] = $values['gender'];
 838       }
 839       return TRUE;
 840     }
 841
 842     if (!empty($values['preferred_communication_method'])) {
 843       $comm = [];
 844       $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER);
 845
 846       $preffComm = explode(',', $values['preferred_communication_method']);
 847       foreach ($preffComm as $v) {
 848         $v = strtolower(trim($v));
 849         if (array_key_exists($v, $pcm)) {
 850           $comm[$pcm[$v]] = 1;
 851         }
 852       }
 853
 854       $params['preferred_communication_method'] = $comm;
 855       return TRUE;
 856     }
 857
 858     // format the website params.
 859     if (!empty($values['url'])) {
 860       static $websiteFields;
 861       if (!is_array($websiteFields)) {
 862         $websiteFields = CRM_Core_DAO_Website::fields();
 863       }
 864       if (!array_key_exists('website', $params) ||
 865         !is_array($params['website'])
 866       ) {
 867         $params['website'] = [];
 868       }
 869
 870       $websiteCount = count($params['website']);
 871       _civicrm_api3_store_values($websiteFields, $values,
 872         $params['website'][++$websiteCount]
 873       );
 874
 875       return TRUE;
 876     }
 877
 878     if (isset($values['note'])) {
 879       // add a note field
 880       if (!isset($params['note'])) {
 881         $params['note'] = [];
 882       }
 883       $noteBlock = count($params['note']) + 1;
 884
 885       $params['note'][$noteBlock] = [];
 886       if (!isset($fields['Note'])) {
 887         $fields['Note'] = CRM_Core_DAO_Note::fields();
 888       }
 889
 890       // get the current logged in civicrm user
 891       $session = CRM_Core_Session::singleton();
 892       $userID = $session->get('userID');
 893
 894       if ($userID) {
 895         $values['contact_id'] = $userID;
 896       }
 897
 898       _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]);
 899
 900       return TRUE;
 901     }
 902
 903     // Check for custom field values
 904     $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $values),
 905       FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE
 906     );
 907
 908     foreach ($values as $key => $value) {
 909       if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
 910         // check if it's a valid custom field id
 911
 912         if (!array_key_exists($customFieldID, $customFields)) {
 913           return civicrm_api3_create_error('Invalid custom field ID');
 914         }
 915         else {
 916           $params[$key] = $value;
 917         }
 918       }
 919     }
 920     return TRUE;
 921   }
 922
 923   /**
 924    * Format location block ready for importing.
 925    *
 926    * There is some test coverage for this in CRM_Contact_Import_Parser_ContactTest
 927    * e.g. testImportPrimaryAddress.
 928    *
 929    * @param array $values
 930    * @param array $params
 931    *
 932    * @return bool
 933    */
 934   protected function formatLocationBlock(&$values, &$params) {
 935     $blockTypes = [
 936       'phone' => 'Phone',
 937       'email' => 'Email',
 938       'im' => 'IM',
 939       'openid' => 'OpenID',
 940       'phone_ext' => 'Phone',
 941     ];
 942     foreach ($blockTypes as $blockFieldName => $block) {
 943       if (!array_key_exists($blockFieldName, $values)) {
 944         continue;
 945       }
 946       $blockIndex = $values['location_type_id'] . (!empty($values['phone_type_id']) ? '_' . $values['phone_type_id'] : '');
 947
 948       // block present in value array.
 949       if (!array_key_exists($blockFieldName, $params) || !is_array($params[$blockFieldName])) {
 950         $params[$blockFieldName] = [];
 951       }
 952
 953       $fields[$block] = $this->getMetadataForEntity($block);
 954
 955       // copy value to dao field name.
 956       if ($blockFieldName == 'im') {
 957         $values['name'] = $values[$blockFieldName];
 958       }
 959
 960       _civicrm_api3_store_values($fields[$block], $values,
 961         $params[$blockFieldName][$blockIndex]
 962       );
 963
 964       $this->fillPrimary($params[$blockFieldName][$blockIndex], $values, $block, CRM_Utils_Array::value('id', $params));
 965
 966       if (empty($params['id']) && (count($params[$blockFieldName]) == 1)) {
 967         $params[$blockFieldName][$blockIndex]['is_primary'] = TRUE;
 968       }
 969
 970       // we only process single block at a time.
 971       return TRUE;
 972     }
 973
 974     // handle address fields.
 975     if (!array_key_exists('address', $params) || !is_array($params['address'])) {
 976       $params['address'] = [];
 977     }
 978
 979     // Note: we doing multiple value formatting here for address custom fields, plus putting into right format.
 980     // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving
 981     // the address in CRM_Core_BAO_Address::create method
 982     if (!empty($values['location_type_id'])) {
 983       static $customFields = [];
 984       if (empty($customFields)) {
 985         $customFields = CRM_Core_BAO_CustomField::getFields('Address');
 986       }
 987       // make a copy of values, as we going to make changes
 988       $newValues = $values;
 989       foreach ($values as $key => $val) {
 990         $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key);
 991         if ($customFieldID && array_key_exists($customFieldID, $customFields)) {
 992
 993           $htmlType = $customFields[$customFieldID]['html_type'] ?? NULL;
 994           if (CRM_Core_BAO_CustomField::isSerialized($customFields[$customFieldID]) && $val) {
 995             $mulValues = explode(',', $val);
 996             $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
 997             $newValues[$key] = [];
 998             foreach ($mulValues as $v1) {
 999               foreach ($customOption as $v2) {
1000                 if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
1001                   (strtolower($v2['value']) == strtolower(trim($v1)))
1002                 ) {
1003                   if ($htmlType == 'CheckBox') {
1004                     $newValues[$key][$v2['value']] = 1;
1005                   }
1006                   else {
1007                     $newValues[$key][] = $v2['value'];
1008                   }
1009                 }
1010               }
1011             }
1012           }
1013         }
1014       }
1015       // consider new values
1016       $values = $newValues;
1017     }
1018
1019     $fields['Address'] = $this->getMetadataForEntity('Address');
1020     // @todo this is kinda replicated below....
1021     _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$values['location_type_id']]);
1022
1023     $addressFields = [
1024       'county',
1025       'country',
1026       'state_province',
1027       'supplemental_address_1',
1028       'supplemental_address_2',
1029       'supplemental_address_3',
1030       'StateProvince.name',
1031     ];
1032     foreach (array_keys($customFields) as $customFieldID) {
1033       $addressFields[] = 'custom_' . $customFieldID;
1034     }
1035
1036     foreach ($addressFields as $field) {
1037       if (array_key_exists($field, $values)) {
1038         if (!array_key_exists('address', $params)) {
1039           $params['address'] = [];
1040         }
1041         $params['address'][$values['location_type_id']][$field] = $values[$field];
1042       }
1043     }
1044
1045     $this->fillPrimary($params['address'][$values['location_type_id']], $values, 'address', CRM_Utils_Array::value('id', $params));
1046     return TRUE;
1047   }
1048
1049   /**
1050    * Get the field metadata for the relevant entity.
1051    *
1052    * @param string $entity
1053    *
1054    * @return array
1055    */
1056   protected function getMetadataForEntity($entity) {
1057     if (!isset($this->fieldMetadata[$entity])) {
1058       $className = "CRM_Core_DAO_$entity";
1059       $this->fieldMetadata[$entity] = $className::fields();
1060     }
1061     return $this->fieldMetadata[$entity];
1062   }
1063
1064   /**
1065    * Fill in the primary location.
1066    *
1067    * If the contact has a primary address we update it. Otherwise
1068    * we add an address of the default location type.
1069    *
1070    * @param array $params
1071    *   Address block parameters
1072    * @param array $values
1073    *   Input values
1074    * @param string $entity
1075    *  - address, email, phone
1076    * @param int|null $contactID
1077    *
1078    * @throws \CiviCRM_API3_Exception
1079    */
1080   protected function fillPrimary(&$params, $values, $entity, $contactID) {
1081     if ($values['location_type_id'] === 'Primary') {
1082       if ($contactID) {
1083         $primary = civicrm_api3($entity, 'get', [
1084           'return' => 'location_type_id',
1085           'contact_id' => $contactID,
1086           'is_primary' => 1,
1087           'sequential' => 1,
1088         ]);
1089       }
1090       $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
1091       $params['location_type_id'] = (int) (isset($primary) && $primary['count']) ? $primary['values'][0]['location_type_id'] : $defaultLocationType->id;
1092       $params['is_primary'] = 1;
1093     }
1094   }
1095
1096 }