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