* Deletes all the cache entries.
*/
public static function resetCache() {
+ if (!CRM_Core_Config::isPermitCacheFlushMode()) {
+ return;
+ }
// reset any static caching
self::$_cache = NULL;
'name'
);
- if (!$config->doNotResetCache) {
- // Note: doNotResetCache flag is currently set by import contact process and merging,
- // since resetting and
- // rebuilding cache could be expensive (for many contacts). We might come out with better
- // approach in future.
- CRM_Contact_BAO_Contact_Utils::clearContactCaches($contact->id);
- }
+ CRM_Contact_BAO_Contact_Utils::clearContactCaches();
if ($invokeHooks) {
if ($isEdit) {
* caches, but are backing off from this with every release. Compromise between ease of coding versus
* performance versus being accurate at that very instant
*
- * @param $contactID
- * The contactID that was edited / deleted.
+ * @param bool $isEmptyPrevNextTable
+ * Should the civicrm_prev_next table be cleared of any contact entries.
+ * This is currently done from import but not other places and would
+ * likely affect user experience in unexpected ways. Existing behaviour retained
+ * ... reluctantly.
*/
- public static function clearContactCaches($contactID = NULL) {
- // clear acl cache if any.
- CRM_ACL_BAO_Cache::resetCache();
-
- if (empty($contactID)) {
- // also clear prev/next dedupe cache - if no contactID passed in
+ public static function clearContactCaches($isEmptyPrevNextTable = FALSE) {
+ if (!CRM_Core_Config::isPermitCacheFlushMode()) {
+ return;
+ }
+ if ($isEmptyPrevNextTable) {
CRM_Core_BAO_PrevNextCache::deleteItem();
}
-
+ // clear acl cache if any.
+ CRM_ACL_BAO_Cache::resetCache();
CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
}
list($numContactsAdded, $numContactsNotAdded)
= self::bulkAddContactsToGroup($contactIds, $groupId, $method, $status, $tracking);
- // also reset the acl cache
- $config = CRM_Core_Config::singleton();
- if (!$config->doNotResetCache) {
- CRM_ACL_BAO_Cache::resetCache();
- }
-
- // reset the group contact cache for all group(s)
- // if this group is being used as a smart group
- CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
+ CRM_Contact_BAO_Contact_Utils::clearContactCaches();
CRM_Utils_Hook::post('create', 'GroupContact', $groupId, $contactIds);
}
}
- // also reset the acl cache
- $config = CRM_Core_Config::singleton();
- if (!$config->doNotResetCache) {
- CRM_ACL_BAO_Cache::resetCache();
- }
-
- // reset the group contact cache for all group(s)
- // if this group is being used as a smart group
- // @todo consider what to do here - it feels like we should either
- // 1) just invalidate the specific group's cache(& perhaps any parents) & let cron do it's thing or
- // possibly clear this specific groups cache, or just call opportunisticCacheFlush() - which would have the
- // same effect as the remove call. The reservation about that is that it is no more aggressive for the group that
- // we know is altered than for all the others, or perhaps, more the point with it's parents & groups that use it in
- // their criteria.
- CRM_Contact_BAO_GroupContactCache::remove();
+ CRM_Contact_BAO_Contact_Utils::clearContactCaches();
CRM_Utils_Hook::post($op, 'GroupContact', $groupId, $contactIds);
* In fact it turned out there is little overlap between the code when group is passed in
* and group is not so it makes more sense as separate functions.
*
- * @todo remove last call to this function from outside the class then make function protected,
- * enforce groupID as an array & remove non group handling.
+ * @todo enforce groupID as an array & remove non group handling.
+ * Use flushCaches when no group id provided.
*
* @param int $groupIDs
* the groupID to delete cache entries, NULL for all groups.
* run the function exactly once for all groups.
*/
public static function remove($groupIDs = NULL, $onceOnly = TRUE) {
- static $invoked = FALSE;
+ if (!is_array($groupIDs)) {
+ Civi::log()
+ ->warning('Deprecated code. This function should not be called without groupIDs. Extensions can use the api job.group_cache_flush', array('civi.tag' => 'deprecated'));
+ return;
+ }
+ if (!isset(Civi::$statics[__CLASS__]['remove_invoked'])) {
+ Civi::$statics[__CLASS__] = array('remove_invoked' => FALSE);
+ }
// typically this needs to happy only once per instance
// this is especially TRUE in import, where we don't need
// i.e. cache is reset for all groups
if (
$onceOnly &&
- $invoked &&
+ Civi::$statics[__CLASS__]['remove_invoked'] &&
$groupIDs == NULL
) {
return;
}
if ($groupIDs == NULL) {
- $invoked = TRUE;
+ Civi::$statics[__CLASS__]['remove_invoked'] = TRUE;
}
elseif (is_array($groupIDs)) {
foreach ($groupIDs as $gid) {
* @throws \CRM_Core_Exception
*/
protected static function getLockForRefresh() {
- if (!isset(Civi::$statics[__CLASS__])) {
+ if (!isset(Civi::$statics[__CLASS__]['is_refresh_init'])) {
Civi::$statics[__CLASS__] = array('is_refresh_init' => FALSE);
}
// get user info of main contact.
$config = CRM_Core_Config::singleton();
- $config->doNotResetCache = 1;
+ CRM_Core_Config::setPermitCacheFlushMode(FALSE);
$mainUfId = CRM_Core_BAO_UFMatch::getUFId($this->_cid);
$mainUser = NULL;
// Clear all caches, forcing any searches to recheck the ACLs or group membership as the import
// may have changed it.
- CRM_Contact_BAO_Contact_Utils::clearContactCaches();
+ CRM_Contact_BAO_Contact_Utils::clearContactCaches(TRUE);
// add all the necessary variables to the form
$importJob->setFormVariables($this);
$this->formatParams($formatted, $onDuplicate, (int) $contactId);
}
- // pass doNotResetCache flag since resetting and rebuilding cache could be expensive.
- $config = CRM_Core_Config::singleton();
- $config->doNotResetCache = 1;
+ // Resetting and rebuilding cache could be expensive.
+ CRM_Core_Config::setPermitCacheFlushMode(FALSE);
$cid = CRM_Contact_BAO_Contact::createProfileContact($formatted, $contactFields, $contactId, NULL, NULL, $formatted['contact_type']);
- $config->doNotResetCache = 0;
+ CRM_Core_Config::setPermitCacheFlushMode(TRUE);
$contact = array(
'contact_id' => $cid,
Civi::settings()->set('installed', 1);
}
+ /**
+ * Is the system permitted to flush caches at the moment.
+ */
+ static public function isPermitCacheFlushMode() {
+ return !CRM_Core_Config::singleton()->doNotResetCache;
+ }
+
+ /**
+ * Set cache clearing to enabled or disabled.
+ *
+ * This might be enabled at the start of a long running process
+ * such as an import in order to delay clearing caches until the end.
+ *
+ * @param bool $enabled
+ * If true then caches can be cleared at this time.
+ */
+ static public function setPermitCacheFlushMode($enabled) {
+ CRM_Core_Config::singleton()->doNotResetCache = $enabled ? 0 : 1;
+ }
+
}
$resultStats = array('merged' => array(), 'skipped' => array());
// we don't want dupe caching to get reset after every-merge, and therefore set the
- // doNotResetCache flag
- $config = CRM_Core_Config::singleton();
- $config->doNotResetCache = 1;
+ CRM_Core_Config::setPermitCacheFlushMode(FALSE);
$deletedContacts = array();
while (!empty($dupePairs)) {
public function callApi() {
require_once 'api/api.php';
+ CRM_Core_Config::setPermitCacheFlushMode(FALSE);
// CRM-9822 -'execute' action always goes thru Job api and always writes to log
if ($this->_action != 'execute' && $this->_joblog) {
require_once 'CRM/Core/JobManager.php';
$this->_params['auth'] = FALSE;
$result = civicrm_api($this->_entity, $this->_action, $this->_params);
}
+ CRM_Core_Config::setPermitCacheFlushMode(TRUE);
+ CRM_Contact_BAO_Contact_Utils::clearContactCaches();
if (!empty($result['is_error'])) {
$this->_log($result['error_message']);
$this->callAPISuccess('GroupContact', 'create', array('group_id' => $groupID, 'contact_id' => $householdID, 'status' => 'Added'));
// Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
- CRM_Contact_BAO_GroupContactCache::remove($groupID, FALSE);
+ CRM_Contact_BAO_GroupContactCache::clearGroupContactCache($groupID);
$sql = CRM_Contact_BAO_Query::getQuery(
array(array('group', 'IN', array($groupID), 0, 0)),
'civicrm_acl_contact_cache',
'civicrm_activity_contact',
'civicrm_activity',
+ 'civicrm_group',
+ 'civicrm_group_contact',
+ 'civicrm_saved_search',
+ 'civicrm_group_contact_cache',
);
$this->quickCleanup($tablesToTruncate, TRUE);
// Rinse & repeat, but with the option.
$this->putGroupContactCacheInClearableState($groupID, $contact);
- $this->callAPISuccess('contact', 'create', array('id' => $contact['id'], 'options' => array('do_not_reset_cache' => 1)));
+ CRM_Core_Config::setPermitCacheFlushMode(FALSE);
+ $this->callAPISuccess('contact', 'create', array('id' => $contact['id']));
$this->assertEquals(1, CRM_Core_DAO::singleValueQuery("SELECT count(*) FROM civicrm_group_contact_cache"));
+ CRM_Core_Config::setPermitCacheFlushMode(TRUE);
}
/**
*/
public function tearDown() {
$this->quickCleanUpFinancialEntities();
- $this->quickCleanup(array('civicrm_group', 'civicrm_saved_search', 'civicrm_group_contact'));
+ $this->quickCleanup(array('civicrm_group', 'civicrm_saved_search', 'civicrm_group_contact', 'civicrm_group_contact_cache', 'civicrm_group'));
parent::tearDown();
}
$result = $this->callAPIAndDocument('report_template', 'getrows', array(
'report_id' => 'contact/summary',
'options' => array('metadata' => array('labels', 'title')),
- ), __FUNCTION__, __FILE__, $description, 'Getrows', 'getrows');
+ ), __FUNCTION__, __FILE__, $description, 'Getrows');
$this->assertEquals('Contact Name', $result['metadata']['labels']['civicrm_contact_sort_name']);
//the second part of this test has been commented out because it relied on the db being reset to
}
// Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
- CRM_Contact_BAO_GroupContactCache::remove($groupID, FALSE);
+ CRM_Contact_BAO_GroupContactCache::clearGroupContactCache($groupID);
return $groupID;
}
}
// Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
- CRM_Contact_BAO_GroupContactCache::remove($groupID, FALSE);
+ CRM_Contact_BAO_GroupContactCache::clearGroupContactCache($groupID);
if ($returnAddedContact) {
return array($groupID, $individualID);
projects / civicrm-core.git / commitdiff