CRM/Dedupe/Merger.php

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