cache.inc 6.76 KB
Newer Older
1
<?php
2
// $Id$
3
4

/**
5
6
7
 * Return data from the persistent cache. Data may be stored as either plain 
 * text or as serialized data. cache_get will automatically return 
 * unserialized objects and arrays.
8
 *
9
 * @param $cid
10
 *   The cache ID of the data to retrieve.
11
 * @param $table
12
13
14
 *   The table $table to store the data in. Valid core values are 
 *   'cache_filter', 'cache_menu', 'cache_page', or 'cache' for 
 *   the default cache.
15
 * @return The cache or FALSE on failure.
16
 */
17
function cache_get($cid, $table = 'cache') {
18
19
20
21
  global $user;

  // Garbage collection necessary when enforcing a minimum cache lifetime
  $cache_flush = variable_get('cache_flush', 0);
22
  if ($cache_flush && ($cache_flush + variable_get('cache_lifetime', 0) <= REQUEST_TIME)) {
23
24
    // Reset the variable immediately to prevent a meltdown in heavy load situations.
    variable_set('cache_flush', 0);
25
    // Time to flush old cache data
26
    db_query("DELETE FROM {" . $table . "} WHERE expire != %d AND expire <= %d", CACHE_PERMANENT, $cache_flush);
27
28
  }

29
  $cache = db_fetch_object(db_query("SELECT data, created, headers, expire, serialized FROM {" . $table . "} WHERE cid = '%s'", $cid));
30
31
32
33
  if (isset($cache->data)) {
    // If the data is permanent or we're not enforcing a minimum cache lifetime
    // always return the cached data.
    if ($cache->expire == CACHE_PERMANENT || !variable_get('cache_lifetime', 0)) {
34
35
36
      if ($cache->serialized) {
        $cache->data = unserialize($cache->data);
      }
37
38
39
40
41
    }
    // If enforcing a minimum cache lifetime, validate that the data is
    // currently valid for this user before we return it by making sure the
    // cache entry was created before the timestamp in the current session's
    // cache timer. The cache variable is loaded into the $user object by
42
    // _sess_read() in session.inc.
43
44
45
    else {
      if ($user->cache > $cache->created) {
        // This cache data is too old and thus not valid for us, ignore it.
46
        return FALSE;
47
48
      }
      else {
49
50
51
        if ($cache->serialized) {
          $cache->data = unserialize($cache->data);
        }
52
53
54
55
      }
    }
    return $cache;
  }
56
  return FALSE;
57
58
59
60
61
}

/**
 * Store data in the persistent cache.
 *
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 * The persistent cache is split up into four database
 * tables. Contributed modules can add additional tables.
 *
 * 'cache_page': This table stores generated pages for anonymous
 * users. This is the only table affected by the page cache setting on
 * the administrator panel.
 *
 * 'cache_menu': Stores the cachable part of the users' menus.
 *
 * 'cache_filter': Stores filtered pieces of content. This table is
 * periodically cleared of stale entries by cron.
 *
 * 'cache': Generic cache storage table.
 *
 * The reasons for having several tables are as follows:
 *
 * - smaller tables allow for faster selects and inserts
 * - we try to put fast changing cache items and rather static
 *   ones into different tables. The effect is that only the fast
 *   changing tables will need a lot of writes to disk. The more
 *   static tables will also be better cachable with MySQL's query cache
 *
84
85
 * @param $cid
 *   The cache ID of the data to store.
86
 * @param $data
87
88
 *   The data to store in the cache. Complex data types will be automatically 
 *   serialized before insertion.
89
 *   Strings will be stored as plain text and not serialized.
90
 * @param $table
91
92
 *   The table $table to store the data in. Valid core values are 
 *   'cache_filter', 'cache_menu', 'cache_page', or 'cache'.
93
94
95
96
97
98
99
100
101
102
103
 * @param $expire
 *   One of the following values:
 *   - CACHE_PERMANENT: Indicates that the item should never be removed unless
 *     explicitly told to using cache_clear_all() with a cache ID.
 *   - CACHE_TEMPORARY: Indicates that the item should be removed at the next
 *     general cache wipe.
 *   - A Unix timestamp: Indicates that the item should be kept at least until
 *     the given time, after which it behaves like CACHE_TEMPORARY.
 * @param $headers
 *   A string containing HTTP header information for cached pages.
 */
104
function cache_set($cid, $data, $table = 'cache', $expire = CACHE_PERMANENT, $headers = NULL) {
105
106
  $fields = array(
    'serialized' => 0,
107
    'created' => REQUEST_TIME,
108
109
110
    'expire' => $expire,
    'headers' => $headers,
  );
111
  if (!is_string($data)) {
112
113
    $fields['data'] = serialize($data);
    $fields['serialized'] = 1;
114
  }
115
116
117
  else {
    $fields['data'] = $data;
    $fields['serialized'] = 0;
118
  }
119
120

  db_merge($table)->key(array('cid' => $cid))->fields($fields)->execute();
121
122
123
}

/**
124
125
 *
 * Expire data from the cache. If called without arguments, expirable
126
 * entries will be cleared from the cache_page and cache_block tables.
127
128
129
130
131
 *
 * @param $cid
 *   If set, the cache ID to delete. Otherwise, all cache entries that can
 *   expire are deleted.
 *
132
133
134
135
 * @param $table
 *   If set, the table $table to delete from. Mandatory
 *   argument if $cid is set.
 *
136
 * @param $wildcard
137
138
139
 *   If set to TRUE, the $cid is treated as a substring
 *   to match rather than a complete ID. The match is a right hand
 *   match. If '*' is given as $cid, the table $table will be emptied.
140
 */
141
function cache_clear_all($cid = NULL, $table = NULL, $wildcard = FALSE) {
142
143
  global $user;

144
  if (!isset($cid) && !isset($table)) {
145
146
    // Clear the block cache first, so stale data will
    // not end up in the page cache.
147
    cache_clear_all(NULL, 'cache_block');
148
    cache_clear_all(NULL, 'cache_page');
149
150
151
    return;
  }

152
153
154
  if (empty($cid)) {
    if (variable_get('cache_lifetime', 0)) {
      // We store the time in the current user's $user->cache variable which
155
      // will be saved into the sessions table by _sess_write(). We then
156
157
      // simulate that the cache was flushed for this user by not returning
      // cached data that was cached before the timestamp.
158
      $user->cache = REQUEST_TIME;
159
160
161
162

      $cache_flush = variable_get('cache_flush', 0);
      if ($cache_flush == 0) {
        // This is the first request to clear the cache, start a timer.
163
        variable_set('cache_flush', REQUEST_TIME);
164
      }
165
      else if (REQUEST_TIME > ($cache_flush + variable_get('cache_lifetime', 0))) {
166
167
        // Clear the cache for everyone, cache_flush_delay seconds have
        // passed since the first request to clear the cache.
168
        db_query("DELETE FROM {" . $table . "} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, REQUEST_TIME);
169
170
171
172
173
        variable_set('cache_flush', 0);
      }
    }
    else {
      // No minimum cache lifetime, flush all temporary cache entries now.
174
      db_query("DELETE FROM {" . $table . "} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, REQUEST_TIME);
175
176
177
178
    }
  }
  else {
    if ($wildcard) {
179
      if ($cid == '*') {
180
        db_delete($table)->execute();
181
182
      }
      else {
183
        db_delete($table)->condition('cid', $cid .'%', 'LIKE')->execute();
184
      }
185
186
    }
    else {
187
      db_delete($table)->condition('cid', $cid)->execute();
188
189
190
191
    }
  }
}