Longman\TelegramBot\Botan

Complexity

Total Complexity

31

Size/Duplication

Total Lines	240
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeBotan()	0	21	3
A	lock()	0	6	2
D	track()	0	84	16
C	shortenUrl()	0	39	7
A	getEventName()	0	14	3

<?php
/**
 * This file is part of the TelegramBot package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\TelegramBot;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Longman\TelegramBot\Entities\Update;
use Longman\TelegramBot\Exception\TelegramException;

/**
 * Class Botan
 *
 * Integration with http://botan.io statistics service for Telegram bots
 */
class Botan
{
    /**
     * Botan.io API URL
     *
     * @var string
     */
    protected static $api_base_uri = 'https://api.botan.io';

    /**
     * Yandex AppMetrica application key
     *
     * @var string
     */
    protected static $token = '';

    /**
     * Guzzle Client object
     *
     * @var \GuzzleHttp\Client
     */
    private static $client;

    /**
     * The actual command that is going to be reported
     *
     *  Set as public to let the developers either:
     *  - block tracking from inside commands by setting the value to non-existent command
     *  - override which command is tracked when commands call other commands with executeCommand()
     *
     * @var string
     */
    public static $command = '';

    /**
     * Initialize Botan
     *
     * @param  string $token
     * @param  array  $options
     *
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public static function initializeBotan($token, array $options = [])
    {
        if (empty($token)) {
            throw new TelegramException('Botan token is empty!');
        }

        $options_default = [
            'timeout' => 3,
        ];

        $options = array_merge($options_default, $options);

        if (!is_numeric($options['timeout'])) {
            throw new TelegramException('Timeout must be a number!');
        }

        self::$token = $token;
        self::$client = new Client(['base_uri' => self::$api_base_uri, 'timeout' => $options['timeout']]);

        BotanDB::initializeBotanDb();
    }

    /**
     * Lock function to make sure only the first command is reported (the one user requested)
     *
     *  This is in case commands are calling other commands with executeCommand()
     *
     * @param string $command
     */
    public static function lock($command = '')
    {
        if (empty(self::$command)) {
            self::$command = strtolower($command);
        }
    }

    /**
     * Track function
     *
     * @param \Longman\TelegramBot\Entities\Update $update
     * @param string                               $command
     *
     * @return bool|string
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public static function track(Update $update, $command = '')
    {
        $command = strtolower($command);

        if (empty(self::$token) || $command !== self::$command) {
            return false;
        }

        if ($update === null) {
            throw new TelegramException('Update object is empty!');
        }

        // Release the lock in case this is getUpdates instance in foreach loop
        self::$command = '';

        $data = [];
        $update_data = (array) $update; // For now, this is the only way
        $update_type = $update->getUpdateType();

        $update_object_names = [
            'message'              => 'Message',
            'edited_message'       => 'Edited Message',
            'channel_post'         => 'Channel Post',
            'edited_channel_post'  => 'Edited Channel Post',
            'inline_query'         => 'Inline Query',
            'chosen_inline_result' => 'Chosen Inline Result',
            'callback_query'       => 'Callback Query',
        ];

        if (array_key_exists($update_type, $update_object_names)) {
            $data = $update_data[$update_type];
            $event_name = $update_object_names[$update_type];

            if ($update_type === 'message' && $entities = $update->getMessage()->getEntities()) {
                foreach ($entities as $entity) {
                    if ($entity->getType() !== 'bot_command' || $entity->getOffset() !== 0) {
                        continue;
                    }
                    $event_name = self::getEventName($command);
                    break;
                }
            }
        }

        if (empty($event_name)) {
            TelegramLog::error('Botan.io stats report failed, no suitable update object found!');

            return false;
        }

        // In case there is no from field assign id = 0
        $uid = isset($data['from']['id']) ? $data['from']['id'] : 0;

        try {
            $response = self::$client->post(
                sprintf(
                    '/track?token=%1$s&uid=%2$s&name=%3$s',
                    self::$token,
                    $uid,
                    urlencode($event_name)
                ),
                [
                    'headers' => [
                        'Content-Type' => 'application/json',
                    ],
                    'json'    => $data,
                ]
            );

            $result = (string) $response->getBody();
        } catch (RequestException $e) {
            $result = $e->getMessage();
        }

        $responseData = json_decode($result, true);

        if (!$responseData || $responseData['status'] !== 'accepted') {
            TelegramLog::debug('Botan.io stats report failed: %s', $result ?: 'empty response');

            return false;
        }

        return $responseData;
    }

    /**
     * Url Shortener function
     *
     * @param string  $url
     * @param integer $user_id
     *
     * @return string
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public static function shortenUrl($url, $user_id)
    {
        if (empty(self::$token)) {
            return $url;
        }

        if (empty($user_id)) {
            throw new TelegramException('User id is empty!');
        }

        if ($cached = BotanDB::selectShortUrl($url, $user_id)) {
            return $cached;
        }

        try {
            $response = self::$client->post(
                sprintf(
                    '/s?token=%1$s&user_ids=%2$s&url=%3$s',
                    self::$token,
                    $user_id,
                    urlencode($url)
                )
            );

            $result = (string) $response->getBody();
        } catch (RequestException $e) {
            $result = $e->getMessage();
        }

        if (filter_var($result, FILTER_VALIDATE_URL) === false) {
            TelegramLog::debug('Botan.io URL shortening failed for "%s": %s', $url, $result ?: 'empty response');

            return $url;
        }

        BotanDB::insertShortUrl($url, $user_id, $result);

        return $result;
    }

    /**
     * @param $command
     * @return string
     */
    private static function getEventName($command)
    {
        if ($command === 'generic') {
            $command = 'Generic';
        } elseif ($command === 'genericmessage') {  // This should not happen as it equals normal message but leaving it as a fail-safe
            $command = 'Generic Message';
        } else {
            $command = '/'.$command;
        }

        $event_name = 'Command ('.$command.')';

        return $event_name;
    }
}