Lots of changes (#1889)

* Add image support to multi-tool page Related to #278 * changes to support image types * final touches * final touches * final touches Signed-off-by: a <a> * final touches Signed-off-by: a <a> * final touches Signed-off-by: a <a> * final touches Signed-off-by: a <a> * final touches Signed-off-by: a <a> * final touches Signed-off-by: a <a> * final touches Signed-off-by: a <a> * Update translation files (#1888) Signed-off-by: GitHub Action <[email protected]> Co-authored-by: GitHub Action <[email protected]> --------- Signed-off-by: a <a> Signed-off-by: GitHub Action <[email protected]> Co-authored-by: a <a> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: GitHub Action <[email protected]>
Stirling-Tools · Sep 13, 2024 · 8c01425 · 8c01425
1 parent 4d47e53
commit 8c01425
Show file tree

Hide file tree

Showing 74 changed files with 735 additions and 758 deletions.
diff --git a/exampleYmlFiles/docker-compose-latest-fat-security.yml b/exampleYmlFiles/docker-compose-latest-fat-security.yml
@@ -1,4 +1,3 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Security-Fat

diff --git a/exampleYmlFiles/docker-compose-latest-security-with-sso.yml b/exampleYmlFiles/docker-compose-latest-security-with-sso.yml
@@ -1,4 +1,3 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Security

diff --git a/exampleYmlFiles/docker-compose-latest-security.yml b/exampleYmlFiles/docker-compose-latest-security.yml
@@ -1,4 +1,3 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Security

diff --git a/exampleYmlFiles/docker-compose-latest-ultra-lite-security.yml b/exampleYmlFiles/docker-compose-latest-ultra-lite-security.yml
@@ -1,4 +1,3 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Ultra-Lite-Security

diff --git a/exampleYmlFiles/docker-compose-latest-ultra-lite.yml b/exampleYmlFiles/docker-compose-latest-ultra-lite.yml
@@ -1,4 +1,3 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Ultra-Lite

diff --git a/exampleYmlFiles/docker-compose-latest.yml b/exampleYmlFiles/docker-compose-latest.yml
@@ -1,4 +1,3 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF

diff --git a/src/main/java/stirling/software/SPDF/EE/EEAppConfig.java b/src/main/java/stirling/software/SPDF/EE/EEAppConfig.java
@@ -0,0 +1,25 @@
+package stirling.software.SPDF.EE;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Lazy;
+
+import stirling.software.SPDF.model.ApplicationProperties;
+
+@Configuration
+@Lazy
+public class EEAppConfig {
+
+    private static final Logger logger = LoggerFactory.getLogger(EEAppConfig.class);
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    @Bean(name = "RunningEE")
+    public boolean runningEnterpriseEdition() {
+        // TODO: Implement EE detection
+        return false;
+    }
+}
diff --git a/src/main/java/stirling/software/SPDF/SPdfApplication.java b/src/main/java/stirling/software/SPDF/SPdfApplication.java
@@ -31,7 +31,6 @@ public class SPdfApplication {
 
     @Autowired private Environment env;
 
-
     @Autowired ApplicationProperties applicationProperties;
 
     private static String serverPortStatic;

diff --git a/src/main/java/stirling/software/SPDF/config/AppConfig.java b/src/main/java/stirling/software/SPDF/config/AppConfig.java
@@ -135,4 +135,29 @@ public Predicate<Path> processOnlyFiles() {
             }
         };
     }
+
+    @Bean(name = "termsAndConditions")
+    public String termsAndConditions() {
+        return applicationProperties.getLegal().getTermsAndConditions();
+    }
+
+    @Bean(name = "privacyPolicy")
+    public String privacyPolicy() {
+        return applicationProperties.getLegal().getPrivacyPolicy();
+    }
+
+    @Bean(name = "cookiePolicy")
+    public String cookiePolicy() {
+        return applicationProperties.getLegal().getCookiePolicy();
+    }
+
+    @Bean(name = "impressum")
+    public String impressum() {
+        return applicationProperties.getLegal().getImpressum();
+    }
+
+    @Bean(name = "accessibilityStatement")
+    public String accessibilityStatement() {
+        return applicationProperties.getLegal().getAccessibilityStatement();
+    }
 }
diff --git a/src/main/java/stirling/software/SPDF/config/AppUpdateService.java b/src/main/java/stirling/software/SPDF/config/AppUpdateService.java
@@ -18,7 +18,7 @@ class AppUpdateService {
     @Bean(name = "shouldShow")
     @Scope("request")
     public boolean shouldShow() {
-        boolean showUpdate = applicationProperties.getSystem().getShowUpdate();
+        boolean showUpdate = applicationProperties.getSystem().isShowUpdate();
         boolean showAdminResult = (showAdmin != null) ? showAdmin.getShowUpdateOnlyAdmins() : true;
         return showUpdate && showAdminResult;
     }

diff --git a/src/main/java/stirling/software/SPDF/config/MetricsFilter.java b/src/main/java/stirling/software/SPDF/config/MetricsFilter.java
@@ -13,6 +13,7 @@
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.SPDF.utils.RequestUriUtils;
 
 @Component
 public class MetricsFilter extends OncePerRequestFilter {
@@ -30,32 +31,16 @@ protected void doFilterInternal(
             throws ServletException, IOException {
         String uri = request.getRequestURI();
 
-        // System.out.println("uri="+uri + ", method=" + request.getMethod() );
-        // Ignore static resources
-        if (!(uri.startsWith("/js")
-                || uri.startsWith("/v1/api-docs")
-                || uri.endsWith("robots.txt")
-                || 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"))) {
+        if (RequestUriUtils.isTrackableResource(request.getContextPath(), uri)) {
 
             Counter counter =
                     Counter.builder("http.requests")
-                            .tag("uri", uri)
+                            .tag("session", request.getSession().getId())
                             .tag("method", request.getMethod())
+                            .tag("uri", uri)
                             .register(meterRegistry);
 
             counter.increment();
-            // System.out.println("Counted");
         }
 
         filterChain.doFilter(request, response);

diff --git a/src/main/java/stirling/software/SPDF/config/PdfMetadataService.java b/src/main/java/stirling/software/SPDF/config/PdfMetadataService.java
@@ -0,0 +1,139 @@
+package stirling.software.SPDF.config;
+
+import java.util.Calendar;
+
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Service;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.controller.api.pipeline.UserServiceInterface;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.PdfMetadata;
+
+@Service
+public class PdfMetadataService {
+
+    private static PdfMetadataService instance;
+
+    private final ApplicationProperties applicationProperties;
+    private final String appVersion;
+    private final UserServiceInterface userService;
+
+    @Autowired
+    public PdfMetadataService(
+            ApplicationProperties applicationProperties,
+            @Qualifier("appVersion") String appVersion,
+            @Autowired(required = false) UserServiceInterface userService) {
+        this.applicationProperties = applicationProperties;
+        this.appVersion = appVersion;
+        this.userService = userService;
+    }
+
+    @PostConstruct
+    public void init() {
+        instance = this;
+    }
+
+    // Static methods for easy access
+
+    public static PdfMetadata extractMetadataFromPdf(PDDocument pdf) {
+        return instance.extractMetadataFromPdfInstance(pdf);
+    }
+
+    public static void setDefaultMetadata(PDDocument pdf) {
+        instance.setDefaultMetadataInstance(pdf);
+    }
+
+    public static void setMetadataToPdf(PDDocument pdf, PdfMetadata pdfMetadata) {
+        instance.setMetadataToPdfInstance(pdf, pdfMetadata);
+    }
+
+    public static void setMetadataToPdf(
+            PDDocument pdf, PdfMetadata pdfMetadata, boolean newlyCreated) {
+        instance.setMetadataToPdfInstance(pdf, pdfMetadata, newlyCreated);
+    }
+
+    // Instance methods
+
+    private PdfMetadata extractMetadataFromPdfInstance(PDDocument pdf) {
+        return PdfMetadata.builder()
+                .author(pdf.getDocumentInformation().getAuthor())
+                .producer(pdf.getDocumentInformation().getProducer())
+                .title(pdf.getDocumentInformation().getTitle())
+                .creator(pdf.getDocumentInformation().getCreator())
+                .subject(pdf.getDocumentInformation().getSubject())
+                .keywords(pdf.getDocumentInformation().getKeywords())
+                .creationDate(pdf.getDocumentInformation().getCreationDate())
+                .modificationDate(pdf.getDocumentInformation().getModificationDate())
+                .build();
+    }
+
+    private void setDefaultMetadataInstance(PDDocument pdf) {
+        PdfMetadata metadata = extractMetadataFromPdfInstance(pdf);
+        setMetadataToPdfInstance(pdf, metadata);
+    }
+
+    private void setMetadataToPdfInstance(PDDocument pdf, PdfMetadata pdfMetadata) {
+        setMetadataToPdfInstance(pdf, pdfMetadata, true);
+    }
+
+    private void setMetadataToPdfInstance(
+            PDDocument pdf, PdfMetadata pdfMetadata, boolean newlyCreated) {
+        if (newlyCreated || pdfMetadata.getCreationDate() == null) {
+            setNewDocumentMetadata(pdf, pdfMetadata);
+        }
+        setCommonMetadata(pdf, pdfMetadata);
+    }
+
+    private void setNewDocumentMetadata(PDDocument pdf, PdfMetadata pdfMetadata) {
+
+        String title = pdfMetadata.getTitle();
+        String creator = "Stirling-PDF";
+
+//        if (applicationProperties
+//                .getEnterpriseEdition()
+//                .getCustomMetadata()
+//                .isAutoUpdateMetadata()) {
+
+            // producer =
+            //
+            // applicationProperties.getEnterpriseEdition().getCustomMetadata().getProducer();
+            // creator =
+            // applicationProperties.getEnterpriseEdition().getCustomMetadata().getCreator();
+            // title = applicationProperties.getEnterpriseEdition().getCustomMetadata().getTitle();
+
+//            if ("{filename}".equals(title)) {
+//                title = "Filename"; // Replace with actual filename logic
+//            } else if ("{unchanged}".equals(title)) {
+//                title = pdfMetadata.getTitle(); // Keep the original title
+//            }
+//        }
+
+        pdf.getDocumentInformation().setTitle(title);
+        pdf.getDocumentInformation().setCreator(creator + " " + appVersion);
+        pdf.getDocumentInformation().setCreationDate(Calendar.getInstance());
+    }
+
+    private void setCommonMetadata(PDDocument pdf, PdfMetadata pdfMetadata) {
+        String producer = "Stirling-PDF";
+        pdf.getDocumentInformation().setProducer(producer + " " + appVersion);
+        pdf.getDocumentInformation().setSubject(pdfMetadata.getSubject());
+        pdf.getDocumentInformation().setKeywords(pdfMetadata.getKeywords());
+        pdf.getDocumentInformation().setModificationDate(Calendar.getInstance());
+
+        String author = pdfMetadata.getAuthor();
+        // if (applicationProperties
+        //        .getEnterpriseEdition()
+        //        .getCustomMetadata()
+        //        .isAutoUpdateMetadata()) {
+        //    author = applicationProperties.getEnterpriseEdition().getCustomMetadata().getAuthor();
+
+        // if (userService != null) {
+        //    author = author.replace("username", userService.getCurrentUsername());
+        // }
+        // }
+        pdf.getDocumentInformation().setAuthor(author);
+    }
+}
diff --git a/src/main/java/stirling/software/SPDF/config/security/AppUpdateAuthService.java b/src/main/java/stirling/software/SPDF/config/security/AppUpdateAuthService.java
@@ -20,7 +20,7 @@ class AppUpdateAuthService implements ShowAdminInterface {
 
     @Override
     public boolean getShowUpdateOnlyAdmins() {
-        boolean showUpdate = applicationProperties.getSystem().getShowUpdate();
+        boolean showUpdate = applicationProperties.getSystem().isShowUpdate();
         if (!showUpdate) {
             return showUpdate;
         }

diff --git a/src/main/java/stirling/software/SPDF/config/security/SecurityConfiguration.java b/src/main/java/stirling/software/SPDF/config/security/SecurityConfiguration.java
@@ -152,8 +152,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
                                             .authenticated());
 
             // Handle OAUTH2 Logins
-            if (applicationProperties.getSecurity().getOAUTH2() != null
-                    && applicationProperties.getSecurity().getOAUTH2().getEnabled()
+            if (applicationProperties.getSecurity().getOauth2() != null
+                    && applicationProperties.getSecurity().getOauth2().getEnabled()
                     && !applicationProperties
                             .getSecurity()
                             .getLoginMethod()
@@ -222,7 +222,7 @@ public ClientRegistrationRepository clientRegistrationRepository() {
     }
 
     private Optional<ClientRegistration> googleClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null || !oauth.getEnabled()) {
             return Optional.empty();
         }
@@ -251,7 +251,7 @@ private Optional<ClientRegistration> googleClientRegistration() {
     }
 
     private Optional<ClientRegistration> keycloakClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null || !oauth.getEnabled()) {
             return Optional.empty();
         }
@@ -275,7 +275,7 @@ private Optional<ClientRegistration> keycloakClientRegistration() {
     }
 
     private Optional<ClientRegistration> githubClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null || !oauth.getEnabled()) {
             return Optional.empty();
         }
@@ -304,7 +304,7 @@ private Optional<ClientRegistration> githubClientRegistration() {
     }
 
     private Optional<ClientRegistration> oidcClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null
                 || oauth.getIssuer() == null
                 || oauth.getIssuer().isEmpty()
@@ -352,7 +352,7 @@ GrantedAuthoritiesMapper userAuthoritiesMapper() {
                             String useAsUsername =
                                     applicationProperties
                                             .getSecurity()
-                                            .getOAUTH2()
+                                            .getOauth2()
                                             .getUseAsUsername();
                             Optional<User> userOpt =
                                     userService.findByUsernameIgnoreCase(

diff --git a/src/main/java/stirling/software/SPDF/config/security/UserAuthenticationFilter.java b/src/main/java/stirling/software/SPDF/config/security/UserAuthenticationFilter.java
@@ -159,7 +159,10 @@ protected boolean shouldNotFilter(HttpServletRequest request) throws ServletExce
         };
 
         for (String pattern : permitAllPatterns) {
-            if (uri.startsWith(pattern) || uri.endsWith(".svg") || uri.endsWith(".png") || uri.endsWith(".ico")) {
+            if (uri.startsWith(pattern)
+                    || uri.endsWith(".svg")
+                    || uri.endsWith(".png")
+                    || uri.endsWith(".ico")) {
                 return true;
             }
         }

diff --git a/src/main/java/stirling/software/SPDF/config/security/UserService.java b/src/main/java/stirling/software/SPDF/config/security/UserService.java
@@ -11,6 +11,7 @@
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.security.core.session.SessionInformation;
 import org.springframework.security.core.userdetails.UserDetails;
 import org.springframework.security.core.userdetails.UsernameNotFoundException;
@@ -342,4 +343,14 @@ public void invalidateUserSessions(String username) {
             }
         }
     }
+
+    public String getCurrentUsername() {
+        Object principal = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
+
+        if (principal instanceof UserDetails) {
+            return ((UserDetails) principal).getUsername();
+        } else {
+            return principal.toString();
+        }
+    }
 }
diff --git a/...irling/software/SPDF/config/security/oauth2/CustomOAuth2AuthenticationSuccessHandler.java b/...irling/software/SPDF/config/security/oauth2/CustomOAuth2AuthenticationSuccessHandler.java
@@ -66,7 +66,7 @@ public void onAuthenticationSuccess(
             // Redirect to the original destination
             super.onAuthenticationSuccess(request, response, authentication);
         } else {
-            OAUTH2 oAuth = applicationProperties.getSecurity().getOAUTH2();
+            OAUTH2 oAuth = applicationProperties.getSecurity().getOauth2();
 
             if (loginAttemptService.isBlocked(username)) {
                 if (session != null) {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,7 +31,6 @@ public class SPdfApplication {

		@Autowired private Environment env;


		@Autowired ApplicationProperties applicationProperties;

		private static String serverPortStatic;
Expand Down