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