2019-01-13 15:01:16 -05:00
|
|
|
using System;
|
2013-02-20 20:33:05 -05:00
|
|
|
using System.Collections.Generic;
|
|
|
|
using System.IO;
|
|
|
|
using System.Linq;
|
2019-01-13 14:24:58 -05:00
|
|
|
using MediaBrowser.Common.Net;
|
|
|
|
using MediaBrowser.Controller.Net;
|
|
|
|
using MediaBrowser.Model.IO;
|
|
|
|
using MediaBrowser.Model.Net;
|
2016-10-25 15:02:04 -04:00
|
|
|
using MediaBrowser.Model.Services;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
namespace MediaBrowser.Api
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Class GetDirectoryContents
|
|
|
|
/// </summary>
|
2014-03-28 15:58:18 -04:00
|
|
|
[Route("/Environment/DirectoryContents", "GET", Summary = "Gets the contents of a given directory in the file system")]
|
2013-02-20 20:33:05 -05:00
|
|
|
public class GetDirectoryContents : IReturn<List<FileSystemEntryInfo>>
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the path.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The path.</value>
|
2013-03-08 14:14:09 -05:00
|
|
|
[ApiMember(Name = "Path", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
|
2013-02-20 20:33:05 -05:00
|
|
|
public string Path { get; set; }
|
2013-03-08 14:14:09 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets a value indicating whether [include files].
|
|
|
|
/// </summary>
|
|
|
|
/// <value><c>true</c> if [include files]; otherwise, <c>false</c>.</value>
|
2013-03-08 17:41:38 -05:00
|
|
|
[ApiMember(Name = "IncludeFiles", Description = "An optional filter to include or exclude files from the results. true/false", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
2013-02-20 20:33:05 -05:00
|
|
|
public bool IncludeFiles { get; set; }
|
2013-03-08 14:14:09 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets a value indicating whether [include directories].
|
|
|
|
/// </summary>
|
|
|
|
/// <value><c>true</c> if [include directories]; otherwise, <c>false</c>.</value>
|
2013-03-08 17:41:38 -05:00
|
|
|
[ApiMember(Name = "IncludeDirectories", Description = "An optional filter to include or exclude folders from the results. true/false", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
2013-02-20 20:33:05 -05:00
|
|
|
public bool IncludeDirectories { get; set; }
|
|
|
|
}
|
|
|
|
|
2017-07-07 18:04:46 -04:00
|
|
|
[Route("/Environment/ValidatePath", "POST", Summary = "Gets the contents of a given directory in the file system")]
|
|
|
|
public class ValidatePath
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the path.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The path.</value>
|
|
|
|
[ApiMember(Name = "Path", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
|
|
|
|
public string Path { get; set; }
|
|
|
|
|
|
|
|
public bool ValidateWriteable { get; set; }
|
|
|
|
public bool? IsFile { get; set; }
|
|
|
|
}
|
|
|
|
|
2019-11-28 11:46:06 -05:00
|
|
|
[Obsolete]
|
2014-03-28 15:58:18 -04:00
|
|
|
[Route("/Environment/NetworkShares", "GET", Summary = "Gets shares from a network device")]
|
2014-01-01 13:26:31 -05:00
|
|
|
public class GetNetworkShares : IReturn<List<FileSystemEntryInfo>>
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the path.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The path.</value>
|
|
|
|
[ApiMember(Name = "Path", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
|
|
public string Path { get; set; }
|
|
|
|
}
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Class GetDrives
|
|
|
|
/// </summary>
|
2014-03-28 15:58:18 -04:00
|
|
|
[Route("/Environment/Drives", "GET", Summary = "Gets available drives from the server's file system")]
|
2013-02-20 20:33:05 -05:00
|
|
|
public class GetDrives : IReturn<List<FileSystemEntryInfo>>
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2013-09-06 16:25:03 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Class GetNetworkComputers
|
|
|
|
/// </summary>
|
2014-03-28 15:58:18 -04:00
|
|
|
[Route("/Environment/NetworkDevices", "GET", Summary = "Gets a list of devices on the network")]
|
2013-09-06 16:25:03 -04:00
|
|
|
public class GetNetworkDevices : IReturn<List<FileSystemEntryInfo>>
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2014-03-28 15:58:18 -04:00
|
|
|
[Route("/Environment/ParentPath", "GET", Summary = "Gets the parent path of a given path")]
|
2014-01-01 13:26:31 -05:00
|
|
|
public class GetParentPath : IReturn<string>
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the path.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The path.</value>
|
|
|
|
[ApiMember(Name = "Path", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
|
|
public string Path { get; set; }
|
|
|
|
}
|
|
|
|
|
2016-07-23 02:49:46 -04:00
|
|
|
public class DefaultDirectoryBrowserInfo
|
|
|
|
{
|
|
|
|
public string Path { get; set; }
|
|
|
|
}
|
|
|
|
|
|
|
|
[Route("/Environment/DefaultDirectoryBrowser", "GET", Summary = "Gets the parent path of a given path")]
|
|
|
|
public class GetDefaultDirectoryBrowser : IReturn<DefaultDirectoryBrowserInfo>
|
|
|
|
{
|
2019-01-07 18:27:46 -05:00
|
|
|
|
2016-07-23 02:49:46 -04:00
|
|
|
}
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Class EnvironmentService
|
|
|
|
/// </summary>
|
2014-12-16 00:46:54 -05:00
|
|
|
[Authenticated(Roles = "Admin", AllowBeforeStartupWizard = true)]
|
2013-03-16 01:52:33 -04:00
|
|
|
public class EnvironmentService : BaseApiService
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2014-01-01 13:26:31 -05:00
|
|
|
const char UncSeparator = '\\';
|
2016-10-31 23:07:45 -04:00
|
|
|
const string UncSeparatorString = "\\";
|
2014-01-01 13:26:31 -05:00
|
|
|
|
2013-02-23 12:54:51 -05:00
|
|
|
/// <summary>
|
|
|
|
/// The _network manager
|
|
|
|
/// </summary>
|
|
|
|
private readonly INetworkManager _networkManager;
|
2017-07-07 18:04:46 -04:00
|
|
|
private readonly IFileSystem _fileSystem;
|
2013-02-23 12:54:51 -05:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Initializes a new instance of the <see cref="EnvironmentService" /> class.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="networkManager">The network manager.</param>
|
2015-09-14 21:16:31 -04:00
|
|
|
public EnvironmentService(INetworkManager networkManager, IFileSystem fileSystem)
|
2013-02-23 12:54:51 -05:00
|
|
|
{
|
|
|
|
if (networkManager == null)
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
throw new ArgumentNullException(nameof(networkManager));
|
2013-02-23 12:54:51 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
_networkManager = networkManager;
|
2015-09-14 21:16:31 -04:00
|
|
|
_fileSystem = fileSystem;
|
2013-02-23 12:54:51 -05:00
|
|
|
}
|
|
|
|
|
2017-07-07 18:04:46 -04:00
|
|
|
public void Post(ValidatePath request)
|
|
|
|
{
|
|
|
|
if (request.IsFile.HasValue)
|
|
|
|
{
|
|
|
|
if (request.IsFile.Value)
|
|
|
|
{
|
2019-01-26 16:59:53 -05:00
|
|
|
if (!File.Exists(request.Path))
|
2017-07-07 18:04:46 -04:00
|
|
|
{
|
|
|
|
throw new FileNotFoundException("File not found", request.Path);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2019-01-29 19:02:17 -05:00
|
|
|
if (!Directory.Exists(request.Path))
|
2017-07-07 18:04:46 -04:00
|
|
|
{
|
|
|
|
throw new FileNotFoundException("File not found", request.Path);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
else
|
|
|
|
{
|
2019-01-29 19:02:17 -05:00
|
|
|
if (!File.Exists(request.Path) && !Directory.Exists(request.Path))
|
2017-07-07 18:04:46 -04:00
|
|
|
{
|
|
|
|
throw new FileNotFoundException("Path not found", request.Path);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (request.ValidateWriteable)
|
|
|
|
{
|
|
|
|
EnsureWriteAccess(request.Path);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
protected void EnsureWriteAccess(string path)
|
|
|
|
{
|
|
|
|
var file = Path.Combine(path, Guid.NewGuid().ToString());
|
|
|
|
|
2019-01-26 17:09:07 -05:00
|
|
|
File.WriteAllText(file, string.Empty);
|
2017-07-07 18:04:46 -04:00
|
|
|
_fileSystem.DeleteFile(file);
|
|
|
|
}
|
|
|
|
|
2019-02-17 05:54:47 -05:00
|
|
|
public object Get(GetDefaultDirectoryBrowser request) =>
|
|
|
|
ToOptimizedResult(new DefaultDirectoryBrowserInfo {Path = null});
|
2016-07-23 02:49:46 -04:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the specified request.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="request">The request.</param>
|
|
|
|
/// <returns>System.Object.</returns>
|
|
|
|
public object Get(GetDirectoryContents request)
|
|
|
|
{
|
|
|
|
var path = request.Path;
|
|
|
|
|
|
|
|
if (string.IsNullOrEmpty(path))
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
throw new ArgumentNullException(nameof(Path));
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2016-10-31 23:07:45 -04:00
|
|
|
var networkPrefix = UncSeparatorString + UncSeparatorString;
|
2013-10-01 17:18:31 -04:00
|
|
|
|
2019-11-28 11:46:06 -05:00
|
|
|
if (path.StartsWith(networkPrefix, StringComparison.OrdinalIgnoreCase)
|
|
|
|
&& path.LastIndexOf(UncSeparator) == 1)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2019-11-28 11:46:06 -05:00
|
|
|
return ToOptimizedResult(Array.Empty<FileSystemEntryInfo>());
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
return ToOptimizedResult(GetFileSystemEntries(request).ToList());
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2019-11-28 11:46:06 -05:00
|
|
|
[Obsolete]
|
2014-01-01 13:26:31 -05:00
|
|
|
public object Get(GetNetworkShares request)
|
2019-11-28 11:46:06 -05:00
|
|
|
=> ToOptimizedResult(Array.Empty<FileSystemEntryInfo>());
|
2014-01-01 13:26:31 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the specified request.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="request">The request.</param>
|
|
|
|
/// <returns>System.Object.</returns>
|
|
|
|
public object Get(GetDrives request)
|
|
|
|
{
|
2013-02-28 14:32:41 -05:00
|
|
|
var result = GetDrives().ToList();
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
return ToOptimizedResult(result);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the list that is returned when an empty path is supplied
|
|
|
|
/// </summary>
|
|
|
|
/// <returns>IEnumerable{FileSystemEntryInfo}.</returns>
|
|
|
|
private IEnumerable<FileSystemEntryInfo> GetDrives()
|
|
|
|
{
|
2016-10-31 23:07:45 -04:00
|
|
|
return _fileSystem.GetDrives().Select(d => new FileSystemEntryInfo
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2016-10-31 23:07:45 -04:00
|
|
|
Name = d.Name,
|
|
|
|
Path = d.FullName,
|
2013-02-20 20:33:05 -05:00
|
|
|
Type = FileSystemEntryType.Directory
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2013-09-06 16:25:03 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the specified request.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="request">The request.</param>
|
|
|
|
/// <returns>System.Object.</returns>
|
|
|
|
public object Get(GetNetworkDevices request)
|
2019-11-28 11:46:06 -05:00
|
|
|
=> ToOptimizedResult(Array.Empty<FileSystemEntryInfo>());
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the file system entries.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="request">The request.</param>
|
|
|
|
/// <returns>IEnumerable{FileSystemEntryInfo}.</returns>
|
|
|
|
private IEnumerable<FileSystemEntryInfo> GetFileSystemEntries(GetDirectoryContents request)
|
|
|
|
{
|
2017-08-30 14:06:54 -04:00
|
|
|
var entries = _fileSystem.GetFileSystemEntries(request.Path).OrderBy(i => i.FullName).Where(i =>
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2015-11-12 15:51:39 -05:00
|
|
|
var isDirectory = i.IsDirectory;
|
2013-04-27 19:09:44 -04:00
|
|
|
|
|
|
|
if (!request.IncludeFiles && !isDirectory)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!request.IncludeDirectories && isDirectory)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
2014-01-01 13:26:31 -05:00
|
|
|
|
2013-04-27 19:09:44 -04:00
|
|
|
return true;
|
|
|
|
});
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2013-04-27 19:09:44 -04:00
|
|
|
return entries.Select(f => new FileSystemEntryInfo
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2013-04-27 19:09:44 -04:00
|
|
|
Name = f.Name,
|
|
|
|
Path = f.FullName,
|
2015-11-12 15:51:39 -05:00
|
|
|
Type = f.IsDirectory ? FileSystemEntryType.Directory : FileSystemEntryType.File
|
2013-04-27 19:09:44 -04:00
|
|
|
|
2017-08-19 15:43:35 -04:00
|
|
|
});
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2014-01-01 13:26:31 -05:00
|
|
|
public object Get(GetParentPath request)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2019-01-26 15:47:11 -05:00
|
|
|
var parent = Path.GetDirectoryName(request.Path);
|
2014-01-01 13:26:31 -05:00
|
|
|
|
|
|
|
if (string.IsNullOrEmpty(parent))
|
|
|
|
{
|
|
|
|
// Check if unc share
|
|
|
|
var index = request.Path.LastIndexOf(UncSeparator);
|
|
|
|
|
|
|
|
if (index != -1 && request.Path.IndexOf(UncSeparator) == 0)
|
|
|
|
{
|
|
|
|
parent = request.Path.Substring(0, index);
|
|
|
|
|
|
|
|
if (string.IsNullOrWhiteSpace(parent.TrimStart(UncSeparator)))
|
|
|
|
{
|
|
|
|
parent = null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return parent;
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|