From c2fec0a03039536021429d200f88f4d78b522f2b Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Tue, 16 May 2023 22:44:53 +0100 Subject: [PATCH 01/11] stats and conditionals --- Dockerfile-lite | 22 +++ DockerfileBase-lite | 57 ++++++ build.gradle | 5 + .../SPDF/config/EndpointConfiguration.java | 168 ++++++++++++++++++ .../SPDF/config/EndpointInterceptor.java | 28 +++ .../software/SPDF/config/MetricsConfig.java | 28 +++ .../software/SPDF/config/MetricsFilter.java | 50 ++++++ .../software/SPDF/config/WebMvcConfig.java | 18 ++ src/main/resources/application.properties | 1 + .../resources/templates/fragments/card.html | 2 +- .../resources/templates/fragments/navbar.html | 148 ++++----------- .../templates/fragments/navbarEntry.html | 6 + src/main/resources/templates/home.html | 2 + 13 files changed, 420 insertions(+), 115 deletions(-) create mode 100644 Dockerfile-lite create mode 100644 DockerfileBase-lite create mode 100644 src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java create mode 100644 src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java create mode 100644 src/main/java/stirling/software/SPDF/config/MetricsConfig.java create mode 100644 src/main/java/stirling/software/SPDF/config/MetricsFilter.java create mode 100644 src/main/java/stirling/software/SPDF/config/WebMvcConfig.java create mode 100644 src/main/resources/templates/fragments/navbarEntry.html diff --git a/Dockerfile-lite b/Dockerfile-lite new file mode 100644 index 00000000..1d12a545 --- /dev/null +++ b/Dockerfile-lite @@ -0,0 +1,22 @@ +# Build jbig2enc in a separate stage +FROM frooodle/stirling-pdf-base:beta2 + +# Create scripts folder and copy local scripts +RUN mkdir /scripts +COPY ./scripts/* /scripts/ + +# Copy the application JAR file +COPY build/libs/*.jar app.jar + +# Expose the application port +EXPOSE 8080 + +# Set environment variables +ENV APP_HOME_NAME="Stirling PDF" +#ENV APP_HOME_DESCRIPTION="Personal PDF Website!" +#ENV APP_NAVBAR_NAME="Stirling PDF" + +# Run the application +RUN chmod +x /scripts/init.sh +ENTRYPOINT ["/scripts/init.sh"] +CMD ["java", "-jar", "/app.jar"] diff --git a/DockerfileBase-lite b/DockerfileBase-lite new file mode 100644 index 00000000..ebe3c31b --- /dev/null +++ b/DockerfileBase-lite @@ -0,0 +1,57 @@ +# Build jbig2enc in a separate stage +FROM debian:bullseye-slim as jbig2enc_builder + +RUN apt-get update && \ + apt-get install -y --no-install-recommends \ + git \ + automake \ + autoconf \ + libtool \ + libleptonica-dev \ + pkg-config \ + ca-certificates \ + zlib1g-dev \ + make \ + g++ + +RUN git clone https://github.com/agl/jbig2enc && \ + cd jbig2enc && \ + ./autogen.sh && \ + ./configure && \ + make && \ + make install + + +# Main stage +FROM openjdk:17-jdk-slim AS base +RUN apt-get update && \ + apt-get install -y --no-install-recommends \ + python3-uno \ + python3-pip \ + unoconv \ + pngquant \ + unpaper \ + ocrmypdf && \ + rm -rf /var/lib/apt/lists/* && \ + mkdir /usr/share/tesseract-ocr-original && \ + cp -r /usr/share/tesseract-ocr/* /usr/share/tesseract-ocr-original && \ + rm -rf /usr/share/tesseract-ocr + +# Python packages stage +FROM base AS python-packages +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 && \ + 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 +COPY --from=jbig2enc_builder /usr/local/bin/jbig2 /usr/local/bin/jbig2 \ No newline at end of file diff --git a/build.gradle b/build.gradle index ff8a5f94..61999152 100644 --- a/build.gradle +++ b/build.gradle @@ -24,6 +24,11 @@ dependencies { //general PDF implementation 'org.apache.pdfbox:pdfbox:2.0.28' + + + implementation 'org.springframework.boot:spring-boot-starter-actuator' + implementation 'io.micrometer:micrometer-core' + developmentOnly("org.springframework.boot:spring-boot-devtools") } diff --git a/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java b/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java new file mode 100644 index 00000000..b0aa3ed6 --- /dev/null +++ b/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java @@ -0,0 +1,168 @@ +package stirling.software.SPDF.config; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +import org.springframework.stereotype.Service; + +@Service +public class EndpointConfiguration { + + private Map endpointStatuses = new ConcurrentHashMap<>(); + private Map> endpointGroups = new ConcurrentHashMap<>(); + + public EndpointConfiguration() { + init(); + processEnvironmentConfigs(); + } + + public void enableEndpoint(String endpoint) { + endpointStatuses.put(endpoint, true); + } + + public void disableEndpoint(String endpoint) { + endpointStatuses.put(endpoint, false); + } + + public boolean isEndpointEnabled(String endpoint) { + if (endpoint.startsWith("/")) { + endpoint = endpoint.substring(1); + } + return endpointStatuses.getOrDefault(endpoint, true); + } + + public void addEndpointToGroup(String group, String endpoint) { + endpointGroups.computeIfAbsent(group, k -> new HashSet<>()).add(endpoint); + } + + public void enableGroup(String group) { + Set endpoints = endpointGroups.get(group); + if (endpoints != null) { + for (String endpoint : endpoints) { + enableEndpoint(endpoint); + } + } + } + + public void disableGroup(String group) { + Set endpoints = endpointGroups.get(group); + if (endpoints != null) { + for (String endpoint : endpoints) { + disableEndpoint(endpoint); + } + } + } + + public void init() { + // Adding endpoints to "PageOps" group + addEndpointToGroup("PageOps", "remove-pages"); + addEndpointToGroup("PageOps", "merge-pdfs"); + addEndpointToGroup("PageOps", "split-pdfs"); + addEndpointToGroup("PageOps", "pdf-organizer"); + addEndpointToGroup("PageOps", "rotate-pdf"); + + // Adding endpoints to "Convert" group + addEndpointToGroup("Convert", "pdf-to-img"); + addEndpointToGroup("Convert", "img-to-pdf"); + addEndpointToGroup("Convert", "pdf-to-pdfa"); + addEndpointToGroup("Convert", "file-to-pdf"); + addEndpointToGroup("Convert", "xlsx-to-pdf"); + addEndpointToGroup("Convert", "pdf-to-word"); + addEndpointToGroup("Convert", "pdf-to-presentation"); + addEndpointToGroup("Convert", "pdf-to-text"); + addEndpointToGroup("Convert", "pdf-to-html"); + addEndpointToGroup("Convert", "pdf-to-xml"); + + // Adding endpoints to "Security" group + addEndpointToGroup("Security", "add-password"); + addEndpointToGroup("Security", "remove-password"); + addEndpointToGroup("Security", "change-permissions"); + addEndpointToGroup("Security", "add-watermark"); + + // Adding endpoints to "Other" group + addEndpointToGroup("Other", "ocr-pdf"); + addEndpointToGroup("Other", "add-image"); + addEndpointToGroup("Other", "compress-pdf"); + addEndpointToGroup("Other", "extract-images"); + addEndpointToGroup("Other", "change-metadata"); + addEndpointToGroup("Other", "extract-image-scans"); + addEndpointToGroup("Other", "sign"); + addEndpointToGroup("Other", "flatten"); + addEndpointToGroup("Other", "repair"); + addEndpointToGroup("Other", "remove-blanks"); + addEndpointToGroup("Other", "compare"); + + + + + + + + //CLI + addEndpointToGroup("CLI", "compress-pdf"); + addEndpointToGroup("CLI", "extract-image-scans"); + addEndpointToGroup("CLI", "remove-blanks"); + addEndpointToGroup("CLI", "repair"); + addEndpointToGroup("CLI", "pdf-to-pdfa"); + addEndpointToGroup("CLI", "file-to-pdf"); + addEndpointToGroup("CLI", "xlsx-to-pdf"); + addEndpointToGroup("CLI", "pdf-to-word"); + addEndpointToGroup("CLI", "pdf-to-presentation"); + addEndpointToGroup("CLI", "pdf-to-text"); + addEndpointToGroup("CLI", "pdf-to-html"); + addEndpointToGroup("CLI", "pdf-to-xml"); + + //python + addEndpointToGroup("Python", "extract-image-scans"); + addEndpointToGroup("Python", "remove-blanks"); + + + + //openCV + addEndpointToGroup("OpenCV", "extract-image-scans"); + addEndpointToGroup("OpenCV", "remove-blanks"); + + //LibreOffice + addEndpointToGroup("LibreOffice", "repair"); + addEndpointToGroup("LibreOffice", "file-to-pdf"); + addEndpointToGroup("LibreOffice", "xlsx-to-pdf"); + addEndpointToGroup("LibreOffice", "pdf-to-word"); + addEndpointToGroup("LibreOffice", "pdf-to-presentation"); + addEndpointToGroup("LibreOffice", "pdf-to-text"); + addEndpointToGroup("LibreOffice", "pdf-to-html"); + addEndpointToGroup("LibreOffice", "pdf-to-xml"); + + + //OCRmyPDF + addEndpointToGroup("OCRmyPDF", "compress-pdf"); + addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa"); + + disableEndpoint("remove-pages"); + disableEndpoint("compress-pdf"); + } + + private void processEnvironmentConfigs() { + String endpointsToRemove = System.getenv("ENDPOINTS_TO_REMOVE"); + String groupsToRemove = System.getenv("GROUPS_TO_REMOVE"); + + if (endpointsToRemove != null) { + String[] endpoints = endpointsToRemove.split(","); + for (String endpoint : endpoints) { + disableEndpoint(endpoint.trim()); + } + } + + if (groupsToRemove != null) { + String[] groups = groupsToRemove.split(","); + for (String group : groups) { + disableGroup(group.trim()); + } + } + } + +} + diff --git a/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java b/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java new file mode 100644 index 00000000..4e560148 --- /dev/null +++ b/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java @@ -0,0 +1,28 @@ +package stirling.software.SPDF.config; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; +import org.springframework.web.servlet.HandlerInterceptor; + +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; + +@Component +public class EndpointInterceptor implements HandlerInterceptor { + + @Autowired + private EndpointConfiguration endpointConfiguration; + + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) + throws Exception { + String requestURI = request.getRequestURI(); + System.out.println("trying " + requestURI); + if (!endpointConfiguration.isEndpointEnabled(requestURI)) { + response.sendError(HttpServletResponse.SC_FORBIDDEN, "This endpoint is disabled"); + return false; + } + return true; + } +} + diff --git a/src/main/java/stirling/software/SPDF/config/MetricsConfig.java b/src/main/java/stirling/software/SPDF/config/MetricsConfig.java new file mode 100644 index 00000000..c80acba4 --- /dev/null +++ b/src/main/java/stirling/software/SPDF/config/MetricsConfig.java @@ -0,0 +1,28 @@ +package stirling.software.SPDF.config; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.stereotype.Component; +import org.springframework.web.filter.OncePerRequestFilter; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.Meter; +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.config.MeterFilter; +import io.micrometer.core.instrument.config.MeterFilterReply; + +@Configuration +public class MetricsConfig { + + @Bean + public MeterFilter meterFilter() { + return new MeterFilter() { + @Override + public MeterFilterReply accept(Meter.Id id) { + if (id.getName().equals("http.requests") || id.getName().equals("health")) { + return MeterFilterReply.NEUTRAL; + } + return MeterFilterReply.DENY; + } + }; + } +} \ No newline at end of file diff --git a/src/main/java/stirling/software/SPDF/config/MetricsFilter.java b/src/main/java/stirling/software/SPDF/config/MetricsFilter.java new file mode 100644 index 00000000..57b9272c --- /dev/null +++ b/src/main/java/stirling/software/SPDF/config/MetricsFilter.java @@ -0,0 +1,50 @@ +package stirling.software.SPDF.config; + +import java.io.IOException; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Bean; +import org.springframework.stereotype.Component; +import org.springframework.web.filter.OncePerRequestFilter; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.Meter; +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.config.MeterFilter; +import io.micrometer.core.instrument.config.MeterFilterReply; +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; + +@Component +public class MetricsFilter extends OncePerRequestFilter { + + private final MeterRegistry meterRegistry; + + @Autowired + public MetricsFilter(MeterRegistry meterRegistry) { + this.meterRegistry = meterRegistry; + } + + @Override + protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) + throws ServletException, IOException { + String uri = request.getRequestURI(); + + // Ignore static resources + if (!(uri.startsWith("/css") || uri.startsWith("/js") || uri.startsWith("/images") || uri.endsWith(".ico") || uri.endsWith(".svg")|| uri.endsWith(".js"))) { + Counter counter = Counter.builder("http.requests") + .tag("uri", uri) + .tag("method", request.getMethod()) + .register(meterRegistry); + + counter.increment(); + } + + filterChain.doFilter(request, response); + } + + + +} diff --git a/src/main/java/stirling/software/SPDF/config/WebMvcConfig.java b/src/main/java/stirling/software/SPDF/config/WebMvcConfig.java new file mode 100644 index 00000000..610b11c0 --- /dev/null +++ b/src/main/java/stirling/software/SPDF/config/WebMvcConfig.java @@ -0,0 +1,18 @@ +package stirling.software.SPDF.config; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.InterceptorRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Configuration +public class WebMvcConfig implements WebMvcConfigurer { + + @Autowired + private EndpointInterceptor endpointInterceptor; + + @Override + public void addInterceptors(InterceptorRegistry registry) { + registry.addInterceptor(endpointInterceptor); + } +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index e52ba67a..2e577acb 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -23,3 +23,4 @@ spring.devtools.restart.enabled=true spring.devtools.livereload.enabled=true spring.thymeleaf.encoding=UTF-8 + diff --git a/src/main/resources/templates/fragments/card.html b/src/main/resources/templates/fragments/card.html index eef6c82e..faa816a4 100644 --- a/src/main/resources/templates/fragments/card.html +++ b/src/main/resources/templates/fragments/card.html @@ -1,4 +1,4 @@ -
+
Icon diff --git a/src/main/resources/templates/fragments/navbar.html b/src/main/resources/templates/fragments/navbar.html index ff921f52..d4d0a3cf 100644 --- a/src/main/resources/templates/fragments/navbar.html +++ b/src/main/resources/templates/fragments/navbar.html @@ -151,26 +151,12 @@ function compareVersions(version1, version2) {
- - icon - - - - icon - - - - icon - - - - icon - - - - icon - - +
+
+
+
+
+
  • @@ -181,56 +167,18 @@ function compareVersions(version1, version2) {
    - - icon - - - - icon - - -
    - - - - icon - - - - - - icon - - - +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + - - icon - -     - - - - icon - - - - - - icon - - - - - icon - - - - - icon - - -
    @@ -243,18 +191,11 @@ function compareVersions(version1, version2) { icon
    - - icon - - - icon - - - icon - - - icon - +
    +
    +
    +
    +
    @@ -266,39 +207,18 @@ function compareVersions(version1, version2) {
    - - icon - - - icon - - - icon - - - icon - - - icon - - - icon - - - icon - - - icon - - - icon - - - icon - - - icon - +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    diff --git a/src/main/resources/templates/fragments/navbarEntry.html b/src/main/resources/templates/fragments/navbarEntry.html new file mode 100644 index 00000000..6fd9ba9e --- /dev/null +++ b/src/main/resources/templates/fragments/navbarEntry.html @@ -0,0 +1,6 @@ + diff --git a/src/main/resources/templates/home.html b/src/main/resources/templates/home.html index 97d311bf..5689eaab 100644 --- a/src/main/resources/templates/home.html +++ b/src/main/resources/templates/home.html @@ -88,6 +88,8 @@ filter: invert(0.2) sepia(2) saturate(50) hue-rotate(190deg);
    + +
    From 6fa6f3d1dcf239643749c0d85ed870e7746d3358 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Wed, 17 May 2023 01:05:24 +0100 Subject: [PATCH 02/11] Merge remote-tracking branch 'origin/main' into conditional --- README.md | 19 ++++++++++--------- ...operties.txt => messages_sv_SE.properties} | 0 2 files changed, 10 insertions(+), 9 deletions(-) rename src/main/resources/{messages_sv_SE.properties.txt => messages_sv_SE.properties} (100%) diff --git a/README.md b/README.md index 8eed8c86..3fd15164 100644 --- a/README.md +++ b/README.md @@ -106,14 +106,15 @@ Please view https://github.com/Frooodle/Stirling-PDF/blob/main/HowToUseOCR.md ## Want to add your own language? Stirling PDF currently supports -- English -- Arabic (العربية) -- German (Deutsch) -- French (Français) -- Spanish (Español) -- Chinese (简体中文) -- Catalan (Català) -- Italian (Italiano) +- English (English) (en_GB) +- Arabic (العربية) (ar_AR) +- German (Deutsch) (de_DE) +- French (Français) (fr_FR) +- Spanish (Español) (es_ES) +- Chinese (简体中文) (it_IT) +- Catalan (Català) (zh_CN) +- Italian (Italiano) (ca_CA) +- Swedish (Svenska) (sv_SE) If you want to add your own language to Stirling-PDF please refer https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md @@ -133,7 +134,7 @@ Simply use environment variables APP_HOME_NAME, APP_HOME_DESCRIPTION and APP_NAV If running Java directly, you can also pass these as properties using -D arguments. Using the same method you can also change -- The default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR to select your default language (Will always default to English on invalid locale) +- The default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR (Note the - character not _ ) to select your default language (Will always default to English on invalid locale) Current accepted locales can be seen above - Enable/Disable search engine visablility with ALLOW_GOOGLE_VISABILITY with true / false values. Default disable visability. - Change root URI for Stirling-PDF ie change server.com/ to server.com/pdf-app by running APP_ROOT_PATH as pdf-app diff --git a/src/main/resources/messages_sv_SE.properties.txt b/src/main/resources/messages_sv_SE.properties similarity index 100% rename from src/main/resources/messages_sv_SE.properties.txt rename to src/main/resources/messages_sv_SE.properties From 1a9329d1dfc19c2e2a082a8a0dffec5a6e7dee35 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Wed, 17 May 2023 17:59:28 +0100 Subject: [PATCH 03/11] other endpoints --- groups.md | 32 +++++++++++++++ groups2.md | 12 ++++++ .../SPDF/config/EndpointConfiguration.java | 23 ++++++++++- .../resources/templates/fragments/navbar.html | 41 ++++++++++--------- 4 files changed, 86 insertions(+), 22 deletions(-) create mode 100644 groups.md create mode 100644 groups2.md diff --git a/groups.md b/groups.md new file mode 100644 index 00000000..9feb2e27 --- /dev/null +++ b/groups.md @@ -0,0 +1,32 @@ +Operation | PageOps | Convert | Security | Other | CLI | Python | OpenCV | LibreOffice | OCRmyPDF | Java | Javascript +--------------------|---------|---------|----------|-------|------|--------|--------|-------------|--------- |-------- |----------- +remove-pages | X | | | | | | | | | X | +merge-pdfs | X | | | | | | | | | X | +split-pdfs | X | | | | | | | | | X | +pdf-organizer | X | | | | | | | | | X | X +rotate-pdf | X | | | | | | | | | X | +pdf-to-img | | X | | | | | | | | X | +img-to-pdf | | X | | | | | | | | X | +pdf-to-pdfa | | X | | | X | | | | X | | +file-to-pdf | | X | | | X | | | X | | | +xlsx-to-pdf | | X | | | X | | | X | | | +pdf-to-word | | X | | | X | | | X | | | +pdf-to-presentation | | X | | | X | | | X | | | +pdf-to-text | | X | | | X | | | X | | | +pdf-to-html | | X | | | X | | | X | | | +pdf-to-xml | | X | | | X | | | X | | | +add-password | | | X | | | | | | | X | +remove-password | | | X | | | | | | | X | +change-permissions | | | X | | | | | | | X | +add-watermark | | | X | | | | | | | X | +ocr-pdf | | | | X | X | | | | X | | +add-image | | | | X | | | | | | X | +compress-pdf | | | | X | X | | | | X +extract-images | | | | X | | | | | | X | +change-metadata | | | | X | | | | | | X | +extract-image-scans | | | | X | X | X | X | | | | +sign | | | | X | | | | | | | X +flatten | | | | X | | | | | | | +repair | | | | X | X | | | X | | | +remove-blanks | | | | X | X | X | X | | | | +compare | | | | X | | | | | | | X diff --git a/groups2.md b/groups2.md new file mode 100644 index 00000000..1f83f183 --- /dev/null +++ b/groups2.md @@ -0,0 +1,12 @@ +X | remove-pages | merge-pdfs | split-pdfs | pdf-organizer | rotate-pdf | pdf-to-img | img-to-pdf | pdf-to-pdfa | file-to-pdf | xlsx-to-pdf | pdf-to-word | pdf-to-presentation | pdf-to-text | pdf-to-html | pdf-to-xml | add-password | remove-password | change-permissions | add-watermark | ocr-pdf | add-image | compress-pdf | extract-images | change-metadata | extract-image-scans | sign | flatten | repair | remove-blanks | compare +-------------------|--------------|------------|------------|---------------|------------|------------|------------|-------------|-------------|-------------|-------------|---------------------|-------------|-------------|-------------|--------------|-----------------|-------------------|--------------|--------|-----------|--------------|---------------|----------------|-------------------|-----|---------|--------|--------------|-------- +PageOps | X | X | X | X | X | | | | | | | | | | | | | | | | | | | | | | | | | +Convert | | | | | | X | X | X | X | X | X | X | X | X | X | | | | | | | | | | | | | | | +Security | | | | | | | | | | | | | | | | X | X | X | X | | | | | | | | | | | +Other | | | | | | | | | | | | | | | | | | | | X | X | X | X | X | X | X | X | X | X | X +CLI | | | | | | | | X | X | X | X | X | X | X | X | | | | | X | | X | | | X | +OpenCV | | | | | | | | | | | | | | | | | | | | | | | | | X | +LibreOffice | | | | | | | | | X | X | X | X | X | X | X | | | | | | | | | | | +OCRmyPDF | | | | | | | | X | | | | | | | | | | | | X | | X | | | | +Java | X | X | X | X | X | X | X | | | | | | | | | X | X | X | X | | X | | X | X | | +Javascript | | | | X | | | | | | | | | | | | | | | | | | | | | | X | | | | X diff --git a/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java b/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java index b0aa3ed6..b2a372e5 100644 --- a/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java +++ b/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java @@ -141,8 +141,27 @@ public class EndpointConfiguration { addEndpointToGroup("OCRmyPDF", "compress-pdf"); addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa"); - disableEndpoint("remove-pages"); - disableEndpoint("compress-pdf"); + //Java + addEndpointToGroup("Java", "merge-pdfs"); + addEndpointToGroup("Java", "remove-pages"); + addEndpointToGroup("Java", "split-pdfs"); + addEndpointToGroup("Java", "pdf-organizer"); + addEndpointToGroup("Java", "rotate-pdf"); + addEndpointToGroup("Java", "pdf-to-img"); + addEndpointToGroup("Java", "img-to-pdf"); + addEndpointToGroup("Java", "add-password"); + addEndpointToGroup("Java", "remove-password"); + addEndpointToGroup("Java", "change-permissions"); + addEndpointToGroup("Java", "add-watermark"); + addEndpointToGroup("Java", "add-image"); + addEndpointToGroup("Java", "extract-images"); + addEndpointToGroup("Java", "change-metadata"); + + + //Javascript + addEndpointToGroup("Javascript", "pdf-organizer"); + addEndpointToGroup("Javascript", "sign"); + addEndpointToGroup("Javascript", "compare"); } private void processEnvironmentConfigs() { diff --git a/src/main/resources/templates/fragments/navbar.html b/src/main/resources/templates/fragments/navbar.html index ae524d79..6c2b7b70 100644 --- a/src/main/resources/templates/fragments/navbar.html +++ b/src/main/resources/templates/fragments/navbar.html @@ -247,38 +247,39 @@ function compareVersions(version1, version2) {
    - - icon English - icon العربية - - icon Deutsch - - - icon Français - - - icon Español - - - icon Italiano - - - icon 简体中文 - icon Català - - icon Svenska + + icon 简体中文 + + + icon Deutsch + + + icon English + + + icon Español + + + icon Français + + + icon Italiano icon Polski + + icon Svenska +
    +
  • From 479dcb18b3efa8fd73d14723f15cbbfb6f38f2e3 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Wed, 17 May 2023 18:16:39 +0100 Subject: [PATCH 04/11] readme stuff --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3fd15164..77d1c49d 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,11 @@ This is a powerful locally hosted web based PDF manipulation tool using docker that allows you to perform various operations on PDF files, such as splitting merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application started as a 100% ChatGPT-made application and has evolved to include a wide range of features to handle all your PDF needs. +Stirling PDF makes no outbount 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) @@ -42,6 +47,7 @@ Feel free to request any features or bug fixes either in github issues or our [D - Parallel file processing and downloads - API for integration with external scripts +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) Hosted instance/demo of the app can be seen [here](https://pdf.adminforge.de/) hosted by the team at adminforge.de ## Technologies used @@ -115,6 +121,7 @@ Stirling PDF currently supports - Catalan (Català) (zh_CN) - Italian (Italiano) (ca_CA) - Swedish (Svenska) (sv_SE) +- Polish (Polski) (pl_PL) If you want to add your own language to Stirling-PDF please refer https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md @@ -134,10 +141,13 @@ Simply use environment variables APP_HOME_NAME, APP_HOME_DESCRIPTION and APP_NAV If running Java directly, you can also pass these as properties using -D arguments. Using the same method you can also change -- The default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR (Note the - character not _ ) to select your default language (Will always default to English on invalid locale) Current accepted locales can be seen above +- The default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR (Note the - character not _ ) to select your default language (Will always default to English on invalid locale) Current accepted locales can be seen above in the Want to add your own language section - Enable/Disable search engine visablility with ALLOW_GOOGLE_VISABILITY with true / false values. Default disable visability. - Change root URI for Stirling-PDF ie change server.com/ to server.com/pdf-app by running APP_ROOT_PATH as pdf-app +- Disable and remove endpoints and functionality from Stirling-PDF. Currently the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma seperated 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) +tring endpointsToRemove = System.getenv("ENDPOINTS_TO_REMOVE"); + String groupsToRemove = System.getenv("GROUPS_TO_REMOVE"); ## API For those wanting to use Stirling-PDFs backend API to link with their own custom scripting to edit PDFs you can view all existing API documentation [here](https://app.swaggerhub.com/apis-docs/Frooodle/Stirling-PDF/) or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation From 54e7998bf7f3d9bab7449e45e1df7baa01414c3f Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Wed, 17 May 2023 18:17:11 +0100 Subject: [PATCH 05/11] remove --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 77d1c49d..b7ee77a3 100644 --- a/README.md +++ b/README.md @@ -146,8 +146,7 @@ Using the same method you can also change - Change root URI for Stirling-PDF ie change server.com/ to server.com/pdf-app by running APP_ROOT_PATH as pdf-app - Disable and remove endpoints and functionality from Stirling-PDF. Currently the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma seperated 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) -tring endpointsToRemove = System.getenv("ENDPOINTS_TO_REMOVE"); - String groupsToRemove = System.getenv("GROUPS_TO_REMOVE"); + ## API For those wanting to use Stirling-PDFs backend API to link with their own custom scripting to edit PDFs you can view all existing API documentation [here](https://app.swaggerhub.com/apis-docs/Frooodle/Stirling-PDF/) or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation From 320f56e473ed2f9496c9b9532c4a7cd987ae1851 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Wed, 17 May 2023 23:58:15 +0100 Subject: [PATCH 06/11] lots of stuff --- Dockerfile-lite | 4 +- Dockerfile-ultralite | 14 ++++ DockerfileBase | 8 +- .../SPDF/config/EndpointConfiguration.java | 7 +- .../SPDF/config/EndpointInterceptor.java | 4 +- .../software/SPDF/config/MetricsConfig.java | 2 +- .../software/SPDF/config/MetricsFilter.java | 2 +- .../controller/web/MetricsController.java | 80 +++++++++++++++++++ src/main/resources/application.properties | 3 +- .../resources/templates/fragments/navbar.html | 75 ++++++++++------- 10 files changed, 153 insertions(+), 46 deletions(-) create mode 100644 Dockerfile-ultralite create mode 100644 src/main/java/stirling/software/SPDF/controller/web/MetricsController.java diff --git a/Dockerfile-lite b/Dockerfile-lite index 1d12a545..8cd84c8d 100644 --- a/Dockerfile-lite +++ b/Dockerfile-lite @@ -12,9 +12,7 @@ COPY build/libs/*.jar app.jar EXPOSE 8080 # Set environment variables -ENV APP_HOME_NAME="Stirling PDF" -#ENV APP_HOME_DESCRIPTION="Personal PDF Website!" -#ENV APP_NAVBAR_NAME="Stirling PDF" +ENV GROUPS_TO_REMOVE=LibreOffice # Run the application RUN chmod +x /scripts/init.sh diff --git a/Dockerfile-ultralite b/Dockerfile-ultralite new file mode 100644 index 00000000..2c87caf7 --- /dev/null +++ b/Dockerfile-ultralite @@ -0,0 +1,14 @@ +# Build jbig2enc in a separate stage +FROM openjdk:17-jdk-slim + +# Copy the application JAR file +COPY build/libs/*.jar app.jar + +# Expose the application port +EXPOSE 8080 + +# Set environment variables +ENV GROUPS_TO_REMOVE=LibreOffice,CLI + +# Run the application +CMD ["java", "-jar", "/app.jar"] diff --git a/DockerfileBase b/DockerfileBase index fc5399af..876b5a10 100644 --- a/DockerfileBase +++ b/DockerfileBase @@ -26,11 +26,11 @@ RUN git clone https://github.com/agl/jbig2enc && \ FROM openjdk:17-jdk-slim AS base RUN apt-get update && \ apt-get install -y --no-install-recommends \ - libreoffice-core \ + libreoffice-core-nogui \ libreoffice-common \ - libreoffice-writer \ - libreoffice-calc \ - libreoffice-impress \ + libreoffice-writer-nogui \ + libreoffice-calc-nogui \ + libreoffice-impress-nogui \ python3-uno \ python3-pip \ unoconv \ diff --git a/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java b/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java index b2a372e5..a81a9130 100644 --- a/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java +++ b/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java @@ -7,11 +7,12 @@ import java.util.Map.Entry; import java.util.Set; import java.util.concurrent.ConcurrentHashMap; +import org.slf4j.LoggerFactory; import org.springframework.stereotype.Service; - +import org.slf4j.Logger; @Service public class EndpointConfiguration { - + private static final Logger logger = LoggerFactory.getLogger(EndpointConfiguration.class); private Map endpointStatuses = new ConcurrentHashMap<>(); private Map> endpointGroups = new ConcurrentHashMap<>(); @@ -25,6 +26,7 @@ public class EndpointConfiguration { } public void disableEndpoint(String endpoint) { + logger.info("Disabling {}", endpoint); endpointStatuses.put(endpoint, false); } @@ -162,6 +164,7 @@ public class EndpointConfiguration { addEndpointToGroup("Javascript", "pdf-organizer"); addEndpointToGroup("Javascript", "sign"); addEndpointToGroup("Javascript", "compare"); + } private void processEnvironmentConfigs() { diff --git a/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java b/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java index 4e560148..5befd511 100644 --- a/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java +++ b/src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java @@ -17,12 +17,10 @@ public class EndpointInterceptor implements HandlerInterceptor { public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String requestURI = request.getRequestURI(); - System.out.println("trying " + requestURI); if (!endpointConfiguration.isEndpointEnabled(requestURI)) { response.sendError(HttpServletResponse.SC_FORBIDDEN, "This endpoint is disabled"); return false; } return true; } -} - +} \ No newline at end of file diff --git a/src/main/java/stirling/software/SPDF/config/MetricsConfig.java b/src/main/java/stirling/software/SPDF/config/MetricsConfig.java index c80acba4..928a3868 100644 --- a/src/main/java/stirling/software/SPDF/config/MetricsConfig.java +++ b/src/main/java/stirling/software/SPDF/config/MetricsConfig.java @@ -18,7 +18,7 @@ public class MetricsConfig { return new MeterFilter() { @Override public MeterFilterReply accept(Meter.Id id) { - if (id.getName().equals("http.requests") || id.getName().equals("health")) { + if (id.getName().equals("http.requests")) { return MeterFilterReply.NEUTRAL; } return MeterFilterReply.DENY; diff --git a/src/main/java/stirling/software/SPDF/config/MetricsFilter.java b/src/main/java/stirling/software/SPDF/config/MetricsFilter.java index 57b9272c..2407b649 100644 --- a/src/main/java/stirling/software/SPDF/config/MetricsFilter.java +++ b/src/main/java/stirling/software/SPDF/config/MetricsFilter.java @@ -33,7 +33,7 @@ public class MetricsFilter extends OncePerRequestFilter { String uri = request.getRequestURI(); // Ignore static resources - if (!(uri.startsWith("/css") || uri.startsWith("/js") || uri.startsWith("/images") || uri.endsWith(".ico") || uri.endsWith(".svg")|| uri.endsWith(".js"))) { + if (!(uri.startsWith("/js") || uri.startsWith("/images") || 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()) diff --git a/src/main/java/stirling/software/SPDF/controller/web/MetricsController.java b/src/main/java/stirling/software/SPDF/controller/web/MetricsController.java new file mode 100644 index 00000000..97d6db93 --- /dev/null +++ b/src/main/java/stirling/software/SPDF/controller/web/MetricsController.java @@ -0,0 +1,80 @@ +package stirling.software.SPDF.controller.web; +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.Meter; +import io.micrometer.core.instrument.MeterRegistry; +import io.swagger.v3.oas.annotations.Operation; + +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("/api/v1") +public class MetricsController { + + private final MeterRegistry meterRegistry; + + public MetricsController(MeterRegistry meterRegistry) { + this.meterRegistry = meterRegistry; + } + + @GetMapping("/status") + @Operation(summary = "Application status and version", + description = "This endpoint returns the status of the application and its version number.") + public Map getStatus() { + Map status = new HashMap<>(); + status.put("status", "UP"); + status.put("version", getClass().getPackage().getImplementationVersion()); + return status; + } + + @GetMapping("/loads") + @Operation(summary = "GET request count", + description = "This endpoint returns the total count of GET requests or the count of GET requests for a specific endpoint.") + public Double getPageLoads(@RequestParam Optional endpoint) { + try { + double count = 0.0; + + for (Meter meter : meterRegistry.getMeters()) { + if (meter.getId().getName().equals("http.requests")) { + String method = meter.getId().getTag("method"); + if (method != null && method.equals("GET")) { + if (meter instanceof Counter) { + count += ((Counter) meter).count(); + } + } + } + } + + return count; + } catch (Exception e) { + return -1.0; + } + } + + @GetMapping("/requests") + @Operation(summary = "POST request count", + description = "This endpoint returns the total count of POST requests or the count of POST requests for a specific endpoint.") + public Double getTotalRequests(@RequestParam Optional endpoint) { + try { + Counter counter; + if (endpoint.isPresent()) { + counter = meterRegistry.get("http.requests") + .tags("method", "POST", "uri", endpoint.get()).counter(); + } else { + counter = meterRegistry.get("http.requests") + .tags("method", "POST").counter(); + } + return counter.count(); + } catch (Exception e) { + return -1.0; + } + + } + +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 2e577acb..6130f481 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -22,5 +22,4 @@ server.servlet.context-path=${APP_ROOT_PATH:/} spring.devtools.restart.enabled=true spring.devtools.livereload.enabled=true -spring.thymeleaf.encoding=UTF-8 - +spring.thymeleaf.encoding=UTF-8 \ No newline at end of file diff --git a/src/main/resources/templates/fragments/navbar.html b/src/main/resources/templates/fragments/navbar.html index 6c2b7b70..cdebcfca 100644 --- a/src/main/resources/templates/fragments/navbar.html +++ b/src/main/resources/templates/fragments/navbar.html @@ -151,11 +151,11 @@ function compareVersions(version1, version2) {
    -
    -
    -
    -
    -
    +
    +
    +
    +
    +
    • @@ -167,16 +167,16 @@ function compareVersions(version1, version2) {
    -
    -
    +
    +
    -
    -
    -
    -
    -
    -
    -
    +
    +
    +
    +
    +
    +
    +
    @@ -191,10 +191,10 @@ function compareVersions(version1, version2) { icon
    -
    -
    -
    -
    +
    +
    +
    +
    @@ -207,18 +207,17 @@ function compareVersions(version1, version2) {
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    - +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    @@ -351,9 +350,13 @@ function compareVersions(version1, version2) {

    + + + +
    @@ -375,6 +378,7 @@ function compareVersions(version1, version2) {
    +
    @@ -385,6 +389,17 @@ function compareVersions(version1, version2) {