jellyfin/MediaBrowser.Api/UserService.cs

420 lines
14 KiB
C#
Raw Normal View History

2013-02-21 01:33:05 +00:00
using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller.Dto;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller.Library;
using MediaBrowser.Model.Dto;
2013-02-24 21:53:54 +00:00
using MediaBrowser.Model.Serialization;
2013-07-08 16:13:21 +00:00
using MediaBrowser.Model.Users;
2013-02-21 01:33:05 +00:00
using ServiceStack.ServiceHost;
2013-02-24 21:53:54 +00:00
using ServiceStack.Text.Controller;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace MediaBrowser.Api
{
/// <summary>
/// Class GetUsers
/// </summary>
[Route("/Users", "GET")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Gets a list of users")]
public class GetUsers : IReturn<List<UserDto>>
2013-02-21 01:33:05 +00:00
{
2013-07-08 16:13:21 +00:00
[ApiMember(Name = "IsHidden", Description="Optional filter by IsHidden=true or false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsHidden { get; set; }
[ApiMember(Name = "IsDisabled", Description = "Optional filter by IsDisabled=true or false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsDisabled { get; set; }
2013-02-21 01:33:05 +00:00
}
2013-07-08 17:13:18 +00:00
[Route("/Users/Public", "GET")]
[Api(Description = "Gets a list of publicly visible users for display on a login screen.")]
public class GetPublicUsers : IReturn<List<UserDto>>
{
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class GetUser
/// </summary>
[Route("/Users/{Id}", "GET")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Gets a user by Id")]
public class GetUser : IReturn<UserDto>
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
2013-03-05 05:08:27 +00:00
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
2013-02-21 01:33:05 +00:00
public Guid Id { get; set; }
}
/// <summary>
/// Class DeleteUser
/// </summary>
[Route("/Users/{Id}", "DELETE")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Deletes a user")]
2013-02-21 01:33:05 +00:00
public class DeleteUser : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
2013-03-08 19:14:09 +00:00
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
2013-02-21 01:33:05 +00:00
public Guid Id { get; set; }
}
/// <summary>
/// Class AuthenticateUser
/// </summary>
[Route("/Users/{Id}/Authenticate", "POST")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Authenticates a user")]
2013-07-09 02:38:18 +00:00
public class AuthenticateUser : IReturnVoid
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
2013-03-08 19:14:09 +00:00
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
2013-02-21 01:33:05 +00:00
public Guid Id { get; set; }
/// <summary>
/// Gets or sets the password.
/// </summary>
/// <value>The password.</value>
2013-03-08 19:14:09 +00:00
[ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
2013-02-21 01:33:05 +00:00
public string Password { get; set; }
}
2013-07-08 16:13:21 +00:00
/// <summary>
/// Class AuthenticateUser
/// </summary>
[Route("/Users/AuthenticateByName", "POST")]
2013-07-08 16:13:21 +00:00
[Api(Description = "Authenticates a user")]
public class AuthenticateUserByName : IReturn<AuthenticationResult>
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Username", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
public string Username { get; set; }
2013-07-08 16:13:21 +00:00
/// <summary>
/// Gets or sets the password.
/// </summary>
/// <value>The password.</value>
[ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
public string Password { get; set; }
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class UpdateUserPassword
/// </summary>
[Route("/Users/{Id}/Password", "POST")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Updates a user's password")]
2013-02-21 01:33:05 +00:00
public class UpdateUserPassword : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
public Guid Id { get; set; }
/// <summary>
/// Gets or sets the password.
/// </summary>
/// <value>The password.</value>
public string CurrentPassword { get; set; }
/// <summary>
/// Gets or sets the new password.
/// </summary>
/// <value>The new password.</value>
public string NewPassword { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [reset password].
/// </summary>
/// <value><c>true</c> if [reset password]; otherwise, <c>false</c>.</value>
public bool ResetPassword { get; set; }
}
/// <summary>
/// Class UpdateUser
/// </summary>
[Route("/Users/{Id}", "POST")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Updates a user")]
2013-03-05 02:05:59 +00:00
public class UpdateUser : UserDto, IReturnVoid
2013-02-21 01:33:05 +00:00
{
}
/// <summary>
/// Class CreateUser
/// </summary>
[Route("/Users", "POST")]
2013-04-10 15:32:09 +00:00
[Api(Description = "Creates a user")]
2013-03-05 02:05:59 +00:00
public class CreateUser : UserDto, IReturn<UserDto>
2013-02-21 01:33:05 +00:00
{
}
/// <summary>
/// Class UsersService
/// </summary>
2013-03-16 05:52:33 +00:00
public class UserService : BaseApiService
2013-02-21 01:33:05 +00:00
{
2013-02-24 21:53:54 +00:00
/// <summary>
/// The _XML serializer
/// </summary>
private readonly IXmlSerializer _xmlSerializer;
/// <summary>
/// The _user manager
/// </summary>
private readonly IUserManager _userManager;
private readonly ILibraryManager _libraryManager;
2013-02-24 21:53:54 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="UserService" /> class.
/// </summary>
/// <param name="xmlSerializer">The XML serializer.</param>
/// <param name="userManager">The user manager.</param>
/// <param name="libraryManager">The library manager.</param>
2013-02-24 21:53:54 +00:00
/// <exception cref="System.ArgumentNullException">xmlSerializer</exception>
public UserService(IXmlSerializer xmlSerializer, IUserManager userManager, ILibraryManager libraryManager)
2013-02-24 21:53:54 +00:00
: base()
{
if (xmlSerializer == null)
{
throw new ArgumentNullException("xmlSerializer");
}
_xmlSerializer = xmlSerializer;
_userManager = userManager;
_libraryManager = libraryManager;
2013-02-24 21:53:54 +00:00
}
2013-07-08 17:13:18 +00:00
public object Get(GetPublicUsers request)
{
return Get(new GetUsers
{
2013-07-08 19:31:45 +00:00
IsHidden = false,
IsDisabled = false
2013-07-08 17:13:18 +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(GetUsers request)
{
var dtoBuilder = new UserDtoBuilder(Logger);
2013-07-08 16:13:21 +00:00
var users = _userManager.Users;
if (request.IsDisabled.HasValue)
{
users = users.Where(i => i.Configuration.IsDisabled == request.IsDisabled.Value);
}
if (request.IsHidden.HasValue)
{
users = users.Where(i => i.Configuration.IsHidden == request.IsHidden.Value);
}
2013-07-08 16:13:21 +00:00
var tasks = users.OrderBy(u => u.Name).Select(dtoBuilder.GetUserDto).Select(i => i.Result);
2013-02-21 01:33:05 +00:00
2013-07-08 16:13:21 +00:00
return ToOptimizedResult(tasks.ToList());
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(GetUser request)
{
var user = _userManager.GetUserById(request.Id);
2013-02-21 01:33:05 +00:00
if (user == null)
{
throw new ResourceNotFoundException("User not found");
}
var dtoBuilder = new UserDtoBuilder(Logger);
var result = dtoBuilder.GetUserDto(user).Result;
2013-02-21 01:33:05 +00:00
return ToOptimizedResult(result);
}
/// <summary>
/// Deletes the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Delete(DeleteUser request)
{
var user = _userManager.GetUserById(request.Id);
2013-02-21 01:33:05 +00:00
if (user == null)
{
throw new ResourceNotFoundException("User not found");
}
var task = _userManager.DeleteUser(user);
2013-02-21 01:33:05 +00:00
Task.WaitAll(task);
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
2013-07-09 02:38:18 +00:00
public void Post(AuthenticateUser request)
2013-07-08 16:13:21 +00:00
{
2013-07-09 02:38:18 +00:00
// No response needed. Will throw an exception on failure.
2013-07-08 16:13:21 +00:00
var result = AuthenticateUser(request).Result;
}
public object Post(AuthenticateUserByName request)
{
var user = _userManager.Users.FirstOrDefault(i => string.Equals(request.Username, i.Name, StringComparison.OrdinalIgnoreCase));
2013-07-08 16:13:21 +00:00
if (user == null)
{
throw new ArgumentException(string.Format("User {0} not found.", request.Username));
}
2013-07-09 02:38:18 +00:00
var result = AuthenticateUser(new AuthenticateUser { Id = user.Id, Password = request.Password }).Result;
return ToOptimizedResult(result);
2013-07-08 16:13:21 +00:00
}
2013-07-09 02:38:18 +00:00
private async Task<AuthenticationResult> AuthenticateUser(AuthenticateUser request)
2013-02-21 01:33:05 +00:00
{
var user = _userManager.GetUserById(request.Id);
2013-02-21 01:33:05 +00:00
if (user == null)
{
throw new ResourceNotFoundException("User not found");
}
2013-07-08 16:13:21 +00:00
var success = await _userManager.AuthenticateUser(user, request.Password).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
if (!success)
{
// Unauthorized
2013-03-13 05:19:03 +00:00
throw new UnauthorizedAccessException("Invalid user or password entered.");
2013-02-21 01:33:05 +00:00
}
2013-07-08 16:13:21 +00:00
var result = new AuthenticationResult
{
User = await new UserDtoBuilder(Logger).GetUserDto(user).ConfigureAwait(false)
};
2013-07-09 02:38:18 +00:00
return result;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(UpdateUserPassword request)
{
var user = _userManager.GetUserById(request.Id);
2013-02-21 01:33:05 +00:00
if (user == null)
{
throw new ResourceNotFoundException("User not found");
}
if (request.ResetPassword)
{
2013-03-13 05:19:03 +00:00
var task = _userManager.ResetPassword(user);
2013-02-21 01:33:05 +00:00
Task.WaitAll(task);
}
else
{
var success = _userManager.AuthenticateUser(user, request.CurrentPassword).Result;
2013-02-21 01:33:05 +00:00
if (!success)
{
2013-03-13 05:19:03 +00:00
throw new UnauthorizedAccessException("Invalid user or password entered.");
2013-02-21 01:33:05 +00:00
}
2013-03-13 05:19:03 +00:00
var task = _userManager.ChangePassword(user, request.NewPassword);
2013-02-21 01:33:05 +00:00
Task.WaitAll(task);
}
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(UpdateUser request)
{
// We need to parse this manually because we told service stack not to with IRequiresRequestStream
// https://code.google.com/p/servicestack/source/browse/trunk/Common/ServiceStack.Text/ServiceStack.Text/Controller/PathInfo.cs
var pathInfo = PathInfo.Parse(RequestContext.PathInfo);
2013-02-21 01:33:05 +00:00
var id = new Guid(pathInfo.GetArgumentValue<string>(1));
2013-02-24 21:53:54 +00:00
2013-03-05 02:05:59 +00:00
var dtoUser = request;
2013-02-21 01:33:05 +00:00
var user = _userManager.GetUserById(id);
2013-02-21 01:33:05 +00:00
// If removing admin access
if (!dtoUser.Configuration.IsAdministrator && user.Configuration.IsAdministrator)
{
if (_userManager.Users.Count(i => i.Configuration.IsAdministrator) == 1)
{
throw new ArgumentException("There must be at least one user in the system with administrative access.");
}
}
2013-07-08 19:31:45 +00:00
// If disabling
if (dtoUser.Configuration.IsDisabled && user.Configuration.IsAdministrator)
{
throw new ArgumentException("Administrators cannot be disabled.");
}
// If disabling
2013-07-08 16:13:21 +00:00
if (dtoUser.Configuration.IsDisabled && !user.Configuration.IsDisabled)
{
if (_userManager.Users.Count(i => !i.Configuration.IsDisabled) == 1)
{
throw new ArgumentException("There must be at least one enabled user in the system.");
}
}
var task = user.Name.Equals(dtoUser.Name, StringComparison.Ordinal) ? _userManager.UpdateUser(user) : _userManager.RenameUser(user, dtoUser.Name);
2013-02-21 01:33:05 +00:00
Task.WaitAll(task);
2013-02-24 21:53:54 +00:00
user.UpdateConfiguration(dtoUser.Configuration, _xmlSerializer);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Post(CreateUser request)
{
2013-03-05 02:05:59 +00:00
var dtoUser = request;
2013-02-21 01:33:05 +00:00
var newUser = _userManager.CreateUser(dtoUser.Name).Result;
2013-02-21 01:33:05 +00:00
newUser.UpdateConfiguration(dtoUser.Configuration, _xmlSerializer);
var dtoBuilder = new UserDtoBuilder(Logger);
var result = dtoBuilder.GetUserDto(newUser).Result;
2013-02-21 01:33:05 +00:00
return ToOptimizedResult(result);
}
}
}