LibraryManager.cs 112 KB

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