inc/classes/main/auth/class_CookieAuth.php

   1 <?php
   2 /**
   3  * A cookie-bases authorization class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  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 CookieAuth extends BaseFrameworkSystem implements Authorizeable, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Clean up a little
  35                 $this->removeNumberFormaters();
  36                 $this->removeSystemArray();
  37         }
  38
  39         /**
  40          * Creates an instance of this class by the given response instance
  41          *
  42          * @param       $responseInstance       An instance of a Responseable class
  43          * @return      $loginInstance          An instance of this login class
  44          */
  45         public final static function createCookieAuth (Responseable $responseInstance) {
  46                 // Get a new instance
  47                 $loginInstance = new CookieAuth();
  48
  49                 // Set the response instance
  50                 $loginInstance->setResponseInstance($responseInstance);
  51
  52                 // Return the prepared instance
  53                 return $loginInstance;
  54         }
  55
  56         /**
  57          * "Setter" for username auth data
  58          *
  59          * @param       $userName       The username from request we shall set
  60          * @return      void
  61          */
  62         public function setUserAuth ($userName) {
  63                 $this->getResponseInstance()->addCookie('username', $userName);
  64         }
  65
  66         /**
  67          * "Setter" for password hash auth data
  68          *
  69          * @param       $passHash       The hashed password from request we shall set
  70          * @return      void
  71          */
  72         public function setPasswordAuth ($passHash) {
  73                 $this->getResponseInstance()->addCookie('u_hash', $passHash, true);
  74         }
  75
  76         /**
  77          * Getter for user auth cookie
  78          *
  79          * @return      $userName       Username to get from cookie
  80          */
  81         public function getUserAuth () {
  82                 // Get the username from cookie
  83                 $userName = $this->getRequestInstance()->readCookie('username');
  84
  85                 // Return the username
  86                 return $userName;
  87         }
  88
  89         /**
  90          * Getter for password hash auth cookie
  91          *
  92          * @return      $passHash       Password hash to get from cookie
  93          */
  94         public function getPasswordAuth () {
  95                 // Get the username from cookie
  96                 $passHash = $this->getRequestInstance()->readCookie('u_hash');
  97
  98                 // Return the username
  99                 return $passHash;
 100         }
 101
 102         /**
 103          * Destroy the authorization data
 104          *
 105          * @return      void
 106          */
 107         public function destroyAuthData () {
 108                 // Expire both cookies
 109                 $this->getResponseInstance()->expireCookie('username');
 110                 $this->getResponseInstance()->expireCookie('u_hash');
 111         }
 112
 113         /**
 114          * Updates the authorization data and/or sets additional tracking data
 115          *
 116          * @param       $requestInstance        An instance of a Requestable class
 117          * @return      void
 118          */
 119         public function updateAuthData () {
 120                 $this->getResponseInstance()->refreshCookie('username');
 121                 $this->getResponseInstance()->refreshCookie('u_hash');
 122         }
 123 }
 124
 125 // [EOF]
 126 ?>