Server : Apache/2.4.41 (Ubuntu) System : Linux journalup 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /var/www/html/lib/pkp/classes/db/
Upload File :
Current File : /var/www/html/lib/pkp/classes/db/SettingsDAO.inc.php
<?php
/**
* @file classes/db/SettingsDAO.inc.php
*
* Copyright (c) 2014-2020 Simon Fraser University
* Copyright (c) 2000-2020 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class SettingsDAO
* @ingroup db
*
* @brief Operations for retrieving and modifying settings.
*/
class SettingsDAO extends DAO {
/**
* Retrieve (and newly cache) all settings.
* @param $id int
* @return array Associative array of settings.
*/
function loadSettings($id) {
$settings = array();
$result = $this->retrieve(
'SELECT setting_name, setting_value, setting_type, locale FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ?',
(int) $id
);
while (!$result->EOF) {
$row = $result->getRowAssoc(false);
$value = $this->convertFromDB($row['setting_value'], $row['setting_type']);
if ($row['locale'] == '') $settings[$row['setting_name']] = $value;
else $settings[$row['setting_name']][$row['locale']] = $value;
$result->MoveNext();
}
$result->Close();
$cache = $this->_getCache($id);
if ($cache) $cache->setEntireCache($settings);
return $settings;
}
/**
* Retrieve cached settings, using the cache if available.
* @param $id int
* @return array Associative array of settings.
*/
function &getSettings($id) {
$cache = $this->_getCache($id);
if ($cache) return $cache->getContents();
return $this->loadSettings($id);
}
/**
* Retrieve a setting value.
* @param $id int
* @param $name string
* @param $locale string optional
* @return mixed
*/
function &getSetting($id, $name, $locale = null) {
if ($cache = $this->_getCache($id)) {
$returner = $cache->get($name);
} else {
$settings = $this->loadSettings($id);
if (isset($settings[$name])) $returner = $settings[$name];
else $returner = null;
}
if ($locale !== null) {
if (!isset($returner[$locale]) || !is_array($returner)) {
unset($returner);
$returner = null;
return $returner;
}
return $returner[$locale];
}
return $returner;
}
/**
* Callback for a cache miss.
* @param $cache Cache
* @param $id string
* @return mixed
*/
function _cacheMiss($cache, $id) {
$settings = $this->loadSettings($cache->getCacheId());
if (!isset($settings[$id])) {
$cache->setCache($id, null);
return null;
}
return $settings[$id];
}
/**
* 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="([^"]+)"}}', array($this, '_installer_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 conference settings from an XML file.
* @param $id int ID of scheduled conference/conference 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($id, $filename, $paramArray = array()) {
$xmlParser = new XMLParser();
$tree = $xmlParser->parse($filename);
if (!$tree) return false;
foreach ($tree->getChildren() as $setting) {
$nameNode = $setting->getChildByName('name');
$valueNode = $setting->getChildByName('value');
if (isset($nameNode) && isset($valueNode)) {
$type = $setting->getAttribute('type');
$isLocaleField = $setting->getAttribute('locale');
$name = $nameNode->getValue();
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(
$id,
$name,
$isLocaleField?array(AppLocale::getLocale() => $value):$value,
$type,
$isLocaleField
);
}
}
}
/**
* Used internally by conference setting installation code to perform translation function.
*/
function _installer_regexp_callback($matches) {
return __($matches[1]);
}
/**
* Add/update a setting.
* @param $id int
* @param $name string
* @param $value mixed
* @param $type string data type of the setting. If omitted, type will be guessed
* @param $isLocalized boolean
*/
function updateSetting($id, $name, $value, $type = null, $isLocalized = false) {
$keyFields = array('setting_name', 'locale', $this->_getPrimaryKeyColumn());
if (!$isLocalized) {
$value = $this->convertToDB($value, $type);
$this->replace($this->_getTableName(),
array(
$this->_getPrimaryKeyColumn() => $id,
'setting_name' => $name,
'setting_value' => $value,
'setting_type' => $type,
'locale' => ''
),
$keyFields
);
} else {
if (is_array($value)) foreach ($value as $locale => $localeValue) {
$this->update('DELETE FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ? AND setting_name = ? AND locale = ?', array($id, $name, $locale));
if (empty($localeValue)) continue;
$type = null;
$this->update('INSERT INTO ' . $this->_getTableName() . '
(' . $this->_getPrimaryKeyColumn() . ', setting_name, setting_value, setting_type, locale)
VALUES (?, ?, ?, ?, ?)',
array(
$id, $name, $this->convertToDB($localeValue, $type), $type, $locale
)
);
}
}
$cache = $this->_getCache($id);
if ($cache) $cache->setCache($name, $value);
}
/**
* Delete a setting.
* @param $id int
* @param $name string
*/
function deleteSetting($id, $name, $locale = null) {
$cache = $this->_getCache($id);
if ($cache) $cache->setCache($name, null);
$params = array($id, $name);
$sql = 'DELETE FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ? AND setting_name = ?';
if ($locale !== null) {
$params[] = $locale;
$sql .= ' AND locale = ?';
}
return $this->update($sql, $params);
}
/**
* Delete all settings for an ID.
* @param $id int
*/
function deleteById($id) {
$cache = $this->_getCache($id);
if ($cache) $cache->flush();
return $this->update(
'DELETE FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ?',
(int) $id
);
}
/**
* Get the settings cache for a given ID
* @param $id
* @return array|null (Null indicates caching disabled)
*/
function _getCache($id) {
$cacheName = $this->_getCacheName();
if ($cacheName === null) return null;
static $settingCache;
if (!isset($settingCache)) {
$settingCache = array();
}
if (!isset($settingCache[$id])) {
$cacheManager = CacheManager::getManager();
$settingCache[$id] = $cacheManager->getCache(
$cacheName, $id,
array($this, '_cacheMiss')
);
}
return $settingCache[$id];
}
/**
* Get the settings table name.
* @return string
*/
protected function _getTableName() {
assert(false); // Must be implemented by subclasses
}
/**
* Get the primary key column name.
*/
protected function _getPrimaryKeyColumn() {
assert(false); // Must be implemented by subclasses
}
/**
* Get the cache name.
* @return string|null Null disables caching.
*/
protected function _getCacheName() {
return null;
}
}
