LSlog: log PHP error suppressed with the @-operator at TRACE level and add a prefix to signal it

doc/src/conf/global/LSlog.md

@@ -8,6 +8,7 @@ $GLOBALS['LSlog'] = array(
   'level' => '[niveau]',
   'log_errors_context' => [booléen],
   'log_errors_context_with_args' => [booléen],
+  'log_errors_context_args_max_length' => [entier],
   'handlers' => array(
     '[handler 1]',
     array (
@@ -66,6 +67,12 @@ $GLOBALS['LSlog'] = array(
   inclus lors de la journalisation du contexte des erreurs.
   __Note :__ ce paramètre n'as aucun effet si le paramètre `log_errors_context` n'est pas activé.
 
+- `log_errors_context_args_max_length`
+
+  Ce paramètre permet de définir à partir de quelle longueur les arguments des méthodes/fonctions
+  appelées et journalisés seront tronqués (par défaut : `1000`). __Note :__ pour désactiver le
+  troncage, mettre ce paramètre à zéro.
+
 - `handlers`
 
   Tableau permettant de configurer les *handlers* de la journalisation. Chaque *handler* gère les

src/conf/config.inc.php

@@ -211,11 +211,14 @@ $GLOBALS['LSlog'] = array (
   // Global logs level (TRACE, DEBUG, INFO, WARNING, ERROR, FATAL)
   'level' => 'INFO',
 
-  // Log errors's context (=backtrace)
+  // Log errors's context (=backtrace, default: false)
   'log_errors_context' => true,
 
-  // Log errors's context with arguments of called method/functions
+  // Log errors's context with arguments of called method/functions (default: false)
-  'log_errors_context_with_args' => false,
+  // 'log_errors_context_with_args' => false,
+
+  // Truncate logged arguments in errors's context (default: 1000)
+  // 'log_errors_context_args_max_length' => 1000,
 
   /**
    * Logs handlers are components that logged message emitted by the application.

src/includes/class/class.LSlog.php

@@ -45,6 +45,12 @@ class LSlog {
    */
   private static $log_errors_context_with_args = false;
 
+  /**
+   * Log errors context with arguments
+   * @var int
+   */
+  private static $log_errors_context_args_max_length = 1000;
+
   /**
    * Configured handlers
    * @see self::start()
@@ -105,6 +111,7 @@ class LSlog {
     self :: $enabled = self :: getConfig('enable', false, 'bool');
     self :: $log_errors_context = self :: getConfig('log_errors_context', false, 'bool');
     self :: $log_errors_context_with_args = self :: getConfig('log_errors_context_with_args', false, 'bool');
+    self :: $log_errors_context_args_max_length = self :: getConfig('log_errors_context_args_max_length', 1000, 'int');
     self :: setLevel();
 
     // Load default handlers class
@@ -246,10 +253,11 @@ class LSlog {
    * @param string $level The message level
    * @param string $message The message
    * @param string|null $logger The logger name (optional, default: null)
+   * @param bool $do_not_include_context Set to true to disable context inclusion (optional, default: false)
    *
    * @return void
    **/
-  public static function logging($level, $message, $logger=null) {
+  public static function logging($level, $message, $logger=null, $do_not_include_context=false) {
     // Check LSlog is enabled
     if (!self :: $enabled)
       return;
@@ -267,10 +275,16 @@ class LSlog {
     }
 
     // Append context to message (if enabled)
-    if (self :: $log_errors_context && self :: checkLevel($level, "ERROR"))
+    $context = "";
-      $message .= "\n".self :: get_debug_backtrace_context(
+    if (
+      !$do_not_include_context
+      && self :: $log_errors_context
+      && self :: checkLevel($level, "ERROR")
+    )
+      $context = "\n  ".self :: get_debug_backtrace_context(
         self :: $log_errors_context_with_args,
-        2
+        2,
+        "  "
       );
 
     foreach (self :: $handlers as $handler) {
@@ -282,12 +296,12 @@ class LSlog {
         continue;
 
       // Logging on this handler
-      call_user_func(array($handler, 'logging'), $level, $message, $logger);
+      call_user_func(array($handler, 'logging'), $level, $message.$context, $logger);
     }
 
     if ($level == 'FATAL') {
       if (php_sapi_name() == "cli")
-        die($message);
+        die($message.$context);
       elseif (class_exists('LStemplate'))
         LStemplate :: fatal_error($message);
       else
@@ -333,11 +347,15 @@ class LSlog {
    * Generate current context backtrace
    * @param bool $with_args Add args (optional, default: false)
    * @param int|null $ignore_last_frames Ignore last frames (optional, default: 1)
+   * @param string|null $prefix Prefix to append at the beginning of each return lines (optional,
+   *                            default: no prefix)
    * @return string Current context backtrace
    **/
-  public static function get_debug_backtrace_context($with_args=false, $ignore_last_frames=null) {
+  public static function get_debug_backtrace_context($with_args=false, $ignore_last_frames=null, $prefix=null) {
+    $ignore_last_frames = is_int($ignore_last_frames)?$ignore_last_frames:1;
+    $prefix = is_string($prefix)?$prefix:"";
     $traces = debug_backtrace();
-    if (!is_array($traces) || count($traces) < 2)
+    if (!is_array($traces) || count($traces) < ($ignore_last_frames + 1))
       return "unknown context";
 
     $msg = array();
@@ -349,7 +367,11 @@ class LSlog {
         $trace[] = $traces[$i]['file'].(isset($traces[$i]['line'])?":".$traces[$i]['line']:"");
       $args = (
         $with_args && isset($traces[$i]["args"])?
-        format_callable_args($traces[$i]["args"]):
+        format_callable_args(
+          $traces[$i]["args"],
+          $prefix,
+          self :: $log_errors_context_args_max_length
+        ):
         ""
       );
       if (isset($traces[$i]['class']) && isset($traces[$i]['function']))
@@ -362,7 +384,7 @@ class LSlog {
       $msg[] = implode(" - ", $trace);
     }
 
-    return implode("\n", $msg);
+    return implode("\n$prefix", $msg);
   }
 
   /**
@@ -381,12 +403,23 @@ class LSlog {
   public static function exception($exception, $prefix=null, $fatal=true, $logger=null) {
     $message =
       ($prefix?"$prefix :\n":"An exception occured :\n").
-      self :: get_debug_backtrace_context(). "\n" .
+      implode(
-      "## ".$exception->getFile().":".$exception->getLine(). " : ". $exception->getMessage();
+        "\n",
-    if (is_null($logger))
+        array_map(
-      self :: logging(($fatal?'FATAL':'ERROR'), $message);
+          function($line) { return "  $line"; },
-    else
+          array_slice(
-      self :: logging(($fatal?'FATAL':'ERROR'), $message, $logger);
+            array_reverse(
+              explode(
+                "\n",
+                $exception->getTraceAsString()
+              ),
+              1
+            ),
+            1
+          )
+        )
+      )."\n    => ". $exception->getMessage();
+    self :: logging(($fatal?'FATAL':'ERROR'), $message, $logger, true);
   }
 
   /**
@@ -435,7 +468,18 @@ class LSlog {
     );
     $error = (isset($errnos2error[$errno])?$errnos2error[$errno]:'UNKNOWN');
     $level = (isset($errors2level[$error])?$errors2level[$error]:'ERROR');
-    self :: logging($level, "A PHP $error occured (#$errno) : $errstr [$errfile:$errline]");
+
+    // Log error suppressed with the @-operator at TRACE level and add a prefix to signal it
+    $prefix = "";
+    $error_reporting = error_reporting();
+    if ( !($error_reporting & $errno) ) {
+      $level = "TRACE";
+      $prefix = "[IGNORE BY @ OPERATOR] ";
+    }
+    self :: logging(
+      $level,
+      "{$prefix}A PHP $error occured (#$errno) : $errstr [$errfile:$errline]"
+    );
     return False;
   }
 

src/includes/functions.php

@@ -776,14 +776,45 @@ function format_callable($callable, $args=null) {
 /**
  * Format callable arguments for logging
  * @param array<mixed> $args Arguments
+ * @param string|null $prefix Prefix to append at the beginning of each return lines (optional,
+ *                            default: no prefix)
+ * @param int $arg_max_length Argument export max length: above, it will be truncated (optional,
+ *                            default: do not truncate)
  * @return string
  */
-function format_callable_args($args) {
+function format_callable_args($args, $prefix=null, $arg_max_length=null) {
   if (!is_array($args) || empty($args))
     return "";
+  $prefix = is_string($prefix)?$prefix:"";
   $formatted_args = [];
-  foreach($args as $arg)
+  $new_line = false;
-    $formatted_args[] = str_replace("\n", '\n', var_export($arg, true));
+  foreach($args as $arg) {
+    try {
+      $formatted = preg_replace(
+        "/\s=>\s+(array|\\\\)/m",
+        " => $1",
+        @var_export($arg, true)
+      );
+      if ($arg_max_length && mb_strlen($formatted) > $arg_max_length) {
+        $formatted = rtrim(substr($formatted, 0, $arg_max_length));
+        $formatted .= strpos($formatted, "\n")?"\n[...]":"[...]";
+      }
+      $formatted_args[] = $formatted;
+      $new_line = $new_line || (strpos($formatted, "\n") !== false);
+    }
+    catch (Exception $e) {
+      $formatted_args[] = "<".gettype($arg).">";
+    }
+  }
+  if ($new_line) {
+    for($i=0; $i < count($formatted_args); $i++) {
+      $formatted_args[$i] = implode(
+        "\n$prefix  ",
+        explode("\n", $formatted_args[$i])
+      );
+    }
+    return "\n$prefix  ".implode(",\n$prefix  ", $formatted_args)."\n$prefix";
+  }
   return implode(", ", $formatted_args);
 }