CRM/Contact/Page/AJAX.php

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