CRM/Contact/BAO/SavedSearch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33
  34 /**
  35  * Business object for Saved searches.
  36  */
  37 class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch {
  38
  39   /**
  40    * Class constructor.
  41    */
  42   public function __construct() {
  43     parent::__construct();
  44   }
  45
  46   /**
  47    * Query the db for all saved searches.
  48    *
  49    * @return array
  50    *   contains the search name as value and and id as key
  51    */
  52   public function getAll() {
  53     $savedSearch = new CRM_Contact_DAO_SavedSearch();
  54     $savedSearch->selectAdd();
  55     $savedSearch->selectAdd('id, name');
  56     $savedSearch->find();
  57     while ($savedSearch->fetch()) {
  58       $aSavedSearch[$savedSearch->id] = $savedSearch->name;
  59     }
  60     return $aSavedSearch;
  61   }
  62
  63   /**
  64    * Retrieve DB object based on input parameters.
  65    *
  66    * It also stores all the retrieved values in the default array.
  67    *
  68    * @param array $params
  69    *   (reference ) an assoc array of name/value pairs.
  70    * @param array $defaults
  71    *   (reference ) an assoc array to hold the flattened values.
  72    *
  73    * @return CRM_Contact_BAO_SavedSearch
  74    */
  75   public static function retrieve(&$params, &$defaults) {
  76     $savedSearch = new CRM_Contact_DAO_SavedSearch();
  77     $savedSearch->copyValues($params);
  78     if ($savedSearch->find(TRUE)) {
  79       CRM_Core_DAO::storeValues($savedSearch, $defaults);
  80       return $savedSearch;
  81     }
  82     return NULL;
  83   }
  84
  85   /**
  86    * Given an id, extract the formValues of the saved search.
  87    *
  88    * @param int $id
  89    *   The id of the saved search.
  90    *
  91    * @return array
  92    *   the values of the posted saved search used as default values in various Search Form
  93    */
  94   public static function getFormValues($id) {
  95     $fv = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'form_values');
  96     $result = NULL;
  97     if ($fv) {
  98       // make sure u unserialize - since it's stored in serialized form
  99       $result = unserialize($fv);
 100     }
 101
 102     $specialFields = array('contact_type', 'group', 'contact_tags', 'member_membership_type_id', 'member_status_id');
 103     foreach ($result as $element => $value) {
 104       if (CRM_Contact_BAO_Query::isAlreadyProcessedForQueryFormat($value)) {
 105         $id = CRM_Utils_Array::value(0, $value);
 106         $value = CRM_Utils_Array::value(2, $value);
 107         if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 108           $value = CRM_Utils_Array::value(key($value), $value);
 109         }
 110         if (strpos($id, '_date_low') !== FALSE || strpos($id, '_date_high') !== FALSE) {
 111           $entityName = strstr($id, '_date', TRUE);
 112           if (!empty($result['relative_dates']) && array_key_exists($entityName, $result['relative_dates'])) {
 113             $result["{$entityName}_date_relative"] = $result['relative_dates'][$entityName];
 114           }
 115           else {
 116             $result[$id] = $value;
 117             $result["{$entityName}_date_relative"] = 0;
 118           }
 119         }
 120         else {
 121           $result[$id] = $value;
 122         }
 123         unset($result[$element]);
 124         continue;
 125       }
 126       if (!empty($value) && is_array($value)) {
 127         if (in_array($element, $specialFields)) {
 128           // Remove the element to minimise support for legacy formats. It is stored in $value
 129           // so will be re-set with the right name.
 130           unset($result[$element]);
 131           $element = str_replace('member_membership_type_id', 'membership_type_id', $element);
 132           $element = str_replace('member_status_id', 'membership_status_id', $element);
 133           CRM_Contact_BAO_Query::legacyConvertFormValues($element, $value);
 134           $result[$element] = $value;
 135         }
 136         // As per the OK (Operator as Key) value format, value array may contain key
 137         // as an operator so to ensure the default is always set actual value
 138         elseif (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 139           $result[$element] = CRM_Utils_Array::value(key($value), $value);
 140           if (is_string($result[$element])) {
 141             $result[$element] = str_replace("%", '', $result[$element]);
 142           }
 143         }
 144       }
 145       if (substr($element, 0, 7) == 'custom_' &&
 146         (substr($element, -5, 5) == '_from' || substr($element, -3, 3) == '_to')
 147       ) {
 148         // Ensure the _relative field is set if from or to are set to ensure custom date
 149         // fields with 'from' or 'to' values are displayed when the are set in the smart group
 150         // being loaded. (CRM-17116)
 151         if (!isset($result[CRM_Contact_BAO_Query::getCustomFieldName($element) . '_relative'])) {
 152           $result[CRM_Contact_BAO_Query::getCustomFieldName($element) . '_relative'] = 0;
 153         }
 154       }
 155       // check to see if we need to convert the old privacy array
 156       // CRM-9180
 157       if (!empty($result['privacy'])) {
 158         if (is_array($result['privacy'])) {
 159           $result['privacy_operator'] = 'AND';
 160           $result['privacy_toggle'] = 1;
 161           if (isset($result['privacy']['do_not_toggle'])) {
 162             if ($result['privacy']['do_not_toggle']) {
 163               $result['privacy_toggle'] = 2;
 164             }
 165             unset($result['privacy']['do_not_toggle']);
 166           }
 167
 168           $result['privacy_options'] = array();
 169           foreach ($result['privacy'] as $name => $val) {
 170             if ($val) {
 171               $result['privacy_options'][] = $name;
 172             }
 173           }
 174         }
 175         unset($result['privacy']);
 176       }
 177     }
 178
 179     return $result;
 180   }
 181
 182   /**
 183    * Get search parameters.
 184    *
 185    * @param int $id
 186    *
 187    * @return array
 188    */
 189   public static function getSearchParams($id) {
 190     $fv = self::getFormValues($id);
 191     //check if the saved search has mapping id
 192     if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'mapping_id')) {
 193       return CRM_Core_BAO_Mapping::formattedFields($fv);
 194     }
 195     elseif (!empty($fv['customSearchID'])) {
 196       return $fv;
 197     }
 198     else {
 199       return CRM_Contact_BAO_Query::convertFormValues($fv);
 200     }
 201   }
 202
 203   /**
 204    * Get the where clause for a saved search.
 205    *
 206    * @param int $id
 207    *   Saved search id.
 208    * @param array $tables
 209    *   (reference ) add the tables that are needed for the select clause.
 210    * @param array $whereTables
 211    *   (reference ) add the tables that are needed for the where clause.
 212    *
 213    * @return string
 214    *   the where clause for this saved search
 215    */
 216   public static function whereClause($id, &$tables, &$whereTables) {
 217     $params = self::getSearchParams($id);
 218     if ($params) {
 219       if (!empty($params['customSearchID'])) {
 220         // this has not yet been implemented
 221       }
 222       else {
 223         return CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
 224       }
 225     }
 226     return NULL;
 227   }
 228
 229   /**
 230    * Contact IDS Sql (whatever that means!).
 231    *
 232    * @param int $id
 233    *
 234    * @return string
 235    */
 236   public static function contactIDsSQL($id) {
 237     $params = self::getSearchParams($id);
 238     if ($params && !empty($params['customSearchID'])) {
 239       return CRM_Contact_BAO_SearchCustom::contactIDSQL(NULL, $id);
 240     }
 241     else {
 242       $tables = $whereTables = array('civicrm_contact' => 1);
 243       $where = CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables);
 244       if (!$where) {
 245         $where = '( 1 )';
 246       }
 247       $from = CRM_Contact_BAO_Query::fromClause($whereTables);
 248       return "
 249 SELECT contact_a.id
 250 $from
 251 WHERE  $where";
 252     }
 253   }
 254
 255   /**
 256    * Get from where email (whatever that means!).
 257    *
 258    * @param int $id
 259    *
 260    * @return array
 261    */
 262   public static function fromWhereEmail($id) {
 263     $params = self::getSearchParams($id);
 264
 265     if ($params) {
 266       if (!empty($params['customSearchID'])) {
 267         return CRM_Contact_BAO_SearchCustom::fromWhereEmail(NULL, $id);
 268       }
 269       else {
 270         $tables = $whereTables = array('civicrm_contact' => 1, 'civicrm_email' => 1);
 271         $where = CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables);
 272         $from = CRM_Contact_BAO_Query::fromClause($whereTables);
 273         return array($from, $where);
 274       }
 275     }
 276     else {
 277       // fix for CRM-7240
 278       $from = "
 279 FROM      civicrm_contact contact_a
 280 LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1)
 281 ";
 282       $where = " ( 1 ) ";
 283       $tables['civicrm_contact'] = $whereTables['civicrm_contact'] = 1;
 284       $tables['civicrm_email'] = $whereTables['civicrm_email'] = 1;
 285       return array($from, $where);
 286     }
 287   }
 288
 289   /**
 290    * Given a saved search compute the clause and the tables and store it for future use.
 291    */
 292   public function buildClause() {
 293     $fv = unserialize($this->form_values);
 294
 295     if ($this->mapping_id) {
 296       $params = CRM_Core_BAO_Mapping::formattedFields($fv);
 297     }
 298     else {
 299       $params = CRM_Contact_BAO_Query::convertFormValues($fv);
 300     }
 301
 302     if (!empty($params)) {
 303       $tables = $whereTables = array();
 304       $this->where_clause = CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
 305       if (!empty($tables)) {
 306         $this->select_tables = serialize($tables);
 307       }
 308       if (!empty($whereTables)) {
 309         $this->where_tables = serialize($whereTables);
 310       }
 311     }
 312   }
 313
 314   /**
 315    * Save the search.
 316    *
 317    * @param bool $hook
 318    */
 319   public function save($hook = TRUE) {
 320     // first build the computed fields
 321     $this->buildClause();
 322
 323     parent::save($hook);
 324   }
 325
 326   /**
 327    * Given an id, get the name of the saved search.
 328    *
 329    * @param int $id
 330    *   The id of the saved search.
 331    *
 332    * @param string $value
 333    *
 334    * @return string
 335    *   the name of the saved search
 336    */
 337   public static function getName($id, $value = 'name') {
 338     $group = new CRM_Contact_DAO_Group();
 339     $group->saved_search_id = $id;
 340     if ($group->find(TRUE)) {
 341       return $group->$value;
 342     }
 343     return NULL;
 344   }
 345
 346   /**
 347    * Create a smart group from normalised values.
 348    *
 349    * @param array $params
 350    *
 351    * @return \CRM_Contact_DAO_SavedSearch
 352    */
 353   public static function create(&$params) {
 354     $savedSearch = new CRM_Contact_DAO_SavedSearch();
 355     if (isset($params['formValues']) &&
 356       !empty($params['formValues'])
 357     ) {
 358       $savedSearch->form_values = serialize($params['formValues']);
 359     }
 360     else {
 361       $savedSearch->form_values = NULL;
 362     }
 363
 364     $savedSearch->is_active = CRM_Utils_Array::value('is_active', $params, 1);
 365     $savedSearch->mapping_id = CRM_Utils_Array::value('mapping_id', $params, 'null');
 366     $savedSearch->custom_search_id = CRM_Utils_Array::value('custom_search_id', $params, 'null');
 367     $savedSearch->id = CRM_Utils_Array::value('id', $params, NULL);
 368
 369     $savedSearch->save();
 370
 371     return $savedSearch;
 372   }
 373
 374   /**
 375    * Assign test value.
 376    *
 377    * @param string $fieldName
 378    * @param array $fieldDef
 379    * @param int $counter
 380    */
 381   protected function assignTestValue($fieldName, &$fieldDef, $counter) {
 382     if ($fieldName == 'form_values') {
 383       // A dummy value for form_values.
 384       $this->{$fieldName} = serialize(
 385           array('sort_name' => "SortName{$counter}"));
 386     }
 387     else {
 388       parent::assignTestValues($fieldName, $fieldDef, $counter);
 389     }
 390   }
 391
 392   /**
 393    * Store relative dates in separate array format
 394    *
 395    * @param array $queryParams
 396    * @param array $formValues
 397    */
 398   public static function saveRelativeDates(&$queryParams, $formValues) {
 399     $relativeDates = array('relative_dates' => array());
 400     foreach ($formValues as $id => $value) {
 401       if (preg_match('/_date_relative$/', $id) && !empty($value)) {
 402         $entityName = strstr($id, '_date', TRUE);
 403         $relativeDates['relative_dates'][$entityName] = $value;
 404       }
 405     }
 406     // merge with original queryParams if relative date value(s) found
 407     if (count($relativeDates['relative_dates'])) {
 408       $queryParams = array_merge($queryParams, $relativeDates);
 409     }
 410   }
 411
 412 }