CRM/Contact/Page/AJAX.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  *
  33  */
  34
  35 /**
  36  * This class contains all contact related functions that are called using AJAX (jQuery)
  37  */
  38 class CRM_Contact_Page_AJAX {
  39   /**
  40    * When a user chooses a username, CHECK_USERNAME_TTL
  41    * is the time window in which they can check usernames
  42    * (without reloading the overall form).
  43    */
  44   const CHECK_USERNAME_TTL = 10800; // 3hr; 3*60*60
  45
  46   const AUTOCOMPLETE_TTL = 21600; // 6hr; 6*60*60
  47
  48   /**
  49    * Ajax callback for custom fields of type ContactReference
  50    *
  51    * Todo: Migrate contact reference fields to use EntityRef
  52    */
  53   public static function contactReference() {
  54     $name = CRM_Utils_Array::value('term', $_GET);
  55     $name = CRM_Utils_Type::escape($name, 'String');
  56     $cfID = CRM_Utils_Type::escape($_GET['id'], 'Positive');
  57
  58     // check that this is a valid, active custom field of Contact Reference type
  59     $params = array('id' => $cfID);
  60     $returnProperties = array('filter', 'data_type', 'is_active');
  61     $cf = array();
  62     CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $cf, $returnProperties);
  63     if (!$cf['id'] || !$cf['is_active'] || $cf['data_type'] != 'ContactReference') {
  64       CRM_Utils_System::civiExit('error');
  65     }
  66
  67     if (!empty($cf['filter'])) {
  68       $filterParams = array();
  69       parse_str($cf['filter'], $filterParams);
  70
  71       $action = CRM_Utils_Array::value('action', $filterParams);
  72       if (!empty($action) && !in_array($action, array('get', 'lookup'))) {
  73         CRM_Utils_System::civiExit('error');
  74       }
  75
  76       if (!empty($filterParams['group'])) {
  77         $filterParams['group'] = explode(',', $filterParams['group']);
  78       }
  79     }
  80
  81     $list = array_keys(CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  82       'contact_reference_options'
  83     ), '1');
  84
  85     $return = array_unique(array_merge(array('sort_name'), $list));
  86
  87     $limit = Civi::settings()->get('search_autocomplete_count');
  88
  89     $params = array('offset' => 0, 'rowCount' => $limit, 'version' => 3);
  90     foreach ($return as $fld) {
  91       $params["return.{$fld}"] = 1;
  92     }
  93
  94     if (!empty($action)) {
  95       $excludeGet = array(
  96         'reset',
  97         'key',
  98         'className',
  99         'fnName',
 100         'json',
 101         'reset',
 102         'context',
 103         'timestamp',
 104         'limit',
 105         'id',
 106         's',
 107         'q',
 108         'action',
 109       );
 110       foreach ($_GET as $param => $val) {
 111         if (empty($val) ||
 112           in_array($param, $excludeGet) ||
 113           strpos($param, 'return.') !== FALSE ||
 114           strpos($param, 'api.') !== FALSE
 115         ) {
 116           continue;
 117         }
 118         $params[$param] = $val;
 119       }
 120     }
 121
 122     if ($name) {
 123       $params['sort_name'] = $name;
 124     }
 125
 126     $params['sort'] = 'sort_name';
 127
 128     // tell api to skip permission chk. dgg
 129     $params['check_permissions'] = 0;
 130
 131     // add filter variable to params
 132     if (!empty($filterParams)) {
 133       $params = array_merge($params, $filterParams);
 134     }
 135
 136     $contact = civicrm_api('Contact', 'Get', $params);
 137
 138     if (!empty($contact['is_error'])) {
 139       CRM_Utils_System::civiExit('error');
 140     }
 141
 142     $contactList = array();
 143     foreach ($contact['values'] as $value) {
 144       $view = array();
 145       foreach ($return as $fld) {
 146         if (!empty($value[$fld])) {
 147           $view[] = $value[$fld];
 148         }
 149       }
 150       $contactList[] = array('id' => $value['id'], 'text' => implode(' :: ', $view));
 151     }
 152
 153     if (!empty($_GET['is_unit_test'])) {
 154       return $contactList;
 155     }
 156     CRM_Utils_JSON::output($contactList);
 157   }
 158
 159   /**
 160    * Fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title
 161    */
 162   public static function getPCPList() {
 163     $name = CRM_Utils_Array::value('term', $_GET);
 164     $name = CRM_Utils_Type::escape($name, 'String');
 165     $limit = $max = Civi::settings()->get('search_autocomplete_count');
 166
 167     $where = ' AND pcp.page_id = cp.id AND pcp.contact_id = cc.id';
 168
 169     $config = CRM_Core_Config::singleton();
 170     if ($config->includeWildCardInName) {
 171       $strSearch = "%$name%";
 172     }
 173     else {
 174       $strSearch = "$name%";
 175     }
 176     $includeEmailFrom = $includeNickName = '';
 177     if ($config->includeNickNameInName) {
 178       $includeNickName = " OR nick_name LIKE '$strSearch'";
 179     }
 180     if ($config->includeEmailInName) {
 181       $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
 182       $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 183     }
 184     else {
 185       $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 186     }
 187
 188     $offset = $count = 0;
 189     if (!empty($_GET['page_num'])) {
 190       $page = (int) $_GET['page_num'];
 191       $offset = $limit * ($page - 1);
 192       $limit++;
 193     }
 194
 195     $select = 'cc.sort_name, pcp.title, cp.title';
 196     $query = "
 197         SELECT id, data
 198         FROM (
 199             SELECT pcp.id as id, CONCAT_WS( ' :: ', {$select} ) as data, sort_name
 200             FROM civicrm_pcp pcp, civicrm_contribution_page cp, civicrm_contact cc
 201             {$includeEmailFrom}
 202             {$whereClause} AND pcp.page_type = 'contribute'
 203             UNION ALL
 204             SELECT pcp.id as id, CONCAT_WS( ' :: ', {$select} ) as data, sort_name
 205             FROM civicrm_pcp pcp, civicrm_event cp, civicrm_contact cc
 206             {$includeEmailFrom}
 207             {$whereClause} AND pcp.page_type = 'event'
 208             ) t
 209         ORDER BY sort_name
 210         LIMIT $offset, $limit
 211         ";
 212
 213     $dao = CRM_Core_DAO::executeQuery($query);
 214     $output = array('results' => array(), 'more' => FALSE);
 215     while ($dao->fetch()) {
 216       if (++$count > $max) {
 217         $output['more'] = TRUE;
 218       }
 219       else {
 220         $output['results'][] = array('id' => $dao->id, 'text' => $dao->data);
 221       }
 222     }
 223     CRM_Utils_JSON::output($output);
 224   }
 225
 226   public static function relationship() {
 227     $relType = CRM_Utils_Request::retrieve('rel_type', 'String', CRM_Core_DAO::$_nullObject, TRUE);
 228     $relContactID = CRM_Utils_Request::retrieve('rel_contact', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
 229     $originalCid = CRM_Utils_Request::retrieve('cid', 'Positive');
 230     $relationshipID = CRM_Utils_Request::retrieve('rel_id', 'Positive');
 231     $caseID = CRM_Utils_Request::retrieve('case_id', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
 232
 233     if (!CRM_Case_BAO_Case::accessCase($caseID)) {
 234       CRM_Utils_System::permissionDenied();
 235     }
 236
 237     $ret = array('is_error' => 0);
 238
 239     list($relTypeId, $b, $a) = explode('_', $relType);
 240
 241     if ($relationshipID && $originalCid) {
 242       CRM_Case_BAO_Case::endCaseRole($caseID, $a, $originalCid, $relTypeId);
 243     }
 244
 245     $clientList = CRM_Case_BAO_Case::getCaseClients($caseID);
 246
 247     // Loop through multiple case clients
 248     foreach ($clientList as $i => $sourceContactID) {
 249       try {
 250         $result = civicrm_api3('relationship', 'create', array(
 251           'case_id' => $caseID,
 252           'relationship_type_id' => $relTypeId,
 253           "contact_id_$a" => $relContactID,
 254           "contact_id_$b" => $sourceContactID,
 255           'start_date' => 'now',
 256         ));
 257       }
 258       catch (CiviCRM_API3_Exception $e) {
 259         $ret['is_error'] = 1;
 260         $ret['error_message'] = $e->getMessage();
 261       }
 262       // Save activity only for the primary (first) client
 263       if ($i == 0 && empty($result['is_error'])) {
 264         CRM_Case_BAO_Case::createCaseRoleActivity($caseID, $result['id'], $relContactID, $sourceContactID);
 265       }
 266     }
 267     if (!empty($_REQUEST['is_unit_test'])) {
 268       return $ret;
 269     }
 270
 271     CRM_Utils_JSON::output($ret);
 272   }
 273
 274   /**
 275    * Fetch the custom field help.
 276    */
 277   public static function customField() {
 278     $fieldId = CRM_Utils_Type::escape($_REQUEST['id'], 'Integer');
 279     $params = array('id' => $fieldId);
 280     $returnProperties = array('help_pre', 'help_post');
 281     $values = array();
 282
 283     CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $values, $returnProperties);
 284     CRM_Utils_JSON::output($values);
 285   }
 286
 287   public static function groupTree() {
 288     CRM_Utils_System::setHttpHeader('Content-Type', 'application/json');
 289     $gids = CRM_Utils_Type::escape($_GET['gids'], 'String');
 290     echo CRM_Contact_BAO_GroupNestingCache::json($gids);
 291     CRM_Utils_System::civiExit();
 292   }
 293
 294   /**
 295    * Delete custom value.
 296    */
 297   public static function deleteCustomValue() {
 298     CRM_Utils_System::setHttpHeader('Content-Type', 'text/plain');
 299     $customValueID = CRM_Utils_Type::escape($_REQUEST['valueID'], 'Positive');
 300     $customGroupID = CRM_Utils_Type::escape($_REQUEST['groupID'], 'Positive');
 301     $contactId = CRM_Utils_Request::retrieve('contactId', 'Positive');
 302     CRM_Core_BAO_CustomValue::deleteCustomValue($customValueID, $customGroupID);
 303     if ($contactId) {
 304       echo CRM_Contact_BAO_Contact::getCountComponent('custom_' . $customGroupID, $contactId);
 305     }
 306
 307     CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 308     CRM_Utils_System::civiExit();
 309   }
 310
 311   /**
 312    *  check the CMS username.
 313    */
 314   static public function checkUserName() {
 315     $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), array('for', 'ts'));
 316     $sig = CRM_Utils_Request::retrieve('sig', 'String');
 317     $for = CRM_Utils_Request::retrieve('for', 'String');
 318     if (
 319       CRM_Utils_Time::getTimeRaw() > $_REQUEST['ts'] + self::CHECK_USERNAME_TTL
 320       || $for != 'civicrm/ajax/cmsuser'
 321       || !$signer->validate($sig, $_REQUEST)
 322     ) {
 323       $user = array('name' => 'error');
 324       CRM_Utils_JSON::output($user);
 325     }
 326
 327     $config = CRM_Core_Config::singleton();
 328     $username = trim(CRM_Utils_Array::value('cms_name', $_REQUEST));
 329
 330     $params = array('name' => $username);
 331
 332     $errors = array();
 333     $config->userSystem->checkUserNameEmailExists($params, $errors);
 334
 335     if (isset($errors['cms_name']) || isset($errors['name'])) {
 336       //user name is not available
 337       $user = array('name' => 'no');
 338       CRM_Utils_JSON::output($user);
 339     }
 340     else {
 341       //user name is available
 342       $user = array('name' => 'yes');
 343       CRM_Utils_JSON::output($user);
 344     }
 345
 346     // Not reachable: JSON::output() above exits.
 347     CRM_Utils_System::civiExit();
 348   }
 349
 350   /**
 351    *  Function to get email address of a contact.
 352    */
 353   public static function getContactEmail() {
 354     if (!empty($_REQUEST['contact_id'])) {
 355       $contactID = CRM_Utils_Type::escape($_REQUEST['contact_id'], 'Positive');
 356       if (!CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::EDIT)) {
 357         return;
 358       }
 359       list($displayName,
 360         $userEmail
 361         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactID);
 362
 363       CRM_Utils_System::setHttpHeader('Content-Type', 'text/plain');
 364       if ($userEmail) {
 365         echo $userEmail;
 366       }
 367     }
 368     else {
 369       $noemail = CRM_Utils_Array::value('noemail', $_GET);
 370       $queryString = NULL;
 371       $name = CRM_Utils_Array::value('name', $_GET);
 372       if ($name) {
 373         $name = CRM_Utils_Type::escape($name, 'String');
 374         if ($noemail) {
 375           $queryString = " cc.sort_name LIKE '%$name%'";
 376         }
 377         else {
 378           $queryString = " ( cc.sort_name LIKE '%$name%' OR ce.email LIKE '%$name%' ) ";
 379         }
 380       }
 381       else {
 382         $cid = CRM_Utils_Array::value('cid', $_GET);
 383         if ($cid) {
 384           //check cid for integer
 385           $contIDS = explode(',', $cid);
 386           foreach ($contIDS as $contID) {
 387             CRM_Utils_Type::escape($contID, 'Integer');
 388           }
 389           $queryString = " cc.id IN ( $cid )";
 390         }
 391       }
 392
 393       if ($queryString) {
 394         $result = array();
 395         $offset = CRM_Utils_Array::value('offset', $_GET, 0);
 396         $rowCount = Civi::settings()->get('search_autocomplete_count');
 397
 398         $offset = CRM_Utils_Type::escape($offset, 'Int');
 399
 400         // add acl clause here
 401         list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('cc');
 402         if ($aclWhere) {
 403           $aclWhere = " AND $aclWhere";
 404         }
 405         if ($noemail) {
 406           $query = "
 407 SELECT sort_name name, cc.id
 408 FROM civicrm_contact cc
 409      {$aclFrom}
 410 WHERE cc.is_deceased = 0 AND {$queryString}
 411       {$aclWhere}
 412 LIMIT {$offset}, {$rowCount}
 413 ";
 414
 415           // send query to hook to be modified if needed
 416           CRM_Utils_Hook::contactListQuery($query,
 417             $name,
 418             CRM_Utils_Request::retrieve('context', 'String'),
 419             CRM_Utils_Request::retrieve('cid', 'Positive')
 420           );
 421
 422           $dao = CRM_Core_DAO::executeQuery($query);
 423           while ($dao->fetch()) {
 424             $result[] = array(
 425               'id' => $dao->id,
 426               'text' => $dao->name,
 427             );
 428           }
 429         }
 430         else {
 431           $query = "
 432 SELECT sort_name name, ce.email, cc.id
 433 FROM   civicrm_email ce INNER JOIN civicrm_contact cc ON cc.id = ce.contact_id
 434        {$aclFrom}
 435 WHERE  ce.on_hold = 0 AND cc.is_deceased = 0 AND cc.do_not_email = 0 AND {$queryString}
 436        {$aclWhere}
 437 LIMIT {$offset}, {$rowCount}
 438 ";
 439
 440           // send query to hook to be modified if needed
 441           CRM_Utils_Hook::contactListQuery($query,
 442             $name,
 443             CRM_Utils_Request::retrieve('context', 'String'),
 444             CRM_Utils_Request::retrieve('cid', 'Positive')
 445           );
 446
 447           $dao = CRM_Core_DAO::executeQuery($query);
 448
 449           while ($dao->fetch()) {
 450             //working here
 451             $result[] = array(
 452               'text' => '"' . $dao->name . '" <' . $dao->email . '>',
 453               'id' => (CRM_Utils_Array::value('id', $_GET)) ? "{$dao->id}::{$dao->email}" : '"' . $dao->name . '" <' . $dao->email . '>',
 454             );
 455           }
 456         }
 457         CRM_Utils_JSON::output($result);
 458       }
 459     }
 460     CRM_Utils_System::civiExit();
 461   }
 462
 463   public static function getContactPhone() {
 464
 465     $queryString = NULL;
 466     //check for mobile type
 467     $phoneTypes = CRM_Core_OptionGroup::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
 468     $mobileType = CRM_Utils_Array::value('Mobile', $phoneTypes);
 469
 470     $name = CRM_Utils_Array::value('name', $_GET);
 471     if ($name) {
 472       $name = CRM_Utils_Type::escape($name, 'String');
 473       $queryString = " ( cc.sort_name LIKE '%$name%' OR cp.phone LIKE '%$name%' ) ";
 474     }
 475     else {
 476       $cid = CRM_Utils_Array::value('cid', $_GET);
 477       if ($cid) {
 478         //check cid for integer
 479         $contIDS = explode(',', $cid);
 480         foreach ($contIDS as $contID) {
 481           CRM_Utils_Type::escape($contID, 'Integer');
 482         }
 483         $queryString = " cc.id IN ( $cid )";
 484       }
 485     }
 486
 487     if ($queryString) {
 488       $result = array();
 489       $offset = CRM_Utils_Array::value('offset', $_GET, 0);
 490       $rowCount = CRM_Utils_Array::value('rowcount', $_GET, 20);
 491
 492       $offset = CRM_Utils_Type::escape($offset, 'Int');
 493       $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
 494
 495       // add acl clause here
 496       list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('cc');
 497       if ($aclWhere) {
 498         $aclWhere = " AND $aclWhere";
 499       }
 500
 501       $query = "
 502 SELECT sort_name name, cp.phone, cc.id
 503 FROM   civicrm_phone cp INNER JOIN civicrm_contact cc ON cc.id = cp.contact_id
 504        {$aclFrom}
 505 WHERE  cc.is_deceased = 0 AND cc.do_not_sms = 0 AND cp.phone_type_id = {$mobileType} AND {$queryString}
 506        {$aclWhere}
 507 LIMIT {$offset}, {$rowCount}
 508 ";
 509
 510       // send query to hook to be modified if needed
 511       CRM_Utils_Hook::contactListQuery($query,
 512         $name,
 513         CRM_Utils_Request::retrieve('context', 'String'),
 514         CRM_Utils_Request::retrieve('cid', 'Positive')
 515       );
 516
 517       $dao = CRM_Core_DAO::executeQuery($query);
 518
 519       while ($dao->fetch()) {
 520         $result[] = array(
 521           'text' => '"' . $dao->name . '" (' . $dao->phone . ')',
 522           'id' => (CRM_Utils_Array::value('id', $_GET)) ? "{$dao->id}::{$dao->phone}" : '"' . $dao->name . '" <' . $dao->phone . '>',
 523         );
 524       }
 525       CRM_Utils_JSON::output($result);
 526     }
 527     CRM_Utils_System::civiExit();
 528   }
 529
 530
 531   public static function buildSubTypes() {
 532     $parent = CRM_Utils_Request::retrieve('parentId', 'Positive');
 533
 534     switch ($parent) {
 535       case 1:
 536         $contactType = 'Individual';
 537         break;
 538
 539       case 2:
 540         $contactType = 'Household';
 541         break;
 542
 543       case 4:
 544         $contactType = 'Organization';
 545         break;
 546     }
 547
 548     $subTypes = CRM_Contact_BAO_ContactType::subTypePairs($contactType, FALSE, NULL);
 549     asort($subTypes);
 550     CRM_Utils_JSON::output($subTypes);
 551   }
 552
 553   public static function buildDedupeRules() {
 554     $parent = CRM_Utils_Request::retrieve('parentId', 'Positive');
 555
 556     switch ($parent) {
 557       case 1:
 558         $contactType = 'Individual';
 559         break;
 560
 561       case 2:
 562         $contactType = 'Household';
 563         break;
 564
 565       case 4:
 566         $contactType = 'Organization';
 567         break;
 568     }
 569
 570     $dedupeRules = CRM_Dedupe_BAO_RuleGroup::getByType($contactType);
 571
 572     CRM_Utils_JSON::output($dedupeRules);
 573   }
 574
 575   /**
 576    * Function used for CiviCRM dashboard operations.
 577    */
 578   public static function dashboard() {
 579     switch ($_REQUEST['op']) {
 580       case 'save_columns':
 581         CRM_Core_BAO_Dashboard::saveDashletChanges($_REQUEST['columns']);
 582         break;
 583
 584       case 'delete_dashlet':
 585         $dashletID = CRM_Utils_Type::escape($_REQUEST['dashlet_id'], 'Positive');
 586         CRM_Core_BAO_Dashboard::deleteDashlet($dashletID);
 587     }
 588
 589     CRM_Utils_System::civiExit();
 590   }
 591
 592   /**
 593    * Retrieve signature based on email id.
 594    */
 595   public static function getSignature() {
 596     $emailID = CRM_Utils_Type::escape($_REQUEST['emailID'], 'Positive');
 597     $query = "SELECT signature_text, signature_html FROM civicrm_email WHERE id = {$emailID}";
 598     $dao = CRM_Core_DAO::executeQuery($query);
 599
 600     $signatures = array();
 601     while ($dao->fetch()) {
 602       $signatures = array(
 603         'signature_text' => $dao->signature_text,
 604         'signature_html' => $dao->signature_html,
 605       );
 606     }
 607
 608     CRM_Utils_JSON::output($signatures);
 609   }
 610
 611   /**
 612    * Process dupes.
 613    */
 614   public static function processDupes() {
 615     $oper = CRM_Utils_Type::escape($_REQUEST['op'], 'String');
 616     $cid = CRM_Utils_Type::escape($_REQUEST['cid'], 'Positive');
 617     $oid = CRM_Utils_Type::escape($_REQUEST['oid'], 'Positive');
 618
 619     if (!$oper || !$cid || !$oid) {
 620       return;
 621     }
 622
 623     $exception = new CRM_Dedupe_DAO_Exception();
 624     $exception->contact_id1 = $cid;
 625     $exception->contact_id2 = $oid;
 626     //make sure contact2 > contact1.
 627     if ($cid > $oid) {
 628       $exception->contact_id1 = $oid;
 629       $exception->contact_id2 = $cid;
 630     }
 631     $exception->find(TRUE);
 632     $status = NULL;
 633     if ($oper == 'dupe-nondupe') {
 634       $status = $exception->save();
 635     }
 636     if ($oper == 'nondupe-dupe') {
 637       $status = $exception->delete();
 638     }
 639
 640     CRM_Utils_JSON::output(array('status' => ($status) ? $oper : $status));
 641   }
 642
 643   /**
 644    * Retrieve list of duplicate pairs from cache table.
 645    */
 646   public static function getDedupes() {
 647     $offset    = isset($_REQUEST['start']) ? CRM_Utils_Type::escape($_REQUEST['start'], 'Integer') : 0;
 648     $rowCount  = isset($_REQUEST['length']) ? CRM_Utils_Type::escape($_REQUEST['length'], 'Integer') : 25;
 649
 650     $gid = CRM_Utils_Request::retrieve('gid', 'Positive');
 651     $rgid = CRM_Utils_Request::retrieve('rgid', 'Positive');
 652     $null = NULL;
 653     $criteria = CRM_Utils_Request::retrieve('criteria', 'Json', $null, FALSE, '{}');
 654     $selected = CRM_Utils_Request::retrieveValue('selected', 'Boolean');
 655     if ($rowCount < 0) {
 656       $rowCount = 0;
 657     }
 658
 659     $whereClause = $orderByClause = '';
 660     $cacheKeyString   = CRM_Dedupe_Merger::getMergeCacheKeyString($rgid, $gid, json_decode($criteria, TRUE));
 661
 662     $searchRows       = array();
 663
 664     $searchParams = self::getSearchOptionsFromRequest();
 665     $queryParams = array();
 666
 667     $join  = '';
 668     $where = array();
 669
 670     $isOrQuery = self::isOrQuery();
 671
 672     $nextParamKey = 3;
 673     $mappings = array(
 674       'dst' => 'cc1.display_name',
 675       'src' => 'cc2.display_name',
 676       'dst_email' => 'ce1.email',
 677       'src_email' => 'ce2.email',
 678       'dst_postcode' => 'ca1.postal_code',
 679       'src_postcode' => 'ca2.postal_code',
 680       'dst_street' => 'ca1.street',
 681       'src_street' => 'ca2.street',
 682     );
 683
 684     foreach ($mappings as $key => $dbName) {
 685       if (!empty($searchParams[$key])) {
 686         // CRM-18694.
 687         $wildcard = strstr($key, 'postcode') ? '' : '%';
 688         $queryParams[$nextParamKey] = array($wildcard . $searchParams[$key] . '%', 'String');
 689         $where[] = $dbName . " LIKE %{$nextParamKey} ";
 690         $nextParamKey++;
 691       }
 692     }
 693
 694     if ($isOrQuery) {
 695       $whereClause   = ' ( ' . implode(' OR ', $where) . ' ) ';
 696     }
 697     else {
 698       if (!empty($where)) {
 699         $whereClause  = implode(' AND ', $where);
 700       }
 701     }
 702     $whereClause .= $whereClause ? ' AND de.id IS NULL' : ' de.id IS NULL';
 703
 704     if ($selected) {
 705       $whereClause .= ' AND pn.is_selected = 1';
 706     }
 707     $join .= CRM_Dedupe_Merger::getJoinOnDedupeTable();
 708
 709     $select = array(
 710       'cc1.contact_type'     => 'dst_contact_type',
 711       'cc1.display_name'     => 'dst_display_name',
 712       'cc1.contact_sub_type' => 'dst_contact_sub_type',
 713       'cc2.contact_type'     => 'src_contact_type',
 714       'cc2.display_name'     => 'src_display_name',
 715       'cc2.contact_sub_type' => 'src_contact_sub_type',
 716       'ce1.email'            => 'dst_email',
 717       'ce2.email'            => 'src_email',
 718       'ca1.postal_code'      => 'dst_postcode',
 719       'ca2.postal_code'      => 'src_postcode',
 720       'ca1.street_address'   => 'dst_street',
 721       'ca2.street_address'   => 'src_street',
 722     );
 723
 724     if ($select) {
 725       $join .= " INNER JOIN civicrm_contact cc1 ON cc1.id = pn.entity_id1";
 726       $join .= " INNER JOIN civicrm_contact cc2 ON cc2.id = pn.entity_id2";
 727       $join .= " LEFT JOIN civicrm_email ce1 ON (ce1.contact_id = pn.entity_id1 AND ce1.is_primary = 1 )";
 728       $join .= " LEFT JOIN civicrm_email ce2 ON (ce2.contact_id = pn.entity_id2 AND ce2.is_primary = 1 )";
 729       $join .= " LEFT JOIN civicrm_address ca1 ON (ca1.contact_id = pn.entity_id1 AND ca1.is_primary = 1 )";
 730       $join .= " LEFT JOIN civicrm_address ca2 ON (ca2.contact_id = pn.entity_id2 AND ca2.is_primary = 1 )";
 731     }
 732     $iTotal = CRM_Core_BAO_PrevNextCache::getCount($cacheKeyString, $join, $whereClause, '=', $queryParams);
 733     if (!empty($_REQUEST['order'])) {
 734       foreach ($_REQUEST['order'] as $orderInfo) {
 735         if (!empty($orderInfo['column'])) {
 736           $orderColumnNumber = $orderInfo['column'];
 737           $dir = $orderInfo['dir'];
 738         }
 739       }
 740       $columnDetails = CRM_Utils_Array::value($orderColumnNumber, $_REQUEST['columns']);
 741     }
 742     if (!empty($columnDetails)) {
 743       switch ($columnDetails['data']) {
 744         case 'src':
 745           $orderByClause = " ORDER BY cc2.display_name {$dir}";
 746           break;
 747
 748         case 'src_email':
 749           $orderByClause = " ORDER BY ce2.email {$dir}";
 750           break;
 751
 752         case 'src_street':
 753           $orderByClause = " ORDER BY ca2.street_address {$dir}";
 754           break;
 755
 756         case 'src_postcode':
 757           $orderByClause = " ORDER BY ca2.postal_code {$dir}";
 758           break;
 759
 760         case 'dst':
 761           $orderByClause = " ORDER BY cc1.display_name {$dir}";
 762           break;
 763
 764         case 'dst_email':
 765           $orderByClause = " ORDER BY ce1.email {$dir}";
 766           break;
 767
 768         case 'dst_street':
 769           $orderByClause = " ORDER BY ca1.street_address {$dir}";
 770           break;
 771
 772         case 'dst_postcode':
 773           $orderByClause = " ORDER BY ca1.postal_code {$dir}";
 774           break;
 775
 776         default:
 777           $orderByClause = " ORDER BY cc1.display_name ASC";
 778           break;
 779       }
 780     }
 781
 782     $dupePairs = CRM_Core_BAO_PrevNextCache::retrieve($cacheKeyString, $join, $whereClause, $offset, $rowCount, $select, $orderByClause, TRUE, $queryParams);
 783     $iFilteredTotal = CRM_Core_DAO::singleValueQuery("SELECT FOUND_ROWS()");
 784
 785     $count = 0;
 786     foreach ($dupePairs as $key => $pairInfo) {
 787       $pair = $pairInfo['data'];
 788       $srcContactSubType  = CRM_Utils_Array::value('src_contact_sub_type', $pairInfo);
 789       $dstContactSubType  = CRM_Utils_Array::value('dst_contact_sub_type', $pairInfo);
 790       $srcTypeImage = CRM_Contact_BAO_Contact_Utils::getImage($srcContactSubType ?
 791         $srcContactSubType : $pairInfo['src_contact_type'],
 792         FALSE,
 793         $pairInfo['entity_id2']
 794       );
 795       $dstTypeImage = CRM_Contact_BAO_Contact_Utils::getImage($dstContactSubType ?
 796         $dstContactSubType : $pairInfo['dst_contact_type'],
 797         FALSE,
 798         $pairInfo['entity_id1']
 799       );
 800
 801       $searchRows[$count]['is_selected'] = $pairInfo['is_selected'];
 802       $searchRows[$count]['is_selected_input'] = "<input type='checkbox' class='crm-dedupe-select' name='pnid_{$pairInfo['prevnext_id']}' value='{$pairInfo['is_selected']}' onclick='toggleDedupeSelect(this)'>";
 803       $searchRows[$count]['src_image'] = $srcTypeImage;
 804       $searchRows[$count]['src'] = CRM_Utils_System::href($pair['srcName'], 'civicrm/contact/view', "reset=1&cid={$pairInfo['entity_id2']}");
 805       $searchRows[$count]['src_email'] = CRM_Utils_Array::value('src_email', $pairInfo);
 806       $searchRows[$count]['src_street'] = CRM_Utils_Array::value('src_street', $pairInfo);
 807       $searchRows[$count]['src_postcode'] = CRM_Utils_Array::value('src_postcode', $pairInfo);
 808       $searchRows[$count]['dst_image'] = $dstTypeImage;
 809       $searchRows[$count]['dst'] = CRM_Utils_System::href($pair['dstName'], 'civicrm/contact/view', "reset=1&cid={$pairInfo['entity_id1']}");
 810       $searchRows[$count]['dst_email'] = CRM_Utils_Array::value('dst_email', $pairInfo);
 811       $searchRows[$count]['dst_street'] = CRM_Utils_Array::value('dst_street', $pairInfo);
 812       $searchRows[$count]['dst_postcode'] = CRM_Utils_Array::value('dst_postcode', $pairInfo);
 813       $searchRows[$count]['conflicts'] = str_replace("',", "',<br/>", CRM_Utils_Array::value('conflicts', $pair));
 814       $searchRows[$count]['weight'] = CRM_Utils_Array::value('weight', $pair);
 815
 816       if (!empty($pairInfo['data']['canMerge'])) {
 817         $mergeParams = [
 818           'reset' => 1,
 819             'cid' => $pairInfo['entity_id1'],
 820             'oid' => $pairInfo['entity_id2'],
 821             'action' => 'update',
 822             'rgid' => $rgid,
 823             'criteria' => $criteria,
 824             'limit' => CRM_Utils_Request::retrieve('limit', 'Integer'),
 825           ];
 826         if ($gid) {
 827           $mergeParams['gid'] = $gid;
 828         }
 829
 830         $searchRows[$count]['actions']  = "<a class='crm-dedupe-flip' href='#' data-pnid={$pairInfo['prevnext_id']}>" . ts('flip') . "</a>&nbsp;|&nbsp;";
 831         $searchRows[$count]['actions'] .= CRM_Utils_System::href(ts('merge'), 'civicrm/contact/merge', $mergeParams);
 832         $searchRows[$count]['actions'] .= "&nbsp;|&nbsp;<a id='notDuplicate' href='#' onClick=\"processDupes( {$pairInfo['entity_id1']}, {$pairInfo['entity_id2']}, 'dupe-nondupe', 'dupe-listing'); return false;\">" . ts('not a duplicate') . "</a>";
 833       }
 834       else {
 835         $searchRows[$count]['actions'] = '<em>' . ts('Insufficient access rights - cannot merge') . '</em>';
 836       }
 837       $count++;
 838     }
 839
 840     $dupePairs = array(
 841       'data'            => $searchRows,
 842       'recordsTotal'    => $iTotal,
 843       'recordsFiltered' => $iFilteredTotal,
 844     );
 845     if (!empty($_REQUEST['is_unit_test'])) {
 846       return $dupePairs;
 847     }
 848     CRM_Utils_JSON::output($dupePairs);
 849   }
 850
 851   /**
 852    * Get the searchable options from the request.
 853    *
 854    * @return array
 855    */
 856   public static function getSearchOptionsFromRequest() {
 857     $searchParams = array();
 858     $searchData = CRM_Utils_Array::value('search', $_REQUEST);
 859     $searchData['value'] = CRM_Utils_Type::escape($searchData['value'], 'String');
 860     $selectorElements = array(
 861       'is_selected',
 862       'is_selected_input',
 863       'src_image',
 864       'src',
 865       'src_email',
 866       'src_street',
 867       'src_postcode',
 868       'dst_image',
 869       'dst',
 870       'dst_email',
 871       'dst_street',
 872       'dst_postcode',
 873       'conflicts',
 874       'weight',
 875       'actions',
 876     );
 877     $columns = $_REQUEST['columns'];
 878
 879     foreach ($columns as $column) {
 880       if (!empty($column['search']['value']) && in_array($column['data'], $selectorElements)) {
 881         $searchParams[$column['data']] = CRM_Utils_Type::escape($column['search']['value'], 'String');
 882       }
 883       elseif (!empty($searchData['value'])) {
 884         $searchParams[$column['data']] = $searchData['value'];
 885       }
 886     }
 887     return $searchParams;
 888   }
 889
 890   /**
 891    * Is the query an OR query.
 892    *
 893    * If a generic search value is passed in - ie. $_REQUEST['search']['value'] = 'abc'
 894    * then all fields are searched for this.
 895    *
 896    * It is unclear if there is any code that still passes this in or whether is is just legacy. It
 897    * could cause a server-killing query on a large site so it probably is NOT in use if we haven't
 898    * had complaints.
 899    *
 900    * @return bool
 901    */
 902   public static function isOrQuery() {
 903     $searchData = CRM_Utils_Array::value('search', $_REQUEST);
 904     return !empty($searchData['value']);
 905   }
 906
 907   /**
 908    * Retrieve a PDF Page Format for the PDF Letter form.
 909    */
 910   public function pdfFormat() {
 911     $formatId = CRM_Utils_Type::escape($_REQUEST['formatId'], 'Integer');
 912
 913     $pdfFormat = CRM_Core_BAO_PdfFormat::getById($formatId);
 914
 915     CRM_Utils_JSON::output($pdfFormat);
 916   }
 917
 918   /**
 919    * Retrieve Paper Size dimensions.
 920    */
 921   public static function paperSize() {
 922     $paperSizeName = CRM_Utils_Type::escape($_REQUEST['paperSizeName'], 'String');
 923
 924     $paperSize = CRM_Core_BAO_PaperSize::getByName($paperSizeName);
 925
 926     CRM_Utils_JSON::output($paperSize);
 927   }
 928
 929   /**
 930    * Swap contacts in a dupe pair i.e main with duplicate contact.
 931    *
 932    * @param int $prevNextId
 933    */
 934   public static function flipDupePairs($prevNextId = NULL) {
 935     if (!$prevNextId) {
 936       // @todo figure out if this is always POST & specify that rather than inexact GET
 937       $prevNextId = CRM_Utils_Request::retrieve('pnid', 'Integer');
 938     }
 939
 940     $onlySelected = FALSE;
 941     if (is_array($prevNextId) && !CRM_Utils_Array::crmIsEmptyArray($prevNextId)) {
 942       $onlySelected = TRUE;
 943     }
 944     $prevNextId = CRM_Utils_Type::escapeAll((array) $prevNextId, 'Positive');
 945     CRM_Core_BAO_PrevNextCache::flipPair($prevNextId, $onlySelected);
 946     CRM_Utils_System::civiExit();
 947   }
 948
 949   /**
 950    * Used to store selected contacts across multiple pages in advanced search.
 951    */
 952   public static function selectUnselectContacts() {
 953     $name = CRM_Utils_Array::value('name', $_REQUEST);
 954     $cacheKey = CRM_Utils_Array::value('qfKey', $_REQUEST);
 955     $state = CRM_Utils_Array::value('state', $_REQUEST, 'checked');
 956     $variableType = CRM_Utils_Array::value('variableType', $_REQUEST, 'single');
 957
 958     $actionToPerform = CRM_Utils_Array::value('action', $_REQUEST, 'select');
 959
 960     if ($variableType == 'multiple') {
 961       // action post value only works with multiple type variable
 962       if ($name) {
 963         //multiple names like mark_x_1-mark_x_2 where 1,2 are cids
 964         $elements = explode('-', $name);
 965         foreach ($elements as $key => $element) {
 966           $elements[$key] = self::_convertToId($element);
 967         }
 968         CRM_Utils_Type::escapeAll($elements, 'Integer');
 969         CRM_Core_BAO_PrevNextCache::markSelection($cacheKey, $actionToPerform, $elements);
 970       }
 971       else {
 972         CRM_Core_BAO_PrevNextCache::markSelection($cacheKey, $actionToPerform);
 973       }
 974     }
 975     elseif ($variableType == 'single') {
 976       $cId = self::_convertToId($name);
 977       CRM_Utils_Type::escape($cId, 'Integer');
 978       $action = ($state == 'checked') ? 'select' : 'unselect';
 979       CRM_Core_BAO_PrevNextCache::markSelection($cacheKey, $action, $cId);
 980     }
 981     $contactIds = CRM_Core_BAO_PrevNextCache::getSelection($cacheKey);
 982     $countSelectionCids = count($contactIds[$cacheKey]);
 983
 984     $arrRet = array('getCount' => $countSelectionCids);
 985     CRM_Utils_JSON::output($arrRet);
 986   }
 987
 988   /**
 989    * @param string $name
 990    *
 991    * @return string
 992    */
 993   public static function _convertToId($name) {
 994     if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
 995       $cId = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
 996     }
 997     return $cId;
 998   }
 999
1000   public static function getAddressDisplay() {
1001     $contactId = CRM_Utils_Request::retrieve('contact_id', 'Positive');
1002     if (!$contactId) {
1003       $addressVal["error_message"] = "no contact id found";
1004     }
1005     else {
1006       $entityBlock = array(
1007         'contact_id' => $contactId,
1008         'entity_id' => $contactId,
1009       );
1010       $addressVal = CRM_Core_BAO_Address::getValues($entityBlock);
1011     }
1012
1013     CRM_Utils_JSON::output($addressVal);
1014   }
1015
1016   /**
1017    * Mark dupe pairs as selected from un-selected state or vice-versa, in dupe cache table.
1018    */
1019   public static function toggleDedupeSelect() {
1020     $pnid = $_REQUEST['pnid'];
1021     $isSelected = CRM_Utils_Type::escape($_REQUEST['is_selected'], 'Boolean');
1022     $cacheKeyString = CRM_Utils_Request::retrieve('cacheKey', 'Alphanumeric', $null, FALSE);
1023
1024     $params = array(
1025       1 => array($isSelected, 'Boolean'),
1026       3 => array("$cacheKeyString%", 'String'), // using % to address rows with conflicts as well
1027     );
1028
1029     //check pnid is_array or integer
1030     $whereClause = NULL;
1031     if (is_array($pnid) && !CRM_Utils_Array::crmIsEmptyArray($pnid)) {
1032       CRM_Utils_Type::escapeAll($pnid, 'Positive');
1033       $pnid = implode(', ', $pnid);
1034       $whereClause = " id IN ( {$pnid} ) ";
1035     }
1036     else {
1037       $pnid = CRM_Utils_Type::escape($pnid, 'Integer');
1038       $whereClause = " id = %2";
1039       $params[2]   = array($pnid, 'Integer');
1040     }
1041
1042     $sql = "UPDATE civicrm_prevnext_cache SET is_selected = %1 WHERE {$whereClause} AND cacheKey LIKE %3";
1043     CRM_Core_DAO::executeQuery($sql, $params);
1044
1045     CRM_Utils_System::civiExit();
1046   }
1047
1048   /**
1049    * Retrieve contact relationships.
1050    */
1051   public static function getContactRelationships() {
1052     $contactID = CRM_Utils_Type::escape($_GET['cid'], 'Integer');
1053     $context = CRM_Utils_Type::escape($_GET['context'], 'String');
1054     $relationship_type_id = CRM_Utils_Type::escape(CRM_Utils_Array::value('relationship_type_id', $_GET), 'Integer', FALSE);
1055
1056     if (!CRM_Contact_BAO_Contact_Permission::allow($contactID)) {
1057       return CRM_Utils_System::permissionDenied();
1058     }
1059
1060     $params = CRM_Core_Page_AJAX::defaultSortAndPagerParams();
1061
1062     $params['contact_id'] = $contactID;
1063     $params['context'] = $context;
1064     if ($relationship_type_id) {
1065       $params['relationship_type_id'] = $relationship_type_id;
1066     }
1067
1068     // get the contact relationships
1069     $relationships = CRM_Contact_BAO_Relationship::getContactRelationshipSelector($params);
1070
1071     CRM_Utils_JSON::output($relationships);
1072   }
1073
1074 }