LibraryManager.cs 113 KB

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