| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Diagnostics; |
| | | 4 | | using System.Globalization; |
| | | 5 | | using System.IO; |
| | | 6 | | using System.Linq; |
| | | 7 | | using System.Reflection; |
| | | 8 | | using System.Threading; |
| | | 9 | | using System.Threading.Tasks; |
| | | 10 | | using CommandLine; |
| | | 11 | | using Emby.Server.Implementations; |
| | | 12 | | using Emby.Server.Implementations.Configuration; |
| | | 13 | | using Emby.Server.Implementations.Serialization; |
| | | 14 | | using Jellyfin.Database.Implementations; |
| | | 15 | | using Jellyfin.Server.Extensions; |
| | | 16 | | using Jellyfin.Server.Helpers; |
| | | 17 | | using Jellyfin.Server.Implementations.DatabaseConfiguration; |
| | | 18 | | using Jellyfin.Server.Implementations.Extensions; |
| | | 19 | | using Jellyfin.Server.Implementations.StorageHelpers; |
| | | 20 | | using Jellyfin.Server.Implementations.SystemBackupService; |
| | | 21 | | using Jellyfin.Server.Migrations; |
| | | 22 | | using Jellyfin.Server.Migrations.Stages; |
| | | 23 | | using Jellyfin.Server.ServerSetupApp; |
| | | 24 | | using MediaBrowser.Common.Configuration; |
| | | 25 | | using MediaBrowser.Common.Net; |
| | | 26 | | using MediaBrowser.Controller; |
| | | 27 | | using Microsoft.AspNetCore.Hosting; |
| | | 28 | | using Microsoft.EntityFrameworkCore; |
| | | 29 | | using Microsoft.Extensions.Configuration; |
| | | 30 | | using Microsoft.Extensions.DependencyInjection; |
| | | 31 | | using Microsoft.Extensions.Hosting; |
| | | 32 | | using Microsoft.Extensions.Logging; |
| | | 33 | | using Microsoft.Extensions.Logging.Abstractions; |
| | | 34 | | using Serilog; |
| | | 35 | | using Serilog.Extensions.Logging; |
| | | 36 | | using static MediaBrowser.Controller.Extensions.ConfigurationExtensions; |
| | | 37 | | using ILogger = Microsoft.Extensions.Logging.ILogger; |
| | | 38 | | |
| | | 39 | | namespace Jellyfin.Server |
| | | 40 | | { |
| | | 41 | | /// <summary> |
| | | 42 | | /// Class containing the entry point of the application. |
| | | 43 | | /// </summary> |
| | | 44 | | public static class Program |
| | | 45 | | { |
| | | 46 | | /// <summary> |
| | | 47 | | /// The name of logging configuration file containing application defaults. |
| | | 48 | | /// </summary> |
| | | 49 | | public const string LoggingConfigFileDefault = "logging.default.json"; |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// The name of the logging configuration file containing the system-specific override settings. |
| | | 53 | | /// </summary> |
| | | 54 | | public const string LoggingConfigFileSystem = "logging.json"; |
| | | 55 | | |
| | 1 | 56 | | private static readonly SerilogLoggerFactory _loggerFactory = new SerilogLoggerFactory(); |
| | | 57 | | private static SetupServer? _setupServer; |
| | | 58 | | private static CoreAppHost? _appHost; |
| | 1 | 59 | | private static IHost? _jellyfinHost = null; |
| | | 60 | | private static long _startTimestamp; |
| | 1 | 61 | | private static ILogger _logger = NullLogger.Instance; |
| | | 62 | | private static bool _restartOnShutdown; |
| | | 63 | | private static IStartupLogger<JellyfinMigrationService>? _migrationLogger; |
| | | 64 | | private static string? _restoreFromBackup; |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// The entry point of the application. |
| | | 68 | | /// </summary> |
| | | 69 | | /// <param name="args">The command line arguments passed.</param> |
| | | 70 | | /// <returns><see cref="Task" />.</returns> |
| | | 71 | | public static Task Main(string[] args) |
| | | 72 | | { |
| | | 73 | | static Task ErrorParsingArguments(IEnumerable<Error> errors) |
| | | 74 | | { |
| | | 75 | | Environment.ExitCode = 1; |
| | | 76 | | return Task.CompletedTask; |
| | | 77 | | } |
| | | 78 | | |
| | | 79 | | // Parse the command line arguments and either start the app or exit indicating error |
| | 0 | 80 | | return Parser.Default.ParseArguments<StartupOptions>(args) |
| | 0 | 81 | | .MapResult(StartApp, ErrorParsingArguments); |
| | | 82 | | } |
| | | 83 | | |
| | | 84 | | private static async Task StartApp(StartupOptions options) |
| | | 85 | | { |
| | 0 | 86 | | _restoreFromBackup = options.RestoreArchive; |
| | 0 | 87 | | _startTimestamp = Stopwatch.GetTimestamp(); |
| | 0 | 88 | | ServerApplicationPaths appPaths = StartupHelpers.CreateApplicationPaths(options); |
| | 0 | 89 | | appPaths.MakeSanityCheckOrThrow(); |
| | | 90 | | |
| | | 91 | | // $JELLYFIN_LOG_DIR needs to be set for the logger configuration manager |
| | 0 | 92 | | Environment.SetEnvironmentVariable("JELLYFIN_LOG_DIR", appPaths.LogDirectoryPath); |
| | | 93 | | |
| | | 94 | | // Enable cl-va P010 interop for tonemapping on Intel VAAPI |
| | 0 | 95 | | Environment.SetEnvironmentVariable("NEOReadDebugKeys", "1"); |
| | 0 | 96 | | Environment.SetEnvironmentVariable("EnableExtendedVaFormats", "1"); |
| | | 97 | | |
| | 0 | 98 | | await StartupHelpers.InitLoggingConfigFile(appPaths).ConfigureAwait(false); |
| | | 99 | | |
| | | 100 | | // Create an instance of the application configuration to use for application startup |
| | 0 | 101 | | IConfiguration startupConfig = CreateAppConfiguration(options, appPaths); |
| | 0 | 102 | | StartupHelpers.InitializeLoggingFramework(startupConfig, appPaths); |
| | 0 | 103 | | _setupServer = new SetupServer(static () => _jellyfinHost?.Services?.GetService<INetworkManager>(), appPaths |
| | 0 | 104 | | await _setupServer.RunAsync().ConfigureAwait(false); |
| | 0 | 105 | | _logger = _loggerFactory.CreateLogger("Main"); |
| | 0 | 106 | | StartupLogger.Logger = new StartupLogger(_logger); |
| | | 107 | | |
| | | 108 | | // Use the logging framework for uncaught exceptions instead of std error |
| | 0 | 109 | | AppDomain.CurrentDomain.UnhandledException += (_, e) |
| | 0 | 110 | | => _logger.LogCritical((Exception)e.ExceptionObject, "Unhandled Exception"); |
| | | 111 | | |
| | 0 | 112 | | _logger.LogInformation( |
| | 0 | 113 | | "Jellyfin version: {Version}", |
| | 0 | 114 | | Assembly.GetEntryAssembly()!.GetName().Version!.ToString(3)); |
| | | 115 | | |
| | 0 | 116 | | StartupHelpers.LogEnvironmentInfo(_logger, appPaths); |
| | | 117 | | |
| | | 118 | | // If hosting the web client, validate the client content path |
| | 0 | 119 | | if (startupConfig.HostWebClient()) |
| | | 120 | | { |
| | 0 | 121 | | var webContentPath = appPaths.WebPath; |
| | 0 | 122 | | if (!Directory.Exists(webContentPath) || !Directory.EnumerateFiles(webContentPath).Any()) |
| | | 123 | | { |
| | 0 | 124 | | _logger.LogError( |
| | 0 | 125 | | "The server is expected to host the web client, but the provided content directory is either " + |
| | 0 | 126 | | "invalid or empty: {WebContentPath}. If you do not want to host the web client with the " + |
| | 0 | 127 | | "server, you may set the '--nowebclient' command line flag, or set" + |
| | 0 | 128 | | "'{ConfigKey}=false' in your config settings", |
| | 0 | 129 | | webContentPath, |
| | 0 | 130 | | HostWebClientKey); |
| | 0 | 131 | | Environment.ExitCode = 1; |
| | 0 | 132 | | return; |
| | | 133 | | } |
| | | 134 | | } |
| | | 135 | | |
| | 0 | 136 | | StorageHelper.TestCommonPathsForStorageCapacity(appPaths, StartupLogger.Logger.With(_loggerFactory.CreateLog |
| | | 137 | | |
| | 0 | 138 | | StartupHelpers.PerformStaticInitialization(); |
| | | 139 | | |
| | 0 | 140 | | await ApplyStartupMigrationAsync(appPaths, startupConfig).ConfigureAwait(false); |
| | | 141 | | |
| | | 142 | | do |
| | | 143 | | { |
| | 0 | 144 | | await StartServer(appPaths, options, startupConfig).ConfigureAwait(false); |
| | | 145 | | |
| | 0 | 146 | | if (_restartOnShutdown) |
| | | 147 | | { |
| | 0 | 148 | | _startTimestamp = Stopwatch.GetTimestamp(); |
| | 0 | 149 | | await _setupServer.StopAsync().ConfigureAwait(false); |
| | 0 | 150 | | await _setupServer.RunAsync().ConfigureAwait(false); |
| | | 151 | | } |
| | 0 | 152 | | } while (_restartOnShutdown); |
| | | 153 | | |
| | 0 | 154 | | _setupServer.Dispose(); |
| | 0 | 155 | | } |
| | | 156 | | |
| | | 157 | | private static async Task StartServer(IServerApplicationPaths appPaths, StartupOptions options, IConfiguration s |
| | | 158 | | { |
| | 0 | 159 | | using CoreAppHost appHost = new CoreAppHost( |
| | 0 | 160 | | appPaths, |
| | 0 | 161 | | _loggerFactory, |
| | 0 | 162 | | options, |
| | 0 | 163 | | startupConfig); |
| | 0 | 164 | | var configurationCompleted = false; |
| | | 165 | | try |
| | | 166 | | { |
| | 0 | 167 | | _jellyfinHost = Host.CreateDefaultBuilder() |
| | 0 | 168 | | .UseConsoleLifetime() |
| | 0 | 169 | | .ConfigureServices(services => appHost.Init(services)) |
| | 0 | 170 | | .ConfigureWebHostDefaults(webHostBuilder => |
| | 0 | 171 | | { |
| | 0 | 172 | | webHostBuilder.ConfigureWebHostBuilder(appHost, startupConfig, appPaths, _logger); |
| | 0 | 173 | | if (bool.TryParse(Environment.GetEnvironmentVariable("JELLYFIN_ENABLE_IIS"), out var iisEnabled) |
| | 0 | 174 | | { |
| | 0 | 175 | | _logger.LogCritical("UNSUPPORTED HOSTING ENVIRONMENT Microsoft Internet Information Services |
| | 0 | 176 | | webHostBuilder.UseIIS(); |
| | 0 | 177 | | } |
| | 0 | 178 | | }) |
| | 0 | 179 | | .ConfigureAppConfiguration(config => config.ConfigureAppConfiguration(options, appPaths, startupConf |
| | 0 | 180 | | .UseSerilog() |
| | 0 | 181 | | .ConfigureServices(e => e |
| | 0 | 182 | | .RegisterStartupLogger() |
| | 0 | 183 | | .AddSingleton<IServiceCollection>(e)) |
| | 0 | 184 | | .Build(); |
| | | 185 | | |
| | | 186 | | /* |
| | | 187 | | * Initialize the transcode path marker so we avoid starting Jellyfin in a broken state. |
| | | 188 | | * This should really be a part of IApplicationPaths but this path is configured differently. |
| | | 189 | | */ |
| | 0 | 190 | | _ = appHost.ConfigurationManager.GetTranscodePath(); |
| | | 191 | | |
| | | 192 | | // Re-use the host service provider in the app host since ASP.NET doesn't allow a custom service collect |
| | 0 | 193 | | appHost.ServiceProvider = _jellyfinHost.Services; |
| | 0 | 194 | | PrepareDatabaseProvider(appHost.ServiceProvider); |
| | | 195 | | |
| | 0 | 196 | | if (!string.IsNullOrWhiteSpace(_restoreFromBackup)) |
| | | 197 | | { |
| | 0 | 198 | | await appHost.ServiceProvider.GetService<IBackupService>()!.RestoreBackupAsync(_restoreFromBackup).C |
| | 0 | 199 | | _restoreFromBackup = null; |
| | 0 | 200 | | _restartOnShutdown = true; |
| | 0 | 201 | | return; |
| | | 202 | | } |
| | | 203 | | |
| | 0 | 204 | | var jellyfinMigrationService = ActivatorUtilities.CreateInstance<JellyfinMigrationService>(appHost.Servi |
| | 0 | 205 | | await jellyfinMigrationService.PrepareSystemForMigration(_logger).ConfigureAwait(false); |
| | 0 | 206 | | await jellyfinMigrationService.MigrateStepAsync(JellyfinMigrationStageTypes.CoreInitialisation, appHost. |
| | | 207 | | |
| | 0 | 208 | | await appHost.InitializeServices(startupConfig).ConfigureAwait(false); |
| | 0 | 209 | | _appHost = appHost; |
| | | 210 | | |
| | 0 | 211 | | await jellyfinMigrationService.MigrateStepAsync(JellyfinMigrationStageTypes.AppInitialisation, appHost.S |
| | 0 | 212 | | await jellyfinMigrationService.CleanupSystemAfterMigration(_logger).ConfigureAwait(false); |
| | | 213 | | try |
| | | 214 | | { |
| | 0 | 215 | | configurationCompleted = true; |
| | 0 | 216 | | await _setupServer!.StopAsync().ConfigureAwait(false); |
| | 0 | 217 | | await _jellyfinHost.StartAsync().ConfigureAwait(false); |
| | | 218 | | |
| | 0 | 219 | | if (!OperatingSystem.IsWindows() && startupConfig.UseUnixSocket()) |
| | | 220 | | { |
| | 0 | 221 | | var socketPath = StartupHelpers.GetUnixSocketPath(startupConfig, appPaths); |
| | | 222 | | |
| | 0 | 223 | | StartupHelpers.SetUnixSocketPermissions(startupConfig, socketPath, _logger); |
| | | 224 | | } |
| | 0 | 225 | | } |
| | 0 | 226 | | catch (Exception) |
| | | 227 | | { |
| | 0 | 228 | | _logger.LogError("Kestrel failed to start! This is most likely due to an invalid address or port bin |
| | 0 | 229 | | throw; |
| | | 230 | | } |
| | | 231 | | |
| | 0 | 232 | | await appHost.RunStartupTasksAsync().ConfigureAwait(false); |
| | | 233 | | |
| | 0 | 234 | | _logger.LogInformation("Startup complete {Time:g}", Stopwatch.GetElapsedTime(_startTimestamp)); |
| | | 235 | | |
| | 0 | 236 | | await _jellyfinHost.WaitForShutdownAsync().ConfigureAwait(false); |
| | 0 | 237 | | _restartOnShutdown = appHost.ShouldRestart; |
| | 0 | 238 | | _restoreFromBackup = appHost.RestoreBackupPath; |
| | 0 | 239 | | } |
| | 0 | 240 | | catch (Exception ex) |
| | | 241 | | { |
| | 0 | 242 | | _restartOnShutdown = false; |
| | 0 | 243 | | _logger.LogCritical(ex, "Error while starting server"); |
| | 0 | 244 | | if (_setupServer!.IsAlive && !configurationCompleted) |
| | | 245 | | { |
| | 0 | 246 | | _setupServer!.SoftStop(); |
| | 0 | 247 | | await Task.Delay(TimeSpan.FromMinutes(10)).ConfigureAwait(false); |
| | 0 | 248 | | await _setupServer!.StopAsync().ConfigureAwait(false); |
| | | 249 | | } |
| | | 250 | | } |
| | | 251 | | finally |
| | | 252 | | { |
| | | 253 | | // Don't throw additional exception if startup failed. |
| | 0 | 254 | | if (appHost.ServiceProvider is not null) |
| | | 255 | | { |
| | 0 | 256 | | _logger.LogInformation("Running query planner optimizations in the database... This might take a whi |
| | | 257 | | |
| | 0 | 258 | | var databaseProvider = appHost.ServiceProvider.GetRequiredService<IJellyfinDatabaseProvider>(); |
| | 0 | 259 | | using var shutdownSource = new CancellationTokenSource(); |
| | 0 | 260 | | shutdownSource.CancelAfter((int)TimeSpan.FromSeconds(60).TotalMicroseconds); |
| | 0 | 261 | | await databaseProvider.RunShutdownTask(shutdownSource.Token).ConfigureAwait(false); |
| | 0 | 262 | | } |
| | | 263 | | |
| | 0 | 264 | | _appHost = null; |
| | 0 | 265 | | _jellyfinHost?.Dispose(); |
| | 0 | 266 | | _jellyfinHost = null; |
| | | 267 | | } |
| | 0 | 268 | | } |
| | | 269 | | |
| | | 270 | | /// <summary> |
| | | 271 | | /// [Internal]Runs the startup Migrations. |
| | | 272 | | /// </summary> |
| | | 273 | | /// <remarks> |
| | | 274 | | /// Not intended to be used other then by jellyfin and its tests. |
| | | 275 | | /// </remarks> |
| | | 276 | | /// <param name="appPaths">Application Paths.</param> |
| | | 277 | | /// <param name="startupConfig">Startup Config.</param> |
| | | 278 | | /// <returns>A task.</returns> |
| | | 279 | | public static async Task ApplyStartupMigrationAsync(ServerApplicationPaths appPaths, IConfiguration startupConfi |
| | | 280 | | { |
| | 21 | 281 | | _migrationLogger = StartupLogger.Logger.BeginGroup<JellyfinMigrationService>($"Migration Service"); |
| | 21 | 282 | | var startupConfigurationManager = new ServerConfigurationManager(appPaths, _loggerFactory, new MyXmlSerializ |
| | 21 | 283 | | startupConfigurationManager.AddParts([new DatabaseConfigurationFactory()]); |
| | 21 | 284 | | var migrationStartupServiceProvider = new ServiceCollection() |
| | 21 | 285 | | .AddLogging(d => d.AddSerilog()) |
| | 21 | 286 | | .AddJellyfinDbContext(startupConfigurationManager, startupConfig) |
| | 21 | 287 | | .AddSingleton<IApplicationPaths>(appPaths) |
| | 21 | 288 | | .AddSingleton<ServerApplicationPaths>(appPaths) |
| | 21 | 289 | | .RegisterStartupLogger(); |
| | | 290 | | |
| | 21 | 291 | | migrationStartupServiceProvider.AddSingleton(migrationStartupServiceProvider); |
| | 21 | 292 | | var startupService = migrationStartupServiceProvider.BuildServiceProvider(); |
| | | 293 | | |
| | 21 | 294 | | PrepareDatabaseProvider(startupService); |
| | | 295 | | |
| | 21 | 296 | | var jellyfinMigrationService = ActivatorUtilities.CreateInstance<JellyfinMigrationService>(startupService); |
| | 21 | 297 | | await jellyfinMigrationService.CheckFirstTimeRunOrMigration(appPaths).ConfigureAwait(false); |
| | 21 | 298 | | await jellyfinMigrationService.MigrateStepAsync(Migrations.Stages.JellyfinMigrationStageTypes.PreInitialisat |
| | 21 | 299 | | } |
| | | 300 | | |
| | | 301 | | /// <summary> |
| | | 302 | | /// [Internal]Runs the Jellyfin migrator service with the Core stage. |
| | | 303 | | /// </summary> |
| | | 304 | | /// <remarks> |
| | | 305 | | /// Not intended to be used other then by jellyfin and its tests. |
| | | 306 | | /// </remarks> |
| | | 307 | | /// <param name="serviceProvider">The service provider.</param> |
| | | 308 | | /// <param name="jellyfinMigrationStage">The stage to run.</param> |
| | | 309 | | /// <returns>A task.</returns> |
| | | 310 | | public static async Task ApplyCoreMigrationsAsync(IServiceProvider serviceProvider, Migrations.Stages.JellyfinMi |
| | | 311 | | { |
| | 42 | 312 | | var jellyfinMigrationService = ActivatorUtilities.CreateInstance<JellyfinMigrationService>(serviceProvider, |
| | 42 | 313 | | await jellyfinMigrationService.MigrateStepAsync(jellyfinMigrationStage, serviceProvider).ConfigureAwait(fals |
| | 42 | 314 | | } |
| | | 315 | | |
| | | 316 | | /// <summary> |
| | | 317 | | /// Create the application configuration. |
| | | 318 | | /// </summary> |
| | | 319 | | /// <param name="commandLineOpts">The command line options passed to the program.</param> |
| | | 320 | | /// <param name="appPaths">The application paths.</param> |
| | | 321 | | /// <returns>The application configuration.</returns> |
| | | 322 | | public static IConfiguration CreateAppConfiguration(StartupOptions commandLineOpts, IApplicationPaths appPaths) |
| | | 323 | | { |
| | 21 | 324 | | return new ConfigurationBuilder() |
| | 21 | 325 | | .ConfigureAppConfiguration(commandLineOpts, appPaths) |
| | 21 | 326 | | .Build(); |
| | | 327 | | } |
| | | 328 | | |
| | | 329 | | private static IConfigurationBuilder ConfigureAppConfiguration( |
| | | 330 | | this IConfigurationBuilder config, |
| | | 331 | | StartupOptions commandLineOpts, |
| | | 332 | | IApplicationPaths appPaths, |
| | | 333 | | IConfiguration? startupConfig = null) |
| | | 334 | | { |
| | | 335 | | // Use the swagger API page as the default redirect path if not hosting the web client |
| | 21 | 336 | | var inMemoryDefaultConfig = ConfigurationOptions.DefaultConfiguration; |
| | 21 | 337 | | if (startupConfig is not null && !startupConfig.HostWebClient()) |
| | | 338 | | { |
| | 0 | 339 | | inMemoryDefaultConfig[DefaultRedirectKey] = "api-docs/swagger"; |
| | | 340 | | } |
| | | 341 | | |
| | 21 | 342 | | return config |
| | 21 | 343 | | .SetBasePath(appPaths.ConfigurationDirectoryPath) |
| | 21 | 344 | | .AddInMemoryCollection(inMemoryDefaultConfig) |
| | 21 | 345 | | .AddJsonFile(LoggingConfigFileDefault, optional: false, reloadOnChange: true) |
| | 21 | 346 | | .AddJsonFile(LoggingConfigFileSystem, optional: true, reloadOnChange: true) |
| | 21 | 347 | | .AddEnvironmentVariables("JELLYFIN_") |
| | 21 | 348 | | .AddInMemoryCollection(commandLineOpts.ConvertToConfig()); |
| | | 349 | | } |
| | | 350 | | |
| | | 351 | | private static void PrepareDatabaseProvider(IServiceProvider services) |
| | | 352 | | { |
| | 21 | 353 | | var factory = services.GetRequiredService<IDbContextFactory<JellyfinDbContext>>(); |
| | 21 | 354 | | var provider = services.GetRequiredService<IJellyfinDatabaseProvider>(); |
| | 21 | 355 | | provider.DbContextFactory = factory; |
| | 21 | 356 | | } |
| | | 357 | | } |
| | | 358 | | } |