LibraryManager.cs 107 KB

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