LibraryManager.cs 112 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228
  1. #pragma warning disable CS1591
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Globalization;
  5. using System.IO;
  6. using System.Linq;
  7. using System.Net;
  8. using System.Net.Http;
  9. using System.Threading;
  10. using System.Threading.Tasks;
  11. using Emby.Naming.Audio;
  12. using Emby.Naming.Common;
  13. using Emby.Naming.TV;
  14. using Emby.Naming.Video;
  15. using Emby.Server.Implementations.Library.Resolvers;
  16. using Emby.Server.Implementations.Library.Validators;
  17. using Emby.Server.Implementations.Playlists;
  18. using Emby.Server.Implementations.ScheduledTasks;
  19. using Jellyfin.Data.Entities;
  20. using Jellyfin.Data.Enums;
  21. using MediaBrowser.Common.Extensions;
  22. using MediaBrowser.Common.Progress;
  23. using MediaBrowser.Controller;
  24. using MediaBrowser.Controller.Configuration;
  25. using MediaBrowser.Controller.Drawing;
  26. using MediaBrowser.Controller.Dto;
  27. using MediaBrowser.Controller.Entities;
  28. using MediaBrowser.Controller.Entities.Audio;
  29. using MediaBrowser.Controller.IO;
  30. using MediaBrowser.Controller.Library;
  31. using MediaBrowser.Controller.LiveTv;
  32. using MediaBrowser.Controller.MediaEncoding;
  33. using MediaBrowser.Controller.Persistence;
  34. using MediaBrowser.Controller.Providers;
  35. using MediaBrowser.Controller.Resolvers;
  36. using MediaBrowser.Controller.Sorting;
  37. using MediaBrowser.Model.Configuration;
  38. using MediaBrowser.Model.Dlna;
  39. using MediaBrowser.Model.Drawing;
  40. using MediaBrowser.Model.Dto;
  41. using MediaBrowser.Model.Entities;
  42. using MediaBrowser.Model.IO;
  43. using MediaBrowser.Model.Library;
  44. using MediaBrowser.Model.Querying;
  45. using MediaBrowser.Model.Tasks;
  46. using MediaBrowser.Providers.MediaInfo;
  47. using Microsoft.Extensions.Caching.Memory;
  48. using Microsoft.Extensions.Logging;
  49. using Episode = MediaBrowser.Controller.Entities.TV.Episode;
  50. using EpisodeInfo = Emby.Naming.TV.EpisodeInfo;
  51. using Genre = MediaBrowser.Controller.Entities.Genre;
  52. using Person = MediaBrowser.Controller.Entities.Person;
  53. using VideoResolver = Emby.Naming.Video.VideoResolver;
  54. namespace Emby.Server.Implementations.Library
  55. {
  56. /// <summary>
  57. /// Class LibraryManager.
  58. /// </summary>
  59. public class LibraryManager : ILibraryManager
  60. {
  61. private const string ShortcutFileExtension = ".mblink";
  62. private readonly ILogger<LibraryManager> _logger;
  63. private readonly IMemoryCache _memoryCache;
  64. private readonly ITaskManager _taskManager;
  65. private readonly IUserManager _userManager;
  66. private readonly IUserDataManager _userDataRepository;
  67. private readonly IServerConfigurationManager _configurationManager;
  68. private readonly Lazy<ILibraryMonitor> _libraryMonitorFactory;
  69. private readonly Lazy<IProviderManager> _providerManagerFactory;
  70. private readonly Lazy<IUserViewManager> _userviewManagerFactory;
  71. private readonly IServerApplicationHost _appHost;
  72. private readonly IMediaEncoder _mediaEncoder;
  73. private readonly IFileSystem _fileSystem;
  74. private readonly IItemRepository _itemRepository;
  75. private readonly IImageProcessor _imageProcessor;
  76. /// <summary>
  77. /// The _root folder sync lock.
  78. /// </summary>
  79. private readonly object _rootFolderSyncLock = new object();
  80. private readonly object _userRootFolderSyncLock = new object();
  81. private readonly TimeSpan _viewRefreshInterval = TimeSpan.FromHours(24);
  82. private NamingOptions _namingOptions;
  83. private string[] _videoFileExtensions;
  84. /// <summary>
  85. /// The _root folder.
  86. /// </summary>
  87. private volatile AggregateFolder _rootFolder;
  88. private volatile UserRootFolder _userRootFolder;
  89. private bool _wizardCompleted;
  90. /// <summary>
  91. /// Initializes a new instance of the <see cref="LibraryManager" /> class.
  92. /// </summary>
  93. /// <param name="appHost">The application host.</param>
  94. /// <param name="logger">The logger.</param>
  95. /// <param name="taskManager">The task manager.</param>
  96. /// <param name="userManager">The user manager.</param>
  97. /// <param name="configurationManager">The configuration manager.</param>
  98. /// <param name="userDataRepository">The user data repository.</param>
  99. /// <param name="libraryMonitorFactory">The library monitor.</param>
  100. /// <param name="fileSystem">The file system.</param>
  101. /// <param name="providerManagerFactory">The provider manager.</param>
  102. /// <param name="userviewManagerFactory">The userview manager.</param>
  103. /// <param name="mediaEncoder">The media encoder.</param>
  104. /// <param name="itemRepository">The item repository.</param>
  105. /// <param name="imageProcessor">The image processor.</param>
  106. /// <param name="memoryCache">The memory cache.</param>
  107. public LibraryManager(
  108. IServerApplicationHost appHost,
  109. ILogger<LibraryManager> logger,
  110. ITaskManager taskManager,
  111. IUserManager userManager,
  112. IServerConfigurationManager configurationManager,
  113. IUserDataManager userDataRepository,
  114. Lazy<ILibraryMonitor> libraryMonitorFactory,
  115. IFileSystem fileSystem,
  116. Lazy<IProviderManager> providerManagerFactory,
  117. Lazy<IUserViewManager> userviewManagerFactory,
  118. IMediaEncoder mediaEncoder,
  119. IItemRepository itemRepository,
  120. IImageProcessor imageProcessor,
  121. IMemoryCache memoryCache)
  122. {
  123. _appHost = appHost;
  124. _logger = logger;
  125. _taskManager = taskManager;
  126. _userManager = userManager;
  127. _configurationManager = configurationManager;
  128. _userDataRepository = userDataRepository;
  129. _libraryMonitorFactory = libraryMonitorFactory;
  130. _fileSystem = fileSystem;
  131. _providerManagerFactory = providerManagerFactory;
  132. _userviewManagerFactory = userviewManagerFactory;
  133. _mediaEncoder = mediaEncoder;
  134. _itemRepository = itemRepository;
  135. _imageProcessor = imageProcessor;
  136. _memoryCache = memoryCache;
  137. _configurationManager.ConfigurationUpdated += ConfigurationUpdated;
  138. RecordConfigurationValues(configurationManager.Configuration);
  139. }
  140. /// <summary>
  141. /// Occurs when [item added].
  142. /// </summary>
  143. public event EventHandler<ItemChangeEventArgs> ItemAdded;
  144. /// <summary>
  145. /// Occurs when [item updated].
  146. /// </summary>
  147. public event EventHandler<ItemChangeEventArgs> ItemUpdated;
  148. /// <summary>
  149. /// Occurs when [item removed].
  150. /// </summary>
  151. public event EventHandler<ItemChangeEventArgs> ItemRemoved;
  152. /// <summary>
  153. /// Gets the root folder.
  154. /// </summary>
  155. /// <value>The root folder.</value>
  156. public AggregateFolder RootFolder
  157. {
  158. get
  159. {
  160. if (_rootFolder == null)
  161. {
  162. lock (_rootFolderSyncLock)
  163. {
  164. if (_rootFolder == null)
  165. {
  166. _rootFolder = CreateRootFolder();
  167. }
  168. }
  169. }
  170. return _rootFolder;
  171. }
  172. }
  173. private ILibraryMonitor LibraryMonitor => _libraryMonitorFactory.Value;
  174. private IProviderManager ProviderManager => _providerManagerFactory.Value;
  175. private IUserViewManager UserViewManager => _userviewManagerFactory.Value;
  176. /// <summary>
  177. /// Gets or sets the postscan tasks.
  178. /// </summary>
  179. /// <value>The postscan tasks.</value>
  180. private ILibraryPostScanTask[] PostscanTasks { get; set; }
  181. /// <summary>
  182. /// Gets or sets the intro providers.
  183. /// </summary>
  184. /// <value>The intro providers.</value>
  185. private IIntroProvider[] IntroProviders { get; set; }
  186. /// <summary>
  187. /// Gets or sets the list of entity resolution ignore rules.
  188. /// </summary>
  189. /// <value>The entity resolution ignore rules.</value>
  190. private IResolverIgnoreRule[] EntityResolutionIgnoreRules { get; set; } = Array.Empty<IResolverIgnoreRule>();
  191. /// <summary>
  192. /// Gets or sets the list of currently registered entity resolvers.
  193. /// </summary>
  194. /// <value>The entity resolvers enumerable.</value>
  195. private IItemResolver[] EntityResolvers { get; set; }
  196. private IMultiItemResolver[] MultiItemResolvers { get; set; }
  197. /// <summary>
  198. /// Gets or sets the comparers.
  199. /// </summary>
  200. /// <value>The comparers.</value>
  201. private IBaseItemComparer[] Comparers { get; set; }
  202. public bool IsScanRunning { get; private set; }
  203. /// <summary>
  204. /// Adds the parts.
  205. /// </summary>
  206. /// <param name="rules">The rules.</param>
  207. /// <param name="resolvers">The resolvers.</param>
  208. /// <param name="introProviders">The intro providers.</param>
  209. /// <param name="itemComparers">The item comparers.</param>
  210. /// <param name="postscanTasks">The post scan tasks.</param>
  211. public void AddParts(
  212. IEnumerable<IResolverIgnoreRule> rules,
  213. IEnumerable<IItemResolver> resolvers,
  214. IEnumerable<IIntroProvider> introProviders,
  215. IEnumerable<IBaseItemComparer> itemComparers,
  216. IEnumerable<ILibraryPostScanTask> postscanTasks)
  217. {
  218. EntityResolutionIgnoreRules = rules.ToArray();
  219. EntityResolvers = resolvers.OrderBy(i => i.Priority).ToArray();
  220. MultiItemResolvers = EntityResolvers.OfType<IMultiItemResolver>().ToArray();
  221. IntroProviders = introProviders.ToArray();
  222. Comparers = itemComparers.ToArray();
  223. PostscanTasks = postscanTasks.ToArray();
  224. }
  225. /// <summary>
  226. /// Records the configuration values.
  227. /// </summary>
  228. /// <param name="configuration">The configuration.</param>
  229. private void RecordConfigurationValues(ServerConfiguration configuration)
  230. {
  231. _wizardCompleted = configuration.IsStartupWizardCompleted;
  232. }
  233. /// <summary>
  234. /// Configurations the updated.
  235. /// </summary>
  236. /// <param name="sender">The sender.</param>
  237. /// <param name="e">The <see cref="EventArgs" /> instance containing the event data.</param>
  238. private void ConfigurationUpdated(object sender, EventArgs e)
  239. {
  240. var config = _configurationManager.Configuration;
  241. var wizardChanged = config.IsStartupWizardCompleted != _wizardCompleted;
  242. RecordConfigurationValues(config);
  243. if (wizardChanged)
  244. {
  245. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  246. }
  247. }
  248. public void RegisterItem(BaseItem item)
  249. {
  250. if (item == null)
  251. {
  252. throw new ArgumentNullException(nameof(item));
  253. }
  254. if (item is IItemByName)
  255. {
  256. if (!(item is MusicArtist))
  257. {
  258. return;
  259. }
  260. }
  261. else if (!item.IsFolder)
  262. {
  263. if (!(item is Video) && !(item is LiveTvChannel))
  264. {
  265. return;
  266. }
  267. }
  268. _memoryCache.Set(item.Id, item);
  269. }
  270. public void DeleteItem(BaseItem item, DeleteOptions options)
  271. {
  272. DeleteItem(item, options, false);
  273. }
  274. public void DeleteItem(BaseItem item, DeleteOptions options, bool notifyParentItem)
  275. {
  276. if (item == null)
  277. {
  278. throw new ArgumentNullException(nameof(item));
  279. }
  280. var parent = item.GetOwner() ?? item.GetParent();
  281. DeleteItem(item, options, parent, notifyParentItem);
  282. }
  283. public void DeleteItem(BaseItem item, DeleteOptions options, BaseItem parent, bool notifyParentItem)
  284. {
  285. if (item == null)
  286. {
  287. throw new ArgumentNullException(nameof(item));
  288. }
  289. if (item.SourceType == SourceType.Channel)
  290. {
  291. if (options.DeleteFromExternalProvider)
  292. {
  293. try
  294. {
  295. var task = BaseItem.ChannelManager.DeleteItem(item);
  296. Task.WaitAll(task);
  297. }
  298. catch (ArgumentException)
  299. {
  300. // channel no longer installed
  301. }
  302. }
  303. options.DeleteFileLocation = false;
  304. }
  305. if (item is LiveTvProgram)
  306. {
  307. _logger.LogDebug(
  308. "Removing item, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  309. item.GetType().Name,
  310. item.Name ?? "Unknown name",
  311. item.Path ?? string.Empty,
  312. item.Id);
  313. }
  314. else
  315. {
  316. _logger.LogInformation(
  317. "Removing item, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  318. item.GetType().Name,
  319. item.Name ?? "Unknown name",
  320. item.Path ?? string.Empty,
  321. item.Id);
  322. }
  323. var children = item.IsFolder
  324. ? ((Folder)item).GetRecursiveChildren(false).ToList()
  325. : new List<BaseItem>();
  326. foreach (var metadataPath in GetMetadataPaths(item, children))
  327. {
  328. if (!Directory.Exists(metadataPath))
  329. {
  330. continue;
  331. }
  332. _logger.LogDebug(
  333. "Deleting metadata path, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  334. item.GetType().Name,
  335. item.Name ?? "Unknown name",
  336. metadataPath,
  337. item.Id);
  338. try
  339. {
  340. Directory.Delete(metadataPath, true);
  341. }
  342. catch (Exception ex)
  343. {
  344. _logger.LogError(ex, "Error deleting {MetadataPath}", metadataPath);
  345. }
  346. }
  347. if (options.DeleteFileLocation && item.IsFileProtocol)
  348. {
  349. // Assume only the first is required
  350. // Add this flag to GetDeletePaths if required in the future
  351. var isRequiredForDelete = true;
  352. foreach (var fileSystemInfo in item.GetDeletePaths())
  353. {
  354. if (Directory.Exists(fileSystemInfo.FullName) || File.Exists(fileSystemInfo.FullName))
  355. {
  356. try
  357. {
  358. _logger.LogInformation(
  359. "Deleting item path, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  360. item.GetType().Name,
  361. item.Name ?? "Unknown name",
  362. fileSystemInfo.FullName,
  363. item.Id);
  364. if (fileSystemInfo.IsDirectory)
  365. {
  366. Directory.Delete(fileSystemInfo.FullName, true);
  367. }
  368. else
  369. {
  370. File.Delete(fileSystemInfo.FullName);
  371. }
  372. }
  373. catch (IOException)
  374. {
  375. if (isRequiredForDelete)
  376. {
  377. throw;
  378. }
  379. }
  380. catch (UnauthorizedAccessException)
  381. {
  382. if (isRequiredForDelete)
  383. {
  384. throw;
  385. }
  386. }
  387. }
  388. isRequiredForDelete = false;
  389. }
  390. }
  391. item.SetParent(null);
  392. _itemRepository.DeleteItem(item.Id);
  393. foreach (var child in children)
  394. {
  395. _itemRepository.DeleteItem(child.Id);
  396. }
  397. _memoryCache.Remove(item.Id);
  398. ReportItemRemoved(item, parent);
  399. }
  400. private static IEnumerable<string> GetMetadataPaths(BaseItem item, IEnumerable<BaseItem> children)
  401. {
  402. var list = new List<string>
  403. {
  404. item.GetInternalMetadataPath()
  405. };
  406. list.AddRange(children.Select(i => i.GetInternalMetadataPath()));
  407. return list;
  408. }
  409. /// <summary>
  410. /// Resolves the item.
  411. /// </summary>
  412. /// <param name="args">The args.</param>
  413. /// <param name="resolvers">The resolvers.</param>
  414. /// <returns>BaseItem.</returns>
  415. private BaseItem ResolveItem(ItemResolveArgs args, IItemResolver[] resolvers)
  416. {
  417. var item = (resolvers ?? EntityResolvers).Select(r => Resolve(args, r))
  418. .FirstOrDefault(i => i != null);
  419. if (item != null)
  420. {
  421. ResolverHelper.SetInitialItemValues(item, args, _fileSystem, this);
  422. }
  423. return item;
  424. }
  425. private BaseItem Resolve(ItemResolveArgs args, IItemResolver resolver)
  426. {
  427. try
  428. {
  429. return resolver.ResolvePath(args);
  430. }
  431. catch (Exception ex)
  432. {
  433. _logger.LogError(ex, "Error in {resolver} resolving {path}", resolver.GetType().Name, args.Path);
  434. return null;
  435. }
  436. }
  437. public Guid GetNewItemId(string key, Type type)
  438. {
  439. return GetNewItemIdInternal(key, type, false);
  440. }
  441. private Guid GetNewItemIdInternal(string key, Type type, bool forceCaseInsensitive)
  442. {
  443. if (string.IsNullOrEmpty(key))
  444. {
  445. throw new ArgumentNullException(nameof(key));
  446. }
  447. if (type == null)
  448. {
  449. throw new ArgumentNullException(nameof(type));
  450. }
  451. string programDataPath = _configurationManager.ApplicationPaths.ProgramDataPath;
  452. if (key.StartsWith(programDataPath, StringComparison.Ordinal))
  453. {
  454. // Try to normalize paths located underneath program-data in an attempt to make them more portable
  455. key = key.Substring(programDataPath.Length)
  456. .TrimStart('/', '\\')
  457. .Replace('/', '\\');
  458. }
  459. if (forceCaseInsensitive || !_configurationManager.Configuration.EnableCaseSensitiveItemIds)
  460. {
  461. key = key.ToLowerInvariant();
  462. }
  463. key = type.FullName + key;
  464. return key.GetMD5();
  465. }
  466. public BaseItem ResolvePath(FileSystemMetadata fileInfo, Folder parent = null)
  467. => ResolvePath(fileInfo, new DirectoryService(_fileSystem), null, parent);
  468. private BaseItem ResolvePath(
  469. FileSystemMetadata fileInfo,
  470. IDirectoryService directoryService,
  471. IItemResolver[] resolvers,
  472. Folder parent = null,
  473. string collectionType = null,
  474. LibraryOptions libraryOptions = null)
  475. {
  476. if (fileInfo == null)
  477. {
  478. throw new ArgumentNullException(nameof(fileInfo));
  479. }
  480. var fullPath = fileInfo.FullName;
  481. if (string.IsNullOrEmpty(collectionType) && parent != null)
  482. {
  483. collectionType = GetContentTypeOverride(fullPath, true);
  484. }
  485. var args = new ItemResolveArgs(_configurationManager.ApplicationPaths, directoryService)
  486. {
  487. Parent = parent,
  488. Path = fullPath,
  489. FileInfo = fileInfo,
  490. CollectionType = collectionType,
  491. LibraryOptions = libraryOptions
  492. };
  493. // Return null if ignore rules deem that we should do so
  494. if (IgnoreFile(args.FileInfo, args.Parent))
  495. {
  496. return null;
  497. }
  498. // Gather child folder and files
  499. if (args.IsDirectory)
  500. {
  501. var isPhysicalRoot = args.IsPhysicalRoot;
  502. // When resolving the root, we need it's grandchildren (children of user views)
  503. var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
  504. FileSystemMetadata[] files;
  505. var isVf = args.IsVf;
  506. try
  507. {
  508. files = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, _fileSystem, _appHost, _logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || isVf);
  509. }
  510. catch (Exception ex)
  511. {
  512. if (parent != null && parent.IsPhysicalRoot)
  513. {
  514. _logger.LogError(ex, "Error in GetFilteredFileSystemEntries isPhysicalRoot: {0} IsVf: {1}", isPhysicalRoot, isVf);
  515. files = Array.Empty<FileSystemMetadata>();
  516. }
  517. else
  518. {
  519. throw;
  520. }
  521. }
  522. // Need to remove subpaths that may have been resolved from shortcuts
  523. // Example: if \\server\movies exists, then strip out \\server\movies\action
  524. if (isPhysicalRoot)
  525. {
  526. files = NormalizeRootPathList(files).ToArray();
  527. }
  528. args.FileSystemChildren = files;
  529. }
  530. // Check to see if we should resolve based on our contents
  531. if (args.IsDirectory && !ShouldResolvePathContents(args))
  532. {
  533. return null;
  534. }
  535. return ResolveItem(args, resolvers);
  536. }
  537. public bool IgnoreFile(FileSystemMetadata file, BaseItem parent)
  538. => EntityResolutionIgnoreRules.Any(r => r.ShouldIgnore(file, parent));
  539. public List<FileSystemMetadata> NormalizeRootPathList(IEnumerable<FileSystemMetadata> paths)
  540. {
  541. var originalList = paths.ToList();
  542. var list = originalList.Where(i => i.IsDirectory)
  543. .Select(i => _fileSystem.NormalizePath(i.FullName))
  544. .Distinct(StringComparer.OrdinalIgnoreCase)
  545. .ToList();
  546. var dupes = list.Where(subPath => !subPath.EndsWith(":\\", StringComparison.OrdinalIgnoreCase) && list.Any(i => _fileSystem.ContainsSubPath(i, subPath)))
  547. .ToList();
  548. foreach (var dupe in dupes)
  549. {
  550. _logger.LogInformation("Found duplicate path: {0}", dupe);
  551. }
  552. var newList = list.Except(dupes, StringComparer.OrdinalIgnoreCase).Select(_fileSystem.GetDirectoryInfo).ToList();
  553. newList.AddRange(originalList.Where(i => !i.IsDirectory));
  554. return newList;
  555. }
  556. /// <summary>
  557. /// Determines whether a path should be ignored based on its contents - called after the contents have been read.
  558. /// </summary>
  559. /// <param name="args">The args.</param>
  560. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  561. private static bool ShouldResolvePathContents(ItemResolveArgs args)
  562. {
  563. // Ignore any folders containing a file called .ignore
  564. return !args.ContainsFileSystemEntryByName(".ignore");
  565. }
  566. public IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemMetadata> files, IDirectoryService directoryService, Folder parent, LibraryOptions libraryOptions, string collectionType)
  567. {
  568. return ResolvePaths(files, directoryService, parent, libraryOptions, collectionType, EntityResolvers);
  569. }
  570. public IEnumerable<BaseItem> ResolvePaths(
  571. IEnumerable<FileSystemMetadata> files,
  572. IDirectoryService directoryService,
  573. Folder parent,
  574. LibraryOptions libraryOptions,
  575. string collectionType,
  576. IItemResolver[] resolvers)
  577. {
  578. var fileList = files.Where(i => !IgnoreFile(i, parent)).ToList();
  579. if (parent != null)
  580. {
  581. var multiItemResolvers = resolvers == null ? MultiItemResolvers : resolvers.OfType<IMultiItemResolver>().ToArray();
  582. foreach (var resolver in multiItemResolvers)
  583. {
  584. var result = resolver.ResolveMultiple(parent, fileList, collectionType, directoryService);
  585. if (result != null && result.Items.Count > 0)
  586. {
  587. var items = new List<BaseItem>();
  588. items.AddRange(result.Items);
  589. foreach (var item in items)
  590. {
  591. ResolverHelper.SetInitialItemValues(item, parent, _fileSystem, this, directoryService);
  592. }
  593. items.AddRange(ResolveFileList(result.ExtraFiles, directoryService, parent, collectionType, resolvers, libraryOptions));
  594. return items;
  595. }
  596. }
  597. }
  598. return ResolveFileList(fileList, directoryService, parent, collectionType, resolvers, libraryOptions);
  599. }
  600. private IEnumerable<BaseItem> ResolveFileList(
  601. IEnumerable<FileSystemMetadata> fileList,
  602. IDirectoryService directoryService,
  603. Folder parent,
  604. string collectionType,
  605. IItemResolver[] resolvers,
  606. LibraryOptions libraryOptions)
  607. {
  608. return fileList.Select(f =>
  609. {
  610. try
  611. {
  612. return ResolvePath(f, directoryService, resolvers, parent, collectionType, libraryOptions);
  613. }
  614. catch (Exception ex)
  615. {
  616. _logger.LogError(ex, "Error resolving path {path}", f.FullName);
  617. return null;
  618. }
  619. }).Where(i => i != null);
  620. }
  621. /// <summary>
  622. /// Creates the root media folder.
  623. /// </summary>
  624. /// <returns>AggregateFolder.</returns>
  625. /// <exception cref="InvalidOperationException">Cannot create the root folder until plugins have loaded.</exception>
  626. public AggregateFolder CreateRootFolder()
  627. {
  628. var rootFolderPath = _configurationManager.ApplicationPaths.RootFolderPath;
  629. Directory.CreateDirectory(rootFolderPath);
  630. var rootFolder = GetItemById(GetNewItemId(rootFolderPath, typeof(AggregateFolder))) as AggregateFolder ??
  631. ((Folder)ResolvePath(_fileSystem.GetDirectoryInfo(rootFolderPath)))
  632. .DeepCopy<Folder, AggregateFolder>();
  633. // In case program data folder was moved
  634. if (!string.Equals(rootFolder.Path, rootFolderPath, StringComparison.Ordinal))
  635. {
  636. _logger.LogInformation("Resetting root folder path to {0}", rootFolderPath);
  637. rootFolder.Path = rootFolderPath;
  638. }
  639. // Add in the plug-in folders
  640. var path = Path.Combine(_configurationManager.ApplicationPaths.DataPath, "playlists");
  641. Directory.CreateDirectory(path);
  642. Folder folder = new PlaylistsFolder
  643. {
  644. Path = path
  645. };
  646. if (folder.Id.Equals(Guid.Empty))
  647. {
  648. if (string.IsNullOrEmpty(folder.Path))
  649. {
  650. folder.Id = GetNewItemId(folder.GetType().Name, folder.GetType());
  651. }
  652. else
  653. {
  654. folder.Id = GetNewItemId(folder.Path, folder.GetType());
  655. }
  656. }
  657. var dbItem = GetItemById(folder.Id) as BasePluginFolder;
  658. if (dbItem != null && string.Equals(dbItem.Path, folder.Path, StringComparison.OrdinalIgnoreCase))
  659. {
  660. folder = dbItem;
  661. }
  662. if (folder.ParentId != rootFolder.Id)
  663. {
  664. folder.ParentId = rootFolder.Id;
  665. folder.UpdateToRepositoryAsync(ItemUpdateType.MetadataImport, CancellationToken.None).GetAwaiter().GetResult();
  666. }
  667. rootFolder.AddVirtualChild(folder);
  668. RegisterItem(folder);
  669. return rootFolder;
  670. }
  671. public Folder GetUserRootFolder()
  672. {
  673. if (_userRootFolder == null)
  674. {
  675. lock (_userRootFolderSyncLock)
  676. {
  677. if (_userRootFolder == null)
  678. {
  679. var userRootPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  680. _logger.LogDebug("Creating userRootPath at {path}", userRootPath);
  681. Directory.CreateDirectory(userRootPath);
  682. var newItemId = GetNewItemId(userRootPath, typeof(UserRootFolder));
  683. UserRootFolder tmpItem = null;
  684. try
  685. {
  686. tmpItem = GetItemById(newItemId) as UserRootFolder;
  687. }
  688. catch (Exception ex)
  689. {
  690. _logger.LogError(ex, "Error creating UserRootFolder {path}", newItemId);
  691. }
  692. if (tmpItem == null)
  693. {
  694. _logger.LogDebug("Creating new userRootFolder with DeepCopy");
  695. tmpItem = ((Folder)ResolvePath(_fileSystem.GetDirectoryInfo(userRootPath))).DeepCopy<Folder, UserRootFolder>();
  696. }
  697. // In case program data folder was moved
  698. if (!string.Equals(tmpItem.Path, userRootPath, StringComparison.Ordinal))
  699. {
  700. _logger.LogInformation("Resetting user root folder path to {0}", userRootPath);
  701. tmpItem.Path = userRootPath;
  702. }
  703. _userRootFolder = tmpItem;
  704. _logger.LogDebug("Setting userRootFolder: {folder}", _userRootFolder);
  705. }
  706. }
  707. }
  708. return _userRootFolder;
  709. }
  710. public BaseItem FindByPath(string path, bool? isFolder)
  711. {
  712. // If this returns multiple items it could be tricky figuring out which one is correct.
  713. // In most cases, the newest one will be and the others obsolete but not yet cleaned up
  714. if (string.IsNullOrEmpty(path))
  715. {
  716. throw new ArgumentNullException(nameof(path));
  717. }
  718. var query = new InternalItemsQuery
  719. {
  720. Path = path,
  721. IsFolder = isFolder,
  722. OrderBy = new[] { (ItemSortBy.DateCreated, SortOrder.Descending) },
  723. Limit = 1,
  724. DtoOptions = new DtoOptions(true)
  725. };
  726. return GetItemList(query)
  727. .FirstOrDefault();
  728. }
  729. /// <summary>
  730. /// Gets the person.
  731. /// </summary>
  732. /// <param name="name">The name.</param>
  733. /// <returns>Task{Person}.</returns>
  734. public Person GetPerson(string name)
  735. {
  736. var path = Person.GetPath(name);
  737. var id = GetItemByNameId<Person>(path);
  738. if (!(GetItemById(id) is Person item))
  739. {
  740. item = new Person
  741. {
  742. Name = name,
  743. Id = id,
  744. DateCreated = DateTime.UtcNow,
  745. DateModified = DateTime.UtcNow,
  746. Path = path
  747. };
  748. }
  749. return item;
  750. }
  751. /// <summary>
  752. /// Gets the studio.
  753. /// </summary>
  754. /// <param name="name">The name.</param>
  755. /// <returns>Task{Studio}.</returns>
  756. public Studio GetStudio(string name)
  757. {
  758. return CreateItemByName<Studio>(Studio.GetPath, name, new DtoOptions(true));
  759. }
  760. public Guid GetStudioId(string name)
  761. {
  762. return GetItemByNameId<Studio>(Studio.GetPath(name));
  763. }
  764. public Guid GetGenreId(string name)
  765. {
  766. return GetItemByNameId<Genre>(Genre.GetPath(name));
  767. }
  768. public Guid GetMusicGenreId(string name)
  769. {
  770. return GetItemByNameId<MusicGenre>(MusicGenre.GetPath(name));
  771. }
  772. /// <summary>
  773. /// Gets the genre.
  774. /// </summary>
  775. /// <param name="name">The name.</param>
  776. /// <returns>Task{Genre}.</returns>
  777. public Genre GetGenre(string name)
  778. {
  779. return CreateItemByName<Genre>(Genre.GetPath, name, new DtoOptions(true));
  780. }
  781. /// <summary>
  782. /// Gets the music genre.
  783. /// </summary>
  784. /// <param name="name">The name.</param>
  785. /// <returns>Task{MusicGenre}.</returns>
  786. public MusicGenre GetMusicGenre(string name)
  787. {
  788. return CreateItemByName<MusicGenre>(MusicGenre.GetPath, name, new DtoOptions(true));
  789. }
  790. /// <summary>
  791. /// Gets the year.
  792. /// </summary>
  793. /// <param name="value">The value.</param>
  794. /// <returns>Task{Year}.</returns>
  795. public Year GetYear(int value)
  796. {
  797. if (value <= 0)
  798. {
  799. throw new ArgumentOutOfRangeException(nameof(value), "Years less than or equal to 0 are invalid.");
  800. }
  801. var name = value.ToString(CultureInfo.InvariantCulture);
  802. return CreateItemByName<Year>(Year.GetPath, name, new DtoOptions(true));
  803. }
  804. /// <summary>
  805. /// Gets a Genre.
  806. /// </summary>
  807. /// <param name="name">The name.</param>
  808. /// <returns>Task{Genre}.</returns>
  809. public MusicArtist GetArtist(string name)
  810. {
  811. return GetArtist(name, new DtoOptions(true));
  812. }
  813. public MusicArtist GetArtist(string name, DtoOptions options)
  814. {
  815. return CreateItemByName<MusicArtist>(MusicArtist.GetPath, name, options);
  816. }
  817. private T CreateItemByName<T>(Func<string, string> getPathFn, string name, DtoOptions options)
  818. where T : BaseItem, new()
  819. {
  820. if (typeof(T) == typeof(MusicArtist))
  821. {
  822. var existing = GetItemList(new InternalItemsQuery
  823. {
  824. IncludeItemTypes = new[] { nameof(MusicArtist) },
  825. Name = name,
  826. DtoOptions = options
  827. }).Cast<MusicArtist>()
  828. .OrderBy(i => i.IsAccessedByName ? 1 : 0)
  829. .Cast<T>()
  830. .FirstOrDefault();
  831. if (existing != null)
  832. {
  833. return existing;
  834. }
  835. }
  836. var path = getPathFn(name);
  837. var id = GetItemByNameId<T>(path);
  838. var item = GetItemById(id) as T;
  839. if (item == null)
  840. {
  841. item = new T
  842. {
  843. Name = name,
  844. Id = id,
  845. DateCreated = DateTime.UtcNow,
  846. DateModified = DateTime.UtcNow,
  847. Path = path
  848. };
  849. CreateItem(item, null);
  850. }
  851. return item;
  852. }
  853. private Guid GetItemByNameId<T>(string path)
  854. where T : BaseItem, new()
  855. {
  856. var forceCaseInsensitiveId = _configurationManager.Configuration.EnableNormalizedItemByNameIds;
  857. return GetNewItemIdInternal(path, typeof(T), forceCaseInsensitiveId);
  858. }
  859. /// <summary>
  860. /// Validate and refresh the People sub-set of the IBN.
  861. /// The items are stored in the db but not loaded into memory until actually requested by an operation.
  862. /// </summary>
  863. /// <param name="cancellationToken">The cancellation token.</param>
  864. /// <param name="progress">The progress.</param>
  865. /// <returns>Task.</returns>
  866. public Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress)
  867. {
  868. // Ensure the location is available.
  869. Directory.CreateDirectory(_configurationManager.ApplicationPaths.PeoplePath);
  870. return new PeopleValidator(this, _logger, _fileSystem).ValidatePeople(cancellationToken, progress);
  871. }
  872. /// <summary>
  873. /// Reloads the root media folder.
  874. /// </summary>
  875. /// <param name="progress">The progress.</param>
  876. /// <param name="cancellationToken">The cancellation token.</param>
  877. /// <returns>Task.</returns>
  878. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  879. {
  880. // Just run the scheduled task so that the user can see it
  881. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  882. return Task.CompletedTask;
  883. }
  884. /// <summary>
  885. /// Queues the library scan.
  886. /// </summary>
  887. public void QueueLibraryScan()
  888. {
  889. // Just run the scheduled task so that the user can see it
  890. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  891. }
  892. /// <summary>
  893. /// Validates the media library internal.
  894. /// </summary>
  895. /// <param name="progress">The progress.</param>
  896. /// <param name="cancellationToken">The cancellation token.</param>
  897. /// <returns>Task.</returns>
  898. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  899. {
  900. IsScanRunning = true;
  901. LibraryMonitor.Stop();
  902. try
  903. {
  904. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  905. }
  906. finally
  907. {
  908. LibraryMonitor.Start();
  909. IsScanRunning = false;
  910. }
  911. }
  912. private async Task ValidateTopLibraryFolders(CancellationToken cancellationToken)
  913. {
  914. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  915. // Start by just validating the children of the root, but go no further
  916. await RootFolder.ValidateChildren(
  917. new SimpleProgress<double>(),
  918. cancellationToken,
  919. new MetadataRefreshOptions(new DirectoryService(_fileSystem)),
  920. recursive: false).ConfigureAwait(false);
  921. await GetUserRootFolder().RefreshMetadata(cancellationToken).ConfigureAwait(false);
  922. await GetUserRootFolder().ValidateChildren(
  923. new SimpleProgress<double>(),
  924. cancellationToken,
  925. new MetadataRefreshOptions(new DirectoryService(_fileSystem)),
  926. recursive: false).ConfigureAwait(false);
  927. // Quickly scan CollectionFolders for changes
  928. foreach (var folder in GetUserRootFolder().Children.OfType<Folder>())
  929. {
  930. await folder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  931. }
  932. }
  933. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  934. {
  935. _logger.LogInformation("Validating media library");
  936. await ValidateTopLibraryFolders(cancellationToken).ConfigureAwait(false);
  937. var innerProgress = new ActionableProgress<double>();
  938. innerProgress.RegisterAction(pct => progress.Report(pct * 0.96));
  939. // Validate the entire media library
  940. await RootFolder.ValidateChildren(innerProgress, cancellationToken, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), recursive: true).ConfigureAwait(false);
  941. progress.Report(96);
  942. innerProgress = new ActionableProgress<double>();
  943. innerProgress.RegisterAction(pct => progress.Report(96 + (pct * .04)));
  944. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  945. progress.Report(100);
  946. }
  947. /// <summary>
  948. /// Runs the post scan tasks.
  949. /// </summary>
  950. /// <param name="progress">The progress.</param>
  951. /// <param name="cancellationToken">The cancellation token.</param>
  952. /// <returns>Task.</returns>
  953. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  954. {
  955. var tasks = PostscanTasks.ToList();
  956. var numComplete = 0;
  957. var numTasks = tasks.Count;
  958. foreach (var task in tasks)
  959. {
  960. var innerProgress = new ActionableProgress<double>();
  961. // Prevent access to modified closure
  962. var currentNumComplete = numComplete;
  963. innerProgress.RegisterAction(pct =>
  964. {
  965. double innerPercent = pct;
  966. innerPercent /= 100;
  967. innerPercent += currentNumComplete;
  968. innerPercent /= numTasks;
  969. innerPercent *= 100;
  970. progress.Report(innerPercent);
  971. });
  972. _logger.LogDebug("Running post-scan task {0}", task.GetType().Name);
  973. try
  974. {
  975. await task.Run(innerProgress, cancellationToken).ConfigureAwait(false);
  976. }
  977. catch (OperationCanceledException)
  978. {
  979. _logger.LogInformation("Post-scan task cancelled: {0}", task.GetType().Name);
  980. throw;
  981. }
  982. catch (Exception ex)
  983. {
  984. _logger.LogError(ex, "Error running post-scan task");
  985. }
  986. numComplete++;
  987. double percent = numComplete;
  988. percent /= numTasks;
  989. progress.Report(percent * 100);
  990. }
  991. _itemRepository.UpdateInheritedValues(cancellationToken);
  992. progress.Report(100);
  993. }
  994. /// <summary>
  995. /// Gets the default view.
  996. /// </summary>
  997. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  998. public List<VirtualFolderInfo> GetVirtualFolders()
  999. {
  1000. return GetVirtualFolders(false);
  1001. }
  1002. public List<VirtualFolderInfo> GetVirtualFolders(bool includeRefreshState)
  1003. {
  1004. _logger.LogDebug("Getting topLibraryFolders");
  1005. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  1006. _logger.LogDebug("Getting refreshQueue");
  1007. var refreshQueue = includeRefreshState ? ProviderManager.GetRefreshQueue() : null;
  1008. return _fileSystem.GetDirectoryPaths(_configurationManager.ApplicationPaths.DefaultUserViewsPath)
  1009. .Select(dir => GetVirtualFolderInfo(dir, topLibraryFolders, refreshQueue))
  1010. .ToList();
  1011. }
  1012. private VirtualFolderInfo GetVirtualFolderInfo(string dir, List<BaseItem> allCollectionFolders, Dictionary<Guid, Guid> refreshQueue)
  1013. {
  1014. var info = new VirtualFolderInfo
  1015. {
  1016. Name = Path.GetFileName(dir),
  1017. Locations = _fileSystem.GetFilePaths(dir, false)
  1018. .Where(i => string.Equals(ShortcutFileExtension, Path.GetExtension(i), StringComparison.OrdinalIgnoreCase))
  1019. .Select(i =>
  1020. {
  1021. try
  1022. {
  1023. return _appHost.ExpandVirtualPath(_fileSystem.ResolveShortcut(i));
  1024. }
  1025. catch (Exception ex)
  1026. {
  1027. _logger.LogError(ex, "Error resolving shortcut file {file}", i);
  1028. return null;
  1029. }
  1030. })
  1031. .Where(i => i != null)
  1032. .OrderBy(i => i)
  1033. .ToArray(),
  1034. CollectionType = GetCollectionType(dir)
  1035. };
  1036. var libraryFolder = allCollectionFolders.FirstOrDefault(i => string.Equals(i.Path, dir, StringComparison.OrdinalIgnoreCase));
  1037. if (libraryFolder != null && libraryFolder.HasImage(ImageType.Primary))
  1038. {
  1039. info.PrimaryImageItemId = libraryFolder.Id.ToString("N", CultureInfo.InvariantCulture);
  1040. }
  1041. if (libraryFolder != null)
  1042. {
  1043. info.ItemId = libraryFolder.Id.ToString("N", CultureInfo.InvariantCulture);
  1044. info.LibraryOptions = GetLibraryOptions(libraryFolder);
  1045. if (refreshQueue != null)
  1046. {
  1047. info.RefreshProgress = libraryFolder.GetRefreshProgress();
  1048. info.RefreshStatus = info.RefreshProgress.HasValue ? "Active" : refreshQueue.ContainsKey(libraryFolder.Id) ? "Queued" : "Idle";
  1049. }
  1050. }
  1051. return info;
  1052. }
  1053. private CollectionTypeOptions? GetCollectionType(string path)
  1054. {
  1055. var files = _fileSystem.GetFilePaths(path, new[] { ".collection" }, true, false);
  1056. foreach (var file in files)
  1057. {
  1058. // TODO: @bond use a ReadOnlySpan<char> here when Enum.TryParse supports it
  1059. // https://github.com/dotnet/runtime/issues/20008
  1060. if (Enum.TryParse<CollectionTypeOptions>(Path.GetFileNameWithoutExtension(file), true, out var res))
  1061. {
  1062. return res;
  1063. }
  1064. }
  1065. return null;
  1066. }
  1067. /// <summary>
  1068. /// Gets the item by id.
  1069. /// </summary>
  1070. /// <param name="id">The id.</param>
  1071. /// <returns>BaseItem.</returns>
  1072. /// <exception cref="ArgumentNullException">id</exception>
  1073. public BaseItem GetItemById(Guid id)
  1074. {
  1075. if (id == Guid.Empty)
  1076. {
  1077. throw new ArgumentException("Guid can't be empty", nameof(id));
  1078. }
  1079. if (_memoryCache.TryGetValue(id, out BaseItem item))
  1080. {
  1081. return item;
  1082. }
  1083. item = RetrieveItem(id);
  1084. if (item != null)
  1085. {
  1086. RegisterItem(item);
  1087. }
  1088. return item;
  1089. }
  1090. public List<BaseItem> GetItemList(InternalItemsQuery query, bool allowExternalContent)
  1091. {
  1092. if (query.Recursive && query.ParentId != Guid.Empty)
  1093. {
  1094. var parent = GetItemById(query.ParentId);
  1095. if (parent != null)
  1096. {
  1097. SetTopParentIdsOrAncestors(query, new List<BaseItem> { parent });
  1098. }
  1099. }
  1100. if (query.User != null)
  1101. {
  1102. AddUserToQuery(query, query.User, allowExternalContent);
  1103. }
  1104. return _itemRepository.GetItemList(query);
  1105. }
  1106. public List<BaseItem> GetItemList(InternalItemsQuery query)
  1107. {
  1108. return GetItemList(query, true);
  1109. }
  1110. public int GetCount(InternalItemsQuery query)
  1111. {
  1112. if (query.Recursive && !query.ParentId.Equals(Guid.Empty))
  1113. {
  1114. var parent = GetItemById(query.ParentId);
  1115. if (parent != null)
  1116. {
  1117. SetTopParentIdsOrAncestors(query, new List<BaseItem> { parent });
  1118. }
  1119. }
  1120. if (query.User != null)
  1121. {
  1122. AddUserToQuery(query, query.User);
  1123. }
  1124. return _itemRepository.GetCount(query);
  1125. }
  1126. public List<BaseItem> GetItemList(InternalItemsQuery query, List<BaseItem> parents)
  1127. {
  1128. SetTopParentIdsOrAncestors(query, parents);
  1129. if (query.AncestorIds.Length == 0 && query.TopParentIds.Length == 0)
  1130. {
  1131. if (query.User != null)
  1132. {
  1133. AddUserToQuery(query, query.User);
  1134. }
  1135. }
  1136. return _itemRepository.GetItemList(query);
  1137. }
  1138. public QueryResult<BaseItem> QueryItems(InternalItemsQuery query)
  1139. {
  1140. if (query.User != null)
  1141. {
  1142. AddUserToQuery(query, query.User);
  1143. }
  1144. if (query.EnableTotalRecordCount)
  1145. {
  1146. return _itemRepository.GetItems(query);
  1147. }
  1148. return new QueryResult<BaseItem>
  1149. {
  1150. Items = _itemRepository.GetItemList(query)
  1151. };
  1152. }
  1153. public List<Guid> GetItemIds(InternalItemsQuery query)
  1154. {
  1155. if (query.User != null)
  1156. {
  1157. AddUserToQuery(query, query.User);
  1158. }
  1159. return _itemRepository.GetItemIdsList(query);
  1160. }
  1161. public QueryResult<(BaseItem, ItemCounts)> GetStudios(InternalItemsQuery query)
  1162. {
  1163. if (query.User != null)
  1164. {
  1165. AddUserToQuery(query, query.User);
  1166. }
  1167. SetTopParentOrAncestorIds(query);
  1168. return _itemRepository.GetStudios(query);
  1169. }
  1170. public QueryResult<(BaseItem, ItemCounts)> GetGenres(InternalItemsQuery query)
  1171. {
  1172. if (query.User != null)
  1173. {
  1174. AddUserToQuery(query, query.User);
  1175. }
  1176. SetTopParentOrAncestorIds(query);
  1177. return _itemRepository.GetGenres(query);
  1178. }
  1179. public QueryResult<(BaseItem, ItemCounts)> GetMusicGenres(InternalItemsQuery query)
  1180. {
  1181. if (query.User != null)
  1182. {
  1183. AddUserToQuery(query, query.User);
  1184. }
  1185. SetTopParentOrAncestorIds(query);
  1186. return _itemRepository.GetMusicGenres(query);
  1187. }
  1188. public QueryResult<(BaseItem, ItemCounts)> GetAllArtists(InternalItemsQuery query)
  1189. {
  1190. if (query.User != null)
  1191. {
  1192. AddUserToQuery(query, query.User);
  1193. }
  1194. SetTopParentOrAncestorIds(query);
  1195. return _itemRepository.GetAllArtists(query);
  1196. }
  1197. public QueryResult<(BaseItem, ItemCounts)> GetArtists(InternalItemsQuery query)
  1198. {
  1199. if (query.User != null)
  1200. {
  1201. AddUserToQuery(query, query.User);
  1202. }
  1203. SetTopParentOrAncestorIds(query);
  1204. return _itemRepository.GetArtists(query);
  1205. }
  1206. private void SetTopParentOrAncestorIds(InternalItemsQuery query)
  1207. {
  1208. var ancestorIds = query.AncestorIds;
  1209. int len = ancestorIds.Length;
  1210. if (len == 0)
  1211. {
  1212. return;
  1213. }
  1214. var parents = new BaseItem[len];
  1215. for (int i = 0; i < len; i++)
  1216. {
  1217. parents[i] = GetItemById(ancestorIds[i]);
  1218. if (!(parents[i] is ICollectionFolder || parents[i] is UserView))
  1219. {
  1220. return;
  1221. }
  1222. }
  1223. // Optimize by querying against top level views
  1224. query.TopParentIds = parents.SelectMany(i => GetTopParentIdsForQuery(i, query.User)).ToArray();
  1225. query.AncestorIds = Array.Empty<Guid>();
  1226. // Prevent searching in all libraries due to empty filter
  1227. if (query.TopParentIds.Length == 0)
  1228. {
  1229. query.TopParentIds = new[] { Guid.NewGuid() };
  1230. }
  1231. }
  1232. public QueryResult<(BaseItem, ItemCounts)> GetAlbumArtists(InternalItemsQuery query)
  1233. {
  1234. if (query.User != null)
  1235. {
  1236. AddUserToQuery(query, query.User);
  1237. }
  1238. SetTopParentOrAncestorIds(query);
  1239. return _itemRepository.GetAlbumArtists(query);
  1240. }
  1241. public QueryResult<BaseItem> GetItemsResult(InternalItemsQuery query)
  1242. {
  1243. if (query.Recursive && !query.ParentId.Equals(Guid.Empty))
  1244. {
  1245. var parent = GetItemById(query.ParentId);
  1246. if (parent != null)
  1247. {
  1248. SetTopParentIdsOrAncestors(query, new List<BaseItem> { parent });
  1249. }
  1250. }
  1251. if (query.User != null)
  1252. {
  1253. AddUserToQuery(query, query.User);
  1254. }
  1255. if (query.EnableTotalRecordCount)
  1256. {
  1257. return _itemRepository.GetItems(query);
  1258. }
  1259. return new QueryResult<BaseItem>
  1260. {
  1261. Items = _itemRepository.GetItemList(query)
  1262. };
  1263. }
  1264. private void SetTopParentIdsOrAncestors(InternalItemsQuery query, List<BaseItem> parents)
  1265. {
  1266. if (parents.All(i => i is ICollectionFolder || i is UserView))
  1267. {
  1268. // Optimize by querying against top level views
  1269. query.TopParentIds = parents.SelectMany(i => GetTopParentIdsForQuery(i, query.User)).ToArray();
  1270. // Prevent searching in all libraries due to empty filter
  1271. if (query.TopParentIds.Length == 0)
  1272. {
  1273. query.TopParentIds = new[] { Guid.NewGuid() };
  1274. }
  1275. }
  1276. else
  1277. {
  1278. // We need to be able to query from any arbitrary ancestor up the tree
  1279. query.AncestorIds = parents.SelectMany(i => i.GetIdsForAncestorQuery()).ToArray();
  1280. // Prevent searching in all libraries due to empty filter
  1281. if (query.AncestorIds.Length == 0)
  1282. {
  1283. query.AncestorIds = new[] { Guid.NewGuid() };
  1284. }
  1285. }
  1286. query.Parent = null;
  1287. }
  1288. private void AddUserToQuery(InternalItemsQuery query, User user, bool allowExternalContent = true)
  1289. {
  1290. if (query.AncestorIds.Length == 0 &&
  1291. query.ParentId.Equals(Guid.Empty) &&
  1292. query.ChannelIds.Count == 0 &&
  1293. query.TopParentIds.Length == 0 &&
  1294. string.IsNullOrEmpty(query.AncestorWithPresentationUniqueKey) &&
  1295. string.IsNullOrEmpty(query.SeriesPresentationUniqueKey) &&
  1296. query.ItemIds.Length == 0)
  1297. {
  1298. var userViews = UserViewManager.GetUserViews(new UserViewQuery
  1299. {
  1300. UserId = user.Id,
  1301. IncludeHidden = true,
  1302. IncludeExternalContent = allowExternalContent
  1303. });
  1304. query.TopParentIds = userViews.SelectMany(i => GetTopParentIdsForQuery(i, user)).ToArray();
  1305. }
  1306. }
  1307. private IEnumerable<Guid> GetTopParentIdsForQuery(BaseItem item, User user)
  1308. {
  1309. if (item is UserView view)
  1310. {
  1311. if (string.Equals(view.ViewType, CollectionType.LiveTv, StringComparison.Ordinal))
  1312. {
  1313. return new[] { view.Id };
  1314. }
  1315. // Translate view into folders
  1316. if (!view.DisplayParentId.Equals(Guid.Empty))
  1317. {
  1318. var displayParent = GetItemById(view.DisplayParentId);
  1319. if (displayParent != null)
  1320. {
  1321. return GetTopParentIdsForQuery(displayParent, user);
  1322. }
  1323. return Array.Empty<Guid>();
  1324. }
  1325. if (!view.ParentId.Equals(Guid.Empty))
  1326. {
  1327. var displayParent = GetItemById(view.ParentId);
  1328. if (displayParent != null)
  1329. {
  1330. return GetTopParentIdsForQuery(displayParent, user);
  1331. }
  1332. return Array.Empty<Guid>();
  1333. }
  1334. // Handle grouping
  1335. if (user != null && !string.IsNullOrEmpty(view.ViewType) && UserView.IsEligibleForGrouping(view.ViewType)
  1336. && user.GetPreference(PreferenceKind.GroupedFolders).Length > 0)
  1337. {
  1338. return GetUserRootFolder()
  1339. .GetChildren(user, true)
  1340. .OfType<CollectionFolder>()
  1341. .Where(i => string.IsNullOrEmpty(i.CollectionType) || string.Equals(i.CollectionType, view.ViewType, StringComparison.OrdinalIgnoreCase))
  1342. .Where(i => user.IsFolderGrouped(i.Id))
  1343. .SelectMany(i => GetTopParentIdsForQuery(i, user));
  1344. }
  1345. return Array.Empty<Guid>();
  1346. }
  1347. if (item is CollectionFolder collectionFolder)
  1348. {
  1349. return collectionFolder.PhysicalFolderIds;
  1350. }
  1351. var topParent = item.GetTopParent();
  1352. if (topParent != null)
  1353. {
  1354. return new[] { topParent.Id };
  1355. }
  1356. return Array.Empty<Guid>();
  1357. }
  1358. /// <summary>
  1359. /// Gets the intros.
  1360. /// </summary>
  1361. /// <param name="item">The item.</param>
  1362. /// <param name="user">The user.</param>
  1363. /// <returns>IEnumerable{System.String}.</returns>
  1364. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1365. {
  1366. var tasks = IntroProviders
  1367. .Take(1)
  1368. .Select(i => GetIntros(i, item, user));
  1369. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1370. return items
  1371. .SelectMany(i => i.ToArray())
  1372. .Select(ResolveIntro)
  1373. .Where(i => i != null);
  1374. }
  1375. /// <summary>
  1376. /// Gets the intros.
  1377. /// </summary>
  1378. /// <param name="provider">The provider.</param>
  1379. /// <param name="item">The item.</param>
  1380. /// <param name="user">The user.</param>
  1381. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1382. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1383. {
  1384. try
  1385. {
  1386. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1387. }
  1388. catch (Exception ex)
  1389. {
  1390. _logger.LogError(ex, "Error getting intros");
  1391. return new List<IntroInfo>();
  1392. }
  1393. }
  1394. /// <summary>
  1395. /// Gets all intro files.
  1396. /// </summary>
  1397. /// <returns>IEnumerable{System.String}.</returns>
  1398. public IEnumerable<string> GetAllIntroFiles()
  1399. {
  1400. return IntroProviders.SelectMany(i =>
  1401. {
  1402. try
  1403. {
  1404. return i.GetAllIntroFiles().ToList();
  1405. }
  1406. catch (Exception ex)
  1407. {
  1408. _logger.LogError(ex, "Error getting intro files");
  1409. return new List<string>();
  1410. }
  1411. });
  1412. }
  1413. /// <summary>
  1414. /// Resolves the intro.
  1415. /// </summary>
  1416. /// <param name="info">The info.</param>
  1417. /// <returns>Video.</returns>
  1418. private Video ResolveIntro(IntroInfo info)
  1419. {
  1420. Video video = null;
  1421. if (info.ItemId.HasValue)
  1422. {
  1423. // Get an existing item by Id
  1424. video = GetItemById(info.ItemId.Value) as Video;
  1425. if (video == null)
  1426. {
  1427. _logger.LogError("Unable to locate item with Id {ID}.", info.ItemId.Value);
  1428. }
  1429. }
  1430. else if (!string.IsNullOrEmpty(info.Path))
  1431. {
  1432. try
  1433. {
  1434. // Try to resolve the path into a video
  1435. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1436. if (video == null)
  1437. {
  1438. _logger.LogError("Intro resolver returned null for {path}.", info.Path);
  1439. }
  1440. else
  1441. {
  1442. // Pull the saved db item that will include metadata
  1443. var dbItem = GetItemById(video.Id) as Video;
  1444. if (dbItem != null)
  1445. {
  1446. video = dbItem;
  1447. }
  1448. else
  1449. {
  1450. return null;
  1451. }
  1452. }
  1453. }
  1454. catch (Exception ex)
  1455. {
  1456. _logger.LogError(ex, "Error resolving path {path}.", info.Path);
  1457. }
  1458. }
  1459. else
  1460. {
  1461. _logger.LogError("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1462. }
  1463. return video;
  1464. }
  1465. /// <summary>
  1466. /// Sorts the specified sort by.
  1467. /// </summary>
  1468. /// <param name="items">The items.</param>
  1469. /// <param name="user">The user.</param>
  1470. /// <param name="sortBy">The sort by.</param>
  1471. /// <param name="sortOrder">The sort order.</param>
  1472. /// <returns>IEnumerable{BaseItem}.</returns>
  1473. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy, SortOrder sortOrder)
  1474. {
  1475. var isFirst = true;
  1476. IOrderedEnumerable<BaseItem> orderedItems = null;
  1477. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c != null))
  1478. {
  1479. if (isFirst)
  1480. {
  1481. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1482. }
  1483. else
  1484. {
  1485. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1486. }
  1487. isFirst = false;
  1488. }
  1489. return orderedItems ?? items;
  1490. }
  1491. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<ValueTuple<string, SortOrder>> orderByList)
  1492. {
  1493. var isFirst = true;
  1494. IOrderedEnumerable<BaseItem> orderedItems = null;
  1495. foreach (var orderBy in orderByList)
  1496. {
  1497. var comparer = GetComparer(orderBy.Item1, user);
  1498. if (comparer == null)
  1499. {
  1500. continue;
  1501. }
  1502. var sortOrder = orderBy.Item2;
  1503. if (isFirst)
  1504. {
  1505. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, comparer) : items.OrderBy(i => i, comparer);
  1506. }
  1507. else
  1508. {
  1509. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, comparer) : orderedItems.ThenBy(i => i, comparer);
  1510. }
  1511. isFirst = false;
  1512. }
  1513. return orderedItems ?? items;
  1514. }
  1515. /// <summary>
  1516. /// Gets the comparer.
  1517. /// </summary>
  1518. /// <param name="name">The name.</param>
  1519. /// <param name="user">The user.</param>
  1520. /// <returns>IBaseItemComparer.</returns>
  1521. private IBaseItemComparer GetComparer(string name, User user)
  1522. {
  1523. var comparer = Comparers.FirstOrDefault(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase));
  1524. // If it requires a user, create a new one, and assign the user
  1525. if (comparer is IUserBaseItemComparer)
  1526. {
  1527. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1528. userComparer.User = user;
  1529. userComparer.UserManager = _userManager;
  1530. userComparer.UserDataRepository = _userDataRepository;
  1531. return userComparer;
  1532. }
  1533. return comparer;
  1534. }
  1535. /// <summary>
  1536. /// Creates the item.
  1537. /// </summary>
  1538. /// <param name="item">The item.</param>
  1539. /// <param name="parent">The parent item.</param>
  1540. public void CreateItem(BaseItem item, BaseItem parent)
  1541. {
  1542. CreateItems(new[] { item }, parent, CancellationToken.None);
  1543. }
  1544. /// <summary>
  1545. /// Creates the items.
  1546. /// </summary>
  1547. /// <param name="items">The items.</param>
  1548. /// <param name="parent">The parent item.</param>
  1549. /// <param name="cancellationToken">The cancellation token.</param>
  1550. public void CreateItems(IReadOnlyList<BaseItem> items, BaseItem parent, CancellationToken cancellationToken)
  1551. {
  1552. _itemRepository.SaveItems(items, cancellationToken);
  1553. foreach (var item in items)
  1554. {
  1555. RegisterItem(item);
  1556. }
  1557. if (ItemAdded != null)
  1558. {
  1559. foreach (var item in items)
  1560. {
  1561. // With the live tv guide this just creates too much noise
  1562. if (item.SourceType != SourceType.Library)
  1563. {
  1564. continue;
  1565. }
  1566. try
  1567. {
  1568. ItemAdded(
  1569. this,
  1570. new ItemChangeEventArgs
  1571. {
  1572. Item = item,
  1573. Parent = parent ?? item.GetParent()
  1574. });
  1575. }
  1576. catch (Exception ex)
  1577. {
  1578. _logger.LogError(ex, "Error in ItemAdded event handler");
  1579. }
  1580. }
  1581. }
  1582. }
  1583. private bool ImageNeedsRefresh(ItemImageInfo image)
  1584. {
  1585. if (image.Path != null && image.IsLocalFile)
  1586. {
  1587. if (image.Width == 0 || image.Height == 0 || string.IsNullOrEmpty(image.BlurHash))
  1588. {
  1589. return true;
  1590. }
  1591. try
  1592. {
  1593. return _fileSystem.GetLastWriteTimeUtc(image.Path) != image.DateModified;
  1594. }
  1595. catch (Exception ex)
  1596. {
  1597. _logger.LogError(ex, "Cannot get file info for {0}", image.Path);
  1598. return false;
  1599. }
  1600. }
  1601. return image.Path != null && !image.IsLocalFile;
  1602. }
  1603. /// <inheritdoc />
  1604. public async Task UpdateImagesAsync(BaseItem item, bool forceUpdate = false)
  1605. {
  1606. if (item == null)
  1607. {
  1608. throw new ArgumentNullException(nameof(item));
  1609. }
  1610. var outdated = forceUpdate ? item.ImageInfos.Where(i => i.Path != null).ToArray() : item.ImageInfos.Where(ImageNeedsRefresh).ToArray();
  1611. // Skip image processing if current or live tv source
  1612. if (outdated.Length == 0 || item.SourceType != SourceType.Library)
  1613. {
  1614. RegisterItem(item);
  1615. return;
  1616. }
  1617. foreach (var img in outdated)
  1618. {
  1619. var image = img;
  1620. if (!img.IsLocalFile)
  1621. {
  1622. try
  1623. {
  1624. var index = item.GetImageIndex(img);
  1625. image = await ConvertImageToLocal(item, img, index).ConfigureAwait(false);
  1626. }
  1627. catch (ArgumentException)
  1628. {
  1629. _logger.LogWarning("Cannot get image index for {0}", img.Path);
  1630. continue;
  1631. }
  1632. catch (InvalidOperationException)
  1633. {
  1634. _logger.LogWarning("Cannot fetch image from {0}", img.Path);
  1635. continue;
  1636. }
  1637. }
  1638. try
  1639. {
  1640. ImageDimensions size = _imageProcessor.GetImageDimensions(item, image);
  1641. image.Width = size.Width;
  1642. image.Height = size.Height;
  1643. }
  1644. catch (Exception ex)
  1645. {
  1646. _logger.LogError(ex, "Cannot get image dimensions for {0}", image.Path);
  1647. image.Width = 0;
  1648. image.Height = 0;
  1649. continue;
  1650. }
  1651. try
  1652. {
  1653. image.BlurHash = _imageProcessor.GetImageBlurHash(image.Path);
  1654. }
  1655. catch (Exception ex)
  1656. {
  1657. _logger.LogError(ex, "Cannot compute blurhash for {0}", image.Path);
  1658. image.BlurHash = string.Empty;
  1659. }
  1660. try
  1661. {
  1662. image.DateModified = _fileSystem.GetLastWriteTimeUtc(image.Path);
  1663. }
  1664. catch (Exception ex)
  1665. {
  1666. _logger.LogError(ex, "Cannot update DateModified for {0}", image.Path);
  1667. }
  1668. }
  1669. _itemRepository.SaveImages(item);
  1670. RegisterItem(item);
  1671. }
  1672. /// <inheritdoc />
  1673. public async Task UpdateItemsAsync(IReadOnlyList<BaseItem> items, BaseItem parent, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1674. {
  1675. foreach (var item in items)
  1676. {
  1677. await RunMetadataSavers(item, updateReason).ConfigureAwait(false);
  1678. }
  1679. _itemRepository.SaveItems(items, cancellationToken);
  1680. if (ItemUpdated != null)
  1681. {
  1682. foreach (var item in items)
  1683. {
  1684. // With the live tv guide this just creates too much noise
  1685. if (item.SourceType != SourceType.Library)
  1686. {
  1687. continue;
  1688. }
  1689. try
  1690. {
  1691. ItemUpdated(
  1692. this,
  1693. new ItemChangeEventArgs
  1694. {
  1695. Item = item,
  1696. Parent = parent,
  1697. UpdateReason = updateReason
  1698. });
  1699. }
  1700. catch (Exception ex)
  1701. {
  1702. _logger.LogError(ex, "Error in ItemUpdated event handler");
  1703. }
  1704. }
  1705. }
  1706. }
  1707. /// <inheritdoc />
  1708. public Task UpdateItemAsync(BaseItem item, BaseItem parent, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1709. => UpdateItemsAsync(new[] { item }, parent, updateReason, cancellationToken);
  1710. public Task RunMetadataSavers(BaseItem item, ItemUpdateType updateReason)
  1711. {
  1712. if (item.IsFileProtocol)
  1713. {
  1714. ProviderManager.SaveMetadata(item, updateReason);
  1715. }
  1716. item.DateLastSaved = DateTime.UtcNow;
  1717. return UpdateImagesAsync(item, updateReason >= ItemUpdateType.ImageUpdate);
  1718. }
  1719. /// <summary>
  1720. /// Reports the item removed.
  1721. /// </summary>
  1722. /// <param name="item">The item.</param>
  1723. /// <param name="parent">The parent item.</param>
  1724. public void ReportItemRemoved(BaseItem item, BaseItem parent)
  1725. {
  1726. if (ItemRemoved != null)
  1727. {
  1728. try
  1729. {
  1730. ItemRemoved(
  1731. this,
  1732. new ItemChangeEventArgs
  1733. {
  1734. Item = item,
  1735. Parent = parent
  1736. });
  1737. }
  1738. catch (Exception ex)
  1739. {
  1740. _logger.LogError(ex, "Error in ItemRemoved event handler");
  1741. }
  1742. }
  1743. }
  1744. /// <summary>
  1745. /// Retrieves the item.
  1746. /// </summary>
  1747. /// <param name="id">The id.</param>
  1748. /// <returns>BaseItem.</returns>
  1749. public BaseItem RetrieveItem(Guid id)
  1750. {
  1751. return _itemRepository.RetrieveItem(id);
  1752. }
  1753. public List<Folder> GetCollectionFolders(BaseItem item)
  1754. {
  1755. while (item != null)
  1756. {
  1757. var parent = item.GetParent();
  1758. if (parent == null || parent is AggregateFolder)
  1759. {
  1760. break;
  1761. }
  1762. item = parent;
  1763. }
  1764. if (item == null)
  1765. {
  1766. return new List<Folder>();
  1767. }
  1768. return GetCollectionFoldersInternal(item, GetUserRootFolder().Children.OfType<Folder>().ToList());
  1769. }
  1770. public List<Folder> GetCollectionFolders(BaseItem item, List<Folder> allUserRootChildren)
  1771. {
  1772. while (item != null)
  1773. {
  1774. var parent = item.GetParent();
  1775. if (parent == null || parent is AggregateFolder)
  1776. {
  1777. break;
  1778. }
  1779. item = parent;
  1780. }
  1781. if (item == null)
  1782. {
  1783. return new List<Folder>();
  1784. }
  1785. return GetCollectionFoldersInternal(item, allUserRootChildren);
  1786. }
  1787. private static List<Folder> GetCollectionFoldersInternal(BaseItem item, List<Folder> allUserRootChildren)
  1788. {
  1789. return allUserRootChildren
  1790. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path, StringComparer.OrdinalIgnoreCase))
  1791. .ToList();
  1792. }
  1793. public LibraryOptions GetLibraryOptions(BaseItem item)
  1794. {
  1795. if (!(item is CollectionFolder collectionFolder))
  1796. {
  1797. collectionFolder = GetCollectionFolders(item)
  1798. .OfType<CollectionFolder>()
  1799. .FirstOrDefault();
  1800. }
  1801. return collectionFolder == null ? new LibraryOptions() : collectionFolder.GetLibraryOptions();
  1802. }
  1803. public string GetContentType(BaseItem item)
  1804. {
  1805. string configuredContentType = GetConfiguredContentType(item, false);
  1806. if (!string.IsNullOrEmpty(configuredContentType))
  1807. {
  1808. return configuredContentType;
  1809. }
  1810. configuredContentType = GetConfiguredContentType(item, true);
  1811. if (!string.IsNullOrEmpty(configuredContentType))
  1812. {
  1813. return configuredContentType;
  1814. }
  1815. return GetInheritedContentType(item);
  1816. }
  1817. public string GetInheritedContentType(BaseItem item)
  1818. {
  1819. var type = GetTopFolderContentType(item);
  1820. if (!string.IsNullOrEmpty(type))
  1821. {
  1822. return type;
  1823. }
  1824. return item.GetParents()
  1825. .Select(GetConfiguredContentType)
  1826. .LastOrDefault(i => !string.IsNullOrEmpty(i));
  1827. }
  1828. public string GetConfiguredContentType(BaseItem item)
  1829. {
  1830. return GetConfiguredContentType(item, false);
  1831. }
  1832. public string GetConfiguredContentType(string path)
  1833. {
  1834. return GetContentTypeOverride(path, false);
  1835. }
  1836. public string GetConfiguredContentType(BaseItem item, bool inheritConfiguredPath)
  1837. {
  1838. if (item is ICollectionFolder collectionFolder)
  1839. {
  1840. return collectionFolder.CollectionType;
  1841. }
  1842. return GetContentTypeOverride(item.ContainingFolderPath, inheritConfiguredPath);
  1843. }
  1844. private string GetContentTypeOverride(string path, bool inherit)
  1845. {
  1846. var nameValuePair = _configurationManager.Configuration.ContentTypes
  1847. .FirstOrDefault(i => _fileSystem.AreEqual(i.Name, path)
  1848. || (inherit && !string.IsNullOrEmpty(i.Name)
  1849. && _fileSystem.ContainsSubPath(i.Name, path)));
  1850. return nameValuePair?.Value;
  1851. }
  1852. private string GetTopFolderContentType(BaseItem item)
  1853. {
  1854. if (item == null)
  1855. {
  1856. return null;
  1857. }
  1858. while (!item.ParentId.Equals(Guid.Empty))
  1859. {
  1860. var parent = item.GetParent();
  1861. if (parent == null || parent is AggregateFolder)
  1862. {
  1863. break;
  1864. }
  1865. item = parent;
  1866. }
  1867. return GetUserRootFolder().Children
  1868. .OfType<ICollectionFolder>()
  1869. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path))
  1870. .Select(i => i.CollectionType)
  1871. .FirstOrDefault(i => !string.IsNullOrEmpty(i));
  1872. }
  1873. public UserView GetNamedView(
  1874. User user,
  1875. string name,
  1876. string viewType,
  1877. string sortName)
  1878. {
  1879. return GetNamedView(user, name, Guid.Empty, viewType, sortName);
  1880. }
  1881. public UserView GetNamedView(
  1882. string name,
  1883. string viewType,
  1884. string sortName)
  1885. {
  1886. var path = Path.Combine(
  1887. _configurationManager.ApplicationPaths.InternalMetadataPath,
  1888. "views",
  1889. _fileSystem.GetValidFilename(viewType));
  1890. var id = GetNewItemId(path + "_namedview_" + name, typeof(UserView));
  1891. var item = GetItemById(id) as UserView;
  1892. var refresh = false;
  1893. if (item == null || !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1894. {
  1895. Directory.CreateDirectory(path);
  1896. item = new UserView
  1897. {
  1898. Path = path,
  1899. Id = id,
  1900. DateCreated = DateTime.UtcNow,
  1901. Name = name,
  1902. ViewType = viewType,
  1903. ForcedSortName = sortName
  1904. };
  1905. CreateItem(item, null);
  1906. refresh = true;
  1907. }
  1908. if (refresh)
  1909. {
  1910. item.UpdateToRepositoryAsync(ItemUpdateType.MetadataImport, CancellationToken.None).GetAwaiter().GetResult();
  1911. ProviderManager.QueueRefresh(item.Id, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), RefreshPriority.Normal);
  1912. }
  1913. return item;
  1914. }
  1915. public UserView GetNamedView(
  1916. User user,
  1917. string name,
  1918. Guid parentId,
  1919. string viewType,
  1920. string sortName)
  1921. {
  1922. var parentIdString = parentId.Equals(Guid.Empty) ? null : parentId.ToString("N", CultureInfo.InvariantCulture);
  1923. var idValues = "38_namedview_" + name + user.Id.ToString("N", CultureInfo.InvariantCulture) + (parentIdString ?? string.Empty) + (viewType ?? string.Empty);
  1924. var id = GetNewItemId(idValues, typeof(UserView));
  1925. var path = Path.Combine(_configurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N", CultureInfo.InvariantCulture));
  1926. var item = GetItemById(id) as UserView;
  1927. var isNew = false;
  1928. if (item == null)
  1929. {
  1930. Directory.CreateDirectory(path);
  1931. item = new UserView
  1932. {
  1933. Path = path,
  1934. Id = id,
  1935. DateCreated = DateTime.UtcNow,
  1936. Name = name,
  1937. ViewType = viewType,
  1938. ForcedSortName = sortName,
  1939. UserId = user.Id,
  1940. DisplayParentId = parentId
  1941. };
  1942. CreateItem(item, null);
  1943. isNew = true;
  1944. }
  1945. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1946. if (!refresh && !item.DisplayParentId.Equals(Guid.Empty))
  1947. {
  1948. var displayParent = GetItemById(item.DisplayParentId);
  1949. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1950. }
  1951. if (refresh)
  1952. {
  1953. ProviderManager.QueueRefresh(
  1954. item.Id,
  1955. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  1956. {
  1957. // Need to force save to increment DateLastSaved
  1958. ForceSave = true
  1959. },
  1960. RefreshPriority.Normal);
  1961. }
  1962. return item;
  1963. }
  1964. public UserView GetShadowView(
  1965. BaseItem parent,
  1966. string viewType,
  1967. string sortName)
  1968. {
  1969. if (parent == null)
  1970. {
  1971. throw new ArgumentNullException(nameof(parent));
  1972. }
  1973. var name = parent.Name;
  1974. var parentId = parent.Id;
  1975. var idValues = "38_namedview_" + name + parentId + (viewType ?? string.Empty);
  1976. var id = GetNewItemId(idValues, typeof(UserView));
  1977. var path = parent.Path;
  1978. var item = GetItemById(id) as UserView;
  1979. var isNew = false;
  1980. if (item == null)
  1981. {
  1982. Directory.CreateDirectory(path);
  1983. item = new UserView
  1984. {
  1985. Path = path,
  1986. Id = id,
  1987. DateCreated = DateTime.UtcNow,
  1988. Name = name,
  1989. ViewType = viewType,
  1990. ForcedSortName = sortName
  1991. };
  1992. item.DisplayParentId = parentId;
  1993. CreateItem(item, null);
  1994. isNew = true;
  1995. }
  1996. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1997. if (!refresh && !item.DisplayParentId.Equals(Guid.Empty))
  1998. {
  1999. var displayParent = GetItemById(item.DisplayParentId);
  2000. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  2001. }
  2002. if (refresh)
  2003. {
  2004. ProviderManager.QueueRefresh(
  2005. item.Id,
  2006. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  2007. {
  2008. // Need to force save to increment DateLastSaved
  2009. ForceSave = true
  2010. },
  2011. RefreshPriority.Normal);
  2012. }
  2013. return item;
  2014. }
  2015. public UserView GetNamedView(
  2016. string name,
  2017. Guid parentId,
  2018. string viewType,
  2019. string sortName,
  2020. string uniqueId)
  2021. {
  2022. if (string.IsNullOrEmpty(name))
  2023. {
  2024. throw new ArgumentNullException(nameof(name));
  2025. }
  2026. var parentIdString = parentId.Equals(Guid.Empty) ? null : parentId.ToString("N", CultureInfo.InvariantCulture);
  2027. var idValues = "37_namedview_" + name + (parentIdString ?? string.Empty) + (viewType ?? string.Empty);
  2028. if (!string.IsNullOrEmpty(uniqueId))
  2029. {
  2030. idValues += uniqueId;
  2031. }
  2032. var id = GetNewItemId(idValues, typeof(UserView));
  2033. var path = Path.Combine(_configurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N", CultureInfo.InvariantCulture));
  2034. var item = GetItemById(id) as UserView;
  2035. var isNew = false;
  2036. if (item == null)
  2037. {
  2038. Directory.CreateDirectory(path);
  2039. item = new UserView
  2040. {
  2041. Path = path,
  2042. Id = id,
  2043. DateCreated = DateTime.UtcNow,
  2044. Name = name,
  2045. ViewType = viewType,
  2046. ForcedSortName = sortName
  2047. };
  2048. item.DisplayParentId = parentId;
  2049. CreateItem(item, null);
  2050. isNew = true;
  2051. }
  2052. if (!string.Equals(viewType, item.ViewType, StringComparison.OrdinalIgnoreCase))
  2053. {
  2054. item.ViewType = viewType;
  2055. item.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).GetAwaiter().GetResult();
  2056. }
  2057. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  2058. if (!refresh && !item.DisplayParentId.Equals(Guid.Empty))
  2059. {
  2060. var displayParent = GetItemById(item.DisplayParentId);
  2061. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  2062. }
  2063. if (refresh)
  2064. {
  2065. ProviderManager.QueueRefresh(
  2066. item.Id,
  2067. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  2068. {
  2069. // Need to force save to increment DateLastSaved
  2070. ForceSave = true
  2071. },
  2072. RefreshPriority.Normal);
  2073. }
  2074. return item;
  2075. }
  2076. public void AddExternalSubtitleStreams(
  2077. List<MediaStream> streams,
  2078. string videoPath,
  2079. string[] files)
  2080. {
  2081. new SubtitleResolver(BaseItem.LocalizationManager).AddExternalSubtitleStreams(streams, videoPath, streams.Count, files);
  2082. }
  2083. public BaseItem GetParentItem(string parentId, Guid? userId)
  2084. {
  2085. if (string.IsNullOrEmpty(parentId))
  2086. {
  2087. return GetParentItem((Guid?)null, userId);
  2088. }
  2089. return GetParentItem(new Guid(parentId), userId);
  2090. }
  2091. public BaseItem GetParentItem(Guid? parentId, Guid? userId)
  2092. {
  2093. if (parentId.HasValue)
  2094. {
  2095. return GetItemById(parentId.Value);
  2096. }
  2097. if (userId.HasValue && userId != Guid.Empty)
  2098. {
  2099. return GetUserRootFolder();
  2100. }
  2101. return RootFolder;
  2102. }
  2103. /// <inheritdoc />
  2104. public bool IsVideoFile(string path)
  2105. {
  2106. var resolver = new VideoResolver(GetNamingOptions());
  2107. return resolver.IsVideoFile(path);
  2108. }
  2109. /// <inheritdoc />
  2110. public bool IsAudioFile(string path)
  2111. => AudioFileParser.IsAudioFile(path, GetNamingOptions());
  2112. /// <inheritdoc />
  2113. public int? GetSeasonNumberFromPath(string path)
  2114. => SeasonPathParser.Parse(path, true, true).SeasonNumber;
  2115. /// <inheritdoc />
  2116. public bool FillMissingEpisodeNumbersFromPath(Episode episode, bool forceRefresh)
  2117. {
  2118. var series = episode.Series;
  2119. bool? isAbsoluteNaming = series != null && string.Equals(series.DisplayOrder, "absolute", StringComparison.OrdinalIgnoreCase);
  2120. if (!isAbsoluteNaming.Value)
  2121. {
  2122. // In other words, no filter applied
  2123. isAbsoluteNaming = null;
  2124. }
  2125. var resolver = new EpisodeResolver(GetNamingOptions());
  2126. var isFolder = episode.VideoType == VideoType.BluRay || episode.VideoType == VideoType.Dvd;
  2127. // TODO nullable - what are we trying to do there with empty episodeInfo?
  2128. EpisodeInfo episodeInfo = null;
  2129. if (episode.IsFileProtocol)
  2130. {
  2131. episodeInfo = resolver.Resolve(episode.Path, isFolder, null, null, isAbsoluteNaming);
  2132. // Resolve from parent folder if it's not the Season folder
  2133. if (episodeInfo == null && episode.Parent.GetType() == typeof(Folder))
  2134. {
  2135. episodeInfo = resolver.Resolve(episode.Parent.Path, true, null, null, isAbsoluteNaming);
  2136. if (episodeInfo != null)
  2137. {
  2138. // add the container
  2139. episodeInfo.Container = Path.GetExtension(episode.Path)?.TrimStart('.');
  2140. }
  2141. }
  2142. }
  2143. episodeInfo ??= new EpisodeInfo(episode.Path);
  2144. try
  2145. {
  2146. var libraryOptions = GetLibraryOptions(episode);
  2147. if (libraryOptions.EnableEmbeddedEpisodeInfos && string.Equals(episodeInfo.Container, "mp4", StringComparison.OrdinalIgnoreCase))
  2148. {
  2149. // Read from metadata
  2150. var mediaInfo = _mediaEncoder.GetMediaInfo(
  2151. new MediaInfoRequest
  2152. {
  2153. MediaSource = episode.GetMediaSources(false)[0],
  2154. MediaType = DlnaProfileType.Video
  2155. },
  2156. CancellationToken.None).GetAwaiter().GetResult();
  2157. if (mediaInfo.ParentIndexNumber > 0)
  2158. {
  2159. episodeInfo.SeasonNumber = mediaInfo.ParentIndexNumber;
  2160. }
  2161. if (mediaInfo.IndexNumber > 0)
  2162. {
  2163. episodeInfo.EpisodeNumber = mediaInfo.IndexNumber;
  2164. }
  2165. if (!string.IsNullOrEmpty(mediaInfo.ShowName))
  2166. {
  2167. episodeInfo.SeriesName = mediaInfo.ShowName;
  2168. }
  2169. }
  2170. }
  2171. catch (Exception ex)
  2172. {
  2173. _logger.LogError(ex, "Error reading the episode informations with ffprobe. Episode: {EpisodeInfo}", episodeInfo.Path);
  2174. }
  2175. var changed = false;
  2176. if (episodeInfo.IsByDate)
  2177. {
  2178. if (episode.IndexNumber.HasValue)
  2179. {
  2180. episode.IndexNumber = null;
  2181. changed = true;
  2182. }
  2183. if (episode.IndexNumberEnd.HasValue)
  2184. {
  2185. episode.IndexNumberEnd = null;
  2186. changed = true;
  2187. }
  2188. if (!episode.PremiereDate.HasValue)
  2189. {
  2190. if (episodeInfo.Year.HasValue && episodeInfo.Month.HasValue && episodeInfo.Day.HasValue)
  2191. {
  2192. episode.PremiereDate = new DateTime(episodeInfo.Year.Value, episodeInfo.Month.Value, episodeInfo.Day.Value).ToUniversalTime();
  2193. }
  2194. if (episode.PremiereDate.HasValue)
  2195. {
  2196. changed = true;
  2197. }
  2198. }
  2199. if (!episode.ProductionYear.HasValue)
  2200. {
  2201. episode.ProductionYear = episodeInfo.Year;
  2202. if (episode.ProductionYear.HasValue)
  2203. {
  2204. changed = true;
  2205. }
  2206. }
  2207. }
  2208. else
  2209. {
  2210. if (!episode.IndexNumber.HasValue || forceRefresh)
  2211. {
  2212. if (episode.IndexNumber != episodeInfo.EpisodeNumber)
  2213. {
  2214. changed = true;
  2215. }
  2216. episode.IndexNumber = episodeInfo.EpisodeNumber;
  2217. }
  2218. if (!episode.IndexNumberEnd.HasValue || forceRefresh)
  2219. {
  2220. if (episode.IndexNumberEnd != episodeInfo.EndingEpisodeNumber)
  2221. {
  2222. changed = true;
  2223. }
  2224. episode.IndexNumberEnd = episodeInfo.EndingEpisodeNumber;
  2225. }
  2226. if (!episode.ParentIndexNumber.HasValue || forceRefresh)
  2227. {
  2228. if (episode.ParentIndexNumber != episodeInfo.SeasonNumber)
  2229. {
  2230. changed = true;
  2231. }
  2232. episode.ParentIndexNumber = episodeInfo.SeasonNumber;
  2233. }
  2234. }
  2235. if (!episode.ParentIndexNumber.HasValue)
  2236. {
  2237. var season = episode.Season;
  2238. if (season != null)
  2239. {
  2240. episode.ParentIndexNumber = season.IndexNumber;
  2241. }
  2242. else
  2243. {
  2244. /*
  2245. Anime series don't generally have a season in their file name, however,
  2246. tvdb needs a season to correctly get the metadata.
  2247. Hence, a null season needs to be filled with something. */
  2248. // FIXME perhaps this would be better for tvdb parser to ask for season 1 if no season is specified
  2249. episode.ParentIndexNumber = 1;
  2250. }
  2251. if (episode.ParentIndexNumber.HasValue)
  2252. {
  2253. changed = true;
  2254. }
  2255. }
  2256. return changed;
  2257. }
  2258. public NamingOptions GetNamingOptions()
  2259. {
  2260. if (_namingOptions == null)
  2261. {
  2262. _namingOptions = new NamingOptions();
  2263. _videoFileExtensions = _namingOptions.VideoFileExtensions;
  2264. }
  2265. return _namingOptions;
  2266. }
  2267. public ItemLookupInfo ParseName(string name)
  2268. {
  2269. var resolver = new VideoResolver(GetNamingOptions());
  2270. var result = resolver.CleanDateTime(name);
  2271. return new ItemLookupInfo
  2272. {
  2273. Name = resolver.TryCleanString(result.Name, out var newName) ? newName.ToString() : result.Name,
  2274. Year = result.Year
  2275. };
  2276. }
  2277. public IEnumerable<Video> FindTrailers(BaseItem owner, List<FileSystemMetadata> fileSystemChildren, IDirectoryService directoryService)
  2278. {
  2279. var namingOptions = GetNamingOptions();
  2280. var files = owner.IsInMixedFolder ? new List<FileSystemMetadata>() : fileSystemChildren.Where(i => i.IsDirectory)
  2281. .Where(i => string.Equals(i.Name, BaseItem.TrailerFolderName, StringComparison.OrdinalIgnoreCase))
  2282. .SelectMany(i => _fileSystem.GetFiles(i.FullName, _videoFileExtensions, false, false))
  2283. .ToList();
  2284. var videoListResolver = new VideoListResolver(namingOptions);
  2285. var videos = videoListResolver.Resolve(fileSystemChildren);
  2286. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files[0].Path, StringComparison.OrdinalIgnoreCase));
  2287. if (currentVideo != null)
  2288. {
  2289. files.AddRange(currentVideo.Extras.Where(i => i.ExtraType == ExtraType.Trailer).Select(i => _fileSystem.GetFileInfo(i.Path)));
  2290. }
  2291. var resolvers = new IItemResolver[]
  2292. {
  2293. new GenericVideoResolver<Trailer>(this)
  2294. };
  2295. return ResolvePaths(files, directoryService, null, new LibraryOptions(), null, resolvers)
  2296. .OfType<Trailer>()
  2297. .Select(video =>
  2298. {
  2299. // Try to retrieve it from the db. If we don't find it, use the resolved version
  2300. if (GetItemById(video.Id) is Trailer dbItem)
  2301. {
  2302. video = dbItem;
  2303. }
  2304. video.ParentId = Guid.Empty;
  2305. video.OwnerId = owner.Id;
  2306. video.ExtraType = ExtraType.Trailer;
  2307. video.TrailerTypes = new[] { TrailerType.LocalTrailer };
  2308. return video;
  2309. // Sort them so that the list can be easily compared for changes
  2310. }).OrderBy(i => i.Path);
  2311. }
  2312. public IEnumerable<Video> FindExtras(BaseItem owner, List<FileSystemMetadata> fileSystemChildren, IDirectoryService directoryService)
  2313. {
  2314. var namingOptions = GetNamingOptions();
  2315. var files = owner.IsInMixedFolder ? new List<FileSystemMetadata>() : fileSystemChildren.Where(i => i.IsDirectory)
  2316. .Where(i => BaseItem.AllExtrasTypesFolderNames.Contains(i.Name ?? string.Empty, StringComparer.OrdinalIgnoreCase))
  2317. .SelectMany(i => _fileSystem.GetFiles(i.FullName, _videoFileExtensions, false, false))
  2318. .ToList();
  2319. var videoListResolver = new VideoListResolver(namingOptions);
  2320. var videos = videoListResolver.Resolve(fileSystemChildren);
  2321. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files[0].Path, StringComparison.OrdinalIgnoreCase));
  2322. if (currentVideo != null)
  2323. {
  2324. files.AddRange(currentVideo.Extras.Where(i => i.ExtraType != ExtraType.Trailer).Select(i => _fileSystem.GetFileInfo(i.Path)));
  2325. }
  2326. return ResolvePaths(files, directoryService, null, new LibraryOptions(), null)
  2327. .OfType<Video>()
  2328. .Select(video =>
  2329. {
  2330. // Try to retrieve it from the db. If we don't find it, use the resolved version
  2331. var dbItem = GetItemById(video.Id) as Video;
  2332. if (dbItem != null)
  2333. {
  2334. video = dbItem;
  2335. }
  2336. video.ParentId = Guid.Empty;
  2337. video.OwnerId = owner.Id;
  2338. SetExtraTypeFromFilename(video);
  2339. return video;
  2340. // Sort them so that the list can be easily compared for changes
  2341. }).OrderBy(i => i.Path);
  2342. }
  2343. public string GetPathAfterNetworkSubstitution(string path, BaseItem ownerItem)
  2344. {
  2345. string newPath;
  2346. if (ownerItem != null)
  2347. {
  2348. var libraryOptions = GetLibraryOptions(ownerItem);
  2349. if (libraryOptions != null)
  2350. {
  2351. foreach (var pathInfo in libraryOptions.PathInfos)
  2352. {
  2353. if (path.TryReplaceSubPath(pathInfo.Path, pathInfo.NetworkPath, out newPath))
  2354. {
  2355. return newPath;
  2356. }
  2357. }
  2358. }
  2359. }
  2360. var metadataPath = _configurationManager.Configuration.MetadataPath;
  2361. var metadataNetworkPath = _configurationManager.Configuration.MetadataNetworkPath;
  2362. if (path.TryReplaceSubPath(metadataPath, metadataNetworkPath, out newPath))
  2363. {
  2364. return newPath;
  2365. }
  2366. foreach (var map in _configurationManager.Configuration.PathSubstitutions)
  2367. {
  2368. if (path.TryReplaceSubPath(map.From, map.To, out newPath))
  2369. {
  2370. return newPath;
  2371. }
  2372. }
  2373. return path;
  2374. }
  2375. public string SubstitutePath(string path, string from, string to)
  2376. {
  2377. if (path.TryReplaceSubPath(from, to, out var newPath))
  2378. {
  2379. return newPath;
  2380. }
  2381. return path;
  2382. }
  2383. private void SetExtraTypeFromFilename(Video item)
  2384. {
  2385. var resolver = new ExtraResolver(GetNamingOptions());
  2386. var result = resolver.GetExtraInfo(item.Path);
  2387. item.ExtraType = result.ExtraType;
  2388. }
  2389. public List<PersonInfo> GetPeople(InternalPeopleQuery query)
  2390. {
  2391. return _itemRepository.GetPeople(query);
  2392. }
  2393. public List<PersonInfo> GetPeople(BaseItem item)
  2394. {
  2395. if (item.SupportsPeople)
  2396. {
  2397. var people = GetPeople(new InternalPeopleQuery
  2398. {
  2399. ItemId = item.Id
  2400. });
  2401. if (people.Count > 0)
  2402. {
  2403. return people;
  2404. }
  2405. }
  2406. return new List<PersonInfo>();
  2407. }
  2408. public List<Person> GetPeopleItems(InternalPeopleQuery query)
  2409. {
  2410. return _itemRepository.GetPeopleNames(query).Select(i =>
  2411. {
  2412. try
  2413. {
  2414. return GetPerson(i);
  2415. }
  2416. catch (Exception ex)
  2417. {
  2418. _logger.LogError(ex, "Error getting person");
  2419. return null;
  2420. }
  2421. }).Where(i => i != null).ToList();
  2422. }
  2423. public List<string> GetPeopleNames(InternalPeopleQuery query)
  2424. {
  2425. return _itemRepository.GetPeopleNames(query);
  2426. }
  2427. public void UpdatePeople(BaseItem item, List<PersonInfo> people)
  2428. {
  2429. if (!item.SupportsPeople)
  2430. {
  2431. return;
  2432. }
  2433. _itemRepository.UpdatePeople(item.Id, people);
  2434. }
  2435. public async Task<ItemImageInfo> ConvertImageToLocal(BaseItem item, ItemImageInfo image, int imageIndex)
  2436. {
  2437. foreach (var url in image.Path.Split('|'))
  2438. {
  2439. try
  2440. {
  2441. _logger.LogDebug("ConvertImageToLocal item {0} - image url: {1}", item.Id, url);
  2442. await ProviderManager.SaveImage(item, url, image.Type, imageIndex, CancellationToken.None).ConfigureAwait(false);
  2443. await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2444. return item.GetImageInfo(image.Type, imageIndex);
  2445. }
  2446. catch (HttpRequestException ex)
  2447. {
  2448. if (ex.StatusCode.HasValue
  2449. && (ex.StatusCode.Value == HttpStatusCode.NotFound || ex.StatusCode.Value == HttpStatusCode.Forbidden))
  2450. {
  2451. continue;
  2452. }
  2453. throw;
  2454. }
  2455. }
  2456. // Remove this image to prevent it from retrying over and over
  2457. item.RemoveImage(image);
  2458. await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2459. throw new InvalidOperationException();
  2460. }
  2461. public async Task AddVirtualFolder(string name, CollectionTypeOptions? collectionType, LibraryOptions options, bool refreshLibrary)
  2462. {
  2463. if (string.IsNullOrWhiteSpace(name))
  2464. {
  2465. throw new ArgumentNullException(nameof(name));
  2466. }
  2467. name = _fileSystem.GetValidFilename(name);
  2468. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2469. var virtualFolderPath = Path.Combine(rootFolderPath, name);
  2470. while (Directory.Exists(virtualFolderPath))
  2471. {
  2472. name += "1";
  2473. virtualFolderPath = Path.Combine(rootFolderPath, name);
  2474. }
  2475. var mediaPathInfos = options.PathInfos;
  2476. if (mediaPathInfos != null)
  2477. {
  2478. var invalidpath = mediaPathInfos.FirstOrDefault(i => !Directory.Exists(i.Path));
  2479. if (invalidpath != null)
  2480. {
  2481. throw new ArgumentException("The specified path does not exist: " + invalidpath.Path + ".");
  2482. }
  2483. }
  2484. LibraryMonitor.Stop();
  2485. try
  2486. {
  2487. Directory.CreateDirectory(virtualFolderPath);
  2488. if (collectionType != null)
  2489. {
  2490. var path = Path.Combine(virtualFolderPath, collectionType.ToString().ToLowerInvariant() + ".collection");
  2491. File.WriteAllBytes(path, Array.Empty<byte>());
  2492. }
  2493. CollectionFolder.SaveLibraryOptions(virtualFolderPath, options);
  2494. if (mediaPathInfos != null)
  2495. {
  2496. foreach (var path in mediaPathInfos)
  2497. {
  2498. AddMediaPathInternal(name, path, false);
  2499. }
  2500. }
  2501. }
  2502. finally
  2503. {
  2504. if (refreshLibrary)
  2505. {
  2506. await ValidateTopLibraryFolders(CancellationToken.None).ConfigureAwait(false);
  2507. StartScanInBackground();
  2508. }
  2509. else
  2510. {
  2511. // Need to add a delay here or directory watchers may still pick up the changes
  2512. await Task.Delay(1000).ConfigureAwait(false);
  2513. LibraryMonitor.Start();
  2514. }
  2515. }
  2516. }
  2517. private void StartScanInBackground()
  2518. {
  2519. Task.Run(() =>
  2520. {
  2521. // No need to start if scanning the library because it will handle it
  2522. ValidateMediaLibrary(new SimpleProgress<double>(), CancellationToken.None);
  2523. });
  2524. }
  2525. public void AddMediaPath(string virtualFolderName, MediaPathInfo pathInfo)
  2526. {
  2527. AddMediaPathInternal(virtualFolderName, pathInfo, true);
  2528. }
  2529. private void AddMediaPathInternal(string virtualFolderName, MediaPathInfo pathInfo, bool saveLibraryOptions)
  2530. {
  2531. if (pathInfo == null)
  2532. {
  2533. throw new ArgumentNullException(nameof(pathInfo));
  2534. }
  2535. var path = pathInfo.Path;
  2536. if (string.IsNullOrWhiteSpace(path))
  2537. {
  2538. throw new ArgumentException(nameof(path));
  2539. }
  2540. if (!Directory.Exists(path))
  2541. {
  2542. throw new FileNotFoundException("The path does not exist.");
  2543. }
  2544. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2545. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2546. var shortcutFilename = Path.GetFileNameWithoutExtension(path);
  2547. var lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2548. while (File.Exists(lnk))
  2549. {
  2550. shortcutFilename += "1";
  2551. lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2552. }
  2553. _fileSystem.CreateShortcut(lnk, _appHost.ReverseVirtualPath(path));
  2554. RemoveContentTypeOverrides(path);
  2555. if (saveLibraryOptions)
  2556. {
  2557. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2558. var list = libraryOptions.PathInfos.ToList();
  2559. list.Add(pathInfo);
  2560. libraryOptions.PathInfos = list.ToArray();
  2561. SyncLibraryOptionsToLocations(virtualFolderPath, libraryOptions);
  2562. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2563. }
  2564. }
  2565. public void UpdateMediaPath(string virtualFolderName, MediaPathInfo pathInfo)
  2566. {
  2567. if (pathInfo == null)
  2568. {
  2569. throw new ArgumentNullException(nameof(pathInfo));
  2570. }
  2571. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2572. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2573. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2574. SyncLibraryOptionsToLocations(virtualFolderPath, libraryOptions);
  2575. var list = libraryOptions.PathInfos.ToList();
  2576. foreach (var originalPathInfo in list)
  2577. {
  2578. if (string.Equals(pathInfo.Path, originalPathInfo.Path, StringComparison.Ordinal))
  2579. {
  2580. originalPathInfo.NetworkPath = pathInfo.NetworkPath;
  2581. break;
  2582. }
  2583. }
  2584. libraryOptions.PathInfos = list.ToArray();
  2585. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2586. }
  2587. private void SyncLibraryOptionsToLocations(string virtualFolderPath, LibraryOptions options)
  2588. {
  2589. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  2590. var info = GetVirtualFolderInfo(virtualFolderPath, topLibraryFolders, null);
  2591. if (info.Locations.Length > 0 && info.Locations.Length != options.PathInfos.Length)
  2592. {
  2593. var list = options.PathInfos.ToList();
  2594. foreach (var location in info.Locations)
  2595. {
  2596. if (!list.Any(i => string.Equals(i.Path, location, StringComparison.Ordinal)))
  2597. {
  2598. list.Add(new MediaPathInfo
  2599. {
  2600. Path = location
  2601. });
  2602. }
  2603. }
  2604. options.PathInfos = list.ToArray();
  2605. }
  2606. }
  2607. public async Task RemoveVirtualFolder(string name, bool refreshLibrary)
  2608. {
  2609. if (string.IsNullOrWhiteSpace(name))
  2610. {
  2611. throw new ArgumentNullException(nameof(name));
  2612. }
  2613. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2614. var path = Path.Combine(rootFolderPath, name);
  2615. if (!Directory.Exists(path))
  2616. {
  2617. throw new FileNotFoundException("The media folder does not exist");
  2618. }
  2619. LibraryMonitor.Stop();
  2620. try
  2621. {
  2622. Directory.Delete(path, true);
  2623. }
  2624. finally
  2625. {
  2626. CollectionFolder.OnCollectionFolderChange();
  2627. if (refreshLibrary)
  2628. {
  2629. await ValidateTopLibraryFolders(CancellationToken.None).ConfigureAwait(false);
  2630. StartScanInBackground();
  2631. }
  2632. else
  2633. {
  2634. // Need to add a delay here or directory watchers may still pick up the changes
  2635. await Task.Delay(1000).ConfigureAwait(false);
  2636. LibraryMonitor.Start();
  2637. }
  2638. }
  2639. }
  2640. private void RemoveContentTypeOverrides(string path)
  2641. {
  2642. if (string.IsNullOrWhiteSpace(path))
  2643. {
  2644. throw new ArgumentNullException(nameof(path));
  2645. }
  2646. var removeList = new List<NameValuePair>();
  2647. foreach (var contentType in _configurationManager.Configuration.ContentTypes)
  2648. {
  2649. if (string.IsNullOrWhiteSpace(contentType.Name))
  2650. {
  2651. removeList.Add(contentType);
  2652. }
  2653. else if (_fileSystem.AreEqual(path, contentType.Name)
  2654. || _fileSystem.ContainsSubPath(path, contentType.Name))
  2655. {
  2656. removeList.Add(contentType);
  2657. }
  2658. }
  2659. if (removeList.Count > 0)
  2660. {
  2661. _configurationManager.Configuration.ContentTypes = _configurationManager.Configuration.ContentTypes
  2662. .Except(removeList)
  2663. .ToArray();
  2664. _configurationManager.SaveConfiguration();
  2665. }
  2666. }
  2667. public void RemoveMediaPath(string virtualFolderName, string mediaPath)
  2668. {
  2669. if (string.IsNullOrEmpty(mediaPath))
  2670. {
  2671. throw new ArgumentNullException(nameof(mediaPath));
  2672. }
  2673. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2674. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2675. if (!Directory.Exists(virtualFolderPath))
  2676. {
  2677. throw new FileNotFoundException(
  2678. string.Format(CultureInfo.InvariantCulture, "The media collection {0} does not exist", virtualFolderName));
  2679. }
  2680. var shortcut = _fileSystem.GetFilePaths(virtualFolderPath, true)
  2681. .Where(i => string.Equals(ShortcutFileExtension, Path.GetExtension(i), StringComparison.OrdinalIgnoreCase))
  2682. .FirstOrDefault(f => _appHost.ExpandVirtualPath(_fileSystem.ResolveShortcut(f)).Equals(mediaPath, StringComparison.OrdinalIgnoreCase));
  2683. if (!string.IsNullOrEmpty(shortcut))
  2684. {
  2685. _fileSystem.DeleteFile(shortcut);
  2686. }
  2687. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2688. libraryOptions.PathInfos = libraryOptions
  2689. .PathInfos
  2690. .Where(i => !string.Equals(i.Path, mediaPath, StringComparison.Ordinal))
  2691. .ToArray();
  2692. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2693. }
  2694. }
  2695. }