remove Query Status Monitor, complete implementation

Feature/sql status

CHANGELOG.md

@@ -6,8 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+---
+
+## [1.2.0] - 2020-04-30
+
+### Added
+
+- Format SQL query 
+- Measures the SQL execution time
+
+---
+
+## [1.1.0] - 2019-09-20
+
+### Added
+
+- add log message
+- add position specifications of the calling source code 
+
+---
+
 ## [1.0.0] - 2019-07-21
 
+available in tumtum/oxid-sql-logger package only
+
 ### Added
 
 - Global function `StartSQLLog` and `StopSQLLog`

README.md

@@ -5,29 +5,31 @@ Returns all SQL queries into console of a Browser.
 
 ## Install
 
-`composer require --dev tumtum/oxid-sql-logger`
+`composer require --dev d3/oxid-sql-logger`
 
 ## Usage
 
-Just set the function `StartSQLLog()` somewhere and from that point on all SQLs will be logged.
+Just set the function `D3StartSQLLog()` somewhere and from that point on all SQLs will be logged.
 
 ```php
-\StartSQLLog();
+\D3StartSQLLog('specific log message');
 
 $db = \OxidEsales\Eshop\Core\DatabaseProvider::getDb(\OxidEsales\Eshop\Core\DatabaseProvider::FETCH_MODE_ASSOC);
 $list = $db->getAll('SELECT * FROM oxarticles WHERE oxprice < ? LIMIT 100', [49.99]);
 
-\StopSQLLog();
+\D3StopSQLLog();
 ```
 
 ## Screenshots
 
 Browser:
 
-![Example all sqls](https://raw.githubusercontent.com/TumTum/oxid-sql-logger/master/img/screenshot-a.jpg)
+![Example all sqls](https://raw.githubusercontent.com/d3datadevelopment/oxid-sql-logger/master/img/screenshot-a.jpg)
-![Example only one range](https://raw.githubusercontent.com/TumTum/oxid-sql-logger/master/img/screenshot-b.png)
 
 CLI:
 
-![Example CLI](https://raw.githubusercontent.com/TumTum/oxid-sql-logger/master/img/screenshot-cli.png)
+![Example CLI](https://raw.githubusercontent.com/d3datadevelopment/oxid-sql-logger/master/img/screenshot-cli.jpg)
 
+## Credits
+
+Many thanks to [Tobias Matthaiou](https://github.com/TumTum/oxid-sql-logger) for his inspiration.

composer.json

@@ -1,23 +1,26 @@
 {
-    "name": "tumtum/oxid-sql-logger",
+    "name": "d3/oxid-sql-logger",
     "description": "Returns all SQL queries in the browser.",
     "type": "library",
     "require": {
-        "monolog/monolog": "^1"
+        "monolog/monolog": "^1",
+        "nilportugues/sql-query-formatter": "^1.2.2"
     },
     "license": "GPL-3.0",
     "autoload": {
         "psr-4": {
-            "tm\\oxid\\sql\\logger\\": "./src"
+            "D3\\OxidSqlLogger\\": "./src"
-        },
+        }
-        "files": [
-            "./src/functions.php"
-        ]
     },
     "authors": [
         {
             "name": "Tobias Matthaiou",
             "email": "developer@tobimat.eu"
+        },
+        {
+            "name": "D3 Data Development (Inh. Thomas Dartsch)",
+            "email": "info@shopmodule.com",
+            "homepage": "http://www.d3data.de"
         }
     ]
 }

example/simple.php

@@ -2,9 +2,18 @@
 
 require __DIR__ . '/../../../../source/bootstrap.php';
 
-\StartSQLLog();
+\D3StartSQLLog('Query for 100 items cheaper than 49,99');
+
+$db = \OxidEsales\Eshop\Core\DatabaseProvider::getDb(\OxidEsales\Eshop\Core\DatabaseProvider::FETCH_MODE_ASSOC);
+$list = $db->getAll('SELECT * '.PHP_EOL.'FROM oxarticles WHERE oxprice < ? LIMIT 100', [49.99]);
+
+\D3StopSQLLog();
+
+// or
+
+\D3StartSQLLog();
 
 $db = \OxidEsales\Eshop\Core\DatabaseProvider::getDb(\OxidEsales\Eshop\Core\DatabaseProvider::FETCH_MODE_ASSOC);
 $list = $db->getAll('SELECT * FROM oxarticles WHERE oxprice < ? LIMIT 100', [49.99]);
 
-\StopSQLLog();
+\D3StopSQLLog();

src/LoggerFactory.php

@@ -1,17 +1,17 @@
 <?php
+
 /**
- * Autor: Tobias Matthaiou <developer@tobimat.eu>
+ * @author    Tobias Matthaiou <developer@tobimat.eu>
- * Date: 2019-08-21
+ * @author    D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * Time: 07:50
  */
-namespace tm\oxid\sql\logger;
+
+namespace D3\OxidSqlLogger;
 
 use Monolog;
 use Symfony\Component\Console\Formatter\OutputFormatterStyle;
 
 /**
  * Class Factory
- * @package tm\oxid\sql\logger
  */
 class LoggerFactory
 {
@@ -34,6 +34,7 @@ class LoggerFactory
             $handlers[] = $this->getStreamHandler();
         } else {
             $handlers[] = $this->getBrowserConsoleHandler();
+            $handlers[] = $this->getFirePHPHandler();
         }
         return $handlers;
     }
@@ -53,7 +54,14 @@ class LoggerFactory
 
         $ttl_color = "$channel $level_name: $message {$newline} $context {$newline} %extra%" . PHP_EOL;
 
-        $streamHandler->setFormatter(new Monolog\Formatter\LineFormatter($ttl_color));
+        $streamHandler->setFormatter(
+            new Monolog\Formatter\LineFormatter(
+                $ttl_color,
+                null,
+                true,
+                true
+            )
+        );
 
         return $streamHandler;
     }
@@ -66,13 +74,21 @@ class LoggerFactory
         return new Monolog\Handler\BrowserConsoleHandler();
     }
 
+    /**
+     * @return Monolog\Handler\FirePHPHandler
+     */
+    private function getFirePHPHandler()
+    {
+        return new Monolog\Handler\FirePHPHandler();
+    }
+
     /**
      * @return array
      */
     private function getProcessors()
     {
         return [
-            new Monolog\Processor\IntrospectionProcessor(Monolog\Logger::DEBUG, ['tm\\oxid\\sql\\logger', 'Doctrine\\DBAL\\Connection', 'OxidEsales\\EshopCommunity\\Core\\Database\\Adapter\\Doctrine\\Database']),
+            new Monolog\Processor\IntrospectionProcessor(Monolog\Logger::DEBUG, ['D3\\OxidSqlLogger', 'Doctrine\\DBAL\\Connection', 'OxidEsales\\EshopCommunity\\Core\\Database\\Adapter\\Doctrine\\Database']),
             new Monolog\Processor\PsrLogMessageProcessor(),
         ];
     }

src/OxidEsalesDatabase.php

@@ -1,27 +1,46 @@
 <?php
+
 /**
- * Autor: Tobias Matthaiou <developer@tobimat.eu>
+ * @author    Tobias Matthaiou <developer@tobimat.eu>
- * Date: 2019-08-20
+ * @author    D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * Time: 21:56
  */
 
-namespace tm\oxid\sql\logger;
+namespace D3\OxidSqlLogger;
 
 use Doctrine\DBAL\Configuration;
 
 /**
  * Class OxidEsalesDatabase
  * Is a depenction injection Helper Class
- *
- * @package tm\oxid\sql\logger
  */
 class OxidEsalesDatabase extends \OxidEsales\Eshop\Core\Database\Adapter\Doctrine\Database
 {
-    public static function enableLogger()
+    public static function enableLogger($message = null)
+    {
+        $trace = debug_backtrace((PHP_VERSION_ID < 50306) ? 2 : DEBUG_BACKTRACE_IGNORE_ARGS);
+
+        $database = \OxidEsales\Eshop\Core\DatabaseProvider::getDb(\OxidEsales\Eshop\Core\DatabaseProvider::FETCH_MODE_ASSOC);
+        $dbalConfig = $database->getConnection()->getConfiguration();
+        $dbalConfig->setSQLLogger(
+            new OxidSQLLogger(
+                isset($trace[1]['file']) ? $trace[1]['file'] : null,
+                isset($trace[1]['line']) ? $trace[1]['line'] : null,
+                isset($trace[2]['class']) ? $trace[2]['class'] : null,
+                isset($trace[2]['function']) ? $trace[2]['function'] : null,
+                $message
+            )
+        );
+    }
+
+    /**
+     * @return OxidSQLLogger
+     * @throws \OxidEsales\Eshop\Core\Exception\DatabaseConnectionException
+     */
+    public static function getLogger()
     {
         $database = \OxidEsales\Eshop\Core\DatabaseProvider::getDb(\OxidEsales\Eshop\Core\DatabaseProvider::FETCH_MODE_ASSOC);
         $dbalConfig = $database->getConnection()->getConfiguration();
-        $dbalConfig->setSQLLogger(new OxidSQLLogger());
+        return $dbalConfig->getSQLLogger();
     }
 
     public static function disableLogger()

src/OxidSQLLogger.php

@@ -1,29 +1,46 @@
 <?php
+
 /**
- * Autor: Tobias Matthaiou <developer@tobimat.eu>
+ * @author    Tobias Matthaiou <developer@tobimat.eu>
- * Date: 2019-08-20
+ * @author    D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * Time: 21:33
  */
 
-namespace tm\oxid\sql\logger;
+namespace D3\OxidSqlLogger;
 
 use Doctrine\DBAL\Logging\SQLLogger;
 use Monolog;
+use NilPortugues\Sql\QueryFormatter\Formatter;
 
 /**
  * Class OxidSQLLogger
- * @package tm\oxid\sql\logger
  */
 class OxidSQLLogger implements SQLLogger
 {
+    public $message;
+    public $logStartingFile;
+    public $logStartingLine;
+    public $logStartingClass;
+    public $logStartingFunction;
+
+    /**
+     * @var SQLQuery
+     */
+    private $SQLQuery = null;
+
     /**
      * @inheritDoc
      */
-    public function __construct()
+    public function __construct($file, $line, $class, $function, $message = null)
     {
         if (!Monolog\Registry::hasLogger('sql')) {
             Monolog\Registry::addLogger((new LoggerFactory())->create('sql'));
         }
+
+        $this->message             = $message;
+        $this->logStartingFile      = $file;
+        $this->logStartingLine      = $line;
+        $this->logStartingClass     = $class;
+        $this->logStartingFunction  = $function;
     }
 
     /**
@@ -31,7 +48,18 @@ class OxidSQLLogger implements SQLLogger
      */
     public function startQuery($sql, array $params = null, array $types = null)
     {
-        Monolog\Registry::sql()->addDebug($sql, ['params' => $params, 'types' => $types]);
+        if ($this->SQLQuery) {
+            $this->SQLQuery->setCanceled();
+            $this->stopQuery();
+        }
+
+        $this->SQLQuery = (new SQLQuery()) ->setSql($sql)
+                                            ->setParams($params)
+                                            ->setTypes($types)
+                                            ->setLogStartingFile($this->logStartingFile)
+                                            ->setLogStartingLine($this->logStartingLine)
+                                            ->setLogStartingClass($this->logStartingClass)
+                                            ->setLogStartingFunction($this->logStartingFunction);
     }
 
     /**
@@ -39,5 +67,24 @@ class OxidSQLLogger implements SQLLogger
      */
     public function stopQuery()
     {
+        if ($this->SQLQuery) {
+            $formatter = new Formatter();
+
+            Monolog\Registry::sql()->addDebug(
+                '['.$this->SQLQuery->getReadableElapsedTime().'] ' . ( $this->message ? $this->message : $this->SQLQuery->getSql() ),
+                [
+                    'query' => $formatter->format($this->SQLQuery->getSql()),
+                    'params' => $this->SQLQuery->getParams(),
+                    'time' => $this->SQLQuery->getElapsedTime(),
+                    'types' => $this->SQLQuery->getTypes(),
+                    'logStartingFile' => $this->SQLQuery->getLogStartingFile(),
+                    'logStartingLine' => $this->SQLQuery->getLogStartingLine(),
+                    'logStartingClass' => $this->SQLQuery->getLogStartingClass(),
+                    'logStartingFunction' => $this->SQLQuery->getLogStartingFunction(),
+                ]
+            );
+        }
+
+        $this->SQLQuery = null;
     }
 }

src/SQLQuery.php

@@ -0,0 +1,247 @@
+<?php
+/**
+ * Autor: Tobias Matthaiou <developer@tobimat.eu>
+ * Date: 2019-08-20
+ * Time: 21:56
+ */
+
+namespace D3\OxidSqlLogger;
+
+/**
+ * Class SQLQuery
+ * @package tm\oxid\sql\logger
+ */
+class SQLQuery
+{
+    /**
+     * @var float|null
+     */
+    private $start_time = null;
+
+    /**
+     * @var float|null
+     */
+    private $stop_time = null;
+
+    /**
+     * @var string
+     */
+    private $sql = '';
+
+    /**
+     * @var null
+     */
+    private $params = null;
+
+    /**
+     * @var null
+     */
+    private $types = null;
+    
+    private $logStartingFile;
+    
+    private $logStartingLine;
+    
+    private $logStartingClass;
+    
+    private $logStartingFunction;
+
+    /**
+     * @inheritDoc
+     */
+    public function __construct()
+    {
+        $this->start_time = microtime(true);
+    }
+
+    /**
+     * @return string
+     */
+    public function getSql()
+    {
+        return $this->sql;
+    }
+
+    /**
+     * @param string $sql
+     * @return SQLQuery
+     */
+    public function setSql($sql)
+    {
+        $this->sql = $sql;
+        return $this;
+    }
+
+    /**
+     * @return null
+     */
+    public function getParams()
+    {
+        return $this->params;
+    }
+
+    /**
+     * @param null $params
+     * @return SQLQuery
+     */
+    public function setParams($params)
+    {
+        $this->params = $params;
+        return $this;
+    }
+
+    /**
+     * @return null
+     */
+    public function getTypes()
+    {
+        return $this->types;
+    }
+
+    /**
+     * @param null $types
+     * @return SQLQuery
+     */
+    public function setTypes($types)
+    {
+        $this->types = $types;
+        return $this;
+    }
+    
+    /**
+     * @return string
+     */
+    public function getLogStartingFile()
+    {
+        return $this->logStartingFile;
+    }
+    
+    /**
+     * @param $file
+     * @return SQLQuery
+     */
+    public function setLogStartingFile($file)
+    {
+        $this->logStartingFile = $file;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLogStartingLine()
+    {
+        return $this->logStartingLine;
+    }
+    
+    /**
+     * @param $line
+     * @return SQLQuery
+     */
+    public function setLogStartingLine($line)
+    {
+        $this->logStartingLine = $line;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLogStartingClass()
+    {
+        return $this->logStartingClass;
+    }
+    
+    /**
+     * @param $classname
+     * @return SQLQuery
+     */
+    public function setLogStartingClass($classname)
+    {
+        $this->logStartingClass = $classname;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLogStartingFunction()
+    {
+        return $this->logStartingFunction;
+    }
+    
+    /**
+     * @param $functionname
+     * @return SQLQuery
+     */
+    public function setLogStartingFunction($functionname)
+    {
+        $this->logStartingFunction = $functionname;
+        return $this;
+    }
+
+    /**
+     * Statement was cancelled prematurely, an error was thrown.
+     *
+     * @return $this
+     */
+    public function setCanceled()
+    {
+        $this->start_time = null;
+        return $this;
+    }
+
+    /**
+     * Returns elapsed time
+     * @return float|string
+     */
+    public function getElapsedTime()
+    {
+        if ($this->start_time === null) {
+            return 'Statement canceled';
+        }
+
+        if ($this->stop_time === null) {
+            $end_time = microtime(true);
+            $this->stop_time = $end_time - $this->start_time;
+        }
+
+        return (float)$this->stop_time;
+    }
+
+    /**
+     * Returns a human readable elapsed time
+     *
+     * @return string
+     */
+    public function getReadableElapsedTime()
+    {
+        return $this->readableElapsedTime($this->getElapsedTime());
+    }
+
+    /**
+     * Returns a human readable elapsed time
+     *
+     * @param  float $microtime
+     * @param  string  $format   The format to display (printf format)
+     * @return string
+     */
+    private function readableElapsedTime($microtime, $format = '%.3f%s', $round = 3)
+    {
+        if (is_string($microtime)) {
+            return $microtime;
+        }
+
+        if ($microtime >= 1) {
+            $unit = 's';
+            $time = round($microtime, $round);
+        } else {
+            $unit = 'ms';
+            $time = round($microtime*1000);
+
+            $format = preg_replace('/(%.[\d]+f)/', '%d', $format);
+        }
+
+        return sprintf($format, $time, $unit);
+    }
+}

src/functions.php

@@ -1,14 +1,14 @@
 <?php
+
 /**
- * Autor: Tobias Matthaiou <developer@tobimat.eu>
+ * @author    Tobias Matthaiou <developer@tobimat.eu>
- * Date: 2019-08-20
+ * @author    D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * Time: 23:11
  */
 
-function StartSQLLog() {
+function D3StartSQLLog($message = null) {
-    \tm\oxid\sql\logger\OxidEsalesDatabase::enableLogger();
+    \D3\OxidSqlLogger\OxidEsalesDatabase::enableLogger($message);
 }
 
-function StopSQLLog() {
+function D3StopSQLLog() {
-    \tm\oxid\sql\logger\OxidEsalesDatabase::disableLogger();
+    \D3\OxidSqlLogger\OxidEsalesDatabase::disableLogger();
 }