4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
33 * @copyright CiviCRM LLC (c) 2004-2014
37 class CRM_Core_BAO_CustomQuery
{
38 const PREFIX
= 'custom_value_';
41 * The set of custom field ids
55 * The name of the elements that are in the select clause
56 * used to extract the values
63 * The tables involved in the query
78 * The english language version of the query
85 * The cache to translate the option values into labels
92 * The custom fields information
99 * Searching for contacts?
103 protected $_contactSearch;
105 protected $_locationSpecificCustomFields;
108 * This stores custom data group types and tables that it extends
113 static $extendsMap = array(
114 'Contact' => 'civicrm_contact',
115 'Individual' => 'civicrm_contact',
116 'Household' => 'civicrm_contact',
117 'Organization' => 'civicrm_contact',
118 'Contribution' => 'civicrm_contribution',
119 'Membership' => 'civicrm_membership',
120 'Participant' => 'civicrm_participant',
121 'Group' => 'civicrm_group',
122 'Relationship' => 'civicrm_relationship',
123 'Event' => 'civicrm_event',
124 'Case' => 'civicrm_case',
125 'Activity' => 'civicrm_activity',
126 'Pledge' => 'civicrm_pledge',
127 'Grant' => 'civicrm_grant',
128 'Address' => 'civicrm_address',
129 'Campaign' => 'civicrm_campaign',
130 'Survey' => 'civicrm_survey',
136 * Takes in a set of custom field ids andsets up the data structures to
140 * The set of custom field ids.
142 * @param bool $contactSearch
143 * @param array $locationSpecificFields
146 public function __construct($ids, $contactSearch = FALSE, $locationSpecificFields = array()) {
148 $this->_locationSpecificCustomFields
= $locationSpecificFields;
150 $this->_select
= array();
151 $this->_element
= array();
152 $this->_tables
= array();
153 $this->_whereTables
= array();
154 $this->_where
= array();
155 $this->_qill
= array();
156 $this->_options
= array();
158 $this->_fields
= array();
159 $this->_contactSearch
= $contactSearch;
161 if (empty($this->_ids
)) {
165 // initialize the field array
166 $tmpArray = array_keys($this->_ids
);
167 $idString = implode(',', $tmpArray);
169 SELECT f.id, f.label, f.data_type,
170 f.html_type, f.is_search_range,
171 f.option_group_id, f.custom_group_id,
172 f.column_name, g.table_name,
173 f.date_format,f.time_format
174 FROM civicrm_custom_field f,
175 civicrm_custom_group g
176 WHERE f.custom_group_id = g.id
179 AND f.id IN ( $idString )";
181 $dao = CRM_Core_DAO
::executeQuery($query);
182 while ($dao->fetch()) {
183 // get the group dao to figure which class this custom field extends
184 $extends = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $dao->custom_group_id
, 'extends');
185 if (array_key_exists($extends, self
::$extendsMap)) {
186 $extendsTable = self
::$extendsMap[$extends];
188 elseif (in_array($extends, CRM_Contact_BAO_ContactType
::subTypes())) {
189 // if $extends is a subtype, refer contact table
190 $extendsTable = self
::$extendsMap['Contact'];
192 $this->_fields
[$dao->id
] = array(
194 'label' => $dao->label
,
195 'extends' => $extendsTable,
196 'data_type' => $dao->data_type
,
197 'html_type' => $dao->html_type
,
198 'is_search_range' => $dao->is_search_range
,
199 'column_name' => $dao->column_name
,
200 'table_name' => $dao->table_name
,
201 'option_group_id' => $dao->option_group_id
,
204 // store it in the options cache to make things easier
205 // during option lookup
206 $this->_options
[$dao->id
] = array();
207 $this->_options
[$dao->id
]['attributes'] = array(
208 'label' => $dao->label
,
209 'data_type' => $dao->data_type
,
210 'html_type' => $dao->html_type
,
213 $optionGroupID = NULL;
214 $htmlTypes = array('CheckBox', 'Radio', 'Select', 'Multi-Select', 'AdvMulti-Select', 'Autocomplete-Select');
215 if (in_array($dao->html_type
, $htmlTypes) && $dao->data_type
!= 'ContactReference') {
216 if ($dao->option_group_id
) {
217 $optionGroupID = $dao->option_group_id
;
219 elseif ($dao->data_type
!= 'Boolean') {
220 $errorMessage = ts("The custom field %1 is corrupt. Please delete and re-build the field",
221 array(1 => $dao->label
)
223 CRM_Core_Error
::fatal($errorMessage);
226 elseif ($dao->html_type
== 'Select Date') {
227 $this->_options
[$dao->id
]['attributes']['date_format'] = $dao->date_format
;
228 $this->_options
[$dao->id
]['attributes']['time_format'] = $dao->time_format
;
231 // build the cache for custom values with options (label => value)
232 if ($optionGroupID != NULL) {
235 FROM civicrm_option_value
236 WHERE option_group_id = $optionGroupID
239 $option = CRM_Core_DAO
::executeQuery($query);
240 while ($option->fetch()) {
241 $dataType = $this->_fields
[$dao->id
]['data_type'];
242 if ($dataType == 'Int' ||
$dataType == 'Float') {
243 $num = round($option->value
, 2);
244 $this->_options
[$dao->id
]["$num"] = $option->label
;
247 $this->_options
[$dao->id
][$option->value
] = $option->label
;
250 $options = $this->_options
[$dao->id
];
251 //unset attributes to avoid confussion
252 unset($options['attributes']);
253 CRM_Utils_Hook
::customFieldOptions($dao->id
, $options, FALSE);
259 * Generate the select clause and the associated tables
260 * for the from clause
266 public function select() {
267 if (empty($this->_fields
)) {
271 foreach ($this->_fields
as $id => $field) {
272 $name = $field['table_name'];
273 $fieldName = 'custom_' . $field['id'];
274 $this->_select
["{$name}_id"] = "{$name}.id as {$name}_id";
275 $this->_element
["{$name}_id"] = 1;
276 $this->_select
[$fieldName] = "{$field['table_name']}.{$field['column_name']} as $fieldName";
277 $this->_element
[$fieldName] = 1;
280 if ($field['extends'] == 'civicrm_group') {
283 elseif ($field['extends'] == 'civicrm_contact') {
284 $joinTable = 'contact_a';
286 elseif ($field['extends'] == 'civicrm_contribution') {
287 $joinTable = $field['extends'];
289 elseif (in_array($field['extends'], self
::$extendsMap)) {
290 $joinTable = $field['extends'];
296 $this->_tables
[$name] = "\nLEFT JOIN $name ON $name.entity_id = $joinTable.id";
298 if ($this->_ids
[$id]) {
299 $this->_whereTables
[$name] = $this->_tables
[$name];
304 $joinTableAlias = $joinTable;
305 // Set location-specific query
306 if (isset($this->_locationSpecificCustomFields
[$id])) {
307 list($locationType, $locationTypeId) = $this->_locationSpecificCustomFields
[$id];
308 $joinTableAlias = "$locationType-address";
309 $joinClause = "\nLEFT JOIN $joinTable `$locationType-address` ON (`$locationType-address`.contact_id = contact_a.id AND `$locationType-address`.location_type_id = $locationTypeId)";
311 $this->_tables
[$name] = "\nLEFT JOIN $name ON $name.entity_id = `$joinTableAlias`.id";
312 if ($this->_ids
[$id]) {
313 $this->_whereTables
[$name] = $this->_tables
[$name];
315 if ($joinTable != 'contact_a') {
316 $this->_whereTables
[$joinTableAlias] = $this->_tables
[$joinTableAlias] = $joinClause;
318 elseif ($this->_contactSearch
) {
319 CRM_Contact_BAO_Query
::$_openedPanes[ts('Custom Fields')] = TRUE;
326 * Generate the where clause and also the english language
334 public function where() {
335 foreach ($this->_ids
as $id => $values) {
337 // Fixed for Isuue CRM 607
338 if (CRM_Utils_Array
::value($id, $this->_fields
) === NULL ||
344 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
346 foreach ($values as $tuple) {
347 list($name, $op, $value, $grouping, $wildcard) = $tuple;
349 $field = $this->_fields
[$id];
351 $fieldName = "{$field['table_name']}.{$field['column_name']}";
353 // Autocomplete comes back as a string not an array
354 if ($field['data_type'] == 'String' && $field['html_type'] == 'Autocomplete-Select' && $op == '=') {
355 $value = explode(',', $value);
358 // Handle multi-select search for any data type
359 if (is_array($value) && !$field['is_search_range']) {
360 $isSerialized = CRM_Core_BAO_CustomField
::isSerialized($field);
361 $wildcard = $isSerialized ?
$wildcard : TRUE;
362 $options = CRM_Utils_Array
::value('values', civicrm_api3('contact', 'getoptions', array('field' => $name, 'context' => 'search'), array()));
364 $sqlOP = $wildcard ?
' OR ' : ' AND ';
366 foreach ($value as $num => &$v) {
367 $sep = count($value) > (1 +
$num) ?
', ' : (' ' . ($wildcard ?
ts('OR') : ts('AND')) . ' ');
368 $qillValue .= ($num ?
$sep : '') . $options[$v];
369 $v = CRM_Core_DAO
::escapeString($v);
371 $sqlValue[] = "( $fieldName like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $v . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' ) ";
377 if (!$isSerialized) {
378 $sqlValue = array("$fieldName IN (" . implode(',', $value) . ")");
380 $this->_where
[$grouping][] = ' ( ' . implode($sqlOP, $sqlValue) . ' ) ';
381 $this->_qill
[$grouping][] = "$field[label] $op $qillValue";
385 // fix $value here to escape sql injection attacks
386 if (!is_array($value)) {
387 $value = CRM_Core_DAO
::escapeString(trim($value));
390 $qillValue = CRM_Core_BAO_CustomField
::getDisplayValue($value, $id, $this->_options
);
392 switch ($field['data_type']) {
396 if ($field['is_search_range'] && is_array($value)) {
397 $this->searchRange($field['id'],
406 $val = CRM_Utils_Type
::escape($strtolower(trim($value)), 'String');
409 $val = $strtolower(CRM_Core_DAO
::escapeString($val));
414 //FIX for custom data query fired against no value(NULL/NOT NULL)
415 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($sql, $op, $val, $field['data_type']);
416 $this->_qill
[$grouping][] = "$field[label] $op $qillValue";
420 case 'ContactReference':
421 $label = $value ? CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name') : '';
422 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'String');
423 $this->_qill
[$grouping][] = $field['label'] . " $op $label";
427 if ($field['is_search_range'] && is_array($value)) {
428 $this->searchRange($field['id'], $field['label'], $field['data_type'], $fieldName, $value, $grouping);
431 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'Integer');
432 $this->_qill
[$grouping][] = $field['label'] . " $op $value";
437 if (strtolower($value) == 'yes' ||
strtolower($value) == strtolower(ts('Yes'))) {
441 $value = (int) $value;
443 $value = ($value == 1) ?
1 : 0;
444 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'Integer');
445 $value = $value ?
ts('Yes') : ts('No');
446 $this->_qill
[$grouping][] = $field['label'] . " {$op} {$value}";
450 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'String');
451 $this->_qill
[$grouping][] = $field['label'] . " $op $value";
455 if ($field['is_search_range'] && is_array($value)) {
456 $this->searchRange($field['id'], $field['label'], $field['data_type'], $fieldName, $value, $grouping);
459 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'Float');
460 $this->_qill
[$grouping][] = $field['label'] . " {$op} {$value}";
465 if ($field['is_search_range'] && is_array($value)) {
466 foreach ($value as $key => $val) {
467 $moneyFormat = CRM_Utils_Rule
::cleanMoney($value[$key]);
468 $value[$key] = $moneyFormat;
470 $this->searchRange($field['id'], $field['label'], $field['data_type'], $fieldName, $value, $grouping);
473 $moneyFormat = CRM_Utils_Rule
::cleanMoney($value);
474 $value = $moneyFormat;
475 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'Float');
476 $this->_qill
[$grouping][] = $field['label'] . " {$op} {$value}";
481 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $value, 'String');
482 $this->_qill
[$grouping][] = "$field[label] $op $value";
486 $fromValue = CRM_Utils_Array
::value('from', $value);
487 $toValue = CRM_Utils_Array
::value('to', $value);
489 if (!$fromValue && !$toValue) {
490 if (!CRM_Utils_Date
::processDate($value) && $op != 'IS NULL' && $op != 'IS NOT NULL') {
494 // hack to handle yy format during search
495 if (is_numeric($value) && strlen($value) == 4) {
496 $value = "01-01-{$value}";
499 $date = CRM_Utils_Date
::processDate($value);
500 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op, $date, 'String');
501 $this->_qill
[$grouping][] = $field['label'] . " {$op} " . CRM_Utils_Date
::customFormat($date);
504 if (is_numeric($fromValue) && strlen($fromValue) == 4) {
505 $fromValue = "01-01-{$fromValue}";
508 if (is_numeric($toValue) && strlen($toValue) == 4) {
509 $toValue = "01-01-{$toValue}";
512 // TO DO: add / remove time based on date parts
513 $fromDate = CRM_Utils_Date
::processDate($fromValue);
514 $toDate = CRM_Utils_Date
::processDate($toValue);
515 if (!$fromDate && !$toDate) {
519 $this->_where
[$grouping][] = "$fieldName >= $fromDate";
520 $this->_qill
[$grouping][] = $field['label'] . ' >= ' . CRM_Utils_Date
::customFormat($fromDate);
523 $this->_where
[$grouping][] = "$fieldName <= $toDate";
524 $this->_qill
[$grouping][] = $field['label'] . ' <= ' . CRM_Utils_Date
::customFormat($toDate);
529 case 'StateProvince':
531 $this->_where
[$grouping][] = "$fieldName {$op} " . CRM_Utils_Type
::escape($value, 'Int');
532 $this->_qill
[$grouping][] = $field['label'] . " {$op} {$qillValue}";
536 if ($op == 'IS NULL' ||
$op == 'IS NOT NULL' ||
$op == 'IS EMPTY' ||
$op == 'IS NOT EMPTY') {
546 $this->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($fieldName, $op);
547 $this->_qill
[$grouping][] = $field['label'] . " {$op} ";
556 * Function that does the actual query generation
557 * basically ties all the above functions together
564 public function query() {
570 if (!empty($this->_where
)) {
572 foreach ($this->_where
as $grouping => $values) {
573 if (!empty($values)) {
574 $clauses[] = ' ( ' . implode(' AND ', $values) . ' ) ';
577 if (!empty($clauses)) {
578 $whereStr = ' ( ' . implode(' OR ', $clauses) . ' ) ';
582 return array(implode(' , ', $this->_select
),
583 implode(' ', $this->_tables
),
592 * @param string $fieldName
596 public function searchRange(&$id, &$label, $type, $fieldName, &$value, &$grouping) {
599 if (isset($value['from'])) {
600 $val = CRM_Utils_Type
::escape($value['from'], $type);
602 if ($type == 'String') {
603 $this->_where
[$grouping][] = "$fieldName >= '$val'";
606 $this->_where
[$grouping][] = "$fieldName >= $val";
608 $qill[] = ts('greater than or equal to \'%1\'', array(1 => $value['from']));
611 if (isset($value['to'])) {
612 $val = CRM_Utils_Type
::escape($value['to'], $type);
613 if ($type == 'String') {
614 $this->_where
[$grouping][] = "$fieldName <= '$val'";
617 $this->_where
[$grouping][] = "$fieldName <= $val";
619 $qill[] = ts('less than or equal to \'%1\'', array(1 => $value['to']));
623 $this->_qill
[$grouping][] = $label . ' - ' . implode(' ' . ts('and') . ' ', $qill);