CRM/Core/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * Base class for most search forms
  30  */
  31 class CRM_Core_Form_Search extends CRM_Core_Form {
  32
  33   /**
  34    * Are we forced to run a search
  35    *
  36    * @var int
  37    */
  38   protected $_force;
  39
  40   /**
  41    * Name of search button
  42    *
  43    * @var string
  44    */
  45   protected $_searchButtonName;
  46
  47   /**
  48    * Name of action button
  49    *
  50    * @var string
  51    */
  52   protected $_actionButtonName;
  53
  54   /**
  55    * Form values that we will be using
  56    *
  57    * @var array
  58    */
  59   public $_formValues;
  60
  61   /**
  62    * Have we already done this search
  63    *
  64    * @var bool
  65    */
  66   protected $_done;
  67
  68   /**
  69    * What context are we being invoked from
  70    *
  71    * @var string
  72    */
  73   protected $_context = NULL;
  74
  75   /**
  76    * The list of tasks or actions that a searcher can perform on a result set.
  77    *
  78    * @var array
  79    */
  80   protected $_taskList = [];
  81
  82   /**
  83    * Declare entity reference fields as they will need to be converted.
  84    *
  85    * The entity reference format looks like '2,3' whereas the Query object expects array(2, 3)
  86    * or array('IN' => array(2, 3). The latter is the one we are moving towards standardising on.
  87    *
  88    * @var array
  89    */
  90   protected $entityReferenceFields = [];
  91
  92   /**
  93    * Builds the list of tasks or actions that a searcher can perform on a result set.
  94    *
  95    * To modify the task list, child classes should alter $this->_taskList,
  96    * preferably by extending this method.
  97    *
  98    * @return array
  99    */
 100   protected function buildTaskList() {
 101     return $this->_taskList;
 102   }
 103
 104   /**
 105    * Metadata for fields on the search form.
 106    *
 107    * Instantiate with empty array for contact to prevent e-notices.
 108    *
 109    * @var array
 110    */
 111   protected $searchFieldMetadata = ['Contact' => []];
 112
 113   /**
 114    * @return array
 115    */
 116   public function getSearchFieldMetadata() {
 117     return $this->searchFieldMetadata;
 118   }
 119
 120   /**
 121    * @param array $searchFieldMetadata
 122    */
 123   public function addSearchFieldMetadata($searchFieldMetadata) {
 124     $this->searchFieldMetadata = array_merge($this->searchFieldMetadata, $searchFieldMetadata);
 125   }
 126
 127   /**
 128    * Prepare for search by loading options from the url, handling force searches, retrieving form values.
 129    *
 130    * @throws \CRM_Core_Exception
 131    * @throws \CiviCRM_API3_Exception
 132    */
 133   public function preProcess() {
 134     $this->loadStandardSearchOptionsFromUrl();
 135     if ($this->_force) {
 136       $this->handleForcedSearch();
 137     }
 138     $this->_formValues = $this->getFormValues();
 139   }
 140
 141   /**
 142    * This virtual function is used to set the default values of various form elements.
 143    *
 144    * @return array|NULL
 145    *   reference to the array of default values
 146    * @throws \CRM_Core_Exception
 147    */
 148   public function setDefaultValues() {
 149     // Use the form values stored to the form. Ideally 'formValues'
 150     // would remain 'pure' & another array would be wrangled.
 151     // We don't do that - so we want the version of formValues stored early on.
 152     $defaults = (array) $this->get('formValues');
 153     foreach (array_keys($this->getSearchFieldMetadata()) as $entity) {
 154       $defaults = array_merge($this->getEntityDefaults($entity), $defaults);
 155     }
 156     return $defaults;
 157   }
 158
 159   /**
 160    * Set the form values based on input and preliminary processing.
 161    *
 162    * @throws \Exception
 163    */
 164   protected function setFormValues() {
 165     $this->_formValues = $this->getFormValues();
 166     $this->set('formValues', $this->_formValues);
 167     $this->convertTextStringsToUseLikeOperator();
 168   }
 169
 170   /**
 171    * Common buildForm tasks required by all searches.
 172    */
 173   public function buildQuickForm() {
 174     CRM_Core_Resources::singleton()
 175       ->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header')
 176       ->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
 177
 178     $this->addButtons([
 179       [
 180         'type' => 'refresh',
 181         'name' => ts('Search'),
 182         'isDefault' => TRUE,
 183       ],
 184     ]);
 185
 186     $this->addClass('crm-search-form');
 187
 188     $tasks = $this->buildTaskList();
 189     $this->addTaskMenu($tasks);
 190   }
 191
 192   /**
 193    * Add any fields described in metadata to the form.
 194    *
 195    * The goal is to describe all fields in metadata and handle from metadata rather
 196    * than existing ad hoc handling.
 197    */
 198   public function addFormFieldsFromMetadata() {
 199     $this->addFormRule(['CRM_Core_Form_Search', 'formRule'], $this);
 200     $this->_action = CRM_Core_Action::ADVANCED;
 201     foreach ($this->getSearchFieldMetadata() as $entity => $fields) {
 202       foreach ($fields as $fieldName => $fieldSpec) {
 203         $fieldType = $fieldSpec['type'] ?? '';
 204         if ($fieldType === CRM_Utils_Type::T_DATE || $fieldType === (CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME) || $fieldType === CRM_Utils_Type::T_TIMESTAMP) {
 205           $title = empty($fieldSpec['unique_title']) ? $fieldSpec['title'] : $fieldSpec['unique_title'];
 206           $this->addDatePickerRange($fieldName, $title, ($fieldType === (CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME) || $fieldType === CRM_Utils_Type::T_TIMESTAMP));
 207         }
 208         else {
 209           // Not quite sure about moving to a mix of keying by entity vs permitting entity to
 210           // be passed in. The challenge of the former is that it doesn't permit ordering.
 211           // Perhaps keying was the wrong starting point & we should do a flat array as all
 212           // fields eventually need to be unique.
 213           $props = ['entity' => $fieldSpec['entity'] ?? $entity];
 214           if (isset($fields[$fieldName]['unique_title'])) {
 215             $props['label'] = $fields[$fieldName]['unique_title'];
 216           }
 217           elseif (isset($fields[$fieldName]['title'])) {
 218             $props['label'] = $fields[$fieldName]['title'];
 219           }
 220           if (empty($fieldSpec['is_pseudofield'])) {
 221             $this->addField($fieldName, $props);
 222           }
 223         }
 224       }
 225     }
 226   }
 227
 228   /**
 229    * Global validation rules for the form.
 230    *
 231    * @param array $fields
 232    *   Posted values of the form.
 233    * @param array $files
 234    * @param object $form
 235    *
 236    * @return array
 237    *   list of errors to be posted back to the form
 238    */
 239   public static function formRule($fields, $files, $form) {
 240     $errors = [];
 241     if (!is_a($form, 'CRM_Core_Form_Search')) {
 242       // So this gets hit with a form object when doing an activity date search from
 243       // advanced search, but a NULL object when doing a pledge search.
 244       return $errors;
 245     }
 246     foreach ($form->getSearchFieldMetadata() as $entity => $spec) {
 247       foreach ($spec as $fieldName => $fieldSpec) {
 248         if ($fieldSpec['type'] === CRM_Utils_Type::T_DATE || $fieldSpec['type'] === (CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME)) {
 249           if (!empty($fields[$fieldName . '_high']) && !empty($fields[$fieldName . '_low']) && empty($fields[$fieldName . '_relative'])) {
 250             if (strtotime($fields[$fieldName . '_low']) > strtotime($fields[$fieldName . '_high'])) {
 251               $errors[$fieldName . '_low'] = ts('%1: Please check that your date range is in correct chronological order.', [1 => $fieldSpec['title']]);
 252             }
 253           }
 254         }
 255       }
 256     }
 257     return $errors;
 258   }
 259
 260   /**
 261    * Get the validation rule to apply to a function.
 262    *
 263    * Alphanumeric is designed to always be safe & for now we just return
 264    * that but in future we can use tighter rules for types like int, bool etc.
 265    *
 266    * @param string $entity
 267    * @param string $fieldName
 268    *
 269    * @return string
 270    */
 271   protected function getValidationTypeForField($entity, $fieldName) {
 272     switch ($this->getSearchFieldMetadata()[$entity][$fieldName]['type']) {
 273       case CRM_Utils_Type::T_BOOLEAN:
 274         return 'Boolean';
 275
 276       case CRM_Utils_Type::T_INT:
 277         return 'CommaSeparatedIntegers';
 278
 279       case CRM_Utils_Type::T_DATE:
 280       case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME:
 281         return 'Timestamp';
 282
 283       default:
 284         return 'Alphanumeric';
 285     }
 286   }
 287
 288   /**
 289    * Get the defaults for the entity for any fields described in metadata.
 290    *
 291    * @param string $entity
 292    *
 293    * @return array
 294    *
 295    * @throws \CRM_Core_Exception
 296    */
 297   protected function getEntityDefaults($entity) {
 298     $defaults = [];
 299     foreach (CRM_Utils_Array::value($entity, $this->getSearchFieldMetadata(), []) as $fieldName => $fieldSpec) {
 300       if (empty($_POST[$fieldName])) {
 301         $value = CRM_Utils_Request::retrieveValue($fieldName, $this->getValidationTypeForField($entity, $fieldName), NULL, NULL, 'GET');
 302         if ($value !== NULL) {
 303           $defaults[$fieldName] = $value;
 304         }
 305         if ($fieldSpec['type'] === CRM_Utils_Type::T_DATE || ($fieldSpec['type'] === CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME)) {
 306           $low = CRM_Utils_Request::retrieveValue($fieldName . '_low', 'Timestamp', NULL, NULL, 'GET');
 307           $high = CRM_Utils_Request::retrieveValue($fieldName . '_high', 'Timestamp', NULL, NULL, 'GET');
 308           if ($low !== NULL || $high !== NULL) {
 309             $defaults[$fieldName . '_relative'] = 0;
 310             $defaults[$fieldName . '_low'] = $low ? date('Y-m-d H:i:s', strtotime($low)) : NULL;
 311             $defaults[$fieldName . '_high'] = $high ? date('Y-m-d H:i:s', strtotime($high)) : NULL;
 312           }
 313           else {
 314             $relative = CRM_Utils_Request::retrieveValue($fieldName . '_relative', 'String', NULL, NULL, 'GET');
 315             if (!empty($relative) && isset(CRM_Core_OptionGroup::values('relative_date_filters')[$relative])) {
 316               $defaults[$fieldName . '_relative'] = $relative;
 317             }
 318           }
 319         }
 320       }
 321     }
 322     return $defaults;
 323   }
 324
 325   /**
 326    * Convert any submitted text fields to use 'like' rather than '=' as the operator.
 327    *
 328    * This excludes any with options.
 329    *
 330    * Note this will only pick up fields declared via metadata.
 331    */
 332   protected function convertTextStringsToUseLikeOperator() {
 333     foreach ($this->getSearchFieldMetadata() as $entity => $fields) {
 334       foreach ($fields as $fieldName => $field) {
 335         if (!empty($this->_formValues[$fieldName]) && empty($field['options']) && empty($field['pseudoconstant'])) {
 336           if (in_array($field['type'], [CRM_Utils_Type::T_STRING, CRM_Utils_Type::T_TEXT])) {
 337             $this->_formValues[$fieldName] = ['LIKE' => CRM_Contact_BAO_Query::getWildCardedValue(TRUE, 'LIKE', trim($this->_formValues[$fieldName]))];
 338           }
 339         }
 340       }
 341     }
 342   }
 343
 344   /**
 345    * Add checkboxes for each row plus a master checkbox.
 346    *
 347    * @param array $rows
 348    */
 349   public function addRowSelectors($rows) {
 350     $this->addElement('checkbox', 'toggleSelect', NULL, NULL, ['class' => 'select-rows']);
 351     if (!empty($rows)) {
 352       foreach ($rows as $row) {
 353         if (!empty($row['checkbox'])) {
 354           $this->addElement('checkbox', $row['checkbox'], NULL, NULL, ['class' => 'select-row']);
 355         }
 356       }
 357     }
 358   }
 359
 360   /**
 361    * Add actions menu to search results form.
 362    *
 363    * @param array $tasks
 364    */
 365   public function addTaskMenu($tasks) {
 366     $taskMetaData = [];
 367     foreach ($tasks as $key => $task) {
 368       $taskMetaData[$key] = ['title' => $task];
 369     }
 370     parent::addTaskMenu($taskMetaData);
 371   }
 372
 373   /**
 374    * Add the sort-name field to the form.
 375    *
 376    * There is a setting to determine whether email is included in the search & we look this up to determine
 377    * which text to choose.
 378    *
 379    * Note that for translation purposes the full string works better than using 'prefix' hence we use override-able functions
 380    * to define the string.
 381    */
 382   protected function addSortNameField() {
 383     $title = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']) ? $this->getSortNameLabelWithEmail() : $this->getSortNameLabelWithOutEmail();
 384     $this->addElement(
 385       'text',
 386       'sort_name',
 387       $title,
 388       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
 389     );
 390     $this->searchFieldMetadata['Contact']['sort_name'] = ['name' => 'sort_name', 'title' => $title, 'type' => CRM_Utils_Type::T_STRING];
 391   }
 392
 393   /**
 394    * Get the label for the sortName field if email searching is on.
 395    *
 396    * (email searching is a setting under search preferences).
 397    *
 398    * @return string
 399    */
 400   protected function getSortNameLabelWithEmail() {
 401     return ts('Name or Email');
 402   }
 403
 404   /**
 405    * Get the label for the sortName field if email searching is off.
 406    *
 407    * (email searching is a setting under search preferences).
 408    *
 409    * @return string
 410    */
 411   protected function getSortNameLabelWithOutEmail() {
 412     return ts('Name');
 413   }
 414
 415   /**
 416    * Explicitly declare the form context for addField().
 417    */
 418   public function getDefaultContext() {
 419     return 'search';
 420   }
 421
 422   /**
 423    * Add generic fields that specify the contact.
 424    */
 425   protected function addContactSearchFields() {
 426     if (!$this->isFormInViewOrEditMode()) {
 427       return;
 428     }
 429     $this->addSortNameField();
 430
 431     $this->_group = CRM_Core_PseudoConstant::nestedGroup();
 432     if ($this->_group) {
 433       $this->add('select', 'group', $this->getGroupLabel(), $this->_group, FALSE,
 434         [
 435           'id' => 'group',
 436           'multiple' => 'multiple',
 437           'class' => 'crm-select2',
 438         ]
 439       );
 440     }
 441
 442     $contactTags = CRM_Core_BAO_Tag::getTags();
 443     if ($contactTags) {
 444       $this->add('select', 'contact_tags', $this->getTagLabel(), $contactTags, FALSE,
 445         [
 446           'id' => 'contact_tags',
 447           'multiple' => 'multiple',
 448           'class' => 'crm-select2',
 449         ]
 450       );
 451     }
 452     $this->addField('contact_type', ['entity' => 'Contact']);
 453
 454     if (CRM_Core_Permission::check('access deleted contacts') && Civi::settings()->get('contact_undelete')) {
 455       $this->addElement('checkbox', 'deleted_contacts', ts('Search in Trash') . '<br />' . ts('(deleted contacts)'));
 456     }
 457
 458   }
 459
 460   /**
 461    * we allow the controller to set force/reset externally, useful when we are being
 462    * driven by the wizard framework
 463    */
 464   protected function loadStandardSearchOptionsFromUrl() {
 465     $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean');
 466     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
 467     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
 468     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'search');
 469     $this->_ssID = CRM_Utils_Request::retrieve('ssID', 'Positive', $this);
 470     $this->assign("context", $this->_context);
 471   }
 472
 473   /**
 474    * Get user submitted values.
 475    *
 476    * Get it from controller only if form has been submitted, else preProcess has set this
 477    */
 478   protected function loadFormValues() {
 479     if (!empty($_POST)  && !$this->controller->isModal()) {
 480       $this->_formValues = $this->controller->exportValues($this->_name);
 481     }
 482     else {
 483       $this->_formValues = $this->get('formValues');
 484     }
 485
 486     if (empty($this->_formValues)) {
 487       if (isset($this->_ssID)) {
 488         $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 489       }
 490     }
 491   }
 492
 493   /**
 494    * Get the form values.
 495    *
 496    * @todo consolidate with loadFormValues()
 497    *
 498    * @return array
 499    *
 500    * @throws \CRM_Core_Exception
 501    */
 502   protected function getFormValues() {
 503     if (!empty($_POST) && !$this->_force) {
 504       return $this->controller->exportValues($this->_name);
 505     }
 506     if ($this->_force) {
 507       return $this->setDefaultValues();
 508     }
 509     return (array) $this->get('formValues');
 510   }
 511
 512   /**
 513    * Set the metadata for the form.
 514    *
 515    * @throws \CiviCRM_API3_Exception
 516    */
 517   protected function setSearchMetadata() {}
 518
 519   /**
 520    * Handle force=1 in the url.
 521    *
 522    * Search field metadata is normally added in buildForm but we are bypassing that in this flow
 523    * (I've always found the flow kinda confusing & perhaps that is the problem but this mitigates)
 524    *
 525    * @throws \CiviCRM_API3_Exception
 526    */
 527   protected function handleForcedSearch() {
 528     $this->setSearchMetadata();
 529     $this->addContactSearchFields();
 530     $this->postProcess();
 531     $this->set('force', 0);
 532   }
 533
 534 }