CRM/Dedupe/Merger.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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/mailing', 'reset=1&force=1&cid=$cid'),
 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     $membershipMerge = FALSE; // CRM-12695
 443
 444     $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs));
 445     if ($tables !== FALSE) {
 446       // if there are specific tables, sanitize the list
 447       $affected = array_unique(array_intersect($affected, $tables));
 448     }
 449     else {
 450       // if there aren't any specific tables, don't affect the ones handled by relTables()
 451       // also don't affect tables in locTables() CRM-15658
 452       $relTables = self::relTables();
 453       $handled = self::locTables();
 454       foreach ($relTables as $params) {
 455         $handled = array_merge($handled, $params['tables']);
 456       }
 457       $affected = array_diff($affected, $handled);
 458       /**
 459        * CRM-12695
 460        * Set $membershipMerge flag only once
 461        * while doing contact related migration
 462        * to call addMembershipToRealtedContacts()
 463        * function only once.
 464        * Since the current function (moveContactBelongings) is called twice
 465        * with & without parameters $tables & $tableOperations
 466        */
 467       // retrieve main contact's related table(s)
 468       $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
 469       // check if membership table exists in main contact's related table(s)
 470       if (in_array('rel_table_memberships', $activeMainRelTables)) {
 471         $membershipMerge = TRUE; // set membership flag - CRM-12695
 472       }
 473     }
 474
 475     $mainId = (int) $mainId;
 476     $otherId = (int) $otherId;
 477
 478     $sqls = array();
 479     foreach ($affected as $table) {
 480       // Call custom processing function for objects that require it
 481       if (isset($cpTables[$table])) {
 482         foreach ($cpTables[$table] as $className => $fnName) {
 483           $className::$fnName($mainId, $otherId, $sqls);
 484         }
 485         // Skip normal processing
 486         continue;
 487       }
 488
 489       // use UPDATE IGNORE + DELETE query pair to skip on situations when
 490       // there's a UNIQUE restriction on ($field, some_other_field) pair
 491       if (isset($cidRefs[$table])) {
 492         foreach ($cidRefs[$table] as $field) {
 493           // carry related contributions CRM-5359
 494           if (in_array($table, $paymentTables)) {
 495             $paymentSqls = self::paymentSql($table, $mainId, $otherId);
 496             $sqls = array_merge($sqls, $paymentSqls);
 497
 498             if (!empty($tables) && !in_array('civicrm_contribution', $tables)) {
 499               $payOprSqls = self::operationSql($mainId, $otherId, $table, $tableOperations, 'payment');
 500               $sqls = array_merge($sqls, $payOprSqls);
 501             }
 502           }
 503
 504           $preOperationSqls = self::operationSql($mainId, $otherId, $table, $tableOperations);
 505           $sqls = array_merge($sqls, $preOperationSqls);
 506
 507           $sqls[] = "UPDATE IGNORE $table SET $field = $mainId WHERE $field = $otherId";
 508           $sqls[] = "DELETE FROM $table WHERE $field = $otherId";
 509         }
 510       }
 511       if (isset($eidRefs[$table])) {
 512         foreach ($eidRefs[$table] as $entityTable => $entityId) {
 513           $sqls[] = "UPDATE IGNORE $table SET $entityId = $mainId WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 514           $sqls[] = "DELETE FROM $table WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 515         }
 516       }
 517     }
 518
 519     // Allow hook_civicrm_merge() to add SQL statements for the merge operation.
 520     CRM_Utils_Hook::merge('sqls', $sqls, $mainId, $otherId, $tables);
 521
 522     // call the SQL queries in one transaction
 523     $transaction = new CRM_Core_Transaction();
 524     foreach ($sqls as $sql) {
 525       CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE);
 526     }
 527     // CRM-12695
 528     if ($membershipMerge) {
 529       // call to function adding membership to related contacts
 530       CRM_Dedupe_Merger::addMembershipToRealtedContacts($mainId);
 531     }
 532     $transaction->commit();
 533   }
 534
 535   /**
 536    * Load all non-empty fields for the contacts
 537    *
 538    * @param array $main
 539    *   Contact details.
 540    * @param array $other
 541    *   Contact details.
 542    *
 543    * @return array
 544    */
 545   public static function retrieveFields($main, $other) {
 546     $result = array(
 547       'contact' => array(),
 548       'custom' => array(),
 549     );
 550     foreach (self::getContactFields() as $validField) {
 551       // CRM-17556 Get all non-empty fields, to make comparison easier
 552       if (!empty($main[$validField]) || !empty($other[$validField])) {
 553         $result['contact'][] = $validField;
 554       }
 555     }
 556
 557     $mainEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($main['id']);
 558     $otherEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($other['id']);
 559     $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs)));
 560     foreach ($keys as $key) {
 561       // Exclude multi-value fields CRM-13836
 562       if (strpos($key, '_')) {
 563         continue;
 564       }
 565       $key1 = CRM_Utils_Array::value($key, $mainEvs);
 566       $key2 = CRM_Utils_Array::value($key, $otherEvs);
 567       // CRM-17556 Get all non-empty fields, to make comparison easier
 568       if (!empty($key1) || !empty($key2)) {
 569         $result['custom'][] = $key;
 570       }
 571     }
 572     return $result;
 573   }
 574
 575   /**
 576    * Batch merge a set of contacts based on rule-group and group.
 577    *
 578    * @param int $rgid
 579    *   Rule group id.
 580    * @param int $gid
 581    *   Group id.
 582    * @param string $mode
 583    *   Helps decide how to behave when there are conflicts.
 584    *                              A 'safe' value skips the merge if there are any un-resolved conflicts.
 585    *                              Does a force merge otherwise.
 586    * @param bool $autoFlip to let api decide which contact to retain and which to delete.
 587    *   Wether to let api decide which contact to retain and which to delete.
 588    * @param int $batchLimit number of merges to carry out in one batch.
 589    * @param int $isSelected if records with is_selected column needs to be processed.
 590    *
 591    * @return array|bool
 592    */
 593   public static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $batchLimit = 1, $isSelected = 2) {
 594     $contactType = CRM_Core_DAO::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
 595     $cacheKeyString = "merge {$contactType}";
 596     $cacheKeyString .= $rgid ? "_{$rgid}" : '_0';
 597     $cacheKeyString .= $gid ? "_{$gid}" : '_0';
 598     $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
 599                                                              pn.entity_id2 = de.contact_id2 )";
 600
 601     $where = "de.id IS NULL";
 602     if ($isSelected === 0 || $isSelected === 1) {
 603       $where .= " AND pn.is_selected = {$isSelected}";
 604     }// else consider all dupe pairs
 605     $where .= " LIMIT {$batchLimit}";
 606
 607     $redirectForPerformance = ($batchLimit > 1) ? TRUE : FALSE;
 608
 609     $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where);
 610     if (empty($dupePairs) && !$redirectForPerformance && $isSelected == 2) {
 611       // If we haven't found any dupes, probably cache is empty.
 612       // Try filling cache and give another try.
 613       CRM_Core_BAO_PrevNextCache::refillCache($rgid, $gid, $cacheKeyString);
 614       $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where);
 615     }
 616
 617     $cacheParams = array(
 618       'cache_key_string' => $cacheKeyString,
 619       'join' => $join,
 620       'where' => $where,
 621     );
 622     return CRM_Dedupe_Merger::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance);
 623   }
 624
 625   public static function updateMergeStats($cacheKeyString, $result = array()) {
 626     // gather latest stats
 627     $merged  = count($result['merged']);
 628     $skipped = count($result['skipped']);
 629
 630     if ($merged <= 0 && $skipped <= 0) {
 631       return;
 632     }
 633
 634     // get previous stats
 635     $previousStats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats");
 636     if (!empty($previousStats)) {
 637       if ($previousStats[0]['merged']) {
 638         $merged = $merged + $previousStats[0]['merged'];
 639       }
 640       if ($previousStats[0]['skipped']) {
 641         $skipped = $skipped + $previousStats[0]['skipped'];
 642       }
 643     }
 644
 645     // delete old stats
 646     CRM_Dedupe_Merger::resetMergeStats($cacheKeyString);
 647
 648     // store the updated stats
 649     $data = array(
 650       'merged'  => $merged,
 651       'skipped' => $skipped,
 652     );
 653     $data = CRM_Core_DAO::escapeString(serialize($data));
 654
 655     $values   = array();
 656     $values[] = " ( 'civicrm_contact', 0, 0, '{$cacheKeyString}_stats', '$data' ) ";
 657     CRM_Core_BAO_PrevNextCache::setItem($values);
 658   }
 659
 660   public static function resetMergeStats($cacheKeyString) {
 661     return CRM_Core_BAO_PrevNextCache::deleteItem(NULL, "{$cacheKeyString}_stats");
 662   }
 663
 664   public static function getMergeStats($cacheKeyString) {
 665     $stats = CRM_Core_BAO_PrevNextCache::retrieve("{$cacheKeyString}_stats");
 666     if (!empty($stats)) {
 667       $stats = $stats[0];
 668     }
 669     return $stats;
 670   }
 671
 672   public static function getMergeStatsMsg($cacheKeyString) {
 673     $msg   = '';
 674     $stats = CRM_Dedupe_Merger::getMergeStats($cacheKeyString);
 675     if (!empty($stats['merged'])) {
 676       $msg = "{$stats['merged']} " . ts(' Contact(s) were merged. ');
 677     }
 678     if (!empty($stats['skipped'])) {
 679       $msg .= $stats['skipped'] . ts(' Contact(s) were skipped.');
 680     }
 681     return $msg;
 682   }
 683
 684   /**
 685    * Merge given set of contacts. Performs core operation.
 686    *
 687    * @param array $dupePairs
 688    *   Set of pair of contacts for whom merge is to be done.
 689    * @param array $cacheParams
 690    *   Prev-next-cache params based on which next pair of contacts are computed.
 691    *                              Generally used with batch-merge.
 692    * @param string $mode
 693    *   Helps decide how to behave when there are conflicts.
 694    *                             A 'safe' value skips the merge if there are any un-resolved conflicts.
 695    *                             Does a force merge otherwise (aggressive mode).
 696    * @param bool $autoFlip to let api decide which contact to retain and which to delete.
 697    *   Wether to let api decide which contact to retain and which to delete.
 698    *
 699    *
 700    * @param bool $redirectForPerformance
 701    *
 702    * @return array|bool
 703    */
 704   public static function merge($dupePairs = array(), $cacheParams = array(), $mode = 'safe',
 705                                $autoFlip = TRUE, $redirectForPerformance = FALSE
 706   ) {
 707     $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams);
 708     $resultStats = array('merged' => array(), 'skipped' => array());
 709
 710     // we don't want dupe caching to get reset after every-merge, and therefore set the
 711     // doNotResetCache flag
 712     $config = CRM_Core_Config::singleton();
 713     $config->doNotResetCache = 1;
 714
 715     while (!empty($dupePairs)) {
 716       foreach ($dupePairs as $dupes) {
 717         CRM_Utils_Hook::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']);
 718         $mainId = $dupes['dstID'];
 719         $otherId = $dupes['srcID'];
 720         $isAutoFlip = CRM_Utils_Array::value('auto_flip', $dupes, $autoFlip);
 721         // if we can, make sure that $mainId is the one with lower id number
 722         if ($isAutoFlip && ($mainId > $otherId)) {
 723           $mainId = $dupes['srcID'];
 724           $otherId = $dupes['dstID'];
 725         }
 726         if (!$mainId || !$otherId) {
 727           // return error
 728           return FALSE;
 729         }
 730
 731         // Generate var $migrationInfo. The variable structure is exactly same as
 732         // $formValues submitted during a UI merge for a pair of contacts.
 733         $rowsElementsAndInfo = CRM_Dedupe_Merger::getRowsElementsAndInfo($mainId, $otherId);
 734
 735         $migrationInfo = &$rowsElementsAndInfo['migration_info'];
 736
 737         // add additional details that we might need to resolve conflicts
 738         $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details'];
 739         $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details'];
 740         $migrationInfo['main_loc_block'] = &$rowsElementsAndInfo['main_loc_block'];
 741         $migrationInfo['rows'] = &$rowsElementsAndInfo['rows'];
 742
 743         // go ahead with merge if there is no conflict
 744         $conflicts = array();
 745         if (!CRM_Dedupe_Merger::skipMerge($mainId, $otherId, $migrationInfo, $mode, $conflicts)) {
 746           CRM_Dedupe_Merger::moveAllBelongings($mainId, $otherId, $migrationInfo);
 747           $resultStats['merged'][] = array('main_id' => $mainId, 'other_id' => $otherId);
 748         }
 749         else {
 750           $resultStats['skipped'][] = array('main_id' => $mainId, 'other_id' => $otherId);
 751         }
 752
 753         // store any conflicts
 754         if (!empty($conflicts)) {
 755           foreach ($conflicts as $key => $dnc) {
 756             $conflicts[$key] = "{$migrationInfo['rows'][$key]['title']}: '{$migrationInfo['rows'][$key]['main']}' vs. '{$migrationInfo['rows'][$key]['other']}'";
 757           }
 758           CRM_Core_BAO_PrevNextCache::markConflict($mainId, $otherId, $cacheKeyString, $conflicts);
 759         }
 760         else {
 761           // delete entry from PrevNextCache table so we don't consider the pair next time
 762           // pair may have been flipped, so make sure we delete using both orders
 763           CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString, TRUE);
 764         }
 765
 766         CRM_Core_DAO::freeResult();
 767         unset($rowsElementsAndInfo, $migrationInfo);
 768       }
 769
 770       if ($cacheKeyString && !$redirectForPerformance) {
 771         // retrieve next pair of dupes
 772         $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString,
 773           $cacheParams['join'],
 774           $cacheParams['where']
 775         );
 776       }
 777       else {
 778         // do not proceed. Terminate the loop
 779         unset($dupePairs);
 780       }
 781     }
 782
 783     CRM_Dedupe_Merger::updateMergeStats($cacheKeyString, $resultStats);
 784     return $resultStats;
 785   }
 786
 787   /**
 788    * A function which uses various rules / algorithms for choosing which contact to bias to
 789    * when there's a conflict (to handle "gotchas"). Plus the safest route to merge.
 790    *
 791    * @param int $mainId
 792    *   Main contact with whom merge has to happen.
 793    * @param int $otherId
 794    *   Duplicate contact which would be deleted after merge operation.
 795    * @param array $migrationInfo
 796    *   Array of information about which elements to merge.
 797    * @param string $mode
 798    *   Helps decide how to behave when there are conflicts.
 799    *   -  A 'safe' value skips the merge if there are any un-resolved conflicts.
 800    *   -  Does a force merge otherwise (aggressive mode).
 801    *
 802    * @param array $conflicts
 803    *
 804    * @return bool
 805    */
 806   public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe', &$conflicts = array()) {
 807
 808     $migrationData = array(
 809       'old_migration_info' => $migrationInfo,
 810       'mode' => $mode,
 811     );
 812
 813     $allLocationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 814
 815     foreach ($migrationInfo as $key => $val) {
 816       if ($val === "null") {
 817         // Rule: Never overwrite with an empty value (in any mode)
 818         unset($migrationInfo[$key]);
 819         continue;
 820       }
 821       elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) or
 822           substr($key, 0, 12) == 'move_custom_'
 823         ) and $val != NULL
 824       ) {
 825         // Rule: If both main-contact, and other-contact have a field with a
 826         // different value, then let $mode decide if to merge it or not
 827         if (
 828           !empty($migrationInfo['rows'][$key]['main'])
 829           && $migrationInfo['rows'][$key]['main'] != $migrationInfo['rows'][$key]['other']
 830         ) {
 831
 832           // note it down & lets wait for response from the hook.
 833           // For no response $mode will decide if to skip this merge
 834           $conflicts[$key] = NULL;
 835         }
 836       }
 837       elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) {
 838         $locField = explode('_', $key);
 839         $fieldName = $locField[2];
 840         $fieldCount = $locField[3];
 841
 842         // Rule: resolve address conflict if any
 843         if ($fieldName == 'address') {
 844           $mainNewLocTypeId = $migrationInfo['location_blocks'][$fieldName][$fieldCount]['locTypeId'];
 845           if (!empty($migrationInfo['main_loc_block']) &&
 846               array_key_exists("main_address_{$mainNewLocTypeId}", $migrationInfo['main_loc_block'])) {
 847             // main loc already has some address for the loc-type. Its a overwrite situation.
 848             // look for next available loc-type
 849             $newTypeId = NULL;
 850             foreach ($allLocationTypes as $typeId => $typeLabel) {
 851               if (!array_key_exists("main_address_{$typeId}", $migrationInfo['main_loc_block'])) {
 852                 $newTypeId = $typeId;
 853               }
 854             }
 855             if ($newTypeId) {
 856               // try insert address at new available loc-type
 857               $migrationInfo['location_blocks'][$fieldName][$fieldCount]['locTypeId'] = $newTypeId;
 858             }
 859             else {
 860               // note it down & lets wait for response from the hook.
 861               // For no response $mode will decide if to skip this merge
 862               $conflicts[$key] = NULL;
 863             }
 864           }
 865         }
 866         elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) {
 867           // for loc blocks other than address like email, phone .. if values are same no point in merging
 868           // and adding redundant value
 869           unset($migrationInfo[$key]);
 870         }
 871       }
 872     }
 873
 874     // A hook to implement other algorithms for choosing which contact to bias to when
 875     // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here
 876     // merge happens with new values filled in here. For a particular field / row not to be merged
 877     // field should be unset from fields_in_conflict.
 878     $migrationData['fields_in_conflict'] = $conflicts;
 879     $migrationData['merge_mode']         = $mode;
 880     CRM_Utils_Hook::merge('batch', $migrationData, $mainId, $otherId);
 881     $conflicts = $migrationData['fields_in_conflict'];
 882     // allow hook to override / manipulate migrationInfo as well
 883     $migrationInfo = $migrationData['old_migration_info'];
 884
 885     if (!empty($conflicts)) {
 886       foreach ($conflicts as $key => $val) {
 887         if ($val === NULL and $mode == 'safe') {
 888           // un-resolved conflicts still present. Lets skip this merge after saving the conflict / reason.
 889           return TRUE;
 890         }
 891         else {
 892           // copy over the resolved values
 893           $migrationInfo[$key] = $val;
 894         }
 895       }
 896       // if there are conflicts and mode is aggressive, allow hooks to decide if to skip merges
 897       if (array_key_exists('skip_merge', $migrationData)) {
 898         return (bool) $migrationData['skip_merge'];
 899       }
 900     }
 901     return FALSE;
 902   }
 903
 904   /**
 905    * A function to build an array of information about location blocks that is
 906    * required when merging location fields
 907    *
 908    * @return array
 909    */
 910   public static function getLocationBlockInfo() {
 911     $locationBlocks = array(
 912       'address' => array(
 913         'label' => 'Address',
 914         'displayField' => 'display',
 915         'sortString' => 'location_type_id',
 916         'hasLocation' => TRUE,
 917         'hasType' => FALSE,
 918       ),
 919       'email' => array(
 920         'label' => 'Email',
 921         'displayField' => 'email',
 922         'sortString' => 'location_type_id',
 923         'hasLocation' => TRUE,
 924         'hasType' => FALSE,
 925       ),
 926       'im' => array(
 927         'label' => 'IM',
 928         'displayField' => 'name',
 929         'sortString' => 'location_type_id,provider_id',
 930         'hasLocation' => TRUE,
 931         'hasType' => 'provider_id',
 932       ),
 933       'phone' => array(
 934         'label' => 'Phone',
 935         'displayField' => 'phone',
 936         'sortString' => 'location_type_id,phone_type_id',
 937         'hasLocation' => TRUE,
 938         'hasType' => 'phone_type_id',
 939       ),
 940       'website' => array(
 941         'label' => 'Website',
 942         'displayField' => 'url',
 943         'sortString' => 'website_type_id',
 944         'hasLocation' => FALSE,
 945         'hasType' => 'website_type_id',
 946       ),
 947     );
 948     return $locationBlocks;
 949   }
 950
 951   /**
 952    * A function to build an array of information required by merge function and the merge UI.
 953    *
 954    * @param int $mainId
 955    *   Main contact with whom merge has to happen.
 956    * @param int $otherId
 957    *   Duplicate contact which would be deleted after merge operation.
 958    *
 959    * @return array|bool|int
 960    *   'main_loc_block' => Stores all location blocks associated with the 'main' contact
 961    */
 962   public static function getRowsElementsAndInfo($mainId, $otherId) {
 963     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
 964
 965     // Fetch contacts
 966     foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
 967       $params = array(
 968         'contact_id' => $cid,
 969         'version' => 3,
 970         'return' => array_merge(array('display_name'), self::getContactFields()),
 971       );
 972       $result = civicrm_api('contact', 'get', $params);
 973
 974       if (empty($result['values'][$cid]['contact_type'])) {
 975         return FALSE;
 976       }
 977       $$moniker = $result['values'][$cid];
 978     }
 979
 980     static $fields = array();
 981     if (empty($fields)) {
 982       $fields = CRM_Contact_DAO_Contact::fields();
 983       CRM_Core_DAO::freeResult();
 984     }
 985
 986     // FIXME: there must be a better way
 987     foreach (array('main', 'other') as $moniker) {
 988       $contact = &$$moniker;
 989       $preferred_communication_method = CRM_Utils_array::value('preferred_communication_method', $contact);
 990       $value = empty($preferred_communication_method) ? array() : $preferred_communication_method;
 991       $specialValues[$moniker] = array(
 992         'preferred_communication_method' => $value,
 993         'communication_style_id' => $value,
 994       );
 995
 996       if (!empty($contact['preferred_communication_method'])) {
 997         // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct
 998         $prefCommList = is_array($specialValues[$moniker]['preferred_communication_method']) ? implode(CRM_Core_DAO::VALUE_SEPARATOR, $specialValues[$moniker]['preferred_communication_method']) : $specialValues[$moniker]['preferred_communication_method'];
 999         $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO::VALUE_SEPARATOR . $prefCommList . CRM_Core_DAO::VALUE_SEPARATOR;
1000       }
1001       $names = array(
1002         'preferred_communication_method' => array(
1003           'newName' => 'preferred_communication_method_display',
1004           'groupName' => 'preferred_communication_method',
1005         ),
1006       );
1007       CRM_Core_OptionGroup::lookupValues($specialValues[$moniker], $names);
1008
1009       if (!empty($contact['communication_style'])) {
1010         $specialValues[$moniker]['communication_style_id_display'] = $contact['communication_style'];
1011       }
1012     }
1013
1014     static $optionValueFields = array();
1015     if (empty($optionValueFields)) {
1016       $optionValueFields = CRM_Core_OptionValue::getFields();
1017     }
1018     foreach ($optionValueFields as $field => $params) {
1019       $fields[$field]['title'] = $params['title'];
1020     }
1021
1022     $compareFields = self::retrieveFields($main, $other);
1023
1024     $rows = $elements = $relTableElements = $migrationInfo = array();
1025
1026     foreach ($compareFields['contact'] as $field) {
1027       if ($field == 'contact_sub_type') {
1028         // CRM-15681 don't display sub-types in UI
1029         continue;
1030       }
1031       foreach (array('main', 'other') as $moniker) {
1032         $contact = &$$moniker;
1033         $value = CRM_Utils_Array::value($field, $contact);
1034         if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) {
1035           $value = CRM_Core_DAO::VALUE_SEPARATOR . trim($specialValues[$moniker][$field], CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR;
1036         }
1037         $label = isset($specialValues[$moniker]["{$field}_display"]) ? $specialValues[$moniker]["{$field}_display"] : $value;
1038         if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_DATE) {
1039           if ($value) {
1040             $value = str_replace('-', '', $value);
1041             $label = CRM_Utils_Date::customFormat($label);
1042           }
1043           else {
1044             $value = "null";
1045           }
1046         }
1047         elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_BOOLEAN) {
1048           if ($label === '0') {
1049             $label = ts('[ ]');
1050           }
1051           if ($label === '1') {
1052             $label = ts('[x]');
1053           }
1054         }
1055         elseif ($field == 'individual_prefix' || $field == 'prefix_id') {
1056           $label = CRM_Utils_Array::value('individual_prefix', $contact);
1057           $value = CRM_Utils_Array::value('prefix_id', $contact);
1058           $field = 'prefix_id';
1059         }
1060         elseif ($field == 'individual_suffix' || $field == 'suffix_id') {
1061           $label = CRM_Utils_Array::value('individual_suffix', $contact);
1062           $value = CRM_Utils_Array::value('suffix_id', $contact);
1063           $field = 'suffix_id';
1064         }
1065         elseif ($field == 'gender_id' && !empty($value)) {
1066           $genderOptions = civicrm_api3('contact', 'getoptions', array('field' => 'gender_id'));
1067           $label = $genderOptions['values'][$value];
1068         }
1069         elseif ($field == 'current_employer_id' && !empty($value)) {
1070           $label = "$value (" . CRM_Contact_BAO_Contact::displayName($value) . ")";
1071         }
1072         $rows["move_$field"][$moniker] = $label;
1073         if ($moniker == 'other') {
1074           //CRM-14334
1075           if ($value === NULL || $value == '') {
1076             $value = 'null';
1077           }
1078           if ($value === 0 or $value === '0') {
1079             $value = $qfZeroBug;
1080           }
1081           if (is_array($value) && empty($value[1])) {
1082             $value[1] = NULL;
1083           }
1084
1085           // Display a checkbox to migrate, only if the values are different
1086           if ($value != $main[$field]) {
1087             $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value);
1088           }
1089
1090           $migrationInfo["move_$field"] = $value;
1091         }
1092       }
1093       $rows["move_$field"]['title'] = $fields[$field]['title'];
1094     }
1095
1096     // Handle location blocks.
1097     // @todo OpenID not in API yet, so is not supported here.
1098
1099     // Set up useful information about the location blocks
1100     $locationBlocks = self::getLocationBlockInfo();
1101
1102     $locations = array(
1103       'main' => array(),
1104       'other' => array(),
1105     );
1106
1107     $mainLocBlock = array();
1108
1109     // @todo This could probably be defined and used earlier
1110     $mergeTargets = array(
1111       'main' => $mainId,
1112       'other' => $otherId,
1113     );
1114
1115     foreach ($locationBlocks as $blockName => $blockInfo) {
1116
1117       // Collect existing fields from both 'main' and 'other' contacts first
1118       // This allows us to match up location/types when building the table rows
1119       foreach ($mergeTargets as $moniker => $cid) {
1120         $cnt = 1;
1121         $searchParams = array(
1122           'version' => 3,
1123           'contact_id' => $cid,
1124           // CRM-17556 Order by field-specific criteria
1125           'options' => array(
1126             'sort' => $blockInfo['sortString'],
1127           ),
1128         );
1129         $values = civicrm_api($blockName, 'get', $searchParams);
1130         if ($values['count']) {
1131           $cnt = 0;
1132           foreach ($values['values'] as $index => $value) {
1133             $locations[$moniker][$blockName][$cnt] = $value;
1134             // Fix address display
1135             $display = '';
1136             if ($blockName == 'address') {
1137               CRM_Core_BAO_Address::fixAddress($value);
1138               $display = CRM_Utils_Address::format($value);
1139               $locations[$moniker][$blockName][$cnt]['display'] = $display;
1140             }
1141
1142             // Add any 'main' contact block values to an array for the JS
1143             // @todo The JS should just access the main_details to find this info?
1144             if ($moniker == 'main') {
1145               if ($blockInfo['hasType']) {
1146                 // Handle websites, no location type ID
1147                 // @todo Remove the need for this specific 'if'
1148                 if ($blockName == 'website') {
1149                   $value['location_type_id'] = 0;
1150                 }
1151                 $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id'] . "_" . $value[$blockInfo['hasType']]]['display'] = $value[$blockInfo['displayField']];
1152                 $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id'] . "_" . $value[$blockInfo['hasType']]]['id'] = $value['id'];
1153               }
1154               else {
1155                 // Get the correct display value for addresses
1156                 // @todo Remove the need for this if...
1157                 if ($blockName == 'address') {
1158                   $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['display'] = $display;
1159                   $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['id'] = $value['id'];
1160                 }
1161                 else {
1162                   $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['display'] = $value[$blockInfo['displayField']];
1163                   $mainLocBlock["main_" . $blockName . "_" . $value['location_type_id']]['id'] = $value['id'];
1164                 }
1165               }
1166             }
1167
1168             $cnt++;
1169           }
1170         }
1171       }
1172
1173       // Now, build the table rows appropriately, based off the information on
1174       // the 'other' contact
1175       if (!empty($locations['other']) && !empty($locations['other'][$blockName])) {
1176         foreach ($locations['other'][$blockName] as $count => $value) {
1177
1178           $displayValue = $value[$blockInfo['displayField']];
1179
1180           // Add this value to the table rows
1181           $rows["move_location_{$blockName}_{$count}"]['other'] = $displayValue;
1182
1183           // CRM-17556 Only display 'main' contact value if it's the same location + type
1184           // Look it up from main values...
1185
1186           $lookupLocation = FALSE;
1187           if ($blockInfo['hasLocation']) {
1188             $lookupLocation = $value['location_type_id'];
1189           }
1190
1191           $lookupType = FALSE;
1192           if ($blockInfo['hasType']) {
1193             $lookupType = $value[$blockInfo['hasType']];
1194           }
1195
1196           // Hold ID of main contact's matching block
1197           $mainContactBlockId = 0;
1198
1199           if (!empty($locations['main'][$blockName])) {
1200             foreach ($locations['main'][$blockName] as $mainValueCheck) {
1201               // No location/type, or matching location and type
1202               if (
1203                 (empty($lookupLocation) || $lookupLocation == $mainValueCheck['location_type_id'])
1204                 && (empty($lookupType) || $lookupType == $mainValueCheck[$blockInfo['hasType']])
1205               ) {
1206                 // Set this value as the default against the 'other' contact value
1207                 $rows["move_location_{$blockName}_{$count}"]['main'] = $mainValueCheck[$blockInfo['displayField']];
1208                 $mainContactBlockId = $mainValueCheck['id'];
1209                 break;
1210               }
1211             }
1212           }
1213
1214           // Add checkbox to migrate data from 'other' to 'main'
1215           $elements[] = array('advcheckbox', "move_location_{$blockName}_{$count}");
1216
1217           // Flag up this field to skipMerge function (@todo: do we need to?)
1218           $migrationInfo["move_location_{$blockName}_{$count}"] = 1;
1219
1220           // Add a hidden field to store the ID of the target main contact block
1221           $elements[] = array('hidden', "location[$blockName][$count][mainContactBlockId]", $mainContactBlockId);
1222
1223           // Setup variables
1224           $thisTypeId = FALSE;
1225           $thisLocId = FALSE;
1226
1227           // Provide a select drop-down for the location's location type
1228           // eg: Home, Work...
1229
1230           $js = NULL;
1231
1232           if ($blockInfo['hasLocation']) {
1233
1234             // Load the location options for this entity
1235             $locationOptions = civicrm_api3($blockName, 'getoptions', array('field' => 'location_type_id'));
1236
1237             // JS lookup 'main' contact's location (if there are any)
1238             if (!empty($locations['main'][$blockName])) {
1239               $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'locTypeId' );");
1240             }
1241
1242             $thisLocId = $value['location_type_id'];
1243
1244             // Put this field's location type at the top of the list
1245             $tmpIdList = $locationOptions['values'];
1246             $defaultLocId = array($thisLocId => $tmpIdList[$thisLocId]);
1247             unset($tmpIdList[$thisLocId]);
1248
1249             // Add the element
1250             $elements[] = array(
1251               'select',
1252               "location[$blockName][$count][locTypeId]",
1253               NULL,
1254               $defaultLocId + $tmpIdList,
1255               $js,
1256             );
1257
1258             // Add the relevant information to the $migrationInfo
1259             // Keep location-type-id same as that of other-contact
1260             // @todo Check this logic out
1261             $migrationInfo['location_blocks'][$blockName][$count]['locTypeId'] = $thisLocId;
1262             if ($blockName != 'address') {
1263               $elements[] = array('advcheckbox', "location[{$blockName}][$count][operation]", NULL, ts('add new'));
1264               // always use add operation
1265               $migrationInfo['location_blocks'][$blockName][$count]['operation'] = 1;
1266             }
1267
1268           }
1269
1270           // Provide a select drop-down for the location's type/provider
1271           // eg websites: Google+, Facebook...
1272
1273           $js = NULL;
1274
1275           if ($blockInfo['hasType']) {
1276
1277             // Load the type options for this entity
1278             $typeOptions = civicrm_api3($blockName, 'getoptions', array('field' => $blockInfo['hasType']));
1279
1280             // CRM-17556 Set up JS lookup of 'main' contact's value by type
1281             if (!empty($locations['main'][$blockName])) {
1282               $js = array('onChange' => "mergeBlock('$blockName', this, $count, 'typeTypeId' );");
1283             }
1284
1285             $thisTypeId = $value[$blockInfo['hasType']];
1286
1287             // Put this field's location type at the top of the list
1288             $tmpIdList = $typeOptions['values'];
1289             $defaultTypeId = array($thisTypeId => $tmpIdList[$thisTypeId]);
1290             unset($tmpIdList[$thisTypeId]);
1291
1292             // Add the element
1293             $elements[] = array(
1294               'select',
1295               "location[$blockName][$count][typeTypeId]",
1296               NULL,
1297               $defaultTypeId + $tmpIdList,
1298               $js,
1299             );
1300
1301             // Add the information to the migrationInfo (@todo Why?)
1302             $migrationInfo['location_blocks'][$blockName][$count]['typeTypeId'] = $thisTypeId;
1303
1304           }
1305
1306           // Set the label for this row
1307           $rowTitle = $blockInfo['label'] . ' ' . ($count + 1);
1308           if (!empty($thisLocId)) {
1309             $rowTitle .= ' (' . $locationOptions['values'][$thisLocId] . ')';
1310           }
1311           if (!empty($thisTypeId)) {
1312             $rowTitle .= ' (' . $typeOptions['values'][$thisTypeId] . ')';
1313           }
1314           $rows["move_location_{$blockName}_$count"]['title'] = $rowTitle;
1315
1316         } // End loop through 'other' locations of this type
1317
1318       } // End if 'other' location for this type exists
1319
1320     } // End loop through each location block entity
1321
1322     // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1323     $config = CRM_Core_Config::singleton();
1324     $mainUfId = CRM_Core_BAO_UFMatch::getUFId($mainId);
1325     $mainUser = NULL;
1326     if ($mainUfId) {
1327       // d6 compatible
1328       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1329         $mainUser = user_load($mainUfId);
1330       }
1331       elseif ($config->userFramework == 'Joomla') {
1332         $mainUser = JFactory::getUser($mainUfId);
1333       }
1334     }
1335     $otherUfId = CRM_Core_BAO_UFMatch::getUFId($otherId);
1336     $otherUser = NULL;
1337     if ($otherUfId) {
1338       // d6 compatible
1339       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1340         $otherUser = user_load($otherUfId);
1341       }
1342       elseif ($config->userFramework == 'Joomla') {
1343         $otherUser = JFactory::getUser($otherUfId);
1344       }
1345     }
1346
1347     $relTables = CRM_Dedupe_Merger::relTables();
1348     $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($otherId);
1349     $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
1350     foreach ($relTables as $name => $null) {
1351       if (!in_array($name, $activeRelTables) &&
1352         !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables))
1353       ) {
1354         unset($relTables[$name]);
1355         continue;
1356       }
1357
1358       $relTableElements[] = array('checkbox', "move_$name");
1359       $migrationInfo["move_$name"] = 1;
1360
1361       $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']);
1362       $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']);
1363       if ($name == 'rel_table_users') {
1364         $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']);
1365         $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']);
1366         $find = array('$ufid', '$ufname');
1367         if ($mainUser) {
1368           $replace = array($mainUfId, $mainUser->name);
1369           $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1370         }
1371         if ($otherUser) {
1372           $replace = array($otherUfId, $otherUser->name);
1373           $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1374         }
1375       }
1376       if ($name == 'rel_table_memberships') {
1377         $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new'));
1378         $migrationInfo["operation"]["move_{$name}"]['add'] = 1;
1379       }
1380     }
1381     foreach ($relTables as $name => $null) {
1382       $relTables["move_$name"] = $relTables[$name];
1383       unset($relTables[$name]);
1384     }
1385
1386     // handle custom fields
1387     $mainTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $mainId, -1,
1388       CRM_Utils_Array::value('contact_sub_type', $main)
1389     );
1390     $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $otherId, -1,
1391       CRM_Utils_Array::value('contact_sub_type', $other)
1392     );
1393     CRM_Core_DAO::freeResult();
1394
1395     foreach ($otherTree as $gid => $group) {
1396       $foundField = FALSE;
1397       if (!isset($group['fields'])) {
1398         continue;
1399       }
1400
1401       foreach ($group['fields'] as $fid => $field) {
1402         if (in_array($fid, $compareFields['custom'])) {
1403           if (!$foundField) {
1404             $rows["custom_group_$gid"]['title'] = $group['title'];
1405             $foundField = TRUE;
1406           }
1407           if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) {
1408             foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1409               $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid);
1410             }
1411           }
1412           $value = "null";
1413           if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) {
1414             foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1415               $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomField::displayValue($values['data'], $fid);
1416               if ($values['data'] === 0 || $values['data'] === '0') {
1417                 $values['data'] = $qfZeroBug;
1418               }
1419               $value = ($values['data']) ? $values['data'] : $value;
1420             }
1421           }
1422           $rows["move_custom_$fid"]['title'] = $field['label'];
1423
1424           $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value);
1425           $migrationInfo["move_custom_$fid"] = $value;
1426         }
1427       }
1428     }
1429
1430     $result = array(
1431       'rows' => $rows,
1432       'elements' => $elements,
1433       'rel_table_elements' => $relTableElements,
1434       'main_loc_block' => $mainLocBlock,
1435       'rel_tables' => $relTables,
1436       'main_details' => $main,
1437       'other_details' => $other,
1438       'migration_info' => $migrationInfo,
1439     );
1440
1441     $result['main_details']['location_blocks'] = $locations['main'];
1442     $result['other_details']['location_blocks'] = $locations['other'];
1443
1444     return $result;
1445   }
1446
1447   /**
1448    * Based on the provided two contact_ids and a set of tables, move the belongings of the
1449    * other contact to the main one - be it Location / CustomFields or Contact .. related info.
1450    * A superset of moveContactBelongings() function.
1451    *
1452    * @param int $mainId
1453    *   Main contact with whom merge has to happen.
1454    * @param int $otherId
1455    *   Duplicate contact which would be deleted after merge operation.
1456    *
1457    * @param $migrationInfo
1458    *
1459    * @return bool
1460    */
1461   public static function moveAllBelongings($mainId, $otherId, $migrationInfo) {
1462     if (empty($migrationInfo)) {
1463       return FALSE;
1464     }
1465
1466     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1467     $relTables = CRM_Dedupe_Merger::relTables();
1468     $moveTables = $locBlocks = $tableOperations = array();
1469     foreach ($migrationInfo as $key => $value) {
1470       if ($value == $qfZeroBug) {
1471         $value = '0';
1472       }
1473       if ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) ||
1474           substr($key, 0, 12) == 'move_custom_') &&
1475         $value != NULL
1476       ) {
1477         $submitted[substr($key, 5)] = $value;
1478       }
1479
1480       // Set up initial information for handling migration of location blocks
1481       elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) {
1482         $locField = explode('_', $key);
1483         $fieldName = $locField[2];
1484         $fieldCount = $locField[3];
1485
1486         // Set up the operation type (add/overwrite)
1487         // Ignore operation for websites
1488         // @todo Tidy this up
1489         $operation = 0;
1490         if ($fieldName != 'website') {
1491           $operation = CRM_Utils_Array::value('operation', $migrationInfo['location_blocks'][$fieldName][$fieldCount]);
1492         }
1493         // default operation is overwrite.
1494         if (!$operation) {
1495           $operation = 2;
1496         }
1497         $locBlocks[$fieldName][$fieldCount]['operation'] = $operation;
1498
1499       }
1500
1501       elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') {
1502         $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1503         if (array_key_exists('operation', $migrationInfo)) {
1504           foreach ($relTables[substr($key, 5)]['tables'] as $table) {
1505             if (array_key_exists($key, $migrationInfo['operation'])) {
1506               $tableOperations[$table] = $migrationInfo['operation'][$key];
1507             }
1508           }
1509         }
1510       }
1511     }
1512
1513     // **** Do location related migration.
1514     // @todo Handle OpenID (not currently in API).
1515     if (!empty($locBlocks)) {
1516
1517       $locationBlocks = self::getLocationBlockInfo();
1518
1519       $primaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_primary' => 1));
1520       $billingBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_billing' => 1));
1521
1522       foreach ($locBlocks as $name => $block) {
1523         if (!is_array($block) || CRM_Utils_System::isNull($block)) {
1524           continue;
1525         }
1526         $daoName = 'CRM_Core_DAO_' . $locationBlocks[$name]['label'];
1527         $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ? array_pop($primaryBlockIds[$name]) : NULL;
1528         $billingDAOId = (array_key_exists($name, $billingBlockIds)) ? array_pop($billingBlockIds[$name]) : NULL;
1529
1530         foreach ($block as $blkCount => $values) {
1531
1532           // For the block which belongs to other-contact, link the location block to main-contact
1533           $otherBlockDAO = new $daoName();
1534           $otherBlockDAO->contact_id = $mainId;
1535
1536           // Get the ID of this block on the 'other' contact, otherwise skip
1537           $otherBlockId = CRM_Utils_Array::value('id', $migrationInfo['other_details']['location_blocks'][$name][$blkCount]);
1538           if (!$otherBlockId) {
1539             continue;
1540           }
1541           $otherBlockDAO->id = $otherBlockId;
1542
1543           // Add/update location and type information from the form, if applicable
1544           if ($locationBlocks[$name]['hasLocation']) {
1545             $locTypeId = CRM_Utils_Array::value('locTypeId', $migrationInfo['location_blocks'][$name][$blkCount]);
1546             $otherBlockDAO->location_type_id = $locTypeId;
1547           }
1548           if ($locationBlocks[$name]['hasType']) {
1549             $typeTypeId = CRM_Utils_Array::value('typeTypeId', $migrationInfo['location_blocks'][$name][$blkCount]);
1550             $otherBlockDAO->{$locationBlocks[$name]['hasType']} = $typeTypeId;
1551           }
1552
1553           // Get main block ID
1554           $mainBlockId = CRM_Utils_Array::value('mainContactBlockId', $migrationInfo['location_blocks'][$name][$blkCount], 0);
1555
1556           // if main contact already has primary & billing, set the flags to 0.
1557           if ($primaryDAOId) {
1558             $otherBlockDAO->is_primary = 0;
1559           }
1560           if ($billingDAOId) {
1561             $otherBlockDAO->is_billing = 0;
1562           }
1563
1564           $operation = CRM_Utils_Array::value('operation', $values, 2);
1565           // overwrite - need to delete block which belongs to main-contact.
1566           if (!empty($mainBlockId) && ($operation == 2)) {
1567             $deleteDAO = new $daoName();
1568             $deleteDAO->id = $mainBlockId;
1569             $deleteDAO->find(TRUE);
1570
1571             // if we about to delete a primary / billing block, set the flags for new block
1572             // that we going to assign to main-contact
1573             if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id)) {
1574               $otherBlockDAO->is_primary = 1;
1575             }
1576             if ($billingDAOId && ($billingDAOId == $deleteDAO->id)) {
1577               $otherBlockDAO->is_billing = 1;
1578             }
1579
1580             $deleteDAO->delete();
1581             $deleteDAO->free();
1582           }
1583
1584           $otherBlockDAO->update();
1585           $otherBlockDAO->free();
1586         }
1587       }
1588     }
1589
1590     // **** Do tables related migrations
1591     if (!empty($moveTables)) {
1592       CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations);
1593       unset($moveTables, $tableOperations);
1594     }
1595
1596     // **** Do contact related migrations
1597     CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId);
1598
1599     // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact()
1600     $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender');
1601     $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix');
1602     $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix');
1603     $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style');
1604     $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee');
1605     $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting');
1606     $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting');
1607     CRM_Core_OptionGroup::lookupValues($submitted, $names, TRUE);
1608
1609     // fix custom fields so they're edible by createProfileContact()
1610     static $treeCache = array();
1611     if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) {
1612       $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup::getTree($migrationInfo['main_details']['contact_type'],
1613         CRM_Core_DAO::$_nullObject, NULL, -1
1614       );
1615     }
1616     $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']];
1617
1618     $cFields = array();
1619     foreach ($cgTree as $key => $group) {
1620       if (!isset($group['fields'])) {
1621         continue;
1622       }
1623       foreach ($group['fields'] as $fid => $field) {
1624         $cFields[$fid]['attributes'] = $field;
1625       }
1626     }
1627
1628     if (!isset($submitted)) {
1629       $submitted = array();
1630     }
1631     foreach ($submitted as $key => $value) {
1632       if (substr($key, 0, 7) == 'custom_') {
1633         $fid = (int) substr($key, 7);
1634         if (empty($cFields[$fid])) {
1635           continue;
1636         }
1637         $htmlType = $cFields[$fid]['attributes']['html_type'];
1638         switch ($htmlType) {
1639           case 'File':
1640             $customFiles[] = $fid;
1641             unset($submitted["custom_$fid"]);
1642             break;
1643
1644           case 'Select Country':
1645           case 'Select State/Province':
1646             $submitted[$key] = CRM_Core_BAO_CustomField::displayValue($value, $fid);
1647             break;
1648
1649           case 'CheckBox':
1650           case 'AdvMulti-Select':
1651           case 'Multi-Select':
1652           case 'Multi-Select Country':
1653           case 'Multi-Select State/Province':
1654             // Merge values from both contacts for multivalue fields, CRM-4385
1655             // get the existing custom values from db.
1656             $customParams = array('entityID' => $mainId, $key => TRUE);
1657             $customfieldValues = CRM_Core_BAO_CustomValueTable::getValues($customParams);
1658             if (!empty($customfieldValues[$key])) {
1659               $existingValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $customfieldValues[$key]);
1660               if (is_array($existingValue) && !empty($existingValue)) {
1661                 $mergeValue = $submmtedCustomValue = array();
1662                 if ($value) {
1663                   $submmtedCustomValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1664                 }
1665
1666                 //hack to remove null and duplicate values from array.
1667                 foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) {
1668                   if ($v != '' && !in_array($v, $mergeValue)) {
1669                     $mergeValue[] = $v;
1670                   }
1671                 }
1672
1673                 //keep state and country as array format.
1674                 //for checkbox and m-select format w/ VALUE_SEPARATOR
1675                 if (in_array($htmlType, array(
1676                   'CheckBox',
1677                   'Multi-Select',
1678                   'AdvMulti-Select',
1679                 ))) {
1680                   $submitted[$key] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1681                       $mergeValue
1682                     ) . CRM_Core_DAO::VALUE_SEPARATOR;
1683                 }
1684                 else {
1685                   $submitted[$key] = $mergeValue;
1686                 }
1687               }
1688             }
1689             elseif (in_array($htmlType, array(
1690               'Multi-Select Country',
1691               'Multi-Select State/Province',
1692             ))) {
1693               //we require submitted values should be in array format
1694               if ($value) {
1695                 $mergeValueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1696                 //hack to remove null values from array.
1697                 $mergeValue = array();
1698                 foreach ($mergeValueArray as $k => $v) {
1699                   if ($v != '') {
1700                     $mergeValue[] = $v;
1701                   }
1702                 }
1703                 $submitted[$key] = $mergeValue;
1704               }
1705             }
1706             break;
1707
1708           default:
1709             break;
1710         }
1711       }
1712     }
1713
1714     // **** Do file custom fields related migrations
1715     // FIXME: move this someplace else (one of the BAOs) after discussing
1716     // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually,
1717     // like, delete a file...
1718
1719     if (!isset($customFiles)) {
1720       $customFiles = array();
1721     }
1722     foreach ($customFiles as $customId) {
1723       list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($customId);
1724
1725       // get the contact_id -> file_id mapping
1726       $fileIds = array();
1727       $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})";
1728       $dao = CRM_Core_DAO::executeQuery($sql);
1729       while ($dao->fetch()) {
1730         $fileIds[$dao->entity_id] = $dao->file_id;
1731       }
1732       $dao->free();
1733
1734       // delete the main contact's file
1735       if (!empty($fileIds[$mainId])) {
1736         CRM_Core_BAO_File::deleteFileReferences($fileIds[$mainId], $mainId, $customId);
1737       }
1738
1739       // move the other contact's file to main contact
1740       //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record
1741       if (CRM_Core_DAO::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}")) {
1742         $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}";
1743       }
1744       else {
1745         $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )";
1746       }
1747       CRM_Core_DAO::executeQuery($sql);
1748
1749       if (CRM_Core_DAO::singleValueQuery("
1750         SELECT id
1751         FROM civicrm_entity_file
1752         WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}")
1753       ) {
1754         $sql = "
1755           UPDATE civicrm_entity_file
1756           SET entity_id = {$mainId}
1757           WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}";
1758       }
1759       else {
1760         $sql = "
1761           INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id )
1762           VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )";
1763       }
1764       CRM_Core_DAO::executeQuery($sql);
1765     }
1766
1767     // move view only custom fields CRM-5362
1768     $viewOnlyCustomFields = array();
1769     foreach ($submitted as $key => $value) {
1770       $fid = (int) substr($key, 7);
1771       if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) {
1772         $viewOnlyCustomFields[$key] = $value;
1773       }
1774     }
1775
1776     // special case to set values for view only, CRM-5362
1777     if (!empty($viewOnlyCustomFields)) {
1778       $viewOnlyCustomFields['entityID'] = $mainId;
1779       CRM_Core_BAO_CustomValueTable::setValues($viewOnlyCustomFields);
1780     }
1781
1782     // **** Delete other contact & update prev-next caching
1783     $otherParams = array(
1784       'contact_id' => $otherId,
1785       'id' => $otherId,
1786       'version' => 3,
1787     );
1788     if (CRM_Core_Permission::check('merge duplicate contacts') &&
1789       CRM_Core_Permission::check('delete contacts')
1790     ) {
1791       // if ext id is submitted then set it null for contact to be deleted
1792       if (!empty($submitted['external_identifier'])) {
1793         $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}";
1794         CRM_Core_DAO::executeQuery($query);
1795       }
1796
1797       civicrm_api('contact', 'delete', $otherParams);
1798       CRM_Core_BAO_PrevNextCache::deleteItem($otherId);
1799     }
1800     // FIXME: else part
1801     /*         else { */
1802
1803     /*             CRM_Core_Session::setStatus( ts('Do not have sufficient permission to delete duplicate contact.') ); */
1804
1805     /*         } */
1806
1807     // CRM-15681 merge sub_types
1808     if ($other_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['other_details'])) {
1809       if ($main_sub_types = CRM_Utils_array::value('contact_sub_type', $migrationInfo['main_details'])) {
1810         $submitted['contact_sub_type'] = array_unique(array_merge($main_sub_types, $other_sub_types));
1811       }
1812       else {
1813         $submitted['contact_sub_type'] = $other_sub_types;
1814       }
1815     }
1816
1817     // **** Update contact related info for the main contact
1818     if (!empty($submitted)) {
1819       $submitted['contact_id'] = $mainId;
1820
1821       //update current employer field
1822       if ($currentEmloyerId = CRM_Utils_Array::value('current_employer_id', $submitted)) {
1823         if (!CRM_Utils_System::isNull($currentEmloyerId)) {
1824           $submitted['current_employer'] = $submitted['current_employer_id'];
1825         }
1826         else {
1827           $submitted['current_employer'] = '';
1828         }
1829         unset($submitted['current_employer_id']);
1830       }
1831
1832       //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name
1833       if (!isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id'])) {
1834         $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id'];
1835       }
1836       if (!isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id'])) {
1837         $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id'];
1838       }
1839
1840       CRM_Contact_BAO_Contact::createProfileContact($submitted, CRM_Core_DAO::$_nullArray, $mainId);
1841       unset($submitted);
1842     }
1843
1844     CRM_Utils_Hook::post('merge', 'Contact', $mainId, CRM_Core_DAO::$_nullObject);
1845
1846     return TRUE;
1847   }
1848
1849   /**
1850    * @return array
1851    *   Array of field names which will be compared, so everything except ID.
1852    */
1853   public static function getContactFields() {
1854     $contactFields = CRM_Contact_DAO_Contact::fields();
1855     $invalidFields = array(
1856       'api_key',
1857       'contact_is_deleted',
1858       'created_date',
1859       'display_name',
1860       'hash',
1861       'id',
1862       'modified_date',
1863       'primary_contact_id',
1864       'sort_name',
1865       'user_unique_id',
1866     );
1867     foreach ($contactFields as $field => $value) {
1868       if (in_array($field, $invalidFields)) {
1869         unset($contactFields[$field]);
1870       }
1871     }
1872     return array_keys($contactFields);
1873   }
1874
1875   /**
1876    * Added for CRM-12695
1877    * Based on the contactID provided
1878    * add/update membership(s) to related contacts
1879    *
1880    * @param int $contactID
1881    */
1882   public static function addMembershipToRealtedContacts($contactID) {
1883     $dao = new CRM_Member_DAO_Membership();
1884     $dao->contact_id = $contactID;
1885     $dao->is_test = 0;
1886     $dao->find();
1887
1888     //checks membership of contact itself
1889     while ($dao->fetch()) {
1890       $relationshipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id, 'relationship_type_id', 'id');
1891       if ($relationshipTypeId) {
1892         $membershipParams = array(
1893           'id' => $dao->id,
1894           'contact_id' => $dao->contact_id,
1895           'membership_type_id' => $dao->membership_type_id,
1896           'join_date' => CRM_Utils_Date::isoToMysql($dao->join_date),
1897           'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date),
1898           'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date),
1899           'source' => $dao->source,
1900           'status_id' => $dao->status_id,
1901         );
1902         // create/update membership(s) for related contact(s)
1903         CRM_Member_BAO_Membership::createRelatedMemberships($membershipParams, $dao);
1904       } // end of if relationshipTypeId
1905     }
1906   }
1907
1908   /**
1909    * Add custom tables that extend contacts to the list of contact references.
1910    *
1911    * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
1912    * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
1913    * - the down side is it is not cached.
1914    *
1915    * Further changes should be include tests in the CRM_Core_MergerTest class
1916    * to ensure that disabled, subtype, multiple etc groups are still captured.
1917    *
1918    * @param array $cidRefs
1919    */
1920   public static function addCustomTablesExtendingContactsToCidRefs(&$cidRefs) {
1921     $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact');
1922     $customValueTables->find();
1923     while ($customValueTables->fetch()) {
1924       $cidRefs[$customValueTables->table_name] = array('entity_id');
1925     }
1926   }
1927
1928 }