raspisms/models/Quota.php

<?php

/*
 * This file is part of RaspiSMS.
 *
 * (c) Pierre-Lin Bonnemaison <plebwebsas@gmail.com>
 *
 * This source file is subject to the GPL-3.0 license that is bundled
 * with this source code in the file LICENSE.
 */

namespace models;

    class Quota extends StandardModel
    {
        /**
         * Return the quota for a user if it exists.
         *
         * @param int $id_user : user id
         *
         * @return array : quota if found, else empty array
         */
        public function get_user_quota(int $id_user)
        {
            return $this->_select_one($this->get_table_name(), ['id_user' => $id_user]);
        }

        /**
         * Get remaining credit for a date
         * if no quota for this user return max int.
         *
         * @param int       $id_user : User id
         * @param \DateTime $at      : date to get credit at
         *
         * @return int : number of remaining credits
         */
        public function get_remaining_credit(int $id_user, \DateTime $at): int
        {
            $query = '
                SELECT (credit + additional - consumed) AS remaining_credit
                FROM quota
                WHERE id_user = :id_user
                AND start_date <= :at
                AND expiration_date > :at';

            $params = [
                'id_user' => $id_user,
                'at' => $at->format('Y-m-d H:i:s'),
            ];

            $result = $this->_run_query($query, $params);

            return $result[0]['remaining_credit'] ?? PHP_INT_MAX;
        }

        /**
         * Get credit usage percent for a date
         * if no quota for this user return 0.
         *
         * @param int       $id_user : User id
         * @param \DateTime $at      : date to get usage percent at
         *
         * @return float : percent of used credits
         */
        public function get_usage_percentage(int $id_user, \DateTime $at): float
        {
            $query = '
                SELECT (consumed / (credit + additional)) AS usage_percentage
                FROM quota
                WHERE id_user = :id_user
                AND start_date <= :at
                AND expiration_date > :at';

            $params = [
                'id_user' => $id_user,
                'at' => $at->format('Y-m-d H:i:s'),
            ];

            $result = $this->_run_query($query, $params);

            return (float) ($result[0]['usage_percentage'] ?? 0);
        }

        /**
         * Consume some credit for a user.
         *
         * @param int $id_user  : User id
         * @param int $quantity : Number of credits to consume
         *
         * @return bool
         */
        public function consume_credit(int $id_user, int $quantity): int
        {
            $query = '
                UPDATE quota
                SET consumed = consumed + :quantity
                WHERE id_user = :id_user';

            $params = [
                'id_user' => $id_user,
                'quantity' => $quantity,
            ];

            return (bool) $this->_run_query($query, $params, \descartes\Model::ROWCOUNT);
        }

        /**
         * Get all quotas we need to send an alert for close limit to users they belongs to
         * do not return quotas when user already had an event QUOTA_LIMIT_CLOSE since quota start_date.
         */
        public function get_quotas_for_limit_close(): array
        {
            $query = '
                SELECT quota.*
                FROM quota
                INNER JOIN setting
                    ON (
                        quota.id_user = setting.id_user
                        AND setting.NAME = :setting_name
                        AND setting.value != 0
                    )
                WHERE
                    quota.consumed / ( quota.credit + quota.additional ) >= setting.value
                    AND (
                        SELECT COUNT(id)
                        FROM event
                        WHERE
                            id_user = quota.id_user
                            AND type = :event_type
                            AND at >= quota.start_date
                    ) = 0;
';

            $params = [
                'setting_name' => 'alert_quota_limit_close',
                'event_type' => 'QUOTA_LIMIT_CLOSE',
            ];

            return $this->_run_query($query, $params);
        }

        /**
         * Get all quotas we need to send an alert for limit reached to users they belongs to
         * do not return quotas when user already had an event QUOTA_LIMIT_REACHED since quota start_date.
         */
        public function get_quotas_for_limit_reached(): array
        {
            $query = '
                SELECT quota.*
                FROM quota
                INNER JOIN setting
                    ON (
                        quota.id_user = setting.id_user
                        AND setting.NAME = :setting_name
                        AND setting.value = 1
                    )
                WHERE
                    quota.consumed >= (quota.credit + quota.additional)
                    AND (
                        SELECT COUNT(id)
                        FROM event
                        WHERE
                            id_user = quota.id_user
                            AND type = :event_type
                            AND at >= quota.start_date
                    ) = 0;
            ';

            $params = [
                'setting_name' => 'alert_quota_limit_reached',
                'event_type' => 'QUOTA_LIMIT_REACHED',
            ];

            return $this->_run_query($query, $params);
        }

        /**
         * Get list of quotas to be renewed as to a date.
         *
         * @param \DateTime $at : Date to get quotas to be renewed before
         */
        public function get_quotas_to_be_renewed(\DateTime $at): array
        {
            $at = $at->format('Y-m-d H:i:s');
            $where = [
                '<=expiration_date' => $at,
                'auto_renew' => true,
            ];

            return $this->_select('quota', $where);
        }

        /**
         * Return table name.
         */
        protected function get_table_name(): string
        {
            return 'quota';
        }
    }