3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
35 * Class CRM_Contact_Form_Merge.
37 class CRM_Contact_Form_Merge
extends CRM_Core_Form
{
38 // The id of the contact that there'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;
48 * Query limit to be retained in the urls.
55 * String for quickform bug handling.
57 * FIXME: QuickForm can't create advcheckboxes with value set to 0 or '0' :(
58 * see HTML_QuickForm_advcheckbox::setValues() - but patching that doesn't
59 * help, as QF doesn't put the 0-value elements in exportValues() anyway...
60 * to side-step this, we use the below UUID as a (re)placeholder
64 var $_qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
66 public function preProcess() {
69 $this->_cid
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
70 $this->_oid
= CRM_Utils_Request
::retrieve('oid', 'Positive', $this, TRUE);
71 $flip = CRM_Utils_Request
::retrieve('flip', 'Positive', $this, FALSE);
73 $this->_rgid
= CRM_Utils_Request
::retrieve('rgid', 'Positive', $this, FALSE);
74 $this->_gid
= $gid = CRM_Utils_Request
::retrieve('gid', 'Positive', $this, FALSE);
75 $this->_mergeId
= CRM_Utils_Request
::retrieve('mergeId', 'Positive', $this, FALSE);
76 $this->limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this, FALSE);
77 $urlParams = "reset=1&rgid={$this->_rgid}&gid={$this->_gid}&limit=" . $this->limit
;
79 $this->bounceIfInvalid($this->_cid
, $this->_oid
);
81 $this->_contactType
= civicrm_api3('Contact', 'getvalue', array(
83 'return' => 'contact_type',
86 $browseUrl = CRM_Utils_System
::url('civicrm/contact/dedupefind', $urlParams . '&action=browse');
89 // Unset browse URL as we have come from the search screen.
91 $this->_rgid
= civicrm_api3('RuleGroup', 'getvalue', array(
92 'contact_type' => $this->_contactType
,
93 'used' => 'Supervised',
97 $this->assign('browseUrl', $browseUrl);
99 CRM_Core_Session
::singleton()->pushUserContext($browseUrl);
102 $cacheKey = CRM_Dedupe_Merger
::getMergeCacheKeyString($this->_rgid
, $gid);
104 $join = CRM_Dedupe_Merger
::getJoinOnDedupeTable();
105 $where = "de.id IS NULL";
107 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, $this->_cid
, $this->_oid
, $this->_mergeId
, $join, $where, $flip);
109 // get user info of main contact.
110 $config = CRM_Core_Config
::singleton();
111 $config->doNotResetCache
= 1;
113 $mainUfId = CRM_Core_BAO_UFMatch
::getUFId($this->_cid
);
117 if ($config->userSystem
->is_drupal
== '1') {
118 $mainUser = user_load($mainUfId);
120 elseif ($config->userFramework
== 'Joomla') {
121 $mainUser = JFactory
::getUser($mainUfId);
124 $this->assign('mainUfId', $mainUfId);
125 $this->assign('mainUfName', $mainUser ?
$mainUser->name
: NULL);
128 $flipUrl = CRM_Utils_System
::url('civicrm/contact/merge',
129 "reset=1&action=update&cid={$this->_oid}&oid={$this->_cid}&rgid={$this->_rgid}&gid={$gid}"
132 $flipUrl .= '&flip=1';
134 $this->assign('flip', $flipUrl);
136 $this->prev
= $this->next
= NULL;
141 if (!empty($pos[$position])) {
142 if ($pos[$position]['id1'] && $pos[$position]['id2']) {
143 $urlParams .= "&cid={$pos[$position]['id1']}&oid={$pos[$position]['id2']}&mergeId={$pos[$position]['mergeId']}&action=update";
144 $this->$position = CRM_Utils_System
::url('civicrm/contact/merge', $urlParams);
145 $this->assign($position, $this->$position);
150 // get user info of other contact.
151 $otherUfId = CRM_Core_BAO_UFMatch
::getUFId($this->_oid
);
156 if ($config->userSystem
->is_drupal
== '1') {
157 $otherUser = user_load($otherUfId);
159 elseif ($config->userFramework
== 'Joomla') {
160 $otherUser = JFactory
::getUser($otherUfId);
163 $this->assign('otherUfId', $otherUfId);
164 $this->assign('otherUfName', $otherUser ?
$otherUser->name
: NULL);
167 $cmsUser = ($mainUfId && $otherUfId) ?
TRUE : FALSE;
168 $this->assign('user', $cmsUser);
170 $rowsElementsAndInfo = CRM_Dedupe_Merger
::getRowsElementsAndInfo($this->_cid
, $this->_oid
);
171 $main = $this->_mainDetails
= $rowsElementsAndInfo['main_details'];
172 $other = $this->_otherDetails
= $rowsElementsAndInfo['other_details'];
174 $this->assign('contact_type', $main['contact_type']);
175 $this->assign('main_name', $main['display_name']);
176 $this->assign('other_name', $other['display_name']);
177 $this->assign('main_cid', $main['contact_id']);
178 $this->assign('other_cid', $other['contact_id']);
179 $this->assign('rgid', $this->_rgid
);
181 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
183 $this->assign('mainLocBlock', json_encode($rowsElementsAndInfo['main_details']['location_blocks']));
184 $this->assign('locationBlockInfo', json_encode(CRM_Dedupe_Merger
::getLocationBlockInfo()));
185 $this->assign('rows', $rowsElementsAndInfo['rows']);
188 foreach ($rowsElementsAndInfo['elements'] as $element) {
189 // We could push this down to the getRowsElementsAndInfo function but it's
190 // already so overloaded - let's start moving towards doing form-things
192 if (substr($element[1], 0, 13) === 'move_location') {
193 $element[4] = array_merge(
194 (array) CRM_Utils_Array
::value(4, $element, array()),
196 'data-location' => substr($element[1], 14),
197 'data-is_location' => TRUE,
200 if (substr($element[1], 0, 15) === 'location_blocks') {
201 // @todo We could add some data elements here to make jquery manipulation more straight-forward
202 // @todo consider enabling if it is an add & defaulting to true.
203 $element[4] = array_merge((array) CRM_Utils_Array
::value(4, $element, array()), array('disabled' => TRUE));
205 $this->addElement($element[0],
207 array_key_exists('2', $element) ?
$element[2] : NULL,
208 array_key_exists('3', $element) ?
$element[3] : NULL,
209 array_key_exists('4', $element) ?
$element[4] : NULL,
210 array_key_exists('5', $element) ?
$element[5] : NULL
214 // add related table elements
215 foreach ($rowsElementsAndInfo['rel_table_elements'] as $relTableElement) {
216 $element = $this->addElement($relTableElement[0], $relTableElement[1]);
217 $element->setChecked(TRUE);
220 $this->assign('rel_tables', $rowsElementsAndInfo['rel_tables']);
221 $this->assign('userContextURL', CRM_Core_Session
::singleton()
222 ->readUserContext());
224 catch (CRM_Core_Exception
$e) {
225 CRM_Core_Error
::statusBounce(ts($e->getMessage()));
229 public function addRules() {
232 public function buildQuickForm() {
233 CRM_Utils_System
::setTitle(ts('Merge %1 contacts', array(1 => $this->_contactType
)));
238 'name' => $this->next ?
ts('Merge and go to Next Pair') : ts('Merge'),
240 'icon' => $this->next ?
'circle-triangle-e' : 'check',
243 if ($this->next ||
$this->prev
) {
246 'name' => ts('Merge and go to Listing'),
250 'name' => ts('Merge and View Result'),
251 'icon' => 'fa-check-circle',
257 'name' => ts('Cancel'),
260 $this->addButtons($buttons);
261 $this->addFormRule(array('CRM_Contact_Form_Merge', 'formRule'), $this);
271 public static function formRule($fields, $files, $self) {
273 $link = CRM_Utils_System
::href(ts('Flip between the original and duplicate contacts.'),
274 'civicrm/contact/merge',
275 'reset=1&action=update&cid=' . $self->_oid
. '&oid=' . $self->_cid
. '&rgid=' . $self->_rgid
. '&flip=1'
277 if (CRM_Contact_BAO_Contact
::checkDomainContact($self->_oid
)) {
278 $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));
283 public function postProcess() {
284 $formValues = $this->exportValues();
286 // reset all selected contact ids from session
287 // when we came from search context, CRM-3526
288 $session = CRM_Core_Session
::singleton();
289 if ($session->get('selectedSearchContactIds')) {
290 $session->resetScope('selectedSearchContactIds');
293 $formValues['main_details'] = $this->_mainDetails
;
294 $formValues['other_details'] = $this->_otherDetails
;
295 $migrationData = array('migration_info' => $formValues);
296 CRM_Utils_Hook
::merge('form', $migrationData, $this->_cid
, $this->_oid
);
297 CRM_Dedupe_Merger
::moveAllBelongings($this->_cid
, $this->_oid
, $migrationData['migration_info']);
299 $name = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_cid
, 'display_name');
300 $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>';
301 CRM_Core_Session
::setStatus($message, ts('Contacts Merged'), 'success');
303 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$this->_cid}");
304 $urlParams = "reset=1&gid={$this->_gid}&rgid={$this->_rgid}&limit={$this->limit}";
306 if (!empty($formValues['_qf_Merge_submit'])) {
307 $urlParams .= "&action=update";
308 $lisitingURL = CRM_Utils_System
::url('civicrm/contact/dedupefind',
311 CRM_Utils_System
::redirect($lisitingURL);
313 if (!empty($formValues['_qf_Merge_done'])) {
314 CRM_Utils_System
::redirect($url);
317 if ($this->next
&& $this->_mergeId
) {
318 $cacheKey = CRM_Dedupe_Merger
::getMergeCacheKeyString($this->_rgid
, $this->_gid
);
320 $join = CRM_Dedupe_Merger
::getJoinOnDedupeTable();
321 $where = "de.id IS NULL";
323 $pos = CRM_Core_BAO_PrevNextCache
::getPositions($cacheKey, NULL, NULL, $this->_mergeId
, $join, $where);
326 $pos['next']['id1'] &&
330 $urlParams .= "&cid={$pos['next']['id1']}&oid={$pos['next']['id2']}&mergeId={$pos['next']['mergeId']}&action=update";
331 $url = CRM_Utils_System
::url('civicrm/contact/merge', $urlParams);
335 CRM_Utils_System
::redirect($url);
339 * Bounce if the merge action is invalid.
341 * We don't allow the merge if it is nonsensical, marked as a duplicate
342 * or outside the user's permission.
345 * Contact ID to retain
347 * Contact ID to delete.
349 public function bounceIfInvalid($cid, $oid) {
351 CRM_Core_Error
::statusBounce(ts('Cannot merge a contact with itself.'));
354 if (!CRM_Dedupe_BAO_Rule
::validateContacts($cid, $oid)) {
355 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'))));
358 if (!(CRM_Contact_BAO_Contact_Permission
::allow($cid, CRM_Core_Permission
::EDIT
) &&
359 CRM_Contact_BAO_Contact_Permission
::allow($oid, CRM_Core_Permission
::EDIT
)
362 CRM_Utils_System
::permissionDenied();
364 // ensure that oid is not the current user, if so refuse to do the merge
365 if (CRM_Core_Session
::singleton()->getLoggedInContactID() == $oid) {
366 $message = ts('The contact record which is linked to the currently logged in user account - \'%1\' - cannot be deleted.',
367 array(1 => CRM_Core_Session
::singleton()->getLoggedInContactDisplayName())
369 CRM_Core_Error
::statusBounce($message);