1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-02 23:47:48 +01:00
MadelineProto/src/EventHandler.php

213 lines
7.6 KiB
PHP
Raw Normal View History

2022-12-30 21:54:44 +01:00
<?php
declare(strict_types=1);
Merge alpha into master (async, huge bugfixes and more) (#546) * Implement async and lots of bugfixes * Implement more async * Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr * Apply fixes from StyleCI * Bugfixes * Apply fixes from StyleCI * Bugfixes, implement combined promises * Apply fixes from StyleCI * Support passing method arguments as callable * Starting to write async upload logic * Apply fixes from StyleCI * Start implementing async file upload * Apply fixes from StyleCI * bugfix * Apply fixes from StyleCI * Start rewriting connection module * Add PHP file docblocks for all classes * Start working on new async stream API * Finish writing stream API * More stream API fixes * Apply fixes from StyleCI * Rewrite DataCenter and Connection modules * Clean up stream API documentation * Fixes * Apply fixes from StyleCI * Add referenced parameter to get length of buffer to read in getReadBuffer API * Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar * Start fixing reads * Fix all protocol stream wrappers * Apply fixes from StyleCI * Implement disconnection, and remove end function * Working async RPC * Implement async file upload * Bugfix * Method recall bugfixes * Bugfixes * Trait bugfixes * Fix FIFO buffer * Bugfixes and speedtests * Async logging * Implement websocket streams * Implement loop API, signal API, clean closing and start changing layer * Small magna, websocket and HTTP fixes * Clean up loop API * Improved stack traces, 2FA and async * Login fixes * Added instructions for manual verification * Small fixes * More app info improvements * More app info improvements * TL and 2FA fixes * Update to layer 89 * More bugfixes * Implement broken media reporting * Remove debug comments * PHP 7.2 backwards compatibility * Bugfixes * Async key generation * Some simplifications * Transport fixes * Cleanup * async API * Performance fixes * Fixes to async API * Bugfixes * Implement one-time async loop * Authorization and logging fixes * Update to layer 91 * 7to5 fix * Null coalesce conversion * Implement socks5 proxy * Implement HTTP proxy * Fixes to HTTP proxy * MTProxy and socks5 fixes * Disable PHP 5 conversion * Proxies have higher priority * Avoid error handling in vendor * Override composer dependencies * Fix travis build * Final composer fixes * Proxy logic fixes * Fix get_updates update handling * Do not use parallel file driver if not supported * Refactor loader and implement HTTP fixes * Suppress errors in loader * HTTP and authorization fixes * HTTP fixes * Improved peer management * Use HTTP protocol on altervista * Small bugfixes * Minor fixes * Docufix * Docufix * Legacy fixes * Fix message queue * Avoid updating if using MTProxy * Improve logs and examples * Trim final newlines while converting parse mode * Reimplement noResponse flag * Async combined event handler and APIFactory fixes * Actually return config * Case-insensitive methods * Bugfix * Apply fixes from StyleCI (#545) * MTProxy fixes * PHP 5 warning * Improved PHP 5 warning * Use <br> along with newlines in web logs * Update docs
2018-12-26 20:51:14 +01:00
/**
* EventHandler module.
*
* This file is part of MadelineProto.
* MadelineProto is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
* MadelineProto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Affero General Public License for more details.
* You should have received a copy of the GNU General Public License along with MadelineProto.
* If not, see <http://www.gnu.org/licenses/>.
*
* @author Daniil Gentili <daniil@daniil.it>
2023-01-04 12:43:01 +01:00
* @copyright 2016-2023 Daniil Gentili <daniil@daniil.it>
Merge alpha into master (async, huge bugfixes and more) (#546) * Implement async and lots of bugfixes * Implement more async * Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr * Apply fixes from StyleCI * Bugfixes * Apply fixes from StyleCI * Bugfixes, implement combined promises * Apply fixes from StyleCI * Support passing method arguments as callable * Starting to write async upload logic * Apply fixes from StyleCI * Start implementing async file upload * Apply fixes from StyleCI * bugfix * Apply fixes from StyleCI * Start rewriting connection module * Add PHP file docblocks for all classes * Start working on new async stream API * Finish writing stream API * More stream API fixes * Apply fixes from StyleCI * Rewrite DataCenter and Connection modules * Clean up stream API documentation * Fixes * Apply fixes from StyleCI * Add referenced parameter to get length of buffer to read in getReadBuffer API * Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar * Start fixing reads * Fix all protocol stream wrappers * Apply fixes from StyleCI * Implement disconnection, and remove end function * Working async RPC * Implement async file upload * Bugfix * Method recall bugfixes * Bugfixes * Trait bugfixes * Fix FIFO buffer * Bugfixes and speedtests * Async logging * Implement websocket streams * Implement loop API, signal API, clean closing and start changing layer * Small magna, websocket and HTTP fixes * Clean up loop API * Improved stack traces, 2FA and async * Login fixes * Added instructions for manual verification * Small fixes * More app info improvements * More app info improvements * TL and 2FA fixes * Update to layer 89 * More bugfixes * Implement broken media reporting * Remove debug comments * PHP 7.2 backwards compatibility * Bugfixes * Async key generation * Some simplifications * Transport fixes * Cleanup * async API * Performance fixes * Fixes to async API * Bugfixes * Implement one-time async loop * Authorization and logging fixes * Update to layer 91 * 7to5 fix * Null coalesce conversion * Implement socks5 proxy * Implement HTTP proxy * Fixes to HTTP proxy * MTProxy and socks5 fixes * Disable PHP 5 conversion * Proxies have higher priority * Avoid error handling in vendor * Override composer dependencies * Fix travis build * Final composer fixes * Proxy logic fixes * Fix get_updates update handling * Do not use parallel file driver if not supported * Refactor loader and implement HTTP fixes * Suppress errors in loader * HTTP and authorization fixes * HTTP fixes * Improved peer management * Use HTTP protocol on altervista * Small bugfixes * Minor fixes * Docufix * Docufix * Legacy fixes * Fix message queue * Avoid updating if using MTProxy * Improve logs and examples * Trim final newlines while converting parse mode * Reimplement noResponse flag * Async combined event handler and APIFactory fixes * Actually return config * Case-insensitive methods * Bugfix * Apply fixes from StyleCI (#545) * MTProxy fixes * PHP 5 warning * Improved PHP 5 warning * Use <br> along with newlines in web logs * Update docs
2018-12-26 20:51:14 +01:00
* @license https://opensource.org/licenses/AGPL-3.0 AGPLv3
2019-10-31 15:07:35 +01:00
* @link https://docs.madelineproto.xyz MadelineProto documentation
Merge alpha into master (async, huge bugfixes and more) (#546) * Implement async and lots of bugfixes * Implement more async * Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr * Apply fixes from StyleCI * Bugfixes * Apply fixes from StyleCI * Bugfixes, implement combined promises * Apply fixes from StyleCI * Support passing method arguments as callable * Starting to write async upload logic * Apply fixes from StyleCI * Start implementing async file upload * Apply fixes from StyleCI * bugfix * Apply fixes from StyleCI * Start rewriting connection module * Add PHP file docblocks for all classes * Start working on new async stream API * Finish writing stream API * More stream API fixes * Apply fixes from StyleCI * Rewrite DataCenter and Connection modules * Clean up stream API documentation * Fixes * Apply fixes from StyleCI * Add referenced parameter to get length of buffer to read in getReadBuffer API * Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar * Start fixing reads * Fix all protocol stream wrappers * Apply fixes from StyleCI * Implement disconnection, and remove end function * Working async RPC * Implement async file upload * Bugfix * Method recall bugfixes * Bugfixes * Trait bugfixes * Fix FIFO buffer * Bugfixes and speedtests * Async logging * Implement websocket streams * Implement loop API, signal API, clean closing and start changing layer * Small magna, websocket and HTTP fixes * Clean up loop API * Improved stack traces, 2FA and async * Login fixes * Added instructions for manual verification * Small fixes * More app info improvements * More app info improvements * TL and 2FA fixes * Update to layer 89 * More bugfixes * Implement broken media reporting * Remove debug comments * PHP 7.2 backwards compatibility * Bugfixes * Async key generation * Some simplifications * Transport fixes * Cleanup * async API * Performance fixes * Fixes to async API * Bugfixes * Implement one-time async loop * Authorization and logging fixes * Update to layer 91 * 7to5 fix * Null coalesce conversion * Implement socks5 proxy * Implement HTTP proxy * Fixes to HTTP proxy * MTProxy and socks5 fixes * Disable PHP 5 conversion * Proxies have higher priority * Avoid error handling in vendor * Override composer dependencies * Fix travis build * Final composer fixes * Proxy logic fixes * Fix get_updates update handling * Do not use parallel file driver if not supported * Refactor loader and implement HTTP fixes * Suppress errors in loader * HTTP and authorization fixes * HTTP fixes * Improved peer management * Use HTTP protocol on altervista * Small bugfixes * Minor fixes * Docufix * Docufix * Legacy fixes * Fix message queue * Avoid updating if using MTProxy * Improve logs and examples * Trim final newlines while converting parse mode * Reimplement noResponse flag * Async combined event handler and APIFactory fixes * Actually return config * Case-insensitive methods * Bugfix * Apply fixes from StyleCI (#545) * MTProxy fixes * PHP 5 warning * Improved PHP 5 warning * Use <br> along with newlines in web logs * Update docs
2018-12-26 20:51:14 +01:00
*/
namespace danog\MadelineProto;
2023-01-22 20:03:51 +01:00
use Amp\DeferredFuture;
use Amp\Future;
use Amp\Sync\LocalMutex;
use danog\MadelineProto\Db\DbPropertiesTrait;
2023-07-06 22:09:09 +02:00
use danog\MadelineProto\EventHandler\Filter\Filter;
use Generator;
2023-07-06 22:09:09 +02:00
use ReflectionAttribute;
2023-06-25 19:52:00 +02:00
use ReflectionClass;
use ReflectionMethod;
use Revolt\EventLoop;
use Webmozart\Assert\Assert;
2019-10-31 15:06:25 +01:00
/**
2019-10-31 20:48:06 +01:00
* Event handler.
2019-10-31 15:06:25 +01:00
*/
2023-01-27 14:20:47 +01:00
abstract class EventHandler extends AbstractAPI
{
use DbPropertiesTrait {
DbPropertiesTrait::initDb as private internalInitDb;
}
2021-12-09 13:25:14 +01:00
/**
* Start MadelineProto and the event handler.
2021-12-09 13:25:14 +01:00
*
* Also initializes error reporting, catching and reporting all errors surfacing from the event loop.
*
* @param string $session Session name
* @param SettingsAbstract $settings Settings
*/
final public static function startAndLoop(string $session, SettingsAbstract $settings): void
{
$API = new API($session, $settings);
2023-01-26 19:57:50 +01:00
$API->startAndLoopInternal(static::class);
2021-12-09 13:25:14 +01:00
}
2022-08-29 16:46:50 +02:00
/**
* Start MadelineProto as a bot and the event handler.
2022-08-29 16:46:50 +02:00
*
* Also initializes error reporting, catching and reporting all errors surfacing from the event loop.
*
* @param string $session Session name
* @param string $token Bot token
* @param SettingsAbstract $settings Settings
*/
final public static function startAndLoopBot(string $session, string $token, SettingsAbstract $settings): void
{
$API = new API($session, $settings);
$API->botLogin($token);
2023-01-26 19:57:50 +01:00
$API->startAndLoopInternal(static::class);
2022-08-29 16:46:50 +02:00
}
2023-06-25 19:52:00 +02:00
/** @internal */
final protected function reconnectFull(): bool
2023-01-27 14:20:47 +01:00
{
return true;
}
2023-01-28 20:08:56 +01:00
/**
* Whether the event handler was started.
*/
private bool $startedInternal = false;
private ?LocalMutex $startMutex = null;
private ?DeferredFuture $startDeferred = null;
2020-10-06 17:33:18 +02:00
/**
* Start method handler.
*
* @internal
*/
2023-06-25 19:52:00 +02:00
final public function internalStart(APIWrapper $MadelineProto, array $pluginsPrev, array &$pluginsNew, bool $main = true): ?array
2020-10-06 17:33:18 +02:00
{
2023-06-25 20:00:41 +02:00
if ($this->startedInternal) {
return null;
}
$this->startMutex ??= new LocalMutex;
2023-01-28 20:08:56 +01:00
$this->startDeferred ??= new DeferredFuture;
$startDeferred = $this->startDeferred;
$lock = $this->startMutex->acquire();
try {
2023-06-25 19:52:00 +02:00
$this->wrapper = $MadelineProto;
$this->exportNamespaces();
if (isset(static::$dbProperties)) {
2023-01-26 14:33:30 +01:00
$this->internalInitDb($this->wrapper->getAPI());
}
2023-06-25 19:52:00 +02:00
if ($main) {
$this->setReportPeers(Tools::call($this->getReportPeers())->await());
}
if (\method_exists($this, 'onStart')) {
$r = $this->onStart();
if ($r instanceof Generator) {
$r = Tools::consumeGenerator($r);
}
if ($r instanceof Future) {
$r = $r->await();
}
}
2023-06-25 19:52:00 +02:00
if ($main) {
$this->setReportPeers(Tools::call($this->getReportPeers())->await());
}
$constructors = $this->getTL()->getConstructors();
$methods = [];
$has_any = false;
foreach ((new ReflectionClass($this))->getMethods(ReflectionMethod::IS_PUBLIC) as $methodRefl) {
$method = $methodRefl->getName();
if ($method === 'onAny') {
$has_any = true;
continue;
}
$method_name = \lcfirst(\substr($method, 2));
if (($constructor = $constructors->findByPredicate($method_name)) && $constructor['type'] === 'Update') {
$methods[$method_name] = $this->$method(...);
2023-07-06 22:09:09 +02:00
continue;
2023-07-07 16:56:03 +02:00
}/*
2023-07-06 22:09:09 +02:00
$filter = $methodRefl->getAttributes(
Filter::class,
ReflectionAttribute::IS_INSTANCEOF
)[0] ?? null;
if (!$filter) {
return $filter;
2023-06-25 19:52:00 +02:00
}
2023-07-06 22:09:09 +02:00
$filter = $filter->newInstance();
2023-07-07 16:56:03 +02:00
//$filter->initialize($this);*/
2023-06-25 19:52:00 +02:00
}
if ($has_any) {
2023-07-06 21:59:36 +02:00
$onAny = $this->onAny(...);
2023-06-25 19:52:00 +02:00
foreach ($constructors->by_id as $constructor) {
if ($constructor['type'] === 'Update' && !isset($methods[$constructor['predicate']])) {
2023-07-06 21:59:36 +02:00
$methods[$constructor['predicate']] = $onAny;
2023-06-25 19:52:00 +02:00
}
}
}
$plugins = \array_values(\array_unique($this->getPlugins()));
Assert::allSubclassOf($plugins, self::class);
foreach ($plugins as $class => $_) {
$plugin = $pluginsPrev[$class] ?? $pluginsNew[$class] ?? new $class;
$pluginsNew[$class] = $plugin;
foreach ($plugin->internalStart($MadelineProto, $pluginsPrev, $pluginsNew, false) ?? [] as $update => $method) {
if (isset($methods[$update])) {
$oldMethod = $methods[$update];
$methods[$update] = function (array $update) use ($oldMethod, $method): void {
EventLoop::queue(function () use ($update, $method): void {
$r = $method($update);
if ($r instanceof Generator) {
Tools::consumeGenerator($r);
}
});
$r = $oldMethod($update);
if ($r instanceof Generator) {
Tools::consumeGenerator($r);
}
};
}
}
}
$this->startedInternal = true;
2023-06-25 19:52:00 +02:00
return $methods;
} finally {
2023-01-28 20:08:56 +01:00
$this->startDeferred = null;
2023-01-22 20:03:51 +01:00
$startDeferred->complete();
$lock->release();
2020-10-06 17:33:18 +02:00
}
}
2023-01-22 20:03:51 +01:00
/**
* @internal
*/
2023-06-25 19:52:00 +02:00
final public function waitForInternalStart(): ?Future
2023-01-22 20:06:34 +01:00
{
2023-01-28 20:08:56 +01:00
if (!$this->startedInternal && !$this->startDeferred) {
$this->startDeferred = new DeferredFuture;
}
return $this->startDeferred?->getFuture();
2023-01-22 20:03:51 +01:00
}
/**
* Get peers where to send error reports.
*
2023-01-04 15:26:06 +01:00
* @return string|int|array<string|int>
*/
2023-01-04 15:26:06 +01:00
public function getReportPeers()
{
return [];
}
2023-06-25 19:52:00 +02:00
/**
* Obtain a list of plugin event handlers.
*
* @return array<class-string<EventHandler>>
*/
public function getPlugins(): array
{
return [];
}
}