diff options
Diffstat (limited to 'MediaBrowser.Controller/Persistence')
6 files changed, 187 insertions, 203 deletions
diff --git a/MediaBrowser.Controller/Persistence/IItemRepository.cs b/MediaBrowser.Controller/Persistence/IItemRepository.cs index 2c52b2b45..b27f156ef 100644 --- a/MediaBrowser.Controller/Persistence/IItemRepository.cs +++ b/MediaBrowser.Controller/Persistence/IItemRepository.cs @@ -7,157 +7,82 @@ using System.Collections.Generic; using System.Threading; using MediaBrowser.Controller.Entities; using MediaBrowser.Model.Dto; -using MediaBrowser.Model.Entities; using MediaBrowser.Model.Querying; -namespace MediaBrowser.Controller.Persistence +namespace MediaBrowser.Controller.Persistence; + +/// <summary> +/// Provides an interface to implement an Item repository. +/// </summary> +public interface IItemRepository : IDisposable { /// <summary> - /// Provides an interface to implement an Item repository. + /// Deletes the item. + /// </summary> + /// <param name="id">The identifier.</param> + void DeleteItem(Guid id); + + /// <summary> + /// Saves the items. + /// </summary> + /// <param name="items">The items.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void SaveItems(IReadOnlyList<BaseItem> items, CancellationToken cancellationToken); + + void SaveImages(BaseItem item); + + /// <summary> + /// Retrieves the item. /// </summary> - public interface IItemRepository : IDisposable - { - /// <summary> - /// Deletes the item. - /// </summary> - /// <param name="id">The identifier.</param> - void DeleteItem(Guid id); - - /// <summary> - /// Saves the items. - /// </summary> - /// <param name="items">The items.</param> - /// <param name="cancellationToken">The cancellation token.</param> - void SaveItems(IReadOnlyList<BaseItem> items, CancellationToken cancellationToken); - - void SaveImages(BaseItem item); - - /// <summary> - /// Retrieves the item. - /// </summary> - /// <param name="id">The id.</param> - /// <returns>BaseItem.</returns> - BaseItem RetrieveItem(Guid id); - - /// <summary> - /// Gets chapters for an item. - /// </summary> - /// <param name="item">The item.</param> - /// <returns>The list of chapter info.</returns> - List<ChapterInfo> GetChapters(BaseItem item); - - /// <summary> - /// Gets a single chapter for an item. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="index">The chapter index.</param> - /// <returns>The chapter info at the specified index.</returns> - ChapterInfo GetChapter(BaseItem item, int index); - - /// <summary> - /// Saves the chapters. - /// </summary> - /// <param name="id">The item id.</param> - /// <param name="chapters">The list of chapters to save.</param> - void SaveChapters(Guid id, IReadOnlyList<ChapterInfo> chapters); - - /// <summary> - /// Gets the media streams. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>IEnumerable{MediaStream}.</returns> - List<MediaStream> GetMediaStreams(MediaStreamQuery query); - - /// <summary> - /// Saves the media streams. - /// </summary> - /// <param name="id">The identifier.</param> - /// <param name="streams">The streams.</param> - /// <param name="cancellationToken">The cancellation token.</param> - void SaveMediaStreams(Guid id, IReadOnlyList<MediaStream> streams, CancellationToken cancellationToken); - - /// <summary> - /// Gets the media attachments. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>IEnumerable{MediaAttachment}.</returns> - List<MediaAttachment> GetMediaAttachments(MediaAttachmentQuery query); - - /// <summary> - /// Saves the media attachments. - /// </summary> - /// <param name="id">The identifier.</param> - /// <param name="attachments">The attachments.</param> - /// <param name="cancellationToken">The cancellation token.</param> - void SaveMediaAttachments(Guid id, IReadOnlyList<MediaAttachment> attachments, CancellationToken cancellationToken); - - /// <summary> - /// Gets the items. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>QueryResult<BaseItem>.</returns> - QueryResult<BaseItem> GetItems(InternalItemsQuery query); - - /// <summary> - /// Gets the item ids list. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>List<Guid>.</returns> - List<Guid> GetItemIdsList(InternalItemsQuery query); - - /// <summary> - /// Gets the people. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>List<PersonInfo>.</returns> - List<PersonInfo> GetPeople(InternalPeopleQuery query); - - /// <summary> - /// Updates the people. - /// </summary> - /// <param name="itemId">The item identifier.</param> - /// <param name="people">The people.</param> - void UpdatePeople(Guid itemId, List<PersonInfo> people); - - /// <summary> - /// Gets the people names. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>List<System.String>.</returns> - List<string> GetPeopleNames(InternalPeopleQuery query); - - /// <summary> - /// Gets the item list. - /// </summary> - /// <param name="query">The query.</param> - /// <returns>List<BaseItem>.</returns> - List<BaseItem> GetItemList(InternalItemsQuery query); - - /// <summary> - /// Updates the inherited values. - /// </summary> - void UpdateInheritedValues(); - - int GetCount(InternalItemsQuery query); - - QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetGenres(InternalItemsQuery query); - - QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetMusicGenres(InternalItemsQuery query); - - QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetStudios(InternalItemsQuery query); - - QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetArtists(InternalItemsQuery query); - - QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAlbumArtists(InternalItemsQuery query); - - QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAllArtists(InternalItemsQuery query); - - List<string> GetMusicGenreNames(); - - List<string> GetStudioNames(); - - List<string> GetGenreNames(); - - List<string> GetAllArtistNames(); - } + /// <param name="id">The id.</param> + /// <returns>BaseItem.</returns> + BaseItem RetrieveItem(Guid id); + + /// <summary> + /// Gets the items. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>QueryResult<BaseItem>.</returns> + QueryResult<BaseItem> GetItems(InternalItemsQuery filter); + + /// <summary> + /// Gets the item ids list. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>List<Guid>.</returns> + IReadOnlyList<Guid> GetItemIdsList(InternalItemsQuery filter); + + /// <summary> + /// Gets the item list. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>List<BaseItem>.</returns> + IReadOnlyList<BaseItem> GetItemList(InternalItemsQuery filter); + + /// <summary> + /// Updates the inherited values. + /// </summary> + void UpdateInheritedValues(); + + int GetCount(InternalItemsQuery filter); + + QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetGenres(InternalItemsQuery filter); + + QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetMusicGenres(InternalItemsQuery filter); + + QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetStudios(InternalItemsQuery filter); + + QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetArtists(InternalItemsQuery filter); + + QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAlbumArtists(InternalItemsQuery filter); + + QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAllArtists(InternalItemsQuery filter); + + IReadOnlyList<string> GetMusicGenreNames(); + + IReadOnlyList<string> GetStudioNames(); + + IReadOnlyList<string> GetGenreNames(); + + IReadOnlyList<string> GetAllArtistNames(); } diff --git a/MediaBrowser.Controller/Persistence/IItemTypeLookup.cs b/MediaBrowser.Controller/Persistence/IItemTypeLookup.cs new file mode 100644 index 000000000..6699d3a4d --- /dev/null +++ b/MediaBrowser.Controller/Persistence/IItemTypeLookup.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using Jellyfin.Data.Enums; +using MediaBrowser.Model.Querying; + +namespace MediaBrowser.Controller.Persistence; + +/// <summary> +/// Provides static lookup data for <see cref="ItemFields"/> and <see cref="BaseItemKind"/> for the domain. +/// </summary> +public interface IItemTypeLookup +{ + /// <summary> + /// Gets all serialisation target types for music related kinds. + /// </summary> + IReadOnlyList<string> MusicGenreTypes { get; } + + /// <summary> + /// Gets mapping for all BaseItemKinds and their expected serialization target. + /// </summary> + IReadOnlyDictionary<BaseItemKind, string> BaseItemKindNames { get; } +} diff --git a/MediaBrowser.Controller/Persistence/IMediaAttachmentRepository.cs b/MediaBrowser.Controller/Persistence/IMediaAttachmentRepository.cs new file mode 100644 index 000000000..4773f4058 --- /dev/null +++ b/MediaBrowser.Controller/Persistence/IMediaAttachmentRepository.cs @@ -0,0 +1,28 @@ +#nullable disable + +#pragma warning disable CS1591 + +using System; +using System.Collections.Generic; +using System.Threading; +using MediaBrowser.Model.Entities; + +namespace MediaBrowser.Controller.Persistence; + +public interface IMediaAttachmentRepository +{ + /// <summary> + /// Gets the media attachments. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>IEnumerable{MediaAttachment}.</returns> + IReadOnlyList<MediaAttachment> GetMediaAttachments(MediaAttachmentQuery filter); + + /// <summary> + /// Saves the media attachments. + /// </summary> + /// <param name="id">The identifier.</param> + /// <param name="attachments">The attachments.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void SaveMediaAttachments(Guid id, IReadOnlyList<MediaAttachment> attachments, CancellationToken cancellationToken); +} diff --git a/MediaBrowser.Controller/Persistence/IMediaStreamRepository.cs b/MediaBrowser.Controller/Persistence/IMediaStreamRepository.cs new file mode 100644 index 000000000..665129eaf --- /dev/null +++ b/MediaBrowser.Controller/Persistence/IMediaStreamRepository.cs @@ -0,0 +1,31 @@ +#nullable disable + +#pragma warning disable CS1591 + +using System; +using System.Collections.Generic; +using System.Threading; +using MediaBrowser.Model.Entities; + +namespace MediaBrowser.Controller.Persistence; + +/// <summary> +/// Provides methods for accessing MediaStreams. +/// </summary> +public interface IMediaStreamRepository +{ + /// <summary> + /// Gets the media streams. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>IEnumerable{MediaStream}.</returns> + IReadOnlyList<MediaStream> GetMediaStreams(MediaStreamQuery filter); + + /// <summary> + /// Saves the media streams. + /// </summary> + /// <param name="id">The identifier.</param> + /// <param name="streams">The streams.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void SaveMediaStreams(Guid id, IReadOnlyList<MediaStream> streams, CancellationToken cancellationToken); +} diff --git a/MediaBrowser.Controller/Persistence/IPeopleRepository.cs b/MediaBrowser.Controller/Persistence/IPeopleRepository.cs new file mode 100644 index 000000000..418289cb4 --- /dev/null +++ b/MediaBrowser.Controller/Persistence/IPeopleRepository.cs @@ -0,0 +1,33 @@ +#nullable disable + +#pragma warning disable CS1591 + +using System; +using System.Collections.Generic; +using MediaBrowser.Controller.Entities; + +namespace MediaBrowser.Controller.Persistence; + +public interface IPeopleRepository +{ + /// <summary> + /// Gets the people. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>The list of people matching the filter.</returns> + IReadOnlyList<PersonInfo> GetPeople(InternalPeopleQuery filter); + + /// <summary> + /// Updates the people. + /// </summary> + /// <param name="itemId">The item identifier.</param> + /// <param name="people">The people.</param> + void UpdatePeople(Guid itemId, IReadOnlyList<PersonInfo> people); + + /// <summary> + /// Gets the people names. + /// </summary> + /// <param name="filter">The query.</param> + /// <returns>The list of people names matching the filter.</returns> + IReadOnlyList<string> GetPeopleNames(InternalPeopleQuery filter); +} diff --git a/MediaBrowser.Controller/Persistence/IUserDataRepository.cs b/MediaBrowser.Controller/Persistence/IUserDataRepository.cs deleted file mode 100644 index f2fb2826a..000000000 --- a/MediaBrowser.Controller/Persistence/IUserDataRepository.cs +++ /dev/null @@ -1,55 +0,0 @@ -#nullable disable - -using System; -using System.Collections.Generic; -using System.Threading; -using MediaBrowser.Controller.Entities; - -namespace MediaBrowser.Controller.Persistence -{ - /// <summary> - /// Provides an interface to implement a UserData repository. - /// </summary> - public interface IUserDataRepository : IDisposable - { - /// <summary> - /// Saves the user data. - /// </summary> - /// <param name="userId">The user id.</param> - /// <param name="key">The key.</param> - /// <param name="userData">The user data.</param> - /// <param name="cancellationToken">The cancellation token.</param> - void SaveUserData(long userId, string key, UserItemData userData, CancellationToken cancellationToken); - - /// <summary> - /// Gets the user data. - /// </summary> - /// <param name="userId">The user id.</param> - /// <param name="key">The key.</param> - /// <returns>The user data.</returns> - UserItemData GetUserData(long userId, string key); - - /// <summary> - /// Gets the user data. - /// </summary> - /// <param name="userId">The user id.</param> - /// <param name="keys">The keys.</param> - /// <returns>The user data.</returns> - UserItemData GetUserData(long userId, List<string> keys); - - /// <summary> - /// Return all user data associated with the given user. - /// </summary> - /// <param name="userId">The user id.</param> - /// <returns>The list of user item data.</returns> - List<UserItemData> GetAllUserData(long userId); - - /// <summary> - /// Save all user data associated with the given user. - /// </summary> - /// <param name="userId">The user id.</param> - /// <param name="userData">The user item data.</param> - /// <param name="cancellationToken">The cancellation token.</param> - void SaveAllUserData(long userId, UserItemData[] userData, CancellationToken cancellationToken); - } -} |