SyncManager.cs 42 KB

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