CRM/Dedupe/Merger.php

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