LibraryManager.cs 109 KB

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