george/PrivateBin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactoring configuration

Browse Source
This commit is contained in:
El RIDO
2015-09-22 23:21:31 +02:00
parent 9f68658106
commit 6d24ff824e
6 changed files with 308 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

191
lib/configuration.php Normal file
View File

@@ -0,0 +1,191 @@
<?php
/**
* ZeroBin
*
* a zero-knowledge paste bin
*
* @link http://sebsauvage.net/wiki/doku.php?id=php:zerobin
* @copyright 2012 Sébastien SAUVAGE (sebsauvage.net)
* @license http://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
* @version 0.21.1
*/
/**
* configuration
*
* parses configuration file, ensures default values present
*/
class configuration
{
/**
* parsed configuration
*
* @var array
*/
private $_configuration;
/**
* default configuration
*
* @var array
*/
private $_defaults = array(
'main' => array(
'discussion' => true,
'opendiscussion' => false,
'password' => true,
'fileupload' => false,
'burnafterreadingselected' => false,
'defaultformatter' => 'plaintext',
'syntaxhighlightingtheme' => null,
'sizelimit' => 2097152,
'template' => 'bootstrap',
'notice' => '',
'base64version' => '2.1.9',
'languageselection' => false,
),
'expire' => array(
'default' => '1week',
),
'expire_options' => array(
'5min' => 300,
'10min' => 600,
'1hour' => 3600,
'1day' => 86400,
'1week' => 604800,
'1month' => 2592000,
'1year' => 31536000,
'never' => 0,
),
'formatter_options' => array(
'plaintext' => 'Plain Text',
'syntaxhighlighting' => 'Source Code',
'markdown' => 'Markdown',
),
'traffic' => array(
'limit' => 10,
'header' => null,
'dir' => 'data',
),
'model' => array(
'class' => 'zerobin_data',
),
'model_options' => array(
'dir' => 'data',
),
);
/**
* parse configuration file and ensure default configuration values are present
*
* @throws Exception
*/
public function __construct()
{
$config = parse_ini_file(PATH . 'cfg' . DIRECTORY_SEPARATOR . 'conf.ini', true);
foreach (array('main', 'model') as $section) {
if (!array_key_exists($section, $config)) {
throw new Exception(i18n::_('ZeroBin requires configuration section [%s] to be present in configuration file.', $section), 2);
}
}
foreach ($this->_defaults as $section => $values)
{
if (!array_key_exists($section, $config))
{
$this->_configuration[$section] = $this->_defaults[$section];
if (array_key_exists('dir', $this->_configuration[$section]))
{
$this->_configuration[$section]['dir'] = PATH . $this->_configuration[$section]['dir'];
}
continue;
}
foreach ($values as $key => $val)
{
if ($key == 'dir')
{
$val = PATH . $val;
}
$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];
}
}
$this->_configuration[$section][$key] = $result;
}
}
}
/**
* get configuration as array
*
* return array
*/
public function get()
{
return $this->_configuration;
}
/**
* get a key from the configuration, typically the main section or all keys
*
* @param string $key
* @param string $section defaults to main
* @throws Exception
* return mixed
*/
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);
}
return $this->_configuration[$section][$key];
}
/**
* get a key from the configuration, typically the main section or all keys
*
* @param string $key if empty, return all configuration options
* @param string $section defaults to main
* @throws Exception
* return mixed
*/
public function getSection($section)
{
if (!array_key_exists($section, $this->_configuration))
{
throw new Exception(i18n::_('ZeroBin requires configuration section [%s] to be present in configuration file.', $section), 3);
}
return $this->_configuration[$section];
}
}

93
lib/zerobin.php
View File

@@ -32,14 +32,12 @@ class zerobin
const GENERIC_ERROR = 'Paste does not exist, has expired or has been deleted.';
/**
* configuration array
* configuration
*
* @access private
* @var array
* @var configuration
*/
private $_conf = array(
'model' => 'zerobin_data',
);
private $_conf;
/**
* data
@@ -164,13 +162,8 @@ class zerobin
);
}
$this->_conf = parse_ini_file(PATH . 'cfg' . DIRECTORY_SEPARATOR . 'conf.ini', true);
foreach (array('main', 'model') as $section) {
if (!array_key_exists($section, $this->_conf)) {
throw new Exception(i18n::_('ZeroBin requires configuration section [%s] to be present in configuration file.', $section), 2);
}
}
$this->_model = $this->_conf['model']['class'];
$this->_conf = new configuration;
$this->_model = $this->_conf->getKey('class', 'model');
}
/**
@@ -185,7 +178,7 @@ class zerobin
if(is_string($this->_model)) {
$this->_model = forward_static_call(
array($this->_model, 'getInstance'),
$this->_conf['model_options']
$this->_conf->getSection('model_options')
);
}
return $this->_model;
@@ -222,12 +215,12 @@ class zerobin
$attachmentname = $has_attachmentname ? $_POST['attachmentname'] : '';
// Make sure last paste from the IP address was more than X seconds ago.
trafficlimiter::setLimit($this->_conf['traffic']['limit']);
trafficlimiter::setPath($this->_conf['traffic']['dir']);
trafficlimiter::setLimit($this->_conf->getKey('limit', 'traffic'));
trafficlimiter::setPath($this->_conf->getKey('dir', 'traffic'));
$ipKey = 'REMOTE_ADDR';
if (array_key_exists('header', $this->_conf['traffic']))
if (($option = $this->_conf->getKey('header', 'traffic')) !== null)
{
$header = 'HTTP_' . $this->_conf['traffic']['header'];
$header = 'HTTP_' . $option;
if (array_key_exists($header, $_SERVER) && !empty($_SERVER[$header]))
{
$ipKey = $header;
@@ -237,12 +230,12 @@ class zerobin
1,
i18n::_(
'Please wait %d seconds between each post.',
$this->_conf['traffic']['limit']
$this->_conf->getKey('limit', 'traffic')
)
);
// Make sure content is not too big.
$sizelimit = (int) $this->_getMainConfig('sizelimit', 2097152);
$sizelimit = $this->_conf->getKey('sizelimit');
if (
strlen($data) + strlen($attachment) + strlen($attachmentname) > $sizelimit
) return $this->_return_message(
@@ -260,7 +253,7 @@ class zerobin
if($has_attachment)
{
if (
!$this->_getMainConfig('fileupload', false) ||
!$this->_conf->getKey('fileupload') ||
!sjcl::isValid($attachment) ||
!($has_attachmentname && sjcl::isValid($attachmentname))
) return $this->_return_message(1, 'Invalid attachment.');
@@ -273,13 +266,14 @@ class zerobin
if (array_key_exists('expire', $_POST) && !empty($_POST['expire']))
{
$selected_expire = (string) $_POST['expire'];
if (array_key_exists($selected_expire, $this->_conf['expire_options']))
$expire_options = $this->_conf->getSection('expire_options');
if (array_key_exists($selected_expire, $expire_options))
{
$expire = $this->_conf['expire_options'][$selected_expire];
$expire = $expire_options[$selected_expire];
}
else
{
$expire = $this->_conf['expire_options'][$this->_conf['expire']['default']];
$expire = $this->_conf->getKey($this->_conf->getKey('default', 'expire'), 'expire_options');
}
if ($expire > 0) $meta['expire_date'] = time() + $expire;
}
@@ -297,7 +291,7 @@ class zerobin
// Read open discussion flag.
if (
$this->_getMainConfig('discussion', true) &&
$this->_conf->getKey('discussion') &&
array_key_exists('opendiscussion', $_POST) &&
!empty($_POST['opendiscussion'])
)
@@ -314,9 +308,9 @@ class zerobin
if (array_key_exists('formatter', $_POST) && !empty($_POST['formatter']))
{
$formatter = $_POST['formatter'];
if (!array_key_exists($formatter, $this->_conf['formatter_options']))
if (!array_key_exists($formatter, $this->_conf->getSection('formatter_options')))
{
$formatter = $this->_getMainConfig('defaultformatter', 'plaintext');
$formatter = $this->_conf->getKey('defaultformatter');
}
$meta['formatter'] = $formatter;
}
@@ -488,7 +482,7 @@ class zerobin
}
// Make sure token is valid.
serversalt::setPath($this->_conf['traffic']['dir']);
serversalt::setPath($this->_conf->getKey('dir', 'traffic'));
if (!filter::slow_equals($deletetoken, hash_hmac('sha1', $dataid, serversalt::get())))
{
$this->_error = 'Wrong deletion token. Paste was not deleted.';
@@ -571,7 +565,7 @@ class zerobin
}
else
{
$paste->meta->formatter = $this->_getMainConfig('defaultformatter', 'plaintext');
$paste->meta->formatter = $this->_conf->getKey('defaultformatter');
}
}
@@ -613,17 +607,17 @@ class zerobin
// label all the expiration options
$expire = array();
foreach ($this->_conf['expire_options'] as $time => $seconds)
foreach ($this->_conf->getSection('expire_options') as $time => $seconds)
{
$expire[$time] = ($seconds == 0) ? i18n::_(ucfirst($time)): filter::time_humanreadable($time);
}
// translate all the formatter options
$formatters = array_map(array('i18n', 'translate'), $this->_conf['formatter_options']);
$formatters = array_map(array('i18n', 'translate'), $this->_conf->getSection('formatter_options'));
// set language cookie if that functionality was enabled
$languageselection = '';
if ($this->_getMainConfig('languageselection', false))
if ($this->_conf->getKey('languageselection'))
{
$languageselection = i18n::getLanguage();
setcookie('lang', $languageselection);
@@ -636,38 +630,23 @@ class zerobin
$page->assign('ERROR', i18n::_($this->_error));
$page->assign('STATUS', i18n::_($this->_status));
$page->assign('VERSION', self::VERSION);
$page->assign('DISCUSSION', $this->_getMainConfig('discussion', true));
$page->assign('OPENDISCUSSION', $this->_getMainConfig('opendiscussion', true));
$page->assign('DISCUSSION', $this->_conf->getKey('discussion'));
$page->assign('OPENDISCUSSION', $this->_conf->getKey('opendiscussion'));
$page->assign('MARKDOWN', array_key_exists('markdown', $formatters));
$page->assign('SYNTAXHIGHLIGHTING', array_key_exists('syntaxhighlighting', $formatters));
$page->assign('SYNTAXHIGHLIGHTINGTHEME', $this->_getMainConfig('syntaxhighlightingtheme', ''));
$page->assign('SYNTAXHIGHLIGHTINGTHEME', $this->_conf->getKey('syntaxhighlightingtheme'));
$page->assign('FORMATTER', $formatters);
$page->assign('FORMATTERDEFAULT', $this->_getMainConfig('defaultformatter', 'plaintext'));
$page->assign('NOTICE', i18n::_($this->_getMainConfig('notice', '')));
$page->assign('BURNAFTERREADINGSELECTED', $this->_getMainConfig('burnafterreadingselected', false));
$page->assign('PASSWORD', $this->_getMainConfig('password', true));
$page->assign('FILEUPLOAD', $this->_getMainConfig('fileupload', false));
$page->assign('BASE64JSVERSION', $this->_getMainConfig('base64version', '2.1.9'));
$page->assign('FORMATTERDEFAULT', $this->_conf->getKey('defaultformatter'));
$page->assign('NOTICE', i18n::_($this->_conf->getKey('notice')));
$page->assign('BURNAFTERREADINGSELECTED', $this->_conf->getKey('burnafterreadingselected'));
$page->assign('PASSWORD', $this->_conf->getKey('password'));
$page->assign('FILEUPLOAD', $this->_conf->getKey('fileupload'));
$page->assign('BASE64JSVERSION', $this->_conf->getKey('base64version'));
$page->assign('LANGUAGESELECTION', $languageselection);
$page->assign('LANGUAGES', i18n::getLanguageLabels(i18n::getAvailableLanguages()));
$page->assign('EXPIRE', $expire);
$page->assign('EXPIREDEFAULT', $this->_conf['expire']['default']);
$page->draw($this->_getMainConfig('template', 'page'));
}
/**
* get configuration option from [main] section, optionally set a default
*
* @access private
* @param string $option
* @param mixed $default (optional)
* @return mixed
*/
private function _getMainConfig($option, $default = false)
{
return array_key_exists($option, $this->_conf['main']) ?
$this->_conf['main'][$option] :
$default;
$page->assign('EXPIREDEFAULT', $this->_conf->getKey('default', 'expire'));
$page->draw($this->_conf->getKey('template'));
}
/**