1374 lines
45 KiB
PHP
1374 lines
45 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
*/
|
||
|
|
abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
|
||
|
|
|
||
|
|
protected $_tableName;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Total number of lines in file
|
||
|
|
*
|
||
|
|
* @var integer
|
||
|
|
*/
|
||
|
|
protected $_rowCount;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Running total number of un-matched Contacts.
|
||
|
|
*/
|
||
|
|
protected $_unMatchCount;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of unmatched lines
|
||
|
|
*/
|
||
|
|
protected $_unMatch;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Total number of contacts with unparsed addresses
|
||
|
|
*/
|
||
|
|
protected $_unparsedAddressCount;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filename of mismatch data
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
protected $_misMatchFilemName;
|
||
|
|
|
||
|
|
protected $_primaryKeyName;
|
||
|
|
protected $_statusFieldName;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* On duplicate
|
||
|
|
*
|
||
|
|
* @var int
|
||
|
|
*/
|
||
|
|
public $_onDuplicate;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Dedupe rule group id to use if set
|
||
|
|
*
|
||
|
|
* @var int
|
||
|
|
*/
|
||
|
|
public $_dedupeRuleGroupID = NULL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Run import.
|
||
|
|
*
|
||
|
|
* @param string $tableName
|
||
|
|
* @param array $mapper
|
||
|
|
* @param int $mode
|
||
|
|
* @param int $contactType
|
||
|
|
* @param string $primaryKeyName
|
||
|
|
* @param string $statusFieldName
|
||
|
|
* @param int $onDuplicate
|
||
|
|
* @param int $statusID
|
||
|
|
* @param int $totalRowCount
|
||
|
|
* @param bool $doGeocodeAddress
|
||
|
|
* @param int $timeout
|
||
|
|
* @param string $contactSubType
|
||
|
|
* @param int $dedupeRuleGroupID
|
||
|
|
*
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function run(
|
||
|
|
$tableName,
|
||
|
|
&$mapper,
|
||
|
|
$mode = self::MODE_PREVIEW,
|
||
|
|
$contactType = self::CONTACT_INDIVIDUAL,
|
||
|
|
$primaryKeyName = '_id',
|
||
|
|
$statusFieldName = '_status',
|
||
|
|
$onDuplicate = self::DUPLICATE_SKIP,
|
||
|
|
$statusID = NULL,
|
||
|
|
$totalRowCount = NULL,
|
||
|
|
$doGeocodeAddress = FALSE,
|
||
|
|
$timeout = CRM_Contact_Import_Parser::DEFAULT_TIMEOUT,
|
||
|
|
$contactSubType = NULL,
|
||
|
|
$dedupeRuleGroupID = NULL
|
||
|
|
) {
|
||
|
|
|
||
|
|
// TODO: Make the timeout actually work
|
||
|
|
$this->_onDuplicate = $onDuplicate;
|
||
|
|
$this->_dedupeRuleGroupID = $dedupeRuleGroupID;
|
||
|
|
|
||
|
|
switch ($contactType) {
|
||
|
|
case CRM_Import_Parser::CONTACT_INDIVIDUAL:
|
||
|
|
$this->_contactType = 'Individual';
|
||
|
|
break;
|
||
|
|
|
||
|
|
case CRM_Import_Parser::CONTACT_HOUSEHOLD:
|
||
|
|
$this->_contactType = 'Household';
|
||
|
|
break;
|
||
|
|
|
||
|
|
case CRM_Import_Parser::CONTACT_ORGANIZATION:
|
||
|
|
$this->_contactType = 'Organization';
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->_contactSubType = $contactSubType;
|
||
|
|
|
||
|
|
$this->init();
|
||
|
|
|
||
|
|
$this->_rowCount = $this->_warningCount = 0;
|
||
|
|
$this->_invalidRowCount = $this->_validCount = 0;
|
||
|
|
$this->_totalCount = $this->_conflictCount = 0;
|
||
|
|
|
||
|
|
$this->_errors = array();
|
||
|
|
$this->_warnings = array();
|
||
|
|
$this->_conflicts = array();
|
||
|
|
$this->_unparsedAddresses = array();
|
||
|
|
|
||
|
|
$this->_tableName = $tableName;
|
||
|
|
$this->_primaryKeyName = $primaryKeyName;
|
||
|
|
$this->_statusFieldName = $statusFieldName;
|
||
|
|
|
||
|
|
if ($mode == self::MODE_MAPFIELD) {
|
||
|
|
$this->_rows = array();
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$this->_activeFieldCount = count($this->_activeFields);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($mode == self::MODE_IMPORT) {
|
||
|
|
//get the key of email field
|
||
|
|
foreach ($mapper as $key => $value) {
|
||
|
|
if (strtolower($value) == 'email') {
|
||
|
|
$emailKey = $key;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($statusID) {
|
||
|
|
$skip = 50;
|
||
|
|
// $skip = 1;
|
||
|
|
$config = CRM_Core_Config::singleton();
|
||
|
|
$statusFile = "{$config->uploadDir}status_{$statusID}.txt";
|
||
|
|
$status = "<div class='description'> " . ts('No processing status reported yet.') . "</div>";
|
||
|
|
|
||
|
|
//do not force the browser to display the save dialog, CRM-7640
|
||
|
|
$contents = json_encode(array(0, $status));
|
||
|
|
|
||
|
|
file_put_contents($statusFile, $contents);
|
||
|
|
|
||
|
|
$startTimestamp = $currTimestamp = $prevTimestamp = time();
|
||
|
|
}
|
||
|
|
|
||
|
|
// get the contents of the temp. import table
|
||
|
|
$query = "SELECT * FROM $tableName";
|
||
|
|
if ($mode == self::MODE_IMPORT) {
|
||
|
|
$query .= " WHERE $statusFieldName = 'NEW'";
|
||
|
|
}
|
||
|
|
$dao = new CRM_Core_DAO();
|
||
|
|
$db = $dao->getDatabaseConnection();
|
||
|
|
$result = $db->query($query);
|
||
|
|
|
||
|
|
while ($values = $result->fetchRow(DB_FETCHMODE_ORDERED)) {
|
||
|
|
$this->_rowCount++;
|
||
|
|
|
||
|
|
/* trim whitespace around the values */
|
||
|
|
foreach ($values as $k => $v) {
|
||
|
|
$values[$k] = trim($v, " \t\r\n");
|
||
|
|
}
|
||
|
|
if (CRM_Utils_System::isNull($values)) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->_totalCount++;
|
||
|
|
|
||
|
|
if ($mode == self::MODE_MAPFIELD) {
|
||
|
|
$returnCode = $this->mapField($values);
|
||
|
|
}
|
||
|
|
elseif ($mode == self::MODE_PREVIEW) {
|
||
|
|
$returnCode = $this->preview($values);
|
||
|
|
}
|
||
|
|
elseif ($mode == self::MODE_SUMMARY) {
|
||
|
|
$returnCode = $this->summary($values);
|
||
|
|
}
|
||
|
|
elseif ($mode == self::MODE_IMPORT) {
|
||
|
|
//print "Running parser in import mode<br/>\n";
|
||
|
|
$returnCode = $this->import($onDuplicate, $values, $doGeocodeAddress);
|
||
|
|
if ($statusID && (($this->_rowCount % $skip) == 0)) {
|
||
|
|
$currTimestamp = time();
|
||
|
|
$totalTime = ($currTimestamp - $startTimestamp);
|
||
|
|
$time = ($currTimestamp - $prevTimestamp);
|
||
|
|
$recordsLeft = $totalRowCount - $this->_rowCount;
|
||
|
|
if ($recordsLeft < 0) {
|
||
|
|
$recordsLeft = 0;
|
||
|
|
}
|
||
|
|
$estimatedTime = ($recordsLeft / $skip) * $time;
|
||
|
|
$estMinutes = floor($estimatedTime / 60);
|
||
|
|
$timeFormatted = '';
|
||
|
|
if ($estMinutes > 1) {
|
||
|
|
$timeFormatted = $estMinutes . ' ' . ts('minutes') . ' ';
|
||
|
|
$estimatedTime = $estimatedTime - ($estMinutes * 60);
|
||
|
|
}
|
||
|
|
$timeFormatted .= round($estimatedTime) . ' ' . ts('seconds');
|
||
|
|
$processedPercent = (int ) (($this->_rowCount * 100) / $totalRowCount);
|
||
|
|
$statusMsg = ts('%1 of %2 records - %3 remaining',
|
||
|
|
array(1 => $this->_rowCount, 2 => $totalRowCount, 3 => $timeFormatted)
|
||
|
|
);
|
||
|
|
$status = "
|
||
|
|
<div class=\"description\">
|
||
|
|
<strong>{$statusMsg}</strong>
|
||
|
|
</div>
|
||
|
|
";
|
||
|
|
|
||
|
|
$contents = json_encode(array($processedPercent, $status));
|
||
|
|
|
||
|
|
file_put_contents($statusFile, $contents);
|
||
|
|
|
||
|
|
$prevTimestamp = $currTimestamp;
|
||
|
|
}
|
||
|
|
// sleep(1);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$returnCode = self::ERROR;
|
||
|
|
}
|
||
|
|
|
||
|
|
// note that a line could be valid but still produce a warning
|
||
|
|
if ($returnCode & self::VALID) {
|
||
|
|
$this->_validCount++;
|
||
|
|
if ($mode == self::MODE_MAPFIELD) {
|
||
|
|
$this->_rows[] = $values;
|
||
|
|
$this->_activeFieldCount = max($this->_activeFieldCount, count($values));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($returnCode & self::WARNING) {
|
||
|
|
$this->_warningCount++;
|
||
|
|
if ($this->_warningCount < $this->_maxWarningCount) {
|
||
|
|
$this->_warningCount[] = $line;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($returnCode & self::ERROR) {
|
||
|
|
$this->_invalidRowCount++;
|
||
|
|
if ($this->_invalidRowCount < $this->_maxErrorCount) {
|
||
|
|
array_unshift($values, $this->_rowCount);
|
||
|
|
$this->_errors[] = $values;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($returnCode & self::CONFLICT) {
|
||
|
|
$this->_conflictCount++;
|
||
|
|
array_unshift($values, $this->_rowCount);
|
||
|
|
$this->_conflicts[] = $values;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($returnCode & self::NO_MATCH) {
|
||
|
|
$this->_unMatchCount++;
|
||
|
|
array_unshift($values, $this->_rowCount);
|
||
|
|
$this->_unMatch[] = $values;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($returnCode & self::DUPLICATE) {
|
||
|
|
if ($returnCode & self::MULTIPLE_DUPE) {
|
||
|
|
/* TODO: multi-dupes should be counted apart from singles
|
||
|
|
* on non-skip action */
|
||
|
|
}
|
||
|
|
$this->_duplicateCount++;
|
||
|
|
array_unshift($values, $this->_rowCount);
|
||
|
|
$this->_duplicates[] = $values;
|
||
|
|
if ($onDuplicate != self::DUPLICATE_SKIP) {
|
||
|
|
$this->_validCount++;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($returnCode & self::UNPARSED_ADDRESS_WARNING) {
|
||
|
|
$this->_unparsedAddressCount++;
|
||
|
|
array_unshift($values, $this->_rowCount);
|
||
|
|
$this->_unparsedAddresses[] = $values;
|
||
|
|
}
|
||
|
|
// we give the derived class a way of aborting the process
|
||
|
|
// note that the return code could be multiple code or'ed together
|
||
|
|
if ($returnCode & self::STOP) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
// if we are done processing the maxNumber of lines, break
|
||
|
|
if ($this->_maxLinesToProcess > 0 && $this->_validCount >= $this->_maxLinesToProcess) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
// clean up memory from dao's
|
||
|
|
CRM_Core_DAO::freeResult();
|
||
|
|
|
||
|
|
// see if we've hit our timeout yet
|
||
|
|
/* if ( $the_thing_with_the_stuff ) {
|
||
|
|
do_something( );
|
||
|
|
} */
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($mode == self::MODE_PREVIEW || $mode == self::MODE_IMPORT) {
|
||
|
|
$customHeaders = $mapper;
|
||
|
|
|
||
|
|
$customfields = CRM_Core_BAO_CustomField::getFields($this->_contactType);
|
||
|
|
foreach ($customHeaders as $key => $value) {
|
||
|
|
if ($id = CRM_Core_BAO_CustomField::getKeyID($value)) {
|
||
|
|
$customHeaders[$key] = $customfields[$id][0];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->_invalidRowCount) {
|
||
|
|
// removed view url for invlaid contacts
|
||
|
|
$headers = array_merge(array(
|
||
|
|
ts('Line Number'),
|
||
|
|
ts('Reason'),
|
||
|
|
),
|
||
|
|
$customHeaders
|
||
|
|
);
|
||
|
|
$this->_errorFileName = self::errorFileName(self::ERROR);
|
||
|
|
self::exportCSV($this->_errorFileName, $headers, $this->_errors);
|
||
|
|
}
|
||
|
|
if ($this->_conflictCount) {
|
||
|
|
$headers = array_merge(array(
|
||
|
|
ts('Line Number'),
|
||
|
|
ts('Reason'),
|
||
|
|
),
|
||
|
|
$customHeaders
|
||
|
|
);
|
||
|
|
$this->_conflictFileName = self::errorFileName(self::CONFLICT);
|
||
|
|
self::exportCSV($this->_conflictFileName, $headers, $this->_conflicts);
|
||
|
|
}
|
||
|
|
if ($this->_duplicateCount) {
|
||
|
|
$headers = array_merge(array(
|
||
|
|
ts('Line Number'),
|
||
|
|
ts('View Contact URL'),
|
||
|
|
),
|
||
|
|
$customHeaders
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->_duplicateFileName = self::errorFileName(self::DUPLICATE);
|
||
|
|
self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates);
|
||
|
|
}
|
||
|
|
if ($this->_unMatchCount) {
|
||
|
|
$headers = array_merge(array(
|
||
|
|
ts('Line Number'),
|
||
|
|
ts('Reason'),
|
||
|
|
),
|
||
|
|
$customHeaders
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->_misMatchFilemName = self::errorFileName(self::NO_MATCH);
|
||
|
|
self::exportCSV($this->_misMatchFilemName, $headers, $this->_unMatch);
|
||
|
|
}
|
||
|
|
if ($this->_unparsedAddressCount) {
|
||
|
|
$headers = array_merge(array(
|
||
|
|
ts('Line Number'),
|
||
|
|
ts('Contact Edit URL'),
|
||
|
|
),
|
||
|
|
$customHeaders
|
||
|
|
);
|
||
|
|
$this->_errorFileName = self::errorFileName(self::UNPARSED_ADDRESS_WARNING);
|
||
|
|
self::exportCSV($this->_errorFileName, $headers, $this->_unparsedAddresses);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
//echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
|
||
|
|
return $this->fini();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Given a list of the importable field keys that the user has selected.
|
||
|
|
* set the active fields array to this list
|
||
|
|
*
|
||
|
|
* @param array $fieldKeys
|
||
|
|
* Mapped array of values.
|
||
|
|
*/
|
||
|
|
public function setActiveFields($fieldKeys) {
|
||
|
|
$this->_activeFieldCount = count($fieldKeys);
|
||
|
|
foreach ($fieldKeys as $key) {
|
||
|
|
if (empty($this->_fields[$key])) {
|
||
|
|
$this->_activeFields[] = new CRM_Contact_Import_Field('', ts('- do not import -'));
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$this->_activeFields[] = clone($this->_fields[$key]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldLocationTypes($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_hasLocationType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldPhoneTypes($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_phoneType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldWebsiteTypes($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_websiteType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set IM Service Provider type fields.
|
||
|
|
*
|
||
|
|
* @param array $elements
|
||
|
|
* IM service provider type ids.
|
||
|
|
*/
|
||
|
|
public function setActiveFieldImProviders($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_imProvider = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelated($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_related = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelatedContactType($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_relatedContactType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelatedContactDetails($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_relatedContactDetails = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelatedContactLocType($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_relatedContactLocType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set active field for related contact's phone type.
|
||
|
|
*
|
||
|
|
* @param array $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelatedContactPhoneType($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $elements
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelatedContactWebsiteType($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set IM Service Provider type fields for related contacts.
|
||
|
|
*
|
||
|
|
* @param array $elements
|
||
|
|
* IM service provider type ids of related contact.
|
||
|
|
*/
|
||
|
|
public function setActiveFieldRelatedContactImProvider($elements) {
|
||
|
|
for ($i = 0; $i < count($elements); $i++) {
|
||
|
|
$this->_activeFields[$i]->_relatedContactImProvider = $elements[$i];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Format the field values for input to the api.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* (reference ) associative array of name/value pairs
|
||
|
|
*/
|
||
|
|
public function &getActiveFieldParams() {
|
||
|
|
$params = array();
|
||
|
|
|
||
|
|
for ($i = 0; $i < $this->_activeFieldCount; $i++) {
|
||
|
|
if ($this->_activeFields[$i]->_name == 'do_not_import') {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($this->_activeFields[$i]->_value)) {
|
||
|
|
if (isset($this->_activeFields[$i]->_hasLocationType)) {
|
||
|
|
if (!isset($params[$this->_activeFields[$i]->_name])) {
|
||
|
|
$params[$this->_activeFields[$i]->_name] = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
$value = array(
|
||
|
|
$this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value,
|
||
|
|
'location_type_id' => $this->_activeFields[$i]->_hasLocationType,
|
||
|
|
);
|
||
|
|
|
||
|
|
if (isset($this->_activeFields[$i]->_phoneType)) {
|
||
|
|
$value['phone_type_id'] = $this->_activeFields[$i]->_phoneType;
|
||
|
|
}
|
||
|
|
|
||
|
|
// get IM service Provider type id
|
||
|
|
if (isset($this->_activeFields[$i]->_imProvider)) {
|
||
|
|
$value['provider_id'] = $this->_activeFields[$i]->_imProvider;
|
||
|
|
}
|
||
|
|
|
||
|
|
$params[$this->_activeFields[$i]->_name][] = $value;
|
||
|
|
}
|
||
|
|
elseif (isset($this->_activeFields[$i]->_websiteType)) {
|
||
|
|
$value = array(
|
||
|
|
$this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value,
|
||
|
|
'website_type_id' => $this->_activeFields[$i]->_websiteType,
|
||
|
|
);
|
||
|
|
|
||
|
|
$params[$this->_activeFields[$i]->_name][] = $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($params[$this->_activeFields[$i]->_name])) {
|
||
|
|
if (!isset($this->_activeFields[$i]->_related)) {
|
||
|
|
$params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//minor fix for CRM-4062
|
||
|
|
if (isset($this->_activeFields[$i]->_related)) {
|
||
|
|
if (!isset($params[$this->_activeFields[$i]->_related])) {
|
||
|
|
$params[$this->_activeFields[$i]->_related] = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($params[$this->_activeFields[$i]->_related]['contact_type']) && !empty($this->_activeFields[$i]->_relatedContactType)) {
|
||
|
|
$params[$this->_activeFields[$i]->_related]['contact_type'] = $this->_activeFields[$i]->_relatedContactType;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($this->_activeFields[$i]->_relatedContactLocType) && !empty($this->_activeFields[$i]->_value)) {
|
||
|
|
if (!empty($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails]) &&
|
||
|
|
!is_array($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails])
|
||
|
|
) {
|
||
|
|
$params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = array();
|
||
|
|
}
|
||
|
|
$value = array(
|
||
|
|
$this->_activeFields[$i]->_relatedContactDetails => $this->_activeFields[$i]->_value,
|
||
|
|
'location_type_id' => $this->_activeFields[$i]->_relatedContactLocType,
|
||
|
|
);
|
||
|
|
|
||
|
|
if (isset($this->_activeFields[$i]->_relatedContactPhoneType)) {
|
||
|
|
$value['phone_type_id'] = $this->_activeFields[$i]->_relatedContactPhoneType;
|
||
|
|
}
|
||
|
|
|
||
|
|
// get IM service Provider type id for related contact
|
||
|
|
if (isset($this->_activeFields[$i]->_relatedContactImProvider)) {
|
||
|
|
$value['provider_id'] = $this->_activeFields[$i]->_relatedContactImProvider;
|
||
|
|
}
|
||
|
|
|
||
|
|
$params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = $value;
|
||
|
|
}
|
||
|
|
elseif (isset($this->_activeFields[$i]->_relatedContactWebsiteType)) {
|
||
|
|
$params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = array(
|
||
|
|
'url' => $this->_activeFields[$i]->_value,
|
||
|
|
'website_type_id' => $this->_activeFields[$i]->_relatedContactWebsiteType,
|
||
|
|
);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = $this->_activeFields[$i]->_value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $params;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getColumnPatterns() {
|
||
|
|
$values = array();
|
||
|
|
foreach ($this->_fields as $name => $field) {
|
||
|
|
$values[$name] = $field->_columnPattern;
|
||
|
|
}
|
||
|
|
return $values;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $name
|
||
|
|
* @param $title
|
||
|
|
* @param int $type
|
||
|
|
* @param string $headerPattern
|
||
|
|
* @param string $dataPattern
|
||
|
|
* @param bool $hasLocationType
|
||
|
|
*/
|
||
|
|
public function addField(
|
||
|
|
$name, $title, $type = CRM_Utils_Type::T_INT,
|
||
|
|
$headerPattern = '//', $dataPattern = '//',
|
||
|
|
$hasLocationType = FALSE
|
||
|
|
) {
|
||
|
|
$this->_fields[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
|
||
|
|
if (empty($name)) {
|
||
|
|
$this->_fields['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Store parser values.
|
||
|
|
*
|
||
|
|
* @param CRM_Core_Session $store
|
||
|
|
*
|
||
|
|
* @param int $mode
|
||
|
|
*/
|
||
|
|
public function set($store, $mode = self::MODE_SUMMARY) {
|
||
|
|
$store->set('rowCount', $this->_rowCount);
|
||
|
|
$store->set('fields', $this->getSelectValues());
|
||
|
|
$store->set('fieldTypes', $this->getSelectTypes());
|
||
|
|
|
||
|
|
$store->set('columnPatterns', $this->getColumnPatterns());
|
||
|
|
$store->set('dataPatterns', $this->getDataPatterns());
|
||
|
|
$store->set('columnCount', $this->_activeFieldCount);
|
||
|
|
|
||
|
|
$store->set('totalRowCount', $this->_totalCount);
|
||
|
|
$store->set('validRowCount', $this->_validCount);
|
||
|
|
$store->set('invalidRowCount', $this->_invalidRowCount);
|
||
|
|
$store->set('conflictRowCount', $this->_conflictCount);
|
||
|
|
$store->set('unMatchCount', $this->_unMatchCount);
|
||
|
|
|
||
|
|
switch ($this->_contactType) {
|
||
|
|
case 'Individual':
|
||
|
|
$store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'Household':
|
||
|
|
$store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'Organization':
|
||
|
|
$store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->_invalidRowCount) {
|
||
|
|
$store->set('errorsFileName', $this->_errorFileName);
|
||
|
|
}
|
||
|
|
if ($this->_conflictCount) {
|
||
|
|
$store->set('conflictsFileName', $this->_conflictFileName);
|
||
|
|
}
|
||
|
|
if (isset($this->_rows) && !empty($this->_rows)) {
|
||
|
|
$store->set('dataValues', $this->_rows);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->_unMatchCount) {
|
||
|
|
$store->set('mismatchFileName', $this->_misMatchFilemName);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($mode == self::MODE_IMPORT) {
|
||
|
|
$store->set('duplicateRowCount', $this->_duplicateCount);
|
||
|
|
$store->set('unparsedAddressCount', $this->_unparsedAddressCount);
|
||
|
|
if ($this->_duplicateCount) {
|
||
|
|
$store->set('duplicatesFileName', $this->_duplicateFileName);
|
||
|
|
}
|
||
|
|
if ($this->_unparsedAddressCount) {
|
||
|
|
$store->set('errorsFileName', $this->_errorFileName);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
//echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Export data to a CSV file.
|
||
|
|
*
|
||
|
|
* @param string $fileName
|
||
|
|
* @param array $header
|
||
|
|
* @param array $data
|
||
|
|
*/
|
||
|
|
public static function exportCSV($fileName, $header, $data) {
|
||
|
|
|
||
|
|
if (file_exists($fileName) && !is_writable($fileName)) {
|
||
|
|
CRM_Core_Error::movedSiteError($fileName);
|
||
|
|
}
|
||
|
|
//hack to remove '_status', '_statusMsg' and '_id' from error file
|
||
|
|
$errorValues = array();
|
||
|
|
$dbRecordStatus = array('IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW');
|
||
|
|
foreach ($data as $rowCount => $rowValues) {
|
||
|
|
$count = 0;
|
||
|
|
foreach ($rowValues as $key => $val) {
|
||
|
|
if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$errorValues[$rowCount][$key] = $val;
|
||
|
|
$count++;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$data = $errorValues;
|
||
|
|
|
||
|
|
$output = array();
|
||
|
|
$fd = fopen($fileName, 'w');
|
||
|
|
|
||
|
|
foreach ($header as $key => $value) {
|
||
|
|
$header[$key] = "\"$value\"";
|
||
|
|
}
|
||
|
|
$config = CRM_Core_Config::singleton();
|
||
|
|
$output[] = implode($config->fieldSeparator, $header);
|
||
|
|
|
||
|
|
foreach ($data as $datum) {
|
||
|
|
foreach ($datum as $key => $value) {
|
||
|
|
$datum[$key] = "\"$value\"";
|
||
|
|
}
|
||
|
|
$output[] = implode($config->fieldSeparator, $datum);
|
||
|
|
}
|
||
|
|
fwrite($fd, implode("\n", $output));
|
||
|
|
fclose($fd);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the record with PK $id in the import database table.
|
||
|
|
*
|
||
|
|
* @param int $id
|
||
|
|
* @param array $params
|
||
|
|
*/
|
||
|
|
public function updateImportRecord($id, &$params) {
|
||
|
|
$statusFieldName = $this->_statusFieldName;
|
||
|
|
$primaryKeyName = $this->_primaryKeyName;
|
||
|
|
|
||
|
|
if ($statusFieldName && $primaryKeyName) {
|
||
|
|
$dao = new CRM_Core_DAO();
|
||
|
|
$db = $dao->getDatabaseConnection();
|
||
|
|
|
||
|
|
$query = "UPDATE $this->_tableName
|
||
|
|
SET $statusFieldName = ?,
|
||
|
|
${statusFieldName}Msg = ?
|
||
|
|
WHERE $primaryKeyName = ?";
|
||
|
|
$args = array(
|
||
|
|
$params[$statusFieldName],
|
||
|
|
CRM_Utils_Array::value("${statusFieldName}Msg", $params),
|
||
|
|
$id,
|
||
|
|
);
|
||
|
|
|
||
|
|
//print "Running query: $query<br/>With arguments: ".$params[$statusFieldName].", ".$params["${statusFieldName}Msg"].", $id<br/>";
|
||
|
|
|
||
|
|
$db->query($query, $args);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Format common params data to proper format to store.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Contain record values.
|
||
|
|
* @param array $formatted
|
||
|
|
* Array of formatted data.
|
||
|
|
* @param array $contactFields
|
||
|
|
* Contact DAO fields.
|
||
|
|
*/
|
||
|
|
public function formatCommonData($params, &$formatted, &$contactFields) {
|
||
|
|
$csType = array(
|
||
|
|
CRM_Utils_Array::value('contact_type', $formatted),
|
||
|
|
);
|
||
|
|
|
||
|
|
//CRM-5125
|
||
|
|
//add custom fields for contact sub type
|
||
|
|
if (!empty($this->_contactSubType)) {
|
||
|
|
$csType = $this->_contactSubType;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($relCsType = CRM_Utils_Array::value('contact_sub_type', $formatted)) {
|
||
|
|
$csType = $relCsType;
|
||
|
|
}
|
||
|
|
|
||
|
|
$customFields = CRM_Core_BAO_CustomField::getFields($formatted['contact_type'], FALSE, FALSE, $csType);
|
||
|
|
|
||
|
|
$addressCustomFields = CRM_Core_BAO_CustomField::getFields('Address');
|
||
|
|
$customFields = $customFields + $addressCustomFields;
|
||
|
|
|
||
|
|
//if a Custom Email Greeting, Custom Postal Greeting or Custom Addressee is mapped, and no "Greeting / Addressee Type ID" is provided, then automatically set the type = Customized, CRM-4575
|
||
|
|
$elements = array(
|
||
|
|
'email_greeting_custom' => 'email_greeting',
|
||
|
|
'postal_greeting_custom' => 'postal_greeting',
|
||
|
|
'addressee_custom' => 'addressee',
|
||
|
|
);
|
||
|
|
foreach ($elements as $k => $v) {
|
||
|
|
if (array_key_exists($k, $params) && !(array_key_exists($v, $params))) {
|
||
|
|
$label = key(CRM_Core_OptionGroup::values($v, TRUE, NULL, NULL, 'AND v.name = "Customized"'));
|
||
|
|
$params[$v] = $label;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//format date first
|
||
|
|
$session = CRM_Core_Session::singleton();
|
||
|
|
$dateType = $session->get("dateTypes");
|
||
|
|
foreach ($params as $key => $val) {
|
||
|
|
$customFieldID = CRM_Core_BAO_CustomField::getKeyID($key);
|
||
|
|
if ($customFieldID &&
|
||
|
|
!array_key_exists($customFieldID, $addressCustomFields)
|
||
|
|
) {
|
||
|
|
//we should not update Date to null, CRM-4062
|
||
|
|
if ($val && ($customFields[$customFieldID]['data_type'] == 'Date')) {
|
||
|
|
//CRM-21267
|
||
|
|
CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $formatted, $dateType, $key);
|
||
|
|
}
|
||
|
|
elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
|
||
|
|
if (empty($val) && !is_numeric($val) && $this->_onDuplicate == CRM_Import_Parser::DUPLICATE_FILL) {
|
||
|
|
//retain earlier value when Import mode is `Fill`
|
||
|
|
unset($params[$key]);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params[$key] = CRM_Utils_String::strtoboolstr($val);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($key == 'birth_date' && $val) {
|
||
|
|
CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key);
|
||
|
|
}
|
||
|
|
elseif ($key == 'deceased_date' && $val) {
|
||
|
|
CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key);
|
||
|
|
$params['is_deceased'] = 1;
|
||
|
|
}
|
||
|
|
elseif ($key == 'is_deceased' && $val) {
|
||
|
|
$params[$key] = CRM_Utils_String::strtoboolstr($val);
|
||
|
|
}
|
||
|
|
elseif ($key == 'gender') {
|
||
|
|
//CRM-4360
|
||
|
|
$params[$key] = $this->checkGender($val);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//now format custom data.
|
||
|
|
foreach ($params as $key => $field) {
|
||
|
|
if (is_array($field)) {
|
||
|
|
$isAddressCustomField = FALSE;
|
||
|
|
foreach ($field as $value) {
|
||
|
|
$break = FALSE;
|
||
|
|
if (is_array($value)) {
|
||
|
|
foreach ($value as $name => $testForEmpty) {
|
||
|
|
if ($addressCustomFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
|
||
|
|
$isAddressCustomField = TRUE;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
// check if $value does not contain IM provider or phoneType
|
||
|
|
if (($name !== 'phone_type_id' || $name !== 'provider_id') && ($testForEmpty === '' || $testForEmpty == NULL)) {
|
||
|
|
$break = TRUE;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$break = TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$break) {
|
||
|
|
$this->formatContactParameters($value, $formatted);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!$isAddressCustomField) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$formatValues = array(
|
||
|
|
$key => $field,
|
||
|
|
);
|
||
|
|
|
||
|
|
if (($key !== 'preferred_communication_method') && (array_key_exists($key, $contactFields))) {
|
||
|
|
// due to merging of individual table and
|
||
|
|
// contact table, we need to avoid
|
||
|
|
// preferred_communication_method forcefully
|
||
|
|
$formatValues['contact_type'] = $formatted['contact_type'];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($key == 'id' && isset($field)) {
|
||
|
|
$formatted[$key] = $field;
|
||
|
|
}
|
||
|
|
$this->formatContactParameters($formatValues, $formatted);
|
||
|
|
|
||
|
|
//Handling Custom Data
|
||
|
|
// note: Address custom fields will be handled separately inside formatContactParameters
|
||
|
|
if (($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) &&
|
||
|
|
array_key_exists($customFieldID, $customFields) &&
|
||
|
|
!array_key_exists($customFieldID, $addressCustomFields)
|
||
|
|
) {
|
||
|
|
|
||
|
|
$extends = CRM_Utils_Array::value('extends', $customFields[$customFieldID]);
|
||
|
|
$htmlType = CRM_Utils_Array::value('html_type', $customFields[$customFieldID]);
|
||
|
|
switch ($htmlType) {
|
||
|
|
case 'Select':
|
||
|
|
case 'Radio':
|
||
|
|
case 'Autocomplete-Select':
|
||
|
|
if ($customFields[$customFieldID]['data_type'] == 'String' || $customFields[$customFieldID]['data_type'] == 'Int') {
|
||
|
|
$customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
|
||
|
|
foreach ($customOption as $customValue) {
|
||
|
|
$val = CRM_Utils_Array::value('value', $customValue);
|
||
|
|
$label = CRM_Utils_Array::value('label', $customValue);
|
||
|
|
$label = strtolower($label);
|
||
|
|
$value = strtolower(trim($formatted[$key]));
|
||
|
|
if (($value == $label) || ($value == strtolower($val))) {
|
||
|
|
$params[$key] = $formatted[$key] = $val;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'CheckBox':
|
||
|
|
case 'AdvMulti-Select':
|
||
|
|
case 'Multi-Select':
|
||
|
|
|
||
|
|
if (!empty($formatted[$key]) && !empty($params[$key])) {
|
||
|
|
$mulValues = explode(',', $formatted[$key]);
|
||
|
|
$customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
|
||
|
|
$formatted[$key] = array();
|
||
|
|
$params[$key] = array();
|
||
|
|
foreach ($mulValues as $v1) {
|
||
|
|
foreach ($customOption as $v2) {
|
||
|
|
if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
|
||
|
|
(strtolower($v2['value']) == strtolower(trim($v1)))
|
||
|
|
) {
|
||
|
|
if ($htmlType == 'CheckBox') {
|
||
|
|
$params[$key][$v2['value']] = $formatted[$key][$v2['value']] = 1;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params[$key][] = $formatted[$key][] = $v2['value'];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($key) && ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) && array_key_exists($customFieldID, $customFields) &&
|
||
|
|
!array_key_exists($customFieldID, $addressCustomFields)
|
||
|
|
) {
|
||
|
|
// @todo calling api functions directly is not supported
|
||
|
|
_civicrm_api3_custom_format_params($params, $formatted, $extends);
|
||
|
|
}
|
||
|
|
|
||
|
|
// to check if not update mode and unset the fields with empty value.
|
||
|
|
if (!$this->_updateWithId && array_key_exists('custom', $formatted)) {
|
||
|
|
foreach ($formatted['custom'] as $customKey => $customvalue) {
|
||
|
|
if (empty($formatted['custom'][$customKey][-1]['is_required'])) {
|
||
|
|
$formatted['custom'][$customKey][-1]['is_required'] = $customFields[$customKey]['is_required'];
|
||
|
|
}
|
||
|
|
$emptyValue = CRM_Utils_Array::value('value', $customvalue[-1]);
|
||
|
|
if (!isset($emptyValue)) {
|
||
|
|
unset($formatted['custom'][$customKey]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// parse street address, CRM-5450
|
||
|
|
if ($this->_parseStreetAddress) {
|
||
|
|
if (array_key_exists('address', $formatted) && is_array($formatted['address'])) {
|
||
|
|
foreach ($formatted['address'] as $instance => & $address) {
|
||
|
|
$streetAddress = CRM_Utils_Array::value('street_address', $address);
|
||
|
|
if (empty($streetAddress)) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
// parse address field.
|
||
|
|
$parsedFields = CRM_Core_BAO_Address::parseStreetAddress($streetAddress);
|
||
|
|
|
||
|
|
//street address consider to be parsed properly,
|
||
|
|
//If we get street_name and street_number.
|
||
|
|
if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) {
|
||
|
|
$parsedFields = array_fill_keys(array_keys($parsedFields), '');
|
||
|
|
}
|
||
|
|
|
||
|
|
// merge parse address w/ main address block.
|
||
|
|
$address = array_merge($address, $parsedFields);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Format contact parameters.
|
||
|
|
*
|
||
|
|
* @todo this function needs re-writing & re-merging into the main function.
|
||
|
|
*
|
||
|
|
* Here be dragons.
|
||
|
|
*
|
||
|
|
* @param array $values
|
||
|
|
* @param array $params
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
protected function formatContactParameters(&$values, &$params) {
|
||
|
|
// Crawl through the possible classes:
|
||
|
|
// Contact
|
||
|
|
// Individual
|
||
|
|
// Household
|
||
|
|
// Organization
|
||
|
|
// Location
|
||
|
|
// Address
|
||
|
|
// Email
|
||
|
|
// Phone
|
||
|
|
// IM
|
||
|
|
// Note
|
||
|
|
// Custom
|
||
|
|
|
||
|
|
// Cache the various object fields
|
||
|
|
static $fields = array();
|
||
|
|
|
||
|
|
// first add core contact values since for other Civi modules they are not added
|
||
|
|
$contactFields = CRM_Contact_DAO_Contact::fields();
|
||
|
|
_civicrm_api3_store_values($contactFields, $values, $params);
|
||
|
|
|
||
|
|
if (isset($values['contact_type'])) {
|
||
|
|
// we're an individual/household/org property
|
||
|
|
|
||
|
|
$fields[$values['contact_type']] = CRM_Contact_DAO_Contact::fields();
|
||
|
|
|
||
|
|
_civicrm_api3_store_values($fields[$values['contact_type']], $values, $params);
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($values['individual_prefix'])) {
|
||
|
|
if (!empty($params['prefix_id'])) {
|
||
|
|
$prefixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id');
|
||
|
|
$params['prefix'] = $prefixes[$params['prefix_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['prefix'] = $values['individual_prefix'];
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($values['individual_suffix'])) {
|
||
|
|
if (!empty($params['suffix_id'])) {
|
||
|
|
$suffixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id');
|
||
|
|
$params['suffix'] = $suffixes[$params['suffix_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['suffix'] = $values['individual_suffix'];
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
// CRM-4575
|
||
|
|
if (isset($values['email_greeting'])) {
|
||
|
|
if (!empty($params['email_greeting_id'])) {
|
||
|
|
$emailGreetingFilter = array(
|
||
|
|
'contact_type' => CRM_Utils_Array::value('contact_type', $params),
|
||
|
|
'greeting_type' => 'email_greeting',
|
||
|
|
);
|
||
|
|
$emailGreetings = CRM_Core_PseudoConstant::greeting($emailGreetingFilter);
|
||
|
|
$params['email_greeting'] = $emailGreetings[$params['email_greeting_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['email_greeting'] = $values['email_greeting'];
|
||
|
|
}
|
||
|
|
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($values['postal_greeting'])) {
|
||
|
|
if (!empty($params['postal_greeting_id'])) {
|
||
|
|
$postalGreetingFilter = array(
|
||
|
|
'contact_type' => CRM_Utils_Array::value('contact_type', $params),
|
||
|
|
'greeting_type' => 'postal_greeting',
|
||
|
|
);
|
||
|
|
$postalGreetings = CRM_Core_PseudoConstant::greeting($postalGreetingFilter);
|
||
|
|
$params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['postal_greeting'] = $values['postal_greeting'];
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($values['addressee'])) {
|
||
|
|
if (!empty($params['addressee_id'])) {
|
||
|
|
$addresseeFilter = array(
|
||
|
|
'contact_type' => CRM_Utils_Array::value('contact_type', $params),
|
||
|
|
'greeting_type' => 'addressee',
|
||
|
|
);
|
||
|
|
$addressee = CRM_Core_PseudoConstant::addressee($addresseeFilter);
|
||
|
|
$params['addressee'] = $addressee[$params['addressee_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['addressee'] = $values['addressee'];
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($values['gender'])) {
|
||
|
|
if (!empty($params['gender_id'])) {
|
||
|
|
$genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
|
||
|
|
$params['gender'] = $genders[$params['gender_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['gender'] = $values['gender'];
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($values['preferred_communication_method'])) {
|
||
|
|
$comm = array();
|
||
|
|
$pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER);
|
||
|
|
|
||
|
|
$preffComm = explode(',', $values['preferred_communication_method']);
|
||
|
|
foreach ($preffComm as $v) {
|
||
|
|
$v = strtolower(trim($v));
|
||
|
|
if (array_key_exists($v, $pcm)) {
|
||
|
|
$comm[$pcm[$v]] = 1;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$params['preferred_communication_method'] = $comm;
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
// format the website params.
|
||
|
|
if (!empty($values['url'])) {
|
||
|
|
static $websiteFields;
|
||
|
|
if (!is_array($websiteFields)) {
|
||
|
|
$websiteFields = CRM_Core_DAO_Website::fields();
|
||
|
|
}
|
||
|
|
if (!array_key_exists('website', $params) ||
|
||
|
|
!is_array($params['website'])
|
||
|
|
) {
|
||
|
|
$params['website'] = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
$websiteCount = count($params['website']);
|
||
|
|
_civicrm_api3_store_values($websiteFields, $values,
|
||
|
|
$params['website'][++$websiteCount]
|
||
|
|
);
|
||
|
|
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
// get the formatted location blocks into params - w/ 3.0 format, CRM-4605
|
||
|
|
if (!empty($values['location_type_id'])) {
|
||
|
|
$blockTypes = array(
|
||
|
|
'phone' => 'Phone',
|
||
|
|
'email' => 'Email',
|
||
|
|
'im' => 'IM',
|
||
|
|
'openid' => 'OpenID',
|
||
|
|
'phone_ext' => 'Phone',
|
||
|
|
);
|
||
|
|
foreach ($blockTypes as $blockFieldName => $block) {
|
||
|
|
if (!array_key_exists($blockFieldName, $values)) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
// block present in value array.
|
||
|
|
if (!array_key_exists($blockFieldName, $params) || !is_array($params[$blockFieldName])) {
|
||
|
|
$params[$blockFieldName] = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!array_key_exists($block, $fields)) {
|
||
|
|
$className = "CRM_Core_DAO_$block";
|
||
|
|
$fields[$block] = $className::fields();
|
||
|
|
}
|
||
|
|
|
||
|
|
$blockCnt = count($params[$blockFieldName]);
|
||
|
|
|
||
|
|
// copy value to dao field name.
|
||
|
|
if ($blockFieldName == 'im') {
|
||
|
|
$values['name'] = $values[$blockFieldName];
|
||
|
|
}
|
||
|
|
|
||
|
|
_civicrm_api3_store_values($fields[$block], $values,
|
||
|
|
$params[$blockFieldName][++$blockCnt]
|
||
|
|
);
|
||
|
|
|
||
|
|
if ($values['location_type_id'] === 'Primary') {
|
||
|
|
if (!empty($params['id'])) {
|
||
|
|
$primary = civicrm_api3($block, 'get', array('return' => 'location_type_id', 'contact_id' => $params['id'], 'is_primary' => 1, 'sequential' => 1));
|
||
|
|
}
|
||
|
|
$defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
|
||
|
|
$values['location_type_id'] = (isset($primary) && $primary['count']) ? $primary['values'][0]['location_type_id'] : $defaultLocationType->id;
|
||
|
|
$values['is_primary'] = 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (empty($params['id']) && ($blockCnt == 1)) {
|
||
|
|
$params[$blockFieldName][$blockCnt]['is_primary'] = TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
// we only process single block at a time.
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
// handle address fields.
|
||
|
|
if (!array_key_exists('address', $params) || !is_array($params['address'])) {
|
||
|
|
$params['address'] = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!array_key_exists('Address', $fields)) {
|
||
|
|
$fields['Address'] = CRM_Core_DAO_Address::fields();
|
||
|
|
}
|
||
|
|
|
||
|
|
// Note: we doing multiple value formatting here for address custom fields, plus putting into right format.
|
||
|
|
// The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving
|
||
|
|
// the address in CRM_Core_BAO_Address::create method
|
||
|
|
if (!empty($values['location_type_id'])) {
|
||
|
|
static $customFields = array();
|
||
|
|
if (empty($customFields)) {
|
||
|
|
$customFields = CRM_Core_BAO_CustomField::getFields('Address');
|
||
|
|
}
|
||
|
|
// make a copy of values, as we going to make changes
|
||
|
|
$newValues = $values;
|
||
|
|
foreach ($values as $key => $val) {
|
||
|
|
$customFieldID = CRM_Core_BAO_CustomField::getKeyID($key);
|
||
|
|
if ($customFieldID && array_key_exists($customFieldID, $customFields)) {
|
||
|
|
// mark an entry in fields array since we want the value of custom field to be copied
|
||
|
|
$fields['Address'][$key] = NULL;
|
||
|
|
|
||
|
|
$htmlType = CRM_Utils_Array::value('html_type', $customFields[$customFieldID]);
|
||
|
|
switch ($htmlType) {
|
||
|
|
case 'CheckBox':
|
||
|
|
case 'AdvMulti-Select':
|
||
|
|
case 'Multi-Select':
|
||
|
|
if ($val) {
|
||
|
|
$mulValues = explode(',', $val);
|
||
|
|
$customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
|
||
|
|
$newValues[$key] = array();
|
||
|
|
foreach ($mulValues as $v1) {
|
||
|
|
foreach ($customOption as $v2) {
|
||
|
|
if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
|
||
|
|
(strtolower($v2['value']) == strtolower(trim($v1)))
|
||
|
|
) {
|
||
|
|
if ($htmlType == 'CheckBox') {
|
||
|
|
$newValues[$key][$v2['value']] = 1;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$newValues[$key][] = $v2['value'];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// consider new values
|
||
|
|
$values = $newValues;
|
||
|
|
}
|
||
|
|
|
||
|
|
_civicrm_api3_store_values($fields['Address'], $values, $params['address'][$values['location_type_id']]);
|
||
|
|
|
||
|
|
$addressFields = array(
|
||
|
|
'county',
|
||
|
|
'country',
|
||
|
|
'state_province',
|
||
|
|
'supplemental_address_1',
|
||
|
|
'supplemental_address_2',
|
||
|
|
'supplemental_address_3',
|
||
|
|
'StateProvince.name',
|
||
|
|
);
|
||
|
|
|
||
|
|
foreach ($addressFields as $field) {
|
||
|
|
if (array_key_exists($field, $values)) {
|
||
|
|
if (!array_key_exists('address', $params)) {
|
||
|
|
$params['address'] = array();
|
||
|
|
}
|
||
|
|
$params['address'][$values['location_type_id']][$field] = $values[$field];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($values['location_type_id'] === 'Primary') {
|
||
|
|
if (!empty($params['id'])) {
|
||
|
|
$primary = civicrm_api3('Address', 'get', array('return' => 'location_type_id', 'contact_id' => $params['id'], 'is_primary' => 1, 'sequential' => 1));
|
||
|
|
}
|
||
|
|
$defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
|
||
|
|
$params['address'][$values['location_type_id']]['location_type_id'] = (isset($primary) && $primary['count']) ? $primary['values'][0]['location_type_id'] : $defaultLocationType->id;
|
||
|
|
$params['address'][$values['location_type_id']]['is_primary'] = 1;
|
||
|
|
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($values['note'])) {
|
||
|
|
// add a note field
|
||
|
|
if (!isset($params['note'])) {
|
||
|
|
$params['note'] = array();
|
||
|
|
}
|
||
|
|
$noteBlock = count($params['note']) + 1;
|
||
|
|
|
||
|
|
$params['note'][$noteBlock] = array();
|
||
|
|
if (!isset($fields['Note'])) {
|
||
|
|
$fields['Note'] = CRM_Core_DAO_Note::fields();
|
||
|
|
}
|
||
|
|
|
||
|
|
// get the current logged in civicrm user
|
||
|
|
$session = CRM_Core_Session::singleton();
|
||
|
|
$userID = $session->get('userID');
|
||
|
|
|
||
|
|
if ($userID) {
|
||
|
|
$values['contact_id'] = $userID;
|
||
|
|
}
|
||
|
|
|
||
|
|
_civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]);
|
||
|
|
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Check for custom field values
|
||
|
|
|
||
|
|
if (empty($fields['custom'])) {
|
||
|
|
$fields['custom'] = &CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $values),
|
||
|
|
FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($values as $key => $value) {
|
||
|
|
if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
|
||
|
|
// check if it's a valid custom field id
|
||
|
|
|
||
|
|
if (!array_key_exists($customFieldID, $fields['custom'])) {
|
||
|
|
return civicrm_api3_create_error('Invalid custom field ID');
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params[$key] = $value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|