Merge branch 'main' into codex/create-junit-tests-for-coverage

.github/workflows/PR-Demo-Comment-with-react.yml

@@ -180,7 +180,7 @@ jobs:
           password: ${{ secrets.DOCKER_HUB_API }}
 
       - name: Build and push PR-specific image
-        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
+        uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0
         with:
           context: .
           file: ./Dockerfile

.github/workflows/dependency-review.yml

@@ -24,4 +24,4 @@ jobs:
       - name: "Checkout Repository"
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: "Dependency Review"
-        uses: actions/dependency-review-action@38ecb5b593bf0eb19e335c03f97670f792489a8b # v4.7.0
+        uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9 # v4.7.1

.github/workflows/licenses-update.yml

@@ -38,7 +38,7 @@ jobs:
           java-version: "17"
           distribution: "adopt"
 
-      - uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+      - uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
 
       - name: check the licenses for compatibility
         run: ./gradlew clean checkLicense

.github/workflows/multiOSReleases.yml

@@ -68,7 +68,7 @@ jobs:
           java-version: "21"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+      - uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
         with:
           gradle-version: 8.14
 
@@ -156,7 +156,7 @@ jobs:
           java-version: "21"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+      - uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
         with:
           gradle-version: 8.14
 

.github/workflows/push-docker.yml

@@ -30,7 +30,7 @@ jobs:
           java-version: "17"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+      - uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
         with:
           gradle-version: 8.14
 
@@ -90,7 +90,7 @@ jobs:
 
       - name: Build and push main Dockerfile
         id: build-push-regular
-        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
+        uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0
         with:
           builder: ${{ steps.buildx.outputs.name }}
           context: .
@@ -135,7 +135,7 @@ jobs:
 
       - name: Build and push Dockerfile-ultra-lite
         id: build-push-lite
-        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
+        uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0
         if: github.ref != 'refs/heads/main'
         with:
           context: .
@@ -166,7 +166,7 @@ jobs:
 
       - name: Build and push main Dockerfile fat
         id: build-push-fat
-        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
+        uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0
         if: github.ref != 'refs/heads/main'
         with:
           builder: ${{ steps.buildx.outputs.name }}

.github/workflows/releaseArtifacts.yml

@@ -35,7 +35,7 @@ jobs:
           java-version: "17"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+      - uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
         with:
           gradle-version: 8.14
 

.github/workflows/scorecards.yml

@@ -74,6 +74,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
+        uses: github/codeql-action/upload-sarif@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
         with:
           sarif_file: results.sarif

.github/workflows/sonarqube.yml

@@ -27,7 +27,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+        uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
 
       - name: Build and analyze with Gradle
         env:

.github/workflows/swagger.yml

@@ -26,7 +26,7 @@ jobs:
           java-version: "17"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
+      - uses: gradle/actions/setup-gradle@8379f6a1328ee0e06e2bb424dadb7b159856a326 # v4.4.0
 
       - name: Generate Swagger documentation
         run: ./gradlew generateOpenApiDocs

.github/workflows/testdriver.yml

@@ -46,7 +46,7 @@ jobs:
           password: ${{ secrets.DOCKER_HUB_API }}
 
       - name: Build and push test image
-        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
+        uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0
         with:
           context: .
           file: ./Dockerfile

AGENTS.md

@@ -0,0 +1,24 @@
+# Codex Contribution Guidelines for Stirling-PDF
+
+This file provides high-level instructions for Codex when modifying any files within this repository. Follow these rules to ensure changes remain consistent with the existing project structure.
+
+## 1. Code Style and Formatting
+- Respect the `.editorconfig` settings located in the repository root. Java files use 4 spaces; HTML, JS, and Python generally use 2 spaces. Lines should end with `LF`.
+- Format Java code with `./gradlew spotlessApply` before committing.
+- Review `DeveloperGuide.md` for project structure and design details before making significant changes.
+
+## 2. Testing
+- Run `./gradlew build` before committing changes to ensure the project compiles.
+- If the build cannot complete due to environment restrictions, DO NOT COMMIT THE CHANGE
+
+## 3. Commits
+- Keep commits focused. Group related changes together and provide concise commit messages.
+- Ensure the working tree is clean (`git status`) before concluding your work.
+
+## 4. Pull Requests
+- Summarize what was changed and why. Include build results from `./gradlew build` in the PR description.
+- Note that the code was generated with the assistance of AI.
+
+## 5. Translations
+- Only modify `messages_en_GB.properties` when adding or updating translations.
+

build.gradle

@@ -10,7 +10,7 @@ plugins {
     id "com.github.jk1.dependency-license-report" version "2.9"
     //id "nebula.lint" version "19.0.3"
     id("org.panteleyev.jpackageplugin") version "1.6.1"
-    id "org.sonarqube" version "6.1.0.5360"
+    id "org.sonarqube" version "6.2.0.5505"
 }
 
 import com.github.jk1.license.render.*
@@ -24,7 +24,7 @@ ext {
     imageioVersion = "3.12.0"
     lombokVersion = "1.18.38"
     bouncycastleVersion = "1.80"
-    springSecuritySamlVersion = "6.4.5"
+    springSecuritySamlVersion = "6.5.0"
     openSamlVersion = "4.3.2"
     tempJrePath = null
 }
@@ -434,7 +434,7 @@ dependencies {
     }
 
     //security updates
-    implementation "org.springframework:spring-webmvc:6.2.6"
+    implementation "org.springframework:spring-webmvc:6.2.7"
 
     implementation("io.github.pixee:java-security-toolkit:1.2.1")
 
@@ -459,7 +459,7 @@ dependencies {
         implementation "org.springframework.boot:spring-boot-starter-mail:$springBootVersion"
 
         implementation "org.springframework.session:spring-session-core:3.4.3"
-        implementation "org.springframework:spring-jdbc:6.2.6"
+        implementation "org.springframework:spring-jdbc:6.2.7"
 
         implementation 'com.unboundid.product.scim2:scim2-sdk-client:2.3.5'
         // Don't upgrade h2database
@@ -528,7 +528,7 @@ dependencies {
     implementation "org.bouncycastle:bcprov-jdk18on:$bouncycastleVersion"
     implementation "org.bouncycastle:bcpkix-jdk18on:$bouncycastleVersion"
     implementation "org.springframework.boot:spring-boot-starter-actuator:$springBootVersion"
-    implementation "io.micrometer:micrometer-core:1.14.7"
+    implementation "io.micrometer:micrometer-core:1.15.0"
     implementation group: "com.google.zxing", name: "core", version: "3.5.3"
     // https://mvnrepository.com/artifact/org.commonmark/commonmark
     implementation "org.commonmark:commonmark:0.24.0"
@@ -544,7 +544,7 @@ dependencies {
     annotationProcessor "org.projectlombok:lombok:$lombokVersion"
 
   // Mockito (core)
-    testImplementation 'org.mockito:mockito-core:5.11.0'
+    testImplementation 'org.mockito:mockito-core:5.17.0'
 
     
     testRuntimeOnly 'org.mockito:mockito-inline:5.2.0'

settings.gradle

@@ -1,5 +1,5 @@
 plugins {
     // Apply the foojay-resolver plugin to allow automatic download of JDKs
-    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.10.0'
+    id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0'
 }
 rootProject.name = 'Stirling-PDF'

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

@@ -31,7 +31,8 @@ public class LibreOfficeListener {
         log.info("waiting for listener to start");
         try (Socket socket = new Socket()) {
             socket.connect(
-                    new InetSocketAddress("localhost", 2002), 1000); // Timeout after 1 second
+                    new InetSocketAddress("localhost", LISTENER_PORT),
+                    1000); // Timeout after 1 second
             return true;
         } catch (Exception e) {
             return false;

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

@@ -11,8 +11,11 @@ import org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver;
 import org.thymeleaf.templateresource.FileTemplateResource;
 import org.thymeleaf.templateresource.ITemplateResource;
 
+import lombok.extern.slf4j.Slf4j;
+
 import stirling.software.SPDF.model.InputStreamTemplateResource;
 
+@Slf4j
 public class FileFallbackTemplateResolver extends AbstractConfigurableTemplateResolver {
 
     private final ResourceLoader resourceLoader;
@@ -40,7 +43,8 @@ public class FileFallbackTemplateResolver extends AbstractConfigurableTemplateRe
                 return new FileTemplateResource(resource.getFile().getPath(), characterEncoding);
             }
         } catch (IOException e) {
-
+            // Log the exception to help with debugging issues loading external templates
+            log.warn("Unable to read template '{}' from file system", resourceName, e);
         }
 
         InputStream inputStream =

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

@@ -3,7 +3,6 @@ package stirling.software.SPDF.controller.api;
 import java.io.IOException;
 import java.security.Principal;
 import java.sql.SQLException;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -168,13 +167,23 @@ public class UserController {
 
     @PreAuthorize("!hasAuthority('ROLE_DEMO_USER')")
     @PostMapping("/updateUserSettings")
-    public String updateUserSettings(HttpServletRequest request, Principal principal)
+    /**
+     * Updates the user settings based on the provided JSON payload.
+     *
+     * @param updates A map containing the settings to update. The expected structure is:
+     *                <ul>
+     *                  <li><b>emailNotifications</b> (optional): "true" or "false" - Enable or disable email notifications.</li>
+     *                  <li><b>theme</b> (optional): "light" or "dark" - Set the user's preferred theme.</li>
+     *                  <li><b>language</b> (optional): A string representing the preferred language (e.g., "en", "fr").</li>
+     *                </ul>
+     *                Keys not listed above will be ignored.
+     * @param principal The currently authenticated user.
+     * @return A redirect string to the account page after updating the settings.
+     * @throws SQLException If a database error occurs.
+     * @throws UnsupportedProviderException If the operation is not supported for the user's provider.
+     */
+    public String updateUserSettings(@RequestBody Map<String, String> updates, Principal principal)
             throws SQLException, UnsupportedProviderException {
-        Map<String, String[]> paramMap = request.getParameterMap();
-        Map<String, String> updates = new HashMap<>();
-        for (Map.Entry<String, String[]> entry : paramMap.entrySet()) {
-            updates.put(entry.getKey(), entry.getValue()[0]);
-        }
         log.debug("Processed updates: {}", updates);
         // Assuming you have a method in userService to update the settings for a user
         userService.updateUserSettings(principal.getName(), updates);

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

@@ -93,6 +93,7 @@ public class PipelineProcessor {
         ByteArrayOutputStream logStream = new ByteArrayOutputStream();
         PrintStream logPrintStream = new PrintStream(logStream);
         boolean hasErrors = false;
+        boolean filtersApplied = false;
         for (PipelineOperation pipelineOperation : config.getOperations()) {
             String operation = pipelineOperation.getOperation();
             boolean isMultiInputOperation = apiDocService.isMultiInput(operation);
@@ -134,7 +135,7 @@ public class PipelineProcessor {
                             if (operation.startsWith("filter-")
                                     && (response.getBody() == null
                                             || response.getBody().length == 0)) {
-                                result.setFiltersApplied(true);
+                                filtersApplied = true;
                                 log.info("Skipping file due to filtering {}", operation);
                                 continue;
                             }
@@ -215,12 +216,12 @@ public class PipelineProcessor {
             log.error("Errors occurred during processing. Log: {}", logStream.toString());
         }
         result.setHasErrors(hasErrors);
-        result.setFiltersApplied(hasErrors);
+        result.setFiltersApplied(filtersApplied);
         result.setOutputFiles(outputFiles);
         return result;
     }
 
-    private ResponseEntity<byte[]> sendWebRequest(String url, MultiValueMap<String, Object> body) {
+    /* package */ ResponseEntity<byte[]> sendWebRequest(String url, MultiValueMap<String, Object> body) {
         RestTemplate restTemplate = new RestTemplate();
         // Set up headers, including API key
         HttpHeaders headers = new HttpHeaders();

src/main/java/stirling/software/SPDF/model/InputStreamTemplateResource.java

@@ -39,7 +39,6 @@ public class InputStreamTemplateResource implements ITemplateResource {
 
     @Override
     public boolean exists() {
-        // TODO Auto-generated method stub
-        return false;
+        return inputStream != null;
     }
 }

src/test/java/stirling/software/SPDF/controller/api/pipeline/PipelineProcessorTest.java

@@ -0,0 +1,76 @@
+package stirling.software.SPDF.controller.api.pipeline;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
+
+import java.util.List;
+import java.util.Map;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.core.io.Resource;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+import jakarta.servlet.ServletContext;
+
+import stirling.software.SPDF.model.PipelineConfig;
+import stirling.software.SPDF.model.PipelineOperation;
+import stirling.software.SPDF.model.PipelineResult;
+
+@ExtendWith(MockitoExtension.class)
+class PipelineProcessorTest {
+
+    @Mock
+    ApiDocService apiDocService;
+
+    @Mock
+    UserServiceInterface userService;
+
+    @Mock
+    ServletContext servletContext;
+
+    PipelineProcessor pipelineProcessor;
+
+    @BeforeEach
+    void setUp() {
+        pipelineProcessor = spy(new PipelineProcessor(apiDocService, userService, servletContext));
+    }
+
+    @Test
+    void runPipelineWithFilterSetsFlag() throws Exception {
+        PipelineOperation op = new PipelineOperation();
+        op.setOperation("filter-page-count");
+        op.setParameters(Map.of());
+        PipelineConfig config = new PipelineConfig();
+        config.setOperations(List.of(op));
+
+        Resource file = new ByteArrayResource("data".getBytes()) {
+            @Override
+            public String getFilename() {
+                return "test.pdf";
+            }
+        };
+
+        List<Resource> files = List.of(file);
+
+        when(apiDocService.isMultiInput("filter-page-count")).thenReturn(false);
+        when(apiDocService.getExtensionTypes(false, "filter-page-count")).thenReturn(List.of("pdf"));
+
+        doReturn(new ResponseEntity<>(new byte[0], HttpStatus.OK))
+                .when(pipelineProcessor)
+                .sendWebRequest(anyString(), any());
+
+        PipelineResult result = pipelineProcessor.runPipelineAgainstFiles(files, config);
+
+        assertTrue(result.isFiltersApplied(), "Filter flag should be true when operation filters file");
+        assertFalse(result.isHasErrors(), "No errors should occur");
+        assertTrue(result.getOutputFiles().isEmpty(), "Filtered file list should be empty");
+    }
+}
+