UsersRememberMeCookiesTable.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Elgg\Database;
use Elgg\Traits\TimeUsing;

class UsersRememberMeCookiesTable {

    use TimeUsing;
    
    public const TABLE_NAME = 'users_remember_me_cookies';

    public function __construct(protected Database $database) {
    }
    
    public function insertHash(\ElggUser $user, string $hash): int {
        // This prevents inserting the same hash twice, which seems to be happening in some rare cases
        // and for unknown reasons. See https://github.com/Elgg/Elgg/issues/8104
        $this->deleteHash($hash);
        
        $insert = Insert::intoTable(self::TABLE_NAME);
        $insert->values([
            'code' => $insert->param($hash, ELGG_VALUE_STRING),
            'guid' => $insert->param($user->guid, ELGG_VALUE_GUID),
            'timestamp' => $insert->param($this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP),
        ]);
        
        return $this->database->insertData($insert);
    }
    
    public function getRowFromHash(string $hash): ?\stdClass {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('code', '=', $hash, ELGG_VALUE_STRING));
        
        return $this->database->getDataRow($select) ?: null;
    }
    
    public function updateHash(\ElggUser $user, string $hash): bool {
        $update = Update::table(self::TABLE_NAME);
        $update->set('timestamp', $update->param($this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP))
            ->where($update->compare('guid', '=', $user->guid, ELGG_VALUE_GUID))
            ->andWhere($update->compare('code', '=', $hash, ELGG_VALUE_STRING));
        
        // not interested in number of updated rows, as an update in the same second won't update the row
        return $this->database->updateData($update);
    }
    
    public function deleteHash(string $hash): int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('code', '=', $hash, ELGG_VALUE_STRING));
        
        return $this->database->deleteData($delete);
    }
    
    public function deleteAllHashes(\ElggUser $user): int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('guid', '=', $user->guid, ELGG_VALUE_GUID));
        
        return $this->database->deleteData($delete);
    }
    
    public function deleteExpiredHashes(int $expiration): int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('timestamp', '<', $expiration, ELGG_VALUE_TIMESTAMP));
        
        return $this->database->deleteData($delete);
    }
}