aboutsummaryrefslogtreecommitdiffstats
path: root/include/cache.class.php
blob: 4a1a4aa60ba9a3cc8d4457ae33514f390707cd9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?php
// +-----------------------------------------------------------------------+
// | Piwigo - a PHP based photo gallery                                    |
// +-----------------------------------------------------------------------+
// | Copyright(C) 2008-2016 Piwigo Team                  http://piwigo.org |
// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
// +-----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify  |
// | it under the terms of the GNU General Public License as published by  |
// | the Free Software Foundation                                          |
// |                                                                       |
// | This program is distributed in the hope that it will be useful, but   |
// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
// | General Public License for more details.                              |
// |                                                                       |
// | You should have received a copy of the GNU General Public License     |
// | along with this program; if not, write to the Free Software           |
// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
// | USA.                                                                  |
// +-----------------------------------------------------------------------+

/**
  Provides a persistent cache mechanism across multiple page loads/sessions etc...
*/
abstract class PersistentCache
{
  var $default_lifetime = 86400;
  protected $instance_key = PHPWG_VERSION;

  /**
  @return a key that can be safely be used with get/set methods
  */
  function make_key($key)
  {
    if ( is_array($key) )
    {
      $key = implode('&', $key);
    }
    $key .= $this->instance_key;
    return md5($key);
  }

  /**
  Searches for a key in the persistent cache and fills corresponding value.
  @param string $key
  @param out mixed $value
  @return false if the $key is not found in cache ($value is not modified in this case)
  */
  abstract function get($key, &$value);

  /**
  Sets a key/value pair in the persistent cache.
  @param string $key - it should be the return value of make_key function
  @param mixed $value
  @param int $lifetime
  @return false on error
  */
  abstract function set($key, $value, $lifetime=null);

  /**
  Purge the persistent cache.
  @param boolean $all - if false only expired items will be purged
  */
  abstract function purge($all);
}


/**
  Implementation of a persistent cache using files.
*/
class PersistentFileCache extends PersistentCache
{
  private $dir;

  function __construct()
  {
    global $conf;
    $this->dir = PHPWG_ROOT_PATH.$conf['data_location'].'cache/';
  }

  function get($key, &$value)
  {
    $loaded = @file_get_contents($this->dir.$key.'.cache');
    if ($loaded !== false && ($loaded=unserialize($loaded)) !== false)
    {
      if ($loaded['expire'] > time())
      {
        $value = $loaded['data'];
        return true;
      }
    }
    return false;
  }

  function set($key, $value, $lifetime=null)
  {
    if ($lifetime === null)
    {
      $lifetime = $this->default_lifetime;
    }

    if (rand() % 97 == 0)
    {
      $this->purge(false);
    }

    $serialized = serialize( array(
        'expire' => time() + $lifetime,
        'data' => $value
      ));

    if (false === @file_put_contents($this->dir.$key.'.cache', $serialized))
    {
      mkgetdir($this->dir, MKGETDIR_DEFAULT&~MKGETDIR_DIE_ON_ERROR);
      if (false === @file_put_contents($this->dir.$key.'.cache', $serialized))
      {
        return false;
      }
    }
    return true;
  }

  function purge($all)
  {
    $files = glob($this->dir.'*.cache');
    if (empty($files))
    {
      return;
    }

    $limit = time() - $this->default_lifetime;
    foreach ($files as $file)
    {
      if ($all || @filemtime($file) < $limit)
        @unlink($file);
    }
  }

}

?>