using MediaBrowser.Controller.Collections ;
using MediaBrowser.Controller.Dto ;
using MediaBrowser.Controller.Entities ;
using MediaBrowser.Controller.Entities.Audio ;
using MediaBrowser.Controller.Entities.Movies ;
using MediaBrowser.Controller.Entities.TV ;
using MediaBrowser.Controller.Library ;
using MediaBrowser.Controller.Localization ;
using MediaBrowser.Controller.Net ;
using MediaBrowser.Model.Entities ;
using MediaBrowser.Model.Querying ;
using ServiceStack ;
using System ;
using System.Collections.Generic ;
using System.Globalization ;
using System.Linq ;
using System.Threading.Tasks ;
namespace MediaBrowser.Api.UserLibrary
{
/// <summary>
/// Class GetItems
/// </summary>
[Route("/Items", "GET", Summary = "Gets items based on a query.")]
[Route("/Users/{UserId}/Items", "GET", Summary = "Gets items based on a query.")]
public class GetItems : BaseItemsRequest , IReturn < ItemsResult >
{
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "GET")]
public Guid ? UserId { get ; set ; }
/// <summary>
/// Limit results to items containing a specific person
/// </summary>
/// <value>The person.</value>
[ApiMember(Name = "Person", Description = "Optional. If specified, results will be filtered to include only those containing the specified person.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string Person { get ; set ; }
/// <summary>
/// If the Person filter is used, this can also be used to restrict to a specific person type
/// </summary>
/// <value>The type of the person.</value>
[ApiMember(Name = "PersonTypes", Description = "Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string PersonTypes { get ; set ; }
/// <summary>
/// Limit results to items containing specific studios
/// </summary>
/// <value>The studios.</value>
[ApiMember(Name = "Studios", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string Studios { get ; set ; }
[ApiMember(Name = "StudioIds", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string StudioIds { get ; set ; }
/// <summary>
/// Gets or sets the studios.
/// </summary>
/// <value>The studios.</value>
[ApiMember(Name = "Artists", Description = "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string Artists { get ; set ; }
[ApiMember(Name = "ArtistIds", Description = "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string ArtistIds { get ; set ; }
[ApiMember(Name = "Albums", Description = "Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string Albums { get ; set ; }
/// <summary>
/// Gets or sets the item ids.
/// </summary>
/// <value>The item ids.</value>
[ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string Ids { get ; set ; }
/// <summary>
/// Gets or sets the video types.
/// </summary>
/// <value>The video types.</value>
[ApiMember(Name = "VideoTypes", Description = "Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string VideoTypes { get ; set ; }
/// <summary>
/// Gets or sets the video formats.
/// </summary>
/// <value>The video formats.</value>
[ApiMember(Name = "Is3D", Description = "Optional filter by items that are 3D, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? Is3D { get ; set ; }
/// <summary>
/// Gets or sets the series status.
/// </summary>
/// <value>The series status.</value>
[ApiMember(Name = "SeriesStatus", Description = "Optional filter by Series Status. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string SeriesStatus { get ; set ; }
[ApiMember(Name = "NameStartsWithOrGreater", Description = "Optional filter by items whose name is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string NameStartsWithOrGreater { get ; set ; }
[ApiMember(Name = "NameStartsWith", Description = "Optional filter by items whose name is sorted equally than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string NameStartsWith { get ; set ; }
[ApiMember(Name = "NameLessThan", Description = "Optional filter by items whose name is equally or lesser than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string NameLessThan { get ; set ; }
[ApiMember(Name = "AlbumArtistStartsWithOrGreater", Description = "Optional filter by items whose album artist is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string AlbumArtistStartsWithOrGreater { get ; set ; }
/// <summary>
/// Gets or sets the air days.
/// </summary>
/// <value>The air days.</value>
[ApiMember(Name = "AirDays", Description = "Optional filter by Series Air Days. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string AirDays { get ; set ; }
/// <summary>
/// Gets or sets the min offical rating.
/// </summary>
/// <value>The min offical rating.</value>
[ApiMember(Name = "MinOfficialRating", Description = "Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string MinOfficialRating { get ; set ; }
/// <summary>
/// Gets or sets the max offical rating.
/// </summary>
/// <value>The max offical rating.</value>
[ApiMember(Name = "MaxOfficialRating", Description = "Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string MaxOfficialRating { get ; set ; }
[ApiMember(Name = "HasThemeSong", Description = "Optional filter by items with theme songs.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? HasThemeSong { get ; set ; }
[ApiMember(Name = "HasThemeVideo", Description = "Optional filter by items with theme videos.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? HasThemeVideo { get ; set ; }
[ApiMember(Name = "HasSubtitles", Description = "Optional filter by items with subtitles.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? HasSubtitles { get ; set ; }
[ApiMember(Name = "HasSpecialFeature", Description = "Optional filter by items with special features.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? HasSpecialFeature { get ; set ; }
[ApiMember(Name = "HasTrailer", Description = "Optional filter by items with trailers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? HasTrailer { get ; set ; }
[ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string AdjacentTo { get ; set ; }
[ApiMember(Name = "MinIndexNumber", Description = "Optional filter by minimum index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MinIndexNumber { get ; set ; }
[ApiMember(Name = "MinPlayers", Description = "Optional filter by minimum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MinPlayers { get ; set ; }
[ApiMember(Name = "MaxPlayers", Description = "Optional filter by maximum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MaxPlayers { get ; set ; }
[ApiMember(Name = "ParentIndexNumber", Description = "Optional filter by parent index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? ParentIndexNumber { get ; set ; }
[ApiMember(Name = "HasParentalRating", Description = "Optional filter by items that have or do not have a parental rating", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? HasParentalRating { get ; set ; }
[ApiMember(Name = "IsHD", Description = "Optional filter by items that are HD or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsHD { get ; set ; }
[ApiMember(Name = "LocationTypes", Description = "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string LocationTypes { get ; set ; }
[ApiMember(Name = "ExcludeLocationTypes", Description = "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string ExcludeLocationTypes { get ; set ; }
[ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsMissing { get ; set ; }
[ApiMember(Name = "IsUnaired", Description = "Optional filter by items that are unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsUnaired { get ; set ; }
[ApiMember(Name = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsVirtualUnaired { get ; set ; }
[ApiMember(Name = "MinCommunityRating", Description = "Optional filter by minimum community rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public double? MinCommunityRating { get ; set ; }
[ApiMember(Name = "MinCriticRating", Description = "Optional filter by minimum critic rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public double? MinCriticRating { get ; set ; }
[ApiMember(Name = "AiredDuringSeason", Description = "Gets all episodes that aired during a season, including specials.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? AiredDuringSeason { get ; set ; }
[ApiMember(Name = "MinPremiereDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public string MinPremiereDate { get ; set ; }
[ApiMember(Name = "MaxPremiereDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public string MaxPremiereDate { get ; set ; }
[ApiMember(Name = "HasOverview", Description = "Optional filter by items that have an overview or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? HasOverview { get ; set ; }
[ApiMember(Name = "HasImdbId", Description = "Optional filter by items that have an imdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? HasImdbId { get ; set ; }
[ApiMember(Name = "HasTmdbId", Description = "Optional filter by items that have a tmdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? HasTmdbId { get ; set ; }
[ApiMember(Name = "HasTvdbId", Description = "Optional filter by items that have a tvdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? HasTvdbId { get ; set ; }
[ApiMember(Name = "IsYearMismatched", Description = "Optional filter by items that are potentially misidentified.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsYearMismatched { get ; set ; }
[ApiMember(Name = "IsInBoxSet", Description = "Optional filter by items that are in boxsets, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsInBoxSet { get ; set ; }
[ApiMember(Name = "IsLocked", Description = "Optional filter by items that are locked.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? IsLocked { get ; set ; }
[ApiMember(Name = "IsUnidentified", Description = "Optional filter by items that are unidentified by internet metadata providers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? IsUnidentified { get ; set ; }
[ApiMember(Name = "IsPlaceHolder", Description = "Optional filter by items that are placeholders", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? IsPlaceHolder { get ; set ; }
[ApiMember(Name = "HasOfficialRating", Description = "Optional filter by items that have official ratings", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public bool? HasOfficialRating { get ; set ; }
[ApiMember(Name = "CollapseBoxSetItems", Description = "Whether or not to hide items behind their boxsets.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? CollapseBoxSetItems { get ; set ; }
public string [ ] GetStudios ( )
{
return ( Studios ? ? string . Empty ) . Split ( new [ ] { '|' } , StringSplitOptions . RemoveEmptyEntries ) ;
}
public string [ ] GetStudioIds ( )
{
return ( StudioIds ? ? string . Empty ) . Split ( new [ ] { '|' } , StringSplitOptions . RemoveEmptyEntries ) ;
}
public string [ ] GetPersonTypes ( )
{
return ( PersonTypes ? ? string . Empty ) . Split ( new [ ] { ',' } , StringSplitOptions . RemoveEmptyEntries ) ;
}
public IEnumerable < VideoType > GetVideoTypes ( )
{
var val = VideoTypes ;
if ( string . IsNullOrEmpty ( val ) )
{
return new VideoType [ ] { } ;
}
return val . Split ( new [ ] { ',' } , StringSplitOptions . RemoveEmptyEntries ) . Select ( v = > ( VideoType ) Enum . Parse ( typeof ( VideoType ) , v , true ) ) ;
}
}
/// <summary>
/// Class ItemsService
/// </summary>
[Authenticated]
public class ItemsService : BaseApiService
{
/// <summary>
/// The _user manager
/// </summary>
private readonly IUserManager _userManager ;
private readonly IUserDataManager _userDataRepository ;
/// <summary>
/// The _library manager
/// </summary>
private readonly ILibraryManager _libraryManager ;
private readonly ILocalizationManager _localization ;
private readonly IDtoService _dtoService ;
private readonly ICollectionManager _collectionManager ;
/// <summary>
/// Initializes a new instance of the <see cref="ItemsService" /> class.
/// </summary>
/// <param name="userManager">The user manager.</param>
/// <param name="libraryManager">The library manager.</param>
/// <param name="userDataRepository">The user data repository.</param>
/// <param name="localization">The localization.</param>
/// <param name="dtoService">The dto service.</param>
/// <param name="collectionManager">The collection manager.</param>
public ItemsService ( IUserManager userManager , ILibraryManager libraryManager , IUserDataManager userDataRepository , ILocalizationManager localization , IDtoService dtoService , ICollectionManager collectionManager )
{
_userManager = userManager ;
_libraryManager = libraryManager ;
_userDataRepository = userDataRepository ;
_localization = localization ;
_dtoService = dtoService ;
_collectionManager = collectionManager ;
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public async Task < object > Get ( GetItems request )
{
var result = await GetItems ( request ) . ConfigureAwait ( false ) ;
return ToOptimizedSerializedResultUsingCache ( result ) ;
}
/// <summary>
/// Gets the items.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task{ItemsResult}.</returns>
private async Task < ItemsResult > GetItems ( GetItems request )
{
var parentItem = string . IsNullOrEmpty ( request . ParentId ) ? null : _libraryManager . GetItemById ( request . ParentId ) ;
var user = request . UserId . HasValue ? _userManager . GetUserById ( request . UserId . Value ) : null ;
var result = await GetItemsToSerialize ( request , user , parentItem ) . ConfigureAwait ( false ) ;
var isFiltered = result . Item2 ;
var dtoOptions = GetDtoOptions ( request ) ;
if ( isFiltered )
{
return new ItemsResult
{
TotalRecordCount = result . Item1 . TotalRecordCount ,
Items = _dtoService . GetBaseItemDtos ( result . Item1 . Items , dtoOptions , user ) . ToArray ( )
} ;
}
var items = result . Item1 . Items . Where ( i = > ApplyAdditionalFilters ( request , i , user , false , _libraryManager ) ) ;
// Apply filters
// Run them starting with the ones that are likely to reduce the list the most
foreach ( var filter in request . GetFilters ( ) . OrderByDescending ( f = > ( int ) f ) )
{
items = ApplyFilter ( items , filter , user , _userDataRepository ) ;
}
items = UserViewBuilder . FilterVirtualEpisodes ( items ,
request . IsMissing ,
request . IsVirtualUnaired ,
request . IsUnaired ) ;
var internalQuery = GetItemsQuery ( request , user ) ;
items = UserViewBuilder . CollapseBoxSetItemsIfNeeded ( items , internalQuery , parentItem , user ) ;
items = _libraryManager . Sort ( items , user , request . GetOrderBy ( ) , request . SortOrder ? ? SortOrder . Ascending ) ;
// This must be the last filter
if ( ! string . IsNullOrEmpty ( request . AdjacentTo ) )
{
items = UserViewBuilder . FilterForAdjacency ( items , request . AdjacentTo ) ;
}
var itemsArray = items . ToList ( ) ;
var pagedItems = ApplyPaging ( request , itemsArray ) ;
var returnItems = _dtoService . GetBaseItemDtos ( pagedItems , dtoOptions , user ) . ToArray ( ) ;
return new ItemsResult
{
TotalRecordCount = itemsArray . Count ,
Items = returnItems
} ;
}
/// <summary>
/// Gets the items to serialize.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="user">The user.</param>
/// <param name="parentItem">The parent item.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
private async Task < Tuple < QueryResult < BaseItem > , bool > > GetItemsToSerialize ( GetItems request , User user , BaseItem parentItem )
{
var item = string . IsNullOrEmpty ( request . ParentId ) ?
user = = null ? _libraryManager . RootFolder : user . RootFolder :
parentItem ;
// Default list type = children
IEnumerable < BaseItem > items ;
if ( ! string . IsNullOrEmpty ( request . Ids ) )
{
var idList = request . Ids . Split ( ',' ) . ToList ( ) ;
items = idList . Select ( i = > _libraryManager . GetItemById ( i ) ) ;
}
else if ( request . Recursive )
{
var result = await ( ( Folder ) item ) . GetItems ( GetItemsQuery ( request , user ) ) . ConfigureAwait ( false ) ;
return new Tuple < QueryResult < BaseItem > , bool > ( result , true ) ;
}
else
{
if ( user = = null )
{
var result = await ( ( Folder ) item ) . GetItems ( GetItemsQuery ( request , null ) ) . ConfigureAwait ( false ) ;
return new Tuple < QueryResult < BaseItem > , bool > ( result , true ) ;
}
var userRoot = item as UserRootFolder ;
if ( userRoot = = null )
{
var result = await ( ( Folder ) item ) . GetItems ( GetItemsQuery ( request , user ) ) . ConfigureAwait ( false ) ;
return new Tuple < QueryResult < BaseItem > , bool > ( result , true ) ;
}
items = ( ( Folder ) item ) . GetChildren ( user , true ) ;
}
return new Tuple < QueryResult < BaseItem > , bool > ( new QueryResult < BaseItem >
{
Items = items . ToArray ( )
} , false ) ;
}
private InternalItemsQuery GetItemsQuery ( GetItems request , User user )
{
var query = new InternalItemsQuery
{
User = user ,
IsPlayed = request . IsPlayed ,
MediaTypes = request . GetMediaTypes ( ) ,
IncludeItemTypes = request . GetIncludeItemTypes ( ) ,
ExcludeItemTypes = request . GetExcludeItemTypes ( ) ,
Recursive = request . Recursive ,
SortBy = request . GetOrderBy ( ) ,
SortOrder = request . SortOrder ? ? SortOrder . Ascending ,
Filter = i = > ApplyAdditionalFilters ( request , i , user , true , _libraryManager ) ,
Limit = request . Limit ,
StartIndex = request . StartIndex ,
IsMissing = request . IsMissing ,
IsVirtualUnaired = request . IsVirtualUnaired ,
IsUnaired = request . IsUnaired ,
CollapseBoxSetItems = request . CollapseBoxSetItems ,
NameLessThan = request . NameLessThan ,
NameStartsWith = request . NameStartsWith ,
NameStartsWithOrGreater = request . NameStartsWithOrGreater ,
HasImdbId = request . HasImdbId ,
IsYearMismatched = request . IsYearMismatched ,
IsUnidentified = request . IsUnidentified ,
IsPlaceHolder = request . IsPlaceHolder ,
IsLocked = request . IsLocked ,
IsInBoxSet = request . IsInBoxSet ,
IsHD = request . IsHD ,
Is3D = request . Is3D ,
HasTvdbId = request . HasTvdbId ,
HasTmdbId = request . HasTmdbId ,
HasOverview = request . HasOverview ,
HasOfficialRating = request . HasOfficialRating ,
HasParentalRating = request . HasParentalRating ,
HasSpecialFeature = request . HasSpecialFeature ,
HasSubtitles = request . HasSubtitles ,
HasThemeSong = request . HasThemeSong ,
HasThemeVideo = request . HasThemeVideo ,
HasTrailer = request . HasTrailer ,
Tags = request . GetTags ( ) ,
OfficialRatings = request . GetOfficialRatings ( ) ,
Genres = request . GetGenres ( ) ,
Studios = request . GetStudios ( ) ,
StudioIds = request . GetStudioIds ( ) ,
Person = request . Person ,
PersonTypes = request . GetPersonTypes ( ) ,
Years = request . GetYears ( ) ,
ImageTypes = request . GetImageTypes ( ) . ToArray ( ) ,
VideoTypes = request . GetVideoTypes ( ) . ToArray ( ) ,
AdjacentTo = request . AdjacentTo
} ;
if ( ! string . IsNullOrWhiteSpace ( request . Ids ) )
{
query . CollapseBoxSetItems = false ;
}
foreach ( var filter in request . GetFilters ( ) )
{
switch ( filter )
{
case ItemFilter . Dislikes :
query . IsLiked = false ;
break ;
case ItemFilter . IsFavorite :
query . IsFavorite = true ;
break ;
case ItemFilter . IsFavoriteOrLikes :
query . IsFavoriteOrLiked = true ;
break ;
case ItemFilter . IsFolder :
query . IsFolder = true ;
break ;
case ItemFilter . IsNotFolder :
query . IsFolder = false ;
break ;
case ItemFilter . IsPlayed :
query . IsPlayed = true ;
break ;
case ItemFilter . IsRecentlyAdded :
break ;
case ItemFilter . IsResumable :
query . IsResumable = true ;
break ;
case ItemFilter . IsUnplayed :
query . IsPlayed = false ;
break ;
case ItemFilter . Likes :
query . IsLiked = true ;
break ;
}
}
return query ;
}
/// <summary>
/// Applies filtering
/// </summary>
/// <param name="items">The items.</param>
/// <param name="filter">The filter.</param>
/// <param name="user">The user.</param>
/// <param name="repository">The repository.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
internal static IEnumerable < BaseItem > ApplyFilter ( IEnumerable < BaseItem > items , ItemFilter filter , User user , IUserDataManager repository )
{
// Avoid implicitly captured closure
var currentUser = user ;
switch ( filter )
{
case ItemFilter . IsFavoriteOrLikes :
return items . Where ( item = >
{
var userdata = repository . GetUserData ( user . Id , item . GetUserDataKey ( ) ) ;
if ( userdata = = null )
{
return false ;
}
var likes = userdata . Likes ? ? false ;
var favorite = userdata . IsFavorite ;
return likes | | favorite ;
} ) ;
case ItemFilter . Likes :
return items . Where ( item = >
{
var userdata = repository . GetUserData ( user . Id , item . GetUserDataKey ( ) ) ;
return userdata ! = null & & userdata . Likes . HasValue & & userdata . Likes . Value ;
} ) ;
case ItemFilter . Dislikes :
return items . Where ( item = >
{
var userdata = repository . GetUserData ( user . Id , item . GetUserDataKey ( ) ) ;
return userdata ! = null & & userdata . Likes . HasValue & & ! userdata . Likes . Value ;
} ) ;
case ItemFilter . IsFavorite :
return items . Where ( item = >
{
var userdata = repository . GetUserData ( user . Id , item . GetUserDataKey ( ) ) ;
return userdata ! = null & & userdata . IsFavorite ;
} ) ;
case ItemFilter . IsResumable :
return items . Where ( item = >
{
var userdata = repository . GetUserData ( user . Id , item . GetUserDataKey ( ) ) ;
return userdata ! = null & & userdata . PlaybackPositionTicks > 0 ;
} ) ;
case ItemFilter . IsPlayed :
return items . Where ( item = > item . IsPlayed ( currentUser ) ) ;
case ItemFilter . IsUnplayed :
return items . Where ( item = > item . IsUnplayed ( currentUser ) ) ;
case ItemFilter . IsFolder :
return items . Where ( item = > item . IsFolder ) ;
case ItemFilter . IsNotFolder :
return items . Where ( item = > ! item . IsFolder ) ;
case ItemFilter . IsRecentlyAdded :
return items . Where ( item = > ( DateTime . UtcNow - item . DateCreated ) . TotalDays < = 10 ) ;
}
return items ;
}
private bool ApplyAdditionalFilters ( GetItems request , BaseItem i , User user , bool isPreFiltered , ILibraryManager libraryManager )
{
var video = i as Video ;
if ( ! isPreFiltered )
{
var mediaTypes = request . GetMediaTypes ( ) ;
if ( mediaTypes . Length > 0 )
{
if ( ! ( ! string . IsNullOrEmpty ( i . MediaType ) & & mediaTypes . Contains ( i . MediaType , StringComparer . OrdinalIgnoreCase ) ) )
{
return false ;
}
}
if ( request . IsPlayed . HasValue )
{
var val = request . IsPlayed . Value ;
if ( i . IsPlayed ( user ) ! = val )
{
return false ;
}
}
// Exclude item types
var excluteItemTypes = request . GetExcludeItemTypes ( ) ;
if ( excluteItemTypes . Length > 0 & & excluteItemTypes . Contains ( i . GetType ( ) . Name , StringComparer . OrdinalIgnoreCase ) )
{
return false ;
}
// Include item types
var includeItemTypes = request . GetIncludeItemTypes ( ) ;
if ( includeItemTypes . Length > 0 & & ! includeItemTypes . Contains ( i . GetType ( ) . Name , StringComparer . OrdinalIgnoreCase ) )
{
return false ;
}
if ( request . IsInBoxSet . HasValue )
{
var val = request . IsInBoxSet . Value ;
if ( i . Parents . OfType < BoxSet > ( ) . Any ( ) ! = val )
{
return false ;
}
}
// Filter by Video3DFormat
if ( request . Is3D . HasValue )
{
var val = request . Is3D . Value ;
if ( video = = null | | val ! = video . Video3DFormat . HasValue )
{
return false ;
}
}
if ( request . IsHD . HasValue )
{
var val = request . IsHD . Value ;
if ( video = = null | | val ! = video . IsHD )
{
return false ;
}
}
if ( request . IsUnidentified . HasValue )
{
var val = request . IsUnidentified . Value ;
if ( i . IsUnidentified ! = val )
{
return false ;
}
}
if ( request . IsLocked . HasValue )
{
var val = request . IsLocked . Value ;
if ( i . IsLocked ! = val )
{
return false ;
}
}
if ( request . HasOverview . HasValue )
{
var filterValue = request . HasOverview . Value ;
var hasValue = ! string . IsNullOrEmpty ( i . Overview ) ;
if ( hasValue ! = filterValue )
{
return false ;
}
}
if ( request . HasImdbId . HasValue )
{
var filterValue = request . HasImdbId . Value ;
var hasValue = ! string . IsNullOrEmpty ( i . GetProviderId ( MetadataProviders . Imdb ) ) ;
if ( hasValue ! = filterValue )
{
return false ;
}
}
if ( request . HasTmdbId . HasValue )
{
var filterValue = request . HasTmdbId . Value ;
var hasValue = ! string . IsNullOrEmpty ( i . GetProviderId ( MetadataProviders . Tmdb ) ) ;
if ( hasValue ! = filterValue )
{
return false ;
}
}
if ( request . HasTvdbId . HasValue )
{
var filterValue = request . HasTvdbId . Value ;
var hasValue = ! string . IsNullOrEmpty ( i . GetProviderId ( MetadataProviders . Tvdb ) ) ;
if ( hasValue ! = filterValue )
{
return false ;
}
}
if ( request . IsYearMismatched . HasValue )
{
var filterValue = request . IsYearMismatched . Value ;
if ( UserViewBuilder . IsYearMismatched ( i , libraryManager ) ! = filterValue )
{
return false ;
}
}
if ( request . HasOfficialRating . HasValue )
{
var filterValue = request . HasOfficialRating . Value ;
var hasValue = ! string . IsNullOrEmpty ( i . OfficialRating ) ;
if ( hasValue ! = filterValue )
{
return false ;
}
}
if ( request . IsPlaceHolder . HasValue )
{
var filterValue = request . IsPlaceHolder . Value ;
var isPlaceHolder = false ;
var hasPlaceHolder = i as ISupportsPlaceHolders ;
if ( hasPlaceHolder ! = null )
{
isPlaceHolder = hasPlaceHolder . IsPlaceHolder ;
}
if ( isPlaceHolder ! = filterValue )
{
return false ;
}
}
if ( request . HasSpecialFeature . HasValue )
{
var filterValue = request . HasSpecialFeature . Value ;
var movie = i as IHasSpecialFeatures ;
if ( movie ! = null )
{
var ok = filterValue
? movie . SpecialFeatureIds . Count > 0
: movie . SpecialFeatureIds . Count = = 0 ;
if ( ! ok )
{
return false ;
}
}
else
{
return false ;
}
}
if ( request . HasSubtitles . HasValue )
{
var val = request . HasSubtitles . Value ;
if ( video = = null | | val ! = video . HasSubtitles )
{
return false ;
}
}
if ( request . HasParentalRating . HasValue )
{
var val = request . HasParentalRating . Value ;
var rating = i . CustomRating ;
if ( string . IsNullOrEmpty ( rating ) )
{
rating = i . OfficialRating ;
}
if ( val )
{
if ( string . IsNullOrEmpty ( rating ) )
{
return false ;
}
}
else
{
if ( ! string . IsNullOrEmpty ( rating ) )
{
return false ;
}
}
}
if ( request . HasTrailer . HasValue )
{
var val = request . HasTrailer . Value ;
var trailerCount = 0 ;
var hasTrailers = i as IHasTrailers ;
if ( hasTrailers ! = null )
{
trailerCount = hasTrailers . GetTrailerIds ( ) . Count ;
}
var ok = val ? trailerCount > 0 : trailerCount = = 0 ;
if ( ! ok )
{
return false ;
}
}
if ( request . HasThemeSong . HasValue )
{
var filterValue = request . HasThemeSong . Value ;
var themeCount = 0 ;
var iHasThemeMedia = i as IHasThemeMedia ;
if ( iHasThemeMedia ! = null )
{
themeCount = iHasThemeMedia . ThemeSongIds . Count ;
}
var ok = filterValue ? themeCount > 0 : themeCount = = 0 ;
if ( ! ok )
{
return false ;
}
}
if ( request . HasThemeVideo . HasValue )
{
var filterValue = request . HasThemeVideo . Value ;
var themeCount = 0 ;
var iHasThemeMedia = i as IHasThemeMedia ;
if ( iHasThemeMedia ! = null )
{
themeCount = iHasThemeMedia . ThemeVideoIds . Count ;
}
var ok = filterValue ? themeCount > 0 : themeCount = = 0 ;
if ( ! ok )
{
return false ;
}
}
// Apply tag filter
var tags = request . GetTags ( ) ;
if ( tags . Length > 0 )
{
var hasTags = i as IHasTags ;
if ( hasTags = = null )
{
return false ;
}
if ( ! ( tags . Any ( v = > hasTags . Tags . Contains ( v , StringComparer . OrdinalIgnoreCase ) ) ) )
{
return false ;
}
}
// Apply official rating filter
var officialRatings = request . GetOfficialRatings ( ) ;
if ( officialRatings . Length > 0 & & ! officialRatings . Contains ( i . OfficialRating ? ? string . Empty ) )
{
return false ;
}
// Apply genre filter
var genres = request . GetGenres ( ) ;
if ( genres . Length > 0 & & ! ( genres . Any ( v = > i . Genres . Contains ( v , StringComparer . OrdinalIgnoreCase ) ) ) )
{
return false ;
}
// Filter by VideoType
var videoTypes = request . GetVideoTypes ( ) ;
if ( video = = null | | ! videoTypes . Contains ( video . VideoType ) )
{
return false ;
}
var imageTypes = request . GetImageTypes ( ) . ToList ( ) ;
if ( imageTypes . Count > 0 )
{
if ( ! ( imageTypes . Any ( i . HasImage ) ) )
{
return false ;
}
}
// Apply studio filter
var studios = request . GetStudios ( ) ;
if ( studios . Length > 0 & & ! studios . Any ( v = > i . Studios . Contains ( v , StringComparer . OrdinalIgnoreCase ) ) )
{
return false ;
}
// Apply studio filter
var studioIds = request . GetStudioIds ( ) ;
if ( studioIds . Length > 0 & & ! studioIds . Any ( id = >
{
var studioItem = libraryManager . GetItemById ( id ) ;
return studioItem ! = null & & i . Studios . Contains ( studioItem . Name , StringComparer . OrdinalIgnoreCase ) ;
} ) )
{
return false ;
}
// Apply year filter
var years = request . GetYears ( ) ;
if ( years . Length > 0 & & ! ( i . ProductionYear . HasValue & & years . Contains ( i . ProductionYear . Value ) ) )
{
return false ;
}
// Apply person filter
if ( ! string . IsNullOrEmpty ( request . Person ) )
{
var personTypes = request . GetPersonTypes ( ) ;
if ( personTypes . Length = = 0 )
{
if ( ! ( i . People . Any ( p = > string . Equals ( p . Name , request . Person , StringComparison . OrdinalIgnoreCase ) ) ) )
{
return false ;
}
}
else
{
var types = personTypes ;
var ok = new [ ] { i } . Any ( item = >
item . People ! = null & &
item . People . Any ( p = >
p . Name . Equals ( request . Person , StringComparison . OrdinalIgnoreCase ) & & ( types . Contains ( p . Type , StringComparer . OrdinalIgnoreCase ) | | types . Contains ( p . Role , StringComparer . OrdinalIgnoreCase ) ) ) ) ;
if ( ! ok )
{
return false ;
}
}
}
}
if ( request . MinCommunityRating . HasValue )
{
var val = request . MinCommunityRating . Value ;
if ( ! ( i . CommunityRating . HasValue & & i . CommunityRating > = val ) )
{
return false ;
}
}
if ( request . MinCriticRating . HasValue )
{
var val = request . MinCriticRating . Value ;
var hasCriticRating = i as IHasCriticRating ;
if ( hasCriticRating ! = null )
{
if ( ! ( hasCriticRating . CriticRating . HasValue & & hasCriticRating . CriticRating > = val ) )
{
return false ;
}
}
else
{
return false ;
}
}
// Artists
if ( ! string . IsNullOrEmpty ( request . ArtistIds ) )
{
var artistIds = request . ArtistIds . Split ( '|' ) ;
var audio = i as IHasArtist ;
if ( ! ( audio ! = null & & artistIds . Any ( id = >
{
var artistItem = libraryManager . GetItemById ( id ) ;
return artistItem ! = null & & audio . HasAnyArtist ( artistItem . Name ) ;
} ) ) )
{
return false ;
}
}
// Artists
if ( ! string . IsNullOrEmpty ( request . Artists ) )
{
var artists = request . Artists . Split ( '|' ) ;
var audio = i as IHasArtist ;
if ( ! ( audio ! = null & & artists . Any ( audio . HasAnyArtist ) ) )
{
return false ;
}
}
// Albums
if ( ! string . IsNullOrEmpty ( request . Albums ) )
{
var albums = request . Albums . Split ( '|' ) ;
var audio = i as Audio ;
if ( audio ! = null )
{
if ( ! albums . Any ( a = > string . Equals ( a , audio . Album , StringComparison . OrdinalIgnoreCase ) ) )
{
return false ;
}
}
var album = i as MusicAlbum ;
if ( album ! = null )
{
if ( ! albums . Any ( a = > string . Equals ( a , album . Name , StringComparison . OrdinalIgnoreCase ) ) )
{
return false ;
}
}
var musicVideo = i as MusicVideo ;
if ( musicVideo ! = null )
{
if ( ! albums . Any ( a = > string . Equals ( a , musicVideo . Album , StringComparison . OrdinalIgnoreCase ) ) )
{
return false ;
}
}
return false ;
}
// Min index number
if ( request . MinIndexNumber . HasValue )
{
if ( ! ( i . IndexNumber . HasValue & & i . IndexNumber . Value > = request . MinIndexNumber . Value ) )
{
return false ;
}
}
// Min official rating
if ( ! string . IsNullOrEmpty ( request . MinOfficialRating ) )
{
var level = _localization . GetRatingLevel ( request . MinOfficialRating ) ;
if ( level . HasValue )
{
var rating = i . CustomRating ;
if ( string . IsNullOrEmpty ( rating ) )
{
rating = i . OfficialRating ;
}
if ( ! string . IsNullOrEmpty ( rating ) )
{
var itemLevel = _localization . GetRatingLevel ( rating ) ;
if ( ! ( ! itemLevel . HasValue | | itemLevel . Value > = level . Value ) )
{
return false ;
}
}
}
}
// Max official rating
if ( ! string . IsNullOrEmpty ( request . MaxOfficialRating ) )
{
var level = _localization . GetRatingLevel ( request . MaxOfficialRating ) ;
if ( level . HasValue )
{
var rating = i . CustomRating ;
if ( string . IsNullOrEmpty ( rating ) )
{
rating = i . OfficialRating ;
}
if ( ! string . IsNullOrEmpty ( rating ) )
{
var itemLevel = _localization . GetRatingLevel ( rating ) ;
if ( ! ( ! itemLevel . HasValue | | itemLevel . Value < = level . Value ) )
{
return false ;
}
}
}
}
// LocationTypes
if ( ! string . IsNullOrEmpty ( request . LocationTypes ) )
{
var vals = request . LocationTypes . Split ( ',' ) ;
if ( ! vals . Contains ( i . LocationType . ToString ( ) , StringComparer . OrdinalIgnoreCase ) )
{
return false ;
}
}
// ExcludeLocationTypes
if ( ! string . IsNullOrEmpty ( request . ExcludeLocationTypes ) )
{
var vals = request . ExcludeLocationTypes . Split ( ',' ) ;
if ( vals . Contains ( i . LocationType . ToString ( ) , StringComparer . OrdinalIgnoreCase ) )
{
return false ;
}
}
if ( ! string . IsNullOrEmpty ( request . AlbumArtistStartsWithOrGreater ) )
{
var ok = new [ ] { i } . OfType < IHasAlbumArtist > ( )
. Any ( p = > string . Compare ( request . AlbumArtistStartsWithOrGreater , p . AlbumArtists . FirstOrDefault ( ) , StringComparison . CurrentCultureIgnoreCase ) < 1 ) ;
if ( ! ok )
{
return false ;
}
}
// Filter by Series Status
if ( ! string . IsNullOrEmpty ( request . SeriesStatus ) )
{
var vals = request . SeriesStatus . Split ( ',' ) ;
var ok = new [ ] { i } . OfType < Series > ( ) . Any ( p = > p . Status . HasValue & & vals . Contains ( p . Status . Value . ToString ( ) , StringComparer . OrdinalIgnoreCase ) ) ;
if ( ! ok )
{
return false ;
}
}
// Filter by Series AirDays
if ( ! string . IsNullOrEmpty ( request . AirDays ) )
{
var days = request . AirDays . Split ( ',' ) . Select ( d = > ( DayOfWeek ) Enum . Parse ( typeof ( DayOfWeek ) , d , true ) ) ;
var ok = new [ ] { i } . OfType < Series > ( ) . Any ( p = > p . AirDays ! = null & & days . Any ( d = > p . AirDays . Contains ( d ) ) ) ;
if ( ! ok )
{
return false ;
}
}
if ( request . MinPlayers . HasValue )
{
var filterValue = request . MinPlayers . Value ;
var game = i as Game ;
if ( game ! = null )
{
var players = game . PlayersSupported ? ? 1 ;
var ok = players > = filterValue ;
if ( ! ok )
{
return false ;
}
}
else
{
return false ;
}
}
if ( request . MaxPlayers . HasValue )
{
var filterValue = request . MaxPlayers . Value ;
var game = i as Game ;
if ( game ! = null )
{
var players = game . PlayersSupported ? ? 1 ;
var ok = players < = filterValue ;
if ( ! ok )
{
return false ;
}
}
else
{
return false ;
}
}
if ( request . ParentIndexNumber . HasValue )
{
var filterValue = request . ParentIndexNumber . Value ;
var episode = i as Episode ;
if ( episode ! = null )
{
if ( episode . ParentIndexNumber . HasValue & & episode . ParentIndexNumber . Value ! = filterValue )
{
return false ;
}
}
var song = i as Audio ;
if ( song ! = null )
{
if ( song . ParentIndexNumber . HasValue & & song . ParentIndexNumber . Value ! = filterValue )
{
return false ;
}
}
}
if ( request . AiredDuringSeason . HasValue )
{
var episode = i as Episode ;
if ( episode = = null )
{
return false ;
}
if ( ! Series . FilterEpisodesBySeason ( new [ ] { episode } , request . AiredDuringSeason . Value , true ) . Any ( ) )
{
return false ;
}
}
if ( ! string . IsNullOrEmpty ( request . MinPremiereDate ) )
{
var date = DateTime . Parse ( request . MinPremiereDate , null , DateTimeStyles . RoundtripKind ) . ToUniversalTime ( ) ;
if ( ! ( i . PremiereDate . HasValue & & i . PremiereDate . Value > = date ) )
{
return false ;
}
}
if ( ! string . IsNullOrEmpty ( request . MaxPremiereDate ) )
{
var date = DateTime . Parse ( request . MaxPremiereDate , null , DateTimeStyles . RoundtripKind ) . ToUniversalTime ( ) ;
if ( ! ( i . PremiereDate . HasValue & & i . PremiereDate . Value < = date ) )
{
return false ;
}
}
return true ;
}
/// <summary>
/// Applies the paging.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="items">The items.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
private IEnumerable < BaseItem > ApplyPaging ( GetItems request , IEnumerable < BaseItem > items )
{
// Start at
if ( request . StartIndex . HasValue )
{
items = items . Skip ( request . StartIndex . Value ) ;
}
// Return limit
if ( request . Limit . HasValue )
{
items = items . Take ( request . Limit . Value ) ;
}
return items ;
}
}
/// <summary>
/// Class DateCreatedComparer
/// </summary>
public class DateCreatedComparer : IComparer < BaseItem >
{
/// <summary>
/// Compares the specified x.
/// </summary>
/// <param name="x">The x.</param>
/// <param name="y">The y.</param>
/// <returns>System.Int32.</returns>
public int Compare ( BaseItem x , BaseItem y )
{
return x . DateCreated . CompareTo ( y . DateCreated ) ;
}
}
}