themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Utils.cs now has uniform tabs

Browse source
This commit is contained in:
Lucas Nicodemus 2015-02-28 19:47:27 -07:00
parent 1be5f6fdc2
commit d8f1324836
1 changed files with 119 additions and 119 deletions
Download patch file Download diff file Expand all files Collapse all files

238
TShockAPI/Utils.cs
View file

@ -35,17 +35,17 @@ namespace TShockAPI
/// </summary> /// </summary>
public class Utils public class Utils
{ {
/// <summary> /// <summary>
/// The lowest id for a prefix. /// The lowest id for a prefix.
/// </summary> /// </summary>
private const int FirstItemPrefix = 1; private const int FirstItemPrefix = 1;
/// <summary> /// <summary>
/// The highest id for a prefix. /// The highest id for a prefix.
/// </summary> /// </summary>
private const int LastItemPrefix = 83; private const int LastItemPrefix = 83;
// Utils is a Singleton // Utils is a Singleton
private static readonly Utils instance = new Utils(); private static readonly Utils instance = new Utils();
private Utils() {} private Utils() {}
public static Utils Instance { get { return instance; } } public static Utils Instance { get { return instance; } }
@ -67,7 +67,7 @@ namespace TShockAPI
/// Used for some places where a list of players might be used. /// Used for some places where a list of players might be used.
/// </summary> /// </summary>
/// <returns>String of players seperated by commas.</returns> /// <returns>String of players seperated by commas.</returns>
[Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")] [Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")]
public string GetPlayers() public string GetPlayers()
{ {
var sb = new StringBuilder(); var sb = new StringBuilder();
@ -85,56 +85,56 @@ namespace TShockAPI
return sb.ToString(); return sb.ToString();
} }
/// <summary> /// <summary>
/// Returns a list of current players on the server /// Returns a list of current players on the server
/// </summary> /// </summary>
/// <param name="includeIDs">bool includeIDs - whether or not the string of each player name should include ID data</param> /// <param name="includeIDs">bool includeIDs - whether or not the string of each player name should include ID data</param>
/// <returns>List of strings with names</returns> /// <returns>List of strings with names</returns>
public List<string> GetPlayers(bool includeIDs) public List<string> GetPlayers(bool includeIDs)
{ {
var players = new List<string>(); var players = new List<string>();
foreach (TSPlayer ply in TShock.Players) foreach (TSPlayer ply in TShock.Players)
{ {
if (ply != null && ply.Active) if (ply != null && ply.Active)
{ {
if (includeIDs) if (includeIDs)
{ {
players.Add(ply.Name + " (IX: " + ply.Index + ", ID: " + ply.UserID + ")"); players.Add(ply.Name + " (IX: " + ply.Index + ", ID: " + ply.UserID + ")");
} }
else else
{ {
players.Add(ply.Name); players.Add(ply.Name);
} }
} }
} }
return players; return players;
} }
/// <summary> /// <summary>
/// Used for some places where a list of players might be used. /// Used for some places where a list of players might be used.
/// </summary> /// </summary>
/// <returns>String of players and their id seperated by commas.</returns> /// <returns>String of players and their id seperated by commas.</returns>
[Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")] [Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")]
public string GetPlayersWithIds() public string GetPlayersWithIds()
{ {
var sb = new StringBuilder(); var sb = new StringBuilder();
foreach (TSPlayer player in TShock.Players) foreach (TSPlayer player in TShock.Players)
{ {
if (player != null && player.Active) if (player != null && player.Active)
{ {
if (sb.Length != 0) if (sb.Length != 0)
{ {
sb.Append(", "); sb.Append(", ");
} }
sb.Append(player.Name); sb.Append(player.Name);
string id = "(ID: " + Convert.ToString(TShock.Users.GetUserID(player.UserAccountName)) + ", IX:" + player.Index + ")"; string id = "(ID: " + Convert.ToString(TShock.Users.GetUserID(player.UserAccountName)) + ", IX:" + player.Index + ")";
sb.Append(id); sb.Append(id);
} }
} }
return sb.ToString(); return sb.ToString();
} }
/// <summary> /// <summary>
/// Finds a player and gets IP as string /// Finds a player and gets IP as string
@ -204,20 +204,20 @@ namespace TShockAPI
Broadcast(msg, color.R, color.G, color.B); Broadcast(msg, color.R, color.G, color.B);
} }
/// <summary> /// <summary>
/// Broadcasts a message from a player, not TShock /// Broadcasts a message from a player, not TShock
/// </summary> /// </summary>
/// <param name="ply">TSPlayer ply - the player that will send the packet</param> /// <param name="ply">TSPlayer ply - the player that will send the packet</param>
/// <param name="msg">string msg - the message</param> /// <param name="msg">string msg - the message</param>
/// <param name="red">r</param> /// <param name="red">r</param>
/// <param name="green">g</param> /// <param name="green">g</param>
/// <param name="blue">b</param> /// <param name="blue">b</param>
public void Broadcast(int ply, string msg, byte red, byte green, byte blue) public void Broadcast(int ply, string msg, byte red, byte green, byte blue)
{ {
TSPlayer.All.SendMessageFromPlayer(msg, red, green, blue, ply); TSPlayer.All.SendMessageFromPlayer(msg, red, green, blue, ply);
TSPlayer.Server.SendMessage(Main.player[ply].name + ": " + msg, red, green, blue); TSPlayer.Server.SendMessage(Main.player[ply].name + ": " + msg, red, green, blue);
TShock.Log.Info(string.Format("Broadcast: {0}", Main.player[ply].name + ": " + msg)); TShock.Log.Info(string.Format("Broadcast: {0}", Main.player[ply].name + ": " + msg));
} }
/// <summary> /// <summary>
/// Sends message to all players with 'logs' permission. /// Sends message to all players with 'logs' permission.
@ -232,7 +232,7 @@ namespace TShockAPI
foreach (TSPlayer player in TShock.Players) foreach (TSPlayer player in TShock.Players)
{ {
if (player != null && player != excludedPlayer && player.Active && player.Group.HasPermission(Permissions.logs) && if (player != null && player != excludedPlayer && player.Active && player.Group.HasPermission(Permissions.logs) &&
player.DisplayLogs && TShock.Config.DisableSpewLogs == false) player.DisplayLogs && TShock.Config.DisableSpewLogs == false)
player.SendMessage(log, color); player.SendMessage(log, color);
} }
} }
@ -293,7 +293,7 @@ namespace TShockAPI
/// <param name="tileX">X location</param> /// <param name="tileX">X location</param>
/// <param name="tileY">Y location</param> /// <param name="tileY">Y location</param>
public void GetRandomClearTileWithInRange(int startTileX, int startTileY, int tileXRange, int tileYRange, public void GetRandomClearTileWithInRange(int startTileX, int startTileY, int tileXRange, int tileYRange,
out int tileX, out int tileY) out int tileX, out int tileY)
{ {
int j = 0; int j = 0;
do do
@ -509,8 +509,8 @@ namespace TShockAPI
} }
return found; return found;
} }
/// <summary> /// <summary>
/// Gets a prefix by ID or name /// Gets a prefix by ID or name
/// </summary> /// </summary>
/// <param name="idOrName">ID or name</param> /// <param name="idOrName">ID or name</param>
@ -635,18 +635,18 @@ namespace TShockAPI
{ {
string playerName = player.Name; string playerName = player.Name;
player.SilentKickInProgress = silent; player.SilentKickInProgress = silent;
if (player.IsLoggedIn && saveSSI) if (player.IsLoggedIn && saveSSI)
player.SaveServerCharacter(); player.SaveServerCharacter();
player.Disconnect(string.Format("Kicked: {0}", reason)); player.Disconnect(string.Format("Kicked: {0}", reason));
TShock.Log.ConsoleInfo(string.Format("Kicked {0} for : '{1}'", playerName, reason)); TShock.Log.ConsoleInfo(string.Format("Kicked {0} for : '{1}'", playerName, reason));
string verb = force ? "force " : ""; string verb = force ? "force " : "";
if (!silent) if (!silent)
{ {
if (string.IsNullOrWhiteSpace(adminUserName)) if (string.IsNullOrWhiteSpace(adminUserName))
Broadcast(string.Format("{0} was {1}kicked for '{2}'", playerName, verb, reason.ToLower()), Color.Green); Broadcast(string.Format("{0} was {1}kicked for '{2}'", playerName, verb, reason.ToLower()), Color.Green);
else else
Broadcast(string.Format("{0} {1}kicked {2} for '{3}'", adminUserName, verb, playerName, reason.ToLower()), Color.Green); Broadcast(string.Format("{0} {1}kicked {2} for '{3}'", adminUserName, verb, playerName, reason.ToLower()), Color.Green);
} }
return true; return true;
} }
return false; return false;
@ -687,28 +687,28 @@ namespace TShockAPI
return false; return false;
} }
public bool HasBanExpired(Ban ban, bool byName = false) public bool HasBanExpired(Ban ban, bool byName = false)
{ {
DateTime exp; DateTime exp;
bool expirationExists = DateTime.TryParse(ban.Expiration, out exp); bool expirationExists = DateTime.TryParse(ban.Expiration, out exp);
if (!string.IsNullOrWhiteSpace(ban.Expiration) && (expirationExists) && if (!string.IsNullOrWhiteSpace(ban.Expiration) && (expirationExists) &&
(DateTime.UtcNow >= exp)) (DateTime.UtcNow >= exp))
{ {
if (byName) if (byName)
{ {
TShock.Bans.RemoveBan(ban.Name, true, true, false); TShock.Bans.RemoveBan(ban.Name, true, true, false);
} }
else else
{ {
TShock.Bans.RemoveBan(ban.IP, false, false, false); TShock.Bans.RemoveBan(ban.IP, false, false, false);
} }
return true; return true;
} }
return false; return false;
} }
/// <summary> /// <summary>
/// Shows a file to the user. /// Shows a file to the user.
@ -762,7 +762,7 @@ namespace TShockAPI
return TShock.Groups.groups[i]; return TShock.Groups.groups[i];
} }
} }
return Group.DefaultGroup; return Group.DefaultGroup;
} }
/// <summary> /// <summary>
@ -796,23 +796,23 @@ namespace TShockAPI
ply.SendErrorMessage("Use \"my query\" for items with spaces"); ply.SendErrorMessage("Use \"my query\" for items with spaces");
} }
/// <summary> /// <summary>
/// Default hashing algorithm. /// Default hashing algorithm.
/// </summary> /// </summary>
public string HashAlgo = "sha512"; public string HashAlgo = "sha512";
/// <summary> /// <summary>
/// A dictionary of hashing algortihms and an implementation object. /// A dictionary of hashing algortihms and an implementation object.
/// </summary> /// </summary>
public readonly Dictionary<string, Func<HashAlgorithm>> HashTypes = new Dictionary<string, Func<HashAlgorithm>> public readonly Dictionary<string, Func<HashAlgorithm>> HashTypes = new Dictionary<string, Func<HashAlgorithm>>
{ {
{"sha512", () => new SHA512Managed()}, {"sha512", () => new SHA512Managed()},
{"sha256", () => new SHA256Managed()}, {"sha256", () => new SHA256Managed()},
{"md5", () => new MD5Cng()}, {"md5", () => new MD5Cng()},
{"sha512-xp", () => SHA512.Create()}, {"sha512-xp", () => SHA512.Create()},
{"sha256-xp", () => SHA256.Create()}, {"sha256-xp", () => SHA256.Create()},
{"md5-xp", () => MD5.Create()}, {"md5-xp", () => MD5.Create()},
}; };
/// <summary> /// <summary>
/// Returns a Sha256 string for a given string /// Returns a Sha256 string for a given string