LibraryManager.cs 107 KB

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