Merge pull request #4866 from totten/master-phpcs
[civicrm-core.git] / CRM / Custom / Import / Parser.php
CommitLineData
9ff5f6c0
N
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
9ff5f6c0 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
9ff5f6c0
N
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26*/
27
28/**
29 *
30 * @package CRM
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
9ff5f6c0
N
32 * $Id$
33 *
34 */
35
36
37abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser {
38
39 protected $_fileName;
40
41 /**#@+
9ff5f6c0
N
42 * @var integer
43 */
44
45 /**
100fef9d 46 * Imported file size
9ff5f6c0
N
47 */
48 protected $_fileSize;
49
50 /**
100fef9d 51 * Separator being used
9ff5f6c0
N
52 */
53 protected $_separator;
54
55 /**
100fef9d 56 * Total number of lines in file
9ff5f6c0
N
57 */
58 protected $_lineCount;
59
60 /**
100fef9d 61 * Whether the file has a column header or not
9ff5f6c0
N
62 *
63 * @var boolean
64 */
65 protected $_haveColumnHeader;
66
e0ef6999 67 /**
100fef9d 68 * @param string $fileName
e0ef6999
EM
69 * @param string $separator
70 * @param int $mapper
71 * @param bool $skipColumnHeader
72 * @param int|string $mode
73 * @param int|string $contactType
74 * @param int $onDuplicate
75 *
76 * @return mixed
77 * @throws Exception
78 */
40b55be5
TO
79 function run(
80 $fileName,
9ff5f6c0
N
81 $separator = ',',
82 &$mapper,
83 $skipColumnHeader = FALSE,
84 $mode = self::MODE_PREVIEW,
85 $contactType = self::CONTACT_INDIVIDUAL,
86 $onDuplicate = self::DUPLICATE_SKIP
87 ) {
88 if (!is_array($fileName)) {
89 CRM_Core_Error::fatal();
90 }
91 $fileName = $fileName['name'];
92
93 switch ($contactType) {
94 case CRM_Import_Parser::CONTACT_INDIVIDUAL:
95 $this->_contactType = 'Individual';
96 break;
97
98 case CRM_Import_Parser::CONTACT_HOUSEHOLD:
99 $this->_contactType = 'Household';
100 break;
101
102 case CRM_Import_Parser::CONTACT_ORGANIZATION:
103 $this->_contactType = 'Organization';
104 }
105 $this->init();
106
107 $this->_haveColumnHeader = $skipColumnHeader;
108
109 $this->_separator = $separator;
110
111 $fd = fopen($fileName, "r");
112 if (!$fd) {
113 return FALSE;
114 }
115
116 $this->_lineCount = $this->_warningCount = 0;
117 $this->_invalidRowCount = $this->_validCount = 0;
118 $this->_totalCount = $this->_conflictCount = 0;
119
120 $this->_errors = array();
121 $this->_warnings = array();
122 $this->_conflicts = array();
123
124 $this->_fileSize = number_format(filesize($fileName) / 1024.0, 2);
125
126 if ($mode == self::MODE_MAPFIELD) {
127 $this->_rows = array();
128 }
129 else {
130 $this->_activeFieldCount = count($this->_activeFields);
131 }
132
133 while (!feof($fd)) {
134 $this->_lineCount++;
135
136 $values = fgetcsv($fd, 8192, $separator);
137 if (!$values) {
138 continue;
139 }
140
141 self::encloseScrub($values);
142
143 // skip column header if we're not in mapfield mode
144 if ($mode != self::MODE_MAPFIELD && $skipColumnHeader) {
145 $skipColumnHeader = FALSE;
146 continue;
147 }
148
149 /* trim whitespace around the values */
150
151 $empty = TRUE;
152 foreach ($values as $k => $v) {
153 $values[$k] = trim($v, " \t\r\n");
154 }
155
156 if (CRM_Utils_System::isNull($values)) {
157 continue;
158 }
159
160 $this->_totalCount++;
161
162 if ($mode == self::MODE_MAPFIELD) {
163 $returnCode = $this->mapField($values);
164 }
165 elseif ($mode == self::MODE_PREVIEW) {
166 $returnCode = $this->preview($values);
167 }
168 elseif ($mode == self::MODE_SUMMARY) {
169 $returnCode = $this->summary($values);
170 }
171 elseif ($mode == self::MODE_IMPORT) {
172 $returnCode = $this->import($onDuplicate, $values);
173 }
174 else {
175 $returnCode = self::ERROR;
176 }
177
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));
184 }
185 }
186
187 if ($returnCode & self::WARNING) {
188 $this->_warningCount++;
189 if ($this->_warningCount < $this->_maxWarningCount) {
190 $this->_warningCount[] = $line;
191 }
192 }
193
194 if ($returnCode & self::ERROR) {
195 $this->_invalidRowCount++;
196 if ($this->_invalidRowCount < $this->_maxErrorCount) {
197 $recordNumber = $this->_lineCount;
198 if ($this->_haveColumnHeader) {
199 $recordNumber--;
200 }
201 array_unshift($values, $recordNumber);
202 $this->_errors[] = $values;
203 }
204 }
205
206 if ($returnCode & self::CONFLICT) {
207 $this->_conflictCount++;
208 $recordNumber = $this->_lineCount;
209 if ($this->_haveColumnHeader) {
210 $recordNumber--;
211 }
212 array_unshift($values, $recordNumber);
213 $this->_conflicts[] = $values;
214 }
215
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 */
220 }
221 $this->_duplicateCount++;
222 $recordNumber = $this->_lineCount;
223 if ($this->_haveColumnHeader) {
224 $recordNumber--;
225 }
226 array_unshift($values, $recordNumber);
227 $this->_duplicates[] = $values;
228 if ($onDuplicate != self::DUPLICATE_SKIP) {
229 $this->_validCount++;
230 }
231 }
232
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) {
236 break;
237 }
238
239 // if we are done processing the maxNumber of lines, break
240 if ($this->_maxLinesToProcess > 0 && $this->_validCount >= $this->_maxLinesToProcess) {
241 break;
242 }
243 }
244
245 fclose($fd);
246
9ff5f6c0
N
247 if ($mode == self::MODE_PREVIEW || $mode == self::MODE_IMPORT) {
248 $customHeaders = $mapper;
249
250 $customfields = CRM_Core_BAO_CustomField::getFields('Activity');
251 foreach ($customHeaders as $key => $value) {
252 if ($id = CRM_Core_BAO_CustomField::getKeyID($value)) {
253 $customHeaders[$key] = $customfields[$id][0];
254 }
255 }
256 if ($this->_invalidRowCount) {
257 // removed view url for invlaid contacts
258 $headers = array_merge(array(ts('Line Number'),
259 ts('Reason'),
260 ),
261 $customHeaders
262 );
263 $this->_errorFileName = self::errorFileName(self::ERROR);
264 self::exportCSV($this->_errorFileName, $headers, $this->_errors);
265 }
266 if ($this->_conflictCount) {
267 $headers = array_merge(array(ts('Line Number'),
268 ts('Reason'),
269 ),
270 $customHeaders
271 );
272 $this->_conflictFileName = self::errorFileName(self::CONFLICT);
273 self::exportCSV($this->_conflictFileName, $headers, $this->_conflicts);
274 }
275 if ($this->_duplicateCount) {
276 $headers = array_merge(array(ts('Line Number'),
277 ts('View Activity History URL'),
278 ),
279 $customHeaders
280 );
281
282 $this->_duplicateFileName = self::errorFileName(self::DUPLICATE);
283 self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates);
284 }
285 }
286 return $this->fini();
287 }
288
289 /**
290 * Given a list of the importable field keys that the user has selected
291 * set the active fields array to this list
292 *
293 * @param array mapped array of values
294 *
295 * @return void
9ff5f6c0 296 */
00be9182 297 public function setActiveFields($fieldKeys) {
9ff5f6c0
N
298 $this->_activeFieldCount = count($fieldKeys);
299 foreach ($fieldKeys as $key) {
300 if (empty($this->_fields[$key])) {
301 $this->_activeFields[] = new CRM_Custom_Import_Field('', ts('- do not import -'));
302 }
303 else {
304 $this->_activeFields[] = clone($this->_fields[$key]);
305 }
306 }
307 }
308
309 /**
100fef9d 310 * Format the field values for input to the api
9ff5f6c0
N
311 *
312 * @return array (reference ) associative array of name/value pairs
9ff5f6c0 313 */
00be9182 314 public function &getActiveFieldParams() {
9ff5f6c0
N
315 $params = array();
316 for ($i = 0; $i < $this->_activeFieldCount; $i++) {
317 if (isset($this->_activeFields[$i]->_value)
318 && !isset($params[$this->_activeFields[$i]->_name])
319 && !isset($this->_activeFields[$i]->_related)
320 ) {
321 $params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value;
322 }
323 }
324 return $params;
325 }
326
327 /**
328 * Store parser values
329 *
330 * @param CRM_Core_Session $store
331 *
da6b46f4
EM
332 * @param int $mode
333 *
9ff5f6c0 334 * @return void
9ff5f6c0 335 */
00be9182 336 public function set($store, $mode = self::MODE_SUMMARY) {
9ff5f6c0
N
337 $store->set('fileSize', $this->_fileSize);
338 $store->set('lineCount', $this->_lineCount);
339 $store->set('seperator', $this->_separator);
340 $store->set('fields', $this->getSelectValues());
341 $store->set('fieldTypes', $this->getSelectTypes());
342
343 $store->set('headerPatterns', $this->getHeaderPatterns());
344 $store->set('dataPatterns', $this->getDataPatterns());
345 $store->set('columnCount', $this->_activeFieldCount);
346 $store->set('_entity', $this->_entity);
347 $store->set('totalRowCount', $this->_totalCount);
348 $store->set('validRowCount', $this->_validCount);
349 $store->set('invalidRowCount', $this->_invalidRowCount);
350 $store->set('conflictRowCount', $this->_conflictCount);
351
352 switch ($this->_contactType) {
353 case 'Individual':
354 $store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL);
355 break;
356
357 case 'Household':
358 $store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD);
359 break;
360
361 case 'Organization':
362 $store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION);
363 }
364
365 if ($this->_invalidRowCount) {
366 $store->set('errorsFileName', $this->_errorFileName);
367 }
368 if ($this->_conflictCount) {
369 $store->set('conflictsFileName', $this->_conflictFileName);
370 }
371 if (isset($this->_rows) && !empty($this->_rows)) {
372 $store->set('dataValues', $this->_rows);
373 }
374
375 if ($mode == self::MODE_IMPORT) {
376 $store->set('duplicateRowCount', $this->_duplicateCount);
377 if ($this->_duplicateCount) {
378 $store->set('duplicatesFileName', $this->_duplicateFileName);
379 }
380 }
381 }
382}