tests/phpunit/CRM/Contact/BAO/QueryTest.php

   1 <?php
   2
   3 /**
   4  *  Include dataProvider for tests
   5  *
   6  * @group headless
   7  */
   8 class CRM_Contact_BAO_QueryTest extends CiviUnitTestCase {
   9
  10   use CRMTraits_Financial_FinancialACLTrait;
  11   use CRMTraits_Financial_PriceSetTrait;
  12
  13   /**
  14    * @return CRM_Contact_BAO_QueryTestDataProvider
  15    */
  16   public function dataProvider() {
  17     return new CRM_Contact_BAO_QueryTestDataProvider();
  18   }
  19
  20   public function setUp() {
  21     parent::setUp();
  22   }
  23
  24   /**
  25    * Clean up after test.
  26    *
  27    * @throws \Exception
  28    */
  29   public function tearDown() {
  30     $this->quickCleanUpFinancialEntities();
  31     $tablesToTruncate = [
  32       'civicrm_group_contact',
  33       'civicrm_group',
  34       'civicrm_saved_search',
  35       'civicrm_entity_tag',
  36       'civicrm_tag',
  37       'civicrm_contact',
  38       'civicrm_address',
  39     ];
  40     $this->quickCleanup($tablesToTruncate);
  41     parent::tearDown();
  42   }
  43
  44   /**
  45    *  Test CRM_Contact_BAO_Query::searchQuery().
  46    *
  47    * @dataProvider dataProvider
  48    *
  49    * @param $fv
  50    * @param $count
  51    * @param $ids
  52    * @param $full
  53    */
  54   public function testSearch($fv, $count, $ids, $full) {
  55     $this->callAPISuccess('SavedSearch', 'create', ['form_values' => 'a:9:{s:5:"qfKey";s:32:"0123456789abcdef0123456789abcdef";s:13:"includeGroups";a:1:{i:0;s:1:"3";}s:13:"excludeGroups";a:0:{}s:11:"includeTags";a:0:{}s:11:"excludeTags";a:0:{}s:4:"task";s:2:"14";s:8:"radio_ts";s:6:"ts_all";s:14:"customSearchID";s:1:"4";s:17:"customSearchClass";s:36:"CRM_Contact_Form_Search_Custom_Group";}']);
  56     $this->callAPISuccess('SavedSearch', 'create', ['form_values' => 'a:9:{s:5:"qfKey";s:32:"0123456789abcdef0123456789abcdef";s:13:"includeGroups";a:1:{i:0;s:1:"3";}s:13:"excludeGroups";a:0:{}s:11:"includeTags";a:0:{}s:11:"excludeTags";a:0:{}s:4:"task";s:2:"14";s:8:"radio_ts";s:6:"ts_all";s:14:"customSearchID";s:1:"4";s:17:"customSearchClass";s:36:"CRM_Contact_Form_Search_Custom_Group";}']);
  57
  58     $tag7 = $this->ids['Tag'][7] = $this->tagCreate(['name' => 'Test Tag 7', 'description' => 'Test Tag 7'])['id'];
  59     $tag9 = $this->ids['Tag'][9] = $this->tagCreate(['name' => 'Test Tag 9', 'description' => 'Test Tag 9'])['id'];
  60     $this->tagCreate(['name' => 'Test Tag 10']);
  61     $groups = [
  62       3 => ['name' => 'Test Group 3'],
  63       4 => ['name' => 'Test Smart Group 4', 'saved_search_id' => 1],
  64       5 => ['name' => 'Test Group 5'],
  65       6 => ['name' => 'Test Smart Group 6', 'saved_search_id' => 2],
  66     ];
  67
  68     foreach ($groups as $id => $group) {
  69       $this->ids['Group'][$id] = $this->groupCreate(array_merge($group, ['title' => $group['name']]));
  70     }
  71     $individuals = [
  72       ['first_name' => 'Test', 'last_name' => 'Test Contact 9', 'gender_id' => 1, 'prefix_id' => 1, 'suffix_id' => 1],
  73       ['first_name' => 'Test', 'last_name' => 'Test Contact 10', 'gender_id' => 2, 'prefix_id' => 2, 'suffix_id' => 2, 'api.entity_tag.create' => ['tag_id' => $tag9]],
  74       ['first_name' => 'Test', 'last_name' => 'Test Contact 11', 'gender_id' => 3, 'prefix_id' => 3, 'suffix_id' => 3, 'api.entity_tag.create' => ['tag_id' => $tag7]],
  75       [
  76         'first_name' => 'Test',
  77         'last_name' => 'Test Contact 12',
  78         'gender_id' => 3,
  79         'prefix_id' => 4,
  80         'suffix_id' => 4,
  81         'api.entity_tag.create' => ['tag_id' => $tag9],
  82         'api.entity_tag.create.2' => ['tag_id' => $tag7],
  83       ],
  84       ['first_name' => 'Test', 'last_name' => 'Test Contact 13', 'gender_id' => 2, 'prefix_id' => 2, 'suffix_id' => 2],
  85       ['first_name' => 'Test', 'last_name' => 'Test Contact 14', 'gender_id' => 3, 'prefix_id' => 4, 'suffix_id' => 4, 'api.entity_tag.create' => ['tag_id' => $tag9]],
  86       ['first_name' => 'Test', 'last_name' => 'Test Contact 15', 'gender_id' => 3, 'prefix_id' => 4, 'suffix_id' => 5, 'api.entity_tag.create' => ['tag_id' => $tag7]],
  87       [
  88         'first_name' => 'Test',
  89         'last_name' => 'Test Contact 16',
  90         'gender_id' => 3,
  91         'prefix_id' => 4,
  92         'suffix_id' => 6,
  93         'api.entity_tag.create' => ['tag_id' => $tag9],
  94         'api.entity_tag.create.2' => ['tag_id' => $tag7],
  95       ],
  96       ['first_name' => 'Test', 'last_name' => 'Test Contact 17', 'gender_id' => 2, 'prefix_id' => 4, 'suffix_id' => 7],
  97       ['first_name' => 'Test', 'last_name' => 'Test Contact 18', 'gender_id' => 2, 'prefix_id' => 4, 'suffix_id' => 4, 'api.entity_tag.create' => ['tag_id' => $tag9]],
  98       ['first_name' => 'Test', 'last_name' => 'Test Contact 19', 'gender_id' => 2, 'prefix_id' => 4, 'suffix_id' => 6, 'api.entity_tag.create.2' => ['tag_id' => $tag7]],
  99       [
 100         'first_name' => 'Test',
 101         'last_name' => 'Test Contact 20',
 102         'gender_id' => 1,
 103         'prefix_id' => 4,
 104         'suffix_id' => 6,
 105         'api.entity_tag.create' => ['tag_id' => $tag9],
 106         'api.entity_tag.create.2' => ['tag_id' => $tag7],
 107       ],
 108       ['first_name' => 'Test', 'last_name' => 'Test Contact 21', 'gender_id' => 3, 'prefix_id' => 1, 'suffix_id' => 6],
 109       ['first_name' => 'Test', 'last_name' => 'Test Contact 22', 'gender_id' => 1, 'prefix_id' => 1, 'suffix_id' => 1, 'api.entity_tag.create' => ['tag_id' => $tag9]],
 110       ['first_name' => 'Test', 'last_name' => 'Test Contact 23', 'gender_id' => 3, 'prefix_id' => 1, 'suffix_id' => 1, 'api.entity_tag.create' => ['tag_id' => $tag7]],
 111       [
 112         'first_name' => 'Test',
 113         'last_name' => 'Test Contact 24',
 114         'gender_id' => 3,
 115         'prefix_id' => 3,
 116         'suffix_id' => 2,
 117         'api.entity_tag.create' => ['tag_id' => $tag9],
 118         'api.entity_tag.create.2' => ['tag_id' => $tag7],
 119       ],
 120     ];
 121     foreach ($individuals as $individual) {
 122       $this->ids['Contact'][$individual['last_name']] = $this->individualCreate($individual);
 123     }
 124     $groupContacts = [
 125       [5 => 13],
 126       [5 => 14],
 127       [5 => 15],
 128       [5 => 16],
 129       [5 => 21],
 130       [5 => 22],
 131       [5 => 23],
 132       [5 => 24],
 133       [3 => 17],
 134       [3 => 18],
 135       [3 => 19],
 136       [3 => 20],
 137       [3 => 21],
 138       [3 => 22],
 139       [3 => 23],
 140       [3 => 24],
 141     ];
 142     foreach ($groupContacts as $group) {
 143       $groupID = $this->ids['Group'][key($group)];
 144       $contactID = $this->ids['Contact']['Test Contact ' . reset($group)];
 145       $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $contactID, 'status' => 'Added']);
 146     }
 147
 148     // We have migrated from a hard-coded dataset to a dynamic one but are still working with the same
 149     // dataprovider at this stage -> wrangle.
 150     foreach ($fv as $key => $value) {
 151       $entity = ucfirst($key);
 152       if (!array_key_exists($entity, $this->ids)) {
 153         continue;
 154       }
 155       if (is_numeric($value)) {
 156         $fv[$key] = $this->ids[$entity][$value];
 157       }
 158       elseif (!empty($value[0])) {
 159         foreach ($value as $index => $oldGroup) {
 160           $fv[$key][$index] = $this->ids[$entity][$oldGroup];
 161         }
 162       }
 163       else {
 164         foreach (array_keys($value) as $index) {
 165           unset($fv[$key][$index]);
 166           $fv[$key][$this->ids[$entity][$index]] = 1;
 167         }
 168       }
 169     }
 170
 171     $params = CRM_Contact_BAO_Query::convertFormValues($fv);
 172     $obj = new CRM_Contact_BAO_Query($params);
 173
 174     // let's set useGroupBy=true since we are listing contacts here who might belong to
 175     // more than one group / tag / notes etc.
 176     $obj->_useGroupBy = TRUE;
 177
 178     $dao = $obj->searchQuery();
 179
 180     $contacts = [];
 181     while ($dao->fetch()) {
 182       $contacts[] = $dao->contact_id;
 183     }
 184
 185     sort($contacts, SORT_NUMERIC);
 186
 187     $expectedIDs = [];
 188     foreach ($ids as $id) {
 189       $expectedIDs[] = $this->ids['Contact']['Test Contact ' . $id];
 190     }
 191     $this->assertEquals($expectedIDs, $contacts);
 192   }
 193
 194   /**
 195    * Check that we get a successful result querying for home address.
 196    * CRM-14263 search builder failure with search profile & address in criteria
 197    */
 198   public function testSearchProfileHomeCityCRM14263() {
 199     $contactID = $this->individualCreate();
 200     CRM_Core_Config::singleton()->defaultSearchProfileID = 1;
 201     $this->callAPISuccess('address', 'create', [
 202       'contact_id' => $contactID,
 203       'city' => 'Cool City',
 204       'location_type_id' => 1,
 205     ]);
 206     $params = [
 207       0 => [
 208         0 => 'city-1',
 209         1 => '=',
 210         2 => 'Cool City',
 211         3 => 1,
 212         4 => 0,
 213       ],
 214     ];
 215     $returnProperties = [
 216       'contact_type' => 1,
 217       'contact_sub_type' => 1,
 218       'sort_name' => 1,
 219     ];
 220
 221     $queryObj = new CRM_Contact_BAO_Query($params, $returnProperties);
 222     try {
 223       $resultDAO = $queryObj->searchQuery();
 224       $this->assertTrue($resultDAO->fetch());
 225     }
 226     catch (PEAR_Exception $e) {
 227       $err = $e->getCause();
 228       $this->fail('invalid SQL created' . $e->getMessage() . " " . $err->userinfo);
 229
 230     }
 231   }
 232
 233   /**
 234    * Check that we get a successful result querying for home address.
 235    * CRM-14263 search builder failure with search profile & address in criteria
 236    */
 237   public function testSearchProfileHomeCityNoResultsCRM14263() {
 238     $contactID = $this->individualCreate();
 239     CRM_Core_Config::singleton()->defaultSearchProfileID = 1;
 240     $this->callAPISuccess('address', 'create', [
 241       'contact_id' => $contactID,
 242       'city' => 'Cool City',
 243       'location_type_id' => 1,
 244     ]);
 245     $params = [
 246       0 => [
 247         0 => 'city-1',
 248         1 => '=',
 249         2 => 'Dumb City',
 250         3 => 1,
 251         4 => 0,
 252       ],
 253     ];
 254     $returnProperties = [
 255       'contact_type' => 1,
 256       'contact_sub_type' => 1,
 257       'sort_name' => 1,
 258     ];
 259
 260     $queryObj = new CRM_Contact_BAO_Query($params, $returnProperties);
 261     try {
 262       $resultDAO = $queryObj->searchQuery();
 263       $this->assertFalse($resultDAO->fetch());
 264     }
 265     catch (PEAR_Exception $e) {
 266       $err = $e->getCause();
 267       $this->fail('invalid SQL created' . $e->getMessage() . " " . $err->userinfo);
 268
 269     }
 270   }
 271
 272   /**
 273    * Test searchPrimaryDetailsOnly setting.
 274    */
 275   public function testSearchPrimaryLocTypes() {
 276     $contactID = $this->individualCreate();
 277     $params = [
 278       'contact_id' => $contactID,
 279       'email' => 'primary@example.com',
 280       'is_primary' => 1,
 281     ];
 282     $this->callAPISuccess('email', 'create', $params);
 283
 284     unset($params['is_primary']);
 285     $params['email'] = 'secondary@team.com';
 286     $this->callAPISuccess('email', 'create', $params);
 287
 288     foreach ([0, 1] as $searchPrimary) {
 289       Civi::settings()->set('searchPrimaryDetailsOnly', $searchPrimary);
 290
 291       $params = [
 292         0 => [
 293           0 => 'email',
 294           1 => 'LIKE',
 295           2 => 'sEcondary@example.com',
 296           3 => 0,
 297           4 => 1,
 298         ],
 299       ];
 300       $returnProperties = [
 301         'contact_type' => 1,
 302         'contact_sub_type' => 1,
 303         'sort_name' => 1,
 304       ];
 305
 306       $queryObj = new CRM_Contact_BAO_Query($params, $returnProperties);
 307       $resultDAO = $queryObj->searchQuery();
 308
 309       if ($searchPrimary) {
 310         $this->assertEquals($resultDAO->N, 0);
 311       }
 312       else {
 313         //Assert secondary email gets included in search results.
 314         while ($resultDAO->fetch()) {
 315           $this->assertEquals('secondary@example.com', $resultDAO->email);
 316         }
 317       }
 318
 319       // API should always return primary email.
 320       $result = $this->callAPISuccess('Contact', 'get', ['contact_id' => $contactID]);
 321       $this->assertEquals('primary@example.com', $result['values'][$contactID]['email']);
 322     }
 323   }
 324
 325   /**
 326    *  Test created to prove failure of search on state when location
 327    *  display name is different form location name (issue 607)
 328    */
 329   public function testSearchOtherLocationUpperLower() {
 330
 331     $params = [
 332       0 => [
 333         0 => 'state_province-4',
 334         1 => 'IS NOT EMPTY',
 335         2 => '',
 336         3 => 1,
 337         4 => 0,
 338       ],
 339     ];
 340     $returnProperties = [
 341       'contact_type' => 1,
 342       'contact_sub_type' => 1,
 343       'sort_name' => 1,
 344       'location' => [
 345         'other' => [
 346           'location_type' => 4,
 347           'state_province' => 1,
 348         ],
 349       ],
 350     ];
 351
 352     // update with the api does not work because it updates both the name and the
 353     // the display_name. Plain SQL however does the job
 354     CRM_Core_DAO::executeQuery('update civicrm_location_type set name=%2 where id=%1',
 355       [
 356         1 => [4, 'Integer'],
 357         2 => ['other', 'String'],
 358       ]);
 359
 360     $queryObj = new CRM_Contact_BAO_Query($params, $returnProperties);
 361
 362     $resultDAO = $queryObj->searchQuery();
 363     $resultDAO->fetch();
 364   }
 365
 366   /**
 367    * CRM-14263 search builder failure with search profile & address in criteria.
 368    *
 369    * We are retrieving primary here - checking the actual sql seems super prescriptive - but since the massive query object has
 370    * so few tests detecting any change seems good here :-)
 371    *
 372    * @dataProvider getSearchProfileData
 373    *
 374    * @param array $params
 375    * @param string $selectClause
 376    * @param string $whereClause
 377    *
 378    * @throws \CRM_Core_Exception
 379    */
 380   public function testSearchProfilePrimaryCityCRM14263($params, $selectClause, $whereClause) {
 381     $contactID = $this->individualCreate();
 382     CRM_Core_Config::singleton()->defaultSearchProfileID = 1;
 383     $this->callAPISuccess('address', 'create', [
 384       'contact_id' => $contactID,
 385       'city' => 'Cool CITY',
 386       'street_address' => 'Long STREET',
 387       'location_type_id' => 1,
 388     ]);
 389     $returnProperties = [
 390       'contact_type' => 1,
 391       'contact_sub_type' => 1,
 392       'sort_name' => 1,
 393     ];
 394     $expectedSQL = "SELECT contact_a.id as contact_id, contact_a.contact_type as `contact_type`, contact_a.contact_sub_type as `contact_sub_type`, contact_a.sort_name as `sort_name`, civicrm_address.id as address_id, " . $selectClause . "  FROM civicrm_contact contact_a LEFT JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 ) WHERE  (  ( " . $whereClause . " )  )  AND (contact_a.is_deleted = 0)    ORDER BY `contact_a`.`sort_name` ASC, `contact_a`.`id` ";
 395     $queryObj = new CRM_Contact_BAO_Query($params, $returnProperties);
 396     try {
 397       $this->assertLike($expectedSQL, $queryObj->getSearchSQL());
 398       list($select, $from, $where, $having) = $queryObj->query();
 399       $dao = CRM_Core_DAO::executeQuery("$select $from $where $having");
 400       $dao->fetch();
 401       $this->assertEquals('Anderson, Anthony', $dao->sort_name);
 402     }
 403     catch (PEAR_Exception $e) {
 404       $err = $e->getCause();
 405       $this->fail('invalid SQL created' . $e->getMessage() . " " . $err->userinfo);
 406
 407     }
 408   }
 409
 410   /**
 411    * Get data sets to test for search.
 412    */
 413   public function getSearchProfileData() {
 414     return [
 415       [
 416         [['city', '=', 'Cool City', 1, 0]],
 417         "civicrm_address.city as `city`",
 418         "civicrm_address.city = 'Cool City'",
 419       ],
 420       [
 421         // Note that in the query 'long street' is lower cased. We eventually want to change that & not mess with the vars - it turns out
 422         // it doesn't work on some charsets. However, the the lcasing affects more vars & we are looking to stagger removal of lcasing 'in case'
 423         // (although we have been removing without blowback since 2017)
 424         [['street_address', '=', 'Long Street', 1, 0]],
 425         "civicrm_address.street_address as `street_address`",
 426         "civicrm_address.street_address LIKE '%Long Street%'",
 427       ],
 428     ];
 429   }
 430
 431   /**
 432    * Test set up to test calling the query object per GroupContactCache BAO usage.
 433    *
 434    * CRM-17254 ensure that if only the contact_id is required other fields should
 435    * not be appended.
 436    */
 437   public function testGroupContactCacheAddSearch() {
 438     $returnProperties = ['contact_id'];
 439     $params = [['group', 'IN', [1], 0, 0]];
 440
 441     $query = new CRM_Contact_BAO_Query(
 442       $params, $returnProperties,
 443       NULL, TRUE, FALSE, 1,
 444       TRUE,
 445       TRUE, FALSE
 446     );
 447
 448     list($select) = $query->query(FALSE);
 449     $this->assertEquals('SELECT contact_a.id as contact_id', $select);
 450   }
 451
 452   /**
 453    * Test smart groups with non-numeric don't fail on range queries.
 454    *
 455    * CRM-14720
 456    */
 457   public function testNumericPostal() {
 458     // Precaution as hitting some inconsistent set up running in isolation vs in the suite.
 459     CRM_Core_DAO::executeQuery('UPDATE civicrm_address SET postal_code = NULL');
 460
 461     $this->individualCreate(['api.address.create' => ['postal_code' => 5, 'location_type_id' => 'Main']]);
 462     $this->individualCreate(['api.address.create' => ['postal_code' => 'EH10 4RB-889', 'location_type_id' => 'Main']]);
 463     $this->individualCreate(['api.address.create' => ['postal_code' => '4', 'location_type_id' => 'Main']]);
 464     $this->individualCreate(['api.address.create' => ['postal_code' => '6', 'location_type_id' => 'Main']]);
 465     $this->individualCreate(['api.address.create' => ['street_address' => 'just a street', 'location_type_id' => 'Main']]);
 466     $this->individualCreate(['api.address.create' => ['postal_code' => '12345678444455555555555555555555555555555555551314151617181920', 'location_type_id' => 'Main']]);
 467
 468     $params = [['postal_code_low', '=', 5, 0, 0]];
 469     CRM_Contact_BAO_Query::convertFormValues($params);
 470
 471     $query = new CRM_Contact_BAO_Query(
 472       $params, ['contact_id'],
 473       NULL, TRUE, FALSE, 1,
 474       TRUE,
 475       TRUE, FALSE
 476     );
 477
 478     $sql = $query->query(FALSE);
 479     $result = CRM_Core_DAO::executeQuery(implode(' ', $sql));
 480     $this->assertEquals(2, $result->N);
 481
 482     // We save this as a smart group and then load it. With mysql warnings on & CRM-14720 this
 483     // results in mysql warnings & hence fatal errors.
 484     /// I was unable to get mysql warnings to activate in the context of the unit tests - but
 485     // felt this code still provided a useful bit of coverage as it runs the various queries to load
 486     // the group & could generate invalid sql if a bug were introduced.
 487     $groupParams = ['title' => 'postal codes', 'formValues' => $params, 'is_active' => 1];
 488     $group = CRM_Contact_BAO_Group::createSmartGroup($groupParams);
 489     CRM_Contact_BAO_GroupContactCache::load($group, TRUE);
 490   }
 491
 492   /**
 493    * Test searches are case insensitive.
 494    */
 495   public function testCaseInsensitive() {
 496     $orgID = $this->organizationCreate(['organization_name' => 'BOb']);
 497     $params = [
 498       'display_name' => 'Minnie Mouse',
 499       'first_name' => 'Minnie',
 500       'last_name' => 'Mouse',
 501       'employer_id' => $orgID,
 502       'contact_type' => 'Individual',
 503       'nick_name' => 'Mins',
 504     ];
 505     $this->callAPISuccess('Contact', 'create', $params);
 506     unset($params['contact_type']);
 507     foreach ($params as $key => $value) {
 508       if ($key == 'employer_id') {
 509         $searchParams = [['current_employer', '=', 'bob', 0, 1]];
 510       }
 511       else {
 512         $searchParams = [[$key, '=', strtolower($value), 0, 1]];
 513       }
 514       $query = new CRM_Contact_BAO_Query($searchParams);
 515       $result = $query->apiQuery($searchParams);
 516       $this->assertEquals(1, count($result[0]), 'search for ' . $key);
 517       $contact = reset($result[0]);
 518       $this->assertEquals('Minnie Mouse', $contact['display_name']);
 519       $this->assertEquals('BOb', $contact['current_employer']);
 520     }
 521   }
 522
 523   /**
 524    * Test smart groups with non-numeric don't fail on equal queries.
 525    *
 526    * CRM-14720
 527    */
 528   public function testNonNumericEqualsPostal() {
 529     $this->individualCreate(['api.address.create' => ['postal_code' => 5, 'location_type_id' => 'Main']]);
 530     $this->individualCreate(['api.address.create' => ['postal_code' => 'EH10 4RB-889', 'location_type_id' => 'Main']]);
 531     $this->individualCreate(['api.address.create' => ['postal_code' => '4', 'location_type_id' => 'Main']]);
 532     $this->individualCreate(['api.address.create' => ['postal_code' => '6', 'location_type_id' => 'Main']]);
 533
 534     $params = [['postal_code', '=', 'EH10 4RB-889', 0, 0]];
 535     CRM_Contact_BAO_Query::convertFormValues($params);
 536
 537     $query = new CRM_Contact_BAO_Query(
 538       $params, ['contact_id'],
 539       NULL, TRUE, FALSE, 1,
 540       TRUE,
 541       TRUE, FALSE
 542     );
 543
 544     $sql = $query->query(FALSE);
 545     $this->assertEquals("WHERE  ( civicrm_address.postal_code = 'EH10 4RB-889' )  AND (contact_a.is_deleted = 0)", $sql[2]);
 546     $result = CRM_Core_DAO::executeQuery(implode(' ', $sql));
 547     $this->assertEquals(1, $result->N);
 548
 549   }
 550
 551   public function testRelationshipDescription() {
 552     $relType = $this->callAPISuccess('RelationshipType', 'create', [
 553       'name_a_b' => uniqid('a'),
 554       'name_b_a' => uniqid('b'),
 555     ]);
 556     $contactID_a = $this->individualCreate([], 1);
 557     $contactID_b = $this->individualCreate([], 2);
 558     $contactID_c = $this->individualCreate([], 3);
 559     $contactID_d = $this->individualCreate([], 4);
 560     $desc = uniqid('rel', TRUE);
 561     $this->callAPISuccess('Relationship', 'create', [
 562       'contact_id_a' => $contactID_a,
 563       'contact_id_b' => $contactID_b,
 564       'relationship_type_id' => $relType['id'],
 565       'is_active' => 1,
 566       'description' => $desc,
 567     ]);
 568     $this->callAPISuccess('Relationship', 'create', [
 569       'contact_id_a' => $contactID_c,
 570       'contact_id_b' => $contactID_d,
 571       'relationship_type_id' => $relType['id'],
 572       'is_active' => 1,
 573       'description' => 'nothing of interest',
 574     ]);
 575     $params = [
 576       ['relation_description', '=', substr($desc, 3, 18), 0, 0],
 577     ];
 578
 579     $query = new CRM_Contact_BAO_Query($params);
 580     $dao = $query->searchQuery();
 581     // This is a little weird but seems consistent with the behavior of the search form in general.
 582     // Technically there are 2 contacts who share a relationship with the description searched for,
 583     // so one might expect the search form to return both of them instead of just Contact A... but it doesn't.
 584     $this->assertEquals('1', $dao->N, "Search query returns exactly 1 result?");
 585     $this->assertTrue($dao->fetch(), "Search query returns success?");
 586     $this->assertEquals($contactID_a, $dao->contact_id, "Search query returns contact A?");
 587   }
 588
 589   public function testNonReciprocalRelationshipTargetGroupIsCorrectResults() {
 590     $contactID_a = $this->individualCreate();
 591     $contactID_b = $this->individualCreate();
 592     $this->callAPISuccess('Relationship', 'create', [
 593       'contact_id_a' => $contactID_a,
 594       'contact_id_b' => $contactID_b,
 595       'relationship_type_id' => 1,
 596       'is_active' => 1,
 597     ]);
 598     // Create a group and add contact A to it.
 599     $groupID = $this->groupCreate();
 600     $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $contactID_a, 'status' => 'Added']);
 601
 602     // Add another (sans-relationship) contact to the group,
 603     $contactID_c = $this->individualCreate();
 604     $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $contactID_c, 'status' => 'Added']);
 605
 606     $params = [
 607       [
 608         0 => 'relation_type_id',
 609         1 => 'IN',
 610         2 =>
 611           [
 612             0 => '1_b_a',
 613           ],
 614         3 => 0,
 615         4 => 0,
 616       ],
 617       [
 618         0 => 'relation_target_group',
 619         1 => 'IN',
 620         2 =>
 621           [
 622             0 => $groupID,
 623           ],
 624         3 => 0,
 625         4 => 0,
 626       ],
 627     ];
 628
 629     $query = new CRM_Contact_BAO_Query($params);
 630     $dao = $query->searchQuery();
 631     $this->assertEquals('1', $dao->N, "Search query returns exactly 1 result?");
 632     $this->assertTrue($dao->fetch(), "Search query returns success?");
 633     $this->assertEquals($contactID_b, $dao->contact_id, "Search query returns parent of contact A?");
 634   }
 635
 636   /**
 637    * @throws \CRM_Core_Exception
 638    */
 639   public function testReciprocalRelationshipTargetGroupIsCorrectResults() {
 640     $contactID_a = $this->individualCreate();
 641     $contactID_b = $this->individualCreate();
 642     $this->callAPISuccess('Relationship', 'create', [
 643       'contact_id_a' => $contactID_a,
 644       'contact_id_b' => $contactID_b,
 645       'relationship_type_id' => 2,
 646       'is_active' => 1,
 647     ]);
 648     // Create a group and add contact A to it.
 649     $groupID = $this->groupCreate();
 650     $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $contactID_a, 'status' => 'Added']);
 651
 652     // Add another (sans-relationship) contact to the group,
 653     $contactID_c = $this->individualCreate();
 654     $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $contactID_c, 'status' => 'Added']);
 655
 656     $params = [
 657       [
 658         0 => 'relation_type_id',
 659         1 => 'IN',
 660         2 =>
 661           [
 662             0 => '2_a_b',
 663           ],
 664         3 => 0,
 665         4 => 0,
 666       ],
 667       [
 668         0 => 'relation_target_group',
 669         1 => 'IN',
 670         2 =>
 671           [
 672             0 => $groupID,
 673           ],
 674         3 => 0,
 675         4 => 0,
 676       ],
 677     ];
 678
 679     $query = new CRM_Contact_BAO_Query($params);
 680     $dao = $query->searchQuery();
 681     $this->assertEquals('1', $dao->N, "Search query returns exactly 1 result?");
 682     $this->assertTrue($dao->fetch(), "Search query returns success?");
 683     $this->assertEquals($contactID_b, $dao->contact_id, "Search query returns spouse of contact A?");
 684   }
 685
 686   public function testReciprocalRelationshipTargetGroupUsesTempTable() {
 687     $groupID = $this->groupCreate();
 688     $params = [
 689       [
 690         0 => 'relation_type_id',
 691         1 => 'IN',
 692         2 =>
 693           [
 694             0 => '2_a_b',
 695           ],
 696         3 => 0,
 697         4 => 0,
 698       ],
 699       [
 700         0 => 'relation_target_group',
 701         1 => 'IN',
 702         2 =>
 703           [
 704             0 => $groupID,
 705           ],
 706         3 => 0,
 707         4 => 0,
 708       ],
 709     ];
 710     $sql = CRM_Contact_BAO_Query::getQuery($params);
 711     $this->assertContains('INNER JOIN civicrm_rel_temp_', $sql, "Query appears to use temporary table of compiled relationships?", TRUE);
 712   }
 713
 714   public function testRelationshipPermissionClause() {
 715     $params = [['relation_type_id', 'IN', ['1_b_a'], 0, 0], ['relation_permission', 'IN', [2], 0, 0]];
 716     $sql = CRM_Contact_BAO_Query::getQuery($params);
 717     $this->assertContains('(civicrm_relationship.is_permission_a_b IN (2))', $sql);
 718   }
 719
 720   /**
 721    * Test Relationship Clause
 722    *
 723    * @throws \CRM_Core_Exception
 724    */
 725   public function testRelationshipClause() {
 726     $today = date('Ymd');
 727     $from1 = " FROM civicrm_contact contact_a LEFT JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id ) LEFT JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
 728     $from2 = " FROM civicrm_contact contact_a LEFT JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id ) LEFT JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
 729     $where1 = "WHERE  ( (
 730 civicrm_relationship.is_active = 1 AND
 731 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
 732 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
 733 ) AND (contact_b.is_deleted = 0) AND civicrm_relationship.relationship_type_id IN (8) )  AND (contact_a.is_deleted = 0)";
 734     $where2 = "WHERE  ( (
 735 civicrm_relationship.is_active = 1 AND
 736 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
 737 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
 738 ) AND (contact_b.is_deleted = 0) AND civicrm_relationship.relationship_type_id IN (8,10) )  AND (contact_a.is_deleted = 0)";
 739     // Test Traditional single select format
 740     $params1 = [['relation_type_id', '=', '8_a_b', 0, 0]];
 741     $query1 = new CRM_Contact_BAO_Query(
 742       $params1, ['contact_id'],
 743       NULL, TRUE, FALSE, 1,
 744       TRUE,
 745       TRUE, FALSE
 746     );
 747     $sql1 = $query1->query(FALSE);
 748     $this->assertLike($from1, $sql1[1]);
 749     $this->assertLike($where1, $sql1[2]);
 750     // Test single relationship type selected in multiple select.
 751     $params2 = [['relation_type_id', 'IN', ['8_a_b'], 0, 0]];
 752     $query2 = new CRM_Contact_BAO_Query(
 753       $params2, ['contact_id'],
 754       NULL, TRUE, FALSE, 1,
 755       TRUE,
 756       TRUE, FALSE
 757     );
 758     $sql2 = $query2->query(FALSE);
 759     $this->assertLike($from1, $sql2[1]);
 760     $this->assertLike($where1, $sql2[2]);
 761     // Test multiple relationship types selected.
 762     $params3 = [['relation_type_id', 'IN', ['8_a_b', '10_a_b'], 0, 0]];
 763     $query3 = new CRM_Contact_BAO_Query(
 764       $params3, ['contact_id'],
 765       NULL, TRUE, FALSE, 1,
 766       TRUE,
 767       TRUE, FALSE
 768     );
 769     $sql3 = $query3->query(FALSE);
 770     $this->assertLike($from1, $sql3[1]);
 771     $this->assertLike($where2, $sql3[2]);
 772     // Test Multiple Relationship type selected where one doesn't actually exist.
 773     $params4 = [['relation_type_id', 'IN', ['8_a_b', '10_a_b', '14_a_b'], 0, 0]];
 774     $query4 = new CRM_Contact_BAO_Query(
 775       $params4, ['contact_id'],
 776       NULL, TRUE, FALSE, 1,
 777       TRUE,
 778       TRUE, FALSE
 779     );
 780     $sql4 = $query4->query(FALSE);
 781     $this->assertLike($from1, $sql4[1]);
 782     $this->assertLike($where2, $sql4[2]);
 783
 784     // Test Multiple b to a Relationship type  .
 785     $params5 = [['relation_type_id', 'IN', ['8_b_a', '10_b_a', '14_b_a'], 0, 0]];
 786     $query5 = new CRM_Contact_BAO_Query(
 787       $params5, ['contact_id'],
 788       NULL, TRUE, FALSE, 1,
 789       TRUE,
 790       TRUE, FALSE
 791     );
 792     $sql5 = $query5->query(FALSE);
 793     $this->assertLike($from2, $sql5[1]);
 794     $this->assertLike($where2, $sql5[2]);
 795   }
 796
 797   /**
 798    * Test we can narrow a group get by status.
 799    *
 800    * @throws \CRM_Core_Exception
 801    */
 802   public function testGetByGroupWithStatus() {
 803     $groupID = $this->groupCreate();
 804     $this->groupContactCreate($groupID, 3);
 805     $groupContactID = $this->callAPISuccessGetSingle('GroupContact', ['group_id' => $groupID, 'options' => ['limit' => 1]])['id'];
 806     $this->callAPISuccess('GroupContact', 'create', ['id' => $groupContactID, 'status' => 'Removed']);
 807     $queryObj = new CRM_Contact_BAO_Query([['group', '=', $groupID, 0, 0], ['group_contact_status', 'IN', ['Removed' => 1], 0, 0]]);
 808     $resultDAO = $queryObj->searchQuery();
 809     $this->assertEquals(1, $resultDAO->N);
 810
 811     $queryObj = new CRM_Contact_BAO_Query([['group', '=', $groupID, 0, 0], ['group_contact_status', 'IN', ['Added' => 1], 0, 0]]);
 812     $resultDAO = $queryObj->searchQuery();
 813     $this->assertEquals(2, $resultDAO->N);
 814
 815     $queryObj = new CRM_Contact_BAO_Query([['group', '=', $groupID, 0, 0]]);
 816     $resultDAO = $queryObj->searchQuery();
 817     $this->assertEquals(2, $resultDAO->N);
 818   }
 819
 820   /**
 821    * Test we can narrow a group get by status.
 822    *
 823    * @throws \Exception
 824    */
 825   public function testGetByGroupWithStatusSmartGroup() {
 826     $groupID = $this->smartGroupCreate();
 827     // This means they are actually all hard-added, which is fine for this purpose.
 828     $this->groupContactCreate($groupID, 3);
 829     $groupContactID = $this->callAPISuccessGetSingle('GroupContact', ['group_id' => $groupID, 'options' => ['limit' => 1]])['id'];
 830     $this->callAPISuccess('GroupContact', 'create', ['id' => $groupContactID, 'status' => 'Removed']);
 831
 832     $queryObj = new CRM_Contact_BAO_Query([['group', '=', $groupID, 0, 0], ['group_contact_status', 'IN', ['Removed' => 1], 0, 0]]);
 833     $resultDAO = $queryObj->searchQuery();
 834     $this->assertEquals(1, $resultDAO->N);
 835   }
 836
 837   /**
 838    * Test the group contact clause does not contain an OR.
 839    *
 840    * The search should return 3 contacts - 2 households in the smart group of
 841    * Contact Type = Household and one Individual hard-added to it. The
 842    * Household that meets both criteria should be returned once.
 843    *
 844    * @throws \Exception
 845    */
 846   public function testGroupClause() {
 847     $this->householdCreate();
 848     $householdID = $this->householdCreate();
 849     $individualID = $this->individualCreate();
 850     $groupID = $this->smartGroupCreate();
 851     $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $individualID, 'status' => 'Added']);
 852     $this->callAPISuccess('GroupContact', 'create', ['group_id' => $groupID, 'contact_id' => $householdID, 'status' => 'Added']);
 853
 854     // Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
 855     CRM_Contact_BAO_GroupContactCache::clearGroupContactCache($groupID);
 856
 857     $sql = CRM_Contact_BAO_Query::getQuery(
 858       [['group', 'IN', [$groupID], 0, 0]],
 859       ['contact_id']
 860     );
 861
 862     $dao = CRM_Core_DAO::executeQuery($sql);
 863     $this->assertEquals(3, $dao->N);
 864     $this->assertFalse(strstr($sql, ' OR '));
 865
 866     $sql = CRM_Contact_BAO_Query::getQuery(
 867       [['group', 'IN', [$groupID], 0, 0]],
 868       ['contact_id' => 1, 'group' => 1]
 869     );
 870
 871     $dao = CRM_Core_DAO::executeQuery($sql);
 872     $this->assertEquals(3, $dao->N);
 873     $this->assertFalse(strstr($sql, ' OR '), 'Query does not include or');
 874     while ($dao->fetch()) {
 875       $this->assertTrue(($dao->groups == $groupID || $dao->groups == ',' . $groupID), $dao->groups . ' includes ' . $groupID);
 876     }
 877   }
 878
 879   /**
 880    * CRM-19562 ensure that only ids are used for contact_id searching.
 881    */
 882   public function testContactIDClause() {
 883     $params = [
 884       ["mark_x_2", "=", 1, 0, 0],
 885       ["mark_x_foo@example.com", "=", 1, 0, 0],
 886     ];
 887     $returnProperties = [
 888       "sort_name" => 1,
 889       "email" => 1,
 890       "do_not_email" => 1,
 891       "is_deceased" => 1,
 892       "on_hold" => 1,
 893       "display_name" => 1,
 894       "preferred_mail_format" => 1,
 895     ];
 896     $numberOfContacts = 2;
 897     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
 898     try {
 899       $query->apiQuery($params, $returnProperties, NULL, NULL, 0, $numberOfContacts);
 900     }
 901     catch (Exception $e) {
 902       $this->assertEquals(
 903         "One of parameters  (value: foo@example.com) is not of the type Positive",
 904         $e->getMessage()
 905       );
 906       $this->assertTrue(TRUE);
 907       return;
 908     }
 909     $this->fail('Test failed for some reason which is not good');
 910   }
 911
 912   /**
 913    * Test the sorting on the contact ID query works.
 914    *
 915    * Checking for lack of fatal.
 916    *
 917    * @param string $sortOrder
 918    *   Param reflecting how sort is passed in.
 919    *   - 1_d is column 1 descending.
 920    *
 921    * @dataProvider getSortOptions
 922    */
 923   public function testContactIDQuery($sortOrder) {
 924     $selector = new CRM_Contact_Selector(NULL, ['radio_ts' => 'ts_all'], NULL, ['sort_name' => 1]);
 925     $selector->contactIDQuery([], $sortOrder);
 926   }
 927
 928   /**
 929    * Test the sorting on the contact ID query works with a profile search.
 930    *
 931    * Checking for lack of fatal.
 932    */
 933   public function testContactIDQueryProfileSearchResults() {
 934     $profile = $this->callAPISuccess('UFGroup', 'create', ['group_type' => 'Contact', 'name' => 'search', 'title' => 'search']);
 935     $this->callAPISuccess('UFField', 'create', [
 936       'uf_group_id' => $profile['id'],
 937       'field_name' => 'postal_code',
 938       'field_type' => 'Contact',
 939       'in_selector' => TRUE,
 940       'is_searchable' => TRUE,
 941       'label' => 'postal code',
 942       'visibility' => 'Public Pages and Listings',
 943     ]);
 944     $selector = new CRM_Contact_Selector(NULL, ['radio_ts' => 'ts_all', 'uf_group_id' => $profile['id']], NULL, ['sort_name' => 1]);
 945     $selector->contactIDQuery([], '2_d');
 946   }
 947
 948   /**
 949    * Get search options to reflect how a UI search would look.
 950    *
 951    * @return array
 952    */
 953   public function getSortOptions() {
 954     return [
 955       ['1_d'],
 956       ['2_d'],
 957       ['3_d'],
 958       ['4_d'],
 959       ['5_d'],
 960       ['6_d'],
 961     ];
 962   }
 963
 964   /**
 965    * Test the summary query does not add an acl clause when acls not enabled..
 966    */
 967   public function testGetSummaryQueryWithFinancialACLDisabled() {
 968     $this->createContributionsForSummaryQueryTests();
 969
 970     // Test the function directly
 971     $where = $from = NULL;
 972     $queryObject = new CRM_Contact_BAO_Query();
 973     $queryObject->appendFinancialTypeWhereAndFromToQueryStrings($where,
 974       $from);
 975     $this->assertEquals(NULL, $where);
 976     $this->assertEquals(NULL, $from);
 977
 978     // Test the function in action
 979     $queryObject = new CRM_Contact_BAO_Query([['contribution_source', '=', 'SSF', '', '']]);
 980     $summary = $queryObject->summaryContribution();
 981     $this->assertEquals([
 982       'total' => [
 983         'avg' => '$ 233.33',
 984         'amount' => '$ 1,400.00',
 985         'count' => 6,
 986       ],
 987       'cancel' => [
 988         'count' => 2,
 989         'amount' => '$ 100.00',
 990         'avg' => '$ 50.00',
 991       ],
 992     ], $summary);
 993   }
 994
 995   /**
 996    * Test the summary query accurately adds financial acl filters.
 997    */
 998   public function testGetSummaryQueryWithFinancialACLEnabled() {
 999     $where = $from = NULL;
1000     $this->createContributionsForSummaryQueryTests();
1001     $this->enableFinancialACLs();
1002     $this->createLoggedInUserWithFinancialACL();
1003
1004     // Test the function directly
1005     $queryObject = new CRM_Contact_BAO_Query();
1006     $queryObject->appendFinancialTypeWhereAndFromToQueryStrings($where,
1007       $from);
1008     $donationTypeID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Donation');
1009     $this->assertEquals(
1010       " LEFT JOIN civicrm_line_item li
1011                   ON civicrm_contribution.id = li.contribution_id AND
1012                      li.entity_table = 'civicrm_contribution' AND li.financial_type_id NOT IN ({$donationTypeID}) ", $from);
1013
1014     // Test the function in action
1015     $queryObject = new CRM_Contact_BAO_Query([['contribution_source', '=', 'SSF', '', '']]);
1016     $summary = $queryObject->summaryContribution();
1017     $this->assertEquals([
1018       'total' => [
1019         'avg' => '$ 200.00',
1020         'amount' => '$ 400.00',
1021         'count' => 2,
1022       ],
1023       'cancel' => [
1024         'count' => 1,
1025         'amount' => '$ 50.00',
1026         'avg' => '$ 50.00',
1027       ],
1028     ], $summary);
1029     $this->disableFinancialACLs();
1030   }
1031
1032   /**
1033    * Create contributions to test summary calculations.
1034    *
1035    * financial type     | cancel_date        |total_amount| source    | line_item_financial_types  |number_line_items| line_amounts
1036    * Donation           |NULL                | 100.00     |SSF         | Donation                  | 1                | 100.00
1037    * Member Dues        |NULL                | 100.00     |SSF         | Member Dues               | 1                | 100.00
1038    * Donation           |NULL                | 300.00     |SSF         | Event Fee,Event Fee       | 2                | 200.00,100.00
1039    * Donation           |NULL                | 300.00     |SSF         | Event Fee,Donation        | 2                | 200.00,100.00
1040    * Donation           |NULL                | 300.00     |SSF         | Donation,Donation         | 2                | 200.00,100.00
1041    * Donation           |2019-02-13 00:00:00 | 50.00      |SSF         | Donation                  | 1                | 50.00
1042    * Member Dues        |2019-02-13 00:00:00 | 50.00      |SSF         | Member Dues               | 1                | 50.00
1043    *
1044    * @throws \CRM_Core_Exception
1045    */
1046   protected function createContributionsForSummaryQueryTests() {
1047     $contactID = $this->individualCreate();
1048     $this->contributionCreate(['contact_id' => $contactID]);
1049     $this->contributionCreate([
1050       'contact_id' => $contactID,
1051       'total_amount' => 100,
1052       'financial_type_id' => 'Member Dues',
1053     ]);
1054     $eventFeeType = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Event Fee');
1055     $this->createContributionWithTwoLineItemsAgainstPriceSet(['contact_id' => $contactID, 'source' => 'SSF']);
1056     $this->createContributionWithTwoLineItemsAgainstPriceSet(['contact_id' => $contactID, 'source' => 'SSF'], [
1057       CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Donation'),
1058       $eventFeeType,
1059     ]);
1060     $this->createContributionWithTwoLineItemsAgainstPriceSet(['contact_id' => $contactID, 'source' => 'SSF'], [
1061       CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Donation'),
1062       CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Donation'),
1063     ]);
1064     $this->createContributionWithTwoLineItemsAgainstPriceSet(['contact_id' => $contactID, 'source' => 'SSF', 'financial_type_id' => $eventFeeType], [
1065       CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Donation'),
1066       CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'financial_type_id', 'Donation'),
1067     ]);
1068     $this->contributionCreate([
1069       'contact_id' => $contactID,
1070       'total_amount' => 50,
1071       'contribution_status_id' => 'Cancelled',
1072       'cancel_date' => 'yesterday',
1073     ]);
1074     $this->contributionCreate([
1075       'contact_id' => $contactID,
1076       'total_amount' => 50,
1077       'contribution_status_id' => 'Cancelled',
1078       'cancel_date' => 'yesterday',
1079       'financial_type_id' => 'Member Dues',
1080     ]);
1081   }
1082
1083 }