]> git.mxchange.org Git - friendica.git/blobdiff - include/config.php
Merge pull request #2112 from rabuzarus/2811_group_side
[friendica.git] / include / config.php
index c999b76f2ebc4f21be6112e6feb326a1956cc60c..05bcea6212d7769359febba441b6b79c36bfc161 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+
 /**
  *
  * Arbitrary configuration storage
  *
  * 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
- */
+// 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'];
-                               }
+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 ($family === 'config') {
+                               $a->config[$k] = $rr['v'];
+                       } else {
+                               $a->config[$family][$k] = $rr['v'];
                        }
                }
+       } 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.
 
-/**
- * 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) {
+function get_config($family, $key, $instore = false) {
 
-               global $a;
+       global $a;
 
+       if(! $instore) {
+               // Looking if the whole family isn't set
+               if(isset($a->config[$family])) {
+                       if($a->config[$family] === '!<unset>!') {
+                               return false;
+                       }
+               }
 
                if(isset($a->config[$family][$key])) {
                        if($a->config[$family][$key] === '!<unset>!') {
@@ -57,83 +62,143 @@ if(! function_exists('get_config')) {
                        }
                        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']);
+       }
+
+       // 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;
-                       return $val;
+
+                       if ($val === '!<unset>!')
+                               return false;
+                       else
+                               return $val;
                }
-               else {
-                       $a->config[$family][$key] = '!<unset>!';
+       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;
                }
-               return false;
+       */
+
+       $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]+:{.*}$|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>!';
 
-/**
- * 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')) {
+               // 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')) {
 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($value) ? intval($value) : $value);
-
+       $dbvalue = (is_bool($dbvalue) ? intval($dbvalue) : $dbvalue);
+       if(get_config($family,$key,true) === false) {
                $a->config[$family][$key] = $value;
-               $ret = q("REPLACE INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
-                               dbesc($family),
-                               dbesc($key),
-                               dbesc($dbvalue)
+               $ret = q("INSERT INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
+                       dbesc($family),
+                       dbesc($key),
+                       dbesc($dbvalue)
                );
-               if($ret) {
+               if($ret)
                        return $value;
-               }
                return $ret;
-
        }
-}
+
+       $ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'",
+               dbesc($dbvalue),
+               dbesc($family),
+               dbesc($key)
+       );
+
+       $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'];
-                       }
+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 ($family != 'config') {
+               // Negative caching
+               $a->config[$uid][$family] = "!<unset>!";
        }
-}
+}}
+
 
 
-/**\r
- * get a particular user-specific config variable given the family name, 
- * the user id and key. Returns false if not set.\r
- *\r
- * If a key is found in the DB but doesn't exist in\r
- * local config cache, pull it into the cache so we don't have\r
- * to hit the DB again for this item.\r
- */
 if(! function_exists('get_pconfig')) {
-       function get_pconfig($uid,$family, $key) {
+function get_pconfig($uid,$family, $key, $instore = false) {
 
-               global $a;
+       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>!') {
@@ -141,87 +206,136 @@ if(! function_exists('get_pconfig')) {
                        }
                        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']);
+       // 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($uid."|".$family."|".$key)) {
+                       $val = apc_fetch($uid."|".$family."|".$key);
                        $a->config[$uid][$family][$key] = $val;
-                       return $val;
-               }
-               else {
-                       $a->config[$uid][$family][$key] = '!<unset>!';
+
+                       if ($val === '!<unset>!')
+                               return false;
+                       else
+                               return $val;
                }
-               return false;
+       elseif (function_exists("xcache_get") AND function_exists("xcache_isset"))
+               if (xcache_isset($uid."|".$family."|".$key)) {
+                       $val = xcache_get($uid."|".$family."|".$key);
+                       $a->config[$uid][$family][$key] = $val;
+
+                       if ($val === '!<unset>!')
+                               return false;
+                       else
+                               return $val;
+               }*/
+
+
+       $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]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
+               $a->config[$uid][$family][$key] = $val;
+
+               // If APC is enabled then store the data there, else try XCache
+               /*if (function_exists("apc_store"))
+                       apc_store($uid."|".$family."|".$key, $val, 600);
+               elseif (function_exists("xcache_set"))
+                       xcache_set($uid."|".$family."|".$key, $val, 600);*/
+
+               return $val;
        }
-}
+       else {
+               $a->config[$uid][$family][$key] = '!<unset>!';
 
-/**
- * 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;
+               // If APC is enabled then store the data there, else try XCache
+               /*if (function_exists("apc_store"))
+                       apc_store($uid."|".$family."|".$key, '!<unset>!', 600);
+               elseif (function_exists("xcache_set"))
+                       xcache_set($uid."|".$family."|".$key, '!<unset>!', 600);*/
        }
-}
+       return false;
+}}
 
+if(! function_exists('del_config')) {
+function del_config($family,$key) {
 
-/**\r
- * Store a user-specific config value ($value) for user $uid in the category ($family)\r
- * under the key ($key). 
- * \r
- * Return the value, or false if the database update failed\r
- */
-if(! function_exists('set_pconfig')) {
-       function set_pconfig($uid,$family,$key,$value) {
+       global $a;
+       if(x($a->config[$family],$key))
+               unset($a->config[$family][$key]);
+       $ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s'",
+               dbesc($family),
+               dbesc($key)
+       );
+       // 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;
+}}
 
-               global $a;
 
-               // manage array value
-               $dbvalue = (is_array($value)?serialize($value):$value);
-               $dbvalue = (is_bool($value)?serialize($value):$value);
 
+// Same as above functions except these are for personal config storage and take an
+// additional $uid argument.
+
+if(! function_exists('set_pconfig')) {
+function set_pconfig($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("REPLACE INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ",
-                               intval($uid),
-                               dbesc($family),
-                               dbesc($key),
-                               dbesc($dbvalue)
+               $ret = q("INSERT INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ",
+                       intval($uid),
+                       dbesc($family),
+                       dbesc($key),
+                       dbesc($dbvalue)
                );
-               if($ret) {
+               if($ret) 
                        return $value;
-               }
                return $ret;
-
        }
-}
+       $ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
+               dbesc($dbvalue),
+               intval($uid),
+               dbesc($family),
+               dbesc($key)
+       );
+
+       $a->config[$uid][$family][$key] = $value;
+
+       // If APC is enabled then store the data there, else try XCache
+       /*if (function_exists("apc_store"))
+               apc_store($uid."|".$family."|".$key, $value, 600);
+       elseif (function_exists("xcache_set"))
+               xcache_set($uid."|".$family."|".$key, $value, 600);*/
+
+
+       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;
-       }
-}
+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'",
+               intval($uid),
+               dbesc($family),
+               dbesc($key)
+       );
+       return $ret;
+}}