ILibraryManager.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. using MediaBrowser.Controller.Entities;
  2. using MediaBrowser.Controller.Entities.Audio;
  3. using MediaBrowser.Controller.Entities.TV;
  4. using MediaBrowser.Controller.Providers;
  5. using MediaBrowser.Controller.Resolvers;
  6. using MediaBrowser.Controller.Sorting;
  7. using MediaBrowser.Model.Entities;
  8. using System;
  9. using System.Collections.Generic;
  10. using System.IO;
  11. using System.Threading;
  12. using System.Threading.Tasks;
  13. namespace MediaBrowser.Controller.Library
  14. {
  15. /// <summary>
  16. /// Interface ILibraryManager
  17. /// </summary>
  18. public interface ILibraryManager
  19. {
  20. /// <summary>
  21. /// Resolves the path.
  22. /// </summary>
  23. /// <param name="fileInfo">The file information.</param>
  24. /// <param name="parent">The parent.</param>
  25. /// <returns>BaseItem.</returns>
  26. BaseItem ResolvePath(FileSystemInfo fileInfo,
  27. Folder parent = null);
  28. /// <summary>
  29. /// Resolves a set of files into a list of BaseItem
  30. /// </summary>
  31. /// <typeparam name="T"></typeparam>
  32. /// <param name="files">The files.</param>
  33. /// <param name="directoryService">The directory service.</param>
  34. /// <param name="parent">The parent.</param>
  35. /// <param name="collectionType">Type of the collection.</param>
  36. /// <returns>List{``0}.</returns>
  37. IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemInfo> files,
  38. IDirectoryService directoryService,
  39. Folder parent, string
  40. collectionType = null);
  41. /// <summary>
  42. /// Gets the root folder.
  43. /// </summary>
  44. /// <value>The root folder.</value>
  45. AggregateFolder RootFolder { get; }
  46. /// <summary>
  47. /// Gets a Person
  48. /// </summary>
  49. /// <param name="name">The name.</param>
  50. /// <returns>Task{Person}.</returns>
  51. Person GetPerson(string name);
  52. /// <summary>
  53. /// Gets the artist.
  54. /// </summary>
  55. /// <param name="name">The name.</param>
  56. /// <returns>Task{Artist}.</returns>
  57. MusicArtist GetArtist(string name);
  58. /// <summary>
  59. /// Gets a Studio
  60. /// </summary>
  61. /// <param name="name">The name.</param>
  62. /// <returns>Task{Studio}.</returns>
  63. Studio GetStudio(string name);
  64. /// <summary>
  65. /// Gets a Genre
  66. /// </summary>
  67. /// <param name="name">The name.</param>
  68. /// <returns>Task{Genre}.</returns>
  69. Genre GetGenre(string name);
  70. /// <summary>
  71. /// Gets the genre.
  72. /// </summary>
  73. /// <param name="name">The name.</param>
  74. /// <returns>Task{MusicGenre}.</returns>
  75. MusicGenre GetMusicGenre(string name);
  76. /// <summary>
  77. /// Gets the game genre.
  78. /// </summary>
  79. /// <param name="name">The name.</param>
  80. /// <returns>Task{GameGenre}.</returns>
  81. GameGenre GetGameGenre(string name);
  82. /// <summary>
  83. /// Gets a Year
  84. /// </summary>
  85. /// <param name="value">The value.</param>
  86. /// <returns>Task{Year}.</returns>
  87. /// <exception cref="System.ArgumentOutOfRangeException"></exception>
  88. Year GetYear(int value);
  89. /// <summary>
  90. /// Validate and refresh the People sub-set of the IBN.
  91. /// The items are stored in the db but not loaded into memory until actually requested by an operation.
  92. /// </summary>
  93. /// <param name="cancellationToken">The cancellation token.</param>
  94. /// <param name="progress">The progress.</param>
  95. /// <returns>Task.</returns>
  96. Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress);
  97. /// <summary>
  98. /// Reloads the root media folder
  99. /// </summary>
  100. /// <param name="progress">The progress.</param>
  101. /// <param name="cancellationToken">The cancellation token.</param>
  102. /// <returns>Task.</returns>
  103. Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken);
  104. /// <summary>
  105. /// Queues the library scan.
  106. /// </summary>
  107. void QueueLibraryScan();
  108. /// <summary>
  109. /// Gets the default view.
  110. /// </summary>
  111. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  112. IEnumerable<VirtualFolderInfo> GetVirtualFolders();
  113. /// <summary>
  114. /// Gets the item by id.
  115. /// </summary>
  116. /// <param name="id">The id.</param>
  117. /// <returns>BaseItem.</returns>
  118. BaseItem GetItemById(Guid id);
  119. /// <summary>
  120. /// Gets the memory item by identifier.
  121. /// </summary>
  122. /// <param name="id">The identifier.</param>
  123. /// <returns>BaseItem.</returns>
  124. BaseItem GetMemoryItemById(Guid id);
  125. /// <summary>
  126. /// Gets the intros.
  127. /// </summary>
  128. /// <param name="item">The item.</param>
  129. /// <param name="user">The user.</param>
  130. /// <returns>IEnumerable{System.String}.</returns>
  131. Task<IEnumerable<Video>> GetIntros(BaseItem item, User user);
  132. /// <summary>
  133. /// Gets all intro files.
  134. /// </summary>
  135. /// <returns>IEnumerable{System.String}.</returns>
  136. IEnumerable<string> GetAllIntroFiles();
  137. /// <summary>
  138. /// Adds the parts.
  139. /// </summary>
  140. /// <param name="rules">The rules.</param>
  141. /// <param name="pluginFolders">The plugin folders.</param>
  142. /// <param name="resolvers">The resolvers.</param>
  143. /// <param name="introProviders">The intro providers.</param>
  144. /// <param name="itemComparers">The item comparers.</param>
  145. /// <param name="postscanTasks">The postscan tasks.</param>
  146. void AddParts(IEnumerable<IResolverIgnoreRule> rules,
  147. IEnumerable<IVirtualFolderCreator> pluginFolders,
  148. IEnumerable<IItemResolver> resolvers,
  149. IEnumerable<IIntroProvider> introProviders,
  150. IEnumerable<IBaseItemComparer> itemComparers,
  151. IEnumerable<ILibraryPostScanTask> postscanTasks);
  152. /// <summary>
  153. /// Sorts the specified items.
  154. /// </summary>
  155. /// <param name="items">The items.</param>
  156. /// <param name="user">The user.</param>
  157. /// <param name="sortBy">The sort by.</param>
  158. /// <param name="sortOrder">The sort order.</param>
  159. /// <returns>IEnumerable{BaseItem}.</returns>
  160. IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy,
  161. SortOrder sortOrder);
  162. /// <summary>
  163. /// Ensure supplied item has only one instance throughout
  164. /// </summary>
  165. /// <param name="item">The item.</param>
  166. /// <returns>The proper instance to the item</returns>
  167. BaseItem GetOrAddByReferenceItem(BaseItem item);
  168. /// <summary>
  169. /// Gets the user root folder.
  170. /// </summary>
  171. /// <returns>UserRootFolder.</returns>
  172. Folder GetUserRootFolder();
  173. /// <summary>
  174. /// Creates the item.
  175. /// </summary>
  176. /// <param name="item">The item.</param>
  177. /// <param name="cancellationToken">The cancellation token.</param>
  178. /// <returns>Task.</returns>
  179. Task CreateItem(BaseItem item, CancellationToken cancellationToken);
  180. /// <summary>
  181. /// Creates the items.
  182. /// </summary>
  183. /// <param name="items">The items.</param>
  184. /// <param name="cancellationToken">The cancellation token.</param>
  185. /// <returns>Task.</returns>
  186. Task CreateItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken);
  187. /// <summary>
  188. /// Updates the item.
  189. /// </summary>
  190. /// <param name="item">The item.</param>
  191. /// <param name="updateReason">The update reason.</param>
  192. /// <param name="cancellationToken">The cancellation token.</param>
  193. /// <returns>Task.</returns>
  194. Task UpdateItem(BaseItem item, ItemUpdateType updateReason, CancellationToken cancellationToken);
  195. /// <summary>
  196. /// Retrieves the item.
  197. /// </summary>
  198. /// <param name="id">The id.</param>
  199. /// <returns>BaseItem.</returns>
  200. BaseItem RetrieveItem(Guid id);
  201. /// <summary>
  202. /// Occurs when [item added].
  203. /// </summary>
  204. event EventHandler<ItemChangeEventArgs> ItemAdded;
  205. /// <summary>
  206. /// Occurs when [item updated].
  207. /// </summary>
  208. event EventHandler<ItemChangeEventArgs> ItemUpdated;
  209. /// <summary>
  210. /// Occurs when [item removed].
  211. /// </summary>
  212. event EventHandler<ItemChangeEventArgs> ItemRemoved;
  213. /// <summary>
  214. /// Reports the item removed.
  215. /// </summary>
  216. /// <param name="item">The item.</param>
  217. void ReportItemRemoved(BaseItem item);
  218. /// <summary>
  219. /// Finds the type of the collection.
  220. /// </summary>
  221. /// <param name="item">The item.</param>
  222. /// <returns>System.String.</returns>
  223. string GetContentType(BaseItem item);
  224. /// <summary>
  225. /// Gets the type of the inherited content.
  226. /// </summary>
  227. /// <param name="item">The item.</param>
  228. /// <returns>System.String.</returns>
  229. string GetInheritedContentType(BaseItem item);
  230. /// <summary>
  231. /// Gets the type of the configured content.
  232. /// </summary>
  233. /// <param name="item">The item.</param>
  234. /// <returns>System.String.</returns>
  235. string GetConfiguredContentType(BaseItem item);
  236. /// <summary>
  237. /// Gets the type of the configured content.
  238. /// </summary>
  239. /// <param name="path">The path.</param>
  240. /// <returns>System.String.</returns>
  241. string GetConfiguredContentType(string path);
  242. /// <summary>
  243. /// Normalizes the root path list.
  244. /// </summary>
  245. /// <param name="paths">The paths.</param>
  246. /// <returns>IEnumerable{System.String}.</returns>
  247. IEnumerable<string> NormalizeRootPathList(IEnumerable<string> paths);
  248. /// <summary>
  249. /// Registers the item.
  250. /// </summary>
  251. /// <param name="item">The item.</param>
  252. void RegisterItem(BaseItem item);
  253. /// <summary>
  254. /// Deletes the item.
  255. /// </summary>
  256. /// <param name="item">The item.</param>
  257. /// <param name="options">The options.</param>
  258. /// <returns>Task.</returns>
  259. Task DeleteItem(BaseItem item, DeleteOptions options);
  260. /// <summary>
  261. /// Replaces the videos with primary versions.
  262. /// </summary>
  263. /// <param name="items">The items.</param>
  264. /// <returns>IEnumerable{BaseItem}.</returns>
  265. IEnumerable<BaseItem> ReplaceVideosWithPrimaryVersions(IEnumerable<BaseItem> items);
  266. /// <summary>
  267. /// Gets the special folder.
  268. /// </summary>
  269. /// <param name="user">The user.</param>
  270. /// <param name="name">The name.</param>
  271. /// <param name="parentId">The parent identifier.</param>
  272. /// <param name="viewType">Type of the view.</param>
  273. /// <param name="sortName">Name of the sort.</param>
  274. /// <param name="cancellationToken">The cancellation token.</param>
  275. /// <returns>Task&lt;UserView&gt;.</returns>
  276. Task<UserView> GetSpecialFolder(User user,
  277. string name,
  278. string parentId,
  279. string viewType,
  280. string sortName,
  281. CancellationToken cancellationToken);
  282. /// <summary>
  283. /// Gets the named view.
  284. /// </summary>
  285. /// <param name="name">The name.</param>
  286. /// <param name="viewType">Type of the view.</param>
  287. /// <param name="sortName">Name of the sort.</param>
  288. /// <param name="cancellationToken">The cancellation token.</param>
  289. /// <returns>Task&lt;UserView&gt;.</returns>
  290. Task<UserView> GetNamedView(string name,
  291. string viewType,
  292. string sortName,
  293. CancellationToken cancellationToken);
  294. /// <summary>
  295. /// Determines whether [is video file] [the specified path].
  296. /// </summary>
  297. /// <param name="path">The path.</param>
  298. /// <returns><c>true</c> if [is video file] [the specified path]; otherwise, <c>false</c>.</returns>
  299. bool IsVideoFile(string path);
  300. /// <summary>
  301. /// Determines whether [is audio file] [the specified path].
  302. /// </summary>
  303. /// <param name="path">The path.</param>
  304. /// <returns><c>true</c> if [is audio file] [the specified path]; otherwise, <c>false</c>.</returns>
  305. bool IsAudioFile(string path);
  306. /// <summary>
  307. /// Gets the season number from path.
  308. /// </summary>
  309. /// <param name="path">The path.</param>
  310. /// <returns>System.Nullable&lt;System.Int32&gt;.</returns>
  311. int? GetSeasonNumberFromPath(string path);
  312. /// <summary>
  313. /// Fills the missing episode numbers from path.
  314. /// </summary>
  315. /// <param name="episode">The episode.</param>
  316. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
  317. bool FillMissingEpisodeNumbersFromPath(Episode episode);
  318. /// <summary>
  319. /// Parses the name.
  320. /// </summary>
  321. /// <param name="name">The name.</param>
  322. /// <returns>ItemInfo.</returns>
  323. ItemLookupInfo ParseName(string name);
  324. /// <summary>
  325. /// Gets the new item identifier.
  326. /// </summary>
  327. /// <param name="key">The key.</param>
  328. /// <param name="type">The type.</param>
  329. /// <returns>Guid.</returns>
  330. Guid GetNewItemId(string key, Type type);
  331. /// <summary>
  332. /// Finds the trailers.
  333. /// </summary>
  334. /// <param name="owner">The owner.</param>
  335. /// <param name="fileSystemChildren">The file system children.</param>
  336. /// <param name="directoryService">The directory service.</param>
  337. /// <returns>IEnumerable&lt;Trailer&gt;.</returns>
  338. IEnumerable<Video> FindTrailers(BaseItem owner, List<FileSystemInfo> fileSystemChildren,
  339. IDirectoryService directoryService);
  340. /// <summary>
  341. /// Finds the extras.
  342. /// </summary>
  343. /// <param name="owner">The owner.</param>
  344. /// <param name="fileSystemChildren">The file system children.</param>
  345. /// <param name="directoryService">The directory service.</param>
  346. /// <returns>IEnumerable&lt;Video&gt;.</returns>
  347. IEnumerable<Video> FindExtras(BaseItem owner, List<FileSystemInfo> fileSystemChildren,
  348. IDirectoryService directoryService);
  349. /// <summary>
  350. /// Gets the collection folders.
  351. /// </summary>
  352. /// <param name="item">The item.</param>
  353. /// <returns>IEnumerable&lt;Folder&gt;.</returns>
  354. IEnumerable<Folder> GetCollectionFolders(BaseItem item);
  355. }
  356. }