summaryrefslogtreecommitdiff
path: root/tests/UnitTests/CacheResourceTests/_shared/cacheresources/cacheresource.mysql.php
blob: 9b51c272509e7ea1e8ccb0369fce1ff0a6dcd593 (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
182
183
184
185
186
187
188
189
190
<?php

use Smarty\Exception;

/**
 * MySQL CacheResource
 * CacheResource Implementation based on the Custom API to use
 * MySQL as the storage resource for Smarty's output caching.
 * Table definition:
 * <pre>CREATE TABLE IF NOT EXISTS `output_cache` (
 *   `id` CHAR(40) NOT NULL COMMENT 'sha1 hash',
 *   `name` VARCHAR(250) NOT NULL,
 *   `cache_id` VARCHAR(250) NULL DEFAULT NULL,
 *   `compile_id` VARCHAR(250) NULL DEFAULT NULL,
 *   `modified` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
 *   `content` LONGTEXT NOT NULL,
 *   PRIMARY KEY (`id`),
 *   INDEX(`name`),
 *   INDEX(`cache_id`),
 *   INDEX(`compile_id`),
 *   INDEX(`modified`)
 * ) ENGINE = InnoDB;</pre>
 *

 * @author  Rodney Rehm
 */
class Smarty_CacheResource_Mysql extends \Smarty\Cacheresource\Custom
{

	/**
	 * @return PDO
	 * @throws Exception
	 */
	protected function db(): PDO {
		static $dbConn = null;
		try {
			return $dbConn ?? ($dbConn = new PDO("mysql:dbname=test;host=127.0.0.1", "smarty"));
		} catch (PDOException $e) {
			throw new Exception('Mysql Resource failed: ' . $e->getMessage());
		}
	}

	/**
	 * @return false|PDOStatement
	 * @throws Exception
	 */
	protected function fetchQuery() {
		static $query = null;
		return $query ?? $query = $this->db()->prepare('SELECT modified, content FROM output_cache WHERE id = :id');
	}

	/**
	 * @return false|PDOStatement
	 * @throws Exception
	 */
	protected function fetchTimestampQuery() {
		static $query = null;
		return $query ?? $query = $this->db()->prepare('SELECT modified FROM output_cache WHERE id = :id');
	}

	/**
	 * @return false|PDOStatement
	 * @throws Exception
	 */
	protected function saveQuery() {
		static $query = null;
		return $query ?? $query = $this->db()->prepare(
			'REPLACE INTO output_cache (id, name, cache_id, compile_id, content)
            VALUES  (:id, :name, :cache_id, :compile_id, :content)'
		);
	}

	/**
	 * fetch cached content and its modification time from data source
	 *
	 * @param string $id unique cache content identifier
	 * @param string $name template name
	 * @param string $cache_id cache id
	 * @param string $compile_id compile id
	 * @param string $content cached content
	 * @param integer $mtime cache modification timestamp (epoch)
	 *
	 * @return void
	 * @throws Exception
	 */
    protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime)
    {
        $this->fetchQuery()->execute(array('id' => $id));
        $row = $this->fetchQuery()->fetch();
        $this->fetchQuery()->closeCursor();
        if ($row) {
            $content = $row[ 'content' ];
            $mtime = strtotime($row[ 'modified' ]);
        } else {
            $content = null;
            $mtime = null;
        }
    }

    /**
     * Fetch cached content's modification timestamp from data source
     *
     * @note implementing this method is optional. Only implement it if modification times can be accessed faster than
     *       loading the complete cached content.
     *
     * @param string $id         unique cache content identifier
     * @param string $name       template name
     * @param string $cache_id   cache id
     * @param string $compile_id compile id
     *
     * @return integer|boolean timestamp (epoch) the template was modified, or false if not found
     */
    protected function fetchTimestamp($id, $name, $cache_id, $compile_id)
    {
        $this->fetchTimestampQuery()->execute(array('id' => $id));
        $mtime = strtotime($this->fetchTimestampQuery()->fetchColumn());
        $this->fetchTimestampQuery()->closeCursor();
        return $mtime;
    }

    /**
     * Save content to cache
     *
     * @param string       $id         unique cache content identifier
     * @param string       $name       template name
     * @param string       $cache_id   cache id
     * @param string       $compile_id compile id
     * @param integer|null $exp_time   seconds till expiration time in seconds or null
     * @param string       $content    content to cache
     *
     * @return boolean      success
     */
    protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content)
    {
        $this->saveQuery()->execute(
            array('id' => $id,
                  'name' => $name,
                  'cache_id' => $cache_id,
                  'compile_id' => $compile_id,
                  'content' => $content,)
        );
        return !!$this->saveQuery()->rowCount();
    }

    /**
     * Delete content from cache
     *
     * @param string       $name       template name
     * @param string       $cache_id   cache id
     * @param string       $compile_id compile id
     * @param integer|null $exp_time   seconds till expiration or null
     *
     * @return integer      number of deleted caches
     */
    protected function delete($name, $cache_id, $compile_id, $exp_time)
    {
        // delete the whole cache
        if ($name === null && $cache_id === null && $compile_id === null && $exp_time === null) {
            // returning the number of deleted caches would require a second query to count them
            $query = $this->db()->query('TRUNCATE TABLE output_cache');
            return -1;
        }
        // build the filter
        $where = array();
        // equal test name
        if ($name !== null) {
            $where[] = 'name = ' . $this->db()->quote($name);
        }
        // equal test compile_id
        if ($compile_id !== null) {
            $where[] = 'compile_id = ' . $this->db()->quote($compile_id);
        }
        // range test expiration time
        if ($exp_time !== null) {
            $where[] = 'modified < DATE_SUB(NOW(), INTERVAL ' . intval($exp_time) . ' SECOND)';
        }
        // equal test cache_id and match sub-groups
        if ($cache_id !== null) {
            $where[] =
                '(cache_id = ' .
                $this->db()->quote($cache_id) .
                ' OR cache_id LIKE ' .
                $this->db()->quote($cache_id . '|%') .
                ')';
        }
        // run delete query
        $query = $this->db()->query('DELETE FROM output_cache WHERE ' . join(' AND ', $where));
        return $query->rowCount();
    }
}