├── install-plugin
├── README.md
├── install-plugin.csproj
└── Program.cs
├── .gitignore
├── .run
├── publish.run.xml
├── jf.run.xml
└── install-plugin.run.xml
├── src
├── MeilisearchItem.cs
├── PluginRegister.cs
├── ScheduledTask.cs
├── Jellyfin.Plugin.Meilisearch.csproj
├── build.yaml
├── UpdateMeilisearchIndexTask.cs
├── Config.cs
├── Controller.cs
├── InjectActionFilter.cs
├── Indexer.cs
├── EFCoreIndexer.cs
├── DbIndexer.cs
├── Plugin.cs
├── MeilisearchClientHolder.cs
├── MeilisearchMutateFilter.cs
└── config.html
├── .github
├── dependabot.yml
└── workflows
│ └── publish.yaml
├── Jellyfin.Plugin.Meilisearch.sln
├── README.md
└── LICENSE
/install-plugin/README.md:
--------------------------------------------------------------------------------
1 | here just some helper script for me to run this thing locally for testing
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /jellyfin*/
2 | dumps/
3 | data.ms/
4 | *.exe
5 | *.pdb
6 | *.dll
7 | bin/
8 | obj/
9 | .idea/
10 | *.user
--------------------------------------------------------------------------------
/install-plugin/install-plugin.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Exe
5 | net9.0
6 | install_plugin
7 | enable
8 | enable
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/.run/publish.run.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/src/MeilisearchItem.cs:
--------------------------------------------------------------------------------
1 | namespace Jellyfin.Plugin.Meilisearch;
2 |
3 | public record MeilisearchItem(
4 | string Guid,
5 | string? Type,
6 | string? ParentId,
7 | string? Name,
8 | string? Overview,
9 | string? OriginalTitle,
10 | string? SeriesName,
11 | int? ProductionYear,
12 | string[]? Artists,
13 | string[]? AlbumArtists,
14 | string[]? Genres,
15 | string[]? Studios,
16 | string[]? Tags,
17 | bool? IsFolder,
18 | double? CommunityRating,
19 | double? CriticRating,
20 | string? Path,
21 | string? Tagline
22 | );
--------------------------------------------------------------------------------
/src/PluginRegister.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Controller;
2 | using MediaBrowser.Controller.Plugins;
3 | using Microsoft.Extensions.DependencyInjection;
4 |
5 | namespace Jellyfin.Plugin.Meilisearch;
6 |
7 | // ReSharper disable once UnusedType.Global
8 | public class PluginRegister : IPluginServiceRegistrator
9 | {
10 | public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHost)
11 | {
12 | serviceCollection.AddSingleton();
13 | serviceCollection.AddSingleton();
14 | serviceCollection.AddSingleton();
15 | }
16 | }
--------------------------------------------------------------------------------
/.run/jf.run.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/src/ScheduledTask.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Model.Tasks;
2 | using Microsoft.Extensions.Logging;
3 |
4 | namespace Jellyfin.Plugin.Meilisearch;
5 |
6 | public class ScheduledTask(ILogger logger, Indexer indexer) : IScheduledTask
7 | {
8 | public async Task ExecuteAsync(IProgress progress, CancellationToken cancellationToken)
9 | {
10 | logger.LogInformation("Executing meilisearch index task");
11 | await indexer.Index();
12 | }
13 |
14 | public IEnumerable GetDefaultTriggers()
15 | {
16 | return [];
17 | }
18 |
19 | public string Name => "Update Meilisearch index for all documents";
20 | public string Key => "task-meilisearch-reindex-full";
21 | public string Description => "Update index for all documents";
22 | public string Category => "Meilisearch";
23 | }
--------------------------------------------------------------------------------
/src/Jellyfin.Plugin.Meilisearch.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | net9.0
5 | enable
6 | enable
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 | # Fetch and update latest `nuget` pkgs
4 | - package-ecosystem: nuget
5 | directory: /
6 | schedule:
7 | interval: weekly
8 | open-pull-requests-limit: 10
9 | labels:
10 | - chore
11 | - dependency
12 | - nuget
13 | commit-message:
14 | prefix: chore
15 | include: scope
16 | ignore:
17 | - dependency-name: "Microsoft.Data.Sqlite"
18 | - dependency-name: "Jellyfin.Controller"
19 | - dependency-name: "Jellyfin.Model"
20 |
21 | # Fetch and update latest `github-actions` pkgs
22 | - package-ecosystem: github-actions
23 | directory: /
24 | schedule:
25 | interval: weekly
26 | open-pull-requests-limit: 10
27 | labels:
28 | - ci
29 | - dependency
30 | - github_actions
31 | commit-message:
32 | prefix: ci
33 | include: scope
--------------------------------------------------------------------------------
/src/build.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | name: "Meilisearch"
3 | guid: "974395db-b31d-46a2-bc86-ef9aa5ac04dd"
4 | version: "0.0.0.0"
5 | targetAbi: "10.11.0.0"
6 | framework: "net9.0"
7 | overview: "A Meilisearch Plugin for Jellyfin"
8 | imageUrl: https://raw.githubusercontent.com/meilisearch/meilisearch/refs/heads/main/assets/meilisearch-logo-dark.svg
9 | description: >
10 | This is a plugin that try to use Meilisearch to speedup the search of jellyfin.
11 | Inspired by Jellysearch
12 | category: "General"
13 | owner: "a.sac."
14 | artifacts:
15 | - "Jellyfin.Plugin.Meilisearch.dll"
16 | - "Jellyfin.Plugin.Meilisearch.pdb"
17 | - "Meilisearch.dll"
18 | - "Microsoft.IdentityModel.Abstractions.dll"
19 | - "Microsoft.IdentityModel.JsonWebTokens.dll"
20 | - "Microsoft.IdentityModel.Logging.dll"
21 | - "Microsoft.IdentityModel.Tokens.dll"
22 | - "System.IdentityModel.Tokens.Jwt.dll"
23 | changelog: changelog
--------------------------------------------------------------------------------
/src/UpdateMeilisearchIndexTask.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Controller.Library;
2 | using Microsoft.Extensions.Logging;
3 |
4 | namespace Jellyfin.Plugin.Meilisearch;
5 |
6 | public class UpdateMeilisearchIndexTask(
7 | ILogger logger,
8 | Indexer indexer,
9 | MeilisearchClientHolder clientHolder)
10 | : ILibraryPostScanTask
11 | {
12 | public async Task Run(IProgress progress, CancellationToken cancellationToken)
13 | {
14 | logger.LogInformation("Updating Meilisearch index");
15 | if (!clientHolder.Ok)
16 | {
17 | logger.LogError("Meilisearch is not configured, skipping index update");
18 | return;
19 | }
20 |
21 | try
22 | {
23 | await indexer.Index();
24 | }
25 | catch (Exception e)
26 | {
27 | logger.LogError(e, "Failed to update Meilisearch index");
28 | }
29 | }
30 | }
--------------------------------------------------------------------------------
/src/Config.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Model.Plugins;
2 |
3 | namespace Jellyfin.Plugin.Meilisearch;
4 |
5 | public class Config : BasePluginConfiguration
6 | {
7 | public static readonly string[] DefaultAttributesToSearchOn =
8 | [
9 | "name", "artists", "albumArtists", "originalTitle", "productionYear", "seriesName", "genres", "tags",
10 | "studios", "overview", "path", "tagline"
11 | ];
12 |
13 | public Config()
14 | {
15 | ApiKey = string.Empty;
16 | Url = string.Empty;
17 | Debug = false;
18 | IndexName = string.Empty;
19 | AttributesToSearchOn = DefaultAttributesToSearchOn;
20 | FallbackToJellyfin = false;
21 | }
22 |
23 | public string ApiKey { get; set; }
24 | public string Url { get; set; }
25 |
26 | public bool Debug { get; set; }
27 | public string IndexName { get; set; }
28 | public string[] AttributesToSearchOn { get; set; }
29 | public bool FallbackToJellyfin { get; set; }
30 | }
--------------------------------------------------------------------------------
/src/Controller.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Common.Api;
2 | using Microsoft.AspNetCore.Authorization;
3 | using Microsoft.AspNetCore.Mvc;
4 |
5 | namespace Jellyfin.Plugin.Meilisearch;
6 |
7 | [Route("meilisearch")]
8 | [ApiController]
9 | [Authorize(Policy = Policies.RequiresElevation)]
10 | public class Controller(MeilisearchClientHolder clientHolder) : ControllerBase
11 | {
12 | [HttpGet("status")]
13 | public ActionResult GetStatus()
14 | {
15 | return new JsonResult(new
16 | {
17 | meilisearch = clientHolder.Status,
18 | meilisearchOk = clientHolder.Ok,
19 | averageSearchTime = $"{Plugin.Instance!.AverageSearchTime}ms",
20 | indexStatus = Plugin.Instance.Indexer.Status
21 | });
22 | }
23 |
24 | [HttpGet("reconnect")]
25 | public async Task Reconnect()
26 | {
27 | if (!clientHolder.Ok) await Plugin.Instance!.TryCreateMeilisearchClient();
28 | return GetStatus();
29 | }
30 |
31 | [HttpGet("reindex")]
32 | public async Task Reindex()
33 | {
34 | await Plugin.Instance!.Indexer.Index();
35 | return GetStatus();
36 | }
37 | }
--------------------------------------------------------------------------------
/.run/install-plugin.run.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Meilisearch.sln:
--------------------------------------------------------------------------------
1 |
2 | Microsoft Visual Studio Solution File, Format Version 12.00
3 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Meilisearch", "src\Jellyfin.Plugin.Meilisearch.csproj", "{D9E8FE69-9E5A-4AE9-BFC2-590DB8DA69E0}"
4 | EndProject
5 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "install-plugin", "install-plugin\install-plugin.csproj", "{E6599AF9-A2FC-4050-ACBA-FF4FD599A903}"
6 | EndProject
7 | Global
8 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
9 | Debug|Any CPU = Debug|Any CPU
10 | Release|Any CPU = Release|Any CPU
11 | EndGlobalSection
12 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
13 | {D9E8FE69-9E5A-4AE9-BFC2-590DB8DA69E0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
14 | {D9E8FE69-9E5A-4AE9-BFC2-590DB8DA69E0}.Debug|Any CPU.Build.0 = Debug|Any CPU
15 | {D9E8FE69-9E5A-4AE9-BFC2-590DB8DA69E0}.Release|Any CPU.ActiveCfg = Release|Any CPU
16 | {D9E8FE69-9E5A-4AE9-BFC2-590DB8DA69E0}.Release|Any CPU.Build.0 = Release|Any CPU
17 | {E6599AF9-A2FC-4050-ACBA-FF4FD599A903}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
18 | {E6599AF9-A2FC-4050-ACBA-FF4FD599A903}.Debug|Any CPU.Build.0 = Debug|Any CPU
19 | {E6599AF9-A2FC-4050-ACBA-FF4FD599A903}.Release|Any CPU.ActiveCfg = Release|Any CPU
20 | {E6599AF9-A2FC-4050-ACBA-FF4FD599A903}.Release|Any CPU.Build.0 = Release|Any CPU
21 | EndGlobalSection
22 | EndGlobal
23 |
--------------------------------------------------------------------------------
/src/InjectActionFilter.cs:
--------------------------------------------------------------------------------
1 | using Microsoft.AspNetCore.Mvc.Controllers;
2 | using Microsoft.AspNetCore.Mvc.Filters;
3 | using Microsoft.AspNetCore.Mvc.Infrastructure;
4 | using Microsoft.Extensions.DependencyInjection;
5 |
6 | namespace Jellyfin.Plugin.Meilisearch;
7 |
8 | public static class InjectActionFilter
9 | {
10 | public static int AddDynamicFilter(
11 | this IActionDescriptorCollectionProvider provider,
12 | IServiceProvider serviceProvider,
13 | Func matcher)
14 | where T : IFilterMetadata
15 | {
16 | // Access the Action Descriptor Collection Provider to modify filter metadata
17 | var actionDescriptors = provider.ActionDescriptors.Items;
18 |
19 | // Find actions on the specified controller type
20 | var targetActions = actionDescriptors.Where(ad =>
21 | {
22 | var cad = ad as ControllerActionDescriptor;
23 | return cad != null && matcher(cad);
24 | }).ToArray();
25 |
26 | // Add the filter to each action on the specified controller
27 | foreach (var action in targetActions)
28 | {
29 | var filter = ActivatorUtilities.CreateInstance(serviceProvider);
30 |
31 | var filterMetadata = action.FilterDescriptors;
32 | filterMetadata.Add(new FilterDescriptor(filter, FilterScope.Global));
33 | }
34 |
35 | return targetActions.Length;
36 | }
37 | }
--------------------------------------------------------------------------------
/src/Indexer.cs:
--------------------------------------------------------------------------------
1 | using System.Collections.Immutable;
2 | using System.Globalization;
3 | using Meilisearch;
4 | using Microsoft.Extensions.Logging;
5 | using Index = Meilisearch.Index;
6 |
7 | namespace Jellyfin.Plugin.Meilisearch;
8 |
9 | public abstract class Indexer(MeilisearchClientHolder clientHolder, ILogger logger)
10 | {
11 | public Dictionary Status { get; } = new();
12 |
13 | public async Task Index()
14 | {
15 | var task = clientHolder.Call(IndexInternal);
16 | if (task == null)
17 | {
18 | logger.LogWarning("Meilisearch is not configured, skipping index update");
19 | return;
20 | }
21 |
22 | await task;
23 | }
24 |
25 | private async Task IndexInternal(MeilisearchClient meilisearchClient, Index index)
26 | {
27 | var items = await GetItems();
28 | if (items.Count <= 0)
29 | {
30 | logger.LogInformation("No items to index");
31 | return;
32 | }
33 |
34 | await index.AddDocumentsInBatchesAsync(items, batchSize: 5000, primaryKey: "guid");
35 | logger.LogInformation("Upload {COUNT} items to Meilisearch", items.Count);
36 | Status["Items"] = items.Count.ToString();
37 | Status["LastIndexed"] = DateTime.Now.ToString(CultureInfo.CurrentCulture);
38 | }
39 |
40 | ///
41 | /// Get the items to index
42 | ///
43 | protected abstract Task> GetItems();
44 | }
--------------------------------------------------------------------------------
/install-plugin/Program.cs:
--------------------------------------------------------------------------------
1 | using System.Text;
2 |
3 | Console.OutputEncoding = Encoding.UTF8;
4 | var buildPath = Path.GetFullPath("src/bin/Debug/publish");
5 | var pluginPath = Path.GetFullPath("jellyfin/data/plugins/Meilisearch");
6 | var files = new[]
7 | {
8 | "Jellyfin.Plugin.Meilisearch.dll",
9 | "Jellyfin.Plugin.Meilisearch.pdb",
10 | "Meilisearch.dll",
11 | "Microsoft.IdentityModel.Abstractions.dll",
12 | "Microsoft.IdentityModel.JsonWebTokens.dll",
13 | "Microsoft.IdentityModel.Logging.dll",
14 | "Microsoft.IdentityModel.Tokens.dll",
15 | "System.IdentityModel.Tokens.Jwt.dll"
16 | };
17 |
18 | Console.WriteLine("reinstalling plugin at: " + pluginPath);
19 | Console.WriteLine("from path: " + buildPath);
20 |
21 | Console.WriteLine("removing plugin");
22 | try
23 | {
24 | // list existing files
25 | foreach (var file in Directory.EnumerateFiles(pluginPath))
26 | {
27 | Console.WriteLine("\tremoving file: " + file);
28 | File.Delete(file);
29 | }
30 |
31 | Directory.Delete(pluginPath, true);
32 | }
33 | catch (Exception)
34 | {
35 | // ignored
36 | }
37 |
38 | Console.WriteLine("installing plugin");
39 | try
40 | {
41 | Console.WriteLine("create plugin folder");
42 | Directory.CreateDirectory(pluginPath);
43 | Console.WriteLine("copying files");
44 | foreach (var file in Directory.EnumerateFiles(buildPath))
45 | if (files.Contains(Path.GetFileName(file)))
46 | {
47 | Console.WriteLine("\t√ " + file);
48 | var newPath = Path.Combine(pluginPath, Path.GetFileName(file));
49 | File.Copy(file, newPath, true);
50 | }
51 | else
52 | {
53 | Console.WriteLine("\t× " + file);
54 | }
55 | }
56 | catch (Exception e)
57 | {
58 | Console.WriteLine(e);
59 | throw;
60 | }
--------------------------------------------------------------------------------
/src/EFCoreIndexer.cs:
--------------------------------------------------------------------------------
1 | using System.Collections.Immutable;
2 | using Jellyfin.Database.Implementations;
3 | using Jellyfin.Database.Implementations.Entities;
4 | using Microsoft.EntityFrameworkCore;
5 | using Microsoft.Extensions.Logging;
6 |
7 | namespace Jellyfin.Plugin.Meilisearch;
8 |
9 | public class EfCoreIndexer(
10 | IJellyfinDatabaseProvider dbProvider,
11 | MeilisearchClientHolder clientHolder,
12 | ILogger logger
13 | ) : Indexer(clientHolder, logger)
14 | {
15 | protected override Task> GetItems()
16 | {
17 | var context = dbProvider.DbContextFactory!.CreateDbContext();
18 | Status["Database"] = context.Database.GetDbConnection().ConnectionString;
19 |
20 | return Task.FromResult(context.BaseItems.ToImmutableList().Select(ToMeilisearchItem).ToImmutableList());
21 | }
22 |
23 |
24 | private static MeilisearchItem ToMeilisearchItem(BaseItemEntity item)
25 | {
26 | return new MeilisearchItem(
27 | Guid: item.Id.ToString(),
28 | Type: item.Type,
29 | ParentId: item.ParentId.ToString(),
30 | Name: item.Name,
31 | Overview: item.Overview,
32 | OriginalTitle: item.OriginalTitle,
33 | SeriesName: item.SeriesName,
34 | Studios: item.Studios?.Split('|'),
35 | Genres: item.Genres?.Split('|'),
36 | Tags: item.Tags?.Split('|'),
37 | CommunityRating: item.CommunityRating,
38 | ProductionYear: item.ProductionYear,
39 | Path: item.Path?[0] == '%' ? null : item.Path,
40 | Artists: item.Artists?.Split('|'),
41 | AlbumArtists: item.AlbumArtists?.Split('|'),
42 | CriticRating: item.CriticRating,
43 | IsFolder: item.IsFolder,
44 | Tagline: item.Tagline
45 | );
46 | }
47 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Meilisearch Plugin for Jellyfin
2 |
3 | A plugin for Jellyfin that try to improves search speed and result by utilize Meilisearch as search engine.
4 |
5 | This plugin offload search logic to Meilisearch, and modifies response from Jellyfin.
6 |
7 | As long as your client uses `/Items` endpoint for search, it should be supported seamlessly I guess.
8 |
9 | Inspired by [JellySearch](https://gitlab.com/DomiStyle/jellysearch).
10 |
11 | ---
12 |
13 | ### Usage
14 |
15 | 1. Setup a Meilisearch instance (maybe a hosted one in the cloud will also work, but I don't recommend).
16 | 2. Add following repository and install the Meilisearch plugin.
17 |
18 | ```
19 | https://raw.githubusercontent.com/arnesacnussem/jellyfin-plugin-meilisearch/refs/heads/master/manifest.json
20 | ```
21 |
22 | 3. Fill url to your Meilisearch instance in plugin settings, and maybe api key also required according to your Meilisearch setup.
23 | - You can set the environment variables `MEILI_URL` and `MEILI_MASTER_KEY` to configure the plugin without editing the Jellyfin UI.
24 | 4. If you want share one Meilisearch instance across multiple Jellyfin instance, you can fill the `Meilisearch Index Name`, if leaving empty, it will use the server name.
25 | 5. Remember click `Save` and make sure the status reports `ok`.
26 | 6. Try typing something in search page.
27 |
28 | ---
29 |
30 | Index will update on following events:
31 |
32 | - Server start
33 | - Configuration change
34 | - Library scan complete
35 | - Update index task being triggered
36 |
37 | ---
38 |
39 | ### How it works
40 |
41 | The core feature, which is to mutate the search request, is done by injecting an [`ActionFilter`](https://learn.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-8.0#action-filters).
42 | So it may only support a few versions of Jellyfin. At the moment I'm using `Jellyfin 10.11.0`,
43 | but it should work on other versions as long as the required parameter name of `/Items` endpoint doesn't change.
44 |
45 | ---
46 |
47 | ###
48 |
49 | I've seen JellySearch, which is a wonderful project, but I don't really like setting up a reverse proxy or any of that hassle.
50 |
51 | So I am writing this, but it still requires a Meilisearch instance.
52 |
53 | At this moment, only the `/Items` endpoint is affected by this plugin, but it still improves a lot on my 200k items library.
54 |
--------------------------------------------------------------------------------
/src/DbIndexer.cs:
--------------------------------------------------------------------------------
1 | using System.Collections.Immutable;
2 | using MediaBrowser.Common.Configuration;
3 | using Microsoft.Data.Sqlite;
4 | using Microsoft.Extensions.Logging;
5 |
6 | namespace Jellyfin.Plugin.Meilisearch;
7 |
8 | /**
9 | * Following code is somewhat copy-pasted or adapted from Jellysearch.
10 | */
11 | public class DbIndexer(
12 | IApplicationPaths applicationPaths,
13 | MeilisearchClientHolder clientHolder,
14 | ILogger logger) : Indexer(clientHolder, logger)
15 | {
16 | protected override async Task> GetItems()
17 | {
18 | var dbPath = Path.Combine(applicationPaths.DataPath, "jellyfin.db");
19 | Status["Database"] = dbPath;
20 | logger.LogInformation("Indexing items from database: {DB}", dbPath);
21 |
22 | // Open Jellyfin library
23 | await using var connection = new SqliteConnection(new SqliteConnectionStringBuilder
24 | {
25 | DataSource = dbPath,
26 | Mode = SqliteOpenMode.ReadOnly
27 | }.ToString());
28 | await connection.OpenAsync();
29 |
30 | // Query all base items
31 | await using var command = connection.CreateCommand();
32 | command.CommandText =
33 | """
34 | SELECT
35 | Id, Type, ParentId, CommunityRating,
36 | Name, Overview, ProductionYear, Genres,
37 | Studios, Tags, IsFolder, CriticRating,
38 | OriginalTitle, SeriesName, Artists,
39 | AlbumArtists, Path, Tagline
40 | FROM
41 | BaseItems
42 | """;
43 |
44 | await using var reader = await command.ExecuteReaderAsync();
45 | var items = new List();
46 | while (await reader.ReadAsync())
47 | {
48 | var item = new MeilisearchItem(
49 | reader.GetGuid(0).ToString(),
50 | !reader.IsDBNull(1) ? reader.GetString(1) : null,
51 | !reader.IsDBNull(2) ? reader.GetString(2) : null,
52 | CommunityRating: !reader.IsDBNull(3) ? reader.GetDouble(3) : null,
53 | Name: !reader.IsDBNull(4) ? reader.GetString(4) : null,
54 | Overview: !reader.IsDBNull(5) ? reader.GetString(5) : null,
55 | ProductionYear: !reader.IsDBNull(6) ? reader.GetInt32(6) : null,
56 | Genres: !reader.IsDBNull(7) ? reader.GetString(7).Split('|') : null,
57 | Studios: !reader.IsDBNull(8) ? reader.GetString(8).Split('|') : null,
58 | Tags: !reader.IsDBNull(9) ? reader.GetString(9).Split('|') : null,
59 | IsFolder: !reader.IsDBNull(10) ? reader.GetBoolean(10) : null,
60 | CriticRating: !reader.IsDBNull(11) ? reader.GetDouble(11) : null,
61 | OriginalTitle: !reader.IsDBNull(12) ? reader.GetString(12) : null,
62 | SeriesName: !reader.IsDBNull(13) ? reader.GetString(13) : null,
63 | Artists: !reader.IsDBNull(14) ? reader.GetString(14).Split('|') : null,
64 | AlbumArtists: !reader.IsDBNull(15) ? reader.GetString(15).Split('|') : null,
65 | Path: !reader.IsDBNull(16) ? reader.GetString(16) : null,
66 | Tagline: !reader.IsDBNull(17) ? reader.GetString(17) : null
67 | );
68 | if (item.Path?[0] == '%') item = item with { Path = null };
69 | items.Add(item);
70 | }
71 |
72 | return items.ToImmutableList();
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/src/Plugin.cs:
--------------------------------------------------------------------------------
1 | using System.Globalization;
2 | using MediaBrowser.Common.Configuration;
3 | using MediaBrowser.Common.Plugins;
4 | using MediaBrowser.Model.Plugins;
5 | using MediaBrowser.Model.Serialization;
6 | using Microsoft.AspNetCore.Mvc.Infrastructure;
7 | using Microsoft.Extensions.Hosting;
8 | using Microsoft.Extensions.Logging;
9 |
10 | namespace Jellyfin.Plugin.Meilisearch;
11 |
12 | // ReSharper disable once ClassNeverInstantiated.Global
13 | public class Plugin : BasePlugin, IHasWebPages
14 | {
15 | private readonly MeilisearchClientHolder _clientHolder;
16 | private readonly ILogger _logger;
17 | public readonly Indexer Indexer;
18 | public long AverageSearchTime;
19 |
20 | public Plugin(
21 | IApplicationPaths applicationPaths,
22 | IXmlSerializer xmlSerializer,
23 | ILogger logger,
24 | IServiceProvider serviceProvider,
25 | MeilisearchClientHolder clientHolder,
26 | Indexer indexer,
27 | IActionDescriptorCollectionProvider provider,
28 | IHostApplicationLifetime hostApplicationLifetime
29 | ) : base(
30 | applicationPaths,
31 | xmlSerializer)
32 | {
33 | _logger = logger;
34 | _clientHolder = clientHolder;
35 | Indexer = indexer;
36 | Instance = this;
37 |
38 | ReloadMeilisearch += (_, _) =>
39 | {
40 | logger.LogInformation("Configuration changed, reloading meilisearch...");
41 | TryCreateMeilisearchClient().Wait();
42 | };
43 |
44 | hostApplicationLifetime.ApplicationStarted.Register(() => { _ = TryCreateMeilisearchClient(false); });
45 | hostApplicationLifetime.ApplicationStarted.Register(() => { TryAddFilter(provider, serviceProvider); });
46 | }
47 |
48 | private EventHandler ReloadMeilisearch { get; }
49 |
50 | public override string Name => "Meilisearch";
51 | public override Guid Id => Guid.Parse("974395db-b31d-46a2-bc86-ef9aa5ac04dd");
52 | public static Plugin? Instance { get; private set; }
53 |
54 |
55 | public IEnumerable GetPages()
56 | {
57 | return
58 | [
59 | new PluginPageInfo
60 | {
61 | Name = Name,
62 | EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.config.html",
63 | GetType().Namespace)
64 | }
65 | ];
66 | }
67 |
68 | private void TryAddFilter(IActionDescriptorCollectionProvider provider, IServiceProvider serviceProvider)
69 | {
70 | // I guess this would work purely because this is a plugin and is loaded after ItemsController
71 | var count = provider.AddDynamicFilter(serviceProvider, t =>
72 | {
73 | var sig = $"{t.ControllerTypeInfo.FullName}#{t.MethodInfo.Name}";
74 | if (Configuration.Debug) Console.WriteLine($"\tmethod: {sig}");
75 |
76 | return sig == "Jellyfin.Api.Controllers.ItemsController#GetItems";
77 | });
78 | _logger.LogInformation("Added {Count} action filters", count);
79 | }
80 |
81 | public override void UpdateConfiguration(BasePluginConfiguration configuration)
82 | {
83 | ArgumentNullException.ThrowIfNull(configuration);
84 | var config = (Config)configuration;
85 | var skipReload = Configuration.Url == config.Url && Configuration.ApiKey == config.ApiKey;
86 |
87 | Configuration = config;
88 | SaveConfiguration(Configuration);
89 | ConfigurationChanged?.Invoke(this, configuration);
90 | if (!skipReload)
91 | ReloadMeilisearch.Invoke(this, configuration);
92 | }
93 |
94 | private volatile Task? _updatingTask;
95 |
96 | public async Task TryCreateMeilisearchClient(bool join = true)
97 | {
98 | if (_updatingTask != null)
99 | {
100 | _logger.LogWarning("Meilisearch client configuration is still updating，skipping");
101 | if (join) await _updatingTask;
102 | return;
103 | }
104 |
105 | try
106 | {
107 | _updatingTask = _TryCreateMeilisearchClient();
108 | await _updatingTask;
109 | }
110 | finally
111 | {
112 | _updatingTask = null;
113 | }
114 | }
115 |
116 | private async Task _TryCreateMeilisearchClient()
117 | {
118 | await _clientHolder.Set(Configuration);
119 | await Indexer.Index();
120 | }
121 |
122 |
123 | public void UpdateAverageSearchTime(long averageSearchTime)
124 | {
125 | lock (this)
126 | {
127 | if (AverageSearchTime == 0) AverageSearchTime = averageSearchTime;
128 | AverageSearchTime = (averageSearchTime + AverageSearchTime) / 2;
129 | }
130 | }
131 | }
--------------------------------------------------------------------------------
/.github/workflows/publish.yaml:
--------------------------------------------------------------------------------
1 | name: '🚀 Publish Plugin'
2 |
3 | on:
4 | push:
5 | tags:
6 | - '*'
7 | workflow_dispatch:
8 | inputs:
9 | dotnet-version:
10 | required: false
11 | default: "9.0.x"
12 | description: "The .NET version to setup for the build"
13 | type: string
14 | dotnet-target:
15 | required: false
16 | default: "net9.0"
17 | description: "The .NET target to set for JPRM"
18 | type: string
19 |
20 | jobs:
21 | build:
22 | runs-on: ubuntu-latest
23 | steps:
24 | - name: Checkout Repository
25 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
26 | with:
27 | fetch-depth: '0'
28 |
29 | - name: Setup .NET
30 | uses: actions/setup-dotnet@2016bd2012dba4e32de620c46fe006a3ac9f0602 # v5.0.1
31 | with:
32 | dotnet-version: "${{ inputs.dotnet-version }}"
33 |
34 | - name: Update build.yaml
35 | run: |-
36 | echo "set version to ${GITHUB_REF#refs/tags/}"
37 | sed -i "s/version: .*/version: '${GITHUB_REF#refs/tags/}'/" ./src/build.yaml
38 |
39 | COMMIT_RANGE=$(git describe --tags --abbrev=0 @^)..@
40 | echo "generate changelog for commit range ${COMMIT_RANGE}"
41 | CHANGELOG=$(git log "$COMMIT_RANGE" --oneline --pretty=format:"- [%h] %s")
42 | sed -i 's/changelog: changelog/changelog: |-\n/' ./src/build.yaml
43 | echo -e "$CHANGELOG" | sed 's/^/ /' >> ./src/build.yaml
44 | mkdir -p ./artifacts
45 | echo -e "$CHANGELOG" > ./artifacts/changelog.md
46 |
47 | - name: Build Jellyfin Plugin
48 | uses: oddstr13/jellyfin-plugin-repository-manager@9497a0a499416cc572ed2e07a391d9f943a37b4d # v1.1.1
49 | id: jprm
50 | with:
51 | dotnet-target: "${{ inputs.dotnet-target }}"
52 | path: './src'
53 | output: './artifacts'
54 |
55 | - name: Upload Artifact
56 | uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
57 | with:
58 | name: build-artifact
59 | retention-days: 30
60 | if-no-files-found: error
61 | path: |
62 | ./artifacts/changelog.md
63 | ./artifacts/*.zip
64 |
65 | upload:
66 | needs:
67 | - build
68 | runs-on: ubuntu-latest
69 | steps:
70 | - name: Download Artifact
71 | uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
72 | with:
73 | name: build-artifact
74 |
75 | - name: Prepare GH Release Assets
76 | run: |-
77 | mv ./changelog.md /tmp/changelog.md
78 | for file in ./*; do
79 | md5sum ${file#./} >> ${file%.*}.md5
80 | sha256sum ${file#./} >> ${file%.*}.sha256
81 | done
82 | ls -l
83 |
84 | - name: Upload GH Release Assets
85 | uses: ncipollo/release-action@b7eabc95ff50cbeeedec83973935c8f306dfcd0b # v1.20.0
86 | with:
87 | artifacts: ./*
88 | bodyFile: /tmp/changelog.md
89 |
90 | publish:
91 | needs:
92 | - upload
93 | runs-on: ubuntu-latest
94 | permissions: # Job-level permissions configuration starts here
95 | contents: write # 'write' access to repository contents
96 | pull-requests: write # 'write' access to pull requests
97 | steps:
98 | - name: Checkout Repository
99 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
100 | with:
101 | fetch-depth: '0'
102 | ref: "master"
103 |
104 | - name: Download Artifact
105 | uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
106 | with:
107 | name: build-artifact
108 |
109 | - name: Update manifest.json
110 | run: |-
111 | echo "::group::Installing JPRM"
112 | python3 -m pip install jprm
113 | echo "::endgroup::"
114 |
115 | RELEASE_TAG="${GITHUB_REF#refs/tags/}"
116 | echo "set release tag to ${RELEASE_TAG}, get release info..."
117 | RELEASE_INFO=$(curl -s "https://api.github.com/repos/${{ github.repository }}/releases/tags/${RELEASE_TAG}")
118 | DOWNLOAD_URL=$(echo "$RELEASE_INFO" | jq -r '.assets[] | select(.name | test("\\.zip$")) | .browser_download_url')
119 | echo "download url: ${DOWNLOAD_URL}"
120 |
121 | echo "::group::Updating manifest.json"
122 | jprm repo add ./manifest.json "$(ls -d *.zip)" -u "${DOWNLOAD_URL}" -U "${DOWNLOAD_URL}"
123 | echo "::endgroup::"
124 |
125 | - name: Commit file
126 | run: |-
127 | git config --global user.name "${GITHUB_ACTOR}"
128 | git config --global user.email "github-actions[bot]@users.noreply.github.com"
129 | git commit -a -m "Update manifest.json for release ${GITHUB_REF#refs/tags/}"
130 |
131 | - name: Push changes
132 | uses: ad-m/github-push-action@77c5b412c50b723d2a4fbc6d71fb5723bcd439aa # v1.0.0
133 | with:
134 | github_token: ${{ secrets.GITHUB_TOKEN }}
135 | branch: master
136 |
--------------------------------------------------------------------------------
/src/MeilisearchClientHolder.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Controller;
2 | using Meilisearch;
3 | using Microsoft.Extensions.Logging;
4 | using Index = Meilisearch.Index;
5 |
6 | namespace Jellyfin.Plugin.Meilisearch;
7 |
8 | public class MeilisearchClientHolder(ILogger logger, IServerApplicationHost applicationHost)
9 | {
10 | private readonly SemaphoreSlim _reconnectLock = new(1, 1);
11 | private volatile Config? _lastConfiguration;
12 |
13 | public string Status { get; private set; } = "Not Configured";
14 | public bool Ok => Client != null && Index != null;
15 | public Index? Index { get; private set; }
16 | public MeilisearchClient? Client { get; private set; }
17 |
18 | public Task? Call(Func func)
19 | => Call(async (client, index) =>
20 | {
21 | await func(client, index).ConfigureAwait(false);
22 | return true;
23 | });
24 |
25 | public Task? Call(Func> func)
26 | {
27 | if (!Ok)
28 | {
29 | _ = TryReconnectInBackground("Call invoked while not connected");
30 | return null;
31 | }
32 |
33 | return ExecuteWithReconnectRetryAsync(func);
34 | }
35 |
36 | public void Unset()
37 | {
38 | Client = null;
39 | Index = null;
40 | Status = "Disconnected";
41 | }
42 |
43 | public async Task Set(Config configuration)
44 | {
45 | _lastConfiguration = configuration;
46 | if (string.IsNullOrEmpty(configuration.Url) &&
47 | string.IsNullOrEmpty(Environment.GetEnvironmentVariable("MEILI_URL")))
48 | {
49 | logger.LogWarning("Missing Meilisearch URL");
50 | Client = null;
51 | Index = null;
52 | Status = "Missing Meilisearch URL";
53 | return;
54 | }
55 |
56 | try
57 | {
58 | // Check for environment variable first
59 | var envApiKey = Environment.GetEnvironmentVariable("MEILI_MASTER_KEY");
60 | // Use API key from config if env var is not set
61 | var apiKey = string.IsNullOrEmpty(envApiKey)
62 | ? (string.IsNullOrEmpty(configuration.ApiKey) ? null : configuration.ApiKey)
63 | : envApiKey;
64 | // Check for environment variable first
65 | var envURL = Environment.GetEnvironmentVariable("MEILI_URL");
66 | // Use URL from config if env var is not set
67 | var url = string.IsNullOrEmpty(envURL)
68 | ? (string.IsNullOrEmpty(configuration.Url) ? null : configuration.Url)
69 | : envURL;
70 | Client = new MeilisearchClient(url, apiKey);
71 | Index = await GetIndex(Client, configuration.IndexName).ConfigureAwait(false);
72 | await UpdateMeilisearchHealthAsync().ConfigureAwait(false);
73 | }
74 | catch (Exception e)
75 | {
76 | Status = e.Message;
77 | Client = null;
78 | Index = null;
79 | logger.LogError(e, "Failed to create MeilisearchClient");
80 | }
81 | }
82 |
83 | private async Task UpdateMeilisearchHealthAsync()
84 | {
85 | if (Client == null)
86 | {
87 | Status = "Server not configured";
88 | return;
89 | }
90 |
91 | try
92 | {
93 | var health = await Client.HealthAsync().ConfigureAwait(false);
94 | Status = $"Server: {health.Status}";
95 | }
96 | catch (Exception e)
97 | {
98 | Status = $"Error: {e.Message}";
99 | logger.LogWarning(e, "Meilisearch health check failed");
100 | }
101 | }
102 |
103 | private async Task GetIndex(MeilisearchClient meilisearch, string? configuredIndexName)
104 | {
105 | var sanitizedConfigName = applicationHost.FriendlyName.Replace(" ", "-");
106 | var indexName = string.IsNullOrEmpty(configuredIndexName) ? sanitizedConfigName : configuredIndexName;
107 | var index = meilisearch.Index(indexName);
108 |
109 | await index.UpdateFilterableAttributesAsync(
110 | ["type", "parentId", "isFolder"]
111 | );
112 |
113 | await index.UpdateSortableAttributesAsync(
114 | ["communityRating", "criticRating"]
115 | );
116 |
117 | await index.UpdateSearchableAttributesAsync(Config.DefaultAttributesToSearchOn);
118 | await index.UpdateDisplayedAttributesAsync(Config.DefaultAttributesToSearchOn.Concat(["guid", "type"]));
119 |
120 | // Set ranking rules to add critic rating
121 | await index.UpdateRankingRulesAsync(
122 | [
123 | "words", "typo", "proximity", "attribute", "sort", "exactness", "communityRating:desc",
124 | "criticRating:desc"
125 | ]
126 | );
127 | return index;
128 | }
129 |
130 | private async Task ExecuteWithReconnectRetryAsync(Func> func)
131 | {
132 | try
133 | {
134 | return await func(Client!, Index!).ConfigureAwait(false);
135 | }
136 | catch (Exception e) when (IsReconnectable(e))
137 | {
138 | logger.LogWarning(e, "Meilisearch request failed; will reset client and try reconnect");
139 | Unset();
140 | await TryReconnectAsync("request failed", e).ConfigureAwait(false);
141 |
142 | if (!Ok)
143 | {
144 | throw;
145 | }
146 |
147 | return await func(Client!, Index!).ConfigureAwait(false);
148 | }
149 | }
150 |
151 | private async Task TryReconnectAsync(string reason, Exception? exception = null)
152 | {
153 | var configuration = _lastConfiguration;
154 | if (configuration == null)
155 | {
156 | logger.LogDebug("Skipping reconnect: no configuration cached (reason={Reason})", reason);
157 | return;
158 | }
159 |
160 | await _reconnectLock.WaitAsync().ConfigureAwait(false);
161 | try
162 | {
163 | if (Ok)
164 | {
165 | return;
166 | }
167 |
168 | logger.LogInformation(exception, "Reconnecting to Meilisearch (reason={Reason})", reason);
169 | await Set(configuration).ConfigureAwait(false);
170 | }
171 | finally
172 | {
173 | _reconnectLock.Release();
174 | }
175 | }
176 |
177 | private Task TryReconnectInBackground(string reason)
178 | {
179 | if (_lastConfiguration == null)
180 | {
181 | return Task.CompletedTask;
182 | }
183 |
184 | return Task.Run(() => TryReconnectAsync(reason));
185 | }
186 |
187 | private static bool IsReconnectable(Exception e)
188 | {
189 | return e is MeilisearchCommunicationError
190 | || e is HttpRequestException
191 | || e is TaskCanceledException
192 | || e is TimeoutException;
193 | }
194 | }
--------------------------------------------------------------------------------
/src/MeilisearchMutateFilter.cs:
--------------------------------------------------------------------------------
1 | using MediaBrowser.Controller.Channels;
2 | using MediaBrowser.Controller.Entities;
3 | using MediaBrowser.Controller.Entities.Audio;
4 | using MediaBrowser.Controller.Entities.Movies;
5 | using MediaBrowser.Controller.Entities.TV;
6 | using MediaBrowser.Controller.Library;
7 | using MediaBrowser.Controller.LiveTv;
8 | using MediaBrowser.Controller.Playlists;
9 | using MediaBrowser.Model.Dto;
10 | using MediaBrowser.Model.Querying;
11 | using Meilisearch;
12 | using Microsoft.AspNetCore.Mvc;
13 | using Microsoft.AspNetCore.Mvc.Filters;
14 | using Microsoft.Extensions.Logging;
15 | using Microsoft.Extensions.Primitives;
16 | using System.Collections.Frozen;
17 | using System.Collections.Immutable;
18 | using System.Collections.ObjectModel;
19 | using System.Diagnostics;
20 | using System.Globalization;
21 | using Jellyfin.Data;
22 | using Jellyfin.Database.Implementations.Entities;
23 | using Jellyfin.Database.Implementations.Enums;
24 | using Jellyfin.Extensions;
25 | using MediaBrowser.Controller.Dto;
26 | using MediaBrowser.Controller.Net;
27 | using MediaBrowser.Model.Entities;
28 | using Index = Meilisearch.Index;
29 |
30 | namespace Jellyfin.Plugin.Meilisearch;
31 |
32 | // ReSharper disable once ClassNeverInstantiated.Global
33 | public class MeilisearchMutateFilter(
34 | MeilisearchClientHolder ch,
35 | ILogger logger,
36 | ILibraryManager libraryManager,
37 | IUserManager userManager,
38 | IDtoService dtoService
39 | ) : IAsyncActionFilter
40 | {
41 | // Build the Jellyfin type map dynamically
42 | private IReadOnlyDictionary JellyfinTypeMap { get; } = new Dictionary()
43 | {
44 | { "AggregateFolder", typeof(AggregateFolder).FullName! },
45 | { "Audio", typeof(Audio).FullName! },
46 | { "AudioBook", typeof(AudioBook).FullName! },
47 | { "BasePluginFolder", typeof(BasePluginFolder).FullName! },
48 | { "Book", typeof(Book).FullName! },
49 | { "BoxSet", typeof(BoxSet).FullName! },
50 | { "Channel", typeof(Channel).FullName! },
51 | { "CollectionFolder", typeof(CollectionFolder).FullName! },
52 | { "Episode", typeof(Episode).FullName! },
53 | { "Folder", typeof(Folder).FullName! },
54 | { "Genre", typeof(Genre).FullName! },
55 | { "Movie", typeof(Movie).FullName! },
56 | { "LiveTvChannel", typeof(LiveTvChannel).FullName! },
57 | { "LiveTvProgram", typeof(LiveTvProgram).FullName! },
58 | { "MusicAlbum", typeof(MusicAlbum).FullName! },
59 | { "MusicArtist", typeof(MusicArtist).FullName! },
60 | { "MusicGenre", typeof(MusicGenre).FullName! },
61 | { "MusicVideo", typeof(MusicVideo).FullName! },
62 | { "Person", typeof(Person).FullName! },
63 | { "Photo", typeof(Photo).FullName! },
64 | { "PhotoAlbum", typeof(PhotoAlbum).FullName! },
65 | { "Playlist", typeof(Playlist).FullName! },
66 | { "PlaylistsFolder", "Emby.Server.Implementations.Playlists.PlaylistsFolder" },
67 | { "Season", typeof(Season).FullName! },
68 | { "Series", typeof(Series).FullName! },
69 | { "Studio", typeof(Studio).FullName! },
70 | { "Trailer", typeof(Trailer).FullName! },
71 | { "TvChannel", typeof(LiveTvChannel).FullName! },
72 | { "TvProgram", typeof(LiveTvProgram).FullName! },
73 | { "UserRootFolder", typeof(UserRootFolder).FullName! },
74 | { "UserView", typeof(UserView).FullName! },
75 | { "Video", typeof(Video).FullName! },
76 | { "Year", typeof(Year).FullName! }
77 | }.ToFrozenDictionary();
78 |
79 | ///
80 | /// check if the user is api key https://github.com/jellyfin/jellyfin/blob/master/Jellyfin.Api/Extensions/ClaimsPrincipalExtensions.cs #GetIsApiKey
81 | ///
82 | /// The action context
83 | /// The action execution delegate
84 | /// bool if the user is api-key
85 | public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
86 | {
87 | if (context.GetIsApiKey())
88 | {
89 | // we not handle the request if user is authenticated by api key
90 | await next();
91 | return;
92 | }
93 |
94 | var user = context.GetUser(userManager);
95 | if (user is null)
96 | {
97 | // we not handle the request if user is null
98 | await next();
99 | return;
100 | }
101 |
102 | var path = context.HttpContext.Request.Path.ToString();
103 | logger.LogDebug("path={path} query={query}", path, context.HttpContext.Request.QueryString);
104 |
105 | var searchTerm = context.GetSearchTerm();
106 | if (!string.IsNullOrEmpty(searchTerm))
107 | {
108 | logger.LogDebug("path={path} searchTerm={searchTerm}", path, searchTerm);
109 | var stopwatch = Stopwatch.StartNew();
110 | var result = await Mutate(context, user, searchTerm);
111 | stopwatch.Stop();
112 | Plugin.Instance?.UpdateAverageSearchTime(stopwatch.ElapsedMilliseconds);
113 |
114 | if (result.SkipNext)
115 | {
116 | context.HttpContext.Response.Headers.Add(new KeyValuePair(
117 | "x-meilisearch-result",
118 | $"{stopwatch.ElapsedMilliseconds}ms, count={result.Count}, skip={result.SkipNext}"));
119 | return;
120 | }
121 | }
122 |
123 | await next();
124 | }
125 |
126 |
127 | private async Task> Search(
128 | Index index,
129 | string searchTerm,
130 | List itemTypes,
131 | List> additionalFilters,
132 | int limitPerType
133 | )
134 | {
135 | List items = [];
136 | try
137 | {
138 | var additionQuery = additionalFilters.Select(it => $"{it.Key} = {it.Value}").ToList();
139 | var additionQueryStr = additionQuery.Count > 0 ? $" AND {string.Join(" AND ", additionQuery)}" : "";
140 | foreach (var itemType in itemTypes)
141 | {
142 | var results = await index.SearchAsync(
143 | searchTerm,
144 | new SearchQuery
145 | {
146 | Filter = $"type = \"{itemType}\" {additionQueryStr}",
147 | Limit = limitPerType,
148 | AttributesToSearchOn = Plugin.Instance?.Configuration.AttributesToSearchOn
149 | }
150 | );
151 | items.AddRange(results.Hits);
152 | }
153 | }
154 | catch (MeilisearchCommunicationError e)
155 | {
156 | logger.LogError(e, "Meilisearch communication error");
157 | ch.Unset();
158 | }
159 |
160 | return items;
161 | }
162 |
163 |
164 | ///
165 | /// Mutates the current search request context by overriding the ids with the results of the Meilisearch query.
166 | /// This part code now is somewhat copied or adapted from Jellysearch.
167 | ///
168 | /// The action context.
169 | /// User who doing the search
170 | /// The search term.
171 | ///
172 | /// If the search term is empty, or if there are no results, the method does nothing.
173 | ///
174 | /// A task representing the asynchronous operation.
175 | private async Task Mutate(ActionExecutingContext context, User user, string searchTerm)
176 | {
177 | if (!ch.Ok || ch.Index == null)
178 | {
179 | logger.LogWarning(
180 | "Meilisearch is not configured or unable to connect, skipping search mutation, will fallback to Jellyfin");
181 | Plugin.Instance?.TryCreateMeilisearchClient(false);
182 | return new MutateResult(false, 0);
183 | }
184 |
185 | var filteredTypes = new List();
186 | var additionalFilters = new List>();
187 |
188 | // includeItemTypes add types from the search
189 | var includeItemTypes = context.GetQueryCommaOrMulti("includeItemTypes");
190 | logger.LogDebug("includeItemTypes={includeItemTypes}", string.Join(", ", includeItemTypes));
191 | filteredTypes.AddRange(ToJellyfinTypes(includeItemTypes));
192 |
193 | // excludeItemTypes remove types from the search
194 | var excludeItemTypes = context.GetQueryCommaOrMulti("excludeItemTypes");
195 | logger.LogDebug("excludeItemTypes={excludeItemTypes}", string.Join(", ", excludeItemTypes));
196 | ToJellyfinTypes(excludeItemTypes).ToImmutableList().ForEach(it => filteredTypes.Remove(it));
197 |
198 |
199 | // mediaTypes add types from the search
200 | var mediaTypes = context.GetQueryCommaOrMulti("mediaTypes");
201 | logger.LogDebug("mediaTypes={mediaTypes}", string.Join(", ", mediaTypes));
202 | if (mediaTypes != null && mediaTypes.Count > 0)
203 | {
204 | // If mediaTypes is set, we only search for those types
205 | filteredTypes.AddRange(ToJellyfinTypes(mediaTypes));
206 | }
207 | else
208 | {
209 | var path = context.HttpContext.Request.Path.ToString();
210 | // Handle direct endpoints and their types
211 | if (path.EndsWith("/Persons", true, CultureInfo.InvariantCulture))
212 | {
213 | filteredTypes.Add(JellyfinTypeMap["Person"]);
214 | }
215 | else if (path.EndsWith("/Artists", true, CultureInfo.InvariantCulture))
216 | {
217 | filteredTypes.Add(JellyfinTypeMap["MusicArtist"]);
218 | }
219 | else if (path.EndsWith("/AlbumArtists", true, CultureInfo.InvariantCulture))
220 | {
221 | // Album artists are marked as folder
222 | filteredTypes.Add(JellyfinTypeMap["MusicArtist"]);
223 | additionalFilters.Add(new KeyValuePair("isFolder", "true"));
224 | }
225 | else if (path.EndsWith("/Genres", true, CultureInfo.InvariantCulture))
226 | {
227 | filteredTypes.Add(JellyfinTypeMap["Genre"]); // TODO: Handle genre search properly
228 | }
229 | }
230 |
231 | var limit = context.ActionArguments.TryGetValue("limit", out var limitObj)
232 | ? (int)limitObj!
233 | : 0;
234 | var limitPreItem = filteredTypes.Count > 0 && limit > 0
235 | ? Math.Clamp(limit / filteredTypes.Count, 30, 100)
236 | : 30;
237 | var meilisearchItems = await Search(ch.Index, searchTerm, filteredTypes, additionalFilters, limitPreItem);
238 |
239 | // remove items that are not visible to the user
240 | var items = meilisearchItems.Select(it =>
241 | {
242 | var item = libraryManager.GetItemById(Guid.Parse(it.Guid));
243 | return (item?.IsVisibleStandalone(user) ?? false) ? item : null;
244 | }).Where(it => it is not null)!.ToImmutableList();
245 |
246 |
247 | var notFallback = !(Plugin.Instance?.Configuration.FallbackToJellyfin ?? false);
248 | if (items.Count > 0 || notFallback)
249 | {
250 | SetQueryResult(context, user, items);
251 | return new MutateResult(true, items.Count);
252 | }
253 |
254 | logger.LogDebug("Not mutate request: results={hits}, fallback={fallback}", items.Count, !notFallback);
255 | return new MutateResult(notFallback, items.Count);
256 | }
257 |
258 | private IEnumerable ToJellyfinTypes(IEnumerable types)
259 | {
260 | foreach (var type in types)
261 | {
262 | if (JellyfinTypeMap.TryGetValue(type, out var jellyfinType))
263 | {
264 | yield return jellyfinType;
265 | }
266 | else
267 | {
268 | logger.LogWarning("ToJellyfinTypes: no mapping for '{mediaType}'", type);
269 | }
270 | }
271 | }
272 |
273 | private record MutateResult(bool SkipNext, int Count);
274 |
275 | private void SetQueryResult(ActionExecutingContext context, User user, ImmutableList items)
276 | {
277 | var fields = context.ActionArguments.TryGetValue("fields", out var fieldsObj)
278 | ? (ItemFields[])fieldsObj!
279 | : [];
280 | if (user.GetPreference(PreferenceKind.AllowedTags).Length != 0 && !fields.Contains(ItemFields.Tags))
281 | {
282 | fields = [..fields, ItemFields.Tags];
283 | }
284 |
285 | // ReSharper disable once SimplifyConditionalTernaryExpression for readability
286 | var enableImages = context.ActionArguments.TryGetValue("enableImages", out var enableImagesObj)
287 | ? (bool)enableImagesObj!
288 | : true;
289 | var enableUserData = context.ActionArguments.TryGetValue("enableUserData", out var enableUserDataObj)
290 | ? (bool?)enableUserDataObj
291 | : null;
292 | var imageTypeLimit = context.ActionArguments.TryGetValue("imageTypeLimit", out var imageTypeLimitObj)
293 | ? (int?)imageTypeLimitObj
294 | : null;
295 | var enableImageTypes = context.ActionArguments.TryGetValue("enableImageTypes", out var enableImageTypesObj)
296 | ? (ImageType[])enableImageTypesObj!
297 | : [];
298 | var dtoOptions = new DtoOptions { Fields = fields }
299 | .AddClientFields(context)
300 | .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
301 | context.Result = new OkObjectResult(new QueryResult
302 | {
303 | Items = dtoService.GetBaseItemDtos(items, dtoOptions),
304 | TotalRecordCount = items.Count,
305 | StartIndex = 0
306 | });
307 | }
308 | }
309 |
310 | public static class ActionExecutingContextExtensions
311 | {
312 | public static string? GetUserClaimValue(this ActionExecutingContext context, string name) =>
313 | context.HttpContext.User.Claims
314 | .FirstOrDefault(claim => claim.Type.Equals(name, StringComparison.OrdinalIgnoreCase))?.Value;
315 |
316 | public static bool GetIsApiKey(this ActionExecutingContext context) =>
317 | bool.TryParse(context.GetUserClaimValue("Jellyfin-IsApiKey"), out var parsedClaimValue) && parsedClaimValue;
318 |
319 | public static User? GetUser(this ActionExecutingContext context, IUserManager userManager)
320 | {
321 | var userId = context.ActionArguments.TryGetValue("userId", out var value) ? (Guid?)value : null;
322 | var claimUserId = context.GetUserClaimValue("Jellyfin-UserId");
323 | var claimUserGuid = string.IsNullOrEmpty(claimUserId) ? Guid.Empty : Guid.Parse(claimUserId);
324 |
325 | // UserId not provided, fall back to authenticated user id.
326 | if (userId.IsNullOrEmpty())
327 | {
328 | return userManager.GetUserById(claimUserGuid);
329 | }
330 |
331 | // User must be administrator to access another user.
332 | var isAdministrator = context.HttpContext.User.IsInRole("Administrator");
333 | if (!userId.Value.Equals(claimUserGuid) && !isAdministrator)
334 | {
335 | throw new SecurityException("Forbidden");
336 | }
337 |
338 | return userManager.GetUserById(userId.Value);
339 | }
340 |
341 | /// should be ["/Users/{userId}/Items", "/Persons", "/Artists/AlbumArtists", "/Artists", "/Genres"];
342 | /// but now only /Items
343 | private static readonly Collection MatchingPaths = ["/Items"];
344 |
345 |
346 | public static string? GetSearchTerm(this ActionExecutingContext context)
347 | {
348 | if (!MatchingPaths.Contains(context.HttpContext.Request.Path)) return null;
349 | if (!context.ActionArguments.TryGetValue("searchTerm", out var searchTermObj)) return null;
350 | var searchTerm = (string?)searchTermObj;
351 | return searchTerm is not { Length: > 0 } ? null : searchTerm;
352 | }
353 |
354 | ///
355 | /// Parse a query parameter that may contain comma delimited values or multiple values.
356 | ///
357 | /// The HttpContext extension.
358 | /// The query parameter name.
359 | /// The list of values.
360 | public static ImmutableList GetQueryCommaOrMulti(this ActionExecutingContext context, string key)
361 | {
362 | if (!context.HttpContext.Request.Query.TryGetValue(key, out var values) || StringValues.IsNullOrEmpty(values))
363 | return ImmutableList.Empty; // no values
364 | var types = values.SelectMany(it =>
365 | it?.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries) ?? []);
366 | return types.ToImmutableList();
367 | }
368 | }
369 |
370 | ///
371 | /// copy from https://github.com/jellyfin/jellyfin/blob/master/Jellyfin.Api/Extensions/DtoExtensions.cs
372 | ///
373 | public static class DtoExtensions
374 | {
375 | internal static DtoOptions AddClientFields(
376 | this DtoOptions dtoOptions, ActionExecutingContext context)
377 | {
378 | var client = context.GetUserClaimValue("Jellyfin-Client");
379 |
380 | // No client in claim
381 | if (string.IsNullOrEmpty(client))
382 | {
383 | return dtoOptions;
384 | }
385 |
386 | if (!dtoOptions.ContainsField(ItemFields.RecursiveItemCount))
387 | {
388 | if (client.Contains("kodi", StringComparison.OrdinalIgnoreCase) ||
389 | client.Contains("wmc", StringComparison.OrdinalIgnoreCase) ||
390 | client.Contains("media center", StringComparison.OrdinalIgnoreCase) ||
391 | client.Contains("classic", StringComparison.OrdinalIgnoreCase))
392 | {
393 | dtoOptions.Fields = [..dtoOptions.Fields, ItemFields.RecursiveItemCount];
394 | }
395 | }
396 |
397 | if (dtoOptions.ContainsField(ItemFields.ChildCount)) return dtoOptions;
398 | if (client.Contains("kodi", StringComparison.OrdinalIgnoreCase) ||
399 | client.Contains("wmc", StringComparison.OrdinalIgnoreCase) ||
400 | client.Contains("media center", StringComparison.OrdinalIgnoreCase) ||
401 | client.Contains("classic", StringComparison.OrdinalIgnoreCase) ||
402 | client.Contains("roku", StringComparison.OrdinalIgnoreCase) ||
403 | client.Contains("samsung", StringComparison.OrdinalIgnoreCase) ||
404 | client.Contains("androidtv", StringComparison.OrdinalIgnoreCase))
405 | {
406 | dtoOptions.Fields = [..dtoOptions.Fields, ItemFields.ChildCount];
407 | }
408 |
409 | return dtoOptions;
410 | }
411 |
412 | internal static DtoOptions AddAdditionalDtoOptions(
413 | this DtoOptions dtoOptions,
414 | bool? enableImages,
415 | bool? enableUserData,
416 | int? imageTypeLimit,
417 | IReadOnlyList enableImageTypes)
418 | {
419 | dtoOptions.EnableImages = enableImages ?? true;
420 |
421 | if (imageTypeLimit.HasValue)
422 | {
423 | dtoOptions.ImageTypeLimit = imageTypeLimit.Value;
424 | }
425 |
426 | if (enableUserData.HasValue)
427 | {
428 | dtoOptions.EnableUserData = enableUserData.Value;
429 | }
430 |
431 | if (enableImageTypes.Count != 0)
432 | {
433 | dtoOptions.ImageTypes = enableImageTypes;
434 | }
435 |
436 | return dtoOptions;
437 | }
438 | }
--------------------------------------------------------------------------------
/src/config.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Meilisearch
6 |
7 |
8 |
11 |
12 |
13 |
14 |
44 |
45 |
46 |
47 | Status
48 |
53 |
59 |
65 |
66 |
(this is a placeholder)
68 |
69 |
70 | Config
71 |
115 |
116 |
117 |
283 |
284 |
285 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 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 General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------