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