CRM/Dedupe/Merger.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Dedupe_Merger {
  36
  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
  40   /**
  41    * @return array
  42    */
  43   public static function relTables() {
  44     static $relTables;
  45
  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'));
  50     }
  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'));
  54     }
  55
  56     if (!$relTables) {
  57       $relTables = array(
  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'),
  62         ),
  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'),
  67         ),
  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'),
  72         ),
  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'),
  77         ),
  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'),
  82         ),
  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'),
  87         ),
  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'),
  92         ),
  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'),
  97         ),
  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'),
 102         ),
 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'),
 107         ),
 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'),
 112         ),
 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'),
 117         ),
 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'),
 122         ),
 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'),
 127         ),
 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'),
 132         ),
 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'),
 137         ),
 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'),
 142         ),
 143         'rel_table_users' => array(
 144           'title' => $title,
 145           'tables' => array('civicrm_uf_match'),
 146           'url' => $userRecordUrl,
 147         ),
 148       );
 149
 150       $relTables += self::getMultiValueCustomSets('relTables');
 151
 152       // Allow hook_civicrm_merge() to adjust $relTables
 153       CRM_Utils_Hook::merge('relTables', $relTables);
 154     }
 155     return $relTables;
 156   }
 157
 158   /**
 159    * Returns the related tables groups for which a contact has any info entered
 160    */
 161   public static function getActiveRelTables($cid) {
 162     $cid = (int) $cid;
 163     $groups = array();
 164
 165     $relTables = self::relTables();
 166     $cidRefs = self::cidRefs();
 167     $eidRefs = self::eidRefs();
 168     foreach ($relTables as $group => $params) {
 169       $sqls = array();
 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";
 174           }
 175         }
 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'";
 179           }
 180         }
 181         foreach ($sqls as $sql) {
 182           if (CRM_Core_DAO::singleValueQuery($sql) > 0) {
 183             $groups[] = $group;
 184           }
 185         }
 186       }
 187     }
 188     return array_unique($groups);
 189   }
 190
 191   /**
 192    * Return tables and their fields referencing civicrm_contact.contact_id explicitly
 193    */
 194   public static function cidRefs() {
 195     static $cidRefs;
 196     if (!$cidRefs) {
 197       $sql = "
 198 SELECT
 199     table_name,
 200     column_name
 201 FROM information_schema.key_column_usage
 202 WHERE
 203     referenced_table_schema = database() AND
 204     referenced_table_name = 'civicrm_contact' AND
 205     referenced_column_name = 'id';
 206       ";
 207       $dao = CRM_Core_DAO::executeQuery($sql);
 208       while ($dao->fetch()) {
 209         $cidRefs[$dao->table_name][] = $dao->column_name;
 210       }
 211
 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';
 214       $dao->free();
 215
 216       // Allow hook_civicrm_merge() to adjust $cidRefs
 217       CRM_Utils_Hook::merge('cidRefs', $cidRefs);
 218     }
 219     return $cidRefs;
 220   }
 221
 222   /**
 223    * Return tables and their fields referencing civicrm_contact.contact_id with entity_id
 224    */
 225   public static function eidRefs() {
 226     static $eidRefs;
 227     if (!$eidRefs) {
 228       // FIXME: this should be generated dynamically from the schema
 229       // tables that reference contacts with entity_{id,table}
 230       $eidRefs = array(
 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'),
 237       );
 238
 239       // Allow hook_civicrm_merge() to adjust $eidRefs
 240       CRM_Utils_Hook::merge('eidRefs', $eidRefs);
 241     }
 242     return $eidRefs;
 243   }
 244
 245   /**
 246    * Return tables using locations
 247    */
 248   public static function locTables() {
 249     static $locTables;
 250     if (!$locTables) {
 251       $locTables = array( 'civicrm_email', 'civicrm_address', 'civicrm_phone' );
 252
 253       // Allow hook_civicrm_merge() to adjust $locTables
 254       CRM_Utils_Hook::merge('locTables', $locTables);
 255     }
 256     return $locTables;
 257   }
 258
 259   /**
 260    * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc.
 261    * @param string $request
 262    *   'relTables' or 'cidRefs'.
 263    * @see CRM-13836
 264    */
 265   public static function getMultiValueCustomSets($request) {
 266     static $data = NULL;
 267     if ($data === NULL) {
 268       $data = array(
 269         'relTables' => array(),
 270         'cidRefs' => array(),
 271       );
 272       $result = civicrm_api3('custom_group', 'get', array(
 273         'is_multiple' => 1,
 274         'extends' => array('IN' => array('Individual', 'Organization', 'Household', 'Contact')),
 275         'return' => array('id', 'title', 'table_name', 'style'),
 276       ));
 277       foreach($result['values'] as $custom) {
 278         $data['cidRefs'][$custom['table_name']] = array('entity_id');
 279         $urlSuffix = $custom['style'] == 'Tab' ? '&selectedChild=custom_' . $custom['id'] : '';
 280         $data['relTables']['rel_table_custom_' . $custom['id']] = array(
 281           'title' => $custom['title'],
 282           'tables' => array($custom['table_name']),
 283           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid' . $urlSuffix),
 284         );
 285       }
 286     }
 287     return $data[$request];
 288   }
 289
 290   /**
 291    * Tables which require custom processing should declare functions to call here.
 292    * Doing so will override normal processing.
 293    */
 294   public static function cpTables() {
 295     static $tables;
 296     if (!$tables) {
 297       $tables = array(
 298         'civicrm_case_contact' => array('CRM_Case_BAO_Case' => 'mergeContacts'),
 299         'civicrm_group_contact' => array('CRM_Contact_BAO_GroupContact' => 'mergeGroupContact'),
 300         // Empty array == do nothing - this table is handled by mergeGroupContact
 301         'civicrm_subscription_history' => array(),
 302         'civicrm_relationship' => array('CRM_Contact_BAO_Relationship' => 'mergeRelationships'),
 303       );
 304     }
 305     return $tables;
 306   }
 307
 308   /**
 309    * Return payment related table.
 310    */
 311   public static function paymentTables() {
 312     static $tables;
 313     if (!$tables) {
 314       $tables = array('civicrm_pledge', 'civicrm_membership', 'civicrm_participant');
 315     }
 316
 317     return $tables;
 318   }
 319
 320   /**
 321    * Return payment update Query.
 322    */
 323   public static function paymentSql($tableName, $mainContactId, $otherContactId) {
 324     $sqls = array();
 325     if (!$tableName || !$mainContactId || !$otherContactId) {
 326       return $sqls;
 327     }
 328
 329     $paymentTables = self::paymentTables();
 330     if (!in_array($tableName, $paymentTables)) {
 331       return $sqls;
 332     }
 333
 334     switch ($tableName) {
 335       case 'civicrm_pledge':
 336         $sqls[] = "
 337     UPDATE  IGNORE  civicrm_contribution contribution
 338 INNER JOIN  civicrm_pledge_payment payment ON ( payment.contribution_id = contribution.id )
 339 INNER JOIN  civicrm_pledge pledge ON ( pledge.id = payment.pledge_id )
 340        SET  contribution.contact_id = $mainContactId
 341      WHERE  pledge.contact_id = $otherContactId";
 342         break;
 343
 344       case 'civicrm_membership':
 345         $sqls[] = "
 346     UPDATE  IGNORE  civicrm_contribution contribution
 347 INNER JOIN  civicrm_membership_payment payment ON ( payment.contribution_id = contribution.id )
 348 INNER JOIN  civicrm_membership membership ON ( membership.id = payment.membership_id )
 349        SET  contribution.contact_id = $mainContactId
 350      WHERE  membership.contact_id = $otherContactId";
 351         break;
 352
 353       case 'civicrm_participant':
 354         $sqls[] = "
 355     UPDATE  IGNORE  civicrm_contribution contribution
 356 INNER JOIN  civicrm_participant_payment payment ON ( payment.contribution_id = contribution.id )
 357 INNER JOIN  civicrm_participant participant ON ( participant.id = payment.participant_id )
 358        SET  contribution.contact_id = $mainContactId
 359      WHERE  participant.contact_id = $otherContactId";
 360         break;
 361     }
 362
 363     return $sqls;
 364   }
 365
 366   /**
 367    * @param int $mainId
 368    * @param int $otherId
 369    * @param string $tableName
 370    * @param array $tableOperations
 371    * @param string $mode
 372    *
 373    * @return array
 374    */
 375   public static function operationSql($mainId, $otherId, $tableName, $tableOperations = array(), $mode = 'add') {
 376     $sqls = array();
 377     if (!$tableName || !$mainId || !$otherId) {
 378       return $sqls;
 379     }
 380
 381     switch ($tableName) {
 382       case 'civicrm_membership':
 383         if (array_key_exists($tableName, $tableOperations) && $tableOperations[$tableName]['add']) {
 384           break;
 385         }
 386         if ($mode == 'add') {
 387           $sqls[] = "
 388 DELETE membership1.* FROM civicrm_membership membership1
 389  INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
 390              AND membership1.contact_id = {$mainId}
 391              AND membership2.contact_id = {$otherId} ";
 392         }
 393         if ($mode == 'payment') {
 394           $sqls[] = "
 395 DELETE contribution.* FROM civicrm_contribution contribution
 396 INNER JOIN  civicrm_membership_payment payment ON payment.contribution_id = contribution.id
 397 INNER JOIN  civicrm_membership membership1 ON membership1.id = payment.membership_id
 398             AND membership1.contact_id = {$mainId}
 399 INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
 400             AND membership2.contact_id = {$otherId}";
 401         }
 402         break;
 403
 404       case 'civicrm_uf_match':
 405         // normal queries won't work for uf_match since that will lead to violation of unique constraint,
 406         // failing to meet intended result. Therefore we introduce this additonal query:
 407         $sqls[] = "DELETE FROM civicrm_uf_match WHERE contact_id = {$mainId}";
 408         break;
 409     }
 410
 411     return $sqls;
 412   }
 413
 414   /**
 415    * Based on the provided two contact_ids and a set of tables, move the
 416    * belongings of the other contact to the main one.
 417    *
 418    * @static
 419    */
 420   public static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) {
 421     $cidRefs = self::cidRefs();
 422     $eidRefs = self::eidRefs();
 423     $cpTables = self::cpTables();
 424     $paymentTables = self::paymentTables();
 425     $membershipMerge = FALSE; // CRM-12695
 426
 427     $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs));
 428     if ($tables !== FALSE) {
 429       // if there are specific tables, sanitize the list
 430       $affected = array_unique(array_intersect($affected, $tables));
 431     }
 432     else {
 433       // if there aren't any specific tables, don't affect the ones handled by relTables()
 434       // also don't affect tables in locTables() CRM-15658
 435       $relTables = self::relTables();
 436       $handled = self::locTables();
 437       foreach ($relTables as $params) {
 438         $handled = array_merge($handled, $params['tables']);
 439       }
 440       $affected = array_diff($affected, $handled);
 441       /**
 442        * CRM-12695
 443        * Set $membershipMerge flag only once
 444        * while doing contact related migration
 445        * to call addMembershipToRealtedContacts()
 446        * function only once.
 447        * Since the current function (moveContactBelongings) is called twice
 448        * with & without parameters $tables & $tableOperations
 449        */
 450       // retrieve main contact's related table(s)
 451       $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
 452       // check if membership table exists in main contact's related table(s)
 453       if (in_array('rel_table_memberships', $activeMainRelTables)) {
 454         $membershipMerge = TRUE; // set membership flag - CRM-12695
 455       }
 456     }
 457
 458     $mainId = (int) $mainId;
 459     $otherId = (int) $otherId;
 460
 461     $sqls = array();
 462     foreach ($affected as $table) {
 463       // Call custom processing function for objects that require it
 464       if (isset($cpTables[$table])) {
 465         foreach ($cpTables[$table] as $className => $fnName) {
 466           $className::$fnName($mainId, $otherId, $sqls);
 467         }
 468         // Skip normal processing
 469         continue;
 470       }
 471
 472       // use UPDATE IGNORE + DELETE query pair to skip on situations when
 473       // there's a UNIQUE restriction on ($field, some_other_field) pair
 474       if (isset($cidRefs[$table])) {
 475         foreach ($cidRefs[$table] as $field) {
 476           // carry related contributions CRM-5359
 477           if (in_array($table, $paymentTables)) {
 478             $paymentSqls = self::paymentSql($table, $mainId, $otherId);
 479             $sqls = array_merge($sqls, $paymentSqls);
 480
 481             if (!empty($tables) && !in_array('civicrm_contribution', $tables)) {
 482               $payOprSqls = self::operationSql($mainId, $otherId, $table, $tableOperations, 'payment');
 483               $sqls = array_merge($sqls, $payOprSqls);
 484             }
 485           }
 486
 487           $preOperationSqls = self::operationSql($mainId, $otherId, $table, $tableOperations);
 488           $sqls = array_merge($sqls, $preOperationSqls);
 489
 490           $sqls[] = "UPDATE IGNORE $table SET $field = $mainId WHERE $field = $otherId";
 491           $sqls[] = "DELETE FROM $table WHERE $field = $otherId";
 492         }
 493       }
 494       if (isset($eidRefs[$table])) {
 495         foreach ($eidRefs[$table] as $entityTable => $entityId) {
 496           $sqls[] = "UPDATE IGNORE $table SET $entityId = $mainId WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 497           $sqls[] = "DELETE FROM $table WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 498         }
 499       }
 500     }
 501
 502     // Allow hook_civicrm_merge() to add SQL statements for the merge operation.
 503     CRM_Utils_Hook::merge('sqls', $sqls, $mainId, $otherId, $tables);
 504
 505     // call the SQL queries in one transaction
 506     $transaction = new CRM_Core_Transaction();
 507     foreach ($sqls as $sql) {
 508       CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE);
 509     }
 510     // CRM-12695
 511     if ($membershipMerge) {
 512       // call to function adding membership to related contacts
 513       CRM_Dedupe_Merger::addMembershipToRealtedContacts($mainId);
 514     }
 515     $transaction->commit();
 516   }
 517
 518   /**
 519    * Find differences between contacts.
 520    *
 521    * @param array $main
 522    *   Contact details.
 523    * @param array $other
 524    *   Contact details.
 525    *
 526    * @return array
 527    * @static
 528    */
 529   public static function findDifferences($main, $other) {
 530     $result = array(
 531       'contact' => array(),
 532       'custom' => array(),
 533     );
 534     foreach (self::getContactFields() as $validField) {
 535       if (CRM_Utils_Array::value($validField, $main) != CRM_Utils_Array::value($validField, $other)) {
 536         $result['contact'][] = $validField;
 537       }
 538     }
 539
 540     $mainEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($main['id']);
 541     $otherEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($other['id']);
 542     $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs)));
 543     foreach ($keys as $key) {
 544       // Exclude multi-value fields CRM-13836
 545       if (strpos($key, '_')) {
 546         continue;
 547       }
 548       $key1 = CRM_Utils_Array::value($key, $mainEvs);
 549       $key2 = CRM_Utils_Array::value($key, $otherEvs);
 550       if ($key1 != $key2) {
 551         $result['custom'][] = $key;
 552       }
 553     }
 554     return $result;
 555   }
 556
 557   /**
 558    * Batch merge a set of contacts based on rule-group and group.
 559    *
 560    * @param int $rgid
 561    *   Rule group id.
 562    * @param int $gid
 563    *   Group id.
 564    * @param string $mode
 565    *   Helps decide how to behave when there are conflicts.
 566    *                              A 'safe' value skips the merge if there are any un-resolved conflicts.
 567    *                              Does a force merge otherwise.
 568    * @param bool $autoFlipWether to let api decide which contact to retain and which to delete.
 569    *   Wether to let api decide which contact to retain and which to delete.
 570    * @param bool $redirectForPerformance
 571    *
 572    * @return array|bool
 573    * @static
 574    */
 575   public static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $redirectForPerformance = FALSE) {
 576     $contactType = CRM_Core_DAO::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
 577     $cacheKeyString = "merge {$contactType}";
 578     $cacheKeyString .= $rgid ? "_{$rgid}" : '_0';
 579     $cacheKeyString .= $gid ? "_{$gid}" : '_0';
 580     $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
 581                                                              pn.entity_id2 = de.contact_id2 )";
 582
 583     $limit = $redirectForPerformance ? 75 : 1;
 584     $where = "de.id IS NULL LIMIT {$limit}";
 585
 586     $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where);
 587     if (empty($dupePairs) && !$redirectForPerformance) {
 588       // If we haven't found any dupes, probably cache is empty.
 589       // Try filling cache and give another try.
 590       CRM_Core_BAO_PrevNextCache::refillCache($rgid, $gid, $cacheKeyString);
 591       $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where);
 592     }
 593
 594     $cacheParams = array(
 595       'cache_key_string' => $cacheKeyString,
 596       'join' => $join,
 597       'where' => $where,
 598     );
 599     return CRM_Dedupe_Merger::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance);
 600   }
 601
 602   /**
 603    * Merge given set of contacts. Performs core operation.
 604    *
 605    * @param array $dupePairs
 606    *   Set of pair of contacts for whom merge is to be done.
 607    * @param array $cacheParams
 608    *   Prev-next-cache params based on which next pair of contacts are computed.
 609    *                              Generally used with batch-merge.
 610    * @param string $mode
 611    *   Helps decide how to behave when there are conflicts.
 612    *                             A 'safe' value skips the merge if there are any un-resolved conflicts.
 613    *                             Does a force merge otherwise (aggressive mode).
 614    * @param bool $autoFlipWether to let api decide which contact to retain and which to delete.
 615    *   Wether to let api decide which contact to retain and which to delete.
 616    *
 617    *
 618    * @param bool $redirectForPerformance
 619    *
 620    * @return array|bool
 621    * @static
 622    */
 623   public static function merge($dupePairs = array(), $cacheParams = array(), $mode = 'safe',
 624     $autoFlip = TRUE, $redirectForPerformance = FALSE
 625   ) {
 626     $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams);
 627     $resultStats = array('merged' => array(), 'skipped' => array());
 628
 629     // we don't want dupe caching to get reset after every-merge, and therefore set the
 630     // doNotResetCache flag
 631     $config = CRM_Core_Config::singleton();
 632     $config->doNotResetCache = 1;
 633
 634     while (!empty($dupePairs)) {
 635       foreach ($dupePairs as $dupes) {
 636         CRM_Utils_Hook::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']);
 637         $mainId = $dupes['dstID'];
 638         $otherId = $dupes['srcID'];
 639         $isAutoFlip = CRM_Utils_Array::value('auto_flip', $dupes, $autoFlip);
 640         // if we can, make sure that $mainId is the one with lower id number
 641         if ($isAutoFlip && ($mainId > $otherId)) {
 642           $mainId = $dupes['srcID'];
 643           $otherId = $dupes['dstID'];
 644         }
 645         if (!$mainId || !$otherId) {
 646           // return error
 647           return FALSE;
 648         }
 649
 650         // Generate var $migrationInfo. The variable structure is exactly same as
 651         // $formValues submitted during a UI merge for a pair of contacts.
 652         $rowsElementsAndInfo = &CRM_Dedupe_Merger::getRowsElementsAndInfo($mainId, $otherId);
 653
 654         $migrationInfo = &$rowsElementsAndInfo['migration_info'];
 655
 656         // add additional details that we might need to resolve conflicts
 657         $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details'];
 658         $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details'];
 659         $migrationInfo['main_loc_block'] = &$rowsElementsAndInfo['main_loc_block'];
 660         $migrationInfo['rows'] = &$rowsElementsAndInfo['rows'];
 661
 662         // go ahead with merge if there is no conflict
 663         if (!CRM_Dedupe_Merger::skipMerge($mainId, $otherId, $migrationInfo, $mode)) {
 664           CRM_Dedupe_Merger::moveAllBelongings($mainId, $otherId, $migrationInfo);
 665           $resultStats['merged'][] = array('main_d' => $mainId, 'other_id' => $otherId);
 666         }
 667         else {
 668           $resultStats['skipped'][] = array('main_d' => $mainId, 'other_id' => $otherId);
 669         }
 670
 671         // delete entry from PrevNextCache table so we don't consider the pair next time
 672         // pair may have been flipped, so make sure we delete using both orders
 673         CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString);
 674         CRM_Core_BAO_PrevNextCache::deletePair($otherId, $mainId, $cacheKeyString);
 675
 676         CRM_Core_DAO::freeResult();
 677         unset($rowsElementsAndInfo, $migrationInfo);
 678       }
 679
 680       if ($cacheKeyString && !$redirectForPerformance) {
 681         // retrieve next pair of dupes
 682         $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString,
 683           $cacheParams['join'],
 684           $cacheParams['where']
 685         );
 686       }
 687       else {
 688         // do not proceed. Terminate the loop
 689         unset($dupePairs);
 690       }
 691     }
 692     return $resultStats;
 693   }
 694
 695   /**
 696    * A function which uses various rules / algorithms for choosing which contact to bias to
 697    * when there's a conflict (to handle "gotchas"). Plus the safest route to merge.
 698    *
 699    * @param int $mainId
 700    *   Main contact with whom merge has to happen.
 701    * @param int $otherId
 702    *   Duplicate contact which would be deleted after merge operation.
 703    * @param array $migrationInfo
 704    *   Array of information about which elements to merge.
 705    * @param string $mode
 706    *   Helps decide how to behave when there are conflicts.
 707    *                                 A 'safe' value skips the merge if there are any un-resolved conflicts.
 708    *                                 Does a force merge otherwise (aggressive mode).
 709    *
 710    * @return bool
 711    * @static
 712    */
 713   public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe') {
 714     $conflicts = array();
 715     $migrationData = array(
 716       'old_migration_info' => $migrationInfo,
 717       'mode' => $mode,
 718     );
 719     $allLocationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 720
 721     foreach ($migrationInfo as $key => $val) {
 722       if ($val === "null") {
 723         // Rule: no overwriting with empty values in any mode
 724         unset($migrationInfo[$key]);
 725         continue;
 726       }
 727       elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) or
 728           substr($key, 0, 12) == 'move_custom_'
 729         ) and $val != NULL) {
 730         // Rule: if both main-contact has other-contact, let $mode decide if to merge a
 731         // particular field or not
 732         if (!empty($migrationInfo['rows'][$key]['main'])) {
 733           // if main also has a value its a conflict
 734           if ($mode == 'safe') {
 735             // note it down & lets wait for response from the hook.
 736             // For no response skip this merge
 737             $conflicts[$key] = NULL;
 738           }
 739           elseif ($mode == 'aggressive') {
 740             // let the main-field be overwritten
 741             continue;
 742           }
 743         }
 744       }
 745       elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) {
 746         $locField = explode('_', $key);
 747         $fieldName = $locField[2];
 748         $fieldCount = $locField[3];
 749
 750         // Rule: resolve address conflict if any -
 751         if ($fieldName == 'address') {
 752           $mainNewLocTypeId = $migrationInfo['location'][$fieldName][$fieldCount]['locTypeId'];
 753           if (!empty($migrationInfo['main_loc_address']) &&
 754               array_key_exists("main_{$mainNewLocTypeId}", $migrationInfo['main_loc_address'])) {
 755             // main loc already has some address for the loc-type. Its a overwrite situation.
 756
 757             // look for next available loc-type
 758             $newTypeId = NULL;
 759             foreach ($allLocationTypes as $typeId => $typeLabel) {
 760               if (!array_key_exists("main_{$typeId}", $migrationInfo['main_loc_address'])) {
 761                 $newTypeId = $typeId;
 762               }
 763             }
 764             if ($newTypeId) {
 765               // try insert address at new available loc-type
 766               $migrationInfo['location'][$fieldName][$fieldCount]['locTypeId'] = $newTypeId;
 767             }
 768             elseif ($mode == 'safe') {
 769               // note it down & lets wait for response from the hook.
 770               // For no response skip this merge
 771               $conflicts[$key] = NULL;
 772             }
 773             elseif ($mode == 'aggressive') {
 774               // let the loc-type-id be same as that of other-contact & go ahead
 775               // with merge assuming aggressive mode
 776               continue;
 777             }
 778           }
 779         }
 780         elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) {
 781           // for loc blocks other than address like email, phone .. if values are same no point in merging
 782           // and adding redundant value
 783           unset($migrationInfo[$key]);
 784         }
 785       }
 786     }
 787
 788     // A hook to implement other algorithms for choosing which contact to bias to when
 789     // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here
 790     // merge happens with new values filled in here. For a particular field / row not to be merged
 791     // field should be unset from fields_in_conflict.
 792     $migrationData['fields_in_conflict'] = $conflicts;
 793     CRM_Utils_Hook::merge('batch', $migrationData, $mainId, $otherId);
 794     $conflicts = $migrationData['fields_in_conflict'];
 795
 796     if (!empty($conflicts)) {
 797       foreach ($conflicts as $key => $val) {
 798         if ($val === NULL and $mode == 'safe') {
 799           // un-resolved conflicts still present. Lets skip this merge.
 800           return TRUE;
 801         }
 802         else {
 803           // copy over the resolved values
 804           $migrationInfo[$key] = $val;
 805         }
 806       }
 807     }
 808     return FALSE;
 809   }
 810
 811   /**
 812    * A function to build an array of information required by merge function and the merge UI.
 813    *
 814    * @param int $mainId
 815    *   Main contact with whom merge has to happen.
 816    * @param int $otherId
 817    *   Duplicate contact which would be deleted after merge operation.
 818    *
 819    * @return array|bool|int
 820    * @static
 821    */
 822   public static function getRowsElementsAndInfo($mainId, $otherId) {
 823     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
 824
 825     // Fetch contacts
 826     foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
 827       $params = array('contact_id' => $cid, 'version' => 3, 'return' => array_merge(array('display_name'), self::getContactFields()));
 828       $result = civicrm_api('contact', 'get', $params);
 829
 830       if (empty($result['values'][$cid]['contact_type'])) {
 831         return FALSE;
 832       }
 833       $$moniker = $result['values'][$cid];
 834     }
 835
 836     static $fields = array();
 837     if (empty($fields)) {
 838       $fields = CRM_Contact_DAO_Contact::fields();
 839       CRM_Core_DAO::freeResult();
 840     }
 841
 842     // FIXME: there must be a better way
 843     foreach (array('main', 'other') as $moniker) {
 844       $contact = &$$moniker;
 845       $preferred_communication_method = CRM_Utils_array::value('preferred_communication_method', $contact);
 846       $value = empty($preferred_communication_method) ? array() : $preferred_communication_method;
 847       $specialValues[$moniker] = array(
 848         'preferred_communication_method' => $value,
 849         'communication_style_id' => $value,
 850       );
 851
 852       if (!empty($contact['preferred_communication_method'])){
 853         // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct
 854         $prefCommList = is_array($specialValues[$moniker]['preferred_communication_method']) ? implode(CRM_Core_DAO::VALUE_SEPARATOR, $specialValues[$moniker]['preferred_communication_method']) : $specialValues[$moniker]['preferred_communication_method'];
 855         $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO::VALUE_SEPARATOR . $prefCommList . CRM_Core_DAO::VALUE_SEPARATOR;
 856       }
 857       $names = array(
 858         'preferred_communication_method' =>
 859         array(
 860           'newName' => 'preferred_communication_method_display',
 861           'groupName' => 'preferred_communication_method',
 862         ),
 863       );
 864       CRM_Core_OptionGroup::lookupValues($specialValues[$moniker], $names);
 865
 866       if (!empty($contact['communication_style'])) {
 867         $specialValues[$moniker]['communication_style_id_display'] = $contact['communication_style'];
 868       }
 869     }
 870
 871     static $optionValueFields = array();
 872     if (empty($optionValueFields)) {
 873       $optionValueFields = CRM_Core_OptionValue::getFields();
 874     }
 875     foreach ($optionValueFields as $field => $params) {
 876       $fields[$field]['title'] = $params['title'];
 877     }
 878
 879     $diffs = self::findDifferences($main, $other);
 880
 881     $rows = $elements = $relTableElements = $migrationInfo = array();
 882
 883     $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
 884
 885     foreach ($diffs['contact'] as $field) {
 886       if ($field == 'contact_sub_type') {
 887         // CRM-15681 don't display sub-types in UI
 888         continue;
 889       }
 890       foreach (array('main', 'other') as $moniker) {
 891         $contact = &$$moniker;
 892         $value = CRM_Utils_Array::value($field, $contact);
 893         if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) {
 894           $value = CRM_Core_DAO::VALUE_SEPARATOR . trim($specialValues[$moniker][$field], CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR;
 895         }
 896         $label = isset($specialValues[$moniker]["{$field}_display"]) ? $specialValues[$moniker]["{$field}_display"] : $value;
 897         if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_DATE) {
 898           if ($value) {
 899             $value = str_replace('-', '', $value);
 900             $label = CRM_Utils_Date::customFormat($label);
 901           }
 902           else {
 903             $value = "null";
 904           }
 905         }
 906         elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_BOOLEAN) {
 907           if ($label === '0') {
 908             $label = ts('[ ]');
 909           }
 910           if ($label === '1') {
 911             $label = ts('[x]');
 912           }
 913         }
 914         elseif ($field == 'individual_prefix' || $field == 'prefix_id') {
 915           $label = CRM_Utils_Array::value('individual_prefix', $contact);
 916           $value = CRM_Utils_Array::value('prefix_id', $contact);
 917           $field = 'prefix_id';
 918         }
 919         elseif ($field == 'individual_suffix' || $field == 'suffix_id') {
 920           $label = CRM_Utils_Array::value('individual_suffix', $contact);
 921           $value = CRM_Utils_Array::value('suffix_id', $contact);
 922           $field = 'suffix_id';
 923         }
 924         elseif ($field == 'gender_id' && !empty($value)) {
 925           $label = $genders[$value];
 926         }
 927         elseif ($field == 'current_employer_id' && !empty($value)) {
 928           $label = "$value (" . CRM_Contact_BAO_Contact::displayName($value) . ")";
 929         }
 930         $rows["move_$field"][$moniker] = $label;
 931         if ($moniker == 'other') {
 932           //CRM-14334
 933           if ($value === NULL || $value == '') {
 934             $value = 'null';
 935           }
 936           if ($value === 0 or $value === '0') {
 937             $value = $qfZeroBug;
 938           }
 939           if (is_array($value) && empty($value[1])) {
 940             $value[1] = NULL;
 941           }
 942           $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value);
 943           $migrationInfo["move_$field"] = $value;
 944         }
 945       }
 946       $rows["move_$field"]['title'] = $fields[$field]['title'];
 947     }
 948
 949     // handle location blocks.
 950     $locationBlocks = array('email', 'phone', 'address');
 951     $locations = array();
 952
 953     foreach ($locationBlocks as $block) {
 954       foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
 955         $cnt = 1;
 956         $values = civicrm_api($block, 'get', array('contact_id' => $cid, 'version' => 3));
 957         $count = $values['count'];
 958         if ($count) {
 959           if ($count > $cnt) {
 960             foreach ($values['values'] as $value) {
 961               if ($block == 'address') {
 962                 CRM_Core_BAO_Address::fixAddress($value);
 963                 $display = CRM_Utils_Address::format($value);
 964                 $locations[$moniker][$block][$cnt] = $value;
 965                 $locations[$moniker][$block][$cnt]['display'] = $display;
 966               }
 967               else {
 968                 $locations[$moniker][$block][$cnt] = $value;
 969               }
 970
 971               $cnt++;
 972             }
 973           }
 974           else {
 975             $id = $values['id'];
 976             if ($block == 'address') {
 977               CRM_Core_BAO_Address::fixAddress($values['values'][$id]);
 978               $display = CRM_Utils_Address::format($values['values'][$id]);
 979               $locations[$moniker][$block][$cnt] = $values['values'][$id];
 980               $locations[$moniker][$block][$cnt]['display'] = $display;
 981             }
 982             else {
 983               $locations[$moniker][$block][$cnt] = $values['values'][$id];
 984             }
 985           }
 986         }
 987       }
 988     }
 989
 990     $allLocationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 991
 992     $mainLocBlock = $locBlockIds = array();
 993     $locBlockIds['main'] = $locBlockIds['other'] = array();
 994     foreach (array('Email', 'Phone', 'IM', 'OpenID', 'Address') as $block) {
 995       $name = strtolower($block);
 996       foreach (array('main', 'other') as $moniker) {
 997         $locIndex = CRM_Utils_Array::value($moniker, $locations);
 998         $blockValue = CRM_Utils_Array::value($name, $locIndex, array());
 999         if (empty($blockValue)) {
1000           $locValue[$moniker][$name] = 0;
1001           $locLabel[$moniker][$name] = $locTypes[$moniker][$name] = array();
1002         }
1003         else {
1004           $locValue[$moniker][$name] = TRUE;
1005           foreach ($blockValue as $count => $blkValues) {
1006             $fldName = $name;
1007             $locTypeId = $blkValues['location_type_id'];
1008             if ($name == 'im') {
1009               $fldName = 'name';
1010             }
1011             if ($name == 'address') {
1012               $fldName = 'display';
1013             }
1014             $locLabel[$moniker][$name][$count] = CRM_Utils_Array::value($fldName,
1015               $blkValues
1016             );
1017             $locTypes[$moniker][$name][$count] = $locTypeId;
1018             if ($moniker == 'main' && in_array($name, $locationBlocks)) {
1019               $mainLocBlock["main_$name$locTypeId"] = CRM_Utils_Array::value($fldName,
1020                 $blkValues
1021               );
1022               $locBlockIds['main'][$name][$locTypeId] = $blkValues['id'];
1023             }
1024             else {
1025               $locBlockIds[$moniker][$name][$count] = $blkValues['id'];
1026             }
1027           }
1028         }
1029       }
1030
1031       if ($locValue['other'][$name] != 0) {
1032         foreach ($locLabel['other'][$name] as $count => $value) {
1033           $locTypeId = $locTypes['other'][$name][$count];
1034           $rows["move_location_{$name}_$count"]['other'] = $value;
1035           $rows["move_location_{$name}_$count"]['main'] = CRM_Utils_Array::value($count,
1036             $locLabel['main'][$name]
1037           );
1038           $rows["move_location_{$name}_$count"]['title'] = ts('%1:%2:%3',
1039             array(
1040               1 => $block,
1041               2 => $count,
1042               3 => $allLocationTypes[$locTypeId]
1043             )
1044           );
1045
1046           $elements[] = array('advcheckbox', "move_location_{$name}_{$count}");
1047           $migrationInfo["move_location_{$name}_{$count}"] = 1;
1048
1049           // make sure default location type is always on top
1050           $mainLocTypeId = CRM_Utils_Array::value($count, $locTypes['main'][$name], $locTypeId);
1051           $locTypeValues = $allLocationTypes;
1052           $defaultLocType = array($mainLocTypeId => $locTypeValues[$mainLocTypeId]);
1053           unset($locTypeValues[$mainLocTypeId]);
1054
1055           // keep 1-1 mapping for address - location type.
1056           $js = NULL;
1057           if (in_array($name, $locationBlocks) && !empty($mainLocBlock)) {
1058             $js = array('onChange' => "mergeBlock('$name', this, $count );");
1059           }
1060           $elements[] = array(
1061             'select', "location[{$name}][$count][locTypeId]", NULL,
1062             $defaultLocType + $locTypeValues, $js,
1063           );
1064           // keep location-type-id same as that of other-contact
1065           $migrationInfo['location'][$name][$count]['locTypeId'] = $locTypeId;
1066
1067           if ($name != 'address') {
1068             $elements[] = array('advcheckbox', "location[{$name}][$count][operation]", NULL, ts('add new'));
1069             // always use add operation
1070             $migrationInfo['location'][$name][$count]['operation'] = 1;
1071           }
1072         }
1073       }
1074     }
1075
1076     // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1077     $config = CRM_Core_Config::singleton();
1078     $mainUfId = CRM_Core_BAO_UFMatch::getUFId($mainId);
1079     $mainUser = NULL;
1080     if ($mainUfId) {
1081       // d6 compatible
1082       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1083         $mainUser = user_load($mainUfId);
1084       }
1085       elseif ($config->userFramework == 'Joomla') {
1086         $mainUser = JFactory::getUser($mainUfId);
1087       }
1088     }
1089     $otherUfId = CRM_Core_BAO_UFMatch::getUFId($otherId);
1090     $otherUser = NULL;
1091     if ($otherUfId) {
1092       // d6 compatible
1093       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1094         $otherUser = user_load($otherUfId);
1095       }
1096       elseif ($config->userFramework == 'Joomla') {
1097         $otherUser = JFactory::getUser($otherUfId);
1098       }
1099     }
1100
1101     $relTables = CRM_Dedupe_Merger::relTables();
1102     $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($otherId);
1103     $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
1104     foreach ($relTables as $name => $null) {
1105       if (!in_array($name, $activeRelTables) &&
1106         !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables))
1107       ) {
1108         unset($relTables[$name]);
1109         continue;
1110       }
1111
1112       $relTableElements[] = array('checkbox', "move_$name");
1113       $migrationInfo["move_$name"] = 1;
1114
1115       $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']);
1116       $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']);
1117       if ($name == 'rel_table_users') {
1118         $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']);
1119         $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']);
1120         $find = array('$ufid', '$ufname');
1121         if ($mainUser) {
1122           $replace = array($mainUfId, $mainUser->name);
1123           $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1124         }
1125         if ($otherUser) {
1126           $replace = array($otherUfId, $otherUser->name);
1127           $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1128         }
1129       }
1130       if ($name == 'rel_table_memberships') {
1131         $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new'));
1132         $migrationInfo["operation"]["move_{$name}"]['add'] = 1;
1133       }
1134     }
1135     foreach ($relTables as $name => $null) {
1136       $relTables["move_$name"] = $relTables[$name];
1137       unset($relTables[$name]);
1138     }
1139
1140     // handle custom fields
1141     $mainTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $mainId, -1,
1142       CRM_Utils_Array::value('contact_sub_type', $main)
1143     );
1144     $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $otherId, -1,
1145       CRM_Utils_Array::value('contact_sub_type', $other)
1146     );
1147     CRM_Core_DAO::freeResult();
1148
1149     foreach ($otherTree as $gid => $group) {
1150       $foundField = FALSE;
1151       if (!isset($group['fields'])) {
1152         continue;
1153       }
1154
1155       foreach ($group['fields'] as $fid => $field) {
1156         if (in_array($fid, $diffs['custom'])) {
1157           if (!$foundField) {
1158             $rows["custom_group_$gid"]['title'] = $group['title'];
1159             $foundField = TRUE;
1160           }
1161           if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) {
1162             foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1163               $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomGroup::formatCustomValues($values,
1164                 $field, TRUE
1165               );
1166             }
1167           }
1168           $value = "null";
1169           if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) {
1170             foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1171               $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomGroup::formatCustomValues($values,
1172                 $field, TRUE
1173               );
1174               if ($values['data'] === 0 || $values['data'] === '0') {
1175                 $values['data'] = $qfZeroBug;
1176               }
1177               $value = ($values['data']) ? $values['data'] : $value;
1178             }
1179           }
1180           $rows["move_custom_$fid"]['title'] = $field['label'];
1181
1182           $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value);
1183           $migrationInfo["move_custom_$fid"] = $value;
1184         }
1185       }
1186     }
1187     $result = array(
1188       'rows' => $rows,
1189       'elements' => $elements,
1190       'rel_table_elements' => $relTableElements,
1191       'main_loc_block' => $mainLocBlock,
1192       'rel_tables' => $relTables,
1193       'main_details' => $main,
1194       'other_details' => $other,
1195       'migration_info' => $migrationInfo,
1196     );
1197
1198     $result['main_details']['loc_block_ids'] = $locBlockIds['main'];
1199     $result['other_details']['loc_block_ids'] = $locBlockIds['other'];
1200
1201     return $result;
1202   }
1203
1204   /**
1205    * Based on the provided two contact_ids and a set of tables, move the belongings of the
1206    * other contact to the main one - be it Location / CustomFields or Contact .. related info.
1207    * A superset of moveContactBelongings() function.
1208    *
1209    * @param int $mainId
1210    *   Main contact with whom merge has to happen.
1211    * @param int $otherId
1212    *   Duplicate contact which would be deleted after merge operation.
1213    *
1214    * @param $migrationInfo
1215    *
1216    * @return bool
1217    * @static
1218    */
1219   public static function moveAllBelongings($mainId, $otherId, $migrationInfo) {
1220     if (empty($migrationInfo)) {
1221       return FALSE;
1222     }
1223
1224     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1225     $relTables = CRM_Dedupe_Merger::relTables();
1226     $moveTables = $locBlocks = $tableOperations = array();
1227     foreach ($migrationInfo as $key => $value) {
1228       if ($value == $qfZeroBug) {
1229         $value = '0';
1230       }
1231       if ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) ||
1232         substr($key, 0, 12) == 'move_custom_') &&
1233         $value != NULL
1234       ) {
1235         $submitted[substr($key, 5)] = $value;
1236       }
1237       elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) {
1238         $locField = explode('_', $key);
1239         $fieldName = $locField[2];
1240         $fieldCount = $locField[3];
1241         $operation = CRM_Utils_Array::value('operation', $migrationInfo['location'][$fieldName][$fieldCount]);
1242         // default operation is overwrite.
1243         if (!$operation) {
1244           $operation = 2;
1245         }
1246
1247         $locBlocks[$fieldName][$fieldCount]['operation'] = $operation;
1248         $locBlocks[$fieldName][$fieldCount]['locTypeId'] = CRM_Utils_Array::value('locTypeId', $migrationInfo['location'][$fieldName][$fieldCount]);
1249       }
1250       elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') {
1251         $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1252         if (array_key_exists('operation', $migrationInfo)) {
1253           foreach ($relTables[substr($key, 5)]['tables'] as $table) {
1254             if (array_key_exists($key, $migrationInfo['operation'])) {
1255               $tableOperations[$table] = $migrationInfo['operation'][$key];
1256             }
1257           }
1258         }
1259       }
1260     }
1261
1262     // **** Do location related migration:
1263     if (!empty($locBlocks)) {
1264       $locComponent = array(
1265         'email' => 'Email',
1266         'phone' => 'Phone',
1267         'im' => 'IM',
1268         'openid' => 'OpenID',
1269         'address' => 'Address',
1270       );
1271
1272       $primaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_primary' => 1));
1273       $billingBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_billing' => 1));
1274
1275       foreach ($locBlocks as $name => $block) {
1276         if (!is_array($block) || CRM_Utils_System::isNull($block)) {
1277           continue;
1278         }
1279         $daoName = 'CRM_Core_DAO_' . $locComponent[$name];
1280         $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ? array_pop($primaryBlockIds[$name]) : NULL;
1281         $billingDAOId = (array_key_exists($name, $billingBlockIds)) ? array_pop($billingBlockIds[$name]) : NULL;
1282
1283         foreach ($block as $blkCount => $values) {
1284           $locTypeId = CRM_Utils_Array::value('locTypeId', $values, 1);
1285           $operation = CRM_Utils_Array::value('operation', $values, 2);
1286           $otherBlockId = CRM_Utils_Array::value($blkCount,
1287             $migrationInfo['other_details']['loc_block_ids'][$name]
1288           );
1289
1290           // keep 1-1 mapping for address - loc type.
1291           $idKey = $blkCount;
1292           if (array_key_exists($name, $locComponent)) {
1293             $idKey = $locTypeId;
1294           }
1295
1296           if (isset($migrationInfo['main_details']['loc_block_ids'][$name])) {
1297             $mainBlockId = CRM_Utils_Array::value($idKey, $migrationInfo['main_details']['loc_block_ids'][$name]);
1298           }
1299
1300           if (!$otherBlockId) {
1301             continue;
1302           }
1303
1304           // for the block which belongs to other-contact, link the contact to main-contact
1305           $otherBlockDAO = new $daoName();
1306           $otherBlockDAO->id = $otherBlockId;
1307           $otherBlockDAO->contact_id = $mainId;
1308           $otherBlockDAO->location_type_id = $locTypeId;
1309
1310           // if main contact already has primary & billing, set the flags to 0.
1311           if ($primaryDAOId) {
1312             $otherBlockDAO->is_primary = 0;
1313           }
1314           if ($billingDAOId) {
1315             $otherBlockDAO->is_billing = 0;
1316           }
1317
1318           // overwrite - need to delete block which belongs to main-contact.
1319           if ($mainBlockId && ($operation == 2)) {
1320             $deleteDAO = new $daoName();
1321             $deleteDAO->id = $mainBlockId;
1322             $deleteDAO->find(TRUE);
1323
1324             // if we about to delete a primary / billing block, set the flags for new block
1325             // that we going to assign to main-contact
1326             if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id)) {
1327               $otherBlockDAO->is_primary = 1;
1328             }
1329             if ($billingDAOId && ($billingDAOId == $deleteDAO->id)) {
1330               $otherBlockDAO->is_billing = 1;
1331             }
1332
1333             $deleteDAO->delete();
1334             $deleteDAO->free();
1335           }
1336
1337           $otherBlockDAO->update();
1338           $otherBlockDAO->free();
1339         }
1340       }
1341     }
1342
1343     // **** Do tables related migrations
1344     if (!empty($moveTables)) {
1345       CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations);
1346       unset($moveTables, $tableOperations);
1347     }
1348
1349     // **** Do contact related migrations
1350     CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId);
1351
1352     // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact()
1353     $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender');
1354     $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix');
1355     $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix');
1356     $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style');
1357     $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee');
1358     $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting');
1359     $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting');
1360     CRM_Core_OptionGroup::lookupValues($submitted, $names, TRUE);
1361
1362     // fix custom fields so they're edible by createProfileContact()
1363     static $treeCache = array();
1364     if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) {
1365       $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup::getTree($migrationInfo['main_details']['contact_type'],
1366         CRM_Core_DAO::$_nullObject, NULL, -1
1367       );
1368     }
1369     $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']];
1370
1371     $cFields = array();
1372     foreach ($cgTree as $key => $group) {
1373       if (!isset($group['fields'])) {
1374         continue;
1375       }
1376       foreach ($group['fields'] as $fid => $field) {
1377         $cFields[$fid]['attributes'] = $field;
1378       }
1379     }
1380
1381     if (!isset($submitted)) {
1382       $submitted = array();
1383     }
1384     foreach ($submitted as $key => $value) {
1385       if (substr($key, 0, 7) == 'custom_') {
1386         $fid = (int) substr($key, 7);
1387         if (empty($cFields[$fid])) {
1388           continue;
1389         }
1390         $htmlType = $cFields[$fid]['attributes']['html_type'];
1391         switch ($htmlType) {
1392           case 'File':
1393             $customFiles[] = $fid;
1394             unset($submitted["custom_$fid"]);
1395             break;
1396
1397           case 'Select Country':
1398           case 'Select State/Province':
1399             $submitted[$key] = CRM_Core_BAO_CustomField::getDisplayValue($value, $fid, $cFields);
1400             break;
1401
1402           case 'CheckBox':
1403           case 'AdvMulti-Select':
1404           case 'Multi-Select':
1405           case 'Multi-Select Country':
1406           case 'Multi-Select State/Province':
1407             // Merge values from both contacts for multivalue fields, CRM-4385
1408             // get the existing custom values from db.
1409             $customParams = array('entityID' => $mainId, $key => TRUE);
1410             $customfieldValues = CRM_Core_BAO_CustomValueTable::getValues($customParams);
1411             if (!empty($customfieldValues[$key])) {
1412               $existingValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $customfieldValues[$key]);
1413               if (is_array($existingValue) && !empty($existingValue)) {
1414                 $mergeValue = $submmtedCustomValue = array();
1415                 if ($value) {
1416                   $submmtedCustomValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1417                 }
1418
1419                 //hack to remove null and duplicate values from array.
1420                 foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) {
1421                   if ($v != '' && !in_array($v, $mergeValue)) {
1422                     $mergeValue[] = $v;
1423                   }
1424                 }
1425
1426                 //keep state and country as array format.
1427                 //for checkbox and m-select format w/ VALUE_SEPARATOR
1428                 if (in_array($htmlType, array(
1429                   'CheckBox', 'Multi-Select', 'AdvMulti-Select'))) {
1430                   $submitted[$key] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1431                     $mergeValue
1432                   ) . CRM_Core_DAO::VALUE_SEPARATOR;
1433                 }
1434                 else {
1435                   $submitted[$key] = $mergeValue;
1436                 }
1437               }
1438             }
1439             elseif (in_array($htmlType, array(
1440               'Multi-Select Country', 'Multi-Select State/Province'))) {
1441               //we require submitted values should be in array format
1442               if ($value) {
1443                 $mergeValueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1444                 //hack to remove null values from array.
1445                 $mergeValue = array();
1446                 foreach ($mergeValueArray as $k => $v) {
1447                   if ($v != '') {
1448                     $mergeValue[] = $v;
1449                   }
1450                 }
1451                 $submitted[$key] = $mergeValue;
1452               }
1453             }
1454             break;
1455
1456           default:
1457             break;
1458         }
1459       }
1460     }
1461
1462     // **** Do file custom fields related migrations
1463     // FIXME: move this someplace else (one of the BAOs) after discussing
1464     // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually,
1465     // like, delete a file...
1466
1467     if (!isset($customFiles)) {
1468       $customFiles = array();
1469     }
1470     foreach ($customFiles as $customId) {
1471       list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($customId);
1472
1473       // get the contact_id -> file_id mapping
1474       $fileIds = array();
1475       $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})";
1476       $dao = CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray);
1477       while ($dao->fetch()) {
1478         $fileIds[$dao->entity_id] = $dao->file_id;
1479       }
1480       $dao->free();
1481
1482       // delete the main contact's file
1483       if (!empty($fileIds[$mainId])) {
1484         CRM_Core_BAO_File::deleteFileReferences($fileIds[$mainId], $mainId, $customId);
1485       }
1486
1487       // move the other contact's file to main contact
1488       //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record
1489       if ( CRM_Core_DAO::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}") ) {
1490         $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}";
1491       }
1492       else {
1493         $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )";
1494       }
1495       CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray);
1496
1497       if ( CRM_Core_DAO::singleValueQuery("
1498         SELECT id
1499         FROM civicrm_entity_file
1500         WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}") ) {
1501         $sql = "
1502           UPDATE civicrm_entity_file
1503           SET entity_id = {$mainId}
1504           WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}";
1505       }
1506       else {
1507         $sql = "
1508           INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id )
1509           VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )";
1510       }
1511       CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray);
1512     }
1513
1514     // move view only custom fields CRM-5362
1515     $viewOnlyCustomFields = array();
1516     foreach ($submitted as $key => $value) {
1517       $fid = (int) substr($key, 7);
1518       if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) {
1519         $viewOnlyCustomFields[$key] = $value;
1520       }
1521     }
1522
1523     // special case to set values for view only, CRM-5362
1524     if (!empty($viewOnlyCustomFields)) {
1525       $viewOnlyCustomFields['entityID'] = $mainId;
1526       CRM_Core_BAO_CustomValueTable::setValues($viewOnlyCustomFields);
1527     }
1528
1529     // **** Delete other contact & update prev-next caching
1530     $otherParams = array(
1531       'contact_id' => $otherId,
1532       'id' => $otherId,
1533       'version' => 3,
1534     );
1535     if (CRM_Core_Permission::check('merge duplicate contacts') &&
1536       CRM_Core_Permission::check('delete contacts')
1537     ) {
1538       // if ext id is submitted then set it null for contact to be deleted
1539       if (!empty($submitted['external_identifier'])) {
1540         $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}";
1541         CRM_Core_DAO::executeQuery($query);
1542       }
1543
1544       civicrm_api('contact', 'delete', $otherParams);
1545       CRM_Core_BAO_PrevNextCache::deleteItem($otherId);
1546     }
1547     // FIXME: else part
1548     /*         else { */
1549
1550     /*             CRM_Core_Session::setStatus( ts('Do not have sufficient permission to delete duplicate contact.') ); */
1551
1552     /*         } */
1553
1554     // CRM-15681 merge sub_types
1555     if ($other_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['other_details'])) {
1556       if ($main_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['main_details'])) {
1557         $submitted['contact_sub_type'] = array_unique( array_merge($main_sub_types, $other_sub_types));
1558       } else {
1559         $submitted['contact_sub_type'] = $other_sub_types;
1560       }
1561     }
1562
1563     // **** Update contact related info for the main contact
1564     if (!empty($submitted)) {
1565       $submitted['contact_id'] = $mainId;
1566
1567       //update current employer field
1568       if ($currentEmloyerId = CRM_Utils_Array::value('current_employer_id', $submitted)) {
1569         if (!CRM_Utils_System::isNull($currentEmloyerId)) {
1570           $submitted['current_employer'] = $submitted['current_employer_id'];
1571         } else {
1572           $submitted['current_employer'] = '';
1573         }
1574         unset($submitted['current_employer_id']);
1575       }
1576
1577       //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name
1578       if ( !isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id']) ) {
1579         $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id'];
1580       }
1581       if ( !isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id']) ) {
1582         $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id'];
1583       }
1584
1585       CRM_Contact_BAO_Contact::createProfileContact($submitted, CRM_Core_DAO::$_nullArray, $mainId);
1586       unset($submitted);
1587     }
1588
1589     CRM_Utils_Hook::post('merge', 'Contact', $mainId, CRM_Core_DAO::$_nullObject);
1590
1591     return TRUE;
1592   }
1593
1594   /**
1595    * @return array of field names which will be compared, so everything except ID.
1596    */
1597   public static function getContactFields() {
1598     $contactFields = CRM_Contact_DAO_Contact::fields();
1599     $invalidFields = array('api_key', 'contact_is_deleted', 'created_date', 'display_name', 'hash', 'id', 'modified_date',
1600       'primary_contact_id', 'sort_name', 'user_unique_id');
1601     foreach ($contactFields as $field => $value) {
1602       if (in_array($field, $invalidFields)) {
1603         unset($contactFields[$field]);
1604       }
1605     }
1606     return array_keys($contactFields);
1607   }
1608
1609   /**
1610    * Added for CRM-12695
1611    * Based on the contactId provided
1612    * add/update membership(s) to related contacts
1613    *
1614    * @param contactId
1615    */
1616   public static function addMembershipToRealtedContacts($contactID) {
1617     $dao = new CRM_Member_DAO_Membership();
1618     $dao->contact_id = $contactID;
1619     $dao->is_test = 0;
1620     $dao->find();
1621
1622     //checks membership of contact itself
1623     while ($dao->fetch()) {
1624       $relationshipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id, 'relationship_type_id', 'id');
1625       if ($relationshipTypeId) {
1626         $membershipParams = array(
1627           'id' => $dao->id,
1628           'contact_id' => $dao->contact_id,
1629           'membership_type_id' => $dao->membership_type_id,
1630           'join_date' => CRM_Utils_Date::isoToMysql($dao->join_date),
1631           'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date),
1632           'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date),
1633           'source' => $dao->source,
1634           'status_id' => $dao->status_id
1635         );
1636         // create/update membership(s) for related contact(s)
1637         CRM_Member_BAO_Membership::createRelatedMemberships($membershipParams, $dao);
1638       } // end of if relationshipTypeId
1639     }
1640   }
1641 }