CRM/Contact/BAO/Query.php

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