3 * A user registration specially for Ship-Simu
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class ShipSimuRegistration extends BaseRegistration {
28 private $hashedPassword = "";
31 * Elements for criteria
33 private $criteriaElements = array(
50 * Protected constructor
54 protected function __construct () {
55 // Call parent constructor
56 parent::__construct(__CLASS__);
58 // Set part description
59 $this->setObjectDescription("Ship-Simu registration class");
61 // Create unique ID number
62 $this->generateUniqueId();
66 * Create a new instance
68 * @return $registrationInstance An instance of this registration class
70 public final static function createShipSimuRegistration () {
72 $registrationInstance = new ShipSimuRegistration();
74 // Initialize the filter chains
75 $registrationInstance->initFilterChains();
78 return $registrationInstance;
82 * Encrypt the given request key or throw an exception if the key was not
83 * found in the request
85 * @param $requestKey Key in request class
88 public function encryptPassword ($requestKey) {
89 // Check if the password is found in the request
90 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
91 // So encrypt the password and store it for later usage in
94 // 1.: Get the plain password
95 $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
97 // 2. Get a crypto helper and hash the password
98 $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword);
100 // 3. Store the hash back in the request
101 $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
106 * Perform things like informing assigned affilates about new registration
107 * before registration
111 public function doPreRegistration () {
112 // First run all pre filters
113 $this->executePreFilters();
117 * Registers the new user account by insterting the request data into the
118 * database and paying some start credits or throw exceptions if this fails
122 public function registerNewUser () {
123 // Get a user database wrapper
124 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
126 // Use this instance to insert the whole registration instance
127 $wrapperInstance->insertRegistrationObject($this);
131 * Perform things like notifying partner websites after registration is done
135 public function doPostRegistration () {
136 // First run all post filters
137 $this->executePostFilters();
141 * Do the action which is required after all registration steps are done.
142 * This can be a simple redirect to another webpage or displaying a message
143 * to the user. Or this can be a login step into the newly created account.
147 public function doPostAction () {
148 // Get an action instance from our factory
149 $actionInstance = ObjectFactory::createObjectByConfiguredName('post_registration_class');
151 // Execute the action
152 $actionInstance->execute($this->getRequestInstance(), $this->getResponseInstance());
156 * Adds registration elements to a given dataset instance
158 * @param $criteriaInstance An instance of a storeable criteria
161 public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
162 // Default is unconfirmed!
163 $configEntry = 'user_status_unconfirmed';
165 // Is the confirmation process entirely disabled?
166 if ($this->getConfigInstance()->readConfig('confirm_email_enabled') === "N") {
167 // No confirmation of email needed
168 $configEntry = 'user_status_confirmed';
171 // Add a lot elements to the dataset criteria
172 foreach ($this->criteriaElements as $alias=>$element) {
173 // Do we have an alias?
174 if (is_string($alias)) {
176 $criteriaInstance->addCriteria($alias, $this->getRequestInstance()->getRequestElement($element));
179 $criteriaInstance->addCriteria($element, $this->getRequestInstance()->getRequestElement($element));
182 // Is this a guest account?
183 if ((($element == "username") || ($alias == "username")) && ($this->getRequestInstance()->getRequestElement($element) == $this->getConfigInstance()->readConfig('guest_login_user'))) {
184 // Yes, then set the config entry to guest status
185 $configEntry = 'user_status_guest';
189 // Mark the username as unique key
190 $criteriaInstance->setUniqueKey('username');
192 // Add account status as configured
193 $criteriaInstance->addConfiguredCriteria(UserDatabaseWrapper::DB_COLUMN_USER_STATUS, $configEntry);
195 // Include registration timestamp
196 $criteriaInstance->addCriteria('registered', date("Y-m-d H:i:s", time()));