3 namespace CoreFramework\Filter\Verifier\Confirmation;
5 // Import framework stuff
6 use CoreFramework\Database\Frontend\User\UserDatabaseWrapper;
7 use CoreFramework\Filter\BaseFilter;
8 use CoreFramework\Filter\Filterable;
9 use CoreFramework\Registry\Registry;
10 use CoreFramework\Request\Requestable;
11 use CoreFramework\Response\Responseable;
14 * A filter for checking if supplied confirmation code is valid.
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.shipsimu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 class ConfirmCodeVerifierFilter extends BaseFilter implements Filterable {
37 * Protected constructor
41 protected function __construct () {
42 // Call parent constructor
43 parent::__construct(__CLASS__);
47 * Creates an instance of this filter class
49 * @return $filterInstance An instance of this filter class
51 public static final function createConfirmCodeVerifierFilter () {
53 $filterInstance = new ConfirmCodeVerifierFilter();
55 // Return the instance
56 return $filterInstance;
60 * Executes the filter with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
65 * @throws FilterChainException If this filter fails to operate
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Get confirmation code from request
69 $confirmCode = $requestInstance->getRequestElement('confirm');
72 if (is_null($confirmCode)) {
74 $requestInstance->requestIsValid(false);
76 // Add a message to the response
77 $responseInstance->addFatalMessage('confirm_code_unset');
80 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
81 } elseif (empty($confirmCode)) {
83 $requestInstance->requestIsValid(false);
85 // Add a message to the response
86 $responseInstance->addFatalMessage('confirm_code_empty');
89 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
92 // Get a user instance from registry
93 $userInstance = Registry::getRegistry()->getInstance('user');
95 // Get the confirm code from user for comparison
96 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
98 // Do we have the same code or different?
99 if ($userCode != $confirmCode) {
101 $requestInstance->requestIsValid(false);
103 // Redirect to error page
104 $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
106 // Stop processing here