patashala/application/helpers/cache_helper.php

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

/**
 * Output Cache Helper
 *
 * Utility functions for working with CodeIgniter's output cache.
 * All code based on or directly copied from CodeIgniter.
 *
 * @category Helpers
 * @author   Steven Benner (http://stevenbenner.com/)
 * @link     https://github.com/stevenbenner/codeigniter-cache-helper
 * @license  MIT License
 * @version  1.4.2
 */

/**
 * Get Cache Folder
 *
 * Gets the path to the application cache folder.
 *
 * @return string Path to the cache folder.
 */
if ( ! function_exists('get_cache_folder'))
{
	function get_cache_folder()
	{
		$CI =& get_instance();

		$path = $CI->config->item('cache_path');
		$cache_path = ($path == '') ? APPPATH . 'cache/' : $path;

		return $cache_path;
	}
}

/**
 * Get Cache File
 *
 * Gets the path to a cache file for the specified uri_string().
 *
 * @param  string $uri_string Full uri_string() of the target page (e.g. 'blog/comments/123').
 * @return string Path to the cache file.
 */
if ( ! function_exists('get_cache_file'))
{
	function get_cache_file($uri_string)
	{
		$CI =& get_instance();

		$uri =  $CI->config->item('base_url') .
				$CI->config->item('index_page') .
				$uri_string;

		return get_cache_folder() . md5($uri);
	}
}

/**
 * Get All Cache Files
 *
 * Gets the path to every cache file currently saved.
 *
 * @return array get_dir_file_info() of cache files.
 */
if ( ! function_exists('get_all_cache_files'))
{
	function get_all_cache_files()
	{
		$CI =& get_instance();

		$CI->load->helper('file');

		return get_dir_file_info(get_cache_folder());
	}
}


/**
 * Delete Cache File
 *
 * Evicts the output cache for the targeted page.
 *
 * @param  string  $uri_string Full uri_string() of the target page (e.g. 'blog/comments/123').
 * @return boolean TRUE if the cache file was removed, FALSE if it was not.
 */
if ( ! function_exists('delete_cache'))
{
	function delete_cache($uri_string)
	{
		$cache_path = get_cache_file($uri_string);

		if (file_exists($cache_path))
		{
			return unlink($cache_path);
		}
		else
		{
			return TRUE;
		}
	}
}

/**
 * Delete All Cache
 *
 * Evicts the output cache for all pages currently cached.
 *
 * @return void
 */
if ( ! function_exists('delete_all_cache'))
{
	function delete_all_cache()
	{
		$cache_files = get_all_cache_files();

		foreach ($cache_files as $file)
		{
			// only delete files with names that are 32 characters in length (MD5)
			if (strlen($file['name']) === 32 && is_really_writable($file['server_path']))
			{
				@unlink($file['server_path']);
			}
		}
	}
}

/**
 * Delete Expired Cache
 *
 * Delete all expired cache files. This is a fairly expensive function so it
 * should not be called on every hit.
 *
 * @return void
 */
if ( ! function_exists('delete_expired_cache'))
{
	function delete_expired_cache()
	{
		$CI =& get_instance();

		$CI->load->helper('file');

		$files = get_dir_file_info(get_cache_folder());

		foreach ($files as $file)
		{
			if (strlen($file['name']) !== 32)
			{
				continue;
			}

			if ( ! $fp = @fopen($file['server_path'], FOPEN_READ))
			{
				continue;
			}

			flock($fp, LOCK_SH);

			$time_str = '';
			while (($char = fgetc($fp)) !== FALSE)
			{
				if ($char === 'T')
				{
					break;
				}
				$time_str .= $char;
			}

			flock($fp, LOCK_UN);
			fclose($fp);

			if (ctype_digit($time_str) && time() >= (int)$time_str)
			{
				if (is_really_writable($file['server_path']))
				{
					@unlink($file['server_path']);
				}
			}
		}
	}
}

/**
 * Get Cache Expiration
 *
 * Gets the expiration time for a cache file. Time strings are in time() format.
 *
 * @param  string $uri_string Full uri_string() of the target page.
 * @return mixed  Time from the cache file or FALSE if there was a problem.
 */
if ( ! function_exists('get_cache_expiration'))
{
	function get_cache_expiration($uri_string)
	{
		$cache_path = get_cache_file($uri_string);

		if ( ! @file_exists($cache_path))
		{
			return FALSE;
		}

		if ( ! $fp = @fopen($cache_path, FOPEN_READ))
		{
			return FALSE;
		}

		flock($fp, LOCK_SH);

		$time_str = '';
		while (($char = fgetc($fp)) !== FALSE)
		{
			if ($char === 'T')
			{
				break;
			}
			$time_str .= $char;
		}

		flock($fp, LOCK_UN);
		fclose($fp);

		if (ctype_digit($time_str))
		{
			return (int)$time_str;
		}
		else
		{
			return FALSE;
		}
	}
}

/* End of file cache_helper.php */
/* Location: ./application/helpers/cache_helper.php */