CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Disable logging in Class Basic and redirect all to Debug\Logging

Browse Source
This commit is contained in:
Clemens Schwaighofer
2021-06-11 20:47:42 +09:00
parent e80915cd5c
commit 448b54f5c1
2 changed files with 148 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
www/lib/CoreLibs/Basic.php
View File

@@ -51,9 +51,11 @@ class Basic
public $page_name; public $page_name;
public $host_name; public $host_name;
public $host_port; public $host_port;
// logging interface, Debug\Logging class
public $log;
// internal error reporting vars // internal error reporting vars
protected $error_id; // error ID for errors in classes /* protected $error_id; // error ID for errors in classes
protected $error_msg = array(); // the "connection" to the outside errors protected $error_msg = []; // the "connection" to the outside errors
// debug output prefix // debug output prefix
public $error_msg_prefix = ''; // prefix to the error string (the class name) public $error_msg_prefix = ''; // prefix to the error string (the class name)
// debug flags // debug flags
@@ -83,7 +85,7 @@ class Basic
public $log_per_page = false; // set, will split log per called file public $log_per_page = false; // set, will split log per called file
public $log_per_run = false; // create a new log file per run (time stamp + unique ID) public $log_per_run = false; // create a new log file per run (time stamp + unique ID)
// script running time // script running time
private $script_starttime; private $script_starttime; */
// email valid checks // email valid checks
public $email_regex_check = []; public $email_regex_check = [];
@@ -111,15 +113,16 @@ class Basic
// running time start for script // running time start for script
$this->script_starttime = microtime(true); $this->script_starttime = microtime(true);
// TODO make check dynamic for entries we MUST have depending on load type
// before we start any work, we should check that all MUST constants are defined // before we start any work, we should check that all MUST constants are defined
$abort = false; $abort = false;
foreach (array( foreach ([
'DS', 'DIR', 'BASE', 'ROOT', 'LIB', 'INCLUDES', 'LAYOUT', 'PICTURES', 'FLASH', 'VIDEOS', 'DOCUMENTS', 'PDFS', 'BINARIES', 'ICONS', 'DS', 'DIR', 'BASE', 'ROOT', 'LIB', 'INCLUDES', 'LAYOUT', 'PICTURES', 'FLASH', 'VIDEOS', 'DOCUMENTS', 'PDFS', 'BINARIES', 'ICONS',
'UPLOADS', 'CSV', 'JS', 'CSS', 'TABLE_ARRAYS', 'SMARTY', 'LANG', 'CACHE', 'TMP', 'LOG', 'TEMPLATES', 'TEMPLATES_C', 'UPLOADS', 'CSV', 'JS', 'CSS', 'TABLE_ARRAYS', 'SMARTY', 'LANG', 'CACHE', 'TMP', 'LOG', 'TEMPLATES', 'TEMPLATES_C',
'DEFAULT_LANG', 'DEFAULT_ENCODING', 'DEFAULT_HASH', 'DEFAULT_LANG', 'DEFAULT_ENCODING', 'DEFAULT_HASH',
'DEFAULT_ACL_LEVEL', 'LOGOUT_TARGET', 'PASSWORD_CHANGE', 'AJAX_REQUEST_TYPE', 'USE_PROTOTYPE', 'USE_SCRIPTACULOUS', 'USE_JQUERY', 'DEFAULT_ACL_LEVEL', 'LOGOUT_TARGET', 'PASSWORD_CHANGE', 'AJAX_REQUEST_TYPE', 'USE_PROTOTYPE', 'USE_SCRIPTACULOUS', 'USE_JQUERY',
'PAGE_WIDTH', 'MASTER_TEMPLATE_NAME', 'PUBLIC_SCHEMA', 'TEST_SCHEMA', 'DEV_SCHEMA', 'LIVE_SCHEMA', 'DB_CONFIG_NAME', 'DB_CONFIG', 'TARGET', 'DEBUG', 'SHOW_ALL_ERRORS' 'PAGE_WIDTH', 'MASTER_TEMPLATE_NAME', 'PUBLIC_SCHEMA', 'TEST_SCHEMA', 'DEV_SCHEMA', 'LIVE_SCHEMA', 'DB_CONFIG_NAME', 'DB_CONFIG', 'TARGET', 'DEBUG', 'SHOW_ALL_ERRORS'
) as $constant) { ] as $constant) {
if (!defined($constant)) { if (!defined($constant)) {
echo "Constant $constant misssing<br>"; echo "Constant $constant misssing<br>";
$abort = true; $abort = true;
@@ -134,20 +137,6 @@ class Basic
// always boolean false // always boolean false
$this->ajax_page_flag = isset($GLOBALS['AJAX_PAGE']) && $GLOBALS['AJAX_PAGE'] ? true : false; $this->ajax_page_flag = isset($GLOBALS['AJAX_PAGE']) && $GLOBALS['AJAX_PAGE'] ? true : false;
// set the page name
$this->page_name = \CoreLibs\Get\System::getPageName();
// set host name
list($this->host_name , $this->host_port) = \CoreLibs\Get\System::getHostName();
// init the log file id
// * GLOBALS
// * CONSTANT
// can be overridden with basicSetLogFileId
if (isset($GLOBALS['LOG_FILE_ID'])) {
$this->basicSetLogId($GLOBALS['LOG_FILE_ID']);
} elseif (defined('LOG_FILE_ID')) {
$this->basicSetLogId(LOG_FILE_ID);
}
// set the paths matching to the valid file types // set the paths matching to the valid file types
$this->data_path = [ $this->data_path = [
'P' => PICTURES, 'P' => PICTURES,
@@ -158,6 +147,21 @@ class Basic
'B' => BINARIES 'B' => BINARIES
]; ];
// set the page name
$this->page_name = \CoreLibs\Get\System::getPageName();
// set host name
list($this->host_name , $this->host_port) = \CoreLibs\Get\System::getHostName();
// logging interface moved here (->debug is now ->log->debug)
$this->log = new \CoreLibs\Debug\Logging();
// init the log file id
// * GLOBALS
// * CONSTANT
// can be overridden with basicSetLogFileId
/* if (isset($GLOBALS['LOG_FILE_ID'])) {
$this->basicSetLogId($GLOBALS['LOG_FILE_ID']);
} elseif (defined('LOG_FILE_ID')) {
$this->basicSetLogId(LOG_FILE_ID);
}
// if given via parameters, only for all // if given via parameters, only for all
$this->debug_output_all = false; $this->debug_output_all = false;
$this->echo_output_all = false; $this->echo_output_all = false;
@@ -210,7 +214,7 @@ class Basic
} }
if (isset($GLOBALS['LOG_PER_RUN'])) { if (isset($GLOBALS['LOG_PER_RUN'])) {
$this->log_per_run = $GLOBALS['LOG_PER_RUN']; $this->log_per_run = $GLOBALS['LOG_PER_RUN'];
} } */
// set the regex for checking emails // set the regex for checking emails
/** @deprecated */ /** @deprecated */
@@ -264,13 +268,12 @@ class Basic
* if non valid string is given it returns the previous set one only * if non valid string is given it returns the previous set one only
* @param string $string log file id string value * @param string $string log file id string value
* @return string returns the set log file id string * @return string returns the set log file id string
* @deprecated Use $basic->log->basicSetLogId() instead
*/ */
public function basicSetLogId(string $string): string public function basicSetLogId(string $string): string
{ {
if (preg_match("/^\w+$/", $string)) { trigger_error('Method '.__METHOD__.' is deprecated, use $basic->log->basicSetLogId() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
$this->log_file_id = $string; return $this->log->basicSetLogId($string);
}
return $this->log_file_id;
} }
// ****** DEBUG/ERROR FUNCTIONS ****** // ****** DEBUG/ERROR FUNCTIONS ******
@@ -354,21 +357,12 @@ class Basic
* @param string $flag on/off * @param string $flag on/off
* array $array of levels to turn on/off debug * array $array of levels to turn on/off debug
* @return void has no return * @return void has no return
* @deprecated Use $basic->log->debugFor() instead
*/ */
public function debugFor(string $type, string $flag): void public function debugFor(string $type, string $flag): void
{ {
$debug_on = func_get_args(); trigger_error('Method '.__METHOD__.' is deprecated, use $basic->log->debugFor() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
array_shift($debug_on); // kick out type $this->log->debugFor(...[func_get_args()]);
array_shift($debug_on); // kick out flag (on/off)
if (count($debug_on) >= 1) {
foreach ($debug_on as $level) {
$switch = $type.'_output';
if ($flag == 'off') {
$switch .= '_not';
}
$this->{$switch}[$level] = 1;
}
}
} }
/** /**
@@ -380,7 +374,7 @@ class Basic
* @param string $level level to check in detailed level flag * @param string $level level to check in detailed level flag
* @return bool true on access allowed or false on no access * @return bool true on access allowed or false on no access
*/ */
private function doDebugTrigger(string $target, string $level): bool /* private function doDebugTrigger(string $target, string $level): bool
{ {
$access = false; $access = false;
// check if we do debug, echo or print // check if we do debug, echo or print
@@ -426,7 +420,7 @@ class Basic
break; break;
} }
return $access; return $access;
} } */
/** /**
* write debug data to error_msg array * write debug data to error_msg array
@@ -439,7 +433,7 @@ class Basic
*/ */
public function debug(string $level, string $string, bool $strip = false): void public function debug(string $level, string $string, bool $strip = false): void
{ {
if ($this->doDebugTrigger('debug', $level)) { /* if ($this->doDebugTrigger('debug', $level)) {
if (!isset($this->error_msg[$level])) { if (!isset($this->error_msg[$level])) {
$this->error_msg[$level] = ''; $this->error_msg[$level] = '';
} }
@@ -466,7 +460,8 @@ class Basic
if ($this->doDebugTrigger('echo', $level)) { if ($this->doDebugTrigger('echo', $level)) {
$this->error_msg[$level] .= $error_string; $this->error_msg[$level] .= $error_string;
} }
} } */
$this->log->debug($level, $string, $strip);
} }
/** /**
@@ -474,15 +469,12 @@ class Basic
* only merges visible ones * only merges visible ones
* @param array $error_msg error array * @param array $error_msg error array
* @return void has no return * @return void has no return
* @deprecated Use $basic->log->mergeErrors() instead
*/ */
public function mergeErrors(array $error_msg = []): void public function mergeErrors(array $error_msg = []): void
{ {
if (!is_array($error_msg)) { trigger_error('Method '.__METHOD__.' is deprecated, use $basic->log->mergeErrors() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
$error_msg = []; $this->log->mergeErrors($error_msg);
}
foreach ($error_msg as $level => $msg) {
$this->error_msg[$level] .= $msg;
}
} }
/** /**
@@ -492,7 +484,7 @@ class Basic
*/ */
public function printErrorMsg(string $string = ''): string public function printErrorMsg(string $string = ''): string
{ {
$string_output = ''; /* $string_output = '';
if ($this->debug_output_all) { if ($this->debug_output_all) {
if ($this->error_msg_prefix) { if ($this->error_msg_prefix) {
$string = $this->error_msg_prefix; $string = $this->error_msg_prefix;
@@ -515,7 +507,8 @@ class Basic
$string_output .= '</div>'; $string_output .= '</div>';
} }
} }
return $string_output; return $string_output; */
return $this->log->printErrorMsg($string);
} }
/** /**
@@ -524,7 +517,7 @@ class Basic
* @param string $error_string error string to write * @param string $error_string error string to write
* @return void has no return * @return void has no return
*/ */
private function writeErrorMsg(string $level, string $error_string): void /* private function writeErrorMsg(string $level, string $error_string): void
{ {
// only write if write is requested // only write if write is requested
if ($this->doDebugTrigger('debug', $level) && if ($this->doDebugTrigger('debug', $level) &&
@@ -584,7 +577,7 @@ class Basic
echo "<!-- could not open file: $fn //-->"; echo "<!-- could not open file: $fn //-->";
} }
} // do write to file } // do write to file
} } */
/** /**
* unsests the error message array * unsests the error message array
@@ -592,16 +585,18 @@ class Basic
* if no level given resets all * if no level given resets all
* @param string $level optional level * @param string $level optional level
* @return void has no return * @return void has no return
* @deprecated Use $basic->log->resetErrorMsg() instead
*/ */
public function resetErrorMsg(string $level = ''): void public function resetErrorMsg(string $level = ''): void
{ {
if (!$level) { trigger_error('Method '.__METHOD__.' is deprecated, use $basic->log->resetErrorMsg() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
$this->error_msg = array(); $this->log->resetErrorMsg($level);
} elseif (isset($this->error_msg[$level])) {
unset($this->error_msg[$level]);
}
} }
// ****** DEBUG SUPPORT FUNCTIONS ******
// [!!! DEPRECATED !!!]
// Moved to \CoreLibs\Debug\Support
/** /**
* prints a html formatted (pre) array * prints a html formatted (pre) array
* @param array $array any array * @param array $array any array
@@ -831,8 +826,7 @@ class Basic
public static function arrayMergeRecursive() public static function arrayMergeRecursive()
{ {
trigger_error('MUST CHANGE: Method '.__METHOD__.' is deprecated, use \CoreLibs\Combined\ArrayHandler::arrayMergeRecursive()', E_USER_DEPRECATED); trigger_error('MUST CHANGE: Method '.__METHOD__.' is deprecated, use \CoreLibs\Combined\ArrayHandler::arrayMergeRecursive()', E_USER_DEPRECATED);
// return \CoreLibs\Combined\ArrayHandler::arrayMergeRecursive(); return \CoreLibs\Combined\ArrayHandler::arrayMergeRecursive(...func_get_args());
return ['PLEASE CONVERT TO: \CoreLibs\Combined\ArrayHandler::arrayMergeRecursive(a, b, c, ...)'];
} }
/** /**

190
www/lib/CoreLibs/Debug/Logging.php
View File

@@ -141,29 +141,7 @@ class Logging
$this->log_per_run = $GLOBALS['LOG_PER_RUN'] ?? false; $this->log_per_run = $GLOBALS['LOG_PER_RUN'] ?? false;
} }
/** // *** PRIVATE ***
* passes list of level names, to turn on debug
* eg $foo->debugFor('print', 'on', ['LOG', 'DEBUG', 'INFO']);
* @param string $type error, echo, print
* @param string $flag on/off
* array $array of levels to turn on/off debug
* @return void has no return
*/
public function debugFor(string $type, string $flag): void
{
$debug_on = func_get_args();
array_shift($debug_on); // kick out type
array_shift($debug_on); // kick out flag (on/off)
if (count($debug_on) >= 1) {
foreach ($debug_on as $level) {
$switch = $type.'_output';
if ($flag == 'off') {
$switch .= '_not';
}
$this->{$switch}[$level] = true;
}
}
}
/** /**
* checks if we have a need to work on certain debug output * checks if we have a need to work on certain debug output
@@ -219,6 +197,102 @@ class Logging
return $access; return $access;
} }
/**
* writes error msg data to file for current level
* @param string $level the level to write
* @param string $error_string error string to write
* @return bool True if message written, FAlse if not
*/
private function writeErrorMsg(string $level, string $error_string): bool
{
// only write if write is requested
if (!($this->doDebugTrigger('debug', $level) &&
$this->doDebugTrigger('print', $level))
) {
return false;
}
// replace all html tags
// $error_string = preg_replace("/(<\/?)(\w+)([^>]*>)/", "##\\2##", $error_string);
// $error_string = preg_replace("/(<\/?)(\w+)([^>]*>)/", "", $error_string);
// replace special line break tag
// $error_string = str_replace('<!--#BR#-->', "\n", $error_string);
// init output variable
$output = $error_string; // output formated error string to output file
// init base file path
$fn = BASE.LOG.$this->log_print_file.'.'.$this->log_file_name_ext;
// log ID prefix settings, if not valid, replace with empty
if (preg_match("/^[A-Za-z0-9]+$/", $this->log_file_id)) {
$rpl_string = '_'.$this->log_file_id;
} else {
$rpl_string = '';
}
$fn = str_replace('##LOGID##', $rpl_string, $fn); // log id (like a log file prefix)
if ($this->log_per_run) {
if (isset($GLOBALS['LOG_FILE_UNIQUE_ID'])) {
$this->log_file_unique_id = $GLOBALS['LOG_FILE_UNIQUE_ID'];
}
if (!$this->log_file_unique_id) {
$GLOBALS['LOG_FILE_UNIQUE_ID'] = $this->log_file_unique_id = date('Y-m-d_His').'_U_'.substr(hash('sha1', uniqid((string)mt_rand(), true)), 0, 8);
}
$rpl_string = '_'.$this->log_file_unique_id; // add 8 char unique string
} else {
$rpl_string = !$this->log_print_file_date ? '' : '_'.date('Y-m-d'); // add date to file
}
$fn = str_replace('##DATE##', $rpl_string, $fn); // create output filename
$rpl_string = !$this->log_per_level ? '' : '_'.$level; // if request to write to one file
$fn = str_replace('##LEVEL##', $rpl_string, $fn); // create output filename
$rpl_string = !$this->log_per_class ? '' : '_'.str_replace('\\', '-', get_class($this)); // set sub class settings
$fn = str_replace('##CLASS##', $rpl_string, $fn); // create output filename
$rpl_string = !$this->log_per_page ? '' : '_'.\CoreLibs\Get\System::getPageName(1); // if request to write to one file
$fn = str_replace('##PAGENAME##', $rpl_string, $fn); // create output filename
// write to file
// first check if max file size is is set and file is bigger
if ($this->log_max_filesize > 0 && ((filesize($fn) / 1024) > $this->log_max_filesize)) {
// for easy purpose, rename file only to attach timestamp, nur sequence numbering
rename($fn, $fn.'.'.date("YmdHis"));
}
$fp = fopen($fn, 'a');
if ($fp !== false) {
fwrite($fp, $output);
fclose($fp);
} else {
echo "<!-- could not open file: $fn //-->";
}
return true;
}
// *** PUBLIC ***
/**
* passes list of level names, to turn on debug
* eg $foo->debugFor('print', 'on', ['LOG', 'DEBUG', 'INFO']);
* @param string $type error, echo, print
* @param string $flag on/off
* array $array of levels to turn on/off debug
* @return void has no return
*/
public function debugFor(string $type, string $flag): void
{
$debug_on = func_get_args();
array_shift($debug_on); // kick out type
array_shift($debug_on); // kick out flag (on/off)
if (count($debug_on) >= 1) {
foreach ($debug_on as $level) {
$switch = $type.'_output';
if ($flag == 'off') {
$switch .= '_not';
}
$this->{$switch}[$level] = true;
}
}
}
/** /**
* write debug data to error_msg array * write debug data to error_msg array
* @param string $level id for error message, groups messages together * @param string $level id for error message, groups messages together
@@ -330,76 +404,6 @@ class Logging
return $string_output; return $string_output;
} }
/**
* writes error msg data to file for current level
* @param string $level the level to write
* @param string $error_string error string to write
* @return bool True if message written, FAlse if not
*/
private function writeErrorMsg(string $level, string $error_string): bool
{
// only write if write is requested
if (!($this->doDebugTrigger('debug', $level) &&
$this->doDebugTrigger('print', $level))
) {
return false;
}
// replace all html tags
// $error_string = preg_replace("/(<\/?)(\w+)([^>]*>)/", "##\\2##", $error_string);
// $error_string = preg_replace("/(<\/?)(\w+)([^>]*>)/", "", $error_string);
// replace special line break tag
// $error_string = str_replace('<!--#BR#-->', "\n", $error_string);
// init output variable
$output = $error_string; // output formated error string to output file
// init base file path
$fn = BASE.LOG.$this->log_print_file.'.'.$this->log_file_name_ext;
// log ID prefix settings, if not valid, replace with empty
if (preg_match("/^[A-Za-z0-9]+$/", $this->log_file_id)) {
$rpl_string = '_'.$this->log_file_id;
} else {
$rpl_string = '';
}
$fn = str_replace('##LOGID##', $rpl_string, $fn); // log id (like a log file prefix)
if ($this->log_per_run) {
if (isset($GLOBALS['LOG_FILE_UNIQUE_ID'])) {
$this->log_file_unique_id = $GLOBALS['LOG_FILE_UNIQUE_ID'];
}
if (!$this->log_file_unique_id) {
$GLOBALS['LOG_FILE_UNIQUE_ID'] = $this->log_file_unique_id = date('Y-m-d_His').'_U_'.substr(hash('sha1', uniqid((string)mt_rand(), true)), 0, 8);
}
$rpl_string = '_'.$this->log_file_unique_id; // add 8 char unique string
} else {
$rpl_string = !$this->log_print_file_date ? '' : '_'.date('Y-m-d'); // add date to file
}
$fn = str_replace('##DATE##', $rpl_string, $fn); // create output filename
$rpl_string = !$this->log_per_level ? '' : '_'.$level; // if request to write to one file
$fn = str_replace('##LEVEL##', $rpl_string, $fn); // create output filename
$rpl_string = !$this->log_per_class ? '' : '_'.str_replace('\\', '-', get_class($this)); // set sub class settings
$fn = str_replace('##CLASS##', $rpl_string, $fn); // create output filename
$rpl_string = !$this->log_per_page ? '' : '_'.\CoreLibs\Get\System::getPageName(1); // if request to write to one file
$fn = str_replace('##PAGENAME##', $rpl_string, $fn); // create output filename
// write to file
// first check if max file size is is set and file is bigger
if ($this->log_max_filesize > 0 && ((filesize($fn) / 1024) > $this->log_max_filesize)) {
// for easy purpose, rename file only to attach timestamp, nur sequence numbering
rename($fn, $fn.'.'.date("YmdHis"));
}
$fp = fopen($fn, 'a');
if ($fp !== false) {
fwrite($fp, $output);
fclose($fp);
} else {
echo "<!-- could not open file: $fn //-->";
}
return true;
}
/** /**
* unsests the error message array * unsests the error message array
* can be used if writing is primary to file * can be used if writing is primary to file