Skip to content

Allowing custom command to handle raw command line inputs #6708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
+12 −6
Closed

Allowing custom command to handle raw command line inputs #6708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dc61d16
Added executeRaw() method to Command
NTT1906 May 26, 2025
725b3c6
Calling the correct method
NTT1906 May 26, 2025
138606a
...
NTT1906 May 26, 2025
eee9200
add the missing `use function preg_split`
NTT1906 May 26, 2025
cd4eebe
move `$args` to if
NTT1906 May 26, 2025
3d94abf
move permission back
NTT1906 May 26, 2025
cd8ea60
use `explode` instead of `preg_split`
NTT1906 May 27, 2025
d88d7e8
multiple changes:
NTT1906 May 27, 2025
8648927
change param name from argLine to rawArgs
NTT1906 May 28, 2025
33ad6de
Merge branch 'minor-next' into execute-raw
NTT1906 May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/command/Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
namespace pocketmine\command;

use pocketmine\command\utils\CommandException;
use pocketmine\command\utils\CommandStringHelper;
use pocketmine\lang\KnownTranslationFactory;
use pocketmine\lang\Translatable;
use pocketmine\permission\PermissionManager;
Expand Down Expand Up @@ -80,6 +81,11 @@ public function __construct(string $name, Translatable|string $description = "",
$this->setAliases($aliases);
}

public function executeRaw(CommandSender $sender, string $commandLabel, string $rawArgs) : void{
$args = CommandStringHelper::parseQuoteAware($rawArgs);
$this->execute($sender, $commandLabel, $args);
}

/**
* @param string[] $args
* @phpstan-param list<string> $args
Expand Down
12 changes: 6 additions & 6 deletions src/command/SimpleCommandMap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
use function array_shift;
use function array_values;
use function count;
use function explode;
use function implode;
use function str_contains;
use function strcasecmp;
Expand Down Expand Up @@ -207,16 +208,15 @@ private function registerAlias(Command $command, bool $isAlias, string $fallback
}

public function dispatch(CommandSender $sender, string $commandLine) : bool{
$args = CommandStringHelper::parseQuoteAware($commandLine);

$sentCommandLabel = array_shift($args);
if($sentCommandLabel !== null && ($target = $this->getCommand($sentCommandLabel)) !== null){
$parts = explode(" ", $commandLine, 2);
$sentCommandLabel = $parts[0];
if(($target = $this->getCommand($sentCommandLabel)) !== null){
$timings = Timings::getCommandDispatchTimings($target->getLabel());
$timings->startTiming();

try{
if($target->testPermission($sender)){
$target->execute($sender, $sentCommandLabel, $args);
$target->executeRaw($sender, $sentCommandLabel, trim($parts[1] ?? ""));
}
}catch(InvalidCommandSyntaxException $e){
$sender->sendMessage($sender->getLanguage()->translate(KnownTranslationFactory::commands_generic_usage($target->getUsage())));
Expand All @@ -226,7 +226,7 @@ public function dispatch(CommandSender $sender, string $commandLine) : bool{
return true;
}

$sender->sendMessage(KnownTranslationFactory::pocketmine_command_notFound($sentCommandLabel ?? "", "/help")->prefix(TextFormat::RED));
$sender->sendMessage(KnownTranslationFactory::pocketmine_command_notFound($sentCommandLabel, "/help")->prefix(TextFormat::RED));
return false;
}

Expand Down