CRM/Contact/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * This is the heart of the search query building mechanism.
  36  */
  37 class CRM_Contact_BAO_Query {
  38
  39   /**
  40    * The various search modes.
  41    *
  42    * As of February 2017, entries not present for 4, 32, 64, 1024.
  43    *
  44    * MODE_ALL seems to be out of sync with the available constants;
  45    * if this is intentionally excluding MODE_MAILING then that may
  46    * bear documenting?
  47    *
  48    * Likewise if there's reason for the missing modes (4, 32, 64 etc).
  49    *
  50    * @var int
  51    */
  52   const
  53     NO_RETURN_PROPERTIES = 'CRM_Contact_BAO_Query::NO_RETURN_PROPERTIES',
  54     MODE_CONTACTS = 1,
  55     MODE_CONTRIBUTE = 2,
  56     // There is no 4,
  57     MODE_MEMBER = 8,
  58     MODE_EVENT = 16,
  59     MODE_CONTACTSRELATED = 32,
  60     // no 64.
  61     MODE_GRANT = 128,
  62     MODE_PLEDGEBANK = 256,
  63     MODE_PLEDGE = 512,
  64     // There is no 1024,
  65     MODE_CASE = 2048,
  66     MODE_ACTIVITY = 4096,
  67     MODE_CAMPAIGN = 8192,
  68     MODE_MAILING = 16384,
  69     MODE_ALL = 17407;
  70
  71   /**
  72    * Constants for search operators
  73    */
  74   const
  75     SEARCH_OPERATOR_AND = 'AND',
  76     SEARCH_OPERATOR_OR = 'OR';
  77
  78   /**
  79    * The default set of return properties.
  80    *
  81    * @var array
  82    */
  83   static $_defaultReturnProperties = NULL;
  84
  85   /**
  86    * The default set of hier return properties.
  87    *
  88    * @var array
  89    */
  90   static $_defaultHierReturnProperties;
  91
  92   /**
  93    * The set of input params.
  94    *
  95    * @var array
  96    */
  97   public $_params;
  98
  99   public $_cfIDs;
 100
 101   public $_paramLookup;
 102
 103   public $_sort;
 104
 105   /**
 106    * The set of output params
 107    *
 108    * @var array
 109    */
 110   public $_returnProperties;
 111
 112   /**
 113    * The select clause
 114    *
 115    * @var array
 116    */
 117   public $_select;
 118
 119   /**
 120    * The name of the elements that are in the select clause
 121    * used to extract the values.
 122    *
 123    * @var array
 124    */
 125   public $_element;
 126
 127   /**
 128    * The tables involved in the query.
 129    *
 130    * @var array
 131    */
 132   public $_tables;
 133
 134   /**
 135    * The table involved in the where clause.
 136    *
 137    * @var array
 138    */
 139   public $_whereTables;
 140
 141   /**
 142    * Array of WHERE clause components.
 143    *
 144    * @var array
 145    */
 146   public $_where;
 147
 148   /**
 149    * The WHERE clause as a string.
 150    *
 151    * @var string
 152    */
 153   public $_whereClause;
 154
 155   /**
 156    * Additional WHERE clause for permissions.
 157    *
 158    * @var string
 159    */
 160   public $_permissionWhereClause;
 161
 162   /**
 163    * The from string
 164    *
 165    * @var string
 166    */
 167   public $_fromClause;
 168
 169   /**
 170    * Additional permission from clause
 171    *
 172    * @var string
 173    */
 174   public $_permissionFromClause;
 175
 176   /**
 177    * The from clause for the simple select and alphabetical
 178    * select
 179    *
 180    * @var string
 181    */
 182   public $_simpleFromClause;
 183
 184   /**
 185    * The having values
 186    *
 187    * @var string
 188    */
 189   public $_having;
 190
 191   /**
 192    * The english language version of the query
 193    *
 194    * @var array
 195    */
 196   public $_qill;
 197
 198   /**
 199    * All the fields that could potentially be involved in
 200    * this query
 201    *
 202    * @var array
 203    */
 204   public $_fields;
 205
 206   /**
 207    * The cache to translate the option values into labels.
 208    *
 209    * @var array
 210    */
 211   public $_options;
 212
 213   /**
 214    * Are we in search mode.
 215    *
 216    * @var boolean
 217    */
 218   public $_search = TRUE;
 219
 220   /**
 221    * Should we skip permission checking.
 222    *
 223    * @var boolean
 224    */
 225   public $_skipPermission = FALSE;
 226
 227   /**
 228    * Should we skip adding of delete clause.
 229    *
 230    * @var boolean
 231    */
 232   public $_skipDeleteClause = FALSE;
 233
 234   /**
 235    * Are we in strict mode (use equality over LIKE)
 236    *
 237    * @var boolean
 238    */
 239   public $_strict = FALSE;
 240
 241   /**
 242    * What operator to use to group the clauses.
 243    *
 244    * @var string
 245    */
 246   public $_operator = 'AND';
 247
 248   public $_mode = 1;
 249
 250   /**
 251    * Should we only search on primary location.
 252    *
 253    * @var boolean
 254    */
 255   public $_primaryLocation = TRUE;
 256
 257   /**
 258    * Are contact ids part of the query.
 259    *
 260    * @var boolean
 261    */
 262   public $_includeContactIds = FALSE;
 263
 264   /**
 265    * Should we use the smart group cache.
 266    *
 267    * @var boolean
 268    */
 269   public $_smartGroupCache = TRUE;
 270
 271   /**
 272    * Should we display contacts with a specific relationship type.
 273    *
 274    * @var string
 275    */
 276   public $_displayRelationshipType = NULL;
 277
 278   /**
 279    * Reference to the query object for custom values.
 280    *
 281    * @var Object
 282    */
 283   public $_customQuery;
 284
 285   /**
 286    * Should we enable the distinct clause, used if we are including
 287    * more than one group
 288    *
 289    * @var boolean
 290    */
 291   public $_useDistinct = FALSE;
 292
 293   /**
 294    * Should we just display one contact record
 295    */
 296   public $_useGroupBy = FALSE;
 297
 298   /**
 299    * The relationship type direction
 300    *
 301    * @var array
 302    */
 303   static $_relType;
 304
 305   /**
 306    * The activity role
 307    *
 308    * @var array
 309    */
 310   static $_activityRole;
 311
 312   /**
 313    * Consider the component activity type
 314    * during activity search.
 315    *
 316    * @var array
 317    */
 318   static $_considerCompActivities;
 319
 320   /**
 321    * Consider with contact activities only,
 322    * during activity search.
 323    *
 324    * @var array
 325    */
 326   static $_withContactActivitiesOnly;
 327
 328   /**
 329    * Use distinct component clause for component searches
 330    *
 331    * @var string
 332    */
 333   public $_distinctComponentClause;
 334
 335   public $_rowCountClause;
 336
 337   /**
 338    * Use groupBy component clause for component searches
 339    *
 340    * @var string
 341    */
 342   public $_groupByComponentClause;
 343
 344   /**
 345    * Track open panes, useful in advance search
 346    *
 347    * @var array
 348    */
 349   public static $_openedPanes = array();
 350
 351   /**
 352    * For search builder - which custom fields are location-dependent
 353    * @var array
 354    */
 355   public $_locationSpecificCustomFields = array();
 356
 357   /**
 358    * The tables which have a dependency on location and/or address
 359    *
 360    * @var array
 361    */
 362   static $_dependencies = array(
 363     'civicrm_state_province' => 1,
 364     'civicrm_country' => 1,
 365     'civicrm_county' => 1,
 366     'civicrm_address' => 1,
 367     'civicrm_location_type' => 1,
 368   );
 369
 370   /**
 371    * List of location specific fields.
 372    */
 373   static $_locationSpecificFields = array(
 374     'street_address',
 375     'street_number',
 376     'street_name',
 377     'street_unit',
 378     'supplemental_address_1',
 379     'supplemental_address_2',
 380     'supplemental_address_3',
 381     'city',
 382     'postal_code',
 383     'postal_code_suffix',
 384     'geo_code_1',
 385     'geo_code_2',
 386     'state_province',
 387     'country',
 388     'county',
 389     'phone',
 390     'email',
 391     'im',
 392     'address_name',
 393     'master_id',
 394   );
 395
 396   /**
 397    * Remember if we handle either end of a number or date range
 398    * so we can skip the other
 399    */
 400   protected $_rangeCache = array();
 401   /**
 402    * Set to true when $this->relationship is run to avoid adding twice
 403    * @var Boolean
 404    */
 405   protected $_relationshipValuesAdded = FALSE;
 406
 407   /**
 408    * Set to the name of the temp table if one has been created
 409    * @var String
 410    */
 411   static $_relationshipTempTable = NULL;
 412
 413   public $_pseudoConstantsSelect = array();
 414
 415   /**
 416    * Class constructor which also does all the work.
 417    *
 418    * @param array $params
 419    * @param array $returnProperties
 420    * @param array $fields
 421    * @param bool $includeContactIds
 422    * @param bool $strict
 423    * @param bool|int $mode - mode the search is operating on
 424    *
 425    * @param bool $skipPermission
 426    * @param bool $searchDescendentGroups
 427    * @param bool $smartGroupCache
 428    * @param null $displayRelationshipType
 429    * @param string $operator
 430    * @param string $apiEntity
 431    * @param bool|NULL $primaryLocationOnly
 432    */
 433   public function __construct(
 434     $params = NULL, $returnProperties = NULL, $fields = NULL,
 435     $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
 436     $skipPermission = FALSE, $searchDescendentGroups = TRUE,
 437     $smartGroupCache = TRUE, $displayRelationshipType = NULL,
 438     $operator = 'AND',
 439     $apiEntity = NULL,
 440     $primaryLocationOnly = NULL
 441   ) {
 442     if ($primaryLocationOnly === NULL) {
 443       $primaryLocationOnly = Civi::settings()->get('searchPrimaryDetailsOnly');
 444     }
 445     $this->_primaryLocation = $primaryLocationOnly;
 446     $this->_params = &$params;
 447     if ($this->_params == NULL) {
 448       $this->_params = array();
 449     }
 450
 451     if ($returnProperties === self::NO_RETURN_PROPERTIES) {
 452       $this->_returnProperties = array();
 453     }
 454     elseif (empty($returnProperties)) {
 455       $this->_returnProperties = self::defaultReturnProperties($mode);
 456     }
 457     else {
 458       $this->_returnProperties = &$returnProperties;
 459     }
 460
 461     $this->_includeContactIds = $includeContactIds;
 462     $this->_strict = $strict;
 463     $this->_mode = $mode;
 464     $this->_skipPermission = $skipPermission;
 465     $this->_smartGroupCache = $smartGroupCache;
 466     $this->_displayRelationshipType = $displayRelationshipType;
 467     $this->setOperator($operator);
 468
 469     if ($fields) {
 470       $this->_fields = &$fields;
 471       $this->_search = FALSE;
 472       $this->_skipPermission = TRUE;
 473     }
 474     else {
 475       $this->_fields = CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE, TRUE, FALSE, !$skipPermission);
 476
 477       $fields = CRM_Core_Component::getQueryFields(!$this->_skipPermission);
 478       unset($fields['note']);
 479       $this->_fields = array_merge($this->_fields, $fields);
 480
 481       // add activity fields
 482       $fields = CRM_Activity_BAO_Activity::exportableFields();
 483       $this->_fields = array_merge($this->_fields, $fields);
 484
 485       // add any fields provided by hook implementers
 486       $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields();
 487       $this->_fields = array_merge($this->_fields, $extFields);
 488     }
 489
 490     // basically do all the work once, and then reuse it
 491     $this->initialize($apiEntity);
 492   }
 493
 494   /**
 495    * Function which actually does all the work for the constructor.
 496    *
 497    * @param string $apiEntity
 498    *   The api entity being called.
 499    *   This sort-of duplicates $mode in a confusing way. Probably not by design.
 500    */
 501   public function initialize($apiEntity = NULL) {
 502     $this->_select = array();
 503     $this->_element = array();
 504     $this->_tables = array();
 505     $this->_whereTables = array();
 506     $this->_where = array();
 507     $this->_qill = array();
 508     $this->_options = array();
 509     $this->_cfIDs = array();
 510     $this->_paramLookup = array();
 511     $this->_having = array();
 512
 513     $this->_customQuery = NULL;
 514
 515     // reset cached static variables - CRM-5803
 516     self::$_activityRole = NULL;
 517     self::$_considerCompActivities = NULL;
 518     self::$_withContactActivitiesOnly = NULL;
 519
 520     $this->_select['contact_id'] = 'contact_a.id as contact_id';
 521     $this->_element['contact_id'] = 1;
 522     $this->_tables['civicrm_contact'] = 1;
 523
 524     if (!empty($this->_params)) {
 525       $this->buildParamsLookup();
 526     }
 527
 528     $this->_whereTables = $this->_tables;
 529
 530     $this->selectClause($apiEntity);
 531     $this->_whereClause = $this->whereClause($apiEntity);
 532     if (array_key_exists('civicrm_contribution', $this->_whereTables)) {
 533       $component = 'contribution';
 534     }
 535     if (array_key_exists('civicrm_membership', $this->_whereTables)) {
 536       $component = 'membership';
 537     }
 538     if (isset($component)) {
 539       CRM_Financial_BAO_FinancialType::buildPermissionedClause($this->_whereClause, $component);
 540     }
 541
 542     $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode, $apiEntity);
 543     $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
 544
 545     $this->openedSearchPanes(TRUE);
 546   }
 547
 548   /**
 549    * Function for same purpose as convertFormValues.
 550    *
 551    * Like convert form values this function exists to pre-Process parameters from the form.
 552    *
 553    * It is unclear why they are different functions & likely relates to advances search
 554    * versus search builder.
 555    *
 556    * The direction we are going is having the form convert values to a standardised format &
 557    * moving away from weird & wonderful where clause switches.
 558    *
 559    * Fix and handle contact deletion nicely.
 560    *
 561    * this code is primarily for search builder use case where different clauses can specify if they want deleted.
 562    *
 563    * CRM-11971
 564    */
 565   public function buildParamsLookup() {
 566     $trashParamExists = FALSE;
 567     $paramByGroup = array();
 568     foreach ($this->_params as $k => $param) {
 569       if (!empty($param[0]) && $param[0] == 'contact_is_deleted') {
 570         $trashParamExists = TRUE;
 571       }
 572       if (!empty($param[3])) {
 573         $paramByGroup[$param[3]][$k] = $param;
 574       }
 575     }
 576
 577     if ($trashParamExists) {
 578       $this->_skipDeleteClause = TRUE;
 579
 580       //cycle through group sets and explicitly add trash param if not set
 581       foreach ($paramByGroup as $setID => $set) {
 582         if (
 583           !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params) &&
 584           !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params)
 585         ) {
 586           $this->_params[] = array(
 587             'contact_is_deleted',
 588             '=',
 589             '0',
 590             $setID,
 591             '0',
 592           );
 593         }
 594       }
 595     }
 596
 597     foreach ($this->_params as $value) {
 598       if (empty($value[0])) {
 599         continue;
 600       }
 601       $cfID = CRM_Core_BAO_CustomField::getKeyID($value[0]);
 602       if ($cfID) {
 603         if (!array_key_exists($cfID, $this->_cfIDs)) {
 604           $this->_cfIDs[$cfID] = array();
 605         }
 606         // Set wildcard value based on "and/or" selection
 607         foreach ($this->_params as $key => $param) {
 608           if ($param[0] == $value[0] . '_operator') {
 609             $value[4] = $param[2] == 'or';
 610             break;
 611           }
 612         }
 613         $this->_cfIDs[$cfID][] = $value;
 614       }
 615
 616       if (!array_key_exists($value[0], $this->_paramLookup)) {
 617         $this->_paramLookup[$value[0]] = array();
 618       }
 619       if ($value[0] !== 'group') {
 620         // Just trying to unravel how group interacts here! This whole function is weird.
 621         $this->_paramLookup[$value[0]][] = $value;
 622       }
 623     }
 624   }
 625
 626   /**
 627    * Some composite fields do not appear in the fields array hack to make them part of the query.
 628    *
 629    * @param $apiEntity
 630    *   The api entity being called.
 631    *   This sort-of duplicates $mode in a confusing way. Probably not by design.
 632    */
 633   public function addSpecialFields($apiEntity) {
 634     static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
 635     // if get called via Contact.get API having address_id as return parameter
 636     if ($apiEntity == 'Contact') {
 637       $special[] = 'address_id';
 638     }
 639     foreach ($special as $name) {
 640       if (!empty($this->_returnProperties[$name])) {
 641         if ($name == 'address_id') {
 642           $this->_tables['civicrm_address'] = 1;
 643           $this->_select['address_id'] = 'civicrm_address.id as address_id';
 644           $this->_element['address_id'] = 1;
 645         }
 646         else {
 647           $this->_select[$name] = "contact_a.{$name} as $name";
 648           $this->_element[$name] = 1;
 649         }
 650       }
 651     }
 652   }
 653
 654   /**
 655    * Given a list of conditions in params and a list of desired
 656    * return Properties generate the required select and from
 657    * clauses. Note that since the where clause introduces new
 658    * tables, the initial attempt also retrieves all variables used
 659    * in the params list
 660    *
 661    * @param string $apiEntity
 662    *   The api entity being called.
 663    *   This sort-of duplicates $mode in a confusing way. Probably not by design.
 664    */
 665   public function selectClause($apiEntity = NULL) {
 666
 667     // @todo Tidy up this. This arises because 1) we are ignoring the $mode & adding a new
 668     // param ($apiEntity) instead - presumably an oversight & 2 because
 669     // contact is not implemented as a component.
 670     $this->addSpecialFields($apiEntity);
 671
 672     foreach ($this->_fields as $name => $field) {
 673       // skip component fields
 674       // there are done by the alter query below
 675       // and need not be done on every field
 676       // @todo remove these & handle using metadata - only obscure fields
 677       // that are hack-added should need to be excluded from the main loop.
 678       if (
 679         (substr($name, 0, 12) == 'participant_') ||
 680         (substr($name, 0, 7) == 'pledge_') ||
 681         (substr($name, 0, 5) == 'case_')
 682       ) {
 683         continue;
 684       }
 685
 686       // redirect to activity select clause
 687       if (
 688         (substr($name, 0, 9) == 'activity_') ||
 689         ($name == 'parent_id')
 690       ) {
 691         CRM_Activity_BAO_Query::select($this);
 692       }
 693
 694       // if this is a hierarchical name, we ignore it
 695       $names = explode('-', $name);
 696       if (count($names) > 1 && isset($names[1]) && is_numeric($names[1])) {
 697         continue;
 698       }
 699
 700       // make an exception for special cases, to add the field in select clause
 701       $makeException = FALSE;
 702
 703       //special handling for groups/tags
 704       if (in_array($name, array('groups', 'tags', 'notes'))
 705         && isset($this->_returnProperties[substr($name, 0, -1)])
 706       ) {
 707         // @todo instead of setting make exception to get us into
 708         // an if clause that has handling for these fields buried with in it
 709         // move the handling to here.
 710         $makeException = TRUE;
 711       }
 712
 713       // since note has 3 different options we need special handling
 714       // note / note_subject / note_body
 715       if ($name == 'notes') {
 716         foreach (array('note', 'note_subject', 'note_body') as $noteField) {
 717           if (isset($this->_returnProperties[$noteField])) {
 718             $makeException = TRUE;
 719             break;
 720           }
 721         }
 722       }
 723
 724       $cfID = CRM_Core_BAO_CustomField::getKeyID($name);
 725       if (
 726         !empty($this->_paramLookup[$name])
 727         || !empty($this->_returnProperties[$name])
 728         || $this->pseudoConstantNameIsInReturnProperties($field)
 729         || $makeException
 730       ) {
 731         if ($cfID) {
 732           // add to cfIDs array if not present
 733           if (!array_key_exists($cfID, $this->_cfIDs)) {
 734             $this->_cfIDs[$cfID] = array();
 735           }
 736         }
 737         elseif (isset($field['where'])) {
 738           list($tableName, $fieldName) = explode('.', $field['where'], 2);
 739           if (isset($tableName)) {
 740             if (CRM_Utils_Array::value($tableName, self::$_dependencies)) {
 741               $this->_tables['civicrm_address'] = 1;
 742               $this->_select['address_id'] = 'civicrm_address.id as address_id';
 743               $this->_element['address_id'] = 1;
 744             }
 745
 746             if ($tableName == 'im_provider' || $tableName == 'email_greeting' ||
 747               $tableName == 'postal_greeting' || $tableName == 'addressee'
 748             ) {
 749               if ($tableName == 'im_provider') {
 750                 CRM_Core_OptionValue::select($this);
 751               }
 752
 753               if (in_array($tableName,
 754                 array('email_greeting', 'postal_greeting', 'addressee'))) {
 755                 $this->_element["{$name}_id"] = 1;
 756                 $this->_select["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
 757                 $this->_pseudoConstantsSelect[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
 758                 $this->_pseudoConstantsSelect[$name]['select'] = "{$name}.{$fieldName} as $name";
 759                 $this->_pseudoConstantsSelect[$name]['element'] = $name;
 760
 761                 if ($tableName == 'email_greeting') {
 762                   // @todo bad join.
 763                   $this->_pseudoConstantsSelect[$name]['join']
 764                     = " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
 765                   $this->_pseudoConstantsSelect[$name]['join'] .=
 766                     " LEFT 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 ) ";
 767                 }
 768                 elseif ($tableName == 'postal_greeting') {
 769                   // @todo bad join.
 770                   $this->_pseudoConstantsSelect[$name]['join']
 771                     = " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
 772                   $this->_pseudoConstantsSelect[$name]['join'] .=
 773                     " LEFT 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 ) ";
 774                 }
 775                 elseif ($tableName == 'addressee') {
 776                   // @todo bad join.
 777                   $this->_pseudoConstantsSelect[$name]['join']
 778                     = " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
 779                   $this->_pseudoConstantsSelect[$name]['join'] .=
 780                     " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
 781                 }
 782                 $this->_pseudoConstantsSelect[$name]['table'] = $tableName;
 783
 784                 //get display
 785                 $greetField = "{$name}_display";
 786                 $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}";
 787                 $this->_element[$greetField] = 1;
 788                 //get custom
 789                 $greetField = "{$name}_custom";
 790                 $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}";
 791                 $this->_element[$greetField] = 1;
 792               }
 793             }
 794             else {
 795               if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
 796                 $this->_tables[$tableName] = 1;
 797               }
 798
 799               // also get the id of the tableName
 800               $tName = substr($tableName, 8);
 801               if (in_array($tName, array('country', 'state_province', 'county'))) {
 802                 if ($tName == 'state_province') {
 803                   $this->_pseudoConstantsSelect['state_province_name'] = array(
 804                     'pseudoField' => "{$tName}",
 805                     'idCol' => "{$tName}_id",
 806                     'bao' => 'CRM_Core_BAO_Address',
 807                     'table' => "civicrm_{$tName}",
 808                     'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
 809                   );
 810
 811                   $this->_pseudoConstantsSelect[$tName] = array(
 812                     'pseudoField' => 'state_province_abbreviation',
 813                     'idCol' => "{$tName}_id",
 814                     'table' => "civicrm_{$tName}",
 815                     'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
 816                   );
 817                 }
 818                 else {
 819                   $this->_pseudoConstantsSelect[$name] = array(
 820                     'pseudoField' => "{$tName}_id",
 821                     'idCol' => "{$tName}_id",
 822                     'bao' => 'CRM_Core_BAO_Address',
 823                     'table' => "civicrm_{$tName}",
 824                     'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
 825                   );
 826                 }
 827
 828                 $this->_select["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
 829                 $this->_element["{$tName}_id"] = 1;
 830               }
 831               elseif ($tName != 'contact') {
 832                 $this->_select["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
 833                 $this->_element["{$tName}_id"] = 1;
 834               }
 835
 836               //special case for phone
 837               if ($name == 'phone') {
 838                 $this->_select['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
 839                 $this->_element['phone_type_id'] = 1;
 840               }
 841
 842               // if IM then select provider_id also
 843               // to get "IM Service Provider" in a file to be exported, CRM-3140
 844               if ($name == 'im') {
 845                 $this->_select['provider_id'] = "civicrm_im.provider_id as provider_id";
 846                 $this->_element['provider_id'] = 1;
 847               }
 848
 849               if ($tName == 'contact' && $fieldName == 'organization_name') {
 850                 // special case, when current employer is set for Individual contact
 851                 $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
 852               }
 853               elseif ($tName == 'contact' && $fieldName === 'id') {
 854                 // Handled elsewhere, explicitly ignore. Possibly for all tables...
 855               }
 856               elseif (in_array($tName, array('country', 'county'))) {
 857                 $this->_pseudoConstantsSelect[$name]['select'] = "{$field['where']} as `$name`";
 858                 $this->_pseudoConstantsSelect[$name]['element'] = $name;
 859               }
 860               elseif ($tName == 'state_province') {
 861                 $this->_pseudoConstantsSelect[$tName]['select'] = "{$field['where']} as `$name`";
 862                 $this->_pseudoConstantsSelect[$tName]['element'] = $name;
 863               }
 864               elseif (strpos($name, 'contribution_soft_credit') !== FALSE) {
 865                 if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($this->_params)) {
 866                   $this->_select[$name] = "{$field['where']} as `$name`";
 867                 }
 868               }
 869               else {
 870                 // If we have an option group defined then rather than joining the option value table in
 871                 // (which is an unindexed join) we render the option value on output.
 872                 // @todo - extend this to other pseudoconstants.
 873                 if ($this->pseudoConstantNameIsInReturnProperties($field, $name)) {
 874                   $pseudoFieldName = $field['pseudoconstant']['optionGroupName'];
 875                   $this->_pseudoConstantsSelect[$pseudoFieldName] = array(
 876                     'pseudoField' => $field['name'],
 877                     'idCol' => $name,
 878                     'field_name' => $field['name'],
 879                     'bao' => $field['bao'],
 880                     'pseudoconstant' => $field['pseudoconstant'],
 881                   );
 882                   $this->_tables[$tableName] = 1;
 883                   $this->_element[$pseudoFieldName] = 1;
 884                 }
 885                 $this->_select[$name] = str_replace('civicrm_contact.', 'contact_a.', "{$field['where']} as `$name`");
 886               }
 887               if (!in_array($tName, array('state_province', 'country', 'county'))) {
 888                 $this->_element[$name] = 1;
 889               }
 890             }
 891           }
 892         }
 893         elseif ($name === 'tags') {
 894           //@todo move this handling outside the big IF & ditch $makeException
 895           $this->_useGroupBy = TRUE;
 896           $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
 897           $this->_element[$name] = 1;
 898           $this->_tables['civicrm_tag'] = 1;
 899           $this->_tables['civicrm_entity_tag'] = 1;
 900         }
 901         elseif ($name === 'groups') {
 902           //@todo move this handling outside the big IF & ditch $makeException
 903           $this->_useGroupBy = TRUE;
 904           // Duplicates will be created here but better to sort them out in php land.
 905           $this->_select[$name] = "
 906             CONCAT_WS(',',
 907             GROUP_CONCAT(DISTINCT IF(civicrm_group_contact.status = 'Added', civicrm_group_contact.group_id, '')),
 908             GROUP_CONCAT(DISTINCT civicrm_group_contact_cache.group_id)
 909           )
 910           as groups";
 911           $this->_element[$name] = 1;
 912           $this->_tables['civicrm_group_contact'] = 1;
 913           $this->_tables['civicrm_group_contact_cache'] = 1;
 914           $this->_pseudoConstantsSelect["{$name}"] = array(
 915             'pseudoField' => "groups",
 916             'idCol' => "groups",
 917           );
 918         }
 919         elseif ($name === 'notes') {
 920           //@todo move this handling outside the big IF & ditch $makeException
 921           // if note field is subject then return subject else body of the note
 922           $noteColumn = 'note';
 923           if (isset($noteField) && $noteField == 'note_subject') {
 924             $noteColumn = 'subject';
 925           }
 926
 927           $this->_useGroupBy = TRUE;
 928           $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
 929           $this->_element[$name] = 1;
 930           $this->_tables['civicrm_note'] = 1;
 931         }
 932         elseif ($name === 'current_employer') {
 933           $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
 934           $this->_element[$name] = 1;
 935         }
 936       }
 937
 938       if ($cfID && !empty($field['is_search_range'])) {
 939         // this is a custom field with range search enabled, so we better check for two/from values
 940         if (!empty($this->_paramLookup[$name . '_from'])) {
 941           if (!array_key_exists($cfID, $this->_cfIDs)) {
 942             $this->_cfIDs[$cfID] = array();
 943           }
 944           foreach ($this->_paramLookup[$name . '_from'] as $pID => $p) {
 945             // search in the cdID array for the same grouping
 946             $fnd = FALSE;
 947             foreach ($this->_cfIDs[$cfID] as $cID => $c) {
 948               if ($c[3] == $p[3]) {
 949                 $this->_cfIDs[$cfID][$cID][2]['from'] = $p[2];
 950                 $fnd = TRUE;
 951               }
 952             }
 953             if (!$fnd) {
 954               $p[2] = array('from' => $p[2]);
 955               $this->_cfIDs[$cfID][] = $p;
 956             }
 957           }
 958         }
 959         if (!empty($this->_paramLookup[$name . '_to'])) {
 960           if (!array_key_exists($cfID, $this->_cfIDs)) {
 961             $this->_cfIDs[$cfID] = array();
 962           }
 963           foreach ($this->_paramLookup[$name . '_to'] as $pID => $p) {
 964             // search in the cdID array for the same grouping
 965             $fnd = FALSE;
 966             foreach ($this->_cfIDs[$cfID] as $cID => $c) {
 967               if ($c[4] == $p[4]) {
 968                 $this->_cfIDs[$cfID][$cID][2]['to'] = $p[2];
 969                 $fnd = TRUE;
 970               }
 971             }
 972             if (!$fnd) {
 973               $p[2] = array('to' => $p[2]);
 974               $this->_cfIDs[$cfID][] = $p;
 975             }
 976           }
 977         }
 978       }
 979     }
 980
 981     // add location as hierarchical elements
 982     $this->addHierarchicalElements();
 983
 984     // add multiple field like website
 985     $this->addMultipleElements();
 986
 987     //fix for CRM-951
 988     CRM_Core_Component::alterQuery($this, 'select');
 989
 990     CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'select');
 991
 992     if (!empty($this->_cfIDs)) {
 993       // @todo This function is the select function but instead of running 'select' it
 994       // is running the whole query.
 995       $this->_customQuery = new CRM_Core_BAO_CustomQuery($this->_cfIDs, TRUE, $this->_locationSpecificCustomFields);
 996       $this->_customQuery->query();
 997       $this->_select = array_merge($this->_select, $this->_customQuery->_select);
 998       $this->_element = array_merge($this->_element, $this->_customQuery->_element);
 999       $this->_tables = array_merge($this->_tables, $this->_customQuery->_tables);
1000       $this->_whereTables = array_merge($this->_whereTables, $this->_customQuery->_whereTables);
1001       $this->_options = $this->_customQuery->_options;
1002     }
1003   }
1004
1005   /**
1006    * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values.
1007    */
1008   public function addHierarchicalElements() {
1009     if (empty($this->_returnProperties['location'])) {
1010       return;
1011     }
1012     if (!is_array($this->_returnProperties['location'])) {
1013       return;
1014     }
1015
1016     $locationTypes = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate');
1017     $processed = array();
1018     $index = 0;
1019
1020     $addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address');
1021     $addressCustomFieldIds = array();
1022
1023     foreach ($this->_returnProperties['location'] as $name => $elements) {
1024       $lCond = self::getPrimaryCondition($name);
1025
1026       if (!$lCond) {
1027         $locationTypeId = array_search($name, $locationTypes);
1028         if ($locationTypeId === FALSE) {
1029           continue;
1030         }
1031         $lCond = "location_type_id = $locationTypeId";
1032         $this->_useDistinct = TRUE;
1033
1034         //commented for CRM-3256
1035         $this->_useGroupBy = TRUE;
1036       }
1037
1038       $name = str_replace(' ', '_', $name);
1039
1040       $tName = "$name-location_type";
1041       $ltName = "`$name-location_type`";
1042       $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1043       $this->_select["{$tName}"] = "`$tName`.name as `{$tName}`";
1044       $this->_element["{$tName}_id"] = 1;
1045       $this->_element["{$tName}"] = 1;
1046
1047       $locationTypeName = $tName;
1048       $locationTypeJoin = array();
1049
1050       $addAddress = FALSE;
1051       $addWhereCount = 0;
1052       foreach ($elements as $elementFullName => $dontCare) {
1053         $index++;
1054         $elementName = $elementCmpName = $elementFullName;
1055
1056         if (substr($elementCmpName, 0, 5) == 'phone') {
1057           $elementCmpName = 'phone';
1058         }
1059
1060         if (in_array($elementCmpName, array_keys($addressCustomFields))) {
1061           if ($cfID = CRM_Core_BAO_CustomField::getKeyID($elementCmpName)) {
1062             $addressCustomFieldIds[$cfID][$name] = 1;
1063           }
1064         }
1065         //add address table only once
1066         if ((in_array($elementCmpName, self::$_locationSpecificFields) || !empty($addressCustomFieldIds))
1067           && !$addAddress
1068           && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
1069         ) {
1070           $tName = "$name-address";
1071           $aName = "`$name-address`";
1072           $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1073           $this->_element["{$tName}_id"] = 1;
1074           $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
1075           $this->_tables[$tName] = $addressJoin;
1076           $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
1077           $processed[$aName] = 1;
1078           $addAddress = TRUE;
1079         }
1080
1081         $cond = $elementType = '';
1082         if (strpos($elementName, '-') !== FALSE) {
1083           // this is either phone, email or IM
1084           list($elementName, $elementType) = explode('-', $elementName);
1085
1086           if (($elementName != 'phone') && ($elementName != 'im')) {
1087             $cond = self::getPrimaryCondition($elementType);
1088           }
1089           // CRM-13011 : If location type is primary, do not restrict search to the phone
1090           // type id - we want the primary phone, regardless of what type it is.
1091           // Otherwise, restrict to the specified phone type for the given field.
1092           if ((!$cond) && ($elementName == 'phone')) {
1093             $cond = "phone_type_id = '$elementType'";
1094           }
1095           elseif ((!$cond) && ($elementName == 'im')) {
1096             // IM service provider id, CRM-3140
1097             $cond = "provider_id = '$elementType'";
1098           }
1099           $elementType = '-' . $elementType;
1100         }
1101
1102         $field = CRM_Utils_Array::value($elementName, $this->_fields);
1103
1104         // hack for profile, add location id
1105         if (!$field) {
1106           if ($elementType &&
1107             // fix for CRM-882( to handle phone types )
1108             !is_numeric($elementType)
1109           ) {
1110             if (is_numeric($name)) {
1111               $field = CRM_Utils_Array::value($elementName . "-Primary$elementType", $this->_fields);
1112             }
1113             else {
1114               $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields);
1115             }
1116           }
1117           elseif (is_numeric($name)) {
1118             //this for phone type to work
1119             if (in_array($elementName, array('phone', 'phone_ext'))) {
1120               $field = CRM_Utils_Array::value($elementName . "-Primary" . $elementType, $this->_fields);
1121             }
1122             else {
1123               $field = CRM_Utils_Array::value($elementName . "-Primary", $this->_fields);
1124             }
1125           }
1126           else {
1127             //this is for phone type to work for profile edit
1128             if (in_array($elementName, array('phone', 'phone_ext'))) {
1129               $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields);
1130             }
1131             else {
1132               $field = CRM_Utils_Array::value($elementName . "-$locationTypeId", $this->_fields);
1133             }
1134           }
1135         }
1136
1137         // Check if there is a value, if so also add to where Clause
1138         $addWhere = FALSE;
1139         if ($this->_params) {
1140           $nm = $elementName;
1141           if (isset($locationTypeId)) {
1142             $nm .= "-$locationTypeId";
1143           }
1144           if (!is_numeric($elementType)) {
1145             $nm .= "$elementType";
1146           }
1147
1148           foreach ($this->_params as $id => $values) {
1149             if ((is_array($values) && $values[0] == $nm) ||
1150               (in_array($elementName, array('phone', 'im'))
1151                 && (strpos($values[0], $nm) !== FALSE)
1152               )
1153             ) {
1154               $addWhere = TRUE;
1155               $addWhereCount++;
1156               break;
1157             }
1158           }
1159         }
1160
1161         if ($field && isset($field['where'])) {
1162           list($tableName, $fieldName) = explode('.', $field['where'], 2);
1163           $pf = substr($tableName, 8);
1164           $tName = $name . '-' . $pf . $elementType;
1165           if (isset($tableName)) {
1166             if ($tableName == 'civicrm_state_province' || $tableName == 'civicrm_country' || $tableName == 'civicrm_county') {
1167               $this->_select["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1168             }
1169             else {
1170               $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1171             }
1172
1173             $this->_element["{$tName}_id"] = 1;
1174             if (substr($tName, -15) == '-state_province') {
1175               // FIXME: hack to fix CRM-1900
1176               $a = Civi::settings()->get('address_format');
1177
1178               if (substr_count($a, 'state_province_name') > 0) {
1179                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array(
1180                   'pseudoField' => "{$pf}_id",
1181                   'idCol' => "{$tName}_id",
1182                   'bao' => 'CRM_Core_BAO_Address',
1183                 );
1184                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1185               }
1186               else {
1187                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array(
1188                   'pseudoField' => 'state_province_abbreviation',
1189                   'idCol' => "{$tName}_id",
1190                 );
1191                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1192               }
1193             }
1194             else {
1195               if (substr($elementFullName, 0, 2) == 'im') {
1196                 $provider = "{$name}-{$elementFullName}-provider_id";
1197                 $this->_select[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1198                 $this->_element[$provider] = 1;
1199               }
1200               if ($pf == 'country' || $pf == 'county') {
1201                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array(
1202                   'pseudoField' => "{$pf}_id",
1203                   'idCol' => "{$tName}_id",
1204                   'bao' => 'CRM_Core_BAO_Address',
1205                 );
1206                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1207               }
1208               else {
1209                 $this->_select["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1210               }
1211             }
1212
1213             if (in_array($pf, array('state_province', 'country', 'county'))) {
1214               $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1215             }
1216             else {
1217               $this->_element["{$name}-{$elementFullName}"] = 1;
1218             }
1219
1220             if (empty($processed["`$tName`"])) {
1221               $processed["`$tName`"] = 1;
1222               $newName = $tableName . '_' . $index;
1223               switch ($tableName) {
1224                 case 'civicrm_phone':
1225                 case 'civicrm_email':
1226                 case 'civicrm_im':
1227                 case 'civicrm_openid':
1228
1229                   $this->_tables[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id";
1230                   if ($tableName != 'civicrm_phone') {
1231                     $this->_tables[$tName] .= " AND `$tName`.$lCond";
1232                   }
1233                   elseif (is_numeric($name)) {
1234                     $this->_select[$tName] = "IF (`$tName`.is_primary = $name, `$tName`.phone, NULL) as `$tName`";
1235                   }
1236
1237                   // this special case to add phone type
1238                   if ($cond) {
1239                     $phoneTypeCondition = " AND `$tName`.$cond ";
1240                     //gross hack to pickup corrupted data also, CRM-7603
1241                     if (strpos($cond, 'phone_type_id') !== FALSE) {
1242                       $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1243                       if (!empty($lCond)) {
1244                         $phoneTypeCondition .= " AND ( `$tName`.$lCond ) ";
1245                       }
1246                     }
1247                     $this->_tables[$tName] .= $phoneTypeCondition;
1248                   }
1249
1250                   //build locationType join
1251                   $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1252
1253                   if ($addWhere) {
1254                     $this->_whereTables[$tName] = $this->_tables[$tName];
1255                   }
1256                   break;
1257
1258                 case 'civicrm_state_province':
1259                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $tName;
1260                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join']
1261                     = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1262                   if ($addWhere) {
1263                     $this->_whereTables["{$name}-address"] = $addressJoin;
1264                   }
1265                   break;
1266
1267                 case 'civicrm_country':
1268                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $newName;
1269                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join']
1270                     = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1271                   if ($addWhere) {
1272                     $this->_whereTables["{$name}-address"] = $addressJoin;
1273                   }
1274                   break;
1275
1276                 case 'civicrm_county':
1277                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $newName;
1278                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join']
1279                     = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1280                   if ($addWhere) {
1281                     $this->_whereTables["{$name}-address"] = $addressJoin;
1282                   }
1283                   break;
1284
1285                 default:
1286                   if ($addWhere) {
1287                     $this->_whereTables["{$name}-address"] = $addressJoin;
1288                   }
1289                   break;
1290               }
1291             }
1292           }
1293         }
1294       }
1295
1296       // add location type  join
1297       $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1298       $this->_tables[$locationTypeName] = $ltypeJoin;
1299
1300       // table should be present in $this->_whereTables,
1301       // to add its condition in location type join, CRM-3939.
1302       if ($addWhereCount) {
1303         $locClause = array();
1304         foreach ($this->_whereTables as $tableName => $clause) {
1305           if (!empty($locationTypeJoin[$tableName])) {
1306             $locClause[] = $locationTypeJoin[$tableName];
1307           }
1308         }
1309
1310         if (!empty($locClause)) {
1311           $this->_whereTables[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1312         }
1313       }
1314     }
1315
1316     if (!empty($addressCustomFieldIds)) {
1317       $customQuery = new CRM_Core_BAO_CustomQuery($addressCustomFieldIds);
1318       foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1319         foreach ($locTypeName as $name => $dnc) {
1320           $this->_locationSpecificCustomFields[$cfID] = array($name, array_search($name, $locationTypes));
1321           $fieldName = "$name-custom_{$cfID}";
1322           $tName = "$name-address-custom-{$cfID}";
1323           $aName = "`$name-address-custom-{$cfID}`";
1324           $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1325           $this->_element["{$tName}_id"] = 1;
1326           $this->_select[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1327           $this->_element[$fieldName] = 1;
1328           $this->_tables[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1329         }
1330       }
1331     }
1332   }
1333
1334   /**
1335    * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values.
1336    */
1337   public function addMultipleElements() {
1338     if (empty($this->_returnProperties['website'])) {
1339       return;
1340     }
1341     if (!is_array($this->_returnProperties['website'])) {
1342       return;
1343     }
1344
1345     foreach ($this->_returnProperties['website'] as $key => $elements) {
1346       foreach ($elements as $elementFullName => $dontCare) {
1347         $tName = "website-{$key}-{$elementFullName}";
1348         $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1349         $this->_select["{$tName}"] = "`$tName`.url as `{$tName}`";
1350         $this->_element["{$tName}_id"] = 1;
1351         $this->_element["{$tName}"] = 1;
1352
1353         $type = "website-{$key}-website_type_id";
1354         $this->_select[$type] = "`$tName`.website_type_id as `{$type}`";
1355         $this->_element[$type] = 1;
1356         $this->_tables[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id AND `$tName`.website_type_id = $key )";
1357       }
1358     }
1359   }
1360
1361   /**
1362    * Generate the query based on what type of query we need.
1363    *
1364    * @param bool $count
1365    * @param bool $sortByChar
1366    * @param bool $groupContacts
1367    * @param bool $onlyDeleted
1368    *
1369    * @return array
1370    *   sql query parts as an array
1371    */
1372   public function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE, $onlyDeleted = FALSE) {
1373     // build permission clause
1374     $this->generatePermissionClause($onlyDeleted, $count);
1375
1376     if ($count) {
1377       if (isset($this->_rowCountClause)) {
1378         $select = "SELECT {$this->_rowCountClause}";
1379       }
1380       elseif (isset($this->_distinctComponentClause)) {
1381         // we add distinct to get the right count for components
1382         // for the more complex result set, we use GROUP BY the same id
1383         // CRM-9630
1384         $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} ) as rowCount";
1385       }
1386       else {
1387         $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1388       }
1389       $from = $this->_simpleFromClause;
1390       if ($this->_useDistinct) {
1391         $this->_useGroupBy = TRUE;
1392       }
1393     }
1394     elseif ($sortByChar) {
1395       $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1396       $from = $this->_simpleFromClause;
1397     }
1398     elseif ($groupContacts) {
1399       $select = 'SELECT contact_a.id as id';
1400       if ($this->_useDistinct) {
1401         $this->_useGroupBy = TRUE;
1402       }
1403       $from = $this->_simpleFromClause;
1404     }
1405     else {
1406       if (!empty($this->_paramLookup['group'])) {
1407
1408         list($name, $op, $value, $grouping, $wildcard) = $this->_paramLookup['group'][0];
1409
1410         if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
1411           $this->_paramLookup['group'][0][1] = key($value);
1412         }
1413
1414         // Presumably the lines below come into manage groups screen.
1415         // make sure there is only one element
1416         // this is used when we are running under smog and need to know
1417         // how the contact was added (CRM-1203)
1418         $groups = (array) CRM_Utils_Array::value($this->_paramLookup['group'][0][1], $this->_paramLookup['group'][0][2], $this->_paramLookup['group'][0][2]);
1419         if ((count($this->_paramLookup['group']) == 1) &&
1420           (count($groups) == 1)
1421         ) {
1422           $groupId = $groups[0];
1423
1424           //check if group is saved search
1425           $group = new CRM_Contact_BAO_Group();
1426           $group->id = $groupId;
1427           $group->find(TRUE);
1428
1429           if (!isset($group->saved_search_id)) {
1430             $tbName = "`civicrm_group_contact-{$groupId}`";
1431             // CRM-17254 don't retrieve extra fields if contact_id is specifically requested
1432             // as this will add load to an intentionally light query.
1433             // ideally this code would be removed as it appears to be to support CRM-1203
1434             // and passing in the required returnProperties from the url would
1435             // make more sense that globally applying the requirements of one form.
1436             if (($this->_returnProperties != array('contact_id'))) {
1437               $this->_select['group_contact_id'] = "$tbName.id as group_contact_id";
1438               $this->_element['group_contact_id'] = 1;
1439               $this->_select['status'] = "$tbName.status as status";
1440               $this->_element['status'] = 1;
1441             }
1442           }
1443         }
1444         $this->_useGroupBy = TRUE;
1445       }
1446       if ($this->_useDistinct && !isset($this->_distinctComponentClause)) {
1447         if (!($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY)) {
1448           // CRM-5954
1449           $this->_select['contact_id'] = 'contact_a.id as contact_id';
1450           $this->_useDistinct = FALSE;
1451           $this->_useGroupBy = TRUE;
1452         }
1453       }
1454
1455       $select = $this->getSelect();
1456       $from = $this->_fromClause;
1457     }
1458
1459     $where = '';
1460     if (!empty($this->_whereClause)) {
1461       $where = "WHERE {$this->_whereClause}";
1462     }
1463
1464     if (!empty($this->_permissionWhereClause) && empty($this->_displayRelationshipType)) {
1465       if (empty($where)) {
1466         $where = "WHERE $this->_permissionWhereClause";
1467       }
1468       else {
1469         $where = "$where AND $this->_permissionWhereClause";
1470       }
1471     }
1472
1473     $having = '';
1474     if (!empty($this->_having)) {
1475       foreach ($this->_having as $havingSets) {
1476         foreach ($havingSets as $havingSet) {
1477           $havingValue[] = $havingSet;
1478         }
1479       }
1480       $having = ' HAVING ' . implode(' AND ', $havingValue);
1481     }
1482
1483     // if we are doing a transform, do it here
1484     // use the $from, $where and $having to get the contact ID
1485     if ($this->_displayRelationshipType) {
1486       $this->filterRelatedContacts($from, $where, $having);
1487     }
1488
1489     return array($select, $from, $where, $having);
1490   }
1491
1492   /**
1493    * Get where values from the parameters.
1494    *
1495    * @param string $name
1496    * @param mixed $grouping
1497    *
1498    * @return mixed
1499    */
1500   public function getWhereValues($name, $grouping) {
1501     $result = NULL;
1502     foreach ($this->_params as $values) {
1503       if ($values[0] == $name && $values[3] == $grouping) {
1504         return $values;
1505       }
1506     }
1507
1508     return $result;
1509   }
1510
1511   /**
1512    * Fix date values.
1513    *
1514    * @param bool $relative
1515    * @param string $from
1516    * @param string $to
1517    */
1518   public static function fixDateValues($relative, &$from, &$to) {
1519     if ($relative) {
1520       list($from, $to) = CRM_Utils_Date::getFromTo($relative, $from, $to);
1521     }
1522   }
1523
1524   /**
1525    * Convert values from form-appropriate to query-object appropriate.
1526    *
1527    * The query object is increasingly supporting the sql-filter syntax which is the most flexible syntax.
1528    * So, ideally we would convert all fields to look like
1529    *  array(
1530    *   0 => $fieldName
1531    *   // Set the operator for legacy reasons, but it is ignored
1532    *   1 =>  '='
1533    *   // array in sql filter syntax
1534    *   2 => array('BETWEEN' => array(1,60),
1535    *   3 => null
1536    *   4 => null
1537    *  );
1538    *
1539    * There are some examples of the syntax in
1540    * https://github.com/civicrm/civicrm-core/tree/master/api/v3/examples/Relationship
1541    *
1542    * More notes at CRM_Core_DAO::createSQLFilter
1543    *
1544    * and a list of supported operators in CRM_Core_DAO
1545    *
1546    * @param array $formValues
1547    * @param int $wildcard
1548    * @param bool $useEquals
1549    *
1550    * @param string $apiEntity
1551    *
1552    * @param array $entityReferenceFields
1553    *   Field names of any entity reference fields (which will need reformatting to IN syntax).
1554    *
1555    * @return array
1556    */
1557   public static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL,
1558     $entityReferenceFields = array()) {
1559     $params = array();
1560     if (empty($formValues)) {
1561       return $params;
1562     }
1563
1564     self::filterCountryFromValuesIfStateExists($formValues);
1565
1566     // Handle relative dates first
1567     foreach (array_keys($formValues) as $id) {
1568       if (preg_match('/_date_relative$/', $id) ||
1569         $id == 'event_relative' ||
1570         $id == 'case_from_relative' ||
1571         $id == 'case_to_relative' ||
1572         $id == 'participant_relative'
1573       ) {
1574         if ($id == 'event_relative') {
1575           $fromRange = 'event_start_date_low';
1576           $toRange = 'event_end_date_high';
1577         }
1578         elseif ($id == 'participant_relative') {
1579           $fromRange = 'participant_register_date_low';
1580           $toRange = 'participant_register_date_high';
1581         }
1582         elseif ($id == 'case_from_relative') {
1583           $fromRange = 'case_from_start_date_low';
1584           $toRange = 'case_from_start_date_high';
1585         }
1586         elseif ($id == 'case_to_relative') {
1587           $fromRange = 'case_to_end_date_low';
1588           $toRange = 'case_to_end_date_high';
1589         }
1590         else {
1591           $dateComponent = explode('_date_relative', $id);
1592           $fromRange = "{$dateComponent[0]}_date_low";
1593           $toRange = "{$dateComponent[0]}_date_high";
1594         }
1595
1596         if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1597           CRM_Contact_BAO_Query::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1598         }
1599       }
1600     }
1601
1602     foreach ($formValues as $id => $values) {
1603       if (self::isAlreadyProcessedForQueryFormat($values)) {
1604         $params[] = $values;
1605         continue;
1606       }
1607
1608       self::legacyConvertFormValues($id, $values);
1609
1610       // The form uses 1 field to represent two db fields
1611       if ($id == 'contact_type' && $values && (!is_array($values) || !array_intersect(array_keys($values), CRM_Core_DAO::acceptedSQLOperators()))) {
1612         $contactType = array();
1613         $subType = array();
1614         foreach ((array) $values as $key => $type) {
1615           $types = explode('__', is_numeric($type) ? $key : $type, 2);
1616           $contactType[$types[0]] = $types[0];
1617           // Add sub-type if specified
1618           if (!empty($types[1])) {
1619             $subType[$types[1]] = $types[1];
1620           }
1621         }
1622         $params[] = array('contact_type', 'IN', $contactType, 0, 0);
1623         if ($subType) {
1624           $params[] = array('contact_sub_type', 'IN', $subType, 0, 0);
1625         }
1626       }
1627       elseif ($id == 'privacy') {
1628         if (is_array($formValues['privacy'])) {
1629           $op = !empty($formValues['privacy']['do_not_toggle']) ? '=' : '!=';
1630           foreach ($formValues['privacy'] as $key => $value) {
1631             if ($value) {
1632               $params[] = array($key, $op, $value, 0, 0);
1633             }
1634           }
1635         }
1636       }
1637       elseif ($id == 'email_on_hold') {
1638         if ($formValues['email_on_hold']['on_hold']) {
1639           $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1640         }
1641       }
1642       elseif (substr($id, 0, 7) == 'custom_'
1643         &&  (
1644           substr($id, -9, 9) == '_relative'
1645           || substr($id, -5, 5) == '_from'
1646           || substr($id, -3, 3) == '_to'
1647         )
1648       ) {
1649         self::convertCustomRelativeFields($formValues, $params, $values, $id);
1650       }
1651       elseif (preg_match('/_date_relative$/', $id) ||
1652         $id == 'event_relative' ||
1653         $id == 'case_from_relative' ||
1654         $id == 'case_to_relative' ||
1655         $id == 'participant_relative'
1656       ) {
1657         // Already handled in previous loop
1658         continue;
1659       }
1660       elseif (in_array($id, $entityReferenceFields) && !empty($values) && is_string($values) && (strpos($values, ',') !=
1661         FALSE)) {
1662         $params[] = array($id, 'IN', explode(',', $values), 0, 0);
1663       }
1664       else {
1665         $values = CRM_Contact_BAO_Query::fixWhereValues($id, $values, $wildcard, $useEquals, $apiEntity);
1666
1667         if (!$values) {
1668           continue;
1669         }
1670         $params[] = $values;
1671       }
1672     }
1673     return $params;
1674   }
1675
1676   /**
1677    * Function to support legacy format for groups and tags.
1678    *
1679    * @param string $id
1680    * @param array|int $values
1681    *
1682    */
1683   public static function legacyConvertFormValues($id, &$values) {
1684     $legacyElements = array(
1685       'group',
1686       'tag',
1687       'contact_tags',
1688       'contact_type',
1689       'membership_type_id',
1690       'membership_status_id',
1691     );
1692     if (in_array($id, $legacyElements) && is_array($values)) {
1693       // prior to 4.7, formValues for some attributes (e.g. group, tag) are stored in array(id1 => 1, id2 => 1),
1694       // as per the recent Search fixes $values need to be in standard array(id1, id2) format
1695       $values = CRM_Utils_Array::convertCheckboxFormatToArray($values);
1696     }
1697   }
1698
1699   /**
1700    * Fix values from query from/to something no-one cared enough to document.
1701    *
1702    * @param int $id
1703    * @param array $values
1704    * @param int $wildcard
1705    * @param bool $useEquals
1706    *
1707    * @param string $apiEntity
1708    *
1709    * @return array|null
1710    */
1711   public static function fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) {
1712     // skip a few search variables
1713     static $skipWhere = NULL;
1714     static $likeNames = NULL;
1715     $result = NULL;
1716
1717     // Change camelCase EntityName to lowercase with underscores
1718     $apiEntity = _civicrm_api_get_entity_name_from_camel($apiEntity);
1719
1720     // check if $value is in OK (Operator as Key) format as used by Get API
1721     if (CRM_Utils_System::isNull($values)) {
1722       return $result;
1723     }
1724
1725     if (!$skipWhere) {
1726       $skipWhere = array(
1727         'task',
1728         'radio_ts',
1729         'uf_group_id',
1730         'component_mode',
1731         'qfKey',
1732         'operator',
1733         'display_relationship_type',
1734       );
1735     }
1736
1737     if (in_array($id, $skipWhere) ||
1738       substr($id, 0, 4) == '_qf_' ||
1739       substr($id, 0, 7) == 'hidden_'
1740     ) {
1741       return $result;
1742     }
1743
1744     if ($apiEntity &&
1745       (substr($id, 0, strlen($apiEntity)) != $apiEntity) &&
1746       (substr($id, 0, 10) != 'financial_' && substr($id, 0, 8) != 'payment_') &&
1747       (substr($id, 0, 7) != 'custom_')
1748     ) {
1749       $id = $apiEntity . '_' . $id;
1750     }
1751
1752     if (!$likeNames) {
1753       $likeNames = array('sort_name', 'email', 'note', 'display_name');
1754     }
1755
1756     // email comes in via advanced search
1757     // so use wildcard always
1758     if ($id == 'email') {
1759       $wildcard = 1;
1760     }
1761
1762     if (!$useEquals && in_array($id, $likeNames)) {
1763       $result = array($id, 'LIKE', $values, 0, 1);
1764     }
1765     elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1766       $result = array($id, 'LIKE', $values, 0, 0);
1767     }
1768     elseif ($id == 'contact_type' ||
1769       (!empty($values) && is_array($values) && !in_array(key($values), CRM_Core_DAO::acceptedSQLOperators(), TRUE))
1770     ) {
1771       $result = array($id, 'IN', $values, 0, $wildcard);
1772     }
1773     else {
1774       $result = array($id, '=', $values, 0, $wildcard);
1775     }
1776
1777     return $result;
1778   }
1779
1780   /**
1781    * Get the where clause for a single field.
1782    *
1783    * @param array $values
1784    * @param string $apiEntity
1785    */
1786   public function whereClauseSingle(&$values, $apiEntity = NULL) {
1787     // do not process custom fields or prefixed contact ids or component params
1788     if (CRM_Core_BAO_CustomField::getKeyID($values[0]) ||
1789       (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) ||
1790       (substr($values[0], 0, 13) == 'contribution_') ||
1791       (substr($values[0], 0, 6) == 'event_') ||
1792       (substr($values[0], 0, 12) == 'participant_') ||
1793       (substr($values[0], 0, 7) == 'member_') ||
1794       (substr($values[0], 0, 6) == 'grant_') ||
1795       (substr($values[0], 0, 7) == 'pledge_') ||
1796       (substr($values[0], 0, 5) == 'case_') ||
1797       (substr($values[0], 0, 10) == 'financial_') ||
1798       (substr($values[0], 0, 8) == 'payment_') ||
1799       (substr($values[0], 0, 11) == 'membership_')
1800     ) {
1801       return;
1802     }
1803
1804     // skip for hook injected fields / params
1805     $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields();
1806     if (array_key_exists($values[0], $extFields)) {
1807       return;
1808     }
1809
1810     switch ($values[0]) {
1811       case 'deleted_contacts':
1812         $this->deletedContacts($values);
1813         return;
1814
1815       case 'contact_sub_type':
1816         $this->contactSubType($values);
1817         return;
1818
1819       case 'group':
1820       case 'group_type':
1821         $this->group($values);
1822         return;
1823
1824       // case tag comes from find contacts
1825       case 'tag_search':
1826         $this->tagSearch($values);
1827         return;
1828
1829       case 'tag':
1830       case 'contact_tags':
1831         $this->tag($values);
1832         return;
1833
1834       case 'note':
1835       case 'note_body':
1836       case 'note_subject':
1837         $this->notes($values);
1838         return;
1839
1840       case 'uf_user':
1841         $this->ufUser($values);
1842         return;
1843
1844       case 'sort_name':
1845       case 'display_name':
1846         $this->sortName($values);
1847         return;
1848
1849       case 'addressee':
1850       case 'postal_greeting':
1851       case 'email_greeting':
1852         $this->greetings($values);
1853         return;
1854
1855       case 'email':
1856       case 'email_id':
1857         $this->email($values, $apiEntity);
1858         return;
1859
1860       case 'phone_numeric':
1861         $this->phone_numeric($values);
1862         return;
1863
1864       case 'phone_phone_type_id':
1865       case 'phone_location_type_id':
1866         $this->phone_option_group($values);
1867         return;
1868
1869       case 'street_address':
1870         $this->street_address($values);
1871         return;
1872
1873       case 'street_number':
1874         $this->street_number($values);
1875         return;
1876
1877       case 'sortByCharacter':
1878         $this->sortByCharacter($values);
1879         return;
1880
1881       case 'location_type':
1882         $this->locationType($values);
1883         return;
1884
1885       case 'county':
1886         $this->county($values);
1887         return;
1888
1889       case 'state_province':
1890       case 'state_province_id':
1891       case 'state_province_name':
1892         $this->stateProvince($values);
1893         return;
1894
1895       case 'country':
1896       case 'country_id':
1897         $this->country($values, FALSE);
1898         return;
1899
1900       case 'postal_code':
1901       case 'postal_code_low':
1902       case 'postal_code_high':
1903         $this->postalCode($values);
1904         return;
1905
1906       case 'activity_date':
1907       case 'activity_date_low':
1908       case 'activity_date_high':
1909       case 'activity_role':
1910       case 'activity_status_id':
1911       case 'activity_status':
1912       case 'activity_priority':
1913       case 'activity_priority_id':
1914       case 'followup_parent_id':
1915       case 'parent_id':
1916       case 'source_contact_id':
1917       case 'activity_text':
1918       case 'activity_option':
1919       case 'test_activities':
1920       case 'activity_type_id':
1921       case 'activity_type':
1922       case 'activity_survey_id':
1923       case 'activity_tags':
1924       case 'activity_taglist':
1925       case 'activity_test':
1926       case 'activity_campaign_id':
1927       case 'activity_engagement_level':
1928       case 'activity_id':
1929       case 'activity_result':
1930       case 'source_contact':
1931         CRM_Activity_BAO_Query::whereClauseSingle($values, $this);
1932         return;
1933
1934       case 'age_low':
1935       case 'age_high':
1936       case 'birth_date_low':
1937       case 'birth_date_high':
1938       case 'deceased_date_low':
1939       case 'deceased_date_high':
1940         $this->demographics($values);
1941         return;
1942
1943       case 'age_asof_date':
1944         // handled by demographics
1945         return;
1946
1947       case 'log_date_low':
1948       case 'log_date_high':
1949         $this->modifiedDates($values);
1950         return;
1951
1952       case 'changed_by':
1953         $this->changeLog($values);
1954         return;
1955
1956       case 'do_not_phone':
1957       case 'do_not_email':
1958       case 'do_not_mail':
1959       case 'do_not_sms':
1960       case 'do_not_trade':
1961       case 'is_opt_out':
1962         $this->privacy($values);
1963         return;
1964
1965       case 'privacy_options':
1966         $this->privacyOptions($values);
1967         return;
1968
1969       case 'privacy_operator':
1970       case 'privacy_toggle':
1971         // these are handled by privacy options
1972         return;
1973
1974       case 'preferred_communication_method':
1975         $this->preferredCommunication($values);
1976         return;
1977
1978       case 'relation_type_id':
1979       case 'relation_start_date_high':
1980       case 'relation_start_date_low':
1981       case 'relation_end_date_high':
1982       case 'relation_end_date_low':
1983       case 'relation_active_period_date_high':
1984       case 'relation_active_period_date_low':
1985       case 'relation_target_name':
1986       case 'relation_status':
1987       case 'relation_date_low':
1988       case 'relation_date_high':
1989         $this->relationship($values);
1990         $this->_relationshipValuesAdded = TRUE;
1991         return;
1992
1993       case 'task_status_id':
1994         $this->task($values);
1995         return;
1996
1997       case 'task_id':
1998         // since this case is handled with the above
1999         return;
2000
2001       case 'prox_distance':
2002         CRM_Contact_BAO_ProximityQuery::process($this, $values);
2003         return;
2004
2005       case 'prox_street_address':
2006       case 'prox_city':
2007       case 'prox_postal_code':
2008       case 'prox_state_province_id':
2009       case 'prox_country_id':
2010       case 'prox_geo_code_1':
2011       case 'prox_geo_code_2':
2012         // handled by the proximity_distance clause
2013         return;
2014
2015       default:
2016         $this->restWhere($values);
2017         return;
2018     }
2019   }
2020
2021   /**
2022    * Given a list of conditions in params generate the required where clause.
2023    *
2024    * @param string $apiEntity
2025    *
2026    * @return string
2027    */
2028   public function whereClause($apiEntity = NULL) {
2029     $this->_where[0] = array();
2030     $this->_qill[0] = array();
2031
2032     $this->includeContactIds();
2033     if (!empty($this->_params)) {
2034       foreach (array_keys($this->_params) as $id) {
2035         if (empty($this->_params[$id][0])) {
2036           continue;
2037         }
2038         // check for both id and contact_id
2039         if ($this->_params[$id][0] == 'id' || $this->_params[$id][0] == 'contact_id') {
2040           $this->_where[0][] = self::buildClause("contact_a.id", $this->_params[$id][1], $this->_params[$id][2]);
2041         }
2042         else {
2043           $this->whereClauseSingle($this->_params[$id], $apiEntity);
2044         }
2045       }
2046
2047       CRM_Core_Component::alterQuery($this, 'where');
2048
2049       CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'where');
2050     }
2051
2052     if ($this->_customQuery) {
2053       // Added following if condition to avoid the wrong value display for 'my account' / any UF info.
2054       // Hope it wont affect the other part of civicrm.. if it does please remove it.
2055       if (!empty($this->_customQuery->_where)) {
2056         $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where);
2057       }
2058
2059       $this->_qill = CRM_Utils_Array::crmArrayMerge($this->_qill, $this->_customQuery->_qill);
2060     }
2061
2062     $clauses = array();
2063     $andClauses = array();
2064
2065     $validClauses = 0;
2066     if (!empty($this->_where)) {
2067       foreach ($this->_where as $grouping => $values) {
2068         if ($grouping > 0 && !empty($values)) {
2069           $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
2070           $validClauses++;
2071         }
2072       }
2073
2074       if (!empty($this->_where[0])) {
2075         $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where[0]) . ' ) ';
2076       }
2077       if (!empty($clauses)) {
2078         $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
2079       }
2080
2081       if ($validClauses > 1) {
2082         $this->_useDistinct = TRUE;
2083       }
2084     }
2085
2086     return implode(' AND ', $andClauses);
2087   }
2088
2089   /**
2090    * Generate where clause for any parameters not already handled.
2091    *
2092    * @param array $values
2093    *
2094    * @throws Exception
2095    */
2096   public function restWhere(&$values) {
2097     $name = CRM_Utils_Array::value(0, $values);
2098     $op = CRM_Utils_Array::value(1, $values);
2099     $value = CRM_Utils_Array::value(2, $values);
2100     $grouping = CRM_Utils_Array::value(3, $values);
2101     $wildcard = CRM_Utils_Array::value(4, $values);
2102
2103     if (isset($grouping) && empty($this->_where[$grouping])) {
2104       $this->_where[$grouping] = array();
2105     }
2106
2107     $multipleFields = array('url');
2108
2109     //check if the location type exists for fields
2110     $lType = '';
2111     $locType = explode('-', $name);
2112
2113     if (!in_array($locType[0], $multipleFields)) {
2114       //add phone type if exists
2115       if (isset($locType[2]) && $locType[2]) {
2116         $locType[2] = CRM_Core_DAO::escapeString($locType[2]);
2117       }
2118     }
2119
2120     $field = CRM_Utils_Array::value($name, $this->_fields);
2121
2122     if (!$field) {
2123       $field = CRM_Utils_Array::value($locType[0], $this->_fields);
2124
2125       if (!$field) {
2126         return;
2127       }
2128     }
2129
2130     $setTables = TRUE;
2131
2132     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2133     $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
2134     if (isset($locType[1]) && is_numeric($locType[1])) {
2135       $lType = $locationType[$locType[1]];
2136     }
2137     if ($lType) {
2138       $field['title'] .= " ($lType)";
2139     }
2140
2141     if (substr($name, 0, 14) === 'state_province') {
2142       if (isset($locType[1]) && is_numeric($locType[1])) {
2143         $setTables = FALSE;
2144         $aName = "{$lType}-address";
2145         $where = "`$aName`.state_province_id";
2146       }
2147       else {
2148         $where = "civicrm_address.state_province_id";
2149       }
2150
2151       $this->_where[$grouping][] = self::buildClause($where, $op, $value);
2152       $this->_tables[$aName] = $this->_whereTables[$aName] = 1;
2153       list($qillop, $qillVal) = self::buildQillForFieldValue('CRM_Core_DAO_Address', "state_province_id", $value, $op);
2154       $this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $field['title'], 2 => $qillop, 3 => $qillVal));
2155     }
2156     elseif (!empty($field['pseudoconstant'])) {
2157       $this->optionValueQuery(
2158         $name, $op, $value, $grouping,
2159         'CRM_Contact_DAO_Contact',
2160         $field,
2161         $field['title'],
2162         'String',
2163         TRUE
2164       );
2165       if ($name == 'gender_id') {
2166         self::$_openedPanes[ts('Demographics')] = TRUE;
2167       }
2168     }
2169     elseif (substr($name, 0, 7) === 'country' || substr($name, 0, 6) === 'county') {
2170       $name = (substr($name, 0, 7) === 'country') ? "country_id" : "county_id";
2171       if (isset($locType[1]) && is_numeric($locType[1])) {
2172         $setTables = FALSE;
2173         $aName = "{$lType}-address";
2174         $where = "`$aName`.$name";
2175       }
2176       else {
2177         $where = "civicrm_address.$name";
2178       }
2179
2180       $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2181       $this->_tables[$aName] = $this->_whereTables[$aName] = 1;
2182
2183       list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, $name, $value, $op);
2184       $this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $field['title'], 2 => $qillop, 3 => $qillVal));
2185     }
2186     elseif ($name === 'world_region') {
2187       $this->optionValueQuery(
2188         $name, $op, $value, $grouping,
2189         NULL,
2190         $field,
2191         ts('World Region'),
2192         'Positive',
2193         TRUE
2194       );
2195     }
2196     elseif ($name === 'is_deceased') {
2197       $this->setQillAndWhere($name, $op, $value, $grouping, $field);
2198       self::$_openedPanes[ts('Demographics')] = TRUE;
2199     }
2200     elseif ($name === 'created_date' || $name === 'modified_date' || $name === 'deceased_date' || $name === 'birth_date') {
2201       $appendDateTime = TRUE;
2202       if ($name === 'deceased_date' || $name === 'birth_date') {
2203         $appendDateTime = FALSE;
2204         self::$_openedPanes[ts('Demographics')] = TRUE;
2205       }
2206       $this->dateQueryBuilder($values, 'contact_a', $name, $name, $field['title'], $appendDateTime);
2207     }
2208     elseif ($name === 'contact_id') {
2209       if (is_int($value)) {
2210         $this->_where[$grouping][] = self::buildClause($field['where'], $op, $value);
2211         $this->_qill[$grouping][] = "$field[title] $op $value";
2212       }
2213     }
2214     elseif ($name === 'name') {
2215       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2216       if ($wildcard) {
2217         $op = 'LIKE';
2218         $value = self::getWildCardedValue($wildcard, $op, $value);
2219       }
2220       // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
2221       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
2222       $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'");
2223       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2224     }
2225     elseif ($name === 'current_employer') {
2226       if ($wildcard) {
2227         $op = 'LIKE';
2228         $value = self::getWildCardedValue($wildcard, $op, $value);
2229       }
2230       $ceWhereClause = self::buildClause("contact_a.organization_name", $op,
2231         $value
2232       );
2233       $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2234       $this->_where[$grouping][] = $ceWhereClause;
2235       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2236     }
2237     elseif ($name === 'email_greeting') {
2238       CRM_Core_Error::deprecatedFunctionWarning('pass in email_greeting_id or email_greeting_display');
2239       $filterCondition = array('greeting_type' => 'email_greeting');
2240       $this->optionValueQuery(
2241         $name, $op, $value, $grouping,
2242         CRM_Core_PseudoConstant::greeting($filterCondition),
2243         $field,
2244         ts('Email Greeting')
2245       );
2246     }
2247     elseif ($name === 'postal_greeting') {
2248       CRM_Core_Error::deprecatedFunctionWarning('pass in postal_greeting_id or postal_greeting_display');
2249       $filterCondition = array('greeting_type' => 'postal_greeting');
2250       $this->optionValueQuery(
2251         $name, $op, $value, $grouping,
2252         CRM_Core_PseudoConstant::greeting($filterCondition),
2253         $field,
2254         ts('Postal Greeting')
2255       );
2256     }
2257     elseif ($name === 'addressee') {
2258       CRM_Core_Error::deprecatedFunctionWarning('pass in addressee_id or addressee_display');
2259       $filterCondition = array('greeting_type' => 'addressee');
2260       $this->optionValueQuery(
2261         $name, $op, $value, $grouping,
2262         CRM_Core_PseudoConstant::greeting($filterCondition),
2263         $field,
2264         ts('Addressee')
2265       );
2266     }
2267     elseif (substr($name, 0, 4) === 'url-') {
2268       $tName = 'civicrm_website';
2269       $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2270       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2271       if ($wildcard) {
2272         $op = 'LIKE';
2273         $value = self::getWildCardedValue($wildcard, $op, $value);
2274       }
2275
2276       $this->_where[$grouping][] = $d = self::buildClause('civicrm_website.url', $op, $value);
2277       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2278     }
2279     elseif ($name === 'contact_is_deleted') {
2280       $this->setQillAndWhere('is_deleted', $op, $value, $grouping, $field);
2281     }
2282     elseif (!empty($field['where'])) {
2283       $type = NULL;
2284       if (!empty($field['type'])) {
2285         $type = CRM_Utils_Type::typeToString($field['type']);
2286       }
2287
2288       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2289
2290       if (isset($locType[1]) &&
2291         is_numeric($locType[1])
2292       ) {
2293         $setTables = FALSE;
2294
2295         //get the location name
2296         list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
2297         $fieldName = "`$tName`.$fldName";
2298
2299         // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2300         $this->_tables[$tName] = $this->_whereTables[$tName] = 1;
2301
2302       }
2303       else {
2304         if ($tableName == 'civicrm_contact') {
2305           $fieldName = "contact_a.{$fieldName}";
2306         }
2307         else {
2308           if ($op != 'IN' && !is_numeric($value) && !is_array($value)) {
2309             $fieldName = "{$field['where']}";
2310           }
2311           else {
2312             $fieldName = "{$field['where']}";
2313           }
2314         }
2315       }
2316
2317       list($qillop, $qillVal) = self::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2318       $this->_qill[$grouping][] = ts("%1 %2 %3", array(
2319         1 => $field['title'],
2320         2 => $qillop,
2321         3 => (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) ? $qillVal : "'$qillVal'"));
2322
2323       if (is_array($value)) {
2324         // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2325         // for api style operators for functions that hit this point without worrying about regression
2326         // (the previous comments indicated the condition for hitting this point were unknown
2327         // per CRM-14743 we are adding modified_date & created_date operator support
2328         $operations = array_keys($value);
2329         foreach ($operations as $operator) {
2330           if (!in_array($operator, CRM_Core_DAO::acceptedSQLOperators())) {
2331             //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2332             //so this condition will satisfy the search for now
2333             if (strpos($op, 'IN') !== FALSE) {
2334               $value = array($op => $value);
2335             }
2336             // we don't know when this might happen
2337             else {
2338               CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2339             }
2340           }
2341         }
2342         $this->_where[$grouping][] = CRM_Core_DAO::createSQLFilter($fieldName, $value, $type);
2343       }
2344       else {
2345         if (!self::caseImportant($op)) {
2346           $value = $strtolower($value);
2347         }
2348         if ($wildcard) {
2349           $op = 'LIKE';
2350           $value = self::getWildCardedValue($wildcard, $op, $value);
2351         }
2352
2353         $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type);
2354       }
2355     }
2356
2357     if ($setTables && isset($field['where'])) {
2358       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2359       if (isset($tableName)) {
2360         $this->_tables[$tableName] = 1;
2361         $this->_whereTables[$tableName] = 1;
2362       }
2363     }
2364   }
2365
2366   /**
2367    * @param $where
2368    * @param $locType
2369    *
2370    * @return array
2371    * @throws Exception
2372    */
2373   public static function getLocationTableName(&$where, &$locType) {
2374     if (isset($locType[1]) && is_numeric($locType[1])) {
2375       list($tbName, $fldName) = explode(".", $where);
2376
2377       //get the location name
2378       $locationType = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate');
2379       $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2380       if (in_array($locType[0], $specialFields)) {
2381         //hack to fix / special handing for phone_ext
2382         if ($locType[0] == 'phone_ext') {
2383           $locType[0] = 'phone';
2384         }
2385         if (isset($locType[2]) && $locType[2]) {
2386           $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2387         }
2388         else {
2389           $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2390         }
2391       }
2392       elseif (in_array($locType[0],
2393         array(
2394           'address_name',
2395           'street_address',
2396           'street_name',
2397           'street_number_suffix',
2398           'street_unit',
2399           'supplemental_address_1',
2400           'supplemental_address_2',
2401           'supplemental_address_3',
2402           'city',
2403           'postal_code',
2404           'postal_code_suffix',
2405           'geo_code_1',
2406           'geo_code_2',
2407           'master_id',
2408         )
2409       )) {
2410         //fix for search by profile with address fields.
2411         $tName = "{$locationType[$locType[1]]}-address";
2412       }
2413       elseif (in_array($locType[0],
2414           array(
2415             'on_hold',
2416             'signature_html',
2417             'signature_text',
2418             'is_bulkmail',
2419           )
2420         )) {
2421         $tName = "{$locationType[$locType[1]]}-email";
2422       }
2423       elseif ($locType[0] == 'provider_id') {
2424         $tName = "{$locationType[$locType[1]]}-im";
2425       }
2426       elseif ($locType[0] == 'openid') {
2427         $tName = "{$locationType[$locType[1]]}-openid";
2428       }
2429       else {
2430         $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2431       }
2432       $tName = str_replace(' ', '_', $tName);
2433       return array($tName, $fldName);
2434     }
2435     CRM_Core_Error::fatal();
2436   }
2437
2438   /**
2439    * Given a result dao, extract the values and return that array
2440    *
2441    * @param CRM_Core_DAO $dao
2442    *
2443    * @return array
2444    *   values for this query
2445    */
2446   public function store($dao) {
2447     $value = array();
2448
2449     foreach ($this->_element as $key => $dontCare) {
2450       if (property_exists($dao, $key)) {
2451         if (strpos($key, '-') !== FALSE) {
2452           $values = explode('-', $key);
2453           $lastElement = array_pop($values);
2454           $current = &$value;
2455           $cnt = count($values);
2456           $count = 1;
2457           foreach ($values as $v) {
2458             if (!array_key_exists($v, $current)) {
2459               $current[$v] = array();
2460             }
2461             //bad hack for im_provider
2462             if ($lastElement == 'provider_id') {
2463               if ($count < $cnt) {
2464                 $current = &$current[$v];
2465               }
2466               else {
2467                 $lastElement = "{$v}_{$lastElement}";
2468               }
2469             }
2470             else {
2471               $current = &$current[$v];
2472             }
2473             $count++;
2474           }
2475
2476           $current[$lastElement] = $dao->$key;
2477         }
2478         else {
2479           $value[$key] = $dao->$key;
2480         }
2481       }
2482     }
2483     return $value;
2484   }
2485
2486   /**
2487    * Getter for tables array.
2488    *
2489    * @return array
2490    */
2491   public function tables() {
2492     return $this->_tables;
2493   }
2494
2495   /**
2496    * Sometimes used to create the from clause, but, not reliably, set
2497    * this AND set tables.
2498    *
2499    * It's unclear the intent - there is a 'simpleFrom' clause which
2500    * takes whereTables into account & a fromClause which doesn't.
2501    *
2502    * logic may have eroded?
2503    *
2504    * @return array
2505    */
2506   public function whereTables() {
2507     return $this->_whereTables;
2508   }
2509
2510   /**
2511    * Generate the where clause (used in match contacts and permissions)
2512    *
2513    * @param array $params
2514    * @param array $fields
2515    * @param array $tables
2516    * @param $whereTables
2517    * @param bool $strict
2518    *
2519    * @return string
2520    */
2521   public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2522     $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2523       FALSE, $strict
2524     );
2525
2526     $tables = array_merge($query->tables(), $tables);
2527     $whereTables = array_merge($query->whereTables(), $whereTables);
2528
2529     return $query->_whereClause;
2530   }
2531
2532   /**
2533    * Create the from clause.
2534    *
2535    * @param array $tables
2536    *   Tables that need to be included in this from clause. If null,
2537    *   return mimimal from clause (i.e. civicrm_contact).
2538    * @param array $inner
2539    *   Tables that should be inner-joined.
2540    * @param array $right
2541    *   Tables that should be right-joined.
2542    * @param bool $primaryLocation
2543    *   Search on primary location. See note below.
2544    * @param int $mode
2545    *   Determines search mode based on bitwise MODE_* constants.
2546    * @param string|NULL $apiEntity
2547    *   Determines search mode based on entity by string.
2548    *
2549    * The $primaryLocation flag only seems to be used when
2550    * locationType() has been called. This may be a search option
2551    * exposed, or perhaps it's a "search all details" approach which
2552    * predates decoupling of location types and primary fields?
2553    *
2554    * @see https://issues.civicrm.org/jira/browse/CRM-19967
2555    *
2556    * @return string
2557    *   the from clause
2558    */
2559   public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1, $apiEntity = NULL) {
2560
2561     $from = ' FROM civicrm_contact contact_a';
2562     if (empty($tables)) {
2563       return $from;
2564     }
2565
2566     if (!empty($tables['civicrm_worldregion'])) {
2567       $tables = array_merge(array('civicrm_country' => 1), $tables);
2568     }
2569
2570     if ((!empty($tables['civicrm_state_province']) || !empty($tables['civicrm_country']) ||
2571         CRM_Utils_Array::value('civicrm_county', $tables)
2572       ) && empty($tables['civicrm_address'])
2573     ) {
2574       $tables = array_merge(array('civicrm_address' => 1),
2575         $tables
2576       );
2577     }
2578
2579     // add group_contact and group table is subscription history is present
2580     if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2581       $tables = array_merge(array(
2582           'civicrm_group' => 1,
2583           'civicrm_group_contact' => 1,
2584         ),
2585         $tables
2586       );
2587     }
2588
2589     // to handle table dependencies of components
2590     CRM_Core_Component::tableNames($tables);
2591     // to handle table dependencies of hook injected tables
2592     CRM_Contact_BAO_Query_Hook::singleton()->setTableDependency($tables);
2593
2594     //format the table list according to the weight
2595     $info = CRM_Core_TableHierarchy::info();
2596
2597     foreach ($tables as $key => $value) {
2598       $k = 99;
2599       if (strpos($key, '-') !== FALSE) {
2600         $keyArray = explode('-', $key);
2601         $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99);
2602       }
2603       elseif (strpos($key, '_') !== FALSE) {
2604         $keyArray = explode('_', $key);
2605         if (is_numeric(array_pop($keyArray))) {
2606           $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99);
2607         }
2608         else {
2609           $k = CRM_Utils_Array::value($key, $info, 99);
2610         }
2611       }
2612       else {
2613         $k = CRM_Utils_Array::value($key, $info, 99);
2614       }
2615       $tempTable[$k . ".$key"] = $key;
2616     }
2617     ksort($tempTable);
2618     $newTables = array();
2619     foreach ($tempTable as $key) {
2620       $newTables[$key] = $tables[$key];
2621     }
2622
2623     $tables = $newTables;
2624
2625     foreach ($tables as $name => $value) {
2626       if (!$value) {
2627         continue;
2628       }
2629
2630       if (!empty($inner[$name])) {
2631         $side = 'INNER';
2632       }
2633       elseif (!empty($right[$name])) {
2634         $side = 'RIGHT';
2635       }
2636       else {
2637         $side = 'LEFT';
2638       }
2639
2640       if ($value != 1) {
2641         // if there is already a join statement in value, use value itself
2642         if (strpos($value, 'JOIN')) {
2643           $from .= " $value ";
2644         }
2645         else {
2646           $from .= " $side JOIN $name ON ( $value ) ";
2647         }
2648         continue;
2649       }
2650
2651       $limitToPrimaryClause = $primaryLocation ? "AND {$name}.is_primary = 1" : '';
2652
2653       switch ($name) {
2654         case 'civicrm_address':
2655           //CRM-14263 further handling of address joins further down...
2656           $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id {$limitToPrimaryClause} )";
2657           continue;
2658
2659         case 'civicrm_phone':
2660           $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id {$limitToPrimaryClause}) ";
2661           continue;
2662
2663         case 'civicrm_email':
2664           $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id {$limitToPrimaryClause})";
2665           continue;
2666
2667         case 'civicrm_im':
2668           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id {$limitToPrimaryClause}) ";
2669           continue;
2670
2671         case 'im_provider':
2672           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2673           $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2674           $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)";
2675           continue;
2676
2677         case 'civicrm_openid':
2678           $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id {$limitToPrimaryClause} )";
2679           continue;
2680
2681         case 'civicrm_worldregion':
2682           $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2683           $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2684           continue;
2685
2686         case 'civicrm_location_type':
2687           $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2688           continue;
2689
2690         case 'civicrm_group':
2691           $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2692           continue;
2693
2694         case 'civicrm_group_contact':
2695           $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2696           continue;
2697
2698         case 'civicrm_group_contact_cache':
2699           $from .= " $side JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id ";
2700           continue;
2701
2702         case 'civicrm_activity':
2703         case 'civicrm_activity_tag':
2704         case 'activity_type':
2705         case 'activity_status':
2706         case 'parent_id':
2707         case 'civicrm_activity_contact':
2708         case 'source_contact':
2709         case 'activity_priority':
2710           $from .= CRM_Activity_BAO_Query::from($name, $mode, $side);
2711           continue;
2712
2713         case 'civicrm_entity_tag':
2714           $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2715                                                               civicrm_entity_tag.entity_id = contact_a.id ) ";
2716           continue;
2717
2718         case 'civicrm_note':
2719           $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2720                                                         contact_a.id = civicrm_note.entity_id ) ";
2721           continue;
2722
2723         case 'civicrm_subscription_history':
2724           $from .= " $side JOIN civicrm_subscription_history
2725                                    ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2726                                   AND civicrm_group_contact.group_id =  civicrm_subscription_history.group_id";
2727           continue;
2728
2729         case 'civicrm_relationship':
2730           if (self::$_relType == 'reciprocal') {
2731             if (self::$_relationshipTempTable) {
2732               // we have a temptable to join on
2733               $tbl = self::$_relationshipTempTable;
2734               $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2735             }
2736             else {
2737               $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2738               $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)";
2739             }
2740           }
2741           elseif (self::$_relType == 'b') {
2742             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2743             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2744           }
2745           else {
2746             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2747             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2748           }
2749           continue;
2750
2751         case 'civicrm_log':
2752           $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2753           $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2754           continue;
2755
2756         case 'civicrm_tag':
2757           $from .= " $side  JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2758           continue;
2759
2760         case 'civicrm_grant':
2761           $from .= CRM_Grant_BAO_Query::from($name, $mode, $side);
2762           continue;
2763
2764         case 'civicrm_campaign':
2765           //Move to default case if not in either mode.
2766           if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
2767             $from .= CRM_Contribute_BAO_Query::from($name, $mode, $side);
2768             continue;
2769           }
2770           elseif ($mode & CRM_Contact_BAO_Query::MODE_MAILING) {
2771             $from .= CRM_Mailing_BAO_Query::from($name, $mode, $side);
2772             continue;
2773           }
2774           elseif ($mode & CRM_Contact_BAO_Query::MODE_CAMPAIGN) {
2775             $from .= CRM_Campaign_BAO_Query::from($name, $mode, $side);
2776             continue;
2777           }
2778
2779         case 'civicrm_website':
2780           $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2781           continue;
2782
2783         default:
2784           $locationTypeName = '';
2785           if (strpos($name, '-address') != 0) {
2786             $locationTypeName = 'address';
2787           }
2788           elseif (strpos($name, '-phone') != 0) {
2789             $locationTypeName = 'phone';
2790           }
2791           elseif (strpos($name, '-email') != 0) {
2792             $locationTypeName = 'email';
2793           }
2794           elseif (strpos($name, '-im') != 0) {
2795             $locationTypeName = 'im';
2796           }
2797           elseif (strpos($name, '-openid') != 0) {
2798             $locationTypeName = 'openid';
2799           }
2800
2801           if ($locationTypeName) {
2802             //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2803             $parts = explode('-', $name);
2804             $locationTypes = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate');
2805             foreach ($locationTypes as $locationTypeID => $locationType) {
2806               if ($parts[0] == str_replace(' ', '_', $locationType)) {
2807                 $locationID = $locationTypeID;
2808               }
2809             }
2810             $from .= " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2811           }
2812           else {
2813             $from .= CRM_Core_Component::from($name, $mode, $side);
2814           }
2815           $from .= CRM_Contact_BAO_Query_Hook::singleton()->buildSearchfrom($name, $mode, $side);
2816
2817           continue;
2818       }
2819     }
2820     return $from;
2821   }
2822
2823   /**
2824    * WHERE / QILL clause for deleted_contacts
2825    *
2826    * @param array $values
2827    */
2828   public function deletedContacts($values) {
2829     list($_, $_, $value, $grouping, $_) = $values;
2830     if ($value) {
2831       // *prepend* to the relevant grouping as this is quite an important factor
2832       array_unshift($this->_qill[$grouping], ts('Search in Trash'));
2833     }
2834   }
2835
2836   /**
2837    * Where / qill clause for contact_type
2838    *
2839    * @param $values
2840    */
2841   public function contactType(&$values) {
2842     list($name, $op, $value, $grouping, $wildcard) = $values;
2843
2844     $subTypes = array();
2845     $clause = array();
2846
2847     // account for search builder mapping multiple values
2848     if (!is_array($value)) {
2849       $values = self::parseSearchBuilderString($value, 'String');
2850       if (is_array($values)) {
2851         $value = array_flip($values);
2852       }
2853     }
2854
2855     if (is_array($value)) {
2856       foreach ($value as $k => $v) {
2857         // fix for CRM-771
2858         if ($k) {
2859           $subType = NULL;
2860           $contactType = $k;
2861           if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) {
2862             list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2);
2863           }
2864
2865           if (!empty($subType)) {
2866             $subTypes[$subType] = 1;
2867           }
2868           $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2869         }
2870       }
2871     }
2872     else {
2873       $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2);
2874       $contactType = $contactTypeANDSubType[0];
2875       $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType);
2876       if (!empty($subType)) {
2877         $subTypes[$subType] = 1;
2878       }
2879       $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2880     }
2881
2882     // fix for CRM-771
2883     if (!empty($clause)) {
2884       $quill = $clause;
2885       if ($op == 'IN' || $op == 'NOT IN') {
2886         $this->_where[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2887       }
2888       else {
2889         $type = array_pop($clause);
2890         $this->_where[$grouping][] = self::buildClause("contact_a.contact_type", $op, $contactType);
2891       }
2892
2893       $this->_qill[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2894
2895       if (!empty($subTypes)) {
2896         $this->includeContactSubTypes($subTypes, $grouping);
2897       }
2898     }
2899   }
2900
2901   /**
2902    * Where / qill clause for contact_sub_type.
2903    *
2904    * @param array $values
2905    */
2906   public function contactSubType(&$values) {
2907     list($name, $op, $value, $grouping, $wildcard) = $values;
2908     $this->includeContactSubTypes($value, $grouping, $op);
2909   }
2910
2911   /**
2912    * @param $value
2913    * @param $grouping
2914    * @param string $op
2915    */
2916   public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2917
2918     if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
2919       $op = key($value);
2920       $value = $value[$op];
2921     }
2922
2923     $clause = array();
2924     $alias = "contact_a.contact_sub_type";
2925     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
2926
2927     $op = str_replace('IN', 'LIKE', $op);
2928     $op = str_replace('=', 'LIKE', $op);
2929     $op = str_replace('!', 'NOT ', $op);
2930
2931     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
2932       $this->_where[$grouping][] = self::buildClause($alias, $op, $value, 'String');
2933     }
2934     elseif (is_array($value)) {
2935       foreach ($value as $k => $v) {
2936         $clause[$k] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($v, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2937       }
2938     }
2939     else {
2940       $clause[$value] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2941     }
2942
2943     if (!empty($clause)) {
2944       $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2945     }
2946     $this->_qill[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2947   }
2948
2949   /**
2950    * Where / qill clause for groups.
2951    *
2952    * @param $values
2953    */
2954   public function group($values) {
2955     list($name, $op, $value, $grouping, $wildcard) = $values;
2956
2957     // If the $value is in OK (operator as key) array format we need to extract the key as operator and value first
2958     if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
2959       $op = key($value);
2960       $value = $value[$op];
2961     }
2962
2963     // Replace pseudo operators from search builder
2964     $op = str_replace('EMPTY', 'NULL', $op);
2965
2966     if (strpos($op, 'NULL')) {
2967       $value = NULL;
2968     }
2969
2970     if (is_array($value) && count($value) > 1) {
2971       if (strpos($op, 'IN') === FALSE && strpos($op, 'NULL') === FALSE) {
2972         CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $op)));
2973       }
2974       $this->_useDistinct = TRUE;
2975     }
2976
2977     if (isset($value)) {
2978       $value = CRM_Utils_Array::value($op, $value, $value);
2979     }
2980
2981     if ($name == 'group_type') {
2982       $value = array_keys($this->getGroupsFromTypeCriteria($value));
2983     }
2984
2985     $regularGroupIDs = $smartGroupIDs = array();
2986     foreach ((array) $value as $id) {
2987       if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $id, 'saved_search_id')) {
2988         $smartGroupIDs[] = $id;
2989       }
2990       else {
2991         $regularGroupIDs[] = $id;
2992       }
2993     }
2994
2995     $isNotOp = ($op == 'NOT IN' || $op == '!=');
2996
2997     $statii = array();
2998     $gcsValues = $this->getWhereValues('group_contact_status', $grouping);
2999     if ($gcsValues &&
3000       is_array($gcsValues[2])
3001     ) {
3002       foreach ($gcsValues[2] as $k => $v) {
3003         if ($v) {
3004           $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
3005         }
3006       }
3007     }
3008     else {
3009       $statii[] = "'Added'";
3010     }
3011     $groupClause = array();
3012     if (count($regularGroupIDs) || empty($value)) {
3013       // include child groups IDs if any
3014       $childGroupIds = (array) CRM_Contact_BAO_Group::getChildGroupIds($regularGroupIDs);
3015       foreach ($childGroupIds as $key => $id) {
3016         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $id, 'saved_search_id')) {
3017           $smartGroupIDs[] = $id;
3018           unset($childGroupIds[$key]);
3019         }
3020       }
3021       if (count($childGroupIds)) {
3022         $regularGroupIDs = array_merge($regularGroupIDs, $childGroupIds);
3023       }
3024
3025       // if $regularGroupIDs is populated with regular child group IDs
3026       //   then change the mysql operator to desired
3027       if (count($regularGroupIDs) > 1) {
3028         $op = strpos($op, 'IN') ? $op : ($op == '!=') ? 'NOT IN' : 'IN';
3029       }
3030       $groupIds = implode(',', (array) $regularGroupIDs);
3031       $gcTable = "`civicrm_group_contact-{$groupIds}`";
3032       $joinClause = array("contact_a.id = {$gcTable}.contact_id");
3033
3034       if (strpos($op, 'IN') !== FALSE) {
3035         $clause = "{$gcTable}.group_id $op ( $groupIds ) ";
3036       }
3037       elseif ($op == '!=') {
3038         $clause = "{$gcTable}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact cgc WHERE cgc.group_id = $groupIds )";
3039       }
3040       else {
3041         $clause = "{$gcTable}.group_id $op $groupIds ";
3042       }
3043       $groupClause[] = "( {$clause} )";
3044
3045       if ($statii) {
3046         $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
3047       }
3048       $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
3049     }
3050
3051     //CRM-19589: contact(s) removed from a Smart Group, resides in civicrm_group_contact table
3052     if (count($smartGroupIDs)) {
3053       $groupClause[] = " ( " . $this->addGroupContactCache($smartGroupIDs, NULL, "contact_a", $op) . " ) ";
3054     }
3055
3056     $and = ($op == 'IS NULL') ? ' AND ' : ' OR ';
3057     $this->_where[$grouping][] = ' ( ' . implode($and, $groupClause) . ' ) ';
3058
3059     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Group', 'id', $value, $op);
3060     $this->_qill[$grouping][] = ts("Group(s) %1 %2", array(1 => $qillop, 2 => $qillVal));
3061     if (strpos($op, 'NULL') === FALSE) {
3062       $this->_qill[$grouping][] = ts("Group Status %1", array(1 => implode(' ' . ts('or') . ' ', $statii)));
3063     }
3064   }
3065
3066   /**
3067    * Function translates selection of group type into a list of groups.
3068    * @param $value
3069    *
3070    * @return array
3071    */
3072   public function getGroupsFromTypeCriteria($value) {
3073     $groupIds = array();
3074     foreach ((array) $value as $groupTypeValue) {
3075       $groupList = CRM_Core_PseudoConstant::group($groupTypeValue);
3076       $groupIds = ($groupIds + $groupList);
3077     }
3078     return $groupIds;
3079   }
3080
3081   /**
3082    * Prime smart group cache for smart groups in the search, and join
3083    * civicrm_group_contact_cache table into the query.
3084    *
3085    * @param array $groups IDs of groups specified in search criteria.
3086    * @param string $tableAlias Alias to use for civicrm_group_contact_cache table.
3087    * @param string $joinTable Table on which to join civicrm_group_contact_cache
3088    * @param string $op SQL comparison operator (NULL, IN, !=, IS NULL, etc.)
3089    * @param string $joinColumn Column in $joinTable on which to join civicrm_group_contact_cache.contact_id
3090    *
3091    * @return string WHERE clause component for smart group criteria.
3092    */
3093   public function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a", $op, $joinColumn = 'id') {
3094     $isNullOp = (strpos($op, 'NULL') !== FALSE);
3095     $groupsIds = $groups;
3096     if (!$isNullOp && !$groups) {
3097       return NULL;
3098     }
3099     elseif (strpos($op, 'IN') !== FALSE) {
3100       $groups = array($op => $groups);
3101     }
3102     elseif (is_array($groups) && count($groups)) {
3103       $groups = array('IN' => $groups);
3104     }
3105
3106     // Find all the groups that are part of a saved search.
3107     $smartGroupClause = self::buildClause("id", $op, $groups, 'Int');
3108     $sql = "
3109 SELECT id, cache_date, saved_search_id, children
3110 FROM   civicrm_group
3111 WHERE  $smartGroupClause
3112   AND  ( saved_search_id != 0
3113    OR    saved_search_id IS NOT NULL
3114    OR    children IS NOT NULL )
3115 ";
3116
3117     $group = CRM_Core_DAO::executeQuery($sql);
3118
3119     while ($group->fetch()) {
3120       $this->_useDistinct = TRUE;
3121       if (!$this->_smartGroupCache || $group->cache_date == NULL) {
3122         CRM_Contact_BAO_GroupContactCache::load($group);
3123       }
3124     }
3125     if ($group->N == 0) {
3126       return NULL;
3127     }
3128
3129     if (!$tableAlias) {
3130       $tableAlias = "`civicrm_group_contact_cache_";
3131       $tableAlias .= ($isNullOp) ? "a`" : implode(',', (array) $groupsIds) . "`";
3132     }
3133
3134     $this->_tables[$tableAlias] = $this->_whereTables[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.{$joinColumn} = {$tableAlias}.contact_id ";
3135     return self::buildClause("{$tableAlias}.group_id", $op, $groups, 'Int');
3136   }
3137
3138   /**
3139    * Where / qill clause for cms users
3140    *
3141    * @param $values
3142    */
3143   public function ufUser(&$values) {
3144     list($name, $op, $value, $grouping, $wildcard) = $values;
3145
3146     if ($value == 1) {
3147       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
3148
3149       $this->_qill[$grouping][] = ts('CMS User');
3150     }
3151     elseif ($value == 0) {
3152       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
3153
3154       $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
3155       $this->_qill[$grouping][] = ts('Not a CMS User');
3156     }
3157   }
3158
3159   /**
3160    * All tag search specific.
3161    *
3162    * @param array $values
3163    */
3164   public function tagSearch(&$values) {
3165     list($name, $op, $value, $grouping, $wildcard) = $values;
3166
3167     $op = "LIKE";
3168     $value = "%{$value}%";
3169
3170     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3171     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3172
3173     $etTable = "`civicrm_entity_tag-" . $value . "`";
3174     $tTable = "`civicrm_tag-" . $value . "`";
3175
3176     if ($useAllTagTypes[2]) {
3177       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3178         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
3179             LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  )";
3180
3181       // search tag in cases
3182       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3183       $tCaseTable = "`civicrm_case_tag-" . $value . "`";
3184       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3185         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3186             LEFT JOIN civicrm_case
3187             ON (civicrm_case_contact.case_id = civicrm_case.id
3188                 AND civicrm_case.is_deleted = 0 )
3189             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
3190             LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id  )";
3191       // search tag in activities
3192       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3193       $tActTable = "`civicrm_act_tag-" . $value . "`";
3194       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
3195       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3196
3197       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3198         = " LEFT JOIN civicrm_activity_contact
3199             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3200             LEFT JOIN civicrm_activity
3201             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3202             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3203             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3204             LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id  )";
3205
3206       $this->_where[$grouping][] = "({$tTable}.name $op '" . $value . "' OR {$tCaseTable}.name $op '" . $value . "' OR {$tActTable}.name $op '" . $value . "')";
3207       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3208     }
3209     else {
3210       $etTable = "`civicrm_entity_tag-" . $value . "`";
3211       $tTable = "`civicrm_tag-" . $value . "`";
3212       $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND
3213       {$etTable}.entity_table = 'civicrm_contact' )
3214                 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  ) ";
3215
3216       $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String');
3217       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3218     }
3219   }
3220
3221   /**
3222    * Where / qill clause for tag.
3223    *
3224    * @param array $values
3225    */
3226   public function tag(&$values) {
3227     list($name, $op, $value, $grouping, $wildcard) = $values;
3228
3229     list($qillop, $qillVal) = self::buildQillForFieldValue('CRM_Core_DAO_EntityTag', "tag_id", $value, $op, array('onlyActive' => FALSE));
3230     // API/Search Builder format array(operator => array(values))
3231     if (is_array($value)) {
3232       if (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
3233         $op = key($value);
3234         $value = $value[$op];
3235       }
3236       if (count($value) > 1) {
3237         $this->_useDistinct = TRUE;
3238       }
3239       $value = implode(',', (array) $value);
3240     }
3241
3242     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3243     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3244
3245     $etTable = "`civicrm_entity_tag-" . $value . "`";
3246
3247     if ($useAllTagTypes[2]) {
3248       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3249         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3250
3251       // search tag in cases
3252       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3253       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
3254       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3255
3256       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3257         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3258             LEFT JOIN civicrm_case
3259             ON (civicrm_case_contact.case_id = civicrm_case.id
3260                 AND civicrm_case.is_deleted = 0 )
3261             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3262       // search tag in activities
3263       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3264       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3265         = " LEFT JOIN civicrm_activity_contact
3266             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3267             LEFT JOIN civicrm_activity
3268             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3269             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3270             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3271
3272       // CRM-10338
3273       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3274         $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3275       }
3276       else {
3277         $this->_where[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3278       }
3279     }
3280     else {
3281       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3282         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3283
3284       // CRM-10338
3285       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3286         // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3287         $op = str_replace('EMPTY', 'NULL', $op);
3288         $this->_where[$grouping][] = "{$etTable}.tag_id $op";
3289       }
3290       // CRM-16941: for tag tried with != operator we don't show contact who don't have given $value AND also in other tag
3291       elseif ($op == '!=') {
3292         $this->_where[$grouping][] = "{$etTable}.entity_id NOT IN (SELECT entity_id FROM civicrm_entity_tag cet WHERE cet.entity_table = 'civicrm_contact' AND " . self::buildClause("cet.tag_id", '=', $value, 'Int') . ")";
3293       }
3294       elseif ($op == '=' || strstr($op, 'IN')) {
3295         $op = ($op == '=') ? 'IN' : $op;
3296         $this->_where[$grouping][] = "{$etTable}.tag_id $op ( $value )";
3297       }
3298     }
3299     $this->_qill[$grouping][] = ts('Tagged %1 %2', array(1 => $qillop, 2 => $qillVal));
3300   }
3301
3302   /**
3303    * Where/qill clause for notes
3304    *
3305    * @param array $values
3306    */
3307   public function notes(&$values) {
3308     list($name, $op, $value, $grouping, $wildcard) = $values;
3309
3310     $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3311     $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6');
3312     $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption);
3313
3314     $this->_useDistinct = TRUE;
3315
3316     $this->_tables['civicrm_note'] = $this->_whereTables['civicrm_note']
3317       = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3318
3319     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3320     $n = trim($value);
3321     $value = $strtolower(CRM_Core_DAO::escapeString($n));
3322     if ($wildcard) {
3323       if (strpos($value, '%') === FALSE) {
3324         $value = "%$value%";
3325       }
3326       $op = 'LIKE';
3327     }
3328     elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') {
3329       $value = NULL;
3330     }
3331
3332     $label = NULL;
3333     $clauses = array();
3334     if ($noteOption % 2 == 0) {
3335       $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String');
3336       $label = ts('Note: Body Only');
3337     }
3338     if ($noteOption % 3 == 0) {
3339       $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String');
3340       $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only');
3341     }
3342     $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3343     list($qillOp, $qillVal) = self::buildQillForFieldValue(NULL, $name, $n, $op);
3344     $this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillOp, 3 => $qillVal));
3345   }
3346
3347   /**
3348    * @param string $name
3349    * @param $op
3350    * @param $grouping
3351    *
3352    * @return bool
3353    */
3354   public function nameNullOrEmptyOp($name, $op, $grouping) {
3355     switch ($op) {
3356       case 'IS NULL':
3357       case 'IS NOT NULL':
3358         $this->_where[$grouping][] = "contact_a.$name $op";
3359         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3360         return TRUE;
3361
3362       case 'IS EMPTY':
3363         $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3364         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3365         return TRUE;
3366
3367       case 'IS NOT EMPTY':
3368         $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3369         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3370         return TRUE;
3371
3372       default:
3373         return FALSE;
3374     }
3375   }
3376
3377   /**
3378    * Where / qill clause for sort_name
3379    *
3380    * @param array $values
3381    */
3382   public function sortName(&$values) {
3383     list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3384
3385     // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3386     if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3387       return;
3388     }
3389
3390     $input = $value = trim($value);
3391
3392     if (!strlen($value)) {
3393       return;
3394     }
3395
3396     $config = CRM_Core_Config::singleton();
3397
3398     $sub = array();
3399
3400     //By default, $sub elements should be joined together with OR statements (don't change this variable).
3401     $subGlue = ' OR ';
3402
3403     $firstChar = substr($value, 0, 1);
3404     $lastChar = substr($value, -1, 1);
3405     $quotes = array("'", '"');
3406     // If string is quoted, strip quotes and otherwise don't alter it
3407     if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3408       $value = trim($value, implode('', $quotes));
3409     }
3410     // Replace spaces with wildcards for a LIKE operation
3411     // UNLESS string contains a comma (this exception is a tiny bit questionable)
3412     elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3413       $value = str_replace(' ', '%', $value);
3414     }
3415     $value = CRM_Core_DAO::escapeString(trim($value));
3416     if (strlen($value)) {
3417       $fieldsub = array();
3418       $value = "'" . self::getWildCardedValue($wildcard, $op, $value) . "'";
3419       if ($fieldName == 'sort_name') {
3420         $wc = "contact_a.sort_name";
3421       }
3422       else {
3423         $wc = "contact_a.display_name";
3424       }
3425       $fieldsub[] = " ( $wc $op $value )";
3426       if ($config->includeNickNameInName) {
3427         $wc = "contact_a.nick_name";
3428         $fieldsub[] = " ( $wc $op $value )";
3429       }
3430       if ($config->includeEmailInName) {
3431         $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3432       }
3433       $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3434     }
3435
3436     $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3437
3438     $this->_where[$grouping][] = $sub;
3439     if ($config->includeEmailInName) {
3440       $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3441       $this->_qill[$grouping][] = ts('Name or Email') . " $op - '$input'";
3442     }
3443     else {
3444       $this->_qill[$grouping][] = ts('Name') . " $op - '$input'";
3445     }
3446   }
3447
3448   /**
3449    * Where/qill clause for greeting fields.
3450    *
3451    * @param array $values
3452    */
3453   public function greetings(&$values) {
3454     list($name, $op, $value, $grouping, $wildcard) = $values;
3455     $name .= '_display';
3456
3457     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, $name, $value, $op);
3458     $this->_qill[$grouping][] = ts('Greeting %1 %2', array(1 => $qillop, 2 => $qillVal));
3459     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value, 'String');
3460   }
3461
3462   /**
3463    * Where / qill clause for email
3464    *
3465    * @param array $values
3466    * @param string $apiEntity
3467    */
3468   protected function email(&$values, $apiEntity) {
3469     list($name, $op, $value, $grouping, $wildcard) = $values;
3470     $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3471
3472     // CRM-18147: for Contact's GET API, email fieldname got appended with its entity as in {$apiEntiy}_{$name}
3473     // so following code is use build whereClause for contact's primart email id
3474     if (!empty($apiEntity)) {
3475       $dataType = 'String';
3476       if ($name == 'email_id') {
3477         $dataType = 'Integer';
3478         $name = 'id';
3479       }
3480
3481       $this->_where[$grouping][] = self::buildClause('civicrm_email.is_primary', '=', 1, 'Integer');
3482       $this->_where[$grouping][] = self::buildClause("civicrm_email.$name", $op, $value, $dataType);
3483       return;
3484     }
3485
3486     $n = trim($value);
3487     if ($n) {
3488       if (substr($n, 0, 1) == '"' &&
3489         substr($n, -1, 1) == '"'
3490       ) {
3491         $n = substr($n, 1, -1);
3492         $value = CRM_Core_DAO::escapeString($n);
3493         $op = '=';
3494       }
3495       else {
3496         $value = self::getWildCardedValue($wildcard, $op, $n);
3497       }
3498       $this->_qill[$grouping][] = ts('Email') . " $op '$n'";
3499       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String');
3500     }
3501     else {
3502       $this->_qill[$grouping][] = ts('Email') . " $op ";
3503       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String');
3504     }
3505   }
3506
3507   /**
3508    * Where / qill clause for phone number
3509    *
3510    * @param array $values
3511    */
3512   public function phone_numeric(&$values) {
3513     list($name, $op, $value, $grouping, $wildcard) = $values;
3514     // Strip non-numeric characters; allow wildcards
3515     $number = preg_replace('/[^\d%]/', '', $value);
3516     if ($number) {
3517       if (strpos($number, '%') === FALSE) {
3518         $number = "%$number%";
3519       }
3520
3521       $this->_qill[$grouping][] = ts('Phone number contains') . " $number";
3522       $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3523       $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3524     }
3525   }
3526
3527   /**
3528    * Where / qill clause for phone type/location
3529    *
3530    * @param array $values
3531    */
3532   public function phone_option_group($values) {
3533     list($name, $op, $value, $grouping, $wildcard) = $values;
3534     $option = ($name == 'phone_phone_type_id' ? 'phone_type_id' : 'location_type_id');
3535     $options = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', $option);
3536     $optionName = $options[$value];
3537     $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName";
3538     $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3539     $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3540   }
3541
3542   /**
3543    * Where / qill clause for street_address.
3544    *
3545    * @param array $values
3546    */
3547   public function street_address(&$values) {
3548     list($name, $op, $value, $grouping, $wildcard) = $values;
3549
3550     if (!$op) {
3551       $op = 'LIKE';
3552     }
3553
3554     $n = trim($value);
3555
3556     if ($n) {
3557       if (strpos($value, '%') === FALSE) {
3558         // only add wild card if not there
3559         $value = "%{$value}%";
3560       }
3561       $op = 'LIKE';
3562       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, $value, 'String');
3563       $this->_qill[$grouping][] = ts('Street') . " $op '$n'";
3564     }
3565     else {
3566       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3567       $this->_qill[$grouping][] = ts('Street') . " $op ";
3568     }
3569
3570     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3571   }
3572
3573   /**
3574    * Where / qill clause for street_unit.
3575    *
3576    * @param array $values
3577    */
3578   public function street_number(&$values) {
3579     list($name, $op, $value, $grouping, $wildcard) = $values;
3580
3581     if (!$op) {
3582       $op = '=';
3583     }
3584
3585     $n = trim($value);
3586
3587     if (strtolower($n) == 'odd') {
3588       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3589       $this->_qill[$grouping][] = ts('Street Number is odd');
3590     }
3591     elseif (strtolower($n) == 'even') {
3592       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3593       $this->_qill[$grouping][] = ts('Street Number is even');
3594     }
3595     else {
3596       $value = strtolower($n);
3597
3598       // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
3599       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3600       $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'";
3601     }
3602
3603     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3604   }
3605
3606   /**
3607    * Where / qill clause for sorting by character.
3608    *
3609    * @param array $values
3610    */
3611   public function sortByCharacter(&$values) {
3612     list($name, $op, $value, $grouping, $wildcard) = $values;
3613
3614     $name = trim($value);
3615     $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'";
3616     $this->_where[$grouping][] = $cond;
3617     $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3618   }
3619
3620   /**
3621    * Where / qill clause for including contact ids.
3622    */
3623   public function includeContactIDs() {
3624     if (!$this->_includeContactIds || empty($this->_params)) {
3625       return;
3626     }
3627
3628     $contactIds = array();
3629     foreach ($this->_params as $id => $values) {
3630       if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
3631         $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN);
3632       }
3633     }
3634     CRM_Utils_Type::validateAll($contactIds, 'Positive');
3635     if (!empty($contactIds)) {
3636       $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3637     }
3638   }
3639
3640   /**
3641    * Where / qill clause for postal code.
3642    *
3643    * @param array $values
3644    */
3645   public function postalCode(&$values) {
3646     // skip if the fields dont have anything to do with postal_code
3647     if (empty($this->_fields['postal_code'])) {
3648       return;
3649     }
3650
3651     list($name, $op, $value, $grouping, $wildcard) = $values;
3652
3653     // Handle numeric postal code range searches properly by casting the column as numeric
3654     if (is_numeric($value)) {
3655       $field = "IF (civicrm_address.postal_code REGEXP '^[0-9]{1,10}$', CAST(civicrm_address.postal_code AS UNSIGNED), 0)";
3656       $val = CRM_Utils_Type::escape($value, 'Integer');
3657     }
3658     else {
3659       $field = 'civicrm_address.postal_code';
3660       // Per CRM-17060 we might be looking at an 'IN' syntax so don't case arrays to string.
3661       if (!is_array($value)) {
3662         $val = CRM_Utils_Type::escape($value, 'String');
3663       }
3664       else {
3665         // Do we need to escape values here? I would expect buildClause does.
3666         $val = $value;
3667       }
3668     }
3669
3670     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3671
3672     if ($name == 'postal_code') {
3673       $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String');
3674       $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}";
3675     }
3676     elseif ($name == 'postal_code_low') {
3677       $this->_where[$grouping][] = " ( $field >= '$val' ) ";
3678       $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3679     }
3680     elseif ($name == 'postal_code_high') {
3681       $this->_where[$grouping][] = " ( $field <= '$val' ) ";
3682       $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3683     }
3684   }
3685
3686   /**
3687    * Where / qill clause for location type.
3688    *
3689    * @param array $values
3690    * @param null $status
3691    *
3692    * @return string
3693    */
3694   public function locationType(&$values, $status = NULL) {
3695     list($name, $op, $value, $grouping, $wildcard) = $values;
3696
3697     if (is_array($value)) {
3698       $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3699       $this->_tables['civicrm_address'] = 1;
3700       $this->_whereTables['civicrm_address'] = 1;
3701
3702       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
3703       $names = array();
3704       foreach ($value as $id) {
3705         $names[] = $locationType[$id];
3706       }
3707
3708       $this->_primaryLocation = FALSE;
3709
3710       if (!$status) {
3711         $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3712       }
3713       else {
3714         return implode(' ' . ts('or') . ' ', $names);
3715       }
3716     }
3717   }
3718
3719   /**
3720    * @param $values
3721    * @param bool $fromStateProvince
3722    *
3723    * @return array|NULL
3724    */
3725   public function country(&$values, $fromStateProvince = TRUE) {
3726     list($name, $op, $value, $grouping, $wildcard) = $values;
3727
3728     if (!$fromStateProvince) {
3729       $stateValues = $this->getWhereValues('state_province', $grouping);
3730       if (!empty($stateValues)) {
3731         // return back to caller if there are state province values
3732         // since that handles this case
3733         return NULL;
3734       }
3735     }
3736
3737     $countryClause = $countryQill = NULL;
3738     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) || ($values && !empty($value))) {
3739       $this->_tables['civicrm_address'] = 1;
3740       $this->_whereTables['civicrm_address'] = 1;
3741
3742       $countryClause = self::buildClause('civicrm_address.country_id', $op, $value, 'Positive');
3743       list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, 'country_id', $value, $op);
3744       $countryQill = ts("%1 %2 %3", array(1 => 'Country', 2 => $qillop, 3 => $qillVal));
3745
3746       if (!$fromStateProvince) {
3747         $this->_where[$grouping][] = $countryClause;
3748         $this->_qill[$grouping][] = $countryQill;
3749       }
3750     }
3751
3752     if ($fromStateProvince) {
3753       if (!empty($countryClause)) {
3754         return array(
3755           $countryClause,
3756           " ...AND... " . $countryQill,
3757         );
3758       }
3759       else {
3760         return array(NULL, NULL);
3761       }
3762     }
3763   }
3764
3765   /**
3766    * Where / qill clause for county (if present).
3767    *
3768    * @param array $values
3769    * @param null $status
3770    *
3771    * @return string
3772    */
3773   public function county(&$values, $status = NULL) {
3774     list($name, $op, $value, $grouping, $wildcard) = $values;
3775
3776     if (!is_array($value)) {
3777       // force the county to be an array
3778       $value = array($value);
3779     }
3780
3781     // check if the values are ids OR names of the counties
3782     $inputFormat = 'id';
3783     foreach ($value as $v) {
3784       if (!is_numeric($v)) {
3785         $inputFormat = 'name';
3786         break;
3787       }
3788     }
3789     $names = array();
3790     if ($op == '=') {
3791       $op = 'IN';
3792     }
3793     elseif ($op == '!=') {
3794       $op = 'NOT IN';
3795     }
3796     else {
3797       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3798       $op = str_replace('EMPTY', 'NULL', $op);
3799     }
3800
3801     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3802       $clause = "civicrm_address.county_id $op";
3803     }
3804     elseif ($inputFormat == 'id') {
3805       $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3806
3807       $county = CRM_Core_PseudoConstant::county();
3808       foreach ($value as $id) {
3809         $names[] = CRM_Utils_Array::value($id, $county);
3810       }
3811     }
3812     else {
3813       $inputClause = array();
3814       $county = CRM_Core_PseudoConstant::county();
3815       foreach ($value as $name) {
3816         $name = trim($name);
3817         $inputClause[] = CRM_Utils_Array::key($name, $county);
3818       }
3819       $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3820       $names = $value;
3821     }
3822     $this->_tables['civicrm_address'] = 1;
3823     $this->_whereTables['civicrm_address'] = 1;
3824
3825     $this->_where[$grouping][] = $clause;
3826     if (!$status) {
3827       $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3828     }
3829     else {
3830       return implode(' ' . ts('or') . ' ', $names);
3831     }
3832   }
3833
3834   /**
3835    * Where / qill clause for state/province AND country (if present).
3836    *
3837    * @param array $values
3838    * @param null $status
3839    *
3840    * @return string
3841    */
3842   public function stateProvince(&$values, $status = NULL) {
3843     list($name, $op, $value, $grouping, $wildcard) = $values;
3844
3845     $stateClause = self::buildClause('civicrm_address.state_province_id', $op, $value, 'Positive');
3846     $this->_tables['civicrm_address'] = 1;
3847     $this->_whereTables['civicrm_address'] = 1;
3848
3849     $countryValues = $this->getWhereValues('country', $grouping);
3850     list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3851     if ($countryClause) {
3852       $clause = "( $stateClause AND $countryClause )";
3853     }
3854     else {
3855       $clause = $stateClause;
3856     }
3857
3858     $this->_where[$grouping][] = $clause;
3859     list($qillop, $qillVal) = self::buildQillForFieldValue('CRM_Core_DAO_Address', "state_province_id", $value, $op);
3860     if (!$status) {
3861       $this->_qill[$grouping][] = ts("State/Province %1 %2 %3", array(1 => $qillop, 2 => $qillVal, 3 => $countryQill));
3862     }
3863     else {
3864       return implode(' ' . ts('or') . ' ', $qillVal) . $countryQill;
3865     }
3866   }
3867
3868   /**
3869    * Where / qill clause for change log.
3870    *
3871    * @param array $values
3872    */
3873   public function changeLog(&$values) {
3874     list($name, $op, $value, $grouping, $wildcard) = $values;
3875
3876     $targetName = $this->getWhereValues('changed_by', $grouping);
3877     if (!$targetName) {
3878       return;
3879     }
3880
3881     $name = trim($targetName[2]);
3882     $name = strtolower(CRM_Core_DAO::escapeString($name));
3883     $name = $targetName[4] ? "%$name%" : $name;
3884     $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3885     $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1;
3886     $this->_qill[$grouping][] = ts('Modified By') . " $name";
3887   }
3888
3889   /**
3890    * @param $values
3891    */
3892   public function modifiedDates($values) {
3893     $this->_useDistinct = TRUE;
3894
3895     // CRM-11281, default to added date if not set
3896     $fieldTitle = ts('Added Date');
3897     $fieldName = 'created_date';
3898     foreach (array_keys($this->_params) as $id) {
3899       if ($this->_params[$id][0] == 'log_date') {
3900         if ($this->_params[$id][2] == 2) {
3901           $fieldTitle = ts('Modified Date');
3902           $fieldName = 'modified_date';
3903         }
3904       }
3905     }
3906
3907     $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3908
3909     self::$_openedPanes[ts('Change Log')] = TRUE;
3910   }
3911
3912   /**
3913    * @param $values
3914    */
3915   public function demographics(&$values) {
3916     list($name, $op, $value, $grouping, $wildcard) = $values;
3917
3918     if (($name == 'age_low') || ($name == 'age_high')) {
3919       $this->ageRangeQueryBuilder($values,
3920         'contact_a', 'age', 'birth_date', ts('Age')
3921       );
3922     }
3923     elseif (($name == 'birth_date_low') || ($name == 'birth_date_high')) {
3924
3925       $this->dateQueryBuilder($values,
3926         'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3927       );
3928     }
3929     elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) {
3930
3931       $this->dateQueryBuilder($values,
3932         'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3933       );
3934     }
3935
3936     self::$_openedPanes[ts('Demographics')] = TRUE;
3937   }
3938
3939   /**
3940    * @param $values
3941    */
3942   public function privacy(&$values) {
3943     list($name, $op, $value, $grouping, $wildcard) = $values;
3944     //fixed for profile search listing CRM-4633
3945     if (strpbrk($value, "[")) {
3946       $value = "'{$value}'";
3947       $op = "!{$op}";
3948       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3949     }
3950     else {
3951       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3952     }
3953     $field = CRM_Utils_Array::value($name, $this->_fields);
3954     $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
3955     $title = $field ? $field['title'] : $name;
3956     $this->_qill[$grouping][] = "$title $op $value";
3957   }
3958
3959   /**
3960    * @param $values
3961    */
3962   public function privacyOptions($values) {
3963     list($name, $op, $value, $grouping, $wildcard) = $values;
3964
3965     if (empty($value) || !is_array($value)) {
3966       return;
3967     }
3968
3969     // get the operator and toggle values
3970     $opValues = $this->getWhereValues('privacy_operator', $grouping);
3971     $operator = 'OR';
3972     if ($opValues &&
3973       strtolower($opValues[2] == 'AND')
3974     ) {
3975       $operator = 'AND';
3976     }
3977
3978     $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3979     $compareOP = '!';
3980     if ($toggleValues &&
3981       $toggleValues[2] == 2
3982     ) {
3983       $compareOP = '';
3984     }
3985
3986     $clauses = array();
3987     $qill = array();
3988     foreach ($value as $dontCare => $pOption) {
3989       $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
3990       $field = CRM_Utils_Array::value($pOption, $this->_fields);
3991       $title = $field ? $field['title'] : $pOption;
3992       $qill[] = " $title = 1 ";
3993     }
3994
3995     $this->_where[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
3996     $this->_qill[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
3997   }
3998
3999   /**
4000    * @param $values
4001    */
4002   public function preferredCommunication(&$values) {
4003     list($name, $op, $value, $grouping, $wildcard) = $values;
4004
4005     if (!is_array($value)) {
4006       $value = str_replace(array('(', ')'), '', explode(",", $value));
4007     }
4008     elseif (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
4009       $op = key($value);
4010       $value = $value[$op];
4011     }
4012     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Contact', $name, $value, $op);
4013
4014     if (self::caseImportant($op)) {
4015       $value = implode("[[:cntrl:]]|[[:cntrl:]]", (array) $value);
4016       $op = (strstr($op, '!') || strstr($op, 'NOT')) ? 'NOT RLIKE' : 'RLIKE';
4017       $value = "[[:cntrl:]]" . $value . "[[:cntrl:]]";
4018     }
4019
4020     $this->_where[$grouping][] = self::buildClause("contact_a.preferred_communication_method", $op, $value);
4021     $this->_qill[$grouping][] = ts('Preferred Communication Method %1 %2', array(1 => $qillop, 2 => $qillVal));
4022   }
4023
4024   /**
4025    * Where / qill clause for relationship.
4026    *
4027    * @param array $values
4028    */
4029   public function relationship(&$values) {
4030     list($name, $op, $value, $grouping, $wildcard) = $values;
4031     if ($this->_relationshipValuesAdded) {
4032       return;
4033     }
4034     // also get values array for relation_target_name
4035     // for relationship search we always do wildcard
4036     $relationType = $this->getWhereValues('relation_type_id', $grouping);
4037     $targetName = $this->getWhereValues('relation_target_name', $grouping);
4038     $relStatus = $this->getWhereValues('relation_status', $grouping);
4039     $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
4040
4041     $nameClause = $name = NULL;
4042     if ($targetName) {
4043       $name = trim($targetName[2]);
4044       if (substr($name, 0, 1) == '"' &&
4045         substr($name, -1, 1) == '"'
4046       ) {
4047         $name = substr($name, 1, -1);
4048         $name = strtolower(CRM_Core_DAO::escapeString($name));
4049         $nameClause = "= '$name'";
4050       }
4051       else {
4052         $name = strtolower(CRM_Core_DAO::escapeString($name));
4053         $nameClause = "LIKE '%{$name}%'";
4054       }
4055     }
4056
4057     $rTypeValues = $relTypes = $relTypesIds = array();
4058     if (!empty($relationType)) {
4059       $relationType[2] = (array) $relationType[2];
4060       foreach ($relationType[2] as $relType) {
4061         $rel = explode('_', $relType);
4062         self::$_relType = $rel[1];
4063         $params = array('id' => $rel[0]);
4064         $typeValues = array();
4065         $rTypeValue = CRM_Contact_BAO_RelationshipType::retrieve($params, $typeValues);
4066         if (!empty($rTypeValue)) {
4067           $rTypeValues[] = $rTypeValue;
4068           $relTypesIds[] = $rel[0];
4069           $relTypes[] = $relType;
4070         }
4071       }
4072     }
4073     if (!empty($rTypeValues)) {
4074       foreach ($rTypeValues as $rTypeValue) {
4075         $rTypeValue = (array) $rTypeValue;
4076         if ($rTypeValue['name_a_b'] == $rTypeValue['name_b_a']) {
4077           // if we don't know which end of the relationship we are dealing with we'll create a temp table
4078           self::$_relType = 'reciprocal';
4079         }
4080       }
4081     }
4082     // if we are creating a temp table we build our own where for the relationship table
4083     $relationshipTempTable = NULL;
4084     if (self::$_relType == 'reciprocal') {
4085       $where = array();
4086       self::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO::createTempTableName('civicrm_rel');
4087       if ($nameClause) {
4088         $where[$grouping][] = " sort_name $nameClause ";
4089       }
4090       $groupJoinTable = "civicrm_relationship";
4091       $groupJoinColumn = "contact_id_alt";
4092     }
4093     else {
4094       $where = &$this->_where;
4095       if ($nameClause) {
4096         $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
4097       }
4098       $groupJoinTable = "contact_b";
4099       $groupJoinColumn = "id";
4100     }
4101     $allRelationshipType = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, NULL, TRUE);
4102     if ($nameClause || !$targetGroup) {
4103       if (!empty($relationType)) {
4104         $relQill = '';
4105         foreach ($relTypes as $rel) {
4106           if (!empty($relQill)) {
4107             $relQill .= ' OR ';
4108           }
4109           $relQill .= $allRelationshipType[$rel];
4110         }
4111         $this->_qill[$grouping][] = 'Relationship Type(s) ' . $relQill . " $name";
4112       }
4113       else {
4114         $this->_qill[$grouping][] = $name;
4115       }
4116     }
4117
4118     //check to see if the target contact is in specified group
4119     if ($targetGroup) {
4120       //add contacts from static groups
4121       $this->_tables['civicrm_relationship_group_contact'] = $this->_whereTables['civicrm_relationship_group_contact']
4122         = " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = {$groupJoinTable}.{$groupJoinColumn} AND civicrm_relationship_group_contact.status = 'Added'";
4123       $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN  (" .
4124         implode(",", $targetGroup[2]) . ") ) ";
4125
4126       //add contacts from saved searches
4127       $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", $groupJoinTable, $op, $groupJoinColumn);
4128
4129       //set the group where clause
4130       if ($ssWhere) {
4131         $groupWhere[] = "( " . $ssWhere . " )";
4132       }
4133       $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4134
4135       //Get the names of the target groups for the qill
4136       $groupNames = CRM_Core_PseudoConstant::group();
4137       $qillNames = array();
4138       foreach ($targetGroup[2] as $groupId) {
4139         if (array_key_exists($groupId, $groupNames)) {
4140           $qillNames[] = $groupNames[$groupId];
4141         }
4142       }
4143       if (!empty($relationType)) {
4144         $relQill = '';
4145         foreach ($relTypes as $rel) {
4146           if (!empty($relQill)) {
4147             $relQill .= ' OR ';
4148           }
4149           $relQill .= CRM_Utils_Array::value($rel, $allRelationshipType);
4150         }
4151         $this->_qill[$grouping][] = 'Relationship Type(s) ' . $relQill . " ( " . implode(", ", $qillNames) . " )";
4152       }
4153       else {
4154         $this->_qill[$grouping][] = implode(", ", $qillNames);
4155       }
4156     }
4157
4158     // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4159     $today = date('Ymd');
4160     //check for active, inactive and all relation status
4161     if ($relStatus[2] == 0) {
4162       $where[$grouping][] = "(
4163 civicrm_relationship.is_active = 1 AND
4164 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4165 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4166 )";
4167       $this->_qill[$grouping][] = ts('Relationship - Active and Current');
4168     }
4169     elseif ($relStatus[2] == 1) {
4170       $where[$grouping][] = "(
4171 civicrm_relationship.is_active = 0 OR
4172 civicrm_relationship.end_date < {$today} OR
4173 civicrm_relationship.start_date > {$today}
4174 )";
4175       $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current');
4176     }
4177
4178     $onlyDeleted = 0;
4179     if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params)) {
4180       $onlyDeleted = 1;
4181     }
4182     $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4183
4184     $this->addRelationshipPermissionClauses($grouping, $where);
4185     $this->addRelationshipDateClauses($grouping, $where);
4186     $this->addRelationshipActivePeriodClauses($grouping, $where);
4187     if (!empty($relTypes)) {
4188       $where[$grouping][] = 'civicrm_relationship.relationship_type_id IN (' . implode(',', $relTypesIds) . ')';
4189     }
4190     $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1;
4191     $this->_useDistinct = TRUE;
4192     $this->_relationshipValuesAdded = TRUE;
4193     // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4194     // join on that,
4195     if ($relationshipTempTable) {
4196       $whereClause = '';
4197       if (!empty($where[$grouping])) {
4198         $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4199         $whereClause = str_replace('contact_b', 'c', $whereClause);
4200       }
4201       $sql = "
4202         CREATE TEMPORARY TABLE {$relationshipTempTable}
4203           (
4204             `contact_id` int(10) unsigned NOT NULL DEFAULT '0',
4205             `contact_id_alt` int(10) unsigned NOT NULL DEFAULT '0',
4206             KEY `contact_id` (`contact_id`),
4207             KEY `contact_id_alt` (`contact_id_alt`)
4208           )
4209           (SELECT contact_id_b as contact_id, contact_id_a as contact_id_alt, civicrm_relationship.id
4210             FROM civicrm_relationship
4211             INNER JOIN  civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4212             $whereClause )
4213           UNION
4214             (SELECT contact_id_a as contact_id, contact_id_b as contact_id_alt, civicrm_relationship.id
4215             FROM civicrm_relationship
4216             INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4217             $whereClause )
4218       ";
4219       CRM_Core_DAO::executeQuery($sql);
4220     }
4221   }
4222
4223   public function addRelationshipPermissionClauses($grouping, &$where) {
4224     $relPermission = $this->getWhereValues('relation_permission', $grouping);
4225     if ($relPermission) {
4226       if (!is_array($relPermission[2])) {
4227         // this form value was scalar in previous versions of Civi
4228         $relPermission[2] = array($relPermission[2]);
4229       }
4230       $where[$grouping][] = "(civicrm_relationship.is_permission_a_b IN (" . implode(",", $relPermission[2]) . "))";
4231
4232       $allRelationshipPermissions = CRM_Contact_BAO_Relationship::buildOptions('is_permission_a_b');
4233       $relQill = '';
4234       foreach ($relPermission[2] as $rel) {
4235         if (!empty($relQill)) {
4236           $relQill .= ' OR ';
4237         }
4238         $relQill .= ts($allRelationshipPermissions[$rel]);
4239       }
4240       $this->_qill[$grouping][] = ts('Permissioned Relationships') . ' - ' . $relQill;
4241     }
4242   }
4243
4244   /**
4245    * Add start & end date criteria in
4246    * @param string $grouping
4247    * @param array $where
4248    *   = array to add where clauses to, in case you are generating a temp table.
4249    * not the main query.
4250    */
4251   public function addRelationshipDateClauses($grouping, &$where) {
4252     $dateValues = array();
4253     $dateTypes = array(
4254       'start_date',
4255       'end_date',
4256     );
4257
4258     foreach ($dateTypes as $dateField) {
4259       $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4260       $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4261       if (!empty($dateValueLow)) {
4262         $date = date('Ymd', strtotime($dateValueLow[2]));
4263         $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4264         $this->_qill[$grouping][] = ($dateField == 'end_date' ? ts('Relationship Ended on or After') : ts('Relationship Recorded Start Date On or After')) . " " . CRM_Utils_Date::customFormat($date);
4265       }
4266       if (!empty($dateValueHigh)) {
4267         $date = date('Ymd', strtotime($dateValueHigh[2]));
4268         $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4269         $this->_qill[$grouping][] = ($dateField == 'end_date' ? ts('Relationship Ended on or Before') : ts('Relationship Recorded Start Date On or Before')) . " " . CRM_Utils_Date::customFormat($date);
4270       }
4271     }
4272   }
4273
4274   /**
4275    * Add start & end active period criteria in
4276    * @param string $grouping
4277    * @param array $where
4278    *   = array to add where clauses to, in case you are generating a temp table.
4279    * not the main query.
4280    */
4281   public function addRelationshipActivePeriodClauses($grouping, &$where) {
4282     $dateValues = array();
4283     $dateField = 'active_period_date';
4284
4285     $dateValueLow = $this->getWhereValues('relation_active_period_date_low', $grouping);
4286     $dateValueHigh = $this->getWhereValues('relation_active_period_date_high', $grouping);
4287     $dateValueLowFormated = $dateValueHighFormated = NULL;
4288     if (!empty($dateValueLow) && !empty($dateValueHigh)) {
4289       $dateValueLowFormated = date('Ymd', strtotime($dateValueLow[2]));
4290       $dateValueHighFormated = date('Ymd', strtotime($dateValueHigh[2]));
4291       $this->_qill[$grouping][] = (ts('Relationship was active between')) . " " . CRM_Utils_Date::customFormat($dateValueLowFormated) . " and " . CRM_Utils_Date::customFormat($dateValueHighFormated);
4292     }
4293     elseif (!empty($dateValueLow)) {
4294       $dateValueLowFormated = date('Ymd', strtotime($dateValueLow[2]));
4295       $this->_qill[$grouping][] = (ts('Relationship was active after')) . " " . CRM_Utils_Date::customFormat($dateValueLowFormated);
4296     }
4297     elseif (!empty($dateValueHigh)) {
4298       $dateValueHighFormated = date('Ymd', strtotime($dateValueHigh[2]));
4299       $this->_qill[$grouping][] = (ts('Relationship was active before')) . " " . CRM_Utils_Date::customFormat($dateValueHighFormated);
4300     }
4301
4302     if ($activePeriodClauses = self::getRelationshipActivePeriodClauses($dateValueLowFormated, $dateValueHighFormated, TRUE)) {
4303       $where[$grouping][] = $activePeriodClauses;
4304     }
4305   }
4306
4307   /**
4308    * Get start & end active period criteria
4309    */
4310   public static function getRelationshipActivePeriodClauses($from, $to, $forceTableName) {
4311     $tableName = $forceTableName ? 'civicrm_relationship.' : '';
4312     if (!is_null($from) && !is_null($to)) {
4313       return '(((' . $tableName . 'start_date >= ' . $from . ' AND ' . $tableName . 'start_date <= ' . $to . ') OR
4314                 (' . $tableName . 'end_date >= ' . $from . ' AND ' . $tableName . 'end_date <= ' . $to . ') OR
4315                 (' . $tableName . 'start_date <= ' . $from . ' AND ' . $tableName . 'end_date >= ' . $to . ' )) OR
4316                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4317                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date >= ' . $from . ') OR
4318                (' . $tableName . 'end_date IS NULL AND ' . $tableName . 'start_date <= ' . $to . '))';
4319     }
4320     elseif (!is_null($from)) {
4321       return '((' . $tableName . 'start_date >= ' . $from . ') OR
4322                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4323                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date >= ' . $from . '))';
4324     }
4325     elseif (!is_null($to)) {
4326       return '((' . $tableName . 'start_date <= ' . $to . ') OR
4327                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4328                (' . $tableName . 'end_date IS NULL AND ' . $tableName . 'start_date <= ' . $to . '))';
4329     }
4330   }
4331
4332   /**
4333    * Default set of return properties.
4334    *
4335    * @param int $mode
4336    *
4337    * @return array
4338    *   derault return properties
4339    */
4340   public static function &defaultReturnProperties($mode = 1) {
4341     if (!isset(self::$_defaultReturnProperties)) {
4342       self::$_defaultReturnProperties = array();
4343     }
4344
4345     if (!isset(self::$_defaultReturnProperties[$mode])) {
4346       // add activity return properties
4347       if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
4348         self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE);
4349       }
4350       else {
4351         self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE);
4352       }
4353
4354       if (empty(self::$_defaultReturnProperties[$mode])) {
4355         self::$_defaultReturnProperties[$mode] = array(
4356           'home_URL' => 1,
4357           'image_URL' => 1,
4358           'legal_identifier' => 1,
4359           'external_identifier' => 1,
4360           'contact_type' => 1,
4361           'contact_sub_type' => 1,
4362           'sort_name' => 1,
4363           'display_name' => 1,
4364           'preferred_mail_format' => 1,
4365           'nick_name' => 1,
4366           'first_name' => 1,
4367           'middle_name' => 1,
4368           'last_name' => 1,
4369           'prefix_id' => 1,
4370           'suffix_id' => 1,
4371           'formal_title' => 1,
4372           'communication_style_id' => 1,
4373           'birth_date' => 1,
4374           'gender_id' => 1,
4375           'street_address' => 1,
4376           'supplemental_address_1' => 1,
4377           'supplemental_address_2' => 1,
4378           'supplemental_address_3' => 1,
4379           'city' => 1,
4380           'postal_code' => 1,
4381           'postal_code_suffix' => 1,
4382           'state_province' => 1,
4383           'country' => 1,
4384           'world_region' => 1,
4385           'geo_code_1' => 1,
4386           'geo_code_2' => 1,
4387           'email' => 1,
4388           'on_hold' => 1,
4389           'phone' => 1,
4390           'im' => 1,
4391           'household_name' => 1,
4392           'organization_name' => 1,
4393           'deceased_date' => 1,
4394           'is_deceased' => 1,
4395           'job_title' => 1,
4396           'legal_name' => 1,
4397           'sic_code' => 1,
4398           'current_employer' => 1,
4399           // FIXME: should we use defaultHierReturnProperties() for the below?
4400           'do_not_email' => 1,
4401           'do_not_mail' => 1,
4402           'do_not_sms' => 1,
4403           'do_not_phone' => 1,
4404           'do_not_trade' => 1,
4405           'is_opt_out' => 1,
4406           'contact_is_deleted' => 1,
4407           'preferred_communication_method' => 1,
4408           'preferred_language' => 1,
4409         );
4410       }
4411     }
4412     return self::$_defaultReturnProperties[$mode];
4413   }
4414
4415   /**
4416    * Get primary condition for a sql clause.
4417    *
4418    * @param int $value
4419    *
4420    * @return string|NULL
4421    */
4422   public static function getPrimaryCondition($value) {
4423     if (is_numeric($value)) {
4424       $value = (int ) $value;
4425       return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0';
4426     }
4427     return NULL;
4428   }
4429
4430   /**
4431    * Wrapper for a simple search query.
4432    *
4433    * @param array $params
4434    * @param array $returnProperties
4435    * @param bool $count
4436    *
4437    * @return string
4438    */
4439   public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4440     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4441     list($select, $from, $where, $having) = $query->query();
4442     $groupBy = ($query->_useGroupBy) ? 'GROUP BY contact_a.id' : '';
4443
4444     $query = "$select $from $where $groupBy $having";
4445     return $query;
4446   }
4447
4448   /**
4449    * These are stub comments as this function needs more explanation - particularly in terms of how it
4450    * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4451    *
4452    * This function was originally written as a wrapper for the api query but is called from multiple places
4453    * in the core code directly so the name is misleading. This function does not use the searchQuery function
4454    * but it is unclear as to whehter that is historical or there is a reason
4455    *  CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4456    *
4457    * @param array $params
4458    * @param array $returnProperties
4459    * @param null $fields
4460    * @param string $sort
4461    * @param int $offset
4462    * @param int $row_count
4463    * @param bool $smartGroupCache
4464    *   ?? update smart group cache?.
4465    * @param bool $count
4466    *   Return count obnly.
4467    * @param bool $skipPermissions
4468    *   Should permissions be ignored or should the logged in user's permissions be applied.
4469    * @param int $mode
4470    *   This basically correlates to the component.
4471    * @param string $apiEntity
4472    *   The api entity being called.
4473    *   This sort-of duplicates $mode in a confusing way. Probably not by design.
4474    *
4475    * @param bool|null $primaryLocationOnly
4476    * @return array
4477    */
4478   public static function apiQuery(
4479     $params = NULL,
4480     $returnProperties = NULL,
4481     $fields = NULL,
4482     $sort = NULL,
4483     $offset = 0,
4484     $row_count = 25,
4485     $smartGroupCache = TRUE,
4486     $count = FALSE,
4487     $skipPermissions = TRUE,
4488     $mode = CRM_Contact_BAO_Query::MODE_CONTACTS,
4489     $apiEntity = NULL,
4490     $primaryLocationOnly = NULL
4491   ) {
4492
4493     $query = new CRM_Contact_BAO_Query(
4494       $params, $returnProperties,
4495       NULL, TRUE, FALSE, $mode,
4496       $skipPermissions,
4497       TRUE, $smartGroupCache,
4498       NULL, 'AND',
4499       $apiEntity, $primaryLocationOnly
4500     );
4501
4502     //this should add a check for view deleted if permissions are enabled
4503     if ($skipPermissions) {
4504       $query->_skipDeleteClause = TRUE;
4505     }
4506     $query->generatePermissionClause(FALSE, $count);
4507
4508     // note : this modifies _fromClause and _simpleFromClause
4509     $query->includePseudoFieldsJoin($sort);
4510
4511     list($select, $from, $where, $having) = $query->query($count);
4512
4513     $options = $query->_options;
4514     if (!empty($query->_permissionWhereClause)) {
4515       if (empty($where)) {
4516         $where = "WHERE $query->_permissionWhereClause";
4517       }
4518       else {
4519         $where = "$where AND $query->_permissionWhereClause";
4520       }
4521     }
4522
4523     $sql = "$select $from $where $having";
4524
4525     // add group by only when API action is not getcount
4526     //  otherwise query fetches incorrect count
4527     if ($query->_useGroupBy && !$count) {
4528       $sql .= self::getGroupByFromSelectColumns($query->_select, 'contact_a.id');
4529     }
4530     if (!empty($sort)) {
4531       $sort = CRM_Utils_Type::escape($sort, 'String');
4532       $sql .= " ORDER BY $sort ";
4533     }
4534     if ($row_count > 0 && $offset >= 0) {
4535       $offset = CRM_Utils_Type::escape($offset, 'Int');
4536       $row_count = CRM_Utils_Type::escape($row_count, 'Int');
4537       $sql .= " LIMIT $offset, $row_count ";
4538     }
4539
4540     $dao = CRM_Core_DAO::executeQuery($sql);
4541
4542     // @todo derive this from the component class rather than hard-code two options.
4543     $entityIDField = ($mode == CRM_Contact_BAO_Query::MODE_CONTRIBUTE) ? 'contribution_id' : 'contact_id';
4544
4545     $values = array();
4546     while ($dao->fetch()) {
4547       if ($count) {
4548         $noRows = $dao->rowCount;
4549         $dao->free();
4550         return array($noRows, NULL);
4551       }
4552       $val = $query->store($dao);
4553       $convertedVals = $query->convertToPseudoNames($dao, TRUE, TRUE);
4554
4555       if (!empty($convertedVals)) {
4556         $val = array_replace_recursive($val, $convertedVals);
4557       }
4558       $values[$dao->$entityIDField] = $val;
4559     }
4560     $dao->free();
4561     return array($values, $options);
4562   }
4563
4564   /**
4565    * Get the actual custom field name by stripping off the appended string.
4566    *
4567    * The string could be _relative, _from, or _to
4568    *
4569    * @todo use metadata rather than convention to do this.
4570    *
4571    * @param string $parameterName
4572    *   The name of the parameter submitted to the form.
4573    *   e.g
4574    *   custom_3_relative
4575    *   custom_3_from
4576    *
4577    * @return string
4578    */
4579   public static function getCustomFieldName($parameterName) {
4580     if (substr($parameterName, -5, 5) == '_from') {
4581       return substr($parameterName, 0, strpos($parameterName, '_from'));
4582     }
4583     if (substr($parameterName, -9, 9) == '_relative') {
4584       return substr($parameterName, 0, strpos($parameterName, '_relative'));
4585     }
4586     if (substr($parameterName, -3, 3) == '_to') {
4587       return substr($parameterName, 0, strpos($parameterName, '_to'));
4588     }
4589   }
4590
4591   /**
4592    * Convert submitted values for relative custom fields to query object format.
4593    *
4594    * The query will support the sqlOperator format so convert to that format.
4595    *
4596    * @param array $formValues
4597    *   Submitted values.
4598    * @param array $params
4599    *   Converted parameters for the query object.
4600    * @param string $values
4601    *   Submitted value.
4602    * @param string $fieldName
4603    *   Submitted field name. (Matches form field not DB field.)
4604    */
4605   protected static function convertCustomRelativeFields(&$formValues, &$params, $values, $fieldName) {
4606     if (empty($values)) {
4607       // e.g we might have relative set & from & to empty. The form flow is a bit funky &
4608       // this function gets called again after they fields have been converted which can get ugly.
4609       return;
4610     }
4611     $customFieldName = self::getCustomFieldName($fieldName);
4612
4613     if (substr($fieldName, -9, 9) == '_relative') {
4614       list($from, $to) = CRM_Utils_Date::getFromTo($values, NULL, NULL);
4615     }
4616     else {
4617       if ($fieldName == $customFieldName . '_to' && CRM_Utils_Array::value($customFieldName . '_from', $formValues)) {
4618         // Both to & from are set. We only need to acton one, choosing from.
4619         return;
4620       }
4621
4622       $from = CRM_Utils_Array::value($customFieldName . '_from', $formValues, NULL);
4623       $to = CRM_Utils_Array::value($customFieldName . '_to', $formValues, NULL);
4624
4625       if (self::isCustomDateField($customFieldName)) {
4626         list($from, $to) = CRM_Utils_Date::getFromTo(NULL, $from, $to);
4627       }
4628     }
4629
4630     if ($from) {
4631       if ($to) {
4632         $relativeFunction = array('BETWEEN' => array($from, $to));
4633       }
4634       else {
4635         $relativeFunction = array('>=' => $from);
4636       }
4637     }
4638     else {
4639       $relativeFunction = array('<=' => $to);
4640     }
4641     $params[] = array(
4642       $customFieldName,
4643       '=',
4644       $relativeFunction,
4645       0,
4646       0,
4647     );
4648   }
4649
4650   /**
4651    * Are we dealing with custom field of type date.
4652    *
4653    * @param $fieldName
4654    *
4655    * @return bool
4656    */
4657   public static function isCustomDateField($fieldName) {
4658     if (($customFieldID = CRM_Core_BAO_CustomField::getKeyID($fieldName)) == FALSE) {
4659       return FALSE;
4660     }
4661     if ('Date' == civicrm_api3('CustomField', 'getvalue', array('id' => $customFieldID, 'return' => 'data_type'))) {
4662       return TRUE;
4663     }
4664     return FALSE;
4665   }
4666
4667   /**
4668    * Has this field already been reformatting to Query object syntax.
4669    *
4670    * The form layer passed formValues to this function in preProcess & postProcess. Reason unknown. This seems
4671    * to come with associated double queries & is possibly damaging performance.
4672    *
4673    * However, here we add a tested function to ensure convertFormValues identifies pre-processed fields & returns
4674    * them as they are.
4675    *
4676    * @param mixed $values
4677    *   Value in formValues for the field.
4678    *
4679    * @return bool;
4680    */
4681   public static function isAlreadyProcessedForQueryFormat($values) {
4682     if (!is_array($values)) {
4683       return FALSE;
4684     }
4685     if (($operator = CRM_Utils_Array::value(1, $values)) == FALSE) {
4686       return FALSE;
4687     }
4688     return in_array($operator, CRM_Core_DAO::acceptedSQLOperators());
4689   }
4690
4691   /**
4692    * If the state and country are passed remove state.
4693    *
4694    * Country is implicit from the state, but including both results in
4695    * a poor query as there is no combined index on state AND country.
4696    *
4697    * CRM-18125
4698    *
4699    * @param array $formValues
4700    */
4701   public static function filterCountryFromValuesIfStateExists(&$formValues) {
4702     if (!empty($formValues['country']) && !empty($formValues['state_province'])) {
4703       // The use of array map sanitises the data by ensuring we are dealing with integers.
4704       $states = implode(', ', array_map('intval', $formValues['state_province']));
4705       $countryList = CRM_Core_DAO::singleValueQuery(
4706         "SELECT GROUP_CONCAT(country_id) FROM civicrm_state_province WHERE id IN ($states)"
4707       );
4708       if ($countryList == $formValues['country']) {
4709         unset($formValues['country']);
4710       }
4711     }
4712   }
4713
4714   /**
4715    * For some special cases, grouping by subset of select fields becomes mandatory.
4716    * Hence, full_group_by mode is handled by appending any_value
4717    * keyword to select fields not present in groupBy
4718    *
4719    * @param array $selectClauses
4720    * @param array $groupBy - Columns already included in GROUP By clause.
4721    * @param string $aggregateFunction
4722    *
4723    * @return string
4724    */
4725   public static function appendAnyValueToSelect($selectClauses, $groupBy, $aggregateFunction = 'ANY_VALUE') {
4726     if (!CRM_Utils_SQL::disableFullGroupByMode()) {
4727       $groupBy = array_map('trim', (array) $groupBy);
4728       $aggregateFunctions = '/(ROUND|AVG|COUNT|GROUP_CONCAT|SUM|MAX|MIN|IF)[[:blank:]]*\(/i';
4729       foreach ($selectClauses as $key => &$val) {
4730         list($selectColumn, $alias) = array_pad(preg_split('/ as /i', $val), 2, NULL);
4731         // append ANY_VALUE() keyword
4732         if (!in_array($selectColumn, $groupBy) && preg_match($aggregateFunctions, trim($selectColumn)) !== 1) {
4733           $val = ($aggregateFunction == 'GROUP_CONCAT') ?
4734             str_replace($selectColumn, "$aggregateFunction(DISTINCT {$selectColumn})", $val) :
4735             str_replace($selectColumn, "$aggregateFunction({$selectColumn})", $val);
4736         }
4737       }
4738     }
4739
4740     return "SELECT " . implode(', ', $selectClauses) . " ";
4741   }
4742
4743   /**
4744    * For some special cases, where if non-aggregate ORDER BY columns are not present in GROUP BY
4745    *  on full_group_by mode, then append the those missing columns to GROUP BY clause
4746    * keyword to select fields not present in groupBy
4747    *
4748    * @param string $groupBy - GROUP BY clause where missing ORDER BY columns will be appended if not present
4749    * @param array $orderBys - ORDER BY sub-clauses
4750    *
4751    */
4752   public static function getGroupByFromOrderBy(&$groupBy, $orderBys) {
4753     if (!CRM_Utils_SQL::disableFullGroupByMode()) {
4754       foreach ($orderBys as $orderBy) {
4755         $orderBy = str_ireplace(array(' DESC', ' ASC', '`'), '', $orderBy); // remove sort syntax from ORDER BY clauses if present
4756         // if ORDER BY column is not present in GROUP BY then append it to end
4757         if (preg_match('/(MAX|MIN)\(/i', trim($orderBy)) !== 1 && !strstr($groupBy, $orderBy)) {
4758           $groupBy .= ", {$orderBy}";
4759         }
4760       }
4761     }
4762   }
4763
4764   /**
4765    * Include Select columns in groupBy clause.
4766    *
4767    * @param array $selectClauses
4768    * @param array $groupBy - Columns already included in GROUP By clause.
4769    *
4770    * @return string
4771    */
4772   public static function getGroupByFromSelectColumns($selectClauses, $groupBy = NULL) {
4773     $groupBy = (array) $groupBy;
4774     $mysqlVersion = CRM_Core_DAO::singleValueQuery('SELECT VERSION()');
4775     $sqlMode = CRM_Core_DAO::singleValueQuery('SELECT @@sql_mode');
4776
4777     //return if ONLY_FULL_GROUP_BY is not enabled.
4778     if (CRM_Utils_SQL::supportsFullGroupBy() && !empty($sqlMode) && in_array('ONLY_FULL_GROUP_BY', explode(',', $sqlMode))) {
4779       $regexToExclude = '/(ROUND|AVG|COUNT|GROUP_CONCAT|SUM|MAX|MIN|IF)[[:blank:]]*\(/i';
4780       foreach ($selectClauses as $key => $val) {
4781         $aliasArray = preg_split('/ as /i', $val);
4782         // if more than 1 alias we need to split by ','.
4783         if (count($aliasArray) > 2) {
4784           $aliasArray = preg_split('/,/', $val);
4785           foreach ($aliasArray as $key => $value) {
4786             $alias = current(preg_split('/ as /i', $value));
4787             if (!in_array($alias, $groupBy) && preg_match($regexToExclude, trim($alias)) !== 1) {
4788               $groupBy[] = $alias;
4789             }
4790           }
4791         }
4792         else {
4793           list($selectColumn, $alias) = array_pad($aliasArray, 2, NULL);
4794           $dateRegex = '/^(DATE_FORMAT|DATE_ADD|CASE)/i';
4795           $tableName = current(explode('.', $selectColumn));
4796           $primaryKey = "{$tableName}.id";
4797           // exclude columns which are already included in groupBy and aggregate functions from select
4798           // CRM-18439 - Also exclude the columns which are functionally dependent on columns in $groupBy (MySQL 5.7+)
4799           if (!in_array($selectColumn, $groupBy) && !in_array($primaryKey, $groupBy) && preg_match($regexToExclude, trim($selectColumn)) !== 1) {
4800             if (!empty($alias) && preg_match($dateRegex, trim($selectColumn))) {
4801               $groupBy[] = $alias;
4802             }
4803             else {
4804               $groupBy[] = $selectColumn;
4805             }
4806           }
4807         }
4808       }
4809     }
4810
4811     if (!empty($groupBy)) {
4812       return " GROUP BY " . implode(', ', $groupBy);
4813     }
4814     return '';
4815   }
4816
4817   /**
4818    * Create and query the db for an contact search.
4819    *
4820    * @param int $offset
4821    *   The offset for the query.
4822    * @param int $rowCount
4823    *   The number of rows to return.
4824    * @param string|CRM_Utils_Sort $sort
4825    *   The order by string.
4826    * @param bool $count
4827    *   Is this a count only query ?.
4828    * @param bool $includeContactIds
4829    *   Should we include contact ids?.
4830    * @param bool $sortByChar
4831    *   If true returns the distinct array of first characters for search results.
4832    * @param bool $groupContacts
4833    *   If true, return only the contact ids.
4834    * @param bool $returnQuery
4835    *   Should we return the query as a string.
4836    * @param string $additionalWhereClause
4837    *   If the caller wants to further restrict the search (used for components).
4838    * @param null $sortOrder
4839    * @param string $additionalFromClause
4840    *   Should be clause with proper joins, effective to reduce where clause load.
4841    *
4842    * @param bool $skipOrderAndLimit
4843    *
4844    * @return CRM_Core_DAO
4845    */
4846   public function searchQuery(
4847     $offset = 0, $rowCount = 0, $sort = NULL,
4848     $count = FALSE, $includeContactIds = FALSE,
4849     $sortByChar = FALSE, $groupContacts = FALSE,
4850     $returnQuery = FALSE,
4851     $additionalWhereClause = NULL, $sortOrder = NULL,
4852     $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4853   ) {
4854
4855     if ($includeContactIds) {
4856       $this->_includeContactIds = TRUE;
4857       $this->_whereClause = $this->whereClause();
4858     }
4859
4860     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4861
4862     // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4863     // and that contact happens to be deleted, set $onlyDeleted to true
4864     foreach ($this->_params as $values) {
4865       $name = CRM_Utils_Array::value(0, $values);
4866       $op = CRM_Utils_Array::value(1, $values);
4867       $value = CRM_Utils_Array::value(2, $values);
4868       if ($name == 'contact_id' and $op == '=') {
4869         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4870           $onlyDeleted = TRUE;
4871         }
4872         break;
4873       }
4874     }
4875
4876     // building the query string
4877     $groupBy = $groupByCols = NULL;
4878     if (!$count) {
4879       if (isset($this->_groupByComponentClause)) {
4880         $groupBy = $this->_groupByComponentClause;
4881         $groupByCols = preg_replace('/^GROUP BY /', '', trim($this->_groupByComponentClause));
4882         $groupByCols = explode(', ', $groupByCols);
4883       }
4884       elseif ($this->_useGroupBy) {
4885         $groupByCols = array('contact_a.id');
4886       }
4887     }
4888     if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) {
4889       $groupByCols = array('civicrm_activity.id');
4890     }
4891
4892     $order = $orderBy = $limit = '';
4893     if (!$count) {
4894       list($order, $additionalFromClause) = $this->prepareOrderBy($sort, $sortByChar, $sortOrder, $additionalFromClause);
4895
4896       if ($rowCount > 0 && $offset >= 0) {
4897         $offset = CRM_Utils_Type::escape($offset, 'Int');
4898         $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
4899         $limit = " LIMIT $offset, $rowCount ";
4900       }
4901     }
4902     // Two cases where we are disabling FGB (FULL_GROUP_BY_MODE):
4903     //   1. Expecting the search query to return all the first single letter characters of contacts ONLY, but when FGB is enabled
4904     //      MySQL expect the columns present in GROUP BY, must be present in SELECT clause and that results into error, needless to have other columns.
4905     //   2. When GROUP BY columns are present then disable FGB otherwise it demands to add ORDER BY columns in GROUP BY and eventually in SELECT
4906     //     clause. This will impact the search query output.
4907     $disableFullGroupByMode = ($sortByChar || !empty($groupByCols));
4908
4909     if ($disableFullGroupByMode) {
4910       CRM_Core_DAO::disableFullGroupByMode();
4911     }
4912
4913     // CRM-15231
4914     $this->_sort = $sort;
4915
4916     //CRM-15967
4917     $this->includePseudoFieldsJoin($sort);
4918
4919     list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4920
4921     if (!empty($groupByCols)) {
4922       $groupBy = " GROUP BY " . implode(', ', $groupByCols);
4923     }
4924
4925     if ($additionalWhereClause) {
4926       $where = $where . ' AND ' . $additionalWhereClause;
4927     }
4928
4929     //additional from clause should be w/ proper joins.
4930     if ($additionalFromClause) {
4931       $from .= "\n" . $additionalFromClause;
4932     }
4933
4934     // if we are doing a transform, do it here
4935     // use the $from, $where and $having to get the contact ID
4936     if ($this->_displayRelationshipType) {
4937       $this->filterRelatedContacts($from, $where, $having);
4938     }
4939
4940     if ($skipOrderAndLimit) {
4941       $query = "$select $from $where $having $groupBy";
4942     }
4943     else {
4944       $query = "$select $from $where $having $groupBy $order $limit";
4945     }
4946
4947     if ($returnQuery) {
4948       return $query;
4949     }
4950     if ($count) {
4951       return CRM_Core_DAO::singleValueQuery($query);
4952     }
4953
4954     $dao = CRM_Core_DAO::executeQuery($query);
4955
4956     if ($disableFullGroupByMode) {
4957       CRM_Core_DAO::reenableFullGroupByMode();
4958     }
4959
4960     if ($groupContacts) {
4961       $ids = array();
4962       while ($dao->fetch()) {
4963         $ids[] = $dao->id;
4964       }
4965       $dao->free();
4966       return implode(',', $ids);
4967     }
4968
4969     return $dao;
4970   }
4971
4972   /**
4973    * Fetch a list of contacts from the prev/next cache for displaying a search results page
4974    *
4975    * @param string $cacheKey
4976    * @param int $offset
4977    * @param int $rowCount
4978    * @param bool $includeContactIds
4979    * @return CRM_Core_DAO
4980    */
4981   public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4982     $this->_includeContactIds = $includeContactIds;
4983     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4984     list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
4985     $from = " FROM civicrm_prevnext_cache pnc INNER JOIN civicrm_contact contact_a ON contact_a.id = pnc.entity_id1 AND pnc.cacheKey = '$cacheKey' " . substr($from, 31);
4986     $order = " ORDER BY pnc.id";
4987     $groupByCol = array('contact_a.id', 'pnc.id');
4988     $select = self::appendAnyValueToSelect($this->_select, $groupByCol, 'GROUP_CONCAT');
4989     $groupBy = " GROUP BY " . implode(', ', $groupByCol);
4990     $limit = " LIMIT $offset, $rowCount";
4991     $query = "$select $from $where $groupBy $order $limit";
4992
4993     return CRM_Core_DAO::executeQuery($query);
4994   }
4995
4996   /**
4997    * Populate $this->_permissionWhereClause with permission related clause and update other
4998    * query related properties.
4999    *
5000    * Function calls ACL permission class and hooks to filter the query appropriately
5001    *
5002    * Note that these 2 params were in the code when extracted from another function
5003    * and a second round extraction would be to make them properties of the class
5004    *
5005    * @param bool $onlyDeleted
5006    *   Only get deleted contacts.
5007    * @param bool $count
5008    *   Return Count only.
5009    */
5010   public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
5011     if (!$this->_skipPermission) {
5012       $this->_permissionWhereClause = CRM_ACL_API::whereClause(
5013         CRM_Core_Permission::VIEW,
5014         $this->_tables,
5015         $this->_whereTables,
5016         NULL,
5017         $onlyDeleted,
5018         $this->_skipDeleteClause
5019       );
5020
5021       // regenerate fromClause since permission might have added tables
5022       if ($this->_permissionWhereClause) {
5023         //fix for row count in qill (in contribute/membership find)
5024         if (!$count) {
5025           $this->_useDistinct = TRUE;
5026         }
5027         //CRM-15231
5028         $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
5029         $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
5030         // note : this modifies _fromClause and _simpleFromClause
5031         $this->includePseudoFieldsJoin($this->_sort);
5032       }
5033     }
5034     else {
5035       // add delete clause if needed even if we are skipping permission
5036       // CRM-7639
5037       if (!$this->_skipDeleteClause) {
5038         if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
5039           $this->_permissionWhereClause = '(contact_a.is_deleted)';
5040         }
5041         else {
5042           // CRM-6181
5043           $this->_permissionWhereClause = '(contact_a.is_deleted = 0)';
5044         }
5045       }
5046     }
5047   }
5048
5049   /**
5050    * @param $val
5051    */
5052   public function setSkipPermission($val) {
5053     $this->_skipPermission = $val;
5054   }
5055
5056   /**
5057    * @param null $context
5058    *
5059    * @return array
5060    */
5061   public function &summaryContribution($context = NULL) {
5062     list($innerselect, $from, $where, $having) = $this->query(TRUE);
5063
5064     // hack $select
5065     $select = "
5066 SELECT COUNT( conts.total_amount ) as total_count,
5067        SUM(   conts.total_amount ) as total_amount,
5068        AVG(   conts.total_amount ) as total_avg,
5069        conts.currency              as currency";
5070     if ($this->_permissionWhereClause) {
5071       $where .= " AND " . $this->_permissionWhereClause;
5072     }
5073     if ($context == 'search') {
5074       $where .= " AND contact_a.is_deleted = 0 ";
5075     }
5076
5077     $query = $this->appendFinancialTypeWhereAndFromToQueryStrings($where, $from);
5078
5079     // make sure contribution is completed - CRM-4989
5080     $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
5081
5082     $summary = array();
5083     $summary['total'] = array();
5084     $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
5085     $innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,
5086       civicrm_contribution.currency $from $completedWhere";
5087     $query = "$select FROM (
5088       $innerQuery GROUP BY civicrm_contribution.id
5089     ) as conts
5090     GROUP BY currency";
5091
5092     $dao = CRM_Core_DAO::executeQuery($query);
5093
5094     $summary['total']['count'] = 0;
5095     $summary['total']['amount'] = $summary['total']['avg'] = array();
5096     while ($dao->fetch()) {
5097       $summary['total']['count'] += $dao->total_count;
5098       $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
5099       $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
5100     }
5101
5102     $orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
5103     $groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
5104     $modeSQL = "$select, SUBSTRING_INDEX(GROUP_CONCAT(conts.total_amount
5105       ORDER BY conts.civicrm_contribution_total_amount_count DESC SEPARATOR ';'), ';', 1) as amount,
5106       MAX(conts.civicrm_contribution_total_amount_count) as civicrm_contribution_total_amount_count
5107       FROM ($innerQuery
5108       $groupBy $orderBy) as conts
5109       GROUP BY currency";
5110
5111     $summary['total']['mode'] = CRM_Contribute_BAO_Contribution::computeStats('mode', $modeSQL);
5112
5113     $medianSQL = "{$from} {$completedWhere}";
5114     $summary['total']['median'] = CRM_Contribute_BAO_Contribution::computeStats('median', $medianSQL, 'civicrm_contribution');
5115     $summary['total']['currencyCount'] = count($summary['total']['median']);
5116
5117     if (!empty($summary['total']['amount'])) {
5118       $summary['total']['amount'] = implode(',&nbsp;', $summary['total']['amount']);
5119       $summary['total']['avg'] = implode(',&nbsp;', $summary['total']['avg']);
5120       $summary['total']['mode'] = implode(',&nbsp;', $summary['total']['mode']);
5121       $summary['total']['median'] = implode(',&nbsp;', $summary['total']['median']);
5122     }
5123     else {
5124       $summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
5125     }
5126
5127     // soft credit summary
5128     if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
5129       $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
5130       $query = "
5131         $select FROM (
5132           SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
5133           GROUP BY civicrm_contribution_soft.id
5134         ) as conts
5135         GROUP BY currency";
5136       $dao = CRM_Core_DAO::executeQuery($query);
5137       $summary['soft_credit']['count'] = 0;
5138       $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
5139       while ($dao->fetch()) {
5140         $summary['soft_credit']['count'] += $dao->total_count;
5141         $summary['soft_credit']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
5142         $summary['soft_credit']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
5143       }
5144       if (!empty($summary['soft_credit']['amount'])) {
5145         $summary['soft_credit']['amount'] = implode(',&nbsp;', $summary['soft_credit']['amount']);
5146         $summary['soft_credit']['avg'] = implode(',&nbsp;', $summary['soft_credit']['avg']);
5147       }
5148       else {
5149         $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
5150       }
5151     }
5152
5153     // hack $select
5154     //@todo  - this could be one query using the IF in mysql - eg
5155     //  SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
5156     //   SELECT civicrm_contribution.total_amount, civicrm_contribution.currency  ,
5157     //  IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
5158     //  IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
5159     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
5160     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
5161     // FROM civicrm_contact contact_a
5162     //  LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
5163     // WHERE  ( ... where clause....
5164     // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
5165     //  ) as conts
5166
5167     $select = "
5168 SELECT COUNT( conts.total_amount ) as cancel_count,
5169        SUM(   conts.total_amount ) as cancel_amount,
5170        AVG(   conts.total_amount ) as cancel_avg,
5171        conts.currency              as currency";
5172
5173     $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
5174     if ($context == 'search') {
5175       $where .= " AND contact_a.is_deleted = 0 ";
5176     }
5177
5178     $query = "$select FROM (
5179       SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
5180       GROUP BY civicrm_contribution.id
5181     ) as conts
5182     GROUP BY currency";
5183
5184     $dao = CRM_Core_DAO::executeQuery($query);
5185
5186     if ($dao->N <= 1) {
5187       if ($dao->fetch()) {
5188         $summary['cancel']['count'] = $dao->cancel_count;
5189         $summary['cancel']['amount'] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
5190         $summary['cancel']['avg'] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
5191       }
5192     }
5193     else {
5194       $summary['cancel']['count'] = 0;
5195       $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
5196       while ($dao->fetch()) {
5197         $summary['cancel']['count'] += $dao->cancel_count;
5198         $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
5199         $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
5200       }
5201       $summary['cancel']['amount'] = implode(',&nbsp;', $summary['cancel']['amount']);
5202       $summary['cancel']['avg'] = implode(',&nbsp;', $summary['cancel']['avg']);
5203     }
5204
5205     return $summary;
5206   }
5207
5208   /**
5209    * Append financial ACL limits to the query from & where clauses, if applicable.
5210    *
5211    * @param string $where
5212    * @param string $from
5213    */
5214   public function appendFinancialTypeWhereAndFromToQueryStrings(&$where, &$from) {
5215     if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
5216       return;
5217     }
5218     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
5219     if (!empty($financialTypes)) {
5220       $where .= " AND civicrm_contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ") AND li.id IS NULL";
5221       $from .= " LEFT JOIN civicrm_line_item li
5222                   ON civicrm_contribution.id = li.contribution_id AND
5223                      li.entity_table = 'civicrm_contribution' AND li.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ") ";
5224     }
5225     else {
5226       $where .= " AND civicrm_contribution.financial_type_id IN (0)";
5227     }
5228   }
5229
5230   /**
5231    * Getter for the qill object.
5232    *
5233    * @return string
5234    */
5235   public function qill() {
5236     return $this->_qill;
5237   }
5238
5239   /**
5240    * Default set of return default hier return properties.
5241    *
5242    * @return array
5243    */
5244   public static function &defaultHierReturnProperties() {
5245     if (!isset(self::$_defaultHierReturnProperties)) {
5246       self::$_defaultHierReturnProperties = array(
5247         'home_URL' => 1,
5248         'image_URL' => 1,
5249         'legal_identifier' => 1,
5250         'external_identifier' => 1,
5251         'contact_type' => 1,
5252         'contact_sub_type' => 1,
5253         'sort_name' => 1,
5254         'display_name' => 1,
5255         'nick_name' => 1,
5256         'first_name' => 1,
5257         'middle_name' => 1,
5258         'last_name' => 1,
5259         'prefix_id' => 1,
5260         'suffix_id' => 1,
5261         'formal_title' => 1,
5262         'communication_style_id' => 1,
5263         'email_greeting' => 1,
5264         'postal_greeting' => 1,
5265         'addressee' => 1,
5266         'birth_date' => 1,
5267         'gender_id' => 1,
5268         'preferred_communication_method' => 1,
5269         'do_not_phone' => 1,
5270         'do_not_email' => 1,
5271         'do_not_mail' => 1,
5272         'do_not_sms' => 1,
5273         'do_not_trade' => 1,
5274         'location' => array(
5275           '1' => array(
5276             'location_type' => 1,
5277             'street_address' => 1,
5278             'city' => 1,
5279             'state_province' => 1,
5280             'postal_code' => 1,
5281             'postal_code_suffix' => 1,
5282             'country' => 1,
5283             'phone-Phone' => 1,
5284             'phone-Mobile' => 1,
5285             'phone-Fax' => 1,
5286             'phone-1' => 1,
5287             'phone-2' => 1,
5288             'phone-3' => 1,
5289             'im-1' => 1,
5290             'im-2' => 1,
5291             'im-3' => 1,
5292             'email-1' => 1,
5293             'email-2' => 1,
5294             'email-3' => 1,
5295           ),
5296           '2' => array(
5297             'location_type' => 1,
5298             'street_address' => 1,
5299             'city' => 1,
5300             'state_province' => 1,
5301             'postal_code' => 1,
5302             'postal_code_suffix' => 1,
5303             'country' => 1,
5304             'phone-Phone' => 1,
5305             'phone-Mobile' => 1,
5306             'phone-1' => 1,
5307             'phone-2' => 1,
5308             'phone-3' => 1,
5309             'im-1' => 1,
5310             'im-2' => 1,
5311             'im-3' => 1,
5312             'email-1' => 1,
5313             'email-2' => 1,
5314             'email-3' => 1,
5315           ),
5316         ),
5317       );
5318     }
5319     return self::$_defaultHierReturnProperties;
5320   }
5321
5322   /**
5323    * Build query for a date field.
5324    *
5325    * @param array $values
5326    * @param string $tableName
5327    * @param string $fieldName
5328    * @param string $dbFieldName
5329    * @param string $fieldTitle
5330    * @param bool $appendTimeStamp
5331    * @param string $dateFormat
5332    */
5333   public function dateQueryBuilder(
5334     &$values, $tableName, $fieldName,
5335     $dbFieldName, $fieldTitle,
5336     $appendTimeStamp = TRUE,
5337     $dateFormat = 'YmdHis'
5338   ) {
5339     list($name, $op, $value, $grouping, $wildcard) = $values;
5340
5341     if ($name == "{$fieldName}_low" ||
5342       $name == "{$fieldName}_high"
5343     ) {
5344       if (isset($this->_rangeCache[$fieldName]) || !$value) {
5345         return;
5346       }
5347       $this->_rangeCache[$fieldName] = 1;
5348
5349       $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
5350
5351       if ($name == $fieldName . '_low') {
5352         $firstOP = '>=';
5353         $firstPhrase = ts('greater than or equal to');
5354         $firstDate = CRM_Utils_Date::processDate($value, NULL, FALSE, $dateFormat);
5355
5356         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5357         if (!empty($secondValues) && $secondValues[2]) {
5358           $secondOP = '<=';
5359           $secondPhrase = ts('less than or equal to');
5360           $secondValue = $secondValues[2];
5361
5362           if ($appendTimeStamp && strlen($secondValue) == 10) {
5363             $secondValue .= ' 23:59:59';
5364           }
5365           $secondDate = CRM_Utils_Date::processDate($secondValue, NULL, FALSE, $dateFormat);
5366         }
5367       }
5368       elseif ($name == $fieldName . '_high') {
5369         $firstOP = '<=';
5370         $firstPhrase = ts('less than or equal to');
5371
5372         if ($appendTimeStamp && strlen($value) == 10) {
5373           $value .= ' 23:59:59';
5374         }
5375         $firstDate = CRM_Utils_Date::processDate($value, NULL, FALSE, $dateFormat);
5376
5377         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5378         if (!empty($secondValues) && $secondValues[2]) {
5379           $secondOP = '>=';
5380           $secondPhrase = ts('greater than or equal to');
5381           $secondValue = $secondValues[2];
5382           $secondDate = CRM_Utils_Date::processDate($secondValue, NULL, FALSE, $dateFormat);
5383         }
5384       }
5385
5386       if (!$appendTimeStamp) {
5387         $firstDate = substr($firstDate, 0, 8);
5388       }
5389       $firstDateFormat = CRM_Utils_Date::customFormat($firstDate);
5390
5391       if ($secondDate) {
5392         if (!$appendTimeStamp) {
5393           $secondDate = substr($secondDate, 0, 8);
5394         }
5395         $secondDateFormat = CRM_Utils_Date::customFormat($secondDate);
5396       }
5397
5398       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5399       if ($secondDate) {
5400         $this->_where[$grouping][] = "
5401 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5402 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5403 ";
5404         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
5405       }
5406       else {
5407         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5408         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
5409       }
5410     }
5411
5412     if ($name == $fieldName) {
5413       //In Get API, for operators other then '=' the $value is in array(op => value) format
5414       if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5415         $op = key($value);
5416         $value = $value[$op];
5417       }
5418
5419       $date = $format = NULL;
5420       if (strstr($op, 'IN')) {
5421         $format = array();
5422         foreach ($value as &$date) {
5423           $date = CRM_Utils_Date::processDate($date, NULL, FALSE, $dateFormat);
5424           if (!$appendTimeStamp) {
5425             $date = substr($date, 0, 8);
5426           }
5427           $format[] = CRM_Utils_Date::customFormat($date);
5428         }
5429         $date = "('" . implode("','", $value) . "')";
5430         $format = implode(', ', $format);
5431       }
5432       elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5433         $date = CRM_Utils_Date::processDate($value, NULL, FALSE, $dateFormat);
5434         if (!$appendTimeStamp) {
5435           $date = substr($date, 0, 8);
5436         }
5437         $format = CRM_Utils_Date::customFormat($date);
5438         $date = "'$date'";
5439       }
5440
5441       if ($date) {
5442         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5443       }
5444       else {
5445         $this->_where[$grouping][] = self::buildClause("{$tableName}.{$dbFieldName}", $op);
5446       }
5447
5448       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5449
5450       $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
5451       $this->_qill[$grouping][] = "$fieldTitle $op $format";
5452     }
5453   }
5454
5455   /**
5456    * @param $values
5457    * @param string $tableName
5458    * @param string $fieldName
5459    * @param string $dbFieldName
5460    * @param $fieldTitle
5461    * @param null $options
5462    */
5463   public function numberRangeBuilder(
5464     &$values,
5465     $tableName, $fieldName,
5466     $dbFieldName, $fieldTitle,
5467     $options = NULL
5468   ) {
5469     list($name, $op, $value, $grouping, $wildcard) = $values;
5470
5471     if ($name == "{$fieldName}_low" ||
5472       $name == "{$fieldName}_high"
5473     ) {
5474       if (isset($this->_rangeCache[$fieldName])) {
5475         return;
5476       }
5477       $this->_rangeCache[$fieldName] = 1;
5478
5479       $secondOP = $secondPhrase = $secondValue = NULL;
5480
5481       if ($name == "{$fieldName}_low") {
5482         $firstOP = '>=';
5483         $firstPhrase = ts('greater than');
5484
5485         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5486         if (!empty($secondValues)) {
5487           $secondOP = '<=';
5488           $secondPhrase = ts('less than');
5489           $secondValue = $secondValues[2];
5490         }
5491       }
5492       else {
5493         $firstOP = '<=';
5494         $firstPhrase = ts('less than');
5495
5496         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5497         if (!empty($secondValues)) {
5498           $secondOP = '>=';
5499           $secondPhrase = ts('greater than');
5500           $secondValue = $secondValues[2];
5501         }
5502       }
5503
5504       if ($secondOP) {
5505         $this->_where[$grouping][] = "
5506 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5507 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5508 ";
5509         $displayValue = $options ? $options[$value] : $value;
5510         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5511
5512         $this->_qill[$grouping][]
5513           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5514       }
5515       else {
5516         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5517         $displayValue = $options ? $options[$value] : $value;
5518         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5519       }
5520       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5521
5522       return;
5523     }
5524
5525     if ($name == $fieldName) {
5526       $op = '=';
5527       $phrase = '=';
5528
5529       $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5530
5531       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5532       $displayValue = $options ? $options[$value] : $value;
5533       $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5534     }
5535   }
5536
5537
5538   /**
5539    * @param $values
5540    * @param string $tableName
5541    * @param string $fieldName
5542    * @param string $dbFieldName
5543    * @param $fieldTitle
5544    * @param null $options
5545    */
5546   public function ageRangeQueryBuilder(
5547     &$values,
5548     $tableName, $fieldName,
5549     $dbFieldName, $fieldTitle,
5550     $options = NULL
5551   ) {
5552     list($name, $op, $value, $grouping, $wildcard) = $values;
5553
5554     $asofDateValues = $this->getWhereValues("{$fieldName}_asof_date", $grouping);
5555     $asofDate = NULL;  // will be treated as current day
5556     if ($asofDateValues) {
5557       $asofDate = CRM_Utils_Date::processDate($asofDateValues[2]);
5558       $asofDateFormat = CRM_Utils_Date::customFormat(substr($asofDate, 0, 8));
5559       $fieldTitle .= ' ' . ts('as of') . ' ' . $asofDateFormat;
5560     }
5561
5562     if ($name == "{$fieldName}_low" ||
5563       $name == "{$fieldName}_high"
5564     ) {
5565       if (isset($this->_rangeCache[$fieldName])) {
5566         return;
5567       }
5568       $this->_rangeCache[$fieldName] = 1;
5569
5570       $secondOP = $secondPhrase = $secondValue = NULL;
5571
5572       if ($name == "{$fieldName}_low") {
5573         $firstPhrase = ts('greater than or equal to');
5574         // NB: age > X means date of birth < Y
5575         $firstOP = '<=';
5576         $firstDate = self::calcDateFromAge($asofDate, $value, 'min');
5577
5578         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5579         if (!empty($secondValues)) {
5580           $secondOP = '>=';
5581           $secondPhrase = ts('less than or equal to');
5582           $secondValue = $secondValues[2];
5583           $secondDate = self::calcDateFromAge($asofDate, $secondValue, 'max');
5584         }
5585       }
5586       else {
5587         $firstOP = '>=';
5588         $firstPhrase = ts('less than or equal to');
5589         $firstDate = self::calcDateFromAge($asofDate, $value, 'max');
5590
5591         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5592         if (!empty($secondValues)) {
5593           $secondOP = '<=';
5594           $secondPhrase = ts('greater than or equal to');
5595           $secondValue = $secondValues[2];
5596           $secondDate = self::calcDateFromAge($asofDate, $secondValue, 'min');
5597         }
5598       }
5599
5600       if ($secondOP) {
5601         $this->_where[$grouping][] = "
5602 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5603 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5604 ";
5605         $displayValue = $options ? $options[$value] : $value;
5606         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5607
5608         $this->_qill[$grouping][]
5609           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5610       }
5611       else {
5612         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5613         $displayValue = $options ? $options[$value] : $value;
5614         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5615       }
5616       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5617       return;
5618     }
5619   }
5620
5621   /**
5622    * Calculate date from age.
5623    *
5624    * @param string $asofDate
5625    * @param int $age
5626    * @param string $type
5627    *
5628    * @return string
5629    */
5630   public static function calcDateFromAge($asofDate, $age, $type) {
5631     $date = new DateTime($asofDate);
5632     if ($type == "min") {
5633       // minimum age is $age: dob <= date - age "235959"
5634       $date->sub(new DateInterval("P" . $age . "Y"));
5635       return $date->format('Ymd') . "235959";
5636     }
5637     else {
5638       // max age is $age: dob >= date - (age + 1y) + 1d "000000"
5639       $date->sub(new DateInterval("P" . ($age + 1) . "Y"))->add(new DateInterval("P1D"));
5640       return $date->format('Ymd') . "000000";
5641     }
5642   }
5643
5644   /**
5645    * Given the field name, operator, value & its data type
5646    * builds the where Clause for the query
5647    * used for handling 'IS NULL'/'IS NOT NULL' operators
5648    *
5649    * @param string $field
5650    *   Fieldname.
5651    * @param string $op
5652    *   Operator.
5653    * @param string $value
5654    *   Value.
5655    * @param string $dataType
5656    *   Data type of the field.
5657    *
5658    * @return string
5659    *   Where clause for the query.
5660    */
5661   public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5662     $op = trim($op);
5663     $clause = "$field $op";
5664
5665     switch ($op) {
5666       case 'IS NULL':
5667       case 'IS NOT NULL':
5668         return $clause;
5669
5670       case 'IS EMPTY':
5671         $clause = ($dataType == 'Date') ? " $field IS NULL " : " (NULLIF($field, '') IS NULL) ";
5672         return $clause;
5673
5674       case 'IS NOT EMPTY':
5675         $clause = ($dataType == 'Date') ? " $field IS NOT NULL " : " (NULLIF($field, '') IS NOT NULL) ";
5676         return $clause;
5677
5678       case 'RLIKE':
5679         return " {$clause} BINARY '{$value}' ";
5680
5681       case 'IN':
5682       case 'NOT IN':
5683         // I feel like this would be escaped properly if passed through $queryString = CRM_Core_DAO::createSqlFilter.
5684         if (!empty($value) && (!is_array($value) || !array_key_exists($op, $value))) {
5685           $value = array($op => (array) $value);
5686         }
5687
5688       default:
5689         if (empty($dataType) || $dataType == 'Date') {
5690           $dataType = 'String';
5691         }
5692         if (is_array($value)) {
5693           //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5694           // widely used and consistent across the codebase
5695           // adding this here won't accept the search functions which don't submit an array
5696           if (($queryString = CRM_Core_DAO::createSqlFilter($field, $value, $dataType)) != FALSE) {
5697
5698             return $queryString;
5699           }
5700           if (!empty($value[0]) && $op === 'BETWEEN') {
5701             CRM_Core_Error::deprecatedFunctionWarning('Fix search input params');
5702             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => $value), $dataType)) != FALSE) {
5703               return $queryString;
5704             }
5705           }
5706           throw new CRM_Core_Exception(ts('Failed to interpret input for search'));
5707         }
5708
5709         $value = CRM_Utils_Type::escape($value, $dataType);
5710         // if we don't have a dataType we should assume
5711         if ($dataType == 'String' || $dataType == 'Text') {
5712           $value = "'" . strtolower($value) . "'";
5713         }
5714         return "$clause $value";
5715     }
5716   }
5717
5718   /**
5719    * @param bool $reset
5720    *
5721    * @return array
5722    */
5723   public function openedSearchPanes($reset = FALSE) {
5724     if (!$reset || empty($this->_whereTables)) {
5725       return self::$_openedPanes;
5726     }
5727
5728     // pane name to table mapper
5729     $panesMapper = array(
5730       ts('Contributions') => 'civicrm_contribution',
5731       ts('Memberships') => 'civicrm_membership',
5732       ts('Events') => 'civicrm_participant',
5733       ts('Relationships') => 'civicrm_relationship',
5734       ts('Activities') => 'civicrm_activity',
5735       ts('Pledges') => 'civicrm_pledge',
5736       ts('Cases') => 'civicrm_case',
5737       ts('Grants') => 'civicrm_grant',
5738       ts('Address Fields') => 'civicrm_address',
5739       ts('Notes') => 'civicrm_note',
5740       ts('Change Log') => 'civicrm_log',
5741       ts('Mailings') => 'civicrm_mailing',
5742     );
5743     CRM_Contact_BAO_Query_Hook::singleton()->getPanesMapper($panesMapper);
5744
5745     foreach (array_keys($this->_whereTables) as $table) {
5746       if ($panName = array_search($table, $panesMapper)) {
5747         self::$_openedPanes[$panName] = TRUE;
5748       }
5749     }
5750
5751     return self::$_openedPanes;
5752   }
5753
5754   /**
5755    * @param $operator
5756    */
5757   public function setOperator($operator) {
5758     $validOperators = array('AND', 'OR');
5759     if (!in_array($operator, $validOperators)) {
5760       $operator = 'AND';
5761     }
5762     $this->_operator = $operator;
5763   }
5764
5765   /**
5766    * @return string
5767    */
5768   public function getOperator() {
5769     return $this->_operator;
5770   }
5771
5772   /**
5773    * @param $from
5774    * @param $where
5775    * @param $having
5776    */
5777   public function filterRelatedContacts(&$from, &$where, &$having) {
5778     if (!isset(Civi::$statics[__CLASS__]['related_contacts_filter'])) {
5779       Civi::$statics[__CLASS__]['related_contacts_filter'] = array();
5780     }
5781     $_rTempCache =& Civi::$statics[__CLASS__]['related_contacts_filter'];
5782     // since there only can be one instance of this filter in every query
5783     // skip if filter has already applied
5784     foreach ($_rTempCache as $acache) {
5785       foreach ($acache['queries'] as $aqcache) {
5786         if (strpos($from, $aqcache['from']) !== FALSE) {
5787           $having = NULL;
5788           return;
5789         }
5790       }
5791     }
5792     $arg_sig = sha1("$from $where $having");
5793     if (isset($_rTempCache[$arg_sig])) {
5794       $cache = $_rTempCache[$arg_sig];
5795     }
5796     else {
5797       // create temp table with contact ids
5798       $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE);
5799
5800       $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5801       CRM_Core_DAO::executeQuery($sql);
5802
5803       $sql = "
5804 REPLACE INTO $tableName ( contact_id )
5805 SELECT contact_a.id
5806        $from
5807        $where
5808        $having
5809 ";
5810       CRM_Core_DAO::executeQuery($sql);
5811
5812       $cache = array('tableName' => $tableName, 'queries' => array());
5813       $_rTempCache[$arg_sig] = $cache;
5814     }
5815     // upsert the query depending on relationship type
5816     if (isset($cache['queries'][$this->_displayRelationshipType])) {
5817       $qcache = $cache['queries'][$this->_displayRelationshipType];
5818     }
5819     else {
5820       $tableName = $cache['tableName'];
5821       $qcache = array(
5822         "from" => "",
5823         "where" => "",
5824       );
5825       $rTypes = CRM_Core_PseudoConstant::relationshipType();
5826       if (is_numeric($this->_displayRelationshipType)) {
5827         $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b'];
5828         $qcache['from'] = "
5829 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5830 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5831 ";
5832         $qcache['where'] = "
5833 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5834 AND   displayRelType.is_active = 1
5835 ";
5836       }
5837       else {
5838         list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType);
5839         if ($dirOne == 'a') {
5840           $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5841           $qcache['from'] .= "
5842 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5843 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5844 ";
5845         }
5846         else {
5847           $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5848           $qcache['from'] .= "
5849 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5850 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5851 ";
5852         }
5853         $qcache['where'] = "
5854 WHERE displayRelType.relationship_type_id = $relType
5855 AND   displayRelType.is_active = 1
5856 ";
5857       }
5858       $qcache['relTypeLabel'] = $relationshipTypeLabel;
5859       $_rTempCache[$arg_sig]['queries'][$this->_displayRelationshipType] = $qcache;
5860     }
5861     $qillMessage = ts('Contacts with a Relationship Type of: ');
5862     $iqill = $qillMessage . "'" . $qcache['relTypeLabel'] . "'";
5863     if (!is_array($this->_qill[0]) || !in_array($iqill, $this->_qill[0])) {
5864       $this->_qill[0][] = $iqill;
5865     }
5866     if (strpos($from, $qcache['from']) === FALSE) {
5867       // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5868       // this happens when we have an event_type in the quert (CRM-7969)
5869       $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5870       $from .= $qcache['from'];
5871       $where = $qcache['where'];
5872       if (!empty($this->_permissionWhereClause)) {
5873         $where .= "AND $this->_permissionWhereClause";
5874       }
5875     }
5876
5877     $having = NULL;
5878   }
5879
5880   /**
5881    * See CRM-19811 for why this is database hurty without apparent benefit.
5882    *
5883    * @param $op
5884    *
5885    * @return bool
5886    */
5887   public static function caseImportant($op) {
5888     return
5889       in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
5890   }
5891
5892   /**
5893    * @param $returnProperties
5894    * @param $prefix
5895    *
5896    * @return bool
5897    */
5898   public static function componentPresent(&$returnProperties, $prefix) {
5899     foreach ($returnProperties as $name => $dontCare) {
5900       if (substr($name, 0, strlen($prefix)) == $prefix) {
5901         return TRUE;
5902       }
5903     }
5904     return FALSE;
5905   }
5906
5907   /**
5908    * Builds the necessary structures for all fields that are similar to option value look-ups.
5909    *
5910    * @param string $name
5911    *   the name of the field.
5912    * @param string $op
5913    *   the sql operator, this function should handle ALL SQL operators.
5914    * @param string $value
5915    *   depends on the operator and who's calling the query builder.
5916    * @param int $grouping
5917    *   the index where to place the where clause.
5918    * @param string $daoName
5919    *   DAO Name.
5920    * @param array $field
5921    *   an array that contains various properties of the field identified by $name.
5922    * @param string $label
5923    *   The label for this field element.
5924    * @param string $dataType
5925    *   The data type for this element.
5926    * @param bool $useIDsOnly
5927    */
5928   public function optionValueQuery(
5929     $name,
5930     $op,
5931     $value,
5932     $grouping,
5933     $daoName = NULL,
5934     $field,
5935     $label,
5936     $dataType = 'String',
5937     $useIDsOnly = FALSE
5938   ) {
5939
5940     $pseudoFields = array(
5941       'email_greeting',
5942       'postal_greeting',
5943       'addressee',
5944       'gender_id',
5945       'prefix_id',
5946       'suffix_id',
5947       'communication_style_id',
5948     );
5949
5950     if ($useIDsOnly) {
5951       list($tableName, $fieldName) = explode('.', $field['where'], 2);
5952       if ($tableName == 'civicrm_contact') {
5953         $wc = "contact_a.$fieldName";
5954       }
5955       else {
5956         // Special handling for on_hold, so that we actually use the 'where'
5957         // property in order to limit the query by the on_hold status of the email,
5958         // instead of using email.id which would be nonsensical.
5959         if ($field['name'] == 'on_hold') {
5960           $wc = "{$field['where']}";
5961         }
5962         else {
5963           $wc = "$tableName.id";
5964         }
5965       }
5966     }
5967     else {
5968       CRM_Core_Error::deprecatedFunctionWarning('pass $ids to this method');
5969       $wc = "{$field['where']}";
5970     }
5971     if (in_array($name, $pseudoFields)) {
5972       if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5973         $wc = "contact_a.{$name}_id";
5974       }
5975       $dataType = 'Positive';
5976       $value = (!$value) ? 0 : $value;
5977     }
5978     if ($name == "world_region") {
5979       $field['name'] = $name;
5980     }
5981
5982     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue($daoName, $field['name'], $value, $op);
5983     $this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillop, 3 => $qillVal));
5984     $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType);
5985   }
5986
5987   /**
5988    * Check and explode a user defined numeric string into an array
5989    * this was the protocol used by search builder in the old old days before we had
5990    * super nice js widgets to do the hard work
5991    *
5992    * @param string $string
5993    * @param string $dataType
5994    *   The dataType we should check for the values, default integer.
5995    *
5996    * @return bool|array
5997    *   false if string does not match the pattern
5998    *   array of numeric values if string does match the pattern
5999    */
6000   public static function parseSearchBuilderString($string, $dataType = 'Integer') {
6001     $string = trim($string);
6002     if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') {
6003       Return FALSE;
6004     }
6005
6006     $string = substr($string, 1, -1);
6007     $values = explode(',', $string);
6008     if (empty($values)) {
6009       return FALSE;
6010     }
6011
6012     $returnValues = array();
6013     foreach ($values as $v) {
6014       if ($dataType == 'Integer' && !is_numeric($v)) {
6015         return FALSE;
6016       }
6017       elseif ($dataType == 'String' && !is_string($v)) {
6018         return FALSE;
6019       }
6020       $returnValues[] = trim($v);
6021     }
6022
6023     if (empty($returnValues)) {
6024       return FALSE;
6025     }
6026
6027     return $returnValues;
6028   }
6029
6030   /**
6031    * Convert the pseudo constants id's to their names
6032    *
6033    * @param CRM_Core_DAO $dao
6034    * @param bool $return
6035    * @param bool $usedForAPI
6036    *
6037    * @return array|NULL
6038    */
6039   public function convertToPseudoNames(&$dao, $return = FALSE, $usedForAPI = FALSE) {
6040     if (empty($this->_pseudoConstantsSelect)) {
6041       return NULL;
6042     }
6043     $values = array();
6044     foreach ($this->_pseudoConstantsSelect as $key => $value) {
6045       if (!empty($this->_pseudoConstantsSelect[$key]['sorting'])) {
6046         continue;
6047       }
6048
6049       if (is_object($dao) && property_exists($dao, $value['idCol'])) {
6050         $val = $dao->{$value['idCol']};
6051         if ($key == 'groups') {
6052           $dao->groups = $this->convertGroupIDStringToLabelString($dao, $val);
6053           continue;
6054         }
6055
6056         if (CRM_Utils_System::isNull($val)) {
6057           $dao->$key = NULL;
6058         }
6059         elseif (!empty($value['pseudoconstant'])) {
6060           // If pseudoconstant is set that is kind of defacto for 'we have a bit more info about this'
6061           // and we can use the metadata to figure it out.
6062           // ideally this bit of IF will absorb & replace all the rest in time as we move to
6063           // more metadata based choices.
6064           if (strpos($val, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
6065             $dbValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($val, CRM_Core_DAO::VALUE_SEPARATOR));
6066             foreach ($dbValues as $pseudoValue) {
6067               $convertedValues[] = CRM_Core_PseudoConstant::getLabel($value['bao'], $value['idCol'], $pseudoValue);
6068             }
6069
6070             $dao->$key = ($usedForAPI) ? $convertedValues : implode(', ', $convertedValues);
6071             $realFieldName = CRM_Utils_Array::value('field_name', $this->_pseudoConstantsSelect[$key]);
6072             if ($usedForAPI && $realFieldName) {
6073               // normally we would see 2 fields returned for pseudoConstants. An exception is
6074               // preferred_communication_method where there is no id-variant.
6075               // For the api we prioritise getting the real data returned.
6076               // over the resolved version
6077               $dao->$realFieldName = $dbValues;
6078             }
6079
6080           }
6081           else {
6082             // This is basically the same as the default but since we have the bao we can use
6083             // a cached function.
6084             $dao->$key = CRM_Core_PseudoConstant::getLabel($value['bao'], $value['idCol'], $val);
6085           }
6086         }
6087         elseif ($baoName = CRM_Utils_Array::value('bao', $value, NULL)) {
6088           //preserve id value
6089           $idColumn = "{$key}_id";
6090           $dao->$idColumn = $val;
6091
6092           if ($key == 'state_province_name') {
6093             $dao->{$value['pseudoField']} = $dao->$key = CRM_Core_PseudoConstant::stateProvince($val);
6094           }
6095           else {
6096             $dao->{$value['pseudoField']} = $dao->$key = CRM_Core_PseudoConstant::getLabel($baoName, $value['pseudoField'], $val);
6097           }
6098         }
6099         elseif ($value['pseudoField'] == 'state_province_abbreviation') {
6100           $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
6101         }
6102         // @todo handle this in the section above for pseudoconstants.
6103         elseif (in_array($value['pseudoField'], array('participant_role_id', 'participant_role'))) {
6104           // @todo define bao on this & merge into the above condition.
6105           $viewValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, $val);
6106
6107           if ($value['pseudoField'] == 'participant_role') {
6108             $pseudoOptions = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'role_id');
6109             foreach ($viewValues as $k => $v) {
6110               $viewValues[$k] = $pseudoOptions[$v];
6111             }
6112           }
6113           $dao->$key = ($usedForAPI && count($viewValues) > 1) ? $viewValues : implode(', ', $viewValues);
6114         }
6115         else {
6116           $labels = CRM_Core_OptionGroup::values($value['pseudoField']);
6117           $dao->$key = $labels[$val];
6118         }
6119
6120         // return converted values in array format
6121         if ($return) {
6122           if (strpos($key, '-') !== FALSE) {
6123             $keyVal = explode('-', $key);
6124             $current = &$values;
6125             $lastElement = array_pop($keyVal);
6126             foreach ($keyVal as $v) {
6127               if (!array_key_exists($v, $current)) {
6128                 $current[$v] = array();
6129               }
6130               $current = &$current[$v];
6131             }
6132             $current[$lastElement] = $dao->$key;
6133           }
6134           else {
6135             $values[$key] = $dao->$key;
6136           }
6137         }
6138       }
6139     }
6140     if (!$usedForAPI) {
6141       foreach (array(
6142          'gender_id' => 'gender',
6143           'prefix_id' => 'individual_prefix',
6144           'suffix_id' => 'individual_suffix',
6145           'communication_style_id' => 'communication_style',
6146         ) as $realField => $labelField) {
6147         // This is a temporary routine for handling these fields while
6148         // we figure out how to handled them based on metadata in
6149         /// export and search builder. CRM-19815, CRM-19830.
6150         if (isset($dao->$realField) && is_numeric($dao->$realField) && isset($dao->$labelField)) {
6151           $dao->$realField = $dao->$labelField;
6152         }
6153       }
6154     }
6155     return $values;
6156   }
6157
6158   /**
6159    * Include pseudo fields LEFT JOIN.
6160    * @param string|array $sort can be a object or string
6161    *
6162    * @return array|NULL
6163    */
6164   public function includePseudoFieldsJoin($sort) {
6165     if (!$sort || empty($this->_pseudoConstantsSelect)) {
6166       return NULL;
6167     }
6168     $sort = is_string($sort) ? $sort : $sort->orderBy();
6169     $present = array();
6170
6171     foreach ($this->_pseudoConstantsSelect as $name => $value) {
6172       if (!empty($value['table'])) {
6173         $regex = "/({$value['table']}\.|{$name})/";
6174         if (preg_match($regex, $sort)) {
6175           $this->_elemnt[$value['element']] = 1;
6176           $this->_select[$value['element']] = $value['select'];
6177           $this->_pseudoConstantsSelect[$name]['sorting'] = 1;
6178           $present[$value['table']] = $value['join'];
6179         }
6180       }
6181     }
6182     $presentSimpleFrom = $present;
6183
6184     if (array_key_exists('civicrm_worldregion', $this->_whereTables) &&
6185       array_key_exists('civicrm_country', $presentSimpleFrom)
6186     ) {
6187       unset($presentSimpleFrom['civicrm_country']);
6188     }
6189     if (array_key_exists('civicrm_worldregion', $this->_tables) &&
6190       array_key_exists('civicrm_country', $present)
6191     ) {
6192       unset($present['civicrm_country']);
6193     }
6194
6195     $presentClause = $presentSimpleFromClause = NULL;
6196     if (!empty($present)) {
6197       $presentClause = implode(' ', $present);
6198     }
6199     if (!empty($presentSimpleFrom)) {
6200       $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
6201     }
6202
6203     $this->_fromClause = $this->_fromClause . $presentClause;
6204     $this->_simpleFromClause = $this->_simpleFromClause . $presentSimpleFromClause;
6205
6206     return array($presentClause, $presentSimpleFromClause);
6207   }
6208
6209   /**
6210    * Build qill for field.
6211    *
6212    * Qill refers to the query detail visible on the UI.
6213    *
6214    * @param string $daoName
6215    * @param string $fieldName
6216    * @param mixed $fieldValue
6217    * @param string $op
6218    * @param array $pseudoExtraParam
6219    * @param int $type
6220    *   Type of the field per CRM_Utils_Type
6221    *
6222    * @return array
6223    */
6224   public static function buildQillForFieldValue(
6225     $daoName,
6226     $fieldName,
6227     $fieldValue,
6228     $op,
6229     $pseudoExtraParam = array(),
6230     $type = CRM_Utils_Type::T_STRING
6231   ) {
6232     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
6233
6234     //API usually have fieldValue format as array(operator => array(values)),
6235     //so we need to separate operator out of fieldValue param
6236     if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
6237       $op = key($fieldValue);
6238       $fieldValue = $fieldValue[$op];
6239     }
6240
6241     // if Operator chosen is NULL/EMPTY then
6242     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
6243       return array(CRM_Utils_Array::value($op, $qillOperators, $op), '');
6244     }
6245
6246     if ($fieldName == 'activity_type_id') {
6247       $pseudoOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
6248     }
6249     elseif ($fieldName == 'country_id') {
6250       $pseudoOptions = CRM_Core_PseudoConstant::country();
6251     }
6252     elseif ($fieldName == 'county_id') {
6253       $pseudoOptions = CRM_Core_PseudoConstant::county();
6254     }
6255     elseif ($fieldName == 'world_region') {
6256       $pseudoOptions = CRM_Core_PseudoConstant::worldRegion();
6257     }
6258     elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
6259       $checkPermission = CRM_Utils_Array::value('check_permission', $pseudoExtraParam, TRUE);
6260       $pseudoOptions = CRM_Event_BAO_Event::getEvents(0, $fieldValue, TRUE, $checkPermission, TRUE);
6261     }
6262     elseif ($fieldName == 'contribution_product_id') {
6263       $pseudoOptions = CRM_Contribute_PseudoConstant::products();
6264     }
6265     elseif ($daoName == 'CRM_Contact_DAO_Group' && $fieldName == 'id') {
6266       $pseudoOptions = CRM_Core_PseudoConstant::group();
6267     }
6268     elseif ($daoName == 'CRM_Batch_BAO_EntityBatch' && $fieldName == 'batch_id') {
6269       $pseudoOptions = CRM_Contribute_PseudoConstant::batch();
6270     }
6271     elseif ($daoName) {
6272       $pseudoOptions = CRM_Core_PseudoConstant::get($daoName, $fieldName, $pseudoExtraParam);
6273     }
6274
6275     if (is_array($fieldValue)) {
6276       $qillString = array();
6277       if (!empty($pseudoOptions)) {
6278         foreach ((array) $fieldValue as $val) {
6279           $qillString[] = CRM_Utils_Array::value($val, $pseudoOptions, $val);
6280         }
6281         $fieldValue = implode(', ', $qillString);
6282       }
6283       else {
6284         if ($type == CRM_Utils_Type::T_DATE) {
6285           foreach ($fieldValue as $index => $value) {
6286             $fieldValue[$index] = CRM_Utils_Date::customFormat($value);
6287           }
6288         }
6289         $separator = ', ';
6290         // @todo - this is a bit specific (one operator).
6291         // However it is covered by a unit test so can be altered later with
6292         // some confidence.
6293         if ($op == 'BETWEEN') {
6294           $separator = ' AND ';
6295         }
6296         $fieldValue = implode($separator, $fieldValue);
6297       }
6298     }
6299     elseif (!empty($pseudoOptions) && array_key_exists($fieldValue, $pseudoOptions)) {
6300       $fieldValue = $pseudoOptions[$fieldValue];
6301     }
6302     elseif ($type === CRM_Utils_Type::T_DATE) {
6303       $fieldValue = CRM_Utils_Date::customFormat($fieldValue);
6304     }
6305
6306     return array(CRM_Utils_Array::value($op, $qillOperators, $op), $fieldValue);
6307   }
6308
6309   /**
6310    * Alter value to reflect wildcard settings.
6311    *
6312    * The form will have tried to guess whether this is a good field to wildcard but there is
6313    * also a site-wide setting that specifies whether it is OK to append the wild card to the beginning
6314    * or only the end of the string
6315    *
6316    * @param bool $wildcard
6317    *   This is a bool made on an assessment 'elsewhere' on whether this is a good field to wildcard.
6318    * @param string $op
6319    *   Generally '=' or 'LIKE'.
6320    * @param string $value
6321    *   The search string.
6322    *
6323    * @return string
6324    */
6325   public static function getWildCardedValue($wildcard, $op, $value) {
6326     if ($wildcard && $op == 'LIKE') {
6327       if (CRM_Core_Config::singleton()->includeWildCardInName && (substr($value, 0, 1) != '%')) {
6328         return "%$value%";
6329       }
6330       else {
6331         return "$value%";
6332       }
6333     }
6334     else {
6335       return "$value";
6336     }
6337   }
6338
6339   /**
6340    * Process special fields of Search Form in OK (Operator in Key) format
6341    *
6342    * @param array $formValues
6343    * @param array $specialFields
6344    *    Special params to be processed
6345    * @param array $changeNames
6346    *   Array of fields whose name should be changed
6347    */
6348   public static function processSpecialFormValue(&$formValues, $specialFields, $changeNames = array()) {
6349     // Array of special fields whose value are considered only for NULL or EMPTY operators
6350     $nullableFields = array('contribution_batch_id');
6351
6352     foreach ($specialFields as $element) {
6353       $value = CRM_Utils_Array::value($element, $formValues);
6354       if ($value) {
6355         if (is_array($value)) {
6356           if (in_array($element, array_keys($changeNames))) {
6357             unset($formValues[$element]);
6358             $element = $changeNames[$element];
6359           }
6360           $formValues[$element] = array('IN' => $value);
6361         }
6362         elseif (in_array($value, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
6363           $formValues[$element] = array($value => 1);
6364         }
6365         elseif (!in_array($element, $nullableFields)) {
6366           // if wildcard is already present return searchString as it is OR append and/or prepend with wildcard
6367           $isWilcard = strstr($value, '%') ? FALSE : CRM_Core_Config::singleton()->includeWildCardInName;
6368           $formValues[$element] = array('LIKE' => self::getWildCardedValue($isWilcard, 'LIKE', $value));
6369         }
6370       }
6371     }
6372   }
6373
6374   /**
6375    * Parse and assimilate the various sort options.
6376    *
6377    * Side-effect: if sorting on a common column from a related table (`city`, `postal_code`,
6378    * `email`), the related table may be joined automatically.
6379    *
6380    * At time of writing, this code is deeply flawed and should be rewritten. For the moment,
6381    * it's been extracted to a standalone function.
6382    *
6383    * @param string|CRM_Utils_Sort $sort
6384    *   The order by string.
6385    * @param bool $sortByChar
6386    *   If true returns the distinct array of first characters for search results.
6387    * @param null $sortOrder
6388    *   Who knows? Hu knows. He who knows Hu knows who.
6389    * @param string $additionalFromClause
6390    *   Should be clause with proper joins, effective to reduce where clause load.
6391    * @return array
6392    *   list(string $orderByClause, string $additionalFromClause).
6393    */
6394   protected function prepareOrderBy($sort, $sortByChar, $sortOrder, $additionalFromClause) {
6395     $order = NULL;
6396     $orderByArray = array();
6397     $config = CRM_Core_Config::singleton();
6398     if ($config->includeOrderByClause ||
6399       isset($this->_distinctComponentClause)
6400     ) {
6401       if ($sort) {
6402         if (is_string($sort)) {
6403           $orderBy = $sort;
6404         }
6405         else {
6406           $orderBy = trim($sort->orderBy());
6407         }
6408         // Deliberately remove the backticks again, as they mess up the evil
6409         // string munging below. This balanced by re-escaping before use.
6410         $orderBy = str_replace('`', '', $orderBy);
6411
6412         if (!empty($orderBy)) {
6413           // this is special case while searching for
6414           // change log CRM-1718
6415           if (preg_match('/sort_name/i', $orderBy)) {
6416             $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
6417           }
6418
6419           $order = " ORDER BY $orderBy";
6420
6421           if ($sortOrder) {
6422             $order .= " $sortOrder";
6423           }
6424
6425           // always add contact_a.id to the ORDER clause
6426           // so the order is deterministic
6427           if (strpos('contact_a.id', $order) === FALSE) {
6428             $order .= ", contact_a.id";
6429           }
6430         }
6431       }
6432       elseif ($sortByChar) {
6433         $orderByArray = array("UPPER(LEFT(contact_a.sort_name, 1)) asc");
6434       }
6435       else {
6436         $order = " ORDER BY contact_a.sort_name ASC, contact_a.id";
6437       }
6438     }
6439     if (!$order && empty($orderByArray)) {
6440       return array($order, $additionalFromClause);
6441     }
6442     // Remove this here & add it at the end for simplicity.
6443     $order = trim(str_replace('ORDER BY', '', $order));
6444
6445     // hack for order clause
6446     if (!empty($orderByArray)) {
6447       $order = implode(', ', $orderByArray);
6448     }
6449     else {
6450       $orderByArray = explode(',', $order);
6451     }
6452     foreach ($orderByArray as $orderByClause) {
6453       $orderByClauseParts = explode(' ', trim($orderByClause));
6454       $field = $orderByClauseParts[0];
6455       $direction = isset($orderByClauseParts[1]) ? $orderByClauseParts[1] : 'asc';
6456
6457       switch ($field) {
6458         case 'city':
6459         case 'postal_code':
6460           $this->_tables["civicrm_address"] = $this->_whereTables["civicrm_address"] = 1;
6461           $order = str_replace($field, "civicrm_address.{$field}", $order);
6462           break;
6463
6464         case 'country':
6465         case 'state_province':
6466           $this->_tables["civicrm_{$field}"] = $this->_whereTables["civicrm_{$field}"] = 1;
6467           if (is_array($this->_returnProperties) && empty($this->_returnProperties)) {
6468             $additionalFromClause .= " LEFT JOIN civicrm_{$field} ON civicrm_{$field}.id = civicrm_address.{$field}_id";
6469           }
6470           $order = str_replace($field, "civicrm_{$field}.name", $order);
6471           break;
6472
6473         case 'email':
6474           $this->_tables["civicrm_email"] = $this->_whereTables["civicrm_email"] = 1;
6475           $order = str_replace($field, "civicrm_email.{$field}", $order);
6476           break;
6477
6478         default:
6479           $cfID = CRM_Core_BAO_CustomField::getKeyID($field);
6480           // add to cfIDs array if not present
6481           if (!empty($cfID) && !array_key_exists($cfID, $this->_cfIDs)) {
6482             $this->_cfIDs[$cfID] = array();
6483             $this->_customQuery = new CRM_Core_BAO_CustomQuery($this->_cfIDs, TRUE, $this->_locationSpecificCustomFields);
6484             $this->_customQuery->query();
6485             $this->_select = array_merge($this->_select, $this->_customQuery->_select);
6486             $this->_tables = array_merge($this->_tables, $this->_customQuery->_tables);
6487           }
6488           foreach ($this->_pseudoConstantsSelect as $key => $pseudoConstantMetadata) {
6489             // By replacing the join to the option value table with the mysql construct
6490             // ORDER BY field('contribution_status_id', 2,1,4)
6491             // we can remove a join. In the case of the option value join it is
6492             /// a join known to cause slow queries.
6493             // @todo cover other pseudoconstant types. Limited to option group ones in the
6494             // first instance for scope reasons. They require slightly different handling as the column (label)
6495             // is not declared for them.
6496             // @todo so far only integer fields are being handled. If we add string fields we need to look at
6497             // escaping.
6498             if (isset($pseudoConstantMetadata['pseudoconstant'])
6499               && isset($pseudoConstantMetadata['pseudoconstant']['optionGroupName'])
6500               && $field === CRM_Utils_Array::value('optionGroupName', $pseudoConstantMetadata['pseudoconstant'])
6501             ) {
6502               $sortedOptions = $pseudoConstantMetadata['bao']::buildOptions($pseudoConstantMetadata['pseudoField'], NULL, array(
6503                 'orderColumn' => 'label',
6504               ));
6505               $order = str_replace("$field $direction", "field({$pseudoConstantMetadata['pseudoField']}," . implode(',', array_keys($sortedOptions)) . ") $direction", $order);
6506             }
6507             //CRM-12565 add "`" around $field if it is a pseudo constant
6508             // This appears to be for 'special' fields like locations with appended numbers or hyphens .. maybe.
6509             if (!empty($pseudoConstantMetadata['element']) && $pseudoConstantMetadata['element'] == $field) {
6510               $order = str_replace($field, "`{$field}`", $order);
6511             }
6512           }
6513       }
6514     }
6515
6516     $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
6517     $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
6518
6519     // The above code relies on crazy brittle string manipulation of a peculiarly-encoded ORDER BY
6520     // clause. But this magic helper which forgivingly reescapes ORDER BY.
6521     // Note: $sortByChar implies that $order was hard-coded/trusted, so it can do funky things.
6522     if ($sortByChar) {
6523       return array(' ORDER BY ' . $order, $additionalFromClause);
6524     }
6525     if ($order) {
6526       $order = CRM_Utils_Type::escape($order, 'MysqlOrderBy');
6527       return array(' ORDER BY ' . $order, $additionalFromClause);
6528     }
6529   }
6530
6531   /**
6532    * Convert a string of group IDs to a string of group labels.
6533    *
6534    * The original string may include duplicates and groups the user does not have
6535    * permission to see.
6536    *
6537    * @param CRM_Core_DAO $dao
6538    * @param string $val
6539    *
6540    * @return string
6541    */
6542   public function convertGroupIDStringToLabelString(&$dao, $val) {
6543     $groupIDs = explode(',', $val);
6544     // Note that groups that the user does not have permission to will be excluded (good).
6545     $groups = array_intersect_key(CRM_Core_PseudoConstant::group(), array_flip($groupIDs));
6546     return implode(', ', $groups);
6547
6548   }
6549
6550   /**
6551    * Set the qill and where properties for a field.
6552    *
6553    * This function is intended as a short-term function to encourage refactoring
6554    * & re-use - but really we should just have less special-casing.
6555    *
6556    * @param string $name
6557    * @param string $op
6558    * @param string|array $value
6559    * @param string $grouping
6560    * @param string $field
6561    */
6562   public function setQillAndWhere($name, $op, $value, $grouping, $field) {
6563     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value);
6564     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, $name, $value, $op);
6565     $this->_qill[$grouping][] = ts("%1 %2 %3", array(
6566       1 => $field['title'],
6567       2 => $qillop,
6568       3 => $qillVal,
6569     ));
6570   }
6571
6572   /**
6573    * Has the pseudoconstant of the field been requested.
6574    *
6575    * For example if the field is payment_instrument_id then it
6576    * has been requested if either payment_instrument_id or payment_instrument
6577    * have been requested. Payment_instrument is the option groun name field value.
6578    *
6579    * @param array $field
6580    * @param string $fieldName
6581    *   The unique name of the field - ie. the one it will be aliased to in the query.
6582    *
6583    * @return bool
6584    */
6585   private function pseudoConstantNameIsInReturnProperties($field, $fieldName = NULL) {
6586     if (!isset($field['pseudoconstant']['optionGroupName'])) {
6587       return FALSE;
6588     }
6589
6590     if (CRM_Utils_Array::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties)) {
6591       return TRUE;
6592     }
6593     if (CRM_Utils_Array::value($fieldName, $this->_returnProperties)) {
6594       return TRUE;
6595     }
6596     // Is this still required - the above goes off the unique name. Test with things like
6597     // communication_prefferences & prefix_id.
6598     if (CRM_Utils_Array::value($field['name'], $this->_returnProperties)) {
6599       return TRUE;
6600     }
6601     return FALSE;
6602   }
6603
6604   /**
6605    * Get Select Clause.
6606    *
6607    * @return string
6608    */
6609   public function getSelect() {
6610     $select = "SELECT ";
6611     if (isset($this->_distinctComponentClause)) {
6612       $select .= "{$this->_distinctComponentClause}, ";
6613     }
6614     $select .= implode(', ', $this->_select);
6615     return $select;
6616   }
6617
6618 }