jellyfin-server/Emby.Server.Implementations/Library/UserDataManager.cs

275 lines
9.1 KiB
C#
Raw Normal View History

2019-11-01 17:38:54 +00:00
#pragma warning disable CS1591
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Globalization;
using System.Threading;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Dto;
2013-10-02 19:08:58 +00:00
using MediaBrowser.Controller.Entities;
2013-10-02 16:08:58 +00:00
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Model.Dto;
2013-10-02 17:23:10 +00:00
using MediaBrowser.Model.Entities;
using Microsoft.Extensions.Logging;
2013-10-02 16:08:58 +00:00
2016-11-03 07:14:14 +00:00
namespace Emby.Server.Implementations.Library
2013-10-02 16:08:58 +00:00
{
/// <summary>
2019-11-01 17:38:54 +00:00
/// Class UserDataManager.
2013-10-02 16:08:58 +00:00
/// </summary>
public class UserDataManager : IUserDataManager
{
2013-10-02 19:08:58 +00:00
public event EventHandler<UserDataSaveEventArgs> UserDataSaved;
2016-06-04 00:15:14 +00:00
private readonly ConcurrentDictionary<string, UserItemData> _userData =
new ConcurrentDictionary<string, UserItemData>(StringComparer.OrdinalIgnoreCase);
2013-10-02 16:58:30 +00:00
private readonly ILogger _logger;
2014-12-26 17:45:06 +00:00
private readonly IServerConfigurationManager _config;
2013-10-02 16:58:30 +00:00
2018-09-12 17:26:21 +00:00
private Func<IUserManager> _userManager;
public UserDataManager(ILoggerFactory loggerFactory, IServerConfigurationManager config, Func<IUserManager> userManager)
2013-10-02 16:58:30 +00:00
{
2014-12-26 17:45:06 +00:00
_config = config;
_logger = loggerFactory.CreateLogger(GetType().Name);
2018-09-12 17:26:21 +00:00
_userManager = userManager;
2013-10-02 16:58:30 +00:00
}
2013-10-02 16:08:58 +00:00
/// <summary>
/// Gets or sets the repository.
/// </summary>
/// <value>The repository.</value>
public IUserDataRepository Repository { get; set; }
2018-09-12 17:26:21 +00:00
public void SaveUserData(Guid userId, BaseItem item, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken)
{
var user = _userManager().GetUserById(userId);
SaveUserData(user, item, userData, reason, cancellationToken);
}
public void SaveUserData(User user, BaseItem item, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken)
2013-10-02 16:08:58 +00:00
{
2013-10-02 16:58:30 +00:00
if (userData == null)
{
throw new ArgumentNullException(nameof(userData));
2013-10-02 16:58:30 +00:00
}
2013-10-23 16:03:12 +00:00
if (item == null)
2013-10-02 16:58:30 +00:00
{
throw new ArgumentNullException(nameof(item));
2013-10-02 16:58:30 +00:00
}
cancellationToken.ThrowIfCancellationRequested();
2016-04-30 23:05:21 +00:00
var keys = item.GetUserDataKeys();
2013-10-23 16:03:12 +00:00
2018-09-12 17:26:21 +00:00
var userId = user.InternalId;
2016-04-30 23:05:21 +00:00
foreach (var key in keys)
2013-10-02 16:58:30 +00:00
{
Repository.SaveUserData(userId, key, userData, cancellationToken);
2013-10-02 16:58:30 +00:00
}
2013-10-02 19:08:58 +00:00
2016-06-04 00:15:14 +00:00
var cacheKey = GetCacheKey(userId, item.Id);
_userData.AddOrUpdate(cacheKey, userData, (k, v) => userData);
UserDataSaved?.Invoke(this, new UserDataSaveEventArgs
2013-10-02 19:08:58 +00:00
{
2016-04-30 23:05:21 +00:00
Keys = keys,
2013-10-02 19:08:58 +00:00
UserData = userData,
SaveReason = reason,
2018-09-12 17:26:21 +00:00
UserId = user.Id,
2013-10-23 16:03:12 +00:00
Item = item
});
2013-10-02 16:08:58 +00:00
}
2014-09-20 22:14:16 +00:00
/// <summary>
/// Save the provided user data for the given user. Batch operation. Does not fire any events or update the cache.
/// </summary>
/// <param name="userId"></param>
/// <param name="userData"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public void SaveAllUserData(Guid userId, UserItemData[] userData, CancellationToken cancellationToken)
2014-09-20 22:14:16 +00:00
{
2018-09-12 17:26:21 +00:00
var user = _userManager().GetUserById(userId);
2014-09-20 22:14:16 +00:00
2018-09-12 17:26:21 +00:00
Repository.SaveAllUserData(user.InternalId, userData, cancellationToken);
2014-09-20 22:14:16 +00:00
}
/// <summary>
/// Retrieve all user data for the given user
/// </summary>
/// <param name="userId"></param>
/// <returns></returns>
public List<UserItemData> GetAllUserData(Guid userId)
2014-09-20 22:14:16 +00:00
{
2018-09-12 17:26:21 +00:00
var user = _userManager().GetUserById(userId);
2014-09-20 22:14:16 +00:00
2018-09-12 17:26:21 +00:00
return Repository.GetAllUserData(user.InternalId);
2014-09-20 22:14:16 +00:00
}
2016-06-04 00:15:14 +00:00
public UserItemData GetUserData(Guid userId, Guid itemId, List<string> keys)
2016-05-11 14:36:28 +00:00
{
2018-09-12 17:26:21 +00:00
var user = _userManager().GetUserById(userId);
return GetUserData(user, itemId, keys);
}
public UserItemData GetUserData(User user, Guid itemId, List<string> keys)
{
var userId = user.InternalId;
2016-06-04 00:15:14 +00:00
var cacheKey = GetCacheKey(userId, itemId);
return _userData.GetOrAdd(cacheKey, k => GetUserDataInternal(userId, keys));
}
2016-05-11 14:36:28 +00:00
2018-09-12 17:26:21 +00:00
private UserItemData GetUserDataInternal(long internalUserId, List<string> keys)
2016-06-04 00:15:14 +00:00
{
2018-09-12 17:26:21 +00:00
var userData = Repository.GetUserData(internalUserId, keys);
2016-06-04 00:15:14 +00:00
if (userData != null)
2016-05-11 14:36:28 +00:00
{
2016-06-04 00:15:14 +00:00
return userData;
2016-05-24 16:58:36 +00:00
}
2016-05-11 14:36:28 +00:00
2016-05-24 16:58:36 +00:00
if (keys.Count > 0)
{
return new UserItemData
2016-05-11 14:36:28 +00:00
{
2016-05-24 16:58:36 +00:00
Key = keys[0]
};
2016-05-11 14:36:28 +00:00
}
2016-05-24 16:58:36 +00:00
return null;
2016-05-11 14:36:28 +00:00
}
2013-10-02 16:58:30 +00:00
/// <summary>
/// Gets the internal key.
/// </summary>
/// <returns>System.String.</returns>
private static string GetCacheKey(long internalUserId, Guid itemId)
2013-10-02 16:58:30 +00:00
{
return internalUserId.ToString(CultureInfo.InvariantCulture) + "-" + itemId.ToString("N", CultureInfo.InvariantCulture);
2013-10-02 16:08:58 +00:00
}
2018-09-12 17:26:21 +00:00
public UserItemData GetUserData(User user, BaseItem item)
2016-04-30 22:05:13 +00:00
{
2018-09-12 17:26:21 +00:00
return GetUserData(user, item.Id, item.GetUserDataKeys());
2016-04-30 22:05:13 +00:00
}
2018-09-12 17:26:21 +00:00
public UserItemData GetUserData(Guid userId, BaseItem item)
2016-04-30 22:05:13 +00:00
{
2016-06-04 00:15:14 +00:00
return GetUserData(userId, item.Id, item.GetUserDataKeys());
2016-04-30 22:05:13 +00:00
}
2018-09-12 17:26:21 +00:00
public UserItemDataDto GetUserDataDto(BaseItem item, User user)
{
2018-09-12 17:26:21 +00:00
var userData = GetUserData(user, item);
var dto = GetUserItemDataDto(userData);
2018-09-12 17:26:21 +00:00
item.FillUserDataDtoValues(dto, userData, null, user, new DtoOptions());
2016-06-19 06:18:29 +00:00
return dto;
}
2018-09-12 17:26:21 +00:00
public UserItemDataDto GetUserDataDto(BaseItem item, BaseItemDto itemDto, User user, DtoOptions options)
2016-06-19 06:18:29 +00:00
{
2018-09-12 17:26:21 +00:00
var userData = GetUserData(user, item);
2016-06-19 06:18:29 +00:00
var dto = GetUserItemDataDto(userData);
2018-09-12 17:26:21 +00:00
item.FillUserDataDtoValues(dto, userData, itemDto, user, options);
return dto;
}
/// <summary>
/// Converts a UserItemData to a DTOUserItemData
/// </summary>
/// <param name="data">The data.</param>
/// <returns>DtoUserItemData.</returns>
2019-01-13 20:37:13 +00:00
/// <exception cref="ArgumentNullException"></exception>
private UserItemDataDto GetUserItemDataDto(UserItemData data)
{
if (data == null)
{
throw new ArgumentNullException(nameof(data));
}
return new UserItemDataDto
{
IsFavorite = data.IsFavorite,
Likes = data.Likes,
PlaybackPositionTicks = data.PlaybackPositionTicks,
PlayCount = data.PlayCount,
Rating = data.Rating,
Played = data.Played,
LastPlayedDate = data.LastPlayedDate,
Key = data.Key
};
}
2014-12-26 17:45:06 +00:00
2015-02-17 18:42:46 +00:00
public bool UpdatePlayState(BaseItem item, UserItemData data, long? reportedPositionTicks)
2014-12-26 17:45:06 +00:00
{
var playedToCompletion = false;
2018-09-12 17:26:21 +00:00
var runtimeTicks = item.GetRunTimeTicksForPlayState();
var positionTicks = reportedPositionTicks ?? runtimeTicks;
var hasRuntime = runtimeTicks > 0;
2014-12-26 17:45:06 +00:00
// If a position has been reported, and if we know the duration
if (positionTicks > 0 && hasRuntime)
{
var pctIn = decimal.Divide(positionTicks, runtimeTicks) * 100;
2014-12-26 17:45:06 +00:00
if (pctIn < _config.Configuration.MinResumePct)
{
// ignore progress during the beginning
2014-12-26 17:45:06 +00:00
positionTicks = 0;
}
2018-09-12 17:26:21 +00:00
else if (pctIn > _config.Configuration.MaxResumePct || positionTicks >= runtimeTicks)
2014-12-26 17:45:06 +00:00
{
// mark as completed close to the end
2014-12-26 17:45:06 +00:00
positionTicks = 0;
data.Played = playedToCompletion = true;
}
else
{
// Enforce MinResumeDuration
2018-09-12 17:26:21 +00:00
var durationSeconds = TimeSpan.FromTicks(runtimeTicks).TotalSeconds;
2014-12-26 17:45:06 +00:00
if (durationSeconds < _config.Configuration.MinResumeDurationSeconds)
{
positionTicks = 0;
data.Played = playedToCompletion = true;
}
}
}
else if (!hasRuntime)
{
// If we don't know the runtime we'll just have to assume it was fully played
data.Played = playedToCompletion = true;
positionTicks = 0;
}
2016-10-11 06:46:59 +00:00
if (!item.SupportsPlayedStatus)
2014-12-26 17:45:06 +00:00
{
positionTicks = 0;
2016-10-11 06:46:59 +00:00
data.Played = false;
2014-12-26 17:45:06 +00:00
}
2016-12-12 05:49:19 +00:00
if (!item.SupportsPositionTicksResume)
2016-10-11 21:33:38 +00:00
{
positionTicks = 0;
}
2014-12-26 17:45:06 +00:00
data.PlaybackPositionTicks = positionTicks;
return playedToCompletion;
}
2013-10-02 16:08:58 +00:00
}
}