3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
12 use Civi\Api4\CustomGroup
;
17 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 class CRM_Dedupe_Merger
{
22 * FIXME: consider creating a common structure with cidRefs() and eidRefs()
23 * FIXME: the sub-pages references by the URLs should
24 * be loaded dynamically on the merge form instead
27 * @throws \CiviCRM_API3_Exception
29 public static function relTables() {
31 if (!isset(Civi
::$statics[__CLASS__
]['relTables'])) {
33 // Setting these merely prevents enotices - but it may be more appropriate not to add the user table below
34 // if the url can't be retrieved. A more standardised way to retrieve them is.
35 // CRM_Core_Config::singleton()->userSystem->getUserRecordUrl() - however that function takes a contact_id &
36 // we may need a different function when it is not known.
37 $title = $userRecordUrl = '';
39 $config = CRM_Core_Config
::singleton();
40 // @todo - this user url stuff is only needed for the form layer - move to CRM_Contact_Form_Merge
41 if ($config->userSystem
->is_drupal
) {
42 $userRecordUrl = CRM_Utils_System
::url('user/%ufid');
43 $title = ts('%1 User: %2; user id: %3', [
44 1 => $config->userFramework
,
49 elseif ($config->userFramework
=== 'Joomla') {
50 $userRecordUrl = $config->userSystem
->getVersion() > 1.5 ?
$config->userFrameworkBaseURL
. "index.php?option=com_users&view=user&task=user.edit&id=" . '%ufid' : $config->userFrameworkBaseURL
. "index2.php?option=com_users&view=user&task=edit&id[]=" . '%ufid';
51 $title = ts('%1 User: %2; user id: %3', [
52 1 => $config->userFramework
,
59 'rel_table_contributions' => [
60 'title' => ts('Contributions'),
62 'civicrm_contribution',
63 'civicrm_contribution_recur',
64 'civicrm_contribution_soft',
66 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=contribute'),
68 'rel_table_contribution_page' => [
69 'title' => ts('Contribution Pages'),
70 'tables' => ['civicrm_contribution_page'],
71 'url' => CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1&cid=$cid'),
73 'rel_table_memberships' => [
74 'title' => ts('Memberships'),
77 'civicrm_membership_log',
78 'civicrm_membership_type',
80 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=member'),
82 'rel_table_participants' => [
83 'title' => ts('Participants'),
84 'tables' => ['civicrm_participant'],
85 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=participant'),
87 'rel_table_events' => [
88 'title' => ts('Events'),
89 'tables' => ['civicrm_event'],
90 'url' => CRM_Utils_System
::url('civicrm/event/manage', 'reset=1&cid=$cid'),
92 'rel_table_activities' => [
93 'title' => ts('Activities'),
94 'tables' => ['civicrm_activity', 'civicrm_activity_contact'],
95 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=activity'),
97 'rel_table_relationships' => [
98 'title' => ts('Relationships'),
99 'tables' => ['civicrm_relationship'],
100 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=rel'),
102 'rel_table_custom_groups' => [
103 'title' => ts('Custom Groups'),
104 'tables' => ['civicrm_custom_group'],
105 'url' => CRM_Utils_System
::url('civicrm/admin/custom/group'),
107 'rel_table_uf_groups' => [
108 'title' => ts('Profiles'),
109 'tables' => ['civicrm_uf_group'],
110 'url' => CRM_Utils_System
::url('civicrm/admin/uf/group', 'reset=1'),
112 'rel_table_groups' => [
113 'title' => ts('Groups'),
114 'tables' => ['civicrm_group_contact'],
115 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=group'),
117 'rel_table_notes' => [
118 'title' => ts('Notes'),
119 'tables' => ['civicrm_note'],
120 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=note'),
122 'rel_table_tags' => [
123 'title' => ts('Tags'),
124 'tables' => ['civicrm_entity_tag'],
125 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=tag'),
127 'rel_table_mailings' => [
128 'title' => ts('Mailings'),
131 'civicrm_mailing_event_queue',
132 'civicrm_mailing_event_subscribe',
134 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=mailing'),
136 'rel_table_cases' => [
137 'title' => ts('Cases'),
138 'tables' => ['civicrm_case_contact'],
139 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=case'),
141 'rel_table_grants' => [
142 'title' => ts('Grants'),
143 'tables' => ['civicrm_grant'],
144 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=grant'),
147 'title' => ts('PCPs'),
148 'tables' => ['civicrm_pcp'],
149 'url' => CRM_Utils_System
::url('civicrm/contribute/pcp/manage', 'reset=1'),
151 'rel_table_pledges' => [
152 'title' => ts('Pledges'),
153 'tables' => ['civicrm_pledge', 'civicrm_pledge_payment'],
154 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=pledge'),
156 'rel_table_users' => [
158 'tables' => ['civicrm_uf_match'],
159 'url' => $userRecordUrl,
163 $relTables +
= self
::getMultiValueCustomSets('relTables');
165 // Allow hook_civicrm_merge() to adjust $relTables
166 CRM_Utils_Hook
::merge('relTables', $relTables);
168 // Cache the results in a static variable
169 Civi
::$statics[__CLASS__
]['relTables'] = $relTables;
172 return Civi
::$statics[__CLASS__
]['relTables'];
176 * Returns the related tables groups for which a contact has any info entered.
181 * @throws \CiviCRM_API3_Exception
183 public static function getActiveRelTables($cid) {
187 $relTables = self
::relTables();
188 $cidRefs = self
::cidRefs();
189 $eidRefs = self
::eidRefs();
190 foreach ($relTables as $group => $params) {
192 foreach ($params['tables'] as $table) {
193 if (isset($cidRefs[$table])) {
194 foreach ($cidRefs[$table] as $field) {
195 $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $field = $cid";
198 if (isset($eidRefs[$table])) {
199 foreach ($eidRefs[$table] as $entityTable => $entityId) {
200 $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $entityId = $cid AND $entityTable = 'civicrm_contact'";
203 foreach ($sqls as $sql) {
204 if (CRM_Core_DAO
::singleValueQuery($sql) > 0) {
210 return array_unique($groups);
214 * Get array tables and fields that reference civicrm_contact.id.
216 * This function calls the merge hook and only exists to wrap the DAO function to support that deprecated call.
217 * The entityTypes hook is the recommended way to add tables to this result.
219 * I thought about adding another hook to alter tableReferences but decided it was unclear if there
220 * are use cases not covered by entityTables and instead we should wait & see.
222 public static function cidRefs() {
223 if (isset(\Civi
::$statics[__CLASS__
]) && isset(\Civi
::$statics[__CLASS__
]['contact_references'])) {
224 return \Civi
::$statics[__CLASS__
]['contact_references'];
227 $contactReferences = $coreReferences = CRM_Core_DAO
::getReferencesToContactTable();
228 foreach (['civicrm_group_contact_cache', 'civicrm_acl_cache', 'civicrm_acl_contact_cache'] as $tableName) {
229 // Don't merge cache tables. These should be otherwise cleared at some point in the dedupe
230 // but they are prone to locking to let's not touch during the dedupe.
231 unset($contactReferences[$tableName], $coreReferences[$tableName]);
234 CRM_Utils_Hook
::merge('cidRefs', $contactReferences);
235 if ($contactReferences !== $coreReferences) {
236 CRM_Core_Error
::deprecatedWarning("Deprecated hook ::merge in context of 'cidRefs. Use entityTypes instead.");
238 \Civi
::$statics[__CLASS__
]['contact_references'] = $contactReferences;
239 return \Civi
::$statics[__CLASS__
]['contact_references'];
243 * Return tables and their fields referencing civicrm_contact.contact_id with entity_id
245 public static function eidRefs() {
248 // FIXME: this should be generated dynamically from the schema
249 // tables that reference contacts with entity_{id,table}
251 'civicrm_acl' => ['entity_table' => 'entity_id'],
252 'civicrm_acl_entity_role' => ['entity_table' => 'entity_id'],
253 'civicrm_entity_file' => ['entity_table' => 'entity_id'],
254 'civicrm_log' => ['entity_table' => 'entity_id'],
255 'civicrm_mailing_group' => ['entity_table' => 'entity_id'],
256 'civicrm_note' => ['entity_table' => 'entity_id'],
259 // Allow hook_civicrm_merge() to adjust $eidRefs
260 CRM_Utils_Hook
::merge('eidRefs', $eidRefs);
266 * Return tables using locations.
268 public static function locTables() {
271 $locTables = ['civicrm_email', 'civicrm_address', 'civicrm_phone'];
273 // Allow hook_civicrm_merge() to adjust $locTables
274 CRM_Utils_Hook
::merge('locTables', $locTables);
280 * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc.
282 * @param string $request
283 * 'relTables' or 'cidRefs'.
286 * @throws \CiviCRM_API3_Exception
289 public static function getMultiValueCustomSets($request) {
291 if (!isset(Civi
::$statics[__CLASS__
]['multiValueCustomSets'])) {
296 $result = civicrm_api3('custom_group', 'get', [
306 'return' => ['id', 'title', 'table_name', 'style'],
308 foreach ($result['values'] as $custom) {
309 $data['cidRefs'][$custom['table_name']] = ['entity_id'];
310 $urlSuffix = $custom['style'] === 'Tab' ?
'&selectedChild=custom_' . $custom['id'] : '';
311 $data['relTables']['rel_table_custom_' . $custom['id']] = [
312 'title' => $custom['title'],
313 'tables' => [$custom['table_name']],
314 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid' . $urlSuffix),
318 // Store the result in a static variable cache
319 Civi
::$statics[__CLASS__
]['multiValueCustomSets'] = $data;
322 return Civi
::$statics[__CLASS__
]['multiValueCustomSets'][$request];
326 * Tables which require custom processing should declare functions to call here.
327 * Doing so will override normal processing.
329 public static function cpTables() {
333 'civicrm_case_contact' => ['CRM_Case_BAO_Case' => 'mergeContacts'],
334 'civicrm_group_contact' => ['CRM_Contact_BAO_GroupContact' => 'mergeGroupContact'],
335 // Empty array == do nothing - this table is handled by mergeGroupContact
336 'civicrm_subscription_history' => [],
337 'civicrm_relationship' => ['CRM_Contact_BAO_Relationship' => 'mergeRelationships'],
338 'civicrm_membership' => ['CRM_Member_BAO_Membership' => 'mergeMemberships'],
345 * Return payment related table.
347 public static function paymentTables() {
350 $tables = ['civicrm_pledge', 'civicrm_membership', 'civicrm_participant'];
356 * Return payment update Query.
358 * @param string $tableName
359 * @param int $mainContactId
360 * @param int $otherContactId
364 public static function paymentSql($tableName, $mainContactId, $otherContactId) {
366 if (!$tableName ||
!$mainContactId ||
!$otherContactId) {
370 $paymentTables = self
::paymentTables();
371 if (!in_array($tableName, $paymentTables)) {
375 switch ($tableName) {
376 case 'civicrm_pledge':
378 UPDATE IGNORE civicrm_contribution contribution
379 INNER JOIN civicrm_pledge_payment payment ON ( payment.contribution_id = contribution.id )
380 INNER JOIN civicrm_pledge pledge ON ( pledge.id = payment.pledge_id )
381 SET contribution.contact_id = $mainContactId
382 WHERE pledge.contact_id = $otherContactId";
385 case 'civicrm_membership':
387 UPDATE IGNORE civicrm_contribution contribution
388 INNER JOIN civicrm_membership_payment payment ON ( payment.contribution_id = contribution.id )
389 INNER JOIN civicrm_membership membership ON ( membership.id = payment.membership_id )
390 SET contribution.contact_id = $mainContactId
391 WHERE membership.contact_id = $otherContactId";
394 case 'civicrm_participant':
396 UPDATE IGNORE civicrm_contribution contribution
397 INNER JOIN civicrm_participant_payment payment ON ( payment.contribution_id = contribution.id )
398 INNER JOIN civicrm_participant participant ON ( participant.id = payment.participant_id )
399 SET contribution.contact_id = $mainContactId
400 WHERE participant.contact_id = $otherContactId";
409 * @param int $otherId
410 * @param string $tableName
411 * @param array $tableOperations
412 * @param string $mode
416 public static function operationSql($mainId, $otherId, $tableName, $tableOperations = [], $mode = 'add') {
418 if (!$tableName ||
!$mainId ||
!$otherId) {
422 switch ($tableName) {
423 case 'civicrm_membership':
424 if (array_key_exists($tableName, $tableOperations) && $tableOperations[$tableName]['add']) {
427 if ($mode === 'add') {
429 DELETE membership1.* FROM civicrm_membership membership1
430 INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
431 AND membership1.contact_id = {$mainId}
432 AND membership2.contact_id = {$otherId} ";
434 if ($mode === 'payment') {
436 DELETE contribution.* FROM civicrm_contribution contribution
437 INNER JOIN civicrm_membership_payment payment ON payment.contribution_id = contribution.id
438 INNER JOIN civicrm_membership membership1 ON membership1.id = payment.membership_id
439 AND membership1.contact_id = {$mainId}
440 INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
441 AND membership2.contact_id = {$otherId}";
445 case 'civicrm_uf_match':
446 // normal queries won't work for uf_match since that will lead to violation of unique constraint,
447 // failing to meet intended result. Therefore we introduce this additional query:
448 $sqls[] = "DELETE FROM civicrm_uf_match WHERE contact_id = {$mainId}";
456 * Based on the provided two contact_ids and a set of tables, remove the
457 * belongings of the other contact and of their relations.
459 * @param int $otherID
460 * @param array $tables
462 * @throws \CiviCRM_API3_Exception
464 public static function removeContactBelongings($otherID, $tables) {
465 // CRM-20421: Removing Inherited memberships when memberships of parent are not migrated to new contact.
466 if (in_array('civicrm_membership', $tables, TRUE)) {
467 $membershipIDs = CRM_Utils_Array
::collect('id',
468 CRM_Utils_Array
::value('values',
469 civicrm_api3('Membership', "get", [
470 'contact_id' => $otherID,
476 if (!empty($membershipIDs)) {
477 civicrm_api3('Membership', 'get', [
478 'owner_membership_id' => ['IN' => $membershipIDs],
479 'api.Membership.delete' => ['id' => '$value.id'],
486 * Based on the provided two contact_ids and a set of tables, move the
487 * belongings of the other contact to the main one.
489 * @param CRM_Dedupe_MergeHandler $mergeHandler
490 * @param array $tables
491 * @param array $tableOperations
493 * @throws \API_Exception
494 * @throws \CiviCRM_API3_Exception
495 * @throws \Civi\API\Exception\UnauthorizedException
497 public static function moveContactBelongings($mergeHandler, $tables, $tableOperations) {
498 $mainId = $mergeHandler->getToKeepID();
499 $otherId = $mergeHandler->getToRemoveID();
500 $cidRefs = self
::cidRefs();
501 $eidRefs = $mergeHandler->getTablesDynamicallyRelatedToContactTable();
502 $dynamicRefs = CRM_Core_DAO
::getDynamicReferencesToTable('civicrm_contact');
503 $cpTables = self
::cpTables();
504 $paymentTables = self
::paymentTables();
505 self
::filterRowBasedCustomDataFromCustomTables($cidRefs);
506 $multiValueCidRefs = self
::getMultiValueCidRefs();
508 $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs));
510 // if there aren't any specific tables, don't affect the ones handled by relTables()
511 // also don't affect tables in locTables() CRM-15658
512 $relTables = self
::relTables();
513 // These arrays don't make a lot of sense. For now ensure the tested handling of tags works...
514 // it is moved over further down....
515 unset($relTables['rel_table_tags']);
516 $handled = self
::locTables();
518 foreach ($relTables as $params) {
519 $handled = array_merge($handled, $params['tables']);
521 $affected = array_diff($affected, $handled);
522 $affected = array_unique(array_merge($affected, $tables));
524 $mainId = (int) $mainId;
525 $otherId = (int) $otherId;
528 foreach ($affected as $table) {
529 // Call custom processing function for objects that require it
530 if (isset($cpTables[$table])) {
531 foreach ($cpTables[$table] as $className => $fnName) {
532 $className::$fnName($mainId, $otherId, $sqls, $tables, $tableOperations);
534 // Skip normal processing
538 if ($table === 'civicrm_activity_contact') {
539 $sqls[] = "UPDATE IGNORE civicrm_activity_contact SET contact_id = $mainId WHERE contact_id = $otherId";
540 $sqls[] = "DELETE FROM civicrm_activity_contact WHERE contact_id = $otherId";
544 if ($table === 'civicrm_dashboard_contact') {
545 $sqls[] = "UPDATE IGNORE civicrm_dashboard_contact SET contact_id = $mainId WHERE contact_id = $otherId";
546 $sqls[] = "DELETE FROM civicrm_dashboard_contact WHERE contact_id = $otherId";
550 if ($table === 'civicrm_dedupe_exception') {
551 $sqls[] = "UPDATE IGNORE civicrm_dedupe_exception SET contact_id1 = $mainId WHERE contact_id1 = $otherId";
552 $sqls[] = "UPDATE IGNORE civicrm_dedupe_exception SET contact_id2 = $mainId WHERE contact_id2 = $otherId";
553 $sqls[] = "DELETE FROM civicrm_dedupe_exception WHERE contact_id1 = $otherId OR contact_id2 = $otherId";
557 if ($table === 'civicrm_setting') {
558 // Per https://lab.civicrm.org/dev/core/-/issues/1934
559 // Note this line is not unit tested as yet as a quick-fix for a regression
560 // but it would be better to do a SELECT request & only update if needed (as a general rule
561 // more selects & less UPDATES will result in less deadlocks while de-duping.
562 // Note the delete is not important here - it can stay with the deleted contact on the
563 // off chance they get restored.
564 $sqls[] = "UPDATE IGNORE civicrm_setting SET contact_id = $mainId WHERE contact_id = $otherId";
568 // use UPDATE IGNORE + DELETE query pair to skip on situations when
569 // there's a UNIQUE restriction on ($field, some_other_field) pair
570 if (isset($cidRefs[$table])) {
571 foreach ($cidRefs[$table] as $field) {
572 // carry related contributions CRM-5359
573 if (in_array($table, $paymentTables)) {
574 $paymentSqls = self
::paymentSql($table, $mainId, $otherId);
575 $sqls = array_merge($sqls, $paymentSqls);
577 if (!empty($tables) && !in_array('civicrm_contribution', $tables)) {
578 $payOprSqls = self
::operationSql($mainId, $otherId, $table, $tableOperations, 'payment');
579 $sqls = array_merge($sqls, $payOprSqls);
583 $preOperationSqls = self
::operationSql($mainId, $otherId, $table, $tableOperations);
584 $sqls = array_merge($sqls, $preOperationSqls);
586 if (!empty($multiValueCidRefs[$table][$field])) {
587 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
588 $sqls[] = "UPDATE $table SET $field = REPLACE($field, '$sep$otherId$sep', '$sep$mainId$sep') WHERE $field LIKE '%$sep$otherId$sep%'";
591 $sqls[] = "UPDATE $table SET $field = $mainId WHERE $field = $otherId";
596 if (isset($eidRefs[$table])) {
597 foreach ($dynamicRefs[$table] as $dynamicRef) {
598 $sqls[] = "UPDATE IGNORE $table SET {$dynamicRef[0]}= $mainId WHERE {$dynamicRef[0]} = $otherId AND {$dynamicRef[1]} = 'civicrm_contact'";
599 $sqls[] = "DELETE FROM $table WHERE {$dynamicRef[0]} = $otherId AND {$dynamicRef[1]} = 'civicrm_contact'";
604 // Allow hook_civicrm_merge() to add SQL statements for the merge operation.
605 CRM_Utils_Hook
::merge('sqls', $sqls, $mainId, $otherId, $tables);
607 foreach ($sqls as $sql) {
608 CRM_Core_DAO
::executeQuery($sql, [], TRUE, NULL, TRUE);
610 CRM_Dedupe_Merger
::addMembershipToRelatedContacts($mainId);
614 * Filter out custom tables from cidRefs unless they are there due to a contact reference or are a multiple set.
616 * The only fields where we want to move the data by sql is where entity reference fields
617 * on another contact refer to the contact being merged, or it is a multiple record set.
618 * The transference of custom data from one contact to another is done in 2 other places in the dedupe process but should
619 * not be done in moveAllContactData.
621 * Note it's a bit silly the way we build & then cull cidRefs - however, poor hook placement means that
622 * until we fully deprecate calling the hook from cidRefs we are stuck.
624 * It was deprecated in code (via deprecation notices if people altered it) in Mar 2019 but in docs only in Apri 2020.
626 * @param array $cidRefs
628 * @throws \API_Exception
629 * @throws \Civi\API\Exception\UnauthorizedException
631 protected static function filterRowBasedCustomDataFromCustomTables(array &$cidRefs) {
632 $customTables = (array) CustomGroup
::get(FALSE)
633 ->setSelect(['table_name'])
634 ->addWhere('is_multiple', '=', 0)
635 ->addWhere('extends', 'IN', array_merge(['Contact'], CRM_Contact_BAO_ContactType
::contactTypes()))
637 ->indexBy('table_name');
638 foreach (array_intersect_key($cidRefs, $customTables) as $tableName => $cidSpec) {
639 if (in_array('entity_id', $cidSpec, TRUE)) {
640 unset($cidRefs[$tableName][array_search('entity_id', $cidSpec, TRUE)]);
642 if (empty($cidRefs[$tableName])) {
643 unset($cidRefs[$tableName]);
649 * Return an array of tables & fields which hold serialized arrays of contact ids
651 * Return format is ['table_name' => ['field_name' => SERIALIZE_METHOD]]
653 * For now, only custom fields can be serialized and the only
654 * method used is CRM_Core_DAO::SERIALIZE_SEPARATOR_BOOKEND.
656 protected static function getMultiValueCidRefs() {
657 $fields = \Civi\Api4\CustomField
::get(FALSE)
658 ->addSelect('custom_group_id.table_name', 'column_name', 'serialize')
659 ->addWhere('data_type', '=', 'ContactReference')
660 ->addWhere('serialize', 'IS NOT EMPTY')
664 foreach ($fields as $field) {
665 $map[$field['custom_group_id.table_name']][$field['column_name']] = $field['serialize'];
671 * Update the contact with the new parameters.
673 * This function is intended as an interim function, with the intent being
676 * The function was calling the rather-terrifying createProfileContact. I copied all
677 * that code into this function and then removed all the parts that have no effect in this scenario.
679 * @param int $contactID
680 * @param array $params
682 * @throws \CRM_Core_Exception
683 * @throws \CiviCRM_API3_Exception
684 * @throws \Civi\API\Exception\UnauthorizedException
686 protected static function updateContact(int $contactID, $params): void
{
687 // This parameter causes blank fields to be be emptied out.
688 // We can probably remove.
689 $params['updateBlankLocInfo'] = TRUE;
690 $data = self
::formatProfileContactParams($params, $contactID);
691 CRM_Contact_BAO_Contact
::create($data);
695 * Format profile contact parameters.
697 * Note this function has been duplicated from CRM_Contact_BAO_Contact
698 * in order to allow us to unravel all the work this class
699 * does to prepare to call this & create some sanity. Also start to
700 * eliminate a toxic function.
702 * @param array $params
703 * @param int $contactID
707 private static function formatProfileContactParams(
712 $data = $contactDetails = [];
714 // get the contact details (hier)
715 $details = CRM_Contact_BAO_Contact
::getHierContactDetails($contactID, []);
717 $contactDetails = $details[$contactID];
718 $data['contact_type'] = $contactDetails['contact_type'] ??
NULL;
719 $data['contact_sub_type'] = $contactDetails['contact_sub_type'] ??
NULL;
721 //fix contact sub type CRM-5125
722 if (array_key_exists('contact_sub_type', $params) &&
723 !empty($params['contact_sub_type'])
725 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type']);
727 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
728 !empty($params['contact_sub_type_hidden'])
730 // if profile was used, and had any subtype, we obtain it from there
731 //CRM-13596 - add to existing contact types, rather than overwriting
732 if (empty($data['contact_sub_type'])) {
733 // If we don't have a contact ID the $data['contact_sub_type'] will not be defined...
734 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
737 $data_contact_sub_type_arr = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
738 if (!in_array($params['contact_sub_type_hidden'], $data_contact_sub_type_arr)) {
739 //CRM-20517 - make sure contact_sub_type gets the correct delimiters
740 $data['contact_sub_type'] = trim($data['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
);
741 $data['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $data['contact_sub_type'] . CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
750 $data['contact_id'] = $contactID;
751 $primaryLocationType = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactID);
753 $billingLocationTypeId = CRM_Core_BAO_LocationType
::getBilling();
755 $blocks = ['email', 'phone', 'im', 'openid'];
757 $multiplFields = ['url'];
758 // prevent overwritten of formatted array, reset all block from
759 // params if it is not in valid format (since import pass valid format)
760 foreach ($blocks as $blk) {
761 if (array_key_exists($blk, $params) &&
762 !is_array($params[$blk])
764 unset($params[$blk]);
768 $primaryPhoneLoc = NULL;
769 $session = CRM_Core_Session
::singleton();
770 foreach ($params as $key => $value) {
771 [$fieldName, $locTypeId, $typeId] = CRM_Utils_System
::explode('-', $key, 3);
773 if ($locTypeId == 'Primary') {
774 if (in_array($fieldName, $blocks)) {
775 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactID, FALSE, $fieldName);
778 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactID, FALSE, 'address');
780 $primaryLocationType = $locTypeId;
783 if (is_numeric($locTypeId) &&
784 !in_array($fieldName, $multiplFields) &&
785 substr($fieldName, 0, 7) != 'custom_'
789 if (is_numeric($typeId)) {
790 $index .= '-' . $typeId;
792 if (!in_array($index, $locationType)) {
793 $locationType[$count] = $index;
797 $loc = CRM_Utils_Array
::key($index, $locationType);
799 $blockName = self
::getLocationEntityForKey($fieldName);
801 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
803 //set is_billing true, for location type "Billing"
804 if ($locTypeId == $billingLocationTypeId) {
805 $data[$blockName][$loc]['is_billing'] = 1;
809 //get the primary location type
810 if ($locTypeId == $primaryLocationType) {
811 $data[$blockName][$loc]['is_primary'] = 1;
814 elseif ($locTypeId == $defaultLocationId) {
815 $data[$blockName][$loc]['is_primary'] = 1;
818 if (in_array($fieldName, ['phone'])) {
820 $data['phone'][$loc]['phone_type_id'] = $typeId;
823 $data['phone'][$loc]['phone_type_id'] = '';
825 $data['phone'][$loc]['phone'] = $value;
827 //special case to handle primary phone with different phone types
828 // in this case we make first phone type as primary
829 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
830 $primaryPhoneLoc = $loc;
833 if ($loc != $primaryPhoneLoc) {
834 unset($data['phone'][$loc]['is_primary']);
837 elseif ($fieldName == 'email') {
838 $data['email'][$loc]['email'] = $value;
839 if (empty($contactID)) {
840 $data['email'][$loc]['is_primary'] = 1;
843 elseif ($fieldName == 'im') {
844 if (isset($params[$key . '-provider_id'])) {
845 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
847 if (strpos($key, '-provider_id') !== FALSE) {
848 $data['im'][$loc]['provider_id'] = $params[$key];
851 $data['im'][$loc]['name'] = $value;
854 elseif ($fieldName == 'openid') {
855 $data['openid'][$loc]['openid'] = $value;
858 if ($fieldName === 'state_province') {
860 if (is_numeric($value) && ((int ) $value) >= 1000) {
861 $data['address'][$loc]['state_province_id'] = $value;
863 elseif (empty($value)) {
864 $data['address'][$loc]['state_province_id'] = '';
867 $data['address'][$loc]['state_province'] = $value;
870 elseif ($fieldName === 'country') {
872 if (is_numeric($value) && ((int ) $value) >= 1000
874 $data['address'][$loc]['country_id'] = $value;
876 elseif (empty($value)) {
877 $data['address'][$loc]['country_id'] = '';
880 $data['address'][$loc]['country'] = $value;
883 elseif ($fieldName === 'county') {
884 $data['address'][$loc]['county_id'] = $value;
886 elseif ($fieldName == 'address_name') {
887 $data['address'][$loc]['name'] = $value;
889 elseif (substr($fieldName, 0, 14) === 'address_custom') {
890 $data['address'][$loc][substr($fieldName, 8)] = $value;
893 $data[$blockName][$loc][$fieldName] = $value;
898 if (substr($key, 0, 4) === 'url-') {
899 $websiteField = explode('-', $key);
900 $data['website'][$websiteField[1]]['website_type_id'] = $websiteField[1];
901 $data['website'][$websiteField[1]]['url'] = $value;
903 elseif (in_array($key, CRM_Contact_BAO_Contact
::$_greetingTypes, TRUE)) {
904 //save email/postal greeting and addressee values if any, CRM-4575
905 $data[$key . '_id'] = $value;
907 elseif (($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($key))) {
908 // for autocomplete transfer hidden value instead of label
909 if ($params[$key] && isset($params[$key . '_id'])) {
910 $value = $params[$key . '_id'];
913 // we need to append time with date
914 if ($params[$key] && isset($params[$key . '_time'])) {
915 $value .= ' ' . $params[$key . '_time'];
918 // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128
919 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 &&
920 ($value == '' ||
!isset($value))
926 if (!empty($params['customRecordValues'])) {
927 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
928 foreach ($params['customRecordValues'] as $recId => $customFields) {
929 if (is_array($customFields) && !empty($customFields)) {
930 foreach ($customFields as $customFieldName) {
931 if ($customFieldName == $key) {
941 //CRM-13596 - check for contact_sub_type_hidden first
942 if (array_key_exists('contact_sub_type_hidden', $params)) {
943 $type = $params['contact_sub_type_hidden'];
946 $type = $data['contact_type'];
947 if (!empty($data['contact_sub_type'])) {
948 $type = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
952 CRM_Core_BAO_CustomField
::formatCustomField($customFieldId,
962 elseif ($key === 'edit') {
966 if ($key === 'location') {
967 foreach ($value as $locationTypeId => $field) {
968 foreach ($field as $block => $val) {
969 if ($block === 'address' && array_key_exists('address_name', $val)) {
970 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
975 if ($key === 'phone' && isset($params['phone_ext'])) {
976 $data[$key] = $value;
977 foreach ($value as $cnt => $phoneBlock) {
978 if ($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']) {
979 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array
::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
983 elseif (in_array($key, ['nick_name', 'job_title', 'middle_name', 'birth_date', 'gender_id', 'current_employer', 'prefix_id', 'suffix_id'])
984 && ($value == '' ||
!isset($value)) &&
985 ($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 ||
986 ($key === 'current_employer' && empty($params['current_employer']))) {
987 // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value
988 // to avoid update with empty values
992 $data[$key] = $value;
998 if (!isset($data['contact_type'])) {
999 $data['contact_type'] = 'Individual';
1006 * Get the relevant location entity for the array key.
1008 * This function is duplicated from CRM_Contact_BAO_Contact to allow cleanup.
1009 * See self::formatProfileContactParams
1011 * Based on the field name we determine which location entity
1012 * we are dealing with. Apart from a few specific ones they
1013 * are mostly 'address' (the default).
1015 * @param string $fieldName
1019 protected static function getLocationEntityForKey($fieldName) {
1020 if (in_array($fieldName, ['email', 'phone', 'im', 'openid'])) {
1023 if ($fieldName === 'phone_ext') {
1030 * Load all non-empty fields for the contacts
1032 * @param array $main
1034 * @param array $other
1039 * @throws \CRM_Core_Exception
1041 public static function retrieveFields($main, $other) {
1046 foreach (self
::getContactFields() as $validField) {
1047 // CRM-17556 Get all non-empty fields, to make comparison easier
1048 if (!empty($main[$validField]) ||
!empty($other[$validField])) {
1049 $result['contact'][] = $validField;
1053 $mainEvs = CRM_Core_BAO_CustomValueTable
::getEntityValues($main['id']);
1054 $otherEvs = CRM_Core_BAO_CustomValueTable
::getEntityValues($other['id']);
1055 $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs)));
1056 foreach ($keys as $key) {
1057 // Exclude multi-value fields CRM-13836
1058 if (strpos($key, '_')) {
1061 $key1 = $mainEvs[$key] ??
NULL;
1062 $key2 = $otherEvs[$key] ??
NULL;
1063 // We wish to retain '0' as it has a different meaning than NULL on a checkbox.
1064 // However I can't think of a case where an empty string is more meaningful than null
1065 // or where it would be FALSE or something else nullish.
1066 $valuesToIgnore = [NULL, '', []];
1067 if (!in_array($key1, $valuesToIgnore, TRUE) ||
!in_array($key2, $valuesToIgnore, TRUE)) {
1068 $result['custom'][] = $key;
1075 * Batch merge a set of contacts based on rule-group and group.
1081 * @param string $mode
1082 * Helps decide how to behave when there are conflicts.
1083 * A 'safe' value skips the merge if there are any un-resolved conflicts, wheras 'aggressive'
1084 * mode does a force merge.
1085 * @param int $batchLimit number of merges to carry out in one batch.
1086 * @param int $isSelected if records with is_selected column needs to be processed.
1087 * Note the option of '2' is only used in conjunction with $redirectForPerformance
1088 * to determine when to reload the cache (!). The use of anything other than a boolean is being grandfathered
1089 * out in favour of explicitly passing in $reloadCacheIfEmpty
1091 * @param array $criteria
1092 * Criteria to use in the filter.
1094 * @param bool $checkPermissions
1095 * Respect logged in user permissions.
1096 * @param bool|null $reloadCacheIfEmpty
1097 * If not set explicitly this is calculated but it is preferred that it be set
1098 * per comments on isSelected above.
1100 * @param int $searchLimit
1101 * Limit on number of contacts to search for duplicates for.
1102 * This means that if the limit is 1000 then only duplicates for the first 1000 contacts
1103 * matching criteria will be found and batchMerged (the number of merges could be less than or greater than 100)
1105 * @return array|bool
1107 * @throws \CRM_Core_Exception
1108 * @throws \CiviCRM_API3_Exception
1109 * @throws \API_Exception
1111 public static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $batchLimit = 1, $isSelected = 2, $criteria = [], $checkPermissions = TRUE, $reloadCacheIfEmpty = NULL, $searchLimit = 0) {
1112 $redirectForPerformance = $batchLimit > 1;
1113 if ($mode === 'aggressive' && $checkPermissions && !CRM_Core_Permission
::check('force merge duplicate contacts')) {
1114 throw new CRM_Core_Exception(ts('Insufficient permissions for aggressive mode batch merge'));
1116 if (!isset($reloadCacheIfEmpty)) {
1117 $reloadCacheIfEmpty = (!$redirectForPerformance && $isSelected == 2);
1119 if ($isSelected !== 0 && $isSelected !== 1) {
1120 // explicitly set to NULL if not 1 or 0 as part of grandfathering out the mystical '2' value.
1123 $dupePairs = self
::getDuplicatePairs($rgid, $gid, $reloadCacheIfEmpty, $batchLimit, $isSelected, ($mode === 'aggressive'), $criteria, $checkPermissions, $searchLimit);
1126 'cache_key_string' => self
::getMergeCacheKeyString($rgid, $gid, $criteria, $checkPermissions, $searchLimit),
1127 // @todo stop passing these parameters in & instead calculate them in the merge function based
1128 // on the 'real' params like $isRespectExclusions $batchLimit and $isSelected.
1129 'join' => self
::getJoinOnDedupeTable(),
1130 'where' => self
::getWhereString($isSelected),
1131 'limit' => (int) $batchLimit,
1133 return CRM_Dedupe_Merger
::merge($dupePairs, $cacheParams, $mode, $redirectForPerformance, $checkPermissions);
1137 * Get the string to join the prevnext cache to the dedupe table.
1140 * The join string to join prevnext cache on the dedupe table.
1142 public static function getJoinOnDedupeTable() {
1144 LEFT JOIN civicrm_dedupe_exception de
1146 pn.entity_id1 = de.contact_id1
1147 AND pn.entity_id2 = de.contact_id2 )
1152 * Get where string for dedupe join.
1154 * @param bool $isSelected
1158 protected static function getWhereString($isSelected) {
1159 $where = 'de.id IS NULL';
1160 if ($isSelected === 0 ||
$isSelected === 1) {
1161 $where .= " AND pn.is_selected = {$isSelected}";
1167 * Update the statistics for the merge set.
1169 * @param string $cacheKeyString
1170 * @param array $result
1172 * @throws \CiviCRM_API3_Exception
1174 public static function updateMergeStats($cacheKeyString, $result = []) {
1175 // gather latest stats
1176 $merged = count($result['merged']);
1177 $skipped = count($result['skipped']);
1179 if ($merged <= 0 && $skipped <= 0) {
1183 // get previous stats
1184 $previousStats = CRM_Dedupe_Merger
::getMergeStats($cacheKeyString);
1185 if (!empty($previousStats)) {
1186 if ($previousStats['merged']) {
1187 $merged = $merged +
$previousStats['merged'];
1189 if ($previousStats['skipped']) {
1190 $skipped = $skipped +
$previousStats['skipped'];
1195 CRM_Dedupe_Merger
::resetMergeStats($cacheKeyString);
1197 // store the updated stats
1199 'merged' => (int) $merged,
1200 'skipped' => (int) $skipped,
1203 CRM_Core_DAO
::executeQuery("INSERT INTO civicrm_prevnext_cache (entity_table, entity_id1, entity_id2, cacheKey, data) VALUES
1204 ('civicrm_contact', 0, 0, %1, %2)", [1 => [$cacheKeyString . '_stats', 'String'], 2 => [serialize($data), 'String']]);
1208 * Delete information about merges for the given string.
1210 * @param $cacheKeyString
1212 public static function resetMergeStats($cacheKeyString) {
1213 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, "{$cacheKeyString}_stats");
1217 * Get merge outcome statistics.
1219 * @param string $cacheKeyString
1222 * Array of how many were merged and how many were skipped.
1224 * @throws \CiviCRM_API3_Exception
1226 public static function getMergeStats($cacheKeyString) {
1227 $stats = civicrm_api3('Dedupe', 'get', ['cachekey' => "{$cacheKeyString}_stats", 'sequential' => 1])['values'];
1228 if (!empty($stats)) {
1229 return $stats[0]['data'];
1235 * Get merge statistics message.
1237 * @param array $stats
1241 public static function getMergeStatsMsg($stats) {
1243 if (!empty($stats['merged'])) {
1244 $msg = '<p>' . ts('One contact merged.', [
1245 'count' => $stats['merged'],
1246 'plural' => '%count contacts merged.',
1249 if (!empty($stats['skipped'])) {
1250 $msg .= '<p>' . ts('One contact was skipped.', [
1251 'count' => $stats['skipped'],
1252 'plural' => '%count contacts were skipped.',
1259 * Merge given set of contacts. Performs core operation.
1261 * @param array $dupePairs
1262 * Set of pair of contacts for whom merge is to be done.
1263 * @param array $cacheParams
1264 * Prev-next-cache params based on which next pair of contacts are computed.
1265 * Generally used with batch-merge.
1266 * @param string $mode
1267 * Helps decide how to behave when there are conflicts.
1268 * A 'safe' value skips the merge if there are any un-resolved conflicts.
1269 * Does a force merge otherwise (aggressive mode).
1271 * @param bool $redirectForPerformance
1272 * Redirect to a url for batch processing.
1274 * @param bool $checkPermissions
1275 * Respect logged in user permissions.
1277 * @return array|bool
1279 * @throws \API_Exception
1280 * @throws \CRM_Core_Exception
1281 * @throws \CiviCRM_API3_Exception
1283 public static function merge($dupePairs = [], $cacheParams = [], $mode = 'safe',
1284 $redirectForPerformance = FALSE, $checkPermissions = TRUE
1286 $cacheKeyString = $cacheParams['cache_key_string'] ??
NULL;
1287 $resultStats = ['merged' => [], 'skipped' => []];
1289 // we don't want dupe caching to get reset after every-merge, and therefore set the
1290 CRM_Core_Config
::setPermitCacheFlushMode(FALSE);
1291 $deletedContacts = [];
1293 while (!empty($dupePairs)) {
1294 foreach ($dupePairs as $index => $dupes) {
1295 if (in_array($dupes['dstID'], $deletedContacts) ||
in_array($dupes['srcID'], $deletedContacts)) {
1296 unset($dupePairs[$index]);
1299 CRM_Utils_Hook
::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']);
1300 if (($result = self
::dedupePair((int) $dupes['dstID'], (int) $dupes['srcID'], $mode, $checkPermissions, $cacheKeyString)) === FALSE) {
1301 unset($dupePairs[$index]);
1304 if (!empty($result['merged'])) {
1305 $deletedContacts[] = $result['merged'][0]['other_id'];
1306 $resultStats['merged'][] = ($result['merged'][0]);
1309 $resultStats['skipped'][] = ($result['skipped'][0]);
1313 if ($cacheKeyString && !$redirectForPerformance) {
1314 // retrieve next pair of dupes
1315 // @todo call getDuplicatePairs.
1316 $dupePairs = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString,
1317 $cacheParams['join'],
1318 $cacheParams['where'],
1320 $cacheParams['limit'],
1327 // do not proceed. Terminate the loop
1332 CRM_Dedupe_Merger
::updateMergeStats($cacheKeyString, $resultStats);
1333 return $resultStats;
1337 * A function which uses various rules / algorithms for choosing which contact to bias to
1338 * when there's a conflict (to handle "gotchas"). Plus the safest route to merge.
1340 * @param int $mainId
1341 * Main contact with whom merge has to happen.
1342 * @param int $otherId
1343 * Duplicate contact which would be deleted after merge operation.
1344 * @param array $migrationInfo
1345 * Array of information about which elements to merge.
1346 * @param string $mode
1347 * Helps decide how to behave when there are conflicts.
1348 * - A 'safe' value skips the merge if there are any un-resolved conflicts.
1349 * - Does a force merge otherwise (aggressive mode).
1351 * @param array $conflicts
1352 * An empty array to be filed with conflict information.
1356 * @throws \CRM_Core_Exception
1357 * @throws \CiviCRM_API3_Exception
1358 * @throws \API_Exception
1360 public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe', &$conflicts = []) {
1362 $conflicts = self
::getConflicts($migrationInfo, (int) $mainId, (int) $otherId, $mode)['conflicts'];
1363 // A hook could have set skip_merge in order to alter merge behaviour.
1364 // This is a something we might ideally deprecate since they really 'should'
1365 // mess with the conflicts array instead.
1366 return (bool) ($migrationData['skip_merge'] ??
!empty($conflicts));
1370 * Compare 2 addresses to see if they are the effectively the same.
1372 * Being the same would mean same location type and any populated fields that describe the locationn match.
1374 * Metadata fields such as is_primary, on_hold, manual_geocode may differ.
1376 * @param array $mainAddress
1377 * @param array $comparisonAddress
1381 public static function locationIsSame($mainAddress, $comparisonAddress) {
1382 $keysToIgnore = self
::ignoredFields();
1383 foreach ($comparisonAddress as $field => $value) {
1384 if (in_array($field, $keysToIgnore)) {
1387 if ((!empty($value) ||
$value === '0') && isset($mainAddress[$field]) && $mainAddress[$field] != $value) {
1395 * Does the location array have valid data.
1397 * While not UI-creatable some sites wind up with email or address rows with no actual email or address
1398 * through non core-UI processes.
1400 * @param array $location
1404 public static function locationHasData($location) {
1405 return !empty(self
::getLocationDataFields($location));
1409 * Get the location data from a location array, filtering out metadata.
1411 * This returns data like street_address but not metadata like is_primary, on_hold etc.
1413 * @param array $location
1417 public static function getLocationDataFields($location) {
1418 $keysToIgnore = array_merge(self
::ignoredFields(), ['display', 'location_type_id']);
1419 foreach ($location as $field => $value) {
1420 if (in_array($field, $keysToIgnore, TRUE)) {
1421 unset($location[$field]);
1428 * A function to build an array of information about location blocks that is
1429 * required when merging location fields
1433 public static function getLocationBlockInfo() {
1436 'label' => 'Address',
1437 'displayField' => 'display',
1438 'sortString' => 'location_type_id',
1439 'hasLocation' => TRUE,
1444 'displayField' => 'display',
1445 'sortString' => 'location_type_id',
1446 'hasLocation' => TRUE,
1451 'displayField' => 'name',
1452 'sortString' => 'location_type_id,provider_id',
1453 'hasLocation' => TRUE,
1454 'hasType' => 'provider_id',
1458 'displayField' => 'phone',
1459 'sortString' => 'location_type_id,phone_type_id',
1460 'hasLocation' => TRUE,
1461 'hasType' => 'phone_type_id',
1464 'label' => 'Website',
1465 'displayField' => 'url',
1466 'sortString' => 'website_type_id',
1467 'hasLocation' => FALSE,
1468 'hasType' => 'website_type_id',
1474 * A function to build an array of information required by merge function and the merge UI.
1476 * @param int $mainId
1477 * Main contact with whom merge has to happen.
1478 * @param int $otherId
1479 * Duplicate contact which would be deleted after merge operation.
1480 * @param bool $checkPermissions
1481 * Should the logged in user's permissions be ignore. Setting this to false is
1482 * highly risky as it could cause data to be lost due to conflicts not showing up.
1483 * OTOH there is a risk a merger might view custom data they do not have permission to.
1484 * Hence for now only making this really explicit and making it reflect perms in
1487 * @todo review permissions issue!
1489 * @return array|bool|int
1491 * rows => An array of arrays, each is row of merge information for the table
1492 * Format: move_fieldname, eg: move_contact_type
1493 * main => Value associated with the main contact
1494 * other => Value associated with the other contact
1495 * title => The title of the field to display in the merge table
1497 * elements => An array of form elements for the merge UI
1499 * rel_tables => Stores the tables that have related entities for the contact
1500 * for example mailings, groups
1502 * main_details => An array of core contact field values, eg: first_name, etc.
1503 * location_blocks => An array of location block data for the main contact
1504 * stored as the 'result' of an API call.
1505 * eg: main_details['location_blocks']['address'][0]['id']
1506 * eg: main_details['location_blocks']['email'][1]['id']
1508 * other_details => As above, but for the 'other' contact
1510 * migration_info => Stores the 'default' merge actions for each field which
1511 * is used when programatically merging contacts. It contains instructions
1512 * to move all fields from the 'other' contact to the 'main' contact, as
1513 * though the form had been submitted with those options.
1515 * @throws \CRM_Core_Exception
1516 * @throws \CiviCRM_API3_Exception
1518 public static function getRowsElementsAndInfo($mainId, $otherId, $checkPermissions = TRUE) {
1519 $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1520 $fields = self
::getMergeFieldsMetadata();
1522 $main = self
::getMergeContactDetails($mainId);
1523 $other = self
::getMergeContactDetails($otherId);
1525 $compareFields = self
::retrieveFields($main, $other);
1527 $rows = $elements = $migrationInfo = [];
1529 foreach ($compareFields['contact'] as $field) {
1530 if ($field === 'contact_sub_type') {
1531 // CRM-15681 don't display sub-types in UI
1534 $rows["move_$field"] = [
1535 'main' => self
::getFieldValueAndLabel($field, $main)['label'],
1536 'other' => self
::getFieldValueAndLabel($field, $other)['label'],
1537 'title' => $fields[$field]['html']['label'] ??
$fields[$field]['title'],
1540 $value = self
::getFieldValueAndLabel($field, $other)['value'];
1542 if ($value === NULL ||
$value == '') {
1545 if ($value === 0 or $value === '0') {
1546 $value = $qfZeroBug;
1548 if (is_array($value) && empty($value[1])) {
1552 // Display a checkbox to migrate, only if the values are different
1553 if ($value != $main[$field]) {
1561 'is_checked' => (!isset($main[$field]) ||
$main[$field] === ''),
1565 $migrationInfo["move_$field"] = $value;
1568 // Handle location blocks.
1569 // @todo OpenID not in API yet, so is not supported here.
1571 // Set up useful information about the location blocks
1572 $locationBlocks = self
::getLocationBlockInfo();
1574 $locations = ['main' => [], 'other' => []];
1576 foreach ($locationBlocks as $blockName => $blockInfo) {
1577 [$locations, $rows, $elements, $migrationInfo] = self
::addLocationFieldInfo($mainId, $otherId, $blockInfo, $blockName, $locations, $rows, $elements, $migrationInfo);
1578 } // End loop through each location block entity
1580 // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1581 $mergeHandler = new CRM_Dedupe_MergeHandler((int) $mainId, (int) $otherId);
1582 $relTables = $mergeHandler->getTablesRelatedToTheMergePair();
1583 foreach ($relTables as $name => $null) {
1584 $migrationInfo["move_$name"] = 1;
1586 $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']);
1587 $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']);
1588 if ($name === 'rel_table_users') {
1589 // @todo - this user url stuff is only needed for the form layer - move to CRM_Contact_Form_Merge
1590 $relTables[$name]['main_url'] = str_replace('%ufid', CRM_Core_BAO_UFMatch
::getUFId($mainId), $relTables[$name]['url']);
1591 $relTables[$name]['other_url'] = str_replace('%ufid', CRM_Core_BAO_UFMatch
::getUFId($otherId), $relTables[$name]['url']);
1593 if ($name === 'rel_table_memberships') {
1594 //Enable 'add new' checkbox if main contact does not contain any membership similar to duplicate contact.
1595 $attributes = ['checked' => 'checked'];
1596 $otherContactMemberships = CRM_Member_BAO_Membership
::getAllContactMembership($otherId);
1597 foreach ($otherContactMemberships as $membership) {
1598 $mainMembership = CRM_Member_BAO_Membership
::getContactMembership($mainId, $membership['membership_type_id'], FALSE);
1599 if ($mainMembership) {
1605 "operation[move_{$name}][add]",
1610 $migrationInfo["operation"]["move_{$name}"]['add'] = 1;
1613 foreach ($relTables as $name => $null) {
1614 $relTables["move_$name"] = $relTables[$name];
1615 unset($relTables[$name]);
1618 // handle custom fields
1619 $mainTree = CRM_Core_BAO_CustomGroup
::getTree($main['contact_type'], NULL, $mainId, -1,
1620 CRM_Utils_Array
::value('contact_sub_type', $main), NULL, TRUE, NULL, TRUE,
1621 $checkPermissions ? CRM_Core_Permission
::EDIT
: FALSE
1623 $otherTree = CRM_Core_BAO_CustomGroup
::getTree($main['contact_type'], NULL, $otherId, -1,
1624 CRM_Utils_Array
::value('contact_sub_type', $other), NULL, TRUE, NULL, TRUE,
1625 $checkPermissions ? CRM_Core_Permission
::EDIT
: FALSE
1628 foreach ($otherTree as $gid => $group) {
1629 if (!isset($group['fields'])) {
1633 foreach ($group['fields'] as $fid => $field) {
1634 $mainContactValue = $mainTree[$gid]['fields'][$fid]['customValue'] ??
NULL;
1635 $otherContactValue = $otherTree[$gid]['fields'][$fid]['customValue'] ??
NULL;
1636 if (in_array($fid, $compareFields['custom'])) {
1637 $rows["custom_group_$gid"]['title'] = $rows["custom_group_$gid"]['title'] ??
$group['title'];
1639 if ($mainContactValue) {
1640 foreach ($mainContactValue as $valueId => $values) {
1641 $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomField
::displayValue($values['data'], $fid);
1645 if ($otherContactValue) {
1646 foreach ($otherContactValue as $valueId => $values) {
1647 $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomField
::displayValue($values['data'], $fid);
1648 if ($values['data'] === 0 ||
$values['data'] === '0') {
1649 $values['data'] = $qfZeroBug;
1651 $value = ($values['data']) ?
$values['data'] : $value;
1654 $rows["move_custom_$fid"]['title'] = $field['label'];
1658 1 => "move_custom_$fid",
1663 'is_checked' => (!isset($rows["move_custom_$fid"]['main']) ||
$rows["move_custom_$fid"]['main'] === ''),
1665 $migrationInfo["move_custom_$fid"] = $value;
1672 'elements' => $elements,
1673 'rel_tables' => $relTables,
1674 'main_details' => $main,
1675 'other_details' => $other,
1676 'migration_info' => $migrationInfo,
1679 $result['main_details']['location_blocks'] = $locations['main'];
1680 $result['other_details']['location_blocks'] = $locations['other'];
1686 * Based on the provided two contact_ids and a set of tables, move the belongings of the
1687 * other contact to the main one - be it Location / CustomFields or Contact .. related info.
1688 * A superset of moveContactBelongings() function.
1690 * @param int $mainId
1691 * Main contact with whom merge has to happen.
1692 * @param int $otherId
1693 * Duplicate contact which would be deleted after merge operation.
1695 * @param array $migrationInfo
1697 * @param bool $checkPermissions
1698 * Respect logged in user permissions.
1702 * @throws \API_Exception
1703 * @throws \CRM_Core_Exception
1704 * @throws \CiviCRM_API3_Exception
1705 * @throws \Civi\API\Exception\UnauthorizedException
1707 public static function moveAllBelongings($mainId, $otherId, $migrationInfo, $checkPermissions = TRUE) {
1708 if (empty($migrationInfo)) {
1711 // Encapsulate in a transaction to avoid half-merges.
1712 $transaction = new CRM_Core_Transaction();
1714 $contactType = $migrationInfo['main_details']['contact_type'];
1715 $relTables = CRM_Dedupe_Merger
::relTables();
1716 $submittedCustomFields = $moveTables = $tableOperations = $removeTables = [];
1718 self
::swapOutFieldsAffectedByQFZeroBug($migrationInfo);
1719 foreach ($migrationInfo as $key => $value) {
1721 if (substr($key, 0, 12) === 'move_custom_' && $value != NULL) {
1722 $submitted[substr($key, 5)] = $value;
1723 $submittedCustomFields[] = substr($key, 12);
1725 elseif (in_array(substr($key, 5), CRM_Dedupe_Merger
::getContactFields()) && $value != NULL) {
1726 $submitted[substr($key, 5)] = $value;
1728 elseif (substr($key, 0, 15) === 'move_rel_table_' and $value == '1') {
1729 $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1730 if (array_key_exists('operation', $migrationInfo)) {
1731 foreach ($relTables[substr($key, 5)]['tables'] as $table) {
1732 if (array_key_exists($key, $migrationInfo['operation'])) {
1733 $tableOperations[$table] = $migrationInfo['operation'][$key];
1738 elseif (substr($key, 0, 15) === 'move_rel_table_' and $value == '0') {
1739 $removeTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1742 $mergeHandler = new CRM_Dedupe_MergeHandler((int) $mainId, (int) $otherId);
1743 $mergeHandler->setMigrationInfo($migrationInfo);
1744 $mergeHandler->mergeLocations();
1746 // **** Do contact related migrations
1747 // @todo - move all custom field processing to the move class & eventually have an
1748 // overridable DAO class for it.
1749 $customFieldBAO = new CRM_Core_BAO_CustomField();
1750 $customFieldBAO->move($otherId, $mainId, $submittedCustomFields);
1751 // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1753 CRM_Dedupe_Merger
::moveContactBelongings($mergeHandler, $moveTables, $tableOperations);
1754 unset($moveTables, $tableOperations);
1756 // **** Do table related removals
1757 if (!empty($removeTables)) {
1759 CRM_Dedupe_Merger
::removeContactBelongings($otherId, $removeTables);
1763 // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact()
1764 $names['gender'] = ['newName' => 'gender_id', 'groupName' => 'gender'];
1765 $names['individual_prefix'] = [
1766 'newName' => 'prefix_id',
1767 'groupName' => 'individual_prefix',
1769 $names['individual_suffix'] = [
1770 'newName' => 'suffix_id',
1771 'groupName' => 'individual_suffix',
1773 $names['communication_style'] = [
1774 'newName' => 'communication_style_id',
1775 'groupName' => 'communication_style',
1777 $names['addressee'] = [
1778 'newName' => 'addressee_id',
1779 'groupName' => 'addressee',
1781 $names['email_greeting'] = [
1782 'newName' => 'email_greeting_id',
1783 'groupName' => 'email_greeting',
1785 $names['postal_greeting'] = [
1786 'newName' => 'postal_greeting_id',
1787 'groupName' => 'postal_greeting',
1789 CRM_Core_OptionGroup
::lookupValues($submitted, $names, TRUE);
1790 // fix custom fields so they're edible by createProfileContact()
1791 $cFields = self
::getCustomFieldMetadata($contactType);
1793 if (!isset($submitted)) {
1796 foreach ($submitted as $key => $value) {
1797 [$cFields, $submitted] = self
::processCustomFields($mainId, $key, $cFields, $submitted, $value);
1800 // move view only custom fields CRM-5362
1801 $viewOnlyCustomFields = [];
1802 foreach ($submitted as $key => $value) {
1803 $fid = CRM_Core_BAO_CustomField
::getKeyID($key);
1804 if ($fid && array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])
1806 $viewOnlyCustomFields[$key] = $value;
1809 // special case to set values for view only, CRM-5362
1810 if (!empty($viewOnlyCustomFields)) {
1811 $viewOnlyCustomFields['entityID'] = $mainId;
1812 CRM_Core_BAO_CustomValueTable
::setValues($viewOnlyCustomFields);
1815 // dev/core#996 Ensure that the earliest created date is stored against the kept contact id
1816 $mainCreatedDate = civicrm_api3('Contact', 'getsingle', [
1818 'return' => ['created_date'],
1820 $otherCreatedDate = civicrm_api3('Contact', 'getsingle', [
1822 'return' => ['created_date'],
1824 if ($otherCreatedDate < $mainCreatedDate && !empty($otherCreatedDate)) {
1825 CRM_Core_DAO
::executeQuery("UPDATE civicrm_contact SET created_date = %1 WHERE id = %2", [
1826 1 => [$otherCreatedDate, 'String'],
1827 2 => [$mainId, 'Positive'],
1831 if (!$checkPermissions ||
(CRM_Core_Permission
::check('merge duplicate contacts') &&
1832 CRM_Core_Permission
::check('delete contacts'))
1834 // if ext id is submitted then set it null for contact to be deleted
1835 if (!empty($submitted['external_identifier'])) {
1836 $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}";
1837 CRM_Core_DAO
::executeQuery($query);
1839 civicrm_api3('contact', 'delete', ['id' => $otherId]);
1842 // CRM-15681 merge sub_types
1843 if ($other_sub_types = CRM_Utils_Array
::value('contact_sub_type', $migrationInfo['other_details'])) {
1844 if ($main_sub_types = CRM_Utils_Array
::value('contact_sub_type', $migrationInfo['main_details'])) {
1845 $submitted['contact_sub_type'] = array_unique(array_merge($main_sub_types, $other_sub_types));
1848 $submitted['contact_sub_type'] = $other_sub_types;
1852 // **** Update contact related info for the main contact
1853 if (!empty($submitted)) {
1854 $submitted['contact_id'] = $mainId;
1856 //update current employer field
1857 if ($currentEmloyerId = CRM_Utils_Array
::value('current_employer_id', $submitted)) {
1858 if (!CRM_Utils_System
::isNull($currentEmloyerId)) {
1859 $submitted['current_employer'] = $submitted['current_employer_id'];
1862 $submitted['current_employer'] = '';
1864 unset($submitted['current_employer_id']);
1867 //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name
1868 if (!isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id'])) {
1869 $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id'];
1871 if (!isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id'])) {
1872 $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id'];
1874 self
::updateContact($mainId, $submitted);
1876 $transaction->commit();
1877 CRM_Utils_Hook
::post('merge', 'Contact', $mainId);
1878 self
::createMergeActivities($mainId, $otherId);
1884 * Get fields in the contact table suitable for merging.
1887 * Array of field names to be potentially merged.
1889 public static function getContactFields() {
1890 $contactFields = CRM_Contact_DAO_Contact
::fields();
1898 'primary_contact_id',
1902 foreach ($contactFields as $field => $value) {
1903 if (in_array($field, $invalidFields)) {
1904 unset($contactFields[$field]);
1907 return array_keys($contactFields);
1911 * Added for CRM-12695
1912 * Based on the contactID provided
1913 * add/update membership(s) to related contacts
1915 * @param int $contactID
1917 * @throws \CRM_Core_Exception
1918 * @throws \CiviCRM_API3_Exception
1920 public static function addMembershipToRelatedContacts($contactID) {
1921 $dao = new CRM_Member_DAO_Membership();
1922 $dao->contact_id
= $contactID;
1926 //checks membership of contact itself
1927 while ($dao->fetch()) {
1928 $relationshipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id
, 'relationship_type_id', 'id');
1929 if ($relationshipTypeId) {
1930 $membershipParams = [
1932 'contact_id' => $dao->contact_id
,
1933 'membership_type_id' => $dao->membership_type_id
,
1934 'join_date' => CRM_Utils_Date
::isoToMysql($dao->join_date
),
1935 'start_date' => CRM_Utils_Date
::isoToMysql($dao->start_date
),
1936 'end_date' => CRM_Utils_Date
::isoToMysql($dao->end_date
),
1937 'source' => $dao->source
,
1938 'status_id' => $dao->status_id
,
1940 // create/update membership(s) for related contact(s)
1941 CRM_Member_BAO_Membership
::createRelatedMemberships($membershipParams, $dao);
1942 } // end of if relationshipTypeId
1947 * Create activities tracking the merge on affected contacts.
1949 * @param int $mainId
1950 * @param int $otherId
1952 * @throws \CiviCRM_API3_Exception
1954 public static function createMergeActivities($mainId, $otherId) {
1959 $activity = civicrm_api3('activity', 'create', [
1960 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() :
1962 'subject' => ts('Contact ID %1 has been merged and deleted.', $params),
1963 'target_contact_id' => $mainId,
1964 'activity_type_id' => 'Contact Merged',
1965 'status_id' => 'Completed',
1967 if (civicrm_api3('Setting', 'getvalue', [
1968 'name' => 'contact_undelete',
1969 'group' => 'CiviCRM Preferences',
1971 civicrm_api3('activity', 'create', [
1972 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() :
1974 'subject' => ts('Contact ID %1 has been merged into Contact ID %2 and deleted.', $params),
1975 'target_contact_id' => $otherId,
1976 'activity_type_id' => 'Contact Deleted by Merge',
1977 'parent_id' => $activity['id'],
1978 'status_id' => 'Completed',
1984 * Get Duplicate Pairs based on a rule for a group.
1986 * @param int $rule_group_id
1987 * @param int $group_id
1988 * @param bool $reloadCacheIfEmpty
1989 * Should the cache be reloaded if empty - this must be false when in a dedupe action!
1990 * @param int $batchLimit
1991 * @param bool $isSelected
1992 * Limit to selected pairs.
1993 * @param bool $includeConflicts
1994 * @param array $criteria
1995 * Additional criteria to narrow down the merge group.
1997 * @param bool $checkPermissions
1998 * Respect logged in user permissions.
2000 * @param int $searchLimit
2001 * Limit to searching for matches against this many contacts.
2003 * @param int $isForceNewSearch
2004 * Should a new search be forced, bypassing any cache retrieval.
2007 * Array of matches meeting the criteria.
2009 * @throws \CRM_Core_Exception
2010 * @throws \CiviCRM_API3_Exception
2012 public static function getDuplicatePairs($rule_group_id, $group_id, $reloadCacheIfEmpty, $batchLimit, $isSelected, $includeConflicts = TRUE, $criteria = [], $checkPermissions = TRUE, $searchLimit = 0, $isForceNewSearch = 0) {
2013 $dupePairs = $isForceNewSearch ?
[] : self
::getCachedDuplicateMatches($rule_group_id, $group_id, $batchLimit, $isSelected, $includeConflicts, $criteria, $checkPermissions, $searchLimit);
2014 if (empty($dupePairs) && $reloadCacheIfEmpty) {
2015 // If we haven't found any dupes, probably cache is empty.
2016 // Try filling cache and give another try. We don't need to specify include conflicts here are there will not be any
2017 // until we have done some processing.
2018 CRM_Core_BAO_PrevNextCache
::refillCache($rule_group_id, $group_id, $criteria, $checkPermissions, $searchLimit);
2019 return self
::getCachedDuplicateMatches($rule_group_id, $group_id, $batchLimit, $isSelected, FALSE, $criteria, $checkPermissions, $searchLimit);
2025 * Get the cache key string for the merge action.
2027 * @param int $rule_group_id
2028 * @param int $group_id
2029 * @param array $criteria
2030 * Additional criteria to narrow down the merge group.
2031 * Currently we are only supporting the key 'contact' within it.
2032 * @param bool $checkPermissions
2033 * Respect the users permissions.
2034 * @param int $searchLimit
2035 * Number of contacts to seek dupes for (we need this because if
2036 * we change it the results won't be refreshed otherwise. Changing the limit
2037 * from 100 to 1000 SHOULD result in a new dedupe search).
2041 public static function getMergeCacheKeyString($rule_group_id, $group_id, $criteria, $checkPermissions, $searchLimit) {
2042 $contactType = CRM_Dedupe_BAO_DedupeRuleGroup
::getContactTypeForRuleGroup($rule_group_id);
2043 $cacheKeyString = "merge_{$contactType}";
2044 $cacheKeyString .= $rule_group_id ?
"_{$rule_group_id}" : '_0';
2045 $cacheKeyString .= $group_id ?
"_{$group_id}" : '_0';
2046 $cacheKeyString .= '_' . (int) $searchLimit;
2047 $cacheKeyString .= !empty($criteria) ?
md5(serialize($criteria)) : '_0';
2048 if ($checkPermissions) {
2049 $contactID = CRM_Core_Session
::getLoggedInContactID();
2051 // Distinguish between no permission check & no logged in user.
2052 $contactID = 'null';
2054 $cacheKeyString .= '_' . $contactID;
2057 $cacheKeyString .= '_0';
2059 return $cacheKeyString;
2063 * Get the metadata for the merge fields.
2065 * This is basically the contact metadata, augmented with fields to
2066 * represent email greeting, postal greeting & addressee.
2070 public static function getMergeFieldsMetadata() {
2071 if (isset(\Civi
::$statics[__CLASS__
]) && isset(\Civi
::$statics[__CLASS__
]['merge_fields_metadata'])) {
2072 return \Civi
::$statics[__CLASS__
]['merge_fields_metadata'];
2074 $fields = CRM_Contact_DAO_Contact
::fields();
2075 static $optionValueFields = [];
2076 if (empty($optionValueFields)) {
2077 $optionValueFields = CRM_Core_OptionValue
::getFields();
2079 foreach ($optionValueFields as $field => $params) {
2080 $fields[$field]['title'] = $params['title'];
2082 \Civi
::$statics[__CLASS__
]['merge_fields_metadata'] = $fields;
2083 return \Civi
::$statics[__CLASS__
]['merge_fields_metadata'];
2087 * Get the details of the contact to be merged.
2089 * @param int $contact_id
2093 * @throws CRM_Core_Exception
2095 public static function getMergeContactDetails($contact_id) {
2097 'contact_id' => $contact_id,
2099 'return' => array_merge(['display_name'], self
::getContactFields()),
2101 $result = civicrm_api('contact', 'get', $params);
2103 // CRM-18480: Cancel the process if the contact is already deleted
2104 if (isset($result['values'][$contact_id]['contact_is_deleted']) && !empty($result['values'][$contact_id]['contact_is_deleted'])) {
2105 throw new CRM_Core_Exception(ts('Cannot merge because one contact (ID %1) has been deleted.', [
2110 return $result['values'][$contact_id];
2114 * Dedupe a pair of contacts.
2116 * @param int $mainId Id of contact to keep.
2117 * @param int $otherId Id of contact to delete.
2118 * @param string $mode
2119 * @param bool $checkPermissions
2120 * @param string $cacheKeyString
2122 * @return bool|array
2123 * @throws \API_Exception
2124 * @throws \CRM_Core_Exception
2125 * @throws \CRM_Core_Exception_ResourceConflictException
2126 * @throws \CiviCRM_API3_Exception
2127 * @throws \Civi\API\Exception\UnauthorizedException
2129 protected static function dedupePair(int $mainId, int $otherId, $mode = 'safe', $checkPermissions = TRUE, $cacheKeyString = NULL) {
2132 $migrationInfo = [];
2134 // Try to lock the contacts before we load the data as we don't want it changing under us.
2135 // https://lab.civicrm.org/dev/core/issues/1355
2136 $locks = self
::getLocksOnContacts([$mainId, $otherId]);
2137 if (!CRM_Dedupe_Merger
::skipMerge($mainId, $otherId, $migrationInfo, $mode, $conflicts)) {
2138 CRM_Dedupe_Merger
::moveAllBelongings($mainId, $otherId, $migrationInfo, $checkPermissions);
2139 $resultStats['merged'][] = [
2140 'main_id' => $mainId,
2141 'other_id' => $otherId,
2145 $resultStats['skipped'][] = [
2146 'main_id' => $mainId,
2147 'other_id' => $otherId,
2151 // store any conflicts
2152 if (!empty($conflicts)) {
2153 CRM_Core_BAO_PrevNextCache
::markConflict($mainId, $otherId, $cacheKeyString, $conflicts, $mode);
2156 self
::deletePairFromPrevNextCache((int) $mainId, (int) $otherId);
2158 self
::releaseLocks($locks);
2159 return $resultStats;
2163 * Delete merged pair from the previous next cache table as the are no longer a merge candidate.
2165 * It's possible there may be more than one set of merge results cached, with different cache keys.
2166 * Once we have merged a pair these should all go (even from a different merge search) as they
2167 * can only be merged once.
2169 * @param int $contactID1
2170 * @param int $contactID2
2172 protected static function deletePairFromPrevNextCache(int $contactID1, int $contactID2) {
2173 CRM_Core_DAO
::executeQuery("
2174 DELETE FROM civicrm_prevnext_cache
2175 WHERE entity_table = 'civicrm_contact'
2176 AND (entity_id1 = %1 AND entity_id2 = %2) OR (entity_id1 = %2 AND entity_id2 = %1)",
2177 [1 => [$contactID1, 'Integer'], 2 => [$contactID2, 'Integer']]
2182 * Replace the pseudo QFKey with zero if it is present.
2184 * @todo - on the slim chance this is still relevant it should be moved to the form layer.
2186 * Details about this bug are somewhat obscured by the move from svn but perhaps JIRA
2189 * @param array $migrationInfo
2191 protected static function swapOutFieldsAffectedByQFZeroBug(&$migrationInfo) {
2192 $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
2193 foreach ($migrationInfo as $key => &$value) {
2194 if ($value === $qfZeroBug) {
2201 * Honestly - what DOES this do - hopefully some refactoring will reveal it's purpose.
2203 * Update this function formats fields in preparation for them to be submitted to the
2204 * 'ProfileContactCreate action. This is a lot of code to do this & for
2205 * - for some fields it fails - e.g Country - per testMergeCustomFields.
2207 * Goal is to move all custom field handling into 'move' functions on the various BAO
2208 * with an underlying DAO function. For custom fields it has been started on the BAO.
2210 * @param int $mainId
2211 * @param string $key
2212 * @param array $cFields
2213 * @param array $submitted
2214 * @param mixed $value
2217 * @throws \CRM_Core_Exception
2219 protected static function processCustomFields($mainId, $key, $cFields, $submitted, $value) {
2220 if (substr($key, 0, 7) === 'custom_') {
2221 $fid = (int) substr($key, 7);
2222 if (empty($cFields[$fid])) {
2223 return [$cFields, $submitted];
2225 $htmlType = $cFields[$fid]['attributes']['html_type'];
2226 $isSerialized = CRM_Core_BAO_CustomField
::isSerialized($cFields[$fid]['attributes']);
2228 if ($htmlType === 'File') {
2229 // Handled in CustomField->move(). Tested in testMergeCustomFields.
2230 unset($submitted["custom_$fid"]);
2232 elseif (!$isSerialized && ($htmlType === 'Select Country' ||
$htmlType === 'Select State/Province')) {
2233 // @todo Test in testMergeCustomFields disabled as this does not work, Handle in CustomField->move().
2234 $submitted[$key] = CRM_Core_BAO_CustomField
::displayValue($value, $fid);
2236 elseif ($htmlType === 'Select Date') {
2237 if ($cFields[$fid]['attributes']['is_view']) {
2238 $submitted[$key] = date('YmdHis', strtotime($submitted[$key]));
2241 elseif ($isSerialized) {
2242 // Merge values from both contacts for multivalue fields, CRM-4385
2243 // get the existing custom values from db.
2244 $customParams = ['entityID' => $mainId, $key => TRUE];
2245 $customfieldValues = CRM_Core_BAO_CustomValueTable
::getValues($customParams);
2246 if (!empty($customfieldValues[$key])) {
2247 $existingValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $customfieldValues[$key]);
2248 if (is_array($existingValue) && !empty($existingValue)) {
2249 $mergeValue = $submittedCustomFields = [];
2250 if ($value === 'null') {
2251 // CRM-19074 if someone has deliberately chosen to overwrite with 'null', respect it.
2252 $submitted[$key] = $value;
2256 $submittedCustomFields = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
2259 // CRM-19653: overwrite or add the existing custom field value with dupicate contact's
2260 // custom field value stored at $submittedCustomValue.
2261 foreach ($submittedCustomFields as $k => $v) {
2262 if ($v != '' && !in_array($v, $mergeValue)) {
2267 //keep state and country as array format.
2268 //for checkbox and m-select format w/ VALUE_SEPARATOR
2269 if (in_array($htmlType, ['CheckBox', 'Select'])) {
2270 $submitted[$key] = CRM_Utils_Array
::implodePadded($mergeValue);
2273 $submitted[$key] = $mergeValue;
2278 elseif (in_array($htmlType, ['Select Country', 'Select State/Province'])) {
2279 //we require submitted values should be in array format
2281 $mergeValueArray = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
2282 //hack to remove null values from array.
2284 foreach ($mergeValueArray as $k => $v) {
2289 $submitted[$key] = $mergeValue;
2294 return [$cFields, $submitted];
2298 * Get metadata for the custom fields for the merge.
2300 * @param string $contactType
2303 * @throws \CRM_Core_Exception
2305 protected static function getCustomFieldMetadata($contactType) {
2307 if (!array_key_exists($contactType, $treeCache)) {
2308 $treeCache[$contactType] = CRM_Core_BAO_CustomGroup
::getTree(
2323 foreach ($treeCache[$contactType] as $key => $group) {
2324 if (!isset($group['fields'])) {
2327 foreach ($group['fields'] as $fid => $field) {
2328 $cFields[$fid]['attributes'] = $field;
2335 * Get conflicts for proposed merge pair.
2337 * @param array $migrationInfo
2338 * This is primarily to inform hooks. The can also modify it which feels
2339 * pretty fragile to do it here - but it is historical.
2340 * @param int $mainId
2341 * Main contact with whom merge has to happen.
2342 * @param int $otherId
2343 * Duplicate contact which would be deleted after merge operation.
2344 * @param string $mode
2345 * Helps decide how to behave when there are conflicts.
2346 * - A 'safe' value skips the merge if there are any un-resolved conflicts.
2347 * - Does a force merge otherwise (aggressive mode).
2351 * @throws \CRM_Core_Exception
2352 * @throws \CiviCRM_API3_Exception
2354 public static function getConflicts(array &$migrationInfo, int $mainId, int $otherId, string $mode): array {
2356 // Generate var $migrationInfo. The variable structure is exactly same as
2357 // $formValues submitted during a UI merge for a pair of contacts.
2358 $rowsElementsAndInfo = CRM_Dedupe_Merger
::getRowsElementsAndInfo($mainId, $otherId, FALSE);
2359 // add additional details that we might need to resolve conflicts
2360 $migrationInfo = $rowsElementsAndInfo['migration_info'];
2361 $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details'];
2362 $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details'];
2363 $migrationInfo['rows'] = &$rowsElementsAndInfo['rows'];
2364 // go ahead with merge if there is no conflict
2365 $originalMigrationInfo = $migrationInfo;
2366 foreach ($migrationInfo as $key => $val) {
2367 if ($val === "null") {
2368 // Rule: Never overwrite with an empty value (in any mode)
2369 unset($migrationInfo[$key]);
2372 elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger
::getContactFields()) or
2373 strpos($key, 'move_custom_') === 0
2376 // Rule: If both main-contact, and other-contact have a field with a
2377 // different value, then let $mode decide if to merge it or not
2379 (!empty($migrationInfo['rows'][$key]['main'])
2380 // For custom fields a 0 (e.g in an int field) could be a true conflict. This
2381 // is probably true for other fields too - e.g. 'do_not_email' but
2382 // leaving that investigation as a @todo - until tests can be written.
2383 // Note the handling of this has test coverage - although the data-typing
2384 // of '0' feels flakey we have insurance.
2385 ||
($migrationInfo['rows'][$key]['main'] === '0' && substr($key, 0, 12) === 'move_custom_')
2387 && $migrationInfo['rows'][$key]['main'] != $migrationInfo['rows'][$key]['other']
2390 // note it down & lets wait for response from the hook.
2391 // For no response $mode will decide if to skip this merge
2392 $conflicts[$key] = NULL;
2395 elseif (substr($key, 0, 14) === 'move_location_' and $val != NULL) {
2396 $locField = explode('_', $key);
2397 $fieldName = $locField[2];
2398 $fieldCount = $locField[3];
2400 // Rule: Catch address conflicts (same address type on both contacts)
2402 isset($migrationInfo['main_details']['location_blocks'][$fieldName]) &&
2403 !empty($migrationInfo['main_details']['location_blocks'][$fieldName])
2406 // Load the address we're inspecting from the 'other' contact
2407 $addressRecord = $migrationInfo['other_details']['location_blocks'][$fieldName][$fieldCount];
2408 $addressRecordLocTypeId = $addressRecord['location_type_id'] ??
NULL;
2410 // If it exists on the 'main' contact already, skip it. Otherwise
2411 // if the location type exists already, log a conflict.
2412 foreach ($migrationInfo['main_details']['location_blocks'][$fieldName] as $mainAddressKey => $mainAddressRecord) {
2413 if (!self
::locationHasData($mainAddressRecord)) {
2414 // Go ahead & overwrite the main address - it has no data in it.
2415 // if it is the primary address then pass that honour to the address that actually has data.
2416 $migrationInfo['location_blocks'][$fieldName][$mainAddressKey]['set_other_primary'] = $mainAddressRecord['is_primary'];
2419 if (self
::locationIsSame($addressRecord, $mainAddressRecord)) {
2420 unset($migrationInfo[$key]);
2423 if ($addressRecordLocTypeId == $mainAddressRecord['location_type_id']) {
2424 $conflicts[$key] = NULL;
2430 // For other locations, don't merge/add if the values are the same
2431 elseif (CRM_Utils_Array
::value('main', $migrationInfo['rows'][$key]) == $migrationInfo['rows'][$key]['other']) {
2432 unset($migrationInfo[$key]);
2437 // A hook to implement other algorithms for choosing which contact to bias to when
2438 // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here
2439 // merge happens with new values filled in here. For a particular field / row not to be merged
2440 // field should be unset from fields_in_conflict.
2442 'old_migration_info' => $originalMigrationInfo,
2444 'fields_in_conflict' => $conflicts,
2445 'merge_mode' => $mode,
2446 'migration_info' => $migrationInfo,
2448 CRM_Utils_Hook
::merge('batch', $migrationData, $mainId, $otherId);
2449 $conflicts = $migrationData['fields_in_conflict'];
2450 // allow hook to override / manipulate migrationInfo as well
2451 $migrationInfo = $migrationData['migration_info'];
2452 foreach ($conflicts as $key => $val) {
2453 // Copy over the resolved values. If we are in aggressive mode we update to null
2454 // so as not to copy over. Why it's different to safe mode is a bit murky.
2455 // Working theory is it doesn't matter what we do in safe mode here if $val is NULL.
2456 // as the merge is not gonna happen if $val == NULL
2457 $migrationInfo[$key] = $val ??
($mode === 'safe' ?
$migrationInfo[$key] : NULL);
2459 return self
::formatConflictArray($conflicts, $migrationInfo['rows'], $migrationInfo['main_details']['location_blocks'], $migrationInfo['other_details']['location_blocks'], $mainId, $otherId, $mode);
2463 * @param array $conflicts
2464 * @param array $migrationInfo
2465 * @param $toKeepContactLocationBlocks
2466 * @param $toRemoveContactLocationBlocks
2468 * @param $toRemoveID
2469 * @param string $mode
2472 * @throws \CRM_Core_Exception
2474 protected static function formatConflictArray($conflicts, $migrationInfo, $toKeepContactLocationBlocks, $toRemoveContactLocationBlocks, $toKeepID, $toRemoveID, $mode) {
2477 foreach ($conflicts as $key => $val) {
2478 if ($val !== NULL) {
2479 // copy over the resolved values
2480 $resolved[$key] = $val;
2481 unset($conflicts[$key]);
2483 elseif ($mode === 'aggressive') {
2484 unset($conflicts[$key]);
2485 if (strpos($key, 'move_location_') !== 0) {
2486 // @todo - just handling plain contact fields for now because I think I need a bigger refactor
2487 // of the below to handle locations & will do as a follow up.
2488 $resolved['contact'][substr($key, 5)] = $migrationInfo[$key]['main'];
2492 foreach (array_keys($conflicts) as $index) {
2493 if (substr($index, 0, 14) === 'move_location_') {
2494 $parts = explode('_', $index);
2495 $entity = $parts[2];
2496 $blockIndex = $parts[3];
2497 $locationTypeID = $toKeepContactLocationBlocks[$entity][$blockIndex]['location_type_id'];
2498 $entityConflicts = [
2499 'location_type_id' => $locationTypeID,
2500 'title' => $migrationInfo[$index]['title'],
2502 foreach ($toKeepContactLocationBlocks[$entity][$blockIndex] as $fieldName => $fieldValue) {
2503 if (in_array($fieldName, self
::ignoredFields())) {
2506 $toRemoveValue = $toRemoveContactLocationBlocks[$entity][$blockIndex][$fieldName] ??
NULL;
2507 if ($fieldValue !== $toRemoveValue) {
2508 $entityConflicts[$fieldName] = [
2509 $toKeepID => $fieldValue,
2510 $toRemoveID => $toRemoveValue,
2514 $return[$entity][] = $entityConflicts;
2516 elseif (substr($index, 0, 5) === 'move_') {
2517 $contactFieldsToCompare[] = str_replace('move_', '', $index);
2518 $return['contact'][str_replace('move_', '', $index)] = [
2519 'title' => $migrationInfo[$index]['title'],
2520 $toKeepID => $migrationInfo[$index]['main'],
2521 $toRemoveID => $migrationInfo[$index]['other'],
2525 // Can't think of why this would be the case but perhaps it's ensuring it isn't as we
2527 throw new CRM_Core_Exception(ts('Unknown parameter') . $index);
2530 return ['conflicts' => $return, 'resolved' => $resolved];
2534 * Get any duplicate merge pairs that have been previously cached.
2536 * @param int $rule_group_id
2537 * @param int $group_id
2538 * @param int $batchLimit
2539 * @param bool $isSelected
2540 * @param bool $includeConflicts
2541 * @param array $criteria
2542 * @param int $checkPermissions
2543 * @param int $searchLimit
2547 protected static function getCachedDuplicateMatches($rule_group_id, $group_id, $batchLimit, $isSelected, $includeConflicts, $criteria, $checkPermissions, $searchLimit = 0) {
2548 return CRM_Core_BAO_PrevNextCache
::retrieve(
2549 self
::getMergeCacheKeyString($rule_group_id, $group_id, $criteria, $checkPermissions, $searchLimit),
2550 self
::getJoinOnDedupeTable(),
2551 self
::getWhereString($isSelected),
2561 protected static function ignoredFields(): array {
2571 return $keysToIgnore;
2575 * Get the field value & label for the given field.
2581 * @throws \Exception
2583 private static function getFieldValueAndLabel($field, $contact): array {
2584 $fields = self
::getMergeFieldsMetadata();
2585 $value = $label = $contact[$field] ??
NULL;
2586 $fieldSpec = $fields[$field];
2587 if (!empty($fieldSpec['serialize']) && is_array($value)) {
2588 // In practice this only applies to preferred_communication_method as the sub types are skipped above
2589 // and no others are serialized.
2591 foreach ($value as $individualValue) {
2592 $labels[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $field, $individualValue);
2594 $label = implode(', ', $labels);
2595 // We serialize this due to historic handling but it's likely that if we just left it as an
2596 // array all would be well & we would have less code.
2597 $value = CRM_Core_DAO
::serializeField($value, $fieldSpec['serialize']);
2599 elseif (!empty($fieldSpec['type']) && $fieldSpec['type'] == CRM_Utils_Type
::T_DATE
) {
2601 $value = str_replace('-', '', $value);
2602 $label = CRM_Utils_Date
::customFormat($label);
2608 elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
2609 if ($label === '0') {
2612 if ($label === '1') {
2616 elseif (!empty($fieldSpec['pseudoconstant'])) {
2617 $label = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $field, $value);
2619 elseif ($field == 'current_employer_id' && !empty($value)) {
2620 $label = "$value (" . CRM_Contact_BAO_Contact
::displayName($value) . ")";
2622 return ['label' => $label, 'value' => $value];
2626 * Build up the location block for the contact in dedupe-screen display format.
2629 * @param array $blockInfo
2630 * @param string $blockName
2634 * @throws \CiviCRM_API3_Exception
2636 private static function buildLocationBlockForContact($cid, $blockInfo, $blockName): array {
2638 'contact_id' => $cid,
2639 // CRM-17556 Order by field-specific criteria
2641 'sort' => $blockInfo['sortString'],
2644 $locationBlock = [];
2645 $values = civicrm_api3($blockName, 'get', $searchParams);
2646 if ($values['count']) {
2648 foreach ($values['values'] as $value) {
2649 $locationBlock[$cnt] = $value;
2650 // Fix address display
2651 if ($blockName == 'address') {
2652 // For performance avoid geocoding while merging https://issues.civicrm.org/jira/browse/CRM-21786
2653 // we can expect existing geocode values to be retained.
2654 $value['skip_geocode'] = TRUE;
2655 CRM_Core_BAO_Address
::fixAddress($value);
2656 unset($value['skip_geocode']);
2657 $locationBlock[$cnt]['display'] = CRM_Utils_Address
::format($value);
2659 // Fix email display
2660 elseif ($blockName == 'email') {
2661 $locationBlock[$cnt]['display'] = CRM_Utils_Mail
::format($value);
2667 return $locationBlock;
2671 * Get a lock on the given contact.
2673 * The lock is like a gentleman's agreement between php & mysql. It is reserved at the
2674 * mysql level so it works across php processes but it doesn't actually lock the database.
2676 * Instead php can check the lock to see if it has been acquired before taking an action.
2678 * In this case we really don't want to attempt to dedupe contacts if another process is
2679 * trying to act on the specific contact as it could result in messy deadlocks & possibly data corruption.
2680 * In most databases this would be a rare event but if multiple dedupe processes are running
2681 * at once (for example) or there is also an import process in play there is potential for them to crash.
2682 * By throwing a specific error the calling process can catch it and determine it is worth trying again later without a lot of
2685 * As of writing no other processes DO grab contact locks but it would be reasonable to consider
2686 * grabbing them doing contact edits in general as well as imports etc.
2688 * @param array $contacts
2692 * @throws \CRM_Core_Exception
2693 * @throws \CRM_Core_Exception_ResourceConflictException
2695 protected static function getLocksOnContacts($contacts):array {
2697 if (!CRM_Utils_SQL
::supportsMultipleLocks()) {
2700 foreach ($contacts as $contactID) {
2701 $lock = Civi
::lockManager()->acquire("data.core.contact.{$contactID}");
2702 if ($lock->isAcquired()) {
2706 self
::releaseLocks($locks);
2707 throw new CRM_Core_Exception_ResourceConflictException(ts('Contact is in Use'), 'contact_lock');
2714 * Release contact locks so another process can alter them if it wants.
2716 * @param array $locks
2718 protected static function releaseLocks(array $locks) {
2719 foreach ($locks as $lock) {
2720 /* @var Civi\Core\Lock\LockInterface $lock */
2730 * @param array $locations
2731 * @param array $rows
2732 * @param array $elements
2733 * @param array $migrationInfo
2736 * @throws \CiviCRM_API3_Exception
2738 protected static function addLocationFieldInfo($mainId, $otherId, $blockInfo, $blockName, array $locations, array $rows, array $elements, array $migrationInfo): array {
2739 // Collect existing fields from both 'main' and 'other' contacts first
2740 // This allows us to match up location/types when building the table rows
2741 $locations['main'][$blockName] = self
::buildLocationBlockForContact($mainId, $blockInfo, $blockName);
2742 $locations['other'][$blockName] = self
::buildLocationBlockForContact($otherId, $blockInfo, $blockName);
2744 // Now, build the table rows appropriately, based off the information on
2745 // the 'other' contact
2746 if (!empty($locations['other']) && !empty($locations['other'][$blockName])) {
2747 foreach ($locations['other'][$blockName] as $count => $value) {
2749 $displayValue = $value[$blockInfo['displayField']];
2751 // Add this value to the table rows
2752 $rows["move_location_{$blockName}_{$count}"]['other'] = $displayValue;
2754 // CRM-17556 Only display 'main' contact value if it's the same location + type
2755 // Look it up from main values...
2757 $lookupLocation = FALSE;
2758 if ($blockInfo['hasLocation']) {
2759 $lookupLocation = $value['location_type_id'];
2762 $lookupType = FALSE;
2763 if ($blockInfo['hasType']) {
2764 $lookupType = $value[$blockInfo['hasType']] ??
NULL;
2767 // Hold ID of main contact's matching block
2768 $mainContactBlockId = 0;
2770 if (!empty($locations['main'][$blockName])) {
2771 foreach ($locations['main'][$blockName] as $mainValueCheck) {
2772 // No location/type, or matching location and type
2774 (empty($lookupLocation) ||
$lookupLocation == $mainValueCheck['location_type_id'])
2775 && (empty($lookupType) ||
$lookupType == $mainValueCheck[$blockInfo['hasType']])
2777 // Set this value as the default against the 'other' contact value
2778 $rows["move_location_{$blockName}_{$count}"]['main'] = $mainValueCheck[$blockInfo['displayField']];
2779 $rows["move_location_{$blockName}_{$count}"]['main_is_primary'] = $mainValueCheck['is_primary'] ??
0;
2780 $rows["move_location_{$blockName}_{$count}"]['location_entity'] = $blockName;
2781 $mainContactBlockId = $mainValueCheck['id'];
2787 // Add checkbox to migrate data from 'other' to 'main'
2788 $elements[] = ['advcheckbox', "move_location_{$blockName}_{$count}"];
2790 // Add checkbox to set the 'other' location as primary
2793 "location_blocks[$blockName][$count][set_other_primary]",
2795 ts('Set as primary'),
2798 // Flag up this field to skipMerge function (@todo: do we need to?)
2799 $migrationInfo["move_location_{$blockName}_{$count}"] = 1;
2801 // Add a hidden field to store the ID of the target main contact block
2804 "location_blocks[$blockName][$count][mainContactBlockId]",
2805 $mainContactBlockId,
2809 $thisTypeId = FALSE;
2812 // Provide a select drop-down for the location's location type
2813 // eg: Home, Work...
2815 if ($blockInfo['hasLocation']) {
2817 // Load the location options for this entity
2818 $locationOptions = civicrm_api3($blockName, 'getoptions', ['field' => 'location_type_id']);
2820 $thisLocId = $value['location_type_id'];
2822 // Put this field's location type at the top of the list
2823 $tmpIdList = $locationOptions['values'];
2824 $defaultLocId = [$thisLocId => $tmpIdList[$thisLocId]];
2825 unset($tmpIdList[$thisLocId]);
2830 "location_blocks[$blockName][$count][locTypeId]",
2832 $defaultLocId +
$tmpIdList,
2835 // Add the relevant information to the $migrationInfo
2836 // Keep location-type-id same as that of other-contact
2837 // @todo Check this logic out
2838 $migrationInfo['location_blocks'][$blockName][$count]['locTypeId'] = $thisLocId;
2839 if ($blockName != 'address') {
2842 "location_blocks[{$blockName}][$count][operation]",
2846 // always use add operation
2847 $migrationInfo['location_blocks'][$blockName][$count]['operation'] = 1;
2852 // Provide a select drop-down for the location's type/provider
2853 // eg websites: Facebook...
2855 if ($blockInfo['hasType']) {
2857 // Load the type options for this entity
2858 $typeOptions = civicrm_api3($blockName, 'getoptions', ['field' => $blockInfo['hasType']]);
2860 $thisTypeId = $value[$blockInfo['hasType']] ??
NULL;
2862 // Put this field's location type at the top of the list
2863 $tmpIdList = $typeOptions['values'];
2864 $defaultTypeId = [$thisTypeId => CRM_Utils_Array
::value($thisTypeId, $tmpIdList)];
2865 unset($tmpIdList[$thisTypeId]);
2870 "location_blocks[$blockName][$count][typeTypeId]",
2872 $defaultTypeId +
$tmpIdList,
2875 // Add the information to the migrationInfo
2876 $migrationInfo['location_blocks'][$blockName][$count]['typeTypeId'] = $thisTypeId;
2880 // Set the label for this row
2881 $rowTitle = $blockInfo['label'] . ' ' . ($count +
1);
2882 if (!empty($thisLocId)) {
2883 $rowTitle .= ' (' . $locationOptions['values'][$thisLocId] . ')';
2885 if (!empty($thisTypeId)) {
2886 $rowTitle .= ' (' . $typeOptions['values'][$thisTypeId] . ')';
2888 $rows["move_location_{$blockName}_$count"]['title'] = $rowTitle;
2890 } // End loop through 'other' locations of this type
2893 return [$locations, $rows, $elements, $migrationInfo];