MAJOR REFACTOR

- The CWA repo now contains all of the core required files it needs & no longer directly uses the latest Calibre-Web releases & linuxserver/docker-calibre-web repo to build it's images
- This change should hopefully make contributing to the project much more intuitive for those interested as well making CWA easier to develop for in general

Bugfixes:

- Fixed typo in amazonjp.py preventing it from working

Author: crocodilestick

.dockerignore

@@ -4,11 +4,15 @@ docker-compose.yml
 .github
 .gitignore
 .github/workflows
+.gitattributes
 build.sh
 README.md
 LICENSE
 Dockerfile
 .dockerignore
-build
+build.sh
 .history
-Dockerfile_calibre_not_included
+docker-compose.yml.dev
+changelogs
+cwa-wiki
+wiki_images

Dockerfile

@@ -26,20 +26,18 @@ SHELL ["/bin/bash", "-c"]
 ARG BUILD_DATE
 ARG VERSION
 ARG CALIBREWEB_RELEASE=0.6.24
-ARG LSCW_RELEASE=0.6.24-ls304
 ARG CALIBRE_RELEASE=8.4.0
 ARG KEPUBIFY_RELEASE=v4.0.4
 LABEL build_version="Version:- ${VERSION}"
 LABEL build_date="${BUILD_DATE}"
-LABEL CW-Stock-version="${CALIBREWEB_RELEASE}"
-LABEL LSCW_Image_Release="${LSCW_RELEASE}"
+LABEL CW-base-version="${CALIBREWEB_RELEASE}"
 LABEL maintainer="CrocodileStick"
 
 # Copy local files into the container
 COPY --chown=abc:abc . /app/calibre-web-automated/
-# STEP 1 - Install stock Calibre-Web
+# STEP 1 - Install Required Packages
 RUN \
-  # STEP 1.1 - Installs required build & runtime packages
+  # STEP 1.1 - Install required apt packages
   echo "**** install build packages ****" && \
   apt-get update && \
   apt-get install -y --no-install-recommends \
@@ -56,68 +54,34 @@ RUN \
     libsasl2-2 \
     libxi6 \
     libxslt1.1 \
+    xdg-utils \
+    inotify-tools \
+    python3 \
+    python3-pip \
+    nano \
+    sqlite3 \
+    zip \
     python3-venv && \
-  echo "**** install calibre-web ****" && \
-  # STEP 1.2 - Check that $CALIBREWEB_RELEASE ARG is not none and if it is, sets the variables value to the most recent tag name
-  if [ -z ${CALIBREWEB_RELEASE+x} ]; then \
-    CALIBREWEB_RELEASE=$(curl -sX GET "https://api.github.com/repos/janeczku/calibre-web/releases/latest" \
-    | awk '/tag_name/{print $4;exit}' FS='[""]'); \
-  fi && \
-  # STEP 1.3 - Downloads the tarball of the release stored in $CALIBREWEB_RELEASE from CW's GitHub Repo, saving it into /tmp
-  curl -o \
-    /tmp/calibre-web.tar.gz -L \
-    https://github.com/janeczku/calibre-web/archive/${CALIBREWEB_RELEASE}.tar.gz && \
-  # STEP 1.4 - Makes /app/calibre-web to extract the downloaded files from the repo to, -p to ignore potential errors that could arise if the folder already existed
-  mkdir -p \
-    /app/calibre-web && \
-  # STEP 1.5 - Extracts the contents of the tar.gz file downloaded from the repo to the /app/calibre-web dir previously created
-  tar xf \
-    /tmp/calibre-web.tar.gz -C \
-    /app/calibre-web --strip-components=1 && \
-  # STEP 1.6 - Sets up a python virtual environment and installs pip and wheel packages
-  cd /app/calibre-web && \
+  # STEP 1.2 - Set up a python virtual environment and install pip and wheel packages
+  cd /app/calibre-web-automated && \
   python3 -m venv /lsiopy && \
   pip install -U --no-cache-dir \
     pip \
     wheel && \
-  # STEP 1.7 - Installing the required python packages listed in 'requirements.txt' and 'optional-requirements.txt'
+  # STEP 1.3 - Installing the required python packages listed in 'requirements.txt' and 'optional-requirements.txt'
     # HOWEVER, they are not pulled from PyPi directly, they are pulled from linuxserver's Ubuntu Wheel Index
     # This is essentially a repository of precompiled some of the most popular packages with C/C++ source code
     # This provides the install maximum compatibility with multiple different architectures including: x86_64, armv71 and aarch64
     # You can read more about python wheels here: https://realpython.com/python-wheels/
   pip install -U --no-cache-dir --find-links https://wheel-index.linuxserver.io/ubuntu/ -r \
-    requirements.txt -r \
-    optional-requirements.txt && \
-  # STEP 1.8 - Installs kepubify
-  echo "**** install kepubify ****" && \
-  if [[ $KEPUBIFY_RELEASE == 'newest' ]]; then \
-    KEPUBIFY_RELEASE=$(curl -sX GET "https://api.github.com/repos/pgaskin/kepubify/releases/latest" \
-    | awk '/tag_name/{print $4;exit}' FS='[""]'); \
-  fi && \
-  if [ "$(uname -m)" == "x86_64" ]; then \
-    curl -o \
-      /usr/bin/kepubify -L \
-      https://github.com/pgaskin/kepubify/releases/download/${KEPUBIFY_RELEASE}/kepubify-linux-64bit; \
-  elif [ "$(uname -m)" == "aarch64" ]; then \
-    curl -o \
-      /usr/bin/kepubify -L \
-      https://github.com/pgaskin/kepubify/releases/download/${KEPUBIFY_RELEASE}/kepubify-linux-arm64; \
-  fi && \
-# STEP 2 - Install Calibre-Web Automated
-  echo "~~~~ CWA Install - installing additional required packages ~~~~" && \
-  # STEP 2.1 - Install additional required packages
-  apt-get update && \
-  apt-get install -y --no-install-recommends \
-    xdg-utils \
-    inotify-tools \
-    python3 \
-    python3-pip \
-    nano \
-    sqlite3 \
-    zip && \
-  # STEP 2.2 - Install additional required python packages
-  pip install -r /app/calibre-web-automated/requirements.txt && \
-  # STEP 2.2.1 - Create koplugin.zip from KOReader plugin folder
+    requirements.txt -r && \
+# STEP 2 - Move contents of /app/calibre-web-automated/root to / and delete the /app/calibre-web-automated/root directory
+  cp -R /app/calibre-web-automated/root/* / && \
+  rm -R /app/calibre-web-automated/root/ && \
+# STEP 3 - Run CWA install script to make required dirs, set script permissions and add aliases for CLI commands  ect.
+  chmod +x /app/calibre-web-automated/scripts/setup-cwa.sh && \
+  /app/calibre-web-automated/scripts/setup-cwa.sh && \
+# STEP 4 - Create koplugin.zip from KOReader plugin folder
   echo "~~~~ Creating koplugin.zip from KOReader plugin folder... ~~~~" && \
   if [ -d "/app/calibre-web-automated/koreader/plugins/cwasync.koplugin" ]; then \
     cd /app/calibre-web-automated/koreader/plugins && \
@@ -135,48 +99,31 @@ RUN \
   else \
     echo "Warning: cwasync.koplugin folder not found, skipping zip creation"; \
   fi && \
-  # STEP 2.3 - Get required 'root' dir from the linuxserver/docker-calibre-web repo
-  echo "~~~~ Getting required files from linuxserver/docker-calibre-web... ~~~~" && \
-    # STEP 2.4.1 - Check the most recent release of linuxserver/docker-calibre-web and store it's tag in LSCW_RELEASE if one was not specified as an ARG
-  if [[ $LSCW_RELEASE == 'newest' ]]; then \
-      LSCW_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/docker-calibre-web/releases/latest" \
-      | awk '/tag_name/{print $4;exit}' FS='[""]'); \
-  fi && \
-    # STEP 2.4.2 - Download the most recent LSCW release to /tmp
-  curl -o \
-      /tmp/lscw.tar.gz -L \
-      https://github.com/linuxserver/docker-calibre-web/archive/refs/tags/${LSCW_RELEASE}.tar.gz && \
-    # STEP 2.4.3 - Makes /app/calibre-web to extract the downloaded files from the repo to, -p to ignore potential errors that could arise if the folder already existed
-  mkdir -p \
-    /tmp/lscw && \
-    # STEP 2.4.4 - Extract contents of lscw.tat.gz to /tmp/lscw
-  tar xf \
-      /tmp/lscw.tar.gz -C \
-      /tmp/lscw --strip-components=1 && \
-    # STEP 2.4.5 - Move contents of 'root' dirs to root dir
-  cp -R /tmp/lscw/root/* / && \
-  cp -R /app/calibre-web-automated/root/* / && \
-    # STEP 2.4.6 - Move koplugin.zip to static directory
+  # STEP 4.1 - Move koplugin.zip to static directory
   if [ -f "/app/calibre-web-automated/koreader/plugins/koplugin.zip" ]; then \
-    mkdir -p /app/calibre-web/cps/static && \
+    mkdir -p /app/calibre-web-automated/cps/static && \
     cp /app/calibre-web-automated/koreader/plugins/koplugin.zip /app/calibre-web/cps/static/ && \
     echo "Moved koplugin.zip to static directory"; \
   else \
     echo "Warning: koplugin.zip not found, skipping move to static directory"; \
   fi && \
-    # STEP 2.4.7 - Remove the temp files
-  rm -R /app/calibre-web-automated/root/ && \
-  rm -R /tmp/lscw/root/ && \
-  # STEP 2.5 - ADD files referencing the versions of the installed main packages
-    # CALIBRE_RELEASE is placed in root by universal calibre below and containers the calibre version being used
-  echo "$VERSION" >| /app/CWA_RELEASE && \
-  echo "$LSCW_RELEASE" >| /app/LSCW_RELEASE && \
-  echo "$KEPUBIFY_RELEASE" >| /app/KEPUBIFY_RELEASE && \
-  # STEP 2.6 - Run CWA install script to make required dirs, set script permissions and add aliases for CLI commands  ect.
-  chmod +x /app/calibre-web-automated/scripts/setup-cwa.sh && \
-  /app/calibre-web-automated/scripts/setup-cwa.sh && \
-# STEP 3 - Install Universal Calibre
-  # STEP 3.1 - Install additional required packages
+# STEP 5 - Installs kepubify
+  echo "**** install kepubify ****" && \
+  if [[ $KEPUBIFY_RELEASE == 'newest' ]]; then \
+    KEPUBIFY_RELEASE=$(curl -sX GET "https://api.github.com/repos/pgaskin/kepubify/releases/latest" \
+    | awk '/tag_name/{print $4;exit}' FS='[""]'); \
+  fi && \
+  if [ "$(uname -m)" == "x86_64" ]; then \
+    curl -o \
+      /usr/bin/kepubify -L \
+      https://github.com/pgaskin/kepubify/releases/download/${KEPUBIFY_RELEASE}/kepubify-linux-64bit; \
+  elif [ "$(uname -m)" == "aarch64" ]; then \
+    curl -o \
+      /usr/bin/kepubify -L \
+      https://github.com/pgaskin/kepubify/releases/download/${KEPUBIFY_RELEASE}/kepubify-linux-arm64; \
+  fi && \
+# STEP 6 - Install Calibre
+  # STEP 6.1 - Install additional required packages
   apt-get update && \
   apt-get install -y --no-install-recommends \
     libxtst6 \
@@ -192,10 +139,10 @@ RUN \
     libglx-mesa0 \
     xz-utils \
     binutils && \
-  # STEP 3.2 - Make the /app/calibre directory for the installed files
+  # STEP 6.2 - Make the /app/calibre directory for the installed files
   mkdir -p \
   /app/calibre && \
-  # STEP 3.3 - Download the desired version of Calibre, determined by the CALIBRE_RELEASE variable and the architecture of the build environment
+  # STEP 6.3 - Download the desired version of Calibre, determined by the CALIBRE_RELEASE variable and the architecture of the build environment
   if [ "$(uname -m)" == "x86_64" ]; then \
     curl -o \
       /calibre.txz -L \
@@ -205,16 +152,18 @@ RUN \
       /calibre.txz -L \
       "https://download.calibre-ebook.com/${CALIBRE_RELEASE}/calibre-${CALIBRE_RELEASE}-arm64.txz"; \
   fi && \
-  # STEP 3.4 - Extract the downloaded file to /app/calibre
+  # STEP 6.4 - Extract the downloaded file to /app/calibre
   tar xf \
       /calibre.txz -C \
       /app/calibre && \
-  # STEP 3.4.1 - Remove the ABI tag from the extracted libQt6* files to allow them to be used on older kernels
+  # STEP 6.4.1 - Remove the ABI tag from the extracted libQt6* files to allow them to be used on older kernels
   strip --remove-section=.note.ABI-tag /app/calibre/lib/libQt6* && \
-  # STEP 3.5 - Delete the extracted calibre.txz to save space in final image
+  # STEP 6.5 - Delete the extracted calibre.txz to save space in final image
   rm /calibre.txz && \
-  # STEP 3.6 - Store the CALIBRE_RELEASE in the root of the image in CALIBRE_RELEASE
-  echo $CALIBRE_RELEASE > /CALIBRE_RELEASE
+# STEP 7 - ADD files referencing the versions of the installed main packages
+  echo "$VERSION" >| /app/CWA_RELEASE && \
+  echo "$KEPUBIFY_RELEASE" >| /app/KEPUBIFY_RELEASE && \
+  echo "$CALIBRE_RELEASE" > /CALIBRE_RELEASE
 
 # Removes packages that are no longer required, also emptying dirs used to build the image that are no longer needed
 RUN \

README.md

@@ -280,7 +280,7 @@ And that's you off to the races! 🥳 HOWEVER to avoid potential problems and en
     - **New Users** - Use any empty folder (if you run into any issues, make sure the ownership of said folder isn't `root:root` in your main os)
     - **Existing/ CW Users** - If there are multiple libraries in the mounted directory, CWA will automatically find and mount the largest one - check the logs for more details on which `metadata.db` was utilised
   <!-- - `/books` _(Optional)_ Utilise if you have a separate collection of book files somewhere and want to be able to access within the container. For the majority of users, this is not required and mounting`/calibre-library' is sufficient -->
-  - `/app/calibre-web/gmail.json` _(Optional)_ - This is used to setup Calibre-Web and/or CWA with your gmail account for sending books via email. Follow the guide [here](https://github.com/janeczku/calibre-web/wiki/Setup-Mailserver#gmail) if this is something you're interested in but be warned it can be a very fiddly process, I would personally recommend a simple SMTP Server
+  - `/app/calibre-web-automated/gmail.json` _(Optional)_ - This is used to setup Calibre-Web and/or CWA with your gmail account for sending books via email. Follow the guide [here](https://github.com/janeczku/calibre-web/wiki/Setup-Mailserver#gmail) if this is something you're interested in but be warned it can be a very fiddly process, I would personally recommend a simple SMTP Server
 
 And just like that, Calibre-Web Automated should be up and running! **HOWEVER** to avoid potential problems and ensure maximum functionality,we recommend carrying out these [Post-Install Tasks Here](#post-install-tasks).
 

changelogs/V3.1.0_changelog.md

@@ -134,7 +134,7 @@ Contributed by [netvyper](https://github.com/netvyper), you can now select multi
  - Auto-Send-to-Kindle 🛫⚙️
  - User setting to pick preferred accent colour of the Web UI 🎨
 
- # Affliated Projects 👬
+ # Affiliateddd Projects 
 
  - In the spirit of community, I also wanted to give a shout out to some really great affiliate projects made by members of our community!
  - As well as being featured here in the release, affiliated projects will now also be prominently feature on the CWA GitHub page to drive as much traffic & enthusiasm to them as possible

cps/MyLoginManager.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+#  This file is part of the Calibre-Web (https://github.com/janeczku/calibre-web)
+#    Copyright (C) 2018-2019 OzzieIsaacs, cervinko, jkrehm, bodybybuddha, ok11,
+#                            andy29485, idalin, Kyosfonica, wuqi, Kennyl, lemmsh,
+#                            falgh1, grunjol, csitko, ytils, xybydy, trasba, vrabe,
+#                            ruben-herold, marblepebble, JackED42, SiphonSquirrel,
+#                            apetresc, nanu-c, mutschler, GammaC0de, vuolter
+#
+#  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 <http://www.gnu.org/licenses/>.
+
+from .cw_login import LoginManager
+from flask import session
+
+
+class MyLoginManager(LoginManager):
+    def _session_protection_failed(self):
+        sess = session._get_current_object()
+        ident = self._session_identifier_generator()
+        if(sess and not (len(sess) == 1
+                         and sess.get('csrf_token', None))) and ident != sess.get('_id', None):
+            return super(). _session_protection_failed()
+        return False
+
+
+