| Server IP : 172.66.157.178 / Your IP : 172.16.20.3 Web Server : Apache/2.4.25 (Debian) System : Linux f64a392e70de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 User : application ( 1000) PHP Version : 5.6.40 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /app/classes/plugins/ |
Upload File : |
<?php
/**
* @file classes/plugins/PluginSettingsDAO.inc.php
*
* Copyright (c) 2013-2019 Simon Fraser University
* Copyright (c) 2003-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class PluginSettingsDAO
* @ingroup plugins
* @see Plugin
*
* @brief Operations for retrieving and modifying plugin settings.
*/
class PluginSettingsDAO extends DAO {
function &_getCache($journalId, $pluginName) {
static $settingCache;
if (!isset($settingCache)) {
$settingCache = array();
}
if (!isset($settingCache[$journalId])) {
$settingCache[$journalId] = array();
}
if (!isset($settingCache[$journalId][$pluginName])) {
$cacheManager =& CacheManager::getManager();
$settingCache[$journalId][$pluginName] =& $cacheManager->getFileCache(
'pluginSettings-' . $journalId, $pluginName,
array($this, '_cacheMiss')
);
}
return $settingCache[$journalId][$pluginName];
}
/**
* Retrieve a plugin setting value.
* @param $pluginName string
* @param $name
* @return mixed
*/
function getSetting($journalId, $pluginName, $name) {
// Normalize the plug-in name to lower case.
$pluginName = strtolower_codesafe($pluginName);
// Retrieve the setting.
$cache =& $this->_getCache($journalId, $pluginName);
return $cache->get($name);
}
function _cacheMiss(&$cache, $id) {
$contextParts = explode('-', $cache->getContext());
$journalId = array_pop($contextParts);
$settings =& $this->getPluginSettings($journalId, $cache->getCacheId());
if (!isset($settings[$id])) {
// Make sure that even null values are cached
$cache->setCache($id, null);
return null;
}
return $settings[$id];
}
/**
* Retrieve and cache all settings for a plugin.
* @param $journalId int
* @param $pluginName string
* @return array
*/
function &getPluginSettings($journalId, $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 journal_id = ?', array($pluginName, $journalId)
);
$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();
unset($result);
// Update the cache.
$cache =& $this->_getCache($journalId, $pluginName);
$cache->setEntireCache($pluginSettings);
return $pluginSettings;
}
/**
* Add/update a plugin setting.
* @param $journalId int
* @param $pluginName string
* @param $name string
* @param $value mixed
* @param $type string data type of the setting. If omitted, type will be guessed
*/
function updateSetting($journalId, $pluginName, $name, $value, $type = null) {
// Normalize the plug-in name to lower case.
$pluginName = strtolower_codesafe($pluginName);
$cache =& $this->_getCache($journalId, $pluginName);
$cache->setCache($name, $value);
$result = $this->retrieve(
'SELECT COUNT(*) FROM plugin_settings WHERE plugin_name = ? AND setting_name = ? AND journal_id = ?',
array($pluginName, $name, $journalId)
);
$count = $result->fields[0];
$result->Close();
unset($result);
$value = $this->convertToDB($value, $type);
if ($count == 0) {
$returner = $this->update(
'INSERT INTO plugin_settings
(plugin_name, journal_id, setting_name, setting_value, setting_type)
VALUES
(?, ?, ?, ?, ?)',
array($pluginName, $journalId, $name, $value, $type)
);
} else {
$returner = $this->update(
'UPDATE plugin_settings SET
setting_value = ?,
setting_type = ?
WHERE plugin_name = ? AND setting_name = ? AND journal_id = ?',
array($value, $type, $pluginName, $name, $journalId)
);
}
return $returner;
}
/**
* Delete a plugin setting.
* @param $journalId int
* @param $pluginName int
* @param $name string
*/
function deleteSetting($journalId, $pluginName, $name) {
// Normalize the plug-in name to lower case.
$pluginName = strtolower_codesafe($pluginName);
$cache =& $this->_getCache($journalId, $pluginName);
$cache->setCache($name, null);
return $this->update(
'DELETE FROM plugin_settings WHERE plugin_name = ? AND setting_name = ? AND journal_id = ?',
array($pluginName, $name, $journalId)
);
}
/**
* Delete all settings for a plugin.
* @param $journalId int
* @param $pluginName string
*/
function deleteSettingsByPlugin($pluginName, $journalId = null) {
// Normalize the plug-in name to lower case.
$pluginName = strtolower_codesafe($pluginName);
if ( $journalId ) {
$cache =& $this->_getCache($journalId, $pluginName);
$cache->flush();
return $this->update(
'DELETE FROM plugin_settings WHERE journal_id = ? AND plugin_name = ?',
array($journalId, $pluginName)
);
} else {
$cacheManager =& CacheManager::getManager();
// NB: this actually deletes all plugins' settings cache
$cacheManager->flush('pluginSettings', CACHE_TYPE_FILE);
return $this->update(
'DELETE FROM plugin_settings WHERE plugin_name = ?',
array($pluginName)
);
}
}
/**
* Delete all settings for a journal.
* @param $journalId int
*/
function deleteSettingsByJournalId($journalId) {
return $this->update(
'DELETE FROM plugin_settings WHERE journal_id = ?', $journalId
);
}
/**
* Used internally by installSettings to perform variable and translation replacements.
* @param $rawInput string contains text including variable and/or translate replacements.
* @param $paramArray array contains variables for replacement
* @returns string
*/
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;
}
/**
* Used internally by installSettings to recursively build nested arrays.
* Deals with translation and variable replacement calls.
* @param $node object XMLNode <array> tag
* @param $paramArray array Parameters to be replaced in key/value contents
*/
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;
}
/**
* Install plugin settings from an XML file.
* @param $journalId int
* @param $pluginName name of plugin for settings to apply to
* @param $filename string Name of XML file to parse and install
* @param $paramArray array Optional parameters for variable replacement in settings
*/
function installSettings($journalId, $pluginName, $filename, $paramArray = array()) {
$xmlParser = new XMLParser();
$tree = $xmlParser->parse($filename);
if (!$tree) {
$xmlParser->destroy();
return false;
}
// Check for existing settings and leave them if they are already in place.
$currentSettings =& $this->getPluginSettings($journalId, $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($journalId, $pluginName, $name, $value, $type);
}
}
$xmlParser->destroy();
}
}
/**
* Used internally by plugin setting installation code to perform translation function.
*/
function _installer_plugin_regexp_callback($matches) {
return __($matches[1]);
}
?>