LibraryManager.cs 108 KB

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