ApiTokens.php

Go to the documentation of this file.

<?php
 
namespace Ubiquity\controllers\rest;
 
use Ubiquity\cache\system\ArrayCache;
 
class ApiTokens {
    protected $tokens;
    protected $length;
    protected $duration;
    protected static $cache;
 
    public function __construct($length = 10, $duration = 3600, $tokens = [ ]) {
        $this->length = $length ?? 10;
        $this->duration = $duration ?? 3600;
        $this->tokens = $tokens;
    }
 
    protected function generateToken() {
        do {
            $token = $this->tokenGenerator ();
        } while ( \array_search ( $token, $this->tokens, true ) === true );
        return $token;
    }
 
    protected function tokenGenerator() {
        return \bin2hex ( \random_bytes ( $this->length ) );
    }
 
    public function getTokens() {
        return $this->tokens;
    }
 
    public function getDuration() {
        return $this->duration;
    }
 
    public function getToken($key) {
        return $this->tokens [$key]??false;
    }
 
    public function isExpired($key) {
        $token = $this->getToken ( $key );
        if ($token !== false) {
            return \time() - $token ['creationTime'] > $this->duration;
        }
        return true;
    }
 
    public function addToken($datas=null) {
        $key = $this->generateToken ();
        $token=[ 'creationTime' => \time () ];
        if(isset($datas)){
            $token['datas']=$datas;
        }
        $this->tokens [$key] = $token;
        return $key;
    }
 
    public function refreshToken(string $key) {
        if($token=$this->getToken($key)){
            $token=$this->addToken($token['datas']??null);
            $this->remove($key);
            return $token;
        }
        return false;
    }
 
    public function clearAll() {
        $this->tokens = [ ];
    }
 
    public function removeExpireds() {
        $tokens = $this->tokens;
        foreach ( $tokens as $key => $value ) {
            if ($this->isExpired ( $key )) {
                unset ( $this->tokens [$key] );
            }
        }
    }
 
    public function remove($key) {
        if (isset ( $this->tokens [$key] )) {
            unset ( $this->tokens [$key] );
            return true;
        }
        return false;
    }
 
    public function storeToCache($key = '_apiTokens') {
        $fileContent = [ 'duration' => $this->duration,'length' => $this->length,'tokens' => $this->tokens ];
        self::$cache->store ( $key, $fileContent );
    }
 
    public function getFromCache($folder, $key = '_apiTokens') {
        if (! isset ( self::$cache )) {
            self::$cache = new ArrayCache ( $folder . 'rest/tokens', '.rest' );
        }
        if (self::$cache->exists ( $key )) {
            $filecontent = self::$cache->fetch ( $key );
            if (isset ( $filecontent ['tokens'] )) {
                $this->tokens = $filecontent ['tokens'];
            }
            if (isset ( $filecontent ['length'] )) {
                $this->length = $filecontent ['length'];
            }
            if (isset ( $filecontent ['duration'] )) {
                $this->duration = $filecontent ["duration"];
            }
        }
        return $this;
    }
}