Helpers in custom CakeErrorController are lost

rchavik · rchavik · commit 07d9a75fcb45 · 2012-06-01T15:28:06.000+07:00
Since many exceptions do not have its own 'template' file, customized
APP/Controller/CakeErrorController with its own list of helpers could be
ignored.

This happens becase ExceptionRenderer is forced to to use _outputMessageSafe
when a template is missing.  This causes Controller::$helpers to be reset with
default values.
diff --git a/lib/Cake/Error/ExceptionRenderer.php b/lib/Cake/Error/ExceptionRenderer.php
@@ -263,6 +263,12 @@ protected function _outputMessage($template) {
 			$this->controller->render($template);
 			$this->controller->afterFilter();
 			$this->controller->response->send();
+		} catch (MissingViewException $e) {
+			try {
+				$this->_outputMessage('error500');
+			} catch (Exception $e) {
+				$this->_outputMessageSafe('error500');
+			}
 		} catch (Exception $e) {
 			$this->_outputMessageSafe('error500');
 		}
diff --git a/lib/Cake/Test/Case/Error/ExceptionRendererTest.php b/lib/Cake/Test/Case/Error/ExceptionRendererTest.php
@@ -277,6 +277,49 @@ public function testErrorMethodCoercion() {
 		$this->assertEquals($exception, $ExceptionRenderer->error);
 	}
 
+/**
+ * test that helpers in custom CakeErrorController are not lost
+ */
+	public function testCakeErrorHelpersNotLost() {
+		$testApp = CAKE . 'Test' . DS . 'test_app' . DS;
+		App::build(array(
+			'Controller' => array(
+				$testApp . 'Controller' . DS
+			),
+			'View/Helper' => array(
+				$testApp . 'View' . DS . 'Helper' . DS
+			),
+			'View/Layouts' => array(
+				$testApp . 'View' . DS . 'Layouts' . DS
+			),
+			'Error' => array(
+				$testApp . 'Error' . DS
+			),
+		), App::RESET);
+		Configure::write('Error', array(
+			'handler' => 'TestAppsErrorHandler::handleError',
+			'level' => E_ALL & ~E_DEPRECATED,
+			'trace' => true
+		));
+
+		Configure::write('Exception', array(
+			'handler' => 'TestAppsErrorHandler::handleException',
+			'renderer' => 'TestAppsExceptionRenderer',
+			'log' => true
+		));
+
+		App::uses('TestAppsErrorController', 'Controller');
+		App::uses('TestAppsExceptionRenderer', 'Error');
+
+		$exception = new SocketException('socket exception');
+		$renderer = new TestAppsExceptionRenderer($exception);
+
+		ob_start();
+		$renderer->render();
+		$result = ob_get_clean();
+		$this->assertContains('<b>peeled</b>', $result);
+	}
+
 /**
  * test that unknown exception types with valid status codes are treated correctly.
  *
diff --git a/lib/Cake/Test/test_app/Controller/TestAppsErrorController.php b/lib/Cake/Test/test_app/Controller/TestAppsErrorController.php
@@ -0,0 +1,14 @@
+<?php
+
+App::uses('CakeErrorController', 'Controller');
+
+class TestAppsErrorController extends CakeErrorController {
+
+	public $helpers = array(
+		'Html',
+		'Session',
+		'Form',
+		'Banana',
+	);
+
+}
diff --git a/lib/Cake/Test/test_app/Error/TestAppsExceptionRenderer.php b/lib/Cake/Test/test_app/Error/TestAppsExceptionRenderer.php
@@ -0,0 +1,21 @@
+<?php
+
+class TestAppsExceptionRenderer extends ExceptionRenderer {
+
+	protected function _getController($exception) {
+		App::uses('TestAppsErrorController', 'Controller');
+		if (!$request = Router::getRequest(true)) {
+			$request = new CakeRequest();
+		}
+		$response = new CakeResponse(array('charset' => Configure::read('App.encoding')));
+		try {
+			$controller = new TestAppsErrorController($request, $response);
+			$controller->layout = 'banana';
+		} catch (Exception $e) {
+			$controller = new Controller($request, $response);
+			$controller->viewPath = 'Errors';
+		}
+		return $controller;
+	}
+
+}
diff --git a/lib/Cake/Test/test_app/View/Helper/BananaHelper.php b/lib/Cake/Test/test_app/View/Helper/BananaHelper.php
@@ -19,4 +19,9 @@
 App::uses('Helper', 'View');
 
 class BananaHelper extends Helper {
+
+	public function peel() {
+		return '<b>peeled</b>';
+	}
+
 }
diff --git a/lib/Cake/Test/test_app/View/Layouts/banana.ctp b/lib/Cake/Test/test_app/View/Layouts/banana.ctp
@@ -0,0 +1,5 @@
+<body>
+<?php
+	echo $this->Banana->peel();
+?>
+</body>

Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,9 @@`
`19`	`19`	`App::uses('Helper', 'View');`
`20`	`20`
`21`	`21`	`class BananaHelper extends Helper {`
	`22`	`+`
	`23`	`+ public function peel() {`
	`24`	`+ return '<b>peeled</b>';`
	`25`	`+ }`
	`26`	`+`
`22`	`27`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +<body>
 +<?php
 +	echo $this->Banana->peel();
 +?>
 +</body>