using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Querying; using ServiceStack.ServiceHost; using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace MediaBrowser.Api.UserLibrary { /// /// Class GetItems /// [Route("/Users/{UserId}/Items", "GET")] [Api(Description = "Gets items based on a query.")] public class GetItems : BaseItemsRequest, IReturn { /// /// Limit results to items containing a specific person /// /// The person. [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; } /// /// If the Person filter is used, this can also be used to restrict to a specific person type /// /// The type of the person. [ApiMember(Name = "PersonType", Description = "Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] public string PersonType { get; set; } /// /// Search characters used to find items /// /// The index by. [ApiMember(Name = "SearchTerm", Description = "Optional. If specified, results will be filtered based on a search term.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] public string SearchTerm { get; set; } /// /// The dynamic, localized index function name /// /// The index by. public string IndexBy { get; set; } /// /// What to sort the results by /// /// The sort by. [ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, CommunityRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Runtime", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string SortBy { get; set; } /// /// Filters to apply to the results /// /// The filters. [ApiMember(Name = "Filters", Description = "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsRecentlyAdded, IsResumable", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string Filters { get; set; } /// /// Limit results to items containing specific genres /// /// The genres. [ApiMember(Name = "Genres", Description = "Optional. If specified, results will be filtered based on genre. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string Genres { get; set; } /// /// Limit results to items containing specific studios /// /// The studios. [ApiMember(Name = "Studios", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string Studios { get; set; } /// /// Gets or sets the exclude item types. /// /// The exclude item types. [ApiMember(Name = "ExcludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string ExcludeItemTypes { get; set; } /// /// Gets or sets the include item types. /// /// The include item types. [ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string IncludeItemTypes { get; set; } /// /// Limit results to items containing specific years /// /// The years. [ApiMember(Name = "Years", Description = "Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string Years { get; set; } /// /// Gets or sets the image types. /// /// The image types. [ApiMember(Name = "ImageTypes", Description = "Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string ImageTypes { get; set; } /// /// Gets or sets the item ids. /// /// The item ids. [ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string Ids { get; set; } } /// /// Class ItemsService /// public class ItemsService : BaseApiService { /// /// The _user manager /// private readonly IUserManager _userManager; /// /// The _library manager /// private readonly ILibraryManager _libraryManager; private readonly ILibrarySearchEngine _searchEngine; /// /// Initializes a new instance of the class. /// /// The user manager. /// The library manager. /// The search engine. public ItemsService(IUserManager userManager, ILibraryManager libraryManager, ILibrarySearchEngine searchEngine) { _userManager = userManager; _libraryManager = libraryManager; _searchEngine = searchEngine; } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetItems request) { var result = GetItems(request).Result; return ToOptimizedResult(result); } /// /// Gets the items. /// /// The request. /// Task{ItemsResult}. private async Task GetItems(GetItems request) { var user = _userManager.GetUserById(request.UserId); var items = GetItemsToSerialize(request, user); // Apply filters // Run them starting with the ones that are likely to reduce the list the most foreach (var filter in GetFilters(request).OrderByDescending(f => (int)f)) { items = ApplyFilter(items, filter, user); } items = ApplyAdditionalFilters(request, items); items = ApplySearchTerm(request, items); items = ApplySortOrder(request, items, user); var itemsArray = items.ToArray(); var pagedItems = ApplyPaging(request, itemsArray); var fields = GetItemFields(request).ToList(); var dtoBuilder = new DtoBuilder(Logger, _libraryManager); var returnItems = await Task.WhenAll(pagedItems.Select(i => dtoBuilder.GetBaseItemDto(i, user, fields))).ConfigureAwait(false); return new ItemsResult { TotalRecordCount = itemsArray.Length, Items = returnItems }; } /// /// Gets the items to serialize. /// /// The request. /// The user. /// IEnumerable{BaseItem}. /// private IEnumerable GetItemsToSerialize(GetItems request, User user) { var item = string.IsNullOrEmpty(request.ParentId) ? user.RootFolder : DtoBuilder.GetItemByClientId(request.ParentId, _userManager, _libraryManager, user.Id); // Default list type = children if (!string.IsNullOrEmpty(request.Ids)) { var idList = request.Ids.Split(',').ToList(); return idList.Select(i => DtoBuilder.GetItemByClientId(i, _userManager, _libraryManager, user.Id)); } if (request.Recursive) { return ((Folder)item).GetRecursiveChildren(user); } return ((Folder)item).GetChildren(user, request.IndexBy); } /// /// Applies sort order /// /// The request. /// The items. /// The user. /// IEnumerable{BaseItem}. private IEnumerable ApplySortOrder(GetItems request, IEnumerable items, User user) { var orderBy = GetOrderBy(request).ToArray(); return orderBy.Length == 0 ? items : _libraryManager.Sort(items, user, orderBy, request.SortOrder ?? SortOrder.Ascending); } /// /// Applies filtering /// /// The items. /// The filter. /// The user. /// IEnumerable{BaseItem}. private IEnumerable ApplyFilter(IEnumerable items, ItemFilter filter, User user) { switch (filter) { case ItemFilter.Likes: return items.Where(item => { var userdata = item.GetUserData(user, false); return userdata != null && userdata.Likes.HasValue && userdata.Likes.Value; }); case ItemFilter.Dislikes: return items.Where(item => { var userdata = item.GetUserData(user, false); return userdata != null && userdata.Likes.HasValue && !userdata.Likes.Value; }); case ItemFilter.IsFavorite: return items.Where(item => { var userdata = item.GetUserData(user, false); return userdata != null && userdata.IsFavorite; }); case ItemFilter.IsRecentlyAdded: return items.Where(item => item.IsRecentlyAdded(user)); case ItemFilter.IsResumable: return items.Where(item => { var userdata = item.GetUserData(user, false); return userdata != null && userdata.PlaybackPositionTicks > 0; }); case ItemFilter.IsPlayed: return items.Where(item => { var userdata = item.GetUserData(user, false); return userdata != null && userdata.PlayCount > 0; }); case ItemFilter.IsUnplayed: return items.Where(item => { var userdata = item.GetUserData(user, false); return userdata == null || userdata.PlayCount == 0; }); case ItemFilter.IsFolder: return items.Where(item => item.IsFolder); case ItemFilter.IsNotFolder: return items.Where(item => !item.IsFolder); } return items; } /// /// Applies the additional filters. /// /// The request. /// The items. /// IEnumerable{BaseItem}. private IEnumerable ApplyAdditionalFilters(GetItems request, IEnumerable items) { var imageTypes = GetImageTypes(request).ToArray(); if (imageTypes.Length > 0) { items = items.Where(item => imageTypes.Any(imageType => HasImage(item, imageType))); } // Exclude item types var excludeItemTypes = request.ExcludeItemTypes; if (!string.IsNullOrEmpty(excludeItemTypes)) { var vals = excludeItemTypes.Split(','); items = items.Where(f => !vals.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase)); } var includeItemTypes = request.IncludeItemTypes; if (!string.IsNullOrEmpty(includeItemTypes)) { var vals = includeItemTypes.Split(','); items = items.Where(f => vals.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase)); } var genres = request.Genres; // Apply genre filter if (!string.IsNullOrEmpty(genres)) { var vals = genres.Split(','); items = items.Where(f => f.Genres != null && vals.Any(v => f.Genres.Contains(v, StringComparer.OrdinalIgnoreCase))); } var studios = request.Studios; // Apply studio filter if (!string.IsNullOrEmpty(studios)) { var vals = studios.Split(','); items = items.Where(f => f.Studios != null && vals.Any(v => f.Studios.Contains(v, StringComparer.OrdinalIgnoreCase))); } var years = request.Years; // Apply year filter if (!string.IsNullOrEmpty(years)) { var vals = years.Split(',').Select(int.Parse); items = items.Where(f => f.ProductionYear.HasValue && vals.Contains(f.ProductionYear.Value)); } var personName = request.Person; // Apply person filter if (!string.IsNullOrEmpty(personName)) { var personType = request.PersonType; items = !string.IsNullOrEmpty(personType) ? items.Where(item => item.People != null && item.People.Any(p => p.Name.Equals(personName, StringComparison.OrdinalIgnoreCase) && p.Type.Equals(personType, StringComparison.OrdinalIgnoreCase))) : items.Where(item => item.People != null && item.People.Any(p => p.Name.Equals(personName, StringComparison.OrdinalIgnoreCase))); } return items; } /// /// Determines whether the specified item has image. /// /// The item. /// Type of the image. /// true if the specified item has image; otherwise, false. private bool HasImage(BaseItem item, ImageType imageType) { if (imageType == ImageType.Backdrop) { return item.BackdropImagePaths != null && item.BackdropImagePaths.Count > 0; } if (imageType == ImageType.Screenshot) { return item.ScreenshotImagePaths != null && item.ScreenshotImagePaths.Count > 0; } if (imageType == ImageType.Chapter) { var video = item as Video; if (video != null) { return video.Chapters != null && video.Chapters.Any(c => !string.IsNullOrEmpty(c.ImagePath)); } return false; } return item.HasImage(imageType); } /// /// Applies the search term. /// /// The request. /// The items. /// IEnumerable{BaseItem}. private IEnumerable ApplySearchTerm(GetItems request, IEnumerable items) { var term = request.SearchTerm; if (!string.IsNullOrEmpty(term)) { items = _searchEngine.Search(items, request.SearchTerm); } return items; } /// /// Applies the paging. /// /// The request. /// The items. /// IEnumerable{BaseItem}. private IEnumerable ApplyPaging(GetItems request, IEnumerable 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; } /// /// Gets the filters. /// /// The request. /// IEnumerable{ItemFilter}. private IEnumerable GetFilters(GetItems request) { var val = request.Filters; if (string.IsNullOrEmpty(val)) { return new ItemFilter[] { }; } return val.Split(',').Select(v => (ItemFilter)Enum.Parse(typeof(ItemFilter), v, true)); } /// /// Gets the item fields. /// /// The request. /// IEnumerable{ItemFields}. private IEnumerable GetItemFields(GetItems request) { var val = request.Fields; if (string.IsNullOrEmpty(val)) { return new ItemFields[] { }; } return val.Split(',').Select(v => (ItemFields)Enum.Parse(typeof(ItemFields), v, true)); } /// /// Gets the order by. /// /// The request. /// IEnumerable{ItemSortBy}. private IEnumerable GetOrderBy(GetItems request) { var val = request.SortBy; if (string.IsNullOrEmpty(val)) { return new string[] { }; } return val.Split(','); } /// /// Gets the image types. /// /// The request. /// IEnumerable{ImageType}. private IEnumerable GetImageTypes(GetItems request) { var val = request.ImageTypes; if (string.IsNullOrEmpty(val)) { return new ImageType[] { }; } return val.Split(',').Select(v => (ImageType)Enum.Parse(typeof(ImageType), v, true)); } } /// /// Class DateCreatedComparer /// public class DateCreatedComparer : IComparer { /// /// Compares the specified x. /// /// The x. /// The y. /// System.Int32. public int Compare(BaseItem x, BaseItem y) { return x.DateCreated.CompareTo(y.DateCreated); } } }