3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 int $groupID groupID of group that we are checking against
45 * @return boolean true if we did not regenerate, false if we did
47 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
66 static function groupRefreshedClause($groupIDClause = null, $includeHiddenGroups = FALSE) {
67 $smartGroupCacheTimeout = self
::smartGroupCacheTimeout();
68 $now = CRM_Utils_Date
::getUTCTime();
73 WHERE ( g.saved_search_id IS NOT NULL OR g.children IS NOT NULL )
75 AND ( g.cache_date IS NULL OR
76 ( TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout ) OR
77 ( $now >= g.refresh_date )
81 if (!$includeHiddenGroups) {
82 $query .= "AND (g.is_hidden = 0 OR g.is_hidden IS NULL)";
85 if (!empty($groupIDClause)) {
86 $query .= " AND ( $groupIDClause ) ";
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
97 * @param int $groupID the group ID
98 * @param boolean $includeHiddenGroups hidden groups are excluded by default
100 * @return string the sql query which lists the groups that need to be refreshed
104 static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) {
105 $query = self
::groupRefreshedClause("g.id = %1", $includeHiddenGroups);
106 $params = array(1 => array($groupID, 'Integer'));
108 // if the query returns the group ID, it means the group is a valid candidate for refreshing
109 return CRM_Core_DAO
::singleValueQuery($query, $params);
113 * Check to see if we have cache entries for this group
114 * if not, regenerate, else return
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
120 * @return boolean true if we did not regenerate, false if we did
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
125 if (empty($groupIDs)) {
126 $groupIDClause = null;
127 $groupIDs = array( );
130 if (!is_array($groupIDs)) {
131 $groupIDs = array($groupIDs);
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.
137 $groupIDString = CRM_Core_DAO
::escapeString(implode(', ', $groupIDs));
139 $groupIDClause = "g.id IN ({$groupIDString})";
142 $query = self
::groupRefreshedClause($groupIDClause);
144 $limitClause = $orderClause = NULL;
146 $limitClause = " LIMIT 0, $limit";
147 $orderClause = " ORDER BY g.cache_date, g.refresh_date";
149 // We ignore hidden groups and disabled groups
155 $dao = CRM_Core_DAO
::executeQuery($query);
156 $processGroupIDs = array();
157 $refreshGroupIDs = $groupIDs;
158 while ($dao->fetch()) {
159 $processGroupIDs[] = $dao->id
;
161 // remove this id from refreshGroupIDs
162 foreach ($refreshGroupIDs as $idx => $gid) {
163 if ($gid == $dao->id
) {
164 unset($refreshGroupIDs[$idx]);
170 if (!empty($refreshGroupIDs)) {
171 $refreshGroupIDString = CRM_Core_DAO
::escapeString(implode(', ', $refreshGroupIDs));
172 $time = CRM_Utils_Date
::getUTCTime($smartGroupCacheTimeout * 60);
174 UPDATE civicrm_group g
175 SET g.refresh_date = $time
176 WHERE g.id IN ( {$refreshGroupIDString} )
177 AND g.refresh_date IS NULL
179 CRM_Core_DAO
::executeQuery($query);
182 if (empty($processGroupIDs)) {
186 self
::add($processGroupIDs);
191 static function add($groupID) {
192 // first delete the current cache
193 self
::remove($groupID);
194 if (!is_array($groupID)) {
195 $groupID = array($groupID);
198 $returnProperties = array('contact_id');
199 foreach ($groupID as $gid) {
200 $params = array(array('group', 'IN', array($gid => 1), 0, 0));
201 // the below call updates the cache table as a byproduct of the query
202 CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, FALSE);
206 static function store(&$groupID, &$values) {
209 // sort the values so we put group IDs in front and hence optimize
210 // mysql storage (or so we think) CRM-9493
213 // to avoid long strings, lets do BULK_INSERT_COUNT values at a time
214 while (!empty($values)) {
216 $input = array_splice($values, 0, CRM_Core_DAO
::BULK_INSERT_COUNT
);
217 $str = implode(',', $input);
218 $sql = "INSERT IGNORE INTO civicrm_group_contact_cache (group_id,contact_id) VALUES $str;";
219 CRM_Core_DAO
::executeQuery($sql);
221 self
::updateCacheTime($groupID, $processed);
225 * Change the cache_date
227 * @param $groupID array(int)
228 * @param $processed bool, whether the cache data was recently modified
230 static function updateCacheTime($groupID, $processed) {
231 // only update cache entry if we had any values
233 // also update the group with cache date information
234 //make sure to give original timezone settings again.
235 $now = CRM_Utils_Date
::getUTCTime();
243 $groupIDs = implode(',', $groupID);
246 SET cache_date = $now, refresh_date = $refresh
247 WHERE id IN ( $groupIDs )
249 CRM_Core_DAO
::executeQuery($sql);
252 static function remove($groupID = NULL, $onceOnly = TRUE) {
253 static $invoked = FALSE;
255 // typically this needs to happy only once per instance
256 // this is especially true in import, where we dont need
257 // to do this all the time
258 // this optimization is done only when no groupID is passed
259 // i.e. cache is reset for all groups
268 if ($groupID == NULL) {
270 } else if (is_array($groupID)) {
271 foreach ($groupID as $gid) {
272 unset(self
::$_alreadyLoaded[$gid]);
274 } else if ($groupID && array_key_exists($groupID, self
::$_alreadyLoaded)) {
275 unset(self
::$_alreadyLoaded[$groupID]);
280 $smartGroupCacheTimeout = self
::smartGroupCacheTimeout();
282 $now = CRM_Utils_Date
::getUTCTime();
283 $refreshTime = CRM_Utils_Date
::getUTCTime($smartGroupCacheTimeout * 60);
285 if (!isset($groupID)) {
286 if ($smartGroupCacheTimeout == 0) {
288 TRUNCATE civicrm_group_contact_cache
291 UPDATE civicrm_group g
292 SET cache_date = null,
299 FROM civicrm_group_contact_cache gc
300 INNER JOIN civicrm_group g ON g.id = gc.group_id
301 WHERE TIMESTAMPDIFF(MINUTE, g.cache_date, $now) >= $smartGroupCacheTimeout
304 UPDATE civicrm_group g
305 SET cache_date = null,
307 WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) >= $smartGroupCacheTimeout
310 UPDATE civicrm_group g
311 SET refresh_date = $refreshTime
312 WHERE TIMESTAMPDIFF(MINUTE, cache_date, $now) < $smartGroupCacheTimeout
313 AND refresh_date IS NULL
317 elseif (is_array($groupID)) {
318 $groupIDs = implode(', ', $groupID);
321 FROM civicrm_group_contact_cache g
322 WHERE g.group_id IN ( $groupIDs )
325 UPDATE civicrm_group g
326 SET cache_date = null,
328 WHERE id IN ( $groupIDs )
334 FROM civicrm_group_contact_cache g
335 WHERE g.group_id = %1
338 UPDATE civicrm_group g
339 SET cache_date = null,
343 $params = array(1 => array($groupID, 'Integer'));
346 CRM_Core_DAO
::executeQuery($query, $params);
349 CRM_Core_DAO
::executeQuery($refresh, $params);
352 // also update the cache_date for these groups
353 CRM_Core_DAO
::executeQuery($update, $params);
357 * load the smart group cache for a saved search
359 * @param object $group - the smart group that needs to be loaded
360 * @param boolean $force - should we force a search through
363 static function load(&$group, $force = FALSE) {
364 $groupID = $group->id
;
365 $savedSearchID = $group->saved_search_id
;
366 if (array_key_exists($groupID, self
::$_alreadyLoaded) && !$force) {
370 // grab a lock so other processes dont compete and do the same query
371 $lockName = "civicrm.group.{$groupID}";
372 $lock = new CRM_Core_Lock($lockName);
373 if (!$lock->isAcquired()) {
374 // this can cause inconsistent results since we dont know if the other process
375 // will fill up the cache before our calling routine needs it.
376 // however this routine does not return the status either, so basically
377 // its a "lets return and hope for the best"
381 self
::$_alreadyLoaded[$groupID] = 1;
383 // we now have the lock, but some other proces could have actually done the work
384 // before we got here, so before we do any work, lets ensure that work needs to be
386 // we allow hidden groups here since we dont know if the caller wants to evaluate an
388 if (!$force && !self
::shouldGroupBeRefreshed($groupID, FALSE, TRUE)) {
396 if ($savedSearchID) {
397 $ssParams = CRM_Contact_BAO_SavedSearch
::getSearchParams($savedSearchID);
399 // rectify params to what proximity search expects if there is a value for prox_distance
401 if (!empty($ssParams)) {
402 CRM_Contact_BAO_ProximityQuery
::fixInputParams($ssParams);
406 $returnProperties = array();
407 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $savedSearchID, 'mapping_id')) {
408 $fv = CRM_Contact_BAO_SavedSearch
::getFormValues($savedSearchID);
409 $returnProperties = CRM_Core_BAO_Mapping
::returnProperties($fv);
412 if (isset($ssParams['customSearchID'])) {
415 // we split it up and store custom class
416 // so temp tables are not destroyed if they are used
417 // hence customClass is defined above at top of function
419 CRM_Contact_BAO_SearchCustom
::customClass($ssParams['customSearchID'], $savedSearchID);
420 $searchSQL = $customClass->contactIDs();
421 $idName = 'contact_id';
424 $formValues = CRM_Contact_BAO_SavedSearch
::getFormValues($savedSearchID);
427 new CRM_Contact_BAO_Query(
428 $ssParams, $returnProperties, NULL,
432 CRM_Utils_Array
::value('display_relationship_type', $formValues),
433 CRM_Utils_Array
::value('operator', $formValues, 'AND')
435 $query->_useDistinct
= FALSE;
436 $query->_useGroupBy
= FALSE;
447 $groupID = CRM_Utils_Type
::escape($groupID, 'Integer');
448 $sql = $searchSQL . " AND contact_a.id NOT IN (
449 SELECT contact_id FROM civicrm_group_contact
450 WHERE civicrm_group_contact.status = 'Removed'
451 AND civicrm_group_contact.group_id = $groupID ) ";
455 $sql = preg_replace("/^\s*SELECT/", "SELECT $groupID as group_id, ", $sql);
458 // lets also store the records that are explicitly added to the group
459 // this allows us to skip the group contact LEFT JOIN
461 SELECT $groupID as group_id, contact_id as $idName
462 FROM civicrm_group_contact
463 WHERE civicrm_group_contact.status = 'Added'
464 AND civicrm_group_contact.group_id = $groupID ";
466 $groupIDs = array($groupID);
467 self
::remove($groupIDs);
470 foreach (array($sql, $sqlB) as $selectSql) {
474 $insertSql = "INSERT IGNORE INTO civicrm_group_contact_cache (group_id,contact_id) ($selectSql);";
476 $result = CRM_Core_DAO
::executeQuery($insertSql);
478 self
::updateCacheTime($groupIDs, $processed);
480 if ($group->children
) {
482 //Store a list of contacts who are removed from the parent group
485 FROM civicrm_group_contact
486 WHERE civicrm_group_contact.status = 'Removed'
487 AND civicrm_group_contact.group_id = $groupID ";
488 $dao = CRM_Core_DAO
::executeQuery($sql);
489 $removed_contacts = array();
490 while ($dao->fetch()) {
491 $removed_contacts[] = $dao->contact_id
;
494 $childrenIDs = explode(',', $group->children
);
495 foreach ($childrenIDs as $childID) {
496 $contactIDs = CRM_Contact_BAO_Group
::getMember($childID, FALSE);
497 //Unset each contact that is removed from the parent group
498 foreach ($removed_contacts as $removed_contact) {
499 unset($contactIDs[$removed_contact]);
502 foreach ($contactIDs as $contactID => $dontCare) {
503 $values[] = "({$groupID},{$contactID})";
506 self
::store($groupIDs, $values);
513 static function smartGroupCacheTimeout() {
514 $config = CRM_Core_Config
::singleton();
517 isset($config->smartGroupCacheTimeout
) &&
518 is_numeric($config->smartGroupCacheTimeout
) &&
519 $config->smartGroupCacheTimeout
> 0) {
520 return $config->smartGroupCacheTimeout
;
523 // lets have a min cache time of 5 mins if not set
528 * Get all the smart groups that this contact belongs to
529 * Note that this could potentially be a super slow function since
530 * it ensure that all contact groups are loaded in the cache
532 * @param int $contactID
533 * @param boolean $showHidden - hidden groups are shown only if this flag is set
535 * @return array an array of groups that this contact belongs to
537 static function contactGroup($contactID, $showHidden = FALSE) {
538 if (empty($contactID)) {
542 if (is_array($contactID)) {
543 $contactIDs = $contactID;
546 $contactIDs = array($contactID);
553 $hiddenClause = ' AND (g.is_hidden = 0 OR g.is_hidden IS NULL) ';
556 $contactIDString = CRM_Core_DAO
::escapeString(implode(', ', $contactIDs));
558 SELECT gc.group_id, gc.contact_id, g.title, g.children, g.description
559 FROM civicrm_group_contact_cache gc
560 INNER JOIN civicrm_group g ON g.id = gc.group_id
561 WHERE gc.contact_id IN ($contactIDString)
563 ORDER BY gc.contact_id, g.children
566 $dao = CRM_Core_DAO
::executeQuery($sql);
567 $contactGroup = array();
568 $prevContactID = null;
569 while ($dao->fetch()) {
572 $prevContactID != $dao->contact_id
574 $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']);
576 $prevContactID = $dao->contact_id
;
577 if (!array_key_exists($dao->contact_id
, $contactGroup)) {
578 $contactGroup[$dao->contact_id
] =
579 array( 'group' => array(), 'groupTitle' => array());
582 $contactGroup[$dao->contact_id
]['group'][] =
584 'id' => $dao->group_id
,
585 'title' => $dao->title
,
586 'description' => $dao->description
,
587 'children' => $dao->children
589 $contactGroup[$dao->contact_id
]['groupTitle'][] = $dao->title
;
592 if ($prevContactID) {
593 $contactGroup[$prevContactID]['groupTitle'] = implode(', ', $contactGroup[$prevContactID]['groupTitle']);
596 if (is_numeric($contactID)) {
597 return $contactGroup[$contactID];
600 return $contactGroup;