From cd4f0179fc1f20954ac73fda7e0fb58ca99837e3 Mon Sep 17 00:00:00 2001 From: m Date: Wed, 16 Sep 2026 14:47:10 +0200 Subject: [PATCH] add gitlab ci --- .gitignore | 27 +- .gitlab-ci.yml | 190 +++++ CHANGELOG.md | 29 + LICENSE | 655 ++++++++++++++++++ README.md | 4 +- backend/.dockerignore | 8 + backend/Dockerfile | 59 ++ backend/cmd/server/router_test.go | 1 + .../000010_resources_ocr_text.down.sql | 1 + .../000010_resources_ocr_text.up.sql | 5 + backend/handlers/files.go | 23 + backend/handlers/files_test.go | 56 ++ backend/handlers/router.go | 1 + backend/repository/resources.go | 28 +- backend/repository/resources_test.go | 51 ++ backend/service/ocr.go | 8 + backend/service/ocr_test.go | 53 ++ backend/service/resources.go | 20 + docker-compose.yml | 60 +- docs/api-v1.md | 10 +- mise.toml | 42 ++ mobile-kotlin/app/build.gradle.kts | 32 +- mobile-kotlin/app/signing.properties.example | 14 + .../vaultdrop/mobile/data/remote/ApiClient.kt | 5 + .../mobile/data/remote/ApiService.kt | 11 + .../vaultdrop/mobile/data/remote/dto/Dtos.kt | 10 + .../mobile/data/repository/OcrRepository.kt | 22 + .../mobile/features/ocr/OcrViewModel.kt | 15 + .../data/repository/FolderMergeDataTest.kt | 5 + .../data/repository/MoveProtectionTest.kt | 5 + .../data/repository/OcrRepositoryTest.kt | 47 ++ .../data/repository/ShareRepositoryTest.kt | 5 + 32 files changed, 1462 insertions(+), 40 deletions(-) create mode 100644 .gitlab-ci.yml create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 backend/.dockerignore create mode 100644 backend/Dockerfile create mode 100644 backend/db/migrations/000010_resources_ocr_text.down.sql create mode 100644 backend/db/migrations/000010_resources_ocr_text.up.sql create mode 100644 mobile-kotlin/app/signing.properties.example diff --git a/.gitignore b/.gitignore index 7431800..e4d829e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,26 @@ -./backend/uploads \ No newline at end of file +# Go backend +backend/bin/ +backend/uploads/* +!backend/uploads/.gitkeep + +# Env local (jamais commité — cf. backend/.env.example) +.env +backend/.env + +# Android / Gradle +mobile-kotlin/local.properties +mobile-kotlin/.gradle/ +mobile-kotlin/.kotlin/ +**/build/ +*.iml +.idea/ + +# Signature release Android (jamais commité) +signing.properties +*.jks +*.keystore +!signing.properties.example + +# Artifacts +*.apk +dist/ \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..6a84933 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,190 @@ +# Pipeline GitLab pour VaultDrop — CI + Release. +# +# Prérequis runner : +# - Un runner avec executor Docker pour les jobs d'images (postgres service, +# docker:dind). Les jobs Android utilisent $ANDROID_IMAGE (défaut +# cimg/android) ; remplacez par l'image installée sur vos workers. +# +# Variables CI/CD à définir (Settings > CI/CD > Variables) : +# - RELEASE_KEYSTORE_B64 base64 du keystore release Android (jamais en clair) +# - SIGNING_STORE_PASSWORD SIGNING_KEY_ALIAS SIGNING_KEY_PASSWORD +# - GITLAB_API_TOKEN token (scope api, write_repository) pour créer la GitLab Release +# - DOCKERHUB_USER DOCKERHUB_TOKEN PAT Docker Hub (push public) +# - DOCKERHUB_NAMESPACE namespace Docker Hub (placeholder) +# +# Publication : à chaque tag vX.Y.Z → GitLab Release (APK attaché, latest + +# historique) + image $CI_REGISTRY + image Docker Hub. + +stages: + - lint + - test + - build + - docker + - release + +variables: + GO_IMAGE: "golang:1.26-alpine" + POSTGRES_IMAGE: "postgres:17-alpine" + ANDROID_IMAGE: "cimg/android:2024.01" + GRADLE_USER_HOME: "$CI_PROJECT_DIR/.gradle-home" + CGO_ENABLED: "0" + +default: + interruptible: true + retry: + max: 1 + +# ---------------------------------------------------------------- lint ---- +lint-backend: + stage: lint + image: $GO_IMAGE + script: + - go mod download + - go vet ./... + - go install honnef.co/go/tools/cmd/staticcheck@latest && staticcheck ./... + +lint-mobile: + stage: lint + image: $ANDROID_IMAGE + cache: + key: gradle-cache + paths: + - .gradle-home/caches + - .gradle-home/wrapper + script: + - cd mobile-kotlin && ./gradlew :app:lint -q + +# ---------------------------------------------------------------- test ---- +test-backend: + stage: test + image: $GO_IMAGE + services: + - name: $POSTGRES_IMAGE + alias: postgres + variables: + POSTGRES_DB: vaultdrop_test + POSTGRES_USER: vaultdrop + POSTGRES_PASSWORD: vaultdrop + TEST_DATABASE_URL: postgres://vaultdrop:vaultdrop@postgres:5432/vaultdrop_test?sslmode=disable + script: + - mkdir -p .go-cache && export GOPATH="$CI_PROJECT_DIR/.go-cache" + - go mod download + - go test ./... + cache: + key: go-cache + paths: + - .go-cache + +test-mobile: + stage: test + image: $ANDROID_IMAGE + cache: + key: gradle-cache + paths: + - .gradle-home/caches + - .gradle-home/wrapper + script: + - cd mobile-kotlin && ./gradlew :app:testDebugUnitTest -q + +# ---------------------------------------------------------------- build ---- +build-backend: + stage: build + image: $GO_IMAGE + script: + - export VERSION=$(cat VERSION) + - mkdir -p backend/bin + - cd backend && CGO_ENABLED=0 GOOS=linux go build -trimpath -ldflags "-s -w -X main.version=$VERSION" -o bin/vaultdrop-server cmd/server/main.go + - ./bin/vaultdrop-server --version + artifacts: + paths: + - backend/bin/vaultdrop-server + expire_in: 1 week + +# --------------------------------------------------------------- docker ---- +docker: + stage: docker + image: docker:27 + services: + - name: docker:27-dind + alias: docker + variables: + DOCKER_HOST: tcp://docker:2375 + DOCKER_TLS_CERTDIR: "" + IMAGE_TAG: "$CI_COMMIT_TAG" + script: + - export IMAGE_TAG="${IMAGE_TAG:-$CI_COMMIT_REF_SLUG}" + - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" "$CI_REGISTRY" + - docker build + --build-arg VERSION="$(cat VERSION)" + --build-arg BUILD_DATE="$(date -u +%Y-%m-%dT%H:%M:%SZ)" + -t "$CI_REGISTRY_IMAGE:$IMAGE_TAG" + ./backend + - docker push "$CI_REGISTRY_IMAGE:$IMAGE_TAG" + - docker run --rm "$CI_REGISTRY_IMAGE:$IMAGE_TAG" --version + needs: ["build-backend"] + rules: + - if: $CI_COMMIT_TAG + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + +# -------------------------------------------------------------- release ---- +release-apk: + stage: release + image: $ANDROID_IMAGE + cache: + key: gradle-cache + paths: + - .gradle-home/caches + - .gradle-home/wrapper + script: + - export VERSION=$(cat VERSION) + - cd mobile-kotlin + - | + if [ -n "${RELEASE_KEYSTORE_B64:-}" ]; then + echo "$RELEASE_KEYSTORE_B64" | base64 -d > app/release.keystore + cat > app/signing.properties <&2 + exit 1 + fi + - ./gradlew :app:assembleRelease -q + - cd "$CI_PROJECT_DIR" + - export GITLAB_TOKEN="$GITLAB_API_TOKEN" + - glab release create "v$VERSION" + --name "VaultDrop v$VERSION" + --notes-file CHANGELOG.md + "mobile-kotlin/app/build/outputs/apk/release/app-release.apk" + needs: ["docker"] + rules: + - if: $CI_COMMIT_TAG + +release-docker: + stage: release + image: docker:27 + services: + - name: docker:27-dind + alias: docker + variables: + DOCKER_HOST: tcp://docker:2375 + DOCKER_TLS_CERTDIR: "" + script: + - export VERSION=$(cat VERSION) + - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" "$CI_REGISTRY" + - docker pull "$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG" + - | + : "${DOCKERHUB_USER:?DOCKERHUB_USER manquant}" + : "${DOCKERHUB_TOKEN:?DOCKERHUB_TOKEN manquant}" + : "${DOCKERHUB_NAMESPACE:?DOCKERHUB_NAMESPACE manquant}" + echo "$DOCKERHUB_TOKEN" | docker login -u "$DOCKERHUB_USER" --password-stdin docker.io + IMAGE="$DOCKERHUB_NAMESPACE/vaultdrop" + docker tag "$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG" "$IMAGE:$CI_COMMIT_TAG" + docker tag "$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG" "$IMAGE:latest" + docker push "$IMAGE:$CI_COMMIT_TAG" + docker push "$IMAGE:latest" + needs: ["docker"] + rules: + - if: $CI_COMMIT_TAG \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3a65bf3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +Toutes les modifications notables de VaultDrop sont documentées ici. +Le format suit [Keep a Changelog](https://keepachangelog.com/fr/1.1.0/) et le versioning est [SemVer](https://semver.org/lang/fr/). + +## [Unreleased] + +### Ajouté +- Pipeline de release CI (GitLab) : lint, tests backend/mobile, build Docker, signature APK release, publication GitLab Release + Docker Hub. +- `backend/Dockerfile` multi-stage : image de production avec Tesseract (fra+eng) embarqué, user non-root, labels OCI. +- Service `backend` actif dans `docker-compose.yml` (déploiement conteneurisé). +- Signature release Android (`signing.properties` non commité, `assembleRelease`). +- Scripts `mise build:release`, `mise docker:build`, `mise release`. +- Licence AGPLv3, badge README, `CHANGELOG.md`. +- Versioning Android aligné sur le `VERSION` racine (versionCode dérivé). + +### Corrigé +- Docs : en-tête `docs/api-v1.md` (référence à l'ancien client Expo remplacée par le client Kotlin), quickstart et docker de la doc Starlight. +- `.gitignore` racine (uploads, binaires, keystore, artifacts). + +## [0.1.0] - 2026-09-15 + +Première version publique. + +### Ajouté +- Backend Go/Gin : auth user-first (paseto v4-local), devices, users (resolve, change password), CRUD fichiers/dossiers, upload multipart, recherche, sharing, sync outbox idempotente + snapshot permissions, OCR jobs (Tesseract), migrations Postgres testées. +- Client Android Kotlin : local-first Room (v7, migrations, DAO), SAF scanner deux passes, outbox transactionnel + worker WorkManager, recherche locale, génération PDF, scanner de documents, thumbnails, mode sombre, i18n FR/EN. +- Contrat API V1 consolidé (`docs/api-v1.md`), test de contrat de routes. +- Site de promotion public + documentation Starlight/Astro (FR/EN, versionnée). \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6ae9c0a --- /dev/null +++ b/LICENSE @@ -0,0 +1,655 @@ +GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they receive +widespread use, become available for other developers to incorporate. +Many developers of free software are heartened and encouraged by the +resulting cooperation. However, in the case of software used on +network servers, this result may fail to come about. The GNU General +Public License permits making a modified version and letting the public +access it on a server without ever releasing its source code to the +public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, carries the obligation to make the source +code freely available. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that transaction +who receives a copy of the work also receives whatever licenses to the +work the party's predecessors in interest had or could give under the +previous paragraph, plus a right to possession of the Corresponding +Source of the work from the predecessor in interest, if the predecessor +has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero +General Public License "or any later version" applies to it, you have +the option of following the terms and conditions either of that +numbered version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number +of the GNU Affero General Public License, you may choose any version +ever published by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that +proxy's public statement of acceptance of a version permanently +authorizes you to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT +LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES +SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE +WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN +ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + VaultDrop — personal document vault, local-first. + Copyright (C) 2026 Thirdshop + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/README.md b/README.md index 493d9f0..b73d0e1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # VaultDrop -VaultDrop est un coffre-fort de documents personnel, local-first. Le client Android镜映 le SAF dans une base Room et pousse les métadonnées de ses mutations via un outbox transactionnel vers le serveur Go/PostgreSQL — pas d'upload physique, pas de cloud-dépendance. +VaultDrop est un coffre-fort de documents personnel, local-first. Le client Android reflète le SAF dans une base Room et pousse les métadonnées de ses mutations via un outbox transactionnel vers le serveur Go/PostgreSQL — pas d'upload physique, pas de cloud-dépendance. + +[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](LICENSE) Disponible sur [thirdshop.fr](https://thirdshop.fr/en/applications/vault/) diff --git a/backend/.dockerignore b/backend/.dockerignore new file mode 100644 index 0000000..84e181b --- /dev/null +++ b/backend/.dockerignore @@ -0,0 +1,8 @@ +bin/ +uploads/* +!uploads/.gitkeep +.env +.git +*.md +.vscode/ +.idea/ \ No newline at end of file diff --git a/backend/Dockerfile b/backend/Dockerfile new file mode 100644 index 0000000..5f9598a --- /dev/null +++ b/backend/Dockerfile @@ -0,0 +1,59 @@ +# syntax=docker/dockerfile:1 + +ARG VERSION=dev +ARG BUILD_DATE=unknown + +# --- builder: compile statique du binaire Go (CGO off, musl) --- +FROM golang:1.26-alpine AS builder +ENV GOTOOLCHAIN=auto +WORKDIR /src +COPY go.mod go.sum ./ +RUN go mod download +COPY . . +ARG VERSION +RUN CGO_ENABLED=0 GOOS=linux go build \ + -trimpath \ + -ldflags "-s -w -X main.version=${VERSION}" \ + -o /out/vaultdrop-server \ + ./cmd/server/main.go + +# --- runtime: mince, Tesseract (fra+eng) embarqué pour l'OCR --- +FROM alpine:3.20 +RUN apk add --no-cache \ + ca-certificates \ + tzdata \ + tesseract-ocr \ + tesseract-ocr-data-eng \ + tesseract-ocr-data-fra + +WORKDIR /app + +ARG VERSION +ARG BUILD_DATE +LABEL org.opencontainers.image.title="vaultdrop-server" \ + org.opencontainers.image.description="VaultDrop backend API (Go/Gin + PostgreSQL) — local-first document vault" \ + org.opencontainers.image.version="${VERSION}" \ + org.opencontainers.image.licenses="AGPL-3.0-only" \ + org.opencontainers.image.source="https://gitlab.com/thirdshop-org/dot" \ + org.opencontainers.image.url="https://thirdshop.fr/en/applications/vault/" \ + org.opencontainers.image.created="${BUILD_DATE}" \ + org.opencontainers.image.revision="" + +COPY --from=builder /out/vaultdrop-server /usr/local/bin/vaultdrop-server + +# UPLOAD_DIR persistant, user non-root +RUN mkdir -p /app/uploads \ + && adduser -D -H -u 10001 vaultdrop \ + && chown vaultdrop:vaultdrop /app/uploads +VOLUME /app/uploads + +ENV PORT=8080 \ + UPLOAD_DIR=/app/uploads + +USER vaultdrop +EXPOSE 8080 + +HEALTHCHECK --interval=30s --timeout=3s --retries=3 \ + CMD wget -q -O - http://127.0.0.1:8080/api/v1/health || exit 1 + +ENTRYPOINT ["vaultdrop-server"] \ No newline at end of file diff --git a/backend/cmd/server/router_test.go b/backend/cmd/server/router_test.go index cf8d5fb..6266d2e 100644 --- a/backend/cmd/server/router_test.go +++ b/backend/cmd/server/router_test.go @@ -14,6 +14,7 @@ var expectedRoutes = []string{ "GET /api/v1/files", "GET /api/v1/files/:id", + "GET /api/v1/files/:id/ocr", "DELETE /api/v1/files/:id", "GET /api/v1/files/search", "GET /api/v1/files/folders", diff --git a/backend/db/migrations/000010_resources_ocr_text.down.sql b/backend/db/migrations/000010_resources_ocr_text.down.sql new file mode 100644 index 0000000..a6f895c --- /dev/null +++ b/backend/db/migrations/000010_resources_ocr_text.down.sql @@ -0,0 +1 @@ +ALTER TABLE resources DROP COLUMN ocr_text; \ No newline at end of file diff --git a/backend/db/migrations/000010_resources_ocr_text.up.sql b/backend/db/migrations/000010_resources_ocr_text.up.sql new file mode 100644 index 0000000..0a40092 --- /dev/null +++ b/backend/db/migrations/000010_resources_ocr_text.up.sql @@ -0,0 +1,5 @@ +-- Texte OCR porté sur la ressource (docs/api-v1.md §5) : le worker OCR écrit +-- l'extrait (`resources.ocr_text`, updated_at bumpé) pour qu'il soit +-- consultable par tous les devices du user ET par les grantees +-- (GET /files/:id/ocr, visibilité viewer+). +ALTER TABLE resources ADD COLUMN ocr_text TEXT; \ No newline at end of file diff --git a/backend/handlers/files.go b/backend/handlers/files.go index 96b8f7f..6dccd49 100644 --- a/backend/handlers/files.go +++ b/backend/handlers/files.go @@ -59,6 +59,29 @@ func FilesGet(c *gin.Context) { api.OK(c, file) } +// FilesGetOcr expose l'extrait OCR server-side d'un fichier visible (viewer+, +// own ou shared) : GET /files/:id/ocr. Réponse { text } ("" si pas encore +// extrait) + updatedAt. Permet à un second device de récupérer le texte déjà +// calculé sans re-téléverser les octets (cf. docs/api-v1.md §5). +func FilesGetOcr(c *gin.Context) { + if Store == nil { + api.Error(c, http.StatusServiceUnavailable, "SERVICE_UNAVAILABLE", "backend not initialized") + return + } + userID := c.GetString(UserIDKey) + id := c.Param("id") + if !deviceIDPattern.MatchString(id) { + api.Error(c, http.StatusNotFound, "NOT_FOUND", "file not found") + return + } + dto, err := Store.GetFileOcr(userID, id) + if err != nil { + writeError(c, err) + return + } + api.OK(c, dto) +} + func FilesDelete(c *gin.Context) { if Store == nil { api.Error(c, http.StatusServiceUnavailable, "SERVICE_UNAVAILABLE", "backend not initialized") diff --git a/backend/handlers/files_test.go b/backend/handlers/files_test.go index c24bd2e..24cef87 100644 --- a/backend/handlers/files_test.go +++ b/backend/handlers/files_test.go @@ -39,6 +39,11 @@ type fileDTO struct { CreatedAt string `json:"createdAt"` } +type fileOcrDTO struct { + Text string `json:"text"` + UpdatedAt string `json:"updatedAt"` +} + type apiError struct { Error struct { Code string `json:"code"` @@ -577,3 +582,54 @@ func TestFilesGetDeleteRejectInvalidID(t *testing.T) { rec, _ = doRequest(t, r, http.MethodGet, "/api/v1/files/"+fileID, otherToken, nil, "") expectError(t, rec, http.StatusNotFound, "NOT_FOUND", "get-cross-user") } + +func TestFilesGetOcrOwnerShareAndScoping(t *testing.T) { + r, _, repo := setup(t) + ownerDevice := repository.NewID() + ownerToken, owner := registerAndLogin(t, r, repo, testUserUsername(ownerDevice, "oc"), "ocr-get-test-password", ownerDevice) + granteeDevice := repository.NewID() + granteeToken, grantee := registerAndLogin(t, r, repo, testUserUsername(granteeDevice, "og"), "ocr-get-test-password-b", granteeDevice) + outsiderDevice := repository.NewID() + outsiderToken, _ := registerAndLogin(t, r, repo, testUserUsername(outsiderDevice, "oh"), "ocr-get-test-password-c", outsiderDevice) + + fileID := repository.NewID() + if err := repo.Resources.InsertFile(owner, fileID, "scan.png", "", 128, nil, nil); err != nil { + t.Fatalf("insert file: %v", err) + } + if err := repo.Resources.UpdateOcrText(owner, fileID, "extrait du scan"); err != nil { + t.Fatalf("write ocr_text: %v", err) + } + + // Owner : texte + updatedAt. + rec, _ := doRequest(t, r, http.MethodGet, "/api/v1/files/"+fileID+"/ocr", ownerToken, nil, "") + envOcr := expectOK(t, rec, "ocr-owner") + var ownerOcr fileOcrDTO + if err := json.Unmarshal(envOcr.Data, &ownerOcr); err != nil { + t.Fatalf("ocr-owner: unmarshal: %v", err) + } + if ownerOcr.Text != "extrait du scan" || ownerOcr.UpdatedAt == "" { + t.Errorf("ocr owner = %+v, attendu texte+updatedAt", ownerOcr) + } + + // Grantée viewer+ : même texte (partage rend l'OCR lisible). + if err := repo.Shares.Upsert(fileID, grantee, "viewer", false, nil, owner); err != nil { + t.Fatalf("share: %v", err) + } + rec, _ = doRequest(t, r, http.MethodGet, "/api/v1/files/"+fileID+"/ocr", granteeToken, nil, "") + envOcr = expectOK(t, rec, "ocr-grantee") + var granteeOcr fileOcrDTO + if err := json.Unmarshal(envOcr.Data, &granteeOcr); err != nil { + t.Fatalf("ocr-grantee: unmarshal: %v", err) + } + if granteeOcr.Text != "extrait du scan" { + t.Errorf("ocr grantee = %+v, attendu texte partagé", granteeOcr) + } + + // Outsider : invisible (404). + rec, _ = doRequest(t, r, http.MethodGet, "/api/v1/files/"+fileID+"/ocr", outsiderToken, nil, "") + expectError(t, rec, http.StatusNotFound, "NOT_FOUND", "ocr-outsider") + + // ID invalide → 404. + rec, _ = doRequest(t, r, http.MethodGet, "/api/v1/files/not-hex/ocr", ownerToken, nil, "") + expectError(t, rec, http.StatusNotFound, "NOT_FOUND", "ocr-invalid-id") +} diff --git a/backend/handlers/router.go b/backend/handlers/router.go index a775aac..6eb85aa 100644 --- a/backend/handlers/router.go +++ b/backend/handlers/router.go @@ -27,6 +27,7 @@ func RegisterRoutes(r *gin.Engine) { protected.GET("/files", FilesList) protected.GET("/files/search", FilesSearch) protected.GET("/files/:id", FilesGet) + protected.GET("/files/:id/ocr", FilesGetOcr) protected.DELETE("/files/:id", FilesDelete) protected.GET("/files/folders", FoldersList) protected.POST("/files/upload", FilesUpload) diff --git a/backend/repository/resources.go b/backend/repository/resources.go index 65e8a9a..2791715 100644 --- a/backend/repository/resources.go +++ b/backend/repository/resources.go @@ -41,6 +41,7 @@ type FileRow struct { FolderID string CreatedAt time.Time UpdatedAt time.Time + OcrText string } type FolderRow struct { @@ -156,11 +157,11 @@ func (r *Resources) InsertFolder(ownerID, id, name, parentResourceID string) err return r.insert(ownerID, id, name, parentResourceID, "folder", 0, nil, nil) } -const fileColumns = `resource_id, name, size_bytes, COALESCE(mime_type, ''), COALESCE(parent_id, ''), created_at, updated_at` +const fileColumns = `resource_id, name, size_bytes, COALESCE(mime_type, ''), COALESCE(parent_id, ''), created_at, updated_at, COALESCE(ocr_text, '')` func (r *Resources) scanFile(scan func(...any) error) (FileRow, error) { var row FileRow - err := scan(&row.ID, &row.Name, &row.Size, &row.MimeType, &row.FolderID, &row.CreatedAt, &row.UpdatedAt) + err := scan(&row.ID, &row.Name, &row.Size, &row.MimeType, &row.FolderID, &row.CreatedAt, &row.UpdatedAt, &row.OcrText) return row, err } @@ -471,6 +472,29 @@ func (r *Resources) UpdatePhysical(ownerID, resourceID string, size int64, mimeT return nil } +// UpdateOcrText writes the server-computed OCR extract onto the resource +// (owner-scoped, bumping updated_at so the change flows through the sync +// snapshot). The text is then readable by every device of the user AND by +// grantees via GET /files/:id/ocr (viewer+, cf. docs/api-v1.md §5). +func (r *Resources) UpdateOcrText(ownerID, resourceID, text string) error { + result, err := r.DB.Exec( + `UPDATE resources SET ocr_text = $3, updated_at = NOW() + WHERE resource_id = $1 AND user_id = $2 AND type = 'file' AND deleted_at IS NULL`, + resourceID, ownerID, text, + ) + if err != nil { + return err + } + affected, err := result.RowsAffected() + if err != nil { + return err + } + if affected == 0 { + return ErrNotFound + } + return nil +} + // SyncDelete soft-deletes a resource; absence is NOT an error (idempotent // terminal state for the outbox). func (r *Resources) SyncDelete(ownerID, resourceID string) error { diff --git a/backend/repository/resources_test.go b/backend/repository/resources_test.go index b1d6b76..d6a7359 100644 --- a/backend/repository/resources_test.go +++ b/backend/repository/resources_test.go @@ -232,3 +232,54 @@ func TestListOwnedDelta(t *testing.T) { t.Errorf("delta attendu uniquement fresh.txt, got %+v", delta) } } + +func TestUpdateOcrTextAndReadBack(t *testing.T) { + repo := newTestResources(t) + owner := NewID() + other := NewID() + mustInsertUser(t, repo, owner) + mustInsertUser(t, repo, other) + + fileID := NewID() + if err := repo.InsertFile(owner, fileID, "scan.png", "", 128, nil, nil); err != nil { + t.Fatalf("insert file: %v", err) + } + + // Vide par défaut. + before := time.Now() + row, err := repo.GetFile(owner, fileID) + if err != nil { + t.Fatalf("get file: %v", err) + } + if row.OcrText != "" { + t.Errorf("ocr_text initial = %q, attendu vide", row.OcrText) + } + + if err := repo.UpdateOcrText(owner, fileID, "extrait du scan"); err != nil { + t.Fatalf("update ocr_text: %v", err) + } + + // L'exécution bump updated_at (→ delta outbox/snapshot). + time.Sleep(5 * time.Millisecond) + after, err := repo.GetFile(owner, fileID) + if err != nil { + t.Fatalf("get file après : %v", err) + } + if after.OcrText != "extrait du scan" { + t.Errorf("ocr_text = %q, attendu %q", after.OcrText, "extrait du scan") + } + if !after.UpdatedAt.After(before) { + t.Errorf("updated_at non bumpé: before=%v after=%v", before, after.UpdatedAt) + } + if after.UpdatedAt.Before(time.Now().Add(-time.Minute)) { + t.Errorf("updated_at incohérent: %v", after.UpdatedAt) + } + + // Non-owner / ressource inconnue → ErrNotFound. + if err := repo.UpdateOcrText(other, fileID, "volé"); !errors.Is(err, ErrNotFound) { + t.Errorf("autre user : attendu ErrNotFound, got %v", err) + } + if err := repo.UpdateOcrText(owner, NewID(), "x"); !errors.Is(err, ErrNotFound) { + t.Errorf("inconnue : attendu ErrNotFound, got %v", err) + } +} diff --git a/backend/service/ocr.go b/backend/service/ocr.go index d394037..0477dde 100644 --- a/backend/service/ocr.go +++ b/backend/service/ocr.go @@ -127,6 +127,14 @@ func (o *Ocr) process(ctx context.Context, row repository.OcrJobRow) { return } _ = o.Repository.OcrJobs.Complete(row.DeviceID, row.ID, text) + // Le texte atterrit sur la ressource (updated_at bumpé) : consultable par + // tous les devices du user et les grantees via GET /files/:id/ocr. SILENCIEUX + // (hôte déjà supprimé ou lock d'écriture) : le job reste source d'historique. + if trimmed := strings.TrimSpace(text); trimmed != "" { + if err := o.Repository.Resources.UpdateOcrText(userID, row.FileID, trimmed); err != nil { + log.Printf("ocr: persiste ocr_text de %s: %v", row.FileID, err) + } + } } // physicalPath résout UPLOAD_DIR//. — l'ext est diff --git a/backend/service/ocr_test.go b/backend/service/ocr_test.go index 8879526..7c87b5b 100644 --- a/backend/service/ocr_test.go +++ b/backend/service/ocr_test.go @@ -110,6 +110,59 @@ func TestOcrJobFailsWhenPhysicalFileMissing(t *testing.T) { } } +func TestOcrJobPersistsTextOnResourceAndGrantsRead(t *testing.T) { + uploadDir := t.TempDir() + o, ownerID, deviceID, _ := newTestOcr(t, uploadDir, stubEngine{text: " extrait du scan "}) + granteeID := mustCreateUser(t, o.Repository, "ocr-grantee") + outsiderID := mustCreateUser(t, o.Repository, "ocr-outsider") + mustRegisterDevice(t, o.Repository, shareTestDeviceID) + + fileID := repository.NewID() + insertOcrFile(t, o, ownerID, fileID) + if err := os.MkdirAll(filepath.Join(uploadDir, ownerID), 0o755); err != nil { + t.Fatalf("mkdir: %v", err) + } + if err := os.WriteFile(filepath.Join(uploadDir, ownerID, fileID+".png"), []byte("img"), 0o644); err != nil { + t.Fatalf("write: %v", err) + } + + job, err := o.Create(ownerID, deviceID, fileID) + if err != nil { + t.Fatalf("create: %v", err) + } + row := waitTillTerminal(t, o, deviceID, job.ID) + if row.Status != "done" { + t.Fatalf("job %s: attendu done", row.Status) + } + + // Le texte (trimé) a atterri sur la ressource, lisible par l'owner. + s := NewResources(o.Repository, uploadDir, 100) + owned, err := s.GetFileOcr(ownerID, fileID) + if err != nil { + t.Fatalf("get ocr owner: %v", err) + } + if owned.Text != "extrait du scan" { + t.Errorf("ocr_text = %q, attendu %q", owned.Text, "extrait du scan") + } + + // ... et par un grantee viewer+ (docs §5 : partage rend le texte lisible). + if err := o.Repository.Shares.Upsert(fileID, granteeID, "viewer", false, nil, ownerID); err != nil { + t.Fatalf("share: %v", err) + } + shared, err := s.GetFileOcr(granteeID, fileID) + if err != nil { + t.Fatalf("get ocr grantee: %v", err) + } + if shared.Text != "extrait du scan" { + t.Errorf("ocr_text grantee = %q, attendu %q", shared.Text, "extrait du scan") + } + + // Un tiers n'y a pas accès. + if _, err := s.GetFileOcr(outsiderID, fileID); !errors.Is(err, repository.ErrNotFound) { + t.Errorf("tiers : attendu ErrNotFound, got %v", err) + } +} + func TestOcrJobFailsOnEngineError(t *testing.T) { uploadDir := t.TempDir() o, userID, deviceID, _ := newTestOcr(t, uploadDir, stubEngine{err: errors.New("tesseract boom")}) diff --git a/backend/service/resources.go b/backend/service/resources.go index 6dd6143..3f343a1 100644 --- a/backend/service/resources.go +++ b/backend/service/resources.go @@ -73,6 +73,26 @@ func (s *Resources) GetFile(ownerID, id string) (FileDTO, error) { return toFileDTO(row), nil } +// FileOcrDTO is the payload of GET /files/:id/ocr: the server-computed OCR +// extract of the resource, readable by its owner and by grantees (viewer+). +type FileOcrDTO struct { + Text string `json:"text"` + UpdatedAt string `json:"updatedAt,omitempty"` +} + +// GetFileOcr returns the OCR text of a file the user can see (viewer+, own or +// shared). Absent text → Text empty ("") with 200 (the caller decides). +func (s *Resources) GetFileOcr(ownerID, id string) (FileOcrDTO, error) { + row, err := s.Repo.GetFileVisible(ownerID, id) + if err != nil { + return FileOcrDTO{}, err + } + return FileOcrDTO{ + Text: row.OcrText, + UpdatedAt: row.UpdatedAt.UTC().Format(time.RFC3339), + }, nil +} + func (s *Resources) DeleteFile(ownerID, id string) (string, error) { return s.Repo.DeleteFile(ownerID, id) } diff --git a/docker-compose.yml b/docker-compose.yml index e77f6c4..1fe7651 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,47 +1,45 @@ services: - # paddleocr envisagé, non retenu — OCR via Tesseract (appel système), cf. docs/api-v1.md - # paddleocr: - # build: - # context: ./backend/ocr-server - # dockerfile: Dockerfile - # ports: - # - "9090:8080" - # environment: - # - OCR_LANG=fr - # restart: unless-stopped - postgres: image: postgres:17-alpine ports: - "5432:5432" environment: - POSTGRES_DB: vaultdrop_dev - POSTGRES_USER: vaultdrop - POSTGRES_PASSWORD: vaultdrop + POSTGRES_DB: ${POSTGRES_DB:-vaultdrop_dev} + POSTGRES_USER: ${POSTGRES_USER:-vaultdrop} + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-vaultdrop} volumes: - postgres-data:/var/lib/postgresql/data restart: unless-stopped healthcheck: - test: ["CMD-SHELL", "pg_isready -U vaultdrop"] + test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-vaultdrop}"] interval: 10s timeout: 5s retries: 5 - # backend: - # build: - # context: ./backend - # dockerfile: Dockerfile - # ports: - # - "8080:8080" - # environment: - # - PORT=8080 - # - DATABASE_URL=postgres://vaultdrop:vaultdrop@postgres:5432/vaultdrop_dev?sslmode=disable - # volumes: - # - ./backend/uploads:/app/uploads - # depends_on: - # postgres: - # condition: service_healthy - # restart: unless-stopped + backend: + build: + context: ./backend + dockerfile: Dockerfile + args: + VERSION: ${VERSION:-dev} + ports: + - "${PORT:-8080}:8080" + environment: + PORT: 8080 + DATABASE_URL: postgres://${POSTGRES_USER:-vaultdrop}:${POSTGRES_PASSWORD:-vaultdrop}@postgres:5432/${POSTGRES_DB:-vaultdrop_dev}?sslmode=disable + UPLOAD_DIR: /app/uploads + MAX_FILE_SIZE_MB: ${MAX_FILE_SIZE_MB:-50} + OCR_LANG: ${OCR_LANG:-fra+eng} + AUTH_SECRET: ${AUTH_SECRET:?AUTH_SECRET requis (voir backend/.env.example)} + ADMIN_USERNAME: ${ADMIN_USERNAME:?ADMIN_USERNAME requis au premier démarrage} + ADMIN_PASSWORD: ${ADMIN_PASSWORD:?ADMIN_PASSWORD requis au premier démarrage} + volumes: + - backend-uploads:/app/uploads + depends_on: + postgres: + condition: service_healthy + restart: unless-stopped volumes: - postgres-data: \ No newline at end of file + postgres-data: + backend-uploads: \ No newline at end of file diff --git a/docs/api-v1.md b/docs/api-v1.md index 317d2b3..fd8abc2 100644 --- a/docs/api-v1.md +++ b/docs/api-v1.md @@ -1,6 +1,6 @@ # VaultDrop — Contrat API V1 (autoritatif) -Status : **autoritatif**. Le client mobile est la source de vérité : `mobile/api/types.ts` + `mobile/api/client.ts` sont implémentés et testés ; le serveur Go doit les matcher exactement (méthode + path + enveloppe), il ne re-négocie pas. Document consolidé à partir de ces deux fichiers — toute divergence de ce doc doit être portée dans le client d'abord. +Status : **autoritatif**. Le client mobile Kotlin est la source de vérité : `data/remote/ApiService.kt` + `data/remote/dto/Dtos.kt` (contrat Retrofit/Moshi) sont implémentés ; le serveur Go doit les matcher exactement (méthode + path + enveloppe), il ne re-négocie pas. Document consolidé depuis le client — toute divergence de ce doc doit être portée dans le client d'abord. Références : `V2.md` (modèle cible), `mobile/services/db/` (conventions sync), `AGENTS.md` (structure + commandes). @@ -8,7 +8,7 @@ Références : `V2.md` (modèle cible), `mobile/services/db/` (conventions sync) ## 1. Base et transport -- Base URL serveur : schéma + host configurés côté client via `EXPO_PUBLIC_API_BASE_URL` (défaut `http://localhost:8080/api/v1`). +- Base URL serveur : configurable à l'exécution dans les Réglages de l'appli (défaut `http://10.0.2.2:8080/api/v1`). - JSON partout, sauf `POST /files/upload` (multipart). - Enveloppe succès : `{ "data": T, "meta"?: { "page": int, "pageSize": int, "total": int } }` (`meta` présent sur les listes paginées). - Erreur : `{ "error": { "code": string, "message": string } }` + statut HTTP adéquat. @@ -43,10 +43,11 @@ Références : `V2.md` (modèle cible), `mobile/services/db/` (conventions sync) | POST | `/files/upload` | multipart : `file` (uri/name/type), `folderId?` | `FileDto` | `FILE_TOO_LARGE` | | POST | `/ocr/jobs` | `{ "fileId": "…" }` | `OcrJob` | — | | GET | `/ocr/jobs/:id` | — | `OcrJob` | `NOT_FOUND` | +| GET | `/files/:id/ocr` | — | `FileOcr` (`{ text, updatedAt }`) | `NOT_FOUND` | | POST | `/sync/ops` | voir §6 | voir §6 | — | | GET | `/sync/permissions` | query `after?` (cached_at ms) | `ResourcePermission[]` | — | -> **Lecture partagée** : `GET /files`, `GET /files/:id`, `GET /files/search` et `GET /files/folders` couvrent les ressources **possédées ET partagées** (accès `viewer+`, §6.2). Le rename d'une ressource partagée passe par l'outbox `update_metadata` (nécessite `editor+`, §6.1). `DELETE /files/:id` reste owner-only. +> **Lecture partagée** : `GET /files`, `GET /files/:id`, `GET /files/search`, `GET /files/:id/ocr` et `GET /files/folders` couvrent les ressources **possédées ET partagées** (accès `viewer+`, §6.2). Le rename d'une ressource partagée passe par l'outbox `update_metadata` (nécessite `editor+`, §6.1). `DELETE /files/:id` reste owner-only. ### DTOs (copie conforme de `mobile/api/types.ts`) @@ -64,6 +65,7 @@ type FileDto = { type FolderDto = { id: string; name: string; parentId?: string | null }; type OcrJobStatus = 'queued' | 'processing' | 'done' | 'failed'; type OcrJob = { id: string; status: OcrJobStatus; text?: string | null; error?: string | null }; +type FileOcr = { text: string; updatedAt?: string | null }; ``` ## 4. Upload @@ -79,6 +81,8 @@ type OcrJob = { id: string; status: OcrJobStatus; text?: string | null; error?: - `GET /ocr/jobs/:id` → statut. Le mobile **poll toutes les 3s** jusqu'à `done`/`failed` (`hooks/useUpload.ts`). Cycle : `queued → processing → done | failed` ; `done` renvoie `text`, `failed` renvoie `error`. - Moteur : **Tesseract en appel système** (`ocr/tesseract.go`), langue `OCR_LANG` (défaut `fra+eng`). Les images sont passées directement à `tesseract` ; les **PDF** subissent une extraction du calque texte (`ledongthuc/pdf`, déjà en go.mod) — un PDF scanné produit un texte vide plutôt qu'un rendu/OCR (hors scope V1). - `fileId` inconnu/pas du user → `NOT_FOUND`. Fichier physique introuvable (ex. suppression manuelle sous `UPLOAD_DIR`) → job `failed` `"file not readable"`. Le job est créé par le device courant (`ocr_jobs.device_id`) mais la validation de la ressource est scopée par le **user**. +- **Le texte atterrit sur la ressource** : à la complétion (`done` avec texte non vide), le worker écrit l'extrait trimé dans `resources.ocr_text` (et **bump `updated_at`**, d'où une injection dans le delta outbox/snapshot). `ocr_jobs.text` reste l'historique du job. +- **`GET /files/:id/ocr`** → `FileOcr { text, updatedAt }` : l'extrait server-side du fichier, lisible par le **possédant ET les grantees** (`viewer+`, même portée que `GET /files/:id` ; `text` `""` si pas encore extrait). Un **second device** rapatrie ainsi le texte d'un OCR fait par un autre device (ou par la ressource partagée) **sans re-téléverser les octets ni re-soumettre de job** — le client Kotlin le fait en tête de `OcrRepository.syncFromServer`/`processAuto` et du viewer (`OcrViewModel`). ## 6. Contrat de sync (outbox + snapshot) diff --git a/mise.toml b/mise.toml index ad618be..9679ba6 100644 --- a/mise.toml +++ b/mise.toml @@ -51,4 +51,46 @@ run = ''' set -euo pipefail cd backend && staticcheck ./... cd ../mobile-kotlin && ./gradlew :app:lint -q +''' + +[tasks.build:release] +description = "Build signed release APK (assembleRelease)" +dir = "mobile-kotlin" +run = ''' +#!/usr/bin/env bash +set -euo pipefail +if [ ! -f app/signing.properties ] && [ -z "${SIGNING_STORE_FILE:-}" ]; then + echo "signing.properties absent — copiez app/signing.properties.example et" + echo "préparez un keystore, ou fournissez SIGNING_STORE_FILE (CI)." >&2 + exit 1 +fi +./gradlew :app:assembleRelease -q +echo "APK : app/build/outputs/apk/release/app-release.apk" +''' + +[tasks.docker:build] +description = "Build the backend Docker image (tagged with VERSION)" +run = ''' +set -euo pipefail +VERSION=$(cat VERSION) +docker build \\ + --build-arg VERSION="$VERSION" \\ + --build-arg BUILD_DATE="$(date -u +%Y-%m-%dT%H:%M:%SZ)" \\ + -t vaultdrop-server:"$VERSION" \\ + ./backend +echo "Image : vaultdrop-server:$VERSION" +''' + +[tasks.release] +description = "Local release checklist: test, build artifacts, tag, push" +run = ''' +set -euo pipefail +VERSION=$(cat VERSION) +echo ">>> Version : $VERSION (tag cible v$VERSION)" +mise run test +mise run build +mise run docker:build +echo +echo "Prêt à tagger ? La CI GitLab construira la release finale à partir du tag." +echo " git tag v$VERSION && git push origin v$VERSION" ''' \ No newline at end of file diff --git a/mobile-kotlin/app/build.gradle.kts b/mobile-kotlin/app/build.gradle.kts index ca88392..cb5fade 100644 --- a/mobile-kotlin/app/build.gradle.kts +++ b/mobile-kotlin/app/build.gradle.kts @@ -8,6 +8,21 @@ plugins { alias(libs.plugins.hilt) } +// Source unique de vérité : VERSION à la racine du dépôt (ex. 0.1.0). +val vaultVersion: String = rootProject.file("../VERSION").readText().trim() +val vaultVersionCode: Int = run { + val parts = vaultVersion.split('.').map { it.toInt() } + check(parts.size == 3) { "VERSION doit être major.minor.patch, reçu: $vaultVersion" } + parts[0] * 1_000_000 + parts[1] * 1_000 + parts[2] +} + +// Signature release : signing.properties (gitignoré) en local, variables +// d'env (SIGNING_*) en CI. Jamais de keystore commité. +val signingProps = Properties().apply { + val f = file("signing.properties") + if (f.exists()) f.inputStream().use { load(it) } +} + android { namespace = "com.vaultdrop.mobile" compileSdk = 35 @@ -19,8 +34,8 @@ android { // OpenCV/CameraX sont en 4K (warning de compatibilité sur devices // 16K-pages). On reste en 34 tant qu'elles ne sont pas mises à jour. targetSdk = 34 - versionCode = 1 - versionName = "0.1.0" + versionCode = vaultVersionCode + versionName = vaultVersion // OpenCV natif : on conserve uniquement les ABIs ciblés // (arm64 = devices, x86_64 = émulateur) pour garder l'APK raisonnable. @@ -29,6 +44,18 @@ android { } } + signingConfigs { + create("release") { + val storePath = signingProps.getProperty("storeFile") ?: System.getenv("SIGNING_STORE_FILE") + if (storePath != null) { + storeFile = file(storePath) + storePassword = signingProps.getProperty("storePassword") ?: System.getenv("SIGNING_STORE_PASSWORD") + keyAlias = signingProps.getProperty("keyAlias") ?: System.getenv("SIGNING_KEY_ALIAS") + keyPassword = signingProps.getProperty("keyPassword") ?: System.getenv("SIGNING_KEY_PASSWORD") + } + } + } + buildTypes { release { isMinifyEnabled = false @@ -36,6 +63,7 @@ android { getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro", ) + signingConfig = signingConfigs.getByName("release") } } compileOptions { diff --git a/mobile-kotlin/app/signing.properties.example b/mobile-kotlin/app/signing.properties.example new file mode 100644 index 0000000..52bd023 --- /dev/null +++ b/mobile-kotlin/app/signing.properties.example @@ -0,0 +1,14 @@ +# Signature release Android — copier vers signing.properties (jamais commité) +# Alternative CI : mêmes valeurs via les variables d'environnement SIGNING_*. +# +# 1. Générer un keystore (ne jamais le committer, garder en lieu sûr) : +# keytool -genkey -v -keystore release.keystore -alias vaultdrop \ +# -keyalg RSA -keysize 2048 -validity 10000 +# 2. Renseigner les valeurs ci-dessous. +# +# storeFile est relatif au répertoire du module app/ (mobile-kotlin/app). + +storeFile=release.keystore +storePassword=CHANGE_ME +keyAlias=vaultdrop +keyPassword=CHANGE_ME \ No newline at end of file diff --git a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiClient.kt b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiClient.kt index 58a1e48..4a6b672 100644 --- a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiClient.kt +++ b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiClient.kt @@ -6,6 +6,7 @@ import com.vaultdrop.mobile.data.remote.dto.ApiEnvelope import com.vaultdrop.mobile.data.remote.dto.ApiErrorEnvelope import com.vaultdrop.mobile.data.remote.dto.DeviceRegistrationDto import com.vaultdrop.mobile.data.remote.dto.FileDto +import com.vaultdrop.mobile.data.remote.dto.FileOcrDto import com.vaultdrop.mobile.data.remote.dto.FolderDto import com.vaultdrop.mobile.data.remote.dto.LoginRequestDto import com.vaultdrop.mobile.data.remote.dto.LoginResponseDto @@ -105,6 +106,10 @@ class ApiClient @Inject constructor( suspend fun getOcrJob(jobId: String): OcrJobDto = unwrap({ apiService.getOcrJob(jobId) }) + /** Extrait OCR server-side d'un fichier visible (viewer+, own ou shared). */ + suspend fun getFileOcr(fileId: String): FileOcrDto = + unwrap({ apiService.getFileOcr(fileId) }) + private suspend fun unwrap( call: suspend () -> Response>, skipUnauthorizedHandling: Boolean = false, diff --git a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiService.kt b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiService.kt index 028492c..bafc9a3 100644 --- a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiService.kt +++ b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/ApiService.kt @@ -3,6 +3,7 @@ package com.vaultdrop.mobile.data.remote import com.vaultdrop.mobile.data.remote.dto.ApiEnvelope import com.vaultdrop.mobile.data.remote.dto.DeviceRegistrationDto import com.vaultdrop.mobile.data.remote.dto.FileDto +import com.vaultdrop.mobile.data.remote.dto.FileOcrDto import com.vaultdrop.mobile.data.remote.dto.FolderDto import com.vaultdrop.mobile.data.remote.dto.LoginRequestDto import com.vaultdrop.mobile.data.remote.dto.LoginResponseDto @@ -96,4 +97,14 @@ interface ApiService { suspend fun getOcrJob( @Path("id") jobId: String, ): Response> + + /** + * Extrait OCR déjà calculé côté serveur pour un fichier visible (viewer+, + * own ou shared). Permet à un second device de récupérer le texte sans + * re-téléverser les octets (docs/api-v1.md §5). + */ + @GET("files/{id}/ocr") + suspend fun getFileOcr( + @Path("id") fileId: String, + ): Response> } \ No newline at end of file diff --git a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/dto/Dtos.kt b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/dto/Dtos.kt index d0a672a..ff77b3d 100644 --- a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/dto/Dtos.kt +++ b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/remote/dto/Dtos.kt @@ -152,4 +152,14 @@ data class OcrJobDto( /** Requête `POST /ocr/jobs` — `{ "fileId": "…32-hex" }` (docs/api-v1.md §5). */ data class OcrSubmitDto( @Json(name = "fileId") val fileId: String, +) + +/** + * Réponse `GET /files/{id}/ocr` — extrait OCR server-side du fichier, + * consultable par le user et les grantees (viewer+). `text` "" tant que + * l'OCR n'a pas encore atterri sur la ressource (docs/api-v1.md §5). + */ +data class FileOcrDto( + @Json(name = "text") val text: String, + @Json(name = "updatedAt") val updatedAt: String? = null, ) \ No newline at end of file diff --git a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/repository/OcrRepository.kt b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/repository/OcrRepository.kt index 4188398..83bc31f 100644 --- a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/repository/OcrRepository.kt +++ b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/data/repository/OcrRepository.kt @@ -26,6 +26,8 @@ import javax.inject.Singleton * * Séquence pour un fichier SAF `processed` + `local-cloud` (resource_id déjà * connu du serveur via l'outbox `create_resource`) : + * 0. [syncFromServer] — si un autre device a déjà OCRisé le fichier, le texte + * est rapatrié via `GET /files/:id/ocr` (viewer+) **sans** upload ni job ; * 1. [ensurePhysical] — upload multipart **ciblé** (`resourceId`) des octets * locaux : pipeline séparé, hors outbox, qui écrit * `UPLOAD_DIR//.` — sans lequel le job OCR @@ -75,6 +77,20 @@ class OcrRepository @Inject constructor( fileDao.updateOcrText(resourceId, text?.takeIf { it.isNotBlank() }, System.currentTimeMillis()) } + /** + * Rapatrie l'extrait OCR déjà calculé côté serveur pour un fichier visible + * (viewer+, own ou shared). Renvoie le texte persisté en Room, ou null si le + * serveur n'a pas encore d'extrait — un second device récupère ainsi le + * résultat d'un OCR fait par un autre device, **sans re-téléverser les + * octets ni re-soumettre un job** (docs/api-v1.md §5, GET /files/:id/ocr). + */ + suspend fun syncFromServer(file: FileEntity): String? { + val dto = apiClient.getFileOcr(file.resourceId) + if (dto.text.isBlank()) return null + saveResult(file.resourceId, dto.text) + return dto.text + } + /** * OCR auto d'un fichier (un seul à la fois) : marqueur « en cours », upload * multipart ciblé, soumission du job serveur, poll jusqu'au terminal puis @@ -86,6 +102,12 @@ class OcrRepository @Inject constructor( val now = System.currentTimeMillis() fileDao.markOcrQueued(file.resourceId, now, now) return try { + // 0. Un autre device a peut-être déjà OCRisé le fichier : si le + // serveur a le texte, on le rapatrie sans upload ni job. + if (syncFromServer(file) != null) { + fileDao.clearOcrQueued(file.resourceId, System.currentTimeMillis()) + return OcrAutoOutcome.Done + } ensurePhysical(file) val jobId = submit(file.resourceId) val final = poll(jobId) diff --git a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/features/ocr/OcrViewModel.kt b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/features/ocr/OcrViewModel.kt index 12f92a1..f1f98fc 100644 --- a/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/features/ocr/OcrViewModel.kt +++ b/mobile-kotlin/app/src/main/java/com/vaultdrop/mobile/features/ocr/OcrViewModel.kt @@ -77,6 +77,21 @@ class OcrViewModel @Inject constructor( _uiState.value = OcrUiState(resourceId = file.resourceId, uploading = true) activeJob = viewModelScope.launch { try { + // Un autre device a peut-être déjà OCRisé ce document : le + // serveur a le texte (GET /files/:id/ocr) → on l'affiche sans + // re-téléverser les octets ni re-soumettre un job (docs §5). + val synced = ocrRepository.syncFromServer(file) + if (synced != null) { + _uiState.update { + it.copy( + resourceId = file.resourceId, + uploading = false, + status = OcrJobStatus.DONE, + text = synced, + ) + } + return@launch + } ocrRepository.ensurePhysical(file) val jobId = ocrRepository.submit(file.resourceId) val final = ocrRepository.poll(jobId) { job -> diff --git a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/FolderMergeDataTest.kt b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/FolderMergeDataTest.kt index 3882302..c759cd8 100644 --- a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/FolderMergeDataTest.kt +++ b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/FolderMergeDataTest.kt @@ -17,6 +17,7 @@ import com.vaultdrop.mobile.data.remote.ApiService import com.vaultdrop.mobile.data.remote.dto.ApiEnvelope import com.vaultdrop.mobile.data.remote.dto.DeviceRegistrationDto import com.vaultdrop.mobile.data.remote.dto.FileDto +import com.vaultdrop.mobile.data.remote.dto.FileOcrDto import com.vaultdrop.mobile.data.remote.dto.FolderDto import com.vaultdrop.mobile.data.remote.dto.LoginRequestDto import com.vaultdrop.mobile.data.remote.dto.LoginResponseDto @@ -224,4 +225,8 @@ private class FolderMergeApiService : ApiService { override suspend fun getOcrJob( jobId: String, ): Response> = Response.success(ApiEnvelope()) + + override suspend fun getFileOcr( + fileId: String, + ): Response> = Response.success(ApiEnvelope(data = FileOcrDto(text = ""))) } \ No newline at end of file diff --git a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/MoveProtectionTest.kt b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/MoveProtectionTest.kt index 1fd3858..26f5ebb 100644 --- a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/MoveProtectionTest.kt +++ b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/MoveProtectionTest.kt @@ -18,6 +18,7 @@ import com.vaultdrop.mobile.data.remote.ApiService import com.vaultdrop.mobile.data.remote.dto.ApiEnvelope import com.vaultdrop.mobile.data.remote.dto.DeviceRegistrationDto import com.vaultdrop.mobile.data.remote.dto.FileDto +import com.vaultdrop.mobile.data.remote.dto.FileOcrDto import com.vaultdrop.mobile.data.remote.dto.FolderDto import com.vaultdrop.mobile.data.remote.dto.LoginRequestDto import com.vaultdrop.mobile.data.remote.dto.LoginResponseDto @@ -311,4 +312,8 @@ private class MoveProtectionApiService : ApiService { override suspend fun getOcrJob( jobId: String, ): Response> = Response.success(ApiEnvelope()) + + override suspend fun getFileOcr( + fileId: String, + ): Response> = Response.success(ApiEnvelope(data = FileOcrDto(text = ""))) } \ No newline at end of file diff --git a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/OcrRepositoryTest.kt b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/OcrRepositoryTest.kt index 580dc7a..98de647 100644 --- a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/OcrRepositoryTest.kt +++ b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/OcrRepositoryTest.kt @@ -15,6 +15,7 @@ import com.vaultdrop.mobile.data.remote.ApiService import com.vaultdrop.mobile.data.remote.dto.ApiEnvelope import com.vaultdrop.mobile.data.remote.dto.DeviceRegistrationDto import com.vaultdrop.mobile.data.remote.dto.FileDto +import com.vaultdrop.mobile.data.remote.dto.FileOcrDto import com.vaultdrop.mobile.data.remote.dto.FolderDto import com.vaultdrop.mobile.data.remote.dto.LoginRequestDto import com.vaultdrop.mobile.data.remote.dto.LoginResponseDto @@ -220,6 +221,43 @@ class OcrRepositoryTest { assertNull(stored?.ocrQueuedAt) assertNull(stored?.ocrText) } + + @Test + fun `syncFromServer_persiste_le_texte_deja_calcule_coté_serveur`() = runTest { + val file = insertFile("content://ocr/synced.txt") + apiService.fileOcr = FileOcrDto(text = "texte d'un autre device", updatedAt = "2026-01-01T00:00:00Z") + + val text = repository.syncFromServer(file) + + assertEquals("texte d'un autre device", text) + assertEquals("texte d'un autre device", fileDao.getByResourceId(file.resourceId)?.ocrText) + assertEquals(1, apiService.getFileOcrCalls) + } + + @Test + fun `syncFromServer_retourne_null_quand_le_serveur_na_pas_d_extrait`() = runTest { + val file = insertFile("content://ocr/no-ocr.txt") + apiService.fileOcr = FileOcrDto(text = "") + + val text = repository.syncFromServer(file) + + assertNull(text) + assertNull(fileDao.getByResourceId(file.resourceId)?.ocrText) + } + + @Test + fun `processAuto_reutilise_le_texte_serveur_sans_upload_ni_job`() = runTest { + val file = insertFile("content://ocr/reuse.txt") + apiService.fileOcr = FileOcrDto(text = "déjà extrait ailleurs") + apiService.jobSequence = emptyList() + + val outcome = repository.processAuto(file) + + assertTrue(outcome is OcrAutoOutcome.Done) + assertTrue(apiService.uploadedFiles.isEmpty()) + assertEquals("déjà extrait ailleurs", fileDao.getByResourceId(file.resourceId)?.ocrText) + assertNull(fileDao.getByResourceId(file.resourceId)?.ocrQueuedAt) + } } /** @@ -230,6 +268,8 @@ private class OcrApiServiceFake : ApiService { var uploadedFiles: MutableList> = mutableListOf() var uploadedBytes: String? = null var jobSequence: List = emptyList() + var fileOcr: FileOcrDto = FileOcrDto(text = "") + var getFileOcrCalls = 0 private var getCalls = 0 override suspend fun listFolders(): Response>> = @@ -289,6 +329,13 @@ private class OcrApiServiceFake : ApiService { return Response.success(ApiEnvelope(data = job)) } + override suspend fun getFileOcr( + fileId: String, + ): Response> { + getFileOcrCalls++ + return Response.success(ApiEnvelope(data = fileOcr)) + } + private fun readBody(body: RequestBody): String { val buffer = okio.Buffer() body.writeTo(buffer) diff --git a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/ShareRepositoryTest.kt b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/ShareRepositoryTest.kt index 7ae115a..164f2e1 100644 --- a/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/ShareRepositoryTest.kt +++ b/mobile-kotlin/app/src/test/java/com/vaultdrop/mobile/data/repository/ShareRepositoryTest.kt @@ -17,6 +17,7 @@ import com.vaultdrop.mobile.data.remote.ApiService import com.vaultdrop.mobile.data.remote.dto.ApiEnvelope import com.vaultdrop.mobile.data.remote.dto.DeviceRegistrationDto import com.vaultdrop.mobile.data.remote.dto.FileDto +import com.vaultdrop.mobile.data.remote.dto.FileOcrDto import com.vaultdrop.mobile.data.remote.dto.FolderDto import com.vaultdrop.mobile.data.remote.dto.LoginRequestDto import com.vaultdrop.mobile.data.remote.dto.LoginResponseDto @@ -268,4 +269,8 @@ private class FakeApiService : ApiService { override suspend fun getOcrJob( jobId: String, ): Response> = Response.success(ApiEnvelope()) + + override suspend fun getFileOcr( + fileId: String, + ): Response> = Response.success(ApiEnvelope(data = FileOcrDto(text = ""))) } \ No newline at end of file