13 namespace Fossology\UI\Api\Controllers;
30 use Psr\Http\Message\ServerRequestInterface;
47 public function getUsers($request, $response, $args)
50 if (isset($args[
'id'])) {
51 $id = intval($args[
'id']);
52 if (! $this->dbHelper->doesIdExist(
"users",
"user_pk", $id)) {
56 $users = $this->dbHelper->getUsers($id);
59 foreach ($users as $user) {
60 $allUsers[] = $user->getArray();
63 $allUsers = $allUsers[0];
65 return $response->withJson($allUsers, 200);
77 public function addUser($request, $response, $args)
82 $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
83 $symfonyRequest->request->set(
'username', $userDetails[
'name']);
84 $symfonyRequest->request->set(
'pass1', $userDetails[
'user_pass']);
85 $symfonyRequest->request->set(
'pass2', $userDetails[
'user_pass']);
86 $symfonyRequest->request->set(
'description', $userDetails[
'description']);
87 $symfonyRequest->request->set(
'permission', $userHelper->getEquivalentValueForPermission($userDetails[
'accessLevel']));
88 $symfonyRequest->request->set(
'folder', $userDetails[
'rootFolderId']);
89 $symfonyRequest->request->set(
'enote', $userDetails[
'emailNotification'] ?
'y' :
'n');
90 $symfonyRequest->request->set(
'email', $userDetails[
'email']);
91 $symfonyRequest->request->set(
'public', $userDetails[
'defaultVisibility']);
92 $symfonyRequest->request->set(
'default_bucketpool_fk', $userDetails[
'defaultBucketpool'] ?? 2);
95 if (isset($userDetails[
'agents'])) {
96 if (is_string($userDetails[
'agents'])) {
97 $userDetails[
'agents'] = json_decode($userDetails[
'agents'],
true);
99 $agents[
'Check_agent_mimetype'] = isset($userDetails[
'agents'][
'mime']) && $userDetails[
'agents'][
'mime'] ? 1 : 0;
100 $agents[
'Check_agent_monk'] = isset($userDetails[
'agents'][
'monk']) && $userDetails[
'agents'][
'monk'] ? 1 : 0;
101 $agents[
'Check_agent_ojo'] = isset($userDetails[
'agents'][
'ojo']) && $userDetails[
'agents'][
'ojo'] ? 1 : 0;
102 $agents[
'Check_agent_bucket'] = isset($userDetails[
'agents'][
'bucket']) && $userDetails[
'agents'][
'bucket'] ? 1 : 0 ;
103 $agents[
'Check_agent_copyright'] = isset($userDetails[
'agents'][
'copyright_email_author']) && $userDetails[
'agents'][
'copyright_email_author'] ? 1 : 0;
104 $agents[
'Check_agent_ecc'] = isset($userDetails[
'agents'][
'ecc']) && $userDetails[
'agents'][
'ecc'] ? 1 : 0;
105 $agents[
'Check_agent_keyword'] = isset($userDetails[
'agents'][
'keyword']) && $userDetails[
'agents'][
'keyword'] ? 1 : 0;
106 $agents[
'Check_agent_nomos'] = isset($userDetails[
'agents'][
'nomos']) && $userDetails[
'agents'][
'nomos'] ? 1 : 0;
107 $agents[
'Check_agent_pkgagent'] = isset($userDetails[
'agents'][
'package']) && $userDetails[
'agents'][
'package'] ? 1 : 0;
108 $agents[
'Check_agent_reso'] = isset($userDetails[
'agents'][
'reso']) && $userDetails[
'agents'][
'reso'] ? 1 : 0;
109 $agents[
'Check_agent_shagent'] = isset($userDetails[
'agents'][
'heritage']) && $userDetails[
'agents'][
'heritage'] ? 1 : 0 ;
112 $symfonyRequest->request->set(
'user_agent_list',
userAgents($agents));
120 $ErrMsg = $userAddObj->add($symfonyRequest);
126 $returnVal =
new Info(201,
"User created successfully", InfoType::INFO);
127 return $response->withJson($returnVal->getArray(), $returnVal->getCode());
141 $id = intval($args[
'id']);
142 if (!$this->dbHelper->doesIdExist(
"users",
"user_pk", $id)) {
146 $this->dbHelper->deleteUser($id);
147 $returnVal =
new Info(202,
"User will be deleted", InfoType::INFO);
148 return $response->withJson($returnVal->getArray(), $returnVal->getCode());
161 $user = $this->dbHelper->getUsers($this->restHelper->getUserId())[0]->getArray();
162 $userDao = $this->restHelper->getUserDao();
163 $defaultGroup = $userDao->getUserAndDefaultGroupByUserName($user[
"name"])[
"group_name"];
164 $user[
"default_group"] = $defaultGroup;
165 return $response->withJson($user, 200);
179 $id = intval($args[
'id']);
180 if ($this->dbHelper->doesIdExist(
"users",
"user_pk", $id)) {
185 $returnVal = $userHelper->modifyUserDetails($reqBody);
186 return $response->withJson($returnVal->getArray(), $returnVal->getCode());
198 public function createRestApiToken($request, $response, $args)
203 $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
206 $symfonyRequest->request->set(
'pat_name', $tokenRequest->getTokenName());
207 $symfonyRequest->request->set(
'pat_expiry', $tokenRequest->getTokenExpire());
208 $symfonyRequest->request->set(
'pat_scope', $tokenRequest->getTokenScope());
215 $userEditObj =
$restHelper->getPlugin(
'user_edit');
219 $token = $userEditObj->generateNewToken($symfonyRequest);
220 }
catch (DuplicateTokenKeyException $e) {
221 throw new HttpTooManyRequestException(
"Please try again later.", $e);
222 }
catch (DuplicateTokenNameException $e) {
223 throw new HttpConflictException($e->getMessage(), $e);
224 }
catch (\UnexpectedValueException $e) {
225 throw new HttpBadRequestException($e->getMessage(), $e);
228 $returnVal =
new Info(201,
"Token created successfully", InfoType::INFO);
229 $res = $returnVal->getArray();
230 $res[
'token'] = $token;
231 return $response->withJson($res, $returnVal->getCode());
245 $tokenType = $args[
'type'];
246 if ($tokenType !=
"active" && $tokenType !=
"expired") {
252 $userEditObj =
$restHelper->getPlugin(
'user_edit');
255 $tokens = $tokenType ==
"active" ? $userEditObj->getListOfActiveTokens() : $userEditObj->getListOfExpiredTokens();
256 $manageTokenObj =
$restHelper->getPlugin(
'manage-token');
258 $finalTokens = array();
259 foreach ($tokens as $token) {
260 list($tokenPk) = explode(
".", $token[
'id']);
261 $tokenVal = $manageTokenObj->revealToken($tokenPk);
262 $finalTokens[] = array_merge($token, [
'token' => $tokenVal[
'token']]);
265 $returnVal =
new Info(200,
"Success", InfoType::INFO);
266 $res = $returnVal->getArray();
267 $res[$tokenType .
'_tokens'] = $finalTokens;
268 return $response->withJson($res, $returnVal->getCode());
Exception when a token has duplicate key for same user.
Exception when a token has duplicate name for same user.
Base controller for REST calls.
getParsedBody(ServerRequestInterface $request)
Parse request body as JSON and return associative PHP array.
Controller for User model.
deleteUser($request, $response, $args)
addUser($request, $response, $args)
getUsers($request, $response, $args)
updateUser($request, $response, $args)
getCurrentUser($request, $response, $args)
getTokens($request, $response, $args)
Override Slim response for withJson function.
Provides various DAO helper functions for REST api.
Handle user related queries.
static getVersion(ServerRequestInterface $request)
Different type of infos provided by REST.
Info model to contain general error and return values.
static fromArray(array $input, int $version)
userAgents($agents=null)
Read the UI form and format the user selected agents into a comma separated list.