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