Skip to content
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.

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

Add AdminResetHome command #2522 #2523

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,12 @@ public Optional<List<String>> tabComplete(User user, String alias, List<String>
return Optional.of(Util.getOnlinePlayerList(user));
}
if (args.size() > 3) {
return Optional.of(Util.tabLimit(new ArrayList<>(getNameIslandMap(user).keySet()), lastArg));
// Work out who is in arg 2
UUID targetUUID = getPlayers().getUUID(args.get(1));
if (targetUUID != null) {
User target = User.getInstance(targetUUID);
return Optional.of(Util.tabLimit(new ArrayList<>(getNameIslandMap(target).keySet()), lastArg));
}
}
return Optional.of(List.of("1"));

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
package world.bentobox.bentobox.api.commands.admin;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;

import world.bentobox.bentobox.api.commands.CompositeCommand;
import world.bentobox.bentobox.api.localization.TextVariables;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.database.objects.Island;
import world.bentobox.bentobox.util.Util;


/**
* This command resets players island name.
* @author BONNe
*/
public class AdminResetHomeCommand extends CompositeCommand
{
Map<String, Island> islands = new HashMap<>();

/**
* Default constructor.
* @param command Parent command.
*/
public AdminResetHomeCommand(CompositeCommand command)
{
super(command, "resethome");
}


/**
* {@inheritDoc}
*/
@Override
public void setup()
{
this.setPermission("mod.resethome");
this.setDescription("commands.admin.resethome.description");
this.setParametersHelp("commands.admin.resethome.parameters");
}


/**
* @param user the {@link User} who is executing this command.
* @param label the label which has been used to execute this command.
* It can be {@link CompositeCommand#getLabel()} or an alias.
* @param args the command arguments.
* @return {@code true} if name can be reset, {@code false} otherwise.
*/
@Override
public boolean canExecute(User user, String label, List<String> args)
{
islands.clear();
if (args.isEmpty()) {
this.showHelp(this, user);
return false;
}
// First arg must be a valid player name
UUID targetUUID = getPlayers().getUUID(args.get(0));
if (targetUUID == null) {
user.sendMessage("general.errors.unknown-player", TextVariables.NAME, args.get(0));
return false;
}
// Get islands
islands = this.getNameIslandMap(User.getInstance(targetUUID));
if (islands.isEmpty()) {
user.sendMessage("general.errors.player-has-no-island");
return false;
}

// Second optional arg must be the name of the island
if (args.size() == 1) {
return true;
}

// A specific island is mentioned. Parse which one it is and remove the others
final String name = String.join(" ", args.subList(1, args.size())); // Join all the args from here with spaces

islands.keySet().removeIf(n -> !name.equalsIgnoreCase(n));

if (islands.isEmpty()) {
// Failed name check - there are either
user.sendMessage("commands.admin.maxhomes.errors.unknown-island", TextVariables.NAME, name);
return false;
}

return true;
}


/**
* @param user the {@link User} who is executing this command.
* @param label the label which has been used to execute this command.
* It can be {@link CompositeCommand#getLabel()} or an alias.
* @param args the command arguments.
* @return {@code true}
*/
@Override
public boolean execute(User user, String label, List<String> args)
{
if (islands.isEmpty()) {
// Sanity check
return false;
}
islands.forEach((name, island) -> {
island.getHomes().keySet().removeIf(String::isEmpty); // Remove the default home
user.sendMessage("commands.admin.resethome.cleared", TextVariables.NAME, name);
});

user.sendMessage("general.success");
return true;
}


@Override
public Optional<List<String>> tabComplete(User user, String alias, List<String> args) {
String lastArg = !args.isEmpty() ? args.get(args.size() - 1) : "";
if (args.size() == 2) {
// Suggest player names
return Optional.of(Util.getOnlinePlayerList(user));
}
if (args.size() > 2) {
// Work out who is in arg 2
UUID targetUUID = getPlayers().getUUID(args.get(0));
if (targetUUID != null) {
User target = User.getInstance(targetUUID);
return Optional.of(Util.tabLimit(new ArrayList<>(getNameIslandMap(target).keySet()), lastArg));
}
}
return Optional.empty();

}

Map<String, Island> getNameIslandMap(User user) {
Map<String, Island> islandMap = new HashMap<>();
int index = 0;
System.out.println("Getting for " + user.getName());
for (Island island : getIslands().getIslands(getWorld(), user.getUniqueId())) {
System.out.println("Island - " + island);
index++;
if (island.getName() != null && !island.getName().isBlank()) {
// Name has been set
islandMap.put(island.getName(), island);
} else {
// Name has not been set
String text = user.getTranslation("protection.flags.ENTER_EXIT_MESSAGES.island", TextVariables.NAME,
user.getName(), TextVariables.DISPLAY_NAME, user.getDisplayName()) + " " + index;
islandMap.put(text, island);
}
}

return islandMap;

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ public void setup() {
new AdminResetNameCommand(this);
// Max homes
new AdminMaxHomesCommand(this);
// Reset Home
new AdminResetHomeCommand(this);
}

/**
Expand Down
7 changes: 5 additions & 2 deletions src/main/resources/locales/en-US.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,14 @@ commands:
description: admin command
maxhomes:
description: change the number of homes allowed on this island or player's island
parameters: <number / player> <number> <island name>
parameters: <number / player> <number> [island name]
max-homes-set: '&a [name] - Set island max homes to [number]'
errors:
unknown-island: &c Unknown island! [name]

resethome:
description: Reset the player's home to default
parameters: <player> [island name]
cleared: '&b Home reset. [name]'
resets:
description: edit player reset values
set:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
Expand Down Expand Up @@ -135,6 +136,8 @@ public void setUp() throws Exception {
// Has team
when(im.inTeam(any(), eq(uuid))).thenReturn(true);

// Players
when(pm.getUUID(anyString())).thenReturn(uuid);
when(plugin.getPlayers()).thenReturn(pm);

// Server & Scheduler
Expand Down Expand Up @@ -457,7 +460,7 @@ public void testTabComplete_ArgsSizeGreaterThan3_ReturnsIslandNames() {
Map<String, Island> nameIslandMap = new HashMap<>();
nameIslandMap.put("IslandOne", mock(Island.class));
nameIslandMap.put("IslandTwo", mock(Island.class));
doReturn(nameIslandMap).when(instance).getNameIslandMap(user);
doReturn(nameIslandMap).when(instance).getNameIslandMap(any());

// Create the list of island names
List<String> islandNames = new ArrayList<>(nameIslandMap.keySet());
Expand Down
Loading
Loading