SimilarItemsHelper.cs 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. using MediaBrowser.Controller.Dto;
  2. using MediaBrowser.Controller.Entities;
  3. using MediaBrowser.Controller.Library;
  4. using MediaBrowser.Controller.Persistence;
  5. using MediaBrowser.Model.Entities;
  6. using MediaBrowser.Model.Logging;
  7. using MediaBrowser.Model.Querying;
  8. using ServiceStack;
  9. using System;
  10. using System.Collections.Generic;
  11. using System.Linq;
  12. using System.Threading.Tasks;
  13. using MediaBrowser.Model.Dto;
  14. namespace MediaBrowser.Api
  15. {
  16. /// <summary>
  17. /// Class BaseGetSimilarItemsFromItem
  18. /// </summary>
  19. public class BaseGetSimilarItemsFromItem : BaseGetSimilarItems
  20. {
  21. /// <summary>
  22. /// Gets or sets the id.
  23. /// </summary>
  24. /// <value>The id.</value>
  25. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  26. public string Id { get; set; }
  27. public string ExcludeArtistIds { get; set; }
  28. }
  29. public class BaseGetSimilarItems : IReturn<ItemsResult>, IHasDtoOptions
  30. {
  31. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  32. public bool? EnableImages { get; set; }
  33. [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  34. public bool? EnableUserData { get; set; }
  35. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  36. public int? ImageTypeLimit { get; set; }
  37. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  38. public string EnableImageTypes { get; set; }
  39. /// <summary>
  40. /// Gets or sets the user id.
  41. /// </summary>
  42. /// <value>The user id.</value>
  43. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  44. public string UserId { get; set; }
  45. /// <summary>
  46. /// The maximum number of items to return
  47. /// </summary>
  48. /// <value>The limit.</value>
  49. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  50. public int? Limit { get; set; }
  51. /// <summary>
  52. /// Fields to return within the items, in addition to basic information
  53. /// </summary>
  54. /// <value>The fields.</value>
  55. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, 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)]
  56. public string Fields { get; set; }
  57. }
  58. /// <summary>
  59. /// Class SimilarItemsHelper
  60. /// </summary>
  61. public static class SimilarItemsHelper
  62. {
  63. 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)
  64. {
  65. var user = !string.IsNullOrWhiteSpace(request.UserId) ? userManager.GetUserById(request.UserId) : null;
  66. var item = string.IsNullOrEmpty(request.Id) ?
  67. (!string.IsNullOrWhiteSpace(request.UserId) ? user.RootFolder :
  68. libraryManager.RootFolder) : libraryManager.GetItemById(request.Id);
  69. var query = new InternalItemsQuery(user)
  70. {
  71. IncludeItemTypes = includeTypes.Select(i => i.Name).ToArray(),
  72. Recursive = true
  73. };
  74. // ExcludeArtistIds
  75. if (!string.IsNullOrEmpty(request.ExcludeArtistIds))
  76. {
  77. query.ExcludeArtistIds = request.ExcludeArtistIds.Split('|');
  78. }
  79. var inputItems = libraryManager.GetItemList(query);
  80. var items = GetSimilaritems(item, libraryManager, inputItems, getSimilarityScore)
  81. .ToList();
  82. IEnumerable<BaseItem> returnItems = items;
  83. if (request.Limit.HasValue)
  84. {
  85. returnItems = returnItems.Take(request.Limit.Value);
  86. }
  87. var dtos = await dtoService.GetBaseItemDtos(returnItems, dtoOptions, user).ConfigureAwait(false);
  88. return new QueryResult<BaseItemDto>
  89. {
  90. Items = dtos.ToArray(),
  91. TotalRecordCount = items.Count
  92. };
  93. }
  94. /// <summary>
  95. /// Gets the similaritems.
  96. /// </summary>
  97. /// <param name="item">The item.</param>
  98. /// <param name="libraryManager">The library manager.</param>
  99. /// <param name="inputItems">The input items.</param>
  100. /// <param name="getSimilarityScore">The get similarity score.</param>
  101. /// <returns>IEnumerable{BaseItem}.</returns>
  102. internal static IEnumerable<BaseItem> GetSimilaritems(BaseItem item, ILibraryManager libraryManager, IEnumerable<BaseItem> inputItems, Func<BaseItem, List<PersonInfo>, List<PersonInfo>, BaseItem, int> getSimilarityScore)
  103. {
  104. var itemId = item.Id;
  105. inputItems = inputItems.Where(i => i.Id != itemId);
  106. var itemPeople = libraryManager.GetPeople(item);
  107. var allPeople = libraryManager.GetPeople(new InternalPeopleQuery
  108. {
  109. AppearsInItemId = item.Id
  110. });
  111. return inputItems.Select(i => new Tuple<BaseItem, int>(i, getSimilarityScore(item, itemPeople, allPeople, i)))
  112. .Where(i => i.Item2 > 2)
  113. .OrderByDescending(i => i.Item2)
  114. .Select(i => i.Item1);
  115. }
  116. private static IEnumerable<string> GetTags(BaseItem item)
  117. {
  118. return item.Tags;
  119. }
  120. private static IEnumerable<string> GetKeywords(BaseItem item)
  121. {
  122. return item.Keywords;
  123. }
  124. /// <summary>
  125. /// Gets the similiarity score.
  126. /// </summary>
  127. /// <param name="item1">The item1.</param>
  128. /// <param name="item1People">The item1 people.</param>
  129. /// <param name="allPeople">All people.</param>
  130. /// <param name="item2">The item2.</param>
  131. /// <returns>System.Int32.</returns>
  132. internal static int GetSimiliarityScore(BaseItem item1, List<PersonInfo> item1People, List<PersonInfo> allPeople, BaseItem item2)
  133. {
  134. var points = 0;
  135. if (!string.IsNullOrEmpty(item1.OfficialRating) && string.Equals(item1.OfficialRating, item2.OfficialRating, StringComparison.OrdinalIgnoreCase))
  136. {
  137. points += 10;
  138. }
  139. // Find common genres
  140. points += item1.Genres.Where(i => item2.Genres.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
  141. // Find common tags
  142. points += GetTags(item1).Where(i => GetTags(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
  143. // Find common keywords
  144. points += GetKeywords(item1).Where(i => GetKeywords(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
  145. // Find common studios
  146. points += item1.Studios.Where(i => item2.Studios.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 3);
  147. var item2PeopleNames = allPeople.Where(i => i.ItemId == item2.Id)
  148. .Select(i => i.Name)
  149. .Where(i => !string.IsNullOrWhiteSpace(i))
  150. .DistinctNames()
  151. .ToDictionary(i => i, StringComparer.OrdinalIgnoreCase);
  152. points += item1People.Where(i => item2PeopleNames.ContainsKey(i.Name)).Sum(i =>
  153. {
  154. if (string.Equals(i.Type, PersonType.Director, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Director, StringComparison.OrdinalIgnoreCase))
  155. {
  156. return 5;
  157. }
  158. if (string.Equals(i.Type, PersonType.Actor, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Actor, StringComparison.OrdinalIgnoreCase))
  159. {
  160. return 3;
  161. }
  162. if (string.Equals(i.Type, PersonType.Composer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Composer, StringComparison.OrdinalIgnoreCase))
  163. {
  164. return 3;
  165. }
  166. if (string.Equals(i.Type, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase))
  167. {
  168. return 3;
  169. }
  170. if (string.Equals(i.Type, PersonType.Writer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Writer, StringComparison.OrdinalIgnoreCase))
  171. {
  172. return 2;
  173. }
  174. return 1;
  175. });
  176. if (item1.ProductionYear.HasValue && item2.ProductionYear.HasValue)
  177. {
  178. var diff = Math.Abs(item1.ProductionYear.Value - item2.ProductionYear.Value);
  179. // Add if they came out within the same decade
  180. if (diff < 10)
  181. {
  182. points += 2;
  183. }
  184. // And more if within five years
  185. if (diff < 5)
  186. {
  187. points += 2;
  188. }
  189. }
  190. return points;
  191. }
  192. }
  193. }