mirror of https://github.com/ErsatzTV/ErsatzTV.git
Browse Source
* add custom movie metadata parsing * refactor episode nfo reader * fix emby and jellyfin bugspull/775/head
Jason Dove
4 years ago
committed by
GitHub
12 changed files with 516 additions and 122 deletions
@ -0,0 +1,241 @@ |
|||||||
|
using System.Text; |
||||||
|
using Bugsnag; |
||||||
|
using ErsatzTV.Core.Metadata.Nfo; |
||||||
|
using FluentAssertions; |
||||||
|
using Moq; |
||||||
|
using NUnit.Framework; |
||||||
|
|
||||||
|
namespace ErsatzTV.Core.Tests.Metadata.Nfo; |
||||||
|
|
||||||
|
[TestFixture] |
||||||
|
public class MovieNfoReaderTests |
||||||
|
{ |
||||||
|
[SetUp] |
||||||
|
public void SetUp() => _movieNfoReader = new MovieNfoReader(new Mock<IClient>().Object); |
||||||
|
|
||||||
|
private MovieNfoReader _movieNfoReader; |
||||||
|
|
||||||
|
[Test] |
||||||
|
public async Task ParsingNfo_Should_Return_Error() |
||||||
|
{ |
||||||
|
await using var stream = |
||||||
|
new MemoryStream(Encoding.UTF8.GetBytes(@"https://www.themoviedb.org/movie/11-star-wars")); |
||||||
|
|
||||||
|
Either<BaseError, MovieNfo> result = await _movieNfoReader.Read(stream); |
||||||
|
|
||||||
|
result.IsLeft.Should().BeTrue(); |
||||||
|
} |
||||||
|
|
||||||
|
[Test] |
||||||
|
public async Task MetadataNfo_Should_Return_Nfo() |
||||||
|
{ |
||||||
|
await using var stream = new MemoryStream(Encoding.UTF8.GetBytes(@"<movie></movie>")); |
||||||
|
|
||||||
|
Either<BaseError, MovieNfo> result = await _movieNfoReader.Read(stream); |
||||||
|
|
||||||
|
result.IsRight.Should().BeTrue(); |
||||||
|
} |
||||||
|
|
||||||
|
[Test] |
||||||
|
public async Task CombinationNfo_Should_Return_Nfo() |
||||||
|
{ |
||||||
|
await using var stream = new MemoryStream( |
||||||
|
Encoding.UTF8.GetBytes( |
||||||
|
@"<movie></movie>
|
||||||
|
https://www.themoviedb.org/movie/11-star-wars"));
|
||||||
|
|
||||||
|
Either<BaseError, MovieNfo> result = await _movieNfoReader.Read(stream); |
||||||
|
|
||||||
|
result.IsRight.Should().BeTrue(); |
||||||
|
} |
||||||
|
|
||||||
|
[Test] |
||||||
|
public async Task FullSample_Should_Return_Nfo() |
||||||
|
{ |
||||||
|
await using var stream = new MemoryStream( |
||||||
|
Encoding.UTF8.GetBytes( |
||||||
|
@"<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes"" ?>
|
||||||
|
<movie> |
||||||
|
<title>Zack Snyder's Justice League</title> |
||||||
|
<originaltitle>Zack Snyder's Justice League</originaltitle> |
||||||
|
<sorttitle>Justice League 2</sorttitle> |
||||||
|
<ratings> |
||||||
|
<rating name=""imdb"" max=""10"" default=""true""> |
||||||
|
<value>8.300000</value> |
||||||
|
<votes>197786</votes> |
||||||
|
</rating> |
||||||
|
<rating name=""themoviedb"" max=""10""> |
||||||
|
<value>8.700000</value> |
||||||
|
<votes>3461</votes> |
||||||
|
</rating> |
||||||
|
<rating name=""trakt"" max=""10""> |
||||||
|
<value>8.195670</value> |
||||||
|
<votes>4247</votes> |
||||||
|
</rating> |
||||||
|
</ratings> |
||||||
|
<userrating>0</userrating> |
||||||
|
<top250>140</top250> |
||||||
|
<outline></outline> |
||||||
|
<plot>Determined to ensure Superman's ultimate sacrifice was not in vain, Bruce Wayne aligns forces with Diana Prince with plans to recruit a team of metahumans to protect the world from an approaching threat of catastrophic proportions.</plot> |
||||||
|
<tagline></tagline> |
||||||
|
<runtime>242</runtime> |
||||||
|
<thumb spoof="""" cache="""" aspect=""poster"" preview="""">https://assets.fanart.tv/fanart/movies/791373/movieposter/zack-snyders-justice-league-603fdb873f474.jpg</thumb>
|
||||||
|
<thumb spoof="""" cache="""" aspect=""poster"" preview="""">https://image.tmdb.org/t/p/original/tnAuB8q5vv7Ax9UAEje5Xi4BXik.jpg</thumb>
|
||||||
|
<thumb spoof="""" cache="""" aspect=""landscape"" preview="""">https://assets.fanart.tv/fanart/movies/791373/moviethumb/zack-snyders-justice-league-6050310135cf6.jpg</thumb>
|
||||||
|
<thumb spoof="""" cache="""" aspect=""landscape"" preview="""">https://image.tmdb.org/t/p/original/wcYBuOZDP6Vi8Ye4qax3Zx9dCan.jpg</thumb>
|
||||||
|
<thumb spoof="""" cache="""" aspect=""keyart"" preview="""">https://assets.fanart.tv/fanart/movies/791373/movieposter/zack-snyders-justice-league-603fdba9bdd16.jpg</thumb>
|
||||||
|
<thumb spoof="""" cache="""" aspect=""clearlogo"" preview="""">https://assets.fanart.tv/fanart/movies/791373/hdmovielogo/zack-snyders-justice-league-5ed3f2e4952e9.png</thumb>
|
||||||
|
<thumb spoof="""" cache="""" aspect=""banner"" preview="""">https://assets.fanart.tv/fanart/movies/791373/moviebanner/zack-snyders-justice-league-6050049514d4c.jpg</thumb>
|
||||||
|
<fanart> |
||||||
|
<thumb colors="""" preview=""https://assets.fanart.tv/preview/movies/791373/moviebackground/zack-snyders-justice-league-5fee5b9fe0e0d.jpg"">https://assets.fanart.tv/fanart/movies/791373/moviebackground/zack-snyders-justice-league-5fee5b9fe0e0d.jpg</thumb>
|
||||||
|
<thumb colors="""" preview=""https://image.tmdb.org/t/p/w780/43NwryODVEsbBDC0jK3wYfVyb5q.jpg"">https://image.tmdb.org/t/p/original/43NwryODVEsbBDC0jK3wYfVyb5q.jpg</thumb>
|
||||||
|
</fanart> |
||||||
|
<mpaa>Australia:M</mpaa> |
||||||
|
<playcount>0</playcount> |
||||||
|
<lastplayed></lastplayed> |
||||||
|
<id>791373</id> |
||||||
|
<uniqueid type=""imdb"">tt12361974</uniqueid> |
||||||
|
<uniqueid type=""tmdb"" default=""true"">791373</uniqueid> |
||||||
|
<genre>SuperHero</genre> |
||||||
|
<tag>TV Recording</tag> |
||||||
|
<set> |
||||||
|
<name>Justice League Collection</name> |
||||||
|
<overview>Based on the DC Comics superhero team</overview> |
||||||
|
</set> |
||||||
|
<country>USA</country> |
||||||
|
<credits>Chris Terrio</credits> |
||||||
|
<director>Zack Snyder</director> |
||||||
|
<premiered>2021-03-18</premiered> |
||||||
|
<year>2021</year> |
||||||
|
<status></status> |
||||||
|
<code></code> |
||||||
|
<aired></aired> |
||||||
|
<studio>Warner Bros. Pictures</studio> |
||||||
|
<trailer></trailer> |
||||||
|
<fileinfo> |
||||||
|
<streamdetails> |
||||||
|
<video> |
||||||
|
<codec>hevc</codec> |
||||||
|
<aspect>1.777778</aspect> |
||||||
|
<width>1920</width> |
||||||
|
<height>1080</height> |
||||||
|
<durationinseconds>14528</durationinseconds> |
||||||
|
<stereomode></stereomode> |
||||||
|
</video> |
||||||
|
<audio> |
||||||
|
<codec>ac3</codec> |
||||||
|
<language>eng</language> |
||||||
|
<channels>6</channels> |
||||||
|
</audio> |
||||||
|
<audio> |
||||||
|
<codec>ac3</codec> |
||||||
|
<language>fre</language> |
||||||
|
<channels>6</channels> |
||||||
|
</audio> |
||||||
|
<subtitle> |
||||||
|
<language>eng</language> |
||||||
|
</subtitle> |
||||||
|
</streamdetails> |
||||||
|
</fileinfo> |
||||||
|
<actor> |
||||||
|
<name>Ben Affleck</name> |
||||||
|
<role>Bruce Wayne / Batman</role> |
||||||
|
<order>0</order> |
||||||
|
<thumb>https://image.tmdb.org/t/p/original/u525jeDOzg9hVdvYfeehTGnw7Aa.jpg</thumb>
|
||||||
|
</actor> |
||||||
|
<actor> |
||||||
|
<name>Henry Cavill</name> |
||||||
|
<role>Clark Kent / Superman / Kal-El</role> |
||||||
|
<order>1</order> |
||||||
|
<thumb>https://image.tmdb.org/t/p/original/hErUwonrQgY5Y7RfxOfv8Fq11MB.jpg</thumb>
|
||||||
|
</actor> |
||||||
|
<actor> |
||||||
|
<name>Gal Gadot</name> |
||||||
|
<role>Diana Prince / Wonder Woman</role> |
||||||
|
<order>2</order> |
||||||
|
<thumb>https://image.tmdb.org/t/p/original/fysvehTvU6bE3JgxaOTRfvQJzJ4.jpg</thumb>
|
||||||
|
</actor> |
||||||
|
<resume> |
||||||
|
<position>0.000000</position> |
||||||
|
<total>0.000000</total> |
||||||
|
</resume> |
||||||
|
<dateadded>2021-03-26 11:35:50</dateadded> |
||||||
|
</movie>"));
|
||||||
|
|
||||||
|
Either<BaseError, MovieNfo> result = await _movieNfoReader.Read(stream); |
||||||
|
|
||||||
|
result.IsRight.Should().BeTrue(); |
||||||
|
|
||||||
|
foreach (MovieNfo nfo in result.RightToSeq()) |
||||||
|
{ |
||||||
|
nfo.Title.Should().Be("Zack Snyder's Justice League"); |
||||||
|
nfo.SortTitle.Should().Be("Justice League 2"); |
||||||
|
nfo.Outline.Should().BeNullOrEmpty(); |
||||||
|
nfo.Year.Should().Be(2021); |
||||||
|
nfo.ContentRating.Should().Be("Australia:M"); |
||||||
|
nfo.Premiered.Should().Be(new DateTime(2021, 03, 18)); |
||||||
|
nfo.Plot.Should().Be( |
||||||
|
"Determined to ensure Superman's ultimate sacrifice was not in vain, Bruce Wayne aligns forces with Diana Prince with plans to recruit a team of metahumans to protect the world from an approaching threat of catastrophic proportions."); |
||||||
|
nfo.Tagline.Should().BeNullOrEmpty(); |
||||||
|
nfo.Genres.Should().BeEquivalentTo(new List<string> { "SuperHero" }); |
||||||
|
nfo.Tags.Should().BeEquivalentTo(new List<string> { "TV Recording" }); |
||||||
|
nfo.Studios.Should().BeEquivalentTo(new List<string> { "Warner Bros. Pictures" }); |
||||||
|
nfo.Actors.Should().BeEquivalentTo( |
||||||
|
new List<ActorNfo> |
||||||
|
{ |
||||||
|
new() |
||||||
|
{ |
||||||
|
Name = "Ben Affleck", Order = 0, Role = "Bruce Wayne / Batman", |
||||||
|
Thumb = "https://image.tmdb.org/t/p/original/u525jeDOzg9hVdvYfeehTGnw7Aa.jpg" |
||||||
|
}, |
||||||
|
new() |
||||||
|
{ |
||||||
|
Name = "Henry Cavill", Order = 1, Role = "Clark Kent / Superman / Kal-El", |
||||||
|
Thumb = "https://image.tmdb.org/t/p/original/hErUwonrQgY5Y7RfxOfv8Fq11MB.jpg" |
||||||
|
}, |
||||||
|
new() |
||||||
|
{ |
||||||
|
Name = "Gal Gadot", Order = 2, Role = "Diana Prince / Wonder Woman", |
||||||
|
Thumb = "https://image.tmdb.org/t/p/original/fysvehTvU6bE3JgxaOTRfvQJzJ4.jpg" |
||||||
|
} |
||||||
|
}); |
||||||
|
nfo.Writers.Should().BeEquivalentTo(new List<string> { "Chris Terrio" }); |
||||||
|
nfo.Directors.Should().BeEquivalentTo(new List<string> { "Zack Snyder" }); |
||||||
|
nfo.UniqueIds.Should().BeEquivalentTo( |
||||||
|
new List<UniqueIdNfo> |
||||||
|
{ |
||||||
|
new() { Type = "imdb", Guid = "tt12361974", Default = false }, |
||||||
|
new() { Type = "tmdb", Guid = "791373", Default = true } |
||||||
|
}); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
[Test] |
||||||
|
public async Task MetadataNfo_With_Tag_Should_Return_Nfo() |
||||||
|
{ |
||||||
|
await using var stream = new MemoryStream(Encoding.UTF8.GetBytes(@"<movie><tag>Test Tag</tag></movie>")); |
||||||
|
|
||||||
|
Either<BaseError, MovieNfo> result = await _movieNfoReader.Read(stream); |
||||||
|
|
||||||
|
result.IsRight.Should().BeTrue(); |
||||||
|
foreach (MovieNfo nfo in result.RightToSeq()) |
||||||
|
{ |
||||||
|
nfo.Tags.Should().BeEquivalentTo(new List<string> { "Test Tag" }); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
[Test] |
||||||
|
public async Task MetadataNfo_With_Outline_Should_Return_Nfo() |
||||||
|
{ |
||||||
|
await using var stream = |
||||||
|
new MemoryStream(Encoding.UTF8.GetBytes(@"<movie><outline>Test Outline</outline></movie>")); |
||||||
|
|
||||||
|
Either<BaseError, MovieNfo> result = await _movieNfoReader.Read(stream); |
||||||
|
|
||||||
|
result.IsRight.Should().BeTrue(); |
||||||
|
foreach (MovieNfo nfo in result.RightToSeq()) |
||||||
|
{ |
||||||
|
nfo.Outline.Should().Be("Test Outline"); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,9 @@ |
|||||||
|
namespace ErsatzTV.Core.Errors; |
||||||
|
|
||||||
|
public class FailedToReadNfo : BaseError |
||||||
|
{ |
||||||
|
public FailedToReadNfo(string message = null) : base( |
||||||
|
string.IsNullOrWhiteSpace(message) ? "Failed to read NFO metadata" : $"Failed to read NFO metadata: {message}") |
||||||
|
{ |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,8 @@ |
|||||||
|
using ErsatzTV.Core.Metadata.Nfo; |
||||||
|
|
||||||
|
namespace ErsatzTV.Core.Interfaces.Metadata.Nfo; |
||||||
|
|
||||||
|
public interface IMovieNfoReader |
||||||
|
{ |
||||||
|
Task<Either<BaseError, MovieNfo>> Read(Stream input); |
||||||
|
} |
||||||
@ -0,0 +1,114 @@ |
|||||||
|
using System.Xml; |
||||||
|
using Bugsnag; |
||||||
|
using ErsatzTV.Core.Errors; |
||||||
|
using ErsatzTV.Core.Interfaces.Metadata.Nfo; |
||||||
|
|
||||||
|
namespace ErsatzTV.Core.Metadata.Nfo; |
||||||
|
|
||||||
|
public class MovieNfoReader : NfoReader<MovieNfo>, IMovieNfoReader |
||||||
|
{ |
||||||
|
private readonly IClient _client; |
||||||
|
|
||||||
|
public MovieNfoReader(IClient client) => _client = client; |
||||||
|
|
||||||
|
public async Task<Either<BaseError, MovieNfo>> Read(Stream input) |
||||||
|
{ |
||||||
|
try |
||||||
|
{ |
||||||
|
var settings = new XmlReaderSettings { Async = true, ConformanceLevel = ConformanceLevel.Fragment }; |
||||||
|
using var reader = XmlReader.Create(input, settings); |
||||||
|
MovieNfo nfo = null; |
||||||
|
var done = false; |
||||||
|
|
||||||
|
while (!done && await reader.ReadAsync()) |
||||||
|
{ |
||||||
|
switch (reader.NodeType) |
||||||
|
{ |
||||||
|
case XmlNodeType.Element: |
||||||
|
switch (reader.Name.ToLowerInvariant()) |
||||||
|
{ |
||||||
|
case "movie": |
||||||
|
nfo = new MovieNfo |
||||||
|
{ |
||||||
|
Genres = new List<string>(), |
||||||
|
Tags = new List<string>(), |
||||||
|
Studios = new List<string>(), |
||||||
|
Actors = new List<ActorNfo>(), |
||||||
|
Writers = new List<string>(), |
||||||
|
Directors = new List<string>(), |
||||||
|
UniqueIds = new List<UniqueIdNfo>() |
||||||
|
}; |
||||||
|
break; |
||||||
|
case "title": |
||||||
|
await ReadStringContent(reader, nfo, (movie, title) => movie.Title = title); |
||||||
|
break; |
||||||
|
case "sorttitle": |
||||||
|
await ReadStringContent(reader, nfo, (movie, sortTitle) => movie.SortTitle = sortTitle); |
||||||
|
break; |
||||||
|
case "outline": |
||||||
|
await ReadStringContent(reader, nfo, (movie, outline) => movie.Outline = outline); |
||||||
|
break; |
||||||
|
case "year": |
||||||
|
await ReadIntContent(reader, nfo, (movie, year) => movie.Year = year); |
||||||
|
break; |
||||||
|
case "mpaa": |
||||||
|
await ReadStringContent( |
||||||
|
reader, |
||||||
|
nfo, |
||||||
|
(movie, contentRating) => movie.ContentRating = contentRating); |
||||||
|
break; |
||||||
|
case "premiered": |
||||||
|
await ReadDateTimeContent( |
||||||
|
reader, |
||||||
|
nfo, |
||||||
|
(movie, premiered) => movie.Premiered = premiered); |
||||||
|
break; |
||||||
|
case "plot": |
||||||
|
await ReadStringContent(reader, nfo, (movie, plot) => movie.Plot = plot); |
||||||
|
break; |
||||||
|
case "genre": |
||||||
|
await ReadStringContent(reader, nfo, (movie, genre) => movie.Genres.Add(genre)); |
||||||
|
break; |
||||||
|
case "tag": |
||||||
|
await ReadStringContent(reader, nfo, (movie, tag) => movie.Tags.Add(tag)); |
||||||
|
break; |
||||||
|
case "studio": |
||||||
|
await ReadStringContent(reader, nfo, (movie, studio) => movie.Studios.Add(studio)); |
||||||
|
break; |
||||||
|
case "actor": |
||||||
|
ReadActor(reader, nfo, (movie, actor) => movie.Actors.Add(actor)); |
||||||
|
break; |
||||||
|
case "credits": |
||||||
|
await ReadStringContent(reader, nfo, (movie, writer) => movie.Writers.Add(writer)); |
||||||
|
break; |
||||||
|
case "director": |
||||||
|
await ReadStringContent( |
||||||
|
reader, |
||||||
|
nfo, |
||||||
|
(movie, director) => movie.Directors.Add(director)); |
||||||
|
break; |
||||||
|
case "uniqueid": |
||||||
|
await ReadUniqueId(reader, nfo, (movie, uniqueid) => movie.UniqueIds.Add(uniqueid)); |
||||||
|
break; |
||||||
|
} |
||||||
|
|
||||||
|
break; |
||||||
|
case XmlNodeType.EndElement: |
||||||
|
if (reader.Name == "movie") |
||||||
|
{ |
||||||
|
done = true; |
||||||
|
} |
||||||
|
|
||||||
|
break; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return Optional(nfo).ToEither((BaseError)new FailedToReadNfo()); |
||||||
|
} |
||||||
|
catch (Exception ex) |
||||||
|
{ |
||||||
|
_client.Notify(ex); |
||||||
|
return new FailedToReadNfo(ex.ToString()); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,83 @@ |
|||||||
|
using System.Xml; |
||||||
|
using System.Xml.Linq; |
||||||
|
|
||||||
|
namespace ErsatzTV.Core.Metadata.Nfo; |
||||||
|
|
||||||
|
public abstract class NfoReader<T> |
||||||
|
{ |
||||||
|
protected static async Task ReadStringContent(XmlReader reader, T nfo, Action<T, string> action) |
||||||
|
{ |
||||||
|
if (nfo != null) |
||||||
|
{ |
||||||
|
string result = await reader.ReadElementContentAsStringAsync(); |
||||||
|
action(nfo, result); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
protected static async Task ReadIntContent(XmlReader reader, T nfo, Action<T, int> action) |
||||||
|
{ |
||||||
|
if (nfo != null && int.TryParse(await reader.ReadElementContentAsStringAsync(), out int result)) |
||||||
|
{ |
||||||
|
action(nfo, result); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
protected static async Task ReadDateTimeContent(XmlReader reader, T nfo, Action<T, DateTime> action) |
||||||
|
{ |
||||||
|
if (nfo != null && DateTime.TryParse(await reader.ReadElementContentAsStringAsync(), out DateTime result)) |
||||||
|
{ |
||||||
|
action(nfo, result); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
protected static void ReadActor(XmlReader reader, T nfo, Action<T, ActorNfo> action) |
||||||
|
{ |
||||||
|
if (nfo != null) |
||||||
|
{ |
||||||
|
var actor = new ActorNfo(); |
||||||
|
var element = (XElement)XNode.ReadFrom(reader); |
||||||
|
|
||||||
|
XElement name = element.Element("name"); |
||||||
|
if (name != null) |
||||||
|
{ |
||||||
|
actor.Name = name.Value; |
||||||
|
} |
||||||
|
|
||||||
|
XElement role = element.Element("role"); |
||||||
|
if (role != null) |
||||||
|
{ |
||||||
|
actor.Role = role.Value; |
||||||
|
} |
||||||
|
|
||||||
|
XElement order = element.Element("order"); |
||||||
|
if (order != null && int.TryParse(order.Value, out int orderValue)) |
||||||
|
{ |
||||||
|
actor.Order = orderValue; |
||||||
|
} |
||||||
|
|
||||||
|
XElement thumb = element.Element("thumb"); |
||||||
|
if (thumb != null) |
||||||
|
{ |
||||||
|
actor.Thumb = thumb.Value; |
||||||
|
} |
||||||
|
|
||||||
|
action(nfo, actor); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
protected static async Task ReadUniqueId(XmlReader reader, T nfo, Action<T, UniqueIdNfo> action) |
||||||
|
{ |
||||||
|
if (nfo != null) |
||||||
|
{ |
||||||
|
var uniqueId = new UniqueIdNfo(); |
||||||
|
reader.MoveToAttribute("default"); |
||||||
|
uniqueId.Default = bool.TryParse(reader.Value, out bool def) && def; |
||||||
|
reader.MoveToAttribute("type"); |
||||||
|
uniqueId.Type = reader.Value; |
||||||
|
reader.MoveToElement(); |
||||||
|
uniqueId.Guid = await reader.ReadElementContentAsStringAsync(); |
||||||
|
|
||||||
|
action(nfo, uniqueId); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
Loading…
Reference in new issue