提交: ca020bd7e84d5eac7c46196a961842afa9d52513 - admintoolkit (git)

Administrator's Toolkit VS plugin

Commit MetaInfo

• 修訂: ca020bd7e84d5eac7c46196a961842afa9d52513 (tree)
• 時間: 2019-08-13 05:36:53
• 作者: melchior <melchior@user...>
• Commiter: melchior

Log Message

re-cyclic backup process,
changed messages,
altering count now supported

Change Summary

• modified: AdminToolkit/AdminModConfig.cs
• modified: AdminToolkit/AdminToolkitMod.cs
• modified: AdminToolkit/Commands/BackupCycleCommand.cs

差異

--- a/AdminToolkit/AdminModConfig.cs
+++ b/AdminToolkit/AdminModConfig.cs
@@ -37,15 +37,22 @@ namespace AdminToolkit
 		/// <value>The backup count.</value>
 		public uint BackupCount { get; set;}
 
+		/// <summary>
+		/// If auto-enable delayed backup cycle on server start
+		/// </summary>
+		/// <value>The autobackup.</value>
+		public bool Autobackup { get; set; }
+
+
 		public AdminModConfig( )
 		{
 			this.PlayerRoleRestrain = "suvisitor";
 			this.PlayerRoleNormal = "suplayer";
 			this.RuleRoleChangerEnabled = false;
 
-			this.BackupDelay = new TimeSpan(1, 0, 0);
-			this.BackupCount = 10;
-
+			this.BackupDelay = new TimeSpan(4, 0, 0);
+			this.BackupCount = 6;
+			this.Autobackup = false;
 		}
 
 

--- a/AdminToolkit/AdminToolkitMod.cs
+++ b/AdminToolkit/AdminToolkitMod.cs
@@ -95,6 +95,7 @@ namespace AdminToolkit
 			this.ServerAPI.RegisterCommand(new BackupCycleCommand(this.ServerAPI) );
 
 			this.ServerAPI.Event.PlayerChat += BoomingVoiceOfAuthority;
+			this.ServerAPI.Event.ServerRunPhase(EnumServerRunPhase.Shutdown, SaveConfigSettings);
 		}
 
 		private void PopulateAdminRoleTable( )
@@ -157,12 +158,13 @@ namespace AdminToolkit
 			return message;
 		}
 
-
-
-
-
-
-
+		private void SaveConfigSettings( )
+		{
+			if (this.CachedConfiguration != null) {				
+				Mod.Logger.Notification("Persisting configuration.");
+				ServerAPI.StoreModConfig<AdminModConfig>(this.CachedConfiguration, _configFilename);
+			}
+		}
 
 }
 }

--- a/AdminToolkit/Commands/BackupCycleCommand.cs
+++ b/AdminToolkit/Commands/BackupCycleCommand.cs
@@ -18,6 +18,10 @@ namespace AdminToolkit
 		private const string _timeFormat = @"d\D\ hh\H\ mm\M\ ss\S";
 		private MechTurk mechanicalTurk;
 
+		private DateTimeOffset _lastBackupTime = DateTimeOffset.MinValue;
+
+		private string fileFilter;
+
 		public BackupCycleCommand(ICoreServerAPI _serverAPI) : base(_serverAPI)
 		{
 			this.Command = "backups";
@@ -27,6 +31,13 @@ namespace AdminToolkit
 			this.Syntax = "enable / disable /  delay [hours] / stats";
 
 			mechanicalTurk = new MechTurk(ServerAPI.Server.Config.Roles.Find(ro => ro.Code == "admin"), this.Logger);
+
+			ServerAPI.Event.ServerRunPhase(EnumServerRunPhase.RunGame, ServerStarts);
+		}
+
+		public bool Enabled {
+
+			get { return this.backupTickerID != 0; }
 		}
 
 		private void BackupCommandParser(IServerPlayer player, int groupId, CmdArgs args)
@@ -35,7 +46,7 @@ namespace AdminToolkit
 
 			StringBuilder msgLine = new StringBuilder( );
 			bool success = false;
-			int? delay;
+			int? delay, count;
 
 			if (args.Length > 0) {
 				string command = args.PopWord( );
@@ -46,12 +57,12 @@ namespace AdminToolkit
 
 				switch (command) {
 				case "enable":
-					success = EnableBackupCycle(true); 
-					if (success) msgLine.AppendFormat("Enabled, with delay: {0}\n", this.CachedConfiguration.BackupDelay.ToString(_timeFormat));
+					success = ToggleBackupCycle(true); 
+					if (success) msgLine.AppendFormat("Enabled, with delay: {0}, next: {1}\n", this.CachedConfiguration.BackupDelay.ToString(_timeFormat), DateTimeOffset.UtcNow.Add(this.CachedConfiguration.BackupDelay).ToString("u"));
 					break;
 
 				case "disable":
-					success = EnableBackupCycle(false); 
+					success = ToggleBackupCycle(false); 
 					if (success) msgLine.AppendLine("Disabled.");
 					break;
 
@@ -68,10 +79,24 @@ namespace AdminToolkit
 
 					break;
 
-				case "stats":
+				case "count":
+					count = args.PopInt( );
 
+					if (count.HasValue && count.Value >= 4) {
+						this.CachedConfiguration.BackupCount = (uint)count.Value;
+						msgLine.AppendFormat("Changed count to: {0} ", this.CachedConfiguration.BackupCount);
+						success = true;
+					} else {
+						msgLine.AppendLine("Wrong quantity value; must be positive integer 4 or more (count) ");
+					}
 
+					break;
 
+				case "state":
+				case "status":
+				case "stats":
+					StatusLine(msgLine);
+					success = true;
 					break;
 
 				default:
@@ -91,23 +116,29 @@ namespace AdminToolkit
 			player.SendMessage(groupId, msgLine.ToString( ), success ? EnumChatType.CommandSuccess : EnumChatType.CommandError);
 		}
 
-		private bool EnableBackupCycle(bool enable)
+		/// <summary>
+		/// Toggles the backup cycle.
+		/// </summary>
+		/// <returns>The backup cycle.</returns>
+		/// <param name="enable">Enable.</param>
+		private bool ToggleBackupCycle(bool enable)
 		{
 			if (enable) 
 			{
-				if (backupTickerID == 0) 
+				if (!this.Enabled) 
 				{
 					this.backupTickerID = ServerAPI.Event.RegisterCallback(BackupCycleHandler, (int)this.CachedConfiguration.BackupDelay.TotalMilliseconds);
-					Logger.VerboseDebug("BackupCycle enabled, delay: {0}", this.CachedConfiguration.BackupDelay.ToString(_timeFormat));
+					Logger.Notification("BackupCycle enabled, delay: {0}", this.CachedConfiguration.BackupDelay.ToString(_timeFormat));
 					return true;
 				}
 			} 
 			else 
 			{				
-				if (backupTickerID != 0) 
+				if (this.Enabled) 
 				{
-					ServerAPI.Event.UnregisterCallback(backupTickerID);	
-					Logger.VerboseDebug("BackupCycle disabled");
+					ServerAPI.Event.UnregisterCallback(backupTickerID);
+					this.backupTickerID = 0;
+					Logger.Notification("BackupCycle disabled");
 					return true;
 				}
 			}
@@ -117,26 +148,26 @@ namespace AdminToolkit
 
 
 		private void BackupCycleHandler(float elapsed)
-		{
-			Logger.Event("Automatic Backup triggered, elasped {0} @{1} Uptime",elapsed, ServerAPI.Server.ServerUptimeSeconds );
+		{			
+			Logger.Event("Backup cycle triggered, elasped {0} @{1} Uptime", elapsed, ServerAPI.Server.ServerUptimeSeconds);
 			//Peek at backup DIR, count files of the backup type
 			var backupDir = new DirectoryInfo(GamePaths.Backups);
 
 			if (backupDir.Exists) {
-				var files = backupDir.GetFiles("*" + GlobalConstants.WorldSaveExtension);
+				
+				var files = backupDir.GetFiles(fileFilter);
 
 				if (files.Length > this.CachedConfiguration.BackupCount) {
 					Logger.VerboseDebug("There are {0} backup files, over set limit", files.Length);
-					var oldest = files.OrderByDescending(fi => fi.CreationTimeUtc).FirstOrDefault( );
+					var oldest = files.OrderBy(fi => fi.CreationTimeUtc).FirstOrDefault( );
 
 					if (oldest != null) {
-						Logger.VerboseDebug("Oldest backup file: {0}", oldest.Name);
+						Logger.VerboseDebug("Oldest backup file: {0}", oldest.FullName);
 						oldest.Delete( );
-						Logger.Notification("Deleted old Backup: {0}", oldest.FullName);
+						Logger.Notification("Deleted old Backup: {0}", oldest.Name);
 					}
 				}
-			} else 
-			{
+			} else {
 				Logger.VerboseDebug("Could not open backup directory");
 			}
 
@@ -145,17 +176,21 @@ namespace AdminToolkit
 
 				ServerMain serverMain = ServerAPI.World as ServerMain;
 				serverMain.EventManager.TriggerChatCommand(mechanicalTurk, GlobalConstants.ServerInfoChatGroup, @"genbackup", new CmdArgs( ));
-		        
-			} else 
-			{
+				_lastBackupTime = DateTimeOffset.UtcNow;
+			} else {
 				Logger.Warning("Could not invoke backup command - API (implimentation) has changed, Contact Developer!");
+				this.backupTickerID = 0;
+				return;
 			}
 
+			this.backupTickerID = ServerAPI.Event.RegisterCallback(BackupCycleHandler, ( int )this.CachedConfiguration.BackupDelay.TotalMilliseconds);
+			Logger.Notification("BackupCycle re-engaged, delay: {0} next time: {1}", this.CachedConfiguration.BackupDelay.ToString(_timeFormat), DateTimeOffset.UtcNow.Add(this.CachedConfiguration.BackupDelay).ToString("u"));
 
 			//GlobalConstants.ConsoleGroup
 			/*
 			backupFileName = Path.GetFileName(server.Config.WorldConfig.SaveFileLocation).Replace(GlobalConstants.WorldSaveExtension, "") + "-" + string.Format("{0:yyyy-MM-dd_HH-mm-ss}", DateTime.Now) + GlobalConstants.WorldSaveExtension;
 			 */
+
 		}
 
 		private void AlterTimeDelay(int delay)
@@ -164,11 +199,97 @@ namespace AdminToolkit
 			delay = Math.Min(delay, 500);//Limited by callback set in milliseconds
 
 			this.CachedConfiguration.BackupDelay = new TimeSpan(delay, 0, 0);
+
+			if (this.Enabled) 
+			{
+				ToggleBackupCycle(false);
+				ToggleBackupCycle(true);
+			}
 		}
 
-		private void UseAMacro( )
+		private void StatusLine(StringBuilder msgLine)
 		{
-			
+			msgLine.AppendFormat("Delay: {0}, Max Backups:{1}, Auto-start:{2}, ", CachedConfiguration.BackupDelay.ToString(_timeFormat),CachedConfiguration.BackupCount,CachedConfiguration.Autobackup );
+
+			if (this.Enabled) {
+				msgLine.AppendFormat("<font color='lime'>Currently enabled: YES</font>\n");
+			} else {
+				msgLine.AppendFormat("<font color='red'>Currently enabled: NO</font>\n");
+			}
+
+			if (_lastBackupTime != DateTimeOffset.MinValue) 
+			{
+				msgLine.AppendFormat("Last Backup attempt: {0} ",  _lastBackupTime.ToString("u") );
+				msgLine.AppendFormat("Next backup due: {0}\n",_lastBackupTime.Add(CachedConfiguration.BackupDelay).ToString("u") );
+			}
+
+			var backupDir = new DirectoryInfo(GamePaths.Backups);
+			long totalBackupSize = 0;
+
+			if (backupDir.Exists) 
+			{
+				var backups = backupDir.GetFiles(fileFilter);
+
+				foreach (FileInfo backFile in backups) 
+				{
+					msgLine.AppendFormat("<font color='white'> '{0}' Size: {1} Written: {2} </font>\n", backFile.Name, FileSizeReadable(backFile.Length), backFile.LastWriteTimeUtc.ToString("u"));
+					totalBackupSize += backFile.Length;
+				}
+
+				msgLine.AppendFormat("Total size: {0} in {1} files.\n", FileSizeReadable(totalBackupSize),backups.Length);
+
+			}
+		}
+
+		public static string FileSizeReadable(long i)
+		{
+			// Get absolute value
+			long absolute_i = (i < 0 ? -i : i);
+			// Determine the suffix and readable value
+			string suffix;
+			double readable;
+			if (absolute_i >= 0x1000000000000000) // Exabyte
+			{
+				suffix = "EB";
+				readable = (i >> 50);
+			} else if (absolute_i >= 0x4000000000000) // Petabyte
+			  {
+				suffix = "PB";
+				readable = (i >> 40);
+			} else if (absolute_i >= 0x10000000000) // Terabyte
+			  {
+				suffix = "TB";
+				readable = (i >> 30);
+			} else if (absolute_i >= 0x40000000) // Gigabyte
+			  {
+				suffix = "GB";
+				readable = (i >> 20);
+			} else if (absolute_i >= 0x100000) // Megabyte
+			  {
+				suffix = "MB";
+				readable = (i >> 10);
+			} else if (absolute_i >= 0x400) // Kilobyte
+			  {
+				suffix = "KB";
+				readable = i;
+			} else {
+				return i.ToString("0 B"); // Byte
+			}
+			// Divide by 1024 to get fractional value
+			readable = (readable / 1024);
+			// Return formatted number with suffix
+			return readable.ToString("0.### ") + suffix;
+		}
+
+		private void ServerStarts( )
+		{
+			//ServerAPI.WorldManager.CurrentWorldName
+			//ServerAPI.WorldManager.SaveGame.WorldName
+			string worldNameTrimmed = Path.GetFileNameWithoutExtension(ServerAPI.WorldManager.CurrentWorldName);
+			fileFilter = $"{worldNameTrimmed}-*{GlobalConstants.WorldSaveExtension}";
+			Logger.VerboseDebug("File Filter: {0}", fileFilter);
+
+			if (CachedConfiguration.Autobackup) { ToggleBackupCycle(true); }
 		}
 	}