| | | 1 | | using System; |
| | | 2 | | using System.ComponentModel; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Globalization; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Threading.Tasks; |
| | | 7 | | using Jellyfin.Api.Helpers; |
| | | 8 | | using Jellyfin.Api.ModelBinders; |
| | | 9 | | using Jellyfin.Data.Enums; |
| | | 10 | | using Jellyfin.Extensions; |
| | | 11 | | using MediaBrowser.Controller.Drawing; |
| | | 12 | | using MediaBrowser.Controller.Dto; |
| | | 13 | | using MediaBrowser.Controller.Entities; |
| | | 14 | | using MediaBrowser.Controller.Entities.Audio; |
| | | 15 | | using MediaBrowser.Controller.Entities.TV; |
| | | 16 | | using MediaBrowser.Controller.Library; |
| | | 17 | | using MediaBrowser.Controller.LiveTv; |
| | | 18 | | using MediaBrowser.Model.Entities; |
| | | 19 | | using MediaBrowser.Model.Search; |
| | | 20 | | using Microsoft.AspNetCore.Authorization; |
| | | 21 | | using Microsoft.AspNetCore.Http; |
| | | 22 | | using Microsoft.AspNetCore.Mvc; |
| | | 23 | | |
| | | 24 | | namespace Jellyfin.Api.Controllers; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Search controller. |
| | | 28 | | /// </summary> |
| | | 29 | | [Route("Search/Hints")] |
| | | 30 | | [Authorize] |
| | | 31 | | public class SearchController : BaseJellyfinApiController |
| | | 32 | | { |
| | | 33 | | private readonly ISearchManager _searchManager; |
| | | 34 | | private readonly ILibraryManager _libraryManager; |
| | | 35 | | private readonly IDtoService _dtoService; |
| | | 36 | | private readonly IImageProcessor _imageProcessor; |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Initializes a new instance of the <see cref="SearchController"/> class. |
| | | 40 | | /// </summary> |
| | | 41 | | /// <param name="searchManager">Instance of <see cref="ISearchManager"/> interface.</param> |
| | | 42 | | /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param> |
| | | 43 | | /// <param name="dtoService">Instance of <see cref="IDtoService"/> interface.</param> |
| | | 44 | | /// <param name="imageProcessor">Instance of <see cref="IImageProcessor"/> interface.</param> |
| | 0 | 45 | | public SearchController( |
| | 0 | 46 | | ISearchManager searchManager, |
| | 0 | 47 | | ILibraryManager libraryManager, |
| | 0 | 48 | | IDtoService dtoService, |
| | 0 | 49 | | IImageProcessor imageProcessor) |
| | | 50 | | { |
| | 0 | 51 | | _searchManager = searchManager; |
| | 0 | 52 | | _libraryManager = libraryManager; |
| | 0 | 53 | | _dtoService = dtoService; |
| | 0 | 54 | | _imageProcessor = imageProcessor; |
| | 0 | 55 | | } |
| | | 56 | | |
| | | 57 | | /// <summary> |
| | | 58 | | /// Gets the search hint result. |
| | | 59 | | /// </summary> |
| | | 60 | | /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr |
| | | 61 | | /// <param name="limit">Optional. The maximum number of records to return.</param> |
| | | 62 | | /// <param name="userId">Optional. Supply a user id to search within a user's library or omit to search all.</param> |
| | | 63 | | /// <param name="searchTerm">The search term to filter on.</param> |
| | | 64 | | /// <param name="includeItemTypes">If specified, only results with the specified item types are returned. This allow |
| | | 65 | | /// <param name="excludeItemTypes">If specified, results with these item types are filtered out. This allows multipl |
| | | 66 | | /// <param name="mediaTypes">If specified, only results with the specified media types are returned. This allows mul |
| | | 67 | | /// <param name="parentId">If specified, only children of the parent are returned.</param> |
| | | 68 | | /// <param name="isMovie">Optional filter for movies.</param> |
| | | 69 | | /// <param name="isSeries">Optional filter for series.</param> |
| | | 70 | | /// <param name="isNews">Optional filter for news.</param> |
| | | 71 | | /// <param name="isKids">Optional filter for kids.</param> |
| | | 72 | | /// <param name="isSports">Optional filter for sports.</param> |
| | | 73 | | /// <param name="includePeople">Optional filter whether to include people.</param> |
| | | 74 | | /// <param name="includeMedia">Optional filter whether to include media.</param> |
| | | 75 | | /// <param name="includeGenres">Optional filter whether to include genres.</param> |
| | | 76 | | /// <param name="includeStudios">Optional filter whether to include studios.</param> |
| | | 77 | | /// <param name="includeArtists">Optional filter whether to include artists.</param> |
| | | 78 | | /// <response code="200">Search hint returned.</response> |
| | | 79 | | /// <returns>An <see cref="SearchHintResult"/> with the results of the search.</returns> |
| | | 80 | | [HttpGet] |
| | | 81 | | [Description("Gets search hints based on a search term")] |
| | | 82 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 83 | | public async Task<ActionResult<SearchHintResult>> GetSearchHints( |
| | | 84 | | [FromQuery] int? startIndex, |
| | | 85 | | [FromQuery] int? limit, |
| | | 86 | | [FromQuery] Guid? userId, |
| | | 87 | | [FromQuery, Required] string searchTerm, |
| | | 88 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes, |
| | | 89 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes, |
| | | 90 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes, |
| | | 91 | | [FromQuery] Guid? parentId, |
| | | 92 | | [FromQuery] bool? isMovie, |
| | | 93 | | [FromQuery] bool? isSeries, |
| | | 94 | | [FromQuery] bool? isNews, |
| | | 95 | | [FromQuery] bool? isKids, |
| | | 96 | | [FromQuery] bool? isSports, |
| | | 97 | | [FromQuery] bool includePeople = true, |
| | | 98 | | [FromQuery] bool includeMedia = true, |
| | | 99 | | [FromQuery] bool includeGenres = true, |
| | | 100 | | [FromQuery] bool includeStudios = true, |
| | | 101 | | [FromQuery] bool includeArtists = true) |
| | | 102 | | { |
| | 0 | 103 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 104 | | var result = await _searchManager.GetSearchHintsAsync(new SearchQuery |
| | 0 | 105 | | { |
| | 0 | 106 | | Limit = limit, |
| | 0 | 107 | | SearchTerm = searchTerm, |
| | 0 | 108 | | IncludeArtists = includeArtists, |
| | 0 | 109 | | IncludeGenres = includeGenres, |
| | 0 | 110 | | IncludeMedia = includeMedia, |
| | 0 | 111 | | IncludePeople = includePeople, |
| | 0 | 112 | | IncludeStudios = includeStudios, |
| | 0 | 113 | | StartIndex = startIndex, |
| | 0 | 114 | | UserId = userId.Value, |
| | 0 | 115 | | IncludeItemTypes = includeItemTypes, |
| | 0 | 116 | | ExcludeItemTypes = excludeItemTypes, |
| | 0 | 117 | | MediaTypes = mediaTypes, |
| | 0 | 118 | | ParentId = parentId, |
| | 0 | 119 | | |
| | 0 | 120 | | IsKids = isKids, |
| | 0 | 121 | | IsMovie = isMovie, |
| | 0 | 122 | | IsNews = isNews, |
| | 0 | 123 | | IsSeries = isSeries, |
| | 0 | 124 | | IsSports = isSports |
| | 0 | 125 | | }).ConfigureAwait(false); |
| | | 126 | | |
| | 0 | 127 | | return new SearchHintResult(result.Items.Select(GetSearchHintResult).ToArray(), result.TotalRecordCount); |
| | 0 | 128 | | } |
| | | 129 | | |
| | | 130 | | /// <summary> |
| | | 131 | | /// Gets the search hint result. |
| | | 132 | | /// </summary> |
| | | 133 | | /// <param name="hintInfo">The hint info.</param> |
| | | 134 | | /// <returns>SearchHintResult.</returns> |
| | | 135 | | private SearchHint GetSearchHintResult(SearchHintInfo hintInfo) |
| | | 136 | | { |
| | 0 | 137 | | var item = hintInfo.Item; |
| | | 138 | | |
| | 0 | 139 | | var result = new SearchHint |
| | 0 | 140 | | { |
| | 0 | 141 | | Name = item.Name, |
| | 0 | 142 | | IndexNumber = item.IndexNumber, |
| | 0 | 143 | | ParentIndexNumber = item.ParentIndexNumber, |
| | 0 | 144 | | Id = item.Id, |
| | 0 | 145 | | Type = item.GetBaseItemKind(), |
| | 0 | 146 | | MediaType = item.MediaType, |
| | 0 | 147 | | MatchedTerm = hintInfo.MatchedTerm, |
| | 0 | 148 | | RunTimeTicks = item.RunTimeTicks, |
| | 0 | 149 | | ProductionYear = item.ProductionYear, |
| | 0 | 150 | | ChannelId = item.ChannelId, |
| | 0 | 151 | | EndDate = item.EndDate |
| | 0 | 152 | | }; |
| | | 153 | | |
| | | 154 | | #pragma warning disable CS0618 |
| | | 155 | | // Kept for compatibility with older clients |
| | 0 | 156 | | result.ItemId = result.Id; |
| | | 157 | | #pragma warning restore CS0618 |
| | | 158 | | |
| | 0 | 159 | | if (item.IsFolder) |
| | | 160 | | { |
| | 0 | 161 | | result.IsFolder = true; |
| | | 162 | | } |
| | | 163 | | |
| | 0 | 164 | | var primaryImageTag = _imageProcessor.GetImageCacheTag(item, ImageType.Primary); |
| | | 165 | | |
| | 0 | 166 | | if (primaryImageTag is not null) |
| | | 167 | | { |
| | 0 | 168 | | result.PrimaryImageTag = primaryImageTag; |
| | 0 | 169 | | result.PrimaryImageAspectRatio = _dtoService.GetPrimaryImageAspectRatio(item); |
| | | 170 | | } |
| | | 171 | | |
| | 0 | 172 | | SetThumbImageInfo(result, item); |
| | 0 | 173 | | SetBackdropImageInfo(result, item); |
| | | 174 | | |
| | | 175 | | switch (item) |
| | | 176 | | { |
| | | 177 | | case IHasSeries hasSeries: |
| | 0 | 178 | | result.Series = hasSeries.SeriesName; |
| | 0 | 179 | | break; |
| | | 180 | | case LiveTvProgram program: |
| | 0 | 181 | | result.StartDate = program.StartDate; |
| | 0 | 182 | | break; |
| | | 183 | | case Series series: |
| | 0 | 184 | | if (series.Status.HasValue) |
| | | 185 | | { |
| | 0 | 186 | | result.Status = series.Status.Value.ToString(); |
| | | 187 | | } |
| | | 188 | | |
| | 0 | 189 | | break; |
| | | 190 | | case MusicAlbum album: |
| | 0 | 191 | | result.Artists = album.Artists; |
| | 0 | 192 | | result.AlbumArtist = album.AlbumArtist; |
| | 0 | 193 | | break; |
| | | 194 | | case Audio song: |
| | 0 | 195 | | result.AlbumArtist = song.AlbumArtists?.FirstOrDefault(); |
| | 0 | 196 | | result.Artists = song.Artists; |
| | | 197 | | |
| | 0 | 198 | | MusicAlbum musicAlbum = song.AlbumEntity; |
| | | 199 | | |
| | 0 | 200 | | if (musicAlbum is not null) |
| | | 201 | | { |
| | 0 | 202 | | result.Album = musicAlbum.Name; |
| | 0 | 203 | | result.AlbumId = musicAlbum.Id; |
| | | 204 | | } |
| | | 205 | | else |
| | | 206 | | { |
| | 0 | 207 | | result.Album = song.Album; |
| | | 208 | | } |
| | | 209 | | |
| | | 210 | | break; |
| | | 211 | | } |
| | | 212 | | |
| | 0 | 213 | | if (!item.ChannelId.IsEmpty()) |
| | | 214 | | { |
| | 0 | 215 | | var channel = _libraryManager.GetItemById<BaseItem>(item.ChannelId); |
| | 0 | 216 | | result.ChannelName = channel?.Name; |
| | | 217 | | } |
| | | 218 | | |
| | 0 | 219 | | return result; |
| | | 220 | | } |
| | | 221 | | |
| | | 222 | | private void SetThumbImageInfo(SearchHint hint, BaseItem item) |
| | | 223 | | { |
| | 0 | 224 | | var itemWithImage = item.HasImage(ImageType.Thumb) ? item : null; |
| | | 225 | | |
| | 0 | 226 | | if (itemWithImage is null && item is Episode) |
| | | 227 | | { |
| | 0 | 228 | | itemWithImage = GetParentWithImage<Series>(item, ImageType.Thumb); |
| | | 229 | | } |
| | | 230 | | |
| | 0 | 231 | | itemWithImage ??= GetParentWithImage<BaseItem>(item, ImageType.Thumb); |
| | | 232 | | |
| | 0 | 233 | | if (itemWithImage is not null) |
| | | 234 | | { |
| | 0 | 235 | | var tag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Thumb); |
| | | 236 | | |
| | 0 | 237 | | if (tag is not null) |
| | | 238 | | { |
| | 0 | 239 | | hint.ThumbImageTag = tag; |
| | 0 | 240 | | hint.ThumbImageItemId = itemWithImage.Id.ToString("N", CultureInfo.InvariantCulture); |
| | | 241 | | } |
| | | 242 | | } |
| | 0 | 243 | | } |
| | | 244 | | |
| | | 245 | | private void SetBackdropImageInfo(SearchHint hint, BaseItem item) |
| | | 246 | | { |
| | 0 | 247 | | var itemWithImage = (item.HasImage(ImageType.Backdrop) ? item : null) |
| | 0 | 248 | | ?? GetParentWithImage<BaseItem>(item, ImageType.Backdrop); |
| | | 249 | | |
| | 0 | 250 | | if (itemWithImage is not null) |
| | | 251 | | { |
| | 0 | 252 | | var tag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Backdrop); |
| | | 253 | | |
| | 0 | 254 | | if (tag is not null) |
| | | 255 | | { |
| | 0 | 256 | | hint.BackdropImageTag = tag; |
| | 0 | 257 | | hint.BackdropImageItemId = itemWithImage.Id.ToString("N", CultureInfo.InvariantCulture); |
| | | 258 | | } |
| | | 259 | | } |
| | 0 | 260 | | } |
| | | 261 | | |
| | | 262 | | private T? GetParentWithImage<T>(BaseItem item, ImageType type) |
| | | 263 | | where T : BaseItem |
| | | 264 | | { |
| | 0 | 265 | | return item.GetParents().OfType<T>().FirstOrDefault(i => i.HasImage(type)); |
| | | 266 | | } |
| | | 267 | | } |