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