├── .gitattributes ├── .gitignore ├── Jellyfin.Plugin.SmartPlaylist.sln ├── Jellyfin.Plugin.SmartPlaylist ├── Jellyfin.Plugin.SmartPlaylist.csproj ├── Plugin.cs ├── Properties │ └── launchSettings.json ├── QueryEngine │ ├── Engine.cs │ ├── Expression.cs │ ├── Factory.cs │ └── Operand.cs ├── ScheduleTasks │ └── RefreshAllPlaylists.cs ├── SmartPlaylist.cs ├── SmartPlaylistDto.cs ├── SmartPlaylistFileSystem.cs └── SmartPlaylistStore.cs ├── LICENSE ├── README.md └── Tests ├── SmartPlaylistTest.cs └── Tests.csproj /.gitattributes: -------------------------------------------------------------------------------- 1 | ############################################################################### 2 | # Set default behavior to automatically normalize line endings. 3 | ############################################################################### 4 | * text=auto 5 | 6 | ############################################################################### 7 | # Set default behavior for command prompt diff. 8 | # 9 | # This is need for earlier builds of msysgit that does not have it on by 10 | # default for csharp files. 11 | # Note: This is only used by command line 12 | ############################################################################### 13 | #*.cs diff=csharp 14 | 15 | ############################################################################### 16 | # Set the merge driver for project and solution files 17 | # 18 | # Merging from the command prompt will add diff markers to the files if there 19 | # are conflicts (Merging from VS is not affected by the settings below, in VS 20 | # the diff markers are never inserted). Diff markers may cause the following 21 | # file extensions to fail to load in VS. An alternative would be to treat 22 | # these files as binary and thus will always conflict and require user 23 | # intervention with every merge. To do so, just uncomment the entries below 24 | ############################################################################### 25 | #*.sln merge=binary 26 | #*.csproj merge=binary 27 | #*.vbproj merge=binary 28 | #*.vcxproj merge=binary 29 | #*.vcproj merge=binary 30 | #*.dbproj merge=binary 31 | #*.fsproj merge=binary 32 | #*.lsproj merge=binary 33 | #*.wixproj merge=binary 34 | #*.modelproj merge=binary 35 | #*.sqlproj merge=binary 36 | #*.wwaproj merge=binary 37 | 38 | ############################################################################### 39 | # behavior for image files 40 | # 41 | # image files are treated as binary by default. 42 | ############################################################################### 43 | #*.jpg binary 44 | #*.png binary 45 | #*.gif binary 46 | 47 | ############################################################################### 48 | # diff behavior for common document formats 49 | # 50 | # Convert binary document formats to text before diffing them. This feature 51 | # is only available from the command line. Turn it on by uncommenting the 52 | # entries below. 53 | ############################################################################### 54 | #*.doc diff=astextplain 55 | #*.DOC diff=astextplain 56 | #*.docx diff=astextplain 57 | #*.DOCX diff=astextplain 58 | #*.dot diff=astextplain 59 | #*.DOT diff=astextplain 60 | #*.pdf diff=astextplain 61 | #*.PDF diff=astextplain 62 | #*.rtf diff=astextplain 63 | #*.RTF diff=astextplain 64 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Build results 17 | [Dd]ebug/ 18 | [Dd]ebugPublic/ 19 | [Rr]elease/ 20 | [Rr]eleases/ 21 | x64/ 22 | x86/ 23 | [Aa][Rr][Mm]/ 24 | [Aa][Rr][Mm]64/ 25 | bld/ 26 | [Bb]in/ 27 | [Oo]bj/ 28 | [Ll]og/ 29 | 30 | # Visual Studio 2015/2017 cache/options directory 31 | .vs/ 32 | # Uncomment if you have tasks that create the project's static files in wwwroot 33 | #wwwroot/ 34 | 35 | # Visual Studio 2017 auto generated files 36 | Generated\ Files/ 37 | 38 | # MSTest test Results 39 | [Tt]est[Rr]esult*/ 40 | [Bb]uild[Ll]og.* 41 | 42 | # NUNIT 43 | *.VisualState.xml 44 | TestResult.xml 45 | 46 | # Build Results of an ATL Project 47 | [Dd]ebugPS/ 48 | [Rr]eleasePS/ 49 | dlldata.c 50 | 51 | # Benchmark Results 52 | BenchmarkDotNet.Artifacts/ 53 | 54 | # .NET Core 55 | project.lock.json 56 | project.fragment.lock.json 57 | artifacts/ 58 | 59 | # StyleCop 60 | StyleCopReport.xml 61 | 62 | # Files built by Visual Studio 63 | *_i.c 64 | *_p.c 65 | *_h.h 66 | *.ilk 67 | *.meta 68 | *.obj 69 | *.iobj 70 | *.pch 71 | *.pdb 72 | *.ipdb 73 | *.pgc 74 | *.pgd 75 | *.rsp 76 | *.sbr 77 | *.tlb 78 | *.tli 79 | *.tlh 80 | *.tmp 81 | *.tmp_proj 82 | *_wpftmp.csproj 83 | *.log 84 | *.vspscc 85 | *.vssscc 86 | .builds 87 | *.pidb 88 | *.svclog 89 | *.scc 90 | 91 | # Chutzpah Test files 92 | _Chutzpah* 93 | 94 | # Visual C++ cache files 95 | ipch/ 96 | *.aps 97 | *.ncb 98 | *.opendb 99 | *.opensdf 100 | *.sdf 101 | *.cachefile 102 | *.VC.db 103 | *.VC.VC.opendb 104 | 105 | # Visual Studio profiler 106 | *.psess 107 | *.vsp 108 | *.vspx 109 | *.sap 110 | 111 | # Visual Studio Trace Files 112 | *.e2e 113 | 114 | # TFS 2012 Local Workspace 115 | $tf/ 116 | 117 | # Guidance Automation Toolkit 118 | *.gpState 119 | 120 | # ReSharper is a .NET coding add-in 121 | _ReSharper*/ 122 | *.[Rr]e[Ss]harper 123 | *.DotSettings.user 124 | 125 | # JustCode is a .NET coding add-in 126 | .JustCode 127 | 128 | # TeamCity is a build add-in 129 | _TeamCity* 130 | 131 | # DotCover is a Code Coverage Tool 132 | *.dotCover 133 | 134 | # AxoCover is a Code Coverage Tool 135 | .axoCover/* 136 | !.axoCover/settings.json 137 | 138 | # Visual Studio code coverage results 139 | *.coverage 140 | *.coveragexml 141 | 142 | # NCrunch 143 | _NCrunch_* 144 | .*crunch*.local.xml 145 | nCrunchTemp_* 146 | 147 | # MightyMoose 148 | *.mm.* 149 | AutoTest.Net/ 150 | 151 | # Web workbench (sass) 152 | .sass-cache/ 153 | 154 | # Installshield output folder 155 | [Ee]xpress/ 156 | 157 | # DocProject is a documentation generator add-in 158 | DocProject/buildhelp/ 159 | DocProject/Help/*.HxT 160 | DocProject/Help/*.HxC 161 | DocProject/Help/*.hhc 162 | DocProject/Help/*.hhk 163 | DocProject/Help/*.hhp 164 | DocProject/Help/Html2 165 | DocProject/Help/html 166 | 167 | # Click-Once directory 168 | publish/ 169 | 170 | # Publish Web Output 171 | *.[Pp]ublish.xml 172 | *.azurePubxml 173 | # Note: Comment the next line if you want to checkin your web deploy settings, 174 | # but database connection strings (with potential passwords) will be unencrypted 175 | *.pubxml 176 | *.publishproj 177 | 178 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 179 | # checkin your Azure Web App publish settings, but sensitive information contained 180 | # in these scripts will be unencrypted 181 | PublishScripts/ 182 | 183 | # NuGet Packages 184 | *.nupkg 185 | # The packages folder can be ignored because of Package Restore 186 | **/[Pp]ackages/* 187 | # except build/, which is used as an MSBuild target. 188 | !**/[Pp]ackages/build/ 189 | # Uncomment if necessary however generally it will be regenerated when needed 190 | #!**/[Pp]ackages/repositories.config 191 | # NuGet v3's project.json files produces more ignorable files 192 | *.nuget.props 193 | *.nuget.targets 194 | 195 | # Microsoft Azure Build Output 196 | csx/ 197 | *.build.csdef 198 | 199 | # Microsoft Azure Emulator 200 | ecf/ 201 | rcf/ 202 | 203 | # Windows Store app package directories and files 204 | AppPackages/ 205 | BundleArtifacts/ 206 | Package.StoreAssociation.xml 207 | _pkginfo.txt 208 | *.appx 209 | 210 | # Visual Studio cache files 211 | # files ending in .cache can be ignored 212 | *.[Cc]ache 213 | # but keep track of directories ending in .cache 214 | !?*.[Cc]ache/ 215 | 216 | # Others 217 | ClientBin/ 218 | ~$* 219 | *~ 220 | *.dbmdl 221 | *.dbproj.schemaview 222 | *.jfm 223 | *.pfx 224 | *.publishsettings 225 | orleans.codegen.cs 226 | 227 | # Including strong name files can present a security risk 228 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 229 | #*.snk 230 | 231 | # Since there are multiple workflows, uncomment next line to ignore bower_components 232 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 233 | #bower_components/ 234 | 235 | # RIA/Silverlight projects 236 | Generated_Code/ 237 | 238 | # Backup & report files from converting an old project file 239 | # to a newer Visual Studio version. Backup files are not needed, 240 | # because we have git ;-) 241 | _UpgradeReport_Files/ 242 | Backup*/ 243 | UpgradeLog*.XML 244 | UpgradeLog*.htm 245 | ServiceFabricBackup/ 246 | *.rptproj.bak 247 | 248 | # SQL Server files 249 | *.mdf 250 | *.ldf 251 | *.ndf 252 | 253 | # Business Intelligence projects 254 | *.rdl.data 255 | *.bim.layout 256 | *.bim_*.settings 257 | *.rptproj.rsuser 258 | *- Backup*.rdl 259 | 260 | # Microsoft Fakes 261 | FakesAssemblies/ 262 | 263 | # GhostDoc plugin setting file 264 | *.GhostDoc.xml 265 | 266 | # Node.js Tools for Visual Studio 267 | .ntvs_analysis.dat 268 | node_modules/ 269 | 270 | # Visual Studio 6 build log 271 | *.plg 272 | 273 | # Visual Studio 6 workspace options file 274 | *.opt 275 | 276 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 277 | *.vbw 278 | 279 | # Visual Studio LightSwitch build output 280 | **/*.HTMLClient/GeneratedArtifacts 281 | **/*.DesktopClient/GeneratedArtifacts 282 | **/*.DesktopClient/ModelManifest.xml 283 | **/*.Server/GeneratedArtifacts 284 | **/*.Server/ModelManifest.xml 285 | _Pvt_Extensions 286 | 287 | # Paket dependency manager 288 | .paket/paket.exe 289 | paket-files/ 290 | 291 | # FAKE - F# Make 292 | .fake/ 293 | 294 | # JetBrains Rider 295 | .idea/ 296 | *.sln.iml 297 | 298 | # CodeRush personal settings 299 | .cr/personal 300 | 301 | # Python Tools for Visual Studio (PTVS) 302 | __pycache__/ 303 | *.pyc 304 | 305 | # Cake - Uncomment if you are using it 306 | # tools/** 307 | # !tools/packages.config 308 | 309 | # Tabs Studio 310 | *.tss 311 | 312 | # Telerik's JustMock configuration file 313 | *.jmconfig 314 | 315 | # BizTalk build output 316 | *.btp.cs 317 | *.btm.cs 318 | *.odx.cs 319 | *.xsd.cs 320 | 321 | # OpenCover UI analysis results 322 | OpenCover/ 323 | 324 | # Azure Stream Analytics local run output 325 | ASALocalRun/ 326 | 327 | # MSBuild Binary and Structured Log 328 | *.binlog 329 | 330 | # NVidia Nsight GPU debugger configuration file 331 | *.nvuser 332 | 333 | # MFractors (Xamarin productivity tool) working folder 334 | .mfractor/ 335 | 336 | # Local History for Visual Studio 337 | .localhistory/ 338 | 339 | # BeatPulse healthcheck temp database 340 | healthchecksdb -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.29920.165 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Jellyfin.Plugin.SmartPlaylist", "Jellyfin.Plugin.SmartPlaylist\Jellyfin.Plugin.SmartPlaylist.csproj", "{EFE3257F-C3D6-4D49-AF40-486CBABAF49C}" 7 | EndProject 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "Tests\Tests.csproj", "{C240ECDA-10A6-42DE-A374-F89EC473498F}" 9 | EndProject 10 | Global 11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 12 | Debug|Any CPU = Debug|Any CPU 13 | Release|Any CPU = Release|Any CPU 14 | EndGlobalSection 15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 16 | {EFE3257F-C3D6-4D49-AF40-486CBABAF49C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 17 | {EFE3257F-C3D6-4D49-AF40-486CBABAF49C}.Debug|Any CPU.Build.0 = Debug|Any CPU 18 | {EFE3257F-C3D6-4D49-AF40-486CBABAF49C}.Release|Any CPU.ActiveCfg = Release|Any CPU 19 | {EFE3257F-C3D6-4D49-AF40-486CBABAF49C}.Release|Any CPU.Build.0 = Release|Any CPU 20 | {C240ECDA-10A6-42DE-A374-F89EC473498F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 21 | {C240ECDA-10A6-42DE-A374-F89EC473498F}.Debug|Any CPU.Build.0 = Debug|Any CPU 22 | {C240ECDA-10A6-42DE-A374-F89EC473498F}.Release|Any CPU.ActiveCfg = Release|Any CPU 23 | {C240ECDA-10A6-42DE-A374-F89EC473498F}.Release|Any CPU.Build.0 = Release|Any CPU 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | GlobalSection(ExtensibilityGlobals) = postSolution 29 | SolutionGuid = {AB0CAC20-A449-45F3-B2A5-6B2E5FC02771} 30 | EndGlobalSection 31 | EndGlobal 32 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/Jellyfin.Plugin.SmartPlaylist.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | net6.0 5 | 1.0.0.0 6 | true 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/Plugin.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using MediaBrowser.Common.Configuration; 4 | using MediaBrowser.Common.Plugins; 5 | using MediaBrowser.Model.Plugins; 6 | using MediaBrowser.Model.Serialization; 7 | 8 | namespace Jellyfin.Plugin.SmartPlaylist 9 | { 10 | public class Plugin : BasePlugin, IHasWebPages 11 | { 12 | public Plugin( 13 | IApplicationPaths applicationPaths, 14 | IXmlSerializer xmlSerializer 15 | ) : base(applicationPaths, xmlSerializer) 16 | { 17 | Instance = this; 18 | } 19 | 20 | 21 | public override Guid Id => Guid.Parse("3C96F5BC-4182-4B86-B05D-F730F2611E45"); 22 | 23 | public override string Name => "SmartPlaylist"; 24 | 25 | public override string Description => "Allow to define smart playlist rules."; 26 | 27 | public static Plugin Instance { get; private set; } 28 | 29 | public IEnumerable GetPages() 30 | { 31 | return new[] 32 | { 33 | new PluginPageInfo 34 | { 35 | //Name = "smartplaylist.html", 36 | //EmbeddedResourcePath = string.Format("{0}.Configuration.smartplaylist.html", GetType().Namespace), 37 | } 38 | }; 39 | } 40 | } 41 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "profiles": { 3 | "Jellyfin.Plugin.SmartPlaylist": { 4 | "commandName": "Executable", 5 | "executablePath": 6 | "C:\\Users\\Rob\\source\\repos\\jellyfin\\Jellyfin.Server\\bin\\Debug\\netcoreapp3.1\\jellyfin.exe", 7 | "commandLineArgs": 8 | "-w C:\\Users\\Rob\\source\\repos\\jellyfin-web\\dist\\ -d C:\\Users\\Rob\\Desktop\\jellyfin-data\\ -c C:\\Users\\Rob\\Desktop\\jellyfin-config\\ --noautorunwebapp" 9 | } 10 | } 11 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/QueryEngine/Engine.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Diagnostics; 4 | using System.Linq.Expressions; 5 | using System.Text.RegularExpressions; 6 | 7 | namespace Jellyfin.Plugin.SmartPlaylist.QueryEngine 8 | { 9 | // This is taken entirely from https://stackoverflow.com/questions/6488034/how-to-implement-a-rule-engine 10 | public class Engine 11 | { 12 | private static System.Linq.Expressions.Expression BuildExpr(Expression r, ParameterExpression param) 13 | { 14 | var left = System.Linq.Expressions.Expression.Property(param, r.MemberName); 15 | var tProp = typeof(T).GetProperty(r.MemberName)?.PropertyType; 16 | // is the operator a known .NET operator? 17 | if (Enum.TryParse(r.Operator, out ExpressionType tBinary)) 18 | { 19 | var right = System.Linq.Expressions.Expression.Constant(Convert.ChangeType(r.TargetValue, tProp)); 20 | // use a binary operation, e.g. 'Equal' -> 'u.Age == 15' 21 | return System.Linq.Expressions.Expression.MakeBinary(tBinary, left, right); 22 | } 23 | 24 | if (r.Operator == "MatchRegex" || r.Operator == "NotMatchRegex") 25 | { 26 | var regex = new Regex(r.TargetValue); 27 | var method = typeof(Regex).GetMethod("IsMatch", new[] { typeof(string) }); 28 | Debug.Assert(method != null, nameof(method) + " != null"); 29 | var callInstance = System.Linq.Expressions.Expression.Constant(regex); 30 | 31 | var toStringMethod = tProp.GetMethod("ToString", new Type[0]); 32 | Debug.Assert(toStringMethod != null, nameof(toStringMethod) + " != null"); 33 | var methodParam = System.Linq.Expressions.Expression.Call(left, toStringMethod); 34 | 35 | var call = System.Linq.Expressions.Expression.Call(callInstance, method, methodParam); 36 | if (r.Operator == "MatchRegex") return call; 37 | if (r.Operator == "NotMatchRegex") return System.Linq.Expressions.Expression.Not(call); 38 | } 39 | 40 | if (tProp.Name == "String") 41 | { 42 | var method = tProp.GetMethod(r.Operator, new[] { typeof(string) }); 43 | var tParam = method.GetParameters()[0].ParameterType; 44 | var right = System.Linq.Expressions.Expression.Constant(Convert.ChangeType(r.TargetValue, tParam)); 45 | // use a method call, e.g. 'Contains' -> 'u.Tags.Contains(some_tag)' 46 | return System.Linq.Expressions.Expression.Call(left, method, right); 47 | } 48 | else 49 | { 50 | var method = tProp.GetMethod(r.Operator); 51 | var tParam = method.GetParameters()[0].ParameterType; 52 | var right = System.Linq.Expressions.Expression.Constant(Convert.ChangeType(r.TargetValue, tParam)); 53 | // use a method call, e.g. 'Contains' -> 'u.Tags.Contains(some_tag)' 54 | return System.Linq.Expressions.Expression.Call(left, method, right); 55 | } 56 | } 57 | 58 | public static Func CompileRule(Expression r) 59 | { 60 | var paramUser = System.Linq.Expressions.Expression.Parameter(typeof(Operand)); 61 | var expr = BuildExpr(r, paramUser); 62 | // build a lambda function User->bool and compile it 63 | var value = System.Linq.Expressions.Expression.Lambda>(expr, paramUser).Compile(true); 64 | return value; 65 | } 66 | 67 | public static List FixRuleSets(List rulesets) 68 | { 69 | foreach (var rules in rulesets) FixRules(rules); 70 | return rulesets; 71 | } 72 | 73 | public static ExpressionSet FixRules(ExpressionSet rules) 74 | { 75 | foreach (var rule in rules.Expressions) 76 | if (rule.MemberName == "PremiereDate") 77 | { 78 | var somedate = DateTime.Parse(rule.TargetValue); 79 | rule.TargetValue = ConvertToUnixTimestamp(somedate).ToString(); 80 | } 81 | 82 | return rules; 83 | } 84 | 85 | public static double ConvertToUnixTimestamp(DateTime date) 86 | { 87 | var origin = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc); 88 | var diff = date.ToUniversalTime() - origin; 89 | return Math.Floor(diff.TotalSeconds); 90 | } 91 | } 92 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/QueryEngine/Expression.cs: -------------------------------------------------------------------------------- 1 | namespace Jellyfin.Plugin.SmartPlaylist.QueryEngine 2 | { 3 | public class Expression 4 | { 5 | public Expression(string memberName, string @operator, string targetValue) 6 | { 7 | MemberName = memberName; 8 | Operator = @operator; 9 | TargetValue = targetValue; 10 | } 11 | 12 | public string MemberName { get; set; } 13 | public string Operator { get; set; } 14 | public string TargetValue { get; set; } 15 | } 16 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/QueryEngine/Factory.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using Jellyfin.Data.Entities; 4 | using MediaBrowser.Controller.Entities; 5 | using MediaBrowser.Controller.Library; 6 | 7 | namespace Jellyfin.Plugin.SmartPlaylist.QueryEngine 8 | { 9 | internal class OperandFactory 10 | { 11 | // Returns a specific operand povided a baseitem, user, and library manager object. 12 | public static Operand GetMediaType(ILibraryManager libraryManager, BaseItem baseItem, User user) 13 | { 14 | var operand = new Operand(baseItem.Name); 15 | var people = libraryManager.GetPeople(baseItem); 16 | if (people.Any()) 17 | { 18 | // Maps to MediaBrowser.Model.Entities.PersonType 19 | operand.Actors = people.Where(x => x.Type.Equals("Actor")).Select(x => x.Name).ToList(); 20 | operand.Composers = people.Where(x => x.Type.Equals("Composer")).Select(x => x.Name).ToList(); 21 | operand.Directors = people.Where(x => x.Type.Equals("Director")).Select(x => x.Name).ToList(); 22 | operand.GuestStars = people.Where(x => x.Type.Equals("GuestStar")).Select(x => x.Name).ToList(); 23 | operand.Producers = people.Where(x => x.Type.Equals("Producer")).Select(x => x.Name).ToList(); 24 | operand.Writers = people.Where(x => x.Type.Equals("Writer")).Select(x => x.Name).ToList(); 25 | } 26 | 27 | operand.Genres = baseItem.Genres.ToList(); 28 | operand.IsPlayed = baseItem.IsPlayed(user); 29 | operand.Studios = baseItem.Studios.ToList(); 30 | operand.CommunityRating = baseItem.CommunityRating.GetValueOrDefault(); 31 | operand.CriticRating = baseItem.CriticRating.GetValueOrDefault(); 32 | operand.MediaType = baseItem.MediaType; 33 | operand.Album = baseItem.Album; 34 | 35 | if (baseItem.PremiereDate.HasValue) 36 | operand.PremiereDate = new DateTimeOffset(baseItem.PremiereDate.Value).ToUnixTimeSeconds(); 37 | operand.DateCreated = new DateTimeOffset(baseItem.DateCreated).ToUnixTimeSeconds(); 38 | operand.DateLastRefreshed = new DateTimeOffset(baseItem.DateLastRefreshed).ToUnixTimeSeconds(); 39 | operand.DateLastSaved = new DateTimeOffset(baseItem.DateLastSaved).ToUnixTimeSeconds(); 40 | operand.DateModified = new DateTimeOffset(baseItem.DateModified).ToUnixTimeSeconds(); 41 | 42 | operand.FolderPath = baseItem.ContainingFolderPath; 43 | return operand; 44 | } 45 | } 46 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/QueryEngine/Operand.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | 3 | namespace Jellyfin.Plugin.SmartPlaylist.QueryEngine 4 | { 5 | public class Operand 6 | { 7 | public Operand(string name) 8 | { 9 | Actors = new List(); 10 | Composers = new List(); 11 | CommunityRating = 0; 12 | CriticRating = 0; 13 | Directors = new List(); 14 | Genres = new List(); 15 | GuestStars = new List(); 16 | Name = name; 17 | FolderPath = ""; 18 | PremiereDate = 0; 19 | Producers = new List(); 20 | Studios = new List(); 21 | Writers = new List(); 22 | MediaType = ""; 23 | Album = ""; 24 | DateCreated = 0; 25 | DateLastRefreshed = 0; 26 | DateLastSaved = 0; 27 | DateModified = 0; 28 | } 29 | 30 | public List Actors { get; set; } 31 | public List Composers { get; set; } 32 | public float CommunityRating { get; set; } 33 | public float CriticRating { get; set; } 34 | public List Directors { get; set; } 35 | public List Genres { get; set; } 36 | public List GuestStars { get; set; } 37 | public bool IsPlayed { get; set; } 38 | public string Name { get; set; } 39 | public string FolderPath { get; set; } 40 | public double PremiereDate { get; set; } 41 | public List Producers { get; set; } 42 | public List Studios { get; set; } 43 | public List Writers { get; set; } 44 | public string MediaType { get; set; } 45 | public string Album { get; set; } 46 | public double DateCreated { get; set; } 47 | public double DateLastRefreshed { get; set; } 48 | public double DateLastSaved { get; set; } 49 | public double DateModified { get; set; } 50 | } 51 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/ScheduleTasks/RefreshAllPlaylists.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading; 5 | using System.Threading.Tasks; 6 | using Jellyfin.Data.Entities; 7 | using Jellyfin.Data.Enums; 8 | using MediaBrowser.Controller; 9 | using MediaBrowser.Controller.Entities; 10 | using MediaBrowser.Controller.Library; 11 | using MediaBrowser.Controller.Playlists; 12 | using MediaBrowser.Controller.Providers; 13 | using MediaBrowser.Model.IO; 14 | using MediaBrowser.Model.Playlists; 15 | using MediaBrowser.Model.Tasks; 16 | using Microsoft.Extensions.Logging; 17 | 18 | namespace Jellyfin.Plugin.SmartPlaylist.ScheduleTasks 19 | { 20 | public class RefreshAllPlaylists : IScheduledTask, IConfigurableScheduledTask 21 | { 22 | public static readonly BaseItemKind[] SupportedItem = 23 | { BaseItemKind.Audio, BaseItemKind.Episode, BaseItemKind.Movie }; 24 | 25 | private readonly IFileSystem _fileSystem; 26 | private readonly ILibraryManager _libraryManager; 27 | private readonly ILogger _logger; 28 | private readonly IPlaylistManager _playlistManager; 29 | private readonly ISmartPlaylistStore _plStore; 30 | private readonly IProviderManager _providerManager; 31 | private readonly IUserManager _userManager; 32 | 33 | public RefreshAllPlaylists( 34 | IFileSystem fileSystem, 35 | ILibraryManager libraryManager, 36 | ILogger logger, 37 | IPlaylistManager playlistManager, 38 | IProviderManager providerManager, 39 | IServerApplicationPaths serverApplicationPaths, 40 | IUserManager userManager 41 | ) 42 | { 43 | _fileSystem = fileSystem; 44 | _libraryManager = libraryManager; 45 | _logger = logger; 46 | _playlistManager = playlistManager; 47 | _providerManager = providerManager; 48 | _userManager = userManager; 49 | 50 | ISmartPlaylistFileSystem plFileSystem = new SmartPlaylistFileSystem(serverApplicationPaths); 51 | _plStore = new SmartPlaylistStore(plFileSystem); 52 | 53 | _logger.LogInformation("Constructed Refresher "); 54 | } 55 | 56 | public bool IsHidden => false; 57 | public bool IsEnabled => true; 58 | public bool IsLogged => true; 59 | public string Key => nameof(RefreshAllPlaylists); 60 | public string Name => "Refresh all SmartPlaylists"; 61 | public string Description => "Refresh all SmartPlaylists"; 62 | public string Category => "Library"; 63 | 64 | 65 | // TODO check for creation of schedule json file. Isn't created currently and won't execute until it is. 66 | public IEnumerable GetDefaultTriggers() 67 | { 68 | return new[] 69 | { 70 | new TaskTriggerInfo 71 | { 72 | IntervalTicks = TimeSpan.FromMinutes(30).Ticks, 73 | Type = TaskTriggerInfo.TriggerInterval 74 | } 75 | }; 76 | } 77 | 78 | public async Task ExecuteAsync(IProgress progress, CancellationToken cancellationToken) 79 | { 80 | var dtos = await _plStore.GetAllSmartPlaylistsAsync(); 81 | foreach (var dto in dtos) 82 | { 83 | var smartPlaylist = new SmartPlaylist(dto); 84 | 85 | var user = _userManager.GetUserByName(smartPlaylist.User); 86 | List p; 87 | try 88 | { 89 | var playlists = _playlistManager.GetPlaylists(user.Id); 90 | p = playlists.Where(x => x.Id.ToString().Replace("-", "") == dto.Id).ToList(); 91 | } 92 | catch (NullReferenceException ex) 93 | { 94 | _logger.LogError(ex, "No user named {0} found, please fix playlist {1}", dto.User, dto.Name); 95 | continue; 96 | } 97 | 98 | 99 | if ((dto.Id == null) | !p.Any()) 100 | { 101 | _logger.LogInformation("Playlist ID not set, creating new playlist"); 102 | var plId = CreateNewPlaylist(dto, user); 103 | dto.Id = plId; 104 | await _plStore.SaveAsync(dto); 105 | var playlists = _playlistManager.GetPlaylists(user.Id); 106 | p = playlists.Where(x => x.Id.ToString().Replace("-", "") == dto.Id).ToList(); 107 | } 108 | 109 | var newItems = smartPlaylist.FilterPlaylistItems(GetAllUserMedia(user), _libraryManager, user); 110 | 111 | var playlist = p.First(); 112 | var query = new InternalItemsQuery(user) 113 | { 114 | IncludeItemTypes = SupportedItem, 115 | Recursive = true 116 | }; 117 | var plItems = playlist.GetChildren(user, false, query).ToList(); 118 | 119 | var toRemove = plItems.Select(x => x.Id.ToString()).ToList(); 120 | RemoveFromPlaylist(playlist.Id.ToString(), toRemove); 121 | await _playlistManager.AddToPlaylistAsync(playlist.Id, newItems.ToArray(), user.Id); 122 | } 123 | } 124 | 125 | private string CreateNewPlaylist(SmartPlaylistDto dto, User user) 126 | { 127 | var req = new PlaylistCreationRequest 128 | { 129 | Name = dto.Name, 130 | UserId = user.Id 131 | }; 132 | var foo = _playlistManager.CreatePlaylist(req); 133 | return foo.Result.Id; 134 | } 135 | 136 | private IEnumerable GetAllUserMedia(User user) 137 | { 138 | var query = new InternalItemsQuery(user) 139 | { 140 | IncludeItemTypes = SupportedItem, 141 | Recursive = true 142 | }; 143 | 144 | return _libraryManager.GetItemsResult(query).Items; 145 | } 146 | 147 | // Real PlaylistManagers RemoveFromPlaylist needs an entry ID which seems to not work. Explore further and file a bug. 148 | public void RemoveFromPlaylist(string playlistId, IEnumerable entryIds) 149 | { 150 | if (!(_libraryManager.GetItemById(playlistId) is Playlist playlist)) 151 | throw new ArgumentException("No Playlist exists with the supplied Id"); 152 | 153 | var children = playlist.GetManageableItems().ToList(); 154 | 155 | var idList = entryIds.ToList(); 156 | var removals = children.Where(i => idList.Contains(i.Item1.ItemId.ToString())).ToArray(); 157 | 158 | playlist.LinkedChildren = children.Except(removals) 159 | .Select(i => i.Item1) 160 | .ToArray(); 161 | playlist.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None); 162 | 163 | _providerManager.QueueRefresh( 164 | playlist.Id, 165 | new MetadataRefreshOptions(new DirectoryService(_fileSystem)) 166 | { 167 | ForceSave = true 168 | }, 169 | RefreshPriority.High); 170 | } 171 | } 172 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/SmartPlaylist.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using Jellyfin.Data.Entities; 5 | using Jellyfin.Plugin.SmartPlaylist.QueryEngine; 6 | using MediaBrowser.Controller.Entities; 7 | using MediaBrowser.Controller.Library; 8 | 9 | namespace Jellyfin.Plugin.SmartPlaylist 10 | { 11 | public class SmartPlaylist 12 | { 13 | public SmartPlaylist(SmartPlaylistDto dto) 14 | { 15 | Id = dto.Id; 16 | Name = dto.Name; 17 | FileName = dto.FileName; 18 | User = dto.User; 19 | ExpressionSets = Engine.FixRuleSets(dto.ExpressionSets); 20 | if (dto.MaxItems > 0) 21 | MaxItems = dto.MaxItems; 22 | else 23 | MaxItems = 1000; 24 | 25 | switch (dto.Order.Name) 26 | { 27 | //ToDo It would be nice to move to automapper and create a better way to map this. 28 | // Could also use DefinedLimitOrders from emby version. 29 | case "NoOrder": 30 | Order = new NoOrder(); 31 | break; 32 | case "Release Date Ascending": 33 | Order = new PremiereDateOrder(); 34 | break; 35 | case "Release Date Descending": 36 | Order = new PremiereDateOrderDesc(); 37 | break; 38 | default: 39 | Order = new NoOrder(); 40 | break; 41 | } 42 | } 43 | 44 | public string Id { get; set; } 45 | public string Name { get; set; } 46 | public string FileName { get; set; } 47 | public string User { get; set; } 48 | public List ExpressionSets { get; set; } 49 | public int MaxItems { get; set; } 50 | public Order Order { get; set; } 51 | 52 | private List>> CompileRuleSets() 53 | { 54 | var compiledRuleSets = new List>>(); 55 | foreach (var set in ExpressionSets) 56 | compiledRuleSets.Add(set.Expressions.Select(r => Engine.CompileRule(r)).ToList()); 57 | return compiledRuleSets; 58 | } 59 | 60 | // Returns the ID's of the items, if order is provided the IDs are sorted. 61 | public IEnumerable FilterPlaylistItems(IEnumerable items, ILibraryManager libraryManager, 62 | User user) 63 | { 64 | var results = new List(); 65 | 66 | var compiledRules = CompileRuleSets(); 67 | foreach (var i in items) 68 | { 69 | var operand = OperandFactory.GetMediaType(libraryManager, i, user); 70 | 71 | if (compiledRules.Any(set => set.All(rule => rule(operand)))) results.Add(i); 72 | } 73 | 74 | return Order.OrderBy(results).Select(x => x.Id); 75 | } 76 | 77 | private static void Validate() 78 | { 79 | //Todo create validation for constructor 80 | } 81 | } 82 | 83 | public abstract class Order 84 | { 85 | public abstract string Name { get; } 86 | 87 | public virtual IEnumerable OrderBy(IEnumerable items) 88 | { 89 | return items; 90 | } 91 | } 92 | 93 | public class NoOrder : Order 94 | { 95 | public override string Name => "NoOrder"; 96 | } 97 | 98 | public class PremiereDateOrder : Order 99 | { 100 | public override string Name => "Release Date Ascending"; 101 | 102 | public override IEnumerable OrderBy(IEnumerable items) 103 | { 104 | return items.OrderBy(x => x.PremiereDate); 105 | } 106 | } 107 | 108 | public class PremiereDateOrderDesc : Order 109 | { 110 | public override string Name => "Release Date Descending"; 111 | 112 | public override IEnumerable OrderBy(IEnumerable items) 113 | { 114 | return items.OrderByDescending(x => x.PremiereDate); 115 | } 116 | } 117 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/SmartPlaylistDto.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using Jellyfin.Plugin.SmartPlaylist.QueryEngine; 4 | 5 | namespace Jellyfin.Plugin.SmartPlaylist 6 | { 7 | [Serializable] 8 | public class SmartPlaylistDto 9 | { 10 | public string Id { get; set; } 11 | public string Name { get; set; } 12 | public string FileName { get; set; } 13 | public string User { get; set; } 14 | public List ExpressionSets { get; set; } 15 | public int MaxItems { get; set; } 16 | public OrderDto Order { get; set; } 17 | } 18 | 19 | public class ExpressionSet 20 | { 21 | public List Expressions { get; set; } 22 | } 23 | 24 | public class OrderDto 25 | { 26 | public string Name { get; set; } 27 | } 28 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/SmartPlaylistFileSystem.cs: -------------------------------------------------------------------------------- 1 | using System.IO; 2 | using System.Linq; 3 | using MediaBrowser.Controller; 4 | 5 | namespace Jellyfin.Plugin.SmartPlaylist 6 | { 7 | public interface ISmartPlaylistFileSystem 8 | { 9 | string BasePath { get; } 10 | string GetSmartPlaylistFilePath(string smartPlaylistId); 11 | string[] GetSmartPlaylistFilePaths(string userId); 12 | string[] GetAllSmartPlaylistFilePaths(); 13 | string GetSmartPlaylistPath(string userId, string playlistId); 14 | } 15 | 16 | public class SmartPlaylistFileSystem : ISmartPlaylistFileSystem 17 | { 18 | // Class Constructor for SmartPlaylistFileSystem 19 | // Creates directory if it doesn't exist 20 | public SmartPlaylistFileSystem(IServerApplicationPaths serverApplicationPaths) 21 | { 22 | BasePath = Path.Combine(serverApplicationPaths.DataPath, "smartplaylists"); 23 | if (!Directory.Exists(BasePath)) Directory.CreateDirectory(BasePath); 24 | } 25 | 26 | public string BasePath { get; } 27 | 28 | public string GetSmartPlaylistFilePath(string smartPlaylistId) 29 | { 30 | return Directory.GetFiles(BasePath, $"{smartPlaylistId}.json", SearchOption.AllDirectories).First(); 31 | } 32 | 33 | public string[] GetSmartPlaylistFilePaths(string userId) 34 | { 35 | return Directory.GetFiles(BasePath); 36 | } 37 | 38 | public string[] GetAllSmartPlaylistFilePaths() 39 | { 40 | return Directory.GetFiles(BasePath, "*.json", SearchOption.AllDirectories); 41 | } 42 | 43 | public string GetSmartPlaylistPath(string userId, string playlistId) 44 | { 45 | return Path.Combine(BasePath, $"{playlistId}.json"); 46 | } 47 | } 48 | } -------------------------------------------------------------------------------- /Jellyfin.Plugin.SmartPlaylist/SmartPlaylistStore.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Linq; 4 | using System.Text.Json; 5 | using System.Threading.Tasks; 6 | 7 | namespace Jellyfin.Plugin.SmartPlaylist 8 | { 9 | public interface ISmartPlaylistStore 10 | { 11 | Task GetSmartPlaylistAsync(Guid smartPlaylistId); 12 | Task LoadPlaylistsAsync(Guid userId); 13 | Task GetAllSmartPlaylistsAsync(); 14 | Task SaveAsync(SmartPlaylistDto smartPlaylist); 15 | void Delete(Guid userId, string smartPlaylistId); 16 | } 17 | 18 | public class SmartPlaylistStore : ISmartPlaylistStore 19 | { 20 | private readonly ISmartPlaylistFileSystem _fileSystem; 21 | 22 | public SmartPlaylistStore(ISmartPlaylistFileSystem fileSystem) 23 | { 24 | _fileSystem = fileSystem; 25 | } 26 | 27 | 28 | public async Task GetSmartPlaylistAsync(Guid smartPlaylistId) 29 | { 30 | var fileName = _fileSystem.GetSmartPlaylistFilePath(smartPlaylistId.ToString()); 31 | 32 | return await LoadPlaylistAsync(fileName).ConfigureAwait(false); 33 | } 34 | 35 | public async Task LoadPlaylistsAsync(Guid userId) 36 | { 37 | var deserializeTasks = _fileSystem.GetSmartPlaylistFilePaths(userId.ToString()).Select(LoadPlaylistAsync) 38 | .ToArray(); 39 | 40 | await Task.WhenAll(deserializeTasks).ConfigureAwait(false); 41 | 42 | return deserializeTasks.Select(x => x.Result).ToArray(); 43 | } 44 | 45 | public async Task GetAllSmartPlaylistsAsync() 46 | { 47 | var deserializeTasks = _fileSystem.GetAllSmartPlaylistFilePaths().Select(LoadPlaylistAsync).ToArray(); 48 | 49 | await Task.WhenAll(deserializeTasks).ConfigureAwait(false); 50 | 51 | return deserializeTasks.Select(x => x.Result).ToArray(); 52 | } 53 | 54 | public async Task SaveAsync(SmartPlaylistDto smartPlaylist) 55 | { 56 | var filePath = _fileSystem.GetSmartPlaylistPath(smartPlaylist.Id, smartPlaylist.FileName); 57 | await using var writer = File.Create(filePath); 58 | await JsonSerializer.SerializeAsync(writer, smartPlaylist).ConfigureAwait(false); 59 | } 60 | 61 | public void Delete(Guid userId, string smartPlaylistId) 62 | { 63 | var filePath = _fileSystem.GetSmartPlaylistPath(userId.ToString(), smartPlaylistId); 64 | if (File.Exists(filePath)) File.Delete(filePath); 65 | } 66 | 67 | private async Task LoadPlaylistAsync(string filePath) 68 | { 69 | await using var reader = File.OpenRead(filePath); 70 | return await JsonSerializer.DeserializeAsync(reader).ConfigureAwait(false); 71 | } 72 | } 73 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Smart Playlist Plugin for Jellyfin 2 | 3 | ## Overview 4 | 5 | This is an attempt to make a smart playlist similar to what iTunes, Plex, and other media players have. It is still in early development and has some limitations which will not be able to be resolved until Jellyfin impliments some features. 6 | 7 | Note: The playlist json format is still in flux as I figure things out. 8 | 9 | ## How to Install 10 | 11 | To use this plugin download the DLL and place it in your plugin directory. Once launched you should find in your data directory a folder called "smartplaylist". Your JSON files describing a playlist go in here. 12 | 13 | ## Configuration 14 | 15 | To create a new playlist, create a json file in this directory having a format such as the following. 16 | 17 | ```json 18 | { 19 | "Name": "CGP Grey", 20 | "FileName": "cgp_grey", 21 | "User": "rob", 22 | "ExpressionSets": [ 23 | { 24 | "Expressions": [ 25 | { 26 | "MemberName": "Directors", 27 | "Operator": "Contains", 28 | "TargetValue": "CGP Grey" 29 | }, 30 | { 31 | "MemberName": "IsPlayed", 32 | "Operator": "Equal", 33 | "TargetValue": "False" 34 | } 35 | ] 36 | }, 37 | { 38 | "Expressions": [ 39 | { 40 | "MemberName": "Directors", 41 | "Operator": "Contains", 42 | "TargetValue": "Nerdwriter1" 43 | }, 44 | { 45 | "MemberName": "IsPlayed", 46 | "Operator": "Equal", 47 | "TargetValue": "False" 48 | } 49 | ] 50 | } 51 | ], 52 | "Order": { 53 | "Name": "Release Date Ascending" 54 | } 55 | } 56 | ``` 57 | 58 | - Id: This field is created after the playlist is first rendered. Do not fill this in yourself. 59 | - Name: Name of the playlist as it will appear in Jellyfin 60 | - FileName: The actual filename. If you create a file named cgpgrey_playlist.json then this should be cgpgrey_playlist 61 | - User: Name of the user for the playlist 62 | - ExpressionSets: This is a list of Expressions. Each expression is OR'ed together. 63 | - Expressions: This is the meat of the plugin. Expressions are a list of maps containing MemberName, Operator, and TargetValue. I am working on a list of all valid things. Currently there are three sets of expressions: 64 | 65 | - Universal LINQ expression operators: [This link](https://docs.microsoft.com/en-us/dotnet/api/system.linq.expressions.expressiontype?redirectedfrom=MSDN&view=net-5.0) is a list of all valid operators within expression trees but only a subset are valid for a specific operand. 66 | - String operators: Equals, StartsWith, EndsWith, Contains. 67 | - Regex operators: MatchRegex, NotMatchRegex. 68 | 69 | - MemberName: This is a reference to the properties in [Operand](https://github.com/ankenyr/jellyfin-smartplaylist-plugin/blob/master/Jellyfin.Plugin.SmartPlaylist/QueryEngine/Operand.cs "Operand"). You set this string to one of the property names to reference what you wish to filter on. 70 | - Operator: An operation used to compare the TargetValue to the property of each piece of media. The above example would match anything with the director set as CGP Grey with a Premiere Date less than 2020/07/01 71 | - Target Value: The value to be compared to. Most things are converted into strings, booleans, or numbers. A date in the above example is converted to seconds since epoch. 72 | 73 | - Order: Provides the type of sorting you wish for the playlist. The following are a list of valid sorting methods so far. 74 | - NoOrder 75 | - Release Date Ascending 76 | - Release Date Descending 77 | 78 | ## Future work 79 | 80 | - Add in more properties to be matched against. Please file aa feature request if you have ideas. 81 | - Document all operators that are valid for each property. 82 | - Explore creating custom property types with custom operators. 83 | - Once Jellyfin allows for custom web pages beyond the configuration page, explore how to allow configuration from the web interface rather than JSON files. 84 | - Add more sorting methods. 85 | - Pretty Print JSON files, possibly this should be done by jellyfin itself. 86 | 87 | ## Credits 88 | 89 | Rule engine was inspired by [this](https://stackoverflow.com/questions/6488034/how-to-implement-a-rule-engine "this") post in Stack Overflow. 90 | Initially wanted to convert [ppankiewicz's plugin](https://github.com/ppankiewicz/Emby.SmartPlaylist.Plugin "ppankiewicz's plugin") but found it to be too incompatible and difficult to work with. I did take some bits of code mostly around interfacing with the filesystem. 91 | -------------------------------------------------------------------------------- /Tests/SmartPlaylistTest.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using Jellyfin.Plugin.SmartPlaylist; 3 | using Jellyfin.Plugin.SmartPlaylist.QueryEngine; 4 | using Xunit; 5 | 6 | namespace Tests 7 | { 8 | public class SmartPlaylistTest 9 | { 10 | [Fact] 11 | public void DtoToSmartPlaylist() 12 | { 13 | var dto = new SmartPlaylistDto 14 | { 15 | Id = "87ccaa10-f801-4a7a-be40-46ede34adb22", 16 | Name = "Foo", 17 | User = "Rob" 18 | }; 19 | 20 | var es = new ExpressionSet 21 | { 22 | Expressions = new List 23 | { 24 | new("foo", "bar", "biz") 25 | } 26 | }; 27 | dto.ExpressionSets = new List 28 | { 29 | es 30 | }; 31 | dto.Order = new OrderDto 32 | { 33 | Name = "Release Date Descending" 34 | }; 35 | var smartPlaylist = new SmartPlaylist(dto); 36 | 37 | Assert.Equal(1000, smartPlaylist.MaxItems); 38 | Assert.Equal("87ccaa10-f801-4a7a-be40-46ede34adb22", smartPlaylist.Id); 39 | Assert.Equal("Foo", smartPlaylist.Name); 40 | Assert.Equal("Rob", smartPlaylist.User); 41 | Assert.Equal("foo", smartPlaylist.ExpressionSets[0].Expressions[0].MemberName); 42 | Assert.Equal("bar", smartPlaylist.ExpressionSets[0].Expressions[0].Operator); 43 | Assert.Equal("biz", smartPlaylist.ExpressionSets[0].Expressions[0].TargetValue); 44 | Assert.Equal("PremiereDateOrderDesc", smartPlaylist.Order.GetType().Name); 45 | } 46 | } 47 | } -------------------------------------------------------------------------------- /Tests/Tests.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | net6.0 5 | 6 | false 7 | 8 | 9 | 10 | 11 | 12 | 13 | all 14 | runtime; build; native; contentfiles; analyzers; buildtransitive 15 | 16 | 17 | all 18 | runtime; build; native; contentfiles; analyzers; buildtransitive 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | --------------------------------------------------------------------------------