File: SQLPermanentStorage.php

package info (click to toggle)
simplesamlphp 1.13.1-2%2Bdeb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 11,304 kB
  • sloc: php: 65,124; xml: 629; python: 376; sh: 193; perl: 185; makefile: 43
file content (210 lines) | stat: -rw-r--r-- 6,207 bytes parent folder | download | duplicates (2)
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?php

/**
 * SQLPermanentStorage
 * 
 * Generic SQL Store to store key value pairs. To be used in several other modules that needs
 * to store data permanently.
 *
 * @author Andreas Åkre Solberg <andreas@uninett.no>, UNINETT AS.
 * @package simpleSAMLphp
 */
class sspmod_core_Storage_SQLPermanentStorage {
	
	private $db;
	
	function __construct($name, $config = NULL) {
		if (is_null($config))
			$config = SimpleSAML_Configuration::getInstance();
		
		$datadir = $config->getPathValue('datadir', 'data/');
		
		if (!is_dir($datadir))
			throw new Exception('Data directory [' . $datadir. '] does not exist');
		if (!is_writable($datadir))
			throw new Exception('Data directory [' . $datadir. '] is not writable');
		
		$sqllitedir = $datadir . 'sqllite/';
		if (!is_dir($sqllitedir)) {
			mkdir($sqllitedir);
		}
		
		$dbfile = $sqllitedir . $name . '.sqllite';
		
		if ($this->db = new SQLiteDatabase($dbfile)) {
			$q = @$this->db->query('SELECT key1 FROM data LIMIT 1');
			if ($q === false) {
				$this->db->queryExec('
		CREATE TABLE data (
			key1 text, 
			key2 text,
			type text,
			value text,
			created timestamp,
			updated timestamp,
			expire timestamp,
			PRIMARY KEY (key1,key2,type)
		);
		');
			} 
		} else {
		    throw new Exception('Error creating SQL lite database [' . $dbfile . '].');
		}
	}

	public function set($type, $key1, $key2, $value, $duration = NULL) {
		if ($this->exists($type, $key1, $key2)) {
			$this->update($type, $key1, $key2, $value, $duration);
		} else {
			$this->insert($type, $key1, $key2, $value, $duration);
		}
	}

	private function insert($type, $key1, $key2, $value, $duration = NULL) {
		
		$setDuration = '';
		if (is_null($duration)) {
			$setDuration = 'NULL';
		} else {
			$setDuration = "'" . sqlite_escape_string(time() + $duration) . "'";
		}
		
		$query = "INSERT INTO data (key1,key2,type,created,updated,expire,value) VALUES (" . 
			"'" . sqlite_escape_string($key1) . "'," . 
			"'" . sqlite_escape_string($key2) . "'," . 
			"'" . sqlite_escape_string($type) . "'," . 
			"'" . sqlite_escape_string(time()) . "'," . 
			"'" . sqlite_escape_string(time()) . "'," . 
			$setDuration . "," .
			"'" . sqlite_escape_string(serialize($value)) . "')";
		$results = $this->db->queryExec($query);
		return $results;
	}
	
	private function update($type, $key1, $key2, $value, $duration = NULL) {
		
		$setDuration = '';
		if (is_null($duration)) {
			$setDuration = ", expire = NULL ";
		} else {
			$setDuration = ", expire = '" . sqlite_escape_string(time() + $duration) . "' ";
		}
		
		$query = "UPDATE data SET " . 
			"updated = '" . sqlite_escape_string(time()) . "'," . 
			"value = '" . sqlite_escape_string(serialize($value)) . "'" .
			$setDuration .
			"WHERE " . 
			"key1 = '" . sqlite_escape_string($key1) . "' AND " . 
			"key2 = '" . sqlite_escape_string($key2) . "' AND " . 
			"type = '" . sqlite_escape_string($type) . "'";
		$results = $this->db->queryExec($query);
		# echo $query;
		# echo $this->db>changes;
		return $results;
	}

	public function get($type = NULL, $key1 = NULL, $key2 = NULL) {
		
		$condition = self::getCondition($type, $key1, $key2);
		$query = "SELECT * FROM data WHERE " . $condition;
		$results = $this->db->arrayQuery($query, SQLITE_ASSOC);
		
#		echo '<pre>type: ' . $type . ' key1:' . $key1 . '   ' . $query; print_r($results); exit;
		
		if (count($results) !== 1) return NULL;
		
		$res = $results[0];
		$res['value'] = unserialize($res['value']);
		return $res;
	}
	
	/*
	 * Return the value directly (not in a container)
	 */
	public function getValue($type = NULL, $key1 = NULL, $key2 = NULL) {
		$res = $this->get($type, $key1, $key2);
		if ($res === NULL) return NULL;
		return $res['value'];
	}
	
	public function exists($type, $key1, $key2) {
		$query = "SELECT * FROM data WHERE " . 
			"key1 = '" . sqlite_escape_string($key1) . "' AND " . 
			"key2 = '" . sqlite_escape_string($key2) . "' AND " . 
			"type = '" . sqlite_escape_string($type) . "' LIMIT 1";
		$results = $this->db->arrayQuery($query, SQLITE_ASSOC);
		return (count($results) == 1);
	}
		
	public function getList($type = NULL, $key1 = NULL, $key2 = NULL) {
		
		$condition = self::getCondition($type, $key1, $key2);
		$query = "SELECT * FROM data WHERE " . $condition;
		$results = $this->db->arrayQuery($query, SQLITE_ASSOC);
		if (count($results) == 0) return NULL;
		
		foreach($results AS $key => $value) {
			$results[$key]['value'] = unserialize($results[$key]['value']);
		}
		return $results;
	}
	
	public function getKeys($type = NULL, $key1 = NULL, $key2 = NULL, $whichKey = 'type') {

		if (!in_array($whichKey, array('key1', 'key2', 'type')))
			throw new Exception('Invalid key type');
			
		$condition = self::getCondition($type, $key1, $key2);
		
		$query = "SELECT DISTINCT " . $whichKey . " FROM data WHERE " . $condition;
		$results = $this->db->arrayQuery($query, SQLITE_ASSOC);

		if (count($results) == 0) return NULL;
		
		$resarray = array();
		foreach($results AS $key => $value) {
			$resarray[] = $value[$whichKey];
		}
		
		return $resarray;
	}
	
	
	public function remove($type, $key1, $key2) {
		$query = "DELETE FROM data WHERE " . 
			"key1 = '" . sqlite_escape_string($key1) . "' AND " . 
			"key2 = '" . sqlite_escape_string($key2) . "' AND " . 
			"type = '" . sqlite_escape_string($type) . "'";
		$results = $this->db->arrayQuery($query, SQLITE_ASSOC);
		return (count($results) == 1);
	}
	
	public function removeExpired() {
		$query = "DELETE FROM data WHERE expire NOT NULL AND expire < " . time();
		$this->db->arrayQuery($query, SQLITE_ASSOC);
		$changes = $this->db->changes();
		return $changes;
	}
	
	
	/**
	 * Create a SQL condition statement based on parameters
	 */
	private static function getCondition($type = NULL, $key1 = NULL, $key2 = NULL) {
		$conditions = array();
		
		if (!is_null($type)) $conditions[] = "type = '" . sqlite_escape_string($type) . "'";
		if (!is_null($key1)) $conditions[] = "key1 = '" . sqlite_escape_string($key1) . "'";
		if (!is_null($key2)) $conditions[] = "key2 = '" . sqlite_escape_string($key2) . "'";
		
		if (count($conditions) === 0) return '1';
		
		$condition = join(' AND ', $conditions);
		
		return $condition;
	}
	
	
}