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 TO |
550 | } |
551 | else { | |
552 | $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = $this->_activeFields[$i]->_value; | |
553 | } | |
554 | } | |
555 | } | |
556 | } | |
557 | ||
558 | return $params; | |
559 | } | |
560 | ||
86538308 EM |
561 | /** |
562 | * @return array | |
563 | */ | |
00be9182 | 564 | public function getColumnPatterns() { |
0c7dc463 | 565 | CRM_Core_Error::deprecatedFunctionWarning('no longer used- use CRM_Contact_Import_MetadataTrait'); |
be2fb01f | 566 | $values = []; |
6a488035 TO |
567 | foreach ($this->_fields as $name => $field) { |
568 | $values[$name] = $field->_columnPattern; | |
569 | } | |
570 | return $values; | |
571 | } | |
572 | ||
86538308 | 573 | /** |
100fef9d | 574 | * @param string $name |
86538308 EM |
575 | * @param $title |
576 | * @param int $type | |
577 | * @param string $headerPattern | |
578 | * @param string $dataPattern | |
579 | * @param bool $hasLocationType | |
580 | */ | |
ae5ffbb7 | 581 | public function addField( |
51ccfbbe | 582 | $name, $title, $type = CRM_Utils_Type::T_INT, |
6a488035 TO |
583 | $headerPattern = '//', $dataPattern = '//', |
584 | $hasLocationType = FALSE | |
585 | ) { | |
719a6fec | 586 | $this->_fields[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType); |
6a488035 | 587 | if (empty($name)) { |
719a6fec | 588 | $this->_fields['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType); |
6a488035 TO |
589 | } |
590 | } | |
591 | ||
6a488035 | 592 | /** |
fe482240 | 593 | * Store parser values. |
6a488035 TO |
594 | * |
595 | * @param CRM_Core_Session $store | |
596 | * | |
2a6da8d7 | 597 | * @param int $mode |
6a488035 | 598 | */ |
00be9182 | 599 | public function set($store, $mode = self::MODE_SUMMARY) { |
6a488035 TO |
600 | $store->set('rowCount', $this->_rowCount); |
601 | $store->set('fields', $this->getSelectValues()); | |
602 | $store->set('fieldTypes', $this->getSelectTypes()); | |
603 | ||
6a488035 TO |
604 | $store->set('columnCount', $this->_activeFieldCount); |
605 | ||
606 | $store->set('totalRowCount', $this->_totalCount); | |
607 | $store->set('validRowCount', $this->_validCount); | |
608 | $store->set('invalidRowCount', $this->_invalidRowCount); | |
609 | $store->set('conflictRowCount', $this->_conflictCount); | |
610 | $store->set('unMatchCount', $this->_unMatchCount); | |
611 | ||
612 | switch ($this->_contactType) { | |
613 | case 'Individual': | |
a05662ef | 614 | $store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL); |
6a488035 TO |
615 | break; |
616 | ||
617 | case 'Household': | |
a05662ef | 618 | $store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD); |
6a488035 TO |
619 | break; |
620 | ||
621 | case 'Organization': | |
a05662ef | 622 | $store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION); |
6a488035 TO |
623 | } |
624 | ||
625 | if ($this->_invalidRowCount) { | |
626 | $store->set('errorsFileName', $this->_errorFileName); | |
627 | } | |
628 | if ($this->_conflictCount) { | |
629 | $store->set('conflictsFileName', $this->_conflictFileName); | |
630 | } | |
631 | if (isset($this->_rows) && !empty($this->_rows)) { | |
632 | $store->set('dataValues', $this->_rows); | |
633 | } | |
634 | ||
635 | if ($this->_unMatchCount) { | |
636 | $store->set('mismatchFileName', $this->_misMatchFilemName); | |
637 | } | |
638 | ||
639 | if ($mode == self::MODE_IMPORT) { | |
640 | $store->set('duplicateRowCount', $this->_duplicateCount); | |
641 | $store->set('unparsedAddressCount', $this->_unparsedAddressCount); | |
642 | if ($this->_duplicateCount) { | |
643 | $store->set('duplicatesFileName', $this->_duplicateFileName); | |
644 | } | |
645 | if ($this->_unparsedAddressCount) { | |
646 | $store->set('errorsFileName', $this->_errorFileName); | |
647 | } | |
648 | } | |
649 | //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount"; | |
650 | } | |
651 | ||
652 | /** | |
fe482240 | 653 | * Export data to a CSV file. |
6a488035 | 654 | * |
100fef9d | 655 | * @param string $fileName |
6a488035 | 656 | * @param array $header |
c490a46a | 657 | * @param array $data |
4815ab3d | 658 | */ |
00be9182 | 659 | public static function exportCSV($fileName, $header, $data) { |
6a488035 TO |
660 | |
661 | if (file_exists($fileName) && !is_writable($fileName)) { | |
662 | CRM_Core_Error::movedSiteError($fileName); | |
663 | } | |
664 | //hack to remove '_status', '_statusMsg' and '_id' from error file | |
be2fb01f CW |
665 | $errorValues = []; |
666 | $dbRecordStatus = ['IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW']; | |
6a488035 TO |
667 | foreach ($data as $rowCount => $rowValues) { |
668 | $count = 0; | |
669 | foreach ($rowValues as $key => $val) { | |
670 | if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) { | |
671 | break; | |
672 | } | |
673 | $errorValues[$rowCount][$key] = $val; | |
674 | $count++; | |
675 | } | |
676 | } | |
677 | $data = $errorValues; | |
678 | ||
be2fb01f | 679 | $output = []; |
6a488035 TO |
680 | $fd = fopen($fileName, 'w'); |
681 | ||
682 | foreach ($header as $key => $value) { | |
683 | $header[$key] = "\"$value\""; | |
684 | } | |
685 | $config = CRM_Core_Config::singleton(); | |
686 | $output[] = implode($config->fieldSeparator, $header); | |
687 | ||
688 | foreach ($data as $datum) { | |
689 | foreach ($datum as $key => $value) { | |
690 | $datum[$key] = "\"$value\""; | |
691 | } | |
692 | $output[] = implode($config->fieldSeparator, $datum); | |
693 | } | |
694 | fwrite($fd, implode("\n", $output)); | |
695 | fclose($fd); | |
696 | } | |
697 | ||
698 | /** | |
4815ab3d | 699 | * Update the record with PK $id in the import database table. |
6a488035 TO |
700 | * |
701 | * @param int $id | |
702 | * @param array $params | |
6a488035 TO |
703 | */ |
704 | public function updateImportRecord($id, &$params) { | |
705 | $statusFieldName = $this->_statusFieldName; | |
706 | $primaryKeyName = $this->_primaryKeyName; | |
707 | ||
708 | if ($statusFieldName && $primaryKeyName) { | |
709 | $dao = new CRM_Core_DAO(); | |
710 | $db = $dao->getDatabaseConnection(); | |
711 | ||
712 | $query = "UPDATE $this->_tableName | |
52892e8b | 713 | SET $statusFieldName = ?, |
6a488035 | 714 | ${statusFieldName}Msg = ? |
52892e8b | 715 | WHERE $primaryKeyName = ?"; |
be2fb01f | 716 | $args = [ |
6a488035 TO |
717 | $params[$statusFieldName], |
718 | CRM_Utils_Array::value("${statusFieldName}Msg", $params), | |
719 | $id, | |
be2fb01f | 720 | ]; |
6a488035 TO |
721 | |
722 | //print "Running query: $query<br/>With arguments: ".$params[$statusFieldName].", ".$params["${statusFieldName}Msg"].", $id<br/>"; | |
723 | ||
724 | $db->query($query, $args); | |
725 | } | |
726 | } | |
727 | ||
5dc4d424 | 728 | /** |
729 | * Format common params data to proper format to store. | |
730 | * | |
731 | * @param array $params | |
732 | * Contain record values. | |
733 | * @param array $formatted | |
734 | * Array of formatted data. | |
735 | * @param array $contactFields | |
736 | * Contact DAO fields. | |
737 | */ | |
738 | public function formatCommonData($params, &$formatted, &$contactFields) { | |
be2fb01f | 739 | $csType = [ |
5dc4d424 | 740 | CRM_Utils_Array::value('contact_type', $formatted), |
be2fb01f | 741 | ]; |
5dc4d424 | 742 | |
743 | //CRM-5125 | |
744 | //add custom fields for contact sub type | |
745 | if (!empty($this->_contactSubType)) { | |
746 | $csType = $this->_contactSubType; | |
747 | } | |
748 | ||
749 | if ($relCsType = CRM_Utils_Array::value('contact_sub_type', $formatted)) { | |
750 | $csType = $relCsType; | |
751 | } | |
752 | ||
753 | $customFields = CRM_Core_BAO_CustomField::getFields($formatted['contact_type'], FALSE, FALSE, $csType); | |
754 | ||
755 | $addressCustomFields = CRM_Core_BAO_CustomField::getFields('Address'); | |
756 | $customFields = $customFields + $addressCustomFields; | |
757 | ||
758 | //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 | 759 | $elements = [ |
5dc4d424 | 760 | 'email_greeting_custom' => 'email_greeting', |
761 | 'postal_greeting_custom' => 'postal_greeting', | |
762 | 'addressee_custom' => 'addressee', | |
be2fb01f | 763 | ]; |
5dc4d424 | 764 | foreach ($elements as $k => $v) { |
765 | if (array_key_exists($k, $params) && !(array_key_exists($v, $params))) { | |
766 | $label = key(CRM_Core_OptionGroup::values($v, TRUE, NULL, NULL, 'AND v.name = "Customized"')); | |
767 | $params[$v] = $label; | |
768 | } | |
769 | } | |
770 | ||
771 | //format date first | |
772 | $session = CRM_Core_Session::singleton(); | |
773 | $dateType = $session->get("dateTypes"); | |
774 | foreach ($params as $key => $val) { | |
775 | $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key); | |
776 | if ($customFieldID && | |
777 | !array_key_exists($customFieldID, $addressCustomFields) | |
778 | ) { | |
779 | //we should not update Date to null, CRM-4062 | |
780 | if ($val && ($customFields[$customFieldID]['data_type'] == 'Date')) { | |
22161818 | 781 | //CRM-21267 |
160a5de1 | 782 | CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $formatted, $dateType, $key); |
5dc4d424 | 783 | } |
784 | elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') { | |
785 | if (empty($val) && !is_numeric($val) && $this->_onDuplicate == CRM_Import_Parser::DUPLICATE_FILL) { | |
786 | //retain earlier value when Import mode is `Fill` | |
787 | unset($params[$key]); | |
788 | } | |
789 | else { | |
790 | $params[$key] = CRM_Utils_String::strtoboolstr($val); | |
791 | } | |
792 | } | |
793 | } | |
794 | ||
795 | if ($key == 'birth_date' && $val) { | |
796 | CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key); | |
797 | } | |
798 | elseif ($key == 'deceased_date' && $val) { | |
799 | CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key); | |
800 | $params['is_deceased'] = 1; | |
801 | } | |
802 | elseif ($key == 'is_deceased' && $val) { | |
803 | $params[$key] = CRM_Utils_String::strtoboolstr($val); | |
804 | } | |
5dc4d424 | 805 | } |
806 | ||
807 | //now format custom data. | |
808 | foreach ($params as $key => $field) { | |
809 | if (is_array($field)) { | |
810 | $isAddressCustomField = FALSE; | |
811 | foreach ($field as $value) { | |
812 | $break = FALSE; | |
813 | if (is_array($value)) { | |
814 | foreach ($value as $name => $testForEmpty) { | |
815 | if ($addressCustomFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) { | |
816 | $isAddressCustomField = TRUE; | |
817 | break; | |
818 | } | |
819 | // check if $value does not contain IM provider or phoneType | |
820 | if (($name !== 'phone_type_id' || $name !== 'provider_id') && ($testForEmpty === '' || $testForEmpty == NULL)) { | |
821 | $break = TRUE; | |
822 | break; | |
823 | } | |
824 | } | |
825 | } | |
826 | else { | |
827 | $break = TRUE; | |
828 | } | |
829 | ||
830 | if (!$break) { | |
9afab633 | 831 | if (!empty($value['location_type_id'])) { |
832 | $this->formatLocationBlock($value, $formatted); | |
833 | } | |
834 | else { | |
835 | CRM_Core_Error::deprecatedFunctionWarning('this is not expected to be reachable now'); | |
836 | $this->formatContactParameters($value, $formatted); | |
837 | } | |
5dc4d424 | 838 | } |
839 | } | |
840 | if (!$isAddressCustomField) { | |
841 | continue; | |
842 | } | |
843 | } | |
844 | ||
be2fb01f | 845 | $formatValues = [ |
5dc4d424 | 846 | $key => $field, |
be2fb01f | 847 | ]; |
5dc4d424 | 848 | |
849 | if (($key !== 'preferred_communication_method') && (array_key_exists($key, $contactFields))) { | |
850 | // due to merging of individual table and | |
851 | // contact table, we need to avoid | |
852 | // preferred_communication_method forcefully | |
853 | $formatValues['contact_type'] = $formatted['contact_type']; | |
854 | } | |
855 | ||
856 | if ($key == 'id' && isset($field)) { | |
857 | $formatted[$key] = $field; | |
858 | } | |
859 | $this->formatContactParameters($formatValues, $formatted); | |
860 | ||
861 | //Handling Custom Data | |
862 | // note: Address custom fields will be handled separately inside formatContactParameters | |
863 | if (($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) && | |
864 | array_key_exists($customFieldID, $customFields) && | |
865 | !array_key_exists($customFieldID, $addressCustomFields) | |
866 | ) { | |
867 | ||
868 | $extends = CRM_Utils_Array::value('extends', $customFields[$customFieldID]); | |
869 | $htmlType = CRM_Utils_Array::value('html_type', $customFields[$customFieldID]); | |
870 | switch ($htmlType) { | |
871 | case 'Select': | |
872 | case 'Radio': | |
873 | case 'Autocomplete-Select': | |
874 | if ($customFields[$customFieldID]['data_type'] == 'String' || $customFields[$customFieldID]['data_type'] == 'Int') { | |
875 | $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE); | |
876 | foreach ($customOption as $customValue) { | |
877 | $val = CRM_Utils_Array::value('value', $customValue); | |
878 | $label = CRM_Utils_Array::value('label', $customValue); | |
879 | $label = strtolower($label); | |
880 | $value = strtolower(trim($formatted[$key])); | |
881 | if (($value == $label) || ($value == strtolower($val))) { | |
882 | $params[$key] = $formatted[$key] = $val; | |
883 | } | |
884 | } | |
885 | } | |
886 | break; | |
887 | ||
888 | case 'CheckBox': | |
5dc4d424 | 889 | case 'Multi-Select': |
890 | ||
891 | if (!empty($formatted[$key]) && !empty($params[$key])) { | |
892 | $mulValues = explode(',', $formatted[$key]); | |
893 | $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE); | |
be2fb01f CW |
894 | $formatted[$key] = []; |
895 | $params[$key] = []; | |
5dc4d424 | 896 | foreach ($mulValues as $v1) { |
897 | foreach ($customOption as $v2) { | |
898 | if ((strtolower($v2['label']) == strtolower(trim($v1))) || | |
899 | (strtolower($v2['value']) == strtolower(trim($v1))) | |
900 | ) { | |
901 | if ($htmlType == 'CheckBox') { | |
902 | $params[$key][$v2['value']] = $formatted[$key][$v2['value']] = 1; | |
903 | } | |
904 | else { | |
905 | $params[$key][] = $formatted[$key][] = $v2['value']; | |
906 | } | |
907 | } | |
908 | } | |
909 | } | |
910 | } | |
911 | break; | |
912 | } | |
913 | } | |
914 | } | |
915 | ||
916 | if (!empty($key) && ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) && array_key_exists($customFieldID, $customFields) && | |
917 | !array_key_exists($customFieldID, $addressCustomFields) | |
918 | ) { | |
919 | // @todo calling api functions directly is not supported | |
920 | _civicrm_api3_custom_format_params($params, $formatted, $extends); | |
921 | } | |
922 | ||
923 | // to check if not update mode and unset the fields with empty value. | |
924 | if (!$this->_updateWithId && array_key_exists('custom', $formatted)) { | |
925 | foreach ($formatted['custom'] as $customKey => $customvalue) { | |
926 | if (empty($formatted['custom'][$customKey][-1]['is_required'])) { | |
927 | $formatted['custom'][$customKey][-1]['is_required'] = $customFields[$customKey]['is_required']; | |
928 | } | |
929 | $emptyValue = CRM_Utils_Array::value('value', $customvalue[-1]); | |
930 | if (!isset($emptyValue)) { | |
931 | unset($formatted['custom'][$customKey]); | |
932 | } | |
933 | } | |
934 | } | |
935 | ||
936 | // parse street address, CRM-5450 | |
937 | if ($this->_parseStreetAddress) { | |
938 | if (array_key_exists('address', $formatted) && is_array($formatted['address'])) { | |
939 | foreach ($formatted['address'] as $instance => & $address) { | |
940 | $streetAddress = CRM_Utils_Array::value('street_address', $address); | |
941 | if (empty($streetAddress)) { | |
942 | continue; | |
943 | } | |
944 | // parse address field. | |
945 | $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($streetAddress); | |
946 | ||
947 | //street address consider to be parsed properly, | |
948 | //If we get street_name and street_number. | |
949 | if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) { | |
950 | $parsedFields = array_fill_keys(array_keys($parsedFields), ''); | |
951 | } | |
952 | ||
953 | // merge parse address w/ main address block. | |
954 | $address = array_merge($address, $parsedFields); | |
955 | } | |
956 | } | |
957 | } | |
958 | } | |
959 | ||
960 | /** | |
961 | * Format contact parameters. | |
962 | * | |
963 | * @todo this function needs re-writing & re-merging into the main function. | |
964 | * | |
965 | * Here be dragons. | |
966 | * | |
967 | * @param array $values | |
968 | * @param array $params | |
969 | * | |
970 | * @return bool | |
971 | */ | |
972 | protected function formatContactParameters(&$values, &$params) { | |
973 | // Crawl through the possible classes: | |
974 | // Contact | |
975 | // Individual | |
976 | // Household | |
977 | // Organization | |
978 | // Location | |
979 | // Address | |
980 | ||
981 | // Phone | |
982 | // IM | |
983 | // Note | |
984 | // Custom | |
985 | ||
5dc4d424 | 986 | // first add core contact values since for other Civi modules they are not added |
987 | $contactFields = CRM_Contact_DAO_Contact::fields(); | |
988 | _civicrm_api3_store_values($contactFields, $values, $params); | |
989 | ||
990 | if (isset($values['contact_type'])) { | |
991 | // we're an individual/household/org property | |
992 | ||
993 | $fields[$values['contact_type']] = CRM_Contact_DAO_Contact::fields(); | |
994 | ||
995 | _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params); | |
996 | return TRUE; | |
997 | } | |
998 | ||
a0c6165f | 999 | // Cache the various object fields |
1000 | // @todo - remove this after confirming this is just a compilation of other-wise-cached fields. | |
1001 | static $fields = []; | |
1002 | ||
5dc4d424 | 1003 | if (isset($values['individual_prefix'])) { |
1004 | if (!empty($params['prefix_id'])) { | |
1005 | $prefixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id'); | |
1006 | $params['prefix'] = $prefixes[$params['prefix_id']]; | |
1007 | } | |
1008 | else { | |
1009 | $params['prefix'] = $values['individual_prefix']; | |
1010 | } | |
1011 | return TRUE; | |
1012 | } | |
1013 | ||
1014 | if (isset($values['individual_suffix'])) { | |
1015 | if (!empty($params['suffix_id'])) { | |
1016 | $suffixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id'); | |
1017 | $params['suffix'] = $suffixes[$params['suffix_id']]; | |
1018 | } | |
1019 | else { | |
1020 | $params['suffix'] = $values['individual_suffix']; | |
1021 | } | |
1022 | return TRUE; | |
1023 | } | |
1024 | ||
1025 | // CRM-4575 | |
1026 | if (isset($values['email_greeting'])) { | |
1027 | if (!empty($params['email_greeting_id'])) { | |
be2fb01f | 1028 | $emailGreetingFilter = [ |
5dc4d424 | 1029 | 'contact_type' => CRM_Utils_Array::value('contact_type', $params), |
1030 | 'greeting_type' => 'email_greeting', | |
be2fb01f | 1031 | ]; |
5dc4d424 | 1032 | $emailGreetings = CRM_Core_PseudoConstant::greeting($emailGreetingFilter); |
1033 | $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']]; | |
1034 | } | |
1035 | else { | |
1036 | $params['email_greeting'] = $values['email_greeting']; | |
1037 | } | |
1038 | ||
1039 | return TRUE; | |
1040 | } | |
1041 | ||
1042 | if (isset($values['postal_greeting'])) { | |
1043 | if (!empty($params['postal_greeting_id'])) { | |
be2fb01f | 1044 | $postalGreetingFilter = [ |
5dc4d424 | 1045 | 'contact_type' => CRM_Utils_Array::value('contact_type', $params), |
1046 | 'greeting_type' => 'postal_greeting', | |
be2fb01f | 1047 | ]; |
5dc4d424 | 1048 | $postalGreetings = CRM_Core_PseudoConstant::greeting($postalGreetingFilter); |
1049 | $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']]; | |
1050 | } | |
1051 | else { | |
1052 | $params['postal_greeting'] = $values['postal_greeting']; | |
1053 | } | |
1054 | return TRUE; | |
1055 | } | |
1056 | ||
1057 | if (isset($values['addressee'])) { | |
1058 | if (!empty($params['addressee_id'])) { | |
be2fb01f | 1059 | $addresseeFilter = [ |
5dc4d424 | 1060 | 'contact_type' => CRM_Utils_Array::value('contact_type', $params), |
1061 | 'greeting_type' => 'addressee', | |
be2fb01f | 1062 | ]; |
5dc4d424 | 1063 | $addressee = CRM_Core_PseudoConstant::addressee($addresseeFilter); |
1064 | $params['addressee'] = $addressee[$params['addressee_id']]; | |
1065 | } | |
1066 | else { | |
1067 | $params['addressee'] = $values['addressee']; | |
1068 | } | |
1069 | return TRUE; | |
1070 | } | |
1071 | ||
1072 | if (isset($values['gender'])) { | |
1073 | if (!empty($params['gender_id'])) { | |
1074 | $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'); | |
1075 | $params['gender'] = $genders[$params['gender_id']]; | |
1076 | } | |
1077 | else { | |
1078 | $params['gender'] = $values['gender']; | |
1079 | } | |
1080 | return TRUE; | |
1081 | } | |
1082 | ||
1083 | if (!empty($values['preferred_communication_method'])) { | |
be2fb01f | 1084 | $comm = []; |
5dc4d424 | 1085 | $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER); |
1086 | ||
1087 | $preffComm = explode(',', $values['preferred_communication_method']); | |
1088 | foreach ($preffComm as $v) { | |
1089 | $v = strtolower(trim($v)); | |
1090 | if (array_key_exists($v, $pcm)) { | |
1091 | $comm[$pcm[$v]] = 1; | |
1092 | } | |
1093 | } | |
1094 | ||
1095 | $params['preferred_communication_method'] = $comm; | |
1096 | return TRUE; | |
1097 | } | |
1098 | ||
1099 | // format the website params. | |
1100 | if (!empty($values['url'])) { | |
1101 | static $websiteFields; | |
1102 | if (!is_array($websiteFields)) { | |
1103 | $websiteFields = CRM_Core_DAO_Website::fields(); | |
1104 | } | |
1105 | if (!array_key_exists('website', $params) || | |
1106 | !is_array($params['website']) | |
1107 | ) { | |
be2fb01f | 1108 | $params['website'] = []; |
5dc4d424 | 1109 | } |
1110 | ||
1111 | $websiteCount = count($params['website']); | |
1112 | _civicrm_api3_store_values($websiteFields, $values, | |
1113 | $params['website'][++$websiteCount] | |
1114 | ); | |
1115 | ||
1116 | return TRUE; | |
1117 | } | |
1118 | ||
1119 | // get the formatted location blocks into params - w/ 3.0 format, CRM-4605 | |
1120 | if (!empty($values['location_type_id'])) { | |
9afab633 | 1121 | CRM_Core_Error::deprecatedFunctionWarning('this is not expected to be reachable now'); |
0b3f2e42 | 1122 | return $this->formatLocationBlock($values, $params); |
5dc4d424 | 1123 | } |
1124 | ||
1125 | if (isset($values['note'])) { | |
1126 | // add a note field | |
1127 | if (!isset($params['note'])) { | |
be2fb01f | 1128 | $params['note'] = []; |
5dc4d424 | 1129 | } |
1130 | $noteBlock = count($params['note']) + 1; | |
1131 | ||
be2fb01f | 1132 | $params['note'][$noteBlock] = []; |
5dc4d424 | 1133 | if (!isset($fields['Note'])) { |
1134 | $fields['Note'] = CRM_Core_DAO_Note::fields(); | |
1135 | } | |
1136 | ||
1137 | // get the current logged in civicrm user | |
1138 | $session = CRM_Core_Session::singleton(); | |
1139 | $userID = $session->get('userID'); | |
1140 | ||
1141 | if ($userID) { | |
1142 | $values['contact_id'] = $userID; | |
1143 | } | |
1144 | ||
1145 | _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]); | |
1146 | ||
1147 | return TRUE; | |
1148 | } | |
1149 | ||
1150 | // Check for custom field values | |
a0c6165f | 1151 | $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $values), |
1152 | FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE | |
1153 | ); | |
5dc4d424 | 1154 | |
1155 | foreach ($values as $key => $value) { | |
1156 | if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) { | |
1157 | // check if it's a valid custom field id | |
1158 | ||
a0c6165f | 1159 | if (!array_key_exists($customFieldID, $customFields)) { |
5dc4d424 | 1160 | return civicrm_api3_create_error('Invalid custom field ID'); |
1161 | } | |
1162 | else { | |
1163 | $params[$key] = $value; | |
1164 | } | |
1165 | } | |
1166 | } | |
1167 | return TRUE; | |
1168 | } | |
1169 | ||
c4c7a315 | 1170 | /** |
1171 | * Format location block ready for importing. | |
1172 | * | |
1173 | * There is some test coverage for this in CRM_Contact_Import_Parser_ContactTest | |
1174 | * e.g. testImportPrimaryAddress. | |
1175 | * | |
1176 | * @param array $values | |
1177 | * @param array $params | |
c4c7a315 | 1178 | * |
1179 | * @return bool | |
1180 | */ | |
0b3f2e42 | 1181 | protected function formatLocationBlock(&$values, &$params) { |
c4c7a315 | 1182 | $blockTypes = [ |
1183 | 'phone' => 'Phone', | |
1184 | 'email' => 'Email', | |
1185 | 'im' => 'IM', | |
1186 | 'openid' => 'OpenID', | |
1187 | 'phone_ext' => 'Phone', | |
1188 | ]; | |
1189 | foreach ($blockTypes as $blockFieldName => $block) { | |
1190 | if (!array_key_exists($blockFieldName, $values)) { | |
1191 | continue; | |
1192 | } | |
a7b9cf38 | 1193 | $blockIndex = $values['location_type_id'] . (!empty($values['phone_type_id']) ? '_' . $values['phone_type_id'] : ''); |
c4c7a315 | 1194 | |
1195 | // block present in value array. | |
1196 | if (!array_key_exists($blockFieldName, $params) || !is_array($params[$blockFieldName])) { | |
1197 | $params[$blockFieldName] = []; | |
1198 | } | |
1199 | ||
0b3f2e42 | 1200 | $fields[$block] = $this->getMetadataForEntity($block); |
c4c7a315 | 1201 | |
c4c7a315 | 1202 | // copy value to dao field name. |
1203 | if ($blockFieldName == 'im') { | |
1204 | $values['name'] = $values[$blockFieldName]; | |
1205 | } | |
1206 | ||
1207 | _civicrm_api3_store_values($fields[$block], $values, | |
a7b9cf38 | 1208 | $params[$blockFieldName][$blockIndex] |
c4c7a315 | 1209 | ); |
1210 | ||
a7b9cf38 | 1211 | $this->fillPrimary($params[$blockFieldName][$blockIndex], $values, $block, CRM_Utils_Array::value('id', $params)); |
c4c7a315 | 1212 | |
2ab10f80 | 1213 | if (empty($params['id']) && (count($params[$blockFieldName]) == 1)) { |
a7b9cf38 | 1214 | $params[$blockFieldName][$blockIndex]['is_primary'] = TRUE; |
c4c7a315 | 1215 | } |
1216 | ||
1217 | // we only process single block at a time. | |
1218 | return TRUE; | |
1219 | } | |
1220 | ||
1221 | // handle address fields. | |
1222 | if (!array_key_exists('address', $params) || !is_array($params['address'])) { | |
1223 | $params['address'] = []; | |
1224 | } | |
1225 | ||
c4c7a315 | 1226 | // Note: we doing multiple value formatting here for address custom fields, plus putting into right format. |
1227 | // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving | |
1228 | // the address in CRM_Core_BAO_Address::create method | |
1229 | if (!empty($values['location_type_id'])) { | |
1230 | static $customFields = []; | |
1231 | if (empty($customFields)) { | |
1232 | $customFields = CRM_Core_BAO_CustomField::getFields('Address'); | |
1233 | } | |
1234 | // make a copy of values, as we going to make changes | |
1235 | $newValues = $values; | |
1236 | foreach ($values as $key => $val) { | |
1237 | $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key); | |
1238 | if ($customFieldID && array_key_exists($customFieldID, $customFields)) { | |
c4c7a315 | 1239 | |
1240 | $htmlType = CRM_Utils_Array::value('html_type', $customFields[$customFieldID]); | |
1241 | switch ($htmlType) { | |
1242 | case 'CheckBox': | |
1243 | case 'Multi-Select': | |
1244 | if ($val) { | |
1245 | $mulValues = explode(',', $val); | |
1246 | $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE); | |
1247 | $newValues[$key] = []; | |
1248 | foreach ($mulValues as $v1) { | |
1249 | foreach ($customOption as $v2) { | |
1250 | if ((strtolower($v2['label']) == strtolower(trim($v1))) || | |
1251 | (strtolower($v2['value']) == strtolower(trim($v1))) | |
1252 | ) { | |
1253 | if ($htmlType == 'CheckBox') { | |
1254 | $newValues[$key][$v2['value']] = 1; | |
1255 | } | |
1256 | else { | |
1257 | $newValues[$key][] = $v2['value']; | |
1258 | } | |
1259 | } | |
1260 | } | |
1261 | } | |
1262 | } | |
1263 | break; | |
1264 | } | |
1265 | } | |
1266 | } | |
1267 | // consider new values | |
1268 | $values = $newValues; | |
1269 | } | |
1270 | ||
0b3f2e42 | 1271 | $fields['Address'] = $this->getMetadataForEntity('Address'); |
1272 | // @todo this is kinda replicated below.... | |
c4c7a315 | 1273 | _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$values['location_type_id']]); |
1274 | ||
1275 | $addressFields = [ | |
1276 | 'county', | |
1277 | 'country', | |
1278 | 'state_province', | |
1279 | 'supplemental_address_1', | |
1280 | 'supplemental_address_2', | |
1281 | 'supplemental_address_3', | |
1282 | 'StateProvince.name', | |
1283 | ]; | |
0b3f2e42 | 1284 | foreach (array_keys($customFields) as $customFieldID) { |
1285 | $addressFields[] = 'custom_' . $customFieldID; | |
1286 | } | |
c4c7a315 | 1287 | |
1288 | foreach ($addressFields as $field) { | |
1289 | if (array_key_exists($field, $values)) { | |
1290 | if (!array_key_exists('address', $params)) { | |
1291 | $params['address'] = []; | |
1292 | } | |
1293 | $params['address'][$values['location_type_id']][$field] = $values[$field]; | |
1294 | } | |
1295 | } | |
1296 | ||
f6953904 | 1297 | $this->fillPrimary($params['address'][$values['location_type_id']], $values, 'address', CRM_Utils_Array::value('id', $params)); |
c4c7a315 | 1298 | return TRUE; |
1299 | } | |
1300 | ||
0b3f2e42 | 1301 | /** |
1302 | * Get the field metadata for the relevant entity. | |
1303 | * | |
1304 | * @param string $entity | |
1305 | * | |
1306 | * @return array | |
1307 | */ | |
1308 | protected function getMetadataForEntity($entity) { | |
1309 | if (!isset($this->fieldMetadata[$entity])) { | |
1310 | $className = "CRM_Core_DAO_$entity"; | |
1311 | $this->fieldMetadata[$entity] = $className::fields(); | |
1312 | } | |
1313 | return $this->fieldMetadata[$entity]; | |
1314 | } | |
1315 | ||
2ab10f80 | 1316 | /** |
1317 | * Fill in the primary location. | |
1318 | * | |
1319 | * If the contact has a primary address we update it. Otherwise | |
1320 | * we add an address of the default location type. | |
1321 | * | |
1322 | * @param array $params | |
1323 | * Address block parameters | |
1324 | * @param array $values | |
1325 | * Input values | |
1326 | * @param string $entity | |
1327 | * - address, email, phone | |
e97c66ff | 1328 | * @param int|null $contactID |
1329 | * | |
1330 | * @throws \CiviCRM_API3_Exception | |
2ab10f80 | 1331 | */ |
1332 | protected function fillPrimary(&$params, $values, $entity, $contactID) { | |
1333 | if ($values['location_type_id'] === 'Primary') { | |
1334 | if ($contactID) { | |
1335 | $primary = civicrm_api3($entity, 'get', [ | |
1336 | 'return' => 'location_type_id', | |
1337 | 'contact_id' => $contactID, | |
1338 | 'is_primary' => 1, | |
9f266042 | 1339 | 'sequential' => 1, |
2ab10f80 | 1340 | ]); |
1341 | } | |
1342 | $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); | |
1343 | $params['location_type_id'] = (int) (isset($primary) && $primary['count']) ? $primary['values'][0]['location_type_id'] : $defaultLocationType->id; | |
1344 | $params['is_primary'] = 1; | |
1345 | } | |
1346 | } | |
1347 | ||
6a488035 | 1348 | } |