Move Introspection to Logger package

src/Core/Logger/Util/Introspection.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Core\Logger\Util;
+
+/**
+ * Get Introspection information about the current call
+ */
+class Introspection
+{
+	/** @var int  */
+	private $skipStackFramesCount;
+
+	/** @var string[] */
+	private $skipClassesPartials;
+
+	private $skipFunctions = [
+		'call_user_func',
+		'call_user_func_array',
+	];
+
+	/**
+	 * @param string[] $skipClassesPartials  An array of classes to skip during logging
+	 * @param int      $skipStackFramesCount If the logger should use information from other hierarchy levels of the call
+	 */
+	public function __construct(array $skipClassesPartials = [], int $skipStackFramesCount = 0)
+	{
+		$this->skipClassesPartials  = $skipClassesPartials;
+		$this->skipStackFramesCount = $skipStackFramesCount;
+	}
+
+	/**
+	 * Adds new classes to get skipped
+	 *
+	 * @param array $classNames
+	 */
+	public function addClasses(array $classNames)
+	{
+		$this->skipClassesPartials = array_merge($this->skipClassesPartials, $classNames);
+	}
+
+	/**
+	 * Returns the introspection record of the current call
+	 *
+	 * @return array
+	 */
+	public function getRecord(): array
+	{
+		$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+
+		$i = 1;
+
+		while ($this->isTraceClassOrSkippedFunction($trace, $i)) {
+			$i++;
+		}
+
+		$i += $this->skipStackFramesCount;
+
+		return [
+			'file'     => isset($trace[$i - 1]['file']) ? basename($trace[$i - 1]['file']) : null,
+			'line'     => $trace[$i - 1]['line'] ?? null,
+			'function' => $trace[$i]['function'] ?? null,
+		];
+	}
+
+	/**
+	 * Checks if the current trace class or function has to be skipped
+	 *
+	 * @param array $trace The current trace array
+	 * @param int   $index The index of the current hierarchy level
+	 *
+	 * @return bool True if the class or function should get skipped, otherwise false
+	 */
+	private function isTraceClassOrSkippedFunction(array $trace, int $index): bool
+	{
+		if (!isset($trace[$index])) {
+			return false;
+		}
+
+		if (isset($trace[$index]['class'])) {
+			foreach ($this->skipClassesPartials as $part) {
+				if (strpos($trace[$index]['class'], $part) !== false) {
+					return true;
+				}
+			}
+		} elseif (in_array($trace[$index]['function'], $this->skipFunctions)) {
+			return true;
+		}
+
+		return false;
+	}
+}