src/Core/Config/PreloadPConfigAdapter.php

   1 <?php\r
   2 \r
   3 namespace Friendica\Core\Config;\r
   4 \r
   5 use dba;\r
   6 use Exception;\r
   7 use Friendica\App;\r
   8 use Friendica\BaseObject;\r
   9 use Friendica\Database\DBM;\r
  10 \r
  11 require_once 'include/dba.php';\r
  12 \r
  13 /**\r
  14  * Preload User Configuration Adapter\r
  15  *\r
  16  * Minimizes the number of database queries to retrieve configuration values at the cost of memory.\r
  17  *\r
  18  * @author Hypolite Petovan <mrpetovan@gmail.com>\r
  19  */\r
  20 class PreloadPConfigAdapter extends BaseObject implements IPConfigAdapter\r
  21 {\r
  22         private $config_loaded = false;\r
  23 \r
  24         public function __construct($uid)\r
  25         {\r
  26                 $this->load($uid, 'config');\r
  27         }\r
  28 \r
  29         public function load($uid, $family)\r
  30         {\r
  31                 if ($this->config_loaded) {\r
  32                         return;\r
  33                 }\r
  34 \r
  35                 $pconfigs = dba::select('pconfig', ['cat', 'v', 'k'], ['uid' => $uid]);\r
  36                 while ($pconfig = dba::fetch($pconfigs)) {\r
  37                         self::getApp()->setPConfigValue($uid, $pconfig['cat'], $pconfig['k'], $pconfig['v']);\r
  38                 }\r
  39                 dba::close($pconfigs);\r
  40 \r
  41                 $this->config_loaded = true;\r
  42         }\r
  43 \r
  44         public function get($uid, $cat, $k, $default_value = null, $refresh = false)\r
  45         {\r
  46                 if ($refresh) {\r
  47                         $config = dba::selectFirst('pconfig', ['v'], ['uid' => $uid, 'cat' => $cat, 'k' => $k]);\r
  48                         if (DBM::is_result($config)) {\r
  49                                 self::getApp()->setPConfigValue($uid, $cat, $k, $config['v']);\r
  50                         } else {\r
  51                                 self::getApp()->deletePConfigValue($uid, $cat, $k);\r
  52                         }\r
  53                 }\r
  54 \r
  55                 $return = self::getApp()->getPConfigValue($uid, $cat, $k, $default_value);\r
  56 \r
  57                 return $return;\r
  58         }\r
  59 \r
  60         public function set($uid, $cat, $k, $value)\r
  61         {\r
  62                 // We store our setting values as strings.\r
  63                 // So we have to do the conversion here so that the compare below works.\r
  64                 // The exception are array values.\r
  65                 $compare_value = !is_array($value) ? (string)$value : $value;\r
  66 \r
  67                 if (self::getApp()->getPConfigValue($uid, $cat, $k) === $compare_value) {\r
  68                         return true;\r
  69                 }\r
  70 \r
  71                 self::getApp()->setPConfigValue($uid, $cat, $k, $value);\r
  72 \r
  73                 // manage array value\r
  74                 $dbvalue = is_array($value) ? serialize($value) : $value;\r
  75 \r
  76                 $result = dba::update('pconfig', ['v' => $dbvalue], ['uid' => $uid, 'cat' => $cat, 'k' => $k], true);\r
  77                 if (!$result) {\r
  78                         throw new Exception('Unable to store config value in [' . $uid . '][' . $cat . '][' . $k . ']');\r
  79                 }\r
  80 \r
  81                 return true;\r
  82         }\r
  83 \r
  84         public function delete($uid, $cat, $k)\r
  85         {\r
  86                 self::getApp()->deletePConfigValue($uid, $cat, $k);\r
  87 \r
  88                 $result = dba::delete('pconfig', ['uid' => $uid, 'cat' => $cat, 'k' => $k]);\r
  89 \r
  90                 return $result;\r
  91         }\r
  92 }\r