From 084411f84761f336ed10a780f6a5c1b33d6c6529 Mon Sep 17 00:00:00 2001 From: Sakura Akeno Isayeki Date: Mon, 28 Apr 2025 15:50:55 +0200 Subject: [PATCH] refactor(db): Update SqlQueryBuilder references + Various refactors Consolidates the creation of SQL query builders across multiple classes to ensure a unified approach for database operations. Replaces manual type checks and specific query creators with a generic method for better maintainability and to prevent errors. Improves code readability and reduces duplication, facilitating easier updates in the future. --- TShockAPI/DB/BanManager.cs | 135 +++++++++++----------- TShockAPI/DB/CharacterManager.cs | 114 +++++++++---------- TShockAPI/DB/GroupManager.cs | 161 +++++++++++++-------------- TShockAPI/DB/ItemManager.cs | 55 ++++----- TShockAPI/DB/ProjectileManager.cs | 52 +++------ TShockAPI/DB/RegionManager.cs | 133 +++++++++------------- TShockAPI/DB/RememberedPosManager.cs | 35 +++--- TShockAPI/DB/ResearchDatastore.cs | 22 ++-- TShockAPI/DB/SqlTable.cs | 47 +++++--- TShockAPI/DB/SqlValue.cs | 8 +- TShockAPI/DB/TileManager.cs | 26 ++--- TShockAPI/DB/UserManager.cs | 53 ++++----- TShockAPI/DB/WarpsManager.cs | 30 +++-- TShockAPI/Extensions/DbExt.cs | 9 ++ TShockAPI/SqlLog.cs | 7 +- 15 files changed, 399 insertions(+), 488 deletions(-) diff --git a/TShockAPI/DB/BanManager.cs b/TShockAPI/DB/BanManager.cs index be05b45c..c56e3d0d 100644 --- a/TShockAPI/DB/BanManager.cs +++ b/TShockAPI/DB/BanManager.cs @@ -69,10 +69,9 @@ namespace TShockAPI.DB new SqlColumn("Date", MySqlDbType.Int64), new SqlColumn("Expiration", MySqlDbType.Int64) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder)new SqliteQueryCreator() - : new MysqlQueryCreator()); + + var creator = new SqlTableCreator(db, db.GetSqlQueryBuilder()); + try { creator.EnsureTableStructure(table); @@ -106,15 +105,12 @@ namespace TShockAPI.DB /// public void TryConvertBans() { - int res; - if (database.GetSqlType() == SqlType.Mysql) + int res = database.GetSqlType() switch { - res = database.QueryScalar("SELECT COUNT(table_name) FROM information_schema.tables WHERE table_schema = @0 and table_name = 'Bans'", TShock.Config.Settings.MySqlDbName); - } - else - { - res = database.QueryScalar("SELECT COUNT(name) FROM sqlite_master WHERE type='table' AND name = 'Bans'"); - } + SqlType.Mysql => database.QueryScalar("SELECT COUNT(table_name) FROM information_schema.tables WHERE table_schema = @0 and table_name = 'Bans'", TShock.Config.Settings.MySqlDbName), + SqlType.Sqlite => database.QueryScalar("SELECT COUNT(name) FROM sqlite_master WHERE type='table' AND name = 'Bans'"), + SqlType.Postgres => database.QueryScalar("SELECT COUNT(table_name) FROM information_schema.tables WHERE table_name = 'Bans'"), + }; if (res != 0) { @@ -301,16 +297,13 @@ namespace TShockAPI.DB return new AddBanResult { Message = message }; } - string query = "INSERT INTO PlayerBans (Identifier, Reason, BanningUser, Date, Expiration) VALUES (@0, @1, @2, @3, @4);"; - - if (database.GetSqlType() == SqlType.Mysql) + string query = "INSERT INTO PlayerBans (Identifier, Reason, BanningUser, Date, Expiration) VALUES (@0, @1, @2, @3, @4)" + database.GetSqlType() switch { - query += "SELECT LAST_INSERT_ID();"; - } - else - { - query += "SELECT CAST(last_insert_rowid() as INT);"; - } + SqlType.Mysql => /*lang=mysql*/"; SELECT LAST_INSERT_ID();", + SqlType.Sqlite => /*lang=sqlite*/"; SELECT last_insert_rowid();", + SqlType.Postgres => /*lang=postgresql*/"RETURNING \"Identifier\";", + _ => null + }; int ticketId = database.QueryScalar(query, args.Identifier, args.Reason, args.BanningUser, args.BanDateTime.Ticks, args.ExpirationDateTime.Ticks); @@ -362,19 +355,18 @@ namespace TShockAPI.DB return Bans[id]; } - using (var reader = database.QueryReader("SELECT * FROM PlayerBans WHERE TicketNumber=@0", id)) - { - if (reader.Read()) - { - var ticketNumber = reader.Get("TicketNumber"); - var identifier = reader.Get("Identifier"); - var reason = reader.Get("Reason"); - var banningUser = reader.Get("BanningUser"); - var date = reader.Get("Date"); - var expiration = reader.Get("Expiration"); + using var reader = database.QueryReader("SELECT * FROM PlayerBans WHERE TicketNumber=@0", id); - return new Ban(ticketNumber, identifier, reason, banningUser, date, expiration); - } + if (reader.Read()) + { + var ticketNumber = reader.Get("TicketNumber"); + var identifier = reader.Get("Identifier"); + var reason = reader.Get("Reason"); + var banningUser = reader.Get("BanningUser"); + var date = reader.Get("Date"); + var expiration = reader.Get("Expiration"); + + return new Ban(ticketNumber, identifier, reason, banningUser, date, expiration); } return null; @@ -394,19 +386,18 @@ namespace TShockAPI.DB query += $" AND Expiration > {DateTime.UtcNow.Ticks}"; } - using (var reader = database.QueryReader(query, identifier)) - { - while (reader.Read()) - { - var ticketNumber = reader.Get("TicketNumber"); - var ident = reader.Get("Identifier"); - var reason = reader.Get("Reason"); - var banningUser = reader.Get("BanningUser"); - var date = reader.Get("Date"); - var expiration = reader.Get("Expiration"); + using var reader = database.QueryReader(query, identifier); - yield return new Ban(ticketNumber, ident, reason, banningUser, date, expiration); - } + while (reader.Read()) + { + var ticketNumber = reader.Get("TicketNumber"); + var ident = reader.Get("Identifier"); + var reason = reader.Get("Reason"); + var banningUser = reader.Get("BanningUser"); + var date = reader.Get("Date"); + var expiration = reader.Get("Expiration"); + + yield return new Ban(ticketNumber, ident, reason, banningUser, date, expiration); } } @@ -419,27 +410,27 @@ namespace TShockAPI.DB public IEnumerable GetBansByIdentifiers(bool currentOnly = true, params string[] identifiers) { //Generate a sequence of '@0, @1, @2, ... etc' - var parameters = string.Join(", ", Enumerable.Range(0, identifiers.Count()).Select(p => $"@{p}")); + var parameters = string.Join(", ", Enumerable.Range(0, identifiers.Length).Select(p => $"@{p}")); string query = $"SELECT * FROM PlayerBans WHERE Identifier IN ({parameters})"; + if (currentOnly) { query += $" AND Expiration > {DateTime.UtcNow.Ticks}"; } - using (var reader = database.QueryReader(query, identifiers)) - { - while (reader.Read()) - { - var ticketNumber = reader.Get("TicketNumber"); - var identifier = reader.Get("Identifier"); - var reason = reader.Get("Reason"); - var banningUser = reader.Get("BanningUser"); - var date = reader.Get("Date"); - var expiration = reader.Get("Expiration"); + using var reader = database.QueryReader(query, identifiers); - yield return new Ban(ticketNumber, identifier, reason, banningUser, date, expiration); - } + while (reader.Read()) + { + var ticketNumber = reader.Get("TicketNumber"); + var identifier = reader.Get("Identifier"); + var reason = reader.Get("Reason"); + var banningUser = reader.Get("BanningUser"); + var date = reader.Get("Date"); + var expiration = reader.Get("Expiration"); + + yield return new Ban(ticketNumber, identifier, reason, banningUser, date, expiration); } } @@ -458,21 +449,19 @@ namespace TShockAPI.DB List banlist = new List(); try { - var orderBy = SortToOrderByMap[sortMethod]; - using (var reader = database.QueryReader($"SELECT * FROM PlayerBans ORDER BY {orderBy}")) - { - while (reader.Read()) - { - var ticketNumber = reader.Get("TicketNumber"); - var identifier = reader.Get("Identifier"); - var reason = reader.Get("Reason"); - var banningUser = reader.Get("BanningUser"); - var date = reader.Get("Date"); - var expiration = reader.Get("Expiration"); + using var reader = database.QueryReader($"SELECT * FROM PlayerBans ORDER BY {SortToOrderByMap[sortMethod]}"); - var ban = new Ban(ticketNumber, identifier, reason, banningUser, date, expiration); - banlist.Add(ban); - } + while (reader.Read()) + { + var ticketNumber = reader.Get("TicketNumber"); + var identifier = reader.Get("Identifier"); + var reason = reader.Get("Reason"); + var banningUser = reader.Get("BanningUser"); + var date = reader.Get("Date"); + var expiration = reader.Get("Expiration"); + + var ban = new Ban(ticketNumber, identifier, reason, banningUser, date, expiration); + banlist.Add(ban); } } catch (Exception ex) @@ -501,7 +490,7 @@ namespace TShockAPI.DB return false; } - internal Dictionary SortToOrderByMap = new Dictionary + private readonly Dictionary SortToOrderByMap = new() { { BanSortMethod.AddedNewestToOldest, "Date DESC" }, { BanSortMethod.AddedOldestToNewest, "Date ASC" }, diff --git a/TShockAPI/DB/CharacterManager.cs b/TShockAPI/DB/CharacterManager.cs index be09da1d..3b9890a3 100644 --- a/TShockAPI/DB/CharacterManager.cs +++ b/TShockAPI/DB/CharacterManager.cs @@ -71,10 +71,8 @@ namespace TShockAPI.DB new SqlColumn("unlockedSuperCart", MySqlDbType.Int32), new SqlColumn("enabledSuperCart", MySqlDbType.Int32) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); } @@ -84,59 +82,57 @@ namespace TShockAPI.DB try { - using (var reader = database.QueryReader("SELECT * FROM tsCharacter WHERE Account=@0", acctid)) + using var reader = database.QueryReader("SELECT * FROM tsCharacter WHERE Account=@0", acctid); + if (reader.Read()) { - if (reader.Read()) + playerData.exists = true; + playerData.health = reader.Get("Health"); + playerData.maxHealth = reader.Get("MaxHealth"); + playerData.mana = reader.Get("Mana"); + playerData.maxMana = reader.Get("MaxMana"); + List inventory = reader.Get("Inventory").Split('~').Select(NetItem.Parse).ToList(); + if (inventory.Count < NetItem.MaxInventory) { - playerData.exists = true; - playerData.health = reader.Get("Health"); - playerData.maxHealth = reader.Get("MaxHealth"); - playerData.mana = reader.Get("Mana"); - playerData.maxMana = reader.Get("MaxMana"); - List inventory = reader.Get("Inventory").Split('~').Select(NetItem.Parse).ToList(); - if (inventory.Count < NetItem.MaxInventory) - { - //TODO: unhardcode this - stop using magic numbers and use NetItem numbers - //Set new armour slots empty - inventory.InsertRange(67, new NetItem[2]); - //Set new vanity slots empty - inventory.InsertRange(77, new NetItem[2]); - //Set new dye slots empty - inventory.InsertRange(87, new NetItem[2]); - //Set the rest of the new slots empty - inventory.AddRange(new NetItem[NetItem.MaxInventory - inventory.Count]); - } - playerData.inventory = inventory.ToArray(); - playerData.extraSlot = reader.Get("extraSlot"); - playerData.spawnX = reader.Get("spawnX"); - playerData.spawnY = reader.Get("spawnY"); - playerData.skinVariant = reader.Get("skinVariant"); - playerData.hair = reader.Get("hair"); - playerData.hairDye = (byte)reader.Get("hairDye"); - playerData.hairColor = TShock.Utils.DecodeColor(reader.Get("hairColor")); - playerData.pantsColor = TShock.Utils.DecodeColor(reader.Get("pantsColor")); - playerData.shirtColor = TShock.Utils.DecodeColor(reader.Get("shirtColor")); - playerData.underShirtColor = TShock.Utils.DecodeColor(reader.Get("underShirtColor")); - playerData.shoeColor = TShock.Utils.DecodeColor(reader.Get("shoeColor")); - playerData.hideVisuals = TShock.Utils.DecodeBoolArray(reader.Get("hideVisuals")); - playerData.skinColor = TShock.Utils.DecodeColor(reader.Get("skinColor")); - playerData.eyeColor = TShock.Utils.DecodeColor(reader.Get("eyeColor")); - playerData.questsCompleted = reader.Get("questsCompleted"); - playerData.usingBiomeTorches = reader.Get("usingBiomeTorches"); - playerData.happyFunTorchTime = reader.Get("happyFunTorchTime"); - playerData.unlockedBiomeTorches = reader.Get("unlockedBiomeTorches"); - playerData.currentLoadoutIndex = reader.Get("currentLoadoutIndex"); - playerData.ateArtisanBread = reader.Get("ateArtisanBread"); - playerData.usedAegisCrystal = reader.Get("usedAegisCrystal"); - playerData.usedAegisFruit = reader.Get("usedAegisFruit"); - playerData.usedArcaneCrystal = reader.Get("usedArcaneCrystal"); - playerData.usedGalaxyPearl = reader.Get("usedGalaxyPearl"); - playerData.usedGummyWorm = reader.Get("usedGummyWorm"); - playerData.usedAmbrosia = reader.Get("usedAmbrosia"); - playerData.unlockedSuperCart = reader.Get("unlockedSuperCart"); - playerData.enabledSuperCart = reader.Get("enabledSuperCart"); - return playerData; + //TODO: unhardcode this - stop using magic numbers and use NetItem numbers + //Set new armour slots empty + inventory.InsertRange(67, new NetItem[2]); + //Set new vanity slots empty + inventory.InsertRange(77, new NetItem[2]); + //Set new dye slots empty + inventory.InsertRange(87, new NetItem[2]); + //Set the rest of the new slots empty + inventory.AddRange(new NetItem[NetItem.MaxInventory - inventory.Count]); } + playerData.inventory = inventory.ToArray(); + playerData.extraSlot = reader.Get("extraSlot"); + playerData.spawnX = reader.Get("spawnX"); + playerData.spawnY = reader.Get("spawnY"); + playerData.skinVariant = reader.Get("skinVariant"); + playerData.hair = reader.Get("hair"); + playerData.hairDye = (byte)reader.Get("hairDye"); + playerData.hairColor = TShock.Utils.DecodeColor(reader.Get("hairColor")); + playerData.pantsColor = TShock.Utils.DecodeColor(reader.Get("pantsColor")); + playerData.shirtColor = TShock.Utils.DecodeColor(reader.Get("shirtColor")); + playerData.underShirtColor = TShock.Utils.DecodeColor(reader.Get("underShirtColor")); + playerData.shoeColor = TShock.Utils.DecodeColor(reader.Get("shoeColor")); + playerData.hideVisuals = TShock.Utils.DecodeBoolArray(reader.Get("hideVisuals")); + playerData.skinColor = TShock.Utils.DecodeColor(reader.Get("skinColor")); + playerData.eyeColor = TShock.Utils.DecodeColor(reader.Get("eyeColor")); + playerData.questsCompleted = reader.Get("questsCompleted"); + playerData.usingBiomeTorches = reader.Get("usingBiomeTorches"); + playerData.happyFunTorchTime = reader.Get("happyFunTorchTime"); + playerData.unlockedBiomeTorches = reader.Get("unlockedBiomeTorches"); + playerData.currentLoadoutIndex = reader.Get("currentLoadoutIndex"); + playerData.ateArtisanBread = reader.Get("ateArtisanBread"); + playerData.usedAegisCrystal = reader.Get("usedAegisCrystal"); + playerData.usedAegisFruit = reader.Get("usedAegisFruit"); + playerData.usedArcaneCrystal = reader.Get("usedArcaneCrystal"); + playerData.usedGalaxyPearl = reader.Get("usedGalaxyPearl"); + playerData.usedGummyWorm = reader.Get("usedGummyWorm"); + playerData.usedAmbrosia = reader.Get("usedAmbrosia"); + playerData.unlockedSuperCart = reader.Get("unlockedSuperCart"); + playerData.enabledSuperCart = reader.Get("enabledSuperCart"); + return playerData; } } catch (Exception ex) @@ -155,7 +151,7 @@ namespace TShockAPI.DB if (items.Count < NetItem.MaxInventory) items.AddRange(new NetItem[NetItem.MaxInventory - items.Count]); - string initialItems = String.Join("~", items.Take(NetItem.MaxInventory)); + string initialItems = string.Join("~", items.Take(NetItem.MaxInventory)); try { database.Query("INSERT INTO tsCharacter (Account, Health, MaxHealth, Mana, MaxMana, Inventory, spawnX, spawnY, questsCompleted) VALUES (@0, @1, @2, @3, @4, @5, @6, @7, @8);", @@ -205,7 +201,7 @@ namespace TShockAPI.DB { database.Query( "INSERT INTO tsCharacter (Account, Health, MaxHealth, Mana, MaxMana, Inventory, extraSlot, spawnX, spawnY, skinVariant, hair, hairDye, hairColor, pantsColor, shirtColor, underShirtColor, shoeColor, hideVisuals, skinColor, eyeColor, questsCompleted, usingBiomeTorches, happyFunTorchTime, unlockedBiomeTorches, currentLoadoutIndex,ateArtisanBread, usedAegisCrystal, usedAegisFruit, usedArcaneCrystal, usedGalaxyPearl, usedGummyWorm, usedAmbrosia, unlockedSuperCart, enabledSuperCart) VALUES (@0, @1, @2, @3, @4, @5, @6, @7, @8, @9, @10, @11, @12, @13, @14, @15, @16, @17, @18, @19, @20, @21, @22, @23, @24, @25, @26, @27, @28, @29, @30, @31, @32, @33);", - player.Account.ID, playerData.health, playerData.maxHealth, playerData.mana, playerData.maxMana, String.Join("~", playerData.inventory), playerData.extraSlot, player.TPlayer.SpawnX, player.TPlayer.SpawnY, player.TPlayer.skinVariant, player.TPlayer.hair, player.TPlayer.hairDye, TShock.Utils.EncodeColor(player.TPlayer.hairColor), TShock.Utils.EncodeColor(player.TPlayer.pantsColor),TShock.Utils.EncodeColor(player.TPlayer.shirtColor), TShock.Utils.EncodeColor(player.TPlayer.underShirtColor), TShock.Utils.EncodeColor(player.TPlayer.shoeColor), TShock.Utils.EncodeBoolArray(player.TPlayer.hideVisibleAccessory), TShock.Utils.EncodeColor(player.TPlayer.skinColor),TShock.Utils.EncodeColor(player.TPlayer.eyeColor), player.TPlayer.anglerQuestsFinished, player.TPlayer.UsingBiomeTorches ? 1 : 0, player.TPlayer.happyFunTorchTime ? 1 : 0, player.TPlayer.unlockedBiomeTorches ? 1 : 0, player.TPlayer.CurrentLoadoutIndex, player.TPlayer.ateArtisanBread ? 1 : 0, player.TPlayer.usedAegisCrystal ? 1 : 0, player.TPlayer.usedAegisFruit ? 1 : 0, player.TPlayer.usedArcaneCrystal ? 1 : 0, player.TPlayer.usedGalaxyPearl ? 1 : 0, player.TPlayer.usedGummyWorm ? 1 : 0, player.TPlayer.usedAmbrosia ? 1 : 0, player.TPlayer.unlockedSuperCart ? 1 : 0, player.TPlayer.enabledSuperCart ? 1 : 0); + player.Account.ID, playerData.health, playerData.maxHealth, playerData.mana, playerData.maxMana, string.Join("~", playerData.inventory), playerData.extraSlot, player.TPlayer.SpawnX, player.TPlayer.SpawnY, player.TPlayer.skinVariant, player.TPlayer.hair, player.TPlayer.hairDye, TShock.Utils.EncodeColor(player.TPlayer.hairColor), TShock.Utils.EncodeColor(player.TPlayer.pantsColor),TShock.Utils.EncodeColor(player.TPlayer.shirtColor), TShock.Utils.EncodeColor(player.TPlayer.underShirtColor), TShock.Utils.EncodeColor(player.TPlayer.shoeColor), TShock.Utils.EncodeBoolArray(player.TPlayer.hideVisibleAccessory), TShock.Utils.EncodeColor(player.TPlayer.skinColor),TShock.Utils.EncodeColor(player.TPlayer.eyeColor), player.TPlayer.anglerQuestsFinished, player.TPlayer.UsingBiomeTorches ? 1 : 0, player.TPlayer.happyFunTorchTime ? 1 : 0, player.TPlayer.unlockedBiomeTorches ? 1 : 0, player.TPlayer.CurrentLoadoutIndex, player.TPlayer.ateArtisanBread ? 1 : 0, player.TPlayer.usedAegisCrystal ? 1 : 0, player.TPlayer.usedAegisFruit ? 1 : 0, player.TPlayer.usedArcaneCrystal ? 1 : 0, player.TPlayer.usedGalaxyPearl ? 1 : 0, player.TPlayer.usedGummyWorm ? 1 : 0, player.TPlayer.usedAmbrosia ? 1 : 0, player.TPlayer.unlockedSuperCart ? 1 : 0, player.TPlayer.enabledSuperCart ? 1 : 0); return true; } catch (Exception ex) @@ -219,7 +215,7 @@ namespace TShockAPI.DB { database.Query( "UPDATE tsCharacter SET Health = @0, MaxHealth = @1, Mana = @2, MaxMana = @3, Inventory = @4, spawnX = @6, spawnY = @7, hair = @8, hairDye = @9, hairColor = @10, pantsColor = @11, shirtColor = @12, underShirtColor = @13, shoeColor = @14, hideVisuals = @15, skinColor = @16, eyeColor = @17, questsCompleted = @18, skinVariant = @19, extraSlot = @20, usingBiomeTorches = @21, happyFunTorchTime = @22, unlockedBiomeTorches = @23, currentLoadoutIndex = @24, ateArtisanBread = @25, usedAegisCrystal = @26, usedAegisFruit = @27, usedArcaneCrystal = @28, usedGalaxyPearl = @29, usedGummyWorm = @30, usedAmbrosia = @31, unlockedSuperCart = @32, enabledSuperCart = @33 WHERE Account = @5;", - playerData.health, playerData.maxHealth, playerData.mana, playerData.maxMana, String.Join("~", playerData.inventory), player.Account.ID, player.TPlayer.SpawnX, player.TPlayer.SpawnY, player.TPlayer.hair, player.TPlayer.hairDye, TShock.Utils.EncodeColor(player.TPlayer.hairColor), TShock.Utils.EncodeColor(player.TPlayer.pantsColor), TShock.Utils.EncodeColor(player.TPlayer.shirtColor), TShock.Utils.EncodeColor(player.TPlayer.underShirtColor), TShock.Utils.EncodeColor(player.TPlayer.shoeColor), TShock.Utils.EncodeBoolArray(player.TPlayer.hideVisibleAccessory), TShock.Utils.EncodeColor(player.TPlayer.skinColor), TShock.Utils.EncodeColor(player.TPlayer.eyeColor), player.TPlayer.anglerQuestsFinished, player.TPlayer.skinVariant, player.TPlayer.extraAccessory ? 1 : 0, player.TPlayer.UsingBiomeTorches ? 1 : 0, player.TPlayer.happyFunTorchTime ? 1 : 0, player.TPlayer.unlockedBiomeTorches ? 1 : 0, player.TPlayer.CurrentLoadoutIndex, player.TPlayer.ateArtisanBread ? 1 : 0, player.TPlayer.usedAegisCrystal ? 1 : 0, player.TPlayer.usedAegisFruit ? 1 : 0, player.TPlayer.usedArcaneCrystal ? 1 : 0, player.TPlayer.usedGalaxyPearl ? 1 : 0, player.TPlayer.usedGummyWorm ? 1 : 0, player.TPlayer.usedAmbrosia ? 1 : 0, player.TPlayer.unlockedSuperCart ? 1 : 0, player.TPlayer.enabledSuperCart ? 1 : 0); + playerData.health, playerData.maxHealth, playerData.mana, playerData.maxMana, string.Join("~", playerData.inventory), player.Account.ID, player.TPlayer.SpawnX, player.TPlayer.SpawnY, player.TPlayer.hair, player.TPlayer.hairDye, TShock.Utils.EncodeColor(player.TPlayer.hairColor), TShock.Utils.EncodeColor(player.TPlayer.pantsColor), TShock.Utils.EncodeColor(player.TPlayer.shirtColor), TShock.Utils.EncodeColor(player.TPlayer.underShirtColor), TShock.Utils.EncodeColor(player.TPlayer.shoeColor), TShock.Utils.EncodeBoolArray(player.TPlayer.hideVisibleAccessory), TShock.Utils.EncodeColor(player.TPlayer.skinColor), TShock.Utils.EncodeColor(player.TPlayer.eyeColor), player.TPlayer.anglerQuestsFinished, player.TPlayer.skinVariant, player.TPlayer.extraAccessory ? 1 : 0, player.TPlayer.UsingBiomeTorches ? 1 : 0, player.TPlayer.happyFunTorchTime ? 1 : 0, player.TPlayer.unlockedBiomeTorches ? 1 : 0, player.TPlayer.CurrentLoadoutIndex, player.TPlayer.ateArtisanBread ? 1 : 0, player.TPlayer.usedAegisCrystal ? 1 : 0, player.TPlayer.usedAegisFruit ? 1 : 0, player.TPlayer.usedArcaneCrystal ? 1 : 0, player.TPlayer.usedGalaxyPearl ? 1 : 0, player.TPlayer.usedGummyWorm ? 1 : 0, player.TPlayer.usedAmbrosia ? 1 : 0, player.TPlayer.unlockedSuperCart ? 1 : 0, player.TPlayer.enabledSuperCart ? 1 : 0); return true; } catch (Exception ex) @@ -280,7 +276,7 @@ namespace TShockAPI.DB playerData.maxHealth, playerData.mana, playerData.maxMana, - String.Join("~", playerData.inventory), + string.Join("~", playerData.inventory), playerData.extraSlot, playerData.spawnX, playerData.spawnX, @@ -326,7 +322,7 @@ namespace TShockAPI.DB playerData.maxHealth, playerData.mana, playerData.maxMana, - String.Join("~", playerData.inventory), + string.Join("~", playerData.inventory), player.Account.ID, playerData.spawnX, playerData.spawnX, diff --git a/TShockAPI/DB/GroupManager.cs b/TShockAPI/DB/GroupManager.cs index 5d32419e..553a1a33 100644 --- a/TShockAPI/DB/GroupManager.cs +++ b/TShockAPI/DB/GroupManager.cs @@ -51,10 +51,9 @@ namespace TShockAPI.DB new SqlColumn("Prefix", MySqlDbType.Text), new SqlColumn("Suffix", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder)new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); + if (creator.EnsureTableStructure(table)) { // Add default groups if they don't exist @@ -294,7 +293,7 @@ namespace TShockAPI.DB /// parent of group /// permissions /// chatcolor - public void AddGroup(String name, string parentname, String permissions, String chatcolor) + public void AddGroup(string name, string parentname, string permissions, string chatcolor) { if (GroupExists(name)) { @@ -383,7 +382,7 @@ namespace TShockAPI.DB /// The group's name. /// The new name. /// The result from the operation to be sent back to the user. - public String RenameGroup(string name, string newName) + public string RenameGroup(string name, string newName) { if (!GroupExists(name)) { @@ -395,87 +394,83 @@ namespace TShockAPI.DB throw new GroupExistsException(newName); } - using (var db = database.CloneEx()) + using var db = database.CloneEx(); + db.Open(); + using var transaction = db.BeginTransaction(); + try { - db.Open(); - using (var transaction = db.BeginTransaction()) + using (var command = db.CreateCommand()) { - try - { - using (var command = db.CreateCommand()) - { - command.CommandText = "UPDATE GroupList SET GroupName = @0 WHERE GroupName = @1"; - command.AddParameter("@0", newName); - command.AddParameter("@1", name); - command.ExecuteNonQuery(); - } + command.CommandText = "UPDATE GroupList SET GroupName = @0 WHERE GroupName = @1"; + command.AddParameter("@0", newName); + command.AddParameter("@1", name); + command.ExecuteNonQuery(); + } - var oldGroup = GetGroupByName(name); - var newGroup = new Group(newName, oldGroup.Parent, oldGroup.ChatColor, oldGroup.Permissions) - { - Prefix = oldGroup.Prefix, - Suffix = oldGroup.Suffix - }; - groups.Remove(oldGroup); - groups.Add(newGroup); + var oldGroup = GetGroupByName(name); + var newGroup = new Group(newName, oldGroup.Parent, oldGroup.ChatColor, oldGroup.Permissions) + { + Prefix = oldGroup.Prefix, + Suffix = oldGroup.Suffix + }; + groups.Remove(oldGroup); + groups.Add(newGroup); - // We need to check if the old group has been referenced as a parent and update those references accordingly - using (var command = db.CreateCommand()) - { - command.CommandText = "UPDATE GroupList SET Parent = @0 WHERE Parent = @1"; - command.AddParameter("@0", newName); - command.AddParameter("@1", name); - command.ExecuteNonQuery(); - } - foreach (var group in groups.Where(g => g.Parent != null && g.Parent == oldGroup)) - { - group.Parent = newGroup; - } + // We need to check if the old group has been referenced as a parent and update those references accordingly + using (var command = db.CreateCommand()) + { + command.CommandText = "UPDATE GroupList SET Parent = @0 WHERE Parent = @1"; + command.AddParameter("@0", newName); + command.AddParameter("@1", name); + command.ExecuteNonQuery(); + } + foreach (var group in groups.Where(g => g.Parent != null && g.Parent == oldGroup)) + { + group.Parent = newGroup; + } - // Read the config file to prevent the possible loss of any unsaved changes - TShock.Config.Read(FileTools.ConfigPath, out bool writeConfig); - if (TShock.Config.Settings.DefaultGuestGroupName == oldGroup.Name) - { - TShock.Config.Settings.DefaultGuestGroupName = newGroup.Name; - Group.DefaultGroup = newGroup; - } - if (TShock.Config.Settings.DefaultRegistrationGroupName == oldGroup.Name) - { - TShock.Config.Settings.DefaultRegistrationGroupName = newGroup.Name; - } - if (writeConfig) - { - TShock.Config.Write(FileTools.ConfigPath); - } + // Read the config file to prevent the possible loss of any unsaved changes + TShock.Config.Read(FileTools.ConfigPath, out bool writeConfig); + if (TShock.Config.Settings.DefaultGuestGroupName == oldGroup.Name) + { + TShock.Config.Settings.DefaultGuestGroupName = newGroup.Name; + Group.DefaultGroup = newGroup; + } + if (TShock.Config.Settings.DefaultRegistrationGroupName == oldGroup.Name) + { + TShock.Config.Settings.DefaultRegistrationGroupName = newGroup.Name; + } + if (writeConfig) + { + TShock.Config.Write(FileTools.ConfigPath); + } - // We also need to check if any users belong to the old group and automatically apply changes - using (var command = db.CreateCommand()) - { - command.CommandText = "UPDATE Users SET Usergroup = @0 WHERE Usergroup = @1"; - command.AddParameter("@0", newName); - command.AddParameter("@1", name); - command.ExecuteNonQuery(); - } - foreach (var player in TShock.Players.Where(p => p?.Group == oldGroup)) - { - player.Group = newGroup; - } + // We also need to check if any users belong to the old group and automatically apply changes + using (var command = db.CreateCommand()) + { + command.CommandText = "UPDATE Users SET Usergroup = @0 WHERE Usergroup = @1"; + command.AddParameter("@0", newName); + command.AddParameter("@1", name); + command.ExecuteNonQuery(); + } + foreach (var player in TShock.Players.Where(p => p?.Group == oldGroup)) + { + player.Group = newGroup; + } - transaction.Commit(); - return GetString($"Group {name} has been renamed to {newName}."); - } - catch (Exception ex) - { - TShock.Log.Error(GetString($"An exception has occurred during database transaction: {ex.Message}")); - try - { - transaction.Rollback(); - } - catch (Exception rollbackEx) - { - TShock.Log.Error(GetString($"An exception has occurred during database rollback: {rollbackEx.Message}")); - } - } + transaction.Commit(); + return GetString($"Group {name} has been renamed to {newName}."); + } + catch (Exception ex) + { + TShock.Log.Error(GetString($"An exception has occurred during database transaction: {ex.Message}")); + try + { + transaction.Rollback(); + } + catch (Exception rollbackEx) + { + TShock.Log.Error(GetString($"An exception has occurred during database rollback: {rollbackEx.Message}")); } } @@ -488,7 +483,7 @@ namespace TShockAPI.DB /// The group's name. /// Whether exceptions will be thrown in case something goes wrong. /// The result from the operation to be sent back to the user. - public String DeleteGroup(String name, bool exceptions = false) + public string DeleteGroup(string name, bool exceptions = false) { if (!GroupExists(name)) { @@ -521,7 +516,7 @@ namespace TShockAPI.DB /// The group name. /// The permission list. /// The result from the operation to be sent back to the user. - public String AddPermissions(String name, List permissions) + public string AddPermissions(string name, List permissions) { if (!GroupExists(name)) return GetString($"Group {name} doesn't exist."); @@ -544,7 +539,7 @@ namespace TShockAPI.DB /// The group name. /// The permission list. /// The result from the operation to be sent back to the user. - public String DeletePermissions(String name, List permissions) + public string DeletePermissions(string name, List permissions) { if (!GroupExists(name)) return GetString($"Group {name} doesn't exist."); diff --git a/TShockAPI/DB/ItemManager.cs b/TShockAPI/DB/ItemManager.cs index e707406c..e533d7c0 100644 --- a/TShockAPI/DB/ItemManager.cs +++ b/TShockAPI/DB/ItemManager.cs @@ -39,10 +39,9 @@ namespace TShockAPI.DB new SqlColumn("ItemName", MySqlDbType.VarChar, 50) {Primary = true}, new SqlColumn("AllowedGroups", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); + creator.EnsureTableStructure(table); UpdateItemBans(); } @@ -51,14 +50,13 @@ namespace TShockAPI.DB { ItemBans.Clear(); - using (var reader = database.QueryReader("SELECT * FROM ItemBans")) + using var reader = database.QueryReader("SELECT * FROM ItemBans"); + + while (reader != null && reader.Read()) { - while (reader != null && reader.Read()) - { - ItemBan ban = new ItemBan(reader.Get("ItemName")); - ban.SetAllowedGroups(reader.Get("AllowedGroups")); - ItemBans.Add(ban); - } + ItemBan ban = new ItemBan(reader.Get("ItemName")); + ban.SetAllowedGroups(reader.Get("AllowedGroups")); + ItemBans.Add(ban); } } @@ -92,14 +90,7 @@ namespace TShockAPI.DB } } - public bool ItemIsBanned(string name) - { - if (ItemBans.Contains(new ItemBan(name))) - { - return true; - } - return false; - } + public bool ItemIsBanned(string name) => ItemBans.Contains(new(name)); public bool ItemIsBanned(string name, TSPlayer ply) { @@ -109,13 +100,12 @@ namespace TShockAPI.DB public bool AllowGroup(string item, string name) { - string groupsNew = ""; ItemBan b = GetItemBanByName(item); if (b != null) { try { - groupsNew = String.Join(",", b.AllowedGroups); + string groupsNew = string.Join(",", b.AllowedGroups); if (groupsNew.Length > 0) groupsNew += ","; groupsNew += name; @@ -123,7 +113,7 @@ namespace TShockAPI.DB int q = database.Query("UPDATE ItemBans SET AllowedGroups=@0 WHERE ItemName=@1", groupsNew, item); - + return q > 0; } catch (Exception ex) @@ -141,12 +131,12 @@ namespace TShockAPI.DB if (b != null) { try - { + { b.RemoveGroup(group); string groups = string.Join(",", b.AllowedGroups); int q = database.Query("UPDATE ItemBans SET AllowedGroups=@0 WHERE ItemName=@1", groups, item); - + if (q > 0) return true; } @@ -158,7 +148,7 @@ namespace TShockAPI.DB return false; } - public ItemBan GetItemBanByName(String name) + public ItemBan GetItemBanByName(string name) { for (int i = 0; i < ItemBans.Count; i++) { @@ -189,10 +179,7 @@ namespace TShockAPI.DB AllowedGroups = new List(); } - public bool Equals(ItemBan other) - { - return Name == other.Name; - } + public bool Equals(ItemBan other) => Name == other.Name; public bool HasPermissionToUseItem(TSPlayer ply) { @@ -225,12 +212,12 @@ namespace TShockAPI.DB // could add in the other permissions in this class instead of a giant if switch. } - public void SetAllowedGroups(String groups) + public void SetAllowedGroups(string groups) { // prevent null pointer exceptions if (!string.IsNullOrEmpty(groups)) { - List groupArr = groups.Split(',').ToList(); + List groupArr = groups.Split(',').ToList(); for (int i = 0; i < groupArr.Count; i++) { @@ -245,10 +232,10 @@ namespace TShockAPI.DB { return AllowedGroups.Remove(groupName); } - + public override string ToString() { - return Name + (AllowedGroups.Count > 0 ? " (" + String.Join(",", AllowedGroups) + ")" : ""); + return Name + (AllowedGroups.Count > 0 ? " (" + string.Join(",", AllowedGroups) + ")" : ""); } } -} \ No newline at end of file +} diff --git a/TShockAPI/DB/ProjectileManager.cs b/TShockAPI/DB/ProjectileManager.cs index f07280b5..f9372f57 100644 --- a/TShockAPI/DB/ProjectileManager.cs +++ b/TShockAPI/DB/ProjectileManager.cs @@ -39,10 +39,8 @@ namespace TShockAPI.DB new SqlColumn("ProjectileID", MySqlDbType.Int32) {Primary = true}, new SqlColumn("AllowedGroups", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); UpdateBans(); } @@ -51,14 +49,13 @@ namespace TShockAPI.DB { ProjectileBans.Clear(); - using (var reader = database.QueryReader("SELECT * FROM ProjectileBans")) + using var reader = database.QueryReader("SELECT * FROM ProjectileBans"); + + while (reader != null && reader.Read()) { - while (reader != null && reader.Read()) - { - ProjectileBan ban = new ProjectileBan((short) reader.Get("ProjectileID")); - ban.SetAllowedGroups(reader.Get("AllowedGroups")); - ProjectileBans.Add(ban); - } + ProjectileBan ban = new ProjectileBan((short) reader.Get("ProjectileID")); + ban.SetAllowedGroups(reader.Get("AllowedGroups")); + ProjectileBans.Add(ban); } } @@ -93,14 +90,7 @@ namespace TShockAPI.DB } } - public bool ProjectileIsBanned(short id) - { - if (ProjectileBans.Contains(new ProjectileBan(id))) - { - return true; - } - return false; - } + public bool ProjectileIsBanned(short id) => ProjectileBans.Contains(new(id)); public bool ProjectileIsBanned(short id, TSPlayer ply) { @@ -114,13 +104,12 @@ namespace TShockAPI.DB public bool AllowGroup(short id, string name) { - string groupsNew = ""; ProjectileBan b = GetBanById(id); if (b != null) { - try + try { - groupsNew = String.Join(",", b.AllowedGroups); + string groupsNew = string.Join(",", b.AllowedGroups); if (groupsNew.Length > 0) groupsNew += ","; groupsNew += name; @@ -194,10 +183,7 @@ namespace TShockAPI.DB AllowedGroups = new List(); } - public bool Equals(ProjectileBan other) - { - return ID == other.ID; - } + public bool Equals(ProjectileBan other) => ID == other.ID; public bool HasPermissionToCreateProjectile(TSPlayer ply) { @@ -230,12 +216,12 @@ namespace TShockAPI.DB // could add in the other permissions in this class instead of a giant if switch. } - public void SetAllowedGroups(String groups) + public void SetAllowedGroups(string groups) { // prevent null pointer exceptions if (!string.IsNullOrEmpty(groups)) { - List groupArr = groups.Split(',').ToList(); + List groupArr = groups.Split(',').ToList(); for (int i = 0; i < groupArr.Count; i++) { @@ -246,14 +232,8 @@ namespace TShockAPI.DB } } - public bool RemoveGroup(string groupName) - { - return AllowedGroups.Remove(groupName); - } + public bool RemoveGroup(string groupName) => AllowedGroups.Remove(groupName); - public override string ToString() - { - return ID + (AllowedGroups.Count > 0 ? " (" + String.Join(",", AllowedGroups) + ")" : ""); - } + public override string ToString() => ID + (AllowedGroups.Count > 0 ? $" ({string.Join(",", AllowedGroups)})" : ""); } } diff --git a/TShockAPI/DB/RegionManager.cs b/TShockAPI/DB/RegionManager.cs index 0950f92f..d657980a 100644 --- a/TShockAPI/DB/RegionManager.cs +++ b/TShockAPI/DB/RegionManager.cs @@ -1,4 +1,4 @@ -/* +/* TShock, a server mod for Terraria Copyright (C) 2011-2019 Pryaxis & TShock Contributors @@ -56,10 +56,7 @@ namespace TShockAPI.DB new SqlColumn("Owner", MySqlDbType.VarChar, 50), new SqlColumn("Z", MySqlDbType.Int32){ DefaultValue = "0" } ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); } @@ -70,49 +67,46 @@ namespace TShockAPI.DB { try { - using (var reader = database.QueryReader("SELECT * FROM Regions WHERE WorldID=@0", Main.worldID.ToString())) + using var reader = database.QueryReader("SELECT * FROM Regions WHERE WorldID=@0", Main.worldID.ToString()); + + Regions.Clear(); + while (reader.Read()) { - Regions.Clear(); - while (reader.Read()) + int id = reader.Get("Id"); + int X1 = reader.Get("X1"); + int Y1 = reader.Get("Y1"); + int height = reader.Get("height"); + int width = reader.Get("width"); + int Protected = reader.Get("Protected"); + string mergedids = reader.Get("UserIds"); + string name = reader.Get("RegionName"); + string owner = reader.Get("Owner"); + string groups = reader.Get("Groups"); + int z = reader.Get("Z"); + + string[] splitids = mergedids.Split(new[] {','}, StringSplitOptions.RemoveEmptyEntries); + + Region r = new Region(id, new Rectangle(X1, Y1, width, height), name, owner, Protected != 0, Main.worldID.ToString(), z); + r.SetAllowedGroups(groups); + try { - int id = reader.Get("Id"); - int X1 = reader.Get("X1"); - int Y1 = reader.Get("Y1"); - int height = reader.Get("height"); - int width = reader.Get("width"); - int Protected = reader.Get("Protected"); - string mergedids = reader.Get("UserIds"); - string name = reader.Get("RegionName"); - string owner = reader.Get("Owner"); - string groups = reader.Get("Groups"); - int z = reader.Get("Z"); - - string[] splitids = mergedids.Split(new[] {','}, StringSplitOptions.RemoveEmptyEntries); - - Region r = new Region(id, new Rectangle(X1, Y1, width, height), name, owner, Protected != 0, Main.worldID.ToString(), z); - r.SetAllowedGroups(groups); - try + foreach (string t in splitids) { - for (int i = 0; i < splitids.Length; i++) - { - int userid; - - if (Int32.TryParse(splitids[i], out userid)) // if unparsable, it's not an int, so silently skip - r.AllowedIDs.Add(userid); - else - TShock.Log.Warn(GetString($"One of your UserIDs is not a usable integer: {splitids[i]}")); - } + if (int.TryParse(t, out int userid)) // if unparsable, it's not an int, so silently skip + r.AllowedIDs.Add(userid); + else + TShock.Log.Warn(GetString($"One of your UserIDs is not a usable integer: {t}")); } - catch (Exception e) - { - TShock.Log.Error(GetString("Your database contains invalid UserIDs (they should be integers).")); - TShock.Log.Error(GetString("A lot of things will fail because of this. You must manually delete and re-create the allowed field.")); - TShock.Log.Error(e.ToString()); - TShock.Log.Error(e.StackTrace); - } - - Regions.Add(r); } + catch (Exception e) + { + TShock.Log.Error(GetString("Your database contains invalid UserIDs (they should be integers).")); + TShock.Log.Error(GetString("A lot of things will fail because of this. You must manually delete and re-create the allowed field.")); + TShock.Log.Error(e.ToString()); + TShock.Log.Error(e.StackTrace); + } + + Regions.Add(r); } } catch (Exception ex) @@ -296,10 +290,7 @@ namespace TShockAPI.DB /// X coordinate /// Y coordinate /// Whether any regions exist at the given (x, y) coordinate - public bool InArea(int x, int y) - { - return Regions.Any(r => r.InArea(x, y)); - } + public bool InArea(int x, int y) => Regions.Any(r => r.InArea(x, y)); /// /// Checks if any regions exist at the given (x, y) coordinate @@ -308,10 +299,7 @@ namespace TShockAPI.DB /// X coordinate /// Y coordinate /// The names of any regions that exist at the given (x, y) coordinate - public IEnumerable InAreaRegionName(int x, int y) - { - return Regions.Where(r => r.InArea(x, y)).Select(r => r.Name); - } + public IEnumerable InAreaRegionName(int x, int y) => Regions.Where(r => r.InArea(x, y)).Select(r => r.Name); /// /// Checks if any regions exist at the given (x, y) coordinate @@ -320,10 +308,7 @@ namespace TShockAPI.DB /// X coordinate /// Y coordinate /// The IDs of any regions that exist at the given (x, y) coordinate - public IEnumerable InAreaRegionID(int x, int y) - { - return Regions.Where(r => r.InArea(x, y)).Select(r => r.ID); - } + public IEnumerable InAreaRegionID(int x, int y) => Regions.Where(r => r.InArea(x, y)).Select(r => r.ID); /// /// Checks if any regions exist at the given (x, y) coordinate @@ -332,10 +317,7 @@ namespace TShockAPI.DB /// X coordinate /// Y coordinate /// The objects of any regions that exist at the given (x, y) coordinate - public IEnumerable InAreaRegion(int x, int y) - { - return Regions.Where(r => r.InArea(x, y)); - } + public IEnumerable InAreaRegion(int x, int y) => Regions.Where(r => r.InArea(x, y)); /// /// Changes the size of a given region @@ -414,7 +396,6 @@ namespace TShockAPI.DB /// true if renamed successfully, false otherwise public bool RenameRegion(string oldName, string newName) { - Region region = null; string worldID = Main.worldID.ToString(); bool result = false; @@ -426,7 +407,7 @@ namespace TShockAPI.DB if (q > 0) { - region = Regions.First(r => r.Name == oldName && r.WorldID == worldID); + Region region = Regions.First(r => r.Name == oldName && r.WorldID == worldID); region.Name = newName; Hooks.RegionHooks.OnRegionRenamed(region, oldName, newName); result = true; @@ -523,7 +504,7 @@ namespace TShockAPI.DB { try { - Region region = Regions.First(r => String.Equals(regionName, r.Name, StringComparison.OrdinalIgnoreCase)); + Region region = Regions.First(r => string.Equals(regionName, r.Name, StringComparison.OrdinalIgnoreCase)); region.Area = new Rectangle(x, y, width, height); if (database.Query("UPDATE Regions SET X1 = @0, Y1 = @1, width = @2, height = @3 WHERE RegionName = @4 AND WorldID = @5", @@ -547,11 +528,9 @@ namespace TShockAPI.DB var regions = new List(); try { - using (var reader = database.QueryReader("SELECT RegionName FROM Regions WHERE WorldID=@0", worldid)) - { - while (reader.Read()) - regions.Add(new Region {Name = reader.Get("RegionName")}); - } + using var reader = database.QueryReader("SELECT RegionName FROM Regions WHERE WorldID=@0", worldid); + while (reader.Read()) + regions.Add(new Region {Name = reader.Get("RegionName")}); } catch (Exception ex) { @@ -565,20 +544,14 @@ namespace TShockAPI.DB /// /// Region name /// The region with the given name, or null if not found - public Region GetRegionByName(String name) - { - return Regions.FirstOrDefault(r => r.Name.Equals(name) && r.WorldID == Main.worldID.ToString()); - } + public Region GetRegionByName(string name) => Regions.FirstOrDefault(r => r.Name.Equals(name) && r.WorldID == Main.worldID.ToString()); /// /// Returns a region with the given ID /// /// Region ID /// The region with the given ID, or null if not found - public Region GetRegionByID(int id) - { - return Regions.FirstOrDefault(r => r.ID == id && r.WorldID == Main.worldID.ToString()); - } + public Region GetRegionByID(int id) => Regions.FirstOrDefault(r => r.ID == id && r.WorldID == Main.worldID.ToString()); /// /// Changes the owner of the region with the given name @@ -799,12 +772,12 @@ namespace TShockAPI.DB /// Sets the user IDs which are allowed to use the region /// /// String of IDs to set - public void SetAllowedIDs(String ids) + public void SetAllowedIDs(string ids) { - String[] idArr = ids.Split(','); + string[] idArr = ids.Split(','); List idList = new List(); - foreach (String id in idArr) + foreach (string id in idArr) { int i = 0; if (int.TryParse(id, out i) && i != 0) @@ -819,12 +792,12 @@ namespace TShockAPI.DB /// Sets the group names which are allowed to use the region /// /// String of group names to set - public void SetAllowedGroups(String groups) + public void SetAllowedGroups(string groups) { // prevent null pointer exceptions if (!string.IsNullOrEmpty(groups)) { - List groupList = groups.Split(',').ToList(); + List groupList = groups.Split(',').ToList(); for (int i = 0; i < groupList.Count; i++) { diff --git a/TShockAPI/DB/RememberedPosManager.cs b/TShockAPI/DB/RememberedPosManager.cs index 297877f7..8d2f6986 100644 --- a/TShockAPI/DB/RememberedPosManager.cs +++ b/TShockAPI/DB/RememberedPosManager.cs @@ -40,10 +40,7 @@ namespace TShockAPI.DB new SqlColumn("Y", MySqlDbType.Int32), new SqlColumn("WorldID", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); } @@ -51,19 +48,17 @@ namespace TShockAPI.DB { try { - using (var reader = database.QueryReader("SELECT * FROM RememberedPos WHERE Name=@0", name)) + using var reader = database.QueryReader("SELECT * FROM RememberedPos WHERE Name=@0", name); + if (reader.Read()) { - if (reader.Read()) - { - int checkX=reader.Get("X"); - int checkY=reader.Get("Y"); - //fix leftover inconsistencies - if (checkX==0) - checkX++; - if (checkY==0) - checkY++; - return new Vector2(checkX, checkY); - } + int checkX=reader.Get("X"); + int checkY=reader.Get("Y"); + //fix leftover inconsistencies + if (checkX==0) + checkX++; + if (checkY==0) + checkY++; + return new Vector2(checkX, checkY); } } catch (Exception ex) @@ -80,12 +75,10 @@ namespace TShockAPI.DB { try { - using (var reader = database.QueryReader("SELECT * FROM RememberedPos WHERE Name=@0 AND IP=@1 AND WorldID=@2", name, IP, Main.worldID.ToString())) + using var reader = database.QueryReader("SELECT * FROM RememberedPos WHERE Name=@0 AND IP=@1 AND WorldID=@2", name, IP, Main.worldID.ToString()); + if (reader.Read()) { - if (reader.Read()) - { - return new Vector2(reader.Get("X"), reader.Get("Y")); - } + return new Vector2(reader.Get("X"), reader.Get("Y")); } } catch (Exception ex) diff --git a/TShockAPI/DB/ResearchDatastore.cs b/TShockAPI/DB/ResearchDatastore.cs index cb51ab18..6f318a91 100644 --- a/TShockAPI/DB/ResearchDatastore.cs +++ b/TShockAPI/DB/ResearchDatastore.cs @@ -41,10 +41,9 @@ namespace TShockAPI.DB new SqlColumn("AmountSacrificed", MySqlDbType.Int32), new SqlColumn("TimeSacrificed", MySqlDbType.DateTime) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder)new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); + try { creator.EnsureTableStructure(table); @@ -85,15 +84,14 @@ namespace TShockAPI.DB where WorldId = @0 group by itemId"; - try { - using (var reader = database.QueryReader(sql, Main.worldID)) + try + { + using var reader = database.QueryReader(sql, Main.worldID); + while (reader.Read()) { - while (reader.Read()) - { - var itemId = reader.Get("itemId"); - var amount = reader.Get("totalSacrificed"); - sacrificedItems[itemId] = amount; - } + var itemId = reader.Get("itemId"); + var amount = reader.Get("totalSacrificed"); + sacrificedItems[itemId] = amount; } } catch (Exception ex) diff --git a/TShockAPI/DB/SqlTable.cs b/TShockAPI/DB/SqlTable.cs index 299ac851..6bf7b8a8 100644 --- a/TShockAPI/DB/SqlTable.cs +++ b/TShockAPI/DB/SqlTable.cs @@ -75,31 +75,44 @@ namespace TShockAPI.DB public List GetColumns(SqlTable table) { - var ret = new List(); - var name = database.GetSqlType(); - if (name == SqlType.Sqlite) + List ret = new(); + switch (database.GetSqlType()) { - using (var reader = database.QueryReader("PRAGMA table_info({0})".SFormat(table.Name))) + case SqlType.Sqlite: { + using QueryResult reader = database.QueryReader("PRAGMA table_info({0})".SFormat(table.Name)); while (reader.Read()) + { ret.Add(reader.Get("name")); + } + + break; } - } - else if (name == SqlType.Mysql) - { - using ( - var reader = - database.QueryReader( - "SELECT COLUMN_NAME FROM information_schema.COLUMNS WHERE TABLE_NAME=@0 AND TABLE_SCHEMA=@1", table.Name, - database.Database)) + case SqlType.Mysql: { + using QueryResult reader = + database.QueryReader("SELECT COLUMN_NAME FROM information_schema.COLUMNS WHERE TABLE_NAME=@0 AND TABLE_SCHEMA=@1", table.Name, database.Database); + while (reader.Read()) + { ret.Add(reader.Get("COLUMN_NAME")); + } + + break; } - } - else - { - throw new NotSupportedException(); + case SqlType.Postgres: + { + using QueryResult reader = + database.QueryReader("SELECT column_name FROM information_schema.columns WHERE table_name=@0", table.Name); + + while (reader.Read()) + { + ret.Add(reader.Get("column_name")); + } + + break; + } + default: throw new NotSupportedException(); } return ret; @@ -110,4 +123,4 @@ namespace TShockAPI.DB database.Query(creator.DeleteRow(table, wheres)); } } -} \ No newline at end of file +} diff --git a/TShockAPI/DB/SqlValue.cs b/TShockAPI/DB/SqlValue.cs index 3df5d995..eaeaa106 100644 --- a/TShockAPI/DB/SqlValue.cs +++ b/TShockAPI/DB/SqlValue.cs @@ -59,11 +59,9 @@ namespace TShockAPI.DB { List values = new List(); - using (var reader = database.QueryReader(creator.ReadColumn(table, wheres))) - { - while (reader.Read()) - values.Add(reader.Reader.Get(column)); - } + using var reader = database.QueryReader(creator.ReadColumn(table, wheres)); + while (reader.Read()) + values.Add(reader.Reader.Get(column)); return values; } diff --git a/TShockAPI/DB/TileManager.cs b/TShockAPI/DB/TileManager.cs index 61903186..4a1b5d29 100644 --- a/TShockAPI/DB/TileManager.cs +++ b/TShockAPI/DB/TileManager.cs @@ -39,10 +39,8 @@ namespace TShockAPI.DB new SqlColumn("TileId", MySqlDbType.Int32) { Primary = true }, new SqlColumn("AllowedGroups", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder)new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); UpdateBans(); } @@ -51,14 +49,12 @@ namespace TShockAPI.DB { TileBans.Clear(); - using (var reader = database.QueryReader("SELECT * FROM TileBans")) + using var reader = database.QueryReader("SELECT * FROM TileBans"); + while (reader != null && reader.Read()) { - while (reader != null && reader.Read()) - { - TileBan ban = new TileBan((short)reader.Get("TileId")); - ban.SetAllowedGroups(reader.Get("AllowedGroups")); - TileBans.Add(ban); - } + TileBan ban = new TileBan((short)reader.Get("TileId")); + ban.SetAllowedGroups(reader.Get("AllowedGroups")); + TileBans.Add(ban); } } @@ -120,7 +116,7 @@ namespace TShockAPI.DB { try { - groupsNew = String.Join(",", b.AllowedGroups); + groupsNew = string.Join(",", b.AllowedGroups); if (groupsNew.Length > 0) groupsNew += ","; groupsNew += name; @@ -230,12 +226,12 @@ namespace TShockAPI.DB // could add in the other permissions in this class instead of a giant if switch. } - public void SetAllowedGroups(String groups) + public void SetAllowedGroups(string groups) { // prevent null pointer exceptions if (!string.IsNullOrEmpty(groups)) { - List groupArr = groups.Split(',').ToList(); + List groupArr = groups.Split(',').ToList(); for (int i = 0; i < groupArr.Count; i++) { @@ -253,7 +249,7 @@ namespace TShockAPI.DB public override string ToString() { - return ID + (AllowedGroups.Count > 0 ? " (" + String.Join(",", AllowedGroups) + ")" : ""); + return ID + (AllowedGroups.Count > 0 ? " (" + string.Join(",", AllowedGroups) + ")" : ""); } } } diff --git a/TShockAPI/DB/UserManager.cs b/TShockAPI/DB/UserManager.cs index a3e050f7..e705e3fc 100644 --- a/TShockAPI/DB/UserManager.cs +++ b/TShockAPI/DB/UserManager.cs @@ -53,10 +53,8 @@ namespace TShockAPI.DB new SqlColumn("LastAccessed", MySqlDbType.Text), new SqlColumn("KnownIPs", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); } @@ -241,12 +239,10 @@ namespace TShockAPI.DB { try { - using (var reader = _database.QueryReader("SELECT * FROM Users WHERE Username=@0", username)) + using var reader = _database.QueryReader("SELECT * FROM Users WHERE Username=@0", username); + if (reader.Read()) { - if (reader.Read()) - { - return reader.Get("ID"); - } + return reader.Get("ID"); } } catch (Exception ex) @@ -310,16 +306,14 @@ namespace TShockAPI.DB try { - using (var result = _database.QueryReader(query, arg)) + using var result = _database.QueryReader(query, arg); + if (result.Read()) { - if (result.Read()) - { - account = LoadUserAccountFromResult(account, result); - // Check for multiple matches - if (!result.Read()) - return account; - multiple = true; - } + account = LoadUserAccountFromResult(account, result); + // Check for multiple matches + if (!result.Read()) + return account; + multiple = true; } } catch (Exception ex) @@ -339,14 +333,12 @@ namespace TShockAPI.DB try { List accounts = new List(); - using (var reader = _database.QueryReader("SELECT * FROM Users")) + using var reader = _database.QueryReader("SELECT * FROM Users"); + while (reader.Read()) { - while (reader.Read()) - { - accounts.Add(LoadUserAccountFromResult(new UserAccount(), reader)); - } - return accounts; + accounts.Add(LoadUserAccountFromResult(new UserAccount(), reader)); } + return accounts; } catch (Exception ex) { @@ -367,14 +359,13 @@ namespace TShockAPI.DB { List accounts = new List(); string search = notAtStart ? string.Format("%{0}%", username) : string.Format("{0}%", username); - using (var reader = _database.QueryReader("SELECT * FROM Users WHERE Username LIKE @0", - search)) + using var reader = _database.QueryReader("SELECT * FROM Users WHERE Username LIKE @0", + search); + while (reader.Read()) { - while (reader.Read()) - { - accounts.Add(LoadUserAccountFromResult(new UserAccount(), reader)); - } + accounts.Add(LoadUserAccountFromResult(new UserAccount(), reader)); } + return accounts; } catch (Exception ex) @@ -497,7 +488,7 @@ namespace TShockAPI.DB int currentWorkFactor; try { - currentWorkFactor = Int32.Parse((Password.Split('$')[2])); + currentWorkFactor = int.Parse((Password.Split('$')[2])); } catch (FormatException) { diff --git a/TShockAPI/DB/WarpsManager.cs b/TShockAPI/DB/WarpsManager.cs index f3287441..06723281 100644 --- a/TShockAPI/DB/WarpsManager.cs +++ b/TShockAPI/DB/WarpsManager.cs @@ -49,10 +49,8 @@ namespace TShockAPI.DB new SqlColumn("WorldID", MySqlDbType.VarChar, 50) { Unique = true }, new SqlColumn("Private", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); } @@ -88,16 +86,14 @@ namespace TShockAPI.DB { Warps.Clear(); - using (var reader = database.QueryReader("SELECT * FROM Warps WHERE WorldID = @0", - Main.worldID.ToString())) + using var reader = database.QueryReader("SELECT * FROM Warps WHERE WorldID = @0", + Main.worldID.ToString()); + while (reader.Read()) { - while (reader.Read()) - { - Warps.Add(new Warp( - new Point(reader.Get("X"), reader.Get("Y")), - reader.Get("WarpName"), - (reader.Get("Private") ?? "0") != "0")); - } + Warps.Add(new Warp( + new Point(reader.Get("X"), reader.Get("Y")), + reader.Get("WarpName"), + (reader.Get("Private") ?? "0") != "0")); } } @@ -113,7 +109,7 @@ namespace TShockAPI.DB if (database.Query("DELETE FROM Warps WHERE WarpName = @0 AND WorldID = @1", warpName, Main.worldID.ToString()) > 0) { - Warps.RemoveAll(w => String.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)); + Warps.RemoveAll(w => string.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)); return true; } } @@ -131,7 +127,7 @@ namespace TShockAPI.DB /// The warp, if it exists, or else null. public Warp Find(string warpName) { - return Warps.FirstOrDefault(w => String.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)); + return Warps.FirstOrDefault(w => string.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)); } /// @@ -148,7 +144,7 @@ namespace TShockAPI.DB if (database.Query("UPDATE Warps SET X = @0, Y = @1 WHERE WarpName = @2 AND WorldID = @3", x, y, warpName, Main.worldID.ToString()) > 0) { - Warps.Find(w => String.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)).Position = new Point(x, y); + Warps.Find(w => string.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)).Position = new Point(x, y); return true; } } @@ -172,7 +168,7 @@ namespace TShockAPI.DB if (database.Query("UPDATE Warps SET Private = @0 WHERE WarpName = @1 AND WorldID = @2", state ? "1" : "0", warpName, Main.worldID.ToString()) > 0) { - Warps.Find(w => String.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)).IsPrivate = state; + Warps.Find(w => string.Equals(w.Name, warpName, StringComparison.OrdinalIgnoreCase)).IsPrivate = state; return true; } } diff --git a/TShockAPI/Extensions/DbExt.cs b/TShockAPI/Extensions/DbExt.cs index c6aa0ab9..d58a966e 100644 --- a/TShockAPI/Extensions/DbExt.cs +++ b/TShockAPI/Extensions/DbExt.cs @@ -23,6 +23,7 @@ using System.Diagnostics.CodeAnalysis; using Microsoft.Data.Sqlite; using MySql.Data.MySqlClient; using Npgsql; +using TShockAPI.DB.Queries; namespace TShockAPI.DB { @@ -154,6 +155,14 @@ namespace TShockAPI.DB _ => SqlType.Unknown }; + public static IQueryBuilder GetSqlQueryBuilder(this IDbConnection db) => db.GetSqlType() switch + { + SqlType.Sqlite => new SqliteQueryCreator(), + SqlType.Mysql => new MysqlQueryCreator(), + SqlType.Postgres => new PostgresQueryCreator(), + _ => throw new NotSupportedException("Database type not supported.") + }; + private static readonly Dictionary> ReadFuncs = new Dictionary > { diff --git a/TShockAPI/SqlLog.cs b/TShockAPI/SqlLog.cs index 2e5a55e3..5fd9a2bc 100644 --- a/TShockAPI/SqlLog.cs +++ b/TShockAPI/SqlLog.cs @@ -62,7 +62,7 @@ namespace TShockAPI /// public SqlLog(IDbConnection db, string textlogFilepath, bool clearTextLog) { - FileName = string.Format("{0}://database", db.GetSqlType()); + FileName = $"{db.GetSqlType()}://database"; _database = db; _backupLog = new TextLog(textlogFilepath, clearTextLog); @@ -74,10 +74,7 @@ namespace TShockAPI new SqlColumn("Message", MySqlDbType.Text) ); - var creator = new SqlTableCreator(db, - db.GetSqlType() == SqlType.Sqlite - ? (IQueryBuilder) new SqliteQueryCreator() - : new MysqlQueryCreator()); + SqlTableCreator creator = new(db, db.GetSqlQueryBuilder()); creator.EnsureTableStructure(table); }