SystemService.cs 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. using MediaBrowser.Common.Configuration;
  2. using MediaBrowser.Common.IO;
  3. using MediaBrowser.Common.Net;
  4. using MediaBrowser.Common.Security;
  5. using MediaBrowser.Controller;
  6. using MediaBrowser.Controller.Net;
  7. using MediaBrowser.Model.Entities;
  8. using MediaBrowser.Model.System;
  9. using ServiceStack;
  10. using System;
  11. using System.Collections.Generic;
  12. using System.IO;
  13. using System.Linq;
  14. using System.Threading.Tasks;
  15. using CommonIO;
  16. using MediaBrowser.Model.Net;
  17. namespace MediaBrowser.Api.System
  18. {
  19. /// <summary>
  20. /// Class GetSystemInfo
  21. /// </summary>
  22. [Route("/System/Info", "GET", Summary = "Gets information about the server")]
  23. [Authenticated(EscapeParentalControl = true)]
  24. public class GetSystemInfo : IReturn<SystemInfo>
  25. {
  26. }
  27. [Route("/System/Info/Public", "GET", Summary = "Gets public information about the server")]
  28. public class GetPublicSystemInfo : IReturn<PublicSystemInfo>
  29. {
  30. }
  31. [Route("/System/Ping", "POST")]
  32. public class PingSystem : IReturnVoid
  33. {
  34. }
  35. /// <summary>
  36. /// Class RestartApplication
  37. /// </summary>
  38. [Route("/System/Restart", "POST", Summary = "Restarts the application, if needed")]
  39. [Authenticated(Roles = "Admin")]
  40. public class RestartApplication
  41. {
  42. }
  43. /// <summary>
  44. /// This is currently not authenticated because the uninstaller needs to be able to shutdown the server.
  45. /// </summary>
  46. [Route("/System/Shutdown", "POST", Summary = "Shuts down the application")]
  47. public class ShutdownApplication
  48. {
  49. // TODO: This is not currently authenticated due to uninstaller
  50. // Improve later
  51. }
  52. [Route("/System/Logs", "GET", Summary = "Gets a list of available server log files")]
  53. [Authenticated(Roles = "Admin")]
  54. public class GetServerLogs : IReturn<List<LogFile>>
  55. {
  56. }
  57. [Route("/System/Endpoint", "GET", Summary = "Gets information about the request endpoint")]
  58. [Authenticated]
  59. public class GetEndpointInfo : IReturn<EndPointInfo>
  60. {
  61. public string Endpoint { get; set; }
  62. }
  63. [Route("/System/Logs/Log", "GET", Summary = "Gets a log file")]
  64. [Authenticated(Roles = "Admin")]
  65. public class GetLogFile
  66. {
  67. [ApiMember(Name = "Name", Description = "The log file name.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  68. public string Name { get; set; }
  69. }
  70. /// <summary>
  71. /// Class SystemInfoService
  72. /// </summary>
  73. public class SystemService : BaseApiService
  74. {
  75. /// <summary>
  76. /// The _app host
  77. /// </summary>
  78. private readonly IServerApplicationHost _appHost;
  79. private readonly IApplicationPaths _appPaths;
  80. private readonly IFileSystem _fileSystem;
  81. private readonly INetworkManager _network;
  82. private readonly ISecurityManager _security;
  83. /// <summary>
  84. /// Initializes a new instance of the <see cref="SystemService" /> class.
  85. /// </summary>
  86. /// <param name="appHost">The app host.</param>
  87. /// <param name="appPaths">The application paths.</param>
  88. /// <param name="fileSystem">The file system.</param>
  89. /// <exception cref="ArgumentNullException">jsonSerializer</exception>
  90. public SystemService(IServerApplicationHost appHost, IApplicationPaths appPaths, IFileSystem fileSystem, INetworkManager network, ISecurityManager security)
  91. {
  92. _appHost = appHost;
  93. _appPaths = appPaths;
  94. _fileSystem = fileSystem;
  95. _network = network;
  96. _security = security;
  97. }
  98. public object Post(PingSystem request)
  99. {
  100. return _appHost.Name;
  101. }
  102. public object Get(GetServerLogs request)
  103. {
  104. List<FileSystemMetadata> files;
  105. try
  106. {
  107. files = _fileSystem.GetFiles(_appPaths.LogDirectoryPath)
  108. .Where(i => string.Equals(i.Extension, ".txt", StringComparison.OrdinalIgnoreCase))
  109. .ToList();
  110. }
  111. catch (DirectoryNotFoundException)
  112. {
  113. files = new List<FileSystemMetadata>();
  114. }
  115. var result = files.Select(i => new LogFile
  116. {
  117. DateCreated = _fileSystem.GetCreationTimeUtc(i),
  118. DateModified = _fileSystem.GetLastWriteTimeUtc(i),
  119. Name = i.Name,
  120. Size = i.Length
  121. }).OrderByDescending(i => i.DateModified)
  122. .ThenByDescending(i => i.DateCreated)
  123. .ThenBy(i => i.Name)
  124. .ToList();
  125. return ToOptimizedResult(result);
  126. }
  127. public object Get(GetLogFile request)
  128. {
  129. var file = _fileSystem.GetFiles(_appPaths.LogDirectoryPath)
  130. .First(i => string.Equals(i.Name, request.Name, StringComparison.OrdinalIgnoreCase));
  131. return ResultFactory.GetStaticFileResult(Request, file.FullName, FileShare.ReadWrite);
  132. }
  133. /// <summary>
  134. /// Gets the specified request.
  135. /// </summary>
  136. /// <param name="request">The request.</param>
  137. /// <returns>System.Object.</returns>
  138. public object Get(GetSystemInfo request)
  139. {
  140. var result = _appHost.GetSystemInfo();
  141. return ToOptimizedResult(result);
  142. }
  143. public object Get(GetPublicSystemInfo request)
  144. {
  145. var result = _appHost.GetSystemInfo();
  146. var publicInfo = new PublicSystemInfo
  147. {
  148. Id = result.Id,
  149. ServerName = result.ServerName,
  150. Version = result.Version,
  151. LocalAddress = result.LocalAddress,
  152. WanAddress = result.WanAddress,
  153. OperatingSystem = result.OperatingSystem
  154. };
  155. return ToOptimizedResult(publicInfo);
  156. }
  157. /// <summary>
  158. /// Posts the specified request.
  159. /// </summary>
  160. /// <param name="request">The request.</param>
  161. public void Post(RestartApplication request)
  162. {
  163. Task.Run(async () =>
  164. {
  165. await Task.Delay(100).ConfigureAwait(false);
  166. await _appHost.Restart().ConfigureAwait(false);
  167. });
  168. }
  169. /// <summary>
  170. /// Posts the specified request.
  171. /// </summary>
  172. /// <param name="request">The request.</param>
  173. public void Post(ShutdownApplication request)
  174. {
  175. Task.Run(async () =>
  176. {
  177. await Task.Delay(100).ConfigureAwait(false);
  178. await _appHost.Shutdown().ConfigureAwait(false);
  179. });
  180. }
  181. public object Get(GetEndpointInfo request)
  182. {
  183. return ToOptimizedResult(new EndPointInfo
  184. {
  185. IsLocal = Request.IsLocal,
  186. IsInNetwork = _network.IsInLocalNetwork(request.Endpoint ?? Request.RemoteIp)
  187. });
  188. }
  189. }
  190. }