3 * A filter for checking if supplied confirmation code is valid.
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007 - 2009 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 * @return $filterInstance An instance of this filter class
40 public final static function createConfirmCodeVerifierFilter () {
42 $filterInstance = new ConfirmCodeVerifierFilter();
44 // Return the instance
45 return $filterInstance;
49 * Executes the filter with given request and response objects
51 * @param $requestInstance An instance of a class with an Requestable interface
52 * @param $responseInstance An instance of a class with an Responseable interface
54 * @throws NullPointerException If the user instance from registry is null
55 * @throws FilterChainException If this filter fails to operate
57 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
58 // Get confirmation code from request
59 $confirmCode = $requestInstance->getRequestElement('confirm');
62 if (is_null($confirmCode)) {
64 $requestInstance->requestIsValid(false);
66 // Add a message to the response
67 $responseInstance->addFatalMessage('confirm_code_unset');
70 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
71 } elseif (empty($confirmCode)) {
73 $requestInstance->requestIsValid(false);
75 // Add a message to the response
76 $responseInstance->addFatalMessage('confirm_code_empty');
79 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
82 // Get a user instance from registry
83 $userInstance = Registry::getRegistry()->getInstance('user');
85 // Is the instance there?
86 if (is_null($userInstance)) {
87 // Throw an exception here
88 throw new NullPointerException ($this, self::EXCEPTION_IS_NULL_POINTER);
91 // Get the confirm code from user for comparison
92 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
94 // Do we have the same code or different?
95 if ($userCode != $confirmCode) {
97 $requestInstance->requestIsValid(false);
99 // Redirect to error page
100 $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
102 // Stop processing here