3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Dedupe_Merger
{
37 // FIXME: consider creating a common structure with cidRefs() and eidRefs()
38 // FIXME: the sub-pages references by the URLs should
39 // be loaded dynamically on the merge form instead
43 static function relTables() {
46 $config = CRM_Core_Config
::singleton();
47 if ($config->userSystem
->is_drupal
) {
48 $userRecordUrl = CRM_Utils_System
::url('user/%ufid');
49 $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework
, 2 => '$ufname', 3 => '$ufid'));
51 elseif ($config->userFramework
== 'Joomla') {
52 $userRecordUrl = $config->userFrameworkVersion
> 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';
53 $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework
, 2 => '$ufname', 3 => '$ufid'));
58 'rel_table_contributions' => array(
59 'title' => ts('Contributions'),
60 'tables' => array('civicrm_contribution', 'civicrm_contribution_recur', 'civicrm_contribution_soft'),
61 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=contribute'),
63 'rel_table_contribution_page' => array(
64 'title' => ts('Contribution Pages'),
65 'tables' => array('civicrm_contribution_page'),
66 'url' => CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1&cid=$cid'),
68 'rel_table_memberships' => array(
69 'title' => ts('Memberships'),
70 'tables' => array('civicrm_membership', 'civicrm_membership_log', 'civicrm_membership_type'),
71 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=member'),
73 'rel_table_participants' => array(
74 'title' => ts('Participants'),
75 'tables' => array('civicrm_participant'),
76 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=participant'),
78 'rel_table_events' => array(
79 'title' => ts('Events'),
80 'tables' => array('civicrm_event'),
81 'url' => CRM_Utils_System
::url('civicrm/event/manage', 'reset=1&cid=$cid'),
83 'rel_table_activities' => array(
84 'title' => ts('Activities'),
85 'tables' => array('civicrm_activity', 'civicrm_activity_contact'),
86 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=activity'),
88 'rel_table_relationships' => array(
89 'title' => ts('Relationships'),
90 'tables' => array('civicrm_relationship'),
91 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=rel'),
93 'rel_table_custom_groups' => array(
94 'title' => ts('Custom Groups'),
95 'tables' => array('civicrm_custom_group'),
96 'url' => CRM_Utils_System
::url('civicrm/admin/custom/group', 'reset=1'),
98 'rel_table_uf_groups' => array(
99 'title' => ts('Profiles'),
100 'tables' => array('civicrm_uf_group'),
101 'url' => CRM_Utils_System
::url('civicrm/admin/uf/group', 'reset=1'),
103 'rel_table_groups' => array(
104 'title' => ts('Groups'),
105 'tables' => array('civicrm_group_contact'),
106 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=group'),
108 'rel_table_notes' => array(
109 'title' => ts('Notes'),
110 'tables' => array('civicrm_note'),
111 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=note'),
113 'rel_table_tags' => array(
114 'title' => ts('Tags'),
115 'tables' => array('civicrm_entity_tag'),
116 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=tag'),
118 'rel_table_mailings' => array(
119 'title' => ts('Mailings'),
120 'tables' => array('civicrm_mailing', 'civicrm_mailing_event_queue', 'civicrm_mailing_event_subscribe'),
121 'url' => CRM_Utils_System
::url('civicrm/mailing', 'reset=1&force=1&cid=$cid'),
123 'rel_table_cases' => array(
124 'title' => ts('Cases'),
125 'tables' => array('civicrm_case_contact'),
126 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=case'),
128 'rel_table_grants' => array(
129 'title' => ts('Grants'),
130 'tables' => array('civicrm_grant'),
131 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=grant'),
133 'rel_table_pcp' => array(
134 'title' => ts('PCPs'),
135 'tables' => array('civicrm_pcp'),
136 'url' => CRM_Utils_System
::url('civicrm/contribute/pcp/manage', 'reset=1'),
138 'rel_table_pledges' => array(
139 'title' => ts('Pledges'),
140 'tables' => array('civicrm_pledge', 'civicrm_pledge_payment'),
141 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=pledge'),
143 'rel_table_users' => array(
145 'tables' => array('civicrm_uf_match'),
146 'url' => $userRecordUrl,
150 $relTables +
= self
::getMultiValueCustomSets('relTables');
152 // Allow hook_civicrm_merge() to adjust $relTables
153 CRM_Utils_Hook
::merge('relTables', $relTables);
159 * Returns the related tables groups for which a contact has any info entered
161 static function getActiveRelTables($cid) {
165 $relTables = self
::relTables();
166 $cidRefs = self
::cidRefs();
167 $eidRefs = self
::eidRefs();
168 foreach ($relTables as $group => $params) {
170 foreach ($params['tables'] as $table) {
171 if (isset($cidRefs[$table])) {
172 foreach ($cidRefs[$table] as $field) {
173 $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $field = $cid";
176 if (isset($eidRefs[$table])) {
177 foreach ($eidRefs[$table] as $entityTable => $entityId) {
178 $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $entityId = $cid AND $entityTable = 'civicrm_contact'";
181 foreach ($sqls as $sql) {
182 if (CRM_Core_DAO
::singleValueQuery($sql) > 0) {
188 return array_unique($groups);
192 * Return tables and their fields referencing civicrm_contact.contact_id explicitly
194 static function cidRefs() {
201 FROM information_schema.key_column_usage
203 referenced_table_schema = database() AND
204 referenced_table_name = 'civicrm_contact' AND
205 referenced_column_name = 'id';
207 $dao = CRM_Core_DAO
::executeQuery($sql);
208 while ($dao->fetch()) {
209 $cidRefs[$dao->table_name
][] = $dao->column_name
;
212 // FixME for time being adding below line statically as no Foreign key constraint defined for table 'civicrm_entity_tag'
213 $cidRefs['civicrm_entity_tag'][] = 'entity_id';
216 // Allow hook_civicrm_merge() to adjust $cidRefs
217 CRM_Utils_Hook
::merge('cidRefs', $cidRefs);
223 * Return tables and their fields referencing civicrm_contact.contact_id with entity_id
225 static function eidRefs() {
228 // FIXME: this should be generated dynamically from the schema
229 // tables that reference contacts with entity_{id,table}
231 'civicrm_acl' => array('entity_table' => 'entity_id'),
232 'civicrm_acl_entity_role' => array('entity_table' => 'entity_id'),
233 'civicrm_entity_file' => array('entity_table' => 'entity_id'),
234 'civicrm_log' => array('entity_table' => 'entity_id'),
235 'civicrm_mailing_group' => array('entity_table' => 'entity_id'),
236 'civicrm_note' => array('entity_table' => 'entity_id'),
239 // Allow hook_civicrm_merge() to adjust $eidRefs
240 CRM_Utils_Hook
::merge('eidRefs', $eidRefs);
246 * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc.
247 * @param string $request 'relTables' or 'cidRefs'
250 static function getMultiValueCustomSets($request) {
252 if ($data === NULL) {
254 'relTables' => array(),
255 'cidRefs' => array(),
257 $result = civicrm_api3('custom_group', 'get', array(
259 'extends' => array('IN' => array('Individual', 'Organization', 'Household', 'Contact')),
260 'return' => array('id', 'title', 'table_name', 'style'),
262 foreach($result['values'] as $custom) {
263 $data['cidRefs'][$custom['table_name']] = array('entity_id');
264 $urlSuffix = $custom['style'] == 'Tab' ?
'&selectedChild=custom_' . $custom['id'] : '';
265 $data['relTables']['rel_table_custom_' . $custom['id']] = array(
266 'title' => $custom['title'],
267 'tables' => array($custom['table_name']),
268 'url' => CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid' . $urlSuffix),
272 return $data[$request];
276 * Tables which require custom processing should declare functions to call here.
277 * Doing so will override normal processing.
279 static function cpTables() {
283 'civicrm_case_contact' => array('CRM_Case_BAO_Case' => 'mergeContacts'),
284 'civicrm_group_contact' => array('CRM_Contact_BAO_GroupContact' => 'mergeGroupContact'),
285 // Empty array == do nothing - this table is handled by mergeGroupContact
286 'civicrm_subscription_history' => array(),
287 'civicrm_relationship' => array('CRM_Contact_BAO_Relationship' => 'mergeRelationships'),
294 * return payment related table.
296 static function paymentTables() {
299 $tables = array('civicrm_pledge', 'civicrm_membership', 'civicrm_participant');
306 * return payment update Query.
308 static function paymentSql($tableName, $mainContactId, $otherContactId) {
310 if (!$tableName ||
!$mainContactId ||
!$otherContactId) {
314 $paymentTables = self
::paymentTables();
315 if (!in_array($tableName, $paymentTables)) {
319 switch ($tableName) {
320 case 'civicrm_pledge':
322 UPDATE IGNORE civicrm_contribution contribution
323 INNER JOIN civicrm_pledge_payment payment ON ( payment.contribution_id = contribution.id )
324 INNER JOIN civicrm_pledge pledge ON ( pledge.id = payment.pledge_id )
325 SET contribution.contact_id = $mainContactId
326 WHERE pledge.contact_id = $otherContactId";
329 case 'civicrm_membership':
331 UPDATE IGNORE civicrm_contribution contribution
332 INNER JOIN civicrm_membership_payment payment ON ( payment.contribution_id = contribution.id )
333 INNER JOIN civicrm_membership membership ON ( membership.id = payment.membership_id )
334 SET contribution.contact_id = $mainContactId
335 WHERE membership.contact_id = $otherContactId";
338 case 'civicrm_participant':
340 UPDATE IGNORE civicrm_contribution contribution
341 INNER JOIN civicrm_participant_payment payment ON ( payment.contribution_id = contribution.id )
342 INNER JOIN civicrm_participant participant ON ( participant.id = payment.participant_id )
343 SET contribution.contact_id = $mainContactId
344 WHERE participant.contact_id = $otherContactId";
355 * @param array $tableOperations
356 * @param string $mode
360 static function operationSql($mainId, $otherId, $tableName, $tableOperations = array(), $mode = 'add') {
362 if (!$tableName ||
!$mainId ||
!$otherId) {
367 switch ($tableName) {
368 case 'civicrm_membership':
369 if (array_key_exists($tableName, $tableOperations) && $tableOperations[$tableName]['add'])
371 if ($mode == 'add') {
373 DELETE membership1.* FROM civicrm_membership membership1
374 INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
375 AND membership1.contact_id = {$mainId}
376 AND membership2.contact_id = {$otherId} ";
378 if ($mode == 'payment') {
380 DELETE contribution.* FROM civicrm_contribution contribution
381 INNER JOIN civicrm_membership_payment payment ON payment.contribution_id = contribution.id
382 INNER JOIN civicrm_membership membership1 ON membership1.id = payment.membership_id
383 AND membership1.contact_id = {$mainId}
384 INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
385 AND membership2.contact_id = {$otherId}";
389 case 'civicrm_uf_match':
390 // normal queries won't work for uf_match since that will lead to violation of unique constraint,
391 // failing to meet intended result. Therefore we introduce this additonal query:
392 $sqls[] = "DELETE FROM civicrm_uf_match WHERE contact_id = {$mainId}";
400 * Based on the provided two contact_ids and a set of tables, move the
401 * belongings of the other contact to the main one.
405 static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) {
406 $cidRefs = self
::cidRefs();
407 $eidRefs = self
::eidRefs();
408 $cpTables = self
::cpTables();
409 $paymentTables = self
::paymentTables();
410 $membershipMerge = FALSE; // CRM-12695
412 $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs));
413 if ($tables !== FALSE) {
414 // if there are specific tables, sanitize the list
415 $affected = array_unique(array_intersect($affected, $tables));
418 // if there aren't any specific tables, don't affect the ones handled by relTables()
419 $relTables = self
::relTables();
421 foreach ($relTables as $params) {
422 $handled = array_merge($handled, $params['tables']);
424 $affected = array_diff($affected, $handled);
427 * Set $membershipMerge flag only once
428 * while doing contact related migration
429 * to call addMembershipToRealtedContacts()
430 * function only once.
431 * Since the current function (moveContactBelongings) is called twice
432 * with & without parameters $tables & $tableOperations
434 // retrieve main contact's related table(s)
435 $activeMainRelTables = CRM_Dedupe_Merger
::getActiveRelTables($mainId);
436 // check if membership table exists in main contact's related table(s)
437 if (in_array('rel_table_memberships', $activeMainRelTables)) {
438 $membershipMerge = TRUE; // set membership flag - CRM-12695
442 $mainId = (int) $mainId;
443 $otherId = (int) $otherId;
446 foreach ($affected as $table) {
447 // Call custom processing function for objects that require it
448 if (isset($cpTables[$table])) {
449 foreach ($cpTables[$table] as $className => $fnName) {
450 $className::$fnName($mainId, $otherId, $sqls);
452 // Skip normal processing
456 // use UPDATE IGNORE + DELETE query pair to skip on situations when
457 // there's a UNIQUE restriction on ($field, some_other_field) pair
458 if (isset($cidRefs[$table])) {
459 foreach ($cidRefs[$table] as $field) {
460 // carry related contributions CRM-5359
461 if (in_array($table, $paymentTables)) {
462 $payOprSqls = self
::operationSql($mainId, $otherId, $table, $tableOperations, 'payment');
463 $sqls = array_merge($sqls, $payOprSqls);
465 $paymentSqls = self
::paymentSql($table, $mainId, $otherId);
466 $sqls = array_merge($sqls, $paymentSqls);
469 $preOperationSqls = self
::operationSql($mainId, $otherId, $table, $tableOperations);
470 $sqls = array_merge($sqls, $preOperationSqls);
472 $sqls[] = "UPDATE IGNORE $table SET $field = $mainId WHERE $field = $otherId";
473 $sqls[] = "DELETE FROM $table WHERE $field = $otherId";
476 if (isset($eidRefs[$table])) {
477 foreach ($eidRefs[$table] as $entityTable => $entityId) {
478 $sqls[] = "UPDATE IGNORE $table SET $entityId = $mainId WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
479 $sqls[] = "DELETE FROM $table WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
484 // Allow hook_civicrm_merge() to add SQL statements for the merge operation.
485 CRM_Utils_Hook
::merge('sqls', $sqls, $mainId, $otherId, $tables);
487 // call the SQL queries in one transaction
488 $transaction = new CRM_Core_Transaction();
489 foreach ($sqls as $sql) {
490 CRM_Core_DAO
::executeQuery($sql, array(), TRUE, NULL, TRUE);
493 if ($membershipMerge) {
494 // call to function adding membership to related contacts
495 CRM_Dedupe_Merger
::addMembershipToRealtedContacts($mainId);
497 $transaction->commit();
501 * Find differences between contacts.
503 * @param array $main contact details
504 * @param array $other contact details
509 static function findDifferences($main, $other) {
511 'contact' => array(),
514 foreach (self
::getContactFields() as $validField) {
515 if (CRM_Utils_Array
::value($validField, $main) != CRM_Utils_Array
::value($validField, $other)) {
516 $result['contact'][] = $validField;
520 $mainEvs = CRM_Core_BAO_CustomValueTable
::getEntityValues($main['id']);
521 $otherEvs = CRM_Core_BAO_CustomValueTable
::getEntityValues($other['id']);
522 $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs)));
523 foreach ($keys as $key) {
524 // Exclude multi-value fields CRM-13836
525 if (strpos($key, '_')) {
528 $key1 = CRM_Utils_Array
::value($key, $mainEvs);
529 $key2 = CRM_Utils_Array
::value($key, $otherEvs);
530 if ($key1 != $key2) {
531 $result['custom'][] = $key;
538 * Function to batch merge a set of contacts based on rule-group and group.
540 * @param int $rgid rule group id
541 * @param int $gid group id
542 * @param string $mode helps decide how to behave when there are conflicts.
543 * A 'safe' value skips the merge if there are any un-resolved conflicts.
544 * Does a force merge otherwise.
545 * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete.
548 * @param bool $redirectForPerformance
551 * @internal param array $cacheParams prev-next-cache params based on which next pair of contacts are computed.
552 * Generally used with batch-merge.
556 static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $redirectForPerformance = FALSE) {
557 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
558 $cacheKeyString = "merge {$contactType}";
559 $cacheKeyString .= $rgid ?
"_{$rgid}" : '_0';
560 $cacheKeyString .= $gid ?
"_{$gid}" : '_0';
561 $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
562 pn.entity_id2 = de.contact_id2 )";
564 $limit = $redirectForPerformance ?
75 : 1;
565 $where = "de.id IS NULL LIMIT {$limit}";
567 $dupePairs = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString, $join, $where);
568 if (empty($dupePairs) && !$redirectForPerformance) {
569 // If we haven't found any dupes, probably cache is empty.
570 // Try filling cache and give another try.
571 CRM_Core_BAO_PrevNextCache
::refillCache($rgid, $gid, $cacheKeyString);
572 $dupePairs = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString, $join, $where);
575 $cacheParams = array(
576 'cache_key_string' => $cacheKeyString,
580 return CRM_Dedupe_Merger
::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance);
584 * Function to merge given set of contacts. Performs core operation.
586 * @param array $dupePairs set of pair of contacts for whom merge is to be done.
587 * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed.
588 * Generally used with batch-merge.
589 * @param string $mode helps decide how to behave when there are conflicts.
590 * A 'safe' value skips the merge if there are any un-resolved conflicts.
591 * Does a force merge otherwise (aggressive mode).
592 * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete.
595 * @param bool $redirectForPerformance
601 static function merge($dupePairs = array(
602 ), $cacheParams = array(), $mode = 'safe',
603 $autoFlip = TRUE, $redirectForPerformance = FALSE
605 $cacheKeyString = CRM_Utils_Array
::value('cache_key_string', $cacheParams);
606 $resultStats = array('merged' => array(), 'skipped' => array());
608 // we don't want dupe caching to get reset after every-merge, and therefore set the
609 // doNotResetCache flag
610 $config = CRM_Core_Config
::singleton();
611 $config->doNotResetCache
= 1;
613 while (!empty($dupePairs)) {
614 foreach ($dupePairs as $dupes) {
615 CRM_Utils_Hook
::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']);
616 $mainId = $dupes['dstID'];
617 $otherId = $dupes['srcID'];
618 $isAutoFlip = CRM_Utils_Array
::value('auto_flip', $dupes, $autoFlip);
619 // if we can, make sure that $mainId is the one with lower id number
620 if ($isAutoFlip && ($mainId > $otherId)) {
621 $mainId = $dupes['srcID'];
622 $otherId = $dupes['dstID'];
624 if (!$mainId ||
!$otherId) {
629 // Generate var $migrationInfo. The variable structure is exactly same as
630 // $formValues submitted during a UI merge for a pair of contacts.
631 $rowsElementsAndInfo = &CRM_Dedupe_Merger
::getRowsElementsAndInfo($mainId, $otherId);
633 $migrationInfo = &$rowsElementsAndInfo['migration_info'];
635 // add additional details that we might need to resolve conflicts
636 $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details'];
637 $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details'];
638 $migrationInfo['main_loc_block'] = &$rowsElementsAndInfo['main_loc_block'];
639 $migrationInfo['rows'] = &$rowsElementsAndInfo['rows'];
641 // go ahead with merge if there is no conflict
642 if (!CRM_Dedupe_Merger
::skipMerge($mainId, $otherId, $migrationInfo, $mode)) {
643 CRM_Dedupe_Merger
::moveAllBelongings($mainId, $otherId, $migrationInfo);
644 $resultStats['merged'][] = array('main_d' => $mainId, 'other_id' => $otherId);
647 $resultStats['skipped'][] = array('main_d' => $mainId, 'other_id' => $otherId);
650 // delete entry from PrevNextCache table so we don't consider the pair next time
651 // pair may have been flipped, so make sure we delete using both orders
652 CRM_Core_BAO_PrevNextCache
::deletePair($mainId, $otherId, $cacheKeyString);
653 CRM_Core_BAO_PrevNextCache
::deletePair($otherId, $mainId, $cacheKeyString);
655 CRM_Core_DAO
::freeResult();
656 unset($rowsElementsAndInfo, $migrationInfo);
659 if ($cacheKeyString && !$redirectForPerformance) {
660 // retrieve next pair of dupes
661 $dupePairs = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString,
662 $cacheParams['join'],
663 $cacheParams['where']
667 // do not proceed. Terminate the loop
675 * A function which uses various rules / algorithms for choosing which contact to bias to
676 * when there's a conflict (to handle "gotchas"). Plus the safest route to merge.
678 * @param int $mainId main contact with whom merge has to happen
679 * @param int $otherId duplicate contact which would be deleted after merge operation
680 * @param array $migrationInfo array of information about which elements to merge.
681 * @param string $mode helps decide how to behave when there are conflicts.
682 * A 'safe' value skips the merge if there are any un-resolved conflicts.
683 * Does a force merge otherwise (aggressive mode).
689 static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe') {
690 $conflicts = array();
691 $migrationData = array(
692 'old_migration_info' => $migrationInfo,
695 $allLocationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
697 foreach ($migrationInfo as $key => $val) {
698 if ($val === "null") {
699 // Rule: no overwriting with empty values in any mode
700 unset($migrationInfo[$key]);
703 elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger
::getContactFields()) or
704 substr($key, 0, 12) == 'move_custom_'
705 ) and $val != NULL) {
706 // Rule: if both main-contact has other-contact, let $mode decide if to merge a
707 // particular field or not
708 if (!empty($migrationInfo['rows'][$key]['main'])) {
709 // if main also has a value its a conflict
710 if ($mode == 'safe') {
711 // note it down & lets wait for response from the hook.
712 // For no response skip this merge
713 $conflicts[$key] = NULL;
715 elseif ($mode == 'aggressive') {
716 // let the main-field be overwritten
721 elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) {
722 $locField = explode('_', $key);
723 $fieldName = $locField[2];
724 $fieldCount = $locField[3];
726 // Rule: resolve address conflict if any -
727 if ($fieldName == 'address') {
728 $mainNewLocTypeId = $migrationInfo['location'][$fieldName][$fieldCount]['locTypeId'];
729 if (!empty($migrationInfo['main_loc_address']) &&
730 array_key_exists("main_{$mainNewLocTypeId}", $migrationInfo['main_loc_address'])) {
731 // main loc already has some address for the loc-type. Its a overwrite situation.
733 // look for next available loc-type
735 foreach ($allLocationTypes as $typeId => $typeLabel) {
736 if (!array_key_exists("main_{$typeId}", $migrationInfo['main_loc_address'])) {
737 $newTypeId = $typeId;
741 // try insert address at new available loc-type
742 $migrationInfo['location'][$fieldName][$fieldCount]['locTypeId'] = $newTypeId;
744 elseif ($mode == 'safe') {
745 // note it down & lets wait for response from the hook.
746 // For no response skip this merge
747 $conflicts[$key] = NULL;
749 elseif ($mode == 'aggressive') {
750 // let the loc-type-id be same as that of other-contact & go ahead
751 // with merge assuming aggressive mode
756 elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) {
757 // for loc blocks other than address like email, phone .. if values are same no point in merging
758 // and adding redundant value
759 unset($migrationInfo[$key]);
764 // A hook to implement other algorithms for choosing which contact to bias to when
765 // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here
766 // merge happens with new values filled in here. For a particular field / row not to be merged
767 // field should be unset from fields_in_conflict.
768 $migrationData['fields_in_conflict'] = $conflicts;
769 CRM_Utils_Hook
::merge('batch', $migrationData, $mainId, $otherId);
770 $conflicts = $migrationData['fields_in_conflict'];
772 if (!empty($conflicts)) {
773 foreach ($conflicts as $key => $val) {
774 if ($val === NULL and $mode == 'safe') {
775 // un-resolved conflicts still present. Lets skip this merge.
779 // copy over the resolved values
780 $migrationInfo[$key] = $val;
788 * A function to build an array of information required by merge function and the merge UI.
790 * @param int $mainId main contact with whom merge has to happen
791 * @param int $otherId duplicate contact which would be deleted after merge operation
793 * @return array|bool|int
797 static function getRowsElementsAndInfo($mainId, $otherId) {
798 $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
801 foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
802 $params = array('contact_id' => $cid, 'version' => 3, 'return' => array_merge(array('display_name'), self
::getContactFields()));
803 $result = civicrm_api('contact', 'get', $params);
805 if (empty($result['values'][$cid]['contact_type'])) {
808 $
$moniker = $result['values'][$cid];
811 static $fields = array();
812 if (empty($fields)) {
813 $fields = CRM_Contact_DAO_Contact
::fields();
814 CRM_Core_DAO
::freeResult();
817 // FIXME: there must be a better way
818 foreach (array('main', 'other') as $moniker) {
819 $contact = &$
$moniker;
820 $preferred_communication_method = CRM_Utils_array
::value('preferred_communication_method', $contact);
821 $value = empty($preferred_communication_method) ?
array() : $preferred_communication_method;
822 $specialValues[$moniker] = array(
823 'preferred_communication_method' => $value,
826 if (!empty($contact['preferred_communication_method'])){
827 // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct
828 $prefCommList = is_array($specialValues[$moniker]['preferred_communication_method']) ?
829 implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $specialValues[$moniker]['preferred_communication_method']) :
830 $specialValues[$moniker]['preferred_communication_method'];
831 $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $prefCommList . CRM_Core_DAO
::VALUE_SEPARATOR
;
834 'preferred_communication_method' =>
836 'newName' => 'preferred_communication_method_display',
837 'groupName' => 'preferred_communication_method',
840 CRM_Core_OptionGroup
::lookupValues($specialValues[$moniker], $names);
843 static $optionValueFields = array();
844 if (empty($optionValueFields)) {
845 $optionValueFields = CRM_Core_OptionValue
::getFields();
847 foreach ($optionValueFields as $field => $params) {
848 $fields[$field]['title'] = $params['title'];
851 $diffs = self
::findDifferences($main, $other);
853 $rows = $elements = $relTableElements = $migrationInfo = array();
855 foreach ($diffs['contact'] as $field) {
856 foreach (array('main', 'other') as $moniker) {
857 $contact = &$
$moniker;
858 $value = CRM_Utils_Array
::value($field, $contact);
859 if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) {
860 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. trim($specialValues[$moniker][$field], CRM_Core_DAO
::VALUE_SEPARATOR
) . CRM_Core_DAO
::VALUE_SEPARATOR
;
862 $label = isset($specialValues[$moniker]["{$field}_display"]) ?
$specialValues[$moniker]["{$field}_display"] : $value;
863 if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type
::T_DATE
) {
865 $value = str_replace('-', '', $value);
866 $label = CRM_Utils_Date
::customFormat($label);
872 elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
873 if ($label === '0') {
876 if ($label === '1') {
880 elseif ($field == 'individual_prefix' ||
$field == 'prefix_id') {
881 $label = CRM_Utils_Array
::value('individual_prefix', $contact);
882 $value = CRM_Utils_Array
::value('prefix_id', $contact);
883 $field = 'prefix_id';
885 elseif ($field == 'individual_suffix' ||
$field == 'suffix_id') {
886 $label = CRM_Utils_Array
::value('individual_suffix', $contact);
887 $value = CRM_Utils_Array
::value('suffix_id', $contact);
888 $field = 'suffix_id';
890 $rows["move_$field"][$moniker] = $label;
891 if ($moniker == 'other') {
893 if ($value === NULL ||
$value == '') {
896 if ($value === 0 or $value === '0') {
899 if (is_array($value) && empty($value[1])) {
902 $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value);
903 $migrationInfo["move_$field"] = $value;
906 $rows["move_$field"]['title'] = $fields[$field]['title'];
909 // handle location blocks.
910 $locationBlocks = array('email', 'phone', 'address');
911 $locations = array();
913 foreach ($locationBlocks as $block) {
914 foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
916 $values = civicrm_api($block, 'get', array('contact_id' => $cid, 'version' => 3));
917 $count = $values['count'];
920 foreach ($values['values'] as $value) {
921 if ($block == 'address') {
922 CRM_Core_BAO_Address
::fixAddress($value);
923 $display = CRM_Utils_Address
::format($value);
924 $locations[$moniker][$block][$cnt] = $value;
925 $locations[$moniker][$block][$cnt]['display'] = $display;
928 $locations[$moniker][$block][$cnt] = $value;
936 if ($block == 'address') {
937 CRM_Core_BAO_Address
::fixAddress($values['values'][$id]);
938 $display = CRM_Utils_Address
::format($values['values'][$id]);
939 $locations[$moniker][$block][$cnt] = $values['values'][$id];
940 $locations[$moniker][$block][$cnt]['display'] = $display;
943 $locations[$moniker][$block][$cnt] = $values['values'][$id];
950 $allLocationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
952 $mainLocBlock = $locBlockIds = array();
953 $locBlockIds['main'] = $locBlockIds['other'] = array();
954 foreach (array('Email', 'Phone', 'IM', 'OpenID', 'Address') as $block) {
955 $name = strtolower($block);
956 foreach (array('main', 'other') as $moniker) {
957 $locIndex = CRM_Utils_Array
::value($moniker, $locations);
958 $blockValue = CRM_Utils_Array
::value($name, $locIndex, array());
959 if (empty($blockValue)) {
960 $locValue[$moniker][$name] = 0;
961 $locLabel[$moniker][$name] = $locTypes[$moniker][$name] = array();
964 $locValue[$moniker][$name] = TRUE;
965 foreach ($blockValue as $count => $blkValues) {
967 $locTypeId = $blkValues['location_type_id'];
971 if ($name == 'address') {
972 $fldName = 'display';
974 $locLabel[$moniker][$name][$count] = CRM_Utils_Array
::value($fldName,
977 $locTypes[$moniker][$name][$count] = $locTypeId;
978 if ($moniker == 'main' && in_array($name, $locationBlocks)) {
979 $mainLocBlock["main_$name$locTypeId"] = CRM_Utils_Array
::value($fldName,
982 $locBlockIds['main'][$name][$locTypeId] = $blkValues['id'];
985 $locBlockIds[$moniker][$name][$count] = $blkValues['id'];
991 if ($locValue['other'][$name] != 0) {
992 foreach ($locLabel['other'][$name] as $count => $value) {
993 $locTypeId = $locTypes['other'][$name][$count];
994 $rows["move_location_{$name}_$count"]['other'] = $value;
995 $rows["move_location_{$name}_$count"]['main'] = CRM_Utils_Array
::value($count,
996 $locLabel['main'][$name]
998 $rows["move_location_{$name}_$count"]['title'] = ts('%1:%2:%3',
1002 3 => $allLocationTypes[$locTypeId]
1006 $elements[] = array('advcheckbox', "move_location_{$name}_{$count}");
1007 $migrationInfo["move_location_{$name}_{$count}"] = 1;
1009 // make sure default location type is always on top
1010 $mainLocTypeId = CRM_Utils_Array
::value($count, $locTypes['main'][$name], $locTypeId);
1011 $locTypeValues = $allLocationTypes;
1012 $defaultLocType = array($mainLocTypeId => $locTypeValues[$mainLocTypeId]);
1013 unset($locTypeValues[$mainLocTypeId]);
1015 // keep 1-1 mapping for address - location type.
1017 if (in_array($name, $locationBlocks) && !empty($mainLocBlock)) {
1018 $js = array('onChange' => "mergeBlock('$name', this, $count );");
1020 $elements[] = array(
1021 'select', "location[{$name}][$count][locTypeId]", NULL,
1022 $defaultLocType +
$locTypeValues, $js,
1024 // keep location-type-id same as that of other-contact
1025 $migrationInfo['location'][$name][$count]['locTypeId'] = $locTypeId;
1027 if ($name != 'address') {
1028 $elements[] = array('advcheckbox', "location[{$name}][$count][operation]", NULL, ts('add new'));
1029 // always use add operation
1030 $migrationInfo['location'][$name][$count]['operation'] = 1;
1036 // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1037 $config = CRM_Core_Config
::singleton();
1038 $mainUfId = CRM_Core_BAO_UFMatch
::getUFId($mainId);
1042 if ($config->userSystem
->is_drupal
== '1' && function_exists($mainUser)) {
1043 $mainUser = user_load($mainUfId);
1045 elseif ($config->userFramework
== 'Joomla') {
1046 $mainUser = JFactory
::getUser($mainUfId);
1049 $otherUfId = CRM_Core_BAO_UFMatch
::getUFId($otherId);
1053 if ($config->userSystem
->is_drupal
== '1' && function_exists($mainUser)) {
1054 $otherUser = user_load($otherUfId);
1056 elseif ($config->userFramework
== 'Joomla') {
1057 $otherUser = JFactory
::getUser($otherUfId);
1061 $relTables = CRM_Dedupe_Merger
::relTables();
1062 $activeRelTables = CRM_Dedupe_Merger
::getActiveRelTables($otherId);
1063 $activeMainRelTables = CRM_Dedupe_Merger
::getActiveRelTables($mainId);
1064 foreach ($relTables as $name => $null) {
1065 if (!in_array($name, $activeRelTables) &&
1066 !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables))
1068 unset($relTables[$name]);
1072 $relTableElements[] = array('checkbox', "move_$name");
1073 $migrationInfo["move_$name"] = 1;
1075 $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']);
1076 $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']);
1077 if ($name == 'rel_table_users') {
1078 $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']);
1079 $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']);
1080 $find = array('$ufid', '$ufname');
1082 $replace = array($mainUfId, $mainUser->name
);
1083 $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1086 $replace = array($otherUfId, $otherUser->name
);
1087 $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1090 if ($name == 'rel_table_memberships') {
1091 $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new'));
1092 $migrationInfo["operation"]["move_{$name}"]['add'] = 1;
1095 foreach ($relTables as $name => $null) {
1096 $relTables["move_$name"] = $relTables[$name];
1097 unset($relTables[$name]);
1100 // handle custom fields
1101 $mainTree = CRM_Core_BAO_CustomGroup
::getTree($main['contact_type'], CRM_Core_DAO
::$_nullObject, $mainId, -1,
1102 CRM_Utils_Array
::value('contact_sub_type', $main)
1104 $otherTree = CRM_Core_BAO_CustomGroup
::getTree($main['contact_type'], CRM_Core_DAO
::$_nullObject, $otherId, -1,
1105 CRM_Utils_Array
::value('contact_sub_type', $other)
1107 CRM_Core_DAO
::freeResult();
1109 foreach ($otherTree as $gid => $group) {
1110 $foundField = FALSE;
1111 if (!isset($group['fields'])) {
1115 foreach ($group['fields'] as $fid => $field) {
1116 if (in_array($fid, $diffs['custom'])) {
1118 $rows["custom_group_$gid"]['title'] = $group['title'];
1121 if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) {
1122 foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1123 $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomGroup
::formatCustomValues($values,
1129 if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) {
1130 foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1131 $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomGroup
::formatCustomValues($values,
1134 if ($values['data'] === 0 ||
$values['data'] === '0') {
1135 $values['data'] = $qfZeroBug;
1137 $value = ($values['data']) ?
$values['data'] : $value;
1140 $rows["move_custom_$fid"]['title'] = $field['label'];
1142 $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value);
1143 $migrationInfo["move_custom_$fid"] = $value;
1149 'elements' => $elements,
1150 'rel_table_elements' => $relTableElements,
1151 'main_loc_block' => $mainLocBlock,
1152 'rel_tables' => $relTables,
1153 'main_details' => $main,
1154 'other_details' => $other,
1155 'migration_info' => $migrationInfo,
1158 $result['main_details']['loc_block_ids'] = $locBlockIds['main'];
1159 $result['other_details']['loc_block_ids'] = $locBlockIds['other'];
1165 * Based on the provided two contact_ids and a set of tables, move the belongings of the
1166 * other contact to the main one - be it Location / CustomFields or Contact .. related info.
1167 * A superset of moveContactBelongings() function.
1169 * @param int $mainId main contact with whom merge has to happen
1170 * @param int $otherId duplicate contact which would be deleted after merge operation
1172 * @param $migrationInfo
1178 static function moveAllBelongings($mainId, $otherId, $migrationInfo) {
1179 if (empty($migrationInfo)) {
1183 $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1184 $relTables = CRM_Dedupe_Merger
::relTables();
1185 $moveTables = $locBlocks = $tableOperations = array();
1186 foreach ($migrationInfo as $key => $value) {
1187 if ($value == $qfZeroBug) {
1190 if ((in_array(substr($key, 5), CRM_Dedupe_Merger
::getContactFields()) ||
1191 substr($key, 0, 12) == 'move_custom_') &&
1194 $submitted[substr($key, 5)] = $value;
1196 elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) {
1197 $locField = explode('_', $key);
1198 $fieldName = $locField[2];
1199 $fieldCount = $locField[3];
1200 $operation = CRM_Utils_Array
::value('operation', $migrationInfo['location'][$fieldName][$fieldCount]);
1201 // default operation is overwrite.
1206 $locBlocks[$fieldName][$fieldCount]['operation'] = $operation;
1207 $locBlocks[$fieldName][$fieldCount]['locTypeId'] = CRM_Utils_Array
::value('locTypeId', $migrationInfo['location'][$fieldName][$fieldCount]);
1209 elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') {
1210 $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1211 if (array_key_exists('operation', $migrationInfo)) {
1212 foreach ($relTables[substr($key, 5)]['tables'] as $table) {
1213 if (array_key_exists($key, $migrationInfo['operation'])) {
1214 $tableOperations[$table] = $migrationInfo['operation'][$key];
1222 // **** Do location related migration:
1223 if (!empty($locBlocks)) {
1224 $locComponent = array(
1228 'openid' => 'OpenID',
1229 'address' => 'Address',
1232 $primaryBlockIds = CRM_Contact_BAO_Contact
::getLocBlockIds($mainId, array('is_primary' => 1));
1233 $billingBlockIds = CRM_Contact_BAO_Contact
::getLocBlockIds($mainId, array('is_billing' => 1));
1235 foreach ($locBlocks as $name => $block) {
1236 if (!is_array($block) || CRM_Utils_System
::isNull($block)) {
1239 $daoName = 'CRM_Core_DAO_' . $locComponent[$name];
1240 $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ?
array_pop($primaryBlockIds[$name]) : NULL;
1241 $billingDAOId = (array_key_exists($name, $billingBlockIds)) ?
array_pop($billingBlockIds[$name]) : NULL;
1243 foreach ($block as $blkCount => $values) {
1244 $locTypeId = CRM_Utils_Array
::value('locTypeId', $values, 1);
1245 $operation = CRM_Utils_Array
::value('operation', $values, 2);
1246 $otherBlockId = CRM_Utils_Array
::value($blkCount,
1247 $migrationInfo['other_details']['loc_block_ids'][$name]
1250 // keep 1-1 mapping for address - loc type.
1252 if (array_key_exists($name, $locComponent)) {
1253 $idKey = $locTypeId;
1256 if (isset($migrationInfo['main_details']['loc_block_ids'][$name])) {
1257 $mainBlockId = CRM_Utils_Array
::value($idKey, $migrationInfo['main_details']['loc_block_ids'][$name]);
1260 if (!$otherBlockId) {
1264 // for the block which belongs to other-contact, link the contact to main-contact
1265 $otherBlockDAO = new $daoName();
1266 $otherBlockDAO->id
= $otherBlockId;
1267 $otherBlockDAO->contact_id
= $mainId;
1268 $otherBlockDAO->location_type_id
= $locTypeId;
1270 // if main contact already has primary & billing, set the flags to 0.
1271 if ($primaryDAOId) {
1272 $otherBlockDAO->is_primary
= 0;
1274 if ($billingDAOId) {
1275 $otherBlockDAO->is_billing
= 0;
1278 // overwrite - need to delete block which belongs to main-contact.
1279 if ($mainBlockId && ($operation == 2)) {
1280 $deleteDAO = new $daoName();
1281 $deleteDAO->id
= $mainBlockId;
1282 $deleteDAO->find(TRUE);
1284 // if we about to delete a primary / billing block, set the flags for new block
1285 // that we going to assign to main-contact
1286 if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id
)) {
1287 $otherBlockDAO->is_primary
= 1;
1289 if ($billingDAOId && ($billingDAOId == $deleteDAO->id
)) {
1290 $otherBlockDAO->is_billing
= 1;
1293 $deleteDAO->delete();
1297 $otherBlockDAO->update();
1298 $otherBlockDAO->free();
1303 // **** Do tables related migrations
1304 if (!empty($moveTables)) {
1305 CRM_Dedupe_Merger
::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations);
1306 unset($moveTables, $tableOperations);
1309 // **** Do contact related migrations
1310 CRM_Dedupe_Merger
::moveContactBelongings($mainId, $otherId);
1312 // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact()
1313 $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender');
1314 $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix');
1315 $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix');
1316 $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style');
1317 $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee');
1318 $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting');
1319 $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting');
1320 CRM_Core_OptionGroup
::lookupValues($submitted, $names, TRUE);
1322 // fix custom fields so they're edible by createProfileContact()
1323 static $treeCache = array();
1324 if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) {
1325 $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup
::getTree($migrationInfo['main_details']['contact_type'],
1326 CRM_Core_DAO
::$_nullObject, NULL, -1
1329 $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']];
1332 foreach ($cgTree as $key => $group) {
1333 if (!isset($group['fields'])) {
1336 foreach ($group['fields'] as $fid => $field) {
1337 $cFields[$fid]['attributes'] = $field;
1341 if (!isset($submitted)) {
1342 $submitted = array();
1344 foreach ($submitted as $key => $value) {
1345 if (substr($key, 0, 7) == 'custom_') {
1346 $fid = (int) substr($key, 7);
1347 $htmlType = $cFields[$fid]['attributes']['html_type'];
1348 switch ($htmlType) {
1350 $customFiles[] = $fid;
1351 unset($submitted["custom_$fid"]);
1354 case 'Select Country':
1355 case 'Select State/Province':
1356 $submitted[$key] = CRM_Core_BAO_CustomField
::getDisplayValue($value, $fid, $cFields);
1360 case 'AdvMulti-Select':
1361 case 'Multi-Select':
1362 case 'Multi-Select Country':
1363 case 'Multi-Select State/Province':
1364 // Merge values from both contacts for multivalue fields, CRM-4385
1365 // get the existing custom values from db.
1366 $customParams = array('entityID' => $mainId, $key => TRUE);
1367 $customfieldValues = CRM_Core_BAO_CustomValueTable
::getValues($customParams);
1368 if (!empty($customfieldValues[$key])) {
1369 $existingValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $customfieldValues[$key]);
1370 if (is_array($existingValue) && !empty($existingValue)) {
1371 $mergeValue = $submmtedCustomValue = array();
1373 $submmtedCustomValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
1376 //hack to remove null and duplicate values from array.
1377 foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) {
1378 if ($v != '' && !in_array($v, $mergeValue)) {
1383 //keep state and country as array format.
1384 //for checkbox and m-select format w/ VALUE_SEPARATOR
1385 if (in_array($htmlType, array(
1386 'CheckBox', 'Multi-Select', 'AdvMulti-Select'))) {
1387 $submitted[$key] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1389 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1392 $submitted[$key] = $mergeValue;
1396 elseif (in_array($htmlType, array(
1397 'Multi-Select Country', 'Multi-Select State/Province'))) {
1398 //we require submitted values should be in array format
1400 $mergeValueArray = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
1401 //hack to remove null values from array.
1402 $mergeValue = array();
1403 foreach ($mergeValueArray as $k => $v) {
1408 $submitted[$key] = $mergeValue;
1419 // **** Do file custom fields related migrations
1420 // FIXME: move this someplace else (one of the BAOs) after discussing
1421 // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually,
1422 // like, delete a file...
1424 if (!isset($customFiles)) {
1425 $customFiles = array();
1427 foreach ($customFiles as $customId) {
1428 list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField
::getTableColumnGroup($customId);
1430 // get the contact_id -> file_id mapping
1432 $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})";
1433 $dao = CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray);
1434 while ($dao->fetch()) {
1435 $fileIds[$dao->entity_id
] = $dao->file_id
;
1439 // delete the main contact's file
1440 if (!empty($fileIds[$mainId])) {
1441 CRM_Core_BAO_File
::deleteFileReferences($fileIds[$mainId], $mainId, $customId);
1444 // move the other contact's file to main contact
1445 //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record
1446 if ( CRM_Core_DAO
::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}") ) {
1447 $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}";
1450 $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )";
1452 CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray);
1454 if ( CRM_Core_DAO
::singleValueQuery("
1456 FROM civicrm_entity_file
1457 WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}") ) {
1459 UPDATE civicrm_entity_file
1460 SET entity_id = {$mainId}
1461 WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}";
1465 INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id )
1466 VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )";
1468 CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray);
1471 // move view only custom fields CRM-5362
1472 $viewOnlyCustomFields = array();
1473 foreach ($submitted as $key => $value) {
1474 $fid = (int) substr($key, 7);
1475 if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) {
1476 $viewOnlyCustomFields[$key] = $value;
1480 // special case to set values for view only, CRM-5362
1481 if (!empty($viewOnlyCustomFields)) {
1482 $viewOnlyCustomFields['entityID'] = $mainId;
1483 CRM_Core_BAO_CustomValueTable
::setValues($viewOnlyCustomFields);
1486 // **** Delete other contact & update prev-next caching
1487 $otherParams = array(
1488 'contact_id' => $otherId,
1492 if (CRM_Core_Permission
::check('merge duplicate contacts') &&
1493 CRM_Core_Permission
::check('delete contacts')
1495 // if ext id is submitted then set it null for contact to be deleted
1496 if (!empty($submitted['external_identifier'])) {
1497 $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}";
1498 CRM_Core_DAO
::executeQuery($query);
1501 civicrm_api('contact', 'delete', $otherParams);
1502 CRM_Core_BAO_PrevNextCache
::deleteItem($otherId);
1507 /* CRM_Core_Session::setStatus( ts('Do not have sufficient permission to delete duplicate contact.') ); */
1512 // **** Update contact related info for the main contact
1513 if (!empty($submitted)) {
1514 $submitted['contact_id'] = $mainId;
1516 //update current employer field
1517 if ($currentEmloyerId = CRM_Utils_Array
::value('current_employer_id', $submitted)) {
1518 if (!CRM_Utils_System
::isNull($currentEmloyerId)) {
1519 $submitted['current_employer'] = $submitted['current_employer_id'];
1521 $submitted['current_employer'] = '';
1523 unset($submitted['current_employer_id']);
1526 //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name
1527 if ( !isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id']) ) {
1528 $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id'];
1530 if ( !isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id']) ) {
1531 $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id'];
1534 CRM_Contact_BAO_Contact
::createProfileContact($submitted, CRM_Core_DAO
::$_nullArray, $mainId);
1542 * @return array of field names which will be compared, so everything except ID.
1544 static function getContactFields() {
1545 $contactFields = CRM_Contact_DAO_Contact
::fields();
1546 $invalidFields = array('api_key', 'contact_is_deleted', 'created_date', 'display_name', 'hash', 'id', 'modified_date',
1547 'primary_contact_id', 'sort_name', 'user_unique_id');
1548 foreach ($contactFields as $field => $value) {
1549 if (in_array($field, $invalidFields)) {
1550 unset($contactFields[$field]);
1553 return array_keys($contactFields);
1557 * Added for CRM-12695
1558 * Based on the contactId provided
1559 * add/update membership(s) to related contacts
1563 static function addMembershipToRealtedContacts($contactID) {
1564 $dao = new CRM_Member_DAO_Membership();
1565 $dao->contact_id
= $contactID;
1569 //checks membership of contact itself
1570 while ($dao->fetch()) {
1571 $relationshipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id
, 'relationship_type_id', 'id');
1572 if ($relationshipTypeId) {
1573 $membershipParams = array(
1575 'contact_id' => $dao->contact_id
,
1576 'membership_type_id' => $dao->membership_type_id
,
1577 'join_date' => CRM_Utils_Date
::isoToMysql($dao->join_date
),
1578 'start_date' => CRM_Utils_Date
::isoToMysql($dao->start_date
),
1579 'end_date' => CRM_Utils_Date
::isoToMysql($dao->end_date
),
1580 'source' => $dao->source
,
1581 'status_id' => $dao->status_id
1583 // create/update membership(s) for related contact(s)
1584 CRM_Member_BAO_Membership
::createRelatedMemberships($membershipParams, $dao);
1585 } // end of if relationshipTypeId