1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2015 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees;
/**
* Authentication.
*/
class Auth {
// Privacy constants
const PRIV_PRIVATE = 2; // Allows visitors to view the item
const PRIV_USER = 1; // Allows members to access the item
const PRIV_NONE = 0; // Allows managers to access the item
const PRIV_HIDE = -1; // Hide the item to all users
/**
* Are we currently logged in?
*
* @return bool
*/
public static function check() {
return self::id() !== null;
}
/**
* Is the specified/current user an administrator?
*
* @param User|null $user
*
* @return bool
*/
public static function isAdmin(User $user = null) {
if ($user === null) {
$user = self::user();
}
return $user && $user->getPreference('canadmin') === '1';
}
/**
* Is the specified/current user a manager of a tree?
*
* @param Tree $tree
* @param User|null $user
*
* @return bool
*/
public static function isManager(Tree $tree, User $user = null) {
if ($user === null) {
$user = self::user();
}
return self::isAdmin($user) || $user && $tree->getUserPreference($user, 'canedit') === 'admin';
}
/**
* Is the specified/current user a moderator of a tree?
*
* @param Tree $tree
* @param User|null $user
*
* @return bool
*/
public static function isModerator(Tree $tree, User $user = null) {
if ($user === null) {
$user = self::user();
}
return self::isManager($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'accept';
}
/**
* Is the specified/current user an editor of a tree?
*
* @param Tree $tree
* @param User|null $user
*
* @return bool
*/
public static function isEditor(Tree $tree, User $user = null) {
if ($user === null) {
$user = self::user();
}
return self::isModerator($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'edit';
}
/**
* Is the specified/current user a member of a tree?
*
* @param Tree $tree
* @param User|null $user
*
* @return bool
*/
public static function isMember(Tree $tree, User $user = null) {
if ($user === null) {
$user = self::user();
}
return self::isEditor($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'access';
}
/**
* What is the specified/current user's access level within a tree?
*
* @param Tree $tree
* @param User|null $user
*
* @return int
*/
public static function accessLevel(Tree $tree, User $user = null) {
if ($user === null) {
$user = self::user();
}
if (self::isManager($tree, $user)) {
return self::PRIV_NONE;
} elseif (self::isMember($tree, $user)) {
return self::PRIV_USER;
} else {
return self::PRIV_PRIVATE;
}
}
/**
* Is the current visitor a search engine? The global is set in session.php
*
* @return bool
*/
public static function isSearchEngine() {
global $SEARCH_SPIDER;
return $SEARCH_SPIDER;
}
/**
* The ID of the authenticated user, from the current session.
*
* @return string|null
*/
public static function id() {
return Session::get('wt_user');
}
/**
* The authenticated user, from the current session.
*
* @return User
*/
public static function user() {
$user = User::find(self::id());
if ($user === null) {
$visitor = new \stdClass;
$visitor->user_id = '';
$visitor->user_name = '';
$visitor->real_name = '';
$visitor->email = '';
return new User($visitor);
} else {
return $user;
}
}
/**
* Login directly as an explicit user - for masquerading.
*
* @param User $user
*/
public static function login(User $user) {
Session::put('wt_user', $user->getUserId());
Session::regenerate(false);
}
/**
* End the session for the current user.
*/
public static function logout() {
Session::regenerate(true);
}
}
|
