CRM/Dedupe/Merger.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33 class CRM_Dedupe_Merger {
  34
  35   /**
  36    * FIXME: consider creating a common structure with cidRefs() and eidRefs()
  37    * FIXME: the sub-pages references by the URLs should
  38    * be loaded dynamically on the merge form instead
  39    * @return array
  40    */
  41   public static function relTables() {
  42     static $relTables;
  43
  44     // Setting these merely prevents enotices - but it may be more appropriate not to add the user table below
  45     // if the url can't be retrieved. A more standardised way to retrieve them is.
  46     // CRM_Core_Config::singleton()->userSystem->getUserRecordUrl() - however that function takes a contact_id &
  47     // we may need a different function when it is not known.
  48     $title = $userRecordUrl = '';
  49
  50     $config = CRM_Core_Config::singleton();
  51     if ($config->userSystem->is_drupal) {
  52       $userRecordUrl = CRM_Utils_System::url('user/%ufid');
  53       $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework, 2 => '$ufname', 3 => '$ufid'));
  54     }
  55     elseif ($config->userFramework == 'Joomla') {
  56       $userRecordUrl = $config->userSystem->getVersion() > 1.5 ? $config->userFrameworkBaseURL . "index.php?option=com_users&view=user&task=user.edit&id=" . '%ufid' : $config->userFrameworkBaseURL . "index2.php?option=com_users&view=user&task=edit&id[]=" . '%ufid';
  57       $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework, 2 => '$ufname', 3 => '$ufid'));
  58     }
  59
  60     if (!$relTables) {
  61       $relTables = array(
  62         'rel_table_contributions' => array(
  63           'title' => ts('Contributions'),
  64           'tables' => array('civicrm_contribution', 'civicrm_contribution_recur', 'civicrm_contribution_soft'),
  65           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=contribute'),
  66         ),
  67         'rel_table_contribution_page' => array(
  68           'title' => ts('Contribution Pages'),
  69           'tables' => array('civicrm_contribution_page'),
  70           'url' => CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1&cid=$cid'),
  71         ),
  72         'rel_table_memberships' => array(
  73           'title' => ts('Memberships'),
  74           'tables' => array('civicrm_membership', 'civicrm_membership_log', 'civicrm_membership_type'),
  75           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=member'),
  76         ),
  77         'rel_table_participants' => array(
  78           'title' => ts('Participants'),
  79           'tables' => array('civicrm_participant'),
  80           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=participant'),
  81         ),
  82         'rel_table_events' => array(
  83           'title' => ts('Events'),
  84           'tables' => array('civicrm_event'),
  85           'url' => CRM_Utils_System::url('civicrm/event/manage', 'reset=1&cid=$cid'),
  86         ),
  87         'rel_table_activities' => array(
  88           'title' => ts('Activities'),
  89           'tables' => array('civicrm_activity', 'civicrm_activity_contact'),
  90           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=activity'),
  91         ),
  92         'rel_table_relationships' => array(
  93           'title' => ts('Relationships'),
  94           'tables' => array('civicrm_relationship'),
  95           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=rel'),
  96         ),
  97         'rel_table_custom_groups' => array(
  98           'title' => ts('Custom Groups'),
  99           'tables' => array('civicrm_custom_group'),
 100           'url' => CRM_Utils_System::url('civicrm/admin/custom/group', 'reset=1'),
 101         ),
 102         'rel_table_uf_groups' => array(
 103           'title' => ts('Profiles'),
 104           'tables' => array('civicrm_uf_group'),
 105           'url' => CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1'),
 106         ),
 107         'rel_table_groups' => array(
 108           'title' => ts('Groups'),
 109           'tables' => array('civicrm_group_contact'),
 110           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=group'),
 111         ),
 112         'rel_table_notes' => array(
 113           'title' => ts('Notes'),
 114           'tables' => array('civicrm_note'),
 115           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=note'),
 116         ),
 117         'rel_table_tags' => array(
 118           'title' => ts('Tags'),
 119           'tables' => array('civicrm_entity_tag'),
 120           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=tag'),
 121         ),
 122         'rel_table_mailings' => array(
 123           'title' => ts('Mailings'),
 124           'tables' => array('civicrm_mailing', 'civicrm_mailing_event_queue', 'civicrm_mailing_event_subscribe'),
 125           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=mailing'),
 126         ),
 127         'rel_table_cases' => array(
 128           'title' => ts('Cases'),
 129           'tables' => array('civicrm_case_contact'),
 130           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=case'),
 131         ),
 132         'rel_table_grants' => array(
 133           'title' => ts('Grants'),
 134           'tables' => array('civicrm_grant'),
 135           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=grant'),
 136         ),
 137         'rel_table_pcp' => array(
 138           'title' => ts('PCPs'),
 139           'tables' => array('civicrm_pcp'),
 140           'url' => CRM_Utils_System::url('civicrm/contribute/pcp/manage', 'reset=1'),
 141         ),
 142         'rel_table_pledges' => array(
 143           'title' => ts('Pledges'),
 144           'tables' => array('civicrm_pledge', 'civicrm_pledge_payment'),
 145           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=pledge'),
 146         ),
 147         'rel_table_users' => array(
 148           'title' => $title,
 149           'tables' => array('civicrm_uf_match'),
 150           'url' => $userRecordUrl,
 151         ),
 152       );
 153
 154       $relTables += self::getMultiValueCustomSets('relTables');
 155
 156       // Allow hook_civicrm_merge() to adjust $relTables
 157       CRM_Utils_Hook::merge('relTables', $relTables);
 158     }
 159     return $relTables;
 160   }
 161
 162   /**
 163    * Returns the related tables groups for which a contact has any info entered.
 164    *
 165    * @param int $cid
 166    *
 167    * @return array
 168    */
 169   public static function getActiveRelTables($cid) {
 170     $cid = (int) $cid;
 171     $groups = array();
 172
 173     $relTables = self::relTables();
 174     $cidRefs = self::cidRefs();
 175     $eidRefs = self::eidRefs();
 176     foreach ($relTables as $group => $params) {
 177       $sqls = array();
 178       foreach ($params['tables'] as $table) {
 179         if (isset($cidRefs[$table])) {
 180           foreach ($cidRefs[$table] as $field) {
 181             $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $field = $cid";
 182           }
 183         }
 184         if (isset($eidRefs[$table])) {
 185           foreach ($eidRefs[$table] as $entityTable => $entityId) {
 186             $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $entityId = $cid AND $entityTable = 'civicrm_contact'";
 187           }
 188         }
 189         foreach ($sqls as $sql) {
 190           if (CRM_Core_DAO::singleValueQuery($sql) > 0) {
 191             $groups[] = $group;
 192           }
 193         }
 194       }
 195     }
 196     return array_unique($groups);
 197   }
 198
 199   /**
 200    * Get array tables and fields that reference civicrm_contact.id.
 201    *
 202    * This includes core tables, custom group tables, tables added by the merge
 203    * hook and (somewhat randomly) the entity_tag table.
 204    *
 205    * Refer to CRM-17454 for information on the danger of querying the information
 206    * schema to derive this.
 207    *
 208    * @todo create an 'entity hook' to allow entities to be registered to CiviCRM
 209    * including all info that is normally in the DAO.
 210    */
 211   public static function cidRefs() {
 212     $cidRefs = array();
 213     $coreReferences = CRM_Core_DAO::getReferencesToTable('civicrm_contact');
 214     foreach ($coreReferences as $coreReference) {
 215       if (!is_a($coreReference, 'CRM_Core_Reference_Dynamic')) {
 216         $cidRefs[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey();
 217       }
 218     }
 219     self::addCustomTablesExtendingContactsToCidRefs($cidRefs);
 220
 221     // FixME for time being adding below line statically as no Foreign key constraint defined for table 'civicrm_entity_tag'
 222     $cidRefs['civicrm_entity_tag'][] = 'entity_id';
 223
 224     // Allow hook_civicrm_merge() to adjust $cidRefs.
 225     // @todo consider adding a way to register entities and have them
 226     // automatically added to this list.
 227     CRM_Utils_Hook::merge('cidRefs', $cidRefs);
 228     return $cidRefs;
 229   }
 230
 231   /**
 232    * Return tables and their fields referencing civicrm_contact.contact_id with entity_id
 233    */
 234   public static function eidRefs() {
 235     static $eidRefs;
 236     if (!$eidRefs) {
 237       // FIXME: this should be generated dynamically from the schema
 238       // tables that reference contacts with entity_{id,table}
 239       $eidRefs = array(
 240         'civicrm_acl' => array('entity_table' => 'entity_id'),
 241         'civicrm_acl_entity_role' => array('entity_table' => 'entity_id'),
 242         'civicrm_entity_file' => array('entity_table' => 'entity_id'),
 243         'civicrm_log' => array('entity_table' => 'entity_id'),
 244         'civicrm_mailing_group' => array('entity_table' => 'entity_id'),
 245         'civicrm_note' => array('entity_table' => 'entity_id'),
 246       );
 247
 248       // Allow hook_civicrm_merge() to adjust $eidRefs
 249       CRM_Utils_Hook::merge('eidRefs', $eidRefs);
 250     }
 251     return $eidRefs;
 252   }
 253
 254   /**
 255    * Return tables using locations.
 256    */
 257   public static function locTables() {
 258     static $locTables;
 259     if (!$locTables) {
 260       $locTables = array('civicrm_email', 'civicrm_address', 'civicrm_phone');
 261
 262       // Allow hook_civicrm_merge() to adjust $locTables
 263       CRM_Utils_Hook::merge('locTables', $locTables);
 264     }
 265     return $locTables;
 266   }
 267
 268   /**
 269    * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc.
 270    * @param string $request
 271    *   'relTables' or 'cidRefs'.
 272    * @see CRM-13836
 273    */
 274   public static function getMultiValueCustomSets($request) {
 275     static $data = NULL;
 276     if ($data === NULL) {
 277       $data = array(
 278         'relTables' => array(),
 279         'cidRefs' => array(),
 280       );
 281       $result = civicrm_api3('custom_group', 'get', array(
 282         'is_multiple' => 1,
 283         'extends' => array('IN' => array('Individual', 'Organization', 'Household', 'Contact')),
 284         'return' => array('id', 'title', 'table_name', 'style'),
 285       ));
 286       foreach ($result['values'] as $custom) {
 287         $data['cidRefs'][$custom['table_name']] = array('entity_id');
 288         $urlSuffix = $custom['style'] == 'Tab' ? '&selectedChild=custom_' . $custom['id'] : '';
 289         $data['relTables']['rel_table_custom_' . $custom['id']] = array(
 290           'title' => $custom['title'],
 291           'tables' => array($custom['table_name']),
 292           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid' . $urlSuffix),
 293         );
 294       }
 295     }
 296     return $data[$request];
 297   }
 298
 299   /**
 300    * Tables which require custom processing should declare functions to call here.
 301    * Doing so will override normal processing.
 302    */
 303   public static function cpTables() {
 304     static $tables;
 305     if (!$tables) {
 306       $tables = array(
 307         'civicrm_case_contact' => array('CRM_Case_BAO_Case' => 'mergeContacts'),
 308         'civicrm_group_contact' => array('CRM_Contact_BAO_GroupContact' => 'mergeGroupContact'),
 309         // Empty array == do nothing - this table is handled by mergeGroupContact
 310         'civicrm_subscription_history' => array(),
 311         'civicrm_relationship' => array('CRM_Contact_BAO_Relationship' => 'mergeRelationships'),
 312       );
 313     }
 314     return $tables;
 315   }
 316
 317   /**
 318    * Return payment related table.
 319    */
 320   public static function paymentTables() {
 321     static $tables;
 322     if (!$tables) {
 323       $tables = array('civicrm_pledge', 'civicrm_membership', 'civicrm_participant');
 324     }
 325     return $tables;
 326   }
 327
 328   /**
 329    * Return payment update Query.
 330    *
 331    * @param string $tableName
 332    * @param int $mainContactId
 333    * @param int $otherContactId
 334    *
 335    * @return array
 336    */
 337   public static function paymentSql($tableName, $mainContactId, $otherContactId) {
 338     $sqls = array();
 339     if (!$tableName || !$mainContactId || !$otherContactId) {
 340       return $sqls;
 341     }
 342
 343     $paymentTables = self::paymentTables();
 344     if (!in_array($tableName, $paymentTables)) {
 345       return $sqls;
 346     }
 347
 348     switch ($tableName) {
 349       case 'civicrm_pledge':
 350         $sqls[] = "
 351     UPDATE  IGNORE  civicrm_contribution contribution
 352 INNER JOIN  civicrm_pledge_payment payment ON ( payment.contribution_id = contribution.id )
 353 INNER JOIN  civicrm_pledge pledge ON ( pledge.id = payment.pledge_id )
 354        SET  contribution.contact_id = $mainContactId
 355      WHERE  pledge.contact_id = $otherContactId";
 356         break;
 357
 358       case 'civicrm_membership':
 359         $sqls[] = "
 360     UPDATE  IGNORE  civicrm_contribution contribution
 361 INNER JOIN  civicrm_membership_payment payment ON ( payment.contribution_id = contribution.id )
 362 INNER JOIN  civicrm_membership membership ON ( membership.id = payment.membership_id )
 363        SET  contribution.contact_id = $mainContactId
 364      WHERE  membership.contact_id = $otherContactId";
 365         break;
 366
 367       case 'civicrm_participant':
 368         $sqls[] = "
 369     UPDATE  IGNORE  civicrm_contribution contribution
 370 INNER JOIN  civicrm_participant_payment payment ON ( payment.contribution_id = contribution.id )
 371 INNER JOIN  civicrm_participant participant ON ( participant.id = payment.participant_id )
 372        SET  contribution.contact_id = $mainContactId
 373      WHERE  participant.contact_id = $otherContactId";
 374         break;
 375     }
 376
 377     return $sqls;
 378   }
 379
 380   /**
 381    * @param int $mainId
 382    * @param int $otherId
 383    * @param string $tableName
 384    * @param array $tableOperations
 385    * @param string $mode
 386    *
 387    * @return array
 388    */
 389   public static function operationSql($mainId, $otherId, $tableName, $tableOperations = array(), $mode = 'add') {
 390     $sqls = array();
 391     if (!$tableName || !$mainId || !$otherId) {
 392       return $sqls;
 393     }
 394
 395     switch ($tableName) {
 396       case 'civicrm_membership':
 397         if (array_key_exists($tableName, $tableOperations) && $tableOperations[$tableName]['add']) {
 398           break;
 399         }
 400         if ($mode == 'add') {
 401           $sqls[] = "
 402 DELETE membership1.* FROM civicrm_membership membership1
 403  INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
 404              AND membership1.contact_id = {$mainId}
 405              AND membership2.contact_id = {$otherId} ";
 406         }
 407         if ($mode == 'payment') {
 408           $sqls[] = "
 409 DELETE contribution.* FROM civicrm_contribution contribution
 410 INNER JOIN  civicrm_membership_payment payment ON payment.contribution_id = contribution.id
 411 INNER JOIN  civicrm_membership membership1 ON membership1.id = payment.membership_id
 412             AND membership1.contact_id = {$mainId}
 413 INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
 414             AND membership2.contact_id = {$otherId}";
 415         }
 416         break;
 417
 418       case 'civicrm_uf_match':
 419         // normal queries won't work for uf_match since that will lead to violation of unique constraint,
 420         // failing to meet intended result. Therefore we introduce this additional query:
 421         $sqls[] = "DELETE FROM civicrm_uf_match WHERE contact_id = {$mainId}";
 422         break;
 423     }
 424
 425     return $sqls;
 426   }
 427
 428   /**
 429    * Based on the provided two contact_ids and a set of tables, move the
 430    * belongings of the other contact to the main one.
 431    *
 432    * @param int $mainId
 433    * @param int $otherId
 434    * @param bool $tables
 435    * @param array $tableOperations
 436    */
 437   public static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) {
 438     $cidRefs = self::cidRefs();
 439     $eidRefs = self::eidRefs();
 440     $cpTables = self::cpTables();
 441     $paymentTables = self::paymentTables();
 442     // CRM-12695:
 443     $membershipMerge = FALSE;
 444
 445     $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs));
 446     if ($tables !== FALSE) {
 447       // if there are specific tables, sanitize the list
 448       $affected = array_unique(array_intersect($affected, $tables));
 449     }
 450     else {
 451       // if there aren't any specific tables, don't affect the ones handled by relTables()
 452       // also don't affect tables in locTables() CRM-15658
 453       $relTables = self::relTables();
 454       $handled = self::locTables();
 455       foreach ($relTables as $params) {
 456         $handled = array_merge($handled, $params['tables']);
 457       }
 458       $affected = array_diff($affected, $handled);
 459       /**
 460        * CRM-12695
 461        * Set $membershipMerge flag only once
 462        * while doing contact related migration
 463        * to call addMembershipToRealtedContacts()
 464        * function only once.
 465        * Since the current function (moveContactBelongings) is called twice
 466        * with & without parameters $tables & $tableOperations
 467        */
 468       // retrieve main contact's related table(s)
 469       $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
 470       // check if membership table exists in main contact's related table(s)
 471       // set membership flag - CRM-12695
 472       if (in_array('rel_table_memberships', $activeMainRelTables)) {
 473         $membershipMerge = TRUE;
 474       }
 475     }
 476
 477     $mainId = (int) $mainId;
 478     $otherId = (int) $otherId;
 479
 480     $sqls = array();
 481     foreach ($affected as $table) {
 482       // Call custom processing function for objects that require it
 483       if (isset($cpTables[$table])) {
 484         foreach ($cpTables[$table] as $className => $fnName) {
 485           $className::$fnName($mainId, $otherId, $sqls);
 486         }
 487         // Skip normal processing
 488         continue;
 489       }
 490
 491       // use UPDATE IGNORE + DELETE query pair to skip on situations when
 492       // there's a UNIQUE restriction on ($field, some_other_field) pair
 493       if (isset($cidRefs[$table])) {
 494         foreach ($cidRefs[$table] as $field) {
 495           // carry related contributions CRM-5359
 496           if (in_array($table, $paymentTables)) {
 497             $paymentSqls = self::paymentSql($table, $mainId, $otherId);
 498             $sqls = array_merge($sqls, $paymentSqls);
 499
 500             if (!empty($tables) && !in_array('civicrm_contribution', $tables)) {
 501               $payOprSqls = self::operationSql($mainId, $otherId, $table, $tableOperations, 'payment');
 502               $sqls = array_merge($sqls, $payOprSqls);
 503             }
 504           }
 505
 506           $preOperationSqls = self::operationSql($mainId, $otherId, $table, $tableOperations);
 507           $sqls = array_merge($sqls, $preOperationSqls);
 508
 509           $sqls[] = "UPDATE IGNORE $table SET $field = $mainId WHERE $field = $otherId";
 510           $sqls[] = "DELETE FROM $table WHERE $field = $otherId";
 511         }
 512       }
 513       if (isset($eidRefs[$table])) {
 514         foreach ($eidRefs[$table] as $entityTable => $entityId) {
 515           $sqls[] = "UPDATE IGNORE $table SET $entityId = $mainId WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 516           $sqls[] = "DELETE FROM $table WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 517         }
 518       }
 519     }
 520
 521     // Allow hook_civicrm_merge() to add SQL statements for the merge operation.
 522     CRM_Utils_Hook::merge('sqls', $sqls, $mainId, $otherId, $tables);
 523
 524     // call the SQL queries in one transaction
 525     $transaction = new CRM_Core_Transaction();
 526     foreach ($sqls as $sql) {
 527       CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE);
 528     }
 529     // CRM-12695
 530     if ($membershipMerge) {
 531       // call to function adding membership to related contacts
 532       CRM_Dedupe_Merger::addMembershipToRealtedContacts($mainId);
 533     }
 534     $transaction->commit();
 535   }
 536
 537   /**
 538    * Load all non-empty fields for the contacts
 539    *
 540    * @param array $main
 541    *   Contact details.
 542    * @param array $other
 543    *   Contact details.
 544    *
 545    * @return array
 546    */
 547   public static function retrieveFields($main, $other) {
 548     $result = array(
 549       'contact' => array(),
 550       'custom' => array(),
 551     );
 552     foreach (self::getContactFields() as $validField) {
 553       // CRM-17556 Get all non-empty fields, to make comparison easier
 554       if (!empty($main[$validField]) || !empty($other[$validField])) {
 555         $result['contact'][] = $validField;
 556       }
 557     }
 558
 559     $mainEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($main['id']);
 560     $otherEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($other['id']);
 561     $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs)));
 562     foreach ($keys as $key) {
 563       // Exclude multi-value fields CRM-13836
 564       if (strpos($key, '_')) {
 565         continue;
 566       }
 567       $key1 = CRM_Utils_Array::value($key, $mainEvs);
 568       $key2 = CRM_Utils_Array::value($key, $otherEvs);
 569       // CRM-17556 Get all non-empty fields, to make comparison easier
 570       if (!empty($key1) || !empty($key2)) {
 571         $result['custom'][] = $key;
 572       }
 573     }
 574     return $result;
 575   }
 576
 577   /**
 578    * Batch merge a set of contacts based on rule-group and group.
 579    *
 580    * @param int $rgid
 581    *   Rule group id.
 582    * @param int $gid
 583    *   Group id.
 584    * @param string $mode
 585    *   Helps decide how to behave when there are conflicts.
 586    *   A 'safe' value skips the merge if there are any un-resolved conflicts, wheras 'aggressive'
 587    *   mode does a force merge.
 588    * @param bool $autoFlip to let api decide which contact to retain and which to delete.
 589    *   Whether to let api decide which contact to retain and which to delete.
 590    * @param int $batchLimit number of merges to carry out in one batch.
 591    * @param int $isSelected if records with is_selected column needs to be processed.
 592    *
 593    * @param array $criteria
 594    *   Criteria to use in the filter.
 595    *
 596    * @param bool $checkPermissions
 597    *   Respect logged in user permissions.
 598    *
 599    * @return array|bool
 600    */
 601   public static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $batchLimit = 1, $isSelected = 2, $criteria = array(), $checkPermissions = TRUE) {
 602     $redirectForPerformance = ($batchLimit > 1) ? TRUE : FALSE;
 603     $reloadCacheIfEmpty = (!$redirectForPerformance && $isSelected == 2);
 604     $dupePairs = self::getDuplicatePairs($rgid, $gid, $reloadCacheIfEmpty, $batchLimit, $isSelected, '', ($mode == 'aggressive'), $criteria, $checkPermissions);
 605
 606     $cacheParams = array(
 607       'cache_key_string' => self::getMergeCacheKeyString($rgid, $gid, $criteria, $checkPermissions),
 608       // @todo stop passing these parameters in & instead calculate them in the merge function based
 609       // on the 'real' params like $isRespectExclusions $batchLimit and $isSelected.
 610       'join' => self::getJoinOnDedupeTable(),
 611       'where' => self::getWhereString($batchLimit, $isSelected),
 612     );
 613     return CRM_Dedupe_Merger::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance, $checkPermissions);
 614   }
 615
 616   /**
 617    * Get the string to join the prevnext cache to the dedupe table.
 618    *
 619    * @return string
 620    *   The join string to join prevnext cache on the dedupe table.
 621    */
 622   public static function getJoinOnDedupeTable() {
 623     return "
 624       LEFT JOIN civicrm_dedupe_exception de
 625         ON (
 626           pn.entity_id1 = de.contact_id1
 627           AND pn.entity_id2 = de.contact_id2 )
 628        ";
 629   }
 630
 631   /**
 632    * Get where string for dedupe join.
 633    *
 634    * @param int $batchLimit
 635    * @param bool $isSelected
 636    *
 637    * @return string
 638    */
 639   protected static function getWhereString($batchLimit, $isSelected) {
 640     $where = "de.id IS NULL";
 641     if ($isSelected === 0 || $isSelected === 1) {
 642       $where .= " AND pn.is_selected = {$isSelected}";
 643     }
 644     // else consider all dupe pairs
 645     // @todo Adding limit to Where??!!
 646     $where .= " LIMIT {$batchLimit}";
 647     return $where;
 648   }
 649
 650   public static function updateMergeStats($cacheKeyString, $result = array()) {
 651     // gather latest stats
 652     $merged  = count($result['merged']);
 653     $skipped = count($result['skipped']);
 654
 655     if ($merged <= 0 && $skipped <= 0) {
 656       return;
 657     }
 658
 659     // get previous stats
 660     $previousStats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats");
 661     if (!empty($previousStats)) {
 662       if ($previousStats[0]['merged']) {
 663         $merged = $merged + $previousStats[0]['merged'];
 664       }
 665       if ($previousStats[0]['skipped']) {
 666         $skipped = $skipped + $previousStats[0]['skipped'];
 667       }
 668     }
 669
 670     // delete old stats
 671     CRM_Dedupe_Merger::resetMergeStats($cacheKeyString);
 672
 673     // store the updated stats
 674     $data = array(
 675       'merged'  => $merged,
 676       'skipped' => $skipped,
 677     );
 678     $data = CRM_Core_DAO::escapeString(serialize($data));
 679
 680     $values   = array();
 681     $values[] = " ( 'civicrm_contact', 0, 0, '{$cacheKeyString}_stats', '$data' ) ";
 682     CRM_Core_BAO_PrevNextCache::setItem($values);
 683   }
 684
 685   /**
 686    * Delete information about merges for the given string.
 687    *
 688    * @param $cacheKeyString
 689    */
 690   public static function resetMergeStats($cacheKeyString) {
 691     CRM_Core_BAO_PrevNextCache::deleteItem(NULL, "{$cacheKeyString}_stats");
 692   }
 693
 694   public static function getMergeStats($cacheKeyString) {
 695     $stats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats");
 696     if (!empty($stats)) {
 697       $stats = $stats[0];
 698     }
 699     return $stats;
 700   }
 701
 702   public static function getMergeStatsMsg($cacheKeyString) {
 703     $msg   = '';
 704     $stats = CRM_Dedupe_Merger::getMergeStats($cacheKeyString);
 705     if (!empty($stats['merged'])) {
 706       $msg = "{$stats['merged']} " . ts('Contact(s) were merged.');
 707     }
 708     if (!empty($stats['skipped'])) {
 709       $msg .= $stats['skipped'] . ts('Contact(s) were skipped.');
 710     }
 711     return $msg;
 712   }
 713
 714   /**
 715    * Merge given set of contacts. Performs core operation.
 716    *
 717    * @param array $dupePairs
 718    *   Set of pair of contacts for whom merge is to be done.
 719    * @param array $cacheParams
 720    *   Prev-next-cache params based on which next pair of contacts are computed.
 721    *                              Generally used with batch-merge.
 722    * @param string $mode
 723    *   Helps decide how to behave when there are conflicts.
 724    *                             A 'safe' value skips the merge if there are any un-resolved conflicts.
 725    *                             Does a force merge otherwise (aggressive mode).
 726    * @param bool $autoFlip to let api decide which contact to retain and which to delete.
 727    *   Whether to let api decide which contact to retain and which to delete.
 728    *
 729    * @param bool $redirectForPerformance
 730    *   Redirect to a url for batch processing.
 731    *
 732    * @param bool $checkPermissions
 733    *   Respect logged in user permissions.
 734    *
 735    * @return array|bool
 736    */
 737   public static function merge($dupePairs = array(), $cacheParams = array(), $mode = 'safe',
 738                                $autoFlip = TRUE, $redirectForPerformance = FALSE, $checkPermissions = TRUE
 739   ) {
 740     $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams);
 741     $resultStats = array('merged' => array(), 'skipped' => array());
 742
 743     // we don't want dupe caching to get reset after every-merge, and therefore set the
 744     // doNotResetCache flag
 745     $config = CRM_Core_Config::singleton();
 746     $config->doNotResetCache = 1;
 747     $deletedContacts = array();
 748
 749     while (!empty($dupePairs)) {
 750       foreach ($dupePairs as $index => $dupes) {
 751         if (in_array($dupes['dstID'], $deletedContacts) || in_array($dupes['srcID'], $deletedContacts)) {
 752           unset($dupePairs[$index]);
 753           continue;
 754         }
 755         CRM_Utils_Hook::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']);
 756         $mainId = $dupes['dstID'];
 757         $otherId = $dupes['srcID'];
 758         $isAutoFlip = CRM_Utils_Array::value('auto_flip', $dupes, $autoFlip);
 759         // if we can, make sure that $mainId is the one with lower id number
 760         if ($isAutoFlip && ($mainId > $otherId)) {
 761           $mainId = $dupes['srcID'];
 762           $otherId = $dupes['dstID'];
 763         }
 764         if (!$mainId || !$otherId) {
 765           // return error
 766           return FALSE;
 767         }
 768
 769         // Generate var $migrationInfo. The variable structure is exactly same as
 770         // $formValues submitted during a UI merge for a pair of contacts.
 771         $rowsElementsAndInfo = CRM_Dedupe_Merger::getRowsElementsAndInfo($mainId, $otherId, $checkPermissions);
 772
 773         $migrationInfo = &$rowsElementsAndInfo['migration_info'];
 774
 775         // add additional details that we might need to resolve conflicts
 776         $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details'];
 777         $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details'];
 778         $migrationInfo['rows'] = &$rowsElementsAndInfo['rows'];
 779
 780         // go ahead with merge if there is no conflict
 781         $conflicts = array();
 782         if (!CRM_Dedupe_Merger::skipMerge($mainId, $otherId, $migrationInfo, $mode, $conflicts)) {
 783           CRM_Dedupe_Merger::moveAllBelongings($mainId, $otherId, $migrationInfo, $checkPermissions);
 784           $resultStats['merged'][] = array('main_id' => $mainId, 'other_id' => $otherId);
 785           $deletedContacts[] = $otherId;
 786         }
 787         else {
 788           $resultStats['skipped'][] = array('main_id' => $mainId, 'other_id' => $otherId);
 789         }
 790
 791         // store any conflicts
 792         if (!empty($conflicts)) {
 793           foreach ($conflicts as $key => $dnc) {
 794             $conflicts[$key] = "{$migrationInfo['rows'][$key]['title']}: '{$migrationInfo['rows'][$key]['main']}' vs. '{$migrationInfo['rows'][$key]['other']}'";
 795           }
 796           CRM_Core_BAO_PrevNextCache::markConflict($mainId, $otherId, $cacheKeyString, $conflicts);
 797         }
 798         else {
 799           // delete entry from PrevNextCache table so we don't consider the pair next time
 800           // pair may have been flipped, so make sure we delete using both orders
 801           CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString, TRUE);
 802         }
 803
 804         CRM_Core_DAO::freeResult();
 805         unset($rowsElementsAndInfo, $migrationInfo);
 806       }
 807
 808       if ($cacheKeyString && !$redirectForPerformance) {
 809         // retrieve next pair of dupes
 810         // @todo call getDuplicatePairs.
 811         $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString,
 812           $cacheParams['join'],
 813           $cacheParams['where'],
 814           0,
 815           0,
 816           array(),
 817           '',
 818           FALSE
 819         );
 820       }
 821       else {
 822         // do not proceed. Terminate the loop
 823         unset($dupePairs);
 824       }
 825     }
 826
 827     CRM_Dedupe_Merger::updateMergeStats($cacheKeyString, $resultStats);
 828     return $resultStats;
 829   }
 830
 831   /**
 832    * A function which uses various rules / algorithms for choosing which contact to bias to
 833    * when there's a conflict (to handle "gotchas"). Plus the safest route to merge.
 834    *
 835    * @param int $mainId
 836    *   Main contact with whom merge has to happen.
 837    * @param int $otherId
 838    *   Duplicate contact which would be deleted after merge operation.
 839    * @param array $migrationInfo
 840    *   Array of information about which elements to merge.
 841    * @param string $mode
 842    *   Helps decide how to behave when there are conflicts.
 843    *   -  A 'safe' value skips the merge if there are any un-resolved conflicts.
 844    *   -  Does a force merge otherwise (aggressive mode).
 845    *
 846    * @param array $conflicts
 847    *
 848    * @return bool
 849    */
 850   public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe', &$conflicts = array()) {
 851
 852     $originalMigrationInfo = $migrationInfo;
 853     foreach ($migrationInfo as $key => $val) {
 854       if ($val === "null") {
 855         // Rule: Never overwrite with an empty value (in any mode)
 856         unset($migrationInfo[$key]);
 857         continue;
 858       }
 859       elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) or
 860           substr($key, 0, 12) == 'move_custom_'
 861         ) and $val != NULL
 862       ) {
 863         // Rule: If both main-contact, and other-contact have a field with a
 864         // different value, then let $mode decide if to merge it or not
 865         if (
 866           (!empty($migrationInfo['rows'][$key]['main'])
 867             // For custom fields a 0 (e.g in an int field) could be a true conflict. This
 868             // is probably true for other fields too - e.g. 'do_not_email' but
 869             // leaving that investigation as a @todo - until tests can be written.
 870             // Note the handling of this has test coverage - although the data-typing
 871             // of '0' feels flakey we have insurance.
 872             || ($migrationInfo['rows'][$key]['main'] === '0' && substr($key, 0, 12) == 'move_custom_')
 873           )
 874           && $migrationInfo['rows'][$key]['main'] != $migrationInfo['rows'][$key]['other']
 875         ) {
 876
 877           // note it down & lets wait for response from the hook.
 878           // For no response $mode will decide if to skip this merge
 879           $conflicts[$key] = NULL;
 880         }
 881       }
 882       elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) {
 883         $locField = explode('_', $key);
 884         $fieldName = $locField[2];
 885         $fieldCount = $locField[3];
 886
 887         // Rule: Catch address conflicts (same address type on both contacts)
 888         if ($fieldName == 'address') {
 889           if (
 890             isset($migrationInfo['main_details']['location_blocks']['address']) &&
 891             !empty($migrationInfo['main_details']['location_blocks']['address'])
 892           ) {
 893             $otherAddresses = $migrationInfo['other_details']['location_blocks']['address'];
 894             $otherAddressLookup = array();
 895             foreach ($otherAddresses as $otherAddressIndex => $otherAddress) {
 896               $otherAddressLookup[$otherAddress['location_type_id']] = $otherAddressIndex;
 897             }
 898             // Look for this LocTypeId in the results
 899             // @todo This can be streamlined using array_column() in PHP 5.5+
 900             foreach ($migrationInfo['main_details']['location_blocks']['address'] as $addressKey => $addressRecord) {
 901               $otherAddressIndex = CRM_Utils_Array::value($addressRecord['location_type_id'], $otherAddressLookup);
 902               $hasMatchingAddress = FALSE;
 903               foreach ($otherAddresses as $otherAddress) {
 904                 if (self::addressIsSame($addressRecord, $otherAddress)) {
 905                   $hasMatchingAddress = TRUE;
 906                 }
 907               }
 908               if ($hasMatchingAddress) {
 909                 unset($migrationInfo[$key]);
 910               }
 911               elseif (!empty($otherAddresses[$otherAddressIndex]) && !self::addressIsSame($addressRecord, $otherAddresses[$otherAddressIndex])) {
 912                 $conflicts[$key] = NULL;
 913                 break;
 914               }
 915             }
 916           }
 917         }
 918         // For other locations, don't merge/add if the values are the same
 919         elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) {
 920           unset($migrationInfo[$key]);
 921         }
 922       }
 923     }
 924
 925     // A hook to implement other algorithms for choosing which contact to bias to when
 926     // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here
 927     // merge happens with new values filled in here. For a particular field / row not to be merged
 928     // field should be unset from fields_in_conflict.
 929     $migrationData = array(
 930       'old_migration_info' => $originalMigrationInfo,
 931       'mode' => $mode,
 932       'fields_in_conflict' => $conflicts,
 933       'merge_mode' => $mode,
 934       'migration_info' => $migrationInfo,
 935     );
 936     CRM_Utils_Hook::merge('batch', $migrationData, $mainId, $otherId);
 937     $conflicts = $migrationData['fields_in_conflict'];
 938     // allow hook to override / manipulate migrationInfo as well
 939     $migrationInfo = $migrationData['migration_info'];
 940
 941     if (!empty($conflicts)) {
 942       foreach ($conflicts as $key => $val) {
 943         if ($val === NULL and $mode == 'safe') {
 944           // un-resolved conflicts still present. Lets skip this merge after saving the conflict / reason.
 945           return TRUE;
 946         }
 947         else {
 948           // copy over the resolved values
 949           $migrationInfo[$key] = $val;
 950         }
 951       }
 952       // if there are conflicts and mode is aggressive, allow hooks to decide if to skip merges
 953       if (array_key_exists('skip_merge', $migrationData)) {
 954         return (bool) $migrationData['skip_merge'];
 955       }
 956     }
 957     return FALSE;
 958   }
 959
 960   /**
 961    * Compare 2 addresses to see if they are the same.
 962    *
 963    * @param array $mainAddress
 964    * @param array $comparisonAddress
 965    *
 966    * @return bool
 967    */
 968   static protected function addressIsSame($mainAddress, $comparisonAddress) {
 969     $keysToIgnore = array('id', 'is_primary', 'is_billing', 'manual_geo_code', 'contact_id');
 970     foreach ($comparisonAddress as $field => $value) {
 971       if (in_array($field, $keysToIgnore)) {
 972         continue;
 973       }
 974       if (!empty($value) && $mainAddress[$field] != $value) {
 975         return FALSE;
 976       }
 977     }
 978     return TRUE;
 979   }
 980
 981   /**
 982    * A function to build an array of information about location blocks that is
 983    * required when merging location fields
 984    *
 985    * @return array
 986    */
 987   public static function getLocationBlockInfo() {
 988     $locationBlocks = array(
 989       'address' => array(
 990         'label' => 'Address',
 991         'displayField' => 'display',
 992         'sortString' => 'location_type_id',
 993         'hasLocation' => TRUE,
 994         'hasType' => FALSE,
 995       ),
 996       'email' => array(
 997         'label' => 'Email',
 998         'displayField' => 'email',
 999         'sortString' => 'location_type_id',
1000         'hasLocation' => TRUE,
1001         'hasType' => FALSE,
1002       ),
1003       'im' => array(
1004         'label' => 'IM',
1005         'displayField' => 'name',
1006         'sortString' => 'location_type_id,provider_id',
1007         'hasLocation' => TRUE,
1008         'hasType' => 'provider_id',
1009       ),
1010       'phone' => array(
1011         'label' => 'Phone',
1012         'displayField' => 'phone',
1013         'sortString' => 'location_type_id,phone_type_id',
1014         'hasLocation' => TRUE,
1015         'hasType' => 'phone_type_id',
1016       ),
1017       'website' => array(
1018         'label' => 'Website',
1019         'displayField' => 'url',
1020         'sortString' => 'website_type_id',
1021         'hasLocation' => FALSE,
1022         'hasType' => 'website_type_id',
1023       ),
1024     );
1025     return $locationBlocks;
1026   }
1027
1028   /**
1029    * A function to build an array of information required by merge function and the merge UI.
1030    *
1031    * @param int $mainId
1032    *   Main contact with whom merge has to happen.
1033    * @param int $otherId
1034    *   Duplicate contact which would be deleted after merge operation.
1035    * @param bool $checkPermissions
1036    *   Should the logged in user's permissions be ignore. Setting this to false is
1037    *   highly risky as it could cause data to be lost due to conflicts not showing up.
1038    *   OTOH there is a risk a merger might view custom data they do not have permission to.
1039    *   Hence for now only making this really explicit and making it reflect perms in
1040    *   an api call.
1041    *
1042    * @todo review permissions issue!
1043    *
1044    * @return array|bool|int
1045    *
1046    *   rows => An array of arrays, each is row of merge information for the table
1047    *   Format: move_fieldname, eg: move_contact_type
1048    *     main => Value associated with the main contact
1049    *     other => Value associated with the other contact
1050    *     title => The title of the field to display in the merge table
1051    *
1052    *   elements => An array of form elements for the merge UI
1053    *
1054    *   rel_table_elements => An array of form elements for the merge UI for
1055    *     entities related to the contact (eg: checkbox to move 'mailings')
1056    *
1057    *   rel_tables => Stores the tables that have related entities for the contact
1058    *     for example mailings, groups
1059    *
1060    *   main_details => An array of core contact field values, eg: first_name, etc.
1061    *     location_blocks => An array of location block data for the main contact
1062    *       stored as the 'result' of an API call.
1063    *       eg: main_details['location_blocks']['address'][0]['id']
1064    *       eg: main_details['location_blocks']['email'][1]['id']
1065    *
1066    *   other_details => As above, but for the 'other' contact
1067    *
1068    *   migration_info => Stores the 'default' merge actions for each field which
1069    *     is used when programatically merging contacts. It contains instructions
1070    *     to move all fields from the 'other' contact to the 'main' contact, as
1071    *     though the form had been submitted with those options.
1072    *
1073    * @throws \CRM_Core_Exception
1074    * @throws \CiviCRM_API3_Exception
1075    * @throws \Exception
1076    */
1077   public static function getRowsElementsAndInfo($mainId, $otherId, $checkPermissions = TRUE) {
1078     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1079
1080     // Fetch contacts
1081     foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
1082       $params = array(
1083         'contact_id' => $cid,
1084         'version' => 3,
1085         'return' => array_merge(array('display_name'), self::getContactFields()),
1086       );
1087       $result = civicrm_api('contact', 'get', $params);
1088
1089       if (empty($result['values'][$cid]['contact_type'])) {
1090         return FALSE;
1091       }
1092
1093       // CRM-18480: Cancel the process if the contact is already deleted
1094       if (isset($result['values'][$cid]['contact_is_deleted']) && !empty($result['values'][$cid]['contact_is_deleted'])) {
1095         throw new CRM_Core_Exception(ts('Cannot merge because the \'%1\' contact (ID %2) has been deleted.', array(1 => $moniker, 2 => $cid)));
1096       }
1097
1098       $$moniker = $result['values'][$cid];
1099     }
1100
1101     $fields = CRM_Contact_DAO_Contact::fields();
1102
1103     // FIXME: there must be a better way
1104     foreach (array('main', 'other') as $moniker) {
1105       $contact = &$$moniker;
1106       $preferred_communication_method = CRM_Utils_array::value('preferred_communication_method', $contact);
1107       $value = empty($preferred_communication_method) ? array() : $preferred_communication_method;
1108       $specialValues[$moniker] = array(
1109         'preferred_communication_method' => $value,
1110         'communication_style_id' => $value,
1111       );
1112
1113       if (!empty($contact['preferred_communication_method'])) {
1114         // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct
1115         $prefCommList = is_array($specialValues[$moniker]['preferred_communication_method']) ? implode(CRM_Core_DAO::VALUE_SEPARATOR, $specialValues[$moniker]['preferred_communication_method']) : $specialValues[$moniker]['preferred_communication_method'];
1116         $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO::VALUE_SEPARATOR . $prefCommList . CRM_Core_DAO::VALUE_SEPARATOR;
1117       }
1118       $names = array(
1119         'preferred_communication_method' => array(
1120           'newName' => 'preferred_communication_method_display',
1121           'groupName' => 'preferred_communication_method',
1122         ),
1123       );
1124       CRM_Core_OptionGroup::lookupValues($specialValues[$moniker], $names);
1125
1126       if (!empty($contact['communication_style'])) {
1127         $specialValues[$moniker]['communication_style_id_display'] = $contact['communication_style'];
1128       }
1129     }
1130
1131     static $optionValueFields = array();
1132     if (empty($optionValueFields)) {
1133       $optionValueFields = CRM_Core_OptionValue::getFields();
1134     }
1135     foreach ($optionValueFields as $field => $params) {
1136       $fields[$field]['title'] = $params['title'];
1137     }
1138
1139     $compareFields = self::retrieveFields($main, $other);
1140
1141     $rows = $elements = $relTableElements = $migrationInfo = array();
1142
1143     foreach ($compareFields['contact'] as $field) {
1144       if ($field == 'contact_sub_type') {
1145         // CRM-15681 don't display sub-types in UI
1146         continue;
1147       }
1148       foreach (array('main', 'other') as $moniker) {
1149         $contact = &$$moniker;
1150         $value = CRM_Utils_Array::value($field, $contact);
1151         if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) {
1152           $value = CRM_Core_DAO::VALUE_SEPARATOR . trim($specialValues[$moniker][$field], CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR;
1153         }
1154         $label = isset($specialValues[$moniker]["{$field}_display"]) ? $specialValues[$moniker]["{$field}_display"] : $value;
1155         if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_DATE) {
1156           if ($value) {
1157             $value = str_replace('-', '', $value);
1158             $label = CRM_Utils_Date::customFormat($label);
1159           }
1160           else {
1161             $value = "null";
1162           }
1163         }
1164         elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_BOOLEAN) {
1165           if ($label === '0') {
1166             $label = ts('[ ]');
1167           }
1168           if ($label === '1') {
1169             $label = ts('[x]');
1170           }
1171         }
1172         elseif ($field == 'individual_prefix' || $field == 'prefix_id') {
1173           $label = CRM_Utils_Array::value('individual_prefix', $contact);
1174           $value = CRM_Utils_Array::value('prefix_id', $contact);
1175           $field = 'prefix_id';
1176         }
1177         elseif ($field == 'individual_suffix' || $field == 'suffix_id') {
1178           $label = CRM_Utils_Array::value('individual_suffix', $contact);
1179           $value = CRM_Utils_Array::value('suffix_id', $contact);
1180           $field = 'suffix_id';
1181         }
1182         elseif ($field == 'gender_id' && !empty($value)) {
1183           $genderOptions = civicrm_api3('contact', 'getoptions', array('field' => 'gender_id'));
1184           $label = $genderOptions['values'][$value];
1185         }
1186         elseif ($field == 'current_employer_id' && !empty($value)) {
1187           $label = "$value (" . CRM_Contact_BAO_Contact::displayName($value) . ")";
1188         }
1189         $rows["move_$field"][$moniker] = $label;
1190         if ($moniker == 'other') {
1191           //CRM-14334
1192           if ($value === NULL || $value == '') {
1193             $value = 'null';
1194           }
1195           if ($value === 0 or $value === '0') {
1196             $value = $qfZeroBug;
1197           }
1198           if (is_array($value) && empty($value[1])) {
1199             $value[1] = NULL;
1200           }
1201
1202           // Display a checkbox to migrate, only if the values are different
1203           if ($value != $main[$field]) {
1204             $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value);
1205           }
1206
1207           $migrationInfo["move_$field"] = $value;
1208         }
1209       }
1210       $rows["move_$field"]['title'] = $fields[$field]['title'];
1211     }
1212
1213     // Handle location blocks.
1214     // @todo OpenID not in API yet, so is not supported here.
1215
1216     // Set up useful information about the location blocks
1217     $locationBlocks = self::getLocationBlockInfo();
1218
1219     $locations = array(
1220       'main' => array(),
1221       'other' => array(),
1222     );
1223
1224     // @todo This could probably be defined and used earlier
1225     $mergeTargets = array(
1226       'main' => $mainId,
1227       'other' => $otherId,
1228     );
1229
1230     foreach ($locationBlocks as $blockName => $blockInfo) {
1231
1232       // Collect existing fields from both 'main' and 'other' contacts first
1233       // This allows us to match up location/types when building the table rows
1234       foreach ($mergeTargets as $moniker => $cid) {
1235         $cnt = 1;
1236         $searchParams = array(
1237           'version' => 3,
1238           'contact_id' => $cid,
1239           // CRM-17556 Order by field-specific criteria
1240           'options' => array(
1241             'sort' => $blockInfo['sortString'],
1242           ),
1243         );
1244         $values = civicrm_api($blockName, 'get', $searchParams);
1245         if ($values['count']) {
1246           $cnt = 0;
1247           foreach ($values['values'] as $index => $value) {
1248             $locations[$moniker][$blockName][$cnt] = $value;
1249             // Fix address display
1250             if ($blockName == 'address') {
1251               CRM_Core_BAO_Address::fixAddress($value);
1252               $locations[$moniker][$blockName][$cnt]['display'] = CRM_Utils_Address::format($value);
1253             }
1254
1255             $cnt++;
1256           }
1257         }
1258       }
1259
1260       // Now, build the table rows appropriately, based off the information on
1261       // the 'other' contact
1262       if (!empty($locations['other']) && !empty($locations['other'][$blockName])) {
1263         foreach ($locations['other'][$blockName] as $count => $value) {
1264
1265           $displayValue = $value[$blockInfo['displayField']];
1266
1267           // Add this value to the table rows
1268           $rows["move_location_{$blockName}_{$count}"]['other'] = $displayValue;
1269
1270           // CRM-17556 Only display 'main' contact value if it's the same location + type
1271           // Look it up from main values...
1272
1273           $lookupLocation = FALSE;
1274           if ($blockInfo['hasLocation']) {
1275             $lookupLocation = $value['location_type_id'];
1276           }
1277
1278           $lookupType = FALSE;
1279           if ($blockInfo['hasType']) {
1280             $lookupType = $value[$blockInfo['hasType']];
1281           }
1282
1283           // Hold ID of main contact's matching block
1284           $mainContactBlockId = 0;
1285
1286           if (!empty($locations['main'][$blockName])) {
1287             foreach ($locations['main'][$blockName] as $mainValueCheck) {
1288               // No location/type, or matching location and type
1289               if (
1290                 (empty($lookupLocation) || $lookupLocation == $mainValueCheck['location_type_id'])
1291                 && (empty($lookupType) || $lookupType == $mainValueCheck[$blockInfo['hasType']])
1292               ) {
1293                 // Set this value as the default against the 'other' contact value
1294                 $rows["move_location_{$blockName}_{$count}"]['main'] = $mainValueCheck[$blockInfo['displayField']];
1295                 $mainContactBlockId = $mainValueCheck['id'];
1296                 break;
1297               }
1298             }
1299           }
1300
1301           // Add checkbox to migrate data from 'other' to 'main'
1302           $elements[] = array('advcheckbox', "move_location_{$blockName}_{$count}");
1303
1304           // Flag up this field to skipMerge function (@todo: do we need to?)
1305           $migrationInfo["move_location_{$blockName}_{$count}"] = 1;
1306
1307           // Add a hidden field to store the ID of the target main contact block
1308           $elements[] = array('hidden', "location_blocks[$blockName][$count][mainContactBlockId]", $mainContactBlockId);
1309
1310           // Setup variables
1311           $thisTypeId = FALSE;
1312           $thisLocId = FALSE;
1313
1314           // Provide a select drop-down for the location's location type
1315           // eg: Home, Work...
1316
1317           $js = NULL;
1318
1319           if ($blockInfo['hasLocation']) {
1320
1321             // Load the location options for this entity
1322             $locationOptions = civicrm_api3($blockName, 'getoptions', array('field' => 'location_type_id'));
1323
1324             // JS lookup 'main' contact's location (if there are any)
1325             if (!empty($locations['main'][$blockName])) {
1326               $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'locTypeId' );");
1327             }
1328
1329             $thisLocId = $value['location_type_id'];
1330
1331             // Put this field's location type at the top of the list
1332             $tmpIdList = $locationOptions['values'];
1333             $defaultLocId = array($thisLocId => $tmpIdList[$thisLocId]);
1334             unset($tmpIdList[$thisLocId]);
1335
1336             // Add the element
1337             $elements[] = array(
1338               'select',
1339               "location_blocks[$blockName][$count][locTypeId]",
1340               NULL,
1341               $defaultLocId + $tmpIdList,
1342               $js,
1343             );
1344
1345             // Add the relevant information to the $migrationInfo
1346             // Keep location-type-id same as that of other-contact
1347             // @todo Check this logic out
1348             $migrationInfo['location_blocks'][$blockName][$count]['locTypeId'] = $thisLocId;
1349             if ($blockName != 'address') {
1350               $elements[] = array('advcheckbox', "location_blocks[{$blockName}][$count][operation]", NULL, ts('add new'));
1351               // always use add operation
1352               $migrationInfo['location_blocks'][$blockName][$count]['operation'] = 1;
1353             }
1354
1355           }
1356
1357           // Provide a select drop-down for the location's type/provider
1358           // eg websites: Google+, Facebook...
1359
1360           $js = NULL;
1361
1362           if ($blockInfo['hasType']) {
1363
1364             // Load the type options for this entity
1365             $typeOptions = civicrm_api3($blockName, 'getoptions', array('field' => $blockInfo['hasType']));
1366
1367             // CRM-17556 Set up JS lookup of 'main' contact's value by type
1368             if (!empty($locations['main'][$blockName])) {
1369               $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'typeTypeId' );");
1370             }
1371
1372             $thisTypeId = $value[$blockInfo['hasType']];
1373
1374             // Put this field's location type at the top of the list
1375             $tmpIdList = $typeOptions['values'];
1376             $defaultTypeId = array($thisTypeId => $tmpIdList[$thisTypeId]);
1377             unset($tmpIdList[$thisTypeId]);
1378
1379             // Add the element
1380             $elements[] = array(
1381               'select',
1382               "location_blocks[$blockName][$count][typeTypeId]",
1383               NULL,
1384               $defaultTypeId + $tmpIdList,
1385               $js,
1386             );
1387
1388             // Add the information to the migrationInfo
1389             $migrationInfo['location_blocks'][$blockName][$count]['typeTypeId'] = $thisTypeId;
1390
1391           }
1392
1393           // Set the label for this row
1394           $rowTitle = $blockInfo['label'] . ' ' . ($count + 1);
1395           if (!empty($thisLocId)) {
1396             $rowTitle .= ' (' . $locationOptions['values'][$thisLocId] . ')';
1397           }
1398           if (!empty($thisTypeId)) {
1399             $rowTitle .= ' (' . $typeOptions['values'][$thisTypeId] . ')';
1400           }
1401           $rows["move_location_{$blockName}_$count"]['title'] = $rowTitle;
1402
1403         } // End loop through 'other' locations of this type
1404
1405       } // End if 'other' location for this type exists
1406
1407     } // End loop through each location block entity
1408
1409     // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1410     $config = CRM_Core_Config::singleton();
1411     $mainUfId = CRM_Core_BAO_UFMatch::getUFId($mainId);
1412     $mainUser = NULL;
1413     if ($mainUfId) {
1414       // d6 compatible
1415       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1416         $mainUser = user_load($mainUfId);
1417       }
1418       elseif ($config->userFramework == 'Joomla') {
1419         $mainUser = JFactory::getUser($mainUfId);
1420       }
1421     }
1422     $otherUfId = CRM_Core_BAO_UFMatch::getUFId($otherId);
1423     $otherUser = NULL;
1424     if ($otherUfId) {
1425       // d6 compatible
1426       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1427         $otherUser = user_load($otherUfId);
1428       }
1429       elseif ($config->userFramework == 'Joomla') {
1430         $otherUser = JFactory::getUser($otherUfId);
1431       }
1432     }
1433
1434     $relTables = CRM_Dedupe_Merger::relTables();
1435     $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($otherId);
1436     $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
1437     foreach ($relTables as $name => $null) {
1438       if (!in_array($name, $activeRelTables) &&
1439         !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables))
1440       ) {
1441         unset($relTables[$name]);
1442         continue;
1443       }
1444
1445       $relTableElements[] = array('checkbox', "move_$name");
1446       $migrationInfo["move_$name"] = 1;
1447
1448       $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']);
1449       $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']);
1450       if ($name == 'rel_table_users') {
1451         $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']);
1452         $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']);
1453         $find = array('$ufid', '$ufname');
1454         if ($mainUser) {
1455           $replace = array($mainUfId, $mainUser->name);
1456           $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1457         }
1458         if ($otherUser) {
1459           $replace = array($otherUfId, $otherUser->name);
1460           $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1461         }
1462       }
1463       if ($name == 'rel_table_memberships') {
1464         $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new'));
1465         $migrationInfo["operation"]["move_{$name}"]['add'] = 1;
1466       }
1467     }
1468     foreach ($relTables as $name => $null) {
1469       $relTables["move_$name"] = $relTables[$name];
1470       unset($relTables[$name]);
1471     }
1472
1473     // handle custom fields
1474     $mainTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], NULL, $mainId, -1,
1475       CRM_Utils_Array::value('contact_sub_type', $main), NULL, TRUE, NULL, TRUE, $checkPermissions
1476     );
1477     $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $otherId, -1,
1478       CRM_Utils_Array::value('contact_sub_type', $other), NULL, TRUE, NULL, TRUE, $checkPermissions
1479     );
1480     CRM_Core_DAO::freeResult();
1481
1482     foreach ($otherTree as $gid => $group) {
1483       $foundField = FALSE;
1484       if (!isset($group['fields'])) {
1485         continue;
1486       }
1487
1488       foreach ($group['fields'] as $fid => $field) {
1489         if (in_array($fid, $compareFields['custom'])) {
1490           if (!$foundField) {
1491             $rows["custom_group_$gid"]['title'] = $group['title'];
1492             $foundField = TRUE;
1493           }
1494           if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) {
1495             foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1496               $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid);
1497             }
1498           }
1499           $value = "null";
1500           if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) {
1501             foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1502               $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid);
1503               if ($values['data'] === 0 || $values['data'] === '0') {
1504                 $values['data'] = $qfZeroBug;
1505               }
1506               $value = ($values['data']) ? $values['data'] : $value;
1507             }
1508           }
1509           $rows["move_custom_$fid"]['title'] = $field['label'];
1510
1511           $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value);
1512           $migrationInfo["move_custom_$fid"] = $value;
1513         }
1514       }
1515     }
1516
1517     $result = array(
1518       'rows' => $rows,
1519       'elements' => $elements,
1520       'rel_table_elements' => $relTableElements,
1521       'rel_tables' => $relTables,
1522       'main_details' => $main,
1523       'other_details' => $other,
1524       'migration_info' => $migrationInfo,
1525     );
1526
1527     $result['main_details']['location_blocks'] = $locations['main'];
1528     $result['other_details']['location_blocks'] = $locations['other'];
1529
1530     return $result;
1531   }
1532
1533   /**
1534    * Based on the provided two contact_ids and a set of tables, move the belongings of the
1535    * other contact to the main one - be it Location / CustomFields or Contact .. related info.
1536    * A superset of moveContactBelongings() function.
1537    *
1538    * @param int $mainId
1539    *   Main contact with whom merge has to happen.
1540    * @param int $otherId
1541    *   Duplicate contact which would be deleted after merge operation.
1542    *
1543    * @param $migrationInfo
1544    *
1545    * @param bool $checkPermissions
1546    *   Respect logged in user permissions.
1547    *
1548    * @return bool
1549    */
1550   public static function moveAllBelongings($mainId, $otherId, $migrationInfo, $checkPermissions = TRUE) {
1551     if (empty($migrationInfo)) {
1552       return FALSE;
1553     }
1554
1555     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1556     $relTables = CRM_Dedupe_Merger::relTables();
1557     $moveTables = $locBlocks = $tableOperations = array();
1558     foreach ($migrationInfo as $key => $value) {
1559       if ($value == $qfZeroBug) {
1560         $value = '0';
1561       }
1562       if ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) ||
1563           substr($key, 0, 12) == 'move_custom_') &&
1564         $value != NULL
1565       ) {
1566         $submitted[substr($key, 5)] = $value;
1567       }
1568
1569       // Set up initial information for handling migration of location blocks
1570       elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) {
1571         $locField = explode('_', $key);
1572         $fieldName = $locField[2];
1573         $fieldCount = $locField[3];
1574
1575         // Set up the operation type (add/overwrite)
1576         // Ignore operation for websites
1577         // @todo Tidy this up
1578         $operation = 0;
1579         if ($fieldName != 'website') {
1580           $operation = CRM_Utils_Array::value('operation', $migrationInfo['location_blocks'][$fieldName][$fieldCount]);
1581         }
1582         // default operation is overwrite.
1583         if (!$operation) {
1584           $operation = 2;
1585         }
1586         $locBlocks[$fieldName][$fieldCount]['operation'] = $operation;
1587
1588       }
1589
1590       elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') {
1591         $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1592         if (array_key_exists('operation', $migrationInfo)) {
1593           foreach ($relTables[substr($key, 5)]['tables'] as $table) {
1594             if (array_key_exists($key, $migrationInfo['operation'])) {
1595               $tableOperations[$table] = $migrationInfo['operation'][$key];
1596             }
1597           }
1598         }
1599       }
1600     }
1601
1602     // **** Do location related migration.
1603     // @todo Handle OpenID (not currently in API).
1604     if (!empty($locBlocks)) {
1605
1606       $locationBlocks = self::getLocationBlockInfo();
1607
1608       $primaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_primary' => 1));
1609       $billingBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_billing' => 1));
1610
1611       foreach ($locBlocks as $name => $block) {
1612         if (!is_array($block) || CRM_Utils_System::isNull($block)) {
1613           continue;
1614         }
1615         $daoName = 'CRM_Core_DAO_' . $locationBlocks[$name]['label'];
1616         $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ? array_pop($primaryBlockIds[$name]) : NULL;
1617         $billingDAOId = (array_key_exists($name, $billingBlockIds)) ? array_pop($billingBlockIds[$name]) : NULL;
1618
1619         foreach ($block as $blkCount => $values) {
1620
1621           // For the block which belongs to other-contact, link the location block to main-contact
1622           $otherBlockDAO = new $daoName();
1623           $otherBlockDAO->contact_id = $mainId;
1624
1625           // Get the ID of this block on the 'other' contact, otherwise skip
1626           $otherBlockId = CRM_Utils_Array::value('id', $migrationInfo['other_details']['location_blocks'][$name][$blkCount]);
1627           if (!$otherBlockId) {
1628             continue;
1629           }
1630           $otherBlockDAO->id = $otherBlockId;
1631
1632           // Add/update location and type information from the form, if applicable
1633           if ($locationBlocks[$name]['hasLocation']) {
1634             $locTypeId = CRM_Utils_Array::value('locTypeId', $migrationInfo['location_blocks'][$name][$blkCount]);
1635             $otherBlockDAO->location_type_id = $locTypeId;
1636           }
1637           if ($locationBlocks[$name]['hasType']) {
1638             $typeTypeId = CRM_Utils_Array::value('typeTypeId', $migrationInfo['location_blocks'][$name][$blkCount]);
1639             $otherBlockDAO->{$locationBlocks[$name]['hasType']} = $typeTypeId;
1640           }
1641
1642           // Get main block ID
1643           $mainBlockId = CRM_Utils_Array::value('mainContactBlockId', $migrationInfo['location_blocks'][$name][$blkCount], 0);
1644
1645           // if main contact already has primary & billing, set the flags to 0.
1646           if ($primaryDAOId) {
1647             $otherBlockDAO->is_primary = 0;
1648           }
1649           if ($billingDAOId) {
1650             $otherBlockDAO->is_billing = 0;
1651           }
1652
1653           $operation = CRM_Utils_Array::value('operation', $values, 2);
1654           // overwrite - need to delete block which belongs to main-contact.
1655           if (!empty($mainBlockId) && ($operation == 2)) {
1656             $deleteDAO = new $daoName();
1657             $deleteDAO->id = $mainBlockId;
1658             $deleteDAO->find(TRUE);
1659
1660             // if we about to delete a primary / billing block, set the flags for new block
1661             // that we going to assign to main-contact
1662             if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id)) {
1663               $otherBlockDAO->is_primary = 1;
1664             }
1665             if ($billingDAOId && ($billingDAOId == $deleteDAO->id)) {
1666               $otherBlockDAO->is_billing = 1;
1667             }
1668
1669             $deleteDAO->delete();
1670             $deleteDAO->free();
1671           }
1672
1673           $otherBlockDAO->update();
1674           $otherBlockDAO->free();
1675         }
1676       }
1677     }
1678
1679     // **** Do tables related migrations
1680     if (!empty($moveTables)) {
1681       CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations);
1682       unset($moveTables, $tableOperations);
1683     }
1684
1685     // **** Do contact related migrations
1686     CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId);
1687
1688     // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact()
1689     $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender');
1690     $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix');
1691     $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix');
1692     $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style');
1693     $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee');
1694     $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting');
1695     $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting');
1696     CRM_Core_OptionGroup::lookupValues($submitted, $names, TRUE);
1697
1698     // fix custom fields so they're edible by createProfileContact()
1699     static $treeCache = array();
1700     if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) {
1701       $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup::getTree($migrationInfo['main_details']['contact_type'],
1702         CRM_Core_DAO::$_nullObject, NULL, -1
1703       );
1704     }
1705     $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']];
1706
1707     $cFields = array();
1708     foreach ($cgTree as $key => $group) {
1709       if (!isset($group['fields'])) {
1710         continue;
1711       }
1712       foreach ($group['fields'] as $fid => $field) {
1713         $cFields[$fid]['attributes'] = $field;
1714       }
1715     }
1716
1717     if (!isset($submitted)) {
1718       $submitted = array();
1719     }
1720     foreach ($submitted as $key => $value) {
1721       if (substr($key, 0, 7) == 'custom_') {
1722         $fid = (int) substr($key, 7);
1723         if (empty($cFields[$fid])) {
1724           continue;
1725         }
1726         $htmlType = $cFields[$fid]['attributes']['html_type'];
1727         switch ($htmlType) {
1728           case 'File':
1729             $customFiles[] = $fid;
1730             unset($submitted["custom_$fid"]);
1731             break;
1732
1733           case 'Select Country':
1734           case 'Select State/Province':
1735             $submitted[$key] = CRM_Core_BAO_CustomField::displayValue($value, $fid);
1736             break;
1737
1738           case 'Select Date':
1739             if ($cFields[$fid]['attributes']['is_view']) {
1740               $submitted[$key] = date('YmdHis', strtotime($submitted[$key]));
1741             }
1742             break;
1743
1744           case 'CheckBox':
1745           case 'AdvMulti-Select':
1746           case 'Multi-Select':
1747           case 'Multi-Select Country':
1748           case 'Multi-Select State/Province':
1749             // Merge values from both contacts for multivalue fields, CRM-4385
1750             // get the existing custom values from db.
1751             $customParams = array('entityID' => $mainId, $key => TRUE);
1752             $customfieldValues = CRM_Core_BAO_CustomValueTable::getValues($customParams);
1753             if (!empty($customfieldValues[$key])) {
1754               $existingValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $customfieldValues[$key]);
1755               if (is_array($existingValue) && !empty($existingValue)) {
1756                 $mergeValue = $submmtedCustomValue = array();
1757                 if ($value) {
1758                   $submmtedCustomValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1759                 }
1760
1761                 //hack to remove null and duplicate values from array.
1762                 foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) {
1763                   if ($v != '' && !in_array($v, $mergeValue)) {
1764                     $mergeValue[] = $v;
1765                   }
1766                 }
1767
1768                 //keep state and country as array format.
1769                 //for checkbox and m-select format w/ VALUE_SEPARATOR
1770                 if (in_array($htmlType, array(
1771                   'CheckBox',
1772                   'Multi-Select',
1773                   'AdvMulti-Select',
1774                 ))) {
1775                   $submitted[$key] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1776                       $mergeValue
1777                     ) . CRM_Core_DAO::VALUE_SEPARATOR;
1778                 }
1779                 else {
1780                   $submitted[$key] = $mergeValue;
1781                 }
1782               }
1783             }
1784             elseif (in_array($htmlType, array(
1785               'Multi-Select Country',
1786               'Multi-Select State/Province',
1787             ))) {
1788               //we require submitted values should be in array format
1789               if ($value) {
1790                 $mergeValueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1791                 //hack to remove null values from array.
1792                 $mergeValue = array();
1793                 foreach ($mergeValueArray as $k => $v) {
1794                   if ($v != '') {
1795                     $mergeValue[] = $v;
1796                   }
1797                 }
1798                 $submitted[$key] = $mergeValue;
1799               }
1800             }
1801             break;
1802
1803           default:
1804             break;
1805         }
1806       }
1807     }
1808
1809     // **** Do file custom fields related migrations
1810     // FIXME: move this someplace else (one of the BAOs) after discussing
1811     // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually,
1812     // like, delete a file...
1813
1814     if (!isset($customFiles)) {
1815       $customFiles = array();
1816     }
1817     foreach ($customFiles as $customId) {
1818       list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($customId);
1819
1820       // get the contact_id -> file_id mapping
1821       $fileIds = array();
1822       $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})";
1823       $dao = CRM_Core_DAO::executeQuery($sql);
1824       while ($dao->fetch()) {
1825         $fileIds[$dao->entity_id] = $dao->file_id;
1826       }
1827       $dao->free();
1828
1829       // delete the main contact's file
1830       if (!empty($fileIds[$mainId])) {
1831         CRM_Core_BAO_File::deleteFileReferences($fileIds[$mainId], $mainId, $customId);
1832       }
1833
1834       // move the other contact's file to main contact
1835       //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record
1836       if (CRM_Core_DAO::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}")) {
1837         $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}";
1838       }
1839       else {
1840         $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )";
1841       }
1842       CRM_Core_DAO::executeQuery($sql);
1843
1844       if (CRM_Core_DAO::singleValueQuery("
1845         SELECT id
1846         FROM civicrm_entity_file
1847         WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}")
1848       ) {
1849         $sql = "
1850           UPDATE civicrm_entity_file
1851           SET entity_id = {$mainId}
1852           WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}";
1853       }
1854       else {
1855         $sql = "
1856           INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id )
1857           VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )";
1858       }
1859       CRM_Core_DAO::executeQuery($sql);
1860     }
1861
1862     // move view only custom fields CRM-5362
1863     $viewOnlyCustomFields = array();
1864     foreach ($submitted as $key => $value) {
1865       $fid = (int) substr($key, 7);
1866       if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) {
1867         $viewOnlyCustomFields[$key] = $value;
1868       }
1869     }
1870
1871     // special case to set values for view only, CRM-5362
1872     if (!empty($viewOnlyCustomFields)) {
1873       $viewOnlyCustomFields['entityID'] = $mainId;
1874       CRM_Core_BAO_CustomValueTable::setValues($viewOnlyCustomFields);
1875     }
1876
1877     if (!$checkPermissions || (CRM_Core_Permission::check('merge duplicate contacts') &&
1878       CRM_Core_Permission::check('delete contacts'))
1879     ) {
1880       // if ext id is submitted then set it null for contact to be deleted
1881       if (!empty($submitted['external_identifier'])) {
1882         $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}";
1883         CRM_Core_DAO::executeQuery($query);
1884       }
1885       civicrm_api3('contact', 'delete', array('id' => $otherId));
1886     }
1887
1888     // CRM-15681 merge sub_types
1889     if ($other_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['other_details'])) {
1890       if ($main_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['main_details'])) {
1891         $submitted['contact_sub_type'] = array_unique(array_merge($main_sub_types, $other_sub_types));
1892       }
1893       else {
1894         $submitted['contact_sub_type'] = $other_sub_types;
1895       }
1896     }
1897
1898     // **** Update contact related info for the main contact
1899     if (!empty($submitted)) {
1900       $submitted['contact_id'] = $mainId;
1901
1902       //update current employer field
1903       if ($currentEmloyerId = CRM_Utils_Array::value('current_employer_id', $submitted)) {
1904         if (!CRM_Utils_System::isNull($currentEmloyerId)) {
1905           $submitted['current_employer'] = $submitted['current_employer_id'];
1906         }
1907         else {
1908           $submitted['current_employer'] = '';
1909         }
1910         unset($submitted['current_employer_id']);
1911       }
1912
1913       //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name
1914       if (!isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id'])) {
1915         $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id'];
1916       }
1917       if (!isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id'])) {
1918         $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id'];
1919       }
1920
1921       CRM_Contact_BAO_Contact::createProfileContact($submitted, CRM_Core_DAO::$_nullArray, $mainId);
1922     }
1923
1924     CRM_Utils_Hook::post('merge', 'Contact', $mainId, CRM_Core_DAO::$_nullObject);
1925     self::createMergeActivities($mainId, $otherId);
1926
1927     return TRUE;
1928   }
1929
1930   /**
1931    * Get fields in the contact table suitable for merging.
1932    *
1933    * @return array
1934    *   Array of field names to be potentially merged.
1935    */
1936   public static function getContactFields() {
1937     $contactFields = CRM_Contact_DAO_Contact::fields();
1938     $invalidFields = array(
1939       'api_key',
1940       'created_date',
1941       'display_name',
1942       'hash',
1943       'id',
1944       'modified_date',
1945       'primary_contact_id',
1946       'sort_name',
1947       'user_unique_id',
1948     );
1949     foreach ($contactFields as $field => $value) {
1950       if (in_array($field, $invalidFields)) {
1951         unset($contactFields[$field]);
1952       }
1953     }
1954     return array_keys($contactFields);
1955   }
1956
1957   /**
1958    * Added for CRM-12695
1959    * Based on the contactID provided
1960    * add/update membership(s) to related contacts
1961    *
1962    * @param int $contactID
1963    */
1964   public static function addMembershipToRealtedContacts($contactID) {
1965     $dao = new CRM_Member_DAO_Membership();
1966     $dao->contact_id = $contactID;
1967     $dao->is_test = 0;
1968     $dao->find();
1969
1970     //checks membership of contact itself
1971     while ($dao->fetch()) {
1972       $relationshipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id, 'relationship_type_id', 'id');
1973       if ($relationshipTypeId) {
1974         $membershipParams = array(
1975           'id' => $dao->id,
1976           'contact_id' => $dao->contact_id,
1977           'membership_type_id' => $dao->membership_type_id,
1978           'join_date' => CRM_Utils_Date::isoToMysql($dao->join_date),
1979           'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date),
1980           'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date),
1981           'source' => $dao->source,
1982           'status_id' => $dao->status_id,
1983         );
1984         // create/update membership(s) for related contact(s)
1985         CRM_Member_BAO_Membership::createRelatedMemberships($membershipParams, $dao);
1986       } // end of if relationshipTypeId
1987     }
1988   }
1989
1990   /**
1991    * Add custom tables that extend contacts to the list of contact references.
1992    *
1993    * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
1994    * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
1995    * - the down side is it is not cached.
1996    *
1997    * Further changes should be include tests in the CRM_Core_MergerTest class
1998    * to ensure that disabled, subtype, multiple etc groups are still captured.
1999    *
2000    * @param array $cidRefs
2001    */
2002   public static function addCustomTablesExtendingContactsToCidRefs(&$cidRefs) {
2003     $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact');
2004     $customValueTables->find();
2005     while ($customValueTables->fetch()) {
2006       $cidRefs[$customValueTables->table_name] = array('entity_id');
2007     }
2008   }
2009
2010   /**
2011    * Create activities tracking the merge on affected contacts.
2012    *
2013    * @param int $mainId
2014    * @param int $otherId
2015    *
2016    * @throws \CiviCRM_API3_Exception
2017    */
2018   public static function createMergeActivities($mainId, $otherId) {
2019     $params = array(
2020       1 => $otherId,
2021       2 => $mainId,
2022     );
2023     $activity = civicrm_api3('activity', 'create', array(
2024       'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() :
2025         $mainId,
2026       'subject' => ts('Contact ID %1 has been merged and deleted.', $params),
2027       'target_contact_id' => $mainId,
2028       'activity_type_id' => 'Contact Merged',
2029       'status_id' => 'Completed',
2030     ));
2031     if (civicrm_api3('Setting', 'getvalue', array('name' => 'contact_undelete', 'group' => 'CiviCRM Preferences'))) {
2032       civicrm_api3('activity', 'create', array(
2033         'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() :
2034           $otherId,
2035         'subject' => ts('Contact ID %1 has been merged into Contact ID %2 and deleted.', $params),
2036         'target_contact_id' => $otherId,
2037         'activity_type_id' => 'Contact Deleted by Merge',
2038         'parent_id' => $activity['id'],
2039         'status_id' => 'Completed',
2040       ));
2041     }
2042   }
2043
2044   /**
2045    * Get Duplicate Pairs based on a rule for a group.
2046    *
2047    * @param int $rule_group_id
2048    * @param int $group_id
2049    * @param bool $reloadCacheIfEmpty
2050    * @param int $batchLimit
2051    * @param bool $isSelected
2052    * @param array|string $orderByClause
2053    * @param bool $includeConflicts
2054    * @param array $criteria
2055    *   Additional criteria to narrow down the merge group.
2056    *
2057    * @param bool $checkPermissions
2058    *   Respect logged in user permissions.
2059    *
2060    * @return array
2061    *    Array of matches meeting the criteria.
2062    */
2063   public static function getDuplicatePairs($rule_group_id, $group_id, $reloadCacheIfEmpty, $batchLimit, $isSelected, $orderByClause = '', $includeConflicts = TRUE, $criteria = array(), $checkPermissions = TRUE) {
2064     $where = self::getWhereString($batchLimit, $isSelected);
2065     $cacheKeyString = self::getMergeCacheKeyString($rule_group_id, $group_id, $criteria, $checkPermissions);
2066     $join = self::getJoinOnDedupeTable();
2067     $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where, 0, 0, array(), $orderByClause, $includeConflicts);
2068     if (empty($dupePairs) && $reloadCacheIfEmpty) {
2069       // If we haven't found any dupes, probably cache is empty.
2070       // Try filling cache and give another try. We don't need to specify include conflicts here are there will not be any
2071       // until we have done some processing.
2072       CRM_Core_BAO_PrevNextCache::refillCache($rule_group_id, $group_id, $cacheKeyString, $criteria, $checkPermissions);
2073       $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where, 0, 0, array(), $orderByClause, $includeConflicts);
2074       return $dupePairs;
2075     }
2076     return $dupePairs;
2077   }
2078
2079   /**
2080    * Get the cache key string for the merge action.
2081    *
2082    * @param int $rule_group_id
2083    * @param int $group_id
2084    * @param array $criteria
2085    *   Additional criteria to narrow down the merge group.
2086    *   Currently we are only supporting the key 'contact' within it.
2087    *
2088    * @param bool $checkPermissions
2089    *   Respect the users permissions.
2090    *
2091    * @return string
2092    */
2093   public static function getMergeCacheKeyString($rule_group_id, $group_id, $criteria = array(), $checkPermissions = TRUE) {
2094     $contactType = CRM_Dedupe_BAO_RuleGroup::getContactTypeForRuleGroup($rule_group_id);
2095     $cacheKeyString = "merge {$contactType}";
2096     $cacheKeyString .= $rule_group_id ? "_{$rule_group_id}" : '_0';
2097     $cacheKeyString .= $group_id ? "_{$group_id}" : '_0';
2098     $cacheKeyString .= !empty($criteria) ? serialize($criteria) : '_0';
2099     if ($checkPermissions) {
2100       $contactID = CRM_Core_Session::getLoggedInContactID();
2101       if (!$contactID) {
2102         // Distinguish between no permission check & no logged in user.
2103         $contactID = 'null';
2104       }
2105       $cacheKeyString .= '_' . $contactID;
2106     }
2107     else {
2108       $cacheKeyString .= '_0';
2109     }
2110     return $cacheKeyString;
2111   }
2112
2113 }