1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-11 17:59:37 +01:00
MadelineProto/src/EventHandler.php

484 lines
17 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 AssertionError;
use danog\Loop\PeriodicLoop;
use danog\MadelineProto\Db\DbPropertiesTrait;
use danog\MadelineProto\EventHandler\Attributes\Cron;
2023-07-10 10:12:46 +02:00
use danog\MadelineProto\EventHandler\Attributes\Handler;
2023-07-07 22:19:34 +02:00
use danog\MadelineProto\EventHandler\Filter\Combinator\FiltersAnd;
2023-07-06 22:09:09 +02:00
use danog\MadelineProto\EventHandler\Filter\Filter;
2023-07-10 10:12:46 +02:00
use danog\MadelineProto\EventHandler\Filter\FilterAllowAll;
2023-07-08 15:45:14 +02:00
use danog\MadelineProto\EventHandler\Update;
use Generator;
use PhpParser\Node\Name;
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;
use function Amp\File\isDirectory;
use function Amp\File\isFile;
use function Amp\File\listFiles;
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;
}
protected function getDbPrefix(): string
{
return $this->wrapper->getAPI()->getDbPrefix();
}
private static bool $includingPlugins = false;
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.
*
2023-09-06 21:12:19 +02:00
* @param string $session Session name
* @param ?SettingsAbstract $settings Settings
2021-12-09 13:25:14 +01:00
*/
final public static function startAndLoop(string $session, ?SettingsAbstract $settings = null): void
2021-12-09 13:25:14 +01:00
{
if (self::$includingPlugins) {
2023-07-13 15:25:13 +02:00
return;
}
2023-07-13 16:16:39 +02:00
self::cachePlugins(static::class);
$settings ??= new SettingsEmpty;
2021-12-09 13:25:14 +01:00
$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.
*
2023-09-06 21:12:19 +02:00
* @param string $session Session name
* @param string $token Bot token
* @param ?SettingsAbstract $settings Settings
2022-08-29 16:46:50 +02:00
*/
final public static function startAndLoopBot(string $session, string $token, ?SettingsAbstract $settings = null): void
2022-08-29 16:46:50 +02:00
{
if (self::$includingPlugins) {
2023-07-13 15:25:13 +02:00
return;
}
2023-07-13 16:16:39 +02:00
self::cachePlugins(static::class);
$settings ??= new SettingsEmpty;
2022-08-29 16:46:50 +02:00
$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;
/**
* @var array<PeriodicLoop>
*/
private array $periodicLoops = [];
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-09-05 15:11:10 +02:00
if ($this->startedInternal) {
return null;
}
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($this->getReportPeers());
2023-06-25 19:52:00 +02:00
}
2023-10-01 20:05:04 +02:00
if (method_exists($this, 'onStart')) {
try {
$r = $this->onStart();
if ($r instanceof Generator) {
throw new AssertionError("Yield cannot be used in onStart!");
}
} catch (\Throwable $e) {
$this->wrapper->getAPI()->rethrowInner($e, true);
}
}
2023-06-25 19:52:00 +02:00
if ($main) {
$this->setReportPeers($this->getReportPeers());
2023-06-25 19:52:00 +02:00
}
2023-07-14 17:41:32 +02:00
if ($this instanceof PluginEventHandler && !$this->isPluginEnabled()) {
return [[], []];
}
2023-06-25 19:52:00 +02:00
$constructors = $this->getTL()->getConstructors();
$methods = [];
2023-07-08 15:45:14 +02:00
$handlers = [];
2023-06-25 19:52:00 +02:00
$has_any = false;
foreach ((new ReflectionClass($this))->getMethods(ReflectionMethod::IS_PUBLIC) as $methodRefl) {
$method = $methodRefl->getName();
if ($method === 'onAny') {
$has_any = true;
continue;
}
2023-07-08 21:42:18 +02:00
$closure = $this->$method(...);
2023-10-01 20:05:04 +02:00
$method_name = lcfirst(substr($method, 2));
if ((
($constructor = $constructors->findByPredicate($method_name)) && $constructor['type'] === 'Update'
)
|| $method_name === 'updateBroadcastProgress'
|| $method_name === 'updateNewOutgoingEncryptedMessage'
) {
2023-07-08 21:42:18 +02:00
$methods[$method_name] = [
$closure,
2023-07-08 21:42:18 +02:00
];
2023-07-06 22:09:09 +02:00
continue;
2023-07-07 22:19:34 +02:00
}
2023-07-23 13:26:00 +02:00
2023-11-11 16:55:29 +01:00
array_map(static fn (ReflectionAttribute $attribute) => $attribute->newInstance(), $methodRefl->getAttributes());
2023-07-23 13:26:00 +02:00
if ($periodic = $methodRefl->getAttributes(Cron::class)) {
2023-08-15 23:21:51 +02:00
if (!$this instanceof SimpleEventHandler) {
2023-08-15 21:18:10 +02:00
throw new AssertionError("Please extend SimpleEventHandler to use crons!");
}
$periodic = $periodic[0]->newInstance();
$this->periodicLoops[$method] = new PeriodicLoop(
2023-11-11 16:55:29 +01:00
static fn (PeriodicLoop $loop): bool => $closure($loop) ?? false,
$method,
$periodic->period
);
$this->periodicLoops[$method]->start();
continue;
}
2023-07-06 22:09:09 +02:00
$filter = $methodRefl->getAttributes(
Filter::class,
ReflectionAttribute::IS_INSTANCEOF
)[0] ?? null;
if (!$filter) {
2023-07-10 10:12:46 +02:00
if (!($handler = $methodRefl->getAttributes(Handler::class))) {
continue;
}
$filter = new FilterAllowAll;
} else {
$filter = $filter->newInstance();
2023-06-25 19:52:00 +02:00
}
2023-07-07 22:19:34 +02:00
$filter = new FiltersAnd(
2023-07-10 10:12:46 +02:00
$filter,
2023-07-07 22:19:34 +02:00
Filter::fromReflectionType($methodRefl->getParameters()[0]->getType())
);
2023-08-05 21:26:58 +02:00
$filter = $filter->initialize($this);
2023-08-15 23:21:51 +02:00
if (!$this instanceof SimpleEventHandler) {
2023-08-15 21:18:10 +02:00
throw new AssertionError("Please extend SimpleEventHandler to use filters!");
}
2023-08-27 10:46:42 +02:00
$handlers []= static function (Update $update) use ($closure, $filter): void {
if ($filter->apply($update)) {
$closure($update);
}
2023-07-08 21:42:18 +02:00
};
2023-07-10 20:05:46 +02:00
}
if ($this instanceof SimpleEventHandler) {
2023-07-16 14:12:23 +02:00
$last = null;
foreach (Tools::validateEventHandlerClass(static::class) as $issue) {
if ($issue->severe) {
$last = $issue;
}
$issue->log();
}
if ($last) {
$last->throw();
}
2023-06-25 19:52:00 +02:00
}
if ($has_any) {
2023-08-05 20:53:57 +02:00
/** @psalm-suppress UndefinedMethod */
$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-08 21:42:18 +02:00
$methods[$constructor['predicate']] = [$onAny];
2023-06-25 19:52:00 +02:00
}
}
}
2023-07-13 16:16:39 +02:00
$plugins = self::$pluginCache[static::class];
foreach ($plugins as $class) {
2023-06-25 19:52:00 +02:00
$plugin = $pluginsPrev[$class] ?? $pluginsNew[$class] ?? new $class;
$pluginsNew[$class] = $plugin;
2023-07-08 21:42:18 +02:00
[$newMethods, $newHandlers] = $plugin->internalStart($MadelineProto, $pluginsPrev, $pluginsNew, false) ?? [];
if (!$plugin->isPluginEnabled()) {
2023-07-14 17:41:32 +02:00
unset($pluginsNew[$class]);
continue;
}
2023-07-08 21:42:18 +02:00
foreach ($newMethods as $update => $method) {
2023-10-01 20:05:04 +02:00
$methods[$update] = array_merge($method, $methods[$update] ?? []);
2023-06-25 19:52:00 +02:00
}
2023-10-01 20:05:04 +02:00
$handlers = array_merge($handlers, $newHandlers);
2023-06-25 19:52:00 +02:00
}
$this->startedInternal = true;
2023-07-08 21:42:18 +02:00
return [$methods, $handlers];
} finally {
2023-01-28 20:08:56 +01:00
$this->startDeferred = null;
2023-01-22 20:03:51 +01:00
$startDeferred->complete();
EventLoop::queue($lock->release(...));
2020-10-06 17:33:18 +02:00
}
}
/**
2023-07-14 18:29:20 +02:00
* Obtain a PeriodicLoop instance created by the Cron attribute.
*
* @param string $name Method name
*/
final public function getPeriodicLoop(string $name): PeriodicLoop
{
return $this->periodicLoops[$name];
}
2023-07-18 15:44:09 +02:00
/**
* Obtain all PeriodicLoop instances created by the Cron attribute.
*
* @return array<string, PeriodicLoop>
*/
final public function getPeriodicLoops(): array
{
return $this->periodicLoops;
}
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 path or a list of paths that will be recursively searched for plugins.
2023-07-08 22:24:31 +02:00
*
2023-07-09 16:36:30 +02:00
* Plugin filenames end with Plugin.php, and will be included automatically.
*
* @return non-empty-string|non-empty-list<non-empty-string>|null
*/
public static function getPluginPaths(): string|array|null
2023-07-08 22:24:31 +02:00
{
return null;
}
/**
* Obtain a list of plugin event handlers to use, in addition with those found by getPluginPath.
2023-06-25 19:52:00 +02:00
*
* @return array<class-string<EventHandler>>
*/
public static function getPlugins(): array
2023-06-25 19:52:00 +02:00
{
return [];
}
2023-07-13 16:16:39 +02:00
/** @var array<class-string<EventHandler>, list<class-string<PluginEventHandler>>> */
private static array $pluginCache = [];
/**
2023-07-13 16:16:39 +02:00
* Cache a list of plugin event handlers.
*
2023-07-16 22:26:23 +02:00
* @internal
*
2023-07-13 16:16:39 +02:00
* @param class-string<EventHandler> $class
*/
2023-07-16 22:26:23 +02:00
final public static function cachePlugins(string $class): void
2023-07-08 22:24:31 +02:00
{
2023-07-13 16:16:39 +02:00
if (isset(self::$pluginCache[$class])) {
return;
}
$plugins = $class::getPlugins();
2023-10-01 20:05:04 +02:00
$plugins = array_values(array_unique($plugins, SORT_REGULAR));
$plugins = array_merge($plugins, self::internalGetDirectoryPlugins($class));
foreach ($plugins as $plugin) {
Assert::classExists($plugin);
2023-10-01 20:05:04 +02:00
Assert::true(is_subclass_of($plugin, PluginEventHandler::class), "$plugin must extend ".PluginEventHandler::class);
Assert::notEq($plugin, PluginEventHandler::class);
2023-10-01 20:05:04 +02:00
Assert::true(str_contains(ltrim($plugin, '\\'), '\\'), "$plugin must be in a namespace!");
2023-07-16 14:12:23 +02:00
$last = null;
foreach (Tools::validateEventHandlerClass($plugin) as $issue) {
if ($issue->severe) {
$last = $issue;
}
$issue->log();
}
if ($last) {
$last->throw();
}
}
2023-07-13 16:16:39 +02:00
self::$pluginCache[$class] = $plugins;
2023-10-26 20:19:37 +02:00
foreach ($plugins as $plugin) {
self::cachePlugins($plugin);
}
}
2023-07-10 21:22:13 +02:00
private static array $checkedPaths = [];
2023-07-13 16:16:39 +02:00
/**
* Cache a list of plugin event handlers.
*
* @param class-string<EventHandler> $class
*/
private static function internalGetDirectoryPlugins(string $class): array
{
2023-10-01 20:05:04 +02:00
if (is_subclass_of($class, PluginEventHandler::class)) {
2023-07-10 21:25:55 +02:00
return [];
}
2023-07-13 16:16:39 +02:00
$paths = $class::getPluginPaths();
2023-07-08 22:24:31 +02:00
if (\is_string($paths)) {
$paths = [$paths];
} elseif ($paths === null) {
$paths = [];
2023-07-10 21:22:13 +02:00
} else {
2023-10-01 20:05:04 +02:00
$paths = array_values($paths);
}
foreach ($paths as $k => &$path) {
2023-10-01 20:05:04 +02:00
$pathNew = realpath($path);
2023-07-13 15:25:13 +02:00
if ($pathNew === false) {
2023-10-01 20:05:04 +02:00
$pathNew = realpath(\dirname((new ReflectionClass($class))->getFileName()).DIRECTORY_SEPARATOR.$path);
2023-07-13 15:25:13 +02:00
if ($pathNew === false) {
unset($paths[$k]);
2023-10-01 20:05:04 +02:00
Logger::log(sprintf(Lang::$current_lang['plugin_path_does_not_exist'], $path), Logger::FATAL_ERROR);
continue;
2023-07-13 15:25:13 +02:00
}
}
$path = $pathNew;
}
2023-07-10 21:22:13 +02:00
if (!$paths) {
2023-07-10 21:25:55 +02:00
return [];
}
2023-07-10 21:25:55 +02:00
$pluginsTemp = [];
$recurse = static function (string $path, string $namespace = 'MadelinePlugin') use (&$recurse, &$pluginsTemp): void {
foreach (listFiles($path) as $file) {
2023-07-13 15:25:13 +02:00
$file = $path.DIRECTORY_SEPARATOR.$file;
if (isDirectory($file)) {
2023-10-01 20:05:04 +02:00
$recurse($file, $namespace.'\\'.basename($file));
} elseif (isFile($file) && str_ends_with($file, ".php")) {
$file = realpath($file);
$fileName = basename($file, '.php');
2023-07-18 16:11:27 +02:00
if ($fileName === 'functions') {
2023-07-09 16:39:43 +02:00
require $file;
2023-07-09 16:36:30 +02:00
continue;
}
2023-10-01 20:05:04 +02:00
if (str_contains($fileName, '.')) {
2023-07-18 16:11:27 +02:00
continue;
}
2023-07-13 15:25:13 +02:00
$class = $namespace.'\\'.$fileName;
2023-07-27 13:20:30 +02:00
$refl = new ReflectionClass($class);
if ($refl->getFileName() !== $file) {
2023-07-13 15:25:13 +02:00
throw new AssertionError("$class was not defined when including $file, the same plugin is present in multiple plugin paths/composer!");
}
2023-10-01 20:05:04 +02:00
if (class_exists($class)
2023-07-27 13:20:30 +02:00
&& !$refl->isAbstract()
2023-10-01 20:05:04 +02:00
&& is_subclass_of($class, PluginEventHandler::class)
2023-07-27 13:20:30 +02:00
) {
2023-07-13 16:16:39 +02:00
self::cachePlugins($class);
2023-07-13 15:25:13 +02:00
$pluginsTemp []= $class;
}
}
}
};
2023-07-10 21:25:55 +02:00
$plugins = [];
try {
2023-07-08 22:24:31 +02:00
self::$includingPlugins = true;
2023-08-05 21:26:58 +02:00
foreach ($paths as $p) {
if (isset(self::$checkedPaths[$p])) {
2023-10-01 20:05:04 +02:00
$plugins = array_merge($plugins, self::$checkedPaths[$p]);
2023-07-10 21:25:55 +02:00
continue;
}
2023-07-10 21:25:55 +02:00
2023-10-01 20:05:04 +02:00
spl_autoload_register(static function (string $class) use ($p): void {
if (!str_starts_with($class, 'MadelinePlugin\\')) {
2023-07-10 21:25:55 +02:00
return;
}
// Has leading /
2023-10-01 20:05:04 +02:00
$file = $p.str_replace('\\', DIRECTORY_SEPARATOR, substr($class, 14)).'.php';
if (file_exists($file)) {
2023-07-14 17:41:32 +02:00
require $file;
2023-10-01 20:05:04 +02:00
if (!class_exists($class) && !interface_exists($class) && !trait_exists($class) && !enum_exists($class)) {
throw new AssertionError("$class was not defined when including $file!");
}
2023-07-10 21:25:55 +02:00
}
});
2023-07-11 19:43:31 +02:00
2023-08-05 21:26:58 +02:00
$recurse($p);
self::$checkedPaths[$p] = $pluginsTemp;
2023-10-01 20:05:04 +02:00
$plugins = array_merge($plugins, $pluginsTemp);
2023-07-11 19:43:31 +02:00
$pluginsTemp = [];
}
2023-07-10 21:25:55 +02:00
} finally {
self::$includingPlugins = false;
}
2023-07-10 21:22:13 +02:00
2023-07-10 21:25:55 +02:00
return $plugins;
}
2023-10-01 20:20:24 +02:00
public function __destruct()
{
2023-10-01 21:12:25 +02:00
if (method_exists($this, 'onStop')) {
try {
$this->onStop();
} catch (\Throwable $e) {
$this->wrapper->getAPI()->rethrowInner($e);
}
2023-10-01 20:20:24 +02:00
}
}
}