177 lines
4.3 KiB
PHP
177 lines
4.3 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
|
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* For full copyright and license information, please see the LICENSE.txt
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
|
* @link https://cakephp.org CakePHP(tm) Project
|
|
* @since 3.0.0
|
|
* @license https://opensource.org/licenses/mit-license.php MIT License
|
|
*/
|
|
namespace Cake\Database\Log;
|
|
|
|
use Cake\Database\Driver\Sqlserver;
|
|
use JsonSerializable;
|
|
|
|
/**
|
|
* Contains a query string, the params used to executed it, time taken to do it
|
|
* and the number of rows found or affected by its execution.
|
|
*
|
|
* @internal
|
|
*/
|
|
class LoggedQuery implements JsonSerializable
|
|
{
|
|
/**
|
|
* Driver executing the query
|
|
*
|
|
* @var \Cake\Database\DriverInterface|null
|
|
*/
|
|
public $driver = null;
|
|
|
|
/**
|
|
* Query string that was executed
|
|
*
|
|
* @var string
|
|
*/
|
|
public $query = '';
|
|
|
|
/**
|
|
* Number of milliseconds this query took to complete
|
|
*
|
|
* @var float
|
|
*/
|
|
public $took = 0;
|
|
|
|
/**
|
|
* Associative array with the params bound to the query string
|
|
*
|
|
* @var array
|
|
*/
|
|
public $params = [];
|
|
|
|
/**
|
|
* Number of rows affected or returned by the query execution
|
|
*
|
|
* @var int
|
|
*/
|
|
public $numRows = 0;
|
|
|
|
/**
|
|
* The exception that was thrown by the execution of this query
|
|
*
|
|
* @var \Exception|null
|
|
*/
|
|
public $error;
|
|
|
|
/**
|
|
* Helper function used to replace query placeholders by the real
|
|
* params used to execute the query
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function interpolate(): string
|
|
{
|
|
$params = array_map(function ($p) {
|
|
if ($p === null) {
|
|
return 'NULL';
|
|
}
|
|
|
|
if (is_bool($p)) {
|
|
if ($this->driver instanceof Sqlserver) {
|
|
return $p ? '1' : '0';
|
|
}
|
|
|
|
return $p ? 'TRUE' : 'FALSE';
|
|
}
|
|
|
|
if (is_string($p)) {
|
|
// Likely binary data like a blob or binary uuid.
|
|
// pattern matches ascii control chars.
|
|
if (preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]/u', '', $p) !== $p) {
|
|
$p = bin2hex($p);
|
|
}
|
|
|
|
$replacements = [
|
|
'$' => '\\$',
|
|
'\\' => '\\\\\\\\',
|
|
"'" => "''",
|
|
];
|
|
|
|
$p = strtr($p, $replacements);
|
|
|
|
return "'$p'";
|
|
}
|
|
|
|
return $p;
|
|
}, $this->params);
|
|
|
|
$keys = [];
|
|
$limit = is_int(key($params)) ? 1 : -1;
|
|
foreach ($params as $key => $param) {
|
|
$keys[] = is_string($key) ? "/:$key\b/" : '/[?]/';
|
|
}
|
|
|
|
return preg_replace($keys, $params, $this->query, $limit);
|
|
}
|
|
|
|
/**
|
|
* Get the logging context data for a query.
|
|
*
|
|
* @return array<string, mixed>
|
|
*/
|
|
public function getContext(): array
|
|
{
|
|
return [
|
|
'numRows' => $this->numRows,
|
|
'took' => $this->took,
|
|
'role' => $this->driver ? $this->driver->getRole() : '',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns data that will be serialized as JSON
|
|
*
|
|
* @return array<string, mixed>
|
|
*/
|
|
public function jsonSerialize(): array
|
|
{
|
|
$error = $this->error;
|
|
if ($error !== null) {
|
|
$error = [
|
|
'class' => get_class($error),
|
|
'message' => $error->getMessage(),
|
|
'code' => $error->getCode(),
|
|
];
|
|
}
|
|
|
|
return [
|
|
'query' => $this->query,
|
|
'numRows' => $this->numRows,
|
|
'params' => $this->params,
|
|
'took' => $this->took,
|
|
'error' => $error,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns the string representation of this logged query
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString(): string
|
|
{
|
|
$sql = $this->query;
|
|
if (!empty($this->params)) {
|
|
$sql = $this->interpolate();
|
|
}
|
|
|
|
return $sql;
|
|
}
|
|
}
|