3 * A generic controller class. You should extend this base class if you want to
4 * write your own controller. You get the advantage that you can use the pre and
7 * @author Roland Haeder <webmaster@shipsimu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.shipsimu.org
13 * This program is free software: you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation, either version 3 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 class BaseController extends BaseFrameworkSystem implements Registerable {
27 // Exception constants
28 const EXCEPTION_FILTER_CHAIN_INVALID = 0xf10;
30 // Names of controller's own filter chains
31 const FILTER_CHAIN_PRE_COMMAND = 'controller_pre_command';
32 const FILTER_CHAIN_POST_COMMAND = 'controller_post_command';
35 * Generic filter chains
37 private $filterChains = array();
40 * Protected constructor
42 * @param $className Name of the class
45 protected function __construct ($className) {
46 // Call parent constructor
47 parent::__construct($className);
49 // Initialize both filter chains
50 $this->initFilterChain(self::FILTER_CHAIN_PRE_COMMAND);
51 $this->initFilterChain(self::FILTER_CHAIN_POST_COMMAND);
53 // Add this controller to the registry
54 Registry::getRegistry()->addInstance('controller', $this);
58 * Executes a command with pre and post filters
60 * @param $requestInstance A Requestable class
61 * @param $responseInstance A Responseable class
64 public function executeGenericPrePostCommand (Requestable $requestInstance, Responseable $responseInstance) {
65 // Get the command instance from the resolver by sending a request instance to the resolver
66 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
68 // Add more filters by the command
69 $commandInstance->addExtraFilters($this, $requestInstance);
71 // Run the pre filters
72 $this->executePreFilters($requestInstance, $responseInstance);
74 // This request was valid! :-D
75 $requestInstance->requestIsValid();
77 // Execute the command
78 $commandInstance->execute($requestInstance, $responseInstance);
80 // Run the post filters
81 $this->executePostFilters($requestInstance, $responseInstance);
83 // Flush the response out
84 $responseInstance->flushBuffer();
88 * Handles the given request and response, redirects to login_failed if
89 * UserAuthorizationException is thrown.
91 * @param $requestInstance An instance of a request class
92 * @param $responseInstance An instance of a response class
95 public function genericHanleRequestLoginFailedRedirect (Requestable $requestInstance, Responseable $responseInstance) {
96 // Get the "form action"
97 $formAction = $requestInstance->getRequestElement('form');
99 // Get command instance from resolver
100 $commandInstance = $this->getResolverInstance()->resolveCommand($formAction);
102 // Add more filters by the command
103 $commandInstance->addExtraFilters($this, $requestInstance);
105 // Try to run the pre filters, if auth exceptions come through redirect here
107 // Run the pre filters
108 $this->executePreFilters($requestInstance, $responseInstance);
109 } catch (UserAuthorizationException $e) {
110 // Redirect to main page
111 $responseInstance->redirectToConfiguredUrl('login_failed');
118 * Is the request still valid? Post filters shall only be executed of
119 * the request is valid
121 if ($requestInstance->isRequestValid()) {
122 // Execute the command
123 $commandInstance->execute($requestInstance, $responseInstance);
125 // Execute *very* generic ppost filters
126 $this->executePostFilters($requestInstance, $responseInstance);
129 // Flush the buffer out
130 $responseInstance->flushBuffer();
134 * Generic execute of the command: pre and post filters with redirect
135 * but request becomes valid after pre-filters run.
137 * @param $requestInstance An instance of a request class
138 * @param $responseInstance An instance of a response class
141 public function genericHanleRequestLoginAreaFailedRedirect (Requestable $requestInstance, Responseable $responseInstance) {
142 // Get the command instance from the resolver by sending a request instance to the resolver
143 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
145 // Add more filters by the command
146 $commandInstance->addExtraFilters($this, $requestInstance);
148 // Try to run the pre filters, if auth exceptions come through redirect here
150 // Run the pre filters
151 $this->executePreFilters($requestInstance, $responseInstance);
152 } catch (UserAuthorizationException $e) {
153 // Redirect to main page
154 $responseInstance->redirectToConfiguredUrl('login_failed');
160 // This request was valid! :-D
161 $requestInstance->requestIsValid();
163 // Execute the command
164 $commandInstance->execute($requestInstance, $responseInstance);
166 // Run the pre filters
167 $this->executePostFilters($requestInstance, $responseInstance);
169 // Flush the response out
170 $responseInstance->flushBuffer();
174 * Private method to initialize a given filter chain
176 * @param $filterChain Name of the filter chain
179 protected function initFilterChain ($filterChain) {
180 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ' init: START');
181 $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
182 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ' init: FINISHED');
186 * Adds a filter to a given filter chain
188 * @param $filterChain Chain of the filter
189 * @param $filterInstance An instance of a filter
191 * @throws InvalidFilterChainException If the filter chain is invalid
193 protected function addFilter ($filterChain, Filterable $filterInstance) {
194 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ',' . $filterInstance->__toString(). ' add: START');
196 // Test if the filter is there
197 if (!isset($this->filterChains[$filterChain])) {
198 // Throw an exception here
199 throw new InvalidFilterChainException(array($this, $filterChain), self::EXCEPTION_FILTER_CHAIN_INVALID);
203 $this->filterChains[$filterChain]->addFilter($filterInstance);
204 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ',' . $filterInstance->__toString(). ' add: FINISH');
208 * Adds a filter to the pre filter chain
210 * @param $filterInstance An instance of a filter
213 public function addPreFilter (Filterable $filterInstance) {
214 // Add the pre filter
215 $this->addFilter(self::FILTER_CHAIN_PRE_COMMAND, $filterInstance);
219 * Adds a filter to the post filter chain
221 * @param $filterInstance An instance of a filter
224 public function addPostFilter (Filterable $filterInstance) {
225 // Add the post filter
226 $this->addFilter(self::FILTER_CHAIN_POST_COMMAND, $filterInstance);
230 * Add a shutdown filter
232 * @param $filterInstance A Filterable class
235 public function addShutdownFilter (Filterable $filterInstance) {
236 $this->addFilter('shutdown', $filterInstance);
240 * Executes given filter chain chain
242 * @param $filterChain Chain of the filter to execute
243 * @param $requestInstance An instance of a request class
244 * @param $responseInstance An instance of a response class
246 * @throws InvalidFilterChainException If the filter chain is invalid
248 protected function executeFilters ($filterChain, Requestable $requestInstance, Responseable $responseInstance) {
249 // Test if the filter is there
250 if (!isset($this->filterChains[$filterChain])) {
251 // Throw an exception here
252 throw new InvalidFilterChainException(array($this, $filterChain), self::EXCEPTION_FILTER_CHAIN_INVALID);
256 $this->filterChains[$filterChain]->processFilters($requestInstance, $responseInstance);
260 * Executes all pre filters
262 * @param $requestInstance An instance of a request class
263 * @param $responseInstance An instance of a response class
266 protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
267 // Execute all pre filters
268 $this->executeFilters(self::FILTER_CHAIN_PRE_COMMAND, $requestInstance, $responseInstance);
272 * Executes all post filters
274 * @param $requestInstance An instance of a request class
275 * @param $responseInstance An instance of a response class
278 protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
279 // Execute all post filters
280 $this->executeFilters(self::FILTER_CHAIN_POST_COMMAND, $requestInstance, $responseInstance);
284 * Executes all shutdown filters
286 * @param $requestInstance A Requestable class
287 * @param $responseInstance A Responseable class
290 public function executeShutdownFilters (Requestable $requestInstance, Responseable $responseInstance) {
291 $this->executeFilters('shutdown', $requestInstance, $responseInstance);