CRM/Contact/BAO/Query.php

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