CRM/Contact/Page/DedupeFind.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2017
  32  */
  33 class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic {
  34   protected $_cid = NULL;
  35   protected $_rgid;
  36   protected $_mainContacts;
  37   protected $_gid;
  38   protected $action;
  39
  40   /**
  41    * Get BAO Name.
  42    *
  43    * @return string
  44    *   Classname of BAO.
  45    */
  46   public function getBAOName() {
  47     return 'CRM_Dedupe_BAO_RuleGroup';
  48   }
  49
  50   /**
  51    * Get action Links.
  52    */
  53   public function &links() {
  54   }
  55
  56   /**
  57    * Browse all rule groups.
  58    */
  59   public function run() {
  60     $gid = CRM_Utils_Request::retrieve('gid', 'Positive', $this, FALSE, 0);
  61     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 0);
  62     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  63     $limit = CRM_Utils_Request::retrieve('limit', 'Integer', $this);
  64     $rgid = CRM_Utils_Request::retrieve('rgid', 'Positive', $this);
  65     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE, 0);
  66     // Using a placeholder for criteria as it is intended to be able to pass this later.
  67     $criteria = array();
  68     $isConflictMode = ($context == 'conflicts');
  69     if ($cid) {
  70       $this->_cid = $cid;
  71     }
  72     if ($gid) {
  73       $this->_gid = $gid;
  74     }
  75     $this->_rgid = $rgid;
  76
  77     $urlQry = array(
  78       'reset' => 1,
  79       'rgid' => $rgid,
  80       'gid' => $gid,
  81       'limit' => $limit,
  82     );
  83     $this->assign('urlQuery', CRM_Utils_System::makeQueryString($urlQry));
  84
  85     if ($context == 'search') {
  86       $context = 'search';
  87       $this->assign('backURL', CRM_Core_Session::singleton()->readUserContext());
  88     }
  89
  90     if ($action & CRM_Core_Action::RENEW) {
  91       // empty cache
  92       if ($rgid) {
  93         CRM_Core_BAO_PrevNextCache::deleteItem(NULL, CRM_Dedupe_Merger::getMergeCacheKeyString($rgid, $gid, $criteria));
  94       }
  95       $urlQry['action'] = 'update';
  96       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/dedupefind', $urlQry));
  97     }
  98     elseif ($action & CRM_Core_Action::MAP) {
  99       // do a batch merge if requested
 100       $result = CRM_Dedupe_Merger::batchMerge($rgid, $gid, 'safe', 75, 2, $criteria);
 101
 102       $skippedCount = CRM_Utils_Request::retrieve('skipped', 'Positive', $this, FALSE, 0);
 103       $skippedCount = $skippedCount + count($result['skipped']);
 104       $mergedCount = CRM_Utils_Request::retrieve('merged', 'Positive', $this, FALSE, 0);
 105       $mergedCount = $mergedCount + count($result['merged']);
 106
 107       if (empty($result['merged']) && empty($result['skipped'])) {
 108         $message = '';
 109         if ($mergedCount >= 1) {
 110           $message = ts("%1 pairs of duplicates were merged", array(1 => $mergedCount));
 111         }
 112         if ($skippedCount >= 1) {
 113           $message = $message ? "{$message} and " : '';
 114           $message .= ts("%1 pairs of duplicates were skipped due to conflict",
 115             array(1 => $skippedCount)
 116           );
 117         }
 118         $message .= ts(" during the batch merge process with safe mode.");
 119         CRM_Core_Session::setStatus($message, ts('Merge Complete'), 'success');
 120         $urlQry['action'] = 'update';
 121         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/dedupefind', $urlQry));
 122       }
 123       else {
 124         $urlQry['action'] = 'map';
 125         $urlQry['skipped'] = $skippedCount;
 126         $urlQry['merged'] = $mergedCount;
 127         CRM_Utils_System::jsRedirect(
 128           CRM_Utils_System::url('civicrm/contact/dedupefind', $urlQry),
 129           ts('Batch Merge Task in progress'),
 130           ts('The batch merge task is still in progress. This page will be refreshed automatically.')
 131         );
 132       }
 133     }
 134
 135     if ($action & CRM_Core_Action::UPDATE ||
 136       $action & CRM_Core_Action::BROWSE
 137     ) {
 138       $this->action = CRM_Core_Action::UPDATE;
 139
 140       $urlQry['snippet'] = 4;
 141       if ($isConflictMode) {
 142         $urlQry['selected'] = 1;
 143       }
 144
 145       $this->assign('sourceUrl', CRM_Utils_System::url('civicrm/ajax/dedupefind', $urlQry, FALSE, NULL, FALSE));
 146
 147       //reload from cache table
 148       $cacheKeyString = CRM_Dedupe_Merger::getMergeCacheKeyString($rgid, $gid, $criteria);
 149
 150       $stats = CRM_Dedupe_Merger::getMergeStatsMsg($cacheKeyString);
 151       if ($stats) {
 152         CRM_Core_Session::setStatus($stats);
 153         // reset so we not displaying same message again
 154         CRM_Dedupe_Merger::resetMergeStats($cacheKeyString);
 155       }
 156
 157       $this->_mainContacts = CRM_Dedupe_Merger::getDuplicatePairs($rgid, $gid, !$isConflictMode, 0, $isConflictMode, '', $isConflictMode, $criteria, TRUE);
 158
 159       if (empty($this->_mainContacts)) {
 160         if ($isConflictMode) {
 161           // if the current screen was intended to list only selected contacts, move back to full dupe list
 162           $urlQry['action'] = 'update';
 163           unset($urlQry['snippet']);
 164           CRM_Utils_System::redirect(CRM_Utils_System::url(CRM_Utils_System::currentPath(), $urlQry));
 165         }
 166         $ruleGroupName = civicrm_api3('RuleGroup', 'getvalue', array('id' => $rgid, 'return' => 'name'));
 167         CRM_Core_Session::singleton()->setStatus(ts('No possible duplicates were found using %1 rule.', array(1 => $ruleGroupName)), ts('None Found'), 'info');
 168         $url = CRM_Utils_System::url('civicrm/contact/deduperules', 'reset=1');
 169         if ($context == 'search') {
 170           $url = CRM_Core_Session::singleton()->readUserContext();
 171         }
 172         CRM_Utils_System::redirect($url);
 173       }
 174       else {
 175         $urlQry['action'] = 'update';
 176         if ($this->_cid) {
 177           $urlQry['cid'] = $this->_cid;
 178           CRM_Core_Session::singleton()->pushUserContext(CRM_Utils_System::url('civicrm/contact/deduperules',
 179             $urlQry
 180           ));
 181         }
 182         else {
 183           CRM_Core_Session::singleton()->pushUserContext(CRM_Utils_System::url('civicrm/contact/dedupefind',
 184             $urlQry
 185           ));
 186         }
 187       }
 188
 189       $this->assign('action', $this->action);
 190       $this->browse();
 191     }
 192     else {
 193       $this->action = CRM_Core_Action::UPDATE;
 194       $this->edit($this->action);
 195       $this->assign('action', $this->action);
 196     }
 197     $this->assign('context', $context);
 198
 199     return parent::run();
 200   }
 201
 202   /**
 203    * Browse all rule groups.
 204    */
 205   public function browse() {
 206     $this->assign('main_contacts', $this->_mainContacts);
 207
 208     if ($this->_cid) {
 209       $this->assign('cid', $this->_cid);
 210     }
 211     if (isset($this->_gid) || $this->_gid) {
 212       $this->assign('gid', $this->_gid);
 213     }
 214     $this->assign('rgid', $this->_rgid);
 215   }
 216
 217   /**
 218    * Get name of edit form.
 219    *
 220    * @return string
 221    *   classname of edit form
 222    */
 223   public function editForm() {
 224     return 'CRM_Contact_Form_DedupeFind';
 225   }
 226
 227   /**
 228    * Get edit form name.
 229    *
 230    * @return string
 231    *   name of this page
 232    */
 233   public function editName() {
 234     return 'DedupeFind';
 235   }
 236
 237   /**
 238    * Get user context.
 239    *
 240    * @param null $mode
 241    *
 242    * @return string
 243    *   user context
 244    */
 245   public function userContext($mode = NULL) {
 246     return 'civicrm/contact/dedupefind';
 247   }
 248
 249 }