commit d4debbbb180f4aa74af27e95325925ae3267dc6e Author: crobibero Date: Tue Sep 8 15:10:57 2020 -0600 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/.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.Simkl.sln b/Jellyfin.Plugin.Simkl.sln new file mode 100644 index 0000000..7e3ce7a --- /dev/null +++ b/Jellyfin.Plugin.Simkl.sln @@ -0,0 +1,16 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.Simkl", "Jellyfin.Plugin.Simkl\Jellyfin.Plugin.Simkl.csproj", "{2C1895EC-A7E1-48B6-A2E0-3E847D1FB748}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {2C1895EC-A7E1-48B6-A2E0-3E847D1FB748}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2C1895EC-A7E1-48B6-A2E0-3E847D1FB748}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2C1895EC-A7E1-48B6-A2E0-3E847D1FB748}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2C1895EC-A7E1-48B6-A2E0-3E847D1FB748}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/Jellyfin.Plugin.Simkl/API/Exceptions/InvalidTokenException.cs b/Jellyfin.Plugin.Simkl/API/Exceptions/InvalidTokenException.cs new file mode 100644 index 0000000..82a7aa5 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Exceptions/InvalidTokenException.cs @@ -0,0 +1,32 @@ +using System; + +namespace Jellyfin.Plugin.Simkl.API.Exceptions +{ + /// + public class InvalidTokenException : Exception + { + /// + /// Initializes a new instance of the class. + /// + public InvalidTokenException() + { + } + + /// + /// Initializes a new instance of the class. + /// + /// The message. + public InvalidTokenException(string msg) : base(msg) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// The message. + /// The inner exception. + public InvalidTokenException(string msg, Exception inner) : base(msg, inner) + { + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/GetPin.cs b/Jellyfin.Plugin.Simkl/API/GetPin.cs new file mode 100644 index 0000000..dfba395 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/GetPin.cs @@ -0,0 +1,14 @@ +using Jellyfin.Plugin.Simkl.API.Responses; +using MediaBrowser.Model.Services; + +namespace Jellyfin.Plugin.Simkl.API +{ + /// + /// Get oauth pin. + /// + [Route("/Simkl/oauth/pin", "GET")] + public class GetPin : IReturn + { + // Doesn't receive anything + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/GetPinStatus.cs b/Jellyfin.Plugin.Simkl/API/GetPinStatus.cs new file mode 100644 index 0000000..56e0199 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/GetPinStatus.cs @@ -0,0 +1,18 @@ +using Jellyfin.Plugin.Simkl.API.Responses; +using MediaBrowser.Model.Services; + +namespace Jellyfin.Plugin.Simkl.API +{ + /// + /// Get pin status. + /// + [Route("/Simkl/oauth/pin/{user_code}", "GET")] + public class GetPinStatus : IReturn + { + /// + /// Gets or sets user code. + /// + [ApiMember(Name = "user_code", Description = "pin to be introduced by the user", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] + public string UserCode { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/GetUserSettings.cs b/Jellyfin.Plugin.Simkl/API/GetUserSettings.cs new file mode 100644 index 0000000..167d05d --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/GetUserSettings.cs @@ -0,0 +1,22 @@ +using System; +using Jellyfin.Plugin.Simkl.API.Objects; +using MediaBrowser.Model.Services; + +namespace Jellyfin.Plugin.Simkl.API +{ + /// + /// Get user settings. + /// + [Route("/Simkl/users/settings/{userId}", "GET")] + public class GetUserSettings : IReturn + { + /// + /// Gets or sets user id. + /// + /// + /// Note: In the future, when we'll have config for more than one user, we'll use a parameter. + /// + [ApiMember(Name = "id", Description = "user id", IsRequired = true, DataType = "Guid", ParameterType = "path", Verb = "GET")] + public Guid UserId { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/Account.cs b/Jellyfin.Plugin.Simkl/API/Objects/Account.cs new file mode 100644 index 0000000..ee6502d --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/Account.cs @@ -0,0 +1,18 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Account. + /// + public class Account + { + /// + /// Gets or sets account id. + /// + public int Id { get; set; } + + /// + /// Gets or sets timezone. + /// + public string Timezone { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/Connections.cs b/Jellyfin.Plugin.Simkl/API/Objects/Connections.cs new file mode 100644 index 0000000..b111558 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/Connections.cs @@ -0,0 +1,13 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Connections. + /// + public class Connections + { + /// + /// Gets or sets a value indicating whether facebook. + /// + public bool Facebook { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/Season.cs b/Jellyfin.Plugin.Simkl/API/Objects/Season.cs new file mode 100644 index 0000000..cd52654 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/Season.cs @@ -0,0 +1,18 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Season. + /// + public class Season + { + /// + /// Gets or sets the season number. + /// + public int? Number { get; set; } + + /// + /// Gets or sets the episodes. + /// + public ShowEpisode[] Episodes { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/ShowEpisode.cs b/Jellyfin.Plugin.Simkl/API/Objects/ShowEpisode.cs new file mode 100644 index 0000000..5bb7879 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/ShowEpisode.cs @@ -0,0 +1,14 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Show episode. + /// + public class ShowEpisode + { + /// + /// Gets or sets episode number. + /// + public int? Number { get; set; } + // TODO: watched_at + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklEpisode.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklEpisode.cs new file mode 100644 index 0000000..2653551 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklEpisode.cs @@ -0,0 +1,41 @@ +using System.Text.Json.Serialization; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl episode container. + /// + public class SimklEpisode : SimklMediaObject + { + /// + /// Gets or sets watched at. + /// + [JsonPropertyName("watched_at")] + public string WatchedAt { get; set; } + + /// + /// Gets or sets ids. + /// + public override SimklIds Ids { get; set; } + + /// + /// Gets or sets the title. + /// + public string Title { get; set; } + + /// + /// Gets or sets the season. + /// + public int Season { get; set; } + + /// + /// Gets or sets the episode. + /// + public int Episode { get; set; } + + /// + /// Gets or sets multipart. + /// + public bool? Multipart { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklFile.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklFile.cs new file mode 100644 index 0000000..389e97d --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklFile.cs @@ -0,0 +1,23 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl File. + /// + public class SimklFile + { + /// + /// Gets or sets the file. + /// + public string File { get; set; } + + /// + /// Gets or sets the part. + /// + public int? Part { get; set; } + + /// + /// Gets or sets the hash. + /// + public string Hash { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklHistory.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklHistory.cs new file mode 100644 index 0000000..eebbc4e --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklHistory.cs @@ -0,0 +1,37 @@ +#pragma warning disable CA2227 + +using System.Collections.Generic; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl history container. + /// + public class SimklHistory + { + /// + /// Initializes a new instance of the class. + /// + public SimklHistory() + { + Movies = new List(); + Shows = new List(); + Episodes = new List(); + } + + /// + /// Gets or sets list of movies. + /// + public List Movies { get; set; } + + /// + /// Gets or sets the list of shows. + /// + public List Shows { get; set; } + + /// + /// Gets or sets the list of episodes. + /// + public List Episodes { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklIds.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklIds.cs new file mode 100644 index 0000000..e9b0e8b --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklIds.cs @@ -0,0 +1,57 @@ +using System.Collections.Generic; +using System.Globalization; +using System.Reflection; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl Ids. + /// + public class SimklIds + { + /// + /// Initializes a new instance of the class. + /// + /// The provider ids. + public SimklIds(Dictionary providerIds) + { + foreach (var (key, value) in providerIds) + { + var prop = GetType().GetProperty(key, BindingFlags.IgnoreCase); + if (prop.PropertyType == typeof(int?)) + { + prop.SetValue(this, int.Parse(value, NumberStyles.Any, CultureInfo.InvariantCulture)); + } + else if (prop.PropertyType == typeof(string)) + { + prop.SetValue(this, value); + } + } + } + + /// + /// Gets or sets simkl. + /// + public int? Simkl { get; set; } + + /// + /// Gets or sets the imdb id. + /// + public string Imdb { get; set; } + + /// + /// Gets or sets the slug. + /// + public string Slug { get; set; } + + /// + /// Gets or sets the netflix id. + /// + public string Netflix { get; set; } + + /// + /// Gets or sets the TMDb id. + /// + public string Tmdb { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklMediaObject.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklMediaObject.cs new file mode 100644 index 0000000..a7e3195 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklMediaObject.cs @@ -0,0 +1,13 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl media object. + /// + public abstract class SimklMediaObject + { + /// + /// Gets or sets ids. + /// + public abstract SimklIds Ids { get; set; } + } +} diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklMovie.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklMovie.cs new file mode 100644 index 0000000..d7fa1eb --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklMovie.cs @@ -0,0 +1,42 @@ +using System; +using System.Globalization; +using MediaBrowser.Model.Dto; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl movie. + /// + public class SimklMovie : SimklMediaObject + { + /// + /// Initializes a new instance of the class. + /// + /// The base item dto. + public SimklMovie(BaseItemDto item) + { + Title = item.OriginalTitle; + Year = item.ProductionYear; + Ids = new SimklMovieIds(item.ProviderIds); + WatchedAt = DateTime.UtcNow.ToString("yyyy-MM-dd HH\\:mm\\:ss", CultureInfo.InvariantCulture); + } + + /// + /// Gets or sets the movie title. + /// + public string Title { get; set; } + + /// + /// Gets or sets the year. + /// + public int? Year { get; set; } + + /// + public override SimklIds Ids { get; set; } + + /// + /// Gets watched at. + /// + public string WatchedAt { get; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklMovieIds.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklMovieIds.cs new file mode 100644 index 0000000..ed82bbe --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklMovieIds.cs @@ -0,0 +1,49 @@ +using System.Collections.Generic; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl movie ids. + /// + public class SimklMovieIds : SimklIds + { + /// + /// Initializes a new instance of the class. + /// + /// the provider movie ids. + public SimklMovieIds(Dictionary providerMovieIds) + : base(providerMovieIds) + { + } + + /// + /// Gets or sets the tvdb id. + /// + public int? Tvdb { get; set; } + + /// + /// Gets or sets the mal id. + /// + public int? Mal { get; set; } + + /// + /// Gets or sets the anidb id. + /// + public int? Anidb { get; set; } + + /// + /// Gets or sets the hulu id. + /// + public int? Hulu { get; set; } + + /// + /// Gets or sets the crunchyroll id. + /// + public int? Crunchyroll { get; set; } + + /// + /// Gets or sets the movie db id. + /// + public string Moviedb { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklShow.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklShow.cs new file mode 100644 index 0000000..ad8cb7a --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklShow.cs @@ -0,0 +1,55 @@ +using MediaBrowser.Model.Dto; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl show. + /// + public class SimklShow : SimklMediaObject + { + /// + /// Initializes a new instance of the class. + /// + /// The media info. + public SimklShow(BaseItemDto mediaInfo) + { + Title = mediaInfo.SeriesName; + Ids = new SimklShowIds(mediaInfo.ProviderIds); + Year = mediaInfo.ProductionYear; + Seasons = new Season[] + { + new Season + { + Number = mediaInfo.ParentIndexNumber, + Episodes = new[] + { + new ShowEpisode + { + Number = mediaInfo.IndexNumber + } + } + } + }; + } + + /// + /// Gets or sets title. + /// + public string Title { get; set; } + + /// + /// Gets or sets year. + /// + public int? Year { get; set; } + + /// + /// Gets or sets seasons. + /// + public Season[] Seasons { get; set; } + + /// + /// Gets or sets ids. + /// + public override SimklIds Ids { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/SimklShowIds.cs b/Jellyfin.Plugin.Simkl/API/Objects/SimklShowIds.cs new file mode 100644 index 0000000..31c6da3 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/SimklShowIds.cs @@ -0,0 +1,49 @@ +using System.Collections.Generic; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// Simkl show ids. + /// + public class SimklShowIds : SimklIds + { + /// + /// Initializes a new instance of the class. + /// + /// The provider movie ids. + public SimklShowIds(Dictionary providerMovieIds) + : base(providerMovieIds) + { + } + + /// + /// Gets or sets tvdb. + /// + public int? Tvdb { get; set; } + + /// + /// Gets or sets mal. + /// + public int? Mal { get; set; } + + /// + /// Gets or sets anidb. + /// + public int? Anidb { get; set; } + + /// + /// Gets or sets hulu. + /// + public int? Hulu { get; set; } + + /// + /// Gets or sets crunchyroll. + /// + public int? Crunchyroll { get; set; } + + /// + /// Gets or sets zap2it. + /// + public string Zap2It { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/User.cs b/Jellyfin.Plugin.Simkl/API/Objects/User.cs new file mode 100644 index 0000000..2c9e24e --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/User.cs @@ -0,0 +1,47 @@ +using System; +using System.Text.Json.Serialization; + +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// User. + /// + public class User + { + /// + /// Gets or sets name. + /// + public string Name { get; set; } + + /// + /// Gets or sets joined at. + /// + [JsonPropertyName("joined_at")] + public DateTime JoinedAt { get; set; } + + /// + /// Gets or sets gender. + /// + public string Gender { get; set; } + + /// + /// Gets or sets avatar. + /// + public string Avatar { get; set; } + + /// + /// Gets or sets bio. + /// + public string Bio { get; set; } + + /// + /// Gets or sets loc. + /// + public string Loc { get; set; } + + /// + /// Gets or sets age. + /// + public string Age { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Objects/UserSettings.cs b/Jellyfin.Plugin.Simkl/API/Objects/UserSettings.cs new file mode 100644 index 0000000..166a6d1 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Objects/UserSettings.cs @@ -0,0 +1,23 @@ +namespace Jellyfin.Plugin.Simkl.API.Objects +{ + /// + /// User settings. + /// + public class UserSettings + { + /// + /// Gets or sets user. + /// + public User User { get; set; } + + /// + /// Gets or sets account. + /// + public Account Account { get; set; } + + /// + /// Gets or sets error. + /// + public string Error { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Responses/CodeResponse.cs b/Jellyfin.Plugin.Simkl/API/Responses/CodeResponse.cs new file mode 100644 index 0000000..9bdc94a --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Responses/CodeResponse.cs @@ -0,0 +1,44 @@ +using System.Text.Json.Serialization; + +namespace Jellyfin.Plugin.Simkl.API.Responses +{ + /// + /// Code response. + /// + public class CodeResponse + { + /// + /// Gets or sets result. + /// + public string Result { get; set; } + + /// + /// Gets or sets device code. + /// + [JsonPropertyName("device_code")] + public string DeviceCode { get; set; } + + /// + /// Gets or sets user code. + /// + [JsonPropertyName("user_code")] + public string UserCode { get; set; } + + /// + /// Gets or sets verification url. + /// + [JsonPropertyName("verification_url")] + public string VerificationUrl { get; set; } + + /// + /// Gets or sets expires in. + /// + [JsonPropertyName("expires_in")] + public int ExpiresIn { get; set; } + + /// + /// Gets or sets interval. + /// + public int Interval { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Responses/CodeStatusResponse.cs b/Jellyfin.Plugin.Simkl/API/Responses/CodeStatusResponse.cs new file mode 100644 index 0000000..0b2ffc6 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Responses/CodeStatusResponse.cs @@ -0,0 +1,26 @@ +using System.Text.Json.Serialization; + +namespace Jellyfin.Plugin.Simkl.API.Responses +{ + /// + /// Code status response. + /// + public class CodeStatusResponse + { + /// + /// Gets or sets result. + /// + public string Result { get; set; } + + /// + /// Gets or sets message. + /// + public string Message { get; set; } + + /// + /// Gets or sets access token. + /// + [JsonPropertyName("access_token")] + public string AccessToken { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Responses/SearchFileResponse.cs b/Jellyfin.Plugin.Simkl/API/Responses/SearchFileResponse.cs new file mode 100644 index 0000000..90b0e0a --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Responses/SearchFileResponse.cs @@ -0,0 +1,30 @@ +using Jellyfin.Plugin.Simkl.API.Objects; + +namespace Jellyfin.Plugin.Simkl.API.Responses +{ + /// + /// Search file response. + /// + public class SearchFileResponse + { + /// + /// Gets or sets type. + /// + public string Type { get; set; } + + /// + /// Gets or sets episode. + /// + public SimklEpisode Episode { get; set; } + + /// + /// Gets or sets movie. + /// + public SimklMovie Movie { get; set; } + + /// + /// Gets or sets show. + /// + public SimklShow Show { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryNotFound.cs b/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryNotFound.cs new file mode 100644 index 0000000..f2fa868 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryNotFound.cs @@ -0,0 +1,25 @@ +using Jellyfin.Plugin.Simkl.API.Objects; + +namespace Jellyfin.Plugin.Simkl.API.Responses +{ + /// + /// sync history not found. + /// + public class SyncHistoryNotFound + { + /// + /// Gets or sets movies. + /// + public SimklMovie[] Movies { get; set; } + + /// + /// Gets or sets shows. + /// + public SimklShow[] Shows { get; set; } + + /// + /// Gets or sets episodes. + /// + public SimklEpisode[] Episodes { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryResponse.cs b/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryResponse.cs new file mode 100644 index 0000000..3a6ced2 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryResponse.cs @@ -0,0 +1,21 @@ +using System.Text.Json.Serialization; + +namespace Jellyfin.Plugin.Simkl.API.Responses +{ + /// + /// Sync history response. + /// + public class SyncHistoryResponse + { + /// + /// Gets or sets added. + /// + public SyncHistoryResponseCount Added { get; set; } + + /// + /// Gets or sets not found. + /// + [JsonPropertyName("not_found")] + public SyncHistoryNotFound NotFound { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryResponseCount.cs b/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryResponseCount.cs new file mode 100644 index 0000000..291433a --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/Responses/SyncHistoryResponseCount.cs @@ -0,0 +1,23 @@ +namespace Jellyfin.Plugin.Simkl.API.Responses +{ + /// + /// Sync history response count. + /// + public class SyncHistoryResponseCount + { + /// + /// Gets or sets movies. + /// + public int Movies { get; set; } + + /// + /// Gets or sets shows. + /// + public int Shows { get; set; } + + /// + /// Gets or sets episodes. + /// + public int Episodes { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/ServerEndpoint.cs b/Jellyfin.Plugin.Simkl/API/ServerEndpoint.cs new file mode 100644 index 0000000..1b4fef9 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/ServerEndpoint.cs @@ -0,0 +1,74 @@ +using Jellyfin.Plugin.Simkl.API.Objects; +using Jellyfin.Plugin.Simkl.API.Responses; +using MediaBrowser.Controller.Net; +using MediaBrowser.Model.Serialization; +using MediaBrowser.Model.Services; +using Microsoft.Extensions.Logging; +#pragma warning disable CA1801 + +namespace Jellyfin.Plugin.Simkl.API +{ + /// + /// Server endpoints. + /// + public class ServerEndpoint : IService, IHasResultFactory + { + private readonly SimklApi _api; + private readonly ILogger _logger; + private readonly IJsonSerializer _json; + + /// + /// Initializes a new instance of the class. + /// + /// The simkl api. + /// Instance of the interface. + /// Instance of the interface. + public ServerEndpoint(SimklApi api, ILogger logger, IJsonSerializer json) + { + _api = api; + _logger = logger; + _json = json; + } + + /// + /// Gets or sets result factory. + /// + public IHttpResultFactory ResultFactory { get; set; } + + /// + /// Gets or sets request. + /// + public IRequest Request { get; set; } + + /// + /// Get pin request. + /// + /// The request. + /// The code response. + public CodeResponse Get(GetPin request) + { + return _api.GetCode().GetAwaiter().GetResult(); + } + + /// + /// Get pin status. + /// + /// The request. + /// Code status response. + public CodeStatusResponse Get(GetPinStatus request) + { + return _api.GetCodeStatus(request.UserCode).GetAwaiter().GetResult(); + } + + /// + /// Get user settings. + /// + /// The request. + /// User settings. + public UserSettings Get(GetUserSettings request) + { + _logger.LogDebug(_json.SerializeToString(request)); + return _api.GetUserSettings(SimklPlugin.Instance.Configuration.GetByGuid(request.UserId).UserToken).Result; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/API/SimklApi.cs b/Jellyfin.Plugin.Simkl/API/SimklApi.cs new file mode 100644 index 0000000..74710ab --- /dev/null +++ b/Jellyfin.Plugin.Simkl/API/SimklApi.cs @@ -0,0 +1,280 @@ +using System.IO; +using System.Threading.Tasks; +using Jellyfin.Plugin.Simkl.API.Exceptions; +using Jellyfin.Plugin.Simkl.API.Objects; +using Jellyfin.Plugin.Simkl.API.Responses; +using MediaBrowser.Common.Net; +using MediaBrowser.Model.Dto; +using MediaBrowser.Model.Serialization; +using Microsoft.Extensions.Logging; // using System.Threading; + +namespace Jellyfin.Plugin.Simkl.API +{ + /// + /// Simkl Api. + /// + public class SimklApi + { + /* INTERFACES */ + private readonly IJsonSerializer _json; + private readonly ILogger _logger; + private readonly IHttpClient _httpClient; + + /* BASIC API THINGS */ + + /// + /// Base url. + /// + public const string Baseurl = @"https://api.simkl.com"; + // public const string BASE_URL = @"http://private-9c39b-simkl.apiary-proxy.com"; + + /// + /// Redirect uri. + /// + public const string RedirectUri = @"https://simkl.com/apps/emby/connected/"; + + /// + /// Api key. + /// + public const string Apikey = @"27dd5d6adc24aa1ad9f95ef913244cbaf6df5696036af577ed41670473dc97d0"; + + /// + /// Secret. + /// + public const string Secret = @"d7b9feb9d48bbaa69dbabaca21ba4671acaa89198637e9e136a4d69ec97ab68b"; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + /// Instance of the interface. + /// Instance of the interface. + public SimklApi(IJsonSerializer json, ILogger logger, IHttpClient httpClient) + { + _json = json; + _logger = logger; + _httpClient = httpClient; + } + + /// + /// Get code. + /// + /// Code response. + public async Task GetCode() + { + var uri = $"/oauth/pin?client_id={Apikey}&redirect={RedirectUri}"; + return _json.DeserializeFromStream(await Get(uri).ConfigureAwait(false)); + } + + /// + /// Get code status. + /// + /// User code. + /// Code status. + public async Task GetCodeStatus(string userCode) + { + var uri = $"/oauth/pin/{userCode}?client_id={Apikey}"; + return _json.DeserializeFromStream(await Get(uri).ConfigureAwait(false)); + } + + /// + /// Get user settings. + /// + /// User token. + /// User settings. + public async Task GetUserSettings(string userToken) + { + try + { + return _json.DeserializeFromStream(await Post("/users/settings/", userToken).ConfigureAwait(false)); + } + catch (MediaBrowser.Model.Net.HttpException e) when (e.StatusCode == System.Net.HttpStatusCode.Unauthorized) + { + // Wontfix: Custom status codes + // "You don't get to pick your response code" - Luke (System Architect of Emby) + // https://emby.media/community/index.php?/topic/61889-wiki-issue-resultfactorythrowerror/ + return new UserSettings { Error = "user_token_failed" }; + } + } + + /// + /// Mark as watched. + /// + /// Item. + /// User token. + /// Status. + public async Task<(bool success, BaseItemDto item)> MarkAsWatched(BaseItemDto item, string userToken) + { + var history = CreateHistoryFromItem(item); + var r = await SyncHistoryAsync(history, userToken).ConfigureAwait(false); + _logger.LogDebug("Response: " + _json.SerializeToString(r)); + if (history.Movies.Count == r.Added.Movies && history.Shows.Count == r.Added.Shows) + { + return (true, item); + } + + // If we are here, is because the item has not been found + // let's try scrobbling from full path + try + { + (history, item) = await GetHistoryFromFileName(item).ConfigureAwait(false); + } + catch (InvalidDataException) + { + // Let's try again but this time using only the FILE name + _logger.LogDebug("Couldn't scrobble using full path, trying using only filename"); + (history, item) = await GetHistoryFromFileName(item, false).ConfigureAwait(false); + } + + r = await SyncHistoryAsync(history, userToken).ConfigureAwait(false); + _logger.LogDebug("Response: " + _json.SerializeToString(r)); + + return (history.Movies.Count == r.Added.Movies && history.Shows.Count == r.Added.Shows, item); + } + + /// + /// Get from file. + /// + /// Filename. + /// Search file response. + private async Task GetFromFile(string filename) + { + var f = new SimklFile { File = filename }; + _logger.LogInformation("Posting: " + _json.SerializeToString(f)); + using var r = new StreamReader(await Post("/search/file/", null, f).ConfigureAwait(false)); + var t = r.ReadToEnd(); + _logger.LogDebug("Response: " + t); + return _json.DeserializeFromString(t); + } + + /// + /// Get history from file name. + /// + /// Item. + /// Full path. + /// Srobble history. + private async Task<(SimklHistory history, BaseItemDto item)> GetHistoryFromFileName(BaseItemDto item, bool fullpath = true) + { + var fname = fullpath ? item.Path : Path.GetFileName(item.Path); + var mo = await GetFromFile(fname).ConfigureAwait(false); + + var history = new SimklHistory(); + if (item.IsMovie == true || item.Type == "Movie") + { + if (mo.Type != "movie") + { + throw new InvalidDataException("type != movie (" + mo.Type + ")"); + } + + item.Name = mo.Movie.Title; + item.ProductionYear = mo.Movie.Year; + history.Movies.Add(mo.Movie); + } + else if (item.IsSeries == true || item.Type == "Episode") + { + if (mo.Type != "episode") + { + throw new InvalidDataException("type != episode (" + mo.Type + ")"); + } + + item.Name = mo.Episode.Title; + item.SeriesName = mo.Show.Title; + item.IndexNumber = mo.Episode.Episode; + item.ParentIndexNumber = mo.Episode.Season; + item.ProductionYear = mo.Show.Year; + history.Episodes.Add(mo.Episode); + } + + return (history, item); + } + + private static HttpRequestOptions GetOptions(string userToken = null) + { + var options = new HttpRequestOptions + { + RequestContentType = "application/json", + LogErrorResponseBody = true, + EnableDefaultUserAgent = true + }; + options.RequestHeaders.Add("simkl-api-key", Apikey); + // options.RequestHeaders.Add("Content-Type", "application/json"); + if (!string.IsNullOrEmpty(userToken)) + { + options.RequestHeaders.Add("Authorization", "Bearer " + userToken); + } + + return options; + } + + private static SimklHistory CreateHistoryFromItem(BaseItemDto item) + { + var history = new SimklHistory(); + + if (item.IsMovie == true || item.Type == "Movie") + { + history.Movies.Add(new SimklMovie(item)); + } + else if (item.IsSeries == true || item.Type == "Episode") + { + // TODO: TV Shows scrobbling (WIP) + history.Shows.Add(new SimklShow(item)); + } + + return history; + } + + /// + /// Implements /sync/history method from simkl. + /// + /// History object. + /// User token. + /// The sync history response. + private async Task SyncHistoryAsync(SimklHistory history, string userToken) + { + try + { + _logger.LogInformation("Syncing History: " + _json.SerializeToString(history)); + return _json.DeserializeFromStream(await Post("/sync/history", userToken, history).ConfigureAwait(false)); + } + catch (MediaBrowser.Model.Net.HttpException e) when (e.StatusCode == System.Net.HttpStatusCode.Unauthorized) + { + _logger.LogError("Invalid user token " + userToken + ", deleting"); + SimklPlugin.Instance.Configuration.DeleteUserToken(userToken); + throw new InvalidTokenException("Invalid user token " + userToken); + } + } + + /// + /// API's private get method, given RELATIVE url and headers. + /// + /// Relative url. + /// Authentication token. + /// HTTP(s) Stream to be used. + private async Task Get(string url, string userToken = null) + { + // Todo: If string is not null neither empty + var options = GetOptions(userToken); + options.Url = Baseurl + url; + + return await _httpClient.Get(options).ConfigureAwait(false); + } + + /// + /// API's private post method. + /// + /// Relative post url. + /// Authentication token. + /// Object to serialize. + private async Task Post(string url, string userToken = null, object data = null) + { + var options = GetOptions(userToken); + options.Url = Baseurl + url; + if (data != null) + { + options.RequestContent = _json.SerializeToString(data); + } + + return (await _httpClient.Post(options).ConfigureAwait(false)).Content; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/Configuration/PluginConfiguration.cs b/Jellyfin.Plugin.Simkl/Configuration/PluginConfiguration.cs new file mode 100644 index 0000000..9a6d262 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/Configuration/PluginConfiguration.cs @@ -0,0 +1,52 @@ +using System; +using System.Linq; +using MediaBrowser.Model.Plugins; + +namespace Jellyfin.Plugin.Simkl.Configuration +{ + /// + /// Class needed to create a Plugin and configure it. + /// + public class PluginConfiguration : BasePluginConfiguration + { + /// + /// Initializes a new instance of the class. + /// + public PluginConfiguration() + { + UserConfigs = Array.Empty(); + } + + /// + /// Gets or sets the list of user configs. + /// + public UserConfig[] UserConfigs { get; set; } + + /// + /// Get config by id. + /// + /// The user id. + /// Stored user config. + public UserConfig GetByGuid(Guid id) + { + return UserConfigs.FirstOrDefault(c => c.Id == id); + } + + /// + /// Delete user token. + /// + /// User token. + public void DeleteUserToken(string userToken) + { + foreach (var config in UserConfigs) + { + if (config.UserToken == userToken) + { + config.UserToken = string.Empty; + } + } + + SimklPlugin.Instance.SaveConfiguration(); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/Configuration/UserConfig.cs b/Jellyfin.Plugin.Simkl/Configuration/UserConfig.cs new file mode 100644 index 0000000..24ce4b6 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/Configuration/UserConfig.cs @@ -0,0 +1,70 @@ +using System; + +namespace Jellyfin.Plugin.Simkl.Configuration +{ + /// + /// User config. + /// + public class UserConfig + { + /// + /// Initializes a new instance of the class. + /// + public UserConfig() + { + ScrobbleMovies = true; + ScrobbleShows = true; + ScrobblePercentage = 70; + ScrobbleNowWatchingPercentage = 5; + MinLength = 5; + UserToken = string.Empty; // Todo: check if token is still valid + ScrobbleTimeout = 30; + } + + /// + /// Gets or sets a value indicating whether scrobble movies. + /// + public bool ScrobbleMovies { get; set; } + + /// + /// Gets or sets a value indicating whether scrobble shows. + /// + public bool ScrobbleShows { get; set; } + + /// + /// Gets or sets scrobble percentage. + /// + public int ScrobblePercentage { get; set; } + + /// + /// Gets or sets scrobble now watching percentage. + /// + public int ScrobbleNowWatchingPercentage { get; set; } + + /// + /// Gets or sets min length. + /// + /// + /// Minimum length for scrobbling (in minutes). + /// + public int MinLength { get; set; } + + /// + /// Gets or sets user token. + /// + public string UserToken { get; set; } // Is the user logged in + + /// + /// Gets or sets scrobble timeout. + /// + /// + /// Time between scrobbling tries. + /// + public int ScrobbleTimeout { get; set; } + + /// + /// Gets or sets user id. + /// + public Guid Id { get; set; } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/Configuration/configPage.html b/Jellyfin.Plugin.Simkl/Configuration/configPage.html new file mode 100644 index 0000000..de8e2e9 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/Configuration/configPage.html @@ -0,0 +1,260 @@ + + + + Simkl's TV Tracker + + +
+
+
+

Simkl's TV Tracker

+
+
+ +
+ + + +
+
+
+ +
+ + \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/Jellyfin.Plugin.Simkl.csproj b/Jellyfin.Plugin.Simkl/Jellyfin.Plugin.Simkl.csproj new file mode 100644 index 0000000..3ad2262 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/Jellyfin.Plugin.Simkl.csproj @@ -0,0 +1,32 @@ + + + + netstandard2.1 + 1.0.0.0 + 1.0.0.0 + true + true + CA1707;CA1819 + + + + + + + + + + + + + + + + + + + + ../jellyfin.ruleset + + + diff --git a/Jellyfin.Plugin.Simkl/Services/Scrobbler.cs b/Jellyfin.Plugin.Simkl/Services/Scrobbler.cs new file mode 100644 index 0000000..32b3c10 --- /dev/null +++ b/Jellyfin.Plugin.Simkl/Services/Scrobbler.cs @@ -0,0 +1,206 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Jellyfin.Plugin.Simkl.API; +using Jellyfin.Plugin.Simkl.API.Exceptions; +using Jellyfin.Plugin.Simkl.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities.Movies; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Notifications; +using MediaBrowser.Controller.Plugins; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.Dto; +using MediaBrowser.Model.Serialization; +using Microsoft.Extensions.Logging; + +namespace Jellyfin.Plugin.Simkl.Services +{ + /// + public class Scrobbler : IServerEntryPoint + { + private readonly ISessionManager _sessionManager; // Needed to set up de startPlayBack and endPlayBack functions + private readonly ILogger _logger; + private readonly IJsonSerializer _json; + private readonly INotificationManager _notifications; + private readonly Dictionary _lastScrobbled; // Library ID of last scrobbled item + private SimklApi _api; + private DateTime _nextTry; + + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + /// Instance of the interface. + /// Instance of the interface. + /// Instance of the interface. + /// Instance of the interface. + public Scrobbler( + IJsonSerializer json, + ISessionManager sessionManager, + ILoggerFactory loggerFactory, + IHttpClient httpClient, + INotificationManager notifications) + { + _json = json; + _sessionManager = sessionManager; + _logger = loggerFactory.CreateLogger(); + _notifications = notifications; + _api = new SimklApi(json, loggerFactory.CreateLogger(), httpClient); + _lastScrobbled = new Dictionary(); + _nextTry = DateTime.UtcNow; + } + + /// + public Task RunAsync() + { + _sessionManager.PlaybackProgress += OnPlaybackProgress; + return Task.CompletedTask; + } + + /// + public void Dispose() + { + Dispose(true); + GC.SuppressFinalize(this); + } + + /// + /// Dispose. + /// + /// Dispose all resources. + protected virtual void Dispose(bool disposing) + { + if (disposing) + { + _sessionManager.PlaybackProgress -= OnPlaybackProgress; + _api = null; + } + } + + /// + /// Session can be scrobbled. + /// + /// The plugin configuration. + /// The session. + /// If session can be scrobbled. + private static bool CanBeScrobbled(UserConfig config, SessionInfo session) + { + if (session.NowPlayingItem.RunTimeTicks != null) + { + var percentageWatched = session.PlayState.PositionTicks / (float)session.NowPlayingItem.RunTimeTicks * 100f; + + // If percentage watched is below minimum, can't scrobble + if (percentageWatched < config.ScrobblePercentage) + { + return false; + } + } + + // If it's below minimum length, can't scrobble + if (session.NowPlayingItem.RunTimeTicks < 60 * 10000 * config.MinLength) + { + return false; + } + + var item = session.FullNowPlayingItem; + return item switch + { + Movie _ => config.ScrobbleMovies, + Episode _ => config.ScrobbleShows, + _ => false + }; + } + + private bool CanSendNotification(BaseItemDto item) + { + if (item.IsMovie == true || item.Type == "Movie") + { + return _notifications.GetNotificationTypes().Any(t => t.Type == SimklNotificationsFactory.NotificationMovieType && t.Enabled); + } + + if (item.IsSeries == true || item.Type == "Episode") + { + return _notifications.GetNotificationTypes().Any(t => t.Type == SimklNotificationsFactory.NotificationShowType && t.Enabled); + } + + return false; + } + + private async void OnPlaybackProgress(object sessions, PlaybackProgressEventArgs e) + { + var sid = e.PlaySessionId; + Guid uid = e.Session.UserId, npid = e.Session.NowPlayingItem.Id; + try + { + if (DateTime.UtcNow < _nextTry) + { + return; + } + + _nextTry = DateTime.UtcNow.AddSeconds(30); + + var userConfig = SimklPlugin.Instance.Configuration.GetByGuid(uid); + if (userConfig == null || string.IsNullOrEmpty(userConfig.UserToken)) + { + _logger.LogError("Can't scrobble: User " + e.Session.UserName + " not logged in (" + (userConfig == null) + ")"); + return; + } + + if (!CanBeScrobbled(userConfig, e.Session)) + { + return; + } + + if (_lastScrobbled.ContainsKey(sid) && _lastScrobbled[sid] == npid) + { + _logger.LogDebug("Already scrobbled {0} for {1}", e.Session.NowPlayingItem.Name, e.Session.UserName); + return; + } + + _logger.LogDebug(_json.SerializeToString(e.Session.NowPlayingItem)); + _logger.LogInformation( + "Trying to scrobble {0} ({1}) for {2} ({3}) - {4} on {5}", + e.Session.NowPlayingItem.Name, + npid, + e.Session.UserName, + uid, + e.Session.NowPlayingItem.Path, + sid); + + var response = await _api.MarkAsWatched(e.MediaInfo, userConfig.UserToken).ConfigureAwait(false); + if (response.success) + { + _logger.LogDebug("Scrobbled without errors"); + _lastScrobbled[sid] = npid; + + if (CanSendNotification(response.item)) + { + await _notifications.SendNotification( + SimklNotificationsFactory.GetNotificationRequest(response.item, e.Session.UserId), + e.Session.FullNowPlayingItem, + CancellationToken.None) + .ConfigureAwait(false); + } + } + } + catch (InvalidTokenException) + { + _logger.LogDebug("Deleted user token"); + } + catch (InvalidDataException ex) + { + _logger.LogError(ex, "Couldn't scrobble."); + _lastScrobbled[sid] = npid; + } + catch (Exception ex) + { + _logger.LogError(ex, "Caught unknown exception while trying to scrobble."); + } + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/Services/SimklNotificationsFactory.cs b/Jellyfin.Plugin.Simkl/Services/SimklNotificationsFactory.cs new file mode 100644 index 0000000..b7eae2d --- /dev/null +++ b/Jellyfin.Plugin.Simkl/Services/SimklNotificationsFactory.cs @@ -0,0 +1,86 @@ +using System; +using System.Collections.Generic; +using MediaBrowser.Controller.Notifications; +using MediaBrowser.Model.Dto; +using MediaBrowser.Model.Notifications; + +namespace Jellyfin.Plugin.Simkl.Services +{ + /// + public class SimklNotificationsFactory : INotificationTypeFactory + { + /// + /// Notification category. + /// + public const string NotificationCategory = "Simkl Scrobbling"; + + /// + /// Notification movie type. + /// + public const string NotificationMovieType = "SimklScrobblingMovie"; + + /// + /// Notification show type. + /// + public const string NotificationShowType = "SimklScrobblingShow"; + + /// + public IEnumerable GetNotificationTypes() + { + yield return new NotificationTypeInfo + { + Type = NotificationMovieType, + Name = "Scrobbling Movie", + Category = NotificationCategory, + Enabled = true, + IsBasedOnUserEvent = false + }; + + yield return new NotificationTypeInfo + { + Type = NotificationShowType, + Name = "Scrobbling TV Show", + Category = NotificationCategory, + Enabled = true, + IsBasedOnUserEvent = false + }; + } + + /// + /// Get notification request. + /// + /// Item. + /// USer id. + /// The notification request. + public static NotificationRequest GetNotificationRequest(BaseItemDto item, Guid userId) + { + var nr = new NotificationRequest + { + Date = DateTime.UtcNow, + UserIds = new[] { userId }, + SendToUserMode = SendToUserType.Custom + }; + + // TODO: Set url parameter to simkl's movie url + if (item.IsMovie == true || item.Type == "Movie") + { + nr.NotificationType = NotificationMovieType; + nr.Name = "Movie Scrobbled to Simkl"; + nr.Description = "The movie " + item.Name; + nr.Description += " has been scrobbled to your account"; + } + + if (item.IsSeries == true || item.Type == "Episode") + { + nr.NotificationType = NotificationShowType; + nr.Name = "Episode Scrobbled to Simkl"; + nr.Description = item.SeriesName; + nr.Description += " S" + item.ParentIndexNumber + ":E" + item.IndexNumber; + nr.Description += " - " + item.Name; + nr.Description += " has been scrobbled to your account"; + } + + return nr; + } + } +} \ No newline at end of file diff --git a/Jellyfin.Plugin.Simkl/SimklPlugin.cs b/Jellyfin.Plugin.Simkl/SimklPlugin.cs new file mode 100644 index 0000000..254e4db --- /dev/null +++ b/Jellyfin.Plugin.Simkl/SimklPlugin.cs @@ -0,0 +1,51 @@ +using System; +using System.Collections.Generic; +using Jellyfin.Plugin.Simkl.Configuration; +using MediaBrowser.Common.Configuration; +using MediaBrowser.Common.Plugins; +using MediaBrowser.Model.Plugins; +using MediaBrowser.Model.Serialization; + +namespace Jellyfin.Plugin.Simkl +{ + /// + /// SIMKL tracker. + /// + public class SimklPlugin : BasePlugin, IHasWebPages + { + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + /// Instance of the interface. + public SimklPlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) + : base(applicationPaths, xmlSerializer) + { + Instance = this; + } + + /// + /// Gets the current instance of the plugin. + /// + public static SimklPlugin Instance { get; private set; } + + /// + public override Guid Id => new Guid("07CAEF58-A94B-4211-A62C-F9774E04EBDB"); + + /// + public override string Name => "Simkl TV Tracker"; + + /// + public override string Description => "Scrobble your watched Movies, TV Shows and Anime to Simkl and share your progress with friends!"; + + /// + public IEnumerable GetPages() + { + yield return new PluginPageInfo + { + Name = Name, + EmbeddedResourcePath = GetType().Namespace + ".Configuration.configPage.html" + }; + } + } +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /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..4865a74 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +

Jellyfin SIMKL Plugin

+

Part of the Jellyfin Project

+ +### +Repository Url: +https://repo.codyrobibero.dev/manifest.json + +## How to enable notifications when something is marked as watched +1. On Jellyfin's dashboard, you'll have to go to the bottom and, on expert options, select "Notifications" +2. There, on section "Simkl Scrobbling", enable both notifications + +## How to enable debugging +To report a bug or an error, we'll need more info to know how to fix it. To send us the needed reports you'll need to +first enable debug logging. + +1. On Jellyfin's dashboard, scroll to the bottom and, on expert options, select "Logs" (right above "Notifications") +2. Click on "Enable debug logging" +3. Restart the server and reproduce the error + +Now you can contact us to try and fix the problem + +## Current features +- Multi-user support +- Auto scrobble Movies and TV Shows at given percentage to Simkl +- Easy login using pin (no more putting passwords with the TV remote) +- If scrobbling fails, search it using filename using Simkl's API and then scrobble it +- Send notifications about scrobbling + +Modified for Jellyfin from https://github.com/SIMKL/Emby/ \ No newline at end of file diff --git a/jellyfin.ruleset b/jellyfin.ruleset new file mode 100644 index 0000000..45ab725 --- /dev/null +++ b/jellyfin.ruleset @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +