CRM/Contact/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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * Base Search / View form for *all* listing of multiple
  36  * contacts
  37  */
  38 class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
  39
  40   /**
  41    * list of valid contexts.
  42    *
  43    * @var array
  44    */
  45   public static $_validContext = NULL;
  46
  47   /**
  48    * List of values used when we want to display other objects.
  49    *
  50    * @var array
  51    */
  52   public static $_modeValues = NULL;
  53
  54   /**
  55    * The contextMenu.
  56    *
  57    * @var array
  58    */
  59   protected $_contextMenu;
  60
  61   /**
  62    * The groupId retrieved from the GET vars.
  63    *
  64    * @var int
  65    */
  66   public $_groupID;
  67
  68   /**
  69    * The Group ID belonging to Add Member to group ID.
  70    * retrieved from the GET vars
  71    *
  72    * @var int
  73    */
  74   protected $_amtgID;
  75
  76   /**
  77    * The saved search ID retrieved from the GET vars.
  78    *
  79    * @var int
  80    */
  81   protected $_ssID;
  82
  83   /**
  84    * The group elements.
  85    *
  86    * @var array
  87    */
  88   public $_group;
  89   public $_groupElement;
  90
  91   /**
  92    * The tag elements.
  93    *
  94    * @var array
  95    */
  96   public $_tag;
  97   public $_tagElement;
  98
  99   /**
 100    * The params used for search.
 101    *
 102    * @var array
 103    */
 104   protected $_params;
 105
 106   /**
 107    * The return properties used for search.
 108    *
 109    * @var array
 110    */
 111   protected $_returnProperties;
 112
 113   /**
 114    * The sort by character.
 115    *
 116    * @var string
 117    */
 118   protected $_sortByCharacter;
 119
 120   /**
 121    * The profile group id used for display.
 122    *
 123    * @var int
 124    */
 125   protected $_ufGroupID;
 126
 127   /**
 128    * Csv - common search values
 129    *
 130    * @var array
 131    */
 132   public static $csv = ['contact_type', 'group', 'tag'];
 133
 134   /**
 135    * How to display the results. Should we display as contributons, members, cases etc.
 136    *
 137    * @var string
 138    */
 139   protected $_componentMode;
 140
 141   /**
 142    * What operator should we use, AND or OR.
 143    *
 144    * @var string
 145    */
 146   protected $_operator;
 147
 148   protected $_modeValue;
 149
 150   /**
 151    * Declare entity reference fields as they will need to be converted to using 'IN'.
 152    *
 153    * @var array
 154    */
 155   protected $entityReferenceFields = ['event_id', 'membership_type_id'];
 156
 157   /**
 158    * Name of the selector to use.
 159    * @var string
 160    */
 161   public static $_selectorName = 'CRM_Contact_Selector';
 162   protected $_customSearchID = NULL;
 163   protected $_customSearchClass = NULL;
 164
 165   protected $_openedPanes = [];
 166
 167   /**
 168    * Explicitly declare the entity api name.
 169    */
 170   public function getDefaultEntity() {
 171     return 'Contact';
 172   }
 173
 174   /**
 175    * Define the set of valid contexts that the search form operates on.
 176    *
 177    * @return array
 178    *   the valid context set and the titles
 179    */
 180   public static function &validContext() {
 181     if (!(self::$_validContext)) {
 182       self::$_validContext = [
 183         'smog' => 'Show members of group',
 184         'amtg' => 'Add members to group',
 185         'basic' => 'Basic Search',
 186         'search' => 'Search',
 187         'builder' => 'Search Builder',
 188         'advanced' => 'Advanced Search',
 189         'custom' => 'Custom Search',
 190       ];
 191     }
 192     return self::$_validContext;
 193   }
 194
 195   /**
 196    * @param $context
 197    *
 198    * @return bool
 199    */
 200   public static function isSearchContext($context) {
 201     $searchContext = CRM_Utils_Array::value($context, self::validContext());
 202     return $searchContext ? TRUE : FALSE;
 203   }
 204
 205   public static function setModeValues() {
 206     self::$_modeValues = [
 207       CRM_Contact_BAO_Query::MODE_CONTACTS => [
 208         'selectorName' => self::$_selectorName,
 209         'selectorLabel' => ts('Contacts'),
 210         'taskFile' => 'CRM/Contact/Form/Search/ResultTasks.tpl',
 211         'taskContext' => NULL,
 212         'resultFile' => 'CRM/Contact/Form/Selector.tpl',
 213         'resultContext' => NULL,
 214         'taskClassName' => 'CRM_Contact_Task',
 215         'component' => '',
 216       ],
 217       CRM_Contact_BAO_Query::MODE_CONTRIBUTE => [
 218         'selectorName' => 'CRM_Contribute_Selector_Search',
 219         'selectorLabel' => ts('Contributions'),
 220         'taskFile' => 'CRM/common/searchResultTasks.tpl',
 221         'taskContext' => 'Contribution',
 222         'resultFile' => 'CRM/Contribute/Form/Selector.tpl',
 223         'resultContext' => 'Search',
 224         'taskClassName' => 'CRM_Contribute_Task',
 225         'component' => 'CiviContribute',
 226       ],
 227       CRM_Contact_BAO_Query::MODE_EVENT => [
 228         'selectorName' => 'CRM_Event_Selector_Search',
 229         'selectorLabel' => ts('Event Participants'),
 230         'taskFile' => 'CRM/common/searchResultTasks.tpl',
 231         'taskContext' => NULL,
 232         'resultFile' => 'CRM/Event/Form/Selector.tpl',
 233         'resultContext' => 'Search',
 234         'taskClassName' => 'CRM_Event_Task',
 235         'component' => 'CiviEvent',
 236       ],
 237       CRM_Contact_BAO_Query::MODE_ACTIVITY => [
 238         'selectorName' => 'CRM_Activity_Selector_Search',
 239         'selectorLabel' => ts('Activities'),
 240         'taskFile' => 'CRM/common/searchResultTasks.tpl',
 241         'taskContext' => NULL,
 242         'resultFile' => 'CRM/Activity/Form/Selector.tpl',
 243         'resultContext' => 'Search',
 244         'taskClassName' => 'CRM_Activity_Task',
 245         'component' => 'activity',
 246       ],
 247       CRM_Contact_BAO_Query::MODE_MEMBER => [
 248         'selectorName' => 'CRM_Member_Selector_Search',
 249         'selectorLabel' => ts('Memberships'),
 250         'taskFile' => "CRM/common/searchResultTasks.tpl",
 251         'taskContext' => NULL,
 252         'resultFile' => 'CRM/Member/Form/Selector.tpl',
 253         'resultContext' => 'Search',
 254         'taskClassName' => 'CRM_Member_Task',
 255         'component' => 'CiviMember',
 256       ],
 257       CRM_Contact_BAO_Query::MODE_CASE => [
 258         'selectorName' => 'CRM_Case_Selector_Search',
 259         'selectorLabel' => ts('Cases'),
 260         'taskFile' => "CRM/common/searchResultTasks.tpl",
 261         'taskContext' => NULL,
 262         'resultFile' => 'CRM/Case/Form/Selector.tpl',
 263         'resultContext' => 'Search',
 264         'taskClassName' => 'CRM_Case_Task',
 265         'component' => 'CiviCase',
 266       ],
 267       CRM_Contact_BAO_Query::MODE_CONTACTSRELATED => [
 268         'selectorName' => self::$_selectorName,
 269         'selectorLabel' => ts('Related Contacts'),
 270         'taskFile' => 'CRM/Contact/Form/Search/ResultTasks.tpl',
 271         'taskContext' => NULL,
 272         'resultFile' => 'CRM/Contact/Form/Selector.tpl',
 273         'resultContext' => NULL,
 274         'taskClassName' => 'CRM_Contact_Task',
 275         'component' => 'related_contact',
 276       ],
 277       CRM_Contact_BAO_Query::MODE_MAILING => [
 278         'selectorName' => 'CRM_Mailing_Selector_Search',
 279         'selectorLabel' => ts('Mailings'),
 280         'taskFile' => "CRM/common/searchResultTasks.tpl",
 281         'taskContext' => NULL,
 282         'resultFile' => 'CRM/Mailing/Form/Selector.tpl',
 283         'resultContext' => 'Search',
 284         'taskClassName' => 'CRM_Mailing_Task',
 285         'component' => 'CiviMail',
 286       ],
 287     ];
 288   }
 289
 290   /**
 291    * Get the metadata for the query mode (this includes task class names)
 292    *
 293    * @param int $mode
 294    *
 295    * @return array
 296    * @throws \CRM_Core_Exception
 297    */
 298   public static function getModeValue($mode = CRM_Contact_BAO_Query::MODE_CONTACTS) {
 299     $searchPane = CRM_Utils_Request::retrieve('searchPane', 'String');
 300     if (!empty($searchPane)) {
 301       $mode = array_search($searchPane, self::getModeToComponentMapping());
 302     }
 303
 304     self::setModeValues();
 305     if (!array_key_exists($mode, self::$_modeValues)) {
 306       $mode = CRM_Contact_BAO_Query::MODE_CONTACTS;
 307     }
 308
 309     return self::$_modeValues[$mode];
 310   }
 311
 312   /**
 313    * Get a mapping of modes to components.
 314    *
 315    * This will map the integers to the components. Contact has an empty component
 316    * an pseudo-components exist for activity & related_contact.
 317    *
 318    * @return array
 319    */
 320   public static function getModeToComponentMapping() {
 321     $mapping = [];
 322     self::setModeValues();
 323
 324     foreach (self::$_modeValues as $id => $metadata) {
 325       $mapping[$id] = $metadata['component'];
 326     }
 327     return $mapping;
 328   }
 329
 330   /**
 331    * @return array
 332    */
 333   public static function getModeSelect() {
 334     self::setModeValues();
 335
 336     $enabledComponents = CRM_Core_Component::getEnabledComponents();
 337     $componentModes = [];
 338     foreach (self::$_modeValues as $id => & $value) {
 339       if (strpos($value['component'], 'Civi') !== FALSE
 340         && !array_key_exists($value['component'], $enabledComponents)
 341       ) {
 342         continue;
 343       }
 344       $componentModes[$id] = $value['selectorLabel'];
 345     }
 346
 347     // unset disabled components
 348     if (!array_key_exists('CiviMail', $enabledComponents)) {
 349       unset($componentModes[CRM_Contact_BAO_Query::MODE_MAILING]);
 350     }
 351
 352     // unset contributions or participants if user does not have permission on them
 353     if (!CRM_Core_Permission::access('CiviContribute')) {
 354       unset($componentModes[CRM_Contact_BAO_Query::MODE_CONTRIBUTE]);
 355     }
 356
 357     if (!CRM_Core_Permission::access('CiviEvent')) {
 358       unset($componentModes[CRM_Contact_BAO_Query::MODE_EVENT]);
 359     }
 360
 361     if (!CRM_Core_Permission::access('CiviMember')) {
 362       unset($componentModes[CRM_Contact_BAO_Query::MODE_MEMBER]);
 363     }
 364
 365     if (!CRM_Core_Permission::check('view all activities')) {
 366       unset($componentModes[CRM_Contact_BAO_Query::MODE_ACTIVITY]);
 367     }
 368
 369     return $componentModes;
 370   }
 371
 372   /**
 373    * Builds the list of tasks or actions that a searcher can perform on a result set.
 374    *
 375    * @return array
 376    */
 377   public function buildTaskList() {
 378     // amtg = 'Add members to group'
 379     if ($this->_context !== 'amtg') {
 380       $taskParams['deletedContacts'] = FALSE;
 381       if ($this->_componentMode == CRM_Contact_BAO_Query::MODE_CONTACTS || $this->_componentMode == CRM_Contact_BAO_Query::MODE_CONTACTSRELATED) {
 382         $taskParams['deletedContacts'] = CRM_Utils_Array::value('deleted_contacts', $this->_formValues);
 383       }
 384       $className = $this->_modeValue['taskClassName'];
 385       $taskParams['ssID'] = isset($this->_ssID) ? $this->_ssID : NULL;
 386       $this->_taskList += $className::permissionedTaskTitles(CRM_Core_Permission::getPermission(), $taskParams);
 387     }
 388
 389     return $this->_taskList;
 390   }
 391
 392   /**
 393    * Build the common elements between the search/advanced form.
 394    */
 395   public function buildQuickForm() {
 396     parent::buildQuickForm();
 397
 398     // some tasks.. what do we want to do with the selected contacts ?
 399     $this->_taskList = $this->buildTaskList();
 400
 401     if (isset($this->_ssID)) {
 402       $search_custom_id
 403         = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID, 'search_custom_id');
 404
 405       $savedSearchValues = [
 406         'id' => $this->_ssID,
 407         'name' => CRM_Contact_BAO_SavedSearch::getName($this->_ssID, 'title'),
 408         'search_custom_id' => $search_custom_id,
 409       ];
 410       $this->assign_by_ref('savedSearch', $savedSearchValues);
 411       $this->assign('ssID', $this->_ssID);
 412     }
 413
 414     if ($this->_context === 'smog') {
 415       // CRM-11788, we might want to do this for all of search where force=1
 416       $formQFKey = CRM_Utils_Array::value('qfKey', $this->_formValues);
 417       $getQFKey = CRM_Utils_Array::value('qfKey', $_GET);
 418       $postQFKey = CRM_Utils_Array::value('qfKey', $_POST);
 419       if ($formQFKey && empty($getQFKey) && empty($postQFKey)) {
 420         $url = CRM_Utils_System::makeURL('qfKey') . $formQFKey;
 421         CRM_Utils_System::redirect($url);
 422       }
 423       $permissionForGroup = FALSE;
 424
 425       if (!empty($this->_groupID)) {
 426         // check if user has permission to edit members of this group
 427         $permission = CRM_Contact_BAO_Group::checkPermission($this->_groupID);
 428         if ($permission && in_array(CRM_Core_Permission::EDIT, $permission)) {
 429           $permissionForGroup = TRUE;
 430         }
 431
 432         // check if _groupID exists, it might not if
 433         // we are displaying a hidden group
 434         if (!isset($this->_group[$this->_groupID])) {
 435           $this->_group[$this->_groupID]
 436             = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID, 'title');
 437         }
 438
 439         // set the group title
 440         $groupValues = ['id' => $this->_groupID, 'title' => $this->_group[$this->_groupID]];
 441         $this->assign_by_ref('group', $groupValues);
 442
 443         // also set ssID if this is a saved search
 444         $ssID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID, 'saved_search_id');
 445         $this->assign('ssID', $ssID);
 446
 447         //get the saved search mapping id
 448         if ($ssID) {
 449           $this->_ssID = $ssID;
 450           $ssMappingId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $ssID, 'mapping_id');
 451           $this->assign('ssMappingID', $ssMappingId);
 452         }
 453
 454         // Set dynamic page title for 'Show Members of Group'
 455         CRM_Utils_System::setTitle(ts('Contacts in Group: %1', [1 => $this->_group[$this->_groupID]]));
 456       }
 457
 458       $group_contact_status = [];
 459       foreach (CRM_Core_SelectValues::groupContactStatus() as $k => $v) {
 460         if (!empty($k)) {
 461           $group_contact_status[] = $this->createElement('checkbox', $k, NULL, $v);
 462         }
 463       }
 464       $this->addGroup($group_contact_status,
 465         'group_contact_status', ts('Group Status')
 466       );
 467
 468       $this->assign('permissionedForGroup', $permissionForGroup);
 469     }
 470
 471     // add the go button for the action form, note it is of type 'next' rather than of type 'submit'
 472     if ($this->_context === 'amtg') {
 473       // check if _groupID exists, it might not if
 474       // we are displaying a hidden group
 475       if (!isset($this->_group[$this->_amtgID])) {
 476         $this->assign('permissionedForGroup', FALSE);
 477         $this->_group[$this->_amtgID]
 478           = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_amtgID, 'title');
 479       }
 480
 481       // Set dynamic page title for 'Add Members Group'
 482       CRM_Utils_System::setTitle(ts('Add to Group: %1', [1 => $this->_group[$this->_amtgID]]));
 483       // also set the group title and freeze the action task with Add Members to Group
 484       $groupValues = ['id' => $this->_amtgID, 'title' => $this->_group[$this->_amtgID]];
 485       $this->assign_by_ref('group', $groupValues);
 486       $this->add('submit', $this->_actionButtonName, ts('Add Contacts to %1', [1 => $this->_group[$this->_amtgID]]),
 487         [
 488           'class' => 'crm-form-submit',
 489         ]
 490       );
 491       $this->add('hidden', 'task', CRM_Contact_Task::GROUP_ADD);
 492       $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', ['checked' => 'checked']);
 493       $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
 494       $this->assign('ts_sel_id', $selectedRowsRadio->_attributes['id']);
 495       $this->assign('ts_all_id', $allRowsRadio->_attributes['id']);
 496     }
 497
 498     $selectedContactIds = [];
 499     $qfKeyParam = CRM_Utils_Array::value('qfKey', $this->_formValues);
 500     // We use ajax to handle selections only if the search results component_mode is set to "contacts"
 501     if ($qfKeyParam && ($this->get('component_mode') <= CRM_Contact_BAO_Query::MODE_CONTACTS || $this->get('component_mode') == CRM_Contact_BAO_Query::MODE_CONTACTSRELATED)) {
 502       $this->addClass('crm-ajax-selection-form');
 503       $qfKeyParam = "civicrm search {$qfKeyParam}";
 504       $selectedContactIdsArr = Civi::service('prevnext')->getSelection($qfKeyParam);
 505       $selectedContactIds = array_keys($selectedContactIdsArr[$qfKeyParam]);
 506     }
 507
 508     $this->assign_by_ref('selectedContactIds', $selectedContactIds);
 509
 510     $rows = $this->get('rows');
 511
 512     if (is_array($rows)) {
 513       $this->addRowSelectors($rows);
 514     }
 515
 516   }
 517
 518   /**
 519    * Processing needed for buildForm and later.
 520    */
 521   public function preProcess() {
 522     // set the various class variables
 523
 524     $this->_group = CRM_Core_PseudoConstant::group();
 525
 526     $this->_tag = CRM_Core_BAO_Tag::getTags();
 527     $this->_done = FALSE;
 528
 529     /*
 530      * we allow the controller to set force/reset externally, useful when we are being
 531      * driven by the wizard framework
 532      */
 533
 534     $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean');
 535
 536     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean');
 537     $this->_groupID = CRM_Utils_Request::retrieve('gid', 'Positive', $this);
 538     $this->_amtgID = CRM_Utils_Request::retrieve('amtgID', 'Positive', $this);
 539     $this->_ssID = CRM_Utils_Request::retrieve('ssID', 'Positive', $this);
 540     $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String', $this);
 541     $this->_ufGroupID = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 542     $this->_componentMode = CRM_Utils_Request::retrieve('component_mode', 'Positive', $this, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS, $_REQUEST);
 543     $this->_operator = CRM_Utils_Request::retrieve('operator', 'String', $this, FALSE, CRM_Contact_BAO_Query::SEARCH_OPERATOR_AND, 'REQUEST');
 544
 545     /**
 546      * set the button names
 547      */
 548     $this->_searchButtonName = $this->getButtonName('refresh');
 549     $this->_actionButtonName = $this->getButtonName('next', 'action');
 550
 551     $this->assign('actionButtonName', $this->_actionButtonName);
 552
 553     // if we dont get this from the url, use default if one exsts
 554     $config = CRM_Core_Config::singleton();
 555     if ($this->_ufGroupID == NULL &&
 556       $config->defaultSearchProfileID != NULL
 557     ) {
 558       $this->_ufGroupID = $config->defaultSearchProfileID;
 559     }
 560
 561     // assign context to drive the template display, make sure context is valid
 562     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'search');
 563     if (!CRM_Utils_Array::value($this->_context, self::validContext())) {
 564       $this->_context = 'search';
 565     }
 566     $this->set('context', $this->_context);
 567     $this->assign('context', $this->_context);
 568
 569     $this->_modeValue = self::getModeValue($this->_componentMode);
 570     $this->assign($this->_modeValue);
 571
 572     $this->set('selectorName', self::$_selectorName);
 573
 574     // get user submitted values
 575     // get it from controller only if form has been submitted, else preProcess has set this
 576     // $this->controller->isModal( ) returns TRUE if page is
 577     // valid, i.e all the validations are TRUE
 578
 579     if (!empty($_POST) && !$this->controller->isModal()) {
 580       $this->_formValues = $this->controller->exportValues($this->_name);
 581
 582       $this->normalizeFormValues();
 583       $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 584       $this->_returnProperties = &$this->returnProperties();
 585
 586       // also get the uf group id directly from the post value
 587       $this->_ufGroupID = CRM_Utils_Array::value('uf_group_id', $_POST, $this->_ufGroupID);
 588       $this->_formValues['uf_group_id'] = $this->_ufGroupID;
 589       $this->set('id', $this->_ufGroupID);
 590
 591       // also get the object mode directly from the post value
 592       $this->_componentMode = CRM_Utils_Array::value('component_mode', $_POST, $this->_componentMode);
 593
 594       // also get the operator from the post value if set
 595       $this->_operator = CRM_Utils_Array::value('operator', $_POST, $this->_operator);
 596       $this->_formValues['operator'] = $this->_operator;
 597       $this->set('operator', $this->_operator);
 598     }
 599     else {
 600       $this->_formValues = $this->get('formValues');
 601       $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 602       $this->_returnProperties = &$this->returnProperties();
 603       if (!empty($this->_ufGroupID)) {
 604         $this->set('id', $this->_ufGroupID);
 605       }
 606     }
 607
 608     if (empty($this->_formValues)) {
 609       //check if group is a smart group (fix for CRM-1255)
 610       if ($this->_groupID) {
 611         if ($ssId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID, 'saved_search_id')) {
 612           $this->_ssID = $ssId;
 613         }
 614       }
 615
 616       // fix for CRM-1907
 617       if (isset($this->_ssID) && $this->_context != 'smog') {
 618         // we only retrieve the saved search values if out current values are null
 619         $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 620
 621         //fix for CRM-1505
 622         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID, 'mapping_id')) {
 623           $this->_params = CRM_Contact_BAO_SavedSearch::getSearchParams($this->_ssID);
 624         }
 625         else {
 626           $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 627         }
 628         $this->_returnProperties = &$this->returnProperties();
 629       }
 630       else {
 631         if (isset($this->_ufGroupID)) {
 632           // also set the uf group id if not already present
 633           $this->_formValues['uf_group_id'] = $this->_ufGroupID;
 634         }
 635         if (isset($this->_componentMode)) {
 636           $this->_formValues['component_mode'] = $this->_componentMode;
 637         }
 638         if (isset($this->_operator)) {
 639           $this->_formValues['operator'] = $this->_operator;
 640         }
 641
 642         // FIXME: we should generalise in a way that components could inject url-filters
 643         // just like they build their own form elements
 644         foreach ([
 645           'mailing_id',
 646           'mailing_delivery_status',
 647           'mailing_open_status',
 648           'mailing_click_status',
 649           'mailing_reply_status',
 650           'mailing_optout',
 651           'mailing_forward',
 652           'mailing_unsubscribe',
 653           'mailing_date_low',
 654           'mailing_date_high',
 655           'mailing_job_start_date_low',
 656           'mailing_job_start_date_high',
 657           'mailing_job_start_date_relative',
 658         ] as $mailingFilter) {
 659           $type = 'String';
 660           if ($mailingFilter == 'mailing_id' &&
 661             $filterVal = CRM_Utils_Request::retrieve('mailing_id', 'Positive', $this)
 662           ) {
 663             $this->_formValues[$mailingFilter] = [$filterVal];
 664           }
 665           elseif ($filterVal = CRM_Utils_Request::retrieve($mailingFilter, $type, $this)) {
 666             $this->_formValues[$mailingFilter] = $filterVal;
 667           }
 668           if ($filterVal) {
 669             $this->_openedPanes['Mailings'] = 1;
 670             $this->_formValues['hidden_CiviMail'] = 1;
 671           }
 672         }
 673       }
 674     }
 675     $this->assign('id',
 676       CRM_Utils_Array::value('uf_group_id', $this->_formValues)
 677     );
 678     $operator = CRM_Utils_Array::value('operator', $this->_formValues, CRM_Contact_BAO_Query::SEARCH_OPERATOR_AND);
 679     $this->set('queryOperator', $operator);
 680     if ($operator == CRM_Contact_BAO_Query::SEARCH_OPERATOR_OR) {
 681       $this->assign('operator', ts('OR'));
 682     }
 683     else {
 684       $this->assign('operator', ts('AND'));
 685     }
 686
 687     // show the context menu only when we’re not searching for deleted contacts; CRM-5673
 688     if (empty($this->_formValues['deleted_contacts'])) {
 689       $menuItems = CRM_Contact_BAO_Contact::contextMenu();
 690       $primaryActions = CRM_Utils_Array::value('primaryActions', $menuItems, []);
 691       $this->_contextMenu = CRM_Utils_Array::value('moreActions', $menuItems, []);
 692       $this->assign('contextMenu', $primaryActions + $this->_contextMenu);
 693     }
 694
 695     if (!isset($this->_componentMode)) {
 696       $this->_componentMode = CRM_Contact_BAO_Query::MODE_CONTACTS;
 697     }
 698     self::$_selectorName = $this->_modeValue['selectorName'];
 699     self::setModeValues();
 700
 701     $setDynamic = FALSE;
 702     if (strpos(self::$_selectorName, 'CRM_Contact_Selector') !== FALSE) {
 703       $selector = new self::$_selectorName(
 704         $this->_customSearchClass,
 705         $this->_formValues,
 706         $this->_params,
 707         $this->_returnProperties,
 708         $this->_action,
 709         FALSE, TRUE,
 710         $this->_context,
 711         $this->_contextMenu
 712       );
 713       $setDynamic = TRUE;
 714     }
 715     else {
 716       $selector = new self::$_selectorName(
 717         $this->_params,
 718         $this->_action,
 719         NULL, FALSE, NULL,
 720         "search", "advanced"
 721       );
 722     }
 723
 724     $selector->setKey($this->controller->_key);
 725
 726     $controller = new CRM_Contact_Selector_Controller($selector,
 727       $this->get(CRM_Utils_Pager::PAGE_ID),
 728       $this->get(CRM_Utils_Sort::SORT_ID),
 729       CRM_Core_Action::VIEW,
 730       $this,
 731       CRM_Core_Selector_Controller::TRANSFER
 732     );
 733     $controller->setEmbedded(TRUE);
 734     $controller->setDynamicAction($setDynamic);
 735
 736     if ($this->_force) {
 737       $this->loadMetadata();
 738       $this->postProcess();
 739
 740       /*
 741        * Note that we repeat this, since the search creates and stores
 742        * values that potentially change the controller behavior. i.e. things
 743        * like totalCount etc
 744        */
 745       $sortID = NULL;
 746       if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 747         $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 748           $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 749         );
 750       }
 751       $controller = new CRM_Contact_Selector_Controller($selector,
 752         $this->get(CRM_Utils_Pager::PAGE_ID),
 753         $sortID,
 754         CRM_Core_Action::VIEW, $this, CRM_Core_Selector_Controller::TRANSFER
 755       );
 756       $controller->setEmbedded(TRUE);
 757       $controller->setDynamicAction($setDynamic);
 758     }
 759
 760     $controller->moveFromSessionToTemplate();
 761   }
 762
 763   /**
 764    * Common post processing.
 765    */
 766   public function postProcess() {
 767     /*
 768      * sometime we do a postProcess early on, so we dont need to repeat it
 769      * this will most likely introduce some more bugs :(
 770      */
 771
 772     if ($this->_done) {
 773       return;
 774     }
 775     $this->_done = TRUE;
 776
 777     //for prev/next pagination
 778     $crmPID = CRM_Utils_Request::retrieve('crmPID', 'Integer');
 779
 780     //get the button name
 781     $buttonName = $this->controller->getButtonName();
 782
 783     if (isset($this->_ufGroupID) && empty($this->_formValues['uf_group_id'])) {
 784       $this->_formValues['uf_group_id'] = $this->_ufGroupID;
 785     }
 786
 787     if (isset($this->_componentMode) && empty($this->_formValues['component_mode'])) {
 788       $this->_formValues['component_mode'] = $this->_componentMode;
 789     }
 790
 791     if (isset($this->_operator) && empty($this->_formValues['operator'])) {
 792       $this->_formValues['operator'] = $this->_operator;
 793     }
 794
 795     if (empty($this->_formValues['qfKey'])) {
 796       $this->_formValues['qfKey'] = $this->controller->_key;
 797     }
 798
 799     if (!CRM_Core_Permission::check('access deleted contacts')) {
 800       unset($this->_formValues['deleted_contacts']);
 801     }
 802
 803     $this->set('type', $this->_action);
 804     $this->set('formValues', $this->_formValues);
 805     $this->set('queryParams', $this->_params);
 806     $this->set('returnProperties', $this->_returnProperties);
 807
 808     if ($buttonName == $this->_actionButtonName) {
 809       // check actionName and if next, then do not repeat a search, since we are going to the next page
 810       // hack, make sure we reset the task values
 811       $stateMachine = $this->controller->getStateMachine();
 812       $formName = $stateMachine->getTaskFormName();
 813       $this->controller->resetPage($formName);
 814       return;
 815     }
 816     else {
 817       if (array_key_exists($this->_searchButtonName, $_POST) ||
 818         ($this->_force && !$crmPID)
 819       ) {
 820         //reset the cache table for new search
 821         $cacheKey = "civicrm search {$this->controller->_key}";
 822         Civi::service('prevnext')->deleteItem(NULL, $cacheKey);
 823       }
 824       $output = CRM_Core_Selector_Controller::SESSION;
 825
 826       // create the selector, controller and run - store results in session
 827       $searchChildGroups = TRUE;
 828       if ($this->get('isAdvanced')) {
 829         $searchChildGroups = FALSE;
 830       }
 831
 832       $setDynamic = FALSE;
 833
 834       if (strpos(self::$_selectorName, 'CRM_Contact_Selector') !== FALSE) {
 835         $selector = new self::$_selectorName(
 836           $this->_customSearchClass,
 837           $this->_formValues,
 838           $this->_params,
 839           $this->_returnProperties,
 840           $this->_action,
 841           FALSE,
 842           $searchChildGroups,
 843           $this->_context,
 844           $this->_contextMenu
 845         );
 846         $setDynamic = TRUE;
 847       }
 848       else {
 849         $selector = new self::$_selectorName(
 850           $this->_params,
 851           $this->_action,
 852           NULL,
 853           FALSE,
 854           NULL,
 855           "search",
 856           "advanced"
 857         );
 858       }
 859
 860       $selector->setKey($this->controller->_key);
 861
 862       // added the sorting  character to the form array
 863       $config = CRM_Core_Config::singleton();
 864       // do this only for contact search
 865       if ($setDynamic && $config->includeAlphabeticalPager) {
 866         // Don't recompute if we are just paging/sorting
 867         if ($this->_reset || (empty($_GET['crmPID']) && empty($_GET['crmSID']) && !$this->_sortByCharacter)) {
 868           $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($selector, $this->_sortByCharacter);
 869           $this->set('AToZBar', $aToZBar);
 870         }
 871       }
 872
 873       $sortID = NULL;
 874       if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 875         $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 876           $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 877         );
 878       }
 879       $controller = new CRM_Contact_Selector_Controller($selector,
 880         $this->get(CRM_Utils_Pager::PAGE_ID),
 881         $sortID,
 882         CRM_Core_Action::VIEW,
 883         $this,
 884         $output
 885       );
 886       $controller->setEmbedded(TRUE);
 887       $controller->setDynamicAction($setDynamic);
 888       $controller->run();
 889     }
 890   }
 891
 892   /**
 893    * @return NULL
 894    */
 895   public function &returnProperties() {
 896     return CRM_Core_DAO::$_nullObject;
 897   }
 898
 899   /**
 900    * Return a descriptive name for the page, used in wizard header
 901    *
 902    * @return string
 903    */
 904   public function getTitle() {
 905     return ts('Search');
 906   }
 907
 908   /**
 909    * Load metadata for fields on the form.
 910    *
 911    * @throws \CiviCRM_API3_Exception
 912    */
 913   protected function loadMetadata() {
 914     // @todo - check what happens if the person does not have 'access civicontribute' - make sure they
 915     // can't by pass acls by passing search criteria in the url.
 916     $this->addSearchFieldMetadata(['Contribution' => CRM_Contribute_BAO_Query::getSearchFieldMetadata()]);
 917     $this->addSearchFieldMetadata(['ContributionRecur' => CRM_Contribute_BAO_ContributionRecur::getContributionRecurSearchFieldMetadata()]);
 918   }
 919
 920 }