CRM/Contact/Selector.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Class is to retrieve and display a range of contacts that match the given criteria.
  20  *
  21  * It is specifically for results of advanced search options.
  22  */
  23 class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  24
  25   const CACHE_SIZE = 500;
  26
  27   /**
  28    * This defines two actions- View and Edit.
  29    *
  30    * @var array
  31    */
  32   public static $_links = NULL;
  33
  34   /**
  35    * We use desc to remind us what that column is, name is used in the tpl
  36    *
  37    * @var array
  38    */
  39   public static $_columnHeaders;
  40
  41   /**
  42    * Properties of contact we're interested in displaying
  43    * @var array
  44    */
  45   public static $_properties = [
  46     'contact_id',
  47     'contact_type',
  48     'contact_sub_type',
  49     'sort_name',
  50     'street_address',
  51     'city',
  52     'state_province',
  53     'postal_code',
  54     'country',
  55     'geo_code_1',
  56     'geo_code_2',
  57     'is_deceased',
  58     'email',
  59     'on_hold',
  60     'phone',
  61     'status',
  62     'do_not_email',
  63     'do_not_phone',
  64     'do_not_mail',
  65   ];
  66
  67   /**
  68    * FormValues is the array returned by exportValues called on
  69    * the HTML_QuickForm_Controller for that page.
  70    *
  71    * @var array
  72    */
  73   public $_formValues;
  74
  75   /**
  76    * The contextMenu
  77    *
  78    * @var array
  79    */
  80   protected $_contextMenu;
  81
  82   /**
  83    * Params is the array in a value used by the search query creator
  84    *
  85    * @var array
  86    */
  87   public $_params;
  88
  89   /**
  90    * The return properties used for search
  91    *
  92    * @var array
  93    */
  94   protected $_returnProperties;
  95
  96   /**
  97    * Represent the type of selector
  98    *
  99    * @var int
 100    */
 101   protected $_action;
 102
 103   protected $_searchContext;
 104
 105   /**
 106    * Query object for this selector.
 107    *
 108    * @var CRM_Contact_BAO_Query
 109    */
 110   protected $_query;
 111
 112   /**
 113    * Get the query object for this selector.
 114    *
 115    * @return CRM_Contact_BAO_Query
 116    */
 117   public function getQueryObject() {
 118     return $this->_query;
 119   }
 120
 121   /**
 122    * Group id
 123    *
 124    * @var int
 125    */
 126   protected $_ufGroupID;
 127
 128   /**
 129    * The public visible fields to be shown to the user
 130    *
 131    * @var array
 132    */
 133   protected $_fields;
 134
 135   /**
 136    * Class constructor.
 137    *
 138    * @param $customSearchClass
 139    * @param array $formValues
 140    *   Array of form values imported.
 141    * @param array $params
 142    *   Array of parameters for query.
 143    * @param null $returnProperties
 144    * @param \const|int $action - action of search basic or advanced.
 145    *
 146    * @param bool $includeContactIds
 147    * @param bool $searchDescendentGroups
 148    * @param string $searchContext
 149    * @param null $contextMenu
 150    *
 151    * @return CRM_Contact_Selector
 152    */
 153   public function __construct(
 154     $customSearchClass,
 155     $formValues = NULL,
 156     $params = NULL,
 157     $returnProperties = NULL,
 158     $action = CRM_Core_Action::NONE,
 159     $includeContactIds = FALSE,
 160     $searchDescendentGroups = TRUE,
 161     $searchContext = 'search',
 162     $contextMenu = NULL
 163   ) {
 164     //don't build query constructor, if form is not submitted
 165     $force = CRM_Utils_Request::retrieve('force', 'Boolean');
 166     if (empty($formValues) && !$force) {
 167       return;
 168     }
 169
 170     // submitted form values
 171     $this->_formValues = &$formValues;
 172     $this->_params = &$params;
 173     $this->_returnProperties = &$returnProperties;
 174     $this->_contextMenu = &$contextMenu;
 175     $this->_context = $searchContext;
 176
 177     // type of selector
 178     $this->_action = $action;
 179
 180     $this->_searchContext = $searchContext;
 181
 182     $this->_ufGroupID = $this->_formValues['uf_group_id'] ?? NULL;
 183
 184     if ($this->_ufGroupID) {
 185       $this->_fields = CRM_Core_BAO_UFGroup::getListingFields(CRM_Core_Action::VIEW,
 186         CRM_Core_BAO_UFGroup::PUBLIC_VISIBILITY |
 187         CRM_Core_BAO_UFGroup::LISTINGS_VISIBILITY,
 188         FALSE, $this->_ufGroupID
 189       );
 190       self::$_columnHeaders = NULL;
 191
 192       $this->_customFields = CRM_Core_BAO_CustomField::getFieldsForImport('Individual');
 193
 194       $this->_returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($this->_fields);
 195       $this->_returnProperties['contact_type'] = 1;
 196       $this->_returnProperties['contact_sub_type'] = 1;
 197       $this->_returnProperties['sort_name'] = 1;
 198       if (!empty($this->_returnProperties['location']) && is_array($this->_returnProperties['location'])) {
 199         foreach ($this->_returnProperties['location'] as $key => $property) {
 200           if (!empty($property['email'])) {
 201             $this->_returnProperties['location'][$key]['on_hold'] = 1;
 202           }
 203         }
 204       }
 205     }
 206
 207     $displayRelationshipType = $this->_formValues['display_relationship_type'] ?? NULL;
 208     $operator = CRM_Utils_Array::value('operator', $this->_formValues, 'AND');
 209
 210     // rectify params to what proximity search expects if there is a value for prox_distance
 211     // CRM-7021
 212     if (!empty($this->_params)) {
 213       CRM_Contact_BAO_ProximityQuery::fixInputParams($this->_params);
 214     }
 215
 216     $this->_query = new CRM_Contact_BAO_Query(
 217       $this->_params,
 218       $this->_returnProperties,
 219       NULL,
 220       $includeContactIds,
 221       FALSE,
 222       CRM_Contact_BAO_Query::MODE_CONTACTS,
 223       FALSE,
 224       $searchDescendentGroups,
 225       FALSE,
 226       $displayRelationshipType,
 227       $operator
 228     );
 229
 230     $this->_options = &$this->_query->_options;
 231   }
 232
 233   /**
 234    * This method set cache key, later used in test environment
 235    *
 236    * @param string $key
 237    */
 238   public function setKey($key) {
 239     $this->_key = $key;
 240   }
 241
 242   /**
 243    * This method returns the links that are given for each search row.
 244    * currently the links added for each row are
 245    *
 246    * - View
 247    * - Edit
 248    *
 249    * @return array
 250    */
 251   public static function &links() {
 252     list($context, $contextMenu, $key) = func_get_args();
 253     $extraParams = ($key) ? "&key={$key}" : NULL;
 254     $searchContext = ($context) ? "&context=$context" : NULL;
 255
 256     if (!(self::$_links)) {
 257       self::$_links = [
 258         CRM_Core_Action::VIEW => [
 259           'name' => ts('View'),
 260           'url' => 'civicrm/contact/view',
 261           'class' => 'no-popup',
 262           'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
 263           'title' => ts('View Contact Details'),
 264           'ref' => 'view-contact',
 265         ],
 266         CRM_Core_Action::UPDATE => [
 267           'name' => ts('Edit'),
 268           'url' => 'civicrm/contact/add',
 269           'class' => 'no-popup',
 270           'qs' => "reset=1&action=update&cid=%%id%%{$searchContext}{$extraParams}",
 271           'title' => ts('Edit Contact Details'),
 272           'ref' => 'edit-contact',
 273         ],
 274       ];
 275
 276       $config = CRM_Core_Config::singleton();
 277       //CRM-16552: mapAPIKey is not mandatory as google no longer requires an API Key
 278       if ($config->mapProvider && ($config->mapAPIKey || $config->mapProvider == 'Google')) {
 279         self::$_links[CRM_Core_Action::MAP] = [
 280           'name' => ts('Map'),
 281           'url' => 'civicrm/contact/map',
 282           'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
 283           'title' => ts('Map Contact'),
 284         ];
 285       }
 286
 287       // Adding Context Menu Links in more action
 288       if ($contextMenu) {
 289         $counter = 7000;
 290         foreach ($contextMenu as $key => $value) {
 291           $contextVal = '&context=' . $value['key'];
 292           if ($value['key'] == 'delete') {
 293             $contextVal = $searchContext;
 294           }
 295           $url = "civicrm/contact/view/{$value['key']}";
 296           $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}";
 297           if ($value['key'] == 'activity') {
 298             $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}";
 299           }
 300           elseif ($value['key'] == 'email') {
 301             $url = "civicrm/contact/view/activity";
 302             $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}";
 303           }
 304
 305           self::$_links[$counter++] = [
 306             'name' => $value['title'],
 307             'url' => $url,
 308             'qs' => $qs,
 309             'title' => $value['title'],
 310             'ref' => $value['ref'],
 311             'class' => $value['class'] ?? NULL,
 312           ];
 313         }
 314       }
 315     }
 316     return self::$_links;
 317   }
 318
 319   /**
 320    * Getter for array of the parameters required for creating pager.
 321    *
 322    * @param $action
 323    * @param array $params
 324    */
 325   public function getPagerParams($action, &$params) {
 326     $params['status'] = ts('Contact %%StatusMessage%%');
 327     $params['csvString'] = NULL;
 328     $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 329
 330     $params['buttonTop'] = 'PagerTopButton';
 331     $params['buttonBottom'] = 'PagerBottomButton';
 332   }
 333
 334   /**
 335    * @param null $action
 336    * @param null $output
 337    *
 338    * @return array
 339    */
 340   public function &getColHeads($action = NULL, $output = NULL) {
 341     $colHeads = self::_getColumnHeaders();
 342     $colHeads[] = ['desc' => ts('Actions'), 'name' => ts('Action')];
 343     return $colHeads;
 344   }
 345
 346   /**
 347    * Returns the column headers as an array of tuples:
 348    * (name, sortName (key to the sort array))
 349    *
 350    * @param string $action
 351    *   The action being performed.
 352    * @param string $output
 353    *   What should the result set include (web/email/csv).
 354    *
 355    * @return array
 356    *   the column headers that need to be displayed
 357    */
 358   public function &getColumnHeaders($action = NULL, $output = NULL) {
 359     $headers = NULL;
 360
 361     // unset return property elements that we don't care
 362     if (!empty($this->_returnProperties)) {
 363       $doNotCareElements = [
 364         'contact_type',
 365         'contact_sub_type',
 366         'sort_name',
 367       ];
 368       foreach ($doNotCareElements as $value) {
 369         unset($this->_returnProperties[$value]);
 370       }
 371     }
 372
 373     if ($output == CRM_Core_Selector_Controller::EXPORT) {
 374       $csvHeaders = [ts('Contact ID'), ts('Contact Type')];
 375       foreach ($this->getColHeads($action, $output) as $column) {
 376         if (array_key_exists('name', $column)) {
 377           $csvHeaders[] = $column['name'];
 378         }
 379       }
 380       $headers = $csvHeaders;
 381     }
 382     elseif ($output == CRM_Core_Selector_Controller::SCREEN) {
 383       $csvHeaders = [ts('Name')];
 384       foreach ($this->getColHeads($action, $output) as $key => $column) {
 385         if (array_key_exists('name', $column) &&
 386           $column['name'] &&
 387           $column['name'] != ts('Name')
 388         ) {
 389           $csvHeaders[$key] = $column['name'];
 390         }
 391       }
 392       $headers = $csvHeaders;
 393     }
 394     elseif ($this->_ufGroupID) {
 395       // we dont use the cached value of column headers
 396       // since it potentially changed because of the profile selected
 397       static $skipFields = ['group', 'tag'];
 398       $direction = CRM_Utils_Sort::ASCENDING;
 399       $empty = TRUE;
 400       if (!self::$_columnHeaders) {
 401         self::$_columnHeaders = [
 402           ['name' => ''],
 403           [
 404             'name' => ts('Name'),
 405             'sort' => 'sort_name',
 406             'direction' => CRM_Utils_Sort::ASCENDING,
 407           ],
 408         ];
 409
 410         $locationTypes = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate');
 411
 412         foreach ($this->_fields as $name => $field) {
 413           if (!empty($field['in_selector']) &&
 414             !in_array($name, $skipFields)
 415           ) {
 416             if (strpos($name, '-') !== FALSE) {
 417               list($fieldName, $lType, $type) = CRM_Utils_System::explode('-', $name, 3);
 418
 419               if ($lType == 'Primary') {
 420                 $locationTypeName = 1;
 421               }
 422               else {
 423                 $locationTypeName = $locationTypes[$lType];
 424               }
 425
 426               if (in_array($fieldName, [
 427                 'phone',
 428                 'im',
 429                 'email',
 430               ])) {
 431                 if ($type) {
 432                   $name = "`$locationTypeName-$fieldName-$type`";
 433                 }
 434                 else {
 435                   $name = "`$locationTypeName-$fieldName`";
 436                 }
 437               }
 438               else {
 439                 $name = "`$locationTypeName-$fieldName`";
 440               }
 441             }
 442             //to handle sort key for Internal contactId.CRM-2289
 443             if ($name == 'id') {
 444               $name = 'contact_id';
 445             }
 446
 447             self::$_columnHeaders[] = [
 448               'name' => $field['title'],
 449               'sort' => $name,
 450               'direction' => $direction,
 451             ];
 452             $direction = CRM_Utils_Sort::DONTCARE;
 453             $empty = FALSE;
 454           }
 455         }
 456
 457         // if we dont have any valid columns, dont add the implicit ones
 458         // this allows the template to check on emptiness of column headers
 459         if ($empty) {
 460           self::$_columnHeaders = [];
 461         }
 462         else {
 463           self::$_columnHeaders[] = ['desc' => ts('Actions'), 'name' => ts('Action')];
 464         }
 465       }
 466       $headers = self::$_columnHeaders;
 467     }
 468     elseif (!empty($this->_returnProperties)) {
 469       self::$_columnHeaders = [
 470         ['name' => ''],
 471         [
 472           'name' => ts('Name'),
 473           'sort' => 'sort_name',
 474           'direction' => CRM_Utils_Sort::ASCENDING,
 475         ],
 476       ];
 477       $properties = self::makeProperties($this->_returnProperties);
 478
 479       foreach ($properties as $prop) {
 480         if (strpos($prop, '-')) {
 481           list($loc, $fld, $phoneType) = CRM_Utils_System::explode('-', $prop, 3);
 482           $title = $this->_query->_fields[$fld]['title'];
 483           if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) {
 484             $title .= "-{$phoneType}";
 485           }
 486           // fetch Location type label from name as $loc, which will be later used in column header
 487           $title .= sprintf(" (%s)",
 488             CRM_Core_PseudoConstant::getLabel(
 489               'CRM_Core_DAO_Address',
 490               'location_type_id',
 491               CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_Address', 'location_type_id', $loc)
 492             )
 493           );
 494
 495         }
 496         elseif (isset($this->_query->_fields[$prop]) && isset($this->_query->_fields[$prop]['title'])) {
 497           $title = $this->_query->_fields[$prop]['title'];
 498         }
 499         elseif (isset($this->_query->_pseudoConstantsSelect[$prop]) && isset($this->_query->_pseudoConstantsSelect[$prop]['pseudoconstant']['optionGroupName'])) {
 500           $title = CRM_Core_BAO_OptionGroup::getTitleByName($this->_query->_pseudoConstantsSelect[$prop]['pseudoconstant']['optionGroupName']);
 501         }
 502         else {
 503           $title = '';
 504         }
 505
 506         self::$_columnHeaders[] = ['name' => $title, 'sort' => $prop];
 507       }
 508       self::$_columnHeaders[] = ['name' => ts('Actions')];
 509       $headers = self::$_columnHeaders;
 510     }
 511     else {
 512       $headers = $this->getColHeads($action, $output);
 513     }
 514
 515     return $headers;
 516   }
 517
 518   /**
 519    * Returns total number of rows for the query.
 520    *
 521    * @param int $action
 522    *
 523    * @return int
 524    *   Total number of rows
 525    */
 526   public function getTotalCount($action) {
 527     // Use count from cache during paging/sorting
 528     if (!empty($_GET['crmPID']) || !empty($_GET['crmSID'])) {
 529       $count = Civi::cache('long')->get("Search Results Count $this->_key");
 530     }
 531     if (empty($count)) {
 532       $count = $this->_query->searchQuery(0, 0, NULL, TRUE);
 533       Civi::cache('long')->set("Search Results Count $this->_key", $count);
 534     }
 535     return $count;
 536   }
 537
 538   /**
 539    * Returns all the rows in the given offset and rowCount.
 540    *
 541    * @param string $action
 542    *   The action being performed.
 543    * @param int $offset
 544    *   The row number to start from.
 545    * @param int $rowCount
 546    *   The number of rows to return.
 547    * @param string $sort
 548    *   The sql string that describes the sort order.
 549    * @param string $output
 550    *   What should the result set include (web/email/csv).
 551    *
 552    * @return int
 553    *   the total number of rows for this action
 554    */
 555   public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 556     if (($output == CRM_Core_Selector_Controller::EXPORT ||
 557         $output == CRM_Core_Selector_Controller::SCREEN
 558       ) &&
 559       $this->_formValues['radio_ts'] == 'ts_sel'
 560     ) {
 561       $includeContactIds = TRUE;
 562     }
 563     else {
 564       $includeContactIds = FALSE;
 565     }
 566
 567     // note the formvalues were given by CRM_Contact_Form_Search to us
 568     // and contain the search criteria (parameters)
 569     // note that the default action is basic
 570     if ($rowCount) {
 571       /** @var CRM_Core_PrevNextCache_Interface $prevNext */
 572       $prevNext = Civi::service('prevnext');
 573       $cacheKey = $this->buildPrevNextCache($sort);
 574       $cids = $prevNext->fetch($cacheKey, $offset, $rowCount);
 575       $resultSet = empty($cids) ? [] : $this->_query->getCachedContacts($cids, $includeContactIds)->fetchGenerator();
 576     }
 577     else {
 578       $resultSet = $this->_query->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds)->fetchGenerator();
 579     }
 580
 581     // process the result of the query
 582     $rows = [];
 583     $permissions = [CRM_Core_Permission::getPermission()];
 584     if (CRM_Core_Permission::check('delete contacts')) {
 585       $permissions[] = CRM_Core_Permission::DELETE;
 586     }
 587     $mask = CRM_Core_Action::mask($permissions);
 588
 589     // mask value to hide map link if there are not lat/long
 590     $mapMask = $mask & 4095;
 591
 592     if ($this->_searchContext == 'smog') {
 593       $gc = CRM_Core_SelectValues::groupContactStatus();
 594     }
 595
 596     if ($this->_ufGroupID) {
 597       $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 598
 599       $names = [];
 600       static $skipFields = ['group', 'tag'];
 601       foreach ($this->_fields as $key => $field) {
 602         if (!empty($field['in_selector']) &&
 603           !in_array($key, $skipFields)
 604         ) {
 605           if (strpos($key, '-') !== FALSE) {
 606             list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $key, 3);
 607
 608             if ($id == 'Primary') {
 609               $locationTypeName = 1;
 610             }
 611             elseif ($fieldName == 'url') {
 612               $locationTypeName = "website-{$id}";
 613             }
 614             else {
 615               $locationTypeName = $locationTypes[$id] ?? NULL;
 616               if (!$locationTypeName) {
 617                 continue;
 618               }
 619             }
 620
 621             $locationTypeName = str_replace(' ', '_', $locationTypeName);
 622             if (in_array($fieldName, [
 623               'phone',
 624               'im',
 625               'email',
 626             ])) {
 627               if ($type) {
 628                 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
 629               }
 630               else {
 631                 $names[] = "{$locationTypeName}-{$fieldName}";
 632               }
 633             }
 634             else {
 635               $names[] = "{$locationTypeName}-{$fieldName}";
 636             }
 637           }
 638           else {
 639             $names[] = $field['name'];
 640           }
 641         }
 642       }
 643
 644       $names[] = "status";
 645     }
 646     elseif (!empty($this->_returnProperties)) {
 647       $names = self::makeProperties($this->_returnProperties);
 648     }
 649     else {
 650       $names = self::$_properties;
 651     }
 652
 653     $links = self::links($this->_context, $this->_contextMenu, $this->_key);
 654
 655     //check explicitly added contact to a Smart Group.
 656     $groupID = $this->_formValues['group'] ?? NULL;
 657
 658     $pseudoconstants = [];
 659     // for CRM-3157 purposes
 660     if (in_array('world_region', $names)) {
 661       $pseudoconstants['world_region'] = [
 662         'dbName' => 'worldregion_id',
 663         'values' => CRM_Core_PseudoConstant::worldRegion(),
 664       ];
 665     }
 666
 667     foreach ($resultSet as $result) {
 668       $row = [];
 669       $this->_query->convertToPseudoNames($result);
 670       // the columns we are interested in
 671       foreach ($names as $property) {
 672         if ($property == 'status') {
 673           continue;
 674         }
 675         if ($cfID = CRM_Core_BAO_CustomField::getKeyID($property)) {
 676           $row[$property] = CRM_Core_BAO_CustomField::displayValue(
 677             $result->$property,
 678             $cfID,
 679             $result->contact_id
 680           );
 681         }
 682         elseif (strpos($property, '-im')) {
 683           $row[$property] = $result->$property;
 684           if (!empty($result->$property)) {
 685             $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
 686             $providerId = $property . "-provider_id";
 687             $providerName = $imProviders[$result->$providerId];
 688             $row[$property] = $result->$property . " ({$providerName})";
 689           }
 690         }
 691         elseif (in_array($property, [
 692           'addressee',
 693           'email_greeting',
 694           'postal_greeting',
 695         ])) {
 696           $greeting = $property . '_display';
 697           $row[$property] = $result->$greeting;
 698         }
 699         elseif (isset($pseudoconstants[$property])) {
 700           $row[$property] = CRM_Utils_Array::value(
 701             $result->{$pseudoconstants[$property]['dbName']},
 702             $pseudoconstants[$property]['values']
 703           );
 704         }
 705         elseif (strpos($property, '-url') !== FALSE) {
 706           $websiteUrl = '';
 707           $websiteKey = str_replace('-url', '', $property);
 708           $propertyArray = explode('-', $property);
 709           $websiteFld = $websiteKey . '-' . array_pop($propertyArray);
 710           if (!empty($result->$websiteFld)) {
 711             $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id');
 712             $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}];
 713             $websiteValue = $result->$websiteFld;
 714             $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue}  ({$websiteType})</a>";
 715           }
 716           $row[$property] = $websiteUrl;
 717         }
 718         elseif (strpos($property, '-email') !== FALSE) {
 719           list($locType) = explode("-email", $property);
 720           $onholdProperty = "{$locType}-on_hold";
 721
 722           $row[$property] = $result->$property ?? NULL;
 723           if (!empty($row[$property]) && !empty($result->$onholdProperty)) {
 724             $row[$property] .= " (On Hold)";
 725           }
 726         }
 727         else {
 728           $row[$property] = $result->$property ?? NULL;
 729         }
 730       }
 731
 732       if (!empty($result->postal_code_suffix)) {
 733         $row['postal_code'] .= "-" . $result->postal_code_suffix;
 734       }
 735
 736       if ($output != CRM_Core_Selector_Controller::EXPORT &&
 737         $this->_searchContext == 'smog'
 738       ) {
 739         if (empty($result->status) &&
 740           $groupID
 741         ) {
 742           $contactID = $result->contact_id;
 743           if ($contactID) {
 744             $gcParams = [
 745               'contact_id' => $contactID,
 746               'group_id' => $groupID,
 747             ];
 748
 749             $gcDefaults = [];
 750             CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults);
 751
 752             if (empty($gcDefaults)) {
 753               $row['status'] = ts('Smart');
 754             }
 755             else {
 756               $row['status'] = $gc[$gcDefaults['status']];
 757             }
 758           }
 759           else {
 760             $row['status'] = NULL;
 761           }
 762         }
 763         else {
 764           $row['status'] = $gc[$result->status];
 765         }
 766       }
 767
 768       if ($output != CRM_Core_Selector_Controller::EXPORT) {
 769         $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contact_id;
 770
 771         if (!empty($this->_formValues['deleted_contacts']) && CRM_Core_Permission::check('access deleted contacts')
 772         ) {
 773           $links = [
 774             [
 775               'name' => ts('View'),
 776               'url' => 'civicrm/contact/view',
 777               'qs' => 'reset=1&cid=%%id%%',
 778               'class' => 'no-popup',
 779               'title' => ts('View Contact Details'),
 780             ],
 781             [
 782               'name' => ts('Restore'),
 783               'url' => 'civicrm/contact/view/delete',
 784               'qs' => 'reset=1&cid=%%id%%&restore=1',
 785               'title' => ts('Restore Contact'),
 786             ],
 787           ];
 788           if (CRM_Core_Permission::check('delete contacts')) {
 789             $links[] = [
 790               'name' => ts('Delete Permanently'),
 791               'url' => 'civicrm/contact/view/delete',
 792               'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
 793               'title' => ts('Permanently Delete Contact'),
 794             ];
 795           }
 796           $row['action'] = CRM_Core_Action::formLink(
 797             $links,
 798             NULL,
 799             ['id' => $result->contact_id],
 800             ts('more'),
 801             FALSE,
 802             'contact.selector.row',
 803             'Contact',
 804             $result->contact_id
 805           );
 806         }
 807         elseif ((is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) ||
 808           (!empty($row['city']) && !empty($row['state_province']))
 809         ) {
 810           $row['action'] = CRM_Core_Action::formLink(
 811             $links,
 812             $mask,
 813             ['id' => $result->contact_id],
 814             ts('more'),
 815             FALSE,
 816             'contact.selector.row',
 817             'Contact',
 818             $result->contact_id
 819           );
 820         }
 821         else {
 822           $row['action'] = CRM_Core_Action::formLink(
 823             $links,
 824             $mapMask,
 825             ['id' => $result->contact_id],
 826             ts('more'),
 827             FALSE,
 828             'contact.selector.row',
 829             'Contact',
 830             $result->contact_id
 831           );
 832         }
 833
 834         // allow components to add more actions
 835         CRM_Core_Component::searchAction($row, $result->contact_id);
 836
 837         $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type,
 838           FALSE,
 839           $result->contact_id
 840         );
 841
 842         $row['contact_type_orig'] = $result->contact_sub_type ? $result->contact_sub_type : $result->contact_type;
 843         $row['contact_id'] = $result->contact_id;
 844         $row['sort_name'] = $result->sort_name;
 845         // Surely this if should be if NOT - otherwise it's just wierd.
 846         if (array_key_exists('id', $row)) {
 847           $row['id'] = $result->contact_id;
 848         }
 849       }
 850
 851       $rows[$row['contact_id']] = $row;
 852     }
 853
 854     return $rows;
 855   }
 856
 857   /**
 858    * @param CRM_Utils_Sort $sort
 859    *
 860    * @return string
 861    */
 862   public function buildPrevNextCache($sort) {
 863     $cacheKey = 'civicrm search ' . $this->_key;
 864
 865     // We should clear the cache in following conditions:
 866     // 1. when starting from scratch, i.e new search
 867     // 2. if records are sorted
 868
 869     // get current page requested
 870     $pageNum = CRM_Utils_Request::retrieve('crmPID', 'Integer');
 871
 872     // get the current sort order
 873     $currentSortID = CRM_Utils_Request::retrieve('crmSID', 'String');
 874
 875     $session = CRM_Core_Session::singleton();
 876
 877     // get previous sort id
 878     $previousSortID = $session->get('previousSortID');
 879
 880     // check for current != previous to ensure cache is not reset if paging is done without changing
 881     // sort criteria
 882     if (!$pageNum || (!empty($currentSortID) && $currentSortID != $previousSortID)) {
 883       Civi::service('prevnext')->deleteItem(NULL, $cacheKey, 'civicrm_contact');
 884       // this means it's fresh search, so set pageNum=1
 885       if (!$pageNum) {
 886         $pageNum = 1;
 887       }
 888     }
 889
 890     // set the current sort as previous sort
 891     if (!empty($currentSortID)) {
 892       $session->set('previousSortID', $currentSortID);
 893     }
 894
 895     $pageSize = CRM_Utils_Request::retrieve('crmRowCount', 'Integer', CRM_Core_DAO::$_nullObject, FALSE, 50);
 896     $firstRecord = ($pageNum - 1) * $pageSize;
 897
 898     //for alphabetic pagination selection save
 899     $sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String');
 900
 901     //for text field pagination selection save
 902     $countRow = Civi::service('prevnext')->getCount($cacheKey);
 903     // $sortByCharacter triggers a refresh in the prevNext cache
 904     if ($sortByCharacter && $sortByCharacter != 'all') {
 905       $this->fillupPrevNextCache($sort, $cacheKey, 0, max(self::CACHE_SIZE, $pageSize));
 906     }
 907     elseif (($firstRecord + $pageSize) >= $countRow) {
 908       $this->fillupPrevNextCache($sort, $cacheKey, $countRow, max(self::CACHE_SIZE, $pageSize) + $firstRecord - $countRow);
 909     }
 910     return $cacheKey;
 911   }
 912
 913   /**
 914    * @param $rows
 915    */
 916   public function addActions(&$rows) {
 917
 918     $basicPermissions = CRM_Core_Permission::check('delete contacts') ? [CRM_Core_Permission::DELETE] : [];
 919
 920     // get permissions on an individual level (CRM-12645)
 921     // @todo look at storing this to the session as this is called twice during search results render.
 922     $can_edit_list = CRM_Contact_BAO_Contact_Permission::allowList(array_keys($rows), CRM_Core_Permission::EDIT);
 923
 924     $links_template = self::links($this->_context, $this->_contextMenu, $this->_key);
 925
 926     foreach ($rows as $id => & $row) {
 927       $links = $links_template;
 928       if (in_array($id, $can_edit_list)) {
 929         $mask = CRM_Core_Action::mask(array_merge([CRM_Core_Permission::EDIT], $basicPermissions));
 930       }
 931       else {
 932         $mask = CRM_Core_Action::mask(array_merge([CRM_Core_Permission::VIEW], $basicPermissions));
 933       }
 934
 935       if ((!is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) &&
 936         (empty($row['city']) || empty($row['state_province']))
 937       ) {
 938         $mask = $mask & 4095;
 939       }
 940
 941       if (!empty($this->_formValues['deleted_contacts']) && CRM_Core_Permission::check('access deleted contacts')
 942       ) {
 943         $links = [
 944           [
 945             'name' => ts('View'),
 946             'url' => 'civicrm/contact/view',
 947             'qs' => 'reset=1&cid=%%id%%',
 948             'class' => 'no-popup',
 949             'title' => ts('View Contact Details'),
 950           ],
 951           [
 952             'name' => ts('Restore'),
 953             'url' => 'civicrm/contact/view/delete',
 954             'qs' => 'reset=1&cid=%%id%%&restore=1',
 955             'title' => ts('Restore Contact'),
 956           ],
 957         ];
 958         if (CRM_Core_Permission::check('delete contacts')) {
 959           $links[] = [
 960             'name' => ts('Delete Permanently'),
 961             'url' => 'civicrm/contact/view/delete',
 962             'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
 963             'title' => ts('Permanently Delete Contact'),
 964           ];
 965         }
 966         $row['action'] = CRM_Core_Action::formLink(
 967           $links,
 968           NULL,
 969           ['id' => $row['contact_id']],
 970           ts('more'),
 971           FALSE,
 972           'contact.selector.actions',
 973           'Contact',
 974           $row['contact_id']
 975         );
 976       }
 977       else {
 978         $row['action'] = CRM_Core_Action::formLink(
 979           $links,
 980           $mask,
 981           ['id' => $row['contact_id']],
 982           ts('more'),
 983           FALSE,
 984           'contact.selector.actions',
 985           'Contact',
 986           $row['contact_id']
 987         );
 988       }
 989
 990       // allow components to add more actions
 991       CRM_Core_Component::searchAction($row, $row['contact_id']);
 992
 993       if (!empty($row['contact_type_orig'])) {
 994         $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($row['contact_type_orig'],
 995           FALSE, $row['contact_id']);
 996       }
 997     }
 998   }
 999
1000   /**
1001    * @param $rows
1002    */
1003   public function removeActions(&$rows) {
1004     foreach ($rows as $rid => & $rValue) {
1005       unset($rValue['contact_type']);
1006       unset($rValue['action']);
1007     }
1008   }
1009
1010   /**
1011    * @param CRM_Utils_Sort $sort
1012    * @param string $cacheKey
1013    * @param int $start
1014    * @param int $end
1015    *
1016    * @throws \CRM_Core_Exception
1017    */
1018   public function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = self::CACHE_SIZE) {
1019     $coreSearch = TRUE;
1020     // For custom searches, use the contactIDs method
1021     if (is_a($this, 'CRM_Contact_Selector_Custom')) {
1022       $sql = $this->_search->contactIDs($start, $end, $sort, TRUE);
1023       $coreSearch = FALSE;
1024     }
1025     // For core searches use the searchQuery method
1026     else {
1027       $sql = $this->_query->getSearchSQL($start, $end, $sort, FALSE, $this->_query->_includeContactIds,
1028         FALSE, TRUE);
1029     }
1030
1031     // CRM-9096
1032     // due to limitations in our search query writer, the above query does not work
1033     // in cases where the query is being sorted on a non-contact table
1034     // this results in a fatal error :(
1035     // see below for the gross hack of trapping the error and not filling
1036     // the prev next cache in this situation
1037     // the other alternative of running the FULL query will just be incredibly inefficient
1038     // and slow things down way too much on large data sets / complex queries
1039
1040     $selectSQL = CRM_Core_DAO::composeQuery("SELECT DISTINCT %1, contact_a.id, contact_a.sort_name", [1 => [$cacheKey, 'String']]);
1041
1042     $sql = str_ireplace(['SELECT contact_a.id as contact_id', 'SELECT contact_a.id as id'], $selectSQL, $sql);
1043     $sql = str_ireplace('ORDER BY `contact_id`', 'ORDER BY `id`', $sql, $sql);
1044
1045     try {
1046       Civi::service('prevnext')->fillWithSql($cacheKey, $sql);
1047     }
1048     catch (CRM_Core_Exception $e) {
1049       if ($coreSearch) {
1050         // in the case of error, try rebuilding cache using full sql which is used for search selector display
1051         // this fixes the bugs reported in CRM-13996 & CRM-14438
1052         $this->rebuildPreNextCache($start, $end, $sort, $cacheKey);
1053       }
1054       else {
1055         CRM_Core_Error::deprecatedFunctionWarning('Custom searches should return sql capable of filling the prevnext cache.');
1056         // This will always show for CiviRules :-( as a) it orders by 'rule_label'
1057         // which is not available in the query & b) it uses contact not contact_a
1058         // as an alias.
1059         // CRM_Core_Session::setStatus(ts('Query Failed'));
1060         return;
1061       }
1062     }
1063
1064     if (Civi::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql) {
1065       // SQL-backed prevnext cache uses an extra record for pruning the cache.
1066       // Also ensure that caches stay alive for 2 days as per previous code
1067       Civi::cache('prevNextCache')->set($cacheKey, $cacheKey, 60 * 60 * 24 * CRM_Core_PrevNextCache_Sql::cacheDays);
1068     }
1069   }
1070
1071   /**
1072    * called to rebuild prev next cache using full sql in case of core search ( excluding custom search)
1073    *
1074    * @param int $start
1075    *   Start for limit clause.
1076    * @param int $end
1077    *   End for limit clause.
1078    * @param CRM_Utils_Sort $sort
1079    * @param string $cacheKey
1080    *   Cache key.
1081    */
1082   public function rebuildPreNextCache($start, $end, $sort, $cacheKey) {
1083     // generate full SQL
1084     $sql = $this->_query->searchQuery($start, $end, $sort, FALSE, $this->_query->_includeContactIds,
1085       FALSE, FALSE, TRUE);
1086
1087     $dao = CRM_Core_DAO::executeQuery($sql);
1088
1089     // build insert query, note that currently we build cache for 500 (self::CACHE_SIZE) contact records at a time, hence below approach
1090     $rows = [];
1091     while ($dao->fetch()) {
1092       $rows[] = [
1093         'entity_table' => 'civicrm_contact',
1094         'entity_id1' => $dao->contact_id,
1095         'entity_id2' => $dao->contact_id,
1096         'data' => $dao->sort_name,
1097       ];
1098     }
1099
1100     Civi::service('prevnext')->fillWithArray($cacheKey, $rows);
1101   }
1102
1103   /**
1104    * @inheritDoc
1105    */
1106   public function getQILL() {
1107     return $this->_query->qill();
1108   }
1109
1110   /**
1111    * Name of export file.
1112    *
1113    * @param string $output
1114    *   Type of output.
1115    *
1116    * @return string
1117    *   name of the file
1118    */
1119   public function getExportFileName($output = 'csv') {
1120     return ts('CiviCRM Contact Search');
1121   }
1122
1123   /**
1124    * Get colunmn headers for search selector.
1125    *
1126    * @return array
1127    */
1128   private static function &_getColumnHeaders() {
1129     if (!isset(self::$_columnHeaders)) {
1130       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
1131         'address_options', TRUE, NULL, TRUE
1132       );
1133
1134       self::$_columnHeaders = [
1135         'contact_type' => ['desc' => ts('Contact Type')],
1136         'sort_name' => [
1137           'name' => ts('Name'),
1138           'sort' => 'sort_name',
1139           'direction' => CRM_Utils_Sort::ASCENDING,
1140         ],
1141       ];
1142
1143       $defaultAddress = [
1144         'street_address' => ['name' => ts('Address')],
1145         'city' => [
1146           'name' => ts('City'),
1147           'sort' => 'city',
1148           'direction' => CRM_Utils_Sort::DONTCARE,
1149         ],
1150         'state_province' => [
1151           'name' => ts('State'),
1152           'sort' => 'state_province',
1153           'direction' => CRM_Utils_Sort::DONTCARE,
1154         ],
1155         'postal_code' => [
1156           'name' => ts('Postal'),
1157           'sort' => 'postal_code',
1158           'direction' => CRM_Utils_Sort::DONTCARE,
1159         ],
1160         'country' => [
1161           'name' => ts('Country'),
1162           'sort' => 'country',
1163           'direction' => CRM_Utils_Sort::DONTCARE,
1164         ],
1165       ];
1166
1167       foreach ($defaultAddress as $columnName => $column) {
1168         if (!empty($addressOptions[$columnName])) {
1169           self::$_columnHeaders[$columnName] = $column;
1170         }
1171       }
1172
1173       self::$_columnHeaders['email'] = [
1174         'name' => ts('Email'),
1175         'sort' => 'email',
1176         'direction' => CRM_Utils_Sort::DONTCARE,
1177       ];
1178
1179       self::$_columnHeaders['phone'] = ['name' => ts('Phone')];
1180     }
1181     return self::$_columnHeaders;
1182   }
1183
1184   /**
1185    * @return CRM_Contact_BAO_Query
1186    */
1187   public function getQuery() {
1188     return $this->_query;
1189   }
1190
1191   /**
1192    * @return CRM_Contact_DAO_Contact
1193    */
1194   public function alphabetQuery() {
1195     return $this->_query->alphabetQuery();
1196   }
1197
1198   /**
1199    * @param array $params
1200    * @param int $sortID
1201    * @param null $displayRelationshipType
1202    * @param string $queryOperator
1203    *
1204    * @return CRM_Contact_DAO_Contact
1205    */
1206   public function contactIDQuery($params, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
1207     $sortOrder = &$this->getSortOrder($this->_action);
1208     $sort = new CRM_Utils_Sort($sortOrder, $sortID);
1209
1210     // rectify params to what proximity search expects if there is a value for prox_distance
1211     // CRM-7021 CRM-7905
1212     if (!empty($params)) {
1213       CRM_Contact_BAO_ProximityQuery::fixInputParams($params);
1214     }
1215
1216     if (!$displayRelationshipType) {
1217       $query = new CRM_Contact_BAO_Query($params,
1218         CRM_Contact_BAO_Query::NO_RETURN_PROPERTIES,
1219         NULL, FALSE, FALSE, 1,
1220         FALSE, TRUE, TRUE, NULL,
1221         $queryOperator
1222       );
1223     }
1224     else {
1225       $query = new CRM_Contact_BAO_Query($params,
1226         CRM_Contact_BAO_Query::NO_RETURN_PROPERTIES,
1227         NULL, FALSE, FALSE, 1,
1228         FALSE, TRUE, TRUE, $displayRelationshipType,
1229         $queryOperator
1230       );
1231     }
1232     return $query->searchQuery(0, 0, $sort);
1233   }
1234
1235   /**
1236    * @param $returnProperties
1237    *
1238    * @return array
1239    */
1240   public function &makeProperties(&$returnProperties) {
1241     $properties = [];
1242     foreach ($returnProperties as $name => $value) {
1243       if ($name != 'location') {
1244         // special handling for group and tag
1245         if (in_array($name, ['group', 'tag'])) {
1246           $name = "{$name}s";
1247         }
1248
1249         // special handling for notes
1250         if (in_array($name, ['note', 'note_subject', 'note_body'])) {
1251           $name = "notes";
1252         }
1253
1254         $properties[] = $name;
1255       }
1256       else {
1257         // extract all the location stuff
1258         foreach ($value as $n => $v) {
1259           foreach ($v as $n1 => $v1) {
1260             if (!strpos('_id', $n1) && $n1 != 'location_type') {
1261               $n = str_replace(' ', '_', $n);
1262               $properties[] = "{$n}-{$n1}";
1263             }
1264           }
1265         }
1266       }
1267     }
1268     return $properties;
1269   }
1270
1271 }