jellyfin-server/MediaBrowser.Api/SimilarItemsHelper.cs

233 lines
10 KiB
C#
Raw Normal View History

using MediaBrowser.Controller.Dto;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Querying;
using System;
using System.Collections.Generic;
using System.Linq;
2016-06-19 06:18:29 +00:00
using System.Threading.Tasks;
using MediaBrowser.Model.Dto;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Services;
namespace MediaBrowser.Api
{
/// <summary>
2013-08-09 15:55:22 +00:00
/// Class BaseGetSimilarItemsFromItem
/// </summary>
2013-08-09 15:55:22 +00:00
public class BaseGetSimilarItemsFromItem : BaseGetSimilarItems
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Id { get; set; }
2016-07-22 17:54:43 +00:00
2016-07-22 22:10:39 +00:00
public string ExcludeArtistIds { get; set; }
2013-08-09 15:55:22 +00:00
}
2016-08-17 19:28:43 +00:00
public class BaseGetSimilarItems : IReturn<ItemsResult>, IHasDtoOptions
{
2016-08-17 19:28:43 +00:00
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool? EnableImages { get; set; }
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool? EnableUserData { get; set; }
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? ImageTypeLimit { get; set; }
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string EnableImageTypes { 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")]
2015-05-29 23:51:33 +00:00
public string UserId { get; set; }
/// <summary>
/// The maximum number of items to return
/// </summary>
/// <value>The limit.</value>
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
2013-06-04 02:02:49 +00:00
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
2017-04-29 06:22:33 +00:00
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
2013-06-04 02:02:49 +00:00
public string Fields { get; set; }
}
2013-09-17 02:44:06 +00:00
/// <summary>
/// Class SimilarItemsHelper
/// </summary>
public static class SimilarItemsHelper
{
2016-06-19 06:18:29 +00:00
internal static async Task<QueryResult<BaseItemDto>> GetSimilarItemsResult(DtoOptions dtoOptions, IUserManager userManager, IItemRepository itemRepository, ILibraryManager libraryManager, IUserDataManager userDataRepository, IDtoService dtoService, ILogger logger, BaseGetSimilarItemsFromItem request, Type[] includeTypes, Func<BaseItem, List<PersonInfo>, List<PersonInfo>, BaseItem, int> getSimilarityScore)
{
2015-05-29 23:51:33 +00:00
var user = !string.IsNullOrWhiteSpace(request.UserId) ? userManager.GetUserById(request.UserId) : null;
var item = string.IsNullOrEmpty(request.Id) ?
2015-05-29 23:51:33 +00:00
(!string.IsNullOrWhiteSpace(request.UserId) ? user.RootFolder :
2014-04-25 20:15:50 +00:00
libraryManager.RootFolder) : libraryManager.GetItemById(request.Id);
2016-03-25 03:53:42 +00:00
var query = new InternalItemsQuery(user)
{
IncludeItemTypes = includeTypes.Select(i => i.Name).ToArray(),
2016-10-08 05:57:38 +00:00
Recursive = true,
2016-10-10 18:18:28 +00:00
DtoOptions = dtoOptions
2016-03-25 03:53:42 +00:00
};
2016-07-22 22:10:39 +00:00
// ExcludeArtistIds
if (!string.IsNullOrEmpty(request.ExcludeArtistIds))
2016-07-22 17:54:43 +00:00
{
2016-07-22 22:10:39 +00:00
query.ExcludeArtistIds = request.ExcludeArtistIds.Split('|');
2016-07-22 17:54:43 +00:00
}
2016-03-25 03:53:42 +00:00
var inputItems = libraryManager.GetItemList(query);
2015-06-21 03:35:22 +00:00
var items = GetSimilaritems(item, libraryManager, inputItems, getSimilarityScore)
.ToList();
IEnumerable<BaseItem> returnItems = items;
if (request.Limit.HasValue)
{
returnItems = returnItems.Take(request.Limit.Value);
}
2016-06-19 06:18:29 +00:00
var dtos = await dtoService.GetBaseItemDtos(returnItems, dtoOptions, user).ConfigureAwait(false);
return new QueryResult<BaseItemDto>
{
2016-06-19 06:18:29 +00:00
Items = dtos.ToArray(),
TotalRecordCount = items.Count
};
}
/// <summary>
/// Gets the similaritems.
/// </summary>
/// <param name="item">The item.</param>
2015-06-21 03:35:22 +00:00
/// <param name="libraryManager">The library manager.</param>
/// <param name="inputItems">The input items.</param>
/// <param name="getSimilarityScore">The get similarity score.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
2015-07-08 16:10:34 +00:00
internal static IEnumerable<BaseItem> GetSimilaritems(BaseItem item, ILibraryManager libraryManager, IEnumerable<BaseItem> inputItems, Func<BaseItem, List<PersonInfo>, List<PersonInfo>, BaseItem, int> getSimilarityScore)
{
var itemId = item.Id;
inputItems = inputItems.Where(i => i.Id != itemId);
2015-07-08 16:10:34 +00:00
var itemPeople = libraryManager.GetPeople(item);
var allPeople = libraryManager.GetPeople(new InternalPeopleQuery
{
AppearsInItemId = item.Id
});
2015-07-08 16:10:34 +00:00
return inputItems.Select(i => new Tuple<BaseItem, int>(i, getSimilarityScore(item, itemPeople, allPeople, i)))
2013-07-21 14:20:57 +00:00
.Where(i => i.Item2 > 2)
.OrderByDescending(i => i.Item2)
.Select(i => i.Item1);
}
private static IEnumerable<string> GetTags(BaseItem item)
{
2016-06-02 17:43:29 +00:00
return item.Tags;
}
2014-01-14 15:50:39 +00:00
private static IEnumerable<string> GetKeywords(BaseItem item)
{
return item.Keywords;
2014-01-14 15:50:39 +00:00
}
/// <summary>
/// Gets the similiarity score.
/// </summary>
/// <param name="item1">The item1.</param>
2015-07-08 16:10:34 +00:00
/// <param name="item1People">The item1 people.</param>
/// <param name="allPeople">All people.</param>
/// <param name="item2">The item2.</param>
/// <returns>System.Int32.</returns>
2015-07-08 16:10:34 +00:00
internal static int GetSimiliarityScore(BaseItem item1, List<PersonInfo> item1People, List<PersonInfo> allPeople, BaseItem item2)
{
var points = 0;
if (!string.IsNullOrEmpty(item1.OfficialRating) && string.Equals(item1.OfficialRating, item2.OfficialRating, StringComparison.OrdinalIgnoreCase))
{
2014-03-13 09:00:47 +00:00
points += 10;
}
// Find common genres
2013-08-07 16:00:20 +00:00
points += item1.Genres.Where(i => item2.Genres.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
// Find common tags
points += GetTags(item1).Where(i => GetTags(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
2014-01-14 15:50:39 +00:00
// Find common keywords
points += GetKeywords(item1).Where(i => GetKeywords(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
2015-01-25 06:34:50 +00:00
// Find common studios
points += item1.Studios.Where(i => item2.Studios.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 3);
2015-07-08 16:10:34 +00:00
var item2PeopleNames = allPeople.Where(i => i.ItemId == item2.Id)
.Select(i => i.Name)
.Where(i => !string.IsNullOrWhiteSpace(i))
2015-04-09 21:11:57 +00:00
.DistinctNames()
.ToDictionary(i => i, StringComparer.OrdinalIgnoreCase);
2015-07-08 16:10:34 +00:00
points += item1People.Where(i => item2PeopleNames.ContainsKey(i.Name)).Sum(i =>
{
2013-08-07 16:00:20 +00:00
if (string.Equals(i.Type, PersonType.Director, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Director, StringComparison.OrdinalIgnoreCase))
{
return 5;
}
2013-08-07 16:00:20 +00:00
if (string.Equals(i.Type, PersonType.Actor, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Actor, StringComparison.OrdinalIgnoreCase))
{
return 3;
}
2013-08-07 16:00:20 +00:00
if (string.Equals(i.Type, PersonType.Composer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Composer, StringComparison.OrdinalIgnoreCase))
{
return 3;
}
2013-08-07 16:00:20 +00:00
if (string.Equals(i.Type, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase))
{
return 3;
}
2013-08-07 16:00:20 +00:00
if (string.Equals(i.Type, PersonType.Writer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Writer, StringComparison.OrdinalIgnoreCase))
{
return 2;
}
return 1;
});
if (item1.ProductionYear.HasValue && item2.ProductionYear.HasValue)
{
var diff = Math.Abs(item1.ProductionYear.Value - item2.ProductionYear.Value);
// Add if they came out within the same decade
if (diff < 10)
{
points += 2;
}
// And more if within five years
if (diff < 5)
{
points += 2;
}
}
return points;
}
}
}