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);
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       $filterCondition = array('greeting_type' => 'email_greeting');
2239       $this->optionValueQuery(
2240         $name, $op, $value, $grouping,
2241         CRM_Core_PseudoConstant::greeting($filterCondition),
2242         $field,
2243         ts('Email Greeting')
2244       );
2245     }
2246     elseif ($name === 'postal_greeting') {
2247       $filterCondition = array('greeting_type' => 'postal_greeting');
2248       $this->optionValueQuery(
2249         $name, $op, $value, $grouping,
2250         CRM_Core_PseudoConstant::greeting($filterCondition),
2251         $field,
2252         ts('Postal Greeting')
2253       );
2254     }
2255     elseif ($name === 'addressee') {
2256       $filterCondition = array('greeting_type' => 'addressee');
2257       $this->optionValueQuery(
2258         $name, $op, $value, $grouping,
2259         CRM_Core_PseudoConstant::greeting($filterCondition),
2260         $field,
2261         ts('Addressee')
2262       );
2263     }
2264     elseif (substr($name, 0, 4) === 'url-') {
2265       $tName = 'civicrm_website';
2266       $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2267       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2268       if ($wildcard) {
2269         $op = 'LIKE';
2270         $value = self::getWildCardedValue($wildcard, $op, $value);
2271       }
2272
2273       $this->_where[$grouping][] = $d = self::buildClause('civicrm_website.url', $op, $value);
2274       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2275     }
2276     elseif ($name === 'contact_is_deleted') {
2277       $this->setQillAndWhere('is_deleted', $op, $value, $grouping, $field);
2278     }
2279     elseif (!empty($field['where'])) {
2280       $type = NULL;
2281       if (!empty($field['type'])) {
2282         $type = CRM_Utils_Type::typeToString($field['type']);
2283       }
2284
2285       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2286
2287       if (isset($locType[1]) &&
2288         is_numeric($locType[1])
2289       ) {
2290         $setTables = FALSE;
2291
2292         //get the location name
2293         list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
2294         // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
2295         $fieldName = "LOWER(`$tName`.$fldName)";
2296
2297         // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2298         $this->_tables[$tName] = $this->_whereTables[$tName] = 1;
2299
2300       }
2301       else {
2302         if ($tableName == 'civicrm_contact') {
2303           $fieldName = "contact_a.{$fieldName}";
2304         }
2305         else {
2306           if ($op != 'IN' && !is_numeric($value) && !is_array($value)) {
2307             // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
2308             $fieldName = "LOWER({$field['where']})";
2309           }
2310           else {
2311             $fieldName = "{$field['where']}";
2312           }
2313         }
2314       }
2315
2316       list($qillop, $qillVal) = self::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2317       $this->_qill[$grouping][] = ts("%1 %2 %3", array(
2318         1 => $field['title'],
2319         2 => $qillop,
2320         3 => (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) ? $qillVal : "'$qillVal'"));
2321
2322       if (is_array($value)) {
2323         // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2324         // for api style operators for functions that hit this point without worrying about regression
2325         // (the previous comments indicated the condition for hitting this point were unknown
2326         // per CRM-14743 we are adding modified_date & created_date operator support
2327         $operations = array_keys($value);
2328         foreach ($operations as $operator) {
2329           if (!in_array($operator, CRM_Core_DAO::acceptedSQLOperators())) {
2330             //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2331             //so this condition will satisfy the search for now
2332             if (strpos($op, 'IN') !== FALSE) {
2333               $value = array($op => $value);
2334             }
2335             // we don't know when this might happen
2336             else {
2337               CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2338             }
2339           }
2340         }
2341         $this->_where[$grouping][] = CRM_Core_DAO::createSQLFilter($fieldName, $value, $type);
2342       }
2343       else {
2344         if (!strpos($op, 'IN')) {
2345           $value = $strtolower($value);
2346         }
2347         if ($wildcard) {
2348           $op = 'LIKE';
2349           $value = self::getWildCardedValue($wildcard, $op, $value);
2350         }
2351
2352         $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type);
2353       }
2354     }
2355
2356     if ($setTables && isset($field['where'])) {
2357       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2358       if (isset($tableName)) {
2359         $this->_tables[$tableName] = 1;
2360         $this->_whereTables[$tableName] = 1;
2361       }
2362     }
2363   }
2364
2365   /**
2366    * @param $where
2367    * @param $locType
2368    *
2369    * @return array
2370    * @throws Exception
2371    */
2372   public static function getLocationTableName(&$where, &$locType) {
2373     if (isset($locType[1]) && is_numeric($locType[1])) {
2374       list($tbName, $fldName) = explode(".", $where);
2375
2376       //get the location name
2377       $locationType = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate');
2378       $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2379       if (in_array($locType[0], $specialFields)) {
2380         //hack to fix / special handing for phone_ext
2381         if ($locType[0] == 'phone_ext') {
2382           $locType[0] = 'phone';
2383         }
2384         if (isset($locType[2]) && $locType[2]) {
2385           $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2386         }
2387         else {
2388           $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2389         }
2390       }
2391       elseif (in_array($locType[0],
2392         array(
2393           'address_name',
2394           'street_address',
2395           'street_name',
2396           'street_number_suffix',
2397           'street_unit',
2398           'supplemental_address_1',
2399           'supplemental_address_2',
2400           'supplemental_address_3',
2401           'city',
2402           'postal_code',
2403           'postal_code_suffix',
2404           'geo_code_1',
2405           'geo_code_2',
2406           'master_id',
2407         )
2408       )) {
2409         //fix for search by profile with address fields.
2410         $tName = "{$locationType[$locType[1]]}-address";
2411       }
2412       elseif (in_array($locType[0],
2413           array(
2414             'on_hold',
2415             'signature_html',
2416             'signature_text',
2417             'is_bulkmail',
2418           )
2419         )) {
2420         $tName = "{$locationType[$locType[1]]}-email";
2421       }
2422       elseif ($locType[0] == 'provider_id') {
2423         $tName = "{$locationType[$locType[1]]}-im";
2424       }
2425       elseif ($locType[0] == 'openid') {
2426         $tName = "{$locationType[$locType[1]]}-openid";
2427       }
2428       else {
2429         $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2430       }
2431       $tName = str_replace(' ', '_', $tName);
2432       return array($tName, $fldName);
2433     }
2434     CRM_Core_Error::fatal();
2435   }
2436
2437   /**
2438    * Given a result dao, extract the values and return that array
2439    *
2440    * @param CRM_Core_DAO $dao
2441    *
2442    * @return array
2443    *   values for this query
2444    */
2445   public function store($dao) {
2446     $value = array();
2447
2448     foreach ($this->_element as $key => $dontCare) {
2449       if (property_exists($dao, $key)) {
2450         if (strpos($key, '-') !== FALSE) {
2451           $values = explode('-', $key);
2452           $lastElement = array_pop($values);
2453           $current = &$value;
2454           $cnt = count($values);
2455           $count = 1;
2456           foreach ($values as $v) {
2457             if (!array_key_exists($v, $current)) {
2458               $current[$v] = array();
2459             }
2460             //bad hack for im_provider
2461             if ($lastElement == 'provider_id') {
2462               if ($count < $cnt) {
2463                 $current = &$current[$v];
2464               }
2465               else {
2466                 $lastElement = "{$v}_{$lastElement}";
2467               }
2468             }
2469             else {
2470               $current = &$current[$v];
2471             }
2472             $count++;
2473           }
2474
2475           $current[$lastElement] = $dao->$key;
2476         }
2477         else {
2478           $value[$key] = $dao->$key;
2479         }
2480       }
2481     }
2482     return $value;
2483   }
2484
2485   /**
2486    * Getter for tables array.
2487    *
2488    * @return array
2489    */
2490   public function tables() {
2491     return $this->_tables;
2492   }
2493
2494   /**
2495    * Sometimes used to create the from clause, but, not reliably, set
2496    * this AND set tables.
2497    *
2498    * It's unclear the intent - there is a 'simpleFrom' clause which
2499    * takes whereTables into account & a fromClause which doesn't.
2500    *
2501    * logic may have eroded?
2502    *
2503    * @return array
2504    */
2505   public function whereTables() {
2506     return $this->_whereTables;
2507   }
2508
2509   /**
2510    * Generate the where clause (used in match contacts and permissions)
2511    *
2512    * @param array $params
2513    * @param array $fields
2514    * @param array $tables
2515    * @param $whereTables
2516    * @param bool $strict
2517    *
2518    * @return string
2519    */
2520   public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2521     $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2522       FALSE, $strict
2523     );
2524
2525     $tables = array_merge($query->tables(), $tables);
2526     $whereTables = array_merge($query->whereTables(), $whereTables);
2527
2528     return $query->_whereClause;
2529   }
2530
2531   /**
2532    * Create the from clause.
2533    *
2534    * @param array $tables
2535    *   Tables that need to be included in this from clause. If null,
2536    *   return mimimal from clause (i.e. civicrm_contact).
2537    * @param array $inner
2538    *   Tables that should be inner-joined.
2539    * @param array $right
2540    *   Tables that should be right-joined.
2541    * @param bool $primaryLocation
2542    *   Search on primary location. See note below.
2543    * @param int $mode
2544    *   Determines search mode based on bitwise MODE_* constants.
2545    * @param string|NULL $apiEntity
2546    *   Determines search mode based on entity by string.
2547    *
2548    * The $primaryLocation flag only seems to be used when
2549    * locationType() has been called. This may be a search option
2550    * exposed, or perhaps it's a "search all details" approach which
2551    * predates decoupling of location types and primary fields?
2552    *
2553    * @see https://issues.civicrm.org/jira/browse/CRM-19967
2554    *
2555    * @return string
2556    *   the from clause
2557    */
2558   public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1, $apiEntity = NULL) {
2559
2560     $from = ' FROM civicrm_contact contact_a';
2561     if (empty($tables)) {
2562       return $from;
2563     }
2564
2565     if (!empty($tables['civicrm_worldregion'])) {
2566       $tables = array_merge(array('civicrm_country' => 1), $tables);
2567     }
2568
2569     if ((!empty($tables['civicrm_state_province']) || !empty($tables['civicrm_country']) ||
2570         CRM_Utils_Array::value('civicrm_county', $tables)
2571       ) && empty($tables['civicrm_address'])
2572     ) {
2573       $tables = array_merge(array('civicrm_address' => 1),
2574         $tables
2575       );
2576     }
2577
2578     // add group_contact and group table is subscription history is present
2579     if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2580       $tables = array_merge(array(
2581           'civicrm_group' => 1,
2582           'civicrm_group_contact' => 1,
2583         ),
2584         $tables
2585       );
2586     }
2587
2588     // to handle table dependencies of components
2589     CRM_Core_Component::tableNames($tables);
2590     // to handle table dependencies of hook injected tables
2591     CRM_Contact_BAO_Query_Hook::singleton()->setTableDependency($tables);
2592
2593     //format the table list according to the weight
2594     $info = CRM_Core_TableHierarchy::info();
2595
2596     foreach ($tables as $key => $value) {
2597       $k = 99;
2598       if (strpos($key, '-') !== FALSE) {
2599         $keyArray = explode('-', $key);
2600         $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99);
2601       }
2602       elseif (strpos($key, '_') !== FALSE) {
2603         $keyArray = explode('_', $key);
2604         if (is_numeric(array_pop($keyArray))) {
2605           $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99);
2606         }
2607         else {
2608           $k = CRM_Utils_Array::value($key, $info, 99);
2609         }
2610       }
2611       else {
2612         $k = CRM_Utils_Array::value($key, $info, 99);
2613       }
2614       $tempTable[$k . ".$key"] = $key;
2615     }
2616     ksort($tempTable);
2617     $newTables = array();
2618     foreach ($tempTable as $key) {
2619       $newTables[$key] = $tables[$key];
2620     }
2621
2622     $tables = $newTables;
2623
2624     foreach ($tables as $name => $value) {
2625       if (!$value) {
2626         continue;
2627       }
2628
2629       if (!empty($inner[$name])) {
2630         $side = 'INNER';
2631       }
2632       elseif (!empty($right[$name])) {
2633         $side = 'RIGHT';
2634       }
2635       else {
2636         $side = 'LEFT';
2637       }
2638
2639       if ($value != 1) {
2640         // if there is already a join statement in value, use value itself
2641         if (strpos($value, 'JOIN')) {
2642           $from .= " $value ";
2643         }
2644         else {
2645           $from .= " $side JOIN $name ON ( $value ) ";
2646         }
2647         continue;
2648       }
2649
2650       $limitToPrimaryClause = $primaryLocation ? "AND {$name}.is_primary = 1" : '';
2651
2652       switch ($name) {
2653         case 'civicrm_address':
2654           //CRM-14263 further handling of address joins further down...
2655           $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id {$limitToPrimaryClause} )";
2656           continue;
2657
2658         case 'civicrm_phone':
2659           $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id {$limitToPrimaryClause}) ";
2660           continue;
2661
2662         case 'civicrm_email':
2663           $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id {$limitToPrimaryClause})";
2664           continue;
2665
2666         case 'civicrm_im':
2667           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id {$limitToPrimaryClause}) ";
2668           continue;
2669
2670         case 'im_provider':
2671           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2672           $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2673           $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)";
2674           continue;
2675
2676         case 'civicrm_openid':
2677           $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id {$limitToPrimaryClause} )";
2678           continue;
2679
2680         case 'civicrm_worldregion':
2681           $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2682           $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2683           continue;
2684
2685         case 'civicrm_location_type':
2686           $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2687           continue;
2688
2689         case 'civicrm_group':
2690           $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2691           continue;
2692
2693         case 'civicrm_group_contact':
2694           $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2695           continue;
2696
2697         case 'civicrm_group_contact_cache':
2698           $from .= " $side JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id ";
2699           continue;
2700
2701         case 'civicrm_activity':
2702         case 'civicrm_activity_tag':
2703         case 'activity_type':
2704         case 'activity_status':
2705         case 'parent_id':
2706         case 'civicrm_activity_contact':
2707         case 'source_contact':
2708         case 'activity_priority':
2709           $from .= CRM_Activity_BAO_Query::from($name, $mode, $side);
2710           continue;
2711
2712         case 'civicrm_entity_tag':
2713           $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2714                                                               civicrm_entity_tag.entity_id = contact_a.id ) ";
2715           continue;
2716
2717         case 'civicrm_note':
2718           $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2719                                                         contact_a.id = civicrm_note.entity_id ) ";
2720           continue;
2721
2722         case 'civicrm_subscription_history':
2723           $from .= " $side JOIN civicrm_subscription_history
2724                                    ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2725                                   AND civicrm_group_contact.group_id =  civicrm_subscription_history.group_id";
2726           continue;
2727
2728         case 'civicrm_relationship':
2729           if (self::$_relType == 'reciprocal') {
2730             if (self::$_relationshipTempTable) {
2731               // we have a temptable to join on
2732               $tbl = self::$_relationshipTempTable;
2733               $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2734             }
2735             else {
2736               $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2737               $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)";
2738             }
2739           }
2740           elseif (self::$_relType == 'b') {
2741             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2742             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2743           }
2744           else {
2745             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2746             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2747           }
2748           continue;
2749
2750         case 'civicrm_log':
2751           $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2752           $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2753           continue;
2754
2755         case 'civicrm_tag':
2756           $from .= " $side  JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2757           continue;
2758
2759         case 'civicrm_grant':
2760           $from .= CRM_Grant_BAO_Query::from($name, $mode, $side);
2761           continue;
2762
2763         case 'civicrm_campaign':
2764           //Move to default case if not in either mode.
2765           if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
2766             $from .= CRM_Contribute_BAO_Query::from($name, $mode, $side);
2767             continue;
2768           }
2769           elseif ($mode & CRM_Contact_BAO_Query::MODE_MAILING) {
2770             $from .= CRM_Mailing_BAO_Query::from($name, $mode, $side);
2771             continue;
2772           }
2773           elseif ($mode & CRM_Contact_BAO_Query::MODE_CAMPAIGN) {
2774             $from .= CRM_Campaign_BAO_Query::from($name, $mode, $side);
2775             continue;
2776           }
2777
2778         case 'civicrm_website':
2779           $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2780           continue;
2781
2782         default:
2783           $locationTypeName = '';
2784           if (strpos($name, '-address') != 0) {
2785             $locationTypeName = 'address';
2786           }
2787           elseif (strpos($name, '-phone') != 0) {
2788             $locationTypeName = 'phone';
2789           }
2790           elseif (strpos($name, '-email') != 0) {
2791             $locationTypeName = 'email';
2792           }
2793           elseif (strpos($name, '-im') != 0) {
2794             $locationTypeName = 'im';
2795           }
2796           elseif (strpos($name, '-openid') != 0) {
2797             $locationTypeName = 'openid';
2798           }
2799
2800           if ($locationTypeName) {
2801             //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2802             $parts = explode('-', $name);
2803             $locationTypes = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate');
2804             foreach ($locationTypes as $locationTypeID => $locationType) {
2805               if ($parts[0] == str_replace(' ', '_', $locationType)) {
2806                 $locationID = $locationTypeID;
2807               }
2808             }
2809             $from .= " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2810           }
2811           else {
2812             $from .= CRM_Core_Component::from($name, $mode, $side);
2813           }
2814           $from .= CRM_Contact_BAO_Query_Hook::singleton()->buildSearchfrom($name, $mode, $side);
2815
2816           continue;
2817       }
2818     }
2819     return $from;
2820   }
2821
2822   /**
2823    * WHERE / QILL clause for deleted_contacts
2824    *
2825    * @param array $values
2826    */
2827   public function deletedContacts($values) {
2828     list($_, $_, $value, $grouping, $_) = $values;
2829     if ($value) {
2830       // *prepend* to the relevant grouping as this is quite an important factor
2831       array_unshift($this->_qill[$grouping], ts('Search in Trash'));
2832     }
2833   }
2834
2835   /**
2836    * Where / qill clause for contact_type
2837    *
2838    * @param $values
2839    */
2840   public function contactType(&$values) {
2841     list($name, $op, $value, $grouping, $wildcard) = $values;
2842
2843     $subTypes = array();
2844     $clause = array();
2845
2846     // account for search builder mapping multiple values
2847     if (!is_array($value)) {
2848       $values = self::parseSearchBuilderString($value, 'String');
2849       if (is_array($values)) {
2850         $value = array_flip($values);
2851       }
2852     }
2853
2854     if (is_array($value)) {
2855       foreach ($value as $k => $v) {
2856         // fix for CRM-771
2857         if ($k) {
2858           $subType = NULL;
2859           $contactType = $k;
2860           if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) {
2861             list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2);
2862           }
2863
2864           if (!empty($subType)) {
2865             $subTypes[$subType] = 1;
2866           }
2867           $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2868         }
2869       }
2870     }
2871     else {
2872       $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2);
2873       $contactType = $contactTypeANDSubType[0];
2874       $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType);
2875       if (!empty($subType)) {
2876         $subTypes[$subType] = 1;
2877       }
2878       $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2879     }
2880
2881     // fix for CRM-771
2882     if (!empty($clause)) {
2883       $quill = $clause;
2884       if ($op == 'IN' || $op == 'NOT IN') {
2885         $this->_where[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2886       }
2887       else {
2888         $type = array_pop($clause);
2889         $this->_where[$grouping][] = self::buildClause("contact_a.contact_type", $op, $contactType);
2890       }
2891
2892       $this->_qill[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2893
2894       if (!empty($subTypes)) {
2895         $this->includeContactSubTypes($subTypes, $grouping);
2896       }
2897     }
2898   }
2899
2900   /**
2901    * Where / qill clause for contact_sub_type.
2902    *
2903    * @param array $values
2904    */
2905   public function contactSubType(&$values) {
2906     list($name, $op, $value, $grouping, $wildcard) = $values;
2907     $this->includeContactSubTypes($value, $grouping, $op);
2908   }
2909
2910   /**
2911    * @param $value
2912    * @param $grouping
2913    * @param string $op
2914    */
2915   public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2916
2917     if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
2918       $op = key($value);
2919       $value = $value[$op];
2920     }
2921
2922     $clause = array();
2923     $alias = "contact_a.contact_sub_type";
2924     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
2925
2926     $op = str_replace('IN', 'LIKE', $op);
2927     $op = str_replace('=', 'LIKE', $op);
2928     $op = str_replace('!', 'NOT ', $op);
2929
2930     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
2931       $this->_where[$grouping][] = self::buildClause($alias, $op, $value, 'String');
2932     }
2933     elseif (is_array($value)) {
2934       foreach ($value as $k => $v) {
2935         $clause[$k] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($v, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2936       }
2937     }
2938     else {
2939       $clause[$value] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2940     }
2941
2942     if (!empty($clause)) {
2943       $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2944     }
2945     $this->_qill[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2946   }
2947
2948   /**
2949    * Where / qill clause for groups.
2950    *
2951    * @param $values
2952    */
2953   public function group($values) {
2954     list($name, $op, $value, $grouping, $wildcard) = $values;
2955
2956     // If the $value is in OK (operator as key) array format we need to extract the key as operator and value first
2957     if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
2958       $op = key($value);
2959       $value = $value[$op];
2960     }
2961
2962     // Replace pseudo operators from search builder
2963     $op = str_replace('EMPTY', 'NULL', $op);
2964
2965     if (strpos($op, 'NULL')) {
2966       $value = NULL;
2967     }
2968
2969     if (is_array($value) && count($value) > 1) {
2970       if (strpos($op, 'IN') === FALSE && strpos($op, 'NULL') === FALSE) {
2971         CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $op)));
2972       }
2973       $this->_useDistinct = TRUE;
2974     }
2975
2976     if (isset($value)) {
2977       $value = CRM_Utils_Array::value($op, $value, $value);
2978     }
2979
2980     if ($name == 'group_type') {
2981       $value = array_keys($this->getGroupsFromTypeCriteria($value));
2982     }
2983
2984     $regularGroupIDs = $smartGroupIDs = array();
2985     foreach ((array) $value as $id) {
2986       if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $id, 'saved_search_id')) {
2987         $smartGroupIDs[] = $id;
2988       }
2989       else {
2990         $regularGroupIDs[] = $id;
2991       }
2992     }
2993
2994     $isNotOp = ($op == 'NOT IN' || $op == '!=');
2995
2996     $statii = array();
2997     $gcsValues = $this->getWhereValues('group_contact_status', $grouping);
2998     if ($gcsValues &&
2999       is_array($gcsValues[2])
3000     ) {
3001       foreach ($gcsValues[2] as $k => $v) {
3002         if ($v) {
3003           $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
3004         }
3005       }
3006     }
3007     else {
3008       $statii[] = "'Added'";
3009     }
3010     $groupClause = array();
3011     if (count($regularGroupIDs) || empty($value)) {
3012       // include child groups IDs if any
3013       $childGroupIds = (array) CRM_Contact_BAO_Group::getChildGroupIds($regularGroupIDs);
3014       foreach ($childGroupIds as $key => $id) {
3015         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $id, 'saved_search_id')) {
3016           $smartGroupIDs[] = $id;
3017           unset($childGroupIds[$key]);
3018         }
3019       }
3020       if (count($childGroupIds)) {
3021         $regularGroupIDs = array_merge($regularGroupIDs, $childGroupIds);
3022       }
3023
3024       // if $regularGroupIDs is populated with regular child group IDs
3025       //   then change the mysql operator to desired
3026       if (count($regularGroupIDs) > 1) {
3027         $op = strpos($op, 'IN') ? $op : ($op == '!=') ? 'NOT IN' : 'IN';
3028       }
3029       $groupIds = implode(',', (array) $regularGroupIDs);
3030       $gcTable = "`civicrm_group_contact-{$groupIds}`";
3031       $joinClause = array("contact_a.id = {$gcTable}.contact_id");
3032
3033       if (strpos($op, 'IN') !== FALSE) {
3034         $clause = "{$gcTable}.group_id $op ( $groupIds ) ";
3035       }
3036       elseif ($op == '!=') {
3037         $clause = "{$gcTable}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact cgc WHERE cgc.group_id = $groupIds )";
3038       }
3039       else {
3040         $clause = "{$gcTable}.group_id $op $groupIds ";
3041       }
3042       $groupClause[] = "( {$clause} )";
3043
3044       if ($statii) {
3045         $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
3046       }
3047       $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
3048     }
3049
3050     //CRM-19589: contact(s) removed from a Smart Group, resides in civicrm_group_contact table
3051     if (count($smartGroupIDs)) {
3052       $groupClause[] = " ( " . $this->addGroupContactCache($smartGroupIDs, NULL, "contact_a", $op) . " ) ";
3053     }
3054
3055     $and = ($op == 'IS NULL') ? ' AND ' : ' OR ';
3056     $this->_where[$grouping][] = ' ( ' . implode($and, $groupClause) . ' ) ';
3057
3058     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Group', 'id', $value, $op);
3059     $this->_qill[$grouping][] = ts("Group(s) %1 %2", array(1 => $qillop, 2 => $qillVal));
3060     if (strpos($op, 'NULL') === FALSE) {
3061       $this->_qill[$grouping][] = ts("Group Status %1", array(1 => implode(' ' . ts('or') . ' ', $statii)));
3062     }
3063   }
3064
3065   /**
3066    * Function translates selection of group type into a list of groups.
3067    * @param $value
3068    *
3069    * @return array
3070    */
3071   public function getGroupsFromTypeCriteria($value) {
3072     $groupIds = array();
3073     foreach ((array) $value as $groupTypeValue) {
3074       $groupList = CRM_Core_PseudoConstant::group($groupTypeValue);
3075       $groupIds = ($groupIds + $groupList);
3076     }
3077     return $groupIds;
3078   }
3079
3080   /**
3081    * Prime smart group cache for smart groups in the search, and join
3082    * civicrm_group_contact_cache table into the query.
3083    *
3084    * @param array $groups IDs of groups specified in search criteria.
3085    * @param string $tableAlias Alias to use for civicrm_group_contact_cache table.
3086    * @param string $joinTable Table on which to join civicrm_group_contact_cache
3087    * @param string $op SQL comparison operator (NULL, IN, !=, IS NULL, etc.)
3088    * @param string $joinColumn Column in $joinTable on which to join civicrm_group_contact_cache.contact_id
3089    *
3090    * @return string WHERE clause component for smart group criteria.
3091    */
3092   public function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a", $op, $joinColumn = 'id') {
3093     $isNullOp = (strpos($op, 'NULL') !== FALSE);
3094     $groupsIds = $groups;
3095     if (!$isNullOp && !$groups) {
3096       return NULL;
3097     }
3098     elseif (strpos($op, 'IN') !== FALSE) {
3099       $groups = array($op => $groups);
3100     }
3101     elseif (is_array($groups) && count($groups)) {
3102       $groups = array('IN' => $groups);
3103     }
3104
3105     // Find all the groups that are part of a saved search.
3106     $smartGroupClause = self::buildClause("id", $op, $groups, 'Int');
3107     $sql = "
3108 SELECT id, cache_date, saved_search_id, children
3109 FROM   civicrm_group
3110 WHERE  $smartGroupClause
3111   AND  ( saved_search_id != 0
3112    OR    saved_search_id IS NOT NULL
3113    OR    children IS NOT NULL )
3114 ";
3115
3116     $group = CRM_Core_DAO::executeQuery($sql);
3117
3118     while ($group->fetch()) {
3119       $this->_useDistinct = TRUE;
3120       if (!$this->_smartGroupCache || $group->cache_date == NULL) {
3121         CRM_Contact_BAO_GroupContactCache::load($group);
3122       }
3123     }
3124     if ($group->N == 0) {
3125       return NULL;
3126     }
3127
3128     if (!$tableAlias) {
3129       $tableAlias = "`civicrm_group_contact_cache_";
3130       $tableAlias .= ($isNullOp) ? "a`" : implode(',', (array) $groupsIds) . "`";
3131     }
3132
3133     $this->_tables[$tableAlias] = $this->_whereTables[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.{$joinColumn} = {$tableAlias}.contact_id ";
3134     return self::buildClause("{$tableAlias}.group_id", $op, $groups, 'Int');
3135   }
3136
3137   /**
3138    * Where / qill clause for cms users
3139    *
3140    * @param $values
3141    */
3142   public function ufUser(&$values) {
3143     list($name, $op, $value, $grouping, $wildcard) = $values;
3144
3145     if ($value == 1) {
3146       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
3147
3148       $this->_qill[$grouping][] = ts('CMS User');
3149     }
3150     elseif ($value == 0) {
3151       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
3152
3153       $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
3154       $this->_qill[$grouping][] = ts('Not a CMS User');
3155     }
3156   }
3157
3158   /**
3159    * All tag search specific.
3160    *
3161    * @param array $values
3162    */
3163   public function tagSearch(&$values) {
3164     list($name, $op, $value, $grouping, $wildcard) = $values;
3165
3166     $op = "LIKE";
3167     $value = "%{$value}%";
3168
3169     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3170     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3171
3172     $etTable = "`civicrm_entity_tag-" . $value . "`";
3173     $tTable = "`civicrm_tag-" . $value . "`";
3174
3175     if ($useAllTagTypes[2]) {
3176       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3177         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
3178             LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  )";
3179
3180       // search tag in cases
3181       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3182       $tCaseTable = "`civicrm_case_tag-" . $value . "`";
3183       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3184         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3185             LEFT JOIN civicrm_case
3186             ON (civicrm_case_contact.case_id = civicrm_case.id
3187                 AND civicrm_case.is_deleted = 0 )
3188             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
3189             LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id  )";
3190       // search tag in activities
3191       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3192       $tActTable = "`civicrm_act_tag-" . $value . "`";
3193       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
3194       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3195
3196       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3197         = " LEFT JOIN civicrm_activity_contact
3198             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3199             LEFT JOIN civicrm_activity
3200             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3201             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3202             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3203             LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id  )";
3204
3205       $this->_where[$grouping][] = "({$tTable}.name $op '" . $value . "' OR {$tCaseTable}.name $op '" . $value . "' OR {$tActTable}.name $op '" . $value . "')";
3206       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3207     }
3208     else {
3209       $etTable = "`civicrm_entity_tag-" . $value . "`";
3210       $tTable = "`civicrm_tag-" . $value . "`";
3211       $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND
3212       {$etTable}.entity_table = 'civicrm_contact' )
3213                 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  ) ";
3214
3215       $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String');
3216       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3217     }
3218   }
3219
3220   /**
3221    * Where / qill clause for tag.
3222    *
3223    * @param array $values
3224    */
3225   public function tag(&$values) {
3226     list($name, $op, $value, $grouping, $wildcard) = $values;
3227
3228     list($qillop, $qillVal) = self::buildQillForFieldValue('CRM_Core_DAO_EntityTag', "tag_id", $value, $op, array('onlyActive' => FALSE));
3229     // API/Search Builder format array(operator => array(values))
3230     if (is_array($value)) {
3231       if (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
3232         $op = key($value);
3233         $value = $value[$op];
3234       }
3235       if (count($value) > 1) {
3236         $this->_useDistinct = TRUE;
3237       }
3238       $value = implode(',', (array) $value);
3239     }
3240
3241     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3242     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3243
3244     $etTable = "`civicrm_entity_tag-" . $value . "`";
3245
3246     if ($useAllTagTypes[2]) {
3247       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3248         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3249
3250       // search tag in cases
3251       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3252       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
3253       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3254
3255       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3256         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3257             LEFT JOIN civicrm_case
3258             ON (civicrm_case_contact.case_id = civicrm_case.id
3259                 AND civicrm_case.is_deleted = 0 )
3260             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3261       // search tag in activities
3262       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3263       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3264         = " LEFT JOIN civicrm_activity_contact
3265             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3266             LEFT JOIN civicrm_activity
3267             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3268             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3269             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3270
3271       // CRM-10338
3272       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3273         $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3274       }
3275       else {
3276         $this->_where[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3277       }
3278     }
3279     else {
3280       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3281         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3282
3283       // CRM-10338
3284       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3285         // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3286         $op = str_replace('EMPTY', 'NULL', $op);
3287         $this->_where[$grouping][] = "{$etTable}.tag_id $op";
3288       }
3289       // CRM-16941: for tag tried with != operator we don't show contact who don't have given $value AND also in other tag
3290       elseif ($op == '!=') {
3291         $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') . ")";
3292       }
3293       elseif ($op == '=' || strstr($op, 'IN')) {
3294         $op = ($op == '=') ? 'IN' : $op;
3295         $this->_where[$grouping][] = "{$etTable}.tag_id $op ( $value )";
3296       }
3297     }
3298     $this->_qill[$grouping][] = ts('Tagged %1 %2', array(1 => $qillop, 2 => $qillVal));
3299   }
3300
3301   /**
3302    * Where/qill clause for notes
3303    *
3304    * @param array $values
3305    */
3306   public function notes(&$values) {
3307     list($name, $op, $value, $grouping, $wildcard) = $values;
3308
3309     $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3310     $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6');
3311     $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption);
3312
3313     $this->_useDistinct = TRUE;
3314
3315     $this->_tables['civicrm_note'] = $this->_whereTables['civicrm_note']
3316       = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3317
3318     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3319     $n = trim($value);
3320     $value = $strtolower(CRM_Core_DAO::escapeString($n));
3321     if ($wildcard) {
3322       if (strpos($value, '%') === FALSE) {
3323         $value = "%$value%";
3324       }
3325       $op = 'LIKE';
3326     }
3327     elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') {
3328       $value = NULL;
3329     }
3330
3331     $label = NULL;
3332     $clauses = array();
3333     if ($noteOption % 2 == 0) {
3334       $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String');
3335       $label = ts('Note: Body Only');
3336     }
3337     if ($noteOption % 3 == 0) {
3338       $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String');
3339       $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only');
3340     }
3341     $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3342     list($qillOp, $qillVal) = self::buildQillForFieldValue(NULL, $name, $n, $op);
3343     $this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillOp, 3 => $qillVal));
3344   }
3345
3346   /**
3347    * @param string $name
3348    * @param $op
3349    * @param $grouping
3350    *
3351    * @return bool
3352    */
3353   public function nameNullOrEmptyOp($name, $op, $grouping) {
3354     switch ($op) {
3355       case 'IS NULL':
3356       case 'IS NOT NULL':
3357         $this->_where[$grouping][] = "contact_a.$name $op";
3358         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3359         return TRUE;
3360
3361       case 'IS EMPTY':
3362         $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3363         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3364         return TRUE;
3365
3366       case 'IS NOT EMPTY':
3367         $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3368         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3369         return TRUE;
3370
3371       default:
3372         return FALSE;
3373     }
3374   }
3375
3376   /**
3377    * Where / qill clause for sort_name
3378    *
3379    * @param array $values
3380    */
3381   public function sortName(&$values) {
3382     list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3383
3384     // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3385     if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3386       return;
3387     }
3388
3389     $input = $value = trim($value);
3390
3391     if (!strlen($value)) {
3392       return;
3393     }
3394
3395     $config = CRM_Core_Config::singleton();
3396
3397     $sub = array();
3398
3399     //By default, $sub elements should be joined together with OR statements (don't change this variable).
3400     $subGlue = ' OR ';
3401
3402     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3403
3404     $firstChar = substr($value, 0, 1);
3405     $lastChar = substr($value, -1, 1);
3406     $quotes = array("'", '"');
3407     // If string is quoted, strip quotes and otherwise don't alter it
3408     if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3409       $value = trim($value, implode('', $quotes));
3410     }
3411     // Replace spaces with wildcards for a LIKE operation
3412     // UNLESS string contains a comma (this exception is a tiny bit questionable)
3413     elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3414       $value = str_replace(' ', '%', $value);
3415     }
3416     $value = $strtolower(CRM_Core_DAO::escapeString(trim($value)));
3417     if (strlen($value)) {
3418       $fieldsub = array();
3419       $value = "'" . self::getWildCardedValue($wildcard, $op, $value) . "'";
3420       if ($fieldName == 'sort_name') {
3421         // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
3422         $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3423       }
3424       else {
3425         // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
3426         $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name";
3427       }
3428       $fieldsub[] = " ( $wc $op $value )";
3429       if ($config->includeNickNameInName) {
3430         // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
3431         $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3432         $fieldsub[] = " ( $wc $op $value )";
3433       }
3434       if ($config->includeEmailInName) {
3435         $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3436       }
3437       $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3438     }
3439
3440     $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3441
3442     $this->_where[$grouping][] = $sub;
3443     if ($config->includeEmailInName) {
3444       $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3445       $this->_qill[$grouping][] = ts('Name or Email') . " $op - '$input'";
3446     }
3447     else {
3448       $this->_qill[$grouping][] = ts('Name') . " $op - '$input'";
3449     }
3450   }
3451
3452   /**
3453    * Where/qill clause for greeting fields.
3454    *
3455    * @param array $values
3456    */
3457   public function greetings(&$values) {
3458     list($name, $op, $value, $grouping, $wildcard) = $values;
3459     $name .= '_display';
3460
3461     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, $name, $value, $op);
3462     $this->_qill[$grouping][] = ts('Greeting %1 %2', array(1 => $qillop, 2 => $qillVal));
3463     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value, 'String');
3464   }
3465
3466   /**
3467    * Where / qill clause for email
3468    *
3469    * @param array $values
3470    * @param string $apiEntity
3471    */
3472   protected function email(&$values, $apiEntity) {
3473     list($name, $op, $value, $grouping, $wildcard) = $values;
3474     $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3475
3476     // CRM-18147: for Contact's GET API, email fieldname got appended with its entity as in {$apiEntiy}_{$name}
3477     // so following code is use build whereClause for contact's primart email id
3478     if (!empty($apiEntity)) {
3479       $dataType = 'String';
3480       if ($name == 'email_id') {
3481         $dataType = 'Integer';
3482         $name = 'id';
3483       }
3484
3485       $this->_where[$grouping][] = self::buildClause('civicrm_email.is_primary', '=', 1, 'Integer');
3486       $this->_where[$grouping][] = self::buildClause("civicrm_email.$name", $op, $value, $dataType);
3487       return;
3488     }
3489
3490     $n = strtolower(trim($value));
3491     if ($n) {
3492       if (substr($n, 0, 1) == '"' &&
3493         substr($n, -1, 1) == '"'
3494       ) {
3495         $n = substr($n, 1, -1);
3496         $value = CRM_Core_DAO::escapeString($n);
3497         $op = '=';
3498       }
3499       else {
3500         $value = self::getWildCardedValue($wildcard, $op, $n);
3501       }
3502       $this->_qill[$grouping][] = ts('Email') . " $op '$n'";
3503       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String');
3504     }
3505     else {
3506       $this->_qill[$grouping][] = ts('Email') . " $op ";
3507       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String');
3508     }
3509   }
3510
3511   /**
3512    * Where / qill clause for phone number
3513    *
3514    * @param array $values
3515    */
3516   public function phone_numeric(&$values) {
3517     list($name, $op, $value, $grouping, $wildcard) = $values;
3518     // Strip non-numeric characters; allow wildcards
3519     $number = preg_replace('/[^\d%]/', '', $value);
3520     if ($number) {
3521       if (strpos($number, '%') === FALSE) {
3522         $number = "%$number%";
3523       }
3524
3525       $this->_qill[$grouping][] = ts('Phone number contains') . " $number";
3526       $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3527       $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3528     }
3529   }
3530
3531   /**
3532    * Where / qill clause for phone type/location
3533    *
3534    * @param array $values
3535    */
3536   public function phone_option_group($values) {
3537     list($name, $op, $value, $grouping, $wildcard) = $values;
3538     $option = ($name == 'phone_phone_type_id' ? 'phone_type_id' : 'location_type_id');
3539     $options = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', $option);
3540     $optionName = $options[$value];
3541     $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName";
3542     $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3543     $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3544   }
3545
3546   /**
3547    * Where / qill clause for street_address.
3548    *
3549    * @param array $values
3550    */
3551   public function street_address(&$values) {
3552     list($name, $op, $value, $grouping, $wildcard) = $values;
3553
3554     if (!$op) {
3555       $op = 'LIKE';
3556     }
3557
3558     $n = trim($value);
3559
3560     if ($n) {
3561       if (strpos($value, '%') === FALSE) {
3562         // only add wild card if not there
3563         $value = "%{$value}%";
3564       }
3565       $op = 'LIKE';
3566       // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
3567       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, $value, 'String');
3568       $this->_qill[$grouping][] = ts('Street') . " $op '$n'";
3569     }
3570     else {
3571       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3572       $this->_qill[$grouping][] = ts('Street') . " $op ";
3573     }
3574
3575     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3576   }
3577
3578   /**
3579    * Where / qill clause for street_unit.
3580    *
3581    * @param array $values
3582    */
3583   public function street_number(&$values) {
3584     list($name, $op, $value, $grouping, $wildcard) = $values;
3585
3586     if (!$op) {
3587       $op = '=';
3588     }
3589
3590     $n = trim($value);
3591
3592     if (strtolower($n) == 'odd') {
3593       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3594       $this->_qill[$grouping][] = ts('Street Number is odd');
3595     }
3596     elseif (strtolower($n) == 'even') {
3597       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3598       $this->_qill[$grouping][] = ts('Street Number is even');
3599     }
3600     else {
3601       $value = strtolower($n);
3602
3603       // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
3604       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3605       $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'";
3606     }
3607
3608     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3609   }
3610
3611   /**
3612    * Where / qill clause for sorting by character.
3613    *
3614    * @param array $values
3615    */
3616   public function sortByCharacter(&$values) {
3617     list($name, $op, $value, $grouping, $wildcard) = $values;
3618
3619     $name = trim($value);
3620     $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'";
3621     $this->_where[$grouping][] = $cond;
3622     $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3623   }
3624
3625   /**
3626    * Where / qill clause for including contact ids.
3627    */
3628   public function includeContactIDs() {
3629     if (!$this->_includeContactIds || empty($this->_params)) {
3630       return;
3631     }
3632
3633     $contactIds = array();
3634     foreach ($this->_params as $id => $values) {
3635       if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
3636         $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN);
3637       }
3638     }
3639     CRM_Utils_Type::validateAll($contactIds, 'Positive');
3640     if (!empty($contactIds)) {
3641       $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3642     }
3643   }
3644
3645   /**
3646    * Where / qill clause for postal code.
3647    *
3648    * @param array $values
3649    */
3650   public function postalCode(&$values) {
3651     // skip if the fields dont have anything to do with postal_code
3652     if (empty($this->_fields['postal_code'])) {
3653       return;
3654     }
3655
3656     list($name, $op, $value, $grouping, $wildcard) = $values;
3657
3658     // Handle numeric postal code range searches properly by casting the column as numeric
3659     if (is_numeric($value)) {
3660       $field = "IF (civicrm_address.postal_code REGEXP '^[0-9]{1,10}$', CAST(civicrm_address.postal_code AS UNSIGNED), 0)";
3661       $val = CRM_Utils_Type::escape($value, 'Integer');
3662     }
3663     else {
3664       $field = 'civicrm_address.postal_code';
3665       // Per CRM-17060 we might be looking at an 'IN' syntax so don't case arrays to string.
3666       if (!is_array($value)) {
3667         $val = CRM_Utils_Type::escape($value, 'String');
3668       }
3669       else {
3670         // Do we need to escape values here? I would expect buildClause does.
3671         $val = $value;
3672       }
3673     }
3674
3675     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3676
3677     if ($name == 'postal_code') {
3678       $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String');
3679       $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}";
3680     }
3681     elseif ($name == 'postal_code_low') {
3682       $this->_where[$grouping][] = " ( $field >= '$val' ) ";
3683       $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3684     }
3685     elseif ($name == 'postal_code_high') {
3686       $this->_where[$grouping][] = " ( $field <= '$val' ) ";
3687       $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3688     }
3689   }
3690
3691   /**
3692    * Where / qill clause for location type.
3693    *
3694    * @param array $values
3695    * @param null $status
3696    *
3697    * @return string
3698    */
3699   public function locationType(&$values, $status = NULL) {
3700     list($name, $op, $value, $grouping, $wildcard) = $values;
3701
3702     if (is_array($value)) {
3703       $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3704       $this->_tables['civicrm_address'] = 1;
3705       $this->_whereTables['civicrm_address'] = 1;
3706
3707       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
3708       $names = array();
3709       foreach ($value as $id) {
3710         $names[] = $locationType[$id];
3711       }
3712
3713       $this->_primaryLocation = FALSE;
3714
3715       if (!$status) {
3716         $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3717       }
3718       else {
3719         return implode(' ' . ts('or') . ' ', $names);
3720       }
3721     }
3722   }
3723
3724   /**
3725    * @param $values
3726    * @param bool $fromStateProvince
3727    *
3728    * @return array|NULL
3729    */
3730   public function country(&$values, $fromStateProvince = TRUE) {
3731     list($name, $op, $value, $grouping, $wildcard) = $values;
3732
3733     if (!$fromStateProvince) {
3734       $stateValues = $this->getWhereValues('state_province', $grouping);
3735       if (!empty($stateValues)) {
3736         // return back to caller if there are state province values
3737         // since that handles this case
3738         return NULL;
3739       }
3740     }
3741
3742     $countryClause = $countryQill = NULL;
3743     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) || ($values && !empty($value))) {
3744       $this->_tables['civicrm_address'] = 1;
3745       $this->_whereTables['civicrm_address'] = 1;
3746
3747       $countryClause = self::buildClause('civicrm_address.country_id', $op, $value, 'Positive');
3748       list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, 'country_id', $value, $op);
3749       $countryQill = ts("%1 %2 %3", array(1 => 'Country', 2 => $qillop, 3 => $qillVal));
3750
3751       if (!$fromStateProvince) {
3752         $this->_where[$grouping][] = $countryClause;
3753         $this->_qill[$grouping][] = $countryQill;
3754       }
3755     }
3756
3757     if ($fromStateProvince) {
3758       if (!empty($countryClause)) {
3759         return array(
3760           $countryClause,
3761           " ...AND... " . $countryQill,
3762         );
3763       }
3764       else {
3765         return array(NULL, NULL);
3766       }
3767     }
3768   }
3769
3770   /**
3771    * Where / qill clause for county (if present).
3772    *
3773    * @param array $values
3774    * @param null $status
3775    *
3776    * @return string
3777    */
3778   public function county(&$values, $status = NULL) {
3779     list($name, $op, $value, $grouping, $wildcard) = $values;
3780
3781     if (!is_array($value)) {
3782       // force the county to be an array
3783       $value = array($value);
3784     }
3785
3786     // check if the values are ids OR names of the counties
3787     $inputFormat = 'id';
3788     foreach ($value as $v) {
3789       if (!is_numeric($v)) {
3790         $inputFormat = 'name';
3791         break;
3792       }
3793     }
3794     $names = array();
3795     if ($op == '=') {
3796       $op = 'IN';
3797     }
3798     elseif ($op == '!=') {
3799       $op = 'NOT IN';
3800     }
3801     else {
3802       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3803       $op = str_replace('EMPTY', 'NULL', $op);
3804     }
3805
3806     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3807       $clause = "civicrm_address.county_id $op";
3808     }
3809     elseif ($inputFormat == 'id') {
3810       $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3811
3812       $county = CRM_Core_PseudoConstant::county();
3813       foreach ($value as $id) {
3814         $names[] = CRM_Utils_Array::value($id, $county);
3815       }
3816     }
3817     else {
3818       $inputClause = array();
3819       $county = CRM_Core_PseudoConstant::county();
3820       foreach ($value as $name) {
3821         $name = trim($name);
3822         $inputClause[] = CRM_Utils_Array::key($name, $county);
3823       }
3824       $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3825       $names = $value;
3826     }
3827     $this->_tables['civicrm_address'] = 1;
3828     $this->_whereTables['civicrm_address'] = 1;
3829
3830     $this->_where[$grouping][] = $clause;
3831     if (!$status) {
3832       $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3833     }
3834     else {
3835       return implode(' ' . ts('or') . ' ', $names);
3836     }
3837   }
3838
3839   /**
3840    * Where / qill clause for state/province AND country (if present).
3841    *
3842    * @param array $values
3843    * @param null $status
3844    *
3845    * @return string
3846    */
3847   public function stateProvince(&$values, $status = NULL) {
3848     list($name, $op, $value, $grouping, $wildcard) = $values;
3849
3850     $stateClause = self::buildClause('civicrm_address.state_province_id', $op, $value, 'Positive');
3851     $this->_tables['civicrm_address'] = 1;
3852     $this->_whereTables['civicrm_address'] = 1;
3853
3854     $countryValues = $this->getWhereValues('country', $grouping);
3855     list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3856     if ($countryClause) {
3857       $clause = "( $stateClause AND $countryClause )";
3858     }
3859     else {
3860       $clause = $stateClause;
3861     }
3862
3863     $this->_where[$grouping][] = $clause;
3864     list($qillop, $qillVal) = self::buildQillForFieldValue('CRM_Core_DAO_Address', "state_province_id", $value, $op);
3865     if (!$status) {
3866       $this->_qill[$grouping][] = ts("State/Province %1 %2 %3", array(1 => $qillop, 2 => $qillVal, 3 => $countryQill));
3867     }
3868     else {
3869       return implode(' ' . ts('or') . ' ', $qillVal) . $countryQill;
3870     }
3871   }
3872
3873   /**
3874    * Where / qill clause for change log.
3875    *
3876    * @param array $values
3877    */
3878   public function changeLog(&$values) {
3879     list($name, $op, $value, $grouping, $wildcard) = $values;
3880
3881     $targetName = $this->getWhereValues('changed_by', $grouping);
3882     if (!$targetName) {
3883       return;
3884     }
3885
3886     $name = trim($targetName[2]);
3887     $name = strtolower(CRM_Core_DAO::escapeString($name));
3888     $name = $targetName[4] ? "%$name%" : $name;
3889     $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3890     $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1;
3891     $this->_qill[$grouping][] = ts('Modified By') . " $name";
3892   }
3893
3894   /**
3895    * @param $values
3896    */
3897   public function modifiedDates($values) {
3898     $this->_useDistinct = TRUE;
3899
3900     // CRM-11281, default to added date if not set
3901     $fieldTitle = ts('Added Date');
3902     $fieldName = 'created_date';
3903     foreach (array_keys($this->_params) as $id) {
3904       if ($this->_params[$id][0] == 'log_date') {
3905         if ($this->_params[$id][2] == 2) {
3906           $fieldTitle = ts('Modified Date');
3907           $fieldName = 'modified_date';
3908         }
3909       }
3910     }
3911
3912     $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3913
3914     self::$_openedPanes[ts('Change Log')] = TRUE;
3915   }
3916
3917   /**
3918    * @param $values
3919    */
3920   public function demographics(&$values) {
3921     list($name, $op, $value, $grouping, $wildcard) = $values;
3922
3923     if (($name == 'age_low') || ($name == 'age_high')) {
3924       $this->ageRangeQueryBuilder($values,
3925         'contact_a', 'age', 'birth_date', ts('Age')
3926       );
3927     }
3928     elseif (($name == 'birth_date_low') || ($name == 'birth_date_high')) {
3929
3930       $this->dateQueryBuilder($values,
3931         'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3932       );
3933     }
3934     elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) {
3935
3936       $this->dateQueryBuilder($values,
3937         'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3938       );
3939     }
3940
3941     self::$_openedPanes[ts('Demographics')] = TRUE;
3942   }
3943
3944   /**
3945    * @param $values
3946    */
3947   public function privacy(&$values) {
3948     list($name, $op, $value, $grouping, $wildcard) = $values;
3949     //fixed for profile search listing CRM-4633
3950     if (strpbrk($value, "[")) {
3951       $value = "'{$value}'";
3952       $op = "!{$op}";
3953       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3954     }
3955     else {
3956       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3957     }
3958     $field = CRM_Utils_Array::value($name, $this->_fields);
3959     $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
3960     $title = $field ? $field['title'] : $name;
3961     $this->_qill[$grouping][] = "$title $op $value";
3962   }
3963
3964   /**
3965    * @param $values
3966    */
3967   public function privacyOptions($values) {
3968     list($name, $op, $value, $grouping, $wildcard) = $values;
3969
3970     if (empty($value) || !is_array($value)) {
3971       return;
3972     }
3973
3974     // get the operator and toggle values
3975     $opValues = $this->getWhereValues('privacy_operator', $grouping);
3976     $operator = 'OR';
3977     if ($opValues &&
3978       strtolower($opValues[2] == 'AND')
3979     ) {
3980       $operator = 'AND';
3981     }
3982
3983     $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3984     $compareOP = '!';
3985     if ($toggleValues &&
3986       $toggleValues[2] == 2
3987     ) {
3988       $compareOP = '';
3989     }
3990
3991     $clauses = array();
3992     $qill = array();
3993     foreach ($value as $dontCare => $pOption) {
3994       $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
3995       $field = CRM_Utils_Array::value($pOption, $this->_fields);
3996       $title = $field ? $field['title'] : $pOption;
3997       $qill[] = " $title = 1 ";
3998     }
3999
4000     $this->_where[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
4001     $this->_qill[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
4002   }
4003
4004   /**
4005    * @param $values
4006    */
4007   public function preferredCommunication(&$values) {
4008     list($name, $op, $value, $grouping, $wildcard) = $values;
4009
4010     if (!is_array($value)) {
4011       $value = str_replace(array('(', ')'), '', explode(",", $value));
4012     }
4013     elseif (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
4014       $op = key($value);
4015       $value = $value[$op];
4016     }
4017     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Contact', $name, $value, $op);
4018
4019     if (self::caseImportant($op)) {
4020       $value = implode("[[:cntrl:]]|[[:cntrl:]]", (array) $value);
4021       $op = (strstr($op, '!') || strstr($op, 'NOT')) ? 'NOT RLIKE' : 'RLIKE';
4022       $value = "[[:cntrl:]]" . $value . "[[:cntrl:]]";
4023     }
4024
4025     $this->_where[$grouping][] = self::buildClause("contact_a.preferred_communication_method", $op, $value);
4026     $this->_qill[$grouping][] = ts('Preferred Communication Method %1 %2', array(1 => $qillop, 2 => $qillVal));
4027   }
4028
4029   /**
4030    * Where / qill clause for relationship.
4031    *
4032    * @param array $values
4033    */
4034   public function relationship(&$values) {
4035     list($name, $op, $value, $grouping, $wildcard) = $values;
4036     if ($this->_relationshipValuesAdded) {
4037       return;
4038     }
4039     // also get values array for relation_target_name
4040     // for relationship search we always do wildcard
4041     $relationType = $this->getWhereValues('relation_type_id', $grouping);
4042     $targetName = $this->getWhereValues('relation_target_name', $grouping);
4043     $relStatus = $this->getWhereValues('relation_status', $grouping);
4044     $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
4045
4046     $nameClause = $name = NULL;
4047     if ($targetName) {
4048       $name = trim($targetName[2]);
4049       if (substr($name, 0, 1) == '"' &&
4050         substr($name, -1, 1) == '"'
4051       ) {
4052         $name = substr($name, 1, -1);
4053         $name = strtolower(CRM_Core_DAO::escapeString($name));
4054         $nameClause = "= '$name'";
4055       }
4056       else {
4057         $name = strtolower(CRM_Core_DAO::escapeString($name));
4058         $nameClause = "LIKE '%{$name}%'";
4059       }
4060     }
4061
4062     $rTypeValues = $relTypes = $relTypesIds = array();
4063     if (!empty($relationType)) {
4064       $relationType[2] = (array) $relationType[2];
4065       foreach ($relationType[2] as $relType) {
4066         $rel = explode('_', $relType);
4067         self::$_relType = $rel[1];
4068         $params = array('id' => $rel[0]);
4069         $typeValues = array();
4070         $rTypeValue = CRM_Contact_BAO_RelationshipType::retrieve($params, $typeValues);
4071         if (!empty($rTypeValue)) {
4072           $rTypeValues[] = $rTypeValue;
4073           $relTypesIds[] = $rel[0];
4074           $relTypes[] = $relType;
4075         }
4076       }
4077     }
4078     if (!empty($rTypeValues)) {
4079       foreach ($rTypeValues as $rTypeValue) {
4080         $rTypeValue = (array) $rTypeValue;
4081         if ($rTypeValue['name_a_b'] == $rTypeValue['name_b_a']) {
4082           // if we don't know which end of the relationship we are dealing with we'll create a temp table
4083           self::$_relType = 'reciprocal';
4084         }
4085       }
4086     }
4087     // if we are creating a temp table we build our own where for the relationship table
4088     $relationshipTempTable = NULL;
4089     if (self::$_relType == 'reciprocal') {
4090       $where = array();
4091       self::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO::createTempTableName('civicrm_rel');
4092       if ($nameClause) {
4093         $where[$grouping][] = " sort_name $nameClause ";
4094       }
4095       $groupJoinTable = "civicrm_relationship";
4096       $groupJoinColumn = "contact_id_alt";
4097     }
4098     else {
4099       $where = &$this->_where;
4100       if ($nameClause) {
4101         $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
4102       }
4103       $groupJoinTable = "contact_b";
4104       $groupJoinColumn = "id";
4105     }
4106     $allRelationshipType = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, NULL, TRUE);
4107     if ($nameClause || !$targetGroup) {
4108       if (!empty($relationType)) {
4109         $relQill = '';
4110         foreach ($relTypes as $rel) {
4111           if (!empty($relQill)) {
4112             $relQill .= ' OR ';
4113           }
4114           $relQill .= $allRelationshipType[$rel];
4115         }
4116         $this->_qill[$grouping][] = 'Relationship Type(s) ' . $relQill . " $name";
4117       }
4118       else {
4119         $this->_qill[$grouping][] = $name;
4120       }
4121     }
4122
4123     //check to see if the target contact is in specified group
4124     if ($targetGroup) {
4125       //add contacts from static groups
4126       $this->_tables['civicrm_relationship_group_contact'] = $this->_whereTables['civicrm_relationship_group_contact']
4127         = " 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'";
4128       $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN  (" .
4129         implode(",", $targetGroup[2]) . ") ) ";
4130
4131       //add contacts from saved searches
4132       $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", $groupJoinTable, $op, $groupJoinColumn);
4133
4134       //set the group where clause
4135       if ($ssWhere) {
4136         $groupWhere[] = "( " . $ssWhere . " )";
4137       }
4138       $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4139
4140       //Get the names of the target groups for the qill
4141       $groupNames = CRM_Core_PseudoConstant::group();
4142       $qillNames = array();
4143       foreach ($targetGroup[2] as $groupId) {
4144         if (array_key_exists($groupId, $groupNames)) {
4145           $qillNames[] = $groupNames[$groupId];
4146         }
4147       }
4148       if (!empty($relationType)) {
4149         $relQill = '';
4150         foreach ($relTypes as $rel) {
4151           if (!empty($relQill)) {
4152             $relQill .= ' OR ';
4153           }
4154           $relQill .= CRM_Utils_Array::value($rel, $allRelationshipType);
4155         }
4156         $this->_qill[$grouping][] = 'Relationship Type(s) ' . $relQill . " ( " . implode(", ", $qillNames) . " )";
4157       }
4158       else {
4159         $this->_qill[$grouping][] = implode(", ", $qillNames);
4160       }
4161     }
4162
4163     // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4164     $today = date('Ymd');
4165     //check for active, inactive and all relation status
4166     if ($relStatus[2] == 0) {
4167       $where[$grouping][] = "(
4168 civicrm_relationship.is_active = 1 AND
4169 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4170 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4171 )";
4172       $this->_qill[$grouping][] = ts('Relationship - Active and Current');
4173     }
4174     elseif ($relStatus[2] == 1) {
4175       $where[$grouping][] = "(
4176 civicrm_relationship.is_active = 0 OR
4177 civicrm_relationship.end_date < {$today} OR
4178 civicrm_relationship.start_date > {$today}
4179 )";
4180       $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current');
4181     }
4182
4183     $onlyDeleted = 0;
4184     if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params)) {
4185       $onlyDeleted = 1;
4186     }
4187     $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4188
4189     $this->addRelationshipPermissionClauses($grouping, $where);
4190     $this->addRelationshipDateClauses($grouping, $where);
4191     $this->addRelationshipActivePeriodClauses($grouping, $where);
4192     if (!empty($relTypes)) {
4193       $where[$grouping][] = 'civicrm_relationship.relationship_type_id IN (' . implode(',', $relTypesIds) . ')';
4194     }
4195     $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1;
4196     $this->_useDistinct = TRUE;
4197     $this->_relationshipValuesAdded = TRUE;
4198     // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4199     // join on that,
4200     if ($relationshipTempTable) {
4201       $whereClause = '';
4202       if (!empty($where[$grouping])) {
4203         $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4204         $whereClause = str_replace('contact_b', 'c', $whereClause);
4205       }
4206       $sql = "
4207         CREATE TEMPORARY TABLE {$relationshipTempTable}
4208           (SELECT contact_id_b as contact_id, contact_id_a as contact_id_alt, civicrm_relationship.id
4209             FROM civicrm_relationship
4210             INNER JOIN  civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4211             $whereClause )
4212           UNION
4213             (SELECT contact_id_a as contact_id, contact_id_b as contact_id_alt, civicrm_relationship.id
4214             FROM civicrm_relationship
4215             INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4216             $whereClause )
4217       ";
4218       CRM_Core_DAO::executeQuery($sql);
4219     }
4220   }
4221
4222   public function addRelationshipPermissionClauses($grouping, &$where) {
4223     $relPermission = $this->getWhereValues('relation_permission', $grouping);
4224     if ($relPermission) {
4225       $where[$grouping][] = "(civicrm_relationship.is_permission_a_b IN (" . implode(",", $relPermission[2]) . "))";
4226
4227       $allRelationshipPermissions = CRM_Contact_BAO_Relationship::buildOptions('is_permission_a_b');
4228       $relQill = '';
4229       foreach ($relPermission[2] as $rel) {
4230         if (!empty($relQill)) {
4231           $relQill .= ' OR ';
4232         }
4233         $relQill .= ts($allRelationshipPermissions[$rel]);
4234       }
4235       $this->_qill[$grouping][] = ts('Permissioned Relationships') . ' - ' . $relQill;
4236     }
4237   }
4238
4239   /**
4240    * Add start & end date criteria in
4241    * @param string $grouping
4242    * @param array $where
4243    *   = array to add where clauses to, in case you are generating a temp table.
4244    * not the main query.
4245    */
4246   public function addRelationshipDateClauses($grouping, &$where) {
4247     $dateValues = array();
4248     $dateTypes = array(
4249       'start_date',
4250       'end_date',
4251     );
4252
4253     foreach ($dateTypes as $dateField) {
4254       $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4255       $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4256       if (!empty($dateValueLow)) {
4257         $date = date('Ymd', strtotime($dateValueLow[2]));
4258         $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4259         $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);
4260       }
4261       if (!empty($dateValueHigh)) {
4262         $date = date('Ymd', strtotime($dateValueHigh[2]));
4263         $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4264         $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);
4265       }
4266     }
4267   }
4268
4269   /**
4270    * Add start & end active period criteria in
4271    * @param string $grouping
4272    * @param array $where
4273    *   = array to add where clauses to, in case you are generating a temp table.
4274    * not the main query.
4275    */
4276   public function addRelationshipActivePeriodClauses($grouping, &$where) {
4277     $dateValues = array();
4278     $dateField = 'active_period_date';
4279
4280     $dateValueLow = $this->getWhereValues('relation_active_period_date_low', $grouping);
4281     $dateValueHigh = $this->getWhereValues('relation_active_period_date_high', $grouping);
4282     $dateValueLowFormated = $dateValueHighFormated = NULL;
4283     if (!empty($dateValueLow) && !empty($dateValueHigh)) {
4284       $dateValueLowFormated = date('Ymd', strtotime($dateValueLow[2]));
4285       $dateValueHighFormated = date('Ymd', strtotime($dateValueHigh[2]));
4286       $this->_qill[$grouping][] = (ts('Relationship was active between')) . " " . CRM_Utils_Date::customFormat($dateValueLowFormated) . " and " . CRM_Utils_Date::customFormat($dateValueHighFormated);
4287     }
4288     elseif (!empty($dateValueLow)) {
4289       $dateValueLowFormated = date('Ymd', strtotime($dateValueLow[2]));
4290       $this->_qill[$grouping][] = (ts('Relationship was active after')) . " " . CRM_Utils_Date::customFormat($dateValueLowFormated);
4291     }
4292     elseif (!empty($dateValueHigh)) {
4293       $dateValueHighFormated = date('Ymd', strtotime($dateValueHigh[2]));
4294       $this->_qill[$grouping][] = (ts('Relationship was active before')) . " " . CRM_Utils_Date::customFormat($dateValueHighFormated);
4295     }
4296
4297     if ($activePeriodClauses = self::getRelationshipActivePeriodClauses($dateValueLowFormated, $dateValueHighFormated, TRUE)) {
4298       $where[$grouping][] = $activePeriodClauses;
4299     }
4300   }
4301
4302   /**
4303    * Get start & end active period criteria
4304    */
4305   public static function getRelationshipActivePeriodClauses($from, $to, $forceTableName) {
4306     $tableName = $forceTableName ? 'civicrm_relationship.' : '';
4307     if (!is_null($from) && !is_null($to)) {
4308       return '(((' . $tableName . 'start_date >= ' . $from . ' AND ' . $tableName . 'start_date <= ' . $to . ') OR
4309                 (' . $tableName . 'end_date >= ' . $from . ' AND ' . $tableName . 'end_date <= ' . $to . ') OR
4310                 (' . $tableName . 'start_date <= ' . $from . ' AND ' . $tableName . 'end_date >= ' . $to . ' )) OR
4311                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4312                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date >= ' . $from . ') OR
4313                (' . $tableName . 'end_date IS NULL AND ' . $tableName . 'start_date <= ' . $to . '))';
4314     }
4315     elseif (!is_null($from)) {
4316       return '((' . $tableName . 'start_date >= ' . $from . ') OR
4317                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4318                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date >= ' . $from . '))';
4319     }
4320     elseif (!is_null($to)) {
4321       return '((' . $tableName . 'start_date <= ' . $to . ') OR
4322                (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4323                (' . $tableName . 'end_date IS NULL AND ' . $tableName . 'start_date <= ' . $to . '))';
4324     }
4325   }
4326
4327   /**
4328    * Default set of return properties.
4329    *
4330    * @param int $mode
4331    *
4332    * @return array
4333    *   derault return properties
4334    */
4335   public static function &defaultReturnProperties($mode = 1) {
4336     if (!isset(self::$_defaultReturnProperties)) {
4337       self::$_defaultReturnProperties = array();
4338     }
4339
4340     if (!isset(self::$_defaultReturnProperties[$mode])) {
4341       // add activity return properties
4342       if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
4343         self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE);
4344       }
4345       else {
4346         self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE);
4347       }
4348
4349       if (empty(self::$_defaultReturnProperties[$mode])) {
4350         self::$_defaultReturnProperties[$mode] = array(
4351           'home_URL' => 1,
4352           'image_URL' => 1,
4353           'legal_identifier' => 1,
4354           'external_identifier' => 1,
4355           'contact_type' => 1,
4356           'contact_sub_type' => 1,
4357           'sort_name' => 1,
4358           'display_name' => 1,
4359           'preferred_mail_format' => 1,
4360           'nick_name' => 1,
4361           'first_name' => 1,
4362           'middle_name' => 1,
4363           'last_name' => 1,
4364           'prefix_id' => 1,
4365           'suffix_id' => 1,
4366           'formal_title' => 1,
4367           'communication_style_id' => 1,
4368           'birth_date' => 1,
4369           'gender_id' => 1,
4370           'street_address' => 1,
4371           'supplemental_address_1' => 1,
4372           'supplemental_address_2' => 1,
4373           'supplemental_address_3' => 1,
4374           'city' => 1,
4375           'postal_code' => 1,
4376           'postal_code_suffix' => 1,
4377           'state_province' => 1,
4378           'country' => 1,
4379           'world_region' => 1,
4380           'geo_code_1' => 1,
4381           'geo_code_2' => 1,
4382           'email' => 1,
4383           'on_hold' => 1,
4384           'phone' => 1,
4385           'im' => 1,
4386           'household_name' => 1,
4387           'organization_name' => 1,
4388           'deceased_date' => 1,
4389           'is_deceased' => 1,
4390           'job_title' => 1,
4391           'legal_name' => 1,
4392           'sic_code' => 1,
4393           'current_employer' => 1,
4394           // FIXME: should we use defaultHierReturnProperties() for the below?
4395           'do_not_email' => 1,
4396           'do_not_mail' => 1,
4397           'do_not_sms' => 1,
4398           'do_not_phone' => 1,
4399           'do_not_trade' => 1,
4400           'is_opt_out' => 1,
4401           'contact_is_deleted' => 1,
4402           'preferred_communication_method' => 1,
4403           'preferred_language' => 1,
4404         );
4405       }
4406     }
4407     return self::$_defaultReturnProperties[$mode];
4408   }
4409
4410   /**
4411    * Get primary condition for a sql clause.
4412    *
4413    * @param int $value
4414    *
4415    * @return string|NULL
4416    */
4417   public static function getPrimaryCondition($value) {
4418     if (is_numeric($value)) {
4419       $value = (int ) $value;
4420       return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0';
4421     }
4422     return NULL;
4423   }
4424
4425   /**
4426    * Wrapper for a simple search query.
4427    *
4428    * @param array $params
4429    * @param array $returnProperties
4430    * @param bool $count
4431    *
4432    * @return string
4433    */
4434   public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4435     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4436     list($select, $from, $where, $having) = $query->query();
4437     $groupBy = ($query->_useGroupBy) ? 'GROUP BY contact_a.id' : '';
4438
4439     $query = "$select $from $where $groupBy $having";
4440     return $query;
4441   }
4442
4443   /**
4444    * These are stub comments as this function needs more explanation - particularly in terms of how it
4445    * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4446    *
4447    * This function was originally written as a wrapper for the api query but is called from multiple places
4448    * in the core code directly so the name is misleading. This function does not use the searchQuery function
4449    * but it is unclear as to whehter that is historical or there is a reason
4450    *  CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4451    *
4452    * @param array $params
4453    * @param array $returnProperties
4454    * @param null $fields
4455    * @param string $sort
4456    * @param int $offset
4457    * @param int $row_count
4458    * @param bool $smartGroupCache
4459    *   ?? update smart group cache?.
4460    * @param bool $count
4461    *   Return count obnly.
4462    * @param bool $skipPermissions
4463    *   Should permissions be ignored or should the logged in user's permissions be applied.
4464    * @param int $mode
4465    *   This basically correlates to the component.
4466    * @param string $apiEntity
4467    *   The api entity being called.
4468    *   This sort-of duplicates $mode in a confusing way. Probably not by design.
4469    *
4470    * @param bool|null $primaryLocationOnly
4471    * @return array
4472    */
4473   public static function apiQuery(
4474     $params = NULL,
4475     $returnProperties = NULL,
4476     $fields = NULL,
4477     $sort = NULL,
4478     $offset = 0,
4479     $row_count = 25,
4480     $smartGroupCache = TRUE,
4481     $count = FALSE,
4482     $skipPermissions = TRUE,
4483     $mode = CRM_Contact_BAO_Query::MODE_CONTACTS,
4484     $apiEntity = NULL,
4485     $primaryLocationOnly = NULL
4486   ) {
4487
4488     $query = new CRM_Contact_BAO_Query(
4489       $params, $returnProperties,
4490       NULL, TRUE, FALSE, $mode,
4491       $skipPermissions,
4492       TRUE, $smartGroupCache,
4493       NULL, 'AND',
4494       $apiEntity, $primaryLocationOnly
4495     );
4496
4497     //this should add a check for view deleted if permissions are enabled
4498     if ($skipPermissions) {
4499       $query->_skipDeleteClause = TRUE;
4500     }
4501     $query->generatePermissionClause(FALSE, $count);
4502
4503     // note : this modifies _fromClause and _simpleFromClause
4504     $query->includePseudoFieldsJoin($sort);
4505
4506     list($select, $from, $where, $having) = $query->query($count);
4507
4508     $options = $query->_options;
4509     if (!empty($query->_permissionWhereClause)) {
4510       if (empty($where)) {
4511         $where = "WHERE $query->_permissionWhereClause";
4512       }
4513       else {
4514         $where = "$where AND $query->_permissionWhereClause";
4515       }
4516     }
4517
4518     $sql = "$select $from $where $having";
4519
4520     // add group by only when API action is not getcount
4521     //  otherwise query fetches incorrect count
4522     if ($query->_useGroupBy && !$count) {
4523       $sql .= self::getGroupByFromSelectColumns($query->_select, 'contact_a.id');
4524     }
4525     if (!empty($sort)) {
4526       $sort = CRM_Utils_Type::escape($sort, 'String');
4527       $sql .= " ORDER BY $sort ";
4528     }
4529     if ($row_count > 0 && $offset >= 0) {
4530       $offset = CRM_Utils_Type::escape($offset, 'Int');
4531       $row_count = CRM_Utils_Type::escape($row_count, 'Int');
4532       $sql .= " LIMIT $offset, $row_count ";
4533     }
4534
4535     $dao = CRM_Core_DAO::executeQuery($sql);
4536
4537     // @todo derive this from the component class rather than hard-code two options.
4538     $entityIDField = ($mode == CRM_Contact_BAO_Query::MODE_CONTRIBUTE) ? 'contribution_id' : 'contact_id';
4539
4540     $values = array();
4541     while ($dao->fetch()) {
4542       if ($count) {
4543         $noRows = $dao->rowCount;
4544         $dao->free();
4545         return array($noRows, NULL);
4546       }
4547       $val = $query->store($dao);
4548       $convertedVals = $query->convertToPseudoNames($dao, TRUE, TRUE);
4549
4550       if (!empty($convertedVals)) {
4551         $val = array_replace_recursive($val, $convertedVals);
4552       }
4553       $values[$dao->$entityIDField] = $val;
4554     }
4555     $dao->free();
4556     return array($values, $options);
4557   }
4558
4559   /**
4560    * Get the actual custom field name by stripping off the appended string.
4561    *
4562    * The string could be _relative, _from, or _to
4563    *
4564    * @todo use metadata rather than convention to do this.
4565    *
4566    * @param string $parameterName
4567    *   The name of the parameter submitted to the form.
4568    *   e.g
4569    *   custom_3_relative
4570    *   custom_3_from
4571    *
4572    * @return string
4573    */
4574   public static function getCustomFieldName($parameterName) {
4575     if (substr($parameterName, -5, 5) == '_from') {
4576       return substr($parameterName, 0, strpos($parameterName, '_from'));
4577     }
4578     if (substr($parameterName, -9, 9) == '_relative') {
4579       return substr($parameterName, 0, strpos($parameterName, '_relative'));
4580     }
4581     if (substr($parameterName, -3, 3) == '_to') {
4582       return substr($parameterName, 0, strpos($parameterName, '_to'));
4583     }
4584   }
4585
4586   /**
4587    * Convert submitted values for relative custom fields to query object format.
4588    *
4589    * The query will support the sqlOperator format so convert to that format.
4590    *
4591    * @param array $formValues
4592    *   Submitted values.
4593    * @param array $params
4594    *   Converted parameters for the query object.
4595    * @param string $values
4596    *   Submitted value.
4597    * @param string $fieldName
4598    *   Submitted field name. (Matches form field not DB field.)
4599    */
4600   protected static function convertCustomRelativeFields(&$formValues, &$params, $values, $fieldName) {
4601     if (empty($values)) {
4602       // e.g we might have relative set & from & to empty. The form flow is a bit funky &
4603       // this function gets called again after they fields have been converted which can get ugly.
4604       return;
4605     }
4606     $customFieldName = self::getCustomFieldName($fieldName);
4607
4608     if (substr($fieldName, -9, 9) == '_relative') {
4609       list($from, $to) = CRM_Utils_Date::getFromTo($values, NULL, NULL);
4610     }
4611     else {
4612       if ($fieldName == $customFieldName . '_to' && CRM_Utils_Array::value($customFieldName . '_from', $formValues)) {
4613         // Both to & from are set. We only need to acton one, choosing from.
4614         return;
4615       }
4616
4617       $from = CRM_Utils_Array::value($customFieldName . '_from', $formValues, NULL);
4618       $to = CRM_Utils_Array::value($customFieldName . '_to', $formValues, NULL);
4619
4620       if (self::isCustomDateField($customFieldName)) {
4621         list($from, $to) = CRM_Utils_Date::getFromTo(NULL, $from, $to);
4622       }
4623     }
4624
4625     if ($from) {
4626       if ($to) {
4627         $relativeFunction = array('BETWEEN' => array($from, $to));
4628       }
4629       else {
4630         $relativeFunction = array('>=' => $from);
4631       }
4632     }
4633     else {
4634       $relativeFunction = array('<=' => $to);
4635     }
4636     $params[] = array(
4637       $customFieldName,
4638       '=',
4639       $relativeFunction,
4640       0,
4641       0,
4642     );
4643   }
4644
4645   /**
4646    * Are we dealing with custom field of type date.
4647    *
4648    * @param $fieldName
4649    *
4650    * @return bool
4651    */
4652   public static function isCustomDateField($fieldName) {
4653     if (($customFieldID = CRM_Core_BAO_CustomField::getKeyID($fieldName)) == FALSE) {
4654       return FALSE;
4655     }
4656     if ('Date' == civicrm_api3('CustomField', 'getvalue', array('id' => $customFieldID, 'return' => 'data_type'))) {
4657       return TRUE;
4658     }
4659     return FALSE;
4660   }
4661
4662   /**
4663    * Has this field already been reformatting to Query object syntax.
4664    *
4665    * The form layer passed formValues to this function in preProcess & postProcess. Reason unknown. This seems
4666    * to come with associated double queries & is possibly damaging performance.
4667    *
4668    * However, here we add a tested function to ensure convertFormValues identifies pre-processed fields & returns
4669    * them as they are.
4670    *
4671    * @param mixed $values
4672    *   Value in formValues for the field.
4673    *
4674    * @return bool;
4675    */
4676   public static function isAlreadyProcessedForQueryFormat($values) {
4677     if (!is_array($values)) {
4678       return FALSE;
4679     }
4680     if (($operator = CRM_Utils_Array::value(1, $values)) == FALSE) {
4681       return FALSE;
4682     }
4683     return in_array($operator, CRM_Core_DAO::acceptedSQLOperators());
4684   }
4685
4686   /**
4687    * If the state and country are passed remove state.
4688    *
4689    * Country is implicit from the state, but including both results in
4690    * a poor query as there is no combined index on state AND country.
4691    *
4692    * CRM-18125
4693    *
4694    * @param array $formValues
4695    */
4696   public static function filterCountryFromValuesIfStateExists(&$formValues) {
4697     if (!empty($formValues['country']) && !empty($formValues['state_province'])) {
4698       // The use of array map sanitises the data by ensuring we are dealing with integers.
4699       $states = implode(', ', array_map('intval', $formValues['state_province']));
4700       $countryList = CRM_Core_DAO::singleValueQuery(
4701         "SELECT GROUP_CONCAT(country_id) FROM civicrm_state_province WHERE id IN ($states)"
4702       );
4703       if ($countryList == $formValues['country']) {
4704         unset($formValues['country']);
4705       }
4706     }
4707   }
4708
4709   /**
4710    * For some special cases, grouping by subset of select fields becomes mandatory.
4711    * Hence, full_group_by mode is handled by appending any_value
4712    * keyword to select fields not present in groupBy
4713    *
4714    * @param array $selectClauses
4715    * @param array $groupBy - Columns already included in GROUP By clause.
4716    * @param string $aggregateFunction
4717    *
4718    * @return string
4719    */
4720   public static function appendAnyValueToSelect($selectClauses, $groupBy, $aggregateFunction = 'ANY_VALUE') {
4721     if (!CRM_Utils_SQL::disableFullGroupByMode()) {
4722       $groupBy = array_map('trim', (array) $groupBy);
4723       $aggregateFunctions = '/(ROUND|AVG|COUNT|GROUP_CONCAT|SUM|MAX|MIN|IF)[[:blank:]]*\(/i';
4724       foreach ($selectClauses as $key => &$val) {
4725         list($selectColumn, $alias) = array_pad(preg_split('/ as /i', $val), 2, NULL);
4726         // append ANY_VALUE() keyword
4727         if (!in_array($selectColumn, $groupBy) && preg_match($aggregateFunctions, trim($selectColumn)) !== 1) {
4728           $val = ($aggregateFunction == 'GROUP_CONCAT') ?
4729             str_replace($selectColumn, "$aggregateFunction(DISTINCT {$selectColumn})", $val) :
4730             str_replace($selectColumn, "$aggregateFunction({$selectColumn})", $val);
4731         }
4732       }
4733     }
4734
4735     return "SELECT " . implode(', ', $selectClauses) . " ";
4736   }
4737
4738   /**
4739    * For some special cases, where if non-aggregate ORDER BY columns are not present in GROUP BY
4740    *  on full_group_by mode, then append the those missing columns to GROUP BY clause
4741    * keyword to select fields not present in groupBy
4742    *
4743    * @param string $groupBy - GROUP BY clause where missing ORDER BY columns will be appended if not present
4744    * @param array $orderBys - ORDER BY sub-clauses
4745    *
4746    */
4747   public static function getGroupByFromOrderBy(&$groupBy, $orderBys) {
4748     if (!CRM_Utils_SQL::disableFullGroupByMode()) {
4749       foreach ($orderBys as $orderBy) {
4750         $orderBy = str_ireplace(array(' DESC', ' ASC', '`'), '', $orderBy); // remove sort syntax from ORDER BY clauses if present
4751         // if ORDER BY column is not present in GROUP BY then append it to end
4752         if (preg_match('/(MAX|MIN)\(/i', trim($orderBy)) !== 1 && !strstr($groupBy, $orderBy)) {
4753           $groupBy .= ", {$orderBy}";
4754         }
4755       }
4756     }
4757   }
4758
4759   /**
4760    * Include Select columns in groupBy clause.
4761    *
4762    * @param array $selectClauses
4763    * @param array $groupBy - Columns already included in GROUP By clause.
4764    *
4765    * @return string
4766    */
4767   public static function getGroupByFromSelectColumns($selectClauses, $groupBy = NULL) {
4768     $groupBy = (array) $groupBy;
4769     $mysqlVersion = CRM_Core_DAO::singleValueQuery('SELECT VERSION()');
4770     $sqlMode = CRM_Core_DAO::singleValueQuery('SELECT @@sql_mode');
4771
4772     //return if ONLY_FULL_GROUP_BY is not enabled.
4773     if (CRM_Utils_SQL::supportsFullGroupBy() && !empty($sqlMode) && in_array('ONLY_FULL_GROUP_BY', explode(',', $sqlMode))) {
4774       $regexToExclude = '/(ROUND|AVG|COUNT|GROUP_CONCAT|SUM|MAX|MIN|IF)[[:blank:]]*\(/i';
4775       foreach ($selectClauses as $key => $val) {
4776         $aliasArray = preg_split('/ as /i', $val);
4777         // if more than 1 alias we need to split by ','.
4778         if (count($aliasArray) > 2) {
4779           $aliasArray = preg_split('/,/', $val);
4780           foreach ($aliasArray as $key => $value) {
4781             $alias = current(preg_split('/ as /i', $value));
4782             if (!in_array($alias, $groupBy) && preg_match($regexToExclude, trim($alias)) !== 1) {
4783               $groupBy[] = $alias;
4784             }
4785           }
4786         }
4787         else {
4788           list($selectColumn, $alias) = array_pad($aliasArray, 2, NULL);
4789           $dateRegex = '/^(DATE_FORMAT|DATE_ADD|CASE)/i';
4790           $tableName = current(explode('.', $selectColumn));
4791           $primaryKey = "{$tableName}.id";
4792           // exclude columns which are already included in groupBy and aggregate functions from select
4793           // CRM-18439 - Also exclude the columns which are functionally dependent on columns in $groupBy (MySQL 5.7+)
4794           if (!in_array($selectColumn, $groupBy) && !in_array($primaryKey, $groupBy) && preg_match($regexToExclude, trim($selectColumn)) !== 1) {
4795             if (!empty($alias) && preg_match($dateRegex, trim($selectColumn))) {
4796               $groupBy[] = $alias;
4797             }
4798             else {
4799               $groupBy[] = $selectColumn;
4800             }
4801           }
4802         }
4803       }
4804     }
4805
4806     if (!empty($groupBy)) {
4807       return " GROUP BY " . implode(', ', $groupBy);
4808     }
4809     return '';
4810   }
4811
4812   /**
4813    * Create and query the db for an contact search.
4814    *
4815    * @param int $offset
4816    *   The offset for the query.
4817    * @param int $rowCount
4818    *   The number of rows to return.
4819    * @param string|CRM_Utils_Sort $sort
4820    *   The order by string.
4821    * @param bool $count
4822    *   Is this a count only query ?.
4823    * @param bool $includeContactIds
4824    *   Should we include contact ids?.
4825    * @param bool $sortByChar
4826    *   If true returns the distinct array of first characters for search results.
4827    * @param bool $groupContacts
4828    *   If true, return only the contact ids.
4829    * @param bool $returnQuery
4830    *   Should we return the query as a string.
4831    * @param string $additionalWhereClause
4832    *   If the caller wants to further restrict the search (used for components).
4833    * @param null $sortOrder
4834    * @param string $additionalFromClause
4835    *   Should be clause with proper joins, effective to reduce where clause load.
4836    *
4837    * @param bool $skipOrderAndLimit
4838    *
4839    * @return CRM_Core_DAO
4840    */
4841   public function searchQuery(
4842     $offset = 0, $rowCount = 0, $sort = NULL,
4843     $count = FALSE, $includeContactIds = FALSE,
4844     $sortByChar = FALSE, $groupContacts = FALSE,
4845     $returnQuery = FALSE,
4846     $additionalWhereClause = NULL, $sortOrder = NULL,
4847     $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4848   ) {
4849
4850     if ($includeContactIds) {
4851       $this->_includeContactIds = TRUE;
4852       $this->_whereClause = $this->whereClause();
4853     }
4854
4855     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4856
4857     // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4858     // and that contact happens to be deleted, set $onlyDeleted to true
4859     foreach ($this->_params as $values) {
4860       $name = CRM_Utils_Array::value(0, $values);
4861       $op = CRM_Utils_Array::value(1, $values);
4862       $value = CRM_Utils_Array::value(2, $values);
4863       if ($name == 'contact_id' and $op == '=') {
4864         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4865           $onlyDeleted = TRUE;
4866         }
4867         break;
4868       }
4869     }
4870
4871     // building the query string
4872     $groupBy = $groupByCols = NULL;
4873     if (!$count) {
4874       if (isset($this->_groupByComponentClause)) {
4875         $groupBy = $this->_groupByComponentClause;
4876         $groupByCols = preg_replace('/^GROUP BY /', '', trim($this->_groupByComponentClause));
4877         $groupByCols = explode(', ', $groupByCols);
4878       }
4879       elseif ($this->_useGroupBy) {
4880         $groupByCols = array('contact_a.id');
4881       }
4882     }
4883     if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) {
4884       $groupByCols = array('civicrm_activity.id');
4885     }
4886
4887     $order = $orderBy = $limit = '';
4888     if (!$count) {
4889       list($order, $additionalFromClause) = $this->prepareOrderBy($sort, $sortByChar, $sortOrder, $additionalFromClause);
4890
4891       if ($rowCount > 0 && $offset >= 0) {
4892         $offset = CRM_Utils_Type::escape($offset, 'Int');
4893         $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
4894         $limit = " LIMIT $offset, $rowCount ";
4895       }
4896     }
4897     // Two cases where we are disabling FGB (FULL_GROUP_BY_MODE):
4898     //   1. Expecting the search query to return all the first single letter characters of contacts ONLY, but when FGB is enabled
4899     //      MySQL expect the columns present in GROUP BY, must be present in SELECT clause and that results into error, needless to have other columns.
4900     //   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
4901     //     clause. This will impact the search query output.
4902     $disableFullGroupByMode = ($sortByChar || !empty($groupByCols));
4903
4904     if ($disableFullGroupByMode) {
4905       CRM_Core_DAO::disableFullGroupByMode();
4906     }
4907
4908     // CRM-15231
4909     $this->_sort = $sort;
4910
4911     //CRM-15967
4912     $this->includePseudoFieldsJoin($sort);
4913
4914     list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4915
4916     if (!empty($groupByCols)) {
4917       $groupBy = " GROUP BY " . implode(', ', $groupByCols);
4918     }
4919
4920     if ($additionalWhereClause) {
4921       $where = $where . ' AND ' . $additionalWhereClause;
4922     }
4923
4924     //additional from clause should be w/ proper joins.
4925     if ($additionalFromClause) {
4926       $from .= "\n" . $additionalFromClause;
4927     }
4928
4929     // if we are doing a transform, do it here
4930     // use the $from, $where and $having to get the contact ID
4931     if ($this->_displayRelationshipType) {
4932       $this->filterRelatedContacts($from, $where, $having);
4933     }
4934
4935     if ($skipOrderAndLimit) {
4936       $query = "$select $from $where $having $groupBy";
4937     }
4938     else {
4939       $query = "$select $from $where $having $groupBy $order $limit";
4940     }
4941
4942     if ($returnQuery) {
4943       return $query;
4944     }
4945     if ($count) {
4946       return CRM_Core_DAO::singleValueQuery($query);
4947     }
4948
4949     $dao = CRM_Core_DAO::executeQuery($query);
4950
4951     if ($disableFullGroupByMode) {
4952       CRM_Core_DAO::reenableFullGroupByMode();
4953     }
4954
4955     if ($groupContacts) {
4956       $ids = array();
4957       while ($dao->fetch()) {
4958         $ids[] = $dao->id;
4959       }
4960       $dao->free();
4961       return implode(',', $ids);
4962     }
4963
4964     return $dao;
4965   }
4966
4967   /**
4968    * Fetch a list of contacts from the prev/next cache for displaying a search results page
4969    *
4970    * @param string $cacheKey
4971    * @param int $offset
4972    * @param int $rowCount
4973    * @param bool $includeContactIds
4974    * @return CRM_Core_DAO
4975    */
4976   public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4977     $this->_includeContactIds = $includeContactIds;
4978     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4979     list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
4980     $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);
4981     $order = " ORDER BY pnc.id";
4982     $groupByCol = array('contact_a.id', 'pnc.id');
4983     $select = self::appendAnyValueToSelect($this->_select, $groupByCol, 'GROUP_CONCAT');
4984     $groupBy = " GROUP BY " . implode(', ', $groupByCol);
4985     $limit = " LIMIT $offset, $rowCount";
4986     $query = "$select $from $where $groupBy $order $limit";
4987
4988     return CRM_Core_DAO::executeQuery($query);
4989   }
4990
4991   /**
4992    * Populate $this->_permissionWhereClause with permission related clause and update other
4993    * query related properties.
4994    *
4995    * Function calls ACL permission class and hooks to filter the query appropriately
4996    *
4997    * Note that these 2 params were in the code when extracted from another function
4998    * and a second round extraction would be to make them properties of the class
4999    *
5000    * @param bool $onlyDeleted
5001    *   Only get deleted contacts.
5002    * @param bool $count
5003    *   Return Count only.
5004    */
5005   public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
5006     if (!$this->_skipPermission) {
5007       $this->_permissionWhereClause = CRM_ACL_API::whereClause(
5008         CRM_Core_Permission::VIEW,
5009         $this->_tables,
5010         $this->_whereTables,
5011         NULL,
5012         $onlyDeleted,
5013         $this->_skipDeleteClause
5014       );
5015
5016       // regenerate fromClause since permission might have added tables
5017       if ($this->_permissionWhereClause) {
5018         //fix for row count in qill (in contribute/membership find)
5019         if (!$count) {
5020           $this->_useDistinct = TRUE;
5021         }
5022         //CRM-15231
5023         $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
5024         $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
5025         // note : this modifies _fromClause and _simpleFromClause
5026         $this->includePseudoFieldsJoin($this->_sort);
5027       }
5028     }
5029     else {
5030       // add delete clause if needed even if we are skipping permission
5031       // CRM-7639
5032       if (!$this->_skipDeleteClause) {
5033         if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
5034           $this->_permissionWhereClause = '(contact_a.is_deleted)';
5035         }
5036         else {
5037           // CRM-6181
5038           $this->_permissionWhereClause = '(contact_a.is_deleted = 0)';
5039         }
5040       }
5041     }
5042   }
5043
5044   /**
5045    * @param $val
5046    */
5047   public function setSkipPermission($val) {
5048     $this->_skipPermission = $val;
5049   }
5050
5051   /**
5052    * @param null $context
5053    *
5054    * @return array
5055    */
5056   public function &summaryContribution($context = NULL) {
5057     list($innerselect, $from, $where, $having) = $this->query(TRUE);
5058
5059     // hack $select
5060     $select = "
5061 SELECT COUNT( conts.total_amount ) as total_count,
5062        SUM(   conts.total_amount ) as total_amount,
5063        AVG(   conts.total_amount ) as total_avg,
5064        conts.currency              as currency";
5065     if ($this->_permissionWhereClause) {
5066       $where .= " AND " . $this->_permissionWhereClause;
5067     }
5068     if ($context == 'search') {
5069       $where .= " AND contact_a.is_deleted = 0 ";
5070     }
5071
5072     $query = $this->appendFinancialTypeWhereAndFromToQueryStrings($where, $from);
5073
5074     // make sure contribution is completed - CRM-4989
5075     $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
5076
5077     $summary = array();
5078     $summary['total'] = array();
5079     $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
5080     $innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,
5081       civicrm_contribution.currency $from $completedWhere";
5082     $query = "$select FROM (
5083       $innerQuery GROUP BY civicrm_contribution.id
5084     ) as conts
5085     GROUP BY currency";
5086
5087     $dao = CRM_Core_DAO::executeQuery($query);
5088
5089     $summary['total']['count'] = 0;
5090     $summary['total']['amount'] = $summary['total']['avg'] = array();
5091     while ($dao->fetch()) {
5092       $summary['total']['count'] += $dao->total_count;
5093       $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
5094       $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
5095     }
5096
5097     $orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
5098     $groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
5099     $modeSQL = "$select, SUBSTRING_INDEX(GROUP_CONCAT(conts.total_amount
5100       ORDER BY conts.civicrm_contribution_total_amount_count DESC SEPARATOR ';'), ';', 1) as amount,
5101       MAX(conts.civicrm_contribution_total_amount_count) as civicrm_contribution_total_amount_count
5102       FROM ($innerQuery
5103       $groupBy $orderBy) as conts
5104       GROUP BY currency";
5105
5106     $summary['total']['mode'] = CRM_Contribute_BAO_Contribution::computeStats('mode', $modeSQL);
5107
5108     $medianSQL = "{$from} {$completedWhere}";
5109     $summary['total']['median'] = CRM_Contribute_BAO_Contribution::computeStats('median', $medianSQL, 'civicrm_contribution');
5110     $summary['total']['currencyCount'] = count($summary['total']['median']);
5111
5112     if (!empty($summary['total']['amount'])) {
5113       $summary['total']['amount'] = implode(',&nbsp;', $summary['total']['amount']);
5114       $summary['total']['avg'] = implode(',&nbsp;', $summary['total']['avg']);
5115       $summary['total']['mode'] = implode(',&nbsp;', $summary['total']['mode']);
5116       $summary['total']['median'] = implode(',&nbsp;', $summary['total']['median']);
5117     }
5118     else {
5119       $summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
5120     }
5121
5122     // soft credit summary
5123     if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
5124       $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
5125       $query = "
5126         $select FROM (
5127           SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
5128           GROUP BY civicrm_contribution_soft.id
5129         ) as conts
5130         GROUP BY currency";
5131       $dao = CRM_Core_DAO::executeQuery($query);
5132       $summary['soft_credit']['count'] = 0;
5133       $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
5134       while ($dao->fetch()) {
5135         $summary['soft_credit']['count'] += $dao->total_count;
5136         $summary['soft_credit']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
5137         $summary['soft_credit']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
5138       }
5139       if (!empty($summary['soft_credit']['amount'])) {
5140         $summary['soft_credit']['amount'] = implode(',&nbsp;', $summary['soft_credit']['amount']);
5141         $summary['soft_credit']['avg'] = implode(',&nbsp;', $summary['soft_credit']['avg']);
5142       }
5143       else {
5144         $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
5145       }
5146     }
5147
5148     // hack $select
5149     //@todo  - this could be one query using the IF in mysql - eg
5150     //  SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
5151     //   SELECT civicrm_contribution.total_amount, civicrm_contribution.currency  ,
5152     //  IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
5153     //  IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
5154     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
5155     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
5156     // FROM civicrm_contact contact_a
5157     //  LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
5158     // WHERE  ( ... where clause....
5159     // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
5160     //  ) as conts
5161
5162     $select = "
5163 SELECT COUNT( conts.total_amount ) as cancel_count,
5164        SUM(   conts.total_amount ) as cancel_amount,
5165        AVG(   conts.total_amount ) as cancel_avg,
5166        conts.currency              as currency";
5167
5168     $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
5169     if ($context == 'search') {
5170       $where .= " AND contact_a.is_deleted = 0 ";
5171     }
5172
5173     $query = "$select FROM (
5174       SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
5175       GROUP BY civicrm_contribution.id
5176     ) as conts
5177     GROUP BY currency";
5178
5179     $dao = CRM_Core_DAO::executeQuery($query);
5180
5181     if ($dao->N <= 1) {
5182       if ($dao->fetch()) {
5183         $summary['cancel']['count'] = $dao->cancel_count;
5184         $summary['cancel']['amount'] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
5185         $summary['cancel']['avg'] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
5186       }
5187     }
5188     else {
5189       $summary['cancel']['count'] = 0;
5190       $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
5191       while ($dao->fetch()) {
5192         $summary['cancel']['count'] += $dao->cancel_count;
5193         $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
5194         $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
5195       }
5196       $summary['cancel']['amount'] = implode(',&nbsp;', $summary['cancel']['amount']);
5197       $summary['cancel']['avg'] = implode(',&nbsp;', $summary['cancel']['avg']);
5198     }
5199
5200     return $summary;
5201   }
5202
5203   /**
5204    * Append financial ACL limits to the query from & where clauses, if applicable.
5205    *
5206    * @param string $where
5207    * @param string $from
5208    */
5209   public function appendFinancialTypeWhereAndFromToQueryStrings(&$where, &$from) {
5210     if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
5211       return;
5212     }
5213     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
5214     if (!empty($financialTypes)) {
5215       $where .= " AND civicrm_contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ") AND li.id IS NULL";
5216       $from .= " LEFT JOIN civicrm_line_item li
5217                   ON civicrm_contribution.id = li.contribution_id AND
5218                      li.entity_table = 'civicrm_contribution' AND li.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ") ";
5219     }
5220     else {
5221       $where .= " AND civicrm_contribution.financial_type_id IN (0)";
5222     }
5223   }
5224
5225   /**
5226    * Getter for the qill object.
5227    *
5228    * @return string
5229    */
5230   public function qill() {
5231     return $this->_qill;
5232   }
5233
5234   /**
5235    * Default set of return default hier return properties.
5236    *
5237    * @return array
5238    */
5239   public static function &defaultHierReturnProperties() {
5240     if (!isset(self::$_defaultHierReturnProperties)) {
5241       self::$_defaultHierReturnProperties = array(
5242         'home_URL' => 1,
5243         'image_URL' => 1,
5244         'legal_identifier' => 1,
5245         'external_identifier' => 1,
5246         'contact_type' => 1,
5247         'contact_sub_type' => 1,
5248         'sort_name' => 1,
5249         'display_name' => 1,
5250         'nick_name' => 1,
5251         'first_name' => 1,
5252         'middle_name' => 1,
5253         'last_name' => 1,
5254         'prefix_id' => 1,
5255         'suffix_id' => 1,
5256         'formal_title' => 1,
5257         'communication_style_id' => 1,
5258         'email_greeting' => 1,
5259         'postal_greeting' => 1,
5260         'addressee' => 1,
5261         'birth_date' => 1,
5262         'gender_id' => 1,
5263         'preferred_communication_method' => 1,
5264         'do_not_phone' => 1,
5265         'do_not_email' => 1,
5266         'do_not_mail' => 1,
5267         'do_not_sms' => 1,
5268         'do_not_trade' => 1,
5269         'location' => array(
5270           '1' => array(
5271             'location_type' => 1,
5272             'street_address' => 1,
5273             'city' => 1,
5274             'state_province' => 1,
5275             'postal_code' => 1,
5276             'postal_code_suffix' => 1,
5277             'country' => 1,
5278             'phone-Phone' => 1,
5279             'phone-Mobile' => 1,
5280             'phone-Fax' => 1,
5281             'phone-1' => 1,
5282             'phone-2' => 1,
5283             'phone-3' => 1,
5284             'im-1' => 1,
5285             'im-2' => 1,
5286             'im-3' => 1,
5287             'email-1' => 1,
5288             'email-2' => 1,
5289             'email-3' => 1,
5290           ),
5291           '2' => array(
5292             'location_type' => 1,
5293             'street_address' => 1,
5294             'city' => 1,
5295             'state_province' => 1,
5296             'postal_code' => 1,
5297             'postal_code_suffix' => 1,
5298             'country' => 1,
5299             'phone-Phone' => 1,
5300             'phone-Mobile' => 1,
5301             'phone-1' => 1,
5302             'phone-2' => 1,
5303             'phone-3' => 1,
5304             'im-1' => 1,
5305             'im-2' => 1,
5306             'im-3' => 1,
5307             'email-1' => 1,
5308             'email-2' => 1,
5309             'email-3' => 1,
5310           ),
5311         ),
5312       );
5313     }
5314     return self::$_defaultHierReturnProperties;
5315   }
5316
5317   /**
5318    * Build query for a date field.
5319    *
5320    * @param array $values
5321    * @param string $tableName
5322    * @param string $fieldName
5323    * @param string $dbFieldName
5324    * @param string $fieldTitle
5325    * @param bool $appendTimeStamp
5326    * @param string $dateFormat
5327    */
5328   public function dateQueryBuilder(
5329     &$values, $tableName, $fieldName,
5330     $dbFieldName, $fieldTitle,
5331     $appendTimeStamp = TRUE,
5332     $dateFormat = 'YmdHis'
5333   ) {
5334     list($name, $op, $value, $grouping, $wildcard) = $values;
5335
5336     if ($name == "{$fieldName}_low" ||
5337       $name == "{$fieldName}_high"
5338     ) {
5339       if (isset($this->_rangeCache[$fieldName]) || !$value) {
5340         return;
5341       }
5342       $this->_rangeCache[$fieldName] = 1;
5343
5344       $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
5345
5346       if ($name == $fieldName . '_low') {
5347         $firstOP = '>=';
5348         $firstPhrase = ts('greater than or equal to');
5349         $firstDate = CRM_Utils_Date::processDate($value, NULL, FALSE, $dateFormat);
5350
5351         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5352         if (!empty($secondValues) && $secondValues[2]) {
5353           $secondOP = '<=';
5354           $secondPhrase = ts('less than or equal to');
5355           $secondValue = $secondValues[2];
5356
5357           if ($appendTimeStamp && strlen($secondValue) == 10) {
5358             $secondValue .= ' 23:59:59';
5359           }
5360           $secondDate = CRM_Utils_Date::processDate($secondValue, NULL, FALSE, $dateFormat);
5361         }
5362       }
5363       elseif ($name == $fieldName . '_high') {
5364         $firstOP = '<=';
5365         $firstPhrase = ts('less than or equal to');
5366
5367         if ($appendTimeStamp && strlen($value) == 10) {
5368           $value .= ' 23:59:59';
5369         }
5370         $firstDate = CRM_Utils_Date::processDate($value, NULL, FALSE, $dateFormat);
5371
5372         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5373         if (!empty($secondValues) && $secondValues[2]) {
5374           $secondOP = '>=';
5375           $secondPhrase = ts('greater than or equal to');
5376           $secondValue = $secondValues[2];
5377           $secondDate = CRM_Utils_Date::processDate($secondValue, NULL, FALSE, $dateFormat);
5378         }
5379       }
5380
5381       if (!$appendTimeStamp) {
5382         $firstDate = substr($firstDate, 0, 8);
5383       }
5384       $firstDateFormat = CRM_Utils_Date::customFormat($firstDate);
5385
5386       if ($secondDate) {
5387         if (!$appendTimeStamp) {
5388           $secondDate = substr($secondDate, 0, 8);
5389         }
5390         $secondDateFormat = CRM_Utils_Date::customFormat($secondDate);
5391       }
5392
5393       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5394       if ($secondDate) {
5395         $this->_where[$grouping][] = "
5396 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5397 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5398 ";
5399         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
5400       }
5401       else {
5402         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5403         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
5404       }
5405     }
5406
5407     if ($name == $fieldName) {
5408       //In Get API, for operators other then '=' the $value is in array(op => value) format
5409       if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5410         $op = key($value);
5411         $value = $value[$op];
5412       }
5413
5414       $date = $format = NULL;
5415       if (strstr($op, 'IN')) {
5416         $format = array();
5417         foreach ($value as &$date) {
5418           $date = CRM_Utils_Date::processDate($date, NULL, FALSE, $dateFormat);
5419           if (!$appendTimeStamp) {
5420             $date = substr($date, 0, 8);
5421           }
5422           $format[] = CRM_Utils_Date::customFormat($date);
5423         }
5424         $date = "('" . implode("','", $value) . "')";
5425         $format = implode(', ', $format);
5426       }
5427       elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5428         $date = CRM_Utils_Date::processDate($value, NULL, FALSE, $dateFormat);
5429         if (!$appendTimeStamp) {
5430           $date = substr($date, 0, 8);
5431         }
5432         $format = CRM_Utils_Date::customFormat($date);
5433         $date = "'$date'";
5434       }
5435
5436       if ($date) {
5437         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5438       }
5439       else {
5440         $this->_where[$grouping][] = self::buildClause("{$tableName}.{$dbFieldName}", $op);
5441       }
5442
5443       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5444
5445       $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
5446       $this->_qill[$grouping][] = "$fieldTitle $op $format";
5447     }
5448   }
5449
5450   /**
5451    * @param $values
5452    * @param string $tableName
5453    * @param string $fieldName
5454    * @param string $dbFieldName
5455    * @param $fieldTitle
5456    * @param null $options
5457    */
5458   public function numberRangeBuilder(
5459     &$values,
5460     $tableName, $fieldName,
5461     $dbFieldName, $fieldTitle,
5462     $options = NULL
5463   ) {
5464     list($name, $op, $value, $grouping, $wildcard) = $values;
5465
5466     if ($name == "{$fieldName}_low" ||
5467       $name == "{$fieldName}_high"
5468     ) {
5469       if (isset($this->_rangeCache[$fieldName])) {
5470         return;
5471       }
5472       $this->_rangeCache[$fieldName] = 1;
5473
5474       $secondOP = $secondPhrase = $secondValue = NULL;
5475
5476       if ($name == "{$fieldName}_low") {
5477         $firstOP = '>=';
5478         $firstPhrase = ts('greater than');
5479
5480         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5481         if (!empty($secondValues)) {
5482           $secondOP = '<=';
5483           $secondPhrase = ts('less than');
5484           $secondValue = $secondValues[2];
5485         }
5486       }
5487       else {
5488         $firstOP = '<=';
5489         $firstPhrase = ts('less than');
5490
5491         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5492         if (!empty($secondValues)) {
5493           $secondOP = '>=';
5494           $secondPhrase = ts('greater than');
5495           $secondValue = $secondValues[2];
5496         }
5497       }
5498
5499       if ($secondOP) {
5500         $this->_where[$grouping][] = "
5501 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5502 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5503 ";
5504         $displayValue = $options ? $options[$value] : $value;
5505         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5506
5507         $this->_qill[$grouping][]
5508           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5509       }
5510       else {
5511         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5512         $displayValue = $options ? $options[$value] : $value;
5513         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5514       }
5515       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5516
5517       return;
5518     }
5519
5520     if ($name == $fieldName) {
5521       $op = '=';
5522       $phrase = '=';
5523
5524       $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5525
5526       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5527       $displayValue = $options ? $options[$value] : $value;
5528       $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5529     }
5530   }
5531
5532
5533   /**
5534    * @param $values
5535    * @param string $tableName
5536    * @param string $fieldName
5537    * @param string $dbFieldName
5538    * @param $fieldTitle
5539    * @param null $options
5540    */
5541   public function ageRangeQueryBuilder(
5542     &$values,
5543     $tableName, $fieldName,
5544     $dbFieldName, $fieldTitle,
5545     $options = NULL
5546   ) {
5547     list($name, $op, $value, $grouping, $wildcard) = $values;
5548
5549     $asofDateValues = $this->getWhereValues("{$fieldName}_asof_date", $grouping);
5550     $asofDate = NULL;  // will be treated as current day
5551     if ($asofDateValues) {
5552       $asofDate = CRM_Utils_Date::processDate($asofDateValues[2]);
5553       $asofDateFormat = CRM_Utils_Date::customFormat(substr($asofDate, 0, 8));
5554       $fieldTitle .= ' ' . ts('as of') . ' ' . $asofDateFormat;
5555     }
5556
5557     if ($name == "{$fieldName}_low" ||
5558       $name == "{$fieldName}_high"
5559     ) {
5560       if (isset($this->_rangeCache[$fieldName])) {
5561         return;
5562       }
5563       $this->_rangeCache[$fieldName] = 1;
5564
5565       $secondOP = $secondPhrase = $secondValue = NULL;
5566
5567       if ($name == "{$fieldName}_low") {
5568         $firstPhrase = ts('greater than or equal to');
5569         // NB: age > X means date of birth < Y
5570         $firstOP = '<=';
5571         $firstDate = self::calcDateFromAge($asofDate, $value, 'min');
5572
5573         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5574         if (!empty($secondValues)) {
5575           $secondOP = '>=';
5576           $secondPhrase = ts('less than or equal to');
5577           $secondValue = $secondValues[2];
5578           $secondDate = self::calcDateFromAge($asofDate, $secondValue, 'max');
5579         }
5580       }
5581       else {
5582         $firstOP = '>=';
5583         $firstPhrase = ts('less than or equal to');
5584         $firstDate = self::calcDateFromAge($asofDate, $value, 'max');
5585
5586         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5587         if (!empty($secondValues)) {
5588           $secondOP = '<=';
5589           $secondPhrase = ts('greater than or equal to');
5590           $secondValue = $secondValues[2];
5591           $secondDate = self::calcDateFromAge($asofDate, $secondValue, 'min');
5592         }
5593       }
5594
5595       if ($secondOP) {
5596         $this->_where[$grouping][] = "
5597 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5598 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5599 ";
5600         $displayValue = $options ? $options[$value] : $value;
5601         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5602
5603         $this->_qill[$grouping][]
5604           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5605       }
5606       else {
5607         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5608         $displayValue = $options ? $options[$value] : $value;
5609         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5610       }
5611       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5612       return;
5613     }
5614   }
5615
5616   /**
5617    * Calculate date from age.
5618    *
5619    * @param string $asofDate
5620    * @param int $age
5621    * @param string $type
5622    *
5623    * @return string
5624    */
5625   public static function calcDateFromAge($asofDate, $age, $type) {
5626     $date = new DateTime($asofDate);
5627     if ($type == "min") {
5628       // minimum age is $age: dob <= date - age "235959"
5629       $date->sub(new DateInterval("P" . $age . "Y"));
5630       return $date->format('Ymd') . "235959";
5631     }
5632     else {
5633       // max age is $age: dob >= date - (age + 1y) + 1d "000000"
5634       $date->sub(new DateInterval("P" . ($age + 1) . "Y"))->add(new DateInterval("P1D"));
5635       return $date->format('Ymd') . "000000";
5636     }
5637   }
5638
5639   /**
5640    * Given the field name, operator, value & its data type
5641    * builds the where Clause for the query
5642    * used for handling 'IS NULL'/'IS NOT NULL' operators
5643    *
5644    * @param string $field
5645    *   Fieldname.
5646    * @param string $op
5647    *   Operator.
5648    * @param string $value
5649    *   Value.
5650    * @param string $dataType
5651    *   Data type of the field.
5652    *
5653    * @return string
5654    *   Where clause for the query.
5655    */
5656   public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5657     $op = trim($op);
5658     $clause = "$field $op";
5659
5660     switch ($op) {
5661       case 'IS NULL':
5662       case 'IS NOT NULL':
5663         return $clause;
5664
5665       case 'IS EMPTY':
5666         $clause = ($dataType == 'Date') ? " $field IS NULL " : " (NULLIF($field, '') IS NULL) ";
5667         return $clause;
5668
5669       case 'IS NOT EMPTY':
5670         $clause = ($dataType == 'Date') ? " $field IS NOT NULL " : " (NULLIF($field, '') IS NOT NULL) ";
5671         return $clause;
5672
5673       case 'IN':
5674       case 'NOT IN':
5675         // I feel like this would be escaped properly if passed through $queryString = CRM_Core_DAO::createSqlFilter.
5676         if (!empty($value) && (!is_array($value) || !array_key_exists($op, $value))) {
5677           $value = array($op => (array) $value);
5678         }
5679
5680       default:
5681         if (empty($dataType) || $dataType == 'Date') {
5682           $dataType = 'String';
5683         }
5684         if (is_array($value)) {
5685           //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5686           // widely used and consistent across the codebase
5687           // adding this here won't accept the search functions which don't submit an array
5688           if (($queryString = CRM_Core_DAO::createSqlFilter($field, $value, $dataType)) != FALSE) {
5689
5690             return $queryString;
5691           }
5692
5693           // This is the here-be-dragons zone. We have no other hopes left for an array so lets assume it 'should' be array('IN' => array(2,5))
5694           // but we got only array(2,5) from the form.
5695           // We could get away with keeping this in 4.6 if we make it such that it throws an enotice in 4.7 so
5696           // people have to de-slopify it.
5697           if (!empty($value[0])) {
5698             if ($op != 'BETWEEN') {
5699               $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReport;
5700             }
5701             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => $value), $dataType)) != FALSE) {
5702               return $queryString;
5703             }
5704           }
5705           else {
5706             $op = 'IN';
5707             $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReportUsingOldFormat;
5708             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => array_keys($value)), $dataType)) != FALSE) {
5709               return $queryString;
5710             }
5711           }
5712         }
5713
5714         $value = CRM_Utils_Type::escape($value, $dataType);
5715         // if we don't have a dataType we should assume
5716         if ($dataType == 'String' || $dataType == 'Text') {
5717           $value = "'" . strtolower($value) . "'";
5718         }
5719         return "$clause $value";
5720     }
5721   }
5722
5723   /**
5724    * @param bool $reset
5725    *
5726    * @return array
5727    */
5728   public function openedSearchPanes($reset = FALSE) {
5729     if (!$reset || empty($this->_whereTables)) {
5730       return self::$_openedPanes;
5731     }
5732
5733     // pane name to table mapper
5734     $panesMapper = array(
5735       ts('Contributions') => 'civicrm_contribution',
5736       ts('Memberships') => 'civicrm_membership',
5737       ts('Events') => 'civicrm_participant',
5738       ts('Relationships') => 'civicrm_relationship',
5739       ts('Activities') => 'civicrm_activity',
5740       ts('Pledges') => 'civicrm_pledge',
5741       ts('Cases') => 'civicrm_case',
5742       ts('Grants') => 'civicrm_grant',
5743       ts('Address Fields') => 'civicrm_address',
5744       ts('Notes') => 'civicrm_note',
5745       ts('Change Log') => 'civicrm_log',
5746       ts('Mailings') => 'civicrm_mailing',
5747     );
5748     CRM_Contact_BAO_Query_Hook::singleton()->getPanesMapper($panesMapper);
5749
5750     foreach (array_keys($this->_whereTables) as $table) {
5751       if ($panName = array_search($table, $panesMapper)) {
5752         self::$_openedPanes[$panName] = TRUE;
5753       }
5754     }
5755
5756     return self::$_openedPanes;
5757   }
5758
5759   /**
5760    * @param $operator
5761    */
5762   public function setOperator($operator) {
5763     $validOperators = array('AND', 'OR');
5764     if (!in_array($operator, $validOperators)) {
5765       $operator = 'AND';
5766     }
5767     $this->_operator = $operator;
5768   }
5769
5770   /**
5771    * @return string
5772    */
5773   public function getOperator() {
5774     return $this->_operator;
5775   }
5776
5777   /**
5778    * @param $from
5779    * @param $where
5780    * @param $having
5781    */
5782   public function filterRelatedContacts(&$from, &$where, &$having) {
5783     if (!isset(Civi::$statics[__CLASS__]['related_contacts_filter'])) {
5784       Civi::$statics[__CLASS__]['related_contacts_filter'] = array();
5785     }
5786     $_rTempCache =& Civi::$statics[__CLASS__]['related_contacts_filter'];
5787     // since there only can be one instance of this filter in every query
5788     // skip if filter has already applied
5789     foreach ($_rTempCache as $acache) {
5790       foreach ($acache['queries'] as $aqcache) {
5791         if (strpos($from, $aqcache['from']) !== FALSE) {
5792           $having = NULL;
5793           return;
5794         }
5795       }
5796     }
5797     $arg_sig = sha1("$from $where $having");
5798     if (isset($_rTempCache[$arg_sig])) {
5799       $cache = $_rTempCache[$arg_sig];
5800     }
5801     else {
5802       // create temp table with contact ids
5803       $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE);
5804
5805       $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5806       CRM_Core_DAO::executeQuery($sql);
5807
5808       $sql = "
5809 REPLACE INTO $tableName ( contact_id )
5810 SELECT contact_a.id
5811        $from
5812        $where
5813        $having
5814 ";
5815       CRM_Core_DAO::executeQuery($sql);
5816
5817       $cache = array('tableName' => $tableName, 'queries' => array());
5818       $_rTempCache[$arg_sig] = $cache;
5819     }
5820     // upsert the query depending on relationship type
5821     if (isset($cache['queries'][$this->_displayRelationshipType])) {
5822       $qcache = $cache['queries'][$this->_displayRelationshipType];
5823     }
5824     else {
5825       $tableName = $cache['tableName'];
5826       $qcache = array(
5827         "from" => "",
5828         "where" => "",
5829       );
5830       $rTypes = CRM_Core_PseudoConstant::relationshipType();
5831       if (is_numeric($this->_displayRelationshipType)) {
5832         $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b'];
5833         $qcache['from'] = "
5834 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5835 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5836 ";
5837         $qcache['where'] = "
5838 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5839 AND   displayRelType.is_active = 1
5840 ";
5841       }
5842       else {
5843         list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType);
5844         if ($dirOne == 'a') {
5845           $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5846           $qcache['from'] .= "
5847 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5848 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5849 ";
5850         }
5851         else {
5852           $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5853           $qcache['from'] .= "
5854 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5855 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5856 ";
5857         }
5858         $qcache['where'] = "
5859 WHERE displayRelType.relationship_type_id = $relType
5860 AND   displayRelType.is_active = 1
5861 ";
5862       }
5863       $qcache['relTypeLabel'] = $relationshipTypeLabel;
5864       $_rTempCache[$arg_sig]['queries'][$this->_displayRelationshipType] = $qcache;
5865     }
5866     $qillMessage = ts('Contacts with a Relationship Type of: ');
5867     $iqill = $qillMessage . "'" . $qcache['relTypeLabel'] . "'";
5868     if (!is_array($this->_qill[0]) || !in_array($iqill, $this->_qill[0])) {
5869       $this->_qill[0][] = $iqill;
5870     }
5871     if (strpos($from, $qcache['from']) === FALSE) {
5872       // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5873       // this happens when we have an event_type in the quert (CRM-7969)
5874       $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5875       $from .= $qcache['from'];
5876       $where = $qcache['where'];
5877       if (!empty($this->_permissionWhereClause)) {
5878         $where .= "AND $this->_permissionWhereClause";
5879       }
5880     }
5881
5882     $having = NULL;
5883   }
5884
5885   /**
5886    * See CRM-19811 for why this is database hurty without apparent benefit.
5887    *
5888    * @param $op
5889    *
5890    * @return bool
5891    */
5892   public static function caseImportant($op) {
5893     return
5894       in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
5895   }
5896
5897   /**
5898    * @param $returnProperties
5899    * @param $prefix
5900    *
5901    * @return bool
5902    */
5903   public static function componentPresent(&$returnProperties, $prefix) {
5904     foreach ($returnProperties as $name => $dontCare) {
5905       if (substr($name, 0, strlen($prefix)) == $prefix) {
5906         return TRUE;
5907       }
5908     }
5909     return FALSE;
5910   }
5911
5912   /**
5913    * Builds the necessary structures for all fields that are similar to option value look-ups.
5914    *
5915    * @param string $name
5916    *   the name of the field.
5917    * @param string $op
5918    *   the sql operator, this function should handle ALL SQL operators.
5919    * @param string $value
5920    *   depends on the operator and who's calling the query builder.
5921    * @param int $grouping
5922    *   the index where to place the where clause.
5923    * @param string $daoName
5924    *   DAO Name.
5925    * @param array $field
5926    *   an array that contains various properties of the field identified by $name.
5927    * @param string $label
5928    *   The label for this field element.
5929    * @param string $dataType
5930    *   The data type for this element.
5931    * @param bool $useIDsOnly
5932    */
5933   public function optionValueQuery(
5934     $name,
5935     $op,
5936     $value,
5937     $grouping,
5938     $daoName = NULL,
5939     $field,
5940     $label,
5941     $dataType = 'String',
5942     $useIDsOnly = FALSE
5943   ) {
5944
5945     $pseudoFields = array(
5946       'email_greeting',
5947       'postal_greeting',
5948       'addressee',
5949       'gender_id',
5950       'prefix_id',
5951       'suffix_id',
5952       'communication_style_id',
5953     );
5954
5955     if ($useIDsOnly) {
5956       list($tableName, $fieldName) = explode('.', $field['where'], 2);
5957       if ($tableName == 'civicrm_contact') {
5958         $wc = "contact_a.$fieldName";
5959       }
5960       else {
5961         $wc = "$tableName.id";
5962       }
5963     }
5964     else {
5965       // LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
5966       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
5967     }
5968     if (in_array($name, $pseudoFields)) {
5969       if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5970         $wc = "contact_a.{$name}_id";
5971       }
5972       $dataType = 'Positive';
5973       $value = (!$value) ? 0 : $value;
5974     }
5975     if ($name == "world_region") {
5976       $field['name'] = $name;
5977     }
5978
5979     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue($daoName, $field['name'], $value, $op);
5980     $this->_qill[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillop, 3 => $qillVal));
5981     $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType);
5982   }
5983
5984   /**
5985    * Check and explode a user defined numeric string into an array
5986    * this was the protocol used by search builder in the old old days before we had
5987    * super nice js widgets to do the hard work
5988    *
5989    * @param string $string
5990    * @param string $dataType
5991    *   The dataType we should check for the values, default integer.
5992    *
5993    * @return bool|array
5994    *   false if string does not match the pattern
5995    *   array of numeric values if string does match the pattern
5996    */
5997   public static function parseSearchBuilderString($string, $dataType = 'Integer') {
5998     $string = trim($string);
5999     if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') {
6000       Return FALSE;
6001     }
6002
6003     $string = substr($string, 1, -1);
6004     $values = explode(',', $string);
6005     if (empty($values)) {
6006       return FALSE;
6007     }
6008
6009     $returnValues = array();
6010     foreach ($values as $v) {
6011       if ($dataType == 'Integer' && !is_numeric($v)) {
6012         return FALSE;
6013       }
6014       elseif ($dataType == 'String' && !is_string($v)) {
6015         return FALSE;
6016       }
6017       $returnValues[] = trim($v);
6018     }
6019
6020     if (empty($returnValues)) {
6021       return FALSE;
6022     }
6023
6024     return $returnValues;
6025   }
6026
6027   /**
6028    * Convert the pseudo constants id's to their names
6029    *
6030    * @param CRM_Core_DAO $dao
6031    * @param bool $return
6032    * @param bool $usedForAPI
6033    *
6034    * @return array|NULL
6035    */
6036   public function convertToPseudoNames(&$dao, $return = FALSE, $usedForAPI = FALSE) {
6037     if (empty($this->_pseudoConstantsSelect)) {
6038       return NULL;
6039     }
6040     $values = array();
6041     foreach ($this->_pseudoConstantsSelect as $key => $value) {
6042       if (!empty($this->_pseudoConstantsSelect[$key]['sorting'])) {
6043         continue;
6044       }
6045
6046       if (is_object($dao) && property_exists($dao, $value['idCol'])) {
6047         $val = $dao->{$value['idCol']};
6048         if ($key == 'groups') {
6049           $dao->groups = $this->convertGroupIDStringToLabelString($dao, $val);
6050           continue;
6051         }
6052
6053         if (CRM_Utils_System::isNull($val)) {
6054           $dao->$key = NULL;
6055         }
6056         elseif (!empty($value['pseudoconstant'])) {
6057           // If pseudoconstant is set that is kind of defacto for 'we have a bit more info about this'
6058           // and we can use the metadata to figure it out.
6059           // ideally this bit of IF will absorb & replace all the rest in time as we move to
6060           // more metadata based choices.
6061           if (strpos($val, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
6062             $dbValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($val, CRM_Core_DAO::VALUE_SEPARATOR));
6063             foreach ($dbValues as $pseudoValue) {
6064               $convertedValues[] = CRM_Core_PseudoConstant::getLabel($value['bao'], $value['idCol'], $pseudoValue);
6065             }
6066
6067             $dao->$key = ($usedForAPI) ? $convertedValues : implode(', ', $convertedValues);
6068             $realFieldName = CRM_Utils_Array::value('field_name', $this->_pseudoConstantsSelect[$key]);
6069             if ($usedForAPI && $realFieldName) {
6070               // normally we would see 2 fields returned for pseudoConstants. An exception is
6071               // preferred_communication_method where there is no id-variant.
6072               // For the api we prioritise getting the real data returned.
6073               // over the resolved version
6074               $dao->$realFieldName = $dbValues;
6075             }
6076
6077           }
6078           else {
6079             // This is basically the same as the default but since we have the bao we can use
6080             // a cached function.
6081             $dao->$key = CRM_Core_PseudoConstant::getLabel($value['bao'], $value['idCol'], $val);
6082           }
6083         }
6084         elseif ($baoName = CRM_Utils_Array::value('bao', $value, NULL)) {
6085           //preserve id value
6086           $idColumn = "{$key}_id";
6087           $dao->$idColumn = $val;
6088
6089           if ($key == 'state_province_name') {
6090             $dao->{$value['pseudoField']} = $dao->$key = CRM_Core_PseudoConstant::stateProvince($val);
6091           }
6092           else {
6093             $dao->{$value['pseudoField']} = $dao->$key = CRM_Core_PseudoConstant::getLabel($baoName, $value['pseudoField'], $val);
6094           }
6095         }
6096         elseif ($value['pseudoField'] == 'state_province_abbreviation') {
6097           $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
6098         }
6099         // @todo handle this in the section above for pseudoconstants.
6100         elseif (in_array($value['pseudoField'], array('participant_role_id', 'participant_role'))) {
6101           // @todo define bao on this & merge into the above condition.
6102           $viewValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, $val);
6103
6104           if ($value['pseudoField'] == 'participant_role') {
6105             $pseudoOptions = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'role_id');
6106             foreach ($viewValues as $k => $v) {
6107               $viewValues[$k] = $pseudoOptions[$v];
6108             }
6109           }
6110           $dao->$key = ($usedForAPI && count($viewValues) > 1) ? $viewValues : implode(', ', $viewValues);
6111         }
6112         else {
6113           $labels = CRM_Core_OptionGroup::values($value['pseudoField']);
6114           $dao->$key = $labels[$val];
6115         }
6116
6117         // return converted values in array format
6118         if ($return) {
6119           if (strpos($key, '-') !== FALSE) {
6120             $keyVal = explode('-', $key);
6121             $current = &$values;
6122             $lastElement = array_pop($keyVal);
6123             foreach ($keyVal as $v) {
6124               if (!array_key_exists($v, $current)) {
6125                 $current[$v] = array();
6126               }
6127               $current = &$current[$v];
6128             }
6129             $current[$lastElement] = $dao->$key;
6130           }
6131           else {
6132             $values[$key] = $dao->$key;
6133           }
6134         }
6135       }
6136     }
6137     if (!$usedForAPI) {
6138       foreach (array(
6139          'gender_id' => 'gender',
6140           'prefix_id' => 'individual_prefix',
6141           'suffix_id' => 'individual_suffix',
6142           'communication_style_id' => 'communication_style',
6143         ) as $realField => $labelField) {
6144         // This is a temporary routine for handling these fields while
6145         // we figure out how to handled them based on metadata in
6146         /// export and search builder. CRM-19815, CRM-19830.
6147         if (isset($dao->$realField) && is_numeric($dao->$realField) && isset($dao->$labelField)) {
6148           $dao->$realField = $dao->$labelField;
6149         }
6150       }
6151     }
6152     return $values;
6153   }
6154
6155   /**
6156    * Include pseudo fields LEFT JOIN.
6157    * @param string|array $sort can be a object or string
6158    *
6159    * @return array|NULL
6160    */
6161   public function includePseudoFieldsJoin($sort) {
6162     if (!$sort || empty($this->_pseudoConstantsSelect)) {
6163       return NULL;
6164     }
6165     $sort = is_string($sort) ? $sort : $sort->orderBy();
6166     $present = array();
6167
6168     foreach ($this->_pseudoConstantsSelect as $name => $value) {
6169       if (!empty($value['table'])) {
6170         $regex = "/({$value['table']}\.|{$name})/";
6171         if (preg_match($regex, $sort)) {
6172           $this->_elemnt[$value['element']] = 1;
6173           $this->_select[$value['element']] = $value['select'];
6174           $this->_pseudoConstantsSelect[$name]['sorting'] = 1;
6175           $present[$value['table']] = $value['join'];
6176         }
6177       }
6178     }
6179     $presentSimpleFrom = $present;
6180
6181     if (array_key_exists('civicrm_worldregion', $this->_whereTables) &&
6182       array_key_exists('civicrm_country', $presentSimpleFrom)
6183     ) {
6184       unset($presentSimpleFrom['civicrm_country']);
6185     }
6186     if (array_key_exists('civicrm_worldregion', $this->_tables) &&
6187       array_key_exists('civicrm_country', $present)
6188     ) {
6189       unset($present['civicrm_country']);
6190     }
6191
6192     $presentClause = $presentSimpleFromClause = NULL;
6193     if (!empty($present)) {
6194       $presentClause = implode(' ', $present);
6195     }
6196     if (!empty($presentSimpleFrom)) {
6197       $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
6198     }
6199
6200     $this->_fromClause = $this->_fromClause . $presentClause;
6201     $this->_simpleFromClause = $this->_simpleFromClause . $presentSimpleFromClause;
6202
6203     return array($presentClause, $presentSimpleFromClause);
6204   }
6205
6206   /**
6207    * Build qill for field.
6208    *
6209    * Qill refers to the query detail visible on the UI.
6210    *
6211    * @param string $daoName
6212    * @param string $fieldName
6213    * @param mixed $fieldValue
6214    * @param string $op
6215    * @param array $pseudoExtraParam
6216    * @param int $type
6217    *   Type of the field per CRM_Utils_Type
6218    *
6219    * @return array
6220    */
6221   public static function buildQillForFieldValue(
6222     $daoName,
6223     $fieldName,
6224     $fieldValue,
6225     $op,
6226     $pseudoExtraParam = array(),
6227     $type = CRM_Utils_Type::T_STRING
6228   ) {
6229     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
6230
6231     //API usually have fieldValue format as array(operator => array(values)),
6232     //so we need to separate operator out of fieldValue param
6233     if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
6234       $op = key($fieldValue);
6235       $fieldValue = $fieldValue[$op];
6236     }
6237
6238     // if Operator chosen is NULL/EMPTY then
6239     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
6240       return array(CRM_Utils_Array::value($op, $qillOperators, $op), '');
6241     }
6242
6243     if ($fieldName == 'activity_type_id') {
6244       $pseudoOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
6245     }
6246     elseif ($fieldName == 'country_id') {
6247       $pseudoOptions = CRM_Core_PseudoConstant::country();
6248     }
6249     elseif ($fieldName == 'county_id') {
6250       $pseudoOptions = CRM_Core_PseudoConstant::county();
6251     }
6252     elseif ($fieldName == 'world_region') {
6253       $pseudoOptions = CRM_Core_PseudoConstant::worldRegion();
6254     }
6255     elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
6256       $checkPermission = CRM_Utils_Array::value('check_permission', $pseudoExtraParam, TRUE);
6257       $pseudoOptions = CRM_Event_BAO_Event::getEvents(0, $fieldValue, TRUE, $checkPermission, TRUE);
6258     }
6259     elseif ($fieldName == 'contribution_product_id') {
6260       $pseudoOptions = CRM_Contribute_PseudoConstant::products();
6261     }
6262     elseif ($daoName == 'CRM_Contact_DAO_Group' && $fieldName == 'id') {
6263       $pseudoOptions = CRM_Core_PseudoConstant::group();
6264     }
6265     elseif ($daoName == 'CRM_Batch_BAO_EntityBatch' && $fieldName == 'batch_id') {
6266       $pseudoOptions = CRM_Contribute_PseudoConstant::batch();
6267     }
6268     elseif ($daoName) {
6269       $pseudoOptions = CRM_Core_PseudoConstant::get($daoName, $fieldName, $pseudoExtraParam);
6270     }
6271
6272     if (is_array($fieldValue)) {
6273       $qillString = array();
6274       if (!empty($pseudoOptions)) {
6275         foreach ((array) $fieldValue as $val) {
6276           $qillString[] = CRM_Utils_Array::value($val, $pseudoOptions, $val);
6277         }
6278         $fieldValue = implode(', ', $qillString);
6279       }
6280       else {
6281         if ($type == CRM_Utils_Type::T_DATE) {
6282           foreach ($fieldValue as $index => $value) {
6283             $fieldValue[$index] = CRM_Utils_Date::customFormat($value);
6284           }
6285         }
6286         $separator = ', ';
6287         // @todo - this is a bit specific (one operator).
6288         // However it is covered by a unit test so can be altered later with
6289         // some confidence.
6290         if ($op == 'BETWEEN') {
6291           $separator = ' AND ';
6292         }
6293         $fieldValue = implode($separator, $fieldValue);
6294       }
6295     }
6296     elseif (!empty($pseudoOptions) && array_key_exists($fieldValue, $pseudoOptions)) {
6297       $fieldValue = $pseudoOptions[$fieldValue];
6298     }
6299     elseif ($type === CRM_Utils_Type::T_DATE) {
6300       $fieldValue = CRM_Utils_Date::customFormat($fieldValue);
6301     }
6302
6303     return array(CRM_Utils_Array::value($op, $qillOperators, $op), $fieldValue);
6304   }
6305
6306   /**
6307    * Alter value to reflect wildcard settings.
6308    *
6309    * The form will have tried to guess whether this is a good field to wildcard but there is
6310    * also a site-wide setting that specifies whether it is OK to append the wild card to the beginning
6311    * or only the end of the string
6312    *
6313    * @param bool $wildcard
6314    *   This is a bool made on an assessment 'elsewhere' on whether this is a good field to wildcard.
6315    * @param string $op
6316    *   Generally '=' or 'LIKE'.
6317    * @param string $value
6318    *   The search string.
6319    *
6320    * @return string
6321    */
6322   public static function getWildCardedValue($wildcard, $op, $value) {
6323     if ($wildcard && $op == 'LIKE') {
6324       if (CRM_Core_Config::singleton()->includeWildCardInName && (substr($value, 0, 1) != '%')) {
6325         return "%$value%";
6326       }
6327       else {
6328         return "$value%";
6329       }
6330     }
6331     else {
6332       return "$value";
6333     }
6334   }
6335
6336   /**
6337    * Process special fields of Search Form in OK (Operator in Key) format
6338    *
6339    * @param array $formValues
6340    * @param array $specialFields
6341    *    Special params to be processed
6342    * @param array $changeNames
6343    *   Array of fields whose name should be changed
6344    */
6345   public static function processSpecialFormValue(&$formValues, $specialFields, $changeNames = array()) {
6346     // Array of special fields whose value are considered only for NULL or EMPTY operators
6347     $nullableFields = array('contribution_batch_id');
6348
6349     foreach ($specialFields as $element) {
6350       $value = CRM_Utils_Array::value($element, $formValues);
6351       if ($value) {
6352         if (is_array($value)) {
6353           if (in_array($element, array_keys($changeNames))) {
6354             unset($formValues[$element]);
6355             $element = $changeNames[$element];
6356           }
6357           $formValues[$element] = array('IN' => $value);
6358         }
6359         elseif (in_array($value, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
6360           $formValues[$element] = array($value => 1);
6361         }
6362         elseif (!in_array($element, $nullableFields)) {
6363           // if wildcard is already present return searchString as it is OR append and/or prepend with wildcard
6364           $isWilcard = strstr($value, '%') ? FALSE : CRM_Core_Config::singleton()->includeWildCardInName;
6365           $formValues[$element] = array('LIKE' => self::getWildCardedValue($isWilcard, 'LIKE', $value));
6366         }
6367       }
6368     }
6369   }
6370
6371   /**
6372    * Parse and assimilate the various sort options.
6373    *
6374    * Side-effect: if sorting on a common column from a related table (`city`, `postal_code`,
6375    * `email`), the related table may be joined automatically.
6376    *
6377    * At time of writing, this code is deeply flawed and should be rewritten. For the moment,
6378    * it's been extracted to a standalone function.
6379    *
6380    * @param string|CRM_Utils_Sort $sort
6381    *   The order by string.
6382    * @param bool $sortByChar
6383    *   If true returns the distinct array of first characters for search results.
6384    * @param null $sortOrder
6385    *   Who knows? Hu knows. He who knows Hu knows who.
6386    * @param string $additionalFromClause
6387    *   Should be clause with proper joins, effective to reduce where clause load.
6388    * @return array
6389    *   list(string $orderByClause, string $additionalFromClause).
6390    */
6391   protected function prepareOrderBy($sort, $sortByChar, $sortOrder, $additionalFromClause) {
6392     $order = NULL;
6393     $orderByArray = array();
6394     $config = CRM_Core_Config::singleton();
6395     if ($config->includeOrderByClause ||
6396       isset($this->_distinctComponentClause)
6397     ) {
6398       if ($sort) {
6399         if (is_string($sort)) {
6400           $orderBy = $sort;
6401         }
6402         else {
6403           $orderBy = trim($sort->orderBy());
6404         }
6405         // Deliberately remove the backticks again, as they mess up the evil
6406         // string munging below. This balanced by re-escaping before use.
6407         $orderBy = str_replace('`', '', $orderBy);
6408
6409         if (!empty($orderBy)) {
6410           // this is special case while searching for
6411           // change log CRM-1718
6412           if (preg_match('/sort_name/i', $orderBy)) {
6413             $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
6414           }
6415
6416           $order = " ORDER BY $orderBy";
6417
6418           if ($sortOrder) {
6419             $order .= " $sortOrder";
6420           }
6421
6422           // always add contact_a.id to the ORDER clause
6423           // so the order is deterministic
6424           if (strpos('contact_a.id', $order) === FALSE) {
6425             $order .= ", contact_a.id";
6426           }
6427         }
6428       }
6429       elseif ($sortByChar) {
6430         $orderByArray = array("UPPER(LEFT(contact_a.sort_name, 1)) asc");
6431       }
6432       else {
6433         $order = " ORDER BY contact_a.sort_name ASC, contact_a.id";
6434       }
6435     }
6436     if (!$order && empty($orderByArray)) {
6437       return array($order, $additionalFromClause);
6438     }
6439     // Remove this here & add it at the end for simplicity.
6440     $order = trim(str_replace('ORDER BY', '', $order));
6441
6442     // hack for order clause
6443     if (!empty($orderByArray)) {
6444       $order = implode(', ', $orderByArray);
6445     }
6446     else {
6447       $orderByArray = explode(',', $order);
6448     }
6449     foreach ($orderByArray as $orderByClause) {
6450       $orderByClauseParts = explode(' ', trim($orderByClause));
6451       $field = $orderByClauseParts[0];
6452       $direction = isset($orderByClauseParts[1]) ? $orderByClauseParts[1] : 'asc';
6453
6454       switch ($field) {
6455         case 'city':
6456         case 'postal_code':
6457           $this->_tables["civicrm_address"] = $this->_whereTables["civicrm_address"] = 1;
6458           $order = str_replace($field, "civicrm_address.{$field}", $order);
6459           break;
6460
6461         case 'country':
6462         case 'state_province':
6463           $this->_tables["civicrm_{$field}"] = $this->_whereTables["civicrm_{$field}"] = 1;
6464           if (is_array($this->_returnProperties) && empty($this->_returnProperties)) {
6465             $additionalFromClause .= " LEFT JOIN civicrm_{$field} ON civicrm_{$field}.id = civicrm_address.{$field}_id";
6466           }
6467           $order = str_replace($field, "civicrm_{$field}.name", $order);
6468           break;
6469
6470         case 'email':
6471           $this->_tables["civicrm_email"] = $this->_whereTables["civicrm_email"] = 1;
6472           $order = str_replace($field, "civicrm_email.{$field}", $order);
6473           break;
6474
6475         default:
6476           $cfID = CRM_Core_BAO_CustomField::getKeyID($field);
6477           // add to cfIDs array if not present
6478           if (!empty($cfID) && !array_key_exists($cfID, $this->_cfIDs)) {
6479             $this->_cfIDs[$cfID] = array();
6480             $this->_customQuery = new CRM_Core_BAO_CustomQuery($this->_cfIDs, TRUE, $this->_locationSpecificCustomFields);
6481             $this->_customQuery->query();
6482             $this->_select = array_merge($this->_select, $this->_customQuery->_select);
6483             $this->_tables = array_merge($this->_tables, $this->_customQuery->_tables);
6484           }
6485           foreach ($this->_pseudoConstantsSelect as $key => $pseudoConstantMetadata) {
6486             // By replacing the join to the option value table with the mysql construct
6487             // ORDER BY field('contribution_status_id', 2,1,4)
6488             // we can remove a join. In the case of the option value join it is
6489             /// a join known to cause slow queries.
6490             // @todo cover other pseudoconstant types. Limited to option group ones in the
6491             // first instance for scope reasons. They require slightly different handling as the column (label)
6492             // is not declared for them.
6493             // @todo so far only integer fields are being handled. If we add string fields we need to look at
6494             // escaping.
6495             if (isset($pseudoConstantMetadata['pseudoconstant'])
6496               && isset($pseudoConstantMetadata['pseudoconstant']['optionGroupName'])
6497               && $field === CRM_Utils_Array::value('optionGroupName', $pseudoConstantMetadata['pseudoconstant'])
6498             ) {
6499               $sortedOptions = $pseudoConstantMetadata['bao']::buildOptions($pseudoConstantMetadata['pseudoField'], NULL, array(
6500                 'orderColumn' => 'label',
6501               ));
6502               $order = str_replace("$field $direction", "field({$pseudoConstantMetadata['pseudoField']}," . implode(',', array_keys($sortedOptions)) . ") $direction", $order);
6503             }
6504             //CRM-12565 add "`" around $field if it is a pseudo constant
6505             // This appears to be for 'special' fields like locations with appended numbers or hyphens .. maybe.
6506             if (!empty($pseudoConstantMetadata['element']) && $pseudoConstantMetadata['element'] == $field) {
6507               $order = str_replace($field, "`{$field}`", $order);
6508             }
6509           }
6510       }
6511     }
6512
6513     $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
6514     $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
6515
6516     // The above code relies on crazy brittle string manipulation of a peculiarly-encoded ORDER BY
6517     // clause. But this magic helper which forgivingly reescapes ORDER BY.
6518     // Note: $sortByChar implies that $order was hard-coded/trusted, so it can do funky things.
6519     if ($sortByChar) {
6520       return array(' ORDER BY ' . $order, $additionalFromClause);
6521     }
6522     if ($order) {
6523       $order = CRM_Utils_Type::escape($order, 'MysqlOrderBy');
6524       return array(' ORDER BY ' . $order, $additionalFromClause);
6525     }
6526   }
6527
6528   /**
6529    * Convert a string of group IDs to a string of group labels.
6530    *
6531    * The original string may include duplicates and groups the user does not have
6532    * permission to see.
6533    *
6534    * @param CRM_Core_DAO $dao
6535    * @param string $val
6536    *
6537    * @return string
6538    */
6539   public function convertGroupIDStringToLabelString(&$dao, $val) {
6540     $groupIDs = explode(',', $val);
6541     // Note that groups that the user does not have permission to will be excluded (good).
6542     $groups = array_intersect_key(CRM_Core_PseudoConstant::group(), array_flip($groupIDs));
6543     return implode(', ', $groups);
6544
6545   }
6546
6547   /**
6548    * Set the qill and where properties for a field.
6549    *
6550    * This function is intended as a short-term function to encourage refactoring
6551    * & re-use - but really we should just have less special-casing.
6552    *
6553    * @param string $name
6554    * @param string $op
6555    * @param string|array $value
6556    * @param string $grouping
6557    * @param string $field
6558    */
6559   public function setQillAndWhere($name, $op, $value, $grouping, $field) {
6560     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value);
6561     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue(NULL, $name, $value, $op);
6562     $this->_qill[$grouping][] = ts("%1 %2 %3", array(
6563       1 => $field['title'],
6564       2 => $qillop,
6565       3 => $qillVal,
6566     ));
6567   }
6568
6569   /**
6570    * Has the pseudoconstant of the field been requested.
6571    *
6572    * For example if the field is payment_instrument_id then it
6573    * has been requested if either payment_instrument_id or payment_instrument
6574    * have been requested. Payment_instrument is the option groun name field value.
6575    *
6576    * @param array $field
6577    * @param string $fieldName
6578    *   The unique name of the field - ie. the one it will be aliased to in the query.
6579    *
6580    * @return bool
6581    */
6582   private function pseudoConstantNameIsInReturnProperties($field, $fieldName = NULL) {
6583     if (!isset($field['pseudoconstant']['optionGroupName'])) {
6584       return FALSE;
6585     }
6586
6587     if (CRM_Utils_Array::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties)) {
6588       return TRUE;
6589     }
6590     if (CRM_Utils_Array::value($fieldName, $this->_returnProperties)) {
6591       return TRUE;
6592     }
6593     // Is this still required - the above goes off the unique name. Test with things like
6594     // communication_prefferences & prefix_id.
6595     if (CRM_Utils_Array::value($field['name'], $this->_returnProperties)) {
6596       return TRUE;
6597     }
6598     return FALSE;
6599   }
6600
6601   /**
6602    * Get Select Clause.
6603    *
6604    * @return string
6605    */
6606   public function getSelect() {
6607     $select = "SELECT ";
6608     if (isset($this->_distinctComponentClause)) {
6609       $select .= "{$this->_distinctComponentClause}, ";
6610     }
6611     $select .= implode(', ', $this->_select);
6612     return $select;
6613   }
6614
6615 }