Implemented /clear command (#3854)

closes #3854

resources/locale

@@ -1 +1 @@
-Subproject commit 884a0496c3c1099b8ded991cb6708dbe8cbbf53e
+Subproject commit 3d1c70b9f3d7650cef7cac25db27397a5708d22c

src/command/SimpleCommandMap.php

@@ -26,6 +26,7 @@ namespace pocketmine\command;
 use pocketmine\command\defaults\BanCommand;
 use pocketmine\command\defaults\BanIpCommand;
 use pocketmine\command\defaults\BanListCommand;
+use pocketmine\command\defaults\ClearCommand;
 use pocketmine\command\defaults\DefaultGamemodeCommand;
 use pocketmine\command\defaults\DeopCommand;
 use pocketmine\command\defaults\DifficultyCommand;
@@ -95,6 +96,7 @@ class SimpleCommandMap implements CommandMap{
 			new BanCommand("ban"),
 			new BanIpCommand("ban-ip"),
 			new BanListCommand("banlist"),
+			new ClearCommand("clear"),
 			new DefaultGamemodeCommand("defaultgamemode"),
 			new DeopCommand("deop"),
 			new DifficultyCommand("difficulty"),

src/command/defaults/ClearCommand.php

@@ -0,0 +1,173 @@
+<?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\command\defaults;
+
+use InvalidArgumentException;
+use pocketmine\command\Command;
+use pocketmine\command\CommandSender;
+use pocketmine\command\utils\InvalidCommandSyntaxException;
+use pocketmine\item\LegacyStringToItemParser;
+use pocketmine\lang\TranslationContainer;
+use pocketmine\player\Player;
+use pocketmine\utils\TextFormat;
+use function array_merge;
+use function count;
+
+class ClearCommand extends VanillaCommand{
+
+	public function __construct(string $name){
+		parent::__construct(
+			$name,
+			"%pocketmine.command.clear.description",
+			"%pocketmine.command.clear.usage"
+		);
+		$this->setPermission("pocketmine.command.clear.self;pocketmine.command.clear.other");
+	}
+
+	public function execute(CommandSender $sender, string $commandLabel, array $args){
+		if(!$this->testPermission($sender)){
+			return true;
+		}
+
+		if(count($args) > 3){
+			throw new InvalidCommandSyntaxException();
+		}
+
+		$target = null;
+		if(isset($args[0])){
+			$target = $sender->getServer()->getPlayerByPrefix($args[0]);
+			if($target === null){
+				$sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.generic.player.notFound"));
+				return true;
+			}
+			if($target !== $sender && !$sender->hasPermission("pocketmine.command.clear.other")){
+				$sender->sendMessage($sender->getLanguage()->translateString(TextFormat::RED . "%commands.generic.permission"));
+				return true;
+			}
+		}elseif($sender instanceof Player){
+			if(!$sender->hasPermission("pocketmine.command.clear.self")){
+				$sender->sendMessage($sender->getLanguage()->translateString(TextFormat::RED . "%commands.generic.permission"));
+				return true;
+			}
+
+			$target = $sender;
+		}else{
+			throw new InvalidCommandSyntaxException();
+		}
+
+		$item = null;
+		$maxCount = -1;
+		if(isset($args[1])){
+			try{
+				$item = LegacyStringToItemParser::getInstance()->parse($args[1]);
+
+				if(isset($args[2])){
+					$item->setCount($maxCount = $this->getInteger($sender, $args[2], 0));
+				}
+			}catch(InvalidArgumentException $e){
+				//vanilla checks this at argument parsing layer, can't come up with a better alternative
+				$sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.give.item.notFound", [$args[1]]));
+				return true;
+			}
+		}
+
+		//checking players inventory for all the items matching the criteria
+		if($item !== null and $maxCount === 0){
+			$count = 0;
+			$contents = array_merge($target->getInventory()->all($item), $target->getArmorInventory()->all($item));
+			foreach($contents as $content){
+				$count += $content->getCount();
+			}
+
+			if($count > 0){
+				$sender->sendMessage(new TranslationContainer("%commands.clear.testing", [$target->getName(), $count]));
+			}else{
+				$sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.clear.failure.no.items", [$target->getName()]));
+			}
+
+			return true;
+		}
+
+		$cleared = 0;
+
+		//clear everything from the targets inventory
+		if($item === null){
+			$contents = array_merge($target->getInventory()->getContents(), $target->getArmorInventory()->getContents());
+			foreach($contents as $content){
+				$cleared += $content->getCount();
+			}
+
+			$target->getInventory()->clearAll();
+			$target->getArmorInventory()->clearAll();
+			//TODO: should the cursor inv be cleared?
+		}else{
+			//clear the item from targets inventory irrelevant of the count
+			if($maxCount === -1){
+				if(($slot = $target->getArmorInventory()->first($item)) !== -1){
+					$cleared++;
+					$target->getArmorInventory()->clear($slot);
+				}
+
+				foreach($target->getInventory()->all($item) as $index => $i){
+					$cleared += $i->getCount();
+					$target->getInventory()->clear($index);
+				}
+			}else{
+				//clear only the given amount of that particular item from targets inventory
+				if(($slot = $target->getArmorInventory()->first($item)) !== -1){
+					$cleared++;
+					$maxCount--;
+					$target->getArmorInventory()->clear($slot);
+				}
+
+				if($maxCount > 0){
+					foreach($target->getInventory()->all($item) as $index => $i){
+						if($i->getCount() >= $maxCount){
+							$i->pop($maxCount);
+							$cleared += $maxCount;
+							$target->getInventory()->setItem($index, $i);
+							break;
+						}
+
+						if($maxCount <= 0){
+							break;
+						}
+
+						$cleared += $i->getCount();
+						$maxCount -= $i->getCount();
+						$target->getInventory()->clear($index);
+					}
+				}
+			}
+		}
+
+		if($cleared > 0){
+			Command::broadcastCommandMessage($sender, new TranslationContainer("%commands.clear.success", [$target->getName(), $cleared]));
+		}else{
+			$sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.clear.failure.no.items", [$target->getName()]));
+		}
+
+		return true;
+	}
+}

src/permission/DefaultPermissions.php

@@ -84,6 +84,9 @@ abstract class DefaultPermissions{
 		self::registerPermission(new Permission(self::ROOT . ".command.kill.self", "Allows the user to commit suicide"), [$everyoneRoot]);
 		self::registerPermission(new Permission(self::ROOT . ".command.kill.other", "Allows the user to kill other players"), [$operatorRoot]);
 
+		self::registerPermission(new Permission(self::ROOT . ".command.clear.self", "Allows the user to clear their own inventory"), [$everyoneRoot]);
+		self::registerPermission(new Permission(self::ROOT . ".command.clear.other", "Allows the user to clear inventory of other players"), [$operatorRoot]);
+
 		self::registerPermission(new Permission(self::ROOT . ".command.me", "Allows the user to perform a chat action"), [$everyoneRoot]);
 		self::registerPermission(new Permission(self::ROOT . ".command.tell", "Allows the user to privately message another player"), [$everyoneRoot]);
 		self::registerPermission(new Permission(self::ROOT . ".command.say", "Allows the user to talk as the console"), [$operatorRoot]);