-
Notifications
You must be signed in to change notification settings - Fork 4
/
Normalizer.php
176 lines (168 loc) · 5.88 KB
/
Normalizer.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
/**
* @package Backtrace
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2020-2024 Brad Kent
* @version v2.2
* @link http://www.github.com/bkdotcom/Backtrace
*/
namespace bdk\Backtrace;
/**
* Normalize backtrace frames
*/
class Normalizer
{
/** @var array */
private static $backtraceTemp = array();
/** @var array */
private static $frameDefault = array(
'args' => array(),
'evalLine' => null,
'file' => null,
'function' => null, // function, Class::function, or Class->function
'line' => null,
'object' => null,
);
/**
* "Normalize" backtrace from debug_backtrace() or xdebug_get_function_stack();
*
* @param array $backtrace trace/stack from debug_backtrace() or xdebug_Get_function_stack()
*
* @return array
*/
public static function normalize($backtrace)
{
self::$backtraceTemp = array();
$frameTemp = array(
'class' => null,
'include_filename' => null,
'params' => null,
'type' => null,
);
$count = \count($backtrace);
$backtrace[] = array(); // add a frame so backtrace[$i + 1] is always a thing
for ($i = 0; $i < $count; $i++) {
$frame = \array_merge(self::$frameDefault, $frameTemp, $backtrace[$i]);
$frame = self::normalizeFrameFile($frame, $backtrace[$i + 1]);
$frame = self::normalizeFrameFunction($frame);
if (\in_array($frame['function'], array('call_user_func', 'call_user_func_array'), true)) {
// don't include this frame
// backtrace only includes when used within namespace and not fully-quallified
// \call_user_func(); // not in trace... same as calling func directly
continue;
}
if ($frame['params']) {
// xdebug_get_function_stack
$frame['args'] = self::normalizeXdebugParams($frame['params']);
}
$frame = \array_intersect_key($frame, self::$frameDefault);
\ksort($frame);
self::$backtraceTemp[] = $frame;
}
return self::$backtraceTemp;
}
/**
* Normalize file value
*
* @param array $frame current frame
* @param array $frameNext next frrame
*
* @return array
*/
private static function normalizeFrameFile(array $frame, array &$frameNext)
{
$regexEvaldCode = '/^(.+)\((\d+)\) : eval\(\)\'d code$/';
$matches = array();
if ($frame['file'] === null) {
// use file/line from next frame
$frame = \array_merge(
$frame,
\array_intersect_key($frameNext, \array_flip(array('file', 'line')))
);
}
if (\preg_match($regexEvaldCode, (string) $frame['file'], $matches)) {
// reported line = line within eval
// line inside paren is the line `eval` is on
$frame['evalLine'] = $frame['line'];
$frame['file'] = $matches[1];
$frame['line'] = (int) $matches[2];
if (isset($frameNext['include_filename'])) {
// xdebug_get_function_stack puts the evaled code in include_filename
$frameNext['params'] = array($frameNext['include_filename']);
$frameNext['class'] = null;
$frameNext['function'] = 'eval';
$frameNext['include_filename'] = null;
}
}
if ($frame['include_filename']) {
// xdebug_get_function_stack
$frame['class'] = null;
$frame['args'] = array($frame['include_filename']);
$frame['function'] = 'include or require';
}
return $frame;
}
/**
* Normalize Function Combine class, type, & function
* unset if empty
*
* @param array $frame backtrace frame
*
* @return array
*/
private static function normalizeFrameFunction(array $frame)
{
$frame['type'] = \strtr((string) $frame['type'], array(
'dynamic' => '->',
'static' => '::',
));
if (\preg_match('/^(call_user_func(?:_array)?):\{.+:\d+\}$/', (string) $frame['function'], $matches)) {
// xdebug_get_function_stack
$frame['function'] = $matches[1];
}
if (\preg_match('/^(.*)\{closure(?::(.*):(\d*)-(\d*))?\}$/', (string) $frame['function'])) {
// both debug_backtrace and xdebug_get_function_stack may have the namespace prefix
// xdebug provides the filepath, start and end lines
$frame['function'] = '{closure}';
} elseif ($frame['class']) {
$frame['function'] = $frame['class'] . $frame['type'] . $frame['function'];
}
return $frame;
}
/**
* de-stringify most params
*
* @param array $params Xdebug frame "params"
*
* @return array
*/
private static function normalizeXdebugParams($params)
{
$map = array(
'FALSE' => false,
'NULL' => null,
'TRUE' => true,
);
$i = 0;
// some versions of xdebug have the wrong numeric key index...
// reindex
$keys = \array_map(static function ($key) use (&$i) {
return \is_string($key)
? $key
: $i++;
}, \array_keys($params));
$values = \array_map(static function ($param) use ($map) {
if ($param[0] === "'") {
return \substr(\stripslashes($param), 1, -1);
}
if (\is_numeric($param)) {
return $param * 1;
}
return \array_key_exists($param, $map)
? $map[$param]
: $param;
}, $params);
return \array_combine($keys, $values);
}
}