LibraryManager.cs 109 KB

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