ConsoleCommandSender is no longer responsible for forwarding broadcast messages to the logger (#5311)

This is a step towards implementing #2543.
This commit is contained in:
Dylan T 2022-09-27 20:58:33 +01:00 committed by GitHub
parent a7dfa0907c
commit 83e5b0adb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 86 additions and 5 deletions

View File

@ -93,6 +93,7 @@ use pocketmine\timings\Timings;
use pocketmine\timings\TimingsHandler;
use pocketmine\updater\UpdateChecker;
use pocketmine\utils\AssumptionFailedError;
use pocketmine\utils\BroadcastLoggerForwarder;
use pocketmine\utils\Config;
use pocketmine\utils\Filesystem;
use pocketmine\utils\Internet;
@ -1044,11 +1045,11 @@ class Server{
$this->logger->info($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_donate(TextFormat::AQUA . "https://patreon.com/pocketminemp" . TextFormat::RESET)));
$this->logger->info($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_startFinished(strval(round(microtime(true) - $this->startTime, 3)))));
//TODO: move console parts to a separate component
$consoleSender = new ConsoleCommandSender($this, $this->language);
$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_ADMINISTRATIVE, $consoleSender);
$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_USERS, $consoleSender);
$forwarder = new BroadcastLoggerForwarder($this, $this->logger, $this->language);
$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_ADMINISTRATIVE, $forwarder);
$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_USERS, $forwarder);
//TODO: move console parts to a separate component
if($this->configGroup->getPropertyBool("console.enable-input", true)){
$this->console = new ConsoleReaderChildProcessDaemon($this->logger);
}

View File

@ -34,6 +34,7 @@ use pocketmine\permission\PermissionManager;
use pocketmine\Server;
use pocketmine\timings\Timings;
use pocketmine\timings\TimingsHandler;
use pocketmine\utils\BroadcastLoggerForwarder;
use pocketmine\utils\TextFormat;
use function explode;
use function str_replace;
@ -232,7 +233,7 @@ abstract class Command{
}
foreach($users as $user){
if($user instanceof ConsoleCommandSender){
if($user instanceof BroadcastLoggerForwarder){
$user->sendMessage($result);
}elseif($user !== $source){
$user->sendMessage($colored);

View File

@ -0,0 +1,79 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\utils;
use pocketmine\command\CommandSender;
use pocketmine\lang\Language;
use pocketmine\lang\Translatable;
use pocketmine\permission\PermissibleBase;
use pocketmine\permission\PermissibleDelegateTrait;
use pocketmine\Server;
/**
* Forwards any messages it receives via sendMessage() to the given logger. Used for forwarding chat messages and
* command audit log messages to the server log file.
*
* Unfortunately, broadcast subscribers are currently required to implement CommandSender, so this class has to include
* a lot of useless methods.
*/
final class BroadcastLoggerForwarder implements CommandSender{
use PermissibleDelegateTrait;
public function __construct(
private Server $server, //annoying useless dependency
private \Logger $logger,
private Language $language
){
//this doesn't need any permissions
$this->perm = new PermissibleBase([]);
}
public function getLanguage() : Language{
return $this->language;
}
public function sendMessage(Translatable|string $message) : void{
if($message instanceof Translatable){
$this->logger->info($this->language->translate($message));
}else{
$this->logger->info($message);
}
}
public function getServer() : Server{
return $this->server;
}
public function getName() : string{
return "Broadcast Logger Forwarder";
}
public function getScreenLineHeight() : int{
return PHP_INT_MAX;
}
public function setScreenLineHeight(?int $height) : void{
//NOOP
}
}