commit f14138965d931319b4f5c152fb6a377db903cada Author: crobibero Date: Sat Nov 7 19:25:51 2020 -0700 Init diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.github/workflows/dotnet-core.yml b/.github/workflows/dotnet-core.yml new file mode 100644 index 0000000..eb31d99 --- /dev/null +++ b/.github/workflows/dotnet-core.yml @@ -0,0 +1,23 @@ +name: .NET Core + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup .NET Core + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 3.1.x + - name: Install dependencies + run: dotnet restore + - name: Build + run: dotnet build --configuration Release --no-restore + - name: Test + run: dotnet test --no-restore --verbosity normal diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3e759b7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,330 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ +**/Properties/launchSettings.json + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_i.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush +.cr/ + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ diff --git a/Jellyfin.Plugin.TvMaze.sln b/Jellyfin.Plugin.TvMaze.sln new file mode 100644 index 0000000..2fbf17d --- /dev/null +++ b/Jellyfin.Plugin.TvMaze.sln @@ -0,0 +1,16 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.TvMaze", "Jellyfin.Plugin.TvMaze\Jellyfin.Plugin.TvMaze.csproj", "{E19BAF7F-0FF0-4C8C-8EA4-831E448467CB}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {E19BAF7F-0FF0-4C8C-8EA4-831E448467CB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E19BAF7F-0FF0-4C8C-8EA4-831E448467CB}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E19BAF7F-0FF0-4C8C-8EA4-831E448467CB}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E19BAF7F-0FF0-4C8C-8EA4-831E448467CB}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/Jellyfin.Plugin.TvMaze/Configuration/PluginConfiguration.cs b/Jellyfin.Plugin.TvMaze/Configuration/PluginConfiguration.cs new file mode 100644 index 0000000..6cef014 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Configuration/PluginConfiguration.cs @@ -0,0 +1,12 @@ +using MediaBrowser.Model.Plugins; + +namespace Jellyfin.Plugin.TvMaze.Configuration +{ + /// + /// Configuration for TV Maze. + /// + public class PluginConfiguration : BasePluginConfiguration + { + // Nothing to configure. + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeEpisodeExternalId.cs b/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeEpisodeExternalId.cs new file mode 100644 index 0000000..ef4ead2 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeEpisodeExternalId.cs @@ -0,0 +1,29 @@ +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; + +namespace Jellyfin.Plugin.TvMaze.ExternalIds +{ + /// + public class TvMazeEpisodeExternalId : IExternalId + { + /// + public string ProviderName => "TV Maze Episode"; + + /// + public string Key => TvMazePlugin.ProviderId; + + /// + public ExternalIdMediaType? Type => ExternalIdMediaType.Episode; + + /// + public string UrlFormatString => "http://www.tvmaze.com/episodes/{0}"; + + /// + public bool Supports(IHasProviderIds item) + { + return item is Episode; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeSeasonExternalId.cs b/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeSeasonExternalId.cs new file mode 100644 index 0000000..94de297 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeSeasonExternalId.cs @@ -0,0 +1,29 @@ +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; + +namespace Jellyfin.Plugin.TvMaze.ExternalIds +{ + /// + public class TvMazeSeasonExternalId : IExternalId + { + /// + public string ProviderName => "TV Maze Season"; + + /// + public string Key => TvMazePlugin.ProviderId; + + /// + public ExternalIdMediaType? Type => ExternalIdMediaType.Season; + + /// + public string UrlFormatString => "http://www.tvmaze.com/seasons/{0}/season"; + + /// + public bool Supports(IHasProviderIds item) + { + return item is Season; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeSeriesExternalId.cs b/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeSeriesExternalId.cs new file mode 100644 index 0000000..e71f731 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/ExternalIds/TvMazeSeriesExternalId.cs @@ -0,0 +1,29 @@ +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; + +namespace Jellyfin.Plugin.TvMaze.ExternalIds +{ + /// + public class TvMazeSeriesExternalId : IExternalId + { + /// + public string ProviderName => "TV Maze Series"; + + /// + public string Key => TvMazePlugin.ProviderId; + + /// + public ExternalIdMediaType? Type => ExternalIdMediaType.Series; + + /// + public string UrlFormatString => "http://www.tvmaze.com/shows/{0}"; + + /// + public bool Supports(IHasProviderIds item) + { + return item is Series; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Jellyfin.Plugin.TvMaze.csproj b/Jellyfin.Plugin.TvMaze/Jellyfin.Plugin.TvMaze.csproj new file mode 100644 index 0000000..bd743f6 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Jellyfin.Plugin.TvMaze.csproj @@ -0,0 +1,36 @@ + + + + netstandard2.1 + 1.0.0.0 + 1.0.0.0 + true + true + enable + + + + + + + + + + + + + + + + + + + + + + + + ../jellyfin.ruleset + + + diff --git a/Jellyfin.Plugin.TvMaze/Providers/Helpers.cs b/Jellyfin.Plugin.TvMaze/Providers/Helpers.cs new file mode 100644 index 0000000..13432c1 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/Helpers.cs @@ -0,0 +1,50 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using MediaBrowser.Model.Entities; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// Search helpers. + /// + public static class Helpers + { + internal static int? GetTvMazeId(Dictionary providerIds) + { + if (providerIds.TryGetValue(TvMazePlugin.ProviderId, out var id) + && !string.IsNullOrEmpty(id)) + { + return Convert.ToInt32(id, CultureInfo.InvariantCulture); + } + + return null; + } + + /// + /// Strips html tags from input. + /// + /// Input string. + /// Stripped input. + internal static string StripHtml(string input) + { + return input + .Replace("
", Environment.NewLine, StringComparison.OrdinalIgnoreCase) + .Replace("

", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("

", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
  • ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
    • ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
      ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
    ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
    ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
    ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("
    ", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("", string.Empty, StringComparison.OrdinalIgnoreCase) + .Replace("", string.Empty, StringComparison.OrdinalIgnoreCase); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Providers/TvMazeEpisodeImageProvider.cs b/Jellyfin.Plugin.TvMaze/Providers/TvMazeEpisodeImageProvider.cs new file mode 100644 index 0000000..5a9ebaa --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/TvMazeEpisodeImageProvider.cs @@ -0,0 +1,103 @@ +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; +using TvMaze.Api.Client; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// TV Maze episode image provider. + /// + public class TvMazeEpisodeImageProvider : IRemoteImageProvider + { + private readonly IHttpClient _httpClient; + private readonly ITvMazeClient _tvMazeClient; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public TvMazeEpisodeImageProvider(IHttpClient httpClient) + { + _httpClient = httpClient; + _tvMazeClient = new TvMazeClient(); + } + + /// + public string Name => TvMazePlugin.ProviderName; + + /// + public bool Supports(BaseItem item) + { + return item is Episode; + } + + /// + public IEnumerable GetSupportedImages(BaseItem item) + { + yield return ImageType.Primary; + } + + /// + public async Task> GetImages(BaseItem item, CancellationToken cancellationToken) + { + var episode = (Episode)item; + var series = episode.Series; + if (series == null) + { + // Episode or series is null. + return Enumerable.Empty(); + } + + var tvMazeId = Helpers.GetTvMazeId(episode.Series.ProviderIds); + if (tvMazeId == null) + { + // Requires series tv maze id. + return Enumerable.Empty(); + } + + if (episode.IndexNumber == null || episode.ParentIndexNumber == null) + { + // Missing episode or season number. + return Enumerable.Empty(); + } + + var tvMazeEpisode = await _tvMazeClient.Shows.GetEpisodeByNumberAsync(tvMazeId.Value, episode.ParentIndexNumber.Value, episode.IndexNumber.Value).ConfigureAwait(false); + if (tvMazeEpisode == null) + { + return Enumerable.Empty(); + } + + var imageResults = new List(); + if (tvMazeEpisode.Image?.Original != null) + { + imageResults.Add(new RemoteImageInfo + { + Url = tvMazeEpisode.Image.Original, + ProviderName = TvMazePlugin.ProviderName, + Language = "en", + Type = ImageType.Primary + }); + } + + return imageResults; + } + + /// + public Task GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url + }); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Providers/TvMazeEpisodeProvider.cs b/Jellyfin.Plugin.TvMaze/Providers/TvMazeEpisodeProvider.cs new file mode 100644 index 0000000..eadecb0 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/TvMazeEpisodeProvider.cs @@ -0,0 +1,137 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; +using TvMaze.Api.Client; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// TV Maze episode provider. + /// + public class TvMazeEpisodeProvider : IRemoteMetadataProvider + { + private readonly ITvMazeClient _tvMazeClient; + private readonly IHttpClient _httpClient; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public TvMazeEpisodeProvider(IHttpClient httpClient) + { + // TODO DI. + _tvMazeClient = new TvMazeClient(); + _httpClient = httpClient; + } + + /// + public string Name => TvMazePlugin.ProviderName; + + /// + public async Task> GetSearchResults(EpisodeInfo searchInfo, CancellationToken cancellationToken) + { + var results = new List(); + + var tvMazeId = Helpers.GetTvMazeId(searchInfo.SeriesProviderIds); + if (!tvMazeId.HasValue) + { + // Requires a tv maze id. + return results; + } + + var episode = await GetMetadataInternal(searchInfo).ConfigureAwait(false); + if (episode != null) + { + results.Add(new RemoteSearchResult + { + IndexNumber = episode.IndexNumber, + Name = episode.Name, + ParentIndexNumber = episode.ParentIndexNumber, + PremiereDate = episode.PremiereDate, + ProductionYear = episode.ProductionYear, + ProviderIds = episode.ProviderIds, + SearchProviderName = Name, + IndexNumberEnd = episode.IndexNumberEnd + }); + } + + return results; + } + + /// + public async Task> GetMetadata(EpisodeInfo info, CancellationToken cancellationToken) + { + var result = new MetadataResult(); + var episode = await GetMetadataInternal(info).ConfigureAwait(false); + if (episode != null) + { + result.Item = episode; + result.HasMetadata = true; + } + + return result; + } + + /// + public Task GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url + }); + } + + private async Task GetMetadataInternal(EpisodeInfo info) + { + var tvMazeId = Helpers.GetTvMazeId(info.SeriesProviderIds); + if (!tvMazeId.HasValue) + { + // Requires a tv maze id. + return null; + } + + // The search query must provide an episode number. + if (!info.IndexNumber.HasValue || !info.ParentIndexNumber.HasValue) + { + return null; + } + + var tvMazeEpisode = await _tvMazeClient.Shows.GetEpisodeByNumberAsync(tvMazeId.Value, info.ParentIndexNumber.Value, info.IndexNumber.Value).ConfigureAwait(false); + if (tvMazeEpisode == null) + { + // No episode found. + return null; + } + + var episode = new Episode + { + Name = tvMazeEpisode.Name, + IndexNumber = tvMazeEpisode.Number, + ParentIndexNumber = tvMazeEpisode.Season + }; + + if (DateTime.TryParse(tvMazeEpisode.AirDate, out var airDate)) + { + episode.PremiereDate = airDate; + } + + if (tvMazeEpisode.Runtime.HasValue) + { + episode.RunTimeTicks = TimeSpan.FromTicks(tvMazeEpisode.Runtime.Value).Ticks; + } + + episode.Overview = Helpers.StripHtml(tvMazeEpisode.Summary); + episode.SetProviderId(TvMazePlugin.ProviderId, tvMazeEpisode.Id.ToString(CultureInfo.InvariantCulture)); + + return episode; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeasonImageProvider.cs b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeasonImageProvider.cs new file mode 100644 index 0000000..eb792ca --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeasonImageProvider.cs @@ -0,0 +1,117 @@ +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; +using TvMaze.Api.Client; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// TV Maze season image provider. + /// + public class TvMazeSeasonImageProvider : IRemoteImageProvider + { + private readonly IHttpClient _httpClient; + private readonly ITvMazeClient _tvMazeClient; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public TvMazeSeasonImageProvider(IHttpClient httpClient) + { + _httpClient = httpClient; + // TODO DI. + _tvMazeClient = new TvMazeClient(); + } + + /// + public string Name => TvMazePlugin.ProviderName; + + /// + public bool Supports(BaseItem item) + { + return item is Season; + } + + /// + public IEnumerable GetSupportedImages(BaseItem item) + { + yield return ImageType.Primary; + } + + /// + public async Task> GetImages(BaseItem item, CancellationToken cancellationToken) + { + var season = (Season)item; + var series = season.Series; + + if (series == null) + { + // Invalid link. + return Enumerable.Empty(); + } + + if (!season.IndexNumber.HasValue) + { + return Enumerable.Empty(); + } + + return await GetSeasonImagesInternal(series, season.IndexNumber.Value).ConfigureAwait(false); + } + + /// + public Task GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url + }); + } + + private async Task> GetSeasonImagesInternal(IHasProviderIds series, int seasonNumber) + { + var tvMazeId = Helpers.GetTvMazeId(series.ProviderIds); + if (tvMazeId == null) + { + // Requires series tv maze id. + return Enumerable.Empty(); + } + + var tvMazeSeasons = await _tvMazeClient.Shows.GetShowSeasonsAsync(tvMazeId.Value).ConfigureAwait(false); + if (tvMazeSeasons == null) + { + return Enumerable.Empty(); + } + + var imageResults = new List(); + foreach (var tvMazeSeason in tvMazeSeasons) + { + if (tvMazeSeason.Number == seasonNumber) + { + if (tvMazeSeason.Image?.Original != null) + { + imageResults.Add(new RemoteImageInfo + { + Url = tvMazeSeason.Image.Original, + ProviderName = TvMazePlugin.ProviderName, + Language = "en", + Type = ImageType.Primary + }); + } + + break; + } + } + + return imageResults; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeasonProvider.cs b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeasonProvider.cs new file mode 100644 index 0000000..060974c --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeasonProvider.cs @@ -0,0 +1,130 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; +using TvMaze.Api.Client; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// TV Maze Season provider. + /// + public class TvMazeSeasonProvider : IRemoteMetadataProvider + { + private readonly ITvMazeClient _tvMazeClient; + private readonly IHttpClient _httpClient; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public TvMazeSeasonProvider(IHttpClient httpClient) + { + // TODO DI. + _tvMazeClient = new TvMazeClient(); + _httpClient = httpClient; + } + + /// + public string Name => TvMazePlugin.ProviderName; + + /// + public async Task> GetSearchResults(SeasonInfo searchInfo, CancellationToken cancellationToken) + { + var results = new List(); + var season = await GetSeasonInternal(searchInfo).ConfigureAwait(false); + if (season != null) + { + results.Add(new RemoteSearchResult + { + IndexNumber = season.IndexNumber, + Name = season.Name, + PremiereDate = season.PremiereDate, + ProductionYear = season.ProductionYear, + ProviderIds = season.ProviderIds, + SearchProviderName = Name + }); + } + + return results; + } + + /// + public async Task> GetMetadata(SeasonInfo info, CancellationToken cancellationToken) + { + var result = new MetadataResult(); + + if (!info.IndexNumber.HasValue) + { + // Requires season number. + return result; + } + + var season = await GetSeasonInternal(info).ConfigureAwait(false); + if (season != null) + { + result.Item = season; + result.HasMetadata = true; + } + + return result; + } + + /// + public Task GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url + }); + } + + private async Task GetSeasonInternal(SeasonInfo info) + { + var tvMazeId = Helpers.GetTvMazeId(info.SeriesProviderIds); + if (tvMazeId == null) + { + // Requires series tv maze id. + return null; + } + + var tvMazeSeasons = await _tvMazeClient.Shows.GetShowSeasonsAsync(tvMazeId.Value).ConfigureAwait(false); + if (tvMazeSeasons == null) + { + return null; + } + + foreach (var tvMazeSeason in tvMazeSeasons) + { + if (tvMazeSeason.Number == info.IndexNumber) + { + var season = new Season + { + Name = tvMazeSeason.Name, + IndexNumber = tvMazeSeason.Number + }; + + if (DateTime.TryParse(tvMazeSeason.PremiereDate, out var premiereDate)) + { + season.PremiereDate = premiereDate; + season.ProductionYear = premiereDate.Year; + } + + season.SetProviderId(TvMazePlugin.ProviderId, tvMazeSeason.Id.ToString(CultureInfo.InvariantCulture)); + + return season; + } + } + + // Season not found. + return null; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeriesImageProvider.cs b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeriesImageProvider.cs new file mode 100644 index 0000000..1f4c7ea --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeriesImageProvider.cs @@ -0,0 +1,89 @@ +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; +using TvMaze.Api.Client; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// TV Maze series image provider. + /// + public class TvMazeSeriesImageProvider : IRemoteImageProvider + { + private readonly IHttpClient _httpClient; + private readonly ITvMazeClient _tvMazeClient; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public TvMazeSeriesImageProvider(IHttpClient httpClient) + { + _httpClient = httpClient; + _tvMazeClient = new TvMazeClient(); + } + + /// + public string Name => TvMazePlugin.ProviderName; + + /// + public bool Supports(BaseItem item) + { + return item is Series; + } + + /// + public IEnumerable GetSupportedImages(BaseItem item) + { + yield return ImageType.Primary; + } + + /// + public async Task> GetImages(BaseItem item, CancellationToken cancellationToken) + { + var tvMazeId = Helpers.GetTvMazeId(item.ProviderIds); + if (tvMazeId == null) + { + // Requires series tv maze id. + return Enumerable.Empty(); + } + + var tvMazeSeries = await _tvMazeClient.Shows.GetShowMainInformation(tvMazeId.Value).ConfigureAwait(false); + if (tvMazeSeries == null) + { + return Enumerable.Empty(); + } + + var imageResults = new List(); + if (tvMazeSeries.Image?.Original != null) + { + imageResults.Add(new RemoteImageInfo + { + Url = tvMazeSeries.Image.Original, + ProviderName = TvMazePlugin.ProviderName, + Language = "en", + Type = ImageType.Primary + }); + } + + return imageResults; + } + + /// + public Task GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url + }); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeriesProvider.cs b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeriesProvider.cs new file mode 100644 index 0000000..e1d6732 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/Providers/TvMazeSeriesProvider.cs @@ -0,0 +1,157 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Providers; +using TvMaze.Api.Client; + +namespace Jellyfin.Plugin.TvMaze.Providers +{ + /// + /// TV Maze series provider. + /// + public class TvMazeSeriesProvider : IRemoteMetadataProvider + { + private readonly IHttpClient _httpClient; + private readonly ITvMazeClient _tvMazeClient; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public TvMazeSeriesProvider(IHttpClient httpClient) + { + _httpClient = httpClient; + // TODO DI. + _tvMazeClient = new TvMazeClient(); + } + + /// + public string Name => TvMazePlugin.ProviderName; + + /// + public async Task> GetSearchResults(SeriesInfo searchInfo, CancellationToken cancellationToken) + { + var show = await _tvMazeClient.Search.ShowSingleSearchAsync($"q={searchInfo.Name}").ConfigureAwait(false); + + // No results + if (show == null) + { + return Enumerable.Empty(); + } + + var searchResult = new RemoteSearchResult + { + Name = show.Show.Name, + SearchProviderName = Name + }; + + if (DateTime.TryParse(show.Show.Premiered, out var premiereDate)) + { + searchResult.PremiereDate = premiereDate; + searchResult.ProductionYear = premiereDate.Year; + } + + // Set all provider ids. + if (!string.IsNullOrEmpty(show.Show.Externals.Imdb)) + { + searchResult.SetProviderId(MetadataProvider.Imdb.ToString(), show.Show.Externals.Imdb); + } + + if (show.Show.Externals.TvRage.HasValue) + { + searchResult.SetProviderId(MetadataProvider.TvRage.ToString(), show.Show.Externals.TvRage.Value.ToString(CultureInfo.InvariantCulture)); + } + + if (show.Show.Externals.TheTvdb.HasValue) + { + searchResult.SetProviderId(MetadataProvider.Tvdb.ToString(), show.Show.Externals.TheTvdb.Value.ToString(CultureInfo.InvariantCulture)); + } + + return new[] + { + searchResult + }; + } + + /// + public async Task> GetMetadata(SeriesInfo info, CancellationToken cancellationToken) + { + var result = new MetadataResult(); + + var tvMazeId = Helpers.GetTvMazeId(info.ProviderIds); + if (!tvMazeId.HasValue) + { + // Requires a tv maze id. + return result; + } + + var tvMazeShow = await _tvMazeClient.Shows.GetShowMainInformation(tvMazeId.Value).ConfigureAwait(false); + if (tvMazeShow == null) + { + // Invalid tv maze id. + return result; + } + + var series = new Series(); + series.Name = tvMazeShow.Name; + series.Genres = tvMazeShow.Genres.ToArray(); + + if (!string.IsNullOrWhiteSpace(tvMazeShow.Network?.Name)) + { + var networkName = tvMazeShow.Network.Name; + if (!string.IsNullOrWhiteSpace(tvMazeShow.Network?.Country?.Code)) + { + networkName = $"{tvMazeShow.Network.Name} ({tvMazeShow.Network.Country.Code})"; + } + + series.Studios = new[] { networkName }; + } + + if (DateTime.TryParse(tvMazeShow.Premiered, out var premiereDate)) + { + series.PremiereDate = premiereDate; + series.ProductionYear = premiereDate.Year; + } + + if (tvMazeShow.Rating?.Average != null) + { + series.CommunityRating = (float?)tvMazeShow.Rating.Average; + } + + if (tvMazeShow.Runtime.HasValue) + { + series.RunTimeTicks = TimeSpan.FromMinutes(tvMazeShow.Runtime.Value).Ticks; + } + + if (string.Equals(tvMazeShow.Status, "Running", StringComparison.OrdinalIgnoreCase)) + { + series.Status = SeriesStatus.Continuing; + } + else if (string.Equals(tvMazeShow.Status, "Ended", StringComparison.OrdinalIgnoreCase)) + { + series.Status = SeriesStatus.Ended; + } + + series.Overview = Helpers.StripHtml(tvMazeShow.Summary); + series.HomePageUrl = tvMazeShow.Url; + return result; + } + + /// + public Task GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url + }); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.TvMaze/TvMazePlugin.cs b/Jellyfin.Plugin.TvMaze/TvMazePlugin.cs new file mode 100644 index 0000000..255f424 --- /dev/null +++ b/Jellyfin.Plugin.TvMaze/TvMazePlugin.cs @@ -0,0 +1,46 @@ +using System; +using Jellyfin.Plugin.TvMaze.Configuration; +using MediaBrowser.Common.Configuration; +using MediaBrowser.Common.Plugins; +using MediaBrowser.Model.Serialization; + +namespace Jellyfin.Plugin.TvMaze +{ + /// + /// TvMaze Plugin. + /// + public class TvMazePlugin : BasePlugin + { + /// + /// Gets the provider name. + /// + public const string ProviderName = "TV Maze"; + + /// + /// Gets the provider id. + /// + public const string ProviderId = "TvMaze"; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + /// Instance of the interface. + public TvMazePlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) + : base(applicationPaths, xmlSerializer) + { + Instance = this; + } + + /// + /// Gets current plugin instance. + /// + public static TvMazePlugin? Instance { get; private set; } + + /// + public override string Name => ProviderName; + + /// + public override Guid Id => new Guid("A4A488D0-17A3-4919-8D82-7F3DE4F6B209"); + } +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c8daf8 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +

    Jellyfin TV Maze Plugin

    +

    Part of the Jellyfin Project

    + +

    +This plugin is built with .NET Core to download metadata for tv. +

    + +## Build Process + +1. Clone or download this repository + +2. Ensure you have .NET Core SDK setup and installed + +3. Build plugin with following command. + +```sh +dotnet publish --configuration Release --output bin +``` +4. Place the resulting file in the `plugins` folder under the program data directory or inside the portable install directory diff --git a/build.yaml b/build.yaml new file mode 100644 index 0000000..43d3cd3 --- /dev/null +++ b/build.yaml @@ -0,0 +1,15 @@ +--- +name: "TV Maze" +guid: "A4A488D0-17A3-4919-8D82-7F3DE4F6B209" +version: "1.0.0.0" +targetAbi: "10.6.0.0" +owner: "jellyfin" +overview: "Get TV metadata from TV Maze" +description: > + Get TV metadata from TV Maze +category: "Metadata" +artifacts: +- "Jellyfin.Plugin.TvMaze.dll" +- "TvMaze.Api.Client.dll" +changelog: > + Initial release. diff --git a/jellyfin.ruleset b/jellyfin.ruleset new file mode 100644 index 0000000..45ab725 --- /dev/null +++ b/jellyfin.ruleset @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +