projects / civicrm-core.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge pull request #139 from lcdservices/master
[civicrm-core.git] / CRM / Contact / BAO / Query.php
CommitLineData
6a488035
TO		 1<?php
2/*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
32 * $Id$
33 *
34 */
35
36/**
37 * This class is a heart of search query building mechanism.
38 */
39class CRM_Contact_BAO_Query {
40
41 /**
42 * The various search modes
43 *
44 * @var int
45 */
46 CONST
47 MODE_CONTACTS = 1,
48 MODE_CONTRIBUTE = 2,
49 MODE_MEMBER = 8,
50 MODE_EVENT = 16,
51 MODE_GRANT = 128,
52 MODE_PLEDGEBANK = 256,
53 MODE_PLEDGE = 512,
54 MODE_CASE = 2048,
55 MODE_ALL = 17407,
56 MODE_ACTIVITY = 4096,
57 MODE_CAMPAIGN = 8192,
58 MODE_MAILING = 16384;
59
60 /**
61 * the default set of return properties
62 *
63 * @var array
64 * @static
65 */
66 static $_defaultReturnProperties = NULL;
67
68 /**
69 * the default set of hier return properties
70 *
71 * @var array
72 * @static
73 */
74 static $_defaultHierReturnProperties;
75
76 /**
77 * the set of input params
78 *
79 * @var array
80 */
81 public $_params;
82
83 public $_cfIDs;
84
85 public $_paramLookup;
86
87 /**
88 * the set of output params
89 *
90 * @var array
91 */
92 public $_returnProperties;
93
94 /**
95 * the select clause
96 *
97 * @var array
98 */
99 public $_select;
100
101 /**
102 * the name of the elements that are in the select clause
103 * used to extract the values
104 *
105 * @var array
106 */
107 public $_element;
108
109 /**
110 * the tables involved in the query
111 *
112 * @var array
113 */
114 public $_tables;
115
116 /**
117 * the table involved in the where clause
118 *
119 * @var array
120 */
121 public $_whereTables;
122
123 /**
124 * the where clause
125 *
126 * @var array
127 */
128 public $_where;
129
130 /**
131 * the where string
132 *
133 * @var string
134 *
135 */
136 public $_whereClause;
137
138 /**
139 * additional permission Where Clause
140 *
141 * @var string
142 *
143 */
144 public $_permissionWhereClause;
145 /**
146 * the from string
147 *
148 * @var string
149 *
150 */
151 public $_fromClause;
152
153 /**
154 * additional permission from clause
155 *
156 * @var string
157 *
158 */
159 public $_permissionFromClause;
160
161 /**
162 * the from clause for the simple select and alphabetical
163 * select
164 *
165 * @var string
166 */
167 public $_simpleFromClause;
168
169 /**
170 * the having values
171 *
172 * @var string
173 *
174 */
175 public $_having;
176
177 /**
178 * The english language version of the query
179 *
180 * @var array
181 */
182 public $_qill;
183
184 /**
185 * All the fields that could potentially be involved in
186 * this query
187 *
188 * @var array
189 */
190 public $_fields;
191
192 /**
193 * The cache to translate the option values into labels
194 *
195 * @var array
196 */
197 public $_options;
198
199 /**
200 * are we in search mode
201 *
202 * @var boolean
203 */
204 public $_search = TRUE;
205
206 /**
207 * should we skip permission checking
208 *
209 * @var boolean
210 */
211 public $_skipPermission = FALSE;
212
213 /**
214 * should we skip adding of delete clause
215 *
216 * @var boolean
217 */
218 public $_skipDeleteClause = FALSE;
219
220 /**
221 * are we in strict mode (use equality over LIKE)
222 *
223 * @var boolean
224 */
225 public $_strict = FALSE;
226
227 /**
228 * What operator to use to group the clauses
229 *
230 * @var string
231 */
232 public $_operator = 'AND';
233
234 public $_mode = 1;
235
236 /**
237 * Should we only search on primary location
238 *
239 * @var boolean
240 */
241 public $_primaryLocation = TRUE;
242
243 /**
244 * are contact ids part of the query
245 *
246 * @var boolean
247 */
248 public $_includeContactIds = FALSE;
249
250 /**
251 * Should we use the smart group cache
252 *
253 * @var boolean
254 */
255 public $_smartGroupCache = TRUE;
256
257 /**
258 * Should we display contacts with a specific relationship type
259 *
260 * @var string
261 */
262 public $_displayRelationshipType = NULL;
263
264 /**
265 * reference to the query object for custom values
266 *
267 * @var Object
268 */
269 public $_customQuery;
270
271 /**
272 * should we enable the distinct clause, used if we are including
273 * more than one group
274 *
275 * @var boolean
276 */
277 public $_useDistinct = FALSE;
278
279 /**
280 * Should we just display one contact record
281 */
282 public $_useGroupBy = FALSE;
283
284 /**
285 * the relationship type direction
286 *
287 * @var array
288 * @static
289 */
290 static $_relType;
291
292 /**
293 * the activity role
294 *
295 * @var array
296 * @static
297 */
298 static $_activityRole;
299
300 /**
301 * Consider the component activity type
302 * during activity search.
303 *
304 * @var array
305 * @static
306 */
307 static $_considerCompActivities;
308
309 /**
310 * Consider with contact activities only,
311 * during activity search.
312 *
313 * @var array
314 * @static
315 */
316 static $_withContactActivitiesOnly;
317
318 /**
319 * use distinct component clause for component searches
320 *
321 * @var string
322 */
323 public $_distinctComponentClause;
324
325 /**
326 * use groupBy component clause for component searches
327 *
328 * @var string
329 */
330 public $_groupByComponentClause;
331
332 /**
333 * Track open panes, useful in advance search
334 *
335 * @var array
336 * @static
337 */
338 public static $_openedPanes = array();
339
340 /**
341 * The tables which have a dependency on location and/or address
342 *
343 * @var array
344 * @static
345 */
346 static $_dependencies = array(
347 'civicrm_state_province' => 1,
348 'civicrm_country' => 1,
349 'civicrm_county' => 1,
350 'civicrm_address' => 1,
351 'civicrm_location_type' => 1,
352 );
353
354 /**
355 * List of location specific fields
356 */
357 static $_locationSpecificFields = array(
358 'street_address',
359 'street_number',
360 'street_name',
361 'street_unit',
362 'supplemental_address_1',
363 'supplemental_address_2',
364 'city',
365 'postal_code',
366 'postal_code_suffix',
367 'geo_code_1',
368 'geo_code_2',
369 'state_province',
370 'country',
371 'county',
372 'phone',
373 'email',
374 'im',
375 'address_name',
376 );
377
378 /**
379 * Rememeber if we handle either end of a number or date range
380 * so we can skip the other
381 */
382 protected $_rangeCache = array();
383
384 /**
385 * class constructor which also does all the work
386 *
387 * @param array $params
388 * @param array $returnProperties
389 * @param array $fields
390 * @param boolean $includeContactIds
391 * @param boolean $strict
392 * @param boolean $mode - mode the search is operating on
393 *
394 * @return Object
395 * @access public
396 */
397 function __construct(
398 $params = NULL, $returnProperties = NULL, $fields = NULL,
399 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
400 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
401 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
402 $operator = 'AND'
403 ) {
404 $this->_params = &$params;
405 if ($this->_params == NULL) {
406 $this->_params = array();
407 }
408
409 if (empty($returnProperties)) {
410 $this->_returnProperties = self::defaultReturnProperties($mode);
411 }
412 else {
413 $this->_returnProperties = &$returnProperties;
414 }
415
416 $this->_includeContactIds = $includeContactIds;
417 $this->_strict = $strict;
418 $this->_mode = $mode;
419 $this->_skipPermission = $skipPermission;
420 $this->_smartGroupCache = $smartGroupCache;
421 $this->_displayRelationshipType = $displayRelationshipType;
422 $this->setOperator($operator);
423
424 if ($fields) {
425 $this->_fields = &$fields;
426 $this->_search = FALSE;
427 $this->_skipPermission = TRUE;
428 }
429 else {
430 $this->_fields = CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE, TRUE);
431
432 $fields = CRM_Core_Component::getQueryFields();
433 unset($fields['note']);
434 $this->_fields = array_merge($this->_fields, $fields);
435
436 // add activity fields
437 $fields = CRM_Activity_BAO_Activity::exportableFields();
438 $this->_fields = array_merge($this->_fields, $fields);
439 }
440
441 // basically do all the work once, and then reuse it
442 $this->initialize();
443 }
444
445 /**
446 * function which actually does all the work for the constructor
447 *
448 * @return void
449 * @access private
450 */
451 function initialize() {
452 $this->_select = array();
453 $this->_element = array();
454 $this->_tables = array();
455 $this->_whereTables = array();
456 $this->_where = array();
457 $this->_qill = array();
458 $this->_options = array();
459 $this->_cfIDs = array();
460 $this->_paramLookup = array();
461 $this->_having = array();
462
463 $this->_customQuery = NULL;
464
465 // reset cached static variables - CRM-5803
466 self::$_activityRole = NULL;
467 self::$_considerCompActivities = NULL;
468 self::$_withContactActivitiesOnly = NULL;
469
470 $this->_select['contact_id'] = 'contact_a.id as contact_id';
471 $this->_element['contact_id'] = 1;
472 $this->_tables['civicrm_contact'] = 1;
473
474 if (!empty($this->_params)) {
475 $this->buildParamsLookup();
476 }
477
478 $this->_whereTables = $this->_tables;
479
480 $this->selectClause();
481 $this->_whereClause = $this->whereClause();
482
483 $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
484 $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
485
486 $this->openedSearchPanes(TRUE);
487 }
488
489 function buildParamsLookup() {
490 // first fix and handle contact deletion nicely
491 // this code is primarily for search builder use case
492 // where different clauses can specify if they want deleted
493 // contacts or not
494 // CRM-11971
495 $trashParamExists = FALSE;
496 $paramByGroup = array();
497 foreach ( $this->_params as $k => $param ) {
498 if ( $param[0] == 'contact_is_deleted' ) {
499 $trashParamExists = TRUE;
500 }
501 $paramByGroup[$param[3]][$k] = $param;
502 }
503
504 if ( $trashParamExists ) {
505 $this->_skipDeleteClause = TRUE;
506
507 //cycle through group sets and explicitly add trash param if not set
508 foreach ( $paramByGroup as $setID => $set ) {
509 if (
510 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params) &&
511 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params) ) {
512 $this->_params[] = array(
513 'contact_is_deleted',
514 '=',
515 '0',
516 $setID,
517 '0',
518 );
519 }
520 }
521 }
522
523 foreach ($this->_params as $value) {
524 if (!CRM_Utils_Array::value(0, $value)) {
525 continue;
526 }
527 $cfID = CRM_Core_BAO_CustomField::getKeyID($value[0]);
528 if ($cfID) {
529 if (!array_key_exists($cfID, $this->_cfIDs)) {
530 $this->_cfIDs[$cfID] = array();
531 }
532 $this->_cfIDs[$cfID][] = $value;
533 }
534
535 if (!array_key_exists($value[0], $this->_paramLookup)) {
536 $this->_paramLookup[$value[0]] = array();
537 }
538 $this->_paramLookup[$value[0]][] = $value;
539 }
540 }
541
542 /**
543 * Some composite fields do not appear in the fields array
544 * hack to make them part of the query
545 *
546 * @return void
547 * @access public
548 */
549 function addSpecialFields() {
550 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
551 foreach ($special as $name) {
552 if (CRM_Utils_Array::value($name, $this->_returnProperties)) {
553 $this->_select[$name] = "contact_a.{$name} as $name";
554 $this->_element[$name] = 1;
555 }
556 }
557 }
558
559 /**
560 * Given a list of conditions in params and a list of desired
561 * return Properties generate the required select and from
562 * clauses. Note that since the where clause introduces new
563 * tables, the initial attempt also retrieves all variables used
564 * in the params list
565 *
566 * @return void
567 * @access public
568 */
569 function selectClause() {
570 $properties = array();
571
572 $this->addSpecialFields();
573
574 foreach ($this->_fields as $name => $field) {
575
576 // skip component fields
577 // there are done by the alter query below
578 // and need not be done on every field
579 if ((substr($name, 0, 12) == 'participant_') ||
580 (substr($name, 0, 7) == 'pledge_') ||
581 (substr($name, 0, 5) == 'case_')
582 ) {
583 continue;
584 }
585
586 // redirect to activity select clause
587 if (substr($name, 0, 9) == 'activity_') {
588 CRM_Activity_BAO_Query::select($this);
589 continue;
590 }
591
592 // if this is a hierarchical name, we ignore it
593 $names = explode('-', $name);
594 if (count($names > 1) && isset($names[1]) && is_numeric($names[1])) {
595 continue;
596 }
597
598 $cfID = CRM_Core_BAO_CustomField::getKeyID($name);
599
600 if (CRM_Utils_Array::value($name, $this->_paramLookup) ||
601 CRM_Utils_Array::value($name, $this->_returnProperties)
602 ) {
603
604 if ($cfID) {
605 // add to cfIDs array if not present
606 if (!array_key_exists($cfID, $this->_cfIDs)) {
607 $this->_cfIDs[$cfID] = array();
608 }
609 }
610 elseif (isset($field['where'])) {
611 list($tableName, $fieldName) = explode('.', $field['where'], 2);
612 if (isset($tableName)) {
613
614 if (CRM_Utils_Array::value($tableName, self::$_dependencies)) {
615 $this->_tables['civicrm_address'] = 1;
616 $this->_select['address_id'] = 'civicrm_address.id as address_id';
617 $this->_element['address_id'] = 1;
618 }
619
620 if ($tableName == 'gender' || $tableName == 'individual_prefix'
621 || $tableName == 'individual_suffix' || $tableName == 'im_provider'
622 || $tableName == 'email_greeting' || $tableName == 'postal_greeting'
623 || $tableName == 'addressee'
624 ) {
625 CRM_Core_OptionValue::select($this);
626 if (in_array($tableName, array(
627 'email_greeting', 'postal_greeting', 'addressee'))) {
628 //get display
629 $greetField = "{$name}_display";
630 $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}";
631 $this->_element[$greetField] = 1;
632 //get custom
633 $greetField = "{$name}_custom";
634 $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}";
635 $this->_element[$greetField] = 1;
636 }
637 }
638 else {
639 $this->_tables[$tableName] = 1;
640
641 // also get the id of the tableName
642 $tName = substr($tableName, 8);
643
644 if ($tName != 'contact') {
645 $this->_select["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
646 $this->_element["{$tName}_id"] = 1;
647 }
648
649 //special case for phone
650 if ($name == 'phone') {
651 $this->_select['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
652 $this->_element['phone_type_id'] = 1;
653 }
654
655 // if IM then select provider_id also
656 // to get "IM Service Provider" in a file to be exported, CRM-3140
657 if ($name == 'im') {
658 $this->_select['provider_id'] = "civicrm_im.provider_id as provider_id";
659 $this->_element['provider_id'] = 1;
660 }
661
662 if ($name == 'state_province') {
663 $this->_select[$name] = "civicrm_state_province.abbreviation as `$name`, civicrm_state_province.name as state_province_name";
664 $this->_element['state_province_name'] = 1;
665 }
666 elseif ($tName == 'contact') {
667 // special case, when current employer is set for Individual contact
668 if ($fieldName == 'organization_name') {
669 $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
670 }
671 elseif ($fieldName != 'id') {
672 $this->_select[$name] = "contact_a.{$fieldName} as `$name`";
673 }
674 }
675 else {
676 $this->_select[$name] = "{$field['where']} as `$name`";
677 }
678 $this->_element[$name] = 1;
679 }
680 }
681 }
682 elseif ($name === 'tags') {
683 $this->_useGroupBy = TRUE;
684 $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
685 $this->_element[$name] = 1;
686 $this->_tables['civicrm_tag'] = 1;
687 $this->_tables['civicrm_entity_tag'] = 1;
688 }
689 elseif ($name === 'groups') {
690 $this->_useGroupBy = TRUE;
691 $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
692 $this->_element[$name] = 1;
693 $this->_tables['civicrm_group'] = 1;
694 }
695 elseif ($name === 'notes') {
696 $this->_useGroupBy = TRUE;
697 $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.note)) as notes";
698 $this->_element[$name] = 1;
699 $this->_tables['civicrm_note'] = 1;
700 }
701 elseif ($name === 'current_employer') {
702 $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
703 $this->_element[$name] = 1;
704 }
705 }
706
707 if ($cfID &&
708 CRM_Utils_Array::value('is_search_range', $field)
709 ) {
710 // this is a custom field with range search enabled, so we better check for two/from values
711 if (CRM_Utils_Array::value($name . '_from', $this->_paramLookup)) {
712 if (!array_key_exists($cfID, $this->_cfIDs)) {
713 $this->_cfIDs[$cfID] = array();
714 }
715 foreach ($this->_paramLookup[$name . '_from'] as $pID => $p) {
716 // search in the cdID array for the same grouping
717 $fnd = FALSE;
718 foreach ($this->_cfIDs[$cfID] as $cID => $c) {
719 if ($c[3] == $p[3]) {
720 $this->_cfIDs[$cfID][$cID][2]['from'] = $p[2];
721 $fnd = TRUE;
722 }
723 }
724 if (!$fnd) {
725 $p[2] = array('from' => $p[2]);
726 $this->_cfIDs[$cfID][] = $p;
727 }
728 }
729 }
730 if (CRM_Utils_Array::value($name . '_to', $this->_paramLookup)) {
731 if (!array_key_exists($cfID, $this->_cfIDs)) {
732 $this->_cfIDs[$cfID] = array();
733 }
734 foreach ($this->_paramLookup[$name . '_to'] as $pID => $p) {
735 // search in the cdID array for the same grouping
736 $fnd = FALSE;
737 foreach ($this->_cfIDs[$cfID] as $cID => $c) {
738 if ($c[4] == $p[4]) {
739 $this->_cfIDs[$cfID][$cID][2]['to'] = $p[2];
740 $fnd = TRUE;
741 }
742 }
743 if (!$fnd) {
744 $p[2] = array('to' => $p[2]);
745 $this->_cfIDs[$cfID][] = $p;
746 }
747 }
748 }
749 }
750 }
751
752 // add location as hierarchical elements
753 $this->addHierarchicalElements();
754
755 // add multiple field like website
756 $this->addMultipleElements();
757
758 //fix for CRM-951
759 CRM_Core_Component::alterQuery($this, 'select');
760
761 if (!empty($this->_cfIDs)) {
762 $this->_customQuery = new CRM_Core_BAO_CustomQuery($this->_cfIDs, TRUE);
763 $this->_customQuery->query();
764 $this->_select = array_merge($this->_select, $this->_customQuery->_select);
765 $this->_element = array_merge($this->_element, $this->_customQuery->_element);
766 $this->_tables = array_merge($this->_tables, $this->_customQuery->_tables);
767 $this->_whereTables = array_merge($this->_whereTables, $this->_customQuery->_whereTables);
768 $this->_options = $this->_customQuery->_options;
769 }
770 }
771
772 /**
773 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
774 * the return values
775 *
776 * @return void
777 * @access public
778 */
779 function addHierarchicalElements() {
780 if (!CRM_Utils_Array::value('location', $this->_returnProperties)) {
781 return;
782 }
783 if (!is_array($this->_returnProperties['location'])) {
784 return;
785 }
786
787 $locationTypes = CRM_Core_PseudoConstant::locationType();
788 $processed = array();
789 $index = 0;
790
791 $addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address');
792 $addressCustomFieldIds = array();
793
794 foreach ($this->_returnProperties['location'] as $name => $elements) {
795 $lCond = self::getPrimaryCondition($name);
796
797 if (!$lCond) {
798 $locationTypeId = array_search($name, $locationTypes);
799 if ($locationTypeId === FALSE) {
800 continue;
801 }
802 $lCond = "location_type_id = $locationTypeId";
803 $this->_useDistinct = TRUE;
804
805 //commented for CRM-3256
806 $this->_useGroupBy = TRUE;
807 }
808
809 $name = str_replace(' ', '_', $name);
810
811 $tName = "$name-location_type";
812 $ltName = "`$name-location_type`";
813 $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
814 $this->_select["{$tName}"] = "`$tName`.name as `{$tName}`";
815 $this->_element["{$tName}_id"] = 1;
816 $this->_element["{$tName}"] = 1;
817
818 $locationTypeName = $tName;
819 $locationTypeJoin = array();
820
821 $addAddress = FALSE;
822 $addWhereCount = 0;
823 foreach ($elements as $elementFullName => $dontCare) {
824 $index++;
825 $elementName = $elementCmpName = $elementFullName;
826
827 if (substr($elementCmpName, 0, 5) == 'phone') {
828 $elementCmpName = 'phone';
829 }
830
831 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
832 if ($cfID = CRM_Core_BAO_CustomField::getKeyID($elementCmpName)) {
833 $addressCustomFieldIds[$cfID][$name] = 1;
834 }
835 }
836 //add address table only once
837 if ((in_array($elementCmpName, self::$_locationSpecificFields) || !empty($addressCustomFieldIds))
838 && !$addAddress
839 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
840 ) {
841 $tName = "$name-address";
842 $aName = "`$name-address`";
843 $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
844 $this->_element["{$tName}_id"] = 1;
845 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
846 $this->_tables[$tName] = $addressJoin;
847 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
848 $processed[$aName] = 1;
849 $addAddress = TRUE;
850 }
851
852 $cond = $elementType = '';
853 if (strpos($elementName, '-') !== FALSE) {
854 // this is either phone, email or IM
855 list($elementName, $elementType) = explode('-', $elementName);
856
857
858 if (($elementName != 'phone') && ($elementName != 'im')) {
859 $cond = self::getPrimaryCondition($elementType);
860 }
861 if ((!$cond) && ($elementName == 'phone')) {
862 $cond = "phone_type_id = '$elementType'";
863 }
864 elseif ((!$cond) && ($elementName == 'im')) {
865 // IM service provider id, CRM-3140
866 $cond = "provider_id = '$elementType'";
867 }
868 $elementType = '-' . $elementType;
869 }
870
871 $field = CRM_Utils_Array::value($elementName, $this->_fields);
872
873 // hack for profile, add location id
874 if (!$field) {
875 if ($elementType &&
876 // fix for CRM-882( to handle phone types )
877 !is_numeric($elementType)
878 ) {
879 if (is_numeric($name)) {
880 $field = CRM_Utils_Array::value($elementName . "-Primary$elementType", $this->_fields);
881 }
882 else {
883 $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields);
884 }
885 }
886 elseif (is_numeric($name)) {
887 //this for phone type to work
888 if (in_array($elementName, array('phone', 'phone_ext'))) {
889 $field = CRM_Utils_Array::value($elementName . "-Primary" . $elementType, $this->_fields);
890 }
891 else {
892 $field = CRM_Utils_Array::value($elementName . "-Primary", $this->_fields);
893 }
894 }
895 else {
896 //this is for phone type to work for profile edit
897 if (in_array($elementName, array('phone', 'phone_ext'))) {
898 $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields);
899 }
900 else {
901 $field = CRM_Utils_Array::value($elementName . "-$locationTypeId", $this->_fields);
902 }
903 }
904 }
905
906 // check if there is a value, if so also add to where Clause
907 $addWhere = FALSE;
908 if ($this->_params) {
909 $nm = $elementName;
910 if (isset($locationTypeId)) {
911 $nm .= "-$locationTypeId";
912 }
913 if (!is_numeric($elementType)) {
914 $nm .= "$elementType";
915 }
916
917 foreach ($this->_params as $id => $values) {
918 if ($values[0] == $nm ||
919 (in_array($elementName, array('phone', 'im'))
920 && (strpos($values[0], $nm) !== FALSE)
921 )
922 ) {
923 $addWhere = TRUE;
924 $addWhereCount++;
925 break;
926 }
927 }
928 }
929
930 if ($field && isset($field['where'])) {
931 list($tableName, $fieldName) = explode('.', $field['where'], 2);
932 $tName = $name . '-' . substr($tableName, 8) . $elementType;
933 if (isset($tableName)) {
934 $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
935 $this->_element["{$tName}_id"] = 1;
936 if (substr($tName, -15) == '-state_province') {
937 // FIXME: hack to fix CRM-1900
938 $a = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
939 'address_format'
940 );
941
942 if (substr_count($a, 'state_province_name') > 0) {
943 $this->_select["{$name}-{$elementFullName}"] = "`$tName`.name as `{$name}-{$elementFullName}`";
944 }
945 else {
946 $this->_select["{$name}-{$elementFullName}"] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
947 }
948 }
949 else {
950 if (substr($elementFullName, 0, 2) == 'im') {
951 $provider = "{$name}-{$elementFullName}-provider_id";
952 $this->_select[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
953 $this->_element[$provider] = 1;
954 }
955
956 $this->_select["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
957 }
958
959 $this->_element["{$name}-{$elementFullName}"] = 1;
960 if (!CRM_Utils_Array::value("`$tName`", $processed)) {
961 $processed["`$tName`"] = 1;
962 $newName = $tableName . '_' . $index;
963 switch ($tableName) {
964 case 'civicrm_phone':
965 case 'civicrm_email':
966 case 'civicrm_im':
967 case 'civicrm_openid':
968
969 $this->_tables[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id AND `$tName`.$lCond";
970 // this special case to add phone type
971 if ($cond) {
972 $phoneTypeCondition = " AND `$tName`.$cond ";
973 //gross hack to pickup corrupted data also, CRM-7603
974 if (strpos($cond, 'phone_type_id') !== FALSE) {
975 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
976 }
977 $this->_tables[$tName] .= $phoneTypeCondition;
978 }
979
980 //build locationType join
981 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
982
983 if ($addWhere) {
984 $this->_whereTables[$tName] = $this->_tables[$tName];
985 }
986 break;
987
988 case 'civicrm_state_province':
989 $this->_tables[$tName] = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
990 if ($addWhere) {
991 $this->_whereTables["{$name}-address"] = $addressJoin;
992 $this->_whereTables[$tName] = $this->_tables[$tName];
993 }
994 break;
995
996 case 'civicrm_country':
997 $this->_tables[$newName] = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
998 if ($addWhere) {
999 $this->_whereTables["{$name}-address"] = $addressJoin;
1000 $this->_whereTables[$newName] = $this->_tables[$newName];
1001 }
1002 break;
1003
1004 case 'civicrm_county':
1005 $this->_tables[$newName] = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1006 if ($addWhere) {
1007 $this->_whereTables["{$name}-address"] = $addressJoin;
1008 $this->_whereTables[$newName] = $this->_tables[$newName];
1009 }
1010 break;
1011
1012 default:
1013 if ($addWhere) {
1014 $this->_whereTables["{$name}-address"] = $addressJoin;
1015 }
1016 break;
1017 }
1018 }
1019 }
1020 }
1021 }
1022
1023 // add location type join
1024 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1025 $this->_tables[$locationTypeName] = $ltypeJoin;
1026
1027 // table should be present in $this->_whereTables,
1028 // to add its condition in location type join, CRM-3939.
1029 if ($addWhereCount) {
1030 $locClause = array();
1031 foreach ($this->_whereTables as $tableName => $clause) {
1032 if (CRM_Utils_Array::value($tableName, $locationTypeJoin)) {
1033 $locClause[] = $locationTypeJoin[$tableName];
1034 }
1035 }
1036
1037 if (!empty($locClause)) {
1038 $this->_whereTables[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1039 }
1040 }
1041 }
1042
1043 if (!empty($addressCustomFieldIds)) {
1044 $cfIDs = $addressCustomFieldIds;
1045 $customQuery = new CRM_Core_BAO_CustomQuery($cfIDs);
1046 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1047 foreach ($locTypeName as $name => $dnc) {
1048 $fieldName = "$name-custom_{$cfID}";
1049 $tName = "$name-address-custom-{$cfID}";
1050 $aName = "`$name-address-custom-{$cfID}`";
1051 $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1052 $this->_element["{$tName}_id"] = 1;
1053 $this->_select[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1054 $this->_element[$fieldName] = 1;
1055 $this->_tables[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1056 }
1057 }
1058 }
1059 }
1060
1061 /**
1062 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
1063 * the return values
1064 *
1065 * @return void
1066 * @access public
1067 */
1068 function addMultipleElements() {
1069 if (!CRM_Utils_Array::value('website', $this->_returnProperties)) {
1070 return;
1071 }
1072 if (!is_array($this->_returnProperties['website'])) {
1073 return;
1074 }
1075
1076 foreach ($this->_returnProperties['website'] as $key => $elements) {
1077 foreach ($elements as $elementFullName => $dontCare) {
1078 $tName = "website-{$key}-{$elementFullName}";
1079 $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1080 $this->_select["{$tName}"] = "`$tName`.url as `{$tName}`";
1081 $this->_element["{$tName}_id"] = 1;
1082 $this->_element["{$tName}"] = 1;
1083
1084 $type = "website-{$key}-website_type_id";
1085 $this->_select[$type] = "`$tName`.website_type_id as `{$type}`";
1086 $this->_element[$type] = 1;
1087 $this->_tables[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id )";
1088 }
1089 }
1090 }
1091
1092 /**
1093 * generate the query based on what type of query we need
1094 *
1095 * @param boolean $count
1096 * @param boolean $sortByChar
1097 * @param boolean $groupContacts
1098 *
1099 * @return the sql string for that query (this will most likely
1100 * change soon)
1101 * @access public
1102 */
1103 function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) {
1104 if ($count) {
1105 if (isset($this->_distinctComponentClause)) {
1106 // we add distinct to get the right count for components
1107 // for the more complex result set, we use GROUP BY the same id
1108 // CRM-9630
1109 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1110 }
1111 else {
1112 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1113 }
1114 $from = $this->_simpleFromClause;
1115 if ($this->_useDistinct) {
1116 $this->_useGroupBy = TRUE;
1117 }
1118 }
1119 elseif ($sortByChar) {
1120 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1121 $from = $this->_simpleFromClause;
1122 }
1123 elseif ($groupContacts) {
1124 $select = 'SELECT contact_a.id as id';
1125 if ($this->_useDistinct) {
1126 $this->_useGroupBy = TRUE;
1127 }
1128 $from = $this->_simpleFromClause;
1129 }
1130 else {
1131 if (CRM_Utils_Array::value('group', $this->_paramLookup)) {
1132 // make sure there is only one element
1133 // this is used when we are running under smog and need to know
1134 // how the contact was added (CRM-1203)
1135 if ((count($this->_paramLookup['group']) == 1) &&
1136 (count($this->_paramLookup['group'][0][2]) == 1)
1137 ) {
1138 $groups = array_keys($this->_paramLookup['group'][0][2]);
1139 $groupId = $groups[0];
1140
1141 //check if group is saved search
1142 $group = new CRM_Contact_BAO_Group();
1143 $group->id = $groupId;
1144 $group->find(TRUE);
1145
1146 if (!isset($group->saved_search_id)) {
1147 $tbName = "`civicrm_group_contact-{$groupId}`";
1148 $this->_select['group_contact_id'] = "$tbName.id as group_contact_id";
1149 $this->_element['group_contact_id'] = 1;
1150 $this->_select['status'] = "$tbName.status as status";
1151 $this->_element['status'] = 1;
1152 $this->_tables[$tbName] = 1;
1153 }
1154 }
1155 $this->_useGroupBy = TRUE;
1156 }
1157 if ($this->_useDistinct && !isset($this->_distinctComponentClause)) {
1158 if (!($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY)) {
1159 // CRM-5954
1160 $this->_select['contact_id'] = 'contact_a.id as contact_id';
1161 $this->_useDistinct = FALSE;
1162 $this->_useGroupBy = TRUE;
1163 }
1164 }
1165
1166 $select = "SELECT ";
1167 if (isset($this->_distinctComponentClause)) {
1168 $select .= "{$this->_distinctComponentClause}, ";
1169 }
1170 $select .= implode(', ', $this->_select);
1171 $from = $this->_fromClause;
1172 }
1173
1174 $where = '';
1175 if (!empty($this->_whereClause)) {
1176 $where = "WHERE {$this->_whereClause}";
1177 }
1178
1179 $having = '';
1180 if (!empty($this->_having)) {
1181 foreach ($this->_having as $havingsets) {
1182 foreach ($havingsets as $havingset) {
1183 $havingvalue[] = $havingset;
1184 }
1185 }
1186 $having = ' HAVING ' . implode(' AND ', $havingvalue);
1187 }
1188
1189 // if we are doing a transform, do it here
1190 // use the $from, $where and $having to get the contact ID
1191 if ($this->_displayRelationshipType) {
1192 $this->filterRelatedContacts($from, $where, $having);
1193 }
1194
1195 return array($select, $from, $where, $having);
1196 }
1197
1198 function &getWhereValues($name, $grouping) {
1199 $result = NULL;
1200 foreach ($this->_params as $id => $values) {
1201 if ($values[0] == $name && $values[3] == $grouping) {
1202 return $values;
1203 }
1204 }
1205
1206 return $result;
1207 }
1208
1209 static function fixDateValues($relative, &$from, &$to) {
1210 if ($relative) {
1211 list($from, $to) = CRM_Utils_Date::getFromTo($relative, $from, $to);
1212 }
1213 }
1214
1215 static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) {
1216 $params = array();
1217 if (empty($formValues)) {
1218 return $params;
1219 }
1220
1221 foreach ($formValues as $id => $values) {
1222 if ($id == 'privacy') {
1223 if (is_array($formValues['privacy'])) {
1224 $op = CRM_Utils_Array::value('do_not_toggle', $formValues['privacy']) ? '=' : '!=';
1225 foreach ($formValues['privacy'] as $key => $value) {
1226 if ($value) {
1227 $params[] = array($key, $op, $value, 0, 0);
1228 }
1229 }
1230 }
1231 }
1232 elseif ($id == 'email_on_hold') {
1233 if ($formValues['email_on_hold']['on_hold']) {
1234 $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1235 }
1236 }
1237 elseif (preg_match('/_date_relative$/', $id) ||
1238 $id == 'event_relative' ||
1239 $id == 'case_from_relative' ||
1240 $id == 'case_to_relative'
1241 ) {
1242 if ($id == 'event_relative') {
1243 $fromRange = 'event_start_date_low';
1244 $toRange = 'event_end_date_high';
1245 }
1246 else if ($id == 'case_from_relative') {
1247 $fromRange = 'case_from_start_date_low';
1248 $toRange = 'case_from_start_date_high';
1249 }
1250 else if ($id == 'case_to_relative') {
1251 $fromRange = 'case_to_end_date_low';
1252 $toRange = 'case_to_end_date_high';
1253 }
1254 else {
1255 $dateComponent = explode('_date_relative', $id);
1256 $fromRange = "{$dateComponent[0]}_date_low";
1257 $toRange = "{$dateComponent[0]}_date_high";
1258 }
1259
1260 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1261 CRM_Contact_BAO_Query::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1262 continue;
1263 }
1264 }
1265 else {
1266 $values = CRM_Contact_BAO_Query::fixWhereValues($id, $values, $wildcard, $useEquals);
1267
1268 if (!$values) {
1269 continue;
1270 }
1271 $params[] = $values;
1272 }
1273 }
1274 return $params;
1275 }
1276
1277 static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) {
1278 // skip a few search variables
1279 static $skipWhere = NULL;
1280 static $arrayValues = NULL;
1281 static $likeNames = NULL;
1282 $result = NULL;
1283
1284 if (CRM_Utils_System::isNull($values)) {
1285 return $result;
1286 }
1287
1288 if (!$skipWhere) {
1289 $skipWhere = array(
1290 'task', 'radio_ts', 'uf_group_id',
1291 'component_mode', 'qfKey', 'operator',
1292 'display_relationship_type',
1293 );
1294 }
1295
1296 if (in_array($id, $skipWhere) ||
1297 substr($id, 0, 4) == '_qf_' ||
1298 substr($id, 0, 7) == 'hidden_'
1299 ) {
1300 return $result;
1301 }
1302
1303 if (!$likeNames) {
1304 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1305 }
1306
1307 // email comes in via advanced search
1308 // so use wildcard always
1309 if ($id == 'email') {
1310 $wildcard = 1;
1311 }
1312
1313 if (!$useEquals && in_array($id, $likeNames)) {
1314 $result = array($id, 'LIKE', $values, 0, 1);
1315 }
1316 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1317 $result = array($id, 'LIKE', $values, 0, 0);
1318 }
1319 elseif ($id == 'group') {
1320 if (is_array($values)) {
1321 foreach ($values as $groupIds => $val) {
1322 $matches = array();
1323 if (preg_match('/-(\d+)$/', $groupIds, $matches)) {
1324 if (strlen($matches[1]) > 0) {
1325 $values[$matches[1]] = 1;
1326 unset($values[$groupIds]);
1327 }
1328 }
1329 }
1330 }
1331 else {
1332 $groupIds = explode(',', $values);
1333 unset($values);
1334 foreach ($groupIds as $groupId) {
1335 $values[$groupId] = 1;
1336 }
1337 }
1338
1339 $result = array($id, 'IN', $values, 0, 0);
1340 }
1341 elseif ($id == 'contact_tags' || $id == 'tag') {
1342 if (!is_array($values)) {
1343 $tagIds = explode(',', $values);
1344 unset($values);
1345 foreach ($tagIds as $tagId) {
1346 $values[$tagId] = 1;
1347 }
1348 }
1349 $result = array($id, 'IN', $values, 0, 0);
1350 }
1351 else {
1352 $result = array($id, '=', $values, 0, $wildcard);
1353 }
1354
1355 return $result;
1356 }
1357
1358 function whereClauseSingle(&$values) {
1359 // do not process custom fields or prefixed contact ids or component params
1360 if (CRM_Core_BAO_CustomField::getKeyID($values[0]) ||
1361 (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) ||
1362 (substr($values[0], 0, 13) == 'contribution_') ||
1363 (substr($values[0], 0, 6) == 'event_') ||
1364 (substr($values[0], 0, 12) == 'participant_') ||
1365 (substr($values[0], 0, 7) == 'member_') ||
1366 (substr($values[0], 0, 6) == 'grant_') ||
1367 (substr($values[0], 0, 7) == 'pledge_') ||
1368 (substr($values[0], 0, 5) == 'case_')
1369 ) {
1370 return;
1371 }
1372
1373 switch ($values[0]) {
1374 case 'deleted_contacts':
1375 $this->deletedContacts($values);
1376 return;
1377
1378 case 'contact_type':
1379 $this->contactType($values);
1380 return;
1381
1382 case 'contact_sub_type':
1383 $this->contactSubType($values);
1384 return;
1385
1386 case 'group':
1387 list($name, $op, $value, $grouping, $wildcard) = $values;
1388 $this->group($values);
1389 return;
1390 case 'group_type':
1391 // so we resolve this into a list of groups & proceed as if they had been
1392 // handed in
1393 list($name, $op, $value, $grouping, $wildcard) = $values;
1394 $values[0] = 'group';
1395 $values[1] = 'IN';
1396 $this->_paramLookup['group'][0][0] ='group';
1397 $this->_paramLookup['group'][0][1] = 'IN';
1398 $this->_paramLookup['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1399 $this->group($values);
1400 return;
1401 // case tag comes from find contacts
1402
1403 case 'tag_search':
1404 $this->tagSearch($values);
1405 return;
1406
1407 case 'tag':
1408 case 'contact_tags':
1409 $this->tag($values);
1410 return;
1411
1412 case 'note':
1413 case 'note_body':
1414 case 'note_subject':
1415 $this->notes($values);
1416 return;
1417
1418 case 'uf_user':
1419 $this->ufUser($values);
1420 return;
1421
1422 case 'sort_name':
1423 case 'display_name':
1424 $this->sortName($values);
1425 //force civicrm_activity_target, CRM-7812
1426 self::$_withContactActivitiesOnly = TRUE;
1427 return;
1428
1429 case 'email':
1430 $this->email($values);
1431 return;
1432
1433 case 'phone_numeric':
1434 $this->phone_numeric($values);
1435 return;
1436
1437 case 'phone_phone_type_id':
1438 case 'phone_location_type_id':
1439 $this->phone_option_group($values);
1440 return;
1441
1442 case 'street_address':
1443 $this->street_address($values);
1444 return;
1445
1446 case 'street_number':
1447 $this->street_number($values);
1448 return;
1449
1450 case 'sortByCharacter':
1451 $this->sortByCharacter($values);
1452 return;
1453
1454 case 'location_type':
1455 $this->locationType($values);
1456 return;
1457
1458 case 'county':
1459 $this->county($values);
1460 return;
1461
1462 case 'state_province':
1463 $this->stateProvince($values);
1464 return;
1465
1466 case 'country':
1467 $this->country($values, FALSE);
1468 return;
1469
1470 case 'postal_code':
1471 case 'postal_code_low':
1472 case 'postal_code_high':
1473 $this->postalCode($values);
1474 return;
1475
1476 case 'activity_date':
1477 case 'activity_date_low':
1478 case 'activity_date_high':
1479 case 'activity_role':
1480 case 'activity_status':
1481 case 'activity_subject':
1482 case 'test_activities':
1483 case 'activity_type_id':
1484 case 'activity_survey_id':
1485 case 'activity_tags':
1486 case 'activity_taglist':
1487 case 'activity_test':
1488 case 'activity_contact_name':
1489 case 'activity_campaign_id':
1490 case 'activity_engagement_level':
1491 case 'activity_id':
1492 case 'source_contact':
1493 CRM_Activity_BAO_Query::whereClauseSingle($values, $this);
1494 return;
1495
1496 case 'birth_date_low':
1497 case 'birth_date_high':
1498 case 'deceased_date_low':
1499 case 'deceased_date_high':
1500 $this->demographics($values);
1501 return;
1502
1503 case 'log_date_low':
1504 case 'log_date_high':
1505 $this->modifiedDates($values);
1506 return;
1507
1508 case 'changed_by':
1509 $this->changeLog($values);
1510 return;
1511
1512 case 'do_not_phone':
1513 case 'do_not_email':
1514 case 'do_not_mail':
1515 case 'do_not_sms':
1516 case 'do_not_trade':
1517 case 'is_opt_out':
1518 $this->privacy($values);
1519 return;
1520
1521 case 'privacy_options':
1522 $this->privacyOptions($values);
1523 return;
1524
1525 case 'privacy_operator':
1526 case 'privacy_toggle':
1527 // these are handled by privacy options
1528 return;
1529
1530 case 'preferred_communication_method':
1531 $this->preferredCommunication($values);
1532 return;
1533
1534 case 'relation_type_id':
1535 $this->relationship($values);
1536 return;
1537
1538 case 'relation_target_name':
1539 case 'relation_status':
1540 case 'relation_date_low':
1541 case 'relation_date_high':
1542 // since this case is handled with the above
1543 return;
1544
1545 case 'task_status_id':
1546 $this->task($values);
1547 return;
1548
1549 case 'task_id':
1550 // since this case is handled with the above
1551 return;
1552
1553 case 'prox_distance':
1554 CRM_Contact_BAO_ProximityQuery::process($this, $values);
1555 return;
1556
1557 case 'prox_street_address':
1558 case 'prox_city':
1559 case 'prox_postal_code':
1560 case 'prox_state_province_id':
1561 case 'prox_country_id':
1562 // handled by the proximity_distance clause
1563 return;
1564
1565 default:
1566 $this->restWhere($values);
1567 return;
1568 }
1569 }
1570
1571 /**
1572 * Given a list of conditions in params generate the required
1573 * where clause
1574 *
1575 * @return void
1576 * @access public
1577 */
1578 function whereClause() {
1579 $this->_where[0] = array();
1580 $this->_qill[0] = array();
1581
1582 $config = CRM_Core_Config::singleton();
1583
1584 $this->includeContactIds();
1585 if (!empty($this->_params)) {
1586
1587 foreach (array_keys($this->_params) as $id) {
1588 if (!CRM_Utils_Array::value(0, $this->_params[$id])) {
1589 continue;
1590 }
1591 // check for both id and contact_id
1592 if ($this->_params[$id][0] == 'id' || $this->_params[$id][0] == 'contact_id') {
a7516181
DL		 1593 if (
1594 $this->_params[$id][1] == 'IS NULL' ||
6a488035
TO		 1595 $this->_params[$id][1] == 'IS NOT NULL'
1596 ) {
1597 $this->_where[0][] = "contact_a.id {$this->_params[$id][1]}";
1598 }
a7516181
DL		 1599 elseif (is_array($this->_params[$id][2])) {
1600 $idList = implode("','", $this->_params[$id][2]);
1601 $this->_where[0][] = "contact_a.id IN ({$idList})";
1602 }
6a488035
TO		 1603 else {
1604 $this->_where[0][] = "contact_a.id {$this->_params[$id][1]} {$this->_params[$id][2]}";
1605 }
1606 }
1607 else {
1608 $this->whereClauseSingle($this->_params[$id]);
1609 }
1610 }
1611
1612 CRM_Core_Component::alterQuery($this, 'where');
1613 }
1614
1615 if ($this->_customQuery) {
1616 // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1617 // Hope it wont affect the other part of civicrm.. if it does please remove it.
1618 if (!empty($this->_customQuery->_where)) {
1619 $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where);
1620 }
1621
1622 $this->_qill = CRM_Utils_Array::crmArrayMerge($this->_qill, $this->_customQuery->_qill);
1623 }
1624
1625 $clauses = array();
1626 $andClauses = array();
1627
1628 $validClauses = 0;
1629 if (!empty($this->_where)) {
1630 foreach ($this->_where as $grouping => $values) {
1631 if ($grouping > 0 && !empty($values)) {
1632 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1633 $validClauses++;
1634 }
1635 }
1636
1637 if (!empty($this->_where[0])) {
1638 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where[0]) . ' ) ';
1639 }
1640 if (!empty($clauses)) {
1641 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1642 }
1643
1644 if ($validClauses > 1) {
1645 $this->_useDistinct = TRUE;
1646 }
1647 }
1648
1649 return implode(' AND ', $andClauses);
1650 }
1651
1652 function restWhere(&$values) {
1653 $name = CRM_Utils_Array::value(0, $values);
1654 $op = CRM_Utils_Array::value(1, $values);
1655 $value = CRM_Utils_Array::value(2, $values);
1656 $grouping = CRM_Utils_Array::value(3, $values);
1657 $wildcard = CRM_Utils_Array::value(4, $values);
1658
1659 if (isset($grouping) && !CRM_Utils_Array::value($grouping, $this->_where)) {
1660 $this->_where[$grouping] = array();
1661 }
1662
1663 $multipleFields = array('url');
1664
1665 //check if the location type exits for fields
1666 $lType = '';
1667 $locType = explode('-', $name);
1668
1669 if (!in_array($locType[0], $multipleFields)) {
1670 //add phone type if exists
1671 if (isset($locType[2]) && $locType[2]) {
1672 $locType[2] = CRM_Core_DAO::escapeString($locType[2]);
1673 }
1674 }
1675
1676 $field = CRM_Utils_Array::value($name, $this->_fields);
1677
1678 if (!$field) {
1679 $field = CRM_Utils_Array::value($locType[0], $this->_fields);
1680
1681 if (!$field) {
1682 return;
1683 }
1684 }
1685
1686 $setTables = TRUE;
1687
1688 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
1689
1690 if (substr($name, 0, 14) === 'state_province') {
1691 if (isset($locType[1]) && is_numeric($locType[1])) {
1692 $setTables = FALSE;
1693
1694 list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
1695 $this->_whereTables[$tName] = $this->_tables[$tName];
1696 $where = "`$tName`.$fldName";
1697 }
1698 else {
1699 $where = $field['where'];
1700 }
1701
1702 if (is_numeric($value)) {
1703 $where = str_replace('.name', '.id', $where);
1704 $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
1705 $states = CRM_Core_PseudoConstant::stateProvince();
1706 $value = $states[(int ) $value];
1707 }
1708 else {
1709 $wc = self::caseImportant($op) ? "LOWER($where)" : $where;
1710 $this->_where[$grouping][] = self::buildClause($wc, $op, $value, 'String');
1711 }
1712 if (!$lType) {
1713 $this->_qill[$grouping][] = ts('State') . " $op '$value'";
1714 }
1715 else {
1716 $this->_qill[$grouping][] = ts('State') . " ($lType) $op '$value'";
1717 }
1718 }
1719 elseif (substr($name, 0, 7) === 'country') {
1720 if (isset($locType[1]) && is_numeric($locType[1])) {
1721 $setTables = FALSE;
1722
1723 list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
1724 $this->_whereTables[$tName] = $this->_tables[$tName];
1725 $where = "`$tName`.$fldName";
1726 }
1727 else {
1728 $where = $field['where'];
1729 }
1730
1731 if (is_numeric($value)) {
1732 $where = str_replace('.name', '.id', $where);
1733 $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
1734 $countries = CRM_Core_PseudoConstant::country();
1735 $value = $countries[(int ) $value];
1736 }
1737 else {
1738 $wc = self::caseImportant($op) ? "LOWER($where)" : $where;
1739 $this->_where[$grouping][] = self::buildClause($wc, $op, $value, 'String');
1740 }
1741 if (!$lType) {
1742 $this->_qill[$grouping][] = ts('Country') . " $op '$value'";
1743 }
1744 else {
1745 $this->_qill[$grouping][] = ts('Country') . " ($lType) $op '$value'";
1746 }
1747 }
1748 elseif (substr($name, 0, 6) === 'county') {
1749 if (isset($locType[1]) && is_numeric($locType[1])) {
1750 $setTables = FALSE;
1751
1752 list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
1753 $this->_whereTables[$tName] = $this->_tables[$tName];
1754 $where = "`$tName`.$fldName";
1755 }
1756 else {
1757 $where = $field['where'];
1758 }
1759 if (is_numeric($value)) {
1760 $where = str_replace('.name', '.id', $where);
1761 $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
1762 $counties = CRM_Core_PseudoConstant::county();
1763 $value = $counties[(int ) $value];
1764 }
1765 else {
1766 $wc = self::caseImportant($op) ? "LOWER($where)" : $where;
1767 $this->_where[$grouping][] = self::buildClause($wc, $op, $value, 'String');
1768 }
1769
1770 if (!$lType) {
1771 $this->_qill[$grouping][] = ts('County') . " $op '$value'";
1772 }
1773 else {
1774 $this->_qill[$grouping][] = ts('County') . " ($lType) $op '$value'";
1775 }
1776 }
1777 elseif ($name === 'world_region') {
1778 $this->optionValueQuery(
1779 $name, $op, $value, $grouping,
1780 CRM_Core_PseudoConstant::worldRegion(),
1781 $field,
1782 ts('World Region')
1783 );
1784 }
1785 elseif ($name === 'individual_prefix') {
1786 $this->optionValueQuery(
1787 $name, $op, $value, $grouping,
1788 CRM_Core_PseudoConstant::individualPrefix(),
1789 $field,
1790 ts('Individual Prefix')
1791 );
1792 }
1793 elseif ($name === 'individual_suffix') {
1794 $this->optionValueQuery(
1795 $name, $op, $value, $grouping,
1796 CRM_Core_PseudoConstant::individualSuffix(),
1797 $field,
1798 ts('Individual Suffix')
1799 );
1800 }
1801 elseif ($name === 'gender') {
1802 $this->optionValueQuery(
1803 $name, $op, $value, $grouping,
1804 CRM_Core_PseudoConstant::gender(),
1805 $field,
1806 ts('Gender')
1807 );
1808 self::$_openedPanes[ts('Demographics')] = TRUE;
1809 }
1810 elseif ($name === 'birth_date') {
1811 $date = CRM_Utils_Date::processDate($value);
1812 $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $date);
1813
1814 if ($date) {
1815 $date = CRM_Utils_Date::customFormat($date);
1816 $this->_qill[$grouping][] = "$field[title] $op \"$date\"";
1817 }
1818 else {
1819 $this->_qill[$grouping][] = "$field[title] $op";
1820 }
1821 self::$_openedPanes[ts('Demographics')] = TRUE;
1822 }
1823 elseif ($name === 'deceased_date') {
1824 $date = CRM_Utils_Date::processDate($value);
1825 $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $date);
1826 if ($date) {
1827 $date = CRM_Utils_Date::customFormat($date);
1828 $this->_qill[$grouping][] = "$field[title] $op \"$date\"";
1829 }
1830 else {
1831 $this->_qill[$grouping][] = "$field[title] $op";
1832 }
1833 self::$_openedPanes[ts('Demographics')] = TRUE;
1834 }
1835 elseif ($name === 'is_deceased') {
1836 $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value);
1837 $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
1838 self::$_openedPanes[ts('Demographics')] = TRUE;
1839 }
1840 elseif ($name === 'contact_id') {
1841 if (is_int($value)) {
1842 $this->_where[$grouping][] = self::buildClause($field['where'], $op, $value);
1843 $this->_qill[$grouping][] = "$field[title] $op $value";
1844 }
1845 }
1846 elseif ($name === 'name') {
1847 $value = $strtolower(CRM_Core_DAO::escapeString($value));
1848 if ($wildcard) {
1849 $value = "%$value%";
1850 $op = 'LIKE';
1851 }
1852 $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
1853 $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'");
1854 $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
1855 }
1856 elseif ($name === 'current_employer') {
1857 $value = $strtolower(CRM_Core_DAO::escapeString($value));
1858 if ($wildcard) {
1859 $value = "%$value%";
1860 $op = 'LIKE';
1861 }
1862 $wc = self::caseImportant($op) ? "LOWER(contact_a.organization_name)" : "contact_a.organization_name";
1863 $this->_where[$grouping][] = self::buildClause($wc, $op,
1864 "'$value' AND contact_a.contact_type ='Individual'"
1865 );
1866 $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
1867 }
1868 elseif ($name === 'email_greeting') {
1869 $filterCondition = array('greeting_type' => 'email_greeting');
1870 $this->optionValueQuery(
1871 $name, $op, $value, $grouping,
1872 CRM_Core_PseudoConstant::greeting($filterCondition),
1873 $field,
1874 ts('Email Greeting')
1875 );
1876 }
1877 elseif ($name === 'postal_greeting') {
1878 $filterCondition = array('greeting_type' => 'postal_greeting');
1879 $this->optionValueQuery(
1880 $name, $op, $value, $grouping,
1881 CRM_Core_PseudoConstant::greeting($filterCondition),
1882 $field,
1883 ts('Postal Greeting')
1884 );
1885 }
1886 elseif ($name === 'addressee') {
1887 $filterCondition = array('greeting_type' => 'addressee');
1888 $this->optionValueQuery(
1889 $name, $op, $value, $grouping,
1890 CRM_Core_PseudoConstant::greeting($filterCondition),
1891 $field,
1892 ts('Addressee')
1893 );
1894 }
1895 elseif (substr($name, 0, 4) === 'url-') {
1896 $tName = 'civicrm_website';
1897 $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
1898 $value = $strtolower(CRM_Core_DAO::escapeString($value));
1899 if ($wildcard) {
1900 $value = "%$value%";
1901 $op = 'LIKE';
1902 }
1903
1904 $wc = 'civicrm_website.url';
1905 $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'");
1906 $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
1907 }
1908 elseif ($name === 'contact_is_deleted') {
1909 $this->_where[$grouping][] = self::buildClause("contact_a.is_deleted", $op, $value);
1910 $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
1911 }
1912 else {
1913 // sometime the value is an array, need to investigate and fix
1914 if (is_array($value)) {
1915 CRM_Core_Error::fatal();
1916 }
1917
1918 if (!empty($field['where'])) {
1919 if ($op != 'IN') {
1920 $value = $strtolower($value);
1921 }
1922 if ($wildcard) {
1923 $value = "%$value%";
1924 $op = 'LIKE';
1925 }
1926
1927 if (isset($locType[1]) &&
1928 is_numeric($locType[1])
1929 ) {
1930 $setTables = FALSE;
1931
1932 //get the location name
1933 $locationType = CRM_Core_PseudoConstant::locationType();
1934 list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
1935
1936 $where = "`$tName`.$fldName";
1937
1938 $this->_where[$grouping][] = self::buildClause("LOWER($where)", $op, $value);
1939 $this->_whereTables[$tName] = $this->_tables[$tName];
1940 $this->_qill[$grouping][] = "$field[title] $op '$value'";
1941 }
1942 else {
1943 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1944 if ($tableName == 'civicrm_contact') {
1945 $fieldName = "LOWER(contact_a.{$fieldName})";
1946 }
1947 else {
1948 if ($op != 'IN' && !is_numeric($value)) {
1949 $fieldName = "LOWER({$field['where']})";
1950 }
1951 else {
1952 $fieldName = "{$field['where']}";
1953 }
1954 }
1955
1956 $type = NULL;
1957 if (CRM_Utils_Array::value('type', $field)) {
1958 $type = CRM_Utils_Type::typeToString($field['type']);
1959 }
1960
1961 $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type);
1962 $this->_qill[$grouping][] = "$field[title] $op $value";
1963 }
1964 }
1965 }
1966
1967 if ($setTables && isset($field['where'])) {
1968 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1969 if (isset($tableName)) {
1970 $this->_tables[$tableName] = 1;
1971 $this->_whereTables[$tableName] = 1;
1972 }
1973 }
1974 }
1975
1976
1977 static function getLocationTableName(&$where, &$locType) {
1978 if (isset($locType[1]) && is_numeric($locType[1])) {
1979 list($tbName, $fldName) = explode(".", $where);
1980
1981 //get the location name
1982 $locationType = CRM_Core_PseudoConstant::locationType();
1983 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
1984 if (in_array($locType[0], $specialFields)) {
1985 //hack to fix / special handing for phone_ext
1986 if ($locType[0] == 'phone_ext') {
1987 $locType[0] = 'phone';
1988 }
1989 if (isset($locType[2]) && $locType[2]) {
1990 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
1991 }
1992 else {
1993 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
1994 }
1995 }
1996 elseif (in_array($locType[0],
1997 array(
1998 'address_name', 'street_address', 'supplemental_address_1', 'supplemental_address_2',
1999 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2',
2000 )
2001 )) {
2002 //fix for search by profile with address fields.
2003 $tName = "{$locationType[$locType[1]]}-address";
2004 }
2005 elseif ($locType[0] == 'on_hold') {
2006 $tName = "{$locationType[$locType[1]]}-email";
2007 }
2008 else {
2009 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2010 }
2011 $tName = str_replace(' ', '_', $tName);
2012 return array($tName, $fldName);
2013 }
2014 CRM_Core_Error::fatal();
2015 }
2016
2017 /**
2018 * Given a result dao, extract the values and return that array
2019 *
2020 * @param Object $dao
2021 *
2022 * @return array values for this query
2023 */
2024 function store($dao) {
2025 $value = array();
2026
2027 foreach ($this->_element as $key => $dontCare) {
2028 if (property_exists($dao, $key)) {
2029 if (strpos($key, '-') !== FALSE) {
2030 $values = explode('-', $key);
2031 $lastElement = array_pop($values);
2032 $current = &$value;
2033 $cnt = count($values);
2034 $count = 1;
2035 foreach ($values as $v) {
2036 if (!array_key_exists($v, $current)) {
2037 $current[$v] = array();
2038 }
2039 //bad hack for im_provider
2040 if ($lastElement == 'provider_id') {
2041 if ($count < $cnt) {
2042 $current = &$current[$v];
2043 }
2044 else {
2045 $lastElement = "{$v}_{$lastElement}";
2046 }
2047 }
2048 else {
2049 $current = &$current[$v];
2050 }
2051 $count++;
2052 }
2053
2054 $current[$lastElement] = $dao->$key;
2055 }
2056 else {
2057 $value[$key] = $dao->$key;
2058 }
2059 }
2060 }
2061 return $value;
2062 }
2063
2064 /**
2065 * getter for tables array
2066 *
2067 * @return array
2068 * @access public
2069 */
2070 function tables() {
2071 return $this->_tables;
2072 }
2073
2074 function whereTables() {
2075 return $this->_whereTables;
2076 }
2077
2078 /**
2079 * generate the where clause (used in match contacts and permissions)
2080 *
2081 * @param array $params
2082 * @param array $fields
2083 * @param array $tables
2084 * @param boolean $strict
2085 *
2086 * @return string
2087 * @access public
2088 * @static
2089 */
2090 static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2091 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2092 FALSE, $strict
2093 );
2094
2095 $tables = array_merge($query->tables(), $tables);
2096 $whereTables = array_merge($query->whereTables(), $whereTables);
2097
2098 return $query->_whereClause;
2099 }
2100
2101 /**
2102 * create the from clause
2103 *
2104 * @param array $tables tables that need to be included in this from clause
2105 * if null, return mimimal from clause (i.e. civicrm_contact)
2106 * @param array $inner tables that should be inner-joined
2107 * @param array $right tables that should be right-joined
2108 *
2109 * @return string the from clause
2110 * @access public
2111 * @static
2112 */
2113 static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2114
2115 $from = ' FROM civicrm_contact contact_a';
2116 if (empty($tables)) {
2117 return $from;
2118 }
2119
2120 if (CRM_Utils_Array::value('civicrm_worldregion', $tables)) {
2121 $tables = array_merge(array('civicrm_country' => 1), $tables);
2122 }
2123
2124 if ((CRM_Utils_Array::value('civicrm_state_province', $tables) ||
2125 CRM_Utils_Array::value('civicrm_country', $tables) ||
2126 CRM_Utils_Array::value('civicrm_county', $tables)
2127 ) &&
2128 !CRM_Utils_Array::value('civicrm_address', $tables)
2129 ) {
2130 $tables = array_merge(array('civicrm_address' => 1),
2131 $tables
2132 );
2133 }
2134
2135 // add group_contact table if group table is present
2136 if (CRM_Utils_Array::value('civicrm_group', $tables) &&
2137 !CRM_Utils_Array::value('civicrm_group_contact', $tables)
2138 ) {
2139 $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'";
2140 }
2141
2142 // add group_contact and group table is subscription history is present
2143 if (CRM_Utils_Array::value('civicrm_subscription_history', $tables)
2144 && !CRM_Utils_Array::value('civicrm_group', $tables)
2145 ) {
2146 $tables = array_merge(array(
2147 'civicrm_group' => 1,
2148 'civicrm_group_contact' => 1,
2149 ),
2150 $tables
2151 );
2152 }
2153
2154 // to handle table dependencies of components
2155 CRM_Core_Component::tableNames($tables);
2156
2157 //format the table list according to the weight
2158 $info = CRM_Core_TableHierarchy::info();
2159
2160 foreach ($tables as $key => $value) {
2161 $k = 99;
2162 if (strpos($key, '-') !== FALSE) {
2163 $keyArray = explode('-', $key);
2164 $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99);
2165 }
2166 elseif (strpos($key, '_') !== FALSE) {
2167 $keyArray = explode('_', $key);
2168 if (is_numeric(array_pop($keyArray))) {
2169 $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99);
2170 }
2171 else {
2172 $k = CRM_Utils_Array::value($key, $info, 99);
2173 }
2174 }
2175 else {
2176 $k = CRM_Utils_Array::value($key, $info, 99);
2177 }
2178 $tempTable[$k . ".$key"] = $key;
2179 }
2180 ksort($tempTable);
2181 $newTables = array();
2182 foreach ($tempTable as $key) {
2183 $newTables[$key] = $tables[$key];
2184 }
2185
2186 $tables = $newTables;
2187
2188 foreach ($tables as $name => $value) {
2189 if (!$value) {
2190 continue;
2191 }
2192
2193 if (CRM_Utils_Array::value($name, $inner)) {
2194 $side = 'INNER';
2195 }
2196 elseif (CRM_Utils_Array::value($name, $right)) {
2197 $side = 'RIGHT';
2198 }
2199 else {
2200 $side = 'LEFT';
2201 }
2202
2203 if ($value != 1) {
2204 // if there is already a join statement in value, use value itself
2205 if (strpos($value, 'JOIN')) {
2206 $from .= " $value ";
2207 }
2208 else {
2209 $from .= " $side JOIN $name ON ( $value ) ";
2210 }
2211 continue;
2212 }
2213 switch ($name) {
2214 case 'civicrm_address':
2215 if ($primaryLocation) {
2216 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2217 }
2218 else {
2219 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2220 }
2221 continue;
2222
2223 case 'civicrm_phone':
2224 $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2225 continue;
2226
2227 case 'civicrm_email':
2228 $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2229 continue;
2230
2231 case 'civicrm_im':
2232 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2233 continue;
2234
2235 case 'im_provider':
2236 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2237 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2238 $from .= " $side JOIN civicrm_option_value im_provider ON (civicrm_im.provider_id = im_provider.value AND option_group_imProvider.id = im_provider.option_group_id)";
2239 continue;
2240
2241 case 'civicrm_openid':
2242 $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2243 continue;
2244
2245 case 'civicrm_state_province':
2246 $from .= " $side JOIN civicrm_state_province ON civicrm_address.state_province_id = civicrm_state_province.id ";
2247 continue;
2248
2249 case 'civicrm_country':
2250 $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2251 continue;
2252
2253 case 'civicrm_worldregion':
2254 $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2255 continue;
2256
2257 case 'civicrm_county':
2258 $from .= " $side JOIN civicrm_county ON civicrm_address.county_id = civicrm_county.id ";
2259 continue;
2260
2261 case 'civicrm_location_type':
2262 $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2263 continue;
2264
2265 case 'civicrm_group':
2266 $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2267 continue;
2268
2269 case 'civicrm_group_contact':
2270 $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2271 continue;
2272
2273 case 'civicrm_activity':
2274 case 'civicrm_activity_tag':
2275 case 'activity_type':
2276 case 'activity_status':
2277 case 'civicrm_activity_contact':
2278 case 'source_contact':
2279 $from .= CRM_Activity_BAO_Query::from($name, $mode, $side);
2280 continue;
2281
2282 case 'civicrm_entity_tag':
2283 $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2284 civicrm_entity_tag.entity_id = contact_a.id ) ";
2285 continue;
2286
2287 case 'civicrm_note':
2288 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2289 contact_a.id = civicrm_note.entity_id ) ";
2290 continue;
2291
2292 case 'civicrm_subscription_history':
2293 $from .= " $side JOIN civicrm_subscription_history
2294 ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2295 AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2296 continue;
2297
2298 case 'individual_prefix':
2299 $from .= " $side JOIN civicrm_option_group option_group_prefix ON (option_group_prefix.name = 'individual_prefix')";
2300 $from .= " $side JOIN civicrm_option_value individual_prefix ON (contact_a.prefix_id = individual_prefix.value AND option_group_prefix.id = individual_prefix.option_group_id ) ";
2301 continue;
2302
2303 case 'individual_suffix':
2304 $from .= " $side JOIN civicrm_option_group option_group_suffix ON (option_group_suffix.name = 'individual_suffix')";
2305 $from .= " $side JOIN civicrm_option_value individual_suffix ON (contact_a.suffix_id = individual_suffix.value AND option_group_suffix.id = individual_suffix.option_group_id ) ";
2306 continue;
2307
2308 case 'gender':
2309 $from .= " $side JOIN civicrm_option_group option_group_gender ON (option_group_gender.name = 'gender')";
2310 $from .= " $side JOIN civicrm_option_value gender ON (contact_a.gender_id = gender.value AND option_group_gender.id = gender.option_group_id) ";
2311 continue;
2312
2313 case 'civicrm_relationship':
2314 if (self::$_relType == 'reciprocal') {
2315 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2316 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id OR civicrm_relationship.contact_id_b = contact_b.id)";
2317 }
2318 elseif (self::$_relType == 'b') {
2319 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2320 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2321 }
2322 else {
2323 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2324 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2325 }
2326 continue;
2327
2328 case 'civicrm_log':
2329 $from .= " $side JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2330 $from .= " $side JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2331 continue;
2332
2333 case 'civicrm_tag':
2334 $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2335 continue;
2336
2337 case 'civicrm_task_status':
2338 $from .= " $side JOIN civicrm_task_status ON ( civicrm_task_status.responsible_entity_table = 'civicrm_contact'
2339 AND contact_a.id = civicrm_task_status.responsible_entity_id )";
2340 continue;
2341
2342 case 'civicrm_grant':
2343 $from .= CRM_Grant_BAO_Query::from($name, $mode, $side);
2344 continue;
2345
2346 //build fromClause for email greeting, postal greeting, addressee CRM-4575
2347
2348 case 'email_greeting':
2349 $from .= " $side JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
2350 $from .= " $side JOIN civicrm_option_value email_greeting ON (contact_a.email_greeting_id = email_greeting.value AND option_group_email_greeting.id = email_greeting.option_group_id ) ";
2351 continue;
2352
2353 case 'postal_greeting':
2354 $from .= " $side JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
2355 $from .= " $side JOIN civicrm_option_value postal_greeting ON (contact_a.postal_greeting_id = postal_greeting.value AND option_group_postal_greeting.id = postal_greeting.option_group_id ) ";
2356 continue;
2357
2358 case 'addressee':
2359 $from .= " $side JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
2360 $from .= " $side JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
2361 continue;
2362
2363 case 'civicrm_website':
2364 $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2365 continue;
2366
2367 default:
2368 $from .= CRM_Core_Component::from($name, $mode, $side);
2369 continue;
2370 }
2371 }
2372
2373 return $from;
2374 }
2375
2376 /**
2377 * WHERE / QILL clause for deleted_contacts
2378 *
2379 * @return void
2380 */
2381 function deletedContacts($values) {
2382 list($_, $_, $value, $grouping, $_) = $values;
2383 if ($value) {
2384 // *prepend* to the relevant grouping as this is quite an important factor
2385 array_unshift($this->_qill[$grouping], ts('Search in Trash'));
2386 }
2387 }
2388
2389 /**
2390 * where / qill clause for contact_type
2391 *
2392 * @return void
2393 * @access public
2394 */
2395 function contactType(&$values) {
2396 list($name, $op, $value, $grouping, $wildcard) = $values;
2397
2398 $subTypes = array();
2399 $clause = array();
2400
2401 // account for search builder mapping multiple values
2402 if (!is_array($value)) {
2403 $values = self::parseSearchBuilderString($value, 'String');
2404 if (is_array($values)) {
2405 $value = array_flip($values);
2406 }
2407 }
2408
2409 if (is_array($value)) {
2410 foreach ($value as $k => $v) {
2411 // fix for CRM-771
2412 if ($k) {
2413 $subType = NULL;
2414 $contactType = $k;
2415 if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) {
2416 list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2);
2417 }
2418
2419 if (!empty($subType)) {
2420 $subTypes[$subType] = 1;
2421 }
2422 $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2423 }
2424 }
2425 }
2426 else {
2427 $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2);
2428 $contactType = $contactTypeANDSubType[0];
2429 $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType);
2430 if (!empty($subType)) {
2431 $subTypes[$subType] = 1;
2432 }
2433 $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2434 }
2435
2436 // fix for CRM-771
2437 if (!empty($clause)) {
2438 $this->_where[$grouping][] = 'contact_a.contact_type IN (' . implode(',', $clause) . ')';
2439 $this->_qill[$grouping][] = ts('Contact Type') . ' - ' . implode(' ' . ts('or') . ' ', $clause);
2440
2441 if (!empty($subTypes)) {
2442 $this->includeContactSubTypes($subTypes, $grouping);
2443 }
2444 }
2445 }
2446
2447 /**
2448 * where / qill clause for contact_sub_type
2449 *
2450 * @return void
2451 * @access public
2452 */
2453 function contactSubType(&$values) {
2454 list($name, $op, $value, $grouping, $wildcard) = $values;
2455 $this->includeContactSubTypes($value, $grouping);
2456 }
2457
2458 function includeContactSubTypes($value, $grouping) {
2459
2460 $clause = array();
2461 $alias = "contact_a.contact_sub_type";
2462
2463 if (is_array($value)) {
2464 foreach ($value as $k => $v) {
2465 if (!empty($k)) {
2466 $clause[$k] = "($alias like '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($k, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2467 }
2468 }
2469 }
2470 else {
2471 $clause[$value] = "($alias like '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2472 }
2473
2474 if (!empty($clause)) {
2475 $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2476 $this->_qill[$grouping][] = ts('Contact Subtype') . ' - ' . implode(' ' . ts('or') . ' ', array_keys($clause));
2477 }
2478 }
2479
2480 /**
2481 * where / qill clause for groups
2482 *
2483 * @return void
2484 * @access public
2485 */
2486 function group(&$values) {
2487 list($name, $op, $value, $grouping, $wildcard) = $values;
2488
2489 if (count($value) > 1) {
2490 $this->_useDistinct = TRUE;
2491 }
2492
2493 $groupNames = CRM_Core_PseudoConstant::group();
2494 $groupIds = implode(',', array_keys($value));
2495
2496 $names = array();
2497 foreach ($value as $id => $dontCare) {
2498 if (array_key_exists($id, $groupNames) && $dontCare) {
2499 $names[] = $groupNames[$id];
2500 }
2501 }
2502
2503 $statii = array();
2504 $in = FALSE;
2505 $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2506 if ($gcsValues &&
2507 is_array($gcsValues[2])
2508 ) {
2509 foreach ($gcsValues[2] as $k => $v) {
2510 if ($v) {
2511 if ($k == 'Added') {
2512 $in = TRUE;
2513 }
2514 $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
2515 }
2516 }
2517 }
2518 else {
2519 $statii[] = '"Added"';
2520 $in = TRUE;
2521 }
2522
2523 $skipGroup = FALSE;
2524 if (count($value) == 1 &&
2525 count($statii) == 1 &&
2526 $statii[0] == '"Added"'
2527 ) {
2528 // check if smart group, if so we can get rid of that one additional
2529 // left join
2530 $groupIDs = array_keys($value);
2531
2532 if (CRM_Utils_Array::value(0, $groupIDs) &&
2533 CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group',
2534 $groupIDs[0],
2535 'saved_search_id'
2536 )
2537 ) {
2538 $skipGroup = TRUE;
2539 }
2540 }
2541
2542 if (!$skipGroup) {
2543 $gcTable = "`civicrm_group_contact-{$groupIds}`";
2544 $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON contact_a.id = {$gcTable}.contact_id ";
2545 }
2546
2547 $qill = ts('Contacts %1', array(1 => $op));
2548 $qill .= ' ' . implode(' ' . ts('or') . ' ', $names);
2549
2550 $groupClause = NULL;
2551
2552 if (!$skipGroup) {
2553 $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2554 if (!empty($statii)) {
2555 $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")";
2556 $qill .= " " . ts('AND') . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii);
2557 }
2558 }
2559
2560 if ($in) {
2561 $ssClause = $this->savedSearch($values);
2562 if ($ssClause) {
2563 if ($groupClause) {
2564 $groupClause = "( ( $groupClause ) OR ( $ssClause ) )";
2565 }
2566 else {
2567 $groupClause = $ssClause;
2568 }
2569 }
2570 }
2571
2572 $this->_where[$grouping][] = $groupClause;
2573 $this->_qill[$grouping][] = $qill;
2574 }
2575 /*
2576 * Function translates selection of group type into a list of groups
2577 */
2578 function getGroupsFromTypeCriteria($value){
2579 $groupIds = array();
2580 foreach ($value as $groupTypeValue) {
2581 $groupList = CRM_Core_PseudoConstant::group($groupTypeValue);
2582 $groupIds = ($groupIds + $groupList);
2583 }
2584 return $groupIds;
2585 }
2586
2587 /**
2588 * where / qill clause for smart groups
2589 *
2590 * @return void
2591 * @access public
2592 */
2593 function savedSearch(&$values) {
2594 list($name, $op, $value, $grouping, $wildcard) = $values;
2595 return $this->addGroupContactCache(array_keys($value));
2596 }
2597
2598 function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") {
2599 $config = CRM_Core_Config::singleton();
2600
2601 // find all the groups that are part of a saved search
2602 $groupIDs = implode(',', $groups);
2603 if (empty($groupIDs)) {
2604 return NULL;
2605 }
2606
2607 $sql = "
2608SELECT id, cache_date, saved_search_id, children
2609FROM civicrm_group
2610WHERE id IN ( $groupIDs )
2611 AND ( saved_search_id != 0
2612 OR saved_search_id IS NOT NULL
2613 OR children IS NOT NULL )
2614";
2615 $group = CRM_Core_DAO::executeQuery($sql);
2616 $ssWhere = array();
2617 while ($group->fetch()) {
2618 if ($tableAlias == NULL) {
2619 $alias = "`civicrm_group_contact_cache_{$group->id}`";
2620 }
2621 else {
2622 $alias = $tableAlias;
2623 }
2624
2625 $this->_useDistinct = TRUE;
2626
2627 if (!$this->_smartGroupCache || $group->cache_date == NULL) {
2628 CRM_Contact_BAO_GroupContactCache::load($group);
2629 }
2630
2631 $this->_tables[$alias] = $this->_whereTables[$alias] = " LEFT JOIN civicrm_group_contact_cache {$alias} ON {$joinTable}.id = {$alias}.contact_id ";
2632 $ssWhere[] = "{$alias}.group_id = {$group->id}";
2633 }
2634
2635 if (!empty($ssWhere)) {
2636 return implode(' OR ', $ssWhere);
2637 }
2638 return NULL;
2639 }
2640
2641 /**
2642 * where / qill clause for cms users
2643 *
2644 * @return void
2645 * @access public
2646 */
2647 function ufUser(&$values) {
2648 list($name, $op, $value, $grouping, $wildcard) = $values;
2649
2650 if ($value == 1) {
2651 $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2652
2653 $this->_qill[$grouping][] = ts('CMS User');
2654 }
2655 elseif ($value == 0) {
2656 $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2657
2658 $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2659 $this->_qill[$grouping][] = ts('Not a CMS User');
2660 }
2661 }
2662
2663 /**
2664 * all tag search specific
2665 *
2666 * @return void
2667 * @access public
2668 */
2669 function tagSearch(&$values) {
2670 list($name, $op, $value, $grouping, $wildcard) = $values;
2671
2672 $op = "LIKE";
2673 $value = "%{$value}%";
2674
2675
2676 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2677 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2678
2679 $etTable = "`civicrm_entity_tag-" . $value . "`";
2680 $tTable = "`civicrm_tag-" . $value . "`";
2681
2682 if ($useAllTagTypes[2]) {
2683 $this->_tables[$etTable] =
2684 $this->_whereTables[$etTable] =
2685 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2686 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
2687
2688 // search tag in cases
2689 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2690 $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2691 $this->_tables[$etCaseTable] =
2692 $this->_whereTables[$etCaseTable] =
2693 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2694 LEFT JOIN civicrm_case
2695 ON (civicrm_case_contact.case_id = civicrm_case.id
2696 AND civicrm_case.is_deleted = 0 )
2697 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2698 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
2699 // search tag in activities
2700 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2701 $tActTable = "`civicrm_act_tag-" . $value . "`";
2702 $this->_tables[$etActTable] =
2703 $this->_whereTables[$etActTable] =
2704 " LEFT JOIN civicrm_activity_target
2705 ON ( civicrm_activity_target.target_contact_id = contact_a.id )
2706 LEFT JOIN civicrm_activity
2707 ON ( civicrm_activity.id = civicrm_activity_target.activity_id
2708 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2709 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
2710 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
2711
2712 $this->_where[$grouping][] = "({$tTable}.name $op '". $value . "' OR {$tCaseTable}.name $op '". $value . "' OR {$tActTable}.name $op '". $value . "')";
2713 $this->_qill[$grouping][] = ts('Tag '.$tagTypesText[2].' %1 ', array( 1 => $op)) . ' ' . $value;
2714 } else {
2715 $etTable = "`civicrm_entity_tag-" . $value . "`";
2716 $tTable = "`civicrm_tag-" . $value . "`";
2717 $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
2718 {$etTable}.entity_table = 'civicrm_contact' )
2719 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
2720
2721 $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String');
2722 $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
2723 }
2724 }
2725
2726 /**
2727 * where / qill clause for tag
2728 *
2729 * @return void
2730 * @access public
2731 */
2732 function tag(&$values) {
2733 list($name, $op, $value, $grouping, $wildcard) = $values;
2734
2735 $tagNames = CRM_Core_PseudoConstant::tag();
2736 if (is_array($value)) {
2737 if (count($value) > 1) {
2738 $this->_useDistinct = TRUE;
2739 }
2740 foreach ($value as $id => $dontCare) {
2741 $names[] = CRM_Utils_Array::value($id, $tagNames);
2742 }
2743 $names = implode(' ' . ts('or') . ' ', $names);
2744 $value = implode(',', array_keys($value));
2745 }
2746 else {
2747 $names = CRM_Utils_Array::value($value, $tagNames);
2748 }
2749
2750
2751 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2752 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2753
2754 $etTable = "`civicrm_entity_tag-" . $value . "`";
2755
2756 if ($useAllTagTypes[2]) {
2757 $this->_tables[$etTable] =
2758 $this->_whereTables[$etTable] =
2759 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2760
2761 // search tag in cases
2762 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2763 $this->_tables[$etCaseTable] =
2764 $this->_whereTables[$etCaseTable] =
2765 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2766 LEFT JOIN civicrm_case
2767 ON (civicrm_case_contact.case_id = civicrm_case.id
2768 AND civicrm_case.is_deleted = 0 )
2769 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
2770 // search tag in activities
2771 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2772 $this->_tables[$etActTable] =
2773 $this->_whereTables[$etActTable] =
2774 " LEFT JOIN civicrm_activity_target
2775 ON ( civicrm_activity_target.target_contact_id = contact_a.id )
2776 LEFT JOIN civicrm_activity
2777 ON ( civicrm_activity.id = civicrm_activity_target.activity_id
2778 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2779 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
2780
2781 // CRM-10338
2782 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2783 $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
2784 }
2785 else {
2786 $this->_where[$grouping][] = "({$etTable}.tag_id $op (". $value . ") OR {$etCaseTable}.tag_id $op (". $value . ") OR {$etActTable}.tag_id $op (". $value . "))";
2787 }
2788 $this->_qill[$grouping][] = ts('Tag %1 '.$tagTypesText[2], array( 1 => $op)) . ' ' . $names;
2789 } else {
2790 $this->_tables[$etTable] =
2791 $this->_whereTables[$etTable] =
2792 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2793
2794 // CRM-10338
2795 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2796 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
2797 $op = str_replace('EMPTY', 'NULL', $op);
2798 $this->_where[$grouping][] = "{$etTable}.tag_id $op";
2799 }
2800 else {
2801 $this->_where[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
2802 }
2803 $this->_qill[$grouping][] = ts('Tagged %1', array( 1 => $op)) . ' ' . $names;
2804 }
2805
2806 }
2807
2808 /**
2809 * where/qill clause for notes
2810 *
2811 * @return void
2812 * @access public
2813 */
2814 function notes(&$values) {
2815 list($name, $op, $value, $grouping, $wildcard) = $values;
2816
2817 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
2818 $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6');
2819 $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption);
2820
2821 $this->_useDistinct = TRUE;
2822
2823 $this->_tables['civicrm_note'] =
2824 $this->_whereTables['civicrm_note'] =
2825 " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
2826
2827 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2828 $n = trim($value);
2829 $value = $strtolower(CRM_Core_DAO::escapeString($n));
2830 if ($wildcard || $op == 'LIKE') {
2831 if (strpos($value, '%') === FALSE) {
2832 $value = "%$value%";
2833 }
2834 $op = 'LIKE';
2835 }
2836 elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') {
2837 $value = NULL;
2838 }
2839
2840 $label = NULL;
2841 $clauses = array();
2842 if ( $noteOption % 2 == 0 ) {
2843 $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String');
2844 $label = ts('Note: Body Only');
2845 }
2846 if ( $noteOption % 3 == 0 ) {
2847 $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String');
2848 $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only');
2849 }
2850 $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
2851 $this->_qill[$grouping][] = $label . " $op - '$n'";
2852 }
2853
2854 function nameNullOrEmptyOp($name, $op, $grouping) {
2855 switch ( $op ) {
2856 case 'IS NULL':
2857 case 'IS NOT NULL':
2858 $this->_where[$grouping][] = "contact_a.$name $op";
2859 $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
2860 return true;
2861
2862 case 'IS EMPTY':
2863 $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
2864 $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
2865 return true;
2866
2867 case 'IS NOT EMPTY':
2868 $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
2869 $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
2870 return true;
2871
2872 default:
2873 return false;
2874 }
2875 }
2876
2877 /**
2878 * where / qill clause for sort_name
2879 *
2880 * @return void
2881 * @access public
2882 */
2883 function sortName(&$values) {
2884 list($name, $op, $value, $grouping, $wildcard) = $values;
2885
2886 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
2887 if ( $this->nameNullOrEmptyOp( $name, $op, $grouping ) ) {
2888 return;
2889 }
2890
2891 $newName = $name;
2892 $name = trim($value);
2893
2894 if (empty($name)) {
2895 return;
2896 }
2897
2898 $config = CRM_Core_Config::singleton();
2899
2900 $sub = array();
2901
2902 //By default, $sub elements should be joined together with OR statements (don't change this variable).
2903 $subGlue = ' OR ';
2904
2905 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2906
2907 if (substr($name, 0, 1) == '"' &&
2908 substr($name, -1, 1) == '"'
2909 ) {
2910 //If name is encased in double quotes, the value should be taken to be the string in entirety and the
2911 $value = substr($name, 1, -1);
2912 $value = $strtolower(CRM_Core_DAO::escapeString($value));
2913 $wc = ($newName == 'sort_name') ? 'LOWER(contact_a.sort_name)' : 'LOWER(contact_a.display_name)';
2914 $sub[] = " ( $wc = '$value' ) ";
2915 if ($config->includeEmailInName) {
2916 $sub[] = " ( civicrm_email.email = '$value' ) ";
2917 }
2918 }
2919 elseif (strpos($name, ',') !== FALSE) {
2920 // if we have a comma in the string, search for the entire string
2921 $value = $strtolower(CRM_Core_DAO::escapeString($name));
2922 if ($wildcard) {
2923 if ($config->includeWildCardInName) {
2924 $value = "'%$value%'";
2925 }
2926 else {
2927 $value = "'$value%'";
2928 }
2929 $op = 'LIKE';
2930 }
2931 else {
2932 $value = "'$value'";
2933 }
2934 if ($newName == 'sort_name') {
2935 $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name";
2936 }
2937 else {
2938 $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name";
2939 }
2940 $sub[] = " ( $wc $op $value )";
2941 if ($config->includeNickNameInName) {
2942 $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name";
2943 $sub[] = " ( $wc $op $value )";
2944 }
2945 if ($config->includeEmailInName) {
2946 $sub[] = " ( civicrm_email.email $op $value ) ";
2947 }
2948 }
2949 else {
2950 // the string should be treated as a series of keywords to be matched with match ANY OR
2951 // match ALL depending on Civi config settings (see CiviAdmin)
2952
2953 // The Civi configuration setting can be overridden if the string *starts* with the case
2954 // insenstive strings 'AND:' or 'OR:'TO THINK ABOUT: what happens when someone searches
2955 // for the following "AND: 'a string in quotes'"? - probably nothing - it would make the
2956 // AND OR variable reduntant because there is only one search string?
2957
2958 // Check to see if the $subGlue is overridden in the search text
2959 if (strtolower(substr($name, 0, 4)) == 'and:') {
2960 $name = substr($name, 4);
2961 $subGlue = ' AND ';
2962 }
2963 if (strtolower(substr($name, 0, 3)) == 'or:') {
2964 $name = substr($name, 3);
2965 $subGlue = ' OR ';
2966 }
2967
2968 $firstChar = substr($name, 0, 1);
2969 $lastChar = substr($name, -1, 1);
2970 $quotes = array("'", '"');
2971 if ((strlen($name) > 2) && in_array($firstChar, $quotes) &&
2972 in_array($lastChar, $quotes)
2973 ) {
2974 $name = substr($name, 1);
2975 $name = substr($name, 0, -1);
2976 $pieces = array($name);
2977 }
2978 else {
2979 $pieces = explode(' ', $name);
2980 }
2981 foreach ($pieces as $piece) {
2982 $value = $strtolower(CRM_Core_DAO::escapeString(trim($piece)));
2983 if (strlen($value)) {
2984 // Added If as a sanitization - without it, when you do an OR search, any string with
2985 // double spaces (i.e. " ") or that has a space after the keyword (e.g. "OR: ") will
2986 // return all contacts because it will include a condition similar to "OR contact
2987 // name LIKE '%'". It might be better to replace this with array_filter.
2988 $fieldsub = array();
2989 if ($wildcard) {
2990 if ($config->includeWildCardInName) {
2991 $value = "'%$value%'";
2992 }
2993 else {
2994 $value = "'$value%'";
2995 }
2996 $op = 'LIKE';
2997 }
2998 else {
2999 $value = "'$value'";
3000 }
3001 if ($newName == 'sort_name') {
3002 $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3003 }
3004 else {
3005 $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name";
3006 }
3007 $fieldsub[] = " ( $wc $op $value )";
3008 if ($config->includeNickNameInName) {
3009 $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3010 $fieldsub[] = " ( $wc $op $value )";
3011 }
3012 if ($config->includeEmailInName) {
3013 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3014 }
3015 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3016 // I seperated the glueing in two. The first stage should always be OR because we are searching for matches in *ANY* of these fields
3017 }
3018 }
3019 }
3020
3021 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3022
3023 $this->_where[$grouping][] = $sub;
3024 if ($config->includeEmailInName) {
3025 $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3026 $this->_qill[$grouping][] = ts('Name or Email ') . "$op - '$name'";
3027 }
3028 else {
3029 $this->_qill[$grouping][] = ts('Name like') . " - '$name'";
3030 }
3031 }
3032
3033 /**
3034 * where / qill clause for email
3035 *
3036 * @return void
3037 * @access public
3038 */
3039 function email(&$values) {
3040 list($name, $op, $value, $grouping, $wildcard) = $values;
3041
3042 $n = trim($value);
3043 if ($n) {
3044 $config = CRM_Core_Config::singleton();
3045
3046 if (substr($n, 0, 1) == '"' &&
3047 substr($n, -1, 1) == '"'
3048 ) {
3049 $n = substr($n, 1, -1);
3050 $value = strtolower(CRM_Core_DAO::escapeString($n));
3051 $value = "'$value'";
3052 $op = '=';
3053 }
3054 else {
3055 $value = strtolower($n);
3056 if ($wildcard) {
3057 if (strpos($value, '%') === FALSE) {
3058 $value = "%{$value}%";
3059 }
3060 $op = 'LIKE';
3061 }
3062 }
3063 $this->_qill[$grouping][] = ts('Email') . " $op '$n'";
3064 $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String');
3065 }
3066 else {
3067 $this->_qill[$grouping][] = ts('Email') . " $op ";
3068 $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String');
3069 }
3070
3071 $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3072 }
3073
3074 /**
3075 * where / qill clause for phone number
3076 *
3077 * @return void
3078 * @access public
3079 */
3080 function phone_numeric(&$values) {
3081 list($name, $op, $value, $grouping, $wildcard) = $values;
3082 // Strip non-numeric characters
3083 $number = preg_replace('/[^\d]/', '', $value);
3084 if ($number) {
3085 $this->_qill[$grouping][] = ts('Phone number contains') . " $number";
3086 $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "%$number%", 'String');
3087 $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3088 }
3089 }
3090
3091 /**
3092 * where / qill clause for phone type/location
3093 *
3094 * @return void
3095 * @access public
3096 */
3097 function phone_option_group($values) {
3098 list($name, $op, $value, $grouping, $wildcard) = $values;
3099 $option = $name == 'phone_phone_type_id' ? 'phoneType' : 'locationType';
3100 $options = CRM_Core_PseudoConstant::$option();
3101 $optionName = $options[$value];
3102 $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName";
3103 $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3104 $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3105 }
3106
3107 /**
3108 * where / qill clause for street_address
3109 *
3110 * @return void
3111 * @access public
3112 */
3113 function street_address(&$values) {
3114 list($name, $op, $value, $grouping, $wildcard) = $values;
3115
3116 if (!$op) {
3117 $op = 'LIKE';
3118 }
3119
3120 $n = trim($value);
3121
3122 if ($n) {
3123 $value = strtolower($n);
3124 if (strpos($value, '%') === FALSE) {
3125 // only add wild card if not there
3126 $value = "%{$value}%";
3127 }
3128 $op = 'LIKE';
3129 $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3130 $this->_qill[$grouping][] = ts('Street') . " $op '$n'";
3131 }
3132 else {
3133 $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3134 $this->_qill[$grouping][] = ts('Street') . " $op ";
3135 }
3136
3137 $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3138 }
3139
3140 /**
3141 * where / qill clause for street_unit
3142 *
3143 * @return void
3144 * @access public
3145 */
3146 function street_number(&$values) {
3147 list($name, $op, $value, $grouping, $wildcard) = $values;
3148
3149 if (!$op) {
3150 $op = '=';
3151 }
3152
3153 $n = trim($value);
3154
3155 if (strtolower($n) == 'odd') {
3156 $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3157 $this->_qill[$grouping][] = ts('Street Number is odd');
3158 }
3159 elseif (strtolower($n) == 'even') {
3160 $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3161 $this->_qill[$grouping][] = ts('Street Number is even');
3162 }
3163 else {
3164 $value = strtolower($n);
3165
3166 $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3167 $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'";
3168 }
3169
3170 $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3171 }
3172
3173 /**
3174 * where / qill clause for sorting by character
3175 *
3176 * @return void
3177 * @access public
3178 */
3179 function sortByCharacter(&$values) {
3180 list($name, $op, $value, $grouping, $wildcard) = $values;
3181
3182 $name = trim($value);
3183 $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'";
3184 $this->_where[$grouping][] = $cond;
3185 $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3186 }
3187
3188 /**
3189 * where / qill clause for including contact ids
3190 *
3191 * @return void
3192 * @access public
3193 */
3194 function includeContactIDs() {
3195 if (!$this->_includeContactIds || empty($this->_params)) {
3196 return;
3197 }
3198
3199 $contactIds = array();
3200 foreach ($this->_params as $id => $values) {
3201 if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
3202 $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN);
3203 }
3204 }
3205 if (!empty($contactIds)) {
3206 $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3207 }
3208 }
3209
3210 /**
3211 * where / qill clause for postal code
3212 *
3213 * @return void
3214 * @access public
3215 */
3216 function postalCode(&$values) {
3217 // skip if the fields dont have anything to do with postal_code
3218 if (!CRM_Utils_Array::value('postal_code', $this->_fields)) {
3219 return;
3220 }
3221
3222 list($name, $op, $value, $grouping, $wildcard) = $values;
3223
3224 // Handle numeric postal code range searches properly by casting the column as numeric
3225 if (is_numeric($value)) {
3226 $field = 'ROUND(civicrm_address.postal_code)';
3227 $val = CRM_Utils_Type::escape($value, 'Integer');
3228 }
3229 else {
3230 $field = 'civicrm_address.postal_code';
3231 $val = CRM_Utils_Type::escape($value, 'String');
3232 }
3233
3234 $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3235
3236 if ($name == 'postal_code') {
3237 $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String');
3238 $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}";
3239 }
3240 elseif ($name == 'postal_code_low') {
3241 $this->_where[$grouping][] = " ( $field >= '$val' ) ";
3242 $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3243 }
3244 elseif ($name == 'postal_code_high') {
3245 $this->_where[$grouping][] = " ( $field <= '$val' ) ";
3246 $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3247 }
3248 }
3249
3250 /**
3251 * where / qill clause for location type
3252 *
3253 * @return void
3254 * @access public
3255 */
3256 function locationType(&$values, $status = NULL) {
3257 list($name, $op, $value, $grouping, $wildcard) = $values;
3258
3259 if (is_array($value)) {
3260 $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', array_keys($value)) . ')';
3261 $this->_tables['civicrm_address'] = 1;
3262 $this->_whereTables['civicrm_address'] = 1;
3263
3264 $locationType = CRM_Core_PseudoConstant::locationType();
3265 $names = array();
3266 foreach (array_keys($value) as $id) {
3267 $names[] = $locationType[$id];
3268 }
3269
3270 $this->_primaryLocation = FALSE;
3271
3272 if (!$status) {
3273 $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3274 }
3275 else {
3276 return implode(' ' . ts('or') . ' ', $names);
3277 }
3278 }
3279 }
3280
3281 function country(&$values, $fromStateProvince = TRUE) {
3282 list($name, $op, $value, $grouping, $wildcard) = $values;
3283
3284 if (!$fromStateProvince) {
3285 $stateValues = $this->getWhereValues('state_province', $grouping);
3286 if (!empty($stateValues)) {
3287 // return back to caller if there are state province values
3288 // since that handles this case
3289 return;
3290 }
3291 }
3292
3293 $countryClause = $countryQill = NULL;
3294 if (
3295 $values &&
3296 !empty($value)
3297 ) {
3298 $this->_tables['civicrm_country'] = 1;
3299 $this->_whereTables['civicrm_country'] = 1;
3300
3301 $countries = CRM_Core_PseudoConstant::country();
3302 if (is_numeric($value)) {
3303 $countryClause = self::buildClause(
3304 'civicrm_country.id',
3305 $op,
3306 $value,
3307 'Positive'
3308 );
3309 $countryName = $countries[(int ) $value];
3310 }
3311
3312 else {
3313 $intValues = self::parseSearchBuilderString($value);
3314 if ($intValues && ($op == 'IN' || $op == 'NOT IN')) {
3315 $countryClause = self::buildClause(
3316 'civicrm_country.id',
3317 $op,
3318 $intValues,
3319 'Positive'
3320 );
3321 $countryNames = array();
3322 foreach ($intValues as $v) {
3323 $countryNames[] = $countries[$v];
3324 }
3325 $countryName = implode(',', $countryNames);
3326 }
3327 else {
3328 $wc = ($op != 'LIKE') ? "LOWER('civicrm_country.name')" : 'civicrm_country.name';
3329 $countryClause = self::buildClause(
3330 'civicrm_country.name',
3331 $op,
3332 $value,
3333 'String'
3334 );
3335 $countryName = $value;
3336 }
3337 }
3338 $countryQill = ts('Country') . " {$op} '$countryName'";
3339
3340 if (!$fromStateProvince) {
3341 $this->_where[$grouping][] = $countryClause;
3342 $this->_qill[$grouping][] = $countryQill;
3343 }
3344 }
3345
3346 if ($fromStateProvince) {
3347 if (!empty($countryClause)) {
3348 return array(
3349 $countryClause,
3350 " ...AND... " . $countryQill,
3351 );
3352 }
3353 else {
3354 return array(NULL, NULL);
3355 }
3356 }
3357 }
3358
3359 /**
3360 * where / qill clause for county (if present)
3361 *
3362 * @return void
3363 * @access public
3364 */
3365 function county(&$values, $status = null) {
3366 list($name, $op, $value, $grouping, $wildcard) = $values;
3367
3368 if (! is_array($value)) {
3369 // force the county to be an array
3370 $value = array($value);
3371 }
3372
3373 // check if the values are ids OR names of the counties
3374 $inputFormat = 'id';
3375 foreach ($value as $v) {
3376 if (!is_numeric($v)) {
3377 $inputFormat = 'name';
3378 break;
3379 }
3380 }
3381 $names = array();
3382 if ($inputFormat == 'id') {
3383 $clause = 'civicrm_county.id IN (' . implode(',', $value) . ')';
3384
3385 $county = CRM_Core_PseudoConstant::county();
3386 foreach ($value as $id) {
3387 $names[] = CRM_Utils_Array::value($id, $county);
3388 }
3389 }
3390 else {
3391 $inputClause = array();
3392 foreach ($value as $name) {
3393 $name = trim($name);
3394 $inputClause[] = "'$name'";
3395 }
3396 $clause = 'civicrm_county.name IN (' . implode(',', $inputClause) . ')';
3397 $names = $value;
3398 }
3399 $this->_tables['civicrm_county'] = 1;
3400 $this->_whereTables['civicrm_county'] = 1;
3401
3402 $this->_where[$grouping][] = $clause;
3403 if (! $status) {
3404 $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3405 } else {
3406 return implode(' ' . ts('or') . ' ', $names);
3407 }
3408 }
3409
3410 /**
3411 * where / qill clause for state/province AND country (if present)
3412 *
3413 * @return void
3414 * @access public
3415 */
3416 function stateProvince(&$values, $status = NULL) {
3417 list($name, $op, $value, $grouping, $wildcard) = $values;
3418
3419 // quick escape for IS NULL
3420 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3421 $value = NULL;
3422 }
3423 else if (!is_array($value)) {
3424 // force the state to be an array
3425 // check if its in the mapper format!
3426 $values = self::parseSearchBuilderString($value);
3427 if (is_array($values)) {
3428 $value = $values;
3429 }
3430 else {
3431 $value = array($value);
3432 }
3433 }
3434
3435 // check if the values are ids OR names of the states
3436 $inputFormat = 'id';
3437 if ($value) {
3438 foreach ($value as $v) {
3439 if (!is_numeric($v)) {
3440 $inputFormat = 'name';
3441 break;
3442 }
3443 }
3444 }
3445
3446 $names = array();
3447 if ($op == '=') {
3448 $op = 'IN';
3449 }
3450 else if ($op == '!=') {
3451 $op = 'NOT IN';
3452 }
3453 else {
3454 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3455 $op = str_replace('EMPTY', 'NULL', $op);
3456 }
3457 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3458 $stateClause = "civicrm_state_province.id $op";
3459 }
3460 else if ($inputFormat == 'id') {
3461 if ($op != 'NOT IN') {
3462 $op = 'IN';
3463 }
3464 $stateClause = "civicrm_state_province.id $op (" . implode(',', $value) . ')';
3465
3466 $stateProvince = CRM_Core_PseudoConstant::stateProvince();
3467 foreach ($value as $id) {
3468 $names[] = CRM_Utils_Array::value($id, $stateProvince);
3469 }
3470 }
3471 else {
3472 $inputClause = array();
3473 foreach ($value as $name) {
3474 $name = trim($name);
3475 $inputClause[] = "'$name'";
3476 }
3477 $stateClause = "civicrm_state_province.name $op (" . implode(',', $inputClause) . ')';
3478 $names = $value;
3479 }
3480
3481 $this->_tables['civicrm_state_province'] = 1;
3482 $this->_whereTables['civicrm_state_province'] = 1;
3483
3484 $countryValues = $this->getWhereValues('country', $grouping);
3485 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3486
3487 if ($countryClause) {
3488 $clause = "( $stateClause AND $countryClause )";
3489 }
3490 else {
3491 $clause = $stateClause;
3492 }
3493
3494 $this->_where[$grouping][] = $clause;
3495 if (!$status) {
3496 $this->_qill[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3497 }
3498 else {
3499 return implode(' ' . ts('or') . ' ', $names) . $countryQill;;
3500 }
3501 }
3502
3503 /**
3504 * where / qill clause for change log
3505 *
3506 * @return void
3507 * @access public
3508 */
3509 function changeLog(&$values) {
3510 list($name, $op, $value, $grouping, $wildcard) = $values;
3511
3512 $targetName = $this->getWhereValues('changed_by', $grouping);
3513 if (!$targetName) {
3514 return;
3515 }
3516
3517 $name = trim($targetName[2]);
3518 $name = strtolower(CRM_Core_DAO::escapeString($name));
3519 $name = $targetName[4] ? "%$name%" : $name;
3520 $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3521 $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1;
3522 $this->_qill[$grouping][] = ts('Changed by') . ": $name";
3523 }
3524
3525 function modifiedDates($values) {
3526 $this->_useDistinct = TRUE;
3527 foreach (array_keys($this->_params) as $id) {
3528 if ($this->_params[$id][0] == 'log_date') {
3529 if ($this->_params[$id][2] == 1) {
3530 $fieldTitle = 'Added Date';
3531 }
3532 elseif ($this->_params[$id][2] == 2) {
3533 $fieldTitle = 'Modified Date';
3534 }
3535 }
3536 }
3537
3538 $this->dateQueryBuilder($values,
3539 'civicrm_log', 'log_date', 'modified_date', $fieldTitle
3540 );
3541 }
3542
3543 function demographics(&$values) {
3544 list($name, $op, $value, $grouping, $wildcard) = $values;
3545
3546 if (($name == 'birth_date_low') || ($name == 'birth_date_high')) {
3547
3548 $this->dateQueryBuilder($values,
3549 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3550 );
3551 }
3552 elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) {
3553
3554 $this->dateQueryBuilder($values,
3555 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3556 );
3557 }
3558
3559 self::$_openedPanes[ts('Demographics')] = TRUE;
3560 }
3561
3562 function privacy(&$values) {
3563 list($name, $op, $value, $grouping, $wildcard) = $values;
3564 //fixed for profile search listing CRM-4633
3565 if (strpbrk($value, "[")) {
3566 $value = "'{$value}'";
3567 $op = "!{$op}";
3568 $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3569 }
3570 else {
3571 $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3572 }
3573 $field = CRM_Utils_Array::value($name, $this->_fields);
3574 $title = $field ? $field['title'] : $name;
3575 $this->_qill[$grouping][] = "$title $op $value";
3576 }
3577
3578 function privacyOptions($values) {
3579 list($name, $op, $value, $grouping, $wildcard) = $values;
3580
3581 if (empty($value) ||
3582 !is_array($value)
3583 ) {
3584 continue;
3585 }
3586
3587 // get the operator and toggle values
3588 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3589 $operator = 'OR';
3590 if ($opValues &&
3591 strtolower($opValues[2] == 'AND')
3592 ) {
3593 $operator = 'AND';
3594 }
3595
3596 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3597 $compareOP = '!=';
3598 if ($toggleValues &&
3599 $toggleValues[2] == 2
3600 ) {
3601 $compareOP = '=';
3602 }
3603
3604 $clauses = array();
3605 $qill = array();
3606 foreach ($value as $dontCare => $pOption) {
3607 $clauses[] = " ( contact_a.{$pOption} $compareOP 1 ) ";
3608 $field = CRM_Utils_Array::value($pOption, $this->_fields);
3609 $title = $field ? $field['title'] : $pOption;
3610 $qill[] = " $title $compareOP 1 ";
3611 }
3612
3613 $this->_where[$grouping][] = '( ' . implode($operator, $clauses) . ' )';
3614 $this->_qill[$grouping][] = implode($operator, $qill);
3615 }
3616
3617 function preferredCommunication(&$values) {
3618 list($name, $op, $value, $grouping, $wildcard) = $values;
3619
3620 $pref = array();
3621 if (!is_array($value)) {
3622 $v = array();
3623 $value = trim($value, ' ()');
3624 if (strpos($value, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
3625 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
3626 }
3627 else {
3628 $v = explode(",", $value);
3629 }
3630
3631 foreach ($v as $item) {
3632 if ($item) {
3633 $pref[] = $item;
3634 }
3635 }
3636 }
3637 else {
3638 foreach ($value as $key => $checked) {
3639 if ($checked) {
3640 $pref[] = $key;
3641 }
3642 }
3643 }
3644
3645 $commPref = CRM_Core_PseudoConstant::pcm();
3646
3647 $sqlValue = array();
3648 $sql = "contact_a.preferred_communication_method";
3649 foreach ($pref as $val) {
3650 $sqlValue[] = "( $sql like '%" . CRM_Core_DAO::VALUE_SEPARATOR . $val . CRM_Core_DAO::VALUE_SEPARATOR . "%' ) ";
3651 $showValue[] = $commPref[$val];
3652 }
3653 $this->_where[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3654 $this->_qill[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3655 }
3656
3657 /**
3658 * where / qill clause for task / task status
3659 *
3660 * @return void
3661 * @access public
3662 */
3663 function task(&$values) {
3664 list($name, $op, $value, $grouping, $wildcard) = $values;
3665
3666 $targetName = $this->getWhereValues('task_id', $grouping);
3667 if (!$targetName) {
3668 return;
3669 }
3670
3671 $taskID = CRM_Utils_Type::escape($targetName[2], 'Integer');
3672 $clause = "civicrm_task_status.task_id = $taskID ";
3673
3674 $statusID = NULL;
3675 if ($value) {
3676 $statusID = CRM_Utils_Type::escape($value, 'Integer');
3677 $clause .= " AND civicrm_task_status.status_id = $statusID";
3678 }
3679
3680 $this->_where[$grouping][] = "civicrm_task_status.task_id = $taskID AND civicrm_task_status.status_id = $statusID";
3681 $this->_tables['civicrm_task_status'] = $this->_whereTables['civicrm_task_status'] = 1;
3682
3683 $taskSelect = CRM_Core_PseudoConstant::tasks();
3684 $this->_qill[$grouping][] = ts('Task') . ": $taskSelect[$taskID]";
3685 if ($statusID) {
3686 $statusSelect = CRM_Core_OptionGroup::values('task_status');
3687 $this->_qill[$grouping][] = ts('Task Status') . ": $statusSelect[$statusID]";
3688 }
3689 }
3690
3691 /**
3692 * where / qill clause for relationship
3693 *
3694 * @return void
3695 * @access public
3696 */
3697 function relationship(&$values) {
3698 list($name, $op, $value, $grouping, $wildcard) = $values;
3699
3700 // also get values array for relation_target_name
3701 // for relatinship search we always do wildcard
3702 $targetName = $this->getWhereValues('relation_target_name', $grouping);
3703 $relStatus = $this->getWhereValues('relation_status', $grouping);
3704 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3705 $start = $this->getWhereValues('relation_date_low', $grouping);
3706 $end = $this->getWhereValues('relation_date_high', $grouping);
3707
3708 $nameClause = $name = NULL;
3709 if ($targetName) {
3710 $name = trim($targetName[2]);
3711 if (substr($name, 0, 1) == '"' &&
3712 substr($name, -1, 1) == '"'
3713 ) {
3714 $name = substr($name, 1, -1);
3715 $name = strtolower(CRM_Core_DAO::escapeString($name));
3716 $nameClause = "= '$name'";
3717 }
3718 else {
3719 $name = strtolower(CRM_Core_DAO::escapeString($name));
3720 $nameClause = "LIKE '%{$name}%'";
3721 }
3722 }
3723
3724 $rel = explode('_', $value);
3725
3726 self::$_relType = $rel[1];
3727
3728 $params = array('id' => $rel[0]);
3729 $rTypeValues = array();
3730 $rType = CRM_Contact_BAO_RelationshipType::retrieve($params, $rTypeValues);
3731 if (!$rType) {
3732 return;
3733 }
3734
3735 if ($rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
3736 self::$_relType = 'reciprocal';
3737 }
3738
3739 if ($nameClause) {
3740 $this->_where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
3741 }
3742
3743 $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
3744 $relTypeOrg = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
3745 $relTypeHou = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Household');
3746 $allRelationshipType = array();
3747 $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
3748 $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
3749
3750 if ($nameClause || !$targetGroup) {
3751 $this->_qill[$grouping][] = "$allRelationshipType[$value] $name";
3752 }
3753
3754
3755 //check to see if the target contact is in specified group
3756 if ($targetGroup) {
3757 //add contacts from static groups
3758 $this->_tables['civicrm_relationship_group_contact'] =
3759 $this->_whereTables['civicrm_relationship_group_contact'] =
3760 " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id";
3761 $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN (" . implode(",", $targetGroup[2]) . ") )";
3762
3763 //add contacts from saved searches
3764 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b");
3765
3766 //set the group where clause
3767 if ($ssWhere) {
3768 $groupWhere[] = "( " . $ssWhere . " )";
3769 }
3770 $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
3771
3772 //Get the names of the target groups for the qill
3773 $groupNames = &CRM_Core_PseudoConstant::group();
3774 $qillNames = array();
3775 foreach ($targetGroup[2] as $groupId) {
3776 if (array_key_exists($groupId, $groupNames)) {
3777 $qillNames[] = $groupNames[$groupId];
3778 }
3779 }
3780 $this->_qill[$grouping][] = "$allRelationshipType[$value] ( " . implode(", ", $qillNames) . " )";
3781 }
3782
3783
3784 //check for active, inactive and all relation status
3785 if ($relStatus[2] == 0) {
3786 $this->_where[$grouping][] = "(
3787civicrm_relationship.is_active = 1 AND
3788( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= CURDATE() ) AND
3789( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= CURDATE() )
3790)";
3791 $this->_qill[$grouping][] = ts('Relationship - Active and Current');
3792 }
3793 elseif ($relStatus[2] == 1) {
3794 $this->_where[$grouping][] = "(
3795civicrm_relationship.is_active = 0 OR
3796civicrm_relationship.end_date < CURDATE() OR
3797civicrm_relationship.start_date > CURDATE()
3798)";
3799 $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current');
3800 }
3801
3802 // Search by dates
3803 if ($start || $end) {
3804 foreach (array('start' => '>=', 'end' => '<=') as $d => $op) {
3805 if (!empty(${$d}[2])) {
3806 $date = date('Ymd', strtotime(${$d}[2]));
3807 $this->_where[$grouping][] = "civicrm_relationship.{$d}_date $op $date";
3808 $this->_qill[$grouping][] = ($d == 'end' ? ts('Relationship Ended by') : ts('Relationship Started On or After')) . " " . CRM_Utils_Date::customFormat($date);
3809 }
3810 }
3811 }
3812
3813 $this->_where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rel[0];
3814 $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1;
3815 $this->_useDistinct = TRUE;
3816 }
3817
3818 /**
3819 * default set of return properties
3820 *
3821 * @return void
3822 * @access public
3823 */
3824 static function &defaultReturnProperties($mode = 1) {
3825 if (!isset(self::$_defaultReturnProperties)) {
3826 self::$_defaultReturnProperties = array();
3827 }
3828
3829 if (!isset(self::$_defaultReturnProperties[$mode])) {
3830 // add activity return properties
3831 if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
3832 self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE);
3833 }
3834 else {
3835 self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE);
3836 }
3837
3838 if (empty(self::$_defaultReturnProperties[$mode])) {
3839 self::$_defaultReturnProperties[$mode] = array(
3840 'home_URL' => 1,
3841 'image_URL' => 1,
3842 'legal_identifier' => 1,
3843 'external_identifier' => 1,
3844 'contact_type' => 1,
3845 'contact_sub_type' => 1,
3846 'sort_name' => 1,
3847 'display_name' => 1,
3848 'preferred_mail_format' => 1,
3849 'nick_name' => 1,
3850 'first_name' => 1,
3851 'middle_name' => 1,
3852 'last_name' => 1,
3853 'individual_prefix' => 1,
3854 'individual_suffix' => 1,
3855 'birth_date' => 1,
3856 'gender' => 1,
3857 'street_address' => 1,
3858 'supplemental_address_1' => 1,
3859 'supplemental_address_2' => 1,
3860 'city' => 1,
3861 'postal_code' => 1,
3862 'postal_code_suffix' => 1,
3863 'state_province' => 1,
3864 'country' => 1,
3865 'world_region' => 1,
3866 'geo_code_1' => 1,
3867 'geo_code_2' => 1,
3868 'email' => 1,
3869 'on_hold' => 1,
3870 'phone' => 1,
3871 'im' => 1,
3872 'household_name' => 1,
3873 'organization_name' => 1,
3874 'deceased_date' => 1,
3875 'is_deceased' => 1,
3876 'job_title' => 1,
3877 'legal_name' => 1,
3878 'sic_code' => 1,
3879 'current_employer' => 1,
3880 // FIXME: should we use defaultHierReturnProperties() for the below?
3881 'do_not_email' => 1,
3882 'do_not_mail' => 1,
3883 'do_not_sms' => 1,
3884 'do_not_phone' => 1,
3885 'do_not_trade' => 1,
3886 'is_opt_out' => 1,
3887 'contact_is_deleted' => 1,
3888 );
3889 }
3890 }
3891 return self::$_defaultReturnProperties[$mode];
3892 }
3893
3894 /**
3895 * get primary condition for a sql clause
3896 *
3897 * @param int $value
3898 *
3899 * @return void
3900 * @access public
3901 */
3902 static function getPrimaryCondition($value) {
3903 if (is_numeric($value)) {
3904 $value = (int ) $value;
3905 return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0';
3906 }
3907 return NULL;
3908 }
3909
3910 /**
3911 * wrapper for a simple search query
3912 *
3913 * @param array $params
3914 * @param array $returnProperties
3915 * @param bolean $count
3916 *
3917 * @return void
3918 * @access public
3919 */
3920 static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
3921 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
3922 list($select, $from, $where, $having) = $query->query();
3923
3924 return "$select $from $where $having";
3925 }
3926
3927 /**
3928 * These are stub comments as this function needs more explanation - particularly in terms of how it
3929 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
3930 *
3931 * This function was originally written as a wrapper for the api query but is called from multiple places
3932 * in the core code directly so the name is misleading. This function does not use the searchQuery function
3933 * but it is unclear as to whehter that is historical or there is a reason
3934 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
3935 *
3936 * @param array $params
3937 * @param array $returnProperties
3938 * @param string $sort
3939 * @param int $offset
3940 * @param int $row_count
3941 * @params bool $smartGroupCache ?? update smart group cache?
3942 * @param bool $count return count obnly
3943 * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied
3944 *
3945 * @return void
3946 * @access public
3947 */
3948 static function apiQuery(
3949 $params = NULL,
3950 $returnProperties = NULL,
3951 $fields = NULL,
3952 $sort = NULL,
3953 $offset = 0,
3954 $row_count = 25,
3955 $smartGroupCache = TRUE,
3956 $count = FALSE,
3957 $skipPermissions = True
3958 ) {
3959
3960 $query = new CRM_Contact_BAO_Query(
3961 $params, $returnProperties,
3962 NULL, TRUE, FALSE, 1,
3963 $skipPermissions,
3964 TRUE, $smartGroupCache
3965 );
3966
3967 //this should add a check for view deleted if permissions are enabled
3968 if ($skipPermissions){
3969 $query->_skipDeleteClause = TRUE;
3970 }
3971 $query->generatePermissionClause(FALSE, $count);
3972 list($select, $from, $where, $having) = $query->query($count);
3973
3974 $options = $query->_options;
3975 if(!empty($query->_permissionWhereClause)){
3976 if (empty($where)) {
3977 $where = "WHERE $query->_permissionWhereClause";
3978 }
3979 else {
3980 $where = "$where AND $query->_permissionWhereClause";
3981 }
3982 }
3983
3984 $sql = "$select $from $where $having";
3985
3986 // add group by
3987 if ($query->_useGroupBy) {
3988 $sql .= ' GROUP BY contact_a.id';
3989 }
3990 if (!empty($sort)) {
3991 $sql .= " ORDER BY $sort ";
3992 }
3993 if ($row_count > 0 && $offset >= 0) {
3994 $sql .= " LIMIT $offset, $row_count ";
3995 }
3996
3997 $dao = CRM_Core_DAO::executeQuery($sql);
3998
3999 $values = array();
4000 while ($dao->fetch()) {
4001 if ($count) {
4002 $noRows = $dao->rowCount;
4003 $dao->free();
4004 return array($noRows,NULL);
4005 }
4006 $values[$dao->contact_id] = $query->store($dao);
4007 }
4008 $dao->free();
4009 return array($values, $options);
4010 }
4011
4012 /**
4013 * create and query the db for an contact search
4014 *
4015 * @param int $offset the offset for the query
4016 * @param int $rowCount the number of rows to return
4017 * @param string $sort the order by string
4018 * @param boolean $count is this a count only query ?
4019 * @param boolean $includeContactIds should we include contact ids?
4020 * @param boolean $sortByChar if true returns the distinct array of first characters for search results
4021 * @param boolean $groupContacts if true, return only the contact ids
4022 * @param boolean $returnQuery should we return the query as a string
4023 * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components)
4024 * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load.
4025 *
4026 * @return CRM_Contact_DAO_Contact
4027 * @access public
4028 */
4029 function searchQuery(
4030 $offset = 0, $rowCount = 0, $sort = NULL,
4031 $count = FALSE, $includeContactIds = FALSE,
4032 $sortByChar = FALSE, $groupContacts = FALSE,
4033 $returnQuery = FALSE,
4034 $additionalWhereClause = NULL, $sortOrder = NULL,
4035 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4036 ) {
4037
4038 if ($includeContactIds) {
4039 $this->_includeContactIds = TRUE;
4040 $this->_whereClause = $this->whereClause();
4041 }
4042
4043 // hack for now, add permission only if we are in search
4044 // FIXME: we should actually filter out deleted contacts (unless requested to do the opposite)
4045 $permission = ' ( 1 ) ';
4046 $onlyDeleted = FALSE;
4047 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4048
4049 // if we’re explicitely looking for a certain contact’s contribs, events, etc.
4050 // and that contact happens to be deleted, set $onlyDeleted to true
4051 foreach ($this->_params as $values) {
4052 $name = CRM_Utils_Array::value(0, $values);
4053 $op = CRM_Utils_Array::value(1, $values);
4054 $value = CRM_Utils_Array::value(2, $values);
4055 if ($name == 'contact_id' and $op == '=') {
4056 if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4057 $onlyDeleted = TRUE;
4058 }
4059 break;
4060 }
4061 }
4062 $this->generatePermissionClause($onlyDeleted, $count);
4063
4064 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts);
4065
4066 //additional from clause should be w/ proper joins.
4067 if ($additionalFromClause) {
4068 $from .= "\n" . $additionalFromClause;
4069 }
4070
4071 if (empty($where)) {
4072 $where = "WHERE $this->_permissionWhereClause";
4073 }
4074 else {
4075 $where = "$where AND $this->_permissionWhereClause";
4076 }
4077
4078 if ($additionalWhereClause) {
4079 $where = $where . ' AND ' . $additionalWhereClause;
4080 }
4081
4082 // building the query string
4083 $groupBy = NULL;
4084 if (!$count) {
4085 if (isset($this->_groupByComponentClause)) {
4086 $groupBy = $this->_groupByComponentClause;
4087 }
4088 elseif ($this->_useGroupBy) {
4089 $groupBy = ' GROUP BY contact_a.id';
4090 }
4091 }
4092 if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) {
4093 $groupBy = 'GROUP BY civicrm_activity.id ';
4094 }
4095
4096 $order = $orderBy = $limit = '';
4097 if (!$count) {
4098 $config = CRM_Core_Config::singleton();
4099 if ($config->includeOrderByClause ||
4100 isset($this->_distinctComponentClause)
4101 ) {
4102 if ($sort) {
4103 if (is_string($sort)) {
4104 $orderBy = $sort;
4105 }
4106 else {
4107 $orderBy = trim($sort->orderBy());
4108 }
4109 if (!empty($orderBy)) {
4110 // this is special case while searching for
4111 // changelog CRM-1718
4112 if (preg_match('/sort_name/i', $orderBy)) {
4113 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4114 }
4115
4116 $order = " ORDER BY $orderBy";
4117
4118 if ($sortOrder) {
4119 $order .= " $sortOrder";
4120 }
4121
4122 // always add contact_a.id to the ORDER clause
4123 // so the order is deterministic
4124 if (strpos('contact_a.id', $order) === FALSE) {
4125 $order .= ", contact_a.id";
4126 }
4127 }
4128 }
4129 elseif ($sortByChar) {
4130 $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4131 }
4132 else {
4133 $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4134 }
4135 }
4136
4137 $doOpt = TRUE;
4138 // hack for order clause
4139 if ($order) {
4140 $fieldStr = trim(str_replace('ORDER BY', '', $order));
4141 $fieldOrder = explode(' ', $fieldStr);
4142 $field = $fieldOrder[0];
4143
4144 if ($field) {
4145 switch ($field) {
4146 case 'sort_name':
4147 case 'id':
4148 case 'contact_a.sort_name':
4149 case 'contact_a.id':
4150 break;
4151
4152 case 'city':
4153 case 'postal_code':
4154 $this->_whereTables["civicrm_address"] = 1;
4155 $order = str_replace($field, "civicrm_address.{$field}", $order);
4156 break;
4157
4158 case 'country':
4159 case 'state_province':
4160 $this->_whereTables["civicrm_{$field}"] = 1;
4161 $order = str_replace($field, "civicrm_{$field}.name", $order);
4162 break;
4163
4164 case 'email':
4165 $this->_whereTables["civicrm_email"] = 1;
4166 $order = str_replace($field, "civicrm_email.{$field}", $order);
4167 break;
4168
4169 default:
4170 $doOpt = FALSE;
4171 }
4172 }
4173 }
4174
4175
4176 if ($rowCount > 0 && $offset >= 0) {
4177 $limit = " LIMIT $offset, $rowCount ";
4178
4179 // ok here is a first hack at an optimization, lets get all the contact ids
4180 // that are restricted and we'll then do the final clause with it
4181 // CRM-5954
4182 if (isset($this->_distinctComponentClause)) {
4183 if (strpos($this->_distinctComponentClause, 'DISTINCT') == FALSE) {
4184 $limitSelect = "SELECT DISTINCT {$this->_distinctComponentClause}";
4185 }
4186 else {
4187 $limitSelect = "SELECT {$this->_distinctComponentClause}";
4188 }
4189 }
4190 else {
4191 $limitSelect = 'SELECT DISTINCT contact_a.id as id';
4192 }
4193
4194 if ($doOpt) {
4195 $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL,
4196 $this->_primaryLocation, $this->_mode
4197 );
4198
4199 if ($additionalFromClause) {
4200 $this->_simpleFromClause .= "\n" . $additionalFromClause;
4201 }
4202 // if we are doing a transform, do it here
4203 // CRM-7969
4204 $having = NULL;
4205 if ($this->_displayRelationshipType) {
4206 $this->filterRelatedContacts($this->_simpleFromClause, $where, $having);
4207 }
4208
4209 $limitQuery = "$limitSelect {$this->_simpleFromClause} $where $groupBy $order $limit";
4210 $limitDAO = CRM_Core_DAO::executeQuery($limitQuery);
4211 $limitIDs = array();
4212 while ($limitDAO->fetch()) {
4213 if ($limitDAO->id) {
4214 $limitIDs[] = $limitDAO->id;
4215 }
4216 }
4217 if (empty($limitIDs)) {
4218 $limitClause = ' AND ( 0 ) ';
4219 }
4220 else {
4221 if (isset($this->_distinctComponentClause)) {
4222 $limitClause = " AND {$this->_distinctComponentClause} IN ( ";
4223 }
4224 else {
4225 $limitClause = ' AND contact_a.id IN ( ';
4226 }
4227 $limitClause .= implode(',', $limitIDs) . ' ) ';
4228 }
4229 $where .= $limitClause;
4230 // reset limit clause since we already restrict what records we want
4231 $limit = NULL;
4232 }
4233 }
4234 }
4235
4236 // if we are doing a transform, do it here
4237 // use the $from, $where and $having to get the contact ID
4238 if ($this->_displayRelationshipType) {
4239 $this->filterRelatedContacts($from, $where, $having);
4240 }
4241
4242 if ($skipOrderAndLimit) {
4243 $query = "$select $from $where $having $groupBy";
4244 }
4245 else {
4246 $query = "$select $from $where $having $groupBy $order $limit";
4247 }
4248
4249 if ($returnQuery) {
4250 return $query;
4251 }
4252
4253 if ($count) {
4254 return CRM_Core_DAO::singleValueQuery($query);
4255 }
4256
4257 //crm_core_error::debug('$query', $query); //exit;
4258
4259 $dao = CRM_Core_DAO::executeQuery($query);
4260 if ($groupContacts) {
4261 $ids = array();
4262 while ($dao->fetch()) {
4263 $ids[] = $dao->id;
4264 }
4265 return implode(',', $ids);
4266 }
4267
4268 return $dao;
4269 }
4270
4271 /**
4272 * Populate $this->_permissionWhereClause with permission related clause and update other
4273 * query related properties.
4274 *
4275 * Function calls ACL permission class and hooks to filter the query appropriately
4276 *
4277 * Note that these 2 params were in the code when extracted from another function
4278 * and a second round extraction would be to make them properties of the class
4279 *
4280 * @param bool $onlyDeleted Only get deleted contacts
4281 * @param bool $count Return Count only
4282 *
4283 * @return null
4284 */
4285 function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4286 if (!$this->_skipPermission) {
4287 $this->_permissionWhereClause = CRM_ACL_API::whereClause(
4288 CRM_Core_Permission::VIEW,
4289 $this->_tables,
4290 $this->_whereTables,
4291 NULL,
4292 $onlyDeleted,
4293 $this->_skipDeleteClause
4294 );
4295
4296 // regenerate fromClause since permission might have added tables
4297 if ($this->_permissionWhereClause) {
4298 //fix for row count in qill (in contribute/membership find)
4299 if (!$count) {
4300 $this->_useDistinct = TRUE;
4301 }
4302 $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4303 $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4304 }
4305 }
4306 else {
4307 // add delete clause if needed even if we are skipping permission
4308 // CRM-7639
4309 if (!$this->_skipDeleteClause) {
4310 if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
4311 $this->_permissionWhereClause = '(contact_a.is_deleted)';
4312 }
4313 else {
4314 // CRM-6181
4315 $this->_permissionWhereClause = '(contact_a.is_deleted = 0)';
4316 }
4317 }
4318 }
4319 }
4320
4321 function setSkipPermission($val) {
4322 $this->_skipPermission = $val;
4323 }
4324
4325 function &summaryContribution($context = NULL) {
4326 list($select, $from, $where, $having) = $this->query(TRUE);
4327
4328 // hack $select
4329 $select = "
4330SELECT COUNT( civicrm_contribution.total_amount ) as total_count,
4331 SUM( civicrm_contribution.total_amount ) as total_amount,
4332 AVG( civicrm_contribution.total_amount ) as total_avg,
4333 civicrm_contribution.currency as currency";
4334
4335 // make sure contribution is completed - CRM-4989
4336 $where .= " AND civicrm_contribution.contribution_status_id = 1 ";
4337 if ($context == 'search') {
4338 $where .= " AND contact_a.is_deleted = 0 ";
4339 }
4340
4341 $summary = array();
4342 $summary['total'] = array();
4343 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4344
4345 $query = "$select $from $where GROUP BY currency";
4346 $params = array();
4347
4348 $dao = CRM_Core_DAO::executeQuery($query, $params);
4349
4350 $summary['total']['count'] = 0;
4351 $summary['total']['amount'] = $summary['total']['avg'] = array();
4352 while ($dao->fetch()) {
4353 $summary['total']['count'] += $dao->total_count;
4354 $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4355 $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4356 }
4357 if (!empty($summary['total']['amount'])) {
4358 $summary['total']['amount'] = implode(',&nbsp;', $summary['total']['amount']);
4359 $summary['total']['avg'] = implode(',&nbsp;', $summary['total']['avg']);
4360 }
4361 else {
4362 $summary['total']['amount'] = $summary['total']['avg'] = 0;
4363 }
4364
4365 // hack $select
4366 $select = "
4367SELECT COUNT( civicrm_contribution.total_amount ) as cancel_count,
4368 SUM( civicrm_contribution.total_amount ) as cancel_amount,
4369 AVG( civicrm_contribution.total_amount ) as cancel_avg,
4370 civicrm_contribution.currency as currency";
4371
4372 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4373 if ($context == 'search') {
4374 $where .= " AND contact_a.is_deleted = 0 ";
4375 }
4376
4377 $query = "$select $from $where GROUP BY currency";
4378 $dao = CRM_Core_DAO::executeQuery($query, $params);
4379
4380 if ($dao->N <= 1) {
4381 if ($dao->fetch()) {
4382 $summary['cancel']['count'] = $dao->cancel_count;
4383 $summary['cancel']['amount'] = $dao->cancel_amount;
4384 $summary['cancel']['avg'] = $dao->cancel_avg;
4385 }
4386 }
4387 else {
4388 $summary['cancel']['count'] = 0;
4389 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4390 while ($dao->fetch()) {
4391 $summary['cancel']['count'] += $dao->cancel_count;
4392 $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
4393 $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
4394 }
4395 $summary['cancel']['amount'] = implode(',&nbsp;', $summary['cancel']['amount']);
4396 $summary['cancel']['avg'] = implode(',&nbsp;', $summary['cancel']['avg']);
4397 }
4398
4399 return $summary;
4400 }
4401
4402 /**
4403 * getter for the qill object
4404 *
4405 * @return string
4406 * @access public
4407 */
4408 function qill() {
4409 return $this->_qill;
4410 }
4411
4412 /**
4413 * default set of return default hier return properties
4414 *
4415 * @return void
4416 * @access public
4417 */
4418 static function &defaultHierReturnProperties() {
4419 if (!isset(self::$_defaultHierReturnProperties)) {
4420 self::$_defaultHierReturnProperties = array(
4421 'home_URL' => 1,
4422 'image_URL' => 1,
4423 'legal_identifier' => 1,
4424 'external_identifier' => 1,
4425 'contact_type' => 1,
4426 'contact_sub_type' => 1,
4427 'sort_name' => 1,
4428 'display_name' => 1,
4429 'nick_name' => 1,
4430 'first_name' => 1,
4431 'middle_name' => 1,
4432 'last_name' => 1,
4433 'individual_prefix' => 1,
4434 'individual_suffix' => 1,
4435 'email_greeting' => 1,
4436 'postal_greeting' => 1,
4437 'addressee' => 1,
4438 'birth_date' => 1,
4439 'gender' => 1,
4440 'preferred_communication_method' => 1,
4441 'do_not_phone' => 1,
4442 'do_not_email' => 1,
4443 'do_not_mail' => 1,
4444 'do_not_sms' => 1,
4445 'do_not_trade' => 1,
4446 'location' =>
4447 array(
4448 '1' => array('location_type' => 1,
4449 'street_address' => 1,
4450 'city' => 1,
4451 'state_province' => 1,
4452 'postal_code' => 1,
4453 'postal_code_suffix' => 1,
4454 'country' => 1,
4455 'phone-Phone' => 1,
4456 'phone-Mobile' => 1,
4457 'phone-Fax' => 1,
4458 'phone-1' => 1,
4459 'phone-2' => 1,
4460 'phone-3' => 1,
4461 'im-1' => 1,
4462 'im-2' => 1,
4463 'im-3' => 1,
4464 'email-1' => 1,
4465 'email-2' => 1,
4466 'email-3' => 1,
4467 ),
4468 '2' => array(
4469 'location_type' => 1,
4470 'street_address' => 1,
4471 'city' => 1,
4472 'state_province' => 1,
4473 'postal_code' => 1,
4474 'postal_code_suffix' => 1,
4475 'country' => 1,
4476 'phone-Phone' => 1,
4477 'phone-Mobile' => 1,
4478 'phone-1' => 1,
4479 'phone-2' => 1,
4480 'phone-3' => 1,
4481 'im-1' => 1,
4482 'im-2' => 1,
4483 'im-3' => 1,
4484 'email-1' => 1,
4485 'email-2' => 1,
4486 'email-3' => 1,
4487 ),
4488 ),
4489 );
4490 }
4491 return self::$_defaultHierReturnProperties;
4492 }
4493
4494 function dateQueryBuilder(
4495 &$values, $tableName, $fieldName,
4496 $dbFieldName, $fieldTitle,
4497 $appendTimeStamp = TRUE
4498 ) {
4499 list($name, $op, $value, $grouping, $wildcard) = $values;
4500
4501 if (!$value) {
4502 return;
4503 }
4504
4505 if ($name == "{$fieldName}_low" ||
4506 $name == "{$fieldName}_high"
4507 ) {
4508 if (isset($this->_rangeCache[$fieldName])) {
4509 return;
4510 }
4511 $this->_rangeCache[$fieldName] = 1;
4512
4513 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4514
4515 if ($name == $fieldName . '_low') {
4516 $firstOP = '>=';
4517 $firstPhrase = 'greater than or equal to';
4518 $firstDate = CRM_Utils_Date::processDate($value);
4519
4520 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4521 if (!empty($secondValues) &&
4522 $secondValues[2]
4523 ) {
4524 $secondOP = '<=';
4525 $secondPhrase = 'less than or equal to';
4526 $secondValue = $secondValues[2];
4527
4528 if ($appendTimeStamp &&
4529 strlen($secondValue) == 10
4530 ) {
4531 $secondValue .= ' 23:59:59';
4532 }
4533 $secondDate = CRM_Utils_Date::processDate($secondValue);
4534 }
4535 }
4536 elseif ($name == $fieldName . '_high') {
4537 $firstOP = '<=';
4538 $firstPhrase = 'less than or equal to';
4539
4540 if ($appendTimeStamp &&
4541 strlen($value) == 10
4542 ) {
4543 $value .= ' 23:59:59';
4544 }
4545 $firstDate = CRM_Utils_Date::processDate($value);
4546
4547 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4548 if (!empty($secondValues) &&
4549 $secondValues[2]
4550 ) {
4551 $secondOP = '>=';
4552 $secondPhrase = 'greater than or equal to';
4553 $secondValue = $secondValues[2];
4554 $secondDate = CRM_Utils_Date::processDate($secondValue);
4555 }
4556 }
4557
4558 if (!$appendTimeStamp) {
4559 $firstDate = substr($firstDate, 0, 8);
4560 }
4561 $firstDateFormat = CRM_Utils_Date::customFormat($firstDate);
4562
4563 if ($secondDate) {
4564 if (!$appendTimeStamp) {
4565 $secondDate = substr($secondDate, 0, 8);
4566 }
4567 $secondDateFormat = CRM_Utils_Date::customFormat($secondDate);
4568 }
4569
4570 $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
4571 if ($secondDate) {
4572 $this->_where[$grouping][] = "
4573( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
4574( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
4575";
4576 $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
4577 }
4578 else {
4579 $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
4580 $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
4581 }
4582 }
4583
4584 if ($name == $fieldName) {
4585 // $op = '=';
4586 $phrase = $op;
4587
4588 $date = CRM_Utils_Date::processDate($value);
4589
4590 if (!$appendTimeStamp) {
4591 $date = substr($date, 0, 8);
4592 }
4593
4594 $format = CRM_Utils_Date::customFormat($date);
4595
4596 if ($date) {
4597 $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op '$date'";
4598 }
4599 else {
4600 $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op";
4601 }
4602 $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
4603 $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$format\"";
4604 }
4605
4606 if (
4607 $tableName == 'civicrm_log' &&
4608 $fieldTitle == 'Added Date'
4609 ) {
4610 //CRM-6903 --hack to check modified date of first record.
4611 //as added date means first modified date of object.
4612 $addedDateQuery = 'select id from civicrm_log group by entity_id order by id';
4613 $this->_where[$grouping][] = "civicrm_log.id IN ( {$addedDateQuery} )";
4614 }
4615 }
4616
4617 function numberRangeBuilder(&$values,
4618 $tableName, $fieldName,
4619 $dbFieldName, $fieldTitle,
4620 $options = NULL
4621 ) {
4622 list($name, $op, $value, $grouping, $wildcard) = $values;
4623
4624 if ($name == "{$fieldName}_low" ||
4625 $name == "{$fieldName}_high"
4626 ) {
4627 if (isset($this->_rangeCache[$fieldName])) {
4628 return;
4629 }
4630 $this->_rangeCache[$fieldName] = 1;
4631
4632 $secondOP = $secondPhrase = $secondValue = NULL;
4633
4634 if ($name == "{$fieldName}_low") {
4635 $firstOP = '>=';
4636 $firstPhrase = 'greater than';
4637
4638 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4639 if (!empty($secondValues)) {
4640 $secondOP = '<=';
4641 $secondPhrase = 'less than';
4642 $secondValue = $secondValues[2];
4643 }
4644 }
4645 else {
4646 $firstOP = '<=';
4647 $firstPhrase = 'less than';
4648
4649 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4650 if (!empty($secondValues)) {
4651 $secondOP = '>=';
4652 $secondPhrase = 'greater than';
4653 $secondValue = $secondValues[2];
4654 }
4655 }
4656
4657 if ($secondOP) {
4658 $this->_where[$grouping][] = "
4659( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
4660( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
4661";
4662 $displayValue = $options ? $options[$value] : $value;
4663 $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
4664
4665 $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
4666 }
4667 else {
4668 $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
4669 $displayValue = $options ? $options[$value] : $value;
4670 $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
4671 }
4672 $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
4673
4674 return;
4675 }
4676
4677 if ($name == $fieldName) {
4678 $op = '=';
4679 $phrase = '=';
4680
4681 $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
4682
4683 $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
4684 $displayValue = $options ? $options[$value] : $value;
4685 $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
4686 }
4687
4688 return;
4689 }
4690
4691 /**
4692 * Given the field name, operator, value & its data type
4693 * builds the where Clause for the query
4694 * used for handling 'IS NULL'/'IS NOT NULL' operators
4695 *
4696 * @param string $field fieldname
4697 * @param string $op operator
4698 * @param string $value value
4699 * @param string $dataType data type of the field
4700 *
4701 * @return where clause for the query
4702 * @access public
4703 */
4704 static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
4705 $op = trim($op);
4706 $clause = "$field $op";
4707
4708 switch ($op) {
4709 case 'IS NULL':
4710 case 'IS NOT NULL':
4711 return $clause;
4712
4713 case 'IS EMPTY':
4714 $clause = " ( $field IS NULL OR $field = '' ) ";
4715 return $clause;
4716
4717 case 'IS NOT EMPTY':
4718 $clause = " ( $field IS NOT NULL AND $field <> '' ) ";
4719 return $clause;
4720
4721 case 'IN':
4722 case 'NOT IN':
4723 if (isset($dataType)) {
4724 if (is_array($value)) {
4725 $values = $value;
4726 }
4727 else {
4728 $value = CRM_Utils_Type::escape($value, "String");
4729 $values = explode(',', CRM_Utils_Array::value(0, explode(')', CRM_Utils_Array::value(1, explode('(', $value)))));
4730 }
4731 // supporting multiple values in IN clause
4732 $val = array();
4733 foreach ($values as $v) {
4734 $v = trim($v);
4735 $val[] = "'" . CRM_Utils_Type::escape($v, $dataType) . "'";
4736 }
4737 $value = "(" . implode($val, ",") . ")";
4738 }
4739 return "$clause $value";
4740
4741 default:
4742 if (empty($dataType)) {
4743 $dataType = 'String';
4744 }
4745
4746 $value = CRM_Utils_Type::escape($value, $dataType);
4747
4748 // if we dont have a dataType we should assume
4749 if ($dataType == 'String') {
4750 $value = "'" . strtolower($value) . "'";
4751 }
4752 return "$clause $value";
4753 }
4754 }
4755
4756 function openedSearchPanes($reset = FALSE) {
4757 if (!$reset || empty($this->_whereTables)) {
4758 return self::$_openedPanes;
4759 }
4760
4761 // pane name to table mapper
4762 $panesMapper = array(
4763 ts('Contributions') => 'civicrm_contribution',
4764 ts('Memberships') => 'civicrm_membership',
4765 ts('Events') => 'civicrm_participant',
4766 ts('Relationships') => 'civicrm_relationship',
4767 ts('Activities') => 'civicrm_activity',
4768 ts('Pledges') => 'civicrm_pledge',
4769 ts('Cases') => 'civicrm_case',
4770 ts('Grants') => 'civicrm_grant',
4771 ts('Address Fields') => 'civicrm_address',
4772 ts('Notes') => 'civicrm_note',
4773 ts('Change Log') => 'civicrm_log',
4774 ts('Mailings') => 'civicrm_mailing_event_queue',
4775 );
4776
4777 foreach (array_keys($this->_whereTables) as $table) {
4778 if ($panName = array_search($table, $panesMapper)) {
4779 self::$_openedPanes[$panName] = TRUE;
4780 }
4781 }
4782
4783 return self::$_openedPanes;
4784 }
4785
4786 function setOperator($operator) {
4787 $validOperators = array('AND', 'OR');
4788 if (!in_array($operator, $validOperators)) {
4789 $operator = 'AND';
4790 }
4791 $this->_operator = $operator;
4792 }
4793
4794 function getOperator() {
4795 return $this->_operator;
4796 }
4797
4798 function filterRelatedContacts(&$from, &$where, &$having) {
4799 static $_rTypeProcessed = NULL;
4800 static $_rTypeFrom = NULL;
4801 static $_rTypeWhere = NULL;
4802
4803 if (!$_rTypeProcessed) {
4804 $_rTypeProcessed = TRUE;
4805
4806 // create temp table with contact ids
4807 $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE);
4808 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
4809 CRM_Core_DAO::executeQuery($sql);
4810
4811 $sql = "
4812REPLACE INTO $tableName ( contact_id )
4813SELECT contact_a.id
4814 $from
4815 $where
4816 $having
4817";
4818 CRM_Core_DAO::executeQuery($sql);
4819
4820 $qillMessage = ts('Contacts with a Relationship Type of: ');
4821 $rTypes = CRM_Core_PseudoConstant::relationshipType();
4822
4823 if (is_numeric($this->_displayRelationshipType)) {
4824 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b'];
4825 $_rTypeFrom = "
4826INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
4827INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
4828";
4829 $_rTypeWhere = "
4830WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
4831AND displayRelType.is_active = 1
4832";
4833 }
4834 else {
4835 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType);
4836 if ($dirOne == 'a') {
4837 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
4838 $_rTypeFrom .= "
4839INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
4840INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
4841";
4842 }
4843 else {
4844 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
4845 $_rTypeFrom .= "
4846INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
4847INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
4848";
4849 }
4850 $_rTypeWhere = "
4851WHERE displayRelType.relationship_type_id = $relType
4852AND displayRelType.is_active = 1
4853";
4854 }
4855
4856 $this->_qill[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
4857 }
4858
4859 if (strpos($from, $_rTypeFrom) === FALSE) {
4860 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
4861 // this happens when we have an event_type in the quert (CRM-7969)
4862 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
4863 $from .= $_rTypeFrom;
4864 $where = $_rTypeWhere;
4865 }
4866
4867 $having = NULL;
4868 }
4869
4870 static function caseImportant( $op ) {
4871 return
4872 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
4873 }
4874
4875 static function componentPresent( &$returnProperties, $prefix ) {
4876 foreach ($returnProperties as $name => $dontCare ) {
4877 if (substr($name, 0, strlen($prefix)) == $prefix) {
4878 return TRUE;
4879 }
4880 }
4881 return FALSE;
4882 }
4883
4884 /**
4885 * Builds the necessary structures for all fields that are similar to option value lookups
4886 *
4887 * @param $name string the name of the field
4888 * @param $op string the sql operator, this function should handle ALL SQL operators
4889 * @param $value any string / integer / array depends on the operator and whos calling the query builder
4890 * @param $grouping int the index where to place the where clause
4891 * @param $selectValue array the key value pairs for this element. This allows us to use this function for things besides option-value pairs
4892 * @param $field array an array that contains various properties of the field identified by $name
4893 * @param $label string The label for this field element
4894 * @param $dataType string The data type for this element
4895 *
4896 * @return void adds the where clause and qill to the query object
4897 */
4898 function optionValueQuery(
4899 $name,
4900 $op,
4901 $value,
4902 $grouping,
4903 $selectValues,
4904 $field,
4905 $label,
4906 $dataType = 'String'
4907 ) {
4908 $qill = $value;
4909 if (is_numeric($value)) {
4910 $qill = $value = $selectValues[(int ) $value];
4911 }
4912 elseif ($op == 'IN' || $op == 'NOT IN') {
4913 $values = self::parseSearchBuilderString($value);
4914 if (is_array($values)) {
4915 $newValues = array();
4916 foreach ($values as $v) {
4917 $newValues[] = $selectValues[(int ) $v];
4918 }
4919 $value = $newValues;
4920 $qill = implode(', ', $value);
4921 }
4922 }
4923 $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
4924 $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType);
4925 $this->_qill[$grouping][] = $label . " $op '$qill'";
4926 }
4927
4928 /** function to check and explode a user defined numeric string into an array
4929 * this was the protocol used by search builder in the old old days before we had
4930 * super nice js widgets to do the hard work
4931 *
4932 * @param string the string to check
4933 * @param string the dataType we should check for the values, default integer
4934 *
4935 * @return FALSE if string does not match the patter
4936 * array of numeric values if string does match the pattern
4937 * @static
4938 */
4939 static function parseSearchBuilderString($string, $dataType = 'Integer') {
4940 $string = trim($string);
4941 if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') {
4942 Return FALSE;
4943 }
4944
4945 $string = substr($string, 1, -1);
4946 $values = explode(',', $string);
4947 if (empty($values)) {
4948 return FALSE;
4949 }
4950
4951 $returnValues = array();
4952 foreach ($values as $v) {
4953 if ($dataType == 'Integer' && ! is_numeric($v)) {
4954 return FALSE;
4955 }
4956 else if ($dataType == 'String' && ! is_string($v)) {
4957 return FALSE;
4958 }
4959 $returnValues[] = trim($v);
4960 }
4961
4962 if (empty($returnValues)) {
4963 return FALSE;
4964 }
4965
4966 return $returnValues;
4967 }
4968}
4969