SyncManager.cs 46 KB

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