LibraryManager.cs 114 KB

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