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 * ACM File Based Caching
  21 * @package acm
  22 */
  23 class acm
  24 {
  25         private $vars = array();
  26         private $var_expires = array();
  27         private $is_modified = false;
  28
  29         public $sql_rowset = array();
  30         public $cache_dir = '';
  31
  32         /**
  33         * Set cache path
  34         */
  35         function __construct()
  36         {
  37                 $this->cache_dir = PHPBB_ROOT_PATH . 'cache/';
  38         }
  39
  40         /**
  41         * Load global cache
  42         */
  43         private function load()
  44         {
  45                 // grab the global cache
  46                 if (file_exists($this->cache_dir . 'data_global.' . PHP_EXT))
  47                 {
  48                         @include($this->cache_dir . 'data_global.' . PHP_EXT);
  49                         return true;
  50                 }
  51
  52                 return false;
  53         }
  54
  55         /**
  56         * Unload cache object
  57         */
  58         public function unload()
  59         {
  60                 $this->save();
  61                 unset($this->vars);
  62                 unset($this->var_expires);
  63                 unset($this->sql_rowset);
  64
  65                 $this->vars = array();
  66                 $this->var_expires = array();
  67                 $this->sql_rowset = array();
  68         }
  69
  70         /**
  71         * Save modified objects
  72         */
  73         private function save()
  74         {
  75                 if (!$this->is_modified)
  76                 {
  77                         return;
  78                 }
  79
  80                 if ($fp = @fopen($this->cache_dir . 'data_global.' . PHP_EXT, 'wb'))
  81                 {
  82                         @flock($fp, LOCK_EX);
  83                         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) . ");");
  84                         @flock($fp, LOCK_UN);
  85                         fclose($fp);
  86
  87                         if (!function_exists('phpbb_chmod'))
  88                         {
  89                                 include(PHPBB_ROOT_PATH . 'includes/functions.' . PHP_EXT);
  90                         }
  91
  92                         phpbb_chmod($this->cache_dir . 'data_global.' . PHP_EXT, phpbb::CHMOD_WRITE);
  93                 }
  94                 else
  95                 {
  96                         // Now, this occurred how often? ... phew, just tell the user then...
  97                         if (!@is_writable($this->cache_dir))
  98                         {
  99                                 trigger_error($this->cache_dir . ' is NOT writable.', E_USER_ERROR);
 100                         }
 101
 102                         trigger_error('Not able to open ' . $this->cache_dir . 'data_global.' . PHP_EXT, E_USER_ERROR);
 103                 }
 104
 105                 $this->is_modified = false;
 106         }
 107
 108         /**
 109         * Tidy cache
 110         */
 111         public function tidy()
 112         {
 113                 $dir = @opendir($this->cache_dir);
 114
 115                 if (!$dir)
 116                 {
 117                         return;
 118                 }
 119
 120                 while (($entry = readdir($dir)) !== false)
 121                 {
 122                         if (!preg_match('/^(sql_|data_(?!global))/', $entry))
 123                         {
 124                                 continue;
 125                         }
 126
 127                         $expired = true;
 128                         @include($this->cache_dir . $entry);
 129                         if ($expired)
 130                         {
 131                                 $this->remove_file($this->cache_dir . $entry);
 132                         }
 133                 }
 134                 closedir($dir);
 135
 136                 if (file_exists($this->cache_dir . 'data_global.' . PHP_EXT))
 137                 {
 138                         if (!sizeof($this->vars))
 139                         {
 140                                 $this->load();
 141                         }
 142
 143                         foreach ($this->var_expires as $var_name => $expires)
 144                         {
 145                                 if (time() > $expires)
 146                                 {
 147                                         $this->destroy($var_name);
 148                                 }
 149                         }
 150                 }
 151
 152                 set_config('cache_last_gc', time(), true);
 153         }
 154
 155         /**
 156         * Get saved cache object
 157         */
 158         public function get($var_name)
 159         {
 160                 if ($var_name[0] === '_')
 161                 {
 162                         if (!$this->_exists($var_name))
 163                         {
 164                                 return false;
 165                         }
 166
 167                         @include($this->cache_dir . "data{$var_name}." . PHP_EXT);
 168                         return (isset($data)) ? $data : false;
 169                 }
 170                 else
 171                 {
 172                         return ($this->_exists($var_name)) ? $this->vars[$var_name] : false;
 173                 }
 174         }
 175
 176         /**
 177         * Put data into cache
 178         */
 179         function put($var_name, $var, $ttl = 31536000)
 180         {
 181                 if ($var_name[0] === '_')
 182                 {
 183                         if ($fp = @fopen($this->cache_dir . "data{$var_name}." . PHP_EXT, 'wb'))
 184                         {
 185                                 @flock($fp, LOCK_EX);
 186                                 fwrite($fp, "<?php\n\$expired = (time() > " . (time() + $ttl) . ") ? true : false;\nif (\$expired) { return; }\n\$data =  " . (sizeof($var) ? "unserialize(" . var_export(serialize($var), true) . ");" : 'array();'));
 187                                 @flock($fp, LOCK_UN);
 188                                 fclose($fp);
 189
 190                                 if (!function_exists('phpbb_chmod'))
 191                                 {
 192                                         include(PHPBB_ROOT_PATH . 'includes/functions.' . PHP_EXT);
 193                                 }
 194
 195                                 phpbb_chmod($this->cache_dir . "data{$var_name}." . PHP_EXT, phpbb::CHMOD_WRITE);
 196                         }
 197                 }
 198                 else
 199                 {
 200                         $this->vars[$var_name] = $var;
 201                         $this->var_expires[$var_name] = time() + $ttl;
 202                         $this->is_modified = true;
 203                 }
 204         }
 205
 206         /**
 207         * Purge cache data
 208         */
 209         public function purge()
 210         {
 211                 // Purge all phpbb cache files
 212                 $dir = @opendir($this->cache_dir);
 213
 214                 if (!$dir)
 215                 {
 216                         return;
 217                 }
 218
 219                 while (($entry = readdir($dir)) !== false)
 220                 {
 221                         if (strpos($entry, 'sql_') !== 0 && strpos($entry, 'data_') !== 0 && strpos($entry, 'ctpl_') !== 0 && strpos($entry, 'tpl_') !== 0)
 222                         {
 223                                 continue;
 224                         }
 225
 226                         $this->remove_file($this->cache_dir . $entry);
 227                 }
 228                 closedir($dir);
 229
 230                 unset($this->vars);
 231                 unset($this->var_expires);
 232                 unset($this->sql_rowset);
 233
 234                 $this->vars = array();
 235                 $this->var_expires = array();
 236                 $this->sql_rowset = array();
 237
 238                 $this->is_modified = false;
 239         }
 240
 241         /**
 242         * Destroy cache data
 243         */
 244         public function destroy($var_name, $table = '')
 245         {
 246                 if ($var_name === 'sql' && !empty($table))
 247                 {
 248                         if (!is_array($table))
 249                         {
 250                                 $table = array($table);
 251                         }
 252
 253                         $dir = @opendir($this->cache_dir);
 254
 255                         if (!$dir)
 256                         {
 257                                 return;
 258                         }
 259
 260                         while (($entry = readdir($dir)) !== false)
 261                         {
 262                                 if (strpos($entry, 'sql_') !== 0)
 263                                 {
 264                                         continue;
 265                                 }
 266
 267                                 // The following method is more failproof than simply assuming the query is on line 3 (which it should be)
 268                                 $check_line = @file_get_contents($this->cache_dir . $entry);
 269
 270                                 if (empty($check_line))
 271                                 {
 272                                         continue;
 273                                 }
 274
 275                                 // Now get the contents between /* and */
 276                                 $check_line = substr($check_line, strpos($check_line, '/* ') + 3, strpos($check_line, ' */') - strpos($check_line, '/* ') - 3);
 277
 278                                 $found = false;
 279                                 foreach ($table as $check_table)
 280                                 {
 281                                         // Better catch partial table names than no table names. ;)
 282                                         if (strpos($check_line, $check_table) !== false)
 283                                         {
 284                                                 $found = true;
 285                                                 break;
 286                                         }
 287                                 }
 288
 289                                 if ($found)
 290                                 {
 291                                         $this->remove_file($this->cache_dir . $entry);
 292                                 }
 293                         }
 294                         closedir($dir);
 295
 296                         return;
 297                 }
 298
 299                 if (!$this->_exists($var_name))
 300                 {
 301                         return;
 302                 }
 303
 304                 if ($var_name[0] === '_')
 305                 {
 306                         $this->remove_file($this->cache_dir . 'data' . $var_name . '.' . PHP_EXT, true);
 307                 }
 308                 else if (isset($this->vars[$var_name]))
 309                 {
 310                         $this->is_modified = true;
 311                         unset($this->vars[$var_name]);
 312                         unset($this->var_expires[$var_name]);
 313
 314                         // We save here to let the following cache hits succeed
 315                         $this->save();
 316                 }
 317         }
 318
 319         /**
 320         * Check if a given cache entry exist
 321         */
 322         private function _exists($var_name)
 323         {
 324                 if ($var_name[0] === '_')
 325                 {
 326                         return file_exists($this->cache_dir . 'data' . $var_name . '.' . PHP_EXT);
 327                 }
 328                 else
 329                 {
 330                         if (!sizeof($this->vars))
 331                         {
 332                                 $this->load();
 333                         }
 334
 335                         if (!isset($this->var_expires[$var_name]))
 336                         {
 337                                 return false;
 338                         }
 339
 340                         return (time() > $this->var_expires[$var_name]) ? false : isset($this->vars[$var_name]);
 341                 }
 342         }
 343
 344         /**
 345         * Load cached sql query
 346         */
 347         public function sql_load($query)
 348         {
 349                 // Remove extra spaces and tabs
 350                 $query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
 351                 $query_id = sizeof($this->sql_rowset);
 352
 353                 if (!file_exists($this->cache_dir . 'sql_' . md5($query) . '.' . PHP_EXT))
 354                 {
 355                         return false;
 356                 }
 357
 358                 @include($this->cache_dir . 'sql_' . md5($query) . '.' . PHP_EXT);
 359
 360                 if (!isset($expired))
 361                 {
 362                         return false;
 363                 }
 364                 else if ($expired)
 365                 {
 366                         $this->remove_file($this->cache_dir . 'sql_' . md5($query) . '.' . PHP_EXT, true);
 367                         return false;
 368                 }
 369
 370
 371                 return $query_id;
 372         }
 373
 374         /**
 375         * Save sql query
 376         */
 377         public function sql_save($query, &$query_result, $ttl)
 378         {
 379                 global $db;
 380
 381                 // Remove extra spaces and tabs
 382                 $query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
 383                 $filename = $this->cache_dir . 'sql_' . md5($query) . '.' . PHP_EXT;
 384
 385                 if ($fp = @fopen($filename, 'wb'))
 386                 {
 387                         @flock($fp, LOCK_EX);
 388
 389                         $query_id = sizeof($this->sql_rowset);
 390                         $this->sql_rowset[$query_id] = array();
 391
 392                         while ($row = $db->sql_fetchrow($query_result))
 393                         {
 394                                 $this->sql_rowset[$query_id][] = $row;
 395                         }
 396                         $db->sql_freeresult($query_result);
 397
 398                         $file = "<?php\n/* " . str_replace('*/', '*\/', $query) . " */";
 399                         $file .= "\n\$expired = (time() > " . (time() + $ttl) . ") ? true : false;\nif (\$expired) { return; }\n";
 400
 401                         fwrite($fp, $file . "\$this->sql_rowset[\$query_id] = " . (sizeof($this->sql_rowset[$query_id]) ? "unserialize(" . var_export(serialize($this->sql_rowset[$query_id]), true) . ");" : 'array();'));
 402                         @flock($fp, LOCK_UN);
 403                         fclose($fp);
 404
 405                         if (!function_exists('phpbb_chmod'))
 406                         {
 407                                 include(PHPBB_ROOT_PATH . 'includes/functions.' . PHP_EXT);
 408                         }
 409
 410                         phpbb_chmod($filename, phpbb::CHMOD_WRITE);
 411
 412                         $query_result = $query_id;
 413                 }
 414         }
 415
 416         /**
 417         * Fetch row from cache (database)
 418         */
 419         public function sql_fetchrow($query_id)
 420         {
 421                 list(, $row) = each($this->sql_rowset[$query_id]);
 422
 423                 return ($row !== NULL) ? $row : false;
 424         }
 425
 426         /**
 427         * Fetch a field from the current row of a cached database result (database)
 428         */
 429         public function sql_fetchfield($query_id, $field)
 430         {
 431                 $row = current($this->sql_rowset[$query_id]);
 432
 433                 return ($row !== false && isset($row[$field])) ? $row[$field] : false;
 434         }
 435
 436         /**
 437         * Free memory used for a cached database result (database)
 438         */
 439         public function sql_freeresult($query_id)
 440         {
 441                 if (!isset($this->sql_rowset[$query_id]))
 442                 {
 443                         return false;
 444                 }
 445
 446                 unset($this->sql_rowset[$query_id]);
 447
 448                 return true;
 449         }
 450
 451         /**
 452         * Removes/unlinks file
 453         */
 454         private function remove_file($filename, $check = false)
 455         {
 456                 if ($check && !@is_writable($this->cache_dir))
 457                 {
 458                         // E_USER_ERROR - not using language entry - intended.
 459                         trigger_error('Unable to remove files within ' . $this->cache_dir . '. Please check directory permissions.', E_USER_ERROR);
 460                 }
 461
 462                 return @unlink($filename);
 463         }
 464 }
 465
 466 ?>