CRM/Contact/BAO/Query.php

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