3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Contact_BAO_GroupContactCache
extends CRM_Contact_DAO_GroupContactCache
{
37 static $_alreadyLoaded = array();
40 * Check to see if we have cache entries for this group
41 * if not, regenerate, else return
44 * Of group that we are checking against.
46 * @return boolean TRUE if we did not regenerate, FALSE if we did
48 public static function check($groupIDs) {
49 if (empty($groupIDs)) {
53 return self
::loadAll($groupIDs);
57 * Common function that formulates the query to see which groups needs to be refreshed
58 * based on their cache date and the smartGroupCacheTimeOut
60 * @param string $groupIDClause
61 * The clause which limits which groups we need to evaluate.
62 * @param bool $includeHiddenGroups
63 * Hidden groups are excluded by default.
65 * @return string the sql query which lists the groups that need to be refreshed
68 public static function groupRefreshedClause($groupIDClause = NULL, $includeHiddenGroups = FALSE) {
69 $smartGroupCacheTimeout = self
::smartGroupCacheTimeout();
70 $now = CRM_Utils_Date
::getUTCTime();
75 WHERE ( g.saved_search_id IS NOT NULL OR g.children IS NOT NULL )
77 AND ( g.cache_date IS NULL OR
78 ( TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout ) OR
79 ( $now >= g.refresh_date )
83 if (!$includeHiddenGroups) {
84 $query .= "AND (g.is_hidden = 0 OR g.is_hidden IS NULL)";
87 if (!empty($groupIDClause)) {
88 $query .= " AND ( $groupIDClause ) ";
95 * Checks to see if a group has been refreshed recently. This is primarily used
96 * in a locking scenario when some other process might have refreshed things underneath
101 * @param bool $includeHiddenGroups
102 * Hidden groups are excluded by default.
104 * @return string the sql query which lists the groups that need to be refreshed
107 public static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) {
108 $query = self
::groupRefreshedClause("g.id = %1", $includeHiddenGroups);
109 $params = array(1 => array($groupID, 'Integer'));
111 // if the query returns the group ID, it means the group is a valid candidate for refreshing
112 return CRM_Core_DAO
::singleValueQuery($query, $params);
116 * Check to see if we have cache entries for this group
117 * if not, regenerate, else return
119 * @param int/array $groupID groupID of group that we are checking against
120 * if empty, all groups are checked
122 * Limits the number of groups we evaluate.
124 * @return boolean TRUE if we did not regenerate, FALSE if we did
126 public static function loadAll($groupIDs = NULL, $limit = 0) {
127 // ensure that all the smart groups are loaded
128 // this function is expensive and should be sparingly used if groupIDs is empty
129 if (empty($groupIDs)) {
130 $groupIDClause = NULL;
134 if (!is_array($groupIDs)) {
135 $groupIDs = array($groupIDs);
138 // note escapeString is a must here and we can't send the imploded value as second arguement to
139 // the executeQuery(), since that would put single quote around the string and such a string
140 // of comma separated integers would not work.
141 $groupIDString = CRM_Core_DAO
::escapeString(implode(', ', $groupIDs));
143 $groupIDClause = "g.id IN ({$groupIDString})";
146 $query = self
::groupRefreshedClause($groupIDClause);
148 $limitClause = $orderClause = NULL;
150 $limitClause = " LIMIT 0, $limit";
151 $orderClause = " ORDER BY g.cache_date, g.refresh_date";
153 // We ignore hidden groups and disabled groups
159 $dao = CRM_Core_DAO
::executeQuery($query);
160 $processGroupIDs = array();
161 $refreshGroupIDs = $groupIDs;
162 while ($dao->fetch()) {
163 $processGroupIDs[] = $dao->id
;
165 // remove this id from refreshGroupIDs
166 foreach ($refreshGroupIDs as $idx => $gid) {
167 if ($gid == $dao->id
) {
168 unset($refreshGroupIDs[$idx]);
174 if (!empty($refreshGroupIDs)) {
175 $refreshGroupIDString = CRM_Core_DAO
::escapeString(implode(', ', $refreshGroupIDs));
176 $time = CRM_Utils_Date
::getUTCTime(self
::smartGroupCacheTimeout() * 60);
178 UPDATE civicrm_group g
179 SET g.refresh_date = $time
180 WHERE g.id IN ( {$refreshGroupIDString} )
181 AND g.refresh_date IS NULL
183 CRM_Core_DAO
::executeQuery($query);
186 if (empty($processGroupIDs)) {
190 self
::add($processGroupIDs);
196 * FIXME: This function should not be needed, because the cache table should not be getting truncated
198 public static function fillIfEmpty() {
199 if (!CRM_Core_DAO
::singleValueQuery("SELECT COUNT(id) FROM civicrm_group_contact_cache")) {
205 * @param int $groupID
207 public static function add($groupID) {
208 // first delete the current cache
209 self
::remove($groupID);
210 if (!is_array($groupID)) {
211 $groupID = array($groupID);
214 $returnProperties = array('contact_id');
215 foreach ($groupID as $gid) {
216 $params = array(array('group', 'IN', array($gid => 1), 0, 0));
217 // the below call updates the cache table as a byproduct of the query
218 CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, FALSE);
223 * @param int $groupID
226 public static function store(&$groupID, &$values) {
229 // sort the values so we put group IDs in front and hence optimize
230 // mysql storage (or so we think) CRM-9493
233 // to avoid long strings, lets do BULK_INSERT_COUNT values at a time
234 while (!empty($values)) {
236 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
237 $str = implode(',', $input);
238 $sql = "INSERT IGNORE INTO civicrm_group_contact_cache (group_id,contact_id) VALUES $str;";
239 CRM_Core_DAO
::executeQuery($sql);
241 self
::updateCacheTime($groupID, $processed);
245 * Change the cache_date
247 * @param array $groupID
248 * @param bool $processed
249 * Whether the cache data was recently modified.
251 public static function updateCacheTime($groupID, $processed) {
252 // only update cache entry if we had any values
254 // also update the group with cache date information
255 //make sure to give original timezone settings again.
256 $now = CRM_Utils_Date
::getUTCTime();
264 $groupIDs = implode(',', $groupID);
267 SET cache_date = $now, refresh_date = $refresh
268 WHERE id IN ( $groupIDs )
270 CRM_Core_DAO
::executeQuery($sql);
274 * Removes all the cache entries pertaining to a specific group
275 * If no groupID is passed in, removes cache entries for all groups
276 * Has an optimization to bypass repeated invocations of this function.
277 * Note that this function is an advisory, i.e. the removal respects the
278 * cache date, i.e. the removal is not done if the group was recently
279 * loaded into the cache.
281 * @param int $groupID
282 * the groupID to delete cache entries, NULL for all groups.
283 * @param bool $onceOnly
284 * run the function exactly once for all groups.
289 public static function remove($groupID = NULL, $onceOnly = TRUE) {
290 static $invoked = FALSE;
292 // typically this needs to happy only once per instance
293 // this is especially TRUE in import, where we dont need
294 // to do this all the time
295 // this optimization is done only when no groupID is passed
296 // i.e. cache is reset for all groups
305 if ($groupID == NULL) {
308 elseif (is_array($groupID)) {
309 foreach ($groupID as $gid) {
310 unset(self
::$_alreadyLoaded[$gid]);
313 elseif ($groupID && array_key_exists($groupID, self
::$_alreadyLoaded)) {
314 unset(self
::$_alreadyLoaded[$groupID]);
319 $smartGroupCacheTimeout = self
::smartGroupCacheTimeout();
321 $now = CRM_Utils_Date
::getUTCTime();
322 $refreshTime = CRM_Utils_Date
::getUTCTime($smartGroupCacheTimeout * 60);
324 if (!isset($groupID)) {
325 if ($smartGroupCacheTimeout == 0) {
327 TRUNCATE civicrm_group_contact_cache
330 UPDATE civicrm_group g
331 SET cache_date = null,
338 FROM civicrm_group_contact_cache gc
339 INNER JOIN civicrm_group g ON g.id = gc.group_id
340 WHERE TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout
343 UPDATE civicrm_group g
344 SET cache_date = null,
346 WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) >= $smartGroupCacheTimeout
349 UPDATE civicrm_group g
350 SET refresh_date = $refreshTime
351 WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) < $smartGroupCacheTimeout
352 AND refresh_date IS NULL
356 elseif (is_array($groupID)) {
357 $groupIDs = implode(', ', $groupID);
360 FROM civicrm_group_contact_cache g
361 WHERE g.group_id IN ( $groupIDs )
364 UPDATE civicrm_group g
365 SET cache_date = null,
367 WHERE id IN ( $groupIDs )
373 FROM civicrm_group_contact_cache g
374 WHERE g.group_id = %1
377 UPDATE civicrm_group g
378 SET cache_date = null,
382 $params = array(1 => array($groupID, 'Integer'));
385 CRM_Core_DAO
::executeQuery($query, $params);
388 CRM_Core_DAO
::executeQuery($refresh, $params);
391 // also update the cache_date for these groups
392 CRM_Core_DAO
::executeQuery($update, $params);
396 * Removes one or more contacts from the smart group cache
397 * @param int|array $cid
398 * @param int $groupId
400 * TRUE if successful.
402 public static function removeContact($cid, $groupId = NULL) {
405 foreach ((array) $cid as $c) {
406 $cids[] = CRM_Utils_Type
::escape($c, 'Integer');
409 $condition = count($cids) == 1 ?
"= {$cids[0]}" : "IN (" . implode(',', $cids) . ")";
411 $condition .= " AND group_id = " . CRM_Utils_Type
::escape($groupId, 'Integer');
413 $sql = "DELETE FROM civicrm_group_contact_cache WHERE contact_id $condition";
414 CRM_Core_DAO
::executeQuery($sql);
421 * Load the smart group cache for a saved search
423 * @param object $group
424 * The smart group that needs to be loaded.
426 * Should we force a search through.
429 public static function load(&$group, $force = FALSE) {
430 $groupID = $group->id
;
431 $savedSearchID = $group->saved_search_id
;
432 if (array_key_exists($groupID, self
::$_alreadyLoaded) && !$force) {
436 // grab a lock so other processes dont compete and do the same query
437 $lockName = "civicrm.group.{$groupID}";
438 $lock = new CRM_Core_Lock($lockName);
439 if (!$lock->isAcquired()) {
440 // this can cause inconsistent results since we dont know if the other process
441 // will fill up the cache before our calling routine needs it.
442 // however this routine does not return the status either, so basically
443 // its a "lets return and hope for the best"
447 self
::$_alreadyLoaded[$groupID] = 1;
449 // we now have the lock, but some other proces could have actually done the work
450 // before we got here, so before we do any work, lets ensure that work needs to be
452 // we allow hidden groups here since we dont know if the caller wants to evaluate an
454 if (!$force && !self
::shouldGroupBeRefreshed($groupID, TRUE)) {
462 if ($savedSearchID) {
463 $ssParams = CRM_Contact_BAO_SavedSearch
::getSearchParams($savedSearchID);
465 // rectify params to what proximity search expects if there is a value for prox_distance
467 if (!empty($ssParams)) {
468 CRM_Contact_BAO_ProximityQuery
::fixInputParams($ssParams);
472 $returnProperties = array();
473 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $savedSearchID, 'mapping_id')) {
474 $fv = CRM_Contact_BAO_SavedSearch
::getFormValues($savedSearchID);
475 $returnProperties = CRM_Core_BAO_Mapping
::returnProperties($fv);
478 if (isset($ssParams['customSearchID'])) {
481 // we split it up and store custom class
482 // so temp tables are not destroyed if they are used
483 // hence customClass is defined above at top of function
485 CRM_Contact_BAO_SearchCustom
::customClass($ssParams['customSearchID'], $savedSearchID);
486 $searchSQL = $customClass->contactIDs();
487 $searchSQL = str_replace('ORDER BY contact_a.id ASC', '', $searchSQL);
488 $idName = 'contact_id';
491 $formValues = CRM_Contact_BAO_SavedSearch
::getFormValues($savedSearchID);
494 new CRM_Contact_BAO_Query(
495 $ssParams, $returnProperties, NULL,
499 CRM_Utils_Array
::value('display_relationship_type', $formValues),
500 CRM_Utils_Array
::value('operator', $formValues, 'AND')
502 $query->_useDistinct
= FALSE;
503 $query->_useGroupBy
= FALSE;
514 $groupID = CRM_Utils_Type
::escape($groupID, 'Integer');
515 $sql = $searchSQL . " AND contact_a.id NOT IN (
516 SELECT contact_id FROM civicrm_group_contact
517 WHERE civicrm_group_contact.status = 'Removed'
518 AND civicrm_group_contact.group_id = $groupID ) ";
522 $sql = preg_replace("/^\s*SELECT/", "SELECT $groupID as group_id, ", $sql);
525 // lets also store the records that are explicitly added to the group
526 // this allows us to skip the group contact LEFT JOIN
528 SELECT $groupID as group_id, contact_id as $idName
529 FROM civicrm_group_contact
530 WHERE civicrm_group_contact.status = 'Added'
531 AND civicrm_group_contact.group_id = $groupID ";
533 $groupIDs = array($groupID);
534 self
::remove($groupIDs);
536 $tempTable = 'civicrm_temp_group_contact_cache' . rand(0,2000);
537 foreach (array($sql, $sqlB) as $selectSql) {
541 $insertSql = "CREATE TEMPORARY TABLE $tempTable ($selectSql);";
543 $result = CRM_Core_DAO
::executeQuery($insertSql);
544 CRM_Core_DAO
::executeQuery(
545 "INSERT IGNORE INTO civicrm_group_contact_cache (contact_id, group_id)
546 SELECT DISTINCT $idName, group_id FROM $tempTable
548 CRM_Core_DAO
::executeQuery(" DROP TABLE $tempTable");
551 self
::updateCacheTime($groupIDs, $processed);
553 if ($group->children
) {
555 //Store a list of contacts who are removed from the parent group
558 FROM civicrm_group_contact
559 WHERE civicrm_group_contact.status = 'Removed'
560 AND civicrm_group_contact.group_id = $groupID ";
561 $dao = CRM_Core_DAO
::executeQuery($sql);
562 $removed_contacts = array();
563 while ($dao->fetch()) {
564 $removed_contacts[] = $dao->contact_id
;
567 $childrenIDs = explode(',', $group->children
);
568 foreach ($childrenIDs as $childID) {
569 $contactIDs = CRM_Contact_BAO_Group
::getMember($childID, FALSE);
570 //Unset each contact that is removed from the parent group
571 foreach ($removed_contacts as $removed_contact) {
572 unset($contactIDs[$removed_contact]);
575 foreach ($contactIDs as $contactID => $dontCare) {
576 $values[] = "({$groupID},{$contactID})";
579 self
::store($groupIDs, $values);
589 public static function smartGroupCacheTimeout() {
590 $config = CRM_Core_Config
::singleton();
593 isset($config->smartGroupCacheTimeout
) &&
594 is_numeric($config->smartGroupCacheTimeout
) &&
595 $config->smartGroupCacheTimeout
> 0) {
596 return $config->smartGroupCacheTimeout
;
599 // lets have a min cache time of 5 mins if not set
604 * Get all the smart groups that this contact belongs to
605 * Note that this could potentially be a super slow function since
606 * it ensure that all contact groups are loaded in the cache
608 * @param int $contactID
609 * @param bool $showHidden
610 * Hidden groups are shown only if this flag is set.
612 * @return array an array of groups that this contact belongs to
614 public static function contactGroup($contactID, $showHidden = FALSE) {
615 if (empty($contactID)) {
619 if (is_array($contactID)) {
620 $contactIDs = $contactID;
623 $contactIDs = array($contactID);
630 $hiddenClause = ' AND (g.is_hidden = 0 OR g.is_hidden IS NULL) ';
633 $contactIDString = CRM_Core_DAO
::escapeString(implode(', ', $contactIDs));
635 SELECT gc.group_id, gc.contact_id, g.title, g.children, g.description
636 FROM civicrm_group_contact_cache gc
637 INNER JOIN civicrm_group g ON g.id = gc.group_id
638 WHERE gc.contact_id IN ($contactIDString)
640 ORDER BY gc.contact_id, g.children
643 $dao = CRM_Core_DAO
::executeQuery($sql);
644 $contactGroup = array();
645 $prevContactID = NULL;
646 while ($dao->fetch()) {
649 $prevContactID != $dao->contact_id
651 $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']);
653 $prevContactID = $dao->contact_id
;
654 if (!array_key_exists($dao->contact_id
, $contactGroup)) {
655 $contactGroup[$dao->contact_id
] =
656 array('group' => array(), 'groupTitle' => array());
659 $contactGroup[$dao->contact_id
]['group'][] =
661 'id' => $dao->group_id
,
662 'title' => $dao->title
,
663 'description' => $dao->description
,
664 'children' => $dao->children
,
666 $contactGroup[$dao->contact_id
]['groupTitle'][] = $dao->title
;
669 if ($prevContactID) {
670 $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']);
673 if ((!empty($contactGroup[$contactID]) && is_numeric($contactID))) {
674 return $contactGroup[$contactID];
677 return $contactGroup;