3 * A filter for checking if the the 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__);
34 // Set part description
35 $this->setObjectDescription("A filter for confirmation code verification");
37 // Create unique ID number
38 $this->generateUniqueId();
42 * Creates an instance of this filter class
44 * @return $filterInstance An instance of this filter class
46 public final static function createConfirmCodeVerifierFilter () {
48 $filterInstance = new ConfirmCodeVerifierFilter();
50 // Return the instance
51 return $filterInstance;
55 * Executes the filter with given request and response objects
57 * @param $requestInstance An instance of a class with an Requestable interface
58 * @param $responseInstance An instance of a class with an Responseable interface
60 * @throws NullPointerException If the user instance from registry is null
62 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
63 // Get confirmation code from request
64 $confirmCode = $requestInstance->getRequestElement('confirm');
67 if (is_null($confirmCode)) {
69 $requestInstance->requestIsValid(false);
71 // Add a message to the response
72 $responseInstance->addFatalMessage('confirm_code_unset');
76 } elseif (empty($confirmCode)) {
78 $requestInstance->requestIsValid(false);
80 // Add a message to the response
81 $responseInstance->addFatalMessage('confirm_code_empty');
87 // Get a user instance from registry
88 $userInstance = Registry::getRegistry()->getInstance('user');
90 // Is the instance there?
91 if (is_null($userInstance)) {
92 // Throw an exception here
93 throw new NullPointerException ($this, self::EXCEPTION_IS_NULL_POINTER);
96 // Get the confirm code from user for comparison
97 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
99 // Do we have the same code or different?
100 if ($userCode != $confirmCode) {
102 $requestInstance->requestIsValid(false);
104 // Redirect to error page
105 $responseInstance->redirectToConfiguredUrl('confirm_code_invalid_url');
107 // Stop processing here