CRM/Dedupe/Merger.php

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