Merge commit 'mike/master'

[friendica.git] / include / dba.php

diff --git a/include/dba.php b/include/dba.php
index 3cc41ebdd5fc3bf7fea93170447f5662c7665117..e58abb1a1210e29e3450fe3c5c2ca995ecffdce6 100644 (file)
--- a/include/dba.php
+++ b/include/dba.php
@@ -1,12 +1,15 @@
 <?php
 
-// MySQL database class
-//
-// For debugging, insert 'dbg(x);' anywhere in the program flow.
-// x = 1: display db success/failure following content
-// x = 2: display full queries following content
-// x = 3: display full queries using echo; which will mess up display
-//        really bad but will return output in stubborn cases.
+/**
+ *
+ * MySQL database class
+ *
+ * For debugging, insert 'dbg(1);' anywhere in the program flow.
+ * dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
+ * When logging, all binary info is converted to text and html entities are escaped so that 
+ * the debugging stream is safe to view within both terminals and web pages.
+ *
+ */
  
 if(! class_exists('dba')) { 
 class dba {
@@ -16,12 +19,15 @@ class dba {
 
        function __construct($server,$user,$pass,$db,$install = false) {
                $this->db = @new mysqli($server,$user,$pass,$db);
-               if((mysqli_connect_errno()) && (! install))
+               if((mysqli_connect_errno()) && (! $install))
                        system_unavailable();    
        }
 
+       public function getdb() {
+               return $this->db;
+       }
+
        public function q($sql) {
-               global $debug_text;
                
                if(! $this->db )
                        return false;
@@ -32,25 +38,32 @@ class dba {
 
                        $mesg = '';
 
-                       if($this->db->mysqli->errno)
-                               $debug_text .=  $this->db->mysqli->error . EOL;
+                       if($this->db->errno)
+                               logger('dba: ' . $this->db->error);
 
                        if($result === false)
                                $mesg = 'false';
                        elseif($result === true)
                                $mesg = 'true';
                        else
-                               $mesg = $result->num_rows.' results' . EOL;
+                               $mesg = $result->num_rows . ' results' . EOL;
         
-                       $str =  'SQL = ' . $sql . EOL . 'SQL returned ' . $mesg . EOL;
-
-                       switch($this->debug) {
-                               case 3:
-                                       echo $str;
-                                       break;
-                               default:
-                                       $debug_text .= $str;
-                                       break;
+                       $str =  'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg . EOL;
+
+                       logger('dba: ' . $str );
+               }
+               else {
+
+                       /*
+                        * If dbfail.out exists, we will write any failed calls directly to it,
+                        * regardless of any logging that may or may nor be in effect.
+                        * These usually indicate SQL syntax errors that need to be resolved.
+                        */
+
+                       if($result === false) {
+                               logger('dba: ' . printable($sql) . ' returned false.');
+                               if(file_exists('dbfail.out'))
+                                       file_put_contents('dbfail.out', printable($sql) . ' returned false' . "\n", FILE_APPEND);
                        }
                }
 
@@ -64,13 +77,8 @@ class dba {
                        $result->free_result();
                }
     
-               if($this->debug == 2)
-                       $debug_text .= print_r($r, true). EOL;
-//                     $debug_text .= quoted_printable_encode(print_r($r, true). EOL);
-               elseif($this->debug == 3)
-                       echo print_r($r, true) . EOL ;
-//                     echo quoted_printable_encode(print_r($r, true) . EOL) ;
-
+               if($this->debug)
+                       logger('dba: ' . printable(print_r($r, true)), LOGGER_DATA);
                return($r);
        }
 
@@ -87,6 +95,15 @@ class dba {
        }
 }}
 
+if(! function_exists('printable')) {
+function printable($s) {
+       $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
+       $s = str_replace("\x00",'.',$s);
+       if(x($_SERVER,'SERVER_NAME'))
+               $s = escape_tags($s);
+       return $s;
+}}
+
 // Procedural functions
 if(! function_exists('dbg')) { 
 function dbg($state) {
@@ -97,7 +114,10 @@ function dbg($state) {
 if(! function_exists('dbesc')) { 
 function dbesc($str) {
        global $db;
-       return($db->escape($str));
+       if($db)
+               return($db->escape($str));
+       else
+               return(str_replace("'","\\'",$str));
 }}
 
 
@@ -112,7 +132,35 @@ function q($sql) {
        global $db;
        $args = func_get_args();
        unset($args[0]);
-       $ret = $db->q(vsprintf($sql,$args));
+
+       if($db) {
+               $ret = $db->q(vsprintf($sql,$args));
+               return $ret;
+       }
+
+       /**
+        *
+        * This will happen occasionally trying to store the 
+        * session data after abnormal program termination 
+        *
+        */
+
+       logger('dba: no database: ' . print_r($args,true));
+       return false; 
+
+}}
+
+/**
+ *
+ * Raw db query, no arguments
+ *
+ */
+
+if(! function_exists('dbq')) { 
+function dbq($sql) {
+
+       global $db;
+       $ret = $db->q($sql);
        return $ret;
 }}
 
@@ -131,8 +179,8 @@ function dbesc_array_cb(&$item, $key) {
 
 
 if(! function_exists('dbesc_array')) {
-function dbesc_array(&$a) {
-       if(is_array($a) && count($a)) {
-               array_walk($a,'dbesc_array_cb');
+function dbesc_array(&$arr) {
+       if(is_array($arr) && count($arr)) {
+               array_walk($arr,'dbesc_array_cb');
        }
 }}             
\ No newline at end of file