CRM/Activity/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This file is for activity search.
  20  */
  21 class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
  22
  23   /**
  24    * @var bool
  25    */
  26   public $submitOnce = TRUE;
  27
  28   /**
  29    * The params that are sent to the query.
  30    *
  31    * @var array
  32    */
  33   protected $_queryParams;
  34
  35   /**
  36    * Are we restricting ourselves to a single contact.
  37    *
  38    * @var bool
  39    */
  40   protected $_single = FALSE;
  41
  42   /**
  43    * Are we restricting ourselves to a single contact.
  44    *
  45    * @var bool
  46    */
  47   protected $_limit;
  48
  49   /**
  50    * Prefix for the controller.
  51    * @var string
  52    */
  53   protected $_prefix = 'activity_';
  54
  55   /**
  56    * The saved search ID retrieved from the GET vars.
  57    *
  58    * @var int
  59    */
  60   protected $_ssID;
  61
  62   /**
  63    * @return string
  64    */
  65   public function getDefaultEntity(): string {
  66     return 'Activity';
  67   }
  68
  69   /**
  70    * Processing needed for buildForm and later.
  71    *
  72    * @throws \CRM_Core_Exception
  73    * @throws \CiviCRM_API3_Exception
  74    */
  75   public function preProcess(): void {
  76     $this->set('searchFormName', 'Search');
  77
  78     // set the button names
  79     $this->_actionButtonName = $this->getButtonName('next', 'action');
  80
  81     $this->_done = FALSE;
  82     $this->sortNameOnly = TRUE;
  83
  84     parent::preProcess();
  85
  86     if (empty($this->_formValues) && isset($this->_ssID)) {
  87       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
  88     }
  89
  90     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
  91     $selector = new CRM_Activity_Selector_Search($this->_queryParams,
  92       $this->_action,
  93       NULL,
  94       $this->_single,
  95       $this->_limit,
  96       $this->_context
  97     );
  98     $prefix = NULL;
  99     if ($this->_context === 'user') {
 100       $prefix = $this->_prefix;
 101     }
 102
 103     $this->assign("{$prefix}limit", $this->_limit);
 104     $this->assign("{$prefix}single", $this->_single);
 105
 106     $controller = new CRM_Core_Selector_Controller($selector,
 107       $this->get(CRM_Utils_Pager::PAGE_ID),
 108       $this->getSortID(),
 109       CRM_Core_Action::VIEW,
 110       $this,
 111       CRM_Core_Selector_Controller::TRANSFER,
 112       $prefix
 113     );
 114     $controller->setEmbedded(TRUE);
 115     $controller->moveFromSessionToTemplate();
 116
 117     $this->assign('summary', $this->get('summary'));
 118   }
 119
 120   /**
 121    * Build the form object.
 122    *
 123    * @throws \CRM_Core_Exception
 124    * @throws \CiviCRM_API3_Exception
 125    */
 126   public function buildQuickForm(): void {
 127     parent::buildQuickForm();
 128     $this->addSortNameField();
 129
 130     CRM_Activity_BAO_Query::buildSearchForm($this);
 131
 132     $rows = $this->get('rows');
 133     if (is_array($rows)) {
 134       if (!$this->_single) {
 135         $this->addRowSelectors($rows);
 136       }
 137
 138       $this->addTaskMenu(CRM_Activity_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission()));
 139     }
 140
 141   }
 142
 143   /**
 144    * The post processing of the form gets done here.
 145    *
 146    * Key things done during post processing are
 147    *      - check for reset or next request. if present, skip post procesing.
 148    *      - now check if user requested running a saved search, if so, then
 149    *        the form values associated with the saved search are used for searching.
 150    *      - if user has done a submit with new values the regular post submissing is
 151    *        done.
 152    *
 153    * The processing consists of using a Selector / Controller framework for getting the
 154    * search results.
 155    *
 156    * @throws \CRM_Core_Exception|\CiviCRM_API3_Exception
 157    */
 158   public function postProcess(): void {
 159     if ($this->_done) {
 160       return;
 161     }
 162
 163     $this->_done = TRUE;
 164     $this->setFormValues();
 165     if (!empty($_POST)) {
 166       $specialParams = [
 167         'activity_type_id',
 168         'priority_id',
 169       ];
 170       $changeNames = [
 171         'priority_id' => 'activity_priority_id',
 172       ];
 173
 174       CRM_Contact_BAO_Query::processSpecialFormValue($this->_formValues, $specialParams, $changeNames);
 175     }
 176     $this->fixFormValues();
 177
 178     if (isset($this->_ssID) && empty($_POST)) {
 179       // if we are editing / running a saved search and the form has not been posted
 180       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 181     }
 182
 183     // We don't show test records in summaries or dashboards
 184     if (empty($this->_formValues['activity_test']) && $this->_force) {
 185       $this->_formValues['activity_test'] = 0;
 186     }
 187
 188     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 189
 190     $this->set('queryParams', $this->_queryParams);
 191
 192     $buttonName = $this->controller->getButtonName();
 193     if ($buttonName == $this->_actionButtonName) {
 194       // check actionName and if next, then do not repeat a search, since we are going to the next page
 195       // hack, make sure we reset the task values
 196       $stateMachine = $this->controller->getStateMachine();
 197       $formName = $stateMachine->getTaskFormName();
 198       $this->controller->resetPage($formName);
 199       return;
 200     }
 201
 202     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 203
 204     $selector = new CRM_Activity_Selector_Search($this->_queryParams,
 205       $this->_action,
 206       NULL,
 207       $this->_single,
 208       $this->_limit,
 209       $this->_context
 210     );
 211     $selector->setKey($this->controller->_key);
 212
 213     $prefix = NULL;
 214     if ($this->_context === 'basic' || $this->_context === 'user') {
 215       $prefix = $this->_prefix;
 216     }
 217
 218     $controller = new CRM_Core_Selector_Controller($selector,
 219       $this->get(CRM_Utils_Pager::PAGE_ID),
 220       $this->getSortID(),
 221       CRM_Core_Action::VIEW,
 222       $this,
 223       CRM_Core_Selector_Controller::SESSION,
 224       $prefix
 225     );
 226     $controller->setEmbedded(TRUE);
 227     $query = &$selector->getQuery();
 228
 229     if ($this->_context === 'user') {
 230       $query->setSkipPermission(TRUE);
 231     }
 232     $controller->run();
 233   }
 234
 235   /**
 236    * Probably more hackery than anything else.
 237    *
 238    * @throws \CRM_Core_Exception
 239    */
 240   public function fixFormValues() {
 241     if (!$this->_force) {
 242       return;
 243     }
 244
 245     $status = CRM_Utils_Request::retrieve('status', 'String', $this);
 246     if ($status) {
 247       $this->_formValues['activity_status_id'] = $status;
 248       $this->_defaults['activity_status_id'] = $status;
 249     }
 250
 251     $survey = CRM_Utils_Request::retrieve('survey', 'Positive');
 252
 253     if ($survey) {
 254       $this->_formValues['activity_survey_id'] = $this->_defaults['activity_survey_id'] = $survey;
 255       $sid = $this->_formValues['activity_survey_id'] ?? NULL;
 256       $activity_type_id = CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $sid, 'activity_type_id');
 257
 258       // since checkbox are replaced by multiple select option
 259       $this->_formValues['activity_type_id'] = $activity_type_id;
 260       $this->_defaults['activity_type_id'] = $activity_type_id;
 261     }
 262     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 263
 264     if ($cid) {
 265       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 266       if ($cid > 0) {
 267         $this->_formValues['contact_id'] = $cid;
 268
 269         $activity_role = CRM_Utils_Request::retrieve('activity_role', 'Positive', $this);
 270
 271         if ($activity_role) {
 272           $this->_formValues['activity_role'] = $activity_role;
 273         }
 274         else {
 275           $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'sort_name');
 276         }
 277         // also assign individual mode to the template
 278         $this->_single = TRUE;
 279       }
 280     }
 281
 282     // Enable search activity by custom value
 283     // @todo this is not good security practice. Instead define entity fields in metadata &
 284     // use getEntity Defaults
 285     $requestParams = CRM_Utils_Request::exportValues();
 286     foreach (array_keys($requestParams) as $key) {
 287       if (substr($key, 0, 7) !== 'custom_') {
 288         continue;
 289       }
 290       elseif (empty($requestParams[$key])) {
 291         continue;
 292       }
 293       $customValue = CRM_Utils_Request::retrieve($key, 'String', $this);
 294       if ($customValue) {
 295         $this->_formValues[$key] = $customValue;
 296         $this->_defaults[$key] = $customValue;
 297       }
 298     }
 299
 300     if (!empty($this->_defaults)) {
 301       $this->setDefaults($this->_defaults);
 302     }
 303   }
 304
 305   /**
 306    * Return a descriptive name for the page, used in wizard header
 307    *
 308    * @return string
 309    */
 310   public function getTitle() {
 311     return ts('Find Activities');
 312   }
 313
 314   /**
 315    * Get metadata for the entity  fields.
 316    *
 317    * @return array
 318    *
 319    * @throws \CiviCRM_API3_Exception
 320    */
 321   protected function getEntityMetadata() {
 322     return CRM_Activity_BAO_Query::getSearchFieldMetadata();
 323   }
 324
 325   /**
 326    * Set the metadata for the form.
 327    */
 328   protected function setSearchMetadata() {
 329     $this->addSearchFieldMetadata(['Activity' => $this->getEntityMetadata()]);
 330   }
 331
 332 }