From fca45b7220f96247f14b1c95b5444c41e3eff9a0 Mon Sep 17 00:00:00 2001 From: demitrix Date: Fri, 3 Jan 2025 16:05:01 +0000 Subject: [PATCH 1/2] Rework metadata scraping flow Redesign UI of meta results to allow selecting which elements of metainfo to save. Save button added to push changes to book record as cover is now optional to update. New save button does not close modal, allowing user to scrape multiple results. --- cps/static/css/style.css | 97 ++++++++++++++++++++++++++++++++++-- cps/static/js/get_meta.js | 56 +++++++++++++-------- cps/templates/book_edit.html | 78 +++++++++++++++++++++-------- 3 files changed, 186 insertions(+), 45 deletions(-) diff --git a/cps/static/css/style.css b/cps/static/css/style.css index 0bab5b5368..b127a52c66 100644 --- a/cps/static/css/style.css +++ b/cps/static/css/style.css @@ -382,14 +382,103 @@ input.pill:not(:checked) + label .glyphicon { display: none; } overflow-y: scroll; } -.media-list { padding-right: 15px; } +#meta-info #book-list { + list-style-type: none; + padding: 0px 15px 0px 0px; +} + +#meta-info #book-list .media { + display: flex; + background-color: #f9f9f9; + margin-bottom: 20px; + border-radius: 8px; + overflow: hidden; + box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1); +} + +#meta-info #book-list .media .media-image { + width: 200px; + padding: 20px; + display: flex; + flex-direction: column; + align-items: center; + position: relative; +} + +#meta-info #book-list .media .media-image-wrapper { + position: relative; + width: 100%; +} + +#meta-info #book-list .media .media-image img { + max-width: 100%; + height: auto; + border-radius: 4px; + display: block; +} +#meta-info #book-list .media .media-image .image-dimensions { + position: absolute; + bottom: 5px; + right: 5px; + background-color: rgba(0, 0, 0, 0.7); + color: white; + padding: 4px 8px; + border-radius: 4px; + font-size: 12px; +} +#meta-info #book-list .media .media-image .image-dimensions.larger { + background-color: rgba(0, 160, 0, 0.7); +} +#meta-info #book-list .media .media-image .image-dimensions.smaller { + background-color: rgba(160, 0, 0, 0.7); +} +#meta-info #book-list .media .media-image input { + position: absolute; + top: 5px; + right: 5px; + width: 20px; + height: 20px; +} -#meta-info img { - max-height: 150px; - max-width: 100px; +#meta-info #book-list .media .media-image button { + margin-top: 10px; + /* padding: 8px 16px; */ cursor: pointer; } +#meta-info #book-list .media .media-image div { + margin-top: 10px; + font-size: 0.9em; + color: #666; + text-align: center; +} + +#meta-info #book-list .media .media-body { + flex: 1; + padding: 20px; + display: grid; + grid-template-columns: auto 1fr; + gap: 10px; + align-content: start; +} + +#meta-info #book-list .media .media-body dt { + font-weight: bold; + color: #333; + display: flex; + align-items: center; +} + +#meta-info #book-list .media .media-body dt input { + margin-right: 5px; + margin-top: 0px; +} + +#meta-info #book-list .media .media-body dd { + margin: 0; + color: #666; +} + .padded-bottom { margin-bottom: 15px; } .upload-format-input-text { display: initial; } #btn-upload-format { display: none; } diff --git a/cps/static/js/get_meta.js b/cps/static/js/get_meta.js index df4119dca2..d2171909d7 100644 --- a/cps/static/js/get_meta.js +++ b/cps/static/js/get_meta.js @@ -37,27 +37,43 @@ $(function () { return presentArray } - function populateForm (book) { - tinymce.get("comments").setContent(book.description); - var uniqueTags = getUniqueValues('tags', book) + function populateForm (book, idx) { + var updateItems = Object.fromEntries(Array.from(document.querySelectorAll(`[data-meta-index="${idx}"]`)).map((value)=>[value.dataset.metaValue, value.checked])) + if (updateItems.description){ + tinymce.get("comments").setContent(book.description); + } + if (updateItems.tags){ + var uniqueTags = getUniqueValues('tags', book) + $("#tags").val(uniqueTags.join(", ")); + } var uniqueLanguages = getUniqueValues('languages', book) - var ampSeparatedAuthors = (book.authors || []).join(" & "); - $("#authors").val(ampSeparatedAuthors); - $("#title").val(book.title); - $("#tags").val(uniqueTags.join(", ")); + if (updateItems.authors){ + var ampSeparatedAuthors = (book.authors || []).join(" & "); + $("#authors").val(ampSeparatedAuthors); + } + if (updateItems.titles){ + $("#title").val(book.title); + } $("#languages").val(uniqueLanguages.join(", ")); $("#rating").data("rating").setValue(Math.round(book.rating)); - if(book.cover && $("#cover_url").length){ + + if(updateItems.cover && book.cover && $("#cover_url").length){ $(".cover img").attr("src", book.cover); $("#cover_url").val(book.cover); } - $("#pubdate").val(book.publishedDate); - $("#publisher").val(book.publisher); - if (typeof book.series !== "undefined") { + if (updateItems.pubDate){ + $("#pubdate").val(book.publishedDate); + } + if (updateItems.publisher){ + $("#publisher").val(book.publisher); + } + if (updateItems.series && typeof book.series !== "undefined") { $("#series").val(book.series); + } + if (updateItems.series_index && typeof book.series_index !== "undefined"){ $("#series_index").val(book.series_index); } - if (typeof book.identifiers !== "undefined") { + if (updateItems.identifiers && typeof book.identifiers !== "undefined") { populateIdentifiers(book.identifiers) } } @@ -94,10 +110,10 @@ $(function () { success: function success(data) { if (data.length) { $("#meta-info").html(""); - data.forEach(function(book) { - var $book = $(templates.bookResult(book)); - $book.find("img").on("click", function () { - populateForm(book); + data.forEach(function(book,idx) { + var $book = $(templates.bookResult({"book":book,"index":idx})); + $book.find("button").on("click", function () { + populateForm(book,idx); }); $("#book-list").append($book); }); @@ -150,10 +166,10 @@ $(function () { data: JSON.stringify(params), success: function success(data) { element.data("initial", "true"); - data.forEach(function(book) { - var $book = $(templates.bookResult(book)); - $book.find("img").on("click", function () { - populateForm(book); + data.forEach(function(book,idx) { + var $book = $(templates.bookResult({"book":book,"index":idx})); + $book.find("button").on("click", function () { + populateForm(book,idx); }); $("#book-list").append($book); }); diff --git a/cps/templates/book_edit.html b/cps/templates/book_edit.html index 615b40c2e8..1b7cb0ef34 100644 --- a/cps/templates/book_edit.html +++ b/cps/templates/book_edit.html @@ -263,28 +263,56 @@

{{_('Fetch Metadata')}}< {% block js %} From a5f7b1b5711e6145eac49154a8f24cc585c3c459 Mon Sep 17 00:00:00 2001 From: demitrix Date: Mon, 6 Jan 2025 17:59:14 +0000 Subject: [PATCH 2/2] Initial commit Adds Hardcover.app as a metadata provider Adds option to sync Kobo Shelves/Read Progress to Hardcover.app --- cps/admin.py | 2 + cps/config_sql.py | 1 + cps/db.py | 4 + cps/kobo.py | 7 +- cps/metadata_provider/amazon.py | 2 +- cps/metadata_provider/comicvine.py | 2 +- cps/metadata_provider/douban.py | 2 +- cps/metadata_provider/google.py | 2 +- cps/metadata_provider/hardcover.py | 255 ++++++++++++++++++++++++++ cps/metadata_provider/lubimyczytac.py | 2 +- cps/metadata_provider/scholar.py | 2 +- cps/search_metadata.py | 2 +- cps/services/Metadata.py | 1 + cps/services/__init__.py | 6 + cps/services/hardcover.py | 232 +++++++++++++++++++++++ cps/shelf.py | 8 +- cps/static/js/get_meta.js | 191 ++++++++++++------- cps/templates/book_edit.html | 9 +- cps/templates/config_edit.html | 4 + cps/templates/detail.html | 2 +- cps/templates/user_edit.html | 6 + cps/ub.py | 10 + cps/web.py | 11 +- 23 files changed, 683 insertions(+), 80 deletions(-) create mode 100644 cps/metadata_provider/hardcover.py create mode 100644 cps/services/hardcover.py diff --git a/cps/admin.py b/cps/admin.py index 3ac5eff993..0573a8e95f 100644 --- a/cps/admin.py +++ b/cps/admin.py @@ -63,6 +63,7 @@ 'ldap': bool(services.ldap), 'goodreads': bool(services.goodreads_support), 'kobo': bool(services.kobo), + 'hardcover' : bool(services.hardcover), 'updater': constants.UPDATER_AVAILABLE, 'gmail': bool(services.gmail), 'scheduler': schedule.use_APScheduler, @@ -1801,6 +1802,7 @@ def _configuration_update_helper(): reboot_required |= _config_checkbox_int(to_save, "config_kobo_sync") _config_int(to_save, "config_external_port") _config_checkbox_int(to_save, "config_kobo_proxy") + _config_checkbox_int(to_save, "config_hardcover_sync") if "config_upload_formats" in to_save: to_save["config_upload_formats"] = ','.join( diff --git a/cps/config_sql.py b/cps/config_sql.py index 7e7d033d1c..d0164a407d 100644 --- a/cps/config_sql.py +++ b/cps/config_sql.py @@ -98,6 +98,7 @@ class _Settings(_Base): config_public_reg = Column(SmallInteger, default=0) config_remote_login = Column(Boolean, default=False) config_kobo_sync = Column(Boolean, default=False) + config_hardcover_sync = Column(Boolean, default=False) config_default_role = Column(SmallInteger, default=0) config_default_show = Column(SmallInteger, default=constants.ADMIN_USER_SIDEBAR) diff --git a/cps/db.py b/cps/db.py index 38b3f07fd2..f379ceb239 100644 --- a/cps/db.py +++ b/cps/db.py @@ -155,6 +155,8 @@ def format_type(self): return "Lubimyczytac" if format_type == "databazeknih": return "Databáze knih" + if format_type == "hardcover-slug": + return "Hardcover" else: return self.type @@ -194,6 +196,8 @@ def __repr__(self): return "http://www.isfdb.org/cgi-bin/pl.cgi?{0}".format(self.val) elif format_type == "databazeknih": return "https://www.databazeknih.cz/knihy/{0}".format(self.val) + elif format_type == "hardcover-slug": + return "https://hardcover.app/books/{0}".format(self.val) elif self.val.lower().startswith("javascript:"): return quote(self.val) elif self.val.lower().startswith("data:"): diff --git a/cps/kobo.py b/cps/kobo.py index 34bf5be4f7..92f1b12f9f 100644 --- a/cps/kobo.py +++ b/cps/kobo.py @@ -49,7 +49,7 @@ from .epub import get_epub_layout from .constants import COVER_THUMBNAIL_SMALL, COVER_THUMBNAIL_MEDIUM, COVER_THUMBNAIL_LARGE from .helper import get_download_link -from .services import SyncToken as SyncToken +from .services import SyncToken as SyncToken, hardcover from .web import download_required from .kobo_auth import requires_kobo_auth, get_auth_token @@ -769,6 +769,7 @@ def HandleStateRequest(book_uuid): try: request_data = request.json + log.debug(request_data) request_reading_state = request_data["ReadingStates"][0] request_bookmark = request_reading_state["CurrentBookmark"] @@ -805,6 +806,10 @@ def HandleStateRequest(book_uuid): ub.session.rollback() abort(400, description="Malformed request data is missing 'ReadingStates' key") + if config.config_hardcover_sync and bool(hardcover): + hardcoverClient = hardcover.HardcoverClient(current_user.hardcover_token) + hardcoverClient.update_reading_progress(book.identifiers, request_bookmark["ProgressPercent"]) + ub.session.merge(kobo_reading_state) ub.session_commit() return jsonify({ diff --git a/cps/metadata_provider/amazon.py b/cps/metadata_provider/amazon.py index 5b07819cba..09ef1eb25a 100644 --- a/cps/metadata_provider/amazon.py +++ b/cps/metadata_provider/amazon.py @@ -53,7 +53,7 @@ class Amazon(Metadata): session.headers=headers def search( - self, query: str, generic_cover: str = "", locale: str = "en" + self, query: str, generic_cover: str = "", locale: str = "en",**kwargs ) -> Optional[List[MetaRecord]]: def inner(link, index) -> [dict, int]: with self.session as session: diff --git a/cps/metadata_provider/comicvine.py b/cps/metadata_provider/comicvine.py index b4d8d34cec..b51c1c9cfa 100644 --- a/cps/metadata_provider/comicvine.py +++ b/cps/metadata_provider/comicvine.py @@ -41,7 +41,7 @@ class ComicVine(Metadata): HEADERS = {"User-Agent": "Not Evil Browser"} def search( - self, query: str, generic_cover: str = "", locale: str = "en" + self, query: str, generic_cover: str = "", locale: str = "en",**kwargs ) -> Optional[List[MetaRecord]]: val = list() if self.active: diff --git a/cps/metadata_provider/douban.py b/cps/metadata_provider/douban.py index 1dd12d8aec..316fbea9dc 100644 --- a/cps/metadata_provider/douban.py +++ b/cps/metadata_provider/douban.py @@ -71,7 +71,7 @@ class Douban(Metadata): def search(self, query: str, generic_cover: str = "", - locale: str = "en") -> List[MetaRecord]: + locale: str = "en",**kwargs) -> List[MetaRecord]: val = [] if self.active: log.debug(f"start searching {query} on douban") diff --git a/cps/metadata_provider/google.py b/cps/metadata_provider/google.py index df9c0dc249..150dab5ed1 100644 --- a/cps/metadata_provider/google.py +++ b/cps/metadata_provider/google.py @@ -40,7 +40,7 @@ class Google(Metadata): ISBN_TYPE = "ISBN_13" def search( - self, query: str, generic_cover: str = "", locale: str = "en" + self, query: str, generic_cover: str = "", locale: str = "en",**kwargs ) -> Optional[List[MetaRecord]]: val = list() if self.active: diff --git a/cps/metadata_provider/hardcover.py b/cps/metadata_provider/hardcover.py new file mode 100644 index 0000000000..9e36f0c8ab --- /dev/null +++ b/cps/metadata_provider/hardcover.py @@ -0,0 +1,255 @@ +# -*- coding: utf-8 -*- + +# This file is part of the Calibre-Web (https://github.com/janeczku/calibre-web) +# Copyright (C) 2021 OzzieIsaacs +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# Hardcover api document: https://Hardcover.gamespot.com/api/documentation +from typing import Dict, List, Optional +from urllib.parse import quote + +import requests +from cps import logger +from cps.services.Metadata import MetaRecord, MetaSourceInfo, Metadata +from importlib import reload + +from flask import g + +log = logger.create() + + +class Hardcover(Metadata): + __name__ = "Hardcover" + __id__ = "hardcover" + DESCRIPTION = "Hardcover Books" + META_URL = "https://hardcover.app" + BASE_URL = "https://api.hardcover.app/v1/graphql" + # SEARCH_QUERY = """{ + # books( + # where: {title: {_eq: "%s"}} + # limit: 10 + # order_by: {users_read_count: desc} + # ) { + # title + # book_series { + # series { + # name + # } + # position + # } + # cached_contributors + # id + # cached_image + # slug + # description + # release_date + # cached_tags + # } + # }""" + SEARCH_QUERY = """query Search($query: String!) { + search(query: $query, query_type: "Book", per_page: 50) { + results + } + } + """ + EDITION_QUERY = """query getEditions($query: Int!) { + books( + where: { id: { _eq: $query } } + order_by: { users_read_count: desc_nulls_last } + ) { + title + slug + id + + book_series { + series { + name + } + position + } + rating + editions( + where: { + _or: [{ reading_format_id: { _neq: 2 } }, { edition_format: { _is_null: true } }] + } + order_by: [{ reading_format_id: desc_nulls_last },{users_count: desc_nulls_last }] + ) { + id + isbn_13 + isbn_10 + title + reading_format_id + contributions { + author { + name + } + } + image { + url + } + language { + code3 + } + publisher { + name + } + release_date + + } + description + cached_tags(path: "Genre") + } + } + """ + HEADERS = { + "Content-Type": "application/json", + } + FORMATS = ["","Physical Book","","","E-Book"] # Map reading_format_id to text equivelant. + + def search( + self, query: str, generic_cover: str = "", locale: str = "en", **kwargs + ) -> Optional[List[MetaRecord]]: + token = kwargs.get("token") + if not token: + log.warning("Hardcover token not set for user") + return None + val = list() + if self.active: + try: + if (token == ""): + raise Exception("Current user does not have Hardcover API token") + else: + edition_seach = query.split(":")[0] == "hardcover-id" + Hardcover.HEADERS["Authorization"] = "Bearer %s" % token + result = requests.post( + Hardcover.BASE_URL, + json={ + "query":Hardcover.SEARCH_QUERY if not edition_seach else Hardcover.EDITION_QUERY, + "variables":{"query":query if not edition_seach else query.split(":")[1]} + }, + headers=Hardcover.HEADERS, + ) + result.raise_for_status() + except Exception as e: + log.warning(e) + return None + if edition_seach: + result = result.json()["data"]["books"][0] + log.debug(result) + val = self._parse_edition_results(result=result, generic_cover=generic_cover, locale=locale) + else: + for result in result.json()["data"]["search"]["results"]["hits"]: + match = self._parse_title_result( + result=result, generic_cover=generic_cover, locale=locale + ) + val.append(match) + return val + + def _parse_title_result( + self, result: Dict, generic_cover: str, locale: str + ) -> MetaRecord: + series = result["document"].get("featured_series",{}).get("series_name", "") + series_index = result["document"].get("featured_series",{}).get("position", "") + match = MetaRecord( + id=result["document"].get("id",""), + title=result["document"].get("title",""), + authors=result["document"].get("author_names", []), + url=self._parse_title_url(result, ""), + source=MetaSourceInfo( + id=self.__id__, + description=Hardcover.DESCRIPTION, + link=Hardcover.META_URL, + ), + series=series, + ) + # TODO Add parse cover function to get better size + match.cover = result["document"]["image"].get("url", generic_cover) + + match.description = result["document"].get("description","") + match.publishedDate = result["document"].get( + "release_date", "") + match.series_index = series_index + match.tags = result["document"].get("genres",[]) + match.identifiers = { + "hardcover-id": match.id, + "hardcover-slug": result["document"].get("slug", "") + } + return match + + def _parse_edition_results( + self, result: Dict, generic_cover: str, locale: str + ) -> MetaRecord: + editions = list() + id = result.get("id","") + for edition in result["editions"]: + match = MetaRecord( + id=id, + title=edition.get("title",""), + authors=self._parse_edition_authors(edition,[]), + url=self._parse_edition_url(edition, ""), + source=MetaSourceInfo( + id=self.__id__, + description=Hardcover.DESCRIPTION, + link=Hardcover.META_URL, + ), + series=result.get("book_series",[{}])[0].get("series",{}).get("name", ""), + ) + # TODO Add parse cover function to get better size + match.cover = (edition.get("image") or {}).get("url", generic_cover) + match.description = result.get("description","") + match.publisher = (edition.get("publisher") or {}).get("name","") + match.publishedDate = edition.get("release_date", "") + match.series_index = result.get("book_series",[{}])[0].get("position", "") + match.tags = self._parse_tags(result,[]) + match.languages = (edition.get("language") or {}).get("code3","") + match.identifiers = { + "hardcover-id": id, + "hardcover-slug": result.get("slug", ""), + "hardcover-edition": edition.get("id",""), + "isbn": (edition.get("isbn_13",edition.get("isbn_10")) or "") + } + match.format = Hardcover.FORMATS[edition.get("reading_format_id",0)] + editions.append(match) + return editions + + @staticmethod + def _parse_title_url(result: Dict, url: str) -> str: + hardcover_slug = result["document"].get("slug", "") + if hardcover_slug: + return f"https://hardcover.app/books/{hardcover_slug}" + return url + + @staticmethod + def _parse_edition_url(edition: Dict, url: str) -> str: + hardcover_edition = edition.get("id", "") + if hardcover_edition: + return f"https://hardcover.app/books/jurassic-park/editions/{hardcover_edition}" + return url + + @staticmethod + def _parse_edition_authors(edition: Dict, authors: List[str]) -> List[str]: + try: + return [author["author"]["name"] for author in edition.get("contributions",[]) if "author" in author and "name" in author["author"]] + except Exception as e: + log.warning(e) + return authors + + @staticmethod + def _parse_tags(result: Dict, tags: List[str]) -> List[str]: + try: + return [item["tag"] for item in result["cached_tags"] if "tag" in item] + except Exception as e: + log.warning(e) + return tags diff --git a/cps/metadata_provider/lubimyczytac.py b/cps/metadata_provider/lubimyczytac.py index 9d4a99f81e..003a732e88 100644 --- a/cps/metadata_provider/lubimyczytac.py +++ b/cps/metadata_provider/lubimyczytac.py @@ -114,7 +114,7 @@ class LubimyCzytac(Metadata): SUMMARY = "//script[@type='application/ld+json']//text()" def search( - self, query: str, generic_cover: str = "", locale: str = "en" + self, query: str, generic_cover: str = "", locale: str = "en",**kwargs ) -> Optional[List[MetaRecord]]: if self.active: try: diff --git a/cps/metadata_provider/scholar.py b/cps/metadata_provider/scholar.py index 5f63234307..b3bfbb720d 100644 --- a/cps/metadata_provider/scholar.py +++ b/cps/metadata_provider/scholar.py @@ -40,7 +40,7 @@ class scholar(Metadata): META_URL = "https://scholar.google.com/" def search( - self, query: str, generic_cover: str = "", locale: str = "en" + self, query: str, generic_cover: str = "", locale: str = "en",**kwargs ) -> Optional[List[MetaRecord]]: val = list() if self.active: diff --git a/cps/search_metadata.py b/cps/search_metadata.py index ae3c9faf91..9700c9c20b 100644 --- a/cps/search_metadata.py +++ b/cps/search_metadata.py @@ -130,7 +130,7 @@ def metadata_search(): # ret = cl[0].search(query, static_cover, locale) with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor: meta = { - executor.submit(c.search, query, static_cover, locale): c + executor.submit(c.search, query, static_cover, locale, token=getattr(current_user,f'{c.__id__}_token',None)): c for c in cl if active.get(c.__id__, True) } diff --git a/cps/services/Metadata.py b/cps/services/Metadata.py index ab4fd48239..d975092f81 100644 --- a/cps/services/Metadata.py +++ b/cps/services/Metadata.py @@ -48,6 +48,7 @@ class MetaRecord: rating: Optional[int] = 0 languages: Optional[List[str]] = dataclasses.field(default_factory=list) tags: Optional[List[str]] = dataclasses.field(default_factory=list) + format: Optional[str] = None class Metadata: diff --git a/cps/services/__init__.py b/cps/services/__init__.py index f93eca3407..000a6f9a89 100644 --- a/cps/services/__init__.py +++ b/cps/services/__init__.py @@ -48,3 +48,9 @@ except ImportError as err: log.debug("Cannot import gmail, sending books via Gmail Oauth2 Verification will not work: %s", err) gmail = None + +try: + from . import hardcover +except ImportError as err: + log.debug("Cannot import hardcover, syncing Kobo read progress to Hardcover will not work: %s", err) + hardcover = None \ No newline at end of file diff --git a/cps/services/hardcover.py b/cps/services/hardcover.py new file mode 100644 index 0000000000..e293fb749d --- /dev/null +++ b/cps/services/hardcover.py @@ -0,0 +1,232 @@ +# -*- coding: utf-8 -*- + +# This file is part of the Calibre-Web (https://github.com/janeczku/calibre-web) +# Copyright (C) 2018-2019 OzzieIsaacs, pwr +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from datetime import datetime +import requests + +from .. import logger + +log = logger.create() + +GRAPHQL_ENDPOINT = "https://api.hardcover.app/v1/graphql" + +USER_BOOK_FRAGMENT = """ + fragment userBookFragment on user_books { + id + status_id + book_id + book { + slug + title + } + edition { + id + pages + } + user_book_reads(order_by: {started_at: desc}, limit: 1) { + id + started_at + finished_at + edition_id + progress_pages + } + }""" + +class HardcoverClient: + def __init__(self, token): + self.endpoint = GRAPHQL_ENDPOINT + self.headers = { + "Content-Type": "application/json", + "Authorization" : f"Bearer {token}" + } + self.privacy = self.get_privacy() + + def get_privacy(self): + query = """ + { + me { + account_privacy_setting_id + } + }""" + response = self.execute(query) + return (response.get("me")[0] or [{}]).get("account_privacy_setting_id",1) + + def get_user_book(self, ids): + query = "" + variables={} + if "hardcover-edition" in ids: + query = """ + query ($query: Int) { + me { + user_books(where: {edition_id: {_eq: $query}}) { + ...userBookFragment + } + } + }""" + variables["query"] = ids["hardcover-edition"] + elif "hardcover-id" in ids: + query = """ + query ($query: Int) { + me { + user_books(where: {book: {id: {_eq: $query}}}) { + ...userBookFragment + } + } + }""" + variables["query"] = ids["hardcover-id"] + elif "hardcover-slug" in ids: + query = """ + query ($slug: String!) { + me { + user_books(where: {book: {slug: {_eq: $query}}}) { + ...userBookFragment + } + } + }""" + variables["query"] = ids["hardcover-slug"] + query += USER_BOOK_FRAGMENT + response = self.execute(query,variables) + return next(iter(response.get("me")[0].get("user_books")),None) + + + # TODO Add option for autocreate of missing books instead of forcing it. + def update_reading_progress(self, identifiers, progress_percent): + ids = self.parse_identifiers(identifiers) + book = self.get_user_book(ids) + if not book: + book = self.add_book(ids, status=2) + if book.get("status_id") is not 2: + book = self.change_book_status(book, 2) + pages = round(book.get("edition",{}).get("pages",0) * (progress_percent / 100)) + log.debug(pages) + read = next(iter(book.get("user_book_reads")),None) + if not read: + read = self.add_read(book, pages) + log.debug(read) + mutation = """ + mutation ($readId: Int!, $pages: Int, $editionId: Int, $startedAt: date, $finishedAt: date) { + update_user_book_read(id: $readId, object: { + progress_pages: $pages, + edition_id: $editionId, + started_at: $startedAt, + finished_at: $finishedAt + }) { + id + } + }""" + variables = { + "readId": int(read.get("id")), + "pages": pages, + "editionId": int(book.get("edition").get("id")), + "startedAt":read.get("started_at",datetime.now().strftime("%Y-%m-%d")), + "finishedAt": datetime.now().strftime("%Y-%m-%d") if progress_percent is 100 else None + } + if progress_percent is 100: + self.change_book_status(book, 3) + return self.execute(query=mutation, variables=variables) + + def change_book_status(self, book, status): + mutation = """ + mutation ($id:Int!, $status_id: Int!) { + update_user_book(id: $id, object: {status_id: $status_id}) { + error + user_book { + ...userBookFragment + } + } + }""" + USER_BOOK_FRAGMENT + variables = { + "id":book.get("id"), + "status_id":status + } + response = self.execute(query=mutation, variables=variables) + return response.get("update_user_book",{}).get("user_book",{}) + + def add_book(self, identifiers, status=1): + ids = self.parse_identifiers(identifiers) + mutation = """ + mutation ($object: UserBookCreateInput!) { + insert_user_book(object: $object) { + error + user_book { + ...userBookFragment + } + } + }""" + USER_BOOK_FRAGMENT + variables = { + "object": { + "book_id":int(ids.get("hardcover-id")), + "edition_id":int(ids.get("hardcover-edition")) if ids.get("hardcover-edition") else None, + "status_id": status, + "privacy_setting_id": self.privacy + } + } + response = self.execute(query=mutation, variables=variables) + return response.get("insert_user_book",{}).get("user_book",{}) + + def add_read(self, book, pages=0): + mutation = """ + mutation ($id: Int!, $pages: Int, $editionId: Int, $startedAt: date) { + insert_user_book_read(user_book_id: $id, user_book_read: { + progress_pages: $pages, + edition_id: $editionId, + started_at: $startedAt, + }) { + error + user_book_read { + id + started_at + finished_at + edition_id + progress_pages + } + } + }""" + variables = { + "id":int(book.get("id")), + "editionId":int(book.get("edition").get("id")) if book.get("edition").get("id") else None, + "pages": pages, + "startedAt": datetime.now().strftime("%Y-%m-%d") + } + response = self.execute(query=mutation, variables=variables) + return response.get("insert_user_book_read").get("user_book_read") + + def parse_identifiers(self, identifiers): + if type(identifiers) != dict: + return {id.type:id.val for id in identifiers if "hardcover" in id.type} + return identifiers + + def execute(self, query, variables=None): + payload = { + "query": query, + "variables": variables or {} + } + + + response = requests.post(self.endpoint, json=payload, headers=self.headers) + try: + response.raise_for_status() + except requests.exceptions.HTTPError as e: + raise Exception(f"HTTP error occurred: {e}") + + result = response.json() + log.debug(result) + if "errors" in result: + raise Exception(f"GraphQL error: {result['errors']}") + + return result.get("data", {}) diff --git a/cps/shelf.py b/cps/shelf.py index e4f93909e2..94deaa7538 100644 --- a/cps/shelf.py +++ b/cps/shelf.py @@ -32,7 +32,7 @@ from . import calibre_db, config, db, logger, ub from .render_template import render_title_template from .usermanagement import login_required_if_no_ano, user_login_required - +from .services import hardcover log = logger.create() shelf = Blueprint('shelf', __name__) @@ -71,7 +71,8 @@ def add_to_shelf(shelf_id, book_id): else: maxOrder = maxOrder[0] - if not calibre_db.session.query(db.Books).filter(db.Books.id == book_id).one_or_none(): + book = calibre_db.session.query(db.Books).filter(db.Books.id == book_id).one_or_none() + if not book: log.error("Invalid Book Id: %s. Could not be added to shelf %s", book_id, shelf.name) if not xhr: flash(_("%(book_id)s is a invalid Book Id. Could not be added to Shelf", book_id=book_id), @@ -99,6 +100,9 @@ def add_to_shelf(shelf_id, book_id): return redirect(request.environ["HTTP_REFERER"]) else: return redirect(url_for('web.index')) + if shelf.kobo_sync and config.config_hardcover_sync and bool(hardcover): + hardcoverClient = hardcover.HardcoverClient(current_user.hardcover_token) + hardcoverClient.add_book(book.identifiers) return "", 204 diff --git a/cps/static/js/get_meta.js b/cps/static/js/get_meta.js index d2171909d7..819b3953b6 100644 --- a/cps/static/js/get_meta.js +++ b/cps/static/js/get_meta.js @@ -18,112 +18,160 @@ $(function () { var msg = i18nMsg; - var keyword = "" + var keyword = ""; var templates = { - bookResult: _.template( - $("#template-book-result").html() - ) + bookResult: _.template($("#template-book-result").html()), }; - function getUniqueValues(attribute_name, book){ - var presentArray = $.map($("#"+attribute_name).val().split(","), $.trim); - if ( presentArray.length === 1 && presentArray[0] === "") { + function getUniqueValues(attribute_name, book) { + var presentArray = $.map( + $("#" + attribute_name) + .val() + .split(","), + $.trim + ); + if (presentArray.length === 1 && presentArray[0] === "") { presentArray = []; } - $.each(book[attribute_name], function(i, el) { + $.each(book[attribute_name], function (i, el) { if ($.inArray(el, presentArray) === -1) presentArray.push(el); }); - return presentArray + return presentArray; } - function populateForm (book, idx) { - var updateItems = Object.fromEntries(Array.from(document.querySelectorAll(`[data-meta-index="${idx}"]`)).map((value)=>[value.dataset.metaValue, value.checked])) - if (updateItems.description){ + function populateForm(book, idx) { + var updateItems = Object.fromEntries( + Array.from( + document.querySelectorAll(`[data-meta-index="${idx}"]`) + ).map((value) => [value.dataset.metaValue, value.checked]) + ); + if (updateItems.description) { tinymce.get("comments").setContent(book.description); } - if (updateItems.tags){ - var uniqueTags = getUniqueValues('tags', book) + if (updateItems.tags) { + var uniqueTags = getUniqueValues("tags", book); $("#tags").val(uniqueTags.join(", ")); } - var uniqueLanguages = getUniqueValues('languages', book) - if (updateItems.authors){ + var uniqueLanguages = getUniqueValues("languages", book); + if (updateItems.authors) { var ampSeparatedAuthors = (book.authors || []).join(" & "); $("#authors").val(ampSeparatedAuthors); } - if (updateItems.titles){ + if (updateItems.titles) { $("#title").val(book.title); } $("#languages").val(uniqueLanguages.join(", ")); $("#rating").data("rating").setValue(Math.round(book.rating)); - - if(updateItems.cover && book.cover && $("#cover_url").length){ + + if (updateItems.cover && book.cover && $("#cover_url").length) { $(".cover img").attr("src", book.cover); $("#cover_url").val(book.cover); } - if (updateItems.pubDate){ + if (updateItems.pubDate) { $("#pubdate").val(book.publishedDate); } - if (updateItems.publisher){ + if (updateItems.publisher) { $("#publisher").val(book.publisher); } if (updateItems.series && typeof book.series !== "undefined") { $("#series").val(book.series); } - if (updateItems.series_index && typeof book.series_index !== "undefined"){ + if ( + updateItems.series_index && + typeof book.series_index !== "undefined" + ) { $("#series_index").val(book.series_index); } - if (updateItems.identifiers && typeof book.identifiers !== "undefined") { - populateIdentifiers(book.identifiers) + if ( + updateItems.identifiers && + typeof book.identifiers !== "undefined" + ) { + populateIdentifiers(book.identifiers); } } - function populateIdentifiers(identifiers){ - for (const property in identifiers) { - console.log(`${property}: ${identifiers[property]}`); - if ($('input[name="identifier-type-'+property+'"]').length) { - $('input[name="identifier-val-'+property+'"]').val(identifiers[property]) - } - else { - addIdentifier(property, identifiers[property]) - } + function populateIdentifiers(identifiers) { + for (const property in identifiers) { + if (identifiers[property].length !== 0) { + console.log(`${property}: ${identifiers[property]}`); + if ( + $('input[name="identifier-type-' + property + '"]').length + ) { + $('input[name="identifier-val-' + property + '"]').val( + identifiers[property] + ); + } else { + addIdentifier(property, identifiers[property]); + } + } } } - function addIdentifier(name, value){ - var line = ''; - line += ''; - line += ''; - line += ''+_("Remove")+''; - line += ''; + function addIdentifier(name, value) { + var line = ""; + line += + ''; + line += + ''; + line += + '' + + _("Remove") + + ""; + line += ""; $("#identifier-table").append(line); } - function doSearch (keyword) { + function doSearch(keyword) { if (keyword) { $("#meta-info").text(msg.loading); $.ajax({ url: getPath() + "/metadata/search", type: "POST", - data: {"query": keyword}, + data: { query: keyword }, dataType: "json", success: function success(data) { if (data.length) { - $("#meta-info").html("
    "); - data.forEach(function(book,idx) { - var $book = $(templates.bookResult({"book":book,"index":idx})); + $("#meta-info").html( + '
      ' + ); + data.forEach(function (book, idx) { + var $book = $( + templates.bookResult({ book: book, index: idx }) + ); $book.find("button").on("click", function () { - populateForm(book,idx); + populateForm(book, idx); }); $("#book-list").append($book); }); - } - else { - $("#meta-info").html("

      " + msg.no_result + "!

      " + $("#meta-info")[0].innerHTML) + } else { + $("#meta-info").html( + '

      ' + + msg.no_result + + "!

      " + + $("#meta-info")[0].innerHTML + ); } }, error: function error() { - $("#meta-info").html("

      " + msg.search_error + "!

      " + $("#meta-info")[0].innerHTML); + $("#meta-info").html( + '

      ' + + msg.search_error + + "!

      " + + $("#meta-info")[0].innerHTML + ); }, }); } @@ -136,12 +184,25 @@ $(function () { type: "get", dataType: "json", success: function success(data) { - data.forEach(function(provider) { + data.forEach(function (provider) { var checked = ""; if (provider.active) { checked = "checked"; } - var $provider_button = '' + var $provider_button = + ''; $("#metadata_provider").append($provider_button); }); }, @@ -152,36 +213,38 @@ $(function () { var element = $(this); var id = element.data("control"); var initial = element.data("initial"); - var val = element.prop('checked'); - var params = {id : id, value: val}; + var val = element.prop("checked"); + var params = { id: id, value: val }; if (!initial) { - params['initial'] = initial; - params['query'] = keyword; + params["initial"] = initial; + params["query"] = keyword; } $.ajax({ - method:"post", + method: "post", contentType: "application/json; charset=utf-8", dataType: "json", url: getPath() + "/metadata/provider/" + id, data: JSON.stringify(params), success: function success(data) { element.data("initial", "true"); - data.forEach(function(book,idx) { - var $book = $(templates.bookResult({"book":book,"index":idx})); + data.forEach(function (book, idx) { + var $book = $( + templates.bookResult({ book: book, index: idx }) + ); $book.find("button").on("click", function () { - populateForm(book,idx); + populateForm(book, idx); }); $("#book-list").append($book); }); - } + }, }); }); $("#meta-search").on("submit", function (e) { e.preventDefault(); keyword = $("#keyword").val(); - $('.pill').each(function(){ - $(this).data("initial", $(this).prop('checked')); + $(".pill").each(function () { + $(this).data("initial", $(this).prop("checked")); }); doSearch(keyword); }); @@ -193,8 +256,8 @@ $(function () { keyword = bookTitle; doSearch(bookTitle); }); - $("#metaModal").on("show.bs.modal", function(e) { - $(e.relatedTarget).one('focus', function (e) { + $("#metaModal").on("show.bs.modal", function (e) { + $(e.relatedTarget).one("focus", function (e) { $(this).blur(); }); }); diff --git a/cps/templates/book_edit.html b/cps/templates/book_edit.html index 1b7cb0ef34..2a1cbb1e59 100644 --- a/cps/templates/book_edit.html +++ b/cps/templates/book_edit.html @@ -276,6 +276,9 @@

      {{_('Fetch Metadata')}}< + <% if(book.format !== "") { %> +
      Format: <%= book.format %>
      + <% } %>
      Title:
      @@ -308,8 +311,10 @@

      {{_('Fetch Metadata')}}< <% } %> <% if (Object.keys(book.identifiers).length !== 0 ) { %> <% for (const key in book.identifiers) { %> -
      Identifier
      -
      <%= key %>:<%= book.identifiers[key] %>
      + <% if (book.identifiers[key] !== "") { %> +
      Identifier
      +
      <%= key %>:<%= book.identifiers[key] %>
      + <% } %> <% } %> <% } %>

      diff --git a/cps/templates/config_edit.html b/cps/templates/config_edit.html index 4018db2e99..5d93f17e7b 100644 --- a/cps/templates/config_edit.html +++ b/cps/templates/config_edit.html @@ -149,6 +149,10 @@

      +
      + + +
      {% endif %} {% if feature_support['goodreads'] %} diff --git a/cps/templates/detail.html b/cps/templates/detail.html index b273ef9eec..bc3ab48529 100644 --- a/cps/templates/detail.html +++ b/cps/templates/detail.html @@ -171,7 +171,7 @@

      {{ entry.title }}

      - {% for identifier in entry.identifiers %} + {% for identifier in entry.identifiers if identifier.__repr__() != identifier.val %} {{ identifier.format_type() }} {% endfor %} diff --git a/cps/templates/user_edit.html b/cps/templates/user_edit.html index b24c6ec069..ed3b7b1179 100644 --- a/cps/templates/user_edit.html +++ b/cps/templates/user_edit.html @@ -60,6 +60,12 @@

      {{title}}

      {% endfor %}
      {% endif %} + {% if kobo_support and hardcover_support and not new_user %} +
      + + +
      + {% endif %} {% if kobo_support and not new_user %}
      diff --git a/cps/ub.py b/cps/ub.py index 0e15b8e2bd..f0ba832962 100644 --- a/cps/ub.py +++ b/cps/ub.py @@ -257,6 +257,7 @@ class User(UserBase, Base): remote_auth_token = relationship('RemoteAuthToken', backref='user', lazy='dynamic') view_settings = Column(JSON, default={}) kobo_only_shelves_sync = Column(Integer, default=0) + hardcover_token = Column(String, unique=True, default="") if oauth_support: @@ -600,6 +601,15 @@ def migrate_user_session_table(engine, _session): conn.execute(text("ALTER TABLE user_session ADD column 'expiry' Integer")) trans.commit() +def migrate_user_table(engine, _session): + try: + _session.query(exists().where(User.hardcover_token)).scalar() + _session.commit() + except exc.OperationalError: # Database is not compatible, some columns are missing + with engine.connect() as conn: + trans = conn.begin() + conn.execute(text("ALTER TABLE user ADD column 'hardcover_token' String")) + trans.commit() # Migrate database to current version, has to be updated after every database change. Currently migration from # maybe 4/5 versions back to current should work. diff --git a/cps/web.py b/cps/web.py index 12e8454d4d..08af5d2953 100644 --- a/cps/web.py +++ b/cps/web.py @@ -65,7 +65,8 @@ feature_support = { 'ldap': bool(services.ldap), 'goodreads': bool(services.goodreads_support), - 'kobo': bool(services.kobo) + 'kobo': bool(services.kobo), + 'hardcover' : bool(services.hardcover) } try: @@ -1465,7 +1466,7 @@ def logout(): # ################################### Users own configuration ######################################################### -def change_profile(kobo_support, local_oauth_check, oauth_status, translations, languages): +def change_profile(kobo_support, hardcover_support, local_oauth_check, oauth_status, translations, languages): to_save = request.form.to_dict() current_user.random_books = 0 try: @@ -1493,6 +1494,7 @@ def change_profile(kobo_support, local_oauth_check, oauth_status, translations, current_user.kobo_only_shelves_sync = int(to_save.get("kobo_only_shelves_sync") == "on") or 0 if old_state == 0 and current_user.kobo_only_shelves_sync == 1: kobo_sync_status.update_on_sync_shelfs(current_user.id) + current_user.hardcover_token = to_save.get("hardcover_token","").replace("Bearer ","") except Exception as ex: flash(str(ex), category="error") @@ -1505,6 +1507,7 @@ def change_profile(kobo_support, local_oauth_check, oauth_status, translations, title=_("%(name)s's Profile", name=current_user.name), page="me", kobo_support=kobo_support, + hardcover_support=hardcover_support, registered_oauth=local_oauth_check, oauth_status=oauth_status) @@ -1536,6 +1539,7 @@ def profile(): languages = calibre_db.speaking_language() translations = get_available_locale() kobo_support = feature_support['kobo'] and config.config_kobo_sync + hardcover_support = feature_support['hardcover'] and config.config_hardcover_sync if feature_support['oauth'] and config.config_login_type == 2: oauth_status = get_oauth_status() local_oauth_check = oauth_check @@ -1544,7 +1548,7 @@ def profile(): local_oauth_check = {} if request.method == "POST": - change_profile(kobo_support, local_oauth_check, oauth_status, translations, languages) + change_profile(kobo_support, hardcover_support, local_oauth_check, oauth_status, translations, languages) return render_title_template("user_edit.html", translations=translations, profile=1, @@ -1552,6 +1556,7 @@ def profile(): content=current_user, config=config, kobo_support=kobo_support, + hardcover_support=hardcover_support, title=_("%(name)s's Profile", name=current_user.name), page="me", registered_oauth=local_oauth_check,