SyncManager.cs 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337
  1. using MediaBrowser.Common.Configuration;
  2. using MediaBrowser.Common.Events;
  3. using MediaBrowser.Common.Extensions;
  4. using MediaBrowser.Common.ScheduledTasks;
  5. using MediaBrowser.Controller;
  6. using MediaBrowser.Controller.Drawing;
  7. using MediaBrowser.Controller.Dto;
  8. using MediaBrowser.Controller.Entities;
  9. using MediaBrowser.Controller.Entities.Audio;
  10. using MediaBrowser.Controller.Entities.TV;
  11. using MediaBrowser.Controller.Library;
  12. using MediaBrowser.Controller.MediaEncoding;
  13. using MediaBrowser.Controller.Playlists;
  14. using MediaBrowser.Controller.Sync;
  15. using MediaBrowser.Controller.TV;
  16. using MediaBrowser.Model.Dto;
  17. using MediaBrowser.Model.Entities;
  18. using MediaBrowser.Model.Events;
  19. using MediaBrowser.Model.Logging;
  20. using MediaBrowser.Model.Querying;
  21. using MediaBrowser.Model.Serialization;
  22. using MediaBrowser.Model.Sync;
  23. using MediaBrowser.Model.Users;
  24. using MoreLinq;
  25. using System;
  26. using System.Collections.Concurrent;
  27. using System.Collections.Generic;
  28. using System.IO;
  29. using System.Linq;
  30. using System.Threading;
  31. using System.Threading.Tasks;
  32. using CommonIO;
  33. namespace MediaBrowser.Server.Implementations.Sync
  34. {
  35. public class SyncManager : ISyncManager
  36. {
  37. private readonly ILibraryManager _libraryManager;
  38. private readonly ISyncRepository _repo;
  39. private readonly IImageProcessor _imageProcessor;
  40. private readonly ILogger _logger;
  41. private readonly IUserManager _userManager;
  42. private readonly Func<IDtoService> _dtoService;
  43. private readonly IServerApplicationHost _appHost;
  44. private readonly ITVSeriesManager _tvSeriesManager;
  45. private readonly Func<IMediaEncoder> _mediaEncoder;
  46. private readonly IFileSystem _fileSystem;
  47. private readonly Func<ISubtitleEncoder> _subtitleEncoder;
  48. private readonly IConfigurationManager _config;
  49. private readonly IUserDataManager _userDataManager;
  50. private readonly Func<IMediaSourceManager> _mediaSourceManager;
  51. private readonly IJsonSerializer _json;
  52. private readonly ITaskManager _taskManager;
  53. private ISyncProvider[] _providers = { };
  54. public event EventHandler<GenericEventArgs<SyncJobCreationResult>> SyncJobCreated;
  55. public event EventHandler<GenericEventArgs<SyncJob>> SyncJobCancelled;
  56. public event EventHandler<GenericEventArgs<SyncJob>> SyncJobUpdated;
  57. public event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemUpdated;
  58. public event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemCreated;
  59. public SyncManager(ILibraryManager libraryManager, ISyncRepository repo, IImageProcessor imageProcessor, ILogger logger, IUserManager userManager, Func<IDtoService> dtoService, IServerApplicationHost appHost, ITVSeriesManager tvSeriesManager, Func<IMediaEncoder> mediaEncoder, IFileSystem fileSystem, Func<ISubtitleEncoder> subtitleEncoder, IConfigurationManager config, IUserDataManager userDataManager, Func<IMediaSourceManager> mediaSourceManager, IJsonSerializer json, ITaskManager taskManager)
  60. {
  61. _libraryManager = libraryManager;
  62. _repo = repo;
  63. _imageProcessor = imageProcessor;
  64. _logger = logger;
  65. _userManager = userManager;
  66. _dtoService = dtoService;
  67. _appHost = appHost;
  68. _tvSeriesManager = tvSeriesManager;
  69. _mediaEncoder = mediaEncoder;
  70. _fileSystem = fileSystem;
  71. _subtitleEncoder = subtitleEncoder;
  72. _config = config;
  73. _userDataManager = userDataManager;
  74. _mediaSourceManager = mediaSourceManager;
  75. _json = json;
  76. _taskManager = taskManager;
  77. }
  78. public void AddParts(IEnumerable<ISyncProvider> providers)
  79. {
  80. _providers = providers.ToArray();
  81. }
  82. public IEnumerable<IServerSyncProvider> ServerSyncProviders
  83. {
  84. get { return _providers.OfType<IServerSyncProvider>(); }
  85. }
  86. private readonly ConcurrentDictionary<string, ISyncDataProvider> _dataProviders =
  87. new ConcurrentDictionary<string, ISyncDataProvider>(StringComparer.OrdinalIgnoreCase);
  88. public ISyncDataProvider GetDataProvider(IServerSyncProvider provider, SyncTarget target)
  89. {
  90. return _dataProviders.GetOrAdd(target.Id, key => new TargetDataProvider(provider, target, _appHost, _logger, _json, _fileSystem, _config.CommonApplicationPaths));
  91. }
  92. public async Task<SyncJobCreationResult> CreateJob(SyncJobRequest request)
  93. {
  94. var processor = GetSyncJobProcessor();
  95. var user = _userManager.GetUserById(request.UserId);
  96. var items = (await processor
  97. .GetItemsForSync(request.Category, request.ParentId, request.ItemIds, user, request.UnwatchedOnly).ConfigureAwait(false))
  98. .ToList();
  99. if (items.Any(i => !SupportsSync(i)))
  100. {
  101. throw new ArgumentException("Item does not support sync.");
  102. }
  103. if (string.IsNullOrWhiteSpace(request.Name))
  104. {
  105. if (request.ItemIds.Count == 1)
  106. {
  107. request.Name = GetDefaultName(_libraryManager.GetItemById(request.ItemIds[0]));
  108. }
  109. }
  110. if (string.IsNullOrWhiteSpace(request.Name))
  111. {
  112. request.Name = DateTime.Now.ToShortDateString() + " " + DateTime.Now.ToShortTimeString();
  113. }
  114. var target = GetSyncTargets(request.UserId)
  115. .FirstOrDefault(i => string.Equals(request.TargetId, i.Id));
  116. if (target == null)
  117. {
  118. throw new ArgumentException("Sync target not found.");
  119. }
  120. var jobId = Guid.NewGuid().ToString("N");
  121. if (string.IsNullOrWhiteSpace(request.Quality))
  122. {
  123. request.Quality = GetQualityOptions(request.TargetId)
  124. .Where(i => i.IsDefault)
  125. .Select(i => i.Id)
  126. .FirstOrDefault(i => !string.IsNullOrWhiteSpace(i));
  127. }
  128. var job = new SyncJob
  129. {
  130. Id = jobId,
  131. Name = request.Name,
  132. TargetId = target.Id,
  133. UserId = request.UserId,
  134. UnwatchedOnly = request.UnwatchedOnly,
  135. ItemLimit = request.ItemLimit,
  136. RequestedItemIds = request.ItemIds ?? new List<string> { },
  137. DateCreated = DateTime.UtcNow,
  138. DateLastModified = DateTime.UtcNow,
  139. SyncNewContent = request.SyncNewContent,
  140. ItemCount = items.Count,
  141. Category = request.Category,
  142. ParentId = request.ParentId,
  143. Quality = request.Quality,
  144. Profile = request.Profile,
  145. Bitrate = request.Bitrate
  146. };
  147. if (!request.Category.HasValue && request.ItemIds != null)
  148. {
  149. var requestedItems = request.ItemIds
  150. .Select(_libraryManager.GetItemById)
  151. .Where(i => i != null);
  152. // It's just a static list
  153. if (!requestedItems.Any(i => i.IsFolder || i is IItemByName))
  154. {
  155. job.SyncNewContent = false;
  156. }
  157. }
  158. await _repo.Create(job).ConfigureAwait(false);
  159. await processor.EnsureJobItems(job).ConfigureAwait(false);
  160. // If it already has a converting status then is must have been aborted during conversion
  161. var jobItemsResult = GetJobItems(new SyncJobItemQuery
  162. {
  163. Statuses = new[] { SyncJobItemStatus.Queued, SyncJobItemStatus.Converting },
  164. JobId = jobId,
  165. AddMetadata = false
  166. });
  167. await processor.SyncJobItems(jobItemsResult.Items, false, new Progress<double>(), CancellationToken.None)
  168. .ConfigureAwait(false);
  169. jobItemsResult = GetJobItems(new SyncJobItemQuery
  170. {
  171. Statuses = new[] { SyncJobItemStatus.Queued, SyncJobItemStatus.Converting },
  172. JobId = jobId,
  173. AddMetadata = false
  174. });
  175. var returnResult = new SyncJobCreationResult
  176. {
  177. Job = GetJob(jobId),
  178. JobItems = jobItemsResult.Items.ToList()
  179. };
  180. if (SyncJobCreated != null)
  181. {
  182. EventHelper.FireEventIfNotNull(SyncJobCreated, this, new GenericEventArgs<SyncJobCreationResult>
  183. {
  184. Argument = returnResult
  185. }, _logger);
  186. }
  187. if (returnResult.JobItems.Any(i => i.Status == SyncJobItemStatus.Queued || i.Status == SyncJobItemStatus.Converting))
  188. {
  189. _taskManager.QueueScheduledTask<SyncConvertScheduledTask>();
  190. }
  191. return returnResult;
  192. }
  193. public async Task UpdateJob(SyncJob job)
  194. {
  195. // Get fresh from the db and only update the fields that are supported to be changed.
  196. var instance = _repo.GetJob(job.Id);
  197. instance.Name = job.Name;
  198. instance.Quality = job.Quality;
  199. instance.Profile = job.Profile;
  200. instance.UnwatchedOnly = job.UnwatchedOnly;
  201. instance.SyncNewContent = job.SyncNewContent;
  202. instance.ItemLimit = job.ItemLimit;
  203. await _repo.Update(instance).ConfigureAwait(false);
  204. OnSyncJobUpdated(instance);
  205. }
  206. internal void OnSyncJobUpdated(SyncJob job)
  207. {
  208. if (SyncJobUpdated != null)
  209. {
  210. EventHelper.FireEventIfNotNull(SyncJobUpdated, this, new GenericEventArgs<SyncJob>
  211. {
  212. Argument = job
  213. }, _logger);
  214. }
  215. }
  216. internal async Task UpdateSyncJobItemInternal(SyncJobItem jobItem)
  217. {
  218. await _repo.Update(jobItem).ConfigureAwait(false);
  219. if (SyncJobUpdated != null)
  220. {
  221. EventHelper.FireEventIfNotNull(SyncJobItemUpdated, this, new GenericEventArgs<SyncJobItem>
  222. {
  223. Argument = jobItem
  224. }, _logger);
  225. }
  226. }
  227. internal void OnSyncJobItemCreated(SyncJobItem job)
  228. {
  229. if (SyncJobUpdated != null)
  230. {
  231. EventHelper.FireEventIfNotNull(SyncJobItemCreated, this, new GenericEventArgs<SyncJobItem>
  232. {
  233. Argument = job
  234. }, _logger);
  235. }
  236. }
  237. public async Task<QueryResult<SyncJob>> GetJobs(SyncJobQuery query)
  238. {
  239. var result = _repo.GetJobs(query);
  240. foreach (var item in result.Items)
  241. {
  242. await FillMetadata(item).ConfigureAwait(false);
  243. }
  244. return result;
  245. }
  246. private async Task FillMetadata(SyncJob job)
  247. {
  248. var user = _userManager.GetUserById(job.UserId);
  249. if (user == null)
  250. {
  251. return;
  252. }
  253. var target = GetSyncTargets(job.UserId)
  254. .FirstOrDefault(i => string.Equals(i.Id, job.TargetId, StringComparison.OrdinalIgnoreCase));
  255. if (target != null)
  256. {
  257. job.TargetName = target.Name;
  258. }
  259. var item = job.RequestedItemIds
  260. .Select(_libraryManager.GetItemById)
  261. .FirstOrDefault(i => i != null);
  262. if (item == null)
  263. {
  264. var processor = GetSyncJobProcessor();
  265. item = (await processor
  266. .GetItemsForSync(job.Category, job.ParentId, job.RequestedItemIds, user, job.UnwatchedOnly).ConfigureAwait(false))
  267. .FirstOrDefault();
  268. }
  269. if (item != null)
  270. {
  271. var hasSeries = item as IHasSeries;
  272. if (hasSeries != null)
  273. {
  274. job.ParentName = hasSeries.SeriesName;
  275. }
  276. var hasAlbumArtist = item as IHasAlbumArtist;
  277. if (hasAlbumArtist != null)
  278. {
  279. job.ParentName = hasAlbumArtist.AlbumArtists.FirstOrDefault();
  280. }
  281. var primaryImage = item.GetImageInfo(ImageType.Primary, 0);
  282. var itemWithImage = item;
  283. if (primaryImage == null)
  284. {
  285. var parentWithImage = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Primary));
  286. if (parentWithImage != null)
  287. {
  288. itemWithImage = parentWithImage;
  289. primaryImage = parentWithImage.GetImageInfo(ImageType.Primary, 0);
  290. }
  291. }
  292. if (primaryImage != null)
  293. {
  294. try
  295. {
  296. job.PrimaryImageTag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Primary);
  297. job.PrimaryImageItemId = itemWithImage.Id.ToString("N");
  298. }
  299. catch (Exception ex)
  300. {
  301. _logger.ErrorException("Error getting image info", ex);
  302. }
  303. }
  304. }
  305. }
  306. private void FillMetadata(SyncJobItem jobItem)
  307. {
  308. var item = _libraryManager.GetItemById(jobItem.ItemId);
  309. if (item == null)
  310. {
  311. return;
  312. }
  313. var primaryImage = item.GetImageInfo(ImageType.Primary, 0);
  314. var itemWithImage = item;
  315. if (primaryImage == null)
  316. {
  317. var parentWithImage = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Primary));
  318. if (parentWithImage != null)
  319. {
  320. itemWithImage = parentWithImage;
  321. primaryImage = parentWithImage.GetImageInfo(ImageType.Primary, 0);
  322. }
  323. }
  324. if (primaryImage != null)
  325. {
  326. try
  327. {
  328. jobItem.PrimaryImageTag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Primary);
  329. jobItem.PrimaryImageItemId = itemWithImage.Id.ToString("N");
  330. }
  331. catch (Exception ex)
  332. {
  333. _logger.ErrorException("Error getting image info", ex);
  334. }
  335. }
  336. }
  337. public async Task CancelJob(string id)
  338. {
  339. var job = GetJob(id);
  340. if (job == null)
  341. {
  342. throw new ArgumentException("Job not found.");
  343. }
  344. await _repo.DeleteJob(id).ConfigureAwait(false);
  345. var path = GetSyncJobProcessor().GetTemporaryPath(id);
  346. try
  347. {
  348. _fileSystem.DeleteDirectory(path, true);
  349. }
  350. catch (DirectoryNotFoundException)
  351. {
  352. }
  353. catch (Exception ex)
  354. {
  355. _logger.ErrorException("Error deleting directory {0}", ex, path);
  356. }
  357. if (SyncJobCancelled != null)
  358. {
  359. EventHelper.FireEventIfNotNull(SyncJobCancelled, this, new GenericEventArgs<SyncJob>
  360. {
  361. Argument = job
  362. }, _logger);
  363. }
  364. }
  365. public SyncJob GetJob(string id)
  366. {
  367. return _repo.GetJob(id);
  368. }
  369. public IEnumerable<SyncTarget> GetSyncTargets(string userId)
  370. {
  371. return _providers
  372. .SelectMany(i => GetSyncTargets(i, userId))
  373. .OrderBy(i => i.Name);
  374. }
  375. private IEnumerable<SyncTarget> GetSyncTargets(ISyncProvider provider)
  376. {
  377. return provider.GetAllSyncTargets().Select(i => new SyncTarget
  378. {
  379. Name = i.Name,
  380. Id = GetSyncTargetId(provider, i)
  381. });
  382. }
  383. private IEnumerable<SyncTarget> GetSyncTargets(ISyncProvider provider, string userId)
  384. {
  385. return provider.GetSyncTargets(userId).Select(i => new SyncTarget
  386. {
  387. Name = i.Name,
  388. Id = GetSyncTargetId(provider, i)
  389. });
  390. }
  391. private string GetSyncTargetId(ISyncProvider provider, SyncTarget target)
  392. {
  393. var hasUniqueId = provider as IHasUniqueTargetIds;
  394. if (hasUniqueId != null)
  395. {
  396. return target.Id;
  397. }
  398. return target.Id;
  399. //var providerId = GetSyncProviderId(provider);
  400. //return (providerId + "-" + target.Id).GetMD5().ToString("N");
  401. }
  402. private string GetSyncProviderId(ISyncProvider provider)
  403. {
  404. return provider.GetType().Name.GetMD5().ToString("N");
  405. }
  406. public bool SupportsSync(BaseItem item)
  407. {
  408. if (item == null)
  409. {
  410. throw new ArgumentNullException("item");
  411. }
  412. if (item is Playlist)
  413. {
  414. return true;
  415. }
  416. if (item is Person)
  417. {
  418. return false;
  419. }
  420. if (item is Year)
  421. {
  422. return false;
  423. }
  424. if (string.Equals(item.MediaType, MediaType.Video, StringComparison.OrdinalIgnoreCase) ||
  425. string.Equals(item.MediaType, MediaType.Audio, StringComparison.OrdinalIgnoreCase) ||
  426. string.Equals(item.MediaType, MediaType.Photo, StringComparison.OrdinalIgnoreCase) ||
  427. string.Equals(item.MediaType, MediaType.Game, StringComparison.OrdinalIgnoreCase) ||
  428. string.Equals(item.MediaType, MediaType.Book, StringComparison.OrdinalIgnoreCase))
  429. {
  430. if (item.LocationType == LocationType.Virtual)
  431. {
  432. return false;
  433. }
  434. var video = item as Video;
  435. if (video != null)
  436. {
  437. if (video.IsPlaceHolder)
  438. {
  439. return false;
  440. }
  441. if (video.IsShortcut)
  442. {
  443. return false;
  444. }
  445. }
  446. if (item.SourceType != SourceType.Library)
  447. {
  448. return false;
  449. }
  450. return true;
  451. }
  452. return item.LocationType == LocationType.FileSystem || item is Season;
  453. }
  454. private string GetDefaultName(BaseItem item)
  455. {
  456. return item.Name;
  457. }
  458. public async Task ReportSyncJobItemTransferred(string id)
  459. {
  460. var jobItem = _repo.GetJobItem(id);
  461. jobItem.Status = SyncJobItemStatus.Synced;
  462. jobItem.Progress = 100;
  463. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  464. var processor = GetSyncJobProcessor();
  465. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  466. if (!string.IsNullOrWhiteSpace(jobItem.TemporaryPath))
  467. {
  468. try
  469. {
  470. _fileSystem.DeleteDirectory(jobItem.TemporaryPath, true);
  471. }
  472. catch (DirectoryNotFoundException)
  473. {
  474. }
  475. catch (Exception ex)
  476. {
  477. _logger.ErrorException("Error deleting temporary job file: {0}", ex, jobItem.OutputPath);
  478. }
  479. }
  480. }
  481. private SyncJobProcessor GetSyncJobProcessor()
  482. {
  483. return new SyncJobProcessor(_libraryManager, _repo, this, _logger, _userManager, _tvSeriesManager, _mediaEncoder(), _subtitleEncoder(), _config, _fileSystem, _mediaSourceManager());
  484. }
  485. public SyncJobItem GetJobItem(string id)
  486. {
  487. return _repo.GetJobItem(id);
  488. }
  489. public QueryResult<SyncJobItem> GetJobItems(SyncJobItemQuery query)
  490. {
  491. var result = _repo.GetJobItems(query);
  492. if (query.AddMetadata)
  493. {
  494. result.Items.ForEach(FillMetadata);
  495. }
  496. return result;
  497. }
  498. private SyncedItem GetJobItemInfo(SyncJobItem jobItem)
  499. {
  500. var job = _repo.GetJob(jobItem.JobId);
  501. if (job == null)
  502. {
  503. _logger.Error("GetJobItemInfo job id {0} no longer exists", jobItem.JobId);
  504. return null;
  505. }
  506. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  507. if (libraryItem == null)
  508. {
  509. _logger.Error("GetJobItemInfo library item with id {0} no longer exists", jobItem.ItemId);
  510. return null;
  511. }
  512. var syncedItem = new SyncedItem
  513. {
  514. SyncJobId = jobItem.JobId,
  515. SyncJobItemId = jobItem.Id,
  516. ServerId = _appHost.SystemId,
  517. UserId = job.UserId,
  518. SyncJobName = job.Name,
  519. SyncJobDateCreated = job.DateCreated,
  520. AdditionalFiles = jobItem.AdditionalFiles.Select(i => new ItemFileInfo
  521. {
  522. ImageType = i.ImageType,
  523. Name = i.Name,
  524. Type = i.Type,
  525. Index = i.Index
  526. }).ToList()
  527. };
  528. var dtoOptions = new DtoOptions();
  529. // Remove some bloat
  530. dtoOptions.Fields.Remove(ItemFields.MediaStreams);
  531. dtoOptions.Fields.Remove(ItemFields.IndexOptions);
  532. dtoOptions.Fields.Remove(ItemFields.MediaSourceCount);
  533. dtoOptions.Fields.Remove(ItemFields.Path);
  534. dtoOptions.Fields.Remove(ItemFields.SeriesGenres);
  535. dtoOptions.Fields.Remove(ItemFields.Settings);
  536. dtoOptions.Fields.Remove(ItemFields.SyncInfo);
  537. syncedItem.Item = _dtoService().GetBaseItemDto(libraryItem, dtoOptions);
  538. var mediaSource = jobItem.MediaSource;
  539. syncedItem.Item.MediaSources = new List<MediaSourceInfo>();
  540. syncedItem.OriginalFileName = Path.GetFileName(libraryItem.Path);
  541. if (string.IsNullOrWhiteSpace(syncedItem.OriginalFileName))
  542. {
  543. syncedItem.OriginalFileName = Path.GetFileName(mediaSource.Path);
  544. }
  545. // This will be null for items that are not audio/video
  546. if (mediaSource != null)
  547. {
  548. syncedItem.OriginalFileName = Path.ChangeExtension(syncedItem.OriginalFileName, Path.GetExtension(mediaSource.Path));
  549. syncedItem.Item.MediaSources.Add(mediaSource);
  550. }
  551. if (string.IsNullOrWhiteSpace(syncedItem.OriginalFileName))
  552. {
  553. syncedItem.OriginalFileName = libraryItem.Name;
  554. }
  555. return syncedItem;
  556. }
  557. public Task ReportOfflineAction(UserAction action)
  558. {
  559. switch (action.Type)
  560. {
  561. case UserActionType.PlayedItem:
  562. return ReportOfflinePlayedItem(action);
  563. default:
  564. throw new ArgumentException("Unexpected action type");
  565. }
  566. }
  567. private Task ReportOfflinePlayedItem(UserAction action)
  568. {
  569. var item = _libraryManager.GetItemById(action.ItemId);
  570. var userData = _userDataManager.GetUserData(new Guid(action.UserId), item.GetUserDataKey());
  571. userData.LastPlayedDate = action.Date;
  572. _userDataManager.UpdatePlayState(item, userData, action.PositionTicks);
  573. return _userDataManager.SaveUserData(new Guid(action.UserId), item, userData, UserDataSaveReason.Import, CancellationToken.None);
  574. }
  575. public async Task<List<SyncedItem>> GetReadySyncItems(string targetId)
  576. {
  577. var processor = GetSyncJobProcessor();
  578. await processor.SyncJobItems(targetId, false, new Progress<double>(), CancellationToken.None).ConfigureAwait(false);
  579. var jobItemResult = GetJobItems(new SyncJobItemQuery
  580. {
  581. TargetId = targetId,
  582. Statuses = new[]
  583. {
  584. SyncJobItemStatus.ReadyToTransfer,
  585. SyncJobItemStatus.Transferring
  586. }
  587. });
  588. var readyItems = jobItemResult.Items
  589. .Select(GetJobItemInfo)
  590. .Where(i => i != null)
  591. .ToList();
  592. _logger.Debug("Returning {0} ready sync items for targetId {1}", readyItems.Count, targetId);
  593. return readyItems;
  594. }
  595. public async Task<SyncDataResponse> SyncData(SyncDataRequest request)
  596. {
  597. if (request.SyncJobItemIds != null)
  598. {
  599. return await SyncDataUsingSyncJobItemIds(request).ConfigureAwait(false);
  600. }
  601. var jobItemResult = GetJobItems(new SyncJobItemQuery
  602. {
  603. TargetId = request.TargetId,
  604. Statuses = new[] { SyncJobItemStatus.Synced }
  605. });
  606. var response = new SyncDataResponse();
  607. foreach (var jobItem in jobItemResult.Items)
  608. {
  609. var requiresSaving = false;
  610. var removeFromDevice = false;
  611. if (request.LocalItemIds.Contains(jobItem.ItemId, StringComparer.OrdinalIgnoreCase))
  612. {
  613. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  614. var job = _repo.GetJob(jobItem.JobId);
  615. var user = _userManager.GetUserById(job.UserId);
  616. if (jobItem.IsMarkedForRemoval)
  617. {
  618. // Tell the device to remove it since it has been marked for removal
  619. _logger.Info("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.ItemId);
  620. removeFromDevice = true;
  621. }
  622. else if (user == null)
  623. {
  624. // Tell the device to remove it since the user is gone now
  625. _logger.Info("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.ItemId);
  626. removeFromDevice = true;
  627. }
  628. else if (!IsLibraryItemAvailable(libraryItem))
  629. {
  630. // Tell the device to remove it since it's no longer available
  631. _logger.Info("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.ItemId);
  632. removeFromDevice = true;
  633. }
  634. else if (job.UnwatchedOnly)
  635. {
  636. if (libraryItem is Video && libraryItem.IsPlayed(user))
  637. {
  638. // Tell the device to remove it since it has been played
  639. _logger.Info("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.ItemId);
  640. removeFromDevice = true;
  641. }
  642. }
  643. }
  644. else
  645. {
  646. // Content is no longer on the device
  647. if (jobItem.IsMarkedForRemoval)
  648. {
  649. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  650. }
  651. else
  652. {
  653. _logger.Info("Setting status to Queued for {0} because it is no longer on the device.", jobItem.ItemId);
  654. jobItem.Status = SyncJobItemStatus.Queued;
  655. jobItem.Progress = 0;
  656. }
  657. requiresSaving = true;
  658. }
  659. if (removeFromDevice)
  660. {
  661. response.ItemIdsToRemove.Add(jobItem.ItemId);
  662. jobItem.IsMarkedForRemoval = true;
  663. requiresSaving = true;
  664. }
  665. if (requiresSaving)
  666. {
  667. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  668. }
  669. }
  670. // Now check each item that's on the device
  671. foreach (var itemId in request.LocalItemIds)
  672. {
  673. // See if it's already marked for removal
  674. if (response.ItemIdsToRemove.Contains(itemId, StringComparer.OrdinalIgnoreCase))
  675. {
  676. continue;
  677. }
  678. // If there isn't a sync job for this item, mark it for removal
  679. if (!jobItemResult.Items.Any(i => string.Equals(itemId, i.ItemId, StringComparison.OrdinalIgnoreCase)))
  680. {
  681. response.ItemIdsToRemove.Add(itemId);
  682. }
  683. }
  684. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  685. var itemsOnDevice = request.LocalItemIds
  686. .Except(response.ItemIdsToRemove)
  687. .ToList();
  688. SetUserAccess(request, response, itemsOnDevice);
  689. return response;
  690. }
  691. private async Task<SyncDataResponse> SyncDataUsingSyncJobItemIds(SyncDataRequest request)
  692. {
  693. var jobItemResult = GetJobItems(new SyncJobItemQuery
  694. {
  695. TargetId = request.TargetId,
  696. Statuses = new[] { SyncJobItemStatus.Synced }
  697. });
  698. var response = new SyncDataResponse();
  699. foreach (var jobItem in jobItemResult.Items)
  700. {
  701. var requiresSaving = false;
  702. var removeFromDevice = false;
  703. if (request.SyncJobItemIds.Contains(jobItem.Id, StringComparer.OrdinalIgnoreCase))
  704. {
  705. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  706. var job = _repo.GetJob(jobItem.JobId);
  707. var user = _userManager.GetUserById(job.UserId);
  708. if (jobItem.IsMarkedForRemoval)
  709. {
  710. // Tell the device to remove it since it has been marked for removal
  711. _logger.Info("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.Id);
  712. removeFromDevice = true;
  713. }
  714. else if (user == null)
  715. {
  716. // Tell the device to remove it since the user is gone now
  717. _logger.Info("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.Id);
  718. removeFromDevice = true;
  719. }
  720. else if (!IsLibraryItemAvailable(libraryItem))
  721. {
  722. // Tell the device to remove it since it's no longer available
  723. _logger.Info("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.Id);
  724. removeFromDevice = true;
  725. }
  726. else if (job.UnwatchedOnly)
  727. {
  728. if (libraryItem is Video && libraryItem.IsPlayed(user))
  729. {
  730. // Tell the device to remove it since it has been played
  731. _logger.Info("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.Id);
  732. removeFromDevice = true;
  733. }
  734. }
  735. }
  736. else
  737. {
  738. // Content is no longer on the device
  739. if (jobItem.IsMarkedForRemoval)
  740. {
  741. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  742. }
  743. else
  744. {
  745. _logger.Info("Setting status to Queued for {0} because it is no longer on the device.", jobItem.Id);
  746. jobItem.Status = SyncJobItemStatus.Queued;
  747. jobItem.Progress = 0;
  748. }
  749. requiresSaving = true;
  750. }
  751. if (removeFromDevice)
  752. {
  753. response.ItemIdsToRemove.Add(jobItem.Id);
  754. jobItem.IsMarkedForRemoval = true;
  755. requiresSaving = true;
  756. }
  757. if (requiresSaving)
  758. {
  759. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  760. }
  761. }
  762. // Now check each item that's on the device
  763. foreach (var syncJobItemId in request.SyncJobItemIds)
  764. {
  765. // See if it's already marked for removal
  766. if (response.ItemIdsToRemove.Contains(syncJobItemId, StringComparer.OrdinalIgnoreCase))
  767. {
  768. continue;
  769. }
  770. // If there isn't a sync job for this item, mark it for removal
  771. if (!jobItemResult.Items.Any(i => string.Equals(syncJobItemId, i.Id, StringComparison.OrdinalIgnoreCase)))
  772. {
  773. response.ItemIdsToRemove.Add(syncJobItemId);
  774. }
  775. }
  776. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  777. return response;
  778. }
  779. private void SetUserAccess(SyncDataRequest request, SyncDataResponse response, List<string> itemIds)
  780. {
  781. var users = request.OfflineUserIds
  782. .Select(_userManager.GetUserById)
  783. .Where(i => i != null)
  784. .ToList();
  785. foreach (var itemId in itemIds)
  786. {
  787. var item = _libraryManager.GetItemById(itemId);
  788. if (item != null)
  789. {
  790. response.ItemUserAccess[itemId] = users
  791. .Where(i => IsUserVisible(item, i))
  792. .Select(i => i.Id.ToString("N"))
  793. .OrderBy(i => i)
  794. .ToList();
  795. }
  796. }
  797. }
  798. private bool IsUserVisible(BaseItem item, User user)
  799. {
  800. return item.IsVisibleStandalone(user);
  801. }
  802. private bool IsLibraryItemAvailable(BaseItem item)
  803. {
  804. if (item == null)
  805. {
  806. return false;
  807. }
  808. return true;
  809. }
  810. public async Task ReEnableJobItem(string id)
  811. {
  812. var jobItem = _repo.GetJobItem(id);
  813. if (jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Cancelled)
  814. {
  815. throw new ArgumentException("Operation is not valid for this job item");
  816. }
  817. jobItem.Status = SyncJobItemStatus.Queued;
  818. jobItem.Progress = 0;
  819. jobItem.IsMarkedForRemoval = false;
  820. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  821. var processor = GetSyncJobProcessor();
  822. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  823. }
  824. public async Task CancelItems(string targetId, IEnumerable<string> itemIds)
  825. {
  826. foreach (var item in itemIds)
  827. {
  828. var syncJobItemResult = GetJobItems(new SyncJobItemQuery
  829. {
  830. AddMetadata = false,
  831. ItemId = item,
  832. TargetId = targetId,
  833. Statuses = new[] { SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Converting, SyncJobItemStatus.Synced, SyncJobItemStatus.Failed }
  834. });
  835. foreach (var jobItem in syncJobItemResult.Items)
  836. {
  837. await CancelJobItem(jobItem.Id).ConfigureAwait(false);
  838. }
  839. }
  840. }
  841. public async Task CancelJobItem(string id)
  842. {
  843. var jobItem = _repo.GetJobItem(id);
  844. if (jobItem.Status != SyncJobItemStatus.Queued && jobItem.Status != SyncJobItemStatus.ReadyToTransfer && jobItem.Status != SyncJobItemStatus.Converting && jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Synced && jobItem.Status != SyncJobItemStatus.Transferring)
  845. {
  846. throw new ArgumentException("Operation is not valid for this job item");
  847. }
  848. if (jobItem.Status != SyncJobItemStatus.Synced)
  849. {
  850. jobItem.Status = SyncJobItemStatus.Cancelled;
  851. }
  852. jobItem.Progress = 0;
  853. jobItem.IsMarkedForRemoval = true;
  854. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  855. var processor = GetSyncJobProcessor();
  856. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  857. var path = processor.GetTemporaryPath(jobItem);
  858. try
  859. {
  860. _fileSystem.DeleteDirectory(path, true);
  861. }
  862. catch (DirectoryNotFoundException)
  863. {
  864. }
  865. catch (Exception ex)
  866. {
  867. _logger.ErrorException("Error deleting directory {0}", ex, path);
  868. }
  869. //var jobItemsResult = GetJobItems(new SyncJobItemQuery
  870. //{
  871. // AddMetadata = false,
  872. // JobId = jobItem.JobId,
  873. // Limit = 0,
  874. // Statuses = new[] { SyncJobItemStatus.Converting, SyncJobItemStatus.Failed, SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Synced, SyncJobItemStatus.Transferring }
  875. //});
  876. //if (jobItemsResult.TotalRecordCount == 0)
  877. //{
  878. // await CancelJob(jobItem.JobId).ConfigureAwait(false);
  879. //}
  880. }
  881. public Task MarkJobItemForRemoval(string id)
  882. {
  883. return CancelJobItem(id);
  884. }
  885. public async Task UnmarkJobItemForRemoval(string id)
  886. {
  887. var jobItem = _repo.GetJobItem(id);
  888. if (jobItem.Status != SyncJobItemStatus.Synced)
  889. {
  890. throw new ArgumentException("Operation is not valid for this job item");
  891. }
  892. jobItem.IsMarkedForRemoval = false;
  893. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  894. var processor = GetSyncJobProcessor();
  895. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  896. }
  897. public async Task ReportSyncJobItemTransferBeginning(string id)
  898. {
  899. var jobItem = _repo.GetJobItem(id);
  900. jobItem.Status = SyncJobItemStatus.Transferring;
  901. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  902. var processor = GetSyncJobProcessor();
  903. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  904. }
  905. public async Task ReportSyncJobItemTransferFailed(string id)
  906. {
  907. var jobItem = _repo.GetJobItem(id);
  908. jobItem.Status = SyncJobItemStatus.ReadyToTransfer;
  909. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  910. var processor = GetSyncJobProcessor();
  911. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  912. }
  913. public QueryResult<SyncedItemProgress> GetSyncedItemProgresses(SyncJobItemQuery query)
  914. {
  915. return _repo.GetSyncedItemProgresses(query);
  916. }
  917. public SyncJobOptions GetAudioOptions(SyncJobItem jobItem, SyncJob job)
  918. {
  919. var options = GetSyncJobOptions(jobItem.TargetId, null, null);
  920. if (job.Bitrate.HasValue)
  921. {
  922. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  923. }
  924. return options;
  925. }
  926. public ISyncProvider GetSyncProvider(SyncJobItem jobItem)
  927. {
  928. foreach (var provider in _providers)
  929. {
  930. foreach (var target in GetSyncTargets(provider))
  931. {
  932. if (string.Equals(target.Id, jobItem.TargetId, StringComparison.OrdinalIgnoreCase))
  933. {
  934. return provider;
  935. }
  936. }
  937. }
  938. return null;
  939. }
  940. public SyncJobOptions GetVideoOptions(SyncJobItem jobItem, SyncJob job)
  941. {
  942. var options = GetSyncJobOptions(jobItem.TargetId, job.Profile, job.Quality);
  943. if (job.Bitrate.HasValue)
  944. {
  945. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  946. }
  947. return options;
  948. }
  949. private SyncJobOptions GetSyncJobOptions(string targetId, string profile, string quality)
  950. {
  951. foreach (var provider in _providers)
  952. {
  953. foreach (var target in GetSyncTargets(provider))
  954. {
  955. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  956. {
  957. return GetSyncJobOptions(provider, target, profile, quality);
  958. }
  959. }
  960. }
  961. return GetDefaultSyncJobOptions(profile, quality);
  962. }
  963. private SyncJobOptions GetSyncJobOptions(ISyncProvider provider, SyncTarget target, string profile, string quality)
  964. {
  965. var hasProfile = provider as IHasSyncQuality;
  966. if (hasProfile != null)
  967. {
  968. return hasProfile.GetSyncJobOptions(target, profile, quality);
  969. }
  970. return GetDefaultSyncJobOptions(profile, quality);
  971. }
  972. private SyncJobOptions GetDefaultSyncJobOptions(string profile, string quality)
  973. {
  974. var supportsAc3 = string.Equals(profile, "general", StringComparison.OrdinalIgnoreCase);
  975. var deviceProfile = new CloudSyncProfile(supportsAc3, false);
  976. deviceProfile.MaxStaticBitrate = SyncHelper.AdjustBitrate(deviceProfile.MaxStaticBitrate, quality);
  977. return new SyncJobOptions
  978. {
  979. DeviceProfile = deviceProfile,
  980. IsConverting = IsConverting(profile, quality)
  981. };
  982. }
  983. private bool IsConverting(string profile, string quality)
  984. {
  985. return !string.Equals(profile, "original", StringComparison.OrdinalIgnoreCase);
  986. }
  987. public IEnumerable<SyncQualityOption> GetQualityOptions(string targetId)
  988. {
  989. return GetQualityOptions(targetId, null);
  990. }
  991. public IEnumerable<SyncQualityOption> GetQualityOptions(string targetId, User user)
  992. {
  993. foreach (var provider in _providers)
  994. {
  995. foreach (var target in GetSyncTargets(provider))
  996. {
  997. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  998. {
  999. return GetQualityOptions(provider, target, user);
  1000. }
  1001. }
  1002. }
  1003. return new List<SyncQualityOption>();
  1004. }
  1005. private IEnumerable<SyncQualityOption> GetQualityOptions(ISyncProvider provider, SyncTarget target, User user)
  1006. {
  1007. var hasQuality = provider as IHasSyncQuality;
  1008. if (hasQuality != null)
  1009. {
  1010. var options = hasQuality.GetQualityOptions(target);
  1011. if (user != null && !user.Policy.EnableSyncTranscoding)
  1012. {
  1013. options = options.Where(i => i.IsOriginalQuality);
  1014. }
  1015. return options;
  1016. }
  1017. // Default options for providers that don't override
  1018. return new List<SyncQualityOption>
  1019. {
  1020. new SyncQualityOption
  1021. {
  1022. Name = "High",
  1023. Id = "high",
  1024. IsDefault = true
  1025. },
  1026. new SyncQualityOption
  1027. {
  1028. Name = "Medium",
  1029. Id = "medium"
  1030. },
  1031. new SyncQualityOption
  1032. {
  1033. Name = "Low",
  1034. Id = "low"
  1035. },
  1036. new SyncQualityOption
  1037. {
  1038. Name = "Custom",
  1039. Id = "custom"
  1040. }
  1041. };
  1042. }
  1043. public IEnumerable<SyncProfileOption> GetProfileOptions(string targetId, User user)
  1044. {
  1045. foreach (var provider in _providers)
  1046. {
  1047. foreach (var target in GetSyncTargets(provider))
  1048. {
  1049. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  1050. {
  1051. return GetProfileOptions(provider, target, user);
  1052. }
  1053. }
  1054. }
  1055. return new List<SyncProfileOption>();
  1056. }
  1057. public IEnumerable<SyncProfileOption> GetProfileOptions(string targetId)
  1058. {
  1059. return GetProfileOptions(targetId, null);
  1060. }
  1061. private IEnumerable<SyncProfileOption> GetProfileOptions(ISyncProvider provider, SyncTarget target, User user)
  1062. {
  1063. var hasQuality = provider as IHasSyncQuality;
  1064. if (hasQuality != null)
  1065. {
  1066. return hasQuality.GetProfileOptions(target);
  1067. }
  1068. var list = new List<SyncProfileOption>();
  1069. list.Add(new SyncProfileOption
  1070. {
  1071. Name = "Original",
  1072. Id = "Original",
  1073. Description = "Syncs original files as-is.",
  1074. EnableQualityOptions = false
  1075. });
  1076. if (user == null || user.Policy.EnableSyncTranscoding)
  1077. {
  1078. list.Add(new SyncProfileOption
  1079. {
  1080. Name = "Baseline",
  1081. Id = "baseline",
  1082. Description = "Designed for compatibility with all devices, including web browsers. Targets H264/AAC video and MP3 audio."
  1083. });
  1084. list.Add(new SyncProfileOption
  1085. {
  1086. Name = "General",
  1087. Id = "general",
  1088. Description = "Designed for compatibility with Chromecast, Roku, Smart TV's, and other similar devices. Targets H264/AAC/AC3 video and MP3 audio.",
  1089. IsDefault = true
  1090. });
  1091. }
  1092. return list;
  1093. }
  1094. protected internal void OnConversionComplete(SyncJobItem item)
  1095. {
  1096. var syncProvider = GetSyncProvider(item);
  1097. if (syncProvider is AppSyncProvider)
  1098. {
  1099. return;
  1100. }
  1101. _taskManager.QueueIfNotRunning<ServerSyncScheduledTask>();
  1102. }
  1103. }
  1104. }