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 //-----------------------------------------------------------------------------
  16 //    Error handler - collects all php/user messages for
  17 //    display in message box.
  18
  19 function error_handler($errno, $errstr, $file, $line) {
  20     global $messages;
  21
  22         // error_reporting==0 when messages are set off with @
  23         if ($errno & error_reporting()) {
  24                 $messages[] = array($errno, $errstr, $file, $line);
  25         }
  26     return true;
  27 }
  28 //------------------------------------------------------------------------------
  29 //      Formats system messages before insert them into message <div>
  30 // FIX center is unused now
  31 function fmt_errors($center=false) {
  32     global $messages, $path_to_root;
  33
  34   $msg_class = array(
  35         E_USER_ERROR => 'err_msg',
  36         E_USER_WARNING =>'warn_msg',
  37         E_USER_NOTICE => 'note_msg');
  38
  39   $type = E_USER_NOTICE;
  40   $content = '';
  41   $class = 'no_msg';
  42   if (count($messages)) {
  43         foreach($messages as $cnt=>$msg) {
  44                 if ($msg[0]>$type) continue;
  45
  46                 if ($msg[0]<$type) {
  47                         if ($msg[0] == E_USER_WARNING) {
  48                                 $type = E_USER_WARNING; // user warnings
  49                                 $content = '';                  // clean notices when we have errors
  50                         } else  {
  51                                 $type = E_USER_ERROR;   // php or user errors
  52                                 if($type == E_USER_WARNING)
  53                                         $content = '';                  // clean other messages
  54                         }
  55                 }
  56             $str = $msg[1];
  57                 if ($msg[0] < E_USER_ERROR && $msg[2] != null)
  58                   $str .= ' '._('in file').': '.$msg[2].' '._('at line ').$msg[3];
  59                 $content .= ($cnt ? '<hr>' : '').$str;
  60         }
  61         $class = $msg_class[$type];
  62   } else
  63    if ($path_to_root=='.')
  64     return '';
  65
  66   $content = "<div class='$class'>$content</div>";
  67   return $content;
  68 }
  69 //-----------------------------------------------------------------------------
  70 // Error box <div> element.
  71 //
  72 function error_box() {
  73     global $before_box;
  74
  75     echo "<div id='msgbox'>";
  76     $before_box = ob_get_clean(); // save html content before error box
  77 // Necessary restart instead of get_contents/clean calls due to a bug in php 4.3.2
  78         register_shutdown_function('ob_end_flush');
  79     ob_start('output_html');
  80     echo "</div>";
  81 }
  82
  83 function display_db_error($msg, $sql_statement=null, $exit=true)
  84 {
  85         global $db, $debug;
  86
  87         $warning = $msg==null;
  88         $db_error = db_error_no();
  89
  90 //      $str = "<span class='errortext'><b>" . _("DATABASE ERROR :") . "</b> $msg</span><br>";
  91         if($warning)
  92                 $str = "<b>" . _("Debug mode database warning:") . "</b><br>";
  93         else
  94                 $str = "<b>" . _("DATABASE ERROR :") . "</b> $msg<br>";
  95
  96         if ($db_error != 0)
  97         {
  98                 $str .= "error code : " . $db_error . "<br>";
  99                 $str .= "error message : " . db_error_msg($db) . "<br>";
 100         }
 101
 102         if ($debug == 1)
 103         {
 104                 $str .= "sql that failed was : " . $sql_statement . "<br>";
 105         }
 106
 107         $str .= "<br><br>";
 108         if($msg)
 109                 trigger_error($str, E_USER_ERROR);
 110         else    // $msg can be null here only in debug mode, otherwise the error is ignored
 111                 trigger_error($str, E_USER_WARNING);
 112         if ($exit)
 113                 exit;
 114 }
 115
 116 function frindly_db_error($db_error)
 117 {
 118         global $db_duplicate_error_code;
 119
 120         if ($db_error == $db_duplicate_error_code)
 121         {
 122                 display_error(_("The entered information is a duplicate. Please go back and enter different values."));
 123                 return true;
 124         }
 125
 126         return false;
 127 }
 128
 129 function check_db_error($msg, $sql_statement, $exit_if_error=true, $rollback_if_error=true)
 130 {
 131         global $db;
 132         $db_error = db_error_no();
 133
 134         if ($db_error != 0)
 135         {
 136
 137                 if (!frindly_db_error($db_error)) {
 138                                 display_db_error($msg, $sql_statement, false);
 139                 }
 140
 141                 if ($rollback_if_error)
 142                 {
 143                   $rollback_result = db_query("rollback","could not rollback");
 144                 }
 145
 146                 if ($exit_if_error)
 147                 {
 148                         echo "<br><br>";
 149                         exit;
 150                 }
 151         }
 152         return $db_error;
 153 }
 154
 155 ?>