Remove DEBUG constant and use config value

* introduces config.php option 'debug' that defaults to false
* migrate DEBUG constant to config value
This commit is contained in:
Morris Jobke 2015-08-24 12:00:37 +02:00
parent a67a2272e7
commit e88b380973
8 changed files with 28 additions and 22 deletions

View File

@ -94,3 +94,12 @@ if ($installedVersion === '1.1.9' && (
} }
} }
} }
/**
* migrate old constant DEBUG to new config value 'debug'
*
* TODO: remove this in ownCloud 8.3
*/
if(defined('DEBUG') && DEBUG === true) {
\OC::$server->getConfig()->setSystemValue('debug', true);
}

View File

@ -1 +1 @@
1.1.10 1.1.11

View File

@ -20,12 +20,6 @@
* * use RST syntax * * use RST syntax
*/ */
/**
* Only enable this for local development and not in production environments
* This will disable the minifier and outputs some additional debug informations
*/
define('DEBUG', true);
$CONFIG = array( $CONFIG = array(
@ -1079,6 +1073,14 @@ $CONFIG = array(
*/ */
'memcache.locking' => '\\OC\\Memcache\\Redis', 'memcache.locking' => '\\OC\\Memcache\\Redis',
/**
* Set this ownCloud instance to debugging mode
*
* Only enable this for local development and not in production environments
* This will disable the minifier and outputs some additional debug information
*/
'debug' => false,
/** /**
* This entry is just here to show a warning in case somebody copied the sample * This entry is just here to show a warning in case somebody copied the sample
* configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION! * configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION!

View File

@ -62,7 +62,7 @@ if ($defaultExpireDateEnabled) {
$outgoingServer2serverShareEnabled = $config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'yes'; $outgoingServer2serverShareEnabled = $config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'yes';
$array = array( $array = array(
"oc_debug" => (defined('DEBUG') && DEBUG) ? 'true' : 'false', "oc_debug" => $config->getSystemValue('debug', false),
"oc_isadmin" => OC_User::isAdminUser(OC_User::getUser()) ? 'true' : 'false', "oc_isadmin" => OC_User::isAdminUser(OC_User::getUser()) ? 'true' : 'false',
"oc_webroot" => "\"".OC::$WEBROOT."\"", "oc_webroot" => "\"".OC::$WEBROOT."\"",
"oc_appswebroots" => str_replace('\\/', '/', json_encode($apps_paths)), // Ugly unescape slashes waiting for better solution "oc_appswebroots" => str_replace('\\/', '/', json_encode($apps_paths)), // Ugly unescape slashes waiting for better solution

View File

@ -582,7 +582,7 @@ class OC {
if (!defined('PHPUNIT_RUN')) { if (!defined('PHPUNIT_RUN')) {
$logger = \OC::$server->getLogger(); $logger = \OC::$server->getLogger();
OC\Log\ErrorHandler::setLogger($logger); OC\Log\ErrorHandler::setLogger($logger);
if (defined('DEBUG') and DEBUG) { if (\OC::$server->getConfig()->getSystemValue('debug', false)) {
OC\Log\ErrorHandler::register(true); OC\Log\ErrorHandler::register(true);
set_exception_handler(array('OC_Template', 'printExceptionErrorPage')); set_exception_handler(array('OC_Template', 'printExceptionErrorPage'));
} else { } else {
@ -1040,7 +1040,7 @@ class OC {
return false; return false;
} }
if (defined("DEBUG") && DEBUG) { if (\OC::$server->getConfig()->getSystemValue('debug', false)) {
\OCP\Util::writeLog('core', 'Trying to login from cookie', \OCP\Util::DEBUG); \OCP\Util::writeLog('core', 'Trying to login from cookie', \OCP\Util::DEBUG);
} }
@ -1093,11 +1093,12 @@ class OC {
self::cleanupLoginTokens($userId); self::cleanupLoginTokens($userId);
if (!empty($_POST["remember_login"])) { if (!empty($_POST["remember_login"])) {
if (defined("DEBUG") && DEBUG) { $config = self::$server->getConfig();
if ($config->getSystemValue('debug', false)) {
self::$server->getLogger()->debug('Setting remember login to cookie', array('app' => 'core')); self::$server->getLogger()->debug('Setting remember login to cookie', array('app' => 'core'));
} }
$token = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(32); $token = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(32);
self::$server->getConfig()->setUserValue($userId, 'login_token', $token, time()); $config->setUserValue($userId, 'login_token', $token, time());
OC_User::setMagicInCookie($userId, $token); OC_User::setMagicInCookie($userId, $token);
} else { } else {
OC_User::unsetMagicInCookie(); OC_User::unsetMagicInCookie();

View File

@ -47,8 +47,6 @@ class Config {
protected $configFilePath; protected $configFilePath;
/** @var string */ /** @var string */
protected $configFileName; protected $configFileName;
/** @var bool */
protected $debugMode;
/** /**
* @param string $configDir Path to the config dir, needs to end with '/' * @param string $configDir Path to the config dir, needs to end with '/'
@ -59,7 +57,6 @@ class Config {
$this->configFilePath = $this->configDir.$fileName; $this->configFilePath = $this->configDir.$fileName;
$this->configFileName = $fileName; $this->configFileName = $fileName;
$this->readData(); $this->readData();
$this->debugMode = (defined('DEBUG') && DEBUG);
} }
/** /**
@ -225,9 +222,6 @@ class Config {
private function writeData() { private function writeData() {
// Create a php file ... // Create a php file ...
$content = "<?php\n"; $content = "<?php\n";
if ($this->debugMode) {
$content .= "define('DEBUG',true);\n";
}
$content .= '$CONFIG = '; $content .= '$CONFIG = ';
$content .= var_export($this->cache, true); $content .= var_export($this->cache, true);
$content .= ";\n"; $content .= ";\n";

View File

@ -329,14 +329,14 @@ class Server extends SimpleContainer implements IServerContainer {
); );
}); });
$this->registerService('EventLogger', function (Server $c) { $this->registerService('EventLogger', function (Server $c) {
if (defined('DEBUG') and DEBUG) { if ($c->getSystemConfig()->getValue('debug', false)) {
return new EventLogger(); return new EventLogger();
} else { } else {
return new NullEventLogger(); return new NullEventLogger();
} }
}); });
$this->registerService('QueryLogger', function ($c) { $this->registerService('QueryLogger', function (Server $c) {
if (defined('DEBUG') and DEBUG) { if ($c->getSystemConfig()->getValue('debug', false)) {
return new QueryLogger(); return new QueryLogger();
} else { } else {
return new NullQueryLogger(); return new NullQueryLogger();

View File

@ -233,7 +233,7 @@ class OC_Template extends \OC\Template\Base {
$content->assign('file', $exception->getFile()); $content->assign('file', $exception->getFile());
$content->assign('line', $exception->getLine()); $content->assign('line', $exception->getLine());
$content->assign('trace', $exception->getTraceAsString()); $content->assign('trace', $exception->getTraceAsString());
$content->assign('debugMode', defined('DEBUG') && DEBUG === true); $content->assign('debugMode', \OC::$server->getSystemConfig()->getValue('debug', false));
$content->assign('remoteAddr', $request->getRemoteAddress()); $content->assign('remoteAddr', $request->getRemoteAddress());
$content->assign('requestID', $request->getId()); $content->assign('requestID', $request->getId());
$content->printPage(); $content->printPage();