Implement give item & Implement configurable handbook endpoints

This commit is contained in:
KingRainbow44 2023-04-10 22:04:47 -04:00
parent eff01b6cea
commit 1661c42def
No known key found for this signature in database
GPG Key ID: FC2CB64B00D257BE
3 changed files with 194 additions and 120 deletions

View File

@ -36,6 +36,8 @@ public final class Configuration extends ConfigContainer {
public static final GameOptions GAME_OPTIONS = config.server.game.gameOptions; public static final GameOptions GAME_OPTIONS = config.server.game.gameOptions;
public static final GameOptions.InventoryLimits INVENTORY_LIMITS = public static final GameOptions.InventoryLimits INVENTORY_LIMITS =
config.server.game.gameOptions.inventoryLimits; config.server.game.gameOptions.inventoryLimits;
public static final GameOptions.HandbookOptions HANDBOOK =
config.server.game.gameOptions.handbook;
private static final String DATA_FOLDER = config.folderStructure.data; private static final String DATA_FOLDER = config.folderStructure.data;
private static final String PLUGINS_FOLDER = config.folderStructure.plugins; private static final String PLUGINS_FOLDER = config.folderStructure.plugins;
private static final String SCRIPTS_FOLDER = config.folderStructure.scripts; private static final String SCRIPTS_FOLDER = config.folderStructure.scripts;

View File

@ -4,12 +4,16 @@ import emu.grasscutter.Grasscutter;
import emu.grasscutter.Grasscutter.ServerRunMode; import emu.grasscutter.Grasscutter.ServerRunMode;
import emu.grasscutter.data.GameData; import emu.grasscutter.data.GameData;
import emu.grasscutter.game.avatar.Avatar; import emu.grasscutter.game.avatar.Avatar;
import emu.grasscutter.game.inventory.GameItem;
import emu.grasscutter.game.props.ActionReason;
import emu.grasscutter.server.http.Router; import emu.grasscutter.server.http.Router;
import emu.grasscutter.utils.FileUtils; import emu.grasscutter.utils.FileUtils;
import emu.grasscutter.utils.objects.HandbookBody; import emu.grasscutter.utils.objects.HandbookBody;
import io.javalin.Javalin; import io.javalin.Javalin;
import io.javalin.http.Context; import io.javalin.http.Context;
import static emu.grasscutter.config.Configuration.HANDBOOK;
/** Handles requests for the new GM Handbook. */ /** Handles requests for the new GM Handbook. */
public final class HandbookHandler implements Router { public final class HandbookHandler implements Router {
private final byte[] handbook; private final byte[] handbook;
@ -21,23 +25,27 @@ public final class HandbookHandler implements Router {
*/ */
public HandbookHandler() { public HandbookHandler() {
this.handbook = FileUtils.readResource("/handbook.html"); this.handbook = FileUtils.readResource("/handbook.html");
this.serve = this.handbook.length > 0; this.serve = HANDBOOK.enable && this.handbook.length > 0;
} }
@Override @Override
public void applyRoutes(Javalin javalin) { public void applyRoutes(Javalin javalin) {
if (!this.serve) return;
// The handbook content. (built from src/handbook) // The handbook content. (built from src/handbook)
javalin.get("/handbook", this::serveHandbook); javalin.get("/handbook", this::serveHandbook);
// Handbook control routes. // Handbook control routes.
javalin.post("/handbook/avatar", this::grantAvatar); javalin.post("/handbook/avatar", this::grantAvatar);
javalin.post("/handbook/item", this::giveItem);
} }
/** /**
* @return True if the server can execute handbook commands. * @return True if the server can execute handbook commands.
*/ */
private boolean controlSupported() { private boolean controlSupported() {
return Grasscutter.getRunMode() == ServerRunMode.HYBRID; return HANDBOOK.enable &&
Grasscutter.getRunMode() == ServerRunMode.HYBRID;
} }
/** /**
@ -105,6 +113,61 @@ public final class HandbookHandler implements Router {
.build()); .build());
} catch (NumberFormatException ignored) { } catch (NumberFormatException ignored) {
ctx.status(500).result("Invalid player UID or avatar ID."); ctx.status(500).result("Invalid player UID or avatar ID.");
} catch (Exception exception) {
ctx.status(500).result("An error occurred while granting the avatar.");
Grasscutter.getLogger().debug("A handbook command error occurred.", exception);
}
}
/**
* Gives an item to the user.
*
* @route POST /handbook/item
* @param ctx The Javalin request context.
*/
private void giveItem(Context ctx) {
if (!this.controlSupported()) {
ctx.status(500).result("Handbook control not supported.");
return;
}
// Parse the request body into a class.
var request = ctx.bodyAsClass(HandbookBody.GiveItem.class);
// Validate the request.
if (request.getPlayer() == null || request.getItem() == null) {
ctx.status(400).result("Invalid request.");
return;
}
try {
// Parse the requested player.
var playerId = Integer.parseInt(request.getPlayer());
var player = Grasscutter.getGameServer().getPlayerByUid(playerId);
// Parse the requested item.
var itemId = Integer.parseInt(request.getItem());
var itemData = GameData.getItemDataMap().get(itemId);
// Validate the request.
if (player == null || itemData == null) {
ctx.status(400).result("Invalid player UID or item ID.");
return;
}
// Create the new item stack.
var itemStack = new GameItem(itemData, request.getAmount());
// Add the item to the inventory.
player.getInventory().addItem(itemStack, ActionReason.Gm);
ctx.json(HandbookBody.Response.builder()
.status(200)
.message("Item granted.")
.build());
} catch (NumberFormatException ignored) {
ctx.status(500).result("Invalid player UID or item ID.");
} catch (Exception exception) {
ctx.status(500).result("An error occurred while granting the item.");
Grasscutter.getLogger().debug("A handbook command error occurred.", exception);
} }
} }
} }

View File

@ -4,6 +4,7 @@ import lombok.Builder;
import lombok.Getter; import lombok.Getter;
/** HTTP request object for handbook controls. */ /** HTTP request object for handbook controls. */
@SuppressWarnings("FieldMayBeFinal")
public interface HandbookBody { public interface HandbookBody {
@Builder @Builder
class Response { class Response {
@ -20,4 +21,12 @@ public interface HandbookBody {
private int constellations = 6; // Range between 0 - 6. private int constellations = 6; // Range between 0 - 6.
private int talentLevels = 10; // Range between 1 - 15. private int talentLevels = 10; // Range between 1 - 15.
} }
@Getter
class GiveItem {
private String player; // Parse into online player ID.
private String item; // Parse into item ID.
private int amount = 1; // Range between 1 - Long.MAX_VALUE.
}
} }