CRM/Contact/Selector.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class is used to retrieve and display a range of
  38  * contacts that match the given criteria (specifically for
  39  * results of advanced search options.
  40  *
  41  */
  42 class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  43
  44   /**
  45    * This defines two actions- View and Edit.
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_links = NULL;
  51
  52   /**
  53    * we use desc to remind us what that column is, name is used in the tpl
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_columnHeaders;
  59
  60   /**
  61    * Properties of contact we're interested in displaying
  62    * @var array
  63    * @static
  64    */
  65   static $_properties = array(
  66     'contact_id', 'contact_type', 'contact_sub_type',
  67     'sort_name', 'street_address',
  68     'city', 'state_province', 'postal_code', 'country',
  69     'geo_code_1', 'geo_code_2', 'is_deceased',
  70     'email', 'on_hold', 'phone', 'status',
  71     'do_not_email', 'do_not_phone', 'do_not_mail',
  72   );
  73
  74   /**
  75    * formValues is the array returned by exportValues called on
  76    * the HTML_QuickForm_Controller for that page.
  77    *
  78    * @var array
  79    * @access protected
  80    */
  81   public $_formValues;
  82
  83   /**
  84    * The contextMenu
  85    *
  86    * @var array
  87    * @access protected
  88    */
  89   protected $_contextMenu;
  90
  91   /**
  92    * params is the array in a value used by the search query creator
  93    *
  94    * @var array
  95    * @access protected
  96    */
  97   public $_params;
  98
  99   /**
 100    * The return properties used for search
 101    *
 102    * @var array
 103    * @access protected
 104    */
 105   protected $_returnProperties;
 106
 107   /**
 108    * represent the type of selector
 109    *
 110    * @var int
 111    * @access protected
 112    */
 113   protected $_action;
 114
 115   protected $_searchContext;
 116
 117   protected $_query;
 118
 119   /**
 120    * group id
 121    *
 122    * @var int
 123    */
 124   protected $_ufGroupID;
 125
 126   /**
 127    * the public visible fields to be shown to the user
 128    *
 129    * @var array
 130    * @access protected
 131    */
 132   protected $_fields;
 133
 134   /**
 135    * Class constructor
 136    *
 137    * @param array $formValues array of form values imported
 138    * @param array $params     array of parameters for query
 139    * @param int   $action - action of search basic or advanced.
 140    *
 141    * @return CRM_Contact_Selector
 142    * @access public
 143    */
 144   function __construct(
 145     $customSearchClass,
 146     $formValues = NULL,
 147     $params = NULL,
 148     $returnProperties = NULL,
 149     $action = CRM_Core_Action::NONE,
 150     $includeContactIds = FALSE,
 151     $searchDescendentGroups = TRUE,
 152     $searchContext = 'search',
 153     $contextMenu = NULL
 154   ) {
 155     //don't build query constructor, if form is not submitted
 156     $force = CRM_Utils_Request::retrieve('force', 'Boolean', CRM_Core_DAO::$_nullObject);
 157     if (empty($formValues) && !$force) {
 158       return;
 159     }
 160
 161     // submitted form values
 162     $this->_formValues = &$formValues;
 163     $this->_params = &$params;
 164     $this->_returnProperties = &$returnProperties;
 165     $this->_contextMenu = &$contextMenu;
 166     $this->_context = $searchContext;
 167
 168     // type of selector
 169     $this->_action = $action;
 170
 171     $this->_searchContext = $searchContext;
 172
 173     $this->_ufGroupID = CRM_Utils_Array::value('uf_group_id', $this->_formValues);
 174
 175     if ($this->_ufGroupID) {
 176       $this->_fields = CRM_Core_BAO_UFGroup::getListingFields(CRM_Core_Action::VIEW,
 177         CRM_Core_BAO_UFGroup::PUBLIC_VISIBILITY |
 178         CRM_Core_BAO_UFGroup::LISTINGS_VISIBILITY,
 179         FALSE, $this->_ufGroupID
 180       );
 181       self::$_columnHeaders = NULL;
 182
 183       $this->_customFields = CRM_Core_BAO_CustomField::getFieldsForImport('Individual');
 184
 185       $this->_returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($this->_fields);
 186       $this->_returnProperties['contact_type'] = 1;
 187       $this->_returnProperties['contact_sub_type'] = 1;
 188       $this->_returnProperties['sort_name'] = 1;
 189     }
 190
 191     $displayRelationshipType = CRM_Utils_Array::value('display_relationship_type', $this->_formValues);
 192     $operator = CRM_Utils_Array::value('operator', $this->_formValues, 'AND');
 193
 194     // rectify params to what proximity search expects if there is a value for prox_distance
 195     // CRM-7021
 196     if (!empty($this->_params)) {
 197       CRM_Contact_BAO_ProximityQuery::fixInputParams($this->_params);
 198     }
 199
 200     $this->_query = new CRM_Contact_BAO_Query(
 201       $this->_params,
 202       $this->_returnProperties,
 203       NULL,
 204       $includeContactIds,
 205       FALSE,
 206       CRM_Contact_BAO_Query::MODE_CONTACTS,
 207       FALSE,
 208       $searchDescendentGroups,
 209       FALSE,
 210       $displayRelationshipType,
 211       $operator
 212     );
 213
 214     $this->_options = &$this->_query->_options;
 215   }
 216   //end of constructor
 217
 218   /**
 219    * This method returns the links that are given for each search row.
 220    * currently the links added for each row are
 221    *
 222    * - View
 223    * - Edit
 224    *
 225    * @return array
 226    * @access public
 227    *
 228    */
 229   static function &links() {
 230     list($context, $contextMenu, $key) = func_get_args();
 231     $extraParams = ($key) ? "&key={$key}" : NULL;
 232     $searchContext = ($context) ? "&context=$context" : NULL;
 233
 234     if (!(self::$_links)) {
 235       self::$_links = array(
 236         CRM_Core_Action::VIEW => array(
 237           'name' => ts('View'),
 238           'url' => 'civicrm/contact/view',
 239           'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
 240           'title' => ts('View Contact Details'),
 241           'ref' => 'view-contact',
 242         ),
 243         CRM_Core_Action::UPDATE => array(
 244           'name' => ts('Edit'),
 245           'url' => 'civicrm/contact/add',
 246           'qs' => "reset=1&action=update&cid=%%id%%{$searchContext}{$extraParams}",
 247           'title' => ts('Edit Contact Details'),
 248           'ref' => 'edit-contact',
 249         ),
 250       );
 251
 252       $config = CRM_Core_Config::singleton();
 253       if ($config->mapAPIKey && $config->mapProvider) {
 254         self::$_links[CRM_Core_Action::MAP] = array(
 255           'name' => ts('Map'),
 256           'url' => 'civicrm/contact/map',
 257           'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
 258           'title' => ts('Map Contact'),
 259         );
 260       }
 261
 262       // Adding Context Menu Links in more action
 263       if ($contextMenu) {
 264         $counter = 7000;
 265         foreach ($contextMenu as $key => $value) {
 266           $contextVal = '&context=' . $value['key'];
 267           if ($value['key'] == 'delete') {
 268             $contextVal = $searchContext;
 269           }
 270
 271           $url = "civicrm/contact/view/{$value['key']}";
 272           $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}";
 273           if ($value['key'] == 'activity') {
 274             $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}";
 275           }
 276           elseif ($value['key'] == 'email') {
 277             $url = "civicrm/contact/view/activity";
 278             $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}";
 279           }
 280
 281           self::$_links[$counter++] = array(
 282             'name' => $value['title'],
 283             'url' => $url,
 284             'qs' => $qs,
 285             'title' => $value['title'],
 286             'ref' => $value['ref'],
 287           );
 288         }
 289       }
 290     }
 291     return self::$_links;
 292   }
 293   //end of function
 294
 295   /**
 296    * getter for array of the parameters required for creating pager.
 297    *
 298    * @param
 299    * @access public
 300    */
 301   function getPagerParams($action, &$params) {
 302     $params['status']    = ts('Contact %%StatusMessage%%');
 303     $params['csvString'] = NULL;
 304     $params['rowCount']  = CRM_Utils_Pager::ROWCOUNT;
 305
 306     $params['buttonTop'] = 'PagerTopButton';
 307     $params['buttonBottom'] = 'PagerBottomButton';
 308   }
 309   //end of function
 310   function &getColHeads($action = NULL, $output = NULL) {
 311
 312     $colHeads = self::_getColumnHeaders();
 313
 314     $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
 315     return $colHeads;
 316   }
 317
 318   /**
 319    * returns the column headers as an array of tuples:
 320    * (name, sortName (key to the sort array))
 321    *
 322    * @param string $action the action being performed
 323    * @param enum   $output what should the result set include (web/email/csv)
 324    *
 325    * @return array the column headers that need to be displayed
 326    * @access public
 327    */
 328   function &getColumnHeaders($action = NULL, $output = NULL) {
 329     $headers = NULL;
 330     if ($output == CRM_Core_Selector_Controller::EXPORT) {
 331       $csvHeaders = array(ts('Contact Id'), ts('Contact Type'));
 332       foreach ($this->getColHeads($action, $output) as $column) {
 333         if (array_key_exists('name', $column)) {
 334           $csvHeaders[] = $column['name'];
 335         }
 336       }
 337       $headers = $csvHeaders;
 338     }
 339     elseif ($output == CRM_Core_Selector_Controller::SCREEN) {
 340       $csvHeaders = array(ts('Name'));
 341       foreach ($this->getColHeads($action, $output) as $key => $column) {
 342         if (array_key_exists('name', $column) &&
 343           $column['name'] &&
 344           $column['name'] != ts('Name')
 345         ) {
 346           $csvHeaders[$key] = $column['name'];
 347         }
 348       }
 349       $headers = $csvHeaders;
 350     }
 351     elseif ($this->_ufGroupID) {
 352       // we dont use the cached value of column headers
 353       // since it potentially changed because of the profile selected
 354       static $skipFields = array('group', 'tag');
 355       $direction = CRM_Utils_Sort::ASCENDING;
 356       $empty = TRUE;
 357       if (!self::$_columnHeaders) {
 358         self::$_columnHeaders = array(array('name' => ''),
 359           array(
 360             'name' => ts('Name'),
 361             'sort' => 'sort_name',
 362             'direction' => CRM_Utils_Sort::ASCENDING,
 363           ),
 364         );
 365
 366         $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 367
 368         foreach ($this->_fields as $name => $field) {
 369           if (CRM_Utils_Array::value('in_selector', $field) &&
 370             !in_array($name, $skipFields)
 371           ) {
 372             if (strpos($name, '-') !== FALSE) {
 373               list($fieldName, $lType, $type) = CRM_Utils_System::explode('-', $name, 3);
 374
 375               if ($lType == 'Primary') {
 376                 $locationTypeName = 1;
 377               }
 378               else {
 379                 $locationTypeName = $locationTypes[$lType];
 380               }
 381
 382               if (in_array($fieldName, array(
 383                 'phone', 'im', 'email'))) {
 384                 if ($type) {
 385                   $name = "`$locationTypeName-$fieldName-$type`";
 386                 }
 387                 else {
 388                   $name = "`$locationTypeName-$fieldName`";
 389                 }
 390               }
 391               else {
 392                 $name = "`$locationTypeName-$fieldName`";
 393               }
 394             }
 395             //to handle sort key for Internal contactId.CRM-2289
 396             if ($name == 'id') {
 397               $name = 'contact_id';
 398             }
 399
 400             self::$_columnHeaders[] = array(
 401               'name' => $field['title'],
 402               'sort' => $name,
 403               'direction' => $direction,
 404             );
 405             $direction = CRM_Utils_Sort::DONTCARE;
 406             $empty = FALSE;
 407           }
 408         }
 409
 410         // if we dont have any valid columns, dont add the implicit ones
 411         // this allows the template to check on emptiness of column headers
 412         if ($empty) {
 413           self::$_columnHeaders = array();
 414         }
 415         else {
 416           self::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
 417         }
 418       }
 419       $headers = self::$_columnHeaders;
 420     }
 421     elseif (!empty($this->_returnProperties)) {
 422       self::$_columnHeaders = array(array('name' => ''),
 423         array(
 424           'name' => ts('Name'),
 425           'sort' => 'sort_name',
 426           'direction' => CRM_Utils_Sort::ASCENDING,
 427         ),
 428       );
 429       $properties = self::makeProperties($this->_returnProperties);
 430
 431       foreach ($properties as $prop) {
 432         if ($prop == 'contact_type' || $prop == 'contact_sub_type' || $prop == 'sort_name') {
 433           continue;
 434         }
 435
 436         if (strpos($prop, '-')) {
 437           list($loc, $fld, $phoneType) = CRM_Utils_System::explode('-', $prop, 3);
 438           $title = $this->_query->_fields[$fld]['title'];
 439           if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) {
 440             $title .= "-{$phoneType}";
 441           }
 442           $title .= " ($loc)";
 443         }
 444         elseif (isset($this->_query->_fields[$prop]) && isset($this->_query->_fields[$prop]['title'])) {
 445           $title = $this->_query->_fields[$prop]['title'];
 446         } else {
 447           $title = '';
 448         }
 449
 450         self::$_columnHeaders[] = array('name' => $title, 'sort' => $prop);
 451       }
 452       self::$_columnHeaders[] = array('name' => ts('Actions'));
 453       $headers = self::$_columnHeaders;
 454     }
 455     else {
 456       $headers = $this->getColHeads($action, $output);
 457     }
 458
 459     return $headers;
 460   }
 461
 462   /**
 463    * Returns total number of rows for the query.
 464    *
 465    * @param
 466    *
 467    * @return int Total number of rows
 468    * @access public
 469    */
 470   function getTotalCount($action) {
 471     return $this->_query->searchQuery(0, 0, NULL, TRUE);
 472   }
 473
 474   /**
 475    * returns all the rows in the given offset and rowCount
 476    *
 477    * @param enum   $action   the action being performed
 478    * @param int    $offset   the row number to start from
 479    * @param int    $rowCount the number of rows to return
 480    * @param string $sort     the sql string that describes the sort order
 481    * @param enum   $output   what should the result set include (web/email/csv)
 482    *
 483    * @return int   the total number of rows for this action
 484    */
 485   function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 486     $config = CRM_Core_Config::singleton();
 487
 488     if (($output == CRM_Core_Selector_Controller::EXPORT ||
 489         $output == CRM_Core_Selector_Controller::SCREEN
 490       ) &&
 491       $this->_formValues['radio_ts'] == 'ts_sel'
 492     ) {
 493       $includeContactIds = TRUE;
 494     }
 495     else {
 496       $includeContactIds = FALSE;
 497     }
 498
 499     // note the formvalues were given by CRM_Contact_Form_Search to us
 500     // and contain the search criteria (parameters)
 501     // note that the default action is basic
 502     $result = $this->_query->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds);
 503
 504     // process the result of the query
 505     $rows = array();
 506     $permissions = array(CRM_Core_Permission::getPermission());
 507     if (CRM_Core_Permission::check('delete contacts')) {
 508       $permissions[] = CRM_Core_Permission::DELETE;
 509     }
 510     $mask = CRM_Core_Action::mask($permissions);
 511
 512     // mask value to hide map link if there are not lat/long
 513     $mapMask = $mask & 4095;
 514
 515     if ($this->_searchContext == 'smog') {
 516       $gc = CRM_Core_SelectValues::groupContactStatus();
 517     }
 518
 519     if ($this->_ufGroupID) {
 520       $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 521
 522       $names = array();
 523       static $skipFields = array('group', 'tag');
 524       foreach ($this->_fields as $key => $field) {
 525         if (
 526           CRM_Utils_Array::value('in_selector', $field) &&
 527           !in_array($key, $skipFields)
 528         ) {
 529           if (strpos($key, '-') !== FALSE) {
 530             list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $key, 3);
 531
 532             if ($id == 'Primary') {
 533               $locationTypeName = 1;
 534             }
 535             else {
 536               $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
 537               if (!$locationTypeName) {
 538                 continue;
 539               }
 540             }
 541
 542             $locationTypeName = str_replace(' ', '_', $locationTypeName);
 543             if (in_array($fieldName, array(
 544               'phone', 'im', 'email'))) {
 545               if ($type) {
 546                 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
 547               }
 548               else {
 549                 $names[] = "{$locationTypeName}-{$fieldName}";
 550               }
 551             }
 552             else {
 553               $names[] = "{$locationTypeName}-{$fieldName}";
 554             }
 555           }
 556           else {
 557             $names[] = $field['name'];
 558           }
 559         }
 560       }
 561
 562       $names[] = "status";
 563     }
 564     elseif (!empty($this->_returnProperties)) {
 565       $names = self::makeProperties($this->_returnProperties);
 566     }
 567     else {
 568       $names = self::$_properties;
 569     }
 570
 571     $multipleSelectFields = array('preferred_communication_method' => 1);
 572
 573     $links = self::links($this->_context, $this->_contextMenu, $this->_key);
 574
 575     //check explicitly added contact to a Smart Group.
 576     $groupID = CRM_Utils_Array::key('1', $this->_formValues['group']);
 577
 578     $pseudoconstants = array();
 579     if (!empty($this->_fields)) {
 580       // get all the pseudoconstant values
 581       foreach ($this->_fields as $name => $values) {
 582         if (isset($this->_fields[$name]['pseudoconstant'])) {
 583           $pseudoconstants[$name] =
 584             array(
 585               'dbName' => $this->_fields[$name]['name'],
 586               'values' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', $name),
 587             );
 588         }
 589       }
 590     }
 591
 592     // for CRM-3157 purposes
 593     if (in_array('country', $names)) {
 594       $pseudoconstants['country'] = array(
 595         'dbName' => 'country_id',
 596         'values' => CRM_Core_PseudoConstant::country()
 597       );
 598     }
 599
 600     if (in_array('state_province', $names)) {
 601       $pseudoconstants['state_province'] = array(
 602         'dbName' => 'state_province_id',
 603         'values' => CRM_Core_PseudoConstant::stateProvince()
 604       );
 605     }
 606
 607     if (in_array('world_region', $names)) {
 608       $pseudoconstants['world_region'] = array(
 609         'dbName' => 'world_region_id',
 610         'values' => CRM_Core_PseudoConstant::worldRegion()
 611       );
 612     }
 613
 614     $seenIDs = array();
 615     while ($result->fetch()) {
 616       $row = array();
 617
 618       // the columns we are interested in
 619       foreach ($names as $property) {
 620         if ($property == 'status') {
 621           continue;
 622         }
 623         if ($cfID = CRM_Core_BAO_CustomField::getKeyID($property)) {
 624           $row[$property] = CRM_Core_BAO_CustomField::getDisplayValue(
 625             $result->$property,
 626             $cfID,
 627             $this->_options,
 628             $result->contact_id
 629           );
 630         }
 631         elseif (
 632           $multipleSelectFields &&
 633           array_key_exists($property, $multipleSelectFields)
 634         ) {
 635           $key = $property;
 636           $paramsNew = array($key => $result->$property);
 637           $name = array($key => array('newName' => $key, 'groupName' => $key));
 638
 639           CRM_Core_OptionGroup::lookupValues($paramsNew, $name, FALSE);
 640           $row[$key] = $paramsNew[$key];
 641         }
 642         elseif (strpos($property, '-im')) {
 643           $row[$property] = $result->$property;
 644           if (!empty($result->$property)) {
 645             $imProviders    = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
 646             $providerId     = $property . "-provider_id";
 647             $providerName   = $imProviders[$result->$providerId];
 648             $row[$property] = $result->$property . " ({$providerName})";
 649           }
 650         }
 651         elseif (in_array($property, array(
 652           'addressee', 'email_greeting', 'postal_greeting'))) {
 653           $greeting = $property . '_display';
 654           $row[$property] = $result->$greeting;
 655         }
 656         elseif (isset($pseudoconstants[$property])) {
 657           $row[$property] = CRM_Utils_Array::value(
 658             $result->{$pseudoconstants[$property]['dbName']},
 659             $pseudoconstants[$property]['values']
 660           );
 661         }
 662         elseif (strpos($property, '-url') !== FALSE) {
 663           $websiteUrl = '';
 664           $websiteKey = 'website-1';
 665           $propertyArray = explode('-', $property);
 666           $websiteFld = $websiteKey . '-' . array_pop($propertyArray);
 667           if (!empty($result->$websiteFld)) {
 668             $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id');
 669             $websiteType  = $websiteTypes[$result->{"$websiteKey-website_type_id"}];
 670             $websiteValue = $result->$websiteFld;
 671             $websiteUrl   = "<a href=\"{$websiteValue}\">{$websiteValue}  ({$websiteType})</a>";
 672           }
 673           $row[$property] = $websiteUrl;
 674         }
 675         else {
 676           $row[$property] = isset($result->$property) ? $result->$property : NULL;
 677         }
 678       }
 679
 680       if (!empty($result->postal_code_suffix)) {
 681         $row['postal_code'] .= "-" . $result->postal_code_suffix;
 682       }
 683
 684       if ($output != CRM_Core_Selector_Controller::EXPORT &&
 685         $this->_searchContext == 'smog'
 686       ) {
 687         if (empty($result->status) &&
 688           $groupID
 689         ) {
 690           $contactID = $result->contact_id;
 691           if ($contactID) {
 692             $gcParams = array(
 693               'contact_id' => $contactID,
 694               'group_id' => $groupID,
 695             );
 696
 697             $gcDefaults = array();
 698             CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults);
 699
 700             if (empty($gcDefaults)) {
 701               $row['status'] = ts('Smart');
 702             }
 703             else {
 704               $row['status'] = $gc[$gcDefaults['status']];
 705             }
 706           }
 707           else {
 708             $row['status'] = NULL;
 709           }
 710         }
 711         else {
 712           $row['status'] = $gc[$result->status];
 713         }
 714       }
 715
 716       if ($output != CRM_Core_Selector_Controller::EXPORT) {
 717         $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contact_id;
 718
 719         if (CRM_Utils_Array::value('deleted_contacts', $this->_formValues)
 720           && CRM_Core_Permission::check('access deleted contacts')
 721         ) {
 722           $links = array(
 723             array(
 724               'name' => ts('View'),
 725               'url' => 'civicrm/contact/view',
 726               'qs' => 'reset=1&cid=%%id%%',
 727               'title' => ts('View Contact Details'),
 728             ),
 729             array(
 730               'name' => ts('Restore'),
 731               'url' => 'civicrm/contact/view/delete',
 732               'qs' => 'reset=1&cid=%%id%%&restore=1',
 733               'title' => ts('Restore Contact'),
 734             ),
 735           );
 736           if (CRM_Core_Permission::check('delete contacts')) {
 737             $links[] = array(
 738               'name' => ts('Delete Permanently'),
 739               'url' => 'civicrm/contact/view/delete',
 740               'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
 741               'title' => ts('Permanently Delete Contact'),
 742             );
 743           }
 744           $row['action'] = CRM_Core_Action::formLink($links, NULL, array('id' => $result->contact_id));
 745         }
 746         elseif ((is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) ||
 747           ($config->mapGeoCoding &&
 748             CRM_Utils_Array::value('city', $row) &&
 749             CRM_Utils_Array::value('state_province', $row)
 750           )
 751         ) {
 752           $row['action'] = CRM_Core_Action::formLink($links, $mask, array('id' => $result->contact_id));
 753         }
 754         else {
 755           $row['action'] = CRM_Core_Action::formLink($links, $mapMask, array('id' => $result->contact_id));
 756         }
 757
 758         // allow components to add more actions
 759         CRM_Core_Component::searchAction($row, $result->contact_id);
 760
 761         $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ?
 762           $result->contact_sub_type : $result->contact_type,
 763           FALSE,
 764           $result->contact_id
 765         );
 766
 767         $row['contact_type_orig'] = $result->contact_sub_type ? $result->contact_sub_type : $result->contact_type;
 768         $row['contact_sub_type']  = $result->contact_sub_type ?
 769           CRM_Contact_BAO_ContactType::contactTypePairs(FALSE, $result->contact_sub_type, ', ') : $result->contact_sub_type;
 770         $row['contact_id'] = $result->contact_id;
 771         $row['sort_name'] = $result->sort_name;
 772         if (array_key_exists('id', $row)) {
 773           $row['id'] = $result->contact_id;
 774         }
 775       }
 776
 777       // Dedupe contacts
 778       if (in_array($row['contact_id'], $seenIDs) === FALSE) {
 779         $seenIDs[] = $row['contact_id'];
 780         $rows[] = $row;
 781       }
 782     }
 783
 784     $this->buildPrevNextCache($sort);
 785
 786     return $rows;
 787   }
 788
 789   function buildPrevNextCache($sort) {
 790     $cacheKey = CRM_Utils_Array::value('qfKey', $this->_formValues);
 791
 792     //for prev/next pagination
 793     $crmPID = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject);
 794
 795     //for alphabetic pagination selection save
 796     $sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String', CRM_Core_DAO::$_nullObject);
 797
 798     //for text field pagination selection save
 799     $countRow = CRM_Core_BAO_PrevNextCache::getCount("%civicrm search {$cacheKey}%", NULL, "entity_table = 'civicrm_contact'", "LIKE");
 800
 801     if (!$crmPID && $countRow == 0 && !$sortByCharacter) {
 802       $this->fillupPrevNextCache($sort);
 803     }
 804     elseif ($sortByCharacter) {
 805       $cacheKeyCharacter = "civicrm search {$cacheKey}_alphabet";
 806       if ($sortByCharacter == 'all') {
 807         //delete the alphabet key corresponding records in prevnext_cache
 808         CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKeyCharacter, 'civicrm_contact');
 809         $cacheKeyCharacter = NULL;
 810       }
 811       $this->fillupPrevNextCache($sort, $cacheKeyCharacter);
 812     }
 813   }
 814
 815   function addActions(&$rows) {
 816     $config = CRM_Core_Config::singleton();
 817
 818     $permissions = array(CRM_Core_Permission::getPermission());
 819     if (CRM_Core_Permission::check('delete contacts')) {
 820       $permissions[] = CRM_Core_Permission::DELETE;
 821     }
 822     $mask = CRM_Core_Action::mask($permissions);
 823     // mask value to hide map link if there are not lat/long
 824     $mapMask = $mask & 4095;
 825
 826     // mask value to hide map link if there are not lat/long
 827     $mapMask = $mask & 4095;
 828
 829     $links = self::links($this->_context, $this->_contextMenu, $this->_key);
 830
 831
 832     foreach ($rows as $id => & $row) {
 833       if (CRM_Utils_Array::value('deleted_contacts', $this->_formValues)
 834         && CRM_Core_Permission::check('access deleted contacts')
 835       ) {
 836         $links = array(
 837           array(
 838             'name' => ts('View'),
 839             'url' => 'civicrm/contact/view',
 840             'qs' => 'reset=1&cid=%%id%%',
 841             'title' => ts('View Contact Details'),
 842           ),
 843           array(
 844             'name' => ts('Restore'),
 845             'url' => 'civicrm/contact/view/delete',
 846             'qs' => 'reset=1&cid=%%id%%&restore=1',
 847             'title' => ts('Restore Contact'),
 848           ),
 849         );
 850         if (CRM_Core_Permission::check('delete contacts')) {
 851           $links[] = array(
 852             'name' => ts('Delete Permanently'),
 853             'url' => 'civicrm/contact/view/delete',
 854             'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
 855             'title' => ts('Permanently Delete Contact'),
 856           );
 857         }
 858         $row['action'] = CRM_Core_Action::formLink($links, NULL, array('id' => $row['contact_id']));
 859       }
 860       elseif ((is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) ||
 861         ($config->mapGeoCoding &&
 862           CRM_Utils_Array::value('city', $row) &&
 863           CRM_Utils_Array::value('state_province', $row)
 864         )
 865       ) {
 866         $row['action'] = CRM_Core_Action::formLink($links, $mask, array('id' => $row['contact_id']));
 867       }
 868       else {
 869         $row['action'] = CRM_Core_Action::formLink($links, $mapMask, array('id' => $row['contact_id']));
 870       }
 871
 872       // allow components to add more actions
 873       CRM_Core_Component::searchAction($row, $row['contact_id']);
 874
 875       if (!empty($row['contact_type_orig'])) {
 876         $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($row['contact_type_orig'],
 877           FALSE, $row['contact_id']);
 878       }
 879     }
 880   }
 881
 882   function removeActions(&$rows) {
 883     foreach ($rows as $rid => & $rValue) {
 884       unset($rValue['contact_type']);
 885       unset($rValue['action']);
 886     }
 887   }
 888
 889   function fillupPrevNextCache($sort, $cacheKey = NULL) {
 890     if (!$cacheKey) {
 891       $cacheKey = "civicrm search {$this->_key}";
 892     }
 893
 894     CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKey, 'civicrm_contact');
 895
 896     // lets fill up the prev next cache here, so view can scroll thru
 897     if (is_a($this, 'CRM_Contact_Selector_Custom')) {
 898       $sql = $this->_search->contactIDs(0, 0, $sort, TRUE);
 899       $replaceSQL = "SELECT contact_a.id as contact_id";
 900     }
 901     else {
 902       $sql = $this->_query->searchQuery(
 903         0, 0, $sort,
 904         FALSE, FALSE,
 905         FALSE, TRUE, TRUE, NULL
 906       );
 907       $replaceSQL = "SELECT contact_a.id as id";
 908     }
 909
 910     // CRM-9096
 911     // due to limitations in our search query writer, the above query does not work
 912     // in cases where the query is being sorted on a non-contact table
 913     // this results in a fatal error :(
 914     // see below for the gross hack of trapping the error and not filling
 915     // the prev next cache in this situation
 916     // the other alternative of running the FULL query will just be incredibly inefficient
 917     // and slow things down way too much on large data sets / complex queries
 918
 919     $insertSQL = "
 920 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
 921 SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
 922 ";
 923
 924     $sql = str_replace($replaceSQL, $insertSQL, $sql);
 925
 926
 927     CRM_Core_Error::ignoreException();
 928     $result = CRM_Core_DAO::executeQuery($sql);
 929     CRM_Core_Error::setCallback();
 930
 931     if (is_a($result, 'DB_Error')) {
 932       // oops the above query failed, so lets just ignore it
 933       // and return
 934       // we print a sorry cant figure it out on view page
 935       return;
 936     }
 937
 938     // also record an entry in the cache key table, so we can delete it periodically
 939     CRM_Core_BAO_Cache::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
 940   }
 941
 942   /**
 943    * Given the current formValues, gets the query in local
 944    * language
 945    *
 946    * @param  array(
 947      reference)   $formValues   submitted formValues
 948    *
 949    * @return array              $qill         which contains an array of strings
 950    * @access public
 951    */
 952
 953   // the current internationalisation is bad, but should more or less work
 954   // for most of "European" languages
 955   public function getQILL() {
 956     return $this->_query->qill();
 957   }
 958
 959   /**
 960    * name of export file.
 961    *
 962    * @param string $output type of output
 963    *
 964    * @return string name of the file
 965    */
 966   function getExportFileName($output = 'csv') {
 967     return ts('CiviCRM Contact Search');
 968   }
 969
 970   /**
 971    * get colunmn headers for search selector
 972    *
 973    *
 974    * @return array $_columnHeaders
 975    * @access private
 976    */
 977   private static function &_getColumnHeaders() {
 978     if (!isset(self::$_columnHeaders)) {
 979       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 980         'address_options', TRUE, NULL, TRUE
 981       );
 982
 983       self::$_columnHeaders = array('contact_type' => array('desc' => ts('Contact Type')),
 984         'sort_name' => array(
 985           'name' => ts('Name'),
 986           'sort' => 'sort_name',
 987           'direction' => CRM_Utils_Sort::ASCENDING,
 988         ),
 989       );
 990
 991       $defaultAddress = array('street_address' => array('name' => ts('Address')),
 992         'city' => array('name' => ts('City'),
 993           'sort' => 'city',
 994           'direction' => CRM_Utils_Sort::DONTCARE,
 995         ),
 996         'state_province' => array('name' => ts('State'),
 997           'sort' => 'state_province',
 998           'direction' => CRM_Utils_Sort::DONTCARE,
 999         ),
1000         'postal_code' => array('name' => ts('Postal'),
1001           'sort' => 'postal_code',
1002           'direction' => CRM_Utils_Sort::DONTCARE,
1003         ),
1004         'country' => array('name' => ts('Country'),
1005           'sort' => 'country',
1006           'direction' => CRM_Utils_Sort::DONTCARE,
1007         ),
1008       );
1009
1010       foreach ($defaultAddress as $columnName => $column) {
1011         if (CRM_Utils_Array::value($columnName, $addressOptions)) {
1012           self::$_columnHeaders[$columnName] = $column;
1013         }
1014       }
1015
1016       self::$_columnHeaders['email'] = array('name' => ts('Email'),
1017         'sort' => 'email',
1018         'direction' => CRM_Utils_Sort::DONTCARE,
1019       );
1020
1021       self::$_columnHeaders['phone'] = array('name' => ts('Phone'));
1022     }
1023     return self::$_columnHeaders;
1024   }
1025
1026   function &getQuery() {
1027     return $this->_query;
1028   }
1029
1030   function alphabetQuery() {
1031     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
1032   }
1033
1034   function contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
1035     $sortOrder = &$this->getSortOrder($this->_action);
1036     $sort = new CRM_Utils_Sort($sortOrder, $sortID);
1037
1038     // rectify params to what proximity search expects if there is a value for prox_distance
1039     // CRM-7021 CRM-7905
1040     if (!empty($params)) {
1041       CRM_Contact_BAO_ProximityQuery::fixInputParams($params);
1042     }
1043
1044     if (!$displayRelationshipType) {
1045       $query = new CRM_Contact_BAO_Query($params,
1046         $this->_returnProperties,
1047         NULL, FALSE, FALSE, 1,
1048         FALSE, TRUE, TRUE, NULL,
1049         $queryOperator
1050       );
1051     }
1052     else {
1053       $query = new CRM_Contact_BAO_Query($params, $this->_returnProperties,
1054         NULL, FALSE, FALSE, 1,
1055         FALSE, TRUE, TRUE, $displayRelationshipType,
1056         $queryOperator
1057       );
1058     }
1059     $value = $query->searchQuery(0, 0, $sort,
1060       FALSE, FALSE, FALSE,
1061       FALSE, FALSE
1062     );
1063     return $value;
1064   }
1065
1066   function &makeProperties(&$returnProperties) {
1067     $properties = array();
1068     foreach ($returnProperties as $name => $value) {
1069       if ($name != 'location') {
1070         $properties[] = $name;
1071       }
1072       else {
1073         // extract all the location stuff
1074         foreach ($value as $n => $v) {
1075           foreach ($v as $n1 => $v1) {
1076             if (!strpos('_id', $n1) && $n1 != 'location_type') {
1077               $properties[] = "{$n}-{$n1}";
1078             }
1079           }
1080         }
1081       }
1082     }
1083     return $properties;
1084   }
1085 }
1086 //end of class
1087