includes/errors.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 $messages = array(); // container for system messages
  13 $before_box = ''; // temporary container for output html data before error box
  14
  15 function get_backtrace($html = false, $skip=0)
  16 {
  17         $str = '';
  18         if ($html) $str .= '<table border=0>';
  19         $trace = debug_backtrace();
  20
  21         foreach($trace as $trn => $tr) {
  22                 if ($trn <= $skip) continue;
  23                 if ($html) $str .= '<tr><td>';
  24                 $str .= $tr['file'].':'.$tr['line'].': ';
  25                 if ($html) $str .= '</td><td>';
  26                 if (isset($tr['type'])) {
  27                         if($tr['type'] == '::') {
  28                                 $str .= $tr['class'].'::';
  29                         } else if($tr['type'] == '->') {
  30                                 $str .= '('.$tr['class'].' Object)'.'->';
  31                         }
  32                 }
  33                 $str .= $tr['function'].'(';
  34
  35                 if(is_array($tr['args'])) {
  36                         $args = array();
  37                         foreach($tr['args'] as $n=>$a) {
  38                                 if (is_object($tr['args'][$n]))
  39                                         $args[$n] = "(".get_class($tr['args'][$n])." Object)";
  40                                 elseif (is_array($tr['args'][$n]))
  41                                         $args[$n] = "(Array[".count($tr['args'][$n])."])";
  42                                 else
  43                                         $args[$n] = "'".$tr['args'][$n]."'";
  44                         }
  45                         $str .= implode(',',$args);
  46                 }
  47                 $str .= ')</td>';
  48         }
  49
  50         if ($html) $str .= '</tr></table>';
  51         return $str;
  52 }
  53
  54 //-----------------------------------------------------------------------------
  55 //    Error handler - collects all php/user messages for
  56 //    display in message box.
  57
  58 function error_handler($errno, $errstr, $file, $line) {
  59     global $messages, $go_debug, $SysPrefs;
  60
  61         // skip well known warnings we don't care about.
  62         // Please use restrainedly to not risk loss of important messages
  63         $excluded_warnings = array(
  64                 'html_entity_decode', 'htmlspecialchars',       // nevermind encodings, special chars are processed anyway
  65                 'should be compatible with that'                        // ignore cpdf/frontreport wrapper warnings
  66         );
  67         foreach($excluded_warnings as $ref) {
  68                 if (strpos($errstr, $ref) !== false) {
  69                         return true;
  70                 }
  71         }
  72
  73         if ($go_debug>1) {
  74                 $bt = get_backtrace(true, 1);
  75         }
  76
  77         // error_reporting==0 when messages are set off with @
  78         if ($errno & error_reporting()) {
  79                 // suppress duplicated errors
  80                 if (!in_array(array($errno, $errstr, $file, $line, @$bt), $messages))
  81                         $messages[] = array($errno, $errstr, $file, $line, @$bt);
  82         }
  83         else if($errno&~E_NOTICE) { // log all not displayed messages
  84                 $user = @$_SESSION["wa_current_user"]->loginname;
  85                 $context = isset($SysPrefs) && !$SysPrefs->db_ok ? '[before upgrade]' : '';
  86                 error_log(user_company() . ":$user:". basename($file) .":$line:$context $errstr");
  87         }
  88
  89     return true;
  90 }
  91 //------------------------------------------------------------------------------
  92 //      Formats system messages before insert them into message <div>
  93 // FIX center is unused now
  94 function fmt_errors($center=false) {
  95     global $messages, $path_to_root, $go_debug;
  96
  97   $msg_class = array(
  98         E_USER_ERROR => 'err_msg',
  99         E_USER_WARNING =>'warn_msg',
 100         E_USER_NOTICE => 'note_msg');
 101
 102   $type = E_USER_NOTICE;
 103   $content = '';
 104 //  $class = 'no_msg';
 105   if (count($messages)) {
 106         foreach($messages as $cnt=>$msg) {
 107                 if ($go_debug && $msg[0]>E_USER_NOTICE)
 108                         $msg[0] = E_ERROR;
 109
 110                 if ($msg[0]>$type) continue;
 111
 112                 if ($msg[0]<$type) {
 113                         if ($msg[0] == E_USER_WARNING) {
 114                                 $type = E_USER_WARNING; // user warnings
 115                                 $content = '';                  // clean notices when we have errors
 116                         } else  {
 117                                 $type = E_USER_ERROR;   // php or user errors
 118                                 if($type == E_USER_WARNING)
 119                                         $content = '';                  // clean other messages
 120                         }
 121                 }
 122
 123             $str = $msg[1];
 124                 if (!in_array($msg[0], array(E_USER_NOTICE, E_USER_ERROR, E_USER_WARNING)) && $msg[2] != null)
 125                   $str .= ' '._('in file').': '.$msg[2].' '._('at line ').$msg[3];
 126
 127                 if ($go_debug>1 && $type!=E_USER_NOTICE && $type!=E_USER_WARNING)
 128                   $str .= '<br>'.$msg[4];
 129                 $content .= ($cnt ? '<hr>' : '').$str;
 130         }
 131         $class = $msg_class[$type];
 132     $content = "<div class='$class'>$content</div>";
 133   } else
 134   if ($path_to_root=='.')
 135         return '';
 136   return $content;
 137 }
 138 //-----------------------------------------------------------------------------
 139 // Error box <div> element.
 140 //
 141 function error_box() {
 142     global $before_box;
 143
 144     echo "<div id='msgbox'>";
 145
 146 // Necessary restart instead of get_contents/clean calls due to a bug in php 4.3.2
 147         $before_box = ob_get_clean(); // save html content before error box
 148     ob_start('output_html');
 149     echo "</div>";
 150 }
 151 /*
 152         Helper to avoid sparse log notices.
 153 */
 154 function end_flush() {
 155         global $Ajax;
 156
 157         if (isset($Ajax))
 158                 $Ajax->run();
 159
 160          // on some (but not all) php versions zlib extension adds 1 additional level of buffering,
 161          // so flush the last buffer outside the loop to be on safe side
 162         while(ob_get_level() > 1)
 163                 ob_end_flush();
 164         @ob_end_flush();
 165
 166         // if any transaction was aborted unexpectedly rollback changes
 167         cancel_transaction();
 168 }
 169
 170 function display_db_error($msg, $sql_statement=null, $exit=true)
 171 {
 172         global $db, $debug, $go_debug, $db_connections;
 173
 174         $warning = $msg==null;
 175         $db_error = db_error_no();
 176
 177 //      $str = "<span class='errortext'><b>" . _("DATABASE ERROR :") . "</b> $msg</span><br>";
 178         if($warning)
 179                 $str = "<b>" . _("Debug mode database warning:") . "</b><br>";
 180         else
 181                 $str = "<b>" . _("DATABASE ERROR :") . "</b> $msg<br>";
 182
 183         if ($db_error != 0)
 184         {
 185                 $str .= "error code : " . $db_error . "<br>";
 186                 $str .= "error message : " . db_error_msg($db) . "<br>";
 187         }
 188
 189         if ($debug == 1)
 190         {
 191                 $cur_prefix = $db_connections[$_SESSION["wa_current_user"]->cur_con]['tbpref'];
 192
 193                 $str .= "sql that failed was : ".str_replace(TB_PREF, $cur_prefix, $sql_statement)."<br>";
 194 //              if ($go_debug > 1) display_backtrace();
 195         }
 196
 197         $str .= "<br><br>";
 198         if($msg)
 199                 trigger_error($str, E_USER_ERROR);
 200         else    // $msg can be null here only in debug mode, otherwise the error is ignored
 201                 trigger_error($str, E_USER_WARNING);
 202         if ($exit)
 203                 exit;
 204 }
 205
 206 function frindly_db_error($db_error)
 207 {
 208         global $db_duplicate_error_code;
 209
 210         if ($db_error == $db_duplicate_error_code)
 211         {
 212                 display_error(_("The entered information is a duplicate. Please go back and enter different values."));
 213                 return true;
 214         }
 215
 216         return false;
 217 }
 218
 219 function check_db_error($msg, $sql_statement, $exit_if_error=true, $rollback_if_error=true)
 220 {
 221         global $db, $go_debug;
 222         $db_error = db_error_no();
 223
 224         if ($db_error != 0)
 225         {
 226
 227                 if ($go_debug || !frindly_db_error($db_error)) {
 228                                 display_db_error($msg, $sql_statement, false);
 229                 }
 230
 231                 if ($rollback_if_error)
 232                 {
 233                   $rollback_result = db_query("rollback");
 234                 }
 235
 236                 if ($exit_if_error)
 237                 {
 238                         end_page(); exit;
 239                 }
 240         }
 241         return $db_error;
 242 }
 243
 244 ?>