jellyfin / jellyfin-plugin-bookshelf Goto Github PK

View Code? Open in Web Editor NEW

195.0 195.0 21.0 15.87 MB

Home Page: https://jellyfin.org

License: MIT License

C# 99.10% HTML 0.90%

hacktoberfest

jellyfin-plugin-bookshelf's Introduction

Jellyfin

The Free Software Media System

Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!

For further details, please see our documentation page. To receive the latest updates, get help with Jellyfin, and join the community, please visit one of our communication channels. For more information about the project, please see our about page.

Want to get started?
Check out our downloads page or our installation guide, then see our quick start guide. You can also build from source.

Something not working right?
Open an Issue on GitHub.

Want to contribute?
Check out our contributing choose-your-own-adventure to see where you can help, then see our contributing guide and our community standards.

New idea or improvement?
Check out our feature request hub.

Don't see Jellyfin in your language?
Check out our Weblate instance to help translate Jellyfin and its subprojects.

Jellyfin Server

This repository contains the code for Jellyfin's backend server. Note that this is only one of many projects under the Jellyfin GitHub organization on GitHub. If you want to contribute, you can start by checking out our documentation to see what to work on.

Server Development

These instructions will help you get set up with a local development environment in order to contribute to this repository. Before you start, please be sure to completely read our guidelines on development contributions. Note that this project is supported on all major operating systems except FreeBSD, which is still incompatible.

Prerequisites

Before the project can be built, you must first install the .NET 8.0 SDK on your system.

Instructions to run this project from the command line are included here, but you will also need to install an IDE if you want to debug the server while it is running. Any IDE that supports .NET 6 development will work, but two options are recent versions of Visual Studio (at least 2022) and Visual Studio Code.

ffmpeg will also need to be installed.

Cloning the Repository

After dependencies are installed you will need to clone a local copy of this repository. If you just want to run the server from source you can clone this repository directly, but if you are intending to contribute code changes to the project, you should set up your own fork of the repository. The following example shows how you can clone the repository directly over HTTPS.

git clone https://github.com/jellyfin/jellyfin.git

Installing the Web Client

The server is configured to host the static files required for the web client in addition to serving the backend by default. Before you can run the server, you will need to get a copy of the web client since they are not included in this repository directly.

Note that it is also possible to host the web client separately from the web server with some additional configuration, in which case you can skip this step.

There are three options to get the files for the web client.

Download one of the finished builds from the Azure DevOps pipeline. You can download the build for a specific release by looking at the branches tab of the pipelines page.
Build them from source following the instructions on the jellyfin-web repository
Get the pre-built files from an existing installation of the server. For example, with a Windows server installation the client files are located at C:\Program Files\Jellyfin\Server\jellyfin-web

Running The Server

The following instructions will help you get the project up and running via the command line, or your preferred IDE.

Running With Visual Studio

To run the project with Visual Studio you can open the Solution (.sln) file and then press F5 to run the server.

Running With Visual Studio Code

To run the project with Visual Studio Code you will first need to open the repository directory with Visual Studio Code using the Open Folder... option.

Second, you need to install the recommended extensions for the workspace. Note that extension recommendations are classified as either "Workspace Recommendations" or "Other Recommendations", but only the "Workspace Recommendations" are required.

After the required extensions are installed, you can run the server by pressing F5.

Running From The Command Line

To run the server from the command line you can use the dotnet run command. The example below shows how to do this if you have cloned the repository into a directory named jellyfin (the default directory name) and should work on all operating systems.

cd jellyfin                          # Move into the repository directory
dotnet run --project Jellyfin.Server --webdir /absolute/path/to/jellyfin-web/dist # Run the server startup project

A second option is to build the project and then run the resulting executable file directly. When running the executable directly you can easily add command line options. Add the --help flag to list details on all the supported command line options.

Build the project

dotnet build                       # Build the project
cd Jellyfin.Server/bin/Debug/net8.0 # Change into the build output directory

Execute the build output. On Linux, Mac, etc. use ./jellyfin and on Windows use jellyfin.exe.

Accessing the Hosted Web Client

If the Server is configured to host the Web Client, and the Server is running, the Web Client can be accessed at http://localhost:8096 by default.

API documentation can be viewed at http://localhost:8096/api-docs/swagger/index.html

Running from GH-Codespaces

As Jellyfin will run on a container on a github hosted server, JF needs to handle some things differently.

NOTE: Depending on the selected configuration (if you just click 'create codespace' it will create a default configuration one) it might take 20-30 seconds to load all extensions and prepare the environment while VS Code is already open. Just give it some time and wait until you see Downloading .NET version(s) 7.0.15~x64 ...... Done! in the output tab.

NOTE: If you want to access the JF instance from outside, like with a WebClient on another PC, remember to set the "ports" in the lower VS Code window to public.

NOTE: When first opening the server instance with any WebUI, you will be sent to the login instead of the setup page. Refresh the login page once and you should be redirected to the Setup.

There are two configurations for you to choose from.

Default - Development Jellyfin Server

This creates a container that has everything to run and debug the Jellyfin Media server but does not setup anything else. Each time you create a new container you have to run through the whole setup again. There is also no ffmpeg, webclient or media preloaded. Use the .NET Launch (nowebclient) launch config to start the server.

Keep in mind that as this has no web client you have to connect to it via an external client. This can be just another codespace container running the WebUI. vuejs does not work from the get-go as it does not support the setup steps.

Development Jellyfin Server ffmpeg

this extends the default server with a default installation of ffmpeg6 though the means described here: https://jellyfin.org/docs/general/installation/linux#repository-manual If you want to install a specific ffmpeg version, follow the comments embedded in the .devcontainer/Dev - Server Ffmpeg/install.ffmpeg.sh file.

Use the ghcs .NET Launch (nowebclient, ffmpeg) launch config to run with the jellyfin-ffmpeg enabled.

Running The Tests

This repository also includes unit tests that are used to validate functionality as part of a CI pipeline on Azure. There are several ways to run these tests.

Run tests from the command line using dotnet test
Run tests in Visual Studio using the Test Explorer
Run individual tests in Visual Studio Code using the associated CodeLens annotation

Advanced Configuration

The following sections describe some more advanced scenarios for running the server from source that build upon the standard instructions above.

Hosting The Web Client Separately

It is not necessary to host the frontend web client as part of the backend server. Hosting these two components separately may be useful for frontend developers who would prefer to host the client in a separate webpack development server for a tighter development loop. See the jellyfin-web repo for instructions on how to do this.

To instruct the server not to host the web content, there is a nowebclient configuration flag that must be set. This can specified using the command line switch --nowebclient or the environment variable JELLYFIN_NOWEBCONTENT=true.

Since this is a common scenario, there is also a separate launch profile defined for Visual Studio called Jellyfin.Server (nowebcontent) that can be selected from the 'Start Debugging' dropdown in the main toolbar.

NOTE: The setup wizard can not be run if the web client is hosted separately.

This project is supported by:

jellyfin-plugin-bookshelf's People

Contributors

Stargazers

Watchers

jellyfin-plugin-bookshelf's Issues

Unable to sort books by read order

Let's say I have books organized as /author/series/book/book.epub and the book folders are numbered so like "1 book a" "2 book b" "3 book c" there seems to be no way to get bookshelf/jellyfin to sort the books by read order, either by pulling the metadata from the books or by having the book folders numbered. When I sort by "folders" the books are in a completely random order that has no relation to the read order.

App: Error in "Open Packaging Format"

Log spammed with

[2020-06-13 00:54:15.085 +03:00] [ERR] [71] App: Error in "Open Packaging Format"
System.NullReferenceException: Object reference not set to an instance of an object.
   at Jellyfin.Plugin.Bookshelf.Providers.BookProviderFromOpf.ReadOpfData(MetadataResult`1 bookResult, String metaFile, CancellationToken cancellationToken)
   at Jellyfin.Plugin.Bookshelf.Providers.BookProviderFromOpf.GetMetadata(ItemInfo info, IDirectoryService directoryService, CancellationToken cancellationToken)
   at MediaBrowser.Providers.Manager.MetadataService`2.RefreshWithProviders(MetadataResult`1 metadata, TIdType id, MetadataRefreshOptions options, List`1 providers, ItemImageProvider imageService, CancellationToken cancellationToken) in /mnt/AUR/jellyfin/src/jellyfin-10.5.5/MediaBrowser.Providers/Manager/MetadataService.cs:line 708
[2020-06-13 00:54:16.129 +03:00] [ERR] [50] App: Error in "Open Packaging Format"
System.NullReferenceException: Object reference not set to an instance of an object.
   at Jellyfin.Plugin.Bookshelf.Providers.BookProviderFromOpf.ReadOpfData(MetadataResult`1 bookResult, String metaFile, CancellationToken cancellationToken)
   at Jellyfin.Plugin.Bookshelf.Providers.BookProviderFromOpf.GetMetadata(ItemInfo info, IDirectoryService directoryService, CancellationToken cancellationToken)
   at MediaBrowser.Providers.Manager.MetadataService`2.RefreshWithProviders(MetadataResult`1 metadata, TIdType id, MetadataRefreshOptions options, List`1 providers, ItemImageProvider imageService, CancellationToken cancellationToken) in /mnt/AUR/jellyfin/src/jellyfin-10.5.5/MediaBrowser.Providers/Manager/MetadataService.cs:line 708

System:

OS: Arch Linux
Virtualization: None
Clients: Browser
Browser: Firefox
Jellyfin Version: 10.5.5
Playback: Transcode
Installed Plugins: AudioDB, Bookshelf, Fanart, LDAP-Auth, MusicBrainz, Open Subtitles, Playback Reporting, Reports
Reverse Proxy: nginx
Base URL: none
Networking: NAT
Storage: local

Book collections/series

It would be nice if Jellyfin read the metadata to see that a book is in a series and then could group all those books in to a book collection/series. Like all the Thomas Covenant books, all the Dune books, all the Xanth books. The metadata exists and it already tells you the order of the series as well.

How to install bookshelf on windows10 's jellyfin

I downdload the *..shelf.dll and *.json from github.
I copy this two files to the jelllyfin's folder.

and I create the "plugins" folder, copy the two files to this folder.

Did I do this correctly?

Comic metadata isn't read from inside the file

It doesn't seem like Jellyfin is reading any of the ComicVine XML info like the docs say it should be. I have all my comic books tagged and they are not being picked up properly. Jellyfin is only showing the filename info and not pulling the covers.
I tagged all my stuff with Mylar3 and LazyLibrarian.
I see the xml file in the directory for the series and inside the CBZ files as well.

/mnt/storage/comics/DC Comics/Absolute Crisis On Infinite Earths (2005)/cvinfo
/mnt/storage/comics/DC Comics/Absolute Crisis On Infinite Earths (2005)/Absolute Crisis On Infinite Earths #1 (2005).cbz

I would upload the metadata files but GitHub won't let me.
Inside the cbz file is "ComicInfo.xml"

always fit to window / screen

hello, the comics player is almost great except it always fits the page only to the height of the screen.

it works fine when the screen is wider than the page, but when the page is wider than the screen it will be cropped, instead of reducing its height.

OPF files being imported as a book in Jellyfin 10.6.1

When I create a book library and have Jellyfin 10.6.1 scan my books directory it is importing the metadata.opf files as if they are books. It never did this before. This is on a brand new library and new scan of the books directory. If you go in to the "book" it will let you try and download the metadata.opf file like it is a book you can download and read. It should be reading these opf files as the metadata they are, instead of thinking they are books.

Google Books API Daily Limit Exceeded

When trying to refresh book metadata, received this in logs:

jellyfin_1  | [01:23:06] [ERR] Error in Google Books
jellyfin_1  | MediaBrowser.Model.Net.HttpException: Forbidden
jellyfin_1  |    at Emby.Server.Implementations.HttpClientManager.HttpClientManager.EnsureSuccessStatusCode(HttpResponseMessage response, HttpRequestOptions options)
jellyfin_1  |    at Emby.Server.Implementations.HttpClientManager.HttpClientManager.SendAsyncInternal(HttpRequestOptions options, HttpMethod httpMethod)
jellyfin_1  |    at Emby.Server.Implementations.HttpClientManager.HttpClientManager.SendAsync(HttpRequestOptions options, HttpMethod httpMethod)
jellyfin_1  |    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetSearchResultsInternal(BookInfo item, CancellationToken cancellationToken)
jellyfin_1  |    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.FetchBookId(BookInfo item, CancellationToken cancellationToken)
jellyfin_1  |    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetMetadata(BookInfo item, CancellationToken cancellationToken)
jellyfin_1  |    at MediaBrowser.Providers.Manager.MetadataService`2.ExecuteRemoteProviders(MetadataResult`1 temp, String logName, TIdType id, IEnumerable`1 providers, CancellationToken cancellationToken)

When trying to run a basic search against the google books api in the browser using the keys and info in ApiUrls.cs, got this:

{
 "error": {
  "errors": [
   {
    "domain": "usageLimits",
    "reason": "dailyLimitExceeded",
    "message": "Daily Limit Exceeded. The quota will be reset at midnight Pacific Time (PT). You may monitor your quota usage and adjust limits in the API Console: https://console.developers.google.com/apis/api/books.googleapis.com/quotas?project=75039668320",
    "extendedHelp": "https://console.developers.google.com/apis/api/books.googleapis.com/quotas?project=75039668320"
   }
  ],
  "code": 403,
  "message": "Daily Limit Exceeded. The quota will be reset at midnight Pacific Time (PT). You may monitor your quota usage and adjust limits in the API Console: https://console.developers.google.com/apis/api/books.googleapis.com/quotas?project=75039668320"
 }
}

Possible solution might be an option for the user to provide their own API key to google books api.

Audio Books

Audio books are not recognized by jellyfin even when using this plugin.

support for leanpub

Please add support for leanpub metadata support.

feature request: Set title to chapter title for chapterized audiobooks

It would be awesome if this plugin could provide chapter title metadata for audiobooks that are broken up into separate audio files by chapter.

Parse custom roles from Calibre opf

As of recent releases, bookshelf can scan Author and other select roles from an ebook/audiobook metadata.

Calibre allows the user to define custom columns for a variety of metadata.
Among these, the user can specify that a column contains a person's name (or list thereof).
This is the most straightforward way to include a field for translator, editor, foreword author, etc

For example, if I wanted to add a "Translator" field to my Calibre library metadata I would go to:
Preferences > Add your own columns > Add custom column
and there select the following:

Column type: "Comma separated text, like tags, shown in the tag browser"
Contain names: yes
Column heading: Translator
Lookup name: whatever

... and leave the rest blank

Then the newly added Translator field can be edited from the GUI.
If I then change the default blank value to a name (or a comma-separated list), Calibre will add a line to the corresponding metadata.opf, which ends up looking like the following two examples:
https://pastebin.com/h0iMCeYk
https://pastebin.com/sMDyra4D

The line that is added is a bit verbose, but the relevant metadata can be extracted as follows:
https://pastebin.com/xzt1w7Rx
(apologies for posting a script in Python rather than C#, but I am not familiar with the latter)

Could parsing of these fields be added to Jellyfin Bookshelf, and shown in the "People" section at the bottom of the ebook page?

App: Error in "Google Books"

Log spammed with

[2020-06-13 00:49:50.403 +03:00] [ERR] [67] App: Error in "Google Books"
System.NullReferenceException: Object reference not set to an instance of an object.
   at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetComparableName(String name)
   at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.FetchBookId(BookInfo item, CancellationToken cancellationToken)
   at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetMetadata(BookInfo item, CancellationToken cancellationToken)
   at MediaBrowser.Providers.Manager.MetadataService`2.ExecuteRemoteProviders(MetadataResult`1 temp, String logName, TIdType id, IEnumerable`1 providers, CancellationToken cancellationToken)
[2020-06-13 00:49:55.757 +03:00] [ERR] [59] App: Error in "Google Books"
System.NullReferenceException: Object reference not set to an instance of an object.
   at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.FetchBookId(BookInfo item, CancellationToken cancellationToken)
   at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetMetadata(BookInfo item, CancellationToken cancellationToken)
   at MediaBrowser.Providers.Manager.MetadataService`2.ExecuteRemoteProviders(MetadataResult`1 temp, String logName, TIdType id, IEnumerable`1 providers, CancellationToken cancellationToken)

System:

OS: Arch Linux
Virtualization: None
Clients: Browser
Browser: Firefox
Jellyfin Version: 10.5.5
Playback: Transcode
Installed Plugins: AudioDB, Bookshelf, Fanart, LDAP-Auth, MusicBrainz, Open Subtitles, Playback Reporting, Reports
Reverse Proxy: nginx
Base URL: none
Networking: NAT
Storage: local

Support for ComicBookInfo metadata (ComicBookLover)

Add support for ComicBookLover's ComicBookInfo format (not to be confused with ComicRack's ComicInfo format).

Support tags from ComicInfo.xml

It looks like while Bookshelf supports reading genres from a ComicInfo.xml file, it doesn't support reading tags. Even though the Tags field is technically still in the draft v2.1 version, it's already supported by other programs like Komga. It would be great if Bookshelf could do the same. I can put up the PR for it, if this seems like a good idea.

new release?

How about creating a new release with the changes since v9? #67 lists already a few nice changes which I would like to enjoy.
I tried compiling the plugin myself but it did not work inside jellyfin for some reason (probably a different .NET SDK or incompatible build settings).

Audio book media files ignored when cue file is present

When I add my audio book library, it sees the folders and cover image but when I try to play a book it is unable to. When I inspect the media, it shows the information for the cue file and not the audio.

Each folder contains a cue file with chapter information, a jpeg cover image, and m4b or mp3. Removing the cue file resolves this issue, but I lose chapter information.

Page numbers, reading progress and saving position

I'm very excited about jellyfin being able to handle ebooks. I think the biggest missing feature for me is being able to keep track of how far into a book I already am, and resuming from that position next time I open it

Google Books NullReferenceException

Saw this scroll by in the logs – I have not looked more into it

ec 11 20:04:54 1070L jellyfin[24387]: [20:04:54] [ERR] MediaBrowser.Providers.Books.BookMetadataService: Error in Google Books
Dec 11 20:04:54 1070L jellyfin[24387]: System.NullReferenceException: Object reference not set to an instance of an object.
Dec 11 20:04:54 1070L jellyfin[24387]:    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.FetchBookId(BookInfo item, CancellationToken cancellationToken)
Dec 11 20:04:54 1070L jellyfin[24387]:    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetMetadata(BookInfo item, CancellationToken cancellationToken)
Dec 11 20:04:54 1070L jellyfin[24387]:    at MediaBrowser.Providers.Manager.MetadataService`2.ExecuteRemoteProviders(MetadataResult`1 temp, String logName, TIdType id, IEnumerable`1 providers, CancellationToken cancellationToken)
Dec 11 20:04:54 1070L jellyfin[24387]: [20:04:54] [DBG] MediaBrowser.Providers.Books.BookMetadataService: Running GoogleBooksImageProvider for /mnt/alvis/Media/Comics/Doctor Strange/Short Runs and Graphic Novels/Thanos (2002) - Infinity Abyss 04.cbz
Dec 11 20:04:54 1070L jellyfin[24387]: [20:04:54] [DBG] MediaBrowser.Providers.Books.BookMetadataService: Running EpubMetadataImageProvider for /mnt/alvis/Media/Comics/Doctor Strange/Short Runs and Graphic Novels/Thanos (2002) - Infinity Abyss 04.cbz
Dec 11 20:04:54 1070L jellyfin[24387]: [20:04:54] [ERR] MediaBrowser.Providers.Books.BookMetadataService: Error in Google Books
Dec 11 20:04:54 1070L jellyfin[24387]: System.NullReferenceException: Object reference not set to an instance of an object.
Dec 11 20:04:54 1070L jellyfin[24387]:    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.FetchBookId(BookInfo item, CancellationToken cancellationToken)
Dec 11 20:04:54 1070L jellyfin[24387]:    at Jellyfin.Plugin.Bookshelf.Providers.GoogleBooks.GoogleBooksProvider.GetMetadata(BookInfo item, CancellationToken cancellationToken)
Dec 11 20:04:54 1070L jellyfin[24387]:    at MediaBrowser.Providers.Manager.MetadataService`2.ExecuteRemoteProviders(MetadataResult`1 temp, String logName, TIdType id, IEnumerable`1 providers, CancellationToken cancellationToken)
Dec 11 20:04:54 1070L jellyfin[24387]: [20:04:54] [DBG] MediaBrowser.Providers.Books.BookMetadataService: Running GoogleBooksImageProvider for /mnt/alvis/Media/Comics/Doctor Strange/Short Runs and Graphic Novels/Thanos (2002) - Infinity Abyss 05.cbr
Dec 11 20:04:54 1070L jellyfin[24387]: [20:04:54] [DBG] MediaBrowser.Providers.Books.BookMetadataService: Running EpubMetadataImageProvider for /mnt/alvis/Media/Comics/Doctor Strange/Short Runs and Graphic Novels/Thanos (2002) - Infinity Abyss 05.cbr

Add plugable archive backend

Hi, thanks for the project.

I'm interested in adding support for a pluggable archive backend. One which can support cbr, cbz etc. At the moment this project only seems to support zipfiles (and variants of zips such as epub). The README mentions rar archives are supported but I'm not seeing any reference to cbr or rar so is this not correct.

Cannot read mobi books in browser?

When I scan, Jellyfin do find the book, but there is no "play" button to let me read this book. I am using jellyfin-web in chrome browser.

Plugin doesn't seem to do anything

Hi, I have installed the plugin, restarted, and to be sure, deleted my prior Audiobooks library and created a new one. The plugin doesn't seem to be doing anything. The library looks exactly like the old pre-plugin-install one did: Shows the folders as created on the drive, no option to show titles or other metadata, no metadata, it just looks like a mixed format folder in folder view with no option to look at it any other way. All the Bookshelf metadata options are visible in the Manage Library page, but nothing is happening and I don't even know where the metadata would appear, since the title is just shown in folder view. My folder structure is [Parent] - Audio Books - [Author Name] - [Book Name] (Year) and contains usually multiple chapters in MP3 and an icon. I have tried mapping to [Parent] and to Audio Books (in different attempts), nothing changes either way. Is it supposed to do something different? Because if all it does is list my folder structure, it isn't useful. I only have it sorted by author because that's how Jellyfin recommends and it mirrors what you would do for Music or in Calibre for ebooks. It's not how I would actually look for something unless we're talking a big name author like Stephen King. I don't know most author names by heart, especially for one-off non-fiction, and I don't really know anyone who does. I want to see a list of titles, browse by pictures like I do with my other Jellyfin content, maybe filter by genre. I'm just not sure what Bookshelf is supposed to be doing, everyone makes it sound like it's the thing that makes Jellyfin work for audiobook but I'm not seeing it do anything at all, so I'm wondering if it's actually functioning.

Feature Request: Google Books id in file name

It would be nice to be able to provide a google books id in the filename like it is possible with tmdb in movies.
for examble i could add the file
why_we_sleep [googlebooksid-ZlU3DwAAQBAJ].pdf
and it automatically knows all the metadata it can fetch from google books

Feature Request: Navigation improvements

The navigation is opaque at the moment. A lot of folks say "Oh I clicked on the book to open it but I only get the first page" and then stop there. At least have clickable arrows or some hint to the users that they need to use the left and right keys? :)

Why all comic vine code commented

Why all comic vine code commented?
Do you have any plans for adding comic vine scrapper support?

https://github.com/jellyfin/jellyfin-plugin-bookshelf/blob/master/Jellyfin.Plugin.Bookshelf/Providers/ComicVine/ComicVineImageProvider.cs
https://github.com/jellyfin/jellyfin-plugin-bookshelf/blob/master/Jellyfin.Plugin.Bookshelf/Providers/ComicVine/ComicVineMetadataProvider.cs

Book author information

It would be nice if Jellyfin could pull in from Goodreads or Wikipedia information about the author and display it when you are showing all the books by a specific author along with a picture of the author.

Cover image not extracted from EPUB files

Bookshelf fails to extract the cover image from some books in the EPUB format. The name of the book as well as the description and other details gets loaded correctly though.

One of the books that cause this issue is https://www.feedbooks.com/book/1421/the-adventures-of-sherlock-holmes

Going into Jellyfin's metadata folder after the book is imported, I can see a poster.jpg file created that is not an image actually.

$ cat poster.jpg 
<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC
     "-//W3C//DTD XHTML 1.1//EN"
     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">

  <head>
   <title>Cover</title>
   <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
  </head>
  
  <body>
    <div style="text-align: center; page-break-after: always;">
      <img src="images/cover.png" alt="Cover" style="height: 100%; max-width: 100%;" />
    </div>
  </body>

</html>

[Bug] minor typo found

Please take in mind that ~~his~~ this is not a complete list.

CB7 support

Jellyfin doesn't pick up CB7 files which it should since 7zip is open source and a great compression program for comic books.

Support epub metadata

pls add the ability to read the metadata from epub files. maybe as a new Provider?

all my selfmade and bought books have metadata and cover embedded

thx :)

M4b audiobooks not playable via safari or IOS app

Bookshelf plug-in has been installed on Jellyfin Server running on Raspberry pi 4. Version 10.8.7

attempting to play audiobooks from IOS or web browser results in following error:

Playback Error
This client isn't compatible with the media and the server isn't sending a compatible media format.

Error getting metadata

Once the library is managed, when manually indicating the search for new content, the log shows the following error

[2019-08-11 11:29:27.009 +02:00] [ERR] Error in "Open Packaging Format"
System.NullReferenceException: Object reference not set to an instance of an object.
   at Jellyfin.Plugin.Bookshelf.Providers.BookProviderFromOpf.ReadOpfData(MetadataResult`1 bookResult, String metaFile, CancellationToken cancellationToken)
   at Jellyfin.Plugin.Bookshelf.Providers.BookProviderFromOpf.GetMetadata(ItemInfo info, IDirectoryService directoryService, CancellationToken cancellationToken)
   at MediaBrowser.Providers.Manager.MetadataService`2.RefreshWithProviders(MetadataResult`1 metadata, TIdType id, MetadataRefreshOptions options, List`1 providers, ItemImageProvider imageService, CancellationToken cancellationToken)

AAX Support?

Is there any way to get support for .aax files added?

Allow customizing the ebook view

It would be nice if the ebook view had more options for visualization, for example setting the default font type and size, being able to customize the text and background color (for example for a "night mode"), or setting the default width of the page. Before using this plugin, I used to use the Nextcloud Files Reader, which does support all the settings I detailed above, and given that it's open-source it should be technically possible to integrate their settings in this app.

Is there a reason to not look for folder(s) inside CBR archive?

Hello, I normally don't make issues on GitHub, pardon my ignorance. When I was trying to load a CBR comic through Jellyfin, I never got past the loading animation.

When I dug around I discovered that when I unrar CBR file there was a folder with the images of the comic inside, so I rared the images, no folder, with CBR extension and Jellyfin was able to instantly load the comic, which is odd since it loads comics with .cbz extension that has a folder.

I never did a pull request, and figured maybe adding code to search for folder/files inside CBR archive would be simple enough for my first pull request.

But I wanted to ask if there a reason this hasn't been done already for CBR? Is it an underlying issue with RAR type archives?

Again, sorry for my ignorance.

Feature Request: zip support.

Currently, the plugin allows Jellyfin to add support for the following ebook formats:

epub
mobi
pdf
cbz
cbr

Would be nice if zip is added as well. Both cbz and cbr are like zip files, so adding zip support could be relatively easy.

Thanks in advance, good day.

Support for ComicVine metadata

Support for ComicVine metadata provider

Some guidelines for file naming could be useful as well. This are the guidelines comictagger uses to identify a comic and search for it in the ComicVine db: https://github.com/comictagger/comictagger/wiki/UserGuide

Support for CoMet comic metadata

Jellyfin is currently missing support for the CoMet comic metadata format.

The specification can be found here:
https://www.denvog.com/comet/comet-specification/

The format is used by e.g.: https://apps.apple.com/us/app/comic-book-viewer/id957475715

Cover image not extracted from ePUB files

I have some books in ePUB format that bookshelf fails to load covers from. The name of the book loads as well as the publication year, but nothing else. I have confirmed that each book has a cover image in the PNG format tagged with the cover-image property. I have also confirmed that this is (probably) not a permissions issue as Jellyfin can read and display the ePUB file if I open it.

Normally providing one of the failing files would be difficult, but thankfully one of them is free. https://www.dragonsteelbooks.com/products/long-chills-and-case-dough-ebook

A (probably) relevant section of the Jellyfin log below:

[2024-01-14 23:18:38.601 -05:00] [ERR] [168] MediaBrowser.Providers.Books.BookMetadataService: Error in "Epub Metadata"
System.NotSupportedException: This stream from ZipArchiveEntry does not support reading.
   at System.IO.Compression.SubReadStream.ThrowIfCantRead()
   at System.IO.Compression.SubReadStream.ReadAsync(Memory`1 buffer, CancellationToken cancellationToken)
   at System.IO.Stream.<CopyToAsync>g__Core|29_0(Stream source, Stream destination, Int32 bufferSize, CancellationToken cancellationToken)
   at System.IO.Compression.DeflateStream.CopyToStream.CopyFromSourceToDestinationAsync()
   at Jellyfin.Plugin.Bookshelf.Providers.Epub.EpubMetadataImageProvider.LoadCover(ZipArchive epub, XmlDocument opf, String opfRootDirectory)
   at MediaBrowser.Providers.Manager.ItemImageProvider.RefreshFromProvider(BaseItem item, IDynamicImageProvider provider, ImageRefreshOptions refreshOptions, TypeOptions savedOptions, ICollection`1 downloadedImages, RefreshResult result, CancellationToken cancellationToken)
[2024-01-14 23:18:38.601 -05:00] [ERR] [164] MediaBrowser.Providers.Books.BookMetadataService: Error in "Epub Metadata"
System.NotSupportedException: This stream from ZipArchiveEntry does not support reading.
   at System.IO.Compression.SubReadStream.ThrowIfCantRead()
   at System.IO.Compression.SubReadStream.ReadAsync(Memory`1 buffer, CancellationToken cancellationToken)
   at System.IO.Stream.<CopyToAsync>g__Core|29_0(Stream source, Stream destination, Int32 bufferSize, CancellationToken cancellationToken)
   at System.IO.Compression.DeflateStream.CopyToStream.CopyFromSourceToDestinationAsync()
   at Jellyfin.Plugin.Bookshelf.Providers.Epub.EpubMetadataImageProvider.LoadCover(ZipArchive epub, XmlDocument opf, String opfRootDirectory)
   at MediaBrowser.Providers.Manager.ItemImageProvider.RefreshFromProvider(BaseItem item, IDynamicImageProvider provider, ImageRefreshOptions refreshOptions, TypeOptions savedOptions, ICollection`1 downloadedImages, RefreshResult result, CancellationToken cancellationToken)
[2024-01-14 23:18:38.601 -05:00] [ERR] [156] MediaBrowser.Providers.Books.BookMetadataService: Error in "Epub Metadata"
System.NotSupportedException: This stream from ZipArchiveEntry does not support reading.
   at System.IO.Compression.SubReadStream.ThrowIfCantRead()
   at System.IO.Compression.SubReadStream.ReadAsync(Memory`1 buffer, CancellationToken cancellationToken)
   at System.IO.Stream.<CopyToAsync>g__Core|29_0(Stream source, Stream destination, Int32 bufferSize, CancellationToken cancellationToken)
   at System.IO.Compression.DeflateStream.CopyToStream.CopyFromSourceToDestinationAsync()
   at Jellyfin.Plugin.Bookshelf.Providers.Epub.EpubMetadataImageProvider.LoadCover(ZipArchive epub, XmlDocument opf, String opfRootDirectory)
   at MediaBrowser.Providers.Manager.ItemImageProvider.RefreshFromProvider(BaseItem item, IDynamicImageProvider provider, ImageRefreshOptions refreshOptions, TypeOptions savedOptions, ICollection`1 downloadedImages, RefreshResult result, CancellationToken cancellationToken)
[2024-01-14 23:18:38.601 -05:00] [ERR] [169] MediaBrowser.Providers.Books.BookMetadataService: Error in "Epub Metadata"
System.NotSupportedException: This stream from ZipArchiveEntry does not support reading.
   at System.IO.Compression.SubReadStream.ThrowIfCantRead()
   at System.IO.Compression.SubReadStream.ReadAsync(Memory`1 buffer, CancellationToken cancellationToken)
   at System.IO.Stream.<CopyToAsync>g__Core|29_0(Stream source, Stream destination, Int32 bufferSize, CancellationToken cancellationToken)
   at System.IO.Compression.DeflateStream.CopyToStream.CopyFromSourceToDestinationAsync()
   at Jellyfin.Plugin.Bookshelf.Providers.Epub.EpubMetadataImageProvider.LoadCover(ZipArchive epub, XmlDocument opf, String opfRootDirectory)
   at MediaBrowser.Providers.Manager.ItemImageProvider.RefreshFromProvider(BaseItem item, IDynamicImageProvider provider, ImageRefreshOptions refreshOptions, TypeOptions savedOptions, ICollection`1 downloadedImages, RefreshResult result, CancellationToken cancellationToken)
[2024-01-14 23:18:38.601 -05:00] [ERR] [171] MediaBrowser.Providers.Books.BookMetadataService: Error in "Epub Metadata"
System.NotSupportedException: This stream from ZipArchiveEntry does not support reading.
   at System.IO.Compression.SubReadStream.ThrowIfCantRead()
   at System.IO.Compression.SubReadStream.ReadAsync(Memory`1 buffer, CancellationToken cancellationToken)
   at System.IO.Stream.<CopyToAsync>g__Core|29_0(Stream source, Stream destination, Int32 bufferSize, CancellationToken cancellationToken)
   at System.IO.Compression.DeflateStream.CopyToStream.CopyFromSourceToDestinationAsync()
   at Jellyfin.Plugin.Bookshelf.Providers.Epub.EpubMetadataImageProvider.LoadCover(ZipArchive epub, XmlDocument opf, String opfRootDirectory)
   at MediaBrowser.Providers.Manager.ItemImageProvider.RefreshFromProvider(BaseItem item, IDynamicImageProvider provider, ImageRefreshOptions refreshOptions, TypeOptions savedOptions, ICollection`1 downloadedImages, RefreshResult result, CancellationToken cancellationToken)
[2024-01-14 23:19:16.060 -05:00] [INF] [167] Emby.Server.Implementations.IO.LibraryMonitor: "Brandon Sanderson" ("/data/books/Books/Brandon Sanderson") will be refreshed.
[2024-01-14 23:19:16.060 -05:00] [INF] [167] Emby.Server.Implementations.IO.LibraryMonitor: "Long Chills and Case Dough" ("/data/books/Books/Brandon Sanderson/Long_Chills_and_Case_Dough_by_Brandon_Sanderson.epub") will be refreshed.
[2024-01-14 23:19:16.060 -05:00] [INF] [167] Emby.Server.Implementations.IO.LibraryMonitor: "The Frugal Wizard’s Handbook for Surviving Medieval England" ("/data/books/Books/Brandon Sanderson/The_Frugal_Wizard_s_Handbook_for_Surviving_Medieval_England_by_Brandon_Sanderson.epub") will be refreshed.
[2024-01-14 23:19:16.060 -05:00] [INF] [167] Emby.Server.Implementations.IO.LibraryMonitor: "The Sunlit Man" ("/data/books/Books/Brandon Sanderson/The_Sunlit_Man_by_Brandon_Sanderson.epub") will be refreshed.
[2024-01-14 23:19:16.060 -05:00] [INF] [167] Emby.Server.Implementations.IO.LibraryMonitor: "Tress of the Emerald Sea" ("/data/books/Books/Brandon Sanderson/Tress_of_the_Emerald_Sea_by_Brandon_Sanderson.epub") will be refreshed.
[2024-01-14 23:19:16.060 -05:00] [INF] [167] Emby.Server.Implementations.IO.LibraryMonitor: "Yumi and the Nightmare Painter" ("/data/books/Books/Brandon Sanderson/Yumi_and_the_Nightmare_Painter_by_Brandon_Sanderson.epub") will be refreshed.
[2024-01-14 23:22:38.633 -05:00] [INF] [114] Emby.Server.Implementations.IO.LibraryMonitor: "Brandon Sanderson" ("/data/books/Books/Brandon Sanderson") will be refreshed.

Add Open Library as a metadata provider

They're operated by the Internet Archive and all their data is CC0.
https://openlibrary.org/

Here's their API documentation:
https://openlibrary.org/developers/api