From 346de0e3843d55a8deb338ab3bf91f3ea4331214 Mon Sep 17 00:00:00 2001
From: Woody Gilk <woody.gilk@kohanaphp.com>
Date: Tue, 9 Dec 2008 11:03:20 -0600
Subject: [PATCH] Added Kohana::cache and implemented caching for
 Kohana::find_file

---
 system/classes/kohana.php | 84 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 78 insertions(+), 6 deletions(-)

diff --git a/system/classes/kohana.php b/system/classes/kohana.php
index e9fb06b..f729927 100644
--- a/system/classes/kohana.php
+++ b/system/classes/kohana.php
@@ -32,7 +32,7 @@ final class Kohana {
 	private static $include_paths = array(APPPATH, SYSPATH);
 
 	// Cache for resource location
-	private static $cache = array();
+	private static $file_path;
 
 	/**
 	 * Initializes the environment:
@@ -51,6 +51,9 @@ final class Kohana {
 		// Enable auto-loading of classes
 		spl_autoload_register(array(__CLASS__, 'auto_load'));
 
+		// Load the file path cache
+		self::$file_path = Kohana::cache('kohana_file_paths');
+
 		if (PHP_SAPI === 'cli')
 		{
 			// The current instance is being run via the command line
@@ -65,6 +68,7 @@ final class Kohana {
 			}
 		}
 
+		/*
 		if ($hooks = self::find_file('hooks'))
 		{
 			foreach ($hooks as $hook)
@@ -73,11 +77,25 @@ final class Kohana {
 				require $hook;
 			}
 		}
+		*/
+
 
 		// The system has been initialized
 		self::$init = TRUE;
 	}
 
+	/**
+	 * The last method before Kohana stops processing the request:
+	 *
+	 * - Saves the file path cache
+	 *
+	 * @return  void
+	 */
+	public function shutdown()
+	{
+		Kohana::cache('kohana_file_paths', self::$file_path);
+	}
+
 	/**
 	 * Finds the path of a file by directory, filename, and extension.
 	 * If no extension is give, the default EXT extension will be used.
@@ -102,10 +120,10 @@ final class Kohana {
 		// Create a partial path of the filename
 		$file = $dir.'/'.$file.$ext;
 
-		if (isset(self::$cache[__FUNCTION__][$file]))
+		if (isset(self::$file_path[$file]))
 		{
 			// The path to this file has already been found
-			return self::$cache[__FUNCTION__][$file];
+			return self::$file_path[$file];
 		}
 
 		foreach (self::$include_paths as $path)
@@ -113,7 +131,7 @@ final class Kohana {
 			if (file_exists($path.$file))
 			{
 				// Cache and return the path to this file
-				return self::$cache[__FUNCTION__][$file] = $path.$file;
+				return self::$file_path[$file] = $path.$file;
 			}
 		}
 
@@ -122,9 +140,9 @@ final class Kohana {
 
 	/**
 	 * Loads a file within a totally empty scope and returns the output:
-	 * 
+	 *
 	 *     $foo = Kohana::load_file('foo.php');
-	 * 
+	 *
 	 * @param   string
 	 * @return  mixed
 	 */
@@ -190,6 +208,60 @@ final class Kohana {
 		return TRUE;
 	}
 
+	/**
+	 * Provides simple file-based caching. All caches are serialized and
+	 * stored as a hash.
+	 *
+	 *     // Set the "foo" cache
+	 *     Kohana::cache('foo', 'hello, world');
+	 *
+	 *     // Get the "foo" cache
+	 *     $foo = Kohana::cache('foo');
+	 *
+	 * @param   string   name of the cache
+	 * @param   mixed    data to cache
+	 * @param   integer  number of seconds the cache is valid for
+	 * @return  mixed    for getting
+	 * @return  boolean  for setting
+	 */
+	public function cache($name, $data = NULL, $lifetime = 60)
+	{
+		// Cache file is a hash of the name
+		$file = sha1($name);
+
+		// Cache directories are split by keys
+		$dir = APPPATH.'cache/'.$file[0].'/';
+
+		if ($data === NULL)
+		{
+			if (is_file($dir.$file))
+			{
+				if ((time() - filemtime($dir.$file)) < $lifetime)
+				{
+					// Return the cache
+					return unserialize(file_get_contents($dir.$file));
+				}
+				else
+				{
+					// Cache has expired
+					unlink($dir.$file);
+				}
+			}
+
+			// Cache not found
+			return NULL;
+		}
+
+		if ( ! is_dir($dir))
+		{
+			// Create the cache directory
+			mkdir($dir, 0777);
+		}
+
+		// Serialize the data and create the cache
+		return (bool) file_put_contents($dir.$file, serialize($data));
+	}
+
 	/**
 	 * Returns an HTML string of debugging information about any number of
 	 * variables, each wrapped in a <pre> tag: