3 namespace Org\Mxchange\CoreFramework\Filter\Verifier\Confirmation;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Database\Frontend\User\UserDatabaseFrontend;
7 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
8 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
9 use Org\Mxchange\CoreFramework\Filter\Filterable;
10 use Org\Mxchange\CoreFramework\Registry\Object\ObjectRegistry;
11 use Org\Mxchange\CoreFramework\Request\Requestable;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
15 * A filter for checking if supplied confirmation code is valid.
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class ConfirmCodeVerifierFilter extends BaseFilter implements Filterable {
38 * Protected constructor
42 private function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this filter class
50 * @return $filterInstance An instance of this filter class
52 public static final function createConfirmCodeVerifierFilter () {
54 $filterInstance = new ConfirmCodeVerifierFilter();
56 // Return the instance
57 return $filterInstance;
61 * Executes the filter with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
66 * @throws FilterChainException If this filter fails to operate
68 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
69 // Get confirmation code from request
70 $confirmCode = $requestInstance->getRequestElement('confirm');
73 if (is_null($confirmCode)) {
75 $requestInstance->setIsRequestValid(FALSE);
77 // Add a message to the response
78 $responseInstance->addFatalMessage('confirm_code_unset');
81 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
82 } elseif (empty($confirmCode)) {
84 $requestInstance->setIsRequestValid(FALSE);
86 // Add a message to the response
87 $responseInstance->addFatalMessage('confirm_code_empty');
90 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
93 // Get a user instance from registry
94 $userInstance = ObjectRegistry::getRegistry('generic')->getInstance('user');
96 // Get the confirm code from user for comparison
97 $userCode = $userInstance->getField(UserDatabaseFrontend::DB_COLUMN_CONFIRM_HASH);
99 // Do we have the same code or different?
100 if ($userCode != $confirmCode) {
102 $requestInstance->setIsRequestValid(FALSE);
104 // Redirect to error page
105 $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
107 // Stop processing here