-
-
Notifications
You must be signed in to change notification settings - Fork 814
/
CustomQuery.php
523 lines (470 loc) · 18.2 KB
/
CustomQuery.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
*/
class CRM_Core_BAO_CustomQuery {
const PREFIX = 'custom_value_';
/**
* The set of custom field ids.
*
* @var array
*/
protected $_ids;
/**
* The select clause.
*
* @var array
*/
public $_select;
/**
* The name of the elements that are in the select clause.
* used to extract the values
*
* @var array
*/
public $_element;
/**
* The tables involved in the query.
*
* @var array
*/
public $_tables;
public $_whereTables;
/**
* The where clause.
*
* @var array
*/
public $_where;
/**
* The english language version of the query.
*
* @var array
*/
public $_qill;
/**
* @deprecated
* No longer needed due to CRM-17646 refactoring, but still used in some places
*
* @var array
*/
public $_options;
/**
* The custom fields information.
*
* @var array
*/
public $_fields;
/**
* Searching for contacts?
*
* @var boolean
*/
protected $_contactSearch;
protected $_locationSpecificCustomFields;
/**
* This stores custom data group types and tables that it extends.
*
* @var array
*/
static $extendsMap = array(
'Contact' => 'civicrm_contact',
'Individual' => 'civicrm_contact',
'Household' => 'civicrm_contact',
'Organization' => 'civicrm_contact',
'Contribution' => 'civicrm_contribution',
'Membership' => 'civicrm_membership',
'Participant' => 'civicrm_participant',
'Group' => 'civicrm_group',
'Relationship' => 'civicrm_relationship',
'Event' => 'civicrm_event',
'Case' => 'civicrm_case',
'Activity' => 'civicrm_activity',
'Pledge' => 'civicrm_pledge',
'Grant' => 'civicrm_grant',
'Address' => 'civicrm_address',
'Campaign' => 'civicrm_campaign',
'Survey' => 'civicrm_survey',
);
/**
* Class constructor.
*
* Takes in a set of custom field ids andsets up the data structures to
* generate a query
*
* @param array $ids
* The set of custom field ids.
*
* @param bool $contactSearch
* @param array $locationSpecificFields
*/
public function __construct($ids, $contactSearch = FALSE, $locationSpecificFields = array()) {
$this->_ids = &$ids;
$this->_locationSpecificCustomFields = $locationSpecificFields;
$this->_select = array();
$this->_element = array();
$this->_tables = array();
$this->_whereTables = array();
$this->_where = array();
$this->_qill = array();
$this->_options = array();
$this->_fields = array();
$this->_contactSearch = $contactSearch;
if (empty($this->_ids)) {
return;
}
// initialize the field array
$tmpArray = array_keys($this->_ids);
$idString = implode(',', $tmpArray);
$query = "
SELECT f.id, f.label, f.data_type,
f.html_type, f.is_search_range,
f.option_group_id, f.custom_group_id,
f.column_name, g.table_name,
f.date_format,f.time_format
FROM civicrm_custom_field f,
civicrm_custom_group g
WHERE f.custom_group_id = g.id
AND g.is_active = 1
AND f.is_active = 1
AND f.id IN ( $idString )";
$dao = CRM_Core_DAO::executeQuery($query);
while ($dao->fetch()) {
// get the group dao to figure which class this custom field extends
$extends = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $dao->custom_group_id, 'extends');
if (array_key_exists($extends, self::$extendsMap)) {
$extendsTable = self::$extendsMap[$extends];
}
elseif (in_array($extends, CRM_Contact_BAO_ContactType::subTypes())) {
// if $extends is a subtype, refer contact table
$extendsTable = self::$extendsMap['Contact'];
}
$this->_fields[$dao->id] = array(
'id' => $dao->id,
'label' => $dao->label,
'extends' => $extendsTable,
'data_type' => $dao->data_type,
'html_type' => $dao->html_type,
'is_search_range' => $dao->is_search_range,
'column_name' => $dao->column_name,
'table_name' => $dao->table_name,
'option_group_id' => $dao->option_group_id,
);
// store it in the options cache to make things easier
// during option lookup
$this->_options[$dao->id] = array();
$this->_options[$dao->id]['attributes'] = array(
'label' => $dao->label,
'data_type' => $dao->data_type,
'html_type' => $dao->html_type,
);
$optionGroupID = NULL;
$htmlTypes = array('CheckBox', 'Radio', 'Select', 'Multi-Select', 'AdvMulti-Select', 'Autocomplete-Select');
if (in_array($dao->html_type, $htmlTypes) && $dao->data_type != 'ContactReference') {
if ($dao->option_group_id) {
$optionGroupID = $dao->option_group_id;
}
elseif ($dao->data_type != 'Boolean') {
$errorMessage = ts("The custom field %1 is corrupt. Please delete and re-build the field",
array(1 => $dao->label)
);
CRM_Core_Error::fatal($errorMessage);
}
}
elseif ($dao->html_type == 'Select Date') {
$this->_options[$dao->id]['attributes']['date_format'] = $dao->date_format;
$this->_options[$dao->id]['attributes']['time_format'] = $dao->time_format;
}
// build the cache for custom values with options (label => value)
if ($optionGroupID != NULL) {
$query = "
SELECT label, value
FROM civicrm_option_value
WHERE option_group_id = $optionGroupID
";
$option = CRM_Core_DAO::executeQuery($query);
while ($option->fetch()) {
$dataType = $this->_fields[$dao->id]['data_type'];
if ($dataType == 'Int' || $dataType == 'Float') {
$num = round($option->value, 2);
$this->_options[$dao->id]["$num"] = $option->label;
}
else {
$this->_options[$dao->id][$option->value] = $option->label;
}
}
$options = $this->_options[$dao->id];
//unset attributes to avoid confussion
unset($options['attributes']);
CRM_Utils_Hook::customFieldOptions($dao->id, $options, FALSE);
}
}
}
/**
* Generate the select clause and the associated tables.
*/
public function select() {
if (empty($this->_fields)) {
return;
}
foreach ($this->_fields as $id => $field) {
$name = $field['table_name'];
$fieldName = 'custom_' . $field['id'];
$this->_select["{$name}_id"] = "{$name}.id as {$name}_id";
$this->_element["{$name}_id"] = 1;
$this->_select[$fieldName] = "{$field['table_name']}.{$field['column_name']} as $fieldName";
$this->_element[$fieldName] = 1;
$joinTable = NULL;
// CRM-14265
if ($field['extends'] == 'civicrm_group') {
return;
}
elseif ($field['extends'] == 'civicrm_contact') {
$joinTable = 'contact_a';
}
elseif ($field['extends'] == 'civicrm_contribution') {
$joinTable = $field['extends'];
}
elseif (in_array($field['extends'], self::$extendsMap)) {
$joinTable = $field['extends'];
}
else {
return;
}
$this->_tables[$name] = "\nLEFT JOIN $name ON $name.entity_id = $joinTable.id";
if ($this->_ids[$id]) {
$this->_whereTables[$name] = $this->_tables[$name];
}
if ($joinTable) {
$joinClause = 1;
$joinTableAlias = $joinTable;
// Set location-specific query
if (isset($this->_locationSpecificCustomFields[$id])) {
list($locationType, $locationTypeId) = $this->_locationSpecificCustomFields[$id];
$joinTableAlias = "$locationType-address";
$joinClause = "\nLEFT JOIN $joinTable `$locationType-address` ON (`$locationType-address`.contact_id = contact_a.id AND `$locationType-address`.location_type_id = $locationTypeId)";
}
$this->_tables[$name] = "\nLEFT JOIN $name ON $name.entity_id = `$joinTableAlias`.id";
if ($this->_ids[$id]) {
$this->_whereTables[$name] = $this->_tables[$name];
}
if ($joinTable != 'contact_a') {
$this->_whereTables[$joinTableAlias] = $this->_tables[$joinTableAlias] = $joinClause;
}
elseif ($this->_contactSearch) {
CRM_Contact_BAO_Query::$_openedPanes[ts('Custom Fields')] = TRUE;
}
}
}
}
/**
* Generate the where clause and also the english language equivalent.
*/
public function where() {
foreach ($this->_ids as $id => $values) {
// Fixed for Issue CRM 607
if (CRM_Utils_Array::value($id, $this->_fields) === NULL ||
!$values
) {
continue;
}
$strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
foreach ($values as $tuple) {
list($name, $op, $value, $grouping, $wildcard) = $tuple;
$field = $this->_fields[$id];
$fieldName = "{$field['table_name']}.{$field['column_name']}";
$isSerialized = CRM_Core_BAO_CustomField::isSerialized($field);
// fix $value here to escape sql injection attacks
$qillValue = NULL;
if (!is_array($value)) {
$value = CRM_Core_DAO::escapeString(trim($value));
$qillValue = CRM_Core_BAO_CustomField::getDisplayValue($value, $id, $this->_options);
}
elseif (count($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
$op = key($value);
$qillValue = strstr($op, 'NULL') ? NULL : CRM_Core_BAO_CustomField::getDisplayValue($value[$op], $id, $this->_options);
}
else {
$op = strstr($op, 'IN') ? $op : 'IN';
$qillValue = CRM_Core_BAO_CustomField::getDisplayValue($value, $id, $this->_options);
}
$qillOp = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
switch ($field['data_type']) {
case 'String':
case 'StateProvince':
case 'Country':
if ($field['is_search_range'] && is_array($value)) {
//didn't found any field under any of these three data-types as searchable by range
}
else {
// fix $value here to escape sql injection attacks
if (!is_array($value)) {
if ($field['data_type'] == 'String') {
$value = CRM_Utils_Type::escape($strtolower($value), 'String');
}
else {
$value = CRM_Utils_Type::escape($value, 'Integer');
}
$value = str_replace(array('[', ']', ','), array('\[', '\]', '[:comma:]'), $value);
$value = str_replace('|', '[:separator:]', $value);
}
elseif ($isSerialized) {
if (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
$op = key($value);
$value = $value[$op];
}
// CRM-19006: escape characters like comma, | before building regex pattern
$value = (array) $value;
foreach ($value as $key => $val) {
$value[$key] = str_replace(array('[', ']', ','), array('\[', '\]', '[:comma:]'), $val);
$value[$key] = str_replace('|', '[:separator:]', $value[$key]);
}
$value = implode(',', $value);
}
// CRM-14563,CRM-16575 : Special handling of multi-select custom fields
if ($isSerialized && !CRM_Utils_System::isNull($value) && !strstr($op, 'NULL') && !strstr($op, 'LIKE')) {
$sp = CRM_Core_DAO::VALUE_SEPARATOR;
$value = str_replace(",", "$sp|$sp", $value);
$value = str_replace(array('[:comma:]', '(', ')'), array(',', '[[.left-parenthesis.]]', '[[.right-parenthesis.]]'), $value);
$op = (strstr($op, '!') || strstr($op, 'NOT')) ? 'NOT RLIKE' : 'RLIKE';
$value = $sp . $value . $sp;
if (!$wildcard) {
foreach (explode("|", $value) as $val) {
$val = str_replace('[:separator:]', '\|', $val);
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $val, 'String');
}
}
else {
$value = str_replace('[:separator:]', '\|', $value);
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
}
}
else {
//FIX for custom data query fired against no value(NULL/NOT NULL)
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
}
$this->_qill[$grouping][] = $field['label'] . " $qillOp $qillValue";
}
break;
case 'ContactReference':
$label = $value ? CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name') : '';
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
$this->_qill[$grouping][] = $field['label'] . " $qillOp $label";
break;
case 'Int':
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Integer');
$this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $field['label'], 2 => $qillOp, 3 => $qillValue));
break;
case 'Boolean':
if (!is_array($value)) {
if (strtolower($value) == 'yes' || strtolower($value) == strtolower(ts('Yes'))) {
$value = 1;
}
else {
$value = (int) $value;
}
$value = ($value == 1) ? 1 : 0;
$qillValue = $value ? 'Yes' : 'No';
}
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Integer');
$this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $field['label'], 2 => $qillOp, 3 => $qillValue));
break;
case 'Link':
case 'Memo':
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
$this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $field['label'], 2 => $qillOp, 3 => $qillValue));
break;
case 'Money':
$value = CRM_Utils_Array::value($op, (array) $value, $value);
if (is_array($value)) {
foreach ($value as $key => $val) {
$value[$key] = CRM_Utils_Rule::cleanMoney($value[$key]);
}
}
else {
$value = CRM_Utils_Rule::cleanMoney($value);
}
case 'Float':
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'Float');
$this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $field['label'], 2 => $qillOp, 3 => $qillValue));
break;
case 'Date':
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op, $value, 'String');
list($qillOp, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, $field['label'], $value, $op, array(), CRM_Utils_Type::T_DATE);
$this->_qill[$grouping][] = "{$field['label']} $qillOp '$qillVal'";
break;
case 'File':
if ($op == 'IS NULL' || $op == 'IS NOT NULL' || $op == 'IS EMPTY' || $op == 'IS NOT EMPTY') {
switch ($op) {
case 'IS EMPTY':
$op = 'IS NULL';
break;
case 'IS NOT EMPTY':
$op = 'IS NOT NULL';
break;
}
$this->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fieldName, $op);
$this->_qill[$grouping][] = $field['label'] . " {$qillOp} ";
}
break;
}
}
}
}
/**
* Function that does the actual query generation.
* basically ties all the above functions together
*
* @return array
* array of strings
*/
public function query() {
$this->select();
$this->where();
$whereStr = NULL;
if (!empty($this->_where)) {
$clauses = array();
foreach ($this->_where as $grouping => $values) {
if (!empty($values)) {
$clauses[] = ' ( ' . implode(' AND ', $values) . ' ) ';
}
}
if (!empty($clauses)) {
$whereStr = ' ( ' . implode(' OR ', $clauses) . ' ) ';
}
}
return array(
implode(' , ', $this->_select),
implode(' ', $this->_tables),
$whereStr,
);
}
}