3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 abstract class CRM_Event_Import_Parser
extends CRM_Import_Parser
{
49 * Seperator being used
51 protected $_seperator;
54 * Total number of lines in file
56 protected $_lineCount;
59 * Whether the file has a column header or not
63 protected $_haveColumnHeader;
66 * @param string $fileName
67 * @param string $seperator
69 * @param bool $skipColumnHeader
71 * @param int $contactType
72 * @param int $onDuplicate
81 $skipColumnHeader = FALSE,
82 $mode = self
::MODE_PREVIEW
,
83 $contactType = self
::CONTACT_INDIVIDUAL
,
84 $onDuplicate = self
::DUPLICATE_SKIP
86 if (!is_array($fileName)) {
87 CRM_Core_Error
::fatal();
89 $fileName = $fileName['name'];
91 switch ($contactType) {
92 case self
::CONTACT_INDIVIDUAL
:
93 $this->_contactType
= 'Individual';
96 case self
::CONTACT_HOUSEHOLD
:
97 $this->_contactType
= 'Household';
100 case self
::CONTACT_ORGANIZATION
:
101 $this->_contactType
= 'Organization';
106 $this->_haveColumnHeader
= $skipColumnHeader;
108 $this->_seperator
= $seperator;
110 $fd = fopen($fileName, "r");
115 $this->_lineCount
= $this->_warningCount
= 0;
116 $this->_invalidRowCount
= $this->_validCount
= 0;
117 $this->_totalCount
= $this->_conflictCount
= 0;
119 $this->_errors
= array();
120 $this->_warnings
= array();
121 $this->_conflicts
= array();
123 $this->_fileSize
= number_format(filesize($fileName) / 1024.0, 2);
125 if ($mode == self
::MODE_MAPFIELD
) {
126 $this->_rows
= array();
129 $this->_activeFieldCount
= count($this->_activeFields
);
135 $values = fgetcsv($fd, 8192, $seperator);
140 self
::encloseScrub($values);
142 // skip column header if we're not in mapfield mode
143 if ($mode != self
::MODE_MAPFIELD
&& $skipColumnHeader) {
144 $skipColumnHeader = FALSE;
148 /* trim whitespace around the values */
151 foreach ($values as $k => $v) {
152 $values[$k] = trim($v, " \t\r\n");
155 if (CRM_Utils_System
::isNull($values)) {
159 $this->_totalCount++
;
161 if ($mode == self
::MODE_MAPFIELD
) {
162 $returnCode = $this->mapField($values);
164 elseif ($mode == self
::MODE_PREVIEW
) {
165 $returnCode = $this->preview($values);
167 elseif ($mode == self
::MODE_SUMMARY
) {
168 $returnCode = $this->summary($values);
170 elseif ($mode == self
::MODE_IMPORT
) {
171 $returnCode = $this->import($onDuplicate, $values);
174 $returnCode = self
::ERROR
;
177 // note that a line could be valid but still produce a warning
178 if ($returnCode & self
::VALID
) {
179 $this->_validCount++
;
180 if ($mode == self
::MODE_MAPFIELD
) {
181 $this->_rows
[] = $values;
182 $this->_activeFieldCount
= max($this->_activeFieldCount
, count($values));
186 if ($returnCode & self
::WARNING
) {
187 $this->_warningCount++
;
188 if ($this->_warningCount
< $this->_maxWarningCount
) {
189 $this->_warningCount
[] = $line;
193 if ($returnCode & self
::ERROR
) {
194 $this->_invalidRowCount++
;
195 $recordNumber = $this->_lineCount
;
196 if ($this->_haveColumnHeader
) {
199 array_unshift($values, $recordNumber);
200 $this->_errors
[] = $values;
203 if ($returnCode & self
::CONFLICT
) {
204 $this->_conflictCount++
;
205 $recordNumber = $this->_lineCount
;
206 if ($this->_haveColumnHeader
) {
209 array_unshift($values, $recordNumber);
210 $this->_conflicts
[] = $values;
213 if ($returnCode & self
::DUPLICATE
) {
214 if ($returnCode & self
::MULTIPLE_DUPE
) {
215 /* TODO: multi-dupes should be counted apart from singles
216 * on non-skip action */
218 $this->_duplicateCount++
;
219 $recordNumber = $this->_lineCount
;
220 if ($this->_haveColumnHeader
) {
223 array_unshift($values, $recordNumber);
224 $this->_duplicates
[] = $values;
225 if ($onDuplicate != self
::DUPLICATE_SKIP
) {
226 $this->_validCount++
;
230 // we give the derived class a way of aborting the process
231 // note that the return code could be multiple code or'ed together
232 if ($returnCode & self
::STOP
) {
236 // if we are done processing the maxNumber of lines, break
237 if ($this->_maxLinesToProcess
> 0 && $this->_validCount
>= $this->_maxLinesToProcess
) {
244 if ($mode == self
::MODE_PREVIEW ||
$mode == self
::MODE_IMPORT
) {
245 $customHeaders = $mapper;
247 $customfields = CRM_Core_BAO_CustomField
::getFields('Participant');
248 foreach ($customHeaders as $key => $value) {
249 if ($id = CRM_Core_BAO_CustomField
::getKeyID($value)) {
250 $customHeaders[$key] = $customfields[$id][0];
254 if ($this->_invalidRowCount
) {
255 // removed view url for invlaid contacts
256 $headers = array_merge(array(
262 $this->_errorFileName
= self
::errorFileName(self
::ERROR
);
263 self
::exportCSV($this->_errorFileName
, $headers, $this->_errors
);
265 if ($this->_conflictCount
) {
266 $headers = array_merge(array(
272 $this->_conflictFileName
= self
::errorFileName(self
::CONFLICT
);
273 self
::exportCSV($this->_conflictFileName
, $headers, $this->_conflicts
);
275 if ($this->_duplicateCount
) {
276 $headers = array_merge(array(
278 ts('View Participant URL'),
283 $this->_duplicateFileName
= self
::errorFileName(self
::DUPLICATE
);
284 self
::exportCSV($this->_duplicateFileName
, $headers, $this->_duplicates
);
287 return $this->fini();
291 * Given a list of the importable field keys that the user has selected
292 * set the active fields array to this list
294 * @param $fieldKeys array mapped array of values
298 public function setActiveFields($fieldKeys) {
299 $this->_activeFieldCount
= count($fieldKeys);
300 foreach ($fieldKeys as $key) {
301 if (empty($this->_fields
[$key])) {
302 $this->_activeFields
[] = new CRM_Event_Import_Field('', ts('- do not import -'));
305 $this->_activeFields
[] = clone($this->_fields
[$key]);
311 * Format the field values for input to the api.
314 * (reference ) associative array of name/value pairs
316 public function &getActiveFieldParams() {
318 for ($i = 0; $i < $this->_activeFieldCount
; $i++
) {
319 if (isset($this->_activeFields
[$i]->_value
)
320 && !isset($params[$this->_activeFields
[$i]->_name
])
321 && !isset($this->_activeFields
[$i]->_related
)
324 $params[$this->_activeFields
[$i]->_name
] = $this->_activeFields
[$i]->_value
;
331 * @param string $name
334 * @param string $headerPattern
335 * @param string $dataPattern
337 public function addField($name, $title, $type = CRM_Utils_Type
::T_INT
, $headerPattern = '//', $dataPattern = '//') {
339 $this->_fields
['doNotImport'] = new CRM_Event_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
343 //$tempField = CRM_Contact_BAO_Contact::importableFields('Individual', null );
344 $tempField = CRM_Contact_BAO_Contact
::importableFields('All', NULL);
345 if (!array_key_exists($name, $tempField)) {
346 $this->_fields
[$name] = new CRM_Event_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
349 $this->_fields
[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern,
350 CRM_Utils_Array
::value('hasLocationType', $tempField[$name])
357 * Store parser values.
359 * @param CRM_Core_Session $store
365 public function set($store, $mode = self
::MODE_SUMMARY
) {
366 $store->set('fileSize', $this->_fileSize
);
367 $store->set('lineCount', $this->_lineCount
);
368 $store->set('seperator', $this->_seperator
);
369 $store->set('fields', $this->getSelectValues());
370 $store->set('fieldTypes', $this->getSelectTypes());
372 $store->set('headerPatterns', $this->getHeaderPatterns());
373 $store->set('dataPatterns', $this->getDataPatterns());
374 $store->set('columnCount', $this->_activeFieldCount
);
376 $store->set('totalRowCount', $this->_totalCount
);
377 $store->set('validRowCount', $this->_validCount
);
378 $store->set('invalidRowCount', $this->_invalidRowCount
);
379 $store->set('conflictRowCount', $this->_conflictCount
);
381 switch ($this->_contactType
) {
383 $store->set('contactType', CRM_Import_Parser
::CONTACT_INDIVIDUAL
);
387 $store->set('contactType', CRM_Import_Parser
::CONTACT_HOUSEHOLD
);
391 $store->set('contactType', CRM_Import_Parser
::CONTACT_ORGANIZATION
);
394 if ($this->_invalidRowCount
) {
395 $store->set('errorsFileName', $this->_errorFileName
);
397 if ($this->_conflictCount
) {
398 $store->set('conflictsFileName', $this->_conflictFileName
);
400 if (isset($this->_rows
) && !empty($this->_rows
)) {
401 $store->set('dataValues', $this->_rows
);
404 if ($mode == self
::MODE_IMPORT
) {
405 $store->set('duplicateRowCount', $this->_duplicateCount
);
406 if ($this->_duplicateCount
) {
407 $store->set('duplicatesFileName', $this->_duplicateFileName
);
413 * Export data to a CSV file.
415 * @param string $fileName
416 * @param array $header
421 public static function exportCSV($fileName, $header, $data) {
423 $fd = fopen($fileName, 'w');
425 foreach ($header as $key => $value) {
426 $header[$key] = "\"$value\"";
428 $config = CRM_Core_Config
::singleton();
429 $output[] = implode($config->fieldSeparator
, $header);
431 foreach ($data as $datum) {
432 foreach ($datum as $key => $value) {
433 if (is_array($value)) {
434 foreach ($value[0] as $k1 => $v1) {
435 if ($k1 == 'location_type_id') {
442 $datum[$key] = "\"$value\"";
445 $output[] = implode($config->fieldSeparator
, $datum);
447 fwrite($fd, implode("\n", $output));