<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
-
abstract class CRM_Import_Parser {
- CONST MAX_ERRORS = 250, MAX_WARNINGS = 25, VALID = 1, WARNING = 2, ERROR = 4, CONFLICT = 8, STOP = 16, DUPLICATE = 32, MULTIPLE_DUPE = 64, NO_MATCH = 128, UNPARSED_ADDRESS_WARNING = 256;
-
/**
- * various parser modes
+ * Settings
*/
- CONST MODE_MAPFIELD = 1, MODE_PREVIEW = 2, MODE_SUMMARY = 4, MODE_IMPORT = 8;
+ const MAX_ERRORS = 250, MAX_WARNINGS = 25, DEFAULT_TIMEOUT = 30;
/**
- * codes for duplicate record handling
+ * Return codes
*/
- CONST DUPLICATE_SKIP = 1, DUPLICATE_REPLACE = 2, DUPLICATE_UPDATE = 4, DUPLICATE_FILL = 8, DUPLICATE_NOCHECK = 16;
+ const VALID = 1, WARNING = 2, ERROR = 4, CONFLICT = 8, STOP = 16, DUPLICATE = 32, MULTIPLE_DUPE = 64, NO_MATCH = 128, UNPARSED_ADDRESS_WARNING = 256;
/**
- * various Contact types
+ * Parser modes
*/
- CONST CONTACT_INDIVIDUAL = 1, CONTACT_HOUSEHOLD = 2, CONTACT_ORGANIZATION = 4;
- CONST DEFAULT_TIMEOUT = 30;
-
- protected $_tableName;
+ const MODE_MAPFIELD = 1, MODE_PREVIEW = 2, MODE_SUMMARY = 4, MODE_IMPORT = 8;
- /**#@+
- * @access protected
- * @var integer
+ /**
+ * Codes for duplicate record handling
*/
+ const DUPLICATE_SKIP = 1, DUPLICATE_REPLACE = 2, DUPLICATE_UPDATE = 4, DUPLICATE_FILL = 8, DUPLICATE_NOCHECK = 16;
/**
- * total number of lines in file
+ * Contact types
*/
- protected $_rowCount;
+ const CONTACT_INDIVIDUAL = 1, CONTACT_HOUSEHOLD = 2, CONTACT_ORGANIZATION = 4;
+
/**
- * total number of non empty lines
+ * Total number of non empty lines
*/
protected $_totalCount;
/**
- * running total number of valid lines
+ * Running total number of valid lines
*/
protected $_validCount;
/**
- * running total number of invalid rows
+ * Running total number of invalid rows
*/
protected $_invalidRowCount;
/**
- * maximum number of invalid rows to store
+ * Maximum number of non-empty/comment lines to process
+ *
+ * @var int
+ */
+ protected $_maxLinesToProcess;
+
+ /**
+ * Maximum number of invalid rows to store
*/
protected $_maxErrorCount;
/**
- * array of error lines, bounded by MAX_ERROR
+ * Array of error lines, bounded by MAX_ERROR
*/
protected $_errors;
/**
- * total number of conflict lines
+ * Total number of conflict lines
*/
protected $_conflictCount;
/**
- * array of conflict lines
+ * Array of conflict lines
*/
protected $_conflicts;
/**
- * total number of duplicate (from database) lines
+ * Total number of duplicate (from database) lines
*/
protected $_duplicateCount;
/**
- * array of duplicate lines
+ * Array of duplicate lines
*/
protected $_duplicates;
/**
- * running total number of warnings
+ * Running total number of warnings
*/
protected $_warningCount;
/**
- * running total number of un matched Conact
- */
- protected $_unMatchCount;
-
- /**
- * array of unmatched lines
- */
- protected $_unMatch;
-
- /**
- * maximum number of warnings to store
+ * Maximum number of warnings to store
*/
protected $_maxWarningCount = self::MAX_WARNINGS;
/**
- * total number of contacts with unparsed addresses
- */
- protected $_unparsedAddressCount;
-
- /**
- * array of warning lines, bounded by MAX_WARNING
+ * Array of warning lines, bounded by MAX_WARNING
*/
protected $_warnings;
/**
- * array of all the fields that could potentially be part
+ * Array of all the fields that could potentially be part
* of this import process
* @var array
*/
protected $_fields;
/**
- * array of the fields that are actually part of the import process
+ * Array of the fields that are actually part of the import process
* the position in the array also dictates their position in the import
* file
* @var array
protected $_activeFields;
/**
- * cache the count of active fields
+ * Cache the count of active fields
*
* @var int
*/
protected $_activeFieldCount;
/**
- * maximum number of non-empty/comment lines to process
- *
- * @var int
- */
- protected $_maxLinesToProcess;
-
- /**
- * cache of preview rows
+ * Cache of preview rows
*
* @var array
*/
protected $_rows;
/**
- * filename of error data
+ * Filename of error data
*
* @var string
*/
protected $_errorFileName;
/**
- * filename of conflict data
+ * Filename of conflict data
*
* @var string
*/
protected $_conflictFileName;
/**
- * filename of duplicate data
+ * Filename of duplicate data
*
* @var string
*/
protected $_duplicateFileName;
/**
- * filename of mismatch data
- *
- * @var string
- */
- protected $_misMatchFilemName;
-
- protected $_primaryKeyName;
- protected $_statusFieldName;
-
- /**
- * contact type
+ * Contact type
*
* @var int
*/
-
public $_contactType;
/**
- * on duplicate
- *
- * @var int
+ * Class constructor
*/
- public $_onDuplicate;
-
- /**
- * dedupe rule group id to use if set
- *
- * @var int
- */
- public $_dedupeRuleGroupID = NULL;
-
- function __construct() {
+ public function __construct() {
$this->_maxLinesToProcess = 0;
$this->_maxErrorCount = self::MAX_ERRORS;
}
+ /**
+ * Abstract function definitions
+ */
abstract function init();
- 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_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();
-
- $status = '';
-
- $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 */
-
- $empty = TRUE;
- 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();
- }
+ /**
+ * @return mixed
+ */
+ abstract function fini();
+ /**
+ * @param $values
+ *
+ * @return mixed
+ */
abstract function mapField(&$values);
+
+ /**
+ * @param $values
+ *
+ * @return mixed
+ */
abstract function preview(&$values);
+
+ /**
+ * @param $values
+ *
+ * @return mixed
+ */
abstract function summary(&$values);
- abstract function import($onDuplicate, &$values);
- abstract function fini();
+ /**
+ * @param $onDuplicate
+ * @param $values
+ *
+ * @return mixed
+ */
+ abstract function import($onDuplicate, &$values);
/**
- * Given a list of the importable field keys that the user has selected
- * set the active fields array to this list
+ * Set and validate field values
*
- * @param array mapped array of values
+ * @param array $elements
+ * : array.
+ * @param $erroneousField
+ * : reference.
*
- * @return void
- * @access public
+ * @return int
*/
- function setActiveFields($fieldKeys) {
- $this->_activeFieldCount = count($fieldKeys);
- foreach ($fieldKeys as $key) {
- if (empty($this->_fields[$key])) {
- $this->_activeFields[] = new CRM_Import_Field('', ts('- do not import -'));
- }
- else {
- $this->_activeFields[] = clone($this->_fields[$key]);
- }
- }
- }
-
- function setActiveFieldValues($elements) {
+ public function setActiveFieldValues($elements, &$erroneousField) {
$maxCount = count($elements) < $this->_activeFieldCount ? count($elements) : $this->_activeFieldCount;
for ($i = 0; $i < $maxCount; $i++) {
$this->_activeFields[$i]->setValue($elements[$i]);
for ($i = 0; $i < $this->_activeFieldCount; $i++) {
if (!$this->_activeFields[$i]->validate()) {
// no need to do any more validation
+ $erroneousField = $i;
$valid = self::ERROR;
break;
}
return $valid;
}
- function setActiveFieldLocationTypes($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_hasLocationType = $elements[$i];
- }
- }
-
- function setActiveFieldPhoneTypes($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_phoneType = $elements[$i];
- }
- }
-
- function setActiveFieldWebsiteTypes($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_websiteType = $elements[$i];
- }
- }
-
/**
- * Function to set IM Service Provider type fields
- *
- * @param array $elements IM service provider type ids
+ * Format the field values for input to the api
*
- * @return void
- * @access public
+ * @return array (reference) associative array of name/value pairs
*/
- function setActiveFieldImProviders($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_imProvider = $elements[$i];
- }
- }
-
- function setActiveFieldRelated($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_related = $elements[$i];
- }
- }
-
- function setActiveFieldRelatedContactType($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_relatedContactType = $elements[$i];
- }
- }
-
- function setActiveFieldRelatedContactDetails($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_relatedContactDetails = $elements[$i];
- }
- }
-
- function setActiveFieldRelatedContactLocType($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_relatedContactLocType = $elements[$i];
- }
- }
-
- function setActiveFieldRelatedContactPhoneType($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i];
- }
- }
-
- function setActiveFieldRelatedContactWebsiteType($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i];
- }
- }
-
- /**
- * Function to set IM Service Provider type fields for related contacts
- *
- * @param array $elements IM service provider type ids of related contact
- *
- * @return void
- * @access public
- */
- function setActiveFieldRelatedContactImProvider($elements) {
- for ($i = 0; $i < count($elements); $i++) {
- $this->_activeFields[$i]->_relatedContactImProvider = $elements[$i];
- }
- }
-
- /**
- * function to format the field values for input to the api
- *
- * @return array (reference ) associative array of name/value pairs
- * @access public
- */
- function &getActiveFieldParams() {
+ public function &getActiveFieldParams() {
$params = array();
-
- //CRM_Core_Error::debug( 'Count', $this->_activeFieldCount );
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 (!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]->_value)
+ && !isset($params[$this->_activeFields[$i]->_name])
+ && !isset($this->_activeFields[$i]->_related)
+ ) {
- 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;
- }
- }
+ $params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value;
}
}
-
return $params;
}
- function getSelectValues() {
+ /**
+ * @return array
+ */
+ public function getSelectValues() {
$values = array();
foreach ($this->_fields as $name => $field) {
$values[$name] = $field->_title;
return $values;
}
- function getSelectTypes() {
+ /**
+ * @return array
+ */
+ public function getSelectTypes() {
$values = array();
foreach ($this->_fields as $name => $field) {
- $values[$name] = $field->_hasLocationType;
+ if (isset($field->_hasLocationType)) {
+ $values[$name] = $field->_hasLocationType;
+ }
}
return $values;
}
- function getColumnPatterns() {
+ /**
+ * @return array
+ */
+ public function getHeaderPatterns() {
$values = array();
foreach ($this->_fields as $name => $field) {
- $values[$name] = $field->_columnPattern;
+ if (isset($field->_headerPattern)) {
+ $values[$name] = $field->_headerPattern;
+ }
}
return $values;
}
- function getDataPatterns() {
+ /**
+ * @return array
+ */
+ public function getDataPatterns() {
$values = array();
foreach ($this->_fields as $name => $field) {
$values[$name] = $field->_dataPattern;
return $values;
}
- function addField($name, $title, $type = CRM_Utils_Type::T_INT,
- $headerPattern = '//', $dataPattern = '//',
- $hasLocationType = FALSE
- ) {
- $this->_fields[$name] = new CRM_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
- if (empty($name)) {
- $this->_fields['doNotImport'] = new CRM_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
- }
- }
-
- /**
- * setter function
- *
- * @param int $max
- *
- * @return void
- * @access public
- */
- function setMaxLinesToProcess($max) {
- $this->_maxLinesToProcess = $max;
- }
-
/**
- * Store parser values
+ * Remove single-quote enclosures from a value array (row)
*
- * @param CRM_Core_Session $store
+ * @param array $values
+ * @param string $enclosure
*
* @return void
- * @access public
+ * @static
*/
- 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);
+ public static function encloseScrub(&$values, $enclosure = "'") {
+ if (empty($values)) {
+ return;
}
- 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);
+ foreach ($values as $k => $v) {
+ $values[$k] = preg_replace("/^$enclosure(.*)$enclosure$/", '$1', $v);
}
-
- 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
+ * Setter function
*
- * @param string $filename
- * @param array $header
- * @param data $data
+ * @param int $max
*
* @return void
- * @access 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);
+ public function setMaxLinesToProcess($max) {
+ $this->_maxLinesToProcess = $max;
}
/**
- * Update the record with PK $id in the import database table
+ * Determines the file extension based on error code
*
- * @param int $id
- * @param array $params
- *
- * @return void
- * @access public
+ * @var $type error code constant
+ * @return string
+ * @static
*/
- 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);
- }
- }
-
- function errorFileName($type) {
+ public static function errorFileName($type) {
$fileName = NULL;
if (empty($type)) {
return $fileName;
$config = CRM_Core_Config::singleton();
$fileName = $config->uploadDir . "sqlImport";
switch ($type) {
- case CRM_Import_Parser::ERROR:
+ case self::ERROR:
$fileName .= '.errors';
break;
- case CRM_Import_Parser::CONFLICT:
+ case self::CONFLICT:
$fileName .= '.conflicts';
break;
- case CRM_Import_Parser::DUPLICATE:
+ case self::DUPLICATE:
$fileName .= '.duplicates';
break;
- case CRM_Import_Parser::NO_MATCH:
+ case self::NO_MATCH:
$fileName .= '.mismatch';
break;
- case CRM_Import_Parser::UNPARSED_ADDRESS_WARNING:
+ case self::UNPARSED_ADDRESS_WARNING:
$fileName .= '.unparsedAddress';
break;
}
return $fileName;
}
- function saveFileName($type) {
+ /**
+ * Determines the file name based on error code
+ *
+ * @var $type error code constant
+ * @return string
+ * @static
+ */
+ public static function saveFileName($type) {
$fileName = NULL;
if (empty($type)) {
return $fileName;
}
switch ($type) {
- case CRM_Import_Parser::ERROR:
+ case self::ERROR:
$fileName = 'Import_Errors.csv';
break;
- case CRM_Import_Parser::CONFLICT:
+ case self::CONFLICT:
$fileName = 'Import_Conflicts.csv';
break;
- case CRM_Import_Parser::DUPLICATE:
+ case self::DUPLICATE:
$fileName = 'Import_Duplicates.csv';
break;
- case CRM_Import_Parser::NO_MATCH:
+ case self::NO_MATCH:
$fileName = 'Import_Mismatch.csv';
break;
- case CRM_Import_Parser::UNPARSED_ADDRESS_WARNING:
+ case self::UNPARSED_ADDRESS_WARNING:
$fileName = 'Import_Unparsed_Address.csv';
break;
}
return $fileName;
}
-}
+}
projects / civicrm-core.git / blobdiff