application/ship-simu/main/registration/class_ShipSimuRegistration.php

   1 <?php
   2 /**
   3  * A user registration class specially for Ship-Simu
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class ShipSimuRegistration extends BaseRegistration implements UserRegister {
  25         /**
  26          * Hashed password
  27          */
  28         private $hashedPassword = "";
  29
  30         /**
  31          * Elements for criteria
  32          */
  33         private $criteriaElements = array(
  34                 'username',
  35                 'pass_hash',
  36                 'email' => 'email1',
  37                 'surname',
  38                 'family',
  39                 'street',
  40                 'zip',
  41                 'city',
  42                 'icq',
  43                 'jabber',
  44                 'yahoo',
  45                 'aol',
  46                 'msn'
  47         );
  48
  49         /**
  50          * Protected constructor
  51          *
  52          * @return      void
  53          */
  54         protected function __construct () {
  55                 // Call parent constructor
  56                 parent::__construct(__CLASS__);
  57         }
  58
  59         /**
  60          * Create a new instance
  61          *
  62          * @return      $registrationInstance   An instance of this registration class
  63          */
  64         public final static function createShipSimuRegistration () {
  65                 // Get a new instance
  66                 $registrationInstance = new ShipSimuRegistration();
  67
  68                 // Initialize the filter chains
  69                 $registrationInstance->initFilterChains();
  70
  71                 // And return it
  72                 return $registrationInstance;
  73         }
  74
  75         /**
  76          * Encrypt given request key or throw an exception if key was not found in
  77          * request
  78          *
  79          * @param       $requestKey             Key in request class
  80          * @return      void
  81          */
  82         public function encryptPassword ($requestKey) {
  83                 // Check if password is found in request
  84                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
  85                         // So encrypt the password and store it for later usage in
  86                         // the request:
  87
  88                         // 1.: Get the plain password
  89                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
  90
  91                         // 2. Get a crypto helper and hash the password
  92                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword);
  93
  94                         // 3. Store the hash back in request
  95                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
  96                 }
  97         }
  98
  99         /**
 100          * Perform things like informing assigned affilates about new registration
 101          * before registration
 102          *
 103          * @return      void
 104          * @todo        Maybe add more things to perform
 105          */
 106         public function doPreRegistration () {
 107                 // First run all pre filters
 108                 $this->executePreFilters();
 109         }
 110
 111         /**
 112          * Registers the new user account by insterting the request data into the
 113          * database and paying some start credits or throw exceptions if this fails
 114          *
 115          * @return      void
 116          * @todo        Maybe add more things to perform
 117          */
 118         public function registerNewUser () {
 119                 // Get a user database wrapper
 120                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
 121
 122                 // Use this instance to insert the whole registration instance
 123                 $wrapperInstance->insertRegistrationObject($this);
 124         }
 125
 126         /**
 127          * Perform things like notifying partner websites after registration is done
 128          *
 129          * @return      void
 130          * @todo        Maybe add more things to perform
 131          */
 132         public function doPostRegistration () {
 133                 // First run all post filters
 134                 $this->executePostFilters();
 135         }
 136
 137         /**
 138          * Do the action which is required after all registration steps are done.
 139          * This can be a simple redirect to another webpage or displaying a message
 140          * to the user. Or this can be a login step into the newly created account.
 141          *
 142          * @return      void
 143          */
 144         public function doPostAction () {
 145                 // Get an action instance from our factory
 146                 $actionInstance = ObjectFactory::createObjectByConfiguredName('post_registration_class');
 147
 148                 // Execute the action
 149                 $actionInstance->execute($this->getRequestInstance(), $this->getResponseInstance());
 150         }
 151
 152         /**
 153          * Adds registration elements to a given dataset instance
 154          *
 155          * @param       $criteriaInstance       An instance of a storeable criteria
 156          * @return      void
 157          */
 158         public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
 159                 // Default is unconfirmed!
 160                 $configEntry = 'user_status_unconfirmed';
 161
 162                 // Is the confirmation process entirely disabled?
 163                 if ($this->getConfigInstance()->getConfigEntry('confirm_email_enabled') === "N") {
 164                         // No confirmation of email needed
 165                         $configEntry = 'user_status_confirmed';
 166                 } // END - if
 167
 168                 // Add a lot elements to the dataset criteria
 169                 foreach ($this->criteriaElements as $alias => $element) {
 170                         // Do we have an alias?
 171                         if (is_string($alias)) {
 172                                 // Yes, so use it
 173                                 $criteriaInstance->addCriteria($alias, $this->getRequestInstance()->getRequestElement($element));
 174                         } else {
 175                                 // No, default entry
 176                                 $criteriaInstance->addCriteria($element, $this->getRequestInstance()->getRequestElement($element));
 177                         }
 178
 179                         // Is this a guest account?
 180                         if ((($element == "username") || ($alias == "username")) && ($this->getRequestInstance()->getRequestElement($element) == $this->getConfigInstance()->getConfigEntry('guest_login_user'))) {
 181                                 // Yes, then set the config entry to guest status
 182                                 $configEntry = 'user_status_guest';
 183                         } // END - if
 184                 } // END - foreach
 185
 186                 // Mark the username as unique key
 187                 $criteriaInstance->setUniqueKey(UserDatabaseWrapper::DB_COLUMN_USERNAME);
 188
 189                 // Add account status as configured
 190                 $criteriaInstance->addConfiguredCriteria(UserDatabaseWrapper::DB_COLUMN_USER_STATUS, $configEntry);
 191
 192                 // Include registration timestamp
 193                 $criteriaInstance->addCriteria("registered", date("Y-m-d H:i:s", time()));
 194         }
 195 }
 196
 197 //
 198 ?>