CRM/Core/BAO/CustomQuery.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2015
  33  * $Id$
  34  *
  35  */
  36 class CRM_Core_BAO_CustomQuery {
  37   const PREFIX = 'custom_value_';
  38
  39   /**
  40    * The set of custom field ids.
  41    *
  42    * @var array
  43    */
  44   protected $_ids;
  45
  46   /**
  47    * The select clause.
  48    *
  49    * @var array
  50    */
  51   public $_select;
  52
  53   /**
  54    * The name of the elements that are in the select clause.
  55    * used to extract the values
  56    *
  57    * @var array
  58    */
  59   public $_element;
  60
  61   /**
  62    * The tables involved in the query.
  63    *
  64    * @var array
  65    */
  66   public $_tables;
  67   public $_whereTables;
  68
  69   /**
  70    * The where clause.
  71    *
  72    * @var array
  73    */
  74   public $_where;
  75
  76   /**
  77    * The english language version of the query.
  78    *
  79    * @var array
  80    */
  81   public $_qill;
  82
  83   /**
  84    * The cache to translate the option values into labels.
  85    *
  86    * @var array
  87    */
  88   public $_options;
  89
  90   /**
  91    * The custom fields information.
  92    *
  93    * @var array
  94    */
  95   public $_fields;
  96
  97   /**
  98    * Searching for contacts?
  99    *
 100    * @var boolean
 101    */
 102   protected $_contactSearch;
 103
 104   protected $_locationSpecificCustomFields;
 105
 106   /**
 107    * This stores custom data group types and tables that it extends.
 108    *
 109    * @var array
 110    */
 111   static $extendsMap = array(
 112     'Contact' => 'civicrm_contact',
 113     'Individual' => 'civicrm_contact',
 114     'Household' => 'civicrm_contact',
 115     'Organization' => 'civicrm_contact',
 116     'Contribution' => 'civicrm_contribution',
 117     'Membership' => 'civicrm_membership',
 118     'Participant' => 'civicrm_participant',
 119     'Group' => 'civicrm_group',
 120     'Relationship' => 'civicrm_relationship',
 121     'Event' => 'civicrm_event',
 122     'Case' => 'civicrm_case',
 123     'Activity' => 'civicrm_activity',
 124     'Pledge' => 'civicrm_pledge',
 125     'Grant' => 'civicrm_grant',
 126     'Address' => 'civicrm_address',
 127     'Campaign' => 'civicrm_campaign',
 128     'Survey' => 'civicrm_survey',
 129   );
 130
 131   /**
 132    * Class constructor.
 133    *
 134    * Takes in a set of custom field ids andsets up the data structures to
 135    * generate a query
 136    *
 137    * @param array $ids
 138    *   The set of custom field ids.
 139    *
 140    * @param bool $contactSearch
 141    * @param array $locationSpecificFields
 142    */
 143   public function __construct($ids, $contactSearch = FALSE, $locationSpecificFields = array()) {
 144     $this->_ids = &$ids;
 145     $this->_locationSpecificCustomFields = $locationSpecificFields;
 146
 147     $this->_select = array();
 148     $this->_element = array();
 149     $this->_tables = array();
 150     $this->_whereTables = array();
 151     $this->_where = array();
 152     $this->_qill = array();
 153     $this->_options = array();
 154
 155     $this->_fields = array();
 156     $this->_contactSearch = $contactSearch;
 157
 158     if (empty($this->_ids)) {
 159       return;
 160     }
 161
 162     // initialize the field array
 163     $tmpArray = array_keys($this->_ids);
 164     $idString = implode(',', $tmpArray);
 165     $query = "
 166 SELECT f.id, f.label, f.data_type,
 167        f.html_type, f.is_search_range,
 168        f.option_group_id, f.custom_group_id,
 169        f.column_name, g.table_name,
 170        f.date_format,f.time_format
 171   FROM civicrm_custom_field f,
 172        civicrm_custom_group g
 173  WHERE f.custom_group_id = g.id
 174    AND g.is_active = 1
 175    AND f.is_active = 1
 176    AND f.id IN ( $idString )";
 177
 178     $dao = CRM_Core_DAO::executeQuery($query);
 179     while ($dao->fetch()) {
 180       // get the group dao to figure which class this custom field extends
 181       $extends = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $dao->custom_group_id, 'extends');
 182       if (array_key_exists($extends, self::$extendsMap)) {
 183         $extendsTable = self::$extendsMap[$extends];
 184       }
 185       elseif (in_array($extends, CRM_Contact_BAO_ContactType::subTypes())) {
 186         // if $extends is a subtype, refer contact table
 187         $extendsTable = self::$extendsMap['Contact'];
 188       }
 189       $this->_fields[$dao->id] = array(
 190         'id' => $dao->id,
 191         'label' => $dao->label,
 192         'extends' => $extendsTable,
 193         'data_type' => $dao->data_type,
 194         'html_type' => $dao->html_type,
 195         'is_search_range' => $dao->is_search_range,
 196         'column_name' => $dao->column_name,
 197         'table_name' => $dao->table_name,
 198         'option_group_id' => $dao->option_group_id,
 199       );
 200
 201       // store it in the options cache to make things easier
 202       // during option lookup
 203       $this->_options[$dao->id] = array();
 204       $this->_options[$dao->id]['attributes'] = array(
 205         'label' => $dao->label,
 206         'data_type' => $dao->data_type,
 207         'html_type' => $dao->html_type,
 208       );
 209
 210       $optionGroupID = NULL;
 211       $htmlTypes = array('CheckBox', 'Radio', 'Select', 'Multi-Select', 'AdvMulti-Select', 'Autocomplete-Select');
 212       if (in_array($dao->html_type, $htmlTypes) && $dao->data_type != 'ContactReference') {
 213         if ($dao->option_group_id) {
 214           $optionGroupID = $dao->option_group_id;
 215         }
 216         elseif ($dao->data_type != 'Boolean') {
 217           $errorMessage = ts("The custom field %1 is corrupt. Please delete and re-build the field",
 218             array(1 => $dao->label)
 219           );
 220           CRM_Core_Error::fatal($errorMessage);
 221         }
 222       }
 223       elseif ($dao->html_type == 'Select Date') {
 224         $this->_options[$dao->id]['attributes']['date_format'] = $dao->date_format;
 225         $this->_options[$dao->id]['attributes']['time_format'] = $dao->time_format;
 226       }
 227
 228       // build the cache for custom values with options (label => value)
 229       if ($optionGroupID != NULL) {
 230         $query = "
 231 SELECT label, value
 232   FROM civicrm_option_value
 233  WHERE option_group_id = $optionGroupID
 234 ";
 235
 236         $option = CRM_Core_DAO::executeQuery($query);
 237         while ($option->fetch()) {
 238           $dataType = $this->_fields[$dao->id]['data_type'];
 239           if ($dataType == 'Int' || $dataType == 'Float') {
 240             $num = round($option->value, 2);
 241             $this->_options[$dao->id]["$num"] = $option->label;
 242           }
 243           else {
 244             $this->_options[$dao->id][$option->value] = $option->label;
 245           }
 246         }
 247         $options = $this->_options[$dao->id];
 248         //unset attributes to avoid confussion
 249         unset($options['attributes']);
 250         CRM_Utils_Hook::customFieldOptions($dao->id, $options, FALSE);
 251       }
 252     }
 253   }
 254
 255   /**
 256    * Generate the select clause and the associated tables.
 257    * for the from clause
 258    *
 259    * @return void
 260    */
 261   public function select() {
 262     if (empty($this->_fields)) {
 263       return;
 264     }
 265
 266     foreach ($this->_fields as $id => $field) {
 267       $name = $field['table_name'];
 268       $fieldName = 'custom_' . $field['id'];
 269       $this->_select["{$name}_id"] = "{$name}.id as {$name}_id";
 270       $this->_element["{$name}_id"] = 1;
 271       $this->_select[$fieldName] = "{$field['table_name']}.{$field['column_name']} as $fieldName";
 272       $this->_element[$fieldName] = 1;
 273       $joinTable = NULL;
 274       // CRM-14265
 275       if ($field['extends'] == 'civicrm_group') {
 276         return;
 277       }
 278       elseif ($field['extends'] == 'civicrm_contact') {
 279         $joinTable = 'contact_a';
 280       }
 281       elseif ($field['extends'] == 'civicrm_contribution') {
 282         $joinTable = $field['extends'];
 283       }
 284       elseif (in_array($field['extends'], self::$extendsMap)) {
 285         $joinTable = $field['extends'];
 286       }
 287       else {
 288         return;
 289       }
 290
 291       $this->_tables[$name] = "\nLEFT JOIN $name ON $name.entity_id = $joinTable.id";
 292
 293       if ($this->_ids[$id]) {
 294         $this->_whereTables[$name] = $this->_tables[$name];
 295       }
 296
 297       if ($joinTable) {
 298         $joinClause = 1;
 299         $joinTableAlias = $joinTable;
 300         // Set location-specific query
 301         if (isset($this->_locationSpecificCustomFields[$id])) {
 302           list($locationType, $locationTypeId) = $this->_locationSpecificCustomFields[$id];
 303           $joinTableAlias = "$locationType-address";
 304           $joinClause = "\nLEFT JOIN $joinTable `$locationType-address` ON (`$locationType-address`.contact_id = contact_a.id AND `$locationType-address`.location_type_id = $locationTypeId)";
 305         }
 306         $this->_tables[$name] = "\nLEFT JOIN $name ON $name.entity_id = `$joinTableAlias`.id";
 307         if ($this->_ids[$id]) {
 308           $this->_whereTables[$name] = $this->_tables[$name];
 309         }
 310         if ($joinTable != 'contact_a') {
 311           $this->_whereTables[$joinTableAlias] = $this->_tables[$joinTableAlias] = $joinClause;
 312         }
 313         elseif ($this->_contactSearch) {
 314           CRM_Contact_BAO_Query::$_openedPanes[ts('Custom Fields')] = TRUE;
 315         }
 316       }
 317     }
 318   }
 319
 320   /**
 321    * Generate the where clause and also the english language.
 322    * equivalent
 323    *
 324    * @return void
 325    */
 326   public function where() {
 327     foreach ($this->_ids as $id => $values) {
 328
 329       // Fixed for Isuue CRM 607
 330       if (CRM_Utils_Array::value($id, $this->_fields) === NULL ||
 331         !$values
 332       ) {
 333         continue;
 334       }
 335
 336       $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
 337
 338       foreach ($values as $tuple) {
 339         list($name, $op, $value, $grouping, $wildcard) = $tuple;
 340
 341         $field = $this->_fields[$id];
 342
 343         $fieldName = "{$field['table_name']}.{$field['column_name']}";
 344
 345         // Autocomplete comes back as a string not an array
 346         if ($field['data_type'] == 'String' && $field['html_type'] == 'Autocomplete-Select' && $op == '=') {
 347           $value = explode(',', $value);
 348         }
 349
 350         // Handle multi-select search for any data type
 351         if (is_array($value) && !$field['is_search_range']) {
 352           $isSerialized = CRM_Core_BAO_CustomField::isSerialized($field);
 353           $wildcard = $isSerialized ? $wildcard : TRUE;
 354           $options = CRM_Utils_Array::value('values', civicrm_api3('contact', 'getoptions', array(
 355                 'field' => $name,
 356                 'context' => 'search',
 357               ), array()));
 358           $qillValue = '';
 359           $sqlOP = $wildcard ? ' OR ' : ' AND ';
 360           $sqlValue = array();
 361           foreach ($value as $num => &$v) {
 362             $sep = count($value) > (1 + $num) ? ', ' : (' ' . ($wildcard ? ts('OR') : ts('AND')) . ' ');
 363             $qillValue .= ($num ? $sep : '') . $options[$v];
 364             $v = CRM_Core_DAO::escapeString($v);
 365             if ($isSerialized) {
 366               $sqlValue[] = "( $fieldName like '%" . CRM_Core_DAO::VALUE_SEPARATOR . $v . CRM_Core_DAO::VALUE_SEPARATOR . "%' ) ";
 367             }
 368             else {
 369               $v = "'$v'";
 370             }
 371           }
 372           if (!$isSerialized) {
 373             $sqlValue = array("$fieldName IN (" . implode(',', $value) . ")");
 374           }
 375           $this->_where[$grouping][] = ' ( ' . implode($sqlOP, $sqlValue) . ' ) ';
 376           $this->_qill[$grouping][] = "$field[label] $op $qillValue";
 377           continue;
 378         }
 379
 380         // fix $value here to escape sql injection attacks
 381         if (!is_array($value)) {
 382           $value = CRM_Core_DAO::escapeString(trim($value));
 383         }
 384
 385         $qillValue = CRM_Core_BAO_CustomField::getDisplayValue($value, $id, $this->_options);
 386         $qillOp = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
 387
 388         switch ($field['data_type']) {
 389           case 'String':
 390             $sql = "$fieldName";
 391
 392             if ($field['is_search_range'] && is_array($value)) {
 393               $this->searchRange($field['id'],
 394                 $field['label'],
 395                 $field['data_type'],
 396                 $fieldName,
 397                 $value,
 398                 $grouping
 399               );
 400             }
 401             else {
 402               $val = CRM_Utils_Type::escape($strtolower(trim($value)), 'String');
 403
 404               // CRM-14563,CRM-16575 : Special handling of multi-select custom fields
 405               $specialHTMLType = array(
 406                 'CheckBox',
 407                 'Multi-Select',
 408                 'AdvMulti-Select',
 409                 'Multi-Select State/Province',
 410                 'Multi-Select Country',
 411               );
 412               if (!empty($val)) {
 413                 if (in_array($field['html_type'], $specialHTMLType)) {
 414                   if (strstr($op, 'IN')) {
 415                     $val = str_replace(array('(', ')'), '', str_replace(",", "[[:cntrl:]]|[[:cntrl:]]", $val));
 416                   }
 417                   $op = (strstr($op, '!') || strstr($op, 'NOT')) ? 'NOT RLIKE' : 'RLIKE';
 418                   $val = "[[:cntrl:]]" . $val . "[[:cntrl:]]";
 419                 }
 420                 elseif ($wildcard) {
 421                   $val = "[[:cntrl:]]%$val%[[:cntrl:]]";
 422                   $op = 'LIKE';
 423                 }
 424               }
 425
 426               //FIX for custom data query fired against no value(NULL/NOT NULL)
 427               $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($sql, $op, $val, $field['data_type']);
 428               $this->_qill[$grouping][] = "$field[label] $qillOp $qillValue";
 429             }
 430             break;
 431
 432           case 'ContactReference':
 433             $label = $value ? CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name') : '';
 434             $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
 435             $this->_qill[$grouping][] = $field['label'] . " $qillOp $label";
 436             break;
 437
 438           case 'Int':
 439             if ($field['is_search_range'] && is_array($value)) {
 440               $this->searchRange($field['id'], $field['label'], $field['data_type'], $fieldName, $value, $grouping);
 441             }
 442             else {
 443               $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Integer');
 444               $this->_qill[$grouping][] = $field['label'] . " $qillOp $value";
 445             }
 446             break;
 447
 448           case 'Boolean':
 449             if (strtolower($value) == 'yes' || strtolower($value) == strtolower(ts('Yes'))) {
 450               $value = 1;
 451             }
 452             else {
 453               $value = (int) $value;
 454             }
 455             $value = ($value == 1) ? 1 : 0;
 456             $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Integer');
 457             $value = $value ? ts('Yes') : ts('No');
 458             $this->_qill[$grouping][] = $field['label'] . " $qillOp {$value}";
 459             break;
 460
 461           case 'Link':
 462             $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
 463             $this->_qill[$grouping][] = $field['label'] . " $qillOp $value";
 464             break;
 465
 466           case 'Float':
 467             if ($field['is_search_range'] && is_array($value)) {
 468               $this->searchRange($field['id'], $field['label'], $field['data_type'], $fieldName, $value, $grouping);
 469             }
 470             else {
 471               $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Float');
 472               $this->_qill[$grouping][] = $field['label'] . " $qillOp {$value}";
 473             }
 474             break;
 475
 476           case 'Money':
 477             if ($field['is_search_range'] && is_array($value)) {
 478               foreach ($value as $key => $val) {
 479                 $moneyFormat = CRM_Utils_Rule::cleanMoney($value[$key]);
 480                 $value[$key] = $moneyFormat;
 481               }
 482               $this->searchRange($field['id'], $field['label'], $field['data_type'], $fieldName, $value, $grouping);
 483             }
 484             else {
 485               $moneyFormat = CRM_Utils_Rule::cleanMoney($value);
 486               $value = $moneyFormat;
 487               $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Float');
 488               $this->_qill[$grouping][] = $field['label'] . " {$qillOp} {$value}";
 489             }
 490             break;
 491
 492           case 'Memo':
 493             $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
 494             $this->_qill[$grouping][] = "$field[label] $qillOp $value";
 495             break;
 496
 497           case 'Date':
 498             $fromValue = CRM_Utils_Array::value('from', $value);
 499             $toValue = CRM_Utils_Array::value('to', $value);
 500
 501             if (!$fromValue && !$toValue) {
 502               if (!CRM_Utils_Date::processDate($value) && !in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
 503                 continue;
 504               }
 505
 506               // hack to handle yy format during search
 507               if (is_numeric($value) && strlen($value) == 4) {
 508                 $value = "01-01-{$value}";
 509               }
 510
 511               $date = CRM_Utils_Date::processDate($value);
 512               $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $date, 'String');
 513               $this->_qill[$grouping][] = $field['label'] . " {$qillOp} " . CRM_Utils_Date::customFormat($date);
 514             }
 515             else {
 516               if (is_numeric($fromValue) && strlen($fromValue) == 4) {
 517                 $fromValue = "01-01-{$fromValue}";
 518               }
 519
 520               if (is_numeric($toValue) && strlen($toValue) == 4) {
 521                 $toValue = "01-01-{$toValue}";
 522               }
 523
 524               // TO DO: add / remove time based on date parts
 525               $fromDate = CRM_Utils_Date::processDate($fromValue);
 526               $toDate = CRM_Utils_Date::processDate($toValue);
 527               if (!$fromDate && !$toDate) {
 528                 continue;
 529               }
 530               if ($fromDate) {
 531                 $this->_where[$grouping][] = "$fieldName >= $fromDate";
 532                 $this->_qill[$grouping][] = $field['label'] . ' >= ' . CRM_Utils_Date::customFormat($fromDate);
 533               }
 534               if ($toDate) {
 535                 $this->_where[$grouping][] = "$fieldName <= $toDate";
 536                 $this->_qill[$grouping][] = $field['label'] . ' <= ' . CRM_Utils_Date::customFormat($toDate);
 537               }
 538             }
 539             break;
 540
 541           case 'StateProvince':
 542           case 'Country':
 543             $this->_where[$grouping][] = "$fieldName {$op} " . CRM_Utils_Type::escape($value, 'Int');
 544             $this->_qill[$grouping][] = $field['label'] . " {$qillOp} {$qillValue}";
 545             break;
 546
 547           case 'File':
 548             if ($op == 'IS NULL' || $op == 'IS NOT NULL' || $op == 'IS EMPTY' || $op == 'IS NOT EMPTY') {
 549               switch ($op) {
 550                 case 'IS EMPTY':
 551                   $op = 'IS NULL';
 552                   break;
 553
 554                 case 'IS NOT EMPTY':
 555                   $op = 'IS NOT NULL';
 556                   break;
 557               }
 558               $this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op);
 559               $this->_qill[$grouping][] = $field['label'] . " {$qillOp} ";
 560             }
 561             break;
 562         }
 563       }
 564     }
 565   }
 566
 567   /**
 568    * Function that does the actual query generation.
 569    * basically ties all the above functions together
 570    *
 571    * @return array
 572    *   array of strings
 573    */
 574   public function query() {
 575     $this->select();
 576
 577     $this->where();
 578
 579     $whereStr = NULL;
 580     if (!empty($this->_where)) {
 581       $clauses = array();
 582       foreach ($this->_where as $grouping => $values) {
 583         if (!empty($values)) {
 584           $clauses[] = ' ( ' . implode(' AND ', $values) . ' ) ';
 585         }
 586       }
 587       if (!empty($clauses)) {
 588         $whereStr = ' ( ' . implode(' OR ', $clauses) . ' ) ';
 589       }
 590     }
 591
 592     return array(
 593       implode(' , ', $this->_select),
 594       implode(' ', $this->_tables),
 595       $whereStr,
 596     );
 597   }
 598
 599   /**
 600    * @param int $id
 601    * @param $label
 602    * @param $type
 603    * @param string $fieldName
 604    * @param $value
 605    * @param $grouping
 606    */
 607   public function searchRange(&$id, &$label, $type, $fieldName, &$value, &$grouping) {
 608     $qill = array();
 609
 610     if (isset($value['from'])) {
 611       $val = CRM_Utils_Type::escape($value['from'], $type);
 612
 613       if ($type == 'String') {
 614         $this->_where[$grouping][] = "$fieldName >= '$val'";
 615       }
 616       else {
 617         $this->_where[$grouping][] = "$fieldName >= $val";
 618       }
 619       $qill[] = ts('greater than or equal to \'%1\'', array(1 => $value['from']));
 620     }
 621
 622     if (isset($value['to'])) {
 623       $val = CRM_Utils_Type::escape($value['to'], $type);
 624       if ($type == 'String') {
 625         $this->_where[$grouping][] = "$fieldName <= '$val'";
 626       }
 627       else {
 628         $this->_where[$grouping][] = "$fieldName <= $val";
 629       }
 630       $qill[] = ts('less than or equal to \'%1\'', array(1 => $value['to']));
 631     }
 632
 633     if (!empty($qill)) {
 634       $this->_qill[$grouping][] = $label . ' - ' . implode(' ' . ts('and') . ' ', $qill);
 635     }
 636   }
 637
 638 }