UserController.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2018, 2021 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 SPDX-FileCopyrightText: Kaushlendra Pratap <kaushlendra-pratap.singh@siemens.com>
 SPDX-License-Identifier: GPL-2.0-only
*/
namespace Fossology\UI\Api\Controllers;
 
use Fossology\Lib\Exceptions\DuplicateTokenKeyException;
use Fossology\Lib\Exceptions\DuplicateTokenNameException;
use Fossology\UI\Api\Exceptions\HttpBadRequestException;
use Fossology\UI\Api\Exceptions\HttpConflictException;
use Fossology\UI\Api\Exceptions\HttpErrorException;
use Fossology\UI\Api\Exceptions\HttpInternalServerErrorException;
use Fossology\UI\Api\Exceptions\HttpNotFoundException;
use Fossology\UI\Api\Exceptions\HttpTooManyRequestException;
use Fossology\UI\Api\Helper\ResponseHelper;
use Fossology\UI\Api\Helper\RestHelper;
use Fossology\UI\Api\Helper\UserHelper;
use Fossology\UI\Api\Models\ApiVersion;
use Fossology\UI\Api\Models\Info;
use Fossology\UI\Api\Models\InfoType;
use Fossology\UI\Api\Models\TokenRequest;
use Psr\Http\Message\ServerRequestInterface;
 
class UserController extends RestController
{
  public function getUsers($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    $id = null;
    if (isset($args['pathParam'])) {
      if ($apiVersion == ApiVersion::V2) {
        $user = $this->restHelper->getUserDao()->getUserByName($args['pathParam']);
        if ($user === null) {
          throw new HttpNotFoundException("UserId doesn't exist");
        }
        $id = intval($user['user_pk']);
      } else {
        $id = intval($args['pathParam']);
      }
      if (! $this->dbHelper->doesIdExist("users", "user_pk", $id)) {
        throw new HttpNotFoundException("UserId doesn't exist");
      }
    }
    $users = $this->dbHelper->getUsers($id);
 
    $allUsers = array();
    foreach ($users as $user) {
      $allUsers[] = $user->getArray($apiVersion);
    }
    if ($id !== null) {
      $allUsers = $allUsers[0];
    }
    return $response->withJson($allUsers, 200);
  }
 
  public function addUser($request, $response, $args)
  {
    $this->throwNotAdminException();
    $apiVersion = ApiVersion::getVersion($request);
    $userDetails = $this->getParsedBody($request);
    if ($userDetails === null || !is_array($userDetails)) {
      throw new HttpBadRequestException("Request body is empty or malformed.");
    }
    if (empty($userDetails['name'])) {
      throw new HttpBadRequestException("Username must be specified.");
    }
    $userHelper = new UserHelper();
    // creating symphony request
    $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
    $symfonyRequest->request->set('username', $userDetails['name']);
    $symfonyRequest->request->set('pass1', $userDetails[$apiVersion == ApiVersion::V2 ? 'userPass' : 'user_pass']);
    $symfonyRequest->request->set('pass2', $userDetails[$apiVersion == ApiVersion::V2 ? 'userPass' : 'user_pass']);
    $symfonyRequest->request->set('description', $userDetails['description']);
    $symfonyRequest->request->set('permission', $userHelper->getEquivalentValueForPermission($userDetails['accessLevel']));
    $symfonyRequest->request->set('folder', $userDetails['rootFolderId']);
    $symfonyRequest->request->set('enote', $userDetails['emailNotification'] ? 'y' : 'n');
    $symfonyRequest->request->set('email', $userDetails['email']);
    $symfonyRequest->request->set('public', $userDetails['defaultVisibility']);
    $symfonyRequest->request->set('default_bucketpool_fk', $userDetails['defaultBucketpool'] ?? 2);
 
    $agents = array();
    if (isset($userDetails['agents'])) {
      if (is_string($userDetails['agents'])) { // If 'x-www-form-urlencoded', inner elements are not decoded
        $userDetails['agents'] = json_decode($userDetails['agents'], true);
      }
      $agents['Check_agent_mimetype'] = isset($userDetails['agents']['mime']) && $userDetails['agents']['mime'] ? 1 : 0;
      $agents['Check_agent_monk'] = isset($userDetails['agents']['monk']) && $userDetails['agents']['monk'] ? 1 : 0;
      $agents['Check_agent_ojo'] = isset($userDetails['agents']['ojo']) && $userDetails['agents']['ojo'] ? 1 : 0;
      $agents['Check_agent_bucket'] = isset($userDetails['agents']['bucket']) && $userDetails['agents']['bucket'] ? 1 : 0 ;
      $agents['Check_agent_copyright'] = isset($userDetails['agents'][$apiVersion == ApiVersion::V2 ? 'copyrightEmailAuthor' : 'copyright_email_author']) && $userDetails['agents'][$apiVersion == ApiVersion::V2 ? 'copyrightEmailAuthor' : 'copyright_email_author'] ? 1 : 0;
      $agents['Check_agent_ecc'] = isset($userDetails['agents']['ecc']) && $userDetails['agents']['ecc'] ? 1 : 0;
      $agents['Check_agent_keyword'] = isset($userDetails['agents']['keyword']) && $userDetails['agents']['keyword'] ? 1 : 0;
      $agents['Check_agent_nomos'] = isset($userDetails['agents']['nomos']) && $userDetails['agents']['nomos'] ? 1 : 0;
      $agents['Check_agent_pkgagent'] = isset($userDetails['agents']['package']) && $userDetails['agents']['package'] ? 1 : 0;
      $agents['Check_agent_reso'] = isset($userDetails['agents']['reso']) && $userDetails['agents']['reso'] ? 1 : 0;
      $agents['Check_agent_shagent'] = isset($userDetails['agents']['heritage']) && $userDetails['agents']['heritage'] ? 1 : 0 ;
    }
 
    $symfonyRequest->request->set('user_agent_list', userAgents($agents));
 
    // initialising the user_add object
    global $container;
    $restHelper = $container->get('helper.restHelper');
    $userAddObj = $restHelper->getPlugin('user_add');
 
    // calling the add function
    $ErrMsg = $userAddObj->add($symfonyRequest);
 
    if ($ErrMsg != '') {
      throw new HttpInternalServerErrorException($ErrMsg);
    }
 
    $returnVal = new Info(201, "User created successfully", InfoType::INFO);
    return $response->withJson($returnVal->getArray(), $returnVal->getCode());
  }
 
  public function deleteUser($request, $response, $args)
  {
    $this->throwNotAdminException();
    $apiVersion = ApiVersion::getVersion($request);
    if ($apiVersion == ApiVersion::V2) {
      $user = $this->restHelper->getUserDao()->getUserByName($args['pathParam']);
      if ($user === null) {
        throw new HttpNotFoundException("UserId doesn't exist");
      }
      $id = intval($user['user_pk']);
    } else {
      $id = intval($args['pathParam']);
    }
    if (!$this->dbHelper->doesIdExist("users","user_pk", $id)) {
      throw new HttpNotFoundException("UserId doesn't exist");
    }
 
    $this->dbHelper->deleteUser($id);
    $returnVal = new Info(202, "User will be deleted", InfoType::INFO);
    return $response->withJson($returnVal->getArray(), $returnVal->getCode());
  }
 
  public function getCurrentUser($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    $user = $this->dbHelper->getUsers($this->restHelper->getUserId())[0]->getArray($apiVersion);
    if ($apiVersion == ApiVersion::V2) {
      return $response->withJson($user, 200);
    }
    $userDao = $this->restHelper->getUserDao();
    $defaultGroup = $userDao->getUserAndDefaultGroupByUserName($user["name"])["group_name"];
    $user['default_group'] = $defaultGroup;
    return $response->withJson($user, 200);
  }
 
  public function updateUser($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    if ($apiVersion == ApiVersion::V2) {
      $user = $this->restHelper->getUserDao()->getUserByName($args['pathParam']);
      if ($user === null) {
        throw new HttpNotFoundException("UserId doesn't exist");
      }
      $id = intval($user['user_pk']);
    } else {
      $id = intval($args['pathParam']);
    }
    if ($id !== intval($this->restHelper->getUserId())) {
      $this->throwNotAdminException();
    }
    if (!$this->dbHelper->doesIdExist("users","user_pk", $id)) {
      throw new HttpNotFoundException("UserId doesn't exist");
    }
    $reqBody = $this->getParsedBody($request);
    $userHelper = new UserHelper($id);
    $returnVal = $userHelper->modifyUserDetails($reqBody, $apiVersion);
    return $response->withJson($returnVal->getArray(), $returnVal->getCode());
  }
 
  public function createRestApiToken($request, $response, $args)
  {
    $reqBody = $this->getParsedBody($request);
    $tokenRequest = TokenRequest::fromArray($reqBody,
      ApiVersion::getVersion($request));
    $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
 
    // translating values for symfony request
    $symfonyRequest->request->set('pat_name', $tokenRequest->getTokenName());
    $symfonyRequest->request->set('pat_expiry', $tokenRequest->getTokenExpire());
    $symfonyRequest->request->set('pat_scope', $tokenRequest->getTokenScope());
 
    // initialising the user_edit plugin
    global $container;
    $restHelper = $container->get('helper.restHelper');
    $userEditObj = $restHelper->getPlugin('user_edit');
 
    // creating the REST token
    try {
      $token = $userEditObj->generateNewToken($symfonyRequest);
    } catch (DuplicateTokenKeyException $e) {
      throw new HttpTooManyRequestException("Please try again later.", $e);
    } catch (DuplicateTokenNameException $e) {
      throw new HttpConflictException($e->getMessage(), $e);
    } catch (\UnexpectedValueException $e) {
      throw new HttpBadRequestException($e->getMessage(), $e);
    }
 
    $returnVal = new Info(201, "Token created successfully", InfoType::INFO);
    $res = $returnVal->getArray();
    $res['token'] = $token;
    return $response->withJson($res, $returnVal->getCode());
  }
 
  public function getTokens($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    $tokenType = $args['type'];
    if ($tokenType != "active" && $tokenType != "expired") {
      throw new HttpBadRequestException("Invalid request!");
    }
    // initialising the user_edit plugin
    global $container;
    $restHelper = $container->get('helper.restHelper');
    $userEditObj = $restHelper->getPlugin('user_edit');
 
    // getting the list of tokens based on the type of token requested
    $tokens = $tokenType == "active" ? $userEditObj->getListOfActiveTokens() : $userEditObj->getListOfExpiredTokens();
    $manageTokenObj = $restHelper->getPlugin('manage-token');
 
    $finalTokens = array();
    foreach ($tokens as $token) {
      list($tokenPk) = explode(".", $token['id']);
      $tokenVal = $manageTokenObj->revealToken($tokenPk);
      $finalTokens[] = array_merge($token, ['token' => $tokenVal['token']]);
    }
 
    $returnVal = new Info(200, "Success", InfoType::INFO);
    $res = $returnVal->getArray();
    $res[$tokenType . ($apiVersion == ApiVersion::V2 ? 'Tokens' : '_tokens')] = $finalTokens;
    return $response->withJson($res, $returnVal->getCode());
  }
}