Merge pull request #1039 from jonocodes/debug_env

feat(backend): introduce DEBUG_LOG env var

Author: kroky

.env.example

@@ -1,5 +1,7 @@
 APP_NAME=Cypht
 
+DEBUG_LOG=true
+
 DB_CONNECTION_TYPE=host
 DB_DRIVER=mysql
 DB_PORT=

config/app.php

@@ -781,6 +781,8 @@
     //     */
     //     'developer',
 
+        'debug_log' => env('DEBUG_LOG', false),
+
     //     /*
     //     | -------
     //     | Github

index.php

@@ -54,7 +54,7 @@
 new Hm_Dispatch($config);
 
 /* log some debug stats about the page */
-if (DEBUG_MODE) {
+if (DEBUG_MODE or $config->get('debug_log')) {
     Hm_Debug::load_page_stats();
     Hm_Debug::show();
 }

lib/environment.php

@@ -87,6 +87,7 @@ public function define_default_constants($config) {
         define('DEFAULT_INLINE_MESSAGE_STYLE', $config->get('default_setting_inline_message_style', 'right'));
         define('DEFAULT_ENABLE_KEYBOARD_SHORTCUTS', $config->get('default_setting_enable_keyboard_shortcuts', false));
         define('DEFAULT_ENABLE_SIEVE_FILTER', $config->get('default_setting_enable_sieve_filter', false));
+        define('DEFAULT_DEBUG_LOG', $config->get('debug_log', false));
     }
 
     /**

lib/module.php

@@ -347,7 +347,7 @@ public function __construct($parent, $page, $output = [], $protected = []) {
      * @return string
      */
     private function invalid_ajax_key() {
-        if (DEBUG_MODE) {
+        if (DEBUG_MODE or $this->config->get('debug_log')) {
             Hm_Debug::add('REQUEST KEY check failed');
             Hm_Debug::load_page_stats();
             Hm_Debug::show();

lib/modules_exec.php

@@ -234,7 +234,7 @@ public function __construct($config) {
      * @return void
      */
     public function process_module_setup() {
-        if (DEBUG_MODE) {
+        if (DEBUG_MODE or $this->site_config->get('debug_log')) {
             $this->setup_debug_modules();
         }
         else {

modules/core/output_modules.php

@@ -620,7 +620,7 @@ protected function output() {
             'var hm_is_logged = function () { return '.($this->get('is_logged') ? '1' : '0').'; };'.
             'var hm_empty_folder = function() { return "'.$this->trans('So alone').'"; };'.
             'var hm_mobile = function() { return '.($this->get('is_mobile') ? '1' : '0').'; };'.
-            'var hm_debug = function() { return "'.(DEBUG_MODE ? '1' : '0').'"; };'.
+            'var hm_debug = function() { return "' . ((DEBUG_MODE || DEFAULT_DEBUG_LOG) ? '1' : '0') . '"; };'.
             'var hm_mailto = function() { return '.($this->get('mailto_handler') ? '1' : '0').'; };'.
             'var hm_page_name = function() { return "'.$this->html_safe($this->get('router_page_name')).'"; };'.
             'var hm_language_direction = function() { return "'.$this->html_safe($this->dir).'"; };'.
@@ -1313,7 +1313,7 @@ class Hm_Output_main_menu_start extends Hm_Output_Module {
      */
     protected function output() {
         $res = '';
-        if (DEBUG_MODE) {
+        if (DEBUG_MODE or DEFAULT_DEBUG_LOG) {
             $res .= '<span title="'.
                 $this->trans('Running in debug mode. See https://cypht.org/install.html Section 6 for more detail.').
                 '" class="debug_title">'.$this->trans('Debug').'</span>';
@@ -1631,7 +1631,7 @@ class Hm_Output_content_section_start extends Hm_Output_Module {
      * Opens a main tag for the primary content section
      */
     protected function output() {
-        return '<main class="container-fluid content_cell" id="cypht-main"><div class="offline">'.$this->trans('Offline').'</div><div class="row m-0 position-relative">';
+        return '<main class="container-fluid content_cell" id="cypht-main"><div class="offline">'.$this->trans('Offline').'</div><div class="row m-0">';
     }
 }
 

modules/desktop_notifications/modules.php

@@ -9,7 +9,7 @@
 
 class Hm_Output_push_js_include extends Hm_Output_Module {
     protected function output() {
-        if (DEBUG_MODE) {
+        if (DEBUG_MODE or DEFAULT_DEBUG_LOG) {
             return '<script type="text/javascript" src="third_party/push.min.js"></script>';
         }
     }

tests/phpunit/modules/core/output_modules.php

@@ -981,7 +981,7 @@ public function test_folder_list_end() {
     public function test_content_section_start() {
         $test = new Output_Test('content_section_start', 'core');
         $res = $test->run();
-        $this->assertEquals(array('<main class="container-fluid content_cell" id="cypht-main"><div class="offline">Offline</div><div class="row m-0 position-relative">'), $res->output_response);
+        $this->assertEquals(array('<main class="container-fluid content_cell" id="cypht-main"><div class="offline">Offline</div><div class="row m-0">'), $res->output_response);
     }
     /**
      * @preserveGlobalState disabled