Merge pull request #682 from Stirling-Tools/ebook

Ebook

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Formatting
+5f771b785130154ed47952635b7acef371ffe0ec

.gitattributes

@@ -1,3 +1,5 @@
+* text=auto eol=lf
+
 # Ignore all JavaScript files in a directory
 src/main/resources/static/pdfjs/* linguist-vendored
 src/main/resources/static/pdfjs/** linguist-vendored

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# All PRs to V1 must be approved by Frooodle
+* @Frooodle

.github/dependabot.yml

@@ -9,3 +9,7 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+  - package-ecosystem: "docker"
+    directory: "/" # Location of Dockerfile
+    schedule:
+      interval: "weekly"

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: "Build repo"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    - uses: gradle/gradle-build-action@v2.4.2
+      with:
+        gradle-version: 7.6
+        arguments: build --no-build-cache

.github/workflows/codeql.yml

@@ -1,55 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-
-name: "Build repo"
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '15 12 * * 1'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-      
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        java-version: '17'
-        distribution: 'temurin'
-
-   # - name: Initialize CodeQL
-   #   uses: github/codeql-action/init@v2
-   #   with:
-   #     languages: java
-
-    - uses: gradle/gradle-build-action@v2.4.2
-      with:
-        gradle-version: 7.6
-        arguments: assemble --no-build-cache
-
-    #- name: Perform CodeQL analysis
-    #  uses: github/codeql-action/analyze@v2

.github/workflows/licenses-update.yml

@@ -0,0 +1,48 @@
+name: License Report Workflow
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'build.gradle'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  generate-license-report:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Run Gradle Command
+        run: ./gradlew clean generateLicenseReport
+
+      - name: Move and Rename License File
+        run: |
+          mv build/reports/dependency-license/index.json src/main/resources/static/3rdPartyLicenses.json
+
+      - name: Check for Changes
+        id: git-check
+        run: |
+          git add src/main/resources/static/3rdPartyLicenses.json
+          git diff --staged --exit-code || echo "changes=true" >> $GITHUB_ENV
+
+      - name: Commit and Push Changes
+        if: env.changes == 'true'
+        run: |
+          git config --global user.name 'Stirling-PDF-Bot'
+          git config --global user.email 'Stirling-PDF-Bot@stirlingtools.com'
+          git commit -m "Update 3rd Party Licenses"
+          git push
+

.github/workflows/push-docker.yml

@@ -6,6 +6,9 @@ on:
     branches: 
       - master
       - main
+permissions:
+  contents: read
+  packages: write
 jobs:
   push:
     runs-on: ubuntu-latest
@@ -139,4 +142,10 @@ jobs:
         cache-to: type=gha,mode=max
         tags: ${{ steps.meta3.outputs.tags }}
         labels: ${{ steps.meta3.outputs.labels }}
+        build-args: 
+          VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
         platforms: linux/amd64,linux/arm64/v8
+    - name: Build and Push Helm Chart
+      run: |
+        helm package chart/stirling-pdf
+        helm push stirling-pdf-chart-1.0.0.tgz oci://registry-1.docker.io/frooodle

.github/workflows/releaseArtifacts.yml

@@ -3,7 +3,9 @@ name: Release Artifacts
 on: 
   release: 
     types: [created]
-
+permissions:
+  contents: write
+  packages: write
 jobs:
   push:
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -0,0 +1,56 @@
+name: Docker Compose Tests
+
+on:
+  pull_request:
+    paths:
+      - 'src/**'
+      - '**.gradle'
+      - '!src/main/java/resources/messages*'
+      - 'exampleYmlFiles/**'
+      - 'Dockerfile'
+      - 'Dockerfile**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Java 17
+      uses: actions/setup-java@v2
+      with:
+        java-version: '17'
+        distribution: 'adopt'
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Run Docker Compose Tests
+      run: |
+        chmod +x ./gradlew
+        
+    - name: Get version number
+      id: versionNumber
+      run: echo "::set-output name=versionNumber::$(./gradlew printVersion --quiet | tail -1)"
+
+
+    - name: Cache Docker layers
+      uses: actions/cache@v2
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ steps.versionNumber.outputs.versionNumber }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-
+
+    - name: Install Docker Compose
+      run: |
+        sudo curl -L "https://github.com/docker/compose/releases/download/v2.6.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+        sudo chmod +x /usr/local/bin/docker-compose
+
+
+    - name: Run Docker Compose Tests
+      run: |
+        chmod +x ./test.sh
+        ./test.sh

.gitignore

@@ -15,8 +15,8 @@ local.properties
 .classpath
 .project
 version.properties
-pipeline/
+pipeline/watchedFolders/
-
+pipeline/finishedFolders/
 #### Stirling-PDF Files ###
 customFiles/
 configs/
@@ -120,4 +120,8 @@ watchedFolders/
 /build
 
 /.vscode
-/.idea
+/.idea
+
+# Ignore Mac DS_Store files
+.DS_Store
+**/.DS_Store

CNAME

@@ -1 +0,0 @@
-stirlingtools.com

Dockerfile

@@ -1,12 +1,13 @@
 # Use the base image
-FROM frooodle/stirling-pdf-base:beta4
+FROM frooodle/stirling-pdf-base:version8
 
 ARG VERSION_TAG
 
 # Set Environment Variables
 ENV DOCKER_ENABLE_SECURITY=false \
     HOME=/home/stirlingpdfuser \
-    VERSION_TAG=$VERSION_TAG
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75"
 #    PUID=1000 \
 #    PGID=1000 \
 #    UMASK=022 \
@@ -18,19 +19,20 @@ ENV DOCKER_ENABLE_SECURITY=false \
 ##    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
 
 # Set up necessary directories and permissions
-RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /usr/share/tesseract-ocr /configs /customFiles 
+RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /usr/share/tesseract-ocr /configs /logs /customFiles /pipeline /pipeline/defaultWebUIConfigs  /pipeline/watchedFolders /pipeline/finishedFolders
 ##&& \
 ##    chown -R stirlingpdfuser:stirlingpdfgroup /scripts /usr/share/fonts/opentype/noto /usr/share/tesseract-ocr /configs /customFiles && \
 ##    chown -R stirlingpdfuser:stirlingpdfgroup /usr/share/tesseract-ocr-original
 
 # Copy necessary files
 COPY ./scripts/* /scripts/
+COPY ./pipeline/ /pipeline/
 COPY src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/
 COPY src/main/resources/static/fonts/*.otf /usr/share/fonts/opentype/noto/
 COPY build/libs/*.jar app.jar
 
 # Set font cache and permissions
-RUN fc-cache -f -v && chmod +x /scripts/init.sh
+RUN fc-cache -f -v && chmod +x /scripts/*
 
 ##&& \
 ##    chown stirlingpdfuser:stirlingpdfgroup /app.jar && \
@@ -42,4 +44,4 @@ EXPOSE 8080
 # Set user and run command
 ##USER stirlingpdfuser
 ENTRYPOINT ["/scripts/init.sh"]
-CMD ["java", "-jar", "/app.jar"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-lite

@@ -1,12 +1,15 @@
 # Build jbig2enc in a separate stage
 FROM bellsoft/liberica-openjdk-debian:17
+
+ARG VERSION_TAG
+
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
-        libreoffice-core-nogui \
+        libreoffice-core \
         libreoffice-common \
-        libreoffice-writer-nogui \
+        libreoffice-writer \
-        libreoffice-calc-nogui \
+        libreoffice-calc \
-        libreoffice-impress-nogui \
+        libreoffice-impress \
         unoconv && \
     rm -rf /var/lib/apt/lists/*
 
@@ -14,7 +17,8 @@ RUN apt-get update && \
 # Set Environment Variables
 ENV DOCKER_ENABLE_SECURITY=false \
     HOME=/home/stirlingpdfuser \
-    VERSION_TAG=$VERSION_TAG 
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75"
 #	PUID=1000 \
 #   PGID=1000 \
 #   UMASK=022 \
@@ -25,17 +29,24 @@ ENV DOCKER_ENABLE_SECURITY=false \
 #    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
 
 # Set up necessary directories and permissions
-RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /configs /customFiles
+RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /configs /customFiles /logs /pipeline /pipeline/defaultWebUIConfigs  /pipeline/watchedFolders /pipeline/finishedFolders
 
 #    chown -R stirlingpdfuser:stirlingpdfgroup /usr/share/fonts/opentype/noto /configs /customFiles
 
 # Copy necessary files
+COPY ./scripts/download-security-jar.sh /scripts/download-security-jar.sh
+COPY ./scripts/init-without-ocr.sh /scripts/init-without-ocr.sh
+COPY ./pipeline/ /pipeline/
 COPY src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/
 COPY src/main/resources/static/fonts/*.otf /usr/share/fonts/opentype/noto/
 COPY build/libs/*.jar app.jar
 
 # Set font cache and permissions
-RUN fc-cache -f -v 
+RUN fc-cache -f -v && \
+chmod +x /scripts/init-without-ocr.sh && \
+chmod +x /scripts/download-security-jar.sh
+
+
 #    chown stirlingpdfuser:stirlingpdfgroup /app.jar
 
 
@@ -50,5 +61,5 @@ ENV DOCKER_ENABLE_SECURITY=false
 
 # Run the application
 #USER stirlingpdfuser
-
+ENTRYPOINT ["/scripts/init-without-ocr.sh"]
-CMD ["java", "-jar", "/app.jar"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-ultra-lite

@@ -1,34 +1,46 @@
 # Build jbig2enc in a separate stage
 FROM bellsoft/liberica-openjdk-alpine:17
 
+ARG VERSION_TAG
+
 # Set Environment Variables
-ENV PUID=1000 \
+ENV DOCKER_ENABLE_SECURITY=false \
-    PGID=1000 \
-    UMASK=022 \
-    DOCKER_ENABLE_SECURITY=false \
     HOME=/home/stirlingpdfuser \
-    VERSION_TAG=$VERSION_TAG
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75"
+#	PUID=1000 \
+#   PGID=1000 \
+#   UMASK=022 \
 
 # Create user and group using Alpine's addgroup and adduser
-RUN addgroup -g $PGID stirlingpdfgroup && \
+#RUN addgroup -g $PGID stirlingpdfgroup && \
-    adduser -u $PUID -G stirlingpdfgroup -s /bin/sh -D stirlingpdfuser && \
+#    adduser -u $PUID -G stirlingpdfgroup -s /bin/sh -D stirlingpdfuser && \
-    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
+#    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
 
 # Set up necessary directories and permissions
-RUN mkdir -p /scripts /configs /customFiles && \
+#RUN mkdir -p /scripts /configs /customFiles && \
-    chown -R stirlingpdfuser:stirlingpdfgroup /scripts /configs /customFiles
+#    chown -R stirlingpdfuser:stirlingpdfgroup /scripts /configs /customFiles /logs /pipeline /pipeline/defaultWebUIConfigs  /pipeline/watchedFolders /pipeline/finishedFolders
-
+ 
+RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /configs /customFiles
+COPY ./scripts/download-security-jar.sh /scripts/download-security-jar.sh
+COPY ./scripts/init-without-ocr.sh /scripts/init-without-ocr.sh
+COPY ./pipeline/ /pipeline/
 COPY build/libs/*.jar app.jar
 
 # Set font cache and permissions
-RUN chown stirlingpdfuser:stirlingpdfgroup /app.jar
+#RUN chown stirlingpdfuser:stirlingpdfgroup /app.jar
+
+RUN chmod +x /scripts/init-without-ocr.sh && \
+chmod +x /scripts/download-security-jar.sh && \
+apk add --no-cache curl
 
 # Expose the application port
 EXPOSE 8080
 
 # Set environment variables
 ENV ENDPOINTS_GROUPS_TO_REMOVE=CLI
-ENV DOCKER_ENABLE_SECURITY=false
+
+ENTRYPOINT ["/scripts/init-without-ocr.sh"]
 
 # Run the application
-CMD ["java", "-jar", "/app.jar"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

DockerfileBase

@@ -1,37 +1,43 @@
 # Main stage
-FROM bellsoft/liberica-openjdk-debian:17 AS base
+FROM ubuntu:latest AS base
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-        libreoffice-core-nogui \
-        libreoffice-common \
-        libreoffice-writer-nogui \
-        libreoffice-calc-nogui \
-        libreoffice-impress-nogui \
-        python3-uno \
-        python3-pip \
-        unoconv \
-        pngquant \
-        unpaper \
-        ocrmypdf && \
-    rm -rf /var/lib/apt/lists/* && \
-    mkdir /usr/share/tesseract-ocr-original && \
-    cp -r /usr/share/tesseract-ocr/* /usr/share/tesseract-ocr-original && \
-    rm -rf /usr/share/tesseract-ocr
 
-# Python packages stage
+
-FROM base AS python-packages
+
+# JDK for app
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
-        build-essential \
+    	openjdk-17-jre && \
-        libffi-dev \
-        libssl-dev \
-        zlib1g-dev \
-        libjpeg-dev && \
-    pip install --upgrade pip && \
-    pip install --no-cache-dir \
-        opencv-python-headless WeasyPrint && \
     rm -rf /var/lib/apt/lists/*
-
+    	
-# Final stage: Copy necessary files from the previous stage
+# Doc conversion
-FROM base
+RUN apt-get update && \
-COPY --from=python-packages /usr/local /usr/local
+    apt-get install -y --no-install-recommends \
+    	libreoffice-core \
+        libreoffice-common \
+        libreoffice-writer \
+        libreoffice-calc \
+        libreoffice-impress \
+		python3-uno \
+		curl \
+		unoconv && \
+    rm -rf /var/lib/apt/lists/*
+		
+		
+# OCR MY PDF (unpaper for descew and other advanced featues)
+RUN apt-get update && apt-get install -y --no-install-recommends software-properties-common gnupg2 && \
+add-apt-repository ppa:alex-p/tesseract-ocr5 && apt install -y --no-install-recommends tesseract-ocr && \
+apt-get update && \
+    apt-get install -y --no-install-recommends \
+        ghostscript \
+        python3-pip \
+        ocrmypdf \
+        unpaper && \
+    rm -rf /var/lib/apt/lists/* && \
+    mv /usr/share/tesseract-ocr /usr/share/tesseract-ocr-original && \
+    pip install --no-cache-dir --upgrade pip && \
+    pip install --no-cache-dir --upgrade ocrmypdf && \
+    pip install --no-cache-dir --upgrade pillow==10.0.1 reportlab==3.6.13 wheel==0.38.1 setuptools==65.5.1 pyjwt==2.4.0 cryptography==39.0.1
+    
+    
+#CV and HTML   
+RUN pip install --no-cache-dir opencv-python-headless WeasyPrint 

FolderScanning.md

@@ -0,0 +1,41 @@
+## User Guide for Local Directory Scanning and File Processing
+
+### Whilst Pipelines are in alpha...
+You must enable this alpha functionality by setting
+```
+system:
+  enableAlphaFunctionality: true
+```
+To true like in the above for your `/config/settings.yml` file, after restarting Stirling-PDF you should see both UI and folder scanning enabled.
+
+### Setting Up Watched Folders:
+- Create a folder where you want your files to be monitored. This is your 'watched folder'.
+- The default directory for this is `./pipeline/watchedFolders/`
+- Place any directories you want to be scanned into this folder, this folder should contain multiple folders each for their own tasks and pipelines.
+
+### Configuring Processing with JSON Files:
+- In each directory you want processed (e.g `./pipeline/watchedFolders/officePrinter`), include a JSON configuration file.
+- This JSON file should specify how you want the files in the directory to be handled (e.g., what operations to perform on them) which can be made, configured and downloaded from Stirling-PDF Pipeline interface.r
+
+### Automatic Scanning and Processing:
+- The system automatically checks the watched folder every minute for new directories and files to process.
+- When a directory with a valid JSON configuration file is found, it begins processing the files inside as per the configuration.
+
+### Processing Steps:
+- Files in each directory are processed according to the instructions in the JSON file.
+- This might involve file conversions, data filtering, renaming files, etc. If the output of a step is a zip, this zip will be automatically unzipped as it passes to next process.
+
+### Results and Output:
+- After processing, the results are saved in a specified output location. This could be a different folder or location as defined in the JSON file or the default location `./pipeline/finishedFolders/`.
+- Each processed file is named and organized according to the rules set in the JSON configuration.
+
+### Completion and Cleanup:
+- Once processing is complete, the original files in the watched folder's directory are removed.
+- You can find the processed files in the designated output location.
+
+### Error Handling:
+- If there's an error during processing, the system will not delete the original files, allowing you to check and retry if necessary.
+
+### User Interaction:
+- As a user, your main tasks are to set up the watched folders, place directories with files for processing, and create the corresponding JSON configuration files.
+- The system handles the rest, including scanning, processing, and outputting results.

HowToAddNewLanguage.md

@@ -1,4 +1,4 @@
-<p align="center"><img src="https://raw.githubusercontent.com/Frooodle/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
+<p align="center"><img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
 </p>
 
 
@@ -8,9 +8,9 @@ Fork Stirling-PDF and make a new branch out of Main
 
 Then add reference to the language in the navbar by adding a new language entry to the dropdown
 
-https://github.com/Frooodle/Stirling-PDF/blob/main/src/main/resources/templates/fragments/languages.html
+https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/templates/fragments/languages.html
 and add a flag svg file to 
-https://github.com/Frooodle/Stirling-PDF/tree/main/src/main/resources/static/images/flags
+https://github.com/Stirling-Tools/Stirling-PDF/tree/main/src/main/resources/static/images/flags
 Any SVG flags are fine, i got most of mine from [here](https://flagicons.lipis.dev/)
 If your language isnt represented by a flag just find whichever closely matches it, such as for Arabic i chose Saudi Arabia
 
@@ -25,7 +25,7 @@ The data-language-code is the code used to reference the file in the next step.
 
 Start by copying the existing english property file 
 
-[https://github.com/Frooodle/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties](https://github.com/Frooodle/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties)
+[https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties)
 
 Copy and rename it to messages_{your data-language-code here}.properties, in the polish example you would set the name to messages_pl_PL.properties
 

HowToUseOCR.md

@@ -2,6 +2,9 @@
 
 This document provides instructions on how to add additional language packs for the OCR tab in Stirling-PDF, both inside and outside of Docker.
 
+## My OCR used to work and now doesnt!
+Please update your tesseract docker volume path version from 4.00 to 5
+
 ## How does the OCR Work
 Stirling-PDF uses [OCRmyPDF](https://github.com/ocrmypdf/OCRmyPDF) which in turn uses tesseract for its text recognition.
 All credit goes to them for this awesome work! 
@@ -18,9 +21,9 @@ Depending on your requirements, you can choose the appropriate language pack for
 ### Installing Language Packs
 
 1. Download the desired language pack(s) by selecting the `.traineddata` file(s) for the language(s) you need.
-2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/4.00/tessdata` (Debian) or `/usr/share/tesseract/tessdata` (Fedora)
+2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/5/tessdata` (Debian) or `/usr/share/tesseract/tessdata` (Fedora)
 
-# DO NOT REMOVE EXISTING ENG.TRAINEDDATA, ITS REQUIRED.
+# DO NOT REMOVE EXISTING ENG.TRAINEDDATA, IT'S REQUIRED.
 
 #### Docker
 
@@ -34,14 +37,14 @@ services:
   your_service_name:
     image: your_docker_image_name
     volumes:
-      - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata
+      - /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata
 ```
 
 
 #### Docker run
 Add the following to your existing docker run command
 ```bash
--v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata
+-v /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata
 ```
 
 #### Non-Docker

Jenkinsfile

@@ -22,12 +22,24 @@ pipeline {
                     def appVersion = sh(returnStdout: true, script: './gradlew printVersion -q').trim()
                     def image = "frooodle/s-pdf:$appVersion"
                     withCredentials([string(credentialsId: 'docker_hub_access_token', variable: 'DOCKER_HUB_ACCESS_TOKEN')]) {
-				sh "docker login --username frooodle --password $DOCKER_HUB_ACCESS_TOKEN"
+				        sh "docker login --username frooodle --password $DOCKER_HUB_ACCESS_TOKEN"
                         sh "docker push $image"
                     }
                 }
             }
-    	
+        }
-	}
+        stage('Helm Push') {
-   }
+            steps {
+                script {
+                    //TODO: Read chartVersion from Chart.yaml
+                    def chartVersion = '1.0.0'
+                    withCredentials([string(credentialsId: 'docker_hub_access_token', variable: 'DOCKER_HUB_ACCESS_TOKEN')]) {
+				        sh "docker login --username frooodle --password $DOCKER_HUB_ACCESS_TOKEN"
+				        sh "helm package chart/stirling-pdf"
+                        sh "helm push stirling-pdf-chart-1.0.0.tgz oci://registry-1.docker.io/frooodle"
+                    }
+                }
+            }
+        }
+    }
 }

LocalRunGuide.md

@@ -1,5 +1,5 @@
 
-To run the application without Docker, you will need to manually install all dependencies and build the necessary components.
+To run the application without Docker/Podman, you will need to manually install all dependencies and build the necessary components.
 
 Note that some dependencies might not be available in the standard repositories of all Linux distributions, and may require additional steps to install.
 
@@ -8,6 +8,8 @@ The following guide assumes you have a basic understanding of using a command li
 It should work on most Linux distributions and MacOS. For Windows, you might need to use Windows Subsystem for Linux (WSL) for certain steps.
 The amount of dependencies is to actually reduce overall size, ie installing LibreOffice sub components rather than full LibreOffice package.
 
+You could theoretically use a Distrobox/Toolbox, if your Distribution has old or not all Packages. But you might just as well use the Docker Container then.
+
 ### Step 1: Prerequisites
 
 Install the following software, if not already installed:
@@ -18,7 +20,7 @@ Install the following software, if not already installed:
 
 - Git
 
-- Python 3 (with pip)
+- Python 3.8 (with pip)
 
 - Make
 
@@ -93,21 +95,21 @@ For Debian-based systems, you can use the following command:
 
 ```bash
 sudo apt-get install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper ocrmypdf
-pip3 install uno opencv-python-headless unoconv pngquant 
+pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint 
 ```
 
 For Fedora:
 
 ```bash
 sudo dnf install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper ocrmypdf
-pip3 install uno opencv-python-headless unoconv pngquant 
+pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint 
 ```
 
 ### Step 4: Clone and Build Stirling-PDF
 
 ```bash
 cd ~/.git &&\
-git clone https://github.com/Frooodle/Stirling-PDF.git &&\
+git clone https://github.com/Stirling-Tools/Stirling-PDF.git &&\
 cd Stirling-PDF &&\
 chmod +x ./gradlew &&\
 ./gradlew build
@@ -137,7 +139,7 @@ Easiest is to use the langpacks provided by your repositories. Skip the other st
 Manual:
 
 1. Download the desired language pack(s) by selecting the `.traineddata` file(s) for the language(s) you need.
-2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/4.00/tessdata`
+2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/5/tessdata`
 3. 
 Please view  [OCRmyPDF install guide](https://ocrmypdf.readthedocs.io/en/latest/installation.html) for more info.
 **IMPORTANT:** DO NOT REMOVE EXISTING `eng.traineddata`, IT'S REQUIRED.
@@ -174,7 +176,7 @@ rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
 ```bash
 ./gradlew bootRun
 or
-java -jar build/libs/app.jar
+java -jar /opt/Stirling-PDF/Stirling-PDF-*.jar
 ```
 
 ### Step 8: Adding a Desktop icon
@@ -200,6 +202,64 @@ EOF
 
 Note: Currently the app will run in the background until manually closed.
 
+### Optional: Run Stirling-PDF as a service
+
+First create a .env file, where you can store environment variables:
+```
+touch /opt/Stirling-PDF/.env
+```
+In this file you can add all variables, one variable per line, as stated in the main readme (for example SYSTEM_DEFAULTLOCALE="de-DE").
+
+Create a new file where we store our service settings and open it with nano editor:
+```
+nano /etc/systemd/system/stirlingpdf.service
+```
+
+Paste this content, make sure to update the filename of the jar-file. Press Ctrl+S and Ctrl+X to save and exit the nano editor:
+```
+[Unit]
+Description=Stirling-PDF service
+After=syslog.target network.target
+
+[Service]
+SuccessExitStatus=143
+
+User=root
+Group=root
+
+Type=simple
+
+EnvironmentFile=/opt/Stirling-PDF/.env
+WorkingDirectory=/opt/Stirling-PDF
+ExecStart=/usr/bin/java -jar Stirling-PDF-0.17.2.jar
+ExecStop=/bin/kill -15 $MAINPID
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Notify systemd that it has to rebuild its internal service database (you have to run this command every time you make a change in the service file):
+```
+sudo systemctl daemon-reload
+```
+
+Enable the service to tell the service to start it automatically:
+```
+sudo systemctl enable stirlingpdf.service
+```
+
+See the status of the service:
+```
+sudo systemctl status stirlingpdf.service
+```
+
+Manually start/stop/restart the service:
+```
+sudo systemctl start stirlingpdf.service
+sudo systemctl stop stirlingpdf.service
+sudo systemctl restart stirlingpdf.service
+```
+
 ---
 
 Remember to set the necessary environment variables before running the project if you want to customize the application the list can be seen in the main readme.

PipelineFeature.md

@@ -0,0 +1,42 @@
+# Pipeline Configuration and Usage Tutorial
+
+## Whilst Pipelines are in alpha...
+You must enable this alpha functionality by setting
+```
+system:
+  enableAlphaFunctionality: true
+```
+To true like in the above for your `/config/settings.yml` file, after restarting Stirling-PDF you should see both UI and folder scanning enabled.
+
+
+## Steps to Configure and Use Your Pipeline
+
+1. **Access Configuration**
+   - Upon entering the screen, click on the **Configure** button.
+
+2. **Enter Pipeline Name**
+   - Provide a name for your pipeline in the designated field.
+
+3. **Select Operations**
+   - Choose the operations for your pipeline (e.g., **Split Pages**), then click **Add Operation**.
+
+4. **Configure Operation Settings**
+   - Input the necessary settings for each added operation. Settings are highlighted in yellow if customization is needed.
+
+5. **Add More Operations**
+   - You can add and adjust the order of multiple operations. Ensure each operation's settings are customized.
+
+6. **Save Settings**
+   - Click **Save Operation Settings** after customizing settings for each operation.
+
+7. **Validate Pipeline**
+   - Use the **Validation** button to check your pipeline. A green indicator signifies correct setup; a pop-out error indicates issues.
+
+8. **Download Pipeline Configuration**
+   - To use the configuration for folder scanning (or save it for future use and reupload it), you can also download a JSON file in this menu. You can also pre-load this for future use by placing it in ``/pipeline/defaultWebUIConfigs/``. It will then appear in the dropdown menu for all users to use.
+
+9. **Submit Files for Processing**
+   - If your pipeline is correctly set up close the configure menu, input the files and hit **Submit**.
+
+10. **Note on Web UI Limitations**
+    - The current web UI version does not support operations that require multiple different types of inputs, such as adding a separate image to a PDF.

README.md

@@ -1,32 +1,31 @@
-<p align="center"><img src="https://raw.githubusercontent.com/Frooodle/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
+<p align="center"><img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
 </p>
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/frooodle/s-pdf)](https://hub.docker.com/r/frooodle/s-pdf)
 [![Discord](https://img.shields.io/discord/1068636748814483718?label=Discord)](https://discord.gg/Cn8pWhQRxZ)
-[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Frooodle/Stirling-PDF/)
+[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Stirling-Tools/Stirling-PDF/)
-[![GitHub Repo stars](https://img.shields.io/github/stars/frooodle/stirling-pdf?style=social)](https://github.com/Frooodle/stirling-pdf)
+[![GitHub Repo stars](https://img.shields.io/github/stars/stirling-tools/stirling-pdf?style=social)](https://github.com/Stirling-Tools/stirling-pdf)
 [![Paypal Donate](https://img.shields.io/badge/Paypal%20Donate-yellow?style=flat&logo=paypal)](https://www.paypal.com/paypalme/froodleplex)
 [![Github Sponser](https://img.shields.io/badge/Github%20Sponsor-yellow?style=flat&logo=github)](https://github.com/sponsors/Frooodle)
 
-[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/Frooodle/Stirling-PDF/tree/digitalOcean&refcode=c3210994b1af)
+[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/Stirling-Tools/Stirling-PDF/tree/digitalOcean&refcode=c3210994b1af)
 
 This is a powerful locally hosted web based PDF manipulation tool using docker that allows you to perform various operations on PDF files, such as splitting merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application started as a 100% ChatGPT-made application and has evolved to include a wide range of features to handle all your PDF needs.
 
 Stirling PDF makes no outbound calls for any record keeping or tracking.
 
-All files and PDFs are either purely client side, in server memory only during the execution of the task or within a temporay file only for execution of the task.
+All files and PDFs exist either exclusively on the client side, reside in server memory only during task execution, or temporarily reside in a file solely for the execution of the task. Any file downloaded by the user will have been deleted from the server by that point.
-Any file which has been downloaded by the user will have already been deleted from the server by that time.
 
-Feel free to request any features or bug fixes either in github issues or our [Discord](https://discord.gg/Cn8pWhQRxZ)
+Please feel free to submit feature requests or report bugs either through GitHub issues or on our [Discord](https://discord.gg/Cn8pWhQRxZ)
 
 ![stirling-home](images/stirling-home.png)
 
 ## Features
 - Dark mode support.
-- Custom download options (see [here](https://github.com/Frooodle/Stirling-PDF/blob/main/images/settings.png) for example)
+- Custom download options (see [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/images/settings.png) for example)
 - Parallel file processing and downloads
 - API for integration with external scripts 
-- Optional Login and Authentication support (see [here](https://github.com/Frooodle/Stirling-PDF/tree/main#login-authentication) for documentation)
+- Optional Login and Authentication support (see [here](https://github.com/Stirling-Tools/Stirling-PDF/tree/main#login-authentication) for documentation)
 
 
 ## **PDF Features**
@@ -81,29 +80,29 @@ Feel free to request any features or bug fixes either in github issues or our [D
 - Get all information on a PDF to view or export as JSON. 
 
 
-For a overview of the tasks and the technology each uses please view [groups.md](https://github.com/Frooodle/Stirling-PDF/blob/main/Groups.md)
+For a overview of the tasks and the technology each uses please view [Endpoint-groups.md](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Endpoint-groups.md)
 Hosted instance/demo of the app can be seen [here](https://pdf.adminforge.de/) hosted by the team at adminforge.de
 
 ## Technologies used
 - Spring Boot + Thymeleaf
-- PDFBox
+- [PDFBox](https://github.com/apache/pdfbox/tree/trunk)
 - [LibreOffice](https://www.libreoffice.org/discover/libreoffice/) for advanced conversions
 - [OcrMyPdf](https://github.com/ocrmypdf/OCRmyPDF)
 - HTML, CSS, JavaScript
 - Docker
-- PDF.js
+- [PDF.js](https://github.com/mozilla/pdf.js)
-- PDF-LIB.js
+- [PDF-LIB.js](https://github.com/Hopding/pdf-lib)
 
 ## How to use
 
 ### Locally
-Please view https://github.com/Frooodle/Stirling-PDF/blob/main/LocalRunGuide.md
+Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/LocalRunGuide.md
 
-### Docker
+### Docker / Podman
 https://hub.docker.com/r/frooodle/s-pdf
 
 Stirling PDF has 3 different versions, a Full version, Lite, and ultra-Lite. Depending on the types of features you use you may want a smaller image to save on space.
-To see what the different versions offer please look at our [version mapping](https://github.com/Frooodle/Stirling-PDF/blob/main/Version-groups.md)
+To see what the different versions offer please look at our [version mapping](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Version-groups.md)
 For people that don't mind about space optimization just use the latest tag.
 ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest?label=Stirling-PDF%20Full)
 ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-lite?label=Stirling-PDF%20Lite)
@@ -113,8 +112,9 @@ Docker Run
 ```
 docker run -d \
   -p 8080:8080 \
-  -v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata \
+  -v /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata \
   -v /location/of/extraConfigs:/configs \
+  -v /location/of/logs:/logs \
   -e DOCKER_ENABLE_SECURITY=false \
   --name stirling-pdf \
   frooodle/s-pdf:latest
@@ -133,26 +133,29 @@ services:
     ports:
       - '8080:8080'
     volumes:
-      - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata #Required for extra OCR languages
+      - /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata #Required for extra OCR languages
       - /location/of/extraConfigs:/configs
 #      - /location/of/customFiles:/customFiles/
+#      - /location/of/logs:/logs/
     environment:
       - DOCKER_ENABLE_SECURITY=false
 ```
 
+Note: Podman is CLI-compatible with Docker, so simply replace "docker" with "podman".
 
 ## Enable OCR/Compression feature
-Please view https://github.com/Frooodle/Stirling-PDF/blob/main/HowToUseOCR.md
+Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
 
 ## Want to add your own language?
-Stirling PDF currently supports 19!
+Stirling PDF currently supports 26!
 - English (English) (en_GB)
 - English (US) (en_US)
 - Arabic (العربية) (ar_AR)
 - German (Deutsch) (de_DE)
 - French (Français) (fr_FR)
 - Spanish (Español) (es_ES)
-- Chinese (简体中文) (zh_CN)
+- Simplified Chinese (简体中文) (zh_CN)
+- Traditional Chinese (繁體中文) (zh_TW)
 - Catalan (Català) (ca_CA)
 - Italian (Italiano) (it_IT)
 - Swedish (Svenska) (sv_SE)
@@ -165,9 +168,15 @@ Stirling PDF currently supports 19!
 - Japanese (日本語) (ja_JP)
 - Dutch (Nederlands) (nl_NL)
 - Greek (el_GR)
+- Turkish (Türkçe) (tr_TR)
+- Indonesia (Bahasa Indonesia) (id_ID)
+- Hindi (हिंदी) (hi_IN)
+- Hungarian (Magyar) (hu_HU)
+- Bulgarian (Български) (bg_BG)
+- Sebian Latin alphabet (Srpski) (sr-Latn-RS)
 
 If you want to add your own language to Stirling-PDF please refer
-https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md
+https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md
 
 And please create a PR to merge it back in so others can use it! 
 
@@ -219,7 +228,7 @@ metrics:
   enabled: true # 'true' to enable Info APIs endpoints (view http://localhost:8080/swagger-ui/index.html#/API to learn more), 'false' to disable
 ```
 ### Extra notes
-- Endpoints. Currently, the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma separate lists of endpoints and groups to disable as example ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages would disable both image-to-pdf and remove pages, GROUPS_TO_REMOVE=LibreOffice Would disable all things that use LibreOffice. You can see a list of all endpoints and groups [here](https://github.com/Frooodle/Stirling-PDF/blob/main/groups.md) 
+- Endpoints. Currently, the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma separate lists of endpoints and groups to disable as example ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages would disable both image-to-pdf and remove pages, GROUPS_TO_REMOVE=LibreOffice Would disable all things that use LibreOffice. You can see a list of all endpoints and groups [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Endpoint-groups.md)
 - customStaticFilePath. Customise static files such as the app logo by placing files in the /customFiles/static/ directory. An example of customising app logo is placing a /customFiles/static/favicon.svg to override current SVG. This can be used to change any images/icons/css/fonts/js etc in Stirling-PDF
 
 ### Environment only parameters
@@ -229,7 +238,7 @@ metrics:
 
 ## API
 For those wanting to use Stirling-PDFs backend API to link with their own custom scripting to edit PDFs you can view all existing API documentation
-[here](https://app.swaggerhub.com/apis-docs/Frooodle/Stirling-PDF/) or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation (Or by following the API button in your settings of Stirling-PDF)
+[here](https://app.swaggerhub.com/apis-docs/Stirling-Tools/Stirling-PDF/) or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation (Or by following the API button in your settings of Stirling-PDF)
 
 
 ## Login authentication
@@ -263,7 +272,7 @@ For API usage you must provide a header with 'X-API-Key' and the associated API
 - Fill forms mannual and automatic 
 
 ### Q2: Why is my application downloading .htm files?
-This is a issue caused commonly by your NGINX congifuration. The default file upload size for NGINX is 1MB, you need to add the following in your Nginx sites-available file. ``client_max_body_size SIZE;`` Where "SIZE" is 50M for example for 50MB files.
+This is an issue caused commonly by your NGINX configuration. The default file upload size for NGINX is 1MB, you need to add the following in your Nginx sites-available file. ``client_max_body_size SIZE;`` Where "SIZE" is 50M for example for 50MB files.
 
 ### Q3: Why is my download timing out
 NGINX has timeout values by default so if you are running Stirling-PDF behind NGINX you may need to set a timeout value such as adding the config ``proxy_read_timeout 3600;``

Version-groups.md

@@ -19,6 +19,7 @@ add-image           |     ✔️      |  ✔️   |  ✔️
 add-watermark       |     ✔️      |  ✔️   |  ✔️
 adjust-contrast     |     ✔️      |  ✔️   |  ✔️
 auto-split-pdf      |     ✔️      |  ✔️   |  ✔️
+auto-redact         |     ✔️      |  ✔️   |  ✔️
 auto-rename         |     ✔️      |  ✔️   |  ✔️
 cert-sign           |     ✔️      |  ✔️   |  ✔️
 crop                |     ✔️      |  ✔️   |  ✔️
@@ -33,7 +34,9 @@ img-to-pdf          |     ✔️      |  ✔️   |  ✔️
 markdown-to-pdf     |     ✔️      |  ✔️   |  ✔️
 merge-pdfs          |     ✔️      |  ✔️   |  ✔️
 multi-page-layout   |     ✔️      |  ✔️   |  ✔️
+overlay-pdf         |     ✔️      |  ✔️   |  ✔️
 pdf-organizer       |     ✔️      |  ✔️   |  ✔️
+pdf-to-csv          |     ✔️      |  ✔️   |  ✔️
 pdf-to-img          |     ✔️      |  ✔️   |  ✔️
 pdf-to-single-page  |     ✔️      |  ✔️   |  ✔️
 remove-pages        |     ✔️      |  ✔️   |  ✔️
@@ -43,6 +46,8 @@ sanitize-pdf        |     ✔️      |  ✔️   |  ✔️
 scale-pages         |     ✔️      |  ✔️   |  ✔️
 sign                |     ✔️      |  ✔️   |  ✔️
 show-javascript     |     ✔️      |  ✔️   |  ✔️
+split-by-size-or-count |     ✔️      |  ✔️   |  ✔️
+split-pdf-by-sections  |     ✔️      |  ✔️   |  ✔️
 split-pdfs          |     ✔️      |  ✔️   |  ✔️
 file-to-pdf         |             |  ✔️   |  ✔️
 pdf-to-html         |             |  ✔️   |  ✔️

build.gradle

@@ -1,18 +1,28 @@
 plugins {
-	id 'java'
+    id 'java'
-	id 'org.springframework.boot' version '3.1.2'
+    id 'org.springframework.boot' version '3.2.1'
-	id 'io.spring.dependency-management' version '1.1.3'
+    id 'io.spring.dependency-management' version '1.1.3'
-	id 'org.springdoc.openapi-gradle-plugin' version '1.6.0'
+    id 'org.springdoc.openapi-gradle-plugin' version '1.8.0'
-	id "io.swagger.swaggerhub" version "1.2.0"
+    id "io.swagger.swaggerhub" version "1.3.2"
-	id 'edu.sc.seis.launch4j' version '3.0.5'
+    id 'edu.sc.seis.launch4j' version '3.0.5'
+    id 'com.diffplug.spotless' version '6.23.3'
+    id 'com.github.jk1.dependency-license-report' version '2.5'
 }
 
+import com.github.jk1.license.render.*
+
 group = 'stirling.software'
-version = '0.15.0'
+version = '0.19.1'
 sourceCompatibility = '17'
 
 repositories {
-	mavenCentral()
+    mavenCentral()
+}
+
+
+
+licenseReport {
+    renderers = [new JsonReportRenderer()]
 }
 
 sourceSets {
@@ -32,7 +42,6 @@ sourceSets {
     }
 }
 
-
 openApi {
     apiDocsUrl = "http://localhost:8080/v1/api-docs"
     outputDir = file("$projectDir")
@@ -46,15 +55,15 @@ launch4j {
   outfile="Stirling-PDF.exe"
   headerType="console"
   jarTask = tasks.bootJar
-  
+
   errTitle="Encountered error, Do you have Java 17?"
-  downloadUrl="https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe" 
+  downloadUrl="https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe"
-  variables=["BROWSER_OPEN=true"]
+  variables=["BROWSER_OPEN=true", "ENDPOINTS_GROUPS_TO_REMOVE=CLI"]
   jreMinVersion="17"
-  
+
   mutexName="Stirling-PDF"
   windowTitle="Stirling-PDF"
-  
+
   messagesStartupError="An error occurred while starting Stirling-PDF"
   //messagesJreNotFoundError="This application requires a Java Runtime Environment, Please download Java 17."
   messagesJreVersionError="You are running the wrong version of Java, Please download Java 17."
@@ -62,45 +71,97 @@ launch4j {
   messagesInstanceAlreadyExists="Stirling-PDF is already running."
 }
 
-dependencies {
+spotless {
-	implementation 'org.yaml:snakeyaml:2.1'
+    java {
-	implementation 'org.springframework.boot:spring-boot-starter-web:3.1.2'
+        target project.fileTree('src/main/java')
-	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf:3.1.2'
-	
-	if (System.getenv('DOCKER_ENABLE_SECURITY') != 'false') {
-        implementation 'org.springframework.boot:spring-boot-starter-security:3.1.2'
-        implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.2.RELEASE'
-        implementation "org.springframework.boot:spring-boot-starter-data-jpa"
-		implementation "com.h2database:h2"
-    }
-	
-	testImplementation 'org.springframework.boot:spring-boot-starter-test:3.1.4'
-	
-	
 
-	// https://mvnrepository.com/artifact/org.apache.pdfbox/jbig2-imageio
+        googleJavaFormat('1.19.1').aosp().reorderImports(false)
-	implementation group: 'org.apache.pdfbox', name: 'jbig2-imageio', version: '3.0.4'
+
-	implementation 'commons-io:commons-io:2.13.0'
+        importOrder('java', 'javax', 'org', 'com', 'net', 'io')
-	
+        toggleOffOn()
+        trimTrailingWhitespace()
+        indentWithSpaces()
+        endWithNewline()
+    }
+}
+
+dependencies {
+    //security updates
+    implementation 'ch.qos.logback:logback-classic:1.4.14'
+    implementation 'ch.qos.logback:logback-core:1.4.14'
+    implementation 'org.springframework:spring-webmvc:6.1.2'
+
+    implementation 'org.yaml:snakeyaml:2.2'
+    implementation 'org.springframework.boot:spring-boot-starter-web:3.2.1'
+    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf:3.2.1'
+
+    if (System.getenv('DOCKER_ENABLE_SECURITY') != 'false') {
+        implementation 'org.springframework.boot:spring-boot-starter-security:3.2.1'
+        implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.2.RELEASE'
+        implementation "org.springframework.boot:spring-boot-starter-data-jpa:3.2.1"
+        
+        //2.2.x requires rebuild of DB file.. need migration path
+        implementation "com.h2database:h2:2.1.214"
+    }
+
+    testImplementation 'org.springframework.boot:spring-boot-starter-test:3.2.1'
+
+    // Batik
+    implementation 'org.apache.xmlgraphics:batik-all:1.17'
+
+    // TwelveMonkeys
+    implementation 'com.twelvemonkeys.imageio:imageio-batik:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-bmp:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-hdr:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-icns:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-iff:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-jpeg:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-pcx:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-pict:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-pnm:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-psd:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-sgi:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-tga:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-thumbsdb:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-tiff:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-webp:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-xwd:3.10.1'
+
+    implementation 'commons-io:commons-io:2.15.1'
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
+
+    //general PDF
+
+    // https://mvnrepository.com/artifact/com.opencsv/opencsv
+    implementation ('com.opencsv:opencsv:5.9') {
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
     
-	//general PDF
+    implementation ('org.apache.pdfbox:pdfbox:2.0.30'){
-    implementation 'org.apache.pdfbox:pdfbox:2.0.29'
+        exclude group: 'commons-logging', module: 'commons-logging'
-    implementation 'org.apache.pdfbox:xmpbox:2.0.29'
+    }
-    implementation 'org.bouncycastle:bcprov-jdk15on:1.70'
+    
-    implementation 'org.bouncycastle:bcpkix-jdk15on:1.70' 
+    implementation ('org.apache.pdfbox:xmpbox:2.0.30'){
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
+    
+    implementation 'org.bouncycastle:bcprov-jdk18on:1.77'
+    implementation 'org.bouncycastle:bcpkix-jdk18on:1.77'
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'io.micrometer:micrometer-core'
     implementation group: 'com.google.zxing', name: 'core', version: '3.5.2'
     // https://mvnrepository.com/artifact/org.commonmark/commonmark
-	implementation 'org.commonmark:commonmark:0.21.0'
+    implementation 'org.commonmark:commonmark:0.21.0'
     // https://mvnrepository.com/artifact/com.github.vladimir-bukhtoyarov/bucket4j-core
-	implementation 'com.github.vladimir-bukhtoyarov:bucket4j-core:7.6.0'
+    implementation 'com.github.vladimir-bukhtoyarov:bucket4j-core:7.6.0'
-    
-    developmentOnly("org.springframework.boot:spring-boot-devtools")
-	compileOnly 'org.projectlombok:lombok:1.18.28'
-	annotationProcessor 'org.projectlombok:lombok:1.18.28'
 
+    developmentOnly("org.springframework.boot:spring-boot-devtools")
+    compileOnly 'org.projectlombok:lombok:1.18.30'
+    annotationProcessor 'org.projectlombok:lombok:1.18.28'
+}
+
+tasks.withType(JavaCompile) {
+    dependsOn 'spotlessApply'
 }
 
 task writeVersion {
@@ -128,11 +189,11 @@ jar {
         attributes 'Implementation-Title': 'Stirling-PDF',
                    'Implementation-Version': project.version
     }
-    
+
 }
 
 tasks.named('test') {
-	useJUnitPlatform()
+    useJUnitPlatform()
 }
 
 task printVersion {

chart/stirling-pdf/Chart.yaml

@@ -1,15 +1,15 @@
 apiVersion: v2
 appVersion: 0.14.2
 description: locally hosted web application that allows you to perform various operations on PDF files
-home: https://github.com/Frooodle/Stirling-PDF
+home: https://github.com/Stirling-Tools/Stirling-PDF
 keywords:
 - stirling-pdf
 - helm
 - charts repo
 maintainers:
-- name: Frooodle
+- name: Stirling-Tools
-  url: https://github.com/Frooodle/Stirling-PDF
+  url: https://github.com/Stirling-Tools/Stirling-PDF
-name: stirling-pdf
+name: stirling-pdf-chart
 sources:
-- https://github.com/Frooodle/Stirling-PDF
+- https://github.com/Stirling-Tools/Stirling-PDF
 version: 1.0.0

exampleYmlFiles/docker-compose-latest-lite-security.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Lite-Security
+    image: frooodle/s-pdf:latest-lite
+    deploy:
+      resources:
+        limits:
+          memory: 2G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "true"
+      SECURITY_ENABLELOGIN: "true"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Lite Latest with Security
+      UI_APPNAMENAVBAR: Stirling-PDF-Lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-lite.yml

@@ -0,0 +1,30 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Lite
+    image: frooodle/s-pdf:latest-lite
+    deploy:
+      resources:
+        limits:
+          memory: 2G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "false"
+      SECURITY_ENABLELOGIN: "false"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Lite Latest
+      UI_APPNAMENAVBAR: Stirling-PDF-Lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-security.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Security
+    image: frooodle/s-pdf:latest
+    deploy:
+      resources:
+        limits:
+          memory: 4G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "true"
+      SECURITY_ENABLELOGIN: "true"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest with Security
+      UI_APPNAMENAVBAR: Stirling-PDF Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-ultra-lite-security.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Ultra-Lite-Security
+    image: frooodle/s-pdf:latest-ultra-lite
+    deploy:
+      resources:
+        limits:
+          memory: 1G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "true"
+      SECURITY_ENABLELOGIN: "true"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Lite Latest with Security
+      UI_APPNAMENAVBAR: Stirling-PDF-Lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-ultra-lite.yml

@@ -0,0 +1,30 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Ultra-Lite
+    image: frooodle/s-pdf:latest-ultra-lite
+    deploy:
+      resources:
+        limits:
+          memory: 1G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "false"
+      SECURITY_ENABLELOGIN: "false"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Ultra-lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Ultra-lite Latest
+      UI_APPNAMENAVBAR: Stirling-PDF-Ultra-lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF
+    image: frooodle/s-pdf:latest
+    deploy:
+      resources:
+        limits:
+          memory: 4G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "false"
+      SECURITY_ENABLELOGIN: "false"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest
+      UI_APPNAMENAVBAR: Stirling-PDF Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

pipeline/defaultWebUIConfigs/Prepare-pdfs-for-email.json

@@ -0,0 +1,39 @@
+{
+  "name": "Prepare-pdfs-for-email",
+  "pipeline": [
+    {
+      "operation": "/api/v1/misc/repair",
+      "parameters": {}
+    },
+    {
+      "operation": "/api/v1/security/sanitize-pdf",
+      "parameters": {
+        "removeJavaScript": true,
+        "removeEmbeddedFiles": false,
+        "removeMetadata": false,
+        "removeLinks": false,
+        "removeFonts": false
+      }
+    },
+    {
+      "operation": "/api/v1/misc/compress-pdf",
+      "parameters": {
+        "optimizeLevel": 2,
+        "expectedOutputSize": ""
+      }
+    },
+    {
+      "operation": "/api/v1/general/split-by-size-or-count",
+      "parameters": {
+        "splitType": 0,
+        "splitValue": "15MB"
+      }
+    }
+  ],
+  "_examples": {
+    "outputDir": "{outputFolder}/{folderName}",
+    "outputFileName": "{filename}-{pipelineName}-{date}-{time}"
+  },
+  "outputDir": "httpWebRequest",
+  "outputFileName": "{filename}"
+}

pipeline/defaultWebUIConfigs/split-rotate-auto-rename.json

@@ -0,0 +1,33 @@
+{
+  "name": "split-rotate-auto-rename",
+  "pipeline": [
+    {
+      "operation": "/api/v1/general/split-pdf-by-sections",
+      "parameters": {
+        "horizontalDivisions": 2,
+        "verticalDivisions": 2,
+        "fileInput": "automated"
+      }
+    },
+    {
+      "operation": "/api/v1/general/rotate-pdf",
+      "parameters": {
+        "angle": 90,
+        "fileInput": "automated"
+      }
+    },
+    {
+      "operation": "/api/v1/misc/auto-rename",
+      "parameters": {
+        "useFirstTextAsFallback": false,
+        "fileInput": "automated"
+      }
+    }
+  ],
+  "_examples": {
+    "outputDir": "{outputFolder}/{folderName}",
+    "outputFileName": "{filename}-{pipelineName}-{date}-{time}"
+  },
+  "outputDir": "{outputFolder}",
+  "outputFileName": "{filename}"
+}

scripts/detect-blank-pages.py

@@ -1,10 +1,11 @@
 import cv2
 import sys
 import argparse
+import numpy as np
 
 def is_blank_image(image_path, threshold=10, white_percent=99, white_value=255, blur_size=5):
     image = cv2.imread(image_path, cv2.IMREAD_GRAYSCALE)
-    
+
     if image is None:
         print(f"Error: Unable to read the image file: {image_path}")
         return False
@@ -15,19 +16,11 @@ def is_blank_image(image_path, threshold=10, white_percent=99, white_value=255,
     _, thresholded_image = cv2.threshold(blurred_image, white_value - threshold, white_value, cv2.THRESH_BINARY)
 
     # Calculate the percentage of white pixels in the thresholded image
-    white_pixels = 0
+    white_pixels = np.sum(thresholded_image == white_value)
-    total_pixels = thresholded_image.size
+    white_pixel_percentage = (white_pixels / thresholded_image.size) * 100
-    for i in range(0, thresholded_image.shape[0], 2):
-        for j in range(0, thresholded_image.shape[1], 2):
-            if thresholded_image[i, j] == white_value:
-                white_pixels += 1
-            white_pixel_percentage = (white_pixels / (i * thresholded_image.shape[1] + j + 1)) * 100
-            if white_pixel_percentage < white_percent:
-                return False
 
     print(f"Page has white pixel percent of {white_pixel_percentage}")
-    return True
+    return white_pixel_percentage >= white_percent
-
 
 
 if __name__ == "__main__":
@@ -39,9 +32,6 @@ if __name__ == "__main__":
 
     blank = is_blank_image(args.image_path, args.threshold, args.white_percent)
 
-    if blank:
+    # Return code 1: The image is considered blank.
-        # Return code 1: The image is considered blank.
+    # Return code 0: The image is not considered blank.
-        sys.exit(1)
+    sys.exit(int(blank))
-    else:
-        # Return code 0: The image is not considered blank.
-        sys.exit(0)

scripts/download-security-jar.sh

@@ -0,0 +1,19 @@
+echo "Running Stirling PDF with DOCKER_ENABLE_SECURITY=${DOCKER_ENABLE_SECURITY} and VERSION_TAG=${VERSION_TAG}"
+# Check for DOCKER_ENABLE_SECURITY and download the appropriate JAR if required
+if [ "$DOCKER_ENABLE_SECURITY" = "true" ] && [ "$VERSION_TAG" != "alpha" ]; then
+    if [ ! -f app-security.jar ]; then
+    	echo "Trying to download from: https://github.com/Stirling-Tools/Stirling-PDF/releases/download/v$VERSION_TAG/Stirling-PDF-with-login.jar"
+        curl -L -o app-security.jar https://github.com/Stirling-Tools/Stirling-PDF/releases/download/v$VERSION_TAG/Stirling-PDF-with-login.jar
+       
+        # If the first download attempt failed, try with the 'v' prefix
+        if [ $? -ne 0 ]; then
+            echo "Trying to download from: https://github.com/Stirling-Tools/Stirling-PDF/releases/download/$VERSION_TAG/Stirling-PDF-with-login.jar"
+        	curl -L -o app-security.jar https://github.com/Stirling-Tools/Stirling-PDF/releases/download/$VERSION_TAG/Stirling-PDF-with-login.jar
+        fi
+
+        if [ $? -eq 0 ]; then  # checks if curl was successful
+            rm -f app.jar
+            ln -s app-security.jar app.jar
+        fi
+    fi
+fi

scripts/init-without-ocr.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+/scripts/download-security-jar.sh
+
+# Run the main command
+exec "$@"

scripts/init.sh

@@ -3,7 +3,11 @@
 # Copy the original tesseract-ocr files to the volume directory without overwriting existing files
 echo "Copying original files without overwriting existing files"
 mkdir -p /usr/share/tesseract-ocr
-cp -rn /usr/share/tesseract-ocr-original/* /usr/share/tesseract-ocr
+cp -rn /usr/share/tesseract-ocr-original/* /usr/share/tesseract-ocr 
+
+if [ -d /usr/share/tesseract-ocr/4.00/tessdata ]; then 
+	cp -r /usr/share/tesseract-ocr/4.00/tessdata/* /usr/share/tesseract-ocr/5/tessdata/ || true; 
+fi
 
 # Check if TESSERACT_LANGS environment variable is set and is not empty
 if [[ -n "$TESSERACT_LANGS" ]]; then
@@ -16,25 +20,7 @@ if [[ -n "$TESSERACT_LANGS" ]]; then
   done
 fi
 
-# Check for DOCKER_ENABLE_SECURITY and download the appropriate JAR if required
+/scripts/download-security-jar.sh
-if [ "$DOCKER_ENABLE_SECURITY" = "true" ] && [ "$VERSION_TAG" != "alpha" ]; then
-    if [ ! -f app-security.jar ]; then
-    	echo "Trying to download from: https://github.com/Frooodle/Stirling-PDF/releases/download/v$VERSION_TAG/Stirling-PDF-with-login.jar"
-        curl -L -o app-security.jar https://github.com/Frooodle/Stirling-PDF/releases/download/v$VERSION_TAG/Stirling-PDF-with-login.jar
-       
-        # If the first download attempt failed, try with the 'v' prefix
-        if [ $? -ne 0 ]; then
-            echo "Trying to download from: https://github.com/Frooodle/Stirling-PDF/releases/download/$VERSION_TAG/Stirling-PDF-with-login.jar"
-        	curl -L -o app-security.jar https://github.com/Frooodle/Stirling-PDF/releases/download/$VERSION_TAG/Stirling-PDF-with-login.jar
-        fi
-
-        if [ $? -eq 0 ]; then  # checks if curl was successful
-            rm -f app.jar
-            ln -s app-security.jar app.jar
-        fi
-    fi
-fi
-
 
 # Run the main command
 exec "$@"

src/main/java/org/apache/pdfbox/examples/signature/CMSProcessableInputStream.java

@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.signature;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import org.bouncycastle.asn1.ASN1ObjectIdentifier;
+import org.bouncycastle.asn1.cms.CMSObjectIdentifiers;
+import org.bouncycastle.cms.CMSException;
+import org.bouncycastle.cms.CMSTypedData;
+
+/**
+ * Wraps a InputStream into a CMSProcessable object for bouncy castle. It's a memory saving
+ * alternative to the {@link org.bouncycastle.cms.CMSProcessableByteArray CMSProcessableByteArray}
+ * class.
+ *
+ * @author Thomas Chojecki
+ */
+class CMSProcessableInputStream implements CMSTypedData {
+    private final InputStream in;
+    private final ASN1ObjectIdentifier contentType;
+
+    CMSProcessableInputStream(InputStream is) {
+        this(new ASN1ObjectIdentifier(CMSObjectIdentifiers.data.getId()), is);
+    }
+
+    CMSProcessableInputStream(ASN1ObjectIdentifier type, InputStream is) {
+        contentType = type;
+        in = is;
+    }
+
+    @Override
+    public Object getContent() {
+        return in;
+    }
+
+    @Override
+    public void write(OutputStream out) throws IOException, CMSException {
+        // read the content only one time
+        in.transferTo(out);
+        in.close();
+    }
+
+    @Override
+    public ASN1ObjectIdentifier getContentType() {
+        return contentType;
+    }
+}

src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java

@@ -0,0 +1,170 @@
+/*
+ * Copyright 2015 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pdfbox.examples.signature;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URISyntaxException;
+import java.security.GeneralSecurityException;
+import java.security.KeyStore;
+import java.security.KeyStoreException;
+import java.security.NoSuchAlgorithmException;
+import java.security.PrivateKey;
+import java.security.UnrecoverableKeyException;
+import java.security.cert.Certificate;
+import java.security.cert.CertificateException;
+import java.security.cert.X509Certificate;
+import java.util.Arrays;
+import java.util.Enumeration;
+
+import org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface;
+import org.bouncycastle.cert.jcajce.JcaCertStore;
+import org.bouncycastle.cms.CMSException;
+import org.bouncycastle.cms.CMSSignedData;
+import org.bouncycastle.cms.CMSSignedDataGenerator;
+import org.bouncycastle.cms.jcajce.JcaSignerInfoGeneratorBuilder;
+import org.bouncycastle.operator.ContentSigner;
+import org.bouncycastle.operator.OperatorCreationException;
+import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder;
+import org.bouncycastle.operator.jcajce.JcaDigestCalculatorProviderBuilder;
+
+public abstract class CreateSignatureBase implements SignatureInterface {
+    private PrivateKey privateKey;
+    private Certificate[] certificateChain;
+    private String tsaUrl;
+    private boolean externalSigning;
+
+    /**
+     * Initialize the signature creator with a keystore (pkcs12) and pin that should be used for the
+     * signature.
+     *
+     * @param keystore is a pkcs12 keystore.
+     * @param pin is the pin for the keystore / private key
+     * @throws KeyStoreException if the keystore has not been initialized (loaded)
+     * @throws NoSuchAlgorithmException if the algorithm for recovering the key cannot be found
+     * @throws UnrecoverableKeyException if the given password is wrong
+     * @throws CertificateException if the certificate is not valid as signing time
+     * @throws IOException if no certificate could be found
+     */
+    public CreateSignatureBase(KeyStore keystore, char[] pin)
+            throws KeyStoreException,
+                    UnrecoverableKeyException,
+                    NoSuchAlgorithmException,
+                    IOException,
+                    CertificateException {
+        // grabs the first alias from the keystore and get the private key. An
+        // alternative method or constructor could be used for setting a specific
+        // alias that should be used.
+        Enumeration<String> aliases = keystore.aliases();
+        String alias;
+        Certificate cert = null;
+        while (cert == null && aliases.hasMoreElements()) {
+            alias = aliases.nextElement();
+            setPrivateKey((PrivateKey) keystore.getKey(alias, pin));
+            Certificate[] certChain = keystore.getCertificateChain(alias);
+            if (certChain != null) {
+                setCertificateChain(certChain);
+                cert = certChain[0];
+                if (cert instanceof X509Certificate) {
+                    // avoid expired certificate
+                    ((X509Certificate) cert).checkValidity();
+
+                    //// SigUtils.checkCertificateUsage((X509Certificate) cert);
+                }
+            }
+        }
+
+        if (cert == null) {
+            throw new IOException("Could not find certificate");
+        }
+    }
+
+    public final void setPrivateKey(PrivateKey privateKey) {
+        this.privateKey = privateKey;
+    }
+
+    public final void setCertificateChain(final Certificate[] certificateChain) {
+        this.certificateChain = certificateChain;
+    }
+
+    public Certificate[] getCertificateChain() {
+        return certificateChain;
+    }
+
+    public void setTsaUrl(String tsaUrl) {
+        this.tsaUrl = tsaUrl;
+    }
+
+    /**
+     * SignatureInterface sample implementation.
+     *
+     * <p>This method will be called from inside of the pdfbox and create the PKCS #7 signature. The
+     * given InputStream contains the bytes that are given by the byte range.
+     *
+     * <p>This method is for internal use only.
+     *
+     * <p>Use your favorite cryptographic library to implement PKCS #7 signature creation. If you
+     * want to create the hash and the signature separately (e.g. to transfer only the hash to an
+     * external application), read <a href="https://stackoverflow.com/questions/41767351">this
+     * answer</a> or <a href="https://stackoverflow.com/questions/56867465">this answer</a>.
+     *
+     * @throws IOException
+     */
+    @Override
+    public byte[] sign(InputStream content) throws IOException {
+        // cannot be done private (interface)
+        try {
+            CMSSignedDataGenerator gen = new CMSSignedDataGenerator();
+            X509Certificate cert = (X509Certificate) certificateChain[0];
+            ContentSigner sha1Signer =
+                    new JcaContentSignerBuilder("SHA256WithRSA").build(privateKey);
+            gen.addSignerInfoGenerator(
+                    new JcaSignerInfoGeneratorBuilder(
+                                    new JcaDigestCalculatorProviderBuilder().build())
+                            .build(sha1Signer, cert));
+            gen.addCertificates(new JcaCertStore(Arrays.asList(certificateChain)));
+            CMSProcessableInputStream msg = new CMSProcessableInputStream(content);
+            CMSSignedData signedData = gen.generate(msg, false);
+            if (tsaUrl != null && !tsaUrl.isEmpty()) {
+                ValidationTimeStamp validation = new ValidationTimeStamp(tsaUrl);
+                signedData = validation.addSignedTimeStamp(signedData);
+            }
+            return signedData.getEncoded();
+        } catch (GeneralSecurityException
+                | CMSException
+                | OperatorCreationException
+                | URISyntaxException e) {
+            throw new IOException(e);
+        }
+    }
+
+    /**
+     * Set if external signing scenario should be used. If {@code false}, SignatureInterface would
+     * be used for signing.
+     *
+     * <p>Default: {@code false}
+     *
+     * @param externalSigning {@code true} if external signing should be performed
+     */
+    public void setExternalSigning(boolean externalSigning) {
+        this.externalSigning = externalSigning;
+    }
+
+    public boolean isExternalSigning() {
+        return externalSigning;
+    }
+}

src/main/java/org/apache/pdfbox/examples/signature/TSAClient.java

@@ -0,0 +1,176 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.signature;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.math.BigInteger;
+import java.net.URL;
+import java.net.URLConnection;
+import java.nio.charset.StandardCharsets;
+import java.security.DigestInputStream;
+import java.security.MessageDigest;
+import java.security.SecureRandom;
+import java.util.Base64;
+import java.util.Random;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.bouncycastle.asn1.ASN1ObjectIdentifier;
+import org.bouncycastle.operator.DefaultDigestAlgorithmIdentifierFinder;
+import org.bouncycastle.operator.DigestAlgorithmIdentifierFinder;
+import org.bouncycastle.tsp.TSPException;
+import org.bouncycastle.tsp.TimeStampRequest;
+import org.bouncycastle.tsp.TimeStampRequestGenerator;
+import org.bouncycastle.tsp.TimeStampResponse;
+import org.bouncycastle.tsp.TimeStampToken;
+
+/**
+ * Time Stamping Authority (TSA) Client [RFC 3161].
+ *
+ * @author Vakhtang Koroghlishvili
+ * @author John Hewson
+ */
+public class TSAClient {
+    private static final Logger LOG = LogManager.getLogger(TSAClient.class);
+
+    private static final DigestAlgorithmIdentifierFinder ALGORITHM_OID_FINDER =
+            new DefaultDigestAlgorithmIdentifierFinder();
+
+    private final URL url;
+    private final String username;
+    private final String password;
+    private final MessageDigest digest;
+
+    // SecureRandom.getInstanceStrong() would be better, but sometimes blocks on Linux
+    private static final Random RANDOM = new SecureRandom();
+
+    /**
+     * @param url the URL of the TSA service
+     * @param username user name of TSA
+     * @param password password of TSA
+     * @param digest the message digest to use
+     */
+    public TSAClient(URL url, String username, String password, MessageDigest digest) {
+        this.url = url;
+        this.username = username;
+        this.password = password;
+        this.digest = digest;
+    }
+
+    /**
+     * @param content
+     * @return the time stamp token
+     * @throws IOException if there was an error with the connection or data from the TSA server, or
+     *     if the time stamp response could not be validated
+     */
+    public TimeStampToken getTimeStampToken(InputStream content) throws IOException {
+        digest.reset();
+        DigestInputStream dis = new DigestInputStream(content, digest);
+        while (dis.read() != -1) {
+            // do nothing
+        }
+        byte[] hash = digest.digest();
+
+        // 32-bit cryptographic nonce
+        int nonce = RANDOM.nextInt();
+
+        // generate TSA request
+        TimeStampRequestGenerator tsaGenerator = new TimeStampRequestGenerator();
+        tsaGenerator.setCertReq(true);
+        ASN1ObjectIdentifier oid = ALGORITHM_OID_FINDER.find(digest.getAlgorithm()).getAlgorithm();
+        TimeStampRequest request = tsaGenerator.generate(oid, hash, BigInteger.valueOf(nonce));
+
+        // get TSA response
+        byte[] tsaResponse = getTSAResponse(request.getEncoded());
+
+        TimeStampResponse response;
+        try {
+            response = new TimeStampResponse(tsaResponse);
+            response.validate(request);
+        } catch (TSPException e) {
+            throw new IOException(e);
+        }
+
+        TimeStampToken timeStampToken = response.getTimeStampToken();
+        if (timeStampToken == null) {
+            // https://www.ietf.org/rfc/rfc3161.html#section-2.4.2
+            throw new IOException(
+                    "Response from "
+                            + url
+                            + " does not have a time stamp token, status: "
+                            + response.getStatus()
+                            + " ("
+                            + response.getStatusString()
+                            + ")");
+        }
+
+        return timeStampToken;
+    }
+
+    // gets response data for the given encoded TimeStampRequest data
+    // throws IOException if a connection to the TSA cannot be established
+    private byte[] getTSAResponse(byte[] request) throws IOException {
+        LOG.debug("Opening connection to TSA server");
+
+        // todo: support proxy servers
+        URLConnection connection = url.openConnection();
+        connection.setDoOutput(true);
+        connection.setDoInput(true);
+        connection.setRequestProperty("Content-Type", "application/timestamp-query");
+
+        LOG.debug("Established connection to TSA server");
+
+        if (username != null && password != null && !username.isEmpty() && !password.isEmpty()) {
+            String contentEncoding = connection.getContentEncoding();
+            if (contentEncoding == null) {
+                contentEncoding = StandardCharsets.UTF_8.name();
+            }
+            connection.setRequestProperty(
+                    "Authorization",
+                    "Basic "
+                            + new String(
+                                    Base64.getEncoder()
+                                            .encode(
+                                                    (username + ":" + password)
+                                                            .getBytes(contentEncoding))));
+        }
+
+        // read response
+        try (OutputStream output = connection.getOutputStream()) {
+            output.write(request);
+        } catch (IOException ex) {
+            LOG.error("Exception when writing to {}", this.url, ex);
+            throw ex;
+        }
+
+        LOG.debug("Waiting for response from TSA server");
+
+        byte[] response;
+        try (InputStream input = connection.getInputStream()) {
+            response = input.readAllBytes();
+        } catch (IOException ex) {
+            LOG.error("Exception when reading from {}", this.url, ex);
+            throw ex;
+        }
+
+        LOG.debug("Received response from TSA server");
+
+        return response;
+    }
+}

src/main/java/org/apache/pdfbox/examples/signature/ValidationTimeStamp.java

@@ -0,0 +1,134 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pdfbox.examples.signature;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.bouncycastle.asn1.ASN1Encodable;
+import org.bouncycastle.asn1.ASN1EncodableVector;
+import org.bouncycastle.asn1.ASN1ObjectIdentifier;
+import org.bouncycastle.asn1.ASN1Primitive;
+import org.bouncycastle.asn1.DERSet;
+import org.bouncycastle.asn1.cms.Attribute;
+import org.bouncycastle.asn1.cms.AttributeTable;
+import org.bouncycastle.asn1.cms.Attributes;
+import org.bouncycastle.asn1.pkcs.PKCSObjectIdentifiers;
+import org.bouncycastle.cms.CMSSignedData;
+import org.bouncycastle.cms.SignerInformation;
+import org.bouncycastle.cms.SignerInformationStore;
+import org.bouncycastle.tsp.TimeStampToken;
+
+/**
+ * This class wraps the TSAClient and the work that has to be done with it. Like Adding Signed
+ * TimeStamps to a signature, or creating a CMS timestamp attribute (with a signed timestamp)
+ *
+ * @author Others
+ * @author Alexis Suter
+ */
+public class ValidationTimeStamp {
+    private TSAClient tsaClient;
+
+    /**
+     * @param tsaUrl The url where TS-Request will be done.
+     * @throws NoSuchAlgorithmException
+     * @throws MalformedURLException
+     * @throws java.net.URISyntaxException
+     */
+    public ValidationTimeStamp(String tsaUrl)
+            throws NoSuchAlgorithmException, MalformedURLException, URISyntaxException {
+        if (tsaUrl != null) {
+            MessageDigest digest = MessageDigest.getInstance("SHA-256");
+            this.tsaClient = new TSAClient(new URI(tsaUrl).toURL(), null, null, digest);
+        }
+    }
+
+    /**
+     * Creates a signed timestamp token by the given input stream.
+     *
+     * @param content InputStream of the content to sign
+     * @return the byte[] of the timestamp token
+     * @throws IOException
+     */
+    public byte[] getTimeStampToken(InputStream content) throws IOException {
+        TimeStampToken timeStampToken = tsaClient.getTimeStampToken(content);
+        return timeStampToken.getEncoded();
+    }
+
+    /**
+     * Extend cms signed data with TimeStamp first or to all signers
+     *
+     * @param signedData Generated CMS signed data
+     * @return CMSSignedData Extended CMS signed data
+     * @throws IOException
+     */
+    public CMSSignedData addSignedTimeStamp(CMSSignedData signedData) throws IOException {
+        SignerInformationStore signerStore = signedData.getSignerInfos();
+        List<SignerInformation> newSigners = new ArrayList<>();
+
+        for (SignerInformation signer : signerStore.getSigners()) {
+            // This adds a timestamp to every signer (into his unsigned attributes) in the
+            // signature.
+            newSigners.add(signTimeStamp(signer));
+        }
+
+        // Because new SignerInformation is created, new SignerInfoStore has to be created
+        // and also be replaced in signedData. Which creates a new signedData object.
+        return CMSSignedData.replaceSigners(signedData, new SignerInformationStore(newSigners));
+    }
+
+    /**
+     * Extend CMS Signer Information with the TimeStampToken into the unsigned Attributes.
+     *
+     * @param signer information about signer
+     * @return information about SignerInformation
+     * @throws IOException
+     */
+    private SignerInformation signTimeStamp(SignerInformation signer) throws IOException {
+        AttributeTable unsignedAttributes = signer.getUnsignedAttributes();
+
+        ASN1EncodableVector vector = new ASN1EncodableVector();
+        if (unsignedAttributes != null) {
+            vector = unsignedAttributes.toASN1EncodableVector();
+        }
+
+        TimeStampToken timeStampToken =
+                tsaClient.getTimeStampToken(new ByteArrayInputStream(signer.getSignature()));
+        byte[] token = timeStampToken.getEncoded();
+        ASN1ObjectIdentifier oid = PKCSObjectIdentifiers.id_aa_signatureTimeStampToken;
+        ASN1Encodable signatureTimeStamp =
+                new Attribute(oid, new DERSet(ASN1Primitive.fromByteArray(token)));
+
+        vector.add(signatureTimeStamp);
+        Attributes signedAttributes = new Attributes(vector);
+
+        // There is no other way changing the unsigned attributes of the signer information.
+        // result is never null, new SignerInformation always returned,
+        // see source code of replaceUnsignedAttributes
+        return SignerInformation.replaceUnsignedAttributes(
+                signer, new AttributeTable(signedAttributes));
+    }
+}

src/main/java/org/apache/pdfbox/examples/util/ConnectedInputStream.java

@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.util;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.HttpURLConnection;
+
+/**
+ * Delegate class to close the connection when the class gets closed.
+ *
+ * @author Tilman Hausherr
+ */
+public class ConnectedInputStream extends InputStream {
+    HttpURLConnection con;
+    InputStream is;
+
+    public ConnectedInputStream(HttpURLConnection con, InputStream is) {
+        this.con = con;
+        this.is = is;
+    }
+
+    @Override
+    public int read() throws IOException {
+        return is.read();
+    }
+
+    @Override
+    public int read(byte[] b) throws IOException {
+        return is.read(b);
+    }
+
+    @Override
+    public int read(byte[] b, int off, int len) throws IOException {
+        return is.read(b, off, len);
+    }
+
+    @Override
+    public long skip(long n) throws IOException {
+        return is.skip(n);
+    }
+
+    @Override
+    public int available() throws IOException {
+        return is.available();
+    }
+
+    @Override
+    public synchronized void mark(int readlimit) {
+        is.mark(readlimit);
+    }
+
+    @Override
+    public synchronized void reset() throws IOException {
+        is.reset();
+    }
+
+    @Override
+    public boolean markSupported() {
+        return is.markSupported();
+    }
+
+    @Override
+    public void close() throws IOException {
+        is.close();
+        con.disconnect();
+    }
+}

src/main/java/stirling/software/SPDF/LibreOfficeListener.java

@@ -22,14 +22,14 @@ public class LibreOfficeListener {
 
     private Process process;
 
-    private LibreOfficeListener() {
+    private LibreOfficeListener() {}
-    }
 
     private boolean isListenerRunning() {
         try {
             System.out.println("waiting for listener to start");
             Socket socket = new Socket();
-            socket.connect(new InetSocketAddress("localhost", 2002), 1000); // Timeout after 1 second
+            socket.connect(
+                    new InetSocketAddress("localhost", 2002), 1000); // Timeout after 1 second
             socket.close();
             return true;
         } catch (IOException e) {
@@ -49,21 +49,22 @@ public class LibreOfficeListener {
 
         // Start a background thread to monitor the activity timeout
         executorService = Executors.newSingleThreadExecutor();
-        executorService.submit(() -> {
+        executorService.submit(
-            while (true) {
+                () -> {
-                long idleTime = System.currentTimeMillis() - lastActivityTime;
+                    while (true) {
-                if (idleTime >= ACTIVITY_TIMEOUT) {
+                        long idleTime = System.currentTimeMillis() - lastActivityTime;
-                    // If there has been no activity for too long, tear down the listener
+                        if (idleTime >= ACTIVITY_TIMEOUT) {
-                    process.destroy();
+                            // If there has been no activity for too long, tear down the listener
-                    break;
+                            process.destroy();
-                }
+                            break;
-                try {
+                        }
-                    Thread.sleep(5000); // Check for inactivity every 5 seconds
+                        try {
-                } catch (InterruptedException e) {
+                            Thread.sleep(5000); // Check for inactivity every 5 seconds
-                    break;
+                        } catch (InterruptedException e) {
-                }
+                            break;
-            }
+                        }
-        });
+                    }
+                });
 
         // Wait for the listener to start up
         long startTime = System.currentTimeMillis();
@@ -92,5 +93,4 @@ public class LibreOfficeListener {
             process.destroy();
         }
     }
-
 }

src/main/java/stirling/software/SPDF/SPdfApplication.java

@@ -1,82 +1,81 @@
-package stirling.software.SPDF;
+package stirling.software.SPDF;
-
+
-import java.nio.file.Files;
+import java.nio.file.Files;
-import java.nio.file.Paths;
+import java.nio.file.Paths;
-import java.util.Collections;
+import java.util.Collections;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.SpringApplication;
+import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.core.env.Environment;
+import org.springframework.core.env.Environment;
-
+import org.springframework.scheduling.annotation.EnableScheduling;
-import jakarta.annotation.PostConstruct;
+
-import stirling.software.SPDF.config.ConfigInitializer;
+import jakarta.annotation.PostConstruct;
-import stirling.software.SPDF.utils.GeneralUtils;
+import stirling.software.SPDF.config.ConfigInitializer;
-@SpringBootApplication
+import stirling.software.SPDF.utils.GeneralUtils;
-
+
-//@EnableScheduling
+@SpringBootApplication
-public class SPdfApplication {
+@EnableScheduling
-	
+public class SPdfApplication {
-	@Autowired
+
-    private Environment env;
+    @Autowired private Environment env;
-
+
-    @PostConstruct
+    @PostConstruct
-    public void init() {
+    public void init() {
-        // Check if the BROWSER_OPEN environment variable is set to true
+        // Check if the BROWSER_OPEN environment variable is set to true
-        String browserOpenEnv = env.getProperty("BROWSER_OPEN");
+        String browserOpenEnv = env.getProperty("BROWSER_OPEN");
-        boolean browserOpen = browserOpenEnv != null && browserOpenEnv.equalsIgnoreCase("true");
+        boolean browserOpen = browserOpenEnv != null && browserOpenEnv.equalsIgnoreCase("true");
-
+
-        if (browserOpen) {
+        if (browserOpen) {
-            try {
+            try {
-                String port = env.getProperty("local.server.port");
+                String url = "http://localhost:" + getPort();
-                if(port == null || port.length() == 0) {
+
-                	port="8080";
+                String os = System.getProperty("os.name").toLowerCase();
-                }
+                Runtime rt = Runtime.getRuntime();
-                String url = "http://localhost:" + port;
+                if (os.contains("win")) {
-
+                    // For Windows
-                String os = System.getProperty("os.name").toLowerCase();
+                    rt.exec("rundll32 url.dll,FileProtocolHandler " + url);
-                Runtime rt = Runtime.getRuntime();
+                }
-                if (os.contains("win")) {
+            } catch (Exception e) {
-                    // For Windows
+                e.printStackTrace();
-                    rt.exec("rundll32 url.dll,FileProtocolHandler " + url);
+            }
-                }
+        }
-            } catch (Exception e) {
+    }
-                e.printStackTrace();
+
-            }
+    public static void main(String[] args) {
-        }
+        SpringApplication app = new SpringApplication(SPdfApplication.class);
-    }
+        app.addInitializers(new ConfigInitializer());
-	
+        if (Files.exists(Paths.get("configs/settings.yml"))) {
-    public static void main(String[] args) {
+            app.setDefaultProperties(
-    	SpringApplication app = new SpringApplication(SPdfApplication.class);
+                    Collections.singletonMap(
-    	app.addInitializers(new ConfigInitializer());
+                            "spring.config.additional-location", "file:configs/settings.yml"));
-    	if (Files.exists(Paths.get("configs/settings.yml"))) {
+        } else {
-            app.setDefaultProperties(Collections.singletonMap("spring.config.additional-location", "file:configs/settings.yml"));
+            System.out.println(
-        } else {
+                    "External configuration file 'configs/settings.yml' does not exist. Using default configuration and environment configuration instead.");
-            System.out.println("External configuration file 'configs/settings.yml' does not exist. Using default configuration and environment configuration instead.");
+        }
-        }
+        app.run(args);
-        app.run(args);
+
-        
+        try {
-        try {
+            Thread.sleep(1000);
-			Thread.sleep(1000);
+        } catch (InterruptedException e) {
-		} catch (InterruptedException e) {
+            // TODO Auto-generated catch block
-			// TODO Auto-generated catch block
+            e.printStackTrace();
-			e.printStackTrace();
+        }
-		}
+
-        
+        GeneralUtils.createDir("customFiles/static/");
-        GeneralUtils.createDir("customFiles/static/");
+        GeneralUtils.createDir("customFiles/templates/");
-        GeneralUtils.createDir("customFiles/templates/");
+
-        
+        System.out.println("Stirling-PDF Started.");
-        
+
-        
+        String url = "http://localhost:" + getPort();
-        System.out.println("Stirling-PDF Started.");
+        System.out.println("Navigate to " + url);
-        
+    }
-        String port = System.getProperty("local.server.port");
+
-        if(port == null || port.length() == 0) {
+    public static String getPort() {
-        	port="8080";
+        String port = System.getProperty("local.server.port");
-        }
+        if (port == null || port.isEmpty()) {
-        String url = "http://localhost:" + port;
+            port = "8080";
-        System.out.println("Navigate to " + url);
+        }
-    }
+        return port;
-    
+    }
-    
+}
-}

src/main/java/stirling/software/SPDF/config/AppConfig.java

@@ -1,55 +1,81 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import org.springframework.beans.PropertyEditorRegistrar;
+import java.nio.file.Files;
-import org.springframework.beans.factory.annotation.Autowired;
+import java.nio.file.Paths;
-import org.springframework.context.annotation.Bean;
+
-import org.springframework.context.annotation.Configuration;
+import org.springframework.beans.factory.annotation.Autowired;
-
+import org.springframework.context.annotation.Bean;
-import stirling.software.SPDF.model.ApplicationProperties;
+import org.springframework.context.annotation.Configuration;
-@Configuration
+
-public class AppConfig {
+import stirling.software.SPDF.model.ApplicationProperties;
-
+
-    
+@Configuration
-    @Autowired
+public class AppConfig {
-    ApplicationProperties applicationProperties;
+
-    
+    @Autowired ApplicationProperties applicationProperties;
-    @Bean(name = "loginEnabled")
+
-    public boolean loginEnabled() {
+    @Bean(name = "loginEnabled")
-        return applicationProperties.getSecurity().getEnableLogin();
+    public boolean loginEnabled() {
-    }
+        return applicationProperties.getSecurity().getEnableLogin();
-
+    }
-    @Bean(name = "appName")
+
-    public String appName() {
+    @Bean(name = "appName")
-        String homeTitle =  applicationProperties.getUi().getAppName();
+    public String appName() {
-        return (homeTitle != null) ? homeTitle : "Stirling PDF";
+        String homeTitle = applicationProperties.getUi().getAppName();
-    }
+        return (homeTitle != null) ? homeTitle : "Stirling PDF";
-
+    }
-    @Bean(name = "appVersion")
+
-    public String appVersion() {
+    @Bean(name = "appVersion")
-        String version = getClass().getPackage().getImplementationVersion();
+    public String appVersion() {
-        return (version != null) ? version : "0.0.0";
+        String version = getClass().getPackage().getImplementationVersion();
-    }
+        return (version != null) ? version : "0.0.0";
-
+    }
-    @Bean(name = "homeText")
+
-    public String homeText() {
+    @Bean(name = "homeText")
-    	return (applicationProperties.getUi().getHomeDescription() != null) ? applicationProperties.getUi().getHomeDescription() : "null";
+    public String homeText() {
-    }
+        return (applicationProperties.getUi().getHomeDescription() != null)
-
+                ? applicationProperties.getUi().getHomeDescription()
-
+                : "null";
-    @Bean(name = "navBarText")
+    }
-    public String navBarText() {
+
-        String defaultNavBar = applicationProperties.getUi().getAppNameNavbar() != null ? applicationProperties.getUi().getAppNameNavbar() : applicationProperties.getUi().getAppName();
+    @Bean(name = "navBarText")
-        return (defaultNavBar != null) ? defaultNavBar : "Stirling PDF";
+    public String navBarText() {
-    }
+        String defaultNavBar =
-	
+                applicationProperties.getUi().getAppNameNavbar() != null
-	@Bean(name = "rateLimit")
+                        ? applicationProperties.getUi().getAppNameNavbar()
-    public boolean rateLimit() {
+                        : applicationProperties.getUi().getAppName();
-        String appName = System.getProperty("rateLimit");
+        return (defaultNavBar != null) ? defaultNavBar : "Stirling PDF";
-        if (appName == null) 
+    }
-            appName = System.getenv("rateLimit");
+
-        System.out.println("rateLimit=" + appName);
+    @Bean(name = "enableAlphaFunctionality")
-        return (appName != null) ? Boolean.valueOf(appName) : false;
+    public boolean enableAlphaFunctionality() {
-    }
+        return applicationProperties.getSystem().getEnableAlphaFunctionality() != null
-	
+                ? applicationProperties.getSystem().getEnableAlphaFunctionality()
-	
+                : false;
-}
+    }
+
+    @Bean(name = "rateLimit")
+    public boolean rateLimit() {
+        String appName = System.getProperty("rateLimit");
+        if (appName == null) appName = System.getenv("rateLimit");
+        return (appName != null) ? Boolean.valueOf(appName) : false;
+    }
+
+    @Bean(name = "RunningInDocker")
+    public boolean runningInDocker() {
+        return Files.exists(Paths.get("/.dockerenv"));
+    }
+
+    @Bean(name = "bookFormatsInstalled")
+    public boolean bookFormatsInstalled() {
+        return applicationProperties.getSystem().getCustomApplications().isInstallBookFormats();
+    }
+
+    @Bean(name = "htmlFormatsInstalled")
+    public boolean htmlFormatsInstalled() {
+        return applicationProperties
+                .getSystem()
+                .getCustomApplications()
+                .isInstallAdvancedHtmlToPDF();
+    }
+}

src/main/java/stirling/software/SPDF/config/Beans.java

@@ -1,65 +1,64 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import java.util.Locale;
+import java.util.Locale;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Configuration;
-import org.springframework.web.servlet.LocaleResolver;
+import org.springframework.web.servlet.LocaleResolver;
-import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
-import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
+import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
-import org.springframework.web.servlet.i18n.SessionLocaleResolver;
+import org.springframework.web.servlet.i18n.SessionLocaleResolver;
-
+
-import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.ApplicationProperties;
-
+
-@Configuration
+@Configuration
-public class Beans implements WebMvcConfigurer {
+public class Beans implements WebMvcConfigurer {
-	
+
-	@Autowired
+    @Autowired ApplicationProperties applicationProperties;
-    ApplicationProperties applicationProperties;
+
-	
+    @Override
-    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
-    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(localeChangeInterceptor());
-        registry.addInterceptor(localeChangeInterceptor());
+        registry.addInterceptor(new CleanUrlInterceptor());
-        registry.addInterceptor(new CleanUrlInterceptor());
+    }
-    }
+
-
+    @Bean
-    @Bean
+    public LocaleChangeInterceptor localeChangeInterceptor() {
-    public LocaleChangeInterceptor localeChangeInterceptor() {
+        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
-        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
+        lci.setParamName("lang");
-        lci.setParamName("lang");
+        return lci;
-        return lci;
+    }
-    }
+
-
+    @Bean
-    @Bean
+    public LocaleResolver localeResolver() {
-    public LocaleResolver localeResolver() {
+        SessionLocaleResolver slr = new SessionLocaleResolver();
-        SessionLocaleResolver slr = new SessionLocaleResolver();
+
-        
+        String appLocaleEnv = applicationProperties.getSystem().getDefaultLocale();
-        
+        Locale defaultLocale =
-        String appLocaleEnv = applicationProperties.getSystem().getDefaultLocale();
+                Locale.UK; // Fallback to UK locale if environment variable is not set
-        Locale defaultLocale = Locale.UK; // Fallback to UK locale if environment variable is not set
+
-
+        if (appLocaleEnv != null && !appLocaleEnv.isEmpty()) {
-        if (appLocaleEnv != null && !appLocaleEnv.isEmpty()) {
+            Locale tempLocale = Locale.forLanguageTag(appLocaleEnv);
-            Locale tempLocale = Locale.forLanguageTag(appLocaleEnv);
+            String tempLanguageTag = tempLocale.toLanguageTag();
-            String tempLanguageTag = tempLocale.toLanguageTag();
+
-
+            if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
-             if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
+                defaultLocale = tempLocale;
-                defaultLocale = tempLocale;
+            } else {
-            } else {
+                tempLocale = Locale.forLanguageTag(appLocaleEnv.replace("_", "-"));
-                tempLocale = Locale.forLanguageTag(appLocaleEnv.replace("_","-"));
+                tempLanguageTag = tempLocale.toLanguageTag();
-                tempLanguageTag = tempLocale.toLanguageTag();
+
-
+                if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
-                if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
+                    defaultLocale = tempLocale;
-                    defaultLocale = tempLocale;
+                } else {
-                } else {
+                    System.err.println(
-                    System.err.println("Invalid APP_LOCALE environment variable value. Falling back to default Locale.UK.");
+                            "Invalid APP_LOCALE environment variable value. Falling back to default Locale.UK.");
-                }
+                }
-            }
+            }
-        }
+        }
-
+
-        slr.setDefaultLocale(defaultLocale);
+        slr.setDefaultLocale(defaultLocale);
-        return slr;
+        return slr;
-    }
+    }
-    
+}
-}

src/main/java/stirling/software/SPDF/config/CleanUrlInterceptor.java

@@ -1,68 +1,74 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import java.util.Arrays;
+import java.util.Arrays;
-import java.util.HashMap;
+import java.util.HashMap;
-import java.util.List;
+import java.util.List;
-import java.util.Map;
+import java.util.Map;
-
+
-import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.HandlerInterceptor;
-import org.springframework.web.servlet.ModelAndView;
+import org.springframework.web.servlet.ModelAndView;
-
+
-import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletResponse;
-
+
-public class CleanUrlInterceptor implements HandlerInterceptor {
+public class CleanUrlInterceptor implements HandlerInterceptor {
-
+
-	private static final List<String> ALLOWED_PARAMS = Arrays.asList("lang", "endpoint", "endpoints", "logout", "error", "file", "messageType");
+    private static final List<String> ALLOWED_PARAMS =
-
+            Arrays.asList(
-	
+                    "lang", "endpoint", "endpoints", "logout", "error", "file", "messageType");
-	@Override
+
-	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
+    @Override
-			throws Exception {
+    public boolean preHandle(
-		String queryString = request.getQueryString();
+            HttpServletRequest request, HttpServletResponse response, Object handler)
-		if (queryString != null && !queryString.isEmpty()) {
+            throws Exception {
-			String requestURI = request.getRequestURI();
+        String queryString = request.getQueryString();
-			Map<String, String> parameters = new HashMap<>();
+        if (queryString != null && !queryString.isEmpty()) {
-
+            String requestURI = request.getRequestURI();
-			// Keep only the allowed parameters
+            Map<String, String> parameters = new HashMap<>();
-			String[] queryParameters = queryString.split("&");
+
-			for (String param : queryParameters) {
+            // Keep only the allowed parameters
-				String[] keyValue = param.split("=");
+            String[] queryParameters = queryString.split("&");
-				if (keyValue.length != 2) {
+            for (String param : queryParameters) {
-					continue;
+                String[] keyValue = param.split("=");
-				}
+                if (keyValue.length != 2) {
-				if (ALLOWED_PARAMS.contains(keyValue[0])) {
+                    continue;
-					parameters.put(keyValue[0], keyValue[1]);
+                }
-				}
+                if (ALLOWED_PARAMS.contains(keyValue[0])) {
-			}
+                    parameters.put(keyValue[0], keyValue[1]);
-
+                }
-			// If there are any parameters that are not allowed
+            }
-			if (parameters.size() != queryParameters.length) {
+
-				// Construct new query string
+            // If there are any parameters that are not allowed
-				StringBuilder newQueryString = new StringBuilder();
+            if (parameters.size() != queryParameters.length) {
-				for (Map.Entry<String, String> entry : parameters.entrySet()) {
+                // Construct new query string
-					if (newQueryString.length() > 0) {
+                StringBuilder newQueryString = new StringBuilder();
-						newQueryString.append("&");
+                for (Map.Entry<String, String> entry : parameters.entrySet()) {
-					}
+                    if (newQueryString.length() > 0) {
-					newQueryString.append(entry.getKey()).append("=").append(entry.getValue());
+                        newQueryString.append("&");
-				}
+                    }
-
+                    newQueryString.append(entry.getKey()).append("=").append(entry.getValue());
-				// Redirect to the URL with only allowed query parameters
+                }
-				String redirectUrl = requestURI + "?" + newQueryString;
+
-				response.sendRedirect(redirectUrl);
+                // Redirect to the URL with only allowed query parameters
-				return false;
+                String redirectUrl = requestURI + "?" + newQueryString;
-			}
+                response.sendRedirect(redirectUrl);
-		}
+                return false;
-		return true;
+            }
-	}
+        }
-
+        return true;
-	@Override
+    }
-	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
+
-			ModelAndView modelAndView) {
+    @Override
-	}
+    public void postHandle(
-
+            HttpServletRequest request,
-	@Override
+            HttpServletResponse response,
-	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
+            Object handler,
-			Exception ex) {
+            ModelAndView modelAndView) {}
-	}
+
-}
+    @Override
+    public void afterCompletion(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            Object handler,
+            Exception ex) {}
+}

src/main/java/stirling/software/SPDF/config/ConfigInitializer.java

@@ -19,111 +19,125 @@ import java.util.stream.Collectors;
 import org.springframework.context.ApplicationContextInitializer;
 import org.springframework.context.ConfigurableApplicationContext;
 
-public class ConfigInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+public class ConfigInitializer
+        implements ApplicationContextInitializer<ConfigurableApplicationContext> {
 
-	@Override
+    @Override
-	public void initialize(ConfigurableApplicationContext applicationContext) {
+    public void initialize(ConfigurableApplicationContext applicationContext) {
-		try {
+        try {
-			ensureConfigExists();
+            ensureConfigExists();
-		} catch (IOException e) {
+        } catch (IOException e) {
-			throw new RuntimeException("Failed to initialize application configuration", e);
+            throw new RuntimeException("Failed to initialize application configuration", e);
-		}
+        }
-	}
+    }
 
-	public void ensureConfigExists() throws IOException {
+    public void ensureConfigExists() throws IOException {
-		// Define the path to the external config directory
+        // Define the path to the external config directory
-		Path destPath = Paths.get("configs", "settings.yml");
+        Path destPath = Paths.get("configs", "settings.yml");
 
-		// Check if the file already exists
+        // Check if the file already exists
-		if (Files.notExists(destPath)) {
+        if (Files.notExists(destPath)) {
-			// Ensure the destination directory exists
+            // Ensure the destination directory exists
-			Files.createDirectories(destPath.getParent());
+            Files.createDirectories(destPath.getParent());
 
-			// Copy the resource from classpath to the external directory
+            // Copy the resource from classpath to the external directory
-			try (InputStream in = getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
+            try (InputStream in =
-				if (in != null) {
+                    getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
-					Files.copy(in, destPath);
+                if (in != null) {
-				} else {
+                    Files.copy(in, destPath);
-					throw new FileNotFoundException("Resource file not found: settings.yml.template");
+                } else {
-				}
+                    throw new FileNotFoundException(
-			}
+                            "Resource file not found: settings.yml.template");
-		} else {
+                }
-			// If user file exists, we need to merge it with the template from the classpath
+            }
-			List<String> templateLines;
+        } else {
-			try (InputStream in = getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
+            // If user file exists, we need to merge it with the template from the classpath
-				templateLines = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8)).lines()
+            List<String> templateLines;
-						.collect(Collectors.toList());
+            try (InputStream in =
-			}
+                    getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
+                templateLines =
+                        new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8))
+                                .lines()
+                                .collect(Collectors.toList());
+            }
 
-			mergeYamlFiles(templateLines, destPath, destPath);
+            mergeYamlFiles(templateLines, destPath, destPath);
-		}
+        }
-	}
+    }
 
-	public void mergeYamlFiles(List<String> templateLines, Path userFilePath, Path outputPath) throws IOException {
+    public void mergeYamlFiles(List<String> templateLines, Path userFilePath, Path outputPath)
-		List<String> userLines = Files.readAllLines(userFilePath);
+            throws IOException {
-		List<String> mergedLines = new ArrayList<>();
+        List<String> userLines = Files.readAllLines(userFilePath);
-		boolean insideAutoGenerated = false;
+        List<String> mergedLines = new ArrayList<>();
-		boolean beforeFirstKey = true;
+        boolean insideAutoGenerated = false;
+        boolean beforeFirstKey = true;
 
-		Function<String, Boolean> isCommented = line -> line.trim().startsWith("#");
+        Function<String, Boolean> isCommented = line -> line.trim().startsWith("#");
-		Function<String, String> extractKey = line -> {
+        Function<String, String> extractKey =
-			String[] parts = line.split(":");
+                line -> {
-			return parts.length > 0 ? parts[0].trim().replace("#", "").trim() : "";
+                    String[] parts = line.split(":");
-		};
+                    return parts.length > 0 ? parts[0].trim().replace("#", "").trim() : "";
+                };
 
-		Set<String> userKeys = userLines.stream().map(extractKey).collect(Collectors.toSet());
+        Set<String> userKeys = userLines.stream().map(extractKey).collect(Collectors.toSet());
 
-		for (String line : templateLines) {
+        for (String line : templateLines) {
-			String key = extractKey.apply(line);
+            String key = extractKey.apply(line);
 
-			if (line.trim().equalsIgnoreCase("AutomaticallyGenerated:")) {
+            if (line.trim().equalsIgnoreCase("AutomaticallyGenerated:")) {
-				insideAutoGenerated = true;
+                insideAutoGenerated = true;
-				mergedLines.add(line);
+                mergedLines.add(line);
-				continue;
+                continue;
-			} else if (insideAutoGenerated && line.trim().isEmpty()) {
+            } else if (insideAutoGenerated && line.trim().isEmpty()) {
-				insideAutoGenerated = false;
+                insideAutoGenerated = false;
-				mergedLines.add(line);
+                mergedLines.add(line);
-				continue;
+                continue;
-			}
+            }
 
-			if (beforeFirstKey && (isCommented.apply(line) || line.trim().isEmpty())) {
+            if (beforeFirstKey && (isCommented.apply(line) || line.trim().isEmpty())) {
-				// Handle top comments and empty lines before the first key.
+                // Handle top comments and empty lines before the first key.
-				mergedLines.add(line);
+                mergedLines.add(line);
-				continue;
+                continue;
-			}
+            }
 
-			if (!key.isEmpty())
+            if (!key.isEmpty()) beforeFirstKey = false;
-				beforeFirstKey = false;
 
-			if (userKeys.contains(key)) {
+            if (userKeys.contains(key)) {
-				// If user has any version (commented or uncommented) of this key, skip the
+                // If user has any version (commented or uncommented) of this key, skip the
-				// template line
+                // template line
-				Optional<String> userValue = userLines.stream()
+                Optional<String> userValue =
-						.filter(l -> extractKey.apply(l).equalsIgnoreCase(key) && !isCommented.apply(l)).findFirst();
+                        userLines.stream()
-				if (userValue.isPresent())
+                                .filter(
-					mergedLines.add(userValue.get());
+                                        l ->
-				continue;
+                                                extractKey.apply(l).equalsIgnoreCase(key)
-			}
+                                                        && !isCommented.apply(l))
+                                .findFirst();
+                if (userValue.isPresent()) mergedLines.add(userValue.get());
+                continue;
+            }
 
-			if (isCommented.apply(line) || line.trim().isEmpty() || !userKeys.contains(key)) {
+            if (isCommented.apply(line) || line.trim().isEmpty() || !userKeys.contains(key)) {
-				mergedLines.add(line); // If line is commented, empty or key not present in user's file, retain the
+                mergedLines.add(
-										// template line
+                        line); // If line is commented, empty or key not present in user's file,
-				continue;
+                // retain the
-			}
+                // template line
-		}
+                continue;
+            }
+        }
 
-		// Add any additional uncommented user lines that are not present in the
+        // Add any additional uncommented user lines that are not present in the
-		// template
+        // template
-		for (String userLine : userLines) {
+        for (String userLine : userLines) {
-			String userKey = extractKey.apply(userLine);
+            String userKey = extractKey.apply(userLine);
-			boolean isPresentInTemplate = templateLines.stream().map(extractKey)
+            boolean isPresentInTemplate =
-					.anyMatch(templateKey -> templateKey.equalsIgnoreCase(userKey));
+                    templateLines.stream()
-			if (!isPresentInTemplate && !isCommented.apply(userLine)) {
+                            .map(extractKey)
-				mergedLines.add(userLine);
+                            .anyMatch(templateKey -> templateKey.equalsIgnoreCase(userKey));
-			}
+            if (!isPresentInTemplate && !isCommented.apply(userLine)) {
-		}
+                mergedLines.add(userLine);
+            }
+        }
 
-		Files.write(outputPath, mergedLines, StandardCharsets.UTF_8);
+        Files.write(outputPath, mergedLines, StandardCharsets.UTF_8);
-	}
+    }
-
+}
-}

src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java

@@ -1,228 +1,247 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import java.util.HashSet;
+import java.util.HashSet;
-import java.util.List;
+import java.util.List;
-import java.util.Map;
+import java.util.Map;
-import java.util.Set;
+import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentHashMap;
-
+
-import org.slf4j.Logger;
+import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Service;
+import org.springframework.beans.factory.annotation.Qualifier;
-
+import org.springframework.context.annotation.DependsOn;
-import stirling.software.SPDF.model.ApplicationProperties;
+import org.springframework.stereotype.Service;
-@Service
+
-public class EndpointConfiguration {
+import stirling.software.SPDF.model.ApplicationProperties;
-    private static final Logger logger = LoggerFactory.getLogger(EndpointConfiguration.class);
+
-    private Map<String, Boolean> endpointStatuses = new ConcurrentHashMap<>();
+@Service
-    private Map<String, Set<String>> endpointGroups = new ConcurrentHashMap<>();
+@DependsOn({"bookFormatsInstalled"})
-
+public class EndpointConfiguration {
-    private final ApplicationProperties applicationProperties;
+    private static final Logger logger = LoggerFactory.getLogger(EndpointConfiguration.class);
-
+    private Map<String, Boolean> endpointStatuses = new ConcurrentHashMap<>();
-    @Autowired
+    private Map<String, Set<String>> endpointGroups = new ConcurrentHashMap<>();
-    public EndpointConfiguration(ApplicationProperties applicationProperties) {
+
-        this.applicationProperties = applicationProperties;
+    private final ApplicationProperties applicationProperties;
-        init();
+
-        processEnvironmentConfigs();
+    private boolean bookFormatsInstalled;
-    }
+
-    
+    @Autowired
-    public void enableEndpoint(String endpoint) {
+    public EndpointConfiguration(
-    	endpointStatuses.put(endpoint, true);
+            ApplicationProperties applicationProperties,
-    }
+            @Qualifier("bookFormatsInstalled") boolean bookFormatsInstalled) {
-
+        this.applicationProperties = applicationProperties;
-    public void disableEndpoint(String endpoint) {
+        this.bookFormatsInstalled = bookFormatsInstalled;
-    	if(!endpointStatuses.containsKey(endpoint) || endpointStatuses.get(endpoint) !=  false) {
+        init();
-	        logger.info("Disabling {}", endpoint);
+        processEnvironmentConfigs();
-	        endpointStatuses.put(endpoint, false);
+    }
-    	}
+
-    }
+    public void enableEndpoint(String endpoint) {
-
+        endpointStatuses.put(endpoint, true);
-    public boolean isEndpointEnabled(String endpoint) {
+    }
-        if (endpoint.startsWith("/")) {
+
-            endpoint = endpoint.substring(1);
+    public void disableEndpoint(String endpoint) {
-        }
+        if (!endpointStatuses.containsKey(endpoint) || endpointStatuses.get(endpoint) != false) {
-        return endpointStatuses.getOrDefault(endpoint, true);
+            logger.info("Disabling {}", endpoint);
-    }
+            endpointStatuses.put(endpoint, false);
-
+        }
-    public void addEndpointToGroup(String group, String endpoint) {
+    }
-        endpointGroups.computeIfAbsent(group, k -> new HashSet<>()).add(endpoint);
+
-    }
+    public boolean isEndpointEnabled(String endpoint) {
-
+        if (endpoint.startsWith("/")) {
-    public void enableGroup(String group) {
+            endpoint = endpoint.substring(1);
-        Set<String> endpoints = endpointGroups.get(group);
+        }
-        if (endpoints != null) {
+        return endpointStatuses.getOrDefault(endpoint, true);
-            for (String endpoint : endpoints) {
+    }
-                enableEndpoint(endpoint);
+
-            }
+    public void addEndpointToGroup(String group, String endpoint) {
-        }
+        endpointGroups.computeIfAbsent(group, k -> new HashSet<>()).add(endpoint);
-    }
+    }
-
+
-    public void disableGroup(String group) {
+    public void enableGroup(String group) {
-        Set<String> endpoints = endpointGroups.get(group);
+        Set<String> endpoints = endpointGroups.get(group);
-        if (endpoints != null) {
+        if (endpoints != null) {
-            for (String endpoint : endpoints) {
+            for (String endpoint : endpoints) {
-                disableEndpoint(endpoint);
+                enableEndpoint(endpoint);
-            }
+            }
-        }
+        }
-    }
+    }
-    
+
-    public void init() {
+    public void disableGroup(String group) {
-        // Adding endpoints to "PageOps" group
+        Set<String> endpoints = endpointGroups.get(group);
-        addEndpointToGroup("PageOps", "remove-pages");
+        if (endpoints != null) {
-        addEndpointToGroup("PageOps", "merge-pdfs");
+            for (String endpoint : endpoints) {
-        addEndpointToGroup("PageOps", "split-pdfs");
+                disableEndpoint(endpoint);
-        addEndpointToGroup("PageOps", "pdf-organizer");
+            }
-        addEndpointToGroup("PageOps", "rotate-pdf");
+        }
-        addEndpointToGroup("PageOps", "multi-page-layout");
+    }
-        addEndpointToGroup("PageOps", "scale-pages");
+
-        addEndpointToGroup("PageOps", "adjust-contrast");
+    public void init() {
-        addEndpointToGroup("PageOps", "crop");
+        // Adding endpoints to "PageOps" group
-        addEndpointToGroup("PageOps", "auto-split-pdf");
+        addEndpointToGroup("PageOps", "remove-pages");
-        addEndpointToGroup("PageOps", "extract-page");
+        addEndpointToGroup("PageOps", "merge-pdfs");
-        addEndpointToGroup("PageOps", "pdf-to-single-page");
+        addEndpointToGroup("PageOps", "split-pdfs");
-        
+        addEndpointToGroup("PageOps", "pdf-organizer");
-        // Adding endpoints to "Convert" group
+        addEndpointToGroup("PageOps", "rotate-pdf");
-        addEndpointToGroup("Convert", "pdf-to-img");
+        addEndpointToGroup("PageOps", "multi-page-layout");
-        addEndpointToGroup("Convert", "img-to-pdf");
+        addEndpointToGroup("PageOps", "scale-pages");
-        addEndpointToGroup("Convert", "pdf-to-pdfa");
+        addEndpointToGroup("PageOps", "adjust-contrast");
-        addEndpointToGroup("Convert", "file-to-pdf");
+        addEndpointToGroup("PageOps", "crop");
-        addEndpointToGroup("Convert", "xlsx-to-pdf");
+        addEndpointToGroup("PageOps", "auto-split-pdf");
-        addEndpointToGroup("Convert", "pdf-to-word");
+        addEndpointToGroup("PageOps", "extract-page");
-        addEndpointToGroup("Convert", "pdf-to-presentation");
+        addEndpointToGroup("PageOps", "pdf-to-single-page");
-        addEndpointToGroup("Convert", "pdf-to-text");
+        addEndpointToGroup("PageOps", "split-by-size-or-count");
-        addEndpointToGroup("Convert", "pdf-to-html");
+        addEndpointToGroup("PageOps", "overlay-pdf");
-        addEndpointToGroup("Convert", "pdf-to-xml");
+        addEndpointToGroup("PageOps", "split-pdf-by-sections");
-        addEndpointToGroup("Convert", "html-to-pdf");
+
-        addEndpointToGroup("Convert", "url-to-pdf");
+        // Adding endpoints to "Convert" group
-        addEndpointToGroup("Convert", "markdown-to-pdf");
+        addEndpointToGroup("Convert", "pdf-to-img");
-        
+        addEndpointToGroup("Convert", "img-to-pdf");
-        // Adding endpoints to "Security" group
+        addEndpointToGroup("Convert", "pdf-to-pdfa");
-        addEndpointToGroup("Security", "add-password");
+        addEndpointToGroup("Convert", "file-to-pdf");
-        addEndpointToGroup("Security", "remove-password");
+        addEndpointToGroup("Convert", "xlsx-to-pdf");
-        addEndpointToGroup("Security", "change-permissions");
+        addEndpointToGroup("Convert", "pdf-to-word");
-        addEndpointToGroup("Security", "add-watermark");
+        addEndpointToGroup("Convert", "pdf-to-presentation");
-        addEndpointToGroup("Security", "cert-sign");
+        addEndpointToGroup("Convert", "pdf-to-text");
-        addEndpointToGroup("Security", "sanitize-pdf");
+        addEndpointToGroup("Convert", "pdf-to-html");
-        
+        addEndpointToGroup("Convert", "pdf-to-xml");
-        
+        addEndpointToGroup("Convert", "html-to-pdf");
-        // Adding endpoints to "Other" group
+        addEndpointToGroup("Convert", "url-to-pdf");
-        addEndpointToGroup("Other", "ocr-pdf");
+        addEndpointToGroup("Convert", "markdown-to-pdf");
-        addEndpointToGroup("Other", "add-image");
+        addEndpointToGroup("Convert", "pdf-to-csv");
-        addEndpointToGroup("Other", "compress-pdf");
+
-        addEndpointToGroup("Other", "extract-images");
+        // Adding endpoints to "Security" group
-        addEndpointToGroup("Other", "change-metadata");
+        addEndpointToGroup("Security", "add-password");
-        addEndpointToGroup("Other", "extract-image-scans");
+        addEndpointToGroup("Security", "remove-password");
-        addEndpointToGroup("Other", "sign");
+        addEndpointToGroup("Security", "change-permissions");
-        addEndpointToGroup("Other", "flatten");
+        addEndpointToGroup("Security", "add-watermark");
-        addEndpointToGroup("Other", "repair");
+        addEndpointToGroup("Security", "cert-sign");
-        addEndpointToGroup("Other", "remove-blanks");
+        addEndpointToGroup("Security", "sanitize-pdf");
-        addEndpointToGroup("Other", "compare");
+        addEndpointToGroup("Security", "auto-redact");
-        addEndpointToGroup("Other", "add-page-numbers");
+
-        addEndpointToGroup("Other", "auto-rename");
+        // Adding endpoints to "Other" group
-        addEndpointToGroup("Other", "get-info-on-pdf");
+        addEndpointToGroup("Other", "ocr-pdf");
-        addEndpointToGroup("Other", "show-javascript");
+        addEndpointToGroup("Other", "add-image");
-        
+        addEndpointToGroup("Other", "compress-pdf");
-        
+        addEndpointToGroup("Other", "extract-images");
-        
+        addEndpointToGroup("Other", "change-metadata");
-        //CLI
+        addEndpointToGroup("Other", "extract-image-scans");
-        addEndpointToGroup("CLI", "compress-pdf");
+        addEndpointToGroup("Other", "sign");
-        addEndpointToGroup("CLI", "extract-image-scans");
+        addEndpointToGroup("Other", "flatten");
-        addEndpointToGroup("CLI", "remove-blanks");
+        addEndpointToGroup("Other", "repair");
-        addEndpointToGroup("CLI", "repair");
+        addEndpointToGroup("Other", "remove-blanks");
-        addEndpointToGroup("CLI", "pdf-to-pdfa");
+        addEndpointToGroup("Other", "remove-annotations");
-        addEndpointToGroup("CLI", "file-to-pdf");
+        addEndpointToGroup("Other", "compare");
-        addEndpointToGroup("CLI", "xlsx-to-pdf");
+        addEndpointToGroup("Other", "add-page-numbers");
-        addEndpointToGroup("CLI", "pdf-to-word");
+        addEndpointToGroup("Other", "auto-rename");
-        addEndpointToGroup("CLI", "pdf-to-presentation");
+        addEndpointToGroup("Other", "get-info-on-pdf");
-        addEndpointToGroup("CLI", "pdf-to-text");
+        addEndpointToGroup("Other", "show-javascript");
-        addEndpointToGroup("CLI", "pdf-to-html");
+
-        addEndpointToGroup("CLI", "pdf-to-xml");
+        // CLI
-        addEndpointToGroup("CLI", "ocr-pdf");
+        addEndpointToGroup("CLI", "compress-pdf");
-        addEndpointToGroup("CLI", "html-to-pdf");
+        addEndpointToGroup("CLI", "extract-image-scans");
-        addEndpointToGroup("CLI", "url-to-pdf");
+        addEndpointToGroup("CLI", "remove-blanks");
-        
+        addEndpointToGroup("CLI", "repair");
-        
+        addEndpointToGroup("CLI", "pdf-to-pdfa");
-        //python
+        addEndpointToGroup("CLI", "file-to-pdf");
-        addEndpointToGroup("Python", "extract-image-scans");
+        addEndpointToGroup("CLI", "xlsx-to-pdf");
-        addEndpointToGroup("Python", "remove-blanks");
+        addEndpointToGroup("CLI", "pdf-to-word");
-        addEndpointToGroup("Python", "html-to-pdf");
+        addEndpointToGroup("CLI", "pdf-to-presentation");
-        addEndpointToGroup("Python", "url-to-pdf");
+        addEndpointToGroup("CLI", "pdf-to-text");
-        
+        addEndpointToGroup("CLI", "pdf-to-html");
-        //openCV
+        addEndpointToGroup("CLI", "pdf-to-xml");
-        addEndpointToGroup("OpenCV", "extract-image-scans");
+        addEndpointToGroup("CLI", "ocr-pdf");
-        addEndpointToGroup("OpenCV", "remove-blanks");
+        addEndpointToGroup("CLI", "html-to-pdf");
-
+        addEndpointToGroup("CLI", "url-to-pdf");
-        //LibreOffice
+        addEndpointToGroup("CLI", "book-to-pdf");
-        addEndpointToGroup("LibreOffice", "repair");
+        addEndpointToGroup("CLI", "pdf-to-book");
-        addEndpointToGroup("LibreOffice", "file-to-pdf");
+
-        addEndpointToGroup("LibreOffice", "xlsx-to-pdf");
+        // Calibre
-        addEndpointToGroup("LibreOffice", "pdf-to-word");
+        addEndpointToGroup("Calibre", "book-to-pdf");
-        addEndpointToGroup("LibreOffice", "pdf-to-presentation");
+        addEndpointToGroup("Calibre", "pdf-to-book");
-        addEndpointToGroup("LibreOffice", "pdf-to-text");
+
-        addEndpointToGroup("LibreOffice", "pdf-to-html");
+        // python
-        addEndpointToGroup("LibreOffice", "pdf-to-xml");
+        addEndpointToGroup("Python", "extract-image-scans");
-        
+        addEndpointToGroup("Python", "remove-blanks");
-        
+        addEndpointToGroup("Python", "html-to-pdf");
-        //OCRmyPDF
+        addEndpointToGroup("Python", "url-to-pdf");
-        addEndpointToGroup("OCRmyPDF", "compress-pdf");
+
-        addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa");
+        // openCV
-        addEndpointToGroup("OCRmyPDF", "ocr-pdf");
+        addEndpointToGroup("OpenCV", "extract-image-scans");
-        
+        addEndpointToGroup("OpenCV", "remove-blanks");
-        //Java
+
-        addEndpointToGroup("Java", "merge-pdfs");
+        // LibreOffice
-        addEndpointToGroup("Java", "remove-pages");
+        addEndpointToGroup("LibreOffice", "repair");
-        addEndpointToGroup("Java", "split-pdfs");
+        addEndpointToGroup("LibreOffice", "file-to-pdf");
-        addEndpointToGroup("Java", "pdf-organizer");
+        addEndpointToGroup("LibreOffice", "xlsx-to-pdf");
-        addEndpointToGroup("Java", "rotate-pdf");
+        addEndpointToGroup("LibreOffice", "pdf-to-word");
-        addEndpointToGroup("Java", "pdf-to-img");
+        addEndpointToGroup("LibreOffice", "pdf-to-presentation");
-        addEndpointToGroup("Java", "img-to-pdf");
+        addEndpointToGroup("LibreOffice", "pdf-to-text");
-        addEndpointToGroup("Java", "add-password");
+        addEndpointToGroup("LibreOffice", "pdf-to-html");
-        addEndpointToGroup("Java", "remove-password");
+        addEndpointToGroup("LibreOffice", "pdf-to-xml");
-        addEndpointToGroup("Java", "change-permissions");
+
-        addEndpointToGroup("Java", "add-watermark");
+        // OCRmyPDF
-        addEndpointToGroup("Java", "add-image");
+        addEndpointToGroup("OCRmyPDF", "compress-pdf");
-        addEndpointToGroup("Java", "extract-images");
+        addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa");
-        addEndpointToGroup("Java", "change-metadata");
+        addEndpointToGroup("OCRmyPDF", "ocr-pdf");
-        addEndpointToGroup("Java", "cert-sign");
+
-        addEndpointToGroup("Java", "multi-page-layout");
+        // Java
-        addEndpointToGroup("Java", "scale-pages");
+        addEndpointToGroup("Java", "merge-pdfs");
-        addEndpointToGroup("Java", "add-page-numbers");
+        addEndpointToGroup("Java", "remove-pages");
-        addEndpointToGroup("Java", "auto-rename");
+        addEndpointToGroup("Java", "split-pdfs");
-        addEndpointToGroup("Java", "auto-split-pdf");
+        addEndpointToGroup("Java", "pdf-organizer");
-        addEndpointToGroup("Java", "sanitize-pdf");
+        addEndpointToGroup("Java", "rotate-pdf");
-        addEndpointToGroup("Java", "crop");
+        addEndpointToGroup("Java", "pdf-to-img");
-        addEndpointToGroup("Java", "get-info-on-pdf");
+        addEndpointToGroup("Java", "img-to-pdf");
-        addEndpointToGroup("Java", "extract-page");
+        addEndpointToGroup("Java", "add-password");
-        addEndpointToGroup("Java", "pdf-to-single-page");
+        addEndpointToGroup("Java", "remove-password");
-        addEndpointToGroup("Java", "markdown-to-pdf");
+        addEndpointToGroup("Java", "change-permissions");
-        addEndpointToGroup("Java", "show-javascript");
+        addEndpointToGroup("Java", "add-watermark");
-        
+        addEndpointToGroup("Java", "add-image");
-        //Javascript
+        addEndpointToGroup("Java", "extract-images");
-        addEndpointToGroup("Javascript", "pdf-organizer");
+        addEndpointToGroup("Java", "change-metadata");
-        addEndpointToGroup("Javascript", "sign");
+        addEndpointToGroup("Java", "cert-sign");
-        addEndpointToGroup("Javascript", "compare");
+        addEndpointToGroup("Java", "multi-page-layout");
-        addEndpointToGroup("Javascript", "adjust-contrast");
+        addEndpointToGroup("Java", "scale-pages");
-        
+        addEndpointToGroup("Java", "add-page-numbers");
-        
+        addEndpointToGroup("Java", "auto-rename");
-    }
+        addEndpointToGroup("Java", "auto-split-pdf");
-    
+        addEndpointToGroup("Java", "sanitize-pdf");
-    private void processEnvironmentConfigs() {
+        addEndpointToGroup("Java", "crop");
-        List<String> endpointsToRemove = applicationProperties.getEndpoints().getToRemove();
+        addEndpointToGroup("Java", "get-info-on-pdf");
-        List<String> groupsToRemove = applicationProperties.getEndpoints().getGroupsToRemove();
+        addEndpointToGroup("Java", "extract-page");
-
+        addEndpointToGroup("Java", "pdf-to-single-page");
-        if (endpointsToRemove != null) {
+        addEndpointToGroup("Java", "markdown-to-pdf");
-            for (String endpoint : endpointsToRemove) {
+        addEndpointToGroup("Java", "show-javascript");
-                disableEndpoint(endpoint.trim());
+        addEndpointToGroup("Java", "auto-redact");
-            }
+        addEndpointToGroup("Java", "pdf-to-csv");
-        }
+        addEndpointToGroup("Java", "split-by-size-or-count");
-
+        addEndpointToGroup("Java", "overlay-pdf");
-        if (groupsToRemove != null) {
+        addEndpointToGroup("Java", "split-pdf-by-sections");
-            for (String group : groupsToRemove) {
+
-                disableGroup(group.trim());
+        // Javascript
-            }
+        addEndpointToGroup("Javascript", "pdf-organizer");
-        }
+        addEndpointToGroup("Javascript", "sign");
-    }
+        addEndpointToGroup("Javascript", "compare");
-
+        addEndpointToGroup("Javascript", "adjust-contrast");
-}
+    }
-
+
+    private void processEnvironmentConfigs() {
+        List<String> endpointsToRemove = applicationProperties.getEndpoints().getToRemove();
+        List<String> groupsToRemove = applicationProperties.getEndpoints().getGroupsToRemove();
+        if (!bookFormatsInstalled) {
+            groupsToRemove.add("Calibre");
+        }
+        if (endpointsToRemove != null) {
+            for (String endpoint : endpointsToRemove) {
+                disableEndpoint(endpoint.trim());
+            }
+        }
+
+        if (groupsToRemove != null) {
+            for (String group : groupsToRemove) {
+                disableGroup(group.trim());
+            }
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java

@@ -1,26 +1,26 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Component;
-import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.HandlerInterceptor;
-
+
-import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletResponse;
-
+
-@Component
+@Component
-public class EndpointInterceptor implements HandlerInterceptor {
+public class EndpointInterceptor implements HandlerInterceptor {
-
+
-    @Autowired
+    @Autowired private EndpointConfiguration endpointConfiguration;
-    private EndpointConfiguration endpointConfiguration;
+
-
+    @Override
-    @Override
+    public boolean preHandle(
-    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
+            HttpServletRequest request, HttpServletResponse response, Object handler)
-            throws Exception {
+            throws Exception {
-        String requestURI = request.getRequestURI();
+        String requestURI = request.getRequestURI();
-        if (!endpointConfiguration.isEndpointEnabled(requestURI)) {
+        if (!endpointConfiguration.isEndpointEnabled(requestURI)) {
-            response.sendError(HttpServletResponse.SC_FORBIDDEN, "This endpoint is disabled");
+            response.sendError(HttpServletResponse.SC_FORBIDDEN, "This endpoint is disabled");
-            return false;
+            return false;
-        }
+        }
-        return true;
+        return true;
-    }
+    }
-}
+}

src/main/java/stirling/software/SPDF/config/MetricsConfig.java

@@ -1,24 +1,25 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-import org.springframework.context.annotation.Bean;
+
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Bean;
-
+import org.springframework.context.annotation.Configuration;
-import io.micrometer.core.instrument.Meter;
+
-import io.micrometer.core.instrument.config.MeterFilter;
+import io.micrometer.core.instrument.Meter;
-import io.micrometer.core.instrument.config.MeterFilterReply;
+import io.micrometer.core.instrument.config.MeterFilter;
-
+import io.micrometer.core.instrument.config.MeterFilterReply;
-@Configuration
+
-public class MetricsConfig {
+@Configuration
-
+public class MetricsConfig {
-    @Bean
+
-    public MeterFilter meterFilter() {
+    @Bean
-        return new MeterFilter() {
+    public MeterFilter meterFilter() {
-            @Override
+        return new MeterFilter() {
-            public MeterFilterReply accept(Meter.Id id) {
+            @Override
-                if (id.getName().equals("http.requests")) {
+            public MeterFilterReply accept(Meter.Id id) {
-                    return MeterFilterReply.NEUTRAL;
+                if (id.getName().equals("http.requests")) {
-                }
+                    return MeterFilterReply.NEUTRAL;
-                return MeterFilterReply.DENY;
+                }
-            }
+                return MeterFilterReply.DENY;
-        };
+            }
-    }
+        };
-}
+    }
+}

src/main/java/stirling/software/SPDF/config/MetricsFilter.java

@@ -1,48 +1,64 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import java.io.IOException;
+import java.io.IOException;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Component;
-import org.springframework.web.filter.OncePerRequestFilter;
+import org.springframework.web.filter.OncePerRequestFilter;
-
+
-import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.Counter;
-import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.MeterRegistry;
-import jakarta.servlet.FilterChain;
+
-import jakarta.servlet.ServletException;
+import jakarta.servlet.FilterChain;
-import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.ServletException;
-import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
-
+import jakarta.servlet.http.HttpServletResponse;
-@Component
+
-public class MetricsFilter extends OncePerRequestFilter {
+@Component
-
+public class MetricsFilter extends OncePerRequestFilter {
-    private final MeterRegistry meterRegistry;
+
-
+    private final MeterRegistry meterRegistry;
-    @Autowired
+
-    public MetricsFilter(MeterRegistry meterRegistry) {
+    @Autowired
-        this.meterRegistry = meterRegistry;
+    public MetricsFilter(MeterRegistry meterRegistry) {
-    }
+        this.meterRegistry = meterRegistry;
-
+    }
-    @Override
+
-    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+    @Override
-            throws ServletException, IOException {
+    protected void doFilterInternal(
-        String uri = request.getRequestURI();
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
-        
+            throws ServletException, IOException {
-        //System.out.println("uri="+uri + ", method=" + request.getMethod() );
+        String uri = request.getRequestURI();
-        // Ignore static resources
+
-        if (!(uri.startsWith("/js") || uri.startsWith("api-docs") || uri.endsWith("robots.txt") || uri.startsWith("/images") || uri.endsWith(".png") || uri.endsWith(".ico") || uri.endsWith(".css") || uri.endsWith(".svg")|| uri.endsWith(".js") || uri.contains("swagger") || uri.startsWith("/api"))) {
+        // System.out.println("uri="+uri + ", method=" + request.getMethod() );
-            Counter counter = Counter.builder("http.requests")
+        // Ignore static resources
-                    .tag("uri", uri)
+        if (!(uri.startsWith("/js")
-                    .tag("method", request.getMethod())
+                || uri.startsWith("/v1/api-docs")
-                    .register(meterRegistry);
+                || uri.endsWith("robots.txt")
-
+                || uri.startsWith("/images")
-            counter.increment();
+                || uri.startsWith("/images")
-            //System.out.println("Counted");
+                || uri.endsWith(".png")
-        }
+                || uri.endsWith(".ico")
-
+                || uri.endsWith(".css")
-        filterChain.doFilter(request, response);
+                || uri.endsWith(".map")
-    }
+                || uri.endsWith(".svg")
-
+                || uri.endsWith(".js")
-    
+                || uri.contains("swagger")
-
+                || uri.startsWith("/api/v1/info")
-}
+                || uri.startsWith("/site.webmanifest")
+                || uri.startsWith("/fonts")
+                || uri.startsWith("/pdfjs"))) {
+
+            Counter counter =
+                    Counter.builder("http.requests")
+                            .tag("uri", uri)
+                            .tag("method", request.getMethod())
+                            .register(meterRegistry);
+
+            counter.increment();
+            // System.out.println("Counted");
+        }
+
+        filterChain.doFilter(request, response);
+    }
+}

src/main/java/stirling/software/SPDF/config/OpenApiConfig.java

@@ -1,27 +1,53 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import org.springframework.context.annotation.Bean;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Bean;
-
+import org.springframework.context.annotation.Configuration;
-import io.swagger.v3.oas.models.Components;
+
-import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Components;
-import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.OpenAPI;
-
+import io.swagger.v3.oas.models.info.Info;
-@Configuration
+import io.swagger.v3.oas.models.security.SecurityRequirement;
-public class OpenApiConfig {
+import io.swagger.v3.oas.models.security.SecurityScheme;
-
+
-	@Bean
+import stirling.software.SPDF.model.ApplicationProperties;
-	public OpenAPI customOpenAPI() {
+
-	    String version = getClass().getPackage().getImplementationVersion();
+@Configuration
-	    if (version == null) {
+public class OpenApiConfig {
-	        
+
-	            version = "1.0.0"; // default version if all else fails
+    @Autowired ApplicationProperties applicationProperties;
-	        
+
-	    }
+    @Bean
-
+    public OpenAPI customOpenAPI() {
-	    return new OpenAPI().components(new Components()).info(
+        String version = getClass().getPackage().getImplementationVersion();
-	            new Info().title("Stirling PDF API").version(version).description("API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."));
+        if (version == null) {
-	}
+            version = "1.0.0"; // default version if all else fails
-
+        }
-
+
-}
+        SecurityScheme apiKeyScheme =
+                new SecurityScheme()
+                        .type(SecurityScheme.Type.APIKEY)
+                        .in(SecurityScheme.In.HEADER)
+                        .name("X-API-KEY");
+        if (!applicationProperties.getSecurity().getEnableLogin()) {
+            return new OpenAPI()
+                    .components(new Components())
+                    .info(
+                            new Info()
+                                    .title("Stirling PDF API")
+                                    .version(version)
+                                    .description(
+                                            "API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."));
+        } else {
+            return new OpenAPI()
+                    .components(new Components().addSecuritySchemes("apiKey", apiKeyScheme))
+                    .info(
+                            new Info()
+                                    .title("Stirling PDF API")
+                                    .version(version)
+                                    .description(
+                                            "API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."))
+                    .addSecurityItem(new SecurityRequirement().addList("apiKey"));
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/PostStartupProcesses.java

@@ -0,0 +1,98 @@
+package stirling.software.SPDF.config;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Component;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.utils.ProcessExecutor;
+import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
+
+@Component
+public class PostStartupProcesses {
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    @Autowired
+    @Qualifier("RunningInDocker")
+    private boolean runningInDocker;
+
+    @Autowired
+    @Qualifier("bookFormatsInstalled")
+    private boolean bookFormatsInstalled;
+
+    @Autowired
+    @Qualifier("htmlFormatsInstalled")
+    private boolean htmlFormatsInstalled;
+
+    private static final Logger logger = LoggerFactory.getLogger(PostStartupProcesses.class);
+
+    @PostConstruct
+    public void runInstallCommandBasedOnEnvironment() throws IOException, InterruptedException {
+        List<List<String>> commands = new ArrayList<>();
+        // Checking for DOCKER_INSTALL_BOOK_FORMATS environment variable
+        if (bookFormatsInstalled) {
+            List<String> tmpList = new ArrayList<>();
+            // Set up the timezone configuration commands
+            tmpList.addAll(
+                    Arrays.asList(
+                            "sh",
+                            "-c",
+                            "echo 'tzdata tzdata/Areas select Europe' | debconf-set-selections; "
+                                    + "echo 'tzdata tzdata/Zones/Europe select Berlin' | debconf-set-selections"));
+            commands.add(tmpList);
+
+            // Install calibre with DEBIAN_FRONTEND set to noninteractive
+            tmpList = new ArrayList<>();
+            tmpList.addAll(
+                    Arrays.asList(
+                            "sh",
+                            "-c",
+                            "DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends calibre"));
+            commands.add(tmpList);
+        }
+
+        // Checking for DOCKER_INSTALL_HTML_FORMATS environment variable
+        if (htmlFormatsInstalled) {
+            List<String> tmpList = new ArrayList<>();
+            // Add -y flag for automatic yes to prompts and --no-install-recommends to reduce size
+            tmpList.addAll(
+                    Arrays.asList(
+                            "apt-get", "install", "wkhtmltopdf", "-y", "--no-install-recommends"));
+            commands.add(tmpList);
+        }
+
+        if (!commands.isEmpty()) {
+            // Run the command
+            if (runningInDocker) {
+                List<String> tmpList = new ArrayList<>();
+                tmpList.addAll(Arrays.asList("apt-get", "update"));
+                commands.add(0, tmpList);
+
+                for (List<String> list : commands) {
+                    ProcessExecutorResult returnCode =
+                            ProcessExecutor.getInstance(ProcessExecutor.Processes.INSTALL_APP, true)
+                                    .runCommandWithOutputHandling(list);
+                    logger.info("RC for app installs {}", returnCode.getRc());
+                }
+            } else {
+
+                logger.info(
+                        "Not running inside Docker so skipping automated install process with command.");
+            }
+
+        } else {
+            if (runningInDocker) {
+                logger.info("No custom apps to install.");
+            }
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/StartupApplicationListener.java

@@ -1,20 +1,18 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-
+import java.time.LocalDateTime;
-import java.time.LocalDateTime;
+
-
+import org.springframework.context.ApplicationListener;
-import org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextRefreshedEvent;
-import org.springframework.context.event.ContextRefreshedEvent;
+import org.springframework.stereotype.Component;
-import org.springframework.stereotype.Component;
+
-
+@Component
-@Component
+public class StartupApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
-public class StartupApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
+
-
+    public static LocalDateTime startTime;
-    public static LocalDateTime startTime;
+
-
+    @Override
-    @Override
+    public void onApplicationEvent(ContextRefreshedEvent event) {
-    public void onApplicationEvent(ContextRefreshedEvent event) {
+        startTime = LocalDateTime.now();
-        startTime = LocalDateTime.now();
+    }
-    }
+}
-}
- 

src/main/java/stirling/software/SPDF/config/WebMvcConfig.java

@@ -1,27 +1,26 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Configuration;
-import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
-import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
-import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-
+
-@Configuration
+@Configuration
-public class WebMvcConfig implements WebMvcConfigurer {
+public class WebMvcConfig implements WebMvcConfigurer {
-
+
-    @Autowired
+    @Autowired private EndpointInterceptor endpointInterceptor;
-    private EndpointInterceptor endpointInterceptor;
+
-
+    @Override
-    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
-    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(endpointInterceptor);
-        registry.addInterceptor(endpointInterceptor);
+    }
-    }
+
-    
+    @Override
-    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
-    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        // Handler for external static resources
-        // Handler for external static resources
+        registry.addResourceHandler("/**")
-        registry.addResourceHandler("/**")
+                .addResourceLocations("file:customFiles/static/", "classpath:/static/");
-                .addResourceLocations("file:customFiles/static/", "classpath:/static/");
+        // .setCachePeriod(0); // Optional: disable caching
-                //.setCachePeriod(0); // Optional: disable caching
+    }
-    }
+}
-}

src/main/java/stirling/software/SPDF/config/YamlPropertySourceFactory.java

@@ -8,16 +8,18 @@ import org.springframework.core.env.PropertiesPropertySource;
 import org.springframework.core.env.PropertySource;
 import org.springframework.core.io.support.EncodedResource;
 import org.springframework.core.io.support.PropertySourceFactory;
+
 public class YamlPropertySourceFactory implements PropertySourceFactory {
 
     @Override
-    public PropertySource<?> createPropertySource(String name, EncodedResource encodedResource) 
+    public PropertySource<?> createPropertySource(String name, EncodedResource encodedResource)
-      throws IOException {
+            throws IOException {
         YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
         factory.setResources(encodedResource.getResource());
 
         Properties properties = factory.getObject();
 
-        return new PropertiesPropertySource(encodedResource.getResource().getFilename(), properties);
+        return new PropertiesPropertySource(
+                encodedResource.getResource().getFilename(), properties);
     }
-}
+}

src/main/java/stirling/software/SPDF/config/security/CustomAuthenticationFailureHandler.java

@@ -1,26 +1,49 @@
-package stirling.software.SPDF.config.security;
+package stirling.software.SPDF.config.security;
-
+
-import java.io.IOException;
+import java.io.IOException;
-
+
-import org.springframework.security.authentication.BadCredentialsException;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.security.authentication.LockedException;
+import org.springframework.security.authentication.BadCredentialsException;
-import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.authentication.LockedException;
-import org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler;
+import org.springframework.security.core.AuthenticationException;
-
+import org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler;
-import jakarta.servlet.ServletException;
+import org.springframework.stereotype.Component;
-import jakarta.servlet.http.HttpServletRequest;
+
-import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.ServletException;
-
+import jakarta.servlet.http.HttpServletRequest;
-public class CustomAuthenticationFailureHandler extends SimpleUrlAuthenticationFailureHandler {
+import jakarta.servlet.http.HttpServletResponse;
-
+
-    @Override
+@Component
-    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) 
+public class CustomAuthenticationFailureHandler extends SimpleUrlAuthenticationFailureHandler {
-      throws IOException, ServletException {
+
-        if (exception.getClass().isAssignableFrom(BadCredentialsException.class)) {
+    @Autowired private final LoginAttemptService loginAttemptService;
-        	setDefaultFailureUrl("/login?error=badcredentials");
+
-        } else if (exception.getClass().isAssignableFrom(LockedException.class)) {
+    @Autowired
-        	setDefaultFailureUrl("/login?error=locked");
+    public CustomAuthenticationFailureHandler(LoginAttemptService loginAttemptService) {
-        }
+        this.loginAttemptService = loginAttemptService;
-        super.onAuthenticationFailure(request, response, exception);
+    }
-    }
+
-}
+    @Override
+    public void onAuthenticationFailure(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            AuthenticationException exception)
+            throws IOException, ServletException {
+        String ip = request.getRemoteAddr();
+        logger.error("Failed login attempt from IP: " + ip);
+
+        String username = request.getParameter("username");
+        if (loginAttemptService.loginAttemptCheck(username)) {
+            setDefaultFailureUrl("/login?error=locked");
+
+        } else {
+            if (exception.getClass().isAssignableFrom(BadCredentialsException.class)) {
+                setDefaultFailureUrl("/login?error=badcredentials");
+            } else if (exception.getClass().isAssignableFrom(LockedException.class)) {
+                setDefaultFailureUrl("/login?error=locked");
+            }
+        }
+
+        super.onAuthenticationFailure(request, response, exception);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/CustomAuthenticationSuccessHandler.java

@@ -0,0 +1,47 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
+import org.springframework.security.web.savedrequest.SavedRequest;
+import org.springframework.stereotype.Component;
+
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpSession;
+import stirling.software.SPDF.utils.RequestUriUtils;
+
+@Component
+public class CustomAuthenticationSuccessHandler
+        extends SavedRequestAwareAuthenticationSuccessHandler {
+
+    @Autowired private LoginAttemptService loginAttemptService;
+
+    @Override
+    public void onAuthenticationSuccess(
+            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            throws ServletException, IOException {
+        String username = request.getParameter("username");
+        loginAttemptService.loginSucceeded(username);
+
+        // Get the saved request
+        HttpSession session = request.getSession(false);
+        SavedRequest savedRequest =
+                session != null
+                        ? (SavedRequest) session.getAttribute("SPRING_SECURITY_SAVED_REQUEST")
+                        : null;
+        if (savedRequest != null
+                && !RequestUriUtils.isStaticResource(savedRequest.getRedirectUrl())) {
+            // Redirect to the original destination
+            super.onAuthenticationSuccess(request, response, authentication);
+        } else {
+            // Redirect to the root URL (considering context path)
+            getRedirectStrategy().sendRedirect(request, response, "/");
+        }
+
+        // super.onAuthenticationSuccess(request, response, authentication);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/CustomUserDetailsService.java

@@ -1,45 +1,57 @@
-package stirling.software.SPDF.config.security;
+package stirling.software.SPDF.config.security;
-
+
-import java.util.Collection;
+import java.util.Collection;
-import java.util.Set;
+import java.util.Set;
-import java.util.stream.Collectors;
+import java.util.stream.Collectors;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.authentication.LockedException;
-import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.GrantedAuthority;
-import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
-import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.security.core.userdetails.UserDetails;
-import org.springframework.security.core.userdetails.UsernameNotFoundException;
+import org.springframework.security.core.userdetails.UserDetailsService;
-import org.springframework.stereotype.Service;
+import org.springframework.security.core.userdetails.UsernameNotFoundException;
-
+import org.springframework.stereotype.Service;
-import stirling.software.SPDF.model.Authority;
+
-import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.model.Authority;
-import stirling.software.SPDF.repository.UserRepository;
+import stirling.software.SPDF.model.User;
-
+import stirling.software.SPDF.repository.UserRepository;
-@Service
+
-public class CustomUserDetailsService implements UserDetailsService {
+@Service
-
+public class CustomUserDetailsService implements UserDetailsService {
-    @Autowired
+
-    private UserRepository userRepository;
+    @Autowired private UserRepository userRepository;
-
+
-   
+    @Autowired private LoginAttemptService loginAttemptService;
-    @Override
+
-    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
+    @Override
-        User user = userRepository.findByUsername(username)
+    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
-            .orElseThrow(() -> new UsernameNotFoundException("No user found with username: " + username));
+        User user =
-
+                userRepository
-        return new org.springframework.security.core.userdetails.User(
+                        .findByUsername(username)
-            user.getUsername(),
+                        .orElseThrow(
-            user.getPassword(),
+                                () ->
-            user.isEnabled(),
+                                        new UsernameNotFoundException(
-            true, true, true,
+                                                "No user found with username: " + username));
-            getAuthorities(user.getAuthorities())
+
-        );
+        if (loginAttemptService.isBlocked(username)) {
-    }
+            throw new LockedException(
-
+                    "Your account has been locked due to too many failed login attempts.");
-    private Collection<? extends GrantedAuthority> getAuthorities(Set<Authority> authorities) {
+        }
-        return authorities.stream()
+
-            .map(authority -> new SimpleGrantedAuthority(authority.getAuthority()))
+        return new org.springframework.security.core.userdetails.User(
-            .collect(Collectors.toList());
+                user.getUsername(),
-    }
+                user.getPassword(),
-}
+                user.isEnabled(),
+                true,
+                true,
+                true,
+                getAuthorities(user.getAuthorities()));
+    }
+
+    private Collection<? extends GrantedAuthority> getAuthorities(Set<Authority> authorities) {
+        return authorities.stream()
+                .map(authority -> new SimpleGrantedAuthority(authority.getAuthority()))
+                .collect(Collectors.toList());
+    }
+}

src/main/java/stirling/software/SPDF/config/security/FirstLoginFilter.java

@@ -15,35 +15,35 @@ import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.utils.RequestUriUtils;
 
 @Component
 public class FirstLoginFilter extends OncePerRequestFilter {
-	
+
-    @Autowired
+    @Autowired @Lazy private UserService userService;
-    @Lazy
+
-    private UserService userService;
-    
     @Override
-    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
+    protected void doFilterInternal(
-    	String method = request.getMethod();
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
-    	String requestURI = request.getRequestURI(); 
+            throws ServletException, IOException {
-    	 // Check if the request is for static resources
+        String method = request.getMethod();
-        boolean isStaticResource = requestURI.startsWith("/css/") 
+        String requestURI = request.getRequestURI();
-                                || requestURI.startsWith("/js/")
+        // Check if the request is for static resources
-                                || requestURI.startsWith("/images/")
+        boolean isStaticResource = RequestUriUtils.isStaticResource(requestURI);
-                                || requestURI.startsWith("/public/")
-                                || requestURI.endsWith(".svg");
 
         // If it's a static resource, just continue the filter chain and skip the logic below
         if (isStaticResource) {
             filterChain.doFilter(request, response);
             return;
         }
-        
+
         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
         if (authentication != null && authentication.isAuthenticated()) {
             Optional<User> user = userService.findByUsername(authentication.getName());
-            if ("GET".equalsIgnoreCase(method) && user.isPresent() && user.get().isFirstLogin() && !"/change-creds".equals(requestURI)) {
+            if ("GET".equalsIgnoreCase(method)
+                    && user.isPresent()
+                    && user.get().isFirstLogin()
+                    && !"/change-creds".equals(requestURI)) {
                 response.sendRedirect("/change-creds");
                 return;
             }

src/main/java/stirling/software/SPDF/config/security/IPRateLimitingFilter.java

@@ -0,0 +1,68 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import jakarta.servlet.Filter;
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
+import stirling.software.SPDF.utils.RequestUriUtils;
+
+public class IPRateLimitingFilter implements Filter {
+
+    private final ConcurrentHashMap<String, AtomicInteger> requestCounts =
+            new ConcurrentHashMap<>();
+    private final ConcurrentHashMap<String, AtomicInteger> getCounts = new ConcurrentHashMap<>();
+    private final int maxRequests;
+    private final int maxGetRequests;
+
+    public IPRateLimitingFilter(int maxRequests, int maxGetRequests) {
+        this.maxRequests = maxRequests;
+        this.maxGetRequests = maxGetRequests;
+    }
+
+    @Override
+    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
+            throws IOException, ServletException {
+        if (request instanceof HttpServletRequest) {
+            HttpServletRequest httpRequest = (HttpServletRequest) request;
+            String method = httpRequest.getMethod();
+            String requestURI = httpRequest.getRequestURI();
+            // Check if the request is for static resources
+            boolean isStaticResource = RequestUriUtils.isStaticResource(requestURI);
+
+            // If it's a static resource, just continue the filter chain and skip the logic below
+            if (isStaticResource) {
+                chain.doFilter(request, response);
+                return;
+            }
+
+            String clientIp = request.getRemoteAddr();
+            requestCounts.computeIfAbsent(clientIp, k -> new AtomicInteger(0));
+            if (!"GET".equalsIgnoreCase(method)) {
+
+                if (requestCounts.get(clientIp).incrementAndGet() > maxRequests) {
+                    // Handle limit exceeded (e.g., send error response)
+                    response.getWriter().write("Rate limit exceeded");
+                    return;
+                }
+            } else {
+                if (requestCounts.get(clientIp).incrementAndGet() > maxGetRequests) {
+                    // Handle limit exceeded (e.g., send error response)
+                    response.getWriter().write("GET Rate limit exceeded");
+                    return;
+                }
+            }
+        }
+        chain.doFilter(request, response);
+    }
+
+    public void resetRequestCounts() {
+        requestCounts.clear();
+        getCounts.clear();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/InitialSecuritySetup.java

@@ -13,73 +13,76 @@ import org.springframework.stereotype.Component;
 import jakarta.annotation.PostConstruct;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.Role;
+
 @Component
 public class InitialSecuritySetup {
 
-	@Autowired
+    @Autowired private UserService userService;
-	private UserService userService;
 
+    @Autowired ApplicationProperties applicationProperties;
 
-	@Autowired
+    @PostConstruct
-	ApplicationProperties applicationProperties;
+    public void init() {
-	
+        if (!userService.hasUsers()) {
-	@PostConstruct
-	public void init() {
-		if (!userService.hasUsers()) {
-			
-			
-			String initialUsername = applicationProperties.getSecurity().getInitialLogin().getUsername();
-			String initialPassword = applicationProperties.getSecurity().getInitialLogin().getPassword();
-			if (initialUsername != null && initialPassword != null) {
-				userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId());
-			} else {
-				initialUsername = "admin";
-			    initialPassword = "stirling";
-				userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId(), true);
-			}
-			
-	        
-		}
-	}
 
+            String initialUsername =
+                    applicationProperties.getSecurity().getInitialLogin().getUsername();
+            String initialPassword =
+                    applicationProperties.getSecurity().getInitialLogin().getPassword();
+            if (initialUsername != null && initialPassword != null) {
+                userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId());
+            } else {
+                initialUsername = "admin";
+                initialPassword = "stirling";
+                userService.saveUser(
+                        initialUsername, initialPassword, Role.ADMIN.getRoleId(), true);
+            }
+        }
+        if (!userService.usernameExists(Role.INTERNAL_API_USER.getRoleId())) {
+            userService.saveUser(
+                    Role.INTERNAL_API_USER.getRoleId(),
+                    UUID.randomUUID().toString(),
+                    Role.INTERNAL_API_USER.getRoleId());
+            userService.addApiKeyToUser(Role.INTERNAL_API_USER.getRoleId());
+        }
+    }
 
+    @PostConstruct
+    public void initSecretKey() throws IOException {
+        String secretKey = applicationProperties.getAutomaticallyGenerated().getKey();
+        if (secretKey == null || secretKey.isEmpty()) {
+            secretKey = UUID.randomUUID().toString(); // Generating a random UUID as the secret key
+            saveKeyToConfig(secretKey);
+        }
+    }
 
-	@PostConstruct
+    private void saveKeyToConfig(String key) throws IOException {
-	public void initSecretKey() throws IOException {
+        Path path = Paths.get("configs", "settings.yml"); // Target the configs/settings.yml
-		String secretKey = applicationProperties.getAutomaticallyGenerated().getKey();
+        List<String> lines = Files.readAllLines(path);
-		if (secretKey == null || secretKey.isEmpty()) {
+        boolean keyFound = false;
-			secretKey = UUID.randomUUID().toString(); // Generating a random UUID as the secret key
-			saveKeyToConfig(secretKey);
-		}
-	}
 
-	private void saveKeyToConfig(String key) throws IOException {
+        // Search for the existing key to replace it or place to add it
-		Path path = Paths.get("configs", "settings.yml"); // Target the configs/settings.yml
+        for (int i = 0; i < lines.size(); i++) {
-		List<String> lines = Files.readAllLines(path);
+            if (lines.get(i).startsWith("AutomaticallyGenerated:")) {
-		boolean keyFound = false;
+                keyFound = true;
+                if (i + 1 < lines.size() && lines.get(i + 1).trim().startsWith("key:")) {
+                    lines.set(i + 1, "  key: " + key);
+                    break;
+                } else {
+                    lines.add(i + 1, "  key: " + key);
+                    break;
+                }
+            }
+        }
 
-		// Search for the existing key to replace it or place to add it
+        // If the section doesn't exist, append it
-		for (int i = 0; i < lines.size(); i++) {
+        if (!keyFound) {
-			if (lines.get(i).startsWith("AutomaticallyGenerated:")) {
+            lines.add("# Automatically Generated Settings (Do Not Edit Directly)");
-				keyFound = true;
+            lines.add("AutomaticallyGenerated:");
-				if (i + 1 < lines.size() && lines.get(i + 1).trim().startsWith("key:")) {
+            lines.add("  key: " + key);
-					lines.set(i + 1, "  key: " + key);
+        }
-					break;
-				} else {
-					lines.add(i + 1, "  key: " + key);
-					break;
-				}
-			}
-		}
 
-		// If the section doesn't exist, append it
+        // Write back to the file
-		if (!keyFound) {
+        Files.write(path, lines);
-			lines.add("# Automatically Generated Settings (Do Not Edit Directly)");
+    }
-			lines.add("AutomaticallyGenerated:");
+}
-			lines.add("  key: " + key);
-		}
-
-		// Write back to the file
-		Files.write(path, lines);
-	}
-}

src/main/java/stirling/software/SPDF/config/security/LoginAttemptService.java

@@ -0,0 +1,58 @@
+package stirling.software.SPDF.config.security;
+
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.TimeUnit;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.AttemptCounter;
+
+@Service
+public class LoginAttemptService {
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    private int MAX_ATTEMPTS;
+    private long ATTEMPT_INCREMENT_TIME;
+
+    @PostConstruct
+    public void init() {
+        MAX_ATTEMPTS = applicationProperties.getSecurity().getLoginAttemptCount();
+        ATTEMPT_INCREMENT_TIME =
+                TimeUnit.MINUTES.toMillis(
+                        applicationProperties.getSecurity().getLoginResetTimeMinutes());
+    }
+
+    private final ConcurrentHashMap<String, AttemptCounter> attemptsCache =
+            new ConcurrentHashMap<>();
+
+    public void loginSucceeded(String key) {
+        attemptsCache.remove(key);
+    }
+
+    public boolean loginAttemptCheck(String key) {
+        attemptsCache.compute(
+                key,
+                (k, attemptCounter) -> {
+                    if (attemptCounter == null
+                            || attemptCounter.shouldReset(ATTEMPT_INCREMENT_TIME)) {
+                        return new AttemptCounter();
+                    } else {
+                        attemptCounter.increment();
+                        return attemptCounter;
+                    }
+                });
+        return attemptsCache.get(key).getAttemptCount() >= MAX_ATTEMPTS;
+    }
+
+    public boolean isBlocked(String key) {
+        AttemptCounter attemptCounter = attemptsCache.get(key);
+        if (attemptCounter != null) {
+            return attemptCounter.getAttemptCount() >= MAX_ATTEMPTS;
+        }
+        return false;
+    }
+}

src/main/java/stirling/software/SPDF/config/security/RateLimitResetScheduler.java

@@ -0,0 +1,19 @@
+package stirling.software.SPDF.config.security;
+
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+@Component
+public class RateLimitResetScheduler {
+
+    private final IPRateLimitingFilter rateLimitingFilter;
+
+    public RateLimitResetScheduler(IPRateLimitingFilter rateLimitingFilter) {
+        this.rateLimitingFilter = rateLimitingFilter;
+    }
+
+    @Scheduled(cron = "0 0 0 * * MON") // At 00:00 every Monday TODO: configurable
+    public void resetRateLimit() {
+        rateLimitingFilter.resetRequestCounts();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/SecurityConfiguration.java

@@ -1,106 +1,140 @@
-package stirling.software.SPDF.config.security;
+package stirling.software.SPDF.config.security;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Lazy;
-import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
+import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
-import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
+import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
-import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
-import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
-import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.security.core.userdetails.UserDetailsService;
-import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
-import org.springframework.security.crypto.password.PasswordEncoder;
+import org.springframework.security.crypto.password.PasswordEncoder;
-import org.springframework.security.web.SecurityFilterChain;
+import org.springframework.security.web.SecurityFilterChain;
-import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
+import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
-import org.springframework.security.web.authentication.rememberme.PersistentTokenRepository;
+import org.springframework.security.web.authentication.rememberme.PersistentTokenRepository;
-import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
+import org.springframework.security.web.savedrequest.NullRequestCache;
-
+import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
-import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
+
-@Configuration
+import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
-@EnableWebSecurity()
+
-@EnableGlobalMethodSecurity(prePostEnabled = true)
+@Configuration
-public class SecurityConfiguration {
+@EnableWebSecurity()
-
+@EnableMethodSecurity
-    @Autowired
+public class SecurityConfiguration {
-    private UserDetailsService userDetailsService;
+
-
+    @Autowired private UserDetailsService userDetailsService;
-    @Bean
+
-    public PasswordEncoder passwordEncoder() {
+    @Bean
-        return new BCryptPasswordEncoder();
+    public PasswordEncoder passwordEncoder() {
-    }
+        return new BCryptPasswordEncoder();
-    @Autowired
+    }
-    @Lazy
+
-    private UserService userService;
+    @Autowired @Lazy private UserService userService;
-    
+
-    @Autowired
+    @Autowired
-    @Qualifier("loginEnabled")
+    @Qualifier("loginEnabled")
-    public boolean loginEnabledValue;
+    public boolean loginEnabledValue;
-    
+
-    @Autowired
+    @Autowired private UserAuthenticationFilter userAuthenticationFilter;
-    private UserAuthenticationFilter userAuthenticationFilter;
+
-    
+    @Autowired private LoginAttemptService loginAttemptService;
-    @Autowired
+
-    private FirstLoginFilter firstLoginFilter;
+    @Autowired private FirstLoginFilter firstLoginFilter;
-    
+
-    @Bean
+    @Bean
-    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception  {
+    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
-    	http.addFilterBefore(userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
+        http.addFilterBefore(userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
-        
+
-    	if(loginEnabledValue) {
+        if (loginEnabledValue) {
-    		
+
-    		http.csrf(csrf -> csrf.disable());
+            http.csrf(csrf -> csrf.disable());
-    		http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
+            http.addFilterBefore(rateLimitingFilter(), UsernamePasswordAuthenticationFilter.class);
-	        http
+            http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
-	            .formLogin(formLogin -> formLogin
+            http.formLogin(
-	                .loginPage("/login")
+                            formLogin ->
-	                .defaultSuccessUrl("/")
+                                    formLogin
-	                .failureHandler(new CustomAuthenticationFailureHandler())
+                                            .loginPage("/login")
-	                .permitAll()
+                                            .successHandler(
-	            )
+                                                    new CustomAuthenticationSuccessHandler())
-	            .logout(logout -> logout
+                                            .defaultSuccessUrl("/")
-	            		.logoutRequestMatcher(new AntPathRequestMatcher("/logout"))
+                                            .failureHandler(
-	                    .logoutSuccessUrl("/login?logout=true")
+                                                    new CustomAuthenticationFailureHandler(
-	                    .invalidateHttpSession(true)        // Invalidate session
+                                                            loginAttemptService))
-	                    .deleteCookies("JSESSIONID", "remember-me") 
+                                            .permitAll())
-	            ).rememberMe(rememberMeConfigurer -> rememberMeConfigurer // Use the configurator directly
+                    .requestCache(requestCache -> requestCache.requestCache(new NullRequestCache()))
-                    .key("uniqueAndSecret")
+                    .logout(
-                    .tokenRepository(persistentTokenRepository())
+                            logout ->
-                    .tokenValiditySeconds(1209600) // 2 weeks
+                                    logout.logoutRequestMatcher(
-                )
+                                                    new AntPathRequestMatcher("/logout"))
-	            .authorizeHttpRequests(authz -> authz
+                                            .logoutSuccessUrl("/login?logout=true")
-	                    .requestMatchers(req -> req.getRequestURI().startsWith("/login") || req.getRequestURI().endsWith(".svg") || req.getRequestURI().startsWith("/register") || req.getRequestURI().startsWith("/error") || req.getRequestURI().startsWith("/images/") ||  req.getRequestURI().startsWith("/public/") || req.getRequestURI().startsWith("/css/") || req.getRequestURI().startsWith("/js/"))
+                                            .invalidateHttpSession(true) // Invalidate session
-	                    .permitAll()
+                                            .deleteCookies("JSESSIONID", "remember-me"))
-	                    .anyRequest().authenticated()
+                    .rememberMe(
-	                )
+                            rememberMeConfigurer ->
-	            .userDetailsService(userDetailsService)
+                                    rememberMeConfigurer // Use the configurator directly
-	            .authenticationProvider(authenticationProvider());
+                                            .key("uniqueAndSecret")
-    	} else {
+                                            .tokenRepository(persistentTokenRepository())
-    		 http.csrf(csrf -> csrf.disable())
+                                            .tokenValiditySeconds(1209600) // 2 weeks
-             .authorizeHttpRequests(authz -> authz
+                            )
-                 .anyRequest().permitAll()
+                    .authorizeHttpRequests(
-             );
+                            authz ->
-    	}
+                                    authz.requestMatchers(
-        return http.build();
+                                                    req -> {
-    }
+                                                        String uri = req.getRequestURI();
-
+                                                        String contextPath = req.getContextPath();
-
+
-    
+                                                        // Remove the context path from the URI
-    @Bean
+                                                        String trimmedUri =
-    public DaoAuthenticationProvider authenticationProvider() {
+                                                                uri.startsWith(contextPath)
-        DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
+                                                                        ? uri.substring(
-        authProvider.setUserDetailsService(userDetailsService);
+                                                                                contextPath
-        authProvider.setPasswordEncoder(passwordEncoder());
+                                                                                        .length())
-        return authProvider;
+                                                                        : uri;
-    }
+
-    
+                                                        return trimmedUri.startsWith("/login")
-    @Bean
+                                                                || trimmedUri.endsWith(".svg")
-    public PersistentTokenRepository persistentTokenRepository() {
+                                                                || trimmedUri.startsWith(
-        return new JPATokenRepositoryImpl();
+                                                                        "/register")
-    }
+                                                                || trimmedUri.startsWith("/error")
-    
+                                                                || trimmedUri.startsWith("/images/")
-
+                                                                || trimmedUri.startsWith("/public/")
-    
+                                                                || trimmedUri.startsWith("/css/")
-}
+                                                                || trimmedUri.startsWith("/js/")
-
+                                                                || trimmedUri.startsWith(
+                                                                        "/api/v1/info/status");
+                                                    })
+                                            .permitAll()
+                                            .anyRequest()
+                                            .authenticated())
+                    .userDetailsService(userDetailsService)
+                    .authenticationProvider(authenticationProvider());
+        } else {
+            http.csrf(csrf -> csrf.disable())
+                    .authorizeHttpRequests(authz -> authz.anyRequest().permitAll());
+        }
+
+        return http.build();
+    }
+
+    @Bean
+    public IPRateLimitingFilter rateLimitingFilter() {
+        int maxRequestsPerIp = 1000000; // Example limit TODO add config level
+        return new IPRateLimitingFilter(maxRequestsPerIp, maxRequestsPerIp);
+    }
+
+    @Bean
+    public DaoAuthenticationProvider authenticationProvider() {
+        DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
+        authProvider.setUserDetailsService(userDetailsService);
+        authProvider.setPasswordEncoder(passwordEncoder());
+        return authProvider;
+    }
+
+    @Bean
+    public PersistentTokenRepository persistentTokenRepository() {
+        return new JPATokenRepositoryImpl();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/UserAuthenticationFilter.java

@@ -1,113 +1,118 @@
-package stirling.software.SPDF.config.security;
+package stirling.software.SPDF.config.security;
-
+
-import java.io.IOException;
+import java.io.IOException;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Lazy;
-import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatus;
-import org.springframework.security.core.Authentication;
+import org.springframework.security.core.Authentication;
-import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.core.AuthenticationException;
-import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.context.SecurityContextHolder;
-import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.userdetails.UserDetails;
-import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.security.core.userdetails.UserDetailsService;
-import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Component;
-import org.springframework.web.filter.OncePerRequestFilter;
+import org.springframework.web.filter.OncePerRequestFilter;
-
+
-import jakarta.servlet.FilterChain;
+import jakarta.servlet.FilterChain;
-import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletException;
-import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletResponse;
-import stirling.software.SPDF.model.ApiKeyAuthenticationToken;
+import stirling.software.SPDF.model.ApiKeyAuthenticationToken;
-@Component
+
-public class UserAuthenticationFilter extends OncePerRequestFilter {
+@Component
-
+public class UserAuthenticationFilter extends OncePerRequestFilter {
-    @Autowired
+
-    private UserDetailsService userDetailsService;
+    @Autowired private UserDetailsService userDetailsService;
-
+
-    @Autowired
+    @Autowired @Lazy private UserService userService;
-    @Lazy
+
-    private UserService userService;
+    @Autowired
-    
+    @Qualifier("loginEnabled")
-   
+    public boolean loginEnabledValue;
-    @Autowired
+
-    @Qualifier("loginEnabled")
+    @Override
-    public boolean loginEnabledValue;
+    protected void doFilterInternal(
-
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
-    @Override
+            throws ServletException, IOException {
-    protected void doFilterInternal(HttpServletRequest request,
+
-                                    HttpServletResponse response,
+        if (!loginEnabledValue) {
-                                    FilterChain filterChain) throws ServletException, IOException {
+            // If login is not enabled, just pass all requests without authentication
-
+            filterChain.doFilter(request, response);
-        if (!loginEnabledValue) {
+            return;
-            // If login is not enabled, just pass all requests without authentication
+        }
-            filterChain.doFilter(request, response);
+        String requestURI = request.getRequestURI();
-            return;
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
-        }
+
-        String requestURI = request.getRequestURI(); 
+        // Check for API key in the request headers if no authentication exists
-        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        if (authentication == null || !authentication.isAuthenticated()) {
-
+            String apiKey = request.getHeader("X-API-Key");
-        // Check for API key in the request headers if no authentication exists
+            if (apiKey != null && !apiKey.trim().isEmpty()) {
-        if (authentication == null || !authentication.isAuthenticated()) {
+                try {
-            String apiKey = request.getHeader("X-API-Key");
+                    // Use API key to authenticate. This requires you to have an authentication
-            if (apiKey != null && !apiKey.trim().isEmpty()) {
+                    // provider for API keys.
-                try {
+                    UserDetails userDetails = userService.loadUserByApiKey(apiKey);
-                    // Use API key to authenticate. This requires you to have an authentication provider for API keys.
+                    if (userDetails == null) {
-                	UserDetails userDetails = userService.loadUserByApiKey(apiKey);
+                        response.setStatus(HttpStatus.UNAUTHORIZED.value());
-                	if(userDetails == null)
+                        response.getWriter().write("Invalid API Key.");
-                	{
+                        return;
-                		response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                    }
-                        response.getWriter().write("Invalid API Key.");
+                    authentication =
-                        return;
+                            new ApiKeyAuthenticationToken(
-                	}
+                                    userDetails, apiKey, userDetails.getAuthorities());
-                    authentication = new ApiKeyAuthenticationToken(userDetails, apiKey, userDetails.getAuthorities());
+                    SecurityContextHolder.getContext().setAuthentication(authentication);
-                    SecurityContextHolder.getContext().setAuthentication(authentication);
+                } catch (AuthenticationException e) {
-                } catch (AuthenticationException e) {
+                    // If API key authentication fails, deny the request
-                    // If API key authentication fails, deny the request
+                    response.setStatus(HttpStatus.UNAUTHORIZED.value());
-                    response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                    response.getWriter().write("Invalid API Key.");
-                    response.getWriter().write("Invalid API Key.");
+                    return;
-                    return;
+                }
-                }
+            }
-            }
+        }
-        }
+
-
+        // If we still don't have any authentication, deny the request
-        // If we still don't have any authentication, deny the request
+        if (authentication == null || !authentication.isAuthenticated()) {
-        if (authentication == null || !authentication.isAuthenticated()) {
+            String method = request.getMethod();
-        	String method = request.getMethod();
+            String contextPath = request.getContextPath();
-        	if ("GET".equalsIgnoreCase(method) && !"/login".equals(requestURI)) {
+
-        		 response.sendRedirect("/login");  // redirect to the login page
+            if ("GET".equalsIgnoreCase(method) && !(contextPath + "/login").equals(requestURI)) {
-        	     return;
+                response.sendRedirect(contextPath + "/login"); // redirect to the login page
-            } else {
+                return;
-	            response.setStatus(HttpStatus.UNAUTHORIZED.value());
+            } else {
-	            response.getWriter().write("Authentication required. Please provide a X-API-KEY in request header.\nThis is found in Settings -> Account Settings -> API Key\nAlternativly you can disable authentication if this is unexpected");
+                response.setStatus(HttpStatus.UNAUTHORIZED.value());
-	            return;
+                response.getWriter()
-            }
+                        .write(
-        }
+                                "Authentication required. Please provide a X-API-KEY in request header.\nThis is found in Settings -> Account Settings -> API Key\nAlternativly you can disable authentication if this is unexpected");
-
+                return;
-        filterChain.doFilter(request, response);
+            }
-    }
+        }
-    
+
-    @Override
+        filterChain.doFilter(request, response);
-    protected boolean shouldNotFilter(HttpServletRequest request) throws ServletException {
+    }
-        String uri = request.getRequestURI();
+
-
+    @Override
-        String[] permitAllPatterns = {
+    protected boolean shouldNotFilter(HttpServletRequest request) throws ServletException {
-            "/login",
+        String uri = request.getRequestURI();
-            "/register",
+        String contextPath = request.getContextPath();
-            "/error",
+        String[] permitAllPatterns = {
-            "/images/",
+            contextPath + "/login",
-            "/public/",
+            contextPath + "/register",
-            "/css/",
+            contextPath + "/error",
-            "/js/"
+            contextPath + "/images/",
-        };
+            contextPath + "/public/",
-
+            contextPath + "/css/",
-        for (String pattern : permitAllPatterns) {
+            contextPath + "/js/",
-            if (uri.startsWith(pattern) || uri.endsWith(".svg")) {
+            contextPath + "/pdfjs/",
-                return true;
+            contextPath + "/api/v1/info/status",
-            }
+            contextPath + "/site.webmanifest"
-        }
+        };
-
+
-        return false;
+        for (String pattern : permitAllPatterns) {
-    }
+            if (uri.startsWith(pattern) || uri.endsWith(".svg")) {
-
+                return true;
-}
+            }
+        }
+
+        return false;
+    }
+}

src/main/java/stirling/software/SPDF/config/security/UserBasedRateLimitingFilter.java

@@ -1,125 +1,143 @@
-package stirling.software.SPDF.config.security;
+package stirling.software.SPDF.config.security;
-
+
-import java.io.IOException;
+import java.io.IOException;
-import java.time.Duration;
+import java.time.Duration;
-import java.util.Map;
+import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentHashMap;
-
+
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatus;
-import org.springframework.security.core.Authentication;
+import org.springframework.security.core.Authentication;
-import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.GrantedAuthority;
-import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.context.SecurityContextHolder;
-import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.userdetails.UserDetails;
-import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.security.core.userdetails.UserDetailsService;
-import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Component;
-import org.springframework.web.filter.OncePerRequestFilter;
+import org.springframework.web.filter.OncePerRequestFilter;
-
+
-import io.github.bucket4j.Bandwidth;
+import io.github.bucket4j.Bandwidth;
-import io.github.bucket4j.Bucket;
+import io.github.bucket4j.Bucket;
-import io.github.bucket4j.ConsumptionProbe;
+import io.github.bucket4j.ConsumptionProbe;
-import io.github.bucket4j.Refill;
+import io.github.bucket4j.Refill;
-import jakarta.servlet.FilterChain;
+
-import jakarta.servlet.ServletException;
+import jakarta.servlet.FilterChain;
-import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.ServletException;
-import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
-import stirling.software.SPDF.model.Role;
+import jakarta.servlet.http.HttpServletResponse;
-@Component
+import stirling.software.SPDF.model.Role;
-public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
+
-
+@Component
-	private final Map<String, Bucket> apiBuckets = new ConcurrentHashMap<>();
+public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
-    private final Map<String, Bucket> webBuckets = new ConcurrentHashMap<>();
+
-
+    private final Map<String, Bucket> apiBuckets = new ConcurrentHashMap<>();
-    @Autowired
+    private final Map<String, Bucket> webBuckets = new ConcurrentHashMap<>();
-    private UserDetailsService userDetailsService;
+
-
+    @Autowired private UserDetailsService userDetailsService;
-    @Autowired
+
-    @Qualifier("rateLimit")
+    @Autowired
-    public boolean rateLimit;
+    @Qualifier("rateLimit")
-
+    public boolean rateLimit;
-    @Override
+
-    protected void doFilterInternal(HttpServletRequest request,
+    @Override
-                                    HttpServletResponse response,
+    protected void doFilterInternal(
-                                    FilterChain filterChain) throws ServletException, IOException {
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
-        if (!rateLimit) {
+            throws ServletException, IOException {
-            // If rateLimit is not enabled, just pass all requests without rate limiting
+        if (!rateLimit) {
-            filterChain.doFilter(request, response);
+            // If rateLimit is not enabled, just pass all requests without rate limiting
-            return;
+            filterChain.doFilter(request, response);
-        }
+            return;
-
+        }
-        String method = request.getMethod();
+
-        if (!"POST".equalsIgnoreCase(method)) {
+        String method = request.getMethod();
-            // If the request is not a POST, just pass it through without rate limiting
+        if (!"POST".equalsIgnoreCase(method)) {
-            filterChain.doFilter(request, response);
+            // If the request is not a POST, just pass it through without rate limiting
-            return;
+            filterChain.doFilter(request, response);
-        }
+            return;
-
+        }
-        String identifier = null;
+
-
+        String identifier = null;
-        // Check for API key in the request headers
+
-        String apiKey = request.getHeader("X-API-Key");
+        // Check for API key in the request headers
-        if (apiKey != null && !apiKey.trim().isEmpty()) {
+        String apiKey = request.getHeader("X-API-Key");
-            identifier = "API_KEY_" + apiKey; // Prefix to distinguish between API keys and usernames
+        if (apiKey != null && !apiKey.trim().isEmpty()) {
-        } else {
+            identifier =
-            Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+                    "API_KEY_" + apiKey; // Prefix to distinguish between API keys and usernames
-            if (authentication != null && authentication.isAuthenticated()) {
+        } else {
-                UserDetails userDetails = (UserDetails) authentication.getPrincipal();
+            Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
-                identifier = userDetails.getUsername();
+            if (authentication != null && authentication.isAuthenticated()) {
-            }
+                UserDetails userDetails = (UserDetails) authentication.getPrincipal();
-        }
+                identifier = userDetails.getUsername();
-
+            }
-        // If neither API key nor an authenticated user is present, use IP address
+        }
-        if (identifier == null) {
+
-            identifier = request.getRemoteAddr();
+        // If neither API key nor an authenticated user is present, use IP address
-        }
+        if (identifier == null) {
-
+            identifier = request.getRemoteAddr();
-        Role userRole = getRoleFromAuthentication(SecurityContextHolder.getContext().getAuthentication());
+        }
-
+
-        if (request.getHeader("X-API-Key") != null) {
+        Role userRole =
-            // It's an API call
+                getRoleFromAuthentication(SecurityContextHolder.getContext().getAuthentication());
-            processRequest(userRole.getApiCallsPerDay(), identifier, apiBuckets, request, response, filterChain);
+
-        } else {
+        if (request.getHeader("X-API-Key") != null) {
-            // It's a Web UI call
+            // It's an API call
-            processRequest(userRole.getWebCallsPerDay(), identifier, webBuckets, request, response, filterChain);
+            processRequest(
-        }
+                    userRole.getApiCallsPerDay(),
-    }
+                    identifier,
-
+                    apiBuckets,
-    private Role getRoleFromAuthentication(Authentication authentication) {
+                    request,
-        if (authentication != null && authentication.isAuthenticated()) {
+                    response,
-            for (GrantedAuthority authority : authentication.getAuthorities()) {
+                    filterChain);
-                try {
+        } else {
-                    return Role.fromString(authority.getAuthority());
+            // It's a Web UI call
-                } catch (IllegalArgumentException ex) {
+            processRequest(
-                    // Ignore and continue to next authority.
+                    userRole.getWebCallsPerDay(),
-                }
+                    identifier,
-            }
+                    webBuckets,
-        }
+                    request,
-        throw new IllegalStateException("User does not have a valid role.");
+                    response,
-    }
+                    filterChain);
-
+        }
-    private void processRequest(int limitPerDay, String identifier, Map<String, Bucket> buckets,
+    }
-                                HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+
-            throws IOException, ServletException {
+    private Role getRoleFromAuthentication(Authentication authentication) {
-        Bucket userBucket = buckets.computeIfAbsent(identifier, k -> createUserBucket(limitPerDay));
+        if (authentication != null && authentication.isAuthenticated()) {
-        ConsumptionProbe probe = userBucket.tryConsumeAndReturnRemaining(1);
+            for (GrantedAuthority authority : authentication.getAuthorities()) {
-
+                try {
-        if (probe.isConsumed()) {
+                    return Role.fromString(authority.getAuthority());
-            response.setHeader("X-Rate-Limit-Remaining", Long.toString(probe.getRemainingTokens()));
+                } catch (IllegalArgumentException ex) {
-            filterChain.doFilter(request, response);
+                    // Ignore and continue to next authority.
-        } else {
+                }
-            long waitForRefill = probe.getNanosToWaitForRefill() / 1_000_000_000;
+            }
-            response.setStatus(HttpStatus.TOO_MANY_REQUESTS.value());
+        }
-            response.setHeader("X-Rate-Limit-Retry-After-Seconds", String.valueOf(waitForRefill));
+        throw new IllegalStateException("User does not have a valid role.");
-            response.getWriter().write("Rate limit exceeded for POST requests.");
+    }
-        }
+
-    }
+    private void processRequest(
-
+            int limitPerDay,
-    private Bucket createUserBucket(int limitPerDay) {
+            String identifier,
-        Bandwidth limit = Bandwidth.classic(limitPerDay, Refill.intervally(limitPerDay, Duration.ofDays(1)));
+            Map<String, Bucket> buckets,
-        return Bucket.builder().addLimit(limit).build();
+            HttpServletRequest request,
-    }
+            HttpServletResponse response,
-}
+            FilterChain filterChain)
-
+            throws IOException, ServletException {
-
+        Bucket userBucket = buckets.computeIfAbsent(identifier, k -> createUserBucket(limitPerDay));
-
+        ConsumptionProbe probe = userBucket.tryConsumeAndReturnRemaining(1);
+
+        if (probe.isConsumed()) {
+            response.setHeader("X-Rate-Limit-Remaining", Long.toString(probe.getRemainingTokens()));
+            filterChain.doFilter(request, response);
+        } else {
+            long waitForRefill = probe.getNanosToWaitForRefill() / 1_000_000_000;
+            response.setStatus(HttpStatus.TOO_MANY_REQUESTS.value());
+            response.setHeader("X-Rate-Limit-Retry-After-Seconds", String.valueOf(waitForRefill));
+            response.getWriter().write("Rate limit exceeded for POST requests.");
+        }
+    }
+
+    private Bucket createUserBucket(int limitPerDay) {
+        Bandwidth limit =
+                Bandwidth.classic(limitPerDay, Refill.intervally(limitPerDay, Duration.ofDays(1)));
+        return Bucket.builder().addLimit(limit).build();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/UserService.java

@@ -1,191 +1,197 @@
-package stirling.software.SPDF.config.security;
+package stirling.software.SPDF.config.security;
-import java.util.Collection;
+
-import java.util.HashMap;
+import java.util.Collection;
-import java.util.Map;
+import java.util.HashMap;
-import java.util.Optional;
+import java.util.Map;
-import java.util.UUID;
+import java.util.Optional;
-import java.util.stream.Collectors;
+import java.util.UUID;
-
+import java.util.stream.Collectors;
-import org.springframework.beans.factory.annotation.Autowired;
+
-import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.security.core.Authentication;
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
-import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.Authentication;
-import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.GrantedAuthority;
-import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
-import org.springframework.security.core.userdetails.UsernameNotFoundException;
+import org.springframework.security.core.userdetails.UserDetails;
-import org.springframework.security.crypto.password.PasswordEncoder;
+import org.springframework.security.core.userdetails.UsernameNotFoundException;
-import org.springframework.stereotype.Service;
+import org.springframework.security.crypto.password.PasswordEncoder;
-
+import org.springframework.stereotype.Service;
-import stirling.software.SPDF.model.Authority;
+
-import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.controller.api.pipeline.UserServiceInterface;
-import stirling.software.SPDF.repository.UserRepository;
+import stirling.software.SPDF.model.Authority;
-@Service
+import stirling.software.SPDF.model.Role;
-public class UserService {
+import stirling.software.SPDF.model.User;
-    
+import stirling.software.SPDF.repository.UserRepository;
-    @Autowired
+
-    private UserRepository userRepository;
+@Service
-
+public class UserService implements UserServiceInterface {
-    @Autowired
+
-    private PasswordEncoder passwordEncoder;
+    @Autowired private UserRepository userRepository;
-
+
-    public Authentication getAuthentication(String apiKey) {
+    @Autowired private PasswordEncoder passwordEncoder;
-        User user = getUserByApiKey(apiKey);
+
-        if (user == null) {
+    public Authentication getAuthentication(String apiKey) {
-            throw new UsernameNotFoundException("API key is not valid");
+        User user = getUserByApiKey(apiKey);
-        }
+        if (user == null) {
-        
+            throw new UsernameNotFoundException("API key is not valid");
-        // Convert the user into an Authentication object
+        }
-        return new UsernamePasswordAuthenticationToken(
+
-            user,                       // principal (typically the user)
+        // Convert the user into an Authentication object
-            null,                       // credentials (we don't expose the password or API key here)
+        return new UsernamePasswordAuthenticationToken(
-            getAuthorities(user)        // user's authorities (roles/permissions)
+                user, // principal (typically the user)
-        );
+                null, // credentials (we don't expose the password or API key here)
-    }
+                getAuthorities(user) // user's authorities (roles/permissions)
-    
+                );
-    private Collection<? extends GrantedAuthority> getAuthorities(User user) {
+    }
-        // Convert each Authority object into a SimpleGrantedAuthority object.
+
-    	return user.getAuthorities().stream()
+    private Collection<? extends GrantedAuthority> getAuthorities(User user) {
-    		    .map((Authority authority) -> new SimpleGrantedAuthority(authority.getAuthority()))
+        // Convert each Authority object into a SimpleGrantedAuthority object.
-    		    .collect(Collectors.toList());
+        return user.getAuthorities().stream()
-
+                .map((Authority authority) -> new SimpleGrantedAuthority(authority.getAuthority()))
-
+                .collect(Collectors.toList());
-    }
+    }
-    
+
-    private String generateApiKey() {
+    private String generateApiKey() {
-        String apiKey;
+        String apiKey;
-        do {
+        do {
-            apiKey = UUID.randomUUID().toString();
+            apiKey = UUID.randomUUID().toString();
-        } while (userRepository.findByApiKey(apiKey) != null); // Ensure uniqueness
+        } while (userRepository.findByApiKey(apiKey) != null); // Ensure uniqueness
-        return apiKey;
+        return apiKey;
-    }
+    }
-
+
-    public User addApiKeyToUser(String username) {
+    public User addApiKeyToUser(String username) {
-        User user = userRepository.findByUsername(username)
+        User user =
-            .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+                userRepository
-        
+                        .findByUsername(username)
-        user.setApiKey(generateApiKey());
+                        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
-        return userRepository.save(user);
+
-    }
+        user.setApiKey(generateApiKey());
-
+        return userRepository.save(user);
-    public User refreshApiKeyForUser(String username) {
+    }
-        return addApiKeyToUser(username); // reuse the add API key method for refreshing
+
-    }
+    public User refreshApiKeyForUser(String username) {
-
+        return addApiKeyToUser(username); // reuse the add API key method for refreshing
-    public String getApiKeyForUser(String username) {
+    }
-        User user = userRepository.findByUsername(username)
+
-            .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+    public String getApiKeyForUser(String username) {
-        return user.getApiKey();
+        User user =
-    }
+                userRepository
-
+                        .findByUsername(username)
-    public boolean isValidApiKey(String apiKey) {
+                        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
-        return userRepository.findByApiKey(apiKey) != null;
+        return user.getApiKey();
-    }
+    }
-
+
-    public User getUserByApiKey(String apiKey) {
+    public boolean isValidApiKey(String apiKey) {
-        return userRepository.findByApiKey(apiKey);
+        return userRepository.findByApiKey(apiKey) != null;
-    }
+    }
-    
+
-    public UserDetails loadUserByApiKey(String apiKey) {
+    public User getUserByApiKey(String apiKey) {
-        User userOptional = userRepository.findByApiKey(apiKey);
+        return userRepository.findByApiKey(apiKey);
-        if (userOptional != null) {
+    }
-            User user = userOptional;
+
-            // Convert your User entity to a UserDetails object with authorities
+    public UserDetails loadUserByApiKey(String apiKey) {
-            return new org.springframework.security.core.userdetails.User(
+        User userOptional = userRepository.findByApiKey(apiKey);
-                user.getUsername(),
+        if (userOptional != null) {
-                user.getPassword(), // you might not need this for API key auth
+            User user = userOptional;
-                getAuthorities(user)
+            // Convert your User entity to a UserDetails object with authorities
-            );
+            return new org.springframework.security.core.userdetails.User(
-        }
+                    user.getUsername(),
-        return null;  // or throw an exception
+                    user.getPassword(), // you might not need this for API key auth
-    }
+                    getAuthorities(user));
-    
+        }
-
+        return null; // or throw an exception
-    public boolean validateApiKeyForUser(String username, String apiKey) {
+    }
-        Optional<User> userOpt = userRepository.findByUsername(username);
+
-        return userOpt.isPresent() && userOpt.get().getApiKey().equals(apiKey);
+    public boolean validateApiKeyForUser(String username, String apiKey) {
-    }
+        Optional<User> userOpt = userRepository.findByUsername(username);
-    
+        return userOpt.isPresent() && userOpt.get().getApiKey().equals(apiKey);
-    public void saveUser(String username, String password) {
+    }
-        User user = new User();
+
-        user.setUsername(username);
+    public void saveUser(String username, String password) {
-        user.setPassword(passwordEncoder.encode(password));
+        User user = new User();
-        user.setEnabled(true);
+        user.setUsername(username);
-        userRepository.save(user);
+        user.setPassword(passwordEncoder.encode(password));
-    }
+        user.setEnabled(true);
-
+        userRepository.save(user);
-    public void saveUser(String username, String password, String role, boolean firstLogin) {
+    }
-        User user = new User();
+
-        user.setUsername(username);
+    public void saveUser(String username, String password, String role, boolean firstLogin) {
-        user.setPassword(passwordEncoder.encode(password));
+        User user = new User();
-        user.addAuthority(new Authority(role, user));
+        user.setUsername(username);
-        user.setEnabled(true);
+        user.setPassword(passwordEncoder.encode(password));
-        user.setFirstLogin(firstLogin);
+        user.addAuthority(new Authority(role, user));
-        userRepository.save(user);
+        user.setEnabled(true);
-    }
+        user.setFirstLogin(firstLogin);
-    
+        userRepository.save(user);
-    public void saveUser(String username, String password, String role) {
+    }
-        User user = new User();
+
-        user.setUsername(username);
+    public void saveUser(String username, String password, String role) {
-        user.setPassword(passwordEncoder.encode(password));
+        User user = new User();
-        user.addAuthority(new Authority(role, user));
+        user.setUsername(username);
-        user.setEnabled(true);
+        user.setPassword(passwordEncoder.encode(password));
-        user.setFirstLogin(false);
+        user.addAuthority(new Authority(role, user));
-        userRepository.save(user);
+        user.setEnabled(true);
-    }
+        user.setFirstLogin(false);
-    
+        userRepository.save(user);
-    public void deleteUser(String username) {
+    }
-    	 Optional<User> userOpt = userRepository.findByUsername(username);
+
-         if (userOpt.isPresent()) {
+    public void deleteUser(String username) {
-        	 userRepository.delete(userOpt.get());
+        Optional<User> userOpt = userRepository.findByUsername(username);
-         }
+        if (userOpt.isPresent()) {
-    }
+            for (Authority authority : userOpt.get().getAuthorities()) {
-    
+                if (authority.getAuthority().equals(Role.INTERNAL_API_USER.getRoleId())) {
-    public boolean usernameExists(String username) {
+                    return;
-        return userRepository.findByUsername(username).isPresent();
+                }
-    }
+            }
-    
+            userRepository.delete(userOpt.get());
-    public boolean hasUsers() {
+        }
-        return userRepository.count() > 0;
+    }
-    }
+
-    
+    public boolean usernameExists(String username) {
-    public void updateUserSettings(String username, Map<String, String> updates) {
+        return userRepository.findByUsername(username).isPresent();
-        Optional<User> userOpt = userRepository.findByUsername(username);
+    }
-        if (userOpt.isPresent()) {
+
-            User user = userOpt.get();
+    public boolean hasUsers() {
-            Map<String, String> settingsMap = user.getSettings();
+        return userRepository.count() > 0;
-
+    }
-            if(settingsMap == null) {
+
-                settingsMap = new HashMap<String,String>();
+    public void updateUserSettings(String username, Map<String, String> updates) {
-            } 
+        Optional<User> userOpt = userRepository.findByUsername(username);
-            settingsMap.clear();
+        if (userOpt.isPresent()) {
-            settingsMap.putAll(updates);
+            User user = userOpt.get();
-            user.setSettings(settingsMap);
+            Map<String, String> settingsMap = user.getSettings();
-
+
-            userRepository.save(user);
+            if (settingsMap == null) {
-        } 
+                settingsMap = new HashMap<String, String>();
-    }
+            }
-
+            settingsMap.clear();
-    public Optional<User> findByUsername(String username) {
+            settingsMap.putAll(updates);
-        return userRepository.findByUsername(username);
+            user.setSettings(settingsMap);
-    }
+
-
+            userRepository.save(user);
-    public void changeUsername(User user, String newUsername) {
+        }
-        user.setUsername(newUsername);
+    }
-        userRepository.save(user);
+
-    }
+    public Optional<User> findByUsername(String username) {
-
+        return userRepository.findByUsername(username);
-    public void changePassword(User user, String newPassword) {
+    }
-        user.setPassword(passwordEncoder.encode(newPassword));
+
-        userRepository.save(user);
+    public void changeUsername(User user, String newUsername) {
-    }
+        user.setUsername(newUsername);
-    
+        userRepository.save(user);
-    public void changeFirstUse(User user, boolean firstUse) {
+    }
-        user.setFirstLogin(firstUse);
+
-        userRepository.save(user);
+    public void changePassword(User user, String newPassword) {
-    }
+        user.setPassword(passwordEncoder.encode(newPassword));
-    
+        userRepository.save(user);
-    
+    }
-    public boolean isPasswordCorrect(User user, String currentPassword) {
+
-        return passwordEncoder.matches(currentPassword, user.getPassword());
+    public void changeFirstUse(User user, boolean firstUse) {
-    }
+        user.setFirstLogin(firstUse);
-}
+        userRepository.save(user);
+    }
+
+    public boolean isPasswordCorrect(User user, String currentPassword) {
+        return passwordEncoder.matches(currentPassword, user.getPassword());
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/CropController.java

@@ -20,6 +20,7 @@ import org.springframework.web.bind.annotation.RestController;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.general.CropPdfForm;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -28,59 +29,62 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "General", description = "General APIs")
 public class CropController {
 
-	private static final Logger logger = LoggerFactory.getLogger(CropController.class);
+    private static final Logger logger = LoggerFactory.getLogger(CropController.class);
 
-	@PostMapping(value = "/crop", consumes = "multipart/form-data")
+    @PostMapping(value = "/crop", consumes = "multipart/form-data")
-	@Operation(summary = "Crops a PDF document", description = "This operation takes an input PDF file and crops it according to the given coordinates. Input:PDF Output:PDF Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> cropPdf(@ModelAttribute CropPdfForm form)
+            summary = "Crops a PDF document",
-			throws IOException {
+            description =
+                    "This operation takes an input PDF file and crops it according to the given coordinates. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> cropPdf(@ModelAttribute CropPdfForm form) throws IOException {
 
+        PDDocument sourceDocument =
+                PDDocument.load(new ByteArrayInputStream(form.getFileInput().getBytes()));
 
-		
+        PDDocument newDocument = new PDDocument();
 
-PDDocument sourceDocument = PDDocument.load(new ByteArrayInputStream(form.getFileInput().getBytes()));
+        int totalPages = sourceDocument.getNumberOfPages();
 
-PDDocument newDocument = new PDDocument();
+        LayerUtility layerUtility = new LayerUtility(newDocument);
 
-int totalPages = sourceDocument.getNumberOfPages();
+        for (int i = 0; i < totalPages; i++) {
+            PDPage sourcePage = sourceDocument.getPage(i);
 
-LayerUtility layerUtility = new LayerUtility(newDocument);
+            // Create a new page with the size of the source page
+            PDPage newPage = new PDPage(sourcePage.getMediaBox());
+            newDocument.addPage(newPage);
+            PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage);
 
-for (int i = 0; i < totalPages; i++) {
+            // Import the source page as a form XObject
-    PDPage sourcePage = sourceDocument.getPage(i);
+            PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
-    
-    // Create a new page with the size of the source page
-    PDPage newPage = new PDPage(sourcePage.getMediaBox());
-    newDocument.addPage(newPage);
-    PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage);
 
-    // Import the source page as a form XObject
+            contentStream.saveGraphicsState();
-    PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
 
-    contentStream.saveGraphicsState();
+            // Define the crop area
-    
+            contentStream.addRect(form.getX(), form.getY(), form.getWidth(), form.getHeight());
-    // Define the crop area
+            contentStream.clip();
-    contentStream.addRect(form.getX(), form.getY(), form.getWidth(), form.getHeight());
-    contentStream.clip();
 
-    // Draw the entire formXObject
+            // Draw the entire formXObject
-    contentStream.drawForm(formXObject);
+            contentStream.drawForm(formXObject);
 
-    contentStream.restoreGraphicsState();
+            contentStream.restoreGraphicsState();
-
-    contentStream.close();
-    
-    // Now, set the new page's media box to the cropped size
-    newPage.setMediaBox(new PDRectangle(form.getX(), form.getY(), form.getWidth(), form.getHeight()));
-}
-
-ByteArrayOutputStream baos = new ByteArrayOutputStream();
-newDocument.save(baos);
-newDocument.close();
-sourceDocument.close();
-
-byte[] pdfContent = baos.toByteArray();
-return WebResponseUtils.bytesToWebResponse(pdfContent, form.getFileInput().getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_cropped.pdf");
-	}
 
+            contentStream.close();
+
+            // Now, set the new page's media box to the cropped size
+            newPage.setMediaBox(
+                    new PDRectangle(form.getX(), form.getY(), form.getWidth(), form.getHeight()));
+        }
+
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        newDocument.save(baos);
+        newDocument.close();
+        sourceDocument.close();
+
+        byte[] pdfContent = baos.toByteArray();
+        return WebResponseUtils.bytesToWebResponse(
+                pdfContent,
+                form.getFileInput().getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                        + "_cropped.pdf");
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/MergeController.java

@@ -1,15 +1,17 @@
 package stirling.software.SPDF.controller.api;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
-import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.nio.file.attribute.BasicFileAttributes;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Comparator;
 import java.util.List;
 
+import org.apache.pdfbox.io.MemoryUsageSetting;
+import org.apache.pdfbox.multipdf.PDFMergerUtility;
 import org.apache.pdfbox.pdmodel.PDDocument;
 import org.apache.pdfbox.pdmodel.PDPage;
 import org.slf4j.Logger;
@@ -23,6 +25,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.general.MergePdfsRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -33,83 +36,97 @@ public class MergeController {
 
     private static final Logger logger = LoggerFactory.getLogger(MergeController.class);
 
-
+    private PDDocument mergeDocuments(List<PDDocument> documents) throws IOException {
-private PDDocument mergeDocuments(List<PDDocument> documents) throws IOException {
+        PDDocument mergedDoc = new PDDocument();
-	PDDocument mergedDoc = new PDDocument();
-    for (PDDocument doc : documents) {
-        for (PDPage page : doc.getPages()) {
-            mergedDoc.addPage(page);
-        }
-    }
-    return mergedDoc;
-}
-
-private Comparator<MultipartFile> getSortComparator(String sortType) {
-    switch (sortType) {
-        case "byFileName":
-            return Comparator.comparing(MultipartFile::getOriginalFilename);
-        case "byDateModified":
-            return (file1, file2) -> {
-                try {
-                    BasicFileAttributes attr1 = Files.readAttributes(Paths.get(file1.getOriginalFilename()), BasicFileAttributes.class);
-                    BasicFileAttributes attr2 = Files.readAttributes(Paths.get(file2.getOriginalFilename()), BasicFileAttributes.class);
-                    return attr1.lastModifiedTime().compareTo(attr2.lastModifiedTime());
-                } catch (IOException e) {
-                    return 0;  // If there's an error, treat them as equal
-                }
-            };
-        case "byDateCreated":
-            return (file1, file2) -> {
-                try {
-                    BasicFileAttributes attr1 = Files.readAttributes(Paths.get(file1.getOriginalFilename()), BasicFileAttributes.class);
-                    BasicFileAttributes attr2 = Files.readAttributes(Paths.get(file2.getOriginalFilename()), BasicFileAttributes.class);
-                    return attr1.creationTime().compareTo(attr2.creationTime());
-                } catch (IOException e) {
-                    return 0;  // If there's an error, treat them as equal
-                }
-            };
-        case "byPDFTitle":
-            return (file1, file2) -> {
-                try (PDDocument doc1 = PDDocument.load(file1.getInputStream());
-                     PDDocument doc2 = PDDocument.load(file2.getInputStream())) {
-                    String title1 = doc1.getDocumentInformation().getTitle();
-                    String title2 = doc2.getDocumentInformation().getTitle();
-                    return title1.compareTo(title2);
-                } catch (IOException e) {
-                    return 0;
-                }
-            };
-        case "orderProvided":
-        default:
-            return (file1, file2) -> 0;  // Default is the order provided
-    }
-}
-
-@PostMapping(consumes = "multipart/form-data", value = "/merge-pdfs")
-@Operation(summary = "Merge multiple PDF files into one",
-        description = "This endpoint merges multiple PDF files into a single PDF file. The merged file will contain all pages from the input files in the order they were provided. Input:PDF Output:PDF Type:MISO")
-public ResponseEntity<byte[]> mergePdfs(@ModelAttribute MergePdfsRequest form) throws IOException {
-
-	MultipartFile[]  files = form.getFileInput();
-    Arrays.sort(files, getSortComparator(form.getSortType()));
-
-    List<PDDocument> documents = new ArrayList<>();
-    for (MultipartFile file : files) {
-        try (InputStream is = file.getInputStream()) {
-            documents.add(PDDocument.load(is));
-        }
-    }
-
-    try (PDDocument mergedDoc = mergeDocuments(documents)) {
-        ResponseEntity<byte[]> response = WebResponseUtils.pdfDocToWebResponse(mergedDoc, files[0].getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_merged.pdf");
-        return response;
-    } finally {
         for (PDDocument doc : documents) {
-            if (doc != null) {
+            for (PDPage page : doc.getPages()) {
-                doc.close();
+                mergedDoc.addPage(page);
             }
         }
+        return mergedDoc;
+    }
+
+    private Comparator<MultipartFile> getSortComparator(String sortType) {
+        switch (sortType) {
+            case "byFileName":
+                return Comparator.comparing(MultipartFile::getOriginalFilename);
+            case "byDateModified":
+                return (file1, file2) -> {
+                    try {
+                        BasicFileAttributes attr1 =
+                                Files.readAttributes(
+                                        Paths.get(file1.getOriginalFilename()),
+                                        BasicFileAttributes.class);
+                        BasicFileAttributes attr2 =
+                                Files.readAttributes(
+                                        Paths.get(file2.getOriginalFilename()),
+                                        BasicFileAttributes.class);
+                        return attr1.lastModifiedTime().compareTo(attr2.lastModifiedTime());
+                    } catch (IOException e) {
+                        return 0; // If there's an error, treat them as equal
+                    }
+                };
+            case "byDateCreated":
+                return (file1, file2) -> {
+                    try {
+                        BasicFileAttributes attr1 =
+                                Files.readAttributes(
+                                        Paths.get(file1.getOriginalFilename()),
+                                        BasicFileAttributes.class);
+                        BasicFileAttributes attr2 =
+                                Files.readAttributes(
+                                        Paths.get(file2.getOriginalFilename()),
+                                        BasicFileAttributes.class);
+                        return attr1.creationTime().compareTo(attr2.creationTime());
+                    } catch (IOException e) {
+                        return 0; // If there's an error, treat them as equal
+                    }
+                };
+            case "byPDFTitle":
+                return (file1, file2) -> {
+                    try (PDDocument doc1 = PDDocument.load(file1.getInputStream());
+                            PDDocument doc2 = PDDocument.load(file2.getInputStream())) {
+                        String title1 = doc1.getDocumentInformation().getTitle();
+                        String title2 = doc2.getDocumentInformation().getTitle();
+                        return title1.compareTo(title2);
+                    } catch (IOException e) {
+                        return 0;
+                    }
+                };
+            case "orderProvided":
+            default:
+                return (file1, file2) -> 0; // Default is the order provided
+        }
+    }
+
+    @PostMapping(consumes = "multipart/form-data", value = "/merge-pdfs")
+    @Operation(
+            summary = "Merge multiple PDF files into one",
+            description =
+                    "This endpoint merges multiple PDF files into a single PDF file. The merged file will contain all pages from the input files in the order they were provided. Input:PDF Output:PDF Type:MISO")
+    public ResponseEntity<byte[]> mergePdfs(@ModelAttribute MergePdfsRequest form)
+            throws IOException {
+        try {
+            MultipartFile[] files = form.getFileInput();
+            Arrays.sort(files, getSortComparator(form.getSortType()));
+
+            PDFMergerUtility mergedDoc = new PDFMergerUtility();
+            ByteArrayOutputStream docOutputstream = new ByteArrayOutputStream();
+
+            for (MultipartFile file : files) {
+                mergedDoc.addSource(new ByteArrayInputStream(file.getBytes()));
+            }
+
+            mergedDoc.setDestinationFileName(
+                    files[0].getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_merged.pdf");
+            mergedDoc.setDestinationStream(docOutputstream);
+            mergedDoc.mergeDocuments(MemoryUsageSetting.setupMainMemoryOnly());
+
+            return WebResponseUtils.bytesToWebResponse(
+                    docOutputstream.toByteArray(), mergedDoc.getDestinationFileName());
+        } catch (Exception ex) {
+            logger.error("Error in merge pdf process", ex);
+            throw ex;
+        }
     }
 }
-
-}

src/main/java/stirling/software/SPDF/controller/api/MultiPageLayoutController.java

@@ -1,6 +1,5 @@
 package stirling.software.SPDF.controller.api;
 
-
 import java.awt.Color;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -23,6 +22,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.general.MergeMultiplePagesRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -31,94 +31,110 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "General", description = "General APIs")
 public class MultiPageLayoutController {
 
-	private static final Logger logger = LoggerFactory.getLogger(MultiPageLayoutController.class);
+    private static final Logger logger = LoggerFactory.getLogger(MultiPageLayoutController.class);
 
-	@PostMapping(value = "/multi-page-layout", consumes = "multipart/form-data")
+    @PostMapping(value = "/multi-page-layout", consumes = "multipart/form-data")
-	@Operation(
+    @Operation(
-	    summary = "Merge multiple pages of a PDF document into a single page",
+            summary = "Merge multiple pages of a PDF document into a single page",
-	    description = "This operation takes an input PDF file and the number of pages to merge into a single sheet in the output PDF file. Input:PDF Output:PDF Type:SISO"
+            description =
-	)
+                    "This operation takes an input PDF file and the number of pages to merge into a single sheet in the output PDF file. Input:PDF Output:PDF Type:SISO")
-	public ResponseEntity<byte[]> mergeMultiplePagesIntoOne(@ModelAttribute MergeMultiplePagesRequest request)
+    public ResponseEntity<byte[]> mergeMultiplePagesIntoOne(
-	        throws IOException {
+            @ModelAttribute MergeMultiplePagesRequest request) throws IOException {
 
-	    int pagesPerSheet = request.getPagesPerSheet();
+        int pagesPerSheet = request.getPagesPerSheet();
-	    MultipartFile file = request.getFileInput();
+        MultipartFile file = request.getFileInput();
-	    boolean addBorder = request.isAddBorder();
+        boolean addBorder = request.isAddBorder();
-	    
-	    if (pagesPerSheet != 2 && pagesPerSheet != 3 && pagesPerSheet != (int) Math.sqrt(pagesPerSheet) * Math.sqrt(pagesPerSheet)) {
-	        throw new IllegalArgumentException("pagesPerSheet must be 2, 3 or a perfect square");
-	    }
 
-	    int cols = pagesPerSheet == 2 || pagesPerSheet == 3 ? pagesPerSheet : (int) Math.sqrt(pagesPerSheet);
+        if (pagesPerSheet != 2
-	    int rows = pagesPerSheet == 2 || pagesPerSheet == 3 ? 1 : (int) Math.sqrt(pagesPerSheet);
+                && pagesPerSheet != 3
+                && pagesPerSheet != (int) Math.sqrt(pagesPerSheet) * Math.sqrt(pagesPerSheet)) {
+            throw new IllegalArgumentException("pagesPerSheet must be 2, 3 or a perfect square");
+        }
 
-	    PDDocument sourceDocument = PDDocument.load(file.getInputStream());
+        int cols =
-	    PDDocument newDocument = new PDDocument();
+                pagesPerSheet == 2 || pagesPerSheet == 3
-	    PDPage newPage = new PDPage(PDRectangle.A4);
+                        ? pagesPerSheet
-	    newDocument.addPage(newPage);
+                        : (int) Math.sqrt(pagesPerSheet);
+        int rows = pagesPerSheet == 2 || pagesPerSheet == 3 ? 1 : (int) Math.sqrt(pagesPerSheet);
 
-	    int totalPages = sourceDocument.getNumberOfPages();
+        PDDocument sourceDocument = PDDocument.load(file.getInputStream());
-	    float cellWidth = newPage.getMediaBox().getWidth() / cols;
+        PDDocument newDocument = new PDDocument();
-	    float cellHeight = newPage.getMediaBox().getHeight() / rows;
+        PDPage newPage = new PDPage(PDRectangle.A4);
+        newDocument.addPage(newPage);
 
-	    PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage, PDPageContentStream.AppendMode.APPEND, true, true);
+        int totalPages = sourceDocument.getNumberOfPages();
-	    LayerUtility layerUtility = new LayerUtility(newDocument);
+        float cellWidth = newPage.getMediaBox().getWidth() / cols;
+        float cellHeight = newPage.getMediaBox().getHeight() / rows;
 
-	    float borderThickness = 1.5f; // Specify border thickness as required
+        PDPageContentStream contentStream =
-	    contentStream.setLineWidth(borderThickness);
+                new PDPageContentStream(
-	    contentStream.setStrokingColor(Color.BLACK);
+                        newDocument, newPage, PDPageContentStream.AppendMode.APPEND, true, true);
-	    
+        LayerUtility layerUtility = new LayerUtility(newDocument);
-	    for (int i = 0; i < totalPages; i++) {
-	        if (i != 0 && i % pagesPerSheet == 0) {
-	            // Close the current content stream and create a new page and content stream
-	            contentStream.close();
-	            newPage = new PDPage(PDRectangle.A4);
-	            newDocument.addPage(newPage);
-	            contentStream = new PDPageContentStream(newDocument, newPage, PDPageContentStream.AppendMode.APPEND, true, true);
-	        }
 
-	        PDPage sourcePage = sourceDocument.getPage(i);
+        float borderThickness = 1.5f; // Specify border thickness as required
-	        PDRectangle rect = sourcePage.getMediaBox();
+        contentStream.setLineWidth(borderThickness);
-	        float scaleWidth = cellWidth / rect.getWidth();
+        contentStream.setStrokingColor(Color.BLACK);
-	        float scaleHeight = cellHeight / rect.getHeight();
-	        float scale = Math.min(scaleWidth, scaleHeight);
 
-	        int adjustedPageIndex = i % pagesPerSheet;  // This will reset the index for every new page
+        for (int i = 0; i < totalPages; i++) {
-	        int rowIndex = adjustedPageIndex / cols;
+            if (i != 0 && i % pagesPerSheet == 0) {
-	        int colIndex = adjustedPageIndex % cols;
+                // Close the current content stream and create a new page and content stream
+                contentStream.close();
+                newPage = new PDPage(PDRectangle.A4);
+                newDocument.addPage(newPage);
+                contentStream =
+                        new PDPageContentStream(
+                                newDocument,
+                                newPage,
+                                PDPageContentStream.AppendMode.APPEND,
+                                true,
+                                true);
+            }
 
-	        float x = colIndex * cellWidth + (cellWidth - rect.getWidth() * scale) / 2;
+            PDPage sourcePage = sourceDocument.getPage(i);
-	        float y = newPage.getMediaBox().getHeight() - ((rowIndex + 1) * cellHeight - (cellHeight - rect.getHeight() * scale) / 2);
+            PDRectangle rect = sourcePage.getMediaBox();
+            float scaleWidth = cellWidth / rect.getWidth();
+            float scaleHeight = cellHeight / rect.getHeight();
+            float scale = Math.min(scaleWidth, scaleHeight);
 
-	        contentStream.saveGraphicsState();
+            int adjustedPageIndex =
-	        contentStream.transform(Matrix.getTranslateInstance(x, y));
+                    i % pagesPerSheet; // This will reset the index for every new page
-	        contentStream.transform(Matrix.getScaleInstance(scale, scale));
+            int rowIndex = adjustedPageIndex / cols;
+            int colIndex = adjustedPageIndex % cols;
 
-	        PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
+            float x = colIndex * cellWidth + (cellWidth - rect.getWidth() * scale) / 2;
-	        contentStream.drawForm(formXObject);
+            float y =
+                    newPage.getMediaBox().getHeight()
+                            - ((rowIndex + 1) * cellHeight
+                                    - (cellHeight - rect.getHeight() * scale) / 2);
 
-	        contentStream.restoreGraphicsState();
+            contentStream.saveGraphicsState();
-	        
+            contentStream.transform(Matrix.getTranslateInstance(x, y));
-	        if(addBorder) {
+            contentStream.transform(Matrix.getScaleInstance(scale, scale));
-		        // Draw border around each page
-		        float borderX = colIndex * cellWidth;
-		        float borderY = newPage.getMediaBox().getHeight() - (rowIndex + 1) * cellHeight;
-		        contentStream.addRect(borderX, borderY, cellWidth, cellHeight);
-		        contentStream.stroke();
-	        }
-	    }
 
+            PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
+            contentStream.drawForm(formXObject);
 
-	    contentStream.close(); // Close the final content stream
+            contentStream.restoreGraphicsState();
-	    sourceDocument.close();
 
-	    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+            if (addBorder) {
-	    newDocument.save(baos);
+                // Draw border around each page
-	    newDocument.close();
+                float borderX = colIndex * cellWidth;
+                float borderY = newPage.getMediaBox().getHeight() - (rowIndex + 1) * cellHeight;
+                contentStream.addRect(borderX, borderY, cellWidth, cellHeight);
+                contentStream.stroke();
+            }
+        }
 
-	    byte[] result = baos.toByteArray();
+        contentStream.close(); // Close the final content stream
-	    return WebResponseUtils.bytesToWebResponse(result, file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_layoutChanged.pdf");
+        sourceDocument.close();
-	}
 
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        newDocument.save(baos);
+        newDocument.close();
 
+        byte[] result = baos.toByteArray();
+        return WebResponseUtils.bytesToWebResponse(
+                result,
+                file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_layoutChanged.pdf");
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/PdfOverlayController.java

@@ -0,0 +1,198 @@
+package stirling.software.SPDF.controller.api;
+
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.pdfbox.multipdf.Overlay;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import stirling.software.SPDF.model.api.general.OverlayPdfsRequest;
+import stirling.software.SPDF.utils.GeneralUtils;
+import stirling.software.SPDF.utils.WebResponseUtils;
+
+@RestController
+@RequestMapping("/api/v1/general")
+@Tag(name = "General", description = "General APIs")
+public class PdfOverlayController {
+
+    @PostMapping(value = "/overlay-pdfs", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Overlay PDF files in various modes",
+            description =
+                    "Overlay PDF files onto a base PDF with different modes: Sequential, Interleaved, or Fixed Repeat. Input:PDF Output:PDF Type:MIMO")
+    public ResponseEntity<byte[]> overlayPdfs(@ModelAttribute OverlayPdfsRequest request)
+            throws IOException {
+        MultipartFile baseFile = request.getFileInput();
+        int overlayPos = request.getOverlayPosition();
+
+        MultipartFile[] overlayFiles = request.getOverlayFiles();
+        File[] overlayPdfFiles = new File[overlayFiles.length];
+        List<File> tempFiles = new ArrayList<>(); // List to keep track of temporary files
+
+        try {
+            for (int i = 0; i < overlayFiles.length; i++) {
+                overlayPdfFiles[i] = GeneralUtils.multipartToFile(overlayFiles[i]);
+            }
+
+            String mode = request.getOverlayMode(); // "SequentialOverlay", "InterleavedOverlay",
+            // "FixedRepeatOverlay"
+            int[] counts = request.getCounts(); // Used for FixedRepeatOverlay mode
+
+            try (PDDocument basePdf = PDDocument.load(baseFile.getInputStream());
+                    Overlay overlay = new Overlay()) {
+                Map<Integer, String> overlayGuide =
+                        prepareOverlayGuide(
+                                basePdf.getNumberOfPages(),
+                                overlayPdfFiles,
+                                mode,
+                                counts,
+                                tempFiles);
+
+                overlay.setInputPDF(basePdf);
+                if (overlayPos == 0) {
+                    overlay.setOverlayPosition(Overlay.Position.FOREGROUND);
+                } else {
+                    overlay.setOverlayPosition(Overlay.Position.BACKGROUND);
+                }
+
+                ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+                overlay.overlay(overlayGuide).save(outputStream);
+                byte[] data = outputStream.toByteArray();
+                String outputFilename =
+                        baseFile.getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                                + "_overlayed.pdf"; // Remove file extension and append .pdf
+
+                return WebResponseUtils.bytesToWebResponse(
+                        data, outputFilename, MediaType.APPLICATION_PDF);
+            }
+        } finally {
+            for (File overlayPdfFile : overlayPdfFiles) {
+                if (overlayPdfFile != null) {
+                    overlayPdfFile.delete();
+                }
+            }
+            for (File tempFile : tempFiles) { // Delete temporary files
+                if (tempFile != null) {
+                    tempFile.delete();
+                }
+            }
+        }
+    }
+
+    private Map<Integer, String> prepareOverlayGuide(
+            int basePageCount, File[] overlayFiles, String mode, int[] counts, List<File> tempFiles)
+            throws IOException {
+        Map<Integer, String> overlayGuide = new HashMap<>();
+        switch (mode) {
+            case "SequentialOverlay":
+                sequentialOverlay(overlayGuide, overlayFiles, basePageCount, tempFiles);
+                break;
+            case "InterleavedOverlay":
+                interleavedOverlay(overlayGuide, overlayFiles, basePageCount);
+                break;
+            case "FixedRepeatOverlay":
+                fixedRepeatOverlay(overlayGuide, overlayFiles, counts, basePageCount);
+                break;
+            default:
+                throw new IllegalArgumentException("Invalid overlay mode");
+        }
+        return overlayGuide;
+    }
+
+    private void sequentialOverlay(
+            Map<Integer, String> overlayGuide,
+            File[] overlayFiles,
+            int basePageCount,
+            List<File> tempFiles)
+            throws IOException {
+        int overlayFileIndex = 0;
+        int pageCountInCurrentOverlay = 0;
+
+        for (int basePageIndex = 1; basePageIndex <= basePageCount; basePageIndex++) {
+            if (pageCountInCurrentOverlay == 0
+                    || pageCountInCurrentOverlay
+                            >= getNumberOfPages(overlayFiles[overlayFileIndex])) {
+                pageCountInCurrentOverlay = 0;
+                overlayFileIndex = (overlayFileIndex + 1) % overlayFiles.length;
+            }
+
+            try (PDDocument overlayPdf = PDDocument.load(overlayFiles[overlayFileIndex])) {
+                PDDocument singlePageDocument = new PDDocument();
+                singlePageDocument.addPage(overlayPdf.getPage(pageCountInCurrentOverlay));
+                File tempFile = File.createTempFile("overlay-page-", ".pdf");
+                singlePageDocument.save(tempFile);
+                singlePageDocument.close();
+
+                overlayGuide.put(basePageIndex, tempFile.getAbsolutePath());
+                tempFiles.add(tempFile); // Keep track of the temporary file for cleanup
+            }
+
+            pageCountInCurrentOverlay++;
+        }
+    }
+
+    private int getNumberOfPages(File file) throws IOException {
+        try (PDDocument doc = PDDocument.load(file)) {
+            return doc.getNumberOfPages();
+        }
+    }
+
+    private void interleavedOverlay(
+            Map<Integer, String> overlayGuide, File[] overlayFiles, int basePageCount)
+            throws IOException {
+        for (int basePageIndex = 1; basePageIndex <= basePageCount; basePageIndex++) {
+            File overlayFile = overlayFiles[(basePageIndex - 1) % overlayFiles.length];
+
+            // Load the overlay document to check its page count
+            try (PDDocument overlayPdf = PDDocument.load(overlayFile)) {
+                int overlayPageCount = overlayPdf.getNumberOfPages();
+                if ((basePageIndex - 1) % overlayPageCount < overlayPageCount) {
+                    overlayGuide.put(basePageIndex, overlayFile.getAbsolutePath());
+                }
+            }
+        }
+    }
+
+    private void fixedRepeatOverlay(
+            Map<Integer, String> overlayGuide, File[] overlayFiles, int[] counts, int basePageCount)
+            throws IOException {
+        if (overlayFiles.length != counts.length) {
+            throw new IllegalArgumentException(
+                    "Counts array length must match the number of overlay files");
+        }
+        int currentPage = 1;
+        for (int i = 0; i < overlayFiles.length; i++) {
+            File overlayFile = overlayFiles[i];
+            int repeatCount = counts[i];
+
+            // Load the overlay document to check its page count
+            try (PDDocument overlayPdf = PDDocument.load(overlayFile)) {
+                int overlayPageCount = overlayPdf.getNumberOfPages();
+                for (int j = 0; j < repeatCount; j++) {
+                    for (int page = 0; page < overlayPageCount; page++) {
+                        if (currentPage > basePageCount) break;
+                        overlayGuide.put(currentPage++, overlayFile.getAbsolutePath());
+                    }
+                }
+            }
+        }
+    }
+}
+
+// Additional classes like OverlayPdfsRequest, WebResponseUtils, etc. are assumed to be defined
+// elsewhere.

src/main/java/stirling/software/SPDF/controller/api/RearrangePagesPDFController.java

@@ -12,208 +12,209 @@ import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RequestPart;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.SortTypes;
 import stirling.software.SPDF.model.api.PDFWithPageNums;
 import stirling.software.SPDF.model.api.general.RearrangePagesRequest;
 import stirling.software.SPDF.utils.GeneralUtils;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/general")
 @Tag(name = "General", description = "General APIs")
 public class RearrangePagesPDFController {
 
-	private static final Logger logger = LoggerFactory.getLogger(RearrangePagesPDFController.class);
+    private static final Logger logger = LoggerFactory.getLogger(RearrangePagesPDFController.class);
 
-	@PostMapping(consumes = "multipart/form-data", value = "/remove-pages")
+    @PostMapping(consumes = "multipart/form-data", value = "/remove-pages")
-	@Operation(summary = "Remove pages from a PDF file", description = "This endpoint removes specified pages from a given PDF file. Users can provide a comma-separated list of page numbers or ranges to delete. Input:PDF Output:PDF Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> deletePages(@ModelAttribute PDFWithPageNums request )
+            summary = "Remove pages from a PDF file",
-			throws IOException {
+            description =
+                    "This endpoint removes specified pages from a given PDF file. Users can provide a comma-separated list of page numbers or ranges to delete. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> deletePages(@ModelAttribute PDFWithPageNums request)
+            throws IOException {
 
-		MultipartFile pdfFile = request.getFileInput();
+        MultipartFile pdfFile = request.getFileInput();
-		String pagesToDelete = request.getPageNumbers();
+        String pagesToDelete = request.getPageNumbers();
-		
-		PDDocument document = PDDocument.load(pdfFile.getBytes());
 
-		// Split the page order string into an array of page numbers or range of numbers
+        PDDocument document = PDDocument.load(pdfFile.getBytes());
-		String[] pageOrderArr = pagesToDelete.split(",");
 
-		List<Integer> pagesToRemove = GeneralUtils.parsePageList(pageOrderArr, document.getNumberOfPages());
+        // Split the page order string into an array of page numbers or range of numbers
+        String[] pageOrderArr = pagesToDelete.split(",");
 
-		for (int i = pagesToRemove.size() - 1; i >= 0; i--) {
+        List<Integer> pagesToRemove =
-			int pageIndex = pagesToRemove.get(i);
+                GeneralUtils.parsePageList(pageOrderArr, document.getNumberOfPages());
-			document.removePage(pageIndex);
-		}
-		return WebResponseUtils.pdfDocToWebResponse(document,
-				pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_removed_pages.pdf");
 
-	}
+        for (int i = pagesToRemove.size() - 1; i >= 0; i--) {
-
+            int pageIndex = pagesToRemove.get(i);
-	
+            document.removePage(pageIndex);
-
+        }
-	private List<Integer> removeFirst(int totalPages) {
+        return WebResponseUtils.pdfDocToWebResponse(
-		if (totalPages <= 1)
+                document,
-			return new ArrayList<>();
+                pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_removed_pages.pdf");
-		List<Integer> newPageOrder = new ArrayList<>();
-		for (int i = 2; i <= totalPages; i++) {
-			newPageOrder.add(i - 1);
-		}
-		return newPageOrder;
-	}
-
-	private List<Integer> removeLast(int totalPages) {
-		if (totalPages <= 1)
-			return new ArrayList<>();
-		List<Integer> newPageOrder = new ArrayList<>();
-		for (int i = 1; i < totalPages; i++) {
-			newPageOrder.add(i - 1);
-		}
-		return newPageOrder;
-	}
-
-	private List<Integer> removeFirstAndLast(int totalPages) {
-		if (totalPages <= 2)
-			return new ArrayList<>();
-		List<Integer> newPageOrder = new ArrayList<>();
-		for (int i = 2; i < totalPages; i++) {
-			newPageOrder.add(i - 1);
-		}
-		return newPageOrder;
-	}
-
-	private List<Integer> reverseOrder(int totalPages) {
-		List<Integer> newPageOrder = new ArrayList<>();
-		for (int i = totalPages; i >= 1; i--) {
-			newPageOrder.add(i - 1);
-		}
-		return newPageOrder;
-	}
-
-	private List<Integer> duplexSort(int totalPages) {
-		List<Integer> newPageOrder = new ArrayList<>();
-		int half = (totalPages + 1) / 2; // This ensures proper behavior with odd numbers of pages
-		for (int i = 1; i <= half; i++) {
-			newPageOrder.add(i - 1);
-			if (i <= totalPages - half) { // Avoid going out of bounds
-				newPageOrder.add(totalPages - i);
-			}
-		}
-		return newPageOrder;
-	}
-
-	private List<Integer> bookletSort(int totalPages) {
-		List<Integer> newPageOrder = new ArrayList<>();
-		for (int i = 0; i < totalPages / 2; i++) {
-			newPageOrder.add(i);
-			newPageOrder.add(totalPages - i - 1);
-		}
-		return newPageOrder;
-	}
-
-	private List<Integer> sideStitchBooklet(int totalPages) {
-		List<Integer> newPageOrder = new ArrayList<>();
-		for (int i = 0; i < (totalPages + 3) / 4; i++) {
-			int begin = i * 4;
-			newPageOrder.add(Math.min(begin + 3, totalPages - 1));
-			newPageOrder.add(Math.min(begin, totalPages - 1));
-			newPageOrder.add(Math.min(begin + 1, totalPages - 1));
-			newPageOrder.add(Math.min(begin + 2, totalPages - 1));
-		}
-		return newPageOrder;
     }
 
-	private List<Integer> oddEvenSplit(int totalPages) {
+    private List<Integer> removeFirst(int totalPages) {
-		List<Integer> newPageOrder = new ArrayList<>();
+        if (totalPages <= 1) return new ArrayList<>();
-		for (int i = 1; i <= totalPages; i += 2) {
+        List<Integer> newPageOrder = new ArrayList<>();
-			newPageOrder.add(i - 1);
+        for (int i = 2; i <= totalPages; i++) {
-		}
+            newPageOrder.add(i - 1);
-		for (int i = 2; i <= totalPages; i += 2) {
+        }
-			newPageOrder.add(i - 1);
+        return newPageOrder;
-		}
+    }
-		return newPageOrder;
-	}
 
-	private List<Integer> processSortTypes(String sortTypes, int totalPages) {
+    private List<Integer> removeLast(int totalPages) {
-		try {
+        if (totalPages <= 1) return new ArrayList<>();
-			SortTypes mode = SortTypes.valueOf(sortTypes.toUpperCase());
+        List<Integer> newPageOrder = new ArrayList<>();
-			switch (mode) {
+        for (int i = 1; i < totalPages; i++) {
-			case REVERSE_ORDER:
+            newPageOrder.add(i - 1);
-				return reverseOrder(totalPages);
+        }
-			case DUPLEX_SORT:
+        return newPageOrder;
-				return duplexSort(totalPages);
+    }
-			case BOOKLET_SORT:
-				return bookletSort(totalPages);
-			case SIDE_STITCH_BOOKLET_SORT:
-				return sideStitchBooklet(totalPages);
-			case ODD_EVEN_SPLIT:
-				return oddEvenSplit(totalPages);
-			case REMOVE_FIRST:
-				return removeFirst(totalPages);
-			case REMOVE_LAST:
-				return removeLast(totalPages);
-			case REMOVE_FIRST_AND_LAST:
-				return removeFirstAndLast(totalPages);
-			default:
-				throw new IllegalArgumentException("Unsupported custom mode");
-			}
-		} catch (IllegalArgumentException e) {
-			logger.error("Unsupported custom mode", e);
-			return null;
-		}
-	}
 
-	@PostMapping(consumes = "multipart/form-data", value = "/rearrange-pages")
+    private List<Integer> removeFirstAndLast(int totalPages) {
-	@Operation(summary = "Rearrange pages in a PDF file", description = "This endpoint rearranges pages in a given PDF file based on the specified page order or custom mode. Users can provide a page order as a comma-separated list of page numbers or page ranges, or a custom mode. Input:PDF Output:PDF")
+        if (totalPages <= 2) return new ArrayList<>();
-	public ResponseEntity<byte[]> rearrangePages(@ModelAttribute RearrangePagesRequest request) throws IOException {
+        List<Integer> newPageOrder = new ArrayList<>();
-	    MultipartFile pdfFile = request.getFileInput();
+        for (int i = 2; i < totalPages; i++) {
-	    String pageOrder = request.getPageNumbers();
+            newPageOrder.add(i - 1);
-	    String sortType = request.getCustomMode();
+        }
-		try {
+        return newPageOrder;
-			// Load the input PDF
+    }
-			PDDocument document = PDDocument.load(pdfFile.getInputStream());
 
-			// Split the page order string into an array of page numbers or range of numbers
+    private List<Integer> reverseOrder(int totalPages) {
-			String[] pageOrderArr = pageOrder != null ? pageOrder.split(",") : new String[0];
+        List<Integer> newPageOrder = new ArrayList<>();
-			int totalPages = document.getNumberOfPages();
+        for (int i = totalPages; i >= 1; i--) {
-			List<Integer> newPageOrder;
+            newPageOrder.add(i - 1);
-			if (sortType != null && sortType.length() > 0) {
+        }
-				newPageOrder = processSortTypes(sortType, totalPages);
+        return newPageOrder;
-			} else {
+    }
-				newPageOrder = GeneralUtils.parsePageList(pageOrderArr, totalPages);
-			}
-			logger.info("newPageOrder = "  +newPageOrder);
-			logger.info("totalPages = "  +totalPages);
-			// Create a new list to hold the pages in the new order
-			List<PDPage> newPages = new ArrayList<>();
-			for (int i = 0; i < newPageOrder.size(); i++) {
-				newPages.add(document.getPage(newPageOrder.get(i)));
-			}
 
-			// Remove all the pages from the original document
+    private List<Integer> duplexSort(int totalPages) {
-			for (int i = document.getNumberOfPages() - 1; i >= 0; i--) {
+        List<Integer> newPageOrder = new ArrayList<>();
-				document.removePage(i);
+        int half = (totalPages + 1) / 2; // This ensures proper behavior with odd numbers of pages
-			}
+        for (int i = 1; i <= half; i++) {
+            newPageOrder.add(i - 1);
+            if (i <= totalPages - half) { // Avoid going out of bounds
+                newPageOrder.add(totalPages - i);
+            }
+        }
+        return newPageOrder;
+    }
 
-			// Add the pages in the new order
+    private List<Integer> bookletSort(int totalPages) {
-			for (PDPage page : newPages) {
+        List<Integer> newPageOrder = new ArrayList<>();
-				document.addPage(page);
+        for (int i = 0; i < totalPages / 2; i++) {
-			}
+            newPageOrder.add(i);
+            newPageOrder.add(totalPages - i - 1);
+        }
+        return newPageOrder;
+    }
 
-			return WebResponseUtils.pdfDocToWebResponse(document,
+    private List<Integer> sideStitchBooklet(int totalPages) {
-					pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_rearranged.pdf");
+        List<Integer> newPageOrder = new ArrayList<>();
-		} catch (IOException e) {
+        for (int i = 0; i < (totalPages + 3) / 4; i++) {
-			logger.error("Failed rearranging documents", e);
+            int begin = i * 4;
-			return null;
+            newPageOrder.add(Math.min(begin + 3, totalPages - 1));
-		}
+            newPageOrder.add(Math.min(begin, totalPages - 1));
-	}
+            newPageOrder.add(Math.min(begin + 1, totalPages - 1));
+            newPageOrder.add(Math.min(begin + 2, totalPages - 1));
+        }
+        return newPageOrder;
+    }
 
-	
+    private List<Integer> oddEvenSplit(int totalPages) {
+        List<Integer> newPageOrder = new ArrayList<>();
+        for (int i = 1; i <= totalPages; i += 2) {
+            newPageOrder.add(i - 1);
+        }
+        for (int i = 2; i <= totalPages; i += 2) {
+            newPageOrder.add(i - 1);
+        }
+        return newPageOrder;
+    }
 
+    private List<Integer> processSortTypes(String sortTypes, int totalPages) {
+        try {
+            SortTypes mode = SortTypes.valueOf(sortTypes.toUpperCase());
+            switch (mode) {
+                case REVERSE_ORDER:
+                    return reverseOrder(totalPages);
+                case DUPLEX_SORT:
+                    return duplexSort(totalPages);
+                case BOOKLET_SORT:
+                    return bookletSort(totalPages);
+                case SIDE_STITCH_BOOKLET_SORT:
+                    return sideStitchBooklet(totalPages);
+                case ODD_EVEN_SPLIT:
+                    return oddEvenSplit(totalPages);
+                case REMOVE_FIRST:
+                    return removeFirst(totalPages);
+                case REMOVE_LAST:
+                    return removeLast(totalPages);
+                case REMOVE_FIRST_AND_LAST:
+                    return removeFirstAndLast(totalPages);
+                default:
+                    throw new IllegalArgumentException("Unsupported custom mode");
+            }
+        } catch (IllegalArgumentException e) {
+            logger.error("Unsupported custom mode", e);
+            return null;
+        }
+    }
+
+    @PostMapping(consumes = "multipart/form-data", value = "/rearrange-pages")
+    @Operation(
+            summary = "Rearrange pages in a PDF file",
+            description =
+                    "This endpoint rearranges pages in a given PDF file based on the specified page order or custom mode. Users can provide a page order as a comma-separated list of page numbers or page ranges, or a custom mode. Input:PDF Output:PDF")
+    public ResponseEntity<byte[]> rearrangePages(@ModelAttribute RearrangePagesRequest request)
+            throws IOException {
+        MultipartFile pdfFile = request.getFileInput();
+        String pageOrder = request.getPageNumbers();
+        String sortType = request.getCustomMode();
+        try {
+            // Load the input PDF
+            PDDocument document = PDDocument.load(pdfFile.getInputStream());
+
+            // Split the page order string into an array of page numbers or range of numbers
+            String[] pageOrderArr = pageOrder != null ? pageOrder.split(",") : new String[0];
+            int totalPages = document.getNumberOfPages();
+            List<Integer> newPageOrder;
+            if (sortType != null && sortType.length() > 0) {
+                newPageOrder = processSortTypes(sortType, totalPages);
+            } else {
+                newPageOrder = GeneralUtils.parsePageList(pageOrderArr, totalPages);
+            }
+            logger.info("newPageOrder = " + newPageOrder);
+            logger.info("totalPages = " + totalPages);
+            // Create a new list to hold the pages in the new order
+            List<PDPage> newPages = new ArrayList<>();
+            for (int i = 0; i < newPageOrder.size(); i++) {
+                newPages.add(document.getPage(newPageOrder.get(i)));
+            }
+
+            // Remove all the pages from the original document
+            for (int i = document.getNumberOfPages() - 1; i >= 0; i--) {
+                document.removePage(i);
+            }
+
+            // Add the pages in the new order
+            for (PDPage page : newPages) {
+                document.addPage(page);
+            }
+
+            return WebResponseUtils.pdfDocToWebResponse(
+                    document,
+                    pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                            + "_rearranged.pdf");
+        } catch (IOException e) {
+            logger.error("Failed rearranging documents", e);
+            return null;
+        }
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/RotationController.java

@@ -16,6 +16,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.general.RotatePDFRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -28,11 +29,11 @@ public class RotationController {
 
     @PostMapping(consumes = "multipart/form-data", value = "/rotate-pdf")
     @Operation(
-        summary = "Rotate a PDF file",
+            summary = "Rotate a PDF file",
-        description = "This endpoint rotates a given PDF file by a specified angle. The angle must be a multiple of 90. Input:PDF Output:PDF Type:SISO"
+            description =
-    )
+                    "This endpoint rotates a given PDF file by a specified angle. The angle must be a multiple of 90. Input:PDF Output:PDF Type:SISO")
-    public ResponseEntity<byte[]> rotatePDF(
+    public ResponseEntity<byte[]> rotatePDF(@ModelAttribute RotatePDFRequest request)
-    		@ModelAttribute RotatePDFRequest request) throws IOException {
+            throws IOException {
         MultipartFile pdfFile = request.getFileInput();
         Integer angle = request.getAngle();
         // Load the PDF document
@@ -45,8 +46,8 @@ public class RotationController {
             page.setRotation(page.getRotation() + angle);
         }
 
-        return WebResponseUtils.pdfDocToWebResponse(document, pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_rotated.pdf");
+        return WebResponseUtils.pdfDocToWebResponse(
-
+                document,
+                pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_rotated.pdf");
     }
-
 }

src/main/java/stirling/software/SPDF/controller/api/ScalePagesController.java

@@ -23,88 +23,90 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.general.ScalePagesRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/general")
 @Tag(name = "General", description = "General APIs")
 public class ScalePagesController {
 
-	private static final Logger logger = LoggerFactory.getLogger(ScalePagesController.class);
+    private static final Logger logger = LoggerFactory.getLogger(ScalePagesController.class);
 
-	@PostMapping(value = "/scale-pages", consumes = "multipart/form-data")
+    @PostMapping(value = "/scale-pages", consumes = "multipart/form-data")
-	@Operation(summary = "Change the size of a PDF page/document", description = "This operation takes an input PDF file and the size to scale the pages to in the output PDF file. Input:PDF Output:PDF Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> scalePages(@ModelAttribute ScalePagesRequest request) throws IOException {
+            summary = "Change the size of a PDF page/document",
-	    MultipartFile file = request.getFileInput();
+            description =
-	    String targetPDRectangle = request.getPageSize();
+                    "This operation takes an input PDF file and the size to scale the pages to in the output PDF file. Input:PDF Output:PDF Type:SISO")
-	    float scaleFactor = request.getScaleFactor();
+    public ResponseEntity<byte[]> scalePages(@ModelAttribute ScalePagesRequest request)
+            throws IOException {
+        MultipartFile file = request.getFileInput();
+        String targetPDRectangle = request.getPageSize();
+        float scaleFactor = request.getScaleFactor();
 
-		Map<String, PDRectangle> sizeMap = new HashMap<>();
+        Map<String, PDRectangle> sizeMap = new HashMap<>();
-		// Add A0 - A10
+        // Add A0 - A10
-		sizeMap.put("A0", PDRectangle.A0);
+        sizeMap.put("A0", PDRectangle.A0);
-		sizeMap.put("A1", PDRectangle.A1);
+        sizeMap.put("A1", PDRectangle.A1);
-		sizeMap.put("A2", PDRectangle.A2);
+        sizeMap.put("A2", PDRectangle.A2);
-		sizeMap.put("A3", PDRectangle.A3);
+        sizeMap.put("A3", PDRectangle.A3);
-		sizeMap.put("A4", PDRectangle.A4);
+        sizeMap.put("A4", PDRectangle.A4);
-		sizeMap.put("A5", PDRectangle.A5);
+        sizeMap.put("A5", PDRectangle.A5);
-		sizeMap.put("A6", PDRectangle.A6);
+        sizeMap.put("A6", PDRectangle.A6);
 
-		// Add other sizes
+        // Add other sizes
-		sizeMap.put("LETTER", PDRectangle.LETTER);
+        sizeMap.put("LETTER", PDRectangle.LETTER);
-		sizeMap.put("LEGAL", PDRectangle.LEGAL);
+        sizeMap.put("LEGAL", PDRectangle.LEGAL);
 
-		if (!sizeMap.containsKey(targetPDRectangle)) {
+        if (!sizeMap.containsKey(targetPDRectangle)) {
-			throw new IllegalArgumentException(
+            throw new IllegalArgumentException(
-					"Invalid PDRectangle. It must be one of the following: A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10");
+                    "Invalid PDRectangle. It must be one of the following: A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10");
-		}
+        }
 
-		PDRectangle targetSize = sizeMap.get(targetPDRectangle);
+        PDRectangle targetSize = sizeMap.get(targetPDRectangle);
 
-	    PDDocument sourceDocument = PDDocument.load(file.getBytes());
+        PDDocument sourceDocument = PDDocument.load(file.getBytes());
-	    PDDocument outputDocument = new PDDocument();
+        PDDocument outputDocument = new PDDocument();
 
-	    int totalPages = sourceDocument.getNumberOfPages();
+        int totalPages = sourceDocument.getNumberOfPages();
-	    for (int i = 0; i < totalPages; i++) {
+        for (int i = 0; i < totalPages; i++) {
-	        PDPage sourcePage = sourceDocument.getPage(i);
+            PDPage sourcePage = sourceDocument.getPage(i);
-	        PDRectangle sourceSize = sourcePage.getMediaBox();
+            PDRectangle sourceSize = sourcePage.getMediaBox();
-	        
-	        float scaleWidth = targetSize.getWidth() / sourceSize.getWidth();
-	        float scaleHeight = targetSize.getHeight() / sourceSize.getHeight();
-	        float scale = Math.min(scaleWidth, scaleHeight) * scaleFactor;
-	        
-	        PDPage newPage = new PDPage(targetSize);
-	        outputDocument.addPage(newPage);
-	        
-	        PDPageContentStream contentStream = new PDPageContentStream(outputDocument, newPage, PDPageContentStream.AppendMode.APPEND, true);
-	        
-	        float x = (targetSize.getWidth() - sourceSize.getWidth() * scale) / 2;
-	        float y = (targetSize.getHeight() - sourceSize.getHeight() * scale) / 2;
-	        
-	        contentStream.saveGraphicsState();
-	        contentStream.transform(Matrix.getTranslateInstance(x, y));
-	        contentStream.transform(Matrix.getScaleInstance(scale, scale));
-	        
-	        LayerUtility layerUtility = new LayerUtility(outputDocument);
-	        PDFormXObject form = layerUtility.importPageAsForm(sourceDocument, i);
-	        contentStream.drawForm(form);
 
-	        contentStream.restoreGraphicsState();
+            float scaleWidth = targetSize.getWidth() / sourceSize.getWidth();
-	        contentStream.close();
+            float scaleHeight = targetSize.getHeight() / sourceSize.getHeight();
-	    }
+            float scale = Math.min(scaleWidth, scaleHeight) * scaleFactor;
 
+            PDPage newPage = new PDPage(targetSize);
+            outputDocument.addPage(newPage);
 
+            PDPageContentStream contentStream =
+                    new PDPageContentStream(
+                            outputDocument, newPage, PDPageContentStream.AppendMode.APPEND, true);
 
+            float x = (targetSize.getWidth() - sourceSize.getWidth() * scale) / 2;
+            float y = (targetSize.getHeight() - sourceSize.getHeight() * scale) / 2;
 
+            contentStream.saveGraphicsState();
+            contentStream.transform(Matrix.getTranslateInstance(x, y));
+            contentStream.transform(Matrix.getScaleInstance(scale, scale));
 
-	    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+            LayerUtility layerUtility = new LayerUtility(outputDocument);
-	    outputDocument.save(baos);
+            PDFormXObject form = layerUtility.importPageAsForm(sourceDocument, i);
-	    outputDocument.close();
+            contentStream.drawForm(form);
-	    sourceDocument.close();
-	    
-	    
-		return WebResponseUtils.bytesToWebResponse(baos.toByteArray(),
-				file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_scaled.pdf");
-	}
 
+            contentStream.restoreGraphicsState();
+            contentStream.close();
+        }
 
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        outputDocument.save(baos);
+        outputDocument.close();
+        sourceDocument.close();
+
+        return WebResponseUtils.bytesToWebResponse(
+                baos.toByteArray(),
+                file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_scaled.pdf");
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/SplitPDFController.java

@@ -25,6 +25,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.PDFWithPageNums;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -36,19 +37,24 @@ public class SplitPDFController {
     private static final Logger logger = LoggerFactory.getLogger(SplitPDFController.class);
 
     @PostMapping(consumes = "multipart/form-data", value = "/split-pages")
-    @Operation(summary = "Split a PDF file into separate documents",
+    @Operation(
-            description = "This endpoint splits a given PDF file into separate documents based on the specified page numbers or ranges. Users can specify pages using individual numbers, ranges, or 'all' for every page. Input:PDF Output:PDF Type:SIMO")
+            summary = "Split a PDF file into separate documents",
-    public ResponseEntity<byte[]> splitPdf(@ModelAttribute PDFWithPageNums request) throws IOException {
+            description =
-    	MultipartFile file = request.getFileInput();
+                    "This endpoint splits a given PDF file into separate documents based on the specified page numbers or ranges. Users can specify pages using individual numbers, ranges, or 'all' for every page. Input:PDF Output:PDF Type:SIMO")
+    public ResponseEntity<byte[]> splitPdf(@ModelAttribute PDFWithPageNums request)
+            throws IOException {
+        MultipartFile file = request.getFileInput();
         String pages = request.getPageNumbers();
         // open the pdf document
         InputStream inputStream = file.getInputStream();
         PDDocument document = PDDocument.load(inputStream);
 
         List<Integer> pageNumbers = request.getPageNumbersList(document);
-        if(!pageNumbers.contains(document.getNumberOfPages() - 1))
+        if (!pageNumbers.contains(document.getNumberOfPages() - 1))
-        	pageNumbers.add(document.getNumberOfPages()- 1);
+            pageNumbers.add(document.getNumberOfPages() - 1);
-        logger.info("Splitting PDF into pages: {}", pageNumbers.stream().map(String::valueOf).collect(Collectors.joining(",")));
+        logger.info(
+                "Splitting PDF into pages: {}",
+                pageNumbers.stream().map(String::valueOf).collect(Collectors.joining(",")));
 
         // split the document
         List<ByteArrayOutputStream> splitDocumentsBoas = new ArrayList<>();
@@ -72,7 +78,6 @@ public class SplitPDFController {
             }
         }
 
-
         // closing the original document
         document.close();
 
@@ -104,8 +109,7 @@ public class SplitPDFController {
         Files.delete(zipFile);
 
         // return the Resource in the response
-        return WebResponseUtils.bytesToWebResponse(data, filename + ".zip", MediaType.APPLICATION_OCTET_STREAM);
+        return WebResponseUtils.bytesToWebResponse(
-        
+                data, filename + ".zip", MediaType.APPLICATION_OCTET_STREAM);
     }
-
+}
-}

src/main/java/stirling/software/SPDF/controller/api/SplitPdfBySectionsController.java

@@ -0,0 +1,143 @@
+package stirling.software.SPDF.controller.api;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+import org.apache.pdfbox.multipdf.LayerUtility;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDPageContentStream;
+import org.apache.pdfbox.pdmodel.common.PDRectangle;
+import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
+import org.apache.pdfbox.util.Matrix;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import stirling.software.SPDF.model.api.SplitPdfBySectionsRequest;
+import stirling.software.SPDF.utils.WebResponseUtils;
+
+@RestController
+@RequestMapping("/api/v1/general")
+@Tag(name = "General", description = "General APIs")
+public class SplitPdfBySectionsController {
+
+    @PostMapping(value = "/split-pdf-by-sections", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Split PDF pages into smaller sections",
+            description =
+                    "Split each page of a PDF into smaller sections based on the user's choice (halves, thirds, quarters, etc.), both vertically and horizontally. Input:PDF Output:ZIP-PDF Type:SISO")
+    public ResponseEntity<byte[]> splitPdf(@ModelAttribute SplitPdfBySectionsRequest request)
+            throws Exception {
+        List<ByteArrayOutputStream> splitDocumentsBoas = new ArrayList<>();
+
+        MultipartFile file = request.getFileInput();
+        PDDocument sourceDocument = PDDocument.load(file.getInputStream());
+
+        // Process the PDF based on split parameters
+        int horiz = request.getHorizontalDivisions() + 1;
+        int verti = request.getVerticalDivisions() + 1;
+
+        List<PDDocument> splitDocuments = splitPdfPages(sourceDocument, verti, horiz);
+        for (PDDocument doc : splitDocuments) {
+            ByteArrayOutputStream baos = new ByteArrayOutputStream();
+            doc.save(baos);
+            doc.close();
+            splitDocumentsBoas.add(baos);
+        }
+
+        sourceDocument.close();
+
+        Path zipFile = Files.createTempFile("split_documents", ".zip");
+        String filename = file.getOriginalFilename().replaceFirst("[.][^.]+$", "");
+        byte[] data;
+
+        try (ZipOutputStream zipOut = new ZipOutputStream(Files.newOutputStream(zipFile))) {
+            int pageNum = 1;
+            for (int i = 0; i < splitDocumentsBoas.size(); i++) {
+                ByteArrayOutputStream baos = splitDocumentsBoas.get(i);
+                int sectionNum = (i % (horiz * verti)) + 1;
+                String fileName = filename + "_" + pageNum + "_" + sectionNum + ".pdf";
+                byte[] pdf = baos.toByteArray();
+                ZipEntry pdfEntry = new ZipEntry(fileName);
+                zipOut.putNextEntry(pdfEntry);
+                zipOut.write(pdf);
+                zipOut.closeEntry();
+
+                if (sectionNum == horiz * verti) pageNum++;
+            }
+        } catch (Exception e) {
+            e.printStackTrace();
+        } finally {
+            data = Files.readAllBytes(zipFile);
+            Files.delete(zipFile);
+        }
+
+        return WebResponseUtils.bytesToWebResponse(
+                data, filename + "_split.zip", MediaType.APPLICATION_OCTET_STREAM);
+    }
+
+    public List<PDDocument> splitPdfPages(
+            PDDocument document, int horizontalDivisions, int verticalDivisions)
+            throws IOException {
+        List<PDDocument> splitDocuments = new ArrayList<>();
+
+        for (PDPage originalPage : document.getPages()) {
+            PDRectangle originalMediaBox = originalPage.getMediaBox();
+            float width = originalMediaBox.getWidth();
+            float height = originalMediaBox.getHeight();
+            float subPageWidth = width / horizontalDivisions;
+            float subPageHeight = height / verticalDivisions;
+
+            LayerUtility layerUtility = new LayerUtility(document);
+
+            for (int i = 0; i < horizontalDivisions; i++) {
+                for (int j = 0; j < verticalDivisions; j++) {
+                    PDDocument subDoc = new PDDocument();
+                    PDPage subPage = new PDPage(new PDRectangle(subPageWidth, subPageHeight));
+                    subDoc.addPage(subPage);
+
+                    PDFormXObject form =
+                            layerUtility.importPageAsForm(
+                                    document, document.getPages().indexOf(originalPage));
+
+                    try (PDPageContentStream contentStream =
+                            new PDPageContentStream(subDoc, subPage)) {
+                        // Set clipping area and position
+                        float translateX = -subPageWidth * i;
+                        float translateY = height - subPageHeight * (verticalDivisions - j);
+
+                        // Code for google Docs pdfs..
+                        // float translateY = -subPageHeight * (verticalDivisions - 1 - j);
+
+                        contentStream.saveGraphicsState();
+                        contentStream.addRect(0, 0, subPageWidth, subPageHeight);
+                        contentStream.clip();
+                        contentStream.transform(new Matrix(1, 0, 0, 1, translateX, translateY));
+
+                        // Draw the form
+                        contentStream.drawForm(form);
+                        contentStream.restoreGraphicsState();
+                    }
+
+                    splitDocuments.add(subDoc);
+                }
+            }
+        }
+
+        return splitDocuments;
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/SplitPdfBySizeController.java

@@ -0,0 +1,153 @@
+package stirling.software.SPDF.controller.api;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import stirling.software.SPDF.model.api.general.SplitPdfBySizeOrCountRequest;
+import stirling.software.SPDF.utils.GeneralUtils;
+import stirling.software.SPDF.utils.WebResponseUtils;
+
+@RestController
+@RequestMapping("/api/v1/general")
+@Tag(name = "General", description = "General APIs")
+public class SplitPdfBySizeController {
+
+    @PostMapping(value = "/split-by-size-or-count", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Auto split PDF pages into separate documents based on size or count",
+            description =
+                    "split PDF into multiple paged documents based on size/count, ie if 20 pages and split into 5, it does 5 documents each 4 pages\r\n"
+                            + " if 10MB and each page is 1MB and you enter 2MB then 5 docs each 2MB (rounded so that it accepts 1.9MB but not 2.1MB) Input:PDF Output:ZIP-PDF Type:SISO")
+    public ResponseEntity<byte[]> autoSplitPdf(@ModelAttribute SplitPdfBySizeOrCountRequest request)
+            throws Exception {
+        List<ByteArrayOutputStream> splitDocumentsBoas = new ArrayList<ByteArrayOutputStream>();
+
+        MultipartFile file = request.getFileInput();
+        PDDocument sourceDocument = PDDocument.load(file.getInputStream());
+
+        // 0 = size, 1 = page count, 2 = doc count
+        int type = request.getSplitType();
+        String value = request.getSplitValue();
+
+        if (type == 0) { // Split by size
+            long maxBytes = GeneralUtils.convertSizeToBytes(value);
+            long currentSize = 0;
+            PDDocument currentDoc = new PDDocument();
+
+            for (PDPage page : sourceDocument.getPages()) {
+                ByteArrayOutputStream pageOutputStream = new ByteArrayOutputStream();
+                PDDocument tempDoc = new PDDocument();
+                tempDoc.addPage(page);
+                tempDoc.save(pageOutputStream);
+                tempDoc.close();
+
+                long pageSize = pageOutputStream.size();
+                if (currentSize + pageSize > maxBytes) {
+                    // Save and reset current document
+                    splitDocumentsBoas.add(currentDocToByteArray(currentDoc));
+                    currentDoc = new PDDocument();
+                    currentSize = 0;
+                }
+
+                currentDoc.addPage(page);
+                currentSize += pageSize;
+            }
+            // Add the last document if it contains any pages
+            if (currentDoc.getPages().getCount() != 0) {
+                splitDocumentsBoas.add(currentDocToByteArray(currentDoc));
+            }
+        } else if (type == 1) { // Split by page count
+            int pageCount = Integer.parseInt(value);
+            int currentPageCount = 0;
+            PDDocument currentDoc = new PDDocument();
+
+            for (PDPage page : sourceDocument.getPages()) {
+                currentDoc.addPage(page);
+                currentPageCount++;
+
+                if (currentPageCount == pageCount) {
+                    // Save and reset current document
+                    splitDocumentsBoas.add(currentDocToByteArray(currentDoc));
+                    currentDoc = new PDDocument();
+                    currentPageCount = 0;
+                }
+            }
+            // Add the last document if it contains any pages
+            if (currentDoc.getPages().getCount() != 0) {
+                splitDocumentsBoas.add(currentDocToByteArray(currentDoc));
+            }
+        } else if (type == 2) { // Split by doc count
+            int documentCount = Integer.parseInt(value);
+            int totalPageCount = sourceDocument.getNumberOfPages();
+            int pagesPerDocument = totalPageCount / documentCount;
+            int extraPages = totalPageCount % documentCount;
+            int currentPageIndex = 0;
+
+            for (int i = 0; i < documentCount; i++) {
+                PDDocument currentDoc = new PDDocument();
+                int pagesToAdd = pagesPerDocument + (i < extraPages ? 1 : 0);
+
+                for (int j = 0; j < pagesToAdd; j++) {
+                    currentDoc.addPage(sourceDocument.getPage(currentPageIndex++));
+                }
+
+                splitDocumentsBoas.add(currentDocToByteArray(currentDoc));
+            }
+        } else {
+            throw new IllegalArgumentException("Invalid argument for split type");
+        }
+
+        sourceDocument.close();
+
+        Path zipFile = Files.createTempFile("split_documents", ".zip");
+        String filename = file.getOriginalFilename().replaceFirst("[.][^.]+$", "");
+        byte[] data;
+
+        try (ZipOutputStream zipOut = new ZipOutputStream(Files.newOutputStream(zipFile))) {
+            for (int i = 0; i < splitDocumentsBoas.size(); i++) {
+                String fileName = filename + "_" + (i + 1) + ".pdf";
+                ByteArrayOutputStream baos = splitDocumentsBoas.get(i);
+                byte[] pdf = baos.toByteArray();
+
+                ZipEntry pdfEntry = new ZipEntry(fileName);
+                zipOut.putNextEntry(pdfEntry);
+                zipOut.write(pdf);
+                zipOut.closeEntry();
+            }
+        } catch (Exception e) {
+            e.printStackTrace();
+        } finally {
+            data = Files.readAllBytes(zipFile);
+            Files.delete(zipFile);
+        }
+
+        return WebResponseUtils.bytesToWebResponse(
+                data, filename + ".zip", MediaType.APPLICATION_OCTET_STREAM);
+    }
+
+    private ByteArrayOutputStream currentDocToByteArray(PDDocument document) throws IOException {
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        document.save(baos);
+        document.close();
+        return baos;
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/ToSinglePageController.java

@@ -20,8 +20,10 @@ import org.springframework.web.bind.annotation.RestController;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.PDFFile;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/general")
 @Tag(name = "General", description = "General APIs")
@@ -29,58 +31,61 @@ public class ToSinglePageController {
 
     private static final Logger logger = LoggerFactory.getLogger(ToSinglePageController.class);
 
-   
     @PostMapping(consumes = "multipart/form-data", value = "/pdf-to-single-page")
     @Operation(
-        summary = "Convert a multi-page PDF into a single long page PDF",
+            summary = "Convert a multi-page PDF into a single long page PDF",
-        description = "This endpoint converts a multi-page PDF document into a single paged PDF document. The width of the single page will be same as the input's width, but the height will be the sum of all the pages' heights. Input:PDF Output:PDF Type:SISO"
+            description =
-    )
+                    "This endpoint converts a multi-page PDF document into a single paged PDF document. The width of the single page will be same as the input's width, but the height will be the sum of all the pages' heights. Input:PDF Output:PDF Type:SISO")
-    public ResponseEntity<byte[]> pdfToSinglePage(@ModelAttribute PDFFile request) throws IOException {
+    public ResponseEntity<byte[]> pdfToSinglePage(@ModelAttribute PDFFile request)
+            throws IOException {
 
-    	// Load the source document
+        // Load the source document
-    	PDDocument sourceDocument = PDDocument.load(request.getFileInput().getInputStream());
+        PDDocument sourceDocument = PDDocument.load(request.getFileInput().getInputStream());
 
-    	// Calculate total height and max width
+        // Calculate total height and max width
-    	float totalHeight = 0;
+        float totalHeight = 0;
-    	float maxWidth = 0;
+        float maxWidth = 0;
-    	for (PDPage page : sourceDocument.getPages()) {
+        for (PDPage page : sourceDocument.getPages()) {
-    	    PDRectangle pageSize = page.getMediaBox();
+            PDRectangle pageSize = page.getMediaBox();
-    	    totalHeight += pageSize.getHeight();
+            totalHeight += pageSize.getHeight();
-    	    maxWidth = Math.max(maxWidth, pageSize.getWidth());
+            maxWidth = Math.max(maxWidth, pageSize.getWidth());
-    	}
+        }
 
-    	// Create new document and page with calculated dimensions
+        // Create new document and page with calculated dimensions
-    	PDDocument newDocument = new PDDocument();
+        PDDocument newDocument = new PDDocument();
-    	PDPage newPage = new PDPage(new PDRectangle(maxWidth, totalHeight));
+        PDPage newPage = new PDPage(new PDRectangle(maxWidth, totalHeight));
-    	newDocument.addPage(newPage);
+        newDocument.addPage(newPage);
 
-    	// Initialize the content stream of the new page
+        // Initialize the content stream of the new page
-    	PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage);
+        PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage);
-    	contentStream.close();
+        contentStream.close();
-    	
-    	LayerUtility layerUtility = new LayerUtility(newDocument);
-    	float yOffset = totalHeight;
 
-    	// For each page, copy its content to the new page at the correct offset
+        LayerUtility layerUtility = new LayerUtility(newDocument);
-    	for (PDPage page : sourceDocument.getPages()) {
+        float yOffset = totalHeight;
-    	    PDFormXObject form = layerUtility.importPageAsForm(sourceDocument, sourceDocument.getPages().indexOf(page));
-    	    AffineTransform af = AffineTransform.getTranslateInstance(0, yOffset - page.getMediaBox().getHeight());
-    	    layerUtility.wrapInSaveRestore(newPage);
-    	    String defaultLayerName = "Layer" + sourceDocument.getPages().indexOf(page);
-    	    layerUtility.appendFormAsLayer(newPage, form, af, defaultLayerName);
-    	    yOffset -= page.getMediaBox().getHeight();
-    	}
 
-    	ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        // For each page, copy its content to the new page at the correct offset
-    	newDocument.save(baos);
+        for (PDPage page : sourceDocument.getPages()) {
-    	newDocument.close();
+            PDFormXObject form =
-    	sourceDocument.close();
+                    layerUtility.importPageAsForm(
+                            sourceDocument, sourceDocument.getPages().indexOf(page));
+            AffineTransform af =
+                    AffineTransform.getTranslateInstance(
+                            0, yOffset - page.getMediaBox().getHeight());
+            layerUtility.wrapInSaveRestore(newPage);
+            String defaultLayerName = "Layer" + sourceDocument.getPages().indexOf(page);
+            layerUtility.appendFormAsLayer(newPage, form, af, defaultLayerName);
+            yOffset -= page.getMediaBox().getHeight();
+        }
 
-    	byte[] result = baos.toByteArray();
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
-    	return WebResponseUtils.bytesToWebResponse(result, request.getFileInput().getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_singlePage.pdf");
+        newDocument.save(baos);
+        newDocument.close();
+        sourceDocument.close();
 
-
+        byte[] result = baos.toByteArray();
-
+        return WebResponseUtils.bytesToWebResponse(
-       
+                result,
+                request.getFileInput().getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                        + "_singlePage.pdf");
     }
-}
+}

src/main/java/stirling/software/SPDF/controller/api/UserController.java

@@ -23,18 +23,20 @@ import org.springframework.web.servlet.view.RedirectView;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import stirling.software.SPDF.config.security.UserService;
+import stirling.software.SPDF.model.Role;
 import stirling.software.SPDF.model.User;
 
 @Controller
 @RequestMapping("/api/v1/user")
 public class UserController {
-    
+
-    @Autowired
+    @Autowired private UserService userService;
-    private UserService userService;
+
-    
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/register")
-    public String register(@RequestParam String username, @RequestParam String password, Model model) {
+    public String register(
-        if(userService.usernameExists(username)) {
+            @RequestParam String username, @RequestParam String password, Model model) {
+        if (userService.usernameExists(username)) {
             model.addAttribute("error", "Username already exists");
             return "register";
         }
@@ -42,38 +44,41 @@ public class UserController {
         userService.saveUser(username, password);
         return "redirect:/login?registered=true";
     }
-    
+
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/change-username-and-password")
-    public RedirectView changeUsernameAndPassword(Principal principal,
+    public RedirectView changeUsernameAndPassword(
-                                                 @RequestParam String currentPassword, 
+            Principal principal,
-                                                 @RequestParam String newUsername, 
+            @RequestParam String currentPassword,
-                                                 @RequestParam String newPassword, 
+            @RequestParam String newUsername,
-                                                 HttpServletRequest request, 
+            @RequestParam String newPassword,
-                                                 HttpServletResponse response,
+            HttpServletRequest request,
-                                                 RedirectAttributes redirectAttributes) {
+            HttpServletResponse response,
-    	if (principal == null) {
+            RedirectAttributes redirectAttributes) {
-    	    return new RedirectView("/change-creds?messageType=notAuthenticated");
+        if (principal == null) {
-    	}
+            return new RedirectView("/change-creds?messageType=notAuthenticated");
+        }
 
-    	Optional<User> userOpt = userService.findByUsername(principal.getName());
+        Optional<User> userOpt = userService.findByUsername(principal.getName());
 
-    	if (userOpt == null || userOpt.isEmpty()) {
+        if (userOpt == null || userOpt.isEmpty()) {
-    	    return new RedirectView("/change-creds?messageType=userNotFound");
+            return new RedirectView("/change-creds?messageType=userNotFound");
-    	}
+        }
 
-    	User user = userOpt.get();
+        User user = userOpt.get();
 
-    	if (!userService.isPasswordCorrect(user, currentPassword)) {
+        if (!userService.isPasswordCorrect(user, currentPassword)) {
-    	    return new RedirectView("/change-creds?messageType=incorrectPassword");
+            return new RedirectView("/change-creds?messageType=incorrectPassword");
-    	}
+        }
-
-    	if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
-    	    return new RedirectView("/change-creds?messageType=usernameExists");
-    	}
 
+        if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
+            return new RedirectView("/change-creds?messageType=usernameExists");
+        }
 
         userService.changePassword(user, newPassword);
-        if(newUsername != null && newUsername.length() > 0 && !user.getUsername().equals(newUsername)) {
+        if (newUsername != null
+                && newUsername.length() > 0
+                && !user.getUsername().equals(newUsername)) {
             userService.changeUsername(user, newUsername);
         }
         userService.changeFirstUse(user, false);
@@ -84,36 +89,36 @@ public class UserController {
         return new RedirectView("/login?messageType=credsUpdated");
     }
 
-
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
-    
     @PostMapping("/change-username")
-    public RedirectView changeUsername(Principal principal,
+    public RedirectView changeUsername(
-                                       @RequestParam String currentPassword, 
+            Principal principal,
-                                       @RequestParam String newUsername, 
+            @RequestParam String currentPassword,
-                                       HttpServletRequest request, 
+            @RequestParam String newUsername,
-                                       HttpServletResponse response,
+            HttpServletRequest request,
-                                       RedirectAttributes redirectAttributes) {
+            HttpServletResponse response,
-    	if (principal == null) {
+            RedirectAttributes redirectAttributes) {
-    	    return new RedirectView("/account?messageType=notAuthenticated");
+        if (principal == null) {
-    	}
+            return new RedirectView("/account?messageType=notAuthenticated");
+        }
 
-    	Optional<User> userOpt = userService.findByUsername(principal.getName());
+        Optional<User> userOpt = userService.findByUsername(principal.getName());
 
-    	if (userOpt == null || userOpt.isEmpty()) {
+        if (userOpt == null || userOpt.isEmpty()) {
-    	    return new RedirectView("/account?messageType=userNotFound");
+            return new RedirectView("/account?messageType=userNotFound");
-    	}
+        }
 
-    	User user = userOpt.get();
+        User user = userOpt.get();
 
-    	if (!userService.isPasswordCorrect(user, currentPassword)) {
+        if (!userService.isPasswordCorrect(user, currentPassword)) {
-    	    return new RedirectView("/account?messageType=incorrectPassword");
+            return new RedirectView("/account?messageType=incorrectPassword");
-    	}
+        }
 
-    	if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
+        if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
-    	    return new RedirectView("/account?messageType=usernameExists");
+            return new RedirectView("/account?messageType=usernameExists");
-    	}
+        }
 
-    	if(newUsername != null && newUsername.length() > 0) {
+        if (newUsername != null && newUsername.length() > 0) {
             userService.changeUsername(user, newUsername);
         }
 
@@ -123,28 +128,30 @@ public class UserController {
         return new RedirectView("/login?messageType=credsUpdated");
     }
 
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/change-password")
-    public RedirectView changePassword(Principal principal, 
+    public RedirectView changePassword(
-                                       @RequestParam String currentPassword, 
+            Principal principal,
-                                       @RequestParam String newPassword, 
+            @RequestParam String currentPassword,
-                                       HttpServletRequest request, 
+            @RequestParam String newPassword,
-                                       HttpServletResponse response,
+            HttpServletRequest request,
-                                       RedirectAttributes redirectAttributes) {
+            HttpServletResponse response,
-    	if (principal == null) {
+            RedirectAttributes redirectAttributes) {
-    	    return new RedirectView("/account?messageType=notAuthenticated");
+        if (principal == null) {
-    	}
+            return new RedirectView("/account?messageType=notAuthenticated");
+        }
 
-    	Optional<User> userOpt = userService.findByUsername(principal.getName());
+        Optional<User> userOpt = userService.findByUsername(principal.getName());
 
-    	if (userOpt == null || userOpt.isEmpty()) {
+        if (userOpt == null || userOpt.isEmpty()) {
-    	    return new RedirectView("/account?messageType=userNotFound");
+            return new RedirectView("/account?messageType=userNotFound");
-    	}
+        }
 
-    	User user = userOpt.get();
+        User user = userOpt.get();
 
-    	if (!userService.isPasswordCorrect(user, currentPassword)) {
+        if (!userService.isPasswordCorrect(user, currentPassword)) {
-    	    return new RedirectView("/account?messageType=incorrectPassword");
+            return new RedirectView("/account?messageType=incorrectPassword");
-    	}
+        }
 
         userService.changePassword(user, newPassword);
 
@@ -154,55 +161,71 @@ public class UserController {
         return new RedirectView("/login?messageType=credsUpdated");
     }
 
-    
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/updateUserSettings")
-	public String updateUserSettings(HttpServletRequest request, Principal principal) {
+    public String updateUserSettings(HttpServletRequest request, Principal principal) {
-	    Map<String, String[]> paramMap = request.getParameterMap();
+        Map<String, String[]> paramMap = request.getParameterMap();
-	    Map<String, String> updates = new HashMap<>();
+        Map<String, String> updates = new HashMap<>();
 
-	    System.out.println("Received parameter map: " + paramMap);
+        System.out.println("Received parameter map: " + paramMap);
 
-	    for (Map.Entry<String, String[]> entry : paramMap.entrySet()) {
+        for (Map.Entry<String, String[]> entry : paramMap.entrySet()) {
-	        updates.put(entry.getKey(), entry.getValue()[0]);
+            updates.put(entry.getKey(), entry.getValue()[0]);
-	    }
+        }
 
-	    System.out.println("Processed updates: " + updates);
+        System.out.println("Processed updates: " + updates);
 
-	    // Assuming you have a method in userService to update the settings for a user
+        // Assuming you have a method in userService to update the settings for a user
-	    userService.updateUserSettings(principal.getName(), updates);
+        userService.updateUserSettings(principal.getName(), updates);
 
-	    return "redirect:/account";  // Redirect to a page of your choice after updating
+        return "redirect:/account"; // Redirect to a page of your choice after updating
-	}
+    }
 
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping("/admin/saveUser")
-    public RedirectView saveUser(@RequestParam String username, @RequestParam String password, @RequestParam String role, 
+    public RedirectView saveUser(
-    		@RequestParam(name = "forceChange", required = false, defaultValue = "false") boolean forceChange) {
+            @RequestParam String username,
-    	
+            @RequestParam String password,
-    	if(userService.usernameExists(username)) {
+            @RequestParam String role,
-    		return new RedirectView("/addUsers?messageType=usernameExists");
+            @RequestParam(name = "forceChange", required = false, defaultValue = "false")
-    	}
+                    boolean forceChange) {
+
+        if (userService.usernameExists(username)) {
+            return new RedirectView("/addUsers?messageType=usernameExists");
+        }
+        try {
+            // Validate the role
+            Role roleEnum = Role.fromString(role);
+            if (roleEnum == Role.INTERNAL_API_USER) {
+                // If the role is INTERNAL_API_USER, reject the request
+                return new RedirectView("/addUsers?messageType=invalidRole");
+            }
+        } catch (IllegalArgumentException e) {
+            // If the role ID is not valid, redirect with an error message
+            return new RedirectView("/addUsers?messageType=invalidRole");
+        }
+
         userService.saveUser(username, password, role, forceChange);
-        return new RedirectView("/addUsers");  // Redirect to account page after adding the user
+        return new RedirectView("/addUsers"); // Redirect to account page after adding the user
     }
 
-    
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping("/admin/deleteUser/{username}")
-    public String deleteUser(@PathVariable String username,  Authentication authentication) {
+    public String deleteUser(@PathVariable String username, Authentication authentication) {
-    	
+
-    	// Get the currently authenticated username
+        // Get the currently authenticated username
         String currentUsername = authentication.getName();
 
         // Check if the provided username matches the current session's username
         if (currentUsername.equals(username)) {
             throw new IllegalArgumentException("Cannot delete currently logined in user.");
         }
-        
+
-    	userService.deleteUser(username); 
+        userService.deleteUser(username);
         return "redirect:/addUsers";
     }
-    
+
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/get-api-key")
     public ResponseEntity<String> getApiKey(Principal principal) {
         if (principal == null) {
@@ -216,6 +239,7 @@ public class UserController {
         return ResponseEntity.ok(apiKey);
     }
 
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/update-api-key")
     public ResponseEntity<String> updateApiKey(Principal principal) {
         if (principal == null) {
@@ -229,6 +253,4 @@ public class UserController {
         }
         return ResponseEntity.ok(apiKey);
     }
-    
-    
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertBookToPDFController.java

@@ -0,0 +1,68 @@
+package stirling.software.SPDF.controller.api.converters;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import stirling.software.SPDF.model.api.GeneralFile;
+import stirling.software.SPDF.utils.FileToPdf;
+import stirling.software.SPDF.utils.WebResponseUtils;
+
+@RestController
+@Tag(name = "Convert", description = "Convert APIs")
+@RequestMapping("/api/v1/convert")
+public class ConvertBookToPDFController {
+
+    @Autowired
+    @Qualifier("bookFormatsInstalled")
+    private boolean bookFormatsInstalled;
+
+    @PostMapping(consumes = "multipart/form-data", value = "/book/pdf")
+    @Operation(
+            summary =
+                    "Convert a BOOK/comic (*.epub | *.mobi | *.azw3 | *.fb2 | *.txt | *.docx) to PDF",
+            description =
+                    "(Requires bookFormatsInstalled flag and Calibre installed) This endpoint takes an BOOK/comic (*.epub | *.mobi | *.azw3 | *.fb2 | *.txt | *.docx)  input and converts it to PDF format.")
+    public ResponseEntity<byte[]> HtmlToPdf(@ModelAttribute GeneralFile request) throws Exception {
+        MultipartFile fileInput = request.getFileInput();
+
+        if (!bookFormatsInstalled) {
+            throw new IllegalArgumentException(
+                    "bookFormatsInstalled flag is False, this functionality is not avaiable");
+        }
+
+        if (fileInput == null) {
+            throw new IllegalArgumentException("Please provide a file for conversion.");
+        }
+
+        String originalFilename = fileInput.getOriginalFilename();
+
+        if (originalFilename != null) {
+            String originalFilenameLower = originalFilename.toLowerCase();
+            if (!originalFilenameLower.endsWith(".epub")
+                    && !originalFilenameLower.endsWith(".mobi")
+                    && !originalFilenameLower.endsWith(".azw3")
+                    && !originalFilenameLower.endsWith(".fb2")
+                    && !originalFilenameLower.endsWith(".txt")
+                    && !originalFilenameLower.endsWith(".docx")) {
+                throw new IllegalArgumentException(
+                        "File must be in .epub, .mobi, .azw3, .fb2, .txt, or .docx format.");
+            }
+        }
+        byte[] pdfBytes = FileToPdf.convertBookTypeToPdf(fileInput.getBytes(), originalFilename);
+
+        String outputFilename =
+                originalFilename.replaceFirst("[.][^.]+$", "")
+                        + ".pdf"; // Remove file extension and append .pdf
+
+        return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertEpubToPdf.java

@@ -1,130 +0,0 @@
-package stirling.software.SPDF.controller.api.converters;
-
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.io.StringReader;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipInputStream;
-
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.ModelAttribute;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
-import org.springframework.web.multipart.MultipartFile;
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.NodeList;
-import org.xml.sax.InputSource;
-
-import io.swagger.v3.oas.annotations.Hidden;
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.tags.Tag;
-import stirling.software.SPDF.model.api.GeneralFile;
-import stirling.software.SPDF.utils.FileToPdf;
-import stirling.software.SPDF.utils.WebResponseUtils;
-
-@RestController
-@RequestMapping("/api/v1/convert")
-@Tag(name = "Convert", description = "Convert APIs")
-public class ConvertEpubToPdf {
-	//TODO
-	@PostMapping(consumes = "multipart/form-data", value = "/epub-to-single-pdf")
-	@Hidden
-	@Operation(
-	    summary = "Convert an EPUB file to a single PDF",
-	    description = "This endpoint takes an EPUB file input and converts it to a single PDF."
-	)
-	public ResponseEntity<byte[]> epubToSinglePdf(
-			@ModelAttribute GeneralFile request) 
-	        throws Exception {
-		MultipartFile fileInput = request.getFileInput();
-	    if (fileInput == null) {
-	        throw new IllegalArgumentException("Please provide an EPUB file for conversion.");
-	    }
-
-	    String originalFilename = fileInput.getOriginalFilename();
-	    if (originalFilename == null || !originalFilename.endsWith(".epub")) {
-	        throw new IllegalArgumentException("File must be in .epub format.");
-	    }
-
-	    Map<String, byte[]> epubContents = extractEpubContent(fileInput);
-	    List<String> htmlFilesOrder = getHtmlFilesOrderFromOpf(epubContents);
-
-	    List<byte[]> individualPdfs = new ArrayList<>();
-
-	    for (String htmlFile : htmlFilesOrder) {
-	        byte[] htmlContent = epubContents.get(htmlFile);
-	        byte[] pdfBytes = FileToPdf.convertHtmlToPdf(htmlContent, htmlFile.replace(".html", ".pdf"));
-	        individualPdfs.add(pdfBytes);
-	    }
-
-	    // Pseudo-code to merge individual PDFs into one.
-	    byte[] mergedPdfBytes = mergeMultiplePdfsIntoOne(individualPdfs);
-
-	    return WebResponseUtils.bytesToWebResponse(mergedPdfBytes, originalFilename.replace(".epub", ".pdf"));
-	}
-
-	// Assuming a pseudo-code function that merges multiple PDFs into one.
-	private byte[] mergeMultiplePdfsIntoOne(List<byte[]> individualPdfs) {
-	    // You can use a library such as  PDFBox to perform the merging here.
-	    // Return the byte[] of the merged PDF.
-		return null;
-	}
-	
-    private Map<String, byte[]> extractEpubContent(MultipartFile fileInput) throws IOException {
-        Map<String, byte[]> contentMap = new HashMap<>();
-
-        try (ZipInputStream zis = new ZipInputStream(fileInput.getInputStream())) {
-            ZipEntry zipEntry = zis.getNextEntry();
-            while (zipEntry != null) {
-                ByteArrayOutputStream baos = new ByteArrayOutputStream();
-                byte[] buffer = new byte[1024];
-                int read = 0;
-                while ((read = zis.read(buffer)) != -1) {
-                    baos.write(buffer, 0, read);
-                }
-                contentMap.put(zipEntry.getName(), baos.toByteArray());
-                zipEntry = zis.getNextEntry();
-            }
-        }
-
-        return contentMap;
-    }
-
-    private List<String> getHtmlFilesOrderFromOpf(Map<String, byte[]> epubContents) throws Exception {
-        String opfContent = new String(epubContents.get("OEBPS/content.opf"));  // Adjusting for given path
-        DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
-        DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
-        InputSource is = new InputSource(new StringReader(opfContent));
-        Document doc = dBuilder.parse(is);
-
-        NodeList itemRefs = doc.getElementsByTagName("itemref");
-        List<String> htmlFilesOrder = new ArrayList<>();
-        
-        for (int i = 0; i < itemRefs.getLength(); i++) {
-            Element itemRef = (Element) itemRefs.item(i);
-            String idref = itemRef.getAttribute("idref");
-            
-            NodeList items = doc.getElementsByTagName("item");
-            for (int j = 0; j < items.getLength(); j++) {
-                Element item = (Element) items.item(j);
-                if (idref.equals(item.getAttribute("id"))) {
-                    htmlFilesOrder.add(item.getAttribute("href"));  // Fetching the actual href
-                    break;
-                }
-            }
-        }
-
-        return htmlFilesOrder;
-    }
-
-
-}

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertHtmlToPDF.java

@@ -1,5 +1,7 @@
 package stirling.software.SPDF.controller.api.converters;
 
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -9,6 +11,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.GeneralFile;
 import stirling.software.SPDF.utils.FileToPdf;
 import stirling.software.SPDF.utils.WebResponseUtils;
@@ -18,35 +21,36 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @RequestMapping("/api/v1/convert")
 public class ConvertHtmlToPDF {
 
+    @Autowired
+    @Qualifier("htmlFormatsInstalled")
+    private boolean htmlFormatsInstalled;
 
-	 @PostMapping(consumes = "multipart/form-data", value = "/html/pdf")
+    @PostMapping(consumes = "multipart/form-data", value = "/html/pdf")
-	    @Operation(
+    @Operation(
-	        summary = "Convert an HTML or ZIP (containing HTML and CSS) to PDF",
+            summary = "Convert an HTML or ZIP (containing HTML and CSS) to PDF",
-	        description = "This endpoint takes an HTML or ZIP file input and converts it to a PDF format."
+            description =
-	    )
+                    "This endpoint takes an HTML or ZIP file input and converts it to a PDF format.")
-	    public ResponseEntity<byte[]> HtmlToPdf(
+    public ResponseEntity<byte[]> HtmlToPdf(@ModelAttribute GeneralFile request) throws Exception {
-	    		@ModelAttribute GeneralFile request) 
+        MultipartFile fileInput = request.getFileInput();
-	    		        throws Exception {
-	    			MultipartFile fileInput = request.getFileInput();
 
-	        if (fileInput == null) {
+        if (fileInput == null) {
-	            throw new IllegalArgumentException("Please provide an HTML or ZIP file for conversion.");
+            throw new IllegalArgumentException(
-	        }
+                    "Please provide an HTML or ZIP file for conversion.");
+        }
 
-	        String originalFilename = fileInput.getOriginalFilename();
+        String originalFilename = fileInput.getOriginalFilename();
-	        if (originalFilename == null || (!originalFilename.endsWith(".html") && !originalFilename.endsWith(".zip"))) {
+        if (originalFilename == null
-	            throw new IllegalArgumentException("File must be either .html or .zip format.");
+                || (!originalFilename.endsWith(".html") && !originalFilename.endsWith(".zip"))) {
-	        }byte[] pdfBytes = FileToPdf.convertHtmlToPdf( fileInput.getBytes(), originalFilename);
+            throw new IllegalArgumentException("File must be either .html or .zip format.");
-	        
+        }
-	        String outputFilename = originalFilename.replaceFirst("[.][^.]+$", "") + ".pdf";  // Remove file extension and append .pdf
+        byte[] pdfBytes =
-	        
+                FileToPdf.convertHtmlToPdf(
-	        return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
+                        fileInput.getBytes(), originalFilename, htmlFormatsInstalled);
-	    }
 
-	   
+        String outputFilename =
-
+                originalFilename.replaceFirst("[.][^.]+$", "")
-    
+                        + ".pdf"; // Remove file extension and append .pdf
-   
-	    
 
+        return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertImgPDFController.java

@@ -1,6 +1,7 @@
 package stirling.software.SPDF.controller.api.converters;
 
 import java.io.IOException;
+import java.net.URLConnection;
 
 import org.apache.pdfbox.rendering.ImageType;
 import org.slf4j.Logger;
@@ -19,10 +20,12 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.converters.ConvertToImageRequest;
 import stirling.software.SPDF.model.api.converters.ConvertToPdfRequest;
 import stirling.software.SPDF.utils.PdfUtils;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/convert")
 @Tag(name = "Convert", description = "Convert APIs")
@@ -31,15 +34,18 @@ public class ConvertImgPDFController {
     private static final Logger logger = LoggerFactory.getLogger(ConvertImgPDFController.class);
 
     @PostMapping(consumes = "multipart/form-data", value = "/pdf/img")
-    @Operation(summary = "Convert PDF to image(s)",
+    @Operation(
-            description = "This endpoint converts a PDF file to image(s) with the specified image format, color type, and DPI. Users can choose to get a single image or multiple images.  Input:PDF Output:Image Type:SI-Conditional")
+            summary = "Convert PDF to image(s)",
-    public ResponseEntity<Resource> convertToImage(@ModelAttribute ConvertToImageRequest request) throws IOException {
+            description =
+                    "This endpoint converts a PDF file to image(s) with the specified image format, color type, and DPI. Users can choose to get a single image or multiple images.  Input:PDF Output:Image Type:SI-Conditional")
+    public ResponseEntity<Resource> convertToImage(@ModelAttribute ConvertToImageRequest request)
+            throws IOException {
         MultipartFile file = request.getFileInput();
         String imageFormat = request.getImageFormat();
         String singleOrMultiple = request.getSingleOrMultiple();
         String colorType = request.getColorType();
         String dpi = request.getDpi();
-        
+
         byte[] pdfBytes = file.getBytes();
         ImageType colorTypeResult = ImageType.RGB;
         if ("greyscale".equals(colorType)) {
@@ -52,7 +58,14 @@ public class ConvertImgPDFController {
         byte[] result = null;
         String filename = file.getOriginalFilename().replaceFirst("[.][^.]+$", "");
         try {
-            result = PdfUtils.convertFromPdf(pdfBytes, imageFormat.toUpperCase(), colorTypeResult, singleImage, Integer.valueOf(dpi), filename);
+            result =
+                    PdfUtils.convertFromPdf(
+                            pdfBytes,
+                            imageFormat.toUpperCase(),
+                            colorTypeResult,
+                            singleImage,
+                            Integer.valueOf(dpi),
+                            filename);
         } catch (IOException e) {
             // TODO Auto-generated catch block
             e.printStackTrace();
@@ -63,41 +76,43 @@ public class ConvertImgPDFController {
         if (singleImage) {
             HttpHeaders headers = new HttpHeaders();
             headers.setContentType(MediaType.parseMediaType(getMediaType(imageFormat)));
-            ResponseEntity<Resource> response = new ResponseEntity<>(new ByteArrayResource(result), headers, HttpStatus.OK);
+            ResponseEntity<Resource> response =
+                    new ResponseEntity<>(new ByteArrayResource(result), headers, HttpStatus.OK);
             return response;
         } else {
             ByteArrayResource resource = new ByteArrayResource(result);
             // return the Resource in the response
             return ResponseEntity.ok()
-                    .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=" + filename + "_convertedToImages.zip")
+                    .header(
-                    .contentType(MediaType.APPLICATION_OCTET_STREAM).contentLength(resource.contentLength()).body(resource);
+                            HttpHeaders.CONTENT_DISPOSITION,
+                            "attachment; filename=" + filename + "_convertedToImages.zip")
+                    .contentType(MediaType.APPLICATION_OCTET_STREAM)
+                    .contentLength(resource.contentLength())
+                    .body(resource);
         }
     }
 
     @PostMapping(consumes = "multipart/form-data", value = "/img/pdf")
-    @Operation(summary = "Convert images to a PDF file",
+    @Operation(
-            description = "This endpoint converts one or more images to a PDF file. Users can specify whether to stretch the images to fit the PDF page, and whether to automatically rotate the images. Input:Image Output:PDF Type:SISO?")
+            summary = "Convert images to a PDF file",
-    public ResponseEntity<byte[]> convertToPdf(@ModelAttribute ConvertToPdfRequest request) throws IOException {
+            description =
+                    "This endpoint converts one or more images to a PDF file. Users can specify whether to stretch the images to fit the PDF page, and whether to automatically rotate the images. Input:Image Output:PDF Type:SISO?")
+    public ResponseEntity<byte[]> convertToPdf(@ModelAttribute ConvertToPdfRequest request)
+            throws IOException {
         MultipartFile[] file = request.getFileInput();
         String fitOption = request.getFitOption();
         String colorType = request.getColorType();
         boolean autoRotate = request.isAutoRotate();
-        
+
         // Convert the file to PDF and get the resulting bytes
         byte[] bytes = PdfUtils.imageToPdf(file, fitOption, autoRotate, colorType);
-        return WebResponseUtils.bytesToWebResponse(bytes, file[0].getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_converted.pdf");
+        return WebResponseUtils.bytesToWebResponse(
+                bytes,
+                file[0].getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_converted.pdf");
     }
 
     private String getMediaType(String imageFormat) {
-        if (imageFormat.equalsIgnoreCase("PNG"))
+        String mimeType = URLConnection.guessContentTypeFromName("." + imageFormat);
-            return "image/png";
+        return mimeType.equals("null") ? "application/octet-stream" : mimeType;
-        else if (imageFormat.equalsIgnoreCase("JPEG") || imageFormat.equalsIgnoreCase("JPG"))
-            return "image/jpeg";
-        else if (imageFormat.equalsIgnoreCase("GIF"))
-            return "image/gif";
-        else
-            return "application/octet-stream";
     }
-
-
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertMarkdownToPdf.java

@@ -3,6 +3,8 @@ package stirling.software.SPDF.controller.api.converters;
 import org.commonmark.node.Node;
 import org.commonmark.parser.Parser;
 import org.commonmark.renderer.html.HtmlRenderer;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -12,6 +14,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.GeneralFile;
 import stirling.software.SPDF.utils.FileToPdf;
 import stirling.software.SPDF.utils.WebResponseUtils;
@@ -20,17 +23,20 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "Convert", description = "Convert APIs")
 @RequestMapping("/api/v1/convert")
 public class ConvertMarkdownToPdf {
-	
+
-	@PostMapping(consumes = "multipart/form-data", value = "/markdown/pdf")
+    @Autowired
+    @Qualifier("htmlFormatsInstalled")
+    private boolean htmlFormatsInstalled;
+
+    @PostMapping(consumes = "multipart/form-data", value = "/markdown/pdf")
     @Operation(
-        summary = "Convert a Markdown file to PDF",
+            summary = "Convert a Markdown file to PDF",
-        description = "This endpoint takes a Markdown file input, converts it to HTML, and then to PDF format."
+            description =
-    )
+                    "This endpoint takes a Markdown file input, converts it to HTML, and then to PDF format.")
-    public ResponseEntity<byte[]> markdownToPdf(
+    public ResponseEntity<byte[]> markdownToPdf(@ModelAttribute GeneralFile request)
-    		@ModelAttribute GeneralFile request) 
+            throws Exception {
-    		        throws Exception {
+        MultipartFile fileInput = request.getFileInput();
-    			MultipartFile fileInput = request.getFileInput();
+
-        
         if (fileInput == null) {
             throw new IllegalArgumentException("Please provide a Markdown file for conversion.");
         }
@@ -45,10 +51,14 @@ public class ConvertMarkdownToPdf {
         Node document = parser.parse(new String(fileInput.getBytes()));
         HtmlRenderer renderer = HtmlRenderer.builder().build();
         String htmlContent = renderer.render(document);
-        
-        byte[] pdfBytes = FileToPdf.convertHtmlToPdf(htmlContent.getBytes(), "converted.html"); 
 
-        String outputFilename = originalFilename.replaceFirst("[.][^.]+$", "") + ".pdf";  // Remove file extension and append .pdf
+        byte[] pdfBytes =
+                FileToPdf.convertHtmlToPdf(
+                        htmlContent.getBytes(), "converted.html", htmlFormatsInstalled);
+
+        String outputFilename =
+                originalFilename.replaceFirst("[.][^.]+$", "")
+                        + ".pdf"; // Remove file extension and append .pdf
         return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
     }
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertOfficeController.java

@@ -18,6 +18,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.GeneralFile;
 import stirling.software.SPDF.utils.ProcessExecutor;
 import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
@@ -31,20 +32,33 @@ public class ConvertOfficeController {
     public byte[] convertToPdf(MultipartFile inputFile) throws IOException, InterruptedException {
         // Check for valid file extension
         String originalFilename = inputFile.getOriginalFilename();
-        if (originalFilename == null || !isValidFileExtension(FilenameUtils.getExtension(originalFilename))) {
+        if (originalFilename == null
+                || !isValidFileExtension(FilenameUtils.getExtension(originalFilename))) {
             throw new IllegalArgumentException("Invalid file extension");
         }
 
         // Save the uploaded file to a temporary location
-        Path tempInputFile = Files.createTempFile("input_", "." + FilenameUtils.getExtension(originalFilename));
+        Path tempInputFile =
+                Files.createTempFile("input_", "." + FilenameUtils.getExtension(originalFilename));
         Files.copy(inputFile.getInputStream(), tempInputFile, StandardCopyOption.REPLACE_EXISTING);
 
         // Prepare the output file path
         Path tempOutputFile = Files.createTempFile("output_", ".pdf");
 
         // Run the LibreOffice command
-        List<String> command = new ArrayList<>(Arrays.asList("unoconv", "-vvv", "-f", "pdf", "-o", tempOutputFile.toString(), tempInputFile.toString()));
+        List<String> command =
-        ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.LIBRE_OFFICE).runCommandWithOutputHandling(command);
+                new ArrayList<>(
+                        Arrays.asList(
+                                "unoconv",
+                                "-vvv",
+                                "-f",
+                                "pdf",
+                                "-o",
+                                tempOutputFile.toString(),
+                                tempInputFile.toString()));
+        ProcessExecutorResult returnCode =
+                ProcessExecutor.getInstance(ProcessExecutor.Processes.LIBRE_OFFICE)
+                        .runCommandWithOutputHandling(command);
 
         // Read the converted PDF file
         byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
@@ -55,6 +69,7 @@ public class ConvertOfficeController {
 
         return pdfBytes;
     }
+
     private boolean isValidFileExtension(String fileExtension) {
         String extensionPattern = "^(?i)[a-z0-9]{2,4}$";
         return fileExtension.matches(extensionPattern);
@@ -62,17 +77,19 @@ public class ConvertOfficeController {
 
     @PostMapping(consumes = "multipart/form-data", value = "/file/pdf")
     @Operation(
-        summary = "Convert a file to a PDF using LibreOffice",
+            summary = "Convert a file to a PDF using LibreOffice",
-        description = "This endpoint converts a given file to a PDF using LibreOffice API  Input:Any Output:PDF Type:SISO"
+            description =
-    )
+                    "This endpoint converts a given file to a PDF using LibreOffice API  Input:ANY Output:PDF Type:SISO")
-    public ResponseEntity<byte[]> processFileToPDF(@ModelAttribute GeneralFile request) 
+    public ResponseEntity<byte[]> processFileToPDF(@ModelAttribute GeneralFile request)
-	        throws Exception {
+            throws Exception {
-		MultipartFile inputFile = request.getFileInput();
+        MultipartFile inputFile = request.getFileInput();
         // unused but can start server instance if startup time is to long
         // LibreOfficeListener.getInstance().start();
 
         byte[] pdfByteArray = convertToPdf(inputFile);
-        return WebResponseUtils.bytesToWebResponse(pdfByteArray, inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_convertedToPDF.pdf");
+        return WebResponseUtils.bytesToWebResponse(
+                pdfByteArray,
+                inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                        + "_convertedToPDF.pdf");
     }
-
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToBookController.java

@@ -0,0 +1,101 @@
+package stirling.software.SPDF.controller.api.converters;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import stirling.software.SPDF.model.api.converters.PdfToBookRequest;
+import stirling.software.SPDF.utils.ProcessExecutor;
+import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
+import stirling.software.SPDF.utils.WebResponseUtils;
+
+@RestController
+@Tag(name = "Convert", description = "Convert APIs")
+@RequestMapping("/api/v1/convert")
+public class ConvertPDFToBookController {
+
+    @Autowired
+    @Qualifier("bookFormatsInstalled")
+    private boolean bookFormatsInstalled;
+
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/book")
+    @Operation(
+            summary =
+                    "Convert a PDF to a Book/comic (*.epub | *.mobi | *.azw3 | *.fb2 | *.txt | *.docx .. (others to include by chatgpt) to PDF",
+            description =
+                    "(Requires bookFormatsInstalled flag and Calibre installed) This endpoint Convert a PDF to a Book/comic (*.epub | *.mobi | *.azw3 | *.fb2 | *.txt | *.docx .. (others to include by chatgpt) to PDF")
+    public ResponseEntity<byte[]> HtmlToPdf(@ModelAttribute PdfToBookRequest request)
+            throws Exception {
+        MultipartFile fileInput = request.getFileInput();
+
+        if (!bookFormatsInstalled) {
+            throw new IllegalArgumentException(
+                    "bookFormatsInstalled flag is False, this functionality is not avaiable");
+        }
+
+        if (fileInput == null) {
+            throw new IllegalArgumentException("Please provide a file for conversion.");
+        }
+
+        // Validate the output format
+        String outputFormat = request.getOutputFormat().toLowerCase();
+        List<String> allowedFormats =
+                Arrays.asList(
+                        "epub", "mobi", "azw3", "docx", "rtf", "txt", "html", "lit", "fb2", "pdb",
+                        "lrf");
+        if (!allowedFormats.contains(outputFormat)) {
+            throw new IllegalArgumentException("Invalid output format: " + outputFormat);
+        }
+
+        byte[] outputFileBytes;
+        List<String> command = new ArrayList<>();
+        Path tempOutputFile =
+                Files.createTempFile(
+                        "output_",
+                        "." + outputFormat); // Use the output format for the file extension
+        Path tempInputFile = null;
+
+        try {
+            // Create temp input file from the provided PDF
+            tempInputFile = Files.createTempFile("input_", ".pdf"); // Assuming input is always PDF
+            Files.write(tempInputFile, fileInput.getBytes());
+
+            command.add("ebook-convert");
+            command.add(tempInputFile.toString());
+            command.add(tempOutputFile.toString());
+
+            ProcessExecutorResult returnCode =
+                    ProcessExecutor.getInstance(ProcessExecutor.Processes.CALIBRE)
+                            .runCommandWithOutputHandling(command);
+
+            outputFileBytes = Files.readAllBytes(tempOutputFile);
+        } finally {
+            // Clean up temporary files
+            if (tempInputFile != null) {
+                Files.deleteIfExists(tempInputFile);
+            }
+            Files.deleteIfExists(tempOutputFile);
+        }
+
+        String outputFilename =
+                fileInput.getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                        + "."
+                        + outputFormat; // Remove file extension and append .pdf
+
+        return WebResponseUtils.bytesToWebResponse(outputFileBytes, outputFilename);
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToOffice.java

@@ -11,6 +11,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.PDFFile;
 import stirling.software.SPDF.model.api.converters.PdfToPresentationRequest;
 import stirling.software.SPDF.model.api.converters.PdfToTextOrRTFRequest;
@@ -22,51 +23,70 @@ import stirling.software.SPDF.utils.PDFToFile;
 @Tag(name = "Convert", description = "Convert APIs")
 public class ConvertPDFToOffice {
 
-	@PostMapping(consumes = "multipart/form-data", value = "/pdf/html")
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/html")
-	@Operation(summary = "Convert PDF to HTML", description = "This endpoint converts a PDF file to HTML format. Input:PDF Output:HTML Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> processPdfToHTML(@ModelAttribute PDFFile request) 
+            summary = "Convert PDF to HTML",
-	        throws Exception {
+            description =
-		MultipartFile inputFile = request.getFileInput();
+                    "This endpoint converts a PDF file to HTML format. Input:PDF Output:HTML Type:SISO")
-		PDFToFile pdfToFile = new PDFToFile();
+    public ResponseEntity<byte[]> processPdfToHTML(@ModelAttribute PDFFile request)
-		return pdfToFile.processPdfToOfficeFormat(inputFile, "html", "writer_pdf_import");
+            throws Exception {
-	}
+        MultipartFile inputFile = request.getFileInput();
+        PDFToFile pdfToFile = new PDFToFile();
+        return pdfToFile.processPdfToOfficeFormat(inputFile, "html", "writer_pdf_import");
+    }
 
-	@PostMapping(consumes = "multipart/form-data", value = "/pdf/presentation")
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/presentation")
-	@Operation(summary = "Convert PDF to Presentation format", description = "This endpoint converts a given PDF file to a Presentation format. Input:PDF Output:PPT Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> processPdfToPresentation(@ModelAttribute PdfToPresentationRequest request) throws IOException, InterruptedException {
+            summary = "Convert PDF to Presentation format",
-	    MultipartFile inputFile = request.getFileInput();
+            description =
-	    String outputFormat = request.getOutputFormat();
+                    "This endpoint converts a given PDF file to a Presentation format. Input:PDF Output:PPT Type:SISO")
-		PDFToFile pdfToFile = new PDFToFile();
+    public ResponseEntity<byte[]> processPdfToPresentation(
-		return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "impress_pdf_import");
+            @ModelAttribute PdfToPresentationRequest request)
-	}
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String outputFormat = request.getOutputFormat();
+        PDFToFile pdfToFile = new PDFToFile();
+        return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "impress_pdf_import");
+    }
 
-	@PostMapping(consumes = "multipart/form-data", value = "/pdf/text")
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/text")
-	@Operation(summary = "Convert PDF to Text or RTF format", description = "This endpoint converts a given PDF file to Text or RTF format. Input:PDF Output:TXT Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> processPdfToRTForTXT(@ModelAttribute PdfToTextOrRTFRequest request) throws IOException, InterruptedException {
+            summary = "Convert PDF to Text or RTF format",
-	    MultipartFile inputFile = request.getFileInput();
+            description =
-	    String outputFormat = request.getOutputFormat();
+                    "This endpoint converts a given PDF file to Text or RTF format. Input:PDF Output:TXT Type:SISO")
+    public ResponseEntity<byte[]> processPdfToRTForTXT(
+            @ModelAttribute PdfToTextOrRTFRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String outputFormat = request.getOutputFormat();
 
-		PDFToFile pdfToFile = new PDFToFile();
+        PDFToFile pdfToFile = new PDFToFile();
-		return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "writer_pdf_import");
+        return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "writer_pdf_import");
-	}
+    }
 
-	@PostMapping(consumes = "multipart/form-data", value = "/pdf/word")
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/word")
-	@Operation(summary = "Convert PDF to Word document", description = "This endpoint converts a given PDF file to a Word document format. Input:PDF Output:WORD Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> processPdfToWord(@ModelAttribute PdfToWordRequest request) throws IOException, InterruptedException {
+            summary = "Convert PDF to Word document",
-	    MultipartFile inputFile = request.getFileInput();
+            description =
-	    String outputFormat = request.getOutputFormat();
+                    "This endpoint converts a given PDF file to a Word document format. Input:PDF Output:WORD Type:SISO")
-		PDFToFile pdfToFile = new PDFToFile();
+    public ResponseEntity<byte[]> processPdfToWord(@ModelAttribute PdfToWordRequest request)
-		return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "writer_pdf_import");
+            throws IOException, InterruptedException {
-	}
+        MultipartFile inputFile = request.getFileInput();
+        String outputFormat = request.getOutputFormat();
+        PDFToFile pdfToFile = new PDFToFile();
+        return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "writer_pdf_import");
+    }
 
-	@PostMapping(consumes = "multipart/form-data", value = "/pdf/xml")
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/xml")
-	@Operation(summary = "Convert PDF to XML", description = "This endpoint converts a PDF file to an XML file. Input:PDF Output:XML Type:SISO")
+    @Operation(
-	public ResponseEntity<byte[]> processPdfToXML(@ModelAttribute PDFFile request) 
+            summary = "Convert PDF to XML",
-	        throws Exception {
+            description =
-		MultipartFile inputFile = request.getFileInput();
+                    "This endpoint converts a PDF file to an XML file. Input:PDF Output:XML Type:SISO")
-
+    public ResponseEntity<byte[]> processPdfToXML(@ModelAttribute PDFFile request)
-		PDFToFile pdfToFile = new PDFToFile();
+            throws Exception {
-		return pdfToFile.processPdfToOfficeFormat(inputFile, "xml", "writer_pdf_import");
+        MultipartFile inputFile = request.getFileInput();
-	}
 
+        PDFToFile pdfToFile = new PDFToFile();
+        return pdfToFile.processPdfToOfficeFormat(inputFile, "xml", "writer_pdf_import");
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToPDFA.java

@@ -14,6 +14,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.PDFFile;
 import stirling.software.SPDF.utils.ProcessExecutor;
 import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
@@ -24,14 +25,13 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "Convert", description = "Convert APIs")
 public class ConvertPDFToPDFA {
 
-	@PostMapping(consumes = "multipart/form-data", value = "/pdf/pdfa")
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/pdfa")
-	@Operation(
+    @Operation(
-	    summary = "Convert a PDF to a PDF/A",
+            summary = "Convert a PDF to a PDF/A",
-	    description = "This endpoint converts a PDF file to a PDF/A file. PDF/A is a format designed for long-term archiving of digital documents. Input:PDF Output:PDF Type:SISO"
+            description =
-	)
+                    "This endpoint converts a PDF file to a PDF/A file. PDF/A is a format designed for long-term archiving of digital documents. Input:PDF Output:PDF Type:SISO")
-	public ResponseEntity<byte[]> pdfToPdfA(@ModelAttribute PDFFile request) 
+    public ResponseEntity<byte[]> pdfToPdfA(@ModelAttribute PDFFile request) throws Exception {
-	        throws Exception {
+        MultipartFile inputFile = request.getFileInput();
-		MultipartFile inputFile = request.getFileInput();
 
         // Save the uploaded file to a temporary location
         Path tempInputFile = Files.createTempFile("input_", ".pdf");
@@ -50,7 +50,9 @@ public class ConvertPDFToPDFA {
         command.add(tempInputFile.toString());
         command.add(tempOutputFile.toString());
 
-        ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF).runCommandWithOutputHandling(command);
+        ProcessExecutorResult returnCode =
+                ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF)
+                        .runCommandWithOutputHandling(command);
 
         // Read the optimized PDF file
         byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
@@ -60,8 +62,8 @@ public class ConvertPDFToPDFA {
         Files.delete(tempOutputFile);
 
         // Return the optimized PDF as a response
-        String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_PDFA.pdf";
+        String outputFilename =
+                inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_PDFA.pdf";
         return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
     }
-
 }

src/main/java/stirling/software/SPDF/controller/api/converters/ConvertWebsiteToPDF.java

@@ -1,76 +1,87 @@
-package stirling.software.SPDF.controller.api.converters;
+package stirling.software.SPDF.controller.api.converters;
-
+
-import java.io.IOException;
+import java.io.IOException;
-import java.nio.file.Files;
+import java.nio.file.Files;
-import java.nio.file.Path;
+import java.nio.file.Path;
-import java.util.ArrayList;
+import java.util.ArrayList;
-import java.util.List;
+import java.util.List;
-
+
-import org.springframework.http.ResponseEntity;
+import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ModelAttribute;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.PostMapping;
-
+import org.springframework.web.bind.annotation.RequestMapping;
-import io.swagger.v3.oas.annotations.Operation;
+import org.springframework.web.bind.annotation.RestController;
-import io.swagger.v3.oas.annotations.tags.Tag;
+
-import stirling.software.SPDF.model.api.converters.UrlToPdfRequest;
+import io.swagger.v3.oas.annotations.Operation;
-import stirling.software.SPDF.utils.GeneralUtils;
+import io.swagger.v3.oas.annotations.tags.Tag;
-import stirling.software.SPDF.utils.ProcessExecutor;
+
-import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
+import stirling.software.SPDF.model.api.converters.UrlToPdfRequest;
-import stirling.software.SPDF.utils.WebResponseUtils;
+import stirling.software.SPDF.utils.GeneralUtils;
-
+import stirling.software.SPDF.utils.ProcessExecutor;
-@RestController
+import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
-@Tag(name = "Convert", description = "Convert APIs")
+import stirling.software.SPDF.utils.WebResponseUtils;
-@RequestMapping("/api/v1/convert")
+
-public class ConvertWebsiteToPDF {
+@RestController
-
+@Tag(name = "Convert", description = "Convert APIs")
-	@PostMapping(consumes = "multipart/form-data", value = "/url/pdf")
+@RequestMapping("/api/v1/convert")
-	@Operation(
+public class ConvertWebsiteToPDF {
-	    summary = "Convert a URL to a PDF",
+
-	    description = "This endpoint fetches content from a URL and converts it to a PDF format."
+    @Autowired
-	)
+    @Qualifier("htmlFormatsInstalled")
-	public ResponseEntity<byte[]> urlToPdf(@ModelAttribute UrlToPdfRequest request) throws IOException, InterruptedException {
+    private boolean htmlFormatsInstalled;
-	    String URL = request.getUrlInput();
+
-
+    @PostMapping(consumes = "multipart/form-data", value = "/url/pdf")
-	    // Validate the URL format
+    @Operation(
-	    if(!URL.matches("^https?://.*") || !GeneralUtils.isValidURL(URL)) {
+            summary = "Convert a URL to a PDF",
-	        throw new IllegalArgumentException("Invalid URL format provided.");
+            description =
-	    }
+                    "This endpoint fetches content from a URL and converts it to a PDF format. Input:N/A Output:PDF Type:SISO")
-	    Path tempOutputFile = null;
+    public ResponseEntity<byte[]> urlToPdf(@ModelAttribute UrlToPdfRequest request)
-	    byte[] pdfBytes;
+            throws IOException, InterruptedException {
-	    try {
+        String URL = request.getUrlInput();
-		    // Prepare the output file path
+
-		    tempOutputFile = Files.createTempFile("output_", ".pdf");
+        // Validate the URL format
-	
+        if (!URL.matches("^https?://.*") || !GeneralUtils.isValidURL(URL)) {
-		    // Prepare the OCRmyPDF command
+            throw new IllegalArgumentException("Invalid URL format provided.");
-		    List<String> command = new ArrayList<>();
+        }
-		    command.add("weasyprint");
+        Path tempOutputFile = null;
-		    command.add(URL);
+        byte[] pdfBytes;
-		    command.add(tempOutputFile.toString());
+        try {
-	
+            // Prepare the output file path
-		    ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.WEASYPRINT).runCommandWithOutputHandling(command);
+            tempOutputFile = Files.createTempFile("output_", ".pdf");
-	
+
-		    // Read the optimized PDF file
+            // Prepare the OCRmyPDF command
-		    pdfBytes = Files.readAllBytes(tempOutputFile);
+            List<String> command = new ArrayList<>();
-	    }
+            if (!htmlFormatsInstalled) {
-	    finally {
+                command.add("weasyprint");
-		    // Clean up the temporary files
+            } else {
-		    Files.delete(tempOutputFile);
+                command.add("wkhtmltopdf");
-	    }
+            }
-	    // Convert URL to a safe filename
+            command.add(URL);
-	    String outputFilename = convertURLToFileName(URL);
+            command.add(tempOutputFile.toString());
-	    
+
-	    return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
+            ProcessExecutorResult returnCode =
-	}
+                    ProcessExecutor.getInstance(ProcessExecutor.Processes.WEASYPRINT)
-
+                            .runCommandWithOutputHandling(command);
-	private String convertURLToFileName(String url) {
+
-	    String safeName = url.replaceAll("[^a-zA-Z0-9]", "_");
+            // Read the optimized PDF file
-	    if(safeName.length() > 50) {
+            pdfBytes = Files.readAllBytes(tempOutputFile);
-	        safeName = safeName.substring(0, 50); // restrict to 50 characters
+        } finally {
-	    }
+            // Clean up the temporary files
-	    return safeName + ".pdf";
+            Files.delete(tempOutputFile);
-	}
+        }
-
+        // Convert URL to a safe filename
-
+        String outputFilename = convertURLToFileName(URL);
-}
+
+        return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
+    }
+
+    private String convertURLToFileName(String url) {
+        String safeName = url.replaceAll("[^a-zA-Z0-9]", "_");
+        if (safeName.length() > 50) {
+            safeName = safeName.substring(0, 50); // restrict to 50 characters
+        }
+        return safeName + ".pdf";
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/converters/ExtractController.java

@@ -0,0 +1,140 @@
+package stirling.software.SPDF.controller.api.converters;
+
+import java.io.ByteArrayInputStream;
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.ContentDisposition;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.opencsv.CSVWriter;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import stirling.software.SPDF.controller.api.CropController;
+import stirling.software.SPDF.controller.api.strippers.PDFTableStripper;
+import stirling.software.SPDF.model.api.extract.PDFFilePage;
+
+@RestController
+@RequestMapping("/api/v1/convert")
+@Tag(name = "Convert", description = "Convert APIs")
+public class ExtractController {
+
+    private static final Logger logger = LoggerFactory.getLogger(CropController.class);
+
+    @PostMapping(value = "/pdf/csv", consumes = "multipart/form-data")
+    @Operation(
+            summary = "Extracts a PDF document to csv",
+            description =
+                    "This operation takes an input PDF file and returns CSV file of whole page. Input:PDF Output:CSV Type:SISO")
+    public ResponseEntity<String> PdfToCsv(@ModelAttribute PDFFilePage form) throws Exception {
+
+        ArrayList<String> tableData = new ArrayList<>();
+        int columnsCount = 0;
+
+        try (PDDocument document =
+                PDDocument.load(new ByteArrayInputStream(form.getFileInput().getBytes()))) {
+            final double res = 72; // PDF units are at 72 DPI
+            PDFTableStripper stripper = new PDFTableStripper();
+            PDPage pdPage = document.getPage(form.getPageId() - 1);
+            stripper.extractTable(pdPage);
+            columnsCount = stripper.getColumns();
+            for (int c = 0; c < columnsCount; ++c) {
+                for (int r = 0; r < stripper.getRows(); ++r) {
+                    tableData.add(stripper.getText(r, c));
+                }
+            }
+        }
+
+        ArrayList<String> notEmptyColumns = new ArrayList<>();
+
+        for (String item : tableData) {
+            if (!item.trim().isEmpty()) {
+                notEmptyColumns.add(item);
+            } else {
+                columnsCount--;
+            }
+        }
+
+        List<String> fullTable =
+                notEmptyColumns.stream()
+                        .map(
+                                (entity) ->
+                                        entity.replace('\n', ' ')
+                                                .replace('\r', ' ')
+                                                .trim()
+                                                .replaceAll("\\s{2,}", "|"))
+                        .toList();
+
+        int rowsCount = fullTable.get(0).split("\\|").length;
+
+        ArrayList<String> headersList = getTableHeaders(columnsCount, fullTable);
+        ArrayList<String> recordList = getRecordsList(rowsCount, fullTable);
+
+        if (headersList.size() == 0 && recordList.size() == 0) {
+            throw new Exception("No table detected, no headers or records found");
+        }
+
+        StringWriter writer = new StringWriter();
+        try (CSVWriter csvWriter = new CSVWriter(writer)) {
+            csvWriter.writeNext(headersList.toArray(new String[0]));
+            for (String record : recordList) {
+                csvWriter.writeNext(record.split("\\|"));
+            }
+        }
+
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentDisposition(
+                ContentDisposition.builder("attachment")
+                        .filename(
+                                form.getFileInput()
+                                                .getOriginalFilename()
+                                                .replaceFirst("[.][^.]+$", "")
+                                        + "_extracted.csv")
+                        .build());
+        headers.setContentType(MediaType.parseMediaType("text/csv"));
+
+        return ResponseEntity.ok().headers(headers).body(writer.toString());
+    }
+
+    private ArrayList<String> getRecordsList(int rowsCounts, List<String> items) {
+        ArrayList<String> recordsList = new ArrayList<>();
+
+        for (int b = 1; b < rowsCounts; b++) {
+            StringBuilder strbldr = new StringBuilder();
+
+            for (int i = 0; i < items.size(); i++) {
+                String[] parts = items.get(i).split("\\|");
+                strbldr.append(parts[b]);
+                if (i != items.size() - 1) {
+                    strbldr.append("|");
+                }
+            }
+            recordsList.add(strbldr.toString());
+        }
+
+        return recordsList;
+    }
+
+    private ArrayList<String> getTableHeaders(int columnsCount, List<String> items) {
+        ArrayList<String> resultList = new ArrayList<>();
+        for (int i = 0; i < columnsCount; i++) {
+            String[] parts = items.get(i).split("\\|");
+            resultList.add(parts[0]);
+        }
+
+        return resultList;
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/filters/FilterController.java

@@ -1,196 +1,210 @@
-package stirling.software.SPDF.controller.api.filters;
+package stirling.software.SPDF.controller.api.filters;
-
+
-import java.io.IOException;
+import java.io.IOException;
-
+
-import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDDocument;
-import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDPage;
-import org.apache.pdfbox.pdmodel.common.PDRectangle;
+import org.apache.pdfbox.pdmodel.common.PDRectangle;
-import org.springframework.http.ResponseEntity;
+import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.ModelAttribute;
-import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.RestController;
-import org.springframework.web.multipart.MultipartFile;
+import org.springframework.web.multipart.MultipartFile;
-
+
-import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.tags.Tag;
+import io.swagger.v3.oas.annotations.tags.Tag;
-import stirling.software.SPDF.model.api.PDFComparisonAndCount;
+
-import stirling.software.SPDF.model.api.PDFWithPageNums;
+import stirling.software.SPDF.model.api.PDFComparisonAndCount;
-import stirling.software.SPDF.model.api.filter.ContainsTextRequest;
+import stirling.software.SPDF.model.api.PDFWithPageNums;
-import stirling.software.SPDF.model.api.filter.FileSizeRequest;
+import stirling.software.SPDF.model.api.filter.ContainsTextRequest;
-import stirling.software.SPDF.model.api.filter.PageRotationRequest;
+import stirling.software.SPDF.model.api.filter.FileSizeRequest;
-import stirling.software.SPDF.model.api.filter.PageSizeRequest;
+import stirling.software.SPDF.model.api.filter.PageRotationRequest;
-import stirling.software.SPDF.utils.PdfUtils;
+import stirling.software.SPDF.model.api.filter.PageSizeRequest;
-import stirling.software.SPDF.utils.WebResponseUtils;
+import stirling.software.SPDF.utils.PdfUtils;
-
+import stirling.software.SPDF.utils.WebResponseUtils;
-@RestController
+
-@RequestMapping("/api/v1/filter")
+@RestController
-@Tag(name = "Filter", description = "Filter APIs")
+@RequestMapping("/api/v1/filter")
-public class FilterController {
+@Tag(name = "Filter", description = "Filter APIs")
-
+public class FilterController {
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-contains-text")
+
-	@Operation(summary = "Checks if a PDF contains set text, returns true if does", description = "Input:PDF Output:Boolean Type:SISO")
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-contains-text")
-	public ResponseEntity<byte[]> containsText(@ModelAttribute ContainsTextRequest request) throws IOException, InterruptedException {
+    @Operation(
-	    MultipartFile inputFile = request.getFileInput();
+            summary = "Checks if a PDF contains set text, returns true if does",
-	    String text = request.getText();
+            description = "Input:PDF Output:Boolean Type:SISO")
-	    String pageNumber = request.getPageNumbers();
+    public ResponseEntity<byte[]> containsText(@ModelAttribute ContainsTextRequest request)
-	    
+            throws IOException, InterruptedException {
-		PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
+        MultipartFile inputFile = request.getFileInput();
-		if (PdfUtils.hasText(pdfDocument, pageNumber, text))
+        String text = request.getText();
-			return WebResponseUtils.pdfDocToWebResponse(pdfDocument, inputFile.getOriginalFilename());
+        String pageNumber = request.getPageNumbers();
-		return null;
+
-	}
+        PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
-
+        if (PdfUtils.hasText(pdfDocument, pageNumber, text))
-	// TODO
+            return WebResponseUtils.pdfDocToWebResponse(
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-contains-image")
+                    pdfDocument, inputFile.getOriginalFilename());
-	@Operation(summary = "Checks if a PDF contains an image", description = "Input:PDF Output:Boolean Type:SISO")
+        return null;
-	public ResponseEntity<byte[]> containsImage(@ModelAttribute PDFWithPageNums request)
+    }
-			throws IOException, InterruptedException {
+
-		MultipartFile inputFile = request.getFileInput();
+    // TODO
-	    String pageNumber = request.getPageNumbers();
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-contains-image")
-	    
+    @Operation(
-		PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
+            summary = "Checks if a PDF contains an image",
-		if (PdfUtils.hasImages(pdfDocument, pageNumber))
+            description = "Input:PDF Output:Boolean Type:SISO")
-			return WebResponseUtils.pdfDocToWebResponse(pdfDocument, inputFile.getOriginalFilename());
+    public ResponseEntity<byte[]> containsImage(@ModelAttribute PDFWithPageNums request)
-		return null;
+            throws IOException, InterruptedException {
-	}
+        MultipartFile inputFile = request.getFileInput();
-
+        String pageNumber = request.getPageNumbers();
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-page-count")
+
-	@Operation(summary = "Checks if a PDF is greater, less or equal to a setPageCount", description = "Input:PDF Output:Boolean Type:SISO")
+        PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
-	public ResponseEntity<byte[]> pageCount(@ModelAttribute PDFComparisonAndCount request) throws IOException, InterruptedException {
+        if (PdfUtils.hasImages(pdfDocument, pageNumber))
-	    MultipartFile inputFile = request.getFileInput();
+            return WebResponseUtils.pdfDocToWebResponse(
-	    String pageCount = request.getPageCount();
+                    pdfDocument, inputFile.getOriginalFilename());
-	    String comparator = request.getComparator();
+        return null;
-		// Load the PDF
+    }
-		PDDocument document = PDDocument.load(inputFile.getInputStream());
+
-		int actualPageCount = document.getNumberOfPages();
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-page-count")
-
+    @Operation(
-		boolean valid = false;
+            summary = "Checks if a PDF is greater, less or equal to a setPageCount",
-		// Perform the comparison
+            description = "Input:PDF Output:Boolean Type:SISO")
-		switch (comparator) {
+    public ResponseEntity<byte[]> pageCount(@ModelAttribute PDFComparisonAndCount request)
-		case "Greater":
+            throws IOException, InterruptedException {
-			valid = actualPageCount > Integer.parseInt(pageCount);
+        MultipartFile inputFile = request.getFileInput();
-			break;
+        String pageCount = request.getPageCount();
-		case "Equal":
+        String comparator = request.getComparator();
-			valid = actualPageCount == Integer.parseInt(pageCount);
+        // Load the PDF
-			break;
+        PDDocument document = PDDocument.load(inputFile.getInputStream());
-		case "Less":
+        int actualPageCount = document.getNumberOfPages();
-			valid = actualPageCount < Integer.parseInt(pageCount);
+
-			break;
+        boolean valid = false;
-		default:
+        // Perform the comparison
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
+        switch (comparator) {
-		}
+            case "Greater":
-
+                valid = actualPageCount > Integer.parseInt(pageCount);
-		if (valid)
+                break;
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+            case "Equal":
-		return null;
+                valid = actualPageCount == Integer.parseInt(pageCount);
-	}
+                break;
-
+            case "Less":
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-page-size")
+                valid = actualPageCount < Integer.parseInt(pageCount);
-	@Operation(summary = "Checks if a PDF is of a certain size", description = "Input:PDF Output:Boolean Type:SISO")
+                break;
-	public ResponseEntity<byte[]> pageSize(@ModelAttribute PageSizeRequest request) throws IOException, InterruptedException {
+            default:
-	    MultipartFile inputFile = request.getFileInput();
+                throw new IllegalArgumentException("Invalid comparator: " + comparator);
-	    String standardPageSize = request.getStandardPageSize();
+        }
-	    String comparator = request.getComparator();
+
-
+        if (valid) return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-		// Load the PDF
+        return null;
-		PDDocument document = PDDocument.load(inputFile.getInputStream());
+    }
-
+
-		PDPage firstPage = document.getPage(0);
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-page-size")
-		PDRectangle actualPageSize = firstPage.getMediaBox();
+    @Operation(
-
+            summary = "Checks if a PDF is of a certain size",
-		// Calculate the area of the actual page size
+            description = "Input:PDF Output:Boolean Type:SISO")
-		float actualArea = actualPageSize.getWidth() * actualPageSize.getHeight();
+    public ResponseEntity<byte[]> pageSize(@ModelAttribute PageSizeRequest request)
-
+            throws IOException, InterruptedException {
-		// Get the standard size and calculate its area
+        MultipartFile inputFile = request.getFileInput();
-		PDRectangle standardSize = PdfUtils.textToPageSize(standardPageSize);
+        String standardPageSize = request.getStandardPageSize();
-		float standardArea = standardSize.getWidth() * standardSize.getHeight();
+        String comparator = request.getComparator();
-
+
-		boolean valid = false;
+        // Load the PDF
-		// Perform the comparison
+        PDDocument document = PDDocument.load(inputFile.getInputStream());
-		switch (comparator) {
+
-		case "Greater":
+        PDPage firstPage = document.getPage(0);
-			valid = actualArea > standardArea;
+        PDRectangle actualPageSize = firstPage.getMediaBox();
-			break;
+
-		case "Equal":
+        // Calculate the area of the actual page size
-			valid = actualArea == standardArea;
+        float actualArea = actualPageSize.getWidth() * actualPageSize.getHeight();
-			break;
+
-		case "Less":
+        // Get the standard size and calculate its area
-			valid = actualArea < standardArea;
+        PDRectangle standardSize = PdfUtils.textToPageSize(standardPageSize);
-			break;
+        float standardArea = standardSize.getWidth() * standardSize.getHeight();
-		default:
+
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
+        boolean valid = false;
-		}
+        // Perform the comparison
-
+        switch (comparator) {
-		if (valid)
+            case "Greater":
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+                valid = actualArea > standardArea;
-		return null;
+                break;
-	}
+            case "Equal":
-
+                valid = actualArea == standardArea;
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-file-size")
+                break;
-	@Operation(summary = "Checks if a PDF is a set file size", description = "Input:PDF Output:Boolean Type:SISO")
+            case "Less":
-	public ResponseEntity<byte[]> fileSize(@ModelAttribute FileSizeRequest request) throws IOException, InterruptedException {
+                valid = actualArea < standardArea;
-	    MultipartFile inputFile = request.getFileInput();
+                break;
-	    String fileSize = request.getFileSize();
+            default:
-	    String comparator = request.getComparator();
+                throw new IllegalArgumentException("Invalid comparator: " + comparator);
-
+        }
-		// Get the file size
+
-		long actualFileSize = inputFile.getSize();
+        if (valid) return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-
+        return null;
-		boolean valid = false;
+    }
-		// Perform the comparison
+
-		switch (comparator) {
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-file-size")
-		case "Greater":
+    @Operation(
-			valid = actualFileSize > Long.parseLong(fileSize);
+            summary = "Checks if a PDF is a set file size",
-			break;
+            description = "Input:PDF Output:Boolean Type:SISO")
-		case "Equal":
+    public ResponseEntity<byte[]> fileSize(@ModelAttribute FileSizeRequest request)
-			valid = actualFileSize == Long.parseLong(fileSize);
+            throws IOException, InterruptedException {
-			break;
+        MultipartFile inputFile = request.getFileInput();
-		case "Less":
+        String fileSize = request.getFileSize();
-			valid = actualFileSize < Long.parseLong(fileSize);
+        String comparator = request.getComparator();
-			break;
+
-		default:
+        // Get the file size
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
+        long actualFileSize = inputFile.getSize();
-		}
+
-
+        boolean valid = false;
-		if (valid)
+        // Perform the comparison
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+        switch (comparator) {
-		return null;
+            case "Greater":
-	}
+                valid = actualFileSize > Long.parseLong(fileSize);
-
+                break;
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-page-rotation")
+            case "Equal":
-	@Operation(summary = "Checks if a PDF is of a certain rotation", description = "Input:PDF Output:Boolean Type:SISO")
+                valid = actualFileSize == Long.parseLong(fileSize);
-	public ResponseEntity<byte[]> pageRotation(@ModelAttribute PageRotationRequest request) throws IOException, InterruptedException {
+                break;
-	    MultipartFile inputFile = request.getFileInput();
+            case "Less":
-	    int rotation = request.getRotation();
+                valid = actualFileSize < Long.parseLong(fileSize);
-	    String comparator = request.getComparator();
+                break;
-
+            default:
-		// Load the PDF
+                throw new IllegalArgumentException("Invalid comparator: " + comparator);
-		PDDocument document = PDDocument.load(inputFile.getInputStream());
+        }
-
+
-		// Get the rotation of the first page
+        if (valid) return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-		PDPage firstPage = document.getPage(0);
+        return null;
-		int actualRotation = firstPage.getRotation();
+    }
-		boolean valid = false;
+
-		// Perform the comparison
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-page-rotation")
-		switch (comparator) {
+    @Operation(
-		case "Greater":
+            summary = "Checks if a PDF is of a certain rotation",
-			valid = actualRotation > rotation;
+            description = "Input:PDF Output:Boolean Type:SISO")
-			break;
+    public ResponseEntity<byte[]> pageRotation(@ModelAttribute PageRotationRequest request)
-		case "Equal":
+            throws IOException, InterruptedException {
-			valid = actualRotation == rotation;
+        MultipartFile inputFile = request.getFileInput();
-			break;
+        int rotation = request.getRotation();
-		case "Less":
+        String comparator = request.getComparator();
-			valid = actualRotation < rotation;
+
-			break;
+        // Load the PDF
-		default:
+        PDDocument document = PDDocument.load(inputFile.getInputStream());
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
+
-		}
+        // Get the rotation of the first page
-
+        PDPage firstPage = document.getPage(0);
-		if (valid)
+        int actualRotation = firstPage.getRotation();
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+        boolean valid = false;
-		return null;
+        // Perform the comparison
-
+        switch (comparator) {
-	}
+            case "Greater":
-
+                valid = actualRotation > rotation;
-}
+                break;
+            case "Equal":
+                valid = actualRotation == rotation;
+                break;
+            case "Less":
+                valid = actualRotation < rotation;
+                break;
+            default:
+                throw new IllegalArgumentException("Invalid comparator: " + comparator);
+        }
+
+        if (valid) return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+        return null;
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/misc/AutoRenameController.java

@@ -19,8 +19,10 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.misc.ExtractHeaderRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/misc")
 @Tag(name = "Misc", description = "Miscellaneous APIs")
@@ -32,97 +34,105 @@ public class AutoRenameController {
     private static final int LINE_LIMIT = 11;
 
     @PostMapping(consumes = "multipart/form-data", value = "/auto-rename")
-    @Operation(summary = "Extract header from PDF file", description = "This endpoint accepts a PDF file and attempts to extract its title or header based on heuristics. Input:PDF Output:PDF Type:SISO")
+    @Operation(
-    public ResponseEntity<byte[]> extractHeader(@ModelAttribute ExtractHeaderRequest request) throws Exception {
+            summary = "Extract header from PDF file",
+            description =
+                    "This endpoint accepts a PDF file and attempts to extract its title or header based on heuristics. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> extractHeader(@ModelAttribute ExtractHeaderRequest request)
+            throws Exception {
         MultipartFile file = request.getFileInput();
         Boolean useFirstTextAsFallback = request.isUseFirstTextAsFallback();
 
-    	        PDDocument document = PDDocument.load(file.getInputStream());
+        PDDocument document = PDDocument.load(file.getInputStream());
-    	        PDFTextStripper reader = new PDFTextStripper() {
+        PDFTextStripper reader =
-    	            class LineInfo {
+                new PDFTextStripper() {
-    	                String text;
+                    class LineInfo {
-    	                float fontSize;
+                        String text;
+                        float fontSize;
 
-    	                LineInfo(String text, float fontSize) {
+                        LineInfo(String text, float fontSize) {
-    	                    this.text = text;
+                            this.text = text;
-    	                    this.fontSize = fontSize;
+                            this.fontSize = fontSize;
-    	                }
+                        }
-    	            }
+                    }
 
-    	            List<LineInfo> lineInfos = new ArrayList<>();
+                    List<LineInfo> lineInfos = new ArrayList<>();
-    	            StringBuilder lineBuilder = new StringBuilder();
+                    StringBuilder lineBuilder = new StringBuilder();
-    	            float lastY = -1;
+                    float lastY = -1;
-    	            float maxFontSizeInLine = 0.0f;
+                    float maxFontSizeInLine = 0.0f;
-    	            int lineCount = 0;
+                    int lineCount = 0;
 
-    	            @Override
+                    @Override
-    	            protected void processTextPosition(TextPosition text) {
+                    protected void processTextPosition(TextPosition text) {
-    	                if (lastY != text.getY() && lineCount < LINE_LIMIT) {
+                        if (lastY != text.getY() && lineCount < LINE_LIMIT) {
-    	                    processLine();
+                            processLine();
-    	                    lineBuilder = new StringBuilder(text.getUnicode());
+                            lineBuilder = new StringBuilder(text.getUnicode());
-    	                    maxFontSizeInLine = text.getFontSizeInPt();
+                            maxFontSizeInLine = text.getFontSizeInPt();
-    	                    lastY = text.getY();
+                            lastY = text.getY();
-    	                    lineCount++;
+                            lineCount++;
-    	                } else if (lineCount < LINE_LIMIT) {
+                        } else if (lineCount < LINE_LIMIT) {
-    	                    lineBuilder.append(text.getUnicode());
+                            lineBuilder.append(text.getUnicode());
-    	                    if (text.getFontSizeInPt() > maxFontSizeInLine) {
+                            if (text.getFontSizeInPt() > maxFontSizeInLine) {
-    	                        maxFontSizeInLine = text.getFontSizeInPt();
+                                maxFontSizeInLine = text.getFontSizeInPt();
-    	                    }
+                            }
-    	                }
+                        }
-    	            }
+                    }
 
-    	            private void processLine() {
+                    private void processLine() {
-    	                if (lineBuilder.length() > 0 && lineCount < LINE_LIMIT) {
+                        if (lineBuilder.length() > 0 && lineCount < LINE_LIMIT) {
-    	                    lineInfos.add(new LineInfo(lineBuilder.toString(), maxFontSizeInLine));
+                            lineInfos.add(new LineInfo(lineBuilder.toString(), maxFontSizeInLine));
-    	                }
+                        }
-    	            }
+                    }
 
-    	            @Override
+                    @Override
-    	            public String getText(PDDocument doc) throws IOException {
+                    public String getText(PDDocument doc) throws IOException {
-    	                this.lineInfos.clear();
+                        this.lineInfos.clear();
-    	                this.lineBuilder = new StringBuilder();
+                        this.lineBuilder = new StringBuilder();
-    	                this.lastY = -1;
+                        this.lastY = -1;
-    	                this.maxFontSizeInLine = 0.0f;
+                        this.maxFontSizeInLine = 0.0f;
-    	                this.lineCount = 0;
+                        this.lineCount = 0;
-    	                super.getText(doc);
+                        super.getText(doc);
-    	                processLine(); // Process the last line
+                        processLine(); // Process the last line
 
-    	                // Merge lines with same font size
+                        // Merge lines with same font size
-    	                List<LineInfo> mergedLineInfos = new ArrayList<>();
+                        List<LineInfo> mergedLineInfos = new ArrayList<>();
-    	                for (int i = 0; i < lineInfos.size(); i++) {
+                        for (int i = 0; i < lineInfos.size(); i++) {
-    	                    String mergedText = lineInfos.get(i).text;
+                            String mergedText = lineInfos.get(i).text;
-    	                    float fontSize = lineInfos.get(i).fontSize;
+                            float fontSize = lineInfos.get(i).fontSize;
-    	                    while (i + 1 < lineInfos.size() && lineInfos.get(i + 1).fontSize == fontSize) {
+                            while (i + 1 < lineInfos.size()
-    	                        mergedText += " " + lineInfos.get(i + 1).text;
+                                    && lineInfos.get(i + 1).fontSize == fontSize) {
-    	                        i++;
+                                mergedText += " " + lineInfos.get(i + 1).text;
-    	                    }
+                                i++;
-    	                    mergedLineInfos.add(new LineInfo(mergedText, fontSize));
+                            }
-    	                }
+                            mergedLineInfos.add(new LineInfo(mergedText, fontSize));
+                        }
 
-    	                // Sort lines by font size in descending order and get the first one
+                        // Sort lines by font size in descending order and get the first one
-    	                mergedLineInfos.sort(Comparator.comparing((LineInfo li) -> li.fontSize).reversed());
+                        mergedLineInfos.sort(
-    	                String title = mergedLineInfos.isEmpty() ? null : mergedLineInfos.get(0).text;
+                                Comparator.comparing((LineInfo li) -> li.fontSize).reversed());
+                        String title =
+                                mergedLineInfos.isEmpty() ? null : mergedLineInfos.get(0).text;
 
-    	                return title != null ? title : (useFirstTextAsFallback ? (mergedLineInfos.isEmpty() ? null : mergedLineInfos.get(mergedLineInfos.size() - 1).text) : null);
+                        return title != null
-    	            }
+                                ? title
+                                : (useFirstTextAsFallback
+                                        ? (mergedLineInfos.isEmpty()
+                                                ? null
+                                                : mergedLineInfos.get(mergedLineInfos.size() - 1)
+                                                        .text)
+                                        : null);
+                    }
+                };
 
-    	        };
+        String header = reader.getText(document);
 
-    	        String header = reader.getText(document);
-
-
-        
         // Sanitize the header string by removing characters not allowed in a filename.
         if (header != null && header.length() < 255) {
             header = header.replaceAll("[/\\\\?%*:|\"<>]", "");
             return WebResponseUtils.pdfDocToWebResponse(document, header + ".pdf");
         } else {
-        	logger.info("File has no good title to be found");
+            logger.info("File has no good title to be found");
-        	return WebResponseUtils.pdfDocToWebResponse(document, file.getOriginalFilename());
+            return WebResponseUtils.pdfDocToWebResponse(document, file.getOriginalFilename());
         }
     }
-    
-
-
-
 }

src/main/java/stirling/software/SPDF/controller/api/misc/AutoSplitPdfController.java

@@ -1,4 +1,5 @@
 package stirling.software.SPDF.controller.api.misc;
+
 import java.awt.image.BufferedImage;
 import java.awt.image.DataBufferByte;
 import java.awt.image.DataBufferInt;
@@ -32,6 +33,7 @@ import com.google.zxing.common.HybridBinarizer;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.misc.AutoSplitPdfRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -40,11 +42,15 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "Misc", description = "Miscellaneous APIs")
 public class AutoSplitPdfController {
 
-    private static final String QR_CONTENT = "https://github.com/Frooodle/Stirling-PDF";
+    private static final String QR_CONTENT = "https://github.com/Stirling-Tools/Stirling-PDF";
 
     @PostMapping(value = "/auto-split-pdf", consumes = "multipart/form-data")
-    @Operation(summary = "Auto split PDF pages into separate documents", description = "This endpoint accepts a PDF file, scans each page for a specific QR code, and splits the document at the QR code boundaries. The output is a zip file containing each separate PDF document. Input:PDF Output:ZIP Type:SISO")
+    @Operation(
-    public ResponseEntity<byte[]> autoSplitPdf(@ModelAttribute AutoSplitPdfRequest request) throws IOException {
+            summary = "Auto split PDF pages into separate documents",
+            description =
+                    "This endpoint accepts a PDF file, scans each page for a specific QR code, and splits the document at the QR code boundaries. The output is a zip file containing each separate PDF document. Input:PDF Output:ZIP-PDF Type:SISO")
+    public ResponseEntity<byte[]> autoSplitPdf(@ModelAttribute AutoSplitPdfRequest request)
+            throws IOException {
         MultipartFile file = request.getFileInput();
         boolean duplexMode = request.isDuplexMode();
 
@@ -107,29 +113,48 @@ public class AutoSplitPdfController {
         } catch (Exception e) {
             e.printStackTrace();
         } finally {
-        	data = Files.readAllBytes(zipFile);
+            data = Files.readAllBytes(zipFile);
             Files.delete(zipFile);
         }
 
-        return WebResponseUtils.bytesToWebResponse(data, filename + ".zip", MediaType.APPLICATION_OCTET_STREAM);
+        return WebResponseUtils.bytesToWebResponse(
+                data, filename + ".zip", MediaType.APPLICATION_OCTET_STREAM);
     }
 
-
     private static String decodeQRCode(BufferedImage bufferedImage) {
         LuminanceSource source;
 
         if (bufferedImage.getRaster().getDataBuffer() instanceof DataBufferByte) {
             byte[] pixels = ((DataBufferByte) bufferedImage.getRaster().getDataBuffer()).getData();
-            source = new PlanarYUVLuminanceSource(pixels, bufferedImage.getWidth(), bufferedImage.getHeight(), 0, 0, bufferedImage.getWidth(), bufferedImage.getHeight(), false);
+            source =
+                    new PlanarYUVLuminanceSource(
+                            pixels,
+                            bufferedImage.getWidth(),
+                            bufferedImage.getHeight(),
+                            0,
+                            0,
+                            bufferedImage.getWidth(),
+                            bufferedImage.getHeight(),
+                            false);
         } else if (bufferedImage.getRaster().getDataBuffer() instanceof DataBufferInt) {
             int[] pixels = ((DataBufferInt) bufferedImage.getRaster().getDataBuffer()).getData();
             byte[] newPixels = new byte[pixels.length];
             for (int i = 0; i < pixels.length; i++) {
                 newPixels[i] = (byte) (pixels[i] & 0xff);
             }
-            source = new PlanarYUVLuminanceSource(newPixels, bufferedImage.getWidth(), bufferedImage.getHeight(), 0, 0, bufferedImage.getWidth(), bufferedImage.getHeight(), false);
+            source =
+                    new PlanarYUVLuminanceSource(
+                            newPixels,
+                            bufferedImage.getWidth(),
+                            bufferedImage.getHeight(),
+                            0,
+                            0,
+                            bufferedImage.getWidth(),
+                            bufferedImage.getHeight(),
+                            false);
         } else {
-            throw new IllegalArgumentException("BufferedImage must have 8-bit gray scale, 24-bit RGB, 32-bit ARGB (packed int), byte gray, or 3-byte/4-byte RGB image data");
+            throw new IllegalArgumentException(
+                    "BufferedImage must have 8-bit gray scale, 24-bit RGB, 32-bit ARGB (packed int), byte gray, or 3-byte/4-byte RGB image data");
         }
 
         BinaryBitmap bitmap = new BinaryBitmap(new HybridBinarizer(source));

src/main/java/stirling/software/SPDF/controller/api/misc/BlankPageController.java

@@ -28,6 +28,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.misc.RemoveBlankPagesRequest;
 import stirling.software.SPDF.utils.PdfUtils;
 import stirling.software.SPDF.utils.ProcessExecutor;
@@ -39,17 +40,18 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "Misc", description = "Miscellaneous APIs")
 public class BlankPageController {
 
-	@PostMapping(consumes = "multipart/form-data", value = "/remove-blanks")
+    @PostMapping(consumes = "multipart/form-data", value = "/remove-blanks")
-	@Operation(
+    @Operation(
-	    summary = "Remove blank pages from a PDF file",
+            summary = "Remove blank pages from a PDF file",
-	    description = "This endpoint removes blank pages from a given PDF file. Users can specify the threshold and white percentage to tune the detection of blank pages. Input:PDF Output:PDF Type:SISO"
+            description =
-	)
+                    "This endpoint removes blank pages from a given PDF file. Users can specify the threshold and white percentage to tune the detection of blank pages. Input:PDF Output:PDF Type:SISO")
-	public ResponseEntity<byte[]> removeBlankPages(@ModelAttribute RemoveBlankPagesRequest request) throws IOException, InterruptedException {
+    public ResponseEntity<byte[]> removeBlankPages(@ModelAttribute RemoveBlankPagesRequest request)
-	    MultipartFile inputFile = request.getFileInput();
+            throws IOException, InterruptedException {
-	    int threshold = request.getThreshold();
+        MultipartFile inputFile = request.getFileInput();
-	    float whitePercent = request.getWhitePercent();
+        int threshold = request.getThreshold();
-		
+        float whitePercent = request.getWhitePercent();
-    	PDDocument document = null;
+
+        PDDocument document = null;
         try {
             document = PDDocument.load(inputFile.getInputStream());
             PDPageTree pages = document.getDocumentCatalog().getPages();
@@ -72,21 +74,34 @@ public class BlankPageController {
                     boolean hasImages = PdfUtils.hasImagesOnPage(page);
                     if (hasImages) {
                         System.out.println("page " + pageIndex + " has image");
-    
+
                         Path tempFile = Files.createTempFile("image_", ".png");
-    
+
                         // Render image and save as temp file
                         BufferedImage image = pdfRenderer.renderImageWithDPI(pageIndex, 300);
                         ImageIO.write(image, "png", tempFile.toFile());
-    
+
-                        List<String> command = new ArrayList<>(Arrays.asList("python3", System.getProperty("user.dir") + "/scripts/detect-blank-pages.py", tempFile.toString() ,"--threshold", String.valueOf(threshold), "--white_percent", String.valueOf(whitePercent)));
+                        List<String> command =
-    
+                                new ArrayList<>(
+                                        Arrays.asList(
+                                                "python3",
+                                                System.getProperty("user.dir")
+                                                        + "/scripts/detect-blank-pages.py",
+                                                tempFile.toString(),
+                                                "--threshold",
+                                                String.valueOf(threshold),
+                                                "--white_percent",
+                                                String.valueOf(whitePercent)));
+
                         // Run CLI command
-                        ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.PYTHON_OPENCV).runCommandWithOutputHandling(command);
+                        ProcessExecutorResult returnCode =
-    
+                                ProcessExecutor.getInstance(ProcessExecutor.Processes.PYTHON_OPENCV)
+                                        .runCommandWithOutputHandling(command);
+
                         // does contain data
                         if (returnCode.getRc() == 0) {
-                            System.out.println("page " + pageIndex + " has image which is not blank");
+                            System.out.println(
+                                    "page " + pageIndex + " has image which is not blank");
                             pagesToKeepIndex.add(pageIndex);
                         } else {
                             System.out.println("Skipping, Image was blank for page #" + pageIndex);
@@ -94,12 +109,12 @@ public class BlankPageController {
                     }
                 }
                 pageIndex++;
-                
             }
             System.out.print("pagesToKeep=" + pagesToKeepIndex.size());
 
             // Remove pages not present in pagesToKeepIndex
-            List<Integer> pageIndices = IntStream.range(0, pages.getCount()).boxed().collect(Collectors.toList());
+            List<Integer> pageIndices =
+                    IntStream.range(0, pages.getCount()).boxed().collect(Collectors.toList());
             Collections.reverse(pageIndices); // Reverse to prevent index shifting during removal
             for (Integer i : pageIndices) {
                 if (!pagesToKeepIndex.contains(i)) {
@@ -107,16 +122,15 @@ public class BlankPageController {
                 }
             }
 
-            return WebResponseUtils.pdfDocToWebResponse(document, inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_blanksRemoved.pdf");
+            return WebResponseUtils.pdfDocToWebResponse(
+                    document,
+                    inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "")
+                            + "_blanksRemoved.pdf");
         } catch (IOException e) {
             e.printStackTrace();
             return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
         } finally {
-            if (document != null)
+            if (document != null) document.close();
-                document.close();
         }
     }
-
-
-    
 }

src/main/java/stirling/software/SPDF/controller/api/misc/CompressController.java

@@ -30,6 +30,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.misc.OptimizePdfRequest;
 import stirling.software.SPDF.utils.GeneralUtils;
 import stirling.software.SPDF.utils.ProcessExecutor;
@@ -44,20 +45,23 @@ public class CompressController {
     private static final Logger logger = LoggerFactory.getLogger(CompressController.class);
 
     @PostMapping(consumes = "multipart/form-data", value = "/compress-pdf")
-    @Operation(summary = "Optimize PDF file", description = "This endpoint accepts a PDF file and optimizes it based on the provided parameters. Input:PDF Output:PDF Type:SISO")
+    @Operation(
-    public ResponseEntity<byte[]> optimizePdf(@ModelAttribute OptimizePdfRequest request) throws Exception {
+            summary = "Optimize PDF file",
+            description =
+                    "This endpoint accepts a PDF file and optimizes it based on the provided parameters. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> optimizePdf(@ModelAttribute OptimizePdfRequest request)
+            throws Exception {
         MultipartFile inputFile = request.getFileInput();
         Integer optimizeLevel = request.getOptimizeLevel();
         String expectedOutputSizeString = request.getExpectedOutputSize();
 
-
+        if (expectedOutputSizeString == null && optimizeLevel == null) {
-        if(expectedOutputSizeString == null && optimizeLevel == null) {
             throw new Exception("Both expected output size and optimize level are not specified");
         }
 
         Long expectedOutputSize = 0L;
         boolean autoMode = false;
-        if (expectedOutputSizeString != null && expectedOutputSizeString.length() > 1 ) {
+        if (expectedOutputSizeString != null && expectedOutputSizeString.length() > 1) {
             expectedOutputSize = GeneralUtils.convertSizeToBytes(expectedOutputSizeString);
             autoMode = true;
         }
@@ -71,8 +75,9 @@ public class CompressController {
         // Prepare the output file path
         Path tempOutputFile = Files.createTempFile("output_", ".pdf");
 
-        // Determine initial optimization level based on expected size reduction, only if in autoMode
+        // Determine initial optimization level based on expected size reduction, only if in
-        if(autoMode) {
+        // autoMode
+        if (autoMode) {
             double sizeReductionRatio = expectedOutputSize / (double) inputFileSize;
             if (sizeReductionRatio > 0.7) {
                 optimizeLevel = 1;
@@ -94,20 +99,20 @@ public class CompressController {
             command.add("-dCompatibilityLevel=1.4");
 
             switch (optimizeLevel) {
-            case 1:
+                case 1:
-                command.add("-dPDFSETTINGS=/prepress");
+                    command.add("-dPDFSETTINGS=/prepress");
-                break;
+                    break;
-            case 2:
+                case 2:
-                command.add("-dPDFSETTINGS=/printer");
+                    command.add("-dPDFSETTINGS=/printer");
-                break;    
+                    break;
-            case 3:
+                case 3:
-                command.add("-dPDFSETTINGS=/ebook");
+                    command.add("-dPDFSETTINGS=/ebook");
-                break;
+                    break;
-            case 4:
+                case 4:
-                command.add("-dPDFSETTINGS=/screen");
+                    command.add("-dPDFSETTINGS=/screen");
-                break;
+                    break;
-            default:
+                default:
-                command.add("-dPDFSETTINGS=/default");
+                    command.add("-dPDFSETTINGS=/default");
             }
 
             command.add("-dNOPAUSE");
@@ -116,7 +121,9 @@ public class CompressController {
             command.add("-sOutputFile=" + tempOutputFile.toString());
             command.add(tempInputFile.toString());
 
-            ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.GHOSTSCRIPT).runCommandWithOutputHandling(command);
+            ProcessExecutorResult returnCode =
+                    ProcessExecutor.getInstance(ProcessExecutor.Processes.GHOSTSCRIPT)
+                            .runCommandWithOutputHandling(command);
 
             // Check if file size is within expected size or not auto mode so instantly finish
             long outputFileSize = Files.size(tempOutputFile);
@@ -125,19 +132,18 @@ public class CompressController {
             } else {
                 // Increase optimization level for next iteration
                 optimizeLevel++;
-                if(autoMode && optimizeLevel > 3) {
+                if (autoMode && optimizeLevel > 3) {
                     System.out.println("Skipping level 4 due to bad results in auto mode");
                     sizeMet = true;
-                } else if(optimizeLevel == 5) {
+                } else if (optimizeLevel == 5) {
-                    
+
                 } else {
-                    System.out.println("Increasing ghostscript optimisation level to " + optimizeLevel);
+                    System.out.println(
+                            "Increasing ghostscript optimisation level to " + optimizeLevel);
                 }
             }
         }
 
-        
-
         if (expectedOutputSize != null && autoMode) {
             long outputFileSize = Files.size(tempOutputFile);
             if (outputFileSize > expectedOutputSize) {
@@ -157,8 +163,8 @@ public class CompressController {
                                     BufferedImage bufferedImage = image.getImage();
 
                                     // Calculate the new dimensions
-                                    int newWidth = (int)(bufferedImage.getWidth() * scaleFactor);
+                                    int newWidth = (int) (bufferedImage.getWidth() * scaleFactor);
-                                    int newHeight = (int)(bufferedImage.getHeight() * scaleFactor);
+                                    int newHeight = (int) (bufferedImage.getHeight() * scaleFactor);
 
                                     // If the new dimensions are zero, skip this iteration
                                     if (newWidth == 0 || newHeight == 0) {
@@ -166,23 +172,39 @@ public class CompressController {
                                     }
 
                                     // Otherwise, proceed with the scaling
-                                    Image scaledImage = bufferedImage.getScaledInstance(newWidth, newHeight, Image.SCALE_SMOOTH);
+                                    Image scaledImage =
+                                            bufferedImage.getScaledInstance(
+                                                    newWidth, newHeight, Image.SCALE_SMOOTH);
 
                                     // Convert the scaled image back to a BufferedImage
-                                    BufferedImage scaledBufferedImage = new BufferedImage(newWidth, newHeight, BufferedImage.TYPE_INT_RGB);
+                                    BufferedImage scaledBufferedImage =
-                                    scaledBufferedImage.getGraphics().drawImage(scaledImage, 0, 0, null);
+                                            new BufferedImage(
+                                                    newWidth,
+                                                    newHeight,
+                                                    BufferedImage.TYPE_INT_RGB);
+                                    scaledBufferedImage
+                                            .getGraphics()
+                                            .drawImage(scaledImage, 0, 0, null);
 
                                     // Compress the scaled image
-                                    ByteArrayOutputStream compressedImageStream = new ByteArrayOutputStream();
+                                    ByteArrayOutputStream compressedImageStream =
-                                    ImageIO.write(scaledBufferedImage, "jpeg", compressedImageStream);
+                                            new ByteArrayOutputStream();
+                                    ImageIO.write(
+                                            scaledBufferedImage, "jpeg", compressedImageStream);
                                     byte[] imageBytes = compressedImageStream.toByteArray();
                                     compressedImageStream.close();
 
                                     // Convert compressed image back to PDImageXObject
-                                    ByteArrayInputStream bais = new ByteArrayInputStream(imageBytes);
+                                    ByteArrayInputStream bais =
-                                    PDImageXObject compressedImage = PDImageXObject.createFromByteArray(doc, imageBytes, image.getCOSObject().toString());
+                                            new ByteArrayInputStream(imageBytes);
+                                    PDImageXObject compressedImage =
+                                            PDImageXObject.createFromByteArray(
+                                                    doc,
+                                                    imageBytes,
+                                                    image.getCOSObject().toString());
 
-                                    // Replace the image in the resources with the compressed version
+                                    // Replace the image in the resources with the compressed
+                                    // version
                                     res.put(name, compressedImage);
                                 }
                             }
@@ -194,16 +216,23 @@ public class CompressController {
                         long currentSize = Files.size(tempOutputFile);
                         // Check if the overall PDF size is still larger than expectedOutputSize
                         if (currentSize > expectedOutputSize) {
-                         // Log the current file size and scaleFactor
+                            // Log the current file size and scaleFactor
-                            
+
-                            System.out.println("Current file size: " + FileUtils.byteCountToDisplaySize(currentSize));
+                            System.out.println(
+                                    "Current file size: "
+                                            + FileUtils.byteCountToDisplaySize(currentSize));
                             System.out.println("Current scale factor: " + scaleFactor);
 
                             // The file is still too large, reduce scaleFactor and try again
                             scaleFactor *= 0.9; // reduce scaleFactor by 10%
                             // Avoid scaleFactor being too small, causing the image to shrink to 0
-                            if(scaleFactor < 0.2 || previousFileSize == currentSize){
+                            if (scaleFactor < 0.2 || previousFileSize == currentSize) {
-                                throw new RuntimeException("Could not reach the desired size without excessively degrading image quality, lowest size recommended is " + FileUtils.byteCountToDisplaySize(currentSize) + ", " + currentSize + " bytes");
+                                throw new RuntimeException(
+                                        "Could not reach the desired size without excessively degrading image quality, lowest size recommended is "
+                                                + FileUtils.byteCountToDisplaySize(currentSize)
+                                                + ", "
+                                                + currentSize
+                                                + " bytes");
                             }
                             previousFileSize = currentSize;
                         } else {
@@ -211,10 +240,7 @@ public class CompressController {
                             break;
                         }
                     }
-
                 }
-
-                    
             }
         }
 
@@ -222,9 +248,10 @@ public class CompressController {
         byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
 
         // Check if optimized file is larger than the original
-        if(pdfBytes.length > inputFileSize) {
+        if (pdfBytes.length > inputFileSize) {
             // Log the occurrence
-            logger.warn("Optimized file is larger than the original. Returning the original file instead.");
+            logger.warn(
+                    "Optimized file is larger than the original. Returning the original file instead.");
 
             // Read the original file again
             pdfBytes = Files.readAllBytes(tempInputFile);
@@ -235,8 +262,8 @@ public class CompressController {
         Files.delete(tempOutputFile);
 
         // Return the optimized PDF as a response
-        String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_Optimized.pdf";
+        String outputFilename =
+                inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_Optimized.pdf";
         return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
     }
-
 }

src/main/java/stirling/software/SPDF/controller/api/misc/ExtractImageScansController.java

@@ -32,10 +32,12 @@ import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.api.misc.ExtractImageScansRequest;
 import stirling.software.SPDF.utils.ProcessExecutor;
 import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/misc")
 @Tag(name = "Misc", description = "Miscellaneous APIs")
@@ -44,18 +46,28 @@ public class ExtractImageScansController {
     private static final Logger logger = LoggerFactory.getLogger(ExtractImageScansController.class);
 
     @PostMapping(consumes = "multipart/form-data", value = "/extract-image-scans")
-    @Operation(summary = "Extract image scans from an input file",
+    @Operation(
-            description = "This endpoint extracts image scans from a given file based on certain parameters. Users can specify angle threshold, tolerance, minimum area, minimum contour area, and border size. Input:PDF Output:IMAGE/ZIP Type:SIMO")
+            summary = "Extract image scans from an input file",
+            description =
+                    "This endpoint extracts image scans from a given file based on certain parameters. Users can specify angle threshold, tolerance, minimum area, minimum contour area, and border size. Input:PDF Output:IMAGE/ZIP Type:SIMO")
     public ResponseEntity<byte[]> extractImageScans(
-    		@RequestBody(
+            @RequestBody(
-    	            description = "Form data containing file and extraction parameters",
+                            description = "Form data containing file and extraction parameters",
-    	            required = true,
+                            required = true,
-    	            content = @Content(
+                            content =
-    	                mediaType = "multipart/form-data",
+                                    @Content(
-    	                schema = @Schema(implementation = ExtractImageScansRequest.class) // This should represent your form's structure
+                                            mediaType = "multipart/form-data",
-    	            )
+                                            schema =
-    	        )
+                                                    @Schema(
-    	        ExtractImageScansRequest form) throws IOException, InterruptedException {
+                                                            implementation =
+                                                                    ExtractImageScansRequest
+                                                                            .class) // This should
+                                            // represent
+                                            // your form's
+                                            // structure
+                                            ))
+                    ExtractImageScansRequest form)
+            throws IOException, InterruptedException {
         String fileName = form.getFileInput().getOriginalFilename();
         String extension = fileName.substring(fileName.lastIndexOf(".") + 1);
 
@@ -64,7 +76,8 @@ public class ExtractImageScansController {
         // Check if input file is a PDF
         if (extension.equalsIgnoreCase("pdf")) {
             // Load PDF document
-            try (PDDocument document = PDDocument.load(new ByteArrayInputStream(form.getFileInput().getBytes()))) {
+            try (PDDocument document =
+                    PDDocument.load(new ByteArrayInputStream(form.getFileInput().getBytes()))) {
                 PDFRenderer pdfRenderer = new PDFRenderer(document);
                 int pageCount = document.getNumberOfPages();
                 images = new ArrayList<>();
@@ -84,7 +97,10 @@ public class ExtractImageScansController {
             }
         } else {
             Path tempInputFile = Files.createTempFile("input_", "." + extension);
-            Files.copy(form.getFileInput().getInputStream(), tempInputFile, StandardCopyOption.REPLACE_EXISTING);
+            Files.copy(
+                    form.getFileInput().getInputStream(),
+                    tempInputFile,
+                    StandardCopyOption.REPLACE_EXISTING);
             // Add input file path to images list
             images.add(tempInputFile.toString());
         }
@@ -95,21 +111,28 @@ public class ExtractImageScansController {
         for (int i = 0; i < images.size(); i++) {
 
             Path tempDir = Files.createTempDirectory("openCV_output");
-            List<String> command = new ArrayList<>(Arrays.asList(
+            List<String> command =
-                    "python3", 
+                    new ArrayList<>(
-                    "./scripts/split_photos.py", 
+                            Arrays.asList(
-                    images.get(i), 
+                                    "python3",
-                    tempDir.toString(), 
+                                    "./scripts/split_photos.py",
-                    "--angle_threshold", String.valueOf(form.getAngleThreshold()),
+                                    images.get(i),
-                    "--tolerance", String.valueOf(form.getTolerance()),
+                                    tempDir.toString(),
-                    "--min_area", String.valueOf(form.getMinArea()),
+                                    "--angle_threshold",
-                    "--min_contour_area", String.valueOf(form.getMinContourArea()),
+                                    String.valueOf(form.getAngleThreshold()),
-                    "--border_size", String.valueOf(form.getBorderSize())
+                                    "--tolerance",
-                ));
+                                    String.valueOf(form.getTolerance()),
-
+                                    "--min_area",
+                                    String.valueOf(form.getMinArea()),
+                                    "--min_contour_area",
+                                    String.valueOf(form.getMinContourArea()),
+                                    "--border_size",
+                                    String.valueOf(form.getBorderSize())));
 
             // Run CLI command
-            ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.PYTHON_OPENCV).runCommandWithOutputHandling(command);
+            ProcessExecutorResult returnCode =
+                    ProcessExecutor.getInstance(ProcessExecutor.Processes.PYTHON_OPENCV)
+                            .runCommandWithOutputHandling(command);
 
             // Read the output photos in temp directory
             List<Path> tempOutputFiles = Files.list(tempDir).sorted().collect(Collectors.toList());
@@ -126,10 +149,16 @@ public class ExtractImageScansController {
             String outputZipFilename = fileName.replaceFirst("[.][^.]+$", "") + "_processed.zip";
             Path tempZipFile = Files.createTempFile("output_", ".zip");
 
-            try (ZipOutputStream zipOut = new ZipOutputStream(new FileOutputStream(tempZipFile.toFile()))) {
+            try (ZipOutputStream zipOut =
+                    new ZipOutputStream(new FileOutputStream(tempZipFile.toFile()))) {
                 // Add processed images to the zip
                 for (int i = 0; i < processedImageBytes.size(); i++) {
-                    ZipEntry entry = new ZipEntry(fileName.replaceFirst("[.][^.]+$", "") + "_" + (i + 1) + ".png");
+                    ZipEntry entry =
+                            new ZipEntry(
+                                    fileName.replaceFirst("[.][^.]+$", "")
+                                            + "_"
+                                            + (i + 1)
+                                            + ".png");
                     zipOut.putNextEntry(entry);
                     zipOut.write(processedImageBytes.get(i));
                     zipOut.closeEntry();
@@ -141,13 +170,15 @@ public class ExtractImageScansController {
             // Clean up the temporary zip file
             Files.delete(tempZipFile);
 
-            return WebResponseUtils.bytesToWebResponse(zipBytes, outputZipFilename, MediaType.APPLICATION_OCTET_STREAM);
+            return WebResponseUtils.bytesToWebResponse(
+                    zipBytes, outputZipFilename, MediaType.APPLICATION_OCTET_STREAM);
         } else {
             // Return the processed image as a response
             byte[] imageBytes = processedImageBytes.get(0);
-            return WebResponseUtils.bytesToWebResponse(imageBytes, fileName.replaceFirst("[.][^.]+$", "") + ".png", MediaType.IMAGE_PNG);
+            return WebResponseUtils.bytesToWebResponse(
+                    imageBytes,
+                    fileName.replaceFirst("[.][^.]+$", "") + ".png",
+                    MediaType.IMAGE_PNG);
         }
-
     }
-
 }