CRM/Contact/Form/Search.php

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