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