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
43 * @param $groupIDs of group that we are checking against
45 * @return boolean true if we did not regenerate, false if we did
47 public static function check($groupIDs) {
48 if (empty($groupIDs)) {
52 return self
::loadAll($groupIDs);
56 * Common function that formulates the query to see which groups needs to be refreshed
57 * based on their cache date and the smartGroupCacheTimeOut
59 * @param string $groupIDClause the clause which limits which groups we need to evaluate
60 * @param boolean $includeHiddenGroups hidden groups are excluded by default
62 * @return string the sql query which lists the groups that need to be refreshed
65 public static function groupRefreshedClause($groupIDClause = null, $includeHiddenGroups = FALSE) {
66 $smartGroupCacheTimeout = self
::smartGroupCacheTimeout();
67 $now = CRM_Utils_Date
::getUTCTime();
72 WHERE ( g.saved_search_id IS NOT NULL OR g.children IS NOT NULL )
74 AND ( g.cache_date IS NULL OR
75 ( TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout ) OR
76 ( $now >= g.refresh_date )
80 if (!$includeHiddenGroups) {
81 $query .= "AND (g.is_hidden = 0 OR g.is_hidden IS NULL)";
84 if (!empty($groupIDClause)) {
85 $query .= " AND ( $groupIDClause ) ";
92 * Checks to see if a group has been refreshed recently. This is primarily used
93 * in a locking scenario when some other process might have refreshed things underneath
96 * @param int $groupID the group ID
97 * @param boolean $includeHiddenGroups hidden groups are excluded by default
99 * @return string the sql query which lists the groups that need to be refreshed
102 public static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) {
103 $query = self
::groupRefreshedClause("g.id = %1", $includeHiddenGroups);
104 $params = array(1 => array($groupID, 'Integer'));
106 // if the query returns the group ID, it means the group is a valid candidate for refreshing
107 return CRM_Core_DAO
::singleValueQuery($query, $params);
111 * Check to see if we have cache entries for this group
112 * if not, regenerate, else return
114 * @param int/array $groupID groupID of group that we are checking against
115 * if empty, all groups are checked
116 * @param int $limit limits the number of groups we evaluate
118 * @return boolean true if we did not regenerate, false if we did
120 public static function loadAll($groupIDs = null, $limit = 0) {
121 // ensure that all the smart groups are loaded
122 // this function is expensive and should be sparingly used if groupIDs is empty
123 if (empty($groupIDs)) {
124 $groupIDClause = null;
125 $groupIDs = array( );
128 if (!is_array($groupIDs)) {
129 $groupIDs = array($groupIDs);
132 // note escapeString is a must here and we can't send the imploded value as second arguement to
133 // the executeQuery(), since that would put single quote around the string and such a string
134 // of comma separated integers would not work.
135 $groupIDString = CRM_Core_DAO
::escapeString(implode(', ', $groupIDs));
137 $groupIDClause = "g.id IN ({$groupIDString})";
140 $query = self
::groupRefreshedClause($groupIDClause);
142 $limitClause = $orderClause = NULL;
144 $limitClause = " LIMIT 0, $limit";
145 $orderClause = " ORDER BY g.cache_date, g.refresh_date";
147 // We ignore hidden groups and disabled groups
153 $dao = CRM_Core_DAO
::executeQuery($query);
154 $processGroupIDs = array();
155 $refreshGroupIDs = $groupIDs;
156 while ($dao->fetch()) {
157 $processGroupIDs[] = $dao->id
;
159 // remove this id from refreshGroupIDs
160 foreach ($refreshGroupIDs as $idx => $gid) {
161 if ($gid == $dao->id
) {
162 unset($refreshGroupIDs[$idx]);
168 if (!empty($refreshGroupIDs)) {
169 $refreshGroupIDString = CRM_Core_DAO
::escapeString(implode(', ', $refreshGroupIDs));
170 $time = CRM_Utils_Date
::getUTCTime(self
::smartGroupCacheTimeout() * 60);
172 UPDATE civicrm_group g
173 SET g.refresh_date = $time
174 WHERE g.id IN ( {$refreshGroupIDString} )
175 AND g.refresh_date IS NULL
177 CRM_Core_DAO
::executeQuery($query);
180 if (empty($processGroupIDs)) {
184 self
::add($processGroupIDs);
190 * FIXME: This function should not be needed, because the cache table should not be getting truncated
192 public static function fillIfEmpty() {
193 if (!CRM_Core_DAO
::singleValueQuery("SELECT COUNT(id) FROM civicrm_group_contact_cache")) {
199 * @param int $groupID
201 public static function add($groupID) {
202 // first delete the current cache
203 self
::remove($groupID);
204 if (!is_array($groupID)) {
205 $groupID = array($groupID);
208 $returnProperties = array('contact_id');
209 foreach ($groupID as $gid) {
210 $params = array(array('group', 'IN', array($gid => 1), 0, 0));
211 // the below call updates the cache table as a byproduct of the query
212 CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, FALSE);
217 * @param int $groupID
220 public static function store(&$groupID, &$values) {
223 // sort the values so we put group IDs in front and hence optimize
224 // mysql storage (or so we think) CRM-9493
227 // to avoid long strings, lets do BULK_INSERT_COUNT values at a time
228 while (!empty($values)) {
230 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
231 $str = implode(',', $input);
232 $sql = "INSERT IGNORE INTO civicrm_group_contact_cache (group_id,contact_id) VALUES $str;";
233 CRM_Core_DAO
::executeQuery($sql);
235 self
::updateCacheTime($groupID, $processed);
239 * Change the cache_date
241 * @param $groupID array(int)
242 * @param $processed bool, whether the cache data was recently modified
244 public static function updateCacheTime($groupID, $processed) {
245 // only update cache entry if we had any values
247 // also update the group with cache date information
248 //make sure to give original timezone settings again.
249 $now = CRM_Utils_Date
::getUTCTime();
257 $groupIDs = implode(',', $groupID);
260 SET cache_date = $now, refresh_date = $refresh
261 WHERE id IN ( $groupIDs )
263 CRM_Core_DAO
::executeQuery($sql);
267 * Removes all the cache entries pertaining to a specific group
268 * If no groupID is passed in, removes cache entries for all groups
269 * Has an optimization to bypass repeated invocations of this function.
270 * Note that this function is an advisory, i.e. the removal respects the
271 * cache date, i.e. the removal is not done if the group was recently
272 * loaded into the cache.
274 * @param $groupID int the groupID to delete cache entries, NULL for all groups
275 * @param $onceOnly boolean run the function exactly once for all groups.
280 public static function remove($groupID = NULL, $onceOnly = TRUE) {
281 static $invoked = FALSE;
283 // typically this needs to happy only once per instance
284 // this is especially true in import, where we dont need
285 // to do this all the time
286 // this optimization is done only when no groupID is passed
287 // i.e. cache is reset for all groups
296 if ($groupID == NULL) {
298 } else if (is_array($groupID)) {
299 foreach ($groupID as $gid) {
300 unset(self
::$_alreadyLoaded[$gid]);
302 } else if ($groupID && array_key_exists($groupID, self
::$_alreadyLoaded)) {
303 unset(self
::$_alreadyLoaded[$groupID]);
308 $smartGroupCacheTimeout = self
::smartGroupCacheTimeout();
310 $now = CRM_Utils_Date
::getUTCTime();
311 $refreshTime = CRM_Utils_Date
::getUTCTime($smartGroupCacheTimeout * 60);
313 if (!isset($groupID)) {
314 if ($smartGroupCacheTimeout == 0) {
316 TRUNCATE civicrm_group_contact_cache
319 UPDATE civicrm_group g
320 SET cache_date = null,
327 FROM civicrm_group_contact_cache gc
328 INNER JOIN civicrm_group g ON g.id = gc.group_id
329 WHERE TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout
332 UPDATE civicrm_group g
333 SET cache_date = null,
335 WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) >= $smartGroupCacheTimeout
338 UPDATE civicrm_group g
339 SET refresh_date = $refreshTime
340 WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) < $smartGroupCacheTimeout
341 AND refresh_date IS NULL
345 elseif (is_array($groupID)) {
346 $groupIDs = implode(', ', $groupID);
349 FROM civicrm_group_contact_cache g
350 WHERE g.group_id IN ( $groupIDs )
353 UPDATE civicrm_group g
354 SET cache_date = null,
356 WHERE id IN ( $groupIDs )
362 FROM civicrm_group_contact_cache g
363 WHERE g.group_id = %1
366 UPDATE civicrm_group g
367 SET cache_date = null,
371 $params = array(1 => array($groupID, 'Integer'));
374 CRM_Core_DAO
::executeQuery($query, $params);
377 CRM_Core_DAO
::executeQuery($refresh, $params);
380 // also update the cache_date for these groups
381 CRM_Core_DAO
::executeQuery($update, $params);
385 * Removes one or more contacts from the smart group cache
386 * @param int|array $cid
387 * @param int $groupId
388 * @return bool - true if successful
390 public static function removeContact($cid, $groupId = NULL) {
393 foreach ((array) $cid as $c) {
394 $cids[] = CRM_Utils_Type
::escape($c, 'Integer');
397 $condition = count($cids) == 1 ?
"= {$cids[0]}" : "IN (" . implode(',', $cids) . ")";
399 $condition .= " AND group_id = " . CRM_Utils_Type
::escape($groupId, 'Integer');
401 $sql = "DELETE FROM civicrm_group_contact_cache WHERE contact_id $condition";
402 CRM_Core_DAO
::executeQuery($sql);
409 * Load the smart group cache for a saved search
411 * @param object $group - the smart group that needs to be loaded
412 * @param boolean $force - should we force a search through
415 public static function load(&$group, $force = FALSE) {
416 $groupID = $group->id
;
417 $savedSearchID = $group->saved_search_id
;
418 if (array_key_exists($groupID, self
::$_alreadyLoaded) && !$force) {
422 // grab a lock so other processes dont compete and do the same query
423 $lockName = "civicrm.group.{$groupID}";
424 $lock = new CRM_Core_Lock($lockName);
425 if (!$lock->isAcquired()) {
426 // this can cause inconsistent results since we dont know if the other process
427 // will fill up the cache before our calling routine needs it.
428 // however this routine does not return the status either, so basically
429 // its a "lets return and hope for the best"
433 self
::$_alreadyLoaded[$groupID] = 1;
435 // we now have the lock, but some other proces could have actually done the work
436 // before we got here, so before we do any work, lets ensure that work needs to be
438 // we allow hidden groups here since we dont know if the caller wants to evaluate an
440 if (!$force && !self
::shouldGroupBeRefreshed($groupID, TRUE)) {
448 if ($savedSearchID) {
449 $ssParams = CRM_Contact_BAO_SavedSearch
::getSearchParams($savedSearchID);
451 // rectify params to what proximity search expects if there is a value for prox_distance
453 if (!empty($ssParams)) {
454 CRM_Contact_BAO_ProximityQuery
::fixInputParams($ssParams);
458 $returnProperties = array();
459 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $savedSearchID, 'mapping_id')) {
460 $fv = CRM_Contact_BAO_SavedSearch
::getFormValues($savedSearchID);
461 $returnProperties = CRM_Core_BAO_Mapping
::returnProperties($fv);
464 if (isset($ssParams['customSearchID'])) {
467 // we split it up and store custom class
468 // so temp tables are not destroyed if they are used
469 // hence customClass is defined above at top of function
471 CRM_Contact_BAO_SearchCustom
::customClass($ssParams['customSearchID'], $savedSearchID);
472 $searchSQL = $customClass->contactIDs();
473 $searchSQL = str_replace('ORDER BY contact_a.id ASC', '', $searchSQL);
474 $idName = 'contact_id';
477 $formValues = CRM_Contact_BAO_SavedSearch
::getFormValues($savedSearchID);
480 new CRM_Contact_BAO_Query(
481 $ssParams, $returnProperties, NULL,
485 CRM_Utils_Array
::value('display_relationship_type', $formValues),
486 CRM_Utils_Array
::value('operator', $formValues, 'AND')
488 $query->_useDistinct
= FALSE;
489 $query->_useGroupBy
= FALSE;
500 $groupID = CRM_Utils_Type
::escape($groupID, 'Integer');
501 $sql = $searchSQL . " AND contact_a.id NOT IN (
502 SELECT contact_id FROM civicrm_group_contact
503 WHERE civicrm_group_contact.status = 'Removed'
504 AND civicrm_group_contact.group_id = $groupID ) ";
508 $sql = preg_replace("/^\s*SELECT/", "SELECT $groupID as group_id, ", $sql);
511 // lets also store the records that are explicitly added to the group
512 // this allows us to skip the group contact LEFT JOIN
514 SELECT $groupID as group_id, contact_id as $idName
515 FROM civicrm_group_contact
516 WHERE civicrm_group_contact.status = 'Added'
517 AND civicrm_group_contact.group_id = $groupID ";
519 $groupIDs = array($groupID);
520 self
::remove($groupIDs);
522 $tempTable = 'civicrm_temp_group_contact_cache' . rand(0,2000);
523 foreach (array($sql, $sqlB) as $selectSql) {
527 $insertSql = "CREATE TEMPORARY TABLE $tempTable ($selectSql);";
529 $result = CRM_Core_DAO
::executeQuery($insertSql);
530 CRM_Core_DAO
::executeQuery(
531 "INSERT IGNORE INTO civicrm_group_contact_cache (contact_id, group_id)
532 SELECT DISTINCT $idName, group_id FROM $tempTable
534 CRM_Core_DAO
::executeQuery(" DROP TABLE $tempTable");
537 self
::updateCacheTime($groupIDs, $processed);
539 if ($group->children
) {
541 //Store a list of contacts who are removed from the parent group
544 FROM civicrm_group_contact
545 WHERE civicrm_group_contact.status = 'Removed'
546 AND civicrm_group_contact.group_id = $groupID ";
547 $dao = CRM_Core_DAO
::executeQuery($sql);
548 $removed_contacts = array();
549 while ($dao->fetch()) {
550 $removed_contacts[] = $dao->contact_id
;
553 $childrenIDs = explode(',', $group->children
);
554 foreach ($childrenIDs as $childID) {
555 $contactIDs = CRM_Contact_BAO_Group
::getMember($childID, FALSE);
556 //Unset each contact that is removed from the parent group
557 foreach ($removed_contacts as $removed_contact) {
558 unset($contactIDs[$removed_contact]);
561 foreach ($contactIDs as $contactID => $dontCare) {
562 $values[] = "({$groupID},{$contactID})";
565 self
::store($groupIDs, $values);
575 public static function smartGroupCacheTimeout() {
576 $config = CRM_Core_Config
::singleton();
579 isset($config->smartGroupCacheTimeout
) &&
580 is_numeric($config->smartGroupCacheTimeout
) &&
581 $config->smartGroupCacheTimeout
> 0) {
582 return $config->smartGroupCacheTimeout
;
585 // lets have a min cache time of 5 mins if not set
590 * Get all the smart groups that this contact belongs to
591 * Note that this could potentially be a super slow function since
592 * it ensure that all contact groups are loaded in the cache
594 * @param int $contactID
595 * @param boolean $showHidden - hidden groups are shown only if this flag is set
597 * @return array an array of groups that this contact belongs to
599 public static function contactGroup($contactID, $showHidden = FALSE) {
600 if (empty($contactID)) {
604 if (is_array($contactID)) {
605 $contactIDs = $contactID;
608 $contactIDs = array($contactID);
615 $hiddenClause = ' AND (g.is_hidden = 0 OR g.is_hidden IS NULL) ';
618 $contactIDString = CRM_Core_DAO
::escapeString(implode(', ', $contactIDs));
620 SELECT gc.group_id, gc.contact_id, g.title, g.children, g.description
621 FROM civicrm_group_contact_cache gc
622 INNER JOIN civicrm_group g ON g.id = gc.group_id
623 WHERE gc.contact_id IN ($contactIDString)
625 ORDER BY gc.contact_id, g.children
628 $dao = CRM_Core_DAO
::executeQuery($sql);
629 $contactGroup = array();
630 $prevContactID = null;
631 while ($dao->fetch()) {
634 $prevContactID != $dao->contact_id
636 $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']);
638 $prevContactID = $dao->contact_id
;
639 if (!array_key_exists($dao->contact_id
, $contactGroup)) {
640 $contactGroup[$dao->contact_id
] =
641 array( 'group' => array(), 'groupTitle' => array());
644 $contactGroup[$dao->contact_id
]['group'][] =
646 'id' => $dao->group_id
,
647 'title' => $dao->title
,
648 'description' => $dao->description
,
649 'children' => $dao->children
651 $contactGroup[$dao->contact_id
]['groupTitle'][] = $dao->title
;
654 if ($prevContactID) {
655 $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']);
658 if ((!empty($contactGroup[$contactID]) && is_numeric($contactID))) {
659 return $contactGroup[$contactID];
662 return $contactGroup;