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

Fix some documentation warnings for MediaBrowser.XbmcMetadata

Browse Source
This commit is contained in:
Bond_009 2019-08-18 19:54:07 +02:00
parent 2638759b42
commit 0803a916aa
20 changed files with 332 additions and 386 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
MediaBrowser.XbmcMetadata/Configuration/NfoOptions.cs
View File

@ -6,6 +6,7 @@ namespace MediaBrowser.XbmcMetadata.Configuration
{ {
public class ConfigurationFactory : IConfigurationFactory public class ConfigurationFactory : IConfigurationFactory
{ {
/// <inheritdoc />
public IEnumerable<ConfigurationStore> GetConfigurations() public IEnumerable<ConfigurationStore> GetConfigurations()
{ {
return new[] return new[]

35
MediaBrowser.XbmcMetadata/Parsers/BaseNfoParser.cs
View File

@ -22,13 +22,6 @@ namespace MediaBrowser.XbmcMetadata.Parsers
public class BaseNfoParser<T> public class BaseNfoParser<T>
where T : BaseItem where T : BaseItem
{ {
/// <summary>
/// The logger
/// </summary>
protected ILogger Logger { get; private set; }
protected IProviderManager ProviderManager { get; private set; }
private readonly CultureInfo _usCulture = new CultureInfo("en-US");
private readonly IConfigurationManager _config; private readonly IConfigurationManager _config;
private Dictionary<string, string> _validProviderIds; private Dictionary<string, string> _validProviderIds;
@ -42,6 +35,20 @@ namespace MediaBrowser.XbmcMetadata.Parsers
ProviderManager = providerManager; ProviderManager = providerManager;
} }
protected CultureInfo UsCulture { get; } = new CultureInfo("en-US");
/// <summary>
/// Gets the logger.
/// </summary>
protected ILogger Logger { get; }
protected IProviderManager ProviderManager { get; }
protected virtual bool SupportsUrlAfterClosingXmlTag => false;
protected virtual string MovieDbParserSearchString => "themoviedb.org/movie/";
/// <summary> /// <summary>
/// Fetches metadata for an item from one xml file /// Fetches metadata for an item from one xml file
/// </summary> /// </summary>
@ -83,8 +90,6 @@ namespace MediaBrowser.XbmcMetadata.Parsers
Fetch(item, metadataFile, GetXmlReaderSettings(), cancellationToken); Fetch(item, metadataFile, GetXmlReaderSettings(), cancellationToken);
} }
protected virtual bool SupportsUrlAfterClosingXmlTag => false;
/// <summary> /// <summary>
/// Fetches the specified item. /// Fetches the specified item.
/// </summary> /// </summary>
@ -198,8 +203,6 @@ namespace MediaBrowser.XbmcMetadata.Parsers
} }
} }
protected virtual string MovieDbParserSearchString => "themoviedb.org/movie/";
protected void ParseProviderLinks(T item, string xml) protected void ParseProviderLinks(T item, string xml)
{ {
//Look for a match for the Regex pattern "tt" followed by 7 digits //Look for a match for the Regex pattern "tt" followed by 7 digits
@ -219,7 +222,7 @@ namespace MediaBrowser.XbmcMetadata.Parsers
var tmdbId = xml.Substring(index + srch.Length).TrimEnd('/').Split('-')[0]; var tmdbId = xml.Substring(index + srch.Length).TrimEnd('/').Split('-')[0];
if (!string.IsNullOrWhiteSpace(tmdbId) && int.TryParse(tmdbId, NumberStyles.Integer, CultureInfo.InvariantCulture, out var value)) if (!string.IsNullOrWhiteSpace(tmdbId) && int.TryParse(tmdbId, NumberStyles.Integer, CultureInfo.InvariantCulture, out var value))
{ {
item.SetProviderId(MetadataProviders.Tmdb, value.ToString(_usCulture)); item.SetProviderId(MetadataProviders.Tmdb, value.ToString(UsCulture));
} }
} }
@ -234,7 +237,7 @@ namespace MediaBrowser.XbmcMetadata.Parsers
var tvdbId = xml.Substring(index + srch.Length).TrimEnd('/'); var tvdbId = xml.Substring(index + srch.Length).TrimEnd('/');
if (!string.IsNullOrWhiteSpace(tvdbId) && int.TryParse(tvdbId, NumberStyles.Integer, CultureInfo.InvariantCulture, out var value)) if (!string.IsNullOrWhiteSpace(tvdbId) && int.TryParse(tvdbId, NumberStyles.Integer, CultureInfo.InvariantCulture, out var value))
{ {
item.SetProviderId(MetadataProviders.Tvdb, value.ToString(_usCulture)); item.SetProviderId(MetadataProviders.Tvdb, value.ToString(UsCulture));
} }
} }
} }
@ -291,7 +294,7 @@ namespace MediaBrowser.XbmcMetadata.Parsers
if (!string.IsNullOrEmpty(text)) if (!string.IsNullOrEmpty(text))
{ {
if (float.TryParse(text, NumberStyles.Any, _usCulture, out var value)) if (float.TryParse(text, NumberStyles.Any, UsCulture, out var value))
{ {
item.CriticRating = value; item.CriticRating = value;
} }
@ -417,7 +420,7 @@ namespace MediaBrowser.XbmcMetadata.Parsers
if (!string.IsNullOrWhiteSpace(text)) if (!string.IsNullOrWhiteSpace(text))
{ {
if (int.TryParse(text.Split(' ')[0], NumberStyles.Integer, _usCulture, out var runtime)) if (int.TryParse(text.Split(' ')[0], NumberStyles.Integer, UsCulture, out var runtime))
{ {
item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks; item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks;
} }
@ -870,7 +873,7 @@ namespace MediaBrowser.XbmcMetadata.Parsers
if (!string.IsNullOrWhiteSpace(val)) if (!string.IsNullOrWhiteSpace(val))
{ {
if (int.TryParse(val, NumberStyles.Integer, _usCulture, out var intVal)) if (int.TryParse(val, NumberStyles.Integer, UsCulture, out var intVal))
{ {
sortOrder = intVal; sortOrder = intVal;
} }

22
MediaBrowser.XbmcMetadata/Parsers/EpisodeNfoParser.cs
View File

@ -1,5 +1,4 @@
using System; using System;
using System.Collections.Generic;
using System.Globalization; using System.Globalization;
using System.IO; using System.IO;
using System.Text; using System.Text;
@ -14,16 +13,12 @@ namespace MediaBrowser.XbmcMetadata.Parsers
{ {
public class EpisodeNfoParser : BaseNfoParser<Episode> public class EpisodeNfoParser : BaseNfoParser<Episode>
{ {
public void Fetch(MetadataResult<Episode> item, public EpisodeNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
List<LocalImageInfo> images, : base(logger, config, providerManager)
string metadataFile,
CancellationToken cancellationToken)
{ {
Fetch(item, metadataFile, cancellationToken);
} }
private readonly CultureInfo UsCulture = new CultureInfo("en-US"); /// <inheritdoc />
protected override void Fetch(MetadataResult<Episode> item, string metadataFile, XmlReaderSettings settings, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<Episode> item, string metadataFile, XmlReaderSettings settings, CancellationToken cancellationToken)
{ {
using (var fileStream = File.OpenRead(metadataFile)) using (var fileStream = File.OpenRead(metadataFile))
@ -73,11 +68,7 @@ namespace MediaBrowser.XbmcMetadata.Parsers
} }
} }
/// <summary> /// <inheritdoc />
/// Fetches the data from XML node.
/// </summary>
/// <param name="reader">The reader.</param>
/// <param name="itemResult">The item result.</param>
protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Episode> itemResult) protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Episode> itemResult)
{ {
var item = itemResult.Item; var item = itemResult.Item;
@ -212,10 +203,5 @@ namespace MediaBrowser.XbmcMetadata.Parsers
break; break;
} }
} }
public EpisodeNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
: base(logger, config, providerManager)
{
}
} }
} }

30
MediaBrowser.XbmcMetadata/Parsers/MovieNfoParser.cs
View File

@ -13,13 +13,15 @@ namespace MediaBrowser.XbmcMetadata.Parsers
{ {
public class MovieNfoParser : BaseNfoParser<Video> public class MovieNfoParser : BaseNfoParser<Video>
{ {
public MovieNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
: base(logger, config, providerManager)
{
}
/// <inheritdoc />
protected override bool SupportsUrlAfterClosingXmlTag => true; protected override bool SupportsUrlAfterClosingXmlTag => true;
/// <summary> /// <inheritdoc />
/// Fetches the data from XML node.
/// </summary>
/// <param name="reader">The reader.</param>
/// <param name="itemResult">The item result.</param>
protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Video> itemResult) protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Video> itemResult)
{ {
var item = itemResult.Item; var item = itemResult.Item;
@ -35,14 +37,17 @@ namespace MediaBrowser.XbmcMetadata.Parsers
{ {
imdbId = reader.ReadElementContentAsString(); imdbId = reader.ReadElementContentAsString();
} }
if (!string.IsNullOrWhiteSpace(imdbId)) if (!string.IsNullOrWhiteSpace(imdbId))
{ {
item.SetProviderId(MetadataProviders.Imdb, imdbId); item.SetProviderId(MetadataProviders.Imdb, imdbId);
} }
if (!string.IsNullOrWhiteSpace(tmdbId)) if (!string.IsNullOrWhiteSpace(tmdbId))
{ {
item.SetProviderId(MetadataProviders.Tmdb, tmdbId); item.SetProviderId(MetadataProviders.Tmdb, tmdbId);
} }
break; break;
} }
case "set": case "set":
@ -83,9 +88,8 @@ namespace MediaBrowser.XbmcMetadata.Parsers
case "artist": case "artist":
{ {
var val = reader.ReadElementContentAsString(); var val = reader.ReadElementContentAsString();
var movie = item as MusicVideo;
if (!string.IsNullOrWhiteSpace(val) && movie != null) if (!string.IsNullOrWhiteSpace(val) && item is MusicVideo movie)
{ {
var list = movie.Artists.ToList(); var list = movie.Artists.ToList();
list.Add(val); list.Add(val);
@ -98,9 +102,8 @@ namespace MediaBrowser.XbmcMetadata.Parsers
case "album": case "album":
{ {
var val = reader.ReadElementContentAsString(); var val = reader.ReadElementContentAsString();
var movie = item as MusicVideo;
if (!string.IsNullOrWhiteSpace(val) && movie != null) if (!string.IsNullOrWhiteSpace(val) && item is MusicVideo movie)
{ {
movie.Album = val; movie.Album = val;
} }
@ -119,11 +122,10 @@ namespace MediaBrowser.XbmcMetadata.Parsers
//xml = xml.Substring(xml.IndexOf('<')); //xml = xml.Substring(xml.IndexOf('<'));
//xml = xml.Substring(0, xml.LastIndexOf('>')); //xml = xml.Substring(0, xml.LastIndexOf('>'));
using (var stringReader = new StringReader("<set>" + xml + "</set>"))
{
// These are not going to be valid xml so no sense in causing the provider to fail and spamming the log with exceptions // These are not going to be valid xml so no sense in causing the provider to fail and spamming the log with exceptions
try try
{ {
using (var stringReader = new StringReader("<set>" + xml + "</set>"))
using (var reader = XmlReader.Create(stringReader, GetXmlReaderSettings())) using (var reader = XmlReader.Create(stringReader, GetXmlReaderSettings()))
{ {
reader.MoveToContent(); reader.MoveToContent();
@ -157,10 +159,4 @@ namespace MediaBrowser.XbmcMetadata.Parsers
} }
} }
} }
public MovieNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
: base(logger, config, providerManager)
{
}
}
} }

16
MediaBrowser.XbmcMetadata/Parsers/SeasonNfoParser.cs
View File

@ -9,11 +9,12 @@ namespace MediaBrowser.XbmcMetadata.Parsers
{ {
public class SeasonNfoParser : BaseNfoParser<Season> public class SeasonNfoParser : BaseNfoParser<Season>
{ {
/// <summary> public SeasonNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
/// Fetches the data from XML node. : base(logger, config, providerManager)
/// </summary> {
/// <param name="reader">The reader.</param> }
/// <param name="itemResult">The item result.</param>
/// <inheritdoc />
protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Season> itemResult) protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Season> itemResult)
{ {
var item = itemResult.Item; var item = itemResult.Item;
@ -39,10 +40,5 @@ namespace MediaBrowser.XbmcMetadata.Parsers
break; break;
} }
} }
public SeasonNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
: base(logger, config, providerManager)
{
}
} }
} }

18
MediaBrowser.XbmcMetadata/Parsers/SeriesNfoParser.cs
View File

@ -11,15 +11,18 @@ namespace MediaBrowser.XbmcMetadata.Parsers
{ {
public class SeriesNfoParser : BaseNfoParser<Series> public class SeriesNfoParser : BaseNfoParser<Series>
{ {
public SeriesNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
: base(logger, config, providerManager)
{
}
/// <inheritdoc />
protected override bool SupportsUrlAfterClosingXmlTag => true; protected override bool SupportsUrlAfterClosingXmlTag => true;
/// <inheritdoc />
protected override string MovieDbParserSearchString => "themoviedb.org/tv/"; protected override string MovieDbParserSearchString => "themoviedb.org/tv/";
/// <summary> /// <inheritdoc />
/// Fetches the data from XML node.
/// </summary>
/// <param name="reader">The reader.</param>
/// <param name="itemResult">The item result.</param>
protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Series> itemResult) protected override void FetchDataFromXmlNode(XmlReader reader, MetadataResult<Series> itemResult)
{ {
var item = itemResult.Item; var item = itemResult.Item;
@ -91,10 +94,5 @@ namespace MediaBrowser.XbmcMetadata.Parsers
break; break;
} }
} }
public SeriesNfoParser(ILogger logger, IConfigurationManager config, IProviderManager providerManager)
: base(logger, config, providerManager)
{
}
} }
} }

6
MediaBrowser.XbmcMetadata/Providers/AlbumNfoProvider.cs
View File

@ -23,14 +23,14 @@ namespace MediaBrowser.XbmcMetadata.Providers
_providerManager = providerManager; _providerManager = providerManager;
} }
/// <inheritdoc />
protected override void Fetch(MetadataResult<MusicAlbum> result, string path, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<MusicAlbum> result, string path, CancellationToken cancellationToken)
{ {
new BaseNfoParser<MusicAlbum>(_logger, _config, _providerManager).Fetch(result, path, cancellationToken); new BaseNfoParser<MusicAlbum>(_logger, _config, _providerManager).Fetch(result, path, cancellationToken);
} }
/// <inheritdoc />
protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService) protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService)
{ => directoryService.GetFile(Path.Combine(info.Path, "album.nfo"));
return directoryService.GetFile(Path.Combine(info.Path, "album.nfo"));
}
} }
} }

6
MediaBrowser.XbmcMetadata/Providers/ArtistNfoProvider.cs
View File

@ -23,14 +23,14 @@ namespace MediaBrowser.XbmcMetadata.Providers
_providerManager = providerManager; _providerManager = providerManager;
} }
/// <inheritdoc />
protected override void Fetch(MetadataResult<MusicArtist> result, string path, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<MusicArtist> result, string path, CancellationToken cancellationToken)
{ {
new BaseNfoParser<MusicArtist>(_logger, _config, _providerManager).Fetch(result, path, cancellationToken); new BaseNfoParser<MusicArtist>(_logger, _config, _providerManager).Fetch(result, path, cancellationToken);
} }
/// <inheritdoc />
protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService) protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService)
{ => directoryService.GetFile(Path.Combine(info.Path, "artist.nfo"));
return directoryService.GetFile(Path.Combine(info.Path, "artist.nfo"));
}
} }
} }

21
MediaBrowser.XbmcMetadata/Providers/BaseNfoProvider.cs
View File

@ -11,9 +11,16 @@ namespace MediaBrowser.XbmcMetadata.Providers
public abstract class BaseNfoProvider<T> : ILocalMetadataProvider<T>, IHasItemChangeMonitor public abstract class BaseNfoProvider<T> : ILocalMetadataProvider<T>, IHasItemChangeMonitor
where T : BaseItem, new() where T : BaseItem, new()
{ {
protected IFileSystem FileSystem; private IFileSystem _fileSystem;
public Task<MetadataResult<T>> GetMetadata(ItemInfo info, protected BaseNfoProvider(IFileSystem fileSystem)
{
_fileSystem = fileSystem;
}
/// <inheritdoc />
public Task<MetadataResult<T>> GetMetadata(
ItemInfo info,
IDirectoryService directoryService, IDirectoryService directoryService,
CancellationToken cancellationToken) CancellationToken cancellationToken)
{ {
@ -47,15 +54,13 @@ namespace MediaBrowser.XbmcMetadata.Providers
return Task.FromResult(result); return Task.FromResult(result);
} }
/// <inheritdoc />
protected abstract void Fetch(MetadataResult<T> result, string path, CancellationToken cancellationToken); protected abstract void Fetch(MetadataResult<T> result, string path, CancellationToken cancellationToken);
protected BaseNfoProvider(IFileSystem fileSystem) /// <inheritdoc />
{
FileSystem = fileSystem;
}
protected abstract FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService); protected abstract FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService);
/// <inheritdoc />
public bool HasChanged(BaseItem item, IDirectoryService directoryService) public bool HasChanged(BaseItem item, IDirectoryService directoryService)
{ {
var file = GetXmlFile(new ItemInfo(item), directoryService); var file = GetXmlFile(new ItemInfo(item), directoryService);
@ -65,7 +70,7 @@ namespace MediaBrowser.XbmcMetadata.Providers
return false; return false;
} }
return file.Exists && FileSystem.GetLastWriteTimeUtc(file) > item.DateLastSaved; return file.Exists && _fileSystem.GetLastWriteTimeUtc(file) > item.DateLastSaved;
} }
public string Name => BaseNfoSaver.SaverName; public string Name => BaseNfoSaver.SaverName;

4
MediaBrowser.XbmcMetadata/Providers/BaseVideoNfoProvider.cs
View File

@ -25,6 +25,7 @@ namespace MediaBrowser.XbmcMetadata.Providers
_providerManager = providerManager; _providerManager = providerManager;
} }
/// <inheritdoc />
protected override void Fetch(MetadataResult<T> result, string path, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<T> result, string path, CancellationToken cancellationToken)
{ {
var tmpItem = new MetadataResult<Video> var tmpItem = new MetadataResult<Video>
@ -42,9 +43,10 @@ namespace MediaBrowser.XbmcMetadata.Providers
} }
} }
/// <inheritdoc />
protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService) protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService)
{ {
return MovieNfoSaver.GetMovieSavePaths(info, FileSystem) return MovieNfoSaver.GetMovieSavePaths(info)
.Select(directoryService.GetFile) .Select(directoryService.GetFile)
.FirstOrDefault(i => i != null); .FirstOrDefault(i => i != null);
} }

9
MediaBrowser.XbmcMetadata/Providers/EpisodeNfoProvider.cs
View File

@ -1,4 +1,3 @@
using System.Collections.Generic;
using System.IO; using System.IO;
using System.Threading; using System.Threading;
using MediaBrowser.Common.Configuration; using MediaBrowser.Common.Configuration;
@ -24,15 +23,13 @@ namespace MediaBrowser.XbmcMetadata.Providers
_providerManager = providerManager; _providerManager = providerManager;
} }
/// <inheritdoc />
protected override void Fetch(MetadataResult<Episode> result, string path, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<Episode> result, string path, CancellationToken cancellationToken)
{ {
var images = new List<LocalImageInfo>(); new EpisodeNfoParser(_logger, _config, _providerManager).Fetch(result, path, cancellationToken);
new EpisodeNfoParser(_logger, _config, _providerManager).Fetch(result, images, path, cancellationToken);
result.Images = images;
} }
/// <inheritdoc />
protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService) protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService)
{ {
var path = Path.ChangeExtension(info.Path, ".nfo"); var path = Path.ChangeExtension(info.Path, ".nfo");

2
MediaBrowser.XbmcMetadata/Providers/SeasonNfoProvider.cs
View File

@ -23,11 +23,13 @@ namespace MediaBrowser.XbmcMetadata.Providers
_providerManager = providerManager; _providerManager = providerManager;
} }
/// <inheritdoc />
protected override void Fetch(MetadataResult<Season> result, string path, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<Season> result, string path, CancellationToken cancellationToken)
{ {
new SeasonNfoParser(_logger, _config, _providerManager).Fetch(result, path, cancellationToken); new SeasonNfoParser(_logger, _config, _providerManager).Fetch(result, path, cancellationToken);
} }
/// <inheritdoc />
protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService) protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService)
=> directoryService.GetFile(Path.Combine(info.Path, "season.nfo")); => directoryService.GetFile(Path.Combine(info.Path, "season.nfo"));
} }

2
MediaBrowser.XbmcMetadata/Providers/SeriesNfoProvider.cs
View File

@ -23,11 +23,13 @@ namespace MediaBrowser.XbmcMetadata.Providers
_providerManager = providerManager; _providerManager = providerManager;
} }
/// <inheritdoc />
protected override void Fetch(MetadataResult<Series> result, string path, CancellationToken cancellationToken) protected override void Fetch(MetadataResult<Series> result, string path, CancellationToken cancellationToken)
{ {
new SeriesNfoParser(_logger, _config, _providerManager).Fetch(result, path, cancellationToken); new SeriesNfoParser(_logger, _config, _providerManager).Fetch(result, path, cancellationToken);
} }
/// <inheritdoc />
protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService) protected override FileSystemMetadata GetXmlFile(ItemInfo info, IDirectoryService directoryService)
=> directoryService.GetFile(Path.Combine(info.Path, "tvshow.nfo")); => directoryService.GetFile(Path.Combine(info.Path, "tvshow.nfo"));
} }

17
MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs
View File

@ -28,26 +28,15 @@ namespace MediaBrowser.XbmcMetadata.Savers
/// <inheritdoc /> /// <inheritdoc />
protected override string GetLocalSavePath(BaseItem item) protected override string GetLocalSavePath(BaseItem item)
{ => Path.Combine(item.Path, "album.nfo");
return Path.Combine(item.Path, "album.nfo");
}
/// <inheritdoc /> /// <inheritdoc />
protected override string GetRootElementName(BaseItem item) protected override string GetRootElementName(BaseItem item)
{ => "album";
return "album";
}
/// <inheritdoc /> /// <inheritdoc />
public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType)
{ => !item.SupportsLocalMetadata && item is MusicAlbum && updateType >= MinimumUpdateType;
if (!item.SupportsLocalMetadata)
{
return false;
}
return item is MusicAlbum && updateType >= MinimumUpdateType;
}
/// <inheritdoc /> /// <inheritdoc />
protected override void WriteCustomElements(BaseItem item, XmlWriter writer) protected override void WriteCustomElements(BaseItem item, XmlWriter writer)

37
MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs
View File

@ -14,26 +14,24 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
public class ArtistNfoSaver : BaseNfoSaver public class ArtistNfoSaver : BaseNfoSaver
{ {
public ArtistNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger)
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
}
/// <inheritdoc />
protected override string GetLocalSavePath(BaseItem item) protected override string GetLocalSavePath(BaseItem item)
{ => Path.Combine(item.Path, "artist.nfo");
return Path.Combine(item.Path, "artist.nfo");
}
/// <inheritdoc />
protected override string GetRootElementName(BaseItem item) protected override string GetRootElementName(BaseItem item)
{ => "artist";
return "artist";
}
/// <inheritdoc />
public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType)
{ => !item.SupportsLocalMetadata && item is MusicArtist && updateType >= MinimumUpdateType;
if (!item.SupportsLocalMetadata)
{
return false;
}
return item is MusicArtist && updateType >= MinimumUpdateType;
}
/// <inheritdoc />
protected override void WriteCustomElements(BaseItem item, XmlWriter writer) protected override void WriteCustomElements(BaseItem item, XmlWriter writer)
{ {
var artist = (MusicArtist)item; var artist = (MusicArtist)item;
@ -51,8 +49,6 @@ namespace MediaBrowser.XbmcMetadata.Savers
AddAlbums(albums, writer); AddAlbums(albums, writer);
} }
private readonly CultureInfo UsCulture = new CultureInfo("en-US");
private void AddAlbums(IList<BaseItem> albums, XmlWriter writer) private void AddAlbums(IList<BaseItem> albums, XmlWriter writer)
{ {
foreach (var album in albums) foreach (var album in albums)
@ -66,13 +62,14 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (album.ProductionYear.HasValue) if (album.ProductionYear.HasValue)
{ {
writer.WriteElementString("year", album.ProductionYear.Value.ToString(UsCulture)); writer.WriteElementString("year", album.ProductionYear.Value.ToString(CultureInfo.InvariantCulture));
} }
writer.WriteEndElement(); writer.WriteEndElement();
} }
} }
/// <inheritdoc />
protected override List<string> GetTagsUsed(BaseItem item) protected override List<string> GetTagsUsed(BaseItem item)
{ {
var list = base.GetTagsUsed(item); var list = base.GetTagsUsed(item);
@ -81,12 +78,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
"album", "album",
"disbanded" "disbanded"
}); });
return list;
}
public ArtistNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) return list;
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
} }
} }
} }

121
MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs
View File

@ -25,12 +25,14 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
public abstract class BaseNfoSaver : IMetadataFileSaver public abstract class BaseNfoSaver : IMetadataFileSaver
{ {
public static readonly string YouTubeWatchUrl = "https://www.youtube.com/watch?v="; public const string DateAddedFormat = "yyyy-MM-dd HH:mm:ss";
private static readonly CultureInfo UsCulture = new CultureInfo("en-US"); public const string YouTubeWatchUrl = "https://www.youtube.com/watch?v=";
private static readonly Dictionary<string, string> CommonTags = new[] { private static readonly CultureInfo _usCulture = CultureInfo.ReadOnly(new CultureInfo("en-US"));
private static readonly HashSet<string> _commonTags = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
"plot", "plot",
"customrating", "customrating",
"lockdata", "lockdata",
@ -93,8 +95,11 @@ namespace MediaBrowser.XbmcMetadata.Savers
"userrating", "userrating",
"countrycode" "countrycode"
};
// filters control characters but allows only properly-formed surrogate sequences
private const string _invalidXMLCharsRegex = @"(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\uFEFF\uFFFE\uFFFF]";
}.ToDictionary(i => i, StringComparer.OrdinalIgnoreCase);
protected BaseNfoSaver( protected BaseNfoSaver(
IFileSystem fileSystem, IFileSystem fileSystem,
@ -112,12 +117,17 @@ namespace MediaBrowser.XbmcMetadata.Savers
FileSystem = fileSystem; FileSystem = fileSystem;
} }
protected IFileSystem FileSystem { get; private set; } protected IFileSystem FileSystem { get; }
protected IServerConfigurationManager ConfigurationManager { get; private set; }
protected ILibraryManager LibraryManager { get; private set; } protected IServerConfigurationManager ConfigurationManager { get; }
protected IUserManager UserManager { get; private set; }
protected IUserDataManager UserDataManager { get; private set; } protected ILibraryManager LibraryManager { get; }
protected ILogger Logger { get; private set; }
protected IUserManager UserManager { get; }
protected IUserDataManager UserDataManager { get; }
protected ILogger Logger { get; }
protected ItemUpdateType MinimumUpdateType protected ItemUpdateType MinimumUpdateType
{ {
@ -136,23 +146,22 @@ namespace MediaBrowser.XbmcMetadata.Savers
public static string SaverName => "Nfo"; public static string SaverName => "Nfo";
/// <inheritdoc />
public string GetSavePath(BaseItem item) public string GetSavePath(BaseItem item)
{ => GetLocalSavePath(item);
return GetLocalSavePath(item);
}
/// <summary> /// <summary>
/// Gets the save path. /// Gets the save path.
/// </summary> /// </summary>
/// <param name="item">The item.</param> /// <param name="item">The item.</param>
/// <returns>System.String.</returns> /// <returns><see cref="string" />.</returns>
protected abstract string GetLocalSavePath(BaseItem item); protected abstract string GetLocalSavePath(BaseItem item);
/// <summary> /// <summary>
/// Gets the name of the root element. /// Gets the name of the root element.
/// </summary> /// </summary>
/// <param name="item">The item.</param> /// <param name="item">The item.</param>
/// <returns>System.String.</returns> /// <returns><see cref="string" />.</returns>
protected abstract string GetRootElementName(BaseItem item); protected abstract string GetRootElementName(BaseItem item);
/// <summary> /// <summary>
@ -169,11 +178,12 @@ namespace MediaBrowser.XbmcMetadata.Savers
foreach (var providerKey in item.ProviderIds.Keys) foreach (var providerKey in item.ProviderIds.Keys)
{ {
var providerIdTagName = GetTagForProviderKey(providerKey); var providerIdTagName = GetTagForProviderKey(providerKey);
if (!CommonTags.ContainsKey(providerIdTagName)) if (!_commonTags.Contains(providerIdTagName))
{ {
list.Add(providerIdTagName); list.Add(providerIdTagName);
} }
} }
return list; return list;
} }
@ -199,7 +209,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
// On Windows, savint the file will fail if the file is hidden or readonly // On Windows, savint the file will fail if the file is hidden or readonly
FileSystem.SetAttributes(path, false, false); FileSystem.SetAttributes(path, false, false);
using (var filestream = FileSystem.GetFileStream(path, FileOpenMode.Create, FileAccessMode.Write, FileShareMode.Read)) using (var filestream = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.Read))
{ {
stream.CopyTo(filestream); stream.CopyTo(filestream);
} }
@ -248,9 +258,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
WriteCustomElements(item, writer); WriteCustomElements(item, writer);
var hasMediaSources = baseItem as IHasMediaSources; if (baseItem is IHasMediaSources hasMediaSources)
if (hasMediaSources != null)
{ {
AddMediaInfo(hasMediaSources, writer); AddMediaInfo(hasMediaSources, writer);
} }
@ -313,17 +321,17 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (stream.BitRate.HasValue) if (stream.BitRate.HasValue)
{ {
writer.WriteElementString("bitrate", stream.BitRate.Value.ToString(UsCulture)); writer.WriteElementString("bitrate", stream.BitRate.Value.ToString(_usCulture));
} }
if (stream.Width.HasValue) if (stream.Width.HasValue)
{ {
writer.WriteElementString("width", stream.Width.Value.ToString(UsCulture)); writer.WriteElementString("width", stream.Width.Value.ToString(_usCulture));
} }
if (stream.Height.HasValue) if (stream.Height.HasValue)
{ {
writer.WriteElementString("height", stream.Height.Value.ToString(UsCulture)); writer.WriteElementString("height", stream.Height.Value.ToString(_usCulture));
} }
if (!string.IsNullOrEmpty(stream.AspectRatio)) if (!string.IsNullOrEmpty(stream.AspectRatio))
@ -336,14 +344,14 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (framerate.HasValue) if (framerate.HasValue)
{ {
writer.WriteElementString("framerate", framerate.Value.ToString(UsCulture)); writer.WriteElementString("framerate", framerate.Value.ToString(_usCulture));
} }
if (!string.IsNullOrEmpty(stream.Language)) if (!string.IsNullOrEmpty(stream.Language))
{ {
// http://web.archive.org/web/20181230211547/https://emby.media/community/index.php?/topic/49071-nfo-not-generated-on-actualize-or-rescan-or-identify // http://web.archive.org/web/20181230211547/https://emby.media/community/index.php?/topic/49071-nfo-not-generated-on-actualize-or-rescan-or-identify
// Web Archive version of link since it's not really explained in the thread. // Web Archive version of link since it's not really explained in the thread.
writer.WriteElementString("language", RemoveInvalidXMLChars(stream.Language)); writer.WriteElementString("language", Regex.Replace(stream.Language, _invalidXMLCharsRegex, string.Empty));
} }
var scanType = stream.IsInterlaced ? "interlaced" : "progressive"; var scanType = stream.IsInterlaced ? "interlaced" : "progressive";
@ -354,12 +362,12 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (stream.Channels.HasValue) if (stream.Channels.HasValue)
{ {
writer.WriteElementString("channels", stream.Channels.Value.ToString(UsCulture)); writer.WriteElementString("channels", stream.Channels.Value.ToString(_usCulture));
} }
if (stream.SampleRate.HasValue) if (stream.SampleRate.HasValue)
{ {
writer.WriteElementString("samplingrate", stream.SampleRate.Value.ToString(UsCulture)); writer.WriteElementString("samplingrate", stream.SampleRate.Value.ToString(_usCulture));
} }
writer.WriteElementString("default", stream.IsDefault.ToString()); writer.WriteElementString("default", stream.IsDefault.ToString());
@ -372,13 +380,11 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
var timespan = TimeSpan.FromTicks(runtimeTicks.Value); var timespan = TimeSpan.FromTicks(runtimeTicks.Value);
writer.WriteElementString("duration", Math.Floor(timespan.TotalMinutes).ToString(UsCulture)); writer.WriteElementString("duration", Math.Floor(timespan.TotalMinutes).ToString(_usCulture));
writer.WriteElementString("durationinseconds", Math.Floor(timespan.TotalSeconds).ToString(UsCulture)); writer.WriteElementString("durationinseconds", Math.Floor(timespan.TotalSeconds).ToString(_usCulture));
} }
var video = item as Video; if (item is Video video)
if (video != null)
{ {
//AddChapters(video, builder, itemRepository); //AddChapters(video, builder, itemRepository);
@ -413,21 +419,6 @@ namespace MediaBrowser.XbmcMetadata.Savers
writer.WriteEndElement(); writer.WriteEndElement();
} }
// filters control characters but allows only properly-formed surrogate sequences
private static Regex _invalidXMLChars = new Regex(
@"(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\uFEFF\uFFFE\uFFFF]");
/// <summary>
/// removes any unusual unicode characters that can't be encoded into XML
/// </summary>
public static string RemoveInvalidXMLChars(string text)
{
if (string.IsNullOrEmpty(text)) return string.Empty;
return _invalidXMLChars.Replace(text, string.Empty);
}
public const string DateAddedFormat = "yyyy-MM-dd HH:mm:ss";
/// <summary> /// <summary>
/// Adds the common nodes. /// Adds the common nodes.
/// </summary> /// </summary>
@ -524,12 +515,12 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (item.CommunityRating.HasValue) if (item.CommunityRating.HasValue)
{ {
writer.WriteElementString("rating", item.CommunityRating.Value.ToString(UsCulture)); writer.WriteElementString("rating", item.CommunityRating.Value.ToString(_usCulture));
} }
if (item.ProductionYear.HasValue) if (item.ProductionYear.HasValue)
{ {
writer.WriteElementString("year", item.ProductionYear.Value.ToString(UsCulture)); writer.WriteElementString("year", item.ProductionYear.Value.ToString(_usCulture));
} }
var forcedSortName = item.ForcedSortName; var forcedSortName = item.ForcedSortName;
@ -628,12 +619,10 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (item.CriticRating.HasValue) if (item.CriticRating.HasValue)
{ {
writer.WriteElementString("criticrating", item.CriticRating.Value.ToString(UsCulture)); writer.WriteElementString("criticrating", item.CriticRating.Value.ToString(_usCulture));
} }
var hasDisplayOrder = item as IHasDisplayOrder; if (item is IHasDisplayOrder hasDisplayOrder)
if (hasDisplayOrder != null)
{ {
if (!string.IsNullOrEmpty(hasDisplayOrder.DisplayOrder)) if (!string.IsNullOrEmpty(hasDisplayOrder.DisplayOrder))
{ {
@ -648,7 +637,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
var timespan = TimeSpan.FromTicks(runTimeTicks.Value); var timespan = TimeSpan.FromTicks(runTimeTicks.Value);
writer.WriteElementString("runtime", Convert.ToInt64(timespan.TotalMinutes).ToString(UsCulture)); writer.WriteElementString("runtime", Convert.ToInt64(timespan.TotalMinutes).ToString(_usCulture));
} }
if (!string.IsNullOrWhiteSpace(item.Tagline)) if (!string.IsNullOrWhiteSpace(item.Tagline))
@ -783,8 +772,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
AddActors(people, writer, libraryManager, fileSystem, config, options.SaveImagePathsInNfo); AddActors(people, writer, libraryManager, fileSystem, config, options.SaveImagePathsInNfo);
var folder = item as BoxSet; if (item is BoxSet folder)
if (folder != null)
{ {
AddCollectionItems(folder, writer); AddCollectionItems(folder, writer);
} }
@ -875,7 +863,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (!item.IsFolder) if (!item.IsFolder)
{ {
writer.WriteElementString("playcount", userdata.PlayCount.ToString(UsCulture)); writer.WriteElementString("playcount", userdata.PlayCount.ToString(_usCulture));
writer.WriteElementString("watched", userdata.Played.ToString(CultureInfo.InvariantCulture).ToLowerInvariant()); writer.WriteElementString("watched", userdata.Played.ToString(CultureInfo.InvariantCulture).ToLowerInvariant());
if (userdata.LastPlayedDate.HasValue) if (userdata.LastPlayedDate.HasValue)
@ -887,8 +875,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
var runTimeTicks = item.RunTimeTicks ?? 0; var runTimeTicks = item.RunTimeTicks ?? 0;
writer.WriteElementString("position", TimeSpan.FromTicks(userdata.PlaybackPositionTicks).TotalSeconds.ToString(UsCulture)); writer.WriteElementString("position", TimeSpan.FromTicks(userdata.PlaybackPositionTicks).TotalSeconds.ToString(_usCulture));
writer.WriteElementString("total", TimeSpan.FromTicks(runTimeTicks).TotalSeconds.ToString(UsCulture)); writer.WriteElementString("total", TimeSpan.FromTicks(runTimeTicks).TotalSeconds.ToString(_usCulture));
} }
writer.WriteEndElement(); writer.WriteEndElement();
@ -922,12 +910,10 @@ namespace MediaBrowser.XbmcMetadata.Savers
if (person.SortOrder.HasValue) if (person.SortOrder.HasValue)
{ {
writer.WriteElementString("sortorder", person.SortOrder.Value.ToString(UsCulture)); writer.WriteElementString("sortorder", person.SortOrder.Value.ToString(_usCulture));
} }
if (saveImagePath) if (saveImagePath)
{
try
{ {
var personEntity = libraryManager.GetPerson(person.Name); var personEntity = libraryManager.GetPerson(person.Name);
var image = personEntity.GetImageInfo(ImageType.Primary, 0); var image = personEntity.GetImageInfo(ImageType.Primary, 0);
@ -937,11 +923,6 @@ namespace MediaBrowser.XbmcMetadata.Savers
writer.WriteElementString("thumb", GetImagePathToSave(image, libraryManager, config)); writer.WriteElementString("thumb", GetImagePathToSave(image, libraryManager, config));
} }
} }
catch (Exception)
{
// Already logged in core
}
}
writer.WriteEndElement(); writer.WriteEndElement();
} }
@ -995,7 +976,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
var name = reader.Name; var name = reader.Name;
if (!CommonTags.ContainsKey(name) && !xmlTagsUsed.Contains(name, StringComparer.OrdinalIgnoreCase)) if (!_commonTags.Contains(name) && !xmlTagsUsed.Contains(name, StringComparer.OrdinalIgnoreCase))
{ {
writer.WriteNode(reader, false); writer.WriteNode(reader, false);
} }
@ -1013,8 +994,6 @@ namespace MediaBrowser.XbmcMetadata.Savers
} }
private string GetTagForProviderKey(string providerKey) private string GetTagForProviderKey(string providerKey)
{ => providerKey.ToLowerInvariant() + "id";
return providerKey.ToLowerInvariant() + "id";
}
} }
} }

67
MediaBrowser.XbmcMetadata/Savers/EpisodeNfoSaver.cs
View File

@ -14,43 +14,43 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
public class EpisodeNfoSaver : BaseNfoSaver public class EpisodeNfoSaver : BaseNfoSaver
{ {
public EpisodeNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger)
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
}
private readonly CultureInfo _usCulture = new CultureInfo("en-US");
/// <inheritdoc />
protected override string GetLocalSavePath(BaseItem item) protected override string GetLocalSavePath(BaseItem item)
{ => Path.ChangeExtension(item.Path, ".nfo");
return Path.ChangeExtension(item.Path, ".nfo");
}
/// <inheritdoc />
protected override string GetRootElementName(BaseItem item) protected override string GetRootElementName(BaseItem item)
{ => "episodedetails";
return "episodedetails";
}
/// <inheritdoc />
public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType)
{ => !item.SupportsLocalMetadata && item is Episode && updateType >= MinimumUpdateType;
if (!item.SupportsLocalMetadata)
{
return false;
}
return item is Episode && updateType >= MinimumUpdateType;
}
/// <inheritdoc />
protected override void WriteCustomElements(BaseItem item, XmlWriter writer) protected override void WriteCustomElements(BaseItem item, XmlWriter writer)
{ {
var episode = (Episode)item; var episode = (Episode)item;
if (episode.IndexNumber.HasValue) if (episode.IndexNumber.HasValue)
{ {
writer.WriteElementString("episode", episode.IndexNumber.Value.ToString(UsCulture)); writer.WriteElementString("episode", episode.IndexNumber.Value.ToString(_usCulture));
} }
if (episode.IndexNumberEnd.HasValue) if (episode.IndexNumberEnd.HasValue)
{ {
writer.WriteElementString("episodenumberend", episode.IndexNumberEnd.Value.ToString(UsCulture)); writer.WriteElementString("episodenumberend", episode.IndexNumberEnd.Value.ToString(_usCulture));
} }
if (episode.ParentIndexNumber.HasValue) if (episode.ParentIndexNumber.HasValue)
{ {
writer.WriteElementString("season", episode.ParentIndexNumber.Value.ToString(UsCulture)); writer.WriteElementString("season", episode.ParentIndexNumber.Value.ToString(_usCulture));
} }
if (episode.PremiereDate.HasValue) if (episode.PremiereDate.HasValue)
@ -64,32 +64,33 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
if (episode.AirsAfterSeasonNumber.HasValue && episode.AirsAfterSeasonNumber.Value != -1) if (episode.AirsAfterSeasonNumber.HasValue && episode.AirsAfterSeasonNumber.Value != -1)
{ {
writer.WriteElementString("airsafter_season", episode.AirsAfterSeasonNumber.Value.ToString(UsCulture)); writer.WriteElementString("airsafter_season", episode.AirsAfterSeasonNumber.Value.ToString(_usCulture));
}
if (episode.AirsBeforeEpisodeNumber.HasValue && episode.AirsBeforeEpisodeNumber.Value != -1)
{
writer.WriteElementString("airsbefore_episode", episode.AirsBeforeEpisodeNumber.Value.ToString(UsCulture));
}
if (episode.AirsBeforeSeasonNumber.HasValue && episode.AirsBeforeSeasonNumber.Value != -1)
{
writer.WriteElementString("airsbefore_season", episode.AirsBeforeSeasonNumber.Value.ToString(UsCulture));
} }
if (episode.AirsBeforeEpisodeNumber.HasValue && episode.AirsBeforeEpisodeNumber.Value != -1) if (episode.AirsBeforeEpisodeNumber.HasValue && episode.AirsBeforeEpisodeNumber.Value != -1)
{ {
writer.WriteElementString("displayepisode", episode.AirsBeforeEpisodeNumber.Value.ToString(UsCulture)); writer.WriteElementString("airsbefore_episode", episode.AirsBeforeEpisodeNumber.Value.ToString(_usCulture));
}
if (episode.AirsBeforeSeasonNumber.HasValue && episode.AirsBeforeSeasonNumber.Value != -1)
{
writer.WriteElementString("airsbefore_season", episode.AirsBeforeSeasonNumber.Value.ToString(_usCulture));
}
if (episode.AirsBeforeEpisodeNumber.HasValue && episode.AirsBeforeEpisodeNumber.Value != -1)
{
writer.WriteElementString("displayepisode", episode.AirsBeforeEpisodeNumber.Value.ToString(_usCulture));
} }
var specialSeason = episode.AiredSeasonNumber; var specialSeason = episode.AiredSeasonNumber;
if (specialSeason.HasValue && specialSeason.Value != -1) if (specialSeason.HasValue && specialSeason.Value != -1)
{ {
writer.WriteElementString("displayseason", specialSeason.Value.ToString(UsCulture)); writer.WriteElementString("displayseason", specialSeason.Value.ToString(_usCulture));
} }
} }
} }
private readonly CultureInfo UsCulture = new CultureInfo("en-US"); /// <inheritdoc />
protected override List<string> GetTagsUsed(BaseItem item) protected override List<string> GetTagsUsed(BaseItem item)
{ {
var list = base.GetTagsUsed(item); var list = base.GetTagsUsed(item);
@ -105,12 +106,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
"displayseason", "displayseason",
"displayepisode" "displayepisode"
}); });
return list;
}
public EpisodeNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) return list;
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
} }
} }
} }

52
MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs
View File

@ -1,5 +1,6 @@
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using System.Linq;
using System.Xml; using System.Xml;
using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities;
@ -15,28 +16,29 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
public class MovieNfoSaver : BaseNfoSaver public class MovieNfoSaver : BaseNfoSaver
{ {
protected override string GetLocalSavePath(BaseItem item) public MovieNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger)
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{ {
var paths = GetMovieSavePaths(new ItemInfo(item), FileSystem);
return paths.Count == 0 ? null : paths[0];
} }
public static List<string> GetMovieSavePaths(ItemInfo item, IFileSystem fileSystem) /// <inheritdoc />
{ protected override string GetLocalSavePath(BaseItem item)
var list = new List<string>(); => GetMovieSavePaths(new ItemInfo(item)).FirstOrDefault();
public static IEnumerable<string> GetMovieSavePaths(ItemInfo item)
{
if (item.VideoType == VideoType.Dvd && !item.IsPlaceHolder) if (item.VideoType == VideoType.Dvd && !item.IsPlaceHolder)
{ {
var path = item.ContainingFolderPath; var path = item.ContainingFolderPath;
list.Add(Path.Combine(path, "VIDEO_TS", "VIDEO_TS.nfo")); yield return Path.Combine(path, "VIDEO_TS", "VIDEO_TS.nfo");
} }
if (!item.IsPlaceHolder && (item.VideoType == VideoType.Dvd || item.VideoType == VideoType.BluRay)) if (!item.IsPlaceHolder && (item.VideoType == VideoType.Dvd || item.VideoType == VideoType.BluRay))
{ {
var path = item.ContainingFolderPath; var path = item.ContainingFolderPath;
list.Add(Path.Combine(path, Path.GetFileName(path) + ".nfo")); yield return Path.Combine(path, Path.GetFileName(path) + ".nfo");
} }
else else
{ {
@ -47,22 +49,20 @@ namespace MediaBrowser.XbmcMetadata.Savers
// list.Add(Path.Combine(item.ContainingFolderPath, "movie.nfo")); // list.Add(Path.Combine(item.ContainingFolderPath, "movie.nfo"));
//} //}
list.Add(Path.ChangeExtension(item.Path, ".nfo")); yield return Path.ChangeExtension(item.Path, ".nfo");
if (!item.IsInMixedFolder) if (!item.IsInMixedFolder)
{ {
list.Add(Path.Combine(item.ContainingFolderPath, "movie.nfo")); yield return Path.Combine(item.ContainingFolderPath, "movie.nfo");
}
} }
} }
return list; /// <inheritdoc />
}
protected override string GetRootElementName(BaseItem item) protected override string GetRootElementName(BaseItem item)
{ => item is MusicVideo ? "musicvideo" : "movie";
return item is MusicVideo ? "musicvideo" : "movie";
}
/// <inheritdoc />
public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType)
{ {
if (!item.SupportsLocalMetadata) if (!item.SupportsLocalMetadata)
@ -70,10 +70,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
return false; return false;
} }
var video = item as Video;
// Check parent for null to avoid running this against things like video backdrops // Check parent for null to avoid running this against things like video backdrops
if (video != null && !(item is Episode) && !video.ExtraType.HasValue) if (item is Video video && !(item is Episode) && !video.ExtraType.HasValue)
{ {
return updateType >= MinimumUpdateType; return updateType >= MinimumUpdateType;
} }
@ -81,6 +79,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
return false; return false;
} }
/// <inheritdoc />
protected override void WriteCustomElements(BaseItem item, XmlWriter writer) protected override void WriteCustomElements(BaseItem item, XmlWriter writer)
{ {
var imdb = item.GetProviderId(MetadataProviders.Imdb); var imdb = item.GetProviderId(MetadataProviders.Imdb);
@ -90,9 +89,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
writer.WriteElementString("id", imdb); writer.WriteElementString("id", imdb);
} }
var musicVideo = item as MusicVideo; if (item is MusicVideo musicVideo)
if (musicVideo != null)
{ {
foreach (var artist in musicVideo.Artists) foreach (var artist in musicVideo.Artists)
{ {
@ -104,9 +101,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
} }
} }
var movie = item as Movie; if (item is Movie movie)
if (movie != null)
{ {
if (!string.IsNullOrEmpty(movie.CollectionName)) if (!string.IsNullOrEmpty(movie.CollectionName))
{ {
@ -115,6 +110,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
} }
} }
/// <inheritdoc />
protected override List<string> GetTagsUsed(BaseItem item) protected override List<string> GetTagsUsed(BaseItem item)
{ {
var list = base.GetTagsUsed(item); var list = base.GetTagsUsed(item);
@ -125,12 +121,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
"set", "set",
"id" "id"
}); });
return list;
}
public MovieNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) return list;
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
} }
} }
} }

35
MediaBrowser.XbmcMetadata/Savers/SeasonNfoSaver.cs
View File

@ -13,16 +13,26 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
public class SeasonNfoSaver : BaseNfoSaver public class SeasonNfoSaver : BaseNfoSaver
{ {
public SeasonNfoSaver(
IFileSystem fileSystem,
IServerConfigurationManager configurationManager,
ILibraryManager libraryManager,
IUserManager userManager,
IUserDataManager userDataManager,
ILogger logger)
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
}
/// <inheritdoc />
protected override string GetLocalSavePath(BaseItem item) protected override string GetLocalSavePath(BaseItem item)
{ => Path.Combine(item.Path, "season.nfo");
return Path.Combine(item.Path, "season.nfo");
}
/// <inheritdoc />
protected override string GetRootElementName(BaseItem item) protected override string GetRootElementName(BaseItem item)
{ => "season";
return "season";
}
/// <inheritdoc />
public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType)
{ {
if (!item.SupportsLocalMetadata) if (!item.SupportsLocalMetadata)
@ -38,6 +48,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
return updateType >= MinimumUpdateType || (updateType >= ItemUpdateType.MetadataImport && File.Exists(GetSavePath(item))); return updateType >= MinimumUpdateType || (updateType >= ItemUpdateType.MetadataImport && File.Exists(GetSavePath(item)));
} }
/// <inheritdoc />
protected override void WriteCustomElements(BaseItem item, XmlWriter writer) protected override void WriteCustomElements(BaseItem item, XmlWriter writer)
{ {
var season = (Season)item; var season = (Season)item;
@ -48,6 +59,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
} }
} }
/// <inheritdoc />
protected override List<string> GetTagsUsed(BaseItem item) protected override List<string> GetTagsUsed(BaseItem item)
{ {
var list = base.GetTagsUsed(item); var list = base.GetTagsUsed(item);
@ -58,16 +70,5 @@ namespace MediaBrowser.XbmcMetadata.Savers
return list; return list;
} }
public SeasonNfoSaver(
IFileSystem fileSystem,
IServerConfigurationManager configurationManager,
ILibraryManager libraryManager,
IUserManager userManager,
IUserDataManager userDataManager,
ILogger logger)
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
}
} }
} }

47
MediaBrowser.XbmcMetadata/Savers/SeriesNfoSaver.cs
View File

@ -1,4 +1,5 @@
using System.Collections.Generic; using System.Collections.Generic;
using System.Globalization;
using System.IO; using System.IO;
using System.Xml; using System.Xml;
using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Configuration;
@ -13,26 +14,30 @@ namespace MediaBrowser.XbmcMetadata.Savers
{ {
public class SeriesNfoSaver : BaseNfoSaver public class SeriesNfoSaver : BaseNfoSaver
{ {
public SeriesNfoSaver(
IFileSystem fileSystem,
IServerConfigurationManager configurationManager,
ILibraryManager libraryManager,
IUserManager userManager,
IUserDataManager userDataManager,
ILogger logger)
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
}
/// <inheritdoc />
protected override string GetLocalSavePath(BaseItem item) protected override string GetLocalSavePath(BaseItem item)
{ => Path.Combine(item.Path, "tvshow.nfo");
return Path.Combine(item.Path, "tvshow.nfo");
}
/// <inheritdoc />
protected override string GetRootElementName(BaseItem item) protected override string GetRootElementName(BaseItem item)
{ => "tvshow";
return "tvshow";
}
/// <inheritdoc />
public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType)
{ => item.SupportsLocalMetadata && item is Series && updateType >= MinimumUpdateType;
if (!item.SupportsLocalMetadata)
{
return false;
}
return item is Series && updateType >= MinimumUpdateType;
}
/// <inheritdoc />
protected override void WriteCustomElements(BaseItem item, XmlWriter writer) protected override void WriteCustomElements(BaseItem item, XmlWriter writer)
{ {
var series = (Series)item; var series = (Series)item;
@ -52,7 +57,12 @@ namespace MediaBrowser.XbmcMetadata.Savers
writer.WriteStartElement("url"); writer.WriteStartElement("url");
writer.WriteAttributeString("cache", string.Format("{0}.xml", tvdb)); writer.WriteAttributeString("cache", string.Format("{0}.xml", tvdb));
writer.WriteString(string.Format("http://www.thetvdb.com/api/1D62F2F90030C444/series/{0}/all/{1}.zip", tvdb, language)); writer.WriteString(
string.Format(
CultureInfo.InvariantCulture,
"http://www.thetvdb.com/api/1D62F2F90030C444/series/{0}/all/{1}.zip",
tvdb,
language));
writer.WriteEndElement(); writer.WriteEndElement();
writer.WriteEndElement(); writer.WriteEndElement();
@ -67,6 +77,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
} }
} }
/// <inheritdoc />
protected override List<string> GetTagsUsed(BaseItem item) protected override List<string> GetTagsUsed(BaseItem item)
{ {
var list = base.GetTagsUsed(item); var list = base.GetTagsUsed(item);
@ -79,12 +90,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
"status", "status",
"displayorder" "displayorder"
}); });
return list;
}
public SeriesNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) return list;
: base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger)
{
} }
} }
} }