init
This commit is contained in:
Sebastian Molenda
+194
@@ -0,0 +1,194 @@
|
||||
<?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;
|
||||
use Cake\Database\Driver\Sqlserver;
|
||||
use Exception;
|
||||
use JsonSerializable;
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
* 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, Stringable
|
||||
{
|
||||
/**
|
||||
* Driver executing the query
|
||||
*
|
||||
* @var \Cake\Database\Driver|null
|
||||
*/
|
||||
protected ?Driver $driver = null;
|
||||
|
||||
/**
|
||||
* Query string that was executed
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected string $query = '';
|
||||
|
||||
/**
|
||||
* Number of milliseconds this query took to complete
|
||||
*
|
||||
* @var float
|
||||
*/
|
||||
protected float $took = 0;
|
||||
|
||||
/**
|
||||
* Associative array with the params bound to the query string
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected array $params = [];
|
||||
|
||||
/**
|
||||
* Number of rows affected or returned by the query execution
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected int $numRows = 0;
|
||||
|
||||
/**
|
||||
* The exception that was thrown by the execution of this query
|
||||
*
|
||||
* @var \Exception|null
|
||||
*/
|
||||
protected ?Exception $error = null;
|
||||
|
||||
/**
|
||||
* 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 (string)preg_replace($keys, $params, $this->query, $limit);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the logging context data for a query.
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function getContext(): array
|
||||
{
|
||||
return [
|
||||
'query' => $this->query,
|
||||
'numRows' => $this->numRows,
|
||||
'took' => $this->took,
|
||||
'role' => $this->driver ? $this->driver->getRole() : '',
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set logging context for this query.
|
||||
*
|
||||
* @param array $context Context data.
|
||||
* @return void
|
||||
*/
|
||||
public function setContext(array $context): void
|
||||
{
|
||||
foreach ($context as $key => $val) {
|
||||
if (property_exists($this, $key)) {
|
||||
$this->{$key} = $val;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns data that will be serialized as JSON
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
$error = $this->error;
|
||||
if ($error !== null) {
|
||||
$error = [
|
||||
'class' => $error::class,
|
||||
'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
|
||||
{
|
||||
if ($this->params) {
|
||||
return $this->interpolate();
|
||||
}
|
||||
|
||||
return $this->query;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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\Log\Engine\BaseLog;
|
||||
use Cake\Log\Log;
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
* This class is a bridge used to write LoggedQuery objects into a real log.
|
||||
* by default this class use the built-in CakePHP Log class to accomplish this
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
class QueryLogger extends BaseLog
|
||||
{
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param array<string, mixed> $config Configuration array
|
||||
*/
|
||||
public function __construct(array $config = [])
|
||||
{
|
||||
$this->_defaultConfig['scopes'] = ['queriesLog', 'cake.database.queries'];
|
||||
$this->_defaultConfig['connection'] = '';
|
||||
|
||||
parent::__construct($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function log($level, string|Stringable $message, array $context = []): void
|
||||
{
|
||||
$context += [
|
||||
'scope' => $this->scopes() ?: ['queriesLog', 'cake.database.queries'],
|
||||
'connection' => $this->getConfig('connection'),
|
||||
'query' => null,
|
||||
];
|
||||
|
||||
if ($context['query'] instanceof LoggedQuery) {
|
||||
$context = $context['query']->getContext() + $context;
|
||||
$message = 'connection={connection} role={role} duration={took} rows={numRows} ' . $message;
|
||||
}
|
||||
Log::write('debug', (string)$message, $context);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user