PluginSettingsDAO.inc.php

<?php
 
class PluginSettingsDAO extends DAO {
 
   function _getCache($contextId, $pluginName) {
      static $settingCache;
 
      if (!isset($settingCache)) {
         $settingCache = array();
      }
      if (!isset($settingCache[$contextId])) {
         $settingCache[$contextId] = array();
      }
      if (!isset($settingCache[$contextId][$pluginName])) {
         $cacheManager = CacheManager::getManager();
         $settingCache[$contextId][$pluginName] = $cacheManager->getCache(
            'pluginSettings-' . $contextId, $pluginName,
            array($this, '_cacheMiss')
         );
      }
      return $settingCache[$contextId][$pluginName];
   }
 
   function getSetting($contextId, $pluginName, $name) {
      // Normalize the plug-in name to lower case.
      $pluginName = strtolower_codesafe($pluginName);
 
      // Retrieve the setting.
      $cache = $this->_getCache($contextId, $pluginName);
      return $cache->get($name);
   }
 
   function settingExists($contextId, $pluginName, $name) {
      $pluginName = strtolower_codesafe($pluginName);
      $result = $this->retrieve(
         'SELECT COUNT(*) FROM plugin_settings WHERE plugin_name = ? AND context_id = ? AND setting_name = ?', array($pluginName, (int) $contextId, $name)
      );
      $returner = $result->fields[0] ? true : false;
      $result->Close();
      return $returner;
   }
 
   function _cacheMiss($cache, $id) {
      $contextParts = explode('-', $cache->getContext());
      $contextId = array_pop($contextParts);
      $settings = $this->getPluginSettings($contextId, $cache->getCacheId());
      if (!isset($settings[$id])) {
         // Make sure that even null values are cached
         $cache->setCache($id, null);
         return null;
      }
      return $settings[$id];
   }
 
   function getPluginSettings($contextId, $pluginName) {
      // Normalize plug-in name to lower case.
      $pluginName = strtolower_codesafe($pluginName);
 
      $result = $this->retrieve(
         'SELECT setting_name, setting_value, setting_type FROM plugin_settings WHERE plugin_name = ? AND context_id = ?', array($pluginName, (int) $contextId)
      );
 
      $pluginSettings = array();
      while (!$result->EOF) {
         $row = $result->getRowAssoc(false);
         $pluginSettings[$row['setting_name']] = $this->convertFromDB($row['setting_value'], $row['setting_type']);
         $result->MoveNext();
      }
      $result->Close();
 
      $cache = $this->_getCache($contextId, $pluginName);
      $cache->setEntireCache($pluginSettings);
 
      return $pluginSettings;
   }
 
   function updateSetting($contextId, $pluginName, $name, $value, $type = null) {
      // Normalize the plug-in name to lower case.
      $pluginName = strtolower_codesafe($pluginName);
 
      $cache = $this->_getCache($contextId, $pluginName);
      $cache->setCache($name, $value);
 
      $value = $this->convertToDB($value, $type);
 
      return $this->replace(
         'plugin_settings',
         array(
            'context_id' => (int) $contextId,
            'plugin_name' => $pluginName,
            'setting_name' => $name,
            'setting_value' => $value,
            'setting_type' => $type,
         ),
         array('context_id', 'plugin_name', 'setting_name')
      );
   }
 
   function deleteSetting($contextId, $pluginName, $name) {
      // Normalize the plug-in name to lower case.
      $pluginName = strtolower_codesafe($pluginName);
 
      $cache = $this->_getCache($contextId, $pluginName);
      $cache->setCache($name, null);
 
      return $this->update(
         'DELETE FROM plugin_settings WHERE plugin_name = ? AND setting_name = ? AND context_id = ?',
         array($pluginName, $name, (int) $contextId)
      );
   }
 
   function deleteSettingsByPlugin($contextId, $pluginName) {
      // Normalize the plug-in name to lower case.
      $pluginName = strtolower_codesafe($pluginName);
 
      $cache = $this->_getCache($contextId, $pluginName);
      $cache->flush();
 
      return $this->update(
         'DELETE FROM plugin_settings WHERE context_id = ? AND plugin_name = ?',
         array((int) $contextId, $pluginName)
      );
   }
 
   function deleteByContextId($contextId) {
      return $this->update(
         'DELETE FROM plugin_settings WHERE context_id = ?', (int) $contextId
      );
   }
 
   function _performReplacement($rawInput, $paramArray = array()) {
      $value = preg_replace_callback('{{translate key="([^"]+)"}}', '_installer_plugin_regexp_callback', $rawInput);
      foreach ($paramArray as $pKey => $pValue) {
         $value = str_replace('{$' . $pKey . '}', $pValue, $value);
      }
      return $value;
   }
 
   function _buildObject ($node, $paramArray = array()) {
      $value = array();
      foreach ($node->getChildren() as $element) {
         $key = $element->getAttribute('key');
         $childArray = $element->getChildByName('array');
         if (isset($childArray)) {
            $content = $this->_buildObject($childArray, $paramArray);
         } else {
            $content = $this->_performReplacement($element->getValue(), $paramArray);
         }
         if (!empty($key)) {
            $key = $this->_performReplacement($key, $paramArray);
            $value[$key] = $content;
         } else $value[] = $content;
      }
      return $value;
   }
 
   function installSettings($contextId, $pluginName, $filename, $paramArray = array()) {
      $xmlParser = new XMLParser();
      $tree = $xmlParser->parse($filename);
 
      if (!$tree) return false;
 
      // Check for existing settings and leave them if they are already in place.
      $currentSettings = $this->getPluginSettings($contextId, $pluginName);
 
      foreach ($tree->getChildren() as $setting) {
         $nameNode = $setting->getChildByName('name');
         $valueNode = $setting->getChildByName('value');
 
         if (isset($nameNode) && isset($valueNode)) {
            $type = $setting->getAttribute('type');
            $name = $nameNode->getValue();
 
            // If the setting already exists, respect it.
            if (isset($currentSettings[$name])) continue;
 
            if ($type == 'object') {
               $arrayNode = $valueNode->getChildByName('array');
               $value = $this->_buildObject($arrayNode, $paramArray);
            } else {
               $value = $this->_performReplacement($valueNode->getValue(), $paramArray);
            }
 
            // Replace translate calls with translated content
            $this->updateSetting($contextId, $pluginName, $name, $value, $type);
         }
      }
   }
}
 
function _installer_plugin_regexp_callback($matches) {
   return __($matches[1]);
}