Continued:
[core.git] / framework / main / classes / filter / validator / class_PasswordValidatorFilter.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Filter\Validator\Password;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
7 use Org\Mxchange\CoreFramework\Filter\Filterable;
8 use Org\Mxchange\CoreFramework\Request\Requestable;
9 use Org\Mxchange\CoreFramework\Response\Responseable;
10
11 /**
12  * A concrete filter for validating the password. This filter may intercept
13  * the filter chain if no password is given or if both passwords didn't match.
14  *
15  * @author              Roland Haeder <webmaster@shipsimu.org>
16  * @version             0.0.0
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18  * @license             GNU GPL 3.0 or any newer version
19  * @link                http://www.shipsimu.org
20  *
21  * This program is free software: you can redistribute it and/or modify
22  * it under the terms of the GNU General Public License as published by
23  * the Free Software Foundation, either version 3 of the License, or
24  * (at your option) any later version.
25  *
26  * This program is distributed in the hope that it will be useful,
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29  * GNU General Public License for more details.
30  *
31  * You should have received a copy of the GNU General Public License
32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
33  */
34 class PasswordValidatorFilter extends BaseFilter implements Filterable {
35         /**
36          * Protected constructor
37          *
38          * @return      void
39          */
40         protected function __construct () {
41                 // Call parent constructor
42                 parent::__construct(__CLASS__);
43         }
44
45         /**
46          * Creates an instance of this filter class
47          *
48          * @return      $filterInstance         An instance of this filter class
49          */
50         public static final function createPasswordValidatorFilter () {
51                 // Get a new instance
52                 $filterInstance = new PasswordValidatorFilter();
53
54                 // Return the instance
55                 return $filterInstance;
56         }
57
58         /**
59          * Executes the filter with given request and response objects
60          *
61          * @param       $requestInstance        An instance of a class with an Requestable interface
62          * @param       $responseInstance       An instance of a class with an Responseable interface
63          * @return      void
64          * @throws      FilterChainException    If this filter fails to operate
65          */
66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
67                 // Get passwords
68                 $password1 = $requestInstance->getRequestElement('pass1');
69                 $password2 = $requestInstance->getRequestElement('pass2');
70
71                 // Is the password still not set?
72                 if ((is_null($password1)) || (is_null($password2))) {
73                         // Not found in form so stop the filtering process
74                         $requestInstance->requestIsValid(false);
75
76                         // Add a message to the response
77                         $responseInstance->addFatalMessage('password_unset');
78
79                         // Abort here
80                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
81                 } elseif ((empty($password1)) || (empty($password2))) {
82                         // Password is empty
83                         $requestInstance->requestIsValid(false);
84
85                         // Is the password empty?
86                         if (empty($password1)) {
87                                 // Add a message to the response
88                                 $responseInstance->addFatalMessage('pass1_empty');
89                         } // END - if
90
91                         // Is the confirmation empty?
92                         if (empty($password2)) {
93                                 // Add a message to the response
94                                 $responseInstance->addFatalMessage('pass2_empty');
95                         } // END - if
96
97                         // Abort here
98                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
99                 } elseif ($password1 != $password2) {
100                         // Passwords didn't match
101                         $requestInstance->requestIsValid(false);
102
103                         // Add a message to the response
104                         $responseInstance->addFatalMessage('pass_mismatch');
105
106                         // Abort here
107                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
108                 } // END - elseif
109         }
110
111 }