TokenRequest.php

<?php
/*
 SPDX-FileCopyrightText: © 2023 Siemens AG
 SPDX-FileContributor: Gaurav Mishra <mishra.gaurav@siemens.com>
 
 SPDX-License-Identifier: GPL-2.0-only
 */
 
namespace Fossology\UI\Api\Models;
 
use DateTime;
use Fossology\Lib\Util\ArrayOperation;
use Fossology\UI\Api\Exceptions\HttpBadRequestException;
use Fossology\UI\Api\Helper\RestHelper;
 
class TokenRequest
{
  const VERSION_1_KEYS = ["username", "password", "token_name", "token_scope",
    "token_expire"];
  const VERSION_2_KEYS = ["username", "password", "tokenName", "tokenScope",
    "tokenExpire"];
  private $tokenName;
  private $tokenScope;
  private $tokenExpire;
  private $username;
  private $password;
 
  public function __construct(string $tokenName, string $tokenScope,
                              string $tokenExpire, string $username="",
                              string $password="")
  {
    $this->setTokenName($tokenName);
    $this->setTokenScope($tokenScope);
    $this->setTokenExpire($tokenExpire);
    $this->setUsername($username);
    $this->setPassword($password);
  }
 
  public function setTokenName(string $tokenName): TokenRequest
  {
    if (empty($tokenName)) {
      throw new HttpBadRequestException("Token name cannot be empty");
    }
    $this->tokenName = $tokenName;
    return $this;
  }
 
  public function setTokenScope(string $tokenScope): TokenRequest
  {
    $tokenScope = strtolower($tokenScope);
    if (!in_array($tokenScope, RestHelper::VALID_SCOPES)) {
      throw new HttpBadRequestException("Invalid scope provided");
    }
    $this->tokenScope = RestHelper::SCOPE_DB_MAP[$tokenScope];
    return $this;
  }
 
  public function setTokenExpire(string $tokenExpire): TokenRequest
  {
    $date = DateTime::createFromFormat("!Y-m-d", $tokenExpire);
    $errors = DateTime::getLastErrors();
    if ($date === false ||
      ($errors !== false &&
        ($errors['warning_count'] > 0 || $errors['error_count'] > 0)) ||
      $date->format('Y-m-d') !== $tokenExpire) {
      throw new HttpBadRequestException("Invalid date format provided");
    }
    $this->tokenExpire = $date;
    return $this;
  }
 
  public function setUsername(string $username): TokenRequest
  {
    $this->username = $username;
    return $this;
  }
 
  public function setPassword(string $password): TokenRequest
  {
    $this->password = $password;
    return $this;
  }
 
  public function getTokenName(): string
  {
    return $this->tokenName;
  }
 
  public function getTokenScope(): string
  {
    return $this->tokenScope;
  }
 
  public function getTokenExpire(): string
  {
    return $this->tokenExpire->format('Y-m-d');
  }
 
  public function getUsername(): string
  {
    return $this->username;
  }
 
  public function getPassword(): string
  {
    return $this->password;
  }
 
  public static function fromArray(array $input, int $version): TokenRequest
  {
    if (! array_key_exists("username", $input)) {
      $input["username"] = "";
    }
    if (! array_key_exists("password", $input)) {
      $input["password"] = "";
    }
    if ($version == ApiVersion::V1) {
      if (! ArrayOperation::arrayKeysExists($input, self::VERSION_1_KEYS)) {
        throw new HttpBadRequestException("Not all required parameters sent.");
      }
      return new TokenRequest(
        $input["token_name"],
        $input["token_scope"],
        $input["token_expire"],
        $input["username"],
        $input["password"]
      );
    } else {
      if (! ArrayOperation::arrayKeysExists($input, self::VERSION_2_KEYS)) {
        throw new HttpBadRequestException("Not all required parameters sent.");
      }
      return new TokenRequest(
        $input["tokenName"],
        $input["tokenScope"],
        $input["tokenExpire"],
        $input["username"],
        $input["password"]
      );
    }
  }
}