CRM/Contact/Form/Search/Advanced.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33
  34 /**
  35  * Advanced search, extends basic search.
  36  */
  37 class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search {
  38
  39   /**
  40    * Processing needed for buildForm and later.
  41    */
  42   public function preProcess() {
  43     $this->set('searchFormName', 'Advanced');
  44
  45     parent::preProcess();
  46     $openedPanes = CRM_Contact_BAO_Query::$_openedPanes;
  47     $openedPanes = array_merge($openedPanes, $this->_openedPanes);
  48     $this->assign('openedPanes', $openedPanes);
  49   }
  50
  51   /**
  52    * Build the form object.
  53    */
  54   public function buildQuickForm() {
  55     $this->set('context', 'advanced');
  56
  57     $this->_searchPane = CRM_Utils_Array::value('searchPane', $_GET);
  58
  59     $this->_searchOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  60       'advanced_search_options'
  61     );
  62
  63     if (!$this->_searchPane || $this->_searchPane == 'basic') {
  64       CRM_Contact_Form_Search_Criteria::basic($this);
  65     }
  66
  67     $allPanes = array();
  68     $paneNames = array(
  69       ts('Address Fields') => 'location',
  70       ts('Custom Fields') => 'custom',
  71       ts('Activities') => 'activity',
  72       ts('Relationships') => 'relationship',
  73       ts('Demographics') => 'demographics',
  74       ts('Notes') => 'notes',
  75       ts('Change Log') => 'changeLog',
  76     );
  77
  78     //check if there are any custom data searchable fields
  79     $extends = array_merge(array('Contact', 'Individual', 'Household', 'Organization'),
  80       CRM_Contact_BAO_ContactType::subTypes()
  81     );
  82     $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE,
  83       $extends
  84     );
  85     // if no searchable fields unset panel
  86     if (empty($groupDetails)) {
  87       unset($paneNames[ts('Custom Fields')]);
  88     }
  89
  90     foreach ($paneNames as $name => $type) {
  91       if (!$this->_searchOptions[$type]) {
  92         unset($paneNames[$name]);
  93       }
  94     }
  95
  96     $components = CRM_Core_Component::getEnabledComponents();
  97
  98     $componentPanes = array();
  99     foreach ($components as $name => $component) {
 100       if (in_array($name, array_keys($this->_searchOptions)) &&
 101         $this->_searchOptions[$name] &&
 102         CRM_Core_Permission::access($component->name)
 103       ) {
 104         $componentPanes[$name] = $component->registerAdvancedSearchPane();
 105         $componentPanes[$name]['name'] = $name;
 106       }
 107     }
 108
 109     usort($componentPanes, array('CRM_Utils_Sort', 'cmpFunc'));
 110     foreach ($componentPanes as $name => $pane) {
 111       // FIXME: we should change the use of $name here to keyword
 112       $paneNames[$pane['title']] = $pane['name'];
 113     }
 114
 115     $hookPanes = array();
 116     CRM_Contact_BAO_Query_Hook::singleton()->registerAdvancedSearchPane($hookPanes);
 117     $paneNames = array_merge($paneNames, $hookPanes);
 118
 119     $this->_paneTemplatePath = array();
 120     foreach ($paneNames as $name => $type) {
 121       if (!array_key_exists($type, $this->_searchOptions) && !in_array($type, $hookPanes)) {
 122         continue;
 123       }
 124
 125       $allPanes[$name] = array(
 126         'url' => CRM_Utils_System::url('civicrm/contact/search/advanced',
 127           "snippet=1&searchPane=$type&qfKey={$this->controller->_key}"
 128         ),
 129         'open' => 'false',
 130         'id' => $type,
 131       );
 132
 133       // see if we need to include this paneName in the current form
 134       if ($this->_searchPane == $type || !empty($_POST["hidden_{$type}"]) ||
 135         CRM_Utils_Array::value("hidden_{$type}", $this->_formValues)
 136       ) {
 137         $allPanes[$name]['open'] = 'true';
 138
 139         if (!empty($components[$type])) {
 140           $c = $components[$type];
 141           $this->add('hidden', "hidden_$type", 1);
 142           $c->buildAdvancedSearchPaneForm($this);
 143           $this->_paneTemplatePath[$type] = $c->getAdvancedSearchPaneTemplatePath();
 144         }
 145         elseif (in_array($type, $hookPanes)) {
 146           CRM_Contact_BAO_Query_Hook::singleton()->buildAdvancedSearchPaneForm($this, $type);
 147           CRM_Contact_BAO_Query_Hook::singleton()->setAdvancedSearchPaneTemplatePath($this->_paneTemplatePath, $type);
 148         }
 149         else {
 150           CRM_Contact_Form_Search_Criteria::$type($this);
 151           $template = ucfirst($type);
 152           $this->_paneTemplatePath[$type] = "CRM/Contact/Form/Search/Criteria/{$template}.tpl";
 153         }
 154       }
 155     }
 156
 157     $this->assign('allPanes', $allPanes);
 158     if (!$this->_searchPane) {
 159       parent::buildQuickForm();
 160     }
 161     else {
 162       $this->assign('suppressForm', TRUE);
 163     }
 164   }
 165
 166   /**
 167    * Use the form name to create the tpl file name.
 168    *
 169    * @return string
 170    */
 171   /**
 172    * @return string
 173    */
 174   public function getTemplateFileName() {
 175     if (!$this->_searchPane) {
 176       return parent::getTemplateFileName();
 177     }
 178     else {
 179       if (isset($this->_paneTemplatePath[$this->_searchPane])) {
 180         return $this->_paneTemplatePath[$this->_searchPane];
 181       }
 182       else {
 183         $name = ucfirst($this->_searchPane);
 184         return "CRM/Contact/Form/Search/Criteria/{$name}.tpl";
 185       }
 186     }
 187   }
 188
 189   /**
 190    * Set the default form values.
 191    *
 192    *
 193    * @return array
 194    *   the default array reference
 195    */
 196   public function setDefaultValues() {
 197     $defaults = $this->_formValues;
 198     $this->normalizeDefaultValues($defaults);
 199
 200     if ($this->_context === 'amtg') {
 201       $defaults['task'] = CRM_Contact_Task::GROUP_CONTACTS;
 202     }
 203
 204     $defaults['privacy_toggle'] = 1;
 205     $defaults['operator'] = 'AND';
 206
 207     return $defaults;
 208   }
 209
 210   /**
 211    * The post processing of the form gets done here.
 212    *
 213    * Key things done during post processing are
 214    *      - check for reset or next request. if present, skip post processing.
 215    *      - now check if user requested running a saved search, if so, then
 216    *        the form values associated with the saved search are used for searching.
 217    *      - if user has done a submit with new values the regular post submitting is
 218    *        done.
 219    * The processing consists of using a Selector / Controller framework for getting the
 220    * search results.
 221    */
 222   public function postProcess() {
 223     $this->set('isAdvanced', '1');
 224
 225     // get user submitted values
 226     // get it from controller only if form has been submitted, else preProcess has set this
 227     if (!empty($_POST)) {
 228       $this->_formValues = $this->controller->exportValues($this->_name);
 229       $this->normalizeFormValues();
 230       // FIXME: couldn't figure out a good place to do this,
 231       // FIXME: so leaving this as a dependency for now
 232       if (array_key_exists('contribution_amount_low', $this->_formValues)) {
 233         foreach (array(
 234                    'contribution_amount_low',
 235                    'contribution_amount_high',
 236                  ) as $f) {
 237           $this->_formValues[$f] = CRM_Utils_Rule::cleanMoney($this->_formValues[$f]);
 238         }
 239       }
 240
 241       // set the group if group is submitted
 242       if (!empty($this->_formValues['uf_group_id'])) {
 243         $this->set('id', $this->_formValues['uf_group_id']);
 244       }
 245       else {
 246         $this->set('id', '');
 247       }
 248     }
 249
 250     // retrieve ssID values only if formValues is null, i.e. form has never been posted
 251     if (empty($this->_formValues) && isset($this->_ssID)) {
 252       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 253     }
 254
 255     if (isset($this->_groupID) && empty($this->_formValues['group'])) {
 256       $this->_formValues['group'] = array($this->_groupID => 1);
 257     }
 258
 259     //search for civicase
 260     if (is_array($this->_formValues)) {
 261       $allCases = FALSE;
 262       if (array_key_exists('case_owner', $this->_formValues) &&
 263         !$this->_formValues['case_owner'] &&
 264         !$this->_force
 265       ) {
 266         foreach (array(
 267                    'case_type_id',
 268                    'case_status_id',
 269                    'case_deleted',
 270                    'case_tags',
 271                  ) as $caseCriteria) {
 272           if (!empty($this->_formValues[$caseCriteria])) {
 273             $allCases = TRUE;
 274             $this->_formValues['case_owner'] = 1;
 275             continue;
 276           }
 277         }
 278         if ($allCases) {
 279           if (CRM_Core_Permission::check('access all cases and activities')) {
 280             $this->_formValues['case_owner'] = 1;
 281           }
 282           else {
 283             $this->_formValues['case_owner'] = 2;
 284           }
 285         }
 286         else {
 287           $this->_formValues['case_owner'] = 0;
 288         }
 289       }
 290       if (array_key_exists('case_owner', $this->_formValues) && empty($this->_formValues['case_deleted'])) {
 291         $this->_formValues['case_deleted'] = 0;
 292       }
 293     }
 294
 295     // we dont want to store the sortByCharacter in the formValue, it is more like
 296     // a filter on the result set
 297     // this filter is reset if we click on the search button
 298     if ($this->_sortByCharacter !== NULL && empty($_POST)) {
 299       if (strtolower($this->_sortByCharacter) == 'all') {
 300         $this->_formValues['sortByCharacter'] = NULL;
 301       }
 302       else {
 303         $this->_formValues['sortByCharacter'] = $this->_sortByCharacter;
 304       }
 305     }
 306     else {
 307       $this->_sortByCharacter = NULL;
 308     }
 309
 310     CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);
 311
 312     $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields);
 313     $this->_returnProperties = &$this->returnProperties();
 314     parent::postProcess();
 315   }
 316
 317   /**
 318    * Normalize the form values to make it look similar to the advanced form values.
 319    *
 320    * This prevents a ton of work downstream and allows us to use the same code for
 321    * multiple purposes (queries, save/edit etc)
 322    */
 323   public function normalizeFormValues() {
 324     $contactType = CRM_Utils_Array::value('contact_type', $this->_formValues);
 325
 326     if ($contactType && is_array($contactType)) {
 327       unset($this->_formValues['contact_type']);
 328       foreach ($contactType as $key => $value) {
 329         $this->_formValues['contact_type'][$value] = 1;
 330       }
 331     }
 332
 333     $config = CRM_Core_Config::singleton();
 334     $specialParams = array(
 335       'financial_type_id',
 336       'contribution_soft_credit_type_id',
 337       'contribution_status',
 338       'contribution_status_id',
 339       'contribution_source',
 340       'membership_status_id',
 341       'participant_status_id',
 342       'contribution_trxn_id',
 343       'activity_type_id',
 344       'status_id',
 345       'activity_subject',
 346       'contribution_page_id',
 347       'contribution_product_id',
 348       'payment_instrument_id',
 349       'group',
 350       'contact_tags',
 351       'preferred_communication_method',
 352     );
 353     foreach ($specialParams as $element) {
 354       $value = CRM_Utils_Array::value($element, $this->_formValues);
 355       if ($value) {
 356         if (is_array($value)) {
 357           if ($element == 'status_id') {
 358             unset($this->_formValues[$element]);
 359             $element = 'activity_' . $element;
 360           }
 361           $this->_formValues[$element] = array('IN' => $value);
 362         }
 363         else {
 364           $this->_formValues[$element] = array('LIKE' => "%$value%");
 365         }
 366       }
 367     }
 368
 369     $taglist = CRM_Utils_Array::value('contact_taglist', $this->_formValues);
 370
 371     if ($taglist && is_array($taglist)) {
 372       unset($this->_formValues['contact_taglist']);
 373       foreach ($taglist as $value) {
 374         if ($value) {
 375           $value = explode(',', $value);
 376           $this->_formValues['contact_tags'] = (array) $value;
 377         }
 378       }
 379     }
 380   }
 381
 382   /**
 383    * Normalize default values for multiselect plugins.
 384    *
 385    * @param array $defaults
 386    *
 387    * @return array
 388    */
 389   public function normalizeDefaultValues(&$defaults) {
 390     if (!is_array($defaults)) {
 391       $defaults = array();
 392     }
 393
 394     if ($this->_ssID && empty($_POST)) {
 395       $specialFields = array('contact_type', 'group', 'contact_tags', 'member_membership_type_id', 'member_status_id');
 396
 397       foreach ($defaults as $element => $value) {
 398         if (!empty($value) && is_array($value)) {
 399           if (in_array($element, $specialFields)) {
 400             $element = str_replace('member_membership_type_id', 'membership_type_id', $element);
 401             $element = str_replace('member_status_id', 'membership_status_id', $element);
 402             $defaults[$element] = array_keys($value);
 403           }
 404           // As per the OK (Operator as Key) value format, value array may contain key
 405           // as an operator so to ensure the default is always set actual value
 406           elseif (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 407             $defaults[$element] = CRM_Utils_Array::value(key($value), $value);
 408             if (is_string($defaults[$element])) {
 409               $defaults[$element] = str_replace("%", '', $defaults[$element]);
 410             }
 411           }
 412         }
 413         if (substr($element, 0, 7) == 'custom_' &&
 414           (substr($element, -5, 5) == '_from' || substr($element, -3, 3) == '_to')
 415           ) {
 416           // Ensure the _relative field is set if from or to are set to ensure custom date
 417           // fields with 'from' or 'to' values are displayed when the are set in the smart group
 418           // being loaded. (CRM-17116)
 419           if (!isset($defaults[CRM_Contact_BAO_Query::getCustomFieldName($element) . '_relative'])) {
 420             $defaults[CRM_Contact_BAO_Query::getCustomFieldName($element) . '_relative'] = 0;
 421           }
 422         }
 423       }
 424     }
 425     return $defaults;
 426   }
 427
 428 }