rating.php

<?php
namespace Bitrix\Sender\Integration\Bitrix24\Limitation;
 
use Bitrix\Main\Config;
use Bitrix\Main\Type\Date;
use Bitrix\Main\Localization\Loc;
 
use Bitrix\Sender\Message;
use Bitrix\Sender\Dispatch\Semantics;
use Bitrix\Sender\Entity\Letter;
use Bitrix\Sender\Integration\Im\Notification;
use Bitrix\Sender\Internals\Model;
 
Loc::loadMessages(__FILE__);
 
class Rating
{
    protected static $base = 1000;
 
    public static function regulate()
    {
        $ratio = self::getRatio();
        if ($ratio >= self::getBlockRate())
        {
            self::block();
        }
    }
 
    public static function calculate()
    {
        $updateTimestamp = (int) self::getParam('date_update', 0);
        $dateToday = new Date();
        if ($dateToday->getTimestamp() <= $updateTimestamp)
        {
            return;
        }
        self::setParam('date_update', $dateToday->getTimestamp());
        if (!$updateTimestamp)
        {
            return;
        }
 
 
        $yesterdayData = Model\DailyCounterTable::getRowByDate(1);
        if (!$yesterdayData)
        {
            return;
        }
 
        // don't upgrade if error count more than 10% of sent
        $countSent = (int) $yesterdayData['SENT_CNT'];
        $countError = (int) $yesterdayData['ERROR_CNT'];
        if ($countSent > 0 && ($countError / $countSent) > 0.1)
        {
            $countSent -= $countError;
        }
 
        $ratio = self::getRatio(1);
        if ($ratio >= self::getBlockRate())
        {
            self::block();
        }
        elseif ($ratio >= self::getDownRate())
        {
            self::downgrade();
        }
        elseif ($countSent >= DailyLimit::instance()->getLimit())
        {
            self::upgrade();
        }
    }
 
    public static function upgrade()
    {
        $limit = DailyLimit::instance()->getLimit();
        $limit = $limit ?: self::getInitialLimit();
        $limit = $limit * self::getLimitMultiplier();
        if ($limit > self::getMaxLimit())
        {
            return;
        }
 
        DailyLimit::instance()->setLimit($limit);
 
        Notification::create()
            ->withMessage(self::getNotifyText('upgraded'))
            ->toAllAuthors()
            ->send();
    }
 
    public static function downgrade($isNotify = true)
    {
        DailyLimit::instance()->setLimit(self::getInitialLimit());
 
        if ($isNotify)
        {
            Notification::create()
                ->withMessage(self::getNotifyText('downgraded'))
                ->toAllAuthors()
                ->send();
        }
    }
 
    public static function block()
    {
        $letters = Model\LetterTable::getList(array(
            'select' => array('ID'),
            'filter' => array(
                '=STATUS' => Semantics::getWorkStates(),
                '=MESSAGE_CODE' => Message\iBase::CODE_MAIL
            )
        ));
 
        $letter = new Letter();
        foreach ($letters as $letterData)
        {
            $letter->load($letterData['ID']);
            if (!$letter->getId())
            {
                continue;
            }
 
            $state = $letter->getState();
            if ($state->canPause())
            {
                $state->pause();
            }
            else if ($state->canReady())
            {
                $state->ready();
            }
            else if ($state->canStop())
            {
                $state->stop();
            }
        }
 
        self::downgrade(false);
        self::setParam('blocked', 'Y');
 
        Notification::create()
            ->withMessage(self::getNotifyText('blocked'))
            ->toAllAuthors()
            ->send();
    }
 
    public static function isBlocked()
    {
        return self::getParam('blocked', 'N') === 'Y';
    }
 
    public static function getDownRate()
    {
        return round(self::getParam('down_over_abuses', 8) / self::$base, 3);
    }
 
    public static function getBlockRate()
    {
        $abusesPer1000Mails = self::getParam('block_over_abuses', 20);
        return round($abusesPer1000Mails / self::$base, 3);
    }
 
    public static function getInitialLimit()
    {
        return (int) self::getParam('initial', 1000);
    }
 
    public static function getMaxLimit()
    {
        return (int) self::getParam('max', 16000);
    }
 
    public static function getLimitMultiplier()
    {
        return (float) self::getParam('multiplier', 2);
    }
 
    protected static function getRatio($daysLeft = 0)
    {
        $result = Model\DailyCounterTable::getRowByDate($daysLeft);
        $sentCount = $result ? (int) $result['SENT_CNT'] - (int) $result['ERROR_CNT'] : 0;
        $abuseCount = $result ? $result['ABUSE_CNT'] : 0;
        if (!$sentCount || $sentCount < 200 || !$abuseCount)
        {
            return 0;
        }
 
        return round($abuseCount / $sentCount, 3);
    }
 
    protected static function getParam($name, $defaultValue = 0)
    {
        return Config\Option::get('sender', "~r_limit_$name", $defaultValue);
    }
 
    protected static function setParam($name, $value)
    {
        Config\Option::set('sender', "~r_limit_$name", $value);
    }
 
    public static function getNotifyText($code)
    {
        $code = mb_strtoupper($code);
        return Loc::getMessage("SENDER_INTEGRATION_BITRIX24_RATING_{$code}1");
    }
}