jellyfin/MediaBrowser.Api/Library/LibraryStructureService.cs

375 lines
12 KiB
C#
Raw Normal View History

2016-03-27 21:11:27 +00:00
using MediaBrowser.Controller;
using MediaBrowser.Controller.Library;
2014-07-02 18:34:08 +00:00
using MediaBrowser.Controller.Net;
2013-02-25 03:56:00 +00:00
using MediaBrowser.Model.Entities;
2013-12-07 15:52:38 +00:00
using ServiceStack;
2013-02-25 03:56:00 +00:00
using System;
using System.Collections.Generic;
using System.IO;
2013-02-25 03:56:00 +00:00
using System.Linq;
2013-08-13 14:41:45 +00:00
using System.Threading;
using System.Threading.Tasks;
2015-10-04 04:23:11 +00:00
using CommonIO;
using MediaBrowser.Controller.Configuration;
2016-08-14 03:12:26 +00:00
using MediaBrowser.Controller.Entities;
2016-08-13 20:54:29 +00:00
using MediaBrowser.Model.Configuration;
2013-02-25 03:56:00 +00:00
namespace MediaBrowser.Api.Library
{
/// <summary>
/// Class GetDefaultVirtualFolders
/// </summary>
[Route("/Library/VirtualFolders", "GET")]
public class GetVirtualFolders : IReturn<List<VirtualFolderInfo>>
{
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
public string UserId { get; set; }
}
[Route("/Library/VirtualFolders", "POST")]
2013-02-25 03:56:00 +00:00
public class AddVirtualFolder : IReturnVoid
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
2013-07-12 19:56:40 +00:00
/// <summary>
/// Gets or sets the type of the collection.
/// </summary>
/// <value>The type of the collection.</value>
public string CollectionType { get; set; }
2013-09-05 17:05:39 +00:00
/// <summary>
/// Gets or sets a value indicating whether [refresh library].
/// </summary>
/// <value><c>true</c> if [refresh library]; otherwise, <c>false</c>.</value>
public bool RefreshLibrary { get; set; }
2015-10-16 02:06:44 +00:00
/// <summary>
/// Gets or sets the path.
/// </summary>
/// <value>The path.</value>
2015-10-26 05:29:32 +00:00
public string[] Paths { get; set; }
public LibraryOptions LibraryOptions { get; set; }
2013-02-25 03:56:00 +00:00
}
[Route("/Library/VirtualFolders", "DELETE")]
2013-02-25 03:56:00 +00:00
public class RemoveVirtualFolder : IReturnVoid
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
2013-09-05 17:05:39 +00:00
/// <summary>
/// Gets or sets a value indicating whether [refresh library].
/// </summary>
/// <value><c>true</c> if [refresh library]; otherwise, <c>false</c>.</value>
public bool RefreshLibrary { get; set; }
2013-02-25 03:56:00 +00:00
}
[Route("/Library/VirtualFolders/Name", "POST")]
2013-02-25 03:56:00 +00:00
public class RenameVirtualFolder : IReturnVoid
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string NewName { get; set; }
2013-09-05 17:05:39 +00:00
/// <summary>
/// Gets or sets a value indicating whether [refresh library].
/// </summary>
/// <value><c>true</c> if [refresh library]; otherwise, <c>false</c>.</value>
public bool RefreshLibrary { get; set; }
2013-02-25 03:56:00 +00:00
}
[Route("/Library/VirtualFolders/Paths", "POST")]
2013-02-25 03:56:00 +00:00
public class AddMediaPath : IReturnVoid
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Path { get; set; }
2013-09-05 17:05:39 +00:00
/// <summary>
/// Gets or sets a value indicating whether [refresh library].
/// </summary>
/// <value><c>true</c> if [refresh library]; otherwise, <c>false</c>.</value>
public bool RefreshLibrary { get; set; }
2013-02-25 03:56:00 +00:00
}
[Route("/Library/VirtualFolders/Paths", "DELETE")]
2013-02-25 03:56:00 +00:00
public class RemoveMediaPath : IReturnVoid
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Path { get; set; }
2013-09-05 17:05:39 +00:00
/// <summary>
/// Gets or sets a value indicating whether [refresh library].
/// </summary>
/// <value><c>true</c> if [refresh library]; otherwise, <c>false</c>.</value>
public bool RefreshLibrary { get; set; }
2013-02-25 03:56:00 +00:00
}
2014-11-15 02:31:03 +00:00
2016-08-14 03:12:26 +00:00
[Route("/Library/VirtualFolders/LibraryOptions", "POST")]
public class UpdateLibraryOptions : IReturnVoid
{
public string Id { get; set; }
public LibraryOptions LibraryOptions { get; set; }
}
2013-02-25 03:56:00 +00:00
/// <summary>
/// Class LibraryStructureService
/// </summary>
2014-11-15 02:31:03 +00:00
[Authenticated(Roles = "Admin", AllowBeforeStartupWizard = true)]
2013-03-16 05:52:33 +00:00
public class LibraryStructureService : BaseApiService
2013-02-25 03:56:00 +00:00
{
/// <summary>
/// The _app paths
/// </summary>
private readonly IServerApplicationPaths _appPaths;
/// <summary>
/// The _library manager
/// </summary>
private readonly ILibraryManager _libraryManager;
2013-04-10 15:32:09 +00:00
private readonly ILibraryMonitor _libraryMonitor;
private readonly IFileSystem _fileSystem;
2013-02-25 03:56:00 +00:00
/// <summary>
2015-01-21 03:54:45 +00:00
/// Initializes a new instance of the <see cref="LibraryStructureService" /> class.
2013-02-25 03:56:00 +00:00
/// </summary>
2015-01-21 03:54:45 +00:00
public LibraryStructureService(IServerApplicationPaths appPaths, ILibraryManager libraryManager, ILibraryMonitor libraryMonitor, IFileSystem fileSystem)
2013-02-25 03:56:00 +00:00
{
if (appPaths == null)
{
throw new ArgumentNullException("appPaths");
}
_appPaths = appPaths;
_libraryManager = libraryManager;
_libraryMonitor = libraryMonitor;
_fileSystem = fileSystem;
2013-02-25 03:56:00 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetVirtualFolders request)
{
2015-01-21 03:54:45 +00:00
var result = _libraryManager.GetVirtualFolders().OrderBy(i => i.Name).ToList();
2013-02-25 03:56:00 +00:00
2015-01-21 03:54:45 +00:00
return ToOptimizedSerializedResultUsingCache(result);
2013-02-25 03:56:00 +00:00
}
2016-08-14 03:12:26 +00:00
public void Post(UpdateLibraryOptions request)
{
var collectionFolder = (CollectionFolder)_libraryManager.GetItemById(request.Id);
collectionFolder.UpdateLibraryOptions(request.LibraryOptions);
}
2013-02-25 03:56:00 +00:00
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(AddVirtualFolder request)
2013-02-25 03:56:00 +00:00
{
var libraryOptions = request.LibraryOptions ?? new LibraryOptions();
_libraryManager.AddVirtualFolder(request.Name, request.CollectionType, request.Paths, libraryOptions, request.RefreshLibrary);
2013-02-25 03:56:00 +00:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(RenameVirtualFolder request)
2013-02-25 03:56:00 +00:00
{
if (string.IsNullOrWhiteSpace(request.Name))
{
throw new ArgumentNullException("request");
}
if (string.IsNullOrWhiteSpace(request.NewName))
{
throw new ArgumentNullException("request");
}
2014-02-21 05:04:11 +00:00
var rootFolderPath = _appPaths.DefaultUserViewsPath;
var currentPath = Path.Combine(rootFolderPath, request.Name);
var newPath = Path.Combine(rootFolderPath, request.NewName);
2016-08-14 03:12:26 +00:00
if (!_fileSystem.DirectoryExists(currentPath))
{
throw new DirectoryNotFoundException("The media collection does not exist");
}
2016-08-14 03:12:26 +00:00
if (!string.Equals(currentPath, newPath, StringComparison.OrdinalIgnoreCase) && _fileSystem.DirectoryExists(newPath))
{
throw new ArgumentException("There is already a media collection with the name " + newPath + ".");
}
_libraryMonitor.Stop();
2013-08-13 14:41:45 +00:00
try
2013-02-25 03:56:00 +00:00
{
// Only make a two-phase move when changing capitalization
if (string.Equals(currentPath, newPath, StringComparison.OrdinalIgnoreCase))
2013-08-13 14:41:45 +00:00
{
//Create an unique name
var temporaryName = Guid.NewGuid().ToString();
var temporaryPath = Path.Combine(rootFolderPath, temporaryName);
2016-08-14 03:12:26 +00:00
_fileSystem.MoveDirectory(currentPath, temporaryPath);
currentPath = temporaryPath;
2013-08-13 14:41:45 +00:00
}
2016-08-14 03:12:26 +00:00
_fileSystem.MoveDirectory(currentPath, newPath);
2013-02-25 03:56:00 +00:00
}
2013-08-13 14:41:45 +00:00
finally
2013-02-25 03:56:00 +00:00
{
2015-03-19 03:47:21 +00:00
Task.Run(() =>
{
2015-03-19 03:47:21 +00:00
// No need to start if scanning the library because it will handle it
if (request.RefreshLibrary)
{
_libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
}
else
{
// Need to add a delay here or directory watchers may still pick up the changes
var task = Task.Delay(1000);
// Have to block here to allow exceptions to bubble
Task.WaitAll(task);
_libraryMonitor.Start();
}
});
2013-09-05 17:05:39 +00:00
}
2013-02-25 03:56:00 +00:00
}
2013-02-25 03:56:00 +00:00
/// <summary>
/// Deletes the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Delete(RemoveVirtualFolder request)
2013-02-25 03:56:00 +00:00
{
2016-05-04 20:50:47 +00:00
_libraryManager.RemoveVirtualFolder(request.Name, request.RefreshLibrary);
2013-02-25 03:56:00 +00:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(AddMediaPath request)
2013-02-25 03:56:00 +00:00
{
if (string.IsNullOrWhiteSpace(request.Name))
{
throw new ArgumentNullException("request");
}
_libraryMonitor.Stop();
2013-08-13 14:41:45 +00:00
try
2013-02-25 03:56:00 +00:00
{
2016-05-04 16:33:22 +00:00
_libraryManager.AddMediaPath(request.Name, request.Path);
2013-02-25 03:56:00 +00:00
}
2013-08-13 14:41:45 +00:00
finally
2013-02-25 03:56:00 +00:00
{
2015-03-19 03:47:21 +00:00
Task.Run(() =>
{
2015-03-19 03:47:21 +00:00
// No need to start if scanning the library because it will handle it
if (request.RefreshLibrary)
{
_libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
}
else
{
// Need to add a delay here or directory watchers may still pick up the changes
var task = Task.Delay(1000);
// Have to block here to allow exceptions to bubble
Task.WaitAll(task);
_libraryMonitor.Start();
}
});
2013-09-05 17:05:39 +00:00
}
2013-02-25 03:56:00 +00:00
}
/// <summary>
/// Deletes the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Delete(RemoveMediaPath request)
2013-02-25 03:56:00 +00:00
{
if (string.IsNullOrWhiteSpace(request.Name))
{
throw new ArgumentNullException("request");
}
_libraryMonitor.Stop();
2013-08-13 14:41:45 +00:00
try
2013-02-25 03:56:00 +00:00
{
2016-05-04 20:50:47 +00:00
_libraryManager.RemoveMediaPath(request.Name, request.Path);
2013-02-25 03:56:00 +00:00
}
2013-08-13 14:41:45 +00:00
finally
2013-02-25 03:56:00 +00:00
{
2015-03-19 03:47:21 +00:00
Task.Run(() =>
{
2015-03-19 03:47:21 +00:00
// No need to start if scanning the library because it will handle it
if (request.RefreshLibrary)
{
_libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
}
else
{
// Need to add a delay here or directory watchers may still pick up the changes
var task = Task.Delay(1000);
// Have to block here to allow exceptions to bubble
Task.WaitAll(task);
_libraryMonitor.Start();
}
});
2013-09-05 17:05:39 +00:00
}
2013-02-25 03:56:00 +00:00
}
}
}