diff options
| author | Bond_009 <bond.009@outlook.com> | 2019-08-18 19:54:07 +0200 |
|---|---|---|
| committer | Bond_009 <bond.009@outlook.com> | 2019-09-08 21:19:41 +0200 |
| commit | 0803a916aa0cffcbec3731036a74a8a81655b9d1 (patch) | |
| tree | 290efca8b9a78f8aad486ec86f08bc1519fff935 /MediaBrowser.XbmcMetadata/Savers | |
| parent | 2638759b425f6c3dd7fb367f4f23e4873a7e20e3 (diff) | |
Fix some documentation warnings for MediaBrowser.XbmcMetadata
Diffstat (limited to 'MediaBrowser.XbmcMetadata/Savers')
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs | 17 | ||||
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs | 35 | ||||
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs | 261 | ||||
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/EpisodeNfoSaver.cs | 53 | ||||
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs | 50 | ||||
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/SeasonNfoSaver.cs | 33 | ||||
| -rw-r--r-- | MediaBrowser.XbmcMetadata/Savers/SeriesNfoSaver.cs | 45 |
7 files changed, 226 insertions, 268 deletions
diff --git a/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs index a1905bf26..3a32112b6 100644 --- a/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs @@ -28,26 +28,15 @@ namespace MediaBrowser.XbmcMetadata.Savers /// <inheritdoc /> protected override string GetLocalSavePath(BaseItem item) - { - return Path.Combine(item.Path, "album.nfo"); - } + => Path.Combine(item.Path, "album.nfo"); /// <inheritdoc /> protected override string GetRootElementName(BaseItem item) - { - return "album"; - } + => "album"; /// <inheritdoc /> public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) - { - if (!item.SupportsLocalMetadata) - { - return false; - } - - return item is MusicAlbum && updateType >= MinimumUpdateType; - } + => !item.SupportsLocalMetadata && item is MusicAlbum && updateType >= MinimumUpdateType; /// <inheritdoc /> protected override void WriteCustomElements(BaseItem item, XmlWriter writer) diff --git a/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs index 0876db5c1..7808edcbc 100644 --- a/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs @@ -14,26 +14,24 @@ namespace MediaBrowser.XbmcMetadata.Savers { public class ArtistNfoSaver : BaseNfoSaver { - protected override string GetLocalSavePath(BaseItem item) + public ArtistNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) + : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) { - return Path.Combine(item.Path, "artist.nfo"); } + /// <inheritdoc /> + protected override string GetLocalSavePath(BaseItem item) + => Path.Combine(item.Path, "artist.nfo"); + + /// <inheritdoc /> protected override string GetRootElementName(BaseItem item) - { - return "artist"; - } + => "artist"; + /// <inheritdoc /> public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) - { - if (!item.SupportsLocalMetadata) - { - return false; - } - - return item is MusicArtist && updateType >= MinimumUpdateType; - } + => !item.SupportsLocalMetadata && item is MusicArtist && updateType >= MinimumUpdateType; + /// <inheritdoc /> protected override void WriteCustomElements(BaseItem item, XmlWriter writer) { var artist = (MusicArtist)item; @@ -51,8 +49,6 @@ namespace MediaBrowser.XbmcMetadata.Savers AddAlbums(albums, writer); } - private readonly CultureInfo UsCulture = new CultureInfo("en-US"); - private void AddAlbums(IList<BaseItem> albums, XmlWriter writer) { foreach (var album in albums) @@ -66,13 +62,14 @@ namespace MediaBrowser.XbmcMetadata.Savers if (album.ProductionYear.HasValue) { - writer.WriteElementString("year", album.ProductionYear.Value.ToString(UsCulture)); + writer.WriteElementString("year", album.ProductionYear.Value.ToString(CultureInfo.InvariantCulture)); } writer.WriteEndElement(); } } + /// <inheritdoc /> protected override List<string> GetTagsUsed(BaseItem item) { var list = base.GetTagsUsed(item); @@ -81,12 +78,8 @@ namespace MediaBrowser.XbmcMetadata.Savers "album", "disbanded" }); - return list; - } - public ArtistNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) - : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) - { + return list; } } } diff --git a/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs index 3ae72c472..ae3c5f7f9 100644 --- a/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs @@ -25,76 +25,81 @@ namespace MediaBrowser.XbmcMetadata.Savers { public abstract class BaseNfoSaver : IMetadataFileSaver { - public static readonly string YouTubeWatchUrl = "https://www.youtube.com/watch?v="; - - private static readonly CultureInfo UsCulture = new CultureInfo("en-US"); - - private static readonly Dictionary<string, string> CommonTags = new[] { - - "plot", - "customrating", - "lockdata", - "dateadded", - "title", - "rating", - "year", - "sorttitle", - "mpaa", - "aspectratio", - "collectionnumber", - "tmdbid", - "rottentomatoesid", - "language", - "tvcomid", - "tagline", - "studio", - "genre", - "tag", - "runtime", - "actor", - "criticrating", - "fileinfo", - "director", - "writer", - "trailer", - "premiered", - "releasedate", - "outline", - "id", - "credits", - "originaltitle", - "watched", - "playcount", - "lastplayed", - "art", - "resume", - "biography", - "formed", - "review", - "style", - "imdbid", - "imdb_id", - "country", - "audiodbalbumid", - "audiodbartistid", - "enddate", - "lockedfields", - "zap2itid", - "tvrageid", - - "musicbrainzartistid", - "musicbrainzalbumartistid", - "musicbrainzalbumid", - "musicbrainzreleasegroupid", - "tvdbid", - "collectionitem", - - "isuserfavorite", - "userrating", - - "countrycode" - - }.ToDictionary(i => i, StringComparer.OrdinalIgnoreCase); + public const string DateAddedFormat = "yyyy-MM-dd HH:mm:ss"; + + public const string YouTubeWatchUrl = "https://www.youtube.com/watch?v="; + + private static readonly CultureInfo _usCulture = CultureInfo.ReadOnly(new CultureInfo("en-US")); + + private static readonly HashSet<string> _commonTags = new HashSet<string>(StringComparer.OrdinalIgnoreCase) + { + "plot", + "customrating", + "lockdata", + "dateadded", + "title", + "rating", + "year", + "sorttitle", + "mpaa", + "aspectratio", + "collectionnumber", + "tmdbid", + "rottentomatoesid", + "language", + "tvcomid", + "tagline", + "studio", + "genre", + "tag", + "runtime", + "actor", + "criticrating", + "fileinfo", + "director", + "writer", + "trailer", + "premiered", + "releasedate", + "outline", + "id", + "credits", + "originaltitle", + "watched", + "playcount", + "lastplayed", + "art", + "resume", + "biography", + "formed", + "review", + "style", + "imdbid", + "imdb_id", + "country", + "audiodbalbumid", + "audiodbartistid", + "enddate", + "lockedfields", + "zap2itid", + "tvrageid", + + "musicbrainzartistid", + "musicbrainzalbumartistid", + "musicbrainzalbumid", + "musicbrainzreleasegroupid", + "tvdbid", + "collectionitem", + + "isuserfavorite", + "userrating", + + "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]"; + protected BaseNfoSaver( IFileSystem fileSystem, @@ -112,12 +117,17 @@ namespace MediaBrowser.XbmcMetadata.Savers FileSystem = fileSystem; } - protected IFileSystem FileSystem { get; private set; } - protected IServerConfigurationManager ConfigurationManager { get; private set; } - protected ILibraryManager LibraryManager { get; private set; } - protected IUserManager UserManager { get; private set; } - protected IUserDataManager UserDataManager { get; private set; } - protected ILogger Logger { get; private set; } + protected IFileSystem FileSystem { get; } + + protected IServerConfigurationManager ConfigurationManager { get; } + + protected ILibraryManager LibraryManager { get; } + + protected IUserManager UserManager { get; } + + protected IUserDataManager UserDataManager { get; } + + protected ILogger Logger { get; } protected ItemUpdateType MinimumUpdateType { @@ -136,23 +146,22 @@ namespace MediaBrowser.XbmcMetadata.Savers public static string SaverName => "Nfo"; + /// <inheritdoc /> public string GetSavePath(BaseItem item) - { - return GetLocalSavePath(item); - } + => GetLocalSavePath(item); /// <summary> /// Gets the save path. /// </summary> /// <param name="item">The item.</param> - /// <returns>System.String.</returns> + /// <returns><see cref="string" />.</returns> protected abstract string GetLocalSavePath(BaseItem item); /// <summary> /// Gets the name of the root element. /// </summary> /// <param name="item">The item.</param> - /// <returns>System.String.</returns> + /// <returns><see cref="string" />.</returns> protected abstract string GetRootElementName(BaseItem item); /// <summary> @@ -169,11 +178,12 @@ namespace MediaBrowser.XbmcMetadata.Savers foreach (var providerKey in item.ProviderIds.Keys) { var providerIdTagName = GetTagForProviderKey(providerKey); - if (!CommonTags.ContainsKey(providerIdTagName)) + if (!_commonTags.Contains(providerIdTagName)) { list.Add(providerIdTagName); } } + return list; } @@ -199,7 +209,7 @@ namespace MediaBrowser.XbmcMetadata.Savers // On Windows, savint the file will fail if the file is hidden or readonly 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); } @@ -248,9 +258,7 @@ namespace MediaBrowser.XbmcMetadata.Savers WriteCustomElements(item, writer); - var hasMediaSources = baseItem as IHasMediaSources; - - if (hasMediaSources != null) + if (baseItem is IHasMediaSources hasMediaSources) { AddMediaInfo(hasMediaSources, writer); } @@ -313,17 +321,17 @@ namespace MediaBrowser.XbmcMetadata.Savers if (stream.BitRate.HasValue) { - writer.WriteElementString("bitrate", stream.BitRate.Value.ToString(UsCulture)); + writer.WriteElementString("bitrate", stream.BitRate.Value.ToString(_usCulture)); } if (stream.Width.HasValue) { - writer.WriteElementString("width", stream.Width.Value.ToString(UsCulture)); + writer.WriteElementString("width", stream.Width.Value.ToString(_usCulture)); } 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)) @@ -336,14 +344,14 @@ namespace MediaBrowser.XbmcMetadata.Savers if (framerate.HasValue) { - writer.WriteElementString("framerate", framerate.Value.ToString(UsCulture)); + writer.WriteElementString("framerate", framerate.Value.ToString(_usCulture)); } 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 // 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"; @@ -354,12 +362,12 @@ namespace MediaBrowser.XbmcMetadata.Savers if (stream.Channels.HasValue) { - writer.WriteElementString("channels", stream.Channels.Value.ToString(UsCulture)); + writer.WriteElementString("channels", stream.Channels.Value.ToString(_usCulture)); } 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()); @@ -372,13 +380,11 @@ namespace MediaBrowser.XbmcMetadata.Savers { var timespan = TimeSpan.FromTicks(runtimeTicks.Value); - writer.WriteElementString("duration", Math.Floor(timespan.TotalMinutes).ToString(UsCulture)); - writer.WriteElementString("durationinseconds", Math.Floor(timespan.TotalSeconds).ToString(UsCulture)); + writer.WriteElementString("duration", Math.Floor(timespan.TotalMinutes).ToString(_usCulture)); + writer.WriteElementString("durationinseconds", Math.Floor(timespan.TotalSeconds).ToString(_usCulture)); } - var video = item as Video; - - if (video != null) + if (item is Video video) { //AddChapters(video, builder, itemRepository); @@ -413,21 +419,6 @@ namespace MediaBrowser.XbmcMetadata.Savers 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> /// Adds the common nodes. /// </summary> @@ -524,12 +515,12 @@ namespace MediaBrowser.XbmcMetadata.Savers if (item.CommunityRating.HasValue) { - writer.WriteElementString("rating", item.CommunityRating.Value.ToString(UsCulture)); + writer.WriteElementString("rating", item.CommunityRating.Value.ToString(_usCulture)); } if (item.ProductionYear.HasValue) { - writer.WriteElementString("year", item.ProductionYear.Value.ToString(UsCulture)); + writer.WriteElementString("year", item.ProductionYear.Value.ToString(_usCulture)); } var forcedSortName = item.ForcedSortName; @@ -628,12 +619,10 @@ namespace MediaBrowser.XbmcMetadata.Savers 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 (hasDisplayOrder != null) + if (item is IHasDisplayOrder hasDisplayOrder) { if (!string.IsNullOrEmpty(hasDisplayOrder.DisplayOrder)) { @@ -648,7 +637,7 @@ namespace MediaBrowser.XbmcMetadata.Savers { 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)) @@ -783,8 +772,7 @@ namespace MediaBrowser.XbmcMetadata.Savers AddActors(people, writer, libraryManager, fileSystem, config, options.SaveImagePathsInNfo); - var folder = item as BoxSet; - if (folder != null) + if (item is BoxSet folder) { AddCollectionItems(folder, writer); } @@ -875,7 +863,7 @@ namespace MediaBrowser.XbmcMetadata.Savers 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()); if (userdata.LastPlayedDate.HasValue) @@ -887,8 +875,8 @@ namespace MediaBrowser.XbmcMetadata.Savers var runTimeTicks = item.RunTimeTicks ?? 0; - writer.WriteElementString("position", TimeSpan.FromTicks(userdata.PlaybackPositionTicks).TotalSeconds.ToString(UsCulture)); - writer.WriteElementString("total", TimeSpan.FromTicks(runTimeTicks).TotalSeconds.ToString(UsCulture)); + writer.WriteElementString("position", TimeSpan.FromTicks(userdata.PlaybackPositionTicks).TotalSeconds.ToString(_usCulture)); + writer.WriteElementString("total", TimeSpan.FromTicks(runTimeTicks).TotalSeconds.ToString(_usCulture)); } writer.WriteEndElement(); @@ -922,24 +910,17 @@ namespace MediaBrowser.XbmcMetadata.Savers if (person.SortOrder.HasValue) { - writer.WriteElementString("sortorder", person.SortOrder.Value.ToString(UsCulture)); + writer.WriteElementString("sortorder", person.SortOrder.Value.ToString(_usCulture)); } if (saveImagePath) { - try - { - var personEntity = libraryManager.GetPerson(person.Name); - var image = personEntity.GetImageInfo(ImageType.Primary, 0); + var personEntity = libraryManager.GetPerson(person.Name); + var image = personEntity.GetImageInfo(ImageType.Primary, 0); - if (image != null) - { - writer.WriteElementString("thumb", GetImagePathToSave(image, libraryManager, config)); - } - } - catch (Exception) + if (image != null) { - // Already logged in core + writer.WriteElementString("thumb", GetImagePathToSave(image, libraryManager, config)); } } @@ -995,7 +976,7 @@ namespace MediaBrowser.XbmcMetadata.Savers { 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); } @@ -1013,8 +994,6 @@ namespace MediaBrowser.XbmcMetadata.Savers } private string GetTagForProviderKey(string providerKey) - { - return providerKey.ToLowerInvariant() + "id"; - } + => providerKey.ToLowerInvariant() + "id"; } } diff --git a/MediaBrowser.XbmcMetadata/Savers/EpisodeNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/EpisodeNfoSaver.cs index cf1b6468a..aa28fded1 100644 --- a/MediaBrowser.XbmcMetadata/Savers/EpisodeNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/EpisodeNfoSaver.cs @@ -14,43 +14,43 @@ namespace MediaBrowser.XbmcMetadata.Savers { public class EpisodeNfoSaver : BaseNfoSaver { - protected override string GetLocalSavePath(BaseItem item) + public EpisodeNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) + : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) { - return Path.ChangeExtension(item.Path, ".nfo"); } + private readonly CultureInfo _usCulture = new CultureInfo("en-US"); + + /// <inheritdoc /> + protected override string GetLocalSavePath(BaseItem item) + => Path.ChangeExtension(item.Path, ".nfo"); + + /// <inheritdoc /> protected override string GetRootElementName(BaseItem item) - { - return "episodedetails"; - } + => "episodedetails"; + /// <inheritdoc /> public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) - { - if (!item.SupportsLocalMetadata) - { - return false; - } - - return item is Episode && updateType >= MinimumUpdateType; - } + => !item.SupportsLocalMetadata && item is Episode && updateType >= MinimumUpdateType; + /// <inheritdoc /> protected override void WriteCustomElements(BaseItem item, XmlWriter writer) { var episode = (Episode)item; if (episode.IndexNumber.HasValue) { - writer.WriteElementString("episode", episode.IndexNumber.Value.ToString(UsCulture)); + writer.WriteElementString("episode", episode.IndexNumber.Value.ToString(_usCulture)); } if (episode.IndexNumberEnd.HasValue) { - writer.WriteElementString("episodenumberend", episode.IndexNumberEnd.Value.ToString(UsCulture)); + writer.WriteElementString("episodenumberend", episode.IndexNumberEnd.Value.ToString(_usCulture)); } if (episode.ParentIndexNumber.HasValue) { - writer.WriteElementString("season", episode.ParentIndexNumber.Value.ToString(UsCulture)); + writer.WriteElementString("season", episode.ParentIndexNumber.Value.ToString(_usCulture)); } if (episode.PremiereDate.HasValue) @@ -64,32 +64,33 @@ namespace MediaBrowser.XbmcMetadata.Savers { 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)); + 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)); + 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)); + writer.WriteElementString("displayepisode", episode.AirsBeforeEpisodeNumber.Value.ToString(_usCulture)); } var specialSeason = episode.AiredSeasonNumber; 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) { var list = base.GetTagsUsed(item); @@ -105,12 +106,8 @@ namespace MediaBrowser.XbmcMetadata.Savers "displayseason", "displayepisode" }); - return list; - } - public EpisodeNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) - : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) - { + return list; } } } diff --git a/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs index 5e0eff029..08a752e33 100644 --- a/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs @@ -1,5 +1,6 @@ using System.Collections.Generic; using System.IO; +using System.Linq; using System.Xml; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; @@ -15,28 +16,29 @@ namespace MediaBrowser.XbmcMetadata.Savers { 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) - { - var list = new List<string>(); + /// <inheritdoc /> + protected override string GetLocalSavePath(BaseItem item) + => GetMovieSavePaths(new ItemInfo(item)).FirstOrDefault(); + public static IEnumerable<string> GetMovieSavePaths(ItemInfo item) + { if (item.VideoType == VideoType.Dvd && !item.IsPlaceHolder) { 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)) { var path = item.ContainingFolderPath; - list.Add(Path.Combine(path, Path.GetFileName(path) + ".nfo")); + yield return Path.Combine(path, Path.GetFileName(path) + ".nfo"); } else { @@ -47,22 +49,20 @@ namespace MediaBrowser.XbmcMetadata.Savers // 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) { - 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) - { - return item is MusicVideo ? "musicvideo" : "movie"; - } + => item is MusicVideo ? "musicvideo" : "movie"; + /// <inheritdoc /> public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) { if (!item.SupportsLocalMetadata) @@ -70,10 +70,8 @@ namespace MediaBrowser.XbmcMetadata.Savers return false; } - var video = item as Video; - // 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; } @@ -81,6 +79,7 @@ namespace MediaBrowser.XbmcMetadata.Savers return false; } + /// <inheritdoc /> protected override void WriteCustomElements(BaseItem item, XmlWriter writer) { var imdb = item.GetProviderId(MetadataProviders.Imdb); @@ -90,9 +89,7 @@ namespace MediaBrowser.XbmcMetadata.Savers writer.WriteElementString("id", imdb); } - var musicVideo = item as MusicVideo; - - if (musicVideo != null) + if (item is MusicVideo musicVideo) { foreach (var artist in musicVideo.Artists) { @@ -104,9 +101,7 @@ namespace MediaBrowser.XbmcMetadata.Savers } } - var movie = item as Movie; - - if (movie != null) + if (item is Movie movie) { if (!string.IsNullOrEmpty(movie.CollectionName)) { @@ -115,6 +110,7 @@ namespace MediaBrowser.XbmcMetadata.Savers } } + /// <inheritdoc /> protected override List<string> GetTagsUsed(BaseItem item) { var list = base.GetTagsUsed(item); @@ -125,12 +121,8 @@ namespace MediaBrowser.XbmcMetadata.Savers "set", "id" }); - return list; - } - public MovieNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) - : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) - { + return list; } } } diff --git a/MediaBrowser.XbmcMetadata/Savers/SeasonNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/SeasonNfoSaver.cs index aa8d3e96c..25695121d 100644 --- a/MediaBrowser.XbmcMetadata/Savers/SeasonNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/SeasonNfoSaver.cs @@ -13,16 +13,26 @@ namespace MediaBrowser.XbmcMetadata.Savers { public class SeasonNfoSaver : BaseNfoSaver { - protected override string GetLocalSavePath(BaseItem item) + public SeasonNfoSaver( + IFileSystem fileSystem, + IServerConfigurationManager configurationManager, + ILibraryManager libraryManager, + IUserManager userManager, + IUserDataManager userDataManager, + ILogger logger) + : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) { - return Path.Combine(item.Path, "season.nfo"); } + /// <inheritdoc /> + protected override string GetLocalSavePath(BaseItem item) + => Path.Combine(item.Path, "season.nfo"); + + /// <inheritdoc /> protected override string GetRootElementName(BaseItem item) - { - return "season"; - } + => "season"; + /// <inheritdoc /> public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) { if (!item.SupportsLocalMetadata) @@ -38,6 +48,7 @@ namespace MediaBrowser.XbmcMetadata.Savers return updateType >= MinimumUpdateType || (updateType >= ItemUpdateType.MetadataImport && File.Exists(GetSavePath(item))); } + /// <inheritdoc /> protected override void WriteCustomElements(BaseItem item, XmlWriter writer) { var season = (Season)item; @@ -48,6 +59,7 @@ namespace MediaBrowser.XbmcMetadata.Savers } } + /// <inheritdoc /> protected override List<string> GetTagsUsed(BaseItem item) { var list = base.GetTagsUsed(item); @@ -58,16 +70,5 @@ namespace MediaBrowser.XbmcMetadata.Savers return list; } - - public SeasonNfoSaver( - IFileSystem fileSystem, - IServerConfigurationManager configurationManager, - ILibraryManager libraryManager, - IUserManager userManager, - IUserDataManager userDataManager, - ILogger logger) - : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) - { - } } } diff --git a/MediaBrowser.XbmcMetadata/Savers/SeriesNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/SeriesNfoSaver.cs index b0fc8c368..8d7faece7 100644 --- a/MediaBrowser.XbmcMetadata/Savers/SeriesNfoSaver.cs +++ b/MediaBrowser.XbmcMetadata/Savers/SeriesNfoSaver.cs @@ -1,4 +1,5 @@ using System.Collections.Generic; +using System.Globalization; using System.IO; using System.Xml; using MediaBrowser.Controller.Configuration; @@ -13,26 +14,30 @@ namespace MediaBrowser.XbmcMetadata.Savers { public class SeriesNfoSaver : BaseNfoSaver { - protected override string GetLocalSavePath(BaseItem item) + public SeriesNfoSaver( + IFileSystem fileSystem, + IServerConfigurationManager configurationManager, + ILibraryManager libraryManager, + IUserManager userManager, + IUserDataManager userDataManager, + ILogger logger) + : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) { - return Path.Combine(item.Path, "tvshow.nfo"); } + /// <inheritdoc /> + protected override string GetLocalSavePath(BaseItem item) + => Path.Combine(item.Path, "tvshow.nfo"); + + /// <inheritdoc /> protected override string GetRootElementName(BaseItem item) - { - return "tvshow"; - } + => "tvshow"; + /// <inheritdoc /> public override bool IsEnabledFor(BaseItem item, ItemUpdateType updateType) - { - if (!item.SupportsLocalMetadata) - { - return false; - } - - return item is Series && updateType >= MinimumUpdateType; - } + => item.SupportsLocalMetadata && item is Series && updateType >= MinimumUpdateType; + /// <inheritdoc /> protected override void WriteCustomElements(BaseItem item, XmlWriter writer) { var series = (Series)item; @@ -52,7 +57,12 @@ namespace MediaBrowser.XbmcMetadata.Savers writer.WriteStartElement("url"); 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(); @@ -67,6 +77,7 @@ namespace MediaBrowser.XbmcMetadata.Savers } } + /// <inheritdoc /> protected override List<string> GetTagsUsed(BaseItem item) { var list = base.GetTagsUsed(item); @@ -79,12 +90,8 @@ namespace MediaBrowser.XbmcMetadata.Savers "status", "displayorder" }); - return list; - } - public SeriesNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger) - : base(fileSystem, configurationManager, libraryManager, userManager, userDataManager, logger) - { + return list; } } } |
