IpLog.php

<?php

namespace Sunlight;

use Sunlight\Database\Database as DB;

abstract class IpLog
{
    /**
     * IP log entry for failed login attempt
     *
     * var: none
     */
    const FAILED_LOGIN_ATTEMPT = 1;

    /**
     * IP log entry for article view counter cooldown
     *
     * var: article ID
     */
    const ARTICLE_VIEW = 2;

    /**
     * IP log entry for article rating cooldown
     *
     * var: article ID
     */
    const ARTICLE_RATED = 3;

    /**
     * IP log entry for poll vote cooldown
     *
     * var: poll ID
     */
    const POLL_VOTE = 4;

    /**
     * IP log entry anti-spam cooldown
     *
     * var: none
     */
    const ANTI_SPAM = 5;

    /**
     * IP log entry for failed account activation attempt
     *
     * var: none
     */
    const FAILED_ACCOUNT_ACTIVATION = 6;

    /**
     * IP log entry for password reset request
     */
    const PASSWORD_RESET_REQUESTED = 7;
    
    /**
     * Check IP address log
     *
     * @param int $type entry type, see class constants
     * @param int|null $var variable argument (depends on type)
     * @param int|null $expires expiration time (for custom types)
     */
    static function check(int $type, ?int $var = null, ?int $expires = null): bool
    {
        // clean IP log
        static $cleaned = [
            'system' => false,
            'custom' => [],
        ];

        if ($type <= self::PASSWORD_RESET_REQUESTED) {
            if (!$cleaned['system']) {
                DB::query(
                    'DELETE FROM ' . DB::table('iplog')
                    . ' WHERE (type=' . self::FAILED_LOGIN_ATTEMPT . ' AND ' . time() . '-time>' . Settings::get('maxloginexpire') . ')'
                    . ' OR (type=' . self::ARTICLE_VIEW . ' AND ' . time() . '-time>' . Settings::get('artviewexpire') . ')'
                    . ' OR (type=' . self::ARTICLE_RATED . ' AND ' . time() . '-time>' . Settings::get('artrateexpire') . ')'
                    . ' OR (type=' . self::POLL_VOTE . ' AND ' . time() . '-time>' . Settings::get('pollvoteexpire') . ')'
                    . ' OR (type=' . self::ANTI_SPAM . ' AND ' . time() . '-time>' . Settings::get('antispamtimeout') . ')'
                    . ' OR (type=' . self::FAILED_ACCOUNT_ACTIVATION . ' AND ' . time() . '-time>' . Settings::get('accactexpire') . ')'
                    . ' OR (type=' . self::PASSWORD_RESET_REQUESTED . ' AND ' . time() . '-time>' . Settings::get('lostpassexpire') . ')'
                );
                $cleaned['system'] = true;
            }
        } elseif (!isset($cleaned['custom'][$type])) {
            if ($expires === null) {
                throw new \InvalidArgumentException('The "expires" argument must be specified for custom types');
            }

            DB::delete('iplog', 'type=' . $type .(($var !== null) ? ' AND var=' . $var : '') . ' AND ' . time() . '-time>' . $expires);
            $cleaned['custom'][$type] = true;
        }

        // check IP log
        $result = true;
        $querybasic = 'SELECT * FROM ' . DB::table('iplog') . ' WHERE ip=' . DB::val(Core::getClientIp()) . ' AND type=' . $type;

        switch ($type) {
            case self::FAILED_LOGIN_ATTEMPT:
                $query = DB::queryRow($querybasic);

                if ($query !== false && $query['var'] >= Settings::get('maxloginattempts')) {
                    $result = false;
                }
                break;

            case self::ARTICLE_VIEW:
            case self::ARTICLE_RATED:
            case self::POLL_VOTE:
                $query = DB::query($querybasic . ' AND var=' . $var);

                if (DB::size($query) != 0) {
                    $result = false;
                }
                break;

            case self::ANTI_SPAM:
            case self::PASSWORD_RESET_REQUESTED:
                $query = DB::query($querybasic);

                if (DB::size($query) != 0) {
                    $result = false;
                }
                break;

            case self::FAILED_ACCOUNT_ACTIVATION:
                $query = DB::queryRow($querybasic);

                if ($query !== false && $query['var'] >= 5) {
                    $result = false;
                }
                break;

            default:
                $query = DB::query($querybasic . (($var !== null) ? ' AND var=' . $var : ''));

                if (DB::size($query) != 0) {
                    $result = false;
                }
                break;
        }

        Extend::call('iplog.check', [
            'type' => $type,
            'var' => $var,
            'result' => &$result,
        ]);

        if ($result === false) {
            Logger::debug('ip_log', 'IP log check failed', ['type' => $type, 'var' => $var]);
        }

        return $result;
    }

    /**
     * Update IP log
     *
     * @param int $type entry type, see class constants
     * @param int|null $var variable argument (depends on type)
     */
    static function update(int $type, ?int $var = null): void
    {
        $querybasic = 'SELECT * FROM ' . DB::table('iplog') . ' WHERE ip=' . DB::val(Core::getClientIp()) . ' AND type=' . $type;

        switch ($type) {
            case self::FAILED_LOGIN_ATTEMPT:
                $query = DB::queryRow($querybasic);

                if ($query !== false) {
                    DB::update('iplog', 'id=' . $query['id'], ['var' => ($query['var'] + 1)]);
                } else {
                    DB::insert('iplog', [
                        'ip' => Core::getClientIp(),
                        'type' => self::FAILED_LOGIN_ATTEMPT,
                        'time' => time(),
                        'var' => 1
                    ]);
                }
                break;

            case self::ARTICLE_VIEW:
                DB::insert('iplog', [
                    'ip' => Core::getClientIp(),
                    'type' => self::ARTICLE_VIEW,
                    'time' => time(),
                    'var' => $var
                ]);
                break;

            case self::ARTICLE_RATED:
                DB::insert('iplog', [
                    'ip' => Core::getClientIp(),
                    'type' => self::ARTICLE_RATED,
                    'time' => time(),
                    'var' => $var
                ]);
                break;

            case self::POLL_VOTE:
                DB::insert('iplog', [
                    'ip' => Core::getClientIp(),
                    'type' => self::POLL_VOTE,
                    'time' => time(),
                    'var' => $var
                ]);
                break;

            case self::ANTI_SPAM:
            case self::PASSWORD_RESET_REQUESTED:
                DB::insert('iplog', [
                    'ip' => Core::getClientIp(),
                    'type' => $type,
                    'time' => time(),
                    'var' => 0
                ]);
                break;

            case self::FAILED_ACCOUNT_ACTIVATION:
                $query = DB::queryRow($querybasic);

                if ($query !== false) {
                    DB::update('iplog', 'id=' . $query['id'], ['var' => ($query['var'] + 1)]);
                } else {
                    DB::insert('iplog', [
                        'ip' => Core::getClientIp(),
                        'type' => self::FAILED_ACCOUNT_ACTIVATION,
                        'time' => time(),
                        'var' => 1
                    ]);
                }
                break;

            default:
                $query = DB::queryRow($querybasic . (($var !== null) ? ' AND var=' . $var : ''));

                if ($query !== false) {
                    DB::update('iplog', 'id=' . $query['id'], ['time' => time()]);
                } else {
                    DB::insert('iplog', [
                        'ip' => Core::getClientIp(),
                        'type' => $type,
                        'time' => time(),
                        'var' => $var
                    ]);
                }
                break;
        }
    }
}