Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 | 16 | */ |
ec3811b1 | 17 | abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { |
6a488035 TO |
18 | |
19 | protected $_tableName; | |
20 | ||
6a488035 | 21 | /** |
100fef9d | 22 | * Total number of lines in file |
4815ab3d | 23 | * |
9f266042 | 24 | * @var int |
6a488035 TO |
25 | */ |
26 | protected $_rowCount; | |
27 | ||
6a488035 | 28 | /** |
4815ab3d | 29 | * Running total number of un-matched Contacts. |
9f266042 | 30 | * |
69078420 | 31 | * @var int |
6a488035 TO |
32 | */ |
33 | protected $_unMatchCount; | |
34 | ||
35 | /** | |
9f266042 | 36 | * Array of unmatched lines. |
37 | * | |
69078420 | 38 | * @var array |
6a488035 TO |
39 | */ |
40 | protected $_unMatch; | |
41 | ||
6a488035 | 42 | /** |
100fef9d | 43 | * Total number of contacts with unparsed addresses |
69078420 | 44 | * @var int |
6a488035 TO |
45 | */ |
46 | protected $_unparsedAddressCount; | |
47 | ||
6a488035 | 48 | /** |
100fef9d | 49 | * Filename of mismatch data |
6a488035 TO |
50 | * |
51 | * @var string | |
52 | */ | |
53 | protected $_misMatchFilemName; | |
54 | ||
55 | protected $_primaryKeyName; | |
56 | protected $_statusFieldName; | |
57 | ||
0b3f2e42 | 58 | protected $fieldMetadata = []; |
6a488035 | 59 | /** |
100fef9d | 60 | * On duplicate |
6a488035 TO |
61 | * |
62 | * @var int | |
63 | */ | |
64 | public $_onDuplicate; | |
65 | ||
66 | /** | |
100fef9d | 67 | * Dedupe rule group id to use if set |
6a488035 TO |
68 | * |
69 | * @var int | |
70 | */ | |
03e04002 | 71 | public $_dedupeRuleGroupID = NULL; |
6a488035 | 72 | |
86538308 | 73 | /** |
4815ab3d | 74 | * Run import. |
75 | * | |
100fef9d | 76 | * @param string $tableName |
4815ab3d | 77 | * @param array $mapper |
86538308 EM |
78 | * @param int $mode |
79 | * @param int $contactType | |
80 | * @param string $primaryKeyName | |
81 | * @param string $statusFieldName | |
82 | * @param int $onDuplicate | |
100fef9d | 83 | * @param int $statusID |
8fd37b20 | 84 | * @param int $totalRowCount |
86538308 EM |
85 | * @param bool $doGeocodeAddress |
86 | * @param int $timeout | |
8fd37b20 | 87 | * @param string $contactSubType |
100fef9d | 88 | * @param int $dedupeRuleGroupID |
86538308 EM |
89 | * |
90 | * @return mixed | |
91 | */ | |
ae5ffbb7 | 92 | public function run( |
51ccfbbe | 93 | $tableName, |
cb660e1d | 94 | $mapper = [], |
52892e8b CW |
95 | $mode = self::MODE_PREVIEW, |
96 | $contactType = self::CONTACT_INDIVIDUAL, | |
97 | $primaryKeyName = '_id', | |
98 | $statusFieldName = '_status', | |
99 | $onDuplicate = self::DUPLICATE_SKIP, | |
100 | $statusID = NULL, | |
101 | $totalRowCount = NULL, | |
102 | $doGeocodeAddress = FALSE, | |
103 | $timeout = CRM_Contact_Import_Parser::DEFAULT_TIMEOUT, | |
104 | $contactSubType = NULL, | |
6a488035 TO |
105 | $dedupeRuleGroupID = NULL |
106 | ) { | |
107 | ||
108 | // TODO: Make the timeout actually work | |
109 | $this->_onDuplicate = $onDuplicate; | |
110 | $this->_dedupeRuleGroupID = $dedupeRuleGroupID; | |
111 | ||
112 | switch ($contactType) { | |
a05662ef | 113 | case CRM_Import_Parser::CONTACT_INDIVIDUAL: |
6a488035 TO |
114 | $this->_contactType = 'Individual'; |
115 | break; | |
116 | ||
a05662ef | 117 | case CRM_Import_Parser::CONTACT_HOUSEHOLD: |
6a488035 TO |
118 | $this->_contactType = 'Household'; |
119 | break; | |
120 | ||
a05662ef | 121 | case CRM_Import_Parser::CONTACT_ORGANIZATION: |
6a488035 TO |
122 | $this->_contactType = 'Organization'; |
123 | } | |
124 | ||
125 | $this->_contactSubType = $contactSubType; | |
126 | ||
127 | $this->init(); | |
128 | ||
129 | $this->_rowCount = $this->_warningCount = 0; | |
130 | $this->_invalidRowCount = $this->_validCount = 0; | |
131 | $this->_totalCount = $this->_conflictCount = 0; | |
132 | ||
be2fb01f CW |
133 | $this->_errors = []; |
134 | $this->_warnings = []; | |
135 | $this->_conflicts = []; | |
136 | $this->_unparsedAddresses = []; | |
6a488035 | 137 | |
6a488035 TO |
138 | $this->_tableName = $tableName; |
139 | $this->_primaryKeyName = $primaryKeyName; | |
140 | $this->_statusFieldName = $statusFieldName; | |
141 | ||
142 | if ($mode == self::MODE_MAPFIELD) { | |
be2fb01f | 143 | $this->_rows = []; |
6a488035 TO |
144 | } |
145 | else { | |
146 | $this->_activeFieldCount = count($this->_activeFields); | |
147 | } | |
148 | ||
149 | if ($mode == self::MODE_IMPORT) { | |
150 | //get the key of email field | |
151 | foreach ($mapper as $key => $value) { | |
152 | if (strtolower($value) == 'email') { | |
153 | $emailKey = $key; | |
154 | break; | |
155 | } | |
156 | } | |
157 | } | |
158 | ||
159 | if ($statusID) { | |
8cebffb2 | 160 | $this->progressImport($statusID); |
6a488035 TO |
161 | $startTimestamp = $currTimestamp = $prevTimestamp = time(); |
162 | } | |
6a488035 TO |
163 | // get the contents of the temp. import table |
164 | $query = "SELECT * FROM $tableName"; | |
165 | if ($mode == self::MODE_IMPORT) { | |
166 | $query .= " WHERE $statusFieldName = 'NEW'"; | |
167 | } | |
6a488035 | 168 | |
2adc819d | 169 | $result = CRM_Core_DAO::executeQuery($query); |
170 | ||
171 | while ($result->fetch()) { | |
86736b20 | 172 | $values = array_values($result->toArray()); |
6a488035 TO |
173 | $this->_rowCount++; |
174 | ||
175 | /* trim whitespace around the values */ | |
6a488035 TO |
176 | foreach ($values as $k => $v) { |
177 | $values[$k] = trim($v, " \t\r\n"); | |
178 | } | |
179 | if (CRM_Utils_System::isNull($values)) { | |
180 | continue; | |
181 | } | |
182 | ||
183 | $this->_totalCount++; | |
184 | ||
185 | if ($mode == self::MODE_MAPFIELD) { | |
186 | $returnCode = $this->mapField($values); | |
187 | } | |
188 | elseif ($mode == self::MODE_PREVIEW) { | |
189 | $returnCode = $this->preview($values); | |
190 | } | |
191 | elseif ($mode == self::MODE_SUMMARY) { | |
192 | $returnCode = $this->summary($values); | |
193 | } | |
194 | elseif ($mode == self::MODE_IMPORT) { | |
195 | //print "Running parser in import mode<br/>\n"; | |
196 | $returnCode = $this->import($onDuplicate, $values, $doGeocodeAddress); | |
8cebffb2 JP |
197 | if ($statusID && (($this->_rowCount % 50) == 0)) { |
198 | $prevTimestamp = $this->progressImport($statusID, FALSE, $startTimestamp, $prevTimestamp, $totalRowCount); | |
6a488035 | 199 | } |
6a488035 TO |
200 | } |
201 | else { | |
202 | $returnCode = self::ERROR; | |
203 | } | |
204 | ||
205 | // note that a line could be valid but still produce a warning | |
206 | if ($returnCode & self::VALID) { | |
207 | $this->_validCount++; | |
208 | if ($mode == self::MODE_MAPFIELD) { | |
209 | $this->_rows[] = $values; | |
210 | $this->_activeFieldCount = max($this->_activeFieldCount, count($values)); | |
211 | } | |
212 | } | |
213 | ||
214 | if ($returnCode & self::WARNING) { | |
215 | $this->_warningCount++; | |
216 | if ($this->_warningCount < $this->_maxWarningCount) { | |
217 | $this->_warningCount[] = $line; | |
218 | } | |
219 | } | |
220 | ||
221 | if ($returnCode & self::ERROR) { | |
222 | $this->_invalidRowCount++; | |
ca2057ea SM |
223 | array_unshift($values, $this->_rowCount); |
224 | $this->_errors[] = $values; | |
6a488035 TO |
225 | } |
226 | ||
227 | if ($returnCode & self::CONFLICT) { | |
228 | $this->_conflictCount++; | |
229 | array_unshift($values, $this->_rowCount); | |
230 | $this->_conflicts[] = $values; | |
231 | } | |
232 | ||
233 | if ($returnCode & self::NO_MATCH) { | |
234 | $this->_unMatchCount++; | |
235 | array_unshift($values, $this->_rowCount); | |
236 | $this->_unMatch[] = $values; | |
237 | } | |
238 | ||
239 | if ($returnCode & self::DUPLICATE) { | |
240 | if ($returnCode & self::MULTIPLE_DUPE) { | |
241 | /* TODO: multi-dupes should be counted apart from singles | |
e70a7fc0 | 242 | * on non-skip action */ |
6a488035 TO |
243 | } |
244 | $this->_duplicateCount++; | |
245 | array_unshift($values, $this->_rowCount); | |
246 | $this->_duplicates[] = $values; | |
247 | if ($onDuplicate != self::DUPLICATE_SKIP) { | |
248 | $this->_validCount++; | |
249 | } | |
250 | } | |
251 | ||
252 | if ($returnCode & self::UNPARSED_ADDRESS_WARNING) { | |
253 | $this->_unparsedAddressCount++; | |
254 | array_unshift($values, $this->_rowCount); | |
255 | $this->_unparsedAddresses[] = $values; | |
256 | } | |
257 | // we give the derived class a way of aborting the process | |
258 | // note that the return code could be multiple code or'ed together | |
259 | if ($returnCode & self::STOP) { | |
260 | break; | |
261 | } | |
262 | ||
263 | // if we are done processing the maxNumber of lines, break | |
264 | if ($this->_maxLinesToProcess > 0 && $this->_validCount >= $this->_maxLinesToProcess) { | |
265 | break; | |
266 | } | |
267 | ||
6a488035 TO |
268 | // see if we've hit our timeout yet |
269 | /* if ( $the_thing_with_the_stuff ) { | |
e70a7fc0 TO |
270 | do_something( ); |
271 | } */ | |
6a488035 TO |
272 | } |
273 | ||
6a488035 TO |
274 | if ($mode == self::MODE_PREVIEW || $mode == self::MODE_IMPORT) { |
275 | $customHeaders = $mapper; | |
276 | ||
277 | $customfields = CRM_Core_BAO_CustomField::getFields($this->_contactType); | |
278 | foreach ($customHeaders as $key => $value) { | |
279 | if ($id = CRM_Core_BAO_CustomField::getKeyID($value)) { | |
280 | $customHeaders[$key] = $customfields[$id][0]; | |
281 | } | |
282 | } | |
283 | ||
284 | if ($this->_invalidRowCount) { | |
285 | // removed view url for invlaid contacts | |
be2fb01f | 286 | $headers = array_merge([ |
69078420 SL |
287 | ts('Line Number'), |
288 | ts('Reason'), | |
289 | ], $customHeaders); | |
6a488035 TO |
290 | $this->_errorFileName = self::errorFileName(self::ERROR); |
291 | self::exportCSV($this->_errorFileName, $headers, $this->_errors); | |
292 | } | |
293 | if ($this->_conflictCount) { | |
be2fb01f | 294 | $headers = array_merge([ |
69078420 SL |
295 | ts('Line Number'), |
296 | ts('Reason'), | |
297 | ], $customHeaders); | |
6a488035 TO |
298 | $this->_conflictFileName = self::errorFileName(self::CONFLICT); |
299 | self::exportCSV($this->_conflictFileName, $headers, $this->_conflicts); | |
300 | } | |
301 | if ($this->_duplicateCount) { | |
be2fb01f | 302 | $headers = array_merge([ |
69078420 SL |
303 | ts('Line Number'), |
304 | ts('View Contact URL'), | |
305 | ], $customHeaders); | |
6a488035 TO |
306 | |
307 | $this->_duplicateFileName = self::errorFileName(self::DUPLICATE); | |
308 | self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates); | |
309 | } | |
310 | if ($this->_unMatchCount) { | |
be2fb01f | 311 | $headers = array_merge([ |
69078420 SL |
312 | ts('Line Number'), |
313 | ts('Reason'), | |
314 | ], $customHeaders); | |
6a488035 TO |
315 | |
316 | $this->_misMatchFilemName = self::errorFileName(self::NO_MATCH); | |
317 | self::exportCSV($this->_misMatchFilemName, $headers, $this->_unMatch); | |
318 | } | |
319 | if ($this->_unparsedAddressCount) { | |
be2fb01f | 320 | $headers = array_merge([ |
69078420 SL |
321 | ts('Line Number'), |
322 | ts('Contact Edit URL'), | |
323 | ], $customHeaders); | |
6a488035 TO |
324 | $this->_errorFileName = self::errorFileName(self::UNPARSED_ADDRESS_WARNING); |
325 | self::exportCSV($this->_errorFileName, $headers, $this->_unparsedAddresses); | |
326 | } | |
327 | } | |
328 | //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; | |
329 | return $this->fini(); | |
330 | } | |
331 | ||
6a488035 | 332 | /** |
fe482240 | 333 | * Given a list of the importable field keys that the user has selected. |
6a488035 TO |
334 | * set the active fields array to this list |
335 | * | |
ae5ffbb7 TO |
336 | * @param array $fieldKeys |
337 | * Mapped array of values. | |
6a488035 | 338 | */ |
00be9182 | 339 | public function setActiveFields($fieldKeys) { |
6a488035 TO |
340 | $this->_activeFieldCount = count($fieldKeys); |
341 | foreach ($fieldKeys as $key) { | |
342 | if (empty($this->_fields[$key])) { | |
719a6fec | 343 | $this->_activeFields[] = new CRM_Contact_Import_Field('', ts('- do not import -')); |
6a488035 TO |
344 | } |
345 | else { | |
346 | $this->_activeFields[] = clone($this->_fields[$key]); | |
347 | } | |
348 | } | |
349 | } | |
350 | ||
86538308 EM |
351 | /** |
352 | * @param $elements | |
353 | */ | |
00be9182 | 354 | public function setActiveFieldLocationTypes($elements) { |
6a488035 TO |
355 | for ($i = 0; $i < count($elements); $i++) { |
356 | $this->_activeFields[$i]->_hasLocationType = $elements[$i]; | |
357 | } | |
358 | } | |
359 | ||
86538308 EM |
360 | /** |
361 | * @param $elements | |
362 | */ | |
69078420 | 363 | |
86538308 EM |
364 | /** |
365 | * @param $elements | |
366 | */ | |
00be9182 | 367 | public function setActiveFieldPhoneTypes($elements) { |
6a488035 TO |
368 | for ($i = 0; $i < count($elements); $i++) { |
369 | $this->_activeFields[$i]->_phoneType = $elements[$i]; | |
370 | } | |
371 | } | |
372 | ||
86538308 EM |
373 | /** |
374 | * @param $elements | |
375 | */ | |
00be9182 | 376 | public function setActiveFieldWebsiteTypes($elements) { |
6a488035 TO |
377 | for ($i = 0; $i < count($elements); $i++) { |
378 | $this->_activeFields[$i]->_websiteType = $elements[$i]; | |
379 | } | |
380 | } | |
381 | ||
382 | /** | |
fe482240 | 383 | * Set IM Service Provider type fields. |
6a488035 | 384 | * |
77c5b619 TO |
385 | * @param array $elements |
386 | * IM service provider type ids. | |
6a488035 | 387 | */ |
00be9182 | 388 | public function setActiveFieldImProviders($elements) { |
6a488035 TO |
389 | for ($i = 0; $i < count($elements); $i++) { |
390 | $this->_activeFields[$i]->_imProvider = $elements[$i]; | |
391 | } | |
392 | } | |
393 | ||
86538308 EM |
394 | /** |
395 | * @param $elements | |
396 | */ | |
00be9182 | 397 | public function setActiveFieldRelated($elements) { |
6a488035 TO |
398 | for ($i = 0; $i < count($elements); $i++) { |
399 | $this->_activeFields[$i]->_related = $elements[$i]; | |
400 | } | |
401 | } | |
402 | ||
86538308 EM |
403 | /** |
404 | * @param $elements | |
405 | */ | |
00be9182 | 406 | public function setActiveFieldRelatedContactType($elements) { |
6a488035 TO |
407 | for ($i = 0; $i < count($elements); $i++) { |
408 | $this->_activeFields[$i]->_relatedContactType = $elements[$i]; | |
409 | } | |
410 | } | |
411 | ||
86538308 EM |
412 | /** |
413 | * @param $elements | |
414 | */ | |
00be9182 | 415 | public function setActiveFieldRelatedContactDetails($elements) { |
6a488035 TO |
416 | for ($i = 0; $i < count($elements); $i++) { |
417 | $this->_activeFields[$i]->_relatedContactDetails = $elements[$i]; | |
418 | } | |
419 | } | |
420 | ||
86538308 EM |
421 | /** |
422 | * @param $elements | |
423 | */ | |
00be9182 | 424 | public function setActiveFieldRelatedContactLocType($elements) { |
6a488035 TO |
425 | for ($i = 0; $i < count($elements); $i++) { |
426 | $this->_activeFields[$i]->_relatedContactLocType = $elements[$i]; | |
427 | } | |
428 | } | |
429 | ||
86538308 | 430 | /** |
4815ab3d | 431 | * Set active field for related contact's phone type. |
432 | * | |
433 | * @param array $elements | |
86538308 | 434 | */ |
00be9182 | 435 | public function setActiveFieldRelatedContactPhoneType($elements) { |
6a488035 TO |
436 | for ($i = 0; $i < count($elements); $i++) { |
437 | $this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i]; | |
438 | } | |
439 | } | |
440 | ||
86538308 EM |
441 | /** |
442 | * @param $elements | |
443 | */ | |
00be9182 | 444 | public function setActiveFieldRelatedContactWebsiteType($elements) { |
6a488035 TO |
445 | for ($i = 0; $i < count($elements); $i++) { |
446 | $this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i]; | |
447 | } | |
448 | } | |
449 | ||
450 | /** | |
fe482240 | 451 | * Set IM Service Provider type fields for related contacts. |
6a488035 | 452 | * |
77c5b619 TO |
453 | * @param array $elements |
454 | * IM service provider type ids of related contact. | |
6a488035 | 455 | */ |
00be9182 | 456 | public function setActiveFieldRelatedContactImProvider($elements) { |
6a488035 TO |
457 | for ($i = 0; $i < count($elements); $i++) { |
458 | $this->_activeFields[$i]->_relatedContactImProvider = $elements[$i]; | |
459 | } | |
460 | } | |
461 | ||
462 | /** | |
fe482240 | 463 | * Format the field values for input to the api. |
6a488035 | 464 | * |
a6c01b45 CW |
465 | * @return array |
466 | * (reference ) associative array of name/value pairs | |
6a488035 | 467 | */ |
00be9182 | 468 | public function &getActiveFieldParams() { |
be2fb01f | 469 | $params = []; |
6a488035 | 470 | |
6a488035 TO |
471 | for ($i = 0; $i < $this->_activeFieldCount; $i++) { |
472 | if ($this->_activeFields[$i]->_name == 'do_not_import') { | |
473 | continue; | |
474 | } | |
475 | ||
476 | if (isset($this->_activeFields[$i]->_value)) { | |
477 | if (isset($this->_activeFields[$i]->_hasLocationType)) { | |
478 | if (!isset($params[$this->_activeFields[$i]->_name])) { | |
be2fb01f | 479 | $params[$this->_activeFields[$i]->_name] = []; |
6a488035 TO |
480 | } |
481 | ||
be2fb01f | 482 | $value = [ |
ae5ffbb7 TO |
483 | $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value, |
484 | 'location_type_id' => $this->_activeFields[$i]->_hasLocationType, | |
be2fb01f | 485 | ]; |
6a488035 TO |
486 | |
487 | if (isset($this->_activeFields[$i]->_phoneType)) { | |
488 | $value['phone_type_id'] = $this->_activeFields[$i]->_phoneType; | |
489 | } | |
490 | ||
491 | // get IM service Provider type id | |
492 | if (isset($this->_activeFields[$i]->_imProvider)) { | |
493 | $value['provider_id'] = $this->_activeFields[$i]->_imProvider; | |
494 | } | |
495 | ||
496 | $params[$this->_activeFields[$i]->_name][] = $value; | |
497 | } | |
498 | elseif (isset($this->_activeFields[$i]->_websiteType)) { | |
be2fb01f | 499 | $value = [ |
6a488035 TO |
500 | $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value, |
501 | 'website_type_id' => $this->_activeFields[$i]->_websiteType, | |
be2fb01f | 502 | ]; |
6a488035 TO |
503 | |
504 | $params[$this->_activeFields[$i]->_name][] = $value; | |
505 | } | |
506 | ||
507 | if (!isset($params[$this->_activeFields[$i]->_name])) { | |
508 | if (!isset($this->_activeFields[$i]->_related)) { | |
509 | $params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value; | |
510 | } | |
511 | } | |
512 | ||
513 | //minor fix for CRM-4062 | |
514 | if (isset($this->_activeFields[$i]->_related)) { | |
515 | if (!isset($params[$this->_activeFields[$i]->_related])) { | |
be2fb01f | 516 | $params[$this->_activeFields[$i]->_related] = []; |
6a488035 TO |
517 | } |
518 | ||
519 | if (!isset($params[$this->_activeFields[$i]->_related]['contact_type']) && !empty($this->_activeFields[$i]->_relatedContactType)) { | |
520 | $params[$this->_activeFields[$i]->_related]['contact_type'] = $this->_activeFields[$i]->_relatedContactType; | |
521 | } | |
522 | ||
523 | if (isset($this->_activeFields[$i]->_relatedContactLocType) && !empty($this->_activeFields[$i]->_value)) { | |
7c7c2ddb | 524 | if (!empty($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails]) && |
353ffa53 TO |
525 | !is_array($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails]) |
526 | ) { | |
be2fb01f | 527 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = []; |
6a488035 | 528 | } |
be2fb01f | 529 | $value = [ |
6a488035 TO |
530 | $this->_activeFields[$i]->_relatedContactDetails => $this->_activeFields[$i]->_value, |
531 | 'location_type_id' => $this->_activeFields[$i]->_relatedContactLocType, | |
be2fb01f | 532 | ]; |
6a488035 TO |
533 | |
534 | if (isset($this->_activeFields[$i]->_relatedContactPhoneType)) { | |
535 | $value['phone_type_id'] = $this->_activeFields[$i]->_relatedContactPhoneType; | |
536 | } | |
537 | ||
538 | // get IM service Provider type id for related contact | |
539 | if (isset($this->_activeFields[$i]->_relatedContactImProvider)) { | |
540 | $value['provider_id'] = $this->_activeFields[$i]->_relatedContactImProvider; | |
541 | } | |
542 | ||
543 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = $value; | |
544 | } | |
545 | elseif (isset($this->_activeFields[$i]->_relatedContactWebsiteType)) { | |
be2fb01f | 546 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = [ |
6a488035 TO |
547 | 'url' => $this->_activeFields[$i]->_value, |
548 | 'website_type_id' => $this->_activeFields[$i]->_relatedContactWebsiteType, | |
be2fb01f | 549 | ]; |
6a488035 | 550 | } |
2c45c10a JP |
551 | elseif (empty($this->_activeFields[$i]->_value) && isset($this->_activeFields[$i]->_relatedContactLocType)) { |
552 | if (empty($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails])) { | |
553 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = []; | |
554 | } | |
555 | } | |
6a488035 TO |
556 | else { |
557 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = $this->_activeFields[$i]->_value; | |
558 | } | |
559 | } | |
560 | } | |
561 | } | |
562 | ||
563 | return $params; | |
564 | } | |
565 | ||
86538308 | 566 | /** |
100fef9d | 567 | * @param string $name |
86538308 EM |
568 | * @param $title |
569 | * @param int $type | |
570 | * @param string $headerPattern | |
571 | * @param string $dataPattern | |
572 | * @param bool $hasLocationType | |
573 | */ | |
ae5ffbb7 | 574 | public function addField( |
51ccfbbe | 575 | $name, $title, $type = CRM_Utils_Type::T_INT, |
6a488035 TO |
576 | $headerPattern = '//', $dataPattern = '//', |
577 | $hasLocationType = FALSE | |
578 | ) { | |
719a6fec | 579 | $this->_fields[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType); |
6a488035 | 580 | if (empty($name)) { |
719a6fec | 581 | $this->_fields['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType); |
6a488035 TO |
582 | } |
583 | } | |
584 | ||
6a488035 | 585 | /** |
fe482240 | 586 | * Store parser values. |
6a488035 TO |
587 | * |
588 | * @param CRM_Core_Session $store | |
589 | * | |
2a6da8d7 | 590 | * @param int $mode |
6a488035 | 591 | */ |
00be9182 | 592 | public function set($store, $mode = self::MODE_SUMMARY) { |
6a488035 TO |
593 | $store->set('rowCount', $this->_rowCount); |
594 | $store->set('fields', $this->getSelectValues()); | |
595 | $store->set('fieldTypes', $this->getSelectTypes()); | |
596 | ||
6a488035 TO |
597 | $store->set('columnCount', $this->_activeFieldCount); |
598 | ||
599 | $store->set('totalRowCount', $this->_totalCount); | |
600 | $store->set('validRowCount', $this->_validCount); | |
601 | $store->set('invalidRowCount', $this->_invalidRowCount); | |
602 | $store->set('conflictRowCount', $this->_conflictCount); | |
603 | $store->set('unMatchCount', $this->_unMatchCount); | |
604 | ||
605 | switch ($this->_contactType) { | |
606 | case 'Individual': | |
a05662ef | 607 | $store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL); |
6a488035 TO |
608 | break; |
609 | ||
610 | case 'Household': | |
a05662ef | 611 | $store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD); |
6a488035 TO |
612 | break; |
613 | ||
614 | case 'Organization': | |
a05662ef | 615 | $store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION); |
6a488035 TO |
616 | } |
617 | ||
618 | if ($this->_invalidRowCount) { | |
619 | $store->set('errorsFileName', $this->_errorFileName); | |
620 | } | |
621 | if ($this->_conflictCount) { | |
622 | $store->set('conflictsFileName', $this->_conflictFileName); | |
623 | } | |
624 | if (isset($this->_rows) && !empty($this->_rows)) { | |
625 | $store->set('dataValues', $this->_rows); | |
626 | } | |
627 | ||
628 | if ($this->_unMatchCount) { | |
629 | $store->set('mismatchFileName', $this->_misMatchFilemName); | |
630 | } | |
631 | ||
632 | if ($mode == self::MODE_IMPORT) { | |
633 | $store->set('duplicateRowCount', $this->_duplicateCount); | |
634 | $store->set('unparsedAddressCount', $this->_unparsedAddressCount); | |
635 | if ($this->_duplicateCount) { | |
636 | $store->set('duplicatesFileName', $this->_duplicateFileName); | |
637 | } | |
638 | if ($this->_unparsedAddressCount) { | |
639 | $store->set('errorsFileName', $this->_errorFileName); | |
640 | } | |
641 | } | |
642 | //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; | |
643 | } | |
644 | ||
645 | /** | |
fe482240 | 646 | * Export data to a CSV file. |
6a488035 | 647 | * |
100fef9d | 648 | * @param string $fileName |
6a488035 | 649 | * @param array $header |
c490a46a | 650 | * @param array $data |
4815ab3d | 651 | */ |
00be9182 | 652 | public static function exportCSV($fileName, $header, $data) { |
6a488035 TO |
653 | |
654 | if (file_exists($fileName) && !is_writable($fileName)) { | |
655 | CRM_Core_Error::movedSiteError($fileName); | |
656 | } | |
657 | //hack to remove '_status', '_statusMsg' and '_id' from error file | |
be2fb01f CW |
658 | $errorValues = []; |
659 | $dbRecordStatus = ['IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW']; | |
6a488035 TO |
660 | foreach ($data as $rowCount => $rowValues) { |
661 | $count = 0; | |
662 | foreach ($rowValues as $key => $val) { | |
663 | if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) { | |
664 | break; | |
665 | } | |
666 | $errorValues[$rowCount][$key] = $val; | |
667 | $count++; | |
668 | } | |
669 | } | |
670 | $data = $errorValues; | |
671 | ||
be2fb01f | 672 | $output = []; |
6a488035 TO |
673 | $fd = fopen($fileName, 'w'); |
674 | ||
675 | foreach ($header as $key => $value) { | |
676 | $header[$key] = "\"$value\""; | |
677 | } | |
678 | $config = CRM_Core_Config::singleton(); | |
679 | $output[] = implode($config->fieldSeparator, $header); | |
680 | ||
681 | foreach ($data as $datum) { | |
682 | foreach ($datum as $key => $value) { | |
683 | $datum[$key] = "\"$value\""; | |
684 | } | |
685 | $output[] = implode($config->fieldSeparator, $datum); | |
686 | } | |
687 | fwrite($fd, implode("\n", $output)); | |
688 | fclose($fd); | |
689 | } | |
690 | ||
691 | /** | |
4815ab3d | 692 | * Update the record with PK $id in the import database table. |
6a488035 | 693 | * |
ca275c67 | 694 | * @deprecated - call setImportStatus directly as the parameters are simpler, |
695 | * | |
6a488035 TO |
696 | * @param int $id |
697 | * @param array $params | |
6a488035 | 698 | */ |
ca275c67 | 699 | public function updateImportRecord($id, $params): void { |
700 | $this->setImportStatus((int) $id, $params[$this->_statusFieldName] ?? '', $params["{$this->_statusFieldName}Msg"] ?? ''); | |
701 | } | |
702 | ||
703 | /** | |
704 | * Set the import status for the given record. | |
705 | * | |
706 | * If this is a sql import then the sql table will be used and the update | |
707 | * will not happen as the relevant fields don't exist in the table - hence | |
708 | * the checks that statusField & primary key are set. | |
709 | * | |
710 | * @param int $id | |
711 | * @param string $status | |
712 | * @param string $message | |
713 | */ | |
714 | public function setImportStatus(int $id, string $status, string $message): void { | |
715 | if ($this->_statusFieldName && $this->_primaryKeyName) { | |
716 | CRM_Core_DAO::executeQuery(" | |
717 | UPDATE $this->_tableName | |
718 | SET $this->_statusFieldName = %1, | |
719 | {$this->_statusFieldName}Msg = %2 | |
720 | WHERE $this->_primaryKeyName = %3 | |
721 | ", [ | |
722 | 1 => [$status, 'String'], | |
723 | 2 => [$message, 'String'], | |
724 | 3 => [$id, 'Integer'], | |
725 | ]); | |
6a488035 TO |
726 | } |
727 | } | |
728 | ||
5dc4d424 | 729 | /** |
730 | * Format common params data to proper format to store. | |
731 | * | |
732 | * @param array $params | |
733 | * Contain record values. | |
734 | * @param array $formatted | |
735 | * Array of formatted data. | |
736 | * @param array $contactFields | |
737 | * Contact DAO fields. | |
738 | */ | |
739 | public function formatCommonData($params, &$formatted, &$contactFields) { | |
be2fb01f | 740 | $csType = [ |
5dc4d424 | 741 | CRM_Utils_Array::value('contact_type', $formatted), |
be2fb01f | 742 | ]; |
5dc4d424 | 743 | |
744 | //CRM-5125 | |
745 | //add custom fields for contact sub type | |
746 | if (!empty($this->_contactSubType)) { | |
747 | $csType = $this->_contactSubType; | |
748 | } | |
749 | ||
750 | if ($relCsType = CRM_Utils_Array::value('contact_sub_type', $formatted)) { | |
751 | $csType = $relCsType; | |
752 | } | |
753 | ||
754 | $customFields = CRM_Core_BAO_CustomField::getFields($formatted['contact_type'], FALSE, FALSE, $csType); | |
755 | ||
756 | $addressCustomFields = CRM_Core_BAO_CustomField::getFields('Address'); | |
757 | $customFields = $customFields + $addressCustomFields; | |
758 | ||
759 | //if a Custom Email Greeting, Custom Postal Greeting or Custom Addressee is mapped, and no "Greeting / Addressee Type ID" is provided, then automatically set the type = Customized, CRM-4575 | |
be2fb01f | 760 | $elements = [ |
5dc4d424 | 761 | 'email_greeting_custom' => 'email_greeting', |
762 | 'postal_greeting_custom' => 'postal_greeting', | |
763 | 'addressee_custom' => 'addressee', | |
be2fb01f | 764 | ]; |
5dc4d424 | 765 | foreach ($elements as $k => $v) { |
766 | if (array_key_exists($k, $params) && !(array_key_exists($v, $params))) { | |
767 | $label = key(CRM_Core_OptionGroup::values($v, TRUE, NULL, NULL, 'AND v.name = "Customized"')); | |
768 | $params[$v] = $label; | |
769 | } | |
770 | } | |
771 | ||
772 | //format date first | |
773 | $session = CRM_Core_Session::singleton(); | |
774 | $dateType = $session->get("dateTypes"); | |
775 | foreach ($params as $key => $val) { | |
776 | $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key); | |
777 | if ($customFieldID && | |
778 | !array_key_exists($customFieldID, $addressCustomFields) | |
779 | ) { | |
780 | //we should not update Date to null, CRM-4062 | |
781 | if ($val && ($customFields[$customFieldID]['data_type'] == 'Date')) { | |
22161818 | 782 | //CRM-21267 |
160a5de1 | 783 | CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $formatted, $dateType, $key); |
5dc4d424 | 784 | } |
785 | elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') { | |
786 | if (empty($val) && !is_numeric($val) && $this->_onDuplicate == CRM_Import_Parser::DUPLICATE_FILL) { | |
787 | //retain earlier value when Import mode is `Fill` | |
788 | unset($params[$key]); | |
789 | } | |
790 | else { | |
791 | $params[$key] = CRM_Utils_String::strtoboolstr($val); | |
792 | } | |
793 | } | |
794 | } | |
795 | ||
796 | if ($key == 'birth_date' && $val) { | |
797 | CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key); | |
798 | } | |
799 | elseif ($key == 'deceased_date' && $val) { | |
800 | CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key); | |
801 | $params['is_deceased'] = 1; | |
802 | } | |
803 | elseif ($key == 'is_deceased' && $val) { | |
804 | $params[$key] = CRM_Utils_String::strtoboolstr($val); | |
805 | } | |
5dc4d424 | 806 | } |
807 | ||
808 | //now format custom data. | |
809 | foreach ($params as $key => $field) { | |
810 | if (is_array($field)) { | |
811 | $isAddressCustomField = FALSE; | |
812 | foreach ($field as $value) { | |
813 | $break = FALSE; | |
814 | if (is_array($value)) { | |
815 | foreach ($value as $name => $testForEmpty) { | |
816 | if ($addressCustomFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) { | |
817 | $isAddressCustomField = TRUE; | |
818 | break; | |
819 | } | |
820 | // check if $value does not contain IM provider or phoneType | |
821 | if (($name !== 'phone_type_id' || $name !== 'provider_id') && ($testForEmpty === '' || $testForEmpty == NULL)) { | |
822 | $break = TRUE; | |
823 | break; | |
824 | } | |
825 | } | |
826 | } | |
827 | else { | |
828 | $break = TRUE; | |
829 | } | |
830 | ||
831 | if (!$break) { | |
9afab633 | 832 | if (!empty($value['location_type_id'])) { |
833 | $this->formatLocationBlock($value, $formatted); | |
834 | } | |
835 | else { | |
732e5edd | 836 | // @todo - this is still reachable - e.g. import with related contact info like firstname,lastname,spouse-first-name,spouse-last-name,spouse-home-phone |
9afab633 | 837 | CRM_Core_Error::deprecatedFunctionWarning('this is not expected to be reachable now'); |
838 | $this->formatContactParameters($value, $formatted); | |
839 | } | |
5dc4d424 | 840 | } |
841 | } | |
842 | if (!$isAddressCustomField) { | |
843 | continue; | |
844 | } | |
845 | } | |
846 | ||
be2fb01f | 847 | $formatValues = [ |
5dc4d424 | 848 | $key => $field, |
be2fb01f | 849 | ]; |
5dc4d424 | 850 | |
851 | if (($key !== 'preferred_communication_method') && (array_key_exists($key, $contactFields))) { | |
852 | // due to merging of individual table and | |
853 | // contact table, we need to avoid | |
854 | // preferred_communication_method forcefully | |
855 | $formatValues['contact_type'] = $formatted['contact_type']; | |
856 | } | |
857 | ||
858 | if ($key == 'id' && isset($field)) { | |
859 | $formatted[$key] = $field; | |
860 | } | |
861 | $this->formatContactParameters($formatValues, $formatted); | |
862 | ||
863 | //Handling Custom Data | |
864 | // note: Address custom fields will be handled separately inside formatContactParameters | |
865 | if (($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) && | |
866 | array_key_exists($customFieldID, $customFields) && | |
867 | !array_key_exists($customFieldID, $addressCustomFields) | |
868 | ) { | |
869 | ||
9c1bc317 CW |
870 | $extends = $customFields[$customFieldID]['extends'] ?? NULL; |
871 | $htmlType = $customFields[$customFieldID]['html_type'] ?? NULL; | |
ba33addf CW |
872 | $dataType = $customFields[$customFieldID]['data_type'] ?? NULL; |
873 | $serialized = CRM_Core_BAO_CustomField::isSerialized($customFields[$customFieldID]); | |
874 | ||
875 | if (!$serialized && in_array($htmlType, ['Select', 'Radio', 'Autocomplete-Select']) && in_array($dataType, ['String', 'Int'])) { | |
876 | $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE); | |
877 | foreach ($customOption as $customValue) { | |
878 | $val = $customValue['value'] ?? NULL; | |
879 | $label = strtolower($customValue['label'] ?? ''); | |
880 | $value = strtolower(trim($formatted[$key])); | |
881 | if (($value == $label) || ($value == strtolower($val))) { | |
882 | $params[$key] = $formatted[$key] = $val; | |
5dc4d424 | 883 | } |
ba33addf CW |
884 | } |
885 | } | |
886 | elseif ($serialized && !empty($formatted[$key]) && !empty($params[$key])) { | |
887 | $mulValues = explode(',', $formatted[$key]); | |
888 | $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE); | |
889 | $formatted[$key] = []; | |
890 | $params[$key] = []; | |
891 | foreach ($mulValues as $v1) { | |
892 | foreach ($customOption as $v2) { | |
893 | if ((strtolower($v2['label']) == strtolower(trim($v1))) || | |
894 | (strtolower($v2['value']) == strtolower(trim($v1))) | |
895 | ) { | |
896 | if ($htmlType == 'CheckBox') { | |
897 | $params[$key][$v2['value']] = $formatted[$key][$v2['value']] = 1; | |
898 | } | |
899 | else { | |
900 | $params[$key][] = $formatted[$key][] = $v2['value']; | |
5dc4d424 | 901 | } |
902 | } | |
903 | } | |
ba33addf | 904 | } |
5dc4d424 | 905 | } |
906 | } | |
907 | } | |
908 | ||
909 | if (!empty($key) && ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) && array_key_exists($customFieldID, $customFields) && | |
910 | !array_key_exists($customFieldID, $addressCustomFields) | |
911 | ) { | |
912 | // @todo calling api functions directly is not supported | |
913 | _civicrm_api3_custom_format_params($params, $formatted, $extends); | |
914 | } | |
915 | ||
916 | // to check if not update mode and unset the fields with empty value. | |
917 | if (!$this->_updateWithId && array_key_exists('custom', $formatted)) { | |
918 | foreach ($formatted['custom'] as $customKey => $customvalue) { | |
919 | if (empty($formatted['custom'][$customKey][-1]['is_required'])) { | |
920 | $formatted['custom'][$customKey][-1]['is_required'] = $customFields[$customKey]['is_required']; | |
921 | } | |
9c1bc317 | 922 | $emptyValue = $customvalue[-1]['value'] ?? NULL; |
5dc4d424 | 923 | if (!isset($emptyValue)) { |
924 | unset($formatted['custom'][$customKey]); | |
925 | } | |
926 | } | |
927 | } | |
928 | ||
929 | // parse street address, CRM-5450 | |
930 | if ($this->_parseStreetAddress) { | |
931 | if (array_key_exists('address', $formatted) && is_array($formatted['address'])) { | |
932 | foreach ($formatted['address'] as $instance => & $address) { | |
9c1bc317 | 933 | $streetAddress = $address['street_address'] ?? NULL; |
5dc4d424 | 934 | if (empty($streetAddress)) { |
935 | continue; | |
936 | } | |
937 | // parse address field. | |
938 | $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($streetAddress); | |
939 | ||
940 | //street address consider to be parsed properly, | |
941 | //If we get street_name and street_number. | |
942 | if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) { | |
943 | $parsedFields = array_fill_keys(array_keys($parsedFields), ''); | |
944 | } | |
945 | ||
946 | // merge parse address w/ main address block. | |
947 | $address = array_merge($address, $parsedFields); | |
948 | } | |
949 | } | |
950 | } | |
951 | } | |
952 | ||
953 | /** | |
954 | * Format contact parameters. | |
955 | * | |
956 | * @todo this function needs re-writing & re-merging into the main function. | |
957 | * | |
958 | * Here be dragons. | |
959 | * | |
960 | * @param array $values | |
961 | * @param array $params | |
962 | * | |
963 | * @return bool | |
964 | */ | |
965 | protected function formatContactParameters(&$values, &$params) { | |
966 | // Crawl through the possible classes: | |
967 | // Contact | |
968 | // Individual | |
969 | // Household | |
970 | // Organization | |
971 | // Location | |
972 | // Address | |
973 | ||
974 | // Phone | |
975 | // IM | |
976 | // Note | |
977 | // Custom | |
978 | ||
5dc4d424 | 979 | // first add core contact values since for other Civi modules they are not added |
980 | $contactFields = CRM_Contact_DAO_Contact::fields(); | |
981 | _civicrm_api3_store_values($contactFields, $values, $params); | |
982 | ||
983 | if (isset($values['contact_type'])) { | |
984 | // we're an individual/household/org property | |
985 | ||
986 | $fields[$values['contact_type']] = CRM_Contact_DAO_Contact::fields(); | |
987 | ||
988 | _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params); | |
989 | return TRUE; | |
990 | } | |
991 | ||
a0c6165f | 992 | // Cache the various object fields |
993 | // @todo - remove this after confirming this is just a compilation of other-wise-cached fields. | |
994 | static $fields = []; | |
995 | ||
5dc4d424 | 996 | if (isset($values['individual_prefix'])) { |
997 | if (!empty($params['prefix_id'])) { | |
998 | $prefixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id'); | |
999 | $params['prefix'] = $prefixes[$params['prefix_id']]; | |
1000 | } | |
1001 | else { | |
1002 | $params['prefix'] = $values['individual_prefix']; | |
1003 | } | |
1004 | return TRUE; | |
1005 | } | |
1006 | ||
1007 | if (isset($values['individual_suffix'])) { | |
1008 | if (!empty($params['suffix_id'])) { | |
1009 | $suffixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id'); | |
1010 | $params['suffix'] = $suffixes[$params['suffix_id']]; | |
1011 | } | |
1012 | else { | |
1013 | $params['suffix'] = $values['individual_suffix']; | |
1014 | } | |
1015 | return TRUE; | |
1016 | } | |
1017 | ||
1018 | // CRM-4575 | |
1019 | if (isset($values['email_greeting'])) { | |
1020 | if (!empty($params['email_greeting_id'])) { | |
be2fb01f | 1021 | $emailGreetingFilter = [ |
6b409353 | 1022 | 'contact_type' => $params['contact_type'] ?? NULL, |
5dc4d424 | 1023 | 'greeting_type' => 'email_greeting', |
be2fb01f | 1024 | ]; |
5dc4d424 | 1025 | $emailGreetings = CRM_Core_PseudoConstant::greeting($emailGreetingFilter); |
1026 | $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']]; | |
1027 | } | |
1028 | else { | |
1029 | $params['email_greeting'] = $values['email_greeting']; | |
1030 | } | |
1031 | ||
1032 | return TRUE; | |
1033 | } | |
1034 | ||
1035 | if (isset($values['postal_greeting'])) { | |
1036 | if (!empty($params['postal_greeting_id'])) { | |
be2fb01f | 1037 | $postalGreetingFilter = [ |
6b409353 | 1038 | 'contact_type' => $params['contact_type'] ?? NULL, |
5dc4d424 | 1039 | 'greeting_type' => 'postal_greeting', |
be2fb01f | 1040 | ]; |
5dc4d424 | 1041 | $postalGreetings = CRM_Core_PseudoConstant::greeting($postalGreetingFilter); |
1042 | $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']]; | |
1043 | } | |
1044 | else { | |
1045 | $params['postal_greeting'] = $values['postal_greeting']; | |
1046 | } | |
1047 | return TRUE; | |
1048 | } | |
1049 | ||
1050 | if (isset($values['addressee'])) { | |
3ad34747 | 1051 | $params['addressee'] = $values['addressee']; |
5dc4d424 | 1052 | return TRUE; |
1053 | } | |
1054 | ||
1055 | if (isset($values['gender'])) { | |
1056 | if (!empty($params['gender_id'])) { | |
1057 | $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'); | |
1058 | $params['gender'] = $genders[$params['gender_id']]; | |
1059 | } | |
1060 | else { | |
1061 | $params['gender'] = $values['gender']; | |
1062 | } | |
1063 | return TRUE; | |
1064 | } | |
1065 | ||
1066 | if (!empty($values['preferred_communication_method'])) { | |
be2fb01f | 1067 | $comm = []; |
5dc4d424 | 1068 | $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER); |
1069 | ||
1070 | $preffComm = explode(',', $values['preferred_communication_method']); | |
1071 | foreach ($preffComm as $v) { | |
1072 | $v = strtolower(trim($v)); | |
1073 | if (array_key_exists($v, $pcm)) { | |
1074 | $comm[$pcm[$v]] = 1; | |
1075 | } | |
1076 | } | |
1077 | ||
1078 | $params['preferred_communication_method'] = $comm; | |
1079 | return TRUE; | |
1080 | } | |
1081 | ||
1082 | // format the website params. | |
1083 | if (!empty($values['url'])) { | |
1084 | static $websiteFields; | |
1085 | if (!is_array($websiteFields)) { | |
1086 | $websiteFields = CRM_Core_DAO_Website::fields(); | |
1087 | } | |
1088 | if (!array_key_exists('website', $params) || | |
1089 | !is_array($params['website']) | |
1090 | ) { | |
be2fb01f | 1091 | $params['website'] = []; |
5dc4d424 | 1092 | } |
1093 | ||
1094 | $websiteCount = count($params['website']); | |
1095 | _civicrm_api3_store_values($websiteFields, $values, | |
1096 | $params['website'][++$websiteCount] | |
1097 | ); | |
1098 | ||
1099 | return TRUE; | |
1100 | } | |
1101 | ||
5dc4d424 | 1102 | if (isset($values['note'])) { |
1103 | // add a note field | |
1104 | if (!isset($params['note'])) { | |
be2fb01f | 1105 | $params['note'] = []; |
5dc4d424 | 1106 | } |
1107 | $noteBlock = count($params['note']) + 1; | |
1108 | ||
be2fb01f | 1109 | $params['note'][$noteBlock] = []; |
5dc4d424 | 1110 | if (!isset($fields['Note'])) { |
1111 | $fields['Note'] = CRM_Core_DAO_Note::fields(); | |
1112 | } | |
1113 | ||
1114 | // get the current logged in civicrm user | |
1115 | $session = CRM_Core_Session::singleton(); | |
1116 | $userID = $session->get('userID'); | |
1117 | ||
1118 | if ($userID) { | |
1119 | $values['contact_id'] = $userID; | |
1120 | } | |
1121 | ||
1122 | _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]); | |
1123 | ||
1124 | return TRUE; | |
1125 | } | |
1126 | ||
1127 | // Check for custom field values | |
a0c6165f | 1128 | $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $values), |
1129 | FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE | |
1130 | ); | |
5dc4d424 | 1131 | |
1132 | foreach ($values as $key => $value) { | |
1133 | if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) { | |
1134 | // check if it's a valid custom field id | |
1135 | ||
a0c6165f | 1136 | if (!array_key_exists($customFieldID, $customFields)) { |
5dc4d424 | 1137 | return civicrm_api3_create_error('Invalid custom field ID'); |
1138 | } | |
1139 | else { | |
1140 | $params[$key] = $value; | |
1141 | } | |
1142 | } | |
1143 | } | |
1144 | return TRUE; | |
1145 | } | |
1146 | ||
c4c7a315 | 1147 | /** |
1148 | * Format location block ready for importing. | |
1149 | * | |
1150 | * There is some test coverage for this in CRM_Contact_Import_Parser_ContactTest | |
1151 | * e.g. testImportPrimaryAddress. | |
1152 | * | |
1153 | * @param array $values | |
1154 | * @param array $params | |
c4c7a315 | 1155 | * |
1156 | * @return bool | |
1157 | */ | |
0b3f2e42 | 1158 | protected function formatLocationBlock(&$values, &$params) { |
c4c7a315 | 1159 | $blockTypes = [ |
1160 | 'phone' => 'Phone', | |
1161 | 'email' => 'Email', | |
1162 | 'im' => 'IM', | |
1163 | 'openid' => 'OpenID', | |
1164 | 'phone_ext' => 'Phone', | |
1165 | ]; | |
1166 | foreach ($blockTypes as $blockFieldName => $block) { | |
1167 | if (!array_key_exists($blockFieldName, $values)) { | |
1168 | continue; | |
1169 | } | |
a7b9cf38 | 1170 | $blockIndex = $values['location_type_id'] . (!empty($values['phone_type_id']) ? '_' . $values['phone_type_id'] : ''); |
c4c7a315 | 1171 | |
1172 | // block present in value array. | |
1173 | if (!array_key_exists($blockFieldName, $params) || !is_array($params[$blockFieldName])) { | |
1174 | $params[$blockFieldName] = []; | |
1175 | } | |
1176 | ||
0b3f2e42 | 1177 | $fields[$block] = $this->getMetadataForEntity($block); |
c4c7a315 | 1178 | |
c4c7a315 | 1179 | // copy value to dao field name. |
1180 | if ($blockFieldName == 'im') { | |
1181 | $values['name'] = $values[$blockFieldName]; | |
1182 | } | |
1183 | ||
1184 | _civicrm_api3_store_values($fields[$block], $values, | |
a7b9cf38 | 1185 | $params[$blockFieldName][$blockIndex] |
c4c7a315 | 1186 | ); |
1187 | ||
a7b9cf38 | 1188 | $this->fillPrimary($params[$blockFieldName][$blockIndex], $values, $block, CRM_Utils_Array::value('id', $params)); |
c4c7a315 | 1189 | |
2ab10f80 | 1190 | if (empty($params['id']) && (count($params[$blockFieldName]) == 1)) { |
a7b9cf38 | 1191 | $params[$blockFieldName][$blockIndex]['is_primary'] = TRUE; |
c4c7a315 | 1192 | } |
1193 | ||
1194 | // we only process single block at a time. | |
1195 | return TRUE; | |
1196 | } | |
1197 | ||
1198 | // handle address fields. | |
1199 | if (!array_key_exists('address', $params) || !is_array($params['address'])) { | |
1200 | $params['address'] = []; | |
1201 | } | |
1202 | ||
c4c7a315 | 1203 | // Note: we doing multiple value formatting here for address custom fields, plus putting into right format. |
1204 | // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving | |
1205 | // the address in CRM_Core_BAO_Address::create method | |
1206 | if (!empty($values['location_type_id'])) { | |
1207 | static $customFields = []; | |
1208 | if (empty($customFields)) { | |
1209 | $customFields = CRM_Core_BAO_CustomField::getFields('Address'); | |
1210 | } | |
1211 | // make a copy of values, as we going to make changes | |
1212 | $newValues = $values; | |
1213 | foreach ($values as $key => $val) { | |
1214 | $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key); | |
1215 | if ($customFieldID && array_key_exists($customFieldID, $customFields)) { | |
c4c7a315 | 1216 | |
9c1bc317 | 1217 | $htmlType = $customFields[$customFieldID]['html_type'] ?? NULL; |
511d0374 CW |
1218 | if (CRM_Core_BAO_CustomField::isSerialized($customFields[$customFieldID]) && $val) { |
1219 | $mulValues = explode(',', $val); | |
1220 | $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE); | |
1221 | $newValues[$key] = []; | |
1222 | foreach ($mulValues as $v1) { | |
1223 | foreach ($customOption as $v2) { | |
1224 | if ((strtolower($v2['label']) == strtolower(trim($v1))) || | |
1225 | (strtolower($v2['value']) == strtolower(trim($v1))) | |
1226 | ) { | |
1227 | if ($htmlType == 'CheckBox') { | |
1228 | $newValues[$key][$v2['value']] = 1; | |
1229 | } | |
1230 | else { | |
1231 | $newValues[$key][] = $v2['value']; | |
c4c7a315 | 1232 | } |
1233 | } | |
1234 | } | |
511d0374 | 1235 | } |
c4c7a315 | 1236 | } |
1237 | } | |
1238 | } | |
1239 | // consider new values | |
1240 | $values = $newValues; | |
1241 | } | |
1242 | ||
0b3f2e42 | 1243 | $fields['Address'] = $this->getMetadataForEntity('Address'); |
1244 | // @todo this is kinda replicated below.... | |
c4c7a315 | 1245 | _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$values['location_type_id']]); |
1246 | ||
1247 | $addressFields = [ | |
1248 | 'county', | |
1249 | 'country', | |
1250 | 'state_province', | |
1251 | 'supplemental_address_1', | |
1252 | 'supplemental_address_2', | |
1253 | 'supplemental_address_3', | |
1254 | 'StateProvince.name', | |
1255 | ]; | |
0b3f2e42 | 1256 | foreach (array_keys($customFields) as $customFieldID) { |
1257 | $addressFields[] = 'custom_' . $customFieldID; | |
1258 | } | |
c4c7a315 | 1259 | |
1260 | foreach ($addressFields as $field) { | |
1261 | if (array_key_exists($field, $values)) { | |
1262 | if (!array_key_exists('address', $params)) { | |
1263 | $params['address'] = []; | |
1264 | } | |
1265 | $params['address'][$values['location_type_id']][$field] = $values[$field]; | |
1266 | } | |
1267 | } | |
1268 | ||
f6953904 | 1269 | $this->fillPrimary($params['address'][$values['location_type_id']], $values, 'address', CRM_Utils_Array::value('id', $params)); |
c4c7a315 | 1270 | return TRUE; |
1271 | } | |
1272 | ||
0b3f2e42 | 1273 | /** |
1274 | * Get the field metadata for the relevant entity. | |
1275 | * | |
1276 | * @param string $entity | |
1277 | * | |
1278 | * @return array | |
1279 | */ | |
1280 | protected function getMetadataForEntity($entity) { | |
1281 | if (!isset($this->fieldMetadata[$entity])) { | |
1282 | $className = "CRM_Core_DAO_$entity"; | |
1283 | $this->fieldMetadata[$entity] = $className::fields(); | |
1284 | } | |
1285 | return $this->fieldMetadata[$entity]; | |
1286 | } | |
1287 | ||
2ab10f80 | 1288 | /** |
1289 | * Fill in the primary location. | |
1290 | * | |
1291 | * If the contact has a primary address we update it. Otherwise | |
1292 | * we add an address of the default location type. | |
1293 | * | |
1294 | * @param array $params | |
1295 | * Address block parameters | |
1296 | * @param array $values | |
1297 | * Input values | |
1298 | * @param string $entity | |
1299 | * - address, email, phone | |
e97c66ff | 1300 | * @param int|null $contactID |
1301 | * | |
1302 | * @throws \CiviCRM_API3_Exception | |
2ab10f80 | 1303 | */ |
1304 | protected function fillPrimary(&$params, $values, $entity, $contactID) { | |
1305 | if ($values['location_type_id'] === 'Primary') { | |
1306 | if ($contactID) { | |
1307 | $primary = civicrm_api3($entity, 'get', [ | |
1308 | 'return' => 'location_type_id', | |
1309 | 'contact_id' => $contactID, | |
1310 | 'is_primary' => 1, | |
9f266042 | 1311 | 'sequential' => 1, |
2ab10f80 | 1312 | ]); |
1313 | } | |
1314 | $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); | |
1315 | $params['location_type_id'] = (int) (isset($primary) && $primary['count']) ? $primary['values'][0]['location_type_id'] : $defaultLocationType->id; | |
1316 | $params['is_primary'] = 1; | |
1317 | } | |
1318 | } | |
1319 | ||
6a488035 | 1320 | } |