LibraryManager.cs 112 KB

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