2014-03-12 03:11:01 +01:00
using MediaBrowser.Common.Extensions ;
2014-09-30 06:47:30 +02:00
using MediaBrowser.Controller.Channels ;
2014-03-12 03:11:01 +01:00
using MediaBrowser.Controller.Dto ;
2013-09-04 19:02:19 +02:00
using MediaBrowser.Controller.Entities ;
2013-05-26 01:52:41 +02:00
using MediaBrowser.Controller.Entities.Movies ;
using MediaBrowser.Controller.Library ;
2014-07-02 20:34:08 +02:00
using MediaBrowser.Controller.Net ;
2013-05-26 01:52:41 +02:00
using MediaBrowser.Controller.Persistence ;
2014-09-30 06:47:30 +02:00
using MediaBrowser.Model.Channels ;
2014-03-12 03:11:01 +01:00
using MediaBrowser.Model.Dto ;
using MediaBrowser.Model.Entities ;
using MediaBrowser.Model.Querying ;
2014-09-30 06:47:30 +02:00
using MoreLinq ;
2013-12-07 16:52:38 +01:00
using ServiceStack ;
2014-03-12 03:11:01 +01:00
using System ;
using System.Collections.Generic ;
using System.Linq ;
2014-09-30 06:47:30 +02:00
using System.Threading ;
using System.Threading.Tasks ;
2013-05-26 01:52:41 +02:00
2014-03-07 16:53:23 +01:00
namespace MediaBrowser.Api.Movies
2013-05-26 01:52:41 +02:00
{
/// <summary>
/// Class GetSimilarMovies
/// </summary>
2014-03-25 22:13:55 +01:00
[Route("/Movies/{Id}/Similar", "GET", Summary = "Finds movies and trailers similar to a given movie.")]
2013-08-09 17:55:22 +02:00
public class GetSimilarMovies : BaseGetSimilarItemsFromItem
2013-05-26 01:52:41 +02:00
{
}
2014-03-25 22:13:55 +01:00
[Route("/Movies/Recommendations", "GET", Summary = "Gets movie recommendations")]
2014-03-12 03:11:01 +01:00
public class GetMovieRecommendations : IReturn < RecommendationDto [ ] > , IHasItemFields
{
[ApiMember(Name = "CategoryLimit", Description = "The max number of categories to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int CategoryLimit { get ; set ; }
[ApiMember(Name = "ItemLimit", Description = "The max number of items to return per category", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int ItemLimit { get ; set ; }
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public Guid ? UserId { get ; set ; }
2014-05-02 04:54:33 +02:00
/// <summary>
/// Specify this to localize the search to a specific item or folder. Omit to use the root.
/// </summary>
/// <value>The parent id.</value>
[ApiMember(Name = "ParentId", Description = "Specify this to localize the search to a specific item or folder. Omit to use the root", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ParentId { get ; set ; }
2014-09-30 06:47:30 +02:00
2014-03-12 03:11:01 +01:00
public GetMovieRecommendations ( )
{
CategoryLimit = 5 ;
ItemLimit = 8 ;
}
public string Fields { get ; set ; }
}
2013-05-26 01:52:41 +02:00
/// <summary>
/// Class MoviesService
/// </summary>
2014-07-02 20:34:08 +02:00
[Authenticated]
2013-05-26 01:52:41 +02:00
public class MoviesService : BaseApiService
{
/// <summary>
/// The _user manager
/// </summary>
private readonly IUserManager _userManager ;
/// <summary>
/// The _user data repository
/// </summary>
2013-10-02 18:08:58 +02:00
private readonly IUserDataManager _userDataRepository ;
2013-05-26 01:52:41 +02:00
/// <summary>
/// The _library manager
/// </summary>
private readonly ILibraryManager _libraryManager ;
2013-06-18 21:16:27 +02:00
private readonly IItemRepository _itemRepo ;
2013-09-04 19:02:19 +02:00
private readonly IDtoService _dtoService ;
2014-09-30 06:47:30 +02:00
private readonly IChannelManager _channelManager ;
2013-05-26 01:52:41 +02:00
/// <summary>
/// Initializes a new instance of the <see cref="MoviesService"/> class.
/// </summary>
/// <param name="userManager">The user manager.</param>
/// <param name="userDataRepository">The user data repository.</param>
/// <param name="libraryManager">The library manager.</param>
2014-09-30 06:47:30 +02:00
public MoviesService ( IUserManager userManager , IUserDataManager userDataRepository , ILibraryManager libraryManager , IItemRepository itemRepo , IDtoService dtoService , IChannelManager channelManager )
2013-05-26 01:52:41 +02:00
{
_userManager = userManager ;
_userDataRepository = userDataRepository ;
_libraryManager = libraryManager ;
2013-06-18 21:16:27 +02:00
_itemRepo = itemRepo ;
2013-09-04 19:02:19 +02:00
_dtoService = dtoService ;
2014-09-30 06:47:30 +02:00
_channelManager = channelManager ;
2013-05-26 01:52:41 +02:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
2014-09-30 06:47:30 +02:00
public async Task < object > Get ( GetSimilarMovies request )
2013-05-26 01:52:41 +02:00
{
2014-09-30 06:47:30 +02:00
var result = await GetSimilarItemsResult (
2014-03-19 05:59:45 +01:00
// Strip out secondary versions
2014-09-30 06:47:30 +02:00
request , item = > ( item is Movie ) & & ! ( ( Video ) item ) . PrimaryVersionId . HasValue ,
2014-03-19 05:59:45 +01:00
2014-09-30 06:47:30 +02:00
SimilarItemsHelper . GetSimiliarityScore ) . ConfigureAwait ( false ) ;
2013-05-26 01:52:41 +02:00
2014-02-04 05:04:19 +01:00
return ToOptimizedSerializedResultUsingCache ( result ) ;
2013-05-26 01:52:41 +02:00
}
2014-03-12 03:11:01 +01:00
2014-09-30 06:47:30 +02:00
public async Task < object > Get ( GetMovieRecommendations request )
2014-03-12 03:11:01 +01:00
{
2014-03-23 06:10:33 +01:00
var user = _userManager . GetUserById ( request . UserId . Value ) ;
2014-03-12 03:11:01 +01:00
2014-05-02 04:54:33 +02:00
var movies = GetAllLibraryItems ( request . UserId , _userManager , _libraryManager , request . ParentId )
2014-09-30 06:47:30 +02:00
. Where ( i = > i is Movie ) ;
movies = _libraryManager . ReplaceVideosWithPrimaryVersions ( movies ) ;
2014-10-07 01:58:46 +02:00
var listEligibleForCategories = new List < BaseItem > ( ) ;
var listEligibleForSuggestion = new List < BaseItem > ( ) ;
2014-09-30 06:47:30 +02:00
var list = movies . ToList ( ) ;
2014-10-07 01:58:46 +02:00
listEligibleForCategories . AddRange ( list ) ;
listEligibleForSuggestion . AddRange ( list ) ;
2014-09-30 06:47:30 +02:00
if ( user . Configuration . IncludeTrailersInSuggestions )
{
var trailerResult = await _channelManager . GetAllMediaInternal ( new AllChannelMediaQuery
{
ContentTypes = new [ ] { ChannelMediaContentType . MovieExtra } ,
ExtraTypes = new [ ] { ExtraType . Trailer } ,
UserId = user . Id . ToString ( "N" )
2014-06-08 03:38:37 +02:00
2014-09-30 06:47:30 +02:00
} , CancellationToken . None ) . ConfigureAwait ( false ) ;
2014-03-12 03:11:01 +01:00
2014-10-07 01:58:46 +02:00
listEligibleForSuggestion . AddRange ( trailerResult . Items ) ;
}
2014-09-30 06:47:30 +02:00
2014-10-07 01:58:46 +02:00
listEligibleForCategories = listEligibleForCategories
. DistinctBy ( i = > i . Name , StringComparer . OrdinalIgnoreCase )
. DistinctBy ( i = > i . GetProviderId ( MetadataProviders . Imdb ) ? ? Guid . NewGuid ( ) . ToString ( ) , StringComparer . OrdinalIgnoreCase )
. ToList ( ) ;
2014-09-30 06:47:30 +02:00
2014-10-07 01:58:46 +02:00
listEligibleForSuggestion = listEligibleForSuggestion
. DistinctBy ( i = > i . Name , StringComparer . OrdinalIgnoreCase )
. DistinctBy ( i = > i . GetProviderId ( MetadataProviders . Imdb ) ? ? Guid . NewGuid ( ) . ToString ( ) , StringComparer . OrdinalIgnoreCase )
. ToList ( ) ;
2014-09-30 06:47:30 +02:00
2014-10-07 01:58:46 +02:00
var result = GetRecommendationCategories ( user , listEligibleForCategories , listEligibleForSuggestion , request . CategoryLimit , request . ItemLimit , request . GetItemFields ( ) . ToList ( ) ) ;
2014-03-12 03:11:01 +01:00
return ToOptimizedResult ( result ) ;
}
2014-09-30 06:47:30 +02:00
private async Task < ItemsResult > GetSimilarItemsResult ( BaseGetSimilarItemsFromItem request , Func < BaseItem , bool > includeInSearch , Func < BaseItem , BaseItem , int > getSimilarityScore )
{
var user = request . UserId . HasValue ? _userManager . GetUserById ( request . UserId . Value ) : null ;
var item = string . IsNullOrEmpty ( request . Id ) ?
( request . UserId . HasValue ? user . RootFolder :
_libraryManager . RootFolder ) : _libraryManager . GetItemById ( request . Id ) ;
var fields = request . GetItemFields ( ) . ToList ( ) ;
var inputItems = user = = null
? _libraryManager . RootFolder . GetRecursiveChildren ( ) . Where ( i = > i . Id ! = item . Id )
: user . RootFolder . GetRecursiveChildren ( user ) . Where ( i = > i . Id ! = item . Id ) ;
inputItems = inputItems . Where ( includeInSearch ) ;
var list = inputItems . ToList ( ) ;
if ( item is Movie & & user ! = null & & user . Configuration . IncludeTrailersInSuggestions )
{
var trailerResult = await _channelManager . GetAllMediaInternal ( new AllChannelMediaQuery
{
ContentTypes = new [ ] { ChannelMediaContentType . MovieExtra } ,
ExtraTypes = new [ ] { ExtraType . Trailer } ,
UserId = user . Id . ToString ( "N" )
} , CancellationToken . None ) . ConfigureAwait ( false ) ;
var newTrailers = trailerResult . Items ;
list . AddRange ( newTrailers ) ;
list = list
. DistinctBy ( i = > i . Name , StringComparer . OrdinalIgnoreCase )
. DistinctBy ( i = > i . GetProviderId ( MetadataProviders . Imdb ) ? ? Guid . NewGuid ( ) . ToString ( ) , StringComparer . OrdinalIgnoreCase )
. ToList ( ) ;
}
var items = SimilarItemsHelper . GetSimilaritems ( item , list , getSimilarityScore ) . ToList ( ) ;
IEnumerable < BaseItem > returnItems = items ;
if ( request . Limit . HasValue )
{
returnItems = returnItems . Take ( request . Limit . Value ) ;
}
var result = new ItemsResult
{
Items = returnItems . Select ( i = > _dtoService . GetBaseItemDto ( i , fields , user ) ) . ToArray ( ) ,
TotalRecordCount = items . Count
} ;
return result ;
}
2014-10-07 01:58:46 +02:00
private IEnumerable < RecommendationDto > GetRecommendationCategories ( User user , List < BaseItem > allMoviesForCategories , List < BaseItem > allMovies , int categoryLimit , int itemLimit , List < ItemFields > fields )
2014-03-12 03:11:01 +01:00
{
var categories = new List < RecommendationDto > ( ) ;
2014-10-07 01:58:46 +02:00
var recentlyPlayedMovies = allMoviesForCategories
2014-03-12 03:11:01 +01:00
. Select ( i = >
{
var userdata = _userDataRepository . GetUserData ( user . Id , i . GetUserDataKey ( ) ) ;
2014-09-30 06:47:30 +02:00
return new Tuple < BaseItem , bool , DateTime > ( i , userdata . Played , userdata . LastPlayedDate ? ? DateTime . MinValue ) ;
2014-03-12 03:11:01 +01:00
} )
. Where ( i = > i . Item2 )
. OrderByDescending ( i = > i . Item3 )
. Select ( i = > i . Item1 )
. ToList ( ) ;
var excludeFromLiked = recentlyPlayedMovies . Take ( 10 ) ;
var likedMovies = allMovies
. Select ( i = >
{
var score = 0 ;
var userData = _userDataRepository . GetUserData ( user . Id , i . GetUserDataKey ( ) ) ;
if ( userData . IsFavorite )
{
score = 2 ;
}
else
{
score = userData . Likes . HasValue ? userData . Likes . Value ? 1 : - 1 : 0 ;
}
2014-09-30 06:47:30 +02:00
return new Tuple < BaseItem , int > ( i , score ) ;
2014-03-12 03:11:01 +01:00
} )
. OrderByDescending ( i = > i . Item2 )
. ThenBy ( i = > Guid . NewGuid ( ) )
. Where ( i = > i . Item2 > 0 )
. Select ( i = > i . Item1 )
. Where ( i = > ! excludeFromLiked . Contains ( i ) ) ;
var mostRecentMovies = recentlyPlayedMovies . Take ( 6 ) . ToList ( ) ;
// Get recently played directors
var recentDirectors = GetDirectors ( mostRecentMovies )
. OrderBy ( i = > Guid . NewGuid ( ) )
. ToList ( ) ;
// Get recently played actors
var recentActors = GetActors ( mostRecentMovies )
. OrderBy ( i = > Guid . NewGuid ( ) )
. ToList ( ) ;
2014-03-12 20:56:12 +01:00
var similarToRecentlyPlayed = GetSimilarTo ( user , allMovies , recentlyPlayedMovies . Take ( 7 ) . OrderBy ( i = > Guid . NewGuid ( ) ) , itemLimit , fields , RecommendationType . SimilarToRecentlyPlayed ) . GetEnumerator ( ) ;
2014-03-12 03:11:01 +01:00
var similarToLiked = GetSimilarTo ( user , allMovies , likedMovies , itemLimit , fields , RecommendationType . SimilarToLikedItem ) . GetEnumerator ( ) ;
var hasDirectorFromRecentlyPlayed = GetWithDirector ( user , allMovies , recentDirectors , itemLimit , fields , RecommendationType . HasDirectorFromRecentlyPlayed ) . GetEnumerator ( ) ;
var hasActorFromRecentlyPlayed = GetWithActor ( user , allMovies , recentActors , itemLimit , fields , RecommendationType . HasActorFromRecentlyPlayed ) . GetEnumerator ( ) ;
var categoryTypes = new List < IEnumerator < RecommendationDto > >
{
// Give this extra weight
similarToRecentlyPlayed ,
similarToRecentlyPlayed ,
// Give this extra weight
similarToLiked ,
similarToLiked ,
hasDirectorFromRecentlyPlayed ,
hasActorFromRecentlyPlayed
} ;
while ( categories . Count < categoryLimit )
{
var allEmpty = true ;
foreach ( var category in categoryTypes )
{
if ( category . MoveNext ( ) )
{
categories . Add ( category . Current ) ;
allEmpty = false ;
if ( categories . Count > = categoryLimit )
{
break ;
}
}
}
if ( allEmpty )
{
break ;
}
}
return categories . OrderBy ( i = > i . RecommendationType ) . ThenBy ( i = > Guid . NewGuid ( ) ) ;
}
2014-09-30 06:47:30 +02:00
private IEnumerable < RecommendationDto > GetWithDirector ( User user , List < BaseItem > allMovies , IEnumerable < string > directors , int itemLimit , List < ItemFields > fields , RecommendationType type )
2014-03-12 03:11:01 +01:00
{
var userId = user . Id ;
foreach ( var director in directors )
{
var items = allMovies
2014-04-22 19:25:54 +02:00
. Where ( i = > i . People . Any ( p = > string . Equals ( p . Type , PersonType . Director , StringComparison . OrdinalIgnoreCase ) & & string . Equals ( p . Name , director , StringComparison . OrdinalIgnoreCase ) ) )
2014-03-12 03:11:01 +01:00
. Take ( itemLimit )
. ToList ( ) ;
if ( items . Count > 0 )
{
yield return new RecommendationDto
{
BaselineItemName = director ,
CategoryId = director . GetMD5 ( ) . ToString ( "N" ) ,
RecommendationType = type ,
Items = items . Select ( i = > _dtoService . GetBaseItemDto ( i , fields , user ) ) . ToArray ( )
} ;
}
}
}
2014-09-30 06:47:30 +02:00
private IEnumerable < RecommendationDto > GetWithActor ( User user , List < BaseItem > allMovies , IEnumerable < string > names , int itemLimit , List < ItemFields > fields , RecommendationType type )
2014-03-12 03:11:01 +01:00
{
var userId = user . Id ;
foreach ( var name in names )
{
var items = allMovies
2014-04-22 19:25:54 +02:00
. Where ( i = > i . People . Any ( p = > string . Equals ( p . Name , name , StringComparison . OrdinalIgnoreCase ) ) )
2014-03-12 03:11:01 +01:00
. Take ( itemLimit )
. ToList ( ) ;
if ( items . Count > 0 )
{
yield return new RecommendationDto
{
BaselineItemName = name ,
CategoryId = name . GetMD5 ( ) . ToString ( "N" ) ,
RecommendationType = type ,
Items = items . Select ( i = > _dtoService . GetBaseItemDto ( i , fields , user ) ) . ToArray ( )
} ;
}
}
}
2014-09-30 06:47:30 +02:00
private IEnumerable < RecommendationDto > GetSimilarTo ( User user , List < BaseItem > allMovies , IEnumerable < BaseItem > baselineItems , int itemLimit , List < ItemFields > fields , RecommendationType type )
2014-03-12 03:11:01 +01:00
{
var userId = user . Id ;
foreach ( var item in baselineItems )
{
var similar = SimilarItemsHelper
. GetSimilaritems ( item , allMovies , SimilarItemsHelper . GetSimiliarityScore )
. Take ( itemLimit )
. ToList ( ) ;
if ( similar . Count > 0 )
{
yield return new RecommendationDto
{
BaselineItemName = item . Name ,
CategoryId = item . Id . ToString ( "N" ) ,
RecommendationType = type ,
Items = similar . Select ( i = > _dtoService . GetBaseItemDto ( i , fields , user ) ) . ToArray ( )
} ;
}
}
}
private IEnumerable < string > GetActors ( IEnumerable < BaseItem > items )
{
// Get the two leading actors for all movies
return items
. SelectMany ( i = > i . People . Where ( p = > ! string . Equals ( PersonType . Director , p . Type , StringComparison . OrdinalIgnoreCase ) ) . Take ( 2 ) )
. Select ( i = > i . Name )
. Distinct ( StringComparer . OrdinalIgnoreCase ) ;
}
private IEnumerable < string > GetDirectors ( IEnumerable < BaseItem > items )
{
return items
. Select ( i = > i . People . FirstOrDefault ( p = > string . Equals ( PersonType . Director , p . Type , StringComparison . OrdinalIgnoreCase ) ) )
. Where ( i = > i ! = null )
. Select ( i = > i . Name )
. Distinct ( StringComparer . OrdinalIgnoreCase ) ;
}
2013-05-26 01:52:41 +02:00
}
}