summaryrefslogtreecommitdiff
path: root/modules/gallery/libraries/drivers/Cache/Database.php
blob: 43f4e38a409e4b1f3b76cc3f68e13615483d52d3 (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?php defined("SYSPATH") or die("No direct script access.");
/**
 * Gallery - a web based photo album viewer and editor
 * Copyright (C) 2000-2009 Bharat Mediratta
 *
 * 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; either version 2 of the License, or (at
 * your option) any later version.
 *
 * 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., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
 */
/*
 * Based on the Cache_Sqlite_Driver developed by the Kohana Team
 */
class Cache_Database_Driver implements Cache_Driver {
  // Kohana database instance
  protected $db;

  /**
   * Tests that the storage location is a directory and is writable.
   */
  public function __construct() {
    // Open up an instance of the database
    $this->db = Database::instance();

    if (!$this->db->table_exists("caches")) {
      throw new Exception("@todo Cache table is not defined");
    }
  }

  /**
   * Checks if a cache id is already set.
   *
   * @param  string   cache id
   * @return boolean
   */
  public function exists($id) {
    $count = $this->db->count_records("caches", array("key" => $id, "expiration >=" => time()));
    return $count > 0;
  }

  /**
   * Sets a cache item to the given data, tags, and lifetime.
   *
   * @param   string   cache id to set
   * @param   string   data in the cache
   * @param   array    cache tags
   * @param   integer  lifetime
   * @return  bool
   */
  public function set($id, $data, array $tags = NULL, $lifetime) {
    if (!empty($tags)) {
      // Escape the tags, adding brackets so the tag can be explicitly matched
      $tags = "<" . implode(">,<", $tags) . ">";
    }

    // Cache Database driver expects unix timestamp
    if ($lifetime !== 0) {
      $lifetime += time();
    }

    if ($this->exists($id)) {
      $status = $this->db->update(
        "caches",
        array("tags" => $tags, "expiration" => $lifetime, "cache" => serialize($data)), array("key" => $id));
    } else {
      $status = $this->db->insert(
        "caches",
        array("key" => $id, "tags" => $tags, "expiration" => $lifetime, "cache" => serialize($data)));
    }

    return count($status) > 0;
  }

  /**
   * Finds an array of ids for a given tag.
   *
   * @param  string  tag name
   * @return array   of ids that match the tag
   */
  public function find($tag) {
    $db_result = $this->db->from("caches")
      ->like("tags", "<$tag>")
      ->get()
      ->result(true);

    // An array will always be returned
    $result = array();

    if ($db_result->count() > 0) {
      // Disable notices for unserializing
      $ER = error_reporting(~E_NOTICE);

      foreach ($db_result as $row) {
        // Add each cache to the array
        $result[$row->key] = unserialize($row->cache);
      }

      // Turn notices back on
      error_reporting($ER);
    }

    return $result;
  }

  /**
   * Fetches a cache item. This will delete the item if it is expired or if
   * the hash does not match the stored hash.
   *
   * @param  string  cache id
   * @return mixed|NULL
   */
  public function get($id) {
    $data = null;
    $result = $this->db->getwhere("caches", array("key" => $id));

    if (count($result) > 0) {
      $cache = $result->current();
      // Make sure the expiration is valid and that the hash matches
      if ($cache->expiration != 0 && $cache->expiration <= time()) {
        // Cache is not valid, delete it now
        $this->delete($cache->id);
      } else {
        // Disable notices for unserializing
        $ER = error_reporting(~E_NOTICE);

        // Return the valid cache data
        $data = unserialize($cache->cache);

        // Turn notices back on
        error_reporting($ER);
      }
    }

    return $data;
  }

  /**
   * Deletes a cache item by id or tag
   *
   * @param  string  cache id or tag, or true for "all items"
   * @param  bool    delete a tag
   * @return bool
   */
  public function delete($id, $tag = false) {
    $this->db->from("caches");
    if ($id === true) {
      $this->db->where(1);
      // Delete all caches
    } else if ($tag === true) {
      $this->db->like("tags", "<$id>");
    } else {
      $this->db->where("key", $id);
    }

    $status = $this->db->delete();

    return count($status) > 0;
  }

  /**
   * Deletes all cache files that are older than the current time.
   */
  public function delete_expired() {
    // Delete all expired caches
    $status = $this->db->from("caches")
      ->where(array("expiration !=" => 0, "expiration <=" => time()))
      ->delete();

    return count($status) > 0;
  }

} // End Cache Database Driver