PrivateBin/lib/Configuration.php

266 lines
9.3 KiB
PHP
Raw Normal View History

2015-09-23 05:21:31 +08:00
<?php
/**
2016-07-11 17:58:15 +08:00
* PrivateBin
2015-09-23 05:21:31 +08:00
*
* a zero-knowledge paste bin
*
2016-07-11 17:58:15 +08:00
* @link https://github.com/PrivateBin/PrivateBin
2015-09-23 05:21:31 +08:00
* @copyright 2012 Sébastien SAUVAGE (sebsauvage.net)
* @license https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
2020-01-09 02:31:06 +08:00
* @version 1.3.2
2015-09-23 05:21:31 +08:00
*/
2016-12-13 01:43:23 +08:00
2016-12-13 01:50:00 +08:00
namespace PrivateBin;
2016-07-21 23:09:48 +08:00
use Exception;
use PDO;
2017-10-09 01:23:33 +08:00
use PrivateBin\Persistence\DataStore;
2016-07-21 23:09:48 +08:00
2015-09-23 05:21:31 +08:00
/**
* Configuration
2015-09-23 05:21:31 +08:00
*
* parses configuration file, ensures default values present
*/
class Configuration
2015-09-23 05:21:31 +08:00
{
/**
* parsed configuration
*
* @var array
*/
private $_configuration;
/**
* default configuration
*
* @var array
*/
2016-07-11 20:15:20 +08:00
private static $_defaults = array(
2015-09-23 05:21:31 +08:00
'main' => array(
'name' => 'PrivateBin',
'discussion' => true,
'opendiscussion' => false,
'password' => true,
'fileupload' => false,
2015-09-23 05:21:31 +08:00
'burnafterreadingselected' => false,
'defaultformatter' => 'plaintext',
'syntaxhighlightingtheme' => null,
'sizelimit' => 10485760,
'template' => 'bootstrap',
'notice' => '',
'languageselection' => false,
'languagedefault' => '',
'urlshortener' => '',
'qrcode' => true,
'icon' => 'identicon',
'cspheader' => 'default-src \'none\'; manifest-src \'self\'; connect-src * blob:; script-src \'self\' \'unsafe-eval\'; style-src \'self\'; font-src \'self\'; img-src \'self\' data: blob:; media-src blob:; object-src blob:; sandbox allow-same-origin allow-scripts allow-forms allow-popups allow-modals',
'zerobincompatibility' => false,
'httpwarning' => true,
'compression' => 'zlib',
2015-09-23 05:21:31 +08:00
),
'expire' => array(
'default' => '1week',
),
'expire_options' => array(
'5min' => 300,
'10min' => 600,
'1hour' => 3600,
'1day' => 86400,
'1week' => 604800,
2015-09-23 05:21:31 +08:00
'1month' => 2592000,
'1year' => 31536000,
'never' => 0,
2015-09-23 05:21:31 +08:00
),
'formatter_options' => array(
'plaintext' => 'Plain Text',
2015-09-23 05:21:31 +08:00
'syntaxhighlighting' => 'Source Code',
'markdown' => 'Markdown',
2015-09-23 05:21:31 +08:00
),
'traffic' => array(
'limit' => 10,
2015-09-23 05:21:31 +08:00
'header' => null,
'dir' => 'data',
2015-09-23 05:21:31 +08:00
),
'purge' => array(
'limit' => 300,
'batchsize' => 10,
'dir' => 'data',
),
2015-09-23 05:21:31 +08:00
'model' => array(
'class' => 'Filesystem',
2015-09-23 05:21:31 +08:00
),
'model_options' => array(
'dir' => 'data',
),
);
/**
* parse configuration file and ensure default configuration values are present
*
* @throws Exception
*/
public function __construct()
{
$config = array();
$basePath = (getenv('CONFIG_PATH') !== false ? getenv('CONFIG_PATH') : PATH . 'cfg') . DIRECTORY_SEPARATOR;
2019-12-19 17:49:59 +08:00
$configIni = $basePath . 'conf.ini';
$configFile = $basePath . 'conf.php';
2019-12-19 17:49:59 +08:00
// rename INI files to avoid configuration leakage
if (is_readable($configIni)) {
DataStore::prependRename($configIni, $configFile, ';');
// cleanup sample, too
$configIniSample = $configIni . '.sample';
if (is_readable($configIniSample)) {
2019-12-19 17:49:59 +08:00
DataStore::prependRename($configIniSample, $basePath . 'conf.sample.php', ';');
}
}
if (is_readable($configFile)) {
$config = parse_ini_file($configFile, true);
foreach (array('main', 'model', 'model_options') as $section) {
if (!array_key_exists($section, $config)) {
throw new Exception(I18n::_('PrivateBin requires configuration section [%s] to be present in configuration file.', $section), 2);
}
2015-09-23 05:21:31 +08:00
}
}
$opts = '_options';
foreach (self::getDefaults() as $section => $values) {
// fill missing sections with default values
if (!array_key_exists($section, $config) || count($config[$section]) == 0) {
$this->_configuration[$section] = $values;
if (array_key_exists('dir', $this->_configuration[$section])) {
2015-09-23 05:21:31 +08:00
$this->_configuration[$section]['dir'] = PATH . $this->_configuration[$section]['dir'];
}
continue;
}
// provide different defaults for database model
elseif (
$section == 'model_options' && in_array(
$this->_configuration['model']['class'],
array('Database', 'privatebin_db', 'zerobin_db')
)
) {
$values = array(
'dsn' => 'sqlite:' . PATH . 'data' . DIRECTORY_SEPARATOR . 'db.sq3',
'tbl' => null,
'usr' => null,
'pwd' => null,
'opt' => array(PDO::ATTR_PERSISTENT => true),
);
}
// "*_options" sections don't require all defaults to be set
if (
$section !== 'model_options' &&
($from = strlen($section) - strlen($opts)) >= 0 &&
strpos($section, $opts, $from) !== false
) {
if (is_int(current($values))) {
$config[$section] = array_map('intval', $config[$section]);
2015-09-23 05:21:31 +08:00
}
$this->_configuration[$section] = $config[$section];
}
// check for missing keys and set defaults if necessary
else {
foreach ($values as $key => $val) {
if ($key == 'dir') {
$val = PATH . $val;
2015-09-23 05:21:31 +08:00
}
$result = $val;
if (array_key_exists($key, $config[$section])) {
if ($val === null) {
$result = $config[$section][$key];
} elseif (is_bool($val)) {
$val = strtolower($config[$section][$key]);
if (in_array($val, array('true', 'yes', 'on'))) {
$result = true;
} elseif (in_array($val, array('false', 'no', 'off'))) {
$result = false;
} else {
$result = (bool) $config[$section][$key];
}
} elseif (is_int($val)) {
$result = (int) $config[$section][$key];
} elseif (is_string($val) && !empty($config[$section][$key])) {
$result = (string) $config[$section][$key];
2015-09-23 05:21:31 +08:00
}
}
$this->_configuration[$section][$key] = $result;
2015-09-23 05:21:31 +08:00
}
}
}
// support for old config file format, before the fork was renamed and PSR-4 introduced
$this->_configuration['model']['class'] = str_replace(
'zerobin_', 'privatebin_',
$this->_configuration['model']['class']
);
$this->_configuration['model']['class'] = str_replace(
array('privatebin_data', 'privatebin_db'),
array('Filesystem', 'Database'),
$this->_configuration['model']['class']
);
// ensure a valid expire default key is set
if (!array_key_exists($this->_configuration['expire']['default'], $this->_configuration['expire_options'])) {
$this->_configuration['expire']['default'] = key($this->_configuration['expire_options']);
}
2015-09-23 05:21:31 +08:00
}
/**
* get configuration as array
*
2018-05-27 21:18:25 +08:00
* @return array
2015-09-23 05:21:31 +08:00
*/
public function get()
{
return $this->_configuration;
}
2016-07-11 20:15:20 +08:00
/**
* get default configuration as array
*
2018-05-27 21:18:25 +08:00
* @return array
2016-07-11 20:15:20 +08:00
*/
public static function getDefaults()
{
return self::$_defaults;
}
2015-09-23 05:21:31 +08:00
/**
* get a key from the configuration, typically the main section or all keys
*
* @param string $key
* @param string $section defaults to main
* @throws Exception
2018-05-27 21:18:25 +08:00
* @return mixed
2015-09-23 05:21:31 +08:00
*/
public function getKey($key, $section = 'main')
{
$options = $this->getSection($section);
if (!array_key_exists($key, $options)) {
throw new Exception(I18n::_('Invalid data.') . " $section / $key", 4);
2015-09-23 05:21:31 +08:00
}
return $this->_configuration[$section][$key];
}
/**
* get a section from the configuration, must exist
2015-09-23 05:21:31 +08:00
*
* @param string $section
2015-09-23 05:21:31 +08:00
* @throws Exception
2018-05-27 21:18:25 +08:00
* @return mixed
2015-09-23 05:21:31 +08:00
*/
public function getSection($section)
{
if (!array_key_exists($section, $this->_configuration)) {
throw new Exception(I18n::_('%s requires configuration section [%s] to be present in configuration file.', I18n::_($this->getKey('name')), $section), 3);
2015-09-23 05:21:31 +08:00
}
return $this->_configuration[$section];
}
}