Mercurial > owls

annotate Includes/Loginsys.class.php @ 7:a3a651f0cac6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added doxygen-comments to Loginsys.class.php
author Meillo r e t u r n s <meillo@marmaro.de>
date Wed, 13 Dec 2006 22:16:59 +0100
parents 3021ce32ee14
children eb5bff360deb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
1 <?php
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
2 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
3 * simple loginsystem for owls
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
4 *
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
5 * @brief simple loginsystem for owls
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
6 * @author Meillo r e t u r n s <meillo@marmaro.de>
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
7 */
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
8 class Loginsys {
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
9
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
10 /// Consts
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
11
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
12 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
13 * time in seconds till the session expires
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
14 */
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
15 define('TIME_SESSION_EXPIRES', 1800);
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
16
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
17
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
18
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
19 /// Constructors
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
20
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
21 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
22 * starts the session
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
23 * and puts an activity timestamp in it
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
24 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
25 public function __construct() {
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
26 session_start();
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
27 $this->heartbeat();
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
28 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
29
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
30
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
31
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
32
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
33 /// Methods
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
34
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
35
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
36 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
37 * trys to log in with the given login data
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
38 *
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
39 * @param $loginname username
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
40 * @param $password_md5 md5 password hash
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
41 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
42 public function login($loginname, $password_md5) { // login ------------------------------------
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
43 $rowuser = mysql_fetch_array(mysql_query("select * from ". DB_PREFIX ."User where loginname='$loginname' and password='$password_md5' "));
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
44 if (mysql_affected_rows() == 1) { // valid login
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
45 $_SESSION[login][id] = $rowuser[id];
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
46 $_SESSION[login][loginname] = $loginname;
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
47 $_SESSION[login][logintime] = time();
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
48 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
49 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
50
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
51
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
52 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
53 * logs the user out
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
54 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
55 public function logout() { // logout ------------------------------------------------------------
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
56 unset($_SESSION[login]);
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
57 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
58
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
59
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
60 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
61 * proves if the user is logged in and if he wan't to long inactive
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
62 *
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
63 * @return bool 'true' if user is logged in, else 'false'
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
64 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
65 public function loggedIn() { // return login-status ---------------------------------------------
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
66 return (isset($_SESSION[login][id]) && $_SESSION[login][logintime] > time()-TIME_SESSION_EXPIRES);
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
67 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
68
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
69
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
70 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
71 * writes the current timestamp into the session
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
72 * this is relevant for the time of inactivity
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
73 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
74 public function heartbeat() {
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
75 if ($this->loggedIn()) {
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
76 $_SESSION[login][logintime] = time();
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
77 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
78 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
79
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
80
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
81
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
82 /// Getter and Setter
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
83
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
84
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
85 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
86 * @return user id
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
87 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
88 public function getUserId() {
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
89 return $_SESSION[login][id];
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
90 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
91
7
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
92 /**
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
93 * @return user name
a3a651f0cac6 added doxygen-comments to Loginsys.class.php
Meillo r e t u r n s <meillo@marmaro.de>
parents: 0
diff changeset
94 */
0
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
95 public function getLoginname() {
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
96 return $_SESSION[login][loginname];
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
97 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
98
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
99 }
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
100
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
101
3021ce32ee14 begin of using hg for owls
"Meillo r e t u r n s <meillo@marmaro.de>"
parents:
diff changeset
102 ?>