michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Use logging.json instead of logging.user.json for override settings

Browse Source
This commit is contained in:
Mark Monteiro 2020-03-08 15:46:13 +01:00
parent 2f0b4cc24c
commit 8dbb1c9257
2 changed files with 14 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Jellyfin.Server/Migrations/Routines/CreateUserLoggingConfigFile.cs
View File

@ -15,11 +15,6 @@ namespace Jellyfin.Server.Migrations.Routines
/// </summary> /// </summary>
internal class CreateUserLoggingConfigFile : IMigrationRoutine internal class CreateUserLoggingConfigFile : IMigrationRoutine
{ {
/// <summary>
/// An empty logging JSON configuration, which will be used as the default contents for the user settings config file.
/// </summary>
private const string EmptyLoggingConfig = @"{ ""Serilog"": { } }";
/// <summary> /// <summary>
/// File history for logging.json as existed during this migration creation. The contents for each has been minified. /// File history for logging.json as existed during this migration creation. The contents for each has been minified.
/// </summary> /// </summary>
@ -48,46 +43,28 @@ namespace Jellyfin.Server.Migrations.Routines
public void Perform(CoreAppHost host, ILogger logger) public void Perform(CoreAppHost host, ILogger logger)
{ {
var logDirectory = host.Resolve<IApplicationPaths>().ConfigurationDirectoryPath; var logDirectory = host.Resolve<IApplicationPaths>().ConfigurationDirectoryPath;
var oldConfigPath = Path.Combine(logDirectory, "logging.json"); var existingConfigPath = Path.Combine(logDirectory, "logging.json");
var userConfigPath = Path.Combine(logDirectory, Program.LoggingConfigFileUser);
// Check if there are existing settings in the old "logging.json" file that should be migrated // If the existing logging.json config file is unmodified, then 'reset' it by moving it to 'logging.old.json'
bool shouldMigrateOldFile = ShouldKeepOldConfig(oldConfigPath); // NOTE: This config file has 'reloadOnChange: true', so this change will take effect immediately even though it has already been loaded
if (File.Exists(existingConfigPath) && ExistingConfigUnmodified(existingConfigPath))
// Create the user settings file "logging.user.json"
if (shouldMigrateOldFile)
{ {
// Use the existing logging.json file File.Move(existingConfigPath, Path.Combine(logDirectory, "logging.old.json"));
File.Copy(oldConfigPath, userConfigPath);
}
else
{
// Write an empty JSON file
File.WriteAllText(userConfigPath, EmptyLoggingConfig);
} }
} }
/// <summary> /// <summary>
/// Check if the existing logging.json file should be migrated to logging.user.json. /// Check if the existing logging.json file has not been modified by the user by comparing it to all the
/// versions in our git history. Until now, the file has never been migrated after first creation so users
/// could have any version from the git history.
/// </summary> /// </summary>
private bool ShouldKeepOldConfig(string oldConfigPath) /// <exception cref="IOException"><paramref name="oldConfigPath"/> does not exist or could not be read.</exception>
private bool ExistingConfigUnmodified(string oldConfigPath)
{ {
// Cannot keep the old logging file if it doesn't exist
if (!File.Exists(oldConfigPath))
{
return false;
}
// Check if the existing logging.json file has been modified by the user by comparing it to all the
// versions in our git history. Until now, the file has never been migrated after first creation so users
// could have any version from the git history.
var existingConfigJson = JToken.Parse(File.ReadAllText(oldConfigPath)); var existingConfigJson = JToken.Parse(File.ReadAllText(oldConfigPath));
var existingConfigIsUnmodified = _defaultConfigHistory return _defaultConfigHistory
.Select(historicalConfigText => JToken.Parse(historicalConfigText)) .Select(historicalConfigText => JToken.Parse(historicalConfigText))
.Any(historicalConfigJson => JToken.DeepEquals(existingConfigJson, historicalConfigJson)); .Any(historicalConfigJson => JToken.DeepEquals(existingConfigJson, historicalConfigJson));
// The existing config file should be kept and used only if it has been modified by the user
return !existingConfigIsUnmodified;
} }
} }
} }

6
Jellyfin.Server/Program.cs
View File

@ -44,9 +44,9 @@ namespace Jellyfin.Server
public static readonly string LoggingConfigFileDefault = "logging.default.json"; public static readonly string LoggingConfigFileDefault = "logging.default.json";
/// <summary> /// <summary>
/// The name of the logging configuration file containing user override settings. /// The name of the logging configuration file containing the system-specific override settings.
/// </summary> /// </summary>
public static readonly string LoggingConfigFileUser = "logging.user.json"; public static readonly string LoggingConfigFileSystem = "logging.json";
private static readonly CancellationTokenSource _tokenSource = new CancellationTokenSource(); private static readonly CancellationTokenSource _tokenSource = new CancellationTokenSource();
private static readonly ILoggerFactory _loggerFactory = new SerilogLoggerFactory(); private static readonly ILoggerFactory _loggerFactory = new SerilogLoggerFactory();
@ -471,7 +471,7 @@ namespace Jellyfin.Server
.SetBasePath(appPaths.ConfigurationDirectoryPath) .SetBasePath(appPaths.ConfigurationDirectoryPath)
.AddInMemoryCollection(ConfigurationOptions.Configuration) .AddInMemoryCollection(ConfigurationOptions.Configuration)
.AddJsonFile(LoggingConfigFileDefault, optional: false, reloadOnChange: true) .AddJsonFile(LoggingConfigFileDefault, optional: false, reloadOnChange: true)
.AddJsonFile(LoggingConfigFileUser, optional: true, reloadOnChange: true) .AddJsonFile(LoggingConfigFileSystem, optional: true, reloadOnChange: true)
.AddEnvironmentVariables("JELLYFIN_") .AddEnvironmentVariables("JELLYFIN_")
.Build(); .Build();
} }