3 * A filter for checking if supplied confirmation code is valid.
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class ConfirmCodeVerifierFilter extends BaseFilter implements Filterable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this filter class
38 * @param $controllerInstance An instance of a Controller class
39 * @return $filterInstance An instance of this filter class
41 public final static function createConfirmCodeVerifierFilter (Controller $controllerInstance) {
43 $filterInstance = new ConfirmCodeVerifierFilter();
46 $filterInstance->setControllerInstance($controllerInstance);
48 // Return the instance
49 return $filterInstance;
53 * Executes the filter with given request and response objects
55 * @param $requestInstance An instance of a class with an Requestable interface
56 * @param $responseInstance An instance of a class with an Responseable interface
58 * @throws NullPointerException If the user instance from registry is null
60 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
61 // Get confirmation code from request
62 $confirmCode = $requestInstance->getRequestElement('confirm');
65 if (is_null($confirmCode)) {
67 $requestInstance->requestIsValid(false);
69 // Add a message to the response
70 $responseInstance->addFatalMessage('confirm_code_unset');
74 } elseif (empty($confirmCode)) {
76 $requestInstance->requestIsValid(false);
78 // Add a message to the response
79 $responseInstance->addFatalMessage('confirm_code_empty');
85 // Get a user instance from registry
86 $userInstance = Registry::getRegistry()->getInstance('user');
88 // Is the instance there?
89 if (is_null($userInstance)) {
90 // Throw an exception here
91 throw new NullPointerException ($this, self::EXCEPTION_IS_NULL_POINTER);
94 // Get the confirm code from user for comparison
95 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
97 // Do we have the same code or different?
98 if ($userCode != $confirmCode) {
100 $requestInstance->requestIsValid(false);
102 // Redirect to error page
103 $responseInstance->redirectToConfiguredUrl('confirm_code_invalid_url');
105 // Stop processing here