Initial EV files
This commit is contained in:
Olu Amey
@@ -0,0 +1,510 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of the CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Debug;
|
||||
|
||||
use CodeIgniter\CodeIgniter;
|
||||
use CodeIgniter\Debug\Toolbar\Collectors\BaseCollector;
|
||||
use CodeIgniter\Debug\Toolbar\Collectors\Config;
|
||||
use CodeIgniter\Debug\Toolbar\Collectors\History;
|
||||
use CodeIgniter\Format\JSONFormatter;
|
||||
use CodeIgniter\Format\XMLFormatter;
|
||||
use CodeIgniter\HTTP\DownloadResponse;
|
||||
use CodeIgniter\HTTP\IncomingRequest;
|
||||
use CodeIgniter\HTTP\RequestInterface;
|
||||
use CodeIgniter\HTTP\Response;
|
||||
use CodeIgniter\HTTP\ResponseInterface;
|
||||
use Config\Services;
|
||||
use Config\Toolbar as ToolbarConfig;
|
||||
use Kint\Kint;
|
||||
|
||||
/**
|
||||
* Debug Toolbar
|
||||
*
|
||||
* Displays a toolbar with bits of stats to aid a developer in debugging.
|
||||
*
|
||||
* Inspiration: http://prophiler.fabfuel.de
|
||||
*/
|
||||
class Toolbar
|
||||
{
|
||||
/**
|
||||
* Toolbar configuration settings.
|
||||
*
|
||||
* @var ToolbarConfig
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* Collectors to be used and displayed.
|
||||
*
|
||||
* @var BaseCollector[]
|
||||
*/
|
||||
protected $collectors = [];
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param ToolbarConfig $config
|
||||
*/
|
||||
public function __construct(ToolbarConfig $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
|
||||
foreach ($config->collectors as $collector)
|
||||
{
|
||||
if (! class_exists($collector))
|
||||
{
|
||||
log_message('critical', 'Toolbar collector does not exists(' . $collector . ').' .
|
||||
'please check $collectors in the Config\Toolbar.php file.');
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->collectors[] = new $collector();
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns all the data required by Debug Bar
|
||||
*
|
||||
* @param float $startTime App start time
|
||||
* @param float $totalTime
|
||||
* @param RequestInterface $request
|
||||
* @param ResponseInterface $response
|
||||
*
|
||||
* @return string JSON encoded data
|
||||
*/
|
||||
public function run(float $startTime, float $totalTime, RequestInterface $request, ResponseInterface $response): string
|
||||
{
|
||||
/**
|
||||
* @var IncomingRequest $request
|
||||
* @var Response $response
|
||||
*/
|
||||
|
||||
// Data items used within the view.
|
||||
$data['url'] = current_url();
|
||||
$data['method'] = $request->getMethod(true);
|
||||
$data['isAJAX'] = $request->isAJAX();
|
||||
$data['startTime'] = $startTime;
|
||||
$data['totalTime'] = $totalTime * 1000;
|
||||
$data['totalMemory'] = number_format((memory_get_peak_usage()) / 1024 / 1024, 3);
|
||||
$data['segmentDuration'] = $this->roundTo($data['totalTime'] / 7);
|
||||
$data['segmentCount'] = (int) ceil($data['totalTime'] / $data['segmentDuration']);
|
||||
$data['CI_VERSION'] = CodeIgniter::CI_VERSION;
|
||||
$data['collectors'] = [];
|
||||
|
||||
foreach ($this->collectors as $collector)
|
||||
{
|
||||
$data['collectors'][] = $collector->getAsArray();
|
||||
}
|
||||
|
||||
foreach ($this->collectVarData() as $heading => $items)
|
||||
{
|
||||
$varData = [];
|
||||
|
||||
if (is_array($items))
|
||||
{
|
||||
foreach ($items as $key => $value)
|
||||
{
|
||||
if (is_string($value))
|
||||
{
|
||||
$varData[esc($key)] = esc($value);
|
||||
}
|
||||
else
|
||||
{
|
||||
$oldKintMode = Kint::$mode_default;
|
||||
$oldKintCalledFrom = Kint::$display_called_from;
|
||||
|
||||
Kint::$mode_default = Kint::MODE_RICH;
|
||||
Kint::$display_called_from = false;
|
||||
|
||||
$kint = @Kint::dump($value);
|
||||
$kint = substr($kint, strpos($kint, '</style>') + 8 );
|
||||
|
||||
Kint::$mode_default = $oldKintMode;
|
||||
Kint::$display_called_from = $oldKintCalledFrom;
|
||||
|
||||
$varData[esc($key)] = $kint;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$data['vars']['varData'][esc($heading)] = $varData;
|
||||
}
|
||||
|
||||
if (! empty($_SESSION))
|
||||
{
|
||||
foreach ($_SESSION as $key => $value)
|
||||
{
|
||||
// Replace the binary data with string to avoid json_encode failure.
|
||||
if (is_string($value) && preg_match('~[^\x20-\x7E\t\r\n]~', $value))
|
||||
{
|
||||
$value = 'binary data';
|
||||
}
|
||||
|
||||
$data['vars']['session'][esc($key)] = is_string($value) ? esc($value) : '<pre>' . esc(print_r($value, true)) . '</pre>';
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($request->getGet() as $name => $value)
|
||||
{
|
||||
$data['vars']['get'][esc($name)] = is_array($value) ? '<pre>' . esc(print_r($value, true)) . '</pre>' : esc($value);
|
||||
}
|
||||
|
||||
foreach ($request->getPost() as $name => $value)
|
||||
{
|
||||
$data['vars']['post'][esc($name)] = is_array($value) ? '<pre>' . esc(print_r($value, true)) . '</pre>' : esc($value);
|
||||
}
|
||||
|
||||
foreach ($request->headers() as $header)
|
||||
{
|
||||
$data['vars']['headers'][esc($header->getName())] = esc($header->getValueLine());
|
||||
}
|
||||
|
||||
foreach ($request->getCookie() as $name => $value)
|
||||
{
|
||||
$data['vars']['cookies'][esc($name)] = esc($value);
|
||||
}
|
||||
|
||||
$data['vars']['request'] = ($request->isSecure() ? 'HTTPS' : 'HTTP') . '/' . $request->getProtocolVersion();
|
||||
|
||||
$data['vars']['response'] = [
|
||||
'statusCode' => $response->getStatusCode(),
|
||||
'reason' => esc($response->getReason()),
|
||||
'contentType' => esc($response->getHeaderLine('content-type')),
|
||||
];
|
||||
|
||||
$data['config'] = Config::display();
|
||||
|
||||
if ($response->CSP !== null)
|
||||
{
|
||||
$response->CSP->addImageSrc('data:');
|
||||
}
|
||||
|
||||
return json_encode($data);
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Called within the view to display the timeline itself.
|
||||
*
|
||||
* @param array $collectors
|
||||
* @param float $startTime
|
||||
* @param integer $segmentCount
|
||||
* @param integer $segmentDuration
|
||||
* @param array $styles
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function renderTimeline(array $collectors, float $startTime, int $segmentCount, int $segmentDuration, array &$styles): string
|
||||
{
|
||||
$displayTime = $segmentCount * $segmentDuration;
|
||||
$rows = $this->collectTimelineData($collectors);
|
||||
$output = '';
|
||||
$styleCount = 0;
|
||||
|
||||
foreach ($rows as $row)
|
||||
{
|
||||
$output .= '<tr>';
|
||||
$output .= "<td>{$row['name']}</td>";
|
||||
$output .= "<td>{$row['component']}</td>";
|
||||
$output .= "<td class='debug-bar-alignRight'>" . number_format($row['duration'] * 1000, 2) . ' ms</td>';
|
||||
$output .= "<td class='debug-bar-noverflow' colspan='{$segmentCount}'>";
|
||||
|
||||
$offset = ((((float) $row['start'] - $startTime) * 1000) / $displayTime) * 100;
|
||||
$length = (((float) $row['duration'] * 1000) / $displayTime) * 100;
|
||||
|
||||
$styles['debug-bar-timeline-' . $styleCount] = "left: {$offset}%; width: {$length}%;";
|
||||
|
||||
$output .= "<span class='timer debug-bar-timeline-{$styleCount}' title='" . number_format($length, 2) . "%'></span>";
|
||||
$output .= '</td>';
|
||||
$output .= '</tr>';
|
||||
|
||||
$styleCount++;
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns a sorted array of timeline data arrays from the collectors.
|
||||
*
|
||||
* @param array $collectors
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function collectTimelineData($collectors): array
|
||||
{
|
||||
$data = [];
|
||||
|
||||
// Collect it
|
||||
foreach ($collectors as $collector)
|
||||
{
|
||||
if (! $collector['hasTimelineData'])
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
$data = array_merge($data, $collector['timelineData']);
|
||||
}
|
||||
|
||||
// Sort it
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns an array of data from all of the modules
|
||||
* that should be displayed in the 'Vars' tab.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function collectVarData(): array
|
||||
{
|
||||
$data = [];
|
||||
|
||||
foreach ($this->collectors as $collector)
|
||||
{
|
||||
if (! $collector->hasVarData())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
$data = array_merge($data, $collector->getVarData());
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Rounds a number to the nearest incremental value.
|
||||
*
|
||||
* @param float $number
|
||||
* @param integer $increments
|
||||
*
|
||||
* @return float
|
||||
*/
|
||||
protected function roundTo(float $number, int $increments = 5): float
|
||||
{
|
||||
$increments = 1 / $increments;
|
||||
|
||||
return (ceil($number * $increments) / $increments);
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Prepare for debugging..
|
||||
*
|
||||
* @param RequestInterface $request
|
||||
* @param ResponseInterface $response
|
||||
* @global \CodeIgniter\CodeIgniter $app
|
||||
* @return void
|
||||
*/
|
||||
public function prepare(RequestInterface $request = null, ResponseInterface $response = null)
|
||||
{
|
||||
/**
|
||||
* @var IncomingRequest $request
|
||||
* @var Response $response
|
||||
*/
|
||||
|
||||
if (CI_DEBUG && ! is_cli())
|
||||
{
|
||||
global $app;
|
||||
|
||||
$request = $request ?? Services::request();
|
||||
$response = $response ?? Services::response();
|
||||
|
||||
// Disable the toolbar for downloads
|
||||
if ($response instanceof DownloadResponse)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
$toolbar = Services::toolbar(config(Toolbar::class));
|
||||
$stats = $app->getPerformanceStats();
|
||||
$data = $toolbar->run(
|
||||
$stats['startTime'],
|
||||
$stats['totalTime'],
|
||||
$request,
|
||||
$response
|
||||
);
|
||||
|
||||
helper('filesystem');
|
||||
|
||||
// Updated to time() so we can get history
|
||||
$time = time();
|
||||
|
||||
if (! is_dir(WRITEPATH . 'debugbar'))
|
||||
{
|
||||
mkdir(WRITEPATH . 'debugbar', 0777);
|
||||
}
|
||||
|
||||
write_file(WRITEPATH . 'debugbar/' . 'debugbar_' . $time . '.json', $data, 'w+');
|
||||
|
||||
$format = $response->getHeaderLine('content-type');
|
||||
|
||||
// Non-HTML formats should not include the debugbar
|
||||
// then we send headers saying where to find the debug data
|
||||
// for this response
|
||||
if ($request->isAJAX() || strpos($format, 'html') === false)
|
||||
{
|
||||
$response->setHeader('Debugbar-Time', "$time")
|
||||
->setHeader('Debugbar-Link', site_url("?debugbar_time={$time}"))
|
||||
->getBody();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$oldKintMode = Kint::$mode_default;
|
||||
Kint::$mode_default = Kint::MODE_RICH;
|
||||
$kintScript = @Kint::dump('');
|
||||
Kint::$mode_default = $oldKintMode;
|
||||
$kintScript = substr($kintScript, 0, strpos($kintScript, '</style>') + 8 );
|
||||
|
||||
$script = PHP_EOL
|
||||
. '<script type="text/javascript" {csp-script-nonce} id="debugbar_loader" '
|
||||
. 'data-time="' . $time . '" '
|
||||
. 'src="' . site_url() . '?debugbar"></script>'
|
||||
. '<script type="text/javascript" {csp-script-nonce} id="debugbar_dynamic_script"></script>'
|
||||
. '<style type="text/css" {csp-style-nonce} id="debugbar_dynamic_style"></style>'
|
||||
. $kintScript
|
||||
. PHP_EOL;
|
||||
|
||||
if (strpos($response->getBody(), '<head>') !== false)
|
||||
{
|
||||
$response->setBody(preg_replace('/<head>/', '<head>' . $script, $response->getBody(), 1));
|
||||
return;
|
||||
}
|
||||
|
||||
$response->appendBody($script);
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Inject debug toolbar into the response.
|
||||
*/
|
||||
public function respond()
|
||||
{
|
||||
if (ENVIRONMENT === 'testing')
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// @codeCoverageIgnoreStart
|
||||
$request = Services::request();
|
||||
|
||||
// If the request contains '?debugbar then we're
|
||||
// simply returning the loading script
|
||||
if ($request->getGet('debugbar') !== null)
|
||||
{
|
||||
// Let the browser know that we are sending javascript
|
||||
header('Content-Type: application/javascript');
|
||||
|
||||
ob_start();
|
||||
include($this->config->viewsPath . 'toolbarloader.js.php');
|
||||
$output = ob_get_clean();
|
||||
|
||||
exit($output);
|
||||
}
|
||||
|
||||
// Otherwise, if it includes ?debugbar_time, then
|
||||
// we should return the entire debugbar.
|
||||
if ($request->getGet('debugbar_time'))
|
||||
{
|
||||
helper('security');
|
||||
|
||||
// Negotiate the content-type to format the output
|
||||
$format = $request->negotiate('media', [
|
||||
'text/html',
|
||||
'application/json',
|
||||
'application/xml',
|
||||
]);
|
||||
$format = explode('/', $format)[1];
|
||||
|
||||
$file = sanitize_filename('debugbar_' . $request->getGet('debugbar_time'));
|
||||
$filename = WRITEPATH . 'debugbar/' . $file . '.json';
|
||||
|
||||
// Show the toolbar
|
||||
if (is_file($filename))
|
||||
{
|
||||
$contents = $this->format(file_get_contents($filename), $format);
|
||||
exit($contents);
|
||||
}
|
||||
|
||||
// File was not written or do not exists
|
||||
http_response_code(404);
|
||||
exit; // Exit here is needed to avoid load the index page
|
||||
}
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
/**
|
||||
* Format output
|
||||
*
|
||||
* @param string $data JSON encoded Toolbar data
|
||||
* @param string $format html, json, xml
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function format(string $data, string $format = 'html'): string
|
||||
{
|
||||
$data = json_decode($data, true);
|
||||
|
||||
if ($this->config->maxHistory !== 0)
|
||||
{
|
||||
$history = new History();
|
||||
$history->setFiles(
|
||||
(int) Services::request()->getGet('debugbar_time'),
|
||||
$this->config->maxHistory
|
||||
);
|
||||
|
||||
$data['collectors'][] = $history->getAsArray();
|
||||
}
|
||||
|
||||
$output = '';
|
||||
|
||||
switch ($format)
|
||||
{
|
||||
case 'html':
|
||||
$data['styles'] = [];
|
||||
extract($data);
|
||||
$parser = Services::parser($this->config->viewsPath, null, false);
|
||||
ob_start();
|
||||
include($this->config->viewsPath . 'toolbar.tpl.php');
|
||||
$output = ob_get_clean();
|
||||
break;
|
||||
case 'json':
|
||||
$formatter = new JSONFormatter();
|
||||
$output = $formatter->format($data);
|
||||
break;
|
||||
case 'xml':
|
||||
$formatter = new XMLFormatter;
|
||||
$output = $formatter->format($data);
|
||||
break;
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user