Registry rewritten, exception added #2
[core.git] / 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, 2009, 2010 Core 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 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
35         /**
36          * Creates an instance of this class by the given response instance
37          *
38          * @param       $responseInstance       An instance of a Responseable class
39          * @return      $loginInstance          An instance of this login class
40          */
41         public final static function createCookieAuth (Responseable $responseInstance) {
42                 // Get a new instance
43                 $loginInstance = new CookieAuth();
44
45                 // Set the response instance
46                 $loginInstance->setResponseInstance($responseInstance);
47
48                 // Return the prepared instance
49                 return $loginInstance;
50         }
51
52         /**
53          * "Setter" for username auth data
54          *
55          * @param       $userName       The username from request we shall set
56          * @return      void
57          */
58         public function setUserAuth ($userName) {
59                 $this->getResponseInstance()->addCookie('username', $userName);
60         }
61
62         /**
63          * "Setter" for password hash auth data
64          *
65          * @param       $passHash       The hashed password from request we shall set
66          * @return      void
67          */
68         public function setPasswordAuth ($passHash) {
69                 $this->getResponseInstance()->addCookie('u_hash', $passHash);
70         }
71
72         /**
73          * Getter for user auth cookie
74          *
75          * @return      $userName       Username to get from cookie
76          */
77         public function getUserAuth () {
78                 // Get the username from cookie
79                 $userName = $this->getRequestInstance()->readCookie('username');
80
81                 // Return the username
82                 return $userName;
83         }
84
85         /**
86          * Getter for password hash auth cookie
87          *
88          * @return      $passHash       Password hash to get from cookie
89          */
90         public function getPasswordAuth () {
91                 // Get the username from cookie
92                 $passHash = $this->getRequestInstance()->readCookie('u_hash');
93
94                 // Return the username
95                 return $passHash;
96         }
97
98         /**
99          * Destroy the authorization data
100          *
101          * @return      void
102          */
103         public function destroyAuthData () {
104                 // Expire both cookies
105                 $this->getResponseInstance()->expireCookie('username');
106                 $this->getResponseInstance()->expireCookie('u_hash');
107         }
108
109         /**
110          * Updates the authorization data and/or sets additional tracking data
111          *
112          * @param       $requestInstance        An instance of a Requestable class
113          * @return      void
114          */
115         public function updateAuthData () {
116                 $this->getResponseInstance()->refreshCookie('username');
117                 $this->getResponseInstance()->refreshCookie('u_hash');
118         }
119 }
120
121 // [EOF]
122 ?>