3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
35 * Class CRM_Contact_Form_Merge.
37 class CRM_Contact_Form_Merge
extends CRM_Core_Form
{
38 // the id of the contact that tere's a duplicate for; this one will
39 // possibly inherit some of $_oid's properties and remain in the system
42 // the id of the other contact - the duplicate one that will get deleted
45 var $_contactType = NULL;
47 // FIXME: QuickForm can't create advcheckboxes with value set to 0 or '0' :(
48 // see HTML_QuickForm_advcheckbox::setValues() - but patching that doesn't
49 // help, as QF doesn't put the 0-value elements in exportValues() anyway...
50 // to side-step this, we use the below UUID as a (re)placeholder
51 var $_qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
53 public function preProcess() {
54 if (!CRM_Core_Permission
::check('merge duplicate contacts')) {
55 CRM_Core_Error
::fatal(ts('You do not have access to this page'));
59 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
60 $oid = CRM_Utils_Request
::retrieve('oid', 'Positive', $this, TRUE);
61 $flip = CRM_Utils_Request
::retrieve('flip', 'Positive', $this, FALSE);
63 $this->_rgid
= $rgid = CRM_Utils_Request
::retrieve('rgid', 'Positive', $this, FALSE);
64 $this->_gid
= $gid = CRM_Utils_Request
::retrieve('gid', 'Positive', $this, FALSE);
65 $this->_mergeId
= CRM_Utils_Request
::retrieve('mergeId', 'Positive', $this, FALSE);
69 CRM_Core_Error
::statusBounce(ts('Cannot merge a contact with itself.'));
72 if (!CRM_Dedupe_BAO_Rule
::validateContacts($cid, $oid)) {
73 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'))));
76 //load cache mechanism
77 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'contact_type');
78 $cacheKey = "merge $contactType";
79 $cacheKey .= $rgid ?
"_{$rgid}" : '_0';
80 $cacheKey .= $gid ?
"_{$gid}" : '_0';
82 $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
83 pn.entity_id2 = de.contact_id2 )";
84 $where = "de.id IS NULL";
86 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, $cid, $oid, $this->_mergeId
, $join, $where, $flip);
88 // Block access if user does not have EDIT permissions for both contacts.
89 if (!(CRM_Contact_BAO_Contact_Permission
::allow($cid, CRM_Core_Permission
::EDIT
) &&
90 CRM_Contact_BAO_Contact_Permission
::allow($oid, CRM_Core_Permission
::EDIT
)
93 CRM_Utils_System
::permissionDenied();
96 // get user info of main contact.
97 $config = CRM_Core_Config
::singleton();
98 $config->doNotResetCache
= 1;
100 $viewUser = CRM_Core_Permission
::check('access user profiles');
101 $mainUfId = CRM_Core_BAO_UFMatch
::getUFId($cid);
105 if ($config->userSystem
->is_drupal
== '1') {
106 $mainUser = user_load($mainUfId);
108 elseif ($config->userFramework
== 'Joomla') {
109 $mainUser = JFactory
::getUser($mainUfId);
112 $this->assign('mainUfId', $mainUfId);
113 $this->assign('mainUfName', $mainUser ?
$mainUser->name
: NULL);
116 $flipUrl = CRM_Utils_System
::url('civicrm/contact/merge',
117 "reset=1&action=update&cid={$oid}&oid={$cid}&rgid={$rgid}&gid={$gid}"
120 $flipUrl .= '&flip=1';
122 $this->assign('flip', $flipUrl);
124 $this->prev
= $this->next
= NULL;
129 if (!empty($pos[$position])) {
130 if ($pos[$position]['id1'] && $pos[$position]['id2']) {
131 $urlParam = "reset=1&cid={$pos[$position]['id1']}&oid={$pos[$position]['id2']}&mergeId={$pos[$position]['mergeId']}&action=update";
134 $urlParam .= "&rgid={$rgid}";
137 $urlParam .= "&gid={$gid}";
140 $this->$position = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
141 $this->assign($position, $this->$position);
146 // get user info of other contact.
147 $otherUfId = CRM_Core_BAO_UFMatch
::getUFId($oid);
152 if ($config->userSystem
->is_drupal
== '1') {
153 $otherUser = user_load($otherUfId);
155 elseif ($config->userFramework
== 'Joomla') {
156 $otherUser = JFactory
::getUser($otherUfId);
159 $this->assign('otherUfId', $otherUfId);
160 $this->assign('otherUfName', $otherUser ?
$otherUser->name
: NULL);
163 $cmsUser = ($mainUfId && $otherUfId) ?
TRUE : FALSE;
164 $this->assign('user', $cmsUser);
166 $session = CRM_Core_Session
::singleton();
170 $urlParam = "reset=1&action=browse&rgid={$rgid}";
172 $urlParam .= "&gid={$gid}";
174 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/dedupefind', $urlParam));
177 // ensure that oid is not the current user, if so refuse to do the merge
178 if ($session->get('userID') == $oid) {
179 $display_name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $oid, 'display_name');
180 $message = ts('The contact record which is linked to the currently logged in user account - \'%1\' - cannot be deleted.',
181 array(1 => $display_name)
183 CRM_Core_Error
::statusBounce($message);
186 $rowsElementsAndInfo = CRM_Dedupe_Merger
::getRowsElementsAndInfo($cid, $oid);
187 $main = $this->_mainDetails
= &$rowsElementsAndInfo['main_details'];
188 $other = $this->_otherDetails
= &$rowsElementsAndInfo['other_details'];
190 if ($main['contact_id'] != $cid) {
191 CRM_Core_Error
::fatal(ts('The main contact record does not exist'));
194 if ($other['contact_id'] != $oid) {
195 CRM_Core_Error
::fatal(ts('The other contact record does not exist'));
198 $this->assign('contact_type', $main['contact_type']);
199 $this->assign('main_name', $main['display_name']);
200 $this->assign('other_name', $other['display_name']);
201 $this->assign('main_cid', $main['contact_id']);
202 $this->assign('other_cid', $other['contact_id']);
203 $this->assign('rgid', $rgid);
207 $this->_rgid
= $rgid;
208 $this->_contactType
= $main['contact_type'];
209 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
211 $this->assign('mainLocBlock', json_encode($rowsElementsAndInfo['main_loc_block']));
212 $this->assign('rows', $rowsElementsAndInfo['rows']);
215 foreach ($rowsElementsAndInfo['elements'] as $element) {
216 $this->addElement($element[0],
218 array_key_exists('2', $element) ?
$element[2] : NULL,
219 array_key_exists('3', $element) ?
$element[3] : NULL,
220 array_key_exists('4', $element) ?
$element[4] : NULL,
221 array_key_exists('5', $element) ?
$element[5] : NULL
225 // add related table elements
226 foreach ($rowsElementsAndInfo['rel_table_elements'] as $relTableElement) {
227 $element = $this->addElement($relTableElement[0], $relTableElement[1]);
228 $element->setChecked(TRUE);
231 $this->assign('rel_tables', $rowsElementsAndInfo['rel_tables']);
232 $this->assign('userContextURL', $session->readUserContext());
236 * This virtual function is used to set the default values of
237 * various form elements
242 * reference to the array of default values
247 public function setDefaultValues() {
248 return array('deleteOther' => 1);
251 public function addRules() {
254 public function buildQuickForm() {
255 CRM_Utils_System
::setTitle(ts('Merge %1 contacts', array(1 => $this->_contactType
)));
260 'name' => $this->next ?
ts('Merge and go to Next Pair') : ts('Merge'),
262 'icon' => $this->next ?
'circle-triangle-e' : 'check',
265 if ($this->next ||
$this->prev
) {
268 'name' => ts('Merge and go to Listing'),
272 'name' => ts('Merge and View Result'),
273 'icon' => 'fa-check-circle',
279 'name' => ts('Cancel'),
282 $this->addButtons($buttons);
283 $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
293 public static function formRule($fields, $files, $self) {
295 $link = CRM_Utils_System
::href(ts('Flip between the original and duplicate contacts.'),
296 'civicrm/contact/merge',
297 'reset=1&action=update&cid=' . $self->_oid
. '&oid=' . $self->_cid
. '&rgid=' . $self->_rgid
. '&flip=1'
299 if (CRM_Contact_BAO_Contact
::checkDomainContact($self->_oid
)) {
300 $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));
305 public function postProcess() {
306 $formValues = $this->exportValues();
308 // reset all selected contact ids from session
309 // when we came from search context, CRM-3526
310 $session = CRM_Core_Session
::singleton();
311 if ($session->get('selectedSearchContactIds')) {
312 $session->resetScope('selectedSearchContactIds');
315 $formValues['main_details'] = $this->_mainDetails
;
316 $formValues['other_details'] = $this->_otherDetails
;
318 CRM_Dedupe_Merger
::moveAllBelongings($this->_cid
, $this->_oid
, $formValues);
320 $name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_cid
, 'display_name');
321 $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>';
322 CRM_Core_Session
::setStatus($message, ts('Contacts Merged'), 'success');
324 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->_cid}");
325 if (!empty($formValues['_qf_Merge_submit'])) {
326 $listParamsURL = "reset=1&action=update&rgid={$this->_rgid}";
328 $listParamsURL .= "&gid={$this->_gid}";
330 $lisitingURL = CRM_Utils_System
::url('civicrm/contact/dedupefind',
333 CRM_Utils_System
::redirect($lisitingURL);
335 if (!empty($formValues['_qf_Merge_done'])) {
336 CRM_Utils_System
::redirect($url);
339 if ($this->next
&& $this->_mergeId
) {
340 $cacheKey = "merge {$this->_contactType}";
341 $cacheKey .= $this->_rgid ?
"_{$this->_rgid}" : '_0';
342 $cacheKey .= $this->_gid ?
"_{$this->_gid}" : '_0';
344 $join = "LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND
345 pn.entity_id2 = de.contact_id2 )";
346 $where = "de.id IS NULL";
348 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, NULL, NULL, $this->_mergeId
, $join, $where);
351 $pos['next']['id1'] &&
355 $urlParam = "reset=1&cid={$pos['next']['id1']}&oid={$pos['next']['id2']}&mergeId={$pos['next']['mergeId']}&action=update";
357 $urlParam .= "&rgid={$this->_rgid}";
360 $urlParam .= "&gid={$this->_gid}";
363 $url = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
367 CRM_Utils_System
::redirect($url);