Merge branch 'main' into add-elements

refactor: have a newline between annotations

.git-blame-ignore-revs

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

.gitattributes

@@ -1,5 +1,6 @@
 # Ignore all JavaScript files in a directory
 src/main/resources/static/pdfjs/* linguist-vendored
+src/main/resources/static/pdfjs/** linguist-vendored
 src/main/resources/static/css/bootstrap-icons.css linguist-vendored
 src/main/resources/static/css/bootstrap.min.css linguist-vendored
 src/main/resources/static/css/fonts/* linguist-vendored

.github/CODEOWNERS

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

.github/pull_request_template.md

@@ -0,0 +1,4 @@
+# License Agreement for Contributions
+By submitting this pull request, I acknowledge and agree that my contributions will be included in Stirling-PDF and that they can be relicensed in the future under MPL 2.0 (Mozilla Public License Version 2.0) license. 
+
+(This does not change the general open-source nature of Stirling-PDF, simply moving from one license to another license)

.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/pull_request_template.md

@@ -0,0 +1,3 @@
+# License Agreement for Contributions
+By submitting this pull request, I acknowledge and agree that my contributions will be included in Stirling-PDF and that they can be relicensed in the future under MPL 2.0 (Mozilla Public License Version 2.0) license. 
+(This does not change the open-source nature of Stirling-PDF, simply moving from one license to another license)

.github/workflows/push-docker.yml

@@ -139,4 +139,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

.gitignore

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

Dockerfile

@@ -1,39 +1,47 @@
 # Use the base image
-FROM frooodle/stirling-pdf-base:beta4
+FROM frooodle/stirling-pdf-base:version8
+
+ARG VERSION_TAG
 
 # Set Environment Variables
-ENV PUID=1000 \
-    PGID=1000 \
-    UMASK=022 \
-    DOCKER_ENABLE_SECURITY=false \
+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 \
+    
 
 # Create user and group
-RUN groupadd -g $PGID stirlingpdfgroup && \
-    useradd -u $PUID -g stirlingpdfgroup -s /bin/sh stirlingpdfuser && \
-    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
+##RUN groupadd -g $PGID stirlingpdfgroup && \
+##    useradd -u $PUID -g stirlingpdfgroup -s /bin/sh stirlingpdfuser && \
+##    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 && \
-    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
+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 && \
-    chown stirlingpdfuser:stirlingpdfgroup /app.jar && \
-    chmod +x /scripts/init.sh
+RUN fc-cache -f -v && chmod +x /scripts/*
+
+##&& \
+##    chown stirlingpdfuser:stirlingpdfgroup /app.jar && \
+##    chmod +x /scripts/init.sh
 
 # Expose necessary ports
 EXPOSE 8080
 
 # Set user and run command
-USER stirlingpdfuser
+##USER stirlingpdfuser
 ENTRYPOINT ["/scripts/init.sh"]
-CMD ["java", "-jar", "/app.jar"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-lite

@@ -1,41 +1,53 @@
 # 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-calc-nogui \
-        libreoffice-impress-nogui \
+        libreoffice-writer \
+        libreoffice-calc \
+        libreoffice-impress \
         unoconv && \
     rm -rf /var/lib/apt/lists/*
 
 
 # Set Environment Variables
-ENV PUID=1000 \
-    PGID=1000 \
-    UMASK=022 \
-    DOCKER_ENABLE_SECURITY=false \
+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 \
 
 # Create user and group
-RUN groupadd -g $PGID stirlingpdfgroup && \
-    useradd -u $PUID -g stirlingpdfgroup -s /bin/sh stirlingpdfuser && \
-    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
+#RUN groupadd -g $PGID stirlingpdfgroup && \
+#    useradd -u $PUID -g stirlingpdfgroup -s /bin/sh stirlingpdfuser && \
+#    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
 
 # Set up necessary directories and permissions
-RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /configs /customFiles && \
-    chown -R stirlingpdfuser:stirlingpdfgroup /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 && \
-    chown stirlingpdfuser:stirlingpdfgroup /app.jar
+chmod +x /scripts/init-without-ocr.sh && \
+chmod +x /scripts/download-security-jar.sh
+
+
+#    chown stirlingpdfuser:stirlingpdfgroup /app.jar
 
 
 
@@ -48,5 +60,6 @@ ENV ENDPOINTS_GROUPS_TO_REMOVE=Python,OpenCV,OCRmyPDF
 ENV DOCKER_ENABLE_SECURITY=false
 
 # Run the application
-USER stirlingpdfuser
-CMD ["java", "-jar", "/app.jar"]
+#USER stirlingpdfuser
+ENTRYPOINT ["/scripts/init-without-ocr.sh"]
+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 \
-    PGID=1000 \
-    UMASK=022 \
-    DOCKER_ENABLE_SECURITY=false \
+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 \
 
 # Create user and group using Alpine's addgroup and adduser
-RUN addgroup -g $PGID stirlingpdfgroup && \
-    adduser -u $PUID -G stirlingpdfgroup -s /bin/sh -D stirlingpdfuser && \
-    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
+#RUN addgroup -g $PGID stirlingpdfgroup && \
+#    adduser -u $PUID -G stirlingpdfgroup -s /bin/sh -D stirlingpdfuser && \
+#    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
 
 # Set up necessary directories and permissions
-RUN mkdir -p /scripts /configs /customFiles && \
-    chown -R stirlingpdfuser:stirlingpdfgroup /scripts /configs /customFiles
-
+#RUN mkdir -p /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,50 @@
 # Main stage
-FROM bellsoft/liberica-openjdk-debian:17 AS base
+FROM ubuntu:latest AS base
+
+
+
+# JDK for app
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
-        libreoffice-core-nogui \
+    	openjdk-17-jre
+    	
+# Doc conversion
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    	libreoffice-core \
         libreoffice-common \
-        libreoffice-writer-nogui \
-        libreoffice-calc-nogui \
-        libreoffice-impress-nogui \
-        python3-uno \
+        libreoffice-writer \
+        libreoffice-calc \
+        libreoffice-impress \
+		python3-uno \
+		curl \
+		unoconv
+		
+		
+# 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 \
-        unoconv \
-        pngquant \
-        unpaper \
-        ocrmypdf && \
-    rm -rf /var/lib/apt/lists/* && \
+        ocrmypdf \
+        unpaper && \
+    pip install --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 
+
+
+# cleanup and etc
+RUN 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
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-        build-essential \
-        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
-FROM base
-COPY --from=python-packages /usr/local /usr/local
+
+    

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,14 +95,14 @@ 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
@@ -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.

README.md

@@ -14,11 +14,9 @@ This is a powerful locally hosted web based PDF manipulation tool using docker t
 
 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.
-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)
+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.
 
+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)
 
@@ -33,6 +31,7 @@ Feel free to request any features or bug fixes either in github issues or our [D
 ## **PDF Features**
 
 ### **Page Operations**
+- View and modify PDFs - View multi page PDFs with custom viewing sorting and searching. Plus on page edit features like annotate, draw and adding text and images. (Using PDF.js with Joxit and Liberation.Liberation fonts)
 - Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages. 
 - Merge multiple PDFs together into a single resultant file. 
 - Split PDFs into multiple files at specified page numbers or extract all pages as individual files. 
@@ -81,7 +80,7 @@ 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/Frooodle/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
@@ -99,7 +98,7 @@ Hosted instance/demo of the app can be seen [here](https://pdf.adminforge.de/) h
 ### Locally
 Please view https://github.com/Frooodle/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.
@@ -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,19 +133,21 @@ 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
 
 ## Want to add your own language?
-Stirling PDF currently supports 18!
+Stirling PDF currently supports 21!
 - English (English) (en_GB)
 - English (US) (en_US)
 - Arabic (العربية) (ar_AR)
@@ -164,6 +166,10 @@ Stirling PDF currently supports 18!
 - Basque (Euskara) (eu_ES)
 - Japanese (日本語) (ja_JP)
 - Dutch (Nederlands) (nl_NL)
+- Greek (el_GR)
+- Turkish (Türkçe) (tr_TR)
+- Indonesia (Bahasa Indonesia) (id_ID)
+- Hindi (हिंदी) (hi_IN)
 
 If you want to add your own language to Stirling-PDF please refer
 https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md
@@ -218,11 +224,11 @@ 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/Frooodle/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
-- ``SYSTEM_ROOTURIPATH`` ie set to ``pdf-app`` to Set the application's root URI tp ``localhost:8080/pdf-app``
+- ``SYSTEM_ROOTURIPATH`` ie set to ``/pdf-app`` to Set the application's root URI to ``localhost:8080/pdf-app``
 - ``SYSTEM_CONNECTIONTIMEOUTMINUTES`` to set custom connection timeout values
 - ``DOCKER_ENABLE_SECURITY`` to tell docker to download security jar (required as true for auth login)
 
@@ -232,10 +238,12 @@ For those wanting to use Stirling-PDFs backend API to link with their own custom
 
 
 ## Login authentication
+![stirling-login](images/login-light.png)
 ### Prerequisites: 
 - User must have the folder ./configs volumed within docker so that it is retained during updates.
 - Docker uses must download the security jar version by setting ``DOCKER_ENABLE_SECURITY`` to ``true`` in environment variables. 
-- Now the initial user will be generated with username ``admin`` and password ``stirling``. On login you will be forced to change the password to a new one.
+- Then either enable login via the settings.yml file or via setting ``SECURITY_ENABLE_LOGIN`` to ``true``
+- Now the initial user will be generated with username ``admin`` and password ``stirling``. On login you will be forced to change the password to a new one. You can also use the environment variables ``SECURITY_INITIALLOGIN_USERNAME`` and  ``SECURITY_INITIALLOGIN_PASSWORD`` to set your own straight away (Recommended to remove them after user creation).
 
 Once the above has been done, on restart, a new stirling-pdf-DB.mv.db will show if everything worked.
 
@@ -256,9 +264,11 @@ For API usage you must provide a header with 'X-API-Key' and the associated API
 - Folder support with auto scanning to perform operations on
 - Redact text (Via UI not just automated way) 
 - Add Forms
-- Annotations
 - Multi page layout (Stich PDF pages together) support x rows y columns and custom page sizing 
 - 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,19 @@
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '3.1.2'
-	id 'io.spring.dependency-management' version '1.1.2'
-	id 'org.springdoc.openapi-gradle-plugin' version '1.6.0'
-	id "io.swagger.swaggerhub" version "1.2.0"
-	id 'edu.sc.seis.launch4j' version '3.0.3'
+    id 'java'
+    id 'org.springframework.boot' version '3.1.2'
+    id 'io.spring.dependency-management' version '1.1.3'
+    id 'org.springdoc.openapi-gradle-plugin' version '1.8.0'
+    id "io.swagger.swaggerhub" version "1.3.2"
+    id 'edu.sc.seis.launch4j' version '3.0.5'
+    id 'com.diffplug.spotless' version '6.23.3'
 }
 
 group = 'stirling.software'
-version = '0.14.0'
+version = '0.18.1'
 sourceCompatibility = '17'
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 sourceSets {
@@ -32,9 +33,8 @@ sourceSets {
     }
 }
 
-
 openApi {
-    apiDocsUrl = "http://localhost:8080/v3/api-docs"
+    apiDocsUrl = "http://localhost:8080/v1/api-docs"
     outputDir = file("$projectDir")
     outputFileName = "SwaggerDoc.json"
 }
@@ -46,15 +46,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" 
-  variables=["BROWSER_OPEN=true"]
+  downloadUrl="https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe"
+  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 +62,95 @@ launch4j {
   messagesInstanceAlreadyExists="Stirling-PDF is already running."
 }
 
+spotless {
+    java {
+        target project.fileTree('src/main/java')
+
+        googleJavaFormat('1.19.1').aosp().reorderImports(false)
+
+        importOrder('java', 'javax', 'org', 'com', 'net', 'io')
+        toggleOffOn()
+        trimTrailingWhitespace()
+        indentWithSpaces()
+        endWithNewline()
+    }
+}
+
 dependencies {
-	implementation 'org.yaml:snakeyaml:2.1'
-	implementation 'org.springframework.boot:spring-boot-starter-web:3.1.2'
-	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'
+    //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.0.15'
+
+    implementation 'org.yaml:snakeyaml:2.1'
+    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"
-		implementation "com.h2database:h2"
+        implementation "com.h2database:h2"
     }
-	
-	testImplementation 'org.springframework.boot:spring-boot-starter-test:3.1.2'
-	
-	
 
-	// https://mvnrepository.com/artifact/org.apache.pdfbox/jbig2-imageio
-	implementation group: 'org.apache.pdfbox', name: 'jbig2-imageio', version: '3.0.4'
-	implementation 'commons-io:commons-io:2.13.0'
-	
-    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
+    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.7.1') {
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
     
-	//general PDF
-    implementation 'org.apache.pdfbox:pdfbox:2.0.29'
-    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:pdfbox:2.0.29'){
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
+    
+    implementation ('org.apache.pdfbox:xmpbox:2.0.29'){
+        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.1'
+    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'
-    
-    developmentOnly("org.springframework.boot:spring-boot-devtools")
-	compileOnly 'org.projectlombok:lombok:1.18.28'
-	annotationProcessor 'org.projectlombok:lombok:1.18.28'
+    implementation 'com.github.vladimir-bukhtoyarov:bucket4j-core:7.6.0'
 
+    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 +178,11 @@ jar {
         attributes 'Implementation-Title': 'Stirling-PDF',
                    'Implementation-Version': project.version
     }
-    
+
 }
 
 tasks.named('test') {
-	useJUnitPlatform()
+    useJUnitPlatform()
 }
 
 task printVersion {

chart/stirling-pdf/Chart.yaml

@@ -0,0 +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
+keywords:
+- stirling-pdf
+- helm
+- charts repo
+maintainers:
+- name: Frooodle
+  url: https://github.com/Frooodle/Stirling-PDF
+name: stirling-pdf-chart
+sources:
+- https://github.com/Frooodle/Stirling-PDF
+version: 1.0.0

chart/stirling-pdf/templates/NOTES.txt

@@ -0,0 +1,30 @@
+** Please be patient while the chart is being deployed **
+
+Get the stirlingpdf URL by running:
+
+{{- if contains "NodePort" .Values.service.type }}
+
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "stirlingpdf.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT/
+
+{{- else if contains "LoadBalancer" .Values.service.type }}
+
+** Please ensure an external IP is associated to the {{ template "stirlingpdf.fullname" . }} service before proceeding **
+** Watch the status using: kubectl get svc --namespace {{ .Release.Namespace }} -w {{ template "stirlingpdf.fullname" . }} **
+
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "stirlingpdf.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  echo http://$SERVICE_IP:{{ .Values.service.externalPort }}/
+
+OR
+
+  export SERVICE_HOST=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "stirlingpdf.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].hostname}')
+  echo http://$SERVICE_HOST:{{ .Values.service.externalPort }}/
+
+{{- else if contains "ClusterIP"  .Values.service.type }}
+
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "stirlingpdf.name" . }}" -l "release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo http://127.0.0.1:8080/
+  kubectl port-forward $POD_NAME 8080:8080 --namespace {{ .Release.Namespace }}
+
+{{- end }}

chart/stirling-pdf/templates/_helpers.tpl

@@ -0,0 +1,129 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "stirlingpdf.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "stirlingpdf.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{- /*
+Create chart name and version as used by the chart label.
+
+It does minimal escaping for use in Kubernetes labels.
+
+Example output:
+
+stirlingpdf-0.4.5
+*/ -}}
+{{- define "stirlingpdf.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "stirlingpdf.labels" -}}
+helm.sh/chart: {{ include "stirlingpdf.chart" . }}
+{{ include "stirlingpdf.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+{{- if .Values.commonLabels}}
+{{ toYaml .Values.commonLabels }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "stirlingpdf.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "stirlingpdf.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "stirlingpdf.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "stirlingpdf.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Return the proper image name to change the volume permissions
+*/}}
+{{- define "stirlingpdf.volumePermissions.image" -}}
+{{- $registryName := .Values.volumePermissions.image.registry -}}
+{{- $repositoryName := .Values.volumePermissions.image.repository -}}
+{{- $tag := .Values.volumePermissions.image.tag | toString -}}
+{{/*
+Helm 2.11 supports the assignment of a value to a variable defined in a different scope,
+but Helm 2.9 and 2.10 doesn't support it, so we need to implement this if-else logic.
+Also, we can't use a single if because lazy evaluation is not an option
+*/}}
+{{- if .Values.global }}
+    {{- if .Values.global.imageRegistry }}
+        {{- printf "%s/%s:%s" .Values.global.imageRegistry $repositoryName $tag -}}
+    {{- else -}}
+        {{- printf "%s/%s:%s" $registryName $repositoryName $tag -}}
+    {{- end -}}
+{{- else -}}
+    {{- printf "%s/%s:%s" $registryName $repositoryName $tag -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Return the proper Docker Image Registry Secret Names
+*/}}
+{{- define "stirlingpdf.imagePullSecrets" -}}
+{{/*
+Helm 2.11 supports the assignment of a value to a variable defined in a different scope,
+but Helm 2.9 and 2.10 does not support it, so we need to implement this if-else logic.
+Also, we can not use a single if because lazy evaluation is not an option
+*/}}
+{{- if .Values.global }}
+{{- if .Values.global.imagePullSecrets }}
+imagePullSecrets:
+{{- range .Values.global.imagePullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- else if or .Values.image.pullSecrets .Values.volumePermissions.image.pullSecrets }}
+imagePullSecrets:
+{{- range .Values.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- range .Values.volumePermissions.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- end -}}
+{{- else if or .Values.image.pullSecrets .Values.volumePermissions.image.pullSecrets }}
+imagePullSecrets:
+{{- range .Values.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- range .Values.volumePermissions.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- end -}}
+{{- end -}}

chart/stirling-pdf/templates/deployment.yaml

@@ -0,0 +1,129 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  {{- with .Values.deployment.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- if .Values.deployment.labels }}
+    {{- toYaml .Values.deployment.labels | nindent 4 }}
+    {{- end }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "stirlingpdf.selectorLabels" . | nindent 6 }}
+  replicas: {{ .Values.replicaCount }}
+  strategy:
+{{ toYaml .Values.strategy | indent 4 }}
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "stirlingpdf.selectorLabels" . | nindent 8 }}
+        {{- if .Values.podLabels }}
+        {{- toYaml .Values.podLabels | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- if .Values.priorityClassName }}
+      priorityClassName: "{{ .Values.priorityClassName }}"
+      {{- end }}
+      {{- if .Values.securityContext.enabled }}
+      securityContext:
+        fsGroup: {{ .Values.securityContext.fsGroup }}
+        {{- if .Values.securityContext.runAsNonRoot }}
+        runAsNonRoot: {{ .Values.securityContext.runAsNonRoot }}
+        {{- end }}
+        {{- if .Values.securityContext.supplementalGroups }}
+        supplementalGroups: {{ .Values.securityContext.supplementalGroups }}
+        {{- end }}
+      {{- else if .Values.persistence.enabled }}
+      initContainers:
+      - name: volume-permissions
+        image: {{ template "stirlingpdf.volumePermissions.image" . }}
+        imagePullPolicy: "{{ .Values.volumePermissions.image.pullPolicy }}"
+        securityContext:
+          {{- toYaml .Values.containerSecurityContext | nindent 10 }}
+        command: ['sh', '-c', 'chown -R {{ .Values.securityContext.fsGroup }}:{{ .Values.securityContext.fsGroup }} {{ .Values.persistence.path }}']
+        volumeMounts:
+        - mountPath: {{ .Values.persistence.path }}
+          name: storage-volume
+      {{- end }}
+{{- include "stirlingpdf.imagePullSecrets" . | indent 6 }}
+      containers:
+      - name: {{ .Chart.Name }}
+        image: {{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}
+        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        securityContext:
+          {{- toYaml .Values.containerSecurityContext | nindent 10 }}
+{{- if .Values.envs }}
+        env:
+{{ toYaml .Values.envs | indent 8 }}
+{{- end }}
+{{- if .Values.extraArgs }}
+        args:
+{{ toYaml .Values.extraArgs | indent 8 }}
+{{- end }}
+        ports:
+        - name: http
+          containerPort: 8080
+        livenessProbe:
+          httpGet:
+            path: /
+            port: http
+{{ toYaml .Values.probes.livenessHttpGetConfig | indent 12 }}
+{{ toYaml .Values.probes.liveness | indent 10 }}
+        readinessProbe:
+          httpGet:
+            path: /
+            port: http
+{{ toYaml .Values.probes.readinessHttpGetConfig | indent 12 }}
+{{ toYaml .Values.probes.readiness | indent 10 }}
+        volumeMounts:
+{{- if .Values.deployment.extraVolumeMounts }}
+        {{- toYaml .Values.deployment.extraVolumeMounts | nindent 8 }}
+{{- end }}
+{{- if .Values.deployment.sidecarContainers }}
+{{- range $name, $spec :=  .Values.deployment.sidecarContainers }}
+      - name: {{ $name }}
+{{- toYaml $spec | nindent 8 }}
+{{- end }}
+{{- end }}
+      {{- with .Values.resources }}
+        resources:
+{{ toYaml . | indent 10 }}
+      {{- end }}
+    {{- with .Values.nodeSelector }}
+      nodeSelector:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- with .Values.affinity }}
+      affinity:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- with .Values.tolerations }}
+      tolerations:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- if .Values.schedulerName }}
+      schedulerName: {{ .Values.schedulerName }}
+    {{- end }}
+      serviceAccountName: {{ include "stirlingpdf.serviceAccountName" . }}
+      automountServiceAccountToken: {{ .Values.serviceAccount.automountServiceAccountToken }}
+      volumes:
+      {{- if .Values.deployment.extraVolumes }}
+      {{- toYaml .Values.deployment.extraVolumes | nindent 6 }}
+      {{- end }}
+      - name: storage-volume
+      {{- if .Values.persistence.enabled }}
+        persistentVolumeClaim:
+          claimName: {{ .Values.persistence.existingClaim | default (include "stirlingpdf.fullname" .) }}
+      {{- else }}
+        emptyDir: {}
+      {{- end }}

chart/stirling-pdf/templates/ingress.yaml

@@ -0,0 +1,85 @@
+{{- if .Values.ingress.enabled }}
+{{- $servicePort := .Values.service.externalPort -}}
+{{- $serviceName := include "stirlingpdf.fullname" . -}}
+{{- $ingressExtraPaths := .Values.ingress.extraPaths -}}
+---
+{{- if semverCompare "<1.14-0" .Capabilities.KubeVersion.GitVersion }}
+apiVersion: extensions/v1beta1
+{{- else if semverCompare "<1.19-0" .Capabilities.KubeVersion.GitVersion }}
+apiVersion: networking.k8s.io/v1beta1
+{{- else }}
+apiVersion: networking.k8s.io/v1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.ingress.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  {{- with .Values.ingress.ingressClassName }}
+  ingressClassName: {{ . }}
+  {{- end }}
+  rules:
+  {{- range .Values.ingress.hosts }}
+  - host: {{ .name }}
+    http:
+      paths:
+      {{- range $ingressExtraPaths }}
+      - path: {{ default "/" .path | quote }}
+        backend:
+        {{- if semverCompare "<1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+          {{- if $.Values.service.servicename }}
+          serviceName: {{ $.Values.service.servicename }}
+          {{- else }}
+          serviceName: {{ default $serviceName .service }}
+          {{- end }}
+          servicePort: {{ default $servicePort .port }}
+        {{- else }}
+          service:
+            {{- if $.Values.service.servicename }}
+            name: {{ $.Values.service.servicename }}
+            {{- else }}
+            name: {{ default $serviceName .service }}
+            {{- end }}
+            port:
+              number: {{ default $servicePort .port }}
+        pathType: {{ default $.Values.ingress.pathType .pathType }}
+        {{- end }}
+      {{- end }}
+      - path: {{ default "/" .path | quote }}
+        backend:
+        {{- if semverCompare "<1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+          {{- if $.Values.service.servicename }}
+          serviceName: {{ $.Values.service.servicename }}
+          {{- else }}
+          serviceName: {{ default $serviceName .service }}
+          {{- end }}
+          servicePort: {{ default $servicePort .servicePort }}
+        {{- else }}
+          service:
+            {{- if $.Values.service.servicename }}
+            name: {{ $.Values.service.servicename }}
+            {{- else }}
+            name: {{ default $serviceName .service }}
+            {{- end }}
+            port:
+              number: {{ default $servicePort .port }}
+        pathType: {{ $.Values.ingress.pathType }}
+        {{- end }}
+  {{- end }}
+  tls:
+  {{- range .Values.ingress.hosts }}
+  {{- if .tls }}
+  - hosts:
+    - {{ .name }}
+    secretName: {{ .tlsSecret }}
+  {{- end }}
+  {{- end }}
+{{- end -}}

chart/stirling-pdf/templates/pv.yaml

@@ -0,0 +1,16 @@
+{{- if .Values.persistence.pv.enabled -}}
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: {{ .Values.persistence.pv.pvname | default (include "stirlingpdf.fullname" .) }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+spec:
+  capacity:
+    storage: {{ .Values.persistence.pv.capacity.storage }}
+  accessModes:
+    - {{ .Values.persistence.pv.accessMode | quote }}
+  nfs:
+    server: {{ .Values.persistence.pv.nfs.server }}
+    path: {{ .Values.persistence.pv.nfs.path | quote }}
+{{- end }}

chart/stirling-pdf/templates/pvc.yaml

@@ -0,0 +1,27 @@
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) -}}
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.persistence.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  accessModes:
+    - {{ .Values.persistence.accessMode | quote }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.size | quote }}
+{{- if .Values.persistence.storageClass }}
+{{- if (eq "-" .Values.persistence.storageClass) }}
+  storageClassName: ""
+{{- else }}
+  storageClassName: "{{ .Values.persistence.storageClass }}"
+{{- end }}
+{{- if .Values.persistence.volumeName }}
+  volumeName: "{{ .Values.persistence.volumeName }}"
+{{- end }}
+{{- end }}
+{{- end }}

chart/stirling-pdf/templates/service.yaml

@@ -0,0 +1,48 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Values.service.servicename | default (include "stirlingpdf.fullname" .) }}
+  {{- with .Values.service.annotations }}
+  annotations:
+  {{- toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.service.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  type: {{ .Values.service.type }}
+  {{- if (or (eq .Values.service.type "LoadBalancer") (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort)))) }}
+  externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }}
+  {{- end }}
+  {{- if (and (eq .Values.service.type "LoadBalancer") .Values.service.loadBalancerIP) }}
+  loadBalancerIP: {{ .Values.service.loadBalancerIP }}
+  {{- end }}
+  {{- if (and (eq .Values.service.type "LoadBalancer") .Values.service.loadBalancerSourceRanges) }}
+  loadBalancerSourceRanges:
+  {{- with .Values.service.loadBalancerSourceRanges }}
+{{ toYaml . | indent 2 }}
+  {{- end }}
+  {{- end }}
+  {{- if eq .Values.service.type "ClusterIP" }}
+  {{- if .Values.service.clusterIP }}
+  clusterIP: {{ .Values.service.clusterIP }}
+  {{- end }}
+  {{- end }}
+  ports:
+  - port: {{ .Values.service.externalPort }}
+{{- if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }}
+    nodePort: {{.Values.service.nodePort}}
+{{- end }}
+{{- if .Values.service.targetPort }}
+    targetPort: {{ .Values.service.targetPort }}
+    name: {{ .Values.service.targetPort }}
+{{- else }}
+    targetPort: http
+    name: http
+{{- end }}
+    protocol: TCP
+    
+  selector:
+    {{- include "stirlingpdf.selectorLabels" . | nindent 4 }}

chart/stirling-pdf/templates/serviceaccount.yaml

@@ -0,0 +1,13 @@
+{{- if .Values.serviceAccount.create -}}
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "stirlingpdf.serviceAccountName" . }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{ toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+{{- end }}

chart/stirling-pdf/templates/servicemonitor.yaml

@@ -0,0 +1,31 @@
+{{- if and ( .Capabilities.APIVersions.Has "monitoring.coreos.com/v1" ) ( .Values.serviceMonitor.enabled ) }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  namespace: {{ .Values.serviceMonitor.namespace | default .Release.Namespace }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.serviceMonitor.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  endpoints:
+  - targetPort: 8080
+{{- if .Values.serviceMonitor.interval }}
+    interval: {{ .Values.serviceMonitor.interval }}
+{{- end }}
+{{- if .Values.serviceMonitor.metricsPath }}
+    path: {{ .Values.serviceMonitor.metricsPath }}
+{{- end }}
+{{- if .Values.serviceMonitor.timeout }}
+    scrapeTimeout: {{ .Values.serviceMonitor.timeout }}
+{{- end }}
+  jobLabel: {{ include "stirlingpdf.fullname" . }}
+  namespaceSelector:
+    matchNames:
+    - {{ .Release.Namespace }}
+  selector:
+    matchLabels:
+      {{- include "stirlingpdf.selectorLabels" . | nindent 6 }}
+{{- end }}

chart/stirling-pdf/values.yaml

@@ -0,0 +1,239 @@
+extraArgs: []
+  # - --storage-timestamp-tolerance 1s
+replicaCount: 1
+strategy:
+  type: RollingUpdate
+image:
+  repository: frooodle/s-pdf
+  # took Chart appVersion by default
+  tag: ~
+  pullPolicy: IfNotPresent
+secret:
+  labels: {}
+## Labels to apply to all resources
+##
+commonLabels: {}
+# team_name: dev
+
+envs: []
+# - name: PP_HOME_NAME
+#   value: "Stirling PDF"
+# - name: APP_HOME_DESCRIPTION
+#   value: "Your locally hosted one-stop-shop for all your PDF needs."
+# - name: APP_NAVBAR_NAME
+#   value: "Stirling PDF"
+# - name: ALLOW_GOOGLE_VISIBILITY
+#   value: "true"
+# - name: APP_ROOT_PATH
+#   value: "/"
+# - name: APP_LOCALE
+#   value: "en_GB"
+
+deployment:
+  ## stirling-pdf Deployment annotations
+  annotations: {}
+  #   name: value
+  labels: {}
+  #   name: value
+  # additional volumes
+  extraVolumes: []
+  #  - name: nginx-config
+  #    secret:
+  #      secretName: nginx-config
+  # additional volumes to mount
+  extraVolumeMounts: []
+  ## sidecarContainers for the stirling-pdf
+  # Can be used to add a proxy to the pod that does
+  # scanning for secrets, signing, authentication, validation
+  # of the chart's content, send notifications...
+  sidecarContainers: {}
+  ## Example sidecarContainer which uses an extraVolume from above and
+  ## a named port that can be referenced in the service as targetPort.
+  #  proxy:
+  #    image: nginx:latest
+  #    ports:
+  #      - name: proxy
+  #        containerPort: 8081
+  #    volumeMounts:
+  #      - name: nginx-config
+  #        readOnly: true
+  #        mountPath: /etc/nginx
+
+## Pod annotations
+## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
+## Read more about kube2iam to provide access to s3 https://github.com/jtblin/kube2iam
+##
+podAnnotations: {}
+  # iam.amazonaws.com/role: role-arn
+
+## Pod labels
+## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+podLabels: {}
+  # name: value
+
+service:
+  servicename:
+  type: ClusterIP
+  externalTrafficPolicy: Local
+  ## Uses pre-assigned IP address from cloud provider
+  ## Only valid if service.type: LoadBalancer
+  loadBalancerIP:
+  ## Limits which cidr blocks can connect to service's load balancer
+  ## Only valid if service.type: LoadBalancer
+  loadBalancerSourceRanges: []
+  # clusterIP: None
+  externalPort: 8080
+  ## targetPort of the container to use. If a sidecar should handle the
+  ## requests first, use the named port from the sidecar. See sidecar example
+  ## from deployment above. Leave empty to use stirling-pdf directly.
+  targetPort:
+  nodePort:
+  annotations: {}
+  labels: {}
+
+serviceMonitor:
+  enabled: false
+  # namespace: prometheus
+  labels: {}
+  metricsPath: "/metrics"
+  # timeout: 60
+  # interval: 60
+
+resources: {}
+#  limits:
+#    cpu: 100m
+#    memory: 128Mi
+#  requests:
+#    cpu: 80m
+#    memory: 64Mi
+
+probes:
+  liveness:
+    initialDelaySeconds: 5
+    periodSeconds: 10
+    timeoutSeconds: 1
+    successThreshold: 1
+    failureThreshold: 3
+  livenessHttpGetConfig:
+    scheme: HTTP
+  readiness:
+    initialDelaySeconds: 5
+    periodSeconds: 10
+    timeoutSeconds: 1
+    successThreshold: 1
+    failureThreshold: 3
+  readinessHttpGetConfig:
+    scheme: HTTP
+
+serviceAccount:
+  create: true
+  name: ""
+  automountServiceAccountToken: false
+  ## Annotations for the Service Account
+  annotations: {}
+
+# UID/GID 1000 is the default user "stirling-pdf" used in
+# the container image starting in v0.8.0 and above. This
+# is required for local persistent storage. If your cluster
+# does not allow this, try setting securityContext: {}
+securityContext:
+  enabled: true
+  fsGroup: 1000
+  ## Optionally, specify supplementalGroups and/or
+  ## runAsNonRoot for security purposes
+  # runAsNonRoot: true
+  # supplementalGroups: [1000]
+
+containerSecurityContext: {}
+
+priorityClassName: ""
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}
+
+persistence:
+  enabled: false
+  accessMode: ReadWriteOnce
+  size: 8Gi
+  labels: {}
+    # name: value
+  path: /tmp
+  ## A manually managed Persistent Volume and Claim
+  ## Requires persistence.enabled: true
+  ## If defined, PVC must be created manually before volume will be bound
+  # existingClaim:
+
+  ## stirling-pdf data Persistent Volume Storage Class
+  ## If defined, storageClassName: <storageClass>
+  ## If set to "-", storageClassName: "", which disables dynamic provisioning
+  ## If undefined (the default) or set to null, no storageClassName spec is
+  ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
+  ##   GKE, AWS & OpenStack)
+  ##
+  # storageClass: "-"
+  # volumeName:
+  pv:
+    enabled: false
+    pvname:
+    capacity:
+      storage: 8Gi
+    accessMode: ReadWriteOnce
+    nfs:
+      server:
+      path:
+
+## Init containers parameters:
+## volumePermissions: Change the owner of the persistent volume mountpoint to RunAsUser:fsGroup
+##
+volumePermissions:
+  image:
+    registry: docker.io
+    repository: bitnami/minideb
+    tag: buster
+    pullPolicy: Always
+    ## Optionally specify an array of imagePullSecrets.
+    ## Secrets must be manually created in the namespace.
+    ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
+    ##
+    # pullSecrets:
+    #   - myRegistryKeySecretName
+
+## Ingress for load balancer
+ingress:
+  enabled: false
+  pathType: "ImplementationSpecific"
+  ## stirling-pdf Ingress labels
+  ##
+  labels: {}
+    # dns: "route53"
+
+  ## stirling-pdf Ingress annotations
+  ##
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+
+  ## stirling-pdf Ingress hostnames
+  ## Must be provided if Ingress is enabled
+  ##
+  hosts: []
+    # - name: stirling-pdf.domain1.com
+    #   path: /
+    #   tls: false
+    # - name: stirling-pdf.domain2.com
+    #   path: /
+    #
+    #   ## Set this to true in order to enable TLS on the ingress record
+    #   tls: true
+    #
+    #   ## If TLS is set to true, you must declare what secret will store the key/certificate for TLS
+    #   ## Secrets must be added manually to the namespace
+    #   tlsSecret: stirling-pdf.domain2-tls
+
+  # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName
+  # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress
+  ingressClassName:
+

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,11 +1,11 @@
 import cv2
-import numpy as np
 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
@@ -16,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
-    total_pixels = thresholded_image.size
-    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
+    white_pixels = np.sum(thresholded_image == white_value)
+    white_pixel_percentage = (white_pixels / thresholded_image.size) * 100
 
     print(f"Page has white pixel percent of {white_pixel_percentage}")
-    return True
-
+    return white_pixel_percentage >= white_percent
 
 
 if __name__ == "__main__":
@@ -40,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.
-        sys.exit(1)
-    else:
-        # Return code 0: The image is not considered blank.
-        sys.exit(0)
+    # Return code 1: The image is considered blank.
+    # Return code 0: The image is not considered blank.
+    sys.exit(int(blank))

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/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

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
-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
-
+/scripts/download-security-jar.sh
 
 # Run the main command
 exec "$@"

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(() -> {
-            while (true) {
-                long idleTime = System.currentTimeMillis() - lastActivityTime;
-                if (idleTime >= ACTIVITY_TIMEOUT) {
-                    // If there has been no activity for too long, tear down the listener
-                    process.destroy();
-                    break;
-                }
-                try {
-                    Thread.sleep(5000); // Check for inactivity every 5 seconds
-                } catch (InterruptedException e) {
-                    break;
-                }
-            }
-        });
+        executorService.submit(
+                () -> {
+                    while (true) {
+                        long idleTime = System.currentTimeMillis() - lastActivityTime;
+                        if (idleTime >= ACTIVITY_TIMEOUT) {
+                            // If there has been no activity for too long, tear down the listener
+                            process.destroy();
+                            break;
+                        }
+                        try {
+                            Thread.sleep(5000); // Check for inactivity every 5 seconds
+                        } 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

@@ -8,17 +8,17 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.core.env.Environment;
+import org.springframework.scheduling.annotation.EnableScheduling;
 
 import jakarta.annotation.PostConstruct;
 import stirling.software.SPDF.config.ConfigInitializer;
 import stirling.software.SPDF.utils.GeneralUtils;
-@SpringBootApplication
 
-//@EnableScheduling
+@SpringBootApplication
+@EnableScheduling
 public class SPdfApplication {
-	
-	@Autowired
-    private Environment env;
+
+    @Autowired private Environment env;
 
     @PostConstruct
     public void init() {
@@ -28,11 +28,7 @@ public class SPdfApplication {
 
         if (browserOpen) {
             try {
-                String port = env.getProperty("local.server.port");
-                if(port == null || port.length() == 0) {
-                	port="8080";
-                }
-                String url = "http://localhost:" + port;
+                String url = "http://localhost:" + getPort();
 
                 String os = System.getProperty("os.name").toLowerCase();
                 Runtime rt = Runtime.getRuntime();
@@ -45,38 +41,41 @@ public class SPdfApplication {
             }
         }
     }
-	
+
     public static void main(String[] args) {
-    	SpringApplication app = new SpringApplication(SPdfApplication.class);
-    	app.addInitializers(new ConfigInitializer());
-    	if (Files.exists(Paths.get("configs/settings.yml"))) {
-            app.setDefaultProperties(Collections.singletonMap("spring.config.additional-location", "file:configs/settings.yml"));
+        SpringApplication app = new SpringApplication(SPdfApplication.class);
+        app.addInitializers(new ConfigInitializer());
+        if (Files.exists(Paths.get("configs/settings.yml"))) {
+            app.setDefaultProperties(
+                    Collections.singletonMap(
+                            "spring.config.additional-location", "file:configs/settings.yml"));
         } else {
-            System.out.println("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);
-        
+
         try {
-			Thread.sleep(1000);
-		} catch (InterruptedException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-        
+            Thread.sleep(1000);
+        } catch (InterruptedException e) {
+            // TODO Auto-generated catch block
+            e.printStackTrace();
+        }
+
         GeneralUtils.createDir("customFiles/static/");
         GeneralUtils.createDir("customFiles/templates/");
-        
-        
-        
+
         System.out.println("Stirling-PDF Started.");
-        
-        String port = System.getProperty("local.server.port");
-        if(port == null || port.length() == 0) {
-        	port="8080";
-        }
-        String url = "http://localhost:" + port;
+
+        String url = "http://localhost:" + getPort();
         System.out.println("Navigate to " + url);
     }
-    
-    
-}
+
+    public static String getPort() {
+        String port = System.getProperty("local.server.port");
+        if (port == null || port.isEmpty()) {
+            port = "8080";
+        }
+        return port;
+    }
+}

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

@@ -5,12 +5,12 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 import stirling.software.SPDF.model.ApplicationProperties;
+
 @Configuration
 public class AppConfig {
 
-    @Autowired
-    ApplicationProperties applicationProperties;
-    
+    @Autowired ApplicationProperties applicationProperties;
+
     @Bean(name = "loginEnabled")
     public boolean loginEnabled() {
         return applicationProperties.getSecurity().getEnableLogin();
@@ -18,7 +18,7 @@ public class AppConfig {
 
     @Bean(name = "appName")
     public String appName() {
-        String homeTitle =  applicationProperties.getUi().getAppName();
+        String homeTitle = applicationProperties.getUi().getAppName();
         return (homeTitle != null) ? homeTitle : "Stirling PDF";
     }
 
@@ -30,24 +30,31 @@ public class AppConfig {
 
     @Bean(name = "homeText")
     public String homeText() {
-    	return (applicationProperties.getUi().getHomeDescription() != null) ? applicationProperties.getUi().getHomeDescription() : "null";
+        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();
+        String defaultNavBar =
+                applicationProperties.getUi().getAppNameNavbar() != null
+                        ? applicationProperties.getUi().getAppNameNavbar()
+                        : applicationProperties.getUi().getAppName();
         return (defaultNavBar != null) ? defaultNavBar : "Stirling PDF";
     }
-	
-	@Bean(name = "rateLimit")
+
+    @Bean(name = "enableAlphaFunctionality")
+    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");
-        System.out.println("rateLimit=" + appName);
+        if (appName == null) appName = System.getenv("rateLimit");
         return (appName != null) ? Boolean.valueOf(appName) : false;
     }
-	
-	
-}
+}

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

@@ -15,10 +15,9 @@ import stirling.software.SPDF.model.ApplicationProperties;
 
 @Configuration
 public class Beans implements WebMvcConfigurer {
-	
-	@Autowired
-    ApplicationProperties applicationProperties;
-	
+
+    @Autowired ApplicationProperties applicationProperties;
+
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(localeChangeInterceptor());
@@ -35,25 +34,26 @@ public class Beans implements WebMvcConfigurer {
     @Bean
     public LocaleResolver localeResolver() {
         SessionLocaleResolver slr = new SessionLocaleResolver();
-        
-        
+
         String appLocaleEnv = applicationProperties.getSystem().getDefaultLocale();
-        Locale defaultLocale = 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()) {
             Locale tempLocale = Locale.forLanguageTag(appLocaleEnv);
             String tempLanguageTag = tempLocale.toLanguageTag();
 
-             if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
+            if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
                 defaultLocale = tempLocale;
             } else {
-                tempLocale = Locale.forLanguageTag(appLocaleEnv.replace("_","-"));
+                tempLocale = Locale.forLanguageTag(appLocaleEnv.replace("_", "-"));
                 tempLanguageTag = tempLocale.toLanguageTag();
 
                 if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
                     defaultLocale = tempLocale;
                 } else {
-                    System.err.println("Invalid APP_LOCALE environment variable value. Falling back to default Locale.UK.");
+                    System.err.println(
+                            "Invalid APP_LOCALE environment variable value. Falling back to default Locale.UK.");
                 }
             }
         }
@@ -61,5 +61,4 @@ public class Beans implements WebMvcConfigurer {
         slr.setDefaultLocale(defaultLocale);
         return slr;
     }
-    
 }

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

@@ -13,56 +13,62 @@ import jakarta.servlet.http.HttpServletResponse;
 
 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)
-			throws Exception {
-		String queryString = request.getQueryString();
-		if (queryString != null && !queryString.isEmpty()) {
-			String requestURI = request.getRequestURI();
-			Map<String, String> parameters = new HashMap<>();
+    @Override
+    public boolean preHandle(
+            HttpServletRequest request, HttpServletResponse response, Object handler)
+            throws Exception {
+        String queryString = request.getQueryString();
+        if (queryString != null && !queryString.isEmpty()) {
+            String requestURI = request.getRequestURI();
+            Map<String, String> parameters = new HashMap<>();
 
-			// Keep only the allowed parameters
-			String[] queryParameters = queryString.split("&");
-			for (String param : queryParameters) {
-				String[] keyValue = param.split("=");
-				if (keyValue.length != 2) {
-					continue;
-				}
-				if (ALLOWED_PARAMS.contains(keyValue[0])) {
-					parameters.put(keyValue[0], keyValue[1]);
-				}
-			}
+            // Keep only the allowed parameters
+            String[] queryParameters = queryString.split("&");
+            for (String param : queryParameters) {
+                String[] keyValue = param.split("=");
+                if (keyValue.length != 2) {
+                    continue;
+                }
+                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
-				StringBuilder newQueryString = new StringBuilder();
-				for (Map.Entry<String, String> entry : parameters.entrySet()) {
-					if (newQueryString.length() > 0) {
-						newQueryString.append("&");
-					}
-					newQueryString.append(entry.getKey()).append("=").append(entry.getValue());
-				}
+            // If there are any parameters that are not allowed
+            if (parameters.size() != queryParameters.length) {
+                // Construct new query string
+                StringBuilder newQueryString = new StringBuilder();
+                for (Map.Entry<String, String> entry : parameters.entrySet()) {
+                    if (newQueryString.length() > 0) {
+                        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);
-				return false;
-			}
-		}
-		return true;
-	}
+                // Redirect to the URL with only allowed query parameters
+                String redirectUrl = requestURI + "?" + newQueryString;
+                response.sendRedirect(redirectUrl);
+                return false;
+            }
+        }
+        return true;
+    }
 
-	@Override
-	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
-			ModelAndView modelAndView) {
-	}
+    @Override
+    public void postHandle(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            Object handler,
+            ModelAndView modelAndView) {}
 
-	@Override
-	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
-			Exception ex) {
-	}
+    @Override
+    public void afterCompletion(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            Object handler,
+            Exception ex) {}
 }

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

@@ -12,12 +12,15 @@ import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+import java.util.Set;
+import java.util.function.Function;
 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
     public void initialize(ConfigurableApplicationContext applicationContext) {
@@ -38,64 +41,103 @@ public class ConfigInitializer implements ApplicationContextInitializer<Configur
             Files.createDirectories(destPath.getParent());
 
             // Copy the resource from classpath to the external directory
-            try (InputStream in = getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
+            try (InputStream in =
+                    getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
                 if (in != null) {
                     Files.copy(in, destPath);
                 } else {
-                    throw new FileNotFoundException("Resource file not found: settings.yml.template");
+                    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;
-            try (InputStream in = getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
-                templateLines = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8)).lines().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);
         }
     }
 
-    public void mergeYamlFiles(List<String> templateLines, Path userFilePath, Path outputPath) throws IOException {
+    public void mergeYamlFiles(List<String> templateLines, Path userFilePath, Path outputPath)
+            throws IOException {
         List<String> userLines = Files.readAllLines(userFilePath);
-
         List<String> mergedLines = new ArrayList<>();
         boolean insideAutoGenerated = false;
+        boolean beforeFirstKey = true;
+
+        Function<String, Boolean> isCommented = line -> line.trim().startsWith("#");
+        Function<String, String> extractKey =
+                line -> {
+                    String[] parts = line.split(":");
+                    return parts.length > 0 ? parts[0].trim().replace("#", "").trim() : "";
+                };
+
+        Set<String> userKeys = userLines.stream().map(extractKey).collect(Collectors.toSet());
 
         for (String line : templateLines) {
-            // Check if we've entered or left the AutomaticallyGenerated section
+            String key = extractKey.apply(line);
+
             if (line.trim().equalsIgnoreCase("AutomaticallyGenerated:")) {
                 insideAutoGenerated = true;
                 mergedLines.add(line);
                 continue;
             } else if (insideAutoGenerated && line.trim().isEmpty()) {
-                // We have reached the end of the AutomaticallyGenerated section
                 insideAutoGenerated = false;
                 mergedLines.add(line);
                 continue;
             }
 
-            if (insideAutoGenerated) {
-                // Add lines from user's settings if we are inside AutomaticallyGenerated
-                Optional<String> userAutoGenValue = userLines.stream().filter(l -> l.trim().startsWith(line.split(":")[0].trim())).findFirst();
-                if (userAutoGenValue.isPresent()) {
-                    mergedLines.add(userAutoGenValue.get());
-                    continue;
-                }
-            } else {
-                // Outside of AutomaticallyGenerated, continue as before
-                if (line.contains(": ")) {
-                    String key = line.split(": ")[0].trim();
-                    Optional<String> userValue = userLines.stream().filter(l -> l.trim().startsWith(key)).findFirst();
-                    if (userValue.isPresent()) {
-                        mergedLines.add(userValue.get());
-                        continue;
-                    }
-                }
+            if (beforeFirstKey && (isCommented.apply(line) || line.trim().isEmpty())) {
+                // Handle top comments and empty lines before the first key.
                 mergedLines.add(line);
+                continue;
+            }
+
+            if (!key.isEmpty()) beforeFirstKey = false;
+
+            if (userKeys.contains(key)) {
+                // If user has any version (commented or uncommented) of this key, skip the
+                // template line
+                Optional<String> userValue =
+                        userLines.stream()
+                                .filter(
+                                        l ->
+                                                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)) {
+                mergedLines.add(
+                        line); // If line is commented, empty or key not present in user's file,
+                // retain the
+                // template line
+                continue;
+            }
+        }
+
+        // Add any additional uncommented user lines that are not present in the
+        // template
+        for (String userLine : userLines) {
+            String userKey = extractKey.apply(userLine);
+            boolean isPresentInTemplate =
+                    templateLines.stream()
+                            .map(extractKey)
+                            .anyMatch(templateKey -> templateKey.equalsIgnoreCase(userKey));
+            if (!isPresentInTemplate && !isCommented.apply(userLine)) {
+                mergedLines.add(userLine);
             }
         }
 
         Files.write(outputPath, mergedLines, StandardCharsets.UTF_8);
     }
-}
+}

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

@@ -12,6 +12,7 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import stirling.software.SPDF.model.ApplicationProperties;
+
 @Service
 public class EndpointConfiguration {
     private static final Logger logger = LoggerFactory.getLogger(EndpointConfiguration.class);
@@ -26,16 +27,16 @@ public class EndpointConfiguration {
         init();
         processEnvironmentConfigs();
     }
-    
+
     public void enableEndpoint(String endpoint) {
-    	endpointStatuses.put(endpoint, true);
+        endpointStatuses.put(endpoint, true);
     }
 
     public void disableEndpoint(String endpoint) {
-    	if(!endpointStatuses.containsKey(endpoint) || endpointStatuses.get(endpoint) !=  false) {
-	        logger.info("Disabling {}", endpoint);
-	        endpointStatuses.put(endpoint, false);
-    	}
+        if (!endpointStatuses.containsKey(endpoint) || endpointStatuses.get(endpoint) != false) {
+            logger.info("Disabling {}", endpoint);
+            endpointStatuses.put(endpoint, false);
+        }
     }
 
     public boolean isEndpointEnabled(String endpoint) {
@@ -66,7 +67,7 @@ public class EndpointConfiguration {
             }
         }
     }
-    
+
     public void init() {
         // Adding endpoints to "PageOps" group
         addEndpointToGroup("PageOps", "remove-pages");
@@ -81,7 +82,10 @@ public class EndpointConfiguration {
         addEndpointToGroup("PageOps", "auto-split-pdf");
         addEndpointToGroup("PageOps", "extract-page");
         addEndpointToGroup("PageOps", "pdf-to-single-page");
-        
+        addEndpointToGroup("PageOps", "split-by-size-or-count");
+        addEndpointToGroup("PageOps", "overlay-pdf");
+        addEndpointToGroup("PageOps", "split-pdf-by-sections");
+
         // Adding endpoints to "Convert" group
         addEndpointToGroup("Convert", "pdf-to-img");
         addEndpointToGroup("Convert", "img-to-pdf");
@@ -96,7 +100,8 @@ public class EndpointConfiguration {
         addEndpointToGroup("Convert", "html-to-pdf");
         addEndpointToGroup("Convert", "url-to-pdf");
         addEndpointToGroup("Convert", "markdown-to-pdf");
-        
+        addEndpointToGroup("Convert", "pdf-to-csv");
+
         // Adding endpoints to "Security" group
         addEndpointToGroup("Security", "add-password");
         addEndpointToGroup("Security", "remove-password");
@@ -104,8 +109,8 @@ public class EndpointConfiguration {
         addEndpointToGroup("Security", "add-watermark");
         addEndpointToGroup("Security", "cert-sign");
         addEndpointToGroup("Security", "sanitize-pdf");
-        
-        
+        addEndpointToGroup("Security", "auto-redact");
+
         // Adding endpoints to "Other" group
         addEndpointToGroup("Other", "ocr-pdf");
         addEndpointToGroup("Other", "add-image");
@@ -117,15 +122,14 @@ public class EndpointConfiguration {
         addEndpointToGroup("Other", "flatten");
         addEndpointToGroup("Other", "repair");
         addEndpointToGroup("Other", "remove-blanks");
+        addEndpointToGroup("Other", "remove-annotations");
         addEndpointToGroup("Other", "compare");
         addEndpointToGroup("Other", "add-page-numbers");
         addEndpointToGroup("Other", "auto-rename");
         addEndpointToGroup("Other", "get-info-on-pdf");
         addEndpointToGroup("Other", "show-javascript");
-        
-        
-        
-        //CLI
+
+        // CLI
         addEndpointToGroup("CLI", "compress-pdf");
         addEndpointToGroup("CLI", "extract-image-scans");
         addEndpointToGroup("CLI", "remove-blanks");
@@ -141,19 +145,18 @@ public class EndpointConfiguration {
         addEndpointToGroup("CLI", "ocr-pdf");
         addEndpointToGroup("CLI", "html-to-pdf");
         addEndpointToGroup("CLI", "url-to-pdf");
-        
-        
-        //python
+
+        // python
         addEndpointToGroup("Python", "extract-image-scans");
         addEndpointToGroup("Python", "remove-blanks");
         addEndpointToGroup("Python", "html-to-pdf");
         addEndpointToGroup("Python", "url-to-pdf");
-        
-        //openCV
+
+        // openCV
         addEndpointToGroup("OpenCV", "extract-image-scans");
         addEndpointToGroup("OpenCV", "remove-blanks");
 
-        //LibreOffice
+        // LibreOffice
         addEndpointToGroup("LibreOffice", "repair");
         addEndpointToGroup("LibreOffice", "file-to-pdf");
         addEndpointToGroup("LibreOffice", "xlsx-to-pdf");
@@ -162,14 +165,13 @@ public class EndpointConfiguration {
         addEndpointToGroup("LibreOffice", "pdf-to-text");
         addEndpointToGroup("LibreOffice", "pdf-to-html");
         addEndpointToGroup("LibreOffice", "pdf-to-xml");
-        
-        
-        //OCRmyPDF
+
+        // OCRmyPDF
         addEndpointToGroup("OCRmyPDF", "compress-pdf");
         addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa");
         addEndpointToGroup("OCRmyPDF", "ocr-pdf");
-        
-        //Java
+
+        // Java
         addEndpointToGroup("Java", "merge-pdfs");
         addEndpointToGroup("Java", "remove-pages");
         addEndpointToGroup("Java", "split-pdfs");
@@ -197,16 +199,19 @@ public class EndpointConfiguration {
         addEndpointToGroup("Java", "pdf-to-single-page");
         addEndpointToGroup("Java", "markdown-to-pdf");
         addEndpointToGroup("Java", "show-javascript");
-        
-        //Javascript
+        addEndpointToGroup("Java", "auto-redact");
+        addEndpointToGroup("Java", "pdf-to-csv");
+        addEndpointToGroup("Java", "split-by-size-or-count");
+        addEndpointToGroup("Java", "overlay-pdf");
+        addEndpointToGroup("Java", "split-pdf-by-sections");
+
+        // 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();
@@ -223,6 +228,4 @@ public class EndpointConfiguration {
             }
         }
     }
-
 }
-

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

@@ -10,11 +10,11 @@ import jakarta.servlet.http.HttpServletResponse;
 @Component
 public class EndpointInterceptor implements HandlerInterceptor {
 
-    @Autowired
-    private EndpointConfiguration endpointConfiguration;
+    @Autowired private EndpointConfiguration endpointConfiguration;
 
     @Override
-    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
+    public boolean preHandle(
+            HttpServletRequest request, HttpServletResponse response, Object handler)
             throws Exception {
         String requestURI = request.getRequestURI();
         if (!endpointConfiguration.isEndpointEnabled(requestURI)) {
@@ -23,4 +23,4 @@ public class EndpointInterceptor implements HandlerInterceptor {
         }
         return true;
     }
-}
+}

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

@@ -1,4 +1,5 @@
 package stirling.software.SPDF.config;
+
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -21,4 +22,4 @@ public class MetricsConfig {
             }
         };
     }
-}
+}

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

@@ -8,6 +8,7 @@ import org.springframework.web.filter.OncePerRequestFilter;
 
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.MeterRegistry;
+
 import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
@@ -24,25 +25,39 @@ public class MetricsFilter extends OncePerRequestFilter {
     }
 
     @Override
-    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
             throws ServletException, IOException {
         String uri = request.getRequestURI();
-        
-        //System.out.println("uri="+uri + ", method=" + request.getMethod() );
+
+        // System.out.println("uri="+uri + ", method=" + request.getMethod() );
         // 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"))) {
-            Counter counter = Counter.builder("http.requests")
-                    .tag("uri", uri)
-                    .tag("method", request.getMethod())
-                    .register(meterRegistry);
+        if (!(uri.startsWith("/js")
+                || uri.startsWith("/v1/api-docs")
+                || uri.endsWith("robots.txt")
+                || uri.startsWith("/images")
+                || uri.startsWith("/images")
+                || uri.endsWith(".png")
+                || uri.endsWith(".ico")
+                || uri.endsWith(".css")
+                || 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;
 
+import org.springframework.beans.factory.annotation.Autowired;
 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.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+
+import stirling.software.SPDF.model.ApplicationProperties;
 
 @Configuration
 public class OpenApiConfig {
 
-	@Bean
-	public OpenAPI customOpenAPI() {
-	    String version = getClass().getPackage().getImplementationVersion();
-	    if (version == null) {
-	        
-	            version = "1.0.0"; // default version if all else fails
-	        
-	    }
-
-	    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."));
-	}
+    @Autowired ApplicationProperties applicationProperties;
 
+    @Bean
+    public OpenAPI customOpenAPI() {
+        String version = getClass().getPackage().getImplementationVersion();
+        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/StartupApplicationListener.java

@@ -1,6 +1,5 @@
 package stirling.software.SPDF.config;
 
-
 import java.time.LocalDateTime;
 
 import org.springframework.context.ApplicationListener;
@@ -17,4 +16,3 @@ public class StartupApplicationListener implements ApplicationListener<ContextRe
         startTime = LocalDateTime.now();
     }
 }
- 

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

@@ -9,19 +9,18 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 @Configuration
 public class WebMvcConfig implements WebMvcConfigurer {
 
-    @Autowired
-    private EndpointInterceptor endpointInterceptor;
+    @Autowired private EndpointInterceptor endpointInterceptor;
 
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(endpointInterceptor);
     }
-    
+
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         // Handler for external static resources
         registry.addResourceHandler("/**")
                 .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) 
-      throws IOException {
+    public PropertySource<?> createPropertySource(String name, EncodedResource encodedResource)
+            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

@@ -2,25 +2,48 @@ package stirling.software.SPDF.config.security;
 
 import java.io.IOException;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.authentication.BadCredentialsException;
 import org.springframework.security.authentication.LockedException;
 import org.springframework.security.core.AuthenticationException;
 import org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler;
+import org.springframework.stereotype.Component;
 
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 
+@Component
 public class CustomAuthenticationFailureHandler extends SimpleUrlAuthenticationFailureHandler {
 
+    @Autowired private final LoginAttemptService loginAttemptService;
+
+    @Autowired
+    public CustomAuthenticationFailureHandler(LoginAttemptService loginAttemptService) {
+        this.loginAttemptService = loginAttemptService;
+    }
+
     @Override
-    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) 
-      throws IOException, ServletException {
-        if (exception.getClass().isAssignableFrom(BadCredentialsException.class)) {
-        	setDefaultFailureUrl("/login?error=badcredentials");
-        } else if (exception.getClass().isAssignableFrom(LockedException.class)) {
-        	setDefaultFailureUrl("/login?error=locked");
+    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

@@ -5,6 +5,7 @@ import java.util.Set;
 import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.authentication.LockedException;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;
 import org.springframework.security.core.userdetails.UserDetails;
@@ -19,27 +20,38 @@ import stirling.software.SPDF.repository.UserRepository;
 @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 {
-        User user = userRepository.findByUsername(username)
-            .orElseThrow(() -> new UsernameNotFoundException("No user found with username: " + username));
+        User user =
+                userRepository
+                        .findByUsername(username)
+                        .orElseThrow(
+                                () ->
+                                        new UsernameNotFoundException(
+                                                "No user found with username: " + username));
+
+        if (loginAttemptService.isBlocked(username)) {
+            throw new LockedException(
+                    "Your account has been locked due to too many failed login attempts.");
+        }
 
         return new org.springframework.security.core.userdetails.User(
-            user.getUsername(),
-            user.getPassword(),
-            user.isEnabled(),
-            true, true, true,
-            getAuthorities(user.getAuthorities())
-        );
+                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());
+                .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
-    @Lazy
-    private UserService userService;
-    
+
+    @Autowired @Lazy private UserService userService;
+
     @Override
-    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
-    	String method = request.getMethod();
-    	String requestURI = request.getRequestURI(); 
-    	 // Check if the request is for static resources
-        boolean isStaticResource = requestURI.startsWith("/css/") 
-                                || requestURI.startsWith("/js/")
-                                || requestURI.startsWith("/images/")
-                                || requestURI.startsWith("/public/")
-                                || requestURI.endsWith(".svg");
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
+        String method = request.getMethod();
+        String requestURI = request.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) {
             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,66 +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
-	private UserService userService;
+    @Autowired private UserService userService;
 
+    @Autowired ApplicationProperties applicationProperties;
 
-	@Autowired
-	ApplicationProperties applicationProperties;
-	
-	@PostConstruct
-	public void init() {
-		if (!userService.hasUsers()) {
-			String initialUsername = "admin";
-			String initialPassword = "stirling";
-			userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId(), true);
-			
-			
-	        
-		}
-	}
+    @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);
+            }
+        }
+        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
-	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);
-		}
-	}
+    private void saveKeyToConfig(String key) throws IOException {
+        Path path = Paths.get("configs", "settings.yml"); // Target the configs/settings.yml
+        List<String> lines = Files.readAllLines(path);
+        boolean keyFound = false;
 
-	private void saveKeyToConfig(String key) throws IOException {
-		Path path = Paths.get("configs", "settings.yml"); // Target the configs/settings.yml
-		List<String> lines = Files.readAllLines(path);
-		boolean keyFound = false;
+        // Search for the existing key to replace it or place to add it
+        for (int i = 0; i < lines.size(); i++) {
+            if (lines.get(i).startsWith("AutomaticallyGenerated:")) {
+                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
-		for (int i = 0; i < lines.size(); i++) {
-			if (lines.get(i).startsWith("AutomaticallyGenerated:")) {
-				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;
-				}
-			}
-		}
+        // If the section doesn't exist, append it
+        if (!keyFound) {
+            lines.add("# Automatically Generated Settings (Do Not Edit Directly)");
+            lines.add("AutomaticallyGenerated:");
+            lines.add("  key: " + key);
+        }
 
-		// If the section doesn't exist, append it
-		if (!keyFound) {
-			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);
-	}
-}
+        // 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

@@ -6,7 +6,7 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
 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.configuration.EnableWebSecurity;
 import org.springframework.security.core.userdetails.UserDetailsService;
@@ -15,78 +15,113 @@ import org.springframework.security.crypto.password.PasswordEncoder;
 import org.springframework.security.web.SecurityFilterChain;
 import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
 import org.springframework.security.web.authentication.rememberme.PersistentTokenRepository;
+import org.springframework.security.web.savedrequest.NullRequestCache;
 import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
 
 import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
+
 @Configuration
 @EnableWebSecurity()
-@EnableGlobalMethodSecurity(prePostEnabled = true)
+@EnableMethodSecurity
 public class SecurityConfiguration {
 
-    @Autowired
-    private UserDetailsService userDetailsService;
+    @Autowired private UserDetailsService userDetailsService;
 
     @Bean
     public PasswordEncoder passwordEncoder() {
         return new BCryptPasswordEncoder();
     }
-    @Autowired
-    @Lazy
-    private UserService userService;
-    
+
+    @Autowired @Lazy private UserService userService;
+
     @Autowired
     @Qualifier("loginEnabled")
     public boolean loginEnabledValue;
-    
-    @Autowired
-    private UserAuthenticationFilter userAuthenticationFilter;
-    
-    @Autowired
-    private FirstLoginFilter firstLoginFilter;
-    
+
+    @Autowired private UserAuthenticationFilter userAuthenticationFilter;
+
+    @Autowired private LoginAttemptService loginAttemptService;
+
+    @Autowired private FirstLoginFilter firstLoginFilter;
+
     @Bean
-    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception  {
-    	http.addFilterBefore(userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
-        
-    	if(loginEnabledValue) {
-    		
-    		http.csrf(csrf -> csrf.disable());
-    		http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
-	        http
-	            .formLogin(formLogin -> formLogin
-	                .loginPage("/login")
-	                .defaultSuccessUrl("/")
-	                .failureHandler(new CustomAuthenticationFailureHandler())
-	                .permitAll()
-	            )
-	            .logout(logout -> logout
-	            		.logoutRequestMatcher(new AntPathRequestMatcher("/logout"))
-	                    .logoutSuccessUrl("/login?logout=true")
-	                    .invalidateHttpSession(true)        // Invalidate session
-	                    .deleteCookies("JSESSIONID", "remember-me") 
-	            ).rememberMe(rememberMeConfigurer -> rememberMeConfigurer // Use the configurator directly
-                    .key("uniqueAndSecret")
-                    .tokenRepository(persistentTokenRepository())
-                    .tokenValiditySeconds(1209600) // 2 weeks
-                )
-	            .authorizeHttpRequests(authz -> authz
-	                    .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/"))
-	                    .permitAll()
-	                    .anyRequest().authenticated()
-	                )
-	            .userDetailsService(userDetailsService)
-	            .authenticationProvider(authenticationProvider());
-    	} else {
-    		 http.csrf(csrf -> csrf.disable())
-             .authorizeHttpRequests(authz -> authz
-                 .anyRequest().permitAll()
-             );
-    	}
+    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
+        http.addFilterBefore(userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
+
+        if (loginEnabledValue) {
+
+            http.csrf(csrf -> csrf.disable());
+            http.addFilterBefore(rateLimitingFilter(), UsernamePasswordAuthenticationFilter.class);
+            http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
+            http.formLogin(
+                            formLogin ->
+                                    formLogin
+                                            .loginPage("/login")
+                                            .successHandler(
+                                                    new CustomAuthenticationSuccessHandler())
+                                            .defaultSuccessUrl("/")
+                                            .failureHandler(
+                                                    new CustomAuthenticationFailureHandler(
+                                                            loginAttemptService))
+                                            .permitAll())
+                    .requestCache(requestCache -> requestCache.requestCache(new NullRequestCache()))
+                    .logout(
+                            logout ->
+                                    logout.logoutRequestMatcher(
+                                                    new AntPathRequestMatcher("/logout"))
+                                            .logoutSuccessUrl("/login?logout=true")
+                                            .invalidateHttpSession(true) // Invalidate session
+                                            .deleteCookies("JSESSIONID", "remember-me"))
+                    .rememberMe(
+                            rememberMeConfigurer ->
+                                    rememberMeConfigurer // Use the configurator directly
+                                            .key("uniqueAndSecret")
+                                            .tokenRepository(persistentTokenRepository())
+                                            .tokenValiditySeconds(1209600) // 2 weeks
+                            )
+                    .authorizeHttpRequests(
+                            authz ->
+                                    authz.requestMatchers(
+                                                    req -> {
+                                                        String uri = req.getRequestURI();
+                                                        String contextPath = req.getContextPath();
+
+                                                        // Remove the context path from the URI
+                                                        String trimmedUri =
+                                                                uri.startsWith(contextPath)
+                                                                        ? uri.substring(
+                                                                                contextPath
+                                                                                        .length())
+                                                                        : uri;
+
+                                                        return trimmedUri.startsWith("/login")
+                                                                || trimmedUri.endsWith(".svg")
+                                                                || trimmedUri.startsWith(
+                                                                        "/register")
+                                                                || trimmedUri.startsWith("/error")
+                                                                || trimmedUri.startsWith("/images/")
+                                                                || trimmedUri.startsWith("/public/")
+                                                                || trimmedUri.startsWith("/css/")
+                                                                || trimmedUri.startsWith("/js/");
+                                                    })
+                                            .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();
@@ -94,13 +129,9 @@ public class SecurityConfiguration {
         authProvider.setPasswordEncoder(passwordEncoder());
         return authProvider;
     }
-    
+
     @Bean
     public PersistentTokenRepository persistentTokenRepository() {
         return new JPATokenRepositoryImpl();
     }
-    
-
-    
 }
-

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

@@ -19,32 +19,29 @@ import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import stirling.software.SPDF.model.ApiKeyAuthenticationToken;
+
 @Component
 public class UserAuthenticationFilter extends OncePerRequestFilter {
 
-    @Autowired
-    private UserDetailsService userDetailsService;
+    @Autowired private UserDetailsService userDetailsService;
+
+    @Autowired @Lazy private UserService userService;
 
-    @Autowired
-    @Lazy
-    private UserService userService;
-    
-   
     @Autowired
     @Qualifier("loginEnabled")
     public boolean loginEnabledValue;
 
     @Override
-    protected void doFilterInternal(HttpServletRequest request,
-                                    HttpServletResponse response,
-                                    FilterChain filterChain) throws ServletException, IOException {
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
 
         if (!loginEnabledValue) {
             // If login is not enabled, just pass all requests without authentication
             filterChain.doFilter(request, response);
             return;
         }
-        String requestURI = request.getRequestURI(); 
+        String requestURI = request.getRequestURI();
         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
 
         // Check for API key in the request headers if no authentication exists
@@ -52,15 +49,17 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
             String apiKey = request.getHeader("X-API-Key");
             if (apiKey != null && !apiKey.trim().isEmpty()) {
                 try {
-                    // Use API key to authenticate. This requires you to have an authentication provider for API keys.
-                	UserDetails userDetails = userService.loadUserByApiKey(apiKey);
-                	if(userDetails == null)
-                	{
-                		response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                    // Use API key to authenticate. This requires you to have an authentication
+                    // provider for API keys.
+                    UserDetails userDetails = userService.loadUserByApiKey(apiKey);
+                    if (userDetails == null) {
+                        response.setStatus(HttpStatus.UNAUTHORIZED.value());
                         response.getWriter().write("Invalid API Key.");
                         return;
-                	}
-                    authentication = new ApiKeyAuthenticationToken(userDetails, apiKey, userDetails.getAuthorities());
+                    }
+                    authentication =
+                            new ApiKeyAuthenticationToken(
+                                    userDetails, apiKey, userDetails.getAuthorities());
                     SecurityContextHolder.getContext().setAuthentication(authentication);
                 } catch (AuthenticationException e) {
                     // If API key authentication fails, deny the request
@@ -73,32 +72,38 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
 
         // If we still don't have any authentication, deny the request
         if (authentication == null || !authentication.isAuthenticated()) {
-        	String method = request.getMethod();
-        	if ("GET".equalsIgnoreCase(method) && !"/login".equals(requestURI)) {
-        		 response.sendRedirect("/login");  // redirect to the login page
-        	     return;
+            String method = request.getMethod();
+            String contextPath = request.getContextPath();
+
+            if ("GET".equalsIgnoreCase(method) && !(contextPath + "/login").equals(requestURI)) {
+                response.sendRedirect(contextPath + "/login"); // redirect to the login page
+                return;
             } else {
-	            response.setStatus(HttpStatus.UNAUTHORIZED.value());
-	            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;
+                response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                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
     protected boolean shouldNotFilter(HttpServletRequest request) throws ServletException {
         String uri = request.getRequestURI();
-
+        String contextPath = request.getContextPath();
         String[] permitAllPatterns = {
-            "/login",
-            "/register",
-            "/error",
-            "/images/",
-            "/public/",
-            "/css/",
-            "/js/"
+            contextPath + "/login",
+            contextPath + "/register",
+            contextPath + "/error",
+            contextPath + "/images/",
+            contextPath + "/public/",
+            contextPath + "/css/",
+            contextPath + "/js/",
+            contextPath + "/pdfjs/",
+            contextPath + "/site.webmanifest"
         };
 
         for (String pattern : permitAllPatterns) {
@@ -109,5 +114,4 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
 
         return false;
     }
-
 }

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

@@ -20,28 +20,29 @@ import io.github.bucket4j.Bandwidth;
 import io.github.bucket4j.Bucket;
 import io.github.bucket4j.ConsumptionProbe;
 import io.github.bucket4j.Refill;
+
 import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import stirling.software.SPDF.model.Role;
+
 @Component
 public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
 
-	private final Map<String, Bucket> apiBuckets = new ConcurrentHashMap<>();
+    private final Map<String, Bucket> apiBuckets = new ConcurrentHashMap<>();
     private final Map<String, Bucket> webBuckets = new ConcurrentHashMap<>();
 
-    @Autowired
-    private UserDetailsService userDetailsService;
+    @Autowired private UserDetailsService userDetailsService;
 
     @Autowired
     @Qualifier("rateLimit")
     public boolean rateLimit;
 
     @Override
-    protected void doFilterInternal(HttpServletRequest request,
-                                    HttpServletResponse response,
-                                    FilterChain filterChain) throws ServletException, IOException {
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
         if (!rateLimit) {
             // If rateLimit is not enabled, just pass all requests without rate limiting
             filterChain.doFilter(request, response);
@@ -60,7 +61,8 @@ public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
         // Check for API key in the request headers
         String apiKey = request.getHeader("X-API-Key");
         if (apiKey != null && !apiKey.trim().isEmpty()) {
-            identifier = "API_KEY_" + apiKey; // Prefix to distinguish between API keys and usernames
+            identifier =
+                    "API_KEY_" + apiKey; // Prefix to distinguish between API keys and usernames
         } else {
             Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
             if (authentication != null && authentication.isAuthenticated()) {
@@ -74,14 +76,27 @@ public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
             identifier = request.getRemoteAddr();
         }
 
-        Role userRole = getRoleFromAuthentication(SecurityContextHolder.getContext().getAuthentication());
+        Role userRole =
+                getRoleFromAuthentication(SecurityContextHolder.getContext().getAuthentication());
 
         if (request.getHeader("X-API-Key") != null) {
             // It's an API call
-            processRequest(userRole.getApiCallsPerDay(), identifier, apiBuckets, request, response, filterChain);
+            processRequest(
+                    userRole.getApiCallsPerDay(),
+                    identifier,
+                    apiBuckets,
+                    request,
+                    response,
+                    filterChain);
         } else {
             // It's a Web UI call
-            processRequest(userRole.getWebCallsPerDay(), identifier, webBuckets, request, response, filterChain);
+            processRequest(
+                    userRole.getWebCallsPerDay(),
+                    identifier,
+                    webBuckets,
+                    request,
+                    response,
+                    filterChain);
         }
     }
 
@@ -98,8 +113,13 @@ public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
         throw new IllegalStateException("User does not have a valid role.");
     }
 
-    private void processRequest(int limitPerDay, String identifier, Map<String, Bucket> buckets,
-                                HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+    private void processRequest(
+            int limitPerDay,
+            String identifier,
+            Map<String, Bucket> buckets,
+            HttpServletRequest request,
+            HttpServletResponse response,
+            FilterChain filterChain)
             throws IOException, ServletException {
         Bucket userBucket = buckets.computeIfAbsent(identifier, k -> createUserBucket(limitPerDay));
         ConsumptionProbe probe = userBucket.tryConsumeAndReturnRemaining(1);
@@ -116,10 +136,8 @@ public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
     }
 
     private Bucket createUserBucket(int limitPerDay) {
-        Bandwidth limit = Bandwidth.classic(limitPerDay, Refill.intervally(limitPerDay, Duration.ofDays(1)));
+        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,4 +1,5 @@
 package stirling.software.SPDF.config.security;
+
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
@@ -16,41 +17,40 @@ import org.springframework.security.core.userdetails.UsernameNotFoundException;
 import org.springframework.security.crypto.password.PasswordEncoder;
 import org.springframework.stereotype.Service;
 
+import stirling.software.SPDF.controller.api.pipeline.UserServiceInterface;
 import stirling.software.SPDF.model.Authority;
+import stirling.software.SPDF.model.Role;
 import stirling.software.SPDF.model.User;
 import stirling.software.SPDF.repository.UserRepository;
-@Service
-public class UserService {
-    
-    @Autowired
-    private UserRepository userRepository;
 
-    @Autowired
-    private PasswordEncoder passwordEncoder;
+@Service
+public class UserService implements UserServiceInterface {
+
+    @Autowired private UserRepository userRepository;
+
+    @Autowired private PasswordEncoder passwordEncoder;
 
     public Authentication getAuthentication(String apiKey) {
         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)
-            null,                       // credentials (we don't expose the password or API key here)
-            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()
-    		    .map((Authority authority) -> new SimpleGrantedAuthority(authority.getAuthority()))
-    		    .collect(Collectors.toList());
-
-
+        return user.getAuthorities().stream()
+                .map((Authority authority) -> new SimpleGrantedAuthority(authority.getAuthority()))
+                .collect(Collectors.toList());
     }
-    
+
     private String generateApiKey() {
         String apiKey;
         do {
@@ -60,9 +60,11 @@ public class UserService {
     }
 
     public User addApiKeyToUser(String username) {
-        User user = userRepository.findByUsername(username)
-            .orElseThrow(() -> new UsernameNotFoundException("User not found"));
-        
+        User user =
+                userRepository
+                        .findByUsername(username)
+                        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+
         user.setApiKey(generateApiKey());
         return userRepository.save(user);
     }
@@ -72,8 +74,10 @@ public class UserService {
     }
 
     public String getApiKeyForUser(String username) {
-        User user = userRepository.findByUsername(username)
-            .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+        User user =
+                userRepository
+                        .findByUsername(username)
+                        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
         return user.getApiKey();
     }
 
@@ -84,27 +88,25 @@ public class UserService {
     public User getUserByApiKey(String apiKey) {
         return userRepository.findByApiKey(apiKey);
     }
-    
+
     public UserDetails loadUserByApiKey(String apiKey) {
         User userOptional = userRepository.findByApiKey(apiKey);
         if (userOptional != null) {
             User user = userOptional;
             // Convert your User entity to a UserDetails object with authorities
             return new org.springframework.security.core.userdetails.User(
-                user.getUsername(),
-                user.getPassword(), // you might not need this for API key auth
-                getAuthorities(user)
-            );
+                    user.getUsername(),
+                    user.getPassword(), // you might not need this for API key auth
+                    getAuthorities(user));
         }
-        return null;  // or throw an exception
+        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 void saveUser(String username, String password) {
         User user = new User();
         user.setUsername(username);
@@ -122,7 +124,7 @@ public class UserService {
         user.setFirstLogin(firstLogin);
         userRepository.save(user);
     }
-    
+
     public void saveUser(String username, String password, String role) {
         User user = new User();
         user.setUsername(username);
@@ -132,37 +134,42 @@ public class UserService {
         user.setFirstLogin(false);
         userRepository.save(user);
     }
-    
+
     public void deleteUser(String username) {
-    	 Optional<User> userOpt = userRepository.findByUsername(username);
-         if (userOpt.isPresent()) {
-        	 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())) {
+                    return;
+                }
+            }
+            userRepository.delete(userOpt.get());
+        }
     }
-    
+
     public boolean usernameExists(String username) {
         return userRepository.findByUsername(username).isPresent();
     }
-    
+
     public boolean hasUsers() {
         return userRepository.count() > 0;
     }
-    
+
     public void updateUserSettings(String username, Map<String, String> updates) {
         Optional<User> userOpt = userRepository.findByUsername(username);
         if (userOpt.isPresent()) {
             User user = userOpt.get();
             Map<String, String> settingsMap = user.getSettings();
 
-            if(settingsMap == null) {
-                settingsMap = new HashMap<String,String>();
-            } 
+            if (settingsMap == null) {
+                settingsMap = new HashMap<String, String>();
+            }
             settingsMap.clear();
             settingsMap.putAll(updates);
             user.setSettings(settingsMap);
 
             userRepository.save(user);
-        } 
+        }
     }
 
     public Optional<User> findByUsername(String username) {
@@ -178,13 +185,12 @@ public class UserService {
         user.setPassword(passwordEncoder.encode(newPassword));
         userRepository.save(user);
     }
-    
+
     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")
-	@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")
-	public ResponseEntity<byte[]> cropPdf(@ModelAttribute CropPdfForm form)
-			throws IOException {
+    @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")
+    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++) {
-    PDPage sourcePage = sourceDocument.getPage(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
+            PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
 
-    // Import the source page as a form XObject
-    PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
+            contentStream.saveGraphicsState();
 
-    contentStream.saveGraphicsState();
-    
-    // Define the crop area
-    contentStream.addRect(form.getX(), form.getY(), form.getWidth(), form.getHeight());
-    contentStream.clip();
+            // Define the crop area
+            contentStream.addRect(form.getX(), form.getY(), form.getWidth(), form.getHeight());
+            contentStream.clip();
 
-    // Draw the entire formXObject
-    contentStream.drawForm(formXObject);
+            // Draw the entire formXObject
+            contentStream.drawForm(formXObject);
 
-    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.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");
+    }
 }

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 {
-	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 {
+    private PDDocument mergeDocuments(List<PDDocument> documents) throws IOException {
+        PDDocument mergedDoc = new PDDocument();
         for (PDDocument doc : documents) {
-            if (doc != null) {
-                doc.close();
+            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 {
+        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,6 @@
 package stirling.software.SPDF.controller.api;
 
-
+import java.awt.Color;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 
@@ -22,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;
 
@@ -30,81 +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")
-	@Operation(
-	    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"
-	)
-	public ResponseEntity<byte[]> mergeMultiplePagesIntoOne(@ModelAttribute MergeMultiplePagesRequest request)
-	        throws IOException {
+    @PostMapping(value = "/multi-page-layout", consumes = "multipart/form-data")
+    @Operation(
+            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")
+    public ResponseEntity<byte[]> mergeMultiplePagesIntoOne(
+            @ModelAttribute MergeMultiplePagesRequest request) throws IOException {
 
-	    int pagesPerSheet = request.getPagesPerSheet();
-	    MultipartFile file = request.getFileInput();
+        int pagesPerSheet = request.getPagesPerSheet();
+        MultipartFile file = request.getFileInput();
+        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");
-	    }
+        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);
-	    int rows = pagesPerSheet == 2 || pagesPerSheet == 3 ? 1 : (int) Math.sqrt(pagesPerSheet);
+        int cols =
+                pagesPerSheet == 2 || pagesPerSheet == 3
+                        ? pagesPerSheet
+                        : (int) Math.sqrt(pagesPerSheet);
+        int rows = pagesPerSheet == 2 || pagesPerSheet == 3 ? 1 : (int) Math.sqrt(pagesPerSheet);
 
-	    PDDocument sourceDocument = PDDocument.load(file.getInputStream());
-	    PDDocument newDocument = new PDDocument();
-	    PDPage newPage = new PDPage(PDRectangle.A4);
-	    newDocument.addPage(newPage);
+        PDDocument sourceDocument = PDDocument.load(file.getInputStream());
+        PDDocument newDocument = new PDDocument();
+        PDPage newPage = new PDPage(PDRectangle.A4);
+        newDocument.addPage(newPage);
 
-	    int totalPages = sourceDocument.getNumberOfPages();
-	    float cellWidth = newPage.getMediaBox().getWidth() / cols;
-	    float cellHeight = newPage.getMediaBox().getHeight() / rows;
+        int totalPages = sourceDocument.getNumberOfPages();
+        float cellWidth = newPage.getMediaBox().getWidth() / cols;
+        float cellHeight = newPage.getMediaBox().getHeight() / rows;
 
-	    PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage, PDPageContentStream.AppendMode.APPEND, true, true);
-	    LayerUtility layerUtility = new LayerUtility(newDocument);
+        PDPageContentStream contentStream =
+                new PDPageContentStream(
+                        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);
-	        }
+        float borderThickness = 1.5f; // Specify border thickness as required
+        contentStream.setLineWidth(borderThickness);
+        contentStream.setStrokingColor(Color.BLACK);
 
-	        PDPage sourcePage = sourceDocument.getPage(i);
-	        PDRectangle rect = sourcePage.getMediaBox();
-	        float scaleWidth = cellWidth / rect.getWidth();
-	        float scaleHeight = cellHeight / rect.getHeight();
-	        float scale = Math.min(scaleWidth, scaleHeight);
+        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);
+            }
 
-	        int adjustedPageIndex = i % pagesPerSheet;  // This will reset the index for every new page
-	        int rowIndex = adjustedPageIndex / cols;
-	        int colIndex = adjustedPageIndex % cols;
+            PDPage sourcePage = sourceDocument.getPage(i);
+            PDRectangle rect = sourcePage.getMediaBox();
+            float scaleWidth = cellWidth / rect.getWidth();
+            float scaleHeight = cellHeight / rect.getHeight();
+            float scale = Math.min(scaleWidth, scaleHeight);
 
-	        float x = colIndex * cellWidth + (cellWidth - rect.getWidth() * scale) / 2;
-	        float y = newPage.getMediaBox().getHeight() - ((rowIndex + 1) * cellHeight - (cellHeight - rect.getHeight() * scale) / 2);
+            int adjustedPageIndex =
+                    i % pagesPerSheet; // This will reset the index for every new page
+            int rowIndex = adjustedPageIndex / cols;
+            int colIndex = adjustedPageIndex % cols;
 
-	        contentStream.saveGraphicsState();
-	        contentStream.transform(Matrix.getTranslateInstance(x, y));
-	        contentStream.transform(Matrix.getScaleInstance(scale, scale));
+            float x = colIndex * cellWidth + (cellWidth - rect.getWidth() * scale) / 2;
+            float y =
+                    newPage.getMediaBox().getHeight()
+                            - ((rowIndex + 1) * cellHeight
+                                    - (cellHeight - rect.getHeight() * scale) / 2);
 
-	        PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
-	        contentStream.drawForm(formXObject);
+            contentStream.saveGraphicsState();
+            contentStream.transform(Matrix.getTranslateInstance(x, y));
+            contentStream.transform(Matrix.getScaleInstance(scale, scale));
 
-	        contentStream.restoreGraphicsState();
-	    }
+            PDFormXObject formXObject = layerUtility.importPageAsForm(sourceDocument, i);
+            contentStream.drawForm(formXObject);
 
+            contentStream.restoreGraphicsState();
 
-	    contentStream.close(); // Close the final content stream
-	    sourceDocument.close();
+            if (addBorder) {
+                // 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();
+            }
+        }
 
-	    ByteArrayOutputStream baos = new ByteArrayOutputStream();
-	    newDocument.save(baos);
-	    newDocument.close();
-
-	    byte[] result = baos.toByteArray();
-	    return WebResponseUtils.bytesToWebResponse(result, file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_layoutChanged.pdf");
-	}
+        contentStream.close(); // Close the final content stream
+        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,206 +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")
-	@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")
-	public ResponseEntity<byte[]> deletePages(
-			@RequestPart(required = true, value = "fileInput") @Parameter(description = "The input PDF file from which pages will be removed") MultipartFile pdfFile,
-			@RequestParam("pagesToDelete") @Parameter(description = "Comma-separated list of pages or page ranges to delete, e.g., '1,3,5-8'") String pagesToDelete)
-			throws IOException {
+    @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")
+    public ResponseEntity<byte[]> deletePages(@ModelAttribute PDFWithPageNums request)
+            throws IOException {
 
-		PDDocument document = PDDocument.load(pdfFile.getBytes());
+        MultipartFile pdfFile = request.getFileInput();
+        String pagesToDelete = request.getPageNumbers();
 
-		// Split the page order string into an array of page numbers or range of numbers
-		String[] pageOrderArr = pagesToDelete.split(",");
+        PDDocument document = PDDocument.load(pdfFile.getBytes());
 
-		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--) {
-			int pageIndex = pagesToRemove.get(i);
-			document.removePage(pageIndex);
-		}
-		return WebResponseUtils.pdfDocToWebResponse(document,
-				pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_removed_pages.pdf");
+        List<Integer> pagesToRemove =
+                GeneralUtils.parsePageList(pageOrderArr, document.getNumberOfPages());
 
-	}
-
-	
-
-	private List<Integer> removeFirst(int totalPages) {
-		if (totalPages <= 1)
-			return new ArrayList<>();
-		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;
+        for (int i = pagesToRemove.size() - 1; i >= 0; i--) {
+            int pageIndex = pagesToRemove.get(i);
+            document.removePage(pageIndex);
+        }
+        return WebResponseUtils.pdfDocToWebResponse(
+                document,
+                pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_removed_pages.pdf");
     }
 
-	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> removeFirst(int totalPages) {
+        if (totalPages <= 1) return new ArrayList<>();
+        List<Integer> newPageOrder = new ArrayList<>();
+        for (int i = 2; i <= totalPages; i++) {
+            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;
-		}
-	}
+    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;
+    }
 
-	@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());
+    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;
+    }
 
-			// 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)));
-			}
+    private List<Integer> reverseOrder(int totalPages) {
+        List<Integer> newPageOrder = new ArrayList<>();
+        for (int i = totalPages; i >= 1; i--) {
+            newPageOrder.add(i - 1);
+        }
+        return newPageOrder;
+    }
 
-			// Remove all the pages from the original document
-			for (int i = document.getNumberOfPages() - 1; i >= 0; i--) {
-				document.removePage(i);
-			}
+    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;
+    }
 
-			// Add the pages in the new order
-			for (PDPage page : newPages) {
-				document.addPage(page);
-			}
+    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;
+    }
 
-			return WebResponseUtils.pdfDocToWebResponse(document,
-					pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_rearranged.pdf");
-		} catch (IOException e) {
-			logger.error("Failed rearranging documents", e);
-			return null;
-		}
-	}
+    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) {
+        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",
-        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(
-    		@ModelAttribute RotatePDFRequest request) throws IOException {
+            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")
+    public ResponseEntity<byte[]> rotatePDF(@ModelAttribute RotatePDFRequest request)
+            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")
-	@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")
-	public ResponseEntity<byte[]> scalePages(@ModelAttribute ScalePagesRequest request) throws IOException {
-	    MultipartFile file = request.getFileInput();
-	    String targetPDRectangle = request.getPageSize();
-	    float scaleFactor = request.getScaleFactor();
+    @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")
+    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<>();
-		// Add A0 - A10
-		sizeMap.put("A0", PDRectangle.A0);
-		sizeMap.put("A1", PDRectangle.A1);
-		sizeMap.put("A2", PDRectangle.A2);
-		sizeMap.put("A3", PDRectangle.A3);
-		sizeMap.put("A4", PDRectangle.A4);
-		sizeMap.put("A5", PDRectangle.A5);
-		sizeMap.put("A6", PDRectangle.A6);
+        Map<String, PDRectangle> sizeMap = new HashMap<>();
+        // Add A0 - A10
+        sizeMap.put("A0", PDRectangle.A0);
+        sizeMap.put("A1", PDRectangle.A1);
+        sizeMap.put("A2", PDRectangle.A2);
+        sizeMap.put("A3", PDRectangle.A3);
+        sizeMap.put("A4", PDRectangle.A4);
+        sizeMap.put("A5", PDRectangle.A5);
+        sizeMap.put("A6", PDRectangle.A6);
 
-		// Add other sizes
-		sizeMap.put("LETTER", PDRectangle.LETTER);
-		sizeMap.put("LEGAL", PDRectangle.LEGAL);
+        // Add other sizes
+        sizeMap.put("LETTER", PDRectangle.LETTER);
+        sizeMap.put("LEGAL", PDRectangle.LEGAL);
 
-		if (!sizeMap.containsKey(targetPDRectangle)) {
-			throw new IllegalArgumentException(
-					"Invalid PDRectangle. It must be one of the following: A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10");
-		}
+        if (!sizeMap.containsKey(targetPDRectangle)) {
+            throw new IllegalArgumentException(
+                    "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 outputDocument = new PDDocument();
+        PDDocument sourceDocument = PDDocument.load(file.getBytes());
+        PDDocument outputDocument = new PDDocument();
 
-	    int totalPages = sourceDocument.getNumberOfPages();
-	    for (int i = 0; i < totalPages; i++) {
-	        PDPage sourcePage = sourceDocument.getPage(i);
-	        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);
+        int totalPages = sourceDocument.getNumberOfPages();
+        for (int i = 0; i < totalPages; i++) {
+            PDPage sourcePage = sourceDocument.getPage(i);
+            PDRectangle sourceSize = sourcePage.getMediaBox();
 
-	        contentStream.restoreGraphicsState();
-	        contentStream.close();
-	    }
+            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));
 
-	    ByteArrayOutputStream baos = new ByteArrayOutputStream();
-	    outputDocument.save(baos);
-	    outputDocument.close();
-	    sourceDocument.close();
-	    
-	    
-		return WebResponseUtils.bytesToWebResponse(baos.toByteArray(),
-				file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_scaled.pdf");
-	}
+            LayerUtility layerUtility = new LayerUtility(outputDocument);
+            PDFormXObject form = layerUtility.importPageAsForm(sourceDocument, i);
+            contentStream.drawForm(form);
 
+            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",
-            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")
-    public ResponseEntity<byte[]> splitPdf(@ModelAttribute PDFWithPageNums request) throws IOException {
-    	MultipartFile file = request.getFileInput();
+    @Operation(
+            summary = "Split a PDF file into separate documents",
+            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")
+    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))
-        	pageNumbers.add(document.getNumberOfPages()- 1);
-        logger.info("Splitting PDF into pages: {}", pageNumbers.stream().map(String::valueOf).collect(Collectors.joining(",")));
+        if (!pageNumbers.contains(document.getNumberOfPages() - 1))
+            pageNumbers.add(document.getNumberOfPages() - 1);
+        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,140 @@
+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);
+
+                        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",
-        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 {
+            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")
+    public ResponseEntity<byte[]> pdfToSinglePage(@ModelAttribute PDFFile request)
+            throws IOException {
 
-    	// Load the source document
-    	PDDocument sourceDocument = PDDocument.load(request.getFileInput().getInputStream());
+        // Load the source document
+        PDDocument sourceDocument = PDDocument.load(request.getFileInput().getInputStream());
 
-    	// Calculate total height and max width
-    	float totalHeight = 0;
-    	float maxWidth = 0;
-    	for (PDPage page : sourceDocument.getPages()) {
-    	    PDRectangle pageSize = page.getMediaBox();
-    	    totalHeight += pageSize.getHeight();
-    	    maxWidth = Math.max(maxWidth, pageSize.getWidth());
-    	}
+        // Calculate total height and max width
+        float totalHeight = 0;
+        float maxWidth = 0;
+        for (PDPage page : sourceDocument.getPages()) {
+            PDRectangle pageSize = page.getMediaBox();
+            totalHeight += pageSize.getHeight();
+            maxWidth = Math.max(maxWidth, pageSize.getWidth());
+        }
 
-    	// Create new document and page with calculated dimensions
-    	PDDocument newDocument = new PDDocument();
-    	PDPage newPage = new PDPage(new PDRectangle(maxWidth, totalHeight));
-    	newDocument.addPage(newPage);
+        // Create new document and page with calculated dimensions
+        PDDocument newDocument = new PDDocument();
+        PDPage newPage = new PDPage(new PDRectangle(maxWidth, totalHeight));
+        newDocument.addPage(newPage);
 
-    	// Initialize the content stream of the new page
-    	PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage);
-    	contentStream.close();
-    	
-    	LayerUtility layerUtility = new LayerUtility(newDocument);
-    	float yOffset = totalHeight;
+        // Initialize the content stream of the new page
+        PDPageContentStream contentStream = new PDPageContentStream(newDocument, newPage);
+        contentStream.close();
 
-    	// For each page, copy its content to the new page at the correct offset
-    	for (PDPage page : sourceDocument.getPages()) {
-    	    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();
-    	}
+        LayerUtility layerUtility = new LayerUtility(newDocument);
+        float yOffset = totalHeight;
 
-    	ByteArrayOutputStream baos = new ByteArrayOutputStream();
-    	newDocument.save(baos);
-    	newDocument.close();
-    	sourceDocument.close();
+        // For each page, copy its content to the new page at the correct offset
+        for (PDPage page : sourceDocument.getPages()) {
+            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();
+        }
 
-    	byte[] result = baos.toByteArray();
-    	return WebResponseUtils.bytesToWebResponse(result, request.getFileInput().getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_singlePage.pdf");
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        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
-    private UserService userService;
-    
+
+    @Autowired private UserService userService;
+
+    @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/register")
-    public String register(@RequestParam String username, @RequestParam String password, Model model) {
-        if(userService.usernameExists(username)) {
+    public String register(
+            @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,
-                                                 @RequestParam String currentPassword, 
-                                                 @RequestParam String newUsername, 
-                                                 @RequestParam String newPassword, 
-                                                 HttpServletRequest request, 
-                                                 HttpServletResponse response,
-                                                 RedirectAttributes redirectAttributes) {
-    	if (principal == null) {
-    	    return new RedirectView("/change-creds?messageType=notAuthenticated");
-    	}
+    public RedirectView changeUsernameAndPassword(
+            Principal principal,
+            @RequestParam String currentPassword,
+            @RequestParam String newUsername,
+            @RequestParam String newPassword,
+            HttpServletRequest request,
+            HttpServletResponse response,
+            RedirectAttributes redirectAttributes) {
+        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()) {
-    	    return new RedirectView("/change-creds?messageType=userNotFound");
-    	}
+        if (userOpt == null || userOpt.isEmpty()) {
+            return new RedirectView("/change-creds?messageType=userNotFound");
+        }
 
-    	User user = userOpt.get();
+        User user = userOpt.get();
 
-    	if (!userService.isPasswordCorrect(user, currentPassword)) {
-    	    return new RedirectView("/change-creds?messageType=incorrectPassword");
-    	}
-
-    	if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
-    	    return new RedirectView("/change-creds?messageType=usernameExists");
-    	}
+        if (!userService.isPasswordCorrect(user, currentPassword)) {
+            return new RedirectView("/change-creds?messageType=incorrectPassword");
+        }
 
+        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,
-                                       @RequestParam String currentPassword, 
-                                       @RequestParam String newUsername, 
-                                       HttpServletRequest request, 
-                                       HttpServletResponse response,
-                                       RedirectAttributes redirectAttributes) {
-    	if (principal == null) {
-    	    return new RedirectView("/account?messageType=notAuthenticated");
-    	}
+    public RedirectView changeUsername(
+            Principal principal,
+            @RequestParam String currentPassword,
+            @RequestParam String newUsername,
+            HttpServletRequest request,
+            HttpServletResponse response,
+            RedirectAttributes redirectAttributes) {
+        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()) {
-    	    return new RedirectView("/account?messageType=userNotFound");
-    	}
+        if (userOpt == null || userOpt.isEmpty()) {
+            return new RedirectView("/account?messageType=userNotFound");
+        }
 
-    	User user = userOpt.get();
+        User user = userOpt.get();
 
-    	if (!userService.isPasswordCorrect(user, currentPassword)) {
-    	    return new RedirectView("/account?messageType=incorrectPassword");
-    	}
+        if (!userService.isPasswordCorrect(user, currentPassword)) {
+            return new RedirectView("/account?messageType=incorrectPassword");
+        }
 
-    	if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
-    	    return new RedirectView("/account?messageType=usernameExists");
-    	}
+        if (!user.getUsername().equals(newUsername) && userService.usernameExists(newUsername)) {
+            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, 
-                                       @RequestParam String currentPassword, 
-                                       @RequestParam String newPassword, 
-                                       HttpServletRequest request, 
-                                       HttpServletResponse response,
-                                       RedirectAttributes redirectAttributes) {
-    	if (principal == null) {
-    	    return new RedirectView("/account?messageType=notAuthenticated");
-    	}
+    public RedirectView changePassword(
+            Principal principal,
+            @RequestParam String currentPassword,
+            @RequestParam String newPassword,
+            HttpServletRequest request,
+            HttpServletResponse response,
+            RedirectAttributes redirectAttributes) {
+        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()) {
-    	    return new RedirectView("/account?messageType=userNotFound");
-    	}
+        if (userOpt == null || userOpt.isEmpty()) {
+            return new RedirectView("/account?messageType=userNotFound");
+        }
 
-    	User user = userOpt.get();
+        User user = userOpt.get();
 
-    	if (!userService.isPasswordCorrect(user, currentPassword)) {
-    	    return new RedirectView("/account?messageType=incorrectPassword");
-    	}
+        if (!userService.isPasswordCorrect(user, currentPassword)) {
+            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) {
-	    Map<String, String[]> paramMap = request.getParameterMap();
-	    Map<String, String> updates = new HashMap<>();
+    public String updateUserSettings(HttpServletRequest request, Principal principal) {
+        Map<String, String[]> paramMap = request.getParameterMap();
+        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()) {
-	        updates.put(entry.getKey(), entry.getValue()[0]);
-	    }
+        for (Map.Entry<String, String[]> entry : paramMap.entrySet()) {
+            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
-	    userService.updateUserSettings(principal.getName(), updates);
+        // Assuming you have a method in userService to update the settings for a user
+        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, 
-    		@RequestParam(name = "forceChange", required = false, defaultValue = "false") boolean forceChange) {
-    	
-    	if(userService.usernameExists(username)) {
-    		return new RedirectView("/addUsers?messageType=usernameExists");
-    	}
+    public RedirectView saveUser(
+            @RequestParam String username,
+            @RequestParam String password,
+            @RequestParam String role,
+            @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) {
-    	
-    	// Get the currently authenticated username
+    public String deleteUser(@PathVariable String username, Authentication authentication) {
+
+        // 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/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

@@ -9,6 +9,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 +19,30 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @RequestMapping("/api/v1/convert")
 public class ConvertHtmlToPDF {
 
+    @PostMapping(consumes = "multipart/form-data", value = "/html/pdf")
+    @Operation(
+            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.")
+    public ResponseEntity<byte[]> HtmlToPdf(@ModelAttribute GeneralFile request) throws Exception {
+        MultipartFile fileInput = request.getFileInput();
 
-	 @PostMapping(consumes = "multipart/form-data", value = "/html/pdf")
-	    @Operation(
-	        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."
-	    )
-	    public ResponseEntity<byte[]> HtmlToPdf(
-	    		@ModelAttribute GeneralFile request) 
-	    		        throws Exception {
-	    			MultipartFile fileInput = request.getFileInput();
+        if (fileInput == null) {
+            throw new IllegalArgumentException(
+                    "Please provide an HTML or ZIP file for conversion.");
+        }
 
-	        if (fileInput == null) {
-	            throw new IllegalArgumentException("Please provide an HTML or ZIP file for conversion.");
-	        }
+        String originalFilename = fileInput.getOriginalFilename();
+        if (originalFilename == null
+                || (!originalFilename.endsWith(".html") && !originalFilename.endsWith(".zip"))) {
+            throw new IllegalArgumentException("File must be either .html or .zip format.");
+        }
+        byte[] pdfBytes = FileToPdf.convertHtmlToPdf(fileInput.getBytes(), originalFilename);
 
-	        String originalFilename = fileInput.getOriginalFilename();
-	        if (originalFilename == null || (!originalFilename.endsWith(".html") && !originalFilename.endsWith(".zip"))) {
-	            throw new IllegalArgumentException("File must be either .html or .zip format.");
-	        }byte[] pdfBytes = FileToPdf.convertHtmlToPdf( fileInput.getBytes(), originalFilename);
-	        
-	        String outputFilename = originalFilename.replaceFirst("[.][^.]+$", "") + ".pdf";  // Remove file extension and append .pdf
-	        
-	        return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
-	    }
-
-	   
-
-    
-   
-	    
+        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)",
-            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 {
+    @Operation(
+            summary = "Convert PDF to image(s)",
+            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")
-                    .contentType(MediaType.APPLICATION_OCTET_STREAM).contentLength(resource.contentLength()).body(resource);
+                    .header(
+                            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",
-            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 {
+    @Operation(
+            summary = "Convert images to a PDF file",
+            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();
-        boolean stretchToFit = request.isStretchToFit();
+        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, stretchToFit, autoRotate, colorType);
-        return WebResponseUtils.bytesToWebResponse(bytes, file[0].getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_converted.pdf");
+        byte[] bytes = PdfUtils.imageToPdf(file, fitOption, autoRotate, colorType);
+        return WebResponseUtils.bytesToWebResponse(
+                bytes,
+                file[0].getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_converted.pdf");
     }
 
     private String getMediaType(String imageFormat) {
-        if (imageFormat.equalsIgnoreCase("PNG"))
-            return "image/png";
-        else if (imageFormat.equalsIgnoreCase("JPEG") || imageFormat.equalsIgnoreCase("JPG"))
-            return "image/jpeg";
-        else if (imageFormat.equalsIgnoreCase("GIF"))
-            return "image/gif";
-        else
-            return "application/octet-stream";
+        String mimeType = URLConnection.guessContentTypeFromName("." + imageFormat);
+        return mimeType.equals("null") ? "application/octet-stream" : mimeType;
     }
-
-
 }

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

@@ -12,6 +12,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 +21,16 @@ 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")
+
+    @PostMapping(consumes = "multipart/form-data", value = "/markdown/pdf")
     @Operation(
-        summary = "Convert a Markdown file to PDF",
-        description = "This endpoint takes a Markdown file input, converts it to HTML, and then to PDF format."
-    )
-    public ResponseEntity<byte[]> markdownToPdf(
-    		@ModelAttribute GeneralFile request) 
-    		        throws Exception {
-    			MultipartFile fileInput = request.getFileInput();
-        
+            summary = "Convert a Markdown file to PDF",
+            description =
+                    "This endpoint takes a Markdown file input, converts it to HTML, and then to PDF format.")
+    public ResponseEntity<byte[]> markdownToPdf(@ModelAttribute GeneralFile request)
+            throws Exception {
+        MultipartFile fileInput = request.getFileInput();
+
         if (fileInput == null) {
             throw new IllegalArgumentException("Please provide a Markdown file for conversion.");
         }
@@ -45,10 +45,12 @@ 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");
+
+        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()));
-        ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.LIBRE_OFFICE).runCommandWithOutputHandling(command);
+        List<String> 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",
-        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) 
-	        throws Exception {
-		MultipartFile inputFile = request.getFileInput();
+            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")
+    public ResponseEntity<byte[]> processFileToPDF(@ModelAttribute GeneralFile request)
+            throws Exception {
+        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/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")
-	@Operation(summary = "Convert PDF to HTML", description = "This endpoint converts a PDF file to HTML format. Input:PDF Output:HTML Type:SISO")
-	public ResponseEntity<byte[]> processPdfToHTML(@ModelAttribute PDFFile request) 
-	        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/html")
+    @Operation(
+            summary = "Convert PDF to HTML",
+            description =
+                    "This endpoint converts a PDF file to HTML format. Input:PDF Output:HTML Type:SISO")
+    public ResponseEntity<byte[]> processPdfToHTML(@ModelAttribute PDFFile request)
+            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")
-	@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")
-	public ResponseEntity<byte[]> processPdfToPresentation(@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/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")
+    public ResponseEntity<byte[]> processPdfToPresentation(
+            @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")
-	@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")
-	public ResponseEntity<byte[]> processPdfToRTForTXT(@ModelAttribute PdfToTextOrRTFRequest request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    String outputFormat = request.getOutputFormat();
+    @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")
+    public ResponseEntity<byte[]> processPdfToRTForTXT(
+            @ModelAttribute PdfToTextOrRTFRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String outputFormat = request.getOutputFormat();
 
-		PDFToFile pdfToFile = new PDFToFile();
-		return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "writer_pdf_import");
-	}
+        PDFToFile pdfToFile = new PDFToFile();
+        return pdfToFile.processPdfToOfficeFormat(inputFile, outputFormat, "writer_pdf_import");
+    }
 
-	@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")
-	public ResponseEntity<byte[]> processPdfToWord(@ModelAttribute PdfToWordRequest request) 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/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")
+    public ResponseEntity<byte[]> processPdfToWord(@ModelAttribute PdfToWordRequest request)
+            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")
-	@Operation(summary = "Convert PDF to XML", description = "This endpoint converts a PDF file to an XML file. Input:PDF Output:XML Type:SISO")
-	public ResponseEntity<byte[]> processPdfToXML(@ModelAttribute PDFFile request) 
-	        throws Exception {
-		MultipartFile inputFile = request.getFileInput();
-
-		PDFToFile pdfToFile = new PDFToFile();
-		return pdfToFile.processPdfToOfficeFormat(inputFile, "xml", "writer_pdf_import");
-	}
+    @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")
+    public ResponseEntity<byte[]> processPdfToXML(@ModelAttribute PDFFile request)
+            throws Exception {
+        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")
-	@Operation(
-	    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"
-	)
-	public ResponseEntity<byte[]> pdfToPdfA(@ModelAttribute PDFFile request) 
-	        throws Exception {
-		MultipartFile inputFile = request.getFileInput();
+    @PostMapping(consumes = "multipart/form-data", value = "/pdf/pdfa")
+    @Operation(
+            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")
+    public ResponseEntity<byte[]> pdfToPdfA(@ModelAttribute PDFFile request) throws Exception {
+        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

@@ -14,6 +14,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.converters.UrlToPdfRequest;
 import stirling.software.SPDF.utils.GeneralUtils;
 import stirling.software.SPDF.utils.ProcessExecutor;
@@ -25,52 +26,52 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @RequestMapping("/api/v1/convert")
 public class ConvertWebsiteToPDF {
 
-	@PostMapping(consumes = "multipart/form-data", value = "/url/pdf")
-	@Operation(
-	    summary = "Convert a URL to a PDF",
-	    description = "This endpoint fetches content from a URL and converts it to a PDF format."
-	)
-	public ResponseEntity<byte[]> urlToPdf(@ModelAttribute UrlToPdfRequest request) throws IOException, InterruptedException {
-	    String URL = request.getUrlInput();
+    @PostMapping(consumes = "multipart/form-data", value = "/url/pdf")
+    @Operation(
+            summary = "Convert a URL to a PDF",
+            description =
+                    "This endpoint fetches content from a URL and converts it to a PDF format. Input:N/A Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> urlToPdf(@ModelAttribute UrlToPdfRequest request)
+            throws IOException, InterruptedException {
+        String URL = request.getUrlInput();
 
-	    // Validate the URL format
-	    if(!URL.matches("^https?://.*") || !GeneralUtils.isValidURL(URL)) {
-	        throw new IllegalArgumentException("Invalid URL format provided.");
-	    }
-	    Path tempOutputFile = null;
-	    byte[] pdfBytes;
-	    try {
-		    // Prepare the output file path
-		    tempOutputFile = Files.createTempFile("output_", ".pdf");
-	
-		    // Prepare the OCRmyPDF command
-		    List<String> command = new ArrayList<>();
-		    command.add("weasyprint");
-		    command.add(URL);
-		    command.add(tempOutputFile.toString());
-	
-		    ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.WEASYPRINT).runCommandWithOutputHandling(command);
-	
-		    // Read the optimized PDF file
-		    pdfBytes = Files.readAllBytes(tempOutputFile);
-	    }
-	    finally {
-		    // Clean up the temporary files
-		    Files.delete(tempOutputFile);
-	    }
-	    // Convert URL to a safe filename
-	    String outputFilename = convertURLToFileName(URL);
-	    
-	    return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
-	}
+        // Validate the URL format
+        if (!URL.matches("^https?://.*") || !GeneralUtils.isValidURL(URL)) {
+            throw new IllegalArgumentException("Invalid URL format provided.");
+        }
+        Path tempOutputFile = null;
+        byte[] pdfBytes;
+        try {
+            // Prepare the output file path
+            tempOutputFile = Files.createTempFile("output_", ".pdf");
 
-	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";
-	}
+            // Prepare the OCRmyPDF command
+            List<String> command = new ArrayList<>();
+            command.add("weasyprint");
+            command.add(URL);
+            command.add(tempOutputFile.toString());
 
+            ProcessExecutorResult returnCode =
+                    ProcessExecutor.getInstance(ProcessExecutor.Processes.WEASYPRINT)
+                            .runCommandWithOutputHandling(command);
 
+            // Read the optimized PDF file
+            pdfBytes = Files.readAllBytes(tempOutputFile);
+        } finally {
+            // Clean up the temporary files
+            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

@@ -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.PDFComparisonAndCount;
 import stirling.software.SPDF.model.api.PDFWithPageNums;
 import stirling.software.SPDF.model.api.filter.ContainsTextRequest;
@@ -28,169 +29,182 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @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")
-	public ResponseEntity<byte[]> containsText(@ModelAttribute ContainsTextRequest request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    String text = request.getText();
-	    String pageNumber = request.getPageNumbers();
-	    
-		PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
-		if (PdfUtils.hasText(pdfDocument, pageNumber, text))
-			return WebResponseUtils.pdfDocToWebResponse(pdfDocument, inputFile.getOriginalFilename());
-		return null;
-	}
+    @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")
+    public ResponseEntity<byte[]> containsText(@ModelAttribute ContainsTextRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String text = request.getText();
+        String pageNumber = request.getPageNumbers();
 
-	// TODO
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-contains-image")
-	@Operation(summary = "Checks if a PDF contains an image", description = "Input:PDF Output:Boolean Type:SISO")
-	public ResponseEntity<byte[]> containsImage(@ModelAttribute PDFWithPageNums request)
-			throws IOException, InterruptedException {
-		MultipartFile inputFile = request.getFileInput();
-	    String pageNumber = request.getPageNumbers();
-	    
-		PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
-		if (PdfUtils.hasImages(pdfDocument, pageNumber))
-			return WebResponseUtils.pdfDocToWebResponse(pdfDocument, inputFile.getOriginalFilename());
-		return null;
-	}
+        PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
+        if (PdfUtils.hasText(pdfDocument, pageNumber, text))
+            return WebResponseUtils.pdfDocToWebResponse(
+                    pdfDocument, inputFile.getOriginalFilename());
+        return null;
+    }
 
-	@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")
-	public ResponseEntity<byte[]> pageCount(@ModelAttribute PDFComparisonAndCount request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    String pageCount = request.getPageCount();
-	    String comparator = request.getComparator();
-		// Load the PDF
-		PDDocument document = PDDocument.load(inputFile.getInputStream());
-		int actualPageCount = document.getNumberOfPages();
+    // TODO
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-contains-image")
+    @Operation(
+            summary = "Checks if a PDF contains an image",
+            description = "Input:PDF Output:Boolean Type:SISO")
+    public ResponseEntity<byte[]> containsImage(@ModelAttribute PDFWithPageNums request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String pageNumber = request.getPageNumbers();
 
-		boolean valid = false;
-		// Perform the comparison
-		switch (comparator) {
-		case "Greater":
-			valid = actualPageCount > Integer.parseInt(pageCount);
-			break;
-		case "Equal":
-			valid = actualPageCount == Integer.parseInt(pageCount);
-			break;
-		case "Less":
-			valid = actualPageCount < Integer.parseInt(pageCount);
-			break;
-		default:
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
-		}
+        PDDocument pdfDocument = PDDocument.load(inputFile.getInputStream());
+        if (PdfUtils.hasImages(pdfDocument, pageNumber))
+            return WebResponseUtils.pdfDocToWebResponse(
+                    pdfDocument, inputFile.getOriginalFilename());
+        return null;
+    }
 
-		if (valid)
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-		return null;
-	}
+    @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")
+    public ResponseEntity<byte[]> pageCount(@ModelAttribute PDFComparisonAndCount request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String pageCount = request.getPageCount();
+        String comparator = request.getComparator();
+        // Load the PDF
+        PDDocument document = PDDocument.load(inputFile.getInputStream());
+        int actualPageCount = document.getNumberOfPages();
 
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-page-size")
-	@Operation(summary = "Checks if a PDF is of a certain size", description = "Input:PDF Output:Boolean Type:SISO")
-	public ResponseEntity<byte[]> pageSize(@ModelAttribute PageSizeRequest request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    String standardPageSize = request.getStandardPageSize();
-	    String comparator = request.getComparator();
+        boolean valid = false;
+        // Perform the comparison
+        switch (comparator) {
+            case "Greater":
+                valid = actualPageCount > Integer.parseInt(pageCount);
+                break;
+            case "Equal":
+                valid = actualPageCount == Integer.parseInt(pageCount);
+                break;
+            case "Less":
+                valid = actualPageCount < Integer.parseInt(pageCount);
+                break;
+            default:
+                throw new IllegalArgumentException("Invalid comparator: " + comparator);
+        }
 
-		// Load the PDF
-		PDDocument document = PDDocument.load(inputFile.getInputStream());
+        if (valid) return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+        return null;
+    }
 
-		PDPage firstPage = document.getPage(0);
-		PDRectangle actualPageSize = firstPage.getMediaBox();
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-page-size")
+    @Operation(
+            summary = "Checks if a PDF is of a certain size",
+            description = "Input:PDF Output:Boolean Type:SISO")
+    public ResponseEntity<byte[]> pageSize(@ModelAttribute PageSizeRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String standardPageSize = request.getStandardPageSize();
+        String comparator = request.getComparator();
 
-		// Calculate the area of the actual page size
-		float actualArea = actualPageSize.getWidth() * actualPageSize.getHeight();
+        // Load the PDF
+        PDDocument document = PDDocument.load(inputFile.getInputStream());
 
-		// Get the standard size and calculate its area
-		PDRectangle standardSize = PdfUtils.textToPageSize(standardPageSize);
-		float standardArea = standardSize.getWidth() * standardSize.getHeight();
+        PDPage firstPage = document.getPage(0);
+        PDRectangle actualPageSize = firstPage.getMediaBox();
 
-		boolean valid = false;
-		// Perform the comparison
-		switch (comparator) {
-		case "Greater":
-			valid = actualArea > standardArea;
-			break;
-		case "Equal":
-			valid = actualArea == standardArea;
-			break;
-		case "Less":
-			valid = actualArea < standardArea;
-			break;
-		default:
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
-		}
+        // Calculate the area of the actual page size
+        float actualArea = actualPageSize.getWidth() * actualPageSize.getHeight();
 
-		if (valid)
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-		return null;
-	}
+        // Get the standard size and calculate its area
+        PDRectangle standardSize = PdfUtils.textToPageSize(standardPageSize);
+        float standardArea = standardSize.getWidth() * standardSize.getHeight();
 
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-file-size")
-	@Operation(summary = "Checks if a PDF is a set file size", description = "Input:PDF Output:Boolean Type:SISO")
-	public ResponseEntity<byte[]> fileSize(@ModelAttribute FileSizeRequest request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    String fileSize = request.getFileSize();
-	    String comparator = request.getComparator();
+        boolean valid = false;
+        // Perform the comparison
+        switch (comparator) {
+            case "Greater":
+                valid = actualArea > standardArea;
+                break;
+            case "Equal":
+                valid = actualArea == standardArea;
+                break;
+            case "Less":
+                valid = actualArea < standardArea;
+                break;
+            default:
+                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) {
-		case "Greater":
-			valid = actualFileSize > Long.parseLong(fileSize);
-			break;
-		case "Equal":
-			valid = actualFileSize == Long.parseLong(fileSize);
-			break;
-		case "Less":
-			valid = actualFileSize < Long.parseLong(fileSize);
-			break;
-		default:
-			throw new IllegalArgumentException("Invalid comparator: " + comparator);
-		}
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-file-size")
+    @Operation(
+            summary = "Checks if a PDF is a set file size",
+            description = "Input:PDF Output:Boolean Type:SISO")
+    public ResponseEntity<byte[]> fileSize(@ModelAttribute FileSizeRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        String fileSize = request.getFileSize();
+        String comparator = request.getComparator();
 
-		if (valid)
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-		return null;
-	}
+        // Get the file size
+        long actualFileSize = inputFile.getSize();
 
-	@PostMapping(consumes = "multipart/form-data", value = "/filter-page-rotation")
-	@Operation(summary = "Checks if a PDF is of a certain rotation", description = "Input:PDF Output:Boolean Type:SISO")
-	public ResponseEntity<byte[]> pageRotation(@ModelAttribute PageRotationRequest request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    int rotation = request.getRotation();
-	    String comparator = request.getComparator();
+        boolean valid = false;
+        // Perform the comparison
+        switch (comparator) {
+            case "Greater":
+                valid = actualFileSize > Long.parseLong(fileSize);
+                break;
+            case "Equal":
+                valid = actualFileSize == Long.parseLong(fileSize);
+                break;
+            case "Less":
+                valid = actualFileSize < Long.parseLong(fileSize);
+                break;
+            default:
+                throw new IllegalArgumentException("Invalid comparator: " + comparator);
+        }
 
-		// Load the PDF
-		PDDocument document = PDDocument.load(inputFile.getInputStream());
+        if (valid) return WebResponseUtils.multiPartFileToWebResponse(inputFile);
+        return null;
+    }
 
-		// Get the rotation of the first page
-		PDPage firstPage = document.getPage(0);
-		int actualRotation = firstPage.getRotation();
-		boolean valid = false;
-		// 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);
-		}
+    @PostMapping(consumes = "multipart/form-data", value = "/filter-page-rotation")
+    @Operation(
+            summary = "Checks if a PDF is of a certain rotation",
+            description = "Input:PDF Output:Boolean Type:SISO")
+    public ResponseEntity<byte[]> pageRotation(@ModelAttribute PageRotationRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        int rotation = request.getRotation();
+        String comparator = request.getComparator();
 
-		if (valid)
-			return WebResponseUtils.multiPartFileToWebResponse(inputFile);
-		return null;
+        // Load the PDF
+        PDDocument document = PDDocument.load(inputFile.getInputStream());
 
-	}
+        // Get the rotation of the first page
+        PDPage firstPage = document.getPage(0);
+        int actualRotation = firstPage.getRotation();
+        boolean valid = false;
+        // 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")
-    public ResponseEntity<byte[]> extractHeader(@ModelAttribute ExtractHeaderRequest request) throws Exception {
+    @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")
+    public ResponseEntity<byte[]> extractHeader(@ModelAttribute ExtractHeaderRequest request)
+            throws Exception {
         MultipartFile file = request.getFileInput();
         Boolean useFirstTextAsFallback = request.isUseFirstTextAsFallback();
 
-    	        PDDocument document = PDDocument.load(file.getInputStream());
-    	        PDFTextStripper reader = new PDFTextStripper() {
-    	            class LineInfo {
-    	                String text;
-    	                float fontSize;
+        PDDocument document = PDDocument.load(file.getInputStream());
+        PDFTextStripper reader =
+                new PDFTextStripper() {
+                    class LineInfo {
+                        String text;
+                        float fontSize;
 
-    	                LineInfo(String text, float fontSize) {
-    	                    this.text = text;
-    	                    this.fontSize = fontSize;
-    	                }
-    	            }
+                        LineInfo(String text, float fontSize) {
+                            this.text = text;
+                            this.fontSize = fontSize;
+                        }
+                    }
 
-    	            List<LineInfo> lineInfos = new ArrayList<>();
-    	            StringBuilder lineBuilder = new StringBuilder();
-    	            float lastY = -1;
-    	            float maxFontSizeInLine = 0.0f;
-    	            int lineCount = 0;
+                    List<LineInfo> lineInfos = new ArrayList<>();
+                    StringBuilder lineBuilder = new StringBuilder();
+                    float lastY = -1;
+                    float maxFontSizeInLine = 0.0f;
+                    int lineCount = 0;
 
-    	            @Override
-    	            protected void processTextPosition(TextPosition text) {
-    	                if (lastY != text.getY() && lineCount < LINE_LIMIT) {
-    	                    processLine();
-    	                    lineBuilder = new StringBuilder(text.getUnicode());
-    	                    maxFontSizeInLine = text.getFontSizeInPt();
-    	                    lastY = text.getY();
-    	                    lineCount++;
-    	                } else if (lineCount < LINE_LIMIT) {
-    	                    lineBuilder.append(text.getUnicode());
-    	                    if (text.getFontSizeInPt() > maxFontSizeInLine) {
-    	                        maxFontSizeInLine = text.getFontSizeInPt();
-    	                    }
-    	                }
-    	            }
+                    @Override
+                    protected void processTextPosition(TextPosition text) {
+                        if (lastY != text.getY() && lineCount < LINE_LIMIT) {
+                            processLine();
+                            lineBuilder = new StringBuilder(text.getUnicode());
+                            maxFontSizeInLine = text.getFontSizeInPt();
+                            lastY = text.getY();
+                            lineCount++;
+                        } else if (lineCount < LINE_LIMIT) {
+                            lineBuilder.append(text.getUnicode());
+                            if (text.getFontSizeInPt() > maxFontSizeInLine) {
+                                maxFontSizeInLine = text.getFontSizeInPt();
+                            }
+                        }
+                    }
 
-    	            private void processLine() {
-    	                if (lineBuilder.length() > 0 && lineCount < LINE_LIMIT) {
-    	                    lineInfos.add(new LineInfo(lineBuilder.toString(), maxFontSizeInLine));
-    	                }
-    	            }
+                    private void processLine() {
+                        if (lineBuilder.length() > 0 && lineCount < LINE_LIMIT) {
+                            lineInfos.add(new LineInfo(lineBuilder.toString(), maxFontSizeInLine));
+                        }
+                    }
 
-    	            @Override
-    	            public String getText(PDDocument doc) throws IOException {
-    	                this.lineInfos.clear();
-    	                this.lineBuilder = new StringBuilder();
-    	                this.lastY = -1;
-    	                this.maxFontSizeInLine = 0.0f;
-    	                this.lineCount = 0;
-    	                super.getText(doc);
-    	                processLine(); // Process the last line
+                    @Override
+                    public String getText(PDDocument doc) throws IOException {
+                        this.lineInfos.clear();
+                        this.lineBuilder = new StringBuilder();
+                        this.lastY = -1;
+                        this.maxFontSizeInLine = 0.0f;
+                        this.lineCount = 0;
+                        super.getText(doc);
+                        processLine(); // Process the last line
 
-    	                // Merge lines with same font size
-    	                List<LineInfo> mergedLineInfos = new ArrayList<>();
-    	                for (int i = 0; i < lineInfos.size(); i++) {
-    	                    String mergedText = lineInfos.get(i).text;
-    	                    float fontSize = lineInfos.get(i).fontSize;
-    	                    while (i + 1 < lineInfos.size() && lineInfos.get(i + 1).fontSize == fontSize) {
-    	                        mergedText += " " + lineInfos.get(i + 1).text;
-    	                        i++;
-    	                    }
-    	                    mergedLineInfos.add(new LineInfo(mergedText, fontSize));
-    	                }
+                        // Merge lines with same font size
+                        List<LineInfo> mergedLineInfos = new ArrayList<>();
+                        for (int i = 0; i < lineInfos.size(); i++) {
+                            String mergedText = lineInfos.get(i).text;
+                            float fontSize = lineInfos.get(i).fontSize;
+                            while (i + 1 < lineInfos.size()
+                                    && lineInfos.get(i + 1).fontSize == fontSize) {
+                                mergedText += " " + lineInfos.get(i + 1).text;
+                                i++;
+                            }
+                            mergedLineInfos.add(new LineInfo(mergedText, fontSize));
+                        }
 
-    	                // Sort lines by font size in descending order and get the first one
-    	                mergedLineInfos.sort(Comparator.comparing((LineInfo li) -> li.fontSize).reversed());
-    	                String title = mergedLineInfos.isEmpty() ? null : mergedLineInfos.get(0).text;
+                        // Sort lines by font size in descending order and get the first one
+                        mergedLineInfos.sort(
+                                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");
-        	return WebResponseUtils.pdfDocToWebResponse(document, file.getOriginalFilename());
+            logger.info("File has no good title to be found");
+            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;
 
@@ -43,8 +45,12 @@ public class AutoSplitPdfController {
     private static final String QR_CONTENT = "https://github.com/Frooodle/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")
-    public ResponseEntity<byte[]> autoSplitPdf(@ModelAttribute AutoSplitPdfRequest request) throws IOException {
+    @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-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")
-	@Operation(
-	    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"
-	)
-	public ResponseEntity<byte[]> removeBlankPages(@ModelAttribute RemoveBlankPagesRequest request) throws IOException, InterruptedException {
-	    MultipartFile inputFile = request.getFileInput();
-	    int threshold = request.getThreshold();
-	    float whitePercent = request.getWhitePercent();
-		
-    	PDDocument document = null;
+    @PostMapping(consumes = "multipart/form-data", value = "/remove-blanks")
+    @Operation(
+            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")
+    public ResponseEntity<byte[]> removeBlankPages(@ModelAttribute RemoveBlankPagesRequest request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
+        int threshold = request.getThreshold();
+        float whitePercent = request.getWhitePercent();
+
+        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)
-                document.close();
+            if (document != null) 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")
-    public ResponseEntity<byte[]> optimizePdf(@ModelAttribute OptimizePdfRequest request) throws Exception {
+    @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")
+    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
-        if(autoMode) {
+        // Determine initial optimization level based on expected size reduction, only if in
+        // 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:
-                command.add("-dPDFSETTINGS=/prepress");
-                break;
-            case 2:
-                command.add("-dPDFSETTINGS=/printer");
-                break;    
-            case 3:
-                command.add("-dPDFSETTINGS=/ebook");
-                break;
-            case 4:
-                command.add("-dPDFSETTINGS=/screen");
-                break;
-            default:
-                command.add("-dPDFSETTINGS=/default");
+                case 1:
+                    command.add("-dPDFSETTINGS=/prepress");
+                    break;
+                case 2:
+                    command.add("-dPDFSETTINGS=/printer");
+                    break;
+                case 3:
+                    command.add("-dPDFSETTINGS=/ebook");
+                    break;
+                case 4:
+                    command.add("-dPDFSETTINGS=/screen");
+                    break;
+                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 newHeight = (int)(bufferedImage.getHeight() * scaleFactor);
+                                    int newWidth = (int) (bufferedImage.getWidth() * 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);
-                                    scaledBufferedImage.getGraphics().drawImage(scaledImage, 0, 0, null);
+                                    BufferedImage scaledBufferedImage =
+                                            new BufferedImage(
+                                                    newWidth,
+                                                    newHeight,
+                                                    BufferedImage.TYPE_INT_RGB);
+                                    scaledBufferedImage
+                                            .getGraphics()
+                                            .drawImage(scaledImage, 0, 0, null);
 
                                     // Compress the scaled image
-                                    ByteArrayOutputStream compressedImageStream = new ByteArrayOutputStream();
-                                    ImageIO.write(scaledBufferedImage, "jpeg", compressedImageStream);
+                                    ByteArrayOutputStream 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);
-                                    PDImageXObject compressedImage = PDImageXObject.createFromByteArray(doc, imageBytes, image.getCOSObject().toString());
+                                    ByteArrayInputStream bais =
+                                            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
-                            
-                            System.out.println("Current file size: " + FileUtils.byteCountToDisplaySize(currentSize));
+                            // Log the current file size and scaleFactor
+
+                            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){
-                                throw new RuntimeException("Could not reach the desired size without excessively degrading image quality, lowest size recommended is " + FileUtils.byteCountToDisplaySize(currentSize) + ", " + currentSize + " bytes");
+                            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");
                             }
                             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",
-            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")
+    @Operation(
+            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(
-    	            description = "Form data containing file and extraction parameters",
-    	            required = true,
-    	            content = @Content(
-    	                mediaType = "multipart/form-data",
-    	                schema = @Schema(implementation = ExtractImageScansRequest.class) // This should represent your form's structure
-    	            )
-    	        )
-    	        ExtractImageScansRequest form) throws IOException, InterruptedException {
+            @RequestBody(
+                            description = "Form data containing file and extraction parameters",
+                            required = true,
+                            content =
+                                    @Content(
+                                            mediaType = "multipart/form-data",
+                                            schema =
+                                                    @Schema(
+                                                            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(
-                    "python3", 
-                    "./scripts/split_photos.py", 
-                    images.get(i), 
-                    tempDir.toString(), 
-                    "--angle_threshold", String.valueOf(form.getAngleThreshold()),
-                    "--tolerance", String.valueOf(form.getTolerance()),
-                    "--min_area", String.valueOf(form.getMinArea()),
-                    "--min_contour_area", String.valueOf(form.getMinContourArea()),
-                    "--border_size", String.valueOf(form.getBorderSize())
-                ));
-
+            List<String> command =
+                    new ArrayList<>(
+                            Arrays.asList(
+                                    "python3",
+                                    "./scripts/split_photos.py",
+                                    images.get(i),
+                                    tempDir.toString(),
+                                    "--angle_threshold",
+                                    String.valueOf(form.getAngleThreshold()),
+                                    "--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);
         }
-
     }
-
 }

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

@@ -6,6 +6,8 @@ import java.awt.image.BufferedImage;
 import java.awt.image.RenderedImage;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.util.HashSet;
+import java.util.Set;
 import java.util.zip.Deflater;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
@@ -28,8 +30,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.PDFWithImageFormatRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/misc")
 @Tag(name = "Misc", description = "Miscellaneous APIs")
@@ -38,13 +42,17 @@ public class ExtractImagesController {
     private static final Logger logger = LoggerFactory.getLogger(ExtractImagesController.class);
 
     @PostMapping(consumes = "multipart/form-data", value = "/extract-images")
-    @Operation(summary = "Extract images from a PDF file",
-            description = "This endpoint extracts images from a given PDF file and returns them in a zip file. Users can specify the output image format. Input:PDF Output:IMAGE/ZIP Type:SIMO")
-    public ResponseEntity<byte[]> extractImages(@ModelAttribute PDFWithImageFormatRequest request) throws IOException {
+    @Operation(
+            summary = "Extract images from a PDF file",
+            description =
+                    "This endpoint extracts images from a given PDF file and returns them in a zip file. Users can specify the output image format. Input:PDF Output:IMAGE/ZIP Type:SIMO")
+    public ResponseEntity<byte[]> extractImages(@ModelAttribute PDFWithImageFormatRequest request)
+            throws IOException {
         MultipartFile file = request.getFileInput();
         String format = request.getFormat();
 
-        System.out.println(System.currentTimeMillis() + "file=" + file.getName() + ", format=" + format);
+        System.out.println(
+                System.currentTimeMillis() + "file=" + file.getName() + ", format=" + format);
         PDDocument document = PDDocument.load(file.getBytes());
 
         // Create ByteArrayOutputStream to write zip file to byte array
@@ -58,7 +66,8 @@ public class ExtractImagesController {
 
         int imageIndex = 1;
         String filename = file.getOriginalFilename().replaceFirst("[.][^.]+$", "");
-        int pageNum = 1;
+        int pageNum = 0;
+        Set<Integer> processedImages = new HashSet<>();
         // Iterate over each page
         for (PDPage page : document.getPages()) {
             ++pageNum;
@@ -66,20 +75,38 @@ public class ExtractImagesController {
             for (COSName name : page.getResources().getXObjectNames()) {
                 if (page.getResources().isImageXObject(name)) {
                     PDImageXObject image = (PDImageXObject) page.getResources().getXObject(name);
+                    int imageHash = image.hashCode();
+                    if (processedImages.contains(imageHash)) {
+                        continue; // Skip already processed images
+                    }
+                    processedImages.add(imageHash);
 
                     // Convert image to desired format
                     RenderedImage renderedImage = image.getImage();
                     BufferedImage bufferedImage = null;
                     if (format.equalsIgnoreCase("png")) {
-                        bufferedImage = new BufferedImage(renderedImage.getWidth(), renderedImage.getHeight(), BufferedImage.TYPE_INT_ARGB);
+                        bufferedImage =
+                                new BufferedImage(
+                                        renderedImage.getWidth(),
+                                        renderedImage.getHeight(),
+                                        BufferedImage.TYPE_INT_ARGB);
                     } else if (format.equalsIgnoreCase("jpeg") || format.equalsIgnoreCase("jpg")) {
-                        bufferedImage = new BufferedImage(renderedImage.getWidth(), renderedImage.getHeight(), BufferedImage.TYPE_INT_RGB);
+                        bufferedImage =
+                                new BufferedImage(
+                                        renderedImage.getWidth(),
+                                        renderedImage.getHeight(),
+                                        BufferedImage.TYPE_INT_RGB);
                     } else if (format.equalsIgnoreCase("gif")) {
-                        bufferedImage = new BufferedImage(renderedImage.getWidth(), renderedImage.getHeight(), BufferedImage.TYPE_BYTE_INDEXED);
+                        bufferedImage =
+                                new BufferedImage(
+                                        renderedImage.getWidth(),
+                                        renderedImage.getHeight(),
+                                        BufferedImage.TYPE_BYTE_INDEXED);
                     }
 
                     // Write image to zip file
-                    String imageName = filename + "_" + imageIndex + " (Page " + pageNum + ")." + format;
+                    String imageName =
+                            filename + "_" + imageIndex + " (Page " + pageNum + ")." + format;
                     ZipEntry zipEntry = new ZipEntry(imageName);
                     zos.putNextEntry(zipEntry);
 
@@ -104,7 +131,7 @@ public class ExtractImagesController {
         // Create ByteArrayResource from byte array
         byte[] zipContents = baos.toByteArray();
 
-        return WebResponseUtils.boasToWebResponse(baos, filename + "_extracted-images.zip", MediaType.APPLICATION_OCTET_STREAM);
+        return WebResponseUtils.boasToWebResponse(
+                baos, filename + "_extracted-images.zip", MediaType.APPLICATION_OCTET_STREAM);
     }
-
 }

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

@@ -3,20 +3,17 @@ package stirling.software.SPDF.controller.api.misc;
 import java.awt.Color;
 import java.awt.geom.AffineTransform;
 import java.awt.image.AffineTransformOp;
-//Required for image manipulation
 import java.awt.image.BufferedImage;
 import java.awt.image.BufferedImageOp;
 import java.awt.image.ConvolveOp;
 import java.awt.image.Kernel;
 import java.awt.image.RescaleOp;
 import java.io.ByteArrayOutputStream;
-//Required for file input/output
 import java.io.File;
 import java.io.IOException;
-//Other required classes
+import java.security.SecureRandom;
 import java.util.Random;
 
-//Required for image input/output
 import javax.imageio.ImageIO;
 
 import org.apache.pdfbox.pdmodel.PDDocument;
@@ -39,6 +36,7 @@ import org.springframework.web.multipart.MultipartFile;
 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.PDFFile;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -49,102 +47,101 @@ public class FakeScanControllerWIP {
 
     private static final Logger logger = LoggerFactory.getLogger(FakeScanControllerWIP.class);
 
-    //TODO
+    // TODO
     @Hidden
     @PostMapping(consumes = "multipart/form-data", value = "/fakeScan")
     @Operation(
-        summary = "Repair a PDF file",
-        description = "This endpoint repairs a given PDF file by running Ghostscript command. The PDF is first saved to a temporary location, repaired, read back, and then returned as a response."
-    )
+            summary = "Repair a PDF file",
+            description =
+                    "This endpoint repairs a given PDF file by running Ghostscript command. The PDF is first saved to a temporary location, repaired, read back, and then returned as a response.")
     public ResponseEntity<byte[]> repairPdf(@ModelAttribute PDFFile request) throws IOException {
         MultipartFile inputFile = request.getFileInput();
 
-    	PDDocument document = PDDocument.load(inputFile.getBytes());
-    	PDFRenderer pdfRenderer = new PDFRenderer(document);
-    	for (int page = 0; page < document.getNumberOfPages(); ++page)
-    	{
-    	    BufferedImage image = pdfRenderer.renderImageWithDPI(page, 300, ImageType.RGB);
-    	    ImageIO.write(image, "png", new File("scanned-" + (page+1) + ".png"));
-    	}
-    	document.close();
+        PDDocument document = PDDocument.load(inputFile.getBytes());
+        PDFRenderer pdfRenderer = new PDFRenderer(document);
+        for (int page = 0; page < document.getNumberOfPages(); ++page) {
+            BufferedImage image = pdfRenderer.renderImageWithDPI(page, 300, ImageType.RGB);
+            ImageIO.write(image, "png", new File("scanned-" + (page + 1) + ".png"));
+        }
+        document.close();
 
-    	// Constants
-    	int scannedness = 90;  // Value between 0 and 100
-    	int dirtiness = 0;  // Value between 0 and 100
+        // Constants
+        int scannedness = 90; // Value between 0 and 100
+        int dirtiness = 0; // Value between 0 and 100
 
-    	// Load the source image
-    	BufferedImage sourceImage = ImageIO.read(new File("scanned-1.png"));
+        // Load the source image
+        BufferedImage sourceImage = ImageIO.read(new File("scanned-1.png"));
 
-    	// Create the destination image
-    	BufferedImage destinationImage = new BufferedImage(sourceImage.getWidth(), sourceImage.getHeight(), sourceImage.getType());
+        // Create the destination image
+        BufferedImage destinationImage =
+                new BufferedImage(
+                        sourceImage.getWidth(), sourceImage.getHeight(), sourceImage.getType());
 
-    	// Apply a brightness and contrast effect based on the "scanned-ness"
-    	float scaleFactor = 1.0f + (scannedness / 100.0f) * 0.5f;  // Between 1.0 and 1.5
-    	float offset = scannedness * 1.5f;  // Between 0 and 150
-    	BufferedImageOp op = new RescaleOp(scaleFactor, offset, null);
-    	op.filter(sourceImage, destinationImage);
+        // Apply a brightness and contrast effect based on the "scanned-ness"
+        float scaleFactor = 1.0f + (scannedness / 100.0f) * 0.5f; // Between 1.0 and 1.5
+        float offset = scannedness * 1.5f; // Between 0 and 150
+        BufferedImageOp op = new RescaleOp(scaleFactor, offset, null);
+        op.filter(sourceImage, destinationImage);
 
-    	// Apply a rotation effect
-    	double rotationRequired = Math.toRadians((new Random().nextInt(3 - 1) + 1));  // Random angle between 1 and 3 degrees
-    	double locationX = destinationImage.getWidth() / 2;
-    	double locationY = destinationImage.getHeight() / 2;
-    	AffineTransform tx = AffineTransform.getRotateInstance(rotationRequired, locationX, locationY);
-    	AffineTransformOp rotateOp = new AffineTransformOp(tx, AffineTransformOp.TYPE_BILINEAR);
-    	destinationImage = rotateOp.filter(destinationImage, null);
+        // Apply a rotation effect
+        double rotationRequired =
+                Math.toRadians(
+                        (new SecureRandom().nextInt(3 - 1)
+                                + 1)); // Random angle between 1 and 3 degrees
+        double locationX = destinationImage.getWidth() / 2;
+        double locationY = destinationImage.getHeight() / 2;
+        AffineTransform tx =
+                AffineTransform.getRotateInstance(rotationRequired, locationX, locationY);
+        AffineTransformOp rotateOp = new AffineTransformOp(tx, AffineTransformOp.TYPE_BILINEAR);
+        destinationImage = rotateOp.filter(destinationImage, null);
 
-    	// Apply a blur effect based on the "scanned-ness"
-    	float blurIntensity = scannedness / 100.0f * 0.2f;  // Between 0.0 and 0.2
-    	float[] matrix = {
-    	    blurIntensity, blurIntensity, blurIntensity,
-    	    blurIntensity, blurIntensity, blurIntensity,
-    	    blurIntensity, blurIntensity, blurIntensity
-    	};
-    	BufferedImageOp blurOp = new ConvolveOp(new Kernel(3, 3, matrix), ConvolveOp.EDGE_NO_OP, null);
-    	destinationImage = blurOp.filter(destinationImage, null);
+        // Apply a blur effect based on the "scanned-ness"
+        float blurIntensity = scannedness / 100.0f * 0.2f; // Between 0.0 and 0.2
+        float[] matrix = {
+            blurIntensity, blurIntensity, blurIntensity,
+            blurIntensity, blurIntensity, blurIntensity,
+            blurIntensity, blurIntensity, blurIntensity
+        };
+        BufferedImageOp blurOp =
+                new ConvolveOp(new Kernel(3, 3, matrix), ConvolveOp.EDGE_NO_OP, null);
+        destinationImage = blurOp.filter(destinationImage, null);
 
-    	// Add noise to the image based on the "dirtiness"
-    	Random random = new Random();
-    	for (int y = 0; y < destinationImage.getHeight(); y++) {
-    	    for (int x = 0; x < destinationImage.getWidth(); x++) {
-    	        if (random.nextInt(100) < dirtiness) {
-    	            // Change the pixel color to black randomly based on the "dirtiness"
-    	            destinationImage.setRGB(x, y, Color.BLACK.getRGB());
-    	        }
-    	    }
-    	}
+        // Add noise to the image based on the "dirtiness"
+        Random random = new SecureRandom();
+        for (int y = 0; y < destinationImage.getHeight(); y++) {
+            for (int x = 0; x < destinationImage.getWidth(); x++) {
+                if (random.nextInt(100) < dirtiness) {
+                    // Change the pixel color to black randomly based on the "dirtiness"
+                    destinationImage.setRGB(x, y, Color.BLACK.getRGB());
+                }
+            }
+        }
 
-    	// Save the image
-    	ImageIO.write(destinationImage, "PNG", new File("scanned-1.png"));
+        // Save the image
+        ImageIO.write(destinationImage, "PNG", new File("scanned-1.png"));
 
+        PDDocument documentOut = new PDDocument();
+        for (int page = 1; page <= document.getNumberOfPages(); ++page) {
+            BufferedImage bim = ImageIO.read(new File("scanned-" + page + ".png"));
 
-    	
-    	
-    	
-    	
+            // Adjust the dimensions of the page
+            PDPage pdPage = new PDPage(new PDRectangle(bim.getWidth() - 1, bim.getHeight() - 1));
+            documentOut.addPage(pdPage);
 
-    	PDDocument documentOut = new PDDocument();
-    	for (int page = 1; page <= document.getNumberOfPages(); ++page)
-    	{
-    	    BufferedImage bim = ImageIO.read(new File("scanned-" + page + ".png"));
-    	    
-    	    // Adjust the dimensions of the page
-    	    PDPage pdPage = new PDPage(new PDRectangle(bim.getWidth() - 1, bim.getHeight() - 1));
-    	    documentOut.addPage(pdPage);
-    	    
-    	    PDImageXObject pdImage = LosslessFactory.createFromImage(documentOut, bim);
-    	    PDPageContentStream contentStream = new PDPageContentStream(documentOut, pdPage);
-    	    
-    	    // Draw the image with a slight offset and enlarged dimensions
-    	    contentStream.drawImage(pdImage, -1, -1, bim.getWidth() + 2, bim.getHeight() + 2);
-    	    contentStream.close();
-    	}
-    	ByteArrayOutputStream baos = new ByteArrayOutputStream();
-    	documentOut.save(baos);
-    	documentOut.close();
+            PDImageXObject pdImage = LosslessFactory.createFromImage(documentOut, bim);
+            PDPageContentStream contentStream = new PDPageContentStream(documentOut, pdPage);
+
+            // Draw the image with a slight offset and enlarged dimensions
+            contentStream.drawImage(pdImage, -1, -1, bim.getWidth() + 2, bim.getHeight() + 2);
+            contentStream.close();
+        }
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        documentOut.save(baos);
+        documentOut.close();
 
         // Return the optimized PDF as a response
-        String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_scanned.pdf";
+        String outputFilename =
+                inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_scanned.pdf";
         return WebResponseUtils.boasToWebResponse(baos, outputFilename);
     }
-
 }

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

@@ -19,6 +19,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.MetadataRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -27,7 +28,6 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "Misc", description = "Miscellaneous APIs")
 public class MetadataController {
 
-
     private String checkUndefined(String entry) {
         // Check if the string is "undefined"
         if ("undefined".equals(entry)) {
@@ -36,14 +36,16 @@ public class MetadataController {
         }
         // Return the original string if it's not "undefined"
         return entry;
-
     }
 
     @PostMapping(consumes = "multipart/form-data", value = "/update-metadata")
-    @Operation(summary = "Update metadata of a PDF file",
-            description = "This endpoint allows you to update the metadata of a given PDF file. You can add, modify, or delete standard and custom metadata fields. Input:PDF Output:PDF Type:SISO")
-    public ResponseEntity<byte[]> metadata(@ModelAttribute MetadataRequest request) throws IOException {
-        
+    @Operation(
+            summary = "Update metadata of a PDF file",
+            description =
+                    "This endpoint allows you to update the metadata of a given PDF file. You can add, modify, or delete standard and custom metadata fields. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> metadata(@ModelAttribute MetadataRequest request)
+            throws IOException {
+
         // Extract PDF file from the request object
         MultipartFile pdfFile = request.getFileInput();
 
@@ -61,8 +63,8 @@ public class MetadataController {
 
         // Extract additional custom parameters
         Map<String, String> allRequestParams = request.getAllRequestParams();
-        if(allRequestParams == null) {
-        	allRequestParams = new java.util.HashMap<String, String>();
+        if (allRequestParams == null) {
+            allRequestParams = new java.util.HashMap<String, String>();
         }
         // Load the PDF file into a PDDocument
         PDDocument document = PDDocument.load(pdfFile.getBytes());
@@ -89,7 +91,9 @@ public class MetadataController {
             }
             // Remove metadata from the PDF history
             document.getDocumentCatalog().getCOSObject().removeItem(COSName.getPDFName("Metadata"));
-            document.getDocumentCatalog().getCOSObject().removeItem(COSName.getPDFName("PieceInfo"));
+            document.getDocumentCatalog()
+                    .getCOSObject()
+                    .removeItem(COSName.getPDFName("PieceInfo"));
             author = null;
             creationDate = null;
             creator = null;
@@ -104,9 +108,17 @@ public class MetadataController {
             for (Entry<String, String> entry : allRequestParams.entrySet()) {
                 String key = entry.getKey();
                 // Check if the key is a standard metadata key
-                if (!key.equalsIgnoreCase("Author") && !key.equalsIgnoreCase("CreationDate") && !key.equalsIgnoreCase("Creator") && !key.equalsIgnoreCase("Keywords")
-                        && !key.equalsIgnoreCase("modificationDate") && !key.equalsIgnoreCase("Producer") && !key.equalsIgnoreCase("Subject") && !key.equalsIgnoreCase("Title")
-                        && !key.equalsIgnoreCase("Trapped") && !key.contains("customKey") && !key.contains("customValue")) {
+                if (!key.equalsIgnoreCase("Author")
+                        && !key.equalsIgnoreCase("CreationDate")
+                        && !key.equalsIgnoreCase("Creator")
+                        && !key.equalsIgnoreCase("Keywords")
+                        && !key.equalsIgnoreCase("modificationDate")
+                        && !key.equalsIgnoreCase("Producer")
+                        && !key.equalsIgnoreCase("Subject")
+                        && !key.equalsIgnoreCase("Title")
+                        && !key.equalsIgnoreCase("Trapped")
+                        && !key.contains("customKey")
+                        && !key.contains("customValue")) {
                     info.setCustomMetadataValue(key, entry.getValue());
                 } else if (key.contains("customKey")) {
                     int number = Integer.parseInt(key.replaceAll("\\D", ""));
@@ -119,7 +131,8 @@ public class MetadataController {
         if (creationDate != null && creationDate.length() > 0) {
             Calendar creationDateCal = Calendar.getInstance();
             try {
-                creationDateCal.setTime(new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").parse(creationDate));
+                creationDateCal.setTime(
+                        new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").parse(creationDate));
             } catch (ParseException e) {
                 e.printStackTrace();
             }
@@ -130,7 +143,8 @@ public class MetadataController {
         if (modificationDate != null && modificationDate.length() > 0) {
             Calendar modificationDateCal = Calendar.getInstance();
             try {
-                modificationDateCal.setTime(new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").parse(modificationDate));
+                modificationDateCal.setTime(
+                        new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").parse(modificationDate));
             } catch (ParseException e) {
                 e.printStackTrace();
             }
@@ -147,7 +161,8 @@ public class MetadataController {
         info.setTrapped(trapped);
 
         document.setDocumentInformation(info);
-        return WebResponseUtils.pdfDocToWebResponse(document, pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_metadata.pdf");
+        return WebResponseUtils.pdfDocToWebResponse(
+                document,
+                pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_metadata.pdf");
     }
-
 }

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

@@ -26,6 +26,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.ProcessPdfWithOcrRequest;
 import stirling.software.SPDF.utils.ProcessExecutor;
 import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
@@ -39,19 +40,26 @@ public class OCRController {
     private static final Logger logger = LoggerFactory.getLogger(OCRController.class);
 
     public List<String> getAvailableTesseractLanguages() {
-        String tessdataDir = "/usr/share/tesseract-ocr/4.00/tessdata";
+        String tessdataDir = "/usr/share/tesseract-ocr/5/tessdata";
         File[] files = new File(tessdataDir).listFiles();
         if (files == null) {
             return Collections.emptyList();
         }
-        return Arrays.stream(files).filter(file -> file.getName().endsWith(".traineddata")).map(file -> file.getName().replace(".traineddata", ""))
-                .filter(lang -> !lang.equalsIgnoreCase("osd")).collect(Collectors.toList());
+        return Arrays.stream(files)
+                .filter(file -> file.getName().endsWith(".traineddata"))
+                .map(file -> file.getName().replace(".traineddata", ""))
+                .filter(lang -> !lang.equalsIgnoreCase("osd"))
+                .collect(Collectors.toList());
     }
 
     @PostMapping(consumes = "multipart/form-data", value = "/ocr-pdf")
-    @Operation(summary = "Process a PDF file with OCR",
-            description = "This endpoint processes a PDF file using OCR (Optical Character Recognition). Users can specify languages, sidecar, deskew, clean, cleanFinal, ocrType, ocrRenderType, and removeImagesAfter options. Input:PDF Output:PDF Type:SI-Conditional")
-    public ResponseEntity<byte[]> processPdfWithOCR(@ModelAttribute ProcessPdfWithOcrRequest request) throws IOException, InterruptedException {
+    @Operation(
+            summary = "Process a PDF file with OCR",
+            description =
+                    "This endpoint processes a PDF file using OCR (Optical Character Recognition). Users can specify languages, sidecar, deskew, clean, cleanFinal, ocrType, ocrRenderType, and removeImagesAfter options. Input:PDF Output:PDF Type:SI-Conditional")
+    public ResponseEntity<byte[]> processPdfWithOCR(
+            @ModelAttribute ProcessPdfWithOcrRequest request)
+            throws IOException, InterruptedException {
         MultipartFile inputFile = request.getFileInput();
         List<String> selectedLanguages = request.getLanguages();
         Boolean sidecar = request.isSidecar();
@@ -65,16 +73,17 @@ public class OCRController {
         if (selectedLanguages == null || selectedLanguages.isEmpty()) {
             throw new IOException("Please select at least one language.");
         }
-        
-        if(!ocrRenderType.equals("hocr") && !ocrRenderType.equals("sandwich")) {
+
+        if (!ocrRenderType.equals("hocr") && !ocrRenderType.equals("sandwich")) {
             throw new IOException("ocrRenderType wrong");
         }
-        
+
         // Get available Tesseract languages
         List<String> availableLanguages = getAvailableTesseractLanguages();
 
         // Validate selected languages
-        selectedLanguages = selectedLanguages.stream().filter(availableLanguages::contains).toList();
+        selectedLanguages =
+                selectedLanguages.stream().filter(availableLanguages::contains).toList();
 
         if (selectedLanguages.isEmpty()) {
             throw new IOException("None of the selected languages are valid.");
@@ -92,8 +101,16 @@ public class OCRController {
         // Run OCR Command
         String languageOption = String.join("+", selectedLanguages);
 
-        
-        List<String> command = new ArrayList<>(Arrays.asList("ocrmypdf", "--verbose", "2", "--output-type", "pdf", "--pdf-renderer" , ocrRenderType));
+        List<String> command =
+                new ArrayList<>(
+                        Arrays.asList(
+                                "ocrmypdf",
+                                "--verbose",
+                                "2",
+                                "--output-type",
+                                "pdf",
+                                "--pdf-renderer",
+                                ocrRenderType));
 
         if (sidecar != null && sidecar) {
             sidecarTextPath = Files.createTempFile("sidecar", ".txt");
@@ -120,42 +137,61 @@ public class OCRController {
             }
         }
 
-        command.addAll(Arrays.asList("--language", languageOption, tempInputFile.toString(), tempOutputFile.toString()));
+        command.addAll(
+                Arrays.asList(
+                        "--language",
+                        languageOption,
+                        tempInputFile.toString(),
+                        tempOutputFile.toString()));
 
         // Run CLI command
-        ProcessExecutorResult result = ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF).runCommandWithOutputHandling(command);
-        if(result.getRc() != 0 && result.getMessages().contains("multiprocessing/synchronize.py") && result.getMessages().contains("OSError: [Errno 38] Function not implemented")) {
-        	command.add("--jobs");
-        	command.add("1");
-        	result = ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF).runCommandWithOutputHandling(command);
+        ProcessExecutorResult result =
+                ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF)
+                        .runCommandWithOutputHandling(command);
+        if (result.getRc() != 0
+                && result.getMessages().contains("multiprocessing/synchronize.py")
+                && result.getMessages().contains("OSError: [Errno 38] Function not implemented")) {
+            command.add("--jobs");
+            command.add("1");
+            result =
+                    ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF)
+                            .runCommandWithOutputHandling(command);
         }
-        
 
-        
-        
         // Remove images from the OCR processed PDF if the flag is set to true
         if (removeImagesAfter != null && removeImagesAfter) {
             Path tempPdfWithoutImages = Files.createTempFile("output_", "_no_images.pdf");
 
-            List<String> gsCommand = Arrays.asList("gs", "-sDEVICE=pdfwrite", "-dFILTERIMAGE", "-o", tempPdfWithoutImages.toString(), tempOutputFile.toString());
+            List<String> gsCommand =
+                    Arrays.asList(
+                            "gs",
+                            "-sDEVICE=pdfwrite",
+                            "-dFILTERIMAGE",
+                            "-o",
+                            tempPdfWithoutImages.toString(),
+                            tempOutputFile.toString());
 
-            ProcessExecutor.getInstance(ProcessExecutor.Processes.GHOSTSCRIPT).runCommandWithOutputHandling(gsCommand);
+            ProcessExecutor.getInstance(ProcessExecutor.Processes.GHOSTSCRIPT)
+                    .runCommandWithOutputHandling(gsCommand);
             tempOutputFile = tempPdfWithoutImages;
         }
         // Read the OCR processed PDF file
         byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
         // Clean up the temporary files
         Files.delete(tempInputFile);
-        
+
         // Return the OCR processed PDF as a response
-        String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_OCR.pdf";
+        String outputFilename =
+                inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_OCR.pdf";
 
         if (sidecar != null && sidecar) {
             // Create a zip file containing both the PDF and the text file
-            String outputZipFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_OCR.zip";
+            String outputZipFilename =
+                    inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_OCR.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 PDF file to the zip
                 ZipEntry pdfEntry = new ZipEntry(outputFilename);
                 zipOut.putNextEntry(pdfEntry);
@@ -177,13 +213,12 @@ public class OCRController {
             Files.delete(sidecarTextPath);
 
             // Return the zip file containing both the PDF and the text file
-            return WebResponseUtils.bytesToWebResponse(zipBytes, outputZipFilename, MediaType.APPLICATION_OCTET_STREAM);
+            return WebResponseUtils.bytesToWebResponse(
+                    zipBytes, outputZipFilename, MediaType.APPLICATION_OCTET_STREAM);
         } else {
             // Return the OCR processed PDF as a response
             Files.delete(tempOutputFile);
             return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
         }
-
     }
-
 }

src/main/java/stirling/software/SPDF/controller/api/misc/OverlayImageController.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.misc.OverlayImageRequest;
 import stirling.software.SPDF.utils.PdfUtils;
 import stirling.software.SPDF.utils.WebResponseUtils;
@@ -27,9 +28,9 @@ public class OverlayImageController {
 
     @PostMapping(consumes = "multipart/form-data", value = "/add-image")
     @Operation(
-        summary = "Overlay image onto a PDF file",
-        description = "This endpoint overlays an image onto a PDF file at the specified coordinates. The image can be overlaid on every page of the PDF if specified.  Input:PDF/IMAGE Output:PDF Type:MF-SISO"
-    )
+            summary = "Overlay image onto a PDF file",
+            description =
+                    "This endpoint overlays an image onto a PDF file at the specified coordinates. The image can be overlaid on every page of the PDF if specified.  Input:PDF/IMAGE Output:PDF Type:MF-SISO")
     public ResponseEntity<byte[]> overlayImage(@ModelAttribute OverlayImageRequest request) {
         MultipartFile pdfFile = request.getFileInput();
         MultipartFile imageFile = request.getImageFile();
@@ -41,7 +42,9 @@ public class OverlayImageController {
             byte[] imageBytes = imageFile.getBytes();
             byte[] result = PdfUtils.overlayImage(pdfBytes, imageBytes, x, y, everyPage);
 
-            return WebResponseUtils.bytesToWebResponse(result, pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_overlayed.pdf");
+            return WebResponseUtils.bytesToWebResponse(
+                    result,
+                    pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_overlayed.pdf");
         } catch (IOException e) {
             logger.error("Failed to add image to PDF", e);
             return new ResponseEntity<>(HttpStatus.BAD_REQUEST);

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

@@ -21,6 +21,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.AddPageNumbersRequest;
 import stirling.software.SPDF.utils.GeneralUtils;
 import stirling.software.SPDF.utils.WebResponseUtils;
@@ -33,16 +34,20 @@ public class PageNumbersController {
     private static final Logger logger = LoggerFactory.getLogger(PageNumbersController.class);
 
     @PostMapping(value = "/add-page-numbers", consumes = "multipart/form-data")
-    @Operation(summary = "Add page numbers to a PDF document", description = "This operation takes an input PDF file and adds page numbers to it. Input:PDF Output:PDF Type:SISO")
-    public ResponseEntity<byte[]> addPageNumbers(@ModelAttribute AddPageNumbersRequest request) throws IOException {
+    @Operation(
+            summary = "Add page numbers to a PDF document",
+            description =
+                    "This operation takes an input PDF file and adds page numbers to it. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> addPageNumbers(@ModelAttribute AddPageNumbersRequest request)
+            throws IOException {
         MultipartFile file = request.getFileInput();
         String customMargin = request.getCustomMargin();
         int position = request.getPosition();
         int startingNumber = request.getStartingNumber();
         String pagesToNumber = request.getPagesToNumber();
         String customText = request.getCustomText();
-    	int pageNumber = startingNumber;
-    	byte[] fileBytes = file.getBytes();
+        int pageNumber = startingNumber;
+        byte[] fileBytes = file.getBytes();
         PDDocument document = PDDocument.load(fileBytes);
 
         float marginFactor;
@@ -58,9 +63,8 @@ public class PageNumbersController {
                 break;
             case "x-large":
                 marginFactor = 0.075f;
-                break;   
-                
-                
+                break;
+
             default:
                 marginFactor = 0.035f;
                 break;
@@ -68,19 +72,29 @@ public class PageNumbersController {
 
         float fontSize = 12.0f;
         PDType1Font font = PDType1Font.HELVETICA;
-        if(pagesToNumber == null || pagesToNumber.length() == 0) {
-        	pagesToNumber = "all";
+        if (pagesToNumber == null || pagesToNumber.length() == 0) {
+            pagesToNumber = "all";
         }
-        if(customText == null || customText.length() == 0) {
-        	customText = "{n}";
+        if (customText == null || customText.length() == 0) {
+            customText = "{n}";
         }
-        List<Integer> pagesToNumberList = GeneralUtils.parsePageList(pagesToNumber.split(","), document.getNumberOfPages());
+        List<Integer> pagesToNumberList =
+                GeneralUtils.parsePageList(pagesToNumber.split(","), document.getNumberOfPages());
 
         for (int i : pagesToNumberList) {
             PDPage page = document.getPage(i);
             PDRectangle pageSize = page.getMediaBox();
 
-            String text = customText != null ? customText.replace("{n}", String.valueOf(pageNumber)).replace("{total}", String.valueOf(document.getNumberOfPages())).replace("{filename}", file.getOriginalFilename().replaceFirst("[.][^.]+$", "")) : String.valueOf(pageNumber);
+            String text =
+                    customText != null
+                            ? customText
+                                    .replace("{n}", String.valueOf(pageNumber))
+                                    .replace("{total}", String.valueOf(document.getNumberOfPages()))
+                                    .replace(
+                                            "{filename}",
+                                            file.getOriginalFilename()
+                                                    .replaceFirst("[.][^.]+$", ""))
+                            : String.valueOf(pageNumber);
 
             float x, y;
 
@@ -88,10 +102,10 @@ public class PageNumbersController {
             int yGroup = 2 - (position - 1) / 3;
 
             switch (xGroup) {
-                case 0:  // left
+                case 0: // left
                     x = pageSize.getLowerLeftX() + marginFactor * pageSize.getWidth();
                     break;
-                case 1:  // center
+                case 1: // center
                     x = pageSize.getLowerLeftX() + (pageSize.getWidth() / 2);
                     break;
                 default: // right
@@ -100,10 +114,10 @@ public class PageNumbersController {
             }
 
             switch (yGroup) {
-                case 0:  // bottom
+                case 0: // bottom
                     y = pageSize.getLowerLeftY() + marginFactor * pageSize.getHeight();
                     break;
-                case 1:  // middle
+                case 1: // middle
                     y = pageSize.getLowerLeftY() + (pageSize.getHeight() / 2);
                     break;
                 default: // top
@@ -111,7 +125,9 @@ public class PageNumbersController {
                     break;
             }
 
-            PDPageContentStream contentStream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true);
+            PDPageContentStream contentStream =
+                    new PDPageContentStream(
+                            document, page, PDPageContentStream.AppendMode.APPEND, true);
             contentStream.beginText();
             contentStream.setFont(font, fontSize);
             contentStream.newLineAtOffset(x, y);
@@ -126,10 +142,9 @@ public class PageNumbersController {
         document.save(baos);
         document.close();
 
-        return WebResponseUtils.bytesToWebResponse(baos.toByteArray(), file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_numbersAdded.pdf", MediaType.APPLICATION_PDF);
-
+        return WebResponseUtils.bytesToWebResponse(
+                baos.toByteArray(),
+                file.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_numbersAdded.pdf",
+                MediaType.APPLICATION_PDF);
     }
-
-
-
 }

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

@@ -17,6 +17,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;
@@ -31,11 +32,12 @@ public class RepairController {
 
     @PostMapping(consumes = "multipart/form-data", value = "/repair")
     @Operation(
-        summary = "Repair a PDF file",
-        description = "This endpoint repairs a given PDF file by running Ghostscript command. The PDF is first saved to a temporary location, repaired, read back, and then returned as a response. Input:PDF Output:PDF Type:SISO"
-    )
-    public ResponseEntity<byte[]> repairPdf(@ModelAttribute PDFFile request) throws IOException, InterruptedException {
-    	MultipartFile inputFile = request.getFileInput();
+            summary = "Repair a PDF file",
+            description =
+                    "This endpoint repairs a given PDF file by running Ghostscript command. The PDF is first saved to a temporary location, repaired, read back, and then returned as a response. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> repairPdf(@ModelAttribute PDFFile request)
+            throws IOException, InterruptedException {
+        MultipartFile inputFile = request.getFileInput();
         // Save the uploaded file to a temporary location
         Path tempInputFile = Files.createTempFile("input_", ".pdf");
         inputFile.transferTo(tempInputFile.toFile());
@@ -50,8 +52,9 @@ public class RepairController {
         command.add("-sDEVICE=pdfwrite");
         command.add(tempInputFile.toString());
 
-
-        ProcessExecutorResult returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.GHOSTSCRIPT).runCommandWithOutputHandling(command);
+        ProcessExecutorResult returnCode =
+                ProcessExecutor.getInstance(ProcessExecutor.Processes.GHOSTSCRIPT)
+                        .runCommandWithOutputHandling(command);
 
         // Read the optimized PDF file
         byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
@@ -61,8 +64,8 @@ public class RepairController {
         Files.delete(tempOutputFile);
 
         // Return the optimized PDF as a response
-        String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_repaired.pdf";
+        String outputFilename =
+                inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_repaired.pdf";
         return WebResponseUtils.bytesToWebResponse(pdfBytes, outputFilename);
     }
-
 }

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

@@ -15,47 +15,62 @@ 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.PDFFile;
 import stirling.software.SPDF.utils.WebResponseUtils;
+
 @RestController
 @RequestMapping("/api/v1/misc")
 @Tag(name = "Misc", description = "Miscellaneous APIs")
 public class ShowJavascript {
 
     private static final Logger logger = LoggerFactory.getLogger(ShowJavascript.class);
+
     @PostMapping(consumes = "multipart/form-data", value = "/show-javascript")
+    @Operation(
+            summary = "Grabs all JS from a PDF and returns a single JS file with all code",
+            description = "desc. Input:PDF Output:JS Type:SISO")
     public ResponseEntity<byte[]> extractHeader(@ModelAttribute PDFFile request) throws Exception {
-    	MultipartFile inputFile = request.getFileInput();
+        MultipartFile inputFile = request.getFileInput();
         String script = "";
 
         try (PDDocument document = PDDocument.load(inputFile.getInputStream())) {
-        	
-        	if(document.getDocumentCatalog() != null && document.getDocumentCatalog().getNames() != null) {
-	            PDNameTreeNode<PDActionJavaScript> jsTree = document.getDocumentCatalog().getNames().getJavaScript();
-	
-	            if (jsTree != null) {
-	                Map<String, PDActionJavaScript> jsEntries = jsTree.getNames();
-	
-	                for (Map.Entry<String, PDActionJavaScript> entry : jsEntries.entrySet()) {
-	                    String name = entry.getKey();
-	                    PDActionJavaScript jsAction = entry.getValue();
-	                    String jsCodeStr = jsAction.getAction();
-	
-	                    script += "// File: " + inputFile.getOriginalFilename() + ", Script: " + name + "\n" + jsCodeStr + "\n";
-	                }
-	            }
-        	}
 
-            if (script.isEmpty()) {
-                script = "PDF '" + inputFile.getOriginalFilename() + "' does not contain Javascript";
+            if (document.getDocumentCatalog() != null
+                    && document.getDocumentCatalog().getNames() != null) {
+                PDNameTreeNode<PDActionJavaScript> jsTree =
+                        document.getDocumentCatalog().getNames().getJavaScript();
+
+                if (jsTree != null) {
+                    Map<String, PDActionJavaScript> jsEntries = jsTree.getNames();
+
+                    for (Map.Entry<String, PDActionJavaScript> entry : jsEntries.entrySet()) {
+                        String name = entry.getKey();
+                        PDActionJavaScript jsAction = entry.getValue();
+                        String jsCodeStr = jsAction.getAction();
+
+                        script +=
+                                "// File: "
+                                        + inputFile.getOriginalFilename()
+                                        + ", Script: "
+                                        + name
+                                        + "\n"
+                                        + jsCodeStr
+                                        + "\n";
+                    }
+                }
             }
 
-            return WebResponseUtils.bytesToWebResponse(script.getBytes(StandardCharsets.UTF_8), inputFile.getOriginalFilename() + ".js");
+            if (script.isEmpty()) {
+                script =
+                        "PDF '" + inputFile.getOriginalFilename() + "' does not contain Javascript";
+            }
+
+            return WebResponseUtils.bytesToWebResponse(
+                    script.getBytes(StandardCharsets.UTF_8),
+                    inputFile.getOriginalFilename() + ".js");
         }
     }
-    
-
-
-
 }

src/main/java/stirling/software/SPDF/controller/api/pipeline/ApiDocService.java

@@ -0,0 +1,122 @@
+package stirling.software.SPDF.controller.api.pipeline;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Service;
+import org.springframework.web.client.RestTemplate;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import jakarta.servlet.ServletContext;
+import stirling.software.SPDF.SPdfApplication;
+import stirling.software.SPDF.model.ApiEndpoint;
+import stirling.software.SPDF.model.Role;
+
+@Service
+public class ApiDocService {
+
+    private final Map<String, ApiEndpoint> apiDocumentation = new HashMap<>();
+
+    private static final Logger logger = LoggerFactory.getLogger(ApiDocService.class);
+
+    @Autowired private ServletContext servletContext;
+
+    private String getApiDocsUrl() {
+        String contextPath = servletContext.getContextPath();
+        String port = SPdfApplication.getPort();
+
+        return "http://localhost:" + port + contextPath + "/v1/api-docs";
+    }
+
+    @Autowired(required = false)
+    private UserServiceInterface userService;
+
+    private String getApiKeyForUser() {
+        if (userService == null) return "";
+        return userService.getApiKeyForUser(Role.INTERNAL_API_USER.getRoleId());
+    }
+
+    JsonNode apiDocsJsonRootNode;
+
+    // @EventListener(ApplicationReadyEvent.class)
+    private synchronized void loadApiDocumentation() {
+        String apiDocsJson = "";
+        try {
+            HttpHeaders headers = new HttpHeaders();
+            String apiKey = getApiKeyForUser();
+            if (!apiKey.isEmpty()) {
+                headers.set("X-API-KEY", apiKey);
+            }
+            HttpEntity<String> entity = new HttpEntity<>(headers);
+
+            RestTemplate restTemplate = new RestTemplate();
+            ResponseEntity<String> response =
+                    restTemplate.exchange(getApiDocsUrl(), HttpMethod.GET, entity, String.class);
+            apiDocsJson = response.getBody();
+
+            ObjectMapper mapper = new ObjectMapper();
+            apiDocsJsonRootNode = mapper.readTree(apiDocsJson);
+
+            JsonNode paths = apiDocsJsonRootNode.path("paths");
+            paths.fields()
+                    .forEachRemaining(
+                            entry -> {
+                                String path = entry.getKey();
+                                JsonNode pathNode = entry.getValue();
+                                if (pathNode.has("post")) {
+                                    JsonNode postNode = pathNode.get("post");
+                                    ApiEndpoint endpoint = new ApiEndpoint(path, postNode);
+                                    apiDocumentation.put(path, endpoint);
+                                }
+                            });
+        } catch (Exception e) {
+            // Handle exceptions
+            logger.error("Error grabbing swagger doc, body result {}", apiDocsJson);
+        }
+    }
+
+    public boolean isValidOperation(String operationName, Map<String, Object> parameters) {
+        if (apiDocumentation.size() == 0) {
+            loadApiDocumentation();
+        }
+        if (!apiDocumentation.containsKey(operationName)) {
+            return false;
+        }
+        ApiEndpoint endpoint = apiDocumentation.get(operationName);
+        return endpoint.areParametersValid(parameters);
+    }
+
+    public boolean isMultiInput(String operationName) {
+        if (apiDocsJsonRootNode == null || apiDocumentation.size() == 0) {
+            loadApiDocumentation();
+        }
+        if (!apiDocumentation.containsKey(operationName)) {
+            return false;
+        }
+
+        ApiEndpoint endpoint = apiDocumentation.get(operationName);
+        String description = endpoint.getDescription();
+
+        Pattern pattern = Pattern.compile("Type:(\\w+)");
+        Matcher matcher = pattern.matcher(description);
+        if (matcher.find()) {
+            String type = matcher.group(1);
+            return type.startsWith("MI");
+        }
+
+        return false;
+    }
+}
+
+// Model class for API Endpoint

src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineController.java

@@ -1,56 +1,32 @@
 package stirling.software.SPDF.controller.api.pipeline;
 
-import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
 import java.io.InputStream;
-import java.io.OutputStream;
-import java.io.PrintStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.time.LocalDate;
-import java.time.LocalTime;
-import java.time.format.DateTimeFormatter;
-import java.util.ArrayList;
-import java.util.Iterator;
 import java.util.List;
-import java.util.Map;
-import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
-import java.util.zip.ZipInputStream;
 import java.util.zip.ZipOutputStream;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.core.io.ByteArrayResource;
 import org.springframework.core.io.Resource;
-import org.springframework.http.HttpEntity;
-import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
-import org.springframework.scheduling.annotation.Scheduled;
-import org.springframework.util.LinkedMultiValueMap;
-import org.springframework.util.MultiValueMap;
 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.client.RestTemplate;
 import org.springframework.web.multipart.MultipartFile;
 
-import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import io.swagger.v3.oas.annotations.tags.Tag;
+
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.PipelineConfig;
-import stirling.software.SPDF.model.PipelineOperation;
 import stirling.software.SPDF.model.api.HandleDataRequest;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -59,466 +35,80 @@ import stirling.software.SPDF.utils.WebResponseUtils;
 @Tag(name = "Pipeline", description = "Pipeline APIs")
 public class PipelineController {
 
-	private static final Logger logger = LoggerFactory.getLogger(PipelineController.class);
-	@Autowired
-	private ObjectMapper objectMapper;
+    private static final Logger logger = LoggerFactory.getLogger(PipelineController.class);
 
-	final String jsonFileName = "pipelineConfig.json";
-	final String watchedFoldersDir = "./pipeline/watchedFolders/";
-	final String finishedFoldersDir = "./pipeline/finishedFolders/";
-	
-	@Scheduled(fixedRate = 25000)
-	public void scanFolders() {
-		logger.info("Scanning folders...");
-		Path watchedFolderPath = Paths.get(watchedFoldersDir);
-		if (!Files.exists(watchedFolderPath)) {
-			try {
-				Files.createDirectories(watchedFolderPath);
-				logger.info("Created directory: {}", watchedFolderPath);
-			} catch (IOException e) {
-				logger.error("Error creating directory: {}", watchedFolderPath, e);
-				return;
-			}
-		}
-		try (Stream<Path> paths = Files.walk(watchedFolderPath)) {
-			paths.filter(Files::isDirectory).forEach(t -> {
-				try {
-					if (!t.equals(watchedFolderPath) && !t.endsWith("processing")) {
-						handleDirectory(t);
-					}
-				} catch (Exception e) {
-					logger.error("Error handling directory: {}", t, e);
-				}
-			});
-		} catch (Exception e) {
-			logger.error("Error walking through directory: {}", watchedFolderPath, e);
-		}
-	}
+    final String watchedFoldersDir = "./pipeline/watchedFolders/";
+    final String finishedFoldersDir = "./pipeline/finishedFolders/";
+    @Autowired PipelineProcessor processor;
 
-	@Autowired
-	ApplicationProperties applicationProperties;
-	
+    @Autowired ApplicationProperties applicationProperties;
 
-	private void handleDirectory(Path dir) throws Exception {
-		logger.info("Handling directory: {}", dir);
-		Path jsonFile = dir.resolve(jsonFileName);
-		Path processingDir = dir.resolve("processing"); // Directory to move files during processing
-		if (!Files.exists(processingDir)) {
-			Files.createDirectory(processingDir);
-			logger.info("Created processing directory: {}", processingDir);
-		}
+    @Autowired private ObjectMapper objectMapper;
 
-		if (Files.exists(jsonFile)) {
-			// Read JSON file
-			String jsonString;
-			try {
-				jsonString = new String(Files.readAllBytes(jsonFile));
-				logger.info("Read JSON file: {}", jsonFile);
-			} catch (IOException e) {
-				logger.error("Error reading JSON file: {}", jsonFile, e);
-				return;
-			}
+    @PostMapping("/handleData")
+    public ResponseEntity<byte[]> handleData(@ModelAttribute HandleDataRequest request)
+            throws JsonMappingException, JsonProcessingException {
+        if (!Boolean.TRUE.equals(applicationProperties.getSystem().getEnableAlphaFunctionality())) {
+            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
+        }
 
-			// Decode JSON to PipelineConfig
-			PipelineConfig config;
-			try {
-				config = objectMapper.readValue(jsonString, PipelineConfig.class);
-				// Assuming your PipelineConfig class has getters for all necessary fields, you
-				// can perform checks here
-				if (config.getOperations() == null || config.getOutputDir() == null || config.getName() == null) {
-					throw new IOException("Invalid JSON format");
-				}
-			} catch (IOException e) {
-				logger.error("Error parsing PipelineConfig: {}", jsonString, e);
-				return;
-			}
+        MultipartFile[] files = request.getFileInput();
+        String jsonString = request.getJson();
+        if (files == null) {
+            return null;
+        }
+        PipelineConfig config = objectMapper.readValue(jsonString, PipelineConfig.class);
+        logger.info("Received POST request to /handleData with {} files", files.length);
+        try {
+            List<Resource> inputFiles = processor.generateInputFiles(files);
+            if (inputFiles == null || inputFiles.size() == 0) {
+                return null;
+            }
+            List<Resource> outputFiles = processor.runPipelineAgainstFiles(inputFiles, config);
+            if (outputFiles != null && outputFiles.size() == 1) {
+                // If there is only one file, return it directly
+                Resource singleFile = outputFiles.get(0);
+                InputStream is = singleFile.getInputStream();
+                byte[] bytes = new byte[(int) singleFile.contentLength()];
+                is.read(bytes);
+                is.close();
 
-			// For each operation in the pipeline
-			for (PipelineOperation operation : config.getOperations()) {
-				// Collect all files based on fileInput
-				File[] files;
-				String fileInput = (String) operation.getParameters().get("fileInput");
-				if ("automated".equals(fileInput)) {
-					// If fileInput is "automated", process all files in the directory
-					try (Stream<Path> paths = Files.list(dir)) {
-						files = paths
-							    .filter(path -> !Files.isDirectory(path)) // exclude directories
-							    .filter(path -> !path.equals(jsonFile)) // exclude jsonFile
-							    .map(Path::toFile)
-							    .toArray(File[]::new);
+                logger.info("Returning single file response...");
+                return WebResponseUtils.bytesToWebResponse(
+                        bytes, singleFile.getFilename(), MediaType.APPLICATION_OCTET_STREAM);
+            } else if (outputFiles == null) {
+                return null;
+            }
 
-					} catch (IOException e) {
-						e.printStackTrace();
-						return;
-					}
-				} else {
-					// If fileInput contains a path, process only this file
-					files = new File[] { new File(fileInput) };
-				}
+            // Create a ByteArrayOutputStream to hold the zip
+            ByteArrayOutputStream baos = new ByteArrayOutputStream();
+            ZipOutputStream zipOut = new ZipOutputStream(baos);
 
-				// Prepare the files for processing
-				List<File> filesToProcess = new ArrayList<>();
-				for (File file : files) {
-				    logger.info(file.getName());
-				    logger.info("{} to {}",file.toPath(), processingDir.resolve(file.getName()));
-				    Files.move(file.toPath(), processingDir.resolve(file.getName()));
-				    filesToProcess.add(processingDir.resolve(file.getName()).toFile());
-				}
+            // Loop through each file and add it to the zip
+            for (Resource file : outputFiles) {
+                ZipEntry zipEntry = new ZipEntry(file.getFilename());
+                zipOut.putNextEntry(zipEntry);
 
-				// Process the files
-				try {
-				    List<Resource> resources = handleFiles(filesToProcess.toArray(new File[0]), jsonString);
-				    
-					if(resources == null) {
-						return;
-					}
-					// Move resultant files and rename them as per config in JSON file
-					for (Resource resource : resources) {
-						String resourceName = resource.getFilename();
-						String baseName = resourceName.substring(0, resourceName.lastIndexOf("."));
-						String extension = resourceName.substring(resourceName.lastIndexOf(".")+1);
-						
-						String outputFileName = config.getOutputPattern().replace("{filename}", baseName);
-						
-						outputFileName = outputFileName.replace("{pipelineName}", config.getName());
-						DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyyMMdd");
-						outputFileName = outputFileName.replace("{date}", LocalDate.now().format(dateFormatter));
-						DateTimeFormatter timeFormatter = DateTimeFormatter.ofPattern("HHmmss");
-						outputFileName = outputFileName.replace("{time}", LocalTime.now().format(timeFormatter));
-						
-						outputFileName += "." + extension;
-						// {filename} {folder} {date} {tmime} {pipeline}
-						String outputDir = config.getOutputDir();
+                // Read the file into a byte array
+                InputStream is = file.getInputStream();
+                byte[] bytes = new byte[(int) file.contentLength()];
+                is.read(bytes);
 
-						String outputFolder = applicationProperties.getAutoPipeline().getOutputFolder();
+                // Write the bytes of the file to the zip
+                zipOut.write(bytes, 0, bytes.length);
+                zipOut.closeEntry();
 
-						if (outputFolder == null || outputFolder.isEmpty()) {
-						    // If the environment variable is not set, use the default value
-						    outputFolder = finishedFoldersDir;
-						}
-						logger.info("outputDir 0={}", outputDir);
-						// Replace the placeholders in the outputDir string
-						outputDir = outputDir.replace("{outputFolder}", outputFolder);
-						outputDir = outputDir.replace("{folderName}", dir.toString());
-						logger.info("outputDir 1={}", outputDir);
-						outputDir = outputDir.replace("\\watchedFolders", "");
-						outputDir = outputDir.replace("//watchedFolders", "");
-						outputDir = outputDir.replace("\\\\watchedFolders", "");
-						outputDir = outputDir.replace("/watchedFolders", "");
-						
-						Path outputPath; 
-						logger.info("outputDir 2={}", outputDir);
-						if (Paths.get(outputDir).isAbsolute()) {
-						    // If it's an absolute path, use it directly
-						    outputPath = Paths.get(outputDir);
-						} else {
-						    // If it's a relative path, make it relative to the current working directory
-						    outputPath = Paths.get(".", outputDir);
-						}
-						
-						logger.info("outputPath={}", outputPath);
-						
-						if (!Files.exists(outputPath)) {
-							try {
-								Files.createDirectories(outputPath);
-								logger.info("Created directory: {}", outputPath);
-							} catch (IOException e) {
-								logger.error("Error creating directory: {}", outputPath, e);
-								return;
-							}
-						}
-						logger.info("outputPath {}", outputPath);	
-						logger.info("outputPath.resolve(outputFileName).toString() {}", outputPath.resolve(outputFileName).toString());	
-						File newFile = new File(outputPath.resolve(outputFileName).toString());
-					    OutputStream os = new FileOutputStream(newFile);
-					    os.write(((ByteArrayResource)resource).getByteArray());
-					    os.close();
-						logger.info("made {}", outputPath.resolve(outputFileName));	
-					}
+                is.close();
+            }
 
-					// If successful, delete the original files
-					for (File file : filesToProcess) {
-						Files.deleteIfExists(processingDir.resolve(file.getName()));
-					}
-				} catch (Exception e) {
-					// If an error occurs, move the original files back
-					for (File file : filesToProcess) {
-						Files.move(processingDir.resolve(file.getName()), file.toPath());
-					}
-					throw e;
-				}
-			}
-		}
-	}
-
-	List<Resource> processFiles(List<Resource> outputFiles, String jsonString) throws Exception {
-		
-		ObjectMapper mapper = new ObjectMapper();
-		JsonNode jsonNode = mapper.readTree(jsonString);
-
-		JsonNode pipelineNode = jsonNode.get("pipeline");
-		logger.info("Running pipelineNode: {}", pipelineNode);
-		ByteArrayOutputStream logStream = new ByteArrayOutputStream();
-		PrintStream logPrintStream = new PrintStream(logStream);
-
-		boolean hasErrors = false;
-
-		for (JsonNode operationNode : pipelineNode) {
-			String operation = operationNode.get("operation").asText();
-			logger.info("Running operation: {}", operation);
-			JsonNode parametersNode = operationNode.get("parameters");
-			String inputFileExtension = "";
-			if (operationNode.has("inputFileType")) {
-				inputFileExtension = operationNode.get("inputFileType").asText();
-			} else {
-				inputFileExtension = ".pdf";
-			}
-
-			List<Resource> newOutputFiles = new ArrayList<>();
-			boolean hasInputFileType = false;
-
-			for (Resource file : outputFiles) {
-				if (file.getFilename().endsWith(inputFileExtension)) {
-					hasInputFileType = true;
-					MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();
-					body.add("fileInput", file);
-
-					Iterator<Map.Entry<String, JsonNode>> parameters = parametersNode.fields();
-					while (parameters.hasNext()) {
-						Map.Entry<String, JsonNode> parameter = parameters.next();
-						body.add(parameter.getKey(), parameter.getValue().asText());
-					}
-
-					HttpHeaders headers = new HttpHeaders();
-					headers.setContentType(MediaType.MULTIPART_FORM_DATA);
-
-					HttpEntity<MultiValueMap<String, Object>> entity = new HttpEntity<>(body, headers);
-
-					RestTemplate restTemplate = new RestTemplate();
-					String url = "http://localhost:8080/" + operation;
-
-					ResponseEntity<byte[]> response = restTemplate.exchange(url, HttpMethod.POST, entity, byte[].class);
-
-					// If the operation is filter and the response body is null or empty, skip this file
-	                if (operation.startsWith("filter-") && (response.getBody() == null || response.getBody().length == 0)) {
-	                	logger.info("Skipping file due to failing {}", operation);
-	                    continue;
-	                }
-	                
-					if (!response.getStatusCode().equals(HttpStatus.OK)) {
-						logPrintStream.println("Error: " + response.getBody());
-						hasErrors = true;
-						continue;
-					}
-					
-					
-					// Define filename
-	                String filename;
-	                if ("auto-rename".equals(operation)) {
-	                    // If the operation is "auto-rename", generate a new filename.
-	                    // This is a simple example of generating a filename using current timestamp.
-	                    // Modify as per your needs.
-	                    filename = "file_" + System.currentTimeMillis();
-	                } else {
-	                    // Otherwise, keep the original filename.
-	                    filename = file.getFilename();
-	                }
-
-	                // Check if the response body is a zip file
-	                if (isZip(response.getBody())) {
-	                    // Unzip the file and add all the files to the new output files
-	                    newOutputFiles.addAll(unzip(response.getBody()));
-	                } else {
-	                    Resource outputResource = new ByteArrayResource(response.getBody()) {
-	                        @Override
-	                        public String getFilename() {
-	                            return filename;
-	                        }
-	                    };
-	                    newOutputFiles.add(outputResource);
-	                }
-				}
-
-				if (!hasInputFileType) {
-					logPrintStream.println(
-							"No files with extension " + inputFileExtension + " found for operation " + operation);
-					hasErrors = true;
-				}
-
-				outputFiles = newOutputFiles;
-			}
-			logPrintStream.close();
-
-		}
-		if (hasErrors) {
-			logger.error("Errors occurred during processing. Log: {}", logStream.toString());
-		}
-		return outputFiles;
-	}
-
-	List<Resource> handleFiles(File[] files, String jsonString) throws Exception {
-		if(files == null || files.length == 0) {
-			logger.info("No files");
-			return null;
-		}
-			
-		logger.info("Handling files: {} files, with JSON string of length: {}", files.length, jsonString.length());
-		
-		ObjectMapper mapper = new ObjectMapper();
-		JsonNode jsonNode = mapper.readTree(jsonString);
-
-		JsonNode pipelineNode = jsonNode.get("pipeline");
-
-		boolean hasErrors = false;
-		List<Resource> outputFiles = new ArrayList<>();
-
-		for (File file : files) {
-		    Path path = Paths.get(file.getAbsolutePath());
-		    System.out.println("Reading file: " + path); // debug statement
-		    
-		    if (Files.exists(path)) {
-		        Resource fileResource = new ByteArrayResource(Files.readAllBytes(path)) {
-		            @Override
-		            public String getFilename() {
-		                return file.getName();
-		            }
-		        };
-		        outputFiles.add(fileResource);
-		    } else {
-		        System.out.println("File not found: " + path); // debug statement
-		    }
-		}
-		logger.info("Files successfully loaded. Starting processing...");
-		return processFiles(outputFiles, jsonString);
-	}
-
-	List<Resource> handleFiles(MultipartFile[] files, String jsonString) throws Exception {
-		if(files == null || files.length == 0) {
-			logger.info("No files");
-			return null;
-		}
-		logger.info("Handling files: {} files, with JSON string of length: {}", files.length, jsonString.length());
-		ObjectMapper mapper = new ObjectMapper();
-		JsonNode jsonNode = mapper.readTree(jsonString);
-
-		JsonNode pipelineNode = jsonNode.get("pipeline");
-
-		boolean hasErrors = false;
-		List<Resource> outputFiles = new ArrayList<>();
-
-		for (MultipartFile file : files) {
-			Resource fileResource = new ByteArrayResource(file.getBytes()) {
-				@Override
-				public String getFilename() {
-					return file.getOriginalFilename();
-				}
-			};
-			outputFiles.add(fileResource);
-		}
-		logger.info("Files successfully loaded. Starting processing...");
-		return processFiles(outputFiles, jsonString);
-	}
-
-	@PostMapping("/handleData")
-	public ResponseEntity<byte[]> handleData(@ModelAttribute HandleDataRequest request) {
-	    MultipartFile[] files = request.getFileInputs();
-	    String jsonString = request.getJsonString();
-		logger.info("Received POST request to /handleData with {} files", files.length);
-		try {
-			List<Resource> outputFiles = handleFiles(files, jsonString);
-
-			if (outputFiles != null && outputFiles.size() == 1) {
-				// If there is only one file, return it directly
-				Resource singleFile = outputFiles.get(0);
-				InputStream is = singleFile.getInputStream();
-				byte[] bytes = new byte[(int) singleFile.contentLength()];
-				is.read(bytes);
-				is.close();
-
-				logger.info("Returning single file response...");
-				return WebResponseUtils.bytesToWebResponse(bytes, singleFile.getFilename(),
-						MediaType.APPLICATION_OCTET_STREAM);
-			} else if (outputFiles == null) {
-				return null;
-			}
-
-			// Create a ByteArrayOutputStream to hold the zip
-			ByteArrayOutputStream baos = new ByteArrayOutputStream();
-			ZipOutputStream zipOut = new ZipOutputStream(baos);
-
-			// Loop through each file and add it to the zip
-			for (Resource file : outputFiles) {
-				ZipEntry zipEntry = new ZipEntry(file.getFilename());
-				zipOut.putNextEntry(zipEntry);
-
-				// Read the file into a byte array
-				InputStream is = file.getInputStream();
-				byte[] bytes = new byte[(int) file.contentLength()];
-				is.read(bytes);
-
-				// Write the bytes of the file to the zip
-				zipOut.write(bytes, 0, bytes.length);
-				zipOut.closeEntry();
-
-				is.close();
-			}
-
-			zipOut.close();
-
-			logger.info("Returning zipped file response...");
-			return WebResponseUtils.boasToWebResponse(baos, "output.zip", MediaType.APPLICATION_OCTET_STREAM);
-		} catch (Exception e) {
-			logger.error("Error handling data: ", e);
-			return null;
-		}
-	}
-
-	private boolean isZip(byte[] data) {
-		if (data == null || data.length < 4) {
-			return false;
-		}
-
-		// Check the first four bytes of the data against the standard zip magic number
-		return data[0] == 0x50 && data[1] == 0x4B && data[2] == 0x03 && data[3] == 0x04;
-	}
-
-	private List<Resource> unzip(byte[] data) throws IOException {
-		logger.info("Unzipping data of length: {}", data.length);
-		List<Resource> unzippedFiles = new ArrayList<>();
-
-		try (ByteArrayInputStream bais = new ByteArrayInputStream(data);
-				ZipInputStream zis = new ZipInputStream(bais)) {
-
-			ZipEntry entry;
-			while ((entry = zis.getNextEntry()) != null) {
-				ByteArrayOutputStream baos = new ByteArrayOutputStream();
-				byte[] buffer = new byte[1024];
-				int count;
-
-				while ((count = zis.read(buffer)) != -1) {
-					baos.write(buffer, 0, count);
-				}
-
-				final String filename = entry.getName();
-				Resource fileResource = new ByteArrayResource(baos.toByteArray()) {
-					@Override
-					public String getFilename() {
-						return filename;
-					}
-				};
-
-				// If the unzipped file is a zip file, unzip it
-				if (isZip(baos.toByteArray())) {
-					logger.info("File {} is a zip file. Unzipping...", filename);
-					unzippedFiles.addAll(unzip(baos.toByteArray()));
-				} else {
-					unzippedFiles.add(fileResource);
-				}
-			}
-		}
-
-		logger.info("Unzipping completed. {} files were unzipped.", unzippedFiles.size());
-		return unzippedFiles;
-	}
+            zipOut.close();
 
+            logger.info("Returning zipped file response...");
+            return WebResponseUtils.boasToWebResponse(
+                    baos, "output.zip", MediaType.APPLICATION_OCTET_STREAM);
+        } catch (Exception e) {
+            logger.error("Error handling data: ", e);
+            return null;
+        }
+    }
 }

src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineDirectoryProcessor.java

@@ -0,0 +1,276 @@
+package stirling.software.SPDF.controller.api.pipeline;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.time.LocalDate;
+import java.time.LocalTime;
+import java.time.format.DateTimeFormatter;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Stream;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.core.io.Resource;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Service;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.PipelineConfig;
+import stirling.software.SPDF.model.PipelineOperation;
+
+@Service
+public class PipelineDirectoryProcessor {
+
+    private static final Logger logger = LoggerFactory.getLogger(PipelineDirectoryProcessor.class);
+    @Autowired private ObjectMapper objectMapper;
+    @Autowired private ApiDocService apiDocService;
+    @Autowired private ApplicationProperties applicationProperties;
+
+    final String watchedFoldersDir = "./pipeline/watchedFolders/";
+    final String finishedFoldersDir = "./pipeline/finishedFolders/";
+
+    @Autowired PipelineProcessor processor;
+
+    @Scheduled(fixedRate = 60000)
+    public void scanFolders() {
+        if (!Boolean.TRUE.equals(applicationProperties.getSystem().getEnableAlphaFunctionality())) {
+            return;
+        }
+        Path watchedFolderPath = Paths.get(watchedFoldersDir);
+        if (!Files.exists(watchedFolderPath)) {
+            try {
+                Files.createDirectories(watchedFolderPath);
+                logger.info("Created directory: {}", watchedFolderPath);
+            } catch (IOException e) {
+                logger.error("Error creating directory: {}", watchedFolderPath, e);
+                return;
+            }
+        }
+        try (Stream<Path> paths = Files.walk(watchedFolderPath)) {
+            paths.filter(Files::isDirectory)
+                    .forEach(
+                            t -> {
+                                try {
+                                    if (!t.equals(watchedFolderPath) && !t.endsWith("processing")) {
+                                        handleDirectory(t);
+                                    }
+                                } catch (Exception e) {
+                                    logger.error("Error handling directory: {}", t, e);
+                                }
+                            });
+        } catch (Exception e) {
+            logger.error("Error walking through directory: {}", watchedFolderPath, e);
+        }
+    }
+
+    public void handleDirectory(Path dir) throws IOException {
+        logger.info("Handling directory: {}", dir);
+        Path processingDir = createProcessingDirectory(dir);
+
+        Optional<Path> jsonFileOptional = findJsonFile(dir);
+        if (!jsonFileOptional.isPresent()) {
+            logger.warn("No .JSON settings file found. No processing will happen for dir {}.", dir);
+            return;
+        }
+
+        Path jsonFile = jsonFileOptional.get();
+        PipelineConfig config = readAndParseJson(jsonFile);
+        processPipelineOperations(dir, processingDir, jsonFile, config);
+    }
+
+    private Path createProcessingDirectory(Path dir) throws IOException {
+        Path processingDir = dir.resolve("processing");
+        if (!Files.exists(processingDir)) {
+            Files.createDirectory(processingDir);
+            logger.info("Created processing directory: {}", processingDir);
+        }
+        return processingDir;
+    }
+
+    private Optional<Path> findJsonFile(Path dir) throws IOException {
+        try (Stream<Path> paths = Files.list(dir)) {
+            return paths.filter(file -> file.toString().endsWith(".json")).findFirst();
+        }
+    }
+
+    private PipelineConfig readAndParseJson(Path jsonFile) throws IOException {
+        String jsonString = new String(Files.readAllBytes(jsonFile), StandardCharsets.UTF_8);
+        logger.debug("Reading JSON file: {}", jsonFile);
+        return objectMapper.readValue(jsonString, PipelineConfig.class);
+    }
+
+    private void processPipelineOperations(
+            Path dir, Path processingDir, Path jsonFile, PipelineConfig config) throws IOException {
+        for (PipelineOperation operation : config.getOperations()) {
+            validateOperation(operation);
+            File[] files = collectFilesForProcessing(dir, jsonFile, operation);
+            if (files == null || files.length == 0) {
+                logger.debug("No files detected for {} ", dir);
+                return;
+            }
+            List<File> filesToProcess = prepareFilesForProcessing(files, processingDir);
+            runPipelineAgainstFiles(filesToProcess, config, dir, processingDir);
+        }
+    }
+
+    private void validateOperation(PipelineOperation operation) throws IOException {
+        if (!apiDocService.isValidOperation(operation.getOperation(), operation.getParameters())) {
+            throw new IOException("Invalid operation: " + operation.getOperation());
+        }
+    }
+
+    private File[] collectFilesForProcessing(Path dir, Path jsonFile, PipelineOperation operation)
+            throws IOException {
+        try (Stream<Path> paths = Files.list(dir)) {
+            if ("automated".equals(operation.getParameters().get("fileInput"))) {
+                return paths.filter(path -> !Files.isDirectory(path) && !path.equals(jsonFile))
+                        .map(Path::toFile)
+                        .toArray(File[]::new);
+            } else {
+                String fileInput = (String) operation.getParameters().get("fileInput");
+                return new File[] {new File(fileInput)};
+            }
+        }
+    }
+
+    private List<File> prepareFilesForProcessing(File[] files, Path processingDir)
+            throws IOException {
+        List<File> filesToProcess = new ArrayList<>();
+        for (File file : files) {
+            Path targetPath = resolveUniqueFilePath(processingDir, file.getName());
+            Files.move(file.toPath(), targetPath);
+            filesToProcess.add(targetPath.toFile());
+        }
+        return filesToProcess;
+    }
+
+    private Path resolveUniqueFilePath(Path directory, String originalFileName) {
+        Path filePath = directory.resolve(originalFileName);
+        int counter = 1;
+
+        while (Files.exists(filePath)) {
+            String newName = appendSuffixToFileName(originalFileName, "(" + counter + ")");
+            filePath = directory.resolve(newName);
+            counter++;
+        }
+
+        return filePath;
+    }
+
+    private String appendSuffixToFileName(String originalFileName, String suffix) {
+        int dotIndex = originalFileName.lastIndexOf('.');
+        if (dotIndex == -1) {
+            return originalFileName + suffix;
+        } else {
+            return originalFileName.substring(0, dotIndex)
+                    + suffix
+                    + originalFileName.substring(dotIndex);
+        }
+    }
+
+    private void runPipelineAgainstFiles(
+            List<File> filesToProcess, PipelineConfig config, Path dir, Path processingDir)
+            throws IOException {
+        try {
+            List<Resource> inputFiles =
+                    processor.generateInputFiles(filesToProcess.toArray(new File[0]));
+            if (inputFiles == null || inputFiles.size() == 0) {
+                return;
+            }
+            List<Resource> outputFiles = processor.runPipelineAgainstFiles(inputFiles, config);
+            if (outputFiles == null) return;
+            moveAndRenameFiles(outputFiles, config, dir);
+            deleteOriginalFiles(filesToProcess, processingDir);
+        } catch (Exception e) {
+            logger.error("error during processing", e);
+            moveFilesBack(filesToProcess, processingDir);
+        }
+    }
+
+    private void moveAndRenameFiles(List<Resource> resources, PipelineConfig config, Path dir)
+            throws IOException {
+        for (Resource resource : resources) {
+            String outputFileName = createOutputFileName(resource, config);
+            Path outputPath = determineOutputPath(config, dir);
+
+            if (!Files.exists(outputPath)) {
+                Files.createDirectories(outputPath);
+                logger.info("Created directory: {}", outputPath);
+            }
+
+            Path outputFile = outputPath.resolve(outputFileName);
+            try (OutputStream os = new FileOutputStream(outputFile.toFile())) {
+                os.write(((ByteArrayResource) resource).getByteArray());
+            }
+
+            logger.info("File moved and renamed to {}", outputFile);
+        }
+    }
+
+    private String createOutputFileName(Resource resource, PipelineConfig config) {
+        String resourceName = resource.getFilename();
+        String baseName = resourceName.substring(0, resourceName.lastIndexOf('.'));
+        String extension = resourceName.substring(resourceName.lastIndexOf('.') + 1);
+
+        String outputFileName =
+                config.getOutputPattern()
+                                .replace("{filename}", baseName)
+                                .replace("{pipelineName}", config.getName())
+                                .replace(
+                                        "{date}",
+                                        LocalDate.now()
+                                                .format(DateTimeFormatter.ofPattern("yyyyMMdd")))
+                                .replace(
+                                        "{time}",
+                                        LocalTime.now()
+                                                .format(DateTimeFormatter.ofPattern("HHmmss")))
+                        + "."
+                        + extension;
+
+        return outputFileName;
+    }
+
+    private Path determineOutputPath(PipelineConfig config, Path dir) {
+        String outputDir =
+                config.getOutputDir()
+                        .replace("{outputFolder}", finishedFoldersDir)
+                        .replace("{folderName}", dir.toString())
+                        .replaceAll("\\\\?watchedFolders", "");
+
+        return Paths.get(outputDir).isAbsolute() ? Paths.get(outputDir) : Paths.get(".", outputDir);
+    }
+
+    private void deleteOriginalFiles(List<File> filesToProcess, Path processingDir)
+            throws IOException {
+        for (File file : filesToProcess) {
+            Files.deleteIfExists(processingDir.resolve(file.getName()));
+            logger.info("Deleted original file: {}", file.getName());
+        }
+    }
+
+    private void moveFilesBack(List<File> filesToProcess, Path processingDir) {
+        for (File file : filesToProcess) {
+            try {
+                Files.move(processingDir.resolve(file.getName()), file.toPath());
+                logger.info(
+                        "Moved file back to original location: {} , {}",
+                        file.toPath(),
+                        file.getName());
+            } catch (IOException e) {
+                logger.error("Error moving file back to original location: {}", file.getName(), e);
+            }
+        }
+    }
+}