aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Api/EnvironmentService.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Api/EnvironmentService.cs')
-rw-r--r--MediaBrowser.Api/EnvironmentService.cs285
1 files changed, 285 insertions, 0 deletions
diff --git a/MediaBrowser.Api/EnvironmentService.cs b/MediaBrowser.Api/EnvironmentService.cs
new file mode 100644
index 000000000..720a71025
--- /dev/null
+++ b/MediaBrowser.Api/EnvironmentService.cs
@@ -0,0 +1,285 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using MediaBrowser.Common.Net;
+using MediaBrowser.Controller.Configuration;
+using MediaBrowser.Controller.Net;
+using MediaBrowser.Model.IO;
+using MediaBrowser.Model.Services;
+using Microsoft.Extensions.Logging;
+
+namespace MediaBrowser.Api
+{
+ /// <summary>
+ /// Class GetDirectoryContents.
+ /// </summary>
+ [Route("/Environment/DirectoryContents", "GET", Summary = "Gets the contents of a given directory in the file system")]
+ public class GetDirectoryContents : 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; }
+
+ /// <summary>
+ /// Gets or sets a value indicating whether [include files].
+ /// </summary>
+ /// <value><c>true</c> if [include files]; otherwise, <c>false</c>.</value>
+ [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")]
+ public bool IncludeFiles { get; set; }
+
+ /// <summary>
+ /// Gets or sets a value indicating whether [include directories].
+ /// </summary>
+ /// <value><c>true</c> if [include directories]; otherwise, <c>false</c>.</value>
+ [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")]
+ public bool IncludeDirectories { get; set; }
+ }
+
+ [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; }
+ }
+
+ [Obsolete]
+ [Route("/Environment/NetworkShares", "GET", Summary = "Gets shares from a network device")]
+ 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; }
+ }
+
+ /// <summary>
+ /// Class GetDrives.
+ /// </summary>
+ [Route("/Environment/Drives", "GET", Summary = "Gets available drives from the server's file system")]
+ public class GetDrives : IReturn<List<FileSystemEntryInfo>>
+ {
+ }
+
+ /// <summary>
+ /// Class GetNetworkComputers.
+ /// </summary>
+ [Route("/Environment/NetworkDevices", "GET", Summary = "Gets a list of devices on the network")]
+ public class GetNetworkDevices : IReturn<List<FileSystemEntryInfo>>
+ {
+ }
+
+ [Route("/Environment/ParentPath", "GET", Summary = "Gets the parent path of a given path")]
+ 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; }
+ }
+
+ 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>
+ {
+ }
+
+ /// <summary>
+ /// Class EnvironmentService.
+ /// </summary>
+ [Authenticated(Roles = "Admin", AllowBeforeStartupWizard = true)]
+ public class EnvironmentService : BaseApiService
+ {
+ private const char UncSeparator = '\\';
+ private const string UncSeparatorString = "\\";
+
+ /// <summary>
+ /// The _network manager.
+ /// </summary>
+ private readonly INetworkManager _networkManager;
+ private readonly IFileSystem _fileSystem;
+
+ /// <summary>
+ /// Initializes a new instance of the <see cref="EnvironmentService" /> class.
+ /// </summary>
+ /// <param name="networkManager">The network manager.</param>
+ public EnvironmentService(
+ ILogger<EnvironmentService> logger,
+ IServerConfigurationManager serverConfigurationManager,
+ IHttpResultFactory httpResultFactory,
+ INetworkManager networkManager,
+ IFileSystem fileSystem)
+ : base(logger, serverConfigurationManager, httpResultFactory)
+ {
+ _networkManager = networkManager;
+ _fileSystem = fileSystem;
+ }
+
+ public void Post(ValidatePath request)
+ {
+ if (request.IsFile.HasValue)
+ {
+ if (request.IsFile.Value)
+ {
+ if (!File.Exists(request.Path))
+ {
+ throw new FileNotFoundException("File not found", request.Path);
+ }
+ }
+ else
+ {
+ if (!Directory.Exists(request.Path))
+ {
+ throw new FileNotFoundException("File not found", request.Path);
+ }
+ }
+ }
+
+ else
+ {
+ if (!File.Exists(request.Path) && !Directory.Exists(request.Path))
+ {
+ 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());
+
+ File.WriteAllText(file, string.Empty);
+ _fileSystem.DeleteFile(file);
+ }
+
+ public object Get(GetDefaultDirectoryBrowser request) =>
+ ToOptimizedResult(new DefaultDirectoryBrowserInfo { Path = null });
+
+ /// <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))
+ {
+ throw new ArgumentNullException(nameof(Path));
+ }
+
+ var networkPrefix = UncSeparatorString + UncSeparatorString;
+
+ if (path.StartsWith(networkPrefix, StringComparison.OrdinalIgnoreCase)
+ && path.LastIndexOf(UncSeparator) == 1)
+ {
+ return ToOptimizedResult(Array.Empty<FileSystemEntryInfo>());
+ }
+
+ return ToOptimizedResult(GetFileSystemEntries(request).ToList());
+ }
+
+ [Obsolete]
+ public object Get(GetNetworkShares request)
+ => ToOptimizedResult(Array.Empty<FileSystemEntryInfo>());
+
+ /// <summary>
+ /// Gets the specified request.
+ /// </summary>
+ /// <param name="request">The request.</param>
+ /// <returns>System.Object.</returns>
+ public object Get(GetDrives request)
+ {
+ var result = GetDrives().ToList();
+
+ return ToOptimizedResult(result);
+ }
+
+ /// <summary>
+ /// Gets the list that is returned when an empty path is supplied.
+ /// </summary>
+ /// <returns>IEnumerable{FileSystemEntryInfo}.</returns>
+ private IEnumerable<FileSystemEntryInfo> GetDrives()
+ {
+ return _fileSystem.GetDrives().Select(d => new FileSystemEntryInfo(d.Name, d.FullName, FileSystemEntryType.Directory));
+ }
+
+ /// <summary>
+ /// Gets the specified request.
+ /// </summary>
+ /// <param name="request">The request.</param>
+ /// <returns>System.Object.</returns>
+ public object Get(GetNetworkDevices request)
+ => ToOptimizedResult(Array.Empty<FileSystemEntryInfo>());
+
+ /// <summary>
+ /// Gets the file system entries.
+ /// </summary>
+ /// <param name="request">The request.</param>
+ /// <returns>IEnumerable{FileSystemEntryInfo}.</returns>
+ private IEnumerable<FileSystemEntryInfo> GetFileSystemEntries(GetDirectoryContents request)
+ {
+ var entries = _fileSystem.GetFileSystemEntries(request.Path).OrderBy(i => i.FullName).Where(i =>
+ {
+ var isDirectory = i.IsDirectory;
+
+ if (!request.IncludeFiles && !isDirectory)
+ {
+ return false;
+ }
+
+ return request.IncludeDirectories || !isDirectory;
+ });
+
+ return entries.Select(f => new FileSystemEntryInfo(f.Name, f.FullName, f.IsDirectory ? FileSystemEntryType.Directory : FileSystemEntryType.File));
+ }
+
+ public object Get(GetParentPath request)
+ {
+ var parent = Path.GetDirectoryName(request.Path);
+
+ 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;
+ }
+ }
+}
generated by cgit v1.2.3 (git 2.46.0) at 2025-12-06 18:40:28 +0000