CRM/Contact/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   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       (!empty($values) && is_array($values) && !in_array(key($values), CRM_Core_DAO::acceptedSQLOperators(), TRUE))
1606     ) {
1607       $result = array($id, 'IN', $values, 0, $wildcard);
1608     }
1609     else {
1610       $result = array($id, '=', $values, 0, $wildcard);
1611     }
1612
1613     return $result;
1614   }
1615
1616   /**
1617    * @param $values
1618    */
1619   public function whereClauseSingle(&$values) {
1620     // do not process custom fields or prefixed contact ids or component params
1621     if (CRM_Core_BAO_CustomField::getKeyID($values[0]) ||
1622       (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) ||
1623       (substr($values[0], 0, 13) == 'contribution_') ||
1624       (substr($values[0], 0, 6) == 'event_') ||
1625       (substr($values[0], 0, 12) == 'participant_') ||
1626       (substr($values[0], 0, 7) == 'member_') ||
1627       (substr($values[0], 0, 6) == 'grant_') ||
1628       (substr($values[0], 0, 7) == 'pledge_') ||
1629       (substr($values[0], 0, 5) == 'case_') ||
1630       (substr($values[0], 0, 10) == 'financial_') ||
1631       (substr($values[0], 0, 8) == 'payment_') ||
1632       (substr($values[0], 0, 11) == 'membership_')
1633     ) {
1634       return;
1635     }
1636
1637     // skip for hook injected fields / params
1638     $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields();
1639     if (array_key_exists($values[0], $extFields)) {
1640       return;
1641     }
1642
1643     switch ($values[0]) {
1644       case 'deleted_contacts':
1645         $this->deletedContacts($values);
1646         return;
1647
1648       case 'contact_type':
1649         $this->contactType($values);
1650         return;
1651
1652       case 'contact_sub_type':
1653         $this->contactSubType($values);
1654         return;
1655
1656       case 'group':
1657         $this->group($values);
1658         return;
1659
1660       case 'group_type':
1661         // so we resolve this into a list of groups & proceed as if they had been
1662         // handed in
1663         list($name, $op, $value, $grouping, $wildcard) = $values;
1664         $values[0] = 'group';
1665         $values[1] = 'IN';
1666         $this->_paramLookup['group'][0][0] = 'group';
1667         $this->_paramLookup['group'][0][1] = 'IN';
1668         $this->_paramLookup['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1669         $this->group($values);
1670         return;
1671
1672       // case tag comes from find contacts
1673       case 'tag_search':
1674         $this->tagSearch($values);
1675         return;
1676
1677       case 'tag':
1678       case 'contact_tags':
1679         $this->tag($values);
1680         return;
1681
1682       case 'note':
1683       case 'note_body':
1684       case 'note_subject':
1685         $this->notes($values);
1686         return;
1687
1688       case 'uf_user':
1689         $this->ufUser($values);
1690         return;
1691
1692       case 'sort_name':
1693       case 'display_name':
1694         $this->sortName($values);
1695         return;
1696
1697       case 'addressee':
1698       case 'postal_greeting':
1699       case 'email_greeting':
1700         $this->greetings($values);
1701         return;
1702
1703       case 'email':
1704         $this->email($values);
1705         return;
1706
1707       case 'phone_numeric':
1708         $this->phone_numeric($values);
1709         return;
1710
1711       case 'phone_phone_type_id':
1712       case 'phone_location_type_id':
1713         $this->phone_option_group($values);
1714         return;
1715
1716       case 'street_address':
1717         $this->street_address($values);
1718         return;
1719
1720       case 'street_number':
1721         $this->street_number($values);
1722         return;
1723
1724       case 'sortByCharacter':
1725         $this->sortByCharacter($values);
1726         return;
1727
1728       case 'location_type':
1729         $this->locationType($values);
1730         return;
1731
1732       case 'county':
1733         $this->county($values);
1734         return;
1735
1736       case 'state_province':
1737         $this->stateProvince($values);
1738         return;
1739
1740       case 'country':
1741         $this->country($values, FALSE);
1742         return;
1743
1744       case 'postal_code':
1745       case 'postal_code_low':
1746       case 'postal_code_high':
1747         $this->postalCode($values);
1748         return;
1749
1750       case 'activity_date':
1751       case 'activity_date_low':
1752       case 'activity_date_high':
1753       case 'activity_role':
1754       case 'activity_status_id':
1755       case 'activity_status':
1756       case 'followup_parent_id':
1757       case 'parent_id':
1758       case 'source_contact_id':
1759       case 'activity_subject':
1760       case 'test_activities':
1761       case 'activity_type_id':
1762       case 'activity_type':
1763       case 'activity_survey_id':
1764       case 'activity_tags':
1765       case 'activity_taglist':
1766       case 'activity_test':
1767       case 'activity_campaign_id':
1768       case 'activity_engagement_level':
1769       case 'activity_id':
1770       case 'activity_result':
1771       case 'source_contact':
1772         CRM_Activity_BAO_Query::whereClauseSingle($values, $this);
1773         return;
1774
1775       case 'age_low':
1776       case 'age_high':
1777       case 'birth_date_low':
1778       case 'birth_date_high':
1779       case 'deceased_date_low':
1780       case 'deceased_date_high':
1781         $this->demographics($values);
1782         return;
1783
1784       case 'age_asof_date':
1785         // handled by demographics
1786         return;
1787
1788       case 'log_date_low':
1789       case 'log_date_high':
1790         $this->modifiedDates($values);
1791         return;
1792
1793       case 'changed_by':
1794         $this->changeLog($values);
1795         return;
1796
1797       case 'do_not_phone':
1798       case 'do_not_email':
1799       case 'do_not_mail':
1800       case 'do_not_sms':
1801       case 'do_not_trade':
1802       case 'is_opt_out':
1803         $this->privacy($values);
1804         return;
1805
1806       case 'privacy_options':
1807         $this->privacyOptions($values);
1808         return;
1809
1810       case 'privacy_operator':
1811       case 'privacy_toggle':
1812         // these are handled by privacy options
1813         return;
1814
1815       case 'preferred_communication_method':
1816         $this->preferredCommunication($values);
1817         return;
1818
1819       case 'relation_type_id':
1820       case 'relation_start_date_high':
1821       case 'relation_start_date_low':
1822       case 'relation_end_date_high':
1823       case 'relation_end_date_low':
1824       case 'relation_target_name':
1825       case 'relation_status':
1826       case 'relation_date_low':
1827       case 'relation_date_high':
1828         $this->relationship($values);
1829         $this->_relationshipValuesAdded = TRUE;
1830         return;
1831
1832       case 'task_status_id':
1833         $this->task($values);
1834         return;
1835
1836       case 'task_id':
1837         // since this case is handled with the above
1838         return;
1839
1840       case 'prox_distance':
1841         CRM_Contact_BAO_ProximityQuery::process($this, $values);
1842         return;
1843
1844       case 'prox_street_address':
1845       case 'prox_city':
1846       case 'prox_postal_code':
1847       case 'prox_state_province_id':
1848       case 'prox_country_id':
1849         // handled by the proximity_distance clause
1850         return;
1851
1852       default:
1853         $this->restWhere($values);
1854         return;
1855     }
1856   }
1857
1858   /**
1859    * Given a list of conditions in params generate the required.
1860    * where clause
1861    *
1862    * @return string
1863    */
1864   public function whereClause() {
1865     $this->_where[0] = array();
1866     $this->_qill[0] = array();
1867
1868     $this->includeContactIds();
1869     if (!empty($this->_params)) {
1870       foreach (array_keys($this->_params) as $id) {
1871         if (empty($this->_params[$id][0])) {
1872           continue;
1873         }
1874         // check for both id and contact_id
1875         if ($this->_params[$id][0] == 'id' || $this->_params[$id][0] == 'contact_id') {
1876           $this->_where[0][] = self::buildClause("contact_a.id", $this->_params[$id][1], $this->_params[$id][2]);
1877         }
1878         else {
1879           $this->whereClauseSingle($this->_params[$id]);
1880         }
1881       }
1882
1883       CRM_Core_Component::alterQuery($this, 'where');
1884
1885       CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'where');
1886     }
1887
1888     if ($this->_customQuery) {
1889       // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1890       // Hope it wont affect the other part of civicrm.. if it does please remove it.
1891       if (!empty($this->_customQuery->_where)) {
1892         $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where);
1893       }
1894
1895       $this->_qill = CRM_Utils_Array::crmArrayMerge($this->_qill, $this->_customQuery->_qill);
1896     }
1897
1898     $clauses = array();
1899     $andClauses = array();
1900
1901     $validClauses = 0;
1902     if (!empty($this->_where)) {
1903       foreach ($this->_where as $grouping => $values) {
1904         if ($grouping > 0 && !empty($values)) {
1905           $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1906           $validClauses++;
1907         }
1908       }
1909
1910       if (!empty($this->_where[0])) {
1911         $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where[0]) . ' ) ';
1912       }
1913       if (!empty($clauses)) {
1914         $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1915       }
1916
1917       if ($validClauses > 1) {
1918         $this->_useDistinct = TRUE;
1919       }
1920     }
1921
1922     return implode(' AND ', $andClauses);
1923   }
1924
1925   /**
1926    * @param $values
1927    *
1928    * @throws Exception
1929    */
1930   public function restWhere(&$values) {
1931     $name = CRM_Utils_Array::value(0, $values);
1932     $op = CRM_Utils_Array::value(1, $values);
1933     $value = CRM_Utils_Array::value(2, $values);
1934     $grouping = CRM_Utils_Array::value(3, $values);
1935     $wildcard = CRM_Utils_Array::value(4, $values);
1936
1937     if (isset($grouping) && empty($this->_where[$grouping])) {
1938       $this->_where[$grouping] = array();
1939     }
1940
1941     $multipleFields = array('url');
1942
1943     //check if the location type exits for fields
1944     $lType = '';
1945     $locType = explode('-', $name);
1946
1947     if (!in_array($locType[0], $multipleFields)) {
1948       //add phone type if exists
1949       if (isset($locType[2]) && $locType[2]) {
1950         $locType[2] = CRM_Core_DAO::escapeString($locType[2]);
1951       }
1952     }
1953
1954     $field = CRM_Utils_Array::value($name, $this->_fields);
1955
1956     if (!$field) {
1957       $field = CRM_Utils_Array::value($locType[0], $this->_fields);
1958
1959       if (!$field) {
1960         return;
1961       }
1962     }
1963
1964     $setTables = TRUE;
1965
1966     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
1967     $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1968
1969     if (substr($name, 0, 14) === 'state_province') {
1970       if (isset($locType[1]) && is_numeric($locType[1])) {
1971         $setTables = FALSE;
1972         $aName = "{$locationType[$locType[1]]}-address";
1973         $where = "`$aName`.state_province_id";
1974       }
1975       else {
1976         $where = "civicrm_address.state_province_id";
1977       }
1978
1979       $states = CRM_Core_PseudoConstant::stateProvince();
1980       if (is_numeric($value)) {
1981         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
1982         $value = $states[(int ) $value];
1983       }
1984       else {
1985         $intVal = CRM_Utils_Array::key($value, $states);
1986         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
1987       }
1988       if (!$lType) {
1989         $this->_qill[$grouping][] = ts('State') . " $op '$value'";
1990       }
1991       else {
1992         $this->_qill[$grouping][] = ts('State') . " ($lType) $op '$value'";
1993       }
1994     }
1995     elseif (!empty($field['pseudoconstant'])) {
1996       $this->optionValueQuery(
1997         $name, $op, $value, $grouping,
1998         CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', $field['name']),
1999         $field,
2000         $field['title'],
2001         'String',
2002         TRUE
2003       );
2004       if ($name == 'gender_id') {
2005         self::$_openedPanes[ts('Demographics')] = TRUE;
2006       }
2007     }
2008     elseif (substr($name, 0, 7) === 'country') {
2009       if (isset($locType[1]) && is_numeric($locType[1])) {
2010         $setTables = FALSE;
2011         $aName = "{$locationType[$locType[1]]}-address";
2012         $where = "`$aName`.country_id";
2013       }
2014       else {
2015         $where = "civicrm_address.country_id";
2016       }
2017
2018       $countries = CRM_Core_PseudoConstant::country();
2019       if (is_numeric($value)) {
2020         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2021         $value = $countries[(int ) $value];
2022       }
2023       else {
2024         $intVal = CRM_Utils_Array::key($value, $countries);
2025         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
2026       }
2027
2028       if (!$lType) {
2029         $this->_qill[$grouping][] = ts('Country') . " $op '$value'";
2030       }
2031       else {
2032         $this->_qill[$grouping][] = ts('Country') . " ($lType) $op '$value'";
2033       }
2034     }
2035     elseif (substr($name, 0, 6) === 'county') {
2036       if (isset($locType[1]) && is_numeric($locType[1])) {
2037         $setTables = FALSE;
2038         $aName = "{$locationType[$locType[1]]}-address";
2039         $where = "`$aName`.county_id";
2040       }
2041       else {
2042         $where = "civicrm_address.county_id";
2043       }
2044
2045       $counties = CRM_Core_PseudoConstant::county();
2046       if (is_numeric($value)) {
2047         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2048         $value = $counties[(int ) $value];
2049       }
2050       else {
2051         $intVal = CRM_Utils_Array::key($value, $counties);
2052         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
2053       }
2054
2055       if (!$lType) {
2056         $this->_qill[$grouping][] = ts('County') . " $op '$value'";
2057       }
2058       else {
2059         $this->_qill[$grouping][] = ts('County') . " ($lType) $op '$value'";
2060       }
2061     }
2062     elseif ($name === 'world_region') {
2063       $field['where'] = 'civicrm_worldregion.id';
2064       $this->optionValueQuery(
2065         $name, $op, $value, $grouping,
2066         CRM_Core_PseudoConstant::worldRegion(),
2067         $field,
2068         ts('World Region'),
2069         'Positive',
2070         TRUE
2071       );
2072     }
2073     elseif ($name === 'is_deceased') {
2074       $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value);
2075       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2076       self::$_openedPanes[ts('Demographics')] = TRUE;
2077     }
2078     elseif ($name === 'created_date' || $name === 'modified_date' || $name === 'deceased_date' || $name === 'birth_date') {
2079       $appendDateTime = TRUE;
2080       if ($name === 'deceased_date' || $name === 'birth_date') {
2081         $appendDateTime = FALSE;
2082         self::$_openedPanes[ts('Demographics')] = TRUE;
2083       }
2084       $this->dateQueryBuilder($values, 'contact_a', $name, $name, $field['title'], $appendDateTime);
2085     }
2086     elseif ($name === 'contact_id') {
2087       if (is_int($value)) {
2088         $this->_where[$grouping][] = self::buildClause($field['where'], $op, $value);
2089         $this->_qill[$grouping][] = "$field[title] $op $value";
2090       }
2091     }
2092     elseif ($name === 'name') {
2093       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2094       if ($wildcard) {
2095         $value = "%$value%";
2096         $op = 'LIKE';
2097       }
2098       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
2099       $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'");
2100       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2101     }
2102     elseif ($name === 'current_employer') {
2103       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2104       if ($wildcard) {
2105         $value = "%$value%";
2106         $op = 'LIKE';
2107       }
2108       $wc = self::caseImportant($op) ? "LOWER(contact_a.organization_name)" : "contact_a.organization_name";
2109       $ceWhereClause = self::buildClause($wc, $op,
2110         $value
2111       );
2112       $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2113       $this->_where[$grouping][] = $ceWhereClause;
2114       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2115     }
2116     elseif ($name === 'email_greeting') {
2117       $filterCondition = array('greeting_type' => 'email_greeting');
2118       $this->optionValueQuery(
2119         $name, $op, $value, $grouping,
2120         CRM_Core_PseudoConstant::greeting($filterCondition),
2121         $field,
2122         ts('Email Greeting')
2123       );
2124     }
2125     elseif ($name === 'postal_greeting') {
2126       $filterCondition = array('greeting_type' => 'postal_greeting');
2127       $this->optionValueQuery(
2128         $name, $op, $value, $grouping,
2129         CRM_Core_PseudoConstant::greeting($filterCondition),
2130         $field,
2131         ts('Postal Greeting')
2132       );
2133     }
2134     elseif ($name === 'addressee') {
2135       $filterCondition = array('greeting_type' => 'addressee');
2136       $this->optionValueQuery(
2137         $name, $op, $value, $grouping,
2138         CRM_Core_PseudoConstant::greeting($filterCondition),
2139         $field,
2140         ts('Addressee')
2141       );
2142     }
2143     elseif (substr($name, 0, 4) === 'url-') {
2144       $tName = 'civicrm_website';
2145       $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2146       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2147       if ($wildcard) {
2148         $value = "%$value%";
2149         $op = 'LIKE';
2150       }
2151
2152       $wc = 'civicrm_website.url';
2153       $this->_where[$grouping][] = $d = self::buildClause($wc, $op, $value);
2154       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2155     }
2156     elseif ($name === 'contact_is_deleted') {
2157       $this->_where[$grouping][] = self::buildClause("contact_a.is_deleted", $op, $value);
2158       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2159     }
2160     elseif (!empty($field['where'])) {
2161       $type = NULL;
2162       if (!empty($field['type'])) {
2163         $type = CRM_Utils_Type::typeToString($field['type']);
2164       }
2165
2166       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2167
2168       if (isset($locType[1]) &&
2169         is_numeric($locType[1])
2170       ) {
2171         $setTables = FALSE;
2172
2173         //get the location name
2174         list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
2175
2176         $fieldName = "LOWER(`$tName`.$fldName)";
2177
2178         // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2179         $this->_tables[$tName] = $this->_whereTables[$tName] = 1;
2180
2181       }
2182       else {
2183         if ($tableName == 'civicrm_contact') {
2184           $fieldName = "LOWER(contact_a.{$fieldName})";
2185         }
2186         else {
2187           if ($op != 'IN' && !is_numeric($value)) {
2188             $fieldName = "LOWER({$field['where']})";
2189           }
2190           else {
2191             $fieldName = "{$field['where']}";
2192           }
2193         }
2194       }
2195
2196       list($qillop, $qillVal) = self::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2197       $this->_qill[$grouping][] = "$field[title] $qillop '$qillVal'";
2198
2199       if (is_array($value)) {
2200         // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2201         // for api style operators for functions that hit this point without worrying about regression
2202         // (the previous comments indicated the condition for hitting this point were unknown
2203         // per CRM-14743 we are adding modified_date & created_date operator support
2204         $operations = array_keys($value);
2205         foreach ($operations as $operator) {
2206           if (!in_array($operator, CRM_Core_DAO::acceptedSQLOperators())) {
2207             //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2208             //so this condition will satisfy the search for now
2209             if (strpos($op, 'IN') !== FALSE) {
2210               $value = array($op => $value);
2211             }
2212             // we don't know when this might happen
2213             else {
2214               CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2215             }
2216           }
2217         }
2218         $this->_where[$grouping][] = CRM_Core_DAO::createSQLFilter($fieldName, $value, $type);
2219       }
2220       else {
2221         if ($op != 'IN') {
2222           $value = $strtolower($value);
2223         }
2224         if ($wildcard) {
2225           $value = "%$value%";
2226           $op = 'LIKE';
2227         }
2228
2229         $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type);
2230       }
2231     }
2232
2233     if ($setTables && isset($field['where'])) {
2234       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2235       if (isset($tableName)) {
2236         $this->_tables[$tableName] = 1;
2237         $this->_whereTables[$tableName] = 1;
2238       }
2239     }
2240   }
2241
2242
2243   /**
2244    * @param $where
2245    * @param $locType
2246    *
2247    * @return array
2248    * @throws Exception
2249    */
2250   public static function getLocationTableName(&$where, &$locType) {
2251     if (isset($locType[1]) && is_numeric($locType[1])) {
2252       list($tbName, $fldName) = explode(".", $where);
2253
2254       //get the location name
2255       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
2256       $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2257       if (in_array($locType[0], $specialFields)) {
2258         //hack to fix / special handing for phone_ext
2259         if ($locType[0] == 'phone_ext') {
2260           $locType[0] = 'phone';
2261         }
2262         if (isset($locType[2]) && $locType[2]) {
2263           $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2264         }
2265         else {
2266           $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2267         }
2268       }
2269       elseif (in_array($locType[0],
2270         array(
2271           'address_name',
2272           'street_address',
2273           'supplemental_address_1',
2274           'supplemental_address_2',
2275           'city',
2276           'postal_code',
2277           'postal_code_suffix',
2278           'geo_code_1',
2279           'geo_code_2',
2280         )
2281       )) {
2282         //fix for search by profile with address fields.
2283         $tName = "{$locationType[$locType[1]]}-address";
2284       }
2285       elseif ($locType[0] == 'on_hold') {
2286         $tName = "{$locationType[$locType[1]]}-email";
2287       }
2288       else {
2289         $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2290       }
2291       $tName = str_replace(' ', '_', $tName);
2292       return array($tName, $fldName);
2293     }
2294     CRM_Core_Error::fatal();
2295   }
2296
2297   /**
2298    * Given a result dao, extract the values and return that array
2299    *
2300    * @param CRM_Core_DAO $dao
2301    *
2302    * @return array
2303    *   values for this query
2304    */
2305   public function store($dao) {
2306     $value = array();
2307
2308     foreach ($this->_element as $key => $dontCare) {
2309       if (property_exists($dao, $key)) {
2310         if (strpos($key, '-') !== FALSE) {
2311           $values = explode('-', $key);
2312           $lastElement = array_pop($values);
2313           $current = &$value;
2314           $cnt = count($values);
2315           $count = 1;
2316           foreach ($values as $v) {
2317             if (!array_key_exists($v, $current)) {
2318               $current[$v] = array();
2319             }
2320             //bad hack for im_provider
2321             if ($lastElement == 'provider_id') {
2322               if ($count < $cnt) {
2323                 $current = &$current[$v];
2324               }
2325               else {
2326                 $lastElement = "{$v}_{$lastElement}";
2327               }
2328             }
2329             else {
2330               $current = &$current[$v];
2331             }
2332             $count++;
2333           }
2334
2335           $current[$lastElement] = $dao->$key;
2336         }
2337         else {
2338           $value[$key] = $dao->$key;
2339         }
2340       }
2341     }
2342     return $value;
2343   }
2344
2345   /**
2346    * Getter for tables array.
2347    *
2348    * @return array
2349    */
2350   public function tables() {
2351     return $this->_tables;
2352   }
2353
2354   /**
2355    * Where tables is sometimes used to create the from clause, but, not reliably, set this AND set tables
2356    * It's unclear the intent - there is a 'simpleFrom' clause which takes whereTables into account & a fromClause which doesn't
2357    * logic may have eroded
2358    * @return array
2359    */
2360   public function whereTables() {
2361     return $this->_whereTables;
2362   }
2363
2364   /**
2365    * Generate the where clause (used in match contacts and permissions)
2366    *
2367    * @param array $params
2368    * @param array $fields
2369    * @param array $tables
2370    * @param $whereTables
2371    * @param bool $strict
2372    *
2373    * @return string
2374    */
2375   public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2376     $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2377       FALSE, $strict
2378     );
2379
2380     $tables = array_merge($query->tables(), $tables);
2381     $whereTables = array_merge($query->whereTables(), $whereTables);
2382
2383     return $query->_whereClause;
2384   }
2385
2386   /**
2387    * Create the from clause.
2388    *
2389    * @param array $tables
2390    *   Tables that need to be included in this from clause.
2391    *                      if null, return mimimal from clause (i.e. civicrm_contact)
2392    * @param array $inner
2393    *   Tables that should be inner-joined.
2394    * @param array $right
2395    *   Tables that should be right-joined.
2396    *
2397    * @param bool $primaryLocation
2398    * @param int $mode
2399    *
2400    * @return string
2401    *   the from clause
2402    */
2403   public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2404
2405     $from = ' FROM civicrm_contact contact_a';
2406     if (empty($tables)) {
2407       return $from;
2408     }
2409
2410     if (!empty($tables['civicrm_worldregion'])) {
2411       $tables = array_merge(array('civicrm_country' => 1), $tables);
2412     }
2413
2414     if ((!empty($tables['civicrm_state_province']) || !empty($tables['civicrm_country']) ||
2415         CRM_Utils_Array::value('civicrm_county', $tables)
2416       ) && empty($tables['civicrm_address'])
2417     ) {
2418       $tables = array_merge(array('civicrm_address' => 1),
2419         $tables
2420       );
2421     }
2422
2423     // add group_contact and group_contact_cache table if group table is present
2424     if (!empty($tables['civicrm_group'])) {
2425       if (empty($tables['civicrm_group_contact'])) {
2426         $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added' ";
2427       }
2428       if (empty($tables['civicrm_group_contact_cache'])) {
2429         $tables['civicrm_group_contact_cache'] = " LEFT JOIN civicrm_group_contact_cache ON civicrm_group_contact_cache.contact_id = contact_a.id ";
2430       }
2431     }
2432
2433     // add group_contact and group table is subscription history is present
2434     if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2435       $tables = array_merge(array(
2436           'civicrm_group' => 1,
2437           'civicrm_group_contact' => 1,
2438         ),
2439         $tables
2440       );
2441     }
2442
2443     // to handle table dependencies of components
2444     CRM_Core_Component::tableNames($tables);
2445     // to handle table dependencies of hook injected tables
2446     CRM_Contact_BAO_Query_Hook::singleton()->setTableDependency($tables);
2447
2448     //format the table list according to the weight
2449     $info = CRM_Core_TableHierarchy::info();
2450
2451     foreach ($tables as $key => $value) {
2452       $k = 99;
2453       if (strpos($key, '-') !== FALSE) {
2454         $keyArray = explode('-', $key);
2455         $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99);
2456       }
2457       elseif (strpos($key, '_') !== FALSE) {
2458         $keyArray = explode('_', $key);
2459         if (is_numeric(array_pop($keyArray))) {
2460           $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99);
2461         }
2462         else {
2463           $k = CRM_Utils_Array::value($key, $info, 99);
2464         }
2465       }
2466       else {
2467         $k = CRM_Utils_Array::value($key, $info, 99);
2468       }
2469       $tempTable[$k . ".$key"] = $key;
2470     }
2471     ksort($tempTable);
2472     $newTables = array();
2473     foreach ($tempTable as $key) {
2474       $newTables[$key] = $tables[$key];
2475     }
2476
2477     $tables = $newTables;
2478
2479     foreach ($tables as $name => $value) {
2480       if (!$value) {
2481         continue;
2482       }
2483
2484       if (!empty($inner[$name])) {
2485         $side = 'INNER';
2486       }
2487       elseif (!empty($right[$name])) {
2488         $side = 'RIGHT';
2489       }
2490       else {
2491         $side = 'LEFT';
2492       }
2493
2494       if ($value != 1) {
2495         // if there is already a join statement in value, use value itself
2496         if (strpos($value, 'JOIN')) {
2497           $from .= " $value ";
2498         }
2499         else {
2500           $from .= " $side JOIN $name ON ( $value ) ";
2501         }
2502         continue;
2503       }
2504       switch ($name) {
2505         case 'civicrm_address':
2506           if ($primaryLocation) {
2507             $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2508           }
2509           else {
2510             //CRM-14263 further handling of address joins further down...
2511             $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2512           }
2513           continue;
2514
2515         case 'civicrm_phone':
2516           $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2517           continue;
2518
2519         case 'civicrm_email':
2520           $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2521           continue;
2522
2523         case 'civicrm_im':
2524           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2525           continue;
2526
2527         case 'im_provider':
2528           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2529           $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2530           $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)";
2531           continue;
2532
2533         case 'civicrm_openid':
2534           $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2535           continue;
2536
2537         case 'civicrm_worldregion':
2538           $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2539           $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2540           continue;
2541
2542         case 'civicrm_location_type':
2543           $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2544           continue;
2545
2546         case 'civicrm_group':
2547           $from .= " $side JOIN civicrm_group ON (civicrm_group.id = civicrm_group_contact.group_id OR civicrm_group.id = civicrm_group_contact_cache.group_id) ";
2548           continue;
2549
2550         case 'civicrm_group_contact':
2551           $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2552           continue;
2553
2554         case 'civicrm_group_contact_cache':
2555           $from .= " $side JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id ";
2556           continue;
2557
2558         case 'civicrm_activity':
2559         case 'civicrm_activity_tag':
2560         case 'activity_type':
2561         case 'activity_status':
2562         case 'parent_id':
2563         case 'civicrm_activity_contact':
2564         case 'source_contact':
2565           $from .= CRM_Activity_BAO_Query::from($name, $mode, $side);
2566           continue;
2567
2568         case 'civicrm_entity_tag':
2569           $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2570                                                               civicrm_entity_tag.entity_id = contact_a.id ) ";
2571           continue;
2572
2573         case 'civicrm_note':
2574           $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2575                                                         contact_a.id = civicrm_note.entity_id ) ";
2576           continue;
2577
2578         case 'civicrm_subscription_history':
2579           $from .= " $side JOIN civicrm_subscription_history
2580                                    ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2581                                   AND civicrm_group_contact.group_id =  civicrm_subscription_history.group_id";
2582           continue;
2583
2584         case 'civicrm_relationship':
2585           if (self::$_relType == 'reciprocal') {
2586             if (self::$_relationshipTempTable) {
2587               // we have a temptable to join on
2588               $tbl = self::$_relationshipTempTable;
2589               $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2590             }
2591             else {
2592               $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2593               $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)";
2594             }
2595           }
2596           elseif (self::$_relType == 'b') {
2597             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2598             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2599           }
2600           else {
2601             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2602             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2603           }
2604           continue;
2605
2606         case 'civicrm_log':
2607           $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2608           $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2609           continue;
2610
2611         case 'civicrm_tag':
2612           $from .= " $side  JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2613           continue;
2614
2615         case 'civicrm_grant':
2616           $from .= CRM_Grant_BAO_Query::from($name, $mode, $side);
2617           continue;
2618
2619         case 'civicrm_website':
2620           $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2621           continue;
2622
2623         default:
2624           $locationTypeName = '';
2625           if (strpos($name, '-address') != 0) {
2626             $locationTypeName = 'address';
2627           }
2628           elseif (strpos($name, '-phone') != 0) {
2629             $locationTypeName = 'phone';
2630           }
2631           elseif (strpos($name, '-email') != 0) {
2632             $locationTypeName = 'email';
2633           }
2634           if ($locationTypeName) {
2635             //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2636             $parts = explode('-', $name);
2637             $locationID = array_search($parts[0], CRM_Core_BAO_Address::buildOptions('location_type_id', 'get', array('name' => $parts[0])));
2638             $from .= " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2639           }
2640           else {
2641             $from .= CRM_Core_Component::from($name, $mode, $side);
2642           }
2643           $from .= CRM_Contact_BAO_Query_Hook::singleton()->buildSearchfrom($name, $mode, $side);
2644
2645           continue;
2646       }
2647     }
2648     return $from;
2649   }
2650
2651   /**
2652    * WHERE / QILL clause for deleted_contacts
2653    *
2654    * @param $values
2655    *
2656    * @return void
2657    */
2658   public function deletedContacts($values) {
2659     list($_, $_, $value, $grouping, $_) = $values;
2660     if ($value) {
2661       // *prepend* to the relevant grouping as this is quite an important factor
2662       array_unshift($this->_qill[$grouping], ts('Search in Trash'));
2663     }
2664   }
2665
2666   /**
2667    * Where / qill clause for contact_type
2668    *
2669    * @param $values
2670    *
2671    * @return void
2672    */
2673   public function contactType(&$values) {
2674     list($name, $op, $value, $grouping, $wildcard) = $values;
2675
2676     $subTypes = array();
2677     $clause = array();
2678
2679     // account for search builder mapping multiple values
2680     if (!is_array($value)) {
2681       $values = self::parseSearchBuilderString($value, 'String');
2682       if (is_array($values)) {
2683         $value = array_flip($values);
2684       }
2685     }
2686
2687     if (is_array($value)) {
2688       foreach ($value as $k => $v) {
2689         // fix for CRM-771
2690         if ($k) {
2691           $subType = NULL;
2692           $contactType = $k;
2693           if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) {
2694             list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2);
2695           }
2696
2697           if (!empty($subType)) {
2698             $subTypes[$subType] = 1;
2699           }
2700           $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2701         }
2702       }
2703     }
2704     else {
2705       $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2);
2706       $contactType = $contactTypeANDSubType[0];
2707       $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType);
2708       if (!empty($subType)) {
2709         $subTypes[$subType] = 1;
2710       }
2711       $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2712     }
2713
2714     // fix for CRM-771
2715     if (!empty($clause)) {
2716       $quill = $clause;
2717       if ($op == 'IN' || $op == 'NOT IN') {
2718         $this->_where[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2719       }
2720       else {
2721         $type = array_pop($clause);
2722         $this->_where[$grouping][] = self::buildClause("contact_a.contact_type", $op, $contactType);
2723       }
2724
2725       $this->_qill[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2726
2727       if (!empty($subTypes)) {
2728         $this->includeContactSubTypes($subTypes, $grouping);
2729       }
2730     }
2731   }
2732
2733   /**
2734    * Where / qill clause for contact_sub_type
2735    *
2736    * @param $values
2737    *
2738    * @return void
2739    */
2740   public function contactSubType(&$values) {
2741     list($name, $op, $value, $grouping, $wildcard) = $values;
2742     $this->includeContactSubTypes($value, $grouping, $op);
2743   }
2744
2745   /**
2746    * @param $value
2747    * @param $grouping
2748    * @param string $op
2749    */
2750   public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2751
2752     $clause = array();
2753     $alias = "contact_a.contact_sub_type";
2754     $qillOperators = array('NOT LIKE' => ts('Not Like')) + CRM_Core_SelectValues::getSearchBuilderOperators();
2755
2756     $op = str_replace('IN', 'LIKE', $op);
2757     $op = str_replace('=', 'LIKE', $op);
2758     $op = str_replace('!', 'NOT ', $op);
2759
2760     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
2761       $this->_where[$grouping][] = self::buildClause($alias, $op, $value, 'String');
2762     }
2763     elseif (is_array($value)) {
2764       foreach ($value as $k => $v) {
2765         if (!empty($k)) {
2766           $clause[$k] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($k, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2767         }
2768       }
2769     }
2770     else {
2771       $clause[$value] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2772     }
2773
2774     if (!empty($clause)) {
2775       $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2776     }
2777     $this->_qill[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2778   }
2779
2780   /**
2781    * Where / qill clause for groups
2782    *
2783    * @param $values
2784    *
2785    * @return void
2786    */
2787   public function group(&$values) {
2788     list($name, $op, $value, $grouping, $wildcard) = $values;
2789
2790     // Replace pseudo operators from search builder
2791     $op = str_replace('EMPTY', 'NULL', $op);
2792
2793     if (count($value) > 1) {
2794       if (strpos($op, 'IN') === FALSE && strpos($op, 'NULL') === FALSE) {
2795         CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $op)));
2796       }
2797       $this->_useDistinct = TRUE;
2798     }
2799
2800     $groupIds = NULL;
2801     $names = array();
2802     $isSmart = FALSE;
2803     $isNotOp = ($op == 'NOT IN' || $op == '!=');
2804
2805     if ($value) {
2806       if (strpos($op, 'IN') === FALSE) {
2807         $value = key($value);
2808       }
2809       else {
2810         $value = array_keys($value);
2811       }
2812     }
2813
2814     $statii = array();
2815     $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2816     if ($gcsValues &&
2817       is_array($gcsValues[2])
2818     ) {
2819       foreach ($gcsValues[2] as $k => $v) {
2820         if ($v) {
2821           $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
2822         }
2823       }
2824     }
2825     else {
2826       $statii[] = '"Added"';
2827     }
2828
2829     $skipGroup = FALSE;
2830     if (!is_array($value) &&
2831       count($statii) == 1 &&
2832       $statii[0] == '"Added"' &&
2833       !$isNotOp
2834     ) {
2835       if (!empty($value) && CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $value, 'saved_search_id')) {
2836         $isSmart = TRUE;
2837       }
2838     }
2839
2840     $ssClause = $this->addGroupContactCache($value, NULL, "contact_a", $op);
2841     $isSmart = (!$ssClause) ? FALSE : $isSmart;
2842     $groupClause = NULL;
2843
2844     if (!$isSmart) {
2845       $groupIds = implode(',', (array) $value);
2846       $gcTable = "`civicrm_group_contact-{$groupIds}`";
2847       $joinClause = array("contact_a.id = {$gcTable}.contact_id");
2848       if ($statii) {
2849         $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
2850       }
2851       $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
2852       $groupClause = "{$gcTable}.group_id $op $groupIds";
2853       if (strpos($op, 'IN') !== FALSE) {
2854         $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2855       }
2856     }
2857
2858     if ($ssClause) {
2859       $and = ($op == 'IS NULL') ? 'AND' : 'OR';
2860       if ($groupClause) {
2861         $groupClause = "( ( $groupClause ) $and ( $ssClause ) )";
2862       }
2863       else {
2864         $groupClause = $ssClause;
2865       }
2866     }
2867
2868     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Group', 'id', $value, $op);
2869     $this->_qill[$grouping][] = ts("Group(s) %1 %2", array(1 => $qillop, 2 => $qillVal));
2870     if (strpos($op, 'NULL') === FALSE) {
2871       $this->_qill[$grouping][] = ts("Group Status %1", array(1 => implode(' ' . ts('or') . ' ', $statii)));
2872     }
2873     if ($groupClause) {
2874       $this->_where[$grouping][] = $groupClause;
2875     }
2876   }
2877
2878   /**
2879    * Function translates selection of group type into a list of groups.
2880    * @param $value
2881    *
2882    * @return array
2883    */
2884   public function getGroupsFromTypeCriteria($value) {
2885     $groupIds = array();
2886     foreach ((array) $value as $groupTypeValue) {
2887       $groupList = CRM_Core_PseudoConstant::group($groupTypeValue);
2888       $groupIds = ($groupIds + $groupList);
2889     }
2890     return $groupIds;
2891   }
2892
2893   /**
2894    * @param array $groups
2895    * @param string $tableAlias
2896    * @param string $joinTable
2897    * @param string $op
2898    *
2899    * @return null|string
2900    */
2901   public function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a", $op) {
2902     $isNullOp = (strpos($op, 'NULL') !== FALSE);
2903     $groupsIds = $groups;
2904     if (!$isNullOp && !$groups) {
2905       return NULL;
2906     }
2907     elseif (strpos($op, 'IN') !== FALSE) {
2908       $groups = array($op => $groups);
2909     }
2910     elseif (is_array($groups) && count($groups)) {
2911       $groups = array('IN' => $groups);
2912     }
2913
2914     // Find all the groups that are part of a saved search.
2915     $smartGroupClause = self::buildClause("id", $op, $groups, 'Int');
2916     $sql = "
2917 SELECT id, cache_date, saved_search_id, children
2918 FROM   civicrm_group
2919 WHERE  $smartGroupClause
2920   AND  ( saved_search_id != 0
2921    OR    saved_search_id IS NOT NULL
2922    OR    children IS NOT NULL )
2923 ";
2924
2925     $group = CRM_Core_DAO::executeQuery($sql);
2926
2927     while ($group->fetch()) {
2928       $this->_useDistinct = TRUE;
2929       if (!$this->_smartGroupCache || $group->cache_date == NULL) {
2930         CRM_Contact_BAO_GroupContactCache::load($group);
2931       }
2932     }
2933
2934     if (!$tableAlias) {
2935       $tableAlias = "`civicrm_group_contact_cache_";
2936       $tableAlias .= ($isNullOp) ? "a`" : implode(',', (array) $groupsIds) . "`";
2937     }
2938
2939     $this->_tables[$tableAlias] = $this->_whereTables[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.id = {$tableAlias}.contact_id ";
2940     return self::buildClause("{$tableAlias}.group_id", $op, $groups, 'Int');
2941   }
2942
2943   /**
2944    * Where / qill clause for cms users
2945    *
2946    * @param $values
2947    *
2948    * @return void
2949    */
2950   public function ufUser(&$values) {
2951     list($name, $op, $value, $grouping, $wildcard) = $values;
2952
2953     if ($value == 1) {
2954       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2955
2956       $this->_qill[$grouping][] = ts('CMS User');
2957     }
2958     elseif ($value == 0) {
2959       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2960
2961       $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2962       $this->_qill[$grouping][] = ts('Not a CMS User');
2963     }
2964   }
2965
2966   /**
2967    * All tag search specific.
2968    *
2969    * @param $values
2970    *
2971    * @return void
2972    */
2973   public function tagSearch(&$values) {
2974     list($name, $op, $value, $grouping, $wildcard) = $values;
2975
2976     $op = "LIKE";
2977     $value = "%{$value}%";
2978
2979     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2980     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2981
2982     $etTable = "`civicrm_entity_tag-" . $value . "`";
2983     $tTable = "`civicrm_tag-" . $value . "`";
2984
2985     if ($useAllTagTypes[2]) {
2986       $this->_tables[$etTable] = $this->_whereTables[$etTable]
2987         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2988             LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  )";
2989
2990       // search tag in cases
2991       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2992       $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2993       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
2994         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2995             LEFT JOIN civicrm_case
2996             ON (civicrm_case_contact.case_id = civicrm_case.id
2997                 AND civicrm_case.is_deleted = 0 )
2998             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2999             LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id  )";
3000       // search tag in activities
3001       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3002       $tActTable = "`civicrm_act_tag-" . $value . "`";
3003       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3004       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3005
3006       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3007         = " LEFT JOIN civicrm_activity_contact
3008             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3009             LEFT JOIN civicrm_activity
3010             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3011             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3012             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3013             LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id  )";
3014
3015       $this->_where[$grouping][] = "({$tTable}.name $op '" . $value . "' OR {$tCaseTable}.name $op '" . $value . "' OR {$tActTable}.name $op '" . $value . "')";
3016       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3017     }
3018     else {
3019       $etTable = "`civicrm_entity_tag-" . $value . "`";
3020       $tTable = "`civicrm_tag-" . $value . "`";
3021       $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND
3022       {$etTable}.entity_table = 'civicrm_contact' )
3023                 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  ) ";
3024
3025       $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String');
3026       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3027     }
3028   }
3029
3030   /**
3031    * Where / qill clause for tag
3032    *
3033    * @param $values
3034    *
3035    * @return void
3036    */
3037   public function tag(&$values) {
3038     list($name, $op, $value, $grouping, $wildcard) = $values;
3039
3040     $tagNames = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
3041     if (is_array($value)) {
3042       if (count($value) > 1) {
3043         $this->_useDistinct = TRUE;
3044       }
3045       foreach ($value as $id => $dontCare) {
3046         $names[] = CRM_Utils_Array::value($id, $tagNames);
3047       }
3048       $names = implode(' ' . ts('or') . ' ', $names);
3049       $value = implode(',', array_keys($value));
3050     }
3051     else {
3052       $names = CRM_Utils_Array::value($value, $tagNames);
3053     }
3054
3055     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3056     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3057
3058     $etTable = "`civicrm_entity_tag-" . $value . "`";
3059
3060     if ($useAllTagTypes[2]) {
3061       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3062         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3063
3064       // search tag in cases
3065       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3066       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3067       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3068
3069       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3070         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3071             LEFT JOIN civicrm_case
3072             ON (civicrm_case_contact.case_id = civicrm_case.id
3073                 AND civicrm_case.is_deleted = 0 )
3074             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3075       // search tag in activities
3076       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3077       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3078         = " LEFT JOIN civicrm_activity_contact
3079             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3080             LEFT JOIN civicrm_activity
3081             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3082             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3083             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3084
3085       // CRM-10338
3086       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3087         $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3088       }
3089       else {
3090         $this->_where[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3091       }
3092       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
3093     }
3094     else {
3095       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3096         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3097
3098       // CRM-10338
3099       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3100         // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3101         $op = str_replace('EMPTY', 'NULL', $op);
3102         $this->_where[$grouping][] = "{$etTable}.tag_id $op";
3103       }
3104       else {
3105         $this->_where[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
3106       }
3107       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $names;
3108     }
3109
3110   }
3111
3112   /**
3113    * Where/qill clause for notes
3114    *
3115    * @param $values
3116    *
3117    * @return void
3118    */
3119   public function notes(&$values) {
3120     list($name, $op, $value, $grouping, $wildcard) = $values;
3121
3122     $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3123     $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6');
3124     $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption);
3125
3126     $this->_useDistinct = TRUE;
3127
3128     $this->_tables['civicrm_note'] = $this->_whereTables['civicrm_note']
3129       = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3130
3131     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3132     $n = trim($value);
3133     $value = $strtolower(CRM_Core_DAO::escapeString($n));
3134     if ($wildcard || $op == 'LIKE') {
3135       if (strpos($value, '%') === FALSE) {
3136         $value = "%$value%";
3137       }
3138       $op = 'LIKE';
3139     }
3140     elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') {
3141       $value = NULL;
3142     }
3143
3144     $label = NULL;
3145     $clauses = array();
3146     if ($noteOption % 2 == 0) {
3147       $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String');
3148       $label = ts('Note: Body Only');
3149     }
3150     if ($noteOption % 3 == 0) {
3151       $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String');
3152       $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only');
3153     }
3154     $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3155     $this->_qill[$grouping][] = $label . " $op - '$n'";
3156   }
3157
3158   /**
3159    * @param string $name
3160    * @param $op
3161    * @param $grouping
3162    *
3163    * @return bool
3164    */
3165   public function nameNullOrEmptyOp($name, $op, $grouping) {
3166     switch ($op) {
3167       case 'IS NULL':
3168       case 'IS NOT NULL':
3169         $this->_where[$grouping][] = "contact_a.$name $op";
3170         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3171         return TRUE;
3172
3173       case 'IS EMPTY':
3174         $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3175         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3176         return TRUE;
3177
3178       case 'IS NOT EMPTY':
3179         $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3180         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3181         return TRUE;
3182
3183       default:
3184         return FALSE;
3185     }
3186   }
3187
3188   /**
3189    * Where / qill clause for sort_name
3190    *
3191    * @param $values
3192    *
3193    * @return void
3194    */
3195   public function sortName(&$values) {
3196     list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3197
3198     // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3199     if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3200       return;
3201     }
3202
3203     $input = $value = trim($value);
3204
3205     if (!strlen($value)) {
3206       return;
3207     }
3208
3209     $config = CRM_Core_Config::singleton();
3210
3211     $sub = array();
3212
3213     //By default, $sub elements should be joined together with OR statements (don't change this variable).
3214     $subGlue = ' OR ';
3215
3216     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3217
3218     $firstChar = substr($value, 0, 1);
3219     $lastChar = substr($value, -1, 1);
3220     $quotes = array("'", '"');
3221     // If string is quoted, strip quotes and otherwise don't alter it
3222     if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3223       $value = trim($value, implode('', $quotes));
3224     }
3225     // Replace spaces with wildcards for a LIKE operation
3226     // UNLESS string contains a comma (this exception is a tiny bit questionable)
3227     elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3228       $value = str_replace(' ', '%', $value);
3229     }
3230     $value = $strtolower(CRM_Core_DAO::escapeString(trim($value)));
3231     if (strlen($value)) {
3232       $fieldsub = array();
3233       if ($wildcard && $op == 'LIKE') {
3234         if ($config->includeWildCardInName) {
3235           $value = "'%$value%'";
3236         }
3237         else {
3238           $value = "'$value%'";
3239         }
3240         $op = 'LIKE';
3241       }
3242       else {
3243         $value = "'$value'";
3244       }
3245       if ($fieldName == 'sort_name') {
3246         $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3247       }
3248       else {
3249         $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name";
3250       }
3251       $fieldsub[] = " ( $wc $op $value )";
3252       if ($config->includeNickNameInName) {
3253         $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3254         $fieldsub[] = " ( $wc $op $value )";
3255       }
3256       if ($config->includeEmailInName) {
3257         $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3258       }
3259       $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3260     }
3261
3262     $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3263
3264     $this->_where[$grouping][] = $sub;
3265     if ($config->includeEmailInName) {
3266       $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3267       $this->_qill[$grouping][] = ts('Name or Email') . " $op - '$input'";
3268     }
3269     else {
3270       $this->_qill[$grouping][] = ts('Name') . " $op - '$input'";
3271     }
3272   }
3273
3274   /**
3275    * Where/qill clause for greeting fields.
3276    *
3277    * @param array $values
3278    */
3279   public function greetings(&$values) {
3280     list($name, $op, $value, $grouping, $wildcard) = $values;
3281     $name .= '_display';
3282
3283     $this->_qill[$grouping][] = ts('Greeting %1 %2', array(1 => $op, 2 => $value));
3284     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", 'LIKE', "$value", 'String');
3285   }
3286
3287   /**
3288    * Where / qill clause for email
3289    *
3290    * @param $values
3291    *
3292    * @return void
3293    */
3294   public function email(&$values) {
3295     list($name, $op, $value, $grouping, $wildcard) = $values;
3296
3297     $n = trim($value);
3298     if ($n) {
3299       $config = CRM_Core_Config::singleton();
3300
3301       if (substr($n, 0, 1) == '"' &&
3302         substr($n, -1, 1) == '"'
3303       ) {
3304         $n = substr($n, 1, -1);
3305         $value = strtolower(CRM_Core_DAO::escapeString($n));
3306         $value = "'$value'";
3307         $op = '=';
3308       }
3309       else {
3310         $value = strtolower($n);
3311         if ($wildcard) {
3312           if (strpos($value, '%') === FALSE) {
3313             $value = "%{$value}%";
3314           }
3315           $op = 'LIKE';
3316         }
3317       }
3318       $this->_qill[$grouping][] = ts('Email') . " $op '$n'";
3319       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String');
3320     }
3321     else {
3322       $this->_qill[$grouping][] = ts('Email') . " $op ";
3323       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String');
3324     }
3325
3326     $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3327   }
3328
3329   /**
3330    * Where / qill clause for phone number
3331    *
3332    * @param $values
3333    *
3334    * @return void
3335    */
3336   public function phone_numeric(&$values) {
3337     list($name, $op, $value, $grouping, $wildcard) = $values;
3338     // Strip non-numeric characters; allow wildcards
3339     $number = preg_replace('/[^\d%]/', '', $value);
3340     if ($number) {
3341       if (strpos($number, '%') === FALSE) {
3342         $number = "%$number%";
3343       }
3344
3345       $this->_qill[$grouping][] = ts('Phone number contains') . " $number";
3346       $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3347       $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3348     }
3349   }
3350
3351   /**
3352    * Where / qill clause for phone type/location
3353    *
3354    * @param $values
3355    *
3356    * @return void
3357    */
3358   public function phone_option_group($values) {
3359     list($name, $op, $value, $grouping, $wildcard) = $values;
3360     $option = ($name == 'phone_phone_type_id' ? 'phone_type_id' : 'location_type_id');
3361     $options = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', $option);
3362     $optionName = $options[$value];
3363     $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName";
3364     $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3365     $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3366   }
3367
3368   /**
3369    * Where / qill clause for street_address
3370    *
3371    * @param $values
3372    *
3373    * @return void
3374    */
3375   public function street_address(&$values) {
3376     list($name, $op, $value, $grouping, $wildcard) = $values;
3377
3378     if (!$op) {
3379       $op = 'LIKE';
3380     }
3381
3382     $n = trim($value);
3383
3384     if ($n) {
3385       $value = strtolower($n);
3386       if (strpos($value, '%') === FALSE) {
3387         // only add wild card if not there
3388         $value = "%{$value}%";
3389       }
3390       $op = 'LIKE';
3391       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3392       $this->_qill[$grouping][] = ts('Street') . " $op '$n'";
3393     }
3394     else {
3395       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3396       $this->_qill[$grouping][] = ts('Street') . " $op ";
3397     }
3398
3399     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3400   }
3401
3402   /**
3403    * Where / qill clause for street_unit
3404    *
3405    * @param $values
3406    *
3407    * @return void
3408    */
3409   public function street_number(&$values) {
3410     list($name, $op, $value, $grouping, $wildcard) = $values;
3411
3412     if (!$op) {
3413       $op = '=';
3414     }
3415
3416     $n = trim($value);
3417
3418     if (strtolower($n) == 'odd') {
3419       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3420       $this->_qill[$grouping][] = ts('Street Number is odd');
3421     }
3422     elseif (strtolower($n) == 'even') {
3423       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3424       $this->_qill[$grouping][] = ts('Street Number is even');
3425     }
3426     else {
3427       $value = strtolower($n);
3428
3429       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3430       $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'";
3431     }
3432
3433     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3434   }
3435
3436   /**
3437    * Where / qill clause for sorting by character
3438    *
3439    * @param $values
3440    *
3441    * @return void
3442    */
3443   public function sortByCharacter(&$values) {
3444     list($name, $op, $value, $grouping, $wildcard) = $values;
3445
3446     $name = trim($value);
3447     $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'";
3448     $this->_where[$grouping][] = $cond;
3449     $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3450   }
3451
3452   /**
3453    * Where / qill clause for including contact ids
3454    *
3455    * @return void
3456    */
3457   public function includeContactIDs() {
3458     if (!$this->_includeContactIds || empty($this->_params)) {
3459       return;
3460     }
3461
3462     $contactIds = array();
3463     foreach ($this->_params as $id => $values) {
3464       if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
3465         $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN);
3466       }
3467     }
3468     if (!empty($contactIds)) {
3469       $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3470     }
3471   }
3472
3473   /**
3474    * Where / qill clause for postal code
3475    *
3476    * @param $values
3477    *
3478    * @return void
3479    */
3480   public function postalCode(&$values) {
3481     // skip if the fields dont have anything to do with postal_code
3482     if (empty($this->_fields['postal_code'])) {
3483       return;
3484     }
3485
3486     list($name, $op, $value, $grouping, $wildcard) = $values;
3487
3488     // Handle numeric postal code range searches properly by casting the column as numeric
3489     if (is_numeric($value)) {
3490       $field = 'ROUND(civicrm_address.postal_code)';
3491       $val = CRM_Utils_Type::escape($value, 'Integer');
3492     }
3493     else {
3494       $field = 'civicrm_address.postal_code';
3495       // Per CRM-17060 we might be looking at an 'IN' syntax so don't case arrays to string.
3496       if (!is_array($value)) {
3497         $val = CRM_Utils_Type::escape($value, 'String');
3498       }
3499       else {
3500         // Do we need to escape values here? I would expect buildClause does.
3501         $val = $value;
3502       }
3503     }
3504
3505     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3506
3507     if ($name == 'postal_code') {
3508       $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String');
3509       $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}";
3510     }
3511     elseif ($name == 'postal_code_low') {
3512       $this->_where[$grouping][] = " ( $field >= '$val' ) ";
3513       $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3514     }
3515     elseif ($name == 'postal_code_high') {
3516       $this->_where[$grouping][] = " ( $field <= '$val' ) ";
3517       $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3518     }
3519   }
3520
3521   /**
3522    * Where / qill clause for location type
3523    *
3524    * @param $values
3525    * @param null $status
3526    *
3527    * @return void
3528    */
3529   public function locationType(&$values, $status = NULL) {
3530     list($name, $op, $value, $grouping, $wildcard) = $values;
3531
3532     if (is_array($value)) {
3533       $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3534       $this->_tables['civicrm_address'] = 1;
3535       $this->_whereTables['civicrm_address'] = 1;
3536
3537       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
3538       $names = array();
3539       foreach ($value as $id) {
3540         $names[] = $locationType[$id];
3541       }
3542
3543       $this->_primaryLocation = FALSE;
3544
3545       if (!$status) {
3546         $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3547       }
3548       else {
3549         return implode(' ' . ts('or') . ' ', $names);
3550       }
3551     }
3552   }
3553
3554   /**
3555    * @param $values
3556    * @param bool $fromStateProvince
3557    *
3558    * @return array|NULL
3559    */
3560   public function country(&$values, $fromStateProvince = TRUE) {
3561     list($name, $op, $value, $grouping, $wildcard) = $values;
3562
3563     if (!$fromStateProvince) {
3564       $stateValues = $this->getWhereValues('state_province', $grouping);
3565       if (!empty($stateValues)) {
3566         // return back to caller if there are state province values
3567         // since that handles this case
3568         return NULL;
3569       }
3570     }
3571
3572     $countryClause = $countryQill = NULL;
3573     if (
3574       $values &&
3575       !empty($value)
3576     ) {
3577
3578       $this->_tables['civicrm_address'] = 1;
3579       $this->_whereTables['civicrm_address'] = 1;
3580
3581       $countries = CRM_Core_PseudoConstant::country();
3582       if (is_numeric($value)) {
3583         $countryClause = self::buildClause(
3584           'civicrm_address.country_id',
3585           $op,
3586           $value,
3587           'Positive'
3588         );
3589         $countryName = $countries[(int ) $value];
3590       }
3591
3592       else {
3593         $intValues = self::parseSearchBuilderString($value);
3594         if ($intValues && ($op == 'IN' || $op == 'NOT IN')) {
3595           $countryClause = self::buildClause(
3596             'civicrm_address.country_id',
3597             $op,
3598             $intValues,
3599             'Positive'
3600           );
3601           $countryNames = array();
3602           foreach ($intValues as $v) {
3603             $countryNames[] = $countries[$v];
3604           }
3605           $countryName = implode(',', $countryNames);
3606         }
3607         else {
3608           $countries = CRM_Core_PseudoConstant::country();
3609           $intVal = CRM_Utils_Array::key($value, $countries);
3610           $countryClause = self::buildClause(
3611             'civicrm_address.country_id',
3612             $op,
3613             $intVal,
3614             'Integer'
3615           );
3616           $countryName = $value;
3617         }
3618       }
3619       $countryQill = ts('Country') . " {$op} '$countryName'";
3620
3621       if (!$fromStateProvince) {
3622         $this->_where[$grouping][] = $countryClause;
3623         $this->_qill[$grouping][] = $countryQill;
3624       }
3625     }
3626
3627     if ($fromStateProvince) {
3628       if (!empty($countryClause)) {
3629         return array(
3630           $countryClause,
3631           " ...AND... " . $countryQill,
3632         );
3633       }
3634       else {
3635         return array(NULL, NULL);
3636       }
3637     }
3638   }
3639
3640   /**
3641    * Where / qill clause for county (if present)
3642    *
3643    * @param $values
3644    * @param null $status
3645    *
3646    * @return void
3647    */
3648   public function county(&$values, $status = NULL) {
3649     list($name, $op, $value, $grouping, $wildcard) = $values;
3650
3651     if (!is_array($value)) {
3652       // force the county to be an array
3653       $value = array($value);
3654     }
3655
3656     // check if the values are ids OR names of the counties
3657     $inputFormat = 'id';
3658     foreach ($value as $v) {
3659       if (!is_numeric($v)) {
3660         $inputFormat = 'name';
3661         break;
3662       }
3663     }
3664     $names = array();
3665     if ($op == '=') {
3666       $op = 'IN';
3667     }
3668     elseif ($op == '!=') {
3669       $op = 'NOT IN';
3670     }
3671     else {
3672       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3673       $op = str_replace('EMPTY', 'NULL', $op);
3674     }
3675
3676     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3677       $clause = "civicrm_address.county_id $op";
3678     }
3679     elseif ($inputFormat == 'id') {
3680       $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3681
3682       $county = CRM_Core_PseudoConstant::county();
3683       foreach ($value as $id) {
3684         $names[] = CRM_Utils_Array::value($id, $county);
3685       }
3686     }
3687     else {
3688       $inputClause = array();
3689       $county = CRM_Core_PseudoConstant::county();
3690       foreach ($value as $name) {
3691         $name = trim($name);
3692         $inputClause[] = CRM_Utils_Array::key($name, $county);
3693       }
3694       $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3695       $names = $value;
3696     }
3697     $this->_tables['civicrm_address'] = 1;
3698     $this->_whereTables['civicrm_address'] = 1;
3699
3700     $this->_where[$grouping][] = $clause;
3701     if (!$status) {
3702       $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3703     }
3704     else {
3705       return implode(' ' . ts('or') . ' ', $names);
3706     }
3707   }
3708
3709   /**
3710    * Where / qill clause for state/province AND country (if present)
3711    *
3712    * @param $values
3713    * @param null $status
3714    *
3715    * @return void
3716    */
3717   public function stateProvince(&$values, $status = NULL) {
3718     list($name, $op, $value, $grouping, $wildcard) = $values;
3719
3720     // quick escape for IS NULL
3721     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3722       $value = NULL;
3723     }
3724     elseif (!is_array($value)) {
3725       // force the state to be an array
3726       // check if its in the mapper format!
3727       $values = self::parseSearchBuilderString($value);
3728       if (is_array($values)) {
3729         $value = $values;
3730       }
3731       else {
3732         $value = array($value);
3733       }
3734     }
3735
3736     // check if the values are ids OR names of the states
3737     $inputFormat = 'id';
3738     if ($value) {
3739       foreach ($value as $v) {
3740         if (!is_numeric($v)) {
3741           $inputFormat = 'name';
3742           break;
3743         }
3744       }
3745     }
3746
3747     $names = array();
3748     if ($op == '=') {
3749       $op = 'IN';
3750     }
3751     elseif ($op == '!=') {
3752       $op = 'NOT IN';
3753     }
3754     else {
3755       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3756       $op = str_replace('EMPTY', 'NULL', $op);
3757     }
3758     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3759       $stateClause = "civicrm_address.state_province_id $op";
3760     }
3761     elseif ($inputFormat == 'id') {
3762       if ($op != 'NOT IN') {
3763         $op = 'IN';
3764       }
3765       $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3766
3767       foreach ($value as $id) {
3768         $names[] = CRM_Core_PseudoConstant::stateProvince($id, FALSE);
3769       }
3770     }
3771     else {
3772       $inputClause = array();
3773       $stateProvince = CRM_Core_PseudoConstant::stateProvince();
3774       foreach ($value as $name) {
3775         $name = trim($name);
3776         $inputClause[] = CRM_Utils_Array::key($name, $stateProvince);
3777       }
3778       $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3779       $names = $value;
3780     }
3781     $this->_tables['civicrm_address'] = 1;
3782     $this->_whereTables['civicrm_address'] = 1;
3783
3784     $countryValues = $this->getWhereValues('country', $grouping);
3785     list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3786
3787     if ($countryClause) {
3788       $clause = "( $stateClause AND $countryClause )";
3789     }
3790     else {
3791       $clause = $stateClause;
3792     }
3793
3794     $this->_where[$grouping][] = $clause;
3795     if (!$status) {
3796       $this->_qill[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3797     }
3798     else {
3799       return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3800     }
3801   }
3802
3803   /**
3804    * Where / qill clause for change log
3805    *
3806    * @param $values
3807    *
3808    * @return void
3809    */
3810   public function changeLog(&$values) {
3811     list($name, $op, $value, $grouping, $wildcard) = $values;
3812
3813     $targetName = $this->getWhereValues('changed_by', $grouping);
3814     if (!$targetName) {
3815       return;
3816     }
3817
3818     $name = trim($targetName[2]);
3819     $name = strtolower(CRM_Core_DAO::escapeString($name));
3820     $name = $targetName[4] ? "%$name%" : $name;
3821     $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3822     $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1;
3823     $this->_qill[$grouping][] = ts('Modified By') . " $name";
3824   }
3825
3826   /**
3827    * @param $values
3828    */
3829   public function modifiedDates($values) {
3830     $this->_useDistinct = TRUE;
3831
3832     // CRM-11281, default to added date if not set
3833     $fieldTitle = ts('Added Date');
3834     $fieldName = 'created_date';
3835     foreach (array_keys($this->_params) as $id) {
3836       if ($this->_params[$id][0] == 'log_date') {
3837         if ($this->_params[$id][2] == 2) {
3838           $fieldTitle = ts('Modified Date');
3839           $fieldName = 'modified_date';
3840         }
3841       }
3842     }
3843
3844     $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3845
3846     self::$_openedPanes[ts('Change Log')] = TRUE;
3847   }
3848
3849   /**
3850    * @param $values
3851    */
3852   public function demographics(&$values) {
3853     list($name, $op, $value, $grouping, $wildcard) = $values;
3854
3855     if (($name == 'age_low') || ($name == 'age_high')) {
3856       $this->ageRangeQueryBuilder($values,
3857         'contact_a', 'age', 'birth_date', ts('Age')
3858       );
3859     }
3860     elseif (($name == 'birth_date_low') || ($name == 'birth_date_high')) {
3861
3862       $this->dateQueryBuilder($values,
3863         'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3864       );
3865     }
3866     elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) {
3867
3868       $this->dateQueryBuilder($values,
3869         'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3870       );
3871     }
3872
3873     self::$_openedPanes[ts('Demographics')] = TRUE;
3874   }
3875
3876   /**
3877    * @param $values
3878    */
3879   public function privacy(&$values) {
3880     list($name, $op, $value, $grouping, $wildcard) = $values;
3881     //fixed for profile search listing CRM-4633
3882     if (strpbrk($value, "[")) {
3883       $value = "'{$value}'";
3884       $op = "!{$op}";
3885       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3886     }
3887     else {
3888       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3889     }
3890     $field = CRM_Utils_Array::value($name, $this->_fields);
3891     $title = $field ? $field['title'] : $name;
3892     $this->_qill[$grouping][] = "$title $op $value";
3893   }
3894
3895   /**
3896    * @param $values
3897    */
3898   public function privacyOptions($values) {
3899     list($name, $op, $value, $grouping, $wildcard) = $values;
3900
3901     if (empty($value) || !is_array($value)) {
3902       return;
3903     }
3904
3905     // get the operator and toggle values
3906     $opValues = $this->getWhereValues('privacy_operator', $grouping);
3907     $operator = 'OR';
3908     if ($opValues &&
3909       strtolower($opValues[2] == 'AND')
3910     ) {
3911       $operator = 'AND';
3912     }
3913
3914     $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3915     $compareOP = '!';
3916     if ($toggleValues &&
3917       $toggleValues[2] == 2
3918     ) {
3919       $compareOP = '';
3920     }
3921
3922     $clauses = array();
3923     $qill = array();
3924     foreach ($value as $dontCare => $pOption) {
3925       $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
3926       $field = CRM_Utils_Array::value($pOption, $this->_fields);
3927       $title = $field ? $field['title'] : $pOption;
3928       $qill[] = " $title = 1 ";
3929     }
3930
3931     $this->_where[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
3932     $this->_qill[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
3933   }
3934
3935   /**
3936    * @param $values
3937    */
3938   public function preferredCommunication(&$values) {
3939     list($name, $op, $value, $grouping, $wildcard) = $values;
3940
3941     $pref = array();
3942     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3943       $value = NULL;
3944     }
3945     elseif (!is_array($value)) {
3946       $v = array();
3947       $value = trim($value, ' ()');
3948       if (strpos($value, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
3949         $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
3950       }
3951       else {
3952         $v = explode(",", $value);
3953       }
3954
3955       foreach ($v as $item) {
3956         if ($item) {
3957           $pref[] = $item;
3958         }
3959       }
3960     }
3961     else {
3962       foreach ($value as $key => $checked) {
3963         if ($checked) {
3964           $pref[] = $key;
3965         }
3966       }
3967     }
3968
3969     $commPref = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
3970
3971     $sqlValue = array();
3972     $showValue = array();
3973     $sql = "contact_a.preferred_communication_method";
3974     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3975       $sqlValue[] = "{$sql} {$op}";
3976     }
3977     else {
3978       foreach ($pref as $val) {
3979         $sqlValue[] = "( $sql like '%" . CRM_Core_DAO::VALUE_SEPARATOR . $val . CRM_Core_DAO::VALUE_SEPARATOR . "%' ) ";
3980         $showValue[] = $commPref[$val];
3981       }
3982     }
3983     $this->_where[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3984     $this->_qill[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3985   }
3986
3987   /**
3988    * Where / qill clause for relationship
3989    *
3990    * @param $values
3991    *
3992    * @return void
3993    */
3994   public function relationship(&$values) {
3995     list($name, $op, $value, $grouping, $wildcard) = $values;
3996     if ($this->_relationshipValuesAdded) {
3997       return;
3998     }
3999     // also get values array for relation_target_name
4000     // for relationship search we always do wildcard
4001     $relationType = $this->getWhereValues('relation_type_id', $grouping);
4002     $targetName = $this->getWhereValues('relation_target_name', $grouping);
4003     $relStatus = $this->getWhereValues('relation_status', $grouping);
4004     $relPermission = $this->getWhereValues('relation_permission', $grouping);
4005     $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
4006
4007     $nameClause = $name = NULL;
4008     if ($targetName) {
4009       $name = trim($targetName[2]);
4010       if (substr($name, 0, 1) == '"' &&
4011         substr($name, -1, 1) == '"'
4012       ) {
4013         $name = substr($name, 1, -1);
4014         $name = strtolower(CRM_Core_DAO::escapeString($name));
4015         $nameClause = "= '$name'";
4016       }
4017       else {
4018         $name = strtolower(CRM_Core_DAO::escapeString($name));
4019         $nameClause = "LIKE '%{$name}%'";
4020       }
4021     }
4022
4023     $rTypeValues = array();
4024     if (!empty($relationType)) {
4025       $rel = explode('_', $relationType[2]);
4026       self::$_relType = $rel[1];
4027       $params = array('id' => $rel[0]);
4028       $rType = CRM_Contact_BAO_RelationshipType::retrieve($params, $rTypeValues);
4029     }
4030     if (!empty($rTypeValues) && $rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
4031       // if we don't know which end of the relationship we are dealing with we'll create a temp table
4032       //@todo unless we are dealing with a target group
4033       self::$_relType = 'reciprocal';
4034     }
4035     // if we are creating a temp table we build our own where for the relationship table
4036     $relationshipTempTable = NULL;
4037     if (self::$_relType == 'reciprocal' && empty($targetGroup)) {
4038       $where = array();
4039       self::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO::createTempTableName('civicrm_rel');
4040       if ($nameClause) {
4041         $where[$grouping][] = " sort_name $nameClause ";
4042       }
4043     }
4044     else {
4045       $where = &$this->_where;
4046       if ($nameClause) {
4047         $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
4048       }
4049     }
4050
4051     $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
4052     $relTypeOrg = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
4053     $relTypeHou = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Household');
4054     $allRelationshipType = array();
4055     $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
4056     $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
4057
4058     if ($nameClause || !$targetGroup) {
4059       if (!empty($relationType)) {
4060         $this->_qill[$grouping][] = $allRelationshipType[$relationType[2]] . " $name";
4061       }
4062       else {
4063         $this->_qill[$grouping][] = $name;
4064       }
4065     }
4066
4067     //check to see if the target contact is in specified group
4068     if ($targetGroup) {
4069       //add contacts from static groups
4070       $this->_tables['civicrm_relationship_group_contact'] = $this->_whereTables['civicrm_relationship_group_contact']
4071         = " 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'";
4072       $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN  (" .
4073         implode(",", $targetGroup[2]) . ") ) ";
4074
4075       //add contacts from saved searches
4076       $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b", $op);
4077
4078       //set the group where clause
4079       if ($ssWhere) {
4080         $groupWhere[] = "( " . $ssWhere . " )";
4081       }
4082       $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4083
4084       //Get the names of the target groups for the qill
4085       $groupNames = CRM_Core_PseudoConstant::group();
4086       $qillNames = array();
4087       foreach ($targetGroup[2] as $groupId) {
4088         if (array_key_exists($groupId, $groupNames)) {
4089           $qillNames[] = $groupNames[$groupId];
4090         }
4091       }
4092       if (!empty($relationType)) {
4093         $this->_qill[$grouping][] = $allRelationshipType[$relationType[2]] . " ( " . implode(", ", $qillNames) . " )";
4094       }
4095       else {
4096         $this->_qill[$grouping][] = implode(", ", $qillNames);
4097       }
4098     }
4099
4100     // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4101     $today = date('Ymd');
4102     //check for active, inactive and all relation status
4103     if ($relStatus[2] == 0) {
4104       $where[$grouping][] = "(
4105 civicrm_relationship.is_active = 1 AND
4106 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4107 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4108 )";
4109       $this->_qill[$grouping][] = ts('Relationship - Active and Current');
4110     }
4111     elseif ($relStatus[2] == 1) {
4112       $where[$grouping][] = "(
4113 civicrm_relationship.is_active = 0 OR
4114 civicrm_relationship.end_date < {$today} OR
4115 civicrm_relationship.start_date > {$today}
4116 )";
4117       $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current');
4118     }
4119
4120     $onlyDeleted = 0;
4121     if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params)) {
4122       $onlyDeleted = 1;
4123     }
4124     $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4125
4126     //check for permissioned, non-permissioned and all permissioned relations
4127     if ($relPermission[2] == 1) {
4128       $where[$grouping][] = "(
4129 civicrm_relationship.is_permission_a_b = 1
4130 )";
4131       $this->_qill[$grouping][] = ts('Relationship - Permissioned');
4132     }
4133     elseif ($relPermission[2] == 2) {
4134       //non-allowed permission relationship.
4135       $where[$grouping][] = "(
4136 civicrm_relationship.is_permission_a_b = 0
4137 )";
4138       $this->_qill[$grouping][] = ts('Relationship - Non-permissioned');
4139     }
4140
4141     $this->addRelationshipDateClauses($grouping, $where);
4142     if (!empty($relationType) && !empty($rType) && isset($rType->id)) {
4143       $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id;
4144     }
4145     $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1;
4146     $this->_useDistinct = TRUE;
4147     $this->_relationshipValuesAdded = TRUE;
4148     // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4149     // join on that,
4150     // @todo creating a temp table could be expanded to group filter
4151     // as even creating a temp table of all relationships is much much more efficient than
4152     // an OR in the join
4153     if ($relationshipTempTable) {
4154       $whereClause = '';
4155       if (!empty($where[$grouping])) {
4156         $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4157         $whereClause = str_replace('contact_b', 'c', $whereClause);
4158       }
4159       $sql = "
4160         CREATE TEMPORARY TABLE {$relationshipTempTable}
4161           (SELECT contact_id_b as contact_id, civicrm_relationship.id
4162             FROM civicrm_relationship
4163             INNER JOIN  civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4164             $whereClause )
4165           UNION
4166             (SELECT contact_id_a as contact_id, civicrm_relationship.id
4167             FROM civicrm_relationship
4168             INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4169             $whereClause )
4170       ";
4171       CRM_Core_DAO::executeQuery($sql);
4172     }
4173
4174   }
4175
4176   /**
4177    * Add start & end date criteria in
4178    * @param string $grouping
4179    * @param array $where
4180    *   = array to add where clauses to, in case you are generating a temp table.
4181    * not the main query.
4182    */
4183   public function addRelationshipDateClauses($grouping, &$where) {
4184     $dateValues = array();
4185     $dateTypes = array(
4186       'start_date',
4187       'end_date',
4188     );
4189
4190     foreach ($dateTypes as $dateField) {
4191       $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4192       $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4193       if (!empty($dateValueLow)) {
4194         $date = date('Ymd', strtotime($dateValueLow[2]));
4195         $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4196         $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);
4197       }
4198       if (!empty($dateValueHigh)) {
4199         $date = date('Ymd', strtotime($dateValueHigh[2]));
4200         $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4201         $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);
4202       }
4203     }
4204   }
4205
4206   /**
4207    * Default set of return properties.
4208    *
4209    * @param int $mode
4210    *
4211    * @return array
4212    *   derault return properties
4213    */
4214   public static function &defaultReturnProperties($mode = 1) {
4215     if (!isset(self::$_defaultReturnProperties)) {
4216       self::$_defaultReturnProperties = array();
4217     }
4218
4219     if (!isset(self::$_defaultReturnProperties[$mode])) {
4220       // add activity return properties
4221       if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
4222         self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE);
4223       }
4224       else {
4225         self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE);
4226       }
4227
4228       if (empty(self::$_defaultReturnProperties[$mode])) {
4229         self::$_defaultReturnProperties[$mode] = array(
4230           'home_URL' => 1,
4231           'image_URL' => 1,
4232           'legal_identifier' => 1,
4233           'external_identifier' => 1,
4234           'contact_type' => 1,
4235           'contact_sub_type' => 1,
4236           'sort_name' => 1,
4237           'display_name' => 1,
4238           'preferred_mail_format' => 1,
4239           'nick_name' => 1,
4240           'first_name' => 1,
4241           'middle_name' => 1,
4242           'last_name' => 1,
4243           'prefix_id' => 1,
4244           'suffix_id' => 1,
4245           'formal_title' => 1,
4246           'communication_style_id' => 1,
4247           'birth_date' => 1,
4248           'gender_id' => 1,
4249           'street_address' => 1,
4250           'supplemental_address_1' => 1,
4251           'supplemental_address_2' => 1,
4252           'city' => 1,
4253           'postal_code' => 1,
4254           'postal_code_suffix' => 1,
4255           'state_province' => 1,
4256           'country' => 1,
4257           'world_region' => 1,
4258           'geo_code_1' => 1,
4259           'geo_code_2' => 1,
4260           'email' => 1,
4261           'on_hold' => 1,
4262           'phone' => 1,
4263           'im' => 1,
4264           'household_name' => 1,
4265           'organization_name' => 1,
4266           'deceased_date' => 1,
4267           'is_deceased' => 1,
4268           'job_title' => 1,
4269           'legal_name' => 1,
4270           'sic_code' => 1,
4271           'current_employer' => 1,
4272           // FIXME: should we use defaultHierReturnProperties() for the below?
4273           'do_not_email' => 1,
4274           'do_not_mail' => 1,
4275           'do_not_sms' => 1,
4276           'do_not_phone' => 1,
4277           'do_not_trade' => 1,
4278           'is_opt_out' => 1,
4279           'contact_is_deleted' => 1,
4280           'preferred_communication_method' => 1,
4281           'preferred_language' => 1,
4282         );
4283       }
4284     }
4285     return self::$_defaultReturnProperties[$mode];
4286   }
4287
4288   /**
4289    * Get primary condition for a sql clause.
4290    *
4291    * @param int $value
4292    *
4293    * @return string|NULL
4294    */
4295   public static function getPrimaryCondition($value) {
4296     if (is_numeric($value)) {
4297       $value = (int ) $value;
4298       return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0';
4299     }
4300     return NULL;
4301   }
4302
4303   /**
4304    * Wrapper for a simple search query.
4305    *
4306    * @param array $params
4307    * @param array $returnProperties
4308    * @param bool $count
4309    *
4310    * @return string
4311    */
4312   public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4313     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4314     list($select, $from, $where, $having) = $query->query();
4315
4316     return "$select $from $where $having";
4317   }
4318
4319   /**
4320    * These are stub comments as this function needs more explanation - particularly in terms of how it
4321    * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4322    *
4323    * This function was originally written as a wrapper for the api query but is called from multiple places
4324    * in the core code directly so the name is misleading. This function does not use the searchQuery function
4325    * but it is unclear as to whehter that is historical or there is a reason
4326    *  CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4327    *
4328    * @param array $params
4329    * @param array $returnProperties
4330    * @param null $fields
4331    * @param string $sort
4332    * @param int $offset
4333    * @param int $row_count
4334    * @param bool $smartGroupCache
4335    *   ?? update smart group cache?.
4336    * @param bool $count
4337    *   Return count obnly.
4338    * @param bool $skipPermissions
4339    *   Should permissions be ignored or should the logged in user's permissions be applied.
4340    *
4341    *
4342    * @return array
4343    */
4344   public static function apiQuery(
4345     $params = NULL,
4346     $returnProperties = NULL,
4347     $fields = NULL,
4348     $sort = NULL,
4349     $offset = 0,
4350     $row_count = 25,
4351     $smartGroupCache = TRUE,
4352     $count = FALSE,
4353     $skipPermissions = TRUE
4354   ) {
4355
4356     $query = new CRM_Contact_BAO_Query(
4357       $params, $returnProperties,
4358       NULL, TRUE, FALSE, 1,
4359       $skipPermissions,
4360       TRUE, $smartGroupCache
4361     );
4362
4363     //this should add a check for view deleted if permissions are enabled
4364     if ($skipPermissions) {
4365       $query->_skipDeleteClause = TRUE;
4366     }
4367     $query->generatePermissionClause(FALSE, $count);
4368
4369     // note : this modifies _fromClause and _simpleFromClause
4370     $query->includePseudoFieldsJoin($sort);
4371
4372     list($select, $from, $where, $having) = $query->query($count);
4373
4374     $options = $query->_options;
4375     if (!empty($query->_permissionWhereClause)) {
4376       if (empty($where)) {
4377         $where = "WHERE $query->_permissionWhereClause";
4378       }
4379       else {
4380         $where = "$where AND $query->_permissionWhereClause";
4381       }
4382     }
4383
4384     $sql = "$select $from $where $having";
4385
4386     // add group by
4387     if ($query->_useGroupBy) {
4388       $sql .= ' GROUP BY contact_a.id';
4389     }
4390     if (!empty($sort)) {
4391       $sort = CRM_Utils_Type::escape($sort, 'String');
4392       $sql .= " ORDER BY $sort ";
4393     }
4394     if ($row_count > 0 && $offset >= 0) {
4395       $offset = CRM_Utils_Type::escape($offset, 'Int');
4396       $rowCount = CRM_Utils_Type::escape($row_count, 'Int');
4397       $sql .= " LIMIT $offset, $row_count ";
4398     }
4399
4400     $dao = CRM_Core_DAO::executeQuery($sql);
4401
4402     $values = array();
4403     while ($dao->fetch()) {
4404       if ($count) {
4405         $noRows = $dao->rowCount;
4406         $dao->free();
4407         return array($noRows, NULL);
4408       }
4409       $val = $query->store($dao);
4410       $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4411
4412       if (!empty($convertedVals)) {
4413         $val = array_replace_recursive($val, $convertedVals);
4414       }
4415       $values[$dao->contact_id] = $val;
4416     }
4417     $dao->free();
4418     return array($values, $options);
4419   }
4420
4421   /**
4422    * Create and query the db for an contact search.
4423    *
4424    * @param int $offset
4425    *   The offset for the query.
4426    * @param int $rowCount
4427    *   The number of rows to return.
4428    * @param string $sort
4429    *   The order by string.
4430    * @param bool $count
4431    *   Is this a count only query ?.
4432    * @param bool $includeContactIds
4433    *   Should we include contact ids?.
4434    * @param bool $sortByChar
4435    *   If true returns the distinct array of first characters for search results.
4436    * @param bool $groupContacts
4437    *   If true, return only the contact ids.
4438    * @param bool $returnQuery
4439    *   Should we return the query as a string.
4440    * @param string $additionalWhereClause
4441    *   If the caller wants to further restrict the search (used for components).
4442    * @param null $sortOrder
4443    * @param string $additionalFromClause
4444    *   Should be clause with proper joins, effective to reduce where clause load.
4445    *
4446    * @param bool $skipOrderAndLimit
4447    *
4448    * @return CRM_Core_DAO
4449    */
4450   public function searchQuery(
4451     $offset = 0, $rowCount = 0, $sort = NULL,
4452     $count = FALSE, $includeContactIds = FALSE,
4453     $sortByChar = FALSE, $groupContacts = FALSE,
4454     $returnQuery = FALSE,
4455     $additionalWhereClause = NULL, $sortOrder = NULL,
4456     $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4457   ) {
4458
4459     if ($includeContactIds) {
4460       $this->_includeContactIds = TRUE;
4461       $this->_whereClause = $this->whereClause();
4462     }
4463
4464     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4465
4466     // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4467     // and that contact happens to be deleted, set $onlyDeleted to true
4468     foreach ($this->_params as $values) {
4469       $name = CRM_Utils_Array::value(0, $values);
4470       $op = CRM_Utils_Array::value(1, $values);
4471       $value = CRM_Utils_Array::value(2, $values);
4472       if ($name == 'contact_id' and $op == '=') {
4473         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4474           $onlyDeleted = TRUE;
4475         }
4476         break;
4477       }
4478     }
4479
4480     // building the query string
4481     $groupBy = NULL;
4482     if (!$count) {
4483       if (isset($this->_groupByComponentClause)) {
4484         $groupBy = $this->_groupByComponentClause;
4485       }
4486       elseif ($this->_useGroupBy) {
4487         $groupBy = ' GROUP BY contact_a.id';
4488       }
4489     }
4490     if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) {
4491       $groupBy = 'GROUP BY civicrm_activity.id ';
4492     }
4493
4494     $order = $orderBy = $limit = '';
4495     if (!$count) {
4496       $config = CRM_Core_Config::singleton();
4497       if ($config->includeOrderByClause ||
4498         isset($this->_distinctComponentClause)
4499       ) {
4500         if ($sort) {
4501           if (is_string($sort)) {
4502             $orderBy = $sort;
4503           }
4504           else {
4505             $orderBy = trim($sort->orderBy());
4506           }
4507           if (!empty($orderBy)) {
4508             // this is special case while searching for
4509             // change log CRM-1718
4510             if (preg_match('/sort_name/i', $orderBy)) {
4511               $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4512             }
4513
4514             $orderBy = CRM_Utils_Type::escape($orderBy, 'String');
4515             $order = " ORDER BY $orderBy";
4516
4517             if ($sortOrder) {
4518               $sortOrder = CRM_Utils_Type::escape($sortOrder, 'String');
4519               $order .= " $sortOrder";
4520             }
4521
4522             // always add contact_a.id to the ORDER clause
4523             // so the order is deterministic
4524             if (strpos('contact_a.id', $order) === FALSE) {
4525               $order .= ", contact_a.id";
4526             }
4527           }
4528         }
4529         elseif ($sortByChar) {
4530           $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4531         }
4532         else {
4533           $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4534         }
4535       }
4536
4537       // hack for order clause
4538       if ($order) {
4539         $fieldStr = trim(str_replace('ORDER BY', '', $order));
4540         $fieldOrder = explode(' ', $fieldStr);
4541         $field = $fieldOrder[0];
4542
4543         if ($field) {
4544           switch ($field) {
4545             case 'city':
4546             case 'postal_code':
4547               $this->_whereTables["civicrm_address"] = 1;
4548               $order = str_replace($field, "civicrm_address.{$field}", $order);
4549               break;
4550
4551             case 'country':
4552             case 'state_province':
4553               $this->_whereTables["civicrm_{$field}"] = 1;
4554               $order = str_replace($field, "civicrm_{$field}.name", $order);
4555               break;
4556
4557             case 'email':
4558               $this->_whereTables["civicrm_email"] = 1;
4559               $order = str_replace($field, "civicrm_email.{$field}", $order);
4560               break;
4561
4562             default:
4563               //CRM-12565 add "`" around $field if it is a pseudo constant
4564               foreach ($this->_pseudoConstantsSelect as $key => $value) {
4565                 if (!empty($value['element']) && $value['element'] == $field) {
4566                   $order = str_replace($field, "`{$field}`", $order);
4567                 }
4568               }
4569           }
4570           $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4571           $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4572         }
4573       }
4574
4575       if ($rowCount > 0 && $offset >= 0) {
4576         $offset = CRM_Utils_Type::escape($offset, 'Int');
4577         $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
4578         $limit = " LIMIT $offset, $rowCount ";
4579       }
4580     }
4581
4582     // CRM-15231
4583     $this->_sort = $sort;
4584
4585     list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4586
4587     if ($additionalWhereClause) {
4588       $where = $where . ' AND ' . $additionalWhereClause;
4589     }
4590
4591     //additional from clause should be w/ proper joins.
4592     if ($additionalFromClause) {
4593       $from .= "\n" . $additionalFromClause;
4594     }
4595
4596     // if we are doing a transform, do it here
4597     // use the $from, $where and $having to get the contact ID
4598     if ($this->_displayRelationshipType) {
4599       $this->filterRelatedContacts($from, $where, $having);
4600     }
4601
4602     if ($skipOrderAndLimit) {
4603       $query = "$select $from $where $having $groupBy";
4604     }
4605     else {
4606       $query = "$select $from $where $having $groupBy $order $limit";
4607     }
4608
4609     if ($returnQuery) {
4610       return $query;
4611     }
4612     if ($count) {
4613       return CRM_Core_DAO::singleValueQuery($query);
4614     }
4615
4616     $dao = CRM_Core_DAO::executeQuery($query);
4617     if ($groupContacts) {
4618       $ids = array();
4619       while ($dao->fetch()) {
4620         $ids[] = $dao->id;
4621       }
4622       return implode(',', $ids);
4623     }
4624
4625     return $dao;
4626   }
4627
4628   /**
4629    * Fetch a list of contacts from the prev/next cache for displaying a search results page
4630    *
4631    * @param string $cacheKey
4632    * @param int $offset
4633    * @param int $rowCount
4634    * @param bool $includeContactIds
4635    * @return CRM_Core_DAO
4636    */
4637   public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4638     $this->_includeContactIds = $includeContactIds;
4639     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4640     list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
4641     $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);
4642     $order = " ORDER BY pnc.id";
4643     $groupBy = " GROUP BY contact_a.id";
4644     $limit = " LIMIT $offset, $rowCount";
4645     $query = "$select $from $where $groupBy $order $limit";
4646
4647     return CRM_Core_DAO::executeQuery($query);
4648   }
4649
4650   /**
4651    * Populate $this->_permissionWhereClause with permission related clause and update other
4652    * query related properties.
4653    *
4654    * Function calls ACL permission class and hooks to filter the query appropriately
4655    *
4656    * Note that these 2 params were in the code when extracted from another function
4657    * and a second round extraction would be to make them properties of the class
4658    *
4659    * @param bool $onlyDeleted
4660    *   Only get deleted contacts.
4661    * @param bool $count
4662    *   Return Count only.
4663    */
4664   public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4665     if (!$this->_skipPermission) {
4666       $this->_permissionWhereClause = CRM_ACL_API::whereClause(
4667         CRM_Core_Permission::VIEW,
4668         $this->_tables,
4669         $this->_whereTables,
4670         NULL,
4671         $onlyDeleted,
4672         $this->_skipDeleteClause
4673       );
4674
4675       // regenerate fromClause since permission might have added tables
4676       if ($this->_permissionWhereClause) {
4677         //fix for row count in qill (in contribute/membership find)
4678         if (!$count) {
4679           $this->_useDistinct = TRUE;
4680         }
4681         //CRM-15231
4682         $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4683         $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4684         // note : this modifies _fromClause and _simpleFromClause
4685         $this->includePseudoFieldsJoin($this->_sort);
4686       }
4687     }
4688     else {
4689       // add delete clause if needed even if we are skipping permission
4690       // CRM-7639
4691       if (!$this->_skipDeleteClause) {
4692         if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
4693           $this->_permissionWhereClause = '(contact_a.is_deleted)';
4694         }
4695         else {
4696           // CRM-6181
4697           $this->_permissionWhereClause = '(contact_a.is_deleted = 0)';
4698         }
4699       }
4700     }
4701   }
4702
4703   /**
4704    * @param $val
4705    */
4706   public function setSkipPermission($val) {
4707     $this->_skipPermission = $val;
4708   }
4709
4710   /**
4711    * @param null $context
4712    *
4713    * @return array
4714    */
4715   public function &summaryContribution($context = NULL) {
4716     list($innerselect, $from, $where, $having) = $this->query(TRUE);
4717
4718     // hack $select
4719     $select = "
4720 SELECT COUNT( conts.total_amount ) as total_count,
4721        SUM(   conts.total_amount ) as total_amount,
4722        AVG(   conts.total_amount ) as total_avg,
4723        conts.total_amount          as amount,
4724        conts.currency              as currency";
4725     if ($this->_permissionWhereClause) {
4726       $where .= " AND " . $this->_permissionWhereClause;
4727     }
4728     if ($context == 'search') {
4729       $where .= " AND contact_a.is_deleted = 0 ";
4730     }
4731
4732     // make sure contribution is completed - CRM-4989
4733     $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
4734
4735     $summary = array();
4736     $summary['total'] = array();
4737     $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4738     $innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,
4739       civicrm_contribution.currency $from $completedWhere";
4740
4741     $query = "$select FROM (
4742       $innerQuery GROUP BY civicrm_contribution.id
4743     ) as conts
4744     GROUP BY currency";
4745
4746     $dao = CRM_Core_DAO::executeQuery($query);
4747
4748     $summary['total']['count'] = 0;
4749     $summary['total']['amount'] = $summary['total']['avg'] = array();
4750     while ($dao->fetch()) {
4751       $summary['total']['count'] += $dao->total_count;
4752       $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4753       $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4754     }
4755
4756     $orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
4757     $groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
4758     $modeSQL = "$select, conts.civicrm_contribution_total_amount_count as civicrm_contribution_total_amount_count FROM ($innerQuery
4759     $groupBy $orderBy) as conts
4760     GROUP BY currency";
4761
4762     $summary['total']['mode'] = CRM_Contribute_BAO_Contribution::computeStats('mode', $modeSQL);
4763
4764     $medianSQL = "{$from} {$completedWhere}";
4765     $summary['total']['median'] = CRM_Contribute_BAO_Contribution::computeStats('median', $medianSQL, 'civicrm_contribution');
4766     $summary['total']['currencyCount'] = count($summary['total']['median']);
4767
4768     if (!empty($summary['total']['amount'])) {
4769       $summary['total']['amount'] = implode(',&nbsp;', $summary['total']['amount']);
4770       $summary['total']['avg'] = implode(',&nbsp;', $summary['total']['avg']);
4771       $summary['total']['mode'] = implode(',&nbsp;', $summary['total']['mode']);
4772       $summary['total']['median'] = implode(',&nbsp;', $summary['total']['median']);
4773     }
4774     else {
4775       $summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
4776     }
4777
4778     // soft credit summary
4779     if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
4780       $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
4781       $query = "
4782         $select FROM (
4783           SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
4784           GROUP BY civicrm_contribution_soft.id
4785         ) as conts
4786         GROUP BY currency";
4787       $dao = CRM_Core_DAO::executeQuery($query);
4788       $summary['soft_credit']['count'] = 0;
4789       $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
4790       while ($dao->fetch()) {
4791         $summary['soft_credit']['count'] += $dao->total_count;
4792         $summary['soft_credit']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4793         $summary['soft_credit']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4794       }
4795       if (!empty($summary['soft_credit']['amount'])) {
4796         $summary['soft_credit']['amount'] = implode(',&nbsp;', $summary['soft_credit']['amount']);
4797         $summary['soft_credit']['avg'] = implode(',&nbsp;', $summary['soft_credit']['avg']);
4798       }
4799       else {
4800         $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
4801       }
4802     }
4803
4804     // hack $select
4805     //@todo  - this could be one query using the IF in mysql - eg
4806     //  SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
4807     //   SELECT civicrm_contribution.total_amount, civicrm_contribution.currency  ,
4808     //  IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
4809     //  IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
4810     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
4811     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
4812     // FROM civicrm_contact contact_a
4813     //  LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
4814     // WHERE  ( ... where clause....
4815     // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
4816     //  ) as conts
4817
4818     $select = "
4819 SELECT COUNT( conts.total_amount ) as cancel_count,
4820        SUM(   conts.total_amount ) as cancel_amount,
4821        AVG(   conts.total_amount ) as cancel_avg,
4822        conts.currency              as currency";
4823
4824     $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4825     if ($context == 'search') {
4826       $where .= " AND contact_a.is_deleted = 0 ";
4827     }
4828
4829     $query = "$select FROM (
4830       SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
4831       GROUP BY civicrm_contribution.id
4832     ) as conts
4833     GROUP BY currency";
4834
4835     $dao = CRM_Core_DAO::executeQuery($query);
4836
4837     if ($dao->N <= 1) {
4838       if ($dao->fetch()) {
4839         $summary['cancel']['count'] = $dao->cancel_count;
4840         $summary['cancel']['amount'] = $dao->cancel_amount;
4841         $summary['cancel']['avg'] = $dao->cancel_avg;
4842       }
4843     }
4844     else {
4845       $summary['cancel']['count'] = 0;
4846       $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4847       while ($dao->fetch()) {
4848         $summary['cancel']['count'] += $dao->cancel_count;
4849         $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
4850         $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
4851       }
4852       $summary['cancel']['amount'] = implode(',&nbsp;', $summary['cancel']['amount']);
4853       $summary['cancel']['avg'] = implode(',&nbsp;', $summary['cancel']['avg']);
4854     }
4855
4856     return $summary;
4857   }
4858
4859   /**
4860    * Getter for the qill object.
4861    *
4862    * @return string
4863    */
4864   public function qill() {
4865     return $this->_qill;
4866   }
4867
4868   /**
4869    * Default set of return default hier return properties.
4870    *
4871    * @return array
4872    */
4873   public static function &defaultHierReturnProperties() {
4874     if (!isset(self::$_defaultHierReturnProperties)) {
4875       self::$_defaultHierReturnProperties = array(
4876         'home_URL' => 1,
4877         'image_URL' => 1,
4878         'legal_identifier' => 1,
4879         'external_identifier' => 1,
4880         'contact_type' => 1,
4881         'contact_sub_type' => 1,
4882         'sort_name' => 1,
4883         'display_name' => 1,
4884         'nick_name' => 1,
4885         'first_name' => 1,
4886         'middle_name' => 1,
4887         'last_name' => 1,
4888         'prefix_id' => 1,
4889         'suffix_id' => 1,
4890         'formal_title' => 1,
4891         'communication_style_id' => 1,
4892         'email_greeting' => 1,
4893         'postal_greeting' => 1,
4894         'addressee' => 1,
4895         'birth_date' => 1,
4896         'gender_id' => 1,
4897         'preferred_communication_method' => 1,
4898         'do_not_phone' => 1,
4899         'do_not_email' => 1,
4900         'do_not_mail' => 1,
4901         'do_not_sms' => 1,
4902         'do_not_trade' => 1,
4903         'location' => array(
4904           '1' => array(
4905             'location_type' => 1,
4906             'street_address' => 1,
4907             'city' => 1,
4908             'state_province' => 1,
4909             'postal_code' => 1,
4910             'postal_code_suffix' => 1,
4911             'country' => 1,
4912             'phone-Phone' => 1,
4913             'phone-Mobile' => 1,
4914             'phone-Fax' => 1,
4915             'phone-1' => 1,
4916             'phone-2' => 1,
4917             'phone-3' => 1,
4918             'im-1' => 1,
4919             'im-2' => 1,
4920             'im-3' => 1,
4921             'email-1' => 1,
4922             'email-2' => 1,
4923             'email-3' => 1,
4924           ),
4925           '2' => array(
4926             'location_type' => 1,
4927             'street_address' => 1,
4928             'city' => 1,
4929             'state_province' => 1,
4930             'postal_code' => 1,
4931             'postal_code_suffix' => 1,
4932             'country' => 1,
4933             'phone-Phone' => 1,
4934             'phone-Mobile' => 1,
4935             'phone-1' => 1,
4936             'phone-2' => 1,
4937             'phone-3' => 1,
4938             'im-1' => 1,
4939             'im-2' => 1,
4940             'im-3' => 1,
4941             'email-1' => 1,
4942             'email-2' => 1,
4943             'email-3' => 1,
4944           ),
4945         ),
4946       );
4947     }
4948     return self::$_defaultHierReturnProperties;
4949   }
4950
4951   /**
4952    * @param $values
4953    * @param string $tableName
4954    * @param string $fieldName
4955    * @param string $dbFieldName
4956    * @param $fieldTitle
4957    * @param bool $appendTimeStamp
4958    */
4959   public function dateQueryBuilder(
4960     &$values, $tableName, $fieldName,
4961     $dbFieldName, $fieldTitle,
4962     $appendTimeStamp = TRUE
4963   ) {
4964     list($name, $op, $value, $grouping, $wildcard) = $values;
4965
4966     if ($name == "{$fieldName}_low" ||
4967       $name == "{$fieldName}_high"
4968     ) {
4969       if (isset($this->_rangeCache[$fieldName]) || !$value) {
4970         return;
4971       }
4972       $this->_rangeCache[$fieldName] = 1;
4973
4974       $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4975
4976       if ($name == $fieldName . '_low') {
4977         $firstOP = '>=';
4978         $firstPhrase = ts('greater than or equal to');
4979         $firstDate = CRM_Utils_Date::processDate($value);
4980
4981         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4982         if (!empty($secondValues) && $secondValues[2]) {
4983           $secondOP = '<=';
4984           $secondPhrase = ts('less than or equal to');
4985           $secondValue = $secondValues[2];
4986
4987           if ($appendTimeStamp && strlen($secondValue) == 10) {
4988             $secondValue .= ' 23:59:59';
4989           }
4990           $secondDate = CRM_Utils_Date::processDate($secondValue);
4991         }
4992       }
4993       elseif ($name == $fieldName . '_high') {
4994         $firstOP = '<=';
4995         $firstPhrase = ts('less than or equal to');
4996
4997         if ($appendTimeStamp && strlen($value) == 10) {
4998           $value .= ' 23:59:59';
4999         }
5000         $firstDate = CRM_Utils_Date::processDate($value);
5001
5002         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5003         if (!empty($secondValues) && $secondValues[2]) {
5004           $secondOP = '>=';
5005           $secondPhrase = ts('greater than or equal to');
5006           $secondValue = $secondValues[2];
5007           $secondDate = CRM_Utils_Date::processDate($secondValue);
5008         }
5009       }
5010
5011       if (!$appendTimeStamp) {
5012         $firstDate = substr($firstDate, 0, 8);
5013       }
5014       $firstDateFormat = CRM_Utils_Date::customFormat($firstDate);
5015
5016       if ($secondDate) {
5017         if (!$appendTimeStamp) {
5018           $secondDate = substr($secondDate, 0, 8);
5019         }
5020         $secondDateFormat = CRM_Utils_Date::customFormat($secondDate);
5021       }
5022
5023       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5024       if ($secondDate) {
5025         $this->_where[$grouping][] = "
5026 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5027 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5028 ";
5029         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
5030       }
5031       else {
5032         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5033         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
5034       }
5035     }
5036
5037     if ($name == $fieldName) {
5038       //In Get API, for operators other then '=' the $value is in array(op => value) format
5039       if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5040         $op = key($value);
5041         $value = $value[$op];
5042       }
5043
5044       $date = $format = NULL;
5045       if (strstr($op, 'IN')) {
5046         $format = array();
5047         foreach ($value as &$date) {
5048           $date = CRM_Utils_Date::processDate($date);
5049           if (!$appendTimeStamp) {
5050             $date = substr($date, 0, 8);
5051           }
5052           $format[] = CRM_Utils_Date::customFormat($date);
5053         }
5054         $date = "('" . implode("','", $value) . "')";
5055         $format = implode(', ', $format);
5056       }
5057       elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5058         $date = CRM_Utils_Date::processDate($value);
5059         if (!$appendTimeStamp) {
5060           $date = substr($date, 0, 8);
5061         }
5062         $format = CRM_Utils_Date::customFormat($date);
5063         $date = "'$date'";
5064       }
5065
5066       if ($date) {
5067         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5068       }
5069       else {
5070         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op";
5071       }
5072
5073       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5074
5075       $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
5076       $this->_qill[$grouping][] = "$fieldTitle $op $format";
5077     }
5078   }
5079
5080   /**
5081    * @param $values
5082    * @param string $tableName
5083    * @param string $fieldName
5084    * @param string $dbFieldName
5085    * @param $fieldTitle
5086    * @param null $options
5087    */
5088   public function numberRangeBuilder(
5089     &$values,
5090     $tableName, $fieldName,
5091     $dbFieldName, $fieldTitle,
5092     $options = NULL
5093   ) {
5094     list($name, $op, $value, $grouping, $wildcard) = $values;
5095
5096     if ($name == "{$fieldName}_low" ||
5097       $name == "{$fieldName}_high"
5098     ) {
5099       if (isset($this->_rangeCache[$fieldName])) {
5100         return;
5101       }
5102       $this->_rangeCache[$fieldName] = 1;
5103
5104       $secondOP = $secondPhrase = $secondValue = NULL;
5105
5106       if ($name == "{$fieldName}_low") {
5107         $firstOP = '>=';
5108         $firstPhrase = ts('greater than');
5109
5110         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5111         if (!empty($secondValues)) {
5112           $secondOP = '<=';
5113           $secondPhrase = ts('less than');
5114           $secondValue = $secondValues[2];
5115         }
5116       }
5117       else {
5118         $firstOP = '<=';
5119         $firstPhrase = ts('less than');
5120
5121         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5122         if (!empty($secondValues)) {
5123           $secondOP = '>=';
5124           $secondPhrase = ts('greater than');
5125           $secondValue = $secondValues[2];
5126         }
5127       }
5128
5129       if ($secondOP) {
5130         $this->_where[$grouping][] = "
5131 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5132 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5133 ";
5134         $displayValue = $options ? $options[$value] : $value;
5135         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5136
5137         $this->_qill[$grouping][]
5138           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5139       }
5140       else {
5141         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5142         $displayValue = $options ? $options[$value] : $value;
5143         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5144       }
5145       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5146
5147       return;
5148     }
5149
5150     if ($name == $fieldName) {
5151       $op = '=';
5152       $phrase = '=';
5153
5154       $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5155
5156       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5157       $displayValue = $options ? $options[$value] : $value;
5158       $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5159     }
5160   }
5161
5162
5163   /**
5164    * @param $values
5165    * @param string $tableName
5166    * @param string $fieldName
5167    * @param string $dbFieldName
5168    * @param $fieldTitle
5169    * @param null $options
5170    */
5171   public function ageRangeQueryBuilder(
5172     &$values,
5173     $tableName, $fieldName,
5174     $dbFieldName, $fieldTitle,
5175     $options = NULL
5176   ) {
5177     list($name, $op, $value, $grouping, $wildcard) = $values;
5178
5179     $asofDateValues = $this->getWhereValues("{$fieldName}_asof_date", $grouping);
5180     $asofDate = NULL;  // will be treated as current day
5181     if ($asofDateValues) {
5182       $asofDate = CRM_Utils_Date::processDate($asofDateValues[2]);
5183       $asofDateFormat = CRM_Utils_Date::customFormat(substr($asofDate, 0, 8));
5184       $fieldTitle .= ' ' . ts('as of') . ' ' . $asofDateFormat;
5185     }
5186
5187     if ($name == "{$fieldName}_low" ||
5188       $name == "{$fieldName}_high"
5189     ) {
5190       if (isset($this->_rangeCache[$fieldName])) {
5191         return;
5192       }
5193       $this->_rangeCache[$fieldName] = 1;
5194
5195       $secondOP = $secondPhrase = $secondValue = NULL;
5196
5197       if ($name == "{$fieldName}_low") {
5198         $firstPhrase = ts('greater than or equal to');
5199         // NB: age > X means date of birth < Y
5200         $firstOP = '<=';
5201         $firstDate = self::calcDateFromAge($asofDate, $value, 'min');
5202
5203         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5204         if (!empty($secondValues)) {
5205           $secondOP = '>=';
5206           $secondPhrase = ts('less than or equal to');
5207           $secondValue = $secondValues[2];
5208           $secondDate = self::calcDateFromAge($asofDate, $secondValue, 'max');
5209         }
5210       }
5211       else {
5212         $firstOP = '>=';
5213         $firstPhrase = ts('less than or equal to');
5214         $firstDate = self::calcDateFromAge($asofDate, $value, 'max');
5215
5216         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5217         if (!empty($secondValues)) {
5218           $secondOP = '<=';
5219           $secondPhrase = ts('greater than or equal to');
5220           $secondValue = $secondValues[2];
5221           $secondDate = self::calcDateFromAge($asofDate, $secondValue, 'min');
5222         }
5223       }
5224
5225       if ($secondOP) {
5226         $this->_where[$grouping][] = "
5227 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5228 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5229 ";
5230         $displayValue = $options ? $options[$value] : $value;
5231         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5232
5233         $this->_qill[$grouping][]
5234           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5235       }
5236       else {
5237         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5238         $displayValue = $options ? $options[$value] : $value;
5239         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5240       }
5241       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5242       return;
5243     }
5244   }
5245
5246   public static function calcDateFromAge($asofDate, $age, $type) {
5247     $date = new DateTime($asofDate);
5248     if ($type == "min") {
5249       // minimum age is $age: dob <= date - age "235959"
5250       $date->sub(new DateInterval("P" . $age . "Y"));
5251       return $date->format('Ymd') . "235959";
5252     }
5253     else {
5254       // max age is $age: dob >= date - (age + 1y) + 1d "000000"
5255       $date->sub(new DateInterval("P" . ($age + 1) . "Y"))->add(new DateInterval("P1D"));
5256       return $date->format('Ymd') . "000000";
5257     }
5258   }
5259
5260   /**
5261    * Given the field name, operator, value & its data type
5262    * builds the where Clause for the query
5263    * used for handling 'IS NULL'/'IS NOT NULL' operators
5264    *
5265    * @param string $field
5266    *   Fieldname.
5267    * @param string $op
5268    *   Operator.
5269    * @param string $value
5270    *   Value.
5271    * @param string $dataType
5272    *   Data type of the field.
5273    *
5274    * @return string
5275    *   Where clause for the query.
5276    */
5277   public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5278     $op = trim($op);
5279     $clause = "$field $op";
5280
5281     switch ($op) {
5282       case 'IS NULL':
5283       case 'IS NOT NULL':
5284         return $clause;
5285
5286       case 'IS EMPTY':
5287         $clause = " (NULLIF($field, '') IS NULL) ";
5288         return $clause;
5289
5290       case 'IS NOT EMPTY':
5291         $clause = " (NULLIF($field, '') IS NOT NULL) ";
5292         return $clause;
5293
5294       case 'IN':
5295       case 'NOT IN':
5296         // I feel like this would be escaped properly if passed through $queryString = CRM_Core_DAO::createSqlFilter.
5297         if (!empty($value) && is_array($value) && !array_key_exists($op, $value)) {
5298           $value = array($op => $value);
5299         }
5300
5301       default:
5302         if (empty($dataType)) {
5303           $dataType = 'String';
5304         }
5305         if (is_array($value)) {
5306           //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5307           // widely used and consistent across the codebase
5308           // adding this here won't accept the search functions which don't submit an array
5309           if (($queryString = CRM_Core_DAO::createSqlFilter($field, $value, $dataType)) != FALSE) {
5310
5311             return $queryString;
5312           }
5313
5314           // This is the here-be-dragons zone. We have no other hopes left for an array so lets assume it 'should' be array('IN' => array(2,5))
5315           // but we got only array(2,5) from the form.
5316           // We could get away with keeping this in 4.6 if we make it such that it throws an enotice in 4.7 so
5317           // people have to de-slopify it.
5318           if (!empty($value[0])) {
5319             $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReport;
5320             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => $value), $dataType)) != FALSE) {
5321               return $queryString;
5322             }
5323           }
5324           else {
5325             $op = 'IN';
5326             $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReportUsingOldFormat;
5327             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => array_keys($value)), $dataType)) != FALSE) {
5328               return $queryString;
5329             }
5330           }
5331         }
5332
5333         $value = CRM_Utils_Type::escape($value, $dataType);
5334         // if we don't have a dataType we should assume
5335         if ($dataType == 'String' || $dataType == 'Text') {
5336           $value = "'" . strtolower($value) . "'";
5337         }
5338         return "$clause $value";
5339     }
5340   }
5341
5342   /**
5343    * @param bool $reset
5344    *
5345    * @return array
5346    */
5347   public function openedSearchPanes($reset = FALSE) {
5348     if (!$reset || empty($this->_whereTables)) {
5349       return self::$_openedPanes;
5350     }
5351
5352     // pane name to table mapper
5353     $panesMapper = array(
5354       ts('Contributions') => 'civicrm_contribution',
5355       ts('Memberships') => 'civicrm_membership',
5356       ts('Events') => 'civicrm_participant',
5357       ts('Relationships') => 'civicrm_relationship',
5358       ts('Activities') => 'civicrm_activity',
5359       ts('Pledges') => 'civicrm_pledge',
5360       ts('Cases') => 'civicrm_case',
5361       ts('Grants') => 'civicrm_grant',
5362       ts('Address Fields') => 'civicrm_address',
5363       ts('Notes') => 'civicrm_note',
5364       ts('Change Log') => 'civicrm_log',
5365       ts('Mailings') => 'civicrm_mailing_event_queue',
5366     );
5367     CRM_Contact_BAO_Query_Hook::singleton()->getPanesMapper($panesMapper);
5368
5369     foreach (array_keys($this->_whereTables) as $table) {
5370       if ($panName = array_search($table, $panesMapper)) {
5371         self::$_openedPanes[$panName] = TRUE;
5372       }
5373     }
5374
5375     return self::$_openedPanes;
5376   }
5377
5378   /**
5379    * @param $operator
5380    */
5381   public function setOperator($operator) {
5382     $validOperators = array('AND', 'OR');
5383     if (!in_array($operator, $validOperators)) {
5384       $operator = 'AND';
5385     }
5386     $this->_operator = $operator;
5387   }
5388
5389   /**
5390    * @return string
5391    */
5392   public function getOperator() {
5393     return $this->_operator;
5394   }
5395
5396   /**
5397    * @param $from
5398    * @param $where
5399    * @param $having
5400    */
5401   public function filterRelatedContacts(&$from, &$where, &$having) {
5402     static $_rTypeProcessed = NULL;
5403     static $_rTypeFrom = NULL;
5404     static $_rTypeWhere = NULL;
5405
5406     if (!$_rTypeProcessed) {
5407       $_rTypeProcessed = TRUE;
5408
5409       // create temp table with contact ids
5410       $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE);
5411       $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5412       CRM_Core_DAO::executeQuery($sql);
5413
5414       $sql = "
5415 REPLACE INTO $tableName ( contact_id )
5416 SELECT contact_a.id
5417        $from
5418        $where
5419        $having
5420 ";
5421       CRM_Core_DAO::executeQuery($sql);
5422
5423       $qillMessage = ts('Contacts with a Relationship Type of: ');
5424       $rTypes = CRM_Core_PseudoConstant::relationshipType();
5425
5426       if (is_numeric($this->_displayRelationshipType)) {
5427         $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b'];
5428         $_rTypeFrom = "
5429 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5430 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5431 ";
5432         $_rTypeWhere = "
5433 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5434 AND   displayRelType.is_active = 1
5435 ";
5436       }
5437       else {
5438         list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType);
5439         if ($dirOne == 'a') {
5440           $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5441           $_rTypeFrom .= "
5442 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5443 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5444 ";
5445         }
5446         else {
5447           $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5448           $_rTypeFrom .= "
5449 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5450 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5451 ";
5452         }
5453         $_rTypeWhere = "
5454 WHERE displayRelType.relationship_type_id = $relType
5455 AND   displayRelType.is_active = 1
5456 ";
5457       }
5458       $this->_qill[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
5459     }
5460
5461     if (!empty($this->_permissionWhereClause)) {
5462       $_rTypeWhere .= "AND $this->_permissionWhereClause";
5463     }
5464
5465     if (strpos($from, $_rTypeFrom) === FALSE) {
5466       // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5467       // this happens when we have an event_type in the quert (CRM-7969)
5468       $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5469       $from .= $_rTypeFrom;
5470       $where = $_rTypeWhere;
5471     }
5472
5473     $having = NULL;
5474   }
5475
5476   /**
5477    * @param $op
5478    *
5479    * @return bool
5480    */
5481   public static function caseImportant($op) {
5482     return
5483       in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
5484   }
5485
5486   /**
5487    * @param $returnProperties
5488    * @param $prefix
5489    *
5490    * @return bool
5491    */
5492   public static function componentPresent(&$returnProperties, $prefix) {
5493     foreach ($returnProperties as $name => $dontCare) {
5494       if (substr($name, 0, strlen($prefix)) == $prefix) {
5495         return TRUE;
5496       }
5497     }
5498     return FALSE;
5499   }
5500
5501   /**
5502    * Builds the necessary structures for all fields that are similar to option value lookups.
5503    *
5504    * @param string $name
5505    *   the name of the field.
5506    * @param string $op
5507    *   the sql operator, this function should handle ALL SQL operators.
5508    * @param string $value
5509    *   depends on the operator and who's calling the query builder.
5510    * @param int $grouping
5511    *   the index where to place the where clause.
5512    * @param $selectValues
5513    *   The key value pairs for this element. This allows us to use this function for things besides option-value pairs.
5514    * @param array $field
5515    *   an array that contains various properties of the field identified by $name.
5516    * @param string $label
5517    *   The label for this field element.
5518    * @param string $dataType
5519    *   The data type for this element.
5520    * @param bool $useIDsOnly
5521    *
5522    * @return void
5523    *   adds the where clause and qill to the query object
5524    */
5525   public function optionValueQuery(
5526     $name,
5527     $op,
5528     $value,
5529     $grouping,
5530     $selectValues,
5531     $field,
5532     $label,
5533     $dataType = 'String',
5534     $useIDsOnly = FALSE
5535   ) {
5536
5537     if (!empty($selectValues) && !is_array($value) && !empty($selectValues[$value])) {
5538       $qill = $selectValues[$value];
5539     }
5540     else {
5541       $qill = $value;
5542     }
5543
5544     $pseudoFields = array(
5545       'email_greeting',
5546       'postal_greeting',
5547       'addressee',
5548       'gender_id',
5549       'prefix_id',
5550       'suffix_id',
5551       'communication_style_id',
5552     );
5553
5554     if (is_numeric($value)) {
5555       $qill = $selectValues[(int ) $value];
5556     }
5557     elseif ($op == 'IN' || $op == 'NOT IN') {
5558       if (is_array($value)) {
5559         $intVals = array();
5560         $newValues = array();
5561         foreach ($value as $k => $v) {
5562           $intVals[$k] = (int) $k;
5563           $newValues[] = $selectValues[(int) $k];
5564         }
5565
5566         $value = (in_array($name, $pseudoFields)) ? $intVals : $newValues;
5567         $qill = implode(', ', $newValues);
5568       }
5569     }
5570     elseif (!array_key_exists($value, $selectValues)) {
5571       // its a string, lets get the int value
5572       $value = array_search($value, $selectValues);
5573     }
5574     if ($useIDsOnly) {
5575       list($tableName, $fieldName) = explode('.', $field['where'], 2);
5576       if ($tableName == 'civicrm_contact') {
5577         $wc = "contact_a.$fieldName";
5578       }
5579       else {
5580         $wc = "$tableName.id";
5581       }
5582     }
5583     else {
5584       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
5585     }
5586
5587     if (in_array($name, $pseudoFields)) {
5588       if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5589         $wc = "contact_a.{$name}_id";
5590       }
5591       $dataType = 'Positive';
5592       $value = (!$value) ? 0 : $value;
5593     }
5594
5595     $this->_qill[$grouping][] = $label . " $op '$qill'";
5596     $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' || $op == 'RLIKE')) ? '=' : $op;
5597     $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType);
5598   }
5599
5600   /**
5601    * Check and explode a user defined numeric string into an array
5602    * this was the protocol used by search builder in the old old days before we had
5603    * super nice js widgets to do the hard work
5604    *
5605    * @param string $string
5606    * @param string $dataType
5607    *   The dataType we should check for the values, default integer.
5608    *
5609    * @return bool|array
5610    *   false if string does not match the pattern
5611    *   array of numeric values if string does match the pattern
5612    */
5613   public static function parseSearchBuilderString($string, $dataType = 'Integer') {
5614     $string = trim($string);
5615     if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') {
5616       Return FALSE;
5617     }
5618
5619     $string = substr($string, 1, -1);
5620     $values = explode(',', $string);
5621     if (empty($values)) {
5622       return FALSE;
5623     }
5624
5625     $returnValues = array();
5626     foreach ($values as $v) {
5627       if ($dataType == 'Integer' && !is_numeric($v)) {
5628         return FALSE;
5629       }
5630       elseif ($dataType == 'String' && !is_string($v)) {
5631         return FALSE;
5632       }
5633       $returnValues[] = trim($v);
5634     }
5635
5636     if (empty($returnValues)) {
5637       return FALSE;
5638     }
5639
5640     return $returnValues;
5641   }
5642
5643   /**
5644    * Convert the pseudo constants id's to their names
5645    *
5646    * @param CRM_Core_DAO $dao
5647    * @param bool $return
5648    *
5649    * @return array|NULL
5650    */
5651   public function convertToPseudoNames(&$dao, $return = FALSE) {
5652     if (empty($this->_pseudoConstantsSelect)) {
5653       return NULL;
5654     }
5655     $values = array();
5656     foreach ($this->_pseudoConstantsSelect as $key => $value) {
5657       if (!empty($this->_pseudoConstantsSelect[$key]['sorting'])) {
5658         continue;
5659       }
5660
5661       if (property_exists($dao, $value['idCol'])) {
5662         $val = $dao->$value['idCol'];
5663
5664         if (CRM_Utils_System::isNull($val)) {
5665           $dao->$key = NULL;
5666         }
5667         elseif ($baoName = CRM_Utils_Array::value('bao', $value, NULL)) {
5668           //preserve id value
5669           $idColumn = "{$key}_id";
5670           $dao->$idColumn = $val;
5671
5672           if ($key == 'state_province_name') {
5673             $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
5674           }
5675           else {
5676             $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::getLabel($baoName, $value['pseudoField'], $val);
5677           }
5678         }
5679         elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5680           $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
5681         }
5682         // FIX ME: we should potentially move this to component Query and write a wrapper function that
5683         // handles pseudoconstant fixes for all component
5684         elseif (in_array($value['pseudoField'], array('participant_status', 'participant_role'))) {
5685           $pseudoOptions = $viewValues = array();
5686           $pseudoOptions = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', $value['idCol']);
5687           foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $val) as $k => $v) {
5688             $viewValues[] = $pseudoOptions[$v];
5689           }
5690           $dao->$key = implode(', ', $viewValues);
5691         }
5692         else {
5693           $labels = CRM_Core_OptionGroup::values($value['pseudoField']);
5694           $dao->$key = $labels[$val];
5695         }
5696
5697         // return converted values in array format
5698         if ($return) {
5699           if (strpos($key, '-') !== FALSE) {
5700             $keyVal = explode('-', $key);
5701             $current = &$values;
5702             $lastElement = array_pop($keyVal);
5703             foreach ($keyVal as $v) {
5704               if (!array_key_exists($v, $current)) {
5705                 $current[$v] = array();
5706               }
5707               $current = &$current[$v];
5708             }
5709             $current[$lastElement] = $dao->$key;
5710           }
5711           else {
5712             $values[$key] = $dao->$key;
5713           }
5714         }
5715       }
5716     }
5717     return $values;
5718   }
5719
5720   /**
5721    * Include pseudo fields LEFT JOIN.
5722    * @param string|array $sort can be a object or string
5723    *
5724    * @return array|NULL
5725    */
5726   public function includePseudoFieldsJoin($sort) {
5727     if (!$sort || empty($this->_pseudoConstantsSelect)) {
5728       return NULL;
5729     }
5730     $sort = is_string($sort) ? $sort : $sort->orderBy();
5731     $present = array();
5732
5733     foreach ($this->_pseudoConstantsSelect as $name => $value) {
5734       if (!empty($value['table'])) {
5735         $regex = "/({$value['table']}\.|{$name})/";
5736         if (preg_match($regex, $sort)) {
5737           $this->_elemnt[$value['element']] = 1;
5738           $this->_select[$value['element']] = $value['select'];
5739           $this->_pseudoConstantsSelect[$name]['sorting'] = 1;
5740           $present[$value['table']] = $value['join'];
5741         }
5742       }
5743     }
5744     $presentSimpleFrom = $present;
5745
5746     if (array_key_exists('civicrm_worldregion', $this->_whereTables) &&
5747       array_key_exists('civicrm_country', $presentSimpleFrom)
5748     ) {
5749       unset($presentSimpleFrom['civicrm_country']);
5750     }
5751     if (array_key_exists('civicrm_worldregion', $this->_tables) &&
5752       array_key_exists('civicrm_country', $present)
5753     ) {
5754       unset($present['civicrm_country']);
5755     }
5756
5757     $presentClause = $presentSimpleFromClause = NULL;
5758     if (!empty($present)) {
5759       $presentClause = implode(' ', $present);
5760     }
5761     if (!empty($presentSimpleFrom)) {
5762       $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5763     }
5764
5765     $this->_fromClause = $this->_fromClause . $presentClause;
5766     $this->_simpleFromClause = $this->_simpleFromClause . $presentSimpleFromClause;
5767
5768     return array($presentClause, $presentSimpleFromClause);
5769   }
5770
5771   /**
5772    * Build qill for field.
5773    *
5774    * Qill refers to the query detail visible on the UI.
5775    *
5776    * @param $daoName
5777    * @param $fieldName
5778    * @param $fieldValue
5779    * @param $op
5780    * @param array $pseduoExtraParam
5781    *
5782    * @return array
5783    */
5784   public static function buildQillForFieldValue($daoName = NULL, $fieldName, $fieldValue, $op, $pseduoExtraParam = array()) {
5785     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
5786
5787     if ($fieldName == 'activity_type_id') {
5788       $pseduoOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
5789     }
5790     elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
5791       $pseduoOptions = CRM_Event_BAO_Event::getEvents(0, $fieldValue, TRUE, TRUE, TRUE);
5792     }
5793     elseif ($fieldName == 'contribution_product_id') {
5794       $pseduoOptions = CRM_Contribute_PseudoConstant::products();
5795     }
5796     elseif ($daoName == 'CRM_Contact_DAO_Group' && $fieldName == 'id') {
5797       $pseduoOptions = CRM_Core_PseudoConstant::group();
5798     }
5799     elseif ($daoName) {
5800       $pseduoOptions = CRM_Core_PseudoConstant::get($daoName, $fieldName, $pseduoExtraParam = array());
5801     }
5802
5803     //API usually have fieldValue format as array(operator => array(values)),
5804     //so we need to separate operator out of fieldValue param
5805     if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5806       $op = key($fieldValue);
5807       $fieldValue = $fieldValue[$op];
5808     }
5809
5810     if (is_array($fieldValue)) {
5811       $qillString = array();
5812       if (!empty($pseduoOptions)) {
5813         foreach ((array) $fieldValue as $val) {
5814           $qillString[] = CRM_Utils_Array::value($val, $pseduoOptions, $val);
5815         }
5816         $fieldValue = implode(', ', $qillString);
5817       }
5818       else {
5819         $fieldValue = implode(', ', $fieldValue);
5820       }
5821     }
5822     elseif (!empty($pseduoOptions) && array_key_exists($fieldValue, $pseduoOptions)) {
5823       $fieldValue = $pseduoOptions[$fieldValue];
5824     }
5825
5826     return array(CRM_Utils_Array::value($op, $qillOperators, $op), $fieldValue);
5827   }
5828
5829 }