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

Document Utils.cs & UserManager.cs

Browse source 
Deprecated Utils.Random()
This commit is contained in:
Lucas Nicodemus 2015-04-19 20:37:38 -06:00
parent ce4585d151
commit 342921b3ed
2 changed files with 147 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

126
TShockAPI/DB/UserManager.cs
View file

@ -29,28 +29,33 @@ using System.Security.Cryptography;
namespace TShockAPI.DB
{
/// <summary>UserManager - Methods for dealing with database users and other user functionality within TShock.</summary>
public class UserManager
{
/// <summary>database - The database object to use for connections.</summary>
private IDbConnection database;
/// <summary>UserManager - Creates a UserManager object. During instantiation, this method will verify the table structure against the format below.</summary>
/// <param name="db">db - The database to connect to.</param>
/// <returns>A UserManager object.</returns>
public UserManager(IDbConnection db)
{
database = db;
var table = new SqlTable("Users",
new SqlColumn("ID", MySqlDbType.Int32) {Primary = true, AutoIncrement = true},
new SqlColumn("Username", MySqlDbType.VarChar, 32) {Unique = true},
new SqlColumn("Password", MySqlDbType.VarChar, 128),
new SqlColumn("UUID", MySqlDbType.VarChar, 128),
new SqlColumn("Usergroup", MySqlDbType.Text),
new SqlColumn("Registered", MySqlDbType.Text),
new SqlColumn("LastAccessed", MySqlDbType.Text),
new SqlColumn("KnownIPs", MySqlDbType.Text)
new SqlColumn("ID", MySqlDbType.Int32) {Primary = true, AutoIncrement = true},
new SqlColumn("Username", MySqlDbType.VarChar, 32) {Unique = true},
new SqlColumn("Password", MySqlDbType.VarChar, 128),
new SqlColumn("UUID", MySqlDbType.VarChar, 128),
new SqlColumn("Usergroup", MySqlDbType.Text),
new SqlColumn("Registered", MySqlDbType.Text),
new SqlColumn("LastAccessed", MySqlDbType.Text),
new SqlColumn("KnownIPs", MySqlDbType.Text)
);
var creator = new SqlTableCreator(db,
db.GetSqlType() == SqlType.Sqlite
? (IQueryBuilder) new SqliteQueryCreator()
: new MysqlQueryCreator());
db.GetSqlType() == SqlType.Sqlite
? (IQueryBuilder) new SqliteQueryCreator()
: new MysqlQueryCreator());
creator.EnsureTableStructure(table);
}
@ -67,7 +72,7 @@ namespace TShockAPI.DB
try
{
ret = database.Query("INSERT INTO Users (Username, Password, UUID, UserGroup, Registered) VALUES (@0, @1, @2, @3, @4);", user.Name,
user.Password, user.UUID, user.Group, DateTime.UtcNow.ToString("s"));
user.Password, user.UUID, user.Group, DateTime.UtcNow.ToString("s"));
}
catch (Exception ex)
{
@ -173,19 +178,24 @@ namespace TShockAPI.DB
}
}
public void UpdateLogin(User user)
{
try
{
if (database.Query("UPDATE Users SET LastAccessed = @0, KnownIps = @1 WHERE Username = @2;", DateTime.UtcNow.ToString("s"), user.KnownIps, user.Name) == 0)
throw new UserNotExistException(user.Name);
}
catch (Exception ex)
{
throw new UserManagerException("UpdateLogin SQL returned an error", ex);
}
}
/// <summary>UpdateLogin - Updates the last accessed time for a database user to the current time.</summary>
/// <param name="user">user - The user object to modify.</param>
public void UpdateLogin(User user)
{
try
{
if (database.Query("UPDATE Users SET LastAccessed = @0, KnownIps = @1 WHERE Username = @2;", DateTime.UtcNow.ToString("s"), user.KnownIps, user.Name) == 0)
throw new UserNotExistException(user.Name);
}
catch (Exception ex)
{
throw new UserManagerException("UpdateLogin SQL returned an error", ex);
}
}
/// <summary>GetUserID - Gets the database ID of a given user object from the database.</summary>
/// <param name="username">username - The username of the user to query for.</param>
/// <returns>int - The user's ID</returns>
public int GetUserID(string username)
{
try
@ -205,6 +215,9 @@ namespace TShockAPI.DB
return -1;
}
/// <summary>GetUserByName - Gets a user object by name.</summary>
/// <param name="name">name - The user's name.</param>
/// <returns>User - The user object returned from the search.</returns>
public User GetUserByName(string name)
{
try
@ -217,6 +230,9 @@ namespace TShockAPI.DB
}
}
/// <summary>GetUserByID - Gets a user object by their user ID.</summary>
/// <param name="id">id - The user's ID.</param>
/// <returns>User - The user object returned from the search.</returns>
public User GetUserByID(int id)
{
try
@ -229,6 +245,9 @@ namespace TShockAPI.DB
}
}
/// <summary>GetUser - Gets a user object by a user object.</summary>
/// <param name="user">user - The user object to search by.</param>
/// <returns>User - The user object that is returned from the search.</returns>
public User GetUser(User user)
{
bool multiple = false;
@ -272,6 +291,8 @@ namespace TShockAPI.DB
throw new UserNotExistException(user.Name);
}
/// <summary>GetUsers - Gets all users from the database.</summary>
/// <returns>List - The users from the database.</returns>
public List<User> GetUsers()
{
try
@ -293,31 +314,60 @@ namespace TShockAPI.DB
return null;
}
/// <summary>LoadUserFromResult - Fills out the fields of a User object with the results from a QueryResult object.</summary>
/// <param name="user">user - The user to add data to.</param>
/// <param name="result">result - The QueryResult object to add data from.</param>
/// <returns>User - The 'filled out' user object.</returns>
private User LoadUserFromResult(User user, QueryResult result)
{
user.ID = result.Get<int>("ID");
user.Group = result.Get<string>("Usergroup");
user.Password = result.Get<string>("Password");
user.UUID = result.Get<string>("UUID");
user.UUID = result.Get<string>("UUID");
user.Name = result.Get<string>("Username");
user.Registered = result.Get<string>("Registered");
user.LastAccessed = result.Get<string>("LastAccessed");
user.KnownIps = result.Get<string>("KnownIps");
user.LastAccessed = result.Get<string>("LastAccessed");
user.KnownIps = result.Get<string>("KnownIps");
return user;
}
}
/// <summary>User - A database user.</summary>
public class User
{
/// <summary>ID - The database ID of the user.</summary>
public int ID { get; set; }
/// <summary>Name - The user's name.</summary>
public string Name { get; set; }
/// <summary>Password - The hashed password for the user.</summary>
public string Password { get; internal set; }
/// <summary>UUID - The user's saved Univerally Unique Identifier token.</summary>
public string UUID { get; set; }
/// <summary>Group - The group object that the user is a part of.</summary>
public string Group { get; set; }
/// <summary>Registered - The unix epoch corresponding to the registration date of the user.</summary>
public string Registered { get; set; }
/// <summary>LastAccessed - The unix epoch corresponding to the last access date of the user.</summary>
public string LastAccessed { get; set; }
/// <summary>KnownIps - A JSON serialized list of known IP addresses for a user.</summary>
public string KnownIps { get; set; }
/// <summary>User - Constructor for the user object, assuming you define everything yourself.</summary>
/// <param name="name">name - The user's name.</param>
/// <param name="pass">pass - The user's password hash.</param>
/// <param name="uuid">uuid - The user's UUID.</param>
/// <param name="group">group - The user's group name.</param>
/// <param name="registered">registered - The unix epoch for the registration date.</param>
/// <param name="last">last - The unix epoch for the last access date.</param>
/// <param name="known">known - The known IPs for the user, serialized as a JSON object</param>
/// <returns>A completed user object.</returns>
public User(string name, string pass, string uuid, string group, string registered, string last, string known)
{
Name = name;
@ -329,6 +379,8 @@ namespace TShockAPI.DB
KnownIps = known;
}
/// <summary>User - Default constructor for a user object; holds no data.</summary>
/// <returns>A user object.</returns>
public User()
{
Name = "";
@ -517,41 +569,61 @@ namespace TShockAPI.DB
}
/// <summary>UserManagerException - An exception generated by the user manager.</summary>
[Serializable]
public class UserManagerException : Exception
{
/// <summary>UserManagerException - Creates a new UserManagerException object.</summary>
/// <param name="message">message - The message for the object.</param>
/// <returns>public - a new UserManagerException object.</returns>
public UserManagerException(string message)
: base(message)
{
}
/// <summary>UserManagerException - Creates a new UserManagerObject with an internal exception.</summary>
/// <param name="message">message - The message for the object.</param>
/// <param name="inner">inner - The inner exception for the object.</param>
/// <returns>public - a nwe UserManagerException with a defined inner exception.</returns>
public UserManagerException(string message, Exception inner)
: base(message, inner)
{
}
}
/// <summary>UserExistsException - A UserExistsException object, used when a user already exists when attempting to create a new one.</summary>
[Serializable]
public class UserExistsException : UserManagerException
{
/// <summary>UserExistsException - Creates a new UserExistsException object.</summary>
/// <param name="name">name - The name of the user that already exists.</param>
/// <returns>public - a UserExistsException object with the user's name passed in the message.</returns>
public UserExistsException(string name)
: base("User '" + name + "' already exists")
{
}
}
/// <summary>UserNotExistException - A UserNotExistException, used when a user does not exist and a query failed as a result of it.</summary>
[Serializable]
public class UserNotExistException : UserManagerException
{
/// <summary>UserNotExistException - Creates a new UserNotExistException object, with the user's name in the message.</summary>
/// <param name="name">name - The user's name to be pasesd in the message.</param>
/// <returns>public - a new UserNotExistException object with a message containing the user's name that does not exist.</returns>
public UserNotExistException(string name)
: base("User '" + name + "' does not exist")
{
}
}
/// <summary>GroupNotExistsException - A GroupNotExistsException, used when a group does not exist.</summary>
[Serializable]
public class GroupNotExistsException : UserManagerException
{
/// <summary>GroupNotExistsException - Creates a new GroupNotExistsException object with the group's name in the message.</summary>
/// <param name="group">group - The group name.</param>
/// <returns>public - a new GroupNotExistsException with the group that does not exist's name in the message.</returns>
public GroupNotExistsException(string group)
: base("Group '" + group + "' does not exist")
{