/* TShock, a server mod for Terraria Copyright (C) 2011 The TShock Team This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ using System; using System.Collections.Generic; using System.Linq; using HttpServer; using Rests; using Terraria; using TShockAPI.DB; namespace TShockAPI { public class RestManager { private Rest Rest; public RestManager(Rest rest) { Rest = rest; } public void RegisterRestfulCommands() { Rest.Register(new RestCommand("/status", Status) {RequiresToken = false}); Rest.Register(new RestCommand("/tokentest", TokenTest) {RequiresToken = true}); Rest.Register(new RestCommand("/users/read/{user}/info", UserInfo) {RequiresToken = true}); Rest.Register(new RestCommand("/users/destroy/{user}", UserDestroy) {RequiresToken = true}); Rest.Register(new RestCommand("/users/update/{user}", UserUpdate) {RequiresToken = true}); Rest.Register(new RestCommand("/users/activelist", UserList) {RequiresToken = true}); Rest.Register(new RestCommand("/bans/create", BanCreate) {RequiresToken = true}); Rest.Register(new RestCommand("/bans/read/{user}/info", BanInfo) {RequiresToken = true}); Rest.Register(new RestCommand("/bans/destroy/{user}", BanDestroy) {RequiresToken = true}); Rest.Register(new RestCommand("/lists/players", PlayerList) {RequiresToken = true}); Rest.Register(new RestCommand("/world/read", WorldRead) {RequiresToken = true}); Rest.Register(new RestCommand("/world/meteor", WorldMeteor) {RequiresToken = true}); Rest.Register(new RestCommand("/world/bloodmoon/{bool}", WorldBloodmoon) {RequiresToken = true}); Rest.Register(new RestCommand("/players/read/{player}", PlayerRead) {RequiresToken = true}); Rest.Register(new RestCommand("/players/{player}/kick", PlayerKick) {RequiresToken = true}); Rest.Register(new RestCommand("/players/{player}/ban", PlayerBan) {RequiresToken = true}); //RegisterExamples(); } #region RestMethods private object TokenTest(RestVerbs verbs, IParameterCollection parameters) { return new Dictionary {{"status", "200"}, {"response", "Token is valid and was passed through correctly."}}; } private object Status(RestVerbs verbs, IParameterCollection parameters) { if (TShock.Config.EnableTokenEndpointAuthentication) return new RestObject("403") {Error = "Server settings require a token for this API call."}; var activeplayers = Main.player.Where(p => p != null && p.active).ToList(); string currentPlayers = string.Join(", ", activeplayers.Select(p => p.name)); var ret = new RestObject("200"); ret["name"] = TShock.Config.ServerNickname; ret["port"] = Convert.ToString(TShock.Config.ServerPort); ret["playercount"] = Convert.ToString(activeplayers.Count()); ret["players"] = currentPlayers; return ret; } #endregion #region RestUserMethods private object UserList(RestVerbs verbs, IParameterCollection parameters) { var ret = new RestObject("200"); string playerlist = ""; foreach (var TSPlayer in TShock.Players) { if (playerlist == "") { playerlist += TSPlayer.UserAccountName; } else { playerlist += ", " + TSPlayer.UserAccountName; } } ret["activeuesrs"] = playerlist; return ret; } private object UserUpdate(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var password = parameters["password"]; var group = parameters["group"]; if (group == null && password == null) { returnBlock.Add("status", "400"); returnBlock.Add("error", "No parameters were passed."); return returnBlock; } var user = TShock.Users.GetUserByName(verbs["user"]); if (user == null) { returnBlock.Add("status", "400"); returnBlock.Add("error", "The specefied user doesn't exist."); return returnBlock; } if (password != null) { TShock.Users.SetUserPassword(user, password); returnBlock.Add("password-response", "Password updated successfully."); } if (group != null) { TShock.Users.SetUserGroup(user, group); returnBlock.Add("group-response", "Group updated successfully."); } returnBlock.Add("status", "200"); return returnBlock; } private object UserDestroy(RestVerbs verbs, IParameterCollection parameters) { var user = TShock.Users.GetUserByName(verbs["user"]); if (user == null) { return new Dictionary {{"status", "400"}, {"error", "The specified user account does not exist."}}; } var returnBlock = new Dictionary(); try { TShock.Users.RemoveUser(user); } catch (Exception) { returnBlock.Add("status", "400"); returnBlock.Add("error", "The specified user was unable to be removed."); return returnBlock; } returnBlock.Add("status", "200"); returnBlock.Add("response", "User deleted successfully."); return returnBlock; } private object UserInfo(RestVerbs verbs, IParameterCollection parameters) { var user = TShock.Users.GetUserByName(verbs["user"]); if (user == null) { return new Dictionary {{"status", "400"}, {"error", "The specified user account does not exist."}}; } var returnBlock = new Dictionary(); returnBlock.Add("status", "200"); returnBlock.Add("group", user.Group); returnBlock.Add("id", user.ID.ToString()); return returnBlock; } #endregion #region RestBanMethods private object BanCreate(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var ip = parameters["ip"]; var name = parameters["name"]; var reason = parameters["reason"]; if (ip == null && name == null) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Required parameters were missing from this API endpoint."); return returnBlock; } if (ip == null) { ip = ""; } if (name == null) { name = ""; } if (reason == null) { reason = ""; } try { TShock.Bans.AddBan(ip, name, reason); } catch (Exception) { returnBlock.Add("status", "400"); returnBlock.Add("error", "The specified ban was unable to be created."); return returnBlock; } returnBlock.Add("status", "200"); returnBlock.Add("response", "Ban created successfully."); return returnBlock; } private object BanDestroy(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var type = parameters["type"]; if (type == null) { returnBlock.Add("Error", "Invalid Type"); return returnBlock; } var ban = new Ban(); if (type == "ip") ban = TShock.Bans.GetBanByIp(verbs["user"]); else if (type == "name") ban = TShock.Bans.GetBanByName(verbs["user"]); else { returnBlock.Add("Error", "Invalid Type"); return returnBlock; } if (ban == null) { return new Dictionary {{"status", "400"}, {"error", "The specified ban does not exist."}}; } try { TShock.Bans.RemoveBan(ban.IP); } catch (Exception) { returnBlock.Add("status", "400"); returnBlock.Add("error", "The specified ban was unable to be removed."); return returnBlock; } returnBlock.Add("status", "200"); returnBlock.Add("response", "Ban deleted successfully."); return returnBlock; } private object BanInfo(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var type = parameters["type"]; if (type == null) { returnBlock.Add("Error", "Invalid Type"); return returnBlock; } var ban = new Ban(); if (type == "ip") ban = TShock.Bans.GetBanByIp(verbs["user"]); else if (type == "name") ban = TShock.Bans.GetBanByName(verbs["user"]); else { returnBlock.Add("Error", "Invalid Type"); return returnBlock; } if (ban == null) { return new Dictionary {{"status", "400"}, {"error", "The specified ban does not exist."}}; } returnBlock.Add("status", "200"); returnBlock.Add("name", ban.Name); returnBlock.Add("ip", ban.IP); returnBlock.Add("reason", ban.Reason); return returnBlock; } #endregion #region RestWorldMethods private object WorldRead(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); returnBlock.Add("status", "200"); returnBlock.Add("name", Main.worldName); returnBlock.Add("size", Main.maxTilesX + "*" + Main.maxTilesY); returnBlock.Add("time", Main.time); returnBlock.Add("daytime", Main.dayTime); returnBlock.Add("bloodmoon", Main.bloodMoon); returnBlock.Add("invasionsize", Main.invasionSize); return returnBlock; } private object WorldMeteor(RestVerbs verbs, IParameterCollection parameters) { WorldGen.dropMeteor(); var returnBlock = new Dictionary(); returnBlock.Add("status", "200"); returnBlock.Add("response", "Meteor has been spawned."); return returnBlock; } private object WorldBloodmoon(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var bloodmoonVerb = verbs["bool"]; bool bloodmoon; if (bloodmoonVerb == null) { returnBlock.Add("status", "400"); returnBlock.Add("error", "No parameter was passed."); return returnBlock; } if (!bool.TryParse(bloodmoonVerb, out bloodmoon)) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Unable to parse parameter."); return returnBlock; } Main.bloodMoon = bloodmoon; returnBlock.Add("status", "200"); returnBlock.Add("response", "Blood Moon has been set to " + bloodmoon); return returnBlock; } #endregion #region RestPlayerMethods private object PlayerList(RestVerbs verbs, IParameterCollection parameters) { var activeplayers = Main.player.Where(p => p != null && p.active).ToList(); string currentPlayers = string.Join(", ", activeplayers.Select(p => p.name)); var ret = new RestObject("200"); ret["players"] = currentPlayers; return ret; } private object PlayerRead(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var playerParam = parameters["player"]; var found = TShock.Utils.FindPlayer(playerParam); if (found.Count == 0) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Name " + playerParam + " was not found"); } else if (found.Count > 1) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Name " + playerParam + " matches " + playerParam.Count() + " players"); } else if (found.Count == 1) { var player = found[0]; returnBlock.Add("status", "200"); returnBlock.Add("nickname", player.Name); returnBlock.Add("username", player.UserAccountName == null ? "" : player.UserAccountName); returnBlock.Add("ip", player.IP); returnBlock.Add("group", player.Group.Name); returnBlock.Add("position", player.TileX + "," + player.TileY); var activeItems = player.TPlayer.inventory.Where(p => p.active).ToList(); returnBlock.Add("inventory", string.Join(", ", activeItems.Select(p => p.name))); returnBlock.Add("buffs", string.Join(", ", player.TPlayer.buffType)); } return returnBlock; } private object PlayerKick(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var playerParam = parameters["player"]; var found = TShock.Utils.FindPlayer(playerParam); var reason = verbs["reason"]; if (found.Count == 0) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Name " + playerParam + " was not found"); } else if (found.Count > 1) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Name " + playerParam + " matches " + playerParam.Count() + " players"); } else if (found.Count == 1) { var player = found[0]; TShock.Utils.ForceKick(player, reason == null ? "Kicked via web" : reason); returnBlock.Add("status", "200"); returnBlock.Add("response", "Player " + player.Name + " was kicked"); } return returnBlock; } private object PlayerBan(RestVerbs verbs, IParameterCollection parameters) { var returnBlock = new Dictionary(); var playerParam = parameters["player"]; var found = TShock.Utils.FindPlayer(playerParam); var reason = verbs["reason"]; if (found.Count == 0) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Name " + playerParam + " was not found"); } else if (found.Count > 1) { returnBlock.Add("status", "400"); returnBlock.Add("error", "Name " + playerParam + " matches " + playerParam.Count() + " players"); } else if (found.Count == 1) { var player = found[0]; TShock.Bans.AddBan(player.IP, player.Name, reason == null ? "Banned via web" : reason); TShock.Utils.ForceKick(player, reason == null ? "Banned via web" : reason); returnBlock.Add("status", "200"); returnBlock.Add("response", "Player " + player.Name + " was banned"); } return returnBlock; } #endregion #region RestExampleMethods public void RegisterExamples() { Rest.Register(new RestCommand("/HelloWorld/name/{username}", UserTest) {RequiresToken = false}); Rest.Register(new RestCommand("/wizard/{username}", Wizard) {RequiresToken = false}); } //The Wizard example, for demonstrating the response convention: private object Wizard(RestVerbs verbs, IParameterCollection parameters) { var returnBack = new Dictionary(); returnBack.Add("status", "200"); //Keep this in everything, 200 = ok, etc. Standard http status codes. returnBack.Add("error", "(If this failed, you would have a different status code and provide the error object.)"); //And only include this if the status isn't 200 or a failure returnBack.Add("Verified Wizard", "You're a wizard, " + verbs["username"]); //Outline any api calls and possible responses in some form of documentation somewhere return returnBack; } //http://127.0.0.1:8080/HelloWorld/name/{username}?type=status private object UserTest(RestVerbs verbs, IParameterCollection parameters) { var ret = new Dictionary(); var type = parameters["type"]; if (type == null) { ret.Add("Error", "Invalid Type"); return ret; } if (type == "status") { ret.Add("Users", "Info here"); return ret; } return null; } #endregion } }