phpBB/includes/acm/acm_apc.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 APC Based Caching
  21 * @package acm
  22 */
  23 class acm
  24 {
  25         private $vars = array();
  26         private $is_modified = false;
  27
  28         public $sql_rowset = array();
  29         public $cache_dir = '';
  30
  31         /**
  32         * Set cache path
  33         */
  34         function __construct()
  35         {
  36                 $this->cache_dir = PHPBB_ROOT_PATH . 'cache/';
  37         }
  38
  39         /**
  40         * Load global cache
  41         */
  42         private function load()
  43         {
  44                 // grab the global cache
  45                 if ($this->vars = apc_fetch('global'))
  46                 {
  47                         return true;
  48                 }
  49
  50                 return false;
  51         }
  52
  53         /**
  54         * Unload cache object
  55         */
  56         public function unload()
  57         {
  58                 $this->save();
  59                 unset($this->vars);
  60                 unset($this->sql_rowset);
  61
  62                 $this->vars = array();
  63                 $this->sql_rowset = array();
  64         }
  65
  66         /**
  67         * Save modified objects
  68         */
  69         private function save()
  70         {
  71                 if (!$this->is_modified)
  72                 {
  73                         return;
  74                 }
  75
  76                 apc_store('global', $this->vars, 31536000);
  77
  78                 $this->is_modified = false;
  79         }
  80
  81         /**
  82         * Tidy cache
  83         */
  84         public function tidy()
  85         {
  86                 // cache has auto GC, no need to have any code here :)
  87
  88                 set_config('cache_last_gc', time(), true);
  89         }
  90
  91         /**
  92         * Get saved cache object
  93         */
  94         public function get($var_name)
  95         {
  96                 if ($var_name[0] === '_')
  97                 {
  98                         return apc_fetch($var_name);
  99                 }
 100                 else
 101                 {
 102                         if (!sizeof($this->vars))
 103                         {
 104                                 $this->load();
 105                         }
 106                         return (isset($this->vars[$var_name])) ? $this->vars[$var_name] : false;
 107                 }
 108         }
 109
 110         /**
 111         * Put data into cache
 112         */
 113         public function put($var_name, $var, $ttl = 31536000)
 114         {
 115                 if ($var_name[0] === '_')
 116                 {
 117                         apc_store($var_name, $var, $ttl);
 118                 }
 119                 else
 120                 {
 121                         $this->vars[$var_name] = $var;
 122                         $this->is_modified = true;
 123                 }
 124         }
 125
 126         /**
 127         * Purge cache data
 128         */
 129         public function purge()
 130         {
 131                 // Purge all phpbb cache files
 132                 $dir = @opendir($this->cache_dir);
 133
 134                 if (!$dir)
 135                 {
 136                         return;
 137                 }
 138
 139                 while (($entry = readdir($dir)) !== false)
 140                 {
 141                         if (strpos($entry, 'sql_') !== 0 && strpos($entry, 'data_') !== 0 && strpos($entry, 'ctpl_') !== 0 && strpos($entry, 'tpl_') !== 0)
 142                         {
 143                                 continue;
 144                         }
 145
 146                         @unlink($this->cache_dir . $entry);
 147                 }
 148                 closedir($dir);
 149
 150                 apc_clear_cache('user');
 151
 152                 unset($this->vars);
 153                 unset($this->sql_rowset);
 154
 155                 $this->vars = array();
 156                 $this->var_expires = array();
 157                 $this->sql_rowset = array();
 158
 159                 $this->is_modified = false;
 160         }
 161
 162         /**
 163         * Destroy cache data
 164         */
 165         public function destroy($var_name, $table = '')
 166         {
 167                 if ($var_name === 'sql' && !empty($table))
 168                 {
 169                         if (!is_array($table))
 170                         {
 171                                 $table = array($table);
 172                         }
 173
 174                         foreach ($table as $table_name)
 175                         {
 176                                 // gives us the md5s that we want
 177                                 $temp = apc_fetch('sql_' . $table_name);
 178                                 if ($temp === false)
 179                                 {
 180                                         continue;
 181                                 }
 182
 183                                 // delete each query ref
 184                                 foreach ($temp as $md5_id => $void)
 185                                 {
 186                                         apc_delete('sql_' . $md5_id);
 187                                 }
 188
 189                                 // delete the table ref
 190                                 apc_delete('sql_' . $table_name);
 191                         }
 192
 193                         return;
 194                 }
 195
 196                 if ($var_name[0] === '_')
 197                 {
 198                         apc_delete($var_name);
 199                 }
 200                 else if (isset($this->vars[$var_name]))
 201                 {
 202                         $this->is_modified = true;
 203                         unset($this->vars[$var_name]);
 204
 205                         // We save here to let the following cache hits succeed
 206                         $this->save();
 207                 }
 208         }
 209
 210         /**
 211         * Load cached sql query
 212         */
 213         public function sql_load($query)
 214         {
 215                 // Remove extra spaces and tabs
 216                 $query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
 217                 $query_id = sizeof($this->sql_rowset);
 218
 219                 $temp = apc_fetch('sql_' . md5($query));
 220
 221                 if ($temp === false)
 222                 {
 223                         return false;
 224                 }
 225
 226                 $this->sql_rowset[$query_id] = $temp;
 227
 228                 return $query_id;
 229         }
 230
 231         /**
 232         * Save sql query
 233         */
 234         public function sql_save($query, &$query_result, $ttl)
 235         {
 236                 global $db;
 237
 238                 // Remove extra spaces and tabs
 239                 $query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
 240
 241                 // determine which tables this query belongs to:
 242
 243                 // grab all the FROM tables, avoid getting a LEFT JOIN
 244                 preg_match('/FROM \(?(\w+(?: (?!LEFT JOIN)\w+)?(?:, ?\w+(?: (?!LEFT JOIN)\w+)?)*)\)?/', $query, $regs);
 245                 $tables = array_map('trim', explode(',', $regs[1]));
 246
 247                 // now get the LEFT JOIN
 248                 preg_match_all('/LEFT JOIN\s+(\w+)(?: \w+)?/', $query, $result, PREG_PATTERN_ORDER);
 249                 $tables = array_merge($tables, $result[1]);
 250
 251                 $query_hash = md5($query);
 252
 253                 foreach ($tables as $table_name)
 254                 {
 255                         if (($pos = strpos($table_name, ' ')) !== false)
 256                         {
 257                                 $table_name = substr($table_name, 0, $pos);
 258                         }
 259
 260                         $temp = apc_fetch('sql_' . $table_name);
 261                         if ($temp === false)
 262                         {
 263                                 $temp = array();
 264                         }
 265                         $temp[$query_hash] = true;
 266                         apc_store('sql_' . $table_name, $temp, $ttl);
 267                 }
 268
 269                 // store them in the right place
 270                 $query_id = sizeof($this->sql_rowset);
 271                 $this->sql_rowset[$query_id] = array();
 272
 273                 while ($row = $db->sql_fetchrow($query_result))
 274                 {
 275                         $this->sql_rowset[$query_id][] = $row;
 276                 }
 277                 $db->sql_freeresult($query_result);
 278
 279                 apc_store('sql_' . $query_hash, $this->sql_rowset[$query_id], $ttl);
 280
 281                 $query_result = $query_id;
 282         }
 283
 284         /**
 285         * Fetch row from cache (database)
 286         */
 287         public function sql_fetchrow($query_id)
 288         {
 289                 list(, $row) = each($this->sql_rowset[$query_id]);
 290
 291                 return ($row !== NULL) ? $row : false;
 292         }
 293
 294         /**
 295         * Fetch a field from the current row of a cached database result (database)
 296         */
 297         public function sql_fetchfield($query_id, $field)
 298         {
 299                 $row = current($this->sql_rowset[$query_id]);
 300
 301                 return ($row !== false && isset($row[$field])) ? $row[$field] : false;
 302         }
 303
 304         /**
 305         * Free memory used for a cached database result (database)
 306         */
 307         public function sql_freeresult($query_id)
 308         {
 309                 if (!isset($this->sql_rowset[$query_id]))
 310                 {
 311                         return false;
 312                 }
 313
 314                 unset($this->sql_rowset[$query_id]);
 315
 316                 return true;
 317         }
 318 }
 319
 320 ?>