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'));
77 $this->_rgid
= civicrm_api3('RuleGroup', 'getvalue', array(
78 'contact_type' => $this->_contactType
,
79 'used' => 'Supervised',
84 $cacheKey = CRM_Dedupe_Merger
::getMergeCacheKeyString($this->_rgid
, $gid);
86 $join = CRM_Dedupe_Merger
::getJoinOnDedupeTable();
87 $where = "de.id IS NULL";
89 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, $cid, $oid, $this->_mergeId
, $join, $where, $flip);
91 // Block access if user does not have EDIT permissions for both contacts.
92 if (!(CRM_Contact_BAO_Contact_Permission
::allow($cid, CRM_Core_Permission
::EDIT
) &&
93 CRM_Contact_BAO_Contact_Permission
::allow($oid, CRM_Core_Permission
::EDIT
)
96 CRM_Utils_System
::permissionDenied();
99 // get user info of main contact.
100 $config = CRM_Core_Config
::singleton();
101 $config->doNotResetCache
= 1;
103 $viewUser = CRM_Core_Permission
::check('access user profiles');
104 $mainUfId = CRM_Core_BAO_UFMatch
::getUFId($cid);
108 if ($config->userSystem
->is_drupal
== '1') {
109 $mainUser = user_load($mainUfId);
111 elseif ($config->userFramework
== 'Joomla') {
112 $mainUser = JFactory
::getUser($mainUfId);
115 $this->assign('mainUfId', $mainUfId);
116 $this->assign('mainUfName', $mainUser ?
$mainUser->name
: NULL);
119 $flipUrl = CRM_Utils_System
::url('civicrm/contact/merge',
120 "reset=1&action=update&cid={$oid}&oid={$cid}&rgid={$this->_rgid}&gid={$gid}"
123 $flipUrl .= '&flip=1';
125 $this->assign('flip', $flipUrl);
127 $this->prev
= $this->next
= NULL;
132 if (!empty($pos[$position])) {
133 if ($pos[$position]['id1'] && $pos[$position]['id2']) {
134 $urlParam = "reset=1&cid={$pos[$position]['id1']}&oid={$pos[$position]['id2']}&mergeId={$pos[$position]['mergeId']}&action=update";
137 $urlParam .= "&rgid={$this->_rgid}";
140 $urlParam .= "&gid={$gid}";
143 $this->$position = CRM_Utils_System
::url('civicrm/contact/merge', $urlParam);
144 $this->assign($position, $this->$position);
149 // get user info of other contact.
150 $otherUfId = CRM_Core_BAO_UFMatch
::getUFId($oid);
155 if ($config->userSystem
->is_drupal
== '1') {
156 $otherUser = user_load($otherUfId);
158 elseif ($config->userFramework
== 'Joomla') {
159 $otherUser = JFactory
::getUser($otherUfId);
162 $this->assign('otherUfId', $otherUfId);
163 $this->assign('otherUfName', $otherUser ?
$otherUser->name
: NULL);
166 $cmsUser = ($mainUfId && $otherUfId) ?
TRUE : FALSE;
167 $this->assign('user', $cmsUser);
169 $session = CRM_Core_Session
::singleton();
173 $urlParam = "reset=1&action=browse&rgid={$this->_rgid}";
175 $urlParam .= "&gid={$gid}";
177 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/dedupefind', $urlParam));
180 // ensure that oid is not the current user, if so refuse to do the merge
181 if ($session->get('userID') == $oid) {
182 $display_name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $oid, 'display_name');
183 $message = ts('The contact record which is linked to the currently logged in user account - \'%1\' - cannot be deleted.',
184 array(1 => $display_name)
186 CRM_Core_Error
::statusBounce($message);
189 $rowsElementsAndInfo = CRM_Dedupe_Merger
::getRowsElementsAndInfo($cid, $oid);
190 $main = $this->_mainDetails
= &$rowsElementsAndInfo['main_details'];
191 $other = $this->_otherDetails
= &$rowsElementsAndInfo['other_details'];
193 if ($main['contact_id'] != $cid) {
194 CRM_Core_Error
::fatal(ts('The main contact record does not exist'));
197 if ($other['contact_id'] != $oid) {
198 CRM_Core_Error
::fatal(ts('The other contact record does not exist'));
201 $this->assign('contact_type', $main['contact_type']);
202 $this->assign('main_name', $main['display_name']);
203 $this->assign('other_name', $other['display_name']);
204 $this->assign('main_cid', $main['contact_id']);
205 $this->assign('other_cid', $other['contact_id']);
206 $this->assign('rgid', $this->_rgid
);
211 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
213 $this->assign('mainLocBlock', json_encode($rowsElementsAndInfo['main_details']['location_blocks']));
214 $this->assign('locationBlockInfo', json_encode(CRM_Dedupe_Merger
::getLocationBlockInfo()));
215 $this->assign('rows', $rowsElementsAndInfo['rows']);
218 foreach ($rowsElementsAndInfo['elements'] as $element) {
219 $this->addElement($element[0],
221 array_key_exists('2', $element) ?
$element[2] : NULL,
222 array_key_exists('3', $element) ?
$element[3] : NULL,
223 array_key_exists('4', $element) ?
$element[4] : NULL,
224 array_key_exists('5', $element) ?
$element[5] : NULL
228 // add related table elements
229 foreach ($rowsElementsAndInfo['rel_table_elements'] as $relTableElement) {
230 $element = $this->addElement($relTableElement[0], $relTableElement[1]);
231 $element->setChecked(TRUE);
234 $this->assign('rel_tables', $rowsElementsAndInfo['rel_tables']);
235 $this->assign('userContextURL', $session->readUserContext());
239 * This virtual function is used to set the default values of
240 * various form elements
245 * reference to the array of default values
250 public function setDefaultValues() {
251 return array('deleteOther' => 1);
254 public function addRules() {
257 public function buildQuickForm() {
258 CRM_Utils_System
::setTitle(ts('Merge %1 contacts', array(1 => $this->_contactType
)));
263 'name' => $this->next ?
ts('Merge and go to Next Pair') : ts('Merge'),
265 'icon' => $this->next ?
'circle-triangle-e' : 'check',
268 if ($this->next ||
$this->prev
) {
271 'name' => ts('Merge and go to Listing'),
275 'name' => ts('Merge and View Result'),
276 'icon' => 'fa-check-circle',
282 'name' => ts('Cancel'),
285 $this->addButtons($buttons);
286 $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
296 public static function formRule($fields, $files, $self) {
298 $link = CRM_Utils_System
::href(ts('Flip between the original and duplicate contacts.'),
299 'civicrm/contact/merge',
300 'reset=1&action=update&cid=' . $self->_oid
. '&oid=' . $self->_cid
. '&rgid=' . $self->_rgid
. '&flip=1'
302 if (CRM_Contact_BAO_Contact
::checkDomainContact($self->_oid
)) {
303 $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));
308 public function postProcess() {
309 $formValues = $this->exportValues();
311 // reset all selected contact ids from session
312 // when we came from search context, CRM-3526
313 $session = CRM_Core_Session
::singleton();
314 if ($session->get('selectedSearchContactIds')) {
315 $session->resetScope('selectedSearchContactIds');
318 $formValues['main_details'] = $this->_mainDetails
;
319 $formValues['other_details'] = $this->_otherDetails
;
321 CRM_Dedupe_Merger
::moveAllBelongings($this->_cid
, $this->_oid
, $formValues);
323 $name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_cid
, 'display_name');
324 $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>';
325 CRM_Core_Session
::setStatus($message, ts('Contacts Merged'), 'success');
327 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->_cid}");
328 if (!empty($formValues['_qf_Merge_submit'])) {
329 $listParamsURL = "reset=1&action=update&rgid={$this->_rgid}";
331 $listParamsURL .= "&gid={$this->_gid}";
333 $lisitingURL = CRM_Utils_System
::url('civicrm/contact/dedupefind',
336 CRM_Utils_System
::redirect($lisitingURL);
338 if (!empty($formValues['_qf_Merge_done'])) {
339 CRM_Utils_System
::redirect($url);
342 if ($this->next
&& $this->_mergeId
) {
343 $cacheKey = CRM_Dedupe_Merger
::getMergeCacheKeyString($this->_rgid
, $this->_gid
);
345 $join = CRM_Dedupe_Merger
::getJoinOnDedupeTable();
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);