| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.IO; |
| | | 4 | | using System.Linq; |
| | | 5 | | using MediaBrowser.Common.Configuration; |
| | | 6 | | using Newtonsoft.Json.Linq; |
| | | 7 | | |
| | | 8 | | namespace Jellyfin.Server.Migrations.Routines |
| | | 9 | | { |
| | | 10 | | /// <summary> |
| | | 11 | | /// Migration to initialize the user logging configuration file "logging.user.json". |
| | | 12 | | /// If the deprecated logging.json file exists and has a custom config, it will be used as logging.user.json, |
| | | 13 | | /// otherwise a blank file will be created. |
| | | 14 | | /// </summary> |
| | | 15 | | #pragma warning disable CS0618 // Type or member is obsolete |
| | | 16 | | [JellyfinMigration("2025-04-20T06:00:00", nameof(CreateUserLoggingConfigFile), "EF103419-8451-40D8-9F34-D1A8E93A1679 |
| | | 17 | | internal class CreateUserLoggingConfigFile : IMigrationRoutine |
| | | 18 | | #pragma warning restore CS0618 // Type or member is obsolete |
| | | 19 | | { |
| | | 20 | | /// <summary> |
| | | 21 | | /// File history for logging.json as existed during this migration creation. The contents for each has been mini |
| | | 22 | | /// </summary> |
| | 0 | 23 | | private readonly List<string> _defaultConfigHistory = new List<string> |
| | 0 | 24 | | { |
| | 0 | 25 | | // 9a6c27947353585391e211aa88b925f81e8cd7b9 |
| | 0 | 26 | | @"{""Serilog"":{""MinimumLevel"":{""Default"":""Information"",""Override"":{""Microsoft"":""Warning"",""Syst |
| | 0 | 27 | | // 71bdcd730705a714ee208eaad7290b7c68df3885 |
| | 0 | 28 | | @"{""Serilog"":{""MinimumLevel"":""Information"",""WriteTo"":[{""Name"":""Console"",""Args"":{""outputTempla |
| | 0 | 29 | | // a44936f97f8afc2817d3491615a7cfe1e31c251c |
| | 0 | 30 | | @"{""Serilog"":{""MinimumLevel"":""Information"",""WriteTo"":[{""Name"":""Console"",""Args"":{""outputTempla |
| | 0 | 31 | | // 7af3754a11ad5a4284f107997fb5419a010ce6f3 |
| | 0 | 32 | | @"{""Serilog"":{""MinimumLevel"":""Information"",""WriteTo"":[{""Name"":""Console"",""Args"":{""outputTempla |
| | 0 | 33 | | // 60691349a11f541958e0b2247c9abc13cb40c9fb |
| | 0 | 34 | | @"{""Serilog"":{""MinimumLevel"":""Information"",""WriteTo"":[{""Name"":""Console"",""Args"":{""outputTempla |
| | 0 | 35 | | // 65fe243afbcc4b596cf8726708c1965cd34b5f68 |
| | 0 | 36 | | @"{""Serilog"":{""MinimumLevel"":""Information"",""WriteTo"":[{""Name"":""Console"",""Args"":{""outputTempla |
| | 0 | 37 | | // 96c9af590494aa8137d5a061aaf1e68feee60b67 |
| | 0 | 38 | | @"{""Serilog"":{""MinimumLevel"":""Information"",""WriteTo"":[{""Name"":""Console"",""Args"":{""outputTempla |
| | 0 | 39 | | }; |
| | | 40 | | |
| | | 41 | | private readonly IApplicationPaths _appPaths; |
| | | 42 | | |
| | | 43 | | public CreateUserLoggingConfigFile(IApplicationPaths appPaths) |
| | | 44 | | { |
| | 0 | 45 | | _appPaths = appPaths; |
| | 0 | 46 | | } |
| | | 47 | | |
| | | 48 | | /// <inheritdoc/> |
| | | 49 | | public void Perform() |
| | | 50 | | { |
| | 0 | 51 | | var logDirectory = _appPaths.ConfigurationDirectoryPath; |
| | 0 | 52 | | var existingConfigPath = Path.Combine(logDirectory, "logging.json"); |
| | | 53 | | |
| | | 54 | | // If the existing logging.json config file is unmodified, then 'reset' it by moving it to 'logging.old.json |
| | | 55 | | // NOTE: This config file has 'reloadOnChange: true', so this change will take effect immediately even thoug |
| | 0 | 56 | | if (File.Exists(existingConfigPath) && ExistingConfigUnmodified(existingConfigPath)) |
| | | 57 | | { |
| | 0 | 58 | | File.Move(existingConfigPath, Path.Combine(logDirectory, "logging.old.json")); |
| | | 59 | | } |
| | 0 | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Check if the existing logging.json file has not been modified by the user by comparing it to all the |
| | | 64 | | /// versions in our git history. Until now, the file has never been migrated after first creation so users |
| | | 65 | | /// could have any version from the git history. |
| | | 66 | | /// </summary> |
| | | 67 | | /// <exception cref="IOException"><paramref name="oldConfigPath"/> does not exist or could not be read.</excepti |
| | | 68 | | private bool ExistingConfigUnmodified(string oldConfigPath) |
| | | 69 | | { |
| | 0 | 70 | | var existingConfigJson = JToken.Parse(File.ReadAllText(oldConfigPath)); |
| | 0 | 71 | | return _defaultConfigHistory |
| | 0 | 72 | | .Select(JToken.Parse) |
| | 0 | 73 | | .Any(historicalConfigJson => JToken.DeepEquals(existingConfigJson, historicalConfigJson)); |
| | | 74 | | } |
| | | 75 | | } |
| | | 76 | | } |