## Adds Auto Archiving Backups are archived once an hour, day, and month. Archives older than 60 days are pruned automatically. _Note: Automatic pruning is off by default_ ### Archive compression format The following formats are supported: * Zstd (The fastest with best compression ratio) * GZip * Zip * None (Tar) _Note: By default archives use [zstandard](http://facebook.github.io/zstd/) format. The archive format can be changed in modernuo.json `autoArchive.compressionFormat`_ ### Restoring world from archive Move the archive to the Saves folder (tar.zst file). On startup the server will extract the file and restore the latest save. See pictures below. ### Manually extracting an archives #### Windows * Use the latest version of [7-zip w/ ZStandard](https://github.com/mcmilk/7-Zip-zstd/releases/latest) 1. Extract the `.tar.zst` file. 2. Extract the `.tar` file. (Yes you have to do it in two steps) * On Windows 10 you can use the command line. `zstd.exe` is in the Assemblies folder after building ModernUO. 1. `tar --use-compress-program "Distribution\Assemblies\zstd.exe -d" -xvf "Archives\Hourly\archivefile.tar.zst" -C "path to where you want to extract it"` #### Mac * Install [Keka](https://www.keka.io) 1. Drop the .tar.zst onto the keka interface. #### Linux 1. Install zstd from a package manager 2. Run `tar -I zstd -xvf "Archives\Hourly\archivefile.tar.zst" -C "path to where you want to extract it"` ### Other changes * Changes Autosave to occur at the same time no matter when the server is booted. * Adds `[SaveFrequency <delay> [warning]`command to set save frequency and warning frequency in-game. * Adds support for time zones that are configurable. The system timezone can also be manually configured. Check `TimeZoneHandler.cs` for details. <img width="257" alt="Screen Shot 2021-09-22 at 11 23 18 PM" src="https://user-images.githubusercontent.com/3953314/134464929-a5bf3cd8-2ef0-4476-a9ad-71d0816a19ac.png"> <img width="241" alt="Screen Shot 2021-09-22 at 11 23 39 PM" src="https://user-images.githubusercontent.com/3953314/134464945-5f6f96dc-3d1e-434d-8256-5c6b3705e786.png"> <img width="836" alt="Screen Shot 2021-09-22 at 11 34 39 PM" src="https://user-images.githubusercontent.com/3953314/134464957-625e57f2-ef47-4ca1-a0a7-cd40c9b6539c.png"> <img width="631" alt="Screen Shot 2021-09-22 at 11 34 50 PM" src="https://user-images.githubusercontent.com/3953314/134464969-b2d65c0d-f8f5-497a-a832-5d805e8e0b22.png">
438 lines
15 KiB
C#
438 lines
15 KiB
C#
/*************************************************************************
|
|
* ModernUO *
|
|
* Copyright 2019-2020 - ModernUO Development Team *
|
|
* Email: hi@modernuo.com *
|
|
* File: ServerConfiguration.cs *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation, either version 3 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
|
*************************************************************************/
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.IO;
|
|
using System.Net;
|
|
using Server.Json;
|
|
using Server.Logging;
|
|
|
|
namespace Server
|
|
{
|
|
public static class ServerConfiguration
|
|
{
|
|
private static readonly ILogger logger = LogFactory.GetLogger(typeof(ServerConfiguration));
|
|
|
|
private const string _relPath = "Configuration/modernuo.json";
|
|
private static readonly string m_FilePath = Path.Join(Core.BaseDirectory, _relPath);
|
|
private static ServerSettings m_Settings;
|
|
private static bool m_Mocked;
|
|
|
|
public static List<string> AssemblyDirectories => m_Settings.AssemblyDirectories;
|
|
|
|
public static List<string> DataDirectories => m_Settings.DataDirectories;
|
|
|
|
public static List<IPEndPoint> Listeners => m_Settings.Listeners;
|
|
|
|
public static string GetSetting(string key, string defaultValue)
|
|
{
|
|
m_Settings.Settings.TryGetValue(key, out var value);
|
|
return value ?? defaultValue;
|
|
}
|
|
|
|
public static int GetSetting(string key, int defaultValue)
|
|
{
|
|
m_Settings.Settings.TryGetValue(key, out var strValue);
|
|
return int.TryParse(strValue, out var value) ? value : defaultValue;
|
|
}
|
|
|
|
public static long GetSetting(string key, long defaultValue)
|
|
{
|
|
m_Settings.Settings.TryGetValue(key, out var strValue);
|
|
return long.TryParse(strValue, out var value) ? value : defaultValue;
|
|
}
|
|
|
|
public static bool GetSetting(string key, bool defaultValue)
|
|
{
|
|
m_Settings.Settings.TryGetValue(key, out var strValue);
|
|
return bool.TryParse(strValue, out var value) ? value : defaultValue;
|
|
}
|
|
|
|
public static T GetSetting<T>(string key, T defaultValue) where T : struct, Enum
|
|
{
|
|
m_Settings.Settings.TryGetValue(key, out var strValue);
|
|
return Enum.TryParse(strValue, out T value) ? value : defaultValue;
|
|
}
|
|
|
|
public static T? GetSetting<T>(string key) where T : struct, Enum
|
|
{
|
|
if (!m_Settings.Settings.TryGetValue(key, out var strValue))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
return Enum.TryParse(strValue, out T value) ? value : null;
|
|
}
|
|
|
|
public static string GetOrUpdateSetting(string key, string defaultValue)
|
|
{
|
|
if (m_Settings.Settings.TryGetValue(key, out var value))
|
|
{
|
|
return value;
|
|
}
|
|
|
|
SetSetting(key, value = defaultValue);
|
|
return value;
|
|
}
|
|
|
|
public static int GetOrUpdateSetting(string key, int defaultValue)
|
|
{
|
|
int value;
|
|
|
|
if (m_Settings.Settings.TryGetValue(key, out var strValue))
|
|
{
|
|
value = int.TryParse(strValue, out value) ? value : defaultValue;
|
|
}
|
|
else
|
|
{
|
|
SetSetting(key, (value = defaultValue).ToString());
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
public static long GetOrUpdateSetting(string key, long defaultValue)
|
|
{
|
|
long value;
|
|
|
|
if (m_Settings.Settings.TryGetValue(key, out var strValue))
|
|
{
|
|
value = long.TryParse(strValue, out value) ? value : defaultValue;
|
|
}
|
|
else
|
|
{
|
|
SetSetting(key, (value = defaultValue).ToString());
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
public static bool GetOrUpdateSetting(string key, bool defaultValue)
|
|
{
|
|
bool value;
|
|
|
|
if (m_Settings.Settings.TryGetValue(key, out var strValue))
|
|
{
|
|
value = bool.TryParse(strValue, out value) ? value : defaultValue;
|
|
}
|
|
else
|
|
{
|
|
SetSetting(key, (value = defaultValue).ToString());
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
public static TimeSpan GetOrUpdateSetting(string key, TimeSpan defaultValue)
|
|
{
|
|
TimeSpan value;
|
|
|
|
if (m_Settings.Settings.TryGetValue(key, out var strValue))
|
|
{
|
|
value = TimeSpan.TryParse(strValue, out value) ? value : defaultValue;
|
|
}
|
|
else
|
|
{
|
|
SetSetting(key, (value = defaultValue).ToString());
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
public static T GetOrUpdateSetting<T>(string key, T defaultValue) where T : struct, Enum
|
|
{
|
|
T value;
|
|
|
|
if (m_Settings.Settings.TryGetValue(key, out var strValue))
|
|
{
|
|
value = Enum.TryParse(strValue, out value) ? value : defaultValue;
|
|
}
|
|
else
|
|
{
|
|
SetSetting(key, (value = defaultValue).ToString());
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
public static void SetSetting(string key, TimeSpan value) => SetSetting(key, value.ToString());
|
|
|
|
public static void SetSetting(string key, int value) => SetSetting(key, value.ToString());
|
|
|
|
public static void SetSetting(string key, long value) => SetSetting(key, value.ToString());
|
|
|
|
public static void SetSetting(string key, bool value) => SetSetting(key, value.ToString());
|
|
|
|
public static void SetSetting<T>(string key, T value) where T : struct, Enum =>
|
|
SetSetting(key, value.ToString());
|
|
|
|
public static void SetSetting(string key, string value)
|
|
{
|
|
m_Settings.Settings[key] = value;
|
|
Save();
|
|
}
|
|
|
|
// If mock is enabled we skip the console readline.
|
|
public static void Load(bool mocked = false)
|
|
{
|
|
m_Mocked = mocked;
|
|
var updated = false;
|
|
|
|
if (File.Exists(m_FilePath))
|
|
{
|
|
logger.Information($"Reading server configuration from {_relPath}...");
|
|
m_Settings = JsonConfig.Deserialize<ServerSettings>(m_FilePath);
|
|
|
|
if (m_Settings == null)
|
|
{
|
|
logger.Error("Reading server configuration failed");
|
|
throw new FileNotFoundException($"Failed to deserialize {m_FilePath}.");
|
|
}
|
|
|
|
logger.Information("Reading server configuration done");
|
|
}
|
|
else
|
|
{
|
|
updated = true;
|
|
m_Settings = new ServerSettings();
|
|
}
|
|
|
|
if (mocked)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (m_Settings.DataDirectories.Count == 0)
|
|
{
|
|
updated = true;
|
|
m_Settings.DataDirectories.AddRange(GetDataDirectories());
|
|
}
|
|
|
|
if (m_Settings.Listeners.Count == 0)
|
|
{
|
|
updated = true;
|
|
m_Settings.Listeners.AddRange(GetListeners());
|
|
}
|
|
|
|
if (m_Settings.Expansion == null)
|
|
{
|
|
var expansion = GetSetting<Expansion>("currentExpansion");
|
|
var hasExpansion = expansion != null;
|
|
|
|
expansion ??= GetExpansion();
|
|
|
|
if (expansion <= Expansion.ML && !hasExpansion)
|
|
{
|
|
SetPre6000Support();
|
|
}
|
|
|
|
updated = true;
|
|
m_Settings.Expansion = expansion;
|
|
}
|
|
|
|
Core.Expansion = m_Settings.Expansion.Value;
|
|
|
|
if (updated)
|
|
{
|
|
Save();
|
|
Console.Write("Server configuration saved to ");
|
|
Utility.PushColor(ConsoleColor.Green);
|
|
Console.WriteLine($"{_relPath}.");
|
|
Utility.PopColor();
|
|
}
|
|
}
|
|
|
|
private static void SetPre6000Support()
|
|
{
|
|
Console.WriteLine("Will you be using a client version older than 6.0.0.0?");
|
|
|
|
do
|
|
{
|
|
Console.Write("y or [n]> ");
|
|
var input = Console.ReadLine();
|
|
if (string.IsNullOrWhiteSpace(input) || input.InsensitiveStartsWith("n"))
|
|
{
|
|
Utility.PushColor(ConsoleColor.Yellow);
|
|
Console.WriteLine("Client >= 6.0.0.0 chosen.");
|
|
Utility.PopColor();
|
|
return;
|
|
}
|
|
|
|
if (input.InsensitiveStartsWith("y"))
|
|
{
|
|
SetSetting("maps.enablePre6000Trammel", true.ToString());
|
|
|
|
Utility.PushColor(ConsoleColor.Yellow);
|
|
Console.WriteLine("Client <= 5.0.9.1 chosen.");
|
|
Utility.PopColor();
|
|
return;
|
|
}
|
|
|
|
Console.Write("Invalid option ");
|
|
Utility.PushColor(ConsoleColor.Red);
|
|
Console.Write(input);
|
|
Utility.PopColor();
|
|
Console.WriteLine(". Press y for yes or n for no.");
|
|
} while (true);
|
|
}
|
|
|
|
private static Expansion GetExpansion()
|
|
{
|
|
Console.WriteLine("Please choose an expansion by typing the number or short name:");
|
|
var expansions = ExpansionInfo.Table;
|
|
|
|
for (int i = 0; i < expansions.Length; i++)
|
|
{
|
|
var info = expansions[i];
|
|
Console.WriteLine(" - {0,2}: {1} ({2})", i, ((Expansion)info.ID).ToString(), info.Name);
|
|
}
|
|
|
|
var maxExpansion = (Expansion)expansions[^1].ID;
|
|
var maxExpansionName = maxExpansion.ToString();
|
|
|
|
do
|
|
{
|
|
Console.Write("[enter for {0}]> ", maxExpansionName);
|
|
var input = Console.ReadLine();
|
|
Expansion expansion;
|
|
|
|
if (string.IsNullOrWhiteSpace(input))
|
|
{
|
|
expansion = maxExpansion;
|
|
}
|
|
else if (int.TryParse(input, NumberStyles.Integer, null, out var number) &&
|
|
number >= 0 && number < expansions.Length)
|
|
{
|
|
expansion = (Expansion)number;
|
|
}
|
|
else if (!Enum.TryParse(input, out expansion))
|
|
{
|
|
Utility.PushColor(ConsoleColor.Red);
|
|
Console.Write(input);
|
|
Utility.PopColor();
|
|
Console.WriteLine(" is an invalid expansion option.");
|
|
continue;
|
|
}
|
|
|
|
Console.Write("Expansion set to ");
|
|
Utility.PushColor(ConsoleColor.Green);
|
|
Console.Write(ExpansionInfo.GetInfo(expansion).Name);
|
|
Utility.PopColor();
|
|
Console.WriteLine(".");
|
|
return expansion;
|
|
} while (true);
|
|
}
|
|
|
|
private static List<string> GetDataDirectories()
|
|
{
|
|
Console.WriteLine("Please enter the absolute path to the Ultima Online data:");
|
|
|
|
var directories = new List<string>();
|
|
|
|
do
|
|
{
|
|
Console.Write("{0}> ", directories.Count > 0 ? "[enter to finish]" : " ");
|
|
var directory = Console.ReadLine();
|
|
if (string.IsNullOrWhiteSpace(directory))
|
|
{
|
|
break;
|
|
}
|
|
|
|
if (Directory.Exists(directory))
|
|
{
|
|
directories.Add(directory);
|
|
Console.Write("Added ");
|
|
Utility.PushColor(ConsoleColor.Green);
|
|
Console.Write(directory);
|
|
Utility.PopColor();
|
|
Console.WriteLine(".");
|
|
}
|
|
else
|
|
{
|
|
Utility.PushColor(ConsoleColor.Red);
|
|
Console.Write(directory);
|
|
Utility.PopColor();
|
|
Console.WriteLine(" does not exist.");
|
|
}
|
|
} while (true);
|
|
|
|
return directories;
|
|
}
|
|
|
|
private static List<IPEndPoint> GetListeners()
|
|
{
|
|
Console.WriteLine("Please enter the IP and ports to listen:");
|
|
Console.WriteLine(" - Only enter IP addresses directly bound to this machine");
|
|
Console.WriteLine(" - To listen to all IP addresses enter 0.0.0.0");
|
|
|
|
var ips = new List<IPEndPoint>();
|
|
|
|
do
|
|
{
|
|
// IP:Port?
|
|
Console.Write("[{0}]> ", ips.Count > 0 ? "enter to finish" : "0.0.0.0:2593");
|
|
var ipStr = Console.ReadLine();
|
|
|
|
IPEndPoint ip;
|
|
if (string.IsNullOrWhiteSpace(ipStr))
|
|
{
|
|
if (ips.Count > 0)
|
|
{
|
|
break;
|
|
}
|
|
|
|
ip = new IPEndPoint(IPAddress.Any, 2593);
|
|
}
|
|
else
|
|
{
|
|
if (!ipStr.ContainsOrdinal(':'))
|
|
{
|
|
ipStr += ":2593";
|
|
}
|
|
|
|
if (!IPEndPoint.TryParse(ipStr, out ip))
|
|
{
|
|
Utility.PushColor(ConsoleColor.Red);
|
|
Console.Write(ipStr);
|
|
Utility.PopColor();
|
|
Console.WriteLine(" is not a valid IP or port.");
|
|
continue;
|
|
}
|
|
}
|
|
|
|
ips.Add(ip);
|
|
Console.Write("Added ");
|
|
Utility.PushColor(ConsoleColor.Green);
|
|
Console.Write(ip);
|
|
Utility.PopColor();
|
|
Console.WriteLine(".");
|
|
} while (true);
|
|
|
|
return ips;
|
|
}
|
|
|
|
public static void Save()
|
|
{
|
|
if (m_Mocked)
|
|
{
|
|
return;
|
|
}
|
|
|
|
JsonConfig.Serialize(m_FilePath, m_Settings);
|
|
}
|
|
}
|
|
}
|