HMACCacheTable.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Database;
 
use Elgg\Database;
use Elgg\Exceptions\RangeException;
use Elgg\Traits\TimeUsing;
 
class HMACCacheTable {
    
    use TimeUsing;
    
    public const TABLE_NAME = 'hmac_cache';
    
    protected int $ttl = 90000;
    
    public function __construct(protected Database $database) {
    }
    
    public function __destruct() {
        if ($this->getTTL() < 0) {
            return;
        }
        
        $expires = $this->getCurrentTime("-{$this->getTTL()} seconds");
        
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('ts', '<', $expires->getTimestamp(), ELGG_VALUE_TIMESTAMP));
        
        $this->database->deleteData($delete);
    }
    
    public function setTTL(int $ttl = 0): void {
        if ($ttl < -1) {
            throw new RangeException(__METHOD__ . ': TTL needs to be greater than or equal to -1');
        }
        
        $this->ttl = $ttl;
    }
    
    public function getTTL(): int {
        return $this->ttl;
    }
    
    public function storeHMAC(string $hmac) {
        $insert = Insert::intoTable(self::TABLE_NAME);
        $insert->values([
            'hmac' => $insert->param($hmac, ELGG_VALUE_STRING),
            'ts' => $insert->param($this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP),
        ]);
        
        return $this->database->insertData($insert);
    }
    
    public function loadHMAC(string $hmac): ?string {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*');
        $select->where($select->compare('hmac', '=', $hmac, ELGG_VALUE_STRING));
        
        $row = $this->database->getDataRow($select);
        if (empty($row)) {
            return null;
        }
        
        return $row->hmac;
    }
    
    public function deleteHMAC(string $hmac) : int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('hmac', '=', $hmac, ELGG_VALUE_STRING));
        
        return $this->database->deleteData($delete);
    }
}