From 3c94ad6bb08c45164824373932d9d1780bb730bb Mon Sep 17 00:00:00 2001
From: Benjamin Renard <brenard@easter-eggs.com>
Date: Thu, 26 Sep 2024 13:53:45 +0200
Subject: [PATCH] LSlog::get_debug_backtrace_context(): add $with_args,
 $ignore_last_frames and $prefix arguments

---
 src/includes/class/class.LSlog.php | 31 +++++++++++++++++++++---------
 1 file changed, 22 insertions(+), 9 deletions(-)

diff --git a/src/includes/class/class.LSlog.php b/src/includes/class/class.LSlog.php
index 3543980b..344d363f 100644
--- a/src/includes/class/class.LSlog.php
+++ b/src/includes/class/class.LSlog.php
@@ -310,29 +310,42 @@ 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() {
+  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)
-      return "unknown context";
+    if (!is_array($traces) || count($traces) < ($ignore_last_frames + 1))
+      return $prefix."unknown context";
 
     $msg = array();
     $j=0;
-    for ($i=count($traces)-1; $i >= 1; $i--) {
+    for ($i=count($traces)-1; $i >= (is_int($ignore_last_frames)?$ignore_last_frames:1); $i--) {
       $j += 1;
       $trace = array("#$j");
       if (isset($traces[$i]['file']))
         $trace[] = $traces[$i]['file'].(isset($traces[$i]['line'])?":".$traces[$i]['line']:"");
+      $args = (
+        $with_args && isset($traces[$i]["args"])?
+        format_callable_args($traces[$i]["args"], $prefix):
+        ""
+      );
       if (isset($traces[$i]['class']) && isset($traces[$i]['function']))
-        $trace[] = $traces[$i]['class'] . " " . $traces[$i]['type'] . " " . $traces[$i]['function']. "()";
+        $trace[] = sprintf(
+          "%s %s %s(%s)",
+          $traces[$i]['class'], $traces[$i]['type'], $traces[$i]['function'], $args
+        );
       elseif (isset($traces[$i]['function']))
-        $trace[] = $traces[$i]['function']. "()";
-      $msg[] = implode(" - ", $trace);
+        $trace[] = sprintf("%s(%s)", $traces[$i]['function'], $args);
+      $msg[] = $prefix.implode(" - ", $trace);
     }
 
-    return implode("\n", $msg);
+    return $prefix.implode("$prefix\n", $msg);
   }
 
   /**