-
Notifications
You must be signed in to change notification settings - Fork 910
/
UserHandler.inc.php
193 lines (162 loc) · 4.66 KB
/
UserHandler.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
<?php
/**
* @file api/v1/user/UserHandler.inc.php
*
* Copyright (c) 2014-2018 Simon Fraser University
* Copyright (c) 2003-2018 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class UserHandler
* @ingroup api_v1_user
*
* @brief Handle API requests for user operations.
*
*/
import('lib.pkp.classes.handler.APIHandler');
import('classes.core.ServicesContainer');
class UserHandler extends APIHandler {
/**
* Constructor
*/
public function __construct() {
$this->_handlerPath = 'users';
$roles = array(ROLE_ID_SITE_ADMIN, ROLE_ID_MANAGER);
$this->_endpoints = array(
'GET' => array (
array(
'pattern' => $this->getEndpointPattern(),
'handler' => array($this, 'getUsers'),
'roles' => $roles
),
array(
'pattern' => $this->getEndpointPattern() . '/{userId}',
'handler' => array($this, 'getUser'),
'roles' => $roles
),
),
);
parent::__construct();
}
/**
* Get a collection of users
* @param $slimRequest Request Slim request object
* @param $response Response object
* @param array $args arguments
*
* @return Response
*/
public function getUsers($slimRequest, $response, $args) {
$request = $this->getRequest();
$context = $request->getContext();
$userService = ServicesContainer::instance()->get('user');
if (!$context) {
return $response->withStatus(404)->withJsonError('api.submissions.404.resourceNotFound');
}
$params = $this->_buildListRequestParams($slimRequest);
$items = array();
$users = $userService->getUsers($context->getId(), $params);
if (!empty($users)) {
$propertyArgs = array(
'request' => $request,
'slimRequest' => $slimRequest,
);
foreach ($users as $user) {
$items[] = $userService->getSummaryProperties($user, $propertyArgs);
}
}
$data = array(
'maxItems' => $userService->getUsersMaxCount($context->getId(), $params),
'items' => $items,
);
return $response->withJson($data, 200);
}
/**
* Get a single user
* @param $slimRequest Request Slim request object
* @param $response Response object
* @param array $args arguments
*
* @return Response
*/
public function getUser($slimRequest, $response, $args) {
$request = $this->getRequest();
$dispatcher = $request->getDispatcher();
$context = $request->getContext();
$userService = ServicesContainer::instance()->get('user');
if (!empty($args['userId'])) {
$user = $userService->getUser((int) $args['userId']);
}
if (!$user) {
return $response->withStatus(404)->withJsonError('api.submissions.404.resourceNotFound');
}
$data = $userService->getFullProperties($user, array(
'request' => $request,
'slimRequest' => $slimRequest
));
return $response->withJson($data, 200);
}
/**
* Convert params passed to list requests. Coerce type and only return
* white-listed params.
*
* @param $slimRequest Request Slim request object
* @return array
*/
private function _buildListRequestParams($slimRequest) {
$request = $this->getRequest();
$currentUser = $request->getUser();
$context = $request->getContext();
// Merge query params over default params
$defaultParams = array(
'count' => 20,
'offset' => 0,
);
$requestParams = array_merge($defaultParams, $slimRequest->getQueryParams());
$returnParams = array();
// Process query params to format incoming data as needed
foreach ($requestParams as $param => $val) {
switch ($param) {
case 'orderBy':
if (in_array($val, array('id', 'familyName', 'givenName'))) {
$returnParams[$param] = $val;
}
break;
case 'orderDirection':
$returnParams[$param] = $val === 'ASC' ? $val : 'DESC';
break;
case 'status':
if (in_array($val, array('all', 'active', 'disabled'))) {
$returnParams[$param] = $val;
}
break;
// Always convert status and roleIds to array
case 'roleIds':
if (is_string($val) && strpos($val, ',') > -1) {
$val = explode(',', $val);
} elseif (!is_array($val)) {
$val = array($val);
}
$returnParams[$param] = array_map('intval', $val);
break;
case 'assignedToSubmissionStage':
case 'assignedToSubmission':
case 'assignedToSection':
$returnParams[$param] = (int) $val;
break;
case 'searchPhrase':
$returnParams[$param] = $val;
break;
// Enforce a maximum count to prevent the API from crippling the
// server
case 'count':
$returnParams[$param] = min(100, (int) $val);
break;
case 'offset':
$returnParams[$param] = (int) $val;
break;
}
}
\HookRegistry::call('API::users::params', array(&$returnParams, $slimRequest));
return $returnParams;
}
}