Added first iteration of split library support for CWA

Author: crocodilestick

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

@@ -57,7 +57,7 @@ jobs:
             BUILD_DATE=${{ github.event.repository.updated_at }}
             VERSION=${{ vars.CURRENT_DEV_VERSION }}-DEV_BUILD-${{ env.IMAGE_TAG }}-${{ vars.CURRENT_DEV_BUILD_NUM }}
           tags: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/calibre-web-automated:dev-${{ env.IMAGE_TAG }}
+            ${{ secrets.DOCKERHUB_USERNAME }}/calibre-web-automated:dev
           
           platforms: linux/amd64,linux/arm64
 

Dockerfile_calibre_not_included

@@ -478,9 +478,8 @@ def convert_library_start(queue):
     queue.put(cl_process)
 
 def get_tmp_conversion_dir() -> str:
-    dirs_json_path = "/app/calibre-web-automated/dirs.json"
     dirs = {}
-    with open(dirs_json_path, 'r') as f:
+    with open(DIRS_JSON, 'r') as f:
         dirs: dict[str, str] = json.load(f)
     tmp_conversion_dir = f"{dirs['tmp_conversion_dir']}/"
 

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

@@ -18,7 +18,7 @@ <h2>{{title}}</h2>
       </div>
       <div class="form-group required">
         <input type="checkbox" id="config_calibre_split" name="config_calibre_split" data-control="split_settings" data-t ="{{ config.config_calibre_split_dir  }}" {% if config.config_calibre_split %}checked{% endif %} >
-        <label for="config_calibre_split">{{_('Separate Book Files from Library - DO NOT USE! COMING IN CWA V3.1.0!')}}</label>
+        <label for="config_calibre_split">{{_('Separate Book Files from Library - metadata.db file should remain in /calibre-library, however your library files can be wherever you desire')}}</label>
       </div>
       <div data-related="split_settings">
        <div class="form-group required input-group">

root/app/calibre-web/cps/templates/config_db.html

@@ -382,11 +382,20 @@ def get_sort_function(sort_param, data):
 
 
 def cwa_get_library_location() -> str:
-    dirs = {}
-    with open('/app/calibre-web-automated/dirs.json', 'r') as f:
-        dirs: dict[str, str] = json.load(f)
-    library_dir = f"{dirs['calibre_library_dir']}/"
-    return library_dir
+    con = sqlite3.connect("/config/app.db")
+    cur = con.cursor()
+    split_library = cur.execute('SELECT config_calibre_split FROM settings;').fetchone()[0]
+
+    if split_library:
+        split_path = cur.execute('SELECT config_calibre_split_dir FROM settings;').fetchone()[0]
+        con.close()
+        return split_path
+    else:
+        dirs = {}
+        with open('/app/calibre-web-automated/dirs.json', 'r') as f:
+            dirs: dict[str, str] = json.load(f)
+        library_dir = f"{dirs['calibre_library_dir']}/"
+        return library_dir
 
 def cwa_get_num_books_in_library() -> int:
     try:

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

@@ -10,6 +10,7 @@
 import tempfile
 import atexit
 from datetime import datetime
+import sqlite3
 
 import pwd
 import grp
@@ -95,6 +96,26 @@ def __init__(self, args) -> None:
         self.ingest_folder, self.library_dir, self.tmp_conversion_dir = self.get_dirs('/app/calibre-web-automated/dirs.json') 
         self.to_convert = self.get_books_to_convert()
 
+        # Gets split library info from app.db and sets library dir to the split dir if split library is enabled
+        self.split_library = self.get_split_library()
+        if self.split_library:
+            self.library_dir = self.split_library
+
+    
+    def get_split_library() -> bool | None:
+        """Checks whether or not the user has split library enabled. Returns None if they don't and the path of the Split Library location if True."""
+        con = sqlite3.connect("/config/app.db")
+        cur = con.cursor()
+        split_library = cur.execute('SELECT config_calibre_split FROM settings;').fetchone()[0]
+
+        if split_library:
+            split_path = cur.execute('SELECT config_calibre_split_dir FROM settings;').fetchone()[0]
+            con.close()
+            return split_path
+        else:
+            con.close()
+            return None
+
 
     def get_dirs(self, dirs_json_path: str) -> tuple[str, str, str]:
         dirs = {}

scripts/convert_library.py

@@ -4,6 +4,7 @@
 import re
 import sys
 import time
+import sqlite3
 from datetime import datetime
 from pathlib import Path
 
@@ -56,9 +57,18 @@ def __init__(self, book_dir: str, file_path: str):
 
     def get_calibre_library(self) -> str:
         """Gets Calibre-Library location from dirs_json path"""
-        with open(dirs_json, 'r') as f:
-            dirs = json.load(f)
-        return dirs['calibre_library_dir'] # Returns without / on the end
+        con = sqlite3.connect("/config/app.db")
+        cur = con.cursor()
+        split_library = cur.execute('SELECT config_calibre_split FROM settings;').fetchone()[0]
+
+        if split_library:
+            split_path = cur.execute('SELECT config_calibre_split_dir FROM settings;').fetchone()[0]
+            con.close()
+            return split_path
+        else:
+            with open(dirs_json, 'r') as f:
+                dirs = json.load(f)
+            return dirs['calibre_library_dir'] # Returns without / on the end
 
 
     def get_time(self) -> str:
@@ -110,9 +120,18 @@ def __init__(self, args):
 
     def get_calibre_library(self) -> str:
         """Gets Calibre-Library location from dirs_json path"""
-        with open(dirs_json, 'r') as f:
-            dirs = json.load(f)
-        return dirs['calibre_library_dir'] # Returns without / on the end
+        con = sqlite3.connect("/config/app.db")
+        cur = con.cursor()
+        split_library = cur.execute('SELECT config_calibre_split FROM settings;').fetchone()[0]
+
+        if split_library:
+            split_path = cur.execute('SELECT config_calibre_split_dir FROM settings;').fetchone()[0]
+            con.close()
+            return split_path
+        else:
+            with open(dirs_json, 'r') as f:
+                dirs = json.load(f)
+            return dirs['calibre_library_dir'] # Returns without / on the end
 
     def read_log(self, auto=True, log_path: str = "None") -> dict:
         """Reads pertinent information from the given log file, adds the book_id from the log name and returns the info as a dict"""

scripts/cover_enforcer.py

@@ -6,6 +6,7 @@
 import tempfile
 import time
 import shutil
+import sqlite3
 from pathlib import Path
 
 from cwa_db import CWA_DB
@@ -69,6 +70,26 @@ def __init__(self, filepath: str):
         self.is_target_format = bool(self.filepath.endswith(self.target_format))
         self.can_convert, self.input_format = self.can_convert_check()
 
+        # Gets split library info from app.db and sets library dir to the split dir if split library is enabled
+        self.split_library = self.get_split_library()
+        if self.split_library:
+            self.library_dir = self.split_library
+
+    
+    def get_split_library() -> bool | None:
+        """Checks whether or not the user has split library enabled. Returns None if they don't and the path of the Split Library location if True."""
+        con = sqlite3.connect("/config/app.db")
+        cur = con.cursor()
+        split_library = cur.execute('SELECT config_calibre_split FROM settings;').fetchone()[0]
+
+        if split_library:
+            split_path = cur.execute('SELECT config_calibre_split_dir FROM settings;').fetchone()[0]
+            con.close()
+            return split_path
+        else:
+            con.close()
+            return None
+
 
     def get_dirs(self, dirs_json_path: str) -> tuple[str, str, str]:
         dirs = {}

scripts/ingest_processor.py

@@ -5,6 +5,7 @@
 import argparse
 from pathlib import Path
 import sys
+import sqlite3
 
 import logging
 import tempfile
@@ -325,10 +326,20 @@ def process(self, input_path, output_path=None, default_language='en'):
 
 
 def get_library_location() -> str:
-    """Gets Calibre-Library location from dirs_json path"""
-    with open(dirs_json, 'r') as f:
-        dirs = json.load(f)
-    return dirs['calibre_library_dir'] # Returns without / on the end
+    con = sqlite3.connect("/config/app.db")
+    cur = con.cursor()
+    split_library = cur.execute('SELECT config_calibre_split FROM settings;').fetchone()[0]
+
+    if split_library:
+        split_path = cur.execute('SELECT config_calibre_split_dir FROM settings;').fetchone()[0]
+        con.close()
+        return split_path
+    else:
+        dirs = {}
+        with open('/app/calibre-web-automated/dirs.json', 'r') as f:
+            dirs: dict[str, str] = json.load(f)
+        library_dir = f"{dirs['calibre_library_dir']}/"
+        return library_dir
 
 def get_all_epubs_in_library() -> list[str]:
     """ Returns a list if the book dir given contains files of one or more of the supported formats"""