3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 abstract class CRM_Event_Import_Parser
extends CRM_Import_Parser
{
51 * Seperator being used
53 protected $_seperator;
56 * Total number of lines in file
58 protected $_lineCount;
61 * Whether the file has a column header or not
65 protected $_haveColumnHeader;
68 * @param string $fileName
69 * @param string $seperator
71 * @param bool $skipColumnHeader
73 * @param int $contactType
74 * @param int $onDuplicate
79 function run($fileName,
82 $skipColumnHeader = FALSE,
83 $mode = self
::MODE_PREVIEW
,
84 $contactType = self
::CONTACT_INDIVIDUAL
,
85 $onDuplicate = self
::DUPLICATE_SKIP
87 if (!is_array($fileName)) {
88 CRM_Core_Error
::fatal();
90 $fileName = $fileName['name'];
92 switch ($contactType) {
93 case self
::CONTACT_INDIVIDUAL
:
94 $this->_contactType
= 'Individual';
97 case self
::CONTACT_HOUSEHOLD
:
98 $this->_contactType
= 'Household';
101 case self
::CONTACT_ORGANIZATION
:
102 $this->_contactType
= 'Organization';
107 $this->_haveColumnHeader
= $skipColumnHeader;
109 $this->_seperator
= $seperator;
111 $fd = fopen($fileName, "r");
116 $this->_lineCount
= $this->_warningCount
= 0;
117 $this->_invalidRowCount
= $this->_validCount
= 0;
118 $this->_totalCount
= $this->_conflictCount
= 0;
120 $this->_errors
= array();
121 $this->_warnings
= array();
122 $this->_conflicts
= array();
124 $this->_fileSize
= number_format(filesize($fileName) / 1024.0, 2);
126 if ($mode == self
::MODE_MAPFIELD
) {
127 $this->_rows
= array();
130 $this->_activeFieldCount
= count($this->_activeFields
);
136 $values = fgetcsv($fd, 8192, $seperator);
141 self
::encloseScrub($values);
143 // skip column header if we're not in mapfield mode
144 if ($mode != self
::MODE_MAPFIELD
&& $skipColumnHeader) {
145 $skipColumnHeader = FALSE;
149 /* trim whitespace around the values */
152 foreach ($values as $k => $v) {
153 $values[$k] = trim($v, " \t\r\n");
156 if (CRM_Utils_System
::isNull($values)) {
160 $this->_totalCount++
;
162 if ($mode == self
::MODE_MAPFIELD
) {
163 $returnCode = $this->mapField($values);
165 elseif ($mode == self
::MODE_PREVIEW
) {
166 $returnCode = $this->preview($values);
168 elseif ($mode == self
::MODE_SUMMARY
) {
169 $returnCode = $this->summary($values);
171 elseif ($mode == self
::MODE_IMPORT
) {
172 $returnCode = $this->import($onDuplicate, $values);
175 $returnCode = self
::ERROR
;
178 // note that a line could be valid but still produce a warning
179 if ($returnCode & self
::VALID
) {
180 $this->_validCount++
;
181 if ($mode == self
::MODE_MAPFIELD
) {
182 $this->_rows
[] = $values;
183 $this->_activeFieldCount
= max($this->_activeFieldCount
, count($values));
187 if ($returnCode & self
::WARNING
) {
188 $this->_warningCount++
;
189 if ($this->_warningCount
< $this->_maxWarningCount
) {
190 $this->_warningCount
[] = $line;
194 if ($returnCode & self
::ERROR
) {
195 $this->_invalidRowCount++
;
196 if ($this->_invalidRowCount
< $this->_maxErrorCount
) {
197 $recordNumber = $this->_lineCount
;
198 if ($this->_haveColumnHeader
) {
201 array_unshift($values, $recordNumber);
202 $this->_errors
[] = $values;
206 if ($returnCode & self
::CONFLICT
) {
207 $this->_conflictCount++
;
208 $recordNumber = $this->_lineCount
;
209 if ($this->_haveColumnHeader
) {
212 array_unshift($values, $recordNumber);
213 $this->_conflicts
[] = $values;
216 if ($returnCode & self
::DUPLICATE
) {
217 if ($returnCode & self
::MULTIPLE_DUPE
) {
218 /* TODO: multi-dupes should be counted apart from singles
219 * on non-skip action */
221 $this->_duplicateCount++
;
222 $recordNumber = $this->_lineCount
;
223 if ($this->_haveColumnHeader
) {
226 array_unshift($values, $recordNumber);
227 $this->_duplicates
[] = $values;
228 if ($onDuplicate != self
::DUPLICATE_SKIP
) {
229 $this->_validCount++
;
233 // we give the derived class a way of aborting the process
234 // note that the return code could be multiple code or'ed together
235 if ($returnCode & self
::STOP
) {
239 // if we are done processing the maxNumber of lines, break
240 if ($this->_maxLinesToProcess
> 0 && $this->_validCount
>= $this->_maxLinesToProcess
) {
247 if ($mode == self
::MODE_PREVIEW ||
$mode == self
::MODE_IMPORT
) {
248 $customHeaders = $mapper;
250 $customfields = CRM_Core_BAO_CustomField
::getFields('Participant');
251 foreach ($customHeaders as $key => $value) {
252 if ($id = CRM_Core_BAO_CustomField
::getKeyID($value)) {
253 $customHeaders[$key] = $customfields[$id][0];
257 if ($this->_invalidRowCount
) {
258 // removed view url for invlaid contacts
259 $headers = array_merge(array(ts('Line Number'),
264 $this->_errorFileName
= self
::errorFileName(self
::ERROR
);
265 self
::exportCSV($this->_errorFileName
, $headers, $this->_errors
);
267 if ($this->_conflictCount
) {
268 $headers = array_merge(array(ts('Line Number'),
273 $this->_conflictFileName
= self
::errorFileName(self
::CONFLICT
);
274 self
::exportCSV($this->_conflictFileName
, $headers, $this->_conflicts
);
276 if ($this->_duplicateCount
) {
277 $headers = array_merge(array(ts('Line Number'),
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 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
313 * @return array (reference ) associative array of name/value pairs
315 public function &getActiveFieldParams() {
317 for ($i = 0; $i < $this->_activeFieldCount
; $i++
) {
318 if (isset($this->_activeFields
[$i]->_value
)
319 && !isset($params[$this->_activeFields
[$i]->_name
])
320 && !isset($this->_activeFields
[$i]->_related
)
323 $params[$this->_activeFields
[$i]->_name
] = $this->_activeFields
[$i]->_value
;
330 * @param string $name
333 * @param string $headerPattern
334 * @param string $dataPattern
336 public function addField($name, $title, $type = CRM_Utils_Type
::T_INT
, $headerPattern = '//', $dataPattern = '//') {
338 $this->_fields
['doNotImport'] = new CRM_Event_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
342 //$tempField = CRM_Contact_BAO_Contact::importableFields('Individual', null );
343 $tempField = CRM_Contact_BAO_Contact
::importableFields('All', NULL);
344 if (!array_key_exists($name, $tempField)) {
345 $this->_fields
[$name] = new CRM_Event_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
348 $this->_fields
[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern,
349 CRM_Utils_Array
::value('hasLocationType', $tempField[$name])
356 * Store parser values
358 * @param CRM_Core_Session $store
364 public function set($store, $mode = self
::MODE_SUMMARY
) {
365 $store->set('fileSize', $this->_fileSize
);
366 $store->set('lineCount', $this->_lineCount
);
367 $store->set('seperator', $this->_seperator
);
368 $store->set('fields', $this->getSelectValues());
369 $store->set('fieldTypes', $this->getSelectTypes());
371 $store->set('headerPatterns', $this->getHeaderPatterns());
372 $store->set('dataPatterns', $this->getDataPatterns());
373 $store->set('columnCount', $this->_activeFieldCount
);
375 $store->set('totalRowCount', $this->_totalCount
);
376 $store->set('validRowCount', $this->_validCount
);
377 $store->set('invalidRowCount', $this->_invalidRowCount
);
378 $store->set('conflictRowCount', $this->_conflictCount
);
380 switch ($this->_contactType
) {
382 $store->set('contactType', CRM_Import_Parser
::CONTACT_INDIVIDUAL
);
386 $store->set('contactType', CRM_Import_Parser
::CONTACT_HOUSEHOLD
);
390 $store->set('contactType', CRM_Import_Parser
::CONTACT_ORGANIZATION
);
393 if ($this->_invalidRowCount
) {
394 $store->set('errorsFileName', $this->_errorFileName
);
396 if ($this->_conflictCount
) {
397 $store->set('conflictsFileName', $this->_conflictFileName
);
399 if (isset($this->_rows
) && !empty($this->_rows
)) {
400 $store->set('dataValues', $this->_rows
);
403 if ($mode == self
::MODE_IMPORT
) {
404 $store->set('duplicateRowCount', $this->_duplicateCount
);
405 if ($this->_duplicateCount
) {
406 $store->set('duplicatesFileName', $this->_duplicateFileName
);
412 * Export data to a CSV file
414 * @param string $fileName
415 * @param array $header
420 public static function exportCSV($fileName, $header, $data) {
422 $fd = fopen($fileName, 'w');
424 foreach ($header as $key => $value) {
425 $header[$key] = "\"$value\"";
427 $config = CRM_Core_Config
::singleton();
428 $output[] = implode($config->fieldSeparator
, $header);
430 foreach ($data as $datum) {
431 foreach ($datum as $key => $value) {
432 if (is_array($value)) {
433 foreach ($value[0] as $k1 => $v1) {
434 if ($k1 == 'location_type_id') {
441 $datum[$key] = "\"$value\"";
444 $output[] = implode($config->fieldSeparator
, $datum);
446 fwrite($fd, implode("\n", $output));