SimilarItemsHelper.cs 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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. namespace MediaBrowser.Api
  13. {
  14. /// <summary>
  15. /// Class BaseGetSimilarItemsFromItem
  16. /// </summary>
  17. public class BaseGetSimilarItemsFromItem : BaseGetSimilarItems
  18. {
  19. /// <summary>
  20. /// Gets or sets the id.
  21. /// </summary>
  22. /// <value>The id.</value>
  23. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  24. public string Id { get; set; }
  25. }
  26. public class BaseGetSimilarItems : IReturn<ItemsResult>, IHasItemFields
  27. {
  28. /// <summary>
  29. /// Gets or sets the user id.
  30. /// </summary>
  31. /// <value>The user id.</value>
  32. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  33. public string UserId { get; set; }
  34. /// <summary>
  35. /// The maximum number of items to return
  36. /// </summary>
  37. /// <value>The limit.</value>
  38. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  39. public int? Limit { get; set; }
  40. /// <summary>
  41. /// Fields to return within the items, in addition to basic information
  42. /// </summary>
  43. /// <value>The fields.</value>
  44. [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)]
  45. public string Fields { get; set; }
  46. }
  47. /// <summary>
  48. /// Class SimilarItemsHelper
  49. /// </summary>
  50. public static class SimilarItemsHelper
  51. {
  52. /// <summary>
  53. /// Gets the similar items.
  54. /// </summary>
  55. /// <param name="dtoOptions">The dto options.</param>
  56. /// <param name="userManager">The user manager.</param>
  57. /// <param name="itemRepository">The item repository.</param>
  58. /// <param name="libraryManager">The library manager.</param>
  59. /// <param name="userDataRepository">The user data repository.</param>
  60. /// <param name="dtoService">The dto service.</param>
  61. /// <param name="logger">The logger.</param>
  62. /// <param name="request">The request.</param>
  63. /// <param name="includeInSearch">The include in search.</param>
  64. /// <param name="getSimilarityScore">The get similarity score.</param>
  65. /// <returns>ItemsResult.</returns>
  66. internal static ItemsResult GetSimilarItemsResult(DtoOptions dtoOptions, IUserManager userManager, IItemRepository itemRepository, ILibraryManager libraryManager, IUserDataManager userDataRepository, IDtoService dtoService, ILogger logger, BaseGetSimilarItemsFromItem request, Func<BaseItem, bool> includeInSearch, Func<BaseItem, BaseItem, int> getSimilarityScore)
  67. {
  68. var user = !string.IsNullOrWhiteSpace(request.UserId) ? userManager.GetUserById(request.UserId) : null;
  69. var item = string.IsNullOrEmpty(request.Id) ?
  70. (!string.IsNullOrWhiteSpace(request.UserId) ? user.RootFolder :
  71. libraryManager.RootFolder) : libraryManager.GetItemById(request.Id);
  72. Func<BaseItem, bool> filter = i => i.Id != item.Id && includeInSearch(i);
  73. var inputItems = user == null
  74. ? libraryManager.RootFolder.GetRecursiveChildren(filter)
  75. : user.RootFolder.GetRecursiveChildren(user, filter);
  76. var items = GetSimilaritems(item, inputItems, getSimilarityScore)
  77. .ToList();
  78. IEnumerable<BaseItem> returnItems = items;
  79. if (request.Limit.HasValue)
  80. {
  81. returnItems = returnItems.Take(request.Limit.Value);
  82. }
  83. var result = new ItemsResult
  84. {
  85. Items = dtoService.GetBaseItemDtos(returnItems, dtoOptions, user).ToArray(),
  86. TotalRecordCount = items.Count
  87. };
  88. return result;
  89. }
  90. /// <summary>
  91. /// Gets the similaritems.
  92. /// </summary>
  93. /// <param name="item">The item.</param>
  94. /// <param name="inputItems">The input items.</param>
  95. /// <param name="getSimilarityScore">The get similarity score.</param>
  96. /// <returns>IEnumerable{BaseItem}.</returns>
  97. internal static IEnumerable<BaseItem> GetSimilaritems(BaseItem item, IEnumerable<BaseItem> inputItems, Func<BaseItem, BaseItem, int> getSimilarityScore)
  98. {
  99. var itemId = item.Id;
  100. inputItems = inputItems.Where(i => i.Id != itemId);
  101. return inputItems.Select(i => new Tuple<BaseItem, int>(i, getSimilarityScore(item, i)))
  102. .Where(i => i.Item2 > 2)
  103. .OrderByDescending(i => i.Item2)
  104. .Select(i => i.Item1);
  105. }
  106. private static IEnumerable<string> GetTags(BaseItem item)
  107. {
  108. var hasTags = item as IHasTags;
  109. if (hasTags != null)
  110. {
  111. return hasTags.Tags;
  112. }
  113. return new List<string>();
  114. }
  115. private static IEnumerable<string> GetKeywords(BaseItem item)
  116. {
  117. var hasTags = item as IHasKeywords;
  118. if (hasTags != null)
  119. {
  120. return hasTags.Keywords;
  121. }
  122. return new List<string>();
  123. }
  124. /// <summary>
  125. /// Gets the similiarity score.
  126. /// </summary>
  127. /// <param name="item1">The item1.</param>
  128. /// <param name="item2">The item2.</param>
  129. /// <returns>System.Int32.</returns>
  130. internal static int GetSimiliarityScore(BaseItem item1, BaseItem item2)
  131. {
  132. var points = 0;
  133. if (!string.IsNullOrEmpty(item1.OfficialRating) && string.Equals(item1.OfficialRating, item2.OfficialRating, StringComparison.OrdinalIgnoreCase))
  134. {
  135. points += 10;
  136. }
  137. // Find common genres
  138. points += item1.Genres.Where(i => item2.Genres.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
  139. // Find common tags
  140. points += GetTags(item1).Where(i => GetTags(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
  141. // Find common keywords
  142. points += GetKeywords(item1).Where(i => GetKeywords(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
  143. // Find common studios
  144. points += item1.Studios.Where(i => item2.Studios.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 3);
  145. var item2PeopleNames = item2.People.Select(i => i.Name)
  146. .DistinctNames()
  147. .ToDictionary(i => i, StringComparer.OrdinalIgnoreCase);
  148. points += item1.People.Where(i => item2PeopleNames.ContainsKey(i.Name)).Sum(i =>
  149. {
  150. if (string.Equals(i.Type, PersonType.Director, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Director, StringComparison.OrdinalIgnoreCase))
  151. {
  152. return 5;
  153. }
  154. if (string.Equals(i.Type, PersonType.Actor, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Actor, StringComparison.OrdinalIgnoreCase))
  155. {
  156. return 3;
  157. }
  158. if (string.Equals(i.Type, PersonType.Composer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Composer, StringComparison.OrdinalIgnoreCase))
  159. {
  160. return 3;
  161. }
  162. if (string.Equals(i.Type, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase))
  163. {
  164. return 3;
  165. }
  166. if (string.Equals(i.Type, PersonType.Writer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Writer, StringComparison.OrdinalIgnoreCase))
  167. {
  168. return 2;
  169. }
  170. return 1;
  171. });
  172. if (item1.ProductionYear.HasValue && item2.ProductionYear.HasValue)
  173. {
  174. var diff = Math.Abs(item1.ProductionYear.Value - item2.ProductionYear.Value);
  175. // Add if they came out within the same decade
  176. if (diff < 10)
  177. {
  178. points += 2;
  179. }
  180. // And more if within five years
  181. if (diff < 5)
  182. {
  183. points += 2;
  184. }
  185. }
  186. return points;
  187. }
  188. }
  189. }