phpBB/includes/acm/acm_file.php

   1 <?php
   2 /**
   3 *
   4 * @package acm
   5 * @version $Id$
   6 * @copyright (c) 2005 phpBB Group
   7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
   8 *
   9 */
  10
  11 /**
  12 * @ignore
  13 */
  14 if (!defined('IN_PHPBB'))
  15 {
  16         exit;
  17 }
  18
  19 /**
  20 * Define file-based cache.
  21 * @package acm
  22 */
  23 class phpbb_acm_file extends phpbb_acm_abstract
  24 {
  25         /**
  26         * @var string The cache directory to use
  27         */
  28         public $cache_dir = '';
  29
  30         /**
  31         * @var array|bool The cache types this class supports. True indicates support for all types.
  32         */
  33         public $supported = true;
  34
  35         /**
  36         * Set cache directory
  37         *
  38         * @param string $cache_prefix   The cache prefix the instance is responsible for
  39         * @access public
  40         */
  41         public function __construct($cache_prefix)
  42         {
  43                 $this->cache_dir = PHPBB_ROOT_PATH . 'cache/';
  44                 $this->cache_prefix = $cache_prefix;
  45         }
  46
  47         /**
  48         * {@link phpbb_acm_abstract::get() get()}
  49         */
  50         public function get($var_name)
  51         {
  52                 if ($var_name[0] === '#')
  53                 {
  54                         $var_name = substr($var_name, 1);
  55                         return $this->get_global($var_name);
  56                 }
  57
  58                 if (!$this->exists($var_name))
  59                 {
  60                         return false;
  61                 }
  62
  63                 @include($this->cache_dir . $this->cache_prefix . '_' . $var_name . '.' . PHP_EXT);
  64
  65                 // If no data there, then the file expired...
  66                 if ($expired)
  67                 {
  68                         // Destroy
  69                         $this->destroy($var_name);
  70                         return false;
  71                 }
  72
  73                 return $data;
  74         }
  75
  76         /**
  77         * {@link phpbb_acm_abstract::put() put()}
  78         */
  79         public function put($var_name, $data, $ttl = 31536000)
  80         {
  81                 if ($var_name[0] === '#')
  82                 {
  83                         $var_name = substr($var_name, 1);
  84                         return $this->put_global($var_name, $data, $ttl);
  85                 }
  86
  87                 $filename = $this->cache_dir . $this->cache_prefix . '_' . $var_name . '.' . PHP_EXT;
  88
  89                 if ($fp = @fopen($filename, 'wb'))
  90                 {
  91                         @flock($fp, LOCK_EX);
  92                         fwrite($fp, "<?php\n\$expired = (time() > " . (time() + $ttl) . ") ? true : false;\nif (\$expired) { return; }\n\$data =  " . (sizeof($data) ? "unserialize(" . var_export(serialize($data), true) . ");" : 'array();'));
  93                         @flock($fp, LOCK_UN);
  94                         fclose($fp);
  95
  96                         phpbb::$system->chmod($filename, phpbb::CHMOD_READ | phpbb::CHMOD_WRITE);
  97                 }
  98
  99                 return $data;
 100         }
 101
 102
 103         /**
 104         * {@link phpbb_acm_abstract::exists() exists()}
 105         */
 106         public function exists($var_name)
 107         {
 108                 if ($var_name[0] === '#')
 109                 {
 110                         $var_name = substr($var_name, 1);
 111                         return $this->exists_global($var_name);
 112                 }
 113
 114                 return file_exists($this->cache_dir . $this->cache_prefix . '_' . $var_name . '.' . PHP_EXT);
 115         }
 116
 117         /**
 118         * {@link phpbb_acm_abstract::destroy() destroy()}
 119         */
 120         public function destroy($var_name)
 121         {
 122                 if ($var_name[0] === '#')
 123                 {
 124                         $var_name = substr($var_name, 1);
 125                         $this->destroy_global($var_name);
 126                 }
 127
 128                 if (!$this->exists($var_name))
 129                 {
 130                         return false;
 131                 }
 132
 133                 $this->remove_file($this->cache_dir . $this->cache_prefix . '_' . $var_name . '.' . PHP_EXT, true);
 134         }
 135
 136         /**
 137         * {@link phpbb_acm_abstract::load() load()}
 138         */
 139         public function load()
 140         {
 141                 // grab the global cache
 142                 if (file_exists($this->cache_dir . $this->cache_prefix . '_global.' . PHP_EXT))
 143                 {
 144                         @include($this->cache_dir . $this->cache_prefix . '_global.' . PHP_EXT);
 145                         return true;
 146                 }
 147
 148                 return false;
 149         }
 150
 151         /**
 152         * {@link phpbb_acm_abstract::unload() unload()}
 153         */
 154         public function unload()
 155         {
 156                 if (!$this->is_modified)
 157                 {
 158                         return;
 159                 }
 160
 161                 $filename = $this->cache_dir . $this->cache_prefix . '_global.' . PHP_EXT;
 162
 163                 if ($fp = @fopen($filename, 'wb'))
 164                 {
 165                         @flock($fp, LOCK_EX);
 166                         fwrite($fp, "<?php\n\$this->vars = unserialize(" . var_export(serialize($this->vars), true) . ");\n\$this->var_expires = unserialize(" . var_export(serialize($this->var_expires), true) . ");");
 167                         @flock($fp, LOCK_UN);
 168                         fclose($fp);
 169
 170                         phpbb::$system->chmod($filename, phpbb::CHMOD_READ | phpbb::CHMOD_WRITE);
 171                 }
 172                 else
 173                 {
 174                         // Now, this occurred how often? ... phew, just tell the user then...
 175                         if (!@is_writable($this->cache_dir))
 176                         {
 177                                 trigger_error($this->cache_dir . ' is NOT writable.', E_USER_ERROR);
 178                         }
 179
 180                         trigger_error('Not able to open ' . $filename, E_USER_ERROR);
 181                 }
 182
 183                 $this->is_modified = false;
 184
 185                 // To reset the global vars
 186                 $this->vars = $this->var_expires = array();
 187         }
 188
 189         /**
 190         * Tidy local cache data. Also see {@link phpbb_acm_abstract::tidy() tidy()}
 191         * @access protected
 192         */
 193         protected function tidy_local()
 194         {
 195                 $dir = @opendir($this->cache_dir);
 196
 197                 if (!$dir)
 198                 {
 199                         return;
 200                 }
 201
 202                 while (($entry = readdir($dir)) !== false)
 203                 {
 204                         if (strpos($entry, $this->cache_prefix . '_') !== 0 || strpos($entry, $this->cache_prefix . '_global') === 0)
 205                         {
 206                                 continue;
 207                         }
 208
 209                         $expired = true;
 210                         @include($this->cache_dir . $entry);
 211
 212                         if ($expired)
 213                         {
 214                                 $this->remove_file($this->cache_dir . $entry);
 215                         }
 216                 }
 217                 closedir($dir);
 218         }
 219
 220         /**
 221         * Purge local cache data. Also see {@link phpbb_acm_abstract::purge() purge()}
 222         * @access protected
 223         */
 224         protected function purge_local()
 225         {
 226                 $dir = @opendir($this->cache_dir);
 227
 228                 if (!$dir)
 229                 {
 230                         return;
 231                 }
 232
 233                 while (($entry = readdir($dir)) !== false)
 234                 {
 235                         if (strpos($entry, $this->cache_prefix . '_') !== 0 || strpos($entry, $this->cache_prefix . '_global') === 0)
 236                         {
 237                                 continue;
 238                         }
 239
 240                         $this->remove_file($this->cache_dir . $entry);
 241                 }
 242                 closedir($dir);
 243         }
 244
 245         /**
 246         * Get modified date for cache entry
 247         *
 248         * @param string $var_name       The cache variable name
 249         * @access public
 250         */
 251         public function get_modified_date($var_name)
 252         {
 253                 return @filemtime($this->cache_dir . $this->cache_prefix . '_' . $var_name . '.' . PHP_EXT);
 254         }
 255
 256         /**
 257         * Removes/unlinks file
 258         *
 259         * @param string $filename       The filename to remove
 260         * @param bool   $check          If true the cache directory is checked for correct directory permissions.
 261         * @access protected
 262         */
 263         protected function remove_file($filename, $check = false)
 264         {
 265                 if ($check && !@is_writable($this->cache_dir))
 266                 {
 267                         // E_USER_ERROR - not using language entry - intended.
 268                         trigger_error('Unable to remove files within ' . $this->cache_dir . '. Please check directory permissions.', E_USER_ERROR);
 269                 }
 270
 271                 return @unlink($filename);
 272         }
 273 }
 274
 275 /**
 276 * Special implementation for cache type 'sql'
 277 * @package acm
 278 */
 279 class phpbb_acm_file_sql extends phpbb_acm_file
 280 {
 281         /**
 282         * {@link phpbb_acm_abstract::destroy() destroy()}
 283         */
 284         public function destroy($var_name)
 285         {
 286                 if ($var_name[0] === '#')
 287                 {
 288                         $var_name = substr($var_name, 1);
 289                         $this->destroy_global($var_name);
 290                 }
 291
 292                 $table = (!is_array($var_name)) ? array($var_name) : $var_name;
 293                 $dir = @opendir($this->cache_dir);
 294
 295                 if (!$dir)
 296                 {
 297                         return;
 298                 }
 299
 300                 while (($entry = readdir($dir)) !== false)
 301                 {
 302                         if (strpos($entry, $this->cache_prefix . '_') !== 0)
 303                         {
 304                                 continue;
 305                         }
 306
 307                         // The following method is more failproof than simply assuming the query is on line 3 (which it should be)
 308                         @include($this->cache_dir . $entry);
 309
 310                         if (empty($data))
 311                         {
 312                                 $this->remove_file($this->cache_dir . $entry);
 313                                 continue;
 314                         }
 315
 316                         // Get the query
 317                         $data = $data['query'];
 318
 319                         $found = false;
 320                         foreach ($table as $check_table)
 321                         {
 322                                 // Better catch partial table names than no table names. ;)
 323                                 if (strpos($data, $check_table) !== false)
 324                                 {
 325                                         $found = true;
 326                                         break;
 327                                 }
 328                         }
 329
 330                         if ($found)
 331                         {
 332                                 $this->remove_file($this->cache_dir . $entry);
 333                         }
 334                 }
 335                 closedir($dir);
 336
 337                 return;
 338         }
 339 }
 340
 341 ?>