SyncManager.cs 39 KB

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