aboutsummaryrefslogtreecommitdiff
path: root/caches/SQLiteCache.php
blob: e8d020a576dde506a32c0047885d2fb07f266e05 (plain) (blame)
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
<?php

/**
 * Cache based on SQLite 3 <https://www.sqlite.org>
 */
class SQLiteCache implements CacheInterface
{
    protected $scope;
    protected $key;

    private $db = null;

    public function __construct()
    {
        if (!extension_loaded('sqlite3')) {
            die('"sqlite3" extension not loaded. Please check "php.ini"');
        }

        if (!is_writable(PATH_CACHE)) {
            returnServerError(
                'RSS-Bridge does not have write permissions for '
                . PATH_CACHE . '!'
            );
        }

        $file = Configuration::getConfig(get_called_class(), 'file');
        if (empty($file)) {
            die('Configuration for ' . get_called_class() . ' missing. Please check your ' . FILE_CONFIG);
        }
        if (dirname($file) == '.') {
            $file = PATH_CACHE . $file;
        } elseif (!is_dir(dirname($file))) {
            die('Invalid configuration for ' . get_called_class() . '. Please check your ' . FILE_CONFIG);
        }

        if (!is_file($file)) {
            $this->db = new SQLite3($file);
            $this->db->enableExceptions(true);
            $this->db->exec("CREATE TABLE storage ('key' BLOB PRIMARY KEY, 'value' BLOB, 'updated' INTEGER)");
        } else {
            $this->db = new SQLite3($file);
            $this->db->enableExceptions(true);
        }
        $this->db->busyTimeout(5000);
    }

    public function loadData()
    {
        $Qselect = $this->db->prepare('SELECT value FROM storage WHERE key = :key');
        $Qselect->bindValue(':key', $this->getCacheKey());
        $result = $Qselect->execute();
        if ($result instanceof SQLite3Result) {
            $data = $result->fetchArray(SQLITE3_ASSOC);
            if (isset($data['value'])) {
                return unserialize($data['value']);
            }
        }

        return null;
    }

    public function saveData($data)
    {
        $Qupdate = $this->db->prepare('INSERT OR REPLACE INTO storage (key, value, updated) VALUES (:key, :value, :updated)');
        $Qupdate->bindValue(':key', $this->getCacheKey());
        $Qupdate->bindValue(':value', serialize($data));
        $Qupdate->bindValue(':updated', time());
        $Qupdate->execute();

        return $this;
    }

    public function getTime()
    {
        $Qselect = $this->db->prepare('SELECT updated FROM storage WHERE key = :key');
        $Qselect->bindValue(':key', $this->getCacheKey());
        $result = $Qselect->execute();
        if ($result instanceof SQLite3Result) {
            $data = $result->fetchArray(SQLITE3_ASSOC);
            if (isset($data['updated'])) {
                return $data['updated'];
            }
        }

        return null;
    }

    public function purgeCache($seconds)
    {
        $Qdelete = $this->db->prepare('DELETE FROM storage WHERE updated < :expired');
        $Qdelete->bindValue(':expired', time() - $seconds);
        $Qdelete->execute();
    }

    /**
    * Set scope
    * @return self
    */
    public function setScope($scope)
    {
        if (is_null($scope) || !is_string($scope)) {
            throw new \Exception('The given scope is invalid!');
        }

        $this->scope = $scope;
        return $this;
    }

    /**
    * Set key
    * @return self
    */
    public function setKey($key)
    {
        if (!empty($key) && is_array($key)) {
            $key = array_map('strtolower', $key);
        }
        $key = json_encode($key);

        if (!is_string($key)) {
            throw new \Exception('The given key is invalid!');
        }

        $this->key = $key;
        return $this;
    }

    ////////////////////////////////////////////////////////////////////////////

    private function getCacheKey()
    {
        if (is_null($this->key)) {
            throw new \Exception('Call "setKey" first!');
        }

        return hash('sha1', $this->scope . $this->key, true);
    }
}