UsersTable.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Elgg\Config;
use Elgg\Database;
use Elgg\Database\Clauses\OrderByClause;
use Elgg\Traits\TimeUsing;

class UsersTable {

    use TimeUsing;

    protected $config;

    protected $db;

    protected $metadata;

    public function __construct(Config $config, Database $db, MetadataTable $metadata) {
        $this->config = $config;
        $this->db = $db;
        $this->metadata = $metadata;
    }

    public function getByUsername($username) {
        if (empty($username)) {
            return false;
        }

        // Fixes #6052. Username is frequently sniffed from the path info, which,
        // unlike $_GET, is not URL decoded. If the username was not URL encoded,
        // this is harmless.
        $username = rawurldecode($username);
        if (empty($username)) {
            return false;
        }

        $logged_in_user = elgg_get_logged_in_user_entity();
        if (!empty($logged_in_user) && ($logged_in_user->username === $username)) {
            return $logged_in_user;
        }

        $users = elgg_get_entities([
            'types' => 'user',
            'metadata_name_value_pairs' => [
                [
                    'name' => 'username',
                    'value' => $username,
                    'case_sensitive' => false,
                ],
            ],
            'limit' => 1,
        ]);

        return $users ? $users[0] : false;
    }

    public function getByEmail($email) {
        if (!$email) {
            return [];
        }

        $users = elgg_get_entities([
            'types' => 'user',
            'metadata_name_value_pairs' => [
                [
                    'name' => 'email',
                    'value' => $email,
                    'case_sensitive' => false,
                ],
            ],
            'limit' => 1,
        ]);

        return $users ? : [];
    }

    public function findActive(array $options = []) {

        $options = array_merge([
            'seconds' => 600,
            'limit' => $this->config->default_limit,
            'offset' => 0,
        ], $options);

        // cast options we're sending to hook
        foreach (['seconds', 'limit', 'offset'] as $key) {
            $options[$key] = (int) $options[$key];
        }
        $options['count'] = (bool) $options['count'];

        // allow plugins to override
        $params = [
            'seconds' => $options['seconds'],
            'limit' => $options['limit'],
            'offset' => $options['offset'],
            'count' => $options['count'],
            'options' => $options,
        ];
        $data = _elgg_services()->hooks->triggerDeprecated('find_active_users', 'system', $params, null, "No longer use the 'find_active_users', 'system' hook", '4.3');
        // check null because the handler could legitimately return falsey values.
        if ($data !== null) {
            return $data;
        }

        $time = $this->getCurrentTime()->getTimestamp() - $options['seconds'];
        return elgg_get_entities([
            'type' => 'user',
            'limit' => $options['limit'],
            'offset' => $options['offset'],
            'count' => $options['count'],
            'wheres' => function(QueryBuilder $qb, $main_alias) use ($time) {
                return $qb->compare("{$main_alias}.last_action", '>=', $time, ELGG_VALUE_INTEGER);
            },
            'order_by' => new OrderByClause('e.last_action', 'DESC'),
        ]);
    }

    public function generateInviteCode(string $username): string {
        $time = $this->getCurrentTime()->getTimestamp();
        $token = _elgg_services()->hmac->getHmac([$time, $username])->getToken();
        
        return "{$time}.{$token}";
    }

    public function validateInviteCode(string $username, string $code): bool {
        // validate the format of the token created by self::generateInviteCode()
        $matches = [];
        if (!preg_match('~^(\d+)\.([a-zA-Z0-9\-_]+)$~', $code, $matches)) {
            return false;
        }
        $time = (int) $matches[1];
        $mac = $matches[2];

        return _elgg_services()->hmac->getHmac([$time, $username])->matchesToken($mac);
    }
}