Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | ||
ec3811b1 | 37 | abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { |
6a488035 TO |
38 | |
39 | protected $_tableName; | |
40 | ||
41 | /**#@+ | |
42 | * @access protected | |
43 | * @var integer | |
44 | */ | |
45 | ||
46 | /** | |
47 | * total number of lines in file | |
48 | */ | |
49 | protected $_rowCount; | |
50 | ||
6a488035 TO |
51 | /** |
52 | * running total number of un matched Conact | |
53 | */ | |
54 | protected $_unMatchCount; | |
55 | ||
56 | /** | |
57 | * array of unmatched lines | |
58 | */ | |
59 | protected $_unMatch; | |
60 | ||
6a488035 TO |
61 | /** |
62 | * total number of contacts with unparsed addresses | |
63 | */ | |
64 | protected $_unparsedAddressCount; | |
65 | ||
6a488035 TO |
66 | /** |
67 | * filename of mismatch data | |
68 | * | |
69 | * @var string | |
70 | */ | |
71 | protected $_misMatchFilemName; | |
72 | ||
73 | protected $_primaryKeyName; | |
74 | protected $_statusFieldName; | |
75 | ||
6a488035 TO |
76 | /** |
77 | * on duplicate | |
78 | * | |
79 | * @var int | |
80 | */ | |
81 | public $_onDuplicate; | |
82 | ||
83 | /** | |
84 | * dedupe rule group id to use if set | |
85 | * | |
86 | * @var int | |
87 | */ | |
03e04002 | 88 | public $_dedupeRuleGroupID = NULL; |
6a488035 | 89 | |
86538308 EM |
90 | /** |
91 | * @param $tableName | |
92 | * @param $mapper | |
93 | * @param int $mode | |
94 | * @param int $contactType | |
95 | * @param string $primaryKeyName | |
96 | * @param string $statusFieldName | |
97 | * @param int $onDuplicate | |
98 | * @param null $statusID | |
99 | * @param null $totalRowCount | |
100 | * @param bool $doGeocodeAddress | |
101 | * @param int $timeout | |
102 | * @param null $contactSubType | |
103 | * @param null $dedupeRuleGroupID | |
104 | * | |
105 | * @return mixed | |
106 | */ | |
6a488035 TO |
107 | function run($tableName, |
108 | &$mapper, | |
52892e8b CW |
109 | $mode = self::MODE_PREVIEW, |
110 | $contactType = self::CONTACT_INDIVIDUAL, | |
111 | $primaryKeyName = '_id', | |
112 | $statusFieldName = '_status', | |
113 | $onDuplicate = self::DUPLICATE_SKIP, | |
114 | $statusID = NULL, | |
115 | $totalRowCount = NULL, | |
116 | $doGeocodeAddress = FALSE, | |
117 | $timeout = CRM_Contact_Import_Parser::DEFAULT_TIMEOUT, | |
118 | $contactSubType = NULL, | |
6a488035 TO |
119 | $dedupeRuleGroupID = NULL |
120 | ) { | |
121 | ||
122 | // TODO: Make the timeout actually work | |
123 | $this->_onDuplicate = $onDuplicate; | |
124 | $this->_dedupeRuleGroupID = $dedupeRuleGroupID; | |
125 | ||
126 | switch ($contactType) { | |
a05662ef | 127 | case CRM_Import_Parser::CONTACT_INDIVIDUAL: |
6a488035 TO |
128 | $this->_contactType = 'Individual'; |
129 | break; | |
130 | ||
a05662ef | 131 | case CRM_Import_Parser::CONTACT_HOUSEHOLD: |
6a488035 TO |
132 | $this->_contactType = 'Household'; |
133 | break; | |
134 | ||
a05662ef | 135 | case CRM_Import_Parser::CONTACT_ORGANIZATION: |
6a488035 TO |
136 | $this->_contactType = 'Organization'; |
137 | } | |
138 | ||
139 | $this->_contactSubType = $contactSubType; | |
140 | ||
141 | $this->init(); | |
142 | ||
143 | $this->_rowCount = $this->_warningCount = 0; | |
144 | $this->_invalidRowCount = $this->_validCount = 0; | |
145 | $this->_totalCount = $this->_conflictCount = 0; | |
146 | ||
147 | $this->_errors = array(); | |
148 | $this->_warnings = array(); | |
149 | $this->_conflicts = array(); | |
150 | $this->_unparsedAddresses = array(); | |
151 | ||
152 | $status = ''; | |
153 | ||
154 | $this->_tableName = $tableName; | |
155 | $this->_primaryKeyName = $primaryKeyName; | |
156 | $this->_statusFieldName = $statusFieldName; | |
157 | ||
158 | if ($mode == self::MODE_MAPFIELD) { | |
159 | $this->_rows = array(); | |
160 | } | |
161 | else { | |
162 | $this->_activeFieldCount = count($this->_activeFields); | |
163 | } | |
164 | ||
165 | if ($mode == self::MODE_IMPORT) { | |
166 | //get the key of email field | |
167 | foreach ($mapper as $key => $value) { | |
168 | if (strtolower($value) == 'email') { | |
169 | $emailKey = $key; | |
170 | break; | |
171 | } | |
172 | } | |
173 | } | |
174 | ||
175 | if ($statusID) { | |
176 | $skip = 50; | |
177 | // $skip = 1; | |
52892e8b | 178 | $config = CRM_Core_Config::singleton(); |
6a488035 | 179 | $statusFile = "{$config->uploadDir}status_{$statusID}.txt"; |
52892e8b | 180 | $status = "<div class='description'> " . ts('No processing status reported yet.') . "</div>"; |
6a488035 TO |
181 | |
182 | //do not force the browser to display the save dialog, CRM-7640 | |
183 | $contents = json_encode(array(0, $status)); | |
184 | ||
185 | file_put_contents($statusFile, $contents); | |
186 | ||
187 | $startTimestamp = $currTimestamp = $prevTimestamp = time(); | |
188 | } | |
189 | ||
190 | // get the contents of the temp. import table | |
191 | $query = "SELECT * FROM $tableName"; | |
192 | if ($mode == self::MODE_IMPORT) { | |
193 | $query .= " WHERE $statusFieldName = 'NEW'"; | |
194 | } | |
52892e8b CW |
195 | $dao = new CRM_Core_DAO(); |
196 | $db = $dao->getDatabaseConnection(); | |
6a488035 TO |
197 | $result = $db->query($query); |
198 | ||
199 | while ($values = $result->fetchRow(DB_FETCHMODE_ORDERED)) { | |
200 | $this->_rowCount++; | |
201 | ||
202 | /* trim whitespace around the values */ | |
203 | ||
204 | $empty = TRUE; | |
205 | foreach ($values as $k => $v) { | |
206 | $values[$k] = trim($v, " \t\r\n"); | |
207 | } | |
208 | if (CRM_Utils_System::isNull($values)) { | |
209 | continue; | |
210 | } | |
211 | ||
212 | $this->_totalCount++; | |
213 | ||
214 | if ($mode == self::MODE_MAPFIELD) { | |
215 | $returnCode = $this->mapField($values); | |
216 | } | |
217 | elseif ($mode == self::MODE_PREVIEW) { | |
218 | $returnCode = $this->preview($values); | |
219 | } | |
220 | elseif ($mode == self::MODE_SUMMARY) { | |
221 | $returnCode = $this->summary($values); | |
222 | } | |
223 | elseif ($mode == self::MODE_IMPORT) { | |
224 | //print "Running parser in import mode<br/>\n"; | |
225 | $returnCode = $this->import($onDuplicate, $values, $doGeocodeAddress); | |
226 | if ($statusID && (($this->_rowCount % $skip) == 0)) { | |
227 | $currTimestamp = time(); | |
52892e8b CW |
228 | $totalTime = ($currTimestamp - $startTimestamp); |
229 | $time = ($currTimestamp - $prevTimestamp); | |
230 | $recordsLeft = $totalRowCount - $this->_rowCount; | |
6a488035 TO |
231 | if ($recordsLeft < 0) { |
232 | $recordsLeft = 0; | |
233 | } | |
234 | $estimatedTime = ($recordsLeft / $skip) * $time; | |
52892e8b | 235 | $estMinutes = floor($estimatedTime / 60); |
6a488035 TO |
236 | $timeFormatted = ''; |
237 | if ($estMinutes > 1) { | |
238 | $timeFormatted = $estMinutes . ' ' . ts('minutes') . ' '; | |
239 | $estimatedTime = $estimatedTime - ($estMinutes * 60); | |
240 | } | |
241 | $timeFormatted .= round($estimatedTime) . ' ' . ts('seconds'); | |
242 | $processedPercent = (int )(($this->_rowCount * 100) / $totalRowCount); | |
243 | $statusMsg = ts('%1 of %2 records - %3 remaining', | |
244 | array(1 => $this->_rowCount, 2 => $totalRowCount, 3 => $timeFormatted) | |
245 | ); | |
246 | $status = " | |
247 | <div class=\"description\"> | |
248 | <strong>{$statusMsg}</strong> | |
249 | </div> | |
250 | "; | |
251 | ||
252 | $contents = json_encode (array($processedPercent, $status)); | |
253 | ||
254 | file_put_contents($statusFile, $contents); | |
255 | ||
256 | $prevTimestamp = $currTimestamp; | |
257 | } | |
258 | // sleep(1); | |
259 | } | |
260 | else { | |
261 | $returnCode = self::ERROR; | |
262 | } | |
263 | ||
264 | // note that a line could be valid but still produce a warning | |
265 | if ($returnCode & self::VALID) { | |
266 | $this->_validCount++; | |
267 | if ($mode == self::MODE_MAPFIELD) { | |
268 | $this->_rows[] = $values; | |
269 | $this->_activeFieldCount = max($this->_activeFieldCount, count($values)); | |
270 | } | |
271 | } | |
272 | ||
273 | if ($returnCode & self::WARNING) { | |
274 | $this->_warningCount++; | |
275 | if ($this->_warningCount < $this->_maxWarningCount) { | |
276 | $this->_warningCount[] = $line; | |
277 | } | |
278 | } | |
279 | ||
280 | if ($returnCode & self::ERROR) { | |
281 | $this->_invalidRowCount++; | |
282 | if ($this->_invalidRowCount < $this->_maxErrorCount) { | |
283 | array_unshift($values, $this->_rowCount); | |
284 | $this->_errors[] = $values; | |
285 | } | |
286 | } | |
287 | ||
288 | if ($returnCode & self::CONFLICT) { | |
289 | $this->_conflictCount++; | |
290 | array_unshift($values, $this->_rowCount); | |
291 | $this->_conflicts[] = $values; | |
292 | } | |
293 | ||
294 | if ($returnCode & self::NO_MATCH) { | |
295 | $this->_unMatchCount++; | |
296 | array_unshift($values, $this->_rowCount); | |
297 | $this->_unMatch[] = $values; | |
298 | } | |
299 | ||
300 | if ($returnCode & self::DUPLICATE) { | |
301 | if ($returnCode & self::MULTIPLE_DUPE) { | |
302 | /* TODO: multi-dupes should be counted apart from singles | |
303 | * on non-skip action */ | |
304 | } | |
305 | $this->_duplicateCount++; | |
306 | array_unshift($values, $this->_rowCount); | |
307 | $this->_duplicates[] = $values; | |
308 | if ($onDuplicate != self::DUPLICATE_SKIP) { | |
309 | $this->_validCount++; | |
310 | } | |
311 | } | |
312 | ||
313 | if ($returnCode & self::UNPARSED_ADDRESS_WARNING) { | |
314 | $this->_unparsedAddressCount++; | |
315 | array_unshift($values, $this->_rowCount); | |
316 | $this->_unparsedAddresses[] = $values; | |
317 | } | |
318 | // we give the derived class a way of aborting the process | |
319 | // note that the return code could be multiple code or'ed together | |
320 | if ($returnCode & self::STOP) { | |
321 | break; | |
322 | } | |
323 | ||
324 | // if we are done processing the maxNumber of lines, break | |
325 | if ($this->_maxLinesToProcess > 0 && $this->_validCount >= $this->_maxLinesToProcess) { | |
326 | break; | |
327 | } | |
328 | ||
329 | // clean up memory from dao's | |
330 | CRM_Core_DAO::freeResult(); | |
331 | ||
332 | // see if we've hit our timeout yet | |
333 | /* if ( $the_thing_with_the_stuff ) { | |
334 | do_something( ); | |
335 | } */ | |
336 | } | |
337 | ||
338 | ||
339 | if ($mode == self::MODE_PREVIEW || $mode == self::MODE_IMPORT) { | |
340 | $customHeaders = $mapper; | |
341 | ||
342 | $customfields = CRM_Core_BAO_CustomField::getFields($this->_contactType); | |
343 | foreach ($customHeaders as $key => $value) { | |
344 | if ($id = CRM_Core_BAO_CustomField::getKeyID($value)) { | |
345 | $customHeaders[$key] = $customfields[$id][0]; | |
346 | } | |
347 | } | |
348 | ||
349 | if ($this->_invalidRowCount) { | |
350 | // removed view url for invlaid contacts | |
351 | $headers = array_merge(array(ts('Line Number'), | |
352 | ts('Reason'), | |
353 | ), | |
354 | $customHeaders | |
355 | ); | |
356 | $this->_errorFileName = self::errorFileName(self::ERROR); | |
357 | self::exportCSV($this->_errorFileName, $headers, $this->_errors); | |
358 | } | |
359 | if ($this->_conflictCount) { | |
360 | $headers = array_merge(array(ts('Line Number'), | |
361 | ts('Reason'), | |
362 | ), | |
363 | $customHeaders | |
364 | ); | |
365 | $this->_conflictFileName = self::errorFileName(self::CONFLICT); | |
366 | self::exportCSV($this->_conflictFileName, $headers, $this->_conflicts); | |
367 | } | |
368 | if ($this->_duplicateCount) { | |
369 | $headers = array_merge(array(ts('Line Number'), | |
370 | ts('View Contact URL'), | |
371 | ), | |
372 | $customHeaders | |
373 | ); | |
374 | ||
375 | $this->_duplicateFileName = self::errorFileName(self::DUPLICATE); | |
376 | self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates); | |
377 | } | |
378 | if ($this->_unMatchCount) { | |
379 | $headers = array_merge(array(ts('Line Number'), | |
380 | ts('Reason'), | |
381 | ), | |
382 | $customHeaders | |
383 | ); | |
384 | ||
385 | $this->_misMatchFilemName = self::errorFileName(self::NO_MATCH); | |
386 | self::exportCSV($this->_misMatchFilemName, $headers, $this->_unMatch); | |
387 | } | |
388 | if ($this->_unparsedAddressCount) { | |
389 | $headers = array_merge(array(ts('Line Number'), | |
390 | ts('Contact Edit URL'), | |
391 | ), | |
392 | $customHeaders | |
393 | ); | |
394 | $this->_errorFileName = self::errorFileName(self::UNPARSED_ADDRESS_WARNING); | |
395 | self::exportCSV($this->_errorFileName, $headers, $this->_unparsedAddresses); | |
396 | } | |
397 | } | |
398 | //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; | |
399 | return $this->fini(); | |
400 | } | |
401 | ||
6a488035 TO |
402 | /** |
403 | * Given a list of the importable field keys that the user has selected | |
404 | * set the active fields array to this list | |
405 | * | |
406 | * @param array mapped array of values | |
407 | * | |
408 | * @return void | |
409 | * @access public | |
410 | */ | |
411 | function setActiveFields($fieldKeys) { | |
412 | $this->_activeFieldCount = count($fieldKeys); | |
413 | foreach ($fieldKeys as $key) { | |
414 | if (empty($this->_fields[$key])) { | |
719a6fec | 415 | $this->_activeFields[] = new CRM_Contact_Import_Field('', ts('- do not import -')); |
6a488035 TO |
416 | } |
417 | else { | |
418 | $this->_activeFields[] = clone($this->_fields[$key]); | |
419 | } | |
420 | } | |
421 | } | |
422 | ||
86538308 EM |
423 | /** |
424 | * @param $elements | |
425 | */ | |
6a488035 TO |
426 | function setActiveFieldLocationTypes($elements) { |
427 | for ($i = 0; $i < count($elements); $i++) { | |
428 | $this->_activeFields[$i]->_hasLocationType = $elements[$i]; | |
429 | } | |
430 | } | |
431 | ||
86538308 EM |
432 | /** |
433 | * @param $elements | |
434 | */ | |
435 | /** | |
436 | * @param $elements | |
437 | */ | |
6a488035 TO |
438 | function setActiveFieldPhoneTypes($elements) { |
439 | for ($i = 0; $i < count($elements); $i++) { | |
440 | $this->_activeFields[$i]->_phoneType = $elements[$i]; | |
441 | } | |
442 | } | |
443 | ||
86538308 EM |
444 | /** |
445 | * @param $elements | |
446 | */ | |
6a488035 TO |
447 | function setActiveFieldWebsiteTypes($elements) { |
448 | for ($i = 0; $i < count($elements); $i++) { | |
449 | $this->_activeFields[$i]->_websiteType = $elements[$i]; | |
450 | } | |
451 | } | |
452 | ||
453 | /** | |
454 | * Function to set IM Service Provider type fields | |
455 | * | |
456 | * @param array $elements IM service provider type ids | |
457 | * | |
458 | * @return void | |
459 | * @access public | |
460 | */ | |
461 | function setActiveFieldImProviders($elements) { | |
462 | for ($i = 0; $i < count($elements); $i++) { | |
463 | $this->_activeFields[$i]->_imProvider = $elements[$i]; | |
464 | } | |
465 | } | |
466 | ||
86538308 EM |
467 | /** |
468 | * @param $elements | |
469 | */ | |
6a488035 TO |
470 | function setActiveFieldRelated($elements) { |
471 | for ($i = 0; $i < count($elements); $i++) { | |
472 | $this->_activeFields[$i]->_related = $elements[$i]; | |
473 | } | |
474 | } | |
475 | ||
86538308 EM |
476 | /** |
477 | * @param $elements | |
478 | */ | |
6a488035 TO |
479 | function setActiveFieldRelatedContactType($elements) { |
480 | for ($i = 0; $i < count($elements); $i++) { | |
481 | $this->_activeFields[$i]->_relatedContactType = $elements[$i]; | |
482 | } | |
483 | } | |
484 | ||
86538308 EM |
485 | /** |
486 | * @param $elements | |
487 | */ | |
6a488035 TO |
488 | function setActiveFieldRelatedContactDetails($elements) { |
489 | for ($i = 0; $i < count($elements); $i++) { | |
490 | $this->_activeFields[$i]->_relatedContactDetails = $elements[$i]; | |
491 | } | |
492 | } | |
493 | ||
86538308 EM |
494 | /** |
495 | * @param $elements | |
496 | */ | |
6a488035 TO |
497 | function setActiveFieldRelatedContactLocType($elements) { |
498 | for ($i = 0; $i < count($elements); $i++) { | |
499 | $this->_activeFields[$i]->_relatedContactLocType = $elements[$i]; | |
500 | } | |
501 | } | |
502 | ||
86538308 EM |
503 | /** |
504 | * @param $elements | |
505 | */ | |
6a488035 TO |
506 | function setActiveFieldRelatedContactPhoneType($elements) { |
507 | for ($i = 0; $i < count($elements); $i++) { | |
508 | $this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i]; | |
509 | } | |
510 | } | |
511 | ||
86538308 EM |
512 | /** |
513 | * @param $elements | |
514 | */ | |
6a488035 TO |
515 | function setActiveFieldRelatedContactWebsiteType($elements) { |
516 | for ($i = 0; $i < count($elements); $i++) { | |
517 | $this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i]; | |
518 | } | |
519 | } | |
520 | ||
521 | /** | |
522 | * Function to set IM Service Provider type fields for related contacts | |
523 | * | |
524 | * @param array $elements IM service provider type ids of related contact | |
525 | * | |
526 | * @return void | |
527 | * @access public | |
528 | */ | |
529 | function setActiveFieldRelatedContactImProvider($elements) { | |
530 | for ($i = 0; $i < count($elements); $i++) { | |
531 | $this->_activeFields[$i]->_relatedContactImProvider = $elements[$i]; | |
532 | } | |
533 | } | |
534 | ||
535 | /** | |
536 | * function to format the field values for input to the api | |
537 | * | |
538 | * @return array (reference ) associative array of name/value pairs | |
539 | * @access public | |
540 | */ | |
541 | function &getActiveFieldParams() { | |
542 | $params = array(); | |
543 | ||
544 | //CRM_Core_Error::debug( 'Count', $this->_activeFieldCount ); | |
545 | for ($i = 0; $i < $this->_activeFieldCount; $i++) { | |
546 | if ($this->_activeFields[$i]->_name == 'do_not_import') { | |
547 | continue; | |
548 | } | |
549 | ||
550 | if (isset($this->_activeFields[$i]->_value)) { | |
551 | if (isset($this->_activeFields[$i]->_hasLocationType)) { | |
552 | if (!isset($params[$this->_activeFields[$i]->_name])) { | |
553 | $params[$this->_activeFields[$i]->_name] = array(); | |
554 | } | |
555 | ||
556 | $value = array( | |
557 | $this->_activeFields[$i]->_name => | |
558 | $this->_activeFields[$i]->_value, | |
559 | 'location_type_id' => | |
560 | $this->_activeFields[$i]->_hasLocationType, | |
561 | ); | |
562 | ||
563 | if (isset($this->_activeFields[$i]->_phoneType)) { | |
564 | $value['phone_type_id'] = $this->_activeFields[$i]->_phoneType; | |
565 | } | |
566 | ||
567 | // get IM service Provider type id | |
568 | if (isset($this->_activeFields[$i]->_imProvider)) { | |
569 | $value['provider_id'] = $this->_activeFields[$i]->_imProvider; | |
570 | } | |
571 | ||
572 | $params[$this->_activeFields[$i]->_name][] = $value; | |
573 | } | |
574 | elseif (isset($this->_activeFields[$i]->_websiteType)) { | |
575 | $value = array( | |
576 | $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value, | |
577 | 'website_type_id' => $this->_activeFields[$i]->_websiteType, | |
578 | ); | |
579 | ||
580 | $params[$this->_activeFields[$i]->_name][] = $value; | |
581 | } | |
582 | ||
583 | if (!isset($params[$this->_activeFields[$i]->_name])) { | |
584 | if (!isset($this->_activeFields[$i]->_related)) { | |
585 | $params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value; | |
586 | } | |
587 | } | |
588 | ||
589 | //minor fix for CRM-4062 | |
590 | if (isset($this->_activeFields[$i]->_related)) { | |
591 | if (!isset($params[$this->_activeFields[$i]->_related])) { | |
592 | $params[$this->_activeFields[$i]->_related] = array(); | |
593 | } | |
594 | ||
595 | if (!isset($params[$this->_activeFields[$i]->_related]['contact_type']) && !empty($this->_activeFields[$i]->_relatedContactType)) { | |
596 | $params[$this->_activeFields[$i]->_related]['contact_type'] = $this->_activeFields[$i]->_relatedContactType; | |
597 | } | |
598 | ||
599 | if (isset($this->_activeFields[$i]->_relatedContactLocType) && !empty($this->_activeFields[$i]->_value)) { | |
600 | if (!is_array($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails])) { | |
601 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = array(); | |
602 | } | |
603 | $value = array( | |
604 | $this->_activeFields[$i]->_relatedContactDetails => $this->_activeFields[$i]->_value, | |
605 | 'location_type_id' => $this->_activeFields[$i]->_relatedContactLocType, | |
606 | ); | |
607 | ||
608 | if (isset($this->_activeFields[$i]->_relatedContactPhoneType)) { | |
609 | $value['phone_type_id'] = $this->_activeFields[$i]->_relatedContactPhoneType; | |
610 | } | |
611 | ||
612 | // get IM service Provider type id for related contact | |
613 | if (isset($this->_activeFields[$i]->_relatedContactImProvider)) { | |
614 | $value['provider_id'] = $this->_activeFields[$i]->_relatedContactImProvider; | |
615 | } | |
616 | ||
617 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = $value; | |
618 | } | |
619 | elseif (isset($this->_activeFields[$i]->_relatedContactWebsiteType)) { | |
620 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = array( | |
621 | 'url' => $this->_activeFields[$i]->_value, | |
622 | 'website_type_id' => $this->_activeFields[$i]->_relatedContactWebsiteType, | |
623 | ); | |
624 | } | |
625 | else { | |
626 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = $this->_activeFields[$i]->_value; | |
627 | } | |
628 | } | |
629 | } | |
630 | } | |
631 | ||
632 | return $params; | |
633 | } | |
634 | ||
86538308 EM |
635 | /** |
636 | * @return array | |
637 | */ | |
6a488035 TO |
638 | function getColumnPatterns() { |
639 | $values = array(); | |
640 | foreach ($this->_fields as $name => $field) { | |
641 | $values[$name] = $field->_columnPattern; | |
642 | } | |
643 | return $values; | |
644 | } | |
645 | ||
86538308 EM |
646 | /** |
647 | * @param $name | |
648 | * @param $title | |
649 | * @param int $type | |
650 | * @param string $headerPattern | |
651 | * @param string $dataPattern | |
652 | * @param bool $hasLocationType | |
653 | */ | |
6a488035 TO |
654 | function addField($name, $title, $type = CRM_Utils_Type::T_INT, |
655 | $headerPattern = '//', $dataPattern = '//', | |
656 | $hasLocationType = FALSE | |
657 | ) { | |
719a6fec | 658 | $this->_fields[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType); |
6a488035 | 659 | if (empty($name)) { |
719a6fec | 660 | $this->_fields['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType); |
6a488035 TO |
661 | } |
662 | } | |
663 | ||
6a488035 TO |
664 | /** |
665 | * Store parser values | |
666 | * | |
667 | * @param CRM_Core_Session $store | |
668 | * | |
2a6da8d7 EM |
669 | * @param int $mode |
670 | * | |
6a488035 TO |
671 | * @return void |
672 | * @access public | |
673 | */ | |
674 | function set($store, $mode = self::MODE_SUMMARY) { | |
675 | $store->set('rowCount', $this->_rowCount); | |
676 | $store->set('fields', $this->getSelectValues()); | |
677 | $store->set('fieldTypes', $this->getSelectTypes()); | |
678 | ||
679 | $store->set('columnPatterns', $this->getColumnPatterns()); | |
680 | $store->set('dataPatterns', $this->getDataPatterns()); | |
681 | $store->set('columnCount', $this->_activeFieldCount); | |
682 | ||
683 | $store->set('totalRowCount', $this->_totalCount); | |
684 | $store->set('validRowCount', $this->_validCount); | |
685 | $store->set('invalidRowCount', $this->_invalidRowCount); | |
686 | $store->set('conflictRowCount', $this->_conflictCount); | |
687 | $store->set('unMatchCount', $this->_unMatchCount); | |
688 | ||
689 | switch ($this->_contactType) { | |
690 | case 'Individual': | |
a05662ef | 691 | $store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL); |
6a488035 TO |
692 | break; |
693 | ||
694 | case 'Household': | |
a05662ef | 695 | $store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD); |
6a488035 TO |
696 | break; |
697 | ||
698 | case 'Organization': | |
a05662ef | 699 | $store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION); |
6a488035 TO |
700 | } |
701 | ||
702 | if ($this->_invalidRowCount) { | |
703 | $store->set('errorsFileName', $this->_errorFileName); | |
704 | } | |
705 | if ($this->_conflictCount) { | |
706 | $store->set('conflictsFileName', $this->_conflictFileName); | |
707 | } | |
708 | if (isset($this->_rows) && !empty($this->_rows)) { | |
709 | $store->set('dataValues', $this->_rows); | |
710 | } | |
711 | ||
712 | if ($this->_unMatchCount) { | |
713 | $store->set('mismatchFileName', $this->_misMatchFilemName); | |
714 | } | |
715 | ||
716 | if ($mode == self::MODE_IMPORT) { | |
717 | $store->set('duplicateRowCount', $this->_duplicateCount); | |
718 | $store->set('unparsedAddressCount', $this->_unparsedAddressCount); | |
719 | if ($this->_duplicateCount) { | |
720 | $store->set('duplicatesFileName', $this->_duplicateFileName); | |
721 | } | |
722 | if ($this->_unparsedAddressCount) { | |
723 | $store->set('errorsFileName', $this->_errorFileName); | |
724 | } | |
725 | } | |
726 | //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; | |
727 | } | |
728 | ||
729 | /** | |
730 | * Export data to a CSV file | |
731 | * | |
2a6da8d7 | 732 | * @param $fileName |
6a488035 TO |
733 | * @param array $header |
734 | * @param data $data | |
735 | * | |
2a6da8d7 | 736 | * @internal param string $filename |
6a488035 TO |
737 | * @return void |
738 | * @access public | |
739 | */ | |
740 | static function exportCSV($fileName, $header, $data) { | |
741 | ||
742 | if (file_exists($fileName) && !is_writable($fileName)) { | |
743 | CRM_Core_Error::movedSiteError($fileName); | |
744 | } | |
745 | //hack to remove '_status', '_statusMsg' and '_id' from error file | |
746 | $errorValues = array(); | |
747 | $dbRecordStatus = array('IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW'); | |
748 | foreach ($data as $rowCount => $rowValues) { | |
749 | $count = 0; | |
750 | foreach ($rowValues as $key => $val) { | |
751 | if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) { | |
752 | break; | |
753 | } | |
754 | $errorValues[$rowCount][$key] = $val; | |
755 | $count++; | |
756 | } | |
757 | } | |
758 | $data = $errorValues; | |
759 | ||
760 | $output = array(); | |
761 | $fd = fopen($fileName, 'w'); | |
762 | ||
763 | foreach ($header as $key => $value) { | |
764 | $header[$key] = "\"$value\""; | |
765 | } | |
766 | $config = CRM_Core_Config::singleton(); | |
767 | $output[] = implode($config->fieldSeparator, $header); | |
768 | ||
769 | foreach ($data as $datum) { | |
770 | foreach ($datum as $key => $value) { | |
771 | $datum[$key] = "\"$value\""; | |
772 | } | |
773 | $output[] = implode($config->fieldSeparator, $datum); | |
774 | } | |
775 | fwrite($fd, implode("\n", $output)); | |
776 | fclose($fd); | |
777 | } | |
778 | ||
779 | /** | |
780 | * Update the record with PK $id in the import database table | |
781 | * | |
782 | * @param int $id | |
783 | * @param array $params | |
784 | * | |
785 | * @return void | |
786 | * @access public | |
787 | */ | |
788 | public function updateImportRecord($id, &$params) { | |
789 | $statusFieldName = $this->_statusFieldName; | |
790 | $primaryKeyName = $this->_primaryKeyName; | |
791 | ||
792 | if ($statusFieldName && $primaryKeyName) { | |
793 | $dao = new CRM_Core_DAO(); | |
794 | $db = $dao->getDatabaseConnection(); | |
795 | ||
796 | $query = "UPDATE $this->_tableName | |
52892e8b | 797 | SET $statusFieldName = ?, |
6a488035 | 798 | ${statusFieldName}Msg = ? |
52892e8b | 799 | WHERE $primaryKeyName = ?"; |
6a488035 TO |
800 | $args = array( |
801 | $params[$statusFieldName], | |
802 | CRM_Utils_Array::value("${statusFieldName}Msg", $params), | |
803 | $id, | |
804 | ); | |
805 | ||
806 | //print "Running query: $query<br/>With arguments: ".$params[$statusFieldName].", ".$params["${statusFieldName}Msg"].", $id<br/>"; | |
807 | ||
808 | $db->query($query, $args); | |
809 | } | |
810 | } | |
811 | ||
6a488035 TO |
812 | } |
813 |