CRM/Dedupe/Merger.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Dedupe_Merger {
  36
  37   // FIXME: consider creating a common structure with cidRefs() and eidRefs()
  38   // FIXME: the sub-pages references by the URLs should
  39   // be loaded dynamically on the merge form instead
  40   static function relTables() {
  41     static $relTables;
  42
  43     $config = CRM_Core_Config::singleton();
  44     if ($config->userSystem->is_drupal) {
  45       $userRecordUrl = CRM_Utils_System::url('user/%ufid');
  46       $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework, 2 => '$ufname', 3 => '$ufid'));
  47     }
  48     elseif ($config->userFramework == 'Joomla') {
  49       $userRecordUrl = $config->userFrameworkVersion > 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';
  50       $title = ts('%1 User: %2; user id: %3', array(1 => $config->userFramework, 2 => '$ufname', 3 => '$ufid'));
  51     }
  52
  53     if (!$relTables) {
  54       $relTables = array(
  55         'rel_table_contributions' => array(
  56           'title' => ts('Contributions'),
  57           'tables' => array('civicrm_contribution', 'civicrm_contribution_recur', 'civicrm_contribution_soft'),
  58           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=contribute'),
  59         ),
  60         'rel_table_contribution_page' => array(
  61           'title' => ts('Contribution Pages'),
  62           'tables' => array('civicrm_contribution_page'),
  63           'url' => CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1&cid=$cid'),
  64         ),
  65         'rel_table_memberships' => array(
  66           'title' => ts('Memberships'),
  67           'tables' => array('civicrm_membership', 'civicrm_membership_log', 'civicrm_membership_type'),
  68           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=member'),
  69         ),
  70         'rel_table_participants' => array(
  71           'title' => ts('Participants'),
  72           'tables' => array('civicrm_participant'),
  73           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=participant'),
  74         ),
  75         'rel_table_events' => array(
  76           'title' => ts('Events'),
  77           'tables' => array('civicrm_event'),
  78           'url' => CRM_Utils_System::url('civicrm/event/manage', 'reset=1&cid=$cid'),
  79         ),
  80         'rel_table_activities' => array(
  81           'title' => ts('Activities'),
  82           'tables' => array('civicrm_activity', 'civicrm_activity_contact'),
  83           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=activity'),
  84         ),
  85         'rel_table_relationships' => array(
  86           'title' => ts('Relationships'),
  87           'tables' => array('civicrm_relationship'),
  88           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=rel'),
  89         ),
  90         'rel_table_custom_groups' => array(
  91           'title' => ts('Custom Groups'),
  92           'tables' => array('civicrm_custom_group'),
  93           'url' => CRM_Utils_System::url('civicrm/admin/custom/group', 'reset=1'),
  94         ),
  95         'rel_table_uf_groups' => array(
  96           'title' => ts('Profiles'),
  97           'tables' => array('civicrm_uf_group'),
  98           'url' => CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1'),
  99         ),
 100         'rel_table_groups' => array(
 101           'title' => ts('Groups'),
 102           'tables' => array('civicrm_group_contact'),
 103           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=group'),
 104         ),
 105         'rel_table_notes' => array(
 106           'title' => ts('Notes'),
 107           'tables' => array('civicrm_note'),
 108           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=note'),
 109         ),
 110         'rel_table_tags' => array(
 111           'title' => ts('Tags'),
 112           'tables' => array('civicrm_entity_tag'),
 113           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=tag'),
 114         ),
 115         'rel_table_mailings' => array(
 116           'title' => ts('Mailings'),
 117           'tables' => array('civicrm_mailing', 'civicrm_mailing_event_queue', 'civicrm_mailing_event_subscribe'),
 118           'url' => CRM_Utils_System::url('civicrm/mailing', 'reset=1&force=1&cid=$cid'),
 119         ),
 120         'rel_table_cases' => array(
 121           'title' => ts('Cases'),
 122           'tables' => array('civicrm_case_contact'),
 123           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=case'),
 124         ),
 125         'rel_table_grants' => array(
 126           'title' => ts('Grants'),
 127           'tables' => array('civicrm_grant'),
 128           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=grant'),
 129         ),
 130         'rel_table_pcp' => array(
 131           'title' => ts('PCPs'),
 132           'tables' => array('civicrm_pcp'),
 133           'url' => CRM_Utils_System::url('civicrm/contribute/pcp/manage', 'reset=1'),
 134         ),
 135         'rel_table_pledges' => array(
 136           'title' => ts('Pledges'),
 137           'tables' => array('civicrm_pledge', 'civicrm_pledge_payment'),
 138           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid&selectedChild=pledge'),
 139         ),
 140         'rel_table_users' => array(
 141           'title' => $title,
 142           'tables' => array('civicrm_uf_match'),
 143           'url' => $userRecordUrl,
 144         ),
 145       );
 146
 147       $relTables += self::getMultiValueCustomSets('relTables');
 148
 149       // Allow hook_civicrm_merge() to adjust $relTables
 150       CRM_Utils_Hook::merge('relTables', $relTables);
 151     }
 152     return $relTables;
 153   }
 154
 155   /**
 156    * Returns the related tables groups for which a contact has any info entered
 157    */
 158   static function getActiveRelTables($cid) {
 159     $cid = (int) $cid;
 160     $groups = array();
 161
 162     $relTables = self::relTables();
 163     $cidRefs = self::cidRefs();
 164     $eidRefs = self::eidRefs();
 165     foreach ($relTables as $group => $params) {
 166       $sqls = array();
 167       foreach ($params['tables'] as $table) {
 168         if (isset($cidRefs[$table])) {
 169           foreach ($cidRefs[$table] as $field) {
 170             $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $field = $cid";
 171           }
 172         }
 173         if (isset($eidRefs[$table])) {
 174           foreach ($eidRefs[$table] as $entityTable => $entityId) {
 175             $sqls[] = "SELECT COUNT(*) AS count FROM $table WHERE $entityId = $cid AND $entityTable = 'civicrm_contact'";
 176           }
 177         }
 178         foreach ($sqls as $sql) {
 179           if (CRM_Core_DAO::singleValueQuery($sql) > 0) {
 180             $groups[] = $group;
 181           }
 182         }
 183       }
 184     }
 185     return array_unique($groups);
 186   }
 187
 188   /**
 189    * Return tables and their fields referencing civicrm_contact.contact_id explicitely
 190    */
 191   static function cidRefs() {
 192     static $cidRefs;
 193     if (!$cidRefs) {
 194       // FIXME: this should be generated dynamically from the schema's
 195       // foreign keys referencing civicrm_contact(id)
 196       $cidRefs = array(
 197         'civicrm_acl_cache' => array('contact_id'),
 198         'civicrm_activity_contact' => array('contact_id'),
 199         'civicrm_case_contact' => array('contact_id'),
 200         'civicrm_contact' => array('primary_contact_id'),
 201         'civicrm_contribution' => array('contact_id'),
 202         'civicrm_contribution_page' => array('created_id'),
 203         'civicrm_contribution_recur' => array('contact_id'),
 204         'civicrm_contribution_soft' => array('contact_id'),
 205         'civicrm_custom_group' => array('created_id'),
 206         'civicrm_entity_tag' => array('entity_id'),
 207         'civicrm_event' => array('created_id'),
 208         'civicrm_grant' => array('contact_id'),
 209         'civicrm_group_contact' => array('contact_id'),
 210         'civicrm_group_organization' => array('organization_id'),
 211         'civicrm_log' => array('modified_id'),
 212         'civicrm_mailing' => array('created_id', 'scheduled_id'),
 213         'civicrm_mailing_event_queue' => array('contact_id'),
 214         'civicrm_mailing_event_subscribe' => array('contact_id'),
 215         'civicrm_membership' => array('contact_id'),
 216         'civicrm_membership_log' => array('modified_id'),
 217         'civicrm_membership_type' => array('member_of_contact_id'),
 218         'civicrm_note' => array('contact_id'),
 219         'civicrm_participant' => array('contact_id'),
 220         'civicrm_pcp' => array('contact_id'),
 221         'civicrm_relationship' => array('contact_id_a', 'contact_id_b'),
 222         'civicrm_uf_match' => array('contact_id'),
 223         'civicrm_uf_group' => array('created_id'),
 224         'civicrm_pledge' => array('contact_id'),
 225       );
 226
 227       $cidRefs += self::getMultiValueCustomSets('cidRefs');
 228
 229       // Add ContactReference custom fields CRM-9561
 230       $sql = "SELECT cg.table_name, cf.column_name
 231               FROM civicrm_custom_group cg, civicrm_custom_field cf
 232               WHERE cg.id = cf.custom_group_id AND cf.data_type = 'ContactReference'";
 233       $dao = CRM_Core_DAO::executeQuery($sql);
 234       while ($dao->fetch()) {
 235         $cidRefs[$dao->table_name][] = $dao->column_name;
 236       }
 237       $dao->free();
 238
 239       // Allow hook_civicrm_merge() to adjust $cidRefs
 240       CRM_Utils_Hook::merge('cidRefs', $cidRefs);
 241     }
 242     return $cidRefs;
 243   }
 244
 245   /**
 246    * Return tables and their fields referencing civicrm_contact.contact_id with entity_id
 247    */
 248   static function eidRefs() {
 249     static $eidRefs;
 250     if (!$eidRefs) {
 251       // FIXME: this should be generated dynamically from the schema
 252       // tables that reference contacts with entity_{id,table}
 253       $eidRefs = array(
 254         'civicrm_acl' => array('entity_table' => 'entity_id'),
 255         'civicrm_acl_entity_role' => array('entity_table' => 'entity_id'),
 256         'civicrm_entity_file' => array('entity_table' => 'entity_id'),
 257         'civicrm_log' => array('entity_table' => 'entity_id'),
 258         'civicrm_mailing_group' => array('entity_table' => 'entity_id'),
 259         'civicrm_note' => array('entity_table' => 'entity_id'),
 260       );
 261
 262       // Allow hook_civicrm_merge() to adjust $eidRefs
 263       CRM_Utils_Hook::merge('eidRefs', $eidRefs);
 264     }
 265     return $eidRefs;
 266   }
 267
 268   /**
 269    * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc.
 270    * @param string $request 'relTables' or 'cidRefs'
 271    * @see CRM-13836
 272    */
 273   static function getMultiValueCustomSets($request) {
 274     static $data = NULL;
 275     if ($data === NULL) {
 276       $data = array(
 277         'relTables' => array(),
 278         'cidRefs' => array(),
 279       );
 280       $result = civicrm_api3('custom_group', 'get', array(
 281         'is_multiple' => 1,
 282         'extends' => array('IN' => array('Individual', 'Organization', 'Household', 'Contact')),
 283         'return' => array('id', 'title', 'table_name', 'style'),
 284       ));
 285       foreach($result['values'] as $custom) {
 286         $data['cidRefs'][$custom['table_name']] = array('entity_id');
 287         $urlSuffix = $custom['style'] == 'Tab' ? '&selectedChild=custom_' . $custom['id'] : '';
 288         $data['relTables']['rel_table_custom_' . $custom['id']] = array(
 289           'title' => $custom['title'],
 290           'tables' => array($custom['table_name']),
 291           'url' => CRM_Utils_System::url('civicrm/contact/view', 'reset=1&force=1&cid=$cid' . $urlSuffix),
 292         );
 293       }
 294     }
 295     return $data[$request];
 296   }
 297
 298   /**
 299    * Tables which require custom processing should declare functions to call here.
 300    * Doing so will override normal processing.
 301    */
 302   static function cpTables() {
 303     static $tables;
 304     if (!$tables) {
 305       $tables = array(
 306         'civicrm_case_contact' => array('CRM_Case_BAO_Case' => 'mergeContacts'),
 307         'civicrm_group_contact' => array('CRM_Contact_BAO_GroupContact' => 'mergeGroupContact'),
 308         // Empty array == do nothing - this table is handled by mergeGroupContact
 309         'civicrm_subscription_history' => array(),
 310         'civicrm_relationship' => array('CRM_Contact_BAO_Relationship' => 'mergeRelationships'),
 311       );
 312     }
 313     return $tables;
 314   }
 315
 316   /**
 317    * return payment related table.
 318    */
 319   static function paymentTables() {
 320     static $tables;
 321     if (!$tables) {
 322       $tables = array('civicrm_pledge', 'civicrm_membership', 'civicrm_participant');
 323     }
 324
 325     return $tables;
 326   }
 327
 328   /**
 329    * return payment update Query.
 330    */
 331   static function paymentSql($tableName, $mainContactId, $otherContactId) {
 332     $sqls = array();
 333     if (!$tableName || !$mainContactId || !$otherContactId) {
 334       return $sqls;
 335     }
 336
 337     $paymentTables = self::paymentTables();
 338     if (!in_array($tableName, $paymentTables)) {
 339       return $sqls;
 340     }
 341
 342     switch ($tableName) {
 343       case 'civicrm_pledge':
 344         $sqls[] = "
 345     UPDATE  IGNORE  civicrm_contribution contribution
 346 INNER JOIN  civicrm_pledge_payment payment ON ( payment.contribution_id = contribution.id )
 347 INNER JOIN  civicrm_pledge pledge ON ( pledge.id = payment.pledge_id )
 348        SET  contribution.contact_id = $mainContactId
 349      WHERE  pledge.contact_id = $otherContactId";
 350         break;
 351
 352       case 'civicrm_membership':
 353         $sqls[] = "
 354     UPDATE  IGNORE  civicrm_contribution contribution
 355 INNER JOIN  civicrm_membership_payment payment ON ( payment.contribution_id = contribution.id )
 356 INNER JOIN  civicrm_membership membership ON ( membership.id = payment.membership_id )
 357        SET  contribution.contact_id = $mainContactId
 358      WHERE  membership.contact_id = $otherContactId";
 359         break;
 360
 361       case 'civicrm_participant':
 362         $sqls[] = "
 363     UPDATE  IGNORE  civicrm_contribution contribution
 364 INNER JOIN  civicrm_participant_payment payment ON ( payment.contribution_id = contribution.id )
 365 INNER JOIN  civicrm_participant participant ON ( participant.id = payment.participant_id )
 366        SET  contribution.contact_id = $mainContactId
 367      WHERE  participant.contact_id = $otherContactId";
 368         break;
 369     }
 370
 371     return $sqls;
 372   }
 373
 374   static function operationSql($mainId, $otherId, $tableName, $tableOperations = array(), $mode = 'add') {
 375     $sqls = array();
 376     if (!$tableName || !$mainId || !$otherId) {
 377       return $sqls;
 378     }
 379
 380
 381     switch ($tableName) {
 382       case 'civicrm_membership':
 383         if (array_key_exists($tableName, $tableOperations) && $tableOperations[$tableName]['add'])
 384         break;
 385       if ($mode == 'add') {
 386         $sqls[] = "
 387 DELETE membership1.* FROM civicrm_membership membership1
 388  INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
 389              AND membership1.contact_id = {$mainId}
 390              AND membership2.contact_id = {$otherId} ";
 391       }
 392       if ($mode == 'payment') {
 393         $sqls[] = "
 394 DELETE contribution.* FROM civicrm_contribution contribution
 395 INNER JOIN  civicrm_membership_payment payment ON payment.contribution_id = contribution.id
 396 INNER JOIN  civicrm_membership membership1 ON membership1.id = payment.membership_id
 397             AND membership1.contact_id = {$mainId}
 398 INNER JOIN  civicrm_membership membership2 ON membership1.membership_type_id = membership2.membership_type_id
 399             AND membership2.contact_id = {$otherId}";
 400       }
 401       break;
 402
 403       case 'civicrm_uf_match':
 404         // normal queries won't work for uf_match since that will lead to violation of unique constraint,
 405         // failing to meet intended result. Therefore we introduce this additonal query:
 406         $sqls[] = "DELETE FROM civicrm_uf_match WHERE contact_id = {$mainId}";
 407         break;
 408     }
 409
 410     return $sqls;
 411   }
 412
 413   /**
 414    * Based on the provided two contact_ids and a set of tables, move the
 415    * belongings of the other contact to the main one.
 416    *
 417    * @static
 418    */
 419   static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) {
 420     $cidRefs = self::cidRefs();
 421     $eidRefs = self::eidRefs();
 422     $cpTables = self::cpTables();
 423     $paymentTables = self::paymentTables();
 424     $membershipMerge = FALSE; // CRM-12695
 425
 426     $affected = array_merge(array_keys($cidRefs), array_keys($eidRefs));
 427     if ($tables !== FALSE) {
 428       // if there are specific tables, sanitize the list
 429       $affected = array_unique(array_intersect($affected, $tables));
 430     }
 431     else {
 432       // if there aren't any specific tables, don't affect the ones handled by relTables()
 433       $relTables = self::relTables();
 434       $handled = array();
 435       foreach ($relTables as $params) {
 436         $handled = array_merge($handled, $params['tables']);
 437       }
 438       $affected = array_diff($affected, $handled);
 439       /**
 440        * CRM-12695
 441        * Set $membershipMerge flag only once
 442        * while doing contact related migration
 443        * to call addMembershipToRealtedContacts()
 444        * function only once.
 445        * Since the current function (moveContactBelongings) is called twice
 446        * with & without parameters $tables & $tableOperations
 447        */
 448       // retrieve main contact's related table(s)
 449       $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
 450       // check if membership table exists in main contact's related table(s)
 451       if (in_array('rel_table_memberships', $activeMainRelTables)) {
 452         $membershipMerge = TRUE; // set membership flag - CRM-12695
 453       }
 454     }
 455
 456     $mainId = (int) $mainId;
 457     $otherId = (int) $otherId;
 458
 459     $sqls = array();
 460     foreach ($affected as $table) {
 461       // Call custom processing function for objects that require it
 462       if (isset($cpTables[$table])) {
 463         foreach ($cpTables[$table] as $className => $fnName) {
 464           $className::$fnName($mainId, $otherId, $sqls);
 465         }
 466         // Skip normal processing
 467         continue;
 468       }
 469
 470       // use UPDATE IGNORE + DELETE query pair to skip on situations when
 471       // there's a UNIQUE restriction on ($field, some_other_field) pair
 472       if (isset($cidRefs[$table])) {
 473         foreach ($cidRefs[$table] as $field) {
 474           // carry related contributions CRM-5359
 475           if (in_array($table, $paymentTables)) {
 476             $payOprSqls = self::operationSql($mainId, $otherId, $table, $tableOperations, 'payment');
 477             $sqls = array_merge($sqls, $payOprSqls);
 478
 479             $paymentSqls = self::paymentSql($table, $mainId, $otherId);
 480             $sqls = array_merge($sqls, $paymentSqls);
 481           }
 482
 483           $preOperationSqls = self::operationSql($mainId, $otherId, $table, $tableOperations);
 484           $sqls = array_merge($sqls, $preOperationSqls);
 485
 486           $sqls[] = "UPDATE IGNORE $table SET $field = $mainId WHERE $field = $otherId";
 487           $sqls[] = "DELETE FROM $table WHERE $field = $otherId";
 488         }
 489       }
 490       if (isset($eidRefs[$table])) {
 491         foreach ($eidRefs[$table] as $entityTable => $entityId) {
 492           $sqls[] = "UPDATE IGNORE $table SET $entityId = $mainId WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 493           $sqls[] = "DELETE FROM $table WHERE $entityId = $otherId AND $entityTable = 'civicrm_contact'";
 494         }
 495       }
 496     }
 497
 498     // Allow hook_civicrm_merge() to add SQL statements for the merge operation.
 499     CRM_Utils_Hook::merge('sqls', $sqls, $mainId, $otherId, $tables);
 500
 501     // call the SQL queries in one transaction
 502     $transaction = new CRM_Core_Transaction();
 503     foreach ($sqls as $sql) {
 504       CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE);
 505     }
 506     // CRM-12695
 507     if ($membershipMerge) {
 508       // call to function adding membership to related contacts
 509       CRM_Dedupe_Merger::addMembershipToRealtedContacts($mainId);
 510     }
 511     $transaction->commit();
 512   }
 513
 514   /**
 515    * Find differences between contacts.
 516    *
 517    * @param array $main contact details
 518    * @param array $other contact details
 519    *
 520    * @static
 521    */
 522   static function findDifferences($main, $other) {
 523     $result = array(
 524       'contact' => array(),
 525       'custom' => array(),
 526     );
 527     foreach (self::getContactFields() as $validField) {
 528       if (CRM_Utils_Array::value($validField, $main) != CRM_Utils_Array::value($validField, $other)) {
 529         $result['contact'][] = $validField;
 530       }
 531     }
 532
 533     $mainEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($main['id']);
 534     $otherEvs = CRM_Core_BAO_CustomValueTable::getEntityValues($other['id']);
 535     $keys = array_unique(array_merge(array_keys($mainEvs), array_keys($otherEvs)));
 536     foreach ($keys as $key) {
 537       // Exclude multi-value fields CRM-13836
 538       if (strpos($key, '_')) {
 539         continue;
 540       }
 541       $key1 = CRM_Utils_Array::value($key, $mainEvs);
 542       $key2 = CRM_Utils_Array::value($key, $otherEvs);
 543       if ($key1 != $key2) {
 544         $result['custom'][] = $key;
 545       }
 546     }
 547     return $result;
 548   }
 549
 550   /**
 551    * Function to batch merge a set of contacts based on rule-group and group.
 552    *
 553    * @param  int     $rgid        rule group id
 554    * @param  int     $gid         group id
 555    * @param  array   $cacheParams prev-next-cache params based on which next pair of contacts are computed.
 556    *                              Generally used with batch-merge.
 557    * @param  string  $mode        helps decide how to behave when there are conflicts.
 558    *                              A 'safe' value skips the merge if there are any un-resolved conflicts.
 559    *                              Does a force merge otherwise.
 560    * @param  boolean $autoFlip   wether to let api decide which contact to retain and which to delete.
 561    *
 562    *
 563    * @static
 564    * @access public
 565    */
 566   static function batchMerge($rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $redirectForPerformance = FALSE) {
 567     $contactType = CRM_Core_DAO::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
 568     $cacheKeyString = "merge {$contactType}";
 569     $cacheKeyString .= $rgid ? "_{$rgid}" : '_0';
 570     $cacheKeyString .= $gid ? "_{$gid}" : '_0';
 571     $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
 572                                                              pn.entity_id2 = de.contact_id2 )";
 573
 574     $limit = $redirectForPerformance ? 75 : 1;
 575     $where = "de.id IS NULL LIMIT {$limit}";
 576
 577     $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where);
 578     if (empty($dupePairs) && !$redirectForPerformance) {
 579       // If we haven't found any dupes, probably cache is empty.
 580       // Try filling cache and give another try.
 581       CRM_Core_BAO_PrevNextCache::refillCache($rgid, $gid, $cacheKeyString);
 582       $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $where);
 583     }
 584
 585     $cacheParams = array(
 586       'cache_key_string' => $cacheKeyString,
 587       'join' => $join,
 588       'where' => $where,
 589     );
 590     return CRM_Dedupe_Merger::merge($dupePairs, $cacheParams, $mode, $autoFlip, $redirectForPerformance);
 591   }
 592
 593   /**
 594    * Function to merge given set of contacts. Performs core operation.
 595    *
 596    * @param  array   $dupePairs   set of pair of contacts for whom merge is to be done.
 597    * @param  array   $cacheParams prev-next-cache params based on which next pair of contacts are computed.
 598    *                              Generally used with batch-merge.
 599    * @param  string  $mode       helps decide how to behave when there are conflicts.
 600    *                             A 'safe' value skips the merge if there are any un-resolved conflicts.
 601    *                             Does a force merge otherwise (aggressive mode).
 602    * @param  boolean $autoFlip   wether to let api decide which contact to retain and which to delete.
 603    *
 604    *
 605    * @static
 606    * @access public
 607    */
 608   static function merge($dupePairs = array(
 609     ), $cacheParams = array(), $mode = 'safe',
 610     $autoFlip = TRUE, $redirectForPerformance = FALSE
 611   ) {
 612     $cacheKeyString = CRM_Utils_Array::value('cache_key_string', $cacheParams);
 613     $resultStats = array('merged' => array(), 'skipped' => array());
 614
 615     // we don't want dupe caching to get reset after every-merge, and therefore set the
 616     // doNotResetCache flag
 617     $config = CRM_Core_Config::singleton();
 618     $config->doNotResetCache = 1;
 619
 620     while (!empty($dupePairs)) {
 621       foreach ($dupePairs as $dupes) {
 622         CRM_Utils_Hook::merge('flip', $dupes, $dupes['dstID'], $dupes['srcID']);
 623         $mainId = $dupes['dstID'];
 624         $otherId = $dupes['srcID'];
 625         $isAutoFlip = CRM_Utils_Array::value('auto_flip', $dupes, $autoFlip);
 626         // if we can, make sure that $mainId is the one with lower id number
 627         if ($isAutoFlip && ($mainId > $otherId)) {
 628           $mainId = $dupes['srcID'];
 629           $otherId = $dupes['dstID'];
 630         }
 631         if (!$mainId || !$otherId) {
 632           // return error
 633           return FALSE;
 634         }
 635
 636         // Generate var $migrationInfo. The variable structure is exactly same as
 637         // $formValues submitted during a UI merge for a pair of contacts.
 638         $rowsElementsAndInfo = &CRM_Dedupe_Merger::getRowsElementsAndInfo($mainId, $otherId);
 639
 640         $migrationInfo = &$rowsElementsAndInfo['migration_info'];
 641
 642         // add additional details that we might need to resolve conflicts
 643         $migrationInfo['main_details'] = &$rowsElementsAndInfo['main_details'];
 644         $migrationInfo['other_details'] = &$rowsElementsAndInfo['other_details'];
 645         $migrationInfo['main_loc_block'] = &$rowsElementsAndInfo['main_loc_block'];
 646         $migrationInfo['rows'] = &$rowsElementsAndInfo['rows'];
 647
 648         // go ahead with merge if there is no conflict
 649         if (!CRM_Dedupe_Merger::skipMerge($mainId, $otherId, $migrationInfo, $mode)) {
 650           CRM_Dedupe_Merger::moveAllBelongings($mainId, $otherId, $migrationInfo);
 651           $resultStats['merged'][] = array('main_d' => $mainId, 'other_id' => $otherId);
 652         }
 653         else {
 654           $resultStats['skipped'][] = array('main_d' => $mainId, 'other_id' => $otherId);
 655         }
 656
 657         // delete entry from PrevNextCache table so we don't consider the pair next time
 658         // pair may have been flipped, so make sure we delete using both orders
 659         CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString);
 660         CRM_Core_BAO_PrevNextCache::deletePair($otherId, $mainId, $cacheKeyString);
 661
 662         CRM_Core_DAO::freeResult();
 663         unset($rowsElementsAndInfo, $migrationInfo);
 664       }
 665
 666       if ($cacheKeyString && !$redirectForPerformance) {
 667         // retrieve next pair of dupes
 668         $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString,
 669           $cacheParams['join'],
 670           $cacheParams['where']
 671         );
 672       }
 673       else {
 674         // do not proceed. Terminate the loop
 675         unset($dupePairs);
 676       }
 677     }
 678     return $resultStats;
 679   }
 680
 681   /**
 682    * A function which uses various rules / algorithms for choosing which contact to bias to
 683    * when there's a conflict (to handle "gotchas"). Plus the safest route to merge.
 684    *
 685    * @param  int     $mainId         main contact with whom merge has to happen
 686    * @param  int     $otherId        duplicate contact which would be deleted after merge operation
 687    * @param  array   $migrationInfo  array of information about which elements to merge.
 688    * @param  string  $mode           helps decide how to behave when there are conflicts.
 689    *                                 A 'safe' value skips the merge if there are any un-resolved conflicts.
 690    *                                 Does a force merge otherwise (aggressive mode).
 691    *
 692    * @static
 693    * @access public
 694    */
 695   static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe') {
 696     $conflicts = array();
 697     $migrationData = array(
 698       'old_migration_info' => $migrationInfo,
 699       'mode' => $mode,
 700     );
 701     $allLocationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 702
 703     foreach ($migrationInfo as $key => $val) {
 704       if ($val === "null") {
 705         // Rule: no overwriting with empty values in any mode
 706         unset($migrationInfo[$key]);
 707         continue;
 708       }
 709       elseif ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) or
 710           substr($key, 0, 12) == 'move_custom_'
 711         ) and $val != NULL) {
 712         // Rule: if both main-contact has other-contact, let $mode decide if to merge a
 713         // particular field or not
 714         if (!empty($migrationInfo['rows'][$key]['main'])) {
 715           // if main also has a value its a conflict
 716           if ($mode == 'safe') {
 717             // note it down & lets wait for response from the hook.
 718             // For no response skip this merge
 719             $conflicts[$key] = NULL;
 720           }
 721           elseif ($mode == 'aggressive') {
 722             // let the main-field be overwritten
 723             continue;
 724           }
 725         }
 726       }
 727       elseif (substr($key, 0, 14) == 'move_location_' and $val != NULL) {
 728         $locField = explode('_', $key);
 729         $fieldName = $locField[2];
 730         $fieldCount = $locField[3];
 731
 732         // Rule: resolve address conflict if any -
 733         if ($fieldName == 'address') {
 734           $mainNewLocTypeId = $migrationInfo['location'][$fieldName][$fieldCount]['locTypeId'];
 735           if (!empty($migrationInfo['main_loc_address']) &&
 736               array_key_exists("main_{$mainNewLocTypeId}", $migrationInfo['main_loc_address'])) {
 737             // main loc already has some address for the loc-type. Its a overwrite situation.
 738
 739             // look for next available loc-type
 740             $newTypeId = NULL;
 741             foreach ($allLocationTypes as $typeId => $typeLabel) {
 742               if (!array_key_exists("main_{$typeId}", $migrationInfo['main_loc_address'])) {
 743                 $newTypeId = $typeId;
 744               }
 745             }
 746             if ($newTypeId) {
 747               // try insert address at new available loc-type
 748               $migrationInfo['location'][$fieldName][$fieldCount]['locTypeId'] = $newTypeId;
 749             }
 750             elseif ($mode == 'safe') {
 751               // note it down & lets wait for response from the hook.
 752               // For no response skip this merge
 753               $conflicts[$key] = NULL;
 754             }
 755             elseif ($mode == 'aggressive') {
 756               // let the loc-type-id be same as that of other-contact & go ahead
 757               // with merge assuming aggressive mode
 758               continue;
 759             }
 760           }
 761         }
 762         elseif ($migrationInfo['rows'][$key]['main'] == $migrationInfo['rows'][$key]['other']) {
 763           // for loc blocks other than address like email, phone .. if values are same no point in merging
 764           // and adding redundant value
 765           unset($migrationInfo[$key]);
 766         }
 767       }
 768     }
 769
 770     // A hook to implement other algorithms for choosing which contact to bias to when
 771     // there's a conflict (to handle "gotchas"). fields_in_conflict could be modified here
 772     // merge happens with new values filled in here. For a particular field / row not to be merged
 773     // field should be unset from fields_in_conflict.
 774     $migrationData['fields_in_conflict'] = $conflicts;
 775     CRM_Utils_Hook::merge('batch', $migrationData, $mainId, $otherId);
 776     $conflicts = $migrationData['fields_in_conflict'];
 777
 778     if (!empty($conflicts)) {
 779       foreach ($conflicts as $key => $val) {
 780         if ($val === NULL and $mode == 'safe') {
 781           // un-resolved conflicts still present. Lets skip this merge.
 782           return TRUE;
 783         }
 784         else {
 785           // copy over the resolved values
 786           $migrationInfo[$key] = $val;
 787         }
 788       }
 789     }
 790     return FALSE;
 791   }
 792
 793   /**
 794    * A function to build an array of information required by merge function and the merge UI.
 795    *
 796    * @param  int     $mainId         main contact with whom merge has to happen
 797    * @param  int     $otherId        duplicate contact which would be deleted after merge operation
 798    *
 799    * @static
 800    * @access public
 801    */
 802   static function getRowsElementsAndInfo($mainId, $otherId) {
 803     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
 804
 805     // Fetch contacts
 806     foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
 807       $params = array('contact_id' => $cid, 'version' => 3, 'return' => array_merge(array('display_name'), self::getContactFields()));
 808       $result = civicrm_api('contact', 'get', $params);
 809
 810       if (empty($result['values'][$cid]['contact_type'])) {
 811         return FALSE;
 812       }
 813       $$moniker = $result['values'][$cid];
 814     }
 815
 816     static $fields = array();
 817     if (empty($fields)) {
 818       $fields = CRM_Contact_DAO_Contact::fields();
 819       CRM_Core_DAO::freeResult();
 820     }
 821
 822     // FIXME: there must be a better way
 823     foreach (array('main', 'other') as $moniker) {
 824       $contact = &$$moniker;
 825       $preferred_communication_method = CRM_Utils_array::value('preferred_communication_method', $contact);
 826       $value = empty($preferred_communication_method) ? array() : $preferred_communication_method;
 827       $specialValues[$moniker] = array(
 828         'preferred_communication_method' => $value,
 829       );
 830
 831       if (!empty($contact['preferred_communication_method'])){
 832       // api 3 returns pref_comm_method as an array, which breaks the lookup; so we reconstruct
 833       $prefCommList = is_array($specialValues[$moniker]['preferred_communication_method']) ?
 834         implode(CRM_Core_DAO::VALUE_SEPARATOR, $specialValues[$moniker]['preferred_communication_method']) :
 835         $specialValues[$moniker]['preferred_communication_method'];
 836         $specialValues[$moniker]['preferred_communication_method'] = CRM_Core_DAO::VALUE_SEPARATOR . $prefCommList . CRM_Core_DAO::VALUE_SEPARATOR;
 837       }
 838       $names = array(
 839         'preferred_communication_method' =>
 840         array(
 841           'newName' => 'preferred_communication_method_display',
 842           'groupName' => 'preferred_communication_method',
 843         ),
 844       );
 845       CRM_Core_OptionGroup::lookupValues($specialValues[$moniker], $names);
 846     }
 847
 848     static $optionValueFields = array();
 849     if (empty($optionValueFields)) {
 850       $optionValueFields = CRM_Core_OptionValue::getFields();
 851     }
 852     foreach ($optionValueFields as $field => $params) {
 853       $fields[$field]['title'] = $params['title'];
 854     }
 855
 856     $diffs = self::findDifferences($main, $other);
 857
 858     $rows = $elements = $relTableElements = $migrationInfo = array();
 859
 860     foreach ($diffs['contact'] as $field) {
 861       foreach (array('main', 'other') as $moniker) {
 862         $contact = &$$moniker;
 863         $value = CRM_Utils_Array::value($field, $contact);
 864         if (isset($specialValues[$moniker][$field]) && is_string($specialValues[$moniker][$field])) {
 865           $value = CRM_Core_DAO::VALUE_SEPARATOR . trim($specialValues[$moniker][$field], CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR;
 866         }
 867         $label = isset($specialValues[$moniker]["{$field}_display"]) ? $specialValues[$moniker]["{$field}_display"] : $value;
 868         if (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_DATE) {
 869           if ($value) {
 870             $value = str_replace('-', '', $value);
 871             $label = CRM_Utils_Date::customFormat($label);
 872           }
 873           else {
 874             $value = "null";
 875           }
 876         }
 877         elseif (!empty($fields[$field]['type']) && $fields[$field]['type'] == CRM_Utils_Type::T_BOOLEAN) {
 878           if ($label === '0') {
 879             $label = ts('[ ]');
 880           }
 881           if ($label === '1') {
 882             $label = ts('[x]');
 883           }
 884         }
 885         elseif ($field == 'individual_prefix' || $field == 'prefix_id') {
 886           $label = CRM_Utils_Array::value('individual_prefix', $contact);
 887           $value = CRM_Utils_Array::value('prefix_id', $contact);
 888           $field = 'prefix_id';
 889         }
 890         elseif ($field == 'individual_suffix' || $field == 'suffix_id') {
 891           $label = CRM_Utils_Array::value('individual_suffix', $contact);
 892           $value = CRM_Utils_Array::value('suffix_id', $contact);
 893           $field = 'suffix_id';
 894         }
 895         $rows["move_$field"][$moniker] = $label;
 896         if ($moniker == 'other') {
 897           //CRM-14334
 898           if ($value === NULL || $value == '') {
 899             $value = 'null';
 900           }
 901           if ($value === 0 or $value === '0') {
 902             $value = $qfZeroBug;
 903           }
 904           if (is_array($value) && empty($value[1])) {
 905             $value[1] = NULL;
 906           }
 907           $elements[] = array('advcheckbox', "move_$field", NULL, NULL, NULL, $value);
 908           $migrationInfo["move_$field"] = $value;
 909         }
 910       }
 911       $rows["move_$field"]['title'] = $fields[$field]['title'];
 912     }
 913
 914     // handle location blocks.
 915     $locationBlocks = array('email', 'phone', 'address');
 916     $locations = array();
 917
 918     foreach ($locationBlocks as $block) {
 919       foreach (array('main' => $mainId, 'other' => $otherId) as $moniker => $cid) {
 920         $cnt = 1;
 921         $values = civicrm_api($block, 'get', array('contact_id' => $cid, 'version' => 3));
 922         $count = $values['count'];
 923         if ($count) {
 924           if ($count > $cnt) {
 925             foreach ($values['values'] as $value) {
 926               if ($block == 'address') {
 927                 CRM_Core_BAO_Address::fixAddress($value);
 928                 $display = CRM_Utils_Address::format($value);
 929                 $locations[$moniker][$block][$cnt] = $value;
 930                 $locations[$moniker][$block][$cnt]['display'] = $display;
 931               }
 932               else {
 933                 $locations[$moniker][$block][$cnt] = $value;
 934               }
 935
 936               $cnt++;
 937             }
 938           }
 939           else {
 940             $id = $values['id'];
 941             if ($block == 'address') {
 942               CRM_Core_BAO_Address::fixAddress($values['values'][$id]);
 943               $display = CRM_Utils_Address::format($values['values'][$id]);
 944               $locations[$moniker][$block][$cnt] = $values['values'][$id];
 945               $locations[$moniker][$block][$cnt]['display'] = $display;
 946             }
 947             else {
 948               $locations[$moniker][$block][$cnt] = $values['values'][$id];
 949             }
 950           }
 951         }
 952       }
 953     }
 954
 955     $allLocationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 956
 957     $mainLocBlock = $locBlockIds = array();
 958     $locBlockIds['main'] = $locBlockIds['other'] = array();
 959     foreach (array('Email', 'Phone', 'IM', 'OpenID', 'Address') as $block) {
 960       $name = strtolower($block);
 961       foreach (array('main', 'other') as $moniker) {
 962         $locIndex = CRM_Utils_Array::value($moniker, $locations);
 963         $blockValue = CRM_Utils_Array::value($name, $locIndex, array());
 964         if (empty($blockValue)) {
 965           $locValue[$moniker][$name] = 0;
 966           $locLabel[$moniker][$name] = $locTypes[$moniker][$name] = array();
 967         }
 968         else {
 969           $locValue[$moniker][$name] = TRUE;
 970           foreach ($blockValue as $count => $blkValues) {
 971             $fldName = $name;
 972             $locTypeId = $blkValues['location_type_id'];
 973             if ($name == 'im') {
 974               $fldName = 'name';
 975             }
 976             if ($name == 'address') {
 977               $fldName = 'display';
 978             }
 979             $locLabel[$moniker][$name][$count] = CRM_Utils_Array::value($fldName,
 980               $blkValues
 981             );
 982             $locTypes[$moniker][$name][$count] = $locTypeId;
 983             if ($moniker == 'main' && in_array($name, $locationBlocks)) {
 984               $mainLocBlock["main_$name$locTypeId"] = CRM_Utils_Array::value($fldName,
 985                 $blkValues
 986               );
 987               $locBlockIds['main'][$name][$locTypeId] = $blkValues['id'];
 988             }
 989             else {
 990               $locBlockIds[$moniker][$name][$count] = $blkValues['id'];
 991             }
 992           }
 993         }
 994       }
 995
 996       if ($locValue['other'][$name] != 0) {
 997         foreach ($locLabel['other'][$name] as $count => $value) {
 998           $locTypeId = $locTypes['other'][$name][$count];
 999           $rows["move_location_{$name}_$count"]['other'] = $value;
1000           $rows["move_location_{$name}_$count"]['main'] = CRM_Utils_Array::value($count,
1001             $locLabel['main'][$name]
1002           );
1003           $rows["move_location_{$name}_$count"]['title'] = ts('%1:%2:%3',
1004             array(
1005               1 => $block,
1006               2 => $count,
1007               3 => $allLocationTypes[$locTypeId]
1008             )
1009           );
1010
1011           $elements[] = array('advcheckbox', "move_location_{$name}_{$count}");
1012           $migrationInfo["move_location_{$name}_{$count}"] = 1;
1013
1014           // make sure default location type is always on top
1015           $mainLocTypeId = CRM_Utils_Array::value($count, $locTypes['main'][$name], $locTypeId);
1016           $locTypeValues = $allLocationTypes;
1017           $defaultLocType = array($mainLocTypeId => $locTypeValues[$mainLocTypeId]);
1018           unset($locTypeValues[$mainLocTypeId]);
1019
1020           // keep 1-1 mapping for address - location type.
1021           $js = NULL;
1022           if (in_array($name, $locationBlocks) && !empty($mainLocBlock)) {
1023             $js = array('onChange' => "mergeBlock('$name', this, $count );");
1024           }
1025           $elements[] = array(
1026             'select', "location[{$name}][$count][locTypeId]", NULL,
1027             $defaultLocType + $locTypeValues, $js,
1028           );
1029           // keep location-type-id same as that of other-contact
1030           $migrationInfo['location'][$name][$count]['locTypeId'] = $locTypeId;
1031
1032           if ($name != 'address') {
1033             $elements[] = array('advcheckbox', "location[{$name}][$count][operation]", NULL, ts('add new'));
1034             // always use add operation
1035             $migrationInfo['location'][$name][$count]['operation'] = 1;
1036           }
1037         }
1038       }
1039     }
1040
1041     // add the related tables and unset the ones that don't sport any of the duplicate contact's info
1042     $config = CRM_Core_Config::singleton();
1043     $mainUfId = CRM_Core_BAO_UFMatch::getUFId($mainId);
1044     $mainUser = NULL;
1045     if ($mainUfId) {
1046       // d6 compatible
1047       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1048         $mainUser = user_load($mainUfId);
1049       }
1050       elseif ($config->userFramework == 'Joomla') {
1051         $mainUser = JFactory::getUser($mainUfId);
1052       }
1053     }
1054     $otherUfId = CRM_Core_BAO_UFMatch::getUFId($otherId);
1055     $otherUser = NULL;
1056     if ($otherUfId) {
1057       // d6 compatible
1058       if ($config->userSystem->is_drupal == '1' && function_exists($mainUser)) {
1059         $otherUser = user_load($otherUfId);
1060       }
1061       elseif ($config->userFramework == 'Joomla') {
1062         $otherUser = JFactory::getUser($otherUfId);
1063       }
1064     }
1065
1066     $relTables = CRM_Dedupe_Merger::relTables();
1067     $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($otherId);
1068     $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($mainId);
1069     foreach ($relTables as $name => $null) {
1070       if (!in_array($name, $activeRelTables) &&
1071         !(($name == 'rel_table_users') && in_array($name, $activeMainRelTables))
1072       ) {
1073         unset($relTables[$name]);
1074         continue;
1075       }
1076
1077       $relTableElements[] = array('checkbox', "move_$name");
1078       $migrationInfo["move_$name"] = 1;
1079
1080       $relTables[$name]['main_url'] = str_replace('$cid', $mainId, $relTables[$name]['url']);
1081       $relTables[$name]['other_url'] = str_replace('$cid', $otherId, $relTables[$name]['url']);
1082       if ($name == 'rel_table_users') {
1083         $relTables[$name]['main_url'] = str_replace('%ufid', $mainUfId, $relTables[$name]['url']);
1084         $relTables[$name]['other_url'] = str_replace('%ufid', $otherUfId, $relTables[$name]['url']);
1085         $find = array('$ufid', '$ufname');
1086         if ($mainUser) {
1087           $replace = array($mainUfId, $mainUser->name);
1088           $relTables[$name]['main_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1089         }
1090         if ($otherUser) {
1091           $replace = array($otherUfId, $otherUser->name);
1092           $relTables[$name]['other_title'] = str_replace($find, $replace, $relTables[$name]['title']);
1093         }
1094       }
1095       if ($name == 'rel_table_memberships') {
1096         $elements[] = array('checkbox', "operation[move_{$name}][add]", NULL, ts('add new'));
1097         $migrationInfo["operation"]["move_{$name}"]['add'] = 1;
1098       }
1099     }
1100     foreach ($relTables as $name => $null) {
1101       $relTables["move_$name"] = $relTables[$name];
1102       unset($relTables[$name]);
1103     }
1104
1105     // handle custom fields
1106     $mainTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $mainId, -1,
1107       CRM_Utils_Array::value('contact_sub_type', $main)
1108     );
1109     $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], CRM_Core_DAO::$_nullObject, $otherId, -1,
1110       CRM_Utils_Array::value('contact_sub_type', $other)
1111     );
1112     CRM_Core_DAO::freeResult();
1113
1114     foreach ($otherTree as $gid => $group) {
1115       $foundField = FALSE;
1116       if (!isset($group['fields'])) {
1117         continue;
1118       }
1119
1120       foreach ($group['fields'] as $fid => $field) {
1121         if (in_array($fid, $diffs['custom'])) {
1122           if (!$foundField) {
1123             $rows["custom_group_$gid"]['title'] = $group['title'];
1124             $foundField = TRUE;
1125           }
1126           if (!empty($mainTree[$gid]['fields'][$fid]['customValue'])) {
1127             foreach ($mainTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1128               $rows["move_custom_$fid"]['main'] = CRM_Core_BAO_CustomGroup::formatCustomValues($values,
1129                 $field, TRUE
1130               );
1131             }
1132           }
1133           $value = "null";
1134           if (!empty($otherTree[$gid]['fields'][$fid]['customValue'])) {
1135             foreach ($otherTree[$gid]['fields'][$fid]['customValue'] as $valueId => $values) {
1136               $rows["move_custom_$fid"]['other'] = CRM_Core_BAO_CustomGroup::formatCustomValues($values,
1137                 $field, TRUE
1138               );
1139               if ($values['data'] === 0 || $values['data'] === '0') {
1140                 $values['data'] = $qfZeroBug;
1141             }
1142               $value = ($values['data']) ? $values['data'] : $value;
1143           }
1144           }
1145           $rows["move_custom_$fid"]['title'] = $field['label'];
1146
1147           $elements[] = array('advcheckbox', "move_custom_$fid", NULL, NULL, NULL, $value);
1148           $migrationInfo["move_custom_$fid"] = $value;
1149         }
1150       }
1151     }
1152     $result = array(
1153       'rows' => $rows,
1154       'elements' => $elements,
1155       'rel_table_elements' => $relTableElements,
1156       'main_loc_block' => $mainLocBlock,
1157       'rel_tables' => $relTables,
1158       'main_details' => $main,
1159       'other_details' => $other,
1160       'migration_info' => $migrationInfo,
1161     );
1162
1163     $result['main_details']['loc_block_ids'] = $locBlockIds['main'];
1164     $result['other_details']['loc_block_ids'] = $locBlockIds['other'];
1165
1166     return $result;
1167   }
1168
1169   /**
1170    * Based on the provided two contact_ids and a set of tables, move the belongings of the
1171    * other contact to the main one - be it Location / CustomFields or Contact .. related info.
1172    * A superset of moveContactBelongings() function.
1173    *
1174    * @param  int     $mainId         main contact with whom merge has to happen
1175    * @param  int     $otherId        duplicate contact which would be deleted after merge operation
1176    *
1177    * @static
1178    * @access public
1179    */
1180   static function moveAllBelongings($mainId, $otherId, $migrationInfo) {
1181     if (empty($migrationInfo)) {
1182       return FALSE;
1183     }
1184
1185     $qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
1186     $relTables = CRM_Dedupe_Merger::relTables();
1187     $moveTables = $locBlocks = $tableOperations = array();
1188     foreach ($migrationInfo as $key => $value) {
1189       if ($value == $qfZeroBug) {
1190         $value = '0';
1191       }
1192       if ((in_array(substr($key, 5), CRM_Dedupe_Merger::getContactFields()) ||
1193         substr($key, 0, 12) == 'move_custom_') &&
1194         $value != NULL
1195       ) {
1196         $submitted[substr($key, 5)] = $value;
1197       }
1198       elseif (substr($key, 0, 14) == 'move_location_' and $value != NULL) {
1199         $locField = explode('_', $key);
1200         $fieldName = $locField[2];
1201         $fieldCount = $locField[3];
1202         $operation = CRM_Utils_Array::value('operation', $migrationInfo['location'][$fieldName][$fieldCount]);
1203         // default operation is overwrite.
1204         if (!$operation) {
1205           $operation = 2;
1206         }
1207
1208         $locBlocks[$fieldName][$fieldCount]['operation'] = $operation;
1209         $locBlocks[$fieldName][$fieldCount]['locTypeId'] = CRM_Utils_Array::value('locTypeId', $migrationInfo['location'][$fieldName][$fieldCount]);
1210       }
1211       elseif (substr($key, 0, 15) == 'move_rel_table_' and $value == '1') {
1212         $moveTables = array_merge($moveTables, $relTables[substr($key, 5)]['tables']);
1213         if (array_key_exists('operation', $migrationInfo)) {
1214           foreach ($relTables[substr($key, 5)]['tables'] as $table) {
1215             if (array_key_exists($key, $migrationInfo['operation'])) {
1216               $tableOperations[$table] = $migrationInfo['operation'][$key];
1217             }
1218           }
1219         }
1220       }
1221     }
1222
1223
1224     // **** Do location related migration:
1225     if (!empty($locBlocks)) {
1226       $locComponent = array(
1227         'email' => 'Email',
1228         'phone' => 'Phone',
1229         'im' => 'IM',
1230         'openid' => 'OpenID',
1231         'address' => 'Address',
1232       );
1233
1234       $primaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_primary' => 1));
1235       $billingBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($mainId, array('is_billing' => 1));
1236
1237       foreach ($locBlocks as $name => $block) {
1238         if (!is_array($block) || CRM_Utils_System::isNull($block)) {
1239           continue;
1240         }
1241         $daoName = 'CRM_Core_DAO_' . $locComponent[$name];
1242         $primaryDAOId = (array_key_exists($name, $primaryBlockIds)) ? array_pop($primaryBlockIds[$name]) : NULL;
1243         $billingDAOId = (array_key_exists($name, $billingBlockIds)) ? array_pop($billingBlockIds[$name]) : NULL;
1244
1245         foreach ($block as $blkCount => $values) {
1246           $locTypeId = CRM_Utils_Array::value('locTypeId', $values, 1);
1247           $operation = CRM_Utils_Array::value('operation', $values, 2);
1248           $otherBlockId = CRM_Utils_Array::value($blkCount,
1249             $migrationInfo['other_details']['loc_block_ids'][$name]
1250           );
1251
1252           // keep 1-1 mapping for address - loc type.
1253           $idKey = $blkCount;
1254           if (array_key_exists($name, $locComponent)) {
1255             $idKey = $locTypeId;
1256           }
1257
1258           if (isset($migrationInfo['main_details']['loc_block_ids'][$name])) {
1259           $mainBlockId = CRM_Utils_Array::value($idKey, $migrationInfo['main_details']['loc_block_ids'][$name]);
1260           }
1261
1262           if (!$otherBlockId) {
1263             continue;
1264           }
1265
1266           // for the block which belongs to other-contact, link the contact to main-contact
1267           $otherBlockDAO = new $daoName();
1268           $otherBlockDAO->id = $otherBlockId;
1269           $otherBlockDAO->contact_id = $mainId;
1270           $otherBlockDAO->location_type_id = $locTypeId;
1271
1272           // if main contact already has primary & billing, set the flags to 0.
1273           if ($primaryDAOId) {
1274             $otherBlockDAO->is_primary = 0;
1275           }
1276           if ($billingDAOId) {
1277             $otherBlockDAO->is_billing = 0;
1278           }
1279
1280           // overwrite - need to delete block which belongs to main-contact.
1281           if ($mainBlockId && ($operation == 2)) {
1282             $deleteDAO = new $daoName();
1283             $deleteDAO->id = $mainBlockId;
1284             $deleteDAO->find(TRUE);
1285
1286             // if we about to delete a primary / billing block, set the flags for new block
1287             // that we going to assign to main-contact
1288             if ($primaryDAOId && ($primaryDAOId == $deleteDAO->id)) {
1289               $otherBlockDAO->is_primary = 1;
1290             }
1291             if ($billingDAOId && ($billingDAOId == $deleteDAO->id)) {
1292               $otherBlockDAO->is_billing = 1;
1293             }
1294
1295             $deleteDAO->delete();
1296             $deleteDAO->free();
1297           }
1298
1299           $otherBlockDAO->update();
1300           $otherBlockDAO->free();
1301         }
1302       }
1303     }
1304
1305     // **** Do tables related migrations
1306     if (!empty($moveTables)) {
1307       CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId, $moveTables, $tableOperations);
1308       unset($moveTables, $tableOperations);
1309     }
1310
1311     // **** Do contact related migrations
1312     CRM_Dedupe_Merger::moveContactBelongings($mainId, $otherId);
1313
1314     // FIXME: fix gender, prefix and postfix, so they're edible by createProfileContact()
1315     $names['gender'] = array('newName' => 'gender_id', 'groupName' => 'gender');
1316     $names['individual_prefix'] = array('newName' => 'prefix_id', 'groupName' => 'individual_prefix');
1317     $names['individual_suffix'] = array('newName' => 'suffix_id', 'groupName' => 'individual_suffix');
1318     $names['communication_style'] = array('newName' => 'communication_style_id', 'groupName' => 'communication_style');
1319     $names['addressee'] = array('newName' => 'addressee_id', 'groupName' => 'addressee');
1320     $names['email_greeting'] = array('newName' => 'email_greeting_id', 'groupName' => 'email_greeting');
1321     $names['postal_greeting'] = array('newName' => 'postal_greeting_id', 'groupName' => 'postal_greeting');
1322     CRM_Core_OptionGroup::lookupValues($submitted, $names, TRUE);
1323
1324     // fix custom fields so they're edible by createProfileContact()
1325     static $treeCache = array();
1326     if (!array_key_exists($migrationInfo['main_details']['contact_type'], $treeCache)) {
1327       $treeCache[$migrationInfo['main_details']['contact_type']] = CRM_Core_BAO_CustomGroup::getTree($migrationInfo['main_details']['contact_type'],
1328         CRM_Core_DAO::$_nullObject, NULL, -1
1329       );
1330     }
1331     $cgTree = &$treeCache[$migrationInfo['main_details']['contact_type']];
1332
1333     $cFields = array();
1334     foreach ($cgTree as $key => $group) {
1335       if (!isset($group['fields'])) {
1336         continue;
1337       }
1338       foreach ($group['fields'] as $fid => $field) {
1339         $cFields[$fid]['attributes'] = $field;
1340       }
1341     }
1342
1343     if (!isset($submitted)) {
1344       $submitted = array();
1345     }
1346     foreach ($submitted as $key => $value) {
1347       if (substr($key, 0, 7) == 'custom_') {
1348         $fid = (int) substr($key, 7);
1349         $htmlType = $cFields[$fid]['attributes']['html_type'];
1350         switch ($htmlType) {
1351           case 'File':
1352             $customFiles[] = $fid;
1353             unset($submitted["custom_$fid"]);
1354             break;
1355
1356           case 'Select Country':
1357           case 'Select State/Province':
1358             $submitted[$key] = CRM_Core_BAO_CustomField::getDisplayValue($value, $fid, $cFields);
1359             break;
1360
1361           case 'CheckBox':
1362           case 'AdvMulti-Select':
1363           case 'Multi-Select':
1364           case 'Multi-Select Country':
1365           case 'Multi-Select State/Province':
1366             // Merge values from both contacts for multivalue fields, CRM-4385
1367             // get the existing custom values from db.
1368             $customParams = array('entityID' => $mainId, $key => TRUE);
1369             $customfieldValues = CRM_Core_BAO_CustomValueTable::getValues($customParams);
1370             if (!empty($customfieldValues[$key])) {
1371               $existingValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $customfieldValues[$key]);
1372               if (is_array($existingValue) && !empty($existingValue)) {
1373                 $mergeValue = $submmtedCustomValue = array();
1374                 if ($value) {
1375                   $submmtedCustomValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1376                 }
1377
1378                 //hack to remove null and duplicate values from array.
1379                 foreach (array_merge($submmtedCustomValue, $existingValue) as $k => $v) {
1380                   if ($v != '' && !in_array($v, $mergeValue)) {
1381                     $mergeValue[] = $v;
1382                   }
1383                 }
1384
1385                 //keep state and country as array format.
1386                 //for checkbox and m-select format w/ VALUE_SEPARATOR
1387                 if (in_array($htmlType, array(
1388                   'CheckBox', 'Multi-Select', 'AdvMulti-Select'))) {
1389                   $submitted[$key] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1390                     $mergeValue
1391                   ) . CRM_Core_DAO::VALUE_SEPARATOR;
1392                 }
1393                 else {
1394                   $submitted[$key] = $mergeValue;
1395                 }
1396               }
1397             }
1398             elseif (in_array($htmlType, array(
1399               'Multi-Select Country', 'Multi-Select State/Province'))) {
1400               //we require submitted values should be in array format
1401               if ($value) {
1402                 $mergeValueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1403                 //hack to remove null values from array.
1404                 $mergeValue = array();
1405                 foreach ($mergeValueArray as $k => $v) {
1406                   if ($v != '') {
1407                     $mergeValue[] = $v;
1408                   }
1409                 }
1410                 $submitted[$key] = $mergeValue;
1411               }
1412             }
1413             break;
1414
1415           default:
1416             break;
1417         }
1418       }
1419     }
1420
1421     // **** Do file custom fields related migrations
1422     // FIXME: move this someplace else (one of the BAOs) after discussing
1423     // where to, and whether CRM_Core_BAO_File::deleteFileReferences() shouldn't actually,
1424     // like, delete a file...
1425
1426     if (!isset($customFiles)) {
1427       $customFiles = array();
1428     }
1429     foreach ($customFiles as $customId) {
1430       list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($customId);
1431
1432       // get the contact_id -> file_id mapping
1433       $fileIds = array();
1434       $sql = "SELECT entity_id, {$columnName} AS file_id FROM {$tableName} WHERE entity_id IN ({$mainId}, {$otherId})";
1435       $dao = CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray);
1436       while ($dao->fetch()) {
1437         $fileIds[$dao->entity_id] = $dao->file_id;
1438       }
1439       $dao->free();
1440
1441       // delete the main contact's file
1442       if (!empty($fileIds[$mainId])) {
1443         CRM_Core_BAO_File::deleteFileReferences($fileIds[$mainId], $mainId, $customId);
1444       }
1445
1446       // move the other contact's file to main contact
1447       //NYSS need to INSERT or UPDATE depending on whether main contact has an existing record
1448       if ( CRM_Core_DAO::singleValueQuery("SELECT id FROM {$tableName} WHERE entity_id = {$mainId}") ) {
1449       $sql = "UPDATE {$tableName} SET {$columnName} = {$fileIds[$otherId]} WHERE entity_id = {$mainId}";
1450       }
1451       else {
1452         $sql = "INSERT INTO {$tableName} ( entity_id, {$columnName} ) VALUES ( {$mainId}, {$fileIds[$otherId]} )";
1453       }
1454       CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray);
1455
1456       if ( CRM_Core_DAO::singleValueQuery("
1457         SELECT id
1458         FROM civicrm_entity_file
1459         WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}") ) {
1460         $sql = "
1461           UPDATE civicrm_entity_file
1462           SET entity_id = {$mainId}
1463           WHERE entity_table = '{$tableName}' AND file_id = {$fileIds[$otherId]}";
1464       }
1465       else {
1466         $sql = "
1467           INSERT INTO civicrm_entity_file ( entity_table, entity_id, file_id )
1468           VALUES ( '{$tableName}', {$mainId}, {$fileIds[$otherId]} )";
1469       }
1470       CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray);
1471     }
1472
1473     // move view only custom fields CRM-5362
1474     $viewOnlyCustomFields = array();
1475     foreach ($submitted as $key => $value) {
1476       $fid = (int) substr($key, 7);
1477       if (array_key_exists($fid, $cFields) && !empty($cFields[$fid]['attributes']['is_view'])) {
1478         $viewOnlyCustomFields[$key] = $value;
1479       }
1480     }
1481
1482     // special case to set values for view only, CRM-5362
1483     if (!empty($viewOnlyCustomFields)) {
1484       $viewOnlyCustomFields['entityID'] = $mainId;
1485       CRM_Core_BAO_CustomValueTable::setValues($viewOnlyCustomFields);
1486     }
1487
1488     // **** Delete other contact & update prev-next caching
1489     $otherParams = array(
1490       'contact_id' => $otherId,
1491       'id' => $otherId,
1492       'version' => 3,
1493     );
1494     if (CRM_Core_Permission::check('merge duplicate contacts') &&
1495       CRM_Core_Permission::check('delete contacts')
1496     ) {
1497       // if ext id is submitted then set it null for contact to be deleted
1498       if (!empty($submitted['external_identifier'])) {
1499         $query = "UPDATE civicrm_contact SET external_identifier = null WHERE id = {$otherId}";
1500         CRM_Core_DAO::executeQuery($query);
1501       }
1502
1503       civicrm_api('contact', 'delete', $otherParams);
1504       CRM_Core_BAO_PrevNextCache::deleteItem($otherId);
1505     }
1506     // FIXME: else part
1507     /*         else { */
1508
1509     /*             CRM_Core_Session::setStatus( ts('Do not have sufficient permission to delete duplicate contact.') ); */
1510
1511     /*         } */
1512
1513
1514     // **** Update contact related info for the main contact
1515     if (!empty($submitted)) {
1516       $submitted['contact_id'] = $mainId;
1517
1518       //update current employer field
1519       if ($currentEmloyerId = CRM_Utils_Array::value('current_employer_id', $submitted)) {
1520         if (!CRM_Utils_System::isNull($currentEmloyerId)) {
1521           $submitted['current_employer'] = $submitted['current_employer_id'];
1522         } else {
1523           $submitted['current_employer'] = '';
1524         }
1525         unset($submitted['current_employer_id']);
1526       }
1527
1528       //CRM-14312 include prefix/suffix from mainId if not overridden for proper construction of display/sort name
1529       if ( !isset($submitted['prefix_id']) && !empty($migrationInfo['main_details']['prefix_id']) ) {
1530         $submitted['prefix_id'] = $migrationInfo['main_details']['prefix_id'];
1531       }
1532       if ( !isset($submitted['suffix_id']) && !empty($migrationInfo['main_details']['suffix_id']) ) {
1533         $submitted['suffix_id'] = $migrationInfo['main_details']['suffix_id'];
1534       }
1535
1536       CRM_Contact_BAO_Contact::createProfileContact($submitted, CRM_Core_DAO::$_nullArray, $mainId);
1537       unset($submitted);
1538     }
1539
1540     return TRUE;
1541   }
1542
1543   /**
1544    * @return array of field names which will be compared, so everything except ID.
1545    */
1546   static function getContactFields() {
1547     $contactFields = CRM_Contact_DAO_Contact::fields();
1548     $invalidFields = array('api_key', 'contact_is_deleted', 'created_date', 'display_name', 'hash', 'id', 'modified_date',
1549       'primary_contact_id', 'sort_name', 'user_unique_id');
1550     foreach ($contactFields as $field => $value) {
1551       if (in_array($field, $invalidFields)) {
1552         unset($contactFields[$field]);
1553       }
1554     }
1555     return array_keys($contactFields);
1556   }
1557
1558   /**
1559    * Added for CRM-12695
1560    * Based on the contactId provided
1561    * add/update membership(s) to related contacts
1562    *
1563    * @param contactId
1564    */
1565   static function addMembershipToRealtedContacts($contactID) {
1566     $dao = new CRM_Member_DAO_Membership();
1567     $dao->contact_id = $contactID;
1568     $dao->is_test = 0;
1569     $dao->find();
1570
1571     //checks membership of contact itself
1572     while ($dao->fetch()) {
1573       $relationshipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $dao->membership_type_id, 'relationship_type_id', 'id');
1574       if ($relationshipTypeId) {
1575         $membershipParams = array(
1576           'id' => $dao->id,
1577           'contact_id' => $dao->contact_id,
1578           'membership_type_id' => $dao->membership_type_id,
1579           'join_date' => CRM_Utils_Date::isoToMysql($dao->join_date),
1580           'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date),
1581           'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date),
1582           'source' => $dao->source,
1583           'status_id' => $dao->status_id
1584         );
1585         // create/update membership(s) for related contact(s)
1586         CRM_Member_BAO_Membership::createRelatedMemberships($membershipParams, $dao);
1587       } // end of if relationshipTypeId
1588     }
1589   }
1590 }
1591