application/shipsimu/main/registration/class_ShipSimuRegistration.php

   1 <?php
   2 /**
   3  * A user registration class specially for Ship-Simu
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.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.shipsimu.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                 'birth_day',
  48                 'birth_month',
  49                 'birth_year'
  50         );
  51
  52         /**
  53          * Protected constructor
  54          *
  55          * @return      void
  56          */
  57         protected function __construct () {
  58                 // Call parent constructor
  59                 parent::__construct(__CLASS__);
  60         }
  61
  62         /**
  63          * Create a new instance
  64          *
  65          * @return      $registrationInstance   An instance of this registration class
  66          */
  67         public static final function createShipSimuRegistration () {
  68                 // Get a new instance
  69                 $registrationInstance = new ShipSimuRegistration();
  70
  71                 // Initialize the filter chains
  72                 $registrationInstance->initFilterChains();
  73
  74                 // And return it
  75                 return $registrationInstance;
  76         }
  77
  78         /**
  79          * Encrypt given request key or throw an exception if key was not found in
  80          * request
  81          *
  82          * @param       $requestKey             Key in request class
  83          * @return      void
  84          */
  85         public function encryptPassword ($requestKey) {
  86                 // Check if password is found in request
  87                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
  88                         // So encrypt the password and store it for later usage in
  89                         // the request:
  90
  91                         // 1.: Get the plain password
  92                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
  93
  94                         // 2. Get a crypto helper and hash the password
  95                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword);
  96
  97                         // 3. Store the hash back in request
  98                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
  99                 }
 100         }
 101
 102         /**
 103          * Perform things like informing assigned affilates about new registration
 104          * before registration
 105          *
 106          * @return      void
 107          * @todo        Maybe add more things to perform
 108          */
 109         public function doPreRegistration () {
 110                 // First run all pre filters
 111                 $this->executePreFilters();
 112         }
 113
 114         /**
 115          * Registers the new user account by insterting the request data into the
 116          * database and paying some start credits or throw exceptions if this fails
 117          *
 118          * @return      void
 119          * @todo        Maybe add more things to perform
 120          */
 121         public function registerNewUser () {
 122                 // Get a user database wrapper
 123                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
 124
 125                 // Use this instance to insert the whole registration instance
 126                 $wrapperInstance->insertRegistrationObject($this);
 127         }
 128
 129         /**
 130          * Perform things like notifying partner websites after registration is done
 131          *
 132          * @return      void
 133          * @todo        Maybe add more things to perform
 134          */
 135         public function doPostRegistration () {
 136                 // First run all post filters
 137                 $this->executePostFilters();
 138         }
 139
 140         /**
 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.
 144          *
 145          * @return      void
 146          */
 147         public function doPostAction () {
 148                 // Get an action instance from our factory
 149                 $actionInstance = ObjectFactory::createObjectByConfiguredName('post_registration_class');
 150
 151                 // Execute the action
 152                 $actionInstance->execute($this->getRequestInstance(), $this->getResponseInstance());
 153         }
 154
 155         /**
 156          * Adds registration elements to a given dataset instance
 157          *
 158          * @param       $criteriaInstance       An instance of a storeable criteria
 159          * @return      void
 160          */
 161         public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
 162                 // Default is unconfirmed!
 163                 $configEntry = 'user_status_unconfirmed';
 164
 165                 // Is the confirmation process entirely disabled?
 166                 if ($this->getConfigInstance()->getConfigEntry('confirm_email_enabled') === 'N') {
 167                         // No confirmation of email needed
 168                         $configEntry = 'user_status_confirmed';
 169                 } // END - if
 170
 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)) {
 175                                 // Yes, so use it
 176                                 $criteriaInstance->addCriteria($alias, $this->getRequestInstance()->getRequestElement($element));
 177
 178                                 // Debug message
 179                                 //* DEBUG: */ $this->debugOutput('ALIAS: alias='.$alias.',element='.$element.'='.$this->getRequestInstance()->getRequestElement($element));
 180                         } else {
 181                                 // No, default entry
 182                                 $criteriaInstance->addCriteria($element, $this->getRequestInstance()->getRequestElement($element));
 183
 184                                 // Debug message
 185                                 //* DEBUG: */ $this->debugOutput('DEFAULT: element='.$element.'='.$this->getRequestInstance()->getRequestElement($element));
 186                         }
 187
 188                         // Is this a guest account?
 189                         if ((($element == 'username') || ($alias == 'username')) && ($this->getRequestInstance()->getRequestElement($element) == $this->getConfigInstance()->getConfigEntry('guest_login_user'))) {
 190                                 // Yes, then set the config entry to guest status
 191                                 $configEntry = 'user_status_guest';
 192                         } // END - if
 193                 } // END - foreach
 194
 195                 // Mark the username as unique key
 196                 $criteriaInstance->setUniqueKey(UserDatabaseWrapper::DB_COLUMN_USERNAME);
 197
 198                 // Add account status as configured
 199                 $criteriaInstance->addConfiguredCriteria(UserDatabaseWrapper::DB_COLUMN_USER_STATUS, $configEntry);
 200
 201                 // Include registration timestamp
 202                 $criteriaInstance->addCriteria('registered', date('Y-m-d H:i:s', time()));
 203         }
 204 }
 205
 206 //
 207 ?>