aboutsummaryrefslogtreecommitdiffstats
path: root/include/config.php
blob: c999b76f2ebc4f21be6112e6feb326a1956cc60c (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
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?php
/**
 *
 * Arbitrary configuration storage
 * Note:
 * Please do not store booleans - convert to 0/1 integer values
 * The get_?config() functions return boolean false for keys that are unset,
 * and this could lead to subtle bugs.
 *
 * There are a few places in the code (such as the admin panel) where boolean
 * configurations need to be fixed as of 10/08/2011.
 *
 * @package config;
 */


/**
 * retrieve a "family" of config variables
 * from database to cached storage
 */
if(! function_exists('load_config')) {
	function load_config($family) {
		global $a;
		$r = q("SELECT * FROM `config` WHERE `cat` = '%s'",
				dbesc($family)
		);
		if(count($r)) {
			foreach($r as $rr) {
				$k = $rr['k'];
				if ($rr['cat'] === 'config') {
					$a->config[$k] = $rr['v'];
				} else {
					$a->config[$family][$k] = $rr['v'];
				}
			}
		}
	}
}

/**
 * get a particular config variable given the family name
 * and key. Returns false if not set.
 *
 * If a key is found in the DB but doesn't exist in
 * local config cache, pull it into the cache so we don't have
 *to hit the DB again for this item.
 */
if(! function_exists('get_config')) {
	function get_config($family, $key) {

		global $a;


		if(isset($a->config[$family][$key])) {
			if($a->config[$family][$key] === '!<unset>!') {
				return false;
			}
			return $a->config[$family][$key];
		}
		$ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
				dbesc($family),
				dbesc($key)
		);
		if(count($ret)) {
			// manage array value
			$val = (preg_match("|^a:[0-9]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
			$a->config[$family][$key] = $val;
			return $val;
		}
		else {
			$a->config[$family][$key] = '!<unset>!';
		}
		return false;
	}
}

/**
 * Store a config value ($value) in the category ($family)
 * under the key ($key)
 * 
 * Return the value, or false if the database update failed
 */
if(! function_exists('set_config')) {

function set_config($family,$key,$value) {
	global $a;
	
	// manage array value
	$dbvalue = (is_array($value)?serialize($value):$value);
	$dbvalue = (is_bool($value) ? intval($value) : $value);

		$a->config[$family][$key] = $value;
		$ret = q("REPLACE INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
				dbesc($family),
				dbesc($key),
				dbesc($dbvalue)
		);
		if($ret) {
			return $value;
		}
		return $ret;

	}
}


if(! function_exists('load_pconfig')) {
	function load_pconfig($uid,$family) {
		global $a;
		$r = q("SELECT * FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d",
				dbesc($family),
				intval($uid)
		);
		if(count($r)) {
			foreach($r as $rr) {
				$k = $rr['k'];
				$a->config[$uid][$family][$k] = $rr['v'];
			}
		}
	}
}


/**
 * get a particular user-specific config variable given the family name, 
 * the user id and key. Returns false if not set.
 *
 * If a key is found in the DB but doesn't exist in
 * local config cache, pull it into the cache so we don't have
 * to hit the DB again for this item.
 */
if(! function_exists('get_pconfig')) {
	function get_pconfig($uid,$family, $key) {

		global $a;


		if(isset($a->config[$uid][$family][$key])) {
			if($a->config[$uid][$family][$key] === '!<unset>!') {
				return false;
			}
			return $a->config[$uid][$family][$key];
		}


		$ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
				intval($uid),
				dbesc($family),
				dbesc($key)
		);

		if(count($ret)) {
			$val = (preg_match("|^a:[0-9]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
			$a->config[$uid][$family][$key] = $val;
			return $val;
		}
		else {
			$a->config[$uid][$family][$key] = '!<unset>!';
		}
		return false;
	}
}

/**
 * Delete a value from config. This function 
 * deletes both: db value and cache entry. 
 */
if(! function_exists('del_config')) {
	function del_config($family,$key) {

		global $a;
		if(x($a->config[$family],$key))
			unset($a->config[$family][$key]);
		$ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
				dbesc($family),
				dbesc($key)
		);
		return $ret;
	}
}


/**
 * Store a user-specific config value ($value) for user $uid in the category ($family)
 * under the key ($key). 
 * 
 * Return the value, or false if the database update failed
 */
if(! function_exists('set_pconfig')) {
	function set_pconfig($uid,$family,$key,$value) {

		global $a;

		// manage array value
		$dbvalue = (is_array($value)?serialize($value):$value);
		$dbvalue = (is_bool($value)?serialize($value):$value);


		$a->config[$uid][$family][$key] = $value;
		$ret = q("REPLACE INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ",
				intval($uid),
				dbesc($family),
				dbesc($key),
				dbesc($dbvalue)
		);
		if($ret) {
			return $value;
		}
		return $ret;

	}
}

if(! function_exists('del_pconfig')) {
	function del_pconfig($uid,$family,$key) {

		global $a;
		if(x($a->config[$uid][$family],$key))
			unset($a->config[$uid][$family][$key]);
		$ret = q("DELETE FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
				intval($uid),
				dbesc($family),
				dbesc($key)
		);
		return $ret;
	}
}