Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | */ |
33 | class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCache { | |
34 | ||
35 | static $_alreadyLoaded = array(); | |
36 | ||
a8eb1fe6 TO |
37 | /** |
38 | * Get a list of caching modes. | |
39 | * | |
40 | * @return array | |
41 | */ | |
42 | public static function getModes() { | |
43 | return array( | |
44 | // Flush expired caches in response to user actions. | |
45 | 'opportunistic' => ts('Opportunistic Flush'), | |
46 | ||
47 | // Flush expired caches via background cron jobs. | |
48 | 'deterministic' => ts('Cron Flush'), | |
49 | ); | |
50 | } | |
51 | ||
6a488035 | 52 | /** |
67d19299 | 53 | * Check to see if we have cache entries for this group. |
54 | * | |
55 | * If not, regenerate, else return. | |
6a488035 | 56 | * |
adf28ffd | 57 | * @param array $groupIDs |
77c5b619 | 58 | * Of group that we are checking against. |
6a488035 | 59 | * |
5396af74 | 60 | * @return bool |
a6c01b45 | 61 | * TRUE if we did not regenerate, FALSE if we did |
6a488035 | 62 | */ |
00be9182 | 63 | public static function check($groupIDs) { |
6a488035 TO |
64 | if (empty($groupIDs)) { |
65 | return TRUE; | |
66 | } | |
67 | ||
68 | return self::loadAll($groupIDs); | |
69 | } | |
70 | ||
abdb2607 | 71 | /** |
adf28ffd | 72 | * Formulate the query to see which groups needs to be refreshed. |
73 | * | |
74 | * The calculation is based on their cache date and the smartGroupCacheTimeOut | |
abdb2607 | 75 | * |
77c5b619 TO |
76 | * @param string $groupIDClause |
77 | * The clause which limits which groups we need to evaluate. | |
78 | * @param bool $includeHiddenGroups | |
79 | * Hidden groups are excluded by default. | |
abdb2607 | 80 | * |
a6c01b45 CW |
81 | * @return string |
82 | * the sql query which lists the groups that need to be refreshed | |
abdb2607 | 83 | */ |
e60f24eb | 84 | public static function groupRefreshedClause($groupIDClause = NULL, $includeHiddenGroups = FALSE) { |
4052239b | 85 | $smartGroupCacheTimeoutDateTime = self::getCacheInvalidDateTime(); |
abdb2607 DL |
86 | |
87 | $query = " | |
88 | SELECT g.id | |
89 | FROM civicrm_group g | |
90 | WHERE ( g.saved_search_id IS NOT NULL OR g.children IS NOT NULL ) | |
91 | AND g.is_active = 1 | |
4052239b | 92 | AND ( |
93 | g.cache_date IS NULL | |
94 | OR cache_date <= $smartGroupCacheTimeoutDateTime | |
95 | OR NOW() >= g.refresh_date | |
96 | )"; | |
abdb2607 DL |
97 | |
98 | if (!$includeHiddenGroups) { | |
99 | $query .= "AND (g.is_hidden = 0 OR g.is_hidden IS NULL)"; | |
100 | } | |
101 | ||
102 | if (!empty($groupIDClause)) { | |
103 | $query .= " AND ( $groupIDClause ) "; | |
104 | } | |
105 | ||
106 | return $query; | |
107 | } | |
108 | ||
109 | /** | |
adf28ffd | 110 | * Check to see if a group has been refreshed recently. |
111 | * | |
112 | * This is primarily used in a locking scenario when some other process might have refreshed things underneath | |
abdb2607 DL |
113 | * this process |
114 | * | |
77c5b619 TO |
115 | * @param int $groupID |
116 | * The group ID. | |
117 | * @param bool $includeHiddenGroups | |
118 | * Hidden groups are excluded by default. | |
abdb2607 | 119 | * |
a6c01b45 CW |
120 | * @return string |
121 | * the sql query which lists the groups that need to be refreshed | |
abdb2607 | 122 | */ |
00be9182 | 123 | public static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) { |
abdb2607 DL |
124 | $query = self::groupRefreshedClause("g.id = %1", $includeHiddenGroups); |
125 | $params = array(1 => array($groupID, 'Integer')); | |
126 | ||
4f53db5a | 127 | // if the query returns the group ID, it means the group is a valid candidate for refreshing |
abdb2607 DL |
128 | return CRM_Core_DAO::singleValueQuery($query, $params); |
129 | } | |
130 | ||
6a488035 | 131 | /** |
adf28ffd | 132 | * Check to see if we have cache entries for this group. |
133 | * | |
6a488035 TO |
134 | * if not, regenerate, else return |
135 | * | |
adf28ffd | 136 | * @param int|array $groupIDs groupIDs of group that we are checking against |
6a488035 | 137 | * if empty, all groups are checked |
77c5b619 TO |
138 | * @param int $limit |
139 | * Limits the number of groups we evaluate. | |
6a488035 | 140 | * |
5396af74 | 141 | * @return bool |
a6c01b45 | 142 | * TRUE if we did not regenerate, FALSE if we did |
6a488035 | 143 | */ |
e60f24eb | 144 | public static function loadAll($groupIDs = NULL, $limit = 0) { |
6a488035 TO |
145 | // ensure that all the smart groups are loaded |
146 | // this function is expensive and should be sparingly used if groupIDs is empty | |
6a488035 | 147 | if (empty($groupIDs)) { |
e60f24eb | 148 | $groupIDClause = NULL; |
481a74f4 | 149 | $groupIDs = array(); |
6a488035 TO |
150 | } |
151 | else { | |
152 | if (!is_array($groupIDs)) { | |
153 | $groupIDs = array($groupIDs); | |
154 | } | |
155 | ||
b44e3f84 | 156 | // note escapeString is a must here and we can't send the imploded value as second argument to |
6a488035 TO |
157 | // the executeQuery(), since that would put single quote around the string and such a string |
158 | // of comma separated integers would not work. | |
0e4e5a49 | 159 | $groupIDString = CRM_Core_DAO::escapeString(implode(', ', $groupIDs)); |
6a488035 | 160 | |
abdb2607 | 161 | $groupIDClause = "g.id IN ({$groupIDString})"; |
6a488035 TO |
162 | } |
163 | ||
abdb2607 | 164 | $query = self::groupRefreshedClause($groupIDClause); |
6a488035 TO |
165 | |
166 | $limitClause = $orderClause = NULL; | |
167 | if ($limit > 0) { | |
168 | $limitClause = " LIMIT 0, $limit"; | |
169 | $orderClause = " ORDER BY g.cache_date, g.refresh_date"; | |
170 | } | |
e2422b8f | 171 | // We ignore hidden groups and disabled groups |
abdb2607 | 172 | $query .= " |
6a488035 | 173 | $orderClause |
f9e16e9a | 174 | $limitClause |
6a488035 TO |
175 | "; |
176 | ||
177 | $dao = CRM_Core_DAO::executeQuery($query); | |
178 | $processGroupIDs = array(); | |
179 | $refreshGroupIDs = $groupIDs; | |
180 | while ($dao->fetch()) { | |
181 | $processGroupIDs[] = $dao->id; | |
182 | ||
183 | // remove this id from refreshGroupIDs | |
184 | foreach ($refreshGroupIDs as $idx => $gid) { | |
185 | if ($gid == $dao->id) { | |
186 | unset($refreshGroupIDs[$idx]); | |
187 | break; | |
188 | } | |
189 | } | |
190 | } | |
191 | ||
192 | if (!empty($refreshGroupIDs)) { | |
82a837e9 | 193 | $refreshGroupIDString = CRM_Core_DAO::escapeString(implode(', ', $refreshGroupIDs)); |
a986056d | 194 | $time = self::getRefreshDateTime(); |
6a488035 TO |
195 | $query = " |
196 | UPDATE civicrm_group g | |
197 | SET g.refresh_date = $time | |
198 | WHERE g.id IN ( {$refreshGroupIDString} ) | |
199 | AND g.refresh_date IS NULL | |
200 | "; | |
82a837e9 | 201 | CRM_Core_DAO::executeQuery($query); |
6a488035 TO |
202 | } |
203 | ||
204 | if (empty($processGroupIDs)) { | |
205 | return TRUE; | |
206 | } | |
207 | else { | |
208 | self::add($processGroupIDs); | |
209 | return FALSE; | |
210 | } | |
211 | } | |
212 | ||
86538308 | 213 | /** |
adf28ffd | 214 | * Build the smart group cache for a given group. |
215 | * | |
100fef9d | 216 | * @param int $groupID |
86538308 | 217 | */ |
00be9182 | 218 | public static function add($groupID) { |
6a488035 TO |
219 | // first delete the current cache |
220 | self::remove($groupID); | |
221 | if (!is_array($groupID)) { | |
222 | $groupID = array($groupID); | |
223 | } | |
224 | ||
225 | $returnProperties = array('contact_id'); | |
226 | foreach ($groupID as $gid) { | |
1dbdc161 | 227 | $params = array(array('group', 'IN', array($gid), 0, 0)); |
abdb2607 | 228 | // the below call updates the cache table as a byproduct of the query |
6a488035 TO |
229 | CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, FALSE); |
230 | } | |
231 | } | |
232 | ||
86538308 | 233 | /** |
adf28ffd | 234 | * Store values into the group contact cache. |
235 | * | |
236 | * @todo review use of INSERT IGNORE. This function appears to be slower that inserting | |
237 | * with a left join. Also, 200 at once seems too little. | |
238 | * | |
100fef9d | 239 | * @param int $groupID |
adf28ffd | 240 | * @param array $values |
86538308 | 241 | */ |
00be9182 | 242 | public static function store(&$groupID, &$values) { |
6a488035 TO |
243 | $processed = FALSE; |
244 | ||
245 | // sort the values so we put group IDs in front and hence optimize | |
246 | // mysql storage (or so we think) CRM-9493 | |
247 | sort($values); | |
eb917190 | 248 | |
6a488035 TO |
249 | // to avoid long strings, lets do BULK_INSERT_COUNT values at a time |
250 | while (!empty($values)) { | |
251 | $processed = TRUE; | |
353ffa53 TO |
252 | $input = array_splice($values, 0, CRM_Core_DAO::BULK_INSERT_COUNT); |
253 | $str = implode(',', $input); | |
254 | $sql = "INSERT IGNORE INTO civicrm_group_contact_cache (group_id,contact_id) VALUES $str;"; | |
6a488035 TO |
255 | CRM_Core_DAO::executeQuery($sql); |
256 | } | |
257 | self::updateCacheTime($groupID, $processed); | |
258 | } | |
259 | ||
260 | /** | |
fe482240 | 261 | * Change the cache_date. |
6a488035 | 262 | * |
5a4f6742 CW |
263 | * @param array $groupID |
264 | * @param bool $processed | |
265 | * Whether the cache data was recently modified. | |
6a488035 | 266 | */ |
00be9182 | 267 | public static function updateCacheTime($groupID, $processed) { |
6a488035 TO |
268 | // only update cache entry if we had any values |
269 | if ($processed) { | |
270 | // also update the group with cache date information | |
a986056d | 271 | $now = date('YmdHis'); |
6a488035 TO |
272 | $refresh = 'null'; |
273 | } | |
274 | else { | |
353ffa53 | 275 | $now = 'null'; |
6a488035 TO |
276 | $refresh = 'null'; |
277 | } | |
278 | ||
279 | $groupIDs = implode(',', $groupID); | |
280 | $sql = " | |
281 | UPDATE civicrm_group | |
282 | SET cache_date = $now, refresh_date = $refresh | |
283 | WHERE id IN ( $groupIDs ) | |
284 | "; | |
285 | CRM_Core_DAO::executeQuery($sql); | |
286 | } | |
287 | ||
cee4f6a1 | 288 | /** |
fe482240 | 289 | * Removes all the cache entries pertaining to a specific group. |
adf28ffd | 290 | * |
cee4f6a1 DL |
291 | * If no groupID is passed in, removes cache entries for all groups |
292 | * Has an optimization to bypass repeated invocations of this function. | |
293 | * Note that this function is an advisory, i.e. the removal respects the | |
294 | * cache date, i.e. the removal is not done if the group was recently | |
295 | * loaded into the cache. | |
296 | * | |
cc7b1cd9 | 297 | * In fact it turned out there is little overlap between the code when group is passed in |
298 | * and group is not so it makes more sense as separate functions. | |
299 | * | |
300 | * @todo remove last call to this function from outside the class then make function protected, | |
301 | * enforce groupID as an array & remove non group handling. | |
302 | * | |
5a4f6742 CW |
303 | * @param int $groupID |
304 | * the groupID to delete cache entries, NULL for all groups. | |
305 | * @param bool $onceOnly | |
306 | * run the function exactly once for all groups. | |
cee4f6a1 | 307 | */ |
00be9182 | 308 | public static function remove($groupID = NULL, $onceOnly = TRUE) { |
6a488035 TO |
309 | static $invoked = FALSE; |
310 | ||
311 | // typically this needs to happy only once per instance | |
4052239b | 312 | // this is especially TRUE in import, where we don't need |
6a488035 TO |
313 | // to do this all the time |
314 | // this optimization is done only when no groupID is passed | |
315 | // i.e. cache is reset for all groups | |
abdb2607 DL |
316 | if ( |
317 | $onceOnly && | |
6a488035 TO |
318 | $invoked && |
319 | $groupID == NULL | |
320 | ) { | |
321 | return; | |
322 | } | |
323 | ||
324 | if ($groupID == NULL) { | |
325 | $invoked = TRUE; | |
0db6c3e1 | 326 | } |
4c9b6178 | 327 | elseif (is_array($groupID)) { |
abdb2607 | 328 | foreach ($groupID as $gid) { |
6a488035 | 329 | unset(self::$_alreadyLoaded[$gid]); |
abdb2607 | 330 | } |
0db6c3e1 | 331 | } |
4c9b6178 | 332 | elseif ($groupID && array_key_exists($groupID, self::$_alreadyLoaded)) { |
6a488035 TO |
333 | unset(self::$_alreadyLoaded[$groupID]); |
334 | } | |
335 | ||
e60f24eb | 336 | $refresh = NULL; |
6a488035 | 337 | $smartGroupCacheTimeout = self::smartGroupCacheTimeout(); |
4052239b | 338 | $params = array( |
339 | 1 => array(self::getCacheInvalidDateTime(), 'String'), | |
340 | 2 => array(self::getRefreshDateTime(), 'String'), | |
341 | ); | |
6a488035 TO |
342 | |
343 | if (!isset($groupID)) { | |
344 | if ($smartGroupCacheTimeout == 0) { | |
345 | $query = " | |
3a5b8ace | 346 | DELETE FROM civicrm_group_contact_cache |
6a488035 TO |
347 | "; |
348 | $update = " | |
349 | UPDATE civicrm_group g | |
350 | SET cache_date = null, | |
351 | refresh_date = null | |
352 | "; | |
353 | } | |
354 | else { | |
a4f518e9 | 355 | |
6a488035 TO |
356 | $query = " |
357 | DELETE gc | |
358 | FROM civicrm_group_contact_cache gc | |
359 | INNER JOIN civicrm_group g ON g.id = gc.group_id | |
9fd7ef4f | 360 | WHERE g.cache_date <= %1 |
6a488035 TO |
361 | "; |
362 | $update = " | |
363 | UPDATE civicrm_group g | |
364 | SET cache_date = null, | |
365 | refresh_date = null | |
9fd7ef4f | 366 | WHERE g.cache_date <= %1 |
6a488035 TO |
367 | "; |
368 | $refresh = " | |
369 | UPDATE civicrm_group g | |
4052239b | 370 | SET refresh_date = %2 |
371 | WHERE g.cache_date < %1 | |
6a488035 TO |
372 | AND refresh_date IS NULL |
373 | "; | |
374 | } | |
375 | } | |
376 | elseif (is_array($groupID)) { | |
377 | $groupIDs = implode(', ', $groupID); | |
378 | $query = " | |
379 | DELETE g | |
380 | FROM civicrm_group_contact_cache g | |
381 | WHERE g.group_id IN ( $groupIDs ) | |
382 | "; | |
383 | $update = " | |
384 | UPDATE civicrm_group g | |
385 | SET cache_date = null, | |
386 | refresh_date = null | |
387 | WHERE id IN ( $groupIDs ) | |
388 | "; | |
389 | } | |
390 | else { | |
391 | $query = " | |
392 | DELETE g | |
393 | FROM civicrm_group_contact_cache g | |
394 | WHERE g.group_id = %1 | |
395 | "; | |
396 | $update = " | |
397 | UPDATE civicrm_group g | |
398 | SET cache_date = null, | |
399 | refresh_date = null | |
400 | WHERE id = %1 | |
401 | "; | |
402 | $params = array(1 => array($groupID, 'Integer')); | |
403 | } | |
404 | ||
405 | CRM_Core_DAO::executeQuery($query, $params); | |
406 | ||
407 | if ($refresh) { | |
408 | CRM_Core_DAO::executeQuery($refresh, $params); | |
409 | } | |
410 | ||
411 | // also update the cache_date for these groups | |
412 | CRM_Core_DAO::executeQuery($update, $params); | |
413 | } | |
414 | ||
801bafd7 | 415 | /** |
416 | * Refresh the smart group cache tables. | |
417 | * | |
418 | * This involves clearing out any aged entries (based on the site timeout setting) and resetting the time outs. | |
419 | * | |
420 | * This function should be called via the opportunistic or deterministic cache refresh function to make the intent | |
421 | * clear. | |
422 | */ | |
2b68a50c | 423 | protected static function flushCaches() { |
cc7b1cd9 | 424 | try { |
425 | $lock = self::getLockForRefresh(); | |
426 | } | |
427 | catch (CRM_Core_Exception $e) { | |
428 | // Someone else is kindly doing the refresh for us right now. | |
801bafd7 | 429 | return; |
430 | } | |
801bafd7 | 431 | $params = array(1 => array(self::getCacheInvalidDateTime(), 'String')); |
cc7b1cd9 | 432 | // @todo this is consistent with previous behaviour but as the first query could take several seconds the second |
433 | // could become inaccurate. It seems to make more sense to fetch them first & delete from an array (which would | |
434 | // also reduce joins). If we do this we should also consider how best to iterate the groups. If we do them one at | |
435 | // a time we could call a hook, allowing people to manage the frequency on their groups, or possibly custom searches | |
436 | // might do that too. However, for 2000 groups that's 2000 iterations. If we do all once we potentially create a | |
437 | // slow query. It's worth noting the speed issue generally relates to the size of the group but if one slow group | |
438 | // is in a query with 500 fast ones all 500 get locked. One approach might be to calculate group size or the | |
439 | // number of groups & then process all at once or many query runs depending on what is found. Of course those | |
440 | // preliminary queries would need speed testing. | |
801bafd7 | 441 | CRM_Core_DAO::executeQuery( |
442 | " | |
443 | DELETE gc | |
444 | FROM civicrm_group_contact_cache gc | |
445 | INNER JOIN civicrm_group g ON g.id = gc.group_id | |
446 | WHERE g.cache_date <= %1 | |
447 | ", | |
448 | $params | |
449 | ); | |
450 | ||
cc7b1cd9 | 451 | // Clear these out without resetting them because we are not building caches here, only clearing them, |
452 | // so the state is 'as if they had never been built'. | |
801bafd7 | 453 | CRM_Core_DAO::executeQuery( |
454 | " | |
455 | UPDATE civicrm_group g | |
cc7b1cd9 | 456 | SET cache_date = NULL, |
457 | refresh_date = NULL | |
801bafd7 | 458 | WHERE g.cache_date <= %1 |
459 | ", | |
460 | $params | |
461 | ); | |
cc7b1cd9 | 462 | $lock->release(); |
801bafd7 | 463 | } |
464 | ||
465 | /** | |
466 | * Check if the refresh is already initiated. | |
467 | * | |
468 | * We have 2 imperfect methods for this: | |
469 | * 1) a static variable in the function. This works fine within a request | |
470 | * 2) a mysql lock. This works fine as long as CiviMail is not running, or if mysql is version 5.7+ | |
471 | * | |
472 | * Where these 2 locks fail we get 2 processes running at the same time, but we have at least minimised that. | |
cc7b1cd9 | 473 | * |
474 | * @return \Civi\Core\Lock\LockInterface | |
475 | * @throws \CRM_Core_Exception | |
801bafd7 | 476 | */ |
cc7b1cd9 | 477 | protected static function getLockForRefresh() { |
478 | if (!isset(Civi::$statics[__CLASS__])) { | |
479 | Civi::$statics[__CLASS__] = array('is_refresh_init' => FALSE); | |
480 | } | |
481 | ||
482 | if (Civi::$statics[__CLASS__]['is_refresh_init']) { | |
483 | throw new CRM_Core_Exception('A refresh has already run in this process'); | |
801bafd7 | 484 | } |
485 | $lock = Civi::lockManager()->acquire('data.core.group.refresh'); | |
cc7b1cd9 | 486 | if ($lock->isAcquired()) { |
487 | Civi::$statics[__CLASS__]['is_refresh_init'] = TRUE; | |
488 | return $lock; | |
801bafd7 | 489 | } |
cc7b1cd9 | 490 | throw new CRM_Core_Exception('Mysql lock unavailable'); |
801bafd7 | 491 | } |
492 | ||
493 | /** | |
494 | * Do an opportunistic cache refresh if the site is configured for these. | |
495 | * | |
e047612e CB |
496 | * Sites that do not run the smart group clearing cron job should refresh the |
497 | * caches on demand. The user session will be forced to wait so it is less | |
498 | * ideal. | |
801bafd7 | 499 | */ |
2b68a50c | 500 | public static function opportunisticCacheFlush() { |
cc7b1cd9 | 501 | if (Civi::settings()->get('smart_group_cache_refresh_mode') == 'opportunistic') { |
2b68a50c | 502 | self::flushCaches(); |
801bafd7 | 503 | } |
504 | } | |
505 | ||
506 | /** | |
507 | * Do a forced cache refresh. | |
508 | * | |
509 | * This function is appropriate to be called by system jobs & non-user sessions. | |
801bafd7 | 510 | */ |
2b68a50c | 511 | public static function deterministicCacheFlush() { |
801bafd7 | 512 | if (self::smartGroupCacheTimeout() == 0) { |
513 | CRM_Core_DAO::executeQuery("TRUNCATE civicrm_group_contact_cache"); | |
514 | CRM_Core_DAO::executeQuery(" | |
515 | UPDATE civicrm_group g | |
516 | SET cache_date = null, refresh_date = null"); | |
517 | } | |
518 | else { | |
2b68a50c | 519 | self::flushCaches(); |
801bafd7 | 520 | } |
521 | } | |
522 | ||
2c6bbd06 | 523 | /** |
adf28ffd | 524 | * Remove one or more contacts from the smart group cache. |
525 | * | |
2c6bbd06 CW |
526 | * @param int|array $cid |
527 | * @param int $groupId | |
adf28ffd | 528 | * |
4eeb9a5b TO |
529 | * @return bool |
530 | * TRUE if successful. | |
2c6bbd06 | 531 | */ |
00be9182 | 532 | public static function removeContact($cid, $groupId = NULL) { |
2c6bbd06 CW |
533 | $cids = array(); |
534 | // sanitize input | |
535 | foreach ((array) $cid as $c) { | |
536 | $cids[] = CRM_Utils_Type::escape($c, 'Integer'); | |
537 | } | |
538 | if ($cids) { | |
539 | $condition = count($cids) == 1 ? "= {$cids[0]}" : "IN (" . implode(',', $cids) . ")"; | |
540 | if ($groupId) { | |
541 | $condition .= " AND group_id = " . CRM_Utils_Type::escape($groupId, 'Integer'); | |
542 | } | |
543 | $sql = "DELETE FROM civicrm_group_contact_cache WHERE contact_id $condition"; | |
544 | CRM_Core_DAO::executeQuery($sql); | |
545 | return TRUE; | |
546 | } | |
547 | return FALSE; | |
548 | } | |
549 | ||
6a488035 | 550 | /** |
fe482240 | 551 | * Load the smart group cache for a saved search. |
abdb2607 | 552 | * |
77c5b619 TO |
553 | * @param object $group |
554 | * The smart group that needs to be loaded. | |
555 | * @param bool $force | |
556 | * Should we force a search through. | |
6a488035 | 557 | */ |
00be9182 | 558 | public static function load(&$group, $force = FALSE) { |
6a488035 TO |
559 | $groupID = $group->id; |
560 | $savedSearchID = $group->saved_search_id; | |
abdb2607 | 561 | if (array_key_exists($groupID, self::$_alreadyLoaded) && !$force) { |
6a488035 TO |
562 | return; |
563 | } | |
cc13551d | 564 | |
4052239b | 565 | // grab a lock so other processes don't compete and do the same query |
83617886 | 566 | $lock = Civi::lockManager()->acquire("data.core.group.{$groupID}"); |
cc13551d | 567 | if (!$lock->isAcquired()) { |
4052239b | 568 | // this can cause inconsistent results since we don't know if the other process |
cc13551d DL |
569 | // will fill up the cache before our calling routine needs it. |
570 | // however this routine does not return the status either, so basically | |
571 | // its a "lets return and hope for the best" | |
572 | return; | |
573 | } | |
574 | ||
6a488035 | 575 | self::$_alreadyLoaded[$groupID] = 1; |
abdb2607 | 576 | |
b44e3f84 | 577 | // we now have the lock, but some other process could have actually done the work |
abdb2607 DL |
578 | // before we got here, so before we do any work, lets ensure that work needs to be |
579 | // done | |
580 | // we allow hidden groups here since we dont know if the caller wants to evaluate an | |
581 | // hidden group | |
3cd86345 | 582 | if (!$force && !self::shouldGroupBeRefreshed($groupID, TRUE)) { |
abdb2607 DL |
583 | $lock->release(); |
584 | return; | |
585 | } | |
586 | ||
353ffa53 TO |
587 | $sql = NULL; |
588 | $idName = 'id'; | |
6a488035 TO |
589 | $customClass = NULL; |
590 | if ($savedSearchID) { | |
591 | $ssParams = CRM_Contact_BAO_SavedSearch::getSearchParams($savedSearchID); | |
592 | ||
593 | // rectify params to what proximity search expects if there is a value for prox_distance | |
594 | // CRM-7021 | |
595 | if (!empty($ssParams)) { | |
596 | CRM_Contact_BAO_ProximityQuery::fixInputParams($ssParams); | |
597 | } | |
598 | ||
6a488035 TO |
599 | $returnProperties = array(); |
600 | if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $savedSearchID, 'mapping_id')) { | |
601 | $fv = CRM_Contact_BAO_SavedSearch::getFormValues($savedSearchID); | |
602 | $returnProperties = CRM_Core_BAO_Mapping::returnProperties($fv); | |
603 | } | |
604 | ||
605 | if (isset($ssParams['customSearchID'])) { | |
606 | // if custom search | |
607 | ||
608 | // we split it up and store custom class | |
609 | // so temp tables are not destroyed if they are used | |
610 | // hence customClass is defined above at top of function | |
5396af74 | 611 | $customClass = CRM_Contact_BAO_SearchCustom::customClass($ssParams['customSearchID'], $savedSearchID); |
6a488035 | 612 | $searchSQL = $customClass->contactIDs(); |
26a9b6ab | 613 | $searchSQL = str_replace('ORDER BY contact_a.id ASC', '', $searchSQL); |
d02c030f | 614 | if (!strstr($searchSQL, 'WHERE')) { |
615 | $searchSQL .= " WHERE ( 1 ) "; | |
616 | } | |
6a488035 TO |
617 | $idName = 'contact_id'; |
618 | } | |
619 | else { | |
620 | $formValues = CRM_Contact_BAO_SavedSearch::getFormValues($savedSearchID); | |
beccb90f | 621 | // CRM-17075 using the formValues in this way imposes extra logic and complexity. |
622 | // we have the where_clause and where tables stored in the saved_search table | |
623 | // and should use these rather than re-processing the form criteria (which over-works | |
624 | // the link between the form layer & the query layer too). | |
625 | // It's hard to think of when you would want to use anything other than return | |
626 | // properties = array('contact_id' => 1) here as the point would appear to be to | |
627 | // generate the list of contact ids in the group. | |
628 | // @todo review this to use values in saved_search table (preferably for 4.8). | |
5396af74 | 629 | $query |
630 | = new CRM_Contact_BAO_Query( | |
6a488035 | 631 | $ssParams, $returnProperties, NULL, |
cc13551d DL |
632 | FALSE, FALSE, 1, |
633 | TRUE, TRUE, | |
634 | FALSE, | |
6a488035 TO |
635 | CRM_Utils_Array::value('display_relationship_type', $formValues), |
636 | CRM_Utils_Array::value('operator', $formValues, 'AND') | |
353ffa53 | 637 | ); |
6a488035 | 638 | $query->_useDistinct = FALSE; |
353ffa53 | 639 | $query->_useGroupBy = FALSE; |
5396af74 | 640 | $searchSQL |
641 | = $query->searchQuery( | |
6a488035 | 642 | 0, 0, NULL, |
353ffa53 TO |
643 | FALSE, FALSE, |
644 | FALSE, TRUE, | |
645 | TRUE, | |
646 | NULL, NULL, NULL, | |
647 | TRUE | |
648 | ); | |
6a488035 TO |
649 | } |
650 | $groupID = CRM_Utils_Type::escape($groupID, 'Integer'); | |
651 | $sql = $searchSQL . " AND contact_a.id NOT IN ( | |
652 | SELECT contact_id FROM civicrm_group_contact | |
653 | WHERE civicrm_group_contact.status = 'Removed' | |
654 | AND civicrm_group_contact.group_id = $groupID ) "; | |
655 | } | |
656 | ||
657 | if ($sql) { | |
658 | $sql = preg_replace("/^\s*SELECT/", "SELECT $groupID as group_id, ", $sql); | |
659 | } | |
660 | ||
661 | // lets also store the records that are explicitly added to the group | |
662 | // this allows us to skip the group contact LEFT JOIN | |
663 | $sqlB = " | |
664 | SELECT $groupID as group_id, contact_id as $idName | |
665 | FROM civicrm_group_contact | |
666 | WHERE civicrm_group_contact.status = 'Added' | |
667 | AND civicrm_group_contact.group_id = $groupID "; | |
668 | ||
669 | $groupIDs = array($groupID); | |
670 | self::remove($groupIDs); | |
abdb2607 | 671 | $processed = FALSE; |
353ffa53 | 672 | $tempTable = 'civicrm_temp_group_contact_cache' . rand(0, 2000); |
6a488035 TO |
673 | foreach (array($sql, $sqlB) as $selectSql) { |
674 | if (!$selectSql) { | |
675 | continue; | |
676 | } | |
b8eae4bd | 677 | $insertSql = "CREATE TEMPORARY TABLE $tempTable ($selectSql);"; |
eb917190 | 678 | $processed = TRUE; |
801bafd7 | 679 | CRM_Core_DAO::executeQuery($insertSql); |
b8eae4bd | 680 | CRM_Core_DAO::executeQuery( |
681 | "INSERT IGNORE INTO civicrm_group_contact_cache (contact_id, group_id) | |
eab13399 | 682 | SELECT DISTINCT $idName, group_id FROM $tempTable |
b8eae4bd | 683 | "); |
5467c9fb | 684 | CRM_Core_DAO::executeQuery(" DROP TEMPORARY TABLE $tempTable"); |
6a488035 | 685 | } |
b8eae4bd | 686 | |
6a488035 TO |
687 | self::updateCacheTime($groupIDs, $processed); |
688 | ||
689 | if ($group->children) { | |
690 | ||
691 | //Store a list of contacts who are removed from the parent group | |
692 | $sql = " | |
693 | SELECT contact_id | |
694 | FROM civicrm_group_contact | |
695 | WHERE civicrm_group_contact.status = 'Removed' | |
696 | AND civicrm_group_contact.group_id = $groupID "; | |
697 | $dao = CRM_Core_DAO::executeQuery($sql); | |
698 | $removed_contacts = array(); | |
699 | while ($dao->fetch()) { | |
700 | $removed_contacts[] = $dao->contact_id; | |
701 | } | |
702 | ||
703 | $childrenIDs = explode(',', $group->children); | |
704 | foreach ($childrenIDs as $childID) { | |
705 | $contactIDs = CRM_Contact_BAO_Group::getMember($childID, FALSE); | |
706 | //Unset each contact that is removed from the parent group | |
707 | foreach ($removed_contacts as $removed_contact) { | |
708 | unset($contactIDs[$removed_contact]); | |
709 | } | |
710 | $values = array(); | |
711 | foreach ($contactIDs as $contactID => $dontCare) { | |
712 | $values[] = "({$groupID},{$contactID})"; | |
713 | } | |
714 | ||
715 | self::store($groupIDs, $values); | |
716 | } | |
717 | } | |
cc13551d DL |
718 | |
719 | $lock->release(); | |
6a488035 TO |
720 | } |
721 | ||
86538308 | 722 | /** |
adf28ffd | 723 | * Retrieve the smart group cache timeout in minutes. |
724 | * | |
725 | * This checks if a timeout has been configured. If one has then smart groups should not | |
726 | * be refreshed more frequently than the time out. If a group was recently refreshed it should not | |
727 | * refresh again within that period. | |
728 | * | |
86538308 EM |
729 | * @return int |
730 | */ | |
00be9182 | 731 | public static function smartGroupCacheTimeout() { |
6a488035 TO |
732 | $config = CRM_Core_Config::singleton(); |
733 | ||
734 | if ( | |
735 | isset($config->smartGroupCacheTimeout) && | |
9bdcddd7 | 736 | is_numeric($config->smartGroupCacheTimeout) |
353ffa53 | 737 | ) { |
6a488035 TO |
738 | return $config->smartGroupCacheTimeout; |
739 | } | |
740 | ||
adf28ffd | 741 | // Default to 5 minutes. |
6a488035 TO |
742 | return 5; |
743 | } | |
744 | ||
9be31c7a | 745 | /** |
fe482240 | 746 | * Get all the smart groups that this contact belongs to. |
adf28ffd | 747 | * |
9be31c7a DL |
748 | * Note that this could potentially be a super slow function since |
749 | * it ensure that all contact groups are loaded in the cache | |
750 | * | |
77c5b619 TO |
751 | * @param int $contactID |
752 | * @param bool $showHidden | |
753 | * Hidden groups are shown only if this flag is set. | |
9be31c7a | 754 | * |
a6c01b45 CW |
755 | * @return array |
756 | * an array of groups that this contact belongs to | |
9be31c7a | 757 | */ |
00be9182 | 758 | public static function contactGroup($contactID, $showHidden = FALSE) { |
6a488035 | 759 | if (empty($contactID)) { |
5396af74 | 760 | return NULL; |
6a488035 TO |
761 | } |
762 | ||
763 | if (is_array($contactID)) { | |
764 | $contactIDs = $contactID; | |
765 | } | |
766 | else { | |
767 | $contactIDs = array($contactID); | |
768 | } | |
769 | ||
770 | self::loadAll(); | |
771 | ||
9be31c7a DL |
772 | $hiddenClause = ''; |
773 | if (!$showHidden) { | |
774 | $hiddenClause = ' AND (g.is_hidden = 0 OR g.is_hidden IS NULL) '; | |
775 | } | |
776 | ||
6a488035 TO |
777 | $contactIDString = CRM_Core_DAO::escapeString(implode(', ', $contactIDs)); |
778 | $sql = " | |
779 | SELECT gc.group_id, gc.contact_id, g.title, g.children, g.description | |
780 | FROM civicrm_group_contact_cache gc | |
781 | INNER JOIN civicrm_group g ON g.id = gc.group_id | |
782 | WHERE gc.contact_id IN ($contactIDString) | |
9be31c7a | 783 | $hiddenClause |
6a488035 TO |
784 | ORDER BY gc.contact_id, g.children |
785 | "; | |
786 | ||
787 | $dao = CRM_Core_DAO::executeQuery($sql); | |
788 | $contactGroup = array(); | |
e60f24eb | 789 | $prevContactID = NULL; |
6a488035 TO |
790 | while ($dao->fetch()) { |
791 | if ( | |
792 | $prevContactID && | |
793 | $prevContactID != $dao->contact_id | |
794 | ) { | |
795 | $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']); | |
796 | } | |
797 | $prevContactID = $dao->contact_id; | |
798 | if (!array_key_exists($dao->contact_id, $contactGroup)) { | |
5396af74 | 799 | $contactGroup[$dao->contact_id] |
800 | = array('group' => array(), 'groupTitle' => array()); | |
6a488035 TO |
801 | } |
802 | ||
5396af74 | 803 | $contactGroup[$dao->contact_id]['group'][] |
804 | = array( | |
6a488035 TO |
805 | 'id' => $dao->group_id, |
806 | 'title' => $dao->title, | |
807 | 'description' => $dao->description, | |
21dfd5f5 | 808 | 'children' => $dao->children, |
6a488035 TO |
809 | ); |
810 | $contactGroup[$dao->contact_id]['groupTitle'][] = $dao->title; | |
811 | } | |
812 | ||
813 | if ($prevContactID) { | |
814 | $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']); | |
815 | } | |
816 | ||
13982f7b | 817 | if ((!empty($contactGroup[$contactID]) && is_numeric($contactID))) { |
6a488035 TO |
818 | return $contactGroup[$contactID]; |
819 | } | |
820 | else { | |
821 | return $contactGroup; | |
822 | } | |
823 | } | |
824 | ||
4052239b | 825 | /** |
826 | * Get the datetime from which the cache should be considered invalid. | |
827 | * | |
828 | * Ie if the smartgroup cache timeout is 5 minutes ago then the cache is invalid if it was | |
829 | * refreshed 6 minutes ago, but not if it was refreshed 4 minutes ago. | |
830 | * | |
831 | * @return string | |
832 | */ | |
833 | public static function getCacheInvalidDateTime() { | |
8b6074a7 | 834 | return date('YmdHis', strtotime("-" . self::smartGroupCacheTimeout() . " Minutes")); |
4052239b | 835 | } |
836 | ||
a986056d | 837 | /** |
838 | * Get the date when the cache should be refreshed from. | |
839 | * | |
840 | * Ie. now + the offset & we will delete anything prior to then. | |
841 | * | |
842 | * @return string | |
843 | */ | |
4052239b | 844 | public static function getRefreshDateTime() { |
8b6074a7 | 845 | return date('YmdHis', strtotime("+ " . self::smartGroupCacheTimeout() . " Minutes")); |
a986056d | 846 | } |
847 | ||
6a488035 | 848 | } |