diff --git a/.github/config/.files.yaml b/.github/config/.files.yaml index 78f4616836..f866770b55 100644 --- a/.github/config/.files.yaml +++ b/.github/config/.files.yaml @@ -6,22 +6,27 @@ app: &app - app/(common|core|proprietary)/src/main/java/** openapi: &openapi - - build.gradle - - app/(common|core|proprietary)/build.gradle - - app/(common|core|proprietary)/src/main/java/** + - *build + - *app -project: &project - - app/(common|core|proprietary)/src/(main|test)/java/** - - app/(common|core|proprietary)/build.gradle - - 'app/(common|core|proprietary)/src/(main|test)/resources/**/!(messages_*.properties|*.md)*' - - exampleYmlFiles/** - - gradle/** - - libs/** - - testing/** - - build.gradle +docker: &docker - Dockerfile - Dockerfile.fat - Dockerfile.ultra-lite + - ".github/workflows/build.yml" + - scripts/init.sh + - scripts/init-without-ocr.sh + - exampleYmlFiles/** + +project: &project + - app/(common|core|proprietary)/src/(main|test)/java/** + - *build + - "app/(common|core|proprietary)/src/(main|test)/resources/**/!(messages_*.properties|*.md)*" + - exampleYmlFiles/** + - gradle/** + - libs/** + - "testing/**/!(requirements*.txt|requirements*.in)*" + - *docker - gradle.properties - gradlew - gradlew.bat @@ -29,7 +34,6 @@ project: &project - settings.gradle - frontend/** - docker/** - - testing/** frontend: &frontend - frontend/** diff --git a/.github/config/dependency-review-config.yml b/.github/config/dependency-review-config.yml index 5df58cdb9a..301a5d0b96 100644 --- a/.github/config/dependency-review-config.yml +++ b/.github/config/dependency-review-config.yml @@ -1 +1 @@ -allow-ghsas: GHSA-wrw7-89jp-8q8g \ No newline at end of file +allow-ghsas: GHSA-wrw7-89jp-8q8g diff --git a/.github/config/repo_devs.json b/.github/config/repo_devs.json index 86d43fd988..9632402605 100644 --- a/.github/config/repo_devs.json +++ b/.github/config/repo_devs.json @@ -1,4 +1,9 @@ { + "label_changer": [ + "Frooodle", + "Ludy87", + "balazs-szucs" + ], "repo_devs": [ "Frooodle", "sf298", diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 356b0263f7..3ba752efaa 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -21,3 +21,38 @@ updates: directory: / schedule: interval: weekly + + - package-ecosystem: npm + directory: /devTools + schedule: + interval: "weekly" + + - package-ecosystem: docker + directory: /docker/backend + schedule: + interval: "weekly" + + - package-ecosystem: docker + directory: /docker/embedded + schedule: + interval: "weekly" + + - package-ecosystem: docker + directory: /docker/frontend + schedule: + interval: "weekly" + + - package-ecosystem: npm + directory: /frontend + schedule: + interval: "weekly" + + - package-ecosystem: cargo + directory: /frontend/src-tauri + schedule: + interval: "weekly" + + - package-ecosystem: pip + directory: /testing/cucumber + schedule: + interval: "weekly" diff --git a/.github/labels.yml b/.github/labels.yml index 842e3fb5c7..a6c354e583 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -184,3 +184,6 @@ - name: "codex" color: "ededed" description: "chatgpt AI generated code" +- name: "break-change" + color: "FF0000" + description: "This PR introduces a breaking API change." diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b909f28e82..d1287c0117 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,6 +27,10 @@ Closes #(issue_number) - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) +### Translations (if applicable) + +- [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) + ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) diff --git a/.github/release.yml b/.github/release.yml index 2d0a9e0f9a..f6ac2e4fa8 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -1,5 +1,9 @@ changelog: categories: + - title: Breaking Changes + labels: + - break-change + - title: Bug Fixes labels: - Bug diff --git a/.github/scripts/check_language_toml.py b/.github/scripts/check_language_toml.py index 494f90962e..6860cc1766 100644 --- a/.github/scripts/check_language_toml.py +++ b/.github/scripts/check_language_toml.py @@ -14,12 +14,10 @@ Usage: # Sample for Windows: # python .github/scripts/check_language_toml.py --reference-file frontend/public/locales/en-GB/translation.toml --branch "" --files frontend/public/locales/de-DE/translation.toml frontend/public/locales/fr-FR/translation.toml -import copy import glob import os import argparse import re -import json import tomllib # Python 3.11+ (stdlib) import tomli_w # For writing TOML files @@ -38,7 +36,7 @@ def find_duplicate_keys(file_path, keys=None, prefix=""): duplicates = [] # Load TOML file - with open(file_path, 'rb') as file: + with open(file_path, "rb") as file: data = tomllib.load(file) def process_dict(obj, current_prefix=""): @@ -67,7 +65,7 @@ def parse_toml_file(file_path): :param file_path: Path to the TOML file. :return: Dictionary with flattened keys. """ - with open(file_path, 'rb') as file: + with open(file_path, "rb") as file: data = tomllib.load(file) def flatten_dict(d, parent_key="", sep="."): @@ -193,13 +191,13 @@ def check_for_differences(reference_file, file_list, branch, actor): basename_current_file = os.path.basename(os.path.join(branch, file_normpath)) locale_dir = os.path.basename(os.path.dirname(file_normpath)) - if ( - basename_current_file == basename_reference_file - and locale_dir == "en-GB" - ): + if basename_current_file == basename_reference_file and locale_dir == "en-GB": continue - if not file_normpath.endswith(".toml") or basename_current_file != "translation.toml": + if ( + not file_normpath.endswith(".toml") + or basename_current_file != "translation.toml" + ): continue only_reference_file = False @@ -288,7 +286,9 @@ def check_for_differences(reference_file, file_list, branch, actor): if __name__ == "__main__": - parser = argparse.ArgumentParser(description="Find missing keys in TOML translation files") + parser = argparse.ArgumentParser( + description="Find missing keys in TOML translation files" + ) parser.add_argument( "--actor", required=False, diff --git a/.github/scripts/requirements_dev.in b/.github/scripts/requirements_dev.in index a8732d927a..1f65a4f4af 100644 --- a/.github/scripts/requirements_dev.in +++ b/.github/scripts/requirements_dev.in @@ -6,3 +6,4 @@ pillow unoserver opencv-python-headless pre-commit +brotli @ git+https://github.com/google/brotli.git@028fb5a23661f123017c060daa546b55cf4bde29 diff --git a/.github/scripts/requirements_dev.txt b/.github/scripts/requirements_dev.txt index 9df13c7ae6..0f42b28a7b 100644 --- a/.github/scripts/requirements_dev.txt +++ b/.github/scripts/requirements_dev.txt @@ -4,201 +4,98 @@ # # pip-compile --allow-unsafe --generate-hashes --output-file='.github\scripts\requirements_dev.txt' --strip-extras '.github\scripts\requirements_dev.in' # -brotli==1.1.0 \ - --hash=sha256:03d20af184290887bdea3f0f78c4f737d126c74dc2f3ccadf07e54ceca3bf208 \ - --hash=sha256:0541e747cce78e24ea12d69176f6a7ddb690e62c425e01d31cc065e69ce55b48 \ - --hash=sha256:069a121ac97412d1fe506da790b3e69f52254b9df4eb665cd42460c837193354 \ - --hash=sha256:0737ddb3068957cf1b054899b0883830bb1fec522ec76b1098f9b6e0f02d9419 \ - --hash=sha256:0b63b949ff929fbc2d6d3ce0e924c9b93c9785d877a21a1b678877ffbbc4423a \ - --hash=sha256:0c6244521dda65ea562d5a69b9a26120769b7a9fb3db2fe9545935ed6735b128 \ - --hash=sha256:11d00ed0a83fa22d29bc6b64ef636c4552ebafcef57154b4ddd132f5638fbd1c \ - --hash=sha256:141bd4d93984070e097521ed07e2575b46f817d08f9fa42b16b9b5f27b5ac088 \ - --hash=sha256:19c116e796420b0cee3da1ccec3b764ed2952ccfcc298b55a10e5610ad7885f9 \ - --hash=sha256:1ab4fbee0b2d9098c74f3057b2bc055a8bd92ccf02f65944a241b4349229185a \ - --hash=sha256:1ae56aca0402a0f9a3431cddda62ad71666ca9d4dc3a10a142b9dce2e3c0cda3 \ - --hash=sha256:1b2c248cd517c222d89e74669a4adfa5577e06ab68771a529060cf5a156e9757 \ - --hash=sha256:1e9a65b5736232e7a7f91ff3d02277f11d339bf34099a56cdab6a8b3410a02b2 \ - --hash=sha256:224e57f6eac61cc449f498cc5f0e1725ba2071a3d4f48d5d9dffba42db196438 \ - --hash=sha256:22fc2a8549ffe699bfba2256ab2ed0421a7b8fadff114a3d201794e45a9ff578 \ - --hash=sha256:23032ae55523cc7bccb4f6a0bf368cd25ad9bcdcc1990b64a647e7bbcce9cb5b \ - --hash=sha256:2333e30a5e00fe0fe55903c8832e08ee9c3b1382aacf4db26664a16528d51b4b \ - --hash=sha256:2954c1c23f81c2eaf0b0717d9380bd348578a94161a65b3a2afc62c86467dd68 \ - --hash=sha256:2a24c50840d89ded6c9a8fdc7b6ed3692ed4e86f1c4a4a938e1e92def92933e0 \ - --hash=sha256:2de9d02f5bda03d27ede52e8cfe7b865b066fa49258cbab568720aa5be80a47d \ - --hash=sha256:2feb1d960f760a575dbc5ab3b1c00504b24caaf6986e2dc2b01c09c87866a943 \ - --hash=sha256:30924eb4c57903d5a7526b08ef4a584acc22ab1ffa085faceb521521d2de32dd \ - --hash=sha256:316cc9b17edf613ac76b1f1f305d2a748f1b976b033b049a6ecdfd5612c70409 \ - --hash=sha256:32d95b80260d79926f5fab3c41701dbb818fde1c9da590e77e571eefd14abe28 \ - --hash=sha256:38025d9f30cf4634f8309c6874ef871b841eb3c347e90b0851f63d1ded5212da \ - --hash=sha256:39da8adedf6942d76dc3e46653e52df937a3c4d6d18fdc94a7c29d263b1f5b50 \ - --hash=sha256:3c0ef38c7a7014ffac184db9e04debe495d317cc9c6fb10071f7fefd93100a4f \ - --hash=sha256:3d7954194c36e304e1523f55d7042c59dc53ec20dd4e9ea9d151f1b62b4415c0 \ - --hash=sha256:3ee8a80d67a4334482d9712b8e83ca6b1d9bc7e351931252ebef5d8f7335a547 \ - --hash=sha256:4093c631e96fdd49e0377a9c167bfd75b6d0bad2ace734c6eb20b348bc3ea180 \ - --hash=sha256:43395e90523f9c23a3d5bdf004733246fba087f2948f87ab28015f12359ca6a0 \ - --hash=sha256:43ce1b9935bfa1ede40028054d7f48b5469cd02733a365eec8a329ffd342915d \ - --hash=sha256:4410f84b33374409552ac9b6903507cdb31cd30d2501fc5ca13d18f73548444a \ - --hash=sha256:494994f807ba0b92092a163a0a283961369a65f6cbe01e8891132b7a320e61eb \ - --hash=sha256:4d4a848d1837973bf0f4b5e54e3bec977d99be36a7895c61abb659301b02c112 \ - --hash=sha256:4ed11165dd45ce798d99a136808a794a748d5dc38511303239d4e2363c0695dc \ - --hash=sha256:4f3607b129417e111e30637af1b56f24f7a49e64763253bbc275c75fa887d4b2 \ - --hash=sha256:510b5b1bfbe20e1a7b3baf5fed9e9451873559a976c1a78eebaa3b86c57b4265 \ - --hash=sha256:524f35912131cc2cabb00edfd8d573b07f2d9f21fa824bd3fb19725a9cf06327 \ - --hash=sha256:587ca6d3cef6e4e868102672d3bd9dc9698c309ba56d41c2b9c85bbb903cdb95 \ - --hash=sha256:58d4b711689366d4a03ac7957ab8c28890415e267f9b6589969e74b6e42225ec \ - --hash=sha256:5b3cc074004d968722f51e550b41a27be656ec48f8afaeeb45ebf65b561481dd \ - --hash=sha256:5dab0844f2cf82be357a0eb11a9087f70c5430b2c241493fc122bb6f2bb0917c \ - --hash=sha256:5e55da2c8724191e5b557f8e18943b1b4839b8efc3ef60d65985bcf6f587dd38 \ - --hash=sha256:5eeb539606f18a0b232d4ba45adccde4125592f3f636a6182b4a8a436548b914 \ - --hash=sha256:5f4d5ea15c9382135076d2fb28dde923352fe02951e66935a9efaac8f10e81b0 \ - --hash=sha256:5fb2ce4b8045c78ebbc7b8f3c15062e435d47e7393cc57c25115cfd49883747a \ - --hash=sha256:6172447e1b368dcbc458925e5ddaf9113477b0ed542df258d84fa28fc45ceea7 \ - --hash=sha256:6967ced6730aed543b8673008b5a391c3b1076d834ca438bbd70635c73775368 \ - --hash=sha256:6974f52a02321b36847cd19d1b8e381bf39939c21efd6ee2fc13a28b0d99348c \ - --hash=sha256:6c3020404e0b5eefd7c9485ccf8393cfb75ec38ce75586e046573c9dc29967a0 \ - --hash=sha256:6c6e0c425f22c1c719c42670d561ad682f7bfeeef918edea971a79ac5252437f \ - --hash=sha256:70051525001750221daa10907c77830bc889cb6d865cc0b813d9db7fefc21451 \ - --hash=sha256:7905193081db9bfa73b1219140b3d315831cbff0d8941f22da695832f0dd188f \ - --hash=sha256:7bc37c4d6b87fb1017ea28c9508b36bbcb0c3d18b4260fcdf08b200c74a6aee8 \ - --hash=sha256:7c4855522edb2e6ae7fdb58e07c3ba9111e7621a8956f481c68d5d979c93032e \ - --hash=sha256:7e4c4629ddad63006efa0ef968c8e4751c5868ff0b1c5c40f76524e894c50248 \ - --hash=sha256:7eedaa5d036d9336c95915035fb57422054014ebdeb6f3b42eac809928e40d0c \ - --hash=sha256:7f4bf76817c14aa98cc6697ac02f3972cb8c3da93e9ef16b9c66573a68014f91 \ - --hash=sha256:81de08ac11bcb85841e440c13611c00b67d3bf82698314928d0b676362546724 \ - --hash=sha256:832436e59afb93e1836081a20f324cb185836c617659b07b129141a8426973c7 \ - --hash=sha256:861bf317735688269936f755fa136a99d1ed526883859f86e41a5d43c61d8966 \ - --hash=sha256:87a3044c3a35055527ac75e419dfa9f4f3667a1e887ee80360589eb8c90aabb9 \ - --hash=sha256:890b5a14ce214389b2cc36ce82f3093f96f4cc730c1cffdbefff77a7c71f2a97 \ - --hash=sha256:89f4988c7203739d48c6f806f1e87a1d96e0806d44f0fba61dba81392c9e474d \ - --hash=sha256:8bf32b98b75c13ec7cf774164172683d6e7891088f6316e54425fde1efc276d5 \ - --hash=sha256:8dadd1314583ec0bf2d1379f7008ad627cd6336625d6679cf2f8e67081b83acf \ - --hash=sha256:901032ff242d479a0efa956d853d16875d42157f98951c0230f69e69f9c09bac \ - --hash=sha256:9011560a466d2eb3f5a6e4929cf4a09be405c64154e12df0dd72713f6500e32b \ - --hash=sha256:906bc3a79de8c4ae5b86d3d75a8b77e44404b0f4261714306e3ad248d8ab0951 \ - --hash=sha256:919e32f147ae93a09fe064d77d5ebf4e35502a8df75c29fb05788528e330fe74 \ - --hash=sha256:91d7cc2a76b5567591d12c01f019dd7afce6ba8cba6571187e21e2fc418ae648 \ - --hash=sha256:929811df5462e182b13920da56c6e0284af407d1de637d8e536c5cd00a7daf60 \ - --hash=sha256:949f3b7c29912693cee0afcf09acd6ebc04c57af949d9bf77d6101ebb61e388c \ - --hash=sha256:a090ca607cbb6a34b0391776f0cb48062081f5f60ddcce5d11838e67a01928d1 \ - --hash=sha256:a1fd8a29719ccce974d523580987b7f8229aeace506952fa9ce1d53a033873c8 \ - --hash=sha256:a37b8f0391212d29b3a91a799c8e4a2855e0576911cdfb2515487e30e322253d \ - --hash=sha256:a3daabb76a78f829cafc365531c972016e4aa8d5b4bf60660ad8ecee19df7ccc \ - --hash=sha256:a469274ad18dc0e4d316eefa616d1d0c2ff9da369af19fa6f3daa4f09671fd61 \ - --hash=sha256:a599669fd7c47233438a56936988a2478685e74854088ef5293802123b5b2460 \ - --hash=sha256:a743e5a28af5f70f9c080380a5f908d4d21d40e8f0e0c8901604d15cfa9ba751 \ - --hash=sha256:a77def80806c421b4b0af06f45d65a136e7ac0bdca3c09d9e2ea4e515367c7e9 \ - --hash=sha256:a7e53012d2853a07a4a79c00643832161a910674a893d296c9f1259859a289d2 \ - --hash=sha256:a93dde851926f4f2678e704fadeb39e16c35d8baebd5252c9fd94ce8ce68c4a0 \ - --hash=sha256:aac0411d20e345dc0920bdec5548e438e999ff68d77564d5e9463a7ca9d3e7b1 \ - --hash=sha256:ae15b066e5ad21366600ebec29a7ccbc86812ed267e4b28e860b8ca16a2bc474 \ - --hash=sha256:aea440a510e14e818e67bfc4027880e2fb500c2ccb20ab21c7a7c8b5b4703d75 \ - --hash=sha256:af6fa6817889314555aede9a919612b23739395ce767fe7fcbea9a80bf140fe5 \ - --hash=sha256:b760c65308ff1e462f65d69c12e4ae085cff3b332d894637f6273a12a482d09f \ - --hash=sha256:be36e3d172dc816333f33520154d708a2657ea63762ec16b62ece02ab5e4daf2 \ - --hash=sha256:c247dd99d39e0338a604f8c2b3bc7061d5c2e9e2ac7ba9cc1be5a69cb6cd832f \ - --hash=sha256:c5529b34c1c9d937168297f2c1fde7ebe9ebdd5e121297ff9c043bdb2ae3d6fb \ - --hash=sha256:c8146669223164fc87a7e3de9f81e9423c67a79d6b3447994dfb9c95da16e2d6 \ - --hash=sha256:c8fd5270e906eef71d4a8d19b7c6a43760c6abcfcc10c9101d14eb2357418de9 \ - --hash=sha256:ca63e1890ede90b2e4454f9a65135a4d387a4585ff8282bb72964fab893f2111 \ - --hash=sha256:caf9ee9a5775f3111642d33b86237b05808dafcd6268faa492250e9b78046eb2 \ - --hash=sha256:cb1dac1770878ade83f2ccdf7d25e494f05c9165f5246b46a621cc849341dc01 \ - --hash=sha256:cdad5b9014d83ca68c25d2e9444e28e967ef16e80f6b436918c700c117a85467 \ - --hash=sha256:cdbc1fc1bc0bff1cef838eafe581b55bfbffaed4ed0318b724d0b71d4d377619 \ - --hash=sha256:ceb64bbc6eac5a140ca649003756940f8d6a7c444a68af170b3187623b43bebf \ - --hash=sha256:d0c5516f0aed654134a2fc936325cc2e642f8a0e096d075209672eb321cff408 \ - --hash=sha256:d143fd47fad1db3d7c27a1b1d66162e855b5d50a89666af46e1679c496e8e579 \ - --hash=sha256:d192f0f30804e55db0d0e0a35d83a9fead0e9a359a9ed0285dbacea60cc10a84 \ - --hash=sha256:d2b35ca2c7f81d173d2fadc2f4f31e88cc5f7a39ae5b6db5513cf3383b0e0ec7 \ - --hash=sha256:d342778ef319e1026af243ed0a07c97acf3bad33b9f29e7ae6a1f68fd083e90c \ - --hash=sha256:d487f5432bf35b60ed625d7e1b448e2dc855422e87469e3f450aa5552b0eb284 \ - --hash=sha256:d7702622a8b40c49bffb46e1e3ba2e81268d5c04a34f460978c6b5517a34dd52 \ - --hash=sha256:db85ecf4e609a48f4b29055f1e144231b90edc90af7481aa731ba2d059226b1b \ - --hash=sha256:de6551e370ef19f8de1807d0a9aa2cdfdce2e85ce88b122fe9f6b2b076837e59 \ - --hash=sha256:e1140c64812cb9b06c922e77f1c26a75ec5e3f0fb2bf92cc8c58720dec276752 \ - --hash=sha256:e4fe605b917c70283db7dfe5ada75e04561479075761a0b3866c081d035b01c1 \ - --hash=sha256:e6a904cb26bfefc2f0a6f240bdf5233be78cd2488900a2f846f3c3ac8489ab80 \ - --hash=sha256:e79e6520141d792237c70bcd7a3b122d00f2613769ae0cb61c52e89fd3443839 \ - --hash=sha256:e84799f09591700a4154154cab9787452925578841a94321d5ee8fb9a9a328f0 \ - --hash=sha256:e93dfc1a1165e385cc8239fab7c036fb2cd8093728cbd85097b284d7b99249a2 \ - --hash=sha256:efa8b278894b14d6da122a72fefcebc28445f2d3f880ac59d46c90f4c13be9a3 \ - --hash=sha256:f0d8a7a6b5983c2496e364b969f0e526647a06b075d034f3297dc66f3b360c64 \ - --hash=sha256:f0db75f47be8b8abc8d9e31bc7aad0547ca26f24a54e6fd10231d623f183d089 \ - --hash=sha256:f296c40e23065d0d6650c4aefe7470d2a25fffda489bcc3eb66083f3ac9f6643 \ - --hash=sha256:f31859074d57b4639318523d6ffdca586ace54271a73ad23ad021acd807eb14b \ - --hash=sha256:f66b5337fa213f1da0d9000bc8dc0cb5b896b726eefd9c6046f699b169c41b9e \ - --hash=sha256:f733d788519c7e3e71f0855c96618720f5d3d60c3cb829d8bbb722dddce37985 \ - --hash=sha256:fce1473f3ccc4187f75b4690cfc922628aed4d3dd013d047f95a9b3919a86596 \ - --hash=sha256:fd5f17ff8f14003595ab414e45fce13d073e0762394f957182e69035c9f3d7c2 \ - --hash=sha256:fdc3ff3bfccdc6b9cc7c342c03aa2400683f0cb891d46e94b64a197910dc4064 - # via fonttools -cffi==1.17.1 \ - --hash=sha256:045d61c734659cc045141be4bae381a41d89b741f795af1dd018bfb532fd0df8 \ - --hash=sha256:0984a4925a435b1da406122d4d7968dd861c1385afe3b45ba82b750f229811e2 \ - --hash=sha256:0e2b1fac190ae3ebfe37b979cc1ce69c81f4e4fe5746bb401dca63a9062cdaf1 \ - --hash=sha256:0f048dcf80db46f0098ccac01132761580d28e28bc0f78ae0d58048063317e15 \ - --hash=sha256:1257bdabf294dceb59f5e70c64a3e2f462c30c7ad68092d01bbbfb1c16b1ba36 \ - --hash=sha256:1c39c6016c32bc48dd54561950ebd6836e1670f2ae46128f67cf49e789c52824 \ - --hash=sha256:1d599671f396c4723d016dbddb72fe8e0397082b0a77a4fab8028923bec050e8 \ - --hash=sha256:28b16024becceed8c6dfbc75629e27788d8a3f9030691a1dbf9821a128b22c36 \ - --hash=sha256:2bb1a08b8008b281856e5971307cc386a8e9c5b625ac297e853d36da6efe9c17 \ - --hash=sha256:30c5e0cb5ae493c04c8b42916e52ca38079f1b235c2f8ae5f4527b963c401caf \ - --hash=sha256:31000ec67d4221a71bd3f67df918b1f88f676f1c3b535a7eb473255fdc0b83fc \ - --hash=sha256:386c8bf53c502fff58903061338ce4f4950cbdcb23e2902d86c0f722b786bbe3 \ - --hash=sha256:3edc8d958eb099c634dace3c7e16560ae474aa3803a5df240542b305d14e14ed \ - --hash=sha256:45398b671ac6d70e67da8e4224a065cec6a93541bb7aebe1b198a61b58c7b702 \ - --hash=sha256:46bf43160c1a35f7ec506d254e5c890f3c03648a4dbac12d624e4490a7046cd1 \ - --hash=sha256:4ceb10419a9adf4460ea14cfd6bc43d08701f0835e979bf821052f1805850fe8 \ - --hash=sha256:51392eae71afec0d0c8fb1a53b204dbb3bcabcb3c9b807eedf3e1e6ccf2de903 \ - --hash=sha256:5da5719280082ac6bd9aa7becb3938dc9f9cbd57fac7d2871717b1feb0902ab6 \ - --hash=sha256:610faea79c43e44c71e1ec53a554553fa22321b65fae24889706c0a84d4ad86d \ - --hash=sha256:636062ea65bd0195bc012fea9321aca499c0504409f413dc88af450b57ffd03b \ - --hash=sha256:6883e737d7d9e4899a8a695e00ec36bd4e5e4f18fabe0aca0efe0a4b44cdb13e \ - --hash=sha256:6b8b4a92e1c65048ff98cfe1f735ef8f1ceb72e3d5f0c25fdb12087a23da22be \ - --hash=sha256:6f17be4345073b0a7b8ea599688f692ac3ef23ce28e5df79c04de519dbc4912c \ - --hash=sha256:706510fe141c86a69c8ddc029c7910003a17353970cff3b904ff0686a5927683 \ - --hash=sha256:72e72408cad3d5419375fc87d289076ee319835bdfa2caad331e377589aebba9 \ - --hash=sha256:733e99bc2df47476e3848417c5a4540522f234dfd4ef3ab7fafdf555b082ec0c \ - --hash=sha256:7596d6620d3fa590f677e9ee430df2958d2d6d6de2feeae5b20e82c00b76fbf8 \ - --hash=sha256:78122be759c3f8a014ce010908ae03364d00a1f81ab5c7f4a7a5120607ea56e1 \ - --hash=sha256:805b4371bf7197c329fcb3ead37e710d1bca9da5d583f5073b799d5c5bd1eee4 \ - --hash=sha256:85a950a4ac9c359340d5963966e3e0a94a676bd6245a4b55bc43949eee26a655 \ - --hash=sha256:8f2cdc858323644ab277e9bb925ad72ae0e67f69e804f4898c070998d50b1a67 \ - --hash=sha256:9755e4345d1ec879e3849e62222a18c7174d65a6a92d5b346b1863912168b595 \ - --hash=sha256:98e3969bcff97cae1b2def8ba499ea3d6f31ddfdb7635374834cf89a1a08ecf0 \ - --hash=sha256:a08d7e755f8ed21095a310a693525137cfe756ce62d066e53f502a83dc550f65 \ - --hash=sha256:a1ed2dd2972641495a3ec98445e09766f077aee98a1c896dcb4ad0d303628e41 \ - --hash=sha256:a24ed04c8ffd54b0729c07cee15a81d964e6fee0e3d4d342a27b020d22959dc6 \ - --hash=sha256:a45e3c6913c5b87b3ff120dcdc03f6131fa0065027d0ed7ee6190736a74cd401 \ - --hash=sha256:a9b15d491f3ad5d692e11f6b71f7857e7835eb677955c00cc0aefcd0669adaf6 \ - --hash=sha256:ad9413ccdeda48c5afdae7e4fa2192157e991ff761e7ab8fdd8926f40b160cc3 \ - --hash=sha256:b2ab587605f4ba0bf81dc0cb08a41bd1c0a5906bd59243d56bad7668a6fc6c16 \ - --hash=sha256:b62ce867176a75d03a665bad002af8e6d54644fad99a3c70905c543130e39d93 \ - --hash=sha256:c03e868a0b3bc35839ba98e74211ed2b05d2119be4e8a0f224fba9384f1fe02e \ - --hash=sha256:c59d6e989d07460165cc5ad3c61f9fd8f1b4796eacbd81cee78957842b834af4 \ - --hash=sha256:c7eac2ef9b63c79431bc4b25f1cd649d7f061a28808cbc6c47b534bd789ef964 \ - --hash=sha256:c9c3d058ebabb74db66e431095118094d06abf53284d9c81f27300d0e0d8bc7c \ - --hash=sha256:ca74b8dbe6e8e8263c0ffd60277de77dcee6c837a3d0881d8c1ead7268c9e576 \ - --hash=sha256:caaf0640ef5f5517f49bc275eca1406b0ffa6aa184892812030f04c2abf589a0 \ - --hash=sha256:cdf5ce3acdfd1661132f2a9c19cac174758dc2352bfe37d98aa7512c6b7178b3 \ - --hash=sha256:d016c76bdd850f3c626af19b0542c9677ba156e4ee4fccfdd7848803533ef662 \ - --hash=sha256:d01b12eeeb4427d3110de311e1774046ad344f5b1a7403101878976ecd7a10f3 \ - --hash=sha256:d63afe322132c194cf832bfec0dc69a99fb9bb6bbd550f161a49e9e855cc78ff \ - --hash=sha256:da95af8214998d77a98cc14e3a3bd00aa191526343078b530ceb0bd710fb48a5 \ - --hash=sha256:dd398dbc6773384a17fe0d3e7eeb8d1a21c2200473ee6806bb5e6a8e62bb73dd \ - --hash=sha256:de2ea4b5833625383e464549fec1bc395c1bdeeb5f25c4a3a82b5a8c756ec22f \ - --hash=sha256:de55b766c7aa2e2a3092c51e0483d700341182f08e67c63630d5b6f200bb28e5 \ - --hash=sha256:df8b1c11f177bc2313ec4b2d46baec87a5f3e71fc8b45dab2ee7cae86d9aba14 \ - --hash=sha256:e03eab0a8677fa80d646b5ddece1cbeaf556c313dcfac435ba11f107ba117b5d \ - --hash=sha256:e221cf152cff04059d011ee126477f0d9588303eb57e88923578ace7baad17f9 \ - --hash=sha256:e31ae45bc2e29f6b2abd0de1cc3b9d5205aa847cafaecb8af1476a609a2f6eb7 \ - --hash=sha256:edae79245293e15384b51f88b00613ba9f7198016a5948b5dddf4917d4d26382 \ - --hash=sha256:f1e22e8c4419538cb197e4dd60acc919d7696e5ef98ee4da4e01d3f8cfa4cc5a \ - --hash=sha256:f3a2b4222ce6b60e2e8b337bb9596923045681d71e5a082783484d845390938e \ - --hash=sha256:f6a16c31041f09ead72d69f583767292f750d24913dadacf5756b966aacb3f1a \ - --hash=sha256:f75c7ab1f9e4aca5414ed4d8e5c0e303a34f4421f8a0d47a4d019ceff0ab6af4 \ - --hash=sha256:f79fc4fc25f1c8698ff97788206bb3c2598949bfe0fef03d299eb1b5356ada99 \ - --hash=sha256:f7f5baafcc48261359e14bcd6d9bff6d4b28d9103847c9e136694cb0501aef87 \ - --hash=sha256:fc48c783f9c87e60831201f2cce7f3b2e4846bf4d8728eabe54d60700b318a0b +# WARNING: pip install will require the following package to be hashed. +# Consider using a hashable URL like https://github.com/jazzband/pip-tools/archive/SOMECOMMIT.zip +# CVE-2025-6176 mitigation: pin brotli to a specific commit +brotli @ git+https://github.com/google/brotli.git@028fb5a23661f123017c060daa546b55cf4bde29 + # via + # -r .github/scripts/requirements_dev.in + # fonttools +cffi==2.0.0 \ + --hash=sha256:00bdf7acc5f795150faa6957054fbbca2439db2f775ce831222b66f192f03beb \ + --hash=sha256:07b271772c100085dd28b74fa0cd81c8fb1a3ba18b21e03d7c27f3436a10606b \ + --hash=sha256:087067fa8953339c723661eda6b54bc98c5625757ea62e95eb4898ad5e776e9f \ + --hash=sha256:0a1527a803f0a659de1af2e1fd700213caba79377e27e4693648c2923da066f9 \ + --hash=sha256:0cf2d91ecc3fcc0625c2c530fe004f82c110405f101548512cce44322fa8ac44 \ + --hash=sha256:0f6084a0ea23d05d20c3edcda20c3d006f9b6f3fefeac38f59262e10cef47ee2 \ + --hash=sha256:12873ca6cb9b0f0d3a0da705d6086fe911591737a59f28b7936bdfed27c0d47c \ + --hash=sha256:19f705ada2530c1167abacb171925dd886168931e0a7b78f5bffcae5c6b5be75 \ + --hash=sha256:1cd13c99ce269b3ed80b417dcd591415d3372bcac067009b6e0f59c7d4015e65 \ + --hash=sha256:1e3a615586f05fc4065a8b22b8152f0c1b00cdbc60596d187c2a74f9e3036e4e \ + --hash=sha256:1f72fb8906754ac8a2cc3f9f5aaa298070652a0ffae577e0ea9bd480dc3c931a \ + --hash=sha256:1fc9ea04857caf665289b7a75923f2c6ed559b8298a1b8c49e59f7dd95c8481e \ + --hash=sha256:203a48d1fb583fc7d78a4c6655692963b860a417c0528492a6bc21f1aaefab25 \ + --hash=sha256:2081580ebb843f759b9f617314a24ed5738c51d2aee65d31e02f6f7a2b97707a \ + --hash=sha256:21d1152871b019407d8ac3985f6775c079416c282e431a4da6afe7aefd2bccbe \ + --hash=sha256:24b6f81f1983e6df8db3adc38562c83f7d4a0c36162885ec7f7b77c7dcbec97b \ + --hash=sha256:256f80b80ca3853f90c21b23ee78cd008713787b1b1e93eae9f3d6a7134abd91 \ + --hash=sha256:28a3a209b96630bca57cce802da70c266eb08c6e97e5afd61a75611ee6c64592 \ + --hash=sha256:2c8f814d84194c9ea681642fd164267891702542f028a15fc97d4674b6206187 \ + --hash=sha256:2de9a304e27f7596cd03d16f1b7c72219bd944e99cc52b84d0145aefb07cbd3c \ + --hash=sha256:38100abb9d1b1435bc4cc340bb4489635dc2f0da7456590877030c9b3d40b0c1 \ + --hash=sha256:3925dd22fa2b7699ed2617149842d2e6adde22b262fcbfada50e3d195e4b3a94 \ + --hash=sha256:3e17ed538242334bf70832644a32a7aae3d83b57567f9fd60a26257e992b79ba \ + --hash=sha256:3e837e369566884707ddaf85fc1744b47575005c0a229de3327f8f9a20f4efeb \ + --hash=sha256:3f4d46d8b35698056ec29bca21546e1551a205058ae1a181d871e278b0b28165 \ + --hash=sha256:44d1b5909021139fe36001ae048dbdde8214afa20200eda0f64c068cac5d5529 \ + --hash=sha256:45d5e886156860dc35862657e1494b9bae8dfa63bf56796f2fb56e1679fc0bca \ + --hash=sha256:4647afc2f90d1ddd33441e5b0e85b16b12ddec4fca55f0d9671fef036ecca27c \ + --hash=sha256:4671d9dd5ec934cb9a73e7ee9676f9362aba54f7f34910956b84d727b0d73fb6 \ + --hash=sha256:53f77cbe57044e88bbd5ed26ac1d0514d2acf0591dd6bb02a3ae37f76811b80c \ + --hash=sha256:5eda85d6d1879e692d546a078b44251cdd08dd1cfb98dfb77b670c97cee49ea0 \ + --hash=sha256:5fed36fccc0612a53f1d4d9a816b50a36702c28a2aa880cb8a122b3466638743 \ + --hash=sha256:61d028e90346df14fedc3d1e5441df818d095f3b87d286825dfcbd6459b7ef63 \ + --hash=sha256:66f011380d0e49ed280c789fbd08ff0d40968ee7b665575489afa95c98196ab5 \ + --hash=sha256:6824f87845e3396029f3820c206e459ccc91760e8fa24422f8b0c3d1731cbec5 \ + --hash=sha256:6c6c373cfc5c83a975506110d17457138c8c63016b563cc9ed6e056a82f13ce4 \ + --hash=sha256:6d02d6655b0e54f54c4ef0b94eb6be0607b70853c45ce98bd278dc7de718be5d \ + --hash=sha256:6d50360be4546678fc1b79ffe7a66265e28667840010348dd69a314145807a1b \ + --hash=sha256:730cacb21e1bdff3ce90babf007d0a0917cc3e6492f336c2f0134101e0944f93 \ + --hash=sha256:737fe7d37e1a1bffe70bd5754ea763a62a066dc5913ca57e957824b72a85e205 \ + --hash=sha256:74a03b9698e198d47562765773b4a8309919089150a0bb17d829ad7b44b60d27 \ + --hash=sha256:7553fb2090d71822f02c629afe6042c299edf91ba1bf94951165613553984512 \ + --hash=sha256:7a66c7204d8869299919db4d5069a82f1561581af12b11b3c9f48c584eb8743d \ + --hash=sha256:7cc09976e8b56f8cebd752f7113ad07752461f48a58cbba644139015ac24954c \ + --hash=sha256:81afed14892743bbe14dacb9e36d9e0e504cd204e0b165062c488942b9718037 \ + --hash=sha256:8941aaadaf67246224cee8c3803777eed332a19d909b47e29c9842ef1e79ac26 \ + --hash=sha256:89472c9762729b5ae1ad974b777416bfda4ac5642423fa93bd57a09204712322 \ + --hash=sha256:8ea985900c5c95ce9db1745f7933eeef5d314f0565b27625d9a10ec9881e1bfb \ + --hash=sha256:8eca2a813c1cb7ad4fb74d368c2ffbbb4789d377ee5bb8df98373c2cc0dee76c \ + --hash=sha256:92b68146a71df78564e4ef48af17551a5ddd142e5190cdf2c5624d0c3ff5b2e8 \ + --hash=sha256:9332088d75dc3241c702d852d4671613136d90fa6881da7d770a483fd05248b4 \ + --hash=sha256:94698a9c5f91f9d138526b48fe26a199609544591f859c870d477351dc7b2414 \ + --hash=sha256:9a67fc9e8eb39039280526379fb3a70023d77caec1852002b4da7e8b270c4dd9 \ + --hash=sha256:9de40a7b0323d889cf8d23d1ef214f565ab154443c42737dfe52ff82cf857664 \ + --hash=sha256:a05d0c237b3349096d3981b727493e22147f934b20f6f125a3eba8f994bec4a9 \ + --hash=sha256:afb8db5439b81cf9c9d0c80404b60c3cc9c3add93e114dcae767f1477cb53775 \ + --hash=sha256:b18a3ed7d5b3bd8d9ef7a8cb226502c6bf8308df1525e1cc676c3680e7176739 \ + --hash=sha256:b1e74d11748e7e98e2f426ab176d4ed720a64412b6a15054378afdb71e0f37dc \ + --hash=sha256:b21e08af67b8a103c71a250401c78d5e0893beff75e28c53c98f4de42f774062 \ + --hash=sha256:b4c854ef3adc177950a8dfc81a86f5115d2abd545751a304c5bcf2c2c7283cfe \ + --hash=sha256:b882b3df248017dba09d6b16defe9b5c407fe32fc7c65a9c69798e6175601be9 \ + --hash=sha256:baf5215e0ab74c16e2dd324e8ec067ef59e41125d3eade2b863d294fd5035c92 \ + --hash=sha256:c649e3a33450ec82378822b3dad03cc228b8f5963c0c12fc3b1e0ab940f768a5 \ + --hash=sha256:c654de545946e0db659b3400168c9ad31b5d29593291482c43e3564effbcee13 \ + --hash=sha256:c6638687455baf640e37344fe26d37c404db8b80d037c3d29f58fe8d1c3b194d \ + --hash=sha256:c8d3b5532fc71b7a77c09192b4a5a200ea992702734a2e9279a37f2478236f26 \ + --hash=sha256:cb527a79772e5ef98fb1d700678fe031e353e765d1ca2d409c92263c6d43e09f \ + --hash=sha256:cf364028c016c03078a23b503f02058f1814320a56ad535686f90565636a9495 \ + --hash=sha256:d48a880098c96020b02d5a1f7d9251308510ce8858940e6fa99ece33f610838b \ + --hash=sha256:d68b6cef7827e8641e8ef16f4494edda8b36104d79773a334beaa1e3521430f6 \ + --hash=sha256:d9b29c1f0ae438d5ee9acb31cadee00a58c46cc9c0b2f9038c6b0b3470877a8c \ + --hash=sha256:d9b97165e8aed9272a6bb17c01e3cc5871a594a446ebedc996e2397a1c1ea8ef \ + --hash=sha256:da68248800ad6320861f129cd9c1bf96ca849a2771a59e0344e88681905916f5 \ + --hash=sha256:da902562c3e9c550df360bfa53c035b2f241fed6d9aef119048073680ace4a18 \ + --hash=sha256:dbd5c7a25a7cb98f5ca55d258b103a2054f859a46ae11aaf23134f9cc0d356ad \ + --hash=sha256:dd4f05f54a52fb558f1ba9f528228066954fee3ebe629fc1660d874d040ae5a3 \ + --hash=sha256:de8dad4425a6ca6e4e5e297b27b5c824ecc7581910bf9aee86cb6835e6812aa7 \ + --hash=sha256:e11e82b744887154b182fd3e7e8512418446501191994dbf9c9fc1f32cc8efd5 \ + --hash=sha256:e6e73b9e02893c764e7e8d5bb5ce277f1a009cd5243f8228f75f842bf937c534 \ + --hash=sha256:f73b96c41e3b2adedc34a7356e64c8eb96e03a3782b535e043a986276ce12a49 \ + --hash=sha256:f93fd8e5c8c0a4aa1f424d6173f14a892044054871c771f8566e4008eaa359d2 \ + --hash=sha256:fc33c5141b55ed366cfaad382df24fe7dcbc686de5be719b207bb248e3053dc5 \ + --hash=sha256:fc7de24befaeae77ba923797c7c87834c73648a05a4bde34b3b7e5588973a453 \ + --hash=sha256:fe562eb1a64e67dd297ccc4f5addea2501664954f2692b69a76449ec7913ecbf # via weasyprint cfgv==3.4.0 \ --hash=sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9 \ @@ -212,57 +109,73 @@ distlib==0.4.0 \ --hash=sha256:9659f7d87e46584a30b5780e43ac7a2143098441670ff0a49d5f9034c54a6c16 \ --hash=sha256:feec40075be03a04501a973d81f633735b4b69f98b05450592310c0f401a4e0d # via virtualenv -filelock==3.18.0 \ - --hash=sha256:adbc88eabb99d2fec8c9c1b229b171f18afa655400173ddc653d5d01501fb9f2 \ - --hash=sha256:c401f4f8377c4464e6db25fff06205fd89bdd83b65eb0488ed1b160f780e21de +filelock==3.20.0 \ + --hash=sha256:339b4732ffda5cd79b13f4e2711a31b0365ce445d95d243bb996273d072546a2 \ + --hash=sha256:711e943b4ec6be42e1d4e6690b48dc175c822967466bb31c0c293f34334c13f4 # via virtualenv -fonttools==4.59.0 \ - --hash=sha256:052444a5d0151878e87e3e512a1aa1a0ab35ee4c28afde0a778e23b0ace4a7de \ - --hash=sha256:169b99a2553a227f7b5fea8d9ecd673aa258617f466b2abc6091fe4512a0dcd0 \ - --hash=sha256:209b75943d158f610b78320eacb5539aa9e920bee2c775445b2846c65d20e19d \ - --hash=sha256:21e606b2d38fed938dde871c5736822dd6bda7a4631b92e509a1f5cd1b90c5df \ - --hash=sha256:241313683afd3baacb32a6bd124d0bce7404bc5280e12e291bae1b9bba28711d \ - --hash=sha256:26731739daa23b872643f0e4072d5939960237d540c35c14e6a06d47d71ca8fe \ - --hash=sha256:2e7cf8044ce2598bb87e44ba1d2c6e45d7a8decf56055b92906dc53f67c76d64 \ - --hash=sha256:31003b6a10f70742a63126b80863ab48175fb8272a18ca0846c0482968f0588e \ - --hash=sha256:332bfe685d1ac58ca8d62b8d6c71c2e52a6c64bc218dc8f7825c9ea51385aa01 \ - --hash=sha256:37c377f7cb2ab2eca8a0b319c68146d34a339792f9420fca6cd49cf28d370705 \ - --hash=sha256:37e01c6ec0c98599778c2e688350d624fa4770fbd6144551bd5e032f1199171c \ - --hash=sha256:401b1941ce37e78b8fd119b419b617277c65ae9417742a63282257434fd68ea2 \ - --hash=sha256:4536f2695fe5c1ffb528d84a35a7d3967e5558d2af58b4775e7ab1449d65767b \ - --hash=sha256:4c908a7036f0f3677f8afa577bcd973e3e20ddd2f7c42a33208d18bee95cdb6f \ - --hash=sha256:51ab1ff33c19e336c02dee1e9fd1abd974a4ca3d8f7eef2a104d0816a241ce97 \ - --hash=sha256:524133c1be38445c5c0575eacea42dbd44374b310b1ffc4b60ff01d881fabb96 \ - --hash=sha256:57bb7e26928573ee7c6504f54c05860d867fd35e675769f3ce01b52af38d48e2 \ - --hash=sha256:60f6665579e909b618282f3c14fa0b80570fbf1ee0e67678b9a9d43aa5d67a37 \ - --hash=sha256:62224a9bb85b4b66d1b46d45cbe43d71cbf8f527d332b177e3b96191ffbc1e64 \ - --hash=sha256:6770d7da00f358183d8fd5c4615436189e4f683bdb6affb02cad3d221d7bb757 \ - --hash=sha256:6801aeddb6acb2c42eafa45bc1cb98ba236871ae6f33f31e984670b749a8e58e \ - --hash=sha256:70d6b3ceaa9cc5a6ac52884f3b3d9544e8e231e95b23f138bdb78e6d4dc0eae3 \ - --hash=sha256:78813b49d749e1bb4db1c57f2d4d7e6db22c253cb0a86ad819f5dc197710d4b2 \ - --hash=sha256:841b2186adce48903c0fef235421ae21549020eca942c1da773ac380b056ab3c \ - --hash=sha256:84fc186980231a287b28560d3123bd255d3c6b6659828c642b4cf961e2b923d0 \ - --hash=sha256:885bde7d26e5b40e15c47bd5def48b38cbd50830a65f98122a8fb90962af7cd1 \ - --hash=sha256:8b4309a2775e4feee7356e63b163969a215d663399cce1b3d3b65e7ec2d9680e \ - --hash=sha256:8d77f92438daeaddc05682f0f3dac90c5b9829bcac75b57e8ce09cb67786073c \ - --hash=sha256:902425f5afe28572d65d2bf9c33edd5265c612ff82c69e6f83ea13eafc0dcbea \ - --hash=sha256:9bcc1e77fbd1609198966ded6b2a9897bd6c6bcbd2287a2fc7d75f1a254179c5 \ - --hash=sha256:a408c3c51358c89b29cfa5317cf11518b7ce5de1717abb55c5ae2d2921027de6 \ - --hash=sha256:a9bf8adc9e1f3012edc8f09b08336272aec0c55bc677422273e21280db748f7c \ - --hash=sha256:b818db35879d2edf7f46c7e729c700a0bce03b61b9412f5a7118406687cb151d \ - --hash=sha256:b8974b2a266b54c96709bd5e239979cddfd2dbceed331aa567ea1d7c4a2202db \ - --hash=sha256:be392ec3529e2f57faa28709d60723a763904f71a2b63aabe14fee6648fe3b14 \ - --hash=sha256:d3972b13148c1d1fbc092b27678a33b3080d1ac0ca305742b0119b75f9e87e38 \ - --hash=sha256:d40dcf533ca481355aa7b682e9e079f766f35715defa4929aeb5597f9604272e \ - --hash=sha256:e93df708c69a193fc7987192f94df250f83f3851fda49413f02ba5dded639482 \ - --hash=sha256:efd7e6660674e234e29937bc1481dceb7e0336bfae75b856b4fb272b5093c5d4 \ - --hash=sha256:f9b3a78f69dcbd803cf2fb3f972779875b244c1115481dfbdd567b2c22b31f6b \ - --hash=sha256:fa39475eaccb98f9199eccfda4298abaf35ae0caec676ffc25b3a5e224044464 \ - --hash=sha256:fbce6dae41b692a5973d0f2158f782b9ad05babc2c2019a970a1094a23909b1b +fonttools==4.60.1 \ + --hash=sha256:022beaea4b73a70295b688f817ddc24ed3e3418b5036ffcd5658141184ef0d0c \ + --hash=sha256:026290e4ec76583881763fac284aca67365e0be9f13a7fb137257096114cb3bc \ + --hash=sha256:0b0835ed15dd5b40d726bb61c846a688f5b4ce2208ec68779bc81860adb5851a \ + --hash=sha256:0eae96373e4b7c9e45d099d7a523444e3554360927225c1cdae221a58a45b856 \ + --hash=sha256:122e1a8ada290423c493491d002f622b1992b1ab0b488c68e31c413390dc7eb2 \ + --hash=sha256:1410155d0e764a4615774e5c2c6fc516259fe3eca5882f034eb9bfdbee056259 \ + --hash=sha256:145daa14bf24824b677b9357c5e44fd8895c2a8f53596e1b9ea3496081dc692c \ + --hash=sha256:1525796c3ffe27bb6268ed2a1bb0dcf214d561dfaf04728abf01489eb5339dce \ + --hash=sha256:154cb6ee417e417bf5f7c42fe25858c9140c26f647c7347c06f0cc2d47eff003 \ + --hash=sha256:2299df884c11162617a66b7c316957d74a18e3758c0274762d2cc87df7bc0272 \ + --hash=sha256:2409d5fb7b55fd70f715e6d34e7a6e4f7511b8ad29a49d6df225ee76da76dd77 \ + --hash=sha256:268ecda8ca6cb5c4f044b1fb9b3b376e8cd1b361cef275082429dc4174907038 \ + --hash=sha256:282dafa55f9659e8999110bd8ed422ebe1c8aecd0dc396550b038e6c9a08b8ea \ + --hash=sha256:2ee06fc57512144d8b0445194c2da9f190f61ad51e230f14836286470c99f854 \ + --hash=sha256:3630e86c484263eaac71d117085d509cbcf7b18f677906824e4bace598fb70d2 \ + --hash=sha256:398447f3d8c0c786cbf1209711e79080a40761eb44b27cdafffb48f52bcec258 \ + --hash=sha256:4ba4bd646e86de16160f0fb72e31c3b9b7d0721c3e5b26b9fa2fc931dfdb2652 \ + --hash=sha256:5664fd1a9ea7f244487ac8f10340c4e37664675e8667d6fee420766e0fb3cf08 \ + --hash=sha256:583b7f8e3c49486e4d489ad1deacfb8d5be54a8ef34d6df824f6a171f8511d99 \ + --hash=sha256:596ecaca36367027d525b3b426d8a8208169d09edcf8c7506aceb3a38bfb55c7 \ + --hash=sha256:5c1015318e4fec75dd4943ad5f6a206d9727adf97410d58b7e32ab644a807914 \ + --hash=sha256:66929e2ea2810c6533a5184f938502cfdaea4bc3efb7130d8cc02e1c1b4108d6 \ + --hash=sha256:6ec722ee589e89a89f5b7574f5c45604030aa6ae24cb2c751e2707193b466fed \ + --hash=sha256:6f68576bb4bbf6060c7ab047b1574a1ebe5c50a17de62830079967b211059ebb \ + --hash=sha256:7473a8ed9ed09aeaa191301244a5a9dbe46fe0bf54f9d6cd21d83044c3321217 \ + --hash=sha256:7b0c6d57ab00dae9529f3faf187f2254ea0aa1e04215cf2f1a8ec277c96661bc \ + --hash=sha256:7b4c32e232a71f63a5d00259ca3d88345ce2a43295bb049d21061f338124246f \ + --hash=sha256:8177ec9676ea6e1793c8a084a90b65a9f778771998eb919d05db6d4b1c0b114c \ + --hash=sha256:839565cbf14645952d933853e8ade66a463684ed6ed6c9345d0faf1f0e868877 \ + --hash=sha256:875cb7764708b3132637f6c5fb385b16eeba0f7ac9fa45a69d35e09b47045801 \ + --hash=sha256:8a44788d9d91df72d1a5eac49b31aeb887a5f4aab761b4cffc4196c74907ea85 \ + --hash=sha256:8b4eb332f9501cb1cd3d4d099374a1e1306783ff95489a1026bde9eb02ccc34a \ + --hash=sha256:906306ac7afe2156fcf0042173d6ebbb05416af70f6b370967b47f8f00103bbb \ + --hash=sha256:992775c9fbe2cf794786fa0ffca7f09f564ba3499b8fe9f2f80bd7197db60383 \ + --hash=sha256:996a4d1834524adbb423385d5a629b868ef9d774670856c63c9a0408a3063401 \ + --hash=sha256:9a52f254ce051e196b8fe2af4634c2d2f02c981756c6464dc192f1b6050b4e28 \ + --hash=sha256:9d0ced62b59e0430b3690dbc5373df1c2aa7585e9a8ce38eff87f0fd993c5b01 \ + --hash=sha256:a140761c4ff63d0cb9256ac752f230460ee225ccef4ad8f68affc723c88e2036 \ + --hash=sha256:a184b2ea57b13680ab6d5fbde99ccef152c95c06746cb7718c583abd8f945ccc \ + --hash=sha256:a3db56f153bd4c5c2b619ab02c5db5192e222150ce5a1bc10f16164714bc39ac \ + --hash=sha256:a46b2f450bc79e06ef3b6394f0c68660529ed51692606ad7f953fc2e448bc903 \ + --hash=sha256:a884aef09d45ba1206712c7dbda5829562d3fea7726935d3289d343232ecb0d3 \ + --hash=sha256:b2cf105cee600d2de04ca3cfa1f74f1127f8455b71dbad02b9da6ec266e116d6 \ + --hash=sha256:b33a7884fabd72bdf5f910d0cf46be50dce86a0362a65cfc746a4168c67eb96c \ + --hash=sha256:b42d86938e8dda1cd9a1a87a6d82f1818eaf933348429653559a458d027446da \ + --hash=sha256:b6379e7546ba4ae4b18f8ae2b9bc5960936007a1c0e30b342f662577e8bc3299 \ + --hash=sha256:c7420a2696a44650120cdd269a5d2e56a477e2bfa9d95e86229059beb1c19e15 \ + --hash=sha256:c8651e0d4b3bdeda6602b85fdc2abbefc1b41e573ecb37b6779c4ca50753a199 \ + --hash=sha256:d066ea419f719ed87bc2c99a4a4bfd77c2e5949cb724588b9dd58f3fd90b92bf \ + --hash=sha256:e6c58beb17380f7c2ea181ea11e7db8c0ceb474c9dd45f48e71e2cb577d146a1 \ + --hash=sha256:e852d9dda9f93ad3651ae1e3bb770eac544ec93c3807888798eccddf84596537 \ + --hash=sha256:ec3681a0cb34c255d76dd9d865a55f260164adb9fa02628415cdc2d43ee2c05d \ + --hash=sha256:ee0c0b3b35b34f782afc673d503167157094a16f442ace7c6c5e0ca80b08f50c \ + --hash=sha256:eedacb5c5d22b7097482fa834bda0dafa3d914a4e829ec83cdea2a01f8c813c4 \ + --hash=sha256:ef00af0439ebfee806b25f24c8f92109157ff3fac5731dc7867957812e87b8d9 \ + --hash=sha256:f0e8817c7d1a0c2eedebf57ef9a9896f3ea23324769a9a2061a80fe8852705ed \ + --hash=sha256:f3d5be054c461d6a2268831f04091dc82753176f6ea06dc6047a5e168265a987 \ + --hash=sha256:f4b5c37a5f40e4d733d3bbaaef082149bee5a5ea3156a785ff64d949bd1353fa # via weasyprint -identify==2.6.13 \ - --hash=sha256:60381139b3ae39447482ecc406944190f690d4a2997f2584062089848361b33b \ - --hash=sha256:da8d6c828e773620e13bfa86ea601c5a5310ba4bcd65edf378198b56a1f9fb32 +identify==2.6.15 \ + --hash=sha256:1181ef7608e00704db228516541eb83a88a9f94433a8c80bb9b5bd54b1d81757 \ + --hash=sha256:e4f4864b96c6557ef2a1e1c951771838f4edc9df3a72ec7118b338801b11c7bf # via pre-commit nodeenv==1.9.1 \ --hash=sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f \ @@ -338,128 +251,113 @@ pdf2image==1.17.0 \ --hash=sha256:eaa959bc116b420dd7ec415fcae49b98100dda3dd18cd2fdfa86d09f112f6d57 \ --hash=sha256:ecdd58d7afb810dffe21ef2b1bbc057ef434dabbac6c33778a38a3f7744a27e2 # via -r .github/scripts/requirements_dev.in -pillow==11.3.0 \ - --hash=sha256:023f6d2d11784a465f09fd09a34b150ea4672e85fb3d05931d89f373ab14abb2 \ - --hash=sha256:02a723e6bf909e7cea0dac1b0e0310be9d7650cd66222a5f1c571455c0a45214 \ - --hash=sha256:040a5b691b0713e1f6cbe222e0f4f74cd233421e105850ae3b3c0ceda520f42e \ - --hash=sha256:05f6ecbeff5005399bb48d198f098a9b4b6bdf27b8487c7f38ca16eeb070cd59 \ - --hash=sha256:068d9c39a2d1b358eb9f245ce7ab1b5c3246c7c8c7d9ba58cfa5b43146c06e50 \ - --hash=sha256:0743841cabd3dba6a83f38a92672cccbd69af56e3e91777b0ee7f4dba4385632 \ - --hash=sha256:092c80c76635f5ecb10f3f83d76716165c96f5229addbd1ec2bdbbda7d496e06 \ - --hash=sha256:0b275ff9b04df7b640c59ec5a3cb113eefd3795a8df80bac69646ef699c6981a \ - --hash=sha256:0bce5c4fd0921f99d2e858dc4d4d64193407e1b99478bc5cacecba2311abde51 \ - --hash=sha256:1019b04af07fc0163e2810167918cb5add8d74674b6267616021ab558dc98ced \ - --hash=sha256:106064daa23a745510dabce1d84f29137a37224831d88eb4ce94bb187b1d7e5f \ - --hash=sha256:118ca10c0d60b06d006be10a501fd6bbdfef559251ed31b794668ed569c87e12 \ - --hash=sha256:13f87d581e71d9189ab21fe0efb5a23e9f28552d5be6979e84001d3b8505abe8 \ - --hash=sha256:155658efb5e044669c08896c0c44231c5e9abcaadbc5cd3648df2f7c0b96b9a6 \ - --hash=sha256:1904e1264881f682f02b7f8167935cce37bc97db457f8e7849dc3a6a52b99580 \ - --hash=sha256:19d2ff547c75b8e3ff46f4d9ef969a06c30ab2d4263a9e287733aa8b2429ce8f \ - --hash=sha256:1a992e86b0dd7aeb1f053cd506508c0999d710a8f07b4c791c63843fc6a807ac \ - --hash=sha256:1b9c17fd4ace828b3003dfd1e30bff24863e0eb59b535e8f80194d9cc7ecf860 \ - --hash=sha256:1c627742b539bba4309df89171356fcb3cc5a9178355b2727d1b74a6cf155fbd \ - --hash=sha256:1cd110edf822773368b396281a2293aeb91c90a2db00d78ea43e7e861631b722 \ - --hash=sha256:1f85acb69adf2aaee8b7da124efebbdb959a104db34d3a2cb0f3793dbae422a8 \ - --hash=sha256:23cff760a9049c502721bdb743a7cb3e03365fafcdfc2ef9784610714166e5a4 \ - --hash=sha256:2465a69cf967b8b49ee1b96d76718cd98c4e925414ead59fdf75cf0fd07df673 \ - --hash=sha256:2a3117c06b8fb646639dce83694f2f9eac405472713fcb1ae887469c0d4f6788 \ - --hash=sha256:2aceea54f957dd4448264f9bf40875da0415c83eb85f55069d89c0ed436e3542 \ - --hash=sha256:2d6fcc902a24ac74495df63faad1884282239265c6839a0a6416d33faedfae7e \ - --hash=sha256:30807c931ff7c095620fe04448e2c2fc673fcbb1ffe2a7da3fb39613489b1ddd \ - --hash=sha256:30b7c02f3899d10f13d7a48163c8969e4e653f8b43416d23d13d1bbfdc93b9f8 \ - --hash=sha256:3828ee7586cd0b2091b6209e5ad53e20d0649bbe87164a459d0676e035e8f523 \ - --hash=sha256:3cee80663f29e3843b68199b9d6f4f54bd1d4a6b59bdd91bceefc51238bcb967 \ - --hash=sha256:3e184b2f26ff146363dd07bde8b711833d7b0202e27d13540bfe2e35a323a809 \ - --hash=sha256:41342b64afeba938edb034d122b2dda5db2139b9a4af999729ba8818e0056477 \ - --hash=sha256:41742638139424703b4d01665b807c6468e23e699e8e90cffefe291c5832b027 \ - --hash=sha256:4445fa62e15936a028672fd48c4c11a66d641d2c05726c7ec1f8ba6a572036ae \ - --hash=sha256:45dfc51ac5975b938e9809451c51734124e73b04d0f0ac621649821a63852e7b \ - --hash=sha256:465b9e8844e3c3519a983d58b80be3f668e2a7a5db97f2784e7079fbc9f9822c \ - --hash=sha256:48d254f8a4c776de343051023eb61ffe818299eeac478da55227d96e241de53f \ - --hash=sha256:4c834a3921375c48ee6b9624061076bc0a32a60b5532b322cc0ea64e639dd50e \ - --hash=sha256:4c96f993ab8c98460cd0c001447bff6194403e8b1d7e149ade5f00594918128b \ - --hash=sha256:504b6f59505f08ae014f724b6207ff6222662aab5cc9542577fb084ed0676ac7 \ - --hash=sha256:527b37216b6ac3a12d7838dc3bd75208ec57c1c6d11ef01902266a5a0c14fc27 \ - --hash=sha256:5418b53c0d59b3824d05e029669efa023bbef0f3e92e75ec8428f3799487f361 \ - --hash=sha256:59a03cdf019efbfeeed910bf79c7c93255c3d54bc45898ac2a4140071b02b4ae \ - --hash=sha256:5e05688ccef30ea69b9317a9ead994b93975104a677a36a8ed8106be9260aa6d \ - --hash=sha256:6359a3bc43f57d5b375d1ad54a0074318a0844d11b76abccf478c37c986d3cfc \ - --hash=sha256:643f189248837533073c405ec2f0bb250ba54598cf80e8c1e043381a60632f58 \ - --hash=sha256:65dc69160114cdd0ca0f35cb434633c75e8e7fad4cf855177a05bf38678f73ad \ - --hash=sha256:67172f2944ebba3d4a7b54f2e95c786a3a50c21b88456329314caaa28cda70f6 \ - --hash=sha256:676b2815362456b5b3216b4fd5bd89d362100dc6f4945154ff172e206a22c024 \ - --hash=sha256:6a418691000f2a418c9135a7cf0d797c1bb7d9a485e61fe8e7722845b95ef978 \ - --hash=sha256:6abdbfd3aea42be05702a8dd98832329c167ee84400a1d1f61ab11437f1717eb \ - --hash=sha256:6be31e3fc9a621e071bc17bb7de63b85cbe0bfae91bb0363c893cbe67247780d \ - --hash=sha256:7107195ddc914f656c7fc8e4a5e1c25f32e9236ea3ea860f257b0436011fddd0 \ - --hash=sha256:71f511f6b3b91dd543282477be45a033e4845a40278fa8dcdbfdb07109bf18f9 \ - --hash=sha256:7859a4cc7c9295f5838015d8cc0a9c215b77e43d07a25e460f35cf516df8626f \ - --hash=sha256:7966e38dcd0fa11ca390aed7c6f20454443581d758242023cf36fcb319b1a874 \ - --hash=sha256:79ea0d14d3ebad43ec77ad5272e6ff9bba5b679ef73375ea760261207fa8e0aa \ - --hash=sha256:7aee118e30a4cf54fdd873bd3a29de51e29105ab11f9aad8c32123f58c8f8081 \ - --hash=sha256:7b161756381f0918e05e7cb8a371fff367e807770f8fe92ecb20d905d0e1c149 \ - --hash=sha256:7c8ec7a017ad1bd562f93dbd8505763e688d388cde6e4a010ae1486916e713e6 \ - --hash=sha256:7d1aa4de119a0ecac0a34a9c8bde33f34022e2e8f99104e47a3ca392fd60e37d \ - --hash=sha256:7db51d222548ccfd274e4572fdbf3e810a5e66b00608862f947b163e613b67dd \ - --hash=sha256:819931d25e57b513242859ce1876c58c59dc31587847bf74cfe06b2e0cb22d2f \ - --hash=sha256:83e1b0161c9d148125083a35c1c5a89db5b7054834fd4387499e06552035236c \ - --hash=sha256:857844335c95bea93fb39e0fa2726b4d9d758850b34075a7e3ff4f4fa3aa3b31 \ - --hash=sha256:8797edc41f3e8536ae4b10897ee2f637235c94f27404cac7297f7b607dd0716e \ - --hash=sha256:8924748b688aa210d79883357d102cd64690e56b923a186f35a82cbc10f997db \ - --hash=sha256:89bd777bc6624fe4115e9fac3352c79ed60f3bb18651420635f26e643e3dd1f6 \ - --hash=sha256:8dc70ca24c110503e16918a658b869019126ecfe03109b754c402daff12b3d9f \ - --hash=sha256:91da1d88226663594e3f6b4b8c3c8d85bd504117d043740a8e0ec449087cc494 \ - --hash=sha256:921bd305b10e82b4d1f5e802b6850677f965d8394203d182f078873851dada69 \ - --hash=sha256:932c754c2d51ad2b2271fd01c3d121daaa35e27efae2a616f77bf164bc0b3e94 \ - --hash=sha256:93efb0b4de7e340d99057415c749175e24c8864302369e05914682ba642e5d77 \ - --hash=sha256:97afb3a00b65cc0804d1c7abddbf090a81eaac02768af58cbdcaaa0a931e0b6d \ - --hash=sha256:97f07ed9f56a3b9b5f49d3661dc9607484e85c67e27f3e8be2c7d28ca032fec7 \ - --hash=sha256:98a9afa7b9007c67ed84c57c9e0ad86a6000da96eaa638e4f8abe5b65ff83f0a \ - --hash=sha256:9ab6ae226de48019caa8074894544af5b53a117ccb9d3b3dcb2871464c829438 \ - --hash=sha256:9c412fddd1b77a75aa904615ebaa6001f169b26fd467b4be93aded278266b288 \ - --hash=sha256:a1bc6ba083b145187f648b667e05a2534ecc4b9f2784c2cbe3089e44868f2b9b \ - --hash=sha256:a418486160228f64dd9e9efcd132679b7a02a5f22c982c78b6fc7dab3fefb635 \ - --hash=sha256:a4d336baed65d50d37b88ca5b60c0fa9d81e3a87d4a7930d3880d1624d5b31f3 \ - --hash=sha256:a6444696fce635783440b7f7a9fc24b3ad10a9ea3f0ab66c5905be1c19ccf17d \ - --hash=sha256:a7bc6e6fd0395bc052f16b1a8670859964dbd7003bd0af2ff08342eb6e442cfe \ - --hash=sha256:b4b8f3efc8d530a1544e5962bd6b403d5f7fe8b9e08227c6b255f98ad82b4ba0 \ - --hash=sha256:b5f56c3f344f2ccaf0dd875d3e180f631dc60a51b314295a3e681fe8cf851fbe \ - --hash=sha256:be5463ac478b623b9dd3937afd7fb7ab3d79dd290a28e2b6df292dc75063eb8a \ - --hash=sha256:c37d8ba9411d6003bba9e518db0db0c58a680ab9fe5179f040b0463644bc9805 \ - --hash=sha256:c84d689db21a1c397d001aa08241044aa2069e7587b398c8cc63020390b1c1b8 \ - --hash=sha256:c96d333dcf42d01f47b37e0979b6bd73ec91eae18614864622d9b87bbd5bbf36 \ - --hash=sha256:cadc9e0ea0a2431124cde7e1697106471fc4c1da01530e679b2391c37d3fbb3a \ - --hash=sha256:cc3e831b563b3114baac7ec2ee86819eb03caa1a2cef0b481a5675b59c4fe23b \ - --hash=sha256:cd8ff254faf15591e724dc7c4ddb6bf4793efcbe13802a4ae3e863cd300b493e \ - --hash=sha256:d000f46e2917c705e9fb93a3606ee4a819d1e3aa7a9b442f6444f07e77cf5e25 \ - --hash=sha256:d9da3df5f9ea2a89b81bb6087177fb1f4d1c7146d583a3fe5c672c0d94e55e12 \ - --hash=sha256:e5c5858ad8ec655450a7c7df532e9842cf8df7cc349df7225c60d5d348c8aada \ - --hash=sha256:e67d793d180c9df62f1f40aee3accca4829d3794c95098887edc18af4b8b780c \ - --hash=sha256:ea944117a7974ae78059fcc1800e5d3295172bb97035c0c1d9345fca1419da71 \ - --hash=sha256:eb76541cba2f958032d79d143b98a3a6b3ea87f0959bbe256c0b5e416599fd5d \ - --hash=sha256:ec1ee50470b0d050984394423d96325b744d55c701a439d2bd66089bff963d3c \ - --hash=sha256:ee92f2fd10f4adc4b43d07ec5e779932b4eb3dbfbc34790ada5a6669bc095aa6 \ - --hash=sha256:f0f5d8f4a08090c6d6d578351a2b91acf519a54986c055af27e7a93feae6d3f1 \ - --hash=sha256:f1f182ebd2303acf8c380a54f615ec883322593320a9b00438eb842c1f37ae50 \ - --hash=sha256:f8a5827f84d973d8636e9dc5764af4f0cf2318d26744b3d902931701b0d46653 \ - --hash=sha256:f944255db153ebb2b19c51fe85dd99ef0ce494123f21b9db4877ffdfc5590c7c \ - --hash=sha256:fdae223722da47b024b867c1ea0be64e0df702c5e0a60e27daad39bf960dd1e4 \ - --hash=sha256:fe27fb049cdcca11f11a7bfda64043c37b30e6b91f10cb5bab275806c32f6ab3 +pillow==12.0.0 \ + --hash=sha256:0869154a2d0546545cde61d1789a6524319fc1897d9ee31218eae7a60ccc5643 \ + --hash=sha256:09f2d0abef9e4e2f349305a4f8cc784a8a6c2f58a8c4892eea13b10a943bd26e \ + --hash=sha256:0b817e7035ea7f6b942c13aa03bb554fc44fea70838ea21f8eb31c638326584e \ + --hash=sha256:0fd00cac9c03256c8b2ff58f162ebcd2587ad3e1f2e397eab718c47e24d231cc \ + --hash=sha256:110486b79f2d112cf6add83b28b627e369219388f64ef2f960fef9ebaf54c642 \ + --hash=sha256:1979f4566bb96c1e50a62d9831e2ea2d1211761e5662afc545fa766f996632f6 \ + --hash=sha256:1ac11e8ea4f611c3c0147424eae514028b5e9077dd99ab91e1bd7bc33ff145e1 \ + --hash=sha256:1b1b133e6e16105f524a8dec491e0586d072948ce15c9b914e41cdadd209052b \ + --hash=sha256:1ee80a59f6ce048ae13cda1abf7fbd2a34ab9ee7d401c46be3ca685d1999a399 \ + --hash=sha256:21f241bdd5080a15bc86d3466a9f6074a9c2c2b314100dd896ac81ee6db2f1ba \ + --hash=sha256:266cd5f2b63ff316d5a1bba46268e603c9caf5606d44f38c2873c380950576ad \ + --hash=sha256:26d9f7d2b604cd23aba3e9faf795787456ac25634d82cd060556998e39c6fa47 \ + --hash=sha256:27f95b12453d165099c84f8a8bfdfd46b9e4bda9e0e4b65f0635430027f55739 \ + --hash=sha256:2c54c1a783d6d60595d3514f0efe9b37c8808746a66920315bfd34a938d7994b \ + --hash=sha256:2fa5f0b6716fc88f11380b88b31fe591a06c6315e955c096c35715788b339e3f \ + --hash=sha256:32ed80ea8a90ee3e6fa08c21e2e091bba6eda8eccc83dbc34c95169507a91f10 \ + --hash=sha256:3830c769decf88f1289680a59d4f4c46c72573446352e2befec9a8512104fa52 \ + --hash=sha256:38df9b4bfd3db902c9c2bd369bcacaf9d935b2fff73709429d95cc41554f7b3d \ + --hash=sha256:3adfb466bbc544b926d50fe8f4a4e6abd8c6bffd28a26177594e6e9b2b76572b \ + --hash=sha256:3e42edad50b6909089750e65c91aa09aaf1e0a71310d383f11321b27c224ed8a \ + --hash=sha256:4078242472387600b2ce8d93ade8899c12bf33fa89e55ec89fe126e9d6d5d9e9 \ + --hash=sha256:455247ac8a4cfb7b9bc45b7e432d10421aea9fc2e74d285ba4072688a74c2e9d \ + --hash=sha256:4cc6b3b2efff105c6a1656cfe59da4fdde2cda9af1c5e0b58529b24525d0a098 \ + --hash=sha256:4cf7fed4b4580601c4345ceb5d4cbf5a980d030fd5ad07c4d2ec589f95f09905 \ + --hash=sha256:5193fde9a5f23c331ea26d0cf171fbf67e3f247585f50c08b3e205c7aeb4589b \ + --hash=sha256:5269cc1caeedb67e6f7269a42014f381f45e2e7cd42d834ede3c703a1d915fe3 \ + --hash=sha256:53561a4ddc36facb432fae7a9d8afbfaf94795414f5cdc5fc52f28c1dca90371 \ + --hash=sha256:55f818bd74fe2f11d4d7cbc65880a843c4075e0ac7226bc1a23261dbea531953 \ + --hash=sha256:58eea5ebe51504057dd95c5b77d21700b77615ab0243d8152793dc00eb4faf01 \ + --hash=sha256:5d5c411a8eaa2299322b647cd932586b1427367fd3184ffbb8f7a219ea2041ca \ + --hash=sha256:6846bd2d116ff42cba6b646edf5bf61d37e5cbd256425fa089fee4ff5c07a99e \ + --hash=sha256:6ace95230bfb7cd79ef66caa064bbe2f2a1e63d93471c3a2e1f1348d9f22d6b7 \ + --hash=sha256:6e51b71417049ad6ab14c49608b4a24d8fb3fe605e5dfabfe523b58064dc3d27 \ + --hash=sha256:71db6b4c1653045dacc1585c1b0d184004f0d7e694c7b34ac165ca70c0838082 \ + --hash=sha256:7438839e9e053ef79f7112c881cef684013855016f928b168b81ed5835f3e75e \ + --hash=sha256:759de84a33be3b178a64c8ba28ad5c135900359e85fb662bc6e403ad4407791d \ + --hash=sha256:792a2c0be4dcc18af9d4a2dfd8a11a17d5e25274a1062b0ec1c2d79c76f3e7f8 \ + --hash=sha256:7d87ef5795da03d742bf49439f9ca4d027cde49c82c5371ba52464aee266699a \ + --hash=sha256:7dfb439562f234f7d57b1ac6bc8fe7f838a4bd49c79230e0f6a1da93e82f1fad \ + --hash=sha256:7fa22993bac7b77b78cae22bad1e2a987ddf0d9015c63358032f84a53f23cdc3 \ + --hash=sha256:805ebf596939e48dbb2e4922a1d3852cfc25c38160751ce02da93058b48d252a \ + --hash=sha256:82240051c6ca513c616f7f9da06e871f61bfd7805f566275841af15015b8f98d \ + --hash=sha256:87d4f8125c9988bfbed67af47dd7a953e2fc7b0cc1e7800ec6d2080d490bb353 \ + --hash=sha256:8d8ca2b210ada074d57fcee40c30446c9562e542fc46aedc19baf758a93532ee \ + --hash=sha256:8dc232e39d409036af549c86f24aed8273a40ffa459981146829a324e0848b4b \ + --hash=sha256:90387104ee8400a7b4598253b4c406f8958f59fcf983a6cea2b50d59f7d63d0b \ + --hash=sha256:905b0365b210c73afb0ebe9101a32572152dfd1c144c7e28968a331b9217b94a \ + --hash=sha256:99353a06902c2e43b43e8ff74ee65a7d90307d82370604746738a1e0661ccca7 \ + --hash=sha256:99a7f72fb6249302aa62245680754862a44179b545ded638cf1fef59befb57ef \ + --hash=sha256:9f0b04c6b8584c2c193babcccc908b38ed29524b29dd464bc8801bf10d746a3a \ + --hash=sha256:9fe611163f6303d1619bbcb653540a4d60f9e55e622d60a3108be0d5b441017a \ + --hash=sha256:a3475b96f5908b3b16c47533daaa87380c491357d197564e0ba34ae75c0f3257 \ + --hash=sha256:a6597ff2b61d121172f5844b53f21467f7082f5fb385a9a29c01414463f93b07 \ + --hash=sha256:a7921c5a6d31b3d756ec980f2f47c0cfdbce0fc48c22a39347a895f41f4a6ea4 \ + --hash=sha256:aa5129de4e174daccbc59d0a3b6d20eaf24417d59851c07ebb37aeb02947987c \ + --hash=sha256:aeaefa96c768fc66818730b952a862235d68825c178f1b3ffd4efd7ad2edcb7c \ + --hash=sha256:afbefa430092f71a9593a99ab6a4e7538bc9eabbf7bf94f91510d3503943edc4 \ + --hash=sha256:aff9e4d82d082ff9513bdd6acd4f5bd359f5b2c870907d2b0a9c5e10d40c88fe \ + --hash=sha256:b22bd8c974942477156be55a768f7aa37c46904c175be4e158b6a86e3a6b7ca8 \ + --hash=sha256:b290fd8aa38422444d4b50d579de197557f182ef1068b75f5aa8558638b8d0a5 \ + --hash=sha256:b2e4b27a6e15b04832fe9bf292b94b5ca156016bbc1ea9c2c20098a0320d6cf6 \ + --hash=sha256:b583dc9070312190192631373c6c8ed277254aa6e6084b74bdd0a6d3b221608e \ + --hash=sha256:b87843e225e74576437fd5b6a4c2205d422754f84a06942cfaf1dc32243e45a8 \ + --hash=sha256:bc91a56697869546d1b8f0a3ff35224557ae7f881050e99f615e0119bf934b4e \ + --hash=sha256:bd87e140e45399c818fac4247880b9ce719e4783d767e030a883a970be632275 \ + --hash=sha256:bde737cff1a975b70652b62d626f7785e0480918dece11e8fef3c0cf057351c3 \ + --hash=sha256:bdee52571a343d721fb2eb3b090a82d959ff37fc631e3f70422e0c2e029f3e76 \ + --hash=sha256:bee2a6db3a7242ea309aa7ee8e2780726fed67ff4e5b40169f2c940e7eb09227 \ + --hash=sha256:beeae3f27f62308f1ddbcfb0690bf44b10732f2ef43758f169d5e9303165d3f9 \ + --hash=sha256:c50f36a62a22d350c96e49ad02d0da41dbd17ddc2e29750dbdba4323f85eb4a5 \ + --hash=sha256:c607c90ba67533e1b2355b821fef6764d1dd2cbe26b8c1005ae84f7aea25ff79 \ + --hash=sha256:c7b2a63fd6d5246349f3d3f37b14430d73ee7e8173154461785e43036ffa96ca \ + --hash=sha256:c828a1ae702fc712978bda0320ba1b9893d99be0badf2647f693cc01cf0f04fa \ + --hash=sha256:c85de1136429c524e55cfa4e033b4a7940ac5c8ee4d9401cc2d1bf48154bbc7b \ + --hash=sha256:c98fa880d695de164b4135a52fd2e9cd7b7c90a9d8ac5e9e443a24a95ef9248e \ + --hash=sha256:cae81479f77420d217def5f54b5b9d279804d17e982e0f2fa19b1d1e14ab5197 \ + --hash=sha256:d034140032870024e6b9892c692fe2968493790dd57208b2c37e3fb35f6df3ab \ + --hash=sha256:d120c38a42c234dc9a8c5de7ceaaf899cf33561956acb4941653f8bdc657aa79 \ + --hash=sha256:d4827615da15cd59784ce39d3388275ec093ae3ee8d7f0c089b76fa87af756c2 \ + --hash=sha256:d49e2314c373f4c2b39446fb1a45ed333c850e09d0c59ac79b72eb3b95397363 \ + --hash=sha256:d52610d51e265a51518692045e372a4c363056130d922a7351429ac9f27e70b0 \ + --hash=sha256:d64317d2587c70324b79861babb9c09f71fbb780bad212018874b2c013d8600e \ + --hash=sha256:d77153e14b709fd8b8af6f66a3afbb9ed6e9fc5ccf0b6b7e1ced7b036a228782 \ + --hash=sha256:d7e091d464ac59d2c7ad8e7e08105eaf9dafbc3883fd7265ffccc2baad6ac925 \ + --hash=sha256:dd333073e0cacdc3089525c7df7d39b211bcdf31fc2824e49d01c6b6187b07d0 \ + --hash=sha256:e5d8efac84c9afcb40914ab49ba063d94f5dbdf5066db4482c66a992f47a3a3b \ + --hash=sha256:f135c702ac42262573fe9714dfe99c944b4ba307af5eb507abef1667e2cbbced \ + --hash=sha256:f13711b1a5ba512d647a0e4ba79280d3a9a045aaf7e0cc6fbe96b91d4cdf6b0c \ + --hash=sha256:f4f1231b7dec408e8670264ce63e9c71409d9583dd21d32c163e25213ee2a344 \ + --hash=sha256:fa3ed2a29a9e9d2d488b4da81dcb54720ac3104a20bf0bd273f1e4648aff5af9 \ + --hash=sha256:fb3096c30df99fd01c7bf8e544f392103d0795b9f98ba71a8054bcbf56b255f1 # via # -r .github/scripts/requirements_dev.in # pdf2image # weasyprint -platformdirs==4.3.8 \ - --hash=sha256:3d512d96e16bcb959a814c9f348431070822a6496326a4be0911c40b5a74c2bc \ - --hash=sha256:ff7059bb7eb1179e2685604f4aaf157cfd9535242bd23742eadc3c13542139b4 +platformdirs==4.5.0 \ + --hash=sha256:70ddccdd7c99fc5942e9fc25636a8b34d04c24b335100223152c2803e4063312 \ + --hash=sha256:e578a81bb873cbb89a41fcc904c7ef523cc18284b7e3b3ccf06aca1403b7ebd3 # via virtualenv pre-commit==4.3.0 \ --hash=sha256:2b0747ad7e6e967169136edffee14c16e148a778a54e4f967921aa1ebf2308d8 \ --hash=sha256:499fe450cc9d42e9d58e606262795ecb64dd05438943c62b66f6a8673da30b16 # via -r .github/scripts/requirements_dev.in -pycparser==2.22 \ - --hash=sha256:491c8be9c040f5390f5bf44a5b07752bd07f56edf992381b05c701439eec10f6 \ - --hash=sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc +pycparser==2.23 \ + --hash=sha256:78816d4f24add8f10a06d6f05b4d424ad9e96cfebf68a4ddc99c65c0720d00c2 \ + --hash=sha256:e5c6e8d3fbad53479cab09ac03729e0a9faf2bee3db8208a550daf5af81a5934 # via cffi pydyf==0.11.0 \ --hash=sha256:0aaf9e2ebbe786ec7a78ec3fbffa4cdcecde53fd6f563221d53c6bc1328848a3 \ @@ -469,60 +367,80 @@ pyphen==0.17.2 \ --hash=sha256:3a07fb017cb2341e1d9ff31b8634efb1ae4dc4b130468c7c39dd3d32e7c3affd \ --hash=sha256:f60647a9c9b30ec6c59910097af82bc5dd2d36576b918e44148d8b07ef3b4aa3 # via weasyprint -pyyaml==6.0.2 \ - --hash=sha256:01179a4a8559ab5de078078f37e5c1a30d76bb88519906844fd7bdea1b7729ff \ - --hash=sha256:0833f8694549e586547b576dcfaba4a6b55b9e96098b36cdc7ebefe667dfed48 \ - --hash=sha256:0a9a2848a5b7feac301353437eb7d5957887edbf81d56e903999a75a3d743086 \ - --hash=sha256:0b69e4ce7a131fe56b7e4d770c67429700908fc0752af059838b1cfb41960e4e \ - --hash=sha256:0ffe8360bab4910ef1b9e87fb812d8bc0a308b0d0eef8c8f44e0254ab3b07133 \ - --hash=sha256:11d8f3dd2b9c1207dcaf2ee0bbbfd5991f571186ec9cc78427ba5bd32afae4b5 \ - --hash=sha256:17e311b6c678207928d649faa7cb0d7b4c26a0ba73d41e99c4fff6b6c3276484 \ - --hash=sha256:1e2120ef853f59c7419231f3bf4e7021f1b936f6ebd222406c3b60212205d2ee \ - --hash=sha256:1f71ea527786de97d1a0cc0eacd1defc0985dcf6b3f17bb77dcfc8c34bec4dc5 \ - --hash=sha256:23502f431948090f597378482b4812b0caae32c22213aecf3b55325e049a6c68 \ - --hash=sha256:24471b829b3bf607e04e88d79542a9d48bb037c2267d7927a874e6c205ca7e9a \ - --hash=sha256:29717114e51c84ddfba879543fb232a6ed60086602313ca38cce623c1d62cfbf \ - --hash=sha256:2e99c6826ffa974fe6e27cdb5ed0021786b03fc98e5ee3c5bfe1fd5015f42b99 \ - --hash=sha256:39693e1f8320ae4f43943590b49779ffb98acb81f788220ea932a6b6c51004d8 \ - --hash=sha256:3ad2a3decf9aaba3d29c8f537ac4b243e36bef957511b4766cb0057d32b0be85 \ - --hash=sha256:3b1fdb9dc17f5a7677423d508ab4f243a726dea51fa5e70992e59a7411c89d19 \ - --hash=sha256:41e4e3953a79407c794916fa277a82531dd93aad34e29c2a514c2c0c5fe971cc \ - --hash=sha256:43fa96a3ca0d6b1812e01ced1044a003533c47f6ee8aca31724f78e93ccc089a \ - --hash=sha256:50187695423ffe49e2deacb8cd10510bc361faac997de9efef88badc3bb9e2d1 \ - --hash=sha256:5ac9328ec4831237bec75defaf839f7d4564be1e6b25ac710bd1a96321cc8317 \ - --hash=sha256:5d225db5a45f21e78dd9358e58a98702a0302f2659a3c6cd320564b75b86f47c \ - --hash=sha256:6395c297d42274772abc367baaa79683958044e5d3835486c16da75d2a694631 \ - --hash=sha256:688ba32a1cffef67fd2e9398a2efebaea461578b0923624778664cc1c914db5d \ - --hash=sha256:68ccc6023a3400877818152ad9a1033e3db8625d899c72eacb5a668902e4d652 \ - --hash=sha256:70b189594dbe54f75ab3a1acec5f1e3faa7e8cf2f1e08d9b561cb41b845f69d5 \ - --hash=sha256:797b4f722ffa07cc8d62053e4cff1486fa6dc094105d13fea7b1de7d8bf71c9e \ - --hash=sha256:7c36280e6fb8385e520936c3cb3b8042851904eba0e58d277dca80a5cfed590b \ - --hash=sha256:7e7401d0de89a9a855c839bc697c079a4af81cf878373abd7dc625847d25cbd8 \ - --hash=sha256:80bab7bfc629882493af4aa31a4cfa43a4c57c83813253626916b8c7ada83476 \ - --hash=sha256:82d09873e40955485746739bcb8b4586983670466c23382c19cffecbf1fd8706 \ - --hash=sha256:8388ee1976c416731879ac16da0aff3f63b286ffdd57cdeb95f3f2e085687563 \ - --hash=sha256:8824b5a04a04a047e72eea5cec3bc266db09e35de6bdfe34c9436ac5ee27d237 \ - --hash=sha256:8b9c7197f7cb2738065c481a0461e50ad02f18c78cd75775628afb4d7137fb3b \ - --hash=sha256:9056c1ecd25795207ad294bcf39f2db3d845767be0ea6e6a34d856f006006083 \ - --hash=sha256:936d68689298c36b53b29f23c6dbb74de12b4ac12ca6cfe0e047bedceea56180 \ - --hash=sha256:9b22676e8097e9e22e36d6b7bda33190d0d400f345f23d4065d48f4ca7ae0425 \ - --hash=sha256:a4d3091415f010369ae4ed1fc6b79def9416358877534caf6a0fdd2146c87a3e \ - --hash=sha256:a8786accb172bd8afb8be14490a16625cbc387036876ab6ba70912730faf8e1f \ - --hash=sha256:a9f8c2e67970f13b16084e04f134610fd1d374bf477b17ec1599185cf611d725 \ - --hash=sha256:bc2fa7c6b47d6bc618dd7fb02ef6fdedb1090ec036abab80d4681424b84c1183 \ - --hash=sha256:c70c95198c015b85feafc136515252a261a84561b7b1d51e3384e0655ddf25ab \ - --hash=sha256:cc1c1159b3d456576af7a3e4d1ba7e6924cb39de8f67111c735f6fc832082774 \ - --hash=sha256:ce826d6ef20b1bc864f0a68340c8b3287705cae2f8b4b1d932177dcc76721725 \ - --hash=sha256:d584d9ec91ad65861cc08d42e834324ef890a082e591037abe114850ff7bbc3e \ - --hash=sha256:d7fded462629cfa4b685c5416b949ebad6cec74af5e2d42905d41e257e0869f5 \ - --hash=sha256:d84a1718ee396f54f3a086ea0a66d8e552b2ab2017ef8b420e92edbc841c352d \ - --hash=sha256:d8e03406cac8513435335dbab54c0d385e4a49e4945d2909a581c83647ca0290 \ - --hash=sha256:e10ce637b18caea04431ce14fabcf5c64a1c61ec9c56b071a4b7ca131ca52d44 \ - --hash=sha256:ec031d5d2feb36d1d1a24380e4db6d43695f3748343d99434e6f5f9156aaa2ed \ - --hash=sha256:ef6107725bd54b262d6dedcc2af448a266975032bc85ef0172c5f059da6325b4 \ - --hash=sha256:efdca5630322a10774e8e98e1af481aad470dd62c3170801852d752aa7a783ba \ - --hash=sha256:f753120cb8181e736c57ef7636e83f31b9c0d1722c516f7e86cf15b7aa57ff12 \ - --hash=sha256:ff3824dc5261f50c9b0dfb3be22b4567a6f938ccce4587b38952d85fd9e9afe4 +pyyaml==6.0.3 \ + --hash=sha256:00c4bdeba853cc34e7dd471f16b4114f4162dc03e6b7afcc2128711f0eca823c \ + --hash=sha256:0150219816b6a1fa26fb4699fb7daa9caf09eb1999f3b70fb6e786805e80375a \ + --hash=sha256:02893d100e99e03eda1c8fd5c441d8c60103fd175728e23e431db1b589cf5ab3 \ + --hash=sha256:02ea2dfa234451bbb8772601d7b8e426c2bfa197136796224e50e35a78777956 \ + --hash=sha256:0f29edc409a6392443abf94b9cf89ce99889a1dd5376d94316ae5145dfedd5d6 \ + --hash=sha256:10892704fc220243f5305762e276552a0395f7beb4dbf9b14ec8fd43b57f126c \ + --hash=sha256:16249ee61e95f858e83976573de0f5b2893b3677ba71c9dd36b9cf8be9ac6d65 \ + --hash=sha256:1d37d57ad971609cf3c53ba6a7e365e40660e3be0e5175fa9f2365a379d6095a \ + --hash=sha256:1ebe39cb5fc479422b83de611d14e2c0d3bb2a18bbcb01f229ab3cfbd8fee7a0 \ + --hash=sha256:214ed4befebe12df36bcc8bc2b64b396ca31be9304b8f59e25c11cf94a4c033b \ + --hash=sha256:2283a07e2c21a2aa78d9c4442724ec1eb15f5e42a723b99cb3d822d48f5f7ad1 \ + --hash=sha256:22ba7cfcad58ef3ecddc7ed1db3409af68d023b7f940da23c6c2a1890976eda6 \ + --hash=sha256:27c0abcb4a5dac13684a37f76e701e054692a9b2d3064b70f5e4eb54810553d7 \ + --hash=sha256:28c8d926f98f432f88adc23edf2e6d4921ac26fb084b028c733d01868d19007e \ + --hash=sha256:2e71d11abed7344e42a8849600193d15b6def118602c4c176f748e4583246007 \ + --hash=sha256:34d5fcd24b8445fadc33f9cf348c1047101756fd760b4dacb5c3e99755703310 \ + --hash=sha256:37503bfbfc9d2c40b344d06b2199cf0e96e97957ab1c1b546fd4f87e53e5d3e4 \ + --hash=sha256:3c5677e12444c15717b902a5798264fa7909e41153cdf9ef7ad571b704a63dd9 \ + --hash=sha256:3ff07ec89bae51176c0549bc4c63aa6202991da2d9a6129d7aef7f1407d3f295 \ + --hash=sha256:41715c910c881bc081f1e8872880d3c650acf13dfa8214bad49ed4cede7c34ea \ + --hash=sha256:418cf3f2111bc80e0933b2cd8cd04f286338bb88bdc7bc8e6dd775ebde60b5e0 \ + --hash=sha256:44edc647873928551a01e7a563d7452ccdebee747728c1080d881d68af7b997e \ + --hash=sha256:4a2e8cebe2ff6ab7d1050ecd59c25d4c8bd7e6f400f5f82b96557ac0abafd0ac \ + --hash=sha256:4ad1906908f2f5ae4e5a8ddfce73c320c2a1429ec52eafd27138b7f1cbe341c9 \ + --hash=sha256:501a031947e3a9025ed4405a168e6ef5ae3126c59f90ce0cd6f2bfc477be31b7 \ + --hash=sha256:5190d403f121660ce8d1d2c1bb2ef1bd05b5f68533fc5c2ea899bd15f4399b35 \ + --hash=sha256:5498cd1645aa724a7c71c8f378eb29ebe23da2fc0d7a08071d89469bf1d2defb \ + --hash=sha256:5cf4e27da7e3fbed4d6c3d8e797387aaad68102272f8f9752883bc32d61cb87b \ + --hash=sha256:5e0b74767e5f8c593e8c9b5912019159ed0533c70051e9cce3e8b6aa699fcd69 \ + --hash=sha256:5ed875a24292240029e4483f9d4a4b8a1ae08843b9c54f43fcc11e404532a8a5 \ + --hash=sha256:5fcd34e47f6e0b794d17de1b4ff496c00986e1c83f7ab2fb8fcfe9616ff7477b \ + --hash=sha256:5fdec68f91a0c6739b380c83b951e2c72ac0197ace422360e6d5a959d8d97b2c \ + --hash=sha256:6344df0d5755a2c9a276d4473ae6b90647e216ab4757f8426893b5dd2ac3f369 \ + --hash=sha256:64386e5e707d03a7e172c0701abfb7e10f0fb753ee1d773128192742712a98fd \ + --hash=sha256:652cb6edd41e718550aad172851962662ff2681490a8a711af6a4d288dd96824 \ + --hash=sha256:66291b10affd76d76f54fad28e22e51719ef9ba22b29e1d7d03d6777a9174198 \ + --hash=sha256:66e1674c3ef6f541c35191caae2d429b967b99e02040f5ba928632d9a7f0f065 \ + --hash=sha256:6adc77889b628398debc7b65c073bcb99c4a0237b248cacaf3fe8a557563ef6c \ + --hash=sha256:79005a0d97d5ddabfeeea4cf676af11e647e41d81c9a7722a193022accdb6b7c \ + --hash=sha256:7c6610def4f163542a622a73fb39f534f8c101d690126992300bf3207eab9764 \ + --hash=sha256:7f047e29dcae44602496db43be01ad42fc6f1cc0d8cd6c83d342306c32270196 \ + --hash=sha256:8098f252adfa6c80ab48096053f512f2321f0b998f98150cea9bd23d83e1467b \ + --hash=sha256:850774a7879607d3a6f50d36d04f00ee69e7fc816450e5f7e58d7f17f1ae5c00 \ + --hash=sha256:8d1fab6bb153a416f9aeb4b8763bc0f22a5586065f86f7664fc23339fc1c1fac \ + --hash=sha256:8da9669d359f02c0b91ccc01cac4a67f16afec0dac22c2ad09f46bee0697eba8 \ + --hash=sha256:8dc52c23056b9ddd46818a57b78404882310fb473d63f17b07d5c40421e47f8e \ + --hash=sha256:9149cad251584d5fb4981be1ecde53a1ca46c891a79788c0df828d2f166bda28 \ + --hash=sha256:93dda82c9c22deb0a405ea4dc5f2d0cda384168e466364dec6255b293923b2f3 \ + --hash=sha256:96b533f0e99f6579b3d4d4995707cf36df9100d67e0c8303a0c55b27b5f99bc5 \ + --hash=sha256:9c57bb8c96f6d1808c030b1687b9b5fb476abaa47f0db9c0101f5e9f394e97f4 \ + --hash=sha256:9c7708761fccb9397fe64bbc0395abcae8c4bf7b0eac081e12b809bf47700d0b \ + --hash=sha256:9f3bfb4965eb874431221a3ff3fdcddc7e74e3b07799e0e84ca4a0f867d449bf \ + --hash=sha256:a33284e20b78bd4a18c8c2282d549d10bc8408a2a7ff57653c0cf0b9be0afce5 \ + --hash=sha256:a80cb027f6b349846a3bf6d73b5e95e782175e52f22108cfa17876aaeff93702 \ + --hash=sha256:b30236e45cf30d2b8e7b3e85881719e98507abed1011bf463a8fa23e9c3e98a8 \ + --hash=sha256:b3bc83488de33889877a0f2543ade9f70c67d66d9ebb4ac959502e12de895788 \ + --hash=sha256:b865addae83924361678b652338317d1bd7e79b1f4596f96b96c77a5a34b34da \ + --hash=sha256:b8bb0864c5a28024fac8a632c443c87c5aa6f215c0b126c449ae1a150412f31d \ + --hash=sha256:ba1cc08a7ccde2d2ec775841541641e4548226580ab850948cbfda66a1befcdc \ + --hash=sha256:bdb2c67c6c1390b63c6ff89f210c8fd09d9a1217a465701eac7316313c915e4c \ + --hash=sha256:c1ff362665ae507275af2853520967820d9124984e0f7466736aea23d8611fba \ + --hash=sha256:c2514fceb77bc5e7a2f7adfaa1feb2fb311607c9cb518dbc378688ec73d8292f \ + --hash=sha256:c3355370a2c156cffb25e876646f149d5d68f5e0a3ce86a5084dd0b64a994917 \ + --hash=sha256:c458b6d084f9b935061bc36216e8a69a7e293a2f1e68bf956dcd9e6cbcd143f5 \ + --hash=sha256:d0eae10f8159e8fdad514efdc92d74fd8d682c933a6dd088030f3834bc8e6b26 \ + --hash=sha256:d76623373421df22fb4cf8817020cbb7ef15c725b9d5e45f17e189bfc384190f \ + --hash=sha256:ebc55a14a21cb14062aa4162f906cd962b28e2e9ea38f9b4391244cd8de4ae0b \ + --hash=sha256:eda16858a3cab07b80edaf74336ece1f986ba330fdb8ee0d6c0d68fe82bc96be \ + --hash=sha256:ee2922902c45ae8ccada2c5b501ab86c36525b883eff4255313a253a3160861c \ + --hash=sha256:efd7b85f94a6f21e4932043973a7ba2613b059c4a000551892ac9f1d11f5baf3 \ + --hash=sha256:f7057c9a337546edc7973c0d3ba84ddcdf0daa14533c2065749c9075001090e6 \ + --hash=sha256:fa160448684b4e94d80416c0fa4aac48967a969efe22931448d853ada8baf926 \ + --hash=sha256:fc09d0aa354569bc501d4e787133afc08552722d3ab34836a80547331bb5d4a0 # via pre-commit tinycss2==1.4.0 \ --hash=sha256:10c0972f6fc0fbee87c3edb76549357415e94548c1ae10ebccdea16fb404a9b7 \ @@ -534,13 +452,13 @@ tinyhtml5==2.0.0 \ --hash=sha256:086f998833da24c300c414d9fe81d9b368fd04cb9d2596a008421cbc705fcfcc \ --hash=sha256:13683277c5b176d070f82d099d977194b7a1e26815b016114f581a74bbfbf47e # via weasyprint -unoserver==3.3.2 \ - --hash=sha256:1eeb7467cf6b56b8eff3b576e2d1b2b2ff4e0eb2052e995ac80a1456de300639 \ - --hash=sha256:87e144f903ee21951b2e06a97549450c13ed7eca5bcebad942d3352d4e882616 +unoserver==3.4 \ + --hash=sha256:3dcf2204013def1d1ddd3671f38b11346bdf349fef9728277462666a8a634419 \ + --hash=sha256:64c24d33d4f65d680a2d9f676518cb28e7fd6c1f9d9a745c33e4a4cb59afdfcd # via -r .github/scripts/requirements_dev.in -virtualenv==20.33.1 \ - --hash=sha256:07c19bc66c11acab6a5958b815cbcee30891cd1c2ccf53785a28651a0d8d8a67 \ - --hash=sha256:1b44478d9e261b3fb8baa5e74a0ca3bc0e05f21aa36167bf9cbf850e542765b8 +virtualenv==20.35.4 \ + --hash=sha256:643d3914d73d3eeb0c552cbb12d7e82adf0e504dbf86a3182f8771a153a1971c \ + --hash=sha256:c21c9cede36c9753eeade68ba7d523529f228a403463376cf821eaae2b650f1b # via pre-commit weasyprint==66.0 \ --hash=sha256:82b0783b726fcd318e2c977dcdddca76515b30044bc7a830cc4fbe717582a6d0 \ @@ -628,9 +546,9 @@ zopfli==0.2.3.post1 \ # via fonttools # The following packages are considered to be unsafe in a requirements file: -pip==25.2 \ - --hash=sha256:578283f006390f85bb6282dffb876454593d637f5d1be494b5202ce4877e71f2 \ - --hash=sha256:6d67a2b4e7f14d8b31b8b52648866fa717f45a1eb70e83002f4331d07e953717 +pip==25.3 \ + --hash=sha256:8d0538dbbd7babbd207f261ed969c65de439f6bc9e5dbd3b3b9a77f25d95f343 \ + --hash=sha256:9655943313a94722b7774661c21049070f6bbb0a1516bf02f7c8d5d9201514cd # via -r .github/scripts/requirements_dev.in setuptools==80.9.0 \ --hash=sha256:062d34222ad13e0cc312a4c02d73f059e86a4acbfbdea8f8f76b28c99f306922 \ diff --git a/.github/scripts/requirements_pre_commit.txt b/.github/scripts/requirements_pre_commit.txt index 60b3041420..b98227afb1 100644 --- a/.github/scripts/requirements_pre_commit.txt +++ b/.github/scripts/requirements_pre_commit.txt @@ -4,17 +4,17 @@ # # pip-compile --generate-hashes --output-file='.github\scripts\requirements_pre_commit.txt' --strip-extras '.github\scripts\requirements_pre_commit.in' # -cfgv==3.4.0 \ - --hash=sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9 \ - --hash=sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560 +cfgv==3.5.0 \ + --hash=sha256:a8dc6b26ad22ff227d2634a65cb388215ce6cc96bbcc5cfde7641ae87e8dacc0 \ + --hash=sha256:d5b1034354820651caa73ede66a6294d6e95c1b00acc5e9b098e917404669132 # via pre-commit distlib==0.4.0 \ --hash=sha256:9659f7d87e46584a30b5780e43ac7a2143098441670ff0a49d5f9034c54a6c16 \ --hash=sha256:feec40075be03a04501a973d81f633735b4b69f98b05450592310c0f401a4e0d # via virtualenv -filelock==3.19.1 \ - --hash=sha256:66eda1888b0171c998b35be2bcc0f6d75c388a7ce20c3f3f37aa8e96c2dddf58 \ - --hash=sha256:d38e30481def20772f5baf097c122c3babc4fcdb7e14e57049eb9d88c6dc017d +filelock==3.20.0 \ + --hash=sha256:339b4732ffda5cd79b13f4e2711a31b0365ce445d95d243bb996273d072546a2 \ + --hash=sha256:711e943b4ec6be42e1d4e6690b48dc175c822967466bb31c0c293f34334c13f4 # via virtualenv identify==2.6.15 \ --hash=sha256:1181ef7608e00704db228516541eb83a88a9f94433a8c80bb9b5bd54b1d81757 \ @@ -24,13 +24,13 @@ nodeenv==1.9.1 \ --hash=sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f \ --hash=sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9 # via pre-commit -platformdirs==4.4.0 \ - --hash=sha256:abd01743f24e5287cd7a5db3752faf1a2d65353f38ec26d98e25a6db65958c85 \ - --hash=sha256:ca753cf4d81dc309bc67b0ea38fd15dc97bc30ce419a7f58d13eb3bf14c4febf +platformdirs==4.5.0 \ + --hash=sha256:70ddccdd7c99fc5942e9fc25636a8b34d04c24b335100223152c2803e4063312 \ + --hash=sha256:e578a81bb873cbb89a41fcc904c7ef523cc18284b7e3b3ccf06aca1403b7ebd3 # via virtualenv -pre-commit==4.3.0 \ - --hash=sha256:2b0747ad7e6e967169136edffee14c16e148a778a54e4f967921aa1ebf2308d8 \ - --hash=sha256:499fe450cc9d42e9d58e606262795ecb64dd05438943c62b66f6a8673da30b16 +pre-commit==4.5.0 \ + --hash=sha256:25e2ce09595174d9c97860a95609f9f852c0614ba602de3561e267547f2335e1 \ + --hash=sha256:dc5a065e932b19fc1d4c653c6939068fe54325af8e741e74e88db4d28a4dd66b # via -r .github/scripts/requirements_pre_commit.in pyyaml==6.0.3 \ --hash=sha256:00c4bdeba853cc34e7dd471f16b4114f4162dc03e6b7afcc2128711f0eca823c \ @@ -107,7 +107,7 @@ pyyaml==6.0.3 \ --hash=sha256:fa160448684b4e94d80416c0fa4aac48967a969efe22931448d853ada8baf926 \ --hash=sha256:fc09d0aa354569bc501d4e787133afc08552722d3ab34836a80547331bb5d4a0 # via pre-commit -virtualenv==20.34.0 \ - --hash=sha256:341f5afa7eee943e4984a9207c025feedd768baff6753cd660c857ceb3e36026 \ - --hash=sha256:44815b2c9dee7ed86e387b842a84f20b93f7f417f95886ca1996a72a4138eb1a +virtualenv==20.35.4 \ + --hash=sha256:643d3914d73d3eeb0c552cbb12d7e82adf0e504dbf86a3182f8771a153a1971c \ + --hash=sha256:c21c9cede36c9753eeade68ba7d523529f228a403463376cf821eaae2b650f1b # via pre-commit diff --git a/.github/scripts/requirements_sync_readme.in b/.github/scripts/requirements_sync_readme.in index 8141b83103..f7501c6d0e 100644 --- a/.github/scripts/requirements_sync_readme.in +++ b/.github/scripts/requirements_sync_readme.in @@ -1 +1,2 @@ tomlkit +tomli-w diff --git a/.github/scripts/requirements_sync_readme.txt b/.github/scripts/requirements_sync_readme.txt index eb0cd9bf7f..a5cf36a683 100644 --- a/.github/scripts/requirements_sync_readme.txt +++ b/.github/scripts/requirements_sync_readme.txt @@ -4,6 +4,10 @@ # # pip-compile --generate-hashes --output-file='.github\scripts\requirements_sync_readme.txt' --strip-extras '.github\scripts\requirements_sync_readme.in' # +tomli-w==1.2.0 \ + --hash=sha256:188306098d013b691fcadc011abd66727d3c414c571bb01b1a174ba8c983cf90 \ + --hash=sha256:2dd14fac5a47c27be9cd4c976af5a12d87fb1f0b4512f81d69cce3b35ae25021 + # via -r .github/scripts/requirements_sync_readme.in tomlkit==0.13.3 \ --hash=sha256:430cf247ee57df2b94ee3fbe588e71d362a941ebb545dec29b53961d61add2a1 \ --hash=sha256:c89c649d79ee40629a9fda55f8ace8c6a1b42deb912b2a8fd8d942ddadb606b0 diff --git a/.github/workflows/PR-Auto-Deploy-V2.yml b/.github/workflows/PR-Auto-Deploy-V2.yml index ad6d6f3dc4..9ee5826227 100644 --- a/.github/workflows/PR-Auto-Deploy-V2.yml +++ b/.github/workflows/PR-Auto-Deploy-V2.yml @@ -37,7 +37,7 @@ jobs: - name: Resolve PR info id: resolve - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: script: | const { owner, repo } = context.repo; @@ -52,7 +52,6 @@ jobs: core.setOutput('repository', pr.head.repo.full_name); core.setOutput('ref', pr.head.ref); core.setOutput('is_fork', String(pr.head.repo.fork)); - core.setOutput('base_ref', pr.base.ref); core.setOutput('author', pr.user.login); core.setOutput('state', pr.state); @@ -65,10 +64,6 @@ jobs: IS_FORK: ${{ steps.resolve.outputs.is_fork }} # nur bei workflow_dispatch gesetzt: ALLOW_FORK_INPUT: ${{ inputs.allow_fork }} - # für Auto-PR-Logik: - PR_TITLE: ${{ github.event.pull_request.title }} - PR_BRANCH: ${{ github.event.pull_request.head.ref }} - PR_BASE: ${{ steps.resolve.outputs.base_ref }} PR_AUTHOR: ${{ steps.resolve.outputs.author }} run: | set -e @@ -89,14 +84,8 @@ jobs: else auth_users=("Frooodle" "sf298" "Ludy87" "LaserKaspar" "sbplat" "reecebrowne" "DarioGii" "ConnorYoh" "EthanHealy01" "jbrunton96" "balazs-szucs") is_auth=false; for u in "${auth_users[@]}"; do [ "$u" = "$PR_AUTHOR" ] && is_auth=true && break; done - if [ "$PR_BASE" = "V2" ] && [ "$is_auth" = true ]; then + if [ "$is_auth" = true ]; then should=true - else - title_has_v2=false; echo "$PR_TITLE" | grep -qiE 'v2|version.?2|version.?two' && title_has_v2=true - branch_has_kw=false; echo "$PR_BRANCH" | grep -qiE 'v2|react' && branch_has_kw=true - if [ "$is_auth" = true ] && { [ "$title_has_v2" = true ] || [ "$branch_has_kw" = true ]; }; then - should=true - fi fi fi @@ -139,7 +128,7 @@ jobs: - name: Add deployment started comment id: deployment-started - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: github-token: ${{ steps.setup-bot.outputs.token }} script: | @@ -174,7 +163,7 @@ jobs: owner, repo, issue_number: prNumber, - body: `🚀 **Auto-deploying V2 version** for PR #${prNumber}...\n\n_This is an automated deployment triggered by V2/version2 keywords in the PR title or V2/React keywords in the branch name._\n\n⚠️ **Note:** If new commits are pushed during deployment, this build will be cancelled and replaced with the latest version.` + body: `🚀 **Auto-deploying V2 version** for PR #${prNumber}...\n\n_This is an automated deployment for approved V2 contributors._\n\n⚠️ **Note:** If new commits are pushed during deployment, this build will be cancelled and replaced with the latest version.` }); return newComment.id; @@ -363,7 +352,7 @@ jobs: - name: Post V2 deployment URL to PR if: success() - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: github-token: ${{ steps.setup-bot.outputs.token }} script: | @@ -394,7 +383,7 @@ jobs: `🔗 **Direct Test URL (non-SSL)** [${deploymentUrl}](${deploymentUrl})\n\n` + `🔐 **Secure HTTPS URL**: [${httpsUrl}](${httpsUrl})\n\n` + `_This deployment will be automatically cleaned up when the PR is closed._\n\n` + - `🔄 **Auto-deployed** because PR title or branch name contains V2/version2/React keywords.`; + `🔄 **Auto-deployed** for approved V2 contributors.`; await github.rest.issues.createComment({ owner, @@ -430,7 +419,7 @@ jobs: private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} - name: Clean up V2 deployment comments - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: github-token: ${{ steps.setup-bot.outputs.token }} script: | diff --git a/.github/workflows/PR-Demo-Comment-with-react.yml b/.github/workflows/PR-Demo-Comment-with-react.yml index c7aa66d4eb..edb5f273a4 100644 --- a/.github/workflows/PR-Demo-Comment-with-react.yml +++ b/.github/workflows/PR-Demo-Comment-with-react.yml @@ -41,12 +41,12 @@ jobs: enable_enterprise: ${{ steps.check-pro-flag.outputs.enable_enterprise }} steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout PR - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Setup GitHub App Bot if: github.actor != 'dependabot[bot]' @@ -129,12 +129,12 @@ jobs: steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout PR - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Setup GitHub App Bot if: github.actor != 'dependabot[bot]' @@ -146,7 +146,7 @@ jobs: private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} - name: Checkout PR - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: ref: refs/pull/${{ needs.check-comment.outputs.pr_number }}/merge token: ${{ steps.setup-bot.outputs.token }} @@ -357,3 +357,149 @@ jobs: rm -f ../private.key docker-compose.yml echo "Cleanup complete." continue-on-error: true + + handle-label-commands: + if: ${{ github.event.issue.pull_request != null }} + runs-on: ubuntu-latest + steps: + - name: Harden Runner + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 + with: + egress-policy: audit + + - name: Check out the repository + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 + + - name: Setup GitHub App Bot + id: setup-bot + uses: ./.github/actions/setup-bot + with: + app-id: ${{ secrets.GH_APP_ID }} + private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} + + - name: Apply label commands + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 + with: + github-token: ${{ steps.setup-bot.outputs.token }} + script: | + const fs = require('fs'); + const path = require('path'); + + const { comment, issue } = context.payload; + const commentBody = comment?.body ?? ''; + if (!commentBody.includes('::label::')) { + core.info('No label commands detected in comment.'); + return; + } + + const configPath = path.join(process.env.GITHUB_WORKSPACE, '.github', 'config', 'repo_devs.json'); + const repoDevsConfig = JSON.parse(fs.readFileSync(configPath, 'utf8')); + const label_changer = (repoDevsConfig.label_changer || []).map((login) => login.toLowerCase()); + + const commenter = (comment?.user?.login || '').toLowerCase(); + if (!label_changer.includes(commenter)) { + core.info(`User ${commenter} is not authorized to manage labels.`); + return; + } + + const labelsConfigPath = path.join(process.env.GITHUB_WORKSPACE, '.github', 'labels.yml'); + const labelsFile = fs.readFileSync(labelsConfigPath, 'utf8'); + + const labelNameMap = new Map(); + for (const match of labelsFile.matchAll(/-\s+name:\s*(?:"([^"]+)"|'([^']+)'|([^\n]+))/g)) { + const labelName = (match[1] ?? match[2] ?? match[3] ?? '').trim(); + + if (!labelName) { + continue; + } + const normalized = labelName.toLowerCase(); + if (!labelNameMap.has(normalized)) { + labelNameMap.set(normalized, labelName); + } + } + + if (!labelNameMap.size) { + core.warning('No labels could be read from .github/labels.yml; aborting label commands.'); + return; + } + + let allowedLabelNames = new Set(labelNameMap.values()); + + const labelsToAdd = new Set(); + const labelsToRemove = new Set(); + const commandRegex = /^(\w+)::(label)::"([^"]+)"/gim; + let match; + while ((match = commandRegex.exec(commentBody)) !== null) { + core.info(`Found label command: ${match[0]} (action: ${match[1]}, label: ${match[2]}, labelName: ${match[3]})`); + const action = match[1].toLowerCase(); + const labelName = match[3].trim(); + + if (!labelName) { + continue; + } + + const normalized = labelName.toLowerCase(); + const resolvedLabelName = labelNameMap.get(normalized); + if (action === 'add') { + if (!resolvedLabelName) { + core.warning(`Label "${labelName}" is not defined in .github/labels.yml and cannot be added.`); + continue; + } + if (!allowedLabelNames.has(resolvedLabelName)) { + core.warning(`Label "${resolvedLabelName}" is not allowed for add commands and will be skipped.`); + continue; + } + labelsToAdd.add(resolvedLabelName); + } else if (action === 'rm') { + const labelToRemove = resolvedLabelName ?? labelName; + if (!resolvedLabelName) { + core.warning(`Label "${labelName}" is not defined in .github/labels.yml; attempting to remove as provided.`); + } + labelsToRemove.add(labelToRemove); + } + } + + const addLabels = Array.from(labelsToAdd); + const removeLabels = Array.from(labelsToRemove); + + if (!addLabels.length && !removeLabels.length) { + core.info('No valid label commands found after parsing.'); + return; + } + + const issueParams = { + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + }; + + if (addLabels.length) { + core.info(`Adding labels: ${addLabels.join(', ')}`); + await github.rest.issues.addLabels({ + ...issueParams, + labels: addLabels, + }); + } + + for (const labelName of removeLabels) { + core.info(`Removing label: ${labelName}`); + try { + await github.rest.issues.removeLabel({ + ...issueParams, + name: labelName, + }); + } catch (error) { + if (error.status === 404) { + core.warning(`Label "${labelName}" was not present on the pull request.`); + } else { + throw error; + } + } + } + + await github.rest.issues.deleteComment({ + owner: context.repo.owner, + repo: context.repo.repo, + comment_id: comment.id, + }); + core.info('Processed label commands and deleted the comment.'); diff --git a/.github/workflows/PR-Demo-cleanup.yml b/.github/workflows/PR-Demo-cleanup.yml index 47f1e8ed9f..621322df73 100644 --- a/.github/workflows/PR-Demo-cleanup.yml +++ b/.github/workflows/PR-Demo-cleanup.yml @@ -21,12 +21,12 @@ jobs: steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout PR - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Setup GitHub App Bot if: github.actor != 'dependabot[bot]' diff --git a/.github/workflows/ai_pr_title_review.yml b/.github/workflows/ai_pr_title_review.yml index 77668d69a6..6dd4c0f041 100644 --- a/.github/workflows/ai_pr_title_review.yml +++ b/.github/workflows/ai_pr_title_review.yml @@ -19,11 +19,11 @@ jobs: steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: fetch-depth: 0 @@ -87,7 +87,7 @@ jobs: - name: AI PR Title Analysis if: steps.actor.outputs.is_repo_dev == 'true' id: ai-title-analysis - uses: actions/ai-inference@b81b2afb8390ee6839b494a404766bef6493c7d9 # v1.2.8 + uses: actions/ai-inference@334892bb203895caaed82ec52d23c1ed9385151e # v2.0.4 with: model: openai/gpt-4o system-prompt-file: ".github/config/system-prompt.txt" diff --git a/.github/workflows/auto-labelerV2.yml b/.github/workflows/auto-labelerV2.yml index d66ea570ae..d776aa7ac8 100644 --- a/.github/workflows/auto-labelerV2.yml +++ b/.github/workflows/auto-labelerV2.yml @@ -2,6 +2,9 @@ name: "Auto Pull Request Labeler V2" on: pull_request_target: types: [opened, synchronize] + branches: + - main + - V2 permissions: contents: read @@ -13,11 +16,11 @@ jobs: pull-requests: write steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Setup GitHub App Bot id: setup-bot diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a5df3e9ec6..bfd1c12814 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -238,7 +238,7 @@ jobs: sudo chmod +x /usr/local/bin/docker-compose - name: Set up Python - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 + uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 with: python-version: "3.12" cache: 'pip' # caching pip dependencies diff --git a/.github/workflows/check_toml.yml b/.github/workflows/check_toml.yml index 8fc1a75b8b..dd5a28ac36 100644 --- a/.github/workflows/check_toml.yml +++ b/.github/workflows/check_toml.yml @@ -25,12 +25,12 @@ jobs: pull-requests: write # Allow writing to pull requests steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout main branch first - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Setup GitHub App Bot id: setup-bot @@ -194,13 +194,12 @@ jobs: core.exportVariable("REFERENCE_FILE", referenceFilePath); - name: Set up Python - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 + uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 with: python-version: "3.12" - name: Install Python dependencies - run: | - pip install tomli-w + run: pip install --require-hashes -r ./.github/scripts/requirements_sync_readme.txt - name: Run Python script to check files id: run-check diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index a35b32c15c..923123e947 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -17,13 +17,13 @@ jobs: runs-on: ubuntu-latest steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: "Checkout Repository" - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: "Dependency Review" - uses: actions/dependency-review-action@56339e523c0409420f6c2c9a2f4292bbb3c07dd3 # v4.8.0 + uses: actions/dependency-review-action@3c4e3dcb1aa7874d2c16be7d79418e9b7efd6261 # v4.8.2 with: config-file: './.github/config/dependency-review-config.yml' diff --git a/.github/workflows/deploy-on-v2-commit.yml b/.github/workflows/deploy-on-v2-commit.yml index f2f90ccfa1..4309d5233d 100644 --- a/.github/workflows/deploy-on-v2-commit.yml +++ b/.github/workflows/deploy-on-v2-commit.yml @@ -23,10 +23,10 @@ jobs: egress-policy: audit - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 - name: Get commit hashes for frontend and backend id: commit-hashes @@ -86,14 +86,14 @@ jobs: - name: Login to Docker Hub - uses: docker/login-action@v3 + uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0 with: username: ${{ secrets.DOCKER_HUB_USERNAME }} password: ${{ secrets.DOCKER_HUB_API }} - name: Build and push frontend image if: steps.check-frontend.outputs.exists == 'false' - uses: docker/build-push-action@v6 + uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0 with: context: . file: ./docker/frontend/Dockerfile @@ -106,7 +106,7 @@ jobs: - name: Build and push backend image if: steps.check-backend.outputs.exists == 'false' - uses: docker/build-push-action@v6 + uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0 with: context: . file: ./docker/backend/Dockerfile diff --git a/.github/workflows/frontend-licenses-update.yml b/.github/workflows/frontend-licenses-update.yml index 33f295640c..1bc56699ff 100644 --- a/.github/workflows/frontend-licenses-update.yml +++ b/.github/workflows/frontend-licenses-update.yml @@ -253,7 +253,7 @@ jobs: - name: Create Pull Request (Push only) id: cpr if: github.event_name == 'push' && env.CHANGES_DETECTED == 'true' - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8 + uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0 with: token: ${{ steps.setup-bot.outputs.token }} commit-message: "Update Frontend 3rd Party Licenses" diff --git a/.github/workflows/licenses-update.yml b/.github/workflows/licenses-update.yml index a3dadc2729..6ec74cb1d3 100644 --- a/.github/workflows/licenses-update.yml +++ b/.github/workflows/licenses-update.yml @@ -31,12 +31,12 @@ jobs: repository-projects: write # Required for enabling automerge steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Check out code - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: fetch-depth: 0 @@ -64,7 +64,7 @@ jobs: - name: Upload artifact on failure if: failure() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 with: name: dependencies-without-allowed-license.json path: build/reports/dependency-license/dependencies-without-allowed-license.json @@ -82,7 +82,7 @@ jobs: - name: Create Pull Request id: cpr if: env.CHANGES_DETECTED == 'true' - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8 + uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0 with: token: ${{ steps.setup-bot.outputs.token }} commit-message: "Update 3rd Party Licenses" diff --git a/.github/workflows/manage-label.yml b/.github/workflows/manage-label.yml index d480249f25..ee6bb3492e 100644 --- a/.github/workflows/manage-label.yml +++ b/.github/workflows/manage-label.yml @@ -15,12 +15,12 @@ jobs: issues: write steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Check out the repository - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Run Labeler uses: crazy-max/ghaction-github-labeler@24d110aa46a59976b8a7f35518cb7f14f434c916 # v5.3.0 diff --git a/.github/workflows/multiOSReleases.yml b/.github/workflows/multiOSReleases.yml index ed8617a15a..e3b2fead3e 100644 --- a/.github/workflows/multiOSReleases.yml +++ b/.github/workflows/multiOSReleases.yml @@ -50,14 +50,14 @@ jobs: version: ${{ steps.versionNumber.outputs.versionNumber }} steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Set up JDK 21 - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 with: java-version: "21" distribution: "temurin" @@ -118,14 +118,14 @@ jobs: file_suffix: "-server" steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Set up JDK 21 - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 with: java-version: "21" distribution: "temurin" @@ -157,7 +157,7 @@ jobs: cp app/core/build/libs/stirling-pdf-${{ needs.determine-matrix.outputs.version }}.jar ./jar-dist/Stirling-PDF${{ matrix.variant.file_suffix }}.jar - name: Upload JAR artifacts - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 with: name: jar${{ matrix.variant.file_suffix }} path: ./jar-dist/*.jar @@ -251,7 +251,7 @@ jobs: targets: ${{ (matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel') && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }} - name: Set up JDK 21 - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 with: java-version: "21" distribution: "temurin" @@ -619,7 +619,7 @@ jobs: fi - name: Upload build artifacts - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 with: name: Stirling-PDF-${{ matrix.name }} path: ./dist/* @@ -633,30 +633,30 @@ jobs: contents: write steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Download all Tauri artifacts - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 with: pattern: Stirling-PDF-* path: ./artifacts/tauri - name: Download JAR artifact (default) - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 with: name: jar path: ./artifacts/jars - name: Download JAR artifact (with login) - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 with: name: jar-with-login path: ./artifacts/jars - name: Download JAR artifact (server only) - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 with: name: jar-server path: ./artifacts/jars @@ -665,7 +665,7 @@ jobs: run: ls -R ./artifacts - name: Upload binaries to Release - uses: softprops/action-gh-release@62c96d0c4e8a889135c1f3a25910db8dbe0e85f7 # v2.3.4 + uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b # v2.5.0 with: tag_name: v${{ needs.determine-matrix.outputs.version }} generate_release_notes: true diff --git a/.github/workflows/pre_commit.yml b/.github/workflows/pre_commit.yml index acd489f5b7..7977d3e37e 100644 --- a/.github/workflows/pre_commit.yml +++ b/.github/workflows/pre_commit.yml @@ -21,12 +21,12 @@ jobs: pull-requests: write steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout repository - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: fetch-depth: 0 @@ -38,7 +38,7 @@ jobs: private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} - name: Set up Python - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 + uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 with: python-version: 3.12 cache: 'pip' # caching pip dependencies @@ -67,7 +67,7 @@ jobs: - name: Create Pull Request if: env.CHANGES_DETECTED == 'true' - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8 + uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0 with: token: ${{ steps.setup-bot.outputs.token }} commit-message: ":file_folder: pre-commit" diff --git a/.github/workflows/push-docker-v2.yml b/.github/workflows/push-docker-v2.yml index 061cf40edb..3f2e18134b 100644 --- a/.github/workflows/push-docker-v2.yml +++ b/.github/workflows/push-docker-v2.yml @@ -5,7 +5,7 @@ on: push: branches: - V2-master - - alljavadocker + - V1_V2_merge # cancel in-progress jobs if a new job is triggered # This is useful to avoid running multiple builds for the same branch if a new commit is pushed @@ -83,7 +83,7 @@ jobs: - name: Generate tags for latest (V2-master branch - production) id: meta - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 if: github.ref == 'refs/heads/V2-master' with: images: | @@ -95,10 +95,10 @@ jobs: type=raw,value=${{ steps.versionNumber.outputs.versionNumber }} type=raw,value=latest - - name: Generate tags for latest (alljavadocker branch - test) + - name: Generate tags for latest (V1_V2_merge branch - test) id: meta-test - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 - if: github.ref == 'refs/heads/alljavadocker' + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 + if: github.ref == 'refs/heads/V1_V2_merge' with: images: | ghcr.io/stirling-tools/stirling-pdf-test @@ -139,7 +139,7 @@ jobs: - name: Generate tags for latest-fat (V2-master branch - production) id: meta-fat - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 if: github.ref == 'refs/heads/V2-master' with: images: | @@ -151,10 +151,10 @@ jobs: type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-fat type=raw,value=latest-fat - - name: Generate tags for latest-fat (alljavadocker branch - test) + - name: Generate tags for latest-fat (V1_V2_merge branch - test) id: meta-fat-test - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 - if: github.ref == 'refs/heads/alljavadocker' + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 + if: github.ref == 'refs/heads/V1_V2_merge' with: images: | ghcr.io/stirling-tools/stirling-pdf-test @@ -193,7 +193,7 @@ jobs: - name: Generate tags for ultra-lite (V2-master branch - production) id: meta-lite - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 if: github.ref == 'refs/heads/V2-master' with: images: | @@ -205,10 +205,10 @@ jobs: type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-ultra-lite type=raw,value=latest-ultra-lite - - name: Generate tags for ultra-lite (alljavadocker branch - test) + - name: Generate tags for ultra-lite (V1_V2_merge branch - test) id: meta-lite-test - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 - if: github.ref == 'refs/heads/alljavadocker' + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 + if: github.ref == 'refs/heads/V1_V2_merge' with: images: | ghcr.io/stirling-tools/stirling-pdf-test diff --git a/.github/workflows/push-docker.yml b/.github/workflows/push-docker.yml index ecf3fdc954..eb4277071a 100644 --- a/.github/workflows/push-docker.yml +++ b/.github/workflows/push-docker.yml @@ -31,11 +31,11 @@ jobs: id-token: write steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Set up JDK 17 uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 @@ -55,7 +55,7 @@ jobs: - name: Install cosign if: github.ref == 'refs/heads/master' - uses: sigstore/cosign-installer@d7543c93d881b35a8faa02e8e3605f69b7a1ce62 # v3.10.0 + uses: sigstore/cosign-installer@faadad0cce49287aee09b3a48701e75088a2c6ad # v4.0.0 with: cosign-release: "v2.4.1" @@ -81,7 +81,7 @@ jobs: password: ${{ github.token }} - name: Set up QEMU - uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0 + uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0 - name: Convert repository owner to lowercase id: repoowner @@ -89,7 +89,7 @@ jobs: - name: Generate tags id: meta - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 if: github.ref != 'refs/heads/main' with: images: | @@ -135,7 +135,7 @@ jobs: - name: Generate tags ultra-lite id: meta2 - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 if: github.ref != 'refs/heads/main' with: images: | @@ -166,7 +166,7 @@ jobs: - name: Generate tags fat id: meta3 - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 with: images: | ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf diff --git a/.github/workflows/releaseArtifacts.yml b/.github/workflows/releaseArtifacts.yml index 70cfced99e..7fdb11056b 100644 --- a/.github/workflows/releaseArtifacts.yml +++ b/.github/workflows/releaseArtifacts.yml @@ -26,7 +26,7 @@ jobs: matrix: ${{ steps.set-matrix.outputs.matrix }} version: ${{ steps.versionNumber.outputs.versionNumber }} steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Get version number id: versionNumber @@ -68,12 +68,12 @@ jobs: WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }} steps: - name: Harden Runner - uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout repository - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Install dependencies (ubuntu only) if: matrix.platform == 'ubuntu-22.04' @@ -95,7 +95,7 @@ jobs: targets: ${{ (matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel') && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }} - name: Set up JDK 21 - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 with: java-version: "21" distribution: "temurin" @@ -448,7 +448,7 @@ jobs: egress-policy: audit - name: Download build artifacts - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 with: name: Stirling-PDF-${{ matrix.name }} @@ -517,7 +517,7 @@ jobs: egress-policy: audit - name: Download all signed artifacts - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 with: pattern: Stirling-PDF-*-signed path: ./artifacts @@ -526,7 +526,7 @@ jobs: run: ls -R ./artifacts - name: Create GitHub Release - uses: softprops/action-gh-release@62c96d0c4e8a889135c1f3a25910db8dbe0e85f7 # v2.3.4 + uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b # v2.5.0 with: tag_name: v${{ needs.determine-matrix.outputs.version }} generate_release_notes: true diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml index d83accd49c..ab5fdd583a 100644 --- a/.github/workflows/scorecards.yml +++ b/.github/workflows/scorecards.yml @@ -35,12 +35,12 @@ jobs: steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: "Checkout code" - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: persist-credentials: false @@ -67,7 +67,7 @@ jobs: # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF # format to the repository Actions tab. - name: "Upload artifact" - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 with: name: SARIF file path: results.sarif @@ -75,6 +75,6 @@ jobs: # Upload the results to GitHub's code scanning dashboard. - name: "Upload to code-scanning" - uses: github/codeql-action/upload-sarif@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.29.5 + uses: github/codeql-action/upload-sarif@fdbfb4d2750291e159f0156def62b853c2798ca2 # v3.29.5 with: sarif_file: results.sarif diff --git a/.github/workflows/sonarqube.yml b/.github/workflows/sonarqube.yml deleted file mode 100644 index dd419b310e..0000000000 --- a/.github/workflows/sonarqube.yml +++ /dev/null @@ -1,76 +0,0 @@ -name: Run Sonarqube - -on: - push: - branches: - - master - pull_request_target: - branches: - - main - workflow_dispatch: - -# cancel in-progress jobs if a new job is triggered -# This is useful to avoid running multiple builds for the same branch if a new commit is pushed -# or a pull request is updated. -# It helps to save resources and time by ensuring that only the latest commit is built and tested -# This is particularly useful for long-running jobs that may take a while to complete. -# The `group` is set to a combination of the workflow name, event name, and branch name. -# This ensures that jobs are grouped by the workflow and branch, allowing for cancellation of -# in-progress jobs when a new commit is pushed to the same branch or a new pull request is opened. -concurrency: - group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref_name || github.ref }} - cancel-in-progress: true - -permissions: - pull-requests: read - actions: read - -jobs: - sonarqube: - if: ${{ vars.CI_PROFILE != 'lite' }} - runs-on: ubuntu-latest - steps: - - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 - with: - egress-policy: audit - - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 - with: - fetch-depth: 0 - - - name: Setup Gradle - uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 - - - name: Build and analyze with Gradle - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} - DISABLE_ADDITIONAL_FEATURES: false - STIRLING_PDF_DESKTOP_UI: true - run: | - ./gradlew clean build sonar \ - -Dsonar.projectKey=Stirling-Tools_Stirling-PDF \ - -Dsonar.organization=stirling-tools \ - -Dsonar.host.url=https://sonarcloud.io \ - -Dsonar.login=${SONAR_TOKEN} \ - -Dsonar.log.level=DEBUG \ - --info - - - name: Upload Problems Report on Failure - if: failure() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 - with: - name: gradle-problems-report - path: build/reports/problems/problems-report.html - retention-days: 7 - - - name: Upload Sonar Logs on Failure - if: failure() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 - with: - name: sonar-logs - path: | - .scannerwork/report-task.txt - build/sonar/ - retention-days: 7 diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index c53bb4a4bb..d2d29c5bce 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -17,12 +17,12 @@ jobs: pull-requests: write steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: 30 days stale issues - uses: actions/stale@5f858e3efba33a5ca4407a664cc011ad407f2008 # v10.1.0 + uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} days-before-stale: 30 diff --git a/.github/workflows/swagger.yml b/.github/workflows/swagger.yml index 6e9cdb4354..0fc542496c 100644 --- a/.github/workflows/swagger.yml +++ b/.github/workflows/swagger.yml @@ -27,11 +27,11 @@ jobs: runs-on: ubuntu-latest steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Set up JDK 17 uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 diff --git a/.github/workflows/sync_files_v2.yml b/.github/workflows/sync_files_v2.yml index 935252be25..d72ba8a9da 100644 --- a/.github/workflows/sync_files_v2.yml +++ b/.github/workflows/sync_files_v2.yml @@ -33,11 +33,11 @@ jobs: runs-on: ubuntu-latest steps: - name: Harden Runner - uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Setup GitHub App Bot id: setup-bot @@ -47,14 +47,13 @@ jobs: private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} - name: Set up Python - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 + uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 with: python-version: "3.12" cache: "pip" # caching pip dependencies - name: Install Python dependencies - run: | - pip install tomli-w + run: pip install --require-hashes -r ./.github/scripts/requirements_sync_readme.txt - name: Sync translation TOML files run: | @@ -65,9 +64,6 @@ jobs: git add frontend/public/locales/*/translation.toml git diff --staged --quiet || git commit -m ":memo: Sync translation files (TOML)" || echo "No changes detected" - - name: Install README dependencies - run: pip install --require-hashes -r ./.github/scripts/requirements_sync_readme.txt - - name: Sync README.md run: | python scripts/counter_translation_v3.py @@ -79,7 +75,7 @@ jobs: - name: Create Pull Request if: always() - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8 + uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0 with: token: ${{ steps.setup-bot.outputs.token }} commit-message: Update files diff --git a/.github/workflows/testdriver.yml b/.github/workflows/testdriver.yml index 12d5bc48d0..59bf2824fc 100644 --- a/.github/workflows/testdriver.yml +++ b/.github/workflows/testdriver.yml @@ -25,12 +25,12 @@ jobs: runs-on: ubuntu-latest steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - name: Checkout repository - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Set up JDK uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 @@ -125,7 +125,7 @@ jobs: outputs: frontend: ${{ steps.changes.outputs.frontend }} steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Check for file changes uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 @@ -140,14 +140,14 @@ jobs: steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 - name: Set up Node - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0 + uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0 with: cache: 'npm' cache-dependency-path: frontend/package-lock.json @@ -176,7 +176,7 @@ jobs: steps: - name: Harden Runner - uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1 + uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2 with: egress-policy: audit diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a97b3a2a84..6541be4237 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.12.7 + rev: v0.14.8 hooks: - id: ruff args: @@ -22,11 +22,11 @@ repos: files: \.(html|css|js|py|md)$ exclude: (.vscode|.devcontainer|app/core/src/main/resources|app/proprietary/src/main/resources|Dockerfile|.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js) - repo: https://github.com/gitleaks/gitleaks - rev: v8.28.0 + rev: v8.30.0 hooks: - id: gitleaks - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v5.0.0 + rev: v6.0.0 hooks: - id: end-of-file-fixer files: ^.*(\.js|\.java|\.py|\.yml)$ diff --git a/app/allowed-licenses.json b/app/allowed-licenses.json index 830ae037a7..315c6bb188 100644 --- a/app/allowed-licenses.json +++ b/app/allowed-licenses.json @@ -96,6 +96,22 @@ "moduleName": ".*", "moduleLicense": "MPL 2.0" }, + { + "moduleName": ".*", + "moduleLicense": "Mozilla Public License, Version 2.0" + }, + { + "moduleName": ".*", + "moduleLicense": "Mozilla Public License 2.0 (MPL-2.0)" + }, + { + "moduleName": ".*", + "moduleLicense": "CDDL+GPL License" + }, + { + "moduleName": ".*", + "moduleLicense": "BSD" + }, { "moduleName": ".*", "moduleLicense": "UnboundID SCIM2 SDK Free Use License" diff --git a/app/common/build.gradle b/app/common/build.gradle index e2184a4a07..313eecdf8d 100644 --- a/app/common/build.gradle +++ b/app/common/build.gradle @@ -33,16 +33,16 @@ dependencies { api 'com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:20240325.1' api 'com.fathzer:javaluator:3.0.6' api 'com.posthog.java:posthog:1.2.0' - api 'org.apache.commons:commons-lang3:3.19.0' + api 'org.apache.commons:commons-lang3:3.20.0' api 'com.drewnoakes:metadata-extractor:2.19.0' // Image metadata extractor api 'com.vladsch.flexmark:flexmark-html2md-converter:0.64.8' api "org.apache.pdfbox:pdfbox:$pdfboxVersion" api "org.apache.pdfbox:xmpbox:$pdfboxVersion" api "org.apache.pdfbox:preflight:$pdfboxVersion" - api 'com.github.junrar:junrar:7.5.5' // RAR archive support for CBR files + api 'com.github.junrar:junrar:7.5.7' // RAR archive support for CBR files api 'jakarta.servlet:jakarta.servlet-api:6.1.0' api 'org.snakeyaml:snakeyaml-engine:2.10' - api "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.13" + api "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.14" api 'jakarta.mail:jakarta.mail-api:2.1.5' runtimeOnly 'org.eclipse.angus:angus-mail:2.0.5' } diff --git a/app/common/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java b/app/common/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java index 35f68939c3..c752485f0c 100644 --- a/app/common/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java +++ b/app/common/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java @@ -156,19 +156,19 @@ public class EndpointConfiguration { return false; } + // Rule 2: For tool groups, they're enabled unless explicitly disabled (handled above) + if (isToolGroup(group)) { + log.debug("isGroupEnabled('{}') -> true (tool group not disabled)", group); + return true; + } + + // Rule 3: For functional groups, check if all endpoints are enabled Set endpoints = endpointGroups.get(group); if (endpoints == null || endpoints.isEmpty()) { log.debug("isGroupEnabled('{}') -> false (no endpoints)", group); return false; } - // Rule 2: For functional groups, check if all endpoints are enabled - // Rule 3: For tool groups, they're enabled unless explicitly disabled (handled above) - if (isToolGroup(group)) { - log.debug("isGroupEnabled('{}') -> true (tool group not disabled)", group); - return true; - } - // For functional groups, check each endpoint individually for (String endpoint : endpoints) { if (!isEndpointEnabledDirectly(endpoint)) { @@ -334,6 +334,9 @@ public class EndpointConfiguration { addEndpointToGroup("Convert", "pdf-to-csv"); addEndpointToGroup("Convert", "pdf-to-markdown"); addEndpointToGroup("Convert", "eml-to-pdf"); + addEndpointToGroup("Convert", "pdf-to-vector"); + addEndpointToGroup("Convert", "vector-to-pdf"); + addEndpointToGroup("Convert", "pdf-to-video"); addEndpointToGroup("Convert", "cbz-to-pdf"); addEndpointToGroup("Convert", "pdf-to-cbz"); addEndpointToGroup("Convert", "pdf-to-json"); @@ -350,6 +353,7 @@ public class EndpointConfiguration { addEndpointToGroup("Security", "auto-redact"); addEndpointToGroup("Security", "redact"); addEndpointToGroup("Security", "validate-signature"); + addEndpointToGroup("Security", "verify-pdf"); addEndpointToGroup("Security", "stamp"); addEndpointToGroup("Security", "sign"); @@ -476,6 +480,8 @@ public class EndpointConfiguration { addEndpointToGroup("Java", "pdf-to-json"); addEndpointToGroup("Java", "json-to-pdf"); addEndpointToGroup("rar", "pdf-to-cbr"); + addEndpointToGroup("Java", "pdf-to-video"); + addEndpointToGroup("Java", "verify-pdf"); // Javascript addEndpointToGroup("Javascript", "pdf-organizer"); @@ -490,6 +496,13 @@ public class EndpointConfiguration { /* Ghostscript */ addEndpointToGroup("Ghostscript", "repair"); addEndpointToGroup("Ghostscript", "compress-pdf"); + addEndpointToGroup("Ghostscript", "crop"); + addEndpointToGroup("Ghostscript", "replace-invert-pdf"); + addEndpointToGroup("Ghostscript", "pdf-to-vector"); + addEndpointToGroup("Ghostscript", "vector-to-pdf"); + + /* ImageMagick */ + addEndpointToGroup("ImageMagick", "compress-pdf"); /* tesseract */ addEndpointToGroup("tesseract", "ocr-pdf"); @@ -525,6 +538,9 @@ public class EndpointConfiguration { addEndpointToGroup("Weasyprint", "markdown-to-pdf"); addEndpointToGroup("Weasyprint", "eml-to-pdf"); + // veraPDF dependent endpoints + addEndpointToGroup("veraPDF", "verify-pdf"); + // Pdftohtml dependent endpoints addEndpointToGroup("Pdftohtml", "pdf-to-html"); addEndpointToGroup("Pdftohtml", "pdf-to-markdown"); @@ -551,7 +567,7 @@ public class EndpointConfiguration { disableGroup("enterprise"); } - if (!applicationProperties.getSystem().getEnableUrlToPDF()) { + if (!applicationProperties.getSystem().isEnableUrlToPDF()) { disableEndpoint("url-to-pdf"); } } @@ -574,7 +590,11 @@ public class EndpointConfiguration { || "Javascript".equals(group) || "Weasyprint".equals(group) || "Pdftohtml".equals(group) - || "rar".equals(group); + || "ImageMagick".equals(group) + || "rar".equals(group) + || "Calibre".equals(group) + || "FFmpeg".equals(group) + || "veraPDF".equals(group); } private boolean isEndpointEnabledDirectly(String endpoint) { diff --git a/app/common/src/main/java/stirling/software/common/aop/AutoJobAspect.java b/app/common/src/main/java/stirling/software/common/aop/AutoJobAspect.java index ac36cd0d74..5e7ce13274 100644 --- a/app/common/src/main/java/stirling/software/common/aop/AutoJobAspect.java +++ b/app/common/src/main/java/stirling/software/common/aop/AutoJobAspect.java @@ -37,7 +37,7 @@ public class AutoJobAspect { @Around("@annotation(autoJobPostMapping)") public Object wrapWithJobExecution( - ProceedingJoinPoint joinPoint, AutoJobPostMapping autoJobPostMapping) { + ProceedingJoinPoint joinPoint, AutoJobPostMapping autoJobPostMapping) throws Exception { // This aspect will run before any audit aspects due to @Order(0) // Extract parameters from the request and annotation boolean async = Boolean.parseBoolean(request.getParameter("async")); @@ -81,6 +81,12 @@ public class AutoJobAspect { "AutoJobAspect caught exception during job execution: {}", ex.getMessage(), ex); + // Rethrow RuntimeException as-is to preserve exception type + if (ex instanceof RuntimeException) { + throw (RuntimeException) ex; + } + // Wrap checked exceptions - GlobalExceptionHandler will unwrap + // BaseAppException throw new RuntimeException(ex); } }, @@ -109,7 +115,8 @@ public class AutoJobAspect { int maxRetries, boolean trackProgress, boolean queueable, - int resourceWeight) { + int resourceWeight) + throws Exception { // Keep jobId reference for progress tracking in TaskManager AtomicReference jobIdRef = new AtomicReference<>(); @@ -207,6 +214,12 @@ public class AutoJobAspect { // If we get here, all retries failed if (lastException != null) { + // Rethrow RuntimeException as-is to preserve exception type + if (lastException instanceof RuntimeException) { + throw (RuntimeException) lastException; + } + // Wrap checked exceptions - GlobalExceptionHandler will unwrap + // BaseAppException throw new RuntimeException( "Job failed after " + maxRetries diff --git a/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java b/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java index 272c0b35ce..efc42046d7 100644 --- a/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java +++ b/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java @@ -37,10 +37,6 @@ public class AppConfig { private final ApplicationProperties applicationProperties; - @Getter - @Value("${baseUrl:http://localhost}") - private String baseUrl; - @Getter @Value("${server.servlet.context-path:/}") private String contextPath; @@ -49,6 +45,17 @@ public class AppConfig { @Value("${server.port:8080}") private String serverPort; + /** + * Get the backend URL from system configuration. Falls back to http://localhost if not + * configured. + * + * @return The backend base URL for SAML/OAuth/API callbacks + */ + public String getBackendUrl() { + String backendUrl = applicationProperties.getSystem().getBackendUrl(); + return (backendUrl != null && !backendUrl.isBlank()) ? backendUrl : "http://localhost"; + } + @Value("${v2}") public boolean v2Enabled; @@ -69,7 +76,7 @@ public class AppConfig { @Bean(name = "loginEnabled") public boolean loginEnabled() { - return applicationProperties.getSecurity().getEnableLogin(); + return applicationProperties.getSecurity().isEnableLogin(); } @Bean(name = "appName") @@ -113,9 +120,7 @@ public class AppConfig { @Bean(name = "enableAlphaFunctionality") public boolean enableAlphaFunctionality() { - return applicationProperties.getSystem().getEnableAlphaFunctionality() != null - ? applicationProperties.getSystem().getEnableAlphaFunctionality() - : false; + return applicationProperties.getSystem().isEnableAlphaFunctionality(); } @Bean(name = "rateLimit") @@ -258,9 +263,14 @@ public class AppConfig { return "NORMAL"; } - @Bean(name = "disablePixel") - public boolean disablePixel() { - return Boolean.parseBoolean(env.getProperty("DISABLE_PIXEL", "false")); + @Bean(name = "scarfEnabled") + public boolean scarfEnabled() { + return applicationProperties.getSystem().isScarfEnabled(); + } + + @Bean(name = "posthogEnabled") + public boolean posthogEnabled() { + return applicationProperties.getSystem().isPosthogEnabled(); } @Bean(name = "machineType") diff --git a/app/common/src/main/java/stirling/software/common/configuration/InstallationPathConfig.java b/app/common/src/main/java/stirling/software/common/configuration/InstallationPathConfig.java index db00c6960f..cc5401f865 100644 --- a/app/common/src/main/java/stirling/software/common/configuration/InstallationPathConfig.java +++ b/app/common/src/main/java/stirling/software/common/configuration/InstallationPathConfig.java @@ -2,6 +2,7 @@ package stirling.software.common.configuration; import java.io.File; import java.nio.file.Paths; +import java.util.Locale; import lombok.extern.slf4j.Slf4j; @@ -61,7 +62,7 @@ public class InstallationPathConfig { private static String initializeBasePath() { if (Boolean.parseBoolean(System.getProperty("STIRLING_PDF_DESKTOP_UI", "false"))) { - String os = System.getProperty("os.name").toLowerCase(); + String os = System.getProperty("os.name").toLowerCase(Locale.ROOT); if (os.contains("win")) { return Paths.get( System.getenv("APPDATA"), // parent path diff --git a/app/common/src/main/java/stirling/software/common/configuration/RuntimePathConfig.java b/app/common/src/main/java/stirling/software/common/configuration/RuntimePathConfig.java index 53fa97c251..7e6da0f0f2 100644 --- a/app/common/src/main/java/stirling/software/common/configuration/RuntimePathConfig.java +++ b/app/common/src/main/java/stirling/software/common/configuration/RuntimePathConfig.java @@ -10,8 +10,10 @@ import lombok.Getter; import lombok.extern.slf4j.Slf4j; import stirling.software.common.model.ApplicationProperties; +import stirling.software.common.model.ApplicationProperties.CustomPaths; import stirling.software.common.model.ApplicationProperties.CustomPaths.Operations; import stirling.software.common.model.ApplicationProperties.CustomPaths.Pipeline; +import stirling.software.common.model.ApplicationProperties.System; @Slf4j @Configuration @@ -19,8 +21,16 @@ import stirling.software.common.model.ApplicationProperties.CustomPaths.Pipeline public class RuntimePathConfig { private final ApplicationProperties properties; private final String basePath; + + // Operation paths private final String weasyPrintPath; private final String unoConvertPath; + private final String calibrePath; + private final String ocrMyPdfPath; + private final String sOfficePath; + + // Tesseract data path + private final String tessDataPath; // Pipeline paths private final String pipelineWatchedFoldersPath; @@ -37,7 +47,10 @@ public class RuntimePathConfig { String defaultFinishedFolders = Path.of(this.pipelinePath, "finishedFolders").toString(); String defaultWebUIConfigs = Path.of(this.pipelinePath, "defaultWebUIConfigs").toString(); - Pipeline pipeline = properties.getSystem().getCustomPaths().getPipeline(); + System system = properties.getSystem(); + CustomPaths customPaths = system.getCustomPaths(); + + Pipeline pipeline = customPaths.getPipeline(); this.pipelineWatchedFoldersPath = resolvePath( @@ -57,8 +70,11 @@ public class RuntimePathConfig { // Initialize Operation paths String defaultWeasyPrintPath = isDocker ? "/opt/venv/bin/weasyprint" : "weasyprint"; String defaultUnoConvertPath = isDocker ? "/opt/venv/bin/unoconvert" : "unoconvert"; + String defaultCalibrePath = isDocker ? "/opt/calibre/ebook-convert" : "ebook-convert"; + String defaultOcrMyPdfPath = isDocker ? "/usr/bin/ocrmypdf" : "ocrmypdf"; + String defaultSOfficePath = isDocker ? "/usr/bin/soffice" : "soffice"; - Operations operations = properties.getSystem().getCustomPaths().getOperations(); + Operations operations = customPaths.getOperations(); this.weasyPrintPath = resolvePath( defaultWeasyPrintPath, @@ -67,6 +83,28 @@ public class RuntimePathConfig { resolvePath( defaultUnoConvertPath, operations != null ? operations.getUnoconvert() : null); + this.calibrePath = + resolvePath( + defaultCalibrePath, operations != null ? operations.getCalibre() : null); + this.ocrMyPdfPath = + resolvePath( + defaultOcrMyPdfPath, operations != null ? operations.getOcrmypdf() : null); + this.sOfficePath = + resolvePath( + defaultSOfficePath, operations != null ? operations.getSoffice() : null); + + // Initialize Tesseract data path + String defaultTessDataPath = + isDocker ? "/usr/share/tesseract-ocr/5/tessdata" : "/usr/share/tessdata"; + + String tessPath = system.getTessdataDir(); + String tessdataDir = java.lang.System.getenv("TESSDATA_PREFIX"); + + this.tessDataPath = + resolvePath( + defaultTessDataPath, + (tessPath != null && !tessPath.isEmpty()) ? tessPath : tessdataDir); + log.info("Using Tesseract data path: {}", this.tessDataPath); } private String resolvePath(String defaultPath, String customPath) { diff --git a/app/common/src/main/java/stirling/software/common/model/ApplicationProperties.java b/app/common/src/main/java/stirling/software/common/model/ApplicationProperties.java index 35ddddeaac..b8cd4e7786 100644 --- a/app/common/src/main/java/stirling/software/common/model/ApplicationProperties.java +++ b/app/common/src/main/java/stirling/software/common/model/ApplicationProperties.java @@ -12,6 +12,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; +import java.util.Locale; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Bean; @@ -68,6 +69,7 @@ public class ApplicationProperties { private AutoPipeline autoPipeline = new AutoPipeline(); private ProcessExecutor processExecutor = new ProcessExecutor(); + private PdfEditor pdfEditor = new PdfEditor(); @Bean public PropertySource dynamicYamlPropertySource(ConfigurableEnvironment environment) @@ -100,6 +102,46 @@ public class ApplicationProperties { private String outputFolder; } + @Data + public static class PdfEditor { + private Cache cache = new Cache(); + private FontNormalization fontNormalization = new FontNormalization(); + private CffConverter cffConverter = new CffConverter(); + private Type3 type3 = new Type3(); + private String fallbackFont = "classpath:/static/fonts/NotoSans-Regular.ttf"; + + @Data + public static class Cache { + private long maxBytes = -1; + private int maxPercent = 20; + } + + @Data + public static class FontNormalization { + private boolean enabled = false; + } + + @Data + public static class CffConverter { + private boolean enabled = true; + private String method = "python"; + private String pythonCommand = "/opt/venv/bin/python3"; + private String pythonScript = "/scripts/convert_cff_to_ttf.py"; + private String fontforgeCommand = "fontforge"; + } + + @Data + public static class Type3 { + private Library library = new Library(); + + @Data + public static class Library { + private boolean enabled = true; + private String index = "classpath:/type3/library/index.json"; + } + } + } + @Data public static class Legal { private String termsAndConditions; @@ -111,7 +153,7 @@ public class ApplicationProperties { @Data public static class Security { - private Boolean enableLogin; + private boolean enableLogin; private InitialLogin initialLogin = new InitialLogin(); private OAUTH2 oauth2 = new OAUTH2(); private SAML2 saml2 = new SAML2(); @@ -286,7 +328,7 @@ public class ApplicationProperties { private KeycloakProvider keycloak = new KeycloakProvider(); public Provider get(String registrationId) throws UnsupportedProviderException { - return switch (registrationId.toLowerCase()) { + return switch (registrationId.toLowerCase(Locale.ROOT)) { case "google" -> getGoogle(); case "github" -> getGithub(); case "keycloak" -> getKeycloak(); @@ -294,8 +336,8 @@ public class ApplicationProperties { throw new UnsupportedProviderException( "Logout from the provider " + registrationId - + " is not supported. " - + "Report it at https://github.com/Stirling-Tools/Stirling-PDF/issues"); + + " is not supported. Report it at" + + " https://github.com/Stirling-Tools/Stirling-PDF/issues"); }; } } @@ -348,29 +390,33 @@ public class ApplicationProperties { @Data public static class System { private String defaultLocale; - private Boolean googlevisibility; + private boolean googlevisibility; private boolean showUpdate; - private Boolean showUpdateOnlyAdmin; + private boolean showUpdateOnlyAdmin; + private boolean showSettingsWhenNoLogin = true; private boolean customHTMLFiles; private String tessdataDir; - private Boolean enableAlphaFunctionality; + private boolean enableAlphaFunctionality; private Boolean enableAnalytics; private Boolean enablePosthog; private Boolean enableScarf; + private Boolean enableDesktopInstallSlide; private Datasource datasource; - private Boolean disableSanitize; + private boolean disableSanitize; private int maxDPI; - private Boolean enableUrlToPDF; + private boolean enableUrlToPDF; private Html html = new Html(); private CustomPaths customPaths = new CustomPaths(); private String fileUploadLimit; private TempFileManagement tempFileManagement = new TempFileManagement(); private DatabaseBackup databaseBackup = new DatabaseBackup(); private List corsAllowedOrigins = new ArrayList<>(); - private String - frontendUrl; // Base URL for frontend (used for invite links, etc.). If not set, + private String backendUrl; // Backend base URL for SAML/OAuth/API callbacks (e.g. + // 'http://localhost:8080', 'https://api.example.com'). Required for + // SSO. + private String frontendUrl; // Frontend URL for invite email links (e.g. - // falls back to backend URL. + // 'https://app.example.com'). If not set, falls back to backendUrl. public boolean isAnalyticsEnabled() { return this.getEnableAnalytics() != null && this.getEnableAnalytics(); @@ -410,6 +456,9 @@ public class ApplicationProperties { public static class Operations { private String weasyprint; private String unoconvert; + private String calibre; + private String ocrmypdf; + private String soffice; } } @@ -492,10 +541,10 @@ public class ApplicationProperties { @Override public String toString() { return """ - Driver { - driverName='%s' - } - """ + Driver { + driverName='%s' + } + """ .formatted(driverName); } } @@ -527,7 +576,7 @@ public class ApplicationProperties { @Data public static class Metrics { - private Boolean enabled; + private boolean enabled; } @Data @@ -535,6 +584,7 @@ public class ApplicationProperties { @ToString.Exclude private String key; private String UUID; private String appVersion; + private Boolean isNewServer; } // TODO: Remove post migration @@ -623,6 +673,25 @@ public class ApplicationProperties { public static class EnterpriseFeatures { private PersistentMetrics persistentMetrics = new PersistentMetrics(); private Audit audit = new Audit(); + private DatabaseNotifications databaseNotifications = new DatabaseNotifications(); + + @Data + public static class DatabaseNotifications { + private Backup backups = new Backup(); + private Imports imports = new Imports(); + + @Data + public static class Backup { + private boolean successful = false; + private boolean failed = false; + } + + @Data + public static class Imports { + private boolean successful = false; + private boolean failed = false; + } + } @Data public static class Audit { @@ -652,10 +721,12 @@ public class ApplicationProperties { private int weasyPrintSessionLimit; private int installAppSessionLimit; private int calibreSessionLimit; + private int imageMagickSessionLimit; private int qpdfSessionLimit; private int tesseractSessionLimit; private int ghostscriptSessionLimit; private int ocrMyPdfSessionLimit; + private int ffmpegSessionLimit; public int getQpdfSessionLimit() { return qpdfSessionLimit > 0 ? qpdfSessionLimit : 2; @@ -689,6 +760,10 @@ public class ApplicationProperties { return calibreSessionLimit > 0 ? calibreSessionLimit : 1; } + public int getImageMagickSessionLimit() { + return imageMagickSessionLimit > 0 ? imageMagickSessionLimit : 4; + } + public int getGhostscriptSessionLimit() { return ghostscriptSessionLimit > 0 ? ghostscriptSessionLimit : 8; } @@ -696,6 +771,10 @@ public class ApplicationProperties { public int getOcrMyPdfSessionLimit() { return ocrMyPdfSessionLimit > 0 ? ocrMyPdfSessionLimit : 2; } + + public int getFfmpegSessionLimit() { + return ffmpegSessionLimit > 0 ? ffmpegSessionLimit : 2; + } } @Data @@ -718,10 +797,13 @@ public class ApplicationProperties { @JsonProperty("calibretimeoutMinutes") private long calibreTimeoutMinutes; + private long imageMagickTimeoutMinutes; + private long tesseractTimeoutMinutes; private long qpdfTimeoutMinutes; private long ghostscriptTimeoutMinutes; private long ocrMyPdfTimeoutMinutes; + private long ffmpegTimeoutMinutes; public long getTesseractTimeoutMinutes() { return tesseractTimeoutMinutes > 0 ? tesseractTimeoutMinutes : 30; @@ -755,6 +837,10 @@ public class ApplicationProperties { return calibreTimeoutMinutes > 0 ? calibreTimeoutMinutes : 30; } + public long getImageMagickTimeoutMinutes() { + return imageMagickTimeoutMinutes > 0 ? imageMagickTimeoutMinutes : 30; + } + public long getGhostscriptTimeoutMinutes() { return ghostscriptTimeoutMinutes > 0 ? ghostscriptTimeoutMinutes : 30; } @@ -762,6 +848,10 @@ public class ApplicationProperties { public long getOcrMyPdfTimeoutMinutes() { return ocrMyPdfTimeoutMinutes > 0 ? ocrMyPdfTimeoutMinutes : 30; } + + public long getFfmpegTimeoutMinutes() { + return ffmpegTimeoutMinutes > 0 ? ffmpegTimeoutMinutes : 30; + } } } } diff --git a/app/common/src/main/java/stirling/software/common/model/FileInfo.java b/app/common/src/main/java/stirling/software/common/model/FileInfo.java index 2e3e59e83b..e894202969 100644 --- a/app/common/src/main/java/stirling/software/common/model/FileInfo.java +++ b/app/common/src/main/java/stirling/software/common/model/FileInfo.java @@ -30,11 +30,11 @@ public class FileInfo { // Formats the file size into a human-readable string. public String getFormattedFileSize() { if (fileSize >= 1024 * 1024 * 1024) { - return String.format(Locale.US, "%.2f GB", fileSize / (1024.0 * 1024 * 1024)); + return String.format(Locale.ROOT, "%.2f GB", fileSize / (1024.0 * 1024 * 1024)); } else if (fileSize >= 1024 * 1024) { - return String.format(Locale.US, "%.2f MB", fileSize / (1024.0 * 1024)); + return String.format(Locale.ROOT, "%.2f MB", fileSize / (1024.0 * 1024)); } else if (fileSize >= 1024) { - return String.format(Locale.US, "%.2f KB", fileSize / 1024.0); + return String.format(Locale.ROOT, "%.2f KB", fileSize / 1024.0); } else { return String.format("%d Bytes", fileSize); } diff --git a/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java b/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java index a7f1585397..e7473140e5 100644 --- a/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java +++ b/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java @@ -7,6 +7,7 @@ import java.io.InputStream; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.StandardCopyOption; +import java.util.Locale; import java.util.concurrent.atomic.AtomicLong; import org.apache.pdfbox.Loader; @@ -249,7 +250,7 @@ public class CustomPDFDocumentFactory { log.debug( "Memory status - Free: {}MB ({}%), Used: {}MB, Max: {}MB", actualFreeMemory / (1024 * 1024), - String.format("%.2f", freeMemoryPercent), + String.format(Locale.ROOT, "%.2f", freeMemoryPercent), usedMemory / (1024 * 1024), maxMemory / (1024 * 1024)); @@ -258,7 +259,7 @@ public class CustomPDFDocumentFactory { || actualFreeMemory < MIN_FREE_MEMORY_BYTES) { log.debug( "Low memory detected ({}%), forcing file-based cache", - String.format("%.2f", freeMemoryPercent)); + String.format(Locale.ROOT, "%.2f", freeMemoryPercent)); return createScratchFileCacheFunction(MemoryUsageSetting.setupTempFileOnly()); } else if (contentSize < SMALL_FILE_THRESHOLD) { log.debug("Using memory-only cache for small document ({}KB)", contentSize / 1024); @@ -477,11 +478,6 @@ public class CustomPDFDocumentFactory { return file; } - /** Create a uniquely named temporary directory */ - private Path createTempDirectory(String prefix) throws IOException { - return Files.createTempDirectory(prefix + tempCounter.incrementAndGet() + "-"); - } - /** Create new document bytes based on an existing document */ public byte[] createNewBytesBasedOnOldDocument(byte[] oldDocument) throws IOException { try (PDDocument document = load(oldDocument)) { diff --git a/app/common/src/main/java/stirling/software/common/service/JobExecutorService.java b/app/common/src/main/java/stirling/software/common/service/JobExecutorService.java index 5f3468a180..3dc4344232 100644 --- a/app/common/src/main/java/stirling/software/common/service/JobExecutorService.java +++ b/app/common/src/main/java/stirling/software/common/service/JobExecutorService.java @@ -253,6 +253,22 @@ public class JobExecutorService { log.error("Synchronous job timed out after {} ms", timeoutToUse); return ResponseEntity.internalServerError() .body(Map.of("error", "Job timed out after " + timeoutToUse + " ms")); + } catch (RuntimeException e) { + // Check if this is a wrapped typed exception that should be handled by + // GlobalExceptionHandler + Throwable cause = e.getCause(); + if (cause instanceof stirling.software.common.util.ExceptionUtils.BaseAppException + || cause + instanceof + stirling.software.common.util.ExceptionUtils + .BaseValidationException) { + // Rethrow so GlobalExceptionHandler can handle with proper HTTP status codes + throw e; + } + // Handle other RuntimeExceptions as generic errors + log.error("Error executing synchronous job: {}", e.getMessage(), e); + return ResponseEntity.internalServerError() + .body(Map.of("error", "Job failed: " + e.getMessage())); } catch (Exception e) { log.error("Error executing synchronous job: {}", e.getMessage(), e); // Construct a JSON error response diff --git a/app/common/src/main/java/stirling/software/common/service/LineArtConversionService.java b/app/common/src/main/java/stirling/software/common/service/LineArtConversionService.java new file mode 100644 index 0000000000..ab4f55d2e6 --- /dev/null +++ b/app/common/src/main/java/stirling/software/common/service/LineArtConversionService.java @@ -0,0 +1,12 @@ +package stirling.software.common.service; + +import java.io.IOException; + +import org.apache.pdfbox.pdmodel.PDDocument; +import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject; + +public interface LineArtConversionService { + PDImageXObject convertImageToLineArt( + PDDocument doc, PDImageXObject originalImage, double threshold, int edgeLevel) + throws IOException; +} diff --git a/app/common/src/main/java/stirling/software/common/service/PostHogService.java b/app/common/src/main/java/stirling/software/common/service/PostHogService.java index 786c04a437..1ec3e87946 100644 --- a/app/common/src/main/java/stirling/software/common/service/PostHogService.java +++ b/app/common/src/main/java/stirling/software/common/service/PostHogService.java @@ -253,7 +253,7 @@ public class PostHogService { addIfNotEmpty( properties, "security_enableLogin", - applicationProperties.getSecurity().getEnableLogin()); + applicationProperties.getSecurity().isEnableLogin()); addIfNotEmpty(properties, "security_csrfDisabled", true); addIfNotEmpty( properties, @@ -299,13 +299,13 @@ public class PostHogService { addIfNotEmpty( properties, "system_googlevisibility", - applicationProperties.getSystem().getGooglevisibility()); + applicationProperties.getSystem().isGooglevisibility()); addIfNotEmpty( properties, "system_showUpdate", applicationProperties.getSystem().isShowUpdate()); addIfNotEmpty( properties, "system_showUpdateOnlyAdmin", - applicationProperties.getSystem().getShowUpdateOnlyAdmin()); + applicationProperties.getSystem().isShowUpdateOnlyAdmin()); addIfNotEmpty( properties, "system_customHTMLFiles", @@ -317,7 +317,7 @@ public class PostHogService { addIfNotEmpty( properties, "system_enableAlphaFunctionality", - applicationProperties.getSystem().getEnableAlphaFunctionality()); + applicationProperties.getSystem().isEnableAlphaFunctionality()); addIfNotEmpty( properties, "system_enableAnalytics", @@ -337,7 +337,7 @@ public class PostHogService { // Capture Metrics properties addIfNotEmpty( - properties, "metrics_enabled", applicationProperties.getMetrics().getEnabled()); + properties, "metrics_enabled", applicationProperties.getMetrics().isEnabled()); // Capture EnterpriseEdition properties addIfNotEmpty( diff --git a/app/common/src/main/java/stirling/software/common/service/ResourceMonitor.java b/app/common/src/main/java/stirling/software/common/service/ResourceMonitor.java index 0e8073d8fb..b229239597 100644 --- a/app/common/src/main/java/stirling/software/common/service/ResourceMonitor.java +++ b/app/common/src/main/java/stirling/software/common/service/ResourceMonitor.java @@ -5,6 +5,7 @@ import java.lang.management.MemoryMXBean; import java.lang.management.OperatingSystemMXBean; import java.time.Duration; import java.time.Instant; +import java.util.Locale; import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; @@ -173,8 +174,8 @@ public class ResourceMonitor { log.info("System resource status changed from {} to {}", oldStatus, newStatus); log.info( "Current metrics - CPU: {}%, Memory: {}%, Free Memory: {} MB", - String.format("%.1f", cpuUsage * 100), - String.format("%.1f", memoryUsage * 100), + String.format(Locale.ROOT, "%.1f", cpuUsage * 100), + String.format(Locale.ROOT, "%.1f", memoryUsage * 100), freeMemory / (1024 * 1024)); } } catch (Exception e) { diff --git a/app/common/src/main/java/stirling/software/common/service/SsrfProtectionService.java b/app/common/src/main/java/stirling/software/common/service/SsrfProtectionService.java index 1f81fb4d42..ce19ff8260 100644 --- a/app/common/src/main/java/stirling/software/common/service/SsrfProtectionService.java +++ b/app/common/src/main/java/stirling/software/common/service/SsrfProtectionService.java @@ -5,6 +5,7 @@ import java.net.Inet6Address; import java.net.InetAddress; import java.net.URI; import java.net.UnknownHostException; +import java.util.Locale; import java.util.regex.Pattern; import org.springframework.stereotype.Service; @@ -83,7 +84,7 @@ public class SsrfProtectionService { return false; } - return config.getAllowedDomains().contains(host.toLowerCase()); + return config.getAllowedDomains().contains(host.toLowerCase(Locale.ROOT)); } catch (Exception e) { log.debug("Failed to parse URL for MAX security check: {}", url, e); @@ -101,7 +102,7 @@ public class SsrfProtectionService { return false; } - String hostLower = host.toLowerCase(); + String hostLower = host.toLowerCase(Locale.ROOT); // Check explicit blocked domains if (config.getBlockedDomains().contains(hostLower)) { @@ -111,7 +112,7 @@ public class SsrfProtectionService { // Check internal TLD patterns for (String tld : config.getInternalTlds()) { - if (hostLower.endsWith(tld.toLowerCase())) { + if (hostLower.endsWith(tld.toLowerCase(Locale.ROOT))) { log.debug("URL blocked by internal TLD pattern '{}': {}", tld, url); return false; } @@ -123,9 +124,11 @@ public class SsrfProtectionService { config.getAllowedDomains().stream() .anyMatch( domain -> - hostLower.equals(domain.toLowerCase()) + hostLower.equals(domain.toLowerCase(Locale.ROOT)) || hostLower.endsWith( - "." + domain.toLowerCase())); + "." + + domain.toLowerCase( + Locale.ROOT))); if (!isAllowed) { log.debug("URL not in allowed domains list: {}", url); diff --git a/app/common/src/main/java/stirling/software/common/service/TaskManager.java b/app/common/src/main/java/stirling/software/common/service/TaskManager.java index 902b2bfd10..5d2a9edca8 100644 --- a/app/common/src/main/java/stirling/software/common/service/TaskManager.java +++ b/app/common/src/main/java/stirling/software/common/service/TaskManager.java @@ -7,6 +7,7 @@ import java.time.LocalDateTime; import java.time.temporal.ChronoUnit; import java.util.ArrayList; import java.util.List; +import java.util.Locale; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.Executors; @@ -101,14 +102,16 @@ public class TaskManager { if (!extractedFiles.isEmpty()) { jobResult.completeWithFiles(extractedFiles); log.debug( - "Set multiple file results for job ID: {} with {} files extracted from ZIP", + "Set multiple file results for job ID: {} with {} files extracted from" + + " ZIP", jobId, extractedFiles.size()); return; } } catch (Exception e) { log.warn( - "Failed to extract ZIP file for job {}: {}. Falling back to single file result.", + "Failed to extract ZIP file for job {}: {}. Falling back to single file" + + " result.", jobId, e.getMessage()); } @@ -342,12 +345,12 @@ public class TaskManager { /** Check if a file is a ZIP file based on content type and filename */ private boolean isZipFile(String contentType, String fileName) { if (contentType != null - && (contentType.equals("application/zip") - || contentType.equals("application/x-zip-compressed"))) { + && ("application/zip".equals(contentType) + || "application/x-zip-compressed".equals(contentType))) { return true; } - if (fileName != null && fileName.toLowerCase().endsWith(".zip")) { + if (fileName != null && fileName.toLowerCase(Locale.ROOT).endsWith(".zip")) { return true; } @@ -414,7 +417,7 @@ public class TaskManager { return MediaType.APPLICATION_OCTET_STREAM_VALUE; } - String lowerName = fileName.toLowerCase(); + String lowerName = fileName.toLowerCase(Locale.ROOT); if (lowerName.endsWith(".pdf")) { return MediaType.APPLICATION_PDF_VALUE; } else if (lowerName.endsWith(".txt")) { diff --git a/app/common/src/main/java/stirling/software/common/util/CbrUtils.java b/app/common/src/main/java/stirling/software/common/util/CbrUtils.java index 429d22407d..c6f9ea78fe 100644 --- a/app/common/src/main/java/stirling/software/common/util/CbrUtils.java +++ b/app/common/src/main/java/stirling/software/common/util/CbrUtils.java @@ -6,6 +6,7 @@ import java.io.InputStream; import java.util.ArrayList; import java.util.Comparator; import java.util.List; +import java.util.Locale; import org.apache.commons.io.FilenameUtils; import org.apache.pdfbox.pdmodel.PDDocument; @@ -58,31 +59,24 @@ public class CbrUtils { log.warn( "Failed to open CBR/RAR archive due to corrupt header: {}", e.getMessage()); - throw ExceptionUtils.createIllegalArgumentException( - "error.invalidFormat", - "Invalid or corrupted CBR/RAR archive. " - + "The file may be corrupted, use an unsupported RAR format (RAR5+), " - + "or may not be a valid RAR archive. " - + "Please ensure the file is a valid RAR archive."); + throw ExceptionUtils.createCbrInvalidFormatException(null); } catch (RarException e) { log.warn("Failed to open CBR/RAR archive: {}", e.getMessage()); - String errorMessage; String exMessage = e.getMessage() != null ? e.getMessage() : ""; if (exMessage.contains("encrypted")) { - errorMessage = "Encrypted CBR/RAR archives are not supported."; + throw ExceptionUtils.createCbrEncryptedException(); } else if (exMessage.isEmpty()) { - errorMessage = - "Invalid CBR/RAR archive. " - + "The file may be encrypted, corrupted, or use an unsupported format."; + throw ExceptionUtils.createCbrInvalidFormatException( + "Invalid CBR/RAR archive. The file may be encrypted, corrupted, or" + + " use an unsupported format."); } else { - errorMessage = + throw ExceptionUtils.createCbrInvalidFormatException( "Invalid CBR/RAR archive: " + exMessage - + ". The file may be encrypted, corrupted, or use an unsupported format."; + + ". The file may be encrypted, corrupted, or use an" + + " unsupported format."); } - throw ExceptionUtils.createIllegalArgumentException( - "error.invalidFormat", errorMessage); } catch (IOException e) { log.warn("IO error reading CBR/RAR archive: {}", e.getMessage()); throw ExceptionUtils.createFileProcessingException("CBR extraction", e); @@ -121,7 +115,8 @@ public class CbrUtils { if (imageEntries.isEmpty()) { throw ExceptionUtils.createIllegalArgumentException( "error.fileProcessing", - "No valid images found in the CBR file. The archive may be empty or contain no supported image formats."); + "No valid images found in the CBR file. The archive may be empty or" + + " contain no supported image formats."); } for (ImageEntryData imageEntry : imageEntries) { @@ -146,7 +141,8 @@ public class CbrUtils { if (document.getNumberOfPages() == 0) { throw ExceptionUtils.createIllegalArgumentException( "error.fileProcessing", - "No images could be processed from the CBR file. All images may be corrupted or in unsupported formats."); + "No images could be processed from the CBR file. All images may be" + + " corrupted or in unsupported formats."); } ByteArrayOutputStream baos = new ByteArrayOutputStream(); @@ -159,7 +155,6 @@ public class CbrUtils { return GeneralUtils.optimizePdfWithGhostscript(pdfBytes); } catch (IOException e) { log.warn("Ghostscript optimization failed, returning unoptimized PDF", e); - return pdfBytes; } } @@ -170,17 +165,17 @@ public class CbrUtils { private void validateCbrFile(MultipartFile file) { if (file == null || file.isEmpty()) { - throw new IllegalArgumentException("File cannot be null or empty"); + throw ExceptionUtils.createFileNullOrEmptyException(); } String filename = file.getOriginalFilename(); if (filename == null) { - throw new IllegalArgumentException("File must have a name"); + throw ExceptionUtils.createFileNoNameException(); } - String extension = FilenameUtils.getExtension(filename).toLowerCase(); + String extension = FilenameUtils.getExtension(filename).toLowerCase(Locale.ROOT); if (!"cbr".equals(extension) && !"rar".equals(extension)) { - throw new IllegalArgumentException("File must be a CBR or RAR archive"); + throw ExceptionUtils.createNotCbrFileException(); } } @@ -190,7 +185,7 @@ public class CbrUtils { return false; } - String extension = FilenameUtils.getExtension(filename).toLowerCase(); + String extension = FilenameUtils.getExtension(filename).toLowerCase(Locale.ROOT); return "cbr".equals(extension) || "rar".equals(extension); } diff --git a/app/common/src/main/java/stirling/software/common/util/CbzUtils.java b/app/common/src/main/java/stirling/software/common/util/CbzUtils.java index 5eb620e8e8..d9fb40189b 100644 --- a/app/common/src/main/java/stirling/software/common/util/CbzUtils.java +++ b/app/common/src/main/java/stirling/software/common/util/CbzUtils.java @@ -8,6 +8,7 @@ import java.util.ArrayList; import java.util.Comparator; import java.util.Enumeration; import java.util.List; +import java.util.Locale; import java.util.zip.ZipEntry; import java.util.zip.ZipFile; import java.util.zip.ZipInputStream; @@ -55,10 +56,10 @@ public class CbzUtils { new java.io.FileInputStream(tempFile.getFile())); ZipInputStream zis = new ZipInputStream(bis)) { if (zis.getNextEntry() == null) { - throw new IllegalArgumentException("Archive is empty or invalid ZIP"); + throw ExceptionUtils.createCbzEmptyException(); } } catch (IOException e) { - throw new IllegalArgumentException("Invalid CBZ/ZIP archive", e); + throw ExceptionUtils.createCbzInvalidFormatException(e); } try (PDDocument document = pdfDocumentFactory.createNewDocument(); @@ -83,7 +84,7 @@ public class CbzUtils { Comparator.comparing(ImageEntryData::name, new NaturalOrderComparator())); if (imageEntries.isEmpty()) { - throw new IllegalArgumentException("No valid images found in the CBZ file"); + throw ExceptionUtils.createCbzNoImagesException(); } for (ImageEntryData imageEntry : imageEntries) { @@ -106,8 +107,7 @@ public class CbzUtils { } if (document.getNumberOfPages() == 0) { - throw new IllegalArgumentException( - "No images could be processed from the CBZ file"); + throw ExceptionUtils.createCbzCorruptedImagesException(); } ByteArrayOutputStream baos = new ByteArrayOutputStream(); document.save(baos); @@ -119,7 +119,6 @@ public class CbzUtils { return GeneralUtils.optimizePdfWithGhostscript(pdfBytes); } catch (IOException e) { log.warn("Ghostscript optimization failed, returning unoptimized PDF", e); - return pdfBytes; } } @@ -130,17 +129,17 @@ public class CbzUtils { private void validateCbzFile(MultipartFile file) { if (file == null || file.isEmpty()) { - throw new IllegalArgumentException("File cannot be null or empty"); + throw ExceptionUtils.createFileNullOrEmptyException(); } String filename = file.getOriginalFilename(); if (filename == null) { - throw new IllegalArgumentException("File must have a name"); + throw ExceptionUtils.createFileNoNameException(); } - String extension = FilenameUtils.getExtension(filename).toLowerCase(); + String extension = FilenameUtils.getExtension(filename).toLowerCase(Locale.ROOT); if (!"cbz".equals(extension) && !"zip".equals(extension)) { - throw new IllegalArgumentException("File must be a CBZ or ZIP archive"); + throw ExceptionUtils.createNotCbzFileException(); } } @@ -150,7 +149,7 @@ public class CbzUtils { return false; } - String extension = FilenameUtils.getExtension(filename).toLowerCase(); + String extension = FilenameUtils.getExtension(filename).toLowerCase(Locale.ROOT); return "cbz".equals(extension) || "zip".equals(extension); } @@ -160,7 +159,7 @@ public class CbzUtils { return false; } - String extension = FilenameUtils.getExtension(filename).toLowerCase(); + String extension = FilenameUtils.getExtension(filename).toLowerCase(Locale.ROOT); return "cbz".equals(extension) || "zip".equals(extension) || "cbr".equals(extension) diff --git a/app/common/src/main/java/stirling/software/common/util/CheckProgramInstall.java b/app/common/src/main/java/stirling/software/common/util/CheckProgramInstall.java index f39daf8ae7..0927f8c595 100644 --- a/app/common/src/main/java/stirling/software/common/util/CheckProgramInstall.java +++ b/app/common/src/main/java/stirling/software/common/util/CheckProgramInstall.java @@ -11,6 +11,8 @@ public class CheckProgramInstall { private static final List PYTHON_COMMANDS = Arrays.asList("python3", "python"); private static boolean pythonAvailableChecked = false; private static String availablePythonCommand = null; + private static boolean ffmpegAvailableChecked = false; + private static boolean ffmpegAvailable = false; /** * Checks which Python command is available and returns it. @@ -56,4 +58,25 @@ public class CheckProgramInstall { public static boolean isPythonAvailable() { return getAvailablePythonCommand() != null; } + + /** + * Checks if FFmpeg is available on the system. + * + * @return true if FFmpeg is installed and accessible, false otherwise. + */ + public static boolean isFfmpegAvailable() { + if (!ffmpegAvailableChecked) { + try { + ProcessExecutorResult result = + ProcessExecutor.getInstance(ProcessExecutor.Processes.FFMPEG) + .runCommandWithOutputHandling(Arrays.asList("ffmpeg", "-version")); + ffmpegAvailable = true; + } catch (IOException | InterruptedException e) { + ffmpegAvailable = false; + } finally { + ffmpegAvailableChecked = true; + } + } + return ffmpegAvailable; + } } diff --git a/app/common/src/main/java/stirling/software/common/util/ChecksumUtils.java b/app/common/src/main/java/stirling/software/common/util/ChecksumUtils.java index d9749deea9..ab39ca5da8 100644 --- a/app/common/src/main/java/stirling/software/common/util/ChecksumUtils.java +++ b/app/common/src/main/java/stirling/software/common/util/ChecksumUtils.java @@ -58,14 +58,11 @@ public class ChecksumUtils { * @throws IOException if reading from the stream fails */ public static String checksum(InputStream is, String algorithm) throws IOException { - switch (algorithm.toUpperCase(Locale.ROOT)) { - case "CRC32": - return checksumChecksum(is, new CRC32()); - case "ADLER32": - return checksumChecksum(is, new Adler32()); - default: - return toHex(checksumBytes(is, algorithm)); - } + return switch (algorithm.toUpperCase(Locale.ROOT)) { + case "CRC32" -> checksumChecksum(is, new CRC32()); + case "ADLER32" -> checksumChecksum(is, new Adler32()); + default -> toHex(checksumBytes(is, algorithm)); + }; } /** @@ -98,14 +95,13 @@ public class ChecksumUtils { * @throws IOException if reading from the stream fails */ public static String checksumBase64(InputStream is, String algorithm) throws IOException { - switch (algorithm.toUpperCase(Locale.ROOT)) { - case "CRC32": - return Base64.getEncoder().encodeToString(checksumChecksumBytes(is, new CRC32())); - case "ADLER32": - return Base64.getEncoder().encodeToString(checksumChecksumBytes(is, new Adler32())); - default: - return Base64.getEncoder().encodeToString(checksumBytes(is, algorithm)); - } + return switch (algorithm.toUpperCase(Locale.ROOT)) { + case "CRC32" -> + Base64.getEncoder().encodeToString(checksumChecksumBytes(is, new CRC32())); + case "ADLER32" -> + Base64.getEncoder().encodeToString(checksumChecksumBytes(is, new Adler32())); + default -> Base64.getEncoder().encodeToString(checksumBytes(is, algorithm)); + }; } /** @@ -179,7 +175,7 @@ public class ChecksumUtils { for (Map.Entry entry : checksums.entrySet()) { // Keep value as long and mask to ensure unsigned hex formatting. long unsigned32 = entry.getValue().getValue() & UNSIGNED_32_BIT_MASK; - results.put(entry.getKey(), String.format("%08x", unsigned32)); + results.put(entry.getKey(), String.format(Locale.ROOT, "%08x", unsigned32)); } return results; } @@ -258,7 +254,7 @@ public class ChecksumUtils { } // Keep as long and mask to ensure correct unsigned representation. long unsigned32 = checksum.getValue() & UNSIGNED_32_BIT_MASK; - return String.format("%08x", unsigned32); + return String.format(Locale.ROOT, "%08x", unsigned32); } /** @@ -294,7 +290,7 @@ public class ChecksumUtils { private static String toHex(byte[] hash) { StringBuilder sb = new StringBuilder(hash.length * 2); for (byte b : hash) { - sb.append(String.format("%02x", b)); + sb.append(String.format(Locale.ROOT, "%02x", b)); } return sb.toString(); } diff --git a/app/common/src/main/java/stirling/software/common/util/CustomHtmlSanitizer.java b/app/common/src/main/java/stirling/software/common/util/CustomHtmlSanitizer.java index c5fb076451..05bb6e546a 100644 --- a/app/common/src/main/java/stirling/software/common/util/CustomHtmlSanitizer.java +++ b/app/common/src/main/java/stirling/software/common/util/CustomHtmlSanitizer.java @@ -62,8 +62,7 @@ public class CustomHtmlSanitizer { .and(new HtmlPolicyBuilder().disallowElements("noscript").toFactory()); public String sanitize(String html) { - boolean disableSanitize = - Boolean.TRUE.equals(applicationProperties.getSystem().getDisableSanitize()); + boolean disableSanitize = applicationProperties.getSystem().isDisableSanitize(); return disableSanitize ? html : POLICY.sanitize(html); } } diff --git a/app/common/src/main/java/stirling/software/common/util/EmlParser.java b/app/common/src/main/java/stirling/software/common/util/EmlParser.java index ec71fbb19c..642bc3a5e1 100644 --- a/app/common/src/main/java/stirling/software/common/util/EmlParser.java +++ b/app/common/src/main/java/stirling/software/common/util/EmlParser.java @@ -11,6 +11,7 @@ import java.time.ZonedDateTime; import java.util.ArrayList; import java.util.Date; import java.util.List; +import java.util.Locale; import java.util.Properties; import java.util.regex.Pattern; @@ -229,7 +230,8 @@ public class EmlParser { Method getContentType = message.getClass().getMethod("getContentType"); String contentType = (String) getContentType.invoke(message); - if (contentType != null && contentType.toLowerCase().contains(TEXT_HTML)) { + if (contentType != null + && contentType.toLowerCase(Locale.ROOT).contains(TEXT_HTML)) { content.setHtmlBody(stringContent); } else { content.setTextBody(stringContent); @@ -296,7 +298,7 @@ public class EmlParser { String contentType = (String) getContentType.invoke(part); String normalizedDisposition = - disposition != null ? ((String) disposition).toLowerCase() : null; + disposition != null ? ((String) disposition).toLowerCase(Locale.ROOT) : null; if ((Boolean) isMimeType.invoke(part, TEXT_PLAIN) && normalizedDisposition == null) { Object partContent = getContent.invoke(part); @@ -422,7 +424,7 @@ public class EmlParser { RegexPatternUtils.getInstance().getNewlineSplitPattern().split(emlContent); for (int i = 0; i < lines.length; i++) { String line = lines[i]; - if (line.toLowerCase().startsWith(headerName.toLowerCase())) { + if (line.toLowerCase(Locale.ROOT).startsWith(headerName.toLowerCase(Locale.ROOT))) { StringBuilder value = new StringBuilder(line.substring(headerName.length()).trim()); for (int j = i + 1; j < lines.length; j++) { @@ -444,7 +446,7 @@ public class EmlParser { private static String extractHtmlBody(String emlContent) { try { - String lowerContent = emlContent.toLowerCase(); + String lowerContent = emlContent.toLowerCase(Locale.ROOT); int htmlStart = lowerContent.indexOf(HEADER_CONTENT_TYPE + " " + TEXT_HTML); if (htmlStart == -1) return null; @@ -463,7 +465,7 @@ public class EmlParser { private static String extractTextBody(String emlContent) { try { - String lowerContent = emlContent.toLowerCase(); + String lowerContent = emlContent.toLowerCase(Locale.ROOT); int textStart = lowerContent.indexOf(HEADER_CONTENT_TYPE + " " + TEXT_PLAIN); if (textStart == -1) { int bodyStart = emlContent.indexOf("\r\n\r\n"); @@ -516,7 +518,7 @@ public class EmlParser { String currentEncoding = ""; for (String line : lines) { - String lowerLine = line.toLowerCase().trim(); + String lowerLine = line.toLowerCase(Locale.ROOT).trim(); if (line.trim().isEmpty()) { inHeaders = false; @@ -554,9 +556,12 @@ public class EmlParser { } private static boolean isAttachment(String disposition, String filename, String contentType) { - return (disposition.toLowerCase().contains(DISPOSITION_ATTACHMENT) && !filename.isEmpty()) - || (!filename.isEmpty() && !contentType.toLowerCase().startsWith("text/")) - || (contentType.toLowerCase().contains("application/") && !filename.isEmpty()); + return (disposition.toLowerCase(Locale.ROOT).contains(DISPOSITION_ATTACHMENT) + && !filename.isEmpty()) + || (!filename.isEmpty() + && !contentType.toLowerCase(Locale.ROOT).startsWith("text/")) + || (contentType.toLowerCase(Locale.ROOT).contains("application/") + && !filename.isEmpty()); } private static String extractFilenameFromDisposition(String disposition) { @@ -565,8 +570,8 @@ public class EmlParser { } // Handle filename*= (RFC 2231 encoded filename) - if (disposition.toLowerCase().contains("filename*=")) { - int filenameStarStart = disposition.toLowerCase().indexOf("filename*=") + 10; + if (disposition.toLowerCase(Locale.ROOT).contains("filename*=")) { + int filenameStarStart = disposition.toLowerCase(Locale.ROOT).indexOf("filename*=") + 10; int filenameStarEnd = disposition.indexOf(";", filenameStarStart); if (filenameStarEnd == -1) filenameStarEnd = disposition.length(); String extendedFilename = @@ -586,7 +591,7 @@ public class EmlParser { } // Handle regular filename= - int filenameStart = disposition.toLowerCase().indexOf("filename=") + 9; + int filenameStart = disposition.toLowerCase(Locale.ROOT).indexOf("filename=") + 9; int filenameEnd = disposition.indexOf(";", filenameStart); if (filenameEnd == -1) filenameEnd = disposition.length(); String filename = disposition.substring(filenameStart, filenameEnd).trim(); diff --git a/app/common/src/main/java/stirling/software/common/util/EmlProcessingUtils.java b/app/common/src/main/java/stirling/software/common/util/EmlProcessingUtils.java index 55035fe9f8..69b1811615 100644 --- a/app/common/src/main/java/stirling/software/common/util/EmlProcessingUtils.java +++ b/app/common/src/main/java/stirling/software/common/util/EmlProcessingUtils.java @@ -48,11 +48,11 @@ public class EmlProcessingUtils { public static void validateEmlInput(byte[] emlBytes) { if (emlBytes == null || emlBytes.length == 0) { - throw new IllegalArgumentException("EML file is empty or null"); + throw ExceptionUtils.createEmlEmptyException(); } if (isInvalidEmlFormat(emlBytes)) { - throw new IllegalArgumentException("Invalid EML file format"); + throw ExceptionUtils.createEmlInvalidFormatException(); } } @@ -109,12 +109,13 @@ public class EmlProcessingUtils { html.append( String.format( + Locale.ROOT, """ - - - %s - + + + +
+
+ + +
+

+ This Stirling-PDF instance is running in API-only mode. The web interface has not been included in this build. +

+
+ + Open API Documentation + +
+ +
+

Looking for the Web UI?

+ +

If you're using Docker:

+
    +
  • You may have pulled an API-only image or there was a build configuration issue
    • +
  • Use the standard Docker image: stirlingtools/stirling-pdf:latest
    • +
+ +

If you're using a JAR file:

+
    +
  • You downloaded Stirling-PDF-server.jar which is the API-only version without UI
    • +
  • Download the full version from GitHub Releases:
    • +
  • Stirling-PDF.jar - Standard version with UI
    • +
  • Stirling-PDF-with-login.jar - Version with authentication features
    • +
+ +

If you built from source:

+
    +
  • Rebuild with: ./gradlew build -PbuildWithFrontend=true
    • +
  • Or deploy the frontend separately from the /frontend directory
    • +
+
+ +
+ +
+

Need Help?

+

Join our community for support:

+ +
+
+
+ +
+ Powered by + Stirling PDF +
+ + diff --git a/app/core/src/main/resources/static/api-wordmark.svg b/app/core/src/main/resources/static/api-wordmark.svg new file mode 100644 index 0000000000..deac1ee165 --- /dev/null +++ b/app/core/src/main/resources/static/api-wordmark.svg @@ -0,0 +1,4 @@ + + + + diff --git a/app/core/src/main/resources/static/css/imageHighlighter.css b/app/core/src/main/resources/static/css/imageHighlighter.css index 397c0c548d..ed4faa941f 100644 --- a/app/core/src/main/resources/static/css/imageHighlighter.css +++ b/app/core/src/main/resources/static/css/imageHighlighter.css @@ -8,7 +8,7 @@ align-items: center; justify-content: center; transition: - visbility 0.1s linear, + visibility 0.1s linear, background-color 0.1s linear; } diff --git a/app/core/src/main/resources/static/css/split-pdf-by-sections.css b/app/core/src/main/resources/static/css/split-pdf-by-sections.css index 7520c10e56..b949000af8 100644 --- a/app/core/src/main/resources/static/css/split-pdf-by-sections.css +++ b/app/core/src/main/resources/static/css/split-pdf-by-sections.css @@ -8,3 +8,6 @@ position: absolute; background-color: red; /* Line color */ } +#pageToSplitSection { + display: none; +} diff --git a/app/core/src/main/resources/static/js/DecryptFiles.js b/app/core/src/main/resources/static/js/DecryptFiles.js index e569d8839a..b19fb6e12e 100644 --- a/app/core/src/main/resources/static/js/DecryptFiles.js +++ b/app/core/src/main/resources/static/js/DecryptFiles.js @@ -1,3 +1,147 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + +function formatProblemDetailsJson(input) { + try { + const obj = typeof input === 'string' ? JSON.parse(input) : input; + const preferredOrder = [ + 'errorCode', + 'title', + 'status', + 'type', + 'detail', + 'instance', + 'path', + 'timestamp', + 'hints', + 'actionRequired' + ]; + + const ordered = {}; + preferredOrder.forEach((key) => { + if (Object.prototype.hasOwnProperty.call(obj, key)) { + ordered[key] = obj[key]; + } + }); + + Object.keys(obj).forEach((key) => { + if (!Object.prototype.hasOwnProperty.call(ordered, key)) { + ordered[key] = obj[key]; + } + }); + + return JSON.stringify(ordered, null, 2); + } catch (err) { + if (typeof input === 'string') return input; + try { + return JSON.stringify(input, null, 2); + } catch (jsonErr) { + return String(input); + } + } +} + +function formatUserFriendlyError(json) { + if (!json || typeof json !== 'object') { + return typeof json === 'string' ? json : ''; + } + + const lines = []; + const title = json.title || json.error || ''; + const detail = json.detail || json.message || ''; + + const primaryLine = title && detail ? `${title}: ${detail}` : title || detail; + + if (primaryLine) { + lines.push(primaryLine); + } + + if (json.errorCode) { + lines.push(''); + lines.push(`Error Code: ${json.errorCode}`); + } + + const detailAlreadyIncluded = detail && primaryLine && primaryLine.includes(detail); + if (detail && !detailAlreadyIncluded) { + lines.push(''); + lines.push(detail); + } + + if (json.hints && Array.isArray(json.hints) && json.hints.length > 0) { + lines.push(''); + lines.push('How to fix:'); + json.hints.forEach((hint, index) => { + lines.push(` ${index + 1}. ${hint}`); + }); + } + + if (json.actionRequired) { + lines.push(''); + lines.push(json.actionRequired); + } + + if (json.supportId) { + lines.push(''); + lines.push(`Support ID: ${json.supportId}`); + } + + return lines + .filter((line, index, arr) => { + if (line !== '') return true; + if (index === 0 || index === arr.length - 1) return false; + return arr[index - 1] !== ''; + }) + .join('\n'); +} + +function buildPdfPasswordProblemDetail(fileName) { + const stirling = window.stirlingPDF || {}; + const detailTemplate = stirling.pdfPasswordDetail || 'The PDF Document is passworded and either the password was not provided or was incorrect'; + const title = stirling.pdfPasswordTitle || 'PDF Password Required'; + const hints = [ + stirling.pdfPasswordHint1, + stirling.pdfPasswordHint2, + stirling.pdfPasswordHint3, + stirling.pdfPasswordHint4, + stirling.pdfPasswordHint5, + stirling.pdfPasswordHint6 + ].filter((hint) => typeof hint === 'string' && hint.trim().length > 0); + const actionRequired = stirling.pdfPasswordAction || 'Provide the owner/permissions password, not just the document open password.'; + + return { + errorCode: 'E004', + title, + detail: detailTemplate.replace('{0}', fileName), + type: '/errors/pdf-password', + path: '/api/v1/security/remove-password', + hints, + actionRequired + }; +} + +function buildCorruptedPdfProblemDetail(fileName) { + const stirling = window.stirlingPDF || {}; + const detailTemplate = stirling.pdfCorruptedMessage || 'The PDF file "{0}" appears to be corrupted or has an invalid structure.'; + const hints = [ + stirling.pdfCorruptedHint1, + stirling.pdfCorruptedHint2, + stirling.pdfCorruptedHint3 + ].filter((hint) => typeof hint === 'string' && hint.trim().length > 0); + const actionRequired = stirling.pdfCorruptedAction || stirling.tryRepairMessage || ''; + + return { + errorCode: 'E001', + title: stirling.pdfCorruptedTitle || 'PDF File Corrupted', + detail: detailTemplate.replace('{0}', fileName), + type: '/errors/pdf-corrupted', + hints, + actionRequired + }; +} + export class DecryptFile { constructor(){ @@ -35,11 +179,8 @@ export class DecryptFile { if (!password) { // No password provided console.error(`No password provided for encrypted PDF: ${file.name}`); - this.showErrorBanner( - `${window.decrypt.noPassword.replace('{0}', file.name)}`, - '', - `${window.decrypt.unexpectedError}` - ); + const problemDetail = buildPdfPasswordProblemDetail(file.name); + this.showProblemDetail(problemDetail); return null; // No file to return } @@ -51,30 +192,48 @@ export class DecryptFile { body: formData, }); - if (response.ok) { - this.removeErrorBanner(); - const decryptedBlob = await response.blob(); - return new File([decryptedBlob], file.name, { - type: "application/pdf", - }); - } else { - const errorText = await response.text(); - console.error(`${window.decrypt.invalidPassword} ${errorText}`); - this.showErrorBanner( - `${window.decrypt.invalidPassword}`, - errorText, - `${window.decrypt.invalidPasswordHeader.replace('{0}', file.name)}` - ); + if (!response.ok) { + const contentType = response.headers.get('content-type') || ''; + if (contentType.includes('application/json') || contentType.includes('application/problem+json')) { + const errorJson = await response.json(); + this.showProblemDetail(errorJson); + } else { + const errorText = await response.text(); + console.error(`${window.decrypt.invalidPassword} ${errorText}`); + const fallbackProblem = buildPdfPasswordProblemDetail(file.name); + if (errorText && errorText.trim().length > 0) { + fallbackProblem.detail = errorText.trim(); + } + this.showProblemDetail(fallbackProblem); + } return null; // No file to return } + + this.removeErrorBanner(); + const decryptedBlob = await response.blob(); + return new File([decryptedBlob], file.name, { + type: 'application/pdf', + }); } catch (error) { // Handle network or unexpected errors console.error(`Failed to decrypt PDF: ${file.name}`, error); - this.showErrorBanner( - `${window.decrypt.unexpectedError.replace('{0}', file.name)}`, - `${error.message || window.decrypt.unexpectedError}`, - error - ); + const fallbackDetail = + (error && error.message) || + window.decrypt.unexpectedError || + 'There was an error processing the file. Please try again.'; + + const unexpectedProblem = { + title: (window.stirlingPDF && window.stirlingPDF.errorUnexpectedTitle) || 'Unexpected Error', + detail: fallbackDetail, + }; + + if (window.decrypt.serverError) { + unexpectedProblem.hints = [ + window.decrypt.serverError.replace('{0}', file.name), + ]; + } + + this.showProblemDetail(unexpectedProblem); return null; // No file to return } } @@ -85,7 +244,7 @@ export class DecryptFile { return {isEncrypted: false, requiresPassword: false}; } - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; const arrayBuffer = await file.arrayBuffer(); const arrayBufferForPdfLib = arrayBuffer.slice(0); @@ -93,12 +252,14 @@ export class DecryptFile { if(this.decryptWorker == null){ loadingTask = pdfjsLib.getDocument({ + ...PDFJS_DEFAULT_OPTIONS, data: arrayBuffer, }); this.decryptWorker = loadingTask._worker }else { loadingTask = pdfjsLib.getDocument({ + ...PDFJS_DEFAULT_OPTIONS, data: arrayBuffer, worker: this.decryptWorker }); @@ -129,11 +290,8 @@ export class DecryptFile { // Handle corrupted PDF files console.error('Corrupted PDF detected:', error); if (window.stirlingPDF.currentPage !== 'repair') { - this.showErrorBanner( - `${window.stirlingPDF.pdfCorruptedMessage.replace('{0}', file.name)}`, - error.stack || '', - `${window.stirlingPDF.tryRepairMessage}` - ); + const corruptedProblem = buildCorruptedPdfProblemDetail(file.name); + this.showProblemDetail(corruptedProblem); } else { console.log('Suppressing corrupted PDF warning banner on repair page'); } @@ -145,19 +303,62 @@ export class DecryptFile { } } - showErrorBanner(message, stackTrace, error) { + showProblemDetail(problemDetail) { const errorContainer = document.getElementById('errorContainer'); - errorContainer.style.display = 'block'; // Display the banner - errorContainer.querySelector('.alert-heading').textContent = error; - errorContainer.querySelector('p').textContent = message; - document.querySelector('#traceContent').textContent = stackTrace; + if (!errorContainer) { + console.error('Error container not found'); + return; + } + + errorContainer.style.display = 'block'; + + const heading = errorContainer.querySelector('.alert-heading'); + const messageEl = errorContainer.querySelector('p'); + const traceEl = document.querySelector('#traceContent'); + + const fallbackHeading = (window.stirlingPDF && window.stirlingPDF.error) || 'Error'; + + if (heading) { + heading.textContent = + (problemDetail && typeof problemDetail === 'object' && problemDetail.title) || + fallbackHeading; + } + + if (messageEl) { + messageEl.style.whiteSpace = 'pre-wrap'; + messageEl.textContent = + typeof problemDetail === 'object' + ? formatUserFriendlyError(problemDetail) + : String(problemDetail || ''); + } + + if (traceEl) { + traceEl.textContent = + typeof problemDetail === 'object' ? formatProblemDetailsJson(problemDetail) : ''; + } } removeErrorBanner() { const errorContainer = document.getElementById('errorContainer'); - errorContainer.style.display = 'none'; // Hide the banner - errorContainer.querySelector('.alert-heading').textContent = ''; - errorContainer.querySelector('p').textContent = ''; - document.querySelector('#traceContent').textContent = ''; + if (!errorContainer) { + return; + } + + errorContainer.style.display = 'none'; + + const heading = errorContainer.querySelector('.alert-heading'); + if (heading) { + heading.textContent = (window.stirlingPDF && window.stirlingPDF.error) || 'Error'; + } + + const messageEl = errorContainer.querySelector('p'); + if (messageEl) { + messageEl.textContent = ''; + } + + const traceEl = document.querySelector('#traceContent'); + if (traceEl) { + traceEl.textContent = ''; + } } } diff --git a/app/core/src/main/resources/static/js/compare/pdfWorker.js b/app/core/src/main/resources/static/js/compare/pdfWorker.js index 78952bd759..86fb66383d 100644 --- a/app/core/src/main/resources/static/js/compare/pdfWorker.js +++ b/app/core/src/main/resources/static/js/compare/pdfWorker.js @@ -1,18 +1,39 @@ importScripts('./diff.js'); +let complexMessage = 'One or both of the provided documents are large files, accuracy of comparison may be reduced'; +let largeFilesMessage = 'One or Both of the provided documents are too large to process'; + +// Early: Listener for SET messages (before onmessage) +self.addEventListener('message', (event) => { + if (event.data.type === 'SET_COMPLEX_MESSAGE') { + complexMessage = event.data.message; + } else if (event.data.type === 'SET_TOO_LARGE_MESSAGE') { + largeFilesMessage = event.data.message; + } +}); + self.onmessage = async function (e) { - const { text1, text2, color1, color2 } = e.data; - console.log('Received text for comparison:', { text1, text2 }); + const data = e.data; + if (data.type !== 'COMPARE') { + console.log('Worker ignored non-COMPARE message'); + return; + } + + const { text1, text2, color1, color2 } = data; + console.log('Received text for comparison:', { lengths: { text1: text1.length, text2: text2.length } }); // Safe Log const startTime = performance.now(); - if (text1.trim() === "" || text2.trim() === "") { + // Safe Trim + if (!text1 || !text2 || text1.trim() === "" || text2.trim() === "") { self.postMessage({ status: 'error', message: 'One or both of the texts are empty.' }); return; } - const words1 = text1.split(' '); - const words2 = text2.split(' '); + // Robust Word-Split (handles spaces/punctuation better) + const words1 = text1.trim().split(/\s+/).filter(w => w.length > 0); + const words2 = text2.trim().split(/\s+/).filter(w => w.length > 0); + const MAX_WORD_COUNT = 150000; const COMPLEX_WORD_COUNT = 50000; const BATCH_SIZE = 5000; // Define a suitable batch size for processing @@ -21,44 +42,28 @@ self.onmessage = async function (e) { const isComplex = words1.length > COMPLEX_WORD_COUNT || words2.length > COMPLEX_WORD_COUNT; const isTooLarge = words1.length > MAX_WORD_COUNT || words2.length > MAX_WORD_COUNT; - let complexMessage = 'One or both of the provided documents are large files, accuracy of comparison may be reduced'; - let tooLargeMessage = 'One or Both of the provided documents are too large to process'; - - // Listen for messages from the main thread - self.addEventListener('message', (event) => { - if (event.data.type === 'SET_TOO_LARGE_MESSAGE') { - tooLargeMessage = event.data.message; - } - if (event.data.type === 'SET_COMPLEX_MESSAGE') { - complexMessage = event.data.message; - } - }); - if (isTooLarge) { - self.postMessage({ - status: 'warning', - message: tooLargeMessage, - }); + self.postMessage({ status: 'error', message: largeFilesMessage }); return; - } else { - - if (isComplex) { - self.postMessage({ - status: 'warning', - message: complexMessage, - }); - } - // Perform diff operation depending on document size - const differences = isComplex - ? await staggeredBatchDiff(words1, words2, color1, color2, BATCH_SIZE, OVERLAP_SIZE) - : diff(words1, words2, color1, color2); - - console.log(`Diff operation took ${performance.now() - startTime} milliseconds`); - self.postMessage({ status: 'success', differences }); } + + if (isComplex) { + self.postMessage({ status: 'warning', message: complexMessage }); + } + + // Diff based on size + let differences; + if (isComplex) { + differences = await staggeredBatchDiff(words1, words2, color1 || '#ff0000', color2 || '#008000', BATCH_SIZE, OVERLAP_SIZE); + } else { + differences = diff(words1, words2, color1 || '#ff0000', color2 || '#008000'); + } + + console.log(`Diff took ${performance.now() - startTime} ms for ${words1.length + words2.length} words`); + self.postMessage({ status: 'success', differences }); }; -//Splits text into smaller batches to run through diff checking algorithms. overlaps the batches to help ensure +// Splits text into smaller batches to run through diff checking algorithms. overlaps the batches to help ensure async function staggeredBatchDiff(words1, words2, color1, color2, batchSize, overlapSize) { const differences = []; const totalWords1 = words1.length; @@ -67,10 +72,9 @@ async function staggeredBatchDiff(words1, words2, color1, color2, batchSize, ove let previousEnd1 = 0; // Track where the last batch ended in words1 let previousEnd2 = 0; // Track where the last batch ended in words2 - // Function to determine if differences are large, differences that are too large indicate potential error in batching - const isLargeDifference = (differences) => { - return differences.length > 50; - }; + // Track processed indices to dedupe overlaps + const processed1 = new Set(); + const processed2 = new Set(); while (previousEnd1 < totalWords1 || previousEnd2 < totalWords2) { // Define the next chunk boundaries @@ -80,66 +84,130 @@ async function staggeredBatchDiff(words1, words2, color1, color2, batchSize, ove const start2 = previousEnd2; const end2 = Math.min(start2 + batchSize, totalWords2); - //If difference is too high decrease batch size for more granular check - const dynamicBatchSize = isLargeDifference(differences) ? batchSize / 2 : batchSize; + // Adaptive: If many diffs, smaller batch (max 3x downscale) + const recentDiffs = differences.slice(-100).filter(([c]) => c !== 'black').length; + // If difference is too high decrease batch size for more granular check + const dynamicBatchSize = Math.max(batchSize / Math.min(8, 1 + recentDiffs / 50), batchSize / 8); - // Adjust the size of the current chunk using dynamic batch size - const batchWords1 = words1.slice(start1, end1 + dynamicBatchSize); - const batchWords2 = words2.slice(start2, end2 + dynamicBatchSize); + const extendedEnd1 = Math.min(end1 + dynamicBatchSize, totalWords1); + const extendedEnd2 = Math.min(end2 + dynamicBatchSize, totalWords2); + + const batchWords1 = words1.slice(start1, extendedEnd1); + const batchWords2 = words2.slice(start2, extendedEnd2); // Include overlap from the previous chunk - const overlapWords1 = previousEnd1 > 0 ? words1.slice(Math.max(0, previousEnd1 - overlapSize), previousEnd1) : []; - const overlapWords2 = previousEnd2 > 0 ? words2.slice(Math.max(0, previousEnd2 - overlapSize), previousEnd2) : []; + const overlapStart1 = Math.max(0, previousEnd1 - overlapSize); + const overlapStart2 = Math.max(0, previousEnd2 - overlapSize); + const overlapWords1 = previousEnd1 > 0 ? words1.slice(overlapStart1, previousEnd1) : []; + const overlapWords2 = previousEnd2 > 0 ? words2.slice(overlapStart2, previousEnd2) : []; + // Combine overlaps and current batches for comparison - const combinedWords1 = overlapWords1.concat(batchWords1); - const combinedWords2 = overlapWords2.concat(batchWords2); + const combinedWords1 = [...overlapWords1, ...batchWords1]; + const combinedWords2 = [...overlapWords2, ...batchWords2]; // Perform the diff on the combined words const batchDifferences = diff(combinedWords1, combinedWords2, color1, color2); - differences.push(...batchDifferences); - // Update the previous end indices based on the results of this batch + const combinedIndices1 = []; + for (let i = overlapStart1; i < previousEnd1; i++) { + combinedIndices1.push(i); + } + for (let i = start1; i < extendedEnd1; i++) { + combinedIndices1.push(i); + } + + const combinedIndices2 = []; + for (let i = overlapStart2; i < previousEnd2; i++) { + combinedIndices2.push(i); + } + for (let i = start2; i < extendedEnd2; i++) { + combinedIndices2.push(i); + } + + let pointer1 = 0; + let pointer2 = 0; + + const filteredBatch = []; + batchDifferences.forEach(([color, word]) => { + if (color === color1) { + const globalIndex1 = combinedIndices1[pointer1]; + if (globalIndex1 === undefined || !processed1.has(globalIndex1)) { + filteredBatch.push([color, word]); + } + if (globalIndex1 !== undefined) { + processed1.add(globalIndex1); + } + pointer1++; + } else if (color === color2) { + const globalIndex2 = combinedIndices2[pointer2]; + if (globalIndex2 === undefined || !processed2.has(globalIndex2)) { + filteredBatch.push([color, word]); + } + if (globalIndex2 !== undefined) { + processed2.add(globalIndex2); + } + pointer2++; + } else { + const globalIndex1 = combinedIndices1[pointer1]; + const globalIndex2 = combinedIndices2[pointer2]; + const alreadyProcessed = (globalIndex1 !== undefined && processed1.has(globalIndex1)) && (globalIndex2 !== undefined && processed2.has(globalIndex2)); + if (!alreadyProcessed) { + filteredBatch.push([color, word]); + } + if (globalIndex1 !== undefined) { + processed1.add(globalIndex1); + } + if (globalIndex2 !== undefined) { + processed2.add(globalIndex2); + } + pointer1++; + pointer2++; + } + }); + + differences.push(...filteredBatch); + + // Mark as processed + for (let k = start1; k < end1; k++) processed1.add(k); + for (let k = start2; k < end2; k++) processed2.add(k); + previousEnd1 = end1; previousEnd2 = end2; + + // Yield for async (avoids blocking) + await new Promise(resolve => setTimeout(resolve, 0)); } return differences; } - // Standard diff function for small text comparisons function diff(words1, words2, color1, color2) { - console.log(`Starting diff between ${words1.length} words and ${words2.length} words`); - const matrix = Array.from({ length: words1.length + 1 }, () => Array(words2.length + 1).fill(0)); + console.log(`Diff: ${words1.length} vs ${words2.length} words`); + const oldStr = words1.join(' '); // As string for diff.js + const newStr = words2.join(' '); + // Static method: No 'new' needed, avoids constructor error + const changes = Diff.diffWords(oldStr, newStr, { ignoreWhitespace: true }); - for (let i = 1; i <= words1.length; i++) { - for (let j = 1; j <= words2.length; j++) { - matrix[i][j] = words1[i - 1] === words2[j - 1] - ? matrix[i - 1][j - 1] + 1 - : Math.max(matrix[i][j - 1], matrix[i - 1][j]); - } - } - return backtrack(matrix, words1, words2, color1, color2); -} - -// Backtrack function to find differences -function backtrack(matrix, words1, words2, color1, color2) { - let i = words1.length, j = words2.length; + // Map changes to [color, word] format (change.value and added/removed) const differences = []; + changes.forEach(change => { + const value = change.value; + const op = change.added ? 1 : change.removed ? -1 : 0; - while (i > 0 || j > 0) { - if (i > 0 && j > 0 && words1[i - 1] === words2[j - 1]) { - differences.unshift(['black', words1[i - 1]]); - i--; j--; - } else if (j > 0 && (i === 0 || matrix[i][j] === matrix[i][j - 1])) { - differences.unshift([color2, words2[j - 1]]); - j--; - } else { - differences.unshift([color1, words1[i - 1]]); - i--; - } - } + // Split value into words and process + const words = value.split(/\s+/).filter(w => w.length > 0); + words.forEach(word => { + if (op === 0) { // Equal + differences.push(['black', word]); + } else if (op === 1) { // Insert + differences.push([color2, word]); + } else if (op === -1) { // Delete + differences.push([color1, word]); + } + }); + }); return differences; } diff --git a/app/core/src/main/resources/static/js/downloader.js b/app/core/src/main/resources/static/js/downloader.js index 9e074be5e1..2afdb2f75c 100644 --- a/app/core/src/main/resources/static/js/downloader.js +++ b/app/core/src/main/resources/static/js/downloader.js @@ -2,6 +2,12 @@ if (window.isDownloadScriptInitialized) return; // Prevent re-execution window.isDownloadScriptInitialized = true; + const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', + }; + // Global PDF processing count tracking for survey system window.incrementPdfProcessingCount = function() { let pdfProcessingCount = parseInt(localStorage.getItem('pdfProcessingCount') || '0'); @@ -19,12 +25,87 @@ error, } = window.stirlingPDF; + // Format Problem Details JSON with consistent key order and pretty-printing + function formatProblemDetailsJson(input) { + try { + const obj = typeof input === 'string' ? JSON.parse(input) : input; + const preferredOrder = [ + 'errorCode', + 'title', + 'status', + 'type', + 'detail', + 'instance', + 'path', + 'timestamp', + 'hints', + 'actionRequired' + ]; + + const out = {}; + // Place preferred keys first if present + preferredOrder.forEach((k) => { + if (Object.prototype.hasOwnProperty.call(obj, k)) { + out[k] = obj[k]; + } + }); + // Append remaining keys preserving their original order + Object.keys(obj).forEach((k) => { + if (!Object.prototype.hasOwnProperty.call(out, k)) { + out[k] = obj[k]; + } + }); + return JSON.stringify(out, null, 2); + } catch (e) { + // Fallback: if it's already a string, return as-is; otherwise pretty-print best effort + if (typeof input === 'string') return input; + try { + return JSON.stringify(input, null, 2); + } catch { + return String(input); + } + } + } + function showErrorBanner(message, stackTrace) { const errorContainer = document.getElementById('errorContainer'); + if (!errorContainer) { + console.error('Error container not found'); + return; + } errorContainer.style.display = 'block'; // Display the banner - errorContainer.querySelector('.alert-heading').textContent = error; - errorContainer.querySelector('p').textContent = message; - document.querySelector('#traceContent').textContent = stackTrace; + const heading = errorContainer.querySelector('.alert-heading'); + const messageEl = errorContainer.querySelector('p'); + const traceEl = document.querySelector('#traceContent'); + + if (heading) heading.textContent = error; + if (messageEl) { + messageEl.style.whiteSpace = 'pre-wrap'; + messageEl.textContent = message; + } + + // Format stack trace: if it looks like JSON, pretty-print with consistent key order; otherwise clean it up + if (traceEl) { + if (stackTrace) { + // Check if stackTrace is already JSON formatted + if (stackTrace.trim().startsWith('{') || stackTrace.trim().startsWith('[')) { + traceEl.textContent = formatProblemDetailsJson(stackTrace); + } else { + // Filter out unhelpful stack traces (internal browser/library paths) + // Only show if it contains meaningful error info + const lines = stackTrace.split('\n'); + const meaningfulLines = lines.filter(line => + !line.includes('pdfjs-legacy') && + !line.includes('pdf.worker') && + !line.includes('pdf.mjs') && + line.trim().length > 0 + ); + traceEl.textContent = meaningfulLines.length > 0 ? meaningfulLines.join('\n') : 'No additional trace information available'; + } + } else { + traceEl.textContent = ''; + } + } } function showSessionExpiredPrompt() { @@ -74,6 +155,12 @@ showGameBtn.style.display = 'none'; } + // Log fileOrder for debugging + const fileOrderValue = formData.get('fileOrder'); + if (fileOrderValue) { + console.log('FormData fileOrder:', fileOrderValue); + } + // Remove empty file entries for (let [key, value] of formData.entries()) { if (value instanceof File && !value.name) { @@ -153,8 +240,13 @@ async function getPDFPageCount(file) { try { const arrayBuffer = await file.arrayBuffer(); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - const pdf = await pdfjsLib.getDocument({data: arrayBuffer}).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + const pdf = await pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: arrayBuffer, + }) + .promise; return pdf.numPages; } catch (error) { console.error('Error getting PDF page count:', error); @@ -164,7 +256,7 @@ async function checkAndDecryptFiles(url, files) { const decryptedFiles = []; - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; // Extract the base URL const baseUrl = new URL(url); @@ -190,7 +282,10 @@ } try { const arrayBuffer = await file.arrayBuffer(); - const loadingTask = pdfjsLib.getDocument({data: arrayBuffer}); + const loadingTask = pdfjsLib.getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: arrayBuffer, + }); console.log(`Attempting to load PDF: ${file.name}`); const pdf = await loadingTask.promise; @@ -204,11 +299,38 @@ if (!password) { console.error(`No password provided for encrypted PDF: ${file.name}`); - showErrorBanner( - `${window.decrypt.noPassword.replace('{0}', file.name)}`, - `${window.decrypt.unexpectedError}` - ); - throw error; + + // Create a Problem Detail object matching the server's E004 response using localized strings + const passwordDetailTemplate = + window.stirlingPDF?.pdfPasswordDetail || + `The PDF file "${file.name}" requires a password to proceed.`; + const hints = [ + window.stirlingPDF?.pdfPasswordHint1, + window.stirlingPDF?.pdfPasswordHint2, + window.stirlingPDF?.pdfPasswordHint3, + window.stirlingPDF?.pdfPasswordHint4, + window.stirlingPDF?.pdfPasswordHint5, + window.stirlingPDF?.pdfPasswordHint6 + ].filter(Boolean); + const noProblemDetail = { + errorCode: 'E004', + title: window.stirlingPDF?.pdfPasswordTitle || 'PDF Password Required', + detail: passwordDetailTemplate.includes('{0}') + ? passwordDetailTemplate.replace('{0}', file.name) + : passwordDetailTemplate, + hints, + actionRequired: + window.stirlingPDF?.pdfPasswordAction || + 'Provide the owner/permissions password, not just the document open password.' + }; + + const bannerMessage = formatUserFriendlyError(noProblemDetail); + const debugInfo = formatProblemDetailsJson(noProblemDetail); + showErrorBanner(bannerMessage, debugInfo); + + const err = new Error(noProblemDetail.detail); + err.alreadyHandled = true; + throw err; } try { @@ -220,18 +342,30 @@ // Use handleSingleDownload to send the request const decryptionResult = await fetchWithCsrf(removePasswordUrl, {method: 'POST', body: formData}); + // Check if we got an error response (RFC 7807 Problem Details) + if (!decryptionResult.ok) { + const contentType = decryptionResult.headers.get('content-type'); + if (contentType && (contentType.includes('application/json') || contentType.includes('application/problem+json'))) { + // Parse the RFC 7807 error response + const errorJson = await decryptionResult.json(); + const formattedError = formatUserFriendlyError(errorJson); + const debugInfo = formatProblemDetailsJson(errorJson); + const title = errorJson.title || 'Decryption Failed'; + const detail = errorJson.detail || 'Failed to decrypt PDF'; + const bannerMessage = formattedError || `${title}: ${detail}`; + showErrorBanner(bannerMessage, debugInfo); + const err = new Error(detail); + err.alreadyHandled = true; // Mark error as already handled + throw err; + } else { + throw new Error('Decryption failed: Invalid server response'); + } + } + if (decryptionResult && decryptionResult.blob) { const decryptedBlob = await decryptionResult.blob(); const decryptedFile = new File([decryptedBlob], file.name, {type: 'application/pdf'}); - /* // Create a link element to download the file - const link = document.createElement('a'); - link.href = URL.createObjectURL(decryptedBlob); - link.download = 'test.pdf'; - document.body.appendChild(link); - link.click(); - document.body.removeChild(link); -*/ decryptedFiles.push(decryptedFile); console.log(`Successfully decrypted PDF: ${file.name}`); } else { @@ -239,10 +373,7 @@ } } catch (decryptError) { console.error(`Failed to decrypt PDF: ${file.name}`, decryptError); - showErrorBanner( - `${window.decrypt.invalidPasswordHeader.replace('{0}', file.name)}`, - `${window.decrypt.invalidPassword}` - ); + // Error banner already shown above with formatted hints/actions throw decryptError; } } else if (error.name === 'InvalidPDFException' || @@ -250,10 +381,34 @@ // Handle corrupted PDF files console.log(`Corrupted PDF detected: ${file.name}`, error); if (window.stirlingPDF.currentPage !== 'repair') { - showErrorBanner( - `${window.stirlingPDF.pdfCorruptedMessage.replace('{0}', file.name)}`, - `${window.stirlingPDF.tryRepairMessage}` - ); + // Create a formatted error message using properties from language files + const errorMessage = window.stirlingPDF.pdfCorruptedMessage.replace('{0}', file.name); + const hints = [ + window.stirlingPDF.pdfCorruptedHint1, + window.stirlingPDF.pdfCorruptedHint2, + window.stirlingPDF.pdfCorruptedHint3 + ].filter((hint) => typeof hint === 'string' && hint.trim().length > 0); + const action = window.stirlingPDF.pdfCorruptedAction || window.stirlingPDF.tryRepairMessage; + + const problemDetails = { + title: window.stirlingPDF.pdfCorruptedTitle || window.stirlingPDF.error || 'Error', + detail: errorMessage + }; + + if (hints.length > 0) { + problemDetails.hints = hints; + } + + if (action) { + problemDetails.actionRequired = action; + } + + const bannerMessage = formatUserFriendlyError(problemDetails); + const debugInfo = formatProblemDetailsJson(problemDetails); + + showErrorBanner(bannerMessage, debugInfo); + // Mark error as already handled to prevent double display + error.alreadyHandled = true; } else { // On repair page, suppress banner; user already knows and is repairing console.log('Suppressing corrupted PDF banner on repair page'); @@ -280,15 +435,33 @@ if (!response.ok) { errorMessage = response.status; + // Check for JSON error responses first (including RFC 7807 Problem Details) + if (contentType && (contentType.includes('application/json') || contentType.includes('application/problem+json'))) { + console.error('Throwing error banner, response was not okay'); + await handleJsonResponse(response); + // Return early - error banner already shown by handleJsonResponse + // Don't throw to avoid double error display + return null; + } + // Only show session expired for 401 without JSON body (actual auth failure) if (response.status === 401) { showSessionExpiredPrompt(); return; } - if (contentType && contentType.includes('application/json')) { - console.error('Throwing error banner, response was not okay'); - return handleJsonResponse(response); + // For non-JSON errors, try to extract error message from response body + try { + const errorText = await response.text(); + if (errorText && errorText.trim().length > 0) { + showErrorBanner(`HTTP ${response.status}`, errorText); + // Return early - error already shown + return null; + } + } catch (textError) { + // If we can't read the response body, show generic error + const errorMsg = `HTTP ${response.status} - ${response.statusText || 'Request failed'}`; + showErrorBanner('Error', errorMsg); + return null; } - throw new Error(`HTTP error! status: ${response.status}`); } const contentDisposition = response.headers.get('Content-Disposition'); @@ -345,20 +518,100 @@ return filename; } + /** + * Format error details in a user-friendly way + * Extracts key information and presents hints/actions prominently + */ + function formatUserFriendlyError(json) { + if (!json || typeof json !== 'object') { + return typeof json === 'string' ? json : ''; + } + + const lines = []; + const title = json.title || json.error || ''; + const detail = json.detail || json.message || ''; + + const primaryLine = title && detail + ? `${title}: ${detail}` + : title || detail; + + if (primaryLine) { + lines.push(primaryLine); + } + + if (json.errorCode) { + lines.push(''); + lines.push(`Error Code: ${json.errorCode}`); + } + + const detailAlreadyIncluded = detail && primaryLine && primaryLine.includes(detail); + + if (detail && !detailAlreadyIncluded) { + lines.push(''); + lines.push(detail); + } + + if (json.hints && Array.isArray(json.hints) && json.hints.length > 0) { + lines.push(''); + lines.push('How to fix:'); + json.hints.forEach((hint, index) => { + lines.push(` ${index + 1}. ${hint}`); + }); + } + + if (json.actionRequired) { + lines.push(''); + lines.push(json.actionRequired); + } + + if (json.supportId) { + lines.push(''); + lines.push(`Support ID: ${json.supportId}`); + } + + return lines + .filter((line, index, arr) => { + if (line !== '') return true; + if (index === 0 || index === arr.length - 1) return false; + return arr[index - 1] !== ''; + }) + .join('\n'); + } + async function handleJsonResponse(response) { const json = await response.json(); - const errorMessage = JSON.stringify(json, null, 2); - if ( - errorMessage.toLowerCase().includes('the password is incorrect') || - errorMessage.toLowerCase().includes('Password is not provided') || - errorMessage.toLowerCase().includes('PDF contains an encryption dictionary') - ) { + + // Format the full JSON response for display in stack trace with errorCode first + const formattedJson = formatProblemDetailsJson(json); + + // Check for PDF password errors using RFC 7807 fields + const isPdfPasswordError = + json.type === '/errors/pdf-password' || + json.errorCode === 'E004' || + (json.detail && ( + json.detail.toLowerCase().includes('pdf document is passworded') || + json.detail.toLowerCase().includes('password is incorrect') || + json.detail.toLowerCase().includes('password was not provided') || + json.detail.toLowerCase().includes('pdf contains an encryption dictionary') + )); + + const fallbackTitle = json.title || json.error || 'Error'; + const fallbackDetail = json.detail || json.message || ''; + const fallbackMessage = fallbackDetail ? `${fallbackTitle}: ${fallbackDetail}` : fallbackTitle; + const bannerMessage = formatUserFriendlyError(json) || fallbackMessage; + + if (isPdfPasswordError) { + showErrorBanner(bannerMessage, formattedJson); + + // Show alert only once for user attention if (!firstErrorOccurred) { firstErrorOccurred = true; - alert(pdfPasswordPrompt); + const detail = json.detail || 'The PDF document requires a password to open.'; + alert(pdfPasswordPrompt + '\n\n' + detail); } } else { - showErrorBanner(json.error + ':' + json.message, json.trace); + // Show user-friendly error, fallback to full JSON for debugging + showErrorBanner(bannerMessage, formattedJson); } } @@ -383,6 +636,10 @@ } function handleDownloadError(error) { + // Skip if error was already handled and displayed + if (error.alreadyHandled) { + return; + } const errorMessage = error.message; showErrorBanner(errorMessage); } @@ -463,12 +720,15 @@ try { const downloadDetails = await handleSingleDownload(url, fileFormData, true, zipFiles); console.log(downloadDetails); - if (zipFiles) { - jszip.file(downloadDetails.filename, downloadDetails.blob); - } else { - //downloadFile(downloadDetails.blob, downloadDetails.filename); + // If downloadDetails is null, error was already shown, skip processing + if (downloadDetails) { + if (zipFiles) { + jszip.file(downloadDetails.filename, downloadDetails.blob); + } else { + //downloadFile(downloadDetails.blob, downloadDetails.filename); + } + updateProgressBar(progressBar, Array.from(files).length); } - updateProgressBar(progressBar, Array.from(files).length); } catch (error) { handleDownloadError(error); console.error(error); diff --git a/app/core/src/main/resources/static/js/errorBanner.js b/app/core/src/main/resources/static/js/errorBanner.js index 727a854f7f..528fe8f272 100644 --- a/app/core/src/main/resources/static/js/errorBanner.js +++ b/app/core/src/main/resources/static/js/errorBanner.js @@ -3,7 +3,7 @@ var traceVisible = false; function toggletrace() { var traceDiv = document.getElementById("trace"); if (!traceVisible) { - traceDiv.style.maxHeight = "500px"; + traceDiv.style.maxHeight = "100vh"; traceVisible = true; } else { traceDiv.style.maxHeight = "0px"; diff --git a/app/core/src/main/resources/static/js/fileInput.js b/app/core/src/main/resources/static/js/fileInput.js index 71b6a1ebfe..07ec80882e 100644 --- a/app/core/src/main/resources/static/js/fileInput.js +++ b/app/core/src/main/resources/static/js/fileInput.js @@ -29,6 +29,54 @@ const mimeTypes = { "pdf": "application/pdf", }; +const isMultiToolPage = () => window.location.pathname?.includes('multi-tool'); + +const isSvgFile = (file) => { + if (!file) return false; + const type = (file.type || '').toLowerCase(); + if (type === 'image/svg+xml') { + return true; + } + const name = (file.name || '').toLowerCase(); + return name.endsWith('.svg'); +}; + +function filterSvgFiles(files) { + if (!Array.isArray(files) || !isMultiToolPage()) { + return { allowed: files ?? [], rejected: [] }; + } + + const allowed = []; + const rejected = []; + + files.forEach((file) => { + if (isSvgFile(file)) { + rejected.push(file); + } else { + allowed.push(file); + } + }); + + return { allowed, rejected }; +} + +function showSvgWarning(rejectedFiles = []) { + if (!rejectedFiles.length) return; + + const message = window.multiTool?.svgNotSupported || + 'SVG files are not supported in Multi Tool and were ignored.'; + const rejectedNames = rejectedFiles + .map((file) => file?.name) + .filter(Boolean) + .join(', '); + + if (rejectedNames) { + alert(`${message}\n${rejectedNames}`); + } else { + alert(message); + } +} + function setupFileInput(chooser) { const elementId = chooser.getAttribute('data-bs-element-id'); const filesSelected = chooser.getAttribute('data-bs-files-selected'); @@ -198,6 +246,24 @@ function setupFileInput(chooser) { await checkZipFile(); + const { allowed: nonSvgFiles, rejected: rejectedSvgFiles } = filterSvgFiles(allFiles); + if (rejectedSvgFiles.length > 0) { + showSvgWarning(rejectedSvgFiles); + allFiles = nonSvgFiles; + + const updatedTransfer = toDataTransfer(allFiles); + element.files = updatedTransfer.files; + if (allFiles.length === 0) { + element.value = ''; + } + + if (allFiles.length === 0) { + inputContainer.querySelector('#fileInputText').innerHTML = originalText; + showOrHideSelectedFilesContainer(allFiles); + return; + } + } + const uploadLimit = window.stirlingPDF?.uploadLimit ?? 0; if (uploadLimit > 0) { const oversizedFiles = allFiles.filter(f => f.size > uploadLimit); diff --git a/app/core/src/main/resources/static/js/homecard.js b/app/core/src/main/resources/static/js/homecard.js index 7da818d05c..22c0caaf58 100644 --- a/app/core/src/main/resources/static/js/homecard.js +++ b/app/core/src/main/resources/static/js/homecard.js @@ -186,7 +186,9 @@ function sortNavElements(criteria) { async function fetchPopularityData(url) { const response = await fetch(url); if (!response.ok) { - throw new Error(`HTTP error! status: ${response.status}`); + const errorText = await response.text().catch(() => ''); + const errorMsg = errorText || response.statusText || 'Request failed'; + throw new Error(`HTTP ${response.status}: ${errorMsg}`); } return await response.text(); } @@ -218,9 +220,11 @@ document.addEventListener('DOMContentLoaded', async function () { }); } try { - const response = await fetch('/files/popularity.txt'); + const response = await fetch('./files/popularity.txt'); if (!response.ok) { - throw new Error(`HTTP error! status: ${response.status}`); + const errorText = await response.text().catch(() => ''); + const errorMsg = errorText || response.statusText || 'Request failed'; + throw new Error(`HTTP ${response.status}: ${errorMsg}`); } const popularityData = await response.json(); applyPopularityData(popularityData); diff --git a/app/core/src/main/resources/static/js/merge.js b/app/core/src/main/resources/static/js/merge.js index 01d7d97d99..af5037c27b 100644 --- a/app/core/src/main/resources/static/js/merge.js +++ b/app/core/src/main/resources/static/js/merge.js @@ -1,3 +1,9 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + let currentSort = { field: null, descending: false, @@ -73,7 +79,13 @@ async function displayFiles(files) { async function getPDFPageCount(file) { const blobUrl = URL.createObjectURL(file); - const pdf = await pdfjsLib.getDocument(blobUrl).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + const pdf = await pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + url: blobUrl, + }) + .promise; URL.revokeObjectURL(blobUrl); return pdf.numPages; } @@ -123,39 +135,38 @@ function attachMoveButtons() { } } -document.getElementById("sortByNameBtn").addEventListener("click", function () { +document.getElementById("sortByNameBtn").addEventListener("click", async function () { if (currentSort.field === "name" && !currentSort.descending) { currentSort.descending = true; - sortFiles((a, b) => b.name.localeCompare(a.name)); + await sortFiles((a, b) => b.name.localeCompare(a.name)); } else { currentSort.field = "name"; currentSort.descending = false; - sortFiles((a, b) => a.name.localeCompare(b.name)); + await sortFiles((a, b) => a.name.localeCompare(b.name)); } }); -document.getElementById("sortByDateBtn").addEventListener("click", function () { +document.getElementById("sortByDateBtn").addEventListener("click", async function () { if (currentSort.field === "lastModified" && !currentSort.descending) { currentSort.descending = true; - sortFiles((a, b) => b.lastModified - a.lastModified); + await sortFiles((a, b) => b.lastModified - a.lastModified); } else { currentSort.field = "lastModified"; currentSort.descending = false; - sortFiles((a, b) => a.lastModified - b.lastModified); + await sortFiles((a, b) => a.lastModified - b.lastModified); } }); -function sortFiles(comparator) { +async function sortFiles(comparator) { // Convert FileList to array and sort const sortedFilesArray = Array.from(document.getElementById("fileInput-input").files).sort(comparator); - // Refresh displayed list - displayFiles(sortedFilesArray); + // Refresh displayed list (wait for it to complete since it's async) + await displayFiles(sortedFilesArray); - // Update the files property - const dataTransfer = new DataTransfer(); - sortedFilesArray.forEach((file) => dataTransfer.items.add(file)); - document.getElementById("fileInput-input").files = dataTransfer.files; + // Update the file input and fileOrder based on the current display order + // This ensures consistency between display and file input + updateFiles(); } function updateFiles() { @@ -163,25 +174,36 @@ function updateFiles() { var liElements = document.querySelectorAll("#selectedFiles li"); const files = document.getElementById("fileInput-input").files; + console.log("updateFiles: found", liElements.length, "LI elements and", files.length, "files"); + for (var i = 0; i < liElements.length; i++) { var fileNameFromList = liElements[i].querySelector(".filename").innerText; - var fileFromFiles; + var found = false; for (var j = 0; j < files.length; j++) { var file = files[j]; if (file.name === fileNameFromList) { dataTransfer.items.add(file); + found = true; break; } } + if (!found) { + console.warn("updateFiles: Could not find file:", fileNameFromList); + } } + document.getElementById("fileInput-input").files = dataTransfer.files; + console.log("updateFiles: Updated file input with", dataTransfer.files.length, "files"); // Also populate hidden fileOrder to preserve visible order const order = Array.from(liElements) .map((li) => li.querySelector(".filename").innerText) .join("\n"); const orderInput = document.getElementById("fileOrder"); - if (orderInput) orderInput.value = order; + if (orderInput) { + orderInput.value = order; + console.log("Updated fileOrder:", order); + } } document.querySelector("#resetFileInputBtn").addEventListener("click", ()=>{ diff --git a/app/core/src/main/resources/static/js/multitool/ImageHighlighter.js b/app/core/src/main/resources/static/js/multitool/ImageHighlighter.js index cf5d161a37..4b914ea9d6 100644 --- a/app/core/src/main/resources/static/js/multitool/ImageHighlighter.js +++ b/app/core/src/main/resources/static/js/multitool/ImageHighlighter.js @@ -42,25 +42,6 @@ class ImageHighlighter { img.addEventListener("click", this.imageHighlightCallback); return div; } - - async addImageFile(file, nextSiblingElement) { - const div = document.createElement("div"); - div.classList.add("page-container"); - - var img = document.createElement("img"); - img.classList.add("page-image"); - img.src = URL.createObjectURL(file); - div.appendChild(img); - - this.pdfAdapters.forEach((adapter) => { - adapter.adapt?.(div); - }); - if (nextSiblingElement) { - this.pagesContainer.insertBefore(div, nextSiblingElement); - } else { - this.pagesContainer.appendChild(div); - } - } } export default ImageHighlighter; diff --git a/app/core/src/main/resources/static/js/multitool/PdfActionsManager.js b/app/core/src/main/resources/static/js/multitool/PdfActionsManager.js index 1ef2978e99..14cb310062 100644 --- a/app/core/src/main/resources/static/js/multitool/PdfActionsManager.js +++ b/app/core/src/main/resources/static/js/multitool/PdfActionsManager.js @@ -1,4 +1,5 @@ import { DeletePageCommand } from "./commands/delete-page.js"; +import { DuplicatePageCommand } from "./commands/duplicate-page.js"; import { SelectPageCommand } from "./commands/select.js"; import { SplitFileCommand } from "./commands/split.js"; import { UndoManager } from "./UndoManager.js"; @@ -78,6 +79,18 @@ class PdfActionsManager { this._pushUndoClearRedo(deletePageCommand); } + duplicatePageButtonCallback(e) { + let imgContainer = this.getPageContainer(e.target); + let duplicatePageCommand = new DuplicatePageCommand( + imgContainer, + this.duplicatePage, + this.pagesContainer + ); + duplicatePageCommand.execute(); + + this._pushUndoClearRedo(duplicatePageCommand); + } + insertFileButtonCallback(e) { var imgContainer = this.getPageContainer(e.target); this.addFiles(imgContainer); @@ -101,10 +114,11 @@ class PdfActionsManager { this.undoManager.pushUndoClearRedo(command); } - setActions({ movePageTo, addFiles, rotateElement }) { + setActions({ movePageTo, addFiles, rotateElement, duplicatePage }) { this.movePageTo = movePageTo; this.addFiles = addFiles; this.rotateElement = rotateElement; + this.duplicatePage = duplicatePage; this.moveUpButtonCallback = this.moveUpButtonCallback.bind(this); this.moveDownButtonCallback = this.moveDownButtonCallback.bind(this); @@ -114,6 +128,7 @@ class PdfActionsManager { this.insertFileButtonCallback = this.insertFileButtonCallback.bind(this); this.insertFileBlankButtonCallback = this.insertFileBlankButtonCallback.bind(this); this.splitFileButtonCallback = this.splitFileButtonCallback.bind(this); + this.duplicatePageButtonCallback = this.duplicatePageButtonCallback.bind(this); } @@ -154,6 +169,13 @@ class PdfActionsManager { rotateCW.onclick = this.rotateCWButtonCallback; buttonContainer.appendChild(rotateCW); + const duplicatePage = document.createElement("button"); + duplicatePage.classList.add("btn", "btn-secondary"); + duplicatePage.setAttribute('title', window.translations.duplicate); + duplicatePage.innerHTML = `control_point_duplicate`; + duplicatePage.onclick = this.duplicatePageButtonCallback; + buttonContainer.appendChild(duplicatePage); + const deletePage = document.createElement("button"); deletePage.classList.add("btn", "btn-danger"); deletePage.setAttribute('title', window.translations.delete); @@ -195,7 +217,7 @@ class PdfActionsManager { const insertFileButton = document.createElement("button"); insertFileButton.classList.add("btn", "btn-primary"); - moveUp.setAttribute('title', window.translations.addFile); + insertFileButton.setAttribute('title', window.translations.addFile); insertFileButton.innerHTML = `add`; insertFileButton.onclick = this.insertFileButtonCallback; insertFileButtonContainer.appendChild(insertFileButton); diff --git a/app/core/src/main/resources/static/js/multitool/PdfContainer.js b/app/core/src/main/resources/static/js/multitool/PdfContainer.js index ade68f0d9b..866fd69faf 100644 --- a/app/core/src/main/resources/static/js/multitool/PdfContainer.js +++ b/app/core/src/main/resources/static/js/multitool/PdfContainer.js @@ -8,6 +8,55 @@ import { AddFilesCommand } from './commands/add-page.js'; import { DecryptFile } from '../DecryptFiles.js'; import { CommandSequence } from './commands/commands-sequence.js'; +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + +const isSvgFile = (file) => { + if (!file) return false; + const type = (file.type || '').toLowerCase(); + if (type === 'image/svg+xml') { + return true; + } + const name = (file.name || '').toLowerCase(); + return name.endsWith('.svg'); +}; + +const partitionSvgFiles = (files = []) => { + const allowed = []; + const rejected = []; + + files.forEach((file) => { + if (isSvgFile(file)) { + rejected.push(file); + } else { + allowed.push(file); + } + }); + + return { allowed, rejected }; +}; + +const notifySvgUnsupported = (files = []) => { + if (!files.length) return; + if (!window.location.pathname?.includes('multi-tool')) return; + + const message = window.multiTool?.svgNotSupported || + 'SVG files are not supported in Multi Tool and were ignored.'; + const names = files + .map((file) => file?.name) + .filter(Boolean) + .join(', '); + + if (names) { + alert(`${message}\n${names}`); + } else { + alert(message); + } +}; + class PdfContainer { fileName; pagesContainer; @@ -30,6 +79,7 @@ class PdfContainer { this.setDownloadAttribute = this.setDownloadAttribute.bind(this); this.preventIllegalChars = this.preventIllegalChars.bind(this); this.addImageFile = this.addImageFile.bind(this); + this.duplicatePage = this.duplicatePage.bind(this); this.nameAndArchiveFiles = this.nameAndArchiveFiles.bind(this); this.splitPDF = this.splitPDF.bind(this); this.splitAll = this.splitAll.bind(this); @@ -56,6 +106,7 @@ class PdfContainer { rotateElement: this.rotateElement, updateFilename: this.updateFilename, deleteSelected: this.deleteSelected, + duplicatePage: this.duplicatePage, }); }); @@ -154,19 +205,31 @@ class PdfContainer { return movePageCommand; } - async addFiles(element) { - let addFilesCommand = new AddFilesCommand( + /** + * Adds files or a single blank page (when blank=true) near an anchor element. + * @param {HTMLElement|null} element - Anchor element (insert before its nextSibling). + * @param {boolean} [blank=false] - When true, insert a single blank page. + */ + async addFiles(element, blank = false) { + // Choose the action: real file picker or blank page generator. + const action = blank + ? async (nextSiblingElement) => { + // Create exactly one blank page and return the created elements array. + const pages = await this.addFilesBlank(nextSiblingElement, []); + return pages; // array of inserted elements + } + : this.addFilesAction.bind(this); + + const addFilesCommand = new AddFilesCommand( element, window.selectedPages, - this.addFilesAction.bind(this), + action, this.pagesContainer ); await addFilesCommand.execute(); - this.undoManager.pushUndoClearRedo(addFilesCommand); window.tooltipSetup(); - } async addFilesAction(nextSiblingElement) { @@ -180,10 +243,18 @@ class PdfContainer { input.onchange = async (e) => { const files = e.target.files; if (files.length > 0) { - pages = await this.addFilesFromFiles(files, nextSiblingElement, pages); - this.updateFilename(files[0].name); + const { + pages: updatedPages, + acceptedFileCount, + } = await this.addFilesFromFiles(files, nextSiblingElement, pages); - if(window.selectPage){ + pages = updatedPages; + + if (acceptedFileCount > 0) { + this.updateFilename(); + } + + if (window.selectPage && acceptedFileCount > 0) { this.showButton(document.getElementById('select-pages-container'), true); } } @@ -196,11 +267,17 @@ class PdfContainer { async handleDroppedFiles(files, nextSiblingElement = null) { if (files.length > 0) { - const pages = await this.addFilesFromFiles(files, nextSiblingElement, []); - this.updateFilename(files[0]?.name || 'untitled'); + const { + pages, + acceptedFileCount, + } = await this.addFilesFromFiles(files, nextSiblingElement, []); - if(window.selectPage) { - this.showButton(document.getElementById('select-pages-container'), true); + if (acceptedFileCount > 0) { + this.updateFilename(); + + if (window.selectPage) { + this.showButton(document.getElementById('select-pages-container'), true); + } } return pages; @@ -209,14 +286,24 @@ class PdfContainer { async addFilesFromFiles(files, nextSiblingElement, pages) { this.fileName = files[0].name; - for (var i = 0; i < files.length; i++) { + const fileArray = Array.from(files || []); + const { allowed: allowedFiles, rejected: rejectedSvgFiles } = partitionSvgFiles(fileArray); + + if (allowedFiles.length > 0) { + this.fileName = allowedFiles[0].name || 'untitled'; + } + + let acceptedFileCount = 0; + + for (let i = 0; i < allowedFiles.length; i++) { + const file = allowedFiles[i]; const startTime = Date.now(); let processingTime, errorMessage = null, pageCount = 0; try { - let decryptedFile = files[i]; + let decryptedFile = file; let isEncrypted = false; let requiresPassword = false; await this.decryptFile @@ -245,18 +332,27 @@ class PdfContainer { processingTime = Date.now() - startTime; this.captureFileProcessingEvent(true, decryptedFile, processingTime, null, pageCount); + acceptedFileCount++; } catch (error) { processingTime = Date.now() - startTime; errorMessage = error.message || 'Unknown error'; - this.captureFileProcessingEvent(false, files[i], processingTime, errorMessage, pageCount); + this.captureFileProcessingEvent(false, file, processingTime, errorMessage, pageCount); + + if (isSvgFile(file)) { + rejectedSvgFiles.push(file); + } } } + if (rejectedSvgFiles.length > 0) { + notifySvgUnsupported(rejectedSvgFiles); + } + document.querySelectorAll('.enable-on-file').forEach((element) => { element.disabled = false; }); - return pages; + return { pages, acceptedFileCount }; } captureFileProcessingEvent(success, file, processingTime, errorMessage, pageCount) { @@ -329,12 +425,20 @@ class PdfContainer { } async addImageFile(file, nextSiblingElement, pages) { + // Ensure the provided file is a safe image type to prevent DOM XSS when + // rendering user-supplied content. Reject SVG and non-image files that could + // contain executable scripts. + if (!(file instanceof File) || !file.type.startsWith('image/') || file.type === 'image/svg+xml') { + throw new Error('Invalid image file'); + } const div = document.createElement('div'); div.classList.add('page-container'); - var img = document.createElement('img'); + const img = document.createElement('img'); img.classList.add('page-image'); - img.src = URL.createObjectURL(file); + const objectUrl = URL.createObjectURL(file); + img.src = objectUrl; + img.onload = () => URL.revokeObjectURL(objectUrl); div.appendChild(img); this.pdfAdapters.forEach((adapter) => { @@ -349,6 +453,30 @@ class PdfContainer { return pages; } + duplicatePage(element) { + const clone = document.createElement('div'); + clone.classList.add('page-container'); + + const originalImg = element.querySelector('img'); + const img = document.createElement('img'); + img.classList.add('page-image'); + img.src = originalImg.src; + img.pageIdx = originalImg.pageIdx; + img.rend = originalImg.rend; + img.doc = originalImg.doc; + img.style.rotate = originalImg.style.rotate; + clone.appendChild(img); + + this.pdfAdapters.forEach((adapter) => { + adapter?.adapt?.(clone); + }); + + const nextSibling = element.nextSibling; + this.pagesContainer.insertBefore(clone, nextSibling); + this.updatePageNumbersAndCheckboxes(); + return clone; + } + async loadFile(file) { var objectUrl = URL.createObjectURL(file); var pdfDocument = await this.toPdfLib(objectUrl); @@ -357,8 +485,11 @@ class PdfContainer { } async toRenderer(objectUrl) { - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - const pdf = await pdfjsLib.getDocument(objectUrl).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + const pdf = await pdfjsLib.getDocument({ + url: objectUrl, + ...PDFJS_DEFAULT_OPTIONS, + }).promise; return { document: pdf, pageCount: pdf.numPages, @@ -609,7 +740,7 @@ class PdfContainer { this.showButton(selectIcon, true); } } else { - console.log("Page Select off. Hidding buttons"); + console.log("Page Select off. Hiding buttons"); this.showButton(selectIcon, false); this.showButton(deselectIcon, false); } @@ -703,20 +834,48 @@ class PdfContainer { async exportPdf(selected) { const pdfDoc = await PDFLib.PDFDocument.create(); const pageContainers = this.pagesContainer.querySelectorAll('.page-container'); // Select all .page-container elements + + const docPageMap = new Map(); + + pageContainers.forEach((container, index) => { + if (selected && !window.selectedPages.includes(index + 1)) { + return; + } + + const img = container.querySelector('img'); + if (!img?.doc) { + return; + } + + let entry = docPageMap.get(img.doc); + if (!entry) { + entry = { indices: [], copiedPages: [], cursor: 0 }; + docPageMap.set(img.doc, entry); + } + + entry.indices.push(img.pageIdx); + }); + + for (const [doc, entry] of docPageMap.entries()) { + entry.copiedPages = await pdfDoc.copyPages(doc, entry.indices); + } + for (var i = 0; i < pageContainers.length; i++) { if (!selected || window.selectedPages.includes(i + 1)) { const img = pageContainers[i].querySelector('img'); // Find the img element within each .page-container if (!img) continue; let page; if (img.doc) { - const pages = await pdfDoc.copyPages(img.doc, [img.pageIdx]); - page = pages[0]; + const entry = docPageMap.get(img.doc); + page = entry.copiedPages[entry.cursor++]; pdfDoc.addPage(page); } else { page = pdfDoc.addPage([img.naturalWidth, img.naturalHeight]); - const imageBytes = await fetch(img.src).then((res) => res.arrayBuffer()); + + // NEU: Bildbytes robust ermitteln (Canvas für blob:, fetch für http/https) + const { bytes: imageBytes, forcedType } = await bytesFromImageElement(img); const uint8Array = new Uint8Array(imageBytes); - const imageType = detectImageType(uint8Array); + const imageType = forcedType || detectImageType(uint8Array); let image; switch (imageType) { @@ -941,6 +1100,36 @@ class PdfContainer { } } +async function bytesFromImageElement(img) { + // Handle Blob URLs without using fetch() + if (img.src.startsWith('blob:')) { + const canvas = document.createElement('canvas'); + canvas.width = img.naturalWidth; + canvas.height = img.naturalHeight; + const ctx = canvas.getContext('2d', { willReadFrequently: true }); + ctx.drawImage(img, 0, 0); + const blob = await new Promise((resolve) => canvas.toBlob(resolve, 'image/png')); + if (!blob) throw new Error('Canvas toBlob() failed'); + const buf = await blob.arrayBuffer(); + return { bytes: buf, forcedType: 'PNG' }; // Canvas always generates PNG + } + + // Fetch http(s)/data:-URLs normally (if necessary) + const res = await fetch(img.src, { cache: 'no-store' }); + if (!res.ok) throw new Error(`HTTP ${res.status} beim Laden von ${img.src}`); + const buf = await res.arrayBuffer(); + + // Use Content-Type as a hint (optional) + let forcedType = null; + const ct = res.headers.get('content-type') || ''; + if (ct.includes('png')) forcedType = 'PNG'; + else if (ct.includes('jpeg') || ct.includes('jpg')) forcedType = 'JPEG'; + else if (ct.includes('tiff')) forcedType = 'TIFF'; + else if (ct.includes('gif')) forcedType = 'GIF'; + + return { bytes: buf, forcedType }; +} + function detectImageType(uint8Array) { // Check for PNG signature if (uint8Array[0] === 137 && uint8Array[1] === 80 && uint8Array[2] === 78 && uint8Array[3] === 71) { diff --git a/app/core/src/main/resources/static/js/multitool/commands/add-page.js b/app/core/src/main/resources/static/js/multitool/commands/add-page.js index b910320c98..09965042de 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/add-page.js +++ b/app/core/src/main/resources/static/js/multitool/commands/add-page.js @@ -1,51 +1,84 @@ -import {Command} from './command.js'; +import { CommandWithAnchors } from './command.js'; -export class AddFilesCommand extends Command { +export class AddFilesCommand extends CommandWithAnchors { + /** + * @param {HTMLElement|null} element - Anchor element (optional, forwarded to addFilesAction) + * @param {number[]} selectedPages + * @param {Function} addFilesAction - async (nextSiblingElement|false) => HTMLElement[]|HTMLElement|null + * @param {HTMLElement} pagesContainer + */ constructor(element, selectedPages, addFilesAction, pagesContainer) { super(); this.element = element; this.selectedPages = selectedPages; this.addFilesAction = addFilesAction; this.pagesContainer = pagesContainer; + + /** @type {HTMLElement[]} */ this.addedElements = []; + + /** + * Anchors captured on undo to support redo reinsertion. + * @type {{ el: HTMLElement, nextSibling: ChildNode|null, index: number }[]} + */ + this._anchors = []; } async execute() { const undoBtn = document.getElementById('undo-btn'); - undoBtn.disabled = true; - if (this.element) { - const newElement = await this.addFilesAction(this.element); - if (newElement) { - this.addedElements = newElement; - } + if (undoBtn) undoBtn.disabled = true; + + const result = await this.addFilesAction(this.element || false); + if (Array.isArray(result)) { + this.addedElements = result; + } else if (result) { + this.addedElements = [result]; } else { - const newElement = await this.addFilesAction(false); - if (newElement) { - this.addedElements = newElement; - } + this.addedElements = []; } - undoBtn.disabled = false; + + // Capture anchors right after insertion so redo does not depend on undo. + this._anchors = this.addedElements.map((el) => this.captureAnchor(el, this.pagesContainer)); + + if (undoBtn) undoBtn.disabled = false; } undo() { - this.addedElements.forEach((element) => { - const nextSibling = element.nextSibling; - this.pagesContainer.removeChild(element); + this._anchors = []; - if (this.pagesContainer.childElementCount === 0) { - const filenameInput = document.getElementById('filename-input'); - const downloadBtn = document.getElementById('export-button'); + for (const el of this.addedElements) { + this._anchors.push(this.captureAnchor(el, this.pagesContainer)); + this.pagesContainer.removeChild(el); + } + if (this.pagesContainer.childElementCount === 0) { + const filenameInput = document.getElementById('filename-input'); + const downloadBtn = document.getElementById('export-button'); + if (filenameInput) { filenameInput.disabled = true; filenameInput.value = ''; + } + if (downloadBtn) { downloadBtn.disabled = true; } - - element._nextSibling = nextSibling; - }); - this.addedElements = []; + } } + redo() { - this.execute(); + if (!this.addedElements.length) return; + // If the elements are already in the DOM (no prior undo), do nothing. + const alreadyInDom = + this.addedElements[0].parentNode === this.pagesContainer; + if (alreadyInDom) return; + + // Use pre-captured anchors (from execute) or fall back to capturing now. + const anchors = (this._anchors && this._anchors.length) + ? this._anchors + : this.addedElements.map((el) => + this.captureAnchor(el, this.pagesContainer)); + + for (const anchor of anchors) { + this.insertWithAnchor(this.pagesContainer, anchor); + } } } diff --git a/app/core/src/main/resources/static/js/multitool/commands/command.js b/app/core/src/main/resources/static/js/multitool/commands/command.js index a4ae5fdf0d..e6bc9b11c4 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/command.js +++ b/app/core/src/main/resources/static/js/multitool/commands/command.js @@ -3,3 +3,63 @@ export class Command { undo() {} redo() {} } + +/** + * Base class that provides anchor capture and reinsertion helpers + * to avoid storing custom state on DOM nodes. + */ +export class CommandWithAnchors extends Command { + constructor() { + super(); + /** @type {{ el: HTMLElement, nextSibling: ChildNode|null, index: number }[]} */ + this._anchors = []; + } + + /** + * Returns the child index of an element in a container. + * @param {HTMLElement} container + * @param {HTMLElement} el + * @returns {number} + */ + _indexOf(container, el) { + return Array.prototype.indexOf.call(container.children, el); + } + + /** + * Captures an anchor for later reinsertion. + * @param {HTMLElement} el + * @param {HTMLElement} container + * @returns {{ el: HTMLElement, nextSibling: ChildNode|null, index: number }} + */ + captureAnchor(el, container) { + return { + el, + nextSibling: el.nextSibling, + index: this._indexOf(container, el), + }; + } + + /** + * Reinserts an element using a previously captured anchor. + * Prefers stored nextSibling when still valid; otherwise falls back to index. + * @param {HTMLElement} container + * @param {{ el: HTMLElement, nextSibling: ChildNode|null, index: number }} anchor + */ + insertWithAnchor(container, anchor) { + const { el, nextSibling, index } = anchor; + const nextValid = nextSibling && nextSibling.parentNode === container; + + let ref = null; + if (nextValid) { + ref = nextSibling; + } else if ( + Number.isInteger(index) && + index >= 0 && + index < container.children.length + ) { + ref = container.children[index] || null; + } + + container.insertBefore(el, ref || null); + } +} diff --git a/app/core/src/main/resources/static/js/multitool/commands/commands-sequence.js b/app/core/src/main/resources/static/js/multitool/commands/commands-sequence.js index 61d2ba4697..ef2f93c218 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/commands-sequence.js +++ b/app/core/src/main/resources/static/js/multitool/commands/commands-sequence.js @@ -1,19 +1,27 @@ -import {Command} from './command.js'; +import { Command } from './command.js'; +/** + * Composes multiple commands into a single atomic operation. + * Executes in order; undo in reverse order. + */ export class CommandSequence extends Command { + /** @param {Command[]} commands - Commands to be executed/undone/redone as a group. */ constructor(commands) { super(); this.commands = commands; - } + + /** Execute: run each command in order. */ execute() { - this.commands.forEach((command) => command.execute()) + this.commands.forEach((command) => command.execute()); } + /** Undo: undo in reverse order. */ undo() { - this.commands.slice().reverse().forEach((command) => command.undo()) + this.commands.slice().reverse().forEach((command) => command.undo()); } + /** Redo: simply execute again. */ redo() { this.execute(); } diff --git a/app/core/src/main/resources/static/js/multitool/commands/delete-page.js b/app/core/src/main/resources/static/js/multitool/commands/delete-page.js index 751b115e2f..a52b4e962a 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/delete-page.js +++ b/app/core/src/main/resources/static/js/multitool/commands/delete-page.js @@ -1,20 +1,32 @@ import { Command } from "./command.js"; +/** + * Removes a page from the container and restores it on undo. + */ export class DeletePageCommand extends Command { + /** + * @param {HTMLElement} element - Page container to delete. + * @param {HTMLElement} pagesContainer - Parent container holding all pages. + */ constructor(element, pagesContainer) { super(); this.element = element; this.pagesContainer = pagesContainer; - this.filenameInputValue = document.getElementById("filename-input").value; + /** @type {ChildNode|null} */ + this.nextSibling = null; + + const filenameInput = document.getElementById("filename-input"); + /** @type {string} */ + this.filenameInputValue = filenameInput ? filenameInput.value : ""; const filenameParagraph = document.getElementById("filename"); - this.filenameParagraphText = filenameParagraph - ? filenameParagraph.innerText - : ""; + /** @type {string} */ + this.filenameParagraphText = filenameParagraph ? filenameParagraph.innerText : ""; } + /** Execute: remove the page and update empty-state UI if needed. */ execute() { this.nextSibling = this.element.nextSibling; @@ -23,15 +35,19 @@ export class DeletePageCommand extends Command { const filenameInput = document.getElementById("filename-input"); const downloadBtn = document.getElementById("export-button"); - filenameInput.disabled = true; - filenameInput.value = ""; - - downloadBtn.disabled = true; + if (filenameInput) { + filenameInput.disabled = true; + filenameInput.value = ""; + } + if (downloadBtn) { + downloadBtn.disabled = true; + } } } + /** Undo: reinsert the page at its original position. */ undo() { - let node = this.nextSibling; + const node = /** @type {ChildNode|null} */ (this.nextSibling); if (node) this.pagesContainer.insertBefore(this.element, node); else this.pagesContainer.appendChild(this.element); @@ -43,12 +59,16 @@ export class DeletePageCommand extends Command { const filenameInput = document.getElementById("filename-input"); const downloadBtn = document.getElementById("export-button"); - filenameInput.disabled = false; - filenameInput.value = this.filenameInputValue; - - downloadBtn.disabled = false; + if (filenameInput) { + filenameInput.disabled = false; + filenameInput.value = this.filenameInputValue; + } + if (downloadBtn) { + downloadBtn.disabled = false; + } } + /** Redo: remove again and maintain empty-state UI. */ redo() { const pageNumberElement = this.element.querySelector(".page-number"); if (pageNumberElement) { @@ -60,10 +80,13 @@ export class DeletePageCommand extends Command { const filenameInput = document.getElementById("filename-input"); const downloadBtn = document.getElementById("export-button"); - filenameInput.disabled = true; - filenameInput.value = ""; - - downloadBtn.disabled = true; + if (filenameInput) { + filenameInput.disabled = true; + filenameInput.value = ""; + } + if (downloadBtn) { + downloadBtn.disabled = true; + } } } } diff --git a/app/core/src/main/resources/static/js/multitool/commands/duplicate-page.js b/app/core/src/main/resources/static/js/multitool/commands/duplicate-page.js new file mode 100644 index 0000000000..8071bc9b27 --- /dev/null +++ b/app/core/src/main/resources/static/js/multitool/commands/duplicate-page.js @@ -0,0 +1,63 @@ +import { CommandWithAnchors } from './command.js'; + +export class DuplicatePageCommand extends CommandWithAnchors { + /** + * @param {HTMLElement} element - The page element to duplicate. + * @param {Function} duplicatePageAction - (element) => HTMLElement (new clone already inserted) + * @param {HTMLElement} pagesContainer + */ + constructor(element, duplicatePageAction, pagesContainer) { + super(); + this.element = element; + this.duplicatePageAction = duplicatePageAction; + this.pagesContainer = pagesContainer; + + /** @type {HTMLElement|null} */ + this.newElement = null; + + /** @type {{ el: HTMLElement, nextSibling: ChildNode|null, index: number }|null} */ + this._anchor = null; + } + + execute() { + // Create and insert a duplicate next to the original + this.newElement = this.duplicatePageAction(this.element); + } + + undo() { + if (!this.newElement) return; + + // Capture anchor before removal so redo can reinsert at the same position + this._anchor = this.captureAnchor(this.newElement, this.pagesContainer); + + this.pagesContainer.removeChild(this.newElement); + + if (this.pagesContainer.childElementCount === 0) { + const filenameInput = document.getElementById('filename-input'); + const downloadBtn = document.getElementById('export-button'); + if (filenameInput) { + filenameInput.disabled = true; + filenameInput.value = ''; + } + if (downloadBtn) { + downloadBtn.disabled = true; + } + } + + window.updatePageNumbersAndCheckboxes?.(); + } + + redo() { + if (!this.newElement) { + this.execute(); + return; + } + if (this._anchor) { + this.insertWithAnchor(this.pagesContainer, this._anchor); + } else { + // Fallback: insert relative to the original element + this.pagesContainer.insertBefore(this.newElement, this.element.nextSibling || null); + } + window.updatePageNumbersAndCheckboxes?.(); + } +} diff --git a/app/core/src/main/resources/static/js/multitool/commands/move-page.js b/app/core/src/main/resources/static/js/multitool/commands/move-page.js index b209e6a7de..d4436050fe 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/move-page.js +++ b/app/core/src/main/resources/static/js/multitool/commands/move-page.js @@ -1,13 +1,25 @@ -import {Command} from './command.js'; +import { Command } from './command.js'; +/** + * Moves a page (or multiple pages, via PdfContainer wrapper) inside the container. + */ export class MovePageCommand extends Command { + /** + * @param {HTMLElement} startElement - Dragged page container. + * @param {HTMLElement|null} endElement - Destination reference; insert before this node. Null = append. + * @param {HTMLElement} pagesContainer - Parent container with all pages. + * @param {HTMLElement} pagesContainerWrapper - Scrollable wrapper element. + * @param {boolean} [scrollTo=false] - Whether to apply a subtle scroll after move. + */ constructor(startElement, endElement, pagesContainer, pagesContainerWrapper, scrollTo = false) { super(); this.pagesContainer = pagesContainer; const childArray = Array.from(this.pagesContainer.childNodes); + /** @type {number} */ this.startIndex = childArray.indexOf(startElement); + /** @type {number} */ this.endIndex = childArray.indexOf(endElement); this.startElement = startElement; @@ -16,8 +28,10 @@ export class MovePageCommand extends Command { this.scrollTo = scrollTo; this.pagesContainerWrapper = pagesContainerWrapper; } + + /** Execute: perform DOM move and optional scroll. */ execute() { - // Check & remove page number elements here too if they exist because Firefox doesn't fire the relevant event on page move. + // Remove stale page number badge if present (Firefox sometimes misses the event) const pageNumberElement = this.startElement.querySelector('.page-number'); if (pageNumberElement) { this.startElement.removeChild(pageNumberElement); @@ -31,7 +45,7 @@ export class MovePageCommand extends Command { } if (this.scrollTo) { - const {width} = this.startElement.getBoundingClientRect(); + const { width } = this.startElement.getBoundingClientRect(); const vector = this.endIndex !== -1 && this.startIndex > this.endIndex ? 0 - width : width; this.pagesContainerWrapper.scroll({ @@ -40,16 +54,17 @@ export class MovePageCommand extends Command { } } + /** Undo: restore original order and optional scroll back. */ undo() { if (this.startElement) { this.pagesContainer.removeChild(this.startElement); - let previousNeighbour = Array.from(this.pagesContainer.childNodes)[this.startIndex]; + const previousNeighbour = Array.from(this.pagesContainer.childNodes)[this.startIndex]; previousNeighbour?.insertAdjacentElement('beforebegin', this.startElement) ?? this.pagesContainer.append(this.startElement); } if (this.scrollTo) { - const {width} = this.startElement.getBoundingClientRect(); + const { width } = this.startElement.getBoundingClientRect(); const vector = this.endIndex === -1 || this.startIndex <= this.endIndex ? 0 - width : width; this.pagesContainerWrapper.scroll({ @@ -58,6 +73,7 @@ export class MovePageCommand extends Command { } } + /** Redo: same as execute. */ redo() { this.execute(); } diff --git a/app/core/src/main/resources/static/js/multitool/commands/page-break.js b/app/core/src/main/resources/static/js/multitool/commands/page-break.js index 2321a5e0b8..0f910ec491 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/page-break.js +++ b/app/core/src/main/resources/static/js/multitool/commands/page-break.js @@ -1,6 +1,13 @@ -import {Command} from './command.js'; +import { CommandWithAnchors } from './command.js'; -export class PageBreakCommand extends Command { +export class PageBreakCommand extends CommandWithAnchors { + /** + * @param {HTMLElement[]} elements + * @param {boolean} isSelectedInWindow + * @param {number[]} selectedPages - 0-based indices of selected pages + * @param {Function} pageBreakCallback - async (element, addedSoFar) => HTMLElement[]|HTMLElement|null + * @param {HTMLElement} pagesContainer + */ constructor(elements, isSelectedInWindow, selectedPages, pageBreakCallback, pagesContainer) { super(); this.elements = elements; @@ -8,7 +15,17 @@ export class PageBreakCommand extends Command { this.selectedPages = selectedPages; this.pageBreakCallback = pageBreakCallback; this.pagesContainer = pagesContainer; + + /** @type {HTMLElement[]} */ this.addedElements = []; + + /** + * Anchors captured on undo to support redo reinsertion. + * @type {{ el: HTMLElement, nextSibling: ChildNode|null, index: number }[]} + */ + this._anchors = []; + + // Keep content snapshot if needed for future enhancements this.originalStates = Array.from(elements, (element) => ({ element, hasContent: element.innerHTML.trim() !== '', @@ -17,43 +34,72 @@ export class PageBreakCommand extends Command { async execute() { const undoBtn = document.getElementById('undo-btn'); - undoBtn.disabled = true; - for (const [index, element] of this.elements.entries()) { - if (!this.isSelectedInWindow || this.selectedPages.includes(index)) { - if (index !== 0) { - const newElement = await this.pageBreakCallback(element, this.addedElements); + if (undoBtn) undoBtn.disabled = true; - if (newElement) { - this.addedElements = newElement; - } + for (const [index, element] of this.elements.entries()) { + const withinSelection = !this.isSelectedInWindow || this.selectedPages.includes(index); + if (!withinSelection) continue; + + if (index !== 0) { + const result = await this.pageBreakCallback(element, this.addedElements); + if (!Array.isArray(this.addedElements)) { + this.addedElements = []; + } + + if (Array.isArray(result)) { + this.addedElements.push(...result); + } else if (result) { + this.addedElements.push(result); } } } - undoBtn.disabled = false; + + // Capture anchors right after insertion so redo does not depend on undo. + this._anchors = this.addedElements.map((el) => this.captureAnchor(el, this.pagesContainer)); + + if (undoBtn) undoBtn.disabled = false; } undo() { - this.addedElements.forEach((element) => { - const nextSibling = element.nextSibling; + this._anchors = []; - this.pagesContainer.removeChild(element); + for (const el of this.addedElements) { + this._anchors.push(this.captureAnchor(el, this.pagesContainer)); + this.pagesContainer.removeChild(el); + } - if (this.pagesContainer.childElementCount === 0) { - const filenameInput = document.getElementById('filename-input'); - const filenameParagraph = document.getElementById('filename'); - const downloadBtn = document.getElementById('export-button'); + if (this.pagesContainer.childElementCount === 0) { + const filenameInput = document.getElementById('filename-input'); + const filenameParagraph = document.getElementById('filename'); + const downloadBtn = document.getElementById('export-button'); + if (filenameInput) { filenameInput.disabled = true; filenameInput.value = ''; + } + if (filenameParagraph) { filenameParagraph.innerText = ''; + } + if (downloadBtn) { downloadBtn.disabled = true; } - - element._nextSibling = nextSibling; - }); + } } redo() { - this.execute(); + // If elements are already present (no prior undo), do nothing. + if (!this.addedElements.length) return; + const alreadyInDom = + this.addedElements[0].parentNode === this.pagesContainer; + if (alreadyInDom) return; + + // Use pre-captured anchors (from execute) or fall back to current ones. + const anchors = (this._anchors && this._anchors.length) + ? this._anchors + : this.addedElements.map((el) => this.captureAnchor(el, this.pagesContainer)); + + for (const anchor of anchors) { + this.insertWithAnchor(this.pagesContainer, anchor); + } } } diff --git a/app/core/src/main/resources/static/js/multitool/commands/remove.js b/app/core/src/main/resources/static/js/multitool/commands/remove.js index 0c2dc14e1a..e7c6bb7ca3 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/remove.js +++ b/app/core/src/main/resources/static/js/multitool/commands/remove.js @@ -1,35 +1,45 @@ import { Command } from "./command.js"; +/** + * Deletes a set of selected pages and restores them on undo. + */ export class RemoveSelectedCommand extends Command { + /** + * @param {HTMLElement} pagesContainer - Parent container. + * @param {number[]} selectedPages - 1-based page numbers to remove. + * @param {Function} updatePageNumbersAndCheckboxes - Callback to refresh UI state. + */ constructor(pagesContainer, selectedPages, updatePageNumbersAndCheckboxes) { super(); this.pagesContainer = pagesContainer; this.selectedPages = selectedPages; + /** @type {{idx:number, childNode:HTMLElement}[]} */ this.deletedChildren = []; - if (updatePageNumbersAndCheckboxes) { - this.updatePageNumbersAndCheckboxes = updatePageNumbersAndCheckboxes; - } else { + this.updatePageNumbersAndCheckboxes = updatePageNumbersAndCheckboxes || (() => { const pageDivs = document.querySelectorAll(".pdf-actions_container"); - pageDivs.forEach((div, index) => { const pageNumber = index + 1; const checkbox = div.querySelector(".pdf-actions_checkbox"); - checkbox.id = `selectPageCheckbox-${pageNumber}`; - checkbox.setAttribute("data-page-number", pageNumber); - checkbox.checked = window.selectedPages.includes(pageNumber); + if (checkbox) { + checkbox.id = `selectPageCheckbox-${pageNumber}`; + checkbox.setAttribute("data-page-number", pageNumber); + checkbox.checked = window.selectedPages.includes(pageNumber); + } }); - } + }); const filenameInput = document.getElementById("filename-input"); const filenameParagraph = document.getElementById("filename"); + /** @type {string} */ this.originalFilenameInputValue = filenameInput ? filenameInput.value : ""; - if (filenameParagraph) - this.originalFilenameParagraphText = filenameParagraph.innerText; + /** @type {string|undefined} */ + this.originalFilenameParagraphText = filenameParagraph?.innerText; } + /** Execute: remove selected pages and update empty state. */ execute() { let deletions = 0; @@ -53,10 +63,9 @@ export class RemoveSelectedCommand extends Command { const downloadBtn = document.getElementById("export-button"); if (filenameInput) filenameInput.disabled = true; - filenameInput.value = ""; + if (filenameInput) filenameInput.value = ""; if (filenameParagraph) filenameParagraph.innerText = ""; - - downloadBtn.disabled = true; + if (downloadBtn) downloadBtn.disabled = true; } window.selectedPages = []; @@ -64,12 +73,13 @@ export class RemoveSelectedCommand extends Command { document.dispatchEvent(new Event("selectedPagesUpdated")); } + /** Undo: restore all removed nodes at their original indices. */ undo() { while (this.deletedChildren.length > 0) { - let deletedChild = this.deletedChildren.pop(); - if (this.pagesContainer.children.length <= deletedChild.idx) + const deletedChild = this.deletedChildren.pop(); + if (this.pagesContainer.children.length <= deletedChild.idx) { this.pagesContainer.appendChild(deletedChild.childNode); - else { + } else { this.pagesContainer.insertBefore( deletedChild.childNode, this.pagesContainer.children[deletedChild.idx] @@ -83,11 +93,11 @@ export class RemoveSelectedCommand extends Command { const downloadBtn = document.getElementById("export-button"); if (filenameInput) filenameInput.disabled = false; - filenameInput.value = this.originalFilenameInputValue; - if (filenameParagraph) + if (filenameInput) filenameInput.value = this.originalFilenameInputValue; + if (filenameParagraph && this.originalFilenameParagraphText !== undefined) { filenameParagraph.innerText = this.originalFilenameParagraphText; - - downloadBtn.disabled = false; + } + if (downloadBtn) downloadBtn.disabled = false; } window.selectedPages = this.selectedPages; @@ -95,6 +105,7 @@ export class RemoveSelectedCommand extends Command { document.dispatchEvent(new Event("selectedPagesUpdated")); } + /** Redo mirrors execute. */ redo() { this.execute(); } diff --git a/app/core/src/main/resources/static/js/multitool/commands/rotate.js b/app/core/src/main/resources/static/js/multitool/commands/rotate.js index 6fb08cb941..e3236fe818 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/rotate.js +++ b/app/core/src/main/resources/static/js/multitool/commands/rotate.js @@ -1,53 +1,61 @@ import { Command } from "./command.js"; +/** + * Rotates a single image element by a relative degree. + */ export class RotateElementCommand extends Command { + /** + * @param {HTMLElement} element - The element to rotate. + * @param {number|string} degree - Relative degrees to add (e.g., 90 or "-90"). + */ constructor(element, degree) { super(); this.element = element; this.degree = degree; } + /** Execute: apply rotation. */ execute() { - let lastTransform = this.element.style.rotate; - if (!lastTransform) { - lastTransform = "0"; - } + let lastTransform = this.element.style.rotate || "0"; const lastAngle = parseInt(lastTransform.replace(/[^\d-]/g, "")); const newAngle = lastAngle + parseInt(this.degree); this.element.style.rotate = newAngle + "deg"; } + /** Undo: revert by subtracting the same delta. */ undo() { - let lastTransform = this.element.style.rotate; - if (!lastTransform) { - lastTransform = "0"; - } - + let lastTransform = this.element.style.rotate || "0"; const currentAngle = parseInt(lastTransform.replace(/[^\d-]/g, "")); const undoAngle = currentAngle + -parseInt(this.degree); this.element.style.rotate = undoAngle + "deg"; } + /** Redo mirrors execute. */ redo() { this.execute(); } } +/** + * Rotates a set of image elements by a relative degree. + */ export class RotateAllCommand extends Command { + /** + * @param {HTMLElement[]} elements - Image elements to rotate. + * @param {number} degree - Relative degrees to add for all. + */ constructor(elements, degree) { super(); this.elements = elements; this.degree = degree; } + /** Execute: apply rotation to all. */ execute() { - for (let element of this.elements) { - let lastTransform = element.style.rotate; - if (!lastTransform) { - lastTransform = "0"; - } + for (const element of this.elements) { + let lastTransform = element.style.rotate || "0"; const lastAngle = parseInt(lastTransform.replace(/[^\d-]/g, "")); const newAngle = lastAngle + this.degree; @@ -55,12 +63,10 @@ export class RotateAllCommand extends Command { } } + /** Undo: revert rotation for all. */ undo() { - for (let element of this.elements) { - let lastTransform = element.style.rotate; - if (!lastTransform) { - lastTransform = "0"; - } + for (const element of this.elements) { + let lastTransform = element.style.rotate || "0"; const currentAngle = parseInt(lastTransform.replace(/[^\d-]/g, "")); const undoAngle = currentAngle + -this.degree; @@ -68,6 +74,7 @@ export class RotateAllCommand extends Command { } } + /** Redo mirrors execute. */ redo() { this.execute(); } diff --git a/app/core/src/main/resources/static/js/multitool/commands/select.js b/app/core/src/main/resources/static/js/multitool/commands/select.js index b76a25ca14..61199cba1b 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/select.js +++ b/app/core/src/main/resources/static/js/multitool/commands/select.js @@ -1,57 +1,45 @@ import { Command } from "./command.js"; +/** + * Toggles selection state of a single page via its checkbox. + */ export class SelectPageCommand extends Command { + /** + * @param {number} pageNumber - 1-based page number. + * @param {HTMLInputElement} checkbox - Checkbox linked to the page. + */ constructor(pageNumber, checkbox) { super(); this.pageNumber = pageNumber; this.selectCheckbox = checkbox; } + /** Execute: apply current checkbox state to global selection. */ execute() { if (this.selectCheckbox.checked) { - //adds to array of selected pages window.selectedPages.push(this.pageNumber); } else { - //remove page from selected pages array const index = window.selectedPages.indexOf(this.pageNumber); - if (index !== -1) { - window.selectedPages.splice(index, 1); - } + if (index !== -1) window.selectedPages.splice(index, 1); } if (window.selectedPages.length > 0 && !window.selectPage) { window.toggleSelectPageVisibility(); } - if (window.selectedPages.length == 0 && window.selectPage) { + if (window.selectedPages.length === 0 && window.selectPage) { window.toggleSelectPageVisibility(); } window.updateSelectedPagesDisplay(); } + /** Undo: invert checkbox and apply same logic as execute. */ undo() { this.selectCheckbox.checked = !this.selectCheckbox.checked; - if (this.selectCheckbox.checked) { - //adds to array of selected pages - window.selectedPages.push(this.pageNumber); - } else { - //remove page from selected pages array - const index = window.selectedPages.indexOf(this.pageNumber); - if (index !== -1) { - window.selectedPages.splice(index, 1); - } - } - - if (window.selectedPages.length > 0 && !window.selectPage) { - window.toggleSelectPageVisibility(); - } - if (window.selectedPages.length == 0 && window.selectPage) { - window.toggleSelectPageVisibility(); - } - - window.updateSelectedPagesDisplay(); + this.execute(); } + /** Redo: invert again then execute. */ redo() { this.selectCheckbox.checked = !this.selectCheckbox.checked; this.execute(); diff --git a/app/core/src/main/resources/static/js/multitool/commands/split.js b/app/core/src/main/resources/static/js/multitool/commands/split.js index 3cbc32cdec..a4fad6ffbe 100644 --- a/app/core/src/main/resources/static/js/multitool/commands/split.js +++ b/app/core/src/main/resources/static/js/multitool/commands/split.js @@ -1,26 +1,45 @@ import { Command } from "./command.js"; +/** + * Toggles a split class on a single page element. + */ export class SplitFileCommand extends Command { + /** + * @param {HTMLElement} element - Target page container. + * @param {string} splitClass - CSS class to toggle for split markers. + */ constructor(element, splitClass) { super(); this.element = element; this.splitClass = splitClass; } + /** Execute: toggle split class. */ execute() { this.element.classList.toggle(this.splitClass); } + /** Undo: toggle split class back. */ undo() { this.element.classList.toggle(this.splitClass); } + /** Redo: same as execute. */ redo() { this.execute(); } } +/** + * Toggles split class across a set of elements, optionally limited by selection. + */ export class SplitAllCommand extends Command { + /** + * @param {NodeListOf|HTMLElement[]} elements - All page containers. + * @param {boolean} isSelectedInWindow - Whether multi-select mode is active. + * @param {number[]} selectedPages - 0-based indices of selected pages (when active). + * @param {string} splitClass - CSS class used as split marker. + */ constructor(elements, isSelectedInWindow, selectedPages, splitClass) { super(); this.elements = elements; @@ -29,72 +48,41 @@ export class SplitAllCommand extends Command { this.splitClass = splitClass; } + /** Execute: toggle split for all or selected pages. */ execute() { if (!this.isSelectedInWindow) { - const hasSplit = this._hasSplit(this.elements, this.splitClass); - if (hasSplit) { - this.elements.forEach((page) => { + const hasSplit = this._hasSplit(); + (this.elements || []).forEach((page) => { + if (hasSplit) { page.classList.remove(this.splitClass); - }); - } else { - this.elements.forEach((page) => { + } else { page.classList.add(this.splitClass); - }); - } + } + }); return; } this.elements.forEach((page, index) => { - const pageIndex = index; - if (this.isSelectedInWindow && !this.selectedPages.includes(pageIndex)) - return; - - if (page.classList.contains(this.splitClass)) { - page.classList.remove(this.splitClass); - } else { - page.classList.add(this.splitClass); - } + if (!this.selectedPages.includes(index)) return; + page.classList.toggle(this.splitClass); }); } + /** @returns {boolean} true if any element currently has the split class. */ _hasSplit() { - if (!this.elements || this.elements.length == 0) return false; - + if (!this.elements || this.elements.length === 0) return false; for (const node of this.elements) { if (node.classList.contains(this.splitClass)) return true; } - return false; } + /** Undo mirrors execute logic. */ undo() { - if (!this.isSelectedInWindow) { - const hasSplit = this._hasSplit(this.elements, this.splitClass); - if (hasSplit) { - this.elements.forEach((page) => { - page.classList.remove(this.splitClass); - }); - } else { - this.elements.forEach((page) => { - page.classList.add(this.splitClass); - }); - } - return; - } - - this.elements.forEach((page, index) => { - const pageIndex = index; - if (this.isSelectedInWindow && !this.selectedPages.includes(pageIndex)) - return; - - if (page.classList.contains(this.splitClass)) { - page.classList.remove(this.splitClass); - } else { - page.classList.add(this.splitClass); - } - }); + this.execute(); } + /** Redo mirrors execute logic. */ redo() { this.execute(); } diff --git a/app/core/src/main/resources/static/js/navbar.js b/app/core/src/main/resources/static/js/navbar.js index be9d2df122..4f1c8a5f78 100644 --- a/app/core/src/main/resources/static/js/navbar.js +++ b/app/core/src/main/resources/static/js/navbar.js @@ -110,7 +110,7 @@ function tooltipSetup() { element.addEventListener("mousemove", (event) => updateTooltipPosition(event, tooltipText)); element.addEventListener("mouseleave", hideTooltip); - // in case UI moves and mouseleave is not triggered, tooltip is readded when mouse is moved over the element + // in case UI moves and mouseleave is not triggered, the tooltip is re-added when the mouse is moved over the element element.addEventListener("click", hideTooltip); }); }; diff --git a/app/core/src/main/resources/static/js/pages/add-image.js b/app/core/src/main/resources/static/js/pages/add-image.js index 2bafd86ecc..6a40145b7f 100644 --- a/app/core/src/main/resources/static/js/pages/add-image.js +++ b/app/core/src/main/resources/static/js/pages/add-image.js @@ -1,3 +1,9 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + window.goToFirstOrLastPage = goToFirstOrLastPage; document.getElementById('download-pdf').addEventListener('click', async () => { @@ -31,8 +37,11 @@ document.querySelector('input[name=pdf-upload]').addEventListener('change', asyn const file = allFiles[0]; originalFileName = file.name.replace(/\.[^/.]+$/, ''); const pdfData = await file.arrayBuffer(); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - const pdfDoc = await pdfjsLib.getDocument({ data: pdfData }).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + const pdfDoc = await pdfjsLib.getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: pdfData, + }).promise; await DraggableUtils.renderPage(pdfDoc, 0); document.querySelectorAll('.show-on-file-selected').forEach((el) => { diff --git a/app/core/src/main/resources/static/js/pages/adjust-contrast.js b/app/core/src/main/resources/static/js/pages/adjust-contrast.js index a9692d2bc4..506af1f8e6 100644 --- a/app/core/src/main/resources/static/js/pages/adjust-contrast.js +++ b/app/core/src/main/resources/static/js/pages/adjust-contrast.js @@ -1,3 +1,9 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + var canvas = document.getElementById('contrast-pdf-canvas'); var context = canvas.getContext('2d'); var originalImageData = null; @@ -9,8 +15,11 @@ async function renderPDFAndSaveOriginalImageData(file) { var fileReader = new FileReader(); fileReader.onload = async function () { var data = new Uint8Array(this.result); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - pdf = await pdfjsLib.getDocument({data: data}).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + pdf = await pdfjsLib.getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: data, + }).promise; // Get the number of pages in the PDF var numPages = pdf.numPages; diff --git a/app/core/src/main/resources/static/js/pages/change-metadata.js b/app/core/src/main/resources/static/js/pages/change-metadata.js index bdc5426b71..25d8565a06 100644 --- a/app/core/src/main/resources/static/js/pages/change-metadata.js +++ b/app/core/src/main/resources/static/js/pages/change-metadata.js @@ -1,3 +1,9 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + const deleteAllCheckbox = document.querySelector('#deleteAll'); let inputs = document.querySelectorAll('input'); const customMetadataDiv = document.getElementById('customMetadata'); @@ -43,8 +49,13 @@ fileInput.addEventListener('change', async function () { customMetadataFormContainer.removeChild(customMetadataFormContainer.firstChild); } var url = URL.createObjectURL(file); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - const pdf = await pdfjsLib.getDocument(url).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + const pdf = await pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + url: url, + }) + .promise; const pdfMetadata = await pdf.getMetadata(); lastPDFFile = pdfMetadata?.info; console.log(pdfMetadata); diff --git a/app/core/src/main/resources/static/js/pages/crop.js b/app/core/src/main/resources/static/js/pages/crop.js index 1854023a07..f6af3e5e23 100644 --- a/app/core/src/main/resources/static/js/pages/crop.js +++ b/app/core/src/main/resources/static/js/pages/crop.js @@ -1,8 +1,13 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + let pdfCanvas = document.getElementById('cropPdfCanvas'); let overlayCanvas = document.getElementById('overlayCanvas'); let canvasesContainer = document.getElementById('canvasesContainer'); canvasesContainer.style.display = 'none'; -let containerRect = canvasesContainer.getBoundingClientRect(); let context = pdfCanvas.getContext('2d'); let overlayContext = overlayCanvas.getContext('2d'); @@ -30,18 +35,30 @@ let rectHeight = 0; let pageScale = 1; // The scale which the pdf page renders let timeId = null; // timeout id for resizing canvases event +let currentRenderTask = null; // Track current PDF render task to cancel if needed function renderPageFromFile(file) { if (file.type === 'application/pdf') { + // Cancel any ongoing render task when loading a new file + if (currentRenderTask) { + currentRenderTask.cancel(); + currentRenderTask = null; + } + let reader = new FileReader(); reader.onload = function (ev) { let typedArray = new Uint8Array(reader.result); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - pdfjsLib.getDocument(typedArray).promise.then(function (pdf) { - pdfDoc = pdf; - totalPages = pdf.numPages; - renderPage(currentPage); - }); + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: typedArray, + }) + .promise.then(function (pdf) { + pdfDoc = pdf; + totalPages = pdf.numPages; + renderPage(currentPage); + }); }; reader.readAsArrayBuffer(file); } @@ -51,7 +68,7 @@ window.addEventListener('resize', function () { clearTimeout(timeId); timeId = setTimeout(function () { - if (fileInput.files.length == 0) return; + if (!pdfDoc) return; // Only resize if we have a PDF loaded let canvasesContainer = document.getElementById('canvasesContainer'); let containerRect = canvasesContainer.getBoundingClientRect(); @@ -59,35 +76,33 @@ window.addEventListener('resize', function () { overlayContext.clearRect(0, 0, overlayCanvas.width, overlayCanvas.height); - pdfCanvas.width = containerRect.width; - pdfCanvas.height = containerRect.height; - - overlayCanvas.width = containerRect.width; - overlayCanvas.height = containerRect.height; - - let file = fileInput.files[0]; - renderPageFromFile(file); + // Re-render with new container size + renderPage(currentPage); }, 1000); }); -fileInput.addEventListener('change', function (e) { - fileInput.addEventListener('file-input-change', async (e) => { - const {allFiles} = e.detail; - if (allFiles && allFiles.length > 0) { - canvasesContainer.style.display = 'block'; // set for visual purposes +fileInput.addEventListener('file-input-change', async (e) => { + if (!e.detail) return; // Guard against null detail + const {allFiles} = e.detail; + if (allFiles && allFiles.length > 0) { + canvasesContainer.style.display = 'block'; // set for visual purposes + + // Wait for the layout to be updated before rendering + setTimeout(() => { let file = allFiles[0]; renderPageFromFile(file); - } - }); + }, 100); + } }); cropForm.addEventListener('submit', function (e) { if (xInput.value == '' && yInput.value == '' && widthInput.value == '' && heightInput.value == '') { - // Ορίστε συντεταγμένες για ολόκληρη την επιφάνεια του PDF + // Set coordinates for the entire PDF surface + let currentContainerRect = canvasesContainer.getBoundingClientRect(); xInput.value = 0; yInput.value = 0; - widthInput.value = containerRect.width; - heightInput.value = containerRect.height; + widthInput.value = currentContainerRect.width; + heightInput.value = currentContainerRect.height; } }); @@ -135,16 +150,24 @@ overlayCanvas.addEventListener('mouseup', function (e) { }); function renderPage(pageNumber) { + // Cancel any ongoing render task + if (currentRenderTask) { + currentRenderTask.cancel(); + currentRenderTask = null; + } + pdfDoc.getPage(pageNumber).then(function (page) { let canvasesContainer = document.getElementById('canvasesContainer'); let containerRect = canvasesContainer.getBoundingClientRect(); pageScale = containerRect.width / page.getViewport({scale: 1}).width; // The new scale - let viewport = page.getViewport({scale: containerRect.width / page.getViewport({scale: 1}).width}); + // Normalize rotation to 0, 90, 180, or 270 degrees + let normalizedRotation = ((page.rotate % 360) + 360) % 360; + let viewport = page.getViewport({scale: pageScale, rotation: normalizedRotation}); - canvasesContainer.width = viewport.width; - canvasesContainer.height = viewport.height; + // Don't set container width, let CSS handle it + canvasesContainer.style.height = viewport.height + 'px'; pdfCanvas.width = viewport.width; pdfCanvas.height = viewport.height; @@ -152,8 +175,21 @@ function renderPage(pageNumber) { overlayCanvas.width = viewport.width; // Match overlay canvas size with PDF canvas overlayCanvas.height = viewport.height; + context.clearRect(0, 0, pdfCanvas.width, pdfCanvas.height); + + context.fillStyle = 'white'; + context.fillRect(0, 0, pdfCanvas.width, pdfCanvas.height); + let renderContext = {canvasContext: context, viewport: viewport}; - page.render(renderContext); - pdfCanvas.classList.add('shadow-canvas'); + currentRenderTask = page.render(renderContext); + currentRenderTask.promise.then(function() { + currentRenderTask = null; + pdfCanvas.classList.add('shadow-canvas'); + }).catch(function(error) { + if (error.name !== 'RenderingCancelledException') { + console.error('PDF rendering error:', error); + } + currentRenderTask = null; + }); }); } diff --git a/app/core/src/main/resources/static/js/pages/pdf-to-csv.js b/app/core/src/main/resources/static/js/pages/pdf-to-csv.js index 9a06aac5b4..1c3cc01248 100644 --- a/app/core/src/main/resources/static/js/pages/pdf-to-csv.js +++ b/app/core/src/main/resources/static/js/pages/pdf-to-csv.js @@ -1,3 +1,9 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + let pdfCanvas = document.getElementById('cropPdfCanvas'); let overlayCanvas = document.getElementById('overlayCanvas'); let canvasesContainer = document.getElementById('canvasesContainer'); @@ -37,12 +43,17 @@ btn1Object.addEventListener('click', function (e) { let reader = new FileReader(); reader.onload = function (ev) { let typedArray = new Uint8Array(reader.result); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - pdfjsLib.getDocument(typedArray).promise.then(function (pdf) { - pdfDoc = pdf; - totalPages = pdf.numPages; - renderPage(currentPage); - }); + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: typedArray, + }) + .promise.then(function (pdf) { + pdfDoc = pdf; + totalPages = pdf.numPages; + renderPage(currentPage); + }); }; reader.readAsArrayBuffer(file); } @@ -58,12 +69,17 @@ btn2Object.addEventListener('click', function (e) { let reader = new FileReader(); reader.onload = function (ev) { let typedArray = new Uint8Array(reader.result); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - pdfjsLib.getDocument(typedArray).promise.then(function (pdf) { - pdfDoc = pdf; - totalPages = pdf.numPages; - renderPage(currentPage); - }); + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: typedArray, + }) + .promise.then(function (pdf) { + pdfDoc = pdf; + totalPages = pdf.numPages; + renderPage(currentPage); + }); }; reader.readAsArrayBuffer(file); } @@ -75,12 +91,17 @@ function renderPageFromFile(file) { let reader = new FileReader(); reader.onload = function (ev) { let typedArray = new Uint8Array(reader.result); - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - pdfjsLib.getDocument(typedArray).promise.then(function (pdf) { - pdfDoc = pdf; - totalPages = pdf.numPages; - renderPage(currentPage); - }); + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + pdfjsLib + .getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: typedArray, + }) + .promise.then(function (pdf) { + pdfDoc = pdf; + totalPages = pdf.numPages; + renderPage(currentPage); + }); pageNumbers.value = currentPage; }; reader.readAsArrayBuffer(file); diff --git a/app/core/src/main/resources/static/js/pages/sign.js b/app/core/src/main/resources/static/js/pages/sign.js index ec02e75b36..48a15c7807 100644 --- a/app/core/src/main/resources/static/js/pages/sign.js +++ b/app/core/src/main/resources/static/js/pages/sign.js @@ -1,3 +1,9 @@ +const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', +}; + window.toggleSignatureView = toggleSignatureView; window.previewSignature = previewSignature; window.addSignatureFromPreview = addSignatureFromPreview; @@ -70,9 +76,11 @@ document const file = allFiles[0]; originalFileName = file.name.replace(/\.[^/.]+$/, ""); const pdfData = await file.arrayBuffer(); - pdfjsLib.GlobalWorkerOptions.workerSrc = - "./pdfjs-legacy/pdf.worker.mjs"; - const pdfDoc = await pdfjsLib.getDocument({ data: pdfData }).promise; + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; + const pdfDoc = await pdfjsLib.getDocument({ + ...PDFJS_DEFAULT_OPTIONS, + data: pdfData, + }).promise; await DraggableUtils.renderPage(pdfDoc, 0); document.querySelectorAll(".show-on-file-selected").forEach((el) => { diff --git a/app/core/src/main/resources/static/js/thirdParty/cookieconsent-config.js b/app/core/src/main/resources/static/js/thirdParty/cookieconsent-config.js index 7199184847..d13cb7d145 100644 --- a/app/core/src/main/resources/static/js/thirdParty/cookieconsent-config.js +++ b/app/core/src/main/resources/static/js/thirdParty/cookieconsent-config.js @@ -3,6 +3,19 @@ import './cookieconsent.umd.js'; // Enable dark mode document.documentElement.classList.add('cc--darkmode'); +// Build analytics services dynamically based on backend config +const analyticsServices = {}; +if (typeof posthogEnabled !== 'undefined' && posthogEnabled) { + analyticsServices.posthog = { + label: cookieBannerPreferencesModalPosthogLabel + }; +} +if (typeof scarfEnabled !== 'undefined' && scarfEnabled) { + analyticsServices.scarf = { + label: cookieBannerPreferencesModalScarfLabel + }; +} + CookieConsent.run({ guiOptions: { consentModal: { @@ -22,7 +35,9 @@ CookieConsent.run({ necessary: { readOnly: true }, - analytics: {} + analytics: { + services: analyticsServices + } }, language: { default: "en", diff --git a/app/core/src/main/resources/templates/convert/ebook-to-pdf.html b/app/core/src/main/resources/templates/convert/ebook-to-pdf.html new file mode 100644 index 0000000000..047e5c02d5 --- /dev/null +++ b/app/core/src/main/resources/templates/convert/ebook-to-pdf.html @@ -0,0 +1,82 @@ + + + + + + + + + +
+
+ +

+
+
+
+
+ menu_book + +
+

+ +
+ Calibre support is disabled. +
+ +
+
+
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ + +
+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/app/core/src/main/resources/templates/convert/pdf-to-epub.html b/app/core/src/main/resources/templates/convert/pdf-to-epub.html new file mode 100644 index 0000000000..b565939562 --- /dev/null +++ b/app/core/src/main/resources/templates/convert/pdf-to-epub.html @@ -0,0 +1,87 @@ + + + + + + + + + +
+
+ +

+
+
+
+
+ menu_book + +
+

+ +
+ Calibre support is disabled. +
+ +
+
+
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ + +
+
+
+
+
+ +
+ + + diff --git a/app/core/src/main/resources/templates/convert/pdf-to-pdfa.html b/app/core/src/main/resources/templates/convert/pdf-to-pdfa.html index 33c07acb9d..6035e7561d 100644 --- a/app/core/src/main/resources/templates/convert/pdf-to-pdfa.html +++ b/app/core/src/main/resources/templates/convert/pdf-to-pdfa.html @@ -23,8 +23,16 @@
@@ -33,7 +41,7 @@ + + + + +
+
+ +

+
+
+
+
+ movie + +
+

+
+
+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+ +
+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/app/core/src/main/resources/templates/convert/vector-to-pdf.html b/app/core/src/main/resources/templates/convert/vector-to-pdf.html new file mode 100644 index 0000000000..d7c112fa92 --- /dev/null +++ b/app/core/src/main/resources/templates/convert/vector-to-pdf.html @@ -0,0 +1,41 @@ + + + + + + + + + +
+
+ +

+
+
+
+
+ picture_as_pdf + +
+
+
+
+
+ + +
+ +
+

+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/app/core/src/main/resources/templates/crop.html b/app/core/src/main/resources/templates/crop.html index e91c481c33..6487b296d5 100644 --- a/app/core/src/main/resources/templates/crop.html +++ b/app/core/src/main/resources/templates/crop.html @@ -23,6 +23,12 @@ +
+ + + +
+
diff --git a/app/core/src/main/resources/templates/fragments/common.html b/app/core/src/main/resources/templates/fragments/common.html index eace509fc1..ffb3e01de4 100644 --- a/app/core/src/main/resources/templates/fragments/common.html +++ b/app/core/src/main/resources/templates/fragments/common.html @@ -168,14 +168,51 @@ - - + + @@ -221,7 +258,7 @@ return; } - window.CookieConsent.acceptedCategory('analytics')? + window.CookieConsent.acceptedService('posthog', 'analytics')? posthog.opt_in_capturing() : posthog.opt_out_capturing(); } const stirlingPDFLabel = /*[[${@StirlingPDFLabel}]]*/ ''; @@ -248,6 +285,8 @@ const cookieBannerPreferencesModalNecessaryDescription = /*[[#{cookieBanner.preferencesModal.necessary.description}]]*/ ""; const cookieBannerPreferencesModalAnalyticsTitle = /*[[#{cookieBanner.preferencesModal.analytics.title}]]*/ ""; const cookieBannerPreferencesModalAnalyticsDescription = /*[[#{cookieBanner.preferencesModal.analytics.description}]]*/ ""; + const cookieBannerPreferencesModalPosthogLabel = /*[[#{cookieBanner.preferencesModal.analytics.posthog.label}]]*/ ""; + const cookieBannerPreferencesModalScarfLabel = /*[[#{cookieBanner.preferencesModal.analytics.scarf.label}]]*/ ""; if (analyticsEnabled) { !function (t, e) { @@ -380,6 +419,20 @@ window.stirlingPDF.uploadLimitExceededPlural = /*[[#{uploadLimitExceededPlural}]]*/ 'are too large. Maximum allowed size is'; window.stirlingPDF.pdfCorruptedMessage = /*[[#{error.pdfInvalid}]]*/ 'The PDF file "{0}" appears to be corrupted or has an invalid structure. Please try using the \'Repair PDF\' feature to fix the file before proceeding.'; window.stirlingPDF.tryRepairMessage = /*[[#{error.tryRepair}]]*/ 'Try using the Repair PDF feature to fix corrupted files.'; + window.stirlingPDF.pdfCorruptedTitle = /*[[#{error.pdfCorrupted.title}]]*/ 'PDF File Corrupted'; + window.stirlingPDF.pdfCorruptedHint1 = /*[[#{error.E001.hint.1}]]*/ 'Try the \'Repair PDF\' feature, then retry this operation.'; + window.stirlingPDF.pdfCorruptedHint2 = /*[[#{error.E001.hint.2}]]*/ 'Re-export the PDF from the original application if possible.'; + window.stirlingPDF.pdfCorruptedHint3 = /*[[#{error.E001.hint.3}]]*/ 'Avoid transferring the file through tools that modify PDFs (e.g., fax/email converters).'; + window.stirlingPDF.pdfCorruptedAction = /*[[#{error.E001.action}]]*/ 'Repair the PDF and retry the operation.'; + window.stirlingPDF.pdfPasswordTitle = /*[[#{error.pdfPassword.title}]]*/ 'PDF Password Required'; + window.stirlingPDF.pdfPasswordDetail = /*[[#{error.pdfPassword}]]*/ 'The PDF Document is passworded and either the password was not provided or was incorrect'; + window.stirlingPDF.pdfPasswordHint1 = /*[[#{error.E004.hint.1}]]*/ 'PDFs can have two passwords: a user password (opens the document) and an owner password (controls permissions). This operation requires the owner password.'; + window.stirlingPDF.pdfPasswordHint2 = /*[[#{error.E004.hint.2}]]*/ 'If you can open the PDF without a password, it may only have an owner password set. Try submitting the permissions password.'; + window.stirlingPDF.pdfPasswordHint3 = /*[[#{error.E004.hint.3}]]*/ 'Digitally signed PDFs cannot have security removed until the signature is removed.'; + window.stirlingPDF.pdfPasswordHint4 = /*[[#{error.E004.hint.4}]]*/ 'Passwords are case-sensitive. Verify capitalisation, spaces, and special characters.'; + window.stirlingPDF.pdfPasswordHint5 = /*[[#{error.E004.hint.5}]]*/ 'Some creators use different encryption standards (40-bit, 128-bit, 256-bit AES). Ensure your password matches the encryption used.'; + window.stirlingPDF.pdfPasswordHint6 = /*[[#{error.E004.hint.6}]]*/ 'If you only have the user password, you cannot remove security restrictions. Contact the document owner for the permissions password.'; + window.stirlingPDF.pdfPasswordAction = /*[[#{error.E004.action}]]*/ 'Provide the owner/permissions password, not just the document open password.'; window.stirlingPDF.currentPage = /*[[${currentPage}]]*/ ''; })(); diff --git a/app/core/src/main/resources/templates/fragments/errorBanner.html b/app/core/src/main/resources/templates/fragments/errorBanner.html index d682dcb922..bb65a94282 100644 --- a/app/core/src/main/resources/templates/fragments/errorBanner.html +++ b/app/core/src/main/resources/templates/fragments/errorBanner.html @@ -3,7 +3,7 @@
@@ -83,6 +89,9 @@
+
+
@@ -107,6 +116,12 @@
+
+
+
+
@@ -123,6 +138,9 @@
+
+
@@ -135,6 +153,9 @@
+
+
@@ -145,6 +166,9 @@
+
+
@@ -163,6 +187,12 @@
+
+
+
+
@@ -258,6 +288,9 @@
+
+
diff --git a/app/core/src/main/resources/templates/fragments/navbar.html b/app/core/src/main/resources/templates/fragments/navbar.html index 2b84fe97ec..2278ed79e9 100644 --- a/app/core/src/main/resources/templates/fragments/navbar.html +++ b/app/core/src/main/resources/templates/fragments/navbar.html @@ -49,6 +49,9 @@ const updateBreakingChanges = /*[[#{update.breakingChanges}]]*/ 'Breaking Changes:'; const updateBreakingChangesDefault = /*[[#{update.breakingChangesDefault}]]*/ 'This version contains breaking changes'; const updateMigrationGuide = /*[[#{update.migrationGuide}]]*/ 'Migration Guide'; + + // PDF.js path + const pdfjsPath = /*[[@{'/pdfjs-legacy/'}]]*/ './pdfjs-legacy/'; diff --git a/app/core/src/main/resources/templates/home-legacy.html b/app/core/src/main/resources/templates/home-legacy.html index 3c01bcbd60..33441fe959 100644 --- a/app/core/src/main/resources/templates/home-legacy.html +++ b/app/core/src/main/resources/templates/home-legacy.html @@ -195,6 +195,9 @@
+
+
@@ -293,6 +296,9 @@
+
+
diff --git a/app/core/src/main/resources/templates/merge-pdfs.html b/app/core/src/main/resources/templates/merge-pdfs.html index 794eac8056..8878c3c257 100644 --- a/app/core/src/main/resources/templates/merge-pdfs.html +++ b/app/core/src/main/resources/templates/merge-pdfs.html @@ -58,7 +58,7 @@ diff --git a/app/core/src/main/resources/templates/misc/compare.html b/app/core/src/main/resources/templates/misc/compare.html index 27a7ed9edc..f7bab9589a 100644 --- a/app/core/src/main/resources/templates/misc/compare.html +++ b/app/core/src/main/resources/templates/misc/compare.html @@ -79,7 +79,7 @@ - +
@@ -105,7 +105,8 @@ result2.addEventListener('scroll', function () { result1.scrollTop = result2.scrollTop; }); - async function comparePDFs() { + + async function comparePDFs(event) { const file1 = document.getElementById("fileInput-input").files[0]; const file2 = document.getElementById("fileInput2-input").files[0]; var color1 = document.getElementById('color-box1').value; @@ -113,137 +114,216 @@ const complexMessage = /*[[#{compare.complex.message}]]*/ 'One or both of the provided documents are large files, accuracy of comparison may be reduced'; const largeFilesMessage = /*[[#{compare.large.file.message}]]*/ 'One or Both of the provided documents are too large to process'; - const noTextMessage = /*[[#{compare.no.text.message}]]*/ 'One or both of the selected PDFs have no text content. Please choose PDFs with text for comparison."'; + const noTextMessage = /*[[#{compare.no.text.message}]]*/ 'One or both of the selected PDFs have no text content. Please choose PDFs with text for comparison.'; + const invalidPdfMessage = /*[[#{compare.invalid.pdf.message}]]*/ 'One or both files are not valid PDFs. Please check and re-upload.'; + const submitText = /*[[#{compare.submit}]]*/ 'Compare'; if (!file1 || !file2) { - console.error("Please select two PDF files to compare"); + alert('Please select two PDF files to compare'); return; } - pdfjsLib.GlobalWorkerOptions.workerSrc = './pdfjs-legacy/pdf.worker.mjs'; - - const [pdf1, pdf2] = await Promise.all([ - pdfjsLib.getDocument(URL.createObjectURL(file1)).promise, - pdfjsLib.getDocument(URL.createObjectURL(file2)).promise - ]); - - const extractText = async (pdf) => { - const pages = []; - for (let i = 1; i <= pdf.numPages; i++) { - const page = await pdf.getPage(i); - const content = await page.getTextContent(); - const strings = content.items.map(item => item.str); - pages.push(strings.join(" ")); - } - return pages.join(" "); - }; - - const [text1, text2] = await Promise.all([ - extractText(pdf1), - extractText(pdf2) - ]); - - if (text1.trim() === "" || text2.trim() === "") { - alert(noTextMessage); + // Basic checks + if (file1.size === 0 || file2.size === 0) { + alert('One or both files are empty.'); + return; + } + if (file1.size > 100 * 1024 * 1024 || file2.size > 100 * 1024 * 1024) { + alert(largeFilesMessage); return; } - const resultDiv1 = document.getElementById("result1"); - const resultDiv2 = document.getElementById("result2"); - const loading = /*[[#{loading}]]*/ 'Loading...'; - - resultDiv1.innerHTML = loading; - resultDiv2.innerHTML = loading; - - // Create a new Worker - const worker = new Worker('./js/compare/pdfWorker.js'); - - - // Post messages to the worker - worker.postMessage({ - type: 'SET_COMPLEX_MESSAGE', - message: complexMessage - }); - - worker.postMessage({ - type: 'SET_TOO_LARGE_MESSAGE', - message: largeFilesMessage - }); - - // Error handling for the worker - worker.onerror = function (error) { - console.error('Worker error:', error); + // PDF.js setup (Legacy-safe: Worker disabled) + const PDFJS_DEFAULT_OPTIONS = { + cMapUrl: pdfjsPath + 'cmaps/', + cMapPacked: true, + standardFontDataUrl: pdfjsPath + 'standard_fonts/', + disableWorker: true // Avoids Legacy CMap errors without changing PDF.js }; - worker.onmessage = function (e) { - const { status, differences, message } = e.data; - if (status === 'error') { + pdfjsLib.GlobalWorkerOptions.workerSrc = pdfjsPath + 'pdf.worker.mjs'; - resultDiv1.innerHTML = ''; - resultDiv2.innerHTML = ''; - alert(message); - return; + const button = event.target; + button.disabled = true; + button.textContent = 'Processing...'; + + try { + // Load ArrayBuffer + const [data1, data2] = await Promise.all([ + readFileAsArrayBuffer(file1), + readFileAsArrayBuffer(file2) + ]); + + // Header validation (prevents InvalidPDFException) + await validatePdfHeader(data1, 'File 1'); + await validatePdfHeader(data2, 'File 2'); + + // Load PDFs + const [pdf1, pdf2] = await Promise.all([ + loadPdfWithErrorHandling({ ...PDFJS_DEFAULT_OPTIONS, data: data1 }, 'File 1'), + loadPdfWithErrorHandling({ ...PDFJS_DEFAULT_OPTIONS, data: data2 }, 'File 2') + ]); + + // Extract text + result1.innerHTML = 'Extracting text from File 1...'; + result2.innerHTML = 'Extracting text from File 2...'; + const [text1, text2] = await Promise.all([ + extractText(pdf1, 'File 1', result1), + extractText(pdf2, 'File 2', result2) + ]); + + if (text1.trim() === "" || text2.trim() === "") { + throw new Error(noTextMessage); } - if (status === 'success' && differences) { - console.log('Differences:', differences); - displayDifferences(differences); - } - if (event.data.status === 'warning') { - console.warn(event.data.message); - alert(event.data.message); - } - }; - worker.postMessage({ text1, text2, color1, color2 }); + // Worker diff + await processWithWorker(text1, text2, color1, color2, complexMessage, largeFilesMessage); - const displayDifferences = (differences) => { - const resultDiv1 = document.getElementById("result1"); - const resultDiv2 = document.getElementById("result2"); - resultDiv1.innerHTML = ""; - resultDiv2.innerHTML = ""; - - differences.forEach(([color, word]) => { - const span1 = document.createElement("span"); - const span2 = document.createElement("span"); - - if (color === color2) { - span1.style.color = "transparent"; - span1.style.userSelect = "none"; - span2.style.color = color; - } - // If it's a deletion, show it in in the first document and transparent in the second - else if (color === color1) { - span1.style.color = color; - span2.style.color = "transparent"; - span2.style.userSelect = "none"; - } - // If it's unchanged, show it in black in both - else { - span1.style.color = color; - span2.style.color = color; - } - - span1.textContent = word; - span2.textContent = word; - resultDiv1.appendChild(span1); - resultDiv2.appendChild(span2); - - // Add space after each word, or a new line if the word ends with a full stop - const spaceOrNewline1 = document.createElement("span"); - const spaceOrNewline2 = document.createElement("span"); - if (word.endsWith(".")) { - spaceOrNewline1.innerHTML = "
"; - spaceOrNewline2.innerHTML = "
"; - } else { - spaceOrNewline1.textContent = " "; - spaceOrNewline2.textContent = " "; - } - resultDiv1.appendChild(spaceOrNewline1); - resultDiv2.appendChild(spaceOrNewline2); - }); - }; + } catch (error) { + console.error('Comparison failed:', error); + alert(error.message || invalidPdfMessage); + result1.innerHTML = ''; + result2.innerHTML = ''; + } finally { + button.disabled = false; + button.textContent = submitText; + } } + // FileReader helper + function readFileAsArrayBuffer(file) { + return new Promise((resolve, reject) => { + const reader = new FileReader(); + reader.onload = () => resolve(reader.result); + reader.onerror = reject; + reader.readAsArrayBuffer(file); + }); + } + // Header validation (PDF.js-specific, but client-side) + async function validatePdfHeader(data, fileName) { + const header = new Uint8Array(data.slice(0, 8)); + const headerStr = String.fromCharCode(...header); + console.log(`${fileName} header:`, headerStr); + if (!headerStr.startsWith('%PDF-')) { + throw new Error(`${fileName} is not a valid PDF (header: ${headerStr}).`); + } + if (data.byteLength < 100) { + throw new Error(`${fileName} is too short.`); + } + } + + // PDF loading with catch + function loadPdfWithErrorHandling(options, fileName) { + return pdfjsLib.getDocument(options).promise + .then(pdf => { + console.log(`${fileName} loaded: ${pdf.numPages} pages`); + return pdf; + }) + .catch(err => { + console.error(`${fileName} load failed:`, err); + if (err.name === 'InvalidPDFException') { + throw new Error(`${fileName}: Invalid PDF structure. Re-upload.`); + } + throw err; + }); + } + + // Text extraction + async function extractText(pdf, fileName, statusElement) { + const pages = []; + const totalPages = pdf.numPages; + for (let i = 1; i <= totalPages; i++) { + const page = await pdf.getPage(i); + const content = await page.getTextContent(); + const strings = content.items.map(item => item.str).join(' '); + pages.push(strings); + statusElement.innerHTML = `${fileName}: ${Math.round((i / totalPages) * 100)}%`; + } + return pages.join(' '); + } + + // Worker processing + async function processWithWorker(text1, text2, color1, color2, complexMessage, largeFilesMessage) { + return new Promise((resolve, reject) => { + const worker = new Worker('./js/compare/pdfWorker.js'); + const timeout = setTimeout(() => { + worker.terminate(); + reject(new Error('Timeout: Files too complex.')); + }, 30000); + + worker.postMessage({ type: 'SET_COMPLEX_MESSAGE', message: complexMessage }); + worker.postMessage({ type: 'SET_TOO_LARGE_MESSAGE', message: largeFilesMessage }); + + worker.onerror = (error) => { + clearTimeout(timeout); + worker.terminate(); + reject(new Error('Worker error: ' + error.message)); + }; + + worker.onmessage = (e) => { + clearTimeout(timeout); + const { status, differences, message } = e.data; + if (status === 'error') { + worker.terminate(); + reject(new Error(message)); + return; + } + if (status === 'warning') { + alert(message); + } + if (status === 'success' && differences) { + displayDifferences(differences, color1, color2); + worker.terminate(); + resolve(); + } + }; + + worker.postMessage({ type: 'COMPARE', text1, text2, color1, color2 }); + }); + } + + // Display differences + function displayDifferences(differences, color1, color2) { + const resultDiv1 = document.getElementById("result1"); + const resultDiv2 = document.getElementById("result2"); + resultDiv1.innerHTML = ""; + resultDiv2.innerHTML = ""; + + differences.forEach(([color, word]) => { + const span1 = document.createElement("span"); + const span2 = document.createElement("span"); + + if (color === color2) { + span1.style.color = "transparent"; + span1.style.userSelect = "none"; + span2.style.color = color; + } else if (color === color1) { + span1.style.color = color; + span2.style.color = "transparent"; + span2.style.userSelect = "none"; + } else { + span1.style.color = color || 'black'; + span2.style.color = color || 'black'; + } + + span1.textContent = word; + span2.textContent = word; + resultDiv1.appendChild(span1); + resultDiv2.appendChild(span2); + + const spaceOrNewline1 = document.createElement("span"); + const spaceOrNewline2 = document.createElement("span"); + if (word.endsWith(".")) { + spaceOrNewline1.innerHTML = "
"; + spaceOrNewline2.innerHTML = "
"; + } else { + spaceOrNewline1.textContent = " "; + spaceOrNewline2.textContent = " "; + } + resultDiv1.appendChild(spaceOrNewline1); + resultDiv2.appendChild(spaceOrNewline2); + }); + }
diff --git a/app/core/src/main/resources/templates/misc/compress-pdf.html b/app/core/src/main/resources/templates/misc/compress-pdf.html index 550983a8c8..b593eb8f3c 100644 --- a/app/core/src/main/resources/templates/misc/compress-pdf.html +++ b/app/core/src/main/resources/templates/misc/compress-pdf.html @@ -45,6 +45,12 @@ + +
+ +
diff --git a/app/core/src/main/resources/templates/misc/extract-attachments.html b/app/core/src/main/resources/templates/misc/extract-attachments.html new file mode 100644 index 0000000000..b1b12ca053 --- /dev/null +++ b/app/core/src/main/resources/templates/misc/extract-attachments.html @@ -0,0 +1,52 @@ + + + + + + + + + +
+
+ +

+
+
+
+
+ folder_zip + +
+ +

+ +
+ +
+
+ + + +
+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/app/core/src/main/resources/templates/misc/flatten.html b/app/core/src/main/resources/templates/misc/flatten.html index fca06e0931..3e31d1cbf9 100644 --- a/app/core/src/main/resources/templates/misc/flatten.html +++ b/app/core/src/main/resources/templates/misc/flatten.html @@ -24,7 +24,20 @@
-
+ +
+ + + +

diff --git a/app/core/src/main/resources/templates/multi-tool.html b/app/core/src/main/resources/templates/multi-tool.html index 1624cf4b57..a1160d43fe 100644 --- a/app/core/src/main/resources/templates/multi-tool.html +++ b/app/core/src/main/resources/templates/multi-tool.html @@ -142,11 +142,16 @@ split: '[[#{multiTool.split}]]', addFile: '[[#{multiTool.addFile}]]', insertPageBreak: '[[#{multiTool.insertPageBreak}]]', + duplicate: '[[#{multiTool.duplicate}]]', dragDropMessage: '[[#{multiTool.dragDropMessage}]]', undo: '[[#{multiTool.undo}]]', redo: '[[#{multiTool.redo}]]', }; + window.multiTool = Object.assign({}, window.multiTool, { + svgNotSupported: '[[#{multiTool.svgNotSupported}]]', + }); + window.decrypt = { passwordPrompt: '[[#{decrypt.passwordPrompt}]]', cancelled: '[[#{decrypt.cancelled}]]', diff --git a/app/core/src/main/resources/templates/pdf-organizer.html b/app/core/src/main/resources/templates/pdf-organizer.html index 746a6bafd4..8e2937eead 100644 --- a/app/core/src/main/resources/templates/pdf-organizer.html +++ b/app/core/src/main/resources/templates/pdf-organizer.html @@ -42,22 +42,29 @@ -
+
+ th:placeholder="#{pdfOrganiser.placeholder}">
diff --git a/app/core/src/main/resources/templates/rotate-pdf.html b/app/core/src/main/resources/templates/rotate-pdf.html index 3d54ce3177..6baa242683 100644 --- a/app/core/src/main/resources/templates/rotate-pdf.html +++ b/app/core/src/main/resources/templates/rotate-pdf.html @@ -59,12 +59,24 @@ - +
diff --git a/app/core/src/test/java/org/apache/pdfbox/examples/util/ConnectedInputStreamTest.java b/app/core/src/test/java/org/apache/pdfbox/examples/util/ConnectedInputStreamTest.java new file mode 100644 index 0000000000..48d8b11a48 --- /dev/null +++ b/app/core/src/test/java/org/apache/pdfbox/examples/util/ConnectedInputStreamTest.java @@ -0,0 +1,86 @@ +package org.apache.pdfbox.examples.util; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.HttpURLConnection; +import java.nio.charset.StandardCharsets; + +import org.junit.jupiter.api.Test; +import org.mockito.InOrder; + +class ConnectedInputStreamTest { + + @Test + void delegates_read_skip_available_mark_reset_and_markSupported() throws IOException { + byte[] data = "hello world".getBytes(StandardCharsets.UTF_8); + ByteArrayInputStream base = new ByteArrayInputStream(data); + HttpURLConnection con = mock(HttpURLConnection.class); + + ConnectedInputStream cis = new ConnectedInputStream(con, base); + + // mark support + assertTrue(cis.markSupported()); + + // available at start + assertEquals(data.length, cis.available()); + + // read single byte + int first = cis.read(); + assertEquals('h', first); + + // mark here + cis.mark(100); + + // read next 4 bytes with read(byte[]) + byte[] buf4 = new byte[4]; + int n4 = cis.read(buf4); + assertEquals(4, n4); + assertArrayEquals("ello".getBytes(StandardCharsets.UTF_8), buf4); + + // read next 1 byte with read(byte[], off, len) + byte[] one = new byte[1]; + int n1 = cis.read(one, 0, 1); + assertEquals(1, n1); + assertEquals((int) ' ', one[0] & 0xFF); + + // reset to mark and re-read the same 5 bytes ("ello ") + cis.reset(); + byte[] again5 = new byte[5]; + int n5 = cis.read(again5, 0, 5); + assertEquals(5, n5); + assertArrayEquals("ello ".getBytes(StandardCharsets.UTF_8), again5); + + // skip one byte ('w') + long skipped = cis.skip(1); + assertEquals(1, skipped); + + // remaining should be "orld" (4 bytes) + assertEquals(4, cis.available()); + byte[] rest = new byte[4]; + assertEquals(4, cis.read(rest)); + assertArrayEquals("orld".getBytes(StandardCharsets.UTF_8), rest); + + // end of stream + assertEquals(-1, cis.read()); + cis.close(); + verify(con).disconnect(); + } + + @Test + void close_closes_stream_before_disconnect() throws IOException { + InputStream is = mock(InputStream.class); + HttpURLConnection con = mock(HttpURLConnection.class); + + ConnectedInputStream cis = new ConnectedInputStream(con, is); + cis.close(); + + InOrder inOrder = inOrder(is, con); + inOrder.verify(is).close(); + inOrder.verify(con).disconnect(); + inOrder.verifyNoMoreInteractions(); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/Factories/ReplaceAndInvertColorFactoryTest.java b/app/core/src/test/java/stirling/software/SPDF/Factories/ReplaceAndInvertColorFactoryTest.java new file mode 100644 index 0000000000..948e00c106 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/Factories/ReplaceAndInvertColorFactoryTest.java @@ -0,0 +1,93 @@ +package stirling.software.SPDF.Factories; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.web.multipart.MultipartFile; + +import stirling.software.SPDF.config.EndpointConfiguration; +import stirling.software.common.model.api.misc.HighContrastColorCombination; +import stirling.software.common.model.api.misc.ReplaceAndInvert; +import stirling.software.common.util.misc.ColorSpaceConversionStrategy; +import stirling.software.common.util.misc.CustomColorReplaceStrategy; +import stirling.software.common.util.misc.InvertFullColorStrategy; +import stirling.software.common.util.misc.ReplaceAndInvertColorStrategy; + +class ReplaceAndInvertColorFactoryTest { + + private ReplaceAndInvertColorFactory factory; + private MultipartFile file; + private EndpointConfiguration endpointConfiguration; + + @BeforeEach + void setup() { + endpointConfiguration = mock(EndpointConfiguration.class); + when(endpointConfiguration.isGroupEnabled("Ghostscript")).thenReturn(true); + factory = new ReplaceAndInvertColorFactory(null, endpointConfiguration); + file = mock(MultipartFile.class); + } + + @Test + void whenCustomColor_thenReturnsCustomColorReplaceStrategy() { + ReplaceAndInvert option = ReplaceAndInvert.CUSTOM_COLOR; + HighContrastColorCombination combo = null; // not used for CUSTOM_COLOR + + ReplaceAndInvertColorStrategy strategy = + factory.replaceAndInvert(file, option, combo, "#FFFFFF", "#000000"); + + assertNotNull(strategy); + assertTrue( + strategy instanceof CustomColorReplaceStrategy, + "Expected CustomColorReplaceStrategy for CUSTOM_COLOR"); + } + + @Test + void whenHighContrastColor_thenReturnsCustomColorReplaceStrategy() { + ReplaceAndInvert option = ReplaceAndInvert.HIGH_CONTRAST_COLOR; + HighContrastColorCombination combo = null; + + ReplaceAndInvertColorStrategy strategy = + factory.replaceAndInvert(file, option, combo, "#FFFFFF", "#000000"); + + assertNotNull(strategy); + assertTrue( + strategy instanceof CustomColorReplaceStrategy, + "Expected CustomColorReplaceStrategy for HIGH_CONTRAST_COLOR"); + } + + @Test + void whenFullInversion_thenReturnsInvertFullColorStrategy() { + ReplaceAndInvert option = ReplaceAndInvert.FULL_INVERSION; + + ReplaceAndInvertColorStrategy strategy = + factory.replaceAndInvert(file, option, null, null, null); + + assertNotNull(strategy); + assertTrue( + strategy instanceof InvertFullColorStrategy, + "Expected InvertFullColorStrategy for FULL_INVERSION"); + } + + @Test + void whenColorSpaceConversion_thenReturnsColorSpaceConversionStrategy() { + ReplaceAndInvert option = ReplaceAndInvert.COLOR_SPACE_CONVERSION; + + ReplaceAndInvertColorStrategy strategy = + factory.replaceAndInvert(file, option, null, null, null); + + assertNotNull(strategy); + assertTrue( + strategy instanceof ColorSpaceConversionStrategy, + "Expected ColorSpaceConversionStrategy for COLOR_SPACE_CONVERSION"); + } + + @Test + void whenNullOption_thenReturnsNull() { + ReplaceAndInvertColorStrategy strategy = + factory.replaceAndInvert(file, null, null, null, null); + assertNull(strategy, "Expected null for unsupported/unknown option"); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/SPDFApplicationTest.java b/app/core/src/test/java/stirling/software/SPDF/SPDFApplicationTest.java index 087475c853..a20ccebb48 100644 --- a/app/core/src/test/java/stirling/software/SPDF/SPDFApplicationTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/SPDFApplicationTest.java @@ -1,6 +1,7 @@ package stirling.software.SPDF; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.Mockito.when; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -10,6 +11,7 @@ import org.mockito.Mock; import org.mockito.junit.jupiter.MockitoExtension; import org.springframework.core.env.Environment; +import stirling.software.common.configuration.AppConfig; import stirling.software.common.model.ApplicationProperties; @ExtendWith(MockitoExtension.class) @@ -21,6 +23,8 @@ public class SPDFApplicationTest { @InjectMocks private SPDFApplication sPDFApplication; + @Mock private AppConfig appConfig; + @BeforeEach public void setUp() { SPDFApplication.setServerPortStatic("8080"); @@ -36,4 +40,25 @@ public class SPDFApplicationTest { public void testGetStaticPort() { assertEquals("8080", SPDFApplication.getStaticPort()); } + + @Test + public void testSetServerPortStaticAuto() { + SPDFApplication.setServerPortStatic("auto"); + assertEquals("0", SPDFApplication.getStaticPort()); + } + + @Test + public void testInit() { + when(appConfig.getBackendUrl()).thenReturn("http://localhost"); + when(appConfig.getContextPath()).thenReturn("/app"); + when(appConfig.getServerPort()).thenReturn("8080"); + + sPDFApplication.init(); + + assertEquals("http://localhost", SPDFApplication.getStaticBaseUrl()); + assertEquals("/app", SPDFApplication.getStaticContextPath()); + assertEquals("8080", SPDFApplication.getStaticPort()); + } + + // Tests for getActiveProfile removed - method is now private } diff --git a/app/core/src/test/java/stirling/software/SPDF/config/ExternalAppDepConfigTest.java b/app/core/src/test/java/stirling/software/SPDF/config/ExternalAppDepConfigTest.java new file mode 100644 index 0000000000..e2c6a326fb --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/config/ExternalAppDepConfigTest.java @@ -0,0 +1,185 @@ +package stirling.software.SPDF.config; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.lenient; +import static org.mockito.Mockito.when; + +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +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 stirling.software.common.configuration.RuntimePathConfig; + +@ExtendWith(MockitoExtension.class) +class ExternalAppDepConfigTest { + + @Mock private EndpointConfiguration endpointConfiguration; + @Mock private RuntimePathConfig runtimePathConfig; + + private ExternalAppDepConfig config; + + @BeforeEach + void setUp() { + when(runtimePathConfig.getWeasyPrintPath()).thenReturn("/custom/weasyprint"); + when(runtimePathConfig.getUnoConvertPath()).thenReturn("/custom/unoconvert"); + when(runtimePathConfig.getCalibrePath()).thenReturn("/custom/calibre"); + when(runtimePathConfig.getOcrMyPdfPath()).thenReturn("/custom/ocrmypdf"); + lenient() + .when(endpointConfiguration.getEndpointsForGroup(anyString())) + .thenReturn(Set.of()); + + config = new ExternalAppDepConfig(endpointConfiguration, runtimePathConfig); + } + + @Test + void commandToGroupMappingIncludesRuntimePaths() throws Exception { + Map> mapping = getCommandToGroupMapping(); + + assertEquals(List.of("Weasyprint"), mapping.get("/custom/weasyprint")); + assertEquals(List.of("Unoconvert"), mapping.get("/custom/unoconvert")); + assertEquals(List.of("Calibre"), mapping.get("/custom/calibre")); + assertEquals(List.of("OCRmyPDF"), mapping.get("/custom/ocrmypdf")); + assertEquals(List.of("Ghostscript"), mapping.get("gs")); + } + + @Test + void getAffectedFeaturesFormatsEndpoints() throws Exception { + Set endpoints = new LinkedHashSet<>(List.of("pdf-to-html", "img-extract")); + when(endpointConfiguration.getEndpointsForGroup("Ghostscript")).thenReturn(endpoints); + + @SuppressWarnings("unchecked") + List features = + (List) invokePrivateMethod(config, "getAffectedFeatures", "Ghostscript"); + + assertEquals(List.of("PDF To Html", "Image Extract"), features); + } + + @Test + void formatEndpointAsFeatureConvertsNames() throws Exception { + String formatted = + (String) invokePrivateMethod(config, "formatEndpointAsFeature", "pdf-img-extract"); + + assertEquals("PDF Image Extract", formatted); + } + + @Test + void capitalizeWordHandlesSpecialCases() throws Exception { + String pdf = (String) invokePrivateMethod(config, "capitalizeWord", "pdf"); + String mixed = (String) invokePrivateMethod(config, "capitalizeWord", "tEsT"); + String empty = (String) invokePrivateMethod(config, "capitalizeWord", ""); + + assertEquals("PDF", pdf); + assertEquals("Test", mixed); + assertEquals("", empty); + } + + @Test + void isWeasyprintMatchesConfiguredCommands() throws Exception { + boolean directMatch = + (boolean) invokePrivateMethod(config, "isWeasyprint", "/custom/weasyprint"); + boolean nameContains = + (boolean) invokePrivateMethod(config, "isWeasyprint", "/usr/bin/weasyprint-cli"); + boolean differentCommand = (boolean) invokePrivateMethod(config, "isWeasyprint", "qpdf"); + + assertTrue(directMatch); + assertTrue(nameContains); + assertFalse(differentCommand); + } + + @Test + void versionComparisonHandlesDifferentFormats() { + ExternalAppDepConfig.Version required = new ExternalAppDepConfig.Version("58"); + ExternalAppDepConfig.Version installed = new ExternalAppDepConfig.Version("57.9.2"); + ExternalAppDepConfig.Version beta = new ExternalAppDepConfig.Version("58.beta"); + + assertTrue(installed.compareTo(required) < 0); + assertEquals(0, beta.compareTo(required)); + assertEquals("58.0.0", beta.toString()); + } + + @SuppressWarnings("unchecked") + private Map> getCommandToGroupMapping() throws Exception { + Field field = ExternalAppDepConfig.class.getDeclaredField("commandToGroupMapping"); + field.setAccessible(true); + return (Map>) field.get(config); + } + + private Object invokePrivateMethod(Object target, String methodName, Object... args) + throws Exception { + Method method = findMatchingMethod(methodName, args); + method.setAccessible(true); + return method.invoke(target, args); + } + + private Method findMatchingMethod(String methodName, Object[] args) + throws NoSuchMethodException { + Method[] methods = ExternalAppDepConfig.class.getDeclaredMethods(); + for (Method candidate : methods) { + if (!candidate.getName().equals(methodName) + || candidate.getParameterCount() != args.length) { + continue; + } + + Class[] parameterTypes = candidate.getParameterTypes(); + boolean matches = true; + for (int i = 0; i < parameterTypes.length; i++) { + if (!isParameterCompatible(parameterTypes[i], args[i])) { + matches = false; + break; + } + } + + if (matches) { + return candidate; + } + } + + throw new NoSuchMethodException( + "No matching method found for " + methodName + " with provided arguments"); + } + + private boolean isParameterCompatible(Class parameterType, Object arg) { + if (arg == null) { + return !parameterType.isPrimitive(); + } + + Class argumentClass = arg.getClass(); + if (parameterType.isPrimitive()) { + return getWrapperType(parameterType).isAssignableFrom(argumentClass); + } + + return parameterType.isAssignableFrom(argumentClass); + } + + private Class getWrapperType(Class primitiveType) { + if (primitiveType == boolean.class) { + return Boolean.class; + } else if (primitiveType == byte.class) { + return Byte.class; + } else if (primitiveType == short.class) { + return Short.class; + } else if (primitiveType == int.class) { + return Integer.class; + } else if (primitiveType == long.class) { + return Long.class; + } else if (primitiveType == float.class) { + return Float.class; + } else if (primitiveType == double.class) { + return Double.class; + } else if (primitiveType == char.class) { + return Character.class; + } + + throw new IllegalArgumentException("Type is not primitive: " + primitiveType); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/AdditionalLanguageJsControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/AdditionalLanguageJsControllerTest.java new file mode 100644 index 0000000000..58c1b2e4e9 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/AdditionalLanguageJsControllerTest.java @@ -0,0 +1,59 @@ +package stirling.software.SPDF.controller.api; + +import static org.hamcrest.Matchers.containsString; +import static org.mockito.Mockito.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; + +import org.junit.jupiter.api.Test; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; + +import stirling.software.SPDF.service.LanguageService; + +class AdditionalLanguageJsControllerTest { + + @Test + void returnsJsWithSupportedLanguagesAndFunction() throws Exception { + LanguageService lang = mock(LanguageService.class); + // LinkedHashSet for deterministic order in the array + when(lang.getSupportedLanguages()) + .thenReturn(new LinkedHashSet<>(List.of("de_DE", "en_GB"))); + + MockMvc mvc = + MockMvcBuilders.standaloneSetup(new AdditionalLanguageJsController(lang)).build(); + + mvc.perform(get("/js/additionalLanguageCode.js")) + .andExpect(status().isOk()) + .andExpect(content().contentType(new MediaType("application", "javascript"))) + .andExpect( + content() + .string( + containsString( + "const supportedLanguages =" + + " [\"de_DE\",\"en_GB\"];"))) + .andExpect(content().string(containsString("function getDetailedLanguageCode()"))) + .andExpect(content().string(containsString("return \"en_GB\";"))); + + verify(lang, times(1)).getSupportedLanguages(); + } + + @Test + void emptySupportedLanguagesYieldsEmptyArray() throws Exception { + LanguageService lang = mock(LanguageService.class); + when(lang.getSupportedLanguages()).thenReturn(Set.of()); + + MockMvc mvc = + MockMvcBuilders.standaloneSetup(new AdditionalLanguageJsController(lang)).build(); + + mvc.perform(get("/js/additionalLanguageCode.js")) + .andExpect(status().isOk()) + .andExpect(content().contentType(new MediaType("application", "javascript"))) + .andExpect(content().string(containsString("const supportedLanguages = [];"))); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/CropControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/CropControllerTest.java new file mode 100644 index 0000000000..3c526a84c5 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/CropControllerTest.java @@ -0,0 +1,686 @@ +package stirling.software.SPDF.controller.api; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.awt.image.BufferedImage; +import java.io.IOException; +import java.lang.reflect.Method; +import java.nio.file.Files; +import java.nio.file.Path; + +import org.apache.pdfbox.Loader; +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.font.PDType1Font; +import org.apache.pdfbox.pdmodel.font.Standard14Fonts; +import org.junit.jupiter.api.*; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.io.TempDir; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; +import org.junit.jupiter.params.provider.ValueSource; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.mock.web.MockMultipartFile; + +import stirling.software.SPDF.model.api.general.CropPdfForm; +import stirling.software.common.service.CustomPDFDocumentFactory; + +@ExtendWith(MockitoExtension.class) +@DisplayName("CropController Tests") +class CropControllerTest { + + @TempDir Path tempDir; + @Mock private CustomPDFDocumentFactory pdfDocumentFactory; + @InjectMocks private CropController cropController; + private TestPdfFactory pdfFactory; + + @BeforeEach + void setUp() { + pdfFactory = new TestPdfFactory(); + } + + private static class CropRequestBuilder { + private final CropPdfForm form = new CropPdfForm(); + + CropRequestBuilder withFile(MockMultipartFile file) { + form.setFileInput(file); + return this; + } + + CropRequestBuilder withCoordinates(float x, float y, float width, float height) { + form.setX(x); + form.setY(y); + form.setWidth(width); + form.setHeight(height); + return this; + } + + CropRequestBuilder withAutoCrop(boolean autoCrop) { + form.setAutoCrop(autoCrop); + return this; + } + + CropRequestBuilder withRemoveDataOutsideCrop(boolean remove) { + form.setRemoveDataOutsideCrop(remove); + return this; + } + + CropPdfForm build() { + return form; + } + } + + private class TestPdfFactory { + private static final PDType1Font HELVETICA = + new PDType1Font(Standard14Fonts.FontName.HELVETICA); + + MockMultipartFile createStandardPdf(String filename) throws IOException { + return createPdf(filename, PDRectangle.LETTER, null); + } + + MockMultipartFile createPdfWithContent(String filename, String content) throws IOException { + return createPdf(filename, PDRectangle.LETTER, content); + } + + MockMultipartFile createPdfWithSize(String filename, PDRectangle size) throws IOException { + return createPdf(filename, size, null); + } + + MockMultipartFile createPdf(String filename, PDRectangle pageSize, String content) + throws IOException { + Path testPdfPath = tempDir.resolve(filename); + + try (PDDocument doc = new PDDocument()) { + PDPage page = new PDPage(pageSize); + doc.addPage(page); + + if (content != null && !content.isEmpty()) { + try (PDPageContentStream contentStream = new PDPageContentStream(doc, page)) { + contentStream.beginText(); + contentStream.setFont(HELVETICA, 12); + contentStream.newLineAtOffset(50, pageSize.getHeight() - 50); + contentStream.showText(content); + contentStream.endText(); + } + } + + doc.save(testPdfPath.toFile()); + } + + return new MockMultipartFile( + "fileInput", + filename, + MediaType.APPLICATION_PDF_VALUE, + Files.readAllBytes(testPdfPath)); + } + + MockMultipartFile createPdfWithCenteredContent(String filename, String content) + throws IOException { + Path testPdfPath = tempDir.resolve(filename); + PDRectangle pageSize = PDRectangle.LETTER; + + try (PDDocument doc = new PDDocument()) { + PDPage page = new PDPage(pageSize); + doc.addPage(page); + + if (content != null && !content.isEmpty()) { + try (PDPageContentStream contentStream = new PDPageContentStream(doc, page)) { + contentStream.beginText(); + contentStream.setFont(HELVETICA, 12); + float x = pageSize.getWidth() / 2 - 50; + float y = pageSize.getHeight() / 2; + contentStream.newLineAtOffset(x, y); + contentStream.showText(content); + contentStream.endText(); + } + } + + doc.save(testPdfPath.toFile()); + } + + return new MockMultipartFile( + "fileInput", + filename, + MediaType.APPLICATION_PDF_VALUE, + Files.readAllBytes(testPdfPath)); + } + } + + @Nested + @DisplayName("Manual Crop with PDFBox") + class ManualCropPDFBoxTests { + + @Test + @DisplayName( + "Should successfully crop PDF using PDFBox when removeDataOutsideCrop is false") + void shouldCropPdfSuccessfullyWithPDFBox() throws IOException { + MockMultipartFile testFile = pdfFactory.createStandardPdf("test.pdf"); + CropPdfForm request = + new CropRequestBuilder() + .withFile(testFile) + .withCoordinates(50f, 50f, 512f, 692f) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + PDDocument mockDocument = mock(PDDocument.class); + PDDocument newDocument = mock(PDDocument.class); + when(pdfDocumentFactory.load(request)).thenReturn(mockDocument); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(mockDocument)) + .thenReturn(newDocument); + + ResponseEntity response = cropController.cropPdf(request); + + assertThat(response) + .isNotNull() + .extracting(ResponseEntity::getStatusCode, ResponseEntity::getBody) + .satisfies( + tuple -> { + assertThat(tuple.get(0)).isEqualTo(HttpStatus.OK); + assertThat(tuple.get(1)).isNotNull(); + }); + + verify(pdfDocumentFactory).load(request); + verify(pdfDocumentFactory).createNewDocumentBasedOnOldDocument(mockDocument); + verify(mockDocument, times(1)).close(); + verify(newDocument, times(1)).close(); + } + + @ParameterizedTest + @CsvSource({"50, 50, 512, 692", "0, 0, 300, 400", "100, 100, 400, 600"}) + @DisplayName("Should handle various coordinate sets correctly") + void shouldHandleVariousCoordinates(float x, float y, float width, float height) + throws IOException { + MockMultipartFile testFile = pdfFactory.createStandardPdf("test.pdf"); + CropPdfForm request = + new CropRequestBuilder() + .withFile(testFile) + .withCoordinates(x, y, width, height) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + PDDocument mockDocument = mock(PDDocument.class); + PDDocument newDocument = mock(PDDocument.class); + when(pdfDocumentFactory.load(request)).thenReturn(mockDocument); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(mockDocument)) + .thenReturn(newDocument); + + ResponseEntity response = cropController.cropPdf(request); + + assertThat(response).isNotNull(); + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + assertThat(response.getBody()).isNotNull(); + + verify(pdfDocumentFactory).load(request); + verify(mockDocument, times(1)).close(); + verify(newDocument, times(1)).close(); + } + } + + @Nested + @DisplayName("Auto Crop Functionality") + @Tag("integration") + class AutoCropTests { + + private TestPdfFactory autoCropPdfFactory; + + @BeforeEach + void setUp() { + autoCropPdfFactory = new TestPdfFactory(); + } + + @Test + @DisplayName("Should auto-crop PDF with content successfully") + void shouldAutoCropPdfSuccessfully() throws IOException { + MockMultipartFile testFile = + autoCropPdfFactory.createPdfWithCenteredContent( + "test_autocrop.pdf", "Test Content for Auto Crop"); + CropPdfForm request = + new CropRequestBuilder().withFile(testFile).withAutoCrop(true).build(); + + // Mock the pdfDocumentFactory to load real PDFs + try (PDDocument sourceDoc = Loader.loadPDF(testFile.getBytes()); + PDDocument newDoc = new PDDocument()) { + when(pdfDocumentFactory.load(request)).thenReturn(sourceDoc); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(sourceDoc)) + .thenReturn(newDoc); + + ResponseEntity response = cropController.cropPdf(request); + + assertThat(response).isNotNull(); + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + assertThat(response.getBody()).isNotEmpty(); + + try (PDDocument result = Loader.loadPDF(response.getBody())) { + assertThat(result.getNumberOfPages()).isEqualTo(1); + + PDPage page = result.getPage(0); + assertThat(page).isNotNull(); + assertThat(page.getMediaBox()).isNotNull(); + } + } + } + + @Test + @DisplayName("Should handle PDF with minimal content") + void shouldHandleMinimalContentPdf() throws IOException { + MockMultipartFile testFile = + autoCropPdfFactory.createPdfWithContent("minimal.pdf", "X"); + CropPdfForm request = + new CropRequestBuilder().withFile(testFile).withAutoCrop(true).build(); + + // Mock the pdfDocumentFactory to load real PDFs + try (PDDocument sourceDoc = Loader.loadPDF(testFile.getBytes()); + PDDocument newDoc = new PDDocument()) { + when(pdfDocumentFactory.load(request)).thenReturn(sourceDoc); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(sourceDoc)) + .thenReturn(newDoc); + + ResponseEntity response = cropController.cropPdf(request); + + assertThat(response).isNotNull(); + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + + Assertions.assertNotNull(response.getBody()); + try (PDDocument result = Loader.loadPDF(response.getBody())) { + assertThat(result.getNumberOfPages()).isEqualTo(1); + } + } + } + } + + @Nested + @DisplayName("Content Bounds Detection") + class ContentBoundsDetectionTests { + + private Method detectContentBoundsMethod; + + private static BufferedImage createWhiteImage(int width, int height) { + BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + for (int x = 0; x < width; x++) { + for (int y = 0; y < height; y++) { + image.setRGB(x, y, 0xFFFFFF); + } + } + return image; + } + + private static BufferedImage createImageFilledWith(int width, int height, int color) { + BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + for (int x = 0; x < width; x++) { + for (int y = 0; y < height; y++) { + image.setRGB(x, y, color); + } + } + return image; + } + + private static void drawBlackRectangle( + BufferedImage image, int x1, int y1, int x2, int y2) { + for (int x = x1; x < x2; x++) { + for (int y = y1; y < y2; y++) { + image.setRGB(x, y, 0x000000); + } + } + } + + private static void drawDarkerRectangle( + BufferedImage image, int x1, int y1, int x2, int y2, int color) { + for (int x = x1; x < x2; x++) { + for (int y = y1; y < y2; y++) { + image.setRGB(x, y, color); + } + } + } + + @BeforeEach + void setUp() throws NoSuchMethodException { + detectContentBoundsMethod = + CropController.class.getDeclaredMethod( + "detectContentBounds", BufferedImage.class); + detectContentBoundsMethod.setAccessible(true); + } + + @Test + @DisplayName("Should detect full image bounds for all white image") + void shouldDetectFullBoundsForWhiteImage() throws Exception { + BufferedImage whiteImage = createWhiteImage(100, 100); + + int[] bounds = (int[]) detectContentBoundsMethod.invoke(null, whiteImage); + + assertThat(bounds).containsExactly(0, 0, 99, 99); + } + + @Test + @DisplayName("Should detect black rectangle bounds correctly") + void shouldDetectBlackRectangleBounds() throws Exception { + BufferedImage image = createWhiteImage(100, 100); + drawBlackRectangle(image, 25, 25, 75, 75); + + int[] bounds = (int[]) detectContentBoundsMethod.invoke(null, image); + + assertThat(bounds).containsExactly(25, 25, 74, 74); + } + + @Test + @DisplayName("Should detect content at image edges") + void shouldDetectContentAtEdges() throws Exception { + BufferedImage image = createWhiteImage(100, 100); + image.setRGB(0, 0, 0x000000); + image.setRGB(99, 0, 0x000000); + image.setRGB(0, 99, 0x000000); + image.setRGB(99, 99, 0x000000); + + int[] bounds = (int[]) detectContentBoundsMethod.invoke(null, image); + + assertThat(bounds).containsExactly(0, 0, 99, 99); + } + + @Test + @DisplayName("Should include noise pixels in bounds detection") + void shouldIncludeNoiseInBounds() throws Exception { + BufferedImage image = createWhiteImage(100, 100); + image.setRGB(10, 10, 0xF0F0F0); + image.setRGB(90, 90, 0xF0F0F0); + drawBlackRectangle(image, 30, 30, 70, 70); + + int[] bounds = (int[]) detectContentBoundsMethod.invoke(null, image); + + assertThat(bounds).containsExactly(10, 9, 90, 89); + } + + @Test + @DisplayName("Should treat gray pixels below threshold as content") + void shouldTreatGrayPixelsAsContent() throws Exception { + BufferedImage image = createImageFilledWith(50, 50, 0xF0F0F0); + drawDarkerRectangle(image, 20, 20, 30, 30, 0xC0C0C0); + + int[] bounds = (int[]) detectContentBoundsMethod.invoke(null, image); + + assertThat(bounds).containsExactly(0, 0, 49, 49); + } + } + + @Nested + @DisplayName("White Pixel Detection") + class WhitePixelDetectionTests { + + private Method isWhiteMethod; + + @BeforeEach + void setUp() throws NoSuchMethodException { + isWhiteMethod = CropController.class.getDeclaredMethod("isWhite", int.class, int.class); + isWhiteMethod.setAccessible(true); + } + + @Test + @DisplayName("Should identify pure white pixels") + void shouldIdentifyWhitePixels() throws Exception { + assertThat((Boolean) isWhiteMethod.invoke(null, 0xFFFFFFFF, 250)).isTrue(); + assertThat((Boolean) isWhiteMethod.invoke(null, 0xFFF0F0F0, 240)).isTrue(); + } + + @Test + @DisplayName("Should identify black pixels as non-white") + void shouldIdentifyBlackPixels() throws Exception { + assertThat((Boolean) isWhiteMethod.invoke(null, 0xFF000000, 250)).isFalse(); + assertThat((Boolean) isWhiteMethod.invoke(null, 0xFF101010, 250)).isFalse(); + } + + @ParameterizedTest + @ValueSource(ints = {0xFFFFFFFF, 0xFFFAFAFA, 0xFFF5F5F5}) + @DisplayName("Should identify various white shades") + void shouldIdentifyVariousWhiteShades(int pixelColor) throws Exception { + assertThat((Boolean) isWhiteMethod.invoke(null, pixelColor, 240)).isTrue(); + } + + @ParameterizedTest + @ValueSource(ints = {0xFF000000, 0xFF101010, 0xFF808080}) + @DisplayName("Should identify various non-white shades") + void shouldIdentifyNonWhiteShades(int pixelColor) throws Exception { + assertThat((Boolean) isWhiteMethod.invoke(null, pixelColor, 250)).isFalse(); + } + } + + @Nested + @DisplayName("CropBounds Conversion") + class CropBoundsTests { + + private Class cropBoundsClass; + private Method fromPixelsMethod; + + @BeforeEach + void setUp() throws ClassNotFoundException, NoSuchMethodException { + cropBoundsClass = + Class.forName( + "stirling.software.SPDF.controller.api.CropController$CropBounds"); + fromPixelsMethod = + cropBoundsClass.getDeclaredMethod( + "fromPixels", int[].class, float.class, float.class); + fromPixelsMethod.setAccessible(true); + } + + @Test + @DisplayName("Should convert pixel bounds to PDF coordinates correctly") + void shouldConvertPixelBoundsToPdfCoordinates() throws Exception { + int[] pixelBounds = {10, 20, 110, 120}; + float scaleX = 0.5f; + float scaleY = 0.5f; + + Object bounds = fromPixelsMethod.invoke(null, pixelBounds, scaleX, scaleY); + + assertThat(getFloatField(bounds, "x")).isCloseTo(5.0f, within(0.01f)); + assertThat(getFloatField(bounds, "y")).isCloseTo(10.0f, within(0.01f)); + assertThat(getFloatField(bounds, "width")).isCloseTo(50.0f, within(0.01f)); + assertThat(getFloatField(bounds, "height")).isCloseTo(50.0f, within(0.01f)); + } + + @ParameterizedTest + @CsvSource({ + "0, 0, 100, 100, 1.0, 1.0", + "10, 20, 50, 80, 2.0, 2.0", + "5, 5, 25, 25, 0.5, 0.5" + }) + @DisplayName("Should handle various scale factors") + void shouldHandleVariousScaleFactors( + int x1, int y1, int x2, int y2, float scaleX, float scaleY) throws Exception { + int[] pixelBounds = {x1, y1, x2, y2}; + + Object bounds = fromPixelsMethod.invoke(null, pixelBounds, scaleX, scaleY); + + assertThat(bounds).isNotNull(); + assertThat(getFloatField(bounds, "width")).isGreaterThan(0); + assertThat(getFloatField(bounds, "height")).isGreaterThan(0); + } + + @Test + @DisplayName("Should throw exception for invalid pixel bounds array") + void shouldThrowExceptionForInvalidArray() { + int[] invalidBounds = {10, 20, 30}; + + assertThatThrownBy(() -> fromPixelsMethod.invoke(null, invalidBounds, 1.0f, 1.0f)) + .isInstanceOf(Exception.class) + .hasCauseInstanceOf(IllegalArgumentException.class) + .cause() + .hasMessageContaining("pixelBounds array must contain exactly 4 elements"); + } + + private float getFloatField(Object obj, String fieldName) throws Exception { + Method getter = cropBoundsClass.getDeclaredMethod(fieldName); + return (Float) getter.invoke(obj); + } + } + + @Nested + @DisplayName("Error Handling") + class ErrorHandlingTests { + + @Test + @DisplayName("Should throw exception for corrupt PDF file") + void shouldThrowExceptionForCorruptPdf() throws IOException { + MockMultipartFile corruptFile = + new MockMultipartFile( + "fileInput", + "corrupt.pdf", + MediaType.APPLICATION_PDF_VALUE, + "not a valid pdf content".getBytes()); + + CropPdfForm request = + new CropRequestBuilder() + .withFile(corruptFile) + .withCoordinates(50f, 50f, 512f, 692f) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + when(pdfDocumentFactory.load(request)).thenThrow(new IOException("Invalid PDF format")); + + assertThatThrownBy(() -> cropController.cropPdf(request)) + .isInstanceOf(IOException.class) + .hasMessageContaining("Invalid PDF format"); + + verify(pdfDocumentFactory).load(request); + } + + @Test + @DisplayName("Should throw exception when coordinates are missing for manual crop") + void shouldThrowExceptionForMissingCoordinates() throws IOException { + MockMultipartFile testFile = pdfFactory.createStandardPdf("test.pdf"); + CropPdfForm request = + new CropRequestBuilder().withFile(testFile).withAutoCrop(false).build(); + + assertThatThrownBy(() -> cropController.cropPdf(request)) + .isInstanceOf(IllegalArgumentException.class) + .hasMessage( + "Crop coordinates (x, y, width, height) are required when auto-crop is not enabled"); + } + + @Test + @DisplayName("Should handle negative coordinates gracefully") + void shouldHandleNegativeCoordinates() throws IOException { + MockMultipartFile testFile = pdfFactory.createStandardPdf("test.pdf"); + CropPdfForm request = + new CropRequestBuilder() + .withFile(testFile) + .withCoordinates(-10f, 50f, 512f, 692f) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + PDDocument mockDocument = mock(PDDocument.class); + PDDocument newDocument = mock(PDDocument.class); + when(pdfDocumentFactory.load(request)).thenReturn(mockDocument); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(mockDocument)) + .thenReturn(newDocument); + + assertThatCode(() -> cropController.cropPdf(request)).doesNotThrowAnyException(); + + verify(mockDocument, times(1)).close(); + verify(newDocument, times(1)).close(); + } + + @Test + @DisplayName("Should handle zero width or height") + void shouldHandleZeroDimensions() throws IOException { + MockMultipartFile testFile = pdfFactory.createStandardPdf("test.pdf"); + CropPdfForm request = + new CropRequestBuilder() + .withFile(testFile) + .withCoordinates(50f, 50f, 0f, 692f) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + PDDocument mockDocument = mock(PDDocument.class); + PDDocument newDocument = mock(PDDocument.class); + when(pdfDocumentFactory.load(request)).thenReturn(mockDocument); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(mockDocument)) + .thenReturn(newDocument); + + assertThatCode(() -> cropController.cropPdf(request)).doesNotThrowAnyException(); + + verify(mockDocument, times(1)).close(); + verify(newDocument, times(1)).close(); + } + } + + @Nested + @DisplayName("PDF Content Verification") + @Tag("integration") + class PdfContentVerificationTests { + + private static PDRectangle getPageSize(String name) { + return switch (name) { + case "LETTER" -> PDRectangle.LETTER; + case "A4" -> PDRectangle.A4; + case "LEGAL" -> PDRectangle.LEGAL; + default -> PDRectangle.LETTER; + }; + } + + @Test + @DisplayName("Should produce PDF with correct dimensions after crop") + void shouldProducePdfWithCorrectDimensions() throws IOException { + MockMultipartFile testFile = pdfFactory.createStandardPdf("test.pdf"); + float expectedWidth = 400f; + float expectedHeight = 500f; + + CropPdfForm request = + new CropRequestBuilder() + .withFile(testFile) + .withCoordinates(50f, 50f, expectedWidth, expectedHeight) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + PDDocument mockDocument = mock(PDDocument.class); + PDDocument newDocument = mock(PDDocument.class); + when(pdfDocumentFactory.load(request)).thenReturn(mockDocument); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(mockDocument)) + .thenReturn(newDocument); + + ResponseEntity response = cropController.cropPdf(request); + + assertThat(response).isNotNull(); + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + } + + @ParameterizedTest + @CsvSource({"test1.pdf, LETTER", "test2.pdf, A4", "test3.pdf, LEGAL"}) + @DisplayName("Should handle different page sizes") + void shouldHandleDifferentPageSizes(String filename, String pageSizeName) + throws IOException { + PDRectangle pageSize = getPageSize(pageSizeName); + MockMultipartFile testFile = pdfFactory.createPdfWithSize(filename, pageSize); + + CropPdfForm request = + new CropRequestBuilder() + .withFile(testFile) + .withCoordinates(50f, 50f, 300f, 400f) + .withRemoveDataOutsideCrop(false) + .withAutoCrop(false) + .build(); + + PDDocument mockDocument = mock(PDDocument.class); + PDDocument newDocument = mock(PDDocument.class); + when(pdfDocumentFactory.load(request)).thenReturn(mockDocument); + when(pdfDocumentFactory.createNewDocumentBasedOnOldDocument(mockDocument)) + .thenReturn(newDocument); + + ResponseEntity response = cropController.cropPdf(request); + + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + verify(mockDocument, times(1)).close(); + verify(newDocument, times(1)).close(); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/EditTableOfContentsControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/EditTableOfContentsControllerTest.java index d99c1eac33..6317a16a39 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/EditTableOfContentsControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/EditTableOfContentsControllerTest.java @@ -1,7 +1,6 @@ package stirling.software.SPDF.controller.api; import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; import java.io.ByteArrayOutputStream; @@ -24,7 +23,6 @@ import org.mockito.ArgumentMatchers; import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.junit.jupiter.MockitoExtension; -import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.mock.web.MockMultipartFile; @@ -87,13 +85,9 @@ class EditTableOfContentsControllerTest { when(mockOutlineItem.getNextSibling()).thenReturn(null); // When - ResponseEntity>> response = - editTableOfContentsController.extractBookmarks(mockFile); + List> result = editTableOfContentsController.extractBookmarks(mockFile); // Then - assertNotNull(response); - assertEquals(HttpStatus.OK, response.getStatusCode()); - List> result = response.getBody(); assertNotNull(result); assertEquals(1, result.size()); @@ -113,13 +107,9 @@ class EditTableOfContentsControllerTest { when(mockCatalog.getDocumentOutline()).thenReturn(null); // When - ResponseEntity>> response = - editTableOfContentsController.extractBookmarks(mockFile); + List> result = editTableOfContentsController.extractBookmarks(mockFile); // Then - assertNotNull(response); - assertEquals(HttpStatus.OK, response.getStatusCode()); - List> result = response.getBody(); assertNotNull(result); assertTrue(result.isEmpty()); verify(mockDocument).close(); @@ -151,13 +141,9 @@ class EditTableOfContentsControllerTest { when(childItem.getNextSibling()).thenReturn(null); // When - ResponseEntity>> response = - editTableOfContentsController.extractBookmarks(mockFile); + List> result = editTableOfContentsController.extractBookmarks(mockFile); // Then - assertNotNull(response); - assertEquals(HttpStatus.OK, response.getStatusCode()); - List> result = response.getBody(); assertNotNull(result); assertEquals(1, result.size()); @@ -191,13 +177,9 @@ class EditTableOfContentsControllerTest { when(mockOutlineItem.getNextSibling()).thenReturn(null); // When - ResponseEntity>> response = - editTableOfContentsController.extractBookmarks(mockFile); + List> result = editTableOfContentsController.extractBookmarks(mockFile); // Then - assertNotNull(response); - assertEquals(HttpStatus.OK, response.getStatusCode()); - List> result = response.getBody(); assertNotNull(result); assertEquals(1, result.size()); diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/MergeControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/MergeControllerTest.java index 3ed794233f..c245cffb09 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/MergeControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/MergeControllerTest.java @@ -1,8 +1,6 @@ package stirling.software.SPDF.controller.api; import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyInt; import static org.mockito.Mockito.*; import java.io.IOException; @@ -39,10 +37,8 @@ class MergeControllerTest { private MockMultipartFile mockFile1; private MockMultipartFile mockFile2; private MockMultipartFile mockFile3; - private PDDocument mockDocument; private PDDocument mockMergedDocument; private PDDocumentCatalog mockCatalog; - private PDPageTree mockPages; private PDPage mockPage1; private PDPage mockPage2; @@ -67,10 +63,10 @@ class MergeControllerTest { MediaType.APPLICATION_PDF_VALUE, "PDF content 3".getBytes()); - mockDocument = mock(PDDocument.class); + PDDocument mockDocument = mock(PDDocument.class); mockMergedDocument = mock(PDDocument.class); mockCatalog = mock(PDDocumentCatalog.class); - mockPages = mock(PDPageTree.class); + PDPageTree mockPages = mock(PDPageTree.class); mockPage1 = mock(PDPage.class); mockPage2 = mock(PDPage.class); } diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/RearrangePagesPDFControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/RearrangePagesPDFControllerTest.java index fcc0a7f0b3..e4fa16d706 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/RearrangePagesPDFControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/RearrangePagesPDFControllerTest.java @@ -1,20 +1,21 @@ package stirling.software.SPDF.controller.api; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.*; import java.util.Arrays; import java.util.List; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.CsvSource; import org.mockito.Mock; -import org.mockito.MockitoAnnotations; +import org.mockito.junit.jupiter.MockitoExtension; import stirling.software.common.service.CustomPDFDocumentFactory; +@ExtendWith({MockitoExtension.class}) class RearrangePagesPDFControllerTest { @Mock private CustomPDFDocumentFactory mockPdfDocumentFactory; @@ -23,7 +24,6 @@ class RearrangePagesPDFControllerTest { @BeforeEach void setUp() { - MockitoAnnotations.openMocks(this); sut = new RearrangePagesPDFController(mockPdfDocumentFactory); } diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/RotationControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/RotationControllerTest.java index 6ac0b45d33..ecdafc09a9 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/RotationControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/RotationControllerTest.java @@ -1,8 +1,6 @@ package stirling.software.SPDF.controller.api; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -61,7 +59,7 @@ public class RotationControllerTest { } @Test - public void testRotatePDFInvalidAngle() throws IOException { + public void testRotatePDFInvalidAngle() { // Create a mock file MockMultipartFile mockFile = new MockMultipartFile( diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertEbookToPDFControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertEbookToPDFControllerTest.java new file mode 100644 index 0000000000..95f0de648d --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertEbookToPDFControllerTest.java @@ -0,0 +1,266 @@ +package stirling.software.SPDF.controller.api.converters; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.when; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; +import java.util.List; +import java.util.concurrent.atomic.AtomicReference; +import java.util.stream.Stream; + +import org.apache.pdfbox.pdmodel.PDDocument; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.ArgumentCaptor; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.MockedStatic; +import org.mockito.Mockito; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.ResponseEntity; +import org.springframework.mock.web.MockMultipartFile; + +import stirling.software.SPDF.config.EndpointConfiguration; +import stirling.software.SPDF.model.api.converters.ConvertEbookToPdfRequest; +import stirling.software.common.service.CustomPDFDocumentFactory; +import stirling.software.common.util.GeneralUtils; +import stirling.software.common.util.ProcessExecutor; +import stirling.software.common.util.ProcessExecutor.ProcessExecutorResult; +import stirling.software.common.util.ProcessExecutor.Processes; +import stirling.software.common.util.TempFileManager; +import stirling.software.common.util.WebResponseUtils; + +@ExtendWith(MockitoExtension.class) +class ConvertEbookToPDFControllerTest { + + @Mock private CustomPDFDocumentFactory pdfDocumentFactory; + @Mock private TempFileManager tempFileManager; + @Mock private EndpointConfiguration endpointConfiguration; + + @InjectMocks private ConvertEbookToPDFController controller; + + @Test + void convertEbookToPdf_buildsCalibreCommandAndCleansUp() throws Exception { + when(endpointConfiguration.isGroupEnabled("Calibre")).thenReturn(true); + + MockMultipartFile ebookFile = + new MockMultipartFile( + "fileInput", "ebook.epub", "application/epub+zip", "content".getBytes()); + + ConvertEbookToPdfRequest request = new ConvertEbookToPdfRequest(); + request.setFileInput(ebookFile); + request.setEmbedAllFonts(true); + request.setIncludeTableOfContents(true); + request.setIncludePageNumbers(true); + + Path workingDir = Files.createTempDirectory("ebook-convert-test-"); + when(tempFileManager.createTempDirectory()).thenReturn(workingDir); + + AtomicReference deletedDir = new AtomicReference<>(); + Mockito.doAnswer( + invocation -> { + Path dir = invocation.getArgument(0); + deletedDir.set(dir); + if (Files.exists(dir)) { + try (Stream paths = Files.walk(dir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + return null; + }) + .when(tempFileManager) + .deleteTempDirectory(any(Path.class)); + + PDDocument mockDocument = Mockito.mock(PDDocument.class); + when(pdfDocumentFactory.load(any(File.class))).thenReturn(mockDocument); + + try (MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); + MockedStatic wr = Mockito.mockStatic(WebResponseUtils.class); + MockedStatic gu = Mockito.mockStatic(GeneralUtils.class)) { + + ProcessExecutor executor = Mockito.mock(ProcessExecutor.class); + pe.when(() -> ProcessExecutor.getInstance(Processes.CALIBRE)).thenReturn(executor); + + ProcessExecutorResult execResult = Mockito.mock(ProcessExecutorResult.class); + when(execResult.getRc()).thenReturn(0); + + @SuppressWarnings("unchecked") + ArgumentCaptor> commandCaptor = ArgumentCaptor.forClass(List.class); + Path expectedInput = workingDir.resolve("ebook.epub"); + Path expectedOutput = workingDir.resolve("ebook.pdf"); + when(executor.runCommandWithOutputHandling( + commandCaptor.capture(), eq(workingDir.toFile()))) + .thenAnswer( + invocation -> { + Files.writeString(expectedOutput, "pdf"); + return execResult; + }); + + ResponseEntity expectedResponse = ResponseEntity.ok("result".getBytes()); + wr.when( + () -> + WebResponseUtils.pdfDocToWebResponse( + mockDocument, "ebook_convertedToPDF.pdf")) + .thenReturn(expectedResponse); + gu.when(() -> GeneralUtils.generateFilename("ebook.epub", "_convertedToPDF.pdf")) + .thenReturn("ebook_convertedToPDF.pdf"); + + ResponseEntity response = controller.convertEbookToPdf(request); + + assertSame(expectedResponse, response); + + List command = commandCaptor.getValue(); + assertEquals(6, command.size()); + assertEquals("ebook-convert", command.get(0)); + assertEquals(expectedInput.toString(), command.get(1)); + assertEquals(expectedOutput.toString(), command.get(2)); + assertEquals("--embed-all-fonts", command.get(3)); + assertEquals("--pdf-add-toc", command.get(4)); + assertEquals("--pdf-page-numbers", command.get(5)); + + assertFalse(Files.exists(expectedInput)); + assertFalse(Files.exists(expectedOutput)); + assertEquals(workingDir, deletedDir.get()); + Mockito.verify(tempFileManager).deleteTempDirectory(workingDir); + } + + if (Files.exists(workingDir)) { + try (Stream paths = Files.walk(workingDir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + } + + @Test + void convertEbookToPdf_withUnsupportedExtensionThrows() { + when(endpointConfiguration.isGroupEnabled("Calibre")).thenReturn(true); + + MockMultipartFile unsupported = + new MockMultipartFile( + "fileInput", "ebook.exe", "application/octet-stream", new byte[] {1, 2, 3}); + + ConvertEbookToPdfRequest request = new ConvertEbookToPdfRequest(); + request.setFileInput(unsupported); + + assertThrows(IllegalArgumentException.class, () -> controller.convertEbookToPdf(request)); + } + + @Test + void convertEbookToPdf_withOptimizeForEbookUsesGhostscript() throws Exception { + when(endpointConfiguration.isGroupEnabled("Calibre")).thenReturn(true); + when(endpointConfiguration.isGroupEnabled("Ghostscript")).thenReturn(true); + + MockMultipartFile ebookFile = + new MockMultipartFile( + "fileInput", "ebook.epub", "application/epub+zip", "content".getBytes()); + + ConvertEbookToPdfRequest request = new ConvertEbookToPdfRequest(); + request.setFileInput(ebookFile); + request.setOptimizeForEbook(true); + + Path workingDir = Files.createTempDirectory("ebook-convert-opt-test-"); + when(tempFileManager.createTempDirectory()).thenReturn(workingDir); + + AtomicReference deletedDir = new AtomicReference<>(); + Mockito.doAnswer( + invocation -> { + Path dir = invocation.getArgument(0); + deletedDir.set(dir); + if (Files.exists(dir)) { + try (Stream paths = Files.walk(dir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + return null; + }) + .when(tempFileManager) + .deleteTempDirectory(any(Path.class)); + + try (MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); + MockedStatic gu = Mockito.mockStatic(GeneralUtils.class); + MockedStatic wr = Mockito.mockStatic(WebResponseUtils.class)) { + + ProcessExecutor executor = Mockito.mock(ProcessExecutor.class); + pe.when(() -> ProcessExecutor.getInstance(Processes.CALIBRE)).thenReturn(executor); + + ProcessExecutorResult execResult = Mockito.mock(ProcessExecutorResult.class); + when(execResult.getRc()).thenReturn(0); + + Path expectedInput = workingDir.resolve("ebook.epub"); + Path expectedOutput = workingDir.resolve("ebook.pdf"); + when(executor.runCommandWithOutputHandling(any(List.class), eq(workingDir.toFile()))) + .thenAnswer( + invocation -> { + Files.writeString(expectedOutput, "pdf"); + return execResult; + }); + + gu.when(() -> GeneralUtils.generateFilename("ebook.epub", "_convertedToPDF.pdf")) + .thenReturn("ebook_convertedToPDF.pdf"); + byte[] optimizedBytes = "optimized".getBytes(StandardCharsets.UTF_8); + gu.when(() -> GeneralUtils.optimizePdfWithGhostscript(Mockito.any(byte[].class))) + .thenReturn(optimizedBytes); + + ResponseEntity expectedResponse = ResponseEntity.ok(optimizedBytes); + wr.when( + () -> + WebResponseUtils.bytesToWebResponse( + optimizedBytes, "ebook_convertedToPDF.pdf")) + .thenReturn(expectedResponse); + + ResponseEntity response = controller.convertEbookToPdf(request); + + assertSame(expectedResponse, response); + gu.verify(() -> GeneralUtils.optimizePdfWithGhostscript(Mockito.any(byte[].class))); + Mockito.verifyNoInteractions(pdfDocumentFactory); + Mockito.verify(tempFileManager).deleteTempDirectory(workingDir); + assertEquals(workingDir, deletedDir.get()); + assertFalse(Files.exists(expectedInput)); + assertFalse(Files.exists(expectedOutput)); + } + + if (Files.exists(workingDir)) { + try (Stream paths = Files.walk(workingDir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToEpubControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToEpubControllerTest.java new file mode 100644 index 0000000000..82aeed070c --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToEpubControllerTest.java @@ -0,0 +1,328 @@ +package stirling.software.SPDF.controller.api.converters; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; +import java.util.List; +import java.util.concurrent.atomic.AtomicReference; +import java.util.stream.Stream; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.ArgumentCaptor; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.MockedStatic; +import org.mockito.Mockito; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.mock.web.MockMultipartFile; + +import stirling.software.SPDF.config.EndpointConfiguration; +import stirling.software.SPDF.model.api.converters.ConvertPdfToEpubRequest; +import stirling.software.SPDF.model.api.converters.ConvertPdfToEpubRequest.OutputFormat; +import stirling.software.SPDF.model.api.converters.ConvertPdfToEpubRequest.TargetDevice; +import stirling.software.common.util.GeneralUtils; +import stirling.software.common.util.ProcessExecutor; +import stirling.software.common.util.ProcessExecutor.ProcessExecutorResult; +import stirling.software.common.util.ProcessExecutor.Processes; +import stirling.software.common.util.TempFileManager; + +@ExtendWith(MockitoExtension.class) +class ConvertPDFToEpubControllerTest { + + private static final MediaType EPUB_MEDIA_TYPE = MediaType.valueOf("application/epub+zip"); + + @Mock private TempFileManager tempFileManager; + @Mock private EndpointConfiguration endpointConfiguration; + + @InjectMocks private ConvertPDFToEpubController controller; + + @Test + void convertPdfToEpub_buildsGoldenCommandAndCleansUp() throws Exception { + when(endpointConfiguration.isGroupEnabled("Calibre")).thenReturn(true); + + MockMultipartFile pdfFile = + new MockMultipartFile( + "fileInput", "novel.pdf", "application/pdf", "content".getBytes()); + + ConvertPdfToEpubRequest request = new ConvertPdfToEpubRequest(); + request.setFileInput(pdfFile); + + Path workingDir = Files.createTempDirectory("pdf-epub-test-"); + when(tempFileManager.createTempDirectory()).thenReturn(workingDir); + + AtomicReference deletedDir = new AtomicReference<>(); + doAnswer( + invocation -> { + Path dir = invocation.getArgument(0); + deletedDir.set(dir); + if (Files.exists(dir)) { + try (Stream paths = Files.walk(dir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + return null; + }) + .when(tempFileManager) + .deleteTempDirectory(any(Path.class)); + + try (MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); + MockedStatic gu = Mockito.mockStatic(GeneralUtils.class)) { + + ProcessExecutor executor = mock(ProcessExecutor.class); + pe.when(() -> ProcessExecutor.getInstance(Processes.CALIBRE)).thenReturn(executor); + + ProcessExecutorResult execResult = mock(ProcessExecutorResult.class); + when(execResult.getRc()).thenReturn(0); + + @SuppressWarnings("unchecked") + ArgumentCaptor> commandCaptor = ArgumentCaptor.forClass(List.class); + Path expectedInput = workingDir.resolve("novel.pdf"); + Path expectedOutput = workingDir.resolve("novel.epub"); + + when(executor.runCommandWithOutputHandling( + commandCaptor.capture(), eq(workingDir.toFile()))) + .thenAnswer( + invocation -> { + Files.writeString(expectedOutput, "epub"); + return execResult; + }); + + gu.when(() -> GeneralUtils.generateFilename("novel.pdf", "_convertedToEPUB.epub")) + .thenReturn("novel_convertedToEPUB.epub"); + ResponseEntity response = controller.convertPdfToEpub(request); + + List command = commandCaptor.getValue(); + assertEquals(11, command.size()); + assertEquals("ebook-convert", command.get(0)); + assertEquals(expectedInput.toString(), command.get(1)); + assertEquals(expectedOutput.toString(), command.get(2)); + assertTrue(command.contains("--enable-heuristics")); + assertTrue(command.contains("--insert-blank-line")); + assertTrue(command.contains("--filter-css")); + assertTrue( + command.contains( + "font-family,color,background-color,margin-left,margin-right")); + assertTrue(command.contains("--chapter")); + assertTrue(command.stream().anyMatch(arg -> arg.contains("Chapter\\s+"))); + assertTrue(command.contains("--output-profile")); + assertTrue(command.contains(TargetDevice.TABLET_PHONE_IMAGES.getCalibreProfile())); + + assertEquals(EPUB_MEDIA_TYPE, response.getHeaders().getContentType()); + assertEquals( + "novel_convertedToEPUB.epub", + response.getHeaders().getContentDisposition().getFilename()); + assertEquals("epub", new String(response.getBody(), StandardCharsets.UTF_8)); + + verify(tempFileManager).deleteTempDirectory(workingDir); + assertEquals(workingDir, deletedDir.get()); + } finally { + deleteIfExists(workingDir); + } + } + + @Test + void convertPdfToEpub_respectsOptions() throws Exception { + when(endpointConfiguration.isGroupEnabled("Calibre")).thenReturn(true); + + MockMultipartFile pdfFile = + new MockMultipartFile( + "fileInput", "story.pdf", "application/pdf", "content".getBytes()); + + ConvertPdfToEpubRequest request = new ConvertPdfToEpubRequest(); + request.setFileInput(pdfFile); + request.setDetectChapters(false); + request.setTargetDevice(TargetDevice.KINDLE_EINK_TEXT); + + Path workingDir = Files.createTempDirectory("pdf-epub-options-test-"); + when(tempFileManager.createTempDirectory()).thenReturn(workingDir); + + doAnswer( + invocation -> { + Path dir = invocation.getArgument(0); + if (Files.exists(dir)) { + try (Stream paths = Files.walk(dir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + return null; + }) + .when(tempFileManager) + .deleteTempDirectory(any(Path.class)); + + try (MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); + MockedStatic gu = Mockito.mockStatic(GeneralUtils.class)) { + + ProcessExecutor executor = mock(ProcessExecutor.class); + pe.when(() -> ProcessExecutor.getInstance(Processes.CALIBRE)).thenReturn(executor); + + ProcessExecutorResult execResult = mock(ProcessExecutorResult.class); + when(execResult.getRc()).thenReturn(0); + + @SuppressWarnings("unchecked") + ArgumentCaptor> commandCaptor = ArgumentCaptor.forClass(List.class); + Path expectedOutput = workingDir.resolve("story.epub"); + + when(executor.runCommandWithOutputHandling( + commandCaptor.capture(), eq(workingDir.toFile()))) + .thenAnswer( + invocation -> { + Files.writeString(expectedOutput, "epub"); + return execResult; + }); + + gu.when(() -> GeneralUtils.generateFilename("story.pdf", "_convertedToEPUB.epub")) + .thenReturn("story_convertedToEPUB.epub"); + ResponseEntity response = controller.convertPdfToEpub(request); + + List command = commandCaptor.getValue(); + assertTrue(command.stream().noneMatch(arg -> "--chapter".equals(arg))); + assertTrue(command.contains("--output-profile")); + assertTrue(command.contains(TargetDevice.KINDLE_EINK_TEXT.getCalibreProfile())); + assertTrue(command.contains("--filter-css")); + assertTrue( + command.contains( + "font-family,color,background-color,margin-left,margin-right")); + assertTrue(command.size() >= 9); + + assertEquals(EPUB_MEDIA_TYPE, response.getHeaders().getContentType()); + assertEquals( + "story_convertedToEPUB.epub", + response.getHeaders().getContentDisposition().getFilename()); + assertEquals("epub", new String(response.getBody(), StandardCharsets.UTF_8)); + } finally { + deleteIfExists(workingDir); + } + } + + @Test + void convertPdfToAzw3_buildsCorrectCommandAndOutput() throws Exception { + when(endpointConfiguration.isGroupEnabled("Calibre")).thenReturn(true); + + MockMultipartFile pdfFile = + new MockMultipartFile( + "fileInput", "book.pdf", "application/pdf", "content".getBytes()); + + ConvertPdfToEpubRequest request = new ConvertPdfToEpubRequest(); + request.setFileInput(pdfFile); + request.setOutputFormat(OutputFormat.AZW3); + request.setDetectChapters(false); + request.setTargetDevice(TargetDevice.KINDLE_EINK_TEXT); + + Path workingDir = Files.createTempDirectory("pdf-azw3-test-"); + when(tempFileManager.createTempDirectory()).thenReturn(workingDir); + + doAnswer( + invocation -> { + Path dir = invocation.getArgument(0); + if (Files.exists(dir)) { + try (Stream paths = Files.walk(dir)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + return null; + }) + .when(tempFileManager) + .deleteTempDirectory(any(Path.class)); + + try (MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); + MockedStatic gu = Mockito.mockStatic(GeneralUtils.class)) { + + ProcessExecutor executor = mock(ProcessExecutor.class); + pe.when(() -> ProcessExecutor.getInstance(Processes.CALIBRE)).thenReturn(executor); + + ProcessExecutorResult execResult = mock(ProcessExecutorResult.class); + when(execResult.getRc()).thenReturn(0); + + @SuppressWarnings("unchecked") + ArgumentCaptor> commandCaptor = ArgumentCaptor.forClass(List.class); + Path expectedInput = workingDir.resolve("book.pdf"); + Path expectedOutput = workingDir.resolve("book.azw3"); + + when(executor.runCommandWithOutputHandling( + commandCaptor.capture(), eq(workingDir.toFile()))) + .thenAnswer( + invocation -> { + Files.writeString(expectedOutput, "azw3"); + return execResult; + }); + + gu.when(() -> GeneralUtils.generateFilename("book.pdf", "_convertedToAZW3.azw3")) + .thenReturn("book_convertedToAZW3.azw3"); + ResponseEntity response = controller.convertPdfToEpub(request); + + List command = commandCaptor.getValue(); + assertEquals("ebook-convert", command.get(0)); + assertEquals(expectedInput.toString(), command.get(1)); + assertEquals(expectedOutput.toString(), command.get(2)); + assertTrue(command.contains("--enable-heuristics")); + assertTrue(command.contains("--insert-blank-line")); + assertTrue(command.contains("--filter-css")); + assertTrue(command.stream().noneMatch(arg -> "--chapter".equals(arg))); + assertTrue(command.contains("--output-profile")); + assertTrue(command.contains(TargetDevice.KINDLE_EINK_TEXT.getCalibreProfile())); + + assertEquals( + MediaType.valueOf("application/vnd.amazon.ebook"), + response.getHeaders().getContentType()); + assertEquals( + "book_convertedToAZW3.azw3", + response.getHeaders().getContentDisposition().getFilename()); + assertEquals("azw3", new String(response.getBody(), StandardCharsets.UTF_8)); + + verify(tempFileManager).deleteTempDirectory(workingDir); + } finally { + deleteIfExists(workingDir); + } + } + + private void deleteIfExists(Path directory) throws IOException { + if (directory == null || !Files.exists(directory)) { + return; + } + try (Stream paths = Files.walk(directory)) { + paths.sorted(Comparator.reverseOrder()) + .forEach( + path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToPDFATest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToPDFATest.java new file mode 100644 index 0000000000..300ccb239a --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertPDFToPDFATest.java @@ -0,0 +1,571 @@ +package stirling.software.SPDF.controller.api.converters; + +import static org.assertj.core.api.Assertions.*; +import static org.junit.jupiter.api.Assertions.*; + +import java.awt.Color; +import java.awt.image.BufferedImage; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.lang.reflect.Method; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.*; + +import org.apache.pdfbox.cos.*; +import org.apache.pdfbox.pdmodel.PDDocument; +import org.apache.pdfbox.pdmodel.PDDocumentInformation; +import org.apache.pdfbox.pdmodel.PDPage; +import org.apache.pdfbox.pdmodel.PDPageContentStream; +import org.apache.pdfbox.pdmodel.common.PDMetadata; +import org.apache.pdfbox.pdmodel.common.PDRectangle; +import org.apache.pdfbox.pdmodel.font.PDType1Font; +import org.apache.pdfbox.pdmodel.font.Standard14Fonts; +import org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent; +import org.apache.pdfbox.pdmodel.graphics.image.LosslessFactory; +import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject; +import org.apache.pdfbox.preflight.ValidationResult; +import org.apache.xmpbox.XMPMetadata; +import org.apache.xmpbox.schema.DublinCoreSchema; +import org.apache.xmpbox.schema.PDFAIdentificationSchema; +import org.apache.xmpbox.schema.XMPBasicSchema; +import org.apache.xmpbox.xml.DomXmpParser; +import org.apache.xmpbox.xml.XmpSerializer; +import org.junit.jupiter.api.*; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.io.TempDir; +import org.mockito.junit.jupiter.MockitoExtension; + +@DisplayName("PDF to PDF/A Converter Tests") +@ExtendWith(MockitoExtension.class) +class ConvertPDFToPDFATest { + + @TempDir Path tempDir; + + @SuppressWarnings("unchecked") + private static T invokePrivateMethod(String methodName, Object... args) throws Exception { + Class[] paramTypes = new Class[args.length]; + for (int i = 0; i < args.length; i++) { + if (args[i] == null) { + paramTypes[i] = Object.class; + } else if (args[i] instanceof Integer) { + paramTypes[i] = int.class; + } else if (args[i] instanceof Boolean) { + paramTypes[i] = boolean.class; + } else { + paramTypes[i] = args[i].getClass(); + } + } + + try { + Method method = ConvertPDFToPDFA.class.getDeclaredMethod(methodName, paramTypes); + method.setAccessible(true); + return (T) method.invoke(null, args); + } catch (NoSuchMethodException e) { + for (Method method : ConvertPDFToPDFA.class.getDeclaredMethods()) { + if (method.getName().equals(methodName) + && method.getParameterCount() == args.length) { + method.setAccessible(true); + return (T) method.invoke(null, args); + } + } + throw e; + } + } + + private PDDocument createSimplePdf() throws IOException { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + document.addPage(page); + + try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) { + contentStream.beginText(); + contentStream.setFont(new PDType1Font(Standard14Fonts.FontName.HELVETICA), 12); + contentStream.newLineAtOffset(100, 700); + contentStream.showText("Test PDF Document"); + contentStream.endText(); + } + + return document; + } + + private PDDocument createPdfWithMetadata(String title, String author, String creator) + throws IOException { + PDDocument document = createSimplePdf(); + + PDDocumentInformation info = new PDDocumentInformation(); + info.setTitle(title); + info.setAuthor(author); + info.setCreator(creator); + info.setSubject("Test Subject"); + info.setKeywords("test, pdf, metadata"); + info.setProducer("Test Producer"); + + GregorianCalendar cal = new GregorianCalendar(2024, Calendar.JANUARY, 1); + info.setCreationDate(cal); + info.setModificationDate(cal); + + document.setDocumentInformation(info); + return document; + } + + private PDDocument createPdfWithTransparency() throws IOException { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + document.addPage(page); + + BufferedImage bufferedImage = new BufferedImage(100, 100, BufferedImage.TYPE_INT_ARGB); + java.awt.Graphics2D g2d = bufferedImage.createGraphics(); + g2d.setColor(new Color(255, 0, 0, 128)); // Semi-transparent red + g2d.fillRect(0, 0, 100, 100); + g2d.dispose(); + + PDImageXObject image = LosslessFactory.createFromImage(document, bufferedImage); + + try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) { + contentStream.drawImage(image, 100, 600, 100, 100); + } + + return document; + } + + private PDDocument createPdfWithXmpMetadata(int pdfaPart) throws Exception { + PDDocument document = createSimplePdf(); + + XMPMetadata xmp = XMPMetadata.createXMPMetadata(); + + PDFAIdentificationSchema pdfaSchema = xmp.createAndAddPDFAIdentificationSchema(); + pdfaSchema.setPart(pdfaPart); + pdfaSchema.setConformance("B"); + + DublinCoreSchema dcSchema = xmp.createAndAddDublinCoreSchema(); + dcSchema.addCreator("Test Creator"); + dcSchema.setTitle("Test Title"); + + XMPBasicSchema xmpBasicSchema = xmp.createAndAddXMPBasicSchema(); + xmpBasicSchema.setCreatorTool("Test Tool"); + + ByteArrayOutputStream xmpStream = new ByteArrayOutputStream(); + new XmpSerializer().serialize(xmp, xmpStream, true); + + PDMetadata metadata = new PDMetadata(document); + metadata.importXMPMetadata(xmpStream.toByteArray()); + + document.getDocumentCatalog().setMetadata(metadata); + + return document; + } + + @Nested + @DisplayName("XMP Metadata Operations") + class XmpMetadataTests { + + @Test + @DisplayName("Should add PDF/A-1 identification schema to XMP metadata") + void shouldAddPdfA1IdentificationSchema() throws Exception { + PDDocument document = createPdfWithMetadata("Test PDF", "Test Author", "Test Creator"); + + invokePrivateMethod("mergeAndAddXmpMetadata", document, 1); + + PDMetadata metadata = document.getDocumentCatalog().getMetadata(); + assertThat(metadata).isNotNull(); + + try (InputStream is = metadata.createInputStream()) { + DomXmpParser parser = new DomXmpParser(); + XMPMetadata xmp = parser.parse(is); + + PDFAIdentificationSchema pdfaSchema = + (PDFAIdentificationSchema) xmp.getSchema(PDFAIdentificationSchema.class); + assertThat(pdfaSchema).isNotNull(); + assertThat(pdfaSchema.getPart()).isEqualTo(1); + assertThat(pdfaSchema.getConformance()).isEqualTo("B"); + } + + document.close(); + } + + @Test + @DisplayName("Should add PDF/A-2 identification schema to XMP metadata") + void shouldAddPdfA2IdentificationSchema() throws Exception { + PDDocument document = createSimplePdf(); + + invokePrivateMethod("mergeAndAddXmpMetadata", document, 2); + + PDMetadata metadata = document.getDocumentCatalog().getMetadata(); + try (InputStream is = metadata.createInputStream()) { + DomXmpParser parser = new DomXmpParser(); + XMPMetadata xmp = parser.parse(is); + + PDFAIdentificationSchema pdfaSchema = + (PDFAIdentificationSchema) xmp.getSchema(PDFAIdentificationSchema.class); + assertThat(pdfaSchema.getPart()).isEqualTo(2); + assertThat(pdfaSchema.getConformance()).isEqualTo("B"); + } + + document.close(); + } + + @Test + @DisplayName("Should preserve Dublin Core creator information") + void shouldPreserveDublinCoreCreatorInformation() throws Exception { + PDDocument document = + createPdfWithMetadata("Test PDF", "Test Author", "Original Creator"); + + invokePrivateMethod("mergeAndAddXmpMetadata", document, 1); + + PDMetadata metadata = document.getDocumentCatalog().getMetadata(); + try (InputStream is = metadata.createInputStream()) { + DomXmpParser parser = new DomXmpParser(); + XMPMetadata xmp = parser.parse(is); + + DublinCoreSchema dcSchema = xmp.getDublinCoreSchema(); + assertThat(dcSchema).isNotNull(); + assertThat(dcSchema.getCreators()).contains("Original Creator"); + } + + document.close(); + } + + @Test + @DisplayName("Should set creation and modification timestamps") + void shouldSetCreationAndModificationTimestamps() throws Exception { + PDDocument document = createSimplePdf(); + + invokePrivateMethod("mergeAndAddXmpMetadata", document, 1); + + PDDocumentInformation info = document.getDocumentInformation(); + assertThat(info.getCreationDate()).isNotNull(); + assertThat(info.getModificationDate()).isNotNull(); + + document.close(); + } + + @Test + @DisplayName("Should handle existing XMP metadata gracefully") + void shouldHandleExistingXmpMetadata() throws Exception { + PDDocument document = createPdfWithXmpMetadata(1); + + invokePrivateMethod("mergeAndAddXmpMetadata", document, 2); + + PDMetadata metadata = document.getDocumentCatalog().getMetadata(); + try (InputStream is = metadata.createInputStream()) { + DomXmpParser parser = new DomXmpParser(); + XMPMetadata xmp = parser.parse(is); + + PDFAIdentificationSchema pdfaSchema = + (PDFAIdentificationSchema) xmp.getSchema(PDFAIdentificationSchema.class); + assertThat(pdfaSchema.getPart()).isEqualTo(2); + } + + document.close(); + } + } + + @Nested + @DisplayName("Content Sanitization") + class ContentSanitizationTests { + + @Test + @DisplayName("Should verify COSDictionary JavaScript removal logic") + void shouldVerifyJavaScriptRemovalLogic() throws Exception { + COSDictionary dict = new COSDictionary(); + dict.setString(COSName.JAVA_SCRIPT, "app.alert('test');"); + dict.setString(COSName.getPDFName("JS"), "some_js_code"); + + assertThat(dict.containsKey(COSName.JAVA_SCRIPT)).isTrue(); + assertThat(dict.containsKey(COSName.getPDFName("JS"))).isTrue(); + + invokePrivateMethod("sanitizePdfA", dict, 1); + + assertThat(dict.containsKey(COSName.JAVA_SCRIPT)).isFalse(); + assertThat(dict.containsKey(COSName.getPDFName("JS"))).isFalse(); + } + + @Test + @DisplayName("Should verify interpolation is set to false") + void shouldVerifyInterpolationSetToFalse() throws Exception { + COSDictionary dict = new COSDictionary(); + dict.setBoolean(COSName.INTERPOLATE, true); + + assertThat(dict.getBoolean(COSName.INTERPOLATE, false)).isTrue(); + + invokePrivateMethod("sanitizePdfA", dict, 1); + + assertThat(dict.getBoolean(COSName.INTERPOLATE, true)).isFalse(); + } + + @Test + @DisplayName("Should verify SMask removal for PDF/A-1") + void shouldVerifySMaskRemovalForPdfA1() throws Exception { + COSDictionary dict = new COSDictionary(); + dict.setItem(COSName.SMASK, new COSArray()); + + assertThat(dict.containsKey(COSName.SMASK)).isTrue(); + + invokePrivateMethod("sanitizePdfA", dict, 1); + + assertThat(dict.containsKey(COSName.SMASK)).isFalse(); + } + + @Test + @DisplayName("Should verify transparency group removal for PDF/A-1") + void shouldVerifyTransparencyGroupRemovalForPdfA1() throws Exception { + COSDictionary dict = new COSDictionary(); + COSDictionary groupDict = new COSDictionary(); + groupDict.setItem(COSName.S, COSName.TRANSPARENCY); + dict.setItem(COSName.GROUP, groupDict); + + assertThat(dict.containsKey(COSName.GROUP)).isTrue(); + + invokePrivateMethod("sanitizePdfA", dict, 1); + + assertThat(dict.containsKey(COSName.GROUP)).isFalse(); + } + + @Test + @DisplayName("Should verify forbidden elements are removed") + void shouldVerifyForbiddenElementsRemoved() throws Exception { + COSDictionary dict = new COSDictionary(); + dict.setItem(COSName.URI, COSName.A); + dict.setItem(COSName.EMBEDDED_FILES, new COSArray()); + dict.setItem(COSName.FILESPEC, new COSDictionary()); + dict.setItem(COSName.getPDFName("RichMedia"), new COSDictionary()); + + assertThat(dict.containsKey(COSName.URI)).isTrue(); + assertThat(dict.containsKey(COSName.EMBEDDED_FILES)).isTrue(); + + invokePrivateMethod("sanitizePdfA", dict, 1); + + assertThat(dict.containsKey(COSName.URI)).isFalse(); + assertThat(dict.containsKey(COSName.EMBEDDED_FILES)).isFalse(); + assertThat(dict.containsKey(COSName.FILESPEC)).isFalse(); + assertThat(dict.containsKey(COSName.getPDFName("RichMedia"))).isFalse(); + } + } + + @Nested + @DisplayName("Transparency Detection") + class TransparencyDetectionTests { + + @Test + @DisplayName("Should detect SMask transparency") + void shouldDetectSMaskTransparency() throws Exception { + PDDocument document = createPdfWithTransparency(); + + boolean hasTransparency = invokePrivateMethod("hasTransparentImages", document); + + assertThat(hasTransparency).isTrue(); + + document.close(); + } + + @Test + @DisplayName("Should not detect transparency in opaque images") + void shouldNotDetectTransparencyInOpaqueImages() throws Exception { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + document.addPage(page); + + BufferedImage bufferedImage = new BufferedImage(100, 100, BufferedImage.TYPE_INT_RGB); + java.awt.Graphics2D g2d = bufferedImage.createGraphics(); + g2d.setColor(Color.RED); + g2d.fillRect(0, 0, 100, 100); + g2d.dispose(); + + PDImageXObject image = LosslessFactory.createFromImage(document, bufferedImage); + + try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) { + contentStream.drawImage(image, 100, 600, 100, 100); + } + + boolean hasTransparency = invokePrivateMethod("hasTransparentImages", document); + + assertThat(hasTransparency).isFalse(); + + document.close(); + } + + @Test + @DisplayName("Should detect interpolation flag") + void shouldDetectInterpolationFlag() throws Exception { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + document.addPage(page); + + BufferedImage bufferedImage = new BufferedImage(100, 100, BufferedImage.TYPE_INT_RGB); + PDImageXObject image = LosslessFactory.createFromImage(document, bufferedImage); + image.setInterpolate(true); + + try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) { + contentStream.drawImage(image, 100, 600); + } + + boolean hasTransparency = invokePrivateMethod("hasTransparentImages", document); + + assertThat(hasTransparency).isTrue(); + + document.close(); + } + } + + @Nested + @DisplayName("Color Profile Management") + class ColorProfileTests { + + @Test + @DisplayName("Should verify ICC profile can be loaded from resources") + void shouldVerifyIccProfileCanBeLoadedFromResources() throws Exception { + try (InputStream iccStream = getClass().getResourceAsStream("/icc/sRGB2014.icc")) { + assertThat(iccStream).isNotNull(); + byte[] iccData = iccStream.readAllBytes(); + assertThat(iccData).isNotEmpty(); + assertThat(iccData).hasSizeGreaterThan(1000); + } + } + + @Test + @DisplayName("Should create color profile output intent structure") + void shouldCreateColorProfileOutputIntentStructure() throws Exception { + PDDocument document = createSimplePdf(); + try (InputStream iccStream = getClass().getResourceAsStream("/icc/sRGB2014.icc")) { + if (iccStream != null) { + PDOutputIntent outputIntent = new PDOutputIntent(document, iccStream); + outputIntent.setInfo("sRGB IEC61966-2.1"); + outputIntent.setOutputCondition("sRGB"); + outputIntent.setOutputConditionIdentifier("sRGB IEC61966-2.1"); + outputIntent.setRegistryName("http://www.color.org"); + + document.getDocumentCatalog().addOutputIntent(outputIntent); + + assertThat(document.getDocumentCatalog().getOutputIntents()).hasSize(1); + PDOutputIntent retrieved = + document.getDocumentCatalog().getOutputIntents().get(0); + assertThat(retrieved.getInfo()).contains("sRGB"); + } + } + + document.close(); + } + } + + @Nested + @DisplayName("Validation") + class ValidationTests { + + @Test + @DisplayName("Should format validation errors correctly") + void shouldFormatValidationErrorsCorrectly() { + String errorCode = "ERROR_CODE_123"; + String errorDetails = "Missing XMP metadata"; + + assertThat(errorCode).isNotBlank(); + assertThat(errorDetails).contains("XMP"); + assertThat(errorCode).startsWith("ERROR"); + } + + @Test + @DisplayName("Should handle validation error details") + void shouldHandleValidationErrorDetails() { + String error1Code = "1.2.3"; + String error1Detail = "Font not embedded"; + String error2Detail = "Missing color profile"; + + assertThat(error1Code).matches("\\d+\\.\\d+\\.\\d+"); + assertThat(error1Detail).contains("Font"); + assertThat(error2Detail).contains("color profile"); + } + + @Test + @DisplayName("Should create validation result with errors") + void shouldCreateValidationResultWithErrors() { + ValidationResult result = new ValidationResult(false); + + assertThat(result.isValid()).isFalse(); + assertThat(result.getErrorsList()).isNotNull(); + } + } + + @Nested + @DisplayName("Helper Methods") + class HelperMethodsTests { + + @Test + @DisplayName("Should build standard Type1 glyph set") + void shouldBuildStandardType1GlyphSet() throws Exception { + String glyphSet = invokePrivateMethod("buildStandardType1GlyphSet"); + + assertThat(glyphSet).isNotBlank().contains("space", "A", "a", "zero", "period"); + } + + @Test + @DisplayName("Should delete directory recursively") + void shouldDeleteDirectoryRecursively() throws Exception { + Path testDir = tempDir.resolve("test_delete"); + Files.createDirectories(testDir); + Path subDir = testDir.resolve("subdir"); + Files.createDirectories(subDir); + Files.createFile(testDir.resolve("file1.txt")); + Files.createFile(subDir.resolve("file2.txt")); + + assertThat(Files.exists(testDir)).isTrue(); + + invokePrivateMethod("deleteQuietly", testDir); + + assertThat(Files.exists(testDir)).isFalse(); + } + + @Test + @DisplayName("Should handle null path in deleteQuietly") + void shouldHandleNullPathInDeleteQuietly() { + assertDoesNotThrow(() -> invokePrivateMethod("deleteQuietly", (Path) null)); + } + + @Test + @DisplayName("Should handle non-existent path in deleteQuietly") + void shouldHandleNonExistentPathInDeleteQuietly() { + Path nonExistent = tempDir.resolve("non_existent_dir"); + + assertDoesNotThrow(() -> invokePrivateMethod("deleteQuietly", nonExistent)); + } + } + + @Nested + @DisplayName("Error Handling") + class ErrorHandlingTests { + + @Test + @DisplayName("Should handle empty PDF document") + void shouldHandleEmptyPdfDocument() { + PDDocument document = new PDDocument(); + + assertDoesNotThrow( + () -> { + invokePrivateMethod("mergeAndAddXmpMetadata", document, 1); + document.close(); + }); + } + + @Test + @DisplayName("Should handle PDF with no resources") + void shouldHandlePdfWithNoResources() throws Exception { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + document.addPage(page); + + assertThat(page.getResources()).isNull(); + + COSDictionary simpleDict = new COSDictionary(); + simpleDict.setItem(COSName.JAVA_SCRIPT, COSName.A); + + assertDoesNotThrow( + () -> { + invokePrivateMethod("sanitizePdfA", simpleDict, 1); + }); + + assertThat(simpleDict.containsKey(COSName.JAVA_SCRIPT)).isFalse(); + + document.close(); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertWebsiteToPdfTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertWebsiteToPdfTest.java index a51dad6a78..8b5c38055a 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertWebsiteToPdfTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/ConvertWebsiteToPdfTest.java @@ -3,14 +3,19 @@ package stirling.software.SPDF.controller.api.converters; import static org.junit.jupiter.api.Assertions.*; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.when; import java.io.File; import java.io.IOException; import java.lang.reflect.Method; import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; import java.nio.file.Files; import java.nio.file.Path; +import java.time.Duration; import java.util.List; import org.apache.pdfbox.pdmodel.PDDocument; @@ -51,18 +56,18 @@ public class ConvertWebsiteToPdfTest { void setUp() throws Exception { mocks = MockitoAnnotations.openMocks(this); - // Feature einschalten (ggf. Struktur an dein Projekt anpassen) + // Enable feature (adjust structure for your project if necessary) applicationProperties = new ApplicationProperties(); applicationProperties.getSystem().setEnableUrlToPDF(true); - // Stubs, falls der Code weiterlaufen sollte + // Stubs in case the code continues to run when(runtimePathConfig.getWeasyPrintPath()).thenReturn("/usr/bin/weasyprint"); when(pdfDocumentFactory.load(any(File.class))).thenReturn(new PDDocument()); - // SUT bauen + // Build SUT sut = new ConvertWebsiteToPDF(pdfDocumentFactory, runtimePathConfig, applicationProperties); - // RequestContext für ServletUriComponentsBuilder bereitstellen + // Provide RequestContext for ServletUriComponentsBuilder MockHttpServletRequest req = new MockHttpServletRequest(); req.setScheme("http"); req.setServerName("localhost"); @@ -94,7 +99,7 @@ public class ConvertWebsiteToPdfTest { @Test void redirect_with_error_when_url_is_not_reachable() throws Exception { UrlToPdfRequest request = new UrlToPdfRequest(); - // .invalid ist per RFC reserviert und nicht auflösbar + // .invalid is reserved by RFC and not resolvable request.setUrlInput("https://nonexistent.invalid/"); ResponseEntity resp = sut.urlToPdf(request); @@ -109,7 +114,7 @@ public class ConvertWebsiteToPdfTest { @Test void redirect_with_error_when_endpoint_disabled() throws Exception { - // Feature deaktivieren + // Disable feature applicationProperties.getSystem().setEnableUrlToPDF(false); UrlToPdfRequest request = new UrlToPdfRequest(); @@ -135,9 +140,9 @@ public class ConvertWebsiteToPdfTest { String out = (String) m.invoke(sut, in); assertTrue(out.endsWith(".pdf")); - // Nur A–Z, a–z, 0–9, Unterstrich und Punkt erlaubt + // Only A–Z, a–z, 0–9, underscore and dot allowed assertTrue(out.matches("[A-Za-z0-9_]+\\.pdf")); - // keine Truncation hier (Quelle ist nicht so lang) + // no truncation here (source not that long) assertTrue(out.length() <= 54); } @@ -147,14 +152,14 @@ public class ConvertWebsiteToPdfTest { ConvertWebsiteToPDF.class.getDeclaredMethod("convertURLToFileName", String.class); m.setAccessible(true); - // Sehr lange URL → löst Truncation aus + // Very long URL -> triggers truncation String longUrl = "https://very-very-long-domain.example.com/some/really/long/path/with?many=params&and=chars"; String out = (String) m.invoke(sut, longUrl); assertTrue(out.endsWith(".pdf")); assertTrue(out.matches("[A-Za-z0-9_]+\\.pdf")); - // safeName ist auf 50 begrenzt → total max 54 inkl. ".pdf" + // safeName limited to 50 -> total max 54 including '.pdf' assertTrue(out.length() <= 54, "Filename should be truncated to 50 + '.pdf'"); } @@ -165,25 +170,26 @@ public class ConvertWebsiteToPdfTest { try (MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); MockedStatic wr = Mockito.mockStatic(WebResponseUtils.class); - MockedStatic gu = Mockito.mockStatic(GeneralUtils.class)) { + MockedStatic gu = Mockito.mockStatic(GeneralUtils.class); + MockedStatic httpClient = mockHttpClientReturning("")) { - // URL-Checks positiv erzwingen + // Force URL checks to be positive gu.when(() -> GeneralUtils.isValidURL("https://example.com")).thenReturn(true); gu.when(() -> GeneralUtils.isURLReachable("https://example.com")).thenReturn(true); - // richtiger ProcessExecutor! + // correct ProcessExecutor! ProcessExecutor mockExec = Mockito.mock(ProcessExecutor.class); pe.when(() -> ProcessExecutor.getInstance(Processes.WEASYPRINT)).thenReturn(mockExec); @SuppressWarnings("unchecked") ArgumentCaptor> cmdCaptor = ArgumentCaptor.forClass(List.class); - // Rückgabewert typgerecht + // Return value of correct type ProcessExecutorResult dummyResult = Mockito.mock(ProcessExecutorResult.class); when(mockExec.runCommandWithOutputHandling(cmdCaptor.capture())) .thenReturn(dummyResult); - // WebResponseUtils mocken + // Mock WebResponseUtils ResponseEntity fakeResponse = ResponseEntity.ok(new byte[0]); wr.when(() -> WebResponseUtils.pdfDocToWebResponse(any(PDDocument.class), anyString())) .thenReturn(fakeResponse); @@ -194,20 +200,22 @@ public class ConvertWebsiteToPdfTest { // Assert – Response OK assertEquals(HttpStatus.OK, resp.getStatusCode()); - // Assert – WeasyPrint-Kommando korrekt + // Assert – WeasyPrint command correct List cmd = cmdCaptor.getValue(); assertNotNull(cmd); assertEquals("/usr/bin/weasyprint", cmd.get(0)); - assertEquals("https://example.com", cmd.get(1)); - assertEquals("--pdf-forms", cmd.get(2)); - assertTrue(cmd.size() >= 4, "WeasyPrint sollte einen Output-Pfad erhalten"); - String outPathStr = cmd.get(3); + assertTrue(cmd.size() >= 6, "WeasyPrint should receive HTML input and output path"); + String htmlPathStr = cmd.get(1); + assertEquals("--base-url", cmd.get(2)); + assertEquals("https://example.com", cmd.get(3)); + assertEquals("--pdf-forms", cmd.get(4)); + String outPathStr = cmd.get(5); assertNotNull(outPathStr); - // Temp-Datei muss im finally gelöscht sein - Path outPath = Path.of(outPathStr); + // Temp file must be deleted in finally assertFalse( - Files.exists(outPath), "Temp-Output-Datei sollte nach dem Call gelöscht sein"); + Files.exists(Path.of(htmlPathStr)), + "Temp HTML file should be deleted after the call"); } } @@ -217,22 +225,33 @@ public class ConvertWebsiteToPdfTest { UrlToPdfRequest request = new UrlToPdfRequest(); request.setUrlInput("https://example.com"); - Path preCreatedTemp = java.nio.file.Files.createTempFile("test_output_", ".pdf"); + Path preCreatedTemp = Files.createTempFile("test_output_", ".pdf"); + Path htmlTemp = Files.createTempFile("test_input_", ".html"); try (MockedStatic gu = Mockito.mockStatic(GeneralUtils.class); MockedStatic pe = Mockito.mockStatic(ProcessExecutor.class); MockedStatic wr = Mockito.mockStatic(WebResponseUtils.class); - MockedStatic files = Mockito.mockStatic(Files.class)) { + MockedStatic files = Mockito.mockStatic(Files.class); + MockedStatic httpClient = mockHttpClientReturning("")) { - // URL-Checks positiv + // Force URL checks to be positive gu.when(() -> GeneralUtils.isValidURL("https://example.com")).thenReturn(true); gu.when(() -> GeneralUtils.isURLReachable("https://example.com")).thenReturn(true); - // Temp-Datei erzwingen + Delete-Fehler provozieren + // Force temp files + provoke delete error + files.when(() -> Files.createTempFile("url_input_", ".html")).thenReturn(htmlTemp); files.when(() -> Files.createTempFile("output_", ".pdf")).thenReturn(preCreatedTemp); + files.when( + () -> + Files.writeString( + eq(htmlTemp), + anyString(), + eq(java.nio.charset.StandardCharsets.UTF_8))) + .thenReturn(htmlTemp); + files.when(() -> Files.deleteIfExists(htmlTemp)).thenReturn(true); files.when(() -> Files.deleteIfExists(preCreatedTemp)) .thenThrow(new IOException("fail delete")); - files.when(() -> Files.exists(preCreatedTemp)).thenReturn(true); // für den Assert + files.when(() -> Files.exists(preCreatedTemp)).thenReturn(true); // for the assert // ProcessExecutor ProcessExecutor mockExec = Mockito.mock(ProcessExecutor.class); @@ -245,20 +264,63 @@ public class ConvertWebsiteToPdfTest { wr.when(() -> WebResponseUtils.pdfDocToWebResponse(any(PDDocument.class), anyString())) .thenReturn(fakeResponse); - // Act: darf keine Exception werfen und soll eine Response liefern + // Act: should not throw and should return a Response ResponseEntity resp = assertDoesNotThrow(() -> sut.urlToPdf(request)); // Assert assertNotNull(resp, "Response should not be null"); assertEquals(HttpStatus.OK, resp.getStatusCode()); assertTrue( - java.nio.file.Files.exists(preCreatedTemp), - "Temp-Datei sollte trotz Lösch-IOException noch existieren"); + Files.exists(preCreatedTemp), + "Temp file should still exist despite delete IOException"); } finally { try { - java.nio.file.Files.deleteIfExists(preCreatedTemp); + Files.deleteIfExists(preCreatedTemp); + Files.deleteIfExists(htmlTemp); } catch (IOException ignore) { } } } + + private static MockedStatic mockHttpClientReturning(String body) throws Exception { + MockedStatic httpClientStatic = Mockito.mockStatic(HttpClient.class); + HttpClient.Builder builder = Mockito.mock(HttpClient.Builder.class); + HttpClient client = Mockito.mock(HttpClient.class); + HttpResponse response = Mockito.mock(); + + httpClientStatic.when(HttpClient::newBuilder).thenReturn(builder); + when(builder.followRedirects(HttpClient.Redirect.NORMAL)).thenReturn(builder); + when(builder.connectTimeout(any(Duration.class))).thenReturn(builder); + when(builder.build()).thenReturn(client); + + Mockito.doReturn(response).when(client).send(any(HttpRequest.class), any()); + when(response.statusCode()).thenReturn(200); + when(response.body()).thenReturn(body); + + return httpClientStatic; + } + + @Test + void redirect_with_error_when_disallowed_content_detected() throws Exception { + UrlToPdfRequest request = new UrlToPdfRequest(); + request.setUrlInput("https://example.com"); + + try (MockedStatic gu = Mockito.mockStatic(GeneralUtils.class); + MockedStatic httpClient = + mockHttpClientReturning( + "")) { + + gu.when(() -> GeneralUtils.isValidURL("https://example.com")).thenReturn(true); + gu.when(() -> GeneralUtils.isURLReachable("https://example.com")).thenReturn(true); + + ResponseEntity resp = sut.urlToPdf(request); + + assertEquals(HttpStatus.SEE_OTHER, resp.getStatusCode()); + URI location = resp.getHeaders().getLocation(); + assertNotNull(location, "Location header expected"); + assertTrue( + location.getQuery() != null + && location.getQuery().contains("error=error.disallowedUrlContent")); + } + } } diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfToCbzUtilsTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfToCbzUtilsTest.java index 6cd6c68219..1afa8e492f 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfToCbzUtilsTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfToCbzUtilsTest.java @@ -42,9 +42,7 @@ public class PdfToCbzUtilsTest { IllegalArgumentException exception = Assertions.assertThrows( IllegalArgumentException.class, - () -> { - PdfToCbzUtils.convertPdfToCbz(null, 300, pdfDocumentFactory); - }); + () -> PdfToCbzUtils.convertPdfToCbz(null, 300, pdfDocumentFactory)); Assertions.assertEquals("File cannot be null or empty", exception.getMessage()); } @@ -56,9 +54,7 @@ public class PdfToCbzUtilsTest { IllegalArgumentException exception = Assertions.assertThrows( IllegalArgumentException.class, - () -> { - PdfToCbzUtils.convertPdfToCbz(emptyFile, 300, pdfDocumentFactory); - }); + () -> PdfToCbzUtils.convertPdfToCbz(emptyFile, 300, pdfDocumentFactory)); Assertions.assertEquals("File cannot be null or empty", exception.getMessage()); } @@ -70,10 +66,8 @@ public class PdfToCbzUtilsTest { IllegalArgumentException exception = Assertions.assertThrows( IllegalArgumentException.class, - () -> { - PdfToCbzUtils.convertPdfToCbz(nonPdfFile, 300, pdfDocumentFactory); - }); - Assertions.assertEquals("File must be a PDF", exception.getMessage()); + () -> PdfToCbzUtils.convertPdfToCbz(nonPdfFile, 300, pdfDocumentFactory)); + Assertions.assertEquals("File must be in PDF format", exception.getMessage()); } @Test @@ -90,9 +84,7 @@ public class PdfToCbzUtilsTest { // structure Assertions.assertThrows( Exception.class, - () -> { - PdfToCbzUtils.convertPdfToCbz(pdfFile, 300, pdfDocumentFactory); - }); + () -> PdfToCbzUtils.convertPdfToCbz(pdfFile, 300, pdfDocumentFactory)); // Verify that load was called Mockito.verify(pdfDocumentFactory).load(pdfFile); diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfVectorExportControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfVectorExportControllerTest.java new file mode 100644 index 0000000000..ad63b21039 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/converters/PdfVectorExportControllerTest.java @@ -0,0 +1,146 @@ +package stirling.software.SPDF.controller.api.converters; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.lenient; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.when; + +import java.lang.reflect.Field; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.mock.web.MockMultipartFile; + +import stirling.software.SPDF.config.EndpointConfiguration; +import stirling.software.SPDF.model.api.converters.PdfVectorExportRequest; +import stirling.software.common.util.ProcessExecutor; +import stirling.software.common.util.ProcessExecutor.ProcessExecutorResult; +import stirling.software.common.util.TempFileManager; + +@ExtendWith(MockitoExtension.class) +class PdfVectorExportControllerTest { + + private final List tempPaths = new ArrayList<>(); + @Mock private TempFileManager tempFileManager; + @Mock private EndpointConfiguration endpointConfiguration; + @Mock private ProcessExecutor ghostscriptExecutor; + @InjectMocks private PdfVectorExportController controller; + private Map originalExecutors; + + @BeforeEach + void setup() throws Exception { + when(tempFileManager.createTempFile(any())) + .thenAnswer( + invocation -> { + String suffix = invocation.getArgument(0); + Path path = + Files.createTempFile( + "vector_test", suffix == null ? "" : suffix); + tempPaths.add(path); + return path.toFile(); + }); + + Field instancesField = ProcessExecutor.class.getDeclaredField("instances"); + instancesField.setAccessible(true); + @SuppressWarnings("unchecked") + Map instances = + (Map) instancesField.get(null); + + originalExecutors = Map.copyOf(instances); + instances.clear(); + instances.put(ProcessExecutor.Processes.GHOSTSCRIPT, ghostscriptExecutor); + } + + @AfterEach + void tearDown() throws Exception { + Field instancesField = ProcessExecutor.class.getDeclaredField("instances"); + instancesField.setAccessible(true); + @SuppressWarnings("unchecked") + Map instances = + (Map) instancesField.get(null); + instances.clear(); + if (originalExecutors != null) { + instances.putAll(originalExecutors); + } + reset(ghostscriptExecutor, tempFileManager, endpointConfiguration); + for (Path path : tempPaths) { + Files.deleteIfExists(path); + } + tempPaths.clear(); + } + + private ProcessExecutorResult mockResult(int rc) { + ProcessExecutorResult result = mock(ProcessExecutorResult.class); + lenient().when(result.getRc()).thenReturn(rc); + lenient().when(result.getMessages()).thenReturn(""); + return result; + } + + @Test + void convertGhostscript_psToPdf_success() throws Exception { + when(endpointConfiguration.isGroupEnabled("Ghostscript")).thenReturn(true); + ProcessExecutorResult result = mockResult(0); + when(ghostscriptExecutor.runCommandWithOutputHandling(any())).thenReturn(result); + + MockMultipartFile file = + new MockMultipartFile( + "fileInput", + "sample.ps", + MediaType.APPLICATION_OCTET_STREAM_VALUE, + new byte[] {1}); + PdfVectorExportRequest request = new PdfVectorExportRequest(); + request.setFileInput(file); + + ResponseEntity response = controller.convertGhostscriptInputsToPdf(request); + + assertThat(response.getStatusCode()).isEqualTo(org.springframework.http.HttpStatus.OK); + assertThat(response.getHeaders().getContentType()).isEqualTo(MediaType.APPLICATION_PDF); + } + + @Test + void convertGhostscript_pdfPassThrough_success() throws Exception { + when(endpointConfiguration.isGroupEnabled("Ghostscript")).thenReturn(false); + + byte[] content = {1}; + MockMultipartFile file = + new MockMultipartFile( + "fileInput", "input.pdf", MediaType.APPLICATION_PDF_VALUE, content); + PdfVectorExportRequest request = new PdfVectorExportRequest(); + request.setFileInput(file); + + ResponseEntity response = controller.convertGhostscriptInputsToPdf(request); + + assertThat(response.getStatusCode()).isEqualTo(org.springframework.http.HttpStatus.OK); + assertThat(response.getHeaders().getContentType()).isEqualTo(MediaType.APPLICATION_PDF); + assertThat(response.getBody()).contains(content); + } + + @Test + void convertGhostscript_unsupportedFormatThrows() { + when(endpointConfiguration.isGroupEnabled("Ghostscript")).thenReturn(false); + MockMultipartFile file = + new MockMultipartFile( + "fileInput", "vector.svg", MediaType.APPLICATION_XML_VALUE, new byte[] {1}); + PdfVectorExportRequest request = new PdfVectorExportRequest(); + request.setFileInput(file); + + assertThrows( + IllegalArgumentException.class, + () -> controller.convertGhostscriptInputsToPdf(request)); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/misc/AttachmentControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/misc/AttachmentControllerTest.java index 0324199f4d..fe0e2ca2d6 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/misc/AttachmentControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/misc/AttachmentControllerTest.java @@ -1,7 +1,6 @@ package stirling.software.SPDF.controller.api.misc; import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; import java.io.IOException; @@ -68,16 +67,16 @@ class AttachmentControllerTest { } @Test - void addAttachments_Success() throws IOException { + void addAttachments_Success() throws Exception { List attachments = List.of(attachment1, attachment2); request.setAttachments(attachments); request.setFileInput(pdfFile); ResponseEntity expectedResponse = ResponseEntity.ok("modified PDF content".getBytes()); - when(pdfDocumentFactory.load(pdfFile, false)).thenReturn(mockDocument); + when(pdfDocumentFactory.load(request, false)).thenReturn(mockDocument); when(pdfAttachmentService.addAttachment(mockDocument, attachments)) - .thenReturn(modifiedMockDocument); + .thenReturn(mockDocument); try (MockedStatic mockedWebResponseUtils = mockStatic(WebResponseUtils.class)) { @@ -85,8 +84,7 @@ class AttachmentControllerTest { .when( () -> WebResponseUtils.pdfDocToWebResponse( - eq(modifiedMockDocument), - eq("test_with_attachments.pdf"))) + eq(mockDocument), eq("test_with_attachments.pdf"))) .thenReturn(expectedResponse); ResponseEntity response = attachmentController.addAttachments(request); @@ -94,22 +92,22 @@ class AttachmentControllerTest { assertNotNull(response); assertEquals(HttpStatus.OK, response.getStatusCode()); assertNotNull(response.getBody()); - verify(pdfDocumentFactory).load(pdfFile, false); + verify(pdfDocumentFactory).load(request, false); verify(pdfAttachmentService).addAttachment(mockDocument, attachments); } } @Test - void addAttachments_SingleAttachment() throws IOException { + void addAttachments_SingleAttachment() throws Exception { List attachments = List.of(attachment1); request.setAttachments(attachments); request.setFileInput(pdfFile); ResponseEntity expectedResponse = ResponseEntity.ok("modified PDF content".getBytes()); - when(pdfDocumentFactory.load(pdfFile, false)).thenReturn(mockDocument); + when(pdfDocumentFactory.load(request, false)).thenReturn(mockDocument); when(pdfAttachmentService.addAttachment(mockDocument, attachments)) - .thenReturn(modifiedMockDocument); + .thenReturn(mockDocument); try (MockedStatic mockedWebResponseUtils = mockStatic(WebResponseUtils.class)) { @@ -117,8 +115,7 @@ class AttachmentControllerTest { .when( () -> WebResponseUtils.pdfDocToWebResponse( - eq(modifiedMockDocument), - eq("test_with_attachments.pdf"))) + eq(mockDocument), eq("test_with_attachments.pdf"))) .thenReturn(expectedResponse); ResponseEntity response = attachmentController.addAttachments(request); @@ -126,33 +123,33 @@ class AttachmentControllerTest { assertNotNull(response); assertEquals(HttpStatus.OK, response.getStatusCode()); assertNotNull(response.getBody()); - verify(pdfDocumentFactory).load(pdfFile, false); + verify(pdfDocumentFactory).load(request, false); verify(pdfAttachmentService).addAttachment(mockDocument, attachments); } } @Test - void addAttachments_IOExceptionFromPDFLoad() throws IOException { + void addAttachments_IOExceptionFromPDFLoad() throws Exception { List attachments = List.of(attachment1); request.setAttachments(attachments); request.setFileInput(pdfFile); IOException ioException = new IOException("Failed to load PDF"); - when(pdfDocumentFactory.load(pdfFile, false)).thenThrow(ioException); + when(pdfDocumentFactory.load(request, false)).thenThrow(ioException); assertThrows(IOException.class, () -> attachmentController.addAttachments(request)); - verify(pdfDocumentFactory).load(pdfFile, false); + verify(pdfDocumentFactory).load(request, false); verifyNoInteractions(pdfAttachmentService); } @Test - void addAttachments_IOExceptionFromAttachmentService() throws IOException { + void addAttachments_IOExceptionFromAttachmentService() throws Exception { List attachments = List.of(attachment1); request.setAttachments(attachments); request.setFileInput(pdfFile); IOException ioException = new IOException("Failed to add attachment"); - when(pdfDocumentFactory.load(pdfFile, false)).thenReturn(mockDocument); + when(pdfDocumentFactory.load(request, false)).thenReturn(mockDocument); when(pdfAttachmentService.addAttachment(mockDocument, attachments)).thenThrow(ioException); assertThrows(IOException.class, () -> attachmentController.addAttachments(request)); diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/pipeline/PipelineProcessorTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/pipeline/PipelineProcessorTest.java index b359e25ff8..f3d0d569f7 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/pipeline/PipelineProcessorTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/pipeline/PipelineProcessorTest.java @@ -1,7 +1,6 @@ package stirling.software.SPDF.controller.api.pipeline; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; @@ -50,13 +49,7 @@ class PipelineProcessorTest { PipelineConfig config = new PipelineConfig(); config.setOperations(List.of(op)); - Resource file = - new ByteArrayResource("data".getBytes()) { - @Override - public String getFilename() { - return "test.pdf"; - } - }; + Resource file = new MyFileByteArrayResource(); List files = List.of(file); @@ -78,4 +71,15 @@ class PipelineProcessorTest { assertFalse(result.isHasErrors(), "No errors should occur"); assertTrue(result.getOutputFiles().isEmpty(), "Filtered file list should be empty"); } + + private static class MyFileByteArrayResource extends ByteArrayResource { + public MyFileByteArrayResource() { + super("data".getBytes()); + } + + @Override + public String getFilename() { + return "test.pdf"; + } + } } diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/security/CertSignControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/security/CertSignControllerTest.java index c9f02cd28d..5a5eff1f12 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/security/CertSignControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/security/CertSignControllerTest.java @@ -1,9 +1,10 @@ package stirling.software.SPDF.controller.api.security; import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; -import static org.mockito.Mockito.when; +import static org.mockito.Mockito.lenient; import java.io.ByteArrayOutputStream; import java.io.InputStream; @@ -107,7 +108,8 @@ class CertSignControllerTest { derCertBytes = baos.toByteArray(); } - when(pdfDocumentFactory.load(any(MultipartFile.class))) + lenient() + .when(pdfDocumentFactory.load(any(MultipartFile.class))) .thenAnswer( invocation -> { MultipartFile file = invocation.getArgument(0); @@ -167,6 +169,31 @@ class CertSignControllerTest { assertTrue(response.getBody().length > 0); } + @Test + void testSignPdfWithMissingPkcs12FileThrowsError() { + MockMultipartFile pdfFile = + new MockMultipartFile( + "fileInput", "test.pdf", MediaType.APPLICATION_PDF_VALUE, pdfBytes); + + SignPDFWithCertRequest request = new SignPDFWithCertRequest(); + request.setFileInput(pdfFile); + request.setCertType("PFX"); + request.setPassword("password"); + request.setShowSignature(false); + request.setReason("test"); + request.setLocation("test"); + request.setName("tester"); + request.setPageNumber(1); + request.setShowLogo(false); + + IllegalArgumentException exception = + assertThrows( + IllegalArgumentException.class, + () -> certSignController.signPDFWithCert(request)); + + assertTrue(exception.getMessage().contains("PKCS12 keystore")); + } + @Test void testSignPdfWithJks() throws Exception { MockMultipartFile pdfFile = diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/security/GetInfoOnPDFTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/security/GetInfoOnPDFTest.java new file mode 100644 index 0000000000..12d5977db5 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/security/GetInfoOnPDFTest.java @@ -0,0 +1,843 @@ +package stirling.software.SPDF.controller.api.security; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.GregorianCalendar; +import java.util.List; + +import org.apache.pdfbox.Loader; +import org.apache.pdfbox.pdmodel.*; +import org.apache.pdfbox.pdmodel.common.PDRectangle; +import org.apache.pdfbox.pdmodel.encryption.AccessPermission; +import org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy; +import org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy; +import org.apache.pdfbox.pdmodel.font.PDType1Font; +import org.apache.pdfbox.pdmodel.font.Standard14Fonts; +import org.junit.jupiter.api.*; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; +import org.mockito.ArgumentMatchers; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.Mockito; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.mock.web.MockMultipartFile; +import org.springframework.web.multipart.MultipartFile; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +import stirling.software.common.model.api.PDFFile; +import stirling.software.common.service.CustomPDFDocumentFactory; + +@DisplayName("GetInfoOnPDF Controller Tests") +@ExtendWith(MockitoExtension.class) +class GetInfoOnPDFTest { + + @Mock private CustomPDFDocumentFactory pdfDocumentFactory; + + @InjectMocks private GetInfoOnPDF getInfoOnPDF; + + private ObjectMapper objectMapper; + + private static final java.time.ZonedDateTime FIXED_NOW = + java.time.ZonedDateTime.parse("2020-01-01T00:00:00Z"); + + @BeforeEach + void setUp() { + objectMapper = new ObjectMapper(); + } + + /** Helper method to load a PDF file from test resources */ + private MockMultipartFile loadPdfFromResources(String filename) throws IOException { + ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); + if (classLoader == null) { + classLoader = getClass().getClassLoader(); + } + + if (classLoader != null) { + try (InputStream resourceStream = classLoader.getResourceAsStream(filename)) { + if (resourceStream != null) { + byte[] content = resourceStream.readAllBytes(); + return new MockMultipartFile( + "file", filename, MediaType.APPLICATION_PDF_VALUE, content); + } + } + } + + Path projectRoot = locateProjectRoot(Path.of("").toAbsolutePath()); + List searchDirectories = + List.of( + projectRoot.resolve( + Path.of("app", "core", "src", "test", "resources").toString()), + projectRoot.resolve( + Path.of("app", "common", "src", "test", "resources").toString()), + projectRoot.resolve( + Path.of("testing", "cucumber", "exampleFiles").toString())); + + for (Path directory : searchDirectories) { + Path filePath = directory.resolve(filename); + if (Files.exists(filePath)) { + byte[] content = Files.readAllBytes(filePath); + return new MockMultipartFile( + "file", filename, MediaType.APPLICATION_PDF_VALUE, content); + } + } + + throw new IOException("PDF file not found: " + filename); + } + + private Path locateProjectRoot(Path start) { + Path current = start; + while (current != null) { + if (Files.exists(current.resolve("settings.gradle"))) { + return current; + } + current = current.getParent(); + } + return start; + } + + /** Helper method to create a simple PDF document with text */ + private PDDocument createSimplePdfWithText(String text) throws IOException { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + document.addPage(page); + + try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) { + contentStream.beginText(); + contentStream.setFont(new PDType1Font(Standard14Fonts.FontName.HELVETICA), 12); + contentStream.newLineAtOffset(100, 700); + contentStream.showText(text); + contentStream.endText(); + } + + return document; + } + + /** Helper method to create a PDF with metadata */ + private PDDocument createPdfWithMetadata() throws IOException { + PDDocument document = createSimplePdfWithText("Test document with metadata"); + + PDDocumentInformation info = new PDDocumentInformation(); + info.setTitle("Test Title"); + info.setAuthor("Test Author"); + info.setSubject("Test Subject"); + info.setKeywords("test, pdf, metadata"); + info.setCreator("Test Creator"); + info.setProducer("Test Producer"); + + GregorianCalendar cal = GregorianCalendar.from(FIXED_NOW); + info.setCreationDate(cal); + info.setModificationDate(cal); + + document.setDocumentInformation(info); + return document; + } + + /** Helper method to create an encrypted PDF */ + private PDDocument createEncryptedPdf() throws IOException { + PDDocument document = createSimplePdfWithText("Encrypted content"); + + AccessPermission accessPermission = new AccessPermission(); + accessPermission.setCanPrint(false); + accessPermission.setCanModify(false); + + ProtectionPolicy protectionPolicy = + new StandardProtectionPolicy("owner", "user", accessPermission); + document.protect(protectionPolicy); + + return document; + } + + /** Helper method to convert PDDocument to MockMultipartFile */ + private MockMultipartFile documentToMultipartFile(PDDocument document, String filename) + throws IOException { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + document.save(baos); + document.close(); + return new MockMultipartFile( + "file", filename, MediaType.APPLICATION_PDF_VALUE, baos.toByteArray()); + } + + @Nested + @DisplayName("Basic Functionality Tests") + class BasicFunctionalityTests { + + @Test + @DisplayName("Should successfully extract info from a valid PDF") + void testGetPdfInfo_ValidPdf() throws IOException { + PDDocument document = createPdfWithMetadata(); + MockMultipartFile mockFile = documentToMultipartFile(document, "test.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + try (PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes())) { + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + Assertions.assertNotNull(response); + Assertions.assertEquals(HttpStatus.OK, response.getStatusCode()); + Assertions.assertNotNull(response.getBody()); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertTrue(jsonNode.has("Metadata")); + Assertions.assertTrue(jsonNode.has("BasicInfo")); + Assertions.assertTrue(jsonNode.has("DocumentInfo")); + Assertions.assertTrue(jsonNode.has("Compliancy")); + Assertions.assertTrue(jsonNode.has("Encryption")); + Assertions.assertTrue(jsonNode.has("Permissions")); + + JsonNode metadata = jsonNode.get("Metadata"); + Assertions.assertEquals("Test Title", metadata.get("Title").asText()); + Assertions.assertEquals("Test Author", metadata.get("Author").asText()); + } + } + + @Test + @DisplayName("Should extract basic info correctly") + void testGetPdfInfo_BasicInfo() throws IOException { + PDDocument document = createSimplePdfWithText("Test content with some words"); + MockMultipartFile mockFile = documentToMultipartFile(document, "basic.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + try (PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes())) { + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode basicInfo = jsonNode.get("BasicInfo"); + + Assertions.assertTrue(basicInfo.has("Number of pages")); + Assertions.assertTrue(basicInfo.has("FileSizeInBytes")); + Assertions.assertTrue(basicInfo.has("WordCount")); + Assertions.assertTrue(basicInfo.has("CharacterCount")); + + Assertions.assertEquals(1, basicInfo.get("Number of pages").asInt()); + Assertions.assertTrue(basicInfo.get("FileSizeInBytes").asLong() > 0); + } + } + + @Test + @DisplayName("Should handle PDF with multiple pages") + void testGetPdfInfo_MultiplePages() throws IOException { + PDDocument document = new PDDocument(); + document.addPage(new PDPage(PDRectangle.A4)); + document.addPage(new PDPage(PDRectangle.A4)); + document.addPage(new PDPage(PDRectangle.LETTER)); + + MockMultipartFile mockFile = documentToMultipartFile(document, "multipage.pdf"); + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + try (PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes())) { + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertEquals( + 3, jsonNode.get("BasicInfo").get("Number of pages").asInt()); + Assertions.assertTrue(jsonNode.has("PerPageInfo")); + + JsonNode perPageInfo = jsonNode.get("PerPageInfo"); + Assertions.assertTrue(perPageInfo.has("Page 1")); + Assertions.assertTrue(perPageInfo.has("Page 2")); + Assertions.assertTrue(perPageInfo.has("Page 3")); + } + } + } + + @Nested + @DisplayName("Metadata Extraction Tests") + class MetadataExtractionTests { + + @Test + @DisplayName("Should extract all metadata fields") + void testExtractMetadata_AllFields() throws IOException { + PDDocument document = createPdfWithMetadata(); + MockMultipartFile mockFile = documentToMultipartFile(document, "metadata.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode metadata = jsonNode.get("Metadata"); + + Assertions.assertEquals("Test Title", metadata.get("Title").asText()); + Assertions.assertEquals("Test Author", metadata.get("Author").asText()); + Assertions.assertEquals("Test Subject", metadata.get("Subject").asText()); + Assertions.assertEquals("test, pdf, metadata", metadata.get("Keywords").asText()); + Assertions.assertEquals("Test Creator", metadata.get("Creator").asText()); + Assertions.assertEquals("Test Producer", metadata.get("Producer").asText()); + Assertions.assertTrue(metadata.has("CreationDate")); + Assertions.assertTrue(metadata.has("ModificationDate")); + + loadedDoc.close(); + } + + @Test + @DisplayName("Should handle PDF with missing metadata") + void testExtractMetadata_MissingFields() throws IOException { + PDDocument document = createSimplePdfWithText("No metadata"); + MockMultipartFile mockFile = documentToMultipartFile(document, "no-metadata.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + Assertions.assertNotNull(response); + Assertions.assertEquals(HttpStatus.OK, response.getStatusCode()); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode metadata = jsonNode.get("Metadata"); + + Assertions.assertNotNull(metadata); + + loadedDoc.close(); + } + } + + @Nested + @DisplayName("Encryption and Permissions Tests") + class EncryptionPermissionsTests { + + @Test + @DisplayName("Should detect unencrypted PDF") + void testEncryption_UnencryptedPdf() throws IOException { + PDDocument document = createSimplePdfWithText("Not encrypted"); + MockMultipartFile mockFile = documentToMultipartFile(document, "unencrypted.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode encryption = jsonNode.get("Encryption"); + + Assertions.assertFalse(encryption.get("IsEncrypted").asBoolean()); + + loadedDoc.close(); + } + + @Test + @DisplayName("Should extract all permissions") + void testPermissions_AllPermissions() throws IOException { + PDDocument document = createSimplePdfWithText("Test permissions"); + MockMultipartFile mockFile = documentToMultipartFile(document, "permissions.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode permissions = jsonNode.get("Permissions"); + + Assertions.assertTrue(permissions.has("Document Assembly")); + Assertions.assertTrue(permissions.has("Extracting Content")); + Assertions.assertTrue(permissions.has("Form Filling")); + Assertions.assertTrue(permissions.has("Modifying")); + Assertions.assertTrue(permissions.has("Printing")); + + loadedDoc.close(); + } + } + + @Nested + @DisplayName("Form Fields Tests") + class FormFieldsTests { + + @Test + @DisplayName("Should extract form fields section from PDF") + void testFormFields_Structure() throws IOException { + PDDocument document = createSimplePdfWithText("Document to test form fields section"); + MockMultipartFile mockFile = documentToMultipartFile(document, "test-forms.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertTrue(jsonNode.has("FormFields")); + JsonNode formFields = jsonNode.get("FormFields"); + Assertions.assertNotNull(formFields); + + loadedDoc.close(); + } + + @Test + @DisplayName("Should handle PDF without form fields") + void testFormFields_NoFields() throws IOException { + PDDocument document = createSimplePdfWithText("No form fields"); + MockMultipartFile mockFile = documentToMultipartFile(document, "no-forms.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode formFields = jsonNode.get("FormFields"); + + Assertions.assertEquals(0, formFields.size()); + + loadedDoc.close(); + } + } + + @Nested + @DisplayName("Per-Page Information Tests") + class PerPageInfoTests { + + @Test + @DisplayName("Should extract page dimensions") + void testPerPageInfo_Dimensions() throws IOException { + PDDocument document = new PDDocument(); + document.addPage(new PDPage(PDRectangle.A4)); + document.addPage(new PDPage(PDRectangle.LETTER)); + + MockMultipartFile mockFile = documentToMultipartFile(document, "dimensions.pdf"); + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode perPageInfo = jsonNode.get("PerPageInfo"); + + JsonNode page1 = perPageInfo.get("Page 1"); + Assertions.assertTrue(page1.has("Size")); + Assertions.assertTrue(page1.get("Size").has("Standard Page")); + Assertions.assertEquals("A4", page1.get("Size").get("Standard Page").asText()); + + JsonNode page2 = perPageInfo.get("Page 2"); + Assertions.assertEquals("Letter", page2.get("Size").get("Standard Page").asText()); + + loadedDoc.close(); + } + + @Test + @DisplayName("Should extract page rotation") + void testPerPageInfo_Rotation() throws IOException { + PDDocument document = new PDDocument(); + PDPage page = new PDPage(PDRectangle.A4); + page.setRotation(90); + document.addPage(page); + + MockMultipartFile mockFile = documentToMultipartFile(document, "rotated.pdf"); + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode page1 = jsonNode.get("PerPageInfo").get("Page 1"); + + Assertions.assertEquals(90, page1.get("Rotation").asInt()); + + loadedDoc.close(); + } + } + + @Nested + @DisplayName("Validation and Error Handling Tests") + class ValidationErrorTests { + + @Test + @DisplayName("Should reject null file") + void testValidation_NullFile() throws IOException { + PDFFile request = new PDFFile(); + request.setFileInput(null); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + Assertions.assertEquals( + HttpStatus.OK, response.getStatusCode()); // Returns error JSON with 200 + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertTrue(jsonNode.has("error")); + Assertions.assertTrue(jsonNode.get("error").asText().contains("PDF file is required")); + } + + @Test + @DisplayName("Should reject empty file") + void testValidation_EmptyFile() throws IOException { + MockMultipartFile emptyFile = + new MockMultipartFile( + "file", "empty.pdf", MediaType.APPLICATION_PDF_VALUE, new byte[0]); + + PDFFile request = new PDFFile(); + request.setFileInput(emptyFile); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertTrue(jsonNode.has("error")); + } + + @Test + @DisplayName("Should reject file that exceeds max size") + void testValidation_TooLargeFile() throws IOException { + MultipartFile largeFile = + new MultipartFile() { + @Override + public String getName() { + return "file"; + } + + @Override + public String getOriginalFilename() { + return "large.pdf"; + } + + @Override + public String getContentType() { + return MediaType.APPLICATION_PDF_VALUE; + } + + @Override + public boolean isEmpty() { + return false; + } + + @Override + public long getSize() { + // Report 101 MB without allocating memory + return 101L * 1024L * 1024L; + } + + @Override + public byte[] getBytes() { + return new byte[0]; + } + + @Override + public java.io.InputStream getInputStream() { + return java.io.InputStream.nullInputStream(); + } + + @Override + public void transferTo(java.io.File dest) throws IllegalStateException {} + }; + + PDFFile request = new PDFFile(); + request.setFileInput(largeFile); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertTrue(jsonNode.has("error")); + Assertions.assertTrue( + jsonNode.get("error").asText().contains("exceeds maximum allowed size")); + } + } + + @Nested + @DisplayName("Static Helper Methods Tests") + class HelperMethodsTests { + + @Test + @DisplayName("Should determine page orientation correctly") + void testGetPageOrientation() { + Assertions.assertEquals("Landscape", GetInfoOnPDF.getPageOrientation(800, 600)); + Assertions.assertEquals("Portrait", GetInfoOnPDF.getPageOrientation(600, 800)); + Assertions.assertEquals("Square", GetInfoOnPDF.getPageOrientation(600, 600)); + } + + @ParameterizedTest + @CsvSource({ + "612, 792, Letter", + "595.276, 841.89, A4", + "2383.937, 3370.394, A0", + "100, 100, Custom" + }) + @DisplayName("Should identify standard page sizes") + void testGetPageSize(float width, float height, String expected) { + Assertions.assertEquals(expected, GetInfoOnPDF.getPageSize(width, height)); + } + + @Test + @DisplayName("Should check for PDF/A standard") + void testCheckForStandard_PdfA() throws IOException { + // This would require a real PDF/A document or mocking + PDDocument document = createSimplePdfWithText("Test"); + boolean result = GetInfoOnPDF.checkForStandard(document, "PDF/A"); + Assertions.assertFalse(result); // Simple PDF is not PDF/A compliant + document.close(); + } + + @Test + @DisplayName("Should handle null document in checkForStandard") + void testCheckForStandard_NullDocument() { + boolean result = GetInfoOnPDF.checkForStandard(null, "PDF/A"); + Assertions.assertFalse(result); + } + + @Test + @DisplayName("Should get PDF/A conformance level") + void testGetPdfAConformanceLevel() throws IOException { + PDDocument document = createSimplePdfWithText("Test"); + String level = GetInfoOnPDF.getPdfAConformanceLevel(document); + Assertions.assertNull(level); + document.close(); + } + + @Test + @DisplayName("Should handle encrypted document in getPdfAConformanceLevel") + void testGetPdfAConformanceLevel_EncryptedDocument() throws IOException { + PDDocument document = createEncryptedPdf(); + String level = GetInfoOnPDF.getPdfAConformanceLevel(document); + Assertions.assertNull(level); // Encrypted documents return null + document.close(); + } + } + + @Nested + @DisplayName("Real PDF Files Tests") + class RealPdfFilesTests { + + @Test + @DisplayName("Should process example.pdf from test resources") + void testRealPdf_Example() { + try { + MockMultipartFile mockFile = loadPdfFromResources("example.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + try (PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes())) { + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + Assertions.assertNotNull(response); + Assertions.assertEquals(HttpStatus.OK, response.getStatusCode()); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertFalse( + jsonNode.has("error"), "Should not have error in response"); + + Assertions.assertTrue(jsonNode.has("BasicInfo")); + Assertions.assertTrue(jsonNode.has("DocumentInfo")); + Assertions.assertTrue(jsonNode.get("DocumentInfo").has("PDF version")); + } + } catch (IOException e) { + Assumptions.assumeTrue( + false, "Skipping test - example.pdf not found: " + e.getMessage()); + } + } + + @Test + @DisplayName("Should process tables.pdf") + void testRealPdf_Tables() { + try { + MockMultipartFile mockFile = loadPdfFromResources("tables.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + try (PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes())) { + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + Assertions.assertNotNull(response); + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + + Assertions.assertFalse(jsonNode.has("error")); + Assertions.assertTrue(jsonNode.has("BasicInfo")); + } + } catch (IOException e) { + Assumptions.assumeTrue( + false, "Skipping test - tables.pdf not found: " + e.getMessage()); + } + } + } + + @Nested + @DisplayName("Compliance Tests") + class ComplianceTests { + + @Test + @DisplayName("Should check PDF/A compliance") + void testCompliance_PdfA() throws IOException { + PDDocument document = createSimplePdfWithText("Test PDF/A"); + MockMultipartFile mockFile = documentToMultipartFile(document, "pdfa.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode compliancy = jsonNode.get("Compliancy"); + + Assertions.assertTrue(compliancy.has("IsPDF/ACompliant")); + Assertions.assertTrue(compliancy.has("IsPDF/XCompliant")); + Assertions.assertTrue(compliancy.has("IsPDF/ECompliant")); + Assertions.assertTrue(compliancy.has("IsPDF/UACompliant")); + + loadedDoc.close(); + } + } + + @Nested + @DisplayName("Image Statistics Tests") + class ImageStatisticsTests { + + @Test + @DisplayName("Should extract image statistics from PDF") + void testImageStatistics() throws IOException { + PDDocument document = createSimplePdfWithText("Document for image statistics"); + MockMultipartFile mockFile = documentToMultipartFile(document, "no-images.pdf"); + + PDFFile request = new PDFFile(); + request.setFileInput(mockFile); + + PDDocument loadedDoc = Loader.loadPDF(mockFile.getBytes()); + Mockito.when( + pdfDocumentFactory.load( + ArgumentMatchers.any(MultipartFile.class), + ArgumentMatchers.anyBoolean())) + .thenReturn(loadedDoc); + + ResponseEntity response = getInfoOnPDF.getPdfInfo(request); + + String jsonResponse = new String(response.getBody(), StandardCharsets.UTF_8); + JsonNode jsonNode = objectMapper.readTree(jsonResponse); + JsonNode basicInfo = jsonNode.get("BasicInfo"); + + Assertions.assertTrue(basicInfo.has("TotalImages")); + Assertions.assertTrue(basicInfo.has("UniqueImages")); + Assertions.assertEquals(0, basicInfo.get("TotalImages").asInt()); + Assertions.assertEquals(0, basicInfo.get("UniqueImages").asInt()); + + loadedDoc.close(); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/api/security/RedactControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/api/security/RedactControllerTest.java index 9ae09afc22..75f1b8d01d 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/api/security/RedactControllerTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/api/security/RedactControllerTest.java @@ -1,7 +1,6 @@ package stirling.software.SPDF.controller.api.security; import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; import java.awt.Color; @@ -70,61 +69,45 @@ class RedactControllerTest { private PDDocument realDocument; private PDPage realPage; - // Helpers - private void testAutoRedaction( - String searchText, - boolean useRegex, - boolean wholeWordSearch, - String redactColor, - float padding, - boolean convertToImage, - boolean expectSuccess) - throws Exception { - RedactPdfRequest request = createRedactPdfRequest(); - request.setListOfText(searchText); - request.setUseRegex(useRegex); - request.setWholeWordSearch(wholeWordSearch); - request.setRedactColor(redactColor); - request.setCustomPadding(padding); - request.setConvertPDFToImage(convertToImage); - - try { - ResponseEntity response = redactController.redactPdf(request); - - if (expectSuccess && response != null) { - assertNotNull(response); - assertEquals(200, response.getStatusCode().value()); - assertNotNull(response.getBody()); - assertTrue(response.getBody().length > 0); - verify(mockDocument, times(1)).save(any(ByteArrayOutputStream.class)); - verify(mockDocument, times(1)).close(); - } - } catch (Exception e) { - if (expectSuccess) { - log.info("Redaction test completed with graceful handling: {}", e.getMessage()); - } else { - assertNotNull(e.getMessage()); + private static byte[] createSimplePdfContent() throws IOException { + try (PDDocument doc = new PDDocument()) { + PDPage page = new PDPage(PDRectangle.A4); + doc.addPage(page); + try (PDPageContentStream contentStream = new PDPageContentStream(doc, page)) { + contentStream.beginText(); + contentStream.setFont(new PDType1Font(Standard14Fonts.FontName.HELVETICA), 12); + contentStream.newLineAtOffset(100, 700); + contentStream.showText("This is a simple PDF."); + contentStream.endText(); } + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + doc.save(baos); + return baos.toByteArray(); } } - private void testManualRedaction(List redactionAreas, boolean convertToImage) - throws Exception { - ManualRedactPdfRequest request = createManualRedactPdfRequest(); - request.setRedactions(redactionAreas); - request.setConvertPDFToImage(convertToImage); + private static List createValidRedactionAreas() { + List areas = new ArrayList<>(); - try { - ResponseEntity response = redactController.redactPDF(request); + RedactionArea area1 = new RedactionArea(); + area1.setPage(1); + area1.setX(100.0); + area1.setY(100.0); + area1.setWidth(200.0); + area1.setHeight(50.0); + area1.setColor("000000"); + areas.add(area1); - if (response != null) { - assertNotNull(response); - assertEquals(200, response.getStatusCode().value()); - verify(mockDocument, times(1)).save(any(ByteArrayOutputStream.class)); - } - } catch (Exception e) { - log.info("Manual redaction test completed with graceful handling: {}", e.getMessage()); - } + RedactionArea area2 = new RedactionArea(); + area2.setPage(1); + area2.setX(300.0); + area2.setY(200.0); + area2.setWidth(150.0); + area2.setHeight(30.0); + area2.setColor("FF0000"); + areas.add(area2); + + return areas; } @BeforeEach @@ -190,16 +173,18 @@ class RedactControllerTest { setupRealDocument(); } - private void setupRealDocument() throws IOException { - realDocument = new PDDocument(); - realPage = new PDPage(PDRectangle.A4); - realDocument.addPage(realPage); + private static List createInvalidRedactionAreas() { + List areas = new ArrayList<>(); - // Set up basic page resources - PDResources resources = new PDResources(); - resources.put( - COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); - realPage.setResources(resources); + RedactionArea invalidArea = new RedactionArea(); + invalidArea.setPage(null); // Invalid - null page + invalidArea.setX(100.0); + invalidArea.setY(100.0); + invalidArea.setWidth(200.0); + invalidArea.setHeight(50.0); + areas.add(invalidArea); + + return areas; } @AfterEach @@ -608,13 +593,266 @@ class RedactControllerTest { } } + private static List createMultipleRedactionAreas() { + List areas = new ArrayList<>(); + + for (int i = 0; i < 5; i++) { + RedactionArea area = new RedactionArea(); + area.setPage(1); + area.setX(50.0 + (i * 60)); + area.setY(50.0 + (i * 40)); + area.setWidth(50.0); + area.setHeight(30.0); + area.setColor(String.format("%06X", i * 0x333333)); + areas.add(area); + } + + return areas; + } + + private static List createOverlappingRedactionAreas() { + List areas = new ArrayList<>(); + + RedactionArea area1 = new RedactionArea(); + area1.setPage(1); + area1.setX(100.0); + area1.setY(100.0); + area1.setWidth(200.0); + area1.setHeight(100.0); + area1.setColor("FF0000"); + areas.add(area1); + + RedactionArea area2 = new RedactionArea(); + area2.setPage(1); + area2.setX(150.0); // Overlaps with area1 + area2.setY(150.0); // Overlaps with area1 + area2.setWidth(200.0); + area2.setHeight(100.0); + area2.setColor("00FF00"); + areas.add(area2); + + return areas; + } + + // Helper for token creation + private static List createSampleTokenList() { + return List.of( + Operator.getOperator("BT"), + COSName.getPDFName("F1"), + new COSFloat(12), + Operator.getOperator("Tf"), + new COSString("Sample text"), + Operator.getOperator("Tj"), + Operator.getOperator("ET")); + } + + private RedactPdfRequest createRedactPdfRequest() { + RedactPdfRequest request = new RedactPdfRequest(); + request.setFileInput(mockPdfFile); + return request; + } + + private ManualRedactPdfRequest createManualRedactPdfRequest() { + ManualRedactPdfRequest request = new ManualRedactPdfRequest(); + request.setFileInput(mockPdfFile); + return request; + } + + private static String extractTextFromTokens(List tokens) { + StringBuilder text = new StringBuilder(); + for (Object token : tokens) { + if (token instanceof COSString cosString) { + text.append(cosString.getString()); + } else if (token instanceof COSArray array) { + for (int i = 0; i < array.size(); i++) { + if (array.getObject(i) instanceof COSString cosString) { + text.append(cosString.getString()); + } + } + } + } + return text.toString(); + } + + private static byte[] readAllBytes(InputStream inputStream) throws IOException { + ByteArrayOutputStream buffer = new ByteArrayOutputStream(); + int nRead; + byte[] data = new byte[1024]; + while ((nRead = inputStream.read(data, 0, data.length)) != -1) { + buffer.write(data, 0, nRead); + } + return buffer.toByteArray(); + } + + // Helpers + private void testAutoRedaction( + String searchText, + boolean useRegex, + boolean wholeWordSearch, + String redactColor, + float padding, + boolean convertToImage, + boolean expectSuccess) { + RedactPdfRequest request = createRedactPdfRequest(); + request.setListOfText(searchText); + request.setUseRegex(useRegex); + request.setWholeWordSearch(wholeWordSearch); + request.setRedactColor(redactColor); + request.setCustomPadding(padding); + request.setConvertPDFToImage(convertToImage); + + try { + ResponseEntity response = redactController.redactPdf(request); + + if (expectSuccess && response != null) { + assertNotNull(response); + assertEquals(200, response.getStatusCode().value()); + assertNotNull(response.getBody()); + assertTrue(response.getBody().length > 0); + verify(mockDocument, times(1)).save(any(ByteArrayOutputStream.class)); + verify(mockDocument, times(1)).close(); + } + } catch (Exception e) { + if (expectSuccess) { + log.info("Redaction test completed with graceful handling: {}", e.getMessage()); + } else { + assertNotNull(e.getMessage()); + } + } + } + + private void testManualRedaction(List redactionAreas, boolean convertToImage) { + ManualRedactPdfRequest request = createManualRedactPdfRequest(); + request.setRedactions(redactionAreas); + request.setConvertPDFToImage(convertToImage); + + try { + ResponseEntity response = redactController.redactPDF(request); + + if (response != null) { + assertNotNull(response); + assertEquals(200, response.getStatusCode().value()); + verify(mockDocument, times(1)).save(any(ByteArrayOutputStream.class)); + } + } catch (Exception e) { + log.info("Manual redaction test completed with graceful handling: {}", e.getMessage()); + } + } + + private void setupRealDocument() { + realDocument = new PDDocument(); + realPage = new PDPage(PDRectangle.A4); + realDocument.addPage(realPage); + + // Set up basic page resources + PDResources resources = new PDResources(); + resources.put( + COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); + realPage.setResources(resources); + } + + // Helper methods for real PDF content creation + private void createRealPageWithSimpleText(String text) throws IOException { + realPage = new PDPage(PDRectangle.A4); + while (realDocument.getNumberOfPages() > 0) { + realDocument.removePage(0); + } + realDocument.addPage(realPage); + realPage.setResources(new PDResources()); + realPage.getResources() + .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); + + try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { + contentStream.beginText(); + contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); + contentStream.newLineAtOffset(50, 750); + contentStream.showText(text); + contentStream.endText(); + } + } + + private void createRealPageWithTJArrayText() throws IOException { + realPage = new PDPage(PDRectangle.A4); + while (realDocument.getNumberOfPages() > 0) { + realDocument.removePage(0); + } + realDocument.addPage(realPage); + realPage.setResources(new PDResources()); + realPage.getResources() + .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); + + try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { + contentStream.beginText(); + contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); + contentStream.newLineAtOffset(50, 750); + + contentStream.showText("This is "); + contentStream.newLineAtOffset(-10, 0); // Simulate positioning + contentStream.showText("secret"); + contentStream.newLineAtOffset(10, 0); // Reset positioning + contentStream.showText(" information"); + contentStream.endText(); + } + } + + private void createRealPageWithMixedContent() throws IOException { + realPage = new PDPage(PDRectangle.A4); + while (realDocument.getNumberOfPages() > 0) { + realDocument.removePage(0); + } + realDocument.addPage(realPage); + realPage.setResources(new PDResources()); + realPage.getResources() + .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); + + try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { + contentStream.setLineWidth(2); + contentStream.moveTo(100, 100); + contentStream.lineTo(200, 200); + contentStream.stroke(); + + contentStream.beginText(); + contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); + contentStream.newLineAtOffset(50, 750); + contentStream.showText("Please redact this content"); + contentStream.endText(); + } + } + + private void createRealPageWithSpecificOperator(String operatorName) throws IOException { + createRealPageWithSimpleText("sensitive data"); + } + + private void createRealPageWithPositionedText() throws IOException { + realPage = new PDPage(PDRectangle.A4); + while (realDocument.getNumberOfPages() > 0) { + realDocument.removePage(0); + } + realDocument.addPage(realPage); + realPage.setResources(new PDResources()); + realPage.getResources() + .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); + + try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { + contentStream.beginText(); + contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); + contentStream.newLineAtOffset(50, 750); + contentStream.showText("Normal text "); + contentStream.newLineAtOffset(100, 0); + contentStream.showText("confidential"); + contentStream.newLineAtOffset(100, 0); + contentStream.showText(" more text"); + contentStream.endText(); + } + } + @Nested @DisplayName("Error Handling and Edge Cases") class ErrorHandlingTests { @Test @DisplayName("Should handle null file input gracefully") - void handleNullFileInput() throws Exception { + void handleNullFileInput() { RedactPdfRequest request = new RedactPdfRequest(); request.setFileInput(null); request.setListOfText("test"); @@ -631,7 +869,7 @@ class RedactControllerTest { @Test @DisplayName("Should handle malformed PDF gracefully") - void handleMalformedPdfGracefully() throws Exception { + void handleMalformedPdfGracefully() { MockMultipartFile malformedFile = new MockMultipartFile( "fileInput", @@ -675,7 +913,7 @@ class RedactControllerTest { @Test @DisplayName("Should handle null redact color gracefully") - void handleNullRedactColor() throws Exception { + void handleNullRedactColor() { RedactPdfRequest request = createRedactPdfRequest(); request.setListOfText("test"); request.setRedactColor(null); @@ -723,34 +961,50 @@ class RedactControllerTest { } } + private List getOriginalTokens() throws Exception { + // Create a new page to avoid side effects from other tests + PDPage pageForTokenExtraction = new PDPage(PDRectangle.A4); + pageForTokenExtraction.setResources(realPage.getResources()); + try (PDPageContentStream contentStream = + new PDPageContentStream(realDocument, pageForTokenExtraction)) { + contentStream.beginText(); + contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); + contentStream.newLineAtOffset(50, 750); + contentStream.showText("Original content"); + contentStream.endText(); + } + return redactController.createTokensWithoutTargetText( + realDocument, pageForTokenExtraction, Collections.emptySet(), false, false); + } + @Nested @DisplayName("Color Decoding Utility Tests") class ColorDecodingTests { @Test @DisplayName("Should decode valid hex color with hash") - void decodeValidHexColorWithHash() throws Exception { + void decodeValidHexColorWithHash() { Color result = redactController.decodeOrDefault("#FF0000"); assertEquals(Color.RED, result); } @Test @DisplayName("Should decode valid hex color without hash") - void decodeValidHexColorWithoutHash() throws Exception { + void decodeValidHexColorWithoutHash() { Color result = redactController.decodeOrDefault("FF0000"); assertEquals(Color.RED, result); } @Test @DisplayName("Should default to black for null color") - void defaultToBlackForNullColor() throws Exception { + void defaultToBlackForNullColor() { Color result = redactController.decodeOrDefault(null); assertEquals(Color.BLACK, result); } @Test @DisplayName("Should default to black for invalid color") - void defaultToBlackForInvalidColor() throws Exception { + void defaultToBlackForInvalidColor() { Color result = redactController.decodeOrDefault("invalid-color"); assertEquals(Color.BLACK, result); } @@ -762,7 +1016,7 @@ class RedactControllerTest { "0000FF" }) @DisplayName("Should handle various valid color formats") - void handleVariousValidColorFormats(String colorInput) throws Exception { + void handleVariousValidColorFormats(String colorInput) { Color result = redactController.decodeOrDefault(colorInput); assertNotNull(result); assertTrue( @@ -778,7 +1032,7 @@ class RedactControllerTest { @Test @DisplayName("Should handle short hex codes appropriately") - void handleShortHexCodes() throws Exception { + void handleShortHexCodes() { Color result1 = redactController.decodeOrDefault("123"); Color result2 = redactController.decodeOrDefault("#12"); @@ -787,6 +1041,15 @@ class RedactControllerTest { } } + private String extractTextFromModifiedPage(PDPage page) throws IOException { + if (page.getContents() != null) { + try (InputStream inputStream = page.getContents()) { + return new String(readAllBytes(inputStream)); + } + } + return ""; + } + @Nested @DisplayName("Content Stream Unit Tests") class ContentStreamUnitTests { @@ -975,7 +1238,7 @@ class RedactControllerTest { @Test @DisplayName("Placeholder creation should maintain text width") - void shouldCreateWidthMatchingPlaceholder() throws Exception { + void shouldCreateWidthMatchingPlaceholder() { String originalText = "confidential"; String placeholder = redactController.createPlaceholderWithFont( @@ -989,7 +1252,7 @@ class RedactControllerTest { @Test @DisplayName("Placeholder should handle special characters") - void shouldHandleSpecialCharactersInPlaceholder() throws Exception { + void shouldHandleSpecialCharactersInPlaceholder() { String originalText = "café naïve"; String placeholder = redactController.createPlaceholderWithFont( @@ -1164,270 +1427,4 @@ class RedactControllerTest { assertTrue(response.getBody().length > 0); } } - - private RedactPdfRequest createRedactPdfRequest() { - RedactPdfRequest request = new RedactPdfRequest(); - request.setFileInput(mockPdfFile); - return request; - } - - private ManualRedactPdfRequest createManualRedactPdfRequest() { - ManualRedactPdfRequest request = new ManualRedactPdfRequest(); - request.setFileInput(mockPdfFile); - return request; - } - - private byte[] createSimplePdfContent() throws IOException { - try (PDDocument doc = new PDDocument()) { - PDPage page = new PDPage(PDRectangle.A4); - doc.addPage(page); - try (PDPageContentStream contentStream = new PDPageContentStream(doc, page)) { - contentStream.beginText(); - contentStream.setFont(new PDType1Font(Standard14Fonts.FontName.HELVETICA), 12); - contentStream.newLineAtOffset(100, 700); - contentStream.showText("This is a simple PDF."); - contentStream.endText(); - } - ByteArrayOutputStream baos = new ByteArrayOutputStream(); - doc.save(baos); - return baos.toByteArray(); - } - } - - private List createValidRedactionAreas() { - List areas = new ArrayList<>(); - - RedactionArea area1 = new RedactionArea(); - area1.setPage(1); - area1.setX(100.0); - area1.setY(100.0); - area1.setWidth(200.0); - area1.setHeight(50.0); - area1.setColor("000000"); - areas.add(area1); - - RedactionArea area2 = new RedactionArea(); - area2.setPage(1); - area2.setX(300.0); - area2.setY(200.0); - area2.setWidth(150.0); - area2.setHeight(30.0); - area2.setColor("FF0000"); - areas.add(area2); - - return areas; - } - - private List createInvalidRedactionAreas() { - List areas = new ArrayList<>(); - - RedactionArea invalidArea = new RedactionArea(); - invalidArea.setPage(null); // Invalid - null page - invalidArea.setX(100.0); - invalidArea.setY(100.0); - invalidArea.setWidth(200.0); - invalidArea.setHeight(50.0); - areas.add(invalidArea); - - return areas; - } - - private List createMultipleRedactionAreas() { - List areas = new ArrayList<>(); - - for (int i = 0; i < 5; i++) { - RedactionArea area = new RedactionArea(); - area.setPage(1); - area.setX(50.0 + (i * 60)); - area.setY(50.0 + (i * 40)); - area.setWidth(50.0); - area.setHeight(30.0); - area.setColor(String.format("%06X", i * 0x333333)); - areas.add(area); - } - - return areas; - } - - private List createOverlappingRedactionAreas() { - List areas = new ArrayList<>(); - - RedactionArea area1 = new RedactionArea(); - area1.setPage(1); - area1.setX(100.0); - area1.setY(100.0); - area1.setWidth(200.0); - area1.setHeight(100.0); - area1.setColor("FF0000"); - areas.add(area1); - - RedactionArea area2 = new RedactionArea(); - area2.setPage(1); - area2.setX(150.0); // Overlaps with area1 - area2.setY(150.0); // Overlaps with area1 - area2.setWidth(200.0); - area2.setHeight(100.0); - area2.setColor("00FF00"); - areas.add(area2); - - return areas; - } - - // Helper methods for real PDF content creation - private void createRealPageWithSimpleText(String text) throws IOException { - realPage = new PDPage(PDRectangle.A4); - while (realDocument.getNumberOfPages() > 0) { - realDocument.removePage(0); - } - realDocument.addPage(realPage); - realPage.setResources(new PDResources()); - realPage.getResources() - .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); - - try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { - contentStream.beginText(); - contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); - contentStream.newLineAtOffset(50, 750); - contentStream.showText(text); - contentStream.endText(); - } - } - - private void createRealPageWithTJArrayText() throws IOException { - realPage = new PDPage(PDRectangle.A4); - while (realDocument.getNumberOfPages() > 0) { - realDocument.removePage(0); - } - realDocument.addPage(realPage); - realPage.setResources(new PDResources()); - realPage.getResources() - .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); - - try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { - contentStream.beginText(); - contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); - contentStream.newLineAtOffset(50, 750); - - contentStream.showText("This is "); - contentStream.newLineAtOffset(-10, 0); // Simulate positioning - contentStream.showText("secret"); - contentStream.newLineAtOffset(10, 0); // Reset positioning - contentStream.showText(" information"); - contentStream.endText(); - } - } - - private void createRealPageWithMixedContent() throws IOException { - realPage = new PDPage(PDRectangle.A4); - while (realDocument.getNumberOfPages() > 0) { - realDocument.removePage(0); - } - realDocument.addPage(realPage); - realPage.setResources(new PDResources()); - realPage.getResources() - .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); - - try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { - contentStream.setLineWidth(2); - contentStream.moveTo(100, 100); - contentStream.lineTo(200, 200); - contentStream.stroke(); - - contentStream.beginText(); - contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); - contentStream.newLineAtOffset(50, 750); - contentStream.showText("Please redact this content"); - contentStream.endText(); - } - } - - private void createRealPageWithSpecificOperator(String operatorName) throws IOException { - createRealPageWithSimpleText("sensitive data"); - } - - private void createRealPageWithPositionedText() throws IOException { - realPage = new PDPage(PDRectangle.A4); - while (realDocument.getNumberOfPages() > 0) { - realDocument.removePage(0); - } - realDocument.addPage(realPage); - realPage.setResources(new PDResources()); - realPage.getResources() - .put(COSName.getPDFName("F1"), new PDType1Font(Standard14Fonts.FontName.HELVETICA)); - - try (PDPageContentStream contentStream = new PDPageContentStream(realDocument, realPage)) { - contentStream.beginText(); - contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); - contentStream.newLineAtOffset(50, 750); - contentStream.showText("Normal text "); - contentStream.newLineAtOffset(100, 0); - contentStream.showText("confidential"); - contentStream.newLineAtOffset(100, 0); - contentStream.showText(" more text"); - contentStream.endText(); - } - } - - // Helper for token creation - private List createSampleTokenList() { - return List.of( - Operator.getOperator("BT"), - COSName.getPDFName("F1"), - new COSFloat(12), - Operator.getOperator("Tf"), - new COSString("Sample text"), - Operator.getOperator("Tj"), - Operator.getOperator("ET")); - } - - private List getOriginalTokens() throws Exception { - // Create a new page to avoid side effects from other tests - PDPage pageForTokenExtraction = new PDPage(PDRectangle.A4); - pageForTokenExtraction.setResources(realPage.getResources()); - try (PDPageContentStream contentStream = - new PDPageContentStream(realDocument, pageForTokenExtraction)) { - contentStream.beginText(); - contentStream.setFont(realPage.getResources().getFont(COSName.getPDFName("F1")), 12); - contentStream.newLineAtOffset(50, 750); - contentStream.showText("Original content"); - contentStream.endText(); - } - return redactController.createTokensWithoutTargetText( - realDocument, pageForTokenExtraction, Collections.emptySet(), false, false); - } - - private String extractTextFromTokens(List tokens) { - StringBuilder text = new StringBuilder(); - for (Object token : tokens) { - if (token instanceof COSString cosString) { - text.append(cosString.getString()); - } else if (token instanceof COSArray array) { - for (int i = 0; i < array.size(); i++) { - if (array.getObject(i) instanceof COSString cosString) { - text.append(cosString.getString()); - } - } - } - } - return text.toString(); - } - - private String extractTextFromModifiedPage(PDPage page) throws IOException { - if (page.getContents() != null) { - try (InputStream inputStream = page.getContents()) { - return new String(readAllBytes(inputStream)); - } - } - return ""; - } - - private byte[] readAllBytes(InputStream inputStream) throws IOException { - ByteArrayOutputStream buffer = new ByteArrayOutputStream(); - int nRead; - byte[] data = new byte[1024]; - while ((nRead = inputStream.read(data, 0, data.length)) != -1) { - buffer.write(data, 0, nRead); - } - return buffer.toByteArray(); - } } diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/web/ConverterWebControllerTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/web/ConverterWebControllerTest.java new file mode 100644 index 0000000000..da73cf83c2 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/controller/web/ConverterWebControllerTest.java @@ -0,0 +1,231 @@ +package stirling.software.SPDF.controller.web; + +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +import java.util.stream.Stream; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.MethodSource; +import org.mockito.MockedStatic; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; + +import stirling.software.SPDF.config.EndpointConfiguration; +import stirling.software.common.model.ApplicationProperties; +import stirling.software.common.util.ApplicationContextProvider; +import stirling.software.common.util.CheckProgramInstall; + +@ExtendWith(MockitoExtension.class) +class ConverterWebControllerTest { + + private MockMvc mockMvc; + + private ConverterWebController controller; + + @BeforeEach + void setup() { + controller = new ConverterWebController(); + mockMvc = MockMvcBuilders.standaloneSetup(controller).build(); + } + + private static Stream simpleEndpoints() { + return Stream.of( + new Object[] {"/img-to-pdf", "convert/img-to-pdf", "img-to-pdf"}, + new Object[] {"/cbz-to-pdf", "convert/cbz-to-pdf", "cbz-to-pdf"}, + new Object[] {"/pdf-to-cbz", "convert/pdf-to-cbz", "pdf-to-cbz"}, + new Object[] {"/cbr-to-pdf", "convert/cbr-to-pdf", "cbr-to-pdf"}, + new Object[] {"/html-to-pdf", "convert/html-to-pdf", "html-to-pdf"}, + new Object[] {"/markdown-to-pdf", "convert/markdown-to-pdf", "markdown-to-pdf"}, + new Object[] {"/pdf-to-markdown", "convert/pdf-to-markdown", "pdf-to-markdown"}, + new Object[] {"/url-to-pdf", "convert/url-to-pdf", "url-to-pdf"}, + new Object[] {"/file-to-pdf", "convert/file-to-pdf", "file-to-pdf"}, + new Object[] {"/pdf-to-pdfa", "convert/pdf-to-pdfa", "pdf-to-pdfa"}, + new Object[] {"/pdf-to-vector", "convert/pdf-to-vector", "pdf-to-vector"}, + new Object[] {"/vector-to-pdf", "convert/vector-to-pdf", "vector-to-pdf"}, + new Object[] {"/pdf-to-xml", "convert/pdf-to-xml", "pdf-to-xml"}, + new Object[] {"/pdf-to-csv", "convert/pdf-to-csv", "pdf-to-csv"}, + new Object[] {"/pdf-to-html", "convert/pdf-to-html", "pdf-to-html"}, + new Object[] { + "/pdf-to-presentation", "convert/pdf-to-presentation", "pdf-to-presentation" + }, + new Object[] {"/pdf-to-text", "convert/pdf-to-text", "pdf-to-text"}, + new Object[] {"/pdf-to-word", "convert/pdf-to-word", "pdf-to-word"}, + new Object[] {"/eml-to-pdf", "convert/eml-to-pdf", "eml-to-pdf"}); + } + + @ParameterizedTest(name = "[{index}] GET {0}") + @MethodSource("simpleEndpoints") + @DisplayName("Should return correct view and model for simple endpoints") + void shouldReturnCorrectViewForSimpleEndpoints(String path, String viewName, String page) + throws Exception { + mockMvc.perform(get(path)) + .andExpect(status().isOk()) + .andExpect(view().name(viewName)) + .andExpect(model().attribute("currentPage", page)); + } + + @Nested + @DisplayName("PDF to CBR endpoint tests") + class PdfToCbrTests { + + @Test + @DisplayName("Should return 404 when endpoint disabled") + void shouldReturn404WhenDisabled() throws Exception { + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class)) { + EndpointConfiguration endpointConfig = mock(EndpointConfiguration.class); + when(endpointConfig.isEndpointEnabled(eq("pdf-to-cbr"))).thenReturn(false); + acp.when(() -> ApplicationContextProvider.getBean(EndpointConfiguration.class)) + .thenReturn(endpointConfig); + + mockMvc.perform(get("/pdf-to-cbr")).andExpect(status().isNotFound()); + } + } + + @Test + @DisplayName("Should return OK when endpoint enabled") + void shouldReturnOkWhenEnabled() throws Exception { + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class)) { + EndpointConfiguration endpointConfig = mock(EndpointConfiguration.class); + when(endpointConfig.isEndpointEnabled(eq("pdf-to-cbr"))).thenReturn(true); + acp.when(() -> ApplicationContextProvider.getBean(EndpointConfiguration.class)) + .thenReturn(endpointConfig); + + mockMvc.perform(get("/pdf-to-cbr")) + .andExpect(status().isOk()) + .andExpect(view().name("convert/pdf-to-cbr")) + .andExpect(model().attribute("currentPage", "pdf-to-cbr")); + } + } + } + + @Nested + @DisplayName("PDF to EPUB endpoint tests") + class PdfToEpubTests { + + @Test + @DisplayName("Should return 404 when endpoint disabled") + void shouldReturn404WhenDisabled() throws Exception { + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class)) { + EndpointConfiguration endpointConfig = mock(EndpointConfiguration.class); + when(endpointConfig.isEndpointEnabled(eq("pdf-to-epub"))).thenReturn(false); + acp.when(() -> ApplicationContextProvider.getBean(EndpointConfiguration.class)) + .thenReturn(endpointConfig); + + mockMvc.perform(get("/pdf-to-epub")).andExpect(status().isNotFound()); + } + } + + @Test + @DisplayName("Should return OK when endpoint enabled") + void shouldReturnOkWhenEnabled() throws Exception { + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class)) { + EndpointConfiguration endpointConfig = mock(EndpointConfiguration.class); + when(endpointConfig.isEndpointEnabled(eq("pdf-to-epub"))).thenReturn(true); + acp.when(() -> ApplicationContextProvider.getBean(EndpointConfiguration.class)) + .thenReturn(endpointConfig); + + mockMvc.perform(get("/pdf-to-epub")) + .andExpect(status().isOk()) + .andExpect(view().name("convert/pdf-to-epub")) + .andExpect(model().attribute("currentPage", "pdf-to-epub")); + } + } + } + + @Test + @DisplayName("Should handle pdf-to-img with default maxDPI=500") + void shouldHandlePdfToImgWithDefaultMaxDpi() throws Exception { + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class); + MockedStatic cpi = + org.mockito.Mockito.mockStatic(CheckProgramInstall.class)) { + cpi.when(CheckProgramInstall::isPythonAvailable).thenReturn(true); + acp.when(() -> ApplicationContextProvider.getBean(ApplicationProperties.class)) + .thenReturn(null); + + mockMvc.perform(get("/pdf-to-img")) + .andExpect(status().isOk()) + .andExpect(view().name("convert/pdf-to-img")) + .andExpect(model().attribute("isPython", true)) + .andExpect(model().attribute("maxDPI", 500)); + } + } + + @Test + @DisplayName("Should handle pdf-to-video with default maxDPI=500") + void shouldHandlePdfToVideoWithDefaultMaxDpi() throws Exception { + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class)) { + acp.when(() -> ApplicationContextProvider.getBean(ApplicationProperties.class)) + .thenReturn(null); + + mockMvc.perform(get("/pdf-to-video")) + .andExpect(status().isOk()) + .andExpect(view().name("convert/pdf-to-video")) + .andExpect(model().attribute("maxDPI", 500)) + .andExpect(model().attribute("currentPage", "pdf-to-video")); + } + } + + @Test + @DisplayName("Should handle pdf-to-img with configured maxDPI from properties") + void shouldHandlePdfToImgWithConfiguredMaxDpi() throws Exception { + // Covers the 'if' branch (properties and system not null) + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class); + MockedStatic cpi = + org.mockito.Mockito.mockStatic(CheckProgramInstall.class)) { + + ApplicationProperties properties = + org.mockito.Mockito.mock( + ApplicationProperties.class, org.mockito.Mockito.RETURNS_DEEP_STUBS); + when(properties.getSystem().getMaxDPI()).thenReturn(777); + acp.when(() -> ApplicationContextProvider.getBean(ApplicationProperties.class)) + .thenReturn(properties); + cpi.when(CheckProgramInstall::isPythonAvailable).thenReturn(true); + + mockMvc.perform(get("/pdf-to-img")) + .andExpect(status().isOk()) + .andExpect(view().name("convert/pdf-to-img")) + .andExpect(model().attribute("isPython", true)) + .andExpect(model().attribute("maxDPI", 777)) + .andExpect(model().attribute("currentPage", "pdf-to-img")); + } + } + + @Test + @DisplayName("Should handle pdf-to-video with configured maxDPI from properties") + void shouldHandlePdfToVideoWithConfiguredMaxDpi() throws Exception { + // Covers the 'if' branch (properties and system not null) + try (MockedStatic acp = + org.mockito.Mockito.mockStatic(ApplicationContextProvider.class)) { + + ApplicationProperties properties = + org.mockito.Mockito.mock( + ApplicationProperties.class, org.mockito.Mockito.RETURNS_DEEP_STUBS); + when(properties.getSystem().getMaxDPI()).thenReturn(640); + acp.when(() -> ApplicationContextProvider.getBean(ApplicationProperties.class)) + .thenReturn(properties); + + mockMvc.perform(get("/pdf-to-video")) + .andExpect(status().isOk()) + .andExpect(view().name("convert/pdf-to-video")) + .andExpect(model().attribute("maxDPI", 640)) + .andExpect(model().attribute("currentPage", "pdf-to-video")); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/controller/web/UploadLimitServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/controller/web/UploadLimitServiceTest.java index 49ca634a6e..219affcd30 100644 --- a/app/core/src/test/java/stirling/software/SPDF/controller/web/UploadLimitServiceTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/controller/web/UploadLimitServiceTest.java @@ -16,35 +16,8 @@ import stirling.software.common.model.ApplicationProperties; class UploadLimitServiceTest { private UploadLimitService uploadLimitService; - private ApplicationProperties applicationProperties; private ApplicationProperties.System systemProps; - @BeforeEach - void setUp() { - applicationProperties = mock(ApplicationProperties.class); - systemProps = mock(ApplicationProperties.System.class); - when(applicationProperties.getSystem()).thenReturn(systemProps); - - uploadLimitService = new UploadLimitService(); - // inject mock - try { - var field = UploadLimitService.class.getDeclaredField("applicationProperties"); - field.setAccessible(true); - field.set(uploadLimitService, applicationProperties); - } catch (ReflectiveOperationException e) { - throw new RuntimeException(e); - } - } - - @ParameterizedTest(name = "getUploadLimit case #{index}: input={0}, expected={1}") - @MethodSource("uploadLimitParams") - void shouldComputeUploadLimitCorrectly(String input, long expected) { - when(systemProps.getFileUploadLimit()).thenReturn(input); - - long result = uploadLimitService.getUploadLimit(); - assertEquals(expected, result); - } - static Stream uploadLimitParams() { return Stream.of( // empty or null input yields 0 @@ -56,11 +29,37 @@ class UploadLimitServiceTest { // valid formats Arguments.of("10KB", 10 * 1024L), Arguments.of("2MB", 2 * 1024 * 1024L), - Arguments.of("1GB", 1L * 1024 * 1024 * 1024), + Arguments.of("1GB", (long) 1024 * 1024 * 1024), Arguments.of("5mb", 5 * 1024 * 1024L), Arguments.of("0MB", 0L)); } + @ParameterizedTest(name = "getUploadLimit case #{index}: input={0}, expected={1}") + @MethodSource("uploadLimitParams") + void shouldComputeUploadLimitCorrectly(String input, long expected) { + when(systemProps.getFileUploadLimit()).thenReturn(input); + + long result = uploadLimitService.getUploadLimit(); + assertEquals(expected, result); + } + + @BeforeEach + void setUp() { + ApplicationProperties applicationProperties = mock(ApplicationProperties.class); + systemProps = mock(ApplicationProperties.System.class); + when(applicationProperties.getSystem()).thenReturn(systemProps); + + uploadLimitService = new UploadLimitService(); + // inject mock + try { + var field = UploadLimitService.class.getDeclaredField("applicationProperties"); + field.setAccessible(true); + field.set(uploadLimitService, applicationProperties); + } catch (ReflectiveOperationException e) { + throw new RuntimeException(e); + } + } + @ParameterizedTest(name = "getReadableUploadLimit case #{index}: rawValue={0}, expected={1}") @MethodSource("readableLimitParams") void shouldReturnReadableFormat(String rawValue, String expected) { diff --git a/app/core/src/test/java/stirling/software/SPDF/model/ApiEndpointTest.java b/app/core/src/test/java/stirling/software/SPDF/model/ApiEndpointTest.java new file mode 100644 index 0000000000..769aa6b9b5 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/model/ApiEndpointTest.java @@ -0,0 +1,104 @@ +package stirling.software.SPDF.model; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.HashMap; +import java.util.Map; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; + +class ApiEndpointTest { + + private final ObjectMapper mapper = new ObjectMapper(); + + private JsonNode postNodeWithParams(String description, String... names) { + ObjectNode post = mapper.createObjectNode(); + post.put("description", description); + ArrayNode params = mapper.createArrayNode(); + for (String n : names) { + ObjectNode p = mapper.createObjectNode(); + if (n != null) { + p.put("name", n); + } + params.add(p); + } + post.set("parameters", params); + return post; + } + + @Test + void parses_description_and_validates_required_parameters() { + JsonNode post = postNodeWithParams("Convert PDF to Markdown", "file", "mode"); + ApiEndpoint endpoint = new ApiEndpoint("pdfToMd", post); + + assertEquals("Convert PDF to Markdown", endpoint.getDescription()); + + Map provided = new HashMap<>(); + provided.put("file", new byte[] {1}); + provided.put("mode", "fast"); + + assertTrue( + endpoint.areParametersValid(provided), "All required keys present should be valid"); + } + + @Test + void missing_any_required_parameter_returns_false() { + JsonNode post = postNodeWithParams("desc", "file", "mode"); + ApiEndpoint endpoint = new ApiEndpoint("pdfToMd", post); + + Map provided = new HashMap<>(); + provided.put("file", new byte[] {1}); + + assertFalse(endpoint.areParametersValid(provided)); + } + + @Test + void extra_parameters_are_ignored_if_required_are_present() { + JsonNode post = postNodeWithParams("desc", "file"); + ApiEndpoint endpoint = new ApiEndpoint("x", post); + + Map provided = new HashMap<>(); + provided.put("file", new byte[] {1}); + provided.put("extra", 123); + + assertTrue(endpoint.areParametersValid(provided)); + } + + @Test + void no_parameters_defined_accepts_empty_input() { + JsonNode postEmptyArray = postNodeWithParams("desc" /* no names */); + ApiEndpoint endpointA = new ApiEndpoint("a", postEmptyArray); + assertTrue(endpointA.areParametersValid(Map.of())); + + ObjectNode postNoField = mapper.createObjectNode(); + postNoField.put("description", "desc"); + ApiEndpoint endpointB = new ApiEndpoint("b", postNoField); + assertTrue(endpointB.areParametersValid(Map.of())); + } + + @Test + void parameter_without_name_creates_empty_required_key() { + JsonNode post = postNodeWithParams("desc", (String) null); + ApiEndpoint endpoint = new ApiEndpoint("y", post); + + assertFalse(endpoint.areParametersValid(Map.of())); + + assertTrue(endpoint.areParametersValid(Map.of("", 42))); + } + + @Test + void toString_contains_name_and_parameter_names() { + JsonNode post = postNodeWithParams("desc", "file", "mode"); + ApiEndpoint endpoint = new ApiEndpoint("pdfToMd", post); + + String s = endpoint.toString(); + assertTrue(s.contains("pdfToMd")); + assertTrue(s.contains("file")); + assertTrue(s.contains("mode")); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/model/SortTypesTest.java b/app/core/src/test/java/stirling/software/SPDF/model/SortTypesTest.java new file mode 100644 index 0000000000..87fe933053 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/model/SortTypesTest.java @@ -0,0 +1,54 @@ +package stirling.software.SPDF.model; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.Arrays; +import java.util.Set; +import java.util.stream.Collectors; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.EnumSource; + +class SortTypesTest { + + private static final Set EXPECTED = + Set.of( + "CUSTOM", + "REVERSE_ORDER", + "DUPLEX_SORT", + "BOOKLET_SORT", + "SIDE_STITCH_BOOKLET_SORT", + "ODD_EVEN_SPLIT", + "ODD_EVEN_MERGE", + "REMOVE_FIRST", + "REMOVE_LAST", + "REMOVE_FIRST_AND_LAST", + "DUPLICATE"); + + @Test + void contains_exactly_expected_constants() { + Set actual = + Arrays.stream(SortTypes.values()).map(Enum::name).collect(Collectors.toSet()); + + assertEquals( + EXPECTED, + actual, + () -> "Enum constants mismatch.\nExpected: " + EXPECTED + "\nActual: " + actual); + } + + @ParameterizedTest + @EnumSource(SortTypes.class) + void valueOf_roundtrip(SortTypes type) { + assertEquals(type, SortTypes.valueOf(type.name())); + } + + @Test + void names_are_unique_and_uppercase() { + String[] names = Arrays.stream(SortTypes.values()).map(Enum::name).toArray(String[]::new); + assertEquals(names.length, Set.of(names).size(), "Duplicate enum names?"); + for (String n : names) { + assertEquals(n, n.toUpperCase(), "Enum name not uppercase: " + n); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/model/api/PDFWithPageNumsTest.java b/app/core/src/test/java/stirling/software/SPDF/model/api/PDFWithPageNumsTest.java new file mode 100644 index 0000000000..50489567c1 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/model/api/PDFWithPageNumsTest.java @@ -0,0 +1,84 @@ +package stirling.software.SPDF.model.api; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.util.List; + +import org.apache.pdfbox.pdmodel.PDDocument; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +class PDFWithPageNumsTest { + + private PDFWithPageNums pdfWithPageNums; + private PDDocument mockDocument; + + @BeforeEach + void setUp() { + pdfWithPageNums = new PDFWithPageNums(); + mockDocument = mock(PDDocument.class); + } + + @Test + void testGetPageNumbersList_AllPages() { + pdfWithPageNums.setPageNumbers("all"); + when(mockDocument.getNumberOfPages()).thenReturn(10); + + List result = pdfWithPageNums.getPageNumbersList(mockDocument, true); + + assertEquals(List.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10), result); + } + + @Test + void testGetPageNumbersList_135_7Pages() { + pdfWithPageNums.setPageNumbers("1,3,5-7"); + when(mockDocument.getNumberOfPages()).thenReturn(10); + + List result = pdfWithPageNums.getPageNumbersList(mockDocument, true); + + assertEquals(List.of(1, 3, 5, 6, 7), result); + } + + @Test + void testGetPageNumbersList_2nPlus1Pages() { + pdfWithPageNums.setPageNumbers("2n+1"); + when(mockDocument.getNumberOfPages()).thenReturn(10); + + List result = pdfWithPageNums.getPageNumbersList(mockDocument, true); + + assertEquals(List.of(3, 5, 7, 9), result); + } + + @Test + void testGetPageNumbersList_3nPages() { + pdfWithPageNums.setPageNumbers("3n"); + when(mockDocument.getNumberOfPages()).thenReturn(10); + + List result = pdfWithPageNums.getPageNumbersList(mockDocument, true); + + assertEquals(List.of(3, 6, 9), result); + } + + @Test + void testGetPageNumbersList_EmptyInput() { + pdfWithPageNums.setPageNumbers(""); + when(mockDocument.getNumberOfPages()).thenReturn(10); + + List result = pdfWithPageNums.getPageNumbersList(mockDocument, true); + + assertTrue(result.isEmpty()); + } + + @Test + void testGetPageNumbersList_InvalidInput() { + pdfWithPageNums.setPageNumbers("invalid"); + when(mockDocument.getNumberOfPages()).thenReturn(10); + + assertThrows( + IllegalArgumentException.class, + () -> { + pdfWithPageNums.getPageNumbersList(mockDocument, true); + }); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/model/api/converters/ConvertPDFToMarkdownTest.java b/app/core/src/test/java/stirling/software/SPDF/model/api/converters/ConvertPDFToMarkdownTest.java new file mode 100644 index 0000000000..ca24ff46f0 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/model/api/converters/ConvertPDFToMarkdownTest.java @@ -0,0 +1,109 @@ +package stirling.software.SPDF.model.api.converters; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +import java.nio.charset.StandardCharsets; + +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; +import org.mockito.MockedConstruction; +import org.mockito.Mockito; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.mock.web.MockMultipartFile; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.multipart.MultipartFile; + +import stirling.software.common.util.PDFToFile; + +class ConvertPDFToMarkdownTest { + + private MockMvc mockMvc() { + return MockMvcBuilders.standaloneSetup(new ConvertPDFToMarkdown(null)) + .setControllerAdvice(new GlobalErrorHandler()) + .build(); + } + + @RestControllerAdvice + static class GlobalErrorHandler { + @ExceptionHandler(Exception.class) + ResponseEntity handle(Exception ex) { + String message = ex.getMessage(); + byte[] body = message != null ? message.getBytes(StandardCharsets.UTF_8) : new byte[0]; + return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(body); + } + } + + @Test + void pdfToMarkdownReturnsMarkdownBytes() throws Exception { + byte[] md = "# heading\n\ncontent\n".getBytes(StandardCharsets.UTF_8); + + try (MockedConstruction construction = + Mockito.mockConstruction( + PDFToFile.class, + (mock, ctx) -> { + when(mock.processPdfToMarkdown(any(MultipartFile.class))) + .thenAnswer( + inv -> + ResponseEntity.ok() + .header("Content-Type", "text/markdown") + .body(md)); + })) { + + MockMvc mvc = mockMvc(); + + MockMultipartFile file = + new MockMultipartFile( + "fileInput", // must match the field name in PDFFile + "input.pdf", + "application/pdf", + new byte[] {1, 2, 3}); + + mvc.perform(multipart("/api/v1/convert/pdf/markdown").file(file)) + .andExpect(status().isOk()) + .andExpect(header().string("Content-Type", "text/markdown")) + .andExpect(content().bytes(md)); + + // Verify that exactly one instance was created + assert construction.constructed().size() == 1; + + // And that the uploaded file was passed to processPdfToMarkdown() + PDFToFile created = construction.constructed().get(0); + ArgumentCaptor captor = ArgumentCaptor.forClass(MultipartFile.class); + verify(created, times(1)).processPdfToMarkdown(captor.capture()); + MultipartFile passed = captor.getValue(); + + // Minimal plausibility checks + assertEquals("input.pdf", passed.getOriginalFilename()); + assertEquals("application/pdf", passed.getContentType()); + } + } + + @Test + void pdfToMarkdownWhenServiceThrowsReturns500() throws Exception { + try (MockedConstruction ignored = + Mockito.mockConstruction( + PDFToFile.class, + (mock, ctx) -> { + when(mock.processPdfToMarkdown(any(MultipartFile.class))) + .thenThrow(new RuntimeException("boom")); + })) { + + MockMvc mvc = mockMvc(); + + MockMultipartFile file = + new MockMultipartFile( + "fileInput", "x.pdf", "application/pdf", new byte[] {0x01}); + + mvc.perform(multipart("/api/v1/convert/pdf/markdown").file(file)) + .andExpect(status().isInternalServerError()); + } + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/model/api/misc/ScannerEffectRequestTest.java b/app/core/src/test/java/stirling/software/SPDF/model/api/misc/ScannerEffectRequestTest.java new file mode 100644 index 0000000000..be9c3ea61f --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/model/api/misc/ScannerEffectRequestTest.java @@ -0,0 +1,130 @@ +package stirling.software.SPDF.model.api.misc; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.Set; +import java.util.stream.Collectors; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.mock.web.MockMultipartFile; + +import jakarta.validation.ConstraintViolation; +import jakarta.validation.Validation; +import jakarta.validation.Validator; +import jakarta.validation.ValidatorFactory; + +class ScannerEffectRequestTest { + + private static Validator validator; + + @BeforeAll + static void setupValidator() { + ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); + validator = factory.getValidator(); + } + + @Test + @DisplayName("fileInput is @NotNull -> violation when missing") + void fileInput_missing_triggersViolation() { + ScannerEffectRequest req = new ScannerEffectRequest(); + + Set> violations = validator.validate(req); + boolean hasFileInputViolation = + violations.stream() + .anyMatch(v -> "fileInput".contentEquals(v.getPropertyPath().toString())); + + assertTrue( + hasFileInputViolation, + () -> + "Expected a validation violation on 'fileInput', but got: " + + violations.stream() + .map(v -> v.getPropertyPath() + " -> " + v.getMessage()) + .collect(Collectors.joining(", "))); + } + + @Test + @DisplayName("fileInput present -> no violation for fileInput") + void fileInput_present_noViolationForThatField() { + ScannerEffectRequest req = new ScannerEffectRequest(); + req.setFileInput( + new MockMultipartFile( + "fileInput", "test.pdf", "application/pdf", new byte[] {1, 2, 3})); + + Set> violations = validator.validate(req); + + boolean hasFileInputViolation = + violations.stream() + .anyMatch(v -> "fileInput".contentEquals(v.getPropertyPath().toString())); + + assertFalse( + hasFileInputViolation, + () -> + "Did not expect a validation violation on 'fileInput', but got: " + + violations.stream() + .map(v -> v.getPropertyPath() + " -> " + v.getMessage()) + .collect(Collectors.joining(", "))); + } + + @Test + @DisplayName("applyHighQualityPreset sets documented values") + void preset_highQuality() { + ScannerEffectRequest req = new ScannerEffectRequest(); + req.applyHighQualityPreset(); + + assertEquals(0.1f, req.getBlur(), 0.0001f); + assertEquals(1.0f, req.getNoise(), 0.0001f); + assertEquals(1.03f, req.getBrightness(), 0.0001f); + assertEquals(1.06f, req.getContrast(), 0.0001f); + assertEquals(150, req.getResolution()); + } + + @Test + @DisplayName("applyMediumQualityPreset sets documented values") + void preset_mediumQuality() { + ScannerEffectRequest req = new ScannerEffectRequest(); + req.applyMediumQualityPreset(); + + assertEquals(0.1f, req.getBlur(), 0.0001f); + assertEquals(1.0f, req.getNoise(), 0.0001f); + assertEquals(1.06f, req.getBrightness(), 0.0001f); + assertEquals(1.12f, req.getContrast(), 0.0001f); + assertEquals(100, req.getResolution()); + } + + @Test + @DisplayName("applyLowQualityPreset sets documented values") + void preset_lowQuality() { + ScannerEffectRequest req = new ScannerEffectRequest(); + req.applyLowQualityPreset(); + + assertEquals(0.9f, req.getBlur(), 0.0001f); + assertEquals(2.5f, req.getNoise(), 0.0001f); + assertEquals(1.08f, req.getBrightness(), 0.0001f); + assertEquals(1.15f, req.getContrast(), 0.0001f); + assertEquals(75, req.getResolution()); + } + + @Test + @DisplayName("getRotationValue() maps enum values to expected degrees") + void rotationValue_mapping() { + ScannerEffectRequest req = new ScannerEffectRequest(); + + // none -> 0 + req.setRotation(ScannerEffectRequest.Rotation.none); + assertEquals(0, req.getRotationValue(), "Rotation 'none' should map to 0°"); + + // slight -> 2 + req.setRotation(ScannerEffectRequest.Rotation.slight); + assertEquals(2, req.getRotationValue(), "Rotation 'slight' should map to 2°"); + + // moderate -> 5 + req.setRotation(ScannerEffectRequest.Rotation.moderate); + assertEquals(5, req.getRotationValue(), "Rotation 'moderate' should map to 5°"); + + // severe -> 8 + req.setRotation(ScannerEffectRequest.Rotation.severe); + assertEquals(8, req.getRotationValue(), "Rotation 'severe' should map to 8°"); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/pdf/FlexibleCSVWriterTest.java b/app/core/src/test/java/stirling/software/SPDF/pdf/FlexibleCSVWriterTest.java new file mode 100644 index 0000000000..77637ece51 --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/pdf/FlexibleCSVWriterTest.java @@ -0,0 +1,25 @@ +package stirling.software.SPDF.pdf; + +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import org.apache.commons.csv.CSVFormat; +import org.junit.jupiter.api.Test; + +class FlexibleCSVWriterTest { + + @Test + void testDefaultConstructor() { + FlexibleCSVWriter writer = new FlexibleCSVWriter(); + assertNotNull(writer, "The FlexibleCSVWriter instance should not be null"); + } + + @Test + void testConstructorWithCSVFormat() { + CSVFormat csvFormat = CSVFormat.DEFAULT; + FlexibleCSVWriter writer = new FlexibleCSVWriter(csvFormat); + assertNotNull( + writer, + "The FlexibleCSVWriter instance should not be null when initialized with" + + " CSVFormat"); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/pdf/TextFinderTest.java b/app/core/src/test/java/stirling/software/SPDF/pdf/TextFinderTest.java index 3e50920707..8b5b4eaf25 100644 --- a/app/core/src/test/java/stirling/software/SPDF/pdf/TextFinderTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/pdf/TextFinderTest.java @@ -1,13 +1,10 @@ package stirling.software.SPDF.pdf; -import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.*; import java.io.IOException; import java.util.List; +import java.util.Locale; import org.apache.pdfbox.pdmodel.PDDocument; import org.apache.pdfbox.pdmodel.PDPage; @@ -53,13 +50,16 @@ class TextFinderTest { expectedCount, foundTexts.size(), String.format( - "Expected %d matches for search term '%s'", expectedCount, searchTerm)); + Locale.ROOT, + "Expected %d matches for search term '%s'", + expectedCount, + searchTerm)); if (expectedTexts != null) { for (String expectedText : expectedTexts) { assertTrue( foundTexts.stream().anyMatch(text -> text.getText().equals(expectedText)), - String.format("Expected to find text: '%s'", expectedText)); + String.format(Locale.ROOT, "Expected to find text: '%s'", expectedText)); } } @@ -275,7 +275,10 @@ class TextFinderTest { // Each pattern should find at least one match in our test content assertFalse( foundTexts.isEmpty(), - String.format("Pattern '%s' should find at least one match", regexPattern)); + String.format( + Locale.ROOT, + "Pattern '%s' should find at least one match", + regexPattern)); } @Test @@ -409,11 +412,11 @@ class TextFinderTest { addTextToPage(document.getPage(i), "Page " + i + " contains searchable content."); } - long startTime = System.currentTimeMillis(); + long startTime = 1000000L; // Fixed start time TextFinder textFinder = new TextFinder("searchable", false, false); textFinder.getText(document); List foundTexts = textFinder.getFoundTexts(); - long endTime = System.currentTimeMillis(); + long endTime = 1001000L; // Fixed end time assertEquals(10, foundTexts.size()); assertTrue( diff --git a/app/core/src/test/java/stirling/software/SPDF/service/ApiDocServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/service/ApiDocServiceTest.java new file mode 100644 index 0000000000..2317abfb9d --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/service/ApiDocServiceTest.java @@ -0,0 +1,124 @@ +package stirling.software.SPDF.service; + +import static org.junit.jupiter.api.Assertions.*; + +import java.lang.reflect.Field; +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 com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +import jakarta.servlet.ServletContext; + +import stirling.software.SPDF.model.ApiEndpoint; +import stirling.software.common.service.UserServiceInterface; + +@ExtendWith(MockitoExtension.class) +class ApiDocServiceTest { + + @Mock ServletContext servletContext; + @Mock UserServiceInterface userService; + + ApiDocService apiDocService; + ObjectMapper mapper = new ObjectMapper(); + + @BeforeEach + void setUp() { + apiDocService = new ApiDocService(servletContext, userService); + } + + private void setApiDocumentation(Map docs) throws Exception { + Field field = ApiDocService.class.getDeclaredField("apiDocumentation"); + field.setAccessible(true); + @SuppressWarnings("unchecked") + Map map = (Map) field.get(apiDocService); + map.clear(); + map.putAll(docs); + } + + private void setApiDocsJsonRootNode() throws Exception { + Field field = ApiDocService.class.getDeclaredField("apiDocsJsonRootNode"); + field.setAccessible(true); + field.set(apiDocService, mapper.createObjectNode()); + } + + @Test + void getExtensionTypesReturnsExpectedList() throws Exception { + String json = "{\"description\": \"Output:PDF\"}"; + JsonNode postNode = mapper.readTree(json); + ApiEndpoint endpoint = new ApiEndpoint("/test", postNode); + + setApiDocumentation(Map.of("/test", endpoint)); + setApiDocsJsonRootNode(); + + List extensions = apiDocService.getExtensionTypes(true, "/test"); + assertEquals(List.of("pdf"), extensions); + } + + @Test + void getExtensionTypesHandlesUnknownOperation() throws Exception { + setApiDocumentation(Map.of()); + + List extensions = apiDocService.getExtensionTypes(true, "/unknown"); + assertNull(extensions); + } + + @Test + void isValidOperationChecksRequiredParameters() throws Exception { + String json = + "{\"description\": \"desc\", \"parameters\": [{\"name\":\"param1\"}, {\"name\":\"param2\"}]}"; + JsonNode postNode = mapper.readTree(json); + ApiEndpoint endpoint = new ApiEndpoint("/op", postNode); + + setApiDocumentation(Map.of("/op", endpoint)); + setApiDocsJsonRootNode(); + + assertTrue(apiDocService.isValidOperation("/op", Map.of("param1", "a", "param2", "b"))); + assertFalse(apiDocService.isValidOperation("/op", Map.of("param1", "a"))); + } + + @Test + void isValidOperationHandlesUnknownOperation() throws Exception { + setApiDocumentation(Map.of()); + + assertFalse(apiDocService.isValidOperation("/unknown", Map.of("param1", "a"))); + } + + @Test + void isMultiInputDetectsTypeMI() throws Exception { + String json = "{\"description\": \"Type:MI\"}"; + JsonNode postNode = mapper.readTree(json); + ApiEndpoint endpoint = new ApiEndpoint("/multi", postNode); + + setApiDocumentation(Map.of("/multi", endpoint)); + setApiDocsJsonRootNode(); + + assertTrue(apiDocService.isMultiInput("/multi")); + } + + @Test + void isMultiInputDetectsUnknownOperation() throws Exception { + setApiDocumentation(Map.of()); + + assertFalse(apiDocService.isMultiInput("/unknown")); + } + + @Test + void isMultiInputHandlesNoDescription() throws Exception { + String json = "{\"parameters\": [{\"name\":\"param1\"}, {\"name\":\"param2\"}]}"; + JsonNode postNode = mapper.readTree(json); + ApiEndpoint endpoint = new ApiEndpoint("/multi", postNode); + + setApiDocumentation(Map.of("/multi", endpoint)); + setApiDocsJsonRootNode(); + + assertFalse(apiDocService.isMultiInput("/multi")); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/service/AttachmentServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/service/AttachmentServiceTest.java index 0ca86b8da2..387ed0e33e 100644 --- a/app/core/src/test/java/stirling/software/SPDF/service/AttachmentServiceTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/service/AttachmentServiceTest.java @@ -7,11 +7,15 @@ import static org.mockito.Mockito.when; import java.io.ByteArrayInputStream; import java.io.IOException; import java.util.List; +import java.util.Optional; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; import org.apache.pdfbox.pdmodel.PDDocument; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.http.MediaType; +import org.springframework.mock.web.MockMultipartFile; import org.springframework.web.multipart.MultipartFile; class AttachmentServiceTest { @@ -105,4 +109,86 @@ class AttachmentServiceTest { assertNotNull(result.getDocumentCatalog().getNames()); } } + + @Test + void extractAttachments_SanitizesFilenamesAndExtractsData() throws IOException { + attachmentService = new AttachmentService(1024 * 1024, 5 * 1024 * 1024); + + try (var document = new PDDocument()) { + var maliciousAttachment = + new MockMultipartFile( + "file", + "..\\evil/../../tricky.txt", + MediaType.TEXT_PLAIN_VALUE, + "danger".getBytes()); + + attachmentService.addAttachment(document, List.of(maliciousAttachment)); + + Optional extracted = attachmentService.extractAttachments(document); + assertTrue(extracted.isPresent()); + + try (var zipInputStream = + new ZipInputStream(new ByteArrayInputStream(extracted.get()))) { + ZipEntry entry = zipInputStream.getNextEntry(); + assertNotNull(entry); + String sanitizedName = entry.getName(); + + assertFalse(sanitizedName.contains("..")); + assertFalse(sanitizedName.contains("/")); + assertFalse(sanitizedName.contains("\\")); + + byte[] data = zipInputStream.readAllBytes(); + assertArrayEquals("danger".getBytes(), data); + assertNull(zipInputStream.getNextEntry()); + } + } + } + + @Test + void extractAttachments_SkipsAttachmentsExceedingSizeLimit() throws IOException { + attachmentService = new AttachmentService(4, 10); + + try (var document = new PDDocument()) { + var oversizedAttachment = + new MockMultipartFile( + "file", + "large.bin", + MediaType.APPLICATION_OCTET_STREAM_VALUE, + "too big".getBytes()); + + attachmentService.addAttachment(document, List.of(oversizedAttachment)); + + Optional extracted = attachmentService.extractAttachments(document); + assertTrue(extracted.isEmpty()); + } + } + + @Test + void extractAttachments_EnforcesTotalSizeLimit() throws IOException { + attachmentService = new AttachmentService(10, 9); + + try (var document = new PDDocument()) { + var first = + new MockMultipartFile( + "file", "first.txt", MediaType.TEXT_PLAIN_VALUE, "12345".getBytes()); + var second = + new MockMultipartFile( + "file", "second.txt", MediaType.TEXT_PLAIN_VALUE, "67890".getBytes()); + + attachmentService.addAttachment(document, List.of(first, second)); + + Optional extracted = attachmentService.extractAttachments(document); + assertTrue(extracted.isPresent()); + + try (var zipInputStream = + new ZipInputStream(new ByteArrayInputStream(extracted.get()))) { + ZipEntry firstEntry = zipInputStream.getNextEntry(); + assertNotNull(firstEntry); + assertEquals("first.txt", firstEntry.getName()); + byte[] firstData = zipInputStream.readNBytes(5); + assertArrayEquals("12345".getBytes(), firstData); + assertNull(zipInputStream.getNextEntry()); + } + } + } } diff --git a/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceBasicTest.java b/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceBasicTest.java index f351abc8ee..542ebe8af1 100644 --- a/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceBasicTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceBasicTest.java @@ -1,11 +1,9 @@ package stirling.software.SPDF.service; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -import java.io.IOException; import java.util.Arrays; import java.util.Collections; import java.util.Set; @@ -33,12 +31,19 @@ class LanguageServiceBasicTest { languageService = new LanguageServiceForTest(applicationProperties); } + // Helper methods + private static Resource createMockResource(String filename) { + Resource mockResource = mock(Resource.class); + when(mockResource.getFilename()).thenReturn(filename); + return mockResource; + } + @Test - void testGetSupportedLanguages_BasicFunctionality() throws IOException { + void testGetSupportedLanguages_BasicFunctionality() { // Set up mocked resources Resource enResource = createMockResource("messages_en_US.properties"); Resource frResource = createMockResource("messages_fr_FR.properties"); - Resource[] mockResources = new Resource[] {enResource, frResource}; + Resource[] mockResources = {enResource, frResource}; // Configure the test service ((LanguageServiceForTest) languageService).setMockResources(mockResources); @@ -53,14 +58,13 @@ class LanguageServiceBasicTest { } @Test - void testGetSupportedLanguages_FilteringInvalidFiles() throws IOException { + void testGetSupportedLanguages_FilteringInvalidFiles() { // Set up mocked resources with invalid files - Resource[] mockResources = - new Resource[] { - createMockResource("messages_en_US.properties"), // Valid - createMockResource("invalid_file.properties"), // Invalid - createMockResource(null) // Null filename - }; + Resource[] mockResources = { + createMockResource("messages_en_US.properties"), // Valid + createMockResource("invalid_file.properties"), // Invalid + createMockResource(null) // Null filename + }; // Configure the test service ((LanguageServiceForTest) languageService).setMockResources(mockResources); @@ -77,15 +81,14 @@ class LanguageServiceBasicTest { } @Test - void testGetSupportedLanguages_WithRestrictions() throws IOException { + void testGetSupportedLanguages_WithRestrictions() { // Set up test resources - Resource[] mockResources = - new Resource[] { - createMockResource("messages_en_US.properties"), - createMockResource("messages_fr_FR.properties"), - createMockResource("messages_de_DE.properties"), - createMockResource("messages_en_GB.properties") - }; + Resource[] mockResources = { + createMockResource("messages_en_US.properties"), + createMockResource("messages_fr_FR.properties"), + createMockResource("messages_de_DE.properties"), + createMockResource("messages_en_GB.properties") + }; // Configure the test service ((LanguageServiceForTest) languageService).setMockResources(mockResources); @@ -104,13 +107,6 @@ class LanguageServiceBasicTest { assertFalse(supportedLanguages.contains("de_DE"), "Restricted language should be excluded"); } - // Helper methods - private Resource createMockResource(String filename) { - Resource mockResource = mock(Resource.class); - when(mockResource.getFilename()).thenReturn(filename); - return mockResource; - } - // Test subclass private static class LanguageServiceForTest extends LanguageService { private Resource[] mockResources; @@ -124,7 +120,7 @@ class LanguageServiceBasicTest { } @Override - protected Resource[] getResourcesFromPattern(String pattern) throws IOException { + protected Resource[] getResourcesFromPattern(String pattern) { return mockResources; } } diff --git a/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceTest.java index 24685e3b7d..b6587cd28f 100644 --- a/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/service/LanguageServiceTest.java @@ -15,7 +15,6 @@ import java.util.Set; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.core.io.Resource; -import org.springframework.core.io.support.PathMatchingResourcePatternResolver; import stirling.software.common.model.ApplicationProperties; import stirling.software.common.model.ApplicationProperties.Ui; @@ -24,10 +23,15 @@ class LanguageServiceTest { private LanguageService languageService; private ApplicationProperties applicationProperties; - private PathMatchingResourcePatternResolver mockedResolver; + + private static Resource createMockResource(String filename) { + Resource mockResource = mock(Resource.class); + when(mockResource.getFilename()).thenReturn(filename); + return mockResource; + } @BeforeEach - void setUp() throws Exception { + void setUp() { // Mock ApplicationProperties applicationProperties = mock(ApplicationProperties.class); Ui ui = mock(Ui.class); @@ -38,7 +42,7 @@ class LanguageServiceTest { } @Test - void testGetSupportedLanguages_NoRestrictions() throws IOException { + void testGetSupportedLanguages_NoRestrictions() { // Setup Set expectedLanguages = new HashSet<>(Arrays.asList("en_US", "fr_FR", "de_DE", "en_GB")); @@ -61,7 +65,7 @@ class LanguageServiceTest { } @Test - void testGetSupportedLanguages_WithRestrictions() throws IOException { + void testGetSupportedLanguages_WithRestrictions() { // Setup Set expectedLanguages = new HashSet<>(Arrays.asList("en_US", "fr_FR", "de_DE", "en_GB")); @@ -87,7 +91,7 @@ class LanguageServiceTest { } @Test - void testGetSupportedLanguages_ExceptionHandling() throws IOException { + void testGetSupportedLanguages_ExceptionHandling() { // Setup - make resolver throw an exception ((LanguageServiceForTest) languageService).setShouldThrowException(true); @@ -98,19 +102,24 @@ class LanguageServiceTest { assertTrue(supportedLanguages.isEmpty(), "Should return empty set on exception"); } + // Helper methods to create mock resources + private Resource[] createMockResources(Set languages) { + return languages.stream() + .map(lang -> createMockResource("messages_" + lang + ".properties")) + .toArray(Resource[]::new); + } + @Test - void testGetSupportedLanguages_FilteringNonMatchingFiles() throws IOException { + void testGetSupportedLanguages_FilteringNonMatchingFiles() { // Setup with some valid and some invalid filenames - Resource[] mixedResources = - new Resource[] { - createMockResource("messages_en_US.properties"), - createMockResource( - "messages_en_GB.properties"), // Explicitly add en_GB resource - createMockResource("messages_fr_FR.properties"), - createMockResource("not_a_messages_file.properties"), - createMockResource("messages_.properties"), // Invalid format - createMockResource(null) // Null filename - }; + Resource[] mixedResources = { + createMockResource("messages_en_US.properties"), + createMockResource("messages_en_GB.properties"), // Explicitly add en_GB resource + createMockResource("messages_fr_FR.properties"), + createMockResource("not_a_messages_file.properties"), + createMockResource("messages_.properties"), // Invalid format + createMockResource(null) // Null filename + }; ((LanguageServiceForTest) languageService).setMockResources(mixedResources); when(applicationProperties.getUi().getLanguages()).thenReturn(Collections.emptyList()); @@ -132,19 +141,6 @@ class LanguageServiceTest { // language codes } - // Helper methods to create mock resources - private Resource[] createMockResources(Set languages) { - return languages.stream() - .map(lang -> createMockResource("messages_" + lang + ".properties")) - .toArray(Resource[]::new); - } - - private Resource createMockResource(String filename) { - Resource mockResource = mock(Resource.class); - when(mockResource.getFilename()).thenReturn(filename); - return mockResource; - } - // Test subclass that allows us to control the resource resolver private static class LanguageServiceForTest extends LanguageService { private Resource[] mockResources; diff --git a/app/core/src/test/java/stirling/software/SPDF/service/MetricsAggregatorServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/service/MetricsAggregatorServiceTest.java new file mode 100644 index 0000000000..c14b00e4af --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/service/MetricsAggregatorServiceTest.java @@ -0,0 +1,75 @@ +package stirling.software.SPDF.service; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.*; + +import java.util.Map; +import java.util.Set; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.simple.SimpleMeterRegistry; + +import stirling.software.SPDF.config.EndpointInspector; +import stirling.software.common.service.PostHogService; + +class MetricsAggregatorServiceTest { + + private SimpleMeterRegistry meterRegistry; + private PostHogService postHogService; + private EndpointInspector endpointInspector; + private MetricsAggregatorService metricsAggregatorService; + + @BeforeEach + void setUp() { + meterRegistry = new SimpleMeterRegistry(); + postHogService = mock(PostHogService.class); + endpointInspector = mock(EndpointInspector.class); + when(endpointInspector.getValidGetEndpoints()).thenReturn(Set.of("/getEndpoint")); + when(endpointInspector.isValidGetEndpoint("/getEndpoint")).thenReturn(true); + metricsAggregatorService = + new MetricsAggregatorService(meterRegistry, postHogService, endpointInspector); + } + + @Captor private ArgumentCaptor> captor; + + @Test + void testAggregateAndSendMetrics() { + meterRegistry.counter("http.requests", "method", "GET", "uri", "/getEndpoint").increment(3); + meterRegistry.counter("http.requests", "method", "POST", "uri", "/api/v1/do").increment(2); + + metricsAggregatorService.aggregateAndSendMetrics(); + + ArgumentCaptor> captor = ArgumentCaptor.forClass(Map.class); + verify(postHogService).captureEvent(eq("aggregated_metrics"), captor.capture()); + Map metrics = captor.getValue(); + + assertEquals(2, metrics.size()); + assertEquals(3.0, (Double) metrics.get("http_requests_GET__getEndpoint")); + assertEquals(2.0, (Double) metrics.get("http_requests_POST__api_v1_do")); + } + + @Test + void testAggregateAndSendMetricsSendsOnlyDifferences() { + Counter counter = + meterRegistry.counter("http.requests", "method", "GET", "uri", "/getEndpoint"); + counter.increment(5); + metricsAggregatorService.aggregateAndSendMetrics(); + reset(postHogService); + + counter.increment(2); + metricsAggregatorService.aggregateAndSendMetrics(); + + ArgumentCaptor> captor = ArgumentCaptor.forClass(Map.class); + verify(postHogService).captureEvent(eq("aggregated_metrics"), captor.capture()); + Map metrics = captor.getValue(); + + assertEquals(1, metrics.size()); + assertEquals(2.0, (Double) metrics.get("http_requests_GET__getEndpoint")); + } +} diff --git a/app/core/src/test/java/stirling/software/SPDF/service/PdfImageRemovalServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/service/PdfImageRemovalServiceTest.java index bd934b6429..f237f2f0f6 100644 --- a/app/core/src/test/java/stirling/software/SPDF/service/PdfImageRemovalServiceTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/service/PdfImageRemovalServiceTest.java @@ -1,6 +1,5 @@ package stirling.software.SPDF.service; -import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.*; import java.io.IOException; @@ -25,6 +24,24 @@ class PdfImageRemovalServiceTest { service = new PdfImageRemovalService(); } + // Helper method for matching COSName in verification + private static COSName eq(final COSName value) { + return Mockito.argThat( + new org.mockito.ArgumentMatcher<>() { + @Override + public boolean matches(COSName argument) { + if (argument == null && value == null) return true; + if (argument == null || value == null) return false; + return argument.getName().equals(value.getName()); + } + + @Override + public String toString() { + return "eq(" + (value != null ? value.getName() : "null") + ")"; + } + }); + } + @Test void testRemoveImagesFromPdf_WithImages() throws IOException { // Mock PDF document and its components @@ -55,7 +72,7 @@ class PdfImageRemovalServiceTest { when(resources.isImageXObject(nonImg)).thenReturn(false); // Execute the method - PDDocument result = service.removeImagesFromPdf(document); + service.removeImagesFromPdf(document); // Verify that images were removed verify(resources, times(1)).put(eq(img1), Mockito.isNull()); @@ -84,7 +101,7 @@ class PdfImageRemovalServiceTest { when(resources.getXObjectNames()).thenReturn(emptyList); // Execute the method - PDDocument result = service.removeImagesFromPdf(document); + service.removeImagesFromPdf(document); // Verify that no modifications were made verify(resources, never()).put(any(COSName.class), any(PDXObject.class)); @@ -120,28 +137,10 @@ class PdfImageRemovalServiceTest { when(resources2.isImageXObject(img2)).thenReturn(true); // Execute the method - PDDocument result = service.removeImagesFromPdf(document); + service.removeImagesFromPdf(document); // Verify that images were removed from both pages verify(resources1, times(1)).put(eq(img1), Mockito.isNull()); verify(resources2, times(1)).put(eq(img2), Mockito.isNull()); } - - // Helper method for matching COSName in verification - private static COSName eq(final COSName value) { - return Mockito.argThat( - new org.mockito.ArgumentMatcher() { - @Override - public boolean matches(COSName argument) { - if (argument == null && value == null) return true; - if (argument == null || value == null) return false; - return argument.getName().equals(value.getName()); - } - - @Override - public String toString() { - return "eq(" + (value != null ? value.getName() : "null") + ")"; - } - }); - } } diff --git a/app/core/src/test/java/stirling/software/SPDF/service/PdfMetadataServiceBasicTest.java b/app/core/src/test/java/stirling/software/SPDF/service/PdfMetadataServiceBasicTest.java index ffdaf6e2f2..c4713fb13e 100644 --- a/app/core/src/test/java/stirling/software/SPDF/service/PdfMetadataServiceBasicTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/service/PdfMetadataServiceBasicTest.java @@ -26,19 +26,17 @@ import stirling.software.common.service.UserServiceInterface; class PdfMetadataServiceBasicTest { - private ApplicationProperties applicationProperties; - private UserServiceInterface userService; private PdfMetadataService pdfMetadataService; private final String STIRLING_PDF_LABEL = "Stirling PDF"; @BeforeEach void setUp() { // Set up mocks for application properties' nested objects - applicationProperties = mock(ApplicationProperties.class); + ApplicationProperties applicationProperties = mock(ApplicationProperties.class); Premium premium = mock(Premium.class); ProFeatures proFeatures = mock(ProFeatures.class); CustomMetadata customMetadata = mock(CustomMetadata.class); - userService = mock(UserServiceInterface.class); + UserServiceInterface userService = mock(UserServiceInterface.class); when(applicationProperties.getPremium()).thenReturn(premium); when(premium.getProFeatures()).thenReturn(proFeatures); diff --git a/app/core/src/test/java/stirling/software/SPDF/service/misc/ReplaceAndInvertColorServiceTest.java b/app/core/src/test/java/stirling/software/SPDF/service/misc/ReplaceAndInvertColorServiceTest.java new file mode 100644 index 0000000000..a668eb9f1f --- /dev/null +++ b/app/core/src/test/java/stirling/software/SPDF/service/misc/ReplaceAndInvertColorServiceTest.java @@ -0,0 +1,77 @@ +package stirling.software.SPDF.service.misc; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.io.IOException; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.springframework.core.io.InputStreamResource; +import org.springframework.web.multipart.MultipartFile; + +import stirling.software.SPDF.Factories.ReplaceAndInvertColorFactory; +import stirling.software.common.model.api.misc.HighContrastColorCombination; +import stirling.software.common.model.api.misc.ReplaceAndInvert; +import stirling.software.common.util.misc.ReplaceAndInvertColorStrategy; + +class ReplaceAndInvertColorServiceTest { + + @Mock private ReplaceAndInvertColorFactory replaceAndInvertColorFactory; + + @Mock private MultipartFile file; + + @Mock private ReplaceAndInvertColorStrategy replaceAndInvertColorStrategy; + + @InjectMocks private ReplaceAndInvertColorService replaceAndInvertColorService; + + @BeforeEach + void setUp() { + MockitoAnnotations.openMocks(this); + } + + @Test + void testReplaceAndInvertColor() throws IOException { + // Arrange + ReplaceAndInvert replaceAndInvertOption = mock(ReplaceAndInvert.class); + HighContrastColorCombination highContrastColorCombination = + mock(HighContrastColorCombination.class); + String backGroundColor = "#FFFFFF"; + String textColor = "#000000"; + + when(replaceAndInvertColorFactory.replaceAndInvert( + file, + replaceAndInvertOption, + highContrastColorCombination, + backGroundColor, + textColor)) + .thenReturn(replaceAndInvertColorStrategy); + + InputStreamResource expectedResource = mock(InputStreamResource.class); + when(replaceAndInvertColorStrategy.replace()).thenReturn(expectedResource); + + // Act + InputStreamResource result = + replaceAndInvertColorService.replaceAndInvertColor( + file, + replaceAndInvertOption, + highContrastColorCombination, + backGroundColor, + textColor); + + // Assert + assertNotNull(result); + assertEquals(expectedResource, result); + verify(replaceAndInvertColorFactory, times(1)) + .replaceAndInvert( + file, + replaceAndInvertOption, + highContrastColorCombination, + backGroundColor, + textColor); + verify(replaceAndInvertColorStrategy, times(1)).replace(); + } +} diff --git a/app/proprietary/build.gradle b/app/proprietary/build.gradle index 6a16824d20..a8d3a5859c 100644 --- a/app/proprietary/build.gradle +++ b/app/proprietary/build.gradle @@ -49,15 +49,15 @@ dependencies { api 'org.springframework.boot:spring-boot-starter-mail' api 'org.springframework.boot:spring-boot-starter-cache' api 'com.github.ben-manes.caffeine:caffeine' - api 'io.swagger.core.v3:swagger-core-jakarta:2.2.38' + api 'io.swagger.core.v3:swagger-core-jakarta:2.2.41' implementation 'com.bucket4j:bucket4j_jdk17-core:8.15.0' // https://mvnrepository.com/artifact/com.bucket4j/bucket4j_jdk17 - implementation 'org.bouncycastle:bcprov-jdk18on:1.82' + implementation 'org.bouncycastle:bcprov-jdk18on:1.83' implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.3.RELEASE' api 'io.micrometer:micrometer-registry-prometheus' - implementation 'com.unboundid.product.scim2:scim2-sdk-client:4.0.0' + implementation 'com.unboundid.product.scim2:scim2-sdk-client:4.1.0' api "io.jsonwebtoken:jjwt-api:$jwtVersion" runtimeOnly "io.jsonwebtoken:jjwt-impl:$jwtVersion" diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/audit/AuditUtils.java b/app/proprietary/src/main/java/stirling/software/proprietary/audit/AuditUtils.java index 2e486b276b..af950c0fd3 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/audit/AuditUtils.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/audit/AuditUtils.java @@ -5,6 +5,7 @@ import java.time.Instant; import java.util.Arrays; import java.util.HashMap; import java.util.List; +import java.util.Locale; import java.util.Map; import java.util.stream.Collectors; import java.util.stream.IntStream; @@ -307,8 +308,8 @@ public class AuditUtils { // For HTTP methods, infer based on controller and path if (httpMethod != null && path != null) { - String cls = controller.getSimpleName().toLowerCase(); - String pkg = controller.getPackage().getName().toLowerCase(); + String cls = controller.getSimpleName().toLowerCase(Locale.ROOT); + String pkg = controller.getPackage().getName().toLowerCase(Locale.ROOT); if ("GET".equals(httpMethod)) return AuditEventType.HTTP_REQUEST; @@ -374,8 +375,8 @@ public class AuditUtils { } // Otherwise infer from controller and path - String cls = controller.getSimpleName().toLowerCase(); - String pkg = controller.getPackage().getName().toLowerCase(); + String cls = controller.getSimpleName().toLowerCase(Locale.ROOT); + String pkg = controller.getPackage().getName().toLowerCase(Locale.ROOT); if ("GET".equals(httpMethod)) return AuditEventType.HTTP_REQUEST; diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/ProprietaryUIDataController.java b/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/ProprietaryUIDataController.java index 88fddb7eaf..d446558320 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/ProprietaryUIDataController.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/ProprietaryUIDataController.java @@ -94,6 +94,22 @@ public class ProprietaryUIDataController { this.auditRepository = auditRepository; } + /** + * Get the backend base URL for SAML/OAuth redirects. Uses system.backendUrl from config if set, + * otherwise defaults to http://localhost:8080 + */ + private String getBackendBaseUrl() { + String backendUrl = applicationProperties.getSystem().getBackendUrl(); + + // If backendUrl is configured, use it + if (backendUrl != null && !backendUrl.trim().isEmpty()) { + return backendUrl.trim(); + } + + // For development, default to localhost:8080 (backend port) + return "http://localhost:8080"; + } + @GetMapping("/audit-dashboard") @PreAuthorize("hasRole('ADMIN')") @EnterpriseEndpoint @@ -118,7 +134,7 @@ public class ProprietaryUIDataController { Security securityProps = applicationProperties.getSecurity(); // Add enableLogin flag so frontend doesn't need to call /app-config - data.setEnableLogin(securityProps.getEnableLogin()); + data.setEnableLogin(securityProps.isEnableLogin()); // Check if this is first-time setup with default credentials // The isFirstLogin flag captures: default username/password usage and unchanged state @@ -185,14 +201,17 @@ public class ProprietaryUIDataController { } SAML2 saml2 = securityProps.getSaml2(); - if (securityProps.isSaml2Active() - && applicationProperties.getSystem().getEnableAlphaFunctionality() - && applicationProperties.getPremium().isEnabled()) { + if (securityProps.isSaml2Active() && applicationProperties.getPremium().isEnabled()) { String samlIdp = saml2.getProvider(); String saml2AuthenticationPath = "/saml2/authenticate/" + saml2.getRegistrationId(); + // For SAML, we need to use the backend URL directly, not a relative path + // This ensures Spring Security generates the correct ACS URL + String backendUrl = getBackendBaseUrl(); + String fullSamlPath = backendUrl + saml2AuthenticationPath; + if (!applicationProperties.getPremium().getProFeatures().isSsoAutoLogin()) { - providerList.put(saml2AuthenticationPath, samlIdp + " (SAML 2)"); + providerList.put(fullSamlPath, samlIdp + " (SAML 2)"); } } diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/SignatureController.java b/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/SignatureController.java index a073c21371..53b3e1f388 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/SignatureController.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/controller/api/SignatureController.java @@ -22,7 +22,6 @@ import org.springframework.web.bind.annotation.RestController; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; -import stirling.software.common.annotations.api.UserApi; import stirling.software.common.configuration.InstallationPathConfig; import stirling.software.proprietary.model.api.signature.SavedSignatureRequest; import stirling.software.proprietary.model.api.signature.SavedSignatureResponse; @@ -34,7 +33,6 @@ import stirling.software.proprietary.service.SignatureService; * authentication and enforces per-user storage limits. All endpoints require authentication * via @PreAuthorize("isAuthenticated()"). */ -@UserApi @Slf4j @RestController @RequestMapping("/api/v1/proprietary/signatures") diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/CustomLogoutSuccessHandler.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/CustomLogoutSuccessHandler.java index 16272b37f0..fa44b13373 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/CustomLogoutSuccessHandler.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/CustomLogoutSuccessHandler.java @@ -5,6 +5,7 @@ import java.security.cert.X509Certificate; import java.security.interfaces.RSAPrivateKey; import java.util.ArrayList; import java.util.List; +import java.util.Locale; import org.springframework.core.io.Resource; import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; @@ -150,7 +151,7 @@ public class CustomLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler { registrationId = oAuthToken.getAuthorizedClientRegistrationId(); // Redirect based on OAuth2 provider - switch (registrationId.toLowerCase()) { + switch (registrationId.toLowerCase(Locale.ROOT)) { case "keycloak" -> { KeycloakProvider keycloak = oauth.getClient().getKeycloak(); @@ -198,7 +199,7 @@ public class CustomLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler { private SamlClient getSamlClient( String registrationId, SAML2 samlConf, List certificates) throws SamlException { - String serverUrl = appConfig.getBaseUrl() + ":" + appConfig.getServerPort(); + String serverUrl = appConfig.getBackendUrl() + ":" + appConfig.getServerPort(); String relyingPartyIdentifier = serverUrl + "/saml2/service-provider-metadata/" + registrationId; diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/InitialSecuritySetup.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/InitialSecuritySetup.java index 8d9ec5a015..bdf87c4582 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/InitialSecuritySetup.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/InitialSecuritySetup.java @@ -151,7 +151,7 @@ public class InitialSecuritySetup { if (internalApiUserOpt.isPresent()) { User internalApiUser = internalApiUserOpt.get(); // move to team internal API user - if (!internalApiUser.getTeam().getName().equals(TeamService.INTERNAL_TEAM_NAME)) { + if (!TeamService.INTERNAL_TEAM_NAME.equals(internalApiUser.getTeam().getName())) { log.info( "Moving internal API user to team: {}", TeamService.INTERNAL_TEAM_NAME); Team internalTeam = teamService.getOrCreateInternalTeam(); diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/config/AccountWebController.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/config/AccountWebController.java index d035dbc587..17857fc85b 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/config/AccountWebController.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/config/AccountWebController.java @@ -120,9 +120,7 @@ public class AccountWebController { SAML2 saml2 = securityProps.getSaml2(); - if (securityProps.isSaml2Active() - && applicationProperties.getSystem().getEnableAlphaFunctionality() - && applicationProperties.getPremium().isEnabled()) { + if (securityProps.isSaml2Active() && applicationProperties.getPremium().isEnabled()) { String samlIdp = saml2.getProvider(); String saml2AuthenticationPath = "/saml2/authenticate/" + saml2.getRegistrationId(); diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/DatabaseConfig.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/DatabaseConfig.java index 86eca9b154..4762fa8a97 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/DatabaseConfig.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/DatabaseConfig.java @@ -1,5 +1,7 @@ package stirling.software.proprietary.security.configuration; +import java.util.Locale; + import javax.sql.DataSource; import org.springframework.beans.factory.annotation.Qualifier; @@ -133,7 +135,7 @@ public class DatabaseConfig { private String getDriverClassName(String driverName) throws UnsupportedProviderException { try { ApplicationProperties.Driver driver = - ApplicationProperties.Driver.valueOf(driverName.toUpperCase()); + ApplicationProperties.Driver.valueOf(driverName.toUpperCase(Locale.ROOT)); return switch (driver) { case H2 -> { diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/SecurityConfiguration.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/SecurityConfiguration.java index 257d243ea4..fa936211da 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/SecurityConfiguration.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/SecurityConfiguration.java @@ -334,7 +334,8 @@ public class SecurityConfiguration { securityProperties.getSaml2(), userService, jwtService, - licenseSettingsService)) + licenseSettingsService, + applicationProperties)) .failureHandler( new CustomSaml2AuthenticationFailureHandler()) .authenticationRequestResolver( @@ -343,7 +344,8 @@ public class SecurityConfiguration { log.error("Error configuring SAML 2 login", e); throw new RuntimeException(e); } - }); + }) + .saml2Metadata(metadata -> {}); } } else { log.debug("Login is not enabled."); diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/ee/KeygenLicenseVerifier.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/ee/KeygenLicenseVerifier.java index a10f395b4b..3f48cd4e51 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/ee/KeygenLicenseVerifier.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/configuration/ee/KeygenLicenseVerifier.java @@ -5,6 +5,7 @@ import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.util.Base64; +import java.util.Locale; import org.bouncycastle.crypto.params.Ed25519PublicKeyParameters; import org.bouncycastle.crypto.signers.Ed25519Signer; @@ -185,7 +186,7 @@ public class KeygenLicenseVerifier { byte[] signatureBytes = Base64.getDecoder().decode(encodedSignature); // Create the signing data format - prefix with "license/" - String signingData = String.format("license/%s", encryptedData); + String signingData = String.format(Locale.ROOT, "license/%s", encryptedData); byte[] signingDataBytes = signingData.getBytes(); log.info("Signing data length: {} bytes", signingDataBytes.length); @@ -348,7 +349,7 @@ public class KeygenLicenseVerifier { .decode(encodedSignature.replace('-', '+').replace('_', '/')); // For ED25519_SIGN format, the signing data is "key/" + encodedPayload - String signingData = String.format("key/%s", encodedPayload); + String signingData = String.format(Locale.ROOT, "key/%s", encodedPayload); byte[] dataBytes = signingData.getBytes(); byte[] publicKeyBytes = Hex.decode(PUBLIC_KEY); @@ -526,8 +527,10 @@ public class KeygenLicenseVerifier { String licenseKey, String machineFingerprint, LicenseContext context) throws Exception { String requestBody = String.format( + Locale.ROOT, "{\"meta\":{\"key\":\"%s\",\"scope\":{\"fingerprint\":\"%s\"}}}", - licenseKey, machineFingerprint); + licenseKey, + machineFingerprint); HttpRequest request = HttpRequest.newBuilder() .uri( diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/AuthController.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/AuthController.java index de6428554c..c3e11c3ab3 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/AuthController.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/AuthController.java @@ -244,10 +244,13 @@ public class AuthController { userMap.put("username", user.getUsername()); userMap.put("role", user.getRolesAsString()); userMap.put("enabled", user.isEnabled()); + userMap.put( + "authenticationType", + user.getAuthenticationType()); // Expose authentication type for SSO detection // Add metadata for OAuth compatibility Map appMetadata = new HashMap<>(); - appMetadata.put("provider", user.getAuthenticationType()); // Default to email provider + appMetadata.put("provider", user.getAuthenticationType()); userMap.put("app_metadata", appMetadata); return userMap; diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/database/DatabaseNotificationServiceInterface.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/database/DatabaseNotificationServiceInterface.java new file mode 100644 index 0000000000..4548a4813c --- /dev/null +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/database/DatabaseNotificationServiceInterface.java @@ -0,0 +1,11 @@ +package stirling.software.proprietary.security.database; + +public interface DatabaseNotificationServiceInterface { + void notifyBackupsSuccess(String subject, String message); + + void notifyBackupsFailure(String subject, String message); + + void notifyImportsSuccess(String subject, String message); + + void notifyImportsFailure(String subject, String message); +} diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/database/service/DatabaseNotificationService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/database/service/DatabaseNotificationService.java new file mode 100644 index 0000000000..ba52116a93 --- /dev/null +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/database/service/DatabaseNotificationService.java @@ -0,0 +1,75 @@ +package stirling.software.proprietary.security.database.service; + +import java.util.Optional; + +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.stereotype.Service; + +import jakarta.mail.MessagingException; + +import lombok.extern.slf4j.Slf4j; + +import stirling.software.common.model.ApplicationProperties; +import stirling.software.common.model.ApplicationProperties.Premium.EnterpriseFeatures.DatabaseNotifications; +import stirling.software.proprietary.security.database.DatabaseNotificationServiceInterface; +import stirling.software.proprietary.security.service.EmailService; + +@Service +@Slf4j +public class DatabaseNotificationService implements DatabaseNotificationServiceInterface { + + private final Optional emailService; + private final ApplicationProperties props; + private final boolean runningEE; + private DatabaseNotifications notifications; + + DatabaseNotificationService( + Optional emailService, + ApplicationProperties props, + @Qualifier("runningEE") boolean runningEE) { + this.emailService = emailService; + this.props = props; + this.runningEE = runningEE; + notifications = props.getPremium().getEnterpriseFeatures().getDatabaseNotifications(); + } + + @Override + public void notifyBackupsSuccess(String subject, String message) { + if (notifications.getBackups().isSuccessful() && runningEE) { + sendMail(subject, message); + } + } + + @Override + public void notifyBackupsFailure(String subject, String message) { + if (notifications.getBackups().isFailed() && runningEE) { + sendMail(subject, message); + } + } + + @Override + public void notifyImportsSuccess(String subject, String message) { + if (notifications.getImports().isSuccessful() && runningEE) { + sendMail(subject, message); + } + } + + @Override + public void notifyImportsFailure(String subject, String message) { + if (notifications.getImports().isFailed() && runningEE) { + sendMail(subject, message); + } + } + + private void sendMail(String subject, String message) { + emailService.ifPresent( + service -> { + try { + String to = props.getMail().getFrom(); + service.sendSimpleMail(to, subject, message); + } catch (MessagingException e) { + log.error("Error sending notification email: {}", e.getMessage(), e); + } + }); + } +} diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/model/AttemptCounter.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/model/AttemptCounter.java index 10cd8eeb7c..3d47c38efc 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/model/AttemptCounter.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/model/AttemptCounter.java @@ -18,7 +18,8 @@ public class AttemptCounter { } public boolean shouldReset(long attemptIncrementTime) { - return System.currentTimeMillis() - lastAttemptTime > attemptIncrementTime; + long elapsed = System.currentTimeMillis() - lastAttemptTime; + return elapsed >= attemptIncrementTime; } public void reset() { diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/model/User.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/model/User.java index c53893a8b4..5e23c30fa2 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/model/User.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/model/User.java @@ -4,6 +4,7 @@ import java.io.Serializable; import java.time.LocalDateTime; import java.util.HashMap; import java.util.HashSet; +import java.util.Locale; import java.util.Map; import java.util.Set; import java.util.stream.Collectors; @@ -129,7 +130,7 @@ public class User implements UserDetails, Serializable { } public void setAuthenticationType(AuthenticationType authenticationType) { - this.authenticationType = authenticationType.toString().toLowerCase(); + this.authenticationType = authenticationType.toString().toLowerCase(Locale.ROOT); } public void addAuthorities(Set authorities) { diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/oauth2/OAuth2Configuration.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/oauth2/OAuth2Configuration.java index 2d5f94620a..8710ed2641 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/oauth2/OAuth2Configuration.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/oauth2/OAuth2Configuration.java @@ -7,6 +7,7 @@ import static stirling.software.common.util.ValidationUtils.isStringEmpty; import java.util.ArrayList; import java.util.HashSet; import java.util.List; +import java.util.Locale; import java.util.Optional; import java.util.Set; @@ -197,7 +198,7 @@ public class OAuth2Configuration { String name = oauth.getProvider(); String firstChar = String.valueOf(name.charAt(0)); - String clientName = name.replaceFirst(firstChar, firstChar.toUpperCase()); + String clientName = name.replaceFirst(firstChar, firstChar.toUpperCase(Locale.ROOT)); Provider oidcProvider = new Provider( @@ -207,7 +208,8 @@ public class OAuth2Configuration { oauth.getClientId(), oauth.getClientSecret(), oauth.getScopes(), - UsernameAttribute.valueOf(oauth.getUseAsUsername().toUpperCase()), + UsernameAttribute.valueOf( + oauth.getUseAsUsername().toUpperCase(Locale.ROOT)), null, null, null); diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/CustomSaml2AuthenticationSuccessHandler.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/CustomSaml2AuthenticationSuccessHandler.java index e8bce579a0..3c63f1bf46 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/CustomSaml2AuthenticationSuccessHandler.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/CustomSaml2AuthenticationSuccessHandler.java @@ -51,6 +51,7 @@ public class CustomSaml2AuthenticationSuccessHandler private final JwtServiceInterface jwtService; private final stirling.software.proprietary.service.UserLicenseSettingsService licenseSettingsService; + private final ApplicationProperties applicationProperties; @Override @Audited(type = AuditEventType.USER_LOGIN, level = AuditLevel.BASIC) @@ -77,8 +78,8 @@ public class CustomSaml2AuthenticationSuccessHandler log.warn( "SAML2 login blocked for existing user '{}' - not eligible (not grandfathered and no ENTERPRISE license)", username); - response.sendRedirect( - request.getContextPath() + "/logout?saml2RequiresLicense=true"); + String origin = resolveOrigin(request); + response.sendRedirect(origin + "/logout?saml2RequiresLicense=true"); return; } } else if (!licenseSettingsService.isSamlEligible(null)) { @@ -86,8 +87,8 @@ public class CustomSaml2AuthenticationSuccessHandler log.warn( "SAML2 login blocked for new user '{}' - not eligible (no ENTERPRISE license for auto-creation)", username); - response.sendRedirect( - request.getContextPath() + "/logout?saml2RequiresLicense=true"); + String origin = resolveOrigin(request); + response.sendRedirect(origin + "/logout?saml2RequiresLicense=true"); return; } @@ -144,20 +145,28 @@ public class CustomSaml2AuthenticationSuccessHandler log.debug( "User {} exists with password but is not SSO user, redirecting to logout", username); - response.sendRedirect( - contextPath + "/logout?oAuth2AuthenticationErrorWeb=true"); + String origin = resolveOrigin(request); + response.sendRedirect(origin + "/logout?oAuth2AuthenticationErrorWeb=true"); return; } try { - if (!userExists || saml2Properties.getBlockRegistration()) { - log.debug("Registration blocked for new user: {}", username); - response.sendRedirect( - contextPath + "/login?errorOAuth=oAuth2AdminBlockedUser"); + // Block new users only if: blockRegistration is true OR autoCreateUser is false + if (!userExists + && (saml2Properties.getBlockRegistration() + || !saml2Properties.getAutoCreateUser())) { + log.debug( + "Registration blocked for new user '{}' (blockRegistration: {}, autoCreateUser: {})", + username, + saml2Properties.getBlockRegistration(), + saml2Properties.getAutoCreateUser()); + String origin = resolveOrigin(request); + response.sendRedirect(origin + "/login?errorOAuth=oAuth2AdminBlockedUser"); return; } if (!userExists && licenseSettingsService.wouldExceedLimit(1)) { - response.sendRedirect(contextPath + "/logout?maxUsersReached=true"); + String origin = resolveOrigin(request); + response.sendRedirect(origin + "/logout?maxUsersReached=true"); return; } @@ -222,16 +231,30 @@ public class CustomSaml2AuthenticationSuccessHandler String contextPath, String jwt) { String redirectPath = resolveRedirectPath(request, contextPath); - String origin = - resolveForwardedOrigin(request) - .orElseGet( - () -> - resolveOriginFromReferer(request) - .orElseGet(() -> buildOriginFromRequest(request))); + String origin = resolveOrigin(request); clearRedirectCookie(response); return origin + redirectPath + "#access_token=" + jwt; } + /** + * Resolve the origin (frontend URL) for redirects. First checks system.frontendUrl from config, + * then falls back to detecting from request headers. + */ + private String resolveOrigin(HttpServletRequest request) { + // First check if frontendUrl is configured + String configuredFrontendUrl = applicationProperties.getSystem().getFrontendUrl(); + if (configuredFrontendUrl != null && !configuredFrontendUrl.trim().isEmpty()) { + return configuredFrontendUrl.trim(); + } + + // Fall back to auto-detection from request headers + return resolveForwardedOrigin(request) + .orElseGet( + () -> + resolveOriginFromReferer(request) + .orElseGet(() -> buildOriginFromRequest(request))); + } + private String resolveRedirectPath(HttpServletRequest request, String contextPath) { return extractRedirectPathFromCookie(request) .filter(path -> path.startsWith("/")) diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/Saml2Configuration.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/Saml2Configuration.java index 9d21f88a37..6ccffa1dac 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/Saml2Configuration.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/saml2/Saml2Configuration.java @@ -41,25 +41,92 @@ public class Saml2Configuration { @ConditionalOnProperty(name = "security.saml2.enabled", havingValue = "true") public RelyingPartyRegistrationRepository relyingPartyRegistrations() throws Exception { SAML2 samlConf = applicationProperties.getSecurity().getSaml2(); - X509Certificate idpCert = CertificateUtils.readCertificate(samlConf.getIdpCert()); + + log.info( + "Initializing SAML2 configuration with registration ID: {}", + samlConf.getRegistrationId()); + + // Load IdP certificate + X509Certificate idpCert; + try { + Resource idpCertResource = samlConf.getIdpCert(); + log.info("Loading IdP certificate from: {}", idpCertResource.getDescription()); + if (!idpCertResource.exists()) { + log.error( + "SAML2 IdP certificate not found at: {}", idpCertResource.getDescription()); + throw new IllegalStateException( + "SAML2 IdP certificate file does not exist: " + + idpCertResource.getDescription()); + } + idpCert = CertificateUtils.readCertificate(idpCertResource); + log.info( + "Successfully loaded IdP certificate. Subject: {}", + idpCert.getSubjectX500Principal().getName()); + } catch (Exception e) { + log.error("Failed to load SAML2 IdP certificate: {}", e.getMessage(), e); + throw new IllegalStateException("Failed to load SAML2 IdP certificate", e); + } + Saml2X509Credential verificationCredential = Saml2X509Credential.verification(idpCert); + + // Load SP private key and certificate Resource privateKeyResource = samlConf.getPrivateKey(); Resource certificateResource = samlConf.getSpCert(); - Saml2X509Credential signingCredential = - new Saml2X509Credential( - CertificateUtils.readPrivateKey(privateKeyResource), - CertificateUtils.readCertificate(certificateResource), - Saml2X509CredentialType.SIGNING); + + log.info("Loading SP private key from: {}", privateKeyResource.getDescription()); + if (!privateKeyResource.exists()) { + log.error("SAML2 SP private key not found at: {}", privateKeyResource.getDescription()); + throw new IllegalStateException( + "SAML2 SP private key file does not exist: " + + privateKeyResource.getDescription()); + } + + log.info("Loading SP certificate from: {}", certificateResource.getDescription()); + if (!certificateResource.exists()) { + log.error( + "SAML2 SP certificate not found at: {}", certificateResource.getDescription()); + throw new IllegalStateException( + "SAML2 SP certificate file does not exist: " + + certificateResource.getDescription()); + } + + Saml2X509Credential signingCredential; + try { + signingCredential = + new Saml2X509Credential( + CertificateUtils.readPrivateKey(privateKeyResource), + CertificateUtils.readCertificate(certificateResource), + Saml2X509CredentialType.SIGNING); + log.info("Successfully loaded SP credentials"); + } catch (Exception e) { + log.error("Failed to load SAML2 SP credentials: {}", e.getMessage(), e); + throw new IllegalStateException("Failed to load SAML2 SP credentials", e); + } + + // Get backend URL from configuration (for SAML endpoints) + String backendUrl = applicationProperties.getSystem().getBackendUrl(); + if (backendUrl == null || backendUrl.isBlank()) { + backendUrl = "{baseUrl}"; // Fallback to Spring's auto-resolution + log.warn( + "system.backendUrl not configured - SAML metadata will use request-based URLs. Set system.backendUrl for production use."); + } else { + log.info("Using configured backend URL for SAML: {}", backendUrl); + } + + String entityId = + backendUrl + "/saml2/service-provider-metadata/" + samlConf.getRegistrationId(); + String acsLocation = backendUrl + "/login/saml2/sso/{registrationId}"; + String sloResponseLocation = backendUrl + "/login"; + RelyingPartyRegistration rp = RelyingPartyRegistration.withRegistrationId(samlConf.getRegistrationId()) .signingX509Credentials(c -> c.add(signingCredential)) - .entityId(samlConf.getIdpIssuer()) + .entityId(entityId) .singleLogoutServiceBinding(Saml2MessageBinding.POST) .singleLogoutServiceLocation(samlConf.getIdpSingleLogoutUrl()) - .singleLogoutServiceResponseLocation("http://localhost:8080/login") + .singleLogoutServiceResponseLocation(sloResponseLocation) .assertionConsumerServiceBinding(Saml2MessageBinding.POST) - .assertionConsumerServiceLocation( - "{baseUrl}/login/saml2/sso/{registrationId}") + .assertionConsumerServiceLocation(acsLocation) .authnRequestsSigned(true) .assertingPartyMetadata( metadata -> @@ -75,9 +142,14 @@ public class Saml2Configuration { .singleLogoutServiceLocation( samlConf.getIdpSingleLogoutUrl()) .singleLogoutServiceResponseLocation( - "http://localhost:8080/login") + sloResponseLocation) .wantAuthnRequestsSigned(true)) .build(); + + log.info( + "SAML2 configuration initialized successfully. Registration ID: {}, IdP: {}", + samlConf.getRegistrationId(), + samlConf.getIdpIssuer()); return new InMemoryRelyingPartyRegistrationRepository(rp); } diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/AppUpdateAuthService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/AppUpdateAuthService.java index 19e3005852..c60c5e2d95 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/AppUpdateAuthService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/AppUpdateAuthService.java @@ -27,7 +27,7 @@ class AppUpdateAuthService implements ShowAdminInterface { if (!showUpdate) { return showUpdate; } - boolean showUpdateOnlyAdmin = applicationProperties.getSystem().getShowUpdateOnlyAdmin(); + boolean showUpdateOnlyAdmin = applicationProperties.getSystem().isShowUpdateOnlyAdmin(); Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); if (authentication == null || !authentication.isAuthenticated()) { return !showUpdateOnlyAdmin; diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/CustomUserDetailsService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/CustomUserDetailsService.java index 33bb8da608..99e87a82b8 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/CustomUserDetailsService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/CustomUserDetailsService.java @@ -1,5 +1,7 @@ package stirling.software.proprietary.security.service; +import java.util.Locale; + import org.springframework.security.authentication.LockedException; import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.core.userdetails.UserDetailsService; @@ -60,7 +62,7 @@ public class CustomUserDetailsService implements UserDetailsService { } AuthenticationType userAuthenticationType = - AuthenticationType.valueOf(authTypeStr.toUpperCase()); + AuthenticationType.valueOf(authTypeStr.toUpperCase(Locale.ROOT)); if (!user.hasPassword() && userAuthenticationType == AuthenticationType.WEB) { throw new IllegalArgumentException("Password must not be null"); } diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/DatabaseService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/DatabaseService.java index 1a3f3ee9c2..a5755edf63 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/DatabaseService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/DatabaseService.java @@ -7,7 +7,10 @@ import java.nio.file.Path; import java.nio.file.Paths; import java.nio.file.StandardCopyOption; import java.nio.file.attribute.BasicFileAttributes; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; import java.sql.Connection; +import java.sql.DriverManager; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; @@ -32,6 +35,7 @@ import lombok.extern.slf4j.Slf4j; import stirling.software.common.configuration.InstallationPathConfig; import stirling.software.common.model.ApplicationProperties; import stirling.software.common.model.FileInfo; +import stirling.software.proprietary.security.database.DatabaseNotificationServiceInterface; import stirling.software.proprietary.security.model.exception.BackupNotFoundException; @Slf4j @@ -44,12 +48,16 @@ public class DatabaseService implements DatabaseServiceInterface { private final ApplicationProperties.Datasource datasourceProps; private final DataSource dataSource; + private final DatabaseNotificationServiceInterface backupNotificationService; public DatabaseService( - ApplicationProperties.Datasource datasourceProps, DataSource dataSource) { + ApplicationProperties.Datasource datasourceProps, + DataSource dataSource, + DatabaseNotificationServiceInterface backupNotificationService) { this.BACKUP_DIR = Paths.get(InstallationPathConfig.getBackupPath()).normalize(); this.datasourceProps = datasourceProps; this.dataSource = dataSource; + this.backupNotificationService = backupNotificationService; moveBackupFiles(); } @@ -172,6 +180,8 @@ public class DatabaseService implements DatabaseServiceInterface { public boolean importDatabaseFromUI(String fileName) { try { importDatabaseFromUI(getBackupFilePath(fileName)); + backupNotificationService.notifyImportsSuccess( + "Database import completed", "Import file: " + fileName); return true; } catch (IOException e) { log.error( @@ -179,6 +189,9 @@ public class DatabaseService implements DatabaseServiceInterface { fileName, e.getMessage(), e.getCause()); + backupNotificationService.notifyImportsFailure( + "Database import failed", + "Import file: " + fileName + " Message: " + e.getMessage()); return false; } } @@ -219,16 +232,59 @@ public class DatabaseService implements DatabaseServiceInterface { PreparedStatement stmt = conn.prepareStatement(query)) { stmt.setString(1, insertOutputFilePath.toString()); stmt.execute(); + backupNotificationService.notifyBackupsSuccess( + "Database backup export completed", + "Backup file: " + insertOutputFilePath.getFileName()); } catch (SQLException e) { log.error("Error during database export: {}", e.getMessage(), e); + backupNotificationService.notifyBackupsFailure( + "Database backup export failed", + "Backup file: " + + insertOutputFilePath.getFileName() + + " Message: " + + e.getMessage()); } catch (CannotReadScriptException e) { log.error("Error during database export: File {} not found", insertOutputFilePath); + backupNotificationService.notifyBackupsFailure( + "Database backup export failed", + "Error during database export: File " + + insertOutputFilePath.getFileName() + + " not found. Message: " + + e.getMessage()); } log.info("Database export completed: {}", insertOutputFilePath); + verifyBackup(insertOutputFilePath); } } + private boolean verifyBackup(Path backupPath) { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + byte[] content = Files.readAllBytes(backupPath); + String checksum = bytesToHex(digest.digest(content)); + log.info("Checksum for {}: {}", backupPath.getFileName(), checksum); + + try (Connection conn = DriverManager.getConnection("jdbc:h2:mem:backupVerify"); + PreparedStatement stmt = conn.prepareStatement("RUNSCRIPT FROM ?")) { + stmt.setString(1, backupPath.toString()); + stmt.execute(); + } + return true; + } catch (IOException | NoSuchAlgorithmException | SQLException e) { + log.error("Backup verification failed for {}: {}", backupPath, e.getMessage(), e); + } + return false; + } + + private String bytesToHex(byte[] hash) { + StringBuilder hexString = new StringBuilder(); + for (byte b : hash) { + hexString.append(String.format("%02x", b)); + } + return hexString.toString(); + } + @Override public List> deleteAllBackups() { List backupList = this.getBackupList(); @@ -384,6 +440,12 @@ public class DatabaseService implements DatabaseServiceInterface { */ private void executeDatabaseScript(Path scriptPath) { if (isH2Database()) { + + if (!verifyBackup(scriptPath)) { + log.error("Backup verification failed for: {}", scriptPath); + throw new IllegalArgumentException("Backup verification failed for: " + scriptPath); + } + String query = "RUNSCRIPT from ?;"; try (Connection conn = dataSource.getConnection(); diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/EmailService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/EmailService.java index 3ae079d0f6..5c1cf75450 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/EmailService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/EmailService.java @@ -11,6 +11,7 @@ import jakarta.mail.MessagingException; import jakarta.mail.internet.MimeMessage; import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; import stirling.software.common.model.ApplicationProperties; import stirling.software.proprietary.security.model.api.Email; @@ -20,6 +21,7 @@ import stirling.software.proprietary.security.model.api.Email; * JavaMailSender to send the email and is designed to handle both the message content and file * attachments. */ +@Slf4j @Service @RequiredArgsConstructor @ConditionalOnProperty(value = "mail.enabled", havingValue = "true", matchIfMissing = false) @@ -72,6 +74,40 @@ public class EmailService { // Sends the email via the configured mail sender mailSender.send(message); + log.debug( + "Email sent successfully to {} with subject: {} body: {}", + email.getTo(), + email.getSubject(), + email.getBody()); + } + + /** + * Sends a simple email without attachments asynchronously. + * + * @param to the recipient address + * @param subject subject line + * @param body message body + * @throws MessagingException if sending fails or address is invalid + */ + @Async + public void sendSimpleMail(String to, String subject, String body) throws MessagingException { + if (to == null || to.trim().isEmpty()) { + throw new MessagingException("Invalid Addresses"); + } + + ApplicationProperties.Mail mailProperties = applicationProperties.getMail(); + MimeMessage message = mailSender.createMimeMessage(); + MimeMessageHelper helper = new MimeMessageHelper(message, false); + helper.addTo(to); + helper.setSubject(subject); + helper.setText(body, false); + helper.setFrom(mailProperties.getFrom()); + mailSender.send(message); + log.debug( + "Simple email sent successfully to {} with subject: {} body: {}", + to, + subject, + body); } /** diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/LoginAttemptService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/LoginAttemptService.java index ecc04bac5a..4db97a1380 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/LoginAttemptService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/LoginAttemptService.java @@ -1,5 +1,6 @@ package stirling.software.proprietary.security.service; +import java.util.Locale; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.TimeUnit; @@ -45,17 +46,19 @@ public class LoginAttemptService { if (!isBlockedEnabled || key == null || key.trim().isEmpty()) { return; } - attemptsCache.remove(key.toLowerCase()); + String normalizedKey = key.toLowerCase(Locale.ROOT); + attemptsCache.remove(normalizedKey); } public void loginFailed(String key) { if (!isBlockedEnabled || key == null || key.trim().isEmpty()) { return; } - AttemptCounter attemptCounter = attemptsCache.get(key.toLowerCase()); + String normalizedKey = key.toLowerCase(Locale.ROOT); + AttemptCounter attemptCounter = attemptsCache.get(normalizedKey); if (attemptCounter == null) { attemptCounter = new AttemptCounter(); - attemptsCache.put(key.toLowerCase(), attemptCounter); + attemptsCache.put(normalizedKey, attemptCounter); } else { if (attemptCounter.shouldReset(ATTEMPT_INCREMENT_TIME)) { attemptCounter.reset(); @@ -68,7 +71,8 @@ public class LoginAttemptService { if (!isBlockedEnabled || key == null || key.trim().isEmpty()) { return false; } - AttemptCounter attemptCounter = attemptsCache.get(key.toLowerCase()); + String normalizedKey = key.toLowerCase(Locale.ROOT); + AttemptCounter attemptCounter = attemptsCache.get(normalizedKey); if (attemptCounter == null) { return false; } @@ -80,7 +84,8 @@ public class LoginAttemptService { // Arbitrarily high number if tracking is disabled return Integer.MAX_VALUE; } - AttemptCounter attemptCounter = attemptsCache.get(key.toLowerCase()); + String normalizedKey = key.toLowerCase(Locale.ROOT); + AttemptCounter attemptCounter = attemptsCache.get(normalizedKey); if (attemptCounter == null) { return MAX_ATTEMPT; } diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/UserService.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/UserService.java index d24e4722a2..fa9a80494e 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/service/UserService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/service/UserService.java @@ -5,6 +5,7 @@ import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.List; +import java.util.Locale; import java.util.Map; import java.util.Optional; import java.util.UUID; @@ -145,6 +146,7 @@ public class UserService implements UserServiceInterface { return addApiKeyToUser(username); } + @Override public String getApiKeyForUser(String username) { User user = findByUsernameIgnoreCase(username) @@ -581,9 +583,10 @@ public class UserService implements UserServiceInterface { .matches(); List notAllowedUserList = new ArrayList<>(); - notAllowedUserList.add("ALL_USERS".toLowerCase()); + notAllowedUserList.add("ALL_USERS".toLowerCase(Locale.ROOT)); notAllowedUserList.add("anonymoususer"); - boolean notAllowedUser = notAllowedUserList.contains(username.toLowerCase()); + String normalizedUsername = username.toLowerCase(Locale.ROOT); + boolean notAllowedUser = notAllowedUserList.contains(normalizedUsername); return (isValidSimpleUsername || isValidEmail) && !notAllowedUser; } @@ -631,6 +634,7 @@ public class UserService implements UserServiceInterface { } } + @Override public String getCurrentUsername() { Object principal = SecurityContextHolder.getContext().getAuthentication().getPrincipal(); @@ -717,6 +721,7 @@ public class UserService implements UserServiceInterface { } } + @Override public long getTotalUsersCount() { // Count all users in the database long userCount = userRepository.count(); diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/service/ImageMagickLineArtConversionService.java b/app/proprietary/src/main/java/stirling/software/proprietary/service/ImageMagickLineArtConversionService.java new file mode 100644 index 0000000000..8ca6a83e7c --- /dev/null +++ b/app/proprietary/src/main/java/stirling/software/proprietary/service/ImageMagickLineArtConversionService.java @@ -0,0 +1,81 @@ +package stirling.software.proprietary.service; + +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.Locale; + +import javax.imageio.ImageIO; + +import org.apache.pdfbox.pdmodel.PDDocument; +import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject; +import org.springframework.stereotype.Service; + +import lombok.extern.slf4j.Slf4j; + +import stirling.software.common.service.LineArtConversionService; +import stirling.software.common.util.ProcessExecutor; +import stirling.software.common.util.ProcessExecutor.ProcessExecutorResult; + +@Slf4j +@Service +public class ImageMagickLineArtConversionService implements LineArtConversionService { + + @Override + public PDImageXObject convertImageToLineArt( + PDDocument doc, PDImageXObject originalImage, double threshold, int edgeLevel) + throws IOException { + + Path inputImage = Files.createTempFile("lineart_image_input_", ".png"); + Path outputImage = Files.createTempFile("lineart_image_output_", ".tiff"); + + try { + ImageIO.write(originalImage.getImage(), "png", inputImage.toFile()); + + List command = new ArrayList<>(); + command.add("magick"); + command.add(inputImage.toString()); + command.add("-colorspace"); + command.add("Gray"); + + // Edge-aware line art conversion using ImageMagick's built-in operators. + // -edge/-negate/-normalize are standard convert options (IM v6+/v7) that + // accentuate outlines before thresholding to a bilevel image. + command.add("-edge"); + command.add(String.valueOf(edgeLevel)); + command.add("-negate"); + command.add("-normalize"); + + command.add("-type"); + command.add("Bilevel"); + command.add("-threshold"); + command.add(String.format(Locale.ROOT, "%.1f%%", threshold)); + command.add("-compress"); + command.add("Group4"); + command.add(outputImage.toString()); + + ProcessExecutorResult result = + ProcessExecutor.getInstance(ProcessExecutor.Processes.IMAGEMAGICK) + .runCommandWithOutputHandling(command); + + if (result.getRc() != 0) { + log.warn( + "ImageMagick line art conversion failed with return code: {}", + result.getRc()); + throw new IOException("ImageMagick line art conversion failed"); + } + + byte[] convertedBytes = Files.readAllBytes(outputImage); + return PDImageXObject.createFromByteArray( + doc, convertedBytes, originalImage.getCOSObject().toString()); + } catch (Exception e) { + log.warn("ImageMagick line art conversion failed", e); + throw new IOException("ImageMagick line art conversion failed", e); + } finally { + Files.deleteIfExists(inputImage); + Files.deleteIfExists(outputImage); + } + } +} diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/service/UserLicenseSettingsService.java b/app/proprietary/src/main/java/stirling/software/proprietary/service/UserLicenseSettingsService.java index aa794e6997..54660a1ccb 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/service/UserLicenseSettingsService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/service/UserLicenseSettingsService.java @@ -177,6 +177,13 @@ public class UserLicenseSettingsService { */ @Transactional public void grandfatherExistingOAuthUsers() { + // Only grandfather users if this is a V1→V2 upgrade, not a fresh V2 install + Boolean isNewServer = applicationProperties.getAutomaticallyGenerated().getIsNewServer(); + if (Boolean.TRUE.equals(isNewServer)) { + log.info("Fresh V2 installation detected - skipping OAuth user grandfathering"); + return; + } + UserLicenseSettings settings = getOrCreateSettings(); // Check if we've already run this migration @@ -348,30 +355,22 @@ public class UserLicenseSettingsService { String username = (user != null) ? user.getUsername() : ""; log.info("OAuth eligibility check for user: {}", username); - // Grandfathered users always have OAuth access - if (user != null && user.isOauthGrandfathered()) { - log.debug("User {} is grandfathered for OAuth", user.getUsername()); + // Check license first - if paying, they're eligible (no need to check grandfathering) + boolean hasPaid = hasPaidLicense(); + if (hasPaid) { + log.debug("User {} eligible for OAuth via paid license", username); return true; } - // todo: remove - if (user != null) { - log.info( - "User {} is NOT grandfathered (isOauthGrandfathered={})", - username, - user.isOauthGrandfathered()); - } else { - log.info("New user attempting OAuth login - checking license requirement"); + // No license - check if grandfathered (fallback for V1 users) + if (user != null && user.isOauthGrandfathered()) { + log.info("User {} eligible for OAuth via grandfathering (no paid license)", username); + return true; } - // Users can use OAuth with SERVER or ENTERPRISE license - boolean hasPaid = hasPaidLicense(); - log.info( - "OAuth eligibility result: hasPaidLicense={}, user={}, eligible={}", - hasPaid, - username, - hasPaid); - return hasPaid; + // Not grandfathered and no license + log.info("User {} NOT eligible for OAuth: no paid license and not grandfathered", username); + return false; } /** @@ -391,29 +390,26 @@ public class UserLicenseSettingsService { String username = (user != null) ? user.getUsername() : ""; log.info("SAML2 eligibility check for user: {}", username); - // Grandfathered users always have SAML access - if (user != null && user.isOauthGrandfathered()) { - log.info("User {} is grandfathered for SAML2 - ELIGIBLE", username); + // Check license first - if paying, they're eligible (no need to check grandfathering) + boolean hasEnterprise = hasEnterpriseLicense(); + if (hasEnterprise) { + log.debug("User {} eligible for SAML2 via ENTERPRISE license", username); return true; } - if (user != null) { + // No license - check if grandfathered (fallback for V1 users) + if (user != null && user.isOauthGrandfathered()) { log.info( - "User {} is NOT grandfathered (isOauthGrandfathered={})", - username, - user.isOauthGrandfathered()); - } else { - log.info("New user attempting SAML2 login - checking license requirement"); + "User {} eligible for SAML2 via grandfathering (no ENTERPRISE license)", + username); + return true; } - // Users can use SAML only with ENTERPRISE license - boolean hasEnterprise = hasEnterpriseLicense(); + // Not grandfathered and no license log.info( - "SAML2 eligibility result: hasEnterpriseLicense={}, user={}, eligible={}", - hasEnterprise, - username, - hasEnterprise); - return hasEnterprise; + "User {} NOT eligible for SAML2: no ENTERPRISE license and not grandfathered", + username); + return false; } /** diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/util/FormUtils.java b/app/proprietary/src/main/java/stirling/software/proprietary/util/FormUtils.java index f35a3c3080..a3cf6ea55f 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/util/FormUtils.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/util/FormUtils.java @@ -1690,9 +1690,9 @@ public class FormUtils { acroForm.getFields().add(field); } - // Delegation methods to FormCopyUtils for form field transformation + // Delegation methods to GeneralFormCopyUtils for form field transformation public boolean hasAnyRotatedPage(PDDocument document) { - return FormCopyUtils.hasAnyRotatedPage(document); + return stirling.software.common.util.GeneralFormCopyUtils.hasAnyRotatedPage(document); } public void copyAndTransformFormFields( @@ -1705,7 +1705,7 @@ public class FormUtils { float cellWidth, float cellHeight) throws IOException { - FormCopyUtils.copyAndTransformFormFields( + stirling.software.common.util.GeneralFormCopyUtils.copyAndTransformFormFields( sourceDocument, newDocument, totalPages, diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/model/TeamTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/model/TeamTest.java new file mode 100644 index 0000000000..82e564bae8 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/model/TeamTest.java @@ -0,0 +1,74 @@ +package stirling.software.proprietary.model; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.junit.jupiter.MockitoExtension; + +import stirling.software.proprietary.security.model.User; + +@ExtendWith(MockitoExtension.class) +class TeamTest { + + @Test + void users_isInitializedAndEmpty() { + Team team = new Team(); + assertNotNull(team.getUsers(), "users Set should be initialized"); + assertTrue(team.getUsers().isEmpty(), "users Set should start empty"); + } + + @Test + void addUser_addsToSet_and_setsBackReference() { + Team team = new Team(); + User user = mock(User.class); + + team.addUser(user); + + assertTrue(team.getUsers().contains(user), "Team should contain added user"); + verify(user, times(1)).setTeam(team); + verifyNoMoreInteractions(user); + } + + @Test + void addUser_twice_isIdempotent_dueToSetSemantics() { + Team team = new Team(); + User user = mock(User.class); + + team.addUser(user); + team.addUser(user); + + assertEquals(1, team.getUsers().size(), "Adding same user twice should not duplicate"); + // In our code, setTeam is called twice (we only test Set idempotency) + verify(user, times(2)).setTeam(team); + } + + @Test + void removeUser_removesFromSet_and_clearsBackReference() { + Team team = new Team(); + User user = mock(User.class); + + team.addUser(user); + assertTrue(team.getUsers().contains(user)); + + team.removeUser(user); + + assertFalse(team.getUsers().contains(user), "User should be removed from Team"); + verify(user, times(1)).setTeam(null); + } + + @Test + void removeUser_onUserNotInSet_still_clearsBackReference() { + Team team = new Team(); + User stranger = mock(User.class); + + // not added + team.removeUser(stranger); + + // Set remains empty + assertTrue(team.getUsers().isEmpty()); + // Back-reference is still set to null + verify(stranger, times(1)).setTeam(null); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/model/dto/TeamWithUserCountDTOTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/model/dto/TeamWithUserCountDTOTest.java new file mode 100644 index 0000000000..6244584a7b --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/model/dto/TeamWithUserCountDTOTest.java @@ -0,0 +1,58 @@ +package stirling.software.proprietary.model.dto; + +import static org.junit.jupiter.api.Assertions.*; + +import org.junit.jupiter.api.Test; + +class TeamWithUserCountDTOTest { + + @Test + void allArgsConstructor_setsFields() { + TeamWithUserCountDTO dto = new TeamWithUserCountDTO(1L, "Engineering", 42L); + + assertEquals(1L, dto.getId()); + assertEquals("Engineering", dto.getName()); + assertEquals(42L, dto.getUserCount()); + } + + @Test + void noArgsConstructor_and_setters_work() { + TeamWithUserCountDTO dto = new TeamWithUserCountDTO(); + + assertNull(dto.getId()); + assertNull(dto.getName()); + assertNull(dto.getUserCount()); + + dto.setId(7L); + dto.setName("Ops"); + dto.setUserCount(5L); + + assertEquals(7L, dto.getId()); + assertEquals("Ops", dto.getName()); + assertEquals(5L, dto.getUserCount()); + } + + @Test + void equals_and_hashCode_based_on_fields() { + TeamWithUserCountDTO a = new TeamWithUserCountDTO(10L, "Team", 3L); + TeamWithUserCountDTO b = new TeamWithUserCountDTO(10L, "Team", 3L); + TeamWithUserCountDTO c = new TeamWithUserCountDTO(10L, "Team", 4L); // differs in userCount + + assertEquals(a, b); + assertEquals(a.hashCode(), b.hashCode()); + + assertNotEquals(a, c); + // Not strictly required but often true when a field differs: + assertNotEquals(a.hashCode(), c.hashCode()); + } + + @Test + void toString_contains_field_values() { + TeamWithUserCountDTO dto = new TeamWithUserCountDTO(2L, "QA", 8L); + String ts = dto.toString(); + + assertTrue(ts.contains("2")); + assertTrue(ts.contains("QA")); + assertTrue(ts.contains("8")); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/CustomLogoutSuccessHandlerTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/CustomLogoutSuccessHandlerTest.java index 0a8a2fbe0b..c4ae42f578 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/CustomLogoutSuccessHandlerTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/CustomLogoutSuccessHandlerTest.java @@ -16,7 +16,6 @@ import org.springframework.security.oauth2.client.authentication.OAuth2Authentic import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; -import stirling.software.common.configuration.AppConfig; import stirling.software.common.model.ApplicationProperties; import stirling.software.proprietary.security.service.JwtServiceInterface; @@ -25,8 +24,6 @@ class CustomLogoutSuccessHandlerTest { @Mock private ApplicationProperties.Security securityProperties; - @Mock private AppConfig appConfig; - @Mock private JwtServiceInterface jwtService; @InjectMocks private CustomLogoutSuccessHandler customLogoutSuccessHandler; diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/DatabaseConfigTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/DatabaseConfigTest.java index eac32eec4c..e74c5c56c4 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/DatabaseConfigTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/DatabaseConfigTest.java @@ -83,4 +83,12 @@ class DatabaseConfigTest { assertThrows(UnsupportedProviderException.class, () -> databaseConfig.dataSource()); } + + @Test + void getDriverClassName_returnsH2Driver() throws Exception { + var m = DatabaseConfig.class.getDeclaredMethod("getDriverClassName", String.class); + m.setAccessible(true); + String driver = (String) m.invoke(databaseConfig, "h2"); + assertEquals(org.springframework.boot.jdbc.DatabaseDriver.H2.getDriverClassName(), driver); + } } diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/ee/LicenseKeyCheckerTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/ee/LicenseKeyCheckerTest.java index 70dd809e43..b30b7fdbd9 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/ee/LicenseKeyCheckerTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/configuration/ee/LicenseKeyCheckerTest.java @@ -61,7 +61,7 @@ class LicenseKeyCheckerTest { ApplicationProperties props = new ApplicationProperties(); props.getPremium().setEnabled(true); - props.getPremium().setKey("file:" + file.toString()); + props.getPremium().setKey("file:" + file); when(verifier.verifyLicense("filekey")).thenReturn(License.ENTERPRISE); LicenseKeyChecker checker = @@ -77,7 +77,7 @@ class LicenseKeyCheckerTest { Path file = temp.resolve("missing.txt"); ApplicationProperties props = new ApplicationProperties(); props.getPremium().setEnabled(true); - props.getPremium().setKey("file:" + file.toString()); + props.getPremium().setKey("file:" + file); LicenseKeyChecker checker = new LicenseKeyChecker(verifier, props, userLicenseSettingsService); diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/database/H2SQLConditionTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/database/H2SQLConditionTest.java new file mode 100644 index 0000000000..dead1b44f4 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/database/H2SQLConditionTest.java @@ -0,0 +1,87 @@ +package stirling.software.proprietary.security.database; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +import org.junit.jupiter.api.Test; +import org.springframework.context.annotation.ConditionContext; +import org.springframework.core.type.AnnotatedTypeMetadata; +import org.springframework.mock.env.MockEnvironment; + +class H2SQLConditionTest { + + private final H2SQLCondition condition = new H2SQLCondition(); + + private boolean eval(MockEnvironment env) { + ConditionContext ctx = mock(ConditionContext.class); + when(ctx.getEnvironment()).thenReturn(env); + AnnotatedTypeMetadata md = mock(AnnotatedTypeMetadata.class); + return condition.matches(ctx, md); + } + + @Test + void returnsTrue_whenDisabledOrMissing_and_typeIsH2_caseInsensitive() { + // Flag fehlt, Typ=h2 -> true + MockEnvironment envMissingFlag = + new MockEnvironment().withProperty("system.datasource.type", "h2"); + assertTrue(eval(envMissingFlag)); + + // Flag=false, Typ=H2 -> true + MockEnvironment envFalseFlag = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "false") + .withProperty("system.datasource.type", "H2"); + assertTrue(eval(envFalseFlag)); + } + + @Test + void returnsFalse_whenEnableCustomDatabase_true_regardlessOfType() { + // Flag=true, Typ=h2 -> false + MockEnvironment envTrueH2 = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "true") + .withProperty("system.datasource.type", "h2"); + assertFalse(eval(envTrueH2)); + + // Flag=true, Typ=postgres -> false + MockEnvironment envTrueOther = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "true") + .withProperty("system.datasource.type", "postgresql"); + assertFalse(eval(envTrueOther)); + + // Flag=true, Typ fehlt -> false + MockEnvironment envTrueMissingType = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "true"); + assertFalse(eval(envTrueMissingType)); + } + + @Test + void returnsFalse_whenTypeNotH2_orMissing_andFlagNotEnabled() { + // Flag fehlt, Typ=postgres -> false + MockEnvironment envNotH2 = + new MockEnvironment().withProperty("system.datasource.type", "postgresql"); + assertFalse(eval(envNotH2)); + + // Flag=false, Typ fehlt -> false (Default: "") + MockEnvironment envMissingType = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "false"); + assertFalse(eval(envMissingType)); + } + + @Test + void returnsFalse_whenEnabled_but_type_not_h2_or_missing() { + MockEnvironment envNotH2 = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "true") + .withProperty("system.datasource.type", "postgresql"); + assertFalse(eval(envNotH2)); + + MockEnvironment envMissingType = + new MockEnvironment() + .withProperty("system.datasource.enableCustomDatabase", "true"); + assertFalse(eval(envMissingType)); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/database/ScheduledTasksTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/database/ScheduledTasksTest.java new file mode 100644 index 0000000000..cece597a31 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/database/ScheduledTasksTest.java @@ -0,0 +1,71 @@ +package stirling.software.proprietary.security.database; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.lang.reflect.Method; +import java.sql.SQLException; +import java.util.Arrays; + +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.context.annotation.Conditional; +import org.springframework.scheduling.annotation.Scheduled; + +import stirling.software.common.model.exception.UnsupportedProviderException; +import stirling.software.proprietary.security.service.DatabaseServiceInterface; + +@ExtendWith(MockitoExtension.class) +class ScheduledTasksTest { + + @Mock private DatabaseServiceInterface databaseService; + + @Test + void performBackup_calls_exportDatabase() throws Exception { + ScheduledTasks tasks = new ScheduledTasks(databaseService); + + tasks.performBackup(); + + verify(databaseService, times(1)).exportDatabase(); + verifyNoMoreInteractions(databaseService); + } + + @Test + void performBackup_propagates_SQLException() throws Exception { + ScheduledTasks tasks = new ScheduledTasks(databaseService); + doThrow(new SQLException("boom")).when(databaseService).exportDatabase(); + + assertThrows(SQLException.class, tasks::performBackup); + } + + @Test + void performBackup_propagates_UnsupportedProviderException() throws Exception { + ScheduledTasks tasks = new ScheduledTasks(databaseService); + doThrow(new UnsupportedProviderException("nope")).when(databaseService).exportDatabase(); + + assertThrows(UnsupportedProviderException.class, tasks::performBackup); + } + + @Test + void hasScheduledAnnotation_withSpELCron() throws Exception { + Method m = ScheduledTasks.class.getDeclaredMethod("performBackup"); + Scheduled scheduled = m.getAnnotation(Scheduled.class); + assertNotNull(scheduled, "@Scheduled annotation missing on performBackup()"); + assertEquals( + "#{applicationProperties.system.databaseBackup.cron}", + scheduled.cron(), + "Unexpected cron SpEL expression"); + } + + @Test + void classHasConditional_onH2SQLCondition() { + Conditional conditional = ScheduledTasks.class.getAnnotation(Conditional.class); + assertNotNull(conditional, "@Conditional missing on ScheduledTasks class"); + + boolean containsH2 = + Arrays.stream(conditional.value()).anyMatch(c -> c == H2SQLCondition.class); + assertTrue(containsH2, "@Conditional should include H2SQLCondition"); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/database/repository/JPATokenRepositoryImplTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/database/repository/JPATokenRepositoryImplTest.java new file mode 100644 index 0000000000..381e36a91b --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/database/repository/JPATokenRepositoryImplTest.java @@ -0,0 +1,141 @@ +package stirling.software.proprietary.security.database.repository; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; + +import java.util.Date; +import java.util.Optional; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; +import org.springframework.security.web.authentication.rememberme.PersistentRememberMeToken; + +import stirling.software.proprietary.security.model.PersistentLogin; + +class JPATokenRepositoryImplTest { + + private final PersistentLoginRepository persistentLoginRepository = + mock(PersistentLoginRepository.class); + private final JPATokenRepositoryImpl tokenRepository = + new JPATokenRepositoryImpl(persistentLoginRepository); + + @Nested + @DisplayName("createNewToken") + class CreateNewTokenTests { + + @Test + @DisplayName("should save new PersistentLogin with correct values") + void shouldSaveNewToken() { + Date date = new Date(); + PersistentRememberMeToken token = + new PersistentRememberMeToken("user1", "series123", "tokenABC", date); + + tokenRepository.createNewToken(token); + + ArgumentCaptor captor = ArgumentCaptor.forClass(PersistentLogin.class); + verify(persistentLoginRepository).save(captor.capture()); + + PersistentLogin saved = captor.getValue(); + assertEquals("series123", saved.getSeries()); + assertEquals("user1", saved.getUsername()); + assertEquals("tokenABC", saved.getToken()); + assertEquals(date.toInstant(), saved.getLastUsed()); + } + } + + @Nested + @DisplayName("updateToken") + class UpdateTokenTests { + + @Test + @DisplayName("should update existing token if found") + void shouldUpdateExistingToken() { + PersistentLogin existing = new PersistentLogin(); + existing.setSeries("series123"); + existing.setUsername("user1"); + existing.setToken("oldToken"); + existing.setLastUsed(new Date().toInstant()); + + when(persistentLoginRepository.findById("series123")).thenReturn(Optional.of(existing)); + + Date newDate = new Date(); + tokenRepository.updateToken("series123", "newToken", newDate); + + assertEquals("newToken", existing.getToken()); + assertEquals(newDate.toInstant(), existing.getLastUsed()); + verify(persistentLoginRepository).save(existing); + } + + @Test + @DisplayName("should do nothing if token not found") + void shouldDoNothingIfNotFound() { + when(persistentLoginRepository.findById("unknownSeries")).thenReturn(Optional.empty()); + + tokenRepository.updateToken("unknownSeries", "newToken", new Date()); + + verify(persistentLoginRepository, never()).save(any()); + } + } + + @Nested + @DisplayName("getTokenForSeries") + class GetTokenForSeriesTests { + + @Test + @DisplayName("should return PersistentRememberMeToken if found") + void shouldReturnTokenIfFound() { + Date date = new Date(); + PersistentLogin login = new PersistentLogin(); + login.setSeries("series123"); + login.setUsername("user1"); + login.setToken("tokenXYZ"); + login.setLastUsed(date.toInstant()); + + when(persistentLoginRepository.findById("series123")).thenReturn(Optional.of(login)); + + PersistentRememberMeToken result = tokenRepository.getTokenForSeries("series123"); + + assertNotNull(result); + assertEquals("user1", result.getUsername()); + assertEquals("series123", result.getSeries()); + assertEquals("tokenXYZ", result.getTokenValue()); + assertEquals(date, result.getDate()); + } + + @Test + @DisplayName("should return null if token not found") + void shouldReturnNullIfNotFound() { + when(persistentLoginRepository.findById("series123")).thenReturn(Optional.empty()); + + PersistentRememberMeToken result = tokenRepository.getTokenForSeries("series123"); + + assertNull(result); + } + } + + @Nested + @DisplayName("removeUserTokens") + class RemoveUserTokensTests { + + @Test + @DisplayName("should call deleteByUsername normally") + void shouldCallDeleteByUsername() { + tokenRepository.removeUserTokens("user1"); + verify(persistentLoginRepository).deleteByUsername("user1"); + } + + @Test + @DisplayName("should swallow exception if deleteByUsername fails") + void shouldSwallowException() { + doThrow(new RuntimeException("DB error")) + .when(persistentLoginRepository) + .deleteByUsername("user1"); + + assertDoesNotThrow(() -> tokenRepository.removeUserTokens("user1")); + verify(persistentLoginRepository).deleteByUsername("user1"); + } + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/model/ApiKeyAuthenticationTokenTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/ApiKeyAuthenticationTokenTest.java new file mode 100644 index 0000000000..ec0496f626 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/ApiKeyAuthenticationTokenTest.java @@ -0,0 +1,84 @@ +package stirling.software.proprietary.security.model; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.List; + +import org.junit.jupiter.api.Test; +import org.springframework.security.core.authority.SimpleGrantedAuthority; + +class ApiKeyAuthenticationTokenTest { + + @Test + void ctor_apiKeyOnly_isUnauthenticated_andStoresApiKey() { + String apiKey = "abc-123"; + ApiKeyAuthenticationToken token = new ApiKeyAuthenticationToken(apiKey); + + assertFalse(token.isAuthenticated(), "should be unauthenticated"); + assertNull(token.getPrincipal(), "principal should be null for unauthenticated ctor"); + assertEquals(apiKey, token.getCredentials(), "credentials should store api key"); + // Authorities: do not check version-dependent behavior (can be null or empty depending on + // Spring Security) + } + + @Test + void ctor_withPrincipalAndAuthorities_isAuthenticated_andStoresAll() { + String apiKey = "xyz-999"; + Object principal = new Object(); + var authorities = List.of(new SimpleGrantedAuthority("ROLE_API")); + + ApiKeyAuthenticationToken token = + new ApiKeyAuthenticationToken(principal, apiKey, authorities); + + assertTrue(token.isAuthenticated(), "should be authenticated"); + assertSame(principal, token.getPrincipal(), "principal should be set"); + assertEquals(apiKey, token.getCredentials(), "credentials should store api key"); + assertNotNull(token.getAuthorities()); + assertEquals(1, token.getAuthorities().size()); + assertEquals("ROLE_API", token.getAuthorities().iterator().next().getAuthority()); + } + + @Test + void setAuthenticated_true_throwsIllegalArgumentException() { + ApiKeyAuthenticationToken token = new ApiKeyAuthenticationToken("k"); + + IllegalArgumentException ex = + assertThrows(IllegalArgumentException.class, () -> token.setAuthenticated(true)); + assertTrue( + ex.getMessage().toLowerCase().contains("trusted"), + "message should explain to use the constructor with authorities"); + } + + @Test + void setAuthenticated_false_isAllowed_andUnsetsFlag() { + Object principal = new Object(); + ApiKeyAuthenticationToken token = + new ApiKeyAuthenticationToken( + principal, "k", List.of(new SimpleGrantedAuthority("ROLE_API"))); + + assertTrue(token.isAuthenticated()); + + // allowed to set to false (via the override method) + token.setAuthenticated(false); + + assertFalse(token.isAuthenticated()); + assertSame(principal, token.getPrincipal(), "principal remains"); + assertEquals("k", token.getCredentials(), "credentials remain until erased"); + } + + @Test + void eraseCredentials_setsCredentialsNull_butKeepsPrincipal() { + Object principal = new Object(); + ApiKeyAuthenticationToken token = + new ApiKeyAuthenticationToken( + principal, "top-secret", List.of(new SimpleGrantedAuthority("ROLE_API"))); + + assertEquals("top-secret", token.getCredentials()); + assertSame(principal, token.getPrincipal()); + + token.eraseCredentials(); + + assertNull(token.getCredentials(), "credentials should be nulled after erase"); + assertSame(principal, token.getPrincipal(), "principal should remain"); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/model/AttemptCounterTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/AttemptCounterTest.java new file mode 100644 index 0000000000..a749a1da63 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/AttemptCounterTest.java @@ -0,0 +1,285 @@ +package stirling.software.proprietary.security.model; + +import static org.junit.jupiter.api.Assertions.*; + +import java.lang.reflect.Field; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +/** + * Comprehensive tests for AttemptCounter. Notes: - We avoid timing flakiness by using generous + * windows or setting lastAttemptTime to 'now'. - Where assumptions are made about edge-case + * behavior, they are documented in comments. + */ +class AttemptCounterTest { + + // --- Helper functions for reflection access to private fields --- + + private static void setPrivateLong(Object target, String fieldName, long value) { + try { + Field f = target.getClass().getDeclaredField(fieldName); + f.setAccessible(true); + f.setLong(target, value); + } catch (Exception e) { + fail("Could not set field '" + fieldName + "': " + e.getMessage()); + } + } + + private static void setPrivateInt(Object target, String fieldName, int value) { + try { + Field f = target.getClass().getDeclaredField(fieldName); + f.setAccessible(true); + f.setInt(target, value); + } catch (Exception e) { + fail("Could not set field '" + fieldName + "': " + e.getMessage()); + } + } + + private static long getPrivateLong(Object target, String fieldName) { + try { + Field f = target.getClass().getDeclaredField(fieldName); + f.setAccessible(true); + return f.getLong(target); + } catch (Exception e) { + fail("Could not read field '" + fieldName + "': " + e.getMessage()); + return -1L; // unreachable + } + } + + // --- Tests --- + + @Test + @DisplayName("Constructor: attemptCount=0 and lastAttemptTime within creation period") + void constructor_shouldInitializeFields() { + long before = System.currentTimeMillis(); + AttemptCounter counter = new AttemptCounter(); + long after = System.currentTimeMillis(); + + // Purpose: Ensure that count is 0 and the timestamp lies in the [before, after] window + assertAll( + () -> assertEquals(0, counter.getAttemptCount(), "attemptCount should be 0"), + () -> { + long ts = counter.getLastAttemptTime(); + assertTrue( + ts >= before && ts <= after, + "lastAttemptTime should be between constructor start and end"); + }); + } + + @Test + @DisplayName( + "increment(): increases attemptCount and updates lastAttemptTime (not less than" + + " before)") + void increment_shouldIncreaseCountAndUpdateTime() { + AttemptCounter counter = new AttemptCounter(); + long prevTime = counter.getLastAttemptTime(); + + counter.increment(); + + // Purpose: After increment, count is +1 and timestamp is not older than before + assertAll( + () -> assertEquals(1, counter.getAttemptCount(), "attemptCount should be 1"), + () -> + assertTrue( + counter.getLastAttemptTime() >= prevTime, + "lastAttemptTime should not be less after increment")); + } + + @Test + @DisplayName("reset(): sets attemptCount to 0 and updates lastAttemptTime") + void reset_shouldZeroCountAndRefreshTime() { + AttemptCounter counter = new AttemptCounter(); + counter.increment(); + counter.increment(); + long beforeReset = counter.getLastAttemptTime(); + + counter.reset(); + + // Purpose: Ensure the counter is reset and time is updated + assertAll( + () -> + assertEquals( + 0, + counter.getAttemptCount(), + "attemptCount should be 0 after reset"), + () -> + assertTrue( + counter.getLastAttemptTime() >= beforeReset, + "lastAttemptTime should be updated after reset (>= previous)")); + } + + @Nested + @DisplayName("shouldReset(attemptIncrementTime)") + class ShouldResetTests { + + @Test + @DisplayName("returns FALSE when time difference is smaller than window") + void shouldReturnFalseWhenWithinWindow() { + AttemptCounter counter = new AttemptCounter(); + long window = 5_000L; // 5 seconds - generous buffer to avoid timing flakiness + long now = System.currentTimeMillis(); + + // Changed: Avoid flaky 1ms margin. We set lastAttemptTime to 'now' and choose a large + // window so elapsed < window is reliably true despite scheduling/clock granularity. + // Changed: Reason for change -> eliminate timing flakiness that caused sporadic + // failures. + setPrivateLong(counter, "lastAttemptTime", now); + + // Purpose: Inside the window -> no reset + assertFalse(counter.shouldReset(window), "Within the window, no reset should occur"); + } + + @Test + @DisplayName("returns TRUE when time difference is exactly equal to window") + void shouldReturnTrueWhenExactlyWindow() { + AttemptCounter counter = new AttemptCounter(); + long window = 200L; + long now = System.currentTimeMillis(); + + // Simulate: last action was exactly 'window' ms ago + setPrivateLong(counter, "lastAttemptTime", now - window); + + // Purpose: Equality -> reset should occur because the window has fully elapsed + assertTrue( + counter.shouldReset(window), + "With exactly equal difference, the reset window has elapsed"); + } + + @Test + @DisplayName("returns TRUE when time difference is greater than window") + void shouldReturnTrueWhenGreaterThanWindow() { + AttemptCounter counter = new AttemptCounter(); + long window = 100L; + long now = System.currentTimeMillis(); + + // Simulate: last action was (window + 1) ms ago + setPrivateLong(counter, "lastAttemptTime", now - (window + 1)); + + // Purpose: Outside the window -> reset + assertTrue(counter.shouldReset(window), "Outside the window, reset should occur"); + } + } + + @Nested + @DisplayName("shouldReset(attemptIncrementTime) – additional edge cases") + class AdditionalEdgeCases { + + @Test + @DisplayName("returns TRUE when window is zero (elapsed >= 0 is always true)") + void shouldReset_shouldReturnTrueWhenWindowIsZero() { + AttemptCounter counter = new AttemptCounter(); + // Set lastAttemptTime == now to avoid timing flakiness + long now = System.currentTimeMillis(); + setPrivateLong(counter, "lastAttemptTime", now); + + // Assumption/Documentation: current implementation uses 'elapsed >= + // attemptIncrementTime' + // With attemptIncrementTime == 0, condition is always true. + assertTrue(counter.shouldReset(0L), "Window=0 means the window has already elapsed"); + } + + @Test + @DisplayName("returns TRUE when window is negative (elapsed >= negative is always true)") + void shouldReset_shouldReturnTrueWhenWindowIsNegative() { + AttemptCounter counter = new AttemptCounter(); + long now = System.currentTimeMillis(); + setPrivateLong(counter, "lastAttemptTime", now); + + // Assumption/Documentation: Negative window is treated as already elapsed. + assertTrue( + counter.shouldReset(-1L), + "Negative window is nonsensical and should result in reset=true (elapsed >=" + + " negative)"); + } + } + + @Test + @DisplayName("Getters: return current values") + void getters_shouldReturnCurrentValues() { + AttemptCounter counter = new AttemptCounter(); + assertAll( + // Purpose: Basic getter functionality + () -> + assertEquals( + 0, counter.getAttemptCount(), "Initial attemptCount should be 0"), + () -> + assertTrue( + counter.getLastAttemptTime() <= System.currentTimeMillis(), + "lastAttemptTime should not be in the future")); + + counter.increment(); + int afterInc = counter.getAttemptCount(); + long last = counter.getLastAttemptTime(); + + assertAll( + // Purpose: After increment, getters reflect the new state + () -> assertEquals(1, afterInc, "attemptCount should be 1 after increment"), + () -> + assertEquals( + last, + counter.getLastAttemptTime(), + "lastAttemptTime should be consistent")); + } + + @Test + @DisplayName( + "Multiple increments(): Count increases monotonically and timestamp remains" + + " monotonically non-decreasing") + void multipleIncrements_shouldIncreaseMonotonically() { + AttemptCounter counter = new AttemptCounter(); + long t1 = counter.getLastAttemptTime(); + + counter.increment(); + long t2 = counter.getLastAttemptTime(); + + counter.increment(); + long t3 = counter.getLastAttemptTime(); + + // Purpose: Document monotonic behavior + assertAll( + () -> + assertEquals( + 2, + counter.getAttemptCount(), + "After two increments, count should be 2"), + () -> + assertTrue( + t2 >= t1 && t3 >= t2, + "Timestamps should be monotonically non-decreasing")); + } + + @Test + @DisplayName("Documenting edge case: attemptCount can technically overflow (int)") + void noteOnIntegerOverflowBehavior() { + // Note: This test only documents the current behavior of int overflow in Java. + // It does not enforce that overflow is desired, only makes visible what happens. + AttemptCounter counter = new AttemptCounter(); + + // Set counter close to Integer.MAX_VALUE and increment() + setPrivateInt(counter, "attemptCount", Integer.MAX_VALUE - 1); + counter.increment(); // -> MAX_VALUE + assertEquals( + Integer.MAX_VALUE, + counter.getAttemptCount(), + "Count should reach Integer.MAX_VALUE"); + + counter.increment(); // -> overflow to Integer.MIN_VALUE + assertEquals( + Integer.MIN_VALUE, + counter.getAttemptCount(), + "After increment past MAX_VALUE, int overflows to MIN_VALUE (Java standard" + + " behavior)"); + } + + @Test + @DisplayName("Reflection: getPrivateLong reads the actual lastAttemptTime") + void reflectionGetter_shouldReturnInternalValue() { + AttemptCounter counter = new AttemptCounter(); + long expected = counter.getLastAttemptTime(); + long reflected = getPrivateLong(counter, "lastAttemptTime"); + + assertEquals(expected, reflected, "Reflection getter should match the field value"); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/model/AuthorityTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/AuthorityTest.java new file mode 100644 index 0000000000..4dab8cf94b --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/AuthorityTest.java @@ -0,0 +1,96 @@ +package stirling.software.proprietary.security.model; + +import static org.junit.jupiter.api.Assertions.*; + +import org.junit.jupiter.api.Test; + +import stirling.software.proprietary.model.Team; + +class AuthorityTest { + + @Test + void noArgsConstructor_allowsSettersAndGetters() { + Authority a = new Authority(); + assertNull(a.getId()); + assertNull(a.getAuthority()); + assertNull(a.getUser()); + + a.setId(42L); + a.setAuthority("ROLE_USER"); + User u = new User(); + a.setUser(u); + + assertEquals(42L, a.getId()); + assertEquals("ROLE_USER", a.getAuthority()); + assertSame(u, a.getUser()); + } + + @Test + void ctorWithUser_setsFields_and_registersInUserAuthorities() { + User u = new User(); + // sanity: authorities set initialized? + assertNotNull(u.getAuthorities()); + assertTrue(u.getAuthorities().isEmpty()); + + Authority a = new Authority("ROLE_ADMIN", u); + + assertEquals("ROLE_ADMIN", a.getAuthority()); + assertSame(u, a.getUser()); + assertTrue(u.getAuthorities().contains(a), "Authority should be registered in user's set"); + assertEquals(1, u.getAuthorities().size()); + } + + @Test + void multipleAuthorities_registerEachInUser() { + User u = new User(); + + Authority a1 = new Authority("ROLE_A", u); + Authority a2 = new Authority("ROLE_B", u); + + assertTrue(u.getAuthorities().contains(a1)); + assertTrue(u.getAuthorities().contains(a2)); + assertEquals(2, u.getAuthorities().size()); + } + + @Test + void ctorWithNullUser_throwsNpe_dueToRegistrationInUserSet() { + assertThrows( + NullPointerException.class, + () -> new Authority("ROLE_X", null), + "Constructor calls user.getAuthorities() and should throw NPE when null"); + } + + @Test + void setUser_doesNotAutoRegisterInUserAuthorities_currentBehavior() { + User u = new User(); + Authority a = new Authority(); + a.setAuthority("ROLE_VIEWER"); + + // only using the setter → no automatic entry in the user's set + a.setUser(u); + + assertSame(u, a.getUser()); + assertTrue( + u.getAuthorities().isEmpty(), + "Current behavior: setUser() does not automatically register in user's set"); + } + + @Test + void toString_equalsHashCode_fromLombok_defaultObjectSemantics() { + // no @EqualsAndHashCode annotation -> default Object semantics + Authority a1 = new Authority(); + Authority a2 = new Authority(); + assertNotEquals(a1, a2); + assertNotEquals(a1.hashCode(), a2.hashCode()); + assertNotNull(a1); + } + + // Optional: shows that User has other fields that don't interfere + @Test + void worksWithUserHavingTeamField() { + User u = new User(); + u.setTeam(new Team()); // just to show that it has no effect + Authority a = new Authority("ROLE_TEST", u); + assertTrue(u.getAuthorities().contains(a)); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/model/UserTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/UserTest.java new file mode 100644 index 0000000000..10ea9be32a --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/UserTest.java @@ -0,0 +1,152 @@ +package stirling.software.proprietary.security.model; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.times; + +import java.util.LinkedHashSet; +import java.util.Set; + +import org.junit.jupiter.api.Test; +import org.mockito.MockedStatic; + +import stirling.software.common.model.enumeration.Role; +import stirling.software.proprietary.model.Team; + +class UserTest { + + @Test + void defaults_collections_initialized() { + User u = new User(); + assertNotNull(u.getAuthorities(), "authorities should be initialized"); + assertTrue(u.getAuthorities().isEmpty()); + assertNotNull(u.getSettings(), "settings should be initialized"); + assertTrue(u.getSettings().isEmpty()); + assertNull(u.getTeam()); + } + + @Test + void addAuthority_adds_to_set_but_doesNot_set_backref_on_authority() { + User u = new User(); + + Authority a = new Authority(); + a.setAuthority("ROLE_A"); + + u.addAuthority(a); + + assertTrue(u.getAuthorities().contains(a)); + // current behavior: addAuthority() does NOT call a.setUser(u) + assertNull( + a.getUser(), "Current behavior: Authority.user is NOT set by User.addAuthority()"); + } + + @Test + void addAuthorities_adds_all() { + User u = new User(); + + Authority a1 = new Authority(); + a1.setAuthority("ROLE_A"); + Authority a2 = new Authority(); + a2.setAuthority("ROLE_B"); + + Set batch = new LinkedHashSet<>(); + batch.add(a1); + batch.add(a2); + + u.addAuthorities(batch); + + assertEquals(2, u.getAuthorities().size()); + assertTrue(u.getAuthorities().contains(a1)); + assertTrue(u.getAuthorities().contains(a2)); + } + + @Test + void getRolesAsString_returns_roles_joined_order_agnostic() { + User u = new User(); + + // We use the Authority constructor that automatically adds itself to u.getAuthorities() + new Authority("ROLE_USER", u); + new Authority("ROLE_ADMIN", u); + + String roles = u.getRolesAsString(); + // Order is not guaranteed due to HashSet -> split/trim and compare as a Set + Set parts = + java.util.Arrays.stream(roles.split(",")) + .map(String::trim) + .filter(s -> !s.isEmpty()) + .collect(java.util.stream.Collectors.toSet()); + + assertEquals(Set.of("ROLE_USER", "ROLE_ADMIN"), parts); + } + + @Test + void hasPassword_null_empty_and_present() { + User u = new User(); + u.setPassword(null); + assertFalse(u.hasPassword()); + + u.setPassword(""); + assertFalse(u.hasPassword()); + + u.setPassword("secret"); + assertTrue(u.hasPassword()); + } + + @Test + void isFirstLogin_handles_null_false_true() { + User u = new User(); + + // Default is Boolean false (according to field initialization) + assertFalse(u.isFirstLogin()); + + u.setFirstLogin(true); + assertTrue(u.isFirstLogin()); + + // explicitly null -> method returns false + u.setIsFirstLogin(null); + assertFalse(u.isFirstLogin()); + } + + @Test + void setAuthenticationType_lowercases_enum_name() { + User u = new User(); + + // Use an existing value from your AuthenticationType enum (e.g. OAUTH2/SAML2/DATABASE) + // If the name differs, simply adjust below. + AuthenticationType at = AuthenticationType.SSO; + u.setAuthenticationType(at); + + assertEquals("sso", u.getAuthenticationType()); + } + + @Test + void team_setter_getter() { + User u = new User(); + Team t = new Team(); + u.setTeam(t); + assertSame(t, u.getTeam()); + } + + @Test + void getRoleName_delegatesToRole_withRolesAsString() { + User u = new User(); + + // Add authorities (order in HashSet doesn't matter) + new Authority("ROLE_USER", u); + new Authority("ROLE_ADMIN", u); + + // Expected argument created exactly as getRoleName() does internally + String expectedArg = u.getRolesAsString(); + + try (MockedStatic roleMock = mockStatic(Role.class)) { + roleMock.when(() -> Role.getRoleNameByRoleId(expectedArg)).thenReturn("Friendly Name"); + + String result = u.getRoleName(); + + assertEquals("Friendly Name", result); + + // Verify it was delegated exactly with the expected string + roleMock.verify(() -> Role.getRoleNameByRoleId(expectedArg), times(1)); + } + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/model/exception/BackupNotFoundExceptionTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/exception/BackupNotFoundExceptionTest.java new file mode 100644 index 0000000000..b8cebcc18a --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/exception/BackupNotFoundExceptionTest.java @@ -0,0 +1,34 @@ +package stirling.software.proprietary.security.model.exception; + +import static org.junit.jupiter.api.Assertions.*; + +import org.junit.jupiter.api.Test; + +class BackupNotFoundExceptionTest { + + @Test + void constructor_setsMessage() { + BackupNotFoundException ex = new BackupNotFoundException("not found"); + assertEquals("not found", ex.getMessage()); + assertNull(ex.getCause(), "No cause expected for single-arg constructor"); + } + + @Test + void extendsRuntimeExceptionDirectly() { + assertEquals( + RuntimeException.class, + BackupNotFoundException.class.getSuperclass(), + "BackupNotFoundException should extend RuntimeException directly"); + } + + @Test + void canBeThrownAndCaught() { + BackupNotFoundException ex = + assertThrows( + BackupNotFoundException.class, + () -> { + throw new BackupNotFoundException("missing backup"); + }); + assertEquals("missing backup", ex.getMessage()); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/model/exception/NoProviderFoundExceptionTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/exception/NoProviderFoundExceptionTest.java new file mode 100644 index 0000000000..8b2dba7562 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/model/exception/NoProviderFoundExceptionTest.java @@ -0,0 +1,33 @@ +package stirling.software.proprietary.security.model.exception; + +import static org.junit.jupiter.api.Assertions.*; + +import org.junit.jupiter.api.Test; + +class NoProviderFoundExceptionTest { + + @Test + void constructor_setsMessage_withoutCause() { + NoProviderFoundException ex = new NoProviderFoundException("no provider"); + assertEquals("no provider", ex.getMessage()); + assertNull(ex.getCause(), "Cause should be null for single-arg constructor"); + } + + @Test + void constructor_setsMessage_andCause() { + Throwable cause = new IllegalStateException("root"); + NoProviderFoundException ex = new NoProviderFoundException("missing", cause); + + assertEquals("missing", ex.getMessage()); + assertSame(cause, ex.getCause()); + } + + @Test + void canBeThrownAndCaught_checkedException() { + try { + throw new NoProviderFoundException("boom"); + } catch (NoProviderFoundException ex) { + assertEquals("boom", ex.getMessage()); + } + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/saml2/JwtSaml2AuthenticationRequestRepositoryTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/saml2/JwtSaml2AuthenticationRequestRepositoryTest.java index 1aa083cc0b..915c97444c 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/saml2/JwtSaml2AuthenticationRequestRepositoryTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/saml2/JwtSaml2AuthenticationRequestRepositoryTest.java @@ -1,9 +1,6 @@ package stirling.software.proprietary.security.saml2; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.ArgumentMatchers.anyMap; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.mock; @@ -62,7 +59,6 @@ class JwtSaml2AuthenticationRequestRepositoryTest { String id = "testId"; String relayState = "testRelayState"; String authnRequestUri = "example.com/authnRequest"; - Map claims = Map.of(); String samlRequest = "testSamlRequest"; String relyingPartyRegistrationId = "stirling-pdf"; diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/EmailServiceTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/EmailServiceTest.java index b1cd5a8ddd..66719e3726 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/EmailServiceTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/EmailServiceTest.java @@ -1,7 +1,6 @@ package stirling.software.proprietary.security.service; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.fail; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -63,7 +62,7 @@ public class EmailServiceTest { } @Test - void testSendEmailWithAttachmentThrowsExceptionForMissingFilename() throws MessagingException { + void testSendEmailWithAttachmentThrowsExceptionForMissingFilename() { Email email = new Email(); email.setTo("test@example.com"); email.setSubject("Test Email"); @@ -82,8 +81,7 @@ public class EmailServiceTest { } @Test - void testSendEmailWithAttachmentThrowsExceptionForMissingFilenameNull() - throws MessagingException { + void testSendEmailWithAttachmentThrowsExceptionForMissingFilenameNull() { Email email = new Email(); email.setTo("test@example.com"); email.setSubject("Test Email"); @@ -102,7 +100,7 @@ public class EmailServiceTest { } @Test - void testSendEmailWithAttachmentThrowsExceptionForMissingFile() throws MessagingException { + void testSendEmailWithAttachmentThrowsExceptionForMissingFile() { Email email = new Email(); email.setTo("test@example.com"); email.setSubject("Test Email"); @@ -120,7 +118,7 @@ public class EmailServiceTest { } @Test - void testSendEmailWithAttachmentThrowsExceptionForMissingFileNull() throws MessagingException { + void testSendEmailWithAttachmentThrowsExceptionForMissingFileNull() { Email email = new Email(); email.setTo("test@example.com"); email.setSubject("Test Email"); @@ -136,8 +134,7 @@ public class EmailServiceTest { } @Test - void testSendEmailWithAttachmentThrowsExceptionForInvalidAddressNull() - throws MessagingException { + void testSendEmailWithAttachmentThrowsExceptionForInvalidAddressNull() { Email email = new Email(); email.setTo(null); // Invalid address email.setSubject("Test Email"); @@ -153,8 +150,7 @@ public class EmailServiceTest { } @Test - void testSendEmailWithAttachmentThrowsExceptionForInvalidAddressEmpty() - throws MessagingException { + void testSendEmailWithAttachmentThrowsExceptionForInvalidAddressEmpty() { Email email = new Email(); email.setTo(""); // Invalid address email.setSubject("Test Email"); diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/LoginAttemptServiceTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/LoginAttemptServiceTest.java new file mode 100644 index 0000000000..fd6733d6d2 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/LoginAttemptServiceTest.java @@ -0,0 +1,239 @@ +package stirling.software.proprietary.security.service; + +import static org.junit.jupiter.api.Assertions.*; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.Arrays; +import java.util.Locale; +import java.util.concurrent.ConcurrentHashMap; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import stirling.software.proprietary.security.model.AttemptCounter; + +/** + * Tests for LoginAttemptService#getRemainingAttempts(...) focusing on edge cases and documented + * behavior. We instantiate the service reflectively to avoid depending on a specific constructor + * signature. Private fields are set via reflection to keep existing production code unchanged. + * + *

Assumptions: - 'MAX_ATTEMPT' is a private int (possibly static final); we read it via + * reflection (static-aware). - 'attemptsCache' is a ConcurrentHashMap. - + * 'isBlockedEnabled' is a boolean flag. - Behavior without clamping is intentional for now (can + * return negative values). + */ +class LoginAttemptServiceTest { + + // --- Reflection helpers --- + + private static Object constructLoginAttemptService() { + try { + Class clazz = + Class.forName( + "stirling.software.proprietary.security.service.LoginAttemptService"); + // Prefer a no-arg constructor if present; otherwise use the first and mock parameters. + Constructor[] ctors = clazz.getDeclaredConstructors(); + Arrays.stream(ctors).forEach(c -> c.setAccessible(true)); + + Constructor target = + Arrays.stream(ctors) + .filter(c -> c.getParameterCount() == 0) + .findFirst() + .orElse(ctors[0]); + + Object[] args = new Object[target.getParameterCount()]; + Class[] paramTypes = target.getParameterTypes(); + for (int i = 0; i < paramTypes.length; i++) { + Class p = paramTypes[i]; + if (p.isPrimitive()) { + // Provide basic defaults for primitives + args[i] = defaultValueForPrimitive(p); + } else { + args[i] = Mockito.mock(p); + } + } + return target.newInstance(args); + } catch (Exception e) { + fail("Could not construct LoginAttemptService reflectively: " + e.getMessage()); + return null; // unreachable + } + } + + private static Object defaultValueForPrimitive(Class p) { + if (p == boolean.class) return false; + if (p == byte.class) return (byte) 0; + if (p == short.class) return (short) 0; + if (p == char.class) return (char) 0; + if (p == int.class) return 0; + if (p == long.class) return 0L; + if (p == float.class) return 0f; + if (p == double.class) return 0d; + throw new IllegalArgumentException("Unsupported primitive: " + p); + } + + private static void setPrivate(Object target, String fieldName, Object value) { + try { + Field f = target.getClass().getDeclaredField(fieldName); + f.setAccessible(true); + if (Modifier.isStatic(f.getModifiers())) { + f.set(null, value); + } else { + f.set(target, value); + } + } catch (Exception e) { + fail("Could not set field '" + fieldName + "': " + e.getMessage()); + } + } + + private static void setPrivateBoolean(Object target, String fieldName, boolean value) { + try { + Field f = target.getClass().getDeclaredField(fieldName); + f.setAccessible(true); + if (Modifier.isStatic(f.getModifiers())) { + f.setBoolean(null, value); + } else { + f.setBoolean(target, value); + } + } catch (Exception e) { + fail("Could not set boolean field '" + fieldName + "': " + e.getMessage()); + } + } + + private static int getPrivateInt(Object targetOrClassInstance, String fieldName) { + try { + Class clazz = + targetOrClassInstance instanceof Class + ? (Class) targetOrClassInstance + : targetOrClassInstance.getClass(); + Field f = clazz.getDeclaredField(fieldName); + f.setAccessible(true); + if (Modifier.isStatic(f.getModifiers())) { + return f.getInt(null); + } else { + return f.getInt(targetOrClassInstance); + } + } catch (Exception e) { + fail("Could not read int field '" + fieldName + "': " + e.getMessage()); + return -1; // unreachable + } + } + + // --- Tests --- + + @Test + @DisplayName("getRemainingAttempts(): returns Integer.MAX_VALUE when disabled or key blank") + void getRemainingAttempts_shouldReturnMaxValueWhenDisabledOrBlankKey() throws Exception { + Object svc = constructLoginAttemptService(); + + // Ensure blocking disabled + setPrivateBoolean(svc, "isBlockedEnabled", false); + + var attemptsCache = new ConcurrentHashMap(); + setPrivate(svc, "attemptsCache", attemptsCache); + + var method = svc.getClass().getMethod("getRemainingAttempts", String.class); + + // Case 1: disabled -> always MAX_VALUE regardless of key + int disabledVal = (Integer) method.invoke(svc, "someUser"); + assertEquals( + Integer.MAX_VALUE, + disabledVal, + "Disabled tracking should return Integer.MAX_VALUE"); + + // Enable and verify blank/whitespace/null handling + setPrivateBoolean(svc, "isBlockedEnabled", true); + + int nullKeyVal = (Integer) method.invoke(svc, (Object) null); + int blankKeyVal = (Integer) method.invoke(svc, " "); + + assertEquals( + Integer.MAX_VALUE, + nullKeyVal, + "Null key should return Integer.MAX_VALUE per current contract"); + assertEquals( + Integer.MAX_VALUE, + blankKeyVal, + "Blank key should return Integer.MAX_VALUE per current contract"); + } + + @Test + @DisplayName("getRemainingAttempts(): returns MAX_ATTEMPT when no counter exists for key") + void getRemainingAttempts_shouldReturnMaxAttemptWhenNoEntry() throws Exception { + Object svc = constructLoginAttemptService(); + setPrivateBoolean(svc, "isBlockedEnabled", true); + var attemptsCache = new ConcurrentHashMap(); + setPrivate(svc, "attemptsCache", attemptsCache); + + int maxAttempt = getPrivateInt(svc, "MAX_ATTEMPT"); // Reads current policy value + var method = svc.getClass().getMethod("getRemainingAttempts", String.class); + + int v1 = (Integer) method.invoke(svc, "UserA"); + int v2 = + (Integer) + method.invoke(svc, "uSeRa"); // case-insensitive by service (normalization) + + assertEquals(maxAttempt, v1, "Unknown user should start with MAX_ATTEMPT remaining"); + assertEquals( + maxAttempt, + v2, + "Case-insensitivity should not create separate entries if none exists yet"); + } + + @Test + @DisplayName("getRemainingAttempts(): decreases with attemptCount in cache") + void getRemainingAttempts_shouldDecreaseAfterAttemptCount() throws Exception { + Object svc = constructLoginAttemptService(); + setPrivateBoolean(svc, "isBlockedEnabled", true); + + int maxAttempt = getPrivateInt(svc, "MAX_ATTEMPT"); + var attemptsCache = new ConcurrentHashMap(); + setPrivate(svc, "attemptsCache", attemptsCache); + + // Prepare a counter with attemptCount = 1 + AttemptCounter c1 = new AttemptCounter(); + Field ac = AttemptCounter.class.getDeclaredField("attemptCount"); + ac.setAccessible(true); + ac.setInt(c1, 1); + attemptsCache.put("userx".toLowerCase(Locale.ROOT), c1); + + var method = svc.getClass().getMethod("getRemainingAttempts", String.class); + int actual = (Integer) method.invoke(svc, "USERX"); + + assertEquals( + maxAttempt - 1, + actual, + "Remaining attempts should reflect current attemptCount (case-insensitive lookup)"); + } + + @Test + @DisplayName( + "getRemainingAttempts(): can become negative when attemptCount > MAX_ATTEMPT (document" + + " current behavior)") + void getRemainingAttempts_shouldBecomeNegativeWhenOverLimit_CurrentBehavior() throws Exception { + Object svc = constructLoginAttemptService(); + setPrivateBoolean(svc, "isBlockedEnabled", true); + + int maxAttempt = getPrivateInt(svc, "MAX_ATTEMPT"); + var attemptsCache = new ConcurrentHashMap(); + setPrivate(svc, "attemptsCache", attemptsCache); + + // Create counter with attemptCount = MAX_ATTEMPT + 5 + AttemptCounter c = new AttemptCounter(); + Field ac = AttemptCounter.class.getDeclaredField("attemptCount"); + ac.setAccessible(true); + ac.setInt(c, maxAttempt + 5); + attemptsCache.put("over".toLowerCase(Locale.ROOT), c); + + var method = svc.getClass().getMethod("getRemainingAttempts", String.class); + + int actual = (Integer) method.invoke(svc, "OVER"); + int expected = maxAttempt - (maxAttempt + 5); // -5 + + // Documentation test: current implementation returns a negative number. + // If you later clamp to 0, update this assertion accordingly and add a new test. + assertEquals(expected, actual, "Current behavior returns negative values without clamping"); + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/MailConfigTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/MailConfigTest.java index 5df56f8eff..3753ff69bb 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/MailConfigTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/MailConfigTest.java @@ -1,8 +1,6 @@ package stirling.software.proprietary.security.service; -import static org.junit.jupiter.api.Assertions.assertAll; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/UserServiceTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/UserServiceTest.java index c536cccdb6..aa742c0e48 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/security/service/UserServiceTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/security/service/UserServiceTest.java @@ -1,8 +1,6 @@ package stirling.software.proprietary.security.service; import static org.junit.jupiter.api.Assertions.*; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.*; import java.sql.SQLException; @@ -135,10 +133,9 @@ class UserServiceTest { AuthenticationType authType = AuthenticationType.WEB; // When & Then - IllegalArgumentException exception = - assertThrows( - IllegalArgumentException.class, - () -> userService.saveUser(invalidUsername, authType)); + assertThrows( + IllegalArgumentException.class, + () -> userService.saveUser(invalidUsername, authType)); verify(userRepository, never()).save(any(User.class)); verify(databaseService, never()).exportDatabase(); @@ -210,10 +207,9 @@ class UserServiceTest { AuthenticationType authType = AuthenticationType.WEB; // When & Then - IllegalArgumentException exception = - assertThrows( - IllegalArgumentException.class, - () -> userService.saveUser(reservedUsername, authType)); + assertThrows( + IllegalArgumentException.class, + () -> userService.saveUser(reservedUsername, authType)); verify(userRepository, never()).save(any(User.class)); verify(databaseService, never()).exportDatabase(); @@ -226,10 +222,9 @@ class UserServiceTest { AuthenticationType authType = AuthenticationType.WEB; // When & Then - IllegalArgumentException exception = - assertThrows( - IllegalArgumentException.class, - () -> userService.saveUser(anonymousUsername, authType)); + assertThrows( + IllegalArgumentException.class, + () -> userService.saveUser(anonymousUsername, authType)); verify(userRepository, never()).save(any(User.class)); verify(databaseService, never()).exportDatabase(); diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/service/UserLicenseSettingsServiceTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/service/UserLicenseSettingsServiceTest.java index 7f9445ad7c..3f0214573f 100644 --- a/app/proprietary/src/test/java/stirling/software/proprietary/service/UserLicenseSettingsServiceTest.java +++ b/app/proprietary/src/test/java/stirling/software/proprietary/service/UserLicenseSettingsServiceTest.java @@ -33,6 +33,7 @@ class UserLicenseSettingsServiceTest { @Mock private UserService userService; @Mock private ApplicationProperties applicationProperties; @Mock private ApplicationProperties.Premium premium; + @Mock private ApplicationProperties.AutomaticallyGenerated automaticallyGenerated; @Mock private LicenseKeyChecker licenseKeyChecker; @Mock private ObjectProvider licenseKeyCheckerProvider; @@ -49,6 +50,9 @@ class UserLicenseSettingsServiceTest { mockSettings.setGrandfatheredUserSignature("80:test-signature"); when(applicationProperties.getPremium()).thenReturn(premium); + when(applicationProperties.getAutomaticallyGenerated()).thenReturn(automaticallyGenerated); + when(automaticallyGenerated.getIsNewServer()) + .thenReturn(false); // Default: not a new server when(settingsRepository.findSettings()).thenReturn(Optional.of(mockSettings)); when(userService.getTotalUsersCount()).thenReturn(80L); when(settingsRepository.save(any(UserLicenseSettings.class))) diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/util/SecretMaskerTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/util/SecretMaskerTest.java new file mode 100644 index 0000000000..d91aec2029 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/util/SecretMaskerTest.java @@ -0,0 +1,176 @@ +package stirling.software.proprietary.util; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +/** + * Unit tests for {@link SecretMasker}. + * + *

Assumptions: - Key matching is case-insensitive via the pattern in SENSITIVE. - If the key + * matches a sensitive pattern, the value is replaced with "***REDACTED***". - Nested maps and lists + * are searched recursively. - Null maps and null values are ignored or returned as null. - + * Non-sensitive keys/values remain unchanged. + */ +class SecretMaskerTest { + + @Nested + @DisplayName("mask(Map) method") + class MaskMethod { + + @Test + @DisplayName("should return null when input map is null") + void shouldReturnNullWhenInputIsNull() { + assertNull(SecretMasker.mask(null)); + } + + @Test + @DisplayName("should mask simple sensitive keys at root level") + void shouldMaskSimpleSensitiveKeys() { + Map input = + Map.of( + "password", "mySecret", + "username", "john"); + + Map result = SecretMasker.mask(input); + + assertEquals("***REDACTED***", result.get("password")); + assertEquals("john", result.get("username")); + } + + @Test + @DisplayName("should mask keys case-insensitively and with special characters") + void shouldMaskKeysCaseInsensitive() { + Map input = + Map.of( + "Api-Key", "12345", + "TOKEN", "abcde", + "normal", "keepme"); + + Map result = SecretMasker.mask(input); + + assertEquals("***REDACTED***", result.get("Api-Key")); + assertEquals("***REDACTED***", result.get("TOKEN")); + assertEquals("keepme", result.get("normal")); + } + + @Test + @DisplayName("should mask nested map sensitive keys") + void shouldMaskNestedMapSensitiveKeys() { + Map input = + Map.of( + "outer", + Map.of( + "jwt", + "tokenValue", + "inner", + Map.of( + "secret", "deepValue", + "other", "ok"))); + + Map result = SecretMasker.mask(input); + + Map outer = (Map) result.get("outer"); + assertEquals("***REDACTED***", outer.get("jwt")); + Map inner = (Map) outer.get("inner"); + assertEquals("***REDACTED***", inner.get("secret")); + assertEquals("ok", inner.get("other")); + } + + @Test + @DisplayName("should mask sensitive keys inside lists") + void shouldMaskSensitiveKeysInsideLists() { + Map input = + Map.of( + "list", + List.of( + Map.of("token", "abc123"), + Map.of("username", "john"), + "stringValue")); + + Map result = SecretMasker.mask(input); + + List list = (List) result.get("list"); + Map first = (Map) list.get(0); + assertEquals("***REDACTED***", first.get("token")); + Map second = (Map) list.get(1); + assertEquals("john", second.get("username")); + assertEquals("stringValue", list.get(2)); + } + + @Test + @DisplayName("should ignore null values") + void shouldIgnoreNullValues() { + // IMPORTANT: Map.of(...) does not allow nulls -> use a mutable Map instead + Map input = new HashMap<>(); + input.put("password", null); + input.put("normal", null); + + Map result = SecretMasker.mask(input); + + // Null values are completely filtered out + assertFalse(result.containsKey("password")); + assertFalse(result.containsKey("normal")); + assertTrue(result.isEmpty(), "Result map should be empty if all entries were null"); + } + + @Test + @DisplayName("should not mask when key does not match pattern") + void shouldNotMaskWhenKeyNotSensitive() { + Map input = Map.of("email", "test@example.com"); + + Map result = SecretMasker.mask(input); + assertEquals("test@example.com", result.get("email")); + } + } + + @Nested + @DisplayName("Deep masking edge branches") + class DeepMaskBranches { + + @Test + @DisplayName("should filter out null values inside nested map") + void shouldFilterOutNullValuesInsideNestedMap() { + // outer -> { inner -> { "token": null, "username": "john" } } + Map inner = new HashMap<>(); + inner.put("token", null); // <- should be filtered out in the result (branch false) + inner.put("username", "john"); // <- should remain + + Map input = Map.of("outer", Map.of("inner", inner)); + + Map result = SecretMasker.mask(input); + + Map outer = (Map) result.get("outer"); + Map maskedInner = (Map) outer.get("inner"); + + // "token" was null -> should be completely absent (filter branch in deepMask(Map)) + assertFalse(maskedInner.containsKey("token")); + // "username" remains unchanged + assertEquals("john", maskedInner.get("username")); + } + + @Test + @DisplayName("should not mask when key is null (falls back to deepMask(value))") + void shouldNotMaskWhenKeyIsNull() { + // Map with null key: { null: "plainText", "password": "toHide" } + Map sensitive = new HashMap<>(); + sensitive.put(null, "plainText"); // <- key == null -> no masking, value stays + sensitive.put("password", "toHide"); // <- sensitive key -> will be masked + + Map input = Map.of("outer", sensitive); + + Map result = SecretMasker.mask(input); + + Map outer = (Map) result.get("outer"); + assertTrue(outer.containsKey(null), "Null key should be preserved"); + assertEquals("plainText", outer.get(null), "Value for null key must not be masked"); + assertEquals("***REDACTED***", outer.get("password"), "Sensitive keys must be masked"); + } + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/web/AuditWebFilterTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/web/AuditWebFilterTest.java new file mode 100644 index 0000000000..d1e8e3bd7c --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/web/AuditWebFilterTest.java @@ -0,0 +1,317 @@ +package stirling.software.proprietary.web; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.IOException; +import java.util.*; + +import org.junit.jupiter.api.*; +import org.slf4j.MDC; +import org.springframework.mock.web.MockHttpServletRequest; +import org.springframework.mock.web.MockHttpServletResponse; +import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; +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 jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.ServletRequest; +import jakarta.servlet.ServletResponse; + +/** + * Tests for {@link AuditWebFilter}. + * + *

Note: The filter clears the MDC in its finally block. Therefore we capture the MDC values + * inside a special FilterChain before the clear happens (snapshot). + */ +class AuditWebFilterTest { + + private AuditWebFilter filter; + private MockHttpServletRequest request; + private MockHttpServletResponse response; + + /** Small helper chain that captures MDC values during the chain invocation. */ + static class CapturingFilterChain implements FilterChain { + final Map captured = new HashMap<>(); + boolean called = false; + + @Override + public void doFilter(ServletRequest req, ServletResponse res) + throws IOException, ServletException { + called = true; + // Snapshot of the MDC keys set by the filter (before the finally-clear) + captured.put("userAgent", MDC.get("userAgent")); + captured.put("referer", MDC.get("referer")); + captured.put("acceptLanguage", MDC.get("acceptLanguage")); + captured.put("contentType", MDC.get("contentType")); + captured.put("userRoles", MDC.get("userRoles")); + captured.put("queryParams", MDC.get("queryParams")); + } + } + + /** Variant that intentionally throws an exception after capturing. */ + static class ThrowingAfterCaptureChain extends CapturingFilterChain { + @Override + public void doFilter(ServletRequest req, ServletResponse res) + throws IOException, ServletException { + super.doFilter(req, res); + throw new IOException("Test Exception"); + } + } + + @BeforeEach + void setUp() { + filter = new AuditWebFilter(); + request = new MockHttpServletRequest(); + response = new MockHttpServletResponse(); + MDC.clear(); + SecurityContextHolder.clearContext(); + } + + @AfterEach + void tearDown() { + MDC.clear(); + SecurityContextHolder.clearContext(); + } + + @Nested + @DisplayName("Header and query parameter handling") + class HeaderAndQueryTests { + + @Test + @DisplayName("Should store all provided headers and query parameters in MDC") + void shouldStoreHeadersAndQueryParamsInMdc() throws ServletException, IOException { + request.addHeader("User-Agent", "JUnit-Test-Agent"); + request.addHeader("Referer", "http://example.com"); + request.addHeader("Accept-Language", "de-DE"); + request.addHeader("Content-Type", "application/json"); + request.setParameter("param1", "value1"); + request.setParameter("param2", "value2"); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertTrue(chain.called, "FilterChain should have been called"); + assertEquals("JUnit-Test-Agent", chain.captured.get("userAgent")); + assertEquals("http://example.com", chain.captured.get("referer")); + assertEquals("de-DE", chain.captured.get("acceptLanguage")); + assertEquals("application/json", chain.captured.get("contentType")); + String params = chain.captured.get("queryParams"); + assertNotNull(params); + assertTrue(params.contains("param1")); + assertTrue(params.contains("param2")); + + assertNull(MDC.get("userAgent")); + assertNull(MDC.get("queryParams")); + } + + @Test + @DisplayName("Should only store present headers and set nothing for empty inputs") + void shouldNotStoreNullHeaders() throws ServletException, IOException { + request.setParameter("onlyParam", "123"); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertNull(chain.captured.get("userAgent")); + assertNull(chain.captured.get("referer")); + assertNull(chain.captured.get("acceptLanguage")); + assertNull(chain.captured.get("contentType")); + assertEquals("onlyParam", chain.captured.get("queryParams")); + } + + // New: empty parameter map case (branch: parameterMap != null && !isEmpty() -> false) + @Test + @DisplayName("Should not set queryParams when parameter map is empty") + void shouldNotStoreQueryParamsWhenEmpty() throws ServletException, IOException { + // no request.setParameter(...) + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertNull( + chain.captured.get("queryParams"), + "With an empty map, queryParams must not be set"); + } + + // New: parameterMap == null (branch: parameterMap != null -> false) + @Test + @DisplayName("Should handle getParameterMap() returning null safely") + void shouldHandleNullParameterMapSafely() throws ServletException, IOException { + MockHttpServletRequest reqWithNullParamMap = + new MockHttpServletRequest() { + @Override + public Map getParameterMap() { + // Assumption: defensive branch in the filter; simulate a broken/unusual + // implementation + return null; + } + }; + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(reqWithNullParamMap, response, chain); + + assertNull( + chain.captured.get("queryParams"), + "With a null parameter map, queryParams must not be set"); + } + } + + @Nested + @DisplayName("Authenticated users") + class AuthenticatedUserTests { + + @Test + @DisplayName("Should store roles of the authenticated user") + void shouldStoreUserRolesInMdc() throws ServletException, IOException { + SecurityContextHolder.getContext() + .setAuthentication( + new UsernamePasswordAuthenticationToken( + "user", + "pass", + Collections.singletonList( + new SimpleGrantedAuthority("ROLE_ADMIN")))); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertEquals("ROLE_ADMIN", chain.captured.get("userRoles")); + assertNull(MDC.get("userRoles")); + } + + @Test + @DisplayName("Should store multiple roles comma-separated") + void shouldStoreMultipleRolesCommaSeparated() throws ServletException, IOException { + SecurityContextHolder.getContext() + .setAuthentication( + new UsernamePasswordAuthenticationToken( + "user", + "pass", + List.of( + new SimpleGrantedAuthority("ROLE_USER"), + new SimpleGrantedAuthority("ROLE_ADMIN")))); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + String roles = chain.captured.get("userRoles"); + assertNotNull(roles, "Roles should be set"); + assertTrue(roles.contains("ROLE_USER")); + assertTrue(roles.contains("ROLE_ADMIN")); + assertTrue(roles.contains(","), "Roles should be separated by a comma"); + } + + // New: auth == null (branch: auth != null -> false) + @Test + @DisplayName("Should not set userRoles when no Authentication object is present") + void shouldNotStoreUserRolesWhenAuthIsNull() throws ServletException, IOException { + // SecurityContext remains empty + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertNull(chain.captured.get("userRoles")); + } + + // New: authorities == null (branch: auth != null && authorities != null -> false) + @Test + @DisplayName("Should not set userRoles when authorities are null") + void shouldNotStoreUserRolesWhenAuthoritiesIsNull() throws ServletException, IOException { + Authentication authWithNullAuthorities = + new Authentication() { + @Override + public Collection getAuthorities() { + return null; // important + } + + @Override + public Object getCredentials() { + return "cred"; + } + + @Override + public Object getDetails() { + return null; + } + + @Override + public Object getPrincipal() { + return "user"; + } + + @Override + public boolean isAuthenticated() { + return true; + } + + @Override + public void setAuthenticated(boolean isAuthenticated) + throws IllegalArgumentException {} + + @Override + public String getName() { + return "user"; + } + }; + SecurityContextHolder.getContext().setAuthentication(authWithNullAuthorities); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertNull( + chain.captured.get("userRoles"), + "With null authorities, userRoles must not be set"); + } + + // New: empty authorities list -> reduce(...).orElse("") → empty string is set + @Test + @DisplayName("Should set empty string when authorities list is empty") + void shouldStoreEmptyStringWhenAuthoritiesEmpty() throws ServletException, IOException { + SecurityContextHolder.getContext() + .setAuthentication( + new UsernamePasswordAuthenticationToken( + "user", "pass", Collections.emptyList())); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertEquals( + "", + chain.captured.get("userRoles"), + "With an empty roles list, an empty string should be set"); + } + } + + @Nested + @DisplayName("MDC cleanup logic") + class MdcCleanupTests { + + @Test + @DisplayName("Should clear MDC after processing") + void shouldClearMdcAfterProcessing() throws ServletException, IOException { + request.addHeader("User-Agent", "JUnit-Test-Agent"); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertEquals("JUnit-Test-Agent", chain.captured.get("userAgent")); + assertNull(MDC.get("userAgent"), "MDC should be cleared after processing"); + } + + @Test + @DisplayName("Should clear MDC even when the FilterChain throws") + void shouldClearMdcOnException() throws ServletException, IOException { + request.addHeader("User-Agent", "JUnit-Test-Agent"); + ThrowingAfterCaptureChain chain = new ThrowingAfterCaptureChain(); + + IOException thrown = + assertThrows( + IOException.class, + () -> filter.doFilterInternal(request, response, chain)); + + assertEquals("Test Exception", thrown.getMessage()); + assertEquals("JUnit-Test-Agent", chain.captured.get("userAgent")); + assertNull(MDC.get("userAgent"), "MDC should also be cleared after exceptions"); + } + } +} diff --git a/app/proprietary/src/test/java/stirling/software/proprietary/web/CorrelationIdFilterTest.java b/app/proprietary/src/test/java/stirling/software/proprietary/web/CorrelationIdFilterTest.java new file mode 100644 index 0000000000..9ab5abf8c1 --- /dev/null +++ b/app/proprietary/src/test/java/stirling/software/proprietary/web/CorrelationIdFilterTest.java @@ -0,0 +1,188 @@ +package stirling.software.proprietary.web; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.UUID; + +import org.junit.jupiter.api.*; +import org.slf4j.MDC; +import org.springframework.mock.web.MockHttpServletRequest; +import org.springframework.mock.web.MockHttpServletResponse; + +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.ServletRequest; +import jakarta.servlet.ServletResponse; + +/** + * Tests for {@link CorrelationIdFilter}. + * + *

Important notes: - The filter sets MDC in the try block and clears it in the finally block. + * Therefore, we capture the MDC values inside a special FilterChain before the clear happens + * (snapshot). - The response header is sanitized via Newlines.stripAll(id). The current code does + * NOT sanitize the value stored in the MDC or the request attribute. These tests reflect the + * current behavior. + */ +class CorrelationIdFilterTest { + + private CorrelationIdFilter filter; + private MockHttpServletRequest request; + private MockHttpServletResponse response; + + /** Chain that snapshots the MDC and header/attribute values during doFilter(). */ + static class CapturingFilterChain implements FilterChain { + final Map capturedMdc = new HashMap<>(); + String responseHeader; + Object requestAttr; + boolean called = false; + + @Override + public void doFilter(ServletRequest req, ServletResponse res) + throws IOException, ServletException { + called = true; + // Snapshot: MDC and request attributes during chain execution + capturedMdc.put(CorrelationIdFilter.MDC_KEY, MDC.get(CorrelationIdFilter.MDC_KEY)); + requestAttr = ((MockHttpServletRequest) req).getAttribute(CorrelationIdFilter.MDC_KEY); + responseHeader = ((MockHttpServletResponse) res).getHeader(CorrelationIdFilter.HEADER); + } + } + + /** Variant that intentionally throws an exception after capturing (to test cleanup). */ + static class ThrowingAfterCaptureChain extends CapturingFilterChain { + @Override + public void doFilter(ServletRequest req, ServletResponse res) + throws IOException, ServletException { + super.doFilter(req, res); + throw new IOException("boom"); + } + } + + @BeforeEach + void setUp() { + filter = new CorrelationIdFilter(); + request = new MockHttpServletRequest(); + response = new MockHttpServletResponse(); + MDC.clear(); + } + + @AfterEach + void tearDown() { + MDC.clear(); + } + + @Nested + @DisplayName("Existing X-Request-Id header") + class ExistingHeader { + + @Test + @DisplayName( + "Should propagate existing ID unchanged to MDC & request attribute, and set it in" + + " the response header") + void shouldPropagateExistingId() throws ServletException, IOException { + String givenId = "abc-123"; + request.addHeader(CorrelationIdFilter.HEADER, givenId); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertTrue(chain.called); + // Set during the chain + assertEquals(givenId, chain.capturedMdc.get(CorrelationIdFilter.MDC_KEY)); + assertEquals(givenId, chain.requestAttr); + assertEquals(givenId, chain.responseHeader); + + // Cleared afterwards + assertNull(MDC.get(CorrelationIdFilter.MDC_KEY)); + } + + @Test + @DisplayName( + "Should strip newlines only in the response header, leaving MDC/attribute" + + " unsanitized (per current code)") + void shouldStripNewlinesOnlyInResponseHeader() throws ServletException, IOException { + String raw = "id-with\r\nnewlines"; + String expectedSanitized = "id-withnewlines"; // Newlines removed + request.addHeader(CorrelationIdFilter.HEADER, raw); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + // MDC & request attribute get the raw value (per implementation) + assertEquals(raw, chain.capturedMdc.get(CorrelationIdFilter.MDC_KEY)); + assertEquals(raw, chain.requestAttr); + // Response header is sanitized + assertEquals(expectedSanitized, chain.responseHeader); + + assertNull(MDC.get(CorrelationIdFilter.MDC_KEY)); + } + } + + @Nested + @DisplayName("Missing or blank header") + class MissingOrBlankHeader { + + @Test + @DisplayName("Should generate UUID when header is missing") + void shouldGenerateUuidWhenHeaderMissing() throws ServletException, IOException { + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + assertTrue(chain.called); + + // Consistency: same value in MDC, request attribute, and response header (no newline + // removal needed) + String mdcId = chain.capturedMdc.get(CorrelationIdFilter.MDC_KEY); + assertNotNull(mdcId); + assertEquals(mdcId, chain.requestAttr); + assertEquals(mdcId, chain.responseHeader); + + // UUID format check + assertDoesNotThrow(() -> UUID.fromString(mdcId)); + + assertNull(MDC.get(CorrelationIdFilter.MDC_KEY)); + } + + @Test + @DisplayName("Should generate UUID when header is blank/whitespace") + void shouldGenerateUuidWhenHeaderBlank() throws ServletException, IOException { + request.addHeader(CorrelationIdFilter.HEADER, " \t "); + + CapturingFilterChain chain = new CapturingFilterChain(); + filter.doFilterInternal(request, response, chain); + + String mdcId = chain.capturedMdc.get(CorrelationIdFilter.MDC_KEY); + assertNotNull(mdcId); + assertEquals(mdcId, chain.requestAttr); + assertEquals(mdcId, chain.responseHeader); + assertDoesNotThrow(() -> UUID.fromString(mdcId)); + + assertNull(MDC.get(CorrelationIdFilter.MDC_KEY)); + } + } + + @Nested + @DisplayName("Cleanup logic (finally)") + class CleanupBehavior { + + @Test + @DisplayName("Should clear MDC even when FilterChain throws") + void shouldClearMdcOnException() throws ServletException, IOException { + request.addHeader(CorrelationIdFilter.HEADER, "req-1"); + ThrowingAfterCaptureChain chain = new ThrowingAfterCaptureChain(); + + IOException ex = + assertThrows( + IOException.class, + () -> filter.doFilterInternal(request, response, chain)); + assertEquals("boom", ex.getMessage()); + + // Was set during the chain… + assertEquals("req-1", chain.capturedMdc.get(CorrelationIdFilter.MDC_KEY)); + // …and cleared afterwards. + assertNull(MDC.get(CorrelationIdFilter.MDC_KEY)); + } + } +} diff --git a/build.gradle b/build.gradle index 90fde88e59..cb5580ef32 100644 --- a/build.gradle +++ b/build.gradle @@ -2,13 +2,13 @@ plugins { id "java" id "jacoco" id "io.spring.dependency-management" version "1.1.7" - id "org.springframework.boot" version "3.5.6" + id "org.springframework.boot" version "3.5.7" id "org.springdoc.openapi-gradle-plugin" version "1.9.0" id "io.swagger.swaggerhub" version "1.3.2" - id "com.diffplug.spotless" version "7.2.1" - id "com.github.jk1.dependency-license-report" version "2.9" + id "com.diffplug.spotless" version "8.1.0" + id "com.github.jk1.dependency-license-report" version "3.0.1" //id "nebula.lint" version "19.0.3" - id "org.sonarqube" version "6.3.1.5724" + id "org.sonarqube" version "7.2.2.6593" } import com.github.jk1.license.render.* @@ -16,15 +16,16 @@ import groovy.json.JsonOutput import groovy.json.JsonSlurper ext { - springBootVersion = "3.5.6" - pdfboxVersion = "3.0.5" - imageioVersion = "3.12.0" + springBootVersion = "3.5.7" + pdfboxVersion = "3.0.6" + imageioVersion = "3.13.0" lombokVersion = "1.18.42" - bouncycastleVersion = "1.82" - springSecuritySamlVersion = "6.5.5" + bouncycastleVersion = "1.83" + springSecuritySamlVersion = "6.5.6" openSamlVersion = "4.3.2" - commonmarkVersion = "0.26.0" + commonmarkVersion = "0.27.0" googleJavaFormatVersion = "1.28.0" + logback = "1.5.23" junitPlatformVersion = "1.12.2" } @@ -59,7 +60,7 @@ repositories { allprojects { group = 'stirling.software' - version = '2.1.3' + version = '2.2.0' configurations.configureEach { exclude group: 'commons-logging', module: 'commons-logging' @@ -162,22 +163,24 @@ subprojects { implementation 'io.github.pixee:java-security-toolkit:1.2.2' //tmp for security bumps - implementation 'ch.qos.logback:logback-core:1.5.19' - implementation 'ch.qos.logback:logback-classic:1.5.19' + implementation "ch.qos.logback:logback-core:$logback" + implementation "ch.qos.logback:logback-classic:$logback" compileOnly "org.projectlombok:lombok:$lombokVersion" annotationProcessor "org.projectlombok:lombok:$lombokVersion" testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.mockito:mockito-inline:5.2.0' - testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junitPlatformVersion" + testRuntimeOnly "org.junit.platform:junit-platform-launcher" - testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.1.0") + testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.3.2") testImplementation "com.squareup.okhttp3:mockwebserver" } tasks.withType(JavaCompile).configureEach { options.encoding = "UTF-8" - dependsOn "spotlessApply" + if (!project.hasProperty("noSpotless")) { + dependsOn "spotlessApply" + } } compileJava { @@ -331,7 +334,7 @@ dependencies { testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junitPlatformVersion" - testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.1.0") + testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.3.2") testImplementation "com.squareup.okhttp3:mockwebserver" } diff --git a/devGuide/DeveloperGuide.md b/devGuide/DeveloperGuide.md index fb8911eaf7..746e09e247 100644 --- a/devGuide/DeveloperGuide.md +++ b/devGuide/DeveloperGuide.md @@ -12,6 +12,7 @@ Stirling-PDF is built using: - PDFBox - LibreOffice - qpdf +- Calibre (`ebook-convert` CLI) for eBook conversions - HTML, CSS, JavaScript - Docker - PDF.js @@ -54,7 +55,12 @@ Stirling-PDF is built using: Stirling-PDF uses Lombok to reduce boilerplate code. Some IDEs, like Eclipse, don't support Lombok out of the box. To set up Lombok in your development environment: Visit the [Lombok website](https://projectlombok.org/setup/) for installation instructions specific to your IDE. -5. Add environment variable +5. Install Calibre CLI (optional but required for eBook conversions) + Ensure the `ebook-convert` binary from Calibre is available on your PATH when working on the + eBook to PDF feature. The Calibre tool group is automatically disabled when the binary is + missing, so having it installed locally allows you to exercise the full workflow. + +6. Add environment variable For local testing, you should generally be testing the full 'Security' version of Stirling PDF. To do this, you must add the environment flag DISABLE_ADDITIONAL_FEATURES=false to your system and/or IDE build/run step. ## 4. Project Structure diff --git a/devTools/package-lock.json b/devTools/package-lock.json index da6cfe0cae..634fcad9a6 100644 --- a/devTools/package-lock.json +++ b/devTools/package-lock.json @@ -8,9 +8,9 @@ "name": "stirling-pdf", "version": "1.0.0", "devDependencies": { - "@stylistic/stylelint-plugin": "^3.1.3", - "stylelint": "^16.21.1", - "stylelint-config-standard": "^38.0.0" + "@stylistic/stylelint-plugin": "^4.0.0", + "stylelint": "^16.26.1", + "stylelint-config-standard": "^39.0.1" } }, "node_modules/@babel/code-frame": { @@ -38,6 +38,30 @@ "node": ">=6.9.0" } }, + "node_modules/@cacheable/memory": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@cacheable/memory/-/memory-2.0.5.tgz", + "integrity": "sha512-fkiAxCvssEyJZ5fxX4tcdZFRmW9JehSTGvvqmXn6rTzG5cH6V/3C4ad8yb01vOjp2xBydHkHrgpW0qeGtzt6VQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cacheable/utils": "^2.3.0", + "@keyv/bigmap": "^1.1.0", + "hookified": "^1.12.2", + "keyv": "^5.5.4" + } + }, + "node_modules/@cacheable/utils": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/@cacheable/utils/-/utils-2.3.1.tgz", + "integrity": "sha512-38NJXjIr4W1Sghun8ju+uYWD8h2c61B4dKwfnQHVDFpAJ9oS28RpfqZQJ6Dgd3RceGkILDY9YT+72HJR3LoeSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "hashery": "^1.2.0", + "keyv": "^5.5.4" + } + }, "node_modules/@csstools/css-parser-algorithms": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", @@ -54,6 +78,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -61,6 +86,26 @@ "@csstools/css-tokenizer": "^3.0.4" } }, + "node_modules/@csstools/css-syntax-patches-for-csstree": { + "version": "1.0.22", + "resolved": "https://registry.npmjs.org/@csstools/css-syntax-patches-for-csstree/-/css-syntax-patches-for-csstree-1.0.22.tgz", + "integrity": "sha512-qBcx6zYlhleiFfdtzkRgwNC7VVoAwfK76Vmsw5t+PbvtdknO9StgRk7ROvq9so1iqbdW4uLIDAsXRsTfUrIoOw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, "node_modules/@csstools/css-tokenizer": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", @@ -77,6 +122,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" } @@ -129,26 +175,40 @@ } }, "node_modules/@dual-bundle/import-meta-resolve": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/@dual-bundle/import-meta-resolve/-/import-meta-resolve-4.1.0.tgz", - "integrity": "sha512-+nxncfwHM5SgAtrVzgpzJOI1ol0PkumhVo469KCf9lUi21IGcY90G98VuHm9VRrUypmAzawAHO9bs6hqeADaVg==", + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/@dual-bundle/import-meta-resolve/-/import-meta-resolve-4.2.1.tgz", + "integrity": "sha512-id+7YRUgoUX6CgV0DtuhirQWodeeA7Lf4i2x71JS/vtA5pRb/hIGWlw+G6MeXvsM+MXrz0VAydTGElX1rAfgPg==", "dev": true, "license": "MIT", "funding": { "type": "github", - "url": "https://github.com/sponsors/wooorm" + "url": "https://github.com/sponsors/JounQin" } }, - "node_modules/@keyv/serialize": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@keyv/serialize/-/serialize-1.0.3.tgz", - "integrity": "sha512-qnEovoOp5Np2JDGonIDL6Ayihw0RhnRh6vxPuHo4RDn1UOzwEo4AeIfpL6UGIrsceWrCMiVPgwRjbHu4vYFc3g==", + "node_modules/@keyv/bigmap": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@keyv/bigmap/-/bigmap-1.3.0.tgz", + "integrity": "sha512-KT01GjzV6AQD5+IYrcpoYLkCu1Jod3nau1Z7EsEuViO3TZGRacSbO9MfHmbJ1WaOXFtWLxPVj169cn2WNKPkIg==", "dev": true, "license": "MIT", "dependencies": { - "buffer": "^6.0.3" + "hashery": "^1.2.0", + "hookified": "^1.13.0" + }, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "keyv": "^5.5.4" } }, + "node_modules/@keyv/serialize": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@keyv/serialize/-/serialize-1.1.1.tgz", + "integrity": "sha512-dXn3FZhPv0US+7dtJsIi2R+c7qWYiReoEh5zUntWCf4oSpMNib8FDhSoed6m3QyZdx5hK7iLFkYk3rNxwt8vTA==", + "dev": true, + "license": "MIT" + }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -188,18 +248,17 @@ } }, "node_modules/@stylistic/stylelint-plugin": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/@stylistic/stylelint-plugin/-/stylelint-plugin-3.1.3.tgz", - "integrity": "sha512-85fsmzgsIVmyG3/GFrjuYj6Cz8rAM7IZiPiXCMiSMfoDOC1lOrzrXPDk24WqviAghnPqGpx8b0caK2PuewWGFg==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@stylistic/stylelint-plugin/-/stylelint-plugin-4.0.0.tgz", + "integrity": "sha512-CFwt3K4Y/7bygNCLCQ8Sy4Hzgbhxq3BsNW0FIuYxl17HD3ywptm54ocyeiLVRrk5jtz1Zwks7Xr9eiZt8SWHAw==", "dev": true, "license": "MIT", "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.1", - "@csstools/css-tokenizer": "^3.0.1", - "@csstools/media-query-list-parser": "^3.0.1", - "is-plain-object": "^5.0.0", - "postcss": "^8.4.41", - "postcss-selector-parser": "^6.1.2", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3", + "postcss": "^8.5.6", + "postcss-selector-parser": "^7.1.0", "postcss-value-parser": "^4.2.0", "style-search": "^0.1.0" }, @@ -207,45 +266,7 @@ "node": "^18.12 || >=20.9" }, "peerDependencies": { - "stylelint": "^16.8.0" - } - }, - "node_modules/@stylistic/stylelint-plugin/node_modules/@csstools/media-query-list-parser": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-3.0.1.tgz", - "integrity": "sha512-HNo8gGD02kHmcbX6PvCoUuOQvn4szyB9ca63vZHKX5A81QytgDG4oxG4IaEfHTlEZSZ6MjPEMWIVU+zF2PZcgw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.1", - "@csstools/css-tokenizer": "^3.0.1" - } - }, - "node_modules/@stylistic/stylelint-plugin/node_modules/postcss-selector-parser": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", - "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" + "stylelint": "^16.22.0" } }, "node_modules/ajv": { @@ -325,27 +346,6 @@ "dev": true, "license": "MIT" }, - "node_modules/base64-js": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", - "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, "node_modules/braces": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", @@ -359,40 +359,18 @@ "node": ">=8" } }, - "node_modules/buffer": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, "node_modules/cacheable": { - "version": "1.10.1", - "resolved": "https://registry.npmjs.org/cacheable/-/cacheable-1.10.1.tgz", - "integrity": "sha512-Fa2BZY0CS9F0PFc/6aVA6tgpOdw+hmv9dkZOlHXII5v5Hw+meJBIWDcPrG9q/dXxGcNbym5t77fzmawrBQfTmQ==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/cacheable/-/cacheable-2.2.0.tgz", + "integrity": "sha512-LEJxRqfeomiiRd2t0uON6hxAtgOoWDfY3fugebbz+J3vDLO+SkdfFChQcOHTZhj9SYa9iwE9MGYNX72dKiOE4w==", "dev": true, "license": "MIT", "dependencies": { - "hookified": "^1.10.0", - "keyv": "^5.3.4" + "@cacheable/memory": "^2.0.5", + "@cacheable/utils": "^2.3.0", + "hookified": "^1.13.0", + "keyv": "^5.5.4", + "qified": "^0.5.2" } }, "node_modules/callsites": { @@ -497,9 +475,9 @@ } }, "node_modules/debug": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz", - "integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==", + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "dev": true, "license": "MIT", "dependencies": { @@ -616,13 +594,13 @@ } }, "node_modules/file-entry-cache": { - "version": "10.1.1", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-10.1.1.tgz", - "integrity": "sha512-zcmsHjg2B2zjuBgjdnB+9q0+cWcgWfykIcsDkWDB4GTPtl1eXUA+gTI6sO0u01AqK3cliHryTU55/b2Ow1hfZg==", + "version": "11.1.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-11.1.1.tgz", + "integrity": "sha512-TPVFSDE7q91Dlk1xpFLvFllf8r0HyOMOlnWy7Z2HBku5H3KhIeOGInexrIeg2D64DosVB/JXkrrk6N/7Wriq4A==", "dev": true, "license": "MIT", "dependencies": { - "flat-cache": "^6.1.10" + "flat-cache": "^6.1.19" } }, "node_modules/fill-range": { @@ -639,15 +617,15 @@ } }, "node_modules/flat-cache": { - "version": "6.1.11", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-6.1.11.tgz", - "integrity": "sha512-zfOAns94mp7bHG/vCn9Ru2eDCmIxVQ5dELUHKjHfDEOJmHNzE+uGa6208kfkgmtym4a0FFjEuFksCXFacbVhSg==", + "version": "6.1.19", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-6.1.19.tgz", + "integrity": "sha512-l/K33newPTZMTGAnnzaiqSl6NnH7Namh8jBNjrgjprWxGmZUuxx/sJNIRaijOh3n7q7ESbhNZC+pvVZMFdeU4A==", "dev": true, "license": "MIT", "dependencies": { - "cacheable": "^1.10.1", + "cacheable": "^2.2.0", "flatted": "^3.3.3", - "hookified": "^1.10.0" + "hookified": "^1.13.0" } }, "node_modules/flatted": { @@ -746,10 +724,23 @@ "node": ">=8" } }, + "node_modules/hashery": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/hashery/-/hashery-1.2.0.tgz", + "integrity": "sha512-43XJKpwle72Ik5Zpam7MuzRWyNdwwdf6XHlh8wCj2PggvWf+v/Dm5B0dxGZOmddidgeO6Ofu9As/o231Ti/9PA==", + "dev": true, + "license": "MIT", + "dependencies": { + "hookified": "^1.13.0" + }, + "engines": { + "node": ">=20" + } + }, "node_modules/hookified": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/hookified/-/hookified-1.10.0.tgz", - "integrity": "sha512-dJw0492Iddsj56U1JsSTm9E/0B/29a1AuoSLRAte8vQg/kaTGF3IgjEWT8c8yG4cC10+HisE1x5QAwR0Xwc+DA==", + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/hookified/-/hookified-1.13.0.tgz", + "integrity": "sha512-6sPYUY8olshgM/1LDNW4QZQN0IqgKhtl/1C8koNZBJrKLBk3AZl6chQtNwpNztvfiApHMEwMHek5rv993PRbWw==", "dev": true, "license": "MIT" }, @@ -766,27 +757,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/ieee754": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", - "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "BSD-3-Clause" - }, "node_modules/ignore": { "version": "7.0.5", "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz", @@ -916,9 +886,9 @@ "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", "dev": true, "license": "MIT", "dependencies": { @@ -943,13 +913,14 @@ "license": "MIT" }, "node_modules/keyv": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-5.3.4.tgz", - "integrity": "sha512-ypEvQvInNpUe+u+w8BIcPkQvEqXquyyibWE/1NB5T2BTzIpS5cGEV1LZskDzPSTvNAaT4+5FutvzlvnkxOSKlw==", + "version": "5.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-5.5.4.tgz", + "integrity": "sha512-eohl3hKTiVyD1ilYdw9T0OiB4hnjef89e3dMYKz+mVKDzj+5IteTseASUsOB+EU9Tf6VNTCjDePcP6wkDGmLKQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { - "@keyv/serialize": "^1.0.3" + "@keyv/serialize": "^1.1.1" } }, "node_modules/kind-of": { @@ -1156,6 +1127,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -1205,6 +1177,7 @@ "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -1220,6 +1193,19 @@ "dev": true, "license": "MIT" }, + "node_modules/qified": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/qified/-/qified-0.5.2.tgz", + "integrity": "sha512-7gJ6mxcQb9vUBOtbKm5mDevbe2uRcOEVp1g4gb/Q+oLntB3HY8eBhOYRxFI2mlDFlY1e4DOSCptzxarXRvzxCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "hookified": "^1.13.0" + }, + "engines": { + "node": ">=20" + } + }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -1383,9 +1369,9 @@ "license": "ISC" }, "node_modules/stylelint": { - "version": "16.21.1", - "resolved": "https://registry.npmjs.org/stylelint/-/stylelint-16.21.1.tgz", - "integrity": "sha512-WCXdXnYK2tpCbebgMF0Bme3YZH/Rh/UXerj75twYo4uLULlcrLwFVdZTvTEF8idFnAcW21YUDJFyKOfaf6xJRw==", + "version": "16.26.1", + "resolved": "https://registry.npmjs.org/stylelint/-/stylelint-16.26.1.tgz", + "integrity": "sha512-v20V59/crfc8sVTAtge0mdafI3AdnzQ2KsWe6v523L4OA1bJO02S7MO2oyXDCS6iWb9ckIPnqAFVItqSBQr7jw==", "dev": true, "funding": [ { @@ -1398,21 +1384,23 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-syntax-patches-for-csstree": "^1.0.19", "@csstools/css-tokenizer": "^3.0.4", "@csstools/media-query-list-parser": "^4.0.3", "@csstools/selector-specificity": "^5.0.0", - "@dual-bundle/import-meta-resolve": "^4.1.0", + "@dual-bundle/import-meta-resolve": "^4.2.1", "balanced-match": "^2.0.0", "colord": "^2.9.3", "cosmiconfig": "^9.0.0", "css-functions-list": "^3.2.3", "css-tree": "^3.1.0", - "debug": "^4.4.1", + "debug": "^4.4.3", "fast-glob": "^3.3.3", "fastest-levenshtein": "^1.0.16", - "file-entry-cache": "^10.1.1", + "file-entry-cache": "^11.1.1", "global-modules": "^2.0.0", "globby": "^11.1.0", "globjoin": "^0.1.4", @@ -1446,9 +1434,9 @@ } }, "node_modules/stylelint-config-recommended": { - "version": "16.0.0", - "resolved": "https://registry.npmjs.org/stylelint-config-recommended/-/stylelint-config-recommended-16.0.0.tgz", - "integrity": "sha512-4RSmPjQegF34wNcK1e1O3Uz91HN8P1aFdFzio90wNK9mjgAI19u5vsU868cVZboKzCaa5XbpvtTzAAGQAxpcXA==", + "version": "17.0.0", + "resolved": "https://registry.npmjs.org/stylelint-config-recommended/-/stylelint-config-recommended-17.0.0.tgz", + "integrity": "sha512-WaMSdEiPfZTSFVoYmJbxorJfA610O0tlYuU2aEwY33UQhSPgFbClrVJYWvy3jGJx+XW37O+LyNLiZOEXhKhJmA==", "dev": true, "funding": [ { @@ -1465,13 +1453,13 @@ "node": ">=18.12.0" }, "peerDependencies": { - "stylelint": "^16.16.0" + "stylelint": "^16.23.0" } }, "node_modules/stylelint-config-standard": { - "version": "38.0.0", - "resolved": "https://registry.npmjs.org/stylelint-config-standard/-/stylelint-config-standard-38.0.0.tgz", - "integrity": "sha512-uj3JIX+dpFseqd/DJx8Gy3PcRAJhlEZ2IrlFOc4LUxBX/PNMEQ198x7LCOE2Q5oT9Vw8nyc4CIL78xSqPr6iag==", + "version": "39.0.1", + "resolved": "https://registry.npmjs.org/stylelint-config-standard/-/stylelint-config-standard-39.0.1.tgz", + "integrity": "sha512-b7Fja59EYHRNOTa3aXiuWnhUWXFU2Nfg6h61bLfAb5GS5fX3LMUD0U5t4S8N/4tpHQg3Acs2UVPR9jy2l1g/3A==", "dev": true, "funding": [ { @@ -1485,13 +1473,13 @@ ], "license": "MIT", "dependencies": { - "stylelint-config-recommended": "^16.0.0" + "stylelint-config-recommended": "^17.0.0" }, "engines": { "node": ">=18.12.0" }, "peerDependencies": { - "stylelint": "^16.18.0" + "stylelint": "^16.23.0" } }, "node_modules/supports-color": { diff --git a/devTools/package.json b/devTools/package.json index 334dd08acf..6791ae887b 100644 --- a/devTools/package.json +++ b/devTools/package.json @@ -6,8 +6,8 @@ "lint:css:fix": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix" }, "devDependencies": { - "@stylistic/stylelint-plugin": "^3.1.3", - "stylelint": "^16.21.1", - "stylelint-config-standard": "^38.0.0" + "@stylistic/stylelint-plugin": "^4.0.0", + "stylelint": "^16.26.1", + "stylelint-config-standard": "^39.0.1" } } diff --git a/docker/Dockerfile.unified b/docker/Dockerfile.unified index 0ba7cfb3c2..2968f569ce 100644 --- a/docker/Dockerfile.unified +++ b/docker/Dockerfile.unified @@ -105,6 +105,7 @@ RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/a gcompat \ libc6-compat \ libreoffice \ + imagemagick \ # pdftohtml poppler-utils \ # OCR MY PDF diff --git a/docker/backend/Dockerfile b/docker/backend/Dockerfile index f2421fa943..cdb7beb78e 100644 --- a/docker/backend/Dockerfile +++ b/docker/backend/Dockerfile @@ -1,5 +1,11 @@ -# Backend Dockerfile - Java Spring Boot with all dependencies and build stage -# Build the application +# ============================================================================== +# Multi-stage Dockerfile for Stirling-PDF – image with everything included +# Includes: LibreOffice, Calibre, Tesseract, OCRmyPDF, unoserver, WeasyPrint, etc. +# ============================================================================== + +# ======================================== +# STAGE 1: Build stage - Alpine with Gradle +# ======================================== FROM gradle:8.14-jdk21 AS build COPY build.gradle . @@ -22,13 +28,87 @@ RUN DISABLE_ADDITIONAL_FEATURES=false \ STIRLING_PDF_DESKTOP_UI=false \ ./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube -# Main stage -FROM alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1 +# ======================================== +# STAGE 2: Runtime image based on Debian stable-slim +# Contains Java runtime + LibreOffice + Calibre + all PDF tools +# ======================================== +FROM debian:stable-slim@sha256:7cb087f19bcc175b96fbe4c2aef42ed00733a659581a80f6ebccfd8fe3185a3d -# Copy necessary files -COPY scripts /scripts -COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/ +SHELL ["/bin/bash", "-o", "pipefail", "-c"] +ENV DEBIAN_FRONTEND=noninteractive +ENV TESS_BASE_PATH=/usr/share/tesseract-ocr/5/tessdata + +# Install core runtime dependencies + tools required by Stirling-PDF features +RUN apt-get update && apt-get install -y --no-install-recommends \ + ca-certificates tzdata tini bash fontconfig \ + openjdk-21-jre-headless \ + ffmpeg poppler-utils ocrmypdf \ + libreoffice-nogui libreoffice-java-common \ + python3 python3-venv python3-uno \ + tesseract-ocr tesseract-ocr-eng tesseract-ocr-deu tesseract-ocr-fra \ + tesseract-ocr-por tesseract-ocr-chi-sim \ + libcairo2 libpango-1.0-0 libpangoft2-1.0-0 libgdk-pixbuf-2.0-0 \ + gosu unpaper \ + # AWT headless support (required for some Java graphics operations) + libfreetype6 libfontconfig1 libx11-6 libxt6 libxext6 libxrender1 libxtst6 libxi6 \ + libxinerama1 libxkbcommon0 libxkbfile1 libsm6 libice6 \ + # Qt WebEngine dependencies for Calibre + libegl1 libopengl0 libgl1 libxdamage1 libxfixes3 libxshmfence1 libdrm2 libgbm1 \ + libxkbcommon-x11-0 libxrandr2 libxcomposite1 libnss3 libx11-xcb1 \ + libxcb-cursor0 libdbus-1-3 libglib2.0-0 \ + # Virtual framebuffer (required for headless LibreOffice) + xvfb x11-utils coreutils \ + # Temporary packages only needed for Calibre installer + xz-utils gpgv curl xdg-utils \ + \ + # Install Calibre from official installer script + && curl -fsSL https://download.calibre-ebook.com/linux-installer.sh | sh /dev/stdin \ + \ + # Clean up installer-only packages + && apt-get purge -y xz-utils gpgv xdg-utils \ + && apt-get autoremove -y \ + && rm -rf /var/lib/apt/lists/* + +# Make ebook-convert available in PATH +RUN ln -sf /opt/calibre/ebook-convert /usr/bin/ebook-convert \ + && /opt/calibre/ebook-convert --version + +# ============================================================================== +# Create non-root user (stirlingpdfuser) with configurable UID/GID +# ============================================================================== +ARG PUID=1000 +ARG PGID=1000 + +RUN set -eux; \ + # Create group if it doesn't exist + if ! getent group stirlingpdfgroup >/dev/null 2>&1; then \ + if getent group "${PGID}" >/dev/null 2>&1; then \ + groupadd -o -g "${PGID}" stirlingpdfgroup; \ + else \ + groupadd -g "${PGID}" stirlingpdfgroup; \ + fi; \ + fi; \ + # Create user if it doesn't exist, avoid UID conflicts + if ! id -u stirlingpdfuser >/dev/null 2>&1; then \ + if getent passwd | awk -F: -v id="${PUID}" '$3==id{found=1} END{exit !found}'; then \ + echo "UID ${PUID} already in use – creating stirlingpdfuser with automatic UID"; \ + useradd -m -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + else \ + useradd -m -u "${PUID}" -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + fi; \ + fi + +# Compatibility alias for older entrypoint scripts expecting su-exec +RUN ln -sf /usr/sbin/gosu /usr/local/bin/su-exec + +# Copy application files from build stage +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/app/core/build/libs/*.jar /app.jar +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/build/libs/restart-helper.jar /restart-helper.jar +COPY scripts/ /scripts/ +COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/truetype/ + +# Optional version tag (can be passed at build time) ARG VERSION_TAG LABEL org.opencontainers.image.title="Stirling-PDF Backend" @@ -43,84 +123,69 @@ LABEL org.opencontainers.image.authors="Stirling-Tools" LABEL org.opencontainers.image.version="${VERSION_TAG}" LABEL org.opencontainers.image.keywords="PDF, manipulation, backend, API, Spring Boot" -# Set Environment Variables +# ============================================================================== +# Runtime environment variables +# ============================================================================== ENV VERSION_TAG=$VERSION_TAG \ - JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \ + DISABLE_ADDITIONAL_FEATURES=true \ + JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 \ + -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 \ + -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70 \ + -Djava.awt.headless=true" \ JAVA_CUSTOM_OPTS="" \ HOME=/home/stirlingpdfuser \ - PUID=1000 \ - PGID=1000 \ + PUID=${PUID} \ + PGID=${PGID} \ UMASK=022 \ - PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \ UNO_PATH=/usr/lib/libreoffice/program \ - URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc \ - PATH=$PATH:/opt/venv/bin \ STIRLING_TEMPFILES_DIRECTORY=/tmp/stirling-pdf \ TMPDIR=/tmp/stirling-pdf \ TEMP=/tmp/stirling-pdf \ TMP=/tmp/stirling-pdf -# JDK for app and all dependencies -RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \ - echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \ - echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \ - apk upgrade --no-cache -a && \ - apk add --no-cache \ - ca-certificates \ - tzdata \ - tini \ - bash \ - curl \ - shadow \ - su-exec \ - openssl \ - openssl-dev \ - openjdk21-jre \ - # Doc conversion - gcompat \ - libc6-compat \ - libreoffice \ - ghostscript \ - fontforge \ - # pdftohtml - poppler-utils \ - # OCR MY PDF (unpaper for descew and other advanced features) - unpaper \ - tesseract-ocr-data-eng \ - tesseract-ocr-data-chi_sim \ - tesseract-ocr-data-deu \ - tesseract-ocr-data-fra \ - tesseract-ocr-data-por \ - ocrmypdf \ - # CV - py3-opencv \ - python3 \ - py3-pip \ - py3-pillow@testing \ - py3-pdf2image@testing && \ - python3 -m venv /opt/venv && \ - /opt/venv/bin/pip install --upgrade pip setuptools && \ - /opt/venv/bin/pip install --no-cache-dir --upgrade unoserver weasyprint && \ - ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \ - mv /usr/share/tessdata /usr/share/tessdata-original && \ - mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf /pipeline/watchedFolders /pipeline/finishedFolders && \ - fc-cache -f -v && \ - chmod +x /scripts/* && \ - chmod +x /scripts/init.sh && \ - # User permissions - addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \ - chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /pipeline /usr/share/fonts/opentype/noto /configs /customFiles /pipeline /tmp/stirling-pdf +# ============================================================================== +# Python virtual environment for additional Python tools (WeasyPrint, OpenCV, etc.) +# ============================================================================== +RUN python3 -m venv /opt/venv --system-site-packages \ + && /opt/venv/bin/pip install --no-cache-dir weasyprint pdf2image opencv-python-headless \ + && /opt/venv/bin/python -c "import cv2; print('OpenCV version:', cv2.__version__)" -# first /app directory is for the build stage, second is for the final image -COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/app/core/build/libs/*.jar /app.jar -COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/build/libs/restart-helper.jar /restart-helper.jar +# Separate venv for unoserver (keeps it isolated) +RUN python3 -m venv /opt/unoserver-venv --system-site-packages \ + && /opt/unoserver-venv/bin/pip install --no-cache-dir unoserver -RUN chown stirlingpdfuser:stirlingpdfgroup /app.jar /restart-helper.jar +# Make unoserver tools available in main venv PATH +RUN ln -sf /opt/unoserver-venv/bin/unoconvert /opt/venv/bin/unoconvert \ + && ln -sf /opt/unoserver-venv/bin/unoserver /opt/venv/bin/unoserver +# Extend PATH to include both virtual environments +ENV PATH="/opt/venv/bin:/opt/unoserver-venv/bin:${PATH}" + +# ============================================================================== +# Final permissions, directories and font cache +# ============================================================================== +RUN set -eux; \ + chmod +x /scripts/*; \ + mkdir -p /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf; \ + chown -R stirlingpdfuser:stirlingpdfgroup \ + /home/stirlingpdfuser /configs /logs /customFiles /pipeline /tmp/stirling-pdf \ + /app.jar /restart-helper.jar /usr/share/fonts/truetype /scripts; \ + chmod -R 755 /tmp/stirling-pdf + +# Rebuild font cache +RUN fc-cache -f -v + +# Force Qt/WebEngine to run headlessly (required for Calibre in Docker) +ENV QT_QPA_PLATFORM=offscreen \ + QTWEBENGINE_CHROMIUM_FLAGS="--disable-gpu --disable-dev-shm-usage" + +# Expose web UI port EXPOSE 8080/tcp -# Set user and run command +STOPSIGNAL SIGTERM + +# Use tini as init (handles signals and zombies correctly) ENTRYPOINT ["tini", "--", "/scripts/init.sh"] -CMD ["sh", "-c", "java -Dfile.encoding=UTF-8 -Djava.io.tmpdir=/tmp/stirling-pdf -jar /app.jar & /opt/venv/bin/unoserver --port 2003 --interface 127.0.0.1"] + +# CMD is empty – actual start command is defined in init.sh +CMD [] diff --git a/docker/backend/Dockerfile.fat b/docker/backend/Dockerfile.fat index c54a162dae..6f512a24c2 100644 --- a/docker/backend/Dockerfile.fat +++ b/docker/backend/Dockerfile.fat @@ -1,5 +1,11 @@ -# Backend fat Dockerfile - Java Spring Boot with all dependencies and build stage -# Build the application +# ============================================================================== +# Multi-stage Dockerfile for Stirling-PDF – "fat" image with everything included +# Includes: LibreOffice, Calibre, Tesseract, OCRmyPDF, unoserver, WeasyPrint, etc. +# ============================================================================== + +# ======================================== +# STAGE 1: Build stage - Gradle +# ======================================== FROM gradle:8.14-jdk21 AS build COPY build.gradle . @@ -22,93 +28,165 @@ RUN DISABLE_ADDITIONAL_FEATURES=false \ STIRLING_PDF_DESKTOP_UI=false \ ./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube -# Main stage -FROM alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1 +# ======================================== +# STAGE 2: Runtime image based on Debian stable-slim +# Contains Java runtime + LibreOffice + Calibre + all PDF tools +# ======================================== +FROM debian:stable-slim@sha256:7cb087f19bcc175b96fbe4c2aef42ed00733a659581a80f6ebccfd8fe3185a3d -# Copy necessary files -COPY scripts /scripts -COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/ -# first /app directory is for the build stage, second is for the final image -COPY --from=build /app/app/core/build/libs/*.jar app.jar -COPY --from=build /app/build/libs/restart-helper.jar restart-helper.jar +SHELL ["/bin/bash", "-o", "pipefail", "-c"] +ENV DEBIAN_FRONTEND=noninteractive +# Install core runtime dependencies + tools required by Stirling-PDF features +RUN apt-get update && apt-get install -y --no-install-recommends \ + ca-certificates tzdata tini bash fontconfig \ + openjdk-21-jre-headless \ + ffmpeg poppler-utils qpdf ghostscript ocrmypdf \ + libreoffice-nogui libreoffice-java-common \ + python3 python3-venv python3-uno \ + tesseract-ocr tesseract-ocr-eng tesseract-ocr-deu tesseract-ocr-fra \ + tesseract-ocr-por tesseract-ocr-chi-sim \ + libcairo2 libpango-1.0-0 libpangoft2-1.0-0 libgdk-pixbuf-2.0-0 \ + gosu unpaper \ + # AWT headless support (required for some Java graphics operations) + libfreetype6 libfontconfig1 libx11-6 libxt6 libxext6 libxrender1 libxtst6 libxi6 \ + libxinerama1 libxkbcommon0 libxkbfile1 libsm6 libice6 \ + # Qt WebEngine dependencies for Calibre + libegl1 libopengl0 libgl1 libxdamage1 libxfixes3 libxshmfence1 libdrm2 libgbm1 \ + libxkbcommon-x11-0 libxrandr2 libxcomposite1 libnss3 libx11-xcb1 \ + libxcb-cursor0 libdbus-1-3 libglib2.0-0 \ + # Virtual framebuffer (required for headless LibreOffice) + xvfb x11-utils coreutils \ + # Temporary packages only needed for Calibre installer + xz-utils gpgv curl xdg-utils \ + \ + # Install Calibre from official installer script + && curl -fsSL https://download.calibre-ebook.com/linux-installer.sh | sh /dev/stdin \ + \ + # Clean up installer-only packages + && apt-get purge -y xz-utils gpgv xdg-utils \ + && apt-get autoremove -y \ + && rm -rf /var/lib/apt/lists/* + +# Make ebook-convert available in PATH +RUN ln -sf /opt/calibre/ebook-convert /usr/bin/ebook-convert \ + && /opt/calibre/ebook-convert --version + +# ============================================================================== +# Create non-root user (stirlingpdfuser) with configurable UID/GID +# ============================================================================== +ARG PUID=1000 +ARG PGID=1000 + +RUN set -eux; \ + # Create group if it doesn't exist + if ! getent group stirlingpdfgroup >/dev/null 2>&1; then \ + if getent group "${PGID}" >/dev/null 2>&1; then \ + groupadd -o -g "${PGID}" stirlingpdfgroup; \ + else \ + groupadd -g "${PGID}" stirlingpdfgroup; \ + fi; \ + fi; \ + # Create user if it doesn't exist, avoid UID conflicts + if ! id -u stirlingpdfuser >/dev/null 2>&1; then \ + if getent passwd | awk -F: -v id="${PUID}" '$3==id{found=1} END{exit !found}'; then \ + echo "UID ${PUID} already in use – creating stirlingpdfuser with automatic UID"; \ + useradd -m -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + else \ + useradd -m -u "${PUID}" -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + fi; \ + fi + +# Compatibility alias for older entrypoint scripts expecting su-exec +RUN ln -sf /usr/sbin/gosu /usr/local/bin/su-exec + +# Copy application files from build stage +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/app/core/build/libs/*.jar /app.jar +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/build/libs/restart-helper.jar /restart-helper.jar +COPY scripts/ /scripts/ +COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/truetype/ + +# Optional version tag (can be passed at build time) ARG VERSION_TAG -# Set Environment Variables +# Metadata labels +LABEL org.opencontainers.image.title="Stirling-PDF" +LABEL org.opencontainers.image.description="A powerful locally hosted web-based PDF manipulation tool supporting 50+ operations including merging, splitting, conversion, OCR, watermarking, and more." +LABEL org.opencontainers.image.source="https://github.com/Stirling-Tools/Stirling-PDF" +LABEL org.opencontainers.image.licenses="MIT" +LABEL org.opencontainers.image.vendor="Stirling-Tools" +LABEL org.opencontainers.image.url="https://www.stirlingpdf.com" +LABEL org.opencontainers.image.documentation="https://docs.stirlingpdf.com" +LABEL maintainer="Stirling-Tools" +LABEL org.opencontainers.image.authors="Stirling-Tools" +LABEL org.opencontainers.image.version="${VERSION_TAG}" +LABEL org.opencontainers.image.keywords="PDF, manipulation, merge, split, convert, OCR, watermark" + +# ============================================================================== +# Runtime environment variables +# ============================================================================== ENV VERSION_TAG=$VERSION_TAG \ - JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \ + DISABLE_ADDITIONAL_FEATURES=true \ + JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 \ + -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 \ + -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70 \ + -Djava.awt.headless=true" \ JAVA_CUSTOM_OPTS="" \ HOME=/home/stirlingpdfuser \ - PUID=1000 \ - PGID=1000 \ + PUID=${PUID} \ + PGID=${PGID} \ UMASK=022 \ FAT_DOCKER=true \ INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \ - PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \ UNO_PATH=/usr/lib/libreoffice/program \ - URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc \ - PATH=$PATH:/opt/venv/bin \ STIRLING_TEMPFILES_DIRECTORY=/tmp/stirling-pdf \ TMPDIR=/tmp/stirling-pdf \ TEMP=/tmp/stirling-pdf \ TMP=/tmp/stirling-pdf -# JDK for app -RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \ - echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \ - echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \ - apk upgrade --no-cache -a && \ - apk add --no-cache \ - ca-certificates \ - tzdata \ - tini \ - bash \ - curl \ - shadow \ - su-exec \ - openssl \ - openssl-dev \ - openjdk21-jre \ - # Doc conversion - gcompat \ - libc6-compat \ - libreoffice \ - ghostscript \ - fontforge \ - # pdftohtml - poppler-utils \ - # OCR MY PDF (unpaper for descew and other advanced featues) - unpaper \ - tesseract-ocr-data-eng \ - tesseract-ocr-data-chi_sim \ - tesseract-ocr-data-deu \ - tesseract-ocr-data-fra \ - tesseract-ocr-data-por \ - ocrmypdf \ - font-terminus font-dejavu font-noto font-noto-cjk font-awesome font-noto-extra font-liberation font-linux-libertine \ - # CV - py3-opencv \ - python3 \ - py3-pip \ - py3-pillow@testing \ - py3-pdf2image@testing && \ - python3 -m venv /opt/venv && \ - /opt/venv/bin/pip install --upgrade pip setuptools && \ - /opt/venv/bin/pip install --no-cache-dir --upgrade unoserver weasyprint && \ - ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \ - mv /usr/share/tessdata /usr/share/tessdata-original && \ - mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf /pipeline/watchedFolders /pipeline/finishedFolders && \ - fc-cache -f -v && \ - chmod +x /scripts/* && \ - chmod +x /scripts/init.sh && \ - # User permissions - addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \ - chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /pipeline /usr/share/fonts/opentype/noto /configs /customFiles /pipeline /tmp/stirling-pdf && \ - chown stirlingpdfuser:stirlingpdfgroup /app.jar /restart-helper.jar +# ============================================================================== +# Python virtual environment for additional Python tools (WeasyPrint, OpenCV, etc.) +# ============================================================================== +RUN python3 -m venv /opt/venv --system-site-packages \ + && /opt/venv/bin/pip install --no-cache-dir weasyprint pdf2image opencv-python-headless \ + && /opt/venv/bin/python -c "import cv2; print('OpenCV version:', cv2.__version__)" +# Separate venv for unoserver (keeps it isolated) +RUN python3 -m venv /opt/unoserver-venv --system-site-packages \ + && /opt/unoserver-venv/bin/pip install --no-cache-dir unoserver + +# Make unoserver tools available in main venv PATH +RUN ln -sf /opt/unoserver-venv/bin/unoconvert /opt/venv/bin/unoconvert \ + && ln -sf /opt/unoserver-venv/bin/unoserver /opt/venv/bin/unoserver + +# Extend PATH to include both virtual environments +ENV PATH="/opt/venv/bin:/opt/unoserver-venv/bin:${PATH}" + +# ============================================================================== +# Final permissions, directories and font cache +# ============================================================================== +RUN set -eux; \ + chmod +x /scripts/*; \ + mkdir -p /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf; \ + chown -R stirlingpdfuser:stirlingpdfgroup \ + /home/stirlingpdfuser /configs /logs /customFiles /pipeline /tmp/stirling-pdf \ + /app.jar /restart-helper.jar /usr/share/fonts/truetype /scripts; \ + chmod -R 755 /tmp/stirling-pdf + +# Rebuild font cache +RUN fc-cache -f -v + +# Force Qt/WebEngine to run headlessly (required for Calibre in Docker) +ENV QT_QPA_PLATFORM=offscreen \ + QTWEBENGINE_CHROMIUM_FLAGS="--disable-gpu --disable-dev-shm-usage" + +# Expose web UI port EXPOSE 8080/tcp -# Set user and run command + +STOPSIGNAL SIGTERM + +# Use tini as init (handles signals and zombies correctly) ENTRYPOINT ["tini", "--", "/scripts/init.sh"] -CMD ["sh", "-c", "java -Dfile.encoding=UTF-8 -Djava.io.tmpdir=/tmp/stirling-pdf -jar /app.jar & /opt/venv/bin/unoserver --port 2003 --interface 127.0.0.1"] + +# CMD is empty – actual start command is defined in init.sh +CMD [] diff --git a/docker/backend/Dockerfile.ultra-lite b/docker/backend/Dockerfile.ultra-lite index ec5ae17c69..8035868be8 100644 --- a/docker/backend/Dockerfile.ultra-lite +++ b/docker/backend/Dockerfile.ultra-lite @@ -1,5 +1,7 @@ # Backend ultra-lite Dockerfile - Java Spring Boot with minimal dependencies and build stage -# Build the application +# ======================================== +# STAGE 1: Build stage - Gradle +# ======================================== FROM gradle:8.14-jdk21 AS build COPY build.gradle . @@ -22,8 +24,10 @@ RUN DISABLE_ADDITIONAL_FEATURES=true \ STIRLING_PDF_DESKTOP_UI=false \ ./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube -# Main stage -FROM alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1 +# ======================================== +# STAGE 2: Runtime stage - Alpine minimal +# ======================================== +FROM alpine:3.22.2@sha256:4b7ce07002c69e8f3d704a9c5d6fd3053be500b7f1c69fc0d80990c2ad8dd412 ARG VERSION_TAG @@ -43,13 +47,17 @@ ENV HOME=/home/stirlingpdfuser \ # Copy necessary files COPY scripts/init-without-ocr.sh /scripts/init-without-ocr.sh COPY scripts/installFonts.sh /scripts/installFonts.sh -COPY --from=build /app/app/core/build/libs/*.jar app.jar -COPY --from=build /app/build/libs/restart-helper.jar restart-helper.jar +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/app/core/build/libs/*.jar /app.jar +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/build/libs/restart-helper.jar /restart-helper.jar # Set up necessary directories and permissions -RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \ - echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \ - echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \ +RUN apk add --no-cache bash \ + && ln -sf /bin/bash /bin/sh \ + && printf '%s\n' \ + 'https://dl-cdn.alpinelinux.org/alpine/edge/main' \ + 'https://dl-cdn.alpinelinux.org/alpine/edge/community' \ + 'https://dl-cdn.alpinelinux.org/alpine/edge/testing' \ + > /etc/apk/repositories && \ apk upgrade --no-cache -a && \ apk add --no-cache \ ca-certificates \ @@ -67,7 +75,8 @@ RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /et chmod +x /scripts/*.sh && \ addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \ chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /pipeline /configs /customFiles /pipeline /tmp/stirling-pdf && \ - chown stirlingpdfuser:stirlingpdfgroup /app.jar /restart-helper.jar + chown stirlingpdfuser:stirlingpdfgroup /app.jar /restart-helper.jar && \ + ln -sf /bin/busybox /bin/sh # Set environment variables ENV ENDPOINTS_GROUPS_TO_REMOVE=CLI @@ -76,4 +85,4 @@ EXPOSE 8080/tcp # Run the application ENTRYPOINT ["tini", "--", "/scripts/init-without-ocr.sh"] -CMD ["java", "-Dfile.encoding=UTF-8", "-Djava.io.tmpdir=/tmp/stirling-pdf", "-jar", "/app.jar"] +CMD [] diff --git a/docker/compose/docker-compose.ultra-lite.yml b/docker/compose/docker-compose.ultra-lite.yml index 0639b53aca..0b11bd75eb 100644 --- a/docker/compose/docker-compose.ultra-lite.yml +++ b/docker/compose/docker-compose.ultra-lite.yml @@ -54,4 +54,4 @@ services: networks: stirling-network: - driver: bridge \ No newline at end of file + driver: bridge diff --git a/docker/embedded/Dockerfile b/docker/embedded/Dockerfile index a38aee9b4a..12067bc7a8 100644 --- a/docker/embedded/Dockerfile +++ b/docker/embedded/Dockerfile @@ -35,14 +35,90 @@ RUN DISABLE_ADDITIONAL_FEATURES=false \ STIRLING_PDF_DESKTOP_UI=false \ ./gradlew clean build -PbuildWithFrontend=true -x spotlessApply -x spotlessCheck -x test -x sonarqube -# Stage 2: Runtime image -FROM alpine:3.22.1 +# Stage 2: Runtime image based on Debian stable-slim +# Contains Java runtime + LibreOffice + Calibre + all PDF tools +FROM debian:stable-slim@sha256:1c25564b03942d874bf6a2b71f2062b71af8bc1475aa873c523e6f7c8fa29e60 +SHELL ["/bin/bash", "-o", "pipefail", "-c"] +ENV DEBIAN_FRONTEND=noninteractive + +ENV TESS_BASE_PATH=/usr/share/tesseract-ocr/5/tessdata + +# Install core runtime dependencies + tools required by Stirling-PDF features +RUN apt-get update && apt-get install -y --no-install-recommends \ + ca-certificates tzdata tini bash fontconfig \ + openjdk-21-jre-headless \ + ffmpeg poppler-utils ocrmypdf imagemagick fontforge ghostscript \ + libreoffice-nogui libreoffice-java-common \ + python3 python3-venv python3-uno \ + tesseract-ocr tesseract-ocr-eng tesseract-ocr-deu tesseract-ocr-fra \ + tesseract-ocr-por tesseract-ocr-chi-sim \ + libcairo2 libpango-1.0-0 libpangoft2-1.0-0 libgdk-pixbuf-2.0-0 \ + gosu unpaper \ + # AWT headless support (required for some Java graphics operations) + libfreetype6 libfontconfig1 libx11-6 libxt6 libxext6 libxrender1 libxtst6 libxi6 \ + libxinerama1 libxkbcommon0 libxkbfile1 libsm6 libice6 \ + # Qt WebEngine dependencies for Calibre + libegl1 libopengl0 libgl1 libxdamage1 libxfixes3 libxshmfence1 libdrm2 libgbm1 \ + libxkbcommon-x11-0 libxrandr2 libxcomposite1 libnss3 libx11-xcb1 \ + libxcb-cursor0 libdbus-1-3 libglib2.0-0 \ + # Virtual framebuffer (required for headless LibreOffice) + xvfb x11-utils coreutils \ + # Temporary packages only needed for Calibre installer + xz-utils gpgv curl xdg-utils \ + \ + # Install Calibre from official installer script + && curl -fsSL https://download.calibre-ebook.com/linux-installer.sh | sh /dev/stdin \ + \ + # Clean up installer-only packages + && apt-get purge -y xz-utils gpgv xdg-utils \ + && apt-get autoremove -y \ + && rm -rf /var/lib/apt/lists/* + +# Make ebook-convert available in PATH +RUN ln -sf /opt/calibre/ebook-convert /usr/bin/ebook-convert \ + && /opt/calibre/ebook-convert --version + +# ============================================================================== +# Create non-root user (stirlingpdfuser) with configurable UID/GID +# ============================================================================== +ARG PUID=1000 +ARG PGID=1000 + +RUN set -eux; \ + # Create group if it doesn't exist + if ! getent group stirlingpdfgroup >/dev/null 2>&1; then \ + if getent group "${PGID}" >/dev/null 2>&1; then \ + groupadd -o -g "${PGID}" stirlingpdfgroup; \ + else \ + groupadd -g "${PGID}" stirlingpdfgroup; \ + fi; \ + fi; \ + # Create user if it doesn't exist, avoid UID conflicts + if ! id -u stirlingpdfuser >/dev/null 2>&1; then \ + if getent passwd | awk -F: -v id="${PUID}" '$3==id{found=1} END{exit !found}'; then \ + echo "UID ${PUID} already in use – creating stirlingpdfuser with automatic UID"; \ + useradd -m -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + else \ + useradd -m -u "${PUID}" -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + fi; \ + fi + +# Compatibility alias for older entrypoint scripts expecting su-exec +RUN ln -sf /usr/sbin/gosu /usr/local/bin/su-exec + +# Copy application files from build stage +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/app/core/build/libs/*.jar /app.jar +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/build/libs/restart-helper.jar /restart-helper.jar +COPY scripts/ /scripts/ +COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/truetype/ + +# Optional version tag (can be passed at build time) ARG VERSION_TAG -# Labels +# Metadata labels LABEL org.opencontainers.image.title="Stirling-PDF" -LABEL org.opencontainers.image.description="Stirling-PDF with embedded frontend - Full version" +LABEL org.opencontainers.image.description="Stirling-PDF with embedded frontend - Full version with Calibre, LibreOffice, Tesseract, OCRmyPDF, and more" LABEL org.opencontainers.image.source="https://github.com/Stirling-Tools/Stirling-PDF" LABEL org.opencontainers.image.licenses="MIT" LABEL org.opencontainers.image.vendor="Stirling-Tools" @@ -53,86 +129,65 @@ LABEL org.opencontainers.image.authors="Stirling-Tools" LABEL org.opencontainers.image.version="${VERSION_TAG}" LABEL org.opencontainers.image.keywords="PDF, manipulation, API, Spring Boot, React" -# Copy scripts and fonts -COPY scripts /scripts -COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/ - -# Copy built JAR from build stage -COPY --from=build /app/app/core/build/libs/*.jar /app.jar -COPY --from=build /app/build/libs/restart-helper.jar /restart-helper.jar - -# Environment Variables +# ============================================================================== +# Runtime environment variables +# ============================================================================== ENV VERSION_TAG=$VERSION_TAG \ - JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \ + JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70 -Djava.awt.headless=true" \ JAVA_CUSTOM_OPTS="" \ HOME=/home/stirlingpdfuser \ - PUID=1000 \ - PGID=1000 \ + PUID=${PUID} \ + PGID=${PGID} \ UMASK=022 \ - PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \ UNO_PATH=/usr/lib/libreoffice/program \ - URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc \ - PATH=$PATH:/opt/venv/bin \ STIRLING_TEMPFILES_DIRECTORY=/tmp/stirling-pdf \ TMPDIR=/tmp/stirling-pdf \ TEMP=/tmp/stirling-pdf \ TMP=/tmp/stirling-pdf -# Install all dependencies -RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \ - echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \ - echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \ - apk upgrade --no-cache -a && \ - apk add --no-cache \ - ca-certificates \ - tzdata \ - tini \ - bash \ - curl \ - shadow \ - su-exec \ - openssl \ - openssl-dev \ - openjdk21-jre \ - # Doc conversion - gcompat \ - libc6-compat \ - libreoffice \ - ghostscript \ - fontforge \ - # pdftohtml - poppler-utils \ - # OCR MY PDF - unpaper \ - tesseract-ocr-data-eng \ - tesseract-ocr-data-chi_sim \ - tesseract-ocr-data-deu \ - tesseract-ocr-data-fra \ - tesseract-ocr-data-por \ - ocrmypdf \ - # CV - py3-opencv \ - python3 \ - py3-pip \ - py3-pillow@testing \ - py3-pdf2image@testing && \ - python3 -m venv /opt/venv && \ - /opt/venv/bin/pip install --upgrade pip setuptools && \ - /opt/venv/bin/pip install --no-cache-dir --upgrade unoserver weasyprint && \ - ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \ - mv /usr/share/tessdata /usr/share/tessdata-original && \ - mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf && \ - fc-cache -f -v && \ - chmod +x /scripts/* && \ - # User permissions - addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \ - chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /pipeline /usr/share/fonts/opentype/noto /configs /customFiles /tmp/stirling-pdf && \ - chown stirlingpdfuser:stirlingpdfgroup /app.jar /restart-helper.jar +# ============================================================================== +# Python virtual environment for additional Python tools (WeasyPrint, OpenCV, etc.) +# ============================================================================== +RUN python3 -m venv /opt/venv --system-site-packages \ + && /opt/venv/bin/pip install --no-cache-dir weasyprint pdf2image opencv-python-headless \ + && /opt/venv/bin/python -c "import cv2; print('OpenCV version:', cv2.__version__)" +# Separate venv for unoserver (keeps it isolated) +RUN python3 -m venv /opt/unoserver-venv --system-site-packages \ + && /opt/unoserver-venv/bin/pip install --no-cache-dir unoserver + +# Make unoserver tools available in main venv PATH +RUN ln -sf /opt/unoserver-venv/bin/unoconvert /opt/venv/bin/unoconvert \ + && ln -sf /opt/unoserver-venv/bin/unoserver /opt/venv/bin/unoserver + +# Extend PATH to include both virtual environments +ENV PATH="/opt/venv/bin:/opt/unoserver-venv/bin:${PATH}" + +# ============================================================================== +# Final permissions, directories and font cache +# ============================================================================== +RUN set -eux; \ + chmod +x /scripts/*; \ + mkdir -p /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf; \ + chown -R stirlingpdfuser:stirlingpdfgroup \ + /home/stirlingpdfuser /configs /logs /customFiles /pipeline /tmp/stirling-pdf \ + /app.jar /restart-helper.jar /usr/share/fonts/truetype /scripts; \ + chmod -R 755 /tmp/stirling-pdf + +# Rebuild font cache +RUN fc-cache -f -v + +# Force Qt/WebEngine to run headlessly (required for Calibre in Docker) +ENV QT_QPA_PLATFORM=offscreen \ + QTWEBENGINE_CHROMIUM_FLAGS="--disable-gpu --disable-dev-shm-usage" + +# Expose web UI port EXPOSE 8080/tcp -# Set user and run command +STOPSIGNAL SIGTERM + +# Use tini as init (handles signals and zombies correctly) ENTRYPOINT ["tini", "--", "/scripts/init.sh"] -CMD ["sh", "-c", "java -Dfile.encoding=UTF-8 -Djava.io.tmpdir=/tmp/stirling-pdf -jar /app.jar & /opt/venv/bin/unoserver --port 2003 --interface 127.0.0.1"] + +# CMD is empty – actual start command is defined in init.sh +CMD [] diff --git a/docker/embedded/Dockerfile.fat b/docker/embedded/Dockerfile.fat index 67e648aee0..1fe61b67a7 100644 --- a/docker/embedded/Dockerfile.fat +++ b/docker/embedded/Dockerfile.fat @@ -35,14 +35,93 @@ RUN DISABLE_ADDITIONAL_FEATURES=false \ STIRLING_PDF_DESKTOP_UI=false \ ./gradlew clean build -PbuildWithFrontend=true -x spotlessApply -x spotlessCheck -x test -x sonarqube -# Stage 2: Runtime image -FROM alpine:3.22.1 +# Stage 2: Runtime image based on Debian stable-slim +# Contains Java runtime + LibreOffice + Calibre + all PDF tools + extra fonts for air-gapped environments +FROM debian:stable-slim@sha256:1c25564b03942d874bf6a2b71f2062b71af8bc1475aa873c523e6f7c8fa29e60 +SHELL ["/bin/bash", "-o", "pipefail", "-c"] +ENV DEBIAN_FRONTEND=noninteractive + +ENV TESS_BASE_PATH=/usr/share/tesseract-ocr/5/tessdata + +# Install core runtime dependencies + tools required by Stirling-PDF features + extra fonts for fat version +RUN apt-get update && apt-get install -y --no-install-recommends \ + ca-certificates tzdata tini bash fontconfig \ + openjdk-21-jre-headless \ + ffmpeg poppler-utils ocrmypdf imagemagick fontforge ghostscript \ + libreoffice-nogui libreoffice-java-common \ + python3 python3-venv python3-uno \ + tesseract-ocr tesseract-ocr-eng tesseract-ocr-deu tesseract-ocr-fra \ + tesseract-ocr-por tesseract-ocr-chi-sim \ + libcairo2 libpango-1.0-0 libpangoft2-1.0-0 libgdk-pixbuf-2.0-0 \ + gosu unpaper \ + # Extra fonts for fat/air-gapped version + fonts-dejavu fonts-liberation fonts-noto fonts-noto-cjk fonts-noto-color-emoji \ + fonts-freefont-ttf fonts-terminus fonts-linuxlibertine \ + # AWT headless support (required for some Java graphics operations) + libfreetype6 libfontconfig1 libx11-6 libxt6 libxext6 libxrender1 libxtst6 libxi6 \ + libxinerama1 libxkbcommon0 libxkbfile1 libsm6 libice6 \ + # Qt WebEngine dependencies for Calibre + libegl1 libopengl0 libgl1 libxdamage1 libxfixes3 libxshmfence1 libdrm2 libgbm1 \ + libxkbcommon-x11-0 libxrandr2 libxcomposite1 libnss3 libx11-xcb1 \ + libxcb-cursor0 libdbus-1-3 libglib2.0-0 \ + # Virtual framebuffer (required for headless LibreOffice) + xvfb x11-utils coreutils \ + # Temporary packages only needed for Calibre installer + xz-utils gpgv curl xdg-utils \ + \ + # Install Calibre from official installer script + && curl -fsSL https://download.calibre-ebook.com/linux-installer.sh | sh /dev/stdin \ + \ + # Clean up installer-only packages + && apt-get purge -y xz-utils gpgv xdg-utils \ + && apt-get autoremove -y \ + && rm -rf /var/lib/apt/lists/* + +# Make ebook-convert available in PATH +RUN ln -sf /opt/calibre/ebook-convert /usr/bin/ebook-convert \ + && /opt/calibre/ebook-convert --version + +# ============================================================================== +# Create non-root user (stirlingpdfuser) with configurable UID/GID +# ============================================================================== +ARG PUID=1000 +ARG PGID=1000 + +RUN set -eux; \ + # Create group if it doesn't exist + if ! getent group stirlingpdfgroup >/dev/null 2>&1; then \ + if getent group "${PGID}" >/dev/null 2>&1; then \ + groupadd -o -g "${PGID}" stirlingpdfgroup; \ + else \ + groupadd -g "${PGID}" stirlingpdfgroup; \ + fi; \ + fi; \ + # Create user if it doesn't exist, avoid UID conflicts + if ! id -u stirlingpdfuser >/dev/null 2>&1; then \ + if getent passwd | awk -F: -v id="${PUID}" '$3==id{found=1} END{exit !found}'; then \ + echo "UID ${PUID} already in use – creating stirlingpdfuser with automatic UID"; \ + useradd -m -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + else \ + useradd -m -u "${PUID}" -g stirlingpdfgroup -d /home/stirlingpdfuser -s /bin/bash stirlingpdfuser; \ + fi; \ + fi + +# Compatibility alias for older entrypoint scripts expecting su-exec +RUN ln -sf /usr/sbin/gosu /usr/local/bin/su-exec + +# Copy application files from build stage +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/app/core/build/libs/*.jar /app.jar +COPY --from=build --chown=stirlingpdfuser:stirlingpdfgroup /app/build/libs/restart-helper.jar /restart-helper.jar +COPY scripts/ /scripts/ +COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/truetype/ + +# Optional version tag (can be passed at build time) ARG VERSION_TAG -# Labels +# Metadata labels LABEL org.opencontainers.image.title="Stirling-PDF Fat" -LABEL org.opencontainers.image.description="Stirling-PDF with embedded frontend - Fat version with extra fonts for air-gapped environments" +LABEL org.opencontainers.image.description="Stirling-PDF with embedded frontend - Fat version with extra fonts for air-gapped environments, includes Calibre, LibreOffice, Tesseract, OCRmyPDF, and more" LABEL org.opencontainers.image.source="https://github.com/Stirling-Tools/Stirling-PDF" LABEL org.opencontainers.image.licenses="MIT" LABEL org.opencontainers.image.vendor="Stirling-Tools" @@ -53,90 +132,67 @@ LABEL org.opencontainers.image.authors="Stirling-Tools" LABEL org.opencontainers.image.version="${VERSION_TAG}" LABEL org.opencontainers.image.keywords="PDF, manipulation, fat, air-gapped, API, Spring Boot, React" -# Copy scripts and fonts -COPY scripts /scripts -COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/ - -# Copy built JAR from build stage -COPY --from=build /app/app/core/build/libs/*.jar /app.jar -COPY --from=build /app/build/libs/restart-helper.jar /restart-helper.jar - -# Environment Variables +# ============================================================================== +# Runtime environment variables +# ============================================================================== ENV VERSION_TAG=$VERSION_TAG \ - JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \ + JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70 -Djava.awt.headless=true" \ JAVA_CUSTOM_OPTS="" \ HOME=/home/stirlingpdfuser \ - PUID=1000 \ - PGID=1000 \ + PUID=${PUID} \ + PGID=${PGID} \ UMASK=022 \ FAT_DOCKER=true \ INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \ - PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \ UNO_PATH=/usr/lib/libreoffice/program \ - URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc \ - PATH=$PATH:/opt/venv/bin \ STIRLING_TEMPFILES_DIRECTORY=/tmp/stirling-pdf \ TMPDIR=/tmp/stirling-pdf \ TEMP=/tmp/stirling-pdf \ TMP=/tmp/stirling-pdf -# Install all dependencies plus extra fonts for air-gapped environments -RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \ - echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \ - echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \ - apk upgrade --no-cache -a && \ - apk add --no-cache \ - ca-certificates \ - tzdata \ - tini \ - bash \ - curl \ - shadow \ - su-exec \ - openssl \ - openssl-dev \ - openjdk21-jre \ - # Doc conversion - gcompat \ - libc6-compat \ - libreoffice \ - ghostscript \ - fontforge \ - # pdftohtml - poppler-utils \ - # OCR MY PDF - unpaper \ - tesseract-ocr-data-eng \ - tesseract-ocr-data-chi_sim \ - tesseract-ocr-data-deu \ - tesseract-ocr-data-fra \ - tesseract-ocr-data-por \ - ocrmypdf \ - # Extra fonts for fat version - font-terminus font-dejavu font-noto font-noto-cjk font-awesome font-noto-extra font-liberation font-linux-libertine \ - # CV - py3-opencv \ - python3 \ - py3-pip \ - py3-pillow@testing \ - py3-pdf2image@testing && \ - python3 -m venv /opt/venv && \ - /opt/venv/bin/pip install --upgrade pip setuptools && \ - /opt/venv/bin/pip install --no-cache-dir --upgrade unoserver weasyprint && \ - ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \ - ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \ - mv /usr/share/tessdata /usr/share/tessdata-original && \ - mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf && \ - fc-cache -f -v && \ - chmod +x /scripts/* && \ - # User permissions - addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \ - chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /pipeline /usr/share/fonts/opentype/noto /configs /customFiles /tmp/stirling-pdf && \ - chown stirlingpdfuser:stirlingpdfgroup /app.jar /restart-helper.jar +# ============================================================================== +# Python virtual environment for additional Python tools (WeasyPrint, OpenCV, etc.) +# ============================================================================== +RUN python3 -m venv /opt/venv --system-site-packages \ + && /opt/venv/bin/pip install --no-cache-dir weasyprint pdf2image opencv-python-headless \ + && /opt/venv/bin/python -c "import cv2; print('OpenCV version:', cv2.__version__)" +# Separate venv for unoserver (keeps it isolated) +RUN python3 -m venv /opt/unoserver-venv --system-site-packages \ + && /opt/unoserver-venv/bin/pip install --no-cache-dir unoserver + +# Make unoserver tools available in main venv PATH +RUN ln -sf /opt/unoserver-venv/bin/unoconvert /opt/venv/bin/unoconvert \ + && ln -sf /opt/unoserver-venv/bin/unoserver /opt/venv/bin/unoserver + +# Extend PATH to include both virtual environments +ENV PATH="/opt/venv/bin:/opt/unoserver-venv/bin:${PATH}" + +# ============================================================================== +# Final permissions, directories and font cache +# ============================================================================== +RUN set -eux; \ + chmod +x /scripts/*; \ + mkdir -p /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf; \ + chown -R stirlingpdfuser:stirlingpdfgroup \ + /home/stirlingpdfuser /configs /logs /customFiles /pipeline /tmp/stirling-pdf \ + /app.jar /restart-helper.jar /usr/share/fonts/truetype /scripts; \ + chmod -R 755 /tmp/stirling-pdf + +# Rebuild font cache +RUN fc-cache -f -v + +# Force Qt/WebEngine to run headlessly (required for Calibre in Docker) +ENV QT_QPA_PLATFORM=offscreen \ + QTWEBENGINE_CHROMIUM_FLAGS="--disable-gpu --disable-dev-shm-usage" + +# Expose web UI port EXPOSE 8080/tcp -# Set user and run command +STOPSIGNAL SIGTERM + +# Use tini as init (handles signals and zombies correctly) ENTRYPOINT ["tini", "--", "/scripts/init.sh"] -CMD ["sh", "-c", "java -Dfile.encoding=UTF-8 -Djava.io.tmpdir=/tmp/stirling-pdf -jar /app.jar & /opt/venv/bin/unoserver --port 2003 --interface 127.0.0.1"] + +# CMD is empty – actual start command is defined in init.sh +CMD [] diff --git a/docker/embedded/compose/docker-compose-latest-fat-endpoints-disabled.yml b/docker/embedded/compose/docker-compose-latest-fat-endpoints-disabled.yml new file mode 100644 index 0000000000..b250b32c96 --- /dev/null +++ b/docker/embedded/compose/docker-compose-latest-fat-endpoints-disabled.yml @@ -0,0 +1,36 @@ + +services: + stirling-pdf: + container_name: Stirling-PDF-Fat-Disable-Endpoints + image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:fat + deploy: + resources: + limits: + memory: 4G + healthcheck: + test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP'"] + interval: 5s + timeout: 10s + retries: 16 + ports: + - 8080:8080 + volumes: + - ../../../stirling/latest/data:/usr/share/tessdata:rw + - ../../../stirling/latest/config:/configs:rw + - ../../../stirling/latest/logs:/logs:rw + - ../../../testing/allEndpointsRemovedSettings.yml:/configs/settings.yml:rw + environment: + DISABLE_ADDITIONAL_FEATURES: "false" + SECURITY_ENABLELOGIN: "false" + PUID: 1002 + PGID: 1002 + UMASK: "022" + SYSTEM_DEFAULTLOCALE: en-US + UI_APPNAME: Stirling-PDF + UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest-fat with all Endpoints Disabled + UI_APPNAMENAVBAR: Stirling-PDF Latest-fat + SYSTEM_MAXFILESIZE: "100" + METRICS_ENABLED: "true" + SYSTEM_GOOGLEVISIBILITY: "true" + SHOW_SURVEY: "true" + restart: on-failure:5 diff --git a/docker/embedded/compose/docker-compose-latest-fat-security.yml b/docker/embedded/compose/docker-compose-latest-fat-security.yml new file mode 100644 index 0000000000..abfe64cc14 --- /dev/null +++ b/docker/embedded/compose/docker-compose-latest-fat-security.yml @@ -0,0 +1,34 @@ +services: + stirling-pdf: + container_name: Stirling-PDF-Security-Fat + image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:fat + deploy: + resources: + limits: + memory: 4G + healthcheck: + test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP'"] + interval: 5s + timeout: 10s + retries: 16 + ports: + - 8080:8080 + volumes: + - ../../../stirling/latest/data:/usr/share/tessdata:rw + - ../../../stirling/latest/config:/configs:rw + - ../../../stirling/latest/logs:/logs:rw + environment: + DISABLE_ADDITIONAL_FEATURES: "false" + SECURITY_ENABLELOGIN: "false" + PUID: 1002 + PGID: 1002 + UMASK: "022" + SYSTEM_DEFAULTLOCALE: en-US + UI_APPNAME: Stirling-PDF + UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest-fat with Security + UI_APPNAMENAVBAR: Stirling-PDF Latest-fat + SYSTEM_MAXFILESIZE: "100" + METRICS_ENABLED: "true" + SYSTEM_GOOGLEVISIBILITY: "true" + SHOW_SURVEY: "true" + restart: on-failure:5 diff --git a/docker/embedded/compose/docker-compose-latest-ultra-lite.yml b/docker/embedded/compose/docker-compose-latest-ultra-lite.yml new file mode 100644 index 0000000000..4bc3debd8b --- /dev/null +++ b/docker/embedded/compose/docker-compose-latest-ultra-lite.yml @@ -0,0 +1,29 @@ +services: + stirling-pdf: + container_name: Stirling-PDF-Ultra-Lite + image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:ultra-lite + deploy: + resources: + limits: + memory: 1G + healthcheck: + test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"] + interval: 5s + timeout: 10s + retries: 16 + ports: + - "8080:8080" + volumes: + - ../../../stirling/latest/config:/configs:rw + - ../../../stirling/latest/logs:/logs:rw + environment: + SECURITY_ENABLELOGIN: "false" + SYSTEM_DEFAULTLOCALE: en-US + UI_APPNAME: Stirling-PDF-Ultra-lite + UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Ultra-lite Latest + UI_APPNAMENAVBAR: Stirling-PDF-Ultra-lite Latest + SYSTEM_MAXFILESIZE: "100" + METRICS_ENABLED: "true" + SYSTEM_GOOGLEVISIBILITY: "true" + SHOW_SURVEY: "true" + restart: on-failure:5 diff --git a/exampleYmlFiles/test_cicd.yml b/docker/embedded/compose/test_cicd.yml similarity index 80% rename from exampleYmlFiles/test_cicd.yml rename to docker/embedded/compose/test_cicd.yml index 086f862d5e..08ae0330a2 100644 --- a/exampleYmlFiles/test_cicd.yml +++ b/docker/embedded/compose/test_cicd.yml @@ -1,7 +1,7 @@ services: stirling-pdf: container_name: Stirling-PDF-Security-Fat-with-login - image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest-fat + image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:fat deploy: resources: limits: @@ -14,9 +14,9 @@ services: ports: - 8080:8080 volumes: - - ./stirling/latest/data:/usr/share/tessdata:rw - - ./stirling/latest/config:/configs:rw - - ./stirling/latest/logs:/logs:rw + - ../../../stirling/latest/data:/usr/share/tessdata:rw + - ../../../stirling/latest/config:/configs:rw + - ../../../stirling/latest/logs:/logs:rw environment: DISABLE_ADDITIONAL_FEATURES: "false" SECURITY_ENABLELOGIN: "true" diff --git a/docs/counter_translation.md b/docs/counter_translation.md new file mode 100644 index 0000000000..b2cdd74451 --- /dev/null +++ b/docs/counter_translation.md @@ -0,0 +1,64 @@ +# `counter_translation.py` + +## Overview + +The script [`scripts/counter_translation.py`](../scripts/counter_translation.py) checks the translation progress of the property files in the directory `app/core/src/main/resources/`. +It compares each `messages_*.properties` file with the English reference file `messages_en_GB.properties` and calculates a percentage of completion for each language. + +In addition to console output, the script automatically updates the progress badges in the project’s `README.md` and maintains the configuration file [`scripts/ignore_translation.toml`](../scripts/ignore_translation.toml), which lists translation keys to be ignored for each language. + +## Requirements + +- Python 3.10 or newer (requires `tomlkit`). +- Must be executed **from the project root directory** so all relative paths are resolved correctly. +- Write permissions for `README.md` and `scripts/ignore_translation.toml`. + +## Default usage + +```bash +python scripts/counter_translation.py +``` + +This command: + +1. scans `app/core/src/main/resources/` for all `messages_*.properties` files, +2. calculates the translation progress for each file, +3. updates the badges in `README.md`, +4. reformats `scripts/ignore_translation.toml` (sorted, multi-line arrays). + +## Check a single language + +```bash +python scripts/counter_translation.py --lang messages_fr_FR.properties +``` + +- The specified file can be given as a relative (to the resources folder) or absolute path. +- The result is printed to the console (e.g. `fr_FR: 87% translated`). +- With `--show-missing-keys`, all untranslated keys are listed as well. + +## Output only the percentage + +For scripts or CI pipelines, the output can be reduced to just the percentage value: + +```bash +python scripts/counter_translation.py --lang messages_fr_FR.properties --show-percentage +``` + +The console will then only print `87` (without the percent symbol or any extra text). + +## Handling `ignore_translation.toml` + +- If a language section is missing, the script creates it automatically. +- Entries in `ignore` are alphabetically sorted and written as multi-line arrays. +- By default, `language.direction` is ignored. If that key is later translated, the script automatically removes it from the ignore list. + +## Integration in Pull Requests + +Whenever translations are updated, this script should be executed. +The updated badges and the modified `ignore_translation.toml` should be committed together with the changed `messages_*.properties` files. + +## Troubleshooting + +- **File not found**: Check the path or use `--lang` with an absolute path. +- **Line error**: The script reports the specific line in both files—this usually means a missing `=` or an unmatched line. +- **Incorrect percentages in README**: Make sure the script was run from the project root and that write permissions are available. diff --git a/frontend/public/locales/en-GB/translation.toml b/frontend/public/locales/en-GB/translation.toml index 83963987d8..f9e13f3c1e 100644 --- a/frontend/public/locales/en-GB/translation.toml +++ b/frontend/public/locales/en-GB/translation.toml @@ -312,10 +312,10 @@ yamlAdvert = "Stirling PDF Pro supports YAML configuration files and other SSO f ssoAdvert = "Looking for more user management features? Check out Stirling PDF Pro" [analytics] -title = "Do you want make Stirling PDF better?" -paragraph1 = "Stirling PDF has opt in analytics to help us improve the product. We do not track any personal information or file contents." +title = "Do you want to help make Stirling PDF better?" +paragraph1 = "Stirling PDF has opt-in analytics to help us improve the product. We do not track any personal information or file contents." paragraph2 = "Please consider enabling analytics to help Stirling-PDF grow and to allow us to understand our users better." -learnMore = "Learn more" +learnMore = "Learn more about our analytics" enable = "Enable analytics" disable = "Disable analytics" settings = "You can change the settings for analytics in the config/settings.yml file" @@ -340,6 +340,10 @@ advance = "Advanced" edit = "View & Edit" popular = "Popular" +[footer] +discord = "Discord" +issues = "GitHub" + [settings.preferences] title = "Preferences" @@ -445,6 +449,7 @@ required = "All fields are required." mismatch = "New passwords do not match." error = "Unable to update password. Please verify your current password and try again." success = "Password updated successfully. Please sign in again." +ssoDisabled = "Password changes are managed by your identity provider." current = "Current password" currentPlaceholder = "Enter your current password" new = "New password" @@ -506,6 +511,7 @@ low = "Low" title = "Change Credentials" header = "Update Your Account Details" changePassword = "You are using default login credentials. Please enter a new password" +ssoManaged = "Your account is managed by your identity provider." newUsername = "New Username" oldPassword = "Current Password" newPassword = "New Password" @@ -730,6 +736,11 @@ tags = "signature,autograph" title = "Sign" desc = "Adds signature to PDF by drawing, text or image" +[home.annotate] +tags = "annotate,highlight,draw" +title = "Annotate" +desc = "Highlight, draw, add notes and shapes in the viewer" + [home.flatten] tags = "simplify,remove,interactive" title = "Flatten" @@ -1238,7 +1249,7 @@ includeAllRecipients = "Include CC and BCC recipients in header" downloadHtml = "Download HTML intermediate file instead of PDF" pdfaOptions = "PDF/A Options" outputFormat = "Output Format" -pdfaNote = "PDF/A-1b is more compatible, PDF/A-2b supports more features." +pdfaNote = "PDF/A-1b is more compatible, PDF/A-2b supports more features, PDF/A-3b supports embedded files." pdfaDigitalSignatureWarning = "The PDF contains a digital signature. This will be removed in the next step." fileFormat = "File Format" wordDoc = "Word Document" @@ -1267,6 +1278,21 @@ cbzOptions = "CBZ to PDF Options" optimizeForEbook = "Optimize PDF for ebook readers (uses Ghostscript)" cbzOutputOptions = "PDF to CBZ Options" cbzDpi = "DPI for image rendering" +cbrOptions = "CBR Options" +cbrOutputOptions = "PDF to CBR Options" +cbrDpi = "DPI for image rendering" + +[convert.ebookOptions] +ebookOptions = "eBook to PDF Options" +ebookOptionsDesc = "Options for converting eBooks to PDF" +embedAllFonts = "Embed all fonts" +embedAllFontsDesc = "Embed all fonts from the eBook into the generated PDF" +includeTableOfContents = "Include table of contents" +includeTableOfContentsDesc = "Add a generated table of contents to the resulting PDF" +includePageNumbers = "Include page numbers" +includePageNumbersDesc = "Add page numbers to the generated PDF" +optimizeForEbookPdf = "Optimize for ebook readers" +optimizeForEbookPdfDesc = "Optimize the PDF for eBook reading (smaller file size, better rendering on eInk devices)" [imageToPdf] tags = "conversion,img,jpg,picture,photo" @@ -1383,6 +1409,11 @@ header = "Add Attachments" add = "Add Attachment" remove = "Remove Attachment" embed = "Embed Attachment" +convertToPdfA3b = "Convert to PDF/A-3b" +convertToPdfA3bDescription = "Creates an archival PDF with embedded attachments" +convertToPdfA3bTooltip = "PDF/A-3b is an archival format ensuring long-term preservation. It allows embedding arbitrary file formats as attachments. Conversion requires Ghostscript and may take longer for large files." +convertToPdfA3bTooltipHeader = "About PDF/A-3b Conversion" +convertToPdfA3bTooltipTitle = "What it does" submit = "Add Attachments" [watermark] @@ -2328,6 +2359,10 @@ saved = "Saved" label = "Upload signature image" placeholder = "Select image file" hint = "Upload a PNG or JPG image of your signature" +removeBackground = "Remove white background (make transparent)" +processing = "Processing image..." +backgroundRemovalFailedTitle = "Background removal failed" +backgroundRemovalFailedMessage = "Could not remove the background from the image. Using original image instead." [sign.instructions] title = "How to add signature" @@ -2373,6 +2408,11 @@ note = "Flattening removes interactive elements from the PDF, making them non-ed label = "Flatten only forms" desc = "Only flatten form fields, leaving other interactive elements intact" +[flatten.renderDpi] +label = "Rendering DPI (optional, recommended 150 DPI)" +help = "Leave blank to use the system default. Higher DPI sharpens output but increases processing time and file size." +placeholder = "e.g. 150" + [flatten.results] title = "Flatten Results" @@ -2947,6 +2987,7 @@ header = "Crop PDF" submit = "Apply Crop" noFileSelected = "Select a PDF file to begin cropping" reset = "Reset to full PDF" +autoCrop = "Auto-crop whitespace" [crop.preview] title = "Crop Area Selection" @@ -3364,6 +3405,19 @@ placeholder = "Enter number of horizontal divisions" label = "Vertical Divisions" placeholder = "Enter number of vertical divisions" +[split-by-sections.splitMode] +label = "Split Mode" +description = "Choose how to split the pages" +splitAll = "Split all pages" +splitAllExceptFirst = "Split all except first" +splitAllExceptLast = "Split all except last" +splitAllExceptFirstAndLast = "Split all except first and last" +custom = "Custom pages" + +[split-by-sections.customPages] +label = "Custom Page Numbers" +placeholder = "e.g. 2,4,6" + [AddStampRequest] tags = "Stamp, Add image, center image, Watermark, PDF, Embed, Customize,Customise" header = "Stamp PDF" @@ -3725,6 +3779,19 @@ filesize = "File Size" [compress.grayscale] label = "Apply Grayscale for Compression" +[compress.linearize] +label = "Linearize PDF for fast web viewing" + +[compress.lineArt] +label = "Convert images to line art" +description = "Uses ImageMagick to reduce pages to high-contrast black and white for maximum size reduction." +unavailable = "ImageMagick is not installed or enabled on this server" +detailLevel = "Detail level" +edgeEmphasis = "Edge emphasis" +edgeLow = "Gentle" +edgeMedium = "Balanced" +edgeHigh = "Strong" + [compress.tooltip.header] title = "Compress Settings Overview" @@ -3742,6 +3809,10 @@ bullet2 = "Higher values reduce file size" title = "Grayscale" text = "Select this option to convert all images to black and white, which can significantly reduce file size especially for scanned PDFs or image-heavy documents." +[compress.tooltip.lineArt] +title = "Line Art" +text = "Convert pages to high-contrast black and white using ImageMagick. Use detail level to control how much content becomes black, and edge emphasis to control how aggressively edges are detected." + [compress.error] failed = "An error occurred while compressing the PDF." @@ -3754,6 +3825,11 @@ failed = "An error occurred while compressing the PDF." _value = "Compression Settings" 1 = "1-3 PDF compression,
4-6 lite image compression,
7-9 intense image compression Will dramatically reduce image quality" +[compress.compressionLevel] +range1to3 = "Lower values preserve quality but result in larger files" +range4to6 = "Medium compression with moderate quality reduction" +range7to9 = "Higher values reduce file size significantly but may reduce image clarity" + [decrypt] passwordPrompt = "This file is password-protected. Please enter the password:" cancelled = "Operation cancelled for PDF: {0}" @@ -3993,23 +4069,92 @@ deleteSelected = "Delete Selected Pages" closePdf = "Close PDF" exportAll = "Export PDF" downloadSelected = "Download Selected Files" -downloadAll = "Download All" -saveAll = "Save All" +annotations = "Annotations" +exportSelected = "Export Selected Pages" +saveChanges = "Save Changes" toggleTheme = "Toggle Theme" -toggleBookmarks = "Toggle Bookmarks" language = "Language" +toggleAnnotations = "Toggle Annotations Visibility" search = "Search PDF" panMode = "Pan Mode" rotateLeft = "Rotate Left" rotateRight = "Rotate Right" toggleSidebar = "Toggle Sidebar" -exportSelected = "Export Selected Pages" -toggleAnnotations = "Toggle Annotations Visibility" -annotationMode = "Toggle Annotation Mode" +toggleBookmarks = "Toggle Bookmarks" print = "Print PDF" -draw = "Draw" -save = "Save" -saveChanges = "Save Changes" +downloadAll = "Download All" +saveAll = "Save All" + +[textAlign] +left = "Left" +center = "Center" +right = "Right" + +[annotation] +title = "Annotate" +desc = "Use highlight, pen, text, and notes. Changes stay live—no flattening required." +highlight = "Highlight" +pen = "Pen" +text = "Text box" +note = "Note" +rectangle = "Rectangle" +ellipse = "Ellipse" +select = "Select" +exit = "Exit annotation mode" +strokeWidth = "Width" +opacity = "Opacity" +strokeOpacity = "Stroke Opacity" +fillOpacity = "Fill Opacity" +fontSize = "Font size" +chooseColor = "Choose colour" +color = "Colour" +strokeColor = "Stroke Colour" +fillColor = "Fill Colour" +underline = "Underline" +strikeout = "Strikeout" +squiggly = "Squiggly" +inkHighlighter = "Freehand Highlighter" +freehandHighlighter = "Freehand Highlighter" +square = "Square" +circle = "Circle" +polygon = "Polygon" +line = "Line" +stamp = "Add Image" +textMarkup = "Text Markup" +drawing = "Drawing" +shapes = "Shapes" +notesStamps = "Notes & Stamps" +settings = "Settings" +borderOn = "Border: On" +borderOff = "Border: Off" +editInk = "Edit Pen" +editLine = "Edit Line" +editNote = "Edit Note" +editText = "Edit Text Box" +editTextMarkup = "Edit Text Markup" +editSelected = "Edit Annotation" +editSquare = "Edit Square" +editCircle = "Edit Circle" +editPolygon = "Edit Polygon" +unsupportedType = "This annotation type is not fully supported for editing." +textAlignment = "Text Alignment" +noteIcon = "Note Icon" +imagePreview = "Preview" +contents = "Text" +backgroundColor = "Background colour" +clearBackground = "Remove background" +noBackground = "No background" +stampSettings = "Stamp Settings" +savingCopy = "Preparing download..." +saveFailed = "Unable to save copy" +saveReady = "Download ready" +selectAndMove = "Select and Edit" +editSelectDescription = "Click an existing annotation to edit its colour, opacity, text, or size." +editStampHint = "To change the image, delete this stamp and add a new one." +editSwitchToSelect = "Switch to Select & Edit to edit this annotation." +undo = "Undo" +redo = "Redo" +applyChanges = "Apply Changes" [search] title = "Search PDF" @@ -4060,12 +4205,20 @@ settings = "Settings" adminSettings = "Admin Settings" allTools = "Tools" reader = "Reader" +tours = "Tours" +showMeAround = "Show me around" + +[quickAccess.toursTooltip] +admin = "Watch walkthroughs here: Tools tour, New V2 layout tour, and the Admin tour." +user = "Watch walkthroughs here: Tools tour and the New V2 layout tour." [quickAccess.helpMenu] toolsTour = "Tools Tour" toolsTourDesc = "Learn what the tools can do" adminTour = "Admin Tour" adminTourDesc = "Explore admin settings & features" +whatsNewTour = "See what's new in V2" +whatsNewTourDesc = "Tour the updated layout" [admin] error = "Error" @@ -5259,6 +5412,16 @@ finish = "Finish" startTour = "Start Tour" startTourDescription = "Take a guided tour of Stirling PDF's key features" +[onboarding.whatsNew] +quickAccess = "Start at the Quick Access rail to jump between Reader, Automate, your files, and all the tours." +leftPanel = "The left Tools panel lists everything you can do. Browse categories or search to find a tool quickly." +fileUpload = "Use the Files button to upload or pick a recent PDF. We will load a sample so you can see the workspace." +rightRail = "The Right Rail holds quick actions to select files, change theme or language, and download results." +topBar = "The top bar lets you swap between Viewer, Page Editor, and Active Files." +pageEditorView = "Switch to the Page Editor to reorder, rotate, or delete pages." +activeFilesView = "Use Active Files to see everything you have open and pick what to work on." +wrapUp = "That is what is new in V2. Open the Tours menu anytime to replay this, the Tools tour, or the Admin tour." + [onboarding.welcomeModal] title = "Welcome to Stirling PDF!" description = "Would you like to take a quick 1-minute tour to learn the key features and how to get started?" @@ -5279,6 +5442,10 @@ download = "Download →" showMeAround = "Show me around" skipTheTour = "Skip the tour" +[onboarding.tourOverview] +title = "Tour Overview" +body = "Stirling PDF V2 ships with dozens of tools and a refreshed layout. Take a quick tour to see what changed and where to find the features you need." + [onboarding.serverLicense] skip = "Skip for now" seePlans = "See Plans →" @@ -5817,6 +5984,8 @@ notAvailable = "Audit system not available" notAvailableMessage = "The audit system is not configured or not available." disabled = "Audit logging is disabled" disabledMessage = "Enable audit logging in your application configuration to track system events." +enterpriseRequired = "Enterprise License Required" +enterpriseRequiredMessage = "The audit logging system is an enterprise feature. Please upgrade to an enterprise license to access audit logs and analytics." [audit.error] title = "Error loading audit system" @@ -6042,7 +6211,7 @@ title = "Authentication Failed" message = "Authentication was not successful. You can close this window and try again." [pdfTextEditor] -title = "PDF JSON Editor" +title = "PDF Text Editor" viewLabel = "PDF Editor" converting = "Converting PDF to editable format..." conversionFailed = "Failed to convert PDF. Please try again." @@ -6071,6 +6240,8 @@ reset = "Reset Changes" downloadJson = "Download JSON" generatePdf = "Generate PDF" saveChanges = "Save Changes" +applyChanges = "Apply Changes" +downloadCopy = "Download Copy" [pdfTextEditor.options.autoScaleText] title = "Auto-scale text to fit boxes" @@ -6089,6 +6260,24 @@ descriptionInline = "Tip: Hold Ctrl (Cmd) or Shift to multi-select text boxes. A title = "Lock edited text to a single PDF element" description = "When enabled, the editor exports each edited text box as one PDF text element to avoid overlapping glyphs or mixed fonts." +[pdfTextEditor.options.advanced] +title = "Advanced Settings" + +[pdfTextEditor.tooltip.header] +title = "Preview Limitations" + +[pdfTextEditor.tooltip.textFocus] +title = "Text and Image Focus" +text = "This workspace focuses on editing text and repositioning embedded images. Complex page artwork, form widgets, and layered graphics are preserved for export but are not fully editable here." + +[pdfTextEditor.tooltip.previewVariance] +title = "Preview Variance" +text = "Some visuals (such as table borders, shapes, or annotation appearances) may not display exactly in the preview. The exported PDF keeps the original drawing commands whenever possible." + +[pdfTextEditor.tooltip.alpha] +title = "Alpha Viewer" +text = "This alpha viewer is still evolving—certain fonts, colours, transparency effects, and layout details may shift slightly. Please double-check the generated PDF before sharing." + [pdfTextEditor.manual] mergeTooltip = "Merge selected boxes" merge = "Merge selection" @@ -6108,8 +6297,8 @@ alpha = "This alpha viewer is still evolving—certain fonts, colours, transpare [pdfTextEditor.empty] title = "No document loaded" subtitle = "Load a PDF or JSON file to begin editing text content." -dropzone = "Drag and drop a PDF or JSON file here, or click to browse" -dropzoneWithFiles = "Select a file from the Files tab, or drag and drop a PDF or JSON file here, or click to browse" +dropzone = "Drag and drop a PDF here, or click to browse" +dropzoneWithFiles = "Select a file from the Files tab, or drag and drop a PDF here, or click to browse" [pdfTextEditor.welcomeBanner] title = "Welcome to PDF Text Editor (Early Access)" diff --git a/frontend/public/locales/it-IT/translation.toml b/frontend/public/locales/it-IT/translation.toml index 20796ceb06..5ef5ce47a8 100644 --- a/frontend/public/locales/it-IT/translation.toml +++ b/frontend/public/locales/it-IT/translation.toml @@ -1107,7 +1107,7 @@ title = "Dividi per conteggio" text = "Crea più PDF con un numero specifico di pagine o documenti ciascuno." bullet1 = "Conteggio pagine: numero fisso per file" bullet2 = "Numero documenti: numero fisso di file in output" -bullet3 = "Utile per workflow batch" +bullet3 = "Utile per batch di flusso di lavoro" [split.tooltip.byChapters] title = "Dividi per capitoli" @@ -1696,7 +1696,7 @@ submit = "Estrai pagine" [extractPages.pageNumbers] label = "Pagine da estrarre" -placeholder = "es., 1,3,5-8 o odd & 1-10" +placeholder = "es., 1,3,5-8 o dispari & 1-10" [extractPages.settings] title = "Impostazioni" @@ -1711,7 +1711,7 @@ failed = "Impossibile estrarre le pagine" title = "Pagine estratte" [pageSelection.tooltip] -description = "Scegli quali pagine usare per l'operazione. Supporta pagine singole, intervalli, formule e la parola chiave \"all\"." +description = "Scegli quali pagine usare per l'operazione. Supporta pagine singole, intervalli, formule e la parola chiave \"tutte\"." [pageSelection.tooltip.header] title = "Guida Selezione Pagine" @@ -1721,7 +1721,7 @@ title = "Uso di base" text = "Seleziona pagine specifiche dal tuo PDF usando una sintassi semplice." bullet1 = "Pagine singole: 1,3,5" bullet2 = "Intervalli: 3-6 o 10-15" -bullet3 = "Tutte le pagine: all" +bullet3 = "Tutte le pagine: tutte" [pageSelection.tooltip.advanced] title = "Funzionalità avanzate" @@ -1739,15 +1739,15 @@ text = "Usa numeri, intervalli, parole chiave e progressioni (n parte da 0). Son [pageSelection.tooltip.syntax.bullets] numbers = "Numeri/intervalli: 5, 10-20" -keywords = "Parole chiave: odd, even" +keywords = "Parole chiave: dispari, pari" progressions = "Progressioni: 3n, 4n+1" [pageSelection.tooltip.operators] title = "Operatori" -text = "AND ha precedenza più alta della virgola. NOT si applica all’interno dell’intervallo del documento." -and = "AND: & o \"and\" — richiede entrambe le condizioni (es., 1-50 & even)" +text = "E ha precedenza più alta della virgola. NON si applica all’interno dell’intervallo del documento." +and = "E: & o \"e\" — richiede entrambe le condizioni (es., 1-50 & pari)" comma = "Virgola: , o | — combina selezioni (es., 1-10, 20)" -not = "NOT: ! o \"not\" — esclude pagine (es., 3n & not 30)" +not = "NON: ! o \"NON\" — esclude pagine (es., 3n & non 30)" [pageSelection.tooltip.examples] title = "Esempi" @@ -1795,15 +1795,15 @@ text = "Usa numeri, intervalli, parole chiave e progressioni (n parte da 0). Son [bulkSelection.syntax.bullets] numbers = "Numeri/intervalli: 5, 10-20" -keywords = "Parole chiave: odd, even" +keywords = "Parole chiave: dispari, pari" progressions = "Progressioni: 3n, 4n+1" [bulkSelection.operators] title = "Operatori" -text = "AND ha precedenza più alta della virgola. NOT si applica all’interno dell’intervallo del documento." -and = "AND: & o \"and\" — richiede entrambe le condizioni (es., 1-50 & even)" +text = "E ha precedenza più alta della virgola. NON si applica all’interno dell’intervallo del documento." +and = "E: & o \"e\" — richiede entrambe le condizioni (es., 1-50 & pari)" comma = "Virgola: , o | — combina selezioni (es., 1-10, 20)" -not = "NOT: ! o \"not\" — esclude pagine (es., 3n & not 30)" +not = "NON: ! o \"non\" — esclude pagine (es., 3n & non 30)" [bulkSelection.examples] title = "Esempi" @@ -2163,9 +2163,9 @@ info = "Python non è installato. È necessario per l'esecuzione." [ScannerImageSplit.selectText] 1 = "Soglia angolo:" -2 = "Imposta il minimo angolo richiesto perché l'immagine venga ruotata (default: 10)." +2 = "Imposta il minimo angolo richiesto perché l'immagine venga ruotata (predefinito: 10)." 3 = "Tolleranza:" -4 = "Imposta lo spettro di colori attorno al colore di sfondo stimato (default: 30)." +4 = "Imposta lo spettro di colori attorno al colore di sfondo stimato (predefinito: 30)." 5 = "Area minima:" 6 = "Imposta l'area minima di una foto (default: 10000)." 7 = "Area di contorno minima:" @@ -2343,26 +2343,26 @@ placeholder = "Seleziona un file PDF nella vista principale per iniziare" settings = "Impostazioni" [flatten.options] -stepTitle = "Opzioni di flattening" -title = "Opzioni di flattening" -note = "Il flattening rimuove gli elementi interattivi dal PDF, rendendoli non modificabili." +stepTitle = "Opzioni di appiattimento" +title = "Opzioni di appiattimento" +note = "L'appiattimento rimuove gli elementi interattivi dal PDF, rendendoli non modificabili." [flatten.options.flattenOnlyForms] label = "Appiattisci solo i moduli" desc = "Appiattisci solo i campi modulo, lasciando intatti gli altri elementi interattivi" [flatten.results] -title = "Risultati Flatten" +title = "Risultati di appiattimento" [flatten.error] -failed = "Si è verificato un errore durante il flattening del PDF." +failed = "Si è verificato un errore durante l'appiattimento del PDF." [flatten.tooltip.header] -title = "Informazioni sul flattening dei PDF" +title = "Informazioni sull'appiattimento dei PDF" [flatten.tooltip.description] -title = "Cosa fa il flattening?" -text = "Il flattening rende il tuo PDF non modificabile trasformando moduli compilabili e pulsanti in testo e immagini normali. Il PDF avrà lo stesso aspetto, ma nessuno potrà più modificare o compilare i moduli. Perfetto per condividere moduli completati, creare documenti finali per gli archivi o garantire un aspetto uniforme ovunque." +title = "Cosa fa l'appiattimento?" +text = "L'appiattimento rende il tuo PDF non modificabile trasformando moduli compilabili e pulsanti in testo e immagini normali. Il PDF avrà lo stesso aspetto, ma nessuno potrà più modificare o compilare i moduli. Perfetto per condividere moduli completati, creare documenti finali per gli archivi o garantire un aspetto uniforme ovunque." bullet1 = "Le caselle di testo diventano testo normale (non modificabile)" bullet2 = "Checkbox e pulsanti diventano immagini" bullet3 = "Ottimo per versioni finali che non vuoi vengano modificate" @@ -2469,7 +2469,7 @@ title = "Compara" header = "Compara PDF" clearSelected = "Cancella selezionati" addFilesHint = "Aggiungi PDF nel passaggio File per abilitarne la selezione." -noFiles = "Nessun PDF disponibile yet" +noFiles = "Nessun PDF disponibile" pages = "Pagine" cta = "Confronta" loading = "Confronto in corso..." @@ -4168,7 +4168,7 @@ label = "Directory pipeline" [admin.settings.general.customPaths.pipeline.watchedFoldersDir] label = "Directory cartelle monitorate" -description = "Directory in cui la pipeline monitora i PDF in arrivo (lascia vuoto per default: /pipeline/watchedFolders)" +description = "Directory in cui la pipeline monitora i PDF in arrivo (lascia vuoto per predefinito: /pipeline/watchedFolders)" [admin.settings.general.customPaths.pipeline.finishedFoldersDir] label = "Directory cartelle completate" @@ -4179,11 +4179,11 @@ label = "Percorsi strumenti esterni" [admin.settings.general.customPaths.operations.weasyprint] label = "Eseguibile WeasyPrint" -description = "Percorso dell'eseguibile WeasyPrint per conversione da HTML a PDF (lascia vuoto per default: /opt/venv/bin/weasyprint)" +description = "Percorso dell'eseguibile WeasyPrint per conversione da HTML a PDF (lascia vuoto per predefinito: /opt/venv/bin/weasyprint)" [admin.settings.general.customPaths.operations.unoconvert] label = "Eseguibile Unoconvert" -description = "Percorso di LibreOffice unoconvert per conversioni di documenti (lascia vuoto per default: /opt/venv/bin/unoconvert)" +description = "Percorso di LibreOffice unoconvert per conversioni di documenti (lascia vuoto per predefinito: /opt/venv/bin/unoconvert)" [admin.settings.security] title = "Sicurezza" @@ -4305,12 +4305,12 @@ label = "Blocca localhost" description = "Blocca localhost e indirizzi loopback (127.x.x.x, ::1)" [admin.settings.security.htmlUrlSecurity.blockLinkLocal] -label = "Blocca indirizzi link-local" -description = "Blocca indirizzi link-local (169.254.x.x, fe80::/10)" +label = "Blocca indirizzi link-locali" +description = "Blocca indirizzi link-locali (169.254.x.x, fe80::/10)" [admin.settings.security.htmlUrlSecurity.blockCloudMetadata] -label = "Blocca endpoint dei metadata cloud" -description = "Blocca gli endpoint dei metadata dei provider cloud (169.254.169.254)" +label = "Blocca endpoint dei metadati cloud" +description = "Blocca gli endpoint dei metadati dei provider cloud (169.254.169.254)" [admin.settings.connections] title = "Connessioni" @@ -5211,7 +5211,7 @@ noSearchResults = "Nessuno strumento trovato" noTools = "Nessuno strumento disponibile" [onboarding] -allTools = "This is the All Tools panel, where you can browse and select from all available PDF tools." +allTools = "Questo è il pannello Tutti gli Strumenti, dove puoi sfogliare e selezionare tutti gli strumenti PDF disponibili." selectCropTool = "Selezioniamo lo strumento Ritaglia per mostrare come usarne uno." toolInterface = "Questa è l'interfaccia dello strumento Ritaglia. Come vedi, non c'è molto perché non abbiamo ancora aggiunto file PDF su cui lavorare." filesButton = "Il pulsante File sulla barra di accesso rapido consente di caricare PDF su cui usare gli strumenti." diff --git a/frontend/public/locales/nl-NL/translation.toml b/frontend/public/locales/nl-NL/translation.toml index b9599e1278..a1192b2a71 100644 --- a/frontend/public/locales/nl-NL/translation.toml +++ b/frontend/public/locales/nl-NL/translation.toml @@ -1,5 +1,5 @@ -unsavedChanges = "Je hebt niet-opgeslagen wijzigingen in je PDF." -areYouSure = "Weet je zeker dat je wilt vertrekken?" +unsavedChanges = "U heeft niet-opgeslagen wijzigingen in uw PDF." +areYouSure = "Weet u zeker dat u wilt vertrekken?" unsavedChangesTitle = "Niet-opgeslagen wijzigingen" keepWorking = "Doorgaan met werken" discardChanges = "Verwerpen en verlaten" @@ -10,11 +10,11 @@ pageSelectionPrompt = "Aangepaste pagina selectie (Voer een komma-gescheiden lij startingNumberTooltip = "Het eerste getal dat wordt weergegeven. Volgende pagina's tellen door vanaf dit nummer." marginTooltip = "Afstand tussen het paginanummer en de rand van de pagina." fontSizeTooltip = "Grootte van de paginanummertekst in punten. Grotere getallen geven grotere tekst." -fontTypeTooltip = "Lettertypefamilie voor de paginanummers. Kies passend bij de stijl van je document." -customTextTooltip = "Optioneel aangepast formaat voor paginanummers. Gebruik {n} als placeholder voor het nummer. Voorbeeld: \"Pagina {n}\" toont \"Pagina 1\", \"Pagina 2\", enz." -pdfPrompt = "Selecteer PDF('s)" -multiPdfPrompt = "Selecteer PDF's (2+)" -multiPdfDropPrompt = "Selecteer (of sleep & zet neer) alle PDF's die je nodig hebt" +fontTypeTooltip = "Lettertypefamilie voor de paginanummers. Kies passend bij de stijl van uw document." +customTextTooltip = "Optioneel aangepast formaat voor paginanummers. Gebruik {n} als plaatsvervanger voor het nummer. Voorbeeld: \"Pagina {n}\" toont \"Pagina 1\", \"Pagina 2\", enz." +pdfPrompt = "PDF(-en) selecteren" +multiPdfPrompt = "PDF-en (2+) selecteren" +multiPdfDropPrompt = "Selecteer (of sleep & zet neer) alle PDF-en die u nodig hebt" imgPrompt = "Selecteer afbeelding(en)" genericSubmit = "Indienen" uploadLimit = "Maximale bestandsgrootte:" @@ -22,7 +22,7 @@ uploadLimitExceededSingular = "is te groot. Maximale toegestane grootte is" uploadLimitExceededPlural = "zijn te groot. Maximale toegestane grootte is" processTimeWarning = "Waarschuwing: Dit proces kan tot een minuut duren afhankelijk van de bestandsgrootte" pageOrderPrompt = "Aangepaste pagina volgorde (Voer een komma-gescheiden lijst van paginanummers of functies in, zoals 2n+1) :" -goToPage = "Ga" +goToPage = "Gaan" true = "Waar" false = "Onwaar" unknown = "Onbekend" @@ -38,11 +38,11 @@ undo = "Ongedaan maken" back = "Terug" nothingToUndo = "Niets om ongedaan te maken" moreOptions = "Meer opties" -editYourNewFiles = "Je nieuwe bestand(en) bewerken" +editYourNewFiles = "Uw nieuwe bestand(en) bewerken" close = "Sluiten" openInViewer = "Openen in Viewer" confirmClose = "Sluiten bevestigen" -confirmCloseMessage = "Weet je zeker dat je dit bestand wilt sluiten?" +confirmCloseMessage = "Weet u zeker dat u dit bestand wilt sluiten?" confirmCloseCancel = "Annuleren" confirmCloseConfirm = "Bestand sluiten" fileSelected = "Geselecteerd: {{filename}}" @@ -55,7 +55,7 @@ alphabet = "Alfabet" downloadPdf = "PDF downloaden" text = "Tekst" font = "Lettertype" -selectFillter = "-- Selecteer --" +selectFillter = "-- Selecteren --" pageNum = "Paginanummer" edit = "Bewerken" delete = "Verwijderen" @@ -88,15 +88,15 @@ deleteUsernameExistsMessage = "De gebruikersnaam bestaat niet en kan niet verwij downgradeCurrentUserMessage = "Kan de rol van de huidige gebruiker niet downgraden" disabledCurrentUserMessage = "De huidige gebruiker kan niet worden uitgeschakeld" downgradeCurrentUserLongMessage = "Kan de rol van de huidige gebruiker niet downgraden. Huidige gebruiker wordt dus niet weergegeven." -userAlreadyExistsOAuthMessage = "De gebruiker bestaat al als een OAuth2 gebruiker." -userAlreadyExistsWebMessage = "De gebruiker bestaat al als een web gebruiker." +userAlreadyExistsOAuthMessage = "De gebruiker bestaat al als een OAuth2-gebruiker." +userAlreadyExistsWebMessage = "De gebruiker bestaat al als een webgebruiker." oops = "Oeps!" help = "Hulp" goHomepage = "Ga naar de startpagina" -joinDiscord = "Word lid van onze Discord server" +joinDiscord = "Word lid van onze Discord-server" seeDockerHub = "Zie Docker Hub" visitGithub = "Ga naar de Github Repository" -donate = "Doneer" +donate = "Doneren" color = "Kleur" sponsor = "Sponsor" info = "Informatie" @@ -108,7 +108,7 @@ review = "Beoordelen" addToDoc = "Toevoegen aan document" reset = "Reset" apply = "Toepassen" -noFileSelected = "Geen bestand geselecteerd. Upload er één." +noFileSelected = "Geen bestand geselecteerd. Upload er een." termsAndConditions = "Algemene voorwaarden" logOut = "Uitloggen" customPosition = "Aangepaste positie" @@ -136,14 +136,14 @@ premiumFeature = "Premiumfunctie:" comingSoon = "Binnenkort beschikbaar:" [toolPanel.modePrompt] -title = "Kies hoe je tools bekijkt" -description = "Bekijk beide lay-outs en beslis hoe je de Stirling PDF-tools wilt verkennen." +title = "Kies hoe u door de tools bladert" +description = "Bekijk beide lay-outs en beslis hoe u de Stirling PDF-tools wilt verkennen." sidebarTitle = "Zijbalkmodus" -sidebarDescription = "Houd tools naast je werkruimte voor snel wisselen." +sidebarDescription = "Houd tools naast uw werkruimte voor snel wisselen." recommended = "Aanbevolen" chooseSidebar = "Zijbalkmodus gebruiken" fullscreenTitle = "Volledig scherm-modus - (verouderd)" -fullscreenDescription = "Blader door alle tools in een catalogus die de werkruimte bedekt totdat je er één kiest." +fullscreenDescription = "Blader door alle tools in een catalogus die de werkruimte bedekt totdat u er een kiest." chooseFullscreen = "Volledig scherm-modus gebruiken" dismiss = "Misschien later" @@ -155,7 +155,7 @@ favorites = "Favorieten" unavailable = "Uitgeschakeld door serverbeheerder:" unavailableDependency = "Niet beschikbaar - vereiste tool ontbreekt op server:" heading = "Alle tools (volledig scherm)" -noResults = "Pas je zoekopdracht aan of schakel beschrijvingen om te vinden wat je nodig hebt." +noResults = "Pas uw zoekopdracht aan of schakel beschrijvingen om te vinden wat u nodig hebt." recommended = "Aanbevolen" unfavorite = "Uit favorieten verwijderen" @@ -164,9 +164,9 @@ fullscreen = "Overschakelen naar volledig scherm" sidebar = "Overschakelen naar zijbalkmodus" [backendStartup] -notFoundTitle = "Backend niet gevonden" +notFoundTitle = "Back-end niet gevonden" retry = "Opnieuw proberen" -unreachable = "De applicatie kan momenteel geen verbinding maken met de backend. Controleer de status van de backend en de netwerkverbinding en probeer het vervolgens opnieuw." +unreachable = "De applicatie kan momenteel geen verbinding maken met de back-end. Controleer de status van de back-end en de netwerkverbinding en probeer het vervolgens opnieuw." [zipWarning] title = "Groot ZIP-bestand" @@ -176,23 +176,23 @@ confirm = "Uitpakken" [defaultApp] title = "Instellen als standaard PDF-app" -message = "Wil je Stirling PDF instellen als je standaard PDF-editor?" -description = "Je kunt dit later wijzigen in je systeeminstellingen." +message = "Wilt u Stirling PDF instellen als standaard PDF-editor?" +description = "U kunt dit later wijzigen in de systeeminstellingen." notNow = "Niet nu" setDefault = "Als standaard instellen" dismiss = "Sluiten" [defaultApp.prompt] title = "Instellen als standaard PDF-editor" -message = "Maak Stirling PDF je standaardapp voor het openen van PDF-bestanden." +message = "Maak Stirling PDF de standaardapp voor het openen van PDF-bestanden." [defaultApp.success] title = "Standaardapp ingesteld" -message = "Stirling PDF is nu je standaard PDF-editor" +message = "Stirling PDF is nu de standaard PDF-editor" [defaultApp.settingsOpened] title = "Instellingen geopend" -message = "Selecteer Stirling PDF in je systeeminstellingen" +message = "Selecteer Stirling PDF in de systeeminstellingen" [defaultApp.error] title = "Fout" @@ -252,23 +252,23 @@ x-large = "Extra groot" [error] pdfPassword = "Het PDF document is beveiligd met een wachtwoord en het wachtwoord is niet ingevoerd of is onjuist" -encryptedPdfMustRemovePassword = "Deze PDF is versleuteld of met een wachtwoord beveiligd. Ontgrendel hem voordat je naar PDF/A converteert." +encryptedPdfMustRemovePassword = "Deze PDF is versleuteld of met een wachtwoord beveiligd. Ontgrendel hem voordat u naar PDF/A converteert." incorrectPasswordProvided = "Het PDF-wachtwoord is onjuist of niet opgegeven." _value = "Fout" dismissAllErrors = "Alle fouten sluiten" sorry = "Excuses voor het probleem!" needHelp = "Hulp nodig / probleem gevonden?" -contactTip = "Als je nog steeds problemen hebt, schroom niet om contact met ons op te nemen voor hulp. Je kan een ticket op onze Github pagina indienen of ons via Discord bereiken:" +contactTip = "Als u nog steeds problemen hebt, schroom niet om contact met ons op te nemen voor hulp. U kunt een ticket op onze Github pagina indienen of ons via Discord bereiken:" github = "Dien een ticket op Github in." -showStack = "Geeft tracering weer" -copyStack = "Kopieer tracering" +showStack = "Tracering weergeven" +copyStack = "Tracering kopiëren" githubSubmit = "GitHub - Dien een ticket in" discordSubmit = "Discord - Maak een support post" [error.404] head = "404 - Pagina niet gevonden | Oeps, we struikelden over de code!" -1 = "We kunnen de pagina die je zoek niet vinden." -2 = "Er ging iets mis." +1 = "We kunnen de pagina die u zoekt niet vinden." +2 = "Er ging iets niet goed." [warning] tooltipTitle = "Waarschuwing" @@ -283,14 +283,14 @@ impressum = "Imprint" showCookieBanner = "Cookievoorkeuren" [pipeline] -header = "Pijplijn menu (Beta)" +header = "Pijplijn-menu (Beta)" uploadButton = "Aangepast uploaden" configureButton = "Configureren" defaultOption = "Aangepast" submitButton = "Opslaan" help = "Pijplijn help" scanHelp = "Map scannen help" -deletePrompt = "Weet je zeker dat je deze pijplijn wil verwijderen?" +deletePrompt = "Weet u zeker dat u deze pijplijn wil verwijderen?" tags = "automatiseren,volgorde,gescrript,batch-verwerking" title = "Pijplijn" @@ -312,14 +312,14 @@ yamlAdvert = "Stirling PDF Pro ondersteunt YAML-configuratie­bestanden en ander ssoAdvert = "Op zoek naar meer gebruikersbeheerfuncties? Bekijk Stirling PDF Pro" [analytics] -title = "Wil je Stirling PDF beter maken?" +title = "Wilt u Stirling PDF beter maken?" paragraph1 = "Stirling PDF heeft opt-in analyses om ons te helpen het product te verbeteren. We volgen geen persoonlijke informatie of bestandsinhoud." paragraph2 = "Overweeg analyses in te schakelen om Stirling PDF te helpen groeien en ons onze gebruikers beter te laten begrijpen." learnMore = "Meer informatie" enable = "Analyses inschakelen" disable = "Analyses uitschakelen" -settings = "Je kunt de instellingen voor analyses wijzigen in het bestand config/settings.yml" -privacyAssurance = "We volgen geen persoonlijke informatie of de inhoud van je bestanden." +settings = "U kunt de instellingen voor analyses wijzigen in het bestand config/settings.yml" +privacyAssurance = "We volgen geen persoonlijke informatie of de inhoud van uw bestanden." [navbar] favorite = "Favorieten" @@ -335,11 +335,15 @@ search = "Zoeken" organize = "Organizeren" convertTo = "Converteren naar PDF" convertFrom = "Converteren van PDF" -security = "Ondertekenen & beveiliging" +security = "Ondertekening & beveiliging" advance = "Geavanceerd" edit = "Bekijken & wijzigen" popular = "Populair" +[footer] +discord = "Discord" +issues = "GitHub" + [settings.preferences] title = "Voorkeuren" @@ -362,7 +366,7 @@ security = "Beveiliging" connections = "Verbindingen" [settings.licensingAnalytics] -title = "Licenties & Analytics" +title = "Licenties & Analyse" plan = "Abonnement" audit = "Audit" usageAnalytics = "Gebruiksstatistieken" @@ -378,7 +382,7 @@ apiKeys = "API-sleutels" [settings.tooltips] enableLoginFirst = "Schakel eerst de loginmodus in" -requiresEnterprise = "Vereist Enterprise-licentie" +requiresEnterprise = "Enterprise-licentie vereist" [settings.connection] title = "Verbindingsmodus" @@ -404,20 +408,20 @@ autoUnzipFileLimitTooltip = "Alleen uitpakken als de ZIP dit aantal bestanden of autoUnzipFileLimit = "Limiet automatisch uitpakken" autoUnzipFileLimitDescription = "Maximaal aantal bestanden om uit ZIP te halen" defaultPdfEditor = "Standaard PDF-editor" -defaultPdfEditorActive = "Stirling PDF is je standaard PDF-editor" +defaultPdfEditorActive = "Stirling PDF is de standaard PDF-editor" defaultPdfEditorInactive = "Een andere app is als standaard ingesteld" defaultPdfEditorChecking = "Controleren..." defaultPdfEditorSet = "Al standaard" setAsDefault = "Als standaard instellen" hideUnavailableTools = "Niet-beschikbare tools verbergen" -hideUnavailableToolsDescription = "Verwijder tools die door je server zijn uitgeschakeld in plaats van ze grijs te tonen." +hideUnavailableToolsDescription = "Verwijder tools die door de server zijn uitgeschakeld in plaats van ze grijs te tonen." hideUnavailableConversions = "Niet-beschikbare conversies verbergen" hideUnavailableConversionsDescription = "Verwijder uitgeschakelde conversie-opties in de tool Converteren in plaats van ze grijs te tonen." [settings.general.enableFeatures] dismiss = "Sluiten" title = "Voor systeembeheerders" -intro = "Schakel gebruikersauthenticatie, teambeheer en werkruimtefuncties in voor je organisatie." +intro = "Schakel gebruikersauthenticatie, teambeheer en werkruimtefuncties in voor uw organisatie." action = "Configureren" and = "en" benefit = "Schakelt gebruikersrollen, teamsamenwerking, beheerdersfuncties en enterprise-functies in." @@ -435,6 +439,25 @@ latestVersion = "Laatste versie" checkForUpdates = "Op updates controleren" viewDetails = "Details bekijken" +[settings.security] +title = "Beveiliging" +description = "Werk uw wachtwoord bij om uw account veilig te houden." + +[settings.security.password] +subtitle = "Wijzig uw wachtwoord. U wordt uitgelogd na het bijwerken." +required = "Alle velden zijn vereist." +mismatch = "Nieuwe wachtwoorden komen niet overeen." +error = "Kan wachtwoord niet bijwerken. Controleer uw huidige wachtwoord en probeer het opnieuw." +success = "Wachtwoord succesvol bijgewerkt. Log alstublieft opnieuw in." +ssoDisabled = "Wachtwoordwijzigingen worden beheerd door uw identiteitsprovider." +current = "Huidig wachtwoord" +currentPlaceholder = "Voer het huidige wachtwoord in" +new = "Nieuw wachtwoord" +newPlaceholder = "Voer een nieuw wachtwoord in" +confirm = "Nieuw wachtwoord bevestigen" +confirmPlaceholder = "Voer uw nieuwe wachtwoord nogmaals in" +update = "Wachtwoord bijwerken" + [settings.hotkeys] title = "Sneltoetsen" description = "Pas sneltoetsen aan voor snelle toegang tot tools. Klik op \"Sneltoets wijzigen\" en druk een nieuwe toetsencombinatie in. Druk op Esc om te annuleren." @@ -443,15 +466,15 @@ searchPlaceholder = "Tools zoeken..." none = "Niet toegewezen" customBadge = "Aangepast" defaultLabel = "Standaard: {{shortcut}}" -capturing = "Toetsen indrukken… (Esc om te annuleren)" +capturing = "Toetsen indrukken... (Esc om te annuleren)" change = "Sneltoets wijzigen" reset = "Reset" shortcut = "Sneltoets" noShortcut = "Geen sneltoets ingesteld" [settings.hotkeys.errorModifier] -mac = "Neem ⌘ (Command), ⌥ (Option) of een andere modificatietoets op in je sneltoets." -windows = "Neem Ctrl, Alt of een andere modificatietoets op in je sneltoets." +mac = "Neem ⌘ (Command), ⌥ (Option) of een andere modificatietoets op in de sneltoets." +windows = "Neem Ctrl, Alt of een andere modificatietoets op in de sneltoets." [update] modalTitle = "Update beschikbaar" @@ -461,7 +484,7 @@ latestStable = "Laatste stabiele" priorityLabel = "Prioriteit" recommendedAction = "Aanbevolen actie" breakingChangesDetected = "Incompatibele wijzigingen gedetecteerd" -breakingChangesMessage = "Sommige versies bevatten incompatibele wijzigingen. Bekijk onderstaande migratiehandleidingen voordat je update." +breakingChangesMessage = "Sommige versies bevatten incompatibele wijzigingen. Bekijk onderstaande migratiehandleidingen voordat u update." migrationGuides = "Migratiehandleidingen" viewGuide = "Handleiding bekijken" loadingDetailedInfo = "Gedetailleerde informatie laden..." @@ -486,13 +509,18 @@ low = "Laag" [changeCreds] title = "Inloggegevens wijzigen" -header = "Werk je accountgegevens bij" -changePassword = "Je gebruikt de standaard inloggegevens. Voer alstublieft een nieuw wachtwoord in" +header = "Werk uw accountgegevens bij" +changePassword = "U gebruikt de standaard inloggegevens. Voer alstublieft een nieuw wachtwoord in" +ssoManaged = "Uw account wordt beheerd door uw identity-provider." newUsername = "Nieuwe gebruikersnaam" oldPassword = "Huidige wachtwoord" newPassword = "Nieuw wachtwoord" confirmNewPassword = "Bevestig nieuw wachtwoord" submit = "Wijzigingen opslaan" +credsUpdated = "Account bijgewerkt" +description = "Wijzigingen opgeslagen. Log alstublieft opnieuw in." +error = "Kan gebruikersnaam niet bijwerken. Controleer het wachtwoord en probeer het opnieuw." +changeUsername = "Werk uw gebruikersnaam bij. U wordt uitgelogd na het bijwerken." [account] title = "Account instellingen" @@ -507,7 +535,7 @@ newPassword = "Nieuw wachtwoord" changePassword = "Wijzig wachtwoord" confirmNewPassword = "Bevestig nieuw wachtwoord" signOut = "Uitloggen" -yourApiKey = "Jouw API sleutel" +yourApiKey = "Uw API-sleutel" syncTitle = "Synchroniseer browserinstellingen met account" settingsCompare = "Instellingen vergelijking:" property = "Eigenschap" @@ -517,11 +545,11 @@ syncToAccount = "Synchroniseer account <- browser" [adminUserSettings] title = "Gebruikersbeheer" -header = "Beheer gebruikers" +header = "Gebruikers beheren" admin = "Beheerder" user = "Gebruiker" -addUser = "Voeg nieuwe gebruiker toe" -deleteUser = "Verwijder gebruiker" +addUser = "Nieuwe gebruiker toevoegen" +deleteUser = "Gebruiker verwijderen" confirmDeleteUser = "Moet deze gebruiker verwijderd worden?" confirmChangeUserStatus = "Moet de gebruiker worden uitgeschakeld/ingeschakeld?" usernameInfo = "Gebruikersnaam kan alleen letters, nummers en de volgende speciale tekens @._+- bevatten of moet een geldig emailadres zijn." @@ -565,7 +593,7 @@ endpoint = "Eindpunt" visits = "Bezoeken" percentage = "Percentage" loading = "Laden..." -failedToLoad = "Het is niet gelukt de endpointgegevens te laden. Probeer te vernieuwen." +failedToLoad = "Het is niet gelukt de eindpuntgegevens te laden. Probeer te vernieuwen." home = "Home" login = "Inloggen" top = "Top" @@ -577,29 +605,29 @@ retry = "Opnieuw proberen" title = "Database Importeer/Exporteer" header = "Database Importeer/Exporteer" fileName = "Bestandsnaam" -creationDate = "Creatiedatum" +creationDate = "Aanmaakdatum" fileSize = "Bestandsgrootte" deleteBackupFile = "Backupbestand verwijderen" importBackupFile = "Backupbestand importeren" createBackupFile = "Back-upbestand maken" downloadBackupFile = "Backupbestand downloaden" -info_1 = "Bij het importeren van gegevens is het cruciaal om de juiste structuur te zorgen voor. Als je niet zeker bent van wat je doet, raadpleeg dan advies en ondersteuning bij een professionele. Een fout in de structuur kan leiden tot toepassingsfouten, waarmee wellicht zelfs de volledige uitvoerbaarheid van de toepassing belemmerd wordt." +info_1 = "Bij het importeren van gegevens is het cruciaal om de juiste structuur te zorgen voor. Als u niet zeker bent van wat u doet, raadpleeg dan advies en ondersteuning bij een professionele. Een fout in de structuur kan leiden tot toepassingsfouten, waarmee wellicht zelfs de volledige uitvoerbaarheid van de toepassing belemmerd wordt." info_2 = "De bestandsnaam maakt geen verschil bij het uploaden. Hij zal later worden herbewoond om de indeling backup_user_yyyyMMddHHmm.sql te volgen, waardoor een consistente bestandsnaamconventie waarborgd wordt." submit = "Backup importeren" -importIntoDatabaseSuccessed = "Importeer naar database succesvol" +importIntoDatabaseSuccessed = "Importeren naar database succesvol" backupCreated = "Databaseback-up geslaagd" -fileNotFound = "File not Found" +fileNotFound = "Bestand niet gevonden" fileNullOrEmpty = "Bestand mag niet null of leeg zijn" -failedImportFile = "Failed Import File" -notSupported = "Deze functie is niet beschikbaar voor je databaseverbinding." +failedImportFile = "Bestand importeren is mislukt" +notSupported = "Deze functie is niet beschikbaar voor de databaseverbinding." [session] -expired = "Je sessie is verlopen. Voer de pagina opnieuw in en probeer het opnieuw." +expired = "Uw sessie is verlopen. Voer de pagina opnieuw in en probeer het opnieuw." refreshPage = "Pagina vernieuwen" [home] -desc = "Jouw lokaal gehoste one-stop-shop voor al je PDF-behoeften." -searchBar = "Zoek naar functies..." +desc = "Uw lokaal gehoste one-stop-shop voor al uw PDF-behoeften." +searchBar = "Functies zoeken..." setFavorites = "Favorieten instellen" hideFavorites = "Favorieten verbergen" showFavorites = "Favorieten tonen" @@ -611,7 +639,7 @@ sortBy = "Sorteren op:" [home.viewPdf] title = "PDF bekijken/bewerken" -desc = "Bekijk, annoteer, voeg tekst of afbeeldingen toe" +desc = "Bekijken, annoteren, tekst of afbeeldingen toevoegen" [home.mobile] brandAlt = "Stirling PDF-logo" @@ -631,17 +659,17 @@ desc = "Pagina's samenvoegen, draaien, herschikken en verwijderen" [home.merge] tags = "combineren,samenvoegen,verenigen" title = "Samenvoegen" -desc = "Voeg eenvoudig meerdere PDF's samen tot één." +desc = "Meerdere PDF-en eenvoudig samenvoegen tot één." [home.split] tags = "splitsen,scheiden,opdelen" title = "Splitsen" -desc = "Splits PDF's in meerdere documenten" +desc = "Splits PDF-en in meerdere documenten" [home.rotate] tags = "draaien,omklappen,oriënteren" title = "Roteren" -desc = "Roteer eenvoudig je PDF's." +desc = "Roteer eenvoudig uw PDF-en." [home.convert] tags = "converteren,wijzigen" @@ -666,17 +694,17 @@ desc = "Ingesloten bestanden (bijlagen) toevoegen aan of verwijderen uit een PDF [home.watermark] tags = "stempel,markeren,overlay" title = "Watermerk toevoegen" -desc = "Voeg een aangepast watermerk toe aan je PDF-document." +desc = "Voeg een aangepast watermerk toe aan uw PDF-document." [home.removePassword] tags = "ontgrendelen" title = "Wachtwoord verwijderen" -desc = "Verwijder wachtwoordbeveiliging van je PDF-document." +desc = "Verwijder wachtwoordbeveiliging van uw PDF-document." [home.compress] tags = "verkleinen,verminderen,optimaliseren" title = "Comprimeren" -desc = "Comprimeer PDF's om hun bestandsgrootte te verkleinen." +desc = "Comprimeer PDF-en om hun bestandsgrootte te verkleinen." [home.unlockPDFForms] tags = "ontgrendelen,inschakelen,bewerken" @@ -710,7 +738,7 @@ desc = "Voegt handtekening toe aan PDF via tekenen, tekst of afbeelding" [home.flatten] tags = "vereenvoudigen,verwijderen,interactief" -title = "Platdrukken" +title = "Afvlakken" desc = "Verwijder alle interactieve elementen en formulieren uit een PDF" [home.certSign] @@ -725,7 +753,7 @@ desc = "Probeert een corrupt/beschadigd PDF te herstellen" [home.removeBlanks] tags = "verwijderen,opschonen,leeg" -title = "Verwijder lege pagina's" +title = "Lege pagina's verwijderen" desc = "Detecteert en verwijdert lege pagina's uit een document" [home.removeAnnotations] @@ -755,7 +783,7 @@ desc = "Maak boekjes met de juiste paginavolgorde en meerpagina-indeling voor af [home.scalePages] tags = "formaat wijzigen,aanpassen,schalen" -title = "Aanpassen paginaformaat/schaal" +title = "Paginaformaat/schaal aanpassen" desc = "Wijzig de grootte/schaal van een pagina en/of de inhoud ervan." [home.addPageNumbers] @@ -780,37 +808,37 @@ desc = "Snijd een PDF bij om de grootte te verkleinen (behoudt tekst!)" [home.autoSplitPDF] tags = "auto,splitsen,QR" -title = "Automatisch splitsen pagina's" +title = "Automatisch pagina's splitsen" desc = "Automatisch splitsen van gescande PDF met fysieke gescande paginasplitter QR-code" [home.sanitize] tags = "opschonen,schonen,verwijderen" -title = "Sanitiseren" +title = "Opschonen" desc = "Potentieel schadelijke elementen uit PDF-bestanden verwijderen" [home.getPdfInfo] tags = "info,metadata,details" -title = "Haal ALLE informatie op over PDF" -desc = "Haalt alle mogelijke informatie op van PDF's" +title = "ALLE informatie over PDF ophalen" +desc = "Haalt alle mogelijke informatie op van PDF-en" [home.pdfToSinglePage] -tags = "combineren,samenvoegen,één" +tags = "combineren,samenvoegen,een,enkel" title = "PDF naar één grote pagina" desc = "Voegt alle PDF-pagina's samen tot één grote pagina" [home.showJS] tags = "javascript,code,script" -title = "Toon Javascript" +title = "Javascript weergeven" desc = "Zoekt en toont ieder script dat in een PDF is geïnjecteerd" [home.redact] tags = "censureren,zwartlakken,verbergen" -title = "Manual Redaction" -desc = "Redacts a PDF based on selected text, drawn shapes and/or selected page(s)" +title = "Redigeren" +desc = "Redigeert een PDF op basis van geselecteerde tekst, getekende vormen en/of geselecteerde pagina('s)" [home.splitBySections] tags = "splitsen,secties,verdelen" -title = "PDF splitsen op secties" +title = "PDF splitsen in secties" desc = "Elke pagina van een PDF opdelen in kleinere horizontale en verticale secties" [home.addStamp] @@ -825,7 +853,7 @@ desc = "Afbeeldingen uit PDF verwijderen om het bestandsgrootte te verminderen" [home.splitByChapters] tags = "splitsen,hoofdstukken,structuur" -title = "PDF op hoofdstukken splitsen" +title = "PDF splitsen in hoofdstukken" desc = "Splits een PDF op basis van zijn hoofdstukstructuur in meerdere bestanden." [home.validateSignature] @@ -851,12 +879,12 @@ desc = "Bladwijzers en inhoudsopgave toevoegen of bewerken in PDF-documenten" [home.manageCertificates] tags = "certificaten,importeren,exporteren" title = "Certificaten beheren" -desc = "Digitale certificaatbestanden importeren, exporteren of verwijderen die worden gebruikt voor het ondertekenen van PDF's." +desc = "Digitale certificaatbestanden importeren, exporteren of verwijderen die worden gebruikt voor het ondertekenen van PDF-en." [home.read] tags = "bekijken,openen,weergeven" title = "Lezen" -desc = "PDF's bekijken en annoteren. Markeer tekst, teken of voeg opmerkingen in voor beoordeling en samenwerking." +desc = "PDF-en bekijken en annoteren. Markeer tekst, teken of voeg opmerkingen in voor beoordeling en samenwerking." [home.reorganizePages] tags = "herordenen,herindelen,organiseren" @@ -871,7 +899,7 @@ desc = "Specifieke pagina's uit een PDF-document extraheren" [home.removePages] tags = "verwijderen,extraheren,uitsluiten" title = "Verwijderen" -desc = "Verwijder ongewenste pagina's uit je PDF-document." +desc = "Verwijder ongewenste pagina's uit uw PDF-document." [home.autoSizeSplitPDF] tags = "auto,splitsen,grootte" @@ -902,7 +930,7 @@ desc = "Link naar handleiding voor air-gapped-installatie" [home.addPassword] title = "Wachtwoord toevoegen" -desc = "Versleutel je PDF-document met een wachtwoord." +desc = "Versleutel uw PDF-document met een wachtwoord." [home.changePermissions] title = "Rechten wijzigen" @@ -914,17 +942,17 @@ title = "Automatiseren" desc = "Bouw workflows met meerdere stappen door PDF-acties te koppelen. Ideaal voor terugkerende taken." [home.overlay-pdfs] -desc = "Plaatst PDF's over een andere PDF heen" -title = "PDF's overlappen" +desc = "Plaatst PDF-en over een andere PDF heen" +title = "PDF-en overlappen" [home.pdfTextEditor] title = "PDF-teksteditor" -desc = "Bewerk bestaande tekst en afbeeldingen in PDF's" +desc = "Bewerk bestaande tekst en afbeeldingen in PDF-en" [home.addText] tags = "tekst,annotatie,label" title = "Tekst toevoegen" -desc = "Voeg overal in je PDF aangepaste tekst toe" +desc = "Voeg overal in uw PDF aangepaste tekst toe" [landing] addFiles = "Bestanden toevoegen" @@ -958,8 +986,8 @@ moveLeft = "Naar links verplaatsen" moveRight = "Naar rechts verplaatsen" delete = "Verwijderen" dragDropMessage = "Pagina('s) geselecteerd" -undo = "Undo" -redo = "Redo" +undo = "Undo (CTRL + Z)" +redo = "Redo (CTRL + Y)" [merge] tags = "samenvoegen,pagina bewerkingen,serverzijde" @@ -990,7 +1018,7 @@ descending = "Aflopend" sort = "Sorteren" [merge.error] -failed = "Er is een fout opgetreden bij het samenvoegen van de PDF's." +failed = "Er is een fout opgetreden bij het samenvoegen van de PDF-en." [merge.tooltip.header] title = "Overzicht instellingen samenvoegen" @@ -1004,8 +1032,8 @@ selectMethod = "Selecteer een splitsmethode" resultsTitle = "Splitsresultaten" [split.desc] -1 = "De nummers die je kiest zijn de paginanummers waarop je een splitsing wilt uitvoeren" -2 = "Als zodanig selecteren van 1,3,7-9 zou een 10 pagina's tellend document splitsen in 6 aparte PDF's met:" +1 = "De nummers die u kiest zijn de paginanummers waarop u een splitsing wilt uitvoeren" +2 = "Als zodanig selecteren van 1,3,7-9 zou een 10 pagina's tellend document splitsen in 6 aparte PDF-en met:" 3 = "Document #1: Pagina 1" 4 = "Document #2: Pagina 2 en 3" 5 = "Document #3: Pagina 4, 5, 6 en 7" @@ -1025,7 +1053,7 @@ failed = "Er is een fout opgetreden bij het splitsen van de PDF." [split.method] label = "Kies een splitsmethode" -placeholder = "Selecteer hoe je de PDF wilt splitsen" +placeholder = "Selecteer hoe u de PDF wilt splitsen" [split.methods.prefix] splitAt = "Splitsen op" @@ -1054,7 +1082,7 @@ tooltip = "Voer het aantal pagina's in voor elk gesplitst bestand" [split.methods.byDocCount] name = "Aantal documenten" desc = "Specifiek aantal bestanden maken" -tooltip = "Voer in hoeveel bestanden je wilt maken" +tooltip = "Voer in hoeveel bestanden u wilt maken" [split.methods.byChapters] name = "Hoofdstukken" @@ -1083,7 +1111,7 @@ title = "Overzicht splitsmethoden" [split.tooltip.byPages] title = "Splitsen op paginanummers" -text = "Splits je PDF op specifieke paginanummers. Met 'n' wordt gesplitst na pagina n. Met 'n-m' wordt gesplitst vóór pagina n en na pagina m." +text = "Splits de PDF op specifieke paginanummers. Met 'n' wordt gesplitst na pagina n. Met 'n-m' wordt gesplitst vóór pagina n en na pagina m." bullet1 = "Enkele splitspunten: 3,7 (splitst na pagina's 3 en 7)" bullet2 = "Reeks-splitspunten: 3-8 (splitst vóór pagina 3 en na pagina 8)" bullet3 = "Gemengd: 2,5-10,15 (splitst na pagina 2, vóór pagina 5, na pagina 10 en na pagina 15)" @@ -1093,25 +1121,25 @@ title = "Splitsen op rastersecties" text = "Deel elke pagina op in een raster van secties. Handig voor documenten met meerdere kolommen of het extraheren van specifieke gebieden." bullet1 = "Horizontaal: aantal rijen om te maken" bullet2 = "Verticaal: aantal kolommen om te maken" -bullet3 = "Samenvoegen: alle secties combineren in één PDF" +bullet3 = "Samenvoegen: alle secties combineren in een PDF" [split.tooltip.bySize] title = "Splitsen op bestandsgrootte" -text = "Maak meerdere PDF's die een opgegeven bestandsgrootte niet overschrijden. Ideaal bij limieten of e-mailbijlagen." +text = "Maak meerdere PDF-en die een opgegeven bestandsgrootte niet overschrijden. Ideaal bij limieten of e-mailbijlagen." bullet1 = "Gebruik MB voor grotere bestanden (bijv. 10MB)" bullet2 = "Gebruik KB voor kleinere bestanden (bijv. 500KB)" bullet3 = "Het systeem splitst op paginagrens" [split.tooltip.byCount] title = "Splitsen op aantal" -text = "Maak meerdere PDF's met een specifiek aantal pagina's of documenten elk." +text = "Maak meerdere PDF-en met een specifiek aantal pagina's of documenten elk." bullet1 = "Aantal pagina's: vast aantal pagina's per bestand" bullet2 = "Aantal documenten: vast aantal uitvoerbestanden" bullet3 = "Handig voor batchverwerkingsworkflows" [split.tooltip.byChapters] title = "Splitsen op hoofdstukken" -text = "Gebruik PDF-bladwijzers om automatisch te splitsen op hoofdstukgrenzen. Vereist PDF's met bladwijzerstructuur." +text = "Gebruik PDF-bladwijzers om automatisch te splitsen op hoofdstukgrenzen. Vereist PDF-en met bladwijzerstructuur." bullet1 = "Bladwijzerniveau: welk niveau om op te splitsen (1=bovenste niveau)" bullet2 = "Metadata opnemen: documenteigenschappen behouden" bullet3 = "Duplicaten toestaan: herhaalde bladwijzernamen afhandelen" @@ -1119,7 +1147,7 @@ bullet3 = "Duplicaten toestaan: herhaalde bladwijzernamen afhandelen" [split.tooltip.byDocCount] bullet1 = "Voer het aantal gewenste uitvoerbestanden in" bullet2 = "Pagina's worden zo gelijk mogelijk verdeeld" -bullet3 = "Handig wanneer je een specifiek aantal bestanden nodig hebt" +bullet3 = "Handig wanneer u een specifiek aantal bestanden nodig hebt" text = "Maak een specifiek aantal uitvoerbestanden door pagina's gelijkmatig te verdelen." title = "Splitsen op aantal documenten" @@ -1127,27 +1155,27 @@ title = "Splitsen op aantal documenten" bullet1 = "Voer het aantal pagina's per uitvoerbestand in" bullet2 = "Het laatste bestand kan minder pagina's hebben als het niet gelijkmatig deelbaar is" bullet3 = "Handig voor batchverwerkingsworkflows" -text = "Maak meerdere PDF's met een specifiek aantal pagina's elk. Perfect voor uniforme documentdelen." +text = "Maak meerdere PDF-en met een specifiek aantal pagina's elk. Perfect voor uniforme documentdelen." title = "Splitsen op aantal pagina's" [split.tooltip.byPageDivider] bullet1 = "Print scheidingsvellen via de downloadlink" -bullet2 = "Plaats scheidingsvellen tussen je documenten" +bullet2 = "Plaats scheidingsvellen tussen uw documenten" bullet3 = "Scan alle documenten samen als één PDF" bullet4 = "Uploaden - scheidingspagina's worden automatisch gedetecteerd en verwijderd" -bullet5 = "Schakel Duplex-modus in als je beide zijden van scheidingsvellen scant" +bullet5 = "Schakel Duplex-modus in als u beide zijden van scheidingsvellen scant" text = "Scans automatisch splitsen met fysieke scheidingsvellen met QR-codes. Perfect voor meerdere documenten die samen zijn gescand." title = "Splitsen met paginascheider" [split.methodSelection.tooltip] bullet1 = "Klik op een methodekaart om te selecteren" bullet2 = "Beweeg over elke kaart om een korte beschrijving te zien" -bullet3 = "De instellingenstap verschijnt nadat je een methode hebt geselecteerd" -bullet4 = "Je kunt de methode op elk moment wijzigen vóór verwerking" -title = "Kies je splitsmethode" +bullet3 = "De instellingenstap verschijnt nadat u een methode hebt geselecteerd" +bullet4 = "U kunt de methode op elk moment wijzigen vóór verwerking" +title = "Kies de splitsmethode" [split.methodSelection.tooltip.header] -text = "Kies hoe je je PDF-document wilt splitsen. Elke methode is geoptimaliseerd voor verschillende use-cases en documenttypen." +text = "Kies hoe u het PDF-document wilt splitsen. Elke methode is geoptimaliseerd voor verschillende use-cases en documenttypen." title = "Selectie splitsmethode" [rotate] @@ -1167,7 +1195,7 @@ title = "Rotatievoorbeeld" title = "Overzicht rotatie-instellingen" [rotate.tooltip.description] -text = "Draai je PDF-pagina's met de klok mee of tegen de klok in in stappen van 90 graden. Alle pagina's in de PDF worden gedraaid. Het voorbeeld toont hoe je document eruitziet na het draaien." +text = "Draai uw PDF-pagina's met de klok mee of tegen de klok in in stappen van 90 graden. Alle pagina's in de PDF worden gedraaid. Het voorbeeld toont hoe u document eruitziet na het draaien." [rotate.tooltip.controls] title = "Bediening" @@ -1206,7 +1234,7 @@ fillPage = "Pagina vullen" autoRotate = "Automatisch roteren" autoRotateDescription = "Afbeeldingen automatisch draaien zodat ze beter op de PDF-pagina passen" combineImages = "Afbeeldingen combineren" -combineImagesDescription = "Combineer alle afbeeldingen in één PDF, of maak afzonderlijke PDF's voor elke afbeelding" +combineImagesDescription = "Combineer alle afbeeldingen in één PDF, of maak afzonderlijke PDF-en voor elke afbeelding" webOptions = "Web-naar-PDF-opties" zoomLevel = "Zoomniveau" emailOptions = "E-mail-naar-PDF-opties" @@ -1260,7 +1288,7 @@ multi = "Meerdere afbeeldingen, één afbeelding per pagina" colorType = "Kleurtype" color = "Kleur" grey = "Grijstinten" -blackwhite = "Zwart en wit (kan data verliezen!)" +blackwhite = "Zwart en wit (kans op gegevensverlies!)" submit = "Omzetten" info = "Python is niet geïnstalleerd. Vereist voor WebP-conversie." placeholder = "(bijv. 1,2,8 of 4,7,12-16 of 2n-1)" @@ -1287,11 +1315,11 @@ _value = "Modus" 11 = "Alle pagina's dupliceren" [pdfOrganiser.mode.desc] -BOOKLET_SORT = "Pagina's rangschikken voor boekjes afdrukken (laatste, eerste, tweede, een-na-laatste, …)." +BOOKLET_SORT = "Pagina's rangschikken voor boekjes afdrukken (laatste, eerste, tweede, een-na-laatste, ...)." CUSTOM = "Gebruik een aangepaste reeks paginanummers of expressies om een nieuwe volgorde te definiëren." -DUPLEX_SORT = "Voorkanten en daarna achterkanten verweven alsof een duplexscanner eerst alle voorkanten en daarna alle achterkanten heeft gescand (1, n, 2, n-1, …)." +DUPLEX_SORT = "Voorkanten en daarna achterkanten verweven alsof een duplexscanner eerst alle voorkanten en daarna alle achterkanten heeft gescand (1, n, 2, n-1, ...)." DUPLICATE = "Dupliceer elke pagina volgens het aantal in de aangepaste volgorde (bijv. 4 duplicaten betekent elke pagina 4×)." -ODD_EVEN_MERGE = "Twee PDF's samenvoegen door pagina's af te wisselen: oneven uit de eerste, even uit de tweede." +ODD_EVEN_MERGE = "Twee PDF-en samenvoegen door pagina's af te wisselen: oneven uit de eerste, even uit de tweede." ODD_EVEN_SPLIT = "Het document splitst in twee uitvoerbestanden: alle oneven pagina's en alle even pagina's." REMOVE_FIRST = "De eerste pagina uit het document verwijderen." REMOVE_FIRST_AND_LAST = "Zowel de eerste als de laatste pagina uit het document verwijderen." @@ -1302,11 +1330,11 @@ SIDE_STITCH_BOOKLET_SORT = "Pagina's rangschikken voor zijkant-geniete boekjes ( [pdfOrganiser.desc] CUSTOM = "Gebruik een aangepaste reeks paginanummers of expressies om een nieuwe volgorde te definiëren." REVERSE_ORDER = "Document omdraaien zodat de laatste pagina de eerste wordt, enzovoort." -DUPLEX_SORT = "Voorkanten en daarna achterkanten verweven alsof een duplexscanner eerst alle voorkanten en daarna alle achterkanten heeft gescand (1, n, 2, n-1, …)." -BOOKLET_SORT = "Pagina's rangschikken voor boekjes afdrukken (laatste, eerste, tweede, een-na-laatste, …)." +DUPLEX_SORT = "Voorkanten en daarna achterkanten verweven alsof een duplexscanner eerst alle voorkanten en daarna alle achterkanten heeft gescand (1, n, 2, n-1, ...)." +BOOKLET_SORT = "Pagina's rangschikken voor boekjes afdrukken (laatste, eerste, tweede, een-na-laatste, ...)." SIDE_STITCH_BOOKLET_SORT = "Pagina's rangschikken voor zijkant-geniete boekjes (geoptimaliseerd voor binden aan de zijkant)." ODD_EVEN_SPLIT = "Het document splitst in twee uitvoerbestanden: alle oneven pagina's en alle even pagina's." -ODD_EVEN_MERGE = "Twee PDF's samenvoegen door pagina's af te wisselen: oneven uit de eerste, even uit de tweede." +ODD_EVEN_MERGE = "Twee PDF-en samenvoegen door pagina's af te wisselen: oneven uit de eerste, even uit de tweede." DUPLICATE = "Dupliceer elke pagina volgens het aantal in de aangepaste volgorde (bijv. 4 duplicaten betekent elke pagina 4×)." REMOVE_FIRST = "Verwijder de eerste pagina uit het document." REMOVE_LAST = "Verwijder de laatste pagina uit het document." @@ -1327,15 +1355,15 @@ label = "Afbeeldingsbestand" configure = "Afbeelding configureren" [addImage.step] -createDesc = "Upload de afbeelding die je wilt toevoegen" +createDesc = "Upload de afbeelding die u wilt toevoegen" place = "Afbeelding plaatsen" -placeDesc = "Klik op de PDF om je afbeelding toe te voegen" +placeDesc = "Klik op de PDF om uw afbeelding toe te voegen" [addImage.instructions] title = "Afbeeldingen toevoegen" -text = "Klik na het uploaden van je afbeelding ergens op de PDF om deze te plaatsen." +text = "Klik na het uploaden van de afbeelding ergens op de PDF om deze te plaatsen." paused = "Plaatsing gepauzeerd" -resumeHint = "Hervat de plaatsing om te klikken en je afbeelding toe te voegen." +resumeHint = "Hervat de plaatsing om te klikken en uw afbeelding toe te voegen." noSignature = "Upload hierboven een afbeelding om te kunnen plaatsen." [addImage.mode] @@ -1583,7 +1611,7 @@ tabTitle = "Werkruimte inhoud" subtitle = "Importeer bladwijzers, bouw hiërarchieën en pas de inhoud toe zonder krappe zijpanelen." noFile = "Geen PDF geselecteerd" fileLabel = "Wijzigingen worden toegepast op de momenteel geselecteerde PDF." -filePrompt = "Selecteer een PDF uit je bibliotheek of upload een nieuwe om te beginnen." +filePrompt = "Selecteer een PDF uit uw bibliotheek of upload een nieuwe om te beginnen." changeFile = "PDF wijzigen" selectFile = "PDF selecteren" @@ -1593,7 +1621,7 @@ description = "Selecteer de tool Inhoudsopgave bewerken om de werkruimte te lade [editTableOfContents.editor] heading = "Bladwijzer-editor" -description = "Voeg bladwijzers toe, nestel ze en wijzig de volgorde om je PDF-inhoud te maken." +description = "Voeg bladwijzers toe, nestel ze en wijzig de volgorde om uw PDF-inhoud te maken." addTopLevel = "Bladwijzer op hoogste niveau toevoegen" defaultTitle = "Nieuwe bladwijzer" defaultChildTitle = "Onderliggende bladwijzer" @@ -1605,7 +1633,7 @@ confirmRemove = "Deze bladwijzer en alle onderliggende verwijderen?" [editTableOfContents.editor.empty] title = "Nog geen bladwijzers" -description = "Importeer bestaande bladwijzers of begin met je eerste item toe te voegen." +description = "Importeer bestaande bladwijzers of begin met uw eerste item toe te voegen." action = "Eerste bladwijzer toevoegen" [editTableOfContents.editor.field] @@ -1624,7 +1652,7 @@ loadedBody = "Bestaande bladwijzers uit de PDF zijn in de editor geladen." noBookmarks = "Geen bladwijzers gevonden in de geselecteerde PDF." loadFailed = "Kan geen bladwijzers uit de geselecteerde PDF extraheren." imported = "Bladwijzers geïmporteerd" -importedBody = "Je JSON-inhoud heeft de huidige editorinhoud vervangen." +importedBody = "De JSON-inhoud heeft de huidige editorinhoud vervangen." importedClipboard = "Klembordgegevens hebben de huidige bladwijzerlijst vervangen." invalidJson = "Ongeldige JSON-structuur" invalidJsonBody = "Geef een geldig bladwijzer-JSON-bestand op en probeer het opnieuw." @@ -1765,10 +1793,10 @@ description = "Voer cijfers gescheiden door komma's in." title = "Afzonderlijke pagina's" [pageSelection.tooltip.mathematical] -bullet1 = "2n → alle even pagina's (2, 4, 6…)" -bullet2 = "2n-1 → alle oneven pagina's (1, 3, 5…)" -bullet3 = "3n → elke 3e pagina (3, 6, 9…)" -bullet4 = "4n-1 → pagina's 3, 7, 11, 15…" +bullet1 = "2n → alle even pagina's (2, 4, 6...)" +bullet2 = "2n-1 → alle oneven pagina's (1, 3, 5...)" +bullet3 = "3n → elke 3e pagina (3, 6, 9...)" +bullet4 = "4n-1 → pagina's 3, 7, 11, 15..." description = "Gebruik n in formules voor patronen." title = "Wiskundige functies" @@ -1926,7 +1954,7 @@ valuePlaceholder = "Aangepaste waarde" remove = "Verwijderen" [changeMetadata.results] -title = "Bijgewerkte PDF's" +title = "Bijgewerkte PDF-en" [changeMetadata.error] failed = "Er is een fout opgetreden bij het wijzigen van de PDF-metadata." @@ -2068,7 +2096,7 @@ title = "Geavanceerde OCR-verwerking" [ocr.tooltip.advanced.compatibility] title = "Compatibiliteitsmodus" -text = "Gebruikt OCR-'sandwich PDF'-modus: resulteert in grotere bestanden, maar betrouwbaarder met bepaalde talen en oudere PDF-software. Standaard gebruiken we hOCR voor kleinere, moderne PDF's." +text = "Gebruikt OCR-'sandwich PDF'-modus: resulteert in grotere bestanden, maar betrouwbaarder met bepaalde talen en oudere PDF-software. Standaard gebruiken we hOCR voor kleinere, moderne PDF-en." [ocr.tooltip.advanced.sidecar] title = "Tekstbestand maken" @@ -2095,7 +2123,7 @@ title = "Afbeeldingen extraheren" header = "Afbeeldingen extraheren" selectText = "Selecteer het beeldformaat voor geëxtraheerde afbeeldingen" allowDuplicates = "Dubbele afbeeldingen opslaan" -submit = "Extraheer" +submit = "Extraheren" [extractImages.settings] title = "Instellingen" @@ -2205,7 +2233,7 @@ headsUpDesc = "Overlappende foto's of achtergronden die qua kleur erg op de foto [sign] title = "Ondertekenen" -header = "PDF's ondertekenen" +header = "PDF-en ondertekenen" upload = "Upload afbeelding" clear = "Wissen" add = "Toevoegen" @@ -2233,9 +2261,9 @@ title = "Teken uw handtekening" clear = "Wissen" [sign.canvas] -heading = "Teken je handtekening" +heading = "Teken uw handtekening" clickToOpen = "Klik om het tekenvenster te openen" -modalTitle = "Teken je handtekening" +modalTitle = "Teken uw handtekening" colorLabel = "Kleur" penSizeLabel = "Pendikte" penSizePlaceholder = "Grootte" @@ -2256,7 +2284,7 @@ description = "Gebruik opgeslagen handtekeningen op elk moment opnieuw." emptyTitle = "Nog geen opgeslagen handtekeningen" emptyDescription = "Teken, upload of typ hierboven een handtekening en kies vervolgens 'Opslaan in bibliotheek' om tot {{max}} favorieten paraat te hebben." limitTitle = "Limiet bereikt" -limitDescription = "Verwijder een opgeslagen handtekening voordat je nieuwe toevoegt (max. {{max}})." +limitDescription = "Verwijder een opgeslagen handtekening voordat u nieuwe toevoegt (max. {{max}})." carouselPosition = "{{current}} van {{total}}" prev = "Vorige" next = "Volgende" @@ -2272,7 +2300,7 @@ saveShared = "Als gedeeld opslaan" saveUnavailable = "Maak eerst een handtekening om deze op te slaan." noChanges = "De huidige handtekening is al opgeslagen." tempStorageTitle = "Tijdelijke browseropslag" -tempStorageDescription = "Handtekeningen worden alleen in je browser opgeslagen. Ze gaan verloren als je je browsergegevens wist of van browser wisselt." +tempStorageDescription = "Handtekeningen worden alleen in de browser opgeslagen. Ze gaan verloren als u de browsergegevens wist of van browser wisselt." personalHeading = "Persoonlijke handtekeningen" sharedHeading = "Gedeelde handtekeningen" personalDescription = "Alleen jij kunt deze handtekeningen zien." @@ -2290,9 +2318,9 @@ saved = "Opgeslagen" configure = "Handtekening configureren" [sign.step] -createDesc = "Kies hoe je de handtekening wilt maken" +createDesc = "Kies hoe u de handtekening wilt maken" place = "Plaatsen en opslaan" -placeDesc = "Plaats de handtekening op je PDF" +placeDesc = "Plaats de handtekening op uw PDF" [sign.type] title = "Type handtekening" @@ -2314,7 +2342,7 @@ image = "Na het uploaden van uw handtekeningafbeelding hierboven, klik ergens op saved = "Selecteer hierboven een opgeslagen handtekening en klik vervolgens ergens op de PDF om deze te plaatsen." text = "Na het invoeren van uw naam hierboven, klik ergens op de PDF om uw handtekening te plaatsen." paused = "Plaatsing gepauzeerd" -resumeHint = "Hervat de plaatsing om te klikken en je handtekening toe te voegen." +resumeHint = "Hervat de plaatsing om te klikken en uw handtekening toe te voegen." noSignature = "Maak hierboven een handtekening om de plaatsingstools in te schakelen." [sign.mode] @@ -2331,7 +2359,7 @@ failed = "Er is een fout opgetreden bij het ondertekenen van de PDF." [flatten] title = "Afvlakken" -header = "PDF's afvlakken" +header = "PDF-en afvlakken" flattenOnlyForms = "Alleen formulieren afvlakken" submit = "Afvlakken" filenamePrefix = "afgevlakt" @@ -2358,7 +2386,7 @@ title = "Resultaten afvlakken" failed = "Er is een fout opgetreden bij het afvlakken van de PDF." [flatten.tooltip.header] -title = "Over PDF's afvlakken" +title = "Over PDF-en afvlakken" [flatten.tooltip.description] title = "Wat doet afvlakken?" @@ -2379,7 +2407,7 @@ bullet4 = "Bladwijzers helpen u nog steeds te navigeren" [repair] tags = "repareren,herstellen,correctie,terughalen" title = "Repareren" -header = "PDF's repareren" +header = "PDF-en repareren" submit = "Repareren" description = "Deze tool probeert corrupte of beschadigde PDF-bestanden te repareren. Er zijn geen extra instellingen nodig." filenamePrefix = "gerepareerd" @@ -2466,17 +2494,17 @@ failed = "Er is een fout opgetreden bij het verwijderen van aantekeningen uit de [compare] tags = "onderscheiden,contrasteren,veranderingen,analyse" title = "Vergelijken" -header = "PDF's vergelijken" +header = "PDF-en vergelijken" clearSelected = "Selectie wissen" -addFilesHint = "Voeg PDF's toe in de stap Bestanden om selectie mogelijk te maken." -noFiles = "Nog geen PDF's beschikbaar" +addFilesHint = "Voeg PDF-en toe in de stap Bestanden om selectie mogelijk te maken." +noFiles = "Nog geen PDF-en beschikbaar" pages = "Pagina's" cta = "Vergelijken" loading = "Bezig met vergelijken..." newLine = "nieuwe-regel" [compare.clear] -confirmTitle = "Geselecteerde PDF's wissen?" +confirmTitle = "Geselecteerde PDF-en wissen?" confirmBody = "Dit sluit de huidige vergelijking en brengt u terug naar Actieve bestanden." confirm = "Wissen en terugkeren" @@ -2495,7 +2523,7 @@ label = "Bewerkt document" placeholder = "Selecteer de bewerkte PDF" [compare.selection] -originalEditedTitle = "Originele en bewerkte PDF's selecteren" +originalEditedTitle = "Originele en bewerkte PDF-en selecteren" [compare.original] label = "Originele PDF" @@ -2517,7 +2545,7 @@ pageLabel = "Pagina" pageNotReadyTitle = "Pagina nog niet gerenderd" pageNotReadyBody = "Sommige pagina's worden nog gerenderd. De navigatie klikt vast zodra ze gereed zijn." rendering = "renderen" -inProgress = "Ten minste een van deze PDF's is zeer groot, scrollen verloopt niet soepel totdat het renderen is voltooid" +inProgress = "Ten minste een van deze PDF-en is zeer groot, scrollen verloopt niet soepel totdat het renderen is voltooid" pagesRendered = "pagina's gerenderd" complete = "Renderen voltooid" @@ -2556,10 +2584,10 @@ complete = "Vergelijking gereed" [compare.longJob] title = "Grote vergelijking bezig" -body = "Deze PDF's overschrijden samen 2,000 pagina's. De verwerking kan enkele minuten duren." +body = "Deze PDF-en overschrijden samen 2,000 pagina's. De verwerking kan enkele minuten duren." [compare.slowOperation] -title = "Nog bezig…" +title = "Nog bezig..." body = "Deze vergelijking duurt langer dan normaal. U kunt het laten doorgaan of annuleren." cancel = "Vergelijking annuleren" @@ -2576,7 +2604,7 @@ message = "Een of beide geselecteerde PDF-bestanden bevatten geen tekstinhoud. K message = "Deze documenten lijken sterk van elkaar te verschillen. De vergelijking is gestopt om tijd te besparen." [compare.earlyDissimilarity] -title = "Deze PDF's verschillen sterk" +title = "Deze PDF-en verschillen sterk" body = "We zien tot nu toe zeer weinig overeenkomsten. U kunt de vergelijking stoppen als dit geen verwante documenten zijn." stopButton = "Vergelijking stoppen" @@ -2594,7 +2622,7 @@ logoTitle = "Logo" name = "Naam" noLogo = "Geen logo" pageNumber = "Paginanummer" -password = "Voer je sleutelopslag of privésleutel wachtwoord in (indien van toepassing):" +password = "Voer de sleutelopslag of privésleutel wachtwoord in (indien van toepassing):" passwordOptional = "Leeg laten als er geen wachtwoord is" reason = "Reden" serverCertMessage = "Servercertificaat gebruiken - geen bestanden of wachtwoord nodig" @@ -2668,7 +2696,7 @@ title = "Over het beheren van handtekeningen" [certSign.tooltip.overview] title = "Wat kan deze tool doen?" -text = "Met deze tool kunt u controleren of uw PDF's digitaal zijn ondertekend en nieuwe digitale handtekeningen toevoegen. Digitale handtekeningen bewijzen wie een document heeft gemaakt of goedgekeurd en tonen of het sinds de ondertekening is gewijzigd." +text = "Met deze tool kunt u controleren of uw PDF-en digitaal zijn ondertekend en nieuwe digitale handtekeningen toevoegen. Digitale handtekeningen bewijzen wie een document heeft gemaakt of goedgekeurd en tonen of het sinds de ondertekening is gewijzigd." bullet1 = "Controleer bestaande handtekeningen en hun geldigheid" bullet2 = "Bekijk gedetailleerde informatie over ondertekenaars en certificaten" bullet3 = "Voeg nieuwe digitale handtekeningen toe om uw documenten te beveiligen" @@ -2701,7 +2729,7 @@ text = "Het is een veilige ID voor uw handtekening die bewijst dat u hebt ondert [certSign.certType.tooltip.which] title = "Welke optie moet ik gebruiken?" text = "Kies de indeling die overeenkomt met uw certificaatbestand:" -bullet1 = "PKCS#12 (.p12 / .pfx) – één gecombineerd bestand (meest voorkomend)" +bullet1 = "PKCS#12 (.p12 / .pfx) – een gecombineerd bestand (meest voorkomend)" bullet2 = "PFX (.pfx) – Microsofts versie van PKCS12" bullet3 = "PEM – aparte .pem-bestanden voor privésleutel en certificaat" bullet4 = "JKS – Java .jks-keystore voor dev-/CI-CD-workflows" @@ -2956,7 +2984,7 @@ failed = "PDF bijsnijden mislukt" selectArea = "Selecteer bijsnijgebied" [crop.tooltip] -title = "Hoe PDF's bijsnijden" +title = "PDF-en bijsnijden" description = "Selecteer het gebied om bij te snijden in uw PDF door de blauwe overlay op de miniatuur te slepen en te schalen." drag = "Sleep de overlay om het bijsnijgebied te verplaatsen" resize = "Sleep aan de hoek- en randgrepen om te schalen" @@ -2966,14 +2994,14 @@ precision = "Gebruik coördinatenvelden voor nauwkeurige positionering" title = "Resultaten bijsnijden" [crop.automation] -info = "Voer bijsnijcoördinaten in PDF-punten in. Oorsprong (0,0) bevindt zich linksonder. Deze waarden worden toegepast op alle PDF's die in deze automatisering worden verwerkt." +info = "Voer bijsnijcoördinaten in PDF-punten in. Oorsprong (0,0) bevindt zich linksonder. Deze waarden worden toegepast op alle PDF-en die in deze automatisering worden verwerkt." reference = "Referentie: A4-pagina is 595,28 × 841,89 punten (210mm × 297mm). 1 inch = 72 punten." [autoSplitPDF] tags = "QR-gebaseerd,scheiden,scan-segment,organiseren" title = "PDF automatisch splitsen" header = "PDF automatisch splitsen" -description = "Print, Voeg in, Scan, upload, en laat ons je documenten automatisch scheiden. Geen handmatig sorteerwerk nodig." +description = "Print, Voeg in, Scan, upload, en laat ons uw documenten automatisch scheiden. Geen handmatig sorteerwerk nodig." formPrompt = "Dien PDF in met Stirling-PDF Pagina-scheiders:" duplexMode = "Duplex Modus (voor- en achterkant scannen)" dividerDownload2 = "Download 'Auto Splitter Divider (with instructions).pdf'" @@ -2981,7 +3009,7 @@ submit = "Indienen" [autoSplitPDF.selectText] 1 = "Print enkele scheidingsbladen van hieronder (Zwart-wit is prima)." -2 = "Scan al je documenten tegelijk door het scheidingsblad ertussen te plaatsen." +2 = "Scan al uw documenten tegelijk door het scheidingsblad ertussen te plaatsen." 3 = "Upload het enkele grote gescande PDF-bestand en laat Stirling PDF de rest afhandelen." 4 = "Scheidingspagina's worden automatisch gedetecteerd en verwijderd, wat een net einddocument garandeert." @@ -3263,8 +3291,8 @@ tags = "pdf,splitsen,document,organiseren" [overlay-pdfs] tags = "Overlappen" header = "PDF bestanden overlappen" -title = "PDF's over elkaar leggen" -desc = "Leg één PDF over een andere heen" +title = "PDF-en over elkaar leggen" +desc = "Leg een PDF over een andere heen" submit = "Indienen" [overlay-pdfs.baseFile] @@ -3273,7 +3301,7 @@ label = "Selecteer basis PDF-bestand" [overlay-pdfs.overlayFiles] label = "Selecteer overlappende PDF-bestanden" placeholder = "Kies PDF('s)..." -addMore = "Meer PDF's toevoegen..." +addMore = "Meer PDF-en toevoegen..." [overlay-pdfs.mode] label = "Selecteer overlappingsmodus" @@ -3299,11 +3327,11 @@ title = "Instellingen" title = "Resultaten overlay" [overlay-pdfs.tooltip.header] -title = "Overzicht PDF's over elkaar leggen" +title = "Overzicht PDF-en over elkaar leggen" [overlay-pdfs.tooltip.description] title = "Beschrijving" -text = "Combineer een basis-PDF met een of meer overlay-PDF's. Overlays kunnen pagina-voor-pagina in verschillende modi worden toegepast en in de voorgrond of achtergrond worden geplaatst." +text = "Combineer een basis-PDF met een of meer overlay-PDF-en. Overlays kunnen pagina-voor-pagina in verschillende modi worden toegepast en in de voorgrond of achtergrond worden geplaatst." [overlay-pdfs.tooltip.mode] title = "Overlaymodus" @@ -3318,21 +3346,21 @@ text = "Voorgrond plaatst de overlay boven op de pagina. Achtergrond plaatst dez [overlay-pdfs.tooltip.overlayFiles] title = "Overlay-bestanden" -text = "Selecteer een of meer PDF's om op de basis te leggen. De volgorde van deze bestanden beïnvloedt hoe pagina's worden toegepast in Sequentiële en Vaste herhalingsmodus." +text = "Selecteer een of meer PDF-en om op de basis te leggen. De volgorde van deze bestanden beïnvloedt hoe pagina's worden toegepast in Sequentiële en Vaste herhalingsmodus." [overlay-pdfs.tooltip.counts] title = "Aantallen (alleen Vaste herhaling)" text = "Geef een positief getal op voor elk overlay-bestand dat aangeeft hoeveel pagina's moeten worden genomen voordat wordt doorgeschakeld. Vereist wanneer de modus Vaste herhaling is." [overlay-pdfs.error] -failed = "Er is een fout opgetreden bij het over elkaar leggen van PDF's." +failed = "Er is een fout opgetreden bij het over elkaar leggen van PDF-en." [split-by-sections] tags = "Sectie splitsen, Verdelen, Aanpassen" title = "PDF in secties splitsen" header = "PDF in secties splitsen" submit = "PDF splitsen" -merge = "Samenvoegen in één PDF" +merge = "Samenvoegen in een PDF" [split-by-sections.horizontal] label = "Horizontale secties" @@ -3533,7 +3561,7 @@ signInWith = "Inloggen met" signInAnonymously = "Als gast aanmelden" rememberme = "Onthoud mij" invalid = "Ongeldige gebruikersnaam of wachtwoord." -locked = "Je account is geblokkeerd." +locked = "Uw account is geblokkeerd." sessionExpired = "Uw sessie is verlopen. Log alstublieft opnieuw in." signinTitle = "Gelieve in te loggen" ssoSignIn = "Inloggen via Single Sign-on" @@ -3570,7 +3598,7 @@ login = "Inloggen" or = "Of" useMagicLink = "Gebruik in plaats daarvan een magic link" enterEmailForMagicLink = "Voer uw e-mailadres in voor een magic link" -sending = "Verzenden…" +sending = "Verzenden..." sendMagicLink = "Magic link verzenden" cancel = "Annuleren" dontHaveAccount = "Nog geen account? Registreer" @@ -3591,17 +3619,17 @@ changePasswordWarning = "Wijzig uw wachtwoord nadat u voor het eerst bent ingelo [login.slides.overview] alt = "Stirling PDF-overzicht" -title = "Uw alles-in-één oplossing voor al uw PDF-behoeften." -subtitle = "Een privacy-first cloud suite voor PDF's waarmee u documenten kunt converteren, ondertekenen, anonimiseren en beheren, plus 50+ andere krachtige tools." +title = "Uw alles-in-een oplossing voor al uw PDF-behoeften." +subtitle = "Een privacy-first cloud suite voor PDF-en waarmee u documenten kunt converteren, ondertekenen, anonimiseren en beheren, plus 50+ andere krachtige tools." [login.slides.edit] -alt = "PDF's bewerken" -title = "Bewerk PDF's om de gewenste informatie te tonen/beveiligen" -subtitle = "Met meer dan een dozijn tools om PDF's te anonimiseren, ondertekenen, lezen en bewerken vindt u zeker wat u zoekt." +alt = "PDF-en bewerken" +title = "Bewerk PDF-en om de gewenste informatie te tonen/beveiligen" +subtitle = "Met meer dan een dozijn tools om PDF-en te anonimiseren, ondertekenen, lezen en bewerken vindt u zeker wat u zoekt." [login.slides.secure] -alt = "PDF's beveiligen" -title = "Bescherm gevoelige informatie in uw PDF's" +alt = "PDF-en beveiligen" +title = "Bescherm gevoelige informatie in uw PDF-en" subtitle = "Voeg wachtwoorden toe, anonimiseer inhoud en beheer certificaten met gemak." [signup] @@ -3636,7 +3664,7 @@ confirmPasswordRequired = "Bevestig uw wachtwoord" title = "PDF naar enkele pagina" header = "PDF naar enkele pagina" submit = "Converteren naar enkele pagina" -description = "Deze tool voegt alle pagina's van uw PDF samen tot één grote enkele pagina. De breedte blijft hetzelfde als de oorspronkelijke pagina's, maar de hoogte wordt de som van alle paginahoogten." +description = "Deze tool voegt alle pagina's van uw PDF samen tot een grote enkele pagina. De breedte blijft hetzelfde als de oorspronkelijke pagina's, maar de hoogte wordt de som van alle paginahoogten." filenamePrefix = "enkele_pagina" [pdfToSinglePage.files] @@ -3671,7 +3699,7 @@ submit = "PDF opschonen" title = "Contrast aanpassen" header = "Contrast aanpassen" basic = "Basisaanpassingen" -contrast = "Kehrbrechting:" +contrast = "Contrast:" brightness = "Helderheid:" saturation = "Verzadiging:" download = "Downloaden" @@ -3690,7 +3718,7 @@ title = "Aangepaste PDF" [compress] title = "Comprimeren" -desc = "Comprimeer PDF's om de bestandsgrootte te verkleinen." +desc = "Comprimeer PDF-en om de bestandsgrootte te verkleinen." header = "PDF comprimeren" credit = "Deze functie gebruikt qpdf voor PDF Compressie/Optimalisatie." submit = "Comprimeren" @@ -3701,7 +3729,17 @@ quality = "Kwaliteit" filesize = "Bestandsgrootte" [compress.grayscale] -label = "Grijsschaal toepassen voor compressie" +label = "Grijstinten toepassen voor compressie" + +[compress.lineArt] +label = "Afbeeldingen omzetten in lijntekening" +description = "Gebruikt ImageMagick om pagina's te reduceren tot hoogcontrast zwart-wit voor maximale verkleining van de bestandsgrootte." +unavailable = "ImageMagick is niet geïnstalleerd of ingeschakeld op deze server" +detailLevel = "Detailniveau" +edgeEmphasis = "Randaccent" +edgeLow = "Zacht" +edgeMedium = "Gebalanceerd" +edgeHigh = "Sterk" [compress.tooltip.header] title = "Overzicht compressie-instellingen" @@ -3718,7 +3756,11 @@ bullet2 = "Hogere waarden verminderen de bestandsgrootte" [compress.tooltip.grayscale] title = "Grijstinten" -text = "Selecteer deze optie om alle afbeeldingen naar zwart-wit te converteren, wat de bestandsgrootte aanzienlijk kan verminderen, vooral voor gescande PDF's of documenten met veel afbeeldingen." +text = "Selecteer deze optie om alle afbeeldingen naar zwart-wit te converteren, wat de bestandsgrootte aanzienlijk kan verminderen, vooral voor gescande PDF-en of documenten met veel afbeeldingen." + +[compress.tooltip.lineArt] +title = "Lijntekening" +text = "Zet pagina's om naar hoogcontrast zwart-wit met ImageMagick. Gebruik het detailniveau om te bepalen hoeveel inhoud zwart wordt, en randaccentuering om te controleren hoe agressief randen worden gedetecteerd." [compress.error] failed = "Er is een fout opgetreden bij het comprimeren van de PDF." @@ -3765,7 +3807,7 @@ maintainAspectRatio = "Beeldverhoudingen behouden" 2 = "PDF automatisch draaien" 3 = "Meervoudige bestandslogica (Alleen ingeschakeld bij werken met meerdere afbeeldingen)" 4 = "Voeg samen in één PDF" -5 = "Zet om naar afzonderlijke PDF's" +5 = "Zet om naar afzonderlijke PDF-en" [PDFToCSV] title = "PDF naar CSV" @@ -3817,13 +3859,13 @@ button = "Vul enquête in." dontShowAgain = "Niet weer tonen" [survey.meeting] -1 = "Als je Stirling PDF op het werk gebruikt, spreken we je graag. We bieden technische supportsessies aan in ruil voor een gebruikersgesprek van 15 minuten." +1 = "Als u Stirling PDF op het werk gebruikt, spreken we u graag. We bieden technische supportsessies aan in ruil voor een gebruikersgesprek van 15 minuten." 2 = "Dit is een kans om:" 3 = "Hulp te krijgen bij deployment, integraties of troubleshooting" 4 = "Direct feedback te geven over performance, edge-cases en ontbrekende functies" 5 = "Ons te helpen Stirling PDF te verfijnen voor gebruik in echte enterprise-omgevingen" -6 = "Als je geïnteresseerd bent, kun je direct tijd met ons team boeken. (Alleen Engelstalig)" -7 = "We kijken ernaar uit om jouw gebruiksscenario's te bespreken en Stirling PDF nog beter te maken!" +6 = "Als u geïnteresseerd bent, kunt u direct tijd met ons team boeken. (Alleen Engelstalig)" +7 = "We kijken ernaar uit om uw gebruiksscenario's te bespreken en Stirling PDF nog beter te maken!" notInterested = "Geen bedrijf en/of geen interesse in een afspraak?" button = "Afspraak boeken" @@ -3848,9 +3890,9 @@ allowDuplicates = "Dubbele items toestaan" submit = "PDF splitsen" [splitByChapters.desc] -1 = "Dit hulpmiddel splits een PDF-bestand op in meerdere PDF's gebaseerd op zijn hoofdstukstructuur." +1 = "Dit hulpmiddel splits een PDF-bestand op in meerdere PDF-en gebaseerd op zijn hoofdstukstructuur." 2 = "Boekmarkeer niveau: Kies het boekmarkeer niveau om te gebruiken voor delen (0 voor topniveau, 1 voor tweedelvou, etc.)." -3 = "Metadata inclusief: Als gecijfeld, de originele PDF's metadata wordt ingevoegd in elk gesplitst PDF-bestand." +3 = "Metadata inclusief: Als gecijfeld, de originele PDF-en metadata wordt ingevoegd in elk gesplitst PDF-bestand." 4 = "Dubbele items toestaan: Als gecijfeld, zorgen multiple boekmarkeersymboolen op dezelfde pagina voor het maken van aparte PDF-bestanden." [fileChooser] @@ -3884,7 +3926,7 @@ acceptNecessaryBtn = "Nee, bedankt" showPreferencesBtn = "Voorkeuren beheren" [cookieBanner.popUp.description] -1 = "We gebruiken cookies en andere technologieën om Stirling PDF beter voor je te laten werken—zo verbeteren we onze tools en blijven we functies bouwen die je waardeert." +1 = "We gebruiken cookies en andere technologieën om Stirling PDF beter voor u te laten werken—zo verbeteren we onze tools en blijven we functies bouwen die u waardeert." 2 = "If you’d rather not, clicking 'No Thanks' will only enable the essential cookies needed to keep things running smoothly." [cookieBanner.preferencesModal] @@ -3897,9 +3939,9 @@ serviceCounterLabel = "Dienst|Diensten" subtitle = "Cookiegebruik" [cookieBanner.preferencesModal.description] -1 = "Stirling PDF gebruikt cookies en vergelijkbare technologieën om je ervaring te verbeteren en te begrijpen hoe onze tools worden gebruikt. Dit helpt ons de prestaties te verbeteren, de functies te ontwikkelen die jij belangrijk vindt en doorlopende ondersteuning te bieden." -2 = "Stirling PDF kan niet—en zal nooit—de inhoud van de documenten die je gebruikt volgen of openen." -3 = "Jouw privacy en vertrouwen staan centraal in wat we doen." +1 = "Stirling PDF gebruikt cookies en vergelijkbare technologieën om uw ervaring te verbeteren en te begrijpen hoe onze tools worden gebruikt. Dit helpt ons de prestaties te verbeteren, de functies te ontwikkelen die jij belangrijk vindt en doorlopende ondersteuning te bieden." +2 = "Stirling PDF kan niet—en zal nooit—de inhoud van de documenten die u gebruikt volgen of openen." +3 = "Uw privacy en vertrouwen staan centraal in wat we doen." [cookieBanner.preferencesModal.necessary] description = "These cookies are essential for the website to function properly. They enable core features like setting your privacy preferences, logging in, and filling out forms—which is why they can’t be turned off." @@ -3910,7 +3952,7 @@ description = "These cookies are essential for the website to function properly. [cookieBanner.preferencesModal.analytics] title = "Analyse" -description = "Deze cookies helpen ons te begrijpen hoe onze tools worden gebruikt, zodat we ons kunnen richten op het bouwen van de functies die onze community het meest waardeert. Wees gerust—Stirling PDF kan niet en zal nooit de inhoud van de documenten waarmee je werkt volgen." +description = "Deze cookies helpen ons te begrijpen hoe onze tools worden gebruikt, zodat we ons kunnen richten op het bouwen van de functies die onze community het meest waardeert. Wees gerust—Stirling PDF kan niet en zal nooit de inhoud van de documenten waarmee u werkt volgen." [cookieBanner.services] posthog = "PostHog Analytics" @@ -3996,8 +4038,8 @@ noResults = "Geen resultaten gevonden" searching = "Zoeken..." [guestBanner] -title = "Je gebruikt Stirling PDF als gast!" -message = "Maak een gratis account aan om je werk op te slaan, meer functies te gebruiken en het project te steunen." +title = "U gebruikt Stirling PDF als gast!" +message = "Maak een gratis account aan om uw werk op te slaan, meer functies te gebruiken en het project te steunen." dismiss = "Banner sluiten" signUp = "Gratis aanmelden" @@ -4038,12 +4080,20 @@ settings = "Opties" adminSettings = "Beheer" allTools = "All Tools" reader = "Reader" +tours = "Tours" +showMeAround = "Leid me rond" + +[quickAccess.toursTooltip] +admin = "Bekijk hier rondleidingen: Tools-tour, nieuwe V2-indeling tour en de Admin-tour." +user = "Bekijk hier rondleidingen: Ronde langs de tools en de nieuwe V2-indeling." [quickAccess.helpMenu] toolsTour = "Rondleiding tools" toolsTourDesc = "Leer wat de tools kunnen" adminTour = "Rondleiding voor beheer" adminTourDesc = "Ontdek beheerinstellingen en functies" +whatsNewTour = "Bekijk wat er nieuw is in V2" +whatsNewTourDesc = "Verken de vernieuwde layout" [admin] error = "Fout" @@ -4079,13 +4129,13 @@ hint = "U hebt niet-opgeslagen wijzigingen" [admin.settings.loginDisabled] title = "Inlogmodus vereist" -message = "Inlogmodus moet zijn ingeschakeld om beheerinstellingen te wijzigen. Stel SECURITY_ENABLELOGIN=true in je omgeving of security.enableLogin: true in settings.yml in, start daarna de server opnieuw." +message = "Inlogmodus moet zijn ingeschakeld om beheerinstellingen te wijzigen. Stel SECURITY_ENABLELOGIN=true in uw omgeving of security.enableLogin: true in settings.yml in, start daarna de server opnieuw." readOnly = "De onderstaande instellingen tonen voorbeeldwaarden ter referentie. Schakel de inlogmodus in om de werkelijke configuratie te bekijken en te bewerken." [admin.settings.restart] title = "Herstart vereist" message = "Instellingen zijn succesvol opgeslagen. Een herstart van de server is vereist om de wijzigingen door te voeren." -question = "Wil je de server nu of later herstarten?" +question = "Wilt u de server nu of later herstarten?" now = "Nu herstarten" later = "Later herstarten" @@ -4168,11 +4218,11 @@ label = "Pipelinemappen" [admin.settings.general.customPaths.pipeline.watchedFoldersDir] label = "Map met bewaakte mappen" -description = "Map waarin de pipeline inkomende PDF's bewaakt (laat leeg voor standaard: /pipeline/watchedFolders)" +description = "Map waarin de pipeline inkomende PDF-en bewaakt (laat leeg voor standaard: /pipeline/watchedFolders)" [admin.settings.general.customPaths.pipeline.finishedFoldersDir] label = "Map met voltooide mappen" -description = "Map waar verwerkte PDF's worden weggeschreven (laat leeg voor standaard: /pipeline/finishedFolders)" +description = "Map waar verwerkte PDF-en worden weggeschreven (laat leeg voor standaard: /pipeline/finishedFolders)" [admin.settings.general.customPaths.operations] label = "Paden naar externe tools" @@ -4344,11 +4394,11 @@ description = "De issuer-URL van de OAuth2-provider" [admin.settings.connections.oauth2.clientId] label = "Client-ID" -description = "De OAuth2 client-ID van je provider" +description = "De OAuth2 client-ID van uw provider" [admin.settings.connections.oauth2.clientSecret] label = "Clientgeheim" -description = "Het OAuth2 clientgeheim van je provider" +description = "Het OAuth2 clientgeheim van uw provider" [admin.settings.connections.oauth2.useAsUsername] label = "Gebruik als gebruikersnaam" @@ -4396,7 +4446,7 @@ configuration = "Databaseconfiguratie" [admin.settings.database.enableCustom] label = "Aangepaste database inschakelen" -description = "Gebruik je eigen aangepaste databaseconfiguratie in plaats van de standaard ingesloten database" +description = "Gebruik uw eigen aangepaste databaseconfiguratie in plaats van de standaard ingesloten database" [admin.settings.database.customUrl] label = "Aangepaste database-URL" @@ -4544,7 +4594,7 @@ description = "E-mailmeldingen en SMTP-functionaliteit inschakelen" [admin.settings.mail.host] label = "SMTP-host" -description = "De hostnaam of het IP-adres van je SMTP-server" +description = "De hostnaam of het IP-adres van uw SMTP-server" [admin.settings.mail.port] label = "SMTP-poort" @@ -4568,7 +4618,7 @@ description = "Sta beheerders toe om gebruikers via e-mail uit te nodigen met au [admin.settings.mail.frontendUrl] label = "Frontend-URL" -description = "Basis-URL voor de frontend (bijv. https://pdf.example.com). Wordt gebruikt voor het genereren van uitnodigingslinks in e-mails. Laat leeg om de backend-URL te gebruiken." +description = "Basis-URL voor de frontend (bijv. https://pdf.example.com). Wordt gebruikt voor het genereren van uitnodigingslinks in e-mails. Laat leeg om de back-end-URL te gebruiken." [admin.settings.legal] title = "Juridische documenten" @@ -4576,7 +4626,7 @@ description = "Links naar juridische documenten en beleidsregels configureren." [admin.settings.legal.disclaimer] title = "Waarschuwing juridische verantwoordelijkheid" -message = "Door deze juridische documenten aan te passen, neem je de volledige verantwoordelijkheid voor conformiteit met alle toepasselijke wetten en voorschriften, inclusief maar niet beperkt tot de GDPR en andere EU-vereisten voor gegevensbescherming. Wijzig deze instellingen alleen als: (1) je een persoonlijke/private instantie beheert, (2) je buiten de EU-jurisdictie valt en je lokale wettelijke verplichtingen begrijpt, of (3) je passend juridisch advies hebt ingewonnen en volledige verantwoordelijkheid aanvaardt voor alle gebruikersgegevens en juridische naleving. Stirling-PDF en zijn ontwikkelaars aanvaarden geen aansprakelijkheid voor jouw wettelijke verplichtingen." +message = "Door deze juridische documenten aan te passen, neemt u de volledige verantwoordelijkheid voor conformiteit met alle toepasselijke wetten en voorschriften, inclusief maar niet beperkt tot de GDPR en andere EU-vereisten voor gegevensbescherming. Wijzig deze instellingen alleen als: (1) u een persoonlijke/private instantie beheert, (2) u buiten de EU-jurisdictie valt en u lokale wettelijke verplichtingen begrijpt, of (3) u passend juridisch advies hebt ingewonnen en volledige verantwoordelijkheid aanvaardt voor alle gebruikersgegevens en juridische naleving. Stirling-PDF en zijn ontwikkelaars aanvaarden geen aansprakelijkheid voor uw wettelijke verplichtingen." [admin.settings.legal.termsAndConditions] label = "Algemene voorwaarden" @@ -4600,24 +4650,24 @@ description = "URL of bestandsnaam van het impressum (in sommige jurisdicties ve [admin.settings.premium] title = "Premium & Enterprise" -description = "Configureer je premium- of enterprise-licentiesleutel." +description = "Configureer uw premium- of enterprise-licentiesleutel." license = "Licentieconfiguratie" noInput = "Geef een licentiesleutel of bestand op" [admin.settings.premium.licenseKey] -toggle = "Heb je een licentiesleutel of certificaatbestand?" -info = "Als je een licentiesleutel of certificaatbestand hebt van een directe aankoop, kun je die hier invoeren om premium- of enterprisefuncties te activeren." +toggle = "Heeft u een licentiesleutel of certificaatbestand?" +info = "Als u een licentiesleutel of certificaatbestand hebt van een directe aankoop, kunt u die hier invoeren om premium- of enterprisefuncties te activeren." [admin.settings.premium.key] label = "Licentiesleutel" -description = "Voer je premium- of enterprise-licentiesleutel in" +description = "Voer uw premium- of enterprise-licentiesleutel in" success = "Licentiesleutel opgeslagen" -successMessage = "Je licentiesleutel is succesvol geactiveerd. Herstart is niet nodig." +successMessage = "Uw licentiesleutel is succesvol geactiveerd. Herstart is niet nodig." [admin.settings.premium.key.overwriteWarning] title = "⚠️ Waarschuwing: Bestaande licentie gedetecteerd" -line1 = "Het overschrijven van je huidige licentiesleutel kan niet ongedaan worden gemaakt." -line2 = "Je vorige licentie gaat permanent verloren, tenzij je er elders een back-up van hebt." +line1 = "Het overschrijven van uw huidige licentiesleutel kan niet ongedaan worden gemaakt." +line2 = "Uw vorige licentie gaat permanent verloren, tenzij u er elders een back-up van hebt." line3 = "Belangrijk: houd licentiesleutels privé en veilig. Deel ze nooit openbaar." [admin.settings.premium.inputMethod] @@ -4626,7 +4676,7 @@ file = "Certificaatbestand" [admin.settings.premium.file] label = "Licentiecertificaatbestand" -description = "Upload je .lic- of .cert-licentiebestand van offline aankopen" +description = "Upload uw .lic- of .cert-licentiebestand van offline aankopen" choose = "Kies licentiebestand" selected = "Geselecteerd: {{filename}} ({{size}})" successMessage = "Licentiebestand succesvol geüpload en geactiveerd. Herstarten niet vereist." @@ -4636,6 +4686,7 @@ title = "Actieve licentie" file = "Bron: licentiebestand ({{path}})" key = "Bron: licentiesleutel" type = "Type: {{type}}" + noInput = "Geef een licentiesleutel op of upload een certificaatbestand" success = "Succes" @@ -4691,7 +4742,7 @@ selectFiles = "Selecteer bestanden" selectPdfToView = "Selecteer een PDF om te bekijken" selectPdfToEdit = "Selecteer een PDF om te bewerken" chooseFromStorage = "Kies een bestand uit opslag of upload een nieuwe PDF" -chooseFromStorageMultiple = "Kies bestanden uit opslag of upload nieuwe PDF's" +chooseFromStorageMultiple = "Kies bestanden uit opslag of upload nieuwe PDF-en" loadFromStorage = "Laden vanuit opslag" filesAvailable = "bestanden beschikbaar" loading = "Laden..." @@ -4719,7 +4770,7 @@ addFiles = "Bestanden toevoegen" [fileManager] title = "PDF-bestanden uploaden" -subtitle = "Voeg bestanden toe aan je opslag voor gemakkelijke toegang in alle tools" +subtitle = "Voeg bestanden toe aan uw opslag voor gemakkelijke toegang in alle tools" filesSelected = "bestanden geselecteerd" clearSelection = "Selectie wissen" openInFileEditor = "Openen in bestandseditor" @@ -4778,7 +4829,7 @@ closeFile = "Bestand sluiten" deleteAll = "Alles verwijderen" loadingFiles = "Bestanden laden..." noFiles = "Geen bestanden beschikbaar" -noFilesFound = "Geen bestanden gevonden die overeenkomen met je zoekopdracht" +noFilesFound = "Geen bestanden gevonden die overeenkomen met uw zoekopdracht" openInPageEditor = "Openen in Pagina-editor" showAll = "Alles weergeven" sortByDate = "Sorteren op datum" @@ -4786,12 +4837,12 @@ sortByName = "Sorteren op naam" sortBySize = "Sorteren op grootte" [storage] -temporaryNotice = "Bestanden worden tijdelijk opgeslagen in je browser en kunnen automatisch worden gewist" +temporaryNotice = "Bestanden worden tijdelijk opgeslagen in uw browser en kunnen automatisch worden gewist" storageLimit = "Opslaglimiet" storageUsed = "Tijdelijke opslag gebruikt" storageFull = "Opslag is bijna vol. Overweeg enkele bestanden te verwijderen." fileTooLarge = "Bestand te groot. Maximale grootte per bestand is" -storageQuotaExceeded = "Opslagquotum overschreden. Verwijder enkele bestanden voordat je meer uploadt." +storageQuotaExceeded = "Opslagquotum overschreden. Verwijder enkele bestanden voordat u meer uploadt." approximateSize = "Geschatte grootte" [sanitize] @@ -4816,7 +4867,7 @@ placeholder = "Selecteer een PDF-bestand in het hoofdscherm om te beginnen" [sanitize.options] title = "Opschoonopties" -note = "Selecteer de elementen die je uit de PDF wilt verwijderen. Er moet minstens één optie geselecteerd zijn." +note = "Selecteer de elementen die u uit de PDF wilt verwijderen. Er moet minstens één optie geselecteerd zijn." [sanitize.options.removeJavaScript] label = "JavaScript verwijderen" @@ -4844,7 +4895,7 @@ desc = "Ingesloten lettertypen uit de PDF verwijderen" [addPassword] title = "Wachtwoord toevoegen" -desc = "Versleutel je PDF-document met een wachtwoord." +desc = "Versleutel uw PDF-document met een wachtwoord." completed = "Wachtwoordbeveiliging toegepast" submit = "Versleutelen" filenamePrefix = "versleuteld" @@ -4871,14 +4922,14 @@ label = "Sleutellengte voor versleuteling" 256bit = "256-bit (Hoog)" [addPassword.results] -title = "Versleutelde PDF's" +title = "Versleutelde PDF-en" [addPassword.tooltip.header] title = "Overzicht wachtwoordbeveiliging" [addPassword.tooltip.passwords] title = "Wachtwoordtypen" -text = "Gebruikerswachtwoorden beperken het openen van het document, terwijl eigenaarwachtwoorden bepalen wat er met het document kan worden gedaan zodra het is geopend. Je kunt beide instellen of slechts één." +text = "Gebruikerswachtwoorden beperken het openen van het document, terwijl eigenaarwachtwoorden bepalen wat er met het document kan worden gedaan zodra het is geopend. U kunt beide instellen of slechts één." bullet1 = "Gebruikerswachtwoord: vereist om de PDF te openen" bullet2 = "Eigenaarwachtwoord: beheert documentmachtigingen (niet door alle PDF-viewers ondersteund)" @@ -4927,7 +4978,7 @@ label = "Voorkom afdrukken" label = "Voorkom afdrukken in verschillende formaten" [changePermissions.results] -title = "Aangepaste PDF's" +title = "Aangepaste PDF-en" [changePermissions.tooltip.header] title = "Rechten wijzigen" @@ -4940,7 +4991,7 @@ text = "Om deze machtigingen niet wijzigbaar te maken, gebruik de tool Wachtwoor [removePassword] title = "Wachtwoord verwijderen" -desc = "Verwijder wachtwoordbeveiliging van je PDF-document." +desc = "Verwijder wachtwoordbeveiliging van uw PDF-document." tags = "veilig,ontsleutelen,beveiliging,wachtwoord verwijderen" filenamePrefix = "ontsleuteld" submit = "Verwijderen" @@ -4958,7 +5009,7 @@ failed = "Er is een fout opgetreden bij het verwijderen van het wachtwoord uit d description = "Voor het verwijderen van wachtwoordbeveiliging is het wachtwoord nodig dat is gebruikt om de PDF te versleutelen. Dit zal het document ontsleutelen, waardoor het toegankelijk wordt zonder wachtwoord." [removePassword.results] -title = "Ontsleutelde PDF's" +title = "Ontsleutelde PDF-en" [automate] title = "Automatiseren" @@ -4985,7 +5036,7 @@ title = "Aanbevolen" [automate.creation] createTitle = "Automatisering maken" editTitle = "Automatisering bewerken" -intro = "Automatiseringen voeren tools opeenvolgend uit. Voeg tools toe in de volgorde waarin je ze wilt uitvoeren." +intro = "Automatiseringen voeren tools opeenvolgend uit. Voeg tools toe in de volgorde waarin u ze wilt uitvoeren." save = "Automatisering opslaan" [automate.creation.name] @@ -5007,7 +5058,7 @@ add = "Een tool toevoegen..." [automate.creation.unsavedChanges] title = "Niet-opgeslagen wijzigingen" -message = "Je hebt niet-opgeslagen wijzigingen. Weet je zeker dat je terug wilt gaan? Alle wijzigingen gaan verloren." +message = "U heeft niet-opgeslagen wijzigingen. Weet u zeker dat u terug wilt gaan? Alle wijzigingen gaan verloren." cancel = "Annuleren" confirm = "Teruggaan" @@ -5036,13 +5087,13 @@ save = "Configuratie opslaan" securePdfIngestion = "Beveiligde PDF-invoer" securePdfIngestionDesc = "Uitgebreide PDF-verwerkingsworkflow die documenten opschoont, OCR met opschoning toepast, converteert naar PDF/A-formaat voor langdurige archivering en de bestandsgrootte optimaliseert." emailPreparation = "E-mailvoorbereiding" -emailPreparationDesc = "Optimaliseert PDF's voor e-maildistributie door bestanden te comprimeren, grote documenten op te splitsen in 20MB-stukken voor e-mailcompatibiliteit en metagegevens te verwijderen voor privacy." +emailPreparationDesc = "Optimaliseert PDF-en voor e-maildistributie door bestanden te comprimeren, grote documenten op te splitsen in 20MB-stukken voor e-mailcompatibiliteit en metagegevens te verwijderen voor privacy." secureWorkflow = "Beveiligingsworkflow" secureWorkflowDesc = "Beveiligt PDF-documenten door mogelijk kwaadaardige inhoud zoals JavaScript en ingesloten bestanden te verwijderen, en voegt vervolgens wachtwoordbeveiliging toe om ongeautoriseerde toegang te voorkomen. Wachtwoord is standaard ingesteld op 'password'." processImages = "Afbeeldingen verwerken" processImagesDesc = "Converteert meerdere afbeeldingsbestanden naar één PDF-document en past vervolgens OCR toe om doorzoekbare tekst uit de afbeeldingen te extraheren." prePublishSanitization = "Opschonen vóór publicatie" -prePublishSanitizationDesc = "Opschoonworkflow die alle verborgen metadata, JavaScript, ingesloten bestanden en aantekeningen verwijdert en formulieren afvlakt om datalekken te voorkomen voordat PDF's online worden gepubliceerd." +prePublishSanitizationDesc = "Opschoonworkflow die alle verborgen metadata, JavaScript, ingesloten bestanden en aantekeningen verwijdert en formulieren afvlakt om datalekken te voorkomen voordat PDF-en online worden gepubliceerd." [colorPicker] title = "Kies kleur" @@ -5069,6 +5120,7 @@ loading = "Laden..." back = "Terug" continue = "Doorgaan" error = "Fout" +save = "Opslaan" [config.overview] title = "Applicatieconfiguratie" @@ -5085,30 +5137,30 @@ integration = "Integratieconfiguratie" [config.account.overview] title = "Accountinstellingen" -manageAccountPreferences = "Beheer je accountvoorkeuren" -guestDescription = "Je bent aangemeld als gast. Overweeg je account hierboven te upgraden." +manageAccountPreferences = "Accountvoorkeuren beheren" +guestDescription = "U bent aangemeld als gast. Overweeg uw account hierboven op te waarderen." [config.account.upgrade] -title = "Gastaccount upgraden" -description = "Koppel je account om je geschiedenis te behouden en toegang te krijgen tot meer functies!" -socialLogin = "Upgraden met sociaal account" +title = "Gastaccount opwaarderen" +description = "Koppel uw account om uw geschiedenis te behouden en toegang te krijgen tot meer functies!" +socialLogin = "Opwaarderen met sociaal account" linkWith = "Koppelen met" -emailPassword = "of voer je e-mailadres en wachtwoord in" +emailPassword = "of voer uw e-mailadres en wachtwoord in" email = "E-mailadres" -emailPlaceholder = "Voer je e-mailadres in" +emailPlaceholder = "Voer uw e-mailadres in" password = "Wachtwoord (optioneel)" passwordPlaceholder = "Stel een wachtwoord in" passwordNote = "Laat leeg om alleen e-mailverificatie te gebruiken" -upgradeButton = "Account upgraden" +upgradeButton = "Account opwaarderen" [config.apiKeys] -intro = "Gebruik je API-sleutel om programmatisch toegang te krijgen tot Stirling PDF's verwerkingsmogelijkheden." +intro = "Gebruik uw API-sleutel om programmatisch toegang te krijgen tot Stirling PDF-en verwerkingsmogelijkheden." docsTitle = "API-documentatie" docsDescription = "Leer meer over integreren met Stirling PDF:" docsLink = "API-documentatie" schemaLink = "API-schemareferentie" usage = "Neem deze sleutel op in de X-API-KEY-header bij alle API-aanvragen." -description = "Je API-sleutel voor toegang tot Stirling's suite van PDF-tools. Kopieer hem naar je project of vernieuw om een nieuwe te genereren." +description = "Uw API-sleutel voor toegang tot Stirling's suite van PDF-tools. Kopieer hem naar uw project of vernieuw om een nieuwe te genereren." publicKeyAriaLabel = "Publieke API-sleutel" copyKeyAriaLabel = "API-sleutel kopiëren" refreshAriaLabel = "API-sleutel vernieuwen" @@ -5118,22 +5170,22 @@ totalCredits = "Totale credits" chartAriaLabel = "Creditsgebruik: inbegrepen {{includedUsed}} van {{includedTotal}}, aangekocht {{purchasedUsed}} van {{purchasedTotal}}" nextReset = "Volgende reset" lastApiUse = "Laatste API-gebruik" -overlayMessage = "Genereer een sleutel om je gebruik en beschikbare credits te zien" +overlayMessage = "Genereer een sleutel om uw gebruik en beschikbare credits te zien" label = "API-sleutel" -guestInfo = "Gasten ontvangen geen API-sleutel. Maak een account aan om een API-sleutel te krijgen die je in je toepassingen kunt gebruiken." +guestInfo = "Gasten ontvangen geen API-sleutel. Maak een account aan om een API-sleutel te krijgen die u in uw toepassingen kunt gebruiken." goToAccount = "Naar Account" -generateError = "We konden je API-sleutel niet genereren." +generateError = "We konden uw API-sleutel niet genereren." [config.apiKeys.refreshModal] title = "API-sleutels vernieuwen" -warning = "⚠️ Waarschuwing: deze actie genereert nieuwe API-sleutels en maakt je vorige sleutels ongeldig." -impact = "Eventuele applicaties of services die deze sleutels momenteel gebruiken, werken niet meer totdat je ze bijwerkt met de nieuwe sleutels." -confirmPrompt = "Weet je zeker dat je wilt doorgaan?" +warning = "⚠️ Waarschuwing: deze actie genereert nieuwe API-sleutels en maakt uw vorige sleutels ongeldig." +impact = "Eventuele applicaties of services die deze sleutels momenteel gebruiken, werken niet meer totdat u ze bijwerkt met de nieuwe sleutels." +confirmPrompt = "Weet u zeker dat u wilt doorgaan?" confirmCta = "Sleutels vernieuwen" [AddAttachmentsRequest] attachments = "Bijlagen selecteren" -info = "Selecteer bestanden om aan je PDF toe te voegen. Deze bestanden worden ingesloten en zijn toegankelijk via het bijlagenpaneel van de PDF." +info = "Selecteer bestanden om aan uw PDF toe te voegen. Deze bestanden worden ingesloten en zijn toegankelijk via het bijlagenpaneel van de PDF." selectFiles = "Bestanden selecteren om bij te voegen" placeholder = "Kies bestanden..." addMoreFiles = "Meer bestanden toevoegen..." @@ -5212,33 +5264,43 @@ noTools = "Geen tools beschikbaar" [onboarding] allTools = "This is the All Tools panel, where you can browse and select from all available PDF tools." -selectCropTool = "Laten we de tool Bijsnijden selecteren om te laten zien hoe je een van de tools gebruikt." -toolInterface = "Dit is de interface van de tool Bijsnijden. Zoals je ziet is er nog niet veel, omdat we nog geen PDF-bestanden hebben toegevoegd om mee te werken." -filesButton = "Met de knop Bestanden op de sneltoegangsbalk kun je PDF's uploaden om de tools op toe te passen." -fileSources = "Je kunt hier nieuwe bestanden uploaden of recente bestanden openen. Voor de rondleiding gebruiken we een voorbeeldbestand." -workbench = "Dit is de Werkbank - het hoofdgebied waar je je PDF's bekijkt en bewerkt." -viewSwitcher = "Gebruik deze bedieningselementen om te kiezen hoe je je PDF's wilt bekijken." -viewer = "Met de Viewer kun je je PDF's lezen en annoteren." -pageEditor = "De Pagina-editor laat je verschillende bewerkingen uitvoeren op de pagina's in je PDF's, zoals herordenen, roteren en verwijderen." -activeFiles = "De weergave Actieve bestanden toont alle PDF's die je in de tool hebt geladen en laat je kiezen welke je wilt verwerken." -fileCheckbox = "Door op een van de bestanden te klikken selecteer je het voor verwerking. Je kunt meerdere bestanden selecteren voor batchbewerkingen." -selectControls = "De rechterzijbalk bevat knoppen om snel al je actieve PDF's te selecteren/deselecteren, en knoppen om het thema of de taal van de app te wijzigen." +selectCropTool = "Laten we de tool Bijsnijden selecteren om te laten zien hoe u een van de tools gebruikt." +toolInterface = "Dit is de interface van de tool Bijsnijden. Zoals u ziet is er nog niet veel, omdat we nog geen PDF-bestanden hebben toegevoegd om mee te werken." +filesButton = "Met de knop Bestanden op de sneltoegangsbalk kunt u PDF-en uploaden om de tools op toe te passen." +fileSources = "U kunt hier nieuwe bestanden uploaden of recente bestanden openen. Voor de rondleiding gebruiken we een voorbeeldbestand." +workbench = "Dit is de Werkbank - het hoofdgebied waar u uw PDF-en bekijkt en bewerkt." +viewSwitcher = "Gebruik deze bedieningselementen om te kiezen hoe u uw PDF-en wilt bekijken." +viewer = "Met de Viewer kunt u uw PDF-en lezen en annoteren." +pageEditor = "De Pagina-editor laat u verschillende bewerkingen uitvoeren op de pagina's in uw PDF-en, zoals herordenen, roteren en verwijderen." +activeFiles = "De weergave Actieve bestanden toont alle PDF-en die u in de tool hebt geladen en laat u kiezen welke u wilt verwerken." +fileCheckbox = "Door op een van de bestanden te klikken selecteert u het voor verwerking. U kunt meerdere bestanden selecteren voor batchbewerkingen." +selectControls = "De rechterzijbalk bevat knoppen om snel al uw actieve PDF-en te selecteren/deselecteren, en knoppen om het thema of de taal van de app te wijzigen." cropSettings = "Nu we het bestand hebben geselecteerd dat we willen bijsnijden, kunnen we de tool Bijsnijden configureren om het gebied te kiezen waarnaar we de PDF willen bijsnijden." -runButton = "Zodra de tool is geconfigureerd, kun je met deze knop de tool uitvoeren op alle geselecteerde PDF's." -results = "Nadat de tool klaar is met uitvoeren, toont de stap Beoordeling een voorbeeld van de resultaten in dit paneel, en kun je de bewerking ongedaan maken of het bestand downloaden." -fileReplacement = "Het gewijzigde bestand vervangt automatisch het originele bestand in de Werkbank, zodat je het eenvoudig door meer tools kunt halen." -pinButton = "Je kunt de knop Vastzetten gebruiken als je wilt dat je bestanden actief blijven nadat er tools op zijn uitgevoerd." -wrapUp = "Je bent er klaar voor! Je hebt geleerd over de belangrijkste onderdelen van de app en hoe je ze gebruikt. Klik wanneer je wilt op de knop Help om deze rondleiding opnieuw te zien." +runButton = "Zodra de tool is geconfigureerd, kunt u met deze knop de tool uitvoeren op alle geselecteerde PDF-en." +results = "Nadat de tool klaar is met uitvoeren, toont de stap Beoordeling een voorbeeld van de resultaten in dit paneel, en kunt u de bewerking ongedaan maken of het bestand downloaden." +fileReplacement = "Het gewijzigde bestand vervangt automatisch het originele bestand in de Werkbank, zodat u het eenvoudig door meer tools kunt halen." +pinButton = "U kunt de knop Vastzetten gebruiken als u wilt dat uw bestanden actief blijven nadat er tools op zijn uitgevoerd." +wrapUp = "U bent er klaar voor! U hebt geleerd over de belangrijkste onderdelen van de app en hoe u ze gebruikt. Klik wanneer u wilt op de knop Help om deze rondleiding opnieuw te zien." previous = "Vorige" next = "Volgende" finish = "Voltooien" startTour = "Rondleiding starten" startTourDescription = "Volg een rondleiding langs de belangrijkste functies van Stirling PDF" +[onboarding.whatsNew] +quickAccess = "Begin met de balk Snelle toegang om te schakelen tussen Reader, Automate, uw bestanden en alle rondleidingen." +leftPanel = "Het linkerpaneel Hulpmiddelen toont alles wat u kunt doen. Blader door categorieën of zoek om snel een hulpmiddel te vinden." +fileUpload = "Gebruik de knop Bestanden om een PDF te uploaden of een recente te selecteren. We laden een voorbeeld zodat u de werkruimte kunt zien." +rightRail = "De Rechterbalk bevat snelle acties om bestanden te selecteren, het thema of de taal te wijzigen en resultaten te downloaden." +topBar = "De bovenste balk laat u schakelen tussen Viewer, Pagina Editor en Actieve bestanden." +pageEditorView = "Schakel over naar de Pagina-editor om pagina's te herschikken, te roteren of te verwijderen." +activeFilesView = "Gebruik Actieve Bestanden om alles te zien wat u open hebt en kies waar u aan wilt werken." +wrapUp = "Dit zijn de nieuwtjes in V2. Open het menu Tours wanneer u maar wilt om dit, de Tools-tour of de Admin-tour opnieuw te bekijken." + [onboarding.welcomeModal] title = "Welkom bij Stirling PDF!" -description = "Wil je een snelle rondleiding van 1 minuut volgen om de belangrijkste functies te leren en hoe je aan de slag gaat?" -helpHint = "Je kunt deze rondleiding altijd later openen via de knop Help linksonder." +description = "Wilt u een snelle rondleiding van 1 minuut volgen om de belangrijkste functies te leren en hoe u aan de slag gaat?" +helpHint = "U kunt deze rondleiding altijd later openen via de knop Help linksonder." startTour = "Rondleiding starten" maybeLater = "Misschien later" dontShowAgain = "Niet meer tonen" @@ -5255,40 +5317,44 @@ download = "Downloaden →" showMeAround = "Geef me een rondleiding" skipTheTour = "Rondleiding overslaan" +[onboarding.tourOverview] +title = "Touroverzicht" +body = "Stirling PDF V2 bevat tientallen tools en een vernieuwde lay-out. Maak een korte rondleiding om te zien wat er is veranderd en waar u de functionaliteiten kunt vinden die u nodig hebt." + [onboarding.serverLicense] skip = "Voor nu overslaan" -seePlans = "Plannen bekijken →" +seePlans = "Abonnementen bekijken →" upgrade = "Nu upgraden →" freeTitle = "Serverlicentie" overLimitTitle = "Serverlicentie vereist" -overLimitBody = "Onze licentie staat tot {{freeTierLimit}} gebruikers gratis per server toe. Je hebt {{overLimitUserCopy}} Stirling-gebruikers. Om zonder onderbreking door te gaan, upgrade naar het Stirling Server-plan - onbeperkte plaatsen, PDF-tekstbewerking en volledige admincontrole voor $99/server/maand." +overLimitBody = "Onze licentie staat tot {{freeTierLimit}} gebruikers gratis per server toe. U hebt {{overLimitUserCopy}} Stirling-gebruikers. Om zonder onderbreking door te gaan, upgrade naar het Stirling Server-abonnement - onbeperkte plaatsen, PDF-tekstbewerking en volledige admincontrole voor $99/server/maand." freeBody = "Onze Open-Core-licentie staat tot {{freeTierLimit}} gebruikers per server gratis toe. Om ononderbroken op te schalen, raden we het Stirling Server-abonnement aan - onbeperkte plaatsen en SSO-ondersteuning voor $99/server/maand." [onboarding.desktopInstall] title = "Downloaden" titleWithOs = "Downloaden voor {{osLabel}}" -body = "Stirling werkt het best als desktopapp. Je kunt het offline gebruiken, sneller documenten openen en lokaal op je computer bewerken." +body = "Stirling werkt het best als desktopapp. U kunt het offline gebruiken, sneller documenten openen en lokaal op uw computer bewerken." [onboarding.planOverview] adminTitle = "Admin-overzicht" -userTitle = "Planoverzicht" -adminBodyLoginEnabled = "Als admin kun je gebruikers beheren, instellingen configureren en de servergezondheid monitoren. De eerste {{freeTierLimit}} personen op je server gebruiken Stirling gratis." -adminBodyLoginDisabled = "Zodra je de loginmodus inschakelt, kun je gebruikers beheren, instellingen configureren en de servergezondheid monitoren. De eerste {{freeTierLimit}} personen op je server gebruiken Stirling gratis." -userBody = "Nodig teamgenoten uit, wijs rollen toe en houd je documenten georganiseerd in één veilige werkruimte. Schakel de loginmodus in wanneer je klaar bent om verder te groeien dan solo-gebruik." +userTitle = "Abonnementoverzicht" +adminBodyLoginEnabled = "Als admin kunt u gebruikers beheren, instellingen configureren en de servergezondheid monitoren. De eerste {{freeTierLimit}} personen op uw server gebruiken Stirling gratis." +adminBodyLoginDisabled = "Zodra u de loginmodus inschakelt, kunt u gebruikers beheren, instellingen configureren en de servergezondheid monitoren. De eerste {{freeTierLimit}} personen op uw server gebruiken Stirling gratis." +userBody = "Nodig teamgenoten uit, wijs rollen toe en houd uw documenten georganiseerd in één veilige werkruimte. Schakel de loginmodus in wanneer u klaar bent om verder te groeien dan solo-gebruik." [onboarding.securityCheck] -message = "De applicatie heeft recent belangrijke wijzigingen ondergaan. De aandacht van je serveradmin kan nodig zijn. Bevestig je rol om door te gaan." +message = "De applicatie heeft recent belangrijke wijzigingen ondergaan. De aandacht van uw serveradmin kan nodig zijn. Bevestig uw rol om door te gaan." [adminOnboarding] welcome = "Welkom bij de Beheerdersrondleiding! Laten we de krachtige enterprise-functies en instellingen voor systeembeheerders verkennen." configButton = "Klik op de knop Config om alle systeeminstellingen en beheerdersopties te openen." settingsOverview = "Dit is het instellingenpaneel. Beheerinstellingen zijn per categorie georganiseerd voor eenvoudige navigatie." -teamsAndUsers = "Beheer hier Teams en individuele gebruikers. Je kunt nieuwe gebruikers uitnodigen via e-mail, deelbare links, of zelf aangepaste accounts voor hen aanmaken." -systemCustomization = "We hebben uitgebreide manieren om de UI aan te passen: Systeeminstellingen laten je de app-naam en talen wijzigen, Functies maken servercertificaatbeheer mogelijk, en Endpoints laten je specifieke tools voor je gebruikers in- of uitschakelen." -databaseSection = "Voor geavanceerde productieomgevingen hebben we instellingen voor externe database-koppelingen zodat je kunt integreren met je bestaande infrastructuur." +teamsAndUsers = "Beheer hier Teams en individuele gebruikers. U kunt nieuwe gebruikers uitnodigen via e-mail, deelbare links, of zelf aangepaste accounts voor hen aanmaken." +systemCustomization = "We hebben uitgebreide manieren om de UI aan te passen: Systeeminstellingen laten u de app-naam en talen wijzigen, Functies maken servercertificaatbeheer mogelijk, en Endpoints laten uw specifieke tools voor uw gebruikers in- of uitschakelen." +databaseSection = "Voor geavanceerde productieomgevingen hebben we instellingen voor externe database-koppelingen zodat u kunt integreren met uw bestaande infrastructuur." connectionsSection = "De sectie Connections ondersteunt verschillende aanmeldmethoden, inclusief aangepaste SSO en SAML-providers zoals Google en GitHub, plus e-mailintegraties voor meldingen en communicatie." -adminTools = "Tot slot hebben we geavanceerde beheertools zoals Auditing om systeemactiviteit te volgen en Gebruiksanalyses om te monitoren hoe je gebruikers met het platform omgaan." -wrapUp = "Dat was de beheerdersrondleiding! Je hebt de enterprise-functies gezien die van Stirling PDF een krachtige, aanpasbare oplossing voor organisaties maken. Je kunt deze rondleiding altijd starten vanuit het Help-menu." +adminTools = "Tot slot hebben we geavanceerde beheertools zoals Auditing om systeemactiviteit te volgen en Gebruiksanalyses om te monitoren hoe u gebruikers met het platform omgaan." +wrapUp = "Dat was de beheerdersrondleiding! U hebt de enterprise-functies gezien die van Stirling PDF een krachtige, aanpasbare oplossing voor organisaties maken. U kunt deze rondleiding altijd starten vanuit het Help-menu." [workspace] title = "Werkruimte" @@ -5315,12 +5381,12 @@ disable = "Uitschakelen" deleteUser = "Gebruiker verwijderen" deleteUserSuccess = "Gebruiker succesvol verwijderd" deleteUserError = "Gebruiker verwijderen is mislukt" -confirmDelete = "Weet je zeker dat je deze gebruiker wilt verwijderen? Deze actie kan niet ongedaan worden gemaakt." +confirmDelete = "Weet u zeker dat u deze gebruiker wilt verwijderen? Deze actie kan niet ongedaan worden gemaakt." loginRequired = "Schakel eerst de loginmodus in" [workspace.people.inviteMembers] label = "Leden uitnodigen" -subtitle = "Typ of plak hieronder e-mailadressen, gescheiden door komma's. Je werkruimte wordt per lid gefactureerd." +subtitle = "Typ of plak hieronder e-mailadressen, gescheiden door komma's. Uw werkruimte wordt per lid gefactureerd." [workspace.people.actions] label = "Acties" @@ -5470,7 +5536,7 @@ cannotRemoveFromSystemTeam = "Kan niet uit het systeemteam verwijderen" renameTeamLabel = "Team hernoemen" deleteTeamLabel = "Team verwijderen" cannotDeleteInternal = "Kan het team Internal niet verwijderen" -confirmDelete = "Weet je zeker dat je dit team wilt verwijderen? Dit team moet leeg zijn om te kunnen verwijderen." +confirmDelete = "Weet u zeker dat u dit team wilt verwijderen? Dit team moet leeg zijn om te kunnen verwijderen." confirmRemove = "Gebruiker uit dit team verwijderen?" cannotRenameInternal = "Kan het team Internal niet hernoemen" cannotAddToInternal = "Kan geen leden toevoegen aan het team Internal" @@ -5544,18 +5610,18 @@ featureComparison = "Functievergelijking" from = "Vanaf" perMonth = "/maand" perSeat = "/plaats" -withServer = "+ Server-plan" +withServer = "+ Server-abonnement" licensedSeats = "Gelicenseerd: {{count}} plaatsen" -includedInCurrent = "Inbegrepen in je plan" -selectPlan = "Plan selecteren" +includedInCurrent = "Inbegrepen in uw abonnement" +selectPlan = "Abonnement selecteren" manage = "Beheren" [plan.manageSubscription] -description = "Beheer je abonnement, facturatie en betaalmethoden" +description = "Beheer uw abonnement, facturatie en betaalmethoden" [plan.activePlan] title = "Actief abonnement" -subtitle = "Details van je huidige abonnement" +subtitle = "Details van uw huidige abonnement" [plan.availablePlans] title = "Beschikbare abonnementen" @@ -5568,6 +5634,28 @@ contactSales = "Neem contact op met Sales" contactToUpgrade = "Neem contact met ons op om uw abonnement te upgraden of aan te passen" maxUsers = "Max. aantal gebruikers" upTo = "Tot" +getLicense = "Serverlicenties verkrijgen" +upgradeToEnterprise = "Opwaarderen naar Enterprise" +selectPeriod = "Selecteer factureringsperiode" +monthlyBilling = "Maandelijkse facturering" +yearlyBilling = "Jaarlijks facturering" +checkoutOpened = "Afrekening geopend" +checkoutInstructions = "Voltooi de aankoop op het Stripe-tabblad. Keer na betaling hier terug en vernieuw de pagina om uw licentie te activeren. U ontvangt ook een e-mail met uw licentiesleutel." +activateLicense = "Licentie activeren" + +[plan.static.licenseActivation] +checkoutOpened = "Afrekening geopend in nieuw tabblad" +instructions = "Voltooi de aankoop in het Stripe-tabblad. Zodra de betaling is voltooid, ontvangt u een e-mail met uw licentiesleutel." +enterKey = "Voer hieronder de licentiesleutel in om het abonnement te activeren:" +keyDescription = "Plak de licentiesleutel uit uw e-mail" +activate = "Licentie activeren" +doLater = "Dit doe ik later" +success = "Licentie geactiveerd!" +successMessage = "Uw licentie is met succes geactiveerd. U kunt dit venster nu sluiten." + +[plan.static.billingPortal] +title = "E-mailverificatie vereist" +message = "U moet uw e-mailadres verifiëren in het Stripe-betalingsportaal. Controleer uw e-mail voor een inloglink." [plan.period] month = "maand" @@ -5593,7 +5681,7 @@ highlight1 = "Aangepaste prijzen" highlight2 = "Toegewijde ondersteuning" highlight3 = "Nieuwste functies" requiresServer = "Server vereist" -requiresServerMessage = "Upgrade eerst naar het Server-plan voordat je naar Enterprise upgradet." +requiresServerMessage = "Upgrade eerst naar het Server-abonnement voordat u naar Enterprise opwaardeert." [plan.feature] title = "Functie" @@ -5606,9 +5694,9 @@ customPricing = "Aangepaste prijzen" [plan.licenseWarning] title = "Gratis self-hosted limiet bereikt" -body = "Je hebt {{total}} gebruikers, maar de gratis laag ondersteunt slechts {{limit}} per server. Upgrade om Stirling PDF soepel te laten draaien." +body = "U hebt {{total}} gebruikers, maar de gratis laag ondersteunt slechts {{limit}} per server. Upgrade om Stirling PDF soepel te laten draaien." overLimit = "meer dan {{limit}}" -cta = "Plannen bekijken" +cta = "Abonnementen bekijken" [subscription] renewsOn = "Wordt verlengd op {{date}}" @@ -5630,28 +5718,28 @@ currentSeats = "Huidige plaatsen" minimumSeats = "Minimum aantal plaatsen" basedOnUsers = "(huidige gebruikers)" newSeatCount = "Nieuw aantal plaatsen" -newSeatCountDescription = "Selecteer het aantal plaatsen voor je enterpriselicentie" +newSeatCountDescription = "Selecteer het aantal plaatsen voor uw enterpriselicentie" whatHappensNext = "Wat gebeurt er daarna?" -stripePortalRedirect = "Je wordt doorgestuurd naar de Stripe-facturatieportal om de wijziging in plaatsen te bekijken en te bevestigen. Het naar rato bedrag wordt automatisch berekend." +stripePortalRedirect = "U wordt doorgestuurd naar de Stripe-facturatieportal om de wijziging in plaatsen te bekijken en te bevestigen. Het naar rato bedrag wordt automatisch berekend." preparingUpdate = "Plaatsupdate voorbereiden..." seatCountTooLow = "Het aantal plaatsen moet minimaal {{minimum}} zijn (huidig aantal gebruikers)" seatCountUnchanged = "Selecteer een ander aantal plaatsen" seatsUpdated = "Plaatsen bijgewerkt" -seatsUpdatedMessage = "Je enterprise-plaatsen zijn bijgewerkt naar {{seats}}" +seatsUpdatedMessage = "Uw enterprise-plaatsen zijn bijgewerkt naar {{seats}}" updateProcessing = "Update verwerken" -updateProcessingMessage = "Je plaatsupdate wordt verwerkt. Vernieuw over enkele ogenblikken." +updateProcessingMessage = "Uw plaatsupdate wordt verwerkt. Vernieuw over enkele ogenblikken." notEnterprise = "Plaatsbeheer is alleen beschikbaar voor enterpriselicenties" [billing.portal] error = "Kon facturatieportaal niet openen" [upgradeBanner] -title = "Upgraden naar Server-plan" +title = "Upgraden naar Server-abonnement" message = "Haal het meeste uit Stirling PDF met onbeperkte gebruikers en geavanceerde functies" upgradeButton = "Nu upgraden" dismiss = "Banner sluiten" attentionTitle = "Deze server heeft aandacht van een admin nodig" -attentionBody = "Je admin moet inloggen om meer info te zien. Neem direct contact met hen op." +attentionBody = "Uw admin moet inloggen om meer info te zien. Neem direct contact met hen op." attentionBodyAdmin = "Controleer de licentievereisten om deze server compliant te houden." seeInfo = "Info bekijken" @@ -5663,45 +5751,45 @@ success = "Betaling geslaagd!" successMessage = "Uw abonnement is succesvol geactiveerd. U ontvangt binnenkort een bevestigingsmail." autoClose = "Dit venster wordt automatisch gesloten..." error = "Betalingsfout" -upgradeSuccess = "Betaling geslaagd! Je abonnement is geüpgraded. De licentie is op je server bijgewerkt. Je ontvangt binnenkort een bevestigingsmail." +upgradeSuccess = "Betaling geslaagd! Uw abonnement is geüpgraded. De licentie is op uw server bijgewerkt. U ontvangt binnenkort een bevestigingsmail." paymentSuccess = "Betaling geslaagd! Licentiesleutel ophalen..." -licenseActivated = "Licentie geactiveerd! Je licentiesleutel is opgeslagen. Er is een bevestigingsmail verzonden naar je geregistreerde e-mailadres." -licenseDelayed = "Betaling geslaagd! Je licentie wordt gegenereerd. Je ontvangt binnenkort een e-mail met je licentiesleutel. Als je deze niet binnen 10 minuten ontvangt, neem dan contact op met support." -licensePollingError = "Betaling geslaagd, maar we konden je licentiesleutel niet automatisch ophalen. Controleer je e-mail of neem contact op met support met je betalingsbevestiging." -licenseRetrievalError = "Betaling geslaagd, maar het ophalen van de licentie is mislukt. Je ontvangt je licentiesleutel via e-mail. Neem contact op met support als je deze niet binnen 10 minuten ontvangt." -syncError = "Betaling geslaagd, maar licentiesynchronisatie is mislukt. Je licentie wordt binnenkort bijgewerkt. Neem contact op met support als het probleem blijft." -licenseSaveError = "Opslaan van licentiesleutel mislukt. Neem contact op met support met je licentiesleutel om de activatie te voltooien." +licenseActivated = "Licentie geactiveerd! Uw licentiesleutel is opgeslagen. Er is een bevestigingsmail verzonden naar uw geregistreerde e-mailadres." +licenseDelayed = "Betaling geslaagd! Uw licentie wordt gegenereerd. U ontvangt binnenkort een e-mail met uw licentiesleutel. Als u deze niet binnen 10 minuten ontvangt, neem dan contact op met support." +licensePollingError = "Betaling geslaagd, maar we konden uw licentiesleutel niet automatisch ophalen. Controleer uw e-mail of neem contact op met support met uw betalingsbevestiging." +licenseRetrievalError = "Betaling geslaagd, maar het ophalen van de licentie is mislukt. U ontvangt uw licentiesleutel via e-mail. Neem contact op met support als u deze niet binnen 10 minuten ontvangt." +syncError = "Betaling geslaagd, maar licentiesynchronisatie is mislukt. Uw licentie wordt binnenkort bijgewerkt. Neem contact op met support als het probleem blijft." +licenseSaveError = "Opslaan van licentiesleutel mislukt. Neem contact op met support met uw licentiesleutel om de activatie te voltooien." paymentCanceled = "Betaling geannuleerd. Er zijn geen kosten in rekening gebracht." -syncingLicense = "Je geüpgradede licentie synchroniseren..." -generatingLicense = "Je licentiesleutel genereren..." +syncingLicense = "Uw geüpgradede licentie synchroniseren..." +generatingLicense = "Uw licentiesleutel genereren..." upgradeComplete = "Upgrade voltooid" -upgradeCompleteMessage = "Je abonnement is succesvol geüpgraded. Je bestaande licentiesleutel is bijgewerkt." +upgradeCompleteMessage = "Uw abonnement is succesvol geüpgraded. Uw bestaande licentiesleutel is bijgewerkt." stripeNotConfigured = "Stripe niet geconfigureerd" -stripeNotConfiguredMessage = "Stripe-betalintegratie is niet geconfigureerd. Neem contact op met je beheerder." +stripeNotConfiguredMessage = "Stripe-betalintegratie is niet geconfigureerd. Neem contact op met uw beheerder." monthly = "Maandelijks" yearly = "Jaarlijks" billingPeriod = "Facturatieperiode" enterpriseNote = "Plaatsen kunnen worden aangepast bij het afrekenen (1-1000)." installationId = "Installatie-ID" -licenseKey = "Je licentiesleutel" -licenseInstructions = "Dit is toegevoegd aan je installatie. Je ontvangt ook een kopie per e-mail." -canCloseWindow = "Je kunt dit venster nu sluiten." +licenseKey = "Uw licentiesleutel" +licenseInstructions = "Dit is toegevoegd aan uw installatie. U ontvangt ook een kopie per e-mail." +canCloseWindow = "U kunt dit venster nu sluiten." licenseKeyProcessing = "Licentiesleutel verwerken" -licenseDelayedMessage = "Je licentiesleutel wordt gegenereerd. Controleer binnenkort je e-mail of neem contact op met support." +licenseDelayedMessage = "Uw licentiesleutel wordt gegenereerd. Controleer binnenkort uw e-mail of neem contact op met support." perYear = "/jaar" perMonth = "/maand" emailInvalid = "Voer een geldig e-mailadres in" [payment.emailStage] -title = "Vul je e-mailadres in" -description = "We gebruiken dit om je licentiesleutel en kwitanties te sturen." +title = "Vul uw e-mailadres in" +description = "We gebruiken dit om uw licentiesleutel en kwitanties te sturen." emailLabel = "E-mailadres" emailPlaceholder = "your@email.com" continue = "Doorgaan" modalTitle = "Aan de slag - {{planName}}" [payment.planStage] -title = "Kies je facturatieperiode" +title = "Kies uw facturatieperiode" savingsNote = "Bespaar {{percent}}% met jaarlijkse facturatie" basePrice = "Basistarief" seatPrice = "Per plaats" @@ -5709,13 +5797,13 @@ totalForSeats = "Totaal ({{count}} plaatsen)" selectMonthly = "Maandelijks selecteren" selectYearly = "Jaarlijks selecteren" savePercent = "Bespaar {{percent}}%" -savingsAmount = "Je bespaart {{amount}}" +savingsAmount = "U bespaart {{amount}}" modalTitle = "Selecteer facturatieperiode - {{planName}}" billedYearly = "Jaarlijks gefactureerd à {{currency}}{{amount}}" [payment.paymentStage] -backToPlan = "Terug naar planselectie" -selectedPlan = "Geselecteerd plan" +backToPlan = "Terug naar abonnementselectie" +selectedPlan = "Geselecteerd abonnement" modalTitle = "Betaling voltooien - {{planName}}" [firstLogin] @@ -5771,6 +5859,8 @@ notAvailable = "Auditsysteem niet beschikbaar" notAvailableMessage = "Het auditsysteem is niet geconfigureerd of niet beschikbaar." disabled = "Auditlogging is uitgeschakeld" disabledMessage = "Schakel auditlogging in uw applicatieconfiguratie in om systeemevenementen te volgen." +enterpriseRequired = "Enterprise-licentie vereist" +enterpriseRequiredMessage = "Het audit-loggingsysteem is een functie voor ondernemingen. Upgrade naar een ondernemingslicentie om toegang te krijgen tot auditlogboeken en analyses." [audit.error] title = "Fout bij laden van auditsysteem" @@ -5870,11 +5960,11 @@ percentage = "Percentage" noData = "Geen gegevens beschikbaar" [backendHealth] -checking = "Backendstatus controleren..." -online = "Backend online" -offline = "Backend offline" -starting = "Backend wordt gestart..." -wait = "Wacht tot de backend is opgestart en probeer het opnieuw." +checking = "Back-endstatus controleren..." +online = "Back-end online" +offline = "Back-end offline" +starting = "Back-end wordt gestart..." +wait = "Wacht tot de back-end is opgestart en probeer het opnieuw." [encryptedPdfUnlock] unlockPrompt = "Ontgrendel PDF om door te gaan" @@ -5896,7 +5986,7 @@ placeholder = "Voer het PDF-wachtwoord in" [setup] welcome = "Welkom bij Stirling PDF" -description = "Begin door te kiezen hoe je Stirling PDF wilt gebruiken" +description = "Begin door te kiezen hoe u Stirling PDF wilt gebruiken" [setup.step1] label = "Kies modus" @@ -5908,28 +5998,28 @@ description = "Zelfgehoste server" [setup.step3] label = "Inloggen" -description = "Vul je gegevens in" +description = "Vul uw gegevens in" [setup.mode.saas] title = "Stirling Cloud" -description = "Log in met je Stirling-account" +description = "Log in met uw Stirling-account" [setup.mode.selfhosted] title = "Self-hosted server" -description = "Verbind met je eigen Stirling PDF-server" +description = "Verbind met uw eigen Stirling PDF-server" [setup.saas] title = "Inloggen bij Stirling" -subtitle = "Log in met je Stirling-account" +subtitle = "Log in met uw Stirling-account" [setup.selfhosted] title = "Inloggen bij server" -subtitle = "Vul je servergegevens in" +subtitle = "Vul uw servergegevens in" link = "of maak verbinding met een zelfgehost account" [setup.server] title = "Verbinden met server" -subtitle = "Vul de URL van je self-hosted server in" +subtitle = "Vul de URL van uw self-hosted server in" testing = "Verbinding testen..." [setup.server.type] @@ -5938,7 +6028,7 @@ selfhosted = "Zelfgehoste server" [setup.server.url] label = "Server-URL" -description = "Voer de volledige URL van je self-hosted Stirling PDF-server in" +description = "Voer de volledige URL van uw self-hosted Stirling PDF-server in" [setup.server.error] emptyUrl = "Voer een server-URL in" @@ -5955,7 +6045,7 @@ step3 = "Start de server opnieuw" [setup.login] title = "Inloggen" -subtitle = "Vul je gegevens in om door te gaan" +subtitle = "Vul uw gegevens in om door te gaan" connectingTo = "Verbinden met:" submit = "Inloggen" signInWith = "Inloggen met" @@ -5971,20 +6061,20 @@ instructionsRestart = "Start vervolgens uw server opnieuw zodat de wijzigingen v [setup.login.username] label = "Gebruikersnaam" -placeholder = "Voer je gebruikersnaam in" +placeholder = "Voer uw gebruikersnaam in" [setup.login.email] label = "E-mail" -placeholder = "Voer je e-mailadres in" +placeholder = "Voer uw e-mailadres in" [setup.login.password] label = "Wachtwoord" -placeholder = "Voer je wachtwoord in" +placeholder = "Voer uw wachtwoord in" [setup.login.error] -emptyUsername = "Vul je gebruikersnaam in" -emptyEmail = "Vul je e-mailadres in" -emptyPassword = "Vul je wachtwoord in" +emptyUsername = "Vul uw gebruikersnaam in" +emptyEmail = "Vul uw e-mailadres in" +emptyPassword = "Vul uw wachtwoord in" oauthFailed = "OAuth-login mislukt. Probeer het opnieuw." [oauth.success] @@ -6070,11 +6160,11 @@ title = "Welkom bij PDF-teksteditor (Early Access)" experimental = "Dit is een experimentele functie in actieve ontwikkeling. Reken op enige instabiliteit en problemen tijdens het gebruik." howItWorks = "Deze tool zet uw PDF om naar een bewerkbaar formaat waarin u tekst kunt wijzigen en afbeeldingen kunt herpositioneren. Wijzigingen worden opgeslagen als een nieuwe PDF." bestFor = "Werkt het best met:" -bestFor1 = "Eenvoudige PDF's met vooral tekst en afbeeldingen" +bestFor1 = "Eenvoudige PDF-en met vooral tekst en afbeeldingen" bestFor2 = "Documenten met standaard alineavormatting" bestFor3 = "Brieven, essays, rapporten en eenvoudige documenten" notIdealFor = "Niet ideaal voor:" -notIdealFor1 = "PDF's met speciale opmaak zoals opsommingstekens, tabellen of lay-outs met meerdere kolommen" +notIdealFor1 = "PDF-en met speciale opmaak zoals opsommingstekens, tabellen of lay-outs met meerdere kolommen" notIdealFor2 = "Magazines, brochures of sterk vormgegeven documenten" notIdealFor3 = "Handleidingen met complexe lay-outs" limitations = "Huidige beperkingen:" @@ -6084,7 +6174,7 @@ limitation3 = "Grote bestanden kunnen tijd kosten om te converteren en te verwer knownIssues = "Bekende problemen (worden verholpen):" issue1 = "Tekstkleur wordt momenteel niet behouden (wordt binnenkort toegevoegd)" issue2 = "Alineamodus heeft meer problemen met uitlijning en afstand - Enkele-regelmodus aanbevolen" -issue3 = "Het voorbeeld wijkt af van de geëxporteerde PDF - geëxporteerde PDF's liggen dichter bij het origineel" +issue3 = "Het voorbeeld wijkt af van de geëxporteerde PDF - geëxporteerde PDF-en liggen dichter bij het origineel" issue4 = "Uitlijning van gedraaide tekst kan handmatige aanpassing vereisen" issue5 = "Transparantie- en laageffecten kunnen afwijken van het origineel" feedback = "Dit is een functie in vroege toegang. Meld eventuele problemen zodat we kunnen verbeteren!" @@ -6126,7 +6216,7 @@ insufficientPermissions = "U hebt geen toestemming om deze actie uit te voeren." [addText] title = "Tekst toevoegen" -header = "Tekst toevoegen aan PDF's" +header = "Tekst toevoegen aan PDF-en" tags = "tekst,annotatie,label" applySignatures = "Tekst toepassen" diff --git a/frontend/scripts/generate-icons.js b/frontend/scripts/generate-icons.js index d99414b668..8dc91e6cc2 100644 --- a/frontend/scripts/generate-icons.js +++ b/frontend/scripts/generate-icons.js @@ -19,27 +19,27 @@ const debug = (message) => { function scanForUsedIcons() { const usedIcons = new Set(); const srcDir = path.join(__dirname, '..', 'src'); - + info('🔍 Scanning codebase for LocalIcon usage...'); - + if (!fs.existsSync(srcDir)) { console.error('❌ Source directory not found:', srcDir); process.exit(1); } - + // Recursively scan all .tsx and .ts files function scanDirectory(dir) { const files = fs.readdirSync(dir); - + files.forEach(file => { const filePath = path.join(dir, file); const stat = fs.statSync(filePath); - + if (stat.isDirectory()) { scanDirectory(filePath); } else if (file.endsWith('.tsx') || file.endsWith('.ts')) { const content = fs.readFileSync(filePath, 'utf8'); - + // Match LocalIcon usage: const localIconMatches = content.match(/]*icon="([^"]+)"/g); if (localIconMatches) { @@ -51,7 +51,7 @@ function scanForUsedIcons() { } }); } - + // Match old material-symbols-rounded spans: icon-name const spanMatches = content.match(/]*className="[^"]*material-symbols-rounded[^"]*"[^>]*>([^<]+)<\/span>/g); if (spanMatches) { @@ -64,7 +64,7 @@ function scanForUsedIcons() { } }); } - + // Match Icon component usage: const iconMatches = content.match(/]*icon="material-symbols:([^"]+)"/g); if (iconMatches) { @@ -79,12 +79,12 @@ function scanForUsedIcons() { } }); } - + scanDirectory(srcDir); - + const iconArray = Array.from(usedIcons).sort(); info(`📋 Found ${iconArray.length} unique icons across codebase`); - + return iconArray; } @@ -102,7 +102,7 @@ async function main() { const existingSet = JSON.parse(fs.readFileSync(outputPath, 'utf8')); const existingIcons = Object.keys(existingSet.icons || {}).sort(); const currentIcons = [...usedIcons].sort(); - + if (JSON.stringify(existingIcons) === JSON.stringify(currentIcons)) { needsRegeneration = false; info(`✅ Icon set already up-to-date (${usedIcons.length} icons, ${Math.round(fs.statSync(outputPath).size / 1024)}KB)`); @@ -122,7 +122,7 @@ async function main() { // Dynamic import of ES module const { getIcons } = await import('@iconify/utils'); - + // Extract only our used icons from the full set const extractedIcons = getIcons(icons, usedIcons); @@ -183,4 +183,4 @@ export default iconSet; main().catch(error => { console.error('❌ Script failed:', error); process.exit(1); -}); \ No newline at end of file +}); diff --git a/frontend/src-tauri/Cargo.lock b/frontend/src-tauri/Cargo.lock index 320732d4bd..9fa5e03593 100644 --- a/frontend/src-tauri/Cargo.lock +++ b/frontend/src-tauri/Cargo.lock @@ -145,9 +145,9 @@ dependencies = [ [[package]] name = "async-lock" -version = "3.4.1" +version = "3.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5fd03604047cee9b6ce9de9f70c6cd540a0520c813cbd49bae61f33ab80ed1dc" +checksum = "290f7f2596bd5b78a9fec8088ccd89180d7f9f55b94b0576823bbbdc72ee8311" dependencies = [ "event-listener", "event-listener-strategy", @@ -301,22 +301,13 @@ dependencies = [ "generic-array", ] -[[package]] -name = "block2" -version = "0.5.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2c132eebf10f5cad5289222520a4a058514204aed6d791f1cf4fe8088b82d15f" -dependencies = [ - "objc2 0.5.2", -] - [[package]] name = "block2" version = "0.6.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cdeb9d870516001442e364c5220d3574d2da8dc765554b4a617230d33fa58ef5" dependencies = [ - "objc2 0.6.3", + "objc2", ] [[package]] @@ -378,9 +369,9 @@ dependencies = [ [[package]] name = "bumpalo" -version = "3.19.0" +version = "3.19.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "46c5e41b57b8bba42a04676d81cb89e9ee8e859a1a66f80a5a72e1cb76b34d43" +checksum = "5dd9dc738b7a8311c7ade152424974d8115f2cdad61e8dab8dac9f2362298510" [[package]] name = "byte-unit" @@ -389,7 +380,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8c6d47a4e2961fb8721bcfc54feae6455f2f64e7054f9bc67e875f0e77f4c58d" dependencies = [ "rust_decimal", - "schemars 1.1.0", + "schemars 1.2.0", "serde", "utf8-width", ] @@ -464,9 +455,9 @@ dependencies = [ [[package]] name = "camino" -version = "1.2.1" +version = "1.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "276a59bf2b2c967788139340c9f0c5b12d7fd6630315c15c217e559de85d2609" +checksum = "e629a66d692cb9ff1a1c664e41771b3dcaf961985a9774c0eb0bd1b51cf60a48" dependencies = [ "serde_core", ] @@ -501,14 +492,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "374b7c592d9c00c1f4972ea58390ac6b18cbb6ab79011f3bdc90a0b82ca06b77" dependencies = [ "serde", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", ] [[package]] name = "cc" -version = "1.2.48" +version = "1.2.51" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c481bdbf0ed3b892f6f806287d72acd515b352a4ec27a208489b8c1bc839633a" +checksum = "7a0aeaff4ff1a90589618835a598e545176939b97874f7abc7851caa0618f203" dependencies = [ "find-msvc-tools", "shlex", @@ -590,6 +581,26 @@ dependencies = [ "crossbeam-utils", ] +[[package]] +name = "const-random" +version = "0.1.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87e00182fe74b066627d63b85fd550ac2998d4b0bd86bfed477a0ae4c7c71359" +dependencies = [ + "const-random-macro", +] + +[[package]] +name = "const-random-macro" +version = "0.1.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9d839f2a20b0aee515dc581a6172f2321f96cab76c1a38a4c584a194955390e" +dependencies = [ + "getrandom 0.2.16", + "once_cell", + "tiny-keccak", +] + [[package]] name = "convert_case" version = "0.4.0" @@ -625,6 +636,24 @@ dependencies = [ "url", ] +[[package]] +name = "cookie_store" +version = "0.22.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fc4bff745c9b4c7fb1e97b25d13153da2bc7796260141df62378998d070207f" +dependencies = [ + "cookie", + "document-features", + "idna", + "log", + "publicsuffix", + "serde", + "serde_derive", + "serde_json", + "time", + "url", +] + [[package]] name = "core-foundation" version = "0.9.4" @@ -717,6 +746,12 @@ version = "0.8.21" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28" +[[package]] +name = "crunchy" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "460fbee9c2c2f33933d720630a6a0bac33ba7053db5344fac858d4b8952d77d5" + [[package]] name = "crypto-common" version = "0.1.7" @@ -872,7 +907,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "89a09f22a6c6069a18470eb92d2298acf25463f14256d24778e1230d789a2aec" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", + "objc2", ] [[package]] @@ -888,9 +923,9 @@ dependencies = [ [[package]] name = "dlopen2" -version = "0.8.1" +version = "0.8.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8d65cde5fb0c42a3d5882d99807698b459f5928de035fa7f547c784fb7b34219" +checksum = "5e2c5bd4158e66d1e215c49b837e11d62f3267b30c92f1d171c4d3105e3dc4d4" dependencies = [ "dlopen2_derive", "libc", @@ -900,15 +935,24 @@ dependencies = [ [[package]] name = "dlopen2_derive" -version = "0.4.2" +version = "0.4.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "95f4a04e1bfbfa4835a6073177aafb95ead4de0722dbb339195fdc7e0a09599b" +checksum = "0fbbb781877580993a8707ec48672673ec7b81eeba04cfd2310bd28c08e47c8f" dependencies = [ "proc-macro2", "quote", "syn 2.0.111", ] +[[package]] +name = "dlv-list" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "442039f5147480ba31067cb00ada1adae6892028e40e45fc5de7b7df6dcc1b5f" +dependencies = [ + "const-random", +] + [[package]] name = "document-features" version = "0.2.12" @@ -929,9 +973,9 @@ dependencies = [ [[package]] name = "dtoa" -version = "1.0.10" +version = "1.0.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d6add3b8cff394282be81f3fc1a0605db594ed69890078ca6e2cab1c408bcf04" +checksum = "4c3cf4824e2d5f025c7b531afcb2325364084a16806f6d47fbc1f5fbd9960590" [[package]] name = "dtoa-short" @@ -963,7 +1007,7 @@ dependencies = [ "cc", "memchr", "rustc_version", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", "vswhom", "winreg", ] @@ -1104,9 +1148,9 @@ dependencies = [ [[package]] name = "find-msvc-tools" -version = "0.1.5" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3a3076410a55c90011c298b04d0cfa770b00fa04e1e3c97d3f6c9de105a03844" +checksum = "645cbb3a84e60b7531617d5ae4e57f7e27308f6445f5abf653209ea76dec8dff" [[package]] name = "flate2" @@ -1608,6 +1652,12 @@ dependencies = [ "ahash", ] +[[package]] +name = "hashbrown" +version = "0.14.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" + [[package]] name = "hashbrown" version = "0.16.1" @@ -1773,7 +1823,7 @@ dependencies = [ "tokio", "tower-service", "tracing", - "windows-registry", + "windows-registry 0.6.1", ] [[package]] @@ -1858,9 +1908,9 @@ checksum = "7aedcccd01fc5fe81e6b489c15b247b8b0690feb23304303a9e560f37efc560a" [[package]] name = "icu_properties" -version = "2.1.1" +version = "2.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e93fcd3157766c0c8da2f8cff6ce651a31f0810eaa1c51ec363ef790bbb5fb99" +checksum = "020bfc02fe870ec3a66d93e677ccca0562506e5872c650f893269e08615d74ec" dependencies = [ "icu_collections", "icu_locale_core", @@ -1872,9 +1922,9 @@ dependencies = [ [[package]] name = "icu_properties_data" -version = "2.1.1" +version = "2.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "02845b3647bb045f1100ecd6480ff52f34c35f82d9880e029d329c21d1054899" +checksum = "616c294cf8d725c6afcd8f55abc17c56464ef6211f9ed59cccffe534129c77af" [[package]] name = "icu_provider" @@ -1958,9 +2008,9 @@ checksum = "469fb0b9cefa57e3ef31275ee7cacb78f2fdca44e4765491884a2b119d4eb130" [[package]] name = "iri-string" -version = "0.7.9" +version = "0.7.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4f867b9d1d896b67beb18518eda36fdb77a32ea590de864f1325b294a6d14397" +checksum = "c91338f0783edbd6195decb37bae672fd3b165faffb89bf7b9e6942f8b1a731a" dependencies = [ "memchr", "serde", @@ -1987,9 +2037,9 @@ dependencies = [ [[package]] name = "itoa" -version = "1.0.15" +version = "1.0.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c" +checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2" [[package]] name = "javascriptcore-rs" @@ -2153,9 +2203,9 @@ dependencies = [ [[package]] name = "libredox" -version = "0.1.10" +version = "0.1.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "416f7e718bdb06000964960ffa43b4335ad4012ae8b99060261aa4a8088d5ccb" +checksum = "3d0b95e02c851351f877147b7deea7b1afb1df71b63aa5f8270716e0c5720616" dependencies = [ "bitflags 2.10.0", "libc", @@ -2292,10 +2342,10 @@ dependencies = [ "dpi", "gtk", "keyboard-types", - "objc2 0.6.3", + "objc2", "objc2-app-kit", "objc2-core-foundation", - "objc2-foundation 0.3.2", + "objc2-foundation", "once_cell", "png", "serde", @@ -2421,22 +2471,6 @@ dependencies = [ "libc", ] -[[package]] -name = "objc-sys" -version = "0.3.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cdb91bdd390c7ce1a8607f35f3ca7151b65afc0ff5ff3b34fa350f7d7c7e4310" - -[[package]] -name = "objc2" -version = "0.5.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "46a785d4eeff09c14c487497c162e92766fbb3e4059a71840cecc03d9a50b804" -dependencies = [ - "objc-sys", - "objc2-encode", -] - [[package]] name = "objc2" version = "0.6.3" @@ -2454,9 +2488,9 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d49e936b501e5c5bf01fda3a9452ff86dc3ea98ad5f283e1455153142d97518c" dependencies = [ "bitflags 2.10.0", - "block2 0.6.2", + "block2", "libc", - "objc2 0.6.3", + "objc2", "objc2-cloud-kit", "objc2-core-data", "objc2-core-foundation", @@ -2464,8 +2498,8 @@ dependencies = [ "objc2-core-image", "objc2-core-text", "objc2-core-video", - "objc2-foundation 0.3.2", - "objc2-quartz-core 0.3.2", + "objc2-foundation", + "objc2-quartz-core", ] [[package]] @@ -2475,8 +2509,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "73ad74d880bb43877038da939b7427bba67e9dd42004a18b809ba7d87cee241c" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", - "objc2-foundation 0.3.2", + "objc2", + "objc2-foundation", ] [[package]] @@ -2486,8 +2520,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0b402a653efbb5e82ce4df10683b6b28027616a2715e90009947d50b8dd298fa" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", - "objc2-foundation 0.3.2", + "objc2", + "objc2-foundation", ] [[package]] @@ -2498,7 +2532,7 @@ checksum = "2a180dd8642fa45cdb7dd721cd4c11b1cadd4929ce112ebd8b9f5803cc79d536" dependencies = [ "bitflags 2.10.0", "dispatch2", - "objc2 0.6.3", + "objc2", ] [[package]] @@ -2509,7 +2543,7 @@ checksum = "e022c9d066895efa1345f8e33e584b9f958da2fd4cd116792e15e07e4720a807" dependencies = [ "bitflags 2.10.0", "dispatch2", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", "objc2-io-surface", ] @@ -2520,8 +2554,8 @@ version = "0.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e5d563b38d2b97209f8e861173de434bd0214cf020e3423a52624cd1d989f006" dependencies = [ - "objc2 0.6.3", - "objc2-foundation 0.3.2", + "objc2", + "objc2-foundation", ] [[package]] @@ -2531,7 +2565,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0cde0dfb48d25d2b4862161a4d5fcc0e3c24367869ad306b0c9ec0073bfed92d" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", "objc2-core-graphics", ] @@ -2543,7 +2577,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d425caf1df73233f29fd8a5c3e5edbc30d2d4307870f802d18f00d83dc5141a6" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", "objc2-core-graphics", "objc2-io-surface", @@ -2564,18 +2598,6 @@ dependencies = [ "cc", ] -[[package]] -name = "objc2-foundation" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0ee638a5da3799329310ad4cfa62fbf045d5f56e3ef5ba4149e7452dcf89d5a8" -dependencies = [ - "bitflags 2.10.0", - "block2 0.5.1", - "libc", - "objc2 0.5.2", -] - [[package]] name = "objc2-foundation" version = "0.3.2" @@ -2583,9 +2605,9 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e3e0adef53c21f888deb4fa59fc59f7eb17404926ee8a6f59f5df0fd7f9f3272" dependencies = [ "bitflags 2.10.0", - "block2 0.6.2", + "block2", "libc", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", ] @@ -2596,7 +2618,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "180788110936d59bab6bd83b6060ffdfffb3b922ba1396b312ae795e1de9d81d" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", ] @@ -2606,35 +2628,10 @@ version = "0.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2a1e6550c4caed348956ce3370c9ffeca70bb1dbed4fa96112e7c6170e074586" dependencies = [ - "objc2 0.6.3", + "objc2", "objc2-core-foundation", ] -[[package]] -name = "objc2-metal" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dd0cba1276f6023976a406a14ffa85e1fdd19df6b0f737b063b95f6c8c7aadd6" -dependencies = [ - "bitflags 2.10.0", - "block2 0.5.1", - "objc2 0.5.2", - "objc2-foundation 0.2.2", -] - -[[package]] -name = "objc2-quartz-core" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e42bee7bff906b14b167da2bac5efe6b6a07e6f7c0a21a7308d40c960242dc7a" -dependencies = [ - "bitflags 2.10.0", - "block2 0.5.1", - "objc2 0.5.2", - "objc2-foundation 0.2.2", - "objc2-metal", -] - [[package]] name = "objc2-quartz-core" version = "0.3.2" @@ -2642,8 +2639,9 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "96c1358452b371bf9f104e21ec536d37a650eb10f7ee379fff67d2e08d537f1f" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", - "objc2-foundation 0.3.2", + "objc2", + "objc2-core-foundation", + "objc2-foundation", ] [[package]] @@ -2653,7 +2651,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "709fe137109bd1e8b5a99390f77a7d8b2961dafc1a1c5db8f2e60329ad6d895a" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", ] @@ -2664,9 +2662,9 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d87d638e33c06f577498cbcc50491496a3ed4246998a7fbba7ccb98b1e7eab22" dependencies = [ "bitflags 2.10.0", - "objc2 0.6.3", + "objc2", "objc2-core-foundation", - "objc2-foundation 0.3.2", + "objc2-foundation", ] [[package]] @@ -2676,11 +2674,11 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b2e5aaab980c433cf470df9d7af96a7b46a9d892d521a2cbbb2f8a4c16751e7f" dependencies = [ "bitflags 2.10.0", - "block2 0.6.2", - "objc2 0.6.3", + "block2", + "objc2", "objc2-app-kit", "objc2-core-foundation", - "objc2-foundation 0.3.2", + "objc2-foundation", "objc2-javascript-core", "objc2-security", ] @@ -2753,6 +2751,16 @@ version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" +[[package]] +name = "ordered-multimap" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49203cdcae0030493bad186b28da2fa25645fa276a51b6fec8010d281e02ef79" +dependencies = [ + "dlv-list", + "hashbrown 0.14.5", +] + [[package]] name = "ordered-stream" version = "0.2.0" @@ -3098,7 +3106,7 @@ version = "3.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "219cb19e96be00ab2e37d6e299658a0cfa83e52429179969b0f0121b4ac46983" dependencies = [ - "toml_edit 0.23.7", + "toml_edit 0.23.10+spec-1.0.0", ] [[package]] @@ -3133,9 +3141,9 @@ checksum = "dc375e1527247fe1a97d8b7156678dfe7c1af2fc075c9a4db3690ecd2a148068" [[package]] name = "proc-macro2" -version = "1.0.103" +version = "1.0.104" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5ee95bc4ef87b8d5ba32e8b7714ccc834865276eab0aed5c9958d00ec45f49e8" +checksum = "9695f8df41bb4f3d222c95a67532365f569318332d03d5f3f67f37b20e6ebdf0" dependencies = [ "unicode-ident", ] @@ -3457,14 +3465,14 @@ dependencies = [ [[package]] name = "reqwest" -version = "0.12.24" +version = "0.12.28" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9d0946410b9f7b082a427e4ef5c8ff541a88b357bc6c637c40db3a68ac70a36f" +checksum = "eddd3ca559203180a307f12d114c268abf583f59b03cb906fd0b3ff8646c1147" dependencies = [ "base64 0.22.1", "bytes", "cookie", - "cookie_store", + "cookie_store 0.22.0", "encoding_rs", "futures-core", "futures-util", @@ -3547,6 +3555,16 @@ dependencies = [ "syn 1.0.109", ] +[[package]] +name = "rust-ini" +version = "0.21.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "796e8d2b6696392a43bea58116b667fb4c29727dc5abd27d6acf338bb4f688c7" +dependencies = [ + "cfg-if", + "ordered-multimap", +] + [[package]] name = "rust_decimal" version = "1.39.0" @@ -3580,9 +3598,9 @@ dependencies = [ [[package]] name = "rustix" -version = "1.1.2" +version = "1.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cd15f8a2c5551a84d56efdc1cd049089e409ac19a3072d5037a17fd70719ff3e" +checksum = "146c9e247ccc180c1f61615433868c99f3de3ae256a30a43b49f67c2d9171f34" dependencies = [ "bitflags 2.10.0", "errno", @@ -3607,9 +3625,9 @@ dependencies = [ [[package]] name = "rustls-pki-types" -version = "1.13.1" +version = "1.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "708c0f9d5f54ba0272468c1d306a52c495b31fa155e91bc25371e6df7996908c" +checksum = "21e6f2ab2928ca4291b86736a8bd920a277a399bba1589409d72154ff87c1282" dependencies = [ "web-time", "zeroize", @@ -3634,9 +3652,9 @@ checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d" [[package]] name = "ryu" -version = "1.0.20" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f" +checksum = "a50f4cf475b65d88e057964e0e9bb1f0aa9bbb2036dc65c64596b42932536984" [[package]] name = "same-file" @@ -3685,9 +3703,9 @@ dependencies = [ [[package]] name = "schemars" -version = "1.1.0" +version = "1.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9558e172d4e8533736ba97870c4b2cd63f84b382a3d6eb063da41b91cce17289" +checksum = "54e910108742c57a770f492731f99be216a52fadd361b06c8fb59d74ccc267d2" dependencies = [ "dyn-clone", "ref-cast", @@ -3838,15 +3856,15 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.145" +version = "1.0.148" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "402a6f66d8c709116cf22f558eab210f5a50187f702eb4d7e5ef38d9a7f1c79c" +checksum = "3084b546a1dd6289475996f182a22aba973866ea8e8b02c51d9f46b1336a22da" dependencies = [ "itoa", "memchr", - "ryu", "serde", "serde_core", + "zmij", ] [[package]] @@ -3871,9 +3889,9 @@ dependencies = [ [[package]] name = "serde_spanned" -version = "1.0.3" +version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e24345aa0fe688594e73770a5f6d1b216508b4f93484c0026d521acd30134392" +checksum = "f8bbf91e5a4d6315eee45e704372590b30e260ee83af6639d64557f51b067776" dependencies = [ "serde_core", ] @@ -3902,7 +3920,7 @@ dependencies = [ "indexmap 1.9.3", "indexmap 2.12.1", "schemars 0.9.0", - "schemars 1.1.0", + "schemars 1.2.0", "serde_core", "serde_json", "serde_with_macros", @@ -4004,18 +4022,19 @@ dependencies = [ [[package]] name = "signal-hook-registry" -version = "1.4.7" +version = "1.4.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7664a098b8e616bdfcc2dc0e9ac44eb231eedf41db4e9fe95d8d32ec728dedad" +checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b" dependencies = [ + "errno", "libc", ] [[package]] name = "simd-adler32" -version = "0.3.7" +version = "0.3.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe" +checksum = "e320a6c5ad31d271ad523dcf3ad13e2767ad8b1cb8f047f75a8aeaf8da139da2" [[package]] name = "simdutf8" @@ -4059,24 +4078,24 @@ dependencies = [ [[package]] name = "softbuffer" -version = "0.4.6" +version = "0.4.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "18051cdd562e792cad055119e0cdb2cfc137e44e3987532e0f9659a77931bb08" +checksum = "aac18da81ebbf05109ab275b157c22a653bb3c12cf884450179942f81bcbf6c3" dependencies = [ "bytemuck", - "cfg_aliases", - "core-graphics", - "foreign-types 0.5.0", "js-sys", - "log", - "objc2 0.5.2", - "objc2-foundation 0.2.2", - "objc2-quartz-core 0.2.2", + "ndk", + "objc2", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-foundation", + "objc2-quartz-core", "raw-window-handle", "redox_syscall", + "tracing", "wasm-bindgen", "web-sys", - "windows-sys 0.59.0", + "windows-sys 0.61.2", ] [[package]] @@ -4133,6 +4152,7 @@ dependencies = [ "sha2", "tauri", "tauri-build", + "tauri-plugin-deep-link", "tauri-plugin-fs", "tauri-plugin-http", "tauri-plugin-log", @@ -4278,7 +4298,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f3a753bdc39c07b192151523a3f77cd0394aa75413802c883a0f6f6a0e5ee2e7" dependencies = [ "bitflags 2.10.0", - "block2 0.6.2", + "block2", "core-foundation 0.10.1", "core-graphics", "crossbeam-channel", @@ -4295,9 +4315,9 @@ dependencies = [ "ndk", "ndk-context", "ndk-sys", - "objc2 0.6.3", + "objc2", "objc2-app-kit", - "objc2-foundation 0.3.2", + "objc2-foundation", "once_cell", "parking_lot", "raw-window-handle", @@ -4336,9 +4356,9 @@ checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1" [[package]] name = "tauri" -version = "2.9.4" +version = "2.9.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "15524fc7959bfcaa051ba6d0b3fb1ef18e978de2176c7c6acb977f7fd14d35c7" +checksum = "8a3868da5508446a7cd08956d523ac3edf0a8bc20bf7e4038f9a95c2800d2033" dependencies = [ "anyhow", "bytes", @@ -4356,9 +4376,9 @@ dependencies = [ "log", "mime", "muda", - "objc2 0.6.3", + "objc2", "objc2-app-kit", - "objc2-foundation 0.3.2", + "objc2-foundation", "objc2-ui-kit", "objc2-web-kit", "percent-encoding", @@ -4403,7 +4423,7 @@ dependencies = [ "serde_json", "tauri-utils", "tauri-winres", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", "walkdir", ] @@ -4461,10 +4481,31 @@ dependencies = [ "serde", "serde_json", "tauri-utils", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", "walkdir", ] +[[package]] +name = "tauri-plugin-deep-link" +version = "2.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e82759f7c7d51de3cbde51c04b3f2332de52436ed84541182cd8944b04e9e73" +dependencies = [ + "dunce", + "plist", + "rust-ini", + "serde", + "serde_json", + "tauri", + "tauri-plugin", + "tauri-utils", + "thiserror 2.0.17", + "tracing", + "url", + "windows-registry 0.5.3", + "windows-result 0.3.4", +] + [[package]] name = "tauri-plugin-fs" version = "2.4.4" @@ -4483,7 +4524,7 @@ dependencies = [ "tauri-plugin", "tauri-utils", "thiserror 2.0.17", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", "url", ] @@ -4494,7 +4535,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c00685aceab12643cf024f712ab0448ba8fcadf86f2391d49d2e5aa732aacc70" dependencies = [ "bytes", - "cookie_store", + "cookie_store 0.21.1", "data-url", "http", "regex", @@ -4521,8 +4562,8 @@ dependencies = [ "byte-unit", "fern", "log", - "objc2 0.6.3", - "objc2-foundation 0.3.2", + "objc2", + "objc2-foundation", "serde", "serde_json", "serde_repr", @@ -4542,7 +4583,7 @@ dependencies = [ "dunce", "glob", "objc2-app-kit", - "objc2-foundation 0.3.2", + "objc2-foundation", "open", "schemars 0.8.22", "serde", @@ -4585,6 +4626,7 @@ dependencies = [ "serde", "serde_json", "tauri", + "tauri-plugin-deep-link", "thiserror 2.0.17", "tracing", "windows-sys 0.60.2", @@ -4618,7 +4660,7 @@ dependencies = [ "gtk", "http", "jni", - "objc2 0.6.3", + "objc2", "objc2-ui-kit", "objc2-web-kit", "raw-window-handle", @@ -4634,17 +4676,17 @@ dependencies = [ [[package]] name = "tauri-runtime-wry" -version = "2.9.2" +version = "2.9.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7950f3bde6bcca6655bc5e76d3d6ec587ceb81032851ab4ddbe1f508bdea2729" +checksum = "187a3f26f681bdf028f796ccf57cf478c1ee422c50128e5a0a6ebeb3f5910065" dependencies = [ "gtk", "http", "jni", "log", - "objc2 0.6.3", + "objc2", "objc2-app-kit", - "objc2-foundation 0.3.2", + "objc2-foundation", "once_cell", "percent-encoding", "raw-window-handle", @@ -4690,7 +4732,7 @@ dependencies = [ "serde_with", "swift-rs", "thiserror 2.0.17", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", "url", "urlpattern", "uuid", @@ -4705,14 +4747,14 @@ checksum = "1087b111fe2b005e42dbdc1990fc18593234238d47453b0c99b7de1c9ab2c1e0" dependencies = [ "dunce", "embed-resource", - "toml 0.9.8", + "toml 0.9.10+spec-1.1.0", ] [[package]] name = "tempfile" -version = "3.23.0" +version = "3.24.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2d31c77bdf42a745371d260a26ca7163f1e0924b64afa0b688e61b5a9fa02f16" +checksum = "655da9c7eb6305c55742045d5a8d2037996d61d8de95806335c7c86ce0f82e9c" dependencies = [ "fastrand", "getrandom 0.3.4", @@ -4805,6 +4847,15 @@ dependencies = [ "time-core", ] +[[package]] +name = "tiny-keccak" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2c9d3793400a45f954c52e73d068316d76b6f4e36977e3fcebb13a2721e80237" +dependencies = [ + "crunchy", +] + [[package]] name = "tiny_http" version = "0.12.0" @@ -4915,14 +4966,14 @@ dependencies = [ [[package]] name = "toml" -version = "0.9.8" +version = "0.9.10+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0dc8b1fb61449e27716ec0e1bdf0f6b8f3e8f6b05391e8497b8b6d7804ea6d8" +checksum = "0825052159284a1a8b4d6c0c86cbc801f2da5afd2b225fa548c72f2e74002f48" dependencies = [ "indexmap 2.12.1", "serde_core", - "serde_spanned 1.0.3", - "toml_datetime 0.7.3", + "serde_spanned 1.0.4", + "toml_datetime 0.7.5+spec-1.1.0", "toml_parser", "toml_writer", "winnow 0.7.14", @@ -4939,9 +4990,9 @@ dependencies = [ [[package]] name = "toml_datetime" -version = "0.7.3" +version = "0.7.5+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f2cdb639ebbc97961c51720f858597f7f24c4fc295327923af55b74c3c724533" +checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347" dependencies = [ "serde_core", ] @@ -4972,30 +5023,30 @@ dependencies = [ [[package]] name = "toml_edit" -version = "0.23.7" +version = "0.23.10+spec-1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6485ef6d0d9b5d0ec17244ff7eb05310113c3f316f2d14200d4de56b3cb98f8d" +checksum = "84c8b9f757e028cee9fa244aea147aab2a9ec09d5325a9b01e0a49730c2b5269" dependencies = [ "indexmap 2.12.1", - "toml_datetime 0.7.3", + "toml_datetime 0.7.5+spec-1.1.0", "toml_parser", "winnow 0.7.14", ] [[package]] name = "toml_parser" -version = "1.0.4" +version = "1.0.6+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c0cbe268d35bdb4bb5a56a2de88d0ad0eb70af5384a99d648cd4b3d04039800e" +checksum = "a3198b4b0a8e11f09dd03e133c0280504d0801269e9afa46362ffde1cbeebf44" dependencies = [ "winnow 0.7.14", ] [[package]] name = "toml_writer" -version = "1.0.4" +version = "1.0.6+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "df8b2b54733674ad286d16267dcfc7a71ed5c776e4ac7aa3c3e2561f7c637bf2" +checksum = "ab16f14aed21ee8bfd8ec22513f7287cd4a91aa92e44edfe2c17ddd004e92607" [[package]] name = "tower" @@ -5014,9 +5065,9 @@ dependencies = [ [[package]] name = "tower-http" -version = "0.6.7" +version = "0.6.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9cf146f99d442e8e68e585f5d798ccd3cad9a7835b917e09728880a862706456" +checksum = "d4e6559d53cc268e5031cd8429d05415bc4cb4aefc4aa5d6cc35fbf5b924a1f8" dependencies = [ "bitflags 2.10.0", "bytes", @@ -5044,9 +5095,9 @@ checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" [[package]] name = "tracing" -version = "0.1.43" +version = "0.1.44" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2d15d90a0b5c19378952d479dc858407149d7bb45a14de0142f6c534b16fc647" +checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" dependencies = [ "pin-project-lite", "tracing-attributes", @@ -5066,9 +5117,9 @@ dependencies = [ [[package]] name = "tracing-core" -version = "0.1.35" +version = "0.1.36" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7a04e24fab5c89c6a36eb8558c9656f30d81de51dfa4d3b45f26b21d61fa0a6c" +checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" dependencies = [ "once_cell", ] @@ -5083,11 +5134,11 @@ dependencies = [ "dirs", "libappindicator", "muda", - "objc2 0.6.3", + "objc2", "objc2-app-kit", "objc2-core-foundation", "objc2-core-graphics", - "objc2-foundation 0.3.2", + "objc2-foundation", "once_cell", "png", "serde", @@ -5544,10 +5595,10 @@ version = "0.6.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d9bec5a31f3f9362f2258fd0e9c9dd61a9ca432e7306cc78c444258f0dce9a9c" dependencies = [ - "objc2 0.6.3", + "objc2", "objc2-app-kit", "objc2-core-foundation", - "objc2-foundation 0.3.2", + "objc2-foundation", "raw-window-handle", "windows-sys 0.59.0", "windows-version", @@ -5656,6 +5707,17 @@ dependencies = [ "windows-link 0.1.3", ] +[[package]] +name = "windows-registry" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b8a9ed28765efc97bbc954883f4e6796c33a06546ebafacbabee9696967499e" +dependencies = [ + "windows-link 0.1.3", + "windows-result 0.3.4", + "windows-strings 0.4.2", +] + [[package]] name = "windows-registry" version = "0.6.1" @@ -5999,7 +6061,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "728b7d4c8ec8d81cab295e0b5b8a4c263c0d41a785fb8f8c4df284e5411140a2" dependencies = [ "base64 0.22.1", - "block2 0.6.2", + "block2", "cookie", "crossbeam-channel", "dirs", @@ -6014,10 +6076,10 @@ dependencies = [ "kuchikiki", "libc", "ndk", - "objc2 0.6.3", + "objc2", "objc2-app-kit", "objc2-core-foundation", - "objc2-foundation 0.3.2", + "objc2-foundation", "objc2-ui-kit", "objc2-web-kit", "once_cell", @@ -6231,6 +6293,12 @@ dependencies = [ "syn 2.0.111", ] +[[package]] +name = "zmij" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f4a4e8e9dc5c62d159f04fcdbe07f4c3fb710415aab4754bf11505501e3251d" + [[package]] name = "zvariant" version = "5.8.0" diff --git a/frontend/src-tauri/Cargo.toml b/frontend/src-tauri/Cargo.toml index c438c6556c..59a8b911cc 100644 --- a/frontend/src-tauri/Cargo.toml +++ b/frontend/src-tauri/Cargo.toml @@ -31,12 +31,13 @@ tauri-plugin-log = "2.7.1" tauri-plugin-shell = "2.3.3" tauri-plugin-fs = "2.4.4" tauri-plugin-http = "2.5.4" -tauri-plugin-single-instance = "2.3.6" +tauri-plugin-single-instance = { version = "2.3.6", features = ["deep-link"] } tauri-plugin-store = "2.4.1" tauri-plugin-opener = "2.5.2" keyring = { version = "3.6.3", features = ["apple-native", "windows-native"] } tokio = { version = "1.48", features = ["time", "sync"] } reqwest = { version = "0.12", features = ["json"] } +tauri-plugin-deep-link = "2.4.5" tiny_http = "0.12" url = "2.5" urlencoding = "2.1" diff --git a/frontend/src-tauri/capabilities/default.json b/frontend/src-tauri/capabilities/default.json index b992b32211..445e1d30a5 100644 --- a/frontend/src-tauri/capabilities/default.json +++ b/frontend/src-tauri/capabilities/default.json @@ -19,6 +19,8 @@ { "identifier": "fs:allow-read-file", "allow": [{ "path": "**" }] - } + }, + "opener:default", + "shell:allow-open" ] } diff --git a/frontend/src-tauri/src/lib.rs b/frontend/src-tauri/src/lib.rs index 0bf2f79bf7..2c5ee8f8e0 100644 --- a/frontend/src-tauri/src/lib.rs +++ b/frontend/src-tauri/src/lib.rs @@ -1,4 +1,4 @@ -use tauri::{Manager, RunEvent, WindowEvent, Emitter}; +use tauri::{AppHandle, Emitter, Manager, RunEvent, WindowEvent}; mod utils; mod commands; @@ -28,6 +28,17 @@ use commands::{ }; use state::connection_state::AppConnectionState; use utils::{add_log, get_tauri_logs}; +use tauri_plugin_deep_link::DeepLinkExt; + +fn dispatch_deep_link(app: &AppHandle, url: &str) { + add_log(format!("🔗 Dispatching deep link: {}", url)); + let _ = app.emit("deep-link", url.to_string()); + + if let Some(window) = app.get_webview_window("main") { + let _ = window.set_focus(); + let _ = window.unminimize(); + } +} #[cfg(target_os = "linux")] fn configure_linux_webview() { @@ -67,6 +78,7 @@ pub fn run() { .plugin(tauri_plugin_fs::init()) .plugin(tauri_plugin_http::init()) .plugin(tauri_plugin_store::Builder::new().build()) + .plugin(tauri_plugin_deep_link::init()) .manage(AppConnectionState::default()) .plugin(tauri_plugin_single_instance::init(|app, args, _cwd| { // This callback runs when a second instance tries to start @@ -103,6 +115,29 @@ pub fn run() { } } + { + let app_handle = app.handle(); + // On macOS the plugin registers schemes via bundle metadata, so runtime registration is required only on Windows/Linux + #[cfg(any(target_os = "linux", target_os = "windows"))] + if let Err(err) = app_handle.deep_link().register_all() { + add_log(format!("⚠️ Failed to register deep link handler: {}", err)); + } + + if let Ok(Some(urls)) = app_handle.deep_link().get_current() { + let initial_handle = app_handle.clone(); + for url in urls { + dispatch_deep_link(&initial_handle, url.as_str()); + } + } + + let event_app_handle = app_handle.clone(); + app_handle.deep_link().on_open_url(move |event| { + for url in event.urls() { + dispatch_deep_link(&event_app_handle, url.as_str()); + } + }); + } + // Start backend immediately, non-blocking let app_handle = app.handle().clone(); diff --git a/frontend/src-tauri/tauri.conf.json b/frontend/src-tauri/tauri.conf.json index 6434d9f524..51a97931bb 100644 --- a/frontend/src-tauri/tauri.conf.json +++ b/frontend/src-tauri/tauri.conf.json @@ -1,7 +1,7 @@ { "$schema": "../node_modules/@tauri-apps/cli/config.schema.json", "productName": "Stirling-PDF", - "version": "2.0.3", + "version": "2.2.0", "identifier": "stirling.pdf.dev", "build": { "frontendDist": "../dist", @@ -22,7 +22,14 @@ }, "bundle": { "active": true, - "targets": ["deb", "rpm", "appimage", "dmg", "app", "msi"], + "targets": [ + "deb", + "rpm", + "appimage", + "dmg", + "app", + "msi" + ], "icon": [ "icons/icon.png", "icons/icon.icns", @@ -39,7 +46,9 @@ ], "fileAssociations": [ { - "ext": ["pdf"], + "ext": [ + "pdf" + ], "name": "PDF Document", "description": "Open PDF files with Stirling-PDF", "role": "Editor", @@ -75,6 +84,13 @@ }, "fs": { "requireLiteralLeadingDot": false + }, + "deep-link": { + "desktop": { + "schemes": [ + "stirlingpdf" + ] + } } } -} +} \ No newline at end of file diff --git a/frontend/src/core/components/AppProviders.tsx b/frontend/src/core/components/AppProviders.tsx index 5fa8d7cb91..f40bd7954b 100644 --- a/frontend/src/core/components/AppProviders.tsx +++ b/frontend/src/core/components/AppProviders.tsx @@ -12,6 +12,7 @@ import { AppConfigProvider, AppConfigProviderProps, AppConfigRetryOptions } from import { RightRailProvider } from "@app/contexts/RightRailContext"; import { ViewerProvider } from "@app/contexts/ViewerContext"; import { SignatureProvider } from "@app/contexts/SignatureContext"; +import { AnnotationProvider } from "@app/contexts/AnnotationContext"; import { TourOrchestrationProvider } from "@app/contexts/TourOrchestrationContext"; import { AdminTourOrchestrationProvider } from "@app/contexts/AdminTourOrchestrationContext"; import { PageEditorProvider } from "@app/contexts/PageEditorContext"; @@ -95,13 +96,15 @@ export function AppProviders({ children, appConfigRetryOptions, appConfigProvide - - - - {children} - - - + + + + + {children} + + + + diff --git a/frontend/src/core/components/annotation/shared/ColorPicker.tsx b/frontend/src/core/components/annotation/shared/ColorPicker.tsx index 04ae501bb7..21656b1f23 100644 --- a/frontend/src/core/components/annotation/shared/ColorPicker.tsx +++ b/frontend/src/core/components/annotation/shared/ColorPicker.tsx @@ -1,5 +1,5 @@ import React from 'react'; -import { Modal, Stack, ColorPicker as MantineColorPicker, Group, Button, ColorSwatch } from '@mantine/core'; +import { Modal, Stack, ColorPicker as MantineColorPicker, Group, Button, ColorSwatch, Slider, Text } from '@mantine/core'; import { useTranslation } from 'react-i18next'; interface ColorPickerProps { @@ -8,6 +8,10 @@ interface ColorPickerProps { selectedColor: string; onColorChange: (color: string) => void; title?: string; + opacity?: number; + onOpacityChange?: (opacity: number) => void; + showOpacity?: boolean; + opacityLabel?: string; } export const ColorPicker: React.FC = ({ @@ -15,10 +19,15 @@ export const ColorPicker: React.FC = ({ onClose, selectedColor, onColorChange, - title + title, + opacity, + onOpacityChange, + showOpacity = false, + opacityLabel, }) => { const { t } = useTranslation(); const resolvedTitle = title ?? t('colorPicker.title', 'Choose colour'); + const resolvedOpacityLabel = opacityLabel ?? t('annotation.opacity', 'Opacity'); return ( = ({ size="lg" fullWidth /> + {showOpacity && onOpacityChange && opacity !== undefined && ( + + {resolvedOpacityLabel} + + + )} + + {analyticsError && ( +

+ {analyticsError} +
+ )} + + ), + background: { + gradientStops: ['#0EA5E9', '#6366F1'], + circles: UNIFIED_CIRCLE_CONFIG, + }, + }; +} + diff --git a/frontend/src/core/components/onboarding/slides/TourOverviewSlide.tsx b/frontend/src/core/components/onboarding/slides/TourOverviewSlide.tsx new file mode 100644 index 0000000000..b76a10b7f5 --- /dev/null +++ b/frontend/src/core/components/onboarding/slides/TourOverviewSlide.tsx @@ -0,0 +1,27 @@ +import React from 'react'; +import { Trans } from 'react-i18next'; +import i18n from '@app/i18n'; +import { SlideConfig } from '@app/types/types'; +import { UNIFIED_CIRCLE_CONFIG } from '@app/components/onboarding/slides/unifiedBackgroundConfig'; +import styles from '@app/components/onboarding/InitialOnboardingModal/InitialOnboardingModal.module.css'; + +export default function TourOverviewSlide(): SlideConfig { + return { + key: 'tour-overview', + title: i18n.t('onboarding.tourOverview.title', 'Tour Overview'), + body: ( + + }} + /> + + ), + background: { + gradientStops: ['#2563EB', '#7C3AED'], + circles: UNIFIED_CIRCLE_CONFIG, + }, + }; +} + diff --git a/frontend/src/core/components/onboarding/useBypassOnboarding.ts b/frontend/src/core/components/onboarding/useBypassOnboarding.ts index 8e7d9b14f0..166c893527 100644 --- a/frontend/src/core/components/onboarding/useBypassOnboarding.ts +++ b/frontend/src/core/components/onboarding/useBypassOnboarding.ts @@ -1,7 +1,6 @@ -import { useEffect, useMemo, useRef, useState } from 'react'; +import { useEffect, useMemo, useState } from 'react'; import { useLocation } from 'react-router-dom'; -import { ONBOARDING_STEPS } from '@app/components/onboarding/orchestrator/onboardingConfig'; -import { markStepSeen } from '@app/components/onboarding/orchestrator/onboardingStorage'; +import { markOnboardingCompleted } from '@app/components/onboarding/orchestrator/onboardingStorage'; const SESSION_KEY = 'onboarding::bypass-all'; const PARAM_KEY = 'bypassOnboarding'; @@ -34,13 +33,12 @@ function setStoredBypass(enabled: boolean): void { /** * Detects the `bypassOnboarding` query parameter and stores it in session storage - * so that onboarding remains disabled while the app is open. Also marks all steps - * as seen to ensure any dependent UI elements remain hidden. + * so that onboarding remains disabled while the app is open. Also marks onboarding + * as completed to ensure any dependent UI elements remain hidden. */ export function useBypassOnboarding(): boolean { const location = useLocation(); const [bypassOnboarding, setBypassOnboarding] = useState(() => readStoredBypass()); - const stepsMarkedRef = useRef(false); const shouldBypassFromSearch = useMemo(() => { try { @@ -57,14 +55,9 @@ export function useBypassOnboarding(): boolean { setBypassOnboarding(nextBypass); if (nextBypass) { setStoredBypass(true); + markOnboardingCompleted(); } }, [shouldBypassFromSearch]); - useEffect(() => { - if (!bypassOnboarding || stepsMarkedRef.current) return; - stepsMarkedRef.current = true; - ONBOARDING_STEPS.forEach((step) => markStepSeen(step.id)); - }, [bypassOnboarding]); - return bypassOnboarding; } diff --git a/frontend/src/core/components/onboarding/useOnboardingEffects.ts b/frontend/src/core/components/onboarding/useOnboardingEffects.ts index 54c58eceee..f7eacb1f9c 100644 --- a/frontend/src/core/components/onboarding/useOnboardingEffects.ts +++ b/frontend/src/core/components/onboarding/useOnboardingEffects.ts @@ -51,14 +51,14 @@ export function useTourRequest(): { clearTourRequest: () => void; } { const [tourRequested, setTourRequested] = useState(false); - const [requestedTourType, setRequestedTourType] = useState('tools'); + const [requestedTourType, setRequestedTourType] = useState('whatsnew'); useEffect(() => { if (typeof window === 'undefined') return; const handleTourRequest = (event: Event) => { const { detail } = event as CustomEvent; - setRequestedTourType(detail?.tourType ?? 'tools'); + setRequestedTourType(detail?.tourType ?? 'whatsnew'); setTourRequested(true); }; diff --git a/frontend/src/core/components/onboarding/userStepsConfig.ts b/frontend/src/core/components/onboarding/userStepsConfig.ts index 07e3da7607..5a936b3d65 100644 --- a/frontend/src/core/components/onboarding/userStepsConfig.ts +++ b/frontend/src/core/components/onboarding/userStepsConfig.ts @@ -8,12 +8,8 @@ export enum TourStep { FILES_BUTTON, FILE_SOURCES, WORKBENCH, - VIEW_SWITCHER, - VIEWER, - PAGE_EDITOR, ACTIVE_FILES, FILE_CHECKBOX, - SELECT_CONTROLS, CROP_SETTINGS, RUN_BUTTON, RESULTS, @@ -28,10 +24,7 @@ interface UserStepActions { backToAllTools: () => void; selectCropTool: () => void; loadSampleFile: () => void; - switchToViewer: () => void; - switchToPageEditor: () => void; switchToActiveFiles: () => void; - selectFirstFile: () => void; pinFile: () => void; modifyCropSettings: () => void; executeTool: () => void; @@ -50,10 +43,7 @@ export function createUserStepsConfig({ t, actions }: CreateUserStepsConfigArgs) backToAllTools, selectCropTool, loadSampleFile, - switchToViewer, - switchToPageEditor, switchToActiveFiles, - selectFirstFile, pinFile, modifyCropSettings, executeTool, @@ -108,26 +98,6 @@ export function createUserStepsConfig({ t, actions }: CreateUserStepsConfigArgs) position: 'center', padding: 0, }, - [TourStep.VIEW_SWITCHER]: { - selector: '[data-tour="view-switcher"]', - content: t('onboarding.viewSwitcher', 'Use these controls to select how you want to view your PDFs.'), - position: 'bottom', - padding: 0, - }, - [TourStep.VIEWER]: { - selector: '[data-tour="workbench"]', - content: t('onboarding.viewer', "The Viewer lets you read and annotate your PDFs."), - position: 'center', - padding: 0, - action: () => switchToViewer(), - }, - [TourStep.PAGE_EDITOR]: { - selector: '[data-tour="workbench"]', - content: t('onboarding.pageEditor', "The Page Editor allows you to do various operations on the pages within your PDFs, such as reordering, rotating and deleting."), - position: 'center', - padding: 0, - action: () => switchToPageEditor(), - }, [TourStep.ACTIVE_FILES]: { selector: '[data-tour="workbench"]', content: t('onboarding.activeFiles', "The Active Files view shows all of the PDFs you have loaded into the tool, and allows you to select which ones to process."), @@ -141,14 +111,6 @@ export function createUserStepsConfig({ t, actions }: CreateUserStepsConfigArgs) position: 'top', padding: 10, }, - [TourStep.SELECT_CONTROLS]: { - selector: '[data-tour="right-rail-controls"]', - highlightedSelectors: ['[data-tour="right-rail-controls"]', '[data-tour="right-rail-settings"]'], - content: t('onboarding.selectControls', "The Right Rail contains buttons to quickly select/deselect all of your active PDFs, along with buttons to change the app's theme or language."), - position: 'left', - padding: 5, - action: () => selectFirstFile(), - }, [TourStep.CROP_SETTINGS]: { selector: '[data-tour="crop-settings"]', content: t('onboarding.cropSettings', "Now that we've selected the file we want crop, we can configure the Crop tool to choose the area that we want to crop the PDF to."), diff --git a/frontend/src/core/components/onboarding/whatsNewStepsConfig.ts b/frontend/src/core/components/onboarding/whatsNewStepsConfig.ts new file mode 100644 index 0000000000..cb86644c4a --- /dev/null +++ b/frontend/src/core/components/onboarding/whatsNewStepsConfig.ts @@ -0,0 +1,197 @@ +import type { StepType } from '@reactour/tour'; +import type { TFunction } from 'i18next'; + +async function waitForElement(selector: string, timeoutMs = 7000, intervalMs = 100): Promise { + if (typeof document === 'undefined') return; + const start = Date.now(); + // Immediate hit + if (document.querySelector(selector)) return; + + return new Promise((resolve) => { + const check = () => { + if (document.querySelector(selector) || Date.now() - start >= timeoutMs) { + resolve(); + return; + } + setTimeout(check, intervalMs); + }; + check(); + }); +} + +async function waitForHighlightable(selector: string, timeoutMs = 7000, intervalMs = 500): Promise { + if (typeof document === 'undefined') return; + const start = Date.now(); + + return new Promise((resolve) => { + const check = () => { + const el = document.querySelector(selector); + const isVisible = !!el && el.getClientRects().length > 0; + if (isVisible || Date.now() - start >= timeoutMs) { + // Nudge Reactour to recalc positions in case layout shifted + window.dispatchEvent(new Event('resize')); + requestAnimationFrame(() => window.dispatchEvent(new Event('resize'))); + resolve(); + return; + } + setTimeout(check, intervalMs); + }; + check(); + }); +} + +export enum WhatsNewTourStep { + QUICK_ACCESS, + LEFT_PANEL, + FILE_UPLOAD, + RIGHT_RAIL, + TOP_BAR, + PAGE_EDITOR_VIEW, + ACTIVE_FILES_VIEW, + WRAP_UP, +} + +interface WhatsNewStepActions { + saveWorkbenchState: () => void; + closeFilesModal: () => void; + backToAllTools: () => void; + openFilesModal: () => void; + loadSampleFile: () => Promise | void; + switchToViewer: () => void; + switchToPageEditor: () => void; + switchToActiveFiles: () => void; + selectFirstFile: () => void; +} + +interface CreateWhatsNewStepsConfigArgs { + t: TFunction; + actions: WhatsNewStepActions; +} + +export function createWhatsNewStepsConfig({ t, actions }: CreateWhatsNewStepsConfigArgs): Record { + const { + saveWorkbenchState, + closeFilesModal, + backToAllTools, + openFilesModal, + loadSampleFile, + switchToViewer, + switchToPageEditor, + switchToActiveFiles, + selectFirstFile, + } = actions; + + return { + [WhatsNewTourStep.QUICK_ACCESS]: { + selector: '[data-tour="quick-access-bar"]', + content: t( + 'onboarding.whatsNew.quickAccess', + 'Start at the Quick Access rail to jump between Reader, Automate, your files, and all the tours.' + ), + position: 'right', + padding: 10, + action: () => { + saveWorkbenchState(); + closeFilesModal(); + backToAllTools(); + }, + }, + [WhatsNewTourStep.LEFT_PANEL]: { + selector: '[data-tour="tool-panel"]', + content: t( + 'onboarding.whatsNew.leftPanel', + 'The left Tools panel lists everything you can do. Browse categories or search to find a tool quickly.' + ), + position: 'center', + padding: 0, + }, + [WhatsNewTourStep.FILE_UPLOAD]: { + selector: '[data-tour="files-button"]', + content: t( + 'onboarding.whatsNew.fileUpload', + 'Use the Files button to upload or pick a recent PDF. We will load a sample so you can see the workspace.' + ), + position: 'right', + padding: 10, + action: async () => { + openFilesModal(); + await waitForElement('[data-tour="file-sources"]', 5000, 100); + }, + actionAfter: async () => { + await Promise.resolve(loadSampleFile()); + closeFilesModal(); + switchToViewer(); + // wait for file render and top controls to mount + await waitForElement('[data-tour="view-switcher"]', 7000, 100); + await waitForHighlightable('[data-tour="view-switcher"]', 7000, 500); + }, + }, + [WhatsNewTourStep.RIGHT_RAIL]: { + selector: '[data-tour="right-rail-controls"]', + highlightedSelectors: ['[data-tour="right-rail-controls"]', '[data-tour="right-rail-settings"]'], + content: t( + 'onboarding.whatsNew.rightRail', + 'The Right Rail holds quick actions to select files, change theme or language, and download results.' + ), + position: 'left', + padding: 10, + action: async () => { + await waitForElement('[data-tour="right-rail-controls"]', 7000, 100); + selectFirstFile(); + }, + }, + [WhatsNewTourStep.TOP_BAR]: { + selector: '[data-tour="view-switcher"]', + content: t( + 'onboarding.whatsNew.topBar', + 'The top bar lets you swap between Viewer, Page Editor, and Active Files.' + ), + position: 'bottom', + padding: 8, + // Ensure the switcher has mounted before this step renders + action: async () => { + switchToViewer(); + await waitForElement('[data-tour="view-switcher"]', 7000, 100); + await waitForHighlightable('[data-tour="view-switcher"]', 7000, 500); + }, + }, + [WhatsNewTourStep.PAGE_EDITOR_VIEW]: { + selector: '[data-tour="view-switcher"]', + content: t( + 'onboarding.whatsNew.pageEditorView', + 'Switch to the Page Editor to reorder, rotate, or delete pages.' + ), + position: 'bottom', + padding: 8, + action: async () => { + switchToPageEditor(); + await waitForElement('[data-tour="view-switcher"]', 7000, 100); + await waitForHighlightable('[data-tour="view-switcher"]', 7000, 500); + }, + }, + [WhatsNewTourStep.ACTIVE_FILES_VIEW]: { + selector: '[data-tour="view-switcher"]', + content: t( + 'onboarding.whatsNew.activeFilesView', + 'Use Active Files to see everything you have open and pick what to work on.' + ), + position: 'bottom', + padding: 8, + action: async () => { + switchToActiveFiles(); + await waitForElement('[data-tour="view-switcher"]', 7000, 100); + await waitForHighlightable('[data-tour="view-switcher"]', 7000, 500); + }, + }, + [WhatsNewTourStep.WRAP_UP]: { + selector: '[data-tour="help-button"]', + content: t( + 'onboarding.whatsNew.wrapUp', + 'That is what is new in V2. Open the Tours menu anytime to replay this, the Tools tour, or the Admin tour.' + ), + position: 'right', + padding: 10, + }, + }; +} + diff --git a/frontend/src/core/components/shared/AdminAnalyticsChoiceModal.tsx b/frontend/src/core/components/shared/AdminAnalyticsChoiceModal.tsx deleted file mode 100644 index f72d28452a..0000000000 --- a/frontend/src/core/components/shared/AdminAnalyticsChoiceModal.tsx +++ /dev/null @@ -1,139 +0,0 @@ -import { - Modal, - Stack, - Button, - Text, - Title, - Anchor, - useMantineTheme, - useComputedColorScheme, -} from '@mantine/core'; -import { useTranslation } from 'react-i18next'; -import { useState } from 'react'; -import { Z_ANALYTICS_MODAL } from '@app/styles/zIndex'; -import { useAppConfig } from '@app/contexts/AppConfigContext'; -import apiClient from '@app/services/apiClient'; - -interface AdminAnalyticsChoiceModalProps { - opened: boolean; - onClose: () => void; -} - -export default function AdminAnalyticsChoiceModal({ opened, onClose }: AdminAnalyticsChoiceModalProps) { - const { t } = useTranslation(); - const { refetch } = useAppConfig(); - const [loading, setLoading] = useState(false); - const [error, setError] = useState(null); - const theme = useMantineTheme(); - const computedColorScheme = useComputedColorScheme('light', { getInitialValueInEffect: true }); - const isDark = computedColorScheme === 'dark'; - const privacyHighlightStyles = { - color: isDark ? '#FFFFFF' : theme.colors.blue[7], - padding: `${theme.spacing.xs} ${theme.spacing.sm}`, - borderRadius: theme.radius.md, - fontWeight: 700, - textAlign: 'center' as const, - display: 'flex', - alignItems: 'center', - justifyContent: 'center', - gap: theme.spacing.xs, - letterSpacing: 0.3, - }; - - const handleChoice = async (enableAnalytics: boolean) => { - setLoading(true); - setError(null); - - try { - const formData = new FormData(); - formData.append('enabled', enableAnalytics.toString()); - - await apiClient.post('/api/v1/settings/update-enable-analytics', formData); - - // Refetch config to apply new settings without page reload - await refetch(); - - // Close the modal after successful save - onClose(); - } catch (err) { - setError(err instanceof Error ? err.message : 'Unknown error occurred'); - setLoading(false); - } - }; - - const handleEnable = () => { - handleChoice(true); - }; - - const handleDisable = () => { - handleChoice(false); - }; - - return ( - {}} // Prevent closing - closeOnClickOutside={false} - closeOnEscape={false} - withCloseButton={false} - size="lg" - centered - zIndex={Z_ANALYTICS_MODAL} - > - - {t('analytics.title', 'Do you want make Stirling PDF better?')} - - - {t('analytics.paragraph1', 'Stirling PDF has opt in analytics to help us improve the product.')} - - - • {t('analytics.privacyAssurance', 'We do not track any personal information or the contents of your files.')} • - - - - {t('analytics.paragraph2', 'Please consider enabling analytics to help Stirling-PDF grow and to allow us to understand our users better.')}{' '} - - {t('analytics.learnMore', 'Learn more')} - - - - {error && ( - - {error} - - )} - - - - - - - - - {t('analytics.settings', 'You can change the settings for analytics in the config/settings.yml file')} - - - - ); -} diff --git a/frontend/src/core/components/shared/AllToolsNavButton.tsx b/frontend/src/core/components/shared/AllToolsNavButton.tsx index 1608d5bd3d..3ba3bb70b4 100644 --- a/frontend/src/core/components/shared/AllToolsNavButton.tsx +++ b/frontend/src/core/components/shared/AllToolsNavButton.tsx @@ -1,6 +1,5 @@ import React from 'react'; import { useTranslation } from 'react-i18next'; -import { Tooltip } from '@app/components/shared/Tooltip'; import AppsIcon from '@mui/icons-material/AppsRounded'; import { useToolWorkflow } from '@app/contexts/ToolWorkflowContext'; import { useNavigationState, useNavigationActions } from '@app/contexts/NavigationContext'; @@ -11,13 +10,11 @@ import QuickAccessButton from '@app/components/shared/quickAccessBar/QuickAccess interface AllToolsNavButtonProps { activeButton: string; setActiveButton: (id: string) => void; - tooltipPosition?: 'left' | 'right' | 'top' | 'bottom'; } const AllToolsNavButton: React.FC = ({ activeButton, setActiveButton, - tooltipPosition = 'right' }) => { const { t } = useTranslation(); const { handleReaderToggle, handleBackToTools, selectedToolKey, leftPanelView } = useToolWorkflow(); @@ -55,26 +52,18 @@ const AllToolsNavButton: React.FC = ({ }; return ( - -
- } - label={t("quickAccess.allTools", "Tools")} - isActive={isActive} - onClick={handleNavClick} - href={navProps.href} - ariaLabel={t("quickAccess.allTools", "Tools")} - textClassName="all-tools-text" - component="a" - /> -
- +
+ } + label={t("quickAccess.allTools", "Tools")} + isActive={isActive} + onClick={handleNavClick} + href={navProps.href} + ariaLabel={t("quickAccess.allTools", "Tools")} + textClassName="all-tools-text" + component="a" + /> +
); }; diff --git a/frontend/src/core/components/shared/Footer.tsx b/frontend/src/core/components/shared/Footer.tsx index 172861d1bb..6a03a2f542 100644 --- a/frontend/src/core/components/shared/Footer.tsx +++ b/frontend/src/core/components/shared/Footer.tsx @@ -95,6 +95,22 @@ export default function Footer({ > {t('legal.terms', 'Terms and Conditions')} + + {t('footer.discord', 'Discord')} + + + {t('footer.issues', 'GitHub')} + ((_, ref) => { const [configModalOpen, setConfigModalOpen] = useState(false); const [activeButton, setActiveButton] = useState('tools'); const scrollableRef = useRef(null); + const { + tooltipOpen, + manualCloseOnly, + showCloseButton, + toursMenuOpen, + setToursMenuOpen, + handleTooltipOpenChange, + } = useToursTooltip(); const isRTL = typeof document !== 'undefined' && document.documentElement.dir === 'rtl'; @@ -163,11 +173,17 @@ const QuickAccessBar = forwardRef((_, ref) => { // onClick: () => setActiveButton('activity') //}, + // Determine if settings button should be hidden + // Hide when login is disabled AND showSettingsWhenNoLogin is false + const shouldHideSettingsButton = + config?.enableLogin === false && + config?.showSettingsWhenNoLogin === false; + const bottomButtons: ButtonConfig[] = [ { id: 'help', - name: t("quickAccess.help", "Help"), - icon: , + name: t("quickAccess.tours", "Tours"), + icon: , isRound: true, size: 'md', type: 'action', @@ -175,23 +191,24 @@ const QuickAccessBar = forwardRef((_, ref) => { // This will be overridden by the wrapper logic }, }, - { + ...(shouldHideSettingsButton ? [] : [{ id: 'config', name: t("quickAccess.settings", "Settings"), icon: , - size: 'md', - type: 'modal', + size: 'md' as const, + type: 'modal' as const, onClick: () => { navigate('/settings/overview'); setConfigModalOpen(true); } - } + } as ButtonConfig]) ]; return (
{/* Fixed header outside scrollable area */} @@ -247,58 +264,83 @@ const QuickAccessBar = forwardRef((_, ref) => { // Handle help button with menu or direct action if (buttonConfig.id === 'help') { const isAdmin = config?.isAdmin === true; + const toursTooltipContent = isAdmin + ? t('quickAccess.toursTooltip.admin', 'Watch walkthroughs here: Tools tour, New V2 layout tour, and the Admin tour.') + : t('quickAccess.toursTooltip.user', 'Watch walkthroughs here: Tools tour and the New V2 layout tour.'); + const tourItems = [ + { + key: 'whatsnew', + icon: , + title: t("quickAccess.helpMenu.whatsNewTour", "See what's new in V2"), + description: t("quickAccess.helpMenu.whatsNewTourDesc", "Tour the updated layout"), + onClick: () => requestStartTour('whatsnew'), + }, + { + key: 'tools', + icon: , + title: t("quickAccess.helpMenu.toolsTour", "Tools Tour"), + description: t("quickAccess.helpMenu.toolsTourDesc", "Learn what the tools can do"), + onClick: () => requestStartTour('tools'), + }, + ...(isAdmin ? [{ + key: 'admin', + icon: , + title: t("quickAccess.helpMenu.adminTour", "Admin Tour"), + description: t("quickAccess.helpMenu.adminTourDesc", "Explore admin settings & features"), + onClick: () => requestStartTour('admin'), + }] : []), + ]; - // If not admin, just show button that starts tools tour directly - if (!isAdmin) { - return ( -
requestStartTour('tools')} + const helpButtonNode = ( +
+ - {renderNavButton(buttonConfig, index)} -
- ); - } - - // If admin, show menu with both options - return ( -
-
{renderNavButton(buttonConfig, index)}
 - } - onClick={() => requestStartTour('tools')} - > -
-
- {t("quickAccess.helpMenu.toolsTour", "Tools Tour")} + {tourItems.map((item) => ( + +
+
+ {item.title} +
+
+ {item.description} +
-
- {t("quickAccess.helpMenu.toolsTourDesc", "Learn what the tools can do")} -
-
- - } - onClick={() => requestStartTour('admin')} - > -
-
- {t("quickAccess.helpMenu.adminTour", "Admin Tour")} -
-
- {t("quickAccess.helpMenu.adminTourDesc", "Explore admin settings & features")} -
-
- + + ))}
); + + return ( + + {helpButtonNode} + + ); } const buttonNode = renderNavButton(buttonConfig, index); diff --git a/frontend/src/core/components/shared/Tooltip.tsx b/frontend/src/core/components/shared/Tooltip.tsx index 980d2cfe76..10fefec023 100644 --- a/frontend/src/core/components/shared/Tooltip.tsx +++ b/frontend/src/core/components/shared/Tooltip.tsx @@ -33,6 +33,10 @@ export interface TooltipProps { disabled?: boolean; /** If false, tooltip will not open on focus (hover only) */ openOnFocus?: boolean; + /** If true, tooltip stays open until explicitly closed (ignores hover/blur/esc/outside) */ + manualCloseOnly?: boolean; + /** Show a close button even when not pinned */ + showCloseButton?: boolean; } export const Tooltip: React.FC = ({ @@ -55,6 +59,8 @@ export const Tooltip: React.FC = ({ closeOnOutside = true, disabled = false, openOnFocus = true, + manualCloseOnly = false, + showCloseButton = false, }) => { const [internalOpen, setInternalOpen] = useState(false); const [isPinned, setIsPinned] = useState(false); @@ -81,6 +87,7 @@ export const Tooltip: React.FC = ({ const isControlled = controlledOpen !== undefined; const open = (isControlled ? !!controlledOpen : internalOpen) && !disabled; + const allowAutoClose = !manualCloseOnly; const resolvedPosition: NonNullable = useMemo(() => { const htmlDir = typeof document !== 'undefined' ? document.documentElement.dir : 'ltr'; @@ -132,11 +139,11 @@ export const Tooltip: React.FC = ({ } // Not pinned and configured to close on outside - if (closeOnOutside && !insideTooltip && !insideTrigger) { + if (allowAutoClose && closeOnOutside && !insideTooltip && !insideTrigger) { setOpen(false); } }, - [isPinned, closeOnOutside, setOpen] + [isPinned, closeOnOutside, setOpen, allowAutoClose] ); useEffect(() => { @@ -200,10 +207,10 @@ export const Tooltip: React.FC = ({ } clearTimers(); - if (!isPinned) setOpen(false); + if (allowAutoClose && !isPinned) setOpen(false); (children.props as any)?.onPointerLeave?.(e); }, - [clearTimers, isPinned, setOpen, children.props] + [clearTimers, isPinned, setOpen, children.props, allowAutoClose] ); const handleMouseDown = useCallback( @@ -257,15 +264,16 @@ export const Tooltip: React.FC = ({ return; } clearTimers(); - if (!isPinned) setOpen(false); + if (allowAutoClose && !isPinned) setOpen(false); (children.props as any)?.onBlur?.(e); }, - [isPinned, setOpen, children.props, clearTimers] + [isPinned, setOpen, children.props, allowAutoClose, clearTimers] ); const handleKeyDown = useCallback((e: React.KeyboardEvent) => { + if (manualCloseOnly) return; if (e.key === 'Escape') setOpen(false); - }, [setOpen]); + }, [setOpen, manualCloseOnly]); // Keep open while pointer is over the tooltip; close when leaving it (if not pinned) const handleTooltipPointerEnter = useCallback(() => { @@ -276,9 +284,9 @@ export const Tooltip: React.FC = ({ (e: React.PointerEvent) => { const related = e.relatedTarget as Node | null; if (isDomNode(related) && triggerRef.current && triggerRef.current.contains(related)) return; - if (!isPinned) setOpen(false); + if (allowAutoClose && !isPinned) setOpen(false); }, - [isPinned, setOpen] + [isPinned, setOpen, allowAutoClose] ); // Enhance child with handlers and ref @@ -301,6 +309,7 @@ export const Tooltip: React.FC = ({ }); const shouldShowTooltip = open; + const shouldShowCloseButton = showCloseButton || isPinned; const tooltipElement = shouldShowTooltip ? (
= ({ className={`${styles['tooltip-container']} ${isPinned ? styles.pinned : ''}`} onClick={pinOnClick ? (e) => { e.stopPropagation(); setIsPinned(true); } : undefined} > - {isPinned && ( + {shouldShowCloseButton && (
)} - +
) : null; diff --git a/frontend/src/core/components/shared/config/configSections/ProviderCard.tsx b/frontend/src/core/components/shared/config/configSections/ProviderCard.tsx index 3d07338ac6..15eaadb415 100644 --- a/frontend/src/core/components/shared/config/configSections/ProviderCard.tsx +++ b/frontend/src/core/components/shared/config/configSections/ProviderCard.tsx @@ -1,4 +1,4 @@ -import { useState } from 'react'; +import { useEffect, useState } from 'react'; import { Paper, Group, Text, Button, Collapse, Stack, TextInput, Textarea, Switch, PasswordInput } from '@mantine/core'; import { useTranslation } from 'react-i18next'; import LocalIcon from '@app/components/shared/LocalIcon'; @@ -25,14 +25,22 @@ export default function ProviderCard({ const [expanded, setExpanded] = useState(false); const [localSettings, setLocalSettings] = useState>(settings); + // Keep local settings in sync with incoming settings (values loaded from settings.yml) + useEffect(() => { + if (!expanded) { + setLocalSettings(settings); + } + }, [settings, expanded]); + // Initialize local settings with defaults when opening an unconfigured provider const handleConnectToggle = () => { if (!isConfigured && !expanded) { // First time opening an unconfigured provider - initialize with defaults - const defaultSettings: Record = {}; + // while preserving any values already present (from settings.yml) + const defaultSettings: Record = { ...settings }; provider.fields.forEach((field) => { if (field.defaultValue !== undefined) { - defaultSettings[field.key] = field.defaultValue; + defaultSettings[field.key] = defaultSettings[field.key] ?? field.defaultValue; } }); setLocalSettings(defaultSettings); diff --git a/frontend/src/core/components/shared/quickAccessBar/useToursTooltip.ts b/frontend/src/core/components/shared/quickAccessBar/useToursTooltip.ts new file mode 100644 index 0000000000..bed983fdd7 --- /dev/null +++ b/frontend/src/core/components/shared/quickAccessBar/useToursTooltip.ts @@ -0,0 +1,81 @@ +import { useCallback, useEffect, useRef, useState } from 'react'; +import { TOUR_STATE_EVENT, type TourStatePayload } from '@app/constants/events'; +import { isOnboardingCompleted, hasShownToursTooltip, markToursTooltipShown } from '@app/components/onboarding/orchestrator/onboardingStorage'; + +export interface ToursTooltipState { + tooltipOpen: boolean | undefined; + manualCloseOnly: boolean; + showCloseButton: boolean; + toursMenuOpen: boolean; + setToursMenuOpen: (open: boolean) => void; + handleTooltipOpenChange: (next: boolean) => void; +} + +/** + * Encapsulates all the logic for the tours tooltip: + * - Shows automatically after onboarding/tour completes (once per user) + * - Hides while the tours menu is open + * - After dismissal, reverts to hover-only tooltip + */ +export function useToursTooltip(): ToursTooltipState { + const [showToursTooltip, setShowToursTooltip] = useState(false); + const [toursMenuOpen, setToursMenuOpen] = useState(false); + const tourWasOpenRef = useRef(false); + + // Auto-show when a tour ends (fires once per user) + useEffect(() => { + if (typeof window === 'undefined') return; + + const handleTourStateChange = (event: Event) => { + const { detail } = event as CustomEvent; + const wasOpen = tourWasOpenRef.current; + tourWasOpenRef.current = detail.isOpen; + + if (wasOpen && !detail.isOpen && !hasShownToursTooltip()) { + setShowToursTooltip(true); + } + }; + + window.addEventListener(TOUR_STATE_EVENT, handleTourStateChange); + return () => window.removeEventListener(TOUR_STATE_EVENT, handleTourStateChange); + }, []); + + // Show once after onboarding is complete + useEffect(() => { + if (isOnboardingCompleted() && !hasShownToursTooltip()) { + setShowToursTooltip(true); + } + }, []); + + const handleDismissToursTooltip = useCallback(() => { + markToursTooltipShown(); + setShowToursTooltip(false); + }, []); + + const hasBeenDismissed = hasShownToursTooltip(); + + const handleTooltipOpenChange = useCallback( + (next: boolean) => { + if (!next) { + if (!hasBeenDismissed) { + handleDismissToursTooltip(); + } + } else if (!hasBeenDismissed && !toursMenuOpen) { + setShowToursTooltip(true); + } + }, + [hasBeenDismissed, toursMenuOpen, handleDismissToursTooltip] + ); + + const tooltipOpen = toursMenuOpen ? false : hasBeenDismissed ? undefined : showToursTooltip; + + return { + tooltipOpen, + manualCloseOnly: !hasBeenDismissed, + showCloseButton: !hasBeenDismissed, + toursMenuOpen, + setToursMenuOpen, + handleTooltipOpenChange, + }; +} + diff --git a/frontend/src/core/components/shared/rightRail/ViewerAnnotationControls.tsx b/frontend/src/core/components/shared/rightRail/ViewerAnnotationControls.tsx index cd95b90b96..41c1afcc55 100644 --- a/frontend/src/core/components/shared/rightRail/ViewerAnnotationControls.tsx +++ b/frontend/src/core/components/shared/rightRail/ViewerAnnotationControls.tsx @@ -1,15 +1,9 @@ -import React, { useState, useEffect } from 'react'; -import { ActionIcon, Popover } from '@mantine/core'; +import React from 'react'; +import { ActionIcon } from '@mantine/core'; import { useTranslation } from 'react-i18next'; import LocalIcon from '@app/components/shared/LocalIcon'; import { Tooltip } from '@app/components/shared/Tooltip'; import { ViewerContext } from '@app/contexts/ViewerContext'; -import { useSignature } from '@app/contexts/SignatureContext'; -import { ColorSwatchButton, ColorPicker } from '@app/components/annotation/shared/ColorPicker'; -import { useFileState, useFileContext } from '@app/contexts/FileContext'; -import { generateThumbnailWithMetadata } from '@app/utils/thumbnailUtils'; -import { createProcessedFile } from '@app/contexts/file/fileActions'; -import { createStirlingFile, createNewStirlingFileStub } from '@app/types/fileContext'; import { useNavigationState } from '@app/contexts/NavigationContext'; import { useSidebarContext } from '@app/contexts/SidebarContext'; import { useRightRailTooltipSide } from '@app/hooks/useRightRailTooltipSide'; @@ -23,31 +17,19 @@ export default function ViewerAnnotationControls({ currentView, disabled = false const { t } = useTranslation(); const { sidebarRefs } = useSidebarContext(); const { position: tooltipPosition, offset: tooltipOffset } = useRightRailTooltipSide(sidebarRefs); - const [selectedColor, setSelectedColor] = useState('#000000'); - const [isColorPickerOpen, setIsColorPickerOpen] = useState(false); - const [isHoverColorPickerOpen, setIsHoverColorPickerOpen] = useState(false); // Viewer context for PDF controls - safely handle when not available const viewerContext = React.useContext(ViewerContext); - // Signature context for accessing drawing API - const { signatureApiRef, isPlacementMode } = useSignature(); - - // File state for save functionality - const { state, selectors } = useFileState(); - const { actions: fileActions } = useFileContext(); - const activeFiles = selectors.getFiles(); - // Check if we're in sign mode const { selectedTool } = useNavigationState(); const isSignMode = selectedTool === 'sign'; - // Turn off annotation mode when switching away from viewer - useEffect(() => { - if (currentView !== 'viewer' && viewerContext?.isAnnotationMode) { - viewerContext.setAnnotationMode(false); - } - }, [currentView, viewerContext]); + // Check if we're in any annotation tool that should disable the toggle + const isInAnnotationTool = selectedTool === 'annotate' || selectedTool === 'sign' || selectedTool === 'addImage' || selectedTool === 'addText'; + + // Check if we're on annotate tool to highlight the button + const isAnnotateActive = selectedTool === 'annotate'; // Don't show any annotation controls in sign mode if (isSignMode) { @@ -59,13 +41,14 @@ export default function ViewerAnnotationControls({ currentView, disabled = false {/* Annotation Visibility Toggle */} { viewerContext?.toggleAnnotationsVisibility(); }} - disabled={disabled || currentView !== 'viewer' || viewerContext?.isAnnotationMode || isPlacementMode} + disabled={disabled || currentView !== 'viewer' || isInAnnotationTool} > - - {/* Annotation Mode Toggle with Drawing Controls */} - {viewerContext?.isAnnotationMode ? ( - // When active: Show color picker on hover -
setIsHoverColorPickerOpen(true)} - onMouseLeave={() => setIsHoverColorPickerOpen(false)} - style={{ display: 'inline-flex' }} - > - setIsHoverColorPickerOpen(false)} - position="left" - withArrow - shadow="md" - offset={8} - > - - { - viewerContext?.toggleAnnotationMode(); - setIsHoverColorPickerOpen(false); // Close hover color picker when toggling off - // Deactivate drawing tool when exiting annotation mode - if (signatureApiRef?.current) { - try { - signatureApiRef.current.deactivateTools(); - } catch (error) { - console.log('Signature API not ready:', error); - } - } - }} - disabled={disabled} - aria-label="Drawing mode active" - > - - - - -
-
-
Drawing Color
- { - setIsHoverColorPickerOpen(false); // Close hover picker - setIsColorPickerOpen(true); // Open main color picker modal - }} - /> -
-
- - -
- ) : ( - // When inactive: Show "Draw" tooltip - - { - viewerContext?.toggleAnnotationMode(); - // Activate ink drawing tool when entering annotation mode - if (signatureApiRef?.current && currentView === 'viewer') { - try { - signatureApiRef.current.activateDrawMode(); - signatureApiRef.current.updateDrawSettings(selectedColor, 2); - } catch (error) { - console.log('Signature API not ready:', error); - } - } - }} - disabled={disabled} - aria-label={typeof t === 'function' ? t('rightRail.draw', 'Draw') : 'Draw'} - > - - - - )} - - {/* Save PDF with Annotations */} - - { - if (viewerContext?.exportActions?.saveAsCopy && currentView === 'viewer') { - try { - const pdfArrayBuffer = await viewerContext.exportActions.saveAsCopy(); - if (pdfArrayBuffer) { - // Create new File object with flattened annotations - const blob = new Blob([pdfArrayBuffer], { type: 'application/pdf' }); - - // Get the original file name or use a default - const originalFileName = activeFiles.length > 0 ? activeFiles[0].name : 'document.pdf'; - const newFile = new File([blob], originalFileName, { type: 'application/pdf' }); - - // Replace the current file in context with the saved version (exact same logic as Sign tool) - if (activeFiles.length > 0) { - // Generate thumbnail and metadata for the saved file - const thumbnailResult = await generateThumbnailWithMetadata(newFile); - const processedFileMetadata = createProcessedFile(thumbnailResult.pageCount, thumbnailResult.thumbnail); - - // Get current file info - const currentFileIds = state.files.ids; - if (currentFileIds.length > 0) { - const currentFileId = currentFileIds[0]; - const currentRecord = selectors.getStirlingFileStub(currentFileId); - - if (!currentRecord) { - console.error('No file record found for:', currentFileId); - return; - } - - // Create output stub and file (exact same as Sign tool) - const outputStub = createNewStirlingFileStub(newFile, undefined, thumbnailResult.thumbnail, processedFileMetadata); - const outputStirlingFile = createStirlingFile(newFile, outputStub.id); - - // Replace the original file with the saved version - await fileActions.consumeFiles([currentFileId], [outputStirlingFile], [outputStub]); - } - } - } - } catch (error) { - console.error('Error saving PDF:', error); - } - } - }} - disabled={disabled} - > - - - - - {/* Color Picker Modal */} - setIsColorPickerOpen(false)} - selectedColor={selectedColor} - onColorChange={(color) => { - setSelectedColor(color); - // Update drawing tool color if annotation mode is active - if (viewerContext?.isAnnotationMode && signatureApiRef?.current && currentView === 'viewer') { - try { - signatureApiRef.current.updateDrawSettings(color, 2); - } catch (error) { - console.log('Unable to update drawing settings:', error); - } - } - }} - title="Choose Drawing Color" - /> ); } diff --git a/frontend/src/core/components/shared/sliderWithInput/SliderWithInput.tsx b/frontend/src/core/components/shared/sliderWithInput/SliderWithInput.tsx index 7a91cdbe39..85e7039e29 100644 --- a/frontend/src/core/components/shared/sliderWithInput/SliderWithInput.tsx +++ b/frontend/src/core/components/shared/sliderWithInput/SliderWithInput.tsx @@ -8,6 +8,7 @@ interface Props { min?: number; max?: number; step?: number; + suffix?: string; } export default function SliderWithInput({ @@ -18,11 +19,12 @@ export default function SliderWithInput({ min = 0, max = 200, step = 1, + suffix = '%', }: Props) { return (
- {label}: {Math.round(value)}% - + {label} +
@@ -33,6 +35,7 @@ export default function SliderWithInput({ max={max} step={step} disabled={disabled} + suffix={suffix} style={{ width: 90 }} /> diff --git a/frontend/src/core/components/shared/tooltip/Tooltip.module.css b/frontend/src/core/components/shared/tooltip/Tooltip.module.css index 62c4bf6963..9d3bdb80a6 100644 --- a/frontend/src/core/components/shared/tooltip/Tooltip.module.css +++ b/frontend/src/core/components/shared/tooltip/Tooltip.module.css @@ -39,7 +39,7 @@ background: var(--bg-raised); padding: 0.25rem; border-radius: 0.25rem; - border: 0.0625rem solid var(--primary-color, #3b82f6); + border: 0.0625rem solid var(--border-default); cursor: pointer; transition: background-color 0.2s ease, border-color 0.2s ease; z-index: 1; @@ -60,6 +60,13 @@ border-color: #ef4444 !important; } +.tooltip-pin-button:focus, +.tooltip-pin-button:focus-visible { + outline: none; + border-color: var(--border-default) !important; + background-color: var(--bg-raised) !important; +} + /* Tooltip Header */ .tooltip-header { display: flex; @@ -91,7 +98,7 @@ /* Tooltip Body */ .tooltip-body { - padding: 1rem !important; + padding: 1rem; color: var(--text-primary) !important; font-size: 0.875rem !important; line-height: 1.6 !important; diff --git a/frontend/src/core/components/shared/tooltip/TooltipContent.tsx b/frontend/src/core/components/shared/tooltip/TooltipContent.tsx index 8bd85966a3..42ee19af36 100644 --- a/frontend/src/core/components/shared/tooltip/TooltipContent.tsx +++ b/frontend/src/core/components/shared/tooltip/TooltipContent.tsx @@ -5,18 +5,20 @@ import { TooltipTip } from '@app/types/tips'; interface TooltipContentProps { content?: React.ReactNode; tips?: TooltipTip[]; + extraRightPadding?: number; } export const TooltipContent: React.FC = ({ content, tips, + extraRightPadding = 0, }) => { return (
)} + + {/* PDF/A-3b conversion option with informative tooltip */} + + + {t("attachments.convertToPdfA3b", "Convert to PDF/A-3b")} + + + + + } + description={t("attachments.convertToPdfA3bDescription", "Creates an archival PDF with embedded attachments")} + checked={parameters.convertToPdfA3b} + onChange={(event) => onParameterChange('convertToPdfA3b', event.currentTarget.checked)} + disabled={disabled} + styles={{ root: { flex: 1 } }} + /> + ); }; diff --git a/frontend/src/core/components/tools/compress/CompressSettings.tsx b/frontend/src/core/components/tools/compress/CompressSettings.tsx index 398e0b7b47..7d5941f3b8 100644 --- a/frontend/src/core/components/tools/compress/CompressSettings.tsx +++ b/frontend/src/core/components/tools/compress/CompressSettings.tsx @@ -1,8 +1,10 @@ -import { useState } from "react"; -import { Stack, Text, NumberInput, Select, Divider, Checkbox } from "@mantine/core"; +import { useState, useEffect } from "react"; +import { Stack, Text, NumberInput, Select, Divider, Checkbox, Slider, SegmentedControl } from "@mantine/core"; +import SliderWithInput from '@app/components/shared/sliderWithInput/SliderWithInput'; import { useTranslation } from "react-i18next"; import { CompressParameters } from "@app/hooks/tools/compress/useCompressParameters"; import ButtonSelector from "@app/components/shared/ButtonSelector"; +import apiClient from "@app/services/apiClient"; interface CompressSettingsProps { parameters: CompressParameters; @@ -12,7 +14,20 @@ interface CompressSettingsProps { const CompressSettings = ({ parameters, onParameterChange, disabled = false }: CompressSettingsProps) => { const { t } = useTranslation(); - const [isSliding, setIsSliding] = useState(false); + const [imageMagickAvailable, setImageMagickAvailable] = useState(null); + + useEffect(() => { + const checkImageMagick = async () => { + try { + const response = await apiClient.get('/api/v1/config/group-enabled?group=ImageMagick'); + setImageMagickAvailable(response.data); + } catch (error) { + console.error('Failed to check ImageMagick availability:', error); + setImageMagickAvailable(true); // Optimistic fallback + } + }; + checkImageMagick(); + }, []); return ( @@ -32,57 +47,22 @@ const CompressSettings = ({ parameters, onParameterChange, disabled = false }: C {/* Quality Adjustment */} {parameters.compressionMethod === 'quality' && ( - + - Compression Level -
- onParameterChange('compressionLevel', parseInt(e.target.value))} - onMouseDown={() => setIsSliding(true)} - onMouseUp={() => setIsSliding(false)} - onTouchStart={() => setIsSliding(true)} - onTouchEnd={() => setIsSliding(false)} - disabled={disabled} - style={{ - width: '100%', - height: '6px', - borderRadius: '3px', - background: `linear-gradient(to right, #228be6 0%, #228be6 ${(parameters.compressionLevel - 1) / 8 * 100}%, #e9ecef ${(parameters.compressionLevel - 1) / 8 * 100}%, #e9ecef 100%)`, - outline: 'none', - WebkitAppearance: 'none' - }} - /> - {isSliding && ( -
- {parameters.compressionLevel} -
- )} -
-
- Min 1 - Max 9 -
- - {parameters.compressionLevel <= 3 && "1-3 PDF compression"} - {parameters.compressionLevel >= 4 && parameters.compressionLevel <= 6 && "4-6 lite image compression"} - {parameters.compressionLevel >= 7 && "7-9 intense image compression Will dramatically reduce image quality"} + onParameterChange('compressionLevel', value)} + disabled={disabled} + min={1} + max={9} + step={1} + suffix="" + /> + + {parameters.compressionLevel <= 3 && t('compress.compressionLevel.range1to3', 'Lower values preserve quality but result in larger files')} + {parameters.compressionLevel >= 4 && parameters.compressionLevel <= 6 && t('compress.compressionLevel.range4to6', 'Medium compression with moderate quality reduction')} + {parameters.compressionLevel >= 7 && t('compress.compressionLevel.range7to9', 'Higher values reduce file size significantly but may reduce image clarity')} )} @@ -129,6 +109,73 @@ const CompressSettings = ({ parameters, onParameterChange, disabled = false }: C disabled={disabled} label={t("compress.grayscale.label", "Apply Grayscale for compression")} /> + + {/* Linearize Option */} + + onParameterChange('linearize', event.currentTarget.checked)} + disabled={disabled} + label={t("compress.linearize.label", "Linearize PDF for fast web viewing")} + /> + + + onParameterChange('lineArt', event.currentTarget.checked)} + disabled={disabled || imageMagickAvailable === false} + label={t("compress.lineArt.label", "Convert images to line art (bilevel)")} + description={ + imageMagickAvailable === false + ? t("compress.lineArt.unavailable", "ImageMagick is not installed or enabled on this server") + : t("compress.lineArt.description", "Uses ImageMagick to reduce pages to high-contrast black and white for maximum size reduction.") + } + /> + {parameters.lineArt && ( + + {t('compress.lineArt.detailLevel', 'Detail level')} + { + // Map threshold to slider position + const thresholdMap = [20, 35, 50, 65, 80]; + const closest = thresholdMap.reduce((prev, curr, idx) => + Math.abs(curr - parameters.lineArtThreshold) < Math.abs(thresholdMap[prev] - parameters.lineArtThreshold) + ? idx : prev, 0); + return closest + 1; + })()} + onChange={(value) => { + // Map slider position to threshold: 1=20%, 2=35%, 3=50%, 4=65%, 5=80% + const thresholdMap = [20, 35, 50, 65, 80]; + onParameterChange('lineArtThreshold', thresholdMap[value - 1]); + }} + disabled={disabled || imageMagickAvailable === false} + label={null} + marks={[ + { value: 1 }, + { value: 2 }, + { value: 3 }, + { value: 4 }, + { value: 5 }, + ]} + /> + + {t('compress.lineArt.edgeEmphasis', 'Edge emphasis')} + onParameterChange('lineArtEdgeLevel', parseInt(value) as 1 | 2 | 3)} + /> + + )} ); diff --git a/frontend/src/core/components/tools/convert/ConvertFromCbrSettings.tsx b/frontend/src/core/components/tools/convert/ConvertFromCbrSettings.tsx new file mode 100644 index 0000000000..8f1a809469 --- /dev/null +++ b/frontend/src/core/components/tools/convert/ConvertFromCbrSettings.tsx @@ -0,0 +1,36 @@ +import { Stack, Text, Checkbox } from '@mantine/core'; +import { useTranslation } from 'react-i18next'; +import { ConvertParameters } from "@app/hooks/tools/convert/useConvertParameters"; + +interface ConvertFromCbrSettingsProps { + parameters: ConvertParameters; + onParameterChange: (key: K, value: ConvertParameters[K]) => void; + disabled?: boolean; +} + +const ConvertFromCbrSettings = ({ + parameters, + onParameterChange, + disabled = false +}: ConvertFromCbrSettingsProps) => { + const { t } = useTranslation(); + + return ( + + {t("convert.cbrOptions", "CBR Options")}: + + onParameterChange('cbrOptions', { + ...parameters.cbrOptions, + optimizeForEbook: event.currentTarget.checked + })} + disabled={disabled} + data-testid="optimize-ebook-checkbox" + /> + + ); +}; + +export default ConvertFromCbrSettings; diff --git a/frontend/src/core/components/tools/convert/ConvertFromEbookSettings.tsx b/frontend/src/core/components/tools/convert/ConvertFromEbookSettings.tsx new file mode 100644 index 0000000000..5d8d2b28b6 --- /dev/null +++ b/frontend/src/core/components/tools/convert/ConvertFromEbookSettings.tsx @@ -0,0 +1,96 @@ +import { Stack, Checkbox } from "@mantine/core"; +import { useTranslation } from "react-i18next"; +import { ConvertParameters } from "@app/hooks/tools/convert/useConvertParameters"; + +interface ConvertFromEbookSettingsProps { + parameters: ConvertParameters; + onParameterChange: (key: K, value: ConvertParameters[K]) => void; + disabled?: boolean; +} + +const ConvertFromEbookSettings = ({ + parameters, + onParameterChange, + disabled = false +}: ConvertFromEbookSettingsProps) => { + const { t } = useTranslation(); + + const handleEmbedAllFontsChange = (value: boolean) => { + onParameterChange('ebookOptions', { + embedAllFonts: value, + includeTableOfContents: parameters.ebookOptions?.includeTableOfContents ?? false, + includePageNumbers: parameters.ebookOptions?.includePageNumbers ?? false, + optimizeForEbook: parameters.ebookOptions?.optimizeForEbook ?? false, + }); + }; + + const handleIncludeTableOfContentsChange = (value: boolean) => { + onParameterChange('ebookOptions', { + embedAllFonts: parameters.ebookOptions?.embedAllFonts ?? false, + includeTableOfContents: value, + includePageNumbers: parameters.ebookOptions?.includePageNumbers ?? false, + optimizeForEbook: parameters.ebookOptions?.optimizeForEbook ?? false, + }); + }; + + const handleIncludePageNumbersChange = (value: boolean) => { + onParameterChange('ebookOptions', { + embedAllFonts: parameters.ebookOptions?.embedAllFonts ?? false, + includeTableOfContents: parameters.ebookOptions?.includeTableOfContents ?? false, + includePageNumbers: value, + optimizeForEbook: parameters.ebookOptions?.optimizeForEbook ?? false, + }); + }; + + const handleOptimizeForEbookChange = (value: boolean) => { + onParameterChange('ebookOptions', { + embedAllFonts: parameters.ebookOptions?.embedAllFonts ?? false, + includeTableOfContents: parameters.ebookOptions?.includeTableOfContents ?? false, + includePageNumbers: parameters.ebookOptions?.includePageNumbers ?? false, + optimizeForEbook: value, + }); + }; + + // Initialize ebookOptions if not present + const ebookOptions = parameters.ebookOptions || { + embedAllFonts: false, + includeTableOfContents: false, + includePageNumbers: false, + optimizeForEbook: false, + }; + + return ( + + handleEmbedAllFontsChange(event.currentTarget.checked)} + disabled={disabled} + /> + handleIncludeTableOfContentsChange(event.currentTarget.checked)} + disabled={disabled} + /> + handleIncludePageNumbersChange(event.currentTarget.checked)} + disabled={disabled} + /> + handleOptimizeForEbookChange(event.currentTarget.checked)} + disabled={disabled} + /> + + ); +}; + +export default ConvertFromEbookSettings; diff --git a/frontend/src/core/components/tools/convert/ConvertSettings.tsx b/frontend/src/core/components/tools/convert/ConvertSettings.tsx index 50c01365bd..127fbb13c7 100644 --- a/frontend/src/core/components/tools/convert/ConvertSettings.tsx +++ b/frontend/src/core/components/tools/convert/ConvertSettings.tsx @@ -17,6 +17,9 @@ import ConvertFromEmailSettings from "@app/components/tools/convert/ConvertFromE import ConvertFromCbzSettings from "@app/components/tools/convert/ConvertFromCbzSettings"; import ConvertToCbzSettings from "@app/components/tools/convert/ConvertToCbzSettings"; import ConvertToPdfaSettings from "@app/components/tools/convert/ConvertToPdfaSettings"; +import ConvertFromCbrSettings from "@app/components/tools/convert/ConvertFromCbrSettings"; +import ConvertToCbrSettings from "@app/components/tools/convert/ConvertToCbrSettings"; +import ConvertFromEbookSettings from "@app/components/tools/convert/ConvertFromEbookSettings"; import { ConvertParameters } from "@app/hooks/tools/convert/useConvertParameters"; import { FROM_FORMAT_OPTIONS, @@ -142,12 +145,24 @@ const ConvertSettings = ({ onParameterChange('pdfaOptions', { outputFormat: 'pdfa-1', }); + onParameterChange('cbrOptions', { + optimizeForEbook: false, + }); + onParameterChange('pdfToCbrOptions', { + dpi: 150, + }); onParameterChange('cbzOptions', { optimizeForEbook: false, }); onParameterChange('cbzOutputOptions', { dpi: 150, }); + onParameterChange('ebookOptions', { + embedAllFonts: false, + includeTableOfContents: false, + includePageNumbers: false, + optimizeForEbook: false, + }); onParameterChange('isSmartDetection', false); onParameterChange('smartDetectionType', 'none'); }; @@ -210,6 +225,12 @@ const ConvertSettings = ({ onParameterChange('pdfaOptions', { outputFormat: 'pdfa-1', }); + onParameterChange('cbrOptions', { + optimizeForEbook: false, + }); + onParameterChange('pdfToCbrOptions', { + dpi: 150, + }); onParameterChange('cbzOptions', { optimizeForEbook: false, }); @@ -366,6 +387,42 @@ const ConvertSettings = ({ )} + {/* eBook to PDF options */} + {['epub', 'mobi', 'azw3', 'fb2'].includes(parameters.fromExtension) && parameters.toExtension === 'pdf' && ( + <> + + + + )} + + {/* CBR to PDF options */} + {parameters.fromExtension === 'cbr' && parameters.toExtension === 'pdf' && ( + <> + + + + )} + + {/* PDF to CBR options */} + {parameters.fromExtension === 'pdf' && parameters.toExtension === 'cbr' && ( + <> + + + + )} + ); }; diff --git a/frontend/src/core/components/tools/convert/ConvertToCbrSettings.tsx b/frontend/src/core/components/tools/convert/ConvertToCbrSettings.tsx new file mode 100644 index 0000000000..db85eda774 --- /dev/null +++ b/frontend/src/core/components/tools/convert/ConvertToCbrSettings.tsx @@ -0,0 +1,39 @@ +import { Stack, Text, NumberInput } from "@mantine/core"; +import { useTranslation } from "react-i18next"; +import { ConvertParameters } from "@app/hooks/tools/convert/useConvertParameters"; + +interface ConvertToCbrSettingsProps { + parameters: ConvertParameters; + onParameterChange: (key: K, value: ConvertParameters[K]) => void; + disabled?: boolean; +} + +const ConvertToCbrSettings = ({ + parameters, + onParameterChange, + disabled = false +}: ConvertToCbrSettingsProps) => { + const { t } = useTranslation(); + + return ( + + {t("convert.cbrOutputOptions", "PDF to CBR Options")}: + + + typeof val === 'number' && + onParameterChange('pdfToCbrOptions', { ...parameters.pdfToCbrOptions, dpi: val }) + } + min={72} + max={600} + step={50} + disabled={disabled} + /> + + ); +}; + +export default ConvertToCbrSettings; diff --git a/frontend/src/core/components/tools/convert/ConvertToPdfaSettings.tsx b/frontend/src/core/components/tools/convert/ConvertToPdfaSettings.tsx index 0b699693e2..3d21cec280 100644 --- a/frontend/src/core/components/tools/convert/ConvertToPdfaSettings.tsx +++ b/frontend/src/core/components/tools/convert/ConvertToPdfaSettings.tsx @@ -22,7 +22,8 @@ const ConvertToPdfaSettings = ({ const pdfaFormatOptions = [ { value: 'pdfa-1', label: 'PDF/A-1b' }, - { value: 'pdfa', label: 'PDF/A-2b' } + { value: 'pdfa', label: 'PDF/A-2b' }, + { value: 'pdfa-3', label: 'PDF/A-3b' } ]; return ( @@ -50,7 +51,7 @@ const ConvertToPdfaSettings = ({ data-testid="pdfa-output-format-select" /> - {t("convert.pdfaNote", "PDF/A-1b is more compatible, PDF/A-2b supports more features.")} + {t("convert.pdfaNote", "PDF/A-1b is more compatible, PDF/A-2b supports more features, PDF/A-3b supports embedded files.")} diff --git a/frontend/src/core/components/tools/crop/CropSettings.tsx b/frontend/src/core/components/tools/crop/CropSettings.tsx index fae3afe57e..441186e033 100644 --- a/frontend/src/core/components/tools/crop/CropSettings.tsx +++ b/frontend/src/core/components/tools/crop/CropSettings.tsx @@ -1,5 +1,5 @@ import { useMemo, useState, useEffect } from "react"; -import { Stack, Text, Box, Group, ActionIcon, Center, Alert } from "@mantine/core"; +import { Stack, Text, Box, Group, ActionIcon, Center, Alert, Checkbox } from "@mantine/core"; import { useTranslation } from "react-i18next"; import RestartAltIcon from "@mui/icons-material/RestartAlt"; import { CropParametersHook } from "@app/hooks/tools/crop/useCropParameters"; @@ -151,69 +151,81 @@ const CropSettings = ({ parameters, disabled = false }: CropSettingsProps) => { return ( - {/* PDF Preview with Crop Selector */} - - - - {t("crop.preview.title", "Crop Area Selection")} - - - - - - -
- - - - - -
- - - - {/* Manual Coordinate Input */} - parameters.updateParameter('autoCrop', e.currentTarget.checked)} disabled={disabled} - pdfBounds={pdfBounds} - showAutomationInfo={false} /> - {/* Validation Alert */} - {!isCropValid && ( + {/* PDF Preview with Crop Selector - Only show when autoCrop is false */} + {!parameters.parameters.autoCrop && ( + + + + {t("crop.preview.title", "Crop Area Selection")} + + + + + + +
+ + + + + +
+ + + )} + + {/* Manual Coordinate Input - Only show when autoCrop is false */} + {!parameters.parameters.autoCrop && ( + + )} + + {/* Validation Alert - Only show when autoCrop is false */} + {!parameters.parameters.autoCrop && !isCropValid && ( {t("crop.error.invalidArea", "Crop area extends beyond PDF boundaries")} diff --git a/frontend/src/core/components/tools/flatten/FlattenSettings.tsx b/frontend/src/core/components/tools/flatten/FlattenSettings.tsx index ae8b1ecf50..b8e97f8ef5 100644 --- a/frontend/src/core/components/tools/flatten/FlattenSettings.tsx +++ b/frontend/src/core/components/tools/flatten/FlattenSettings.tsx @@ -1,4 +1,4 @@ -import { Stack, Text, Checkbox } from "@mantine/core"; +import { Stack, Text, Checkbox, NumberInput } from "@mantine/core"; import { useTranslation } from "react-i18next"; import { FlattenParameters } from "@app/hooks/tools/flatten/useFlattenParameters"; @@ -28,6 +28,20 @@ const FlattenSettings = ({ parameters, onParameterChange, disabled = false }: Fl } /> + + {!parameters.flattenOnlyForms && ( + onParameterChange('renderDpi', value != null && value !== '' ? Number(value) : undefined)} + disabled={disabled} + min={72} + max={2400} + step={50} + /> + )} ); }; diff --git a/frontend/src/core/components/tools/getPdfInfo/sections/OtherSection.tsx b/frontend/src/core/components/tools/getPdfInfo/sections/OtherSection.tsx index e7eb8d8b3e..3bc515a1a2 100644 --- a/frontend/src/core/components/tools/getPdfInfo/sections/OtherSection.tsx +++ b/frontend/src/core/components/tools/getPdfInfo/sections/OtherSection.tsx @@ -1,7 +1,7 @@ import React from 'react'; import { Accordion, Stack, Text } from '@mantine/core'; import { useTranslation } from 'react-i18next'; -import type { PdfOtherInfo } from '@app/types/getPdfInfo'; +import type { PdfOtherInfo, PdfAttachmentInfo, PdfEmbeddedFileInfo } from '@app/types/getPdfInfo'; import SectionBlock from '@app/components/tools/getPdfInfo/shared/SectionBlock'; import ScrollableCodeBlock from '@app/components/tools/getPdfInfo/shared/ScrollableCodeBlock'; import { pdfInfoAccordionStyles } from '@app/components/tools/getPdfInfo/shared/accordionStyles'; @@ -11,6 +11,42 @@ interface OtherSectionProps { other?: PdfOtherInfo | null; } +const renderAttachmentsList = (attachments: PdfAttachmentInfo[] | undefined, emptyText: string) => { + if (!attachments || attachments.length === 0) return {emptyText}; + return ( + + {attachments.map((attachment, idx) => ( +
+ + {attachment.Name || 'Unnamed attachment'} + {attachment.Description && ` - ${attachment.Description}`} + {attachment.FileSize != null && ` (${attachment.FileSize} bytes)`} + +
+ ))} + + ); +}; + +const renderEmbeddedFilesList = (embeddedFiles: PdfEmbeddedFileInfo[] | undefined, emptyText: string) => { + if (!embeddedFiles || embeddedFiles.length === 0) return {emptyText}; + return ( + + {embeddedFiles.map((file, idx) => ( +
+ + {file.Name || 'Unnamed file'} + {file.FileSize != null && ` (${file.FileSize} bytes)`} + {file.MimeType && ` - ${file.MimeType}`} + {file.CreationDate && ` - Created: ${file.CreationDate}`} + {file.ModificationDate && ` - Modified: ${file.ModificationDate}`} + +
+ ))} + + ); +}; + const renderList = (arr: unknown[] | undefined, emptyText: string) => { if (!arr || arr.length === 0) return {emptyText}; return ( @@ -37,11 +73,11 @@ const OtherSection: React.FC = ({ anchorId, other }) => { {t('getPdfInfo.other.attachments', 'Attachments')} - {renderList(other?.Attachments, noneDetected)} + {renderAttachmentsList(other?.Attachments, noneDetected)} {t('getPdfInfo.other.embeddedFiles', 'Embedded Files')} - {renderList(other?.EmbeddedFiles, noneDetected)} + {renderEmbeddedFilesList(other?.EmbeddedFiles, noneDetected)} {t('getPdfInfo.other.javaScript', 'JavaScript')} diff --git a/frontend/src/core/components/tools/getPdfInfo/sections/PerPageSection.tsx b/frontend/src/core/components/tools/getPdfInfo/sections/PerPageSection.tsx index 4fd257cce6..36bd7bf1c1 100644 --- a/frontend/src/core/components/tools/getPdfInfo/sections/PerPageSection.tsx +++ b/frontend/src/core/components/tools/getPdfInfo/sections/PerPageSection.tsx @@ -1,7 +1,7 @@ import React from 'react'; import { Accordion, Stack, Text } from '@mantine/core'; import { useTranslation } from 'react-i18next'; -import type { PdfPerPageInfo, PdfPageInfo, PdfFontInfo } from '@app/types/getPdfInfo'; +import type { PdfPerPageInfo, PdfPageInfo, PdfFontInfo, PdfImageInfo } from '@app/types/getPdfInfo'; import SectionBlock from '@app/components/tools/getPdfInfo/shared/SectionBlock'; import KeyValueList from '@app/components/tools/getPdfInfo/shared/KeyValueList'; import { pdfInfoAccordionStyles } from '@app/components/tools/getPdfInfo/shared/accordionStyles'; @@ -11,6 +11,23 @@ interface PerPageSectionProps { perPage?: PdfPerPageInfo | null; } +const renderImagesList = (images: PdfImageInfo[] | undefined, emptyText: string) => { + if (!images || images.length === 0) return {emptyText}; + return ( + + {images.map((image, idx) => ( +
+ + {image.Name ? `${image.Name} ` : 'Image '} + ({image.Width}×{image.Height}px + {image.ColorSpace ? `, ${image.ColorSpace}` : ''}) + +
+ ))} + + ); +}; + const renderList = (arr: unknown[] | undefined, emptyText: string) => { if (!arr || arr.length === 0) return {emptyText}; return ( @@ -84,7 +101,7 @@ const PerPageSection: React.FC = ({ anchorId, perPage }) => )} {t('getPdfInfo.perPage.images', 'Images')} - {renderList(pageInfo?.Images, noneDetected)} + {renderImagesList(pageInfo?.Images, noneDetected)} {t('getPdfInfo.perPage.links', 'Links')} diff --git a/frontend/src/core/components/tools/pdfTextEditor/FontStatusPanel.tsx b/frontend/src/core/components/tools/pdfTextEditor/FontStatusPanel.tsx index 0ba9a46654..2c600c2319 100644 --- a/frontend/src/core/components/tools/pdfTextEditor/FontStatusPanel.tsx +++ b/frontend/src/core/components/tools/pdfTextEditor/FontStatusPanel.tsx @@ -1,10 +1,11 @@ import React, { useMemo, useState } from 'react'; import { - Accordion, Badge, Box, Code, Collapse, + Divider, + Flex, Group, List, Paper, @@ -29,10 +30,14 @@ import { getFontStatusColor, getFontStatusDescription, } from '@app/tools/pdfTextEditor/fontAnalysis'; +import LocalIcon from '@app/components/shared/LocalIcon'; +import { Tooltip as CustomTooltip } from '@app/components/shared/Tooltip'; interface FontStatusPanelProps { document: PdfJsonDocument | null; pageIndex?: number; + isCollapsed?: boolean; + onCollapsedChange?: (collapsed: boolean) => void; } const FontStatusBadge = ({ analysis }: { analysis: FontAnalysis }) => { @@ -74,25 +79,31 @@ const FontDetailItem = ({ analysis }: { analysis: FontAnalysis }) => { const [expanded, setExpanded] = useState(false); return ( - setExpanded(!expanded)}> + setExpanded(!expanded)}> - - - - - {analysis.baseName} - + + + + + + {analysis.baseName} + + {analysis.isSubset && ( - + subset )} - + {expanded ? : } - + @@ -165,7 +176,12 @@ const FontDetailItem = ({ analysis }: { analysis: FontAnalysis }) => { ); }; -const FontStatusPanel: React.FC = ({ document, pageIndex }) => { +const FontStatusPanel: React.FC = ({ + document, + pageIndex, + isCollapsed = false, + onCollapsedChange +}) => { const { t } = useTranslation(); const fontAnalysis: DocumentFontAnalysis = useMemo( @@ -175,16 +191,6 @@ const FontStatusPanel: React.FC = ({ document, pageIndex } const { canReproducePerfectly, hasWarnings, summary, fonts } = fontAnalysis; - const statusIcon = useMemo(() => { - if (canReproducePerfectly) { - return ; - } - if (hasWarnings) { - return ; - } - return ; - }, [canReproducePerfectly, hasWarnings]); - // Early return AFTER all hooks are declared if (!document || fontAnalysis.fonts.length === 0) { return null; @@ -197,37 +203,46 @@ const FontStatusPanel: React.FC = ({ document, pageIndex } : t('pdfTextEditor.fontAnalysis.allFonts', 'All fonts'); return ( - - - - - - {statusIcon} - - {pageLabel} - - - {fonts.length} - - +
+
+ {/* Header - matches ToolStep style */} + onCollapsedChange?.(!isCollapsed)} + > + + + {pageLabel} + + + {fonts.length} + + - {/* Warning badges BEFORE expansion */} - - {summary.systemFallback > 0 && ( - }> - {summary.systemFallback} {t('pdfTextEditor.fontAnalysis.fallback', 'fallback')} - - )} - {summary.missing > 0 && ( - }> - {summary.missing} {t('pdfTextEditor.fontAnalysis.missing', 'missing')} - - )} - - - - - + {isCollapsed ? ( + + ) : ( + + )} + + + {/* Content */} + {!isCollapsed && ( + {/* Overall Status Message */} {canReproducePerfectly @@ -277,9 +292,10 @@ const FontStatusPanel: React.FC = ({ document, pageIndex } ))} - - - + )} +
+ +
); }; diff --git a/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorSidebar.tsx b/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorSidebar.tsx new file mode 100644 index 0000000000..6ad1fec331 --- /dev/null +++ b/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorSidebar.tsx @@ -0,0 +1,340 @@ +import React, { useCallback, useMemo, useState } from 'react'; +import { + ActionIcon, + Badge, + Button, + Divider, + Flex, + Group, + Menu, + Modal, + ScrollArea, + SegmentedControl, + Stack, + Switch, + Text, +} from '@mantine/core'; +import { useTranslation } from 'react-i18next'; +import AutorenewIcon from '@mui/icons-material/Autorenew'; +import InfoOutlinedIcon from '@mui/icons-material/InfoOutlined'; +import MoreHorizIcon from '@mui/icons-material/MoreHoriz'; +import FileDownloadIcon from '@mui/icons-material/FileDownloadOutlined'; + +import { PdfTextEditorViewData, TextGroup } from '@app/tools/pdfTextEditor/pdfTextEditorTypes'; +import { pageDimensions } from '@app/tools/pdfTextEditor/pdfTextEditorUtils'; +import FontStatusPanel from '@app/components/tools/pdfTextEditor/FontStatusPanel'; +import ToolStep from '@app/components/tools/shared/ToolStep'; +import { usePdfTextEditorTips } from '@app/components/tooltips/usePdfTextEditorTips'; +import { Tooltip } from '@app/components/shared/Tooltip'; +import LocalIcon from '@app/components/shared/LocalIcon'; + +type GroupingMode = 'auto' | 'paragraph' | 'singleLine'; + +interface PdfTextEditorSidebarProps { + data: PdfTextEditorViewData; +} + +// Analyze page content to determine if it's paragraph-heavy +const analyzePageContentType = ( + groups: TextGroup[], + pageWidth: number, +): boolean => { + if (groups.length < 3) { + return false; + } + + const widths = groups.map((g) => Math.max(g.bounds.right - g.bounds.left, 1)); + const avgWidth = widths.reduce((sum, w) => sum + w, 0) / widths.length; + const stdDev = Math.sqrt( + widths.reduce((sum, w) => sum + Math.pow(w - avgWidth, 2), 0) / widths.length, + ); + const coefficientOfVariation = avgWidth > 0 ? stdDev / avgWidth : 0; + const fullWidthRatio = widths.filter((w) => w > pageWidth * 0.65).length / widths.length; + + const criterion1 = groups.length >= 3; + const criterion2 = avgWidth > pageWidth * 0.3; + const criterion3 = coefficientOfVariation > 0.5 || fullWidthRatio > 0.6; + + return criterion1 && criterion2 && criterion3; +}; + +const PdfTextEditorSidebar = ({ data }: PdfTextEditorSidebarProps) => { + const { t } = useTranslation(); + const [pendingModeChange, setPendingModeChange] = useState(null); + const [advancedSettingsCollapsed, setAdvancedSettingsCollapsed] = useState(false); + const [fontsCollapsed, setFontsCollapsed] = useState(false); + const pdfTextEditorTips = usePdfTextEditorTips(); + + const { + document: pdfDocument, + groupsByPage, + hasDocument, + hasChanges, + fileName, + isGeneratingPdf, + isSavingToWorkbench, + isConverting, + forceSingleTextElement, + groupingMode: externalGroupingMode, + autoScaleText, + selectedPage, + onReset, + onGeneratePdf, + onSaveToWorkbench, + onForceSingleTextElementChange, + onGroupingModeChange, + onAutoScaleTextChange, + } = data; + + // Get page dimensions + const pages = pdfDocument?.pages ?? []; + const currentPage = pages[selectedPage] ?? null; + const { width: pageWidth } = pageDimensions(currentPage); + const pageGroups = groupsByPage[selectedPage] ?? []; + + // Detect if current page contains paragraph-heavy content + const isParagraphPage = useMemo(() => { + return analyzePageContentType(pageGroups, pageWidth); + }, [pageGroups, pageWidth]); + + const handleModeChangeRequest = useCallback((newMode: GroupingMode) => { + if (hasChanges && newMode !== externalGroupingMode) { + setPendingModeChange(newMode); + } else { + onGroupingModeChange(newMode); + } + }, [hasChanges, externalGroupingMode, onGroupingModeChange]); + + const handleConfirmModeChange = useCallback(() => { + if (pendingModeChange) { + onGroupingModeChange(pendingModeChange); + setPendingModeChange(null); + } + }, [pendingModeChange, onGroupingModeChange]); + + const handleCancelModeChange = useCallback(() => { + setPendingModeChange(null); + }, []); + + return ( + <> + + + + + {/* Title row with ALPHA badge and info tooltip */} + + + + {t('pdfTextEditor.title', 'PDF Text Editor')} + + + {t('toolPanel.alpha', 'Alpha')} + + + + + + + + + + {fileName && ( + + {t('pdfTextEditor.currentFile', 'Current file: {{name}}', { name: fileName })} + + )} + + + setAdvancedSettingsCollapsed(!advancedSettingsCollapsed)} + > + + + + + + + + + + + {t('pdfTextEditor.options.autoScaleText.title', 'Auto-scale text to fit boxes')} + + + onAutoScaleTextChange(event.currentTarget.checked)} + /> + + + + + + + + {t('pdfTextEditor.options.groupingMode.title', 'Text Grouping Mode')} + + {externalGroupingMode === 'auto' && isParagraphPage && ( + + {t('pdfTextEditor.pageType.paragraph', 'Paragraph page')} + + )} + {externalGroupingMode === 'auto' && !isParagraphPage && hasDocument && ( + + {t('pdfTextEditor.pageType.sparse', 'Sparse text')} + + )} + + + {externalGroupingMode === 'auto' + ? t( + 'pdfTextEditor.options.groupingMode.autoDescription', + 'Automatically detects page type and groups text appropriately.' + ) + : externalGroupingMode === 'paragraph' + ? t( + 'pdfTextEditor.options.groupingMode.paragraphDescription', + 'Groups aligned lines into multi-line paragraph text boxes.' + ) + : t( + 'pdfTextEditor.options.groupingMode.singleLineDescription', + 'Keeps each PDF text line as a separate text box.' + )} + + handleModeChangeRequest(value as GroupingMode)} + data={[ + { label: t('pdfTextEditor.groupingMode.auto', 'Auto'), value: 'auto' }, + { label: t('pdfTextEditor.groupingMode.paragraph', 'Paragraph'), value: 'paragraph' }, + { label: t('pdfTextEditor.groupingMode.singleLine', 'Single Line'), value: 'singleLine' }, + ]} + fullWidth + /> + + + + + + + + + + + + + {t('pdfTextEditor.options.forceSingleElement.title', 'Lock edited text to a single PDF element')} + + + onForceSingleTextElementChange(event.currentTarget.checked)} + /> + + + + + {hasDocument && ( + + )} + + + + + + + + + + + + + } + onClick={() => onGeneratePdf()} + disabled={!hasChanges || isGeneratingPdf} + > + {t('pdfTextEditor.actions.downloadCopy', 'Download Copy')} + + } + onClick={onReset} + color="red" + > + {t('pdfTextEditor.actions.reset', 'Reset Changes')} + + + + + + + {/* Mode Change Confirmation Modal */} + + + + {t( + 'pdfTextEditor.modeChange.warning', + 'Changing the text grouping mode will reset all unsaved changes. Are you sure you want to continue?' + )} + + + + + + + + + ); +}; + +export default PdfTextEditorSidebar; diff --git a/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorView.tsx b/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorView.tsx index 3c5b45e0e6..99cd6ad99a 100644 --- a/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorView.tsx +++ b/frontend/src/core/components/tools/pdfTextEditor/PdfTextEditorView.tsx @@ -1,6 +1,5 @@ import React, { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react'; import { - Accordion, ActionIcon, Alert, Badge, @@ -14,18 +13,12 @@ import { Pagination, Progress, ScrollArea, - SegmentedControl, Stack, - Switch, Text, - Title, Tooltip, } from '@mantine/core'; import { Dropzone } from '@mantine/dropzone'; import { useTranslation } from 'react-i18next'; -import DescriptionIcon from '@mui/icons-material/DescriptionOutlined'; -import FileDownloadIcon from '@mui/icons-material/FileDownloadOutlined'; -import PictureAsPdfIcon from '@mui/icons-material/PictureAsPdfOutlined'; import AutorenewIcon from '@mui/icons-material/Autorenew'; import WarningAmberIcon from '@mui/icons-material/WarningAmber'; import InfoOutlinedIcon from '@mui/icons-material/InfoOutlined'; @@ -34,7 +27,6 @@ import MergeTypeIcon from '@mui/icons-material/MergeType'; import CallSplitIcon from '@mui/icons-material/CallSplit'; import MoreVertIcon from '@mui/icons-material/MoreVert'; import UploadFileIcon from '@mui/icons-material/UploadFileOutlined'; -import SaveIcon from '@mui/icons-material/SaveOutlined'; import { Rnd } from 'react-rnd'; import NavigationWarningModal from '@app/components/shared/NavigationWarningModal'; @@ -46,7 +38,6 @@ import { TextGroup, } from '@app/tools/pdfTextEditor/pdfTextEditorTypes'; import { getImageBounds, pageDimensions } from '@app/tools/pdfTextEditor/pdfTextEditorUtils'; -import FontStatusPanel from '@app/components/tools/pdfTextEditor/FontStatusPanel'; const MAX_RENDER_WIDTH = 820; const MIN_BOX_SIZE = 18; @@ -313,8 +304,6 @@ const analyzePageContentType = (groups: TextGroup[], pageWidth: number): boolean return isParagraphPage; }; -type GroupingMode = 'auto' | 'paragraph' | 'singleLine'; - const PdfTextEditorView = ({ data }: PdfTextEditorViewProps) => { const { t } = useTranslation(); const { activeFiles } = useFileContext(); @@ -327,9 +316,7 @@ const PdfTextEditorView = ({ data }: PdfTextEditorViewProps) => { const rndRefs = useRef>(new Map()); const pendingDragUpdateRef = useRef(null); const [fontFamilies, setFontFamilies] = useState>(new Map()); - const [autoScaleText, setAutoScaleText] = useState(true); const [textScales, setTextScales] = useState>(new Map()); - const [pendingModeChange, setPendingModeChange] = useState(null); const measurementKeyRef = useRef(''); const containerRef = useRef(null); const editorRefs = useRef>(new Map()); @@ -378,27 +365,27 @@ const PdfTextEditorView = ({ data }: PdfTextEditorViewProps) => { dirtyPages, hasDocument, hasVectorPreview, - fileName, + fileName: _fileName, errorMessage, - isGeneratingPdf, - isSavingToWorkbench, + isGeneratingPdf: _isGeneratingPdf, + isSavingToWorkbench: _isSavingToWorkbench, isConverting, conversionProgress, - hasChanges, - forceSingleTextElement, + hasChanges: _hasChanges, + forceSingleTextElement: _forceSingleTextElement, groupingMode: externalGroupingMode, + autoScaleText, requestPagePreview, onSelectPage, onGroupEdit, onGroupDelete, onImageTransform, onImageReset, - onReset, - onDownloadJson, - onGeneratePdf, + onReset: _onReset, + onGeneratePdf: _onGeneratePdf, onSaveToWorkbench, - onForceSingleTextElementChange, - onGroupingModeChange, + onForceSingleTextElementChange: _onForceSingleTextElementChange, + onGroupingModeChange: _onGroupingModeChange, onMergeGroups, onUngroupGroup, onLoadFile, @@ -428,27 +415,6 @@ const PdfTextEditorView = ({ data }: PdfTextEditorViewProps) => { } : null, }); - const handleModeChangeRequest = useCallback((newMode: GroupingMode) => { - if (hasChanges && newMode !== externalGroupingMode) { - // Show confirmation dialog - setPendingModeChange(newMode); - } else { - // No changes, switch immediately - onGroupingModeChange(newMode); - } - }, [hasChanges, externalGroupingMode, onGroupingModeChange]); - - const handleConfirmModeChange = useCallback(() => { - if (pendingModeChange) { - onGroupingModeChange(pendingModeChange); - setPendingModeChange(null); - } - }, [pendingModeChange, onGroupingModeChange]); - - const handleCancelModeChange = useCallback(() => { - setPendingModeChange(null); - }, []); - const clearSelection = useCallback(() => { setSelectedGroupIds(new Set()); lastSelectedGroupIdRef.current = null; @@ -1448,223 +1414,16 @@ const selectionToolbarPosition = useMemo(() => { padding: '1.5rem', overflow: 'hidden', height: '100%', - display: 'grid', - gridTemplateColumns: 'minmax(0, 1fr) 320px', - gridTemplateRows: '1fr', - alignItems: hasDocument ? 'start' : 'stretch', - gap: '1.5rem', + display: 'flex', + flexDirection: 'column', }} > - - - - - - - {t('pdfTextEditor.title', 'PDF JSON Editor')} - {hasChanges && {t('pdfTextEditor.badges.unsaved', 'Edited')}} - - - - - - - - - - - {fileName && ( - - {t('pdfTextEditor.currentFile', 'Current file: {{name}}', { name: fileName })} - - )} - - - - -
- - {t('pdfTextEditor.options.autoScaleText.title', 'Auto-scale text to fit boxes')} - - - {t( - 'pdfTextEditor.options.autoScaleText.description', - 'Automatically scales text horizontally to fit within its original bounding box when font rendering differs from PDF.' - )} - -
- setAutoScaleText(event.currentTarget.checked)} - /> - - - - - - {t('pdfTextEditor.options.groupingMode.title', 'Text Grouping Mode')} - - {externalGroupingMode === 'auto' && isParagraphPage && ( - - {t('pdfTextEditor.pageType.paragraph', 'Paragraph page')} - - )} - {externalGroupingMode === 'auto' && !isParagraphPage && hasDocument && ( - - {t('pdfTextEditor.pageType.sparse', 'Sparse text')} - - )} - - - {externalGroupingMode === 'auto' - ? t( - 'pdfTextEditor.options.groupingMode.autoDescription', - 'Automatically detects page type and groups text appropriately.' - ) - : externalGroupingMode === 'paragraph' - ? t( - 'pdfTextEditor.options.groupingMode.paragraphDescription', - 'Groups aligned lines into multi-line paragraph text boxes.' - ) - : t( - 'pdfTextEditor.options.groupingMode.singleLineDescription', - 'Keeps each PDF text line as a separate text box.' - )} - - handleModeChangeRequest(value as GroupingMode)} - data={[ - { label: t('pdfTextEditor.groupingMode.auto', 'Auto'), value: 'auto' }, - { label: t('pdfTextEditor.groupingMode.paragraph', 'Paragraph'), value: 'paragraph' }, - { label: t('pdfTextEditor.groupingMode.singleLine', 'Single Line'), value: 'singleLine' }, - ]} - fullWidth - /> - - - - {t( - 'pdfTextEditor.options.manualGrouping.descriptionInline', - 'Tip: Hold Ctrl (Cmd) or Shift to multi-select text boxes. A floating toolbar will appear above the selection so you can merge, ungroup, or adjust widths.', - )} - - - -
- - {t('pdfTextEditor.options.forceSingleElement.title', 'Lock edited text to a single PDF element')} - - - {t( - 'pdfTextEditor.options.forceSingleElement.description', - 'When enabled, the editor exports each edited text box as one PDF text element to avoid overlapping glyphs or mixed fonts.' - )} - -
- onForceSingleTextElementChange(event.currentTarget.checked)} - /> - - - - - - - - - - - {t('pdfTextEditor.disclaimer.heading', 'Preview Limitations')} - - - - - - - {t( - 'pdfTextEditor.disclaimer.textFocus', - 'This workspace focuses on editing text and repositioning embedded images. Complex page artwork, form widgets, and layered graphics are preserved for export but are not fully editable here.' - )} - - - {t( - 'pdfTextEditor.disclaimer.previewVariance', - 'Some visuals (such as table borders, shapes, or annotation appearances) may not display exactly in the preview. The exported PDF keeps the original drawing commands whenever possible.' - )} - - - {t( - 'pdfTextEditor.disclaimer.alpha', - 'This alpha viewer is still evolving—certain fonts, colours, transparency effects, and layout details may shift slightly. Please double-check the generated PDF before sharing.' - )} - - - - - - - {hasDocument && } - - - - {errorMessage && ( } color="red" radius="md" - style={{ gridColumn: '2 / 3' }} + mb="md" > {errorMessage} @@ -1674,7 +1433,7 @@ const selectionToolbarPosition = useMemo(() => { { @@ -1704,8 +1463,8 @@ const selectionToolbarPosition = useMemo(() => { {activeFiles.length > 0 - ? t('pdfTextEditor.empty.dropzoneWithFiles', 'Select a file from the Files tab, or drag and drop a PDF or JSON file here, or click to browse') - : t('pdfTextEditor.empty.dropzone', 'Drag and drop a PDF or JSON file here, or click to browse')} + ? t('pdfTextEditor.empty.dropzoneWithFiles', 'Select a file from the Files tab, or drag and drop a PDF here, or click to browse') + : t('pdfTextEditor.empty.dropzone', 'Drag and drop a PDF here, or click to browse')} @@ -1713,7 +1472,7 @@ const selectionToolbarPosition = useMemo(() => { )} {isConverting && ( - +
@@ -1748,10 +1507,8 @@ const selectionToolbarPosition = useMemo(() => { gap="lg" className="flex-1" style={{ - gridColumn: '1 / 2', - gridRow: 1, minHeight: 0, - height: 'calc(100vh - 3rem)', + flex: 1, overflow: 'hidden', }} > @@ -1788,65 +1545,208 @@ const selectionToolbarPosition = useMemo(() => { title={ - {t('pdfTextEditor.welcomeBanner.title', 'Welcome to PDF Text Editor (Early Access)')} + + {t( + 'pdfTextEditor.welcomeBanner.title', + 'Welcome to PDF Text Editor (Early Access)', + )} + } centered size="lg" + scrollAreaComponent={Box} > - - +
+ {/* Header (fixed) */} +
- {t('pdfTextEditor.welcomeBanner.experimental', 'This is an experimental feature in active development. Expect some instability and issues during use.')} + {t( + 'pdfTextEditor.welcomeBanner.experimental', + 'This is an experimental feature in active development. Expect some instability and issues during use.', + )} - {t('pdfTextEditor.welcomeBanner.howItWorks', 'This tool converts your PDF to an editable format where you can modify text content and reposition images. Changes are saved back as a new PDF.')} + {t( + 'pdfTextEditor.welcomeBanner.howItWorks', + 'This tool converts your PDF to an editable format where you can modify text content and reposition images. Changes are saved back as a new PDF.', + )} +
+ + {/* Body (scrollable) */} +
+
+ + + {t('pdfTextEditor.welcomeBanner.bestFor', 'Works Best With:')} + + +
  • + {t( + 'pdfTextEditor.welcomeBanner.bestFor1', + 'Simple PDFs containing primarily text and images', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.bestFor2', + 'Documents with standard paragraph formatting', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.bestFor3', + 'Letters, essays, reports, and basic documents', + )} +
    • +     + + + {t('pdfTextEditor.welcomeBanner.notIdealFor', 'Not Ideal For:')} + + +
  • + {t( + 'pdfTextEditor.welcomeBanner.notIdealFor1', + 'PDFs with special formatting like bullet points, tables, or multi-column layouts', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.notIdealFor2', + 'Magazines, brochures, or heavily designed documents', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.notIdealFor3', + 'Instruction manuals with complex layouts', + )} +
    • +     + + + {t('pdfTextEditor.welcomeBanner.limitations', 'Current Limitations:')} + + +
  • + {t( + 'pdfTextEditor.welcomeBanner.limitation1', + 'Font rendering may differ slightly from the original PDF', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.limitation2', + 'Complex graphics, form fields, and annotations are preserved but not editable', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.limitation3', + 'Large files may take time to convert and process', + )} +
    • +     + + + {t('pdfTextEditor.welcomeBanner.knownIssues', 'Known Issues (Being Fixed):')} + + +
  • + {t( + 'pdfTextEditor.welcomeBanner.issue1', + 'Text colour is not currently preserved (will be added soon)', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.issue2', + 'Paragraph mode has more alignment and spacing issues - Single Line mode recommended', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.issue3', + 'The preview display differs from the exported PDF - exported PDFs are closer to the original', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.issue4', + 'Rotated text alignment may need manual adjustment', + )} +
    • +
  • + {t( + 'pdfTextEditor.welcomeBanner.issue5', + 'Transparency and layering effects may vary from original', + )} +
    • +     +
    +
    + + {/* Footer (fixed) */} +
    - - {t('pdfTextEditor.welcomeBanner.bestFor', 'Works Best With:')} + + {t( + 'pdfTextEditor.welcomeBanner.feedback', + 'This is an early access feature. Please report any issues you encounter to help us improve!', + )} - -
  • {t('pdfTextEditor.welcomeBanner.bestFor1', 'Simple PDFs containing primarily text and images')}
    • -
  • {t('pdfTextEditor.welcomeBanner.bestFor2', 'Documents with standard paragraph formatting')}
    • -
  • {t('pdfTextEditor.welcomeBanner.bestFor3', 'Letters, essays, reports, and basic documents')}
    • -     - - - {t('pdfTextEditor.welcomeBanner.notIdealFor', 'Not Ideal For:')} - - -
  • {t('pdfTextEditor.welcomeBanner.notIdealFor1', 'PDFs with special formatting like bullet points, tables, or multi-column layouts')}
    • -
  • {t('pdfTextEditor.welcomeBanner.notIdealFor2', 'Magazines, brochures, or heavily designed documents')}
    • -
  • {t('pdfTextEditor.welcomeBanner.notIdealFor3', 'Instruction manuals with complex layouts')}
    • -     - - - {t('pdfTextEditor.welcomeBanner.limitations', 'Current Limitations:')} - - -
  • {t('pdfTextEditor.welcomeBanner.limitation1', 'Font rendering may differ slightly from the original PDF')}
    • -
  • {t('pdfTextEditor.welcomeBanner.limitation2', 'Complex graphics, form fields, and annotations are preserved but not editable')}
    • -
  • {t('pdfTextEditor.welcomeBanner.limitation3', 'Large files may take time to convert and process')}
    • -     - - - {t('pdfTextEditor.welcomeBanner.knownIssues', 'Known Issues (Being Fixed):')} - - -
  • {t('pdfTextEditor.welcomeBanner.issue1', 'Text colour is not currently preserved (will be added soon)')}
    • -
  • {t('pdfTextEditor.welcomeBanner.issue2', 'Paragraph mode has more alignment and spacing issues - Single Line mode recommended')}
    • -
  • {t('pdfTextEditor.welcomeBanner.issue3', 'The preview display differs from the exported PDF - exported PDFs are closer to the original')}
    • -
  • {t('pdfTextEditor.welcomeBanner.issue4', 'Rotated text alignment may need manual adjustment')}
    • -
  • {t('pdfTextEditor.welcomeBanner.issue5', 'Transparency and layering effects may vary from original')}
    • -     - - - {t('pdfTextEditor.welcomeBanner.feedback', 'This is an early access feature. Please report any issues you encounter to help us improve!')} - - + @@ -1854,8 +1754,8 @@ const selectionToolbarPosition = useMemo(() => { {t('pdfTextEditor.welcomeBanner.dontShowAgain', "Don't show again")} - - +
    +
    {     )} - {/* Mode Change Confirmation Modal */} - - - - {t( - 'pdfTextEditor.modeChange.warning', - 'Changing the text grouping mode will reset all unsaved changes. Are you sure you want to continue?' - )} - - - - - - - - {/* Navigation Warning Modal */} { + const handleKeyDown = (event: KeyboardEvent) => { + if (event.key === 'ArrowLeft') { + event.preventDefault(); + parameters.rotateAnticlockwise(); + } else if (event.key === 'ArrowRight') { + event.preventDefault(); + parameters.rotateClockwise(); + } + }; + + window.addEventListener('keydown', handleKeyDown); + + return () => { + window.removeEventListener('keydown', handleKeyDown); + }; + }, [parameters]); + return ( {/* Thumbnail Preview Section */} diff --git a/frontend/src/core/components/tools/sign/SignSettings.tsx b/frontend/src/core/components/tools/sign/SignSettings.tsx index 12de2cadda..c4261e5511 100644 --- a/frontend/src/core/components/tools/sign/SignSettings.tsx +++ b/frontend/src/core/components/tools/sign/SignSettings.tsx @@ -461,23 +461,13 @@ const SignSettings = ({ const handleImageChange = async (file: File | null) => { if (file && !disabled) { try { - const result = await new Promise((resolve, reject) => { - const reader = new FileReader(); - reader.onload = (e) => { - if (e.target?.result) { - resolve(e.target.result as string); - } else { - reject(new Error('Failed to read file')); - } - }; - reader.onerror = () => reject(reader.error); - reader.readAsDataURL(file); - }); - // Reset pause state and directly activate placement setPlacementManuallyPaused(false); lastAppliedPlacementKey.current = null; - setImageSignatureData(result); + + // Image data will be set by onProcessedImageData callback in ImageUploader + // This avoids the race condition where both handleImageChange and onProcessedImageData + // try to set the image data, potentially with the wrong version // Directly activate placement on image upload if (typeof window !== 'undefined') { @@ -491,8 +481,6 @@ const SignSettings = ({ } else if (!file) { setImageSignatureData(undefined); onDeactivateSignature?.(); - setImageSignatureData(undefined); - onDeactivateSignature?.(); } }; @@ -835,6 +823,12 @@ const SignSettings = ({ { + if (dataUrl) { + setImageSignatureData(dataUrl); + } + }} /> {renderSaveButtonRow('image', hasImageSignature, handleSaveImageSignature)} diff --git a/frontend/src/core/components/tools/split/SplitSettings.tsx b/frontend/src/core/components/tools/split/SplitSettings.tsx index e2349ac889..b0eafae2fd 100644 --- a/frontend/src/core/components/tools/split/SplitSettings.tsx +++ b/frontend/src/core/components/tools/split/SplitSettings.tsx @@ -1,4 +1,4 @@ -import { Stack, TextInput, Checkbox, Anchor, Text } from '@mantine/core'; +import { Stack, TextInput, Checkbox, Anchor, Text, Select } from '@mantine/core'; import LocalIcon from '@app/components/shared/LocalIcon'; import { useTranslation } from 'react-i18next'; import { SPLIT_METHODS } from '@app/constants/splitConstants'; @@ -49,6 +49,29 @@ const SplitSettings = ({ placeholder={t("split-by-sections.vertical.placeholder", "Enter number of vertical divisions")} disabled={disabled} /> +