| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.4 | |
| 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 | |
| 311 | function &getColHeads($action = NULL, $output = NULL) { |
| 312 | $colHeads = self::_getColumnHeaders(); |
| 313 | $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action')); |
| 314 | return $colHeads; |
| 315 | } |
| 316 | |
| 317 | /** |
| 318 | * returns the column headers as an array of tuples: |
| 319 | * (name, sortName (key to the sort array)) |
| 320 | * |
| 321 | * @param string $action the action being performed |
| 322 | * @param enum $output what should the result set include (web/email/csv) |
| 323 | * |
| 324 | * @return array the column headers that need to be displayed |
| 325 | * @access public |
| 326 | */ |
| 327 | function &getColumnHeaders($action = NULL, $output = NULL) { |
| 328 | $headers = NULL; |
| 329 | if ($output == CRM_Core_Selector_Controller::EXPORT) { |
| 330 | $csvHeaders = array(ts('Contact Id'), ts('Contact Type')); |
| 331 | foreach ($this->getColHeads($action, $output) as $column) { |
| 332 | if (array_key_exists('name', $column)) { |
| 333 | $csvHeaders[] = $column['name']; |
| 334 | } |
| 335 | } |
| 336 | $headers = $csvHeaders; |
| 337 | } |
| 338 | elseif ($output == CRM_Core_Selector_Controller::SCREEN) { |
| 339 | $csvHeaders = array(ts('Name')); |
| 340 | foreach ($this->getColHeads($action, $output) as $key => $column) { |
| 341 | if (array_key_exists('name', $column) && |
| 342 | $column['name'] && |
| 343 | $column['name'] != ts('Name') |
| 344 | ) { |
| 345 | $csvHeaders[$key] = $column['name']; |
| 346 | } |
| 347 | } |
| 348 | $headers = $csvHeaders; |
| 349 | } |
| 350 | elseif ($this->_ufGroupID) { |
| 351 | // we dont use the cached value of column headers |
| 352 | // since it potentially changed because of the profile selected |
| 353 | static $skipFields = array('group', 'tag'); |
| 354 | $direction = CRM_Utils_Sort::ASCENDING; |
| 355 | $empty = TRUE; |
| 356 | if (!self::$_columnHeaders) { |
| 357 | self::$_columnHeaders = array(array('name' => ''), |
| 358 | array( |
| 359 | 'name' => ts('Name'), |
| 360 | 'sort' => 'sort_name', |
| 361 | 'direction' => CRM_Utils_Sort::ASCENDING, |
| 362 | ), |
| 363 | ); |
| 364 | |
| 365 | $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
| 366 | |
| 367 | foreach ($this->_fields as $name => $field) { |
| 368 | if (CRM_Utils_Array::value('in_selector', $field) && |
| 369 | !in_array($name, $skipFields) |
| 370 | ) { |
| 371 | if (strpos($name, '-') !== FALSE) { |
| 372 | list($fieldName, $lType, $type) = CRM_Utils_System::explode('-', $name, 3); |
| 373 | |
| 374 | if ($lType == 'Primary') { |
| 375 | $locationTypeName = 1; |
| 376 | } |
| 377 | else { |
| 378 | $locationTypeName = $locationTypes[$lType]; |
| 379 | } |
| 380 | |
| 381 | if (in_array($fieldName, array( |
| 382 | 'phone', 'im', 'email'))) { |
| 383 | if ($type) { |
| 384 | $name = "`$locationTypeName-$fieldName-$type`"; |
| 385 | } |
| 386 | else { |
| 387 | $name = "`$locationTypeName-$fieldName`"; |
| 388 | } |
| 389 | } |
| 390 | else { |
| 391 | $name = "`$locationTypeName-$fieldName`"; |
| 392 | } |
| 393 | } |
| 394 | //to handle sort key for Internal contactId.CRM-2289 |
| 395 | if ($name == 'id') { |
| 396 | $name = 'contact_id'; |
| 397 | } |
| 398 | |
| 399 | self::$_columnHeaders[] = array( |
| 400 | 'name' => $field['title'], |
| 401 | 'sort' => $name, |
| 402 | 'direction' => $direction, |
| 403 | ); |
| 404 | $direction = CRM_Utils_Sort::DONTCARE; |
| 405 | $empty = FALSE; |
| 406 | } |
| 407 | } |
| 408 | |
| 409 | // if we dont have any valid columns, dont add the implicit ones |
| 410 | // this allows the template to check on emptiness of column headers |
| 411 | if ($empty) { |
| 412 | self::$_columnHeaders = array(); |
| 413 | } |
| 414 | else { |
| 415 | self::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action')); |
| 416 | } |
| 417 | } |
| 418 | $headers = self::$_columnHeaders; |
| 419 | } |
| 420 | elseif (!empty($this->_returnProperties)) { |
| 421 | self::$_columnHeaders = array(array('name' => ''), |
| 422 | array( |
| 423 | 'name' => ts('Name'), |
| 424 | 'sort' => 'sort_name', |
| 425 | 'direction' => CRM_Utils_Sort::ASCENDING, |
| 426 | ), |
| 427 | ); |
| 428 | $properties = self::makeProperties($this->_returnProperties); |
| 429 | |
| 430 | foreach ($properties as $prop) { |
| 431 | if ($prop == 'contact_type' || $prop == 'contact_sub_type' || $prop == 'sort_name') { |
| 432 | continue; |
| 433 | } |
| 434 | |
| 435 | if (strpos($prop, '-')) { |
| 436 | list($loc, $fld, $phoneType) = CRM_Utils_System::explode('-', $prop, 3); |
| 437 | $title = $this->_query->_fields[$fld]['title']; |
| 438 | if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) { |
| 439 | $title .= "-{$phoneType}"; |
| 440 | } |
| 441 | $title .= " ($loc)"; |
| 442 | } |
| 443 | elseif (isset($this->_query->_fields[$prop]) && isset($this->_query->_fields[$prop]['title'])) { |
| 444 | $title = $this->_query->_fields[$prop]['title']; |
| 445 | } else { |
| 446 | $title = ''; |
| 447 | } |
| 448 | |
| 449 | self::$_columnHeaders[] = array('name' => $title, 'sort' => $prop); |
| 450 | } |
| 451 | self::$_columnHeaders[] = array('name' => ts('Actions')); |
| 452 | $headers = self::$_columnHeaders; |
| 453 | } |
| 454 | else { |
| 455 | $headers = $this->getColHeads($action, $output); |
| 456 | } |
| 457 | |
| 458 | return $headers; |
| 459 | } |
| 460 | |
| 461 | /** |
| 462 | * Returns total number of rows for the query. |
| 463 | * |
| 464 | * @param |
| 465 | * |
| 466 | * @return int Total number of rows |
| 467 | * @access public |
| 468 | */ |
| 469 | function getTotalCount($action) { |
| 470 | // Use count from cache during paging/sorting |
| 471 | if (!empty($_GET['crmPID']) || !empty($_GET['crmSID'])) { |
| 472 | $count = CRM_Core_BAO_Cache::getItem('Search Results Count', $this->_key); |
| 473 | } |
| 474 | if (empty($count)) { |
| 475 | $count = $this->_query->searchQuery(0, 0, NULL, TRUE); |
| 476 | CRM_Core_BAO_Cache::setItem($count, 'Search Results Count', $this->_key); |
| 477 | } |
| 478 | return $count; |
| 479 | } |
| 480 | |
| 481 | /** |
| 482 | * returns all the rows in the given offset and rowCount |
| 483 | * |
| 484 | * @param enum $action the action being performed |
| 485 | * @param int $offset the row number to start from |
| 486 | * @param int $rowCount the number of rows to return |
| 487 | * @param string $sort the sql string that describes the sort order |
| 488 | * @param enum $output what should the result set include (web/email/csv) |
| 489 | * |
| 490 | * @return int the total number of rows for this action |
| 491 | */ |
| 492 | function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { |
| 493 | $config = CRM_Core_Config::singleton(); |
| 494 | |
| 495 | if (($output == CRM_Core_Selector_Controller::EXPORT || |
| 496 | $output == CRM_Core_Selector_Controller::SCREEN |
| 497 | ) && |
| 498 | $this->_formValues['radio_ts'] == 'ts_sel' |
| 499 | ) { |
| 500 | $includeContactIds = TRUE; |
| 501 | } |
| 502 | else { |
| 503 | $includeContactIds = FALSE; |
| 504 | } |
| 505 | |
| 506 | // note the formvalues were given by CRM_Contact_Form_Search to us |
| 507 | // and contain the search criteria (parameters) |
| 508 | // note that the default action is basic |
| 509 | if ($rowCount) { |
| 510 | $cacheKey = $this->buildPrevNextCache($sort); |
| 511 | $result = $this->_query->getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds); |
| 512 | } |
| 513 | else { |
| 514 | $result = $this->_query->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds); |
| 515 | } |
| 516 | |
| 517 | // process the result of the query |
| 518 | $rows = array(); |
| 519 | $permissions = array(CRM_Core_Permission::getPermission()); |
| 520 | if (CRM_Core_Permission::check('delete contacts')) { |
| 521 | $permissions[] = CRM_Core_Permission::DELETE; |
| 522 | } |
| 523 | $mask = CRM_Core_Action::mask($permissions); |
| 524 | |
| 525 | // mask value to hide map link if there are not lat/long |
| 526 | $mapMask = $mask & 4095; |
| 527 | |
| 528 | if ($this->_searchContext == 'smog') { |
| 529 | $gc = CRM_Core_SelectValues::groupContactStatus(); |
| 530 | } |
| 531 | |
| 532 | if ($this->_ufGroupID) { |
| 533 | $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
| 534 | |
| 535 | $names = array(); |
| 536 | static $skipFields = array('group', 'tag'); |
| 537 | foreach ($this->_fields as $key => $field) { |
| 538 | if ( |
| 539 | CRM_Utils_Array::value('in_selector', $field) && |
| 540 | !in_array($key, $skipFields) |
| 541 | ) { |
| 542 | if (strpos($key, '-') !== FALSE) { |
| 543 | list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $key, 3); |
| 544 | |
| 545 | if ($id == 'Primary') { |
| 546 | $locationTypeName = 1; |
| 547 | } |
| 548 | else { |
| 549 | $locationTypeName = CRM_Utils_Array::value($id, $locationTypes); |
| 550 | if (!$locationTypeName) { |
| 551 | continue; |
| 552 | } |
| 553 | } |
| 554 | |
| 555 | $locationTypeName = str_replace(' ', '_', $locationTypeName); |
| 556 | if (in_array($fieldName, array( |
| 557 | 'phone', 'im', 'email'))) { |
| 558 | if ($type) { |
| 559 | $names[] = "{$locationTypeName}-{$fieldName}-{$type}"; |
| 560 | } |
| 561 | else { |
| 562 | $names[] = "{$locationTypeName}-{$fieldName}"; |
| 563 | } |
| 564 | } |
| 565 | else { |
| 566 | $names[] = "{$locationTypeName}-{$fieldName}"; |
| 567 | } |
| 568 | } |
| 569 | else { |
| 570 | $names[] = $field['name']; |
| 571 | } |
| 572 | } |
| 573 | } |
| 574 | |
| 575 | $names[] = "status"; |
| 576 | } |
| 577 | elseif (!empty($this->_returnProperties)) { |
| 578 | $names = self::makeProperties($this->_returnProperties); |
| 579 | } |
| 580 | else { |
| 581 | $names = self::$_properties; |
| 582 | } |
| 583 | |
| 584 | $multipleSelectFields = array('preferred_communication_method' => 1); |
| 585 | |
| 586 | $links = self::links($this->_context, $this->_contextMenu, $this->_key); |
| 587 | |
| 588 | //check explicitly added contact to a Smart Group. |
| 589 | $groupID = CRM_Utils_Array::key('1', $this->_formValues['group']); |
| 590 | |
| 591 | $pseudoconstants = array(); |
| 592 | // for CRM-3157 purposes |
| 593 | if (in_array('world_region', $names)) { |
| 594 | $pseudoconstants['world_region'] = array( |
| 595 | 'dbName' => 'world_region_id', |
| 596 | 'values' => CRM_Core_PseudoConstant::worldRegion() |
| 597 | ); |
| 598 | } |
| 599 | |
| 600 | $seenIDs = array(); |
| 601 | while ($result->fetch()) { |
| 602 | $row = array(); |
| 603 | $this->_query->convertToPseudoNames($result); |
| 604 | |
| 605 | // the columns we are interested in |
| 606 | foreach ($names as $property) { |
| 607 | if ($property == 'status') { |
| 608 | continue; |
| 609 | } |
| 610 | if ($cfID = CRM_Core_BAO_CustomField::getKeyID($property)) { |
| 611 | $row[$property] = CRM_Core_BAO_CustomField::getDisplayValue( |
| 612 | $result->$property, |
| 613 | $cfID, |
| 614 | $this->_options, |
| 615 | $result->contact_id |
| 616 | ); |
| 617 | } |
| 618 | elseif ( |
| 619 | $multipleSelectFields && |
| 620 | array_key_exists($property, $multipleSelectFields) |
| 621 | ) { |
| 622 | $key = $property; |
| 623 | $paramsNew = array($key => $result->$property); |
| 624 | $name = array($key => array('newName' => $key, 'groupName' => $key)); |
| 625 | |
| 626 | CRM_Core_OptionGroup::lookupValues($paramsNew, $name, FALSE); |
| 627 | $row[$key] = $paramsNew[$key]; |
| 628 | } |
| 629 | elseif (strpos($property, '-im')) { |
| 630 | $row[$property] = $result->$property; |
| 631 | if (!empty($result->$property)) { |
| 632 | $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'); |
| 633 | $providerId = $property . "-provider_id"; |
| 634 | $providerName = $imProviders[$result->$providerId]; |
| 635 | $row[$property] = $result->$property . " ({$providerName})"; |
| 636 | } |
| 637 | } |
| 638 | elseif (in_array($property, array( |
| 639 | 'addressee', 'email_greeting', 'postal_greeting'))) { |
| 640 | $greeting = $property . '_display'; |
| 641 | $row[$property] = $result->$greeting; |
| 642 | } |
| 643 | elseif ($property == 'state_province') { |
| 644 | $row[$property] = $result->state_province_name; |
| 645 | } |
| 646 | elseif (isset($pseudoconstants[$property])) { |
| 647 | $row[$property] = CRM_Utils_Array::value( |
| 648 | $result->{$pseudoconstants[$property]['dbName']}, |
| 649 | $pseudoconstants[$property]['values'] |
| 650 | ); |
| 651 | } |
| 652 | elseif (strpos($property, '-url') !== FALSE) { |
| 653 | $websiteUrl = ''; |
| 654 | $websiteKey = 'website-1'; |
| 655 | $propertyArray = explode('-', $property); |
| 656 | $websiteFld = $websiteKey . '-' . array_pop($propertyArray); |
| 657 | if (!empty($result->$websiteFld)) { |
| 658 | $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'); |
| 659 | $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}]; |
| 660 | $websiteValue = $result->$websiteFld; |
| 661 | $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue} ({$websiteType})</a>"; |
| 662 | } |
| 663 | $row[$property] = $websiteUrl; |
| 664 | } |
| 665 | else { |
| 666 | $row[$property] = isset($result->$property) ? $result->$property : NULL; |
| 667 | } |
| 668 | } |
| 669 | |
| 670 | if (!empty($result->postal_code_suffix)) { |
| 671 | $row['postal_code'] .= "-" . $result->postal_code_suffix; |
| 672 | } |
| 673 | |
| 674 | if ($output != CRM_Core_Selector_Controller::EXPORT && |
| 675 | $this->_searchContext == 'smog' |
| 676 | ) { |
| 677 | if (empty($result->status) && |
| 678 | $groupID |
| 679 | ) { |
| 680 | $contactID = $result->contact_id; |
| 681 | if ($contactID) { |
| 682 | $gcParams = array( |
| 683 | 'contact_id' => $contactID, |
| 684 | 'group_id' => $groupID, |
| 685 | ); |
| 686 | |
| 687 | $gcDefaults = array(); |
| 688 | CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults); |
| 689 | |
| 690 | if (empty($gcDefaults)) { |
| 691 | $row['status'] = ts('Smart'); |
| 692 | } |
| 693 | else { |
| 694 | $row['status'] = $gc[$gcDefaults['status']]; |
| 695 | } |
| 696 | } |
| 697 | else { |
| 698 | $row['status'] = NULL; |
| 699 | } |
| 700 | } |
| 701 | else { |
| 702 | $row['status'] = $gc[$result->status]; |
| 703 | } |
| 704 | } |
| 705 | |
| 706 | if ($output != CRM_Core_Selector_Controller::EXPORT) { |
| 707 | $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contact_id; |
| 708 | |
| 709 | if (CRM_Utils_Array::value('deleted_contacts', $this->_formValues) |
| 710 | && CRM_Core_Permission::check('access deleted contacts') |
| 711 | ) { |
| 712 | $links = array( |
| 713 | array( |
| 714 | 'name' => ts('View'), |
| 715 | 'url' => 'civicrm/contact/view', |
| 716 | 'qs' => 'reset=1&cid=%%id%%', |
| 717 | 'title' => ts('View Contact Details'), |
| 718 | ), |
| 719 | array( |
| 720 | 'name' => ts('Restore'), |
| 721 | 'url' => 'civicrm/contact/view/delete', |
| 722 | 'qs' => 'reset=1&cid=%%id%%&restore=1', |
| 723 | 'title' => ts('Restore Contact'), |
| 724 | ), |
| 725 | ); |
| 726 | if (CRM_Core_Permission::check('delete contacts')) { |
| 727 | $links[] = array( |
| 728 | 'name' => ts('Delete Permanently'), |
| 729 | 'url' => 'civicrm/contact/view/delete', |
| 730 | 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1', |
| 731 | 'title' => ts('Permanently Delete Contact'), |
| 732 | ); |
| 733 | } |
| 734 | $row['action'] = CRM_Core_Action::formLink($links, NULL, array('id' => $result->contact_id)); |
| 735 | } |
| 736 | elseif ((is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) || |
| 737 | ($config->mapGeoCoding && |
| 738 | CRM_Utils_Array::value('city', $row) && |
| 739 | CRM_Utils_Array::value('state_province', $row) |
| 740 | ) |
| 741 | ) { |
| 742 | $row['action'] = CRM_Core_Action::formLink($links, $mask, array('id' => $result->contact_id)); |
| 743 | } |
| 744 | else { |
| 745 | $row['action'] = CRM_Core_Action::formLink($links, $mapMask, array('id' => $result->contact_id)); |
| 746 | } |
| 747 | |
| 748 | // allow components to add more actions |
| 749 | CRM_Core_Component::searchAction($row, $result->contact_id); |
| 750 | |
| 751 | $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? |
| 752 | $result->contact_sub_type : $result->contact_type, |
| 753 | FALSE, |
| 754 | $result->contact_id |
| 755 | ); |
| 756 | |
| 757 | $row['contact_type_orig'] = $result->contact_sub_type ? $result->contact_sub_type : $result->contact_type; |
| 758 | $row['contact_sub_type'] = $result->contact_sub_type ? |
| 759 | CRM_Contact_BAO_ContactType::contactTypePairs(FALSE, $result->contact_sub_type, ', ') : $result->contact_sub_type; |
| 760 | $row['contact_id'] = $result->contact_id; |
| 761 | $row['sort_name'] = $result->sort_name; |
| 762 | if (array_key_exists('id', $row)) { |
| 763 | $row['id'] = $result->contact_id; |
| 764 | } |
| 765 | } |
| 766 | |
| 767 | // Dedupe contacts |
| 768 | if (in_array($row['contact_id'], $seenIDs) === FALSE) { |
| 769 | $seenIDs[] = $row['contact_id']; |
| 770 | $rows[] = $row; |
| 771 | } |
| 772 | } |
| 773 | |
| 774 | return $rows; |
| 775 | } |
| 776 | |
| 777 | function buildPrevNextCache($sort) { |
| 778 | $cacheKey = 'civicrm search ' . $this->_key; |
| 779 | |
| 780 | // Get current page requested |
| 781 | $pageNum = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject); |
| 782 | // When starting from scratch, clear any old cache |
| 783 | if (!$pageNum) { |
| 784 | CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKey, 'civicrm_contact'); |
| 785 | $pageNum = 1; |
| 786 | } |
| 787 | |
| 788 | $pageSize = CRM_Utils_Request::retrieve('crmRowCount', 'Integer', CRM_Core_DAO::$_nullObject, FALSE, 50); |
| 789 | $firstRecord = ($pageNum - 1) * $pageSize; |
| 790 | |
| 791 | //for alphabetic pagination selection save |
| 792 | $sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String', CRM_Core_DAO::$_nullObject); |
| 793 | |
| 794 | //for text field pagination selection save |
| 795 | $countRow = CRM_Core_BAO_PrevNextCache::getCount($cacheKey, NULL, "entity_table = 'civicrm_contact'"); |
| 796 | |
| 797 | // $sortByCharacter triggers a refresh in the prevNext cache |
| 798 | if ($sortByCharacter && $sortByCharacter != 'all') { |
| 799 | $cacheKey .= "_alphabet"; |
| 800 | $this->fillupPrevNextCache($sort, $cacheKey); |
| 801 | } |
| 802 | elseif ($firstRecord >= $countRow) { |
| 803 | $this->fillupPrevNextCache($sort, $cacheKey, $countRow, $firstRecord + 500); |
| 804 | } |
| 805 | return $cacheKey; |
| 806 | } |
| 807 | |
| 808 | function addActions(&$rows) { |
| 809 | $config = CRM_Core_Config::singleton(); |
| 810 | |
| 811 | $permissions = array(CRM_Core_Permission::getPermission()); |
| 812 | if (CRM_Core_Permission::check('delete contacts')) { |
| 813 | $permissions[] = CRM_Core_Permission::DELETE; |
| 814 | } |
| 815 | $mask = CRM_Core_Action::mask($permissions); |
| 816 | // mask value to hide map link if there are not lat/long |
| 817 | $mapMask = $mask & 4095; |
| 818 | |
| 819 | // mask value to hide map link if there are not lat/long |
| 820 | $mapMask = $mask & 4095; |
| 821 | |
| 822 | $links = self::links($this->_context, $this->_contextMenu, $this->_key); |
| 823 | |
| 824 | |
| 825 | foreach ($rows as $id => & $row) { |
| 826 | if (CRM_Utils_Array::value('deleted_contacts', $this->_formValues) |
| 827 | && CRM_Core_Permission::check('access deleted contacts') |
| 828 | ) { |
| 829 | $links = array( |
| 830 | array( |
| 831 | 'name' => ts('View'), |
| 832 | 'url' => 'civicrm/contact/view', |
| 833 | 'qs' => 'reset=1&cid=%%id%%', |
| 834 | 'title' => ts('View Contact Details'), |
| 835 | ), |
| 836 | array( |
| 837 | 'name' => ts('Restore'), |
| 838 | 'url' => 'civicrm/contact/view/delete', |
| 839 | 'qs' => 'reset=1&cid=%%id%%&restore=1', |
| 840 | 'title' => ts('Restore Contact'), |
| 841 | ), |
| 842 | ); |
| 843 | if (CRM_Core_Permission::check('delete contacts')) { |
| 844 | $links[] = array( |
| 845 | 'name' => ts('Delete Permanently'), |
| 846 | 'url' => 'civicrm/contact/view/delete', |
| 847 | 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1', |
| 848 | 'title' => ts('Permanently Delete Contact'), |
| 849 | ); |
| 850 | } |
| 851 | $row['action'] = CRM_Core_Action::formLink($links, NULL, array('id' => $row['contact_id'])); |
| 852 | } |
| 853 | elseif ((is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) || |
| 854 | ($config->mapGeoCoding && |
| 855 | CRM_Utils_Array::value('city', $row) && |
| 856 | CRM_Utils_Array::value('state_province', $row) |
| 857 | ) |
| 858 | ) { |
| 859 | $row['action'] = CRM_Core_Action::formLink($links, $mask, array('id' => $row['contact_id'])); |
| 860 | } |
| 861 | else { |
| 862 | $row['action'] = CRM_Core_Action::formLink($links, $mapMask, array('id' => $row['contact_id'])); |
| 863 | } |
| 864 | |
| 865 | // allow components to add more actions |
| 866 | CRM_Core_Component::searchAction($row, $row['contact_id']); |
| 867 | |
| 868 | if (!empty($row['contact_type_orig'])) { |
| 869 | $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($row['contact_type_orig'], |
| 870 | FALSE, $row['contact_id']); |
| 871 | } |
| 872 | } |
| 873 | } |
| 874 | |
| 875 | function removeActions(&$rows) { |
| 876 | foreach ($rows as $rid => & $rValue) { |
| 877 | unset($rValue['contact_type']); |
| 878 | unset($rValue['action']); |
| 879 | } |
| 880 | } |
| 881 | |
| 882 | /** |
| 883 | * @param object $sort |
| 884 | * @param string $cacheKey |
| 885 | * @param int $start |
| 886 | * @param int $end |
| 887 | */ |
| 888 | function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = 500) { |
| 889 | |
| 890 | // For custom searches, use the contactIDs method |
| 891 | if (is_a($this, 'CRM_Contact_Selector_Custom')) { |
| 892 | $sql = $this->_search->contactIDs($start, $end, $sort, TRUE); |
| 893 | $replaceSQL = "SELECT contact_a.id as contact_id"; |
| 894 | } |
| 895 | // For core searches use the searchQuery method |
| 896 | else { |
| 897 | $sql = $this->_query->searchQuery( |
| 898 | $start, $end, $sort, |
| 899 | FALSE, FALSE, |
| 900 | FALSE, TRUE, TRUE, NULL |
| 901 | ); |
| 902 | $replaceSQL = "SELECT contact_a.id as id"; |
| 903 | } |
| 904 | |
| 905 | // CRM-9096 |
| 906 | // due to limitations in our search query writer, the above query does not work |
| 907 | // in cases where the query is being sorted on a non-contact table |
| 908 | // this results in a fatal error :( |
| 909 | // see below for the gross hack of trapping the error and not filling |
| 910 | // the prev next cache in this situation |
| 911 | // the other alternative of running the FULL query will just be incredibly inefficient |
| 912 | // and slow things down way too much on large data sets / complex queries |
| 913 | |
| 914 | $insertSQL = " |
| 915 | INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data ) |
| 916 | SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name |
| 917 | "; |
| 918 | |
| 919 | $sql = str_replace($replaceSQL, $insertSQL, $sql); |
| 920 | |
| 921 | CRM_Core_Error::ignoreException(); |
| 922 | $result = CRM_Core_DAO::executeQuery($sql); |
| 923 | CRM_Core_Error::setCallback(); |
| 924 | |
| 925 | if (is_a($result, 'DB_Error')) { |
| 926 | // oops the above query failed, so lets just ignore it |
| 927 | // and return |
| 928 | // we print a sorry cant figure it out on view page |
| 929 | return; |
| 930 | } |
| 931 | |
| 932 | // also record an entry in the cache key table, so we can delete it periodically |
| 933 | CRM_Core_BAO_Cache::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey); |
| 934 | } |
| 935 | |
| 936 | /** |
| 937 | * Given the current formValues, gets the query in local |
| 938 | * language |
| 939 | * |
| 940 | * @param array( |
| 941 | reference) $formValues submitted formValues |
| 942 | * |
| 943 | * @return array $qill which contains an array of strings |
| 944 | * @access public |
| 945 | */ |
| 946 | |
| 947 | // the current internationalisation is bad, but should more or less work |
| 948 | // for most of "European" languages |
| 949 | public function getQILL() { |
| 950 | return $this->_query->qill(); |
| 951 | } |
| 952 | |
| 953 | /** |
| 954 | * name of export file. |
| 955 | * |
| 956 | * @param string $output type of output |
| 957 | * |
| 958 | * @return string name of the file |
| 959 | */ |
| 960 | function getExportFileName($output = 'csv') { |
| 961 | return ts('CiviCRM Contact Search'); |
| 962 | } |
| 963 | |
| 964 | /** |
| 965 | * get colunmn headers for search selector |
| 966 | * |
| 967 | * |
| 968 | * @return array $_columnHeaders |
| 969 | * @access private |
| 970 | */ |
| 971 | private static function &_getColumnHeaders() { |
| 972 | if (!isset(self::$_columnHeaders)) { |
| 973 | $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, |
| 974 | 'address_options', TRUE, NULL, TRUE |
| 975 | ); |
| 976 | |
| 977 | self::$_columnHeaders = array( |
| 978 | 'contact_type' => array('desc' => ts('Contact Type')), |
| 979 | 'sort_name' => array( |
| 980 | 'name' => ts('Name'), |
| 981 | 'sort' => 'sort_name', |
| 982 | 'direction' => CRM_Utils_Sort::ASCENDING, |
| 983 | ), |
| 984 | ); |
| 985 | |
| 986 | $defaultAddress = array( |
| 987 | 'street_address' => array('name' => ts('Address')), |
| 988 | 'city' => array( |
| 989 | 'name' => ts('City'), |
| 990 | 'sort' => 'city', |
| 991 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 992 | ), |
| 993 | 'state_province' => array( |
| 994 | 'name' => ts('State'), |
| 995 | 'sort' => 'state_province', |
| 996 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 997 | ), |
| 998 | 'postal_code' => array( |
| 999 | 'name' => ts('Postal'), |
| 1000 | 'sort' => 'postal_code', |
| 1001 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1002 | ), |
| 1003 | 'country' => array( |
| 1004 | '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( |
| 1017 | 'name' => ts('Email'), |
| 1018 | 'sort' => 'email', |
| 1019 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1020 | ); |
| 1021 | |
| 1022 | self::$_columnHeaders['phone'] = array('name' => ts('Phone')); |
| 1023 | } |
| 1024 | return self::$_columnHeaders; |
| 1025 | } |
| 1026 | |
| 1027 | function &getQuery() { |
| 1028 | return $this->_query; |
| 1029 | } |
| 1030 | |
| 1031 | function alphabetQuery() { |
| 1032 | return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE); |
| 1033 | } |
| 1034 | |
| 1035 | function contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') { |
| 1036 | $sortOrder = &$this->getSortOrder($this->_action); |
| 1037 | $sort = new CRM_Utils_Sort($sortOrder, $sortID); |
| 1038 | |
| 1039 | // rectify params to what proximity search expects if there is a value for prox_distance |
| 1040 | // CRM-7021 CRM-7905 |
| 1041 | if (!empty($params)) { |
| 1042 | CRM_Contact_BAO_ProximityQuery::fixInputParams($params); |
| 1043 | } |
| 1044 | |
| 1045 | if (!$displayRelationshipType) { |
| 1046 | $query = new CRM_Contact_BAO_Query($params, |
| 1047 | $this->_returnProperties, |
| 1048 | NULL, FALSE, FALSE, 1, |
| 1049 | FALSE, TRUE, TRUE, NULL, |
| 1050 | $queryOperator |
| 1051 | ); |
| 1052 | } |
| 1053 | else { |
| 1054 | $query = new CRM_Contact_BAO_Query($params, $this->_returnProperties, |
| 1055 | NULL, FALSE, FALSE, 1, |
| 1056 | FALSE, TRUE, TRUE, $displayRelationshipType, |
| 1057 | $queryOperator |
| 1058 | ); |
| 1059 | } |
| 1060 | $value = $query->searchQuery(0, 0, $sort, |
| 1061 | FALSE, FALSE, FALSE, |
| 1062 | FALSE, FALSE |
| 1063 | ); |
| 1064 | return $value; |
| 1065 | } |
| 1066 | |
| 1067 | function &makeProperties(&$returnProperties) { |
| 1068 | $properties = array(); |
| 1069 | foreach ($returnProperties as $name => $value) { |
| 1070 | if ($name != 'location') { |
| 1071 | // special handling for group and tag |
| 1072 | if (in_array($name, array('group', 'tag'))) { |
| 1073 | $name = "{$name}s"; |
| 1074 | } |
| 1075 | |
| 1076 | // special handling for notes |
| 1077 | if (in_array($name, array('note', 'note_subject', 'note_body'))) { |
| 1078 | $name = "notes"; |
| 1079 | } |
| 1080 | |
| 1081 | $properties[] = $name; |
| 1082 | } |
| 1083 | else { |
| 1084 | // extract all the location stuff |
| 1085 | foreach ($value as $n => $v) { |
| 1086 | foreach ($v as $n1 => $v1) { |
| 1087 | if (!strpos('_id', $n1) && $n1 != 'location_type') { |
| 1088 | $properties[] = "{$n}-{$n1}"; |
| 1089 | } |
| 1090 | } |
| 1091 | } |
| 1092 | } |
| 1093 | } |
| 1094 | return $properties; |
| 1095 | } |
| 1096 | } |
| 1097 | //end of class |
| 1098 | |