2020-06-02 15:07:07 +02:00
using System ;
using System.ComponentModel ;
using System.ComponentModel.DataAnnotations ;
using System.Globalization ;
using System.Linq ;
2020-06-16 22:15:58 +02:00
using Jellyfin.Api.Constants ;
2020-06-07 15:41:49 +02:00
using Jellyfin.Api.Helpers ;
2020-06-02 15:07:07 +02:00
using MediaBrowser.Controller.Drawing ;
using MediaBrowser.Controller.Dto ;
using MediaBrowser.Controller.Entities ;
using MediaBrowser.Controller.Entities.Audio ;
using MediaBrowser.Controller.Entities.TV ;
using MediaBrowser.Controller.Library ;
using MediaBrowser.Controller.LiveTv ;
using MediaBrowser.Model.Entities ;
using MediaBrowser.Model.Search ;
2020-06-07 15:33:54 +02:00
using Microsoft.AspNetCore.Authorization ;
2020-06-02 15:07:07 +02:00
using Microsoft.AspNetCore.Http ;
using Microsoft.AspNetCore.Mvc ;
namespace Jellyfin.Api.Controllers
{
/// <summary>
/// Search controller.
/// </summary>
2020-08-04 16:27:54 +02:00
[Route("Search/Hints")]
2020-06-16 22:15:58 +02:00
[Authorize(Policy = Policies.DefaultAuthorization)]
2020-06-02 15:07:07 +02:00
public class SearchController : BaseJellyfinApiController
{
private readonly ISearchEngine _searchEngine ;
private readonly ILibraryManager _libraryManager ;
private readonly IDtoService _dtoService ;
private readonly IImageProcessor _imageProcessor ;
/// <summary>
/// Initializes a new instance of the <see cref="SearchController"/> class.
/// </summary>
/// <param name="searchEngine">Instance of <see cref="ISearchEngine"/> interface.</param>
/// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param>
/// <param name="dtoService">Instance of <see cref="IDtoService"/> interface.</param>
/// <param name="imageProcessor">Instance of <see cref="IImageProcessor"/> interface.</param>
public SearchController (
ISearchEngine searchEngine ,
ILibraryManager libraryManager ,
IDtoService dtoService ,
IImageProcessor imageProcessor )
{
_searchEngine = searchEngine ;
_libraryManager = libraryManager ;
_dtoService = dtoService ;
_imageProcessor = imageProcessor ;
}
/// <summary>
/// Gets the search hint result.
/// </summary>
2020-06-07 15:33:54 +02:00
/// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
/// <param name="limit">Optional. The maximum number of records to return.</param>
/// <param name="userId">Optional. Supply a user id to search within a user's library or omit to search all.</param>
2020-06-02 15:07:07 +02:00
/// <param name="searchTerm">The search term to filter on.</param>
/// <param name="includeItemTypes">If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.</param>
/// <param name="excludeItemTypes">If specified, results with these item types are filtered out. This allows multiple, comma delimeted.</param>
/// <param name="mediaTypes">If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.</param>
/// <param name="parentId">If specified, only children of the parent are returned.</param>
/// <param name="isMovie">Optional filter for movies.</param>
/// <param name="isSeries">Optional filter for series.</param>
/// <param name="isNews">Optional filter for news.</param>
/// <param name="isKids">Optional filter for kids.</param>
/// <param name="isSports">Optional filter for sports.</param>
2020-06-07 18:10:08 +02:00
/// <param name="includePeople">Optional filter whether to include people.</param>
/// <param name="includeMedia">Optional filter whether to include media.</param>
/// <param name="includeGenres">Optional filter whether to include genres.</param>
/// <param name="includeStudios">Optional filter whether to include studios.</param>
/// <param name="includeArtists">Optional filter whether to include artists.</param>
2020-06-09 11:00:37 +02:00
/// <response code="200">Search hint returned.</response>
2020-06-02 15:07:07 +02:00
/// <returns>An <see cref="SearchHintResult"/> with the results of the search.</returns>
[HttpGet]
[Description("Gets search hints based on a search term")]
[ProducesResponseType(StatusCodes.Status200OK)]
public ActionResult < SearchHintResult > Get (
[FromQuery] int? startIndex ,
[FromQuery] int? limit ,
2020-07-07 17:10:51 +02:00
[FromQuery] Guid ? userId ,
2020-06-27 18:50:44 +02:00
[FromQuery, Required] string? searchTerm ,
[FromQuery] string? includeItemTypes ,
[FromQuery] string? excludeItemTypes ,
[FromQuery] string? mediaTypes ,
[FromQuery] string? parentId ,
2020-06-02 15:07:07 +02:00
[FromQuery] bool? isMovie ,
[FromQuery] bool? isSeries ,
[FromQuery] bool? isNews ,
[FromQuery] bool? isKids ,
2020-06-07 18:10:08 +02:00
[FromQuery] bool? isSports ,
[FromQuery] bool includePeople = true ,
[FromQuery] bool includeMedia = true ,
[FromQuery] bool includeGenres = true ,
[FromQuery] bool includeStudios = true ,
[FromQuery] bool includeArtists = true )
2020-06-02 15:07:07 +02:00
{
var result = _searchEngine . GetSearchHints ( new SearchQuery
{
Limit = limit ,
SearchTerm = searchTerm ,
IncludeArtists = includeArtists ,
IncludeGenres = includeGenres ,
IncludeMedia = includeMedia ,
IncludePeople = includePeople ,
IncludeStudios = includeStudios ,
StartIndex = startIndex ,
2020-07-07 17:10:51 +02:00
UserId = userId ? ? Guid . Empty ,
2020-06-07 15:41:49 +02:00
IncludeItemTypes = RequestHelpers . Split ( includeItemTypes , ',' , true ) ,
ExcludeItemTypes = RequestHelpers . Split ( excludeItemTypes , ',' , true ) ,
MediaTypes = RequestHelpers . Split ( mediaTypes , ',' , true ) ,
2020-06-02 15:07:07 +02:00
ParentId = parentId ,
IsKids = isKids ,
IsMovie = isMovie ,
IsNews = isNews ,
IsSeries = isSeries ,
IsSports = isSports
} ) ;
2020-06-07 15:33:54 +02:00
return new SearchHintResult
2020-06-02 15:07:07 +02:00
{
TotalRecordCount = result . TotalRecordCount ,
SearchHints = result . Items . Select ( GetSearchHintResult ) . ToArray ( )
2020-06-07 15:33:54 +02:00
} ;
2020-06-02 15:07:07 +02:00
}
/// <summary>
/// Gets the search hint result.
/// </summary>
/// <param name="hintInfo">The hint info.</param>
/// <returns>SearchHintResult.</returns>
private SearchHint GetSearchHintResult ( SearchHintInfo hintInfo )
{
var item = hintInfo . Item ;
var result = new SearchHint
{
Name = item . Name ,
IndexNumber = item . IndexNumber ,
ParentIndexNumber = item . ParentIndexNumber ,
Id = item . Id ,
Type = item . GetClientTypeName ( ) ,
MediaType = item . MediaType ,
MatchedTerm = hintInfo . MatchedTerm ,
RunTimeTicks = item . RunTimeTicks ,
ProductionYear = item . ProductionYear ,
ChannelId = item . ChannelId ,
EndDate = item . EndDate
} ;
// legacy
result . ItemId = result . Id ;
if ( item . IsFolder )
{
result . IsFolder = true ;
}
var primaryImageTag = _imageProcessor . GetImageCacheTag ( item , ImageType . Primary ) ;
if ( primaryImageTag ! = null )
{
result . PrimaryImageTag = primaryImageTag ;
result . PrimaryImageAspectRatio = _dtoService . GetPrimaryImageAspectRatio ( item ) ;
}
SetThumbImageInfo ( result , item ) ;
SetBackdropImageInfo ( result , item ) ;
switch ( item )
{
case IHasSeries hasSeries :
result . Series = hasSeries . SeriesName ;
break ;
case LiveTvProgram program :
result . StartDate = program . StartDate ;
break ;
case Series series :
if ( series . Status . HasValue )
{
result . Status = series . Status . Value . ToString ( ) ;
}
break ;
case MusicAlbum album :
result . Artists = album . Artists ;
result . AlbumArtist = album . AlbumArtist ;
break ;
case Audio song :
result . AlbumArtist = song . AlbumArtists ? [ 0 ] ;
result . Artists = song . Artists ;
MusicAlbum musicAlbum = song . AlbumEntity ;
if ( musicAlbum ! = null )
{
result . Album = musicAlbum . Name ;
result . AlbumId = musicAlbum . Id ;
}
else
{
result . Album = song . Album ;
}
break ;
}
if ( ! item . ChannelId . Equals ( Guid . Empty ) )
{
var channel = _libraryManager . GetItemById ( item . ChannelId ) ;
result . ChannelName = channel ? . Name ;
}
return result ;
}
private void SetThumbImageInfo ( SearchHint hint , BaseItem item )
{
var itemWithImage = item . HasImage ( ImageType . Thumb ) ? item : null ;
if ( itemWithImage = = null & & item is Episode )
{
itemWithImage = GetParentWithImage < Series > ( item , ImageType . Thumb ) ;
}
if ( itemWithImage = = null )
{
itemWithImage = GetParentWithImage < BaseItem > ( item , ImageType . Thumb ) ;
}
if ( itemWithImage ! = null )
{
var tag = _imageProcessor . GetImageCacheTag ( itemWithImage , ImageType . Thumb ) ;
if ( tag ! = null )
{
hint . ThumbImageTag = tag ;
hint . ThumbImageItemId = itemWithImage . Id . ToString ( "N" , CultureInfo . InvariantCulture ) ;
}
}
}
private void SetBackdropImageInfo ( SearchHint hint , BaseItem item )
{
var itemWithImage = ( item . HasImage ( ImageType . Backdrop ) ? item : null )
? ? GetParentWithImage < BaseItem > ( item , ImageType . Backdrop ) ;
if ( itemWithImage ! = null )
{
var tag = _imageProcessor . GetImageCacheTag ( itemWithImage , ImageType . Backdrop ) ;
if ( tag ! = null )
{
hint . BackdropImageTag = tag ;
hint . BackdropImageItemId = itemWithImage . Id . ToString ( "N" , CultureInfo . InvariantCulture ) ;
}
}
}
private T GetParentWithImage < T > ( BaseItem item , ImageType type )
where T : BaseItem
{
return item . GetParents ( ) . OfType < T > ( ) . FirstOrDefault ( i = > i . HasImage ( type ) ) ;
}
}
}