LibraryManager.cs 109 KB

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