telegram-bot-php / core

src/lib/Telegram.php

Indentation +361 added lines, -361 removed lines

@@ -18,366 +18,366 @@
 class Telegram
 {
 
-	/**
-	 * @var string
-	 */
-	private string $api_key;
-
-	/**
-	 * @var string
-	 */
-	public static string $VERSION = 'v1.0.0';
-
-	/**
-	 * Telegram constructor.
-	 *
-	 * @param string $api_key
-	 */
-	public function __construct(string $api_key = '')
-	{
-		if ($api_key === '') {
-			$env_file = $this->getEnvFilePath();
-			$api_key = DotEnv::load($env_file)->get('TELEGRAM_API_KEY');
-		}
-
-		if (empty($api_key) || !is_string($api_key)) {
-			throw new TelegramException('API Key is required');
-		}
-
-		DotEnv::put('TG_CURRENT_KEY', ($this->api_key = $api_key));
-		DotEnv::put('TELEGRAM_API_KEY', ($this->api_key = $api_key));
-	}
-
-	/**
-	 * Get env file path and return it
-	 *
-	 * @return string
-	 */
-	private function getEnvFilePath(): string
-	{
-		$defaultEnvPaths = [
-			$_SERVER['DOCUMENT_ROOT'] . '/.env',
-			getcwd() . '/../.env',
-			getcwd() . '/.env',
-		];
-
-		foreach ($defaultEnvPaths as $path) {
-			if (file_exists($path)) {
-				return $path;
-			}
-		}
-
-		return '';
-	}
-
-	/**
-	 * Get API key from temporary ENV variable
-	 *
-	 * @return ?string
-	 */
-	public static function getApiKey(): ?string
-	{
-		return DotEnv::get('TG_CURRENT_KEY');
-	}
-
-	/**
-	 * Get bot info from given API key
-	 *
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public function getInfo(): Response
-	{
-		$result = Request::getMe();
-
-		if (!$result->isOk()) {
-			throw new TelegramException($result->getErrorCode() . ': ' . $result->getDescription());
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Set Webhook for bot
-	 *
-	 * @param string $url
-	 * @param array $data Optional parameters.
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public function setWebhook(string $url, array $data = []): Response
-	{
-		if ($url === '') {
-			throw new TelegramException('Hook url is empty!');
-		}
-
-		if (!str_starts_with($url, 'https://')) {
-			throw new TelegramException('Hook url must start with https://');
-		}
-
-		$data = array_intersect_key($data, array_flip([
-			'certificate',
-			'ip_address',
-			'max_connections',
-			'allowed_updates',
-			'drop_pending_updates',
-		]));
-		$data['url'] = $url;
-
-		$result = Request::setWebhook($data);
-
-		if (!$result->isOk()) {
-			throw new TelegramException(
-				'Webhook was not set! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
-			);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Delete any assigned webhook
-	 *
-	 * @param array $data
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public function deleteWebhook(array $data = []): Response
-	{
-		$result = Request::deleteWebhook($data);
-
-		if (!$result->isOk()) {
-			throw new TelegramException(
-				'Webhook was not deleted! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
-			);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * This method sets the admin username. and will be used to send you a message if the bot is not working.
-	 *
-	 * @param int $chat_id
-	 * @return void
-	 */
-	public function setAdmin(int $chat_id): void
-	{
-		defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $chat_id);
-	}
-
-	/**
-	 * Get input from stdin and return it
-	 *
-	 * @return ?string
-	 */
-	public static function getInput(): ?string
-	{
-		return file_get_contents('php://input') ?? null;
-	}
-
-	/**
-	 * This method will convert a string to an update object
-	 *
-	 * @param string $input The input string
-	 * @param string $apiKey The API key
-	 * @return Update|false
-	 */
-	public static function processUpdate(string $input, string $apiKey): Update|false
-	{
-		if (empty($input)) {
-			throw new TelegramException(
-				'Input is empty! Please check your code and try again.'
-			);
-		}
-
-		if (!self::validateToken($apiKey)) {
-			throw new TelegramException(
-				'Invalid token! Please check your code and try again.'
-			);
-		}
-
-		if (self::validateWebData($apiKey, $input)) {
-			if (Common::isUrlEncode($input)) {
-				$web_data = Common::urlDecode($input);
-			}
-
-			if (Common::isJson($input)) {
-				$web_data = json_decode($input, true);
-			}
-
-			$input = json_encode([
-				'web_data' => $web_data,
-			]);
-		}
-
-		if (!Common::isJson($input)) {
-			throw new TelegramException(
-				'Input is not a valid JSON string! Please check your code and try again.'
-			);
-		}
-
-		$input = json_decode($input, true);
-
-		return new Update($input);
-	}
-
-	/**
-	 * Validate webapp data from is from Telegram
-	 *
-	 * @link https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
-	 *
-	 * @param string $token The bot token
-	 * @param string $body The message body from getInput()
-	 * @return bool
-	 */
-	public static function validateWebData(string $token, string $body): bool
-	{
-		if (!Common::isJson($body)) {
-			$raw_data = rawurldecode(str_replace('_auth=', '', $body));
-			$data = Common::urlDecode($raw_data);
-
-			if (empty($data['user'])) {
-				return false;
-			}
-
-			$data['user'] = urldecode($data['user']);
-
-		} else {
-			$data = json_decode($body, true);
-
-			if (empty($data['user'])) {
-				return false;
-			}
-
-			$data['user'] = json_encode($data['user']);
-		}
-
-		$data_check_string = "auth_date={$data['auth_date']}\nquery_id={$data['query_id']}\nuser={$data['user']}";
-		$secret_key = hash_hmac('sha256', $token, "WebAppData", true);
-
-		return hash_hmac('sha256', $data_check_string, $secret_key) == $data['hash'];
-	}
-
-	/**
-	 * Get the update from input
-	 *
-	 * @return Update|false
-	 */
-	public static function getUpdate(): Update|false
-	{
-		$input = self::getInput();
-		if (empty($input)) return false;
-		return Telegram::processUpdate($input, self::getApiKey());
-	}
-
-	/**
-	 * Validate the token
-	 *
-	 * @param string $token (e.g. 123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11) {digit}:{alphanumeric[34]}
-	 * @return bool
-	 */
-	public static function validateToken(string $token): bool
-	{
-		preg_match_all('/([0-9]+:[a-zA-Z0-9-_]+)/', $token, $matches);
-		return count($matches[0]) == 1;
-	}
-
-	/**
-	 * Pass the update to the given webhook handler
-	 *
-	 * @param WebhookHandler $webhook_handler The webhook handler
-	 * @param ?Update $update By default, it will get the update from input
-	 * @return void
-	 */
-	public function fetchWith(WebhookHandler $webhook_handler, ?Update $update = null): void
-	{
-		if (is_subclass_of($webhook_handler, WebhookHandler::class)) {
-			if ($update === null) $update = self::getUpdate();
-			$webhook_handler->resolve($update);
-		}
-	}
-
-	/**
-	 * Get token from env file.
-	 *
-	 * @param string $file
-	 * @return ?string
-	 */
-	protected function getTokenFromEnvFile(string $file): ?string
-	{
-		if (!file_exists($file)) return null;
-		return DotEnv::load($file)::get('TELEGRAM_API_KEY');
-	}
-
-	/**
-	 * Debug mode
-	 *
-	 * @param ?int $admin_id Fill this or use setAdmin()
-	 * @return void
-	 */
-	public static function setDebugMode(?int $admin_id = null): void
-	{
-		error_reporting(E_ALL);
-		ini_set('display_errors', 1);
-
-		defined('DEBUG_MODE') or define('DEBUG_MODE', true);
-		if ($admin_id) {
-			defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $admin_id);
-		}
-
-		set_exception_handler(function ($exception) {
-
-			if (defined('DEBUG_MODE') && DEBUG_MODE) {
-
-				TelegramLog::error(($message = sprintf(
-					"%s(%d): %s\n%s",
-					$exception->getFile(),
-					$exception->getLine(),
-					$exception->getMessage(),
-					$exception->getTraceAsString()
-				)));
-
-				echo '<b>TelegramError:</b> ' . $message;
-
-				if (defined('TG_ADMIN_ID') && TG_ADMIN_ID) {
-					$input = getenv('TG_CURRENT_UPDATE') ?? self::getInput();
-					$update = self::processUpdate($input, self::getApiKey());
-
-					file_put_contents(
-						($file = getcwd() . '/' . uniqid('error_') . '.log'),
-						$message . PHP_EOL . PHP_EOL . $update->getRawData(false)
-					);
-
-					Request::sendMessage([
-						'chat_id' => TG_ADMIN_ID,
-						'text' => $message,
-					]);
-
-					Request::sendDocument([
-						'chat_id' => TG_ADMIN_ID,
-						'document' => $file,
-					]);
-
-					unlink($file);
-				}
-
-			} else {
-				throw $exception;
-			}
-
-		});
-	}
-
-	/**
-	 * Just another echo
-	 *
-	 * @param string $text
-	 * @return void
-	 */
-	public static function echo(string $text): void
-	{
-		echo $text;
-	}
+    /**
+     * @var string
+     */
+    private string $api_key;
+
+    /**
+     * @var string
+     */
+    public static string $VERSION = 'v1.0.0';
+
+    /**
+     * Telegram constructor.
+     *
+     * @param string $api_key
+     */
+    public function __construct(string $api_key = '')
+    {
+        if ($api_key === '') {
+            $env_file = $this->getEnvFilePath();
+            $api_key = DotEnv::load($env_file)->get('TELEGRAM_API_KEY');
+        }
+
+        if (empty($api_key) || !is_string($api_key)) {
+            throw new TelegramException('API Key is required');
+        }
+
+        DotEnv::put('TG_CURRENT_KEY', ($this->api_key = $api_key));
+        DotEnv::put('TELEGRAM_API_KEY', ($this->api_key = $api_key));
+    }
+
+    /**
+     * Get env file path and return it
+     *
+     * @return string
+     */
+    private function getEnvFilePath(): string
+    {
+        $defaultEnvPaths = [
+            $_SERVER['DOCUMENT_ROOT'] . '/.env',
+            getcwd() . '/../.env',
+            getcwd() . '/.env',
+        ];
+
+        foreach ($defaultEnvPaths as $path) {
+            if (file_exists($path)) {
+                return $path;
+            }
+        }
+
+        return '';
+    }
+
+    /**
+     * Get API key from temporary ENV variable
+     *
+     * @return ?string
+     */
+    public static function getApiKey(): ?string
+    {
+        return DotEnv::get('TG_CURRENT_KEY');
+    }
+
+    /**
+     * Get bot info from given API key
+     *
+     * @return Response
+     * @throws TelegramException
+     */
+    public function getInfo(): Response
+    {
+        $result = Request::getMe();
+
+        if (!$result->isOk()) {
+            throw new TelegramException($result->getErrorCode() . ': ' . $result->getDescription());
+        }
+
+        return $result;
+    }
+
+    /**
+     * Set Webhook for bot
+     *
+     * @param string $url
+     * @param array $data Optional parameters.
+     * @return Response
+     * @throws TelegramException
+     */
+    public function setWebhook(string $url, array $data = []): Response
+    {
+        if ($url === '') {
+            throw new TelegramException('Hook url is empty!');
+        }
+
+        if (!str_starts_with($url, 'https://')) {
+            throw new TelegramException('Hook url must start with https://');
+        }
+
+        $data = array_intersect_key($data, array_flip([
+            'certificate',
+            'ip_address',
+            'max_connections',
+            'allowed_updates',
+            'drop_pending_updates',
+        ]));
+        $data['url'] = $url;
+
+        $result = Request::setWebhook($data);
+
+        if (!$result->isOk()) {
+            throw new TelegramException(
+                'Webhook was not set! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
+            );
+        }
+
+        return $result;
+    }
+
+    /**
+     * Delete any assigned webhook
+     *
+     * @param array $data
+     * @return Response
+     * @throws TelegramException
+     */
+    public function deleteWebhook(array $data = []): Response
+    {
+        $result = Request::deleteWebhook($data);
+
+        if (!$result->isOk()) {
+            throw new TelegramException(
+                'Webhook was not deleted! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
+            );
+        }
+
+        return $result;
+    }
+
+    /**
+     * This method sets the admin username. and will be used to send you a message if the bot is not working.
+     *
+     * @param int $chat_id
+     * @return void
+     */
+    public function setAdmin(int $chat_id): void
+    {
+        defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $chat_id);
+    }
+
+    /**
+     * Get input from stdin and return it
+     *
+     * @return ?string
+     */
+    public static function getInput(): ?string
+    {
+        return file_get_contents('php://input') ?? null;
+    }
+
+    /**
+     * This method will convert a string to an update object
+     *
+     * @param string $input The input string
+     * @param string $apiKey The API key
+     * @return Update|false
+     */
+    public static function processUpdate(string $input, string $apiKey): Update|false
+    {
+        if (empty($input)) {
+            throw new TelegramException(
+                'Input is empty! Please check your code and try again.'
+            );
+        }
+
+        if (!self::validateToken($apiKey)) {
+            throw new TelegramException(
+                'Invalid token! Please check your code and try again.'
+            );
+        }
+
+        if (self::validateWebData($apiKey, $input)) {
+            if (Common::isUrlEncode($input)) {
+                $web_data = Common::urlDecode($input);
+            }
+
+            if (Common::isJson($input)) {
+                $web_data = json_decode($input, true);
+            }
+
+            $input = json_encode([
+                'web_data' => $web_data,
+            ]);
+        }
+
+        if (!Common::isJson($input)) {
+            throw new TelegramException(
+                'Input is not a valid JSON string! Please check your code and try again.'
+            );
+        }
+
+        $input = json_decode($input, true);
+
+        return new Update($input);
+    }
+
+    /**
+     * Validate webapp data from is from Telegram
+     *
+     * @link https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
+     *
+     * @param string $token The bot token
+     * @param string $body The message body from getInput()
+     * @return bool
+     */
+    public static function validateWebData(string $token, string $body): bool
+    {
+        if (!Common::isJson($body)) {
+            $raw_data = rawurldecode(str_replace('_auth=', '', $body));
+            $data = Common::urlDecode($raw_data);
+
+            if (empty($data['user'])) {
+                return false;
+            }
+
+            $data['user'] = urldecode($data['user']);
+
+        } else {
+            $data = json_decode($body, true);
+
+            if (empty($data['user'])) {
+                return false;
+            }
+
+            $data['user'] = json_encode($data['user']);
+        }
+
+        $data_check_string = "auth_date={$data['auth_date']}\nquery_id={$data['query_id']}\nuser={$data['user']}";
+        $secret_key = hash_hmac('sha256', $token, "WebAppData", true);
+
+        return hash_hmac('sha256', $data_check_string, $secret_key) == $data['hash'];
+    }
+
+    /**
+     * Get the update from input
+     *
+     * @return Update|false
+     */
+    public static function getUpdate(): Update|false
+    {
+        $input = self::getInput();
+        if (empty($input)) return false;
+        return Telegram::processUpdate($input, self::getApiKey());
+    }
+
+    /**
+     * Validate the token
+     *
+     * @param string $token (e.g. 123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11) {digit}:{alphanumeric[34]}
+     * @return bool
+     */
+    public static function validateToken(string $token): bool
+    {
+        preg_match_all('/([0-9]+:[a-zA-Z0-9-_]+)/', $token, $matches);
+        return count($matches[0]) == 1;
+    }
+
+    /**
+     * Pass the update to the given webhook handler
+     *
+     * @param WebhookHandler $webhook_handler The webhook handler
+     * @param ?Update $update By default, it will get the update from input
+     * @return void
+     */
+    public function fetchWith(WebhookHandler $webhook_handler, ?Update $update = null): void
+    {
+        if (is_subclass_of($webhook_handler, WebhookHandler::class)) {
+            if ($update === null) $update = self::getUpdate();
+            $webhook_handler->resolve($update);
+        }
+    }
+
+    /**
+     * Get token from env file.
+     *
+     * @param string $file
+     * @return ?string
+     */
+    protected function getTokenFromEnvFile(string $file): ?string
+    {
+        if (!file_exists($file)) return null;
+        return DotEnv::load($file)::get('TELEGRAM_API_KEY');
+    }
+
+    /**
+     * Debug mode
+     *
+     * @param ?int $admin_id Fill this or use setAdmin()
+     * @return void
+     */
+    public static function setDebugMode(?int $admin_id = null): void
+    {
+        error_reporting(E_ALL);
+        ini_set('display_errors', 1);
+
+        defined('DEBUG_MODE') or define('DEBUG_MODE', true);
+        if ($admin_id) {
+            defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $admin_id);
+        }
+
+        set_exception_handler(function ($exception) {
+
+            if (defined('DEBUG_MODE') && DEBUG_MODE) {
+
+                TelegramLog::error(($message = sprintf(
+                    "%s(%d): %s\n%s",
+                    $exception->getFile(),
+                    $exception->getLine(),
+                    $exception->getMessage(),
+                    $exception->getTraceAsString()
+                )));
+
+                echo '<b>TelegramError:</b> ' . $message;
+
+                if (defined('TG_ADMIN_ID') && TG_ADMIN_ID) {
+                    $input = getenv('TG_CURRENT_UPDATE') ?? self::getInput();
+                    $update = self::processUpdate($input, self::getApiKey());
+
+                    file_put_contents(
+                        ($file = getcwd() . '/' . uniqid('error_') . '.log'),
+                        $message . PHP_EOL . PHP_EOL . $update->getRawData(false)
+                    );
+
+                    Request::sendMessage([
+                        'chat_id' => TG_ADMIN_ID,
+                        'text' => $message,
+                    ]);
+
+                    Request::sendDocument([
+                        'chat_id' => TG_ADMIN_ID,
+                        'document' => $file,
+                    ]);
+
+                    unlink($file);
+                }
+
+            } else {
+                throw $exception;
+            }
+
+        });
+    }
+
+    /**
+     * Just another echo
+     *
+     * @param string $text
+     * @return void
+     */
+    public static function echo(string $text): void
+    {
+        echo $text;
+    }
 
 }
\ No newline at end of file