CRM/Contact/Form/Merge.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
  36 require_once 'api/api.php';
  37
  38 /**
  39  * Class CRM_Contact_Form_Merge
  40  */
  41 class CRM_Contact_Form_Merge extends CRM_Core_Form {
  42   // the id of the contact that tere's a duplicate for; this one will
  43   // possibly inherit some of $_oid's properties and remain in the system
  44   var $_cid = NULL;
  45
  46   // the id of the other contact - the duplicate one that will get deleted
  47   var $_oid = NULL;
  48
  49   var $_contactType = NULL;
  50
  51   // variable to keep all location block ids.
  52   protected $_locBlockIds = array();
  53
  54   // FIXME: QuickForm can't create advcheckboxes with value set to 0 or '0' :(
  55   // see HTML_QuickForm_advcheckbox::setValues() - but patching that doesn't
  56   // help, as QF doesn't put the 0-value elements in exportValues() anyway...
  57   // to side-step this, we use the below UUID as a (re)placeholder
  58   var $_qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
  59
  60   function preProcess() {
  61     if (!CRM_Core_Permission::check('merge duplicate contacts')) {
  62       CRM_Core_Error::fatal(ts('You do not have access to this page'));
  63     }
  64
  65     $rows = array();
  66     $cid  = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  67     $oid  = CRM_Utils_Request::retrieve('oid', 'Positive', $this, TRUE);
  68     $flip = CRM_Utils_Request::retrieve('flip', 'Positive', $this, FALSE);
  69
  70     $this->_rgid    = $rgid = CRM_Utils_Request::retrieve('rgid', 'Positive', $this, FALSE);
  71     $this->_gid     = $gid = CRM_Utils_Request::retrieve('gid', 'Positive', $this, FALSE);
  72     $this->_mergeId = CRM_Utils_Request::retrieve('mergeId', 'Positive', $this, FALSE);
  73
  74     // Sanity check
  75     if ($cid == $oid) {
  76       CRM_Core_Error::statusBounce(ts('Cannot merge a contact with itself.'));
  77     }
  78
  79     if (!CRM_Dedupe_BAO_Rule::validateContacts($cid, $oid)) {
  80       CRM_Core_Error::statusBounce(ts('The selected pair of contacts are marked as non duplicates. If these records should be merged, you can remove this exception on the <a href=\'%1\'>Dedupe Exceptions</a> page.', array(1 => CRM_Utils_System::url('civicrm/dedupe/exception', 'reset=1'))));
  81     }
  82
  83     //load cache mechanism
  84     $contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'contact_type');
  85     $cacheKey = "merge $contactType";
  86     $cacheKey .= $rgid ? "_{$rgid}" : '_0';
  87     $cacheKey .= $gid ? "_{$gid}" : '_0';
  88
  89     $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
  90                                                              pn.entity_id2 = de.contact_id2 )";
  91     $where = "de.id IS NULL";
  92
  93     $pos = CRM_Core_BAO_PrevNextCache::getPositions($cacheKey, $cid, $oid, $this->_mergeId, $join, $where, $flip);
  94
  95     // Block access if user does not have EDIT permissions for both contacts.
  96     if (!(CRM_Contact_BAO_Contact_Permission::allow($cid, CRM_Core_Permission::EDIT) &&
  97         CRM_Contact_BAO_Contact_Permission::allow($oid, CRM_Core_Permission::EDIT)
  98       )) {
  99       CRM_Utils_System::permissionDenied();
 100     }
 101
 102     // get user info of main contact.
 103     $config = CRM_Core_Config::singleton();
 104     $config->doNotResetCache = 1;
 105
 106     $viewUser = CRM_Core_Permission::check('access user profiles');
 107     $mainUfId = CRM_Core_BAO_UFMatch::getUFId($cid);
 108     $mainUser = NULL;
 109     if ($mainUfId) {
 110       // d6 compatible
 111       if ($config->userSystem->is_drupal == '1') {
 112         $mainUser = user_load($mainUfId);
 113       }
 114       elseif ($config->userFramework == 'Joomla') {
 115         $mainUser = JFactory::getUser($mainUfId);
 116       }
 117
 118       $this->assign('mainUfId', $mainUfId);
 119       $this->assign('mainUfName', $mainUser ? $mainUser->name : NULL);
 120     }
 121
 122     $flipUrl = CRM_Utils_System::url('civicrm/contact/merge',
 123       "reset=1&action=update&cid={$oid}&oid={$cid}&rgid={$rgid}&gid={$gid}"
 124     );
 125     if (!$flip) {
 126       $flipUrl .= '&flip=1';
 127     }
 128     $this->assign('flip', $flipUrl);
 129
 130     $this->prev = $this->next = NULL;
 131     foreach (array(
 132       'prev', 'next') as $position) {
 133       if (!empty($pos[$position])) {
 134         if ($pos[$position]['id1'] && $pos[$position]['id2']) {
 135           $urlParam = "reset=1&cid={$pos[$position]['id1']}&oid={$pos[$position]['id2']}&mergeId={$pos[$position]['mergeId']}&action=update";
 136
 137           if ($rgid) {
 138             $urlParam .= "&rgid={$rgid}";
 139           }
 140           if ($gid) {
 141             $urlParam .= "&gid={$gid}";
 142           }
 143
 144           $this->$position = CRM_Utils_System::url('civicrm/contact/merge', $urlParam);
 145           $this->assign($position, $this->$position);
 146         }
 147       }
 148     }
 149
 150     // get user info of other contact.
 151     $otherUfId = CRM_Core_BAO_UFMatch::getUFId($oid);
 152     $otherUser = NULL;
 153
 154     if ($otherUfId) {
 155       // d6 compatible
 156       if ($config->userSystem->is_drupal == '1') {
 157         $otherUser = user_load($otherUfId);
 158       }
 159       elseif ($config->userFramework == 'Joomla') {
 160         $otherUser = JFactory::getUser($otherUfId);
 161       }
 162
 163       $this->assign('otherUfId', $otherUfId);
 164       $this->assign('otherUfName', $otherUser ? $otherUser->name : NULL);
 165     }
 166
 167     $cmsUser = ($mainUfId && $otherUfId) ? TRUE : FALSE;
 168     $this->assign('user', $cmsUser);
 169
 170     $session = CRM_Core_Session::singleton();
 171
 172     // context fixed.
 173     if ($rgid) {
 174       $urlParam = "reset=1&action=browse&rgid={$rgid}";
 175       if ($gid) {
 176         $urlParam .= "&gid={$gid}";
 177       }
 178       $session->pushUserContext(CRM_Utils_System::url('civicrm/contact/dedupefind', $urlParam));
 179     }
 180
 181     // ensure that oid is not the current user, if so refuse to do the merge
 182     if ($session->get('userID') == $oid) {
 183       $display_name = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $oid, 'display_name');
 184       $message = ts('The contact record which is linked to the currently logged in user account - \'%1\' - cannot be deleted.',
 185         array(1 => $display_name)
 186       );
 187       CRM_Core_Error::statusBounce($message);
 188     }
 189
 190     $rowsElementsAndInfo = CRM_Dedupe_Merger::getRowsElementsAndInfo($cid, $oid);
 191     $main = $this->_mainDetails = &$rowsElementsAndInfo['main_details'];
 192     $other = $this->_otherDetails = &$rowsElementsAndInfo['other_details'];
 193
 194     if ($main['contact_id'] != $cid) {
 195       CRM_Core_Error::fatal(ts('The main contact record does not exist'));
 196     }
 197
 198     if ($other['contact_id'] != $oid) {
 199       CRM_Core_Error::fatal(ts('The other contact record does not exist'));
 200     }
 201
 202     $this->assign('contact_type', $main['contact_type']);
 203     $this->assign('main_name', $main['display_name']);
 204     $this->assign('other_name', $other['display_name']);
 205     $this->assign('main_cid', $main['contact_id']);
 206     $this->assign('other_cid', $other['contact_id']);
 207     $this->assign('rgid', $rgid);
 208
 209     $this->_cid         = $cid;
 210     $this->_oid         = $oid;
 211     $this->_rgid        = $rgid;
 212     $this->_contactType = $main['contact_type'];
 213     $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
 214
 215     $this->assign('mainLocBlock', json_encode($rowsElementsAndInfo['main_loc_block']));
 216     $this->assign('rows', $rowsElementsAndInfo['rows']);
 217
 218     $this->_locBlockIds = array(
 219       'main' => $rowsElementsAndInfo['main_details']['loc_block_ids'],
 220       'other' => $rowsElementsAndInfo['other_details']['loc_block_ids']
 221     );
 222
 223     // add elements
 224     foreach ($rowsElementsAndInfo['elements'] as $element) {
 225       $this->addElement($element[0],
 226         $element[1],
 227         array_key_exists('2', $element) ? $element[2] : NULL,
 228         array_key_exists('3', $element) ? $element[3] : NULL,
 229         array_key_exists('4', $element) ? $element[4] : NULL,
 230         array_key_exists('5', $element) ? $element[5] : NULL
 231       );
 232     }
 233
 234     // add related table elements
 235     foreach ($rowsElementsAndInfo['rel_table_elements'] as $relTableElement) {
 236       $element = $this->addElement($relTableElement[0], $relTableElement[1]);
 237       $element->setChecked(TRUE);
 238     }
 239
 240     $this->assign('rel_tables', $rowsElementsAndInfo['rel_tables']);
 241     $this->assign('userContextURL', $session->readUserContext());
 242   }
 243
 244   /**
 245    * This virtual function is used to set the default values of
 246    * various form elements
 247    *
 248    * access        public
 249    *
 250    * @return array reference to the array of default values
 251    *
 252    */
 253   /**
 254    * @return array
 255    */
 256   function setDefaultValues() {
 257     return array('deleteOther' => 1);
 258   }
 259
 260   function addRules() {}
 261
 262   public function buildQuickForm() {
 263     CRM_Utils_System::setTitle(ts('Merge %1s', array(1 => $this->_contactType)));
 264     $name = ts('Merge');
 265     if ($this->next) {
 266       $name = ts('Merge and Goto Next Pair');
 267     }
 268
 269     if ($this->next || $this->prev) {
 270       $button = array(
 271         array(
 272           'type' => 'next',
 273           'name' => $name,
 274           'isDefault' => TRUE,
 275         ),
 276         array(
 277           'type' => 'submit',
 278           'name' => ts('Merge and Goto Listing'),
 279         ),
 280         array(
 281           'type' => 'done',
 282           'name' => ts('Merge and View Result'),
 283         ),
 284         array(
 285           'type' => 'cancel',
 286           'name' => ts('Cancel'),
 287         ),
 288       );
 289     }
 290     else {
 291       $button = array(
 292         array(
 293           'type' => 'next',
 294           'name' => $name,
 295           'isDefault' => TRUE,
 296         ),
 297         array(
 298           'type' => 'cancel',
 299           'name' => ts('Cancel'),
 300         ),
 301       );
 302     }
 303
 304     $this->addButtons($button);
 305     $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
 306   }
 307
 308   /**
 309    * @param $fields
 310    * @param $files
 311    * @param $self
 312    *
 313    * @return array
 314    */
 315   static function formRule($fields, $files, $self) {
 316     $errors = array();
 317     $link = CRM_Utils_System::href(ts('Flip between the original and duplicate contacts.'),
 318       'civicrm/contact/merge',
 319       'reset=1&action=update&cid=' . $self->_oid . '&oid=' . $self->_cid . '&rgid=' . $self->_rgid . '&flip=1'
 320     );
 321     if (CRM_Contact_BAO_Contact::checkDomainContact($self->_oid)) {
 322       $errors['_qf_default'] = ts("The Default Organization contact cannot be merged into another contact record. It is associated with the CiviCRM installation for this domain and contains information used for system functions. If you want to merge these records, you can: %1", array(1 => $link));
 323     }
 324     return $errors;
 325   }
 326
 327   public function postProcess() {
 328     $formValues = $this->exportValues();
 329
 330     // reset all selected contact ids from session
 331     // when we came from search context, CRM-3526
 332     $session = CRM_Core_Session::singleton();
 333     if ($session->get('selectedSearchContactIds')) {
 334       $session->resetScope('selectedSearchContactIds');
 335     }
 336
 337     $formValues['main_details'] = $this->_mainDetails;
 338     $formValues['other_details'] = $this->_otherDetails;
 339
 340     CRM_Dedupe_Merger::moveAllBelongings($this->_cid, $this->_oid, $formValues);
 341
 342     $name = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_cid, 'display_name');
 343     $message = '<ul><li>' . ts('%1 has been updated.', array(1 => $name)) . '</li><li>' . ts('Contact ID %1 has been deleted.', array(1 => $this->_oid)) . '</li></ul>';
 344     CRM_Core_Session::setStatus($message, ts('Contacts Merged'), 'success');
 345
 346     $url = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->_cid}");
 347     if (!empty($formValues['_qf_Merge_submit'])) {
 348       $listParamsURL = "reset=1&action=update&rgid={$this->_rgid}";
 349       if ($this->_gid) {
 350         $listParamsURL .= "&gid={$this->_gid}";
 351       }
 352       $lisitingURL = CRM_Utils_System::url('civicrm/contact/dedupefind',
 353         $listParamsURL
 354       );
 355       CRM_Utils_System::redirect($lisitingURL);
 356     }
 357      if (!empty($formValues['_qf_Merge_done'])) {
 358       CRM_Utils_System::redirect($url);
 359     }
 360
 361     if ($this->next && $this->_mergeId) {
 362       $cacheKey = "merge {$this->_contactType}";
 363       $cacheKey .= $this->_rgid ? "_{$this->_rgid}" : '_0';
 364       $cacheKey .= $this->_gid ? "_{$this->_gid}" : '_0';
 365
 366       $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
 367                                                                  pn.entity_id2 = de.contact_id2 )";
 368       $where = "de.id IS NULL";
 369
 370       $pos = CRM_Core_BAO_PrevNextCache::getPositions($cacheKey, NULL, NULL, $this->_mergeId, $join, $where);
 371
 372       if (!empty($pos) &&
 373         $pos['next']['id1'] &&
 374         $pos['next']['id2']
 375       ) {
 376
 377         $urlParam = "reset=1&cid={$pos['next']['id1']}&oid={$pos['next']['id2']}&mergeId={$pos['next']['mergeId']}&action=update";
 378         if ($this->_rgid) {
 379           $urlParam .= "&rgid={$this->_rgid}";
 380         }
 381         if ($this->_gid) {
 382           $urlParam .= "&gid={$this->_gid}";
 383         }
 384
 385         $url = CRM_Utils_System::url('civicrm/contact/merge', $urlParam);
 386       }
 387     }
 388
 389     CRM_Utils_System::redirect($url);
 390   }
 391 }
 392