Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCache { | |
36 | ||
37 | static $_alreadyLoaded = array(); | |
38 | ||
39 | /** | |
40 | * Check to see if we have cache entries for this group | |
41 | * if not, regenerate, else return | |
42 | * | |
c490a46a | 43 | * @param $groupIDs of group that we are checking against |
6a488035 TO |
44 | * |
45 | * @return boolean true if we did not regenerate, false if we did | |
46 | */ | |
47 | static function check($groupIDs) { | |
48 | if (empty($groupIDs)) { | |
49 | return TRUE; | |
50 | } | |
51 | ||
52 | return self::loadAll($groupIDs); | |
53 | } | |
54 | ||
abdb2607 DL |
55 | /** |
56 | * Common function that formulates the query to see which groups needs to be refreshed | |
57 | * based on their cache date and the smartGroupCacheTimeOut | |
58 | * | |
59 | * @param string $groupIDClause the clause which limits which groups we need to evaluate | |
60 | * @param boolean $includeHiddenGroups hidden groups are excluded by default | |
61 | * | |
62 | * @return string the sql query which lists the groups that need to be refreshed | |
63 | * @static | |
64 | * @public | |
65 | */ | |
66 | static function groupRefreshedClause($groupIDClause = null, $includeHiddenGroups = FALSE) { | |
67 | $smartGroupCacheTimeout = self::smartGroupCacheTimeout(); | |
68 | $now = CRM_Utils_Date::getUTCTime(); | |
69 | ||
70 | $query = " | |
71 | SELECT g.id | |
72 | FROM civicrm_group g | |
73 | WHERE ( g.saved_search_id IS NOT NULL OR g.children IS NOT NULL ) | |
74 | AND g.is_active = 1 | |
75 | AND ( g.cache_date IS NULL OR | |
76 | ( TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout ) OR | |
77 | ( $now >= g.refresh_date ) | |
78 | ) | |
79 | "; | |
80 | ||
81 | if (!$includeHiddenGroups) { | |
82 | $query .= "AND (g.is_hidden = 0 OR g.is_hidden IS NULL)"; | |
83 | } | |
84 | ||
85 | if (!empty($groupIDClause)) { | |
86 | $query .= " AND ( $groupIDClause ) "; | |
87 | } | |
88 | ||
89 | return $query; | |
90 | } | |
91 | ||
92 | /** | |
93 | * Checks to see if a group has been refreshed recently. This is primarily used | |
94 | * in a locking scenario when some other process might have refreshed things underneath | |
95 | * this process | |
96 | * | |
97 | * @param int $groupID the group ID | |
98 | * @param boolean $includeHiddenGroups hidden groups are excluded by default | |
99 | * | |
100 | * @return string the sql query which lists the groups that need to be refreshed | |
101 | * @static | |
102 | * @public | |
103 | */ | |
4f53db5a | 104 | static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) { |
abdb2607 DL |
105 | $query = self::groupRefreshedClause("g.id = %1", $includeHiddenGroups); |
106 | $params = array(1 => array($groupID, 'Integer')); | |
107 | ||
4f53db5a | 108 | // if the query returns the group ID, it means the group is a valid candidate for refreshing |
abdb2607 DL |
109 | return CRM_Core_DAO::singleValueQuery($query, $params); |
110 | } | |
111 | ||
6a488035 TO |
112 | /** |
113 | * Check to see if we have cache entries for this group | |
114 | * if not, regenerate, else return | |
115 | * | |
116 | * @param int/array $groupID groupID of group that we are checking against | |
117 | * if empty, all groups are checked | |
118 | * @param int $limit limits the number of groups we evaluate | |
119 | * | |
120 | * @return boolean true if we did not regenerate, false if we did | |
121 | */ | |
122 | static function loadAll($groupIDs = null, $limit = 0) { | |
123 | // ensure that all the smart groups are loaded | |
124 | // this function is expensive and should be sparingly used if groupIDs is empty | |
6a488035 TO |
125 | if (empty($groupIDs)) { |
126 | $groupIDClause = null; | |
127 | $groupIDs = array( ); | |
128 | } | |
129 | else { | |
130 | if (!is_array($groupIDs)) { | |
131 | $groupIDs = array($groupIDs); | |
132 | } | |
133 | ||
134 | // note escapeString is a must here and we can't send the imploded value as second arguement to | |
135 | // the executeQuery(), since that would put single quote around the string and such a string | |
136 | // of comma separated integers would not work. | |
0e4e5a49 | 137 | $groupIDString = CRM_Core_DAO::escapeString(implode(', ', $groupIDs)); |
6a488035 | 138 | |
abdb2607 | 139 | $groupIDClause = "g.id IN ({$groupIDString})"; |
6a488035 TO |
140 | } |
141 | ||
abdb2607 | 142 | $query = self::groupRefreshedClause($groupIDClause); |
6a488035 TO |
143 | |
144 | $limitClause = $orderClause = NULL; | |
145 | if ($limit > 0) { | |
146 | $limitClause = " LIMIT 0, $limit"; | |
147 | $orderClause = " ORDER BY g.cache_date, g.refresh_date"; | |
148 | } | |
e2422b8f | 149 | // We ignore hidden groups and disabled groups |
abdb2607 | 150 | $query .= " |
6a488035 | 151 | $orderClause |
f9e16e9a | 152 | $limitClause |
6a488035 TO |
153 | "; |
154 | ||
155 | $dao = CRM_Core_DAO::executeQuery($query); | |
156 | $processGroupIDs = array(); | |
157 | $refreshGroupIDs = $groupIDs; | |
158 | while ($dao->fetch()) { | |
159 | $processGroupIDs[] = $dao->id; | |
160 | ||
161 | // remove this id from refreshGroupIDs | |
162 | foreach ($refreshGroupIDs as $idx => $gid) { | |
163 | if ($gid == $dao->id) { | |
164 | unset($refreshGroupIDs[$idx]); | |
165 | break; | |
166 | } | |
167 | } | |
168 | } | |
169 | ||
170 | if (!empty($refreshGroupIDs)) { | |
82a837e9 | 171 | $refreshGroupIDString = CRM_Core_DAO::escapeString(implode(', ', $refreshGroupIDs)); |
634366e7 | 172 | $time = CRM_Utils_Date::getUTCTime(self::smartGroupCacheTimeout() * 60); |
6a488035 TO |
173 | $query = " |
174 | UPDATE civicrm_group g | |
175 | SET g.refresh_date = $time | |
176 | WHERE g.id IN ( {$refreshGroupIDString} ) | |
177 | AND g.refresh_date IS NULL | |
178 | "; | |
82a837e9 | 179 | CRM_Core_DAO::executeQuery($query); |
6a488035 TO |
180 | } |
181 | ||
182 | if (empty($processGroupIDs)) { | |
183 | return TRUE; | |
184 | } | |
185 | else { | |
186 | self::add($processGroupIDs); | |
187 | return FALSE; | |
188 | } | |
189 | } | |
190 | ||
520bca8e CW |
191 | /** |
192 | * FIXME: This function should not be needed, because the cache table should not be getting truncated | |
193 | */ | |
194 | static function fillIfEmpty() { | |
195 | if (!CRM_Core_DAO::singleValueQuery("SELECT COUNT(id) FROM civicrm_group_contact_cache")) { | |
196 | self::loadAll(); | |
197 | } | |
198 | } | |
199 | ||
86538308 | 200 | /** |
100fef9d | 201 | * @param int $groupID |
86538308 | 202 | */ |
6a488035 TO |
203 | static function add($groupID) { |
204 | // first delete the current cache | |
205 | self::remove($groupID); | |
206 | if (!is_array($groupID)) { | |
207 | $groupID = array($groupID); | |
208 | } | |
209 | ||
210 | $returnProperties = array('contact_id'); | |
211 | foreach ($groupID as $gid) { | |
212 | $params = array(array('group', 'IN', array($gid => 1), 0, 0)); | |
abdb2607 | 213 | // the below call updates the cache table as a byproduct of the query |
6a488035 TO |
214 | CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, FALSE); |
215 | } | |
216 | } | |
217 | ||
86538308 | 218 | /** |
100fef9d | 219 | * @param int $groupID |
86538308 EM |
220 | * @param $values |
221 | */ | |
6a488035 TO |
222 | static function store(&$groupID, &$values) { |
223 | $processed = FALSE; | |
224 | ||
225 | // sort the values so we put group IDs in front and hence optimize | |
226 | // mysql storage (or so we think) CRM-9493 | |
227 | sort($values); | |
eb917190 | 228 | |
6a488035 TO |
229 | // to avoid long strings, lets do BULK_INSERT_COUNT values at a time |
230 | while (!empty($values)) { | |
231 | $processed = TRUE; | |
232 | $input = array_splice($values, 0, CRM_Core_DAO::BULK_INSERT_COUNT); | |
233 | $str = implode(',', $input); | |
eb917190 | 234 | $sql = "INSERT IGNORE INTO civicrm_group_contact_cache (group_id,contact_id) VALUES $str;"; |
6a488035 TO |
235 | CRM_Core_DAO::executeQuery($sql); |
236 | } | |
237 | self::updateCacheTime($groupID, $processed); | |
238 | } | |
239 | ||
240 | /** | |
241 | * Change the cache_date | |
242 | * | |
243 | * @param $groupID array(int) | |
244 | * @param $processed bool, whether the cache data was recently modified | |
245 | */ | |
246 | static function updateCacheTime($groupID, $processed) { | |
247 | // only update cache entry if we had any values | |
248 | if ($processed) { | |
249 | // also update the group with cache date information | |
250 | //make sure to give original timezone settings again. | |
251 | $now = CRM_Utils_Date::getUTCTime(); | |
252 | $refresh = 'null'; | |
253 | } | |
254 | else { | |
255 | $now = 'null'; | |
256 | $refresh = 'null'; | |
257 | } | |
258 | ||
259 | $groupIDs = implode(',', $groupID); | |
260 | $sql = " | |
261 | UPDATE civicrm_group | |
262 | SET cache_date = $now, refresh_date = $refresh | |
263 | WHERE id IN ( $groupIDs ) | |
264 | "; | |
265 | CRM_Core_DAO::executeQuery($sql); | |
266 | } | |
267 | ||
cee4f6a1 DL |
268 | /** |
269 | * Removes all the cache entries pertaining to a specific group | |
270 | * If no groupID is passed in, removes cache entries for all groups | |
271 | * Has an optimization to bypass repeated invocations of this function. | |
272 | * Note that this function is an advisory, i.e. the removal respects the | |
273 | * cache date, i.e. the removal is not done if the group was recently | |
274 | * loaded into the cache. | |
275 | * | |
276 | * @param $groupID int the groupID to delete cache entries, NULL for all groups | |
277 | * @param $onceOnly boolean run the function exactly once for all groups. | |
278 | * | |
279 | * @public | |
280 | * @return void | |
281 | * @static | |
282 | */ | |
6a488035 TO |
283 | static function remove($groupID = NULL, $onceOnly = TRUE) { |
284 | static $invoked = FALSE; | |
285 | ||
286 | // typically this needs to happy only once per instance | |
287 | // this is especially true in import, where we dont need | |
288 | // to do this all the time | |
289 | // this optimization is done only when no groupID is passed | |
290 | // i.e. cache is reset for all groups | |
abdb2607 DL |
291 | if ( |
292 | $onceOnly && | |
6a488035 TO |
293 | $invoked && |
294 | $groupID == NULL | |
295 | ) { | |
296 | return; | |
297 | } | |
298 | ||
299 | if ($groupID == NULL) { | |
300 | $invoked = TRUE; | |
301 | } else if (is_array($groupID)) { | |
abdb2607 | 302 | foreach ($groupID as $gid) { |
6a488035 | 303 | unset(self::$_alreadyLoaded[$gid]); |
abdb2607 | 304 | } |
6a488035 TO |
305 | } else if ($groupID && array_key_exists($groupID, self::$_alreadyLoaded)) { |
306 | unset(self::$_alreadyLoaded[$groupID]); | |
307 | } | |
308 | ||
309 | $refresh = null; | |
310 | $params = array(); | |
311 | $smartGroupCacheTimeout = self::smartGroupCacheTimeout(); | |
312 | ||
313 | $now = CRM_Utils_Date::getUTCTime(); | |
cf142e47 | 314 | $refreshTime = CRM_Utils_Date::getUTCTime($smartGroupCacheTimeout * 60); |
6a488035 TO |
315 | |
316 | if (!isset($groupID)) { | |
317 | if ($smartGroupCacheTimeout == 0) { | |
318 | $query = " | |
319 | TRUNCATE civicrm_group_contact_cache | |
320 | "; | |
321 | $update = " | |
322 | UPDATE civicrm_group g | |
323 | SET cache_date = null, | |
324 | refresh_date = null | |
325 | "; | |
326 | } | |
327 | else { | |
328 | $query = " | |
329 | DELETE gc | |
330 | FROM civicrm_group_contact_cache gc | |
331 | INNER JOIN civicrm_group g ON g.id = gc.group_id | |
332 | WHERE TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout | |
333 | "; | |
334 | $update = " | |
335 | UPDATE civicrm_group g | |
336 | SET cache_date = null, | |
337 | refresh_date = null | |
338 | WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) >= $smartGroupCacheTimeout | |
339 | "; | |
340 | $refresh = " | |
341 | UPDATE civicrm_group g | |
342 | SET refresh_date = $refreshTime | |
343 | WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) < $smartGroupCacheTimeout | |
344 | AND refresh_date IS NULL | |
345 | "; | |
346 | } | |
347 | } | |
348 | elseif (is_array($groupID)) { | |
349 | $groupIDs = implode(', ', $groupID); | |
350 | $query = " | |
351 | DELETE g | |
352 | FROM civicrm_group_contact_cache g | |
353 | WHERE g.group_id IN ( $groupIDs ) | |
354 | "; | |
355 | $update = " | |
356 | UPDATE civicrm_group g | |
357 | SET cache_date = null, | |
358 | refresh_date = null | |
359 | WHERE id IN ( $groupIDs ) | |
360 | "; | |
361 | } | |
362 | else { | |
363 | $query = " | |
364 | DELETE g | |
365 | FROM civicrm_group_contact_cache g | |
366 | WHERE g.group_id = %1 | |
367 | "; | |
368 | $update = " | |
369 | UPDATE civicrm_group g | |
370 | SET cache_date = null, | |
371 | refresh_date = null | |
372 | WHERE id = %1 | |
373 | "; | |
374 | $params = array(1 => array($groupID, 'Integer')); | |
375 | } | |
376 | ||
377 | CRM_Core_DAO::executeQuery($query, $params); | |
378 | ||
379 | if ($refresh) { | |
380 | CRM_Core_DAO::executeQuery($refresh, $params); | |
381 | } | |
382 | ||
383 | // also update the cache_date for these groups | |
384 | CRM_Core_DAO::executeQuery($update, $params); | |
385 | } | |
386 | ||
387 | /** | |
100fef9d | 388 | * Load the smart group cache for a saved search |
abdb2607 DL |
389 | * |
390 | * @param object $group - the smart group that needs to be loaded | |
391 | * @param boolean $force - should we force a search through | |
392 | * | |
6a488035 | 393 | */ |
abdb2607 | 394 | static function load(&$group, $force = FALSE) { |
6a488035 TO |
395 | $groupID = $group->id; |
396 | $savedSearchID = $group->saved_search_id; | |
abdb2607 | 397 | if (array_key_exists($groupID, self::$_alreadyLoaded) && !$force) { |
6a488035 TO |
398 | return; |
399 | } | |
cc13551d DL |
400 | |
401 | // grab a lock so other processes dont compete and do the same query | |
402 | $lockName = "civicrm.group.{$groupID}"; | |
403 | $lock = new CRM_Core_Lock($lockName); | |
404 | if (!$lock->isAcquired()) { | |
405 | // this can cause inconsistent results since we dont know if the other process | |
406 | // will fill up the cache before our calling routine needs it. | |
407 | // however this routine does not return the status either, so basically | |
408 | // its a "lets return and hope for the best" | |
409 | return; | |
410 | } | |
411 | ||
6a488035 | 412 | self::$_alreadyLoaded[$groupID] = 1; |
abdb2607 DL |
413 | |
414 | // we now have the lock, but some other proces could have actually done the work | |
415 | // before we got here, so before we do any work, lets ensure that work needs to be | |
416 | // done | |
417 | // we allow hidden groups here since we dont know if the caller wants to evaluate an | |
418 | // hidden group | |
3cd86345 | 419 | if (!$force && !self::shouldGroupBeRefreshed($groupID, TRUE)) { |
abdb2607 DL |
420 | $lock->release(); |
421 | return; | |
422 | } | |
423 | ||
6a488035 TO |
424 | $sql = NULL; |
425 | $idName = 'id'; | |
426 | $customClass = NULL; | |
427 | if ($savedSearchID) { | |
428 | $ssParams = CRM_Contact_BAO_SavedSearch::getSearchParams($savedSearchID); | |
429 | ||
430 | // rectify params to what proximity search expects if there is a value for prox_distance | |
431 | // CRM-7021 | |
432 | if (!empty($ssParams)) { | |
433 | CRM_Contact_BAO_ProximityQuery::fixInputParams($ssParams); | |
434 | } | |
435 | ||
436 | ||
437 | $returnProperties = array(); | |
438 | if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $savedSearchID, 'mapping_id')) { | |
439 | $fv = CRM_Contact_BAO_SavedSearch::getFormValues($savedSearchID); | |
440 | $returnProperties = CRM_Core_BAO_Mapping::returnProperties($fv); | |
441 | } | |
442 | ||
443 | if (isset($ssParams['customSearchID'])) { | |
444 | // if custom search | |
445 | ||
446 | // we split it up and store custom class | |
447 | // so temp tables are not destroyed if they are used | |
448 | // hence customClass is defined above at top of function | |
449 | $customClass = | |
450 | CRM_Contact_BAO_SearchCustom::customClass($ssParams['customSearchID'], $savedSearchID); | |
451 | $searchSQL = $customClass->contactIDs(); | |
26a9b6ab | 452 | $searchSQL = str_replace('ORDER BY contact_a.id ASC', '', $searchSQL); |
6a488035 TO |
453 | $idName = 'contact_id'; |
454 | } | |
455 | else { | |
456 | $formValues = CRM_Contact_BAO_SavedSearch::getFormValues($savedSearchID); | |
457 | ||
458 | $query = | |
459 | new CRM_Contact_BAO_Query( | |
460 | $ssParams, $returnProperties, NULL, | |
cc13551d DL |
461 | FALSE, FALSE, 1, |
462 | TRUE, TRUE, | |
463 | FALSE, | |
6a488035 TO |
464 | CRM_Utils_Array::value('display_relationship_type', $formValues), |
465 | CRM_Utils_Array::value('operator', $formValues, 'AND') | |
466 | ); | |
467 | $query->_useDistinct = FALSE; | |
468 | $query->_useGroupBy = FALSE; | |
469 | $searchSQL = | |
470 | $query->searchQuery( | |
471 | 0, 0, NULL, | |
472 | FALSE, FALSE, | |
473 | FALSE, TRUE, | |
474 | TRUE, | |
475 | NULL, NULL, NULL, | |
476 | TRUE | |
477 | ); | |
478 | } | |
479 | $groupID = CRM_Utils_Type::escape($groupID, 'Integer'); | |
480 | $sql = $searchSQL . " AND contact_a.id NOT IN ( | |
481 | SELECT contact_id FROM civicrm_group_contact | |
482 | WHERE civicrm_group_contact.status = 'Removed' | |
483 | AND civicrm_group_contact.group_id = $groupID ) "; | |
484 | } | |
485 | ||
486 | if ($sql) { | |
487 | $sql = preg_replace("/^\s*SELECT/", "SELECT $groupID as group_id, ", $sql); | |
488 | } | |
489 | ||
490 | // lets also store the records that are explicitly added to the group | |
491 | // this allows us to skip the group contact LEFT JOIN | |
492 | $sqlB = " | |
493 | SELECT $groupID as group_id, contact_id as $idName | |
494 | FROM civicrm_group_contact | |
495 | WHERE civicrm_group_contact.status = 'Added' | |
496 | AND civicrm_group_contact.group_id = $groupID "; | |
497 | ||
498 | $groupIDs = array($groupID); | |
499 | self::remove($groupIDs); | |
abdb2607 | 500 | $processed = FALSE; |
b8eae4bd | 501 | $tempTable = 'civicrm_temp_group_contact_cache' . rand(0,2000); |
6a488035 TO |
502 | foreach (array($sql, $sqlB) as $selectSql) { |
503 | if (!$selectSql) { | |
504 | continue; | |
505 | } | |
b8eae4bd | 506 | $insertSql = "CREATE TEMPORARY TABLE $tempTable ($selectSql);"; |
eb917190 | 507 | $processed = TRUE; |
6a488035 | 508 | $result = CRM_Core_DAO::executeQuery($insertSql); |
b8eae4bd | 509 | CRM_Core_DAO::executeQuery( |
510 | "INSERT IGNORE INTO civicrm_group_contact_cache (contact_id, group_id) | |
eab13399 | 511 | SELECT DISTINCT $idName, group_id FROM $tempTable |
b8eae4bd | 512 | "); |
513 | CRM_Core_DAO::executeQuery(" DROP TABLE $tempTable"); | |
6a488035 | 514 | } |
b8eae4bd | 515 | |
6a488035 TO |
516 | self::updateCacheTime($groupIDs, $processed); |
517 | ||
518 | if ($group->children) { | |
519 | ||
520 | //Store a list of contacts who are removed from the parent group | |
521 | $sql = " | |
522 | SELECT contact_id | |
523 | FROM civicrm_group_contact | |
524 | WHERE civicrm_group_contact.status = 'Removed' | |
525 | AND civicrm_group_contact.group_id = $groupID "; | |
526 | $dao = CRM_Core_DAO::executeQuery($sql); | |
527 | $removed_contacts = array(); | |
528 | while ($dao->fetch()) { | |
529 | $removed_contacts[] = $dao->contact_id; | |
530 | } | |
531 | ||
532 | $childrenIDs = explode(',', $group->children); | |
533 | foreach ($childrenIDs as $childID) { | |
534 | $contactIDs = CRM_Contact_BAO_Group::getMember($childID, FALSE); | |
535 | //Unset each contact that is removed from the parent group | |
536 | foreach ($removed_contacts as $removed_contact) { | |
537 | unset($contactIDs[$removed_contact]); | |
538 | } | |
539 | $values = array(); | |
540 | foreach ($contactIDs as $contactID => $dontCare) { | |
541 | $values[] = "({$groupID},{$contactID})"; | |
542 | } | |
543 | ||
544 | self::store($groupIDs, $values); | |
545 | } | |
546 | } | |
cc13551d DL |
547 | |
548 | $lock->release(); | |
6a488035 TO |
549 | } |
550 | ||
86538308 EM |
551 | /** |
552 | * @return int | |
553 | */ | |
6a488035 TO |
554 | static function smartGroupCacheTimeout() { |
555 | $config = CRM_Core_Config::singleton(); | |
556 | ||
557 | if ( | |
558 | isset($config->smartGroupCacheTimeout) && | |
559 | is_numeric($config->smartGroupCacheTimeout) && | |
560 | $config->smartGroupCacheTimeout > 0) { | |
561 | return $config->smartGroupCacheTimeout; | |
562 | } | |
563 | ||
564 | // lets have a min cache time of 5 mins if not set | |
565 | return 5; | |
566 | } | |
567 | ||
9be31c7a DL |
568 | /** |
569 | * Get all the smart groups that this contact belongs to | |
570 | * Note that this could potentially be a super slow function since | |
571 | * it ensure that all contact groups are loaded in the cache | |
572 | * | |
573 | * @param int $contactID | |
574 | * @param boolean $showHidden - hidden groups are shown only if this flag is set | |
575 | * | |
576 | * @return array an array of groups that this contact belongs to | |
577 | */ | |
578 | static function contactGroup($contactID, $showHidden = FALSE) { | |
6a488035 TO |
579 | if (empty($contactID)) { |
580 | return; | |
581 | } | |
582 | ||
583 | if (is_array($contactID)) { | |
584 | $contactIDs = $contactID; | |
585 | } | |
586 | else { | |
587 | $contactIDs = array($contactID); | |
588 | } | |
589 | ||
590 | self::loadAll(); | |
591 | ||
9be31c7a DL |
592 | $hiddenClause = ''; |
593 | if (!$showHidden) { | |
594 | $hiddenClause = ' AND (g.is_hidden = 0 OR g.is_hidden IS NULL) '; | |
595 | } | |
596 | ||
6a488035 TO |
597 | $contactIDString = CRM_Core_DAO::escapeString(implode(', ', $contactIDs)); |
598 | $sql = " | |
599 | SELECT gc.group_id, gc.contact_id, g.title, g.children, g.description | |
600 | FROM civicrm_group_contact_cache gc | |
601 | INNER JOIN civicrm_group g ON g.id = gc.group_id | |
602 | WHERE gc.contact_id IN ($contactIDString) | |
9be31c7a | 603 | $hiddenClause |
6a488035 TO |
604 | ORDER BY gc.contact_id, g.children |
605 | "; | |
606 | ||
607 | $dao = CRM_Core_DAO::executeQuery($sql); | |
608 | $contactGroup = array(); | |
609 | $prevContactID = null; | |
610 | while ($dao->fetch()) { | |
611 | if ( | |
612 | $prevContactID && | |
613 | $prevContactID != $dao->contact_id | |
614 | ) { | |
615 | $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']); | |
616 | } | |
617 | $prevContactID = $dao->contact_id; | |
618 | if (!array_key_exists($dao->contact_id, $contactGroup)) { | |
619 | $contactGroup[$dao->contact_id] = | |
620 | array( 'group' => array(), 'groupTitle' => array()); | |
621 | } | |
622 | ||
623 | $contactGroup[$dao->contact_id]['group'][] = | |
624 | array( | |
625 | 'id' => $dao->group_id, | |
626 | 'title' => $dao->title, | |
627 | 'description' => $dao->description, | |
628 | 'children' => $dao->children | |
629 | ); | |
630 | $contactGroup[$dao->contact_id]['groupTitle'][] = $dao->title; | |
631 | } | |
632 | ||
633 | if ($prevContactID) { | |
634 | $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']); | |
635 | } | |
636 | ||
13982f7b | 637 | if ((!empty($contactGroup[$contactID]) && is_numeric($contactID))) { |
6a488035 TO |
638 | return $contactGroup[$contactID]; |
639 | } | |
640 | else { | |
641 | return $contactGroup; | |
642 | } | |
643 | } | |
644 | ||
645 | } | |
646 |