Changeset 2502

Timestamp:

Sep 5, 2008, 3:24:01 AM (16 years ago)

Author:

rvelices

Message:

• better management of fatal errors (instead of die or trigger_error rather use fatal_error ...)

Location:

trunk

Files:

• admin/include/functions.php (modified) (1 diff)
• include/common.inc.php (modified) (3 diffs)
• include/functions.inc.php (modified) (6 diffs)
• include/functions_calendar.inc.php (modified) (2 diffs)
• include/functions_html.inc.php (modified) (1 diff)
• include/functions_url.inc.php (modified) (3 diffs)
• include/template.class.php (modified) (1 diff)
• plugins/SwiftThemeCreator/simul (modified) (1 prop)
• plugins/SwiftThemeCreator/simul/.cvsignore (deleted)

trunk/admin/include/functions.php

@@ -1833 +1833 @@
 function create_table_add_character_set($query)
 {
-  defined('DB_CHARSET') or trigger_error('create_table_add_character_set DB_CHARSET undefined', E_USER_ERROR);
+  defined('DB_CHARSET') or fatal_error('create_table_add_character_set DB_CHARSET undefined');
   if ('DB_CHARSET'!='')
   {

trunk/include/common.inc.php

@@ -22 +22 @@
 // +-----------------------------------------------------------------------+
 
-if (!defined('PHPWG_ROOT_PATH'))
-{
-  die('Hacking attempt!');
-}
+defined('PHPWG_ROOT_PATH') or trigger_error('Hacking attempt!', E_USER_ERROR);
+
 // determine the initial instant to indicate the generation time of this page
 $t1 = explode( ' ', microtime() );
@@ -147 +145 @@
 
 defined('PWG_CHARSET') and defined('DB_CHARSET')
-  or die('PWG_CHARSET and/or DB_CHARSET is not defined');
+  or fatal_error('PWG_CHARSET and/or DB_CHARSET is not defined');
 if ( version_compare(mysql_get_server_info(), '4.1.0', '>=') )
 {
@@ -159 +157 @@
   if ( strtolower(PWG_CHARSET)!='iso-8859-1' )
   {
-    die('PWG supports only iso-8859-1 charset on MySql version '.mysql_get_server_info());
+    fatal_error('PWG supports only iso-8859-1 charset on MySql version '.mysql_get_server_info());
   }
 }

trunk/include/functions.inc.php

@@ -233 +233 @@
     if ($mkd==false)
     {
-      !($flags&MKGETDIR_DIE_ON_ERROR) or trigger_error( "$dir ".l10n('no_write_access'), E_USER_ERROR);
+      !($flags&MKGETDIR_DIE_ON_ERROR) or fatal_error( "$dir ".l10n('no_write_access'));
       return false;
     }
@@ -251 +251 @@
     if ( !is_writable($dir) )
     {
-      !($flags&MKGETDIR_DIE_ON_ERROR) or trigger_error( "$dir ".l10n('no_write_access'), E_USER_ERROR);
+      !($flags&MKGETDIR_DIE_ON_ERROR) or fatal_error( "$dir ".l10n('no_write_access'));
       return false;
     }
@@ -946 +946 @@
 // my_error returns (or send to standard output) the message concerning the
 // error occured for the last mysql query.
-
 function my_error($header, $die)
 {
-  $error = $header;
-  $error.= "\n[mysql error ".mysql_errno().'] '.mysql_error()."\n";
-
-  if (function_exists('debug_backtrace'))
-  {
-    $bt = debug_backtrace();
-    for ($i=0; $i<count($bt); $i++)
-    {
-      $error .= "#$i\t".@$bt[$i]['function']." ".@$bt[$i]['file']."(".@@$bt[$i]['line'].")\n";
-    }
-  }
+  $error = "[mysql error ".mysql_errno().'] '.mysql_error()."\n";
+  $error .= $header;
 
   if ($die)
   {
-    @set_status_header(500);
-    echo( str_repeat( ' ', 300)."\n"); //IE doesn't error output if below a size
+    fatal_error($error);
   }
   echo("<pre>");
-  trigger_error($error, $die ? E_USER_ERROR : E_USER_WARNING);
-  !$die || die($error); // just in case the handler didnt die
+  trigger_error($error, E_USER_WARNING);
   echo("</pre>");
 }
@@ -1138 +1126 @@
   else
   {
-    die('l10n_args: Invalid arguments');
+    fatal_error('l10n_args: Invalid arguments');
   }
 
@@ -1222 +1210 @@
   if ((mysql_num_rows($result) == 0) and !empty($condition))
   {
-    die('No configuration data');
+    fatal_error('No configuration data');
   }
 
@@ -1372 +1360 @@
 function get_pwg_charset()
 {
-  defined('PWG_CHARSET') or die('load_language PWG_CHARSET undefined');
+  defined('PWG_CHARSET') or fatal_error('load_language PWG_CHARSET undefined');
   return PWG_CHARSET;
 }

trunk/include/functions_calendar.inc.php

@@ -116 +116 @@
 
   // Retrieve calendar field
-  if ( !isset( $fields[ $page['chronology_field'] ] ) )
-  {
-    die('bad chronology field');
-  }
+  isset( $fields[ $page['chronology_field'] ] ) or fatal_error('bad chronology field');
 
   // Retrieve style
@@ -199 +196 @@
       $must_show_list = false;
     }
-    
+
     $page['comment'] = '';
     $template->assign('FILE_CHRONOLOGY_VIEW', 'month_calendar.tpl');

trunk/include/functions_html.inc.php

@@ -651 +651 @@
 }
 
+/**
+ * exits the current script with 500 http code
+ * this method can be called at any time (does not use template/language/user etc...)
+ * @param string msg a message to display
+ */
+function fatal_error($msg)
+{
+  $btrace_msg = '';
+  if (function_exists('debug_backtrace'))
+  {
+    $bt = debug_backtrace();
+    for ($i=1; $i<count($bt); $i++)
+    {
+      $class = isset($bt[$i]['class']) ? (@$bt[$i]['class'].'::') : '';
+      $btrace_msg .= "#$i\t".$class.@$bt[$i]['function'].' '.@$bt[$i]['file']."(".@$bt[$i]['line'].")\n";
+    }
+    $btrace_msg = trim($btrace_msg);
+    $msg .= "\n";
+  }
+
+  $display = "<h1>Piwigo encountered a non recoverable error</h1>
+<pre style='font-size:larger;background:white;color:red;padding:1em;margin:0;clear:both;display:block;width:auto;height:auto;overflow:auto'>
+<b>$msg</b>
+$btrace_msg
+</pre>\n";
+
+  @set_status_header(500);
+  echo $display.str_repeat( ' ', 300); //IE doesn't error output if below a size
+
+  if ( function_exists('ini_set') )
+  {// if possible turn off error display (we display it)
+    ini_set('display_errors', false);
+  }
+  error_reporting( E_ALL );
+  trigger_error( strip_tags($msg).$btrace_msg, E_USER_ERROR );
+  die(0); // just in case
+}
+
 /* returns the title to be displayed above thumbnails on tag page
  */

trunk/include/functions_url.inc.php

@@ -220 +220 @@
 {
   global $conf;
-  if (!isset($params['image_id']))
-  {
-    die('make_picture_url: image_id is a required parameter');
-  }
+
+  isset($params['image_id']) or fatal_error('make_picture_url: image_id is a required parameter');
 
   $url = get_root_url().'picture';
@@ -376 +374 @@
       if (!isset($params['tags']) or count($params['tags']) == 0)
       {
-        die('make_section_in_url: require at least one tag');
+        fatal_error('make_section_in_url: require at least one tag');
       }
 
@@ -407 +405 @@
     case 'search' :
     {
-      if (!isset($params['search']))
-      {
-        die('make_section_in_url: require a search identifier');
-      }
-
+      isset($params['search']) or fatal_error('make_section_in_url: require a search identifier');
       $section_string.= '/search/'.$params['search'];
-
       break;
     }
     case 'list' :
     {
-      if (!isset($params['list']))
-      {
-        die('make_section_in_url: require a list of items');
-      }
-
+      isset($params['list']) or fatal_error('make_section_in_url: require a list of items');
       $section_string.= '/list/'.implode(',', $params['list']);
-
       break;
     }

trunk/include/template.class.php

@@ -225 +225 @@
     if ( !isset($this->files[$handle]) )
     {
-      trigger_error("Template->parse(): Couldn't load template file for handle $handle", E_USER_ERROR);
+      fatal_error("Template->parse(): Couldn't load template file for handle $handle");
     }