-
Notifications
You must be signed in to change notification settings - Fork 23
/
RoleDAO.inc.php
259 lines (223 loc) · 6.1 KB
/
RoleDAO.inc.php
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<?php
/**
* @file classes/security/RoleDAO.inc.php
*
* Copyright (c) 2005-2012 Alec Smecher and John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class RoleDAO
* @ingroup security
* @see Role
*
* @brief Operations for retrieving and modifying Role objects.
*/
import('classes.security.Role');
class RoleDAO extends DAO {
/**
* Constructor.
*/
function RoleDAO() {
parent::DAO();
$this->userDao =& DAORegistry::getDAO('UserDAO');
}
/**
* Create new data object.
* @return Role
*/
function &newDataObject() {
$dataObject = new Role();
return $dataObject;
}
/**
* Retrieve a role.
* @param $userId int
* @param $roleId int
* @return Role
*/
function &getRole($userId, $roleId) {
$result =& $this->retrieve(
'SELECT * FROM roles WHERE user_id = ? AND role_id = ?',
array(
(int) $userId,
(int) $roleId
)
);
$returner = null;
if ($result->RecordCount() != 0) {
$returner =& $this->_returnRoleFromRow($result->GetRowAssoc(false));
}
$result->Close();
unset($result);
return $returner;
}
/**
* Internal function to return a Role object from a row.
* @param $row array
* @return Role
*/
function &_returnRoleFromRow($row) {
$role = new Role();
$role->setUserId($row['user_id']);
$role->setRoleId($row['role_id']);
HookRegistry::call('RoleDAO::_returnRoleFromRow', array(&$role, &$row));
return $role;
}
/**
* Insert a new role.
* @param $role Role
*/
function insertRole(&$role) {
return $this->update(
'INSERT INTO roles
(user_id, role_id)
VALUES
(?, ?)',
array(
(int) $role->getUserId(),
(int) $role->getRoleId()
)
);
}
/**
* Delete a role.
* @param $role Role
*/
function deleteRole(&$role) {
return $this->deleteRoleByUserId($role->getUserId(), $role->getRoleId());
}
/**
* Delete a role.
* @param $userId int
* @param $roleId int optional
*/
function deleteRoleByUserId($userId, $roleId = null) {
$params = array((int) $userId);
$roleId = (int) $roleId;
if ($roleId) $params[] = $roleId;
return $this->update(
'DELETE FROM roles WHERE user_id = ?' . ($roleId?' AND role_id = ?':''),
$params
);
}
/**
* Retrieve a list of all roles for a specified user.
* @param $userId int
* @return array matching Roles
*/
function &getRolesByUserId($userId) {
$roles = array();
$result =& $this->retrieve(
'SELECT * FROM roles WHERE user_id = ?',
(int) $userId
);
while (!$result->EOF) {
$roles[] = $this->_returnRoleFromRow($result->GetRowAssoc(false));
$result->moveNext();
}
$result->Close();
unset($result);
return $roles;
}
/**
* Return an array of objects corresponding to the roles a given user has,
* grouped by context id.
* @param $userId int
* @return array
*/
function &getByUserIdGroupedByContext($userId) {
$roles = $this->getRolesByUserId($userId);
$groupedRoles = array();
foreach ($roles as $role) {
$groupedRoles[CONTEXT_ID_NONE][$role->getRoleId()] =& $role;
unset($role);
}
return $groupedRoles;
}
/**
* Retrieve a list of users in a specified role.
* @param $roleId int optional (can leave as null to get all users in journal)
* @param $searchType int optional, which field to search
* @param $search string optional, string to match
* @param $searchMatch string optional, type of match ('is' vs. 'contains' vs. 'startsWith')
* @param $dbResultRange object DBRangeInfo object describing range of results to return
* @return array matching Users
*/
function &getUsersByRoleId($roleId = null, $searchType = null, $search = null, $searchMatch = null, $dbResultRange = null, $sortBy = null, $sortDirection = SORT_DIRECTION_ASC) {
$users = array();
$paramArray = array('interests');
if ($roleId) $paramArray[] = (int) $roleId;
$searchSql = '';
$searchTypeMap = array(
USER_FIELD_FIRSTNAME => 'u.first_name',
USER_FIELD_LASTNAME => 'u.last_name',
USER_FIELD_USERNAME => 'u.username',
USER_FIELD_EMAIL => 'u.email',
USER_FIELD_INTERESTS => 's.setting_value'
);
if (isset($search) && isset($searchTypeMap[$searchType])) {
$fieldName = $searchTypeMap[$searchType];
switch ($searchMatch) {
case 'is':
$searchSql = "AND LOWER($fieldName) = LOWER(?)";
$paramArray[] = $search;
break;
case 'contains':
$searchSql = "AND LOWER($fieldName) LIKE LOWER(?)";
$paramArray[] = '%' . $search . '%';
break;
case 'startsWith':
$searchSql = "AND LOWER($fieldName) LIKE LOWER(?)";
$paramArray[] = $search . '%';
break;
}
} elseif (isset($search)) switch ($searchType) {
case USER_FIELD_USERID:
$searchSql = 'AND u.user_id=?';
$paramArray[] = $search;
break;
case USER_FIELD_INITIAL:
$searchSql = 'AND LOWER(u.last_name) LIKE LOWER(?)';
$paramArray[] = $search . '%';
break;
}
$searchSql .= ($sortBy?(' ORDER BY ' . $this->getSortMapping($sortBy) . ' ' . $this->getDirectionMapping($sortDirection)) : '');
$result =& $this->retrieveRange(
'SELECT DISTINCT u.* FROM users AS u LEFT JOIN user_settings s ON (u.user_id = s.user_id AND s.setting_name = ?), roles AS r WHERE u.user_id = r.user_id ' . ($roleId?'AND r.role_id = ?':'') . ' ' . $searchSql,
$paramArray,
$dbResultRange
);
$returner = new DAOResultFactory($result, $this->userDao, '_returnUserFromRowWithData');
return $returner;
}
/**
* Validation check to see if a user belongs to any group that has a given role
* @param $userId int
* @param $roleId int
* @return boolean
*/
function userHasRole($userId, $roleId) {
$result =& $this->retrieve(
'SELECT COUNT(*) FROM roles WHERE user_id = ? AND role_id = ?', array((int) $userId, (int) $roleId)
);
$returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;
$result->Close();
unset($result);
return $returner;
}
/**
* Get a role's ID based on its path.
* @param $rolePath string
* @return int
*/
function getRoleIdFromPath($rolePath) {
switch ($rolePath) {
case 'admin':
return ROLE_ID_SITE_ADMIN;
case 'submitter':
return ROLE_ID_SUBMITTER;
default:
return null;
}
}
}
?>