Merge branch 'hardcover'

Author: demitrix

.github/workflows/dockerhub-build-push-on-push.yml

@@ -1,43 +1,63 @@
 name: Build & Push - Dev
-# Automatically builds and pushes a multi-platform dev image based on commits involving key files
+# Automatically builds and pushes a multi-platform dev image based on commits involving key files in any branch
 
 on:
   push:
     branches:
-      - main
+      - "**" # Runs on pushes to any branch
     paths:
       - "empty_library/**"
       - "root/**"
       - "scripts/**"
       - "**/Dockerfile"
+  create:
+    branches:
+      - "**" # Runs when a new branch is created
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    if: github.event.ref_type == 'branch' || github.event_name == 'push' # Ensures it runs for branch creation & push events
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout correct branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Determine Docker Image Tag
+        id: tag
+        run: |
+          if [[ "${{ github.ref_name }}" == "main" ]]; then
+            echo "IMAGE_TAG=dev" >> $GITHUB_ENV
+          else
+            echo "IMAGE_TAG=dev-${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
 
       - name: DockerHub Login
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_PA_TOKEN }}
 
+      - name: Install QEMU
+        run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
       - name: Build and push Docker image
         uses: docker/build-push-action@v6
         with:
+          provenance: false # Disable provenance metadata to fix BuildKit issues
           context: .
           file: ./Dockerfile
           push: true
           build-args: |
             BUILD_DATE=${{ github.event.repository.updated_at }}
-            VERSION=${{ vars.CURRENT_DEV_VERSION }}-DEV_BUILD-${{ vars.CURRENT_DEV_BUILD_NUM }}
+            VERSION=${{ vars.CURRENT_DEV_VERSION }}-DEV_BUILD-${{ env.IMAGE_TAG }}-${{ vars.CURRENT_DEV_BUILD_NUM }}
           tags: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/calibre-web-automated:dev
+            ${{ secrets.DOCKERHUB_USERNAME }}/calibre-web-automated:dev-${{ env.IMAGE_TAG }}
 
           platforms: linux/amd64,linux/arm64
 

README.md

@@ -295,6 +295,7 @@ And just like that, Calibre-Web Automated should be up and running! **HOWEVER**
 
 - CWA has been designed to make switching over as easy as possible. To migrate your CW instance to CWA, simply:
   1. Stop your instance of CW if it's still running
+  2. Whatever your `/books` bind was in Calibre-Web, should be your `/calibre-library` bind for CWA
   2. Mount the same `/config` folder in your Docker Compose that you were using for CW (or a copy of it to be extra safe)
   3. Mount the same folder containing your Calibre Library (the Docker Compose for the Linuxserver image of Calibre Web has this as `/books` by default)
 - And then you're done! All of your users, settings ect. should be automatically carried over into your new CWA instance! Enjoy!

root/app/calibre-web/cps/cwa_functions.py

@@ -1,4 +1,4 @@
-from flask import Blueprint, redirect, flash, url_for, request, send_from_directory, abort
+from flask import Blueprint, redirect, flash, url_for, request, send_from_directory, abort, jsonify, current_app
 from flask_babel import gettext as _
 
 from . import logger, config, constants, csrf
@@ -40,6 +40,7 @@
 
 # Folder where the log files are stored
 LOG_ARCHIVE = "/config/log_archive"
+DIRS_JSON = "/app/calibre-web-automated/dirs.json"
 
 ##———————————————————————————END OF GLOBAL VARIABLES——————————————————————————##
 
@@ -72,31 +73,66 @@ def cwa_switch_theme():
         config.config_default_show |= constants.DETAIL_RANDOM
 
     config.save()
-    return redirect("/", code=302)
+    return redirect(url_for("web.index"), code=302)
 
 ##————————————————————————————————————————————————————————————————————————————##
 ##                                                                            ##
 ##                             CWA LIBRARY REFRESH                            ##
 ##                                                                            ##
 ##————————————————————————————————————————————————————————————————————————————##
 
+def get_ingest_dir():
+    with open(DIRS_JSON, 'r') as f:
+        dirs = json.load(f)
+        return dirs['ingest_folder']
+
+def refresh_library(app):
+    with app.app_context():  # Create app context for session
+        ingest_dir = get_ingest_dir()
+        result = subprocess.run(['python3', '/app/calibre-web-automated/scripts/ingest_processor.py', ingest_dir])
+        return_code = result.returncode
+
+        # Add empty list for messages in app context if a list doesn't already exist
+        if "library_refresh_messages" not in current_app.config:
+            current_app.config["library_refresh_messages"] = []
+
+        if return_code == 2:
+            message = "Library Refresh 🔄 The book ingest service is already running ✋ Please wait until it has finished before trying again ⌛"
+        elif return_code == 0:
+            message = "Library Refresh 🔄 Library refreshed & ingest process complete! ✅"
+        else:
+            message = "Library Refresh 🔄 An unexpected error occurred, check the logs ⛔"
+        
+        # Display message to user in Web UI
+        current_app.config["library_refresh_messages"].append(message)
+        # Print result to docker log
+        print(message.replace('Library Refresh 🔄', '[library-refresh]'), flush=True)
+
+@csrf.exempt
 @library_refresh.route("/cwa-library-refresh", methods=["GET", "POST"])
 @login_required_if_no_ano
 def cwa_library_refresh():
-    flash(_("Library Refresh: Initialising Book Ingest System, please wait..."), category="cwa_refresh")
-    result = subprocess.run(['python3', '/app/calibre-web-automated/scripts/ingest_processor.py', '/cwa-book-ingest'])
-    return_code = result.returncode
-
-    # if return_code == 100:
-    #     flash(_(f"Library Refresh: Ingest process complete. New books ingested."), category="cwa_refresh")
-    if return_code == 2:
-        flash(_("Library Refresh: The book ingest service is already running, please wait until it has finished before trying again."), category="cwa_refresh")
-    elif return_code == 0:
-        flash(_("Library Refresh: Library refreshed & ingest process complete."), category="cwa_refresh")
-    else:
-        flash(_("Library Refresh: An unexpected error occurred, check the logs."), category="cwa_refresh")
+    print("[library-refresh] Library refresh manually triggered by user...", flush=True)
+    app = current_app._get_current_object()  # Get actual app instance
+
+    current_app.config["library_refresh_messages"] = []
+
+    # Run refresh_library() in a background thread
+    library_refresh_thread = Thread(target=refresh_library, args=(app,))
+    library_refresh_thread.start()
 
-    return redirect("/", code=302)
+    return jsonify({"message": "Library Refresh 🔄 Checking for any books that may have been missed, please wait..."}), 200
+
+@csrf.exempt
+@library_refresh.route("/cwa-library-refresh/messages", methods=["GET"])
+@login_required_if_no_ano
+def get_library_refresh_messages():
+    messages = current_app.config.get("library_refresh_messages", [])
+
+    # Clear messages after they have been retrieved
+    current_app.config["library_refresh_messages"] = []
+
+    return jsonify({"messages": messages})
 
 ##————————————————————————————————————————————————————————————————————————————##
 ##                                                                            ##
@@ -688,4 +724,4 @@ def get_status():
     progress = extract_progress(status)
     statusList = {'status':status,
                   'progress':progress}
-    return json.dumps(statusList)
+    return json.dumps(statusList)

root/app/calibre-web/cps/editbooks.py

@@ -214,6 +214,76 @@ def table_get_custom_enum(c_id):
 @edit_required
 def edit_list_book(param):
     vals = request.form.to_dict()
+    return edit_book_param(param, vals)
+
+@editbook.route("/ajax/editselectedbooks", methods=['POST'])
+@login_required_if_no_ano
+@edit_required
+def edit_selected_books():
+    d = request.get_json()
+    selections = d.get('selections')
+    title = d.get('title')
+    title_sort = d.get('title_sort')
+    author_sort = d.get('author_sort')
+    authors = d.get('authors')
+    categories = d.get('categories')
+    series = d.get('series')
+    languages = d.get('languages')
+    publishers = d.get('publishers')
+    comments = d.get('comments')
+    checkA = d.get('checkA')
+
+    if len(selections) != 0:
+        for book_id in selections:
+            vals = {
+                "pk": book_id,
+                "value": None,
+                "checkA": checkA,
+            }
+            if title:
+                vals['value'] = title
+                edit_book_param('title', vals)
+            if title_sort:
+                vals['value'] = title_sort
+                edit_book_param('sort', vals)
+            if author_sort:
+                vals['value'] = author_sort
+                edit_book_param('author_sort', vals)
+            if authors:
+                vals['value'] = authors
+                edit_book_param('authors', vals)
+            if categories:
+                vals['value'] = categories
+                edit_book_param('tags', vals)
+            if series:
+                vals['value'] = series
+                edit_book_param('series', vals)
+            if languages:
+                vals['value'] = languages
+                edit_book_param('languages', vals)
+            if publishers:
+                vals['value'] = publishers
+                edit_book_param('publishers', vals)
+            if comments:
+                vals['value'] = comments
+                edit_book_param('comments', vals)
+        return json.dumps({'success': True})
+    return ""
+
+# Separated from /editbooks so that /editselectedbooks can also use this
+#
+# param: the property of the book to be changed
+# vals - JSON Object:
+#   { 
+#       'pk': "the book id",
+#       'value': "changes value of param to what's passed here"
+#       'checkA': "Optional. Used to check if autosort author is enabled. Assumed as true if not passed"
+#       'checkT': "Optional. Used to check if autotitle author is enabled. Assumed as true if not passed"
+#   }
+#
+@login_required_if_no_ano
+@edit_required
+def edit_book_param(param, vals):
     book = calibre_db.get_book(vals['pk'])
     sort_param = ""
     ret = ""
@@ -353,6 +423,66 @@ def simulate_merge_list_book():
     return ""
 
 
+@editbook.route("/ajax/displayselectedbooks", methods=['POST'])
+@user_login_required
+@edit_required
+def display_selected_books():
+    vals = request.get_json().get('selections')
+    books = []
+    if vals:
+        for book_id in vals:
+            books.append(calibre_db.get_book(book_id).title)
+        return json.dumps({'books': books})
+    return ""
+
+@editbook.route("/ajax/archiveselectedbooks", methods=['POST'])
+@login_required_if_no_ano
+@edit_required
+def archive_selected_books():
+    vals = request.get_json().get('selections')
+    state = request.get_json().get('archive')
+    if vals:
+        for book_id in vals:
+            is_archived = change_archived_books(book_id, state,
+                                                message="Book {} archive bit set to: {}".format(book_id, state))
+            if is_archived:
+                kobo_sync_status.remove_synced_book(book_id)
+        return json.dumps({'success': True})
+    return ""
+
+@editbook.route("/ajax/deleteselectedbooks", methods=['POST'])
+@user_login_required
+@edit_required
+def delete_selected_books():
+    vals = request.get_json().get('selections')
+    if vals:
+        for book_id in vals:
+            delete_book_from_table(book_id, "", True)
+        return json.dumps({'success': True})
+    return ""
+
+@editbook.route("/ajax/readselectedbooks", methods=['POST'])
+@user_login_required
+@edit_required
+def read_selected_books():
+    vals = request.get_json().get('selections')
+    markAsRead = request.get_json().get('markAsRead')
+    if vals:
+        try:
+            for book_id in vals:
+                ret = helper.edit_book_read_status(book_id, markAsRead)
+
+        except (OperationalError, IntegrityError, StaleDataError) as e:
+            calibre_db.session.rollback()
+            log.error_or_exception("Database error: {}".format(e))
+            ret = Response(json.dumps({'success': False,
+                    'msg': 'Database error: {}'.format(e.orig if hasattr(e, "orig") else e)}),
+                    mimetype='application/json')
+
+        return json.dumps({'success': True})
+    return ""
+
+
 @editbook.route("/ajax/mergebooks", methods=['POST'])
 @user_login_required
 @edit_required

root/app/calibre-web/cps/render_template.py

@@ -147,8 +147,9 @@ def cwa_update_notification() -> None:
 
         update_available, current_version, tag_name = cwa_update_available()
         if update_available:
-            message = f"⚡🚨 CWA UPDATE AVAILABLE! 🚨⚡ Current - {current_version} | Newest - {tag_name} | To update, just re-pull the image! This message will only display once per day"
+            message = f"⚡🚨 CWA UPDATE AVAILABLE! 🚨⚡ Current - {current_version} | Newest - {tag_name} | To update, just re-pull the image! This message will only display once per day |"
             flash(_(message), category="cwa_update")
+            print(f"[cwa-update-notification-service] {message}", flush=True)
 
         with open('/app/cwa_update_notice', 'w') as f:
             f.write(current_date)
@@ -161,7 +162,10 @@ def cwa_update_notification() -> None:
 def render_title_template(*args, **kwargs):
     sidebar, simple = get_sidebar_config(kwargs)
     if current_user.role_admin():
-        cwa_update_notification()
+        try:
+            cwa_update_notification()
+        except Exception as e:
+            print(f"[cwa-update-notification-service] The following error occurred when checking for available updates:\n{e}", flush=True)
     try:
         return render_template(instance=config.config_calibre_web_title, sidebar=sidebar, simple=simple,
                                accept=config.config_upload_formats.split(','),

root/app/calibre-web/cps/services/hardcover.py

@@ -108,10 +108,15 @@ def get_user_book(self, ids):
     def update_reading_progress(self, identifiers, progress_percent):
         ids = self.parse_identifiers(identifiers)
         book = self.get_user_book(ids)
-        if not book: # Book doesn't exist, add it in Reading status
+        # Book doesn't exist, add it in Reading status
+        if not book: 
             book = self.add_book(ids, status=2)
-        if book.get("status_id") != 2: # Book is either WTR or Read
+        # Book is either WTR or Read, and we aren't finished reading
+        if book.get("status_id") != 2 and progress_percent != 100: 
             book = self.change_book_status(book, 2)
+        # Book is already marked as read, and we are also done
+        if book.get("status_id") == 3 and progress_percent == 100: 
+            return
         pages = book.get("edition",{}).get("pages",0)
         if pages:
             pages_read = round(pages * (progress_percent / 100))
@@ -220,16 +225,12 @@ def execute(self, query, variables=None):
             "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()
         if "errors" in result:
             raise Exception(f"GraphQL error: {result['errors']}")
-
         return result.get("data", {})