jellyfin/MediaBrowser.Api/UserLibrary/BaseItemsByNameService.cs

316 lines
12 KiB
C#
Raw Normal View History

using MediaBrowser.Controller.Dto;
using MediaBrowser.Controller.Entities;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Model.Dto;
2013-03-10 05:36:39 +00:00
using MediaBrowser.Model.Querying;
2013-12-07 15:52:38 +00:00
using ServiceStack;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
using System.Linq;
namespace MediaBrowser.Api.UserLibrary
{
/// <summary>
/// Class BaseItemsByNameService
/// </summary>
/// <typeparam name="TItemType">The type of the T item type.</typeparam>
2013-03-16 05:52:33 +00:00
public abstract class BaseItemsByNameService<TItemType> : BaseApiService
where TItemType : BaseItem, IItemByName
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// The _user manager
/// </summary>
protected readonly IUserManager UserManager;
2013-03-11 05:06:55 +00:00
/// <summary>
/// The library manager
/// </summary>
protected readonly ILibraryManager LibraryManager;
2013-10-02 16:08:58 +00:00
protected readonly IUserDataManager UserDataRepository;
2013-06-18 19:16:27 +00:00
protected readonly IItemRepository ItemRepository;
2013-09-04 17:02:19 +00:00
protected IDtoService DtoService { get; private set; }
/// <summary>
/// Initializes a new instance of the <see cref="BaseItemsByNameService{TItemType}" /> class.
/// </summary>
/// <param name="userManager">The user manager.</param>
2013-03-11 05:06:55 +00:00
/// <param name="libraryManager">The library manager.</param>
/// <param name="userDataRepository">The user data repository.</param>
/// <param name="itemRepository">The item repository.</param>
/// <param name="dtoService">The dto service.</param>
2013-10-02 16:08:58 +00:00
protected BaseItemsByNameService(IUserManager userManager, ILibraryManager libraryManager, IUserDataManager userDataRepository, IItemRepository itemRepository, IDtoService dtoService)
{
UserManager = userManager;
LibraryManager = libraryManager;
UserDataRepository = userDataRepository;
2013-06-18 19:16:27 +00:00
ItemRepository = itemRepository;
2013-09-04 17:02:19 +00:00
DtoService = dtoService;
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-09-27 12:24:28 +00:00
protected ItemsResult GetResult(GetItemsByName request)
2013-02-21 01:33:05 +00:00
{
2013-04-22 04:38:03 +00:00
User user = null;
BaseItem item;
2013-02-21 01:33:05 +00:00
2013-04-22 04:38:03 +00:00
if (request.UserId.HasValue)
{
user = UserManager.GetUserById(request.UserId.Value);
2013-09-04 17:02:19 +00:00
item = string.IsNullOrEmpty(request.ParentId) ? user.RootFolder : DtoService.GetItemByDtoId(request.ParentId, user.Id);
2013-04-22 04:38:03 +00:00
}
else
{
2013-09-04 17:02:19 +00:00
item = string.IsNullOrEmpty(request.ParentId) ? LibraryManager.RootFolder : DtoService.GetItemByDtoId(request.ParentId);
2013-04-22 04:38:03 +00:00
}
2013-02-21 01:33:05 +00:00
IEnumerable<BaseItem> items;
if (item.IsFolder)
{
var folder = (Folder)item;
2013-04-22 04:38:03 +00:00
if (request.UserId.HasValue)
{
2013-07-05 13:47:10 +00:00
items = request.Recursive ? folder.GetRecursiveChildren(user) : folder.GetChildren(user, true);
2013-04-22 04:38:03 +00:00
}
else
{
2013-09-27 12:24:28 +00:00
items = request.Recursive ? folder.GetRecursiveChildren() : folder.Children;
2013-04-22 04:38:03 +00:00
}
2013-02-21 01:33:05 +00:00
}
else
{
items = new[] { item };
}
2013-04-22 04:38:03 +00:00
items = FilterItems(request, items);
2013-04-11 19:36:50 +00:00
var extractedItems = GetAllItems(request, items);
var filteredItems = FilterItems(request, extractedItems, user);
2014-01-14 20:03:35 +00:00
filteredItems = FilterByLibraryItems(request, filteredItems, user);
filteredItems = ItemsService.ApplySortOrder(request, filteredItems, user, LibraryManager).Cast<TItemType>();
var ibnItemsArray = filteredItems.ToList();
IEnumerable<TItemType> ibnItems = ibnItemsArray;
2013-02-21 01:33:05 +00:00
var result = new ItemsResult
{
TotalRecordCount = ibnItemsArray.Count
2013-02-21 01:33:05 +00:00
};
if (request.StartIndex.HasValue || request.Limit.HasValue)
2013-02-21 01:33:05 +00:00
{
if (request.StartIndex.HasValue)
{
ibnItems = ibnItems.Skip(request.StartIndex.Value);
}
if (request.Limit.HasValue)
2013-02-21 01:33:05 +00:00
{
ibnItems = ibnItems.Take(request.Limit.Value);
2013-02-21 01:33:05 +00:00
}
}
2013-04-11 19:36:50 +00:00
var fields = request.GetItemFields().ToList();
2013-03-02 07:16:52 +00:00
2013-09-17 02:44:06 +00:00
var dtos = ibnItems.Select(i => GetDto(i, user, fields));
2013-02-21 01:33:05 +00:00
2013-09-17 02:44:06 +00:00
result.Items = dtos.Where(i => i != null).ToArray();
2013-02-21 01:33:05 +00:00
return result;
}
2014-01-14 20:03:35 +00:00
private IEnumerable<TItemType> FilterByLibraryItems(GetItemsByName request, IEnumerable<TItemType> items, User user)
{
var filters = request.GetFilters().ToList();
if (filters.Contains(ItemFilter.IsPlayed))
{
var libraryItems = user.RootFolder.GetRecursiveChildren(user).ToList();
2014-01-15 22:19:37 +00:00
items = items.Where(i => GetLibraryItems(i, libraryItems).All(l => l.IsPlayed(user)));
2014-01-14 20:03:35 +00:00
}
if (filters.Contains(ItemFilter.IsUnplayed))
{
var libraryItems = user.RootFolder.GetRecursiveChildren(user).ToList();
2014-01-15 22:19:37 +00:00
items = items.Where(i => GetLibraryItems(i, libraryItems).All(l => !l.IsPlayed(user)));
2014-01-14 20:03:35 +00:00
}
return items;
}
protected abstract IEnumerable<BaseItem> GetLibraryItems(TItemType item, IEnumerable<BaseItem> libraryItems);
/// <summary>
/// Filters the items.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="items">The items.</param>
/// <param name="user">The user.</param>
/// <returns>IEnumerable{`0}.</returns>
private IEnumerable<TItemType> FilterItems(GetItemsByName request, IEnumerable<TItemType> items, User user)
{
2013-05-17 03:24:41 +00:00
if (!string.IsNullOrEmpty(request.NameStartsWithOrGreater))
2013-05-16 20:46:18 +00:00
{
2013-10-04 15:22:03 +00:00
items = items.Where(i => string.Compare(request.NameStartsWithOrGreater, i.SortName, StringComparison.CurrentCultureIgnoreCase) < 1);
}
if (!string.IsNullOrEmpty(request.NameLessThan))
{
items = items.Where(i => string.Compare(request.NameLessThan, i.SortName, StringComparison.CurrentCultureIgnoreCase) == 1);
2013-05-16 20:46:18 +00:00
}
var imageTypes = request.GetImageTypes().ToList();
if (imageTypes.Count > 0)
2013-09-06 05:13:43 +00:00
{
items = items.Where(item => imageTypes.Any(imageType => ItemsService.HasImage(item, imageType)));
2013-09-06 05:13:43 +00:00
}
2013-09-10 19:30:56 +00:00
var filters = request.GetFilters().ToList();
if (filters.Count == 0)
{
return items;
}
items = items.AsParallel();
if (filters.Contains(ItemFilter.Dislikes))
{
items = items.Where(i =>
2013-09-10 19:30:56 +00:00
{
var userdata = UserDataRepository.GetUserData(user.Id, i.GetUserDataKey());
2013-09-10 19:30:56 +00:00
return userdata != null && userdata.Likes.HasValue && !userdata.Likes.Value;
});
}
if (filters.Contains(ItemFilter.Likes))
{
items = items.Where(i =>
{
var userdata = UserDataRepository.GetUserData(user.Id, i.GetUserDataKey());
return userdata != null && userdata.Likes.HasValue && userdata.Likes.Value;
});
}
2013-07-30 20:31:25 +00:00
if (filters.Contains(ItemFilter.IsFavoriteOrLikes))
{
items = items.Where(i =>
{
var userdata = UserDataRepository.GetUserData(user.Id, i.GetUserDataKey());
2013-07-30 20:31:25 +00:00
var likes = userdata.Likes ?? false;
var favorite = userdata.IsFavorite;
return likes || favorite;
});
}
2013-09-10 19:30:56 +00:00
if (filters.Contains(ItemFilter.IsFavorite))
{
items = items.Where(i =>
{
var userdata = UserDataRepository.GetUserData(user.Id, i.GetUserDataKey());
2013-10-21 03:01:22 +00:00
return userdata != null && userdata.IsFavorite;
});
}
2013-09-10 19:30:56 +00:00
return items.AsEnumerable();
}
2013-09-10 19:30:56 +00:00
2013-03-02 07:16:52 +00:00
/// <summary>
2013-04-11 19:36:50 +00:00
/// Filters the items.
2013-03-02 07:16:52 +00:00
/// </summary>
/// <param name="request">The request.</param>
2013-04-11 19:36:50 +00:00
/// <param name="items">The items.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
2013-04-24 14:30:12 +00:00
protected virtual IEnumerable<BaseItem> FilterItems(GetItemsByName request, IEnumerable<BaseItem> items)
2013-03-02 07:16:52 +00:00
{
// Exclude item types
if (!string.IsNullOrEmpty(request.ExcludeItemTypes))
2013-03-02 07:16:52 +00:00
{
var vals = request.ExcludeItemTypes.Split(',');
items = items.Where(f => !vals.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase));
2013-03-02 07:16:52 +00:00
}
// Include item types
if (!string.IsNullOrEmpty(request.IncludeItemTypes))
{
var vals = request.IncludeItemTypes.Split(',');
items = items.Where(f => vals.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase));
}
2013-04-11 19:36:50 +00:00
2013-04-24 20:28:42 +00:00
// Include MediaTypes
if (!string.IsNullOrEmpty(request.MediaTypes))
{
var vals = request.MediaTypes.Split(',');
items = items.Where(f => vals.Contains(f.MediaType ?? string.Empty, StringComparer.OrdinalIgnoreCase));
}
2013-09-10 19:30:56 +00:00
2013-04-11 19:36:50 +00:00
return items;
2013-03-02 07:16:52 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets all items.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="items">The items.</param>
/// <returns>IEnumerable{Task{`0}}.</returns>
protected abstract IEnumerable<TItemType> GetAllItems(GetItemsByName request, IEnumerable<BaseItem> items);
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the dto.
/// </summary>
/// <param name="item">The item.</param>
2013-02-21 01:33:05 +00:00
/// <param name="user">The user.</param>
/// <param name="fields">The fields.</param>
/// <returns>Task{DtoBaseItem}.</returns>
2013-09-17 02:44:06 +00:00
private BaseItemDto GetDto(TItemType item, User user, List<ItemFields> fields)
2013-02-21 01:33:05 +00:00
{
2013-09-17 02:44:06 +00:00
var dto = user == null ? DtoService.GetBaseItemDto(item, fields) :
DtoService.GetBaseItemDto(item, fields, user);
2013-02-21 01:33:05 +00:00
return dto;
}
}
/// <summary>
/// Class GetItemsByName
/// </summary>
2013-03-11 05:06:55 +00:00
public class GetItemsByName : BaseItemsRequest, IReturn<ItemsResult>
2013-02-21 01:33:05 +00:00
{
2013-04-22 04:38:03 +00:00
/// <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; }
2013-05-17 03:24:41 +00:00
[ApiMember(Name = "NameStartsWithOrGreater", Description = "Optional filter by items whose name is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string NameStartsWithOrGreater { get; set; }
2013-09-10 19:30:56 +00:00
2013-10-04 15:22:03 +00:00
[ApiMember(Name = "NameLessThan", Description = "Optional filter by items whose name is sorted less than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string NameLessThan { get; set; }
2013-04-22 04:38:03 +00:00
public GetItemsByName()
{
Recursive = true;
}
2013-02-21 01:33:05 +00:00
}
}