├── README.md
└── querylog
    ├── QueryLogPlugin.php
    ├── variables
        └── QueryLogVariable.php
    └── templates
        └── index.twig


/README.md:
--------------------------------------------------------------------------------
 1 | # Query Log Plugin for Craft CMS
 2 | 
 3 | Show a log of database queries in your front-end templates.
 4 | 
 5 | ![Screenshot](https://raw.githubusercontent.com/wiki/rsanchez/craft-query-log/screenshot.png)
 6 | 
 7 | ## Usage
 8 | 
 9 | Add this to the bottom of your template:
10 | 
11 | ```
12 | {{ craft.querylog | raw }}
13 | ```
14 | 
15 | The ideal location is in your master layout, just before the final closing `</html>` tag.
16 | 
17 | When Craft `devMode` is set to `true`, this will add a Query Log button to the bottom of your page. Click it to reveal a list of all queries executed on the page.


--------------------------------------------------------------------------------
/querylog/QueryLogPlugin.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Query Log plugin for Craft CMS
  4 |  *
  5 |  * Log DB queries to the front-end with template variables.
  6 |  *
  7 |  * @author    Rob Sanchez
  8 |  * @copyright Copyright (c) 2016 Rob Sanchez
  9 |  * @link      https://github.com/rsanchez
 10 |  * @package   QueryLog
 11 |  * @since     1.0.0
 12 |  */
 13 | 
 14 | namespace Craft;
 15 | 
 16 | class QueryLogPlugin extends BasePlugin
 17 | {
 18 |     /**
 19 |      * @return mixed
 20 |      */
 21 |     public function init()
 22 |     {
 23 |     }
 24 | 
 25 |     /**
 26 |      * @return mixed
 27 |      */
 28 |     public function getName()
 29 |     {
 30 |          return Craft::t('Query Log');
 31 |     }
 32 | 
 33 |     /**
 34 |      * @return mixed
 35 |      */
 36 |     public function getDescription()
 37 |     {
 38 |         return Craft::t('Log DB queries to the front-end with template variables.');
 39 |     }
 40 | 
 41 |     /**
 42 |      * @return string
 43 |      */
 44 |     public function getDocumentationUrl()
 45 |     {
 46 |         return '';
 47 |     }
 48 | 
 49 |     /**
 50 |      * @return string
 51 |      */
 52 |     public function getReleaseFeedUrl()
 53 |     {
 54 |         return '';
 55 |     }
 56 | 
 57 |     /**
 58 |      * @return string
 59 |      */
 60 |     public function getVersion()
 61 |     {
 62 |         return '1.0.1';
 63 |     }
 64 | 
 65 |     /**
 66 |      * @return string
 67 |      */
 68 |     public function getSchemaVersion()
 69 |     {
 70 |         return '1.0.0';
 71 |     }
 72 | 
 73 |     /**
 74 |      * @return string
 75 |      */
 76 |     public function getDeveloper()
 77 |     {
 78 |         return 'Rob Sanchez';
 79 |     }
 80 | 
 81 |     /**
 82 |      * @return string
 83 |      */
 84 |     public function getDeveloperUrl()
 85 |     {
 86 |         return 'https://github.com/rsanchez';
 87 |     }
 88 | 
 89 |     /**
 90 |      * @return bool
 91 |      */
 92 |     public function hasCpSection()
 93 |     {
 94 |         return false;
 95 |     }
 96 | 
 97 |     /**
 98 |      */
 99 |     public function onBeforeInstall()
100 |     {
101 |     }
102 | 
103 |     /**
104 |      */
105 |     public function onAfterInstall()
106 |     {
107 |     }
108 | 
109 |     /**
110 |      */
111 |     public function onBeforeUninstall()
112 |     {
113 |     }
114 | 
115 |     /**
116 |      */
117 |     public function onAfterUninstall()
118 |     {
119 |     }
120 | }


--------------------------------------------------------------------------------
/querylog/variables/QueryLogVariable.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Query Log plugin for Craft CMS
  4 |  *
  5 |  * Query Log Variable
  6 |  *
  7 |  * @author    Rob Sanchez
  8 |  * @copyright Copyright (c) 2016 Rob Sanchez
  9 |  * @link      https://github.com/rsanchez
 10 |  * @package   QueryLog
 11 |  * @since     1.0.0
 12 |  */
 13 | 
 14 | namespace Craft;
 15 | 
 16 | use CLogger;
 17 | use ReflectionProperty;
 18 | 
 19 | class QueryLogVariable
 20 | {
 21 |     /**
 22 |      */
 23 |     public function queries()
 24 |     {
 25 |         $logs = Craft::getLogger()->getLogs(CLogger::LEVEL_PROFILE, 'system.db.CDbCommand.query');
 26 | 
 27 |         $queries = array();
 28 | 
 29 |         $startTimes = array();
 30 | 
 31 |         foreach ($logs as $log) {
 32 |             $msg = $log[0];
 33 |             $time = $log[3];
 34 |             $query = new \stdClass();
 35 | 
 36 |             if (strpos($msg, 'begin:') === 0) {
 37 |                 $sql = substr($msg, 6 + 27, -1);
 38 |                 $startTimes[$sql] = $time;
 39 |             } elseif (strpos($msg, 'end:') === 0) {
 40 |                 $query->sql = $this->parseSqlBindings(substr($msg, 4 + 27, -1));
 41 |                 $query->duration = number_format(($time - $startTimes[$sql]) * 1000, 2).'ms';
 42 |                 $queries[] = $query;
 43 |             }
 44 |         }
 45 | 
 46 |         return $queries;
 47 |     }
 48 | 
 49 |     public function __toString()
 50 |     {
 51 |         $this->hackAddTemplatePath();
 52 | 
 53 |         $queries = $this->queries();
 54 | 
 55 |         if (!$queries) {
 56 |             return '';
 57 |         }
 58 | 
 59 |         return craft()->templates->render('querylog/index', compact('queries'));
 60 |     }
 61 | 
 62 |     /**
 63 |      * Parse a sql statement and interpolate any bindings
 64 |      * @param  string $sql
 65 |      * @return string
 66 |      */
 67 |     protected function parseSqlBindings($query)
 68 |     {
 69 |         if (preg_match('/^(.*?)\. Bound with (.*?)$/s', $query, $match)) {
 70 |             $query = $match[1];
 71 |             $bindings = $match[2];
 72 | 
 73 |             preg_match_all('/:(.*?)=(.*?)(,|$)/', $bindings, $matches);
 74 | 
 75 |             foreach ($matches[1] as $i => $column) {
 76 |                 $value = $matches[2][$i];
 77 | 
 78 |                 $query = str_replace(':'.$column, $value, $query);
 79 |             }
 80 |         }
 81 | 
 82 |         return $query.';';
 83 |     }
 84 | 
 85 |     /**
 86 |      * Template service doesn't normally let you load plugin templates on a non CP/ non action request
 87 |      * So we inject our querylog/index template path here
 88 |      * @return void
 89 |      */
 90 |     protected function hackAddTemplatePath()
 91 |     {
 92 |         // add our template path
 93 |         $key = craft()->path->getSiteTemplatesPath().':querylog/index';
 94 | 
 95 |         $path = craft()->path->getPluginsPath().'querylog/templates/index.twig';
 96 | 
 97 |         $reflectionProperty = new ReflectionProperty(craft()->templates, '_templatePaths');
 98 | 
 99 |         $reflectionProperty->setAccessible(true);
100 | 
101 |         $templatePaths = $reflectionProperty->getValue(craft()->templates);
102 | 
103 |         $templatePaths[$key] = $path;
104 | 
105 |         $reflectionProperty->setValue(craft()->templates, $templatePaths);
106 | 
107 |         $reflectionProperty->setAccessible(false);
108 |     }
109 | }
110 | 


--------------------------------------------------------------------------------
/querylog/templates/index.twig:
--------------------------------------------------------------------------------
  1 | <style>
  2 | #querylog {
  3 |     position: fixed;
  4 |     bottom: 0;
  5 |     left: 0;
  6 |     right: 0;
  7 |     color: #000;
  8 |     background-color: transparent;
  9 |     z-index: 9999999999;
 10 | }
 11 | #querylog-button {
 12 |     position: absolute;
 13 |     top: -30px;
 14 |     left: 20px;
 15 |     height: 30px;
 16 |     font-family: HelveticaNeue, "Open Sans", Helvetica, Arial, sans-serif;
 17 |     font-size: 13px;
 18 |     line-height: 20px;
 19 |     vertical-align: middle;
 20 |     width: auto;
 21 |     border: none;
 22 |     display: inline-block;
 23 |     margin: 0;
 24 |     border-radius: 3px 3px 0 0;
 25 |     padding: 6px 12px;
 26 |     text-align: center;
 27 |     cursor: pointer;
 28 |     white-space: nowrap;
 29 |     -webkit-user-select: none;
 30 |     -moz-user-select: none;
 31 |     -ms-user-select: none;
 32 |     cursor: pointer;
 33 |     -webkit-box-sizing: border-box;
 34 |     -moz-box-sizing: border-box;
 35 |     box-sizing: border-box;
 36 |     -webkit-appearance: none;
 37 |     color: #fff;
 38 |     background-image: -webkit-linear-gradient(#da5a47, #cc5643);
 39 |     background-image: -moz-linear-gradient(#da5a47, #cc5643);
 40 |     background-image: -ms-linear-gradient(#da5a47, #cc5643);
 41 |     background-image: -o-linear-gradient(#da5a47, #cc5643);
 42 |     background-image: linear-gradient(#da5a47, #cc5643);
 43 |     -webkit-box-shadow: inset 0 0 0 1px rgba(0, 0, 20, 0.1), 0 -7px 20px -7px rgba(0, 0, 0, 0.25);
 44 |     -moz-box-shadow: inset 0 0 0 1px rgba(0, 0, 20, 0.1), 0 -7px 20px -7px rgba(0, 0, 0, 0.25);
 45 |     box-shadow: inset 0 0 0 1px rgba(0, 0, 20, 0.1), 0 -7px 20px -7px rgba(0, 0, 0, 0.25);
 46 |     z-index: 1;
 47 | }
 48 | #querylog-button:hover {
 49 |     background-image: -webkit-linear-gradient(#bf503f, #b34b3b);
 50 |     background-image: -moz-linear-gradient(#bf503f, #b34b3b);
 51 |     background-image: -ms-linear-gradient(#bf503f, #b34b3b);
 52 |     background-image: -o-linear-gradient(#bf503f, #b34b3b);
 53 |     background-image: linear-gradient(#bf503f, #b34b3b);
 54 | }
 55 | #querylog-tray {
 56 |     overflow-y: hidden;
 57 |     max-height: 0;
 58 |     transition-property: all;
 59 |     transition-duration: .5s;
 60 |     transition-timing-function: cubic-bezier(0, 1, 0.5, 1);
 61 |     padding: 0 20px;
 62 |     background: #fff;
 63 | }
 64 | #querylog-toggle {
 65 |     display: none;
 66 | }
 67 | #querylog-toggle:checked + #querylog-tray {
 68 |     -webkit-box-shadow: inset 0 0 0 1px rgba(0, 0, 20, 0.1), 0 0 20px rgba(0, 0, 0, 0.1);
 69 |     -moz-box-shadow: inset 0 0 0 1px rgba(0, 0, 20, 0.1), 0 0 20px rgba(0, 0, 0, 0.1);
 70 |     box-shadow: inset 0 0 0 1px rgba(0, 0, 20, 0.1), 0 0 20px rgba(0, 0, 0, 0.1);
 71 |     height: auto;
 72 |     max-height: 500px;
 73 |     overflow-y: scroll;
 74 | }
 75 | #querylog-count {
 76 |     font-family: HelveticaNeue, "Open Sans", Helvetica, Arial, sans-serif;
 77 |     font-size: 13px;
 78 |     line-height: 18px;
 79 |     color: #29323d;
 80 |     padding-left: 14px;
 81 |     margin: 20px 0;
 82 | }
 83 | #querylog-queries {
 84 |     font-size: 13px;
 85 |     line-height: 20px;
 86 |     table-layout: fixed;
 87 |     margin: 20px 0 0;
 88 | }
 89 | #querylog-queries th {
 90 |     text-align: left;
 91 |     font-family: HelveticaNeue, "Open Sans", Helvetica, Arial, sans-serif;
 92 | }
 93 | #querylog-queries th + th {
 94 |     padding-left: 30px;
 95 | }
 96 | #querylog-queries th {
 97 |     font-weight: bold;
 98 |     vertical-align: top;
 99 |     font-size: 11px;
100 |     line-height: 1.2;
101 |     padding: 5px 14px;
102 |     color: rgba(0, 0, 0, 0.5);
103 | }
104 | #querylog-queries td {
105 |     font-family: HelveticaNeue, "Open Sans", Helvetica, Arial, sans-serif;
106 |     border-top: 1px dotted #e3e5e8;
107 |     padding: 15px 14px;
108 |     word-wrap: break-word;
109 |     vertical-align: top;
110 | }
111 | #querylog-queries td + td {
112 |     word-wrap: normal;
113 | }
114 | #querylog-queries tr:first-child td {
115 |     border-top-style: solid;
116 | }
117 | #querylog-queries code[class*=language] {
118 |     white-space: pre-wrap;
119 |     white-space: -moz-pre-wrap;
120 |     white-space: -pre-wrap;
121 |     white-space: -o-pre-wrap;
122 |     word-wrap: break-word;
123 |     border: none;
124 |     font-family: monospace;
125 | }
126 | #querylog-queries .token {
127 |     font-family: monospace;
128 | }
129 | #querylog-queries td + td {
130 |     padding-left: 30px;
131 | }
132 | </style>
133 | 
134 | <div id="querylog">
135 |     <label for="querylog-toggle" id="querylog-button">
136 |         Query Log
137 |     </label>
138 |     <input type="checkbox" id="querylog-toggle">
139 |     <div id="querylog-tray">
140 |         <div id="querylog-count">{{ queries|length }} total queries.</div>
141 |         <table id="querylog-queries" cellpadding="0" border="0" cellspacing="0" width="100%">
142 |             <thead>
143 |                 <tr>
144 |                     <th>Query</th>
145 |                     <th width="90">Duration</th>
146 |                 </tr>
147 |             </thead>
148 |             <tbody>
149 |             {% for query in queries %}
150 |                 <tr>
151 |                     <td><code class="language-sql">{{ query.sql }}</code></td>
152 |                     <td width="90">{{ query.duration }}</td>
153 |                 </tr>
154 |             {% endfor %}
155 |             </tbody>
156 |         </table>
157 |     </div>
158 | </div>
159 | 
160 | <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.5.1/themes/prism-coy.min.css">
161 | <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.5.1/components/prism-core.min.js"></script>
162 | <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.5.1/components/prism-sql.min.js"></script>
163 | 


--------------------------------------------------------------------------------