Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7396117
ChromePHPHandler.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
5 KB
Referenced Files
None
Subscribers
None
ChromePHPHandler.php
View Options
<?php
declare
(
strict_types
=
1
);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace
Monolog\Handler
;
use
Monolog\Formatter\ChromePHPFormatter
;
use
Monolog\Formatter\FormatterInterface
;
use
Monolog\Logger
;
use
Monolog\Utils
;
/**
* Handler sending logs to the ChromePHP extension (http://www.chromephp.com/)
*
* This also works out of the box with Firefox 43+
*
* @author Christophe Coevoet <stof@notk.org>
*
* @phpstan-import-type Record from \Monolog\Logger
*/
class
ChromePHPHandler
extends
AbstractProcessingHandler
{
use
WebRequestRecognizerTrait
;
/**
* Version of the extension
*/
protected
const
VERSION
=
'4.0'
;
/**
* Header name
*/
protected
const
HEADER_NAME
=
'X-ChromeLogger-Data'
;
/**
* Regular expression to detect supported browsers (matches any Chrome, or Firefox 43+)
*/
protected
const
USER_AGENT_REGEX
=
'{
\b
(?:Chrome/
\d
+(?:
\.\d
+)*|HeadlessChrome|Firefox/(?:4[3-9]|[5-9]
\d
|
\d
{3,})(?:
\.\d
)*)
\b
}'
;
/** @var bool */
protected
static
$initialized
=
false
;
/**
* Tracks whether we sent too much data
*
* Chrome limits the headers to 4KB, so when we sent 3KB we stop sending
*
* @var bool
*/
protected
static
$overflowed
=
false
;
/** @var mixed[] */
protected
static
$json
=
[
'version'
=>
self
::
VERSION
,
'columns'
=>
[
'label'
,
'log'
,
'backtrace'
,
'type'
],
'rows'
=>
[],
];
/** @var bool */
protected
static
$sendHeaders
=
true
;
public
function
__construct
(
$level
=
Logger
::
DEBUG
,
bool
$bubble
=
true
)
{
parent
::
__construct
(
$level
,
$bubble
);
if
(!
function_exists
(
'json_encode'
))
{
throw
new
\RuntimeException
(
'PHP
\'
s json extension is required to use Monolog
\'
s ChromePHPHandler'
);
}
}
/**
* {@inheritDoc}
*/
public
function
handleBatch
(
array
$records
):
void
{
if
(!
$this
->
isWebRequest
())
{
return
;
}
$messages
=
[];
foreach
(
$records
as
$record
)
{
if
(
$record
[
'level'
]
<
$this
->
level
)
{
continue
;
}
/** @var Record $message */
$message
=
$this
->
processRecord
(
$record
);
$messages
[]
=
$message
;
}
if
(!
empty
(
$messages
))
{
$messages
=
$this
->
getFormatter
()->
formatBatch
(
$messages
);
self
::
$json
[
'rows'
]
=
array_merge
(
self
::
$json
[
'rows'
],
$messages
);
$this
->
send
();
}
}
/**
* {@inheritDoc}
*/
protected
function
getDefaultFormatter
():
FormatterInterface
{
return
new
ChromePHPFormatter
();
}
/**
* Creates & sends header for a record
*
* @see sendHeader()
* @see send()
*/
protected
function
write
(
array
$record
):
void
{
if
(!
$this
->
isWebRequest
())
{
return
;
}
self
::
$json
[
'rows'
][]
=
$record
[
'formatted'
];
$this
->
send
();
}
/**
* Sends the log header
*
* @see sendHeader()
*/
protected
function
send
():
void
{
if
(
self
::
$overflowed
||
!
self
::
$sendHeaders
)
{
return
;
}
if
(!
self
::
$initialized
)
{
self
::
$initialized
=
true
;
self
::
$sendHeaders
=
$this
->
headersAccepted
();
if
(!
self
::
$sendHeaders
)
{
return
;
}
self
::
$json
[
'request_uri'
]
=
$_SERVER
[
'REQUEST_URI'
]
??
''
;
}
$json
=
Utils
::
jsonEncode
(
self
::
$json
,
Utils
::
DEFAULT_JSON_FLAGS
&
~
JSON_UNESCAPED_UNICODE
,
true
);
$data
=
base64_encode
(
$json
);
if
(
strlen
(
$data
)
>
3
*
1024
)
{
self
::
$overflowed
=
true
;
$record
=
[
'message'
=>
'Incomplete logs, chrome header size limit reached'
,
'context'
=>
[],
'level'
=>
Logger
::
WARNING
,
'level_name'
=>
Logger
::
getLevelName
(
Logger
::
WARNING
),
'channel'
=>
'monolog'
,
'datetime'
=>
new
\DateTimeImmutable
(),
'extra'
=>
[],
];
self
::
$json
[
'rows'
][
count
(
self
::
$json
[
'rows'
])
-
1
]
=
$this
->
getFormatter
()->
format
(
$record
);
$json
=
Utils
::
jsonEncode
(
self
::
$json
,
Utils
::
DEFAULT_JSON_FLAGS
&
~
JSON_UNESCAPED_UNICODE
,
true
);
$data
=
base64_encode
(
$json
);
}
if
(
trim
(
$data
)
!==
''
)
{
$this
->
sendHeader
(
static
::
HEADER_NAME
,
$data
);
}
}
/**
* Send header string to the client
*/
protected
function
sendHeader
(
string
$header
,
string
$content
):
void
{
if
(!
headers_sent
()
&&
self
::
$sendHeaders
)
{
header
(
sprintf
(
'%s: %s'
,
$header
,
$content
));
}
}
/**
* Verifies if the headers are accepted by the current user agent
*/
protected
function
headersAccepted
():
bool
{
if
(
empty
(
$_SERVER
[
'HTTP_USER_AGENT'
]))
{
return
false
;
}
return
preg_match
(
static
::
USER_AGENT_REGEX
,
$_SERVER
[
'HTTP_USER_AGENT'
])
===
1
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 14:02 (7 h, 41 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
5f/e4/8306ad3bbc6dd764c83aaf945d0c
Default Alt Text
ChromePHPHandler.php (5 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment