KTS-3148

"Custom Error Page cannot be disabled." Fixed. Cleaned up custom error page functionality. Committed By: Jonathan Byrne Reviewed By: Megan Watson git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8368 c91229c3-7414-0410-bfa2-8a42b809f60b

KTS-3148
"Custom Error Page cannot be disabled." Fixed. Cleaned up custom error page functionality. Committed By: Jonathan Byrne Reviewed By: Megan Watson git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8368 c91229c3-7414-0410-bfa2-8a42b809f60b
Jonathan Byrne
1 parent f88492af
Showing 7 changed files with 171 additions and 85 deletions
config/config.ini
config/dmsDefaults.php
customerrorpage.php
lib/dispatcher.inc.php
lib/validation/customerror.php
lib/validation/customerrorhandler.php
lib/validation/customerrorviewer.inc.php
@@ -398,9 +398,12 @@ warningThreshold=10
 urgentThreshold=5
 [CustomErrorMessages]
-;Turn custom error messages on or off here // account wide
-customerrormessages=on
-;name or url of custom error page
+;Turn custom error messages on or off here.
+customerrormessages=off
+;name or url of custom error page.
 customerrorpagepath=customerrorpage.php
-;Turn custom error handler on or off
+;Turn custom error handler on or off.
+;The custom error handler will log any non php errors caught
+;by the custom error handler if it is turned on.
+;Php errors are always logged by php itself.
 customerrorhandler=on
@@ -97,6 +97,7 @@ if (!defined(&#39;PATH_SEPARATOR&#39;)) {
 }
 require_once(KT_LIB_DIR . '/Log.inc');
+require_once(KT_LIB_DIR . '/validation/customerror.php');
 // {{{ KTInit
 class KTInit {
@@ -388,18 +389,27 @@ class KTInit {
     // }}}
-function catchFatalErrors($p_OnOff='On'){
-	ini_set('display_errors','On');
-    $phperror='><div id="phperror" style="display:none">';
-	ini_set('error_prepend_string',$phperror);
-
-	$sUrl = KTInit::guessRootUrl();
-	global $default;
-	$sRootUrl = ($default->sslEnabled ? 'https' : 'http') .'://'.$_SERVER['HTTP_HOST'].$sUrl;
-
-	$phperror='</div>><form name="catcher" action="'.$sRootUrl.'/customerrorpage.php" method="post" ><input type="hidden" name="fatal" value=""></form>
-	<script> document.catcher.fatal.value = document.getElementById("phperror").innerHTML; document.catcher.submit();</script>';
-	ini_set('error_append_string',$phperror);
+function catchFatalErrors()
+{
+	
+	$CustomErrorPage = KTCustomErrorViewer::getCustomErrorRedirectPage();
+	if($CustomErrorPage != '0')
+	{
+		ini_set('display_errors','On');
+	    $phperror='><div id="phperror" style="display:none">';
+		ini_set('error_prepend_string',$phperror);
+	
+		$sUrl = KTInit::guessRootUrl();
+		global $default;
+		$sRootUrl = ($default->sslEnabled ? 'https' : 'http') .'://'.$_SERVER['HTTP_HOST'].$sUrl;
+		
+		$CustomErrorPage = basename($CustomErrorPage);
+		
+		$phperror='</div>><form name="catcher" action="'.$sRootUrl.'/'.$CustomErrorPage.'" method="post" ><input type="hidden" name="fatal" value=""></form>
+		<script> document.catcher.fatal.value = document.getElementById("phperror").innerHTML; document.catcher.submit();</script>';
+		ini_set('error_append_string',$phperror);
+	}
+	
 }
@@ -704,21 +714,6 @@ require_once(KT_LIB_DIR . &#39;/util/ktutil.inc&#39;);
 require_once(KT_LIB_DIR . '/ktentity.inc');
-//$KTInit->catchFatalErrors();
-
-if (phpversion()<5){
-
-	$sErrorPage = 'http://'.$_SERVER['HTTP_HOST'].'/'.'customerrorpage.php';
-
-	session_start();
-
-	$_SESSION['sErrorMessage'] = 'KnowledgeTree now requires that PHP version 5 is installed. PHP version 4 is no longer supported.';
-
-
-	header('location:'. $sErrorPage ) ;
-
-}
-
 require_once(KT_LIB_DIR . '/config/config.inc.php');
 require_once(KT_DIR . '/search2/indexing/indexerCore.inc.php');
@@ -732,6 +727,24 @@ if (isset($GLOBALS[&#39;kt_test&#39;])) {
 }
 $oKTConfig =& KTConfig::getSingleton();
+
+if($oKTConfig->get('CustomErrorMessages/customerrormessages') == 'on')
+{
+	$KTInit->catchFatalErrors();
+}
+
+if (phpversion()<5){
+
+	$sErrorPage = 'http://'.$_SERVER['HTTP_HOST'].'/'.'customerrorpage.php';
+
+	session_start();
+
+	$_SESSION['sErrorMessage'] = 'KnowledgeTree now requires that PHP version 5 is installed. PHP version 4 is no longer supported.';
+
+
+	header('location:'. $sErrorPage ) ;
+
+}
 $KTInit->setupServerVariables();
 // instantiate log
@@ -13,32 +13,39 @@ if (array_key_exists(&#39;Error_MessageOne&#39;, $_POST) &amp;&amp; array_key_exists(&#39;Error_Mess
 }
 session_start();
-require_once("config/dmsDefaults.php");
+
 if (array_key_exists('sErrorMessage', $_SESSION))
 {
-$phperror = $_SESSION['sErrorMessage'];
+	$phperror = $_SESSION['sErrorMessage'];
 }
-global $default;
-
-$sUrl = $default->rootUrl;
+//Finding root Url
+$sHost = $_SERVER['HTTP_HOST'];
+$sScriptName = dirname($_SERVER['SCRIPT_NAME']);
+$sRoot = $sHost.$sScriptName;
+$bSSLEnabled = false;
+if ($_SERVER['HTTPS'] === 'on')
+{
+	$bSSLEnabled = true;
+}
+$sRootUrl = ($bSSLEnabled ? 'https://' : 'http://').$sRoot;
 ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>
 	<head>
 		<title>Knowledgetree - Desklet</title>
-		<link rel="stylesheet" type="text/css" href="<?php echo $sUrl ?>/resources/css/errors.css" />
+		<link rel="stylesheet" type="text/css" href="<?php echo $sRootUrl ?>/resources/css/errors.css" />
 	<script type="text/javascript"> 
 function Click()
 {
-var open = document.getElementById('exp');
-open.style.display = 'block';
-var border = document.getElementById('error-container');
-border.style.height = '250px'; 
+	var open = document.getElementById('exp');
+	open.style.display = 'block';
+	var border = document.getElementById('error-container');
+	border.style.height = '250px'; 
 }
 </script>		
@@ -53,7 +60,7 @@ border.style.height = &#39;250px&#39;;
 				<h1>Error!! - You have encountered a problem starting your document management system.</h1>
 				<p><h2>Please contact your systems administrator</h2></p>
-				<p>For more details, click here <img src="<?php echo $sUrl ?>/resources/graphics/info.gif" style="cursor: pointer;" onclick="Click()" /><div id ="exp" style="display: none; "> <?php if(isset($sErrorMessage)){ echo $sErrorMessage;  }else  if(isset($posted)){ echo $posted; } else if($phperror){ echo $phperror; } ?></div></p>
+				<p>For more details, click here <img src="<?php echo $sRootUrl ?>/resources/graphics/info.gif" style="cursor: pointer;" onclick="Click()" /><div id ="exp" style="display: none; "> <?php if(isset($sErrorMessage)){ echo $sErrorMessage;  }else  if(isset($posted)){ echo $posted; } else if($phperror){ echo $phperror; } ?></div></p>
 			</div>		
 		</div>		
@@ -537,38 +537,17 @@ class KTErrorDispatcher extends KTStandardDispatcher {
     }
     function dispatch() {
-        require_once(KT_LIB_DIR . '/validation/errorviewer.inc.php');
-        require_once(KT_LIB_DIR . '/validation/customerrorviewer.inc.php');
-                
-        $oCustomViewer =& KTCustomErrorViewer::initCustomErrorViewer();
-                
-        //if the custom error messages are set to 'on' in the config file 
-        //we check if the error page exists and redirect to it if it does.
-        //if either the page doesn't exit or the custom error option is off in the config file
-        //we carry out default error reporting
-        if ($oCustomViewer->getCustomErrorConfigSetting() == 'on'){
-        	$CustomErrorPage = $oCustomViewer->getCustomErrorRedirectPage();
-        	if ( $CustomErrorPage != '0') //if an error is not returned from getCustomErrorRedirectPage();
-        	{
-        		$sErrorHandler = $oCustomViewer->getCustomErrorHandlerSetting();
-
-        		//redirect
-        		if ($sErrorHandler == 'on')
-        		{
-        			//if custom error handler is set to on inside config.ini then send error object with error page
-        			$oCustomViewer->doCustomErrorPageRedirect($CustomErrorPage, $this->oError);
-				}
-        		else if ($sErrorHandler != 'on')
-        		{
-        			//if custom error handler is set to off inside config.ini then just send error page
-        			$oCustomViewer->doCustomErrorPageRedirect($CustomErrorPage);
-        		}
-        		
-        		//exit without errors	
-        		exit(0);
-           	}
+        
+        require_once(KT_LIB_DIR . '/validation/customerror.php');
+        
+        $bCustomCheck = KTCustomErrorCheck::customErrorInit($this->oError);
+              
+        if($bCustomCheck)
+        {
+        	exit(0);
         }
+                
         //if either customer error messages is off or the custom error page doesn't exist the function will run 
         //the default error handling here
         $oRegistry =& KTErrorViewerRegistry::getSingleton();
+<?php
+/**
+ * $Id: $
+ *
+ * KnowledgeTree Open Source Edition
+ * Document Management Made Simple
+ * Copyright (C) 2004 - 2008 The Jam Warehouse Software (Pty) Limited
+ * 
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 3 as published by the
+ * Free Software Foundation.
+ * 
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ * You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
+ * Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
+ * 
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ * 
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "Powered by
+ * KnowledgeTree" logo and retain the original copyright notice. If the display of the 
+ * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
+ * must display the words "Powered by KnowledgeTree" and retain the original 
+ * copyright notice. 
+ * Contributor( s): ______________________________________
+ */
+ 
+require_once(KT_LIB_DIR . '/validation/errorviewer.inc.php');
+require_once(KT_LIB_DIR . '/validation/customerrorviewer.inc.php');
+                
+class KTCustomErrorCheck
+{
+    function customErrorInit($error)
+	{
+		$oCustomViewer =& KTCustomErrorViewer::initCustomErrorViewer();
+		        
+		//if the custom error messages are set to 'on' in the config file 
+		//we check if the error page exists and redirect to it if it does.
+		//if either the page doesn't exit or the custom error option is off in the config file
+		//we carry out default error reporting
+		if ($oCustomViewer->getCustomErrorConfigSetting() == 'on')
+		{
+			
+			$CustomErrorPage = $oCustomViewer->getCustomErrorRedirectPage();
+			if ( $CustomErrorPage != '0') //if an error is not returned from getCustomErrorRedirectPage();
+			{
+				
+				$sErrorHandler = $oCustomViewer->getCustomErrorHandlerSetting();
+					
+				
+				if ($sErrorHandler == 'on')
+				{
+					$oErrorHandler = KTCustomErrorHandler::initCustomErrorHandler();
+					$oErrorHandler->logError($error);
+				}
+				
+				//redirect
+				$oCustomViewer->doCustomErrorPageRedirect($CustomErrorPage, $error);
+				
+				
+				//exit without errors	
+				return true;
+		   	}
+		   	else
+		   	{
+		   		return false;
+		   	}
+		}
+		else
+		{
+			return false;
+		}
+	}
+}
+?>
 \ No newline at end of file
@@ -33,7 +33,7 @@
  * copyright notice. 
  * Contributor( s): ______________________________________
  */
-  require_once('config/dmsDefaults.php');
+  //require_once(KT_DIR.'config/dmsDefaults.php');
   require_once(KT_LIB_DIR.'/Log.inc');
  class KTCustomErrorHandler
@@ -72,7 +72,11 @@
     	if (substr($sCustomErrorPage, 0, 4) != 'http')
     	{
-    		$sCustomErrorPage = 'http://'.$_SERVER['HTTP_HOST'].'/'.$sCustomErrorPage;
+    		$sUrl = KTInit::guessRootUrl();
+    		global $default;
+			$sRootUrl = ($default->sslEnabled ? 'https' : 'http') .'://'.$_SERVER['HTTP_HOST'].$sUrl;
+    		$sCustomErrorPage = $sRootUrl.'/'.$sCustomErrorPage;
+ 		
     	}
@@ -106,7 +110,6 @@
     // {{{ customErrorPageRedirect()
     function doCustomErrorPageRedirect($CustomErrorPage, $oError = null)
     {
-    	$sErrorMessage = '';
     	if($oError != null)
     	{
     		//call error handler
@@ -114,22 +117,19 @@
     		$aErrorMessage = array ();
 			$aErrorMessage['Error_MessageOne'] = $oError->getMessage();
 			$aErrorMessage['Error_MessageTwo'] = $oError->getUserInfo();
-    		//echo '<pre>';
-    		//print_r($aErrorMessage);
-    		//echo '</pre>';
-    		//exit;
-    		$customErrorHandler = KTCustomErrorHandler::initCustomErrorHandler();
-    		$customErrorHandler->logError($oError);
+    		
     	}
-    	
+		
+		    	
     	$ErrorPageCurlSession = curl_init($CustomErrorPage);
-	//curl_setopt($ErrorPageCurlSession, CURLOPT_SSL_VERIFYPEER, false);
+	  //curl_setopt($ErrorPageCurlSession, CURLOPT_SSL_VERIFYPEER, false);
 		curl_setopt($ErrorPageCurlSession, CURLOPT_POST, true);
 		curl_setopt($ErrorPageCurlSession, CURLOPT_POSTFIELDS, $aErrorMessage);
     	$ErrorPageSent = curl_exec($ErrorPageCurlSession);
-   	curl_close($ErrorPageCurlSession);
-	
+   	    curl_close($ErrorPageCurlSession);
+
     }
  	// }}}
+ 	
  }
  ?>