mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Convert OC_Config to object interface

This commit is contained in:
Bart Visscher 2013-03-03 12:06:00 +01:00
parent 2208313e02
commit 07df94def6
5 changed files with 288 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
lib/config.php
View File

@ -34,17 +34,27 @@
*
*/
namespace OC;
/**
* This class is responsible for reading and writing config.php, the very basic
* configuration file of owncloud.
*/
class OC_Config{
class Config {
// associative array key => value
private static $cache = array();
protected $cache = array();
// Is the cache filled?
private static $init = false;
protected $config_dir;
protected $config_filename;
protected $debug_mode;
public function __construct($config_dir, $debug_mode) {
$this->config_dir = $config_dir;
$this->debug_mode = $debug_mode;
$this->config_filename = $this->config_dir.'config.php';
$this->readData();
}
/**
* @brief Lists all available config keys
* @return array with key names
@ -52,10 +62,8 @@ class OC_Config{
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
*/
public static function getKeys() {
self::readData();
return array_keys( self::$cache );
public function getKeys() {
return array_keys( $this->cache );
}
/**
@ -67,11 +75,9 @@ class OC_Config{
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
*/
public static function getValue( $key, $default = null ) {
self::readData();
if( array_key_exists( $key, self::$cache )) {
return self::$cache[$key];
public function getValue( $key, $default = null ) {
if( array_key_exists( $key, $this->cache )) {
return $this->cache[$key];
}
return $default;
@ -81,57 +87,43 @@ class OC_Config{
* @brief Sets a value
* @param string $key key
* @param string $value value
* @return bool
*
* This function sets the value and writes the config.php. If the file can
* not be written, false will be returned.
*/
public static function setValue( $key, $value ) {
self::readData();
public function setValue( $key, $value ) {
// Add change
self::$cache[$key] = $value;
$this->cache[$key] = $value;
// Write changes
self::writeData();
return true;
$this->writeData();
}
/**
* @brief Removes a key from the config
* @param string $key key
* @return bool
*
* This function removes a key from the config.php. If owncloud has no
* write access to config.php, the function will return false.
*/
public static function deleteKey( $key ) {
self::readData();
if( array_key_exists( $key, self::$cache )) {
public function deleteKey( $key ) {
if( array_key_exists( $key, $this->cache )) {
// Delete key from cache
unset( self::$cache[$key] );
unset( $this->cache[$key] );
// Write changes
self::writeData();
$this->writeData();
}
return true;
}
/**
* @brief Loads the config file
* @return bool
*
* Reads the config file and saves it to the cache
*/
private static function readData() {
if( self::$init ) {
return true;
}
private function readData() {
// read all file in config dir ending by config.php
$config_files = glob( OC::$SERVERROOT."/config/*.config.php");
$config_files = glob( $this->config_dir.'*.config.php');
//Filter only regular files
$config_files = array_filter($config_files, 'is_file');
@ -140,54 +132,49 @@ class OC_Config{
natsort($config_files);
// Add default config
array_unshift($config_files,OC::$SERVERROOT."/config/config.php");
array_unshift($config_files, $this->config_filename);
//Include file and merge config
foreach($config_files as $file){
foreach($config_files as $file) {
if( !file_exists( $file) ) {
continue;
}
unset($CONFIG);
include $file;
if( isset( $CONFIG ) && is_array( $CONFIG )) {
self::$cache = array_merge(self::$cache, $CONFIG);
$this->cache = array_merge($this->cache, $CONFIG);
}
}
// We cached everything
self::$init = true;
return true;
}
/**
* @brief Writes the config file
* @return bool
*
* Saves the config to the config file.
*
*/
public static function writeData() {
private function writeData() {
// Create a php file ...
$content = "<?php\n ";
if (defined('DEBUG') && DEBUG) {
$content = "<?php\n";
if ($this->debug_mode) {
$content .= "define('DEBUG',true);\n";
}
$content .= "\$CONFIG = ";
$content .= var_export(self::$cache, true);
$content .= '$CONFIG = ';
$content .= var_export($this->cache, true);
$content .= ";\n";
//var_dump($content, $this);
$filename = OC::$SERVERROOT."/config/config.php";
// Write the file
$result=@file_put_contents( $filename, $content );
$result=@file_put_contents( $this->config_filename, $content );
if(!$result) {
$tmpl = new OC_Template( '', 'error', 'guest' );
$tmpl->assign('errors', array(1=>array(
'error'=>"Can't write into config directory 'config'",
'hint'=>'You can usually fix this by giving the webserver user write access'
.' to the config directory in owncloud')));
$tmpl->printPage();
exit;
throw new HintException(
"Can't write into config directory 'config'",
'You can usually fix this by giving the webserver user write access'
.' to the config directory in owncloud');
}
// Prevent others not to read the config
@chmod($filename, 0640);
return true;
@chmod($this->config_filename, 0640);
}
}
require_once __DIR__.'/legacy/'.basename(__FILE__);

27
lib/hintexception.php Normal file
View File

@ -0,0 +1,27 @@
<?php
/**
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC;
class HintException extends \Exception
{
private $hint;
public function __construct($message, $hint, $code = 0, Exception $previous = null) {
$this->hint = $hint;
parent::__construct($message, $code, $previous);
}
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n";
}
public function getHint() {
return $this->hint;
}
}

98
lib/legacy/config.php Normal file
View File

@ -0,0 +1,98 @@
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/*
*
* An example of config.php
*
* <?php
* $CONFIG = array(
* "database" => "mysql",
* "firstrun" => false,
* "pi" => 3.14
* );
* ?>
*
*/
/**
* This class is responsible for reading and writing config.php, the very basic
* configuration file of owncloud.
*/
OC_Config::$object = new \OC\Config(OC::$SERVERROOT.'/config/', defined('DEBUG') && DEBUG);
class OC_Config{
public static $object;
/**
* @brief Lists all available config keys
* @return array with key names
*
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
*/
public static function getKeys() {
return self::$object->getKeys();
}
/**
* @brief Gets a value from config.php
* @param string $key key
* @param string $default = null default value
* @return string the value or $default
*
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
*/
public static function getValue( $key, $default = null ) {
return self::$object->getValue( $key, $default );
}
/**
* @brief Sets a value
* @param string $key key
* @param string $value value
*
* This function sets the value and writes the config.php. If the file can
* not be written, false will be returned.
*/
public static function setValue( $key, $value ) {
try {
self::$object->setValue( $key, $value );
} catch (\OC\HintException $e) {
\OC_Template::printErrorPage( $e->getMessage(), $e->getHint() );
}
}
/**
* @brief Removes a key from the config
* @param string $key key
*
* This function removes a key from the config.php. If owncloud has no
* write access to config.php, the function will return false.
*/
public static function deleteKey( $key ) {
try {
self::$object->deleteKey( $key );
} catch (\OC\HintException $e) {
\OC_Template::printErrorPage( $e->getMessage(), $e->getHint() );
}
}
}

16
lib/setup.php
View File

@ -1,21 +1,7 @@
<?php
class DatabaseSetupException extends Exception
class DatabaseSetupException extends \OC\HintException
{
private $hint;
public function __construct($message, $hint, $code = 0, Exception $previous = null) {
$this->hint = $hint;
parent::__construct($message, $code, $previous);
}
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n";
}
public function getHint() {
return $this->hint;
}
}
class OC_Setup {

113
tests/lib/config.php Normal file
View File

@ -0,0 +1,113 @@
<?php
/**
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
class Test_Config extends PHPUnit_Framework_TestCase {
const CONFIG_FILE = 'static://config.php';
const CONFIG_DIR = 'static://';
const TESTCONTENT = '<?php $CONFIG=array("foo"=>"bar");';
public function testReadData()
{
$config = new OC\Config(self::CONFIG_DIR, false);
$this->assertAttributeEquals(array(), 'cache', $config);
file_put_contents(self::CONFIG_FILE, self::TESTCONTENT);
$config = new OC\Config(self::CONFIG_DIR, false);
$this->assertAttributeEquals(array('foo'=>'bar'), 'cache', $config);
}
public function testGetKeys()
{
file_put_contents(self::CONFIG_FILE, self::TESTCONTENT);
$config = new OC\Config(self::CONFIG_DIR, false);
$this->assertEquals(array('foo'), $config->getKeys());
}
public function testGetValue()
{
file_put_contents(self::CONFIG_FILE, self::TESTCONTENT);
$config = new OC\Config(self::CONFIG_DIR, false);
$this->assertEquals('bar', $config->getValue('foo'));
$this->assertEquals(null, $config->getValue('bar'));
$this->assertEquals('moo', $config->getValue('bar', 'moo'));
}
public function testSetValue()
{
file_put_contents(self::CONFIG_FILE, self::TESTCONTENT);
$config = new OC\Config(self::CONFIG_DIR, false);
$config->setValue('foo', 'moo');
$this->assertAttributeEquals(array('foo'=>'moo'), 'cache', $config);
$content = file_get_contents(self::CONFIG_FILE);
$this->assertEquals(<<<EOL
<?php
\$CONFIG = array (
'foo' => 'moo',
);
EOL
, $content);
$config->setValue('bar', 'red');
$this->assertAttributeEquals(array('foo'=>'moo', 'bar'=>'red'), 'cache', $config);
$content = file_get_contents(self::CONFIG_FILE);
$this->assertEquals(<<<EOL
<?php
\$CONFIG = array (
'foo' => 'moo',
'bar' => 'red',
);
EOL
, $content);
}
public function testDeleteKey()
{
file_put_contents(self::CONFIG_FILE, self::TESTCONTENT);
$config = new OC\Config(self::CONFIG_DIR, false);
$config->deleteKey('foo');
$this->assertAttributeEquals(array(), 'cache', $config);
$content = file_get_contents(self::CONFIG_FILE);
$this->assertEquals(<<<EOL
<?php
\$CONFIG = array (
);
EOL
, $content);
}
public function testSavingDebugMode()
{
file_put_contents(self::CONFIG_FILE, self::TESTCONTENT);
$config = new OC\Config(self::CONFIG_DIR, true);
$config->deleteKey('foo'); // change something so we save to the config file
$this->assertAttributeEquals(array(), 'cache', $config);
$this->assertAttributeEquals(true, 'debug_mode', $config);
$content = file_get_contents(self::CONFIG_FILE);
$this->assertEquals(<<<EOL
<?php
define('DEBUG',true);
\$CONFIG = array (
);
EOL
, $content);
}
public function testWriteData()
{
$config = new OC\Config('/non-writable', false);
try {
$config->setValue('foo', 'bar');
} catch (\OC\HintException $e) {
return;
}
$this->fail();
}
}