diff --git a/Emby.Server.Implementations/ApplicationHost.cs b/Emby.Server.Implementations/ApplicationHost.cs
index 903c31133..8892f7f40 100644
--- a/Emby.Server.Implementations/ApplicationHost.cs
+++ b/Emby.Server.Implementations/ApplicationHost.cs
@@ -313,22 +313,6 @@ namespace Emby.Server.Implementations
? Environment.MachineName
: ConfigurationManager.Configuration.ServerName;
- ///
- /// Temporary function to migration network settings out of system.xml and into network.xml.
- /// TODO: remove at the point when a fixed migration path has been decided upon.
- ///
- private void MigrateNetworkConfiguration()
- {
- string path = Path.Combine(ConfigurationManager.CommonApplicationPaths.ConfigurationDirectoryPath, "network.xml");
- if (!File.Exists(path))
- {
- var networkSettings = new NetworkConfiguration();
- ClassMigrationHelper.CopyProperties(ConfigurationManager.Configuration, networkSettings);
- _xmlSerializer.SerializeToFile(networkSettings, path);
- Logger.LogDebug("Successfully migrated network settings.");
- }
- }
-
public string ExpandVirtualPath(string path)
{
var appPaths = ApplicationPaths;
@@ -513,8 +497,6 @@ namespace Emby.Server.Implementations
ConfigurationManager.AddParts(GetExports());
- // Have to migrate settings here as migration subsystem not yet initialised.
- MigrateNetworkConfiguration();
NetManager = new NetworkManager(ConfigurationManager, LoggerFactory.CreateLogger());
// Initialize runtime stat collection
diff --git a/Jellyfin.Api/Helpers/ClassMigrationHelper.cs b/Jellyfin.Api/Helpers/ClassMigrationHelper.cs
deleted file mode 100644
index 76fb27bcc..000000000
--- a/Jellyfin.Api/Helpers/ClassMigrationHelper.cs
+++ /dev/null
@@ -1,71 +0,0 @@
-using System;
-using System.Reflection;
-
-namespace Jellyfin.Api.Helpers
-{
- ///
- /// A static class for copying matching properties from one object to another.
- /// TODO: remove at the point when a fixed migration path has been decided upon.
- ///
- public static class ClassMigrationHelper
- {
- ///
- /// Extension for 'Object' that copies the properties to a destination object.
- ///
- /// The source.
- /// The destination.
- public static void CopyProperties(this object source, object destination)
- {
- // If any this null throw an exception.
- if (source == null || destination == null)
- {
- throw new ArgumentException("Source or/and Destination Objects are null");
- }
-
- // Getting the Types of the objects.
- Type typeDest = destination.GetType();
- Type typeSrc = source.GetType();
-
- // Iterate the Properties of the source instance and populate them from their destination counterparts.
- PropertyInfo[] srcProps = typeSrc.GetProperties();
- foreach (PropertyInfo srcProp in srcProps)
- {
- if (!srcProp.CanRead)
- {
- continue;
- }
-
- var targetProperty = typeDest.GetProperty(srcProp.Name);
- if (targetProperty == null)
- {
- continue;
- }
-
- if (!targetProperty.CanWrite)
- {
- continue;
- }
-
- var obj = targetProperty.GetSetMethod(true);
- if (obj != null && obj.IsPrivate)
- {
- continue;
- }
-
- var target = targetProperty.GetSetMethod();
- if (target != null && (target.Attributes & MethodAttributes.Static) != 0)
- {
- continue;
- }
-
- if (!targetProperty.PropertyType.IsAssignableFrom(srcProp.PropertyType))
- {
- continue;
- }
-
- // Passed all tests, lets set the value.
- targetProperty.SetValue(destination, srcProp.GetValue(source, null), null);
- }
- }
- }
-}
diff --git a/Jellyfin.Server/Migrations/MigrationRunner.cs b/Jellyfin.Server/Migrations/MigrationRunner.cs
index 7365c8dbc..11b6c4912 100644
--- a/Jellyfin.Server/Migrations/MigrationRunner.cs
+++ b/Jellyfin.Server/Migrations/MigrationRunner.cs
@@ -1,6 +1,11 @@
using System;
+using System.Collections.Generic;
+using System.IO;
using System.Linq;
+using Emby.Server.Implementations;
+using Emby.Server.Implementations.Serialization;
using MediaBrowser.Common.Configuration;
+using MediaBrowser.Model.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
@@ -11,6 +16,14 @@ namespace Jellyfin.Server.Migrations
///
public sealed class MigrationRunner
{
+ ///
+ /// The list of known pre-startup migrations, in order of applicability.
+ ///
+ private static readonly Type[] _preStartupMigrationTypes =
+ {
+ typeof(PreStartupRoutines.CreateNetworkConfiguration)
+ };
+
///
/// The list of known migrations, in order of applicability.
///
@@ -29,6 +42,7 @@ namespace Jellyfin.Server.Migrations
typeof(Routines.MigrateAuthenticationDb)
};
+
///
/// Run all needed migrations.
///
@@ -41,17 +55,50 @@ namespace Jellyfin.Server.Migrations
.Select(m => ActivatorUtilities.CreateInstance(host.ServiceProvider, m))
.OfType()
.ToArray();
- var migrationOptions = host.ConfigurationManager.GetConfiguration(MigrationsListStore.StoreKey);
- if (!host.ConfigurationManager.Configuration.IsStartupWizardCompleted && migrationOptions.Applied.Count == 0)
+ var migrationOptions = host.ConfigurationManager.GetConfiguration(MigrationsListStore.StoreKey);
+ HandleStartupWizardCondition(migrations, migrationOptions, host.ConfigurationManager.Configuration.IsStartupWizardCompleted, logger);
+ PerformMigrations(migrations, migrationOptions, options => host.ConfigurationManager.SaveConfiguration(MigrationsListStore.StoreKey, options), logger);
+ }
+
+ ///
+ /// Run all needed pre-startup migrations.
+ ///
+ /// Application paths.
+ /// Factory for making the logger.
+ public static void RunPreStartup(ServerApplicationPaths appPaths, ILoggerFactory loggerFactory)
+ {
+ var logger = loggerFactory.CreateLogger();
+ var migrations = _preStartupMigrationTypes
+ .Select(m => Activator.CreateInstance(m, appPaths, loggerFactory))
+ .OfType()
+ .ToArray();
+
+ var xmlSerializer = new MyXmlSerializer();
+ var migrationConfigPath = Path.Join(appPaths.ConfigurationDirectoryPath, MigrationsListStore.StoreKey.ToLowerInvariant() + ".xml");
+ var migrationOptions = (MigrationOptions)xmlSerializer.DeserializeFromFile(typeof(MigrationOptions), migrationConfigPath)!;
+
+ // We have to deserialize it manually since the configuration manager may overwrite it
+ var serverConfig = (ServerConfiguration)xmlSerializer.DeserializeFromFile(typeof(ServerConfiguration), appPaths.SystemConfigurationFilePath)!;
+ HandleStartupWizardCondition(migrations, migrationOptions, serverConfig.IsStartupWizardCompleted, logger);
+ PerformMigrations(migrations, migrationOptions, options => xmlSerializer.SerializeToFile(options, migrationConfigPath), logger);
+ }
+
+ private static void HandleStartupWizardCondition(IEnumerable migrations, MigrationOptions migrationOptions, bool isStartWizardCompleted, ILogger logger)
+ {
+ if (isStartWizardCompleted || migrationOptions.Applied.Count != 0)
{
- // If startup wizard is not finished, this is a fresh install.
- // Don't run any migrations, just mark all of them as applied.
- logger.LogInformation("Marking all known migrations as applied because this is a fresh install");
- migrationOptions.Applied.AddRange(migrations.Where(m => !m.PerformOnNewInstall).Select(m => (m.Id, m.Name)));
- host.ConfigurationManager.SaveConfiguration(MigrationsListStore.StoreKey, migrationOptions);
+ return;
}
+ // If startup wizard is not finished, this is a fresh install.
+ var onlyOldInstalls = migrations.Where(m => !m.PerformOnNewInstall).ToArray();
+ logger.LogInformation("Marking following migrations as applied because this is a fresh install: {@OnlyOldInstalls}", onlyOldInstalls.Select(m => m.Name));
+ migrationOptions.Applied.AddRange(onlyOldInstalls.Select(m => (m.Id, m.Name)));
+ }
+
+ private static void PerformMigrations(IMigrationRoutine[] migrations, MigrationOptions migrationOptions, Action saveConfiguration, ILogger logger)
+ {
var appliedMigrationIds = migrationOptions.Applied.Select(m => m.Id).ToHashSet();
for (var i = 0; i < migrations.Length; i++)
@@ -78,7 +125,7 @@ namespace Jellyfin.Server.Migrations
// Mark the migration as completed
logger.LogInformation("Migration '{Name}' applied successfully", migrationRoutine.Name);
migrationOptions.Applied.Add((migrationRoutine.Id, migrationRoutine.Name));
- host.ConfigurationManager.SaveConfiguration(MigrationsListStore.StoreKey, migrationOptions);
+ saveConfiguration(migrationOptions);
logger.LogDebug("Migration '{Name}' marked as applied in configuration.", migrationRoutine.Name);
}
}
diff --git a/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs b/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs
new file mode 100644
index 000000000..98c845dc3
--- /dev/null
+++ b/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs
@@ -0,0 +1,140 @@
+using System;
+using System.IO;
+using System.Runtime.Serialization;
+using System.Xml;
+using System.Xml.Serialization;
+using Emby.Server.Implementations;
+using Microsoft.Extensions.Logging;
+
+namespace Jellyfin.Server.Migrations.PreStartupRoutines;
+
+///
+public class CreateNetworkConfiguration : IMigrationRoutine
+{
+ private readonly ServerApplicationPaths _applicationPaths;
+ private readonly ILogger _logger;
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// An instance of .
+ /// An instance of the interface.
+ public CreateNetworkConfiguration(ServerApplicationPaths applicationPaths, ILoggerFactory loggerFactory)
+ {
+ _applicationPaths = applicationPaths;
+ _logger = loggerFactory.CreateLogger();
+ }
+
+ ///
+ public Guid Id => Guid.Parse("9B354818-94D5-4B68-AC49-E35CB85F9D84");
+
+ ///
+ public string Name => nameof(CreateNetworkConfiguration);
+
+ ///
+ public bool PerformOnNewInstall => false;
+
+ ///
+ public void Perform()
+ {
+ string path = Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "network.xml");
+ if (File.Exists(path))
+ {
+ _logger.LogDebug("Network configuration file already exists, skipping");
+ return;
+ }
+
+ var serverConfigSerializer = new XmlSerializer(typeof(OldNetworkConfiguration), new XmlRootAttribute("ServerConfiguration"));
+ using var xmlReader = XmlReader.Create(_applicationPaths.SystemConfigurationFilePath);
+ var networkSettings = serverConfigSerializer.Deserialize(xmlReader);
+
+ var networkConfigSerializer = new XmlSerializer(typeof(OldNetworkConfiguration), new XmlRootAttribute("NetworkConfiguration"));
+ var xmlWriterSettings = new XmlWriterSettings { Indent = true };
+ using var xmlWriter = XmlWriter.Create(path, xmlWriterSettings);
+ networkConfigSerializer.Serialize(xmlWriter, networkSettings);
+ }
+
+#pragma warning disable CS1591
+ public sealed class OldNetworkConfiguration
+ {
+ public const int DefaultHttpPort = 8096;
+
+ public const int DefaultHttpsPort = 8920;
+
+ private string _baseUrl = string.Empty;
+
+ public bool RequireHttps { get; set; }
+
+ public string CertificatePath { get; set; } = string.Empty;
+
+ public string CertificatePassword { get; set; } = string.Empty;
+
+ public string BaseUrl
+ {
+ get => _baseUrl;
+ set
+ {
+ // Normalize the start of the string
+ if (string.IsNullOrWhiteSpace(value))
+ {
+ // If baseUrl is empty, set an empty prefix string
+ _baseUrl = string.Empty;
+ return;
+ }
+
+ if (value[0] != '/')
+ {
+ // If baseUrl was not configured with a leading slash, append one for consistency
+ value = "/" + value;
+ }
+
+ // Normalize the end of the string
+ if (value[^1] == '/')
+ {
+ // If baseUrl was configured with a trailing slash, remove it for consistency
+ value = value.Remove(value.Length - 1);
+ }
+
+ _baseUrl = value;
+ }
+ }
+
+ public int PublicHttpsPort { get; set; } = DefaultHttpsPort;
+
+ public int HttpServerPortNumber { get; set; } = DefaultHttpPort;
+
+ public int HttpsPortNumber { get; set; } = DefaultHttpsPort;
+
+ public bool EnableHttps { get; set; }
+
+ public int PublicPort { get; set; } = DefaultHttpPort;
+
+ public bool EnableIPV6 { get; set; }
+
+ [DataMember(Name = "EnableIPV4")]
+ public bool EnableIPV4 { get; set; } = true;
+
+ public bool IgnoreVirtualInterfaces { get; set; } = true;
+
+ public string VirtualInterfaceNames { get; set; } = "vEthernet*";
+
+ public bool TrustAllIP6Interfaces { get; set; }
+
+ public string[] PublishedServerUriBySubnet { get; set; } = Array.Empty();
+
+ public string[] RemoteIPFilter { get; set; } = Array.Empty();
+
+ public bool IsRemoteIPFilterBlacklist { get; set; }
+
+ public bool EnableUPnP { get; set; }
+
+ public bool EnableRemoteAccess { get; set; } = true;
+
+ public string[] LocalNetworkSubnets { get; set; } = Array.Empty();
+
+ public string[] LocalNetworkAddresses { get; set; } = Array.Empty();
+
+ public string[] KnownProxies { get; set; } = Array.Empty();
+ }
+#pragma warning restore CS1591
+}
diff --git a/Jellyfin.Server/Program.cs b/Jellyfin.Server/Program.cs
index 7f158aebb..f40526e22 100644
--- a/Jellyfin.Server/Program.cs
+++ b/Jellyfin.Server/Program.cs
@@ -175,6 +175,7 @@ namespace Jellyfin.Server
}
PerformStaticInitialization();
+ Migrations.MigrationRunner.RunPreStartup(appPaths, _loggerFactory);
var appHost = new CoreAppHost(
appPaths,
diff --git a/MediaBrowser.Model/Configuration/ServerConfiguration.cs b/MediaBrowser.Model/Configuration/ServerConfiguration.cs
index 0ab721b77..46e61ee1a 100644
--- a/MediaBrowser.Model/Configuration/ServerConfiguration.cs
+++ b/MediaBrowser.Model/Configuration/ServerConfiguration.cs
@@ -13,18 +13,6 @@ namespace MediaBrowser.Model.Configuration
///
public class ServerConfiguration : BaseApplicationConfiguration
{
- ///
- /// The default value for .
- ///
- public const int DefaultHttpPort = 8096;
-
- ///
- /// The default value for and .
- ///
- public const int DefaultHttpsPort = 8920;
-
- private string _baseUrl = string.Empty;
-
///
/// Initializes a new instance of the class.
///
@@ -75,149 +63,13 @@ namespace MediaBrowser.Model.Configuration
};
}
- ///
- /// Gets or sets a value indicating whether to enable automatic port forwarding.
- ///
- public bool EnableUPnP { get; set; } = false;
-
///
/// Gets or sets a value indicating whether to enable prometheus metrics exporting.
///
public bool EnableMetrics { get; set; } = false;
- ///
- /// Gets or sets the public mapped port.
- ///
- /// The public mapped port.
- public int PublicPort { get; set; } = DefaultHttpPort;
-
- ///
- /// Gets or sets a value indicating whether the http port should be mapped as part of UPnP automatic port forwarding.
- ///
- public bool UPnPCreateHttpPortMap { get; set; } = false;
-
- ///
- /// Gets or sets client udp port range.
- ///
- public string UDPPortRange { get; set; } = string.Empty;
-
- ///
- /// Gets or sets a value indicating whether IPV6 capability is enabled.
- ///
- public bool EnableIPV6 { get; set; } = false;
-
- ///
- /// Gets or sets a value indicating whether IPV4 capability is enabled.
- ///
- public bool EnableIPV4 { get; set; } = true;
-
- ///
- /// Gets or sets a value indicating whether detailed ssdp logs are sent to the console/log.
- /// "Emby.Dlna": "Debug" must be set in logging.default.json for this property to work.
- ///
- public bool EnableSSDPTracing { get; set; } = false;
-
- ///
- /// Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log.
- /// If the setting "Emby.Dlna": "Debug" msut be set in logging.default.json for this property to work.
- ///
- public string SSDPTracingFilter { get; set; } = string.Empty;
-
- ///
- /// Gets or sets the number of times SSDP UDP messages are sent.
- ///
- public int UDPSendCount { get; set; } = 2;
-
- ///
- /// Gets or sets the delay between each groups of SSDP messages (in ms).
- ///
- public int UDPSendDelay { get; set; } = 100;
-
- ///
- /// Gets or sets a value indicating whether address names that match should be Ignore for the purposes of binding.
- ///
- public bool IgnoreVirtualInterfaces { get; set; } = true;
-
- ///
- /// Gets or sets a value indicating the interfaces that should be ignored. The list can be comma separated. .
- ///
- public string VirtualInterfaceNames { get; set; } = "vEthernet*";
-
- ///
- /// Gets or sets the time (in seconds) between the pings of SSDP gateway monitor.
- ///
- public int GatewayMonitorPeriod { get; set; } = 60;
-
- ///
- /// Gets a value indicating whether multi-socket binding is available.
- ///
- public bool EnableMultiSocketBinding { get; } = true;
-
- ///
- /// Gets or sets a value indicating whether all IPv6 interfaces should be treated as on the internal network.
- /// Depending on the address range implemented ULA ranges might not be used.
- ///
- public bool TrustAllIP6Interfaces { get; set; } = false;
-
- ///
- /// Gets or sets the ports that HDHomerun uses.
- ///
- public string HDHomerunPortRange { get; set; } = string.Empty;
-
- ///
- /// Gets or sets PublishedServerUri to advertise for specific subnets.
- ///
- public string[] PublishedServerUriBySubnet { get; set; } = Array.Empty();
-
- ///
- /// Gets or sets a value indicating whether Autodiscovery tracing is enabled.
- ///
- public bool AutoDiscoveryTracing { get; set; } = false;
-
- ///
- /// Gets or sets a value indicating whether Autodiscovery is enabled.
- ///
- public bool AutoDiscovery { get; set; } = true;
-
- ///
- /// Gets or sets the public HTTPS port.
- ///
- /// The public HTTPS port.
- public int PublicHttpsPort { get; set; } = DefaultHttpsPort;
-
- ///
- /// Gets or sets the HTTP server port number.
- ///
- /// The HTTP server port number.
- public int HttpServerPortNumber { get; set; } = DefaultHttpPort;
-
- ///
- /// Gets or sets the HTTPS server port number.
- ///
- /// The HTTPS server port number.
- public int HttpsPortNumber { get; set; } = DefaultHttpsPort;
-
- ///
- /// Gets or sets a value indicating whether to use HTTPS.
- ///
- ///
- /// In order for HTTPS to be used, in addition to setting this to true, valid values must also be
- /// provided for and .
- ///
- public bool EnableHttps { get; set; } = false;
-
public bool EnableNormalizedItemByNameIds { get; set; } = true;
- ///
- /// Gets or sets the filesystem path of an X.509 certificate to use for SSL.
- ///
- public string CertificatePath { get; set; } = string.Empty;
-
- ///
- /// Gets or sets the password required to access the X.509 certificate data in the file specified by .
- ///
- public string CertificatePassword { get; set; } = string.Empty;
-
///
/// Gets or sets a value indicating whether this instance is port authorized.
///
@@ -229,11 +81,6 @@ namespace MediaBrowser.Model.Configuration
///
public bool QuickConnectAvailable { get; set; } = false;
- ///
- /// Gets or sets a value indicating whether access outside of the LAN is permitted.
- ///
- public bool EnableRemoteAccess { get; set; } = true;
-
///
/// Gets or sets a value indicating whether [enable case sensitive item ids].
///
@@ -318,13 +165,6 @@ namespace MediaBrowser.Model.Configuration
/// The file watcher delay.
public int LibraryMonitorDelay { get; set; } = 60;
- ///
- /// Gets or sets a value indicating whether [enable dashboard response caching].
- /// Allows potential contributors without visual studio to modify production dashboard code and test changes.
- ///
- /// true if [enable dashboard response caching]; otherwise, false.
- public bool EnableDashboardResponseCaching { get; set; } = true;
-
///
/// Gets or sets the image saving convention.
///
@@ -337,36 +177,6 @@ namespace MediaBrowser.Model.Configuration
public string ServerName { get; set; } = string.Empty;
- public string BaseUrl
- {
- get => _baseUrl;
- set
- {
- // Normalize the start of the string
- if (string.IsNullOrWhiteSpace(value))
- {
- // If baseUrl is empty, set an empty prefix string
- _baseUrl = string.Empty;
- return;
- }
-
- if (value[0] != '/')
- {
- // If baseUrl was not configured with a leading slash, append one for consistency
- value = "/" + value;
- }
-
- // Normalize the end of the string
- if (value[value.Length - 1] == '/')
- {
- // If baseUrl was configured with a trailing slash, remove it for consistency
- value = value.Remove(value.Length - 1);
- }
-
- _baseUrl = value;
- }
- }
-
public string UICulture { get; set; } = "en-US";
public bool SaveMetadataHidden { get; set; } = false;
@@ -381,43 +191,16 @@ namespace MediaBrowser.Model.Configuration
public bool DisplaySpecialsWithinSeasons { get; set; } = true;
- ///
- /// Gets or sets the subnets that are deemed to make up the LAN.
- ///
- public string[] LocalNetworkSubnets { get; set; } = Array.Empty();
-
- ///
- /// Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.
- ///
- public string[] LocalNetworkAddresses { get; set; } = Array.Empty();
-
public string[] CodecsUsed { get; set; } = Array.Empty();
public List PluginRepositories { get; set; } = new List();
public bool EnableExternalContentInSuggestions { get; set; } = true;
- ///
- /// Gets or sets a value indicating whether the server should force connections over HTTPS.
- ///
- public bool RequireHttps { get; set; } = false;
-
- ///
- /// Gets or sets the filter for remote IP connectivity. Used in conjuntion with .
- ///
- public string[] RemoteIPFilter { get; set; } = Array.Empty();
-
- ///
- /// Gets or sets a value indicating whether contains a blacklist or a whitelist. Default is a whitelist.
- ///
- public bool IsRemoteIPFilterBlacklist { get; set; } = false;
-
public int ImageExtractionTimeoutMs { get; set; } = 0;
public PathSubstitution[] PathSubstitutions { get; set; } = Array.Empty();
- public string[] UninstalledPlugins { get; set; } = Array.Empty();
-
///
/// Gets or sets a value indicating whether slow server responses should be logged as a warning.
///
@@ -433,11 +216,6 @@ namespace MediaBrowser.Model.Configuration
///
public string[] CorsHosts { get; set; } = new[] { "*" };
- ///
- /// Gets or sets the known proxies.
- ///
- public string[] KnownProxies { get; set; } = Array.Empty();
-
///
/// Gets or sets the number of days we should retain activity logs.
///