src/Core/Config/PreloadConfigAdapter.php

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