sqltracker.php

<?php
 
namespace Bitrix\Main\Diag;
 
use Bitrix\Main\Application;
 
class SqlTracker implements \Iterator
{
    protected $queries = array();
    protected $time = 0.0;
    protected static $depthBackTrace = 0;
    protected $counter = 0;
    protected $logFilePath = "";
 
    public function __construct()
    {
        if (self::$depthBackTrace == 0)
        {
            $eh = \Bitrix\Main\Config\Configuration::getValue('exception_handling');
            if (!empty($eh['depth_back_trace']))
            {
                self::$depthBackTrace = (int) $eh['depth_back_trace'];
            }
            else
            {
                self::$depthBackTrace = 8;
            }
        }
    }
 
    public function reset()
    {
        $this->queries = array();
        $this->time = 0.0;
        $this->counter = 0;
    }
 
    public function getNewTrackerQuery()
    {
        $query = new SqlTrackerQuery($this);
        $this->queries[] = $query;
        $this->counter++;
        return $query;
    }
 
    public function addTime($time)
    {
        $this->time += $time;
    }
 
    public function getCounter()
    {
        return $this->counter;
    }
 
    public function getTime()
    {
        return $this->time;
    }
 
    public function getQueries()
    {
        return $this->queries;
    }
 
    public function getDepthBackTrace()
    {
        return self::$depthBackTrace;
    }
 
    public function setDepthBackTrace($depthBackTrace)
    {
        self::$depthBackTrace = (int) $depthBackTrace;
    }
 
    public function startFileLog($filePath)
    {
        $this->logFilePath = (string)$filePath;
    }
 
    public function writeFileLog($sql, $executionTime = 0.0, $additional = "", $traceSkip = 2)
    {
        if ($this->logFilePath)
        {
            $application = Application::getInstance();
            if ($application->isInitialized() && $application->getKernelSession()->isStarted())
            {
                $sessionId = $application->getKernelSession()->getId();
            }
            else
            {
                $sessionId = '-';
            }
 
            $header = "TIME: ".round($executionTime, 6)." SESSION: ".$sessionId." ".$additional."\n";
            $headerLength = mb_strlen($header);
            $body = $this->formatSql($sql);
            $trace = $this->formatTrace(Helper::getBackTrace(self::$depthBackTrace, null, $traceSkip));
            $footer = str_repeat("-", $headerLength);
            $message =
                "\n".$header.
                "\n".$body.
                "\n\n".$trace.
                "\n".$footer.
                "\n";
            \Bitrix\Main\IO\File::putFileContents($this->logFilePath, $message, \Bitrix\Main\IO\File::APPEND);
        }
    }
 
    public function stopFileLog()
    {
        $this->logFilePath = "";
    }
 
    protected function formatSql($sql)
    {
        $sqlLines = explode("\n", $sql);
        $skip = true;
        $tabs = 0;
        foreach ($sqlLines as $i => $line)
        {
            if ($skip)
            {
                if (trim($line, "\n\r\t ") == "")
                {
                    unset($sqlLines[$i]);
                }
                else
                {
                    $skip = false;
                    $tabs = mb_strlen($line) - mb_strlen(ltrim($line, "\t"));
                }
            }
            if ($tabs)
            {
                $line = preg_replace("/^[\\t]{1,$tabs}/", "", $line);
                if ($line !== "")
                    $sqlLines[$i] = $line;
                else
                    unset($sqlLines[$i]);
            }
        }
        return implode("\n", $sqlLines);
    }
 
    protected function formatTrace(array $trace = null)
    {
        if ($trace)
        {
            $traceLines = array();
            foreach ($trace as $traceInfo)
            {
                $traceLine = '';
 
                if (array_key_exists('class', $traceInfo))
                    $traceLine .= $traceInfo['class'].$traceInfo['type'];
 
                if (array_key_exists('function', $traceInfo))
                    $traceLine .= $traceInfo['function'].'()';
 
                if (array_key_exists('file', $traceInfo))
                {
                    $traceLine .= ' '.$traceInfo['file'];
                    if (array_key_exists('line', $traceInfo))
                    $traceLine .= ':'.$traceInfo['line'];
                }
 
                if ($traceLine)
                    $traceLines[] = ' from '.$traceLine;
            }
 
            return implode("\n", $traceLines);
        }
        else
        {
            return "";
        }
    }
 
    public function rewind()
    {
        reset($this->queries);
    }
 
    public function current()
    {
        return current($this->queries);
    }
 
    public function key()
    {
        return key($this->queries);
    }
 
    public function next()
    {
        next($this->queries);
    }
 
    public function valid()
    {
        return key($this->queries) !== null;
    }
}