Version 1
[yaffs-website] / vendor / gabordemooij / redbean / RedBeanPHP / Logger / RDefault / Debug.php
diff --git a/vendor/gabordemooij/redbean/RedBeanPHP/Logger/RDefault/Debug.php b/vendor/gabordemooij/redbean/RedBeanPHP/Logger/RDefault/Debug.php
new file mode 100644 (file)
index 0000000..076014c
--- /dev/null
@@ -0,0 +1,212 @@
+<?php
+
+namespace RedBeanPHP\Logger\RDefault;
+
+use RedBeanPHP\Logger as Logger;
+use RedBeanPHP\Logger\RDefault as RDefault;
+use RedBeanPHP\RedException as RedException;
+
+/**
+ * Debug logger.
+ * A special logger for debugging purposes.
+ * Provides debugging logging functions for RedBeanPHP.
+ *
+ * @file    RedBeanPHP/Logger/RDefault/Debug.php
+ * @author  Gabor de Mooij and the RedBeanPHP Community
+ * @license BSD/GPLv2
+ *
+ * @copyright
+ * copyright (c) G.J.G.T. (Gabor) de Mooij
+ * This source file is subject to the BSD/GPLv2 License that is bundled
+ * with this source code in the file license.txt.
+ */
+class Debug extends RDefault implements Logger
+{
+       /**
+        * @var integer
+        */
+       private $strLen = 40;
+
+       /**
+        * Writes a query for logging with all bindings / params filled
+        * in.
+        *
+        * @param string $newSql   the query
+        * @param array  $bindings the bindings to process (key-value pairs)
+        *
+        * @return string
+        */
+       private function writeQuery( $newSql, $newBindings )
+       {
+               //avoid str_replace collisions: slot1 and slot10 (issue 407).
+               uksort( $newBindings, function( $a, $b ) {
+                       return ( strlen( $b ) - strlen( $a ) );
+               } );
+
+               $newStr = $newSql;
+               foreach( $newBindings as $slot => $value ) {
+                       if ( strpos( $slot, ':' ) === 0 ) {
+                               $newStr = str_replace( $slot, $this->fillInValue( $value ), $newStr );
+                       }
+               }
+               return $newStr;
+       }
+
+       /**
+        * Fills in a value of a binding and truncates the
+        * resulting string if necessary.
+        *
+        * @param mixed $value bound value
+        *
+        * @return string
+        */
+       protected function fillInValue( $value )
+       {
+               if ( is_null( $value ) ) $value = 'NULL';
+
+               $value = strval( $value );
+               if ( strlen( $value ) > ( $this->strLen ) ) {
+                       $value = substr( $value, 0, ( $this->strLen ) ).'... ';
+               }
+
+               if ( !\RedBeanPHP\QueryWriter\AQueryWriter::canBeTreatedAsInt( $value ) && $value !== 'NULL') {
+                       $value = '\''.$value.'\'';
+               }
+
+               return $value;
+       }
+
+       /**
+        * Dependending on the current mode of operation,
+        * this method will either log and output to STDIN or
+        * just log.
+        *
+        * Depending on the value of constant PHP_SAPI this function
+        * will format output for console or HTML.
+        *
+        * @param string $str string to log or output and log
+        *
+        * @return void
+        */
+       protected function output( $str )
+       {
+               $this->logs[] = $str;
+               if ( !$this->mode ) {
+                       $highlight = FALSE;
+                       /* just a quick heuritsic to highlight schema changes */
+                       if ( strpos( $str, 'CREATE' ) === 0
+                       || strpos( $str, 'ALTER' ) === 0
+                       || strpos( $str, 'DROP' ) === 0) {
+                               $highlight = TRUE;
+                       }
+                       if (PHP_SAPI === 'cli') {
+                               if ($highlight) echo "\e[91m";
+                               echo $str, PHP_EOL;
+                               echo "\e[39m";
+                       } else {
+                               if ($highlight) {
+                                       echo "<b style=\"color:red\">{$str}</b>";
+                               } else {
+                                       echo $str;
+                               }
+                               echo '<br />';
+                       }
+               }
+       }
+
+       /**
+        * Normalizes the slots in an SQL string.
+        * Replaces question mark slots with :slot1 :slot2 etc.
+        *
+        * @param string $sql sql to normalize
+        *
+        * @return string
+        */
+       protected function normalizeSlots( $sql )
+       {
+               $newSql = $sql;
+               $i = 0;
+               while(strpos($newSql, '?') !== FALSE ){
+                       $pos   = strpos( $newSql, '?' );
+                       $slot  = ':slot'.$i;
+                       $begin = substr( $newSql, 0, $pos );
+                       $end   = substr( $newSql, $pos+1 );
+                       if (PHP_SAPI === 'cli') {
+                               $newSql = "{$begin}\e[32m{$slot}\e[39m{$end}";
+                       } else {
+                               $newSql = "{$begin}<b style=\"color:green\">$slot</b>{$end}";
+                       }
+                       $i ++;
+               }
+               return $newSql;
+       }
+
+       /**
+        * Normalizes the bindings.
+        * Replaces numeric binding keys with :slot1 :slot2 etc.
+        *
+        * @param array $bindings bindings to normalize
+        *
+        * @return array
+        */
+       protected function normalizeBindings( $bindings )
+       {
+               $i = 0;
+               $newBindings = array();
+               foreach( $bindings as $key => $value ) {
+                       if ( is_numeric($key) ) {
+                               $newKey = ':slot'.$i;
+                               $newBindings[$newKey] = $value;
+                               $i++;
+                       } else {
+                               $newBindings[$key] = $value;
+                       }
+               }
+               return $newBindings;
+       }
+
+       /**
+        * Logger method.
+        *
+        * Takes a number of arguments tries to create
+        * a proper debug log based on the available data.
+        *
+        * @return void
+        */
+       public function log()
+       {
+               if ( func_num_args() < 1 ) return;
+
+               $sql = func_get_arg( 0 );
+
+               if ( func_num_args() < 2) {
+                       $bindings = array();
+               } else {
+                       $bindings = func_get_arg( 1 );
+               }
+
+               if ( !is_array( $bindings ) ) {
+                       return $this->output( $sql );
+               }
+
+               $newSql = $this->normalizeSlots( $sql );
+               $newBindings = $this->normalizeBindings( $bindings );
+               $newStr = $this->writeQuery( $newSql, $newBindings );
+               $this->output( $newStr );
+       }
+
+       /**
+        * Sets the max string length for the parameter output in
+        * SQL queries. Set this value to a reasonable number to
+        * keep you SQL queries readable.
+        *
+        * @param integer $len string length
+        *
+        * @return self
+        */
+       public function setParamStringLength( $len = 20 )
+       {
+               $this->strLen = max(0, $len);
+               return $this;
+       }
+}