2019-01-13 20:54:44 +01:00
using System ;
2019-11-01 18:38:54 +01:00
using System.Globalization ;
2016-11-11 04:29:51 +01:00
using System.IO ;
2017-02-20 21:50:58 +01:00
using Emby.Server.Implementations.AppBase ;
2014-12-22 02:02:15 +01:00
using MediaBrowser.Common.Configuration ;
2013-03-04 06:43:06 +01:00
using MediaBrowser.Controller ;
using MediaBrowser.Controller.Configuration ;
using MediaBrowser.Model.Configuration ;
2014-05-08 22:09:53 +02:00
using MediaBrowser.Model.Events ;
2016-11-11 04:29:51 +01:00
using MediaBrowser.Model.IO ;
2013-03-04 06:43:06 +01:00
using MediaBrowser.Model.Serialization ;
2019-01-13 20:20:16 +01:00
using Microsoft.Extensions.Logging ;
2013-03-04 06:43:06 +01:00
2017-02-20 21:50:58 +01:00
namespace Emby.Server.Implementations.Configuration
2013-03-04 06:43:06 +01:00
{
/// <summary>
2019-11-08 12:49:00 +01:00
/// Class ServerConfigurationManager.
2013-03-04 06:43:06 +01:00
/// </summary>
public class ServerConfigurationManager : BaseConfigurationManager , IServerConfigurationManager
{
/// <summary>
/// Initializes a new instance of the <see cref="ServerConfigurationManager" /> class.
/// </summary>
/// <param name="applicationPaths">The application paths.</param>
2018-12-13 14:18:25 +01:00
/// <param name="loggerFactory">The paramref name="loggerFactory" factory.</param>
2013-03-04 06:43:06 +01:00
/// <param name="xmlSerializer">The XML serializer.</param>
2015-10-07 23:42:29 +02:00
/// <param name="fileSystem">The file system.</param>
2018-12-13 14:18:25 +01:00
public ServerConfigurationManager ( IApplicationPaths applicationPaths , ILoggerFactory loggerFactory , IXmlSerializer xmlSerializer , IFileSystem fileSystem )
: base ( applicationPaths , loggerFactory , xmlSerializer , fileSystem )
2013-03-04 06:43:06 +01:00
{
2014-03-25 22:13:55 +01:00
UpdateMetadataPath ( ) ;
2013-03-04 06:43:06 +01:00
}
2019-11-01 18:38:54 +01:00
/// <summary>
/// Configuration updating event.
/// </summary>
2014-05-07 20:38:50 +02:00
public event EventHandler < GenericEventArgs < ServerConfiguration > > ConfigurationUpdating ;
2013-03-04 06:43:06 +01:00
/// <summary>
/// Gets the type of the configuration.
/// </summary>
/// <value>The type of the configuration.</value>
2019-01-06 21:50:43 +01:00
protected override Type ConfigurationType = > typeof ( ServerConfiguration ) ;
2013-03-04 06:43:06 +01:00
/// <summary>
/// Gets the application paths.
/// </summary>
/// <value>The application paths.</value>
2019-01-06 21:50:43 +01:00
public IServerApplicationPaths ApplicationPaths = > ( IServerApplicationPaths ) CommonApplicationPaths ;
2013-03-04 06:43:06 +01:00
/// <summary>
/// Gets the configuration.
/// </summary>
/// <value>The configuration.</value>
2019-01-06 21:50:43 +01:00
public ServerConfiguration Configuration = > ( ServerConfiguration ) CommonConfiguration ;
2013-04-23 21:17:21 +02:00
/// <summary>
/// Called when [configuration updated].
/// </summary>
protected override void OnConfigurationUpdated ( )
{
2014-04-04 00:50:04 +02:00
UpdateMetadataPath ( ) ;
2013-04-23 21:17:21 +02:00
base . OnConfigurationUpdated ( ) ;
}
2014-03-25 22:13:55 +01:00
/// <summary>
/// Updates the metadata path.
/// </summary>
2020-04-26 21:30:37 +02:00
/// <exception cref="UnauthorizedAccessException">If the directory does not exist, and the caller does not have the required permission to create it.</exception>
/// <exception cref="NotSupportedException">If there is a custom path transcoding path specified, but it is invalid.</exception>
/// <exception cref="IOException">If the directory does not exist, and it also could not be created.</exception>
2014-03-25 22:13:55 +01:00
private void UpdateMetadataPath ( )
{
2020-04-14 22:01:21 +02:00
( ( ServerApplicationPaths ) ApplicationPaths ) . InternalMetadataPath = string . IsNullOrWhiteSpace ( Configuration . MetadataPath )
2020-04-26 21:30:37 +02:00
? ApplicationPaths . DefaultInternalMetadataPath
2020-04-14 22:01:21 +02:00
: Configuration . MetadataPath ;
2020-04-26 21:30:37 +02:00
Directory . CreateDirectory ( ApplicationPaths . InternalMetadataPath ) ;
2015-01-21 04:54:45 +01:00
}
2013-04-23 21:17:21 +02:00
/// <summary>
/// Replaces the configuration.
/// </summary>
/// <param name="newConfiguration">The new configuration.</param>
2020-04-14 22:01:21 +02:00
/// <exception cref="DirectoryNotFoundException">If the configuration path doesn't exist.</exception>
2013-04-23 21:17:21 +02:00
public override void ReplaceConfiguration ( BaseApplicationConfiguration newConfiguration )
{
2014-05-07 20:38:50 +02:00
var newConfig = ( ServerConfiguration ) newConfiguration ;
2013-04-23 21:17:21 +02:00
2014-03-25 22:13:55 +01:00
ValidateMetadataPath ( newConfig ) ;
2015-12-29 14:36:54 +01:00
ValidateSslCertificate ( newConfig ) ;
2013-12-15 02:17:57 +01:00
2020-04-05 18:10:56 +02:00
ConfigurationUpdating ? . Invoke ( this , new GenericEventArgs < ServerConfiguration > ( newConfig ) ) ;
2014-05-07 20:38:50 +02:00
2013-12-15 02:17:57 +01:00
base . ReplaceConfiguration ( newConfiguration ) ;
}
2015-12-29 14:36:54 +01:00
/// <summary>
/// Validates the SSL certificate.
/// </summary>
/// <param name="newConfig">The new configuration.</param>
2019-11-01 18:38:54 +01:00
/// <exception cref="FileNotFoundException">The certificate path doesn't exist.</exception>
2015-12-29 14:36:54 +01:00
private void ValidateSslCertificate ( BaseApplicationConfiguration newConfig )
{
var serverConfig = ( ServerConfiguration ) newConfig ;
2015-12-29 18:15:19 +01:00
var newPath = serverConfig . CertificatePath ;
2015-12-29 14:36:54 +01:00
2015-12-29 18:15:19 +01:00
if ( ! string . IsNullOrWhiteSpace ( newPath )
2019-11-01 18:38:54 +01:00
& & ! string . Equals ( Configuration . CertificatePath , newPath , StringComparison . Ordinal ) )
2015-12-29 14:36:54 +01:00
{
// Validate
2019-01-26 22:59:53 +01:00
if ( ! File . Exists ( newPath ) )
2015-12-29 14:36:54 +01:00
{
2019-11-01 18:38:54 +01:00
throw new FileNotFoundException (
string . Format (
CultureInfo . InvariantCulture ,
"Certificate file '{0}' does not exist." ,
newPath ) ) ;
2015-12-29 14:36:54 +01:00
}
}
}
2014-03-25 22:13:55 +01:00
/// <summary>
/// Validates the metadata path.
/// </summary>
/// <param name="newConfig">The new configuration.</param>
2019-11-01 18:38:54 +01:00
/// <exception cref="DirectoryNotFoundException">The new config path doesn't exist.</exception>
2014-03-25 22:13:55 +01:00
private void ValidateMetadataPath ( ServerConfiguration newConfig )
{
var newPath = newConfig . MetadataPath ;
if ( ! string . IsNullOrWhiteSpace ( newPath )
2020-03-24 16:12:06 +01:00
& & ! string . Equals ( Configuration . MetadataPath , newPath , StringComparison . Ordinal ) )
2014-03-25 22:13:55 +01:00
{
// Validate
2019-01-26 22:59:53 +01:00
if ( ! Directory . Exists ( newPath ) )
2014-03-25 22:13:55 +01:00
{
2019-11-01 18:38:54 +01:00
throw new DirectoryNotFoundException (
string . Format (
CultureInfo . InvariantCulture ,
"{0} does not exist." ,
newPath ) ) ;
2014-03-25 22:13:55 +01:00
}
2015-10-06 16:59:42 +02:00
EnsureWriteAccess ( newPath ) ;
2014-03-25 22:13:55 +01:00
}
}
2014-07-11 06:27:46 +02:00
2019-11-01 18:38:54 +01:00
/// <summary>
2019-12-10 16:22:03 +01:00
/// Sets all configuration values to their optimal values.
2019-11-01 18:38:54 +01:00
/// </summary>
/// <returns>If the configuration changed.</returns>
2017-11-01 20:50:16 +01:00
public bool SetOptimalValues ( )
2014-07-11 06:27:46 +02:00
{
2017-11-01 20:50:16 +01:00
var config = Configuration ;
2014-07-11 06:27:46 +02:00
2017-11-01 20:50:16 +01:00
var changed = false ;
2014-07-11 06:27:46 +02:00
2017-11-01 20:50:16 +01:00
if ( ! config . EnableCaseSensitiveItemIds )
2014-07-11 06:27:46 +02:00
{
2017-11-01 20:50:16 +01:00
config . EnableCaseSensitiveItemIds = true ;
changed = true ;
}
2014-07-11 06:27:46 +02:00
2017-11-01 20:50:16 +01:00
if ( ! config . SkipDeserializationForBasicTypes )
{
config . SkipDeserializationForBasicTypes = true ;
changed = true ;
2014-07-11 06:27:46 +02:00
}
2017-11-01 20:50:16 +01:00
if ( ! config . EnableSimpleArtistDetection )
{
config . EnableSimpleArtistDetection = true ;
changed = true ;
}
2014-07-11 06:27:46 +02:00
2017-11-01 20:50:16 +01:00
if ( ! config . EnableNormalizedItemByNameIds )
2014-07-11 06:27:46 +02:00
{
2017-11-01 20:50:16 +01:00
config . EnableNormalizedItemByNameIds = true ;
changed = true ;
}
2014-07-11 06:27:46 +02:00
2017-11-01 20:50:16 +01:00
if ( ! config . DisableLiveTvChannelUserDataName )
{
config . DisableLiveTvChannelUserDataName = true ;
changed = true ;
}
2014-07-11 06:27:46 +02:00
2017-11-01 20:50:16 +01:00
if ( ! config . EnableNewOmdbSupport )
{
config . EnableNewOmdbSupport = true ;
changed = true ;
}
2014-07-11 06:27:46 +02:00
2018-09-12 19:26:21 +02:00
if ( ! config . CollectionsUpgraded )
{
config . CollectionsUpgraded = true ;
changed = true ;
}
2017-11-01 20:50:16 +01:00
return changed ;
2014-07-11 06:27:46 +02:00
}
2013-03-04 06:43:06 +01:00
}
}