ActivityLogEntryPoint.cs 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644
  1. #pragma warning disable CS1591
  2. #pragma warning disable SA1600
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Globalization;
  6. using System.Linq;
  7. using System.Text;
  8. using System.Threading.Tasks;
  9. using MediaBrowser.Common.Plugins;
  10. using MediaBrowser.Common.Updates;
  11. using MediaBrowser.Controller;
  12. using MediaBrowser.Controller.Authentication;
  13. using MediaBrowser.Controller.Devices;
  14. using MediaBrowser.Controller.Entities;
  15. using MediaBrowser.Controller.Library;
  16. using MediaBrowser.Controller.Plugins;
  17. using MediaBrowser.Controller.Session;
  18. using MediaBrowser.Controller.Subtitles;
  19. using MediaBrowser.Model.Activity;
  20. using MediaBrowser.Model.Dto;
  21. using MediaBrowser.Model.Entities;
  22. using MediaBrowser.Model.Events;
  23. using MediaBrowser.Model.Globalization;
  24. using MediaBrowser.Model.Notifications;
  25. using MediaBrowser.Model.Tasks;
  26. using MediaBrowser.Model.Updates;
  27. using Microsoft.Extensions.Logging;
  28. namespace Emby.Server.Implementations.Activity
  29. {
  30. public sealed class ActivityLogEntryPoint : IServerEntryPoint
  31. {
  32. private readonly ILogger _logger;
  33. private readonly IInstallationManager _installationManager;
  34. private readonly ISessionManager _sessionManager;
  35. private readonly ITaskManager _taskManager;
  36. private readonly IActivityManager _activityManager;
  37. private readonly ILocalizationManager _localization;
  38. private readonly ISubtitleManager _subManager;
  39. private readonly IUserManager _userManager;
  40. private readonly IDeviceManager _deviceManager;
  41. /// <summary>
  42. /// Initializes a new instance of the <see cref="ActivityLogEntryPoint"/> class.
  43. /// </summary>
  44. /// <param name="logger"></param>
  45. /// <param name="sessionManager"></param>
  46. /// <param name="deviceManager"></param>
  47. /// <param name="taskManager"></param>
  48. /// <param name="activityManager"></param>
  49. /// <param name="localization"></param>
  50. /// <param name="installationManager"></param>
  51. /// <param name="subManager"></param>
  52. /// <param name="userManager"></param>
  53. /// <param name="appHost"></param>
  54. public ActivityLogEntryPoint(
  55. ILogger<ActivityLogEntryPoint> logger,
  56. ISessionManager sessionManager,
  57. IDeviceManager deviceManager,
  58. ITaskManager taskManager,
  59. IActivityManager activityManager,
  60. ILocalizationManager localization,
  61. IInstallationManager installationManager,
  62. ISubtitleManager subManager,
  63. IUserManager userManager)
  64. {
  65. _logger = logger;
  66. _sessionManager = sessionManager;
  67. _deviceManager = deviceManager;
  68. _taskManager = taskManager;
  69. _activityManager = activityManager;
  70. _localization = localization;
  71. _installationManager = installationManager;
  72. _subManager = subManager;
  73. _userManager = userManager;
  74. }
  75. public Task RunAsync()
  76. {
  77. _taskManager.TaskCompleted += OnTaskCompleted;
  78. _installationManager.PluginInstalled += OnPluginInstalled;
  79. _installationManager.PluginUninstalled += OnPluginUninstalled;
  80. _installationManager.PluginUpdated += OnPluginUpdated;
  81. _installationManager.PackageInstallationFailed += OnPackageInstallationFailed;
  82. _sessionManager.SessionStarted += OnSessionStarted;
  83. _sessionManager.AuthenticationFailed += OnAuthenticationFailed;
  84. _sessionManager.AuthenticationSucceeded += OnAuthenticationSucceeded;
  85. _sessionManager.SessionEnded += OnSessionEnded;
  86. _sessionManager.PlaybackStart += OnPlaybackStart;
  87. _sessionManager.PlaybackStopped += OnPlaybackStopped;
  88. _subManager.SubtitleDownloadFailure += OnSubtitleDownloadFailure;
  89. _userManager.UserCreated += OnUserCreated;
  90. _userManager.UserPasswordChanged += OnUserPasswordChanged;
  91. _userManager.UserDeleted += OnUserDeleted;
  92. _userManager.UserPolicyUpdated += OnUserPolicyUpdated;
  93. _userManager.UserLockedOut += OnUserLockedOut;
  94. _deviceManager.CameraImageUploaded += OnCameraImageUploaded;
  95. return Task.CompletedTask;
  96. }
  97. private void OnCameraImageUploaded(object sender, GenericEventArgs<CameraImageUploadInfo> e)
  98. {
  99. CreateLogEntry(new ActivityLogEntry
  100. {
  101. Name = string.Format(
  102. CultureInfo.InvariantCulture,
  103. _localization.GetLocalizedString("CameraImageUploadedFrom"),
  104. e.Argument.Device.Name),
  105. Type = NotificationType.CameraImageUploaded.ToString()
  106. });
  107. }
  108. private void OnUserLockedOut(object sender, GenericEventArgs<User> e)
  109. {
  110. CreateLogEntry(new ActivityLogEntry
  111. {
  112. Name = string.Format(
  113. CultureInfo.InvariantCulture,
  114. _localization.GetLocalizedString("UserLockedOutWithName"),
  115. e.Argument.Name),
  116. Type = NotificationType.UserLockedOut.ToString(),
  117. UserId = e.Argument.Id
  118. });
  119. }
  120. private void OnSubtitleDownloadFailure(object sender, SubtitleDownloadFailureEventArgs e)
  121. {
  122. CreateLogEntry(new ActivityLogEntry
  123. {
  124. Name = string.Format(
  125. CultureInfo.InvariantCulture,
  126. _localization.GetLocalizedString("SubtitleDownloadFailureFromForItem"),
  127. e.Provider,
  128. Emby.Notifications.NotificationEntryPoint.GetItemName(e.Item)),
  129. Type = "SubtitleDownloadFailure",
  130. ItemId = e.Item.Id.ToString("N", CultureInfo.InvariantCulture),
  131. ShortOverview = e.Exception.Message
  132. });
  133. }
  134. private void OnPlaybackStopped(object sender, PlaybackStopEventArgs e)
  135. {
  136. var item = e.MediaInfo;
  137. if (item == null)
  138. {
  139. _logger.LogWarning("PlaybackStopped reported with null media info.");
  140. return;
  141. }
  142. if (e.Item != null && e.Item.IsThemeMedia)
  143. {
  144. // Don't report theme song or local trailer playback
  145. return;
  146. }
  147. if (e.Users.Count == 0)
  148. {
  149. return;
  150. }
  151. var user = e.Users[0];
  152. CreateLogEntry(new ActivityLogEntry
  153. {
  154. Name = string.Format(_localization.GetLocalizedString("UserStoppedPlayingItemWithValues"), user.Name, GetItemName(item), e.DeviceName),
  155. Type = GetPlaybackStoppedNotificationType(item.MediaType),
  156. UserId = user.Id
  157. });
  158. }
  159. private void OnPlaybackStart(object sender, PlaybackProgressEventArgs e)
  160. {
  161. var item = e.MediaInfo;
  162. if (item == null)
  163. {
  164. _logger.LogWarning("PlaybackStart reported with null media info.");
  165. return;
  166. }
  167. if (e.Item != null && e.Item.IsThemeMedia)
  168. {
  169. // Don't report theme song or local trailer playback
  170. return;
  171. }
  172. if (e.Users.Count == 0)
  173. {
  174. return;
  175. }
  176. var user = e.Users.First();
  177. CreateLogEntry(new ActivityLogEntry
  178. {
  179. Name = string.Format(
  180. CultureInfo.InvariantCulture,
  181. _localization.GetLocalizedString("UserStartedPlayingItemWithValues"),
  182. user.Name,
  183. GetItemName(item),
  184. e.DeviceName),
  185. Type = GetPlaybackNotificationType(item.MediaType),
  186. UserId = user.Id
  187. });
  188. }
  189. private static string GetItemName(BaseItemDto item)
  190. {
  191. var name = item.Name;
  192. if (!string.IsNullOrEmpty(item.SeriesName))
  193. {
  194. name = item.SeriesName + " - " + name;
  195. }
  196. if (item.Artists != null && item.Artists.Count > 0)
  197. {
  198. name = item.Artists[0] + " - " + name;
  199. }
  200. return name;
  201. }
  202. private static string GetPlaybackNotificationType(string mediaType)
  203. {
  204. if (string.Equals(mediaType, MediaType.Audio, StringComparison.OrdinalIgnoreCase))
  205. {
  206. return NotificationType.AudioPlayback.ToString();
  207. }
  208. if (string.Equals(mediaType, MediaType.Video, StringComparison.OrdinalIgnoreCase))
  209. {
  210. return NotificationType.VideoPlayback.ToString();
  211. }
  212. return null;
  213. }
  214. private static string GetPlaybackStoppedNotificationType(string mediaType)
  215. {
  216. if (string.Equals(mediaType, MediaType.Audio, StringComparison.OrdinalIgnoreCase))
  217. {
  218. return NotificationType.AudioPlaybackStopped.ToString();
  219. }
  220. if (string.Equals(mediaType, MediaType.Video, StringComparison.OrdinalIgnoreCase))
  221. {
  222. return NotificationType.VideoPlaybackStopped.ToString();
  223. }
  224. return null;
  225. }
  226. private void OnSessionEnded(object sender, SessionEventArgs e)
  227. {
  228. string name;
  229. var session = e.SessionInfo;
  230. if (string.IsNullOrEmpty(session.UserName))
  231. {
  232. name = string.Format(
  233. CultureInfo.InvariantCulture,
  234. _localization.GetLocalizedString("DeviceOfflineWithName"),
  235. session.DeviceName);
  236. // Causing too much spam for now
  237. return;
  238. }
  239. else
  240. {
  241. name = string.Format(
  242. CultureInfo.InvariantCulture,
  243. _localization.GetLocalizedString("UserOfflineFromDevice"),
  244. session.UserName,
  245. session.DeviceName);
  246. }
  247. CreateLogEntry(new ActivityLogEntry
  248. {
  249. Name = name,
  250. Type = "SessionEnded",
  251. ShortOverview = string.Format(
  252. CultureInfo.InvariantCulture,
  253. _localization.GetLocalizedString("LabelIpAddressValue"),
  254. session.RemoteEndPoint),
  255. UserId = session.UserId
  256. });
  257. }
  258. private void OnAuthenticationSucceeded(object sender, GenericEventArgs<AuthenticationResult> e)
  259. {
  260. var user = e.Argument.User;
  261. CreateLogEntry(new ActivityLogEntry
  262. {
  263. Name = string.Format(
  264. CultureInfo.InvariantCulture,
  265. _localization.GetLocalizedString("AuthenticationSucceededWithUserName"),
  266. user.Name),
  267. Type = "AuthenticationSucceeded",
  268. ShortOverview = string.Format(
  269. CultureInfo.InvariantCulture,
  270. _localization.GetLocalizedString("LabelIpAddressValue"),
  271. e.Argument.SessionInfo.RemoteEndPoint),
  272. UserId = user.Id
  273. });
  274. }
  275. private void OnAuthenticationFailed(object sender, GenericEventArgs<AuthenticationRequest> e)
  276. {
  277. CreateLogEntry(new ActivityLogEntry
  278. {
  279. Name = string.Format(
  280. CultureInfo.InvariantCulture,
  281. _localization.GetLocalizedString("FailedLoginAttemptWithUserName"),
  282. e.Argument.Username),
  283. Type = "AuthenticationFailed",
  284. ShortOverview = string.Format(
  285. CultureInfo.InvariantCulture,
  286. _localization.GetLocalizedString("LabelIpAddressValue"),
  287. e.Argument.RemoteEndPoint),
  288. Severity = LogLevel.Error
  289. });
  290. }
  291. private void OnUserPolicyUpdated(object sender, GenericEventArgs<User> e)
  292. {
  293. CreateLogEntry(new ActivityLogEntry
  294. {
  295. Name = string.Format(
  296. CultureInfo.InvariantCulture,
  297. _localization.GetLocalizedString("UserPolicyUpdatedWithName"),
  298. e.Argument.Name),
  299. Type = "UserPolicyUpdated",
  300. UserId = e.Argument.Id
  301. });
  302. }
  303. private void OnUserDeleted(object sender, GenericEventArgs<User> e)
  304. {
  305. CreateLogEntry(new ActivityLogEntry
  306. {
  307. Name = string.Format(
  308. CultureInfo.InvariantCulture,
  309. _localization.GetLocalizedString("UserDeletedWithName"),
  310. e.Argument.Name),
  311. Type = "UserDeleted"
  312. });
  313. }
  314. private void OnUserPasswordChanged(object sender, GenericEventArgs<User> e)
  315. {
  316. CreateLogEntry(new ActivityLogEntry
  317. {
  318. Name = string.Format(
  319. CultureInfo.InvariantCulture,
  320. _localization.GetLocalizedString("UserPasswordChangedWithName"),
  321. e.Argument.Name),
  322. Type = "UserPasswordChanged",
  323. UserId = e.Argument.Id
  324. });
  325. }
  326. private void OnUserCreated(object sender, GenericEventArgs<User> e)
  327. {
  328. CreateLogEntry(new ActivityLogEntry
  329. {
  330. Name = string.Format(
  331. CultureInfo.InvariantCulture,
  332. _localization.GetLocalizedString("UserCreatedWithName"),
  333. e.Argument.Name),
  334. Type = "UserCreated",
  335. UserId = e.Argument.Id
  336. });
  337. }
  338. private void OnSessionStarted(object sender, SessionEventArgs e)
  339. {
  340. string name;
  341. var session = e.SessionInfo;
  342. if (string.IsNullOrEmpty(session.UserName))
  343. {
  344. name = string.Format(
  345. CultureInfo.InvariantCulture,
  346. _localization.GetLocalizedString("DeviceOnlineWithName"),
  347. session.DeviceName);
  348. // Causing too much spam for now
  349. return;
  350. }
  351. else
  352. {
  353. name = string.Format(
  354. CultureInfo.InvariantCulture,
  355. _localization.GetLocalizedString("UserOnlineFromDevice"),
  356. session.UserName,
  357. session.DeviceName);
  358. }
  359. CreateLogEntry(new ActivityLogEntry
  360. {
  361. Name = name,
  362. Type = "SessionStarted",
  363. ShortOverview = string.Format(
  364. CultureInfo.InvariantCulture,
  365. _localization.GetLocalizedString("LabelIpAddressValue"),
  366. session.RemoteEndPoint),
  367. UserId = session.UserId
  368. });
  369. }
  370. private void OnPluginUpdated(object sender, GenericEventArgs<(IPlugin, PackageVersionInfo)> e)
  371. {
  372. CreateLogEntry(new ActivityLogEntry
  373. {
  374. Name = string.Format(
  375. CultureInfo.InvariantCulture,
  376. _localization.GetLocalizedString("PluginUpdatedWithName"),
  377. e.Argument.Item1.Name),
  378. Type = NotificationType.PluginUpdateInstalled.ToString(),
  379. ShortOverview = string.Format(
  380. CultureInfo.InvariantCulture,
  381. _localization.GetLocalizedString("VersionNumber"),
  382. e.Argument.Item2.versionStr),
  383. Overview = e.Argument.Item2.description
  384. });
  385. }
  386. private void OnPluginUninstalled(object sender, GenericEventArgs<IPlugin> e)
  387. {
  388. CreateLogEntry(new ActivityLogEntry
  389. {
  390. Name = string.Format(
  391. CultureInfo.InvariantCulture,
  392. _localization.GetLocalizedString("PluginUninstalledWithName"),
  393. e.Argument.Name),
  394. Type = NotificationType.PluginUninstalled.ToString()
  395. });
  396. }
  397. private void OnPluginInstalled(object sender, GenericEventArgs<PackageVersionInfo> e)
  398. {
  399. CreateLogEntry(new ActivityLogEntry
  400. {
  401. Name = string.Format(
  402. CultureInfo.InvariantCulture,
  403. _localization.GetLocalizedString("PluginInstalledWithName"),
  404. e.Argument.name),
  405. Type = NotificationType.PluginInstalled.ToString(),
  406. ShortOverview = string.Format(
  407. CultureInfo.InvariantCulture,
  408. _localization.GetLocalizedString("VersionNumber"),
  409. e.Argument.versionStr)
  410. });
  411. }
  412. private void OnPackageInstallationFailed(object sender, InstallationFailedEventArgs e)
  413. {
  414. var installationInfo = e.InstallationInfo;
  415. CreateLogEntry(new ActivityLogEntry
  416. {
  417. Name = string.Format(
  418. CultureInfo.InvariantCulture,
  419. _localization.GetLocalizedString("NameInstallFailed"),
  420. installationInfo.Name),
  421. Type = NotificationType.InstallationFailed.ToString(),
  422. ShortOverview = string.Format(
  423. CultureInfo.InvariantCulture,
  424. _localization.GetLocalizedString("VersionNumber"),
  425. installationInfo.Version),
  426. Overview = e.Exception.Message
  427. });
  428. }
  429. private void OnTaskCompleted(object sender, TaskCompletionEventArgs e)
  430. {
  431. var result = e.Result;
  432. var task = e.Task;
  433. var activityTask = task.ScheduledTask as IConfigurableScheduledTask;
  434. if (activityTask != null && !activityTask.IsLogged)
  435. {
  436. return;
  437. }
  438. var time = result.EndTimeUtc - result.StartTimeUtc;
  439. var runningTime = string.Format(
  440. CultureInfo.InvariantCulture,
  441. _localization.GetLocalizedString("LabelRunningTimeValue"),
  442. ToUserFriendlyString(time));
  443. if (result.Status == TaskCompletionStatus.Failed)
  444. {
  445. var vals = new List<string>();
  446. if (!string.IsNullOrEmpty(e.Result.ErrorMessage))
  447. {
  448. vals.Add(e.Result.ErrorMessage);
  449. }
  450. if (!string.IsNullOrEmpty(e.Result.LongErrorMessage))
  451. {
  452. vals.Add(e.Result.LongErrorMessage);
  453. }
  454. CreateLogEntry(new ActivityLogEntry
  455. {
  456. Name = string.Format(
  457. CultureInfo.InvariantCulture,
  458. _localization.GetLocalizedString("ScheduledTaskFailedWithName"),
  459. task.Name),
  460. Type = NotificationType.TaskFailed.ToString(),
  461. Overview = string.Join(Environment.NewLine, vals),
  462. ShortOverview = runningTime,
  463. Severity = LogLevel.Error
  464. });
  465. }
  466. }
  467. private void CreateLogEntry(ActivityLogEntry entry)
  468. => _activityManager.Create(entry);
  469. /// <inheritdoc />
  470. public void Dispose()
  471. {
  472. _taskManager.TaskCompleted -= OnTaskCompleted;
  473. _installationManager.PluginInstalled -= OnPluginInstalled;
  474. _installationManager.PluginUninstalled -= OnPluginUninstalled;
  475. _installationManager.PluginUpdated -= OnPluginUpdated;
  476. _installationManager.PackageInstallationFailed -= OnPackageInstallationFailed;
  477. _sessionManager.SessionStarted -= OnSessionStarted;
  478. _sessionManager.AuthenticationFailed -= OnAuthenticationFailed;
  479. _sessionManager.AuthenticationSucceeded -= OnAuthenticationSucceeded;
  480. _sessionManager.SessionEnded -= OnSessionEnded;
  481. _sessionManager.PlaybackStart -= OnPlaybackStart;
  482. _sessionManager.PlaybackStopped -= OnPlaybackStopped;
  483. _subManager.SubtitleDownloadFailure -= OnSubtitleDownloadFailure;
  484. _userManager.UserCreated -= OnUserCreated;
  485. _userManager.UserPasswordChanged -= OnUserPasswordChanged;
  486. _userManager.UserDeleted -= OnUserDeleted;
  487. _userManager.UserPolicyUpdated -= OnUserPolicyUpdated;
  488. _userManager.UserLockedOut -= OnUserLockedOut;
  489. _deviceManager.CameraImageUploaded -= OnCameraImageUploaded;
  490. }
  491. /// <summary>
  492. /// Constructs a user-friendly string for this TimeSpan instance.
  493. /// </summary>
  494. public static string ToUserFriendlyString(TimeSpan span)
  495. {
  496. const int DaysInYear = 365;
  497. const int DaysInMonth = 30;
  498. // Get each non-zero value from TimeSpan component
  499. var values = new List<string>();
  500. // Number of years
  501. int days = span.Days;
  502. if (days >= DaysInYear)
  503. {
  504. int years = days / DaysInYear;
  505. values.Add(CreateValueString(years, "year"));
  506. days = days % DaysInYear;
  507. }
  508. // Number of months
  509. if (days >= DaysInMonth)
  510. {
  511. int months = days / DaysInMonth;
  512. values.Add(CreateValueString(months, "month"));
  513. days = days % DaysInMonth;
  514. }
  515. // Number of days
  516. if (days >= 1)
  517. {
  518. values.Add(CreateValueString(days, "day"));
  519. }
  520. // Number of hours
  521. if (span.Hours >= 1)
  522. {
  523. values.Add(CreateValueString(span.Hours, "hour"));
  524. }
  525. // Number of minutes
  526. if (span.Minutes >= 1)
  527. {
  528. values.Add(CreateValueString(span.Minutes, "minute"));
  529. }
  530. // Number of seconds (include when 0 if no other components included)
  531. if (span.Seconds >= 1 || values.Count == 0)
  532. {
  533. values.Add(CreateValueString(span.Seconds, "second"));
  534. }
  535. // Combine values into string
  536. var builder = new StringBuilder();
  537. for (int i = 0; i < values.Count; i++)
  538. {
  539. if (builder.Length > 0)
  540. {
  541. builder.Append(i == values.Count - 1 ? " and " : ", ");
  542. }
  543. builder.Append(values[i]);
  544. }
  545. // Return result
  546. return builder.ToString();
  547. }
  548. /// <summary>
  549. /// Constructs a string description of a time-span value.
  550. /// </summary>
  551. /// <param name="value">The value of this item.</param>
  552. /// <param name="description">The name of this item (singular form).</param>
  553. private static string CreateValueString(int value, string description)
  554. {
  555. return string.Format(
  556. CultureInfo.InvariantCulture,
  557. "{0:#,##0} {1}",
  558. value,
  559. value == 1 ? description : string.Format(CultureInfo.InvariantCulture, "{0}s", description));
  560. }
  561. }
  562. }