CRM/Contact/Page/AJAX.php

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