Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

MDL-37683 cache: siteidentifier is now included in the keys

  • Loading branch information...
commit e0d9b7c0d42a66dfc95a6be5b86cfa53b1e9f57b 1 parent 1dd6835
@samhemelryk samhemelryk authored
View
20 cache/classes/config.php
@@ -72,6 +72,12 @@ class cache_config {
protected $configlocks = array();
/**
+ * The site identifier used when the cache config was last saved.
+ * @var string
+ */
+ protected $siteidentifier = null;
+
+ /**
* Please use cache_config::instance to get an instance of the cache config that is ready to be used.
*/
public function __construct() {
@@ -139,6 +145,12 @@ public function load($configuration = false) {
$this->configdefinitionmappings = array();
$this->configlockmappings = array();
+ $siteidentifier = 'unknown';
+ if (array_key_exists('siteidentifier', $configuration)) {
+ $siteidentifier = $configuration['siteidentifier'];
+ }
+ $this->siteidentifier = $siteidentifier;
+
// Filter the lock instances.
$defaultlock = null;
foreach ($configuration['locks'] as $conf) {
@@ -272,6 +284,14 @@ public function load($configuration = false) {
}
/**
+ * Returns the site identifier used by the cache API.
+ * @return string
+ */
+ public function get_site_identifier() {
+ return $this->siteidentifier;
+ }
+
+ /**
* Includes the configuration file and makes sure it contains the expected bits.
*
* You need to ensure that the config file exists before this is called.
View
19 cache/classes/definition.php
@@ -275,6 +275,12 @@ class cache_definition {
protected $definitionhash = null;
/**
+ * An identifier to make cache keys predictably unique.
+ * @var string
+ */
+ protected $cacheidentifier = '0';
+
+ /**
* Creates a cache definition given a definition from the cache configuration or from a caches.php file.
*
* @param string $id
@@ -675,6 +681,15 @@ public function set_identifiers(array $identifiers = array()) {
}
/**
+ * Sets an identifier for the cache.
+ * This can be used
+ * @param string $identifier
+ */
+ public function set_cache_identifier($identifier) {
+ $this->cacheidentifier = (string)$identifier;
+ }
+
+ /**
* Returns the requirements of this definition as a binary flag.
* @return int
*/
@@ -723,7 +738,8 @@ public function generate_definition_hash() {
*/
public function generate_single_key_prefix() {
if ($this->keyprefixsingle === null) {
- $this->keyprefixsingle = $this->mode.'/'.$this->mode;
+ $this->keyprefixsingle = $this->mode.'/'.$this->component.'/'.$this->area;
+ $this->keyprefixsingle .= '/'.$this->cacheidentifier;
$identifiers = $this->get_identifiers();
if ($identifiers) {
foreach ($identifiers as $key => $value) {
@@ -746,6 +762,7 @@ public function generate_multi_key_parts() {
'mode' => $this->mode,
'component' => $this->component,
'area' => $this->area,
+ 'siteidentifier' => $this->cacheidentifier
);
if (!empty($this->identifiers)) {
$identifiers = array();
View
3  cache/classes/factory.php
@@ -203,6 +203,8 @@ public function create_cache_from_params($mode, $component, $area, array $identi
}
// Get the class. Note this is a late static binding so we need to use get_called_class.
$definition = cache_definition::load_adhoc($mode, $component, $area, $options);
+ $config = $this->create_config_instance();
+ $definition->set_cache_identifier($config->get_site_identifier());
$definition->set_identifiers($identifiers);
$cache = $this->create_cache($definition, $identifiers);
if ($definition->should_be_persistent()) {
@@ -390,6 +392,7 @@ public function create_definition($component, $area, $aggregate = null) {
} else {
$definition = cache_definition::load($id, $definition, $aggregate);
}
+ $definition->set_cache_identifier($instance->get_site_identifier());
}
$this->definitions[$id] = $definition;
}
View
19 cache/classes/helper.php
@@ -234,6 +234,7 @@ public static function invalidate_by_event($event, array $keys) {
$factory = cache_factory::instance();
foreach ($instance->get_definitions() as $name => $definitionarr) {
$definition = cache_definition::load($name, $definitionarr);
+ $definition->set_cache_identifier($instance->get_site_identifier());
if ($definition->invalidates_on_event($event)) {
// OK at this point we know that the definition has information to invalidate on the event.
// There are two routes, either its an application cache in which case we can invalidate it now.
@@ -304,6 +305,7 @@ public static function purge_by_event($event) {
$factory = cache_factory::instance();
foreach ($instance->get_definitions() as $name => $definitionarr) {
$definition = cache_definition::load($name, $definitionarr);
+ $definition->set_cache_identifier($instance->get_site_identifier());
if ($definition->invalidates_on_event($event)) {
// Create the cache.
$cache = $factory->create_cache($definition);
@@ -496,4 +498,21 @@ public static function update_definitions($coreonly = false) {
// Second reset anything we have already initialised to ensure we're all up to date.
cache_factory::reset();
}
+
+ /**
+ * Update the site identifier stored by the cache API.
+ *
+ * @param string $siteidentifier
+ */
+ public static function update_site_identifier($siteidentifier) {
+ global $CFG;
+ // Include locallib
+ require_once($CFG->dirroot.'/cache/locallib.php');
+ $factory = cache_factory::instance();
+ $factory->updating_started();
+ $config = $factory->create_config_instance(true);
+ $config->update_site_identifier($siteidentifier);
+ $factory->updating_finished();
+ cache_factory::reset();
+ }
}
View
10 cache/locallib.php
@@ -119,6 +119,7 @@ protected function config_save() {
*/
protected function generate_configuration_array() {
$configuration = array();
+ $configuration['siteidentifier'] = $this->siteidentifier;;
$configuration['stores'] = $this->configstores;
$configuration['modemappings'] = $this->configmodemappings;
$configuration['definitions'] = $this->configdefinitions;
@@ -524,6 +525,15 @@ public function set_definition_mappings($definition, $mappings) {
$this->config_save();
}
+ /**
+ * Update the site identifier stored by the cache API.
+ *
+ * @param string $siteidentifier
+ */
+ public function update_site_identifier($siteidentifier) {
+ $this->siteidentifier = md5((string)$siteidentifier);
+ $this->config_save();
+ }
}
/**
View
13 cache/tests/cache_test.php
@@ -553,6 +553,8 @@ public function test_distributed_application_event_invalidation() {
'mode' => cache_store::MODE_APPLICATION,
'component' => 'phpunit',
'area' => 'eventinvalidationtest',
+ 'simplekeys' => true,
+ 'simpledata' => true,
'invalidationevents' => array(
'crazyevent'
)
@@ -567,13 +569,16 @@ public function test_distributed_application_event_invalidation() {
// OK data added, data invalidated, and invalidation time has been set.
// Now we need to manually add back the data and adjust the invalidation time.
- $timefile = $CFG->dataroot.'/cache/cachestore_file/default_application/phpunit_eventinvalidationtest/a65/a65b1dc524cf6e03c1795197c84d5231eb229b86.cache';
+ $hash = md5(cache_store::MODE_APPLICATION.'/phpunit/eventinvalidationtest/'.$CFG->wwwroot.'phpunit');
+ $timefile = $CFG->dataroot."/cache/cachestore_file/default_application/phpunit_eventinvalidationtest/las/lastinvalidation-$hash.cache";
+ // Make sure the file is correct.
+ $this->assertTrue(file_exists($timefile));
$timecont = serialize(cache::now() - 60); // Back 60sec in the past to force it to re-invalidate.
make_writable_directory(dirname($timefile));
file_put_contents($timefile, $timecont);
$this->assertTrue(file_exists($timefile));
- $datafile = $CFG->dataroot.'/cache/cachestore_file/default_application/phpunit_eventinvalidationtest/626/626e9c7a45febd98f064c2b383de8d9d4ebbde7b.cache';
+ $datafile = $CFG->dataroot."/cache/cachestore_file/default_application/phpunit_eventinvalidationtest/tes/testkey1-$hash.cache";
$datacont = serialize("test data 1");
make_writable_directory(dirname($datafile));
file_put_contents($datafile, $datacont);
@@ -586,6 +591,8 @@ public function test_distributed_application_event_invalidation() {
'mode' => cache_store::MODE_APPLICATION,
'component' => 'phpunit',
'area' => 'eventinvalidationtest',
+ 'simplekeys' => true,
+ 'simpledata' => true,
));
$cache = cache::make('phpunit', 'eventinvalidationtest');
$this->assertEquals('test data 1', $cache->get('testkey1'));
@@ -597,6 +604,8 @@ public function test_distributed_application_event_invalidation() {
'mode' => cache_store::MODE_APPLICATION,
'component' => 'phpunit',
'area' => 'eventinvalidationtest',
+ 'simplekeys' => true,
+ 'simpledata' => true,
'invalidationevents' => array(
'crazyevent'
)
View
10 cache/tests/fixtures/lib.php
@@ -102,6 +102,16 @@ public function phpunit_add_definition_mapping($definition, $store, $sort) {
'sort' => (int)$sort
);
}
+
+ /**
+ * Overrides the default site identifier used by the Cache API so that we can be sure of what it is.
+ *
+ * @return string
+ */
+ public function get_site_identifier() {
+ global $CFG;
+ return $CFG->wwwroot.'phpunit';
+ }
}
/**
View
10 lib/db/upgrade.php
@@ -1577,5 +1577,15 @@ function xmldb_main_upgrade($oldversion) {
upgrade_main_savepoint(true, 2013021100.01);
}
+ if ($oldversion < 2013021800.00) {
+ // Add the site identifier to the cache config's file.
+ $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
+ cache_helper::update_site_identifier($siteidentifier);
+
+ // Main savepoint reached.
+ upgrade_main_savepoint(true, 2013021800.00);
+ }
+
+
return true;
}
View
35 lib/moodlelib.php
@@ -1327,6 +1327,9 @@ function set_config($name, $value, $plugin=NULL) {
$DB->insert_record('config', $config, false);
}
}
+ if ($name === 'siteidentifier') {
+ cache_helper::update_site_identifier($value);
+ }
cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
} else { // plugin scope
if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
@@ -1360,6 +1363,8 @@ function set_config($name, $value, $plugin=NULL) {
* If called with 2 parameters it will return a string single
* value or false if the value is not found.
*
+ * @static $siteidentifier The site identifier is not cached. We use this static cache so
+ * that we need only fetch it once per request.
* @param string $plugin full component name
* @param string $name default NULL
* @return mixed hash-like object or single value, return false no config found
@@ -1367,6 +1372,8 @@ function set_config($name, $value, $plugin=NULL) {
function get_config($plugin, $name = NULL) {
global $CFG, $DB;
+ static $siteidentifier = null;
+
if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
$forced =& $CFG->config_php_settings;
$iscore = true;
@@ -1380,8 +1387,28 @@ function get_config($plugin, $name = NULL) {
$iscore = false;
}
- if (!empty($name) && array_key_exists($name, $forced)) {
- return (string)$forced[$name];
+ if ($siteidentifier === null) {
+ try {
+ // This may fail during installation.
+ // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
+ // install the database.
+ $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
+ } catch (dml_exception $ex) {
+ // It's failed. We'll use this oppertunity to disable cache stores so that we don't inadvertingly start using
+ // old caches. People should delete there moodledata dirs when reinstalling the database... but they don't.
+ cache_factory::disable_stores();
+ // Set siteidentifier to false. We don't want to trip this continually.
+ $siteidentifier = false;
+ throw $ex;
+ }
+ }
+
+ if (!empty($name)) {
+ if (array_key_exists($name, $forced)) {
+ return (string)$forced[$name];
+ } else if ($name === 'siteidentifier' && $plugin == 'core') {
+ return $siteidentifier;
+ }
}
$cache = cache::make('core', 'config');
@@ -1405,6 +1432,10 @@ function get_config($plugin, $name = NULL) {
return false;
}
+ if ($plugin === 'core') {
+ $result['siteidentifier'] = $siteidentifier;
+ }
+
foreach ($forced as $key => $value) {
if (is_null($value) or is_array($value) or is_object($value)) {
// we do not want any extra mess here, just real settings that could be saved in db
View
11 lib/upgradelib.php
@@ -1448,8 +1448,9 @@ function install_core($version, $verbose) {
print_upgrade_part_end(null, true, $verbose);
- // Reset the cache, this returns it to a normal operation state.
- cache_factory::reset();
+ // Purge all caches. They're disabled but this ensures that we don't have any persistent data just in case something
+ // during installation didn't use APIs.
+ cache_helper::purge_all();
} catch (exception $ex) {
upgrade_handle_exception($ex);
}
@@ -1536,8 +1537,8 @@ function upgrade_noncore($verbose) {
// upgrade all plugins types
try {
- // Disable the use of cache stores here. We will reset the factory after we've performed the installation.
- // This ensures that we don't permanently cache anything during installation.
+ // Disable the use of cache stores here.
+ // We don't reset this, the site can live without proper caching for life of this request.
cache_factory::disable_stores();
$plugintypes = get_plugin_types();
@@ -1546,8 +1547,6 @@ function upgrade_noncore($verbose) {
}
// Update cache definitions. Involves scanning each plugin for any changes.
cache_helper::update_definitions();
- // Reset the cache system to a normal state.
- cache_factory::reset();
} catch (Exception $ex) {
upgrade_handle_exception($ex);
}
View
2  version.php
@@ -30,7 +30,7 @@
defined('MOODLE_INTERNAL') || die();
-$version = 2013021400.00; // YYYYMMDD = weekly release date of this DEV branch
+$version = 2013021800.00; // YYYYMMDD = weekly release date of this DEV branch
// RR = release increments - 00 in DEV branches
// .XX = incremental changes
Please sign in to comment.
Something went wrong with that request. Please try again.