3 * A concrete filter for validating the email address. This filter may intercept
4 * the filter chain if no email address is given or if supplied email has an
5 * invalid form. It could also intercept our filter chain if email address is
6 * already used by some one if configuration requires this.
8 * @author Roland Haeder <webmaster@shipsimu.org>
10 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.shipsimu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 class EmailValidatorFilter extends BaseFilter implements Filterable {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
39 * Creates an instance of this filter class
41 * @return $filterInstance An instance of this filter class
43 public static final function createEmailValidatorFilter () {
45 $filterInstance = new EmailValidatorFilter();
47 // Return the instance
48 return $filterInstance;
52 * Executes the filter with given request and response objects
54 * @param $requestInstance An instance of a class with an Requestable interface
55 * @param $responseInstance An instance of a class with an Responseable interface
57 * @throws FilterChainException If this filter fails to operate
59 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60 // Get Email from request
61 $email = $requestInstance->getRequestElement('email');
64 if ((is_null($email)) || ($this->getConfigInstance()->getConfigEntry('register_email_unique') == 'Y')) {
66 $email1 = $requestInstance->getRequestElement('email1');
67 $email2 = $requestInstance->getRequestElement('email2');
69 // Is the email still not set?
70 if ((is_null($email1)) || (is_null($email2))) {
71 // Not found in form so stop the filtering process
72 $requestInstance->requestIsValid(FALSE);
74 // Add a message to the response
75 $responseInstance->addFatalMessage('email_unset');
78 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
79 } elseif ((empty($email1)) || (empty($email2))) {
81 $requestInstance->requestIsValid(FALSE);
83 // Is the email empty?
85 // Add a message to the response
86 $responseInstance->addFatalMessage('email1_empty');
89 // Is the confirmation empty?
91 // Add a message to the response
92 $responseInstance->addFatalMessage('email2_empty');
96 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
97 } elseif ($this->ifEmailIsTaken($email1)) {
98 // Email is already taken
99 $requestInstance->requestIsValid(FALSE);
101 // Add a message to the response
102 $responseInstance->addFatalMessage('email_taken');
105 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
106 } elseif ($email1 != $email2) {
107 // Emails didn't match
108 $requestInstance->requestIsValid(FALSE);
110 // Add a message to the response
111 $responseInstance->addFatalMessage('emails_mismatch');
114 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
116 } elseif (empty($email)) {
118 $requestInstance->requestIsValid(FALSE);
120 // Add a message to the response
121 $responseInstance->addFatalMessage('email_empty');
124 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
129 * Check whether the email as already been taken
131 * @param $email Email to check for existence
132 * @return $alreadyTaken Whether the email has been taken
134 private function ifEmailIsTaken ($email) {
135 // Default is already taken
136 $alreadyTaken = TRUE;
138 // Initialize instance
139 $userInstance = NULL;
141 // Get a registry instance
142 $registry = Registry::getRegistry();
144 // Is the user already there?
145 if ($registry->instanceExists('user')) {
146 // Use the instance for checking for the email
147 $userInstance = $registry->getInstance('user');
148 $userInstance->setEmailAddress($email);
150 // If this instance is created then the username *does* exist
151 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('user_class'), 'createMemberByEmail'), array($email));
153 // Remember this user instance in our registry for later usage
154 $registry->addInstance('user', $userInstance);
157 // Does the email exist?
158 if ($userInstance->ifEmailAddressExists() === FALSE) {
159 // This email has not being used yet
160 $alreadyTaken = FALSE;
164 return $alreadyTaken;