3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
36 require_once 'api/api.php';
39 * Class CRM_Contact_Form_Merge
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
46 // the id of the other contact - the duplicate one that will get deleted
49 var $_contactType = NULL;
51 // variable to keep all location block ids.
52 protected $_locBlockIds = array();
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';
60 public 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'));
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);
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);
76 CRM_Core_Error
::statusBounce(ts('Cannot merge a contact with itself.'));
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'))));
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';
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";
93 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, $cid, $oid, $this->_mergeId
, $join, $where, $flip);
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
)
100 CRM_Utils_System
::permissionDenied();
103 // get user info of main contact.
104 $config = CRM_Core_Config
::singleton();
105 $config->doNotResetCache
= 1;
107 $viewUser = CRM_Core_Permission
::check('access user profiles');
108 $mainUfId = CRM_Core_BAO_UFMatch
::getUFId($cid);
112 if ($config->userSystem
->is_drupal
== '1') {
113 $mainUser = user_load($mainUfId);
115 elseif ($config->userFramework
== 'Joomla') {
116 $mainUser = JFactory
::getUser($mainUfId);
119 $this->assign('mainUfId', $mainUfId);
120 $this->assign('mainUfName', $mainUser ?
$mainUser->name
: NULL);
123 $flipUrl = CRM_Utils_System
::url('civicrm/contact/merge',
124 "reset=1&action=update&cid={$oid}&oid={$cid}&rgid={$rgid}&gid={$gid}"
127 $flipUrl .= '&flip=1';
129 $this->assign('flip', $flipUrl);
131 $this->prev
= $this->next
= NULL;
136 if (!empty($pos[$position])) {
137 if ($pos[$position]['id1'] && $pos[$position]['id2']) {
138 $urlParam = "reset=1&cid={$pos[$position]['id1']}&oid={$pos[$position]['id2']}&mergeId={$pos[$position]['mergeId']}&action=update";
141 $urlParam .= "&rgid={$rgid}";
144 $urlParam .= "&gid={$gid}";
147 $this->$position = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
148 $this->assign($position, $this->$position);
153 // get user info of other contact.
154 $otherUfId = CRM_Core_BAO_UFMatch
::getUFId($oid);
159 if ($config->userSystem
->is_drupal
== '1') {
160 $otherUser = user_load($otherUfId);
162 elseif ($config->userFramework
== 'Joomla') {
163 $otherUser = JFactory
::getUser($otherUfId);
166 $this->assign('otherUfId', $otherUfId);
167 $this->assign('otherUfName', $otherUser ?
$otherUser->name
: NULL);
170 $cmsUser = ($mainUfId && $otherUfId) ?
TRUE : FALSE;
171 $this->assign('user', $cmsUser);
173 $session = CRM_Core_Session
::singleton();
177 $urlParam = "reset=1&action=browse&rgid={$rgid}";
179 $urlParam .= "&gid={$gid}";
181 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/dedupefind', $urlParam));
184 // ensure that oid is not the current user, if so refuse to do the merge
185 if ($session->get('userID') == $oid) {
186 $display_name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $oid, 'display_name');
187 $message = ts('The contact record which is linked to the currently logged in user account - \'%1\' - cannot be deleted.',
188 array(1 => $display_name)
190 CRM_Core_Error
::statusBounce($message);
193 $rowsElementsAndInfo = CRM_Dedupe_Merger
::getRowsElementsAndInfo($cid, $oid);
194 $main = $this->_mainDetails
= &$rowsElementsAndInfo['main_details'];
195 $other = $this->_otherDetails
= &$rowsElementsAndInfo['other_details'];
197 if ($main['contact_id'] != $cid) {
198 CRM_Core_Error
::fatal(ts('The main contact record does not exist'));
201 if ($other['contact_id'] != $oid) {
202 CRM_Core_Error
::fatal(ts('The other contact record does not exist'));
205 $this->assign('contact_type', $main['contact_type']);
206 $this->assign('main_name', $main['display_name']);
207 $this->assign('other_name', $other['display_name']);
208 $this->assign('main_cid', $main['contact_id']);
209 $this->assign('other_cid', $other['contact_id']);
210 $this->assign('rgid', $rgid);
214 $this->_rgid
= $rgid;
215 $this->_contactType
= $main['contact_type'];
216 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
218 $this->assign('mainLocBlock', json_encode($rowsElementsAndInfo['main_loc_block']));
219 $this->assign('rows', $rowsElementsAndInfo['rows']);
221 $this->_locBlockIds
= array(
222 'main' => $rowsElementsAndInfo['main_details']['loc_block_ids'],
223 'other' => $rowsElementsAndInfo['other_details']['loc_block_ids'],
227 foreach ($rowsElementsAndInfo['elements'] as $element) {
228 $this->addElement($element[0],
230 array_key_exists('2', $element) ?
$element[2] : NULL,
231 array_key_exists('3', $element) ?
$element[3] : NULL,
232 array_key_exists('4', $element) ?
$element[4] : NULL,
233 array_key_exists('5', $element) ?
$element[5] : NULL
237 // add related table elements
238 foreach ($rowsElementsAndInfo['rel_table_elements'] as $relTableElement) {
239 $element = $this->addElement($relTableElement[0], $relTableElement[1]);
240 $element->setChecked(TRUE);
243 $this->assign('rel_tables', $rowsElementsAndInfo['rel_tables']);
244 $this->assign('userContextURL', $session->readUserContext());
248 * This virtual function is used to set the default values of
249 * various form elements
254 * reference to the array of default values
259 public function setDefaultValues() {
260 return array('deleteOther' => 1);
263 public function addRules() {
266 public function buildQuickForm() {
267 CRM_Utils_System
::setTitle(ts('Merge %1s', array(1 => $this->_contactType
)));
272 'name' => $this->next ?
ts('Merge and Goto Next Pair') : ts('Merge'),
274 'icon' => $this->next ?
'circle-triangle-e' : 'check',
277 if ($this->next ||
$this->prev
) {
280 'name' => ts('Merge and Goto Listing'),
284 'name' => ts('Merge and View Result'),
285 'icon' => 'circle-check'
291 'name' => ts('Cancel'),
294 $this->addButtons($buttons);
295 $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
305 public static function formRule($fields, $files, $self) {
307 $link = CRM_Utils_System
::href(ts('Flip between the original and duplicate contacts.'),
308 'civicrm/contact/merge',
309 'reset=1&action=update&cid=' . $self->_oid
. '&oid=' . $self->_cid
. '&rgid=' . $self->_rgid
. '&flip=1'
311 if (CRM_Contact_BAO_Contact
::checkDomainContact($self->_oid
)) {
312 $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));
317 public function postProcess() {
318 $formValues = $this->exportValues();
320 // reset all selected contact ids from session
321 // when we came from search context, CRM-3526
322 $session = CRM_Core_Session
::singleton();
323 if ($session->get('selectedSearchContactIds')) {
324 $session->resetScope('selectedSearchContactIds');
327 $formValues['main_details'] = $this->_mainDetails
;
328 $formValues['other_details'] = $this->_otherDetails
;
330 CRM_Dedupe_Merger
::moveAllBelongings($this->_cid
, $this->_oid
, $formValues);
332 $name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_cid
, 'display_name');
333 $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>';
334 CRM_Core_Session
::setStatus($message, ts('Contacts Merged'), 'success');
336 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->_cid}");
337 if (!empty($formValues['_qf_Merge_submit'])) {
338 $listParamsURL = "reset=1&action=update&rgid={$this->_rgid}";
340 $listParamsURL .= "&gid={$this->_gid}";
342 $lisitingURL = CRM_Utils_System
::url('civicrm/contact/dedupefind',
345 CRM_Utils_System
::redirect($lisitingURL);
347 if (!empty($formValues['_qf_Merge_done'])) {
348 CRM_Utils_System
::redirect($url);
351 if ($this->next
&& $this->_mergeId
) {
352 $cacheKey = "merge {$this->_contactType}";
353 $cacheKey .= $this->_rgid ?
"_{$this->_rgid}" : '_0';
354 $cacheKey .= $this->_gid ?
"_{$this->_gid}" : '_0';
356 $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
357 pn.entity_id2 = de.contact_id2 )";
358 $where = "de.id IS NULL";
360 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, NULL, NULL, $this->_mergeId
, $join, $where);
363 $pos['next']['id1'] &&
367 $urlParam = "reset=1&cid={$pos['next']['id1']}&oid={$pos['next']['id2']}&mergeId={$pos['next']['mergeId']}&action=update";
369 $urlParam .= "&rgid={$this->_rgid}";
372 $urlParam .= "&gid={$this->_gid}";
375 $url = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
379 CRM_Utils_System
::redirect($url);