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
= 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'))));
75 $this->_contactType
= civicrm_api3('Contact', 'getvalue', array('id' => $cid, 'return' => 'contact_type'));
76 $isFromDedupeScreen = TRUE;
78 $isFromDedupeScreen = FALSE;
79 $this->_rgid
= civicrm_api3('RuleGroup', 'getvalue', array(
80 'contact_type' => $this->_contactType
,
81 'used' => 'Supervised',
86 $cacheKey = CRM_Dedupe_Merger
::getMergeCacheKeyString($this->_rgid
, $gid);
88 $join = CRM_Dedupe_Merger
::getJoinOnDedupeTable();
89 $where = "de.id IS NULL";
91 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, $cid, $oid, $this->_mergeId
, $join, $where, $flip);
93 // Block access if user does not have EDIT permissions for both contacts.
94 if (!(CRM_Contact_BAO_Contact_Permission
::allow($cid, CRM_Core_Permission
::EDIT
) &&
95 CRM_Contact_BAO_Contact_Permission
::allow($oid, CRM_Core_Permission
::EDIT
)
98 CRM_Utils_System
::permissionDenied();
101 // get user info of main contact.
102 $config = CRM_Core_Config
::singleton();
103 $config->doNotResetCache
= 1;
105 $viewUser = CRM_Core_Permission
::check('access user profiles');
106 $mainUfId = CRM_Core_BAO_UFMatch
::getUFId($cid);
110 if ($config->userSystem
->is_drupal
== '1') {
111 $mainUser = user_load($mainUfId);
113 elseif ($config->userFramework
== 'Joomla') {
114 $mainUser = JFactory
::getUser($mainUfId);
117 $this->assign('mainUfId', $mainUfId);
118 $this->assign('mainUfName', $mainUser ?
$mainUser->name
: NULL);
121 $flipUrl = CRM_Utils_System
::url('civicrm/contact/merge',
122 "reset=1&action=update&cid={$oid}&oid={$cid}&rgid={$this->_rgid}&gid={$gid}"
125 $flipUrl .= '&flip=1';
127 $this->assign('flip', $flipUrl);
129 $this->prev
= $this->next
= NULL;
134 if (!empty($pos[$position])) {
135 if ($pos[$position]['id1'] && $pos[$position]['id2']) {
136 $urlParam = "reset=1&cid={$pos[$position]['id1']}&oid={$pos[$position]['id2']}&mergeId={$pos[$position]['mergeId']}&action=update";
139 $urlParam .= "&rgid={$this->_rgid}";
142 $urlParam .= "&gid={$gid}";
145 $this->$position = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
146 $this->assign($position, $this->$position);
151 // get user info of other contact.
152 $otherUfId = CRM_Core_BAO_UFMatch
::getUFId($oid);
157 if ($config->userSystem
->is_drupal
== '1') {
158 $otherUser = user_load($otherUfId);
160 elseif ($config->userFramework
== 'Joomla') {
161 $otherUser = JFactory
::getUser($otherUfId);
164 $this->assign('otherUfId', $otherUfId);
165 $this->assign('otherUfName', $otherUser ?
$otherUser->name
: NULL);
168 $cmsUser = ($mainUfId && $otherUfId) ?
TRUE : FALSE;
169 $this->assign('user', $cmsUser);
171 $session = CRM_Core_Session
::singleton();
174 if ($isFromDedupeScreen) {
175 $urlParam = "reset=1&action=browse&rgid={$this->_rgid}";
177 $urlParam .= "&gid={$gid}";
179 $browseUrl = CRM_Utils_System
::url('civicrm/contact/dedupefind', $urlParam);
180 $session->pushUserContext($browseUrl);
182 $this->assign('browseUrl', empty($browseUrl) ?
'' : $browseUrl);
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', $this->_rgid
);
215 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
217 $this->assign('mainLocBlock', json_encode($rowsElementsAndInfo['main_details']['location_blocks']));
218 $this->assign('locationBlockInfo', json_encode(CRM_Dedupe_Merger
::getLocationBlockInfo()));
219 $this->assign('rows', $rowsElementsAndInfo['rows']);
222 foreach ($rowsElementsAndInfo['elements'] as $element) {
223 $this->addElement($element[0],
225 array_key_exists('2', $element) ?
$element[2] : NULL,
226 array_key_exists('3', $element) ?
$element[3] : NULL,
227 array_key_exists('4', $element) ?
$element[4] : NULL,
228 array_key_exists('5', $element) ?
$element[5] : NULL
232 // add related table elements
233 foreach ($rowsElementsAndInfo['rel_table_elements'] as $relTableElement) {
234 $element = $this->addElement($relTableElement[0], $relTableElement[1]);
235 $element->setChecked(TRUE);
238 $this->assign('rel_tables', $rowsElementsAndInfo['rel_tables']);
239 $this->assign('userContextURL', $session->readUserContext());
243 * This virtual function is used to set the default values of
244 * various form elements
249 * reference to the array of default values
254 public function setDefaultValues() {
255 return array('deleteOther' => 1);
258 public function addRules() {
261 public function buildQuickForm() {
262 CRM_Utils_System
::setTitle(ts('Merge %1 contacts', array(1 => $this->_contactType
)));
267 'name' => $this->next ?
ts('Merge and go to Next Pair') : ts('Merge'),
269 'icon' => $this->next ?
'circle-triangle-e' : 'check',
272 if ($this->next ||
$this->prev
) {
275 'name' => ts('Merge and go to Listing'),
279 'name' => ts('Merge and View Result'),
280 'icon' => 'fa-check-circle',
286 'name' => ts('Cancel'),
289 $this->addButtons($buttons);
290 $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
300 public static function formRule($fields, $files, $self) {
302 $link = CRM_Utils_System
::href(ts('Flip between the original and duplicate contacts.'),
303 'civicrm/contact/merge',
304 'reset=1&action=update&cid=' . $self->_oid
. '&oid=' . $self->_cid
. '&rgid=' . $self->_rgid
. '&flip=1'
306 if (CRM_Contact_BAO_Contact
::checkDomainContact($self->_oid
)) {
307 $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));
312 public function postProcess() {
313 $formValues = $this->exportValues();
315 // reset all selected contact ids from session
316 // when we came from search context, CRM-3526
317 $session = CRM_Core_Session
::singleton();
318 if ($session->get('selectedSearchContactIds')) {
319 $session->resetScope('selectedSearchContactIds');
322 $formValues['main_details'] = $this->_mainDetails
;
323 $formValues['other_details'] = $this->_otherDetails
;
325 CRM_Dedupe_Merger
::moveAllBelongings($this->_cid
, $this->_oid
, $formValues);
327 $name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_cid
, 'display_name');
328 $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>';
329 CRM_Core_Session
::setStatus($message, ts('Contacts Merged'), 'success');
331 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->_cid}");
332 if (!empty($formValues['_qf_Merge_submit'])) {
333 $listParamsURL = "reset=1&action=update&rgid={$this->_rgid}";
335 $listParamsURL .= "&gid={$this->_gid}";
337 $lisitingURL = CRM_Utils_System
::url('civicrm/contact/dedupefind',
340 CRM_Utils_System
::redirect($lisitingURL);
342 if (!empty($formValues['_qf_Merge_done'])) {
343 CRM_Utils_System
::redirect($url);
346 if ($this->next
&& $this->_mergeId
) {
347 $cacheKey = CRM_Dedupe_Merger
::getMergeCacheKeyString($this->_rgid
, $this->_gid
);
349 $join = CRM_Dedupe_Merger
::getJoinOnDedupeTable();
350 $where = "de.id IS NULL";
352 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, NULL, NULL, $this->_mergeId
, $join, $where);
355 $pos['next']['id1'] &&
359 $urlParam = "reset=1&cid={$pos['next']['id1']}&oid={$pos['next']['id2']}&mergeId={$pos['next']['mergeId']}&action=update";
361 $urlParam .= "&rgid={$this->_rgid}";
364 $urlParam .= "&gid={$this->_gid}";
367 $url = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
371 CRM_Utils_System
::redirect($url);