LibraryManager.cs 108 KB

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