2013-03-04 06:43:06 +01:00
|
|
|
|
using MediaBrowser.Common.Configuration;
|
2013-02-27 21:25:45 +01:00
|
|
|
|
using MediaBrowser.Controller.Library;
|
2014-01-28 19:37:01 +01:00
|
|
|
|
using MediaBrowser.Controller.Providers;
|
2013-02-21 02:33:05 +01:00
|
|
|
|
using MediaBrowser.Model.Configuration;
|
2013-03-13 06:19:03 +01:00
|
|
|
|
using MediaBrowser.Model.Serialization;
|
2013-02-21 02:33:05 +01:00
|
|
|
|
using System;
|
|
|
|
|
using System.IO;
|
|
|
|
|
using System.Runtime.Serialization;
|
|
|
|
|
using System.Threading;
|
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Entities
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Class User
|
|
|
|
|
/// </summary>
|
|
|
|
|
public class User : BaseItem
|
|
|
|
|
{
|
2013-03-08 06:08:27 +01:00
|
|
|
|
public static IUserManager UserManager { get; set; }
|
|
|
|
|
public static IXmlSerializer XmlSerializer { get; set; }
|
2013-02-27 21:25:45 +01:00
|
|
|
|
|
2013-02-21 02:33:05 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the root folder path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The root folder path.</value>
|
|
|
|
|
[IgnoreDataMember]
|
|
|
|
|
public string RootFolderPath
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
2013-06-04 18:48:23 +02:00
|
|
|
|
var path = Configuration.UseCustomLibrary ? GetRootFolderPath(Name) : ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
|
2013-06-04 04:02:49 +02:00
|
|
|
|
|
2013-10-01 20:24:27 +02:00
|
|
|
|
Directory.CreateDirectory(path);
|
2013-06-04 04:02:49 +02:00
|
|
|
|
|
2013-06-04 18:48:23 +02:00
|
|
|
|
return path;
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the root folder path based on a given username
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="username">The username.</param>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
private string GetRootFolderPath(string username)
|
|
|
|
|
{
|
|
|
|
|
var safeFolderName = FileSystem.GetValidFilename(username);
|
|
|
|
|
|
2013-03-04 06:43:06 +01:00
|
|
|
|
return System.IO.Path.Combine(ConfigurationManager.ApplicationPaths.RootFolderPath, safeFolderName);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the password.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The password.</value>
|
|
|
|
|
public string Password { get; set; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The path.</value>
|
2013-12-29 15:12:29 +01:00
|
|
|
|
[IgnoreDataMember]
|
2013-02-21 02:33:05 +01:00
|
|
|
|
public override string Path
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
// Return this so that metadata providers will look in here
|
|
|
|
|
return ConfigurationDirectoryPath;
|
|
|
|
|
}
|
|
|
|
|
set
|
|
|
|
|
{
|
|
|
|
|
base.Path = value;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2014-02-07 23:40:03 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Returns the folder containing the item.
|
|
|
|
|
/// If the item is a folder, it returns the folder itself
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The containing folder path.</value>
|
|
|
|
|
public override string ContainingFolderPath
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return Path;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets a value indicating whether this instance is owned item.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value><c>true</c> if this instance is owned item; otherwise, <c>false</c>.</value>
|
|
|
|
|
public override bool IsOwnedItem
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2013-02-21 02:33:05 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// The _root folder
|
|
|
|
|
/// </summary>
|
|
|
|
|
private UserRootFolder _rootFolder;
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the root folder.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The root folder.</value>
|
|
|
|
|
[IgnoreDataMember]
|
|
|
|
|
public UserRootFolder RootFolder
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
2013-12-29 18:07:29 +01:00
|
|
|
|
return _rootFolder ?? (LibraryManager.GetUserRootFolder(RootFolderPath));
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
private set
|
|
|
|
|
{
|
|
|
|
|
_rootFolder = value;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the last login date.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The last login date.</value>
|
|
|
|
|
public DateTime? LastLoginDate { get; set; }
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the last activity date.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The last activity date.</value>
|
|
|
|
|
public DateTime? LastActivityDate { get; set; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The _configuration
|
|
|
|
|
/// </summary>
|
|
|
|
|
private UserConfiguration _configuration;
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The _configuration initialized
|
|
|
|
|
/// </summary>
|
|
|
|
|
private bool _configurationInitialized;
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The _configuration sync lock
|
|
|
|
|
/// </summary>
|
|
|
|
|
private object _configurationSyncLock = new object();
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the user's configuration
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The configuration.</value>
|
|
|
|
|
[IgnoreDataMember]
|
|
|
|
|
public UserConfiguration Configuration
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
// Lazy load
|
2013-03-04 06:43:06 +01:00
|
|
|
|
LazyInitializer.EnsureInitialized(ref _configuration, ref _configurationInitialized, ref _configurationSyncLock, () => (UserConfiguration)ConfigurationHelper.GetXmlConfiguration(typeof(UserConfiguration), ConfigurationFilePath, XmlSerializer));
|
2013-02-21 02:33:05 +01:00
|
|
|
|
return _configuration;
|
|
|
|
|
}
|
|
|
|
|
private set
|
|
|
|
|
{
|
|
|
|
|
_configuration = value;
|
|
|
|
|
|
|
|
|
|
if (value == null)
|
|
|
|
|
{
|
|
|
|
|
_configurationInitialized = false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Reloads the root media folder
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
|
|
|
/// <param name="progress">The progress.</param>
|
|
|
|
|
/// <returns>Task.</returns>
|
2013-02-22 05:23:06 +01:00
|
|
|
|
public async Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
|
2013-02-21 02:33:05 +01:00
|
|
|
|
{
|
2013-02-21 21:26:35 +01:00
|
|
|
|
Logger.Info("Validating media library for {0}", Name);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
|
|
|
|
|
|
|
|
|
|
cancellationToken.ThrowIfCancellationRequested();
|
|
|
|
|
|
|
|
|
|
await RootFolder.ValidateChildren(progress, cancellationToken).ConfigureAwait(false);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Renames the user.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="newName">The new name.</param>
|
|
|
|
|
/// <returns>Task.</returns>
|
|
|
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
2013-02-27 21:25:45 +01:00
|
|
|
|
public Task Rename(string newName)
|
2013-02-21 02:33:05 +01:00
|
|
|
|
{
|
|
|
|
|
if (string.IsNullOrEmpty(newName))
|
|
|
|
|
{
|
|
|
|
|
throw new ArgumentNullException();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// If only the casing is changing, leave the file system alone
|
|
|
|
|
if (!newName.Equals(Name, StringComparison.OrdinalIgnoreCase))
|
|
|
|
|
{
|
|
|
|
|
// Move configuration
|
|
|
|
|
var newConfigDirectory = GetConfigurationDirectoryPath(newName);
|
2013-12-29 18:07:29 +01:00
|
|
|
|
var oldConfigurationDirectory = ConfigurationDirectoryPath;
|
2013-02-21 02:33:05 +01:00
|
|
|
|
|
|
|
|
|
// Exceptions will be thrown if these paths already exist
|
|
|
|
|
if (Directory.Exists(newConfigDirectory))
|
|
|
|
|
{
|
|
|
|
|
Directory.Delete(newConfigDirectory, true);
|
|
|
|
|
}
|
2013-12-29 18:07:29 +01:00
|
|
|
|
|
|
|
|
|
if (Directory.Exists(oldConfigurationDirectory))
|
|
|
|
|
{
|
|
|
|
|
Directory.Move(oldConfigurationDirectory, newConfigDirectory);
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
Directory.CreateDirectory(newConfigDirectory);
|
|
|
|
|
}
|
2013-02-21 02:33:05 +01:00
|
|
|
|
|
|
|
|
|
var customLibraryPath = GetRootFolderPath(Name);
|
|
|
|
|
|
|
|
|
|
// Move the root folder path if using a custom library
|
|
|
|
|
if (Directory.Exists(customLibraryPath))
|
|
|
|
|
{
|
|
|
|
|
var newRootFolderPath = GetRootFolderPath(newName);
|
|
|
|
|
if (Directory.Exists(newRootFolderPath))
|
|
|
|
|
{
|
|
|
|
|
Directory.Delete(newRootFolderPath, true);
|
|
|
|
|
}
|
|
|
|
|
Directory.Move(customLibraryPath, newRootFolderPath);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Name = newName;
|
|
|
|
|
|
|
|
|
|
// Force these to be lazy loaded again
|
|
|
|
|
RootFolder = null;
|
|
|
|
|
|
|
|
|
|
// Kick off a task to validate the media library
|
2013-04-10 17:56:36 +02:00
|
|
|
|
Task.Run(() => ValidateMediaLibrary(new Progress<double>(), CancellationToken.None));
|
2013-02-21 02:33:05 +01:00
|
|
|
|
|
2014-01-28 19:37:01 +01:00
|
|
|
|
return RefreshMetadata(new MetadataRefreshOptions
|
|
|
|
|
{
|
2014-02-06 23:22:03 +01:00
|
|
|
|
ReplaceAllMetadata = true,
|
|
|
|
|
ImageRefreshMode = ImageRefreshMode.FullRefresh,
|
|
|
|
|
MetadataRefreshMode = MetadataRefreshMode.FullRefresh
|
2014-01-28 19:37:01 +01:00
|
|
|
|
|
|
|
|
|
}, CancellationToken.None);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
|
2014-02-07 23:40:03 +01:00
|
|
|
|
public override Task UpdateToRepository(ItemUpdateType updateReason, CancellationToken cancellationToken)
|
|
|
|
|
{
|
|
|
|
|
return UserManager.UpdateUser(this);
|
|
|
|
|
}
|
|
|
|
|
|
2013-02-21 02:33:05 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the path to the user's configuration directory
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The configuration directory path.</value>
|
2013-12-29 18:07:29 +01:00
|
|
|
|
[IgnoreDataMember]
|
2013-02-21 02:33:05 +01:00
|
|
|
|
private string ConfigurationDirectoryPath
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
2013-12-29 18:07:29 +01:00
|
|
|
|
return GetConfigurationDirectoryPath(Name);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the configuration directory path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="username">The username.</param>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
private string GetConfigurationDirectoryPath(string username)
|
|
|
|
|
{
|
2013-12-29 15:12:29 +01:00
|
|
|
|
if (string.IsNullOrEmpty(username))
|
|
|
|
|
{
|
|
|
|
|
throw new ArgumentNullException("username");
|
|
|
|
|
}
|
|
|
|
|
|
2013-02-21 02:33:05 +01:00
|
|
|
|
var safeFolderName = FileSystem.GetValidFilename(username);
|
|
|
|
|
|
2013-03-04 06:43:06 +01:00
|
|
|
|
return System.IO.Path.Combine(ConfigurationManager.ApplicationPaths.UserConfigurationDirectoryPath, safeFolderName);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the path to the user's configuration file
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The configuration file path.</value>
|
2013-12-29 18:07:29 +01:00
|
|
|
|
[IgnoreDataMember]
|
2013-04-22 17:46:23 +02:00
|
|
|
|
public string ConfigurationFilePath
|
2013-02-21 02:33:05 +01:00
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return System.IO.Path.Combine(ConfigurationDirectoryPath, "config.xml");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Saves the current configuration to the file system
|
|
|
|
|
/// </summary>
|
2013-02-24 22:53:54 +01:00
|
|
|
|
public void SaveConfiguration(IXmlSerializer serializer)
|
2013-02-21 02:33:05 +01:00
|
|
|
|
{
|
2013-12-29 18:07:29 +01:00
|
|
|
|
var xmlPath = ConfigurationFilePath;
|
|
|
|
|
Directory.CreateDirectory(System.IO.Path.GetDirectoryName(xmlPath));
|
|
|
|
|
serializer.SerializeToFile(Configuration, xmlPath);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Updates the configuration.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="config">The config.</param>
|
2013-02-24 22:53:54 +01:00
|
|
|
|
/// <param name="serializer">The serializer.</param>
|
2013-02-21 02:33:05 +01:00
|
|
|
|
/// <exception cref="System.ArgumentNullException">config</exception>
|
2013-02-24 22:53:54 +01:00
|
|
|
|
public void UpdateConfiguration(UserConfiguration config, IXmlSerializer serializer)
|
2013-02-21 02:33:05 +01:00
|
|
|
|
{
|
|
|
|
|
if (config == null)
|
|
|
|
|
{
|
|
|
|
|
throw new ArgumentNullException("config");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var customLibraryChanged = config.UseCustomLibrary != Configuration.UseCustomLibrary;
|
|
|
|
|
|
|
|
|
|
Configuration = config;
|
2013-02-24 22:53:54 +01:00
|
|
|
|
SaveConfiguration(serializer);
|
2013-02-21 02:33:05 +01:00
|
|
|
|
|
|
|
|
|
// Force these to be lazy loaded again
|
|
|
|
|
if (customLibraryChanged)
|
|
|
|
|
{
|
|
|
|
|
RootFolder = null;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|