Permalink
Browse files

MDL-36363 cache: clean up pre-integration

  • Loading branch information...
1 parent 86afa1d commit a50cdcc0fd8dd0de34220b78d21532408691f3c0 Sam Hemelryk committed Jan 24, 2013
View
@@ -136,15 +136,6 @@ public static function initialise_test_instance(cache_definition $definition);
abstract public function __construct($name, array $configuration = array());
/**
- * Performs any necessary operation when the store instance has been created.
- *
- * @link http://tracker.moodle.org/browse/MDL-36363
- */
- public function instance_created() {
- // By default, do nothing.
- }
-
- /**
* Returns the name of this store instance.
* @return string
*/
@@ -235,23 +226,35 @@ public function instance_created() {
/**
* Performs any necessary clean up when the store instance is being deleted.
*
- * Please note that if the store has been already initialised with
- * a definition ({@link initialise()}), cleanup will be performed against the scope
- * of that definition i.e. the result depends on the specific store implementation.
+ * @deprecated since 2.5
+ */
+ public function cleanup() {
+ debugging('This function has been renamed to instance_deleted. Please update your calls.', DEBUG_DEVELOPER);
+ }
+
+ /**
+ * Performs any necessary operation when the store instance has been created.
*
- * @see instance_deleted()
+ * @since 2.5
*/
- abstract public function cleanup();
+ public function instance_created() {
+ // By default, do nothing.
+ }
/**
- * Performs any necessary operation when the store instance is being deleted,
- * regardless the store being initialised with a definition ({@link initialise()}).
+ * Performs any necessary operation when the store instance is being deleted.
+ *
+ * This method may be called before the store has been initialised.
*
- * @link http://tracker.moodle.org/browse/MDL-36363
+ * @since 2.5
* @see cleanup()
*/
public function instance_deleted() {
- // By default, do nothing
+ if (method_exists($this, 'cleanup')) {
+ // There used to be a legacy function called cleanup, it was renamed to instance delete.
+ // To be removed in 2.6.
+ $this->cleanup();
+ }
}
/**
View
@@ -308,6 +308,7 @@ public function delete_store_instance($name) {
throw new cache_exception('You cannot delete a cache store that has definition mappings.');
}
}
+
// Call instance_deleted()
$class = 'cachestore_'.$this->configstores[$name]['plugin'];
$store = new $class($name, $this->configstores[$name]['configuration']);
View
@@ -46,16 +46,16 @@ class cachestore_file extends cache_store implements cache_is_key_aware, cache_i
protected $name;
/**
- * The path to use for the file storage. False otherwise.
+ * The path used to store files for this store and the definition it was initialised with.
* @var string
*/
- protected $filestorepath = false;
+ protected $path = false;
/**
- * The path to use when the store instance has been initialised. False otherwise.
+ * The path in which definition specific sub directories will be created for caching.
* @var string
*/
- protected $path = false;
+ protected $filestorepath = false;
/**
* Set to true when a prescan has been performed.
@@ -136,6 +136,7 @@ public function __construct($name, array $configuration = array()) {
}
$this->isready = $path !== false;
$this->filestorepath = $path;
+ // This will be updated once the store has been initialised for a definition.
$this->path = $path;
// Check if we should prescan the directory.
@@ -517,7 +518,6 @@ public function purge() {
}
$this->keys = array();
}
-
return true;
}
@@ -609,22 +609,9 @@ protected function ensure_path_exists() {
* 1. Purges the cache directory.
* 2. Deletes the directory we created for the given definition.
*/
- public function cleanup() {
- $this->purge();
- @rmdir($this->path);
- }
-
- /**
- * Performs any necessary operation when the file store instance is being deleted,
- * regardless the file store being initialised with a definition ({@link initialise()}).
- *
- * @see cleanup()
- */
public function instance_deleted() {
- if ($this->isready && !$this->prescan) {
- // Remove the content related to this file store.
- $this->purge_all_definitions();
- }
+ $this->purge_all_definitions();
+ @rmdir($this->filestorepath);
}
/**
@@ -319,19 +319,18 @@ public static function config_set_edit_form_data(moodleform $editform, array $co
/**
* Performs any necessary clean up when the store instance is being deleted.
*/
- public function cleanup() {
- $this->purge();
- }
-
- /**
- * Performs any necessary operation when the store instance is being deleted,
- * regardless the store being initialised with a definition ({@link initialise()}).
- *
- * @link http://tracker.moodle.org/browse/MDL-36363
- * @see cleanup()
- */
public function instance_deleted() {
- $this->cleanup();
+ if ($this->connection) {
+ $connection = $this->connection;
+ } else {
+ $connection = new Memcache;
+ foreach ($this->servers as $server) {
+ $connection->addServer($server[0], $server[1], true, $server[2]);
+ }
+ }
+ $connection->flush();
+ unset($connection);
+ unset($this->connection);
}
/**
@@ -401,19 +401,22 @@ public static function config_set_edit_form_data(moodleform $editform, array $co
/**
* Performs any necessary clean up when the store instance is being deleted.
*/
- public function cleanup() {
- $this->purge();
- }
-
- /**
- * Performs any necessary operation when the store instance is being deleted,
- * regardless the store being initialised with a definition ({@link initialise()}).
- *
- * @link http://tracker.moodle.org/browse/MDL-36363
- * @see cleanup()
- */
public function instance_deleted() {
- $this->cleanup();
+ if ($this->connection) {
+ $connection = $this->connection;
+ } else {
+ $connection = new Memcached(crc32($this->name));
+ $servers = $connection->getServerList();
+ if (empty($servers)) {
+ foreach ($this->options as $key => $value) {
+ $connection->setOption($key, $value);
+ }
+ $connection->addServers($this->servers);
+ }
+ }
+ $connection->flush();
+ unset($connection);
+ unset($this->connection);
}
/**
@@ -67,7 +67,7 @@ class cachestore_mongodb extends cache_store implements cache_is_configurable {
* The Connection object
* @var Mongo
*/
- protected $connection;
+ protected $connection = false;
/**
* The Database Object
@@ -439,19 +439,22 @@ public static function config_set_edit_form_data(moodleform $editform, array $co
/**
* Performs any necessary clean up when the store instance is being deleted.
*/
- public function cleanup() {
- $this->purge();
- }
-
- /**
- * Performs any necessary operation when the store instance is being deleted,
- * regardless the store being initialised with a definition ({@link initialise()}).
- *
- * @link http://tracker.moodle.org/browse/MDL-36363
- * @see cleanup()
- */
public function instance_deleted() {
- $this->cleanup();
+ // We can't use purge here that acts upon a collection.
+ // Instead we must drop the named database.
+ if ($this->connection) {
+ $connection = $this->connection;
+ } else {
+ $connection = new Mongo($this->server, $this->options);
+ }
+ $database = $connection->selectDB($this->databasename);
+ $database->drop();
+ $connection = null;
+ $database = null;
+ // Explicitly unset things to cause a close.
+ $this->collection = null;
+ $this->database = null;
+ $this->connection = null;
}
/**
@@ -375,19 +375,8 @@ public static function can_add_instance() {
/**
* Performs any necessary clean up when the store instance is being deleted.
*/
- public function cleanup() {
- $this->purge();
- }
-
- /**
- * Performs any necessary operation when the store instance is being deleted,
- * regardless the store being initialised with a definition ({@link initialise()}).
- *
- * @link http://tracker.moodle.org/browse/MDL-36363
- * @see cleanup()
- */
public function instance_deleted() {
- $this->cleanup();
+ $this->purge();
}
/**
@@ -372,19 +372,8 @@ public static function can_add_instance() {
/**
* Performs any necessary clean up when the store instance is being deleted.
*/
- public function cleanup() {
- $this->purge();
- }
-
- /**
- * Performs any necessary operation when the store instance is being deleted,
- * regardless the store being initialised with a definition ({@link initialise()}).
- *
- * @link http://tracker.moodle.org/browse/MDL-36363
- * @see cleanup()
- */
public function instance_deleted() {
- $this->cleanup();
+ $this->purge();
}
/**
@@ -100,7 +100,7 @@
}
$result[5] = sprintf('%01.4f', microtime(true) - $start);
$applicationtable->data[] = $result;
- $store->cleanup();
+ $store->instance_deleted();
}
}
@@ -136,7 +136,7 @@
}
$result[5] = sprintf('%01.4f', microtime(true) - $start);
$sessiontable->data[] = $result;
- $store->cleanup();
+ $store->instance_deleted();
}
}
@@ -172,7 +172,7 @@
}
$result[5] = sprintf('%01.4f', microtime(true) - $start);
$requesttable->data[] = $result;
- $store->cleanup();
+ $store->instance_deleted();
}
}
View
@@ -0,0 +1,8 @@
+This files describes API changes in /cache/stores/* - cache store plugins.
+Information provided here is intended especially for developers.
+
+=== 2.5 ===
+* cleanup method renamed to instance_deleted.
+ It is now called when the store is deleted as all comments suggested anyway.
+* instance_created method added.
+ It is called when the store is created for the very first time.

0 comments on commit a50cdcc

Please sign in to comment.