jellyfin/MediaBrowser.Api/UserLibrary/PersonsService.cs

169 lines
6.1 KiB
C#
Raw Normal View History

2013-04-22 04:38:03 +00:00
using MediaBrowser.Controller.Dto;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Library;
2014-07-02 18:34:08 +00:00
using MediaBrowser.Controller.Net;
using MediaBrowser.Controller.Persistence;
2013-04-17 05:36:56 +00:00
using MediaBrowser.Model.Dto;
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 GetPersons
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Persons", "GET", Summary = "Gets all persons from a given item, folder, or the entire library")]
2013-02-21 01:33:05 +00:00
public class GetPersons : GetItemsByName
{
/// <summary>
/// Gets or sets the person types.
/// </summary>
/// <value>The person types.</value>
[ApiMember(Name = "PersonTypes", Description = "Optional filter by person type. Accepts multiple, comma-delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
2013-02-21 01:33:05 +00:00
public string PersonTypes { get; set; }
}
2013-04-17 05:36:56 +00:00
2013-04-22 04:38:03 +00:00
/// <summary>
/// Class GetPerson
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Persons/{Name}", "GET", Summary = "Gets a person, by name")]
2013-04-22 04:38:03 +00:00
public class GetPerson : IReturn<BaseItemDto>
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The person name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { 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")]
public Guid? UserId { get; set; }
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class PersonsService
/// </summary>
2014-07-02 18:34:08 +00:00
[Authenticated]
2013-02-21 01:33:05 +00:00
public class PersonsService : BaseItemsByNameService<Person>
{
2013-04-17 05:36:56 +00:00
/// <summary>
2013-06-18 19:16:27 +00:00
/// Initializes a new instance of the <see cref="PersonsService" /> class.
2013-04-17 05:36:56 +00:00
/// </summary>
/// <param name="userManager">The user manager.</param>
/// <param name="libraryManager">The library manager.</param>
/// <param name="userDataRepository">The user data repository.</param>
2013-06-18 19:16:27 +00:00
/// <param name="itemRepo">The item repo.</param>
2013-10-02 16:08:58 +00:00
public PersonsService(IUserManager userManager, ILibraryManager libraryManager, IUserDataManager userDataRepository, IItemRepository itemRepo, IDtoService dtoService)
2013-09-04 17:02:19 +00:00
: base(userManager, libraryManager, userDataRepository, itemRepo, dtoService)
{
}
2013-04-22 04:38:03 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetPerson request)
{
2013-09-17 02:44:06 +00:00
var result = GetItem(request);
2013-04-22 04:38:03 +00:00
return ToOptimizedSerializedResultUsingCache(result);
2013-04-22 04:38:03 +00:00
}
/// <summary>
/// Gets the item.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-09-17 02:44:06 +00:00
private BaseItemDto GetItem(GetPerson request)
2013-04-22 04:38:03 +00:00
{
var item = GetPerson(request.Name, LibraryManager);
2013-04-22 04:38:03 +00:00
2015-01-24 19:03:55 +00:00
var dtoOptions = GetDtoOptions(request);
2013-04-22 04:38:03 +00:00
if (request.UserId.HasValue)
{
var user = UserManager.GetUserById(request.UserId.Value);
2014-12-27 05:08:39 +00:00
return DtoService.GetBaseItemDto(item, dtoOptions, user);
2013-04-22 04:38:03 +00:00
}
2014-12-27 05:08:39 +00:00
return DtoService.GetBaseItemDto(item, dtoOptions);
2013-04-22 04:38:03 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetPersons request)
{
2013-09-27 12:24:28 +00:00
var result = GetResult(request);
2013-02-21 01:33:05 +00:00
return ToOptimizedSerializedResultUsingCache(result);
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{Tuple{System.StringFunc{System.Int32}}}.</returns>
protected override IEnumerable<Person> GetAllItems(GetItemsByName request, IEnumerable<BaseItem> items)
2013-02-21 01:33:05 +00:00
{
2013-04-17 05:36:56 +00:00
var inputPersonTypes = ((GetPersons)request).PersonTypes;
2013-02-21 01:33:05 +00:00
var personTypes = string.IsNullOrEmpty(inputPersonTypes) ? new string[] { } : inputPersonTypes.Split(',');
2013-07-11 20:25:12 +00:00
var itemsList = items.ToList();
2013-02-21 01:33:05 +00:00
// Either get all people, or all people filtered by a specific person type
var allPeople = GetAllPeople(itemsList, personTypes);
return allPeople
.Select(i => i.Name)
.Distinct(StringComparer.OrdinalIgnoreCase)
.Select(name =>
{
try
{
return LibraryManager.GetPerson(name);
}
catch
{
return null;
// Already logged at lower levels
}
}
).Where(i => i != null);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets all people.
/// </summary>
/// <param name="itemsList">The items list.</param>
/// <param name="personTypes">The person types.</param>
/// <returns>IEnumerable{PersonInfo}.</returns>
private IEnumerable<PersonInfo> GetAllPeople(IEnumerable<BaseItem> itemsList, string[] personTypes)
{
var people = itemsList.SelectMany(i => i.People.OrderBy(p => p.SortOrder ?? int.MaxValue).ThenBy(p => p.Type));
2014-10-06 23:58:46 +00:00
if (personTypes.Length > 0)
{
people = people.Where(p =>
personTypes.Contains(p.Type ?? string.Empty, StringComparer.OrdinalIgnoreCase) ||
personTypes.Contains(p.Role ?? string.Empty, StringComparer.OrdinalIgnoreCase));
}
2014-10-06 23:58:46 +00:00
return people;
2013-02-21 01:33:05 +00:00
}
}
}