jellyfin-server/MediaBrowser.Api/BaseApiService.cs

420 lines
14 KiB
C#
Raw Normal View History

2015-06-21 03:35:22 +00:00
using MediaBrowser.Controller.Dto;
2015-01-24 19:03:55 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Audio;
2013-03-16 05:52:33 +00:00
using MediaBrowser.Controller.Library;
2013-12-07 15:52:38 +00:00
using MediaBrowser.Controller.Net;
2014-03-25 21:13:55 +00:00
using MediaBrowser.Controller.Session;
2015-01-24 19:03:55 +00:00
using MediaBrowser.Model.Entities;
2013-03-16 05:52:33 +00:00
using MediaBrowser.Model.Logging;
2015-01-22 16:41:34 +00:00
using ServiceStack.Text.Controller;
2014-01-12 21:32:13 +00:00
using ServiceStack.Web;
2013-03-16 05:52:33 +00:00
using System;
using System.Collections.Generic;
2013-05-12 20:30:23 +00:00
using System.Linq;
2015-06-21 03:35:22 +00:00
using System.Threading.Tasks;
2013-03-16 05:52:33 +00:00
namespace MediaBrowser.Api
{
/// <summary>
/// Class BaseApiService
/// </summary>
public class BaseApiService : IHasResultFactory, IRestfulService, IHasSession
2013-03-16 05:52:33 +00:00
{
/// <summary>
/// Gets or sets the logger.
/// </summary>
/// <value>The logger.</value>
public ILogger Logger { get; set; }
2015-01-22 16:41:34 +00:00
/// <summary>
/// Gets or sets the HTTP result factory.
/// </summary>
/// <value>The HTTP result factory.</value>
public IHttpResultFactory ResultFactory { get; set; }
/// <summary>
/// Gets or sets the request context.
/// </summary>
/// <value>The request context.</value>
2013-12-07 15:52:38 +00:00
public IRequest Request { get; set; }
public ISessionContext SessionContext { get; set; }
2015-01-24 19:03:55 +00:00
public IAuthorizationContext AuthorizationContext { get; set; }
2013-12-07 15:52:38 +00:00
public string GetHeader(string name)
{
return Request.Headers[name];
}
/// <summary>
/// To the optimized result.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="result">The result.</param>
/// <returns>System.Object.</returns>
protected object ToOptimizedResult<T>(T result)
where T : class
{
2013-12-07 15:52:38 +00:00
return ResultFactory.GetOptimizedResult(Request, result);
}
/// <summary>
/// To the optimized result using cache.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="cacheKey">The cache key.</param>
/// <param name="lastDateModified">The last date modified.</param>
/// <param name="cacheDuration">Duration of the cache.</param>
/// <param name="factoryFn">The factory function.</param>
/// <returns>System.Object.</returns>
protected object ToOptimizedResultUsingCache<T>(Guid cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration, Func<T> factoryFn)
where T : class
{
2013-12-07 15:52:38 +00:00
return ResultFactory.GetOptimizedResultUsingCache(Request, cacheKey, lastDateModified, cacheDuration, factoryFn);
}
2015-03-17 03:48:05 +00:00
protected void AssertCanUpdateUser(IUserManager userManager, string userId)
2015-03-16 01:48:25 +00:00
{
var auth = AuthorizationContext.GetAuthorizationInfo(Request);
2015-03-17 03:48:05 +00:00
var authenticatedUser = userManager.GetUserById(auth.UserId);
2015-03-16 01:48:25 +00:00
// If they're going to update the record of another user, they must be an administrator
if (!string.Equals(userId, auth.UserId, StringComparison.OrdinalIgnoreCase))
{
if (!authenticatedUser.Policy.IsAdministrator)
{
throw new SecurityException("Unauthorized access.");
}
}
else
{
if (!authenticatedUser.Policy.EnableUserPreferenceAccess)
{
throw new SecurityException("Unauthorized access.");
}
}
}
/// <summary>
/// To the optimized serialized result using cache.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="result">The result.</param>
/// <returns>System.Object.</returns>
protected object ToOptimizedSerializedResultUsingCache<T>(T result)
where T : class
{
2014-02-09 21:11:11 +00:00
return ToOptimizedResult(result);
}
2014-02-13 01:52:24 +00:00
2014-03-25 21:13:55 +00:00
/// <summary>
/// Gets the session.
/// </summary>
/// <returns>SessionInfo.</returns>
2015-03-09 19:40:03 +00:00
protected async Task<SessionInfo> GetSession()
2014-03-25 21:13:55 +00:00
{
2015-03-09 19:40:03 +00:00
var session = await SessionContext.GetSession(Request).ConfigureAwait(false);
2014-06-25 15:12:39 +00:00
if (session == null)
{
throw new ArgumentException("Session not found.");
}
return session;
2014-03-25 21:13:55 +00:00
}
2013-05-02 14:30:38 +00:00
/// <summary>
/// To the static file result.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>System.Object.</returns>
protected object ToStaticFileResult(string path)
{
2013-12-07 15:52:38 +00:00
return ResultFactory.GetStaticFileResult(Request, path);
2013-05-02 14:30:38 +00:00
}
2014-10-25 18:32:58 +00:00
private readonly char[] _dashReplaceChars = { '?', '/', '&' };
private const char SlugChar = '-';
2015-01-24 19:03:55 +00:00
protected DtoOptions GetDtoOptions(object request)
{
var options = new DtoOptions();
options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
var hasFields = request as IHasItemFields;
if (hasFields != null)
{
options.Fields = hasFields.GetItemFields().ToList();
}
var hasDtoOptions = request as IHasDtoOptions;
if (hasDtoOptions != null)
{
options.EnableImages = hasDtoOptions.EnableImages ?? true;
if (hasDtoOptions.ImageTypeLimit.HasValue)
{
options.ImageTypeLimit = hasDtoOptions.ImageTypeLimit.Value;
}
if (!string.IsNullOrWhiteSpace(hasDtoOptions.EnableImageTypes))
{
options.ImageTypes = (hasDtoOptions.EnableImageTypes ?? string.Empty).Split(',').Where(i => !string.IsNullOrWhiteSpace(i)).Select(v => (ImageType)Enum.Parse(typeof(ImageType), v, true)).ToList();
}
}
return options;
}
2013-11-21 20:48:26 +00:00
protected MusicArtist GetArtist(string name, ILibraryManager libraryManager)
{
return libraryManager.GetArtist(DeSlugArtistName(name, libraryManager));
}
protected Studio GetStudio(string name, ILibraryManager libraryManager)
{
return libraryManager.GetStudio(DeSlugStudioName(name, libraryManager));
}
protected Genre GetGenre(string name, ILibraryManager libraryManager)
{
return libraryManager.GetGenre(DeSlugGenreName(name, libraryManager));
}
protected MusicGenre GetMusicGenre(string name, ILibraryManager libraryManager)
2013-06-11 03:31:00 +00:00
{
return libraryManager.GetMusicGenre(DeSlugGenreName(name, libraryManager));
}
protected GameGenre GetGameGenre(string name, ILibraryManager libraryManager)
2013-07-01 17:17:33 +00:00
{
2013-07-01 18:17:55 +00:00
return libraryManager.GetGameGenre(DeSlugGameGenreName(name, libraryManager));
2013-07-01 17:17:33 +00:00
}
protected Person GetPerson(string name, ILibraryManager libraryManager)
{
return libraryManager.GetPerson(DeSlugPersonName(name, libraryManager));
}
2015-05-29 23:51:33 +00:00
protected IList<BaseItem> GetAllLibraryItems(string userId, IUserManager userManager, ILibraryManager libraryManager, string parentId, Func<BaseItem,bool> filter)
2013-09-21 21:00:04 +00:00
{
2014-05-02 02:54:33 +00:00
if (!string.IsNullOrEmpty(parentId))
{
2015-01-22 16:41:34 +00:00
var folder = (Folder)libraryManager.GetItemById(new Guid(parentId));
2014-05-02 02:54:33 +00:00
2015-05-29 23:51:33 +00:00
if (!string.IsNullOrWhiteSpace(userId))
2014-06-14 23:13:09 +00:00
{
2015-05-29 23:51:33 +00:00
var user = userManager.GetUserById(userId);
2014-06-14 23:13:09 +00:00
2014-07-15 01:25:58 +00:00
if (user == null)
{
throw new ArgumentException("User not found");
}
2015-01-25 06:34:50 +00:00
return folder
.GetRecursiveChildren(user, filter)
.ToList();
2014-06-14 23:13:09 +00:00
}
2015-01-25 06:34:50 +00:00
return folder
.GetRecursiveChildren(filter);
2014-05-02 02:54:33 +00:00
}
2015-05-29 23:51:33 +00:00
if (!string.IsNullOrWhiteSpace(userId))
2013-09-21 21:00:04 +00:00
{
2015-05-29 23:51:33 +00:00
var user = userManager.GetUserById(userId);
2013-09-21 21:00:04 +00:00
2014-07-15 01:25:58 +00:00
if (user == null)
{
throw new ArgumentException("User not found");
}
2015-01-25 06:34:50 +00:00
return userManager
2015-05-29 23:51:33 +00:00
.GetUserById(userId)
2015-01-25 06:34:50 +00:00
.RootFolder
.GetRecursiveChildren(user, filter)
.ToList();
2013-09-21 21:00:04 +00:00
}
2015-01-25 06:34:50 +00:00
return libraryManager
.RootFolder
.GetRecursiveChildren(filter);
2013-09-21 21:00:04 +00:00
}
/// <summary>
/// Deslugs an artist name by finding the correct entry in the library
/// </summary>
/// <param name="name"></param>
/// <param name="libraryManager"></param>
/// <returns></returns>
protected string DeSlugArtistName(string name, ILibraryManager libraryManager)
{
if (name.IndexOf(SlugChar) == -1)
{
return name;
}
2015-01-25 06:34:50 +00:00
return libraryManager.RootFolder
.GetRecursiveChildren(i => i is IHasArtist)
.Cast<IHasArtist>()
.SelectMany(i => i.AllArtists)
2015-04-09 21:11:57 +00:00
.DistinctNames()
.FirstOrDefault(i =>
{
i = _dashReplaceChars.Aggregate(i, (current, c) => current.Replace(c, SlugChar));
return string.Equals(i, name, StringComparison.OrdinalIgnoreCase);
}) ?? name;
}
/// <summary>
/// Deslugs a genre name by finding the correct entry in the library
/// </summary>
protected string DeSlugGenreName(string name, ILibraryManager libraryManager)
{
if (name.IndexOf(SlugChar) == -1)
{
return name;
}
2013-09-27 12:24:28 +00:00
return libraryManager.RootFolder.GetRecursiveChildren()
.SelectMany(i => i.Genres)
2015-04-09 21:11:57 +00:00
.DistinctNames()
.FirstOrDefault(i =>
{
i = _dashReplaceChars.Aggregate(i, (current, c) => current.Replace(c, SlugChar));
return string.Equals(i, name, StringComparison.OrdinalIgnoreCase);
}) ?? name;
}
2013-07-01 18:17:55 +00:00
protected string DeSlugGameGenreName(string name, ILibraryManager libraryManager)
{
if (name.IndexOf(SlugChar) == -1)
{
return name;
}
2015-01-25 06:34:50 +00:00
return libraryManager.RootFolder
.GetRecursiveChildren(i => i is Game)
2013-07-01 18:17:55 +00:00
.SelectMany(i => i.Genres)
2015-04-09 21:11:57 +00:00
.DistinctNames()
2013-07-01 18:17:55 +00:00
.FirstOrDefault(i =>
{
i = _dashReplaceChars.Aggregate(i, (current, c) => current.Replace(c, SlugChar));
return string.Equals(i, name, StringComparison.OrdinalIgnoreCase);
}) ?? name;
}
/// <summary>
/// Deslugs a studio name by finding the correct entry in the library
/// </summary>
protected string DeSlugStudioName(string name, ILibraryManager libraryManager)
{
if (name.IndexOf(SlugChar) == -1)
{
return name;
}
2015-01-25 06:34:50 +00:00
return libraryManager.RootFolder
.GetRecursiveChildren()
.SelectMany(i => i.Studios)
2015-04-09 21:11:57 +00:00
.DistinctNames()
.FirstOrDefault(i =>
{
i = _dashReplaceChars.Aggregate(i, (current, c) => current.Replace(c, SlugChar));
return string.Equals(i, name, StringComparison.OrdinalIgnoreCase);
}) ?? name;
}
/// <summary>
/// Deslugs a person name by finding the correct entry in the library
/// </summary>
protected string DeSlugPersonName(string name, ILibraryManager libraryManager)
{
if (name.IndexOf(SlugChar) == -1)
{
return name;
}
2015-07-08 16:10:34 +00:00
return libraryManager.GetPeopleNames(new InternalPeopleQuery())
.FirstOrDefault(i =>
{
i = _dashReplaceChars.Aggregate(i, (current, c) => current.Replace(c, SlugChar));
return string.Equals(i, name, StringComparison.OrdinalIgnoreCase);
}) ?? name;
}
2013-08-03 14:38:56 +00:00
2015-01-22 16:41:34 +00:00
protected string GetPathValue(int index)
{
var pathInfo = PathInfo.Parse(Request.PathInfo);
var first = pathInfo.GetArgumentValue<string>(0);
// backwards compatibility
2015-06-25 21:50:56 +00:00
if (string.Equals(first, "mediabrowser", StringComparison.OrdinalIgnoreCase) ||
string.Equals(first, "emby", StringComparison.OrdinalIgnoreCase))
2015-01-22 16:41:34 +00:00
{
index++;
}
return pathInfo.GetArgumentValue<string>(index);
}
2013-08-03 14:38:56 +00:00
/// <summary>
/// Gets the name of the item by.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="type">The type.</param>
/// <param name="libraryManager">The library manager.</param>
/// <returns>Task{BaseItem}.</returns>
protected BaseItem GetItemByName(string name, string type, ILibraryManager libraryManager)
2013-08-03 14:38:56 +00:00
{
BaseItem item;
if (type.IndexOf("Person", StringComparison.OrdinalIgnoreCase) == 0)
{
item = GetPerson(name, libraryManager);
2013-08-03 14:38:56 +00:00
}
else if (type.IndexOf("Artist", StringComparison.OrdinalIgnoreCase) == 0)
{
item = GetArtist(name, libraryManager);
2013-08-03 14:38:56 +00:00
}
else if (type.IndexOf("Genre", StringComparison.OrdinalIgnoreCase) == 0)
{
item = GetGenre(name, libraryManager);
2013-08-03 14:38:56 +00:00
}
else if (type.IndexOf("MusicGenre", StringComparison.OrdinalIgnoreCase) == 0)
{
item = GetMusicGenre(name, libraryManager);
2013-08-03 14:38:56 +00:00
}
else if (type.IndexOf("GameGenre", StringComparison.OrdinalIgnoreCase) == 0)
{
item = GetGameGenre(name, libraryManager);
2013-08-03 14:38:56 +00:00
}
else if (type.IndexOf("Studio", StringComparison.OrdinalIgnoreCase) == 0)
{
item = GetStudio(name, libraryManager);
2013-08-03 14:38:56 +00:00
}
else if (type.IndexOf("Year", StringComparison.OrdinalIgnoreCase) == 0)
{
item = libraryManager.GetYear(int.Parse(name));
2013-08-03 14:38:56 +00:00
}
else
{
throw new ArgumentException();
}
return item;
}
2013-03-16 05:52:33 +00:00
}
}