X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fconfig.php;h=585caf43ae1b3207f5bb317b71e90840da60532d;hb=d034822f079d063cffb607109bf1e0c03a9276e0;hp=df1070c13c6b61ab5c476e5874c619a229a85f7c;hpb=7f19d39b146844fd71d148690d3e550df9d3043b;p=friendica.git

diff --git a/include/config.php b/include/config.php
index df1070c13c..585caf43ae 100644
--- a/include/config.php
+++ b/include/config.php
@@ -1,8 +1,11 @@
 <?php
 
+require_once("include/PConfig.php");
+
 /**
- *
- * Arbitrary configuration storage
+ * @file include/config.php
+ * 
+ *  @brief 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,
@@ -12,39 +15,54 @@
  * configurations need to be fixed as of 10/08/2011.
  */
 
-
-// retrieve a "family" of config variables from database to cached storage
-
-if(! function_exists('load_config')) {
+/**
+ * @brief Loads all configuration values of family into a cached storage.
+ *
+ * All configuration values of the system are stored in global cache
+ * which is available under the global variable $a->config
+ *
+ * @param string $family
+ *  The category of the configuration value
+ * @return void
+ */
 function load_config($family) {
 	global $a;
-	$r = q("SELECT * FROM `config` WHERE `cat` = '%s'",
-		dbesc($family)
-	);
+
+	$r = q("SELECT `v`, `k` FROM `config` WHERE `cat` = '%s'", dbesc($family));
 	if(count($r)) {
 		foreach($r as $rr) {
 			$k = $rr['k'];
-			if ($rr['cat'] === 'config') {
+			if ($family === 'config') {
 				$a->config[$k] = $rr['v'];
 			} else {
 				$a->config[$family][$k] = $rr['v'];
 			}
 		}
-	} else if ($rr['cat'] != 'config') {
+	} else if ($family != 'config') {
 		// Negative caching
 		$a->config[$family] = "!<unset>!";
 	}
-}}
+}
 
-// get a particular config variable given the family name
-// and key. Returns false if not set.
-// $instore is only used by the set_config function
-// to determine if the key already exists in the DB
-// 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')) {
+/**
+ * @brief Get a particular user's config variable given the category name
+ * ($family) and a key.
+ *
+ * Get a particular config value from the given category ($family)
+ * and the $key from a cached storage in $a->config[$uid].
+ * $instore is only used by the set_config function
+ * to determine if the key already exists in the DB
+ * 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.
+ *
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to query
+ * @param boolean $instore Determines if the key already exists in the DB
+ * @return mixed Stored value or false if it does not exist
+ */
 function get_config($family, $key, $instore = false) {
 
 	global $a;
@@ -64,29 +82,86 @@ function get_config($family, $key, $instore = false) {
 			return $a->config[$family][$key];
 		}
 	}
+
+	// If APC is enabled then fetch the data from there, else try XCache
+	/*if (function_exists("apc_fetch") AND function_exists("apc_exists"))
+		if (apc_exists($family."|".$key)) {
+			$val = apc_fetch($family."|".$key);
+			$a->config[$family][$key] = $val;
+
+			if ($val === '!<unset>!')
+				return false;
+			else
+				return $val;
+		}
+	elseif (function_exists("xcache_fetch") AND function_exists("xcache_isset"))
+		if (xcache_isset($family."|".$key)) {
+			$val = xcache_fetch($family."|".$key);
+			$a->config[$family][$key] = $val;
+
+			if ($val === '!<unset>!')
+				return false;
+			else
+				return $val;
+		}
+	*/
+
 	$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']);
+		$val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
 		$a->config[$family][$key] = $val;
+
+		// If APC is enabled then store the data there, else try XCache
+		/*if (function_exists("apc_store"))
+			apc_store($family."|".$key, $val, 600);
+		elseif (function_exists("xcache_set"))
+			xcache_set($family."|".$key, $val, 600);*/
+
 		return $val;
 	}
 	else {
 		$a->config[$family][$key] = '!<unset>!';
+
+		// If APC is enabled then store the data there, else try XCache
+		/*if (function_exists("apc_store"))
+			apc_store($family."|".$key, '!<unset>!', 600);
+		elseif (function_exists("xcache_set"))
+			xcache_set($family."|".$key, '!<unset>!', 600);*/
 	}
 	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')) {
+/**
+ * @brief Sets a configuration value for system config
+ *
+ * Stores a config value ($value) in the category ($family) under the key ($key)
+ * for the user_id $uid.
+ *
+ * Note: Please do not store booleans - convert to 0/1 integer values!
+ *
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to set
+ * @param string $value
+ *  The value to store
+ * @return mixed Stored $value or false if the database update failed
+ */
 function set_config($family,$key,$value) {
 	global $a;
+
+	// If $a->config[$family] has been previously set to '!<unset>!', then
+	// $a->config[$family][$key] will evaluate to $a->config[$family][0], and
+	// $a->config[$family][$key] = $value will be equivalent to
+	// $a->config[$family][0] = $value[0] (this causes infuriating bugs),
+	// so unset the family before assigning a value to a family's key
+	if($a->config[$family] === '!<unset>!')
+		unset($a->config[$family]);
+
 	// manage array value
 	$dbvalue = (is_array($value)?serialize($value):$value);
 	$dbvalue = (is_bool($dbvalue) ? intval($dbvalue) : $dbvalue);
@@ -102,7 +177,7 @@ function set_config($family,$key,$value) {
 		return $ret;
 	}
 
-	$ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
+	$ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'",
 		dbesc($dbvalue),
 		dbesc($family),
 		dbesc($key)
@@ -110,132 +185,113 @@ function set_config($family,$key,$value) {
 
 	$a->config[$family][$key] = $value;
 
+	// If APC is enabled then store the data there, else try XCache
+	/*if (function_exists("apc_store"))
+		apc_store($family."|".$key, $value, 600);
+	elseif (function_exists("xcache_set"))
+		xcache_set($family."|".$key, $value, 600);*/
+
 	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'];
-		}
-	} else if ($rr['cat'] != 'config') {
-		// Negative caching
-		$a->config[$uid][$family] = "!<unset>!";
-	}
-}}
-
-
-
-if(! function_exists('get_pconfig')) {
-function get_pconfig($uid,$family, $key, $instore = false) {
-
-	global $a;
-
-	if(! $instore) {
-		// Looking if the whole family isn't set
-		if(isset($a->config[$uid][$family])) {
-			if($a->config[$uid][$family] === '!<unset>!') {
-				return false;
-			}
-		}
-
-		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;
-}}
-
-if(! function_exists('del_config')) {
+/**
+ * @brief Deletes the given key from the system configuration.
+ *
+ * Removes the configured value from the stored cache in $a->config
+ * and removes it from the database.
+ *
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to delete
+ * @return mixed
+ */
 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",
+	$ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s'",
 		dbesc($family),
 		dbesc($key)
 	);
-	return $ret;
-}}
+	// If APC is enabled then delete the data from there, else try XCache
+	/*if (function_exists("apc_delete"))
+		apc_delete($family."|".$key);
+	elseif (function_exists("xcache_unset"))
+		xcache_unset($family."|".$key);*/
 
+	return $ret;
+}
 
+/**
+ * @brief (Deprecated) Loads all configuration values of a user's config family into a cached storage.
+ *
+ * Note: This function is deprecated. Use PConfig::load() instead.
+ *
+ * @param string $uid
+ *  The user_id
+ * @param string $family
+ *  The category of the configuration value
+ * @return void
+ */
+function load_pconfig($uid,$family) {
+	return PConfig::load($uid, $family);
+}
 
-// Same as above functions except these are for personal config storage and take an
-// additional $uid argument.
+/**
+ * @brief (Deprecated) Get a particular user's config variable given the category name
+ * ($family) and a key.
+ *
+ * Note: This function is deprecated. Use PConfig::get() instead.
+ *
+ * @param string $uid
+ *  The user_id
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to query
+ * @param boolean $instore
+ * Determines if the key already exists in the DB
+ * @return mixed Stored value or false if it does not exist
+ */
+function get_pconfig($uid,$family, $key, $instore = false) {
+	return PConfig::get($uid, $family, $key, $instore);
+}
 
-if(! function_exists('set_pconfig')) {
+/**
+ * @brief (Deprecated) Sets a configuration value for a user
+ *
+ * Note: This function is deprecated. Use PConfig::set() instead.
+ *
+ * @param string $uid
+ *  The user_id
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to set
+ * @param string $value
+ *  The value to store
+ * @return mixed Stored $value or false
+ */
 function set_pconfig($uid,$family,$key,$value) {
+	return PConfig::set($uid, $family, $key, $value);
+}
 
-	global $a;
-
-	// manage array value
-	$dbvalue = (is_array($value)?serialize($value):$value);
-
-	if(get_pconfig($uid,$family,$key,true) === false) {
-		$a->config[$uid][$family][$key] = $value;
-		$ret = q("INSERT 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;
-	}
-	$ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
-		dbesc($dbvalue),
-		intval($uid),
-		dbesc($family),
-		dbesc($key)
-	);
-
-	$a->config[$uid][$family][$key] = $value;
-
-	if($ret)
-		return $value;
-	return $ret;
-}}
-
-if(! function_exists('del_pconfig')) {
+/**
+ * @brief (Deprecated) Deletes the given key from the users's configuration.
+ *
+ * Note: This function is deprecated. Use PConfig::delete() instead.
+ *
+ * @param string $uid The user_id
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to delete
+ * @return mixed
+ */
 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;
-}}
+	return PConfig::delete($uid, $family, $key);
+}