Merge branch 'general-devel-rest' of github.com:TShock/TShock into general-devel-rest
This commit is contained in:
high
commit
b7fd7f1953
4 changed files with 4 additions and 4 deletions
377
TShockAPI/Rest/RestManager.cs
Normal file
377
TShockAPI/Rest/RestManager.cs
Normal file
|
|
@ -0,0 +1,377 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using HttpServer;
|
||||
using Rests;
|
||||
using Terraria;
|
||||
|
||||
namespace TShockAPI {
|
||||
|
||||
public class RestManager
|
||||
{
|
||||
private Rest Rest;
|
||||
public RestManager(Rest rest)
|
||||
{
|
||||
Rest = rest;
|
||||
}
|
||||
|
||||
public void RegisterRestfulCommands()
|
||||
{
|
||||
Rest.Register(new RestCommand("/status", Status) {RequiesToken = false});
|
||||
Rest.Register(new RestCommand("/tokentest", TokenTest) { RequiesToken = true });
|
||||
|
||||
Rest.Register(new RestCommand("/users/read/{user}/info", UserInfo) {RequiesToken = true});
|
||||
Rest.Register(new RestCommand("/users/destroy/{user}", UserDestroy) {RequiesToken = true});
|
||||
Rest.Register(new RestCommand("/users/update/{user}", UserUpdate) {RequiesToken = true});
|
||||
|
||||
Rest.Register(new RestCommand("/bans/create", BanCreate) { RequiesToken = true });
|
||||
Rest.Register(new RestCommand("/bans/read/{user}/info", BanInfo) { RequiesToken = true });
|
||||
Rest.Register(new RestCommand("/bans/destroy/{user}", BanDestroy) { RequiesToken = true });
|
||||
|
||||
|
||||
Rest.Register(new RestCommand("/lists/players", UserList) {RequiesToken = true});
|
||||
|
||||
Rest.Register(new RestCommand("/world/read", WorldRead) { RequiesToken = true });
|
||||
Rest.Register(new RestCommand("/world/meteor", WorldMeteor) { RequiesToken = true });
|
||||
Rest.Register(new RestCommand("/world/bloodmoon/{bool}", WorldBloodmoon) { RequiesToken = true });
|
||||
//RegisterExamples();
|
||||
}
|
||||
|
||||
#region RestMethods
|
||||
|
||||
object TokenTest(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
return new Dictionary<string, string> { { "status", "200" }, { "response", "Token is valid and was passed through correctly." } };
|
||||
}
|
||||
|
||||
object Status(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
if (TShock.Config.EnableTokenEndpointAuthentication)
|
||||
{
|
||||
returnBlock.Add("status", "403");
|
||||
returnBlock.Add("error", "Server settings require a token for this API call.");
|
||||
return returnBlock;
|
||||
}
|
||||
string CurrentPlayers = "";
|
||||
int PlayerCount = 0;
|
||||
for (int i = 0; i < Main.player.Length; i++)
|
||||
{
|
||||
if (Main.player[i].active)
|
||||
{
|
||||
CurrentPlayers += Main.player[i].name + ", ";
|
||||
PlayerCount++;
|
||||
}
|
||||
}
|
||||
returnBlock.Add("status", "200");
|
||||
returnBlock.Add("name", TShock.Config.ServerNickname);
|
||||
returnBlock.Add("port", Convert.ToString(TShock.Config.ServerPort));
|
||||
returnBlock.Add("playercount", Convert.ToString(PlayerCount));
|
||||
returnBlock.Add("players", CurrentPlayers);
|
||||
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region RestUserMethods
|
||||
|
||||
object UserList(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
string players = "";
|
||||
for (int i = 0; i < Main.player.Length; i++ )
|
||||
{
|
||||
if (Main.player[i].active)
|
||||
{
|
||||
players += Main.player[i].name + ", ";
|
||||
}
|
||||
}
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
returnBlock.Add("status", "200");
|
||||
returnBlock.Add("players", players);
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
object UserUpdate(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
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;
|
||||
}
|
||||
|
||||
object UserDestroy(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var user = TShock.Users.GetUserByName(verbs["user"]);
|
||||
if (user == null)
|
||||
{
|
||||
return new Dictionary<string, string> { { "status", "400" }, { "error", "The specified user account does not exist." } };
|
||||
}
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
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;
|
||||
}
|
||||
|
||||
object UserInfo(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var user = TShock.Users.GetUserByName(verbs["user"]);
|
||||
if (user == null)
|
||||
{
|
||||
return new Dictionary<string, string>
|
||||
{{"status", "400"}, {"error", "The specified user account does not exist."}};
|
||||
}
|
||||
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
returnBlock.Add("status", "200");
|
||||
returnBlock.Add("group", user.Group);
|
||||
returnBlock.Add("id", user.ID.ToString());
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region RestBanMethods
|
||||
|
||||
object BanCreate(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
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;
|
||||
}
|
||||
|
||||
object BanDestroy(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
|
||||
var type = parameters["type"];
|
||||
if (type == null)
|
||||
{
|
||||
returnBlock.Add("Error", "Invalid Type");
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
var ban = new DB.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<string, string> { { "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;
|
||||
}
|
||||
|
||||
object BanInfo(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
|
||||
var type = parameters["type"];
|
||||
if (type == null)
|
||||
{
|
||||
returnBlock.Add("Error", "Invalid Type");
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
var ban = new DB.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<string, string> { { "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
|
||||
object WorldRead(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
returnBlock.Add("status", "200");
|
||||
returnBlock.Add("name", Main.worldName);
|
||||
returnBlock.Add("size", Main.maxTilesX + "*" + Main.maxTilesY);
|
||||
returnBlock.Add("time", Main.time.ToString());
|
||||
returnBlock.Add("daytime", Main.dayTime.ToString());
|
||||
returnBlock.Add("bloodmoon", Main.bloodMoon.ToString());
|
||||
returnBlock.Add("invasionsize", Main.invasionSize.ToString());
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
object WorldMeteor(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
WorldGen.dropMeteor();
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
returnBlock.Add("status", "200");
|
||||
returnBlock.Add("response", "Meteor has been spawned.");
|
||||
return returnBlock;
|
||||
}
|
||||
|
||||
object WorldBloodmoon(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBlock = new Dictionary<string, string>();
|
||||
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.ToString());
|
||||
return returnBlock;
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region RestExampleMethods
|
||||
|
||||
public void RegisterExamples()
|
||||
{
|
||||
Rest.Register(new RestCommand("/HelloWorld/name/{username}", UserTest) {RequiesToken = false});
|
||||
Rest.Register(new RestCommand("/wizard/{username}", Wizard) {RequiesToken = false});
|
||||
}
|
||||
|
||||
//The Wizard example, for demonstrating the response convention:
|
||||
object Wizard(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var returnBack = new Dictionary<string, string>();
|
||||
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
|
||||
object UserTest(RestVerbs verbs, IParameterCollection parameters)
|
||||
{
|
||||
var ret = new Dictionary<string, string>();
|
||||
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
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue