From 4f6698e39f08b4a26ae0ba54660faffd176a9f5e Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 29 Sep 2023 22:40:10 -0700 Subject: [PATCH 1/4] Update mkdocs.yml --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 1e692d68b..29e997a27 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,7 @@ theme: repo: fontawesome/brands/github favicon: assets/favicon.png repo_url: https://github.com/paperless-ngx/paperless-ngx +repo_name: paperless-ngx/paperless-ngx edit_uri: blob/main/docs/ extra_css: - assets/extra.css From 226c771735571d4c59b465c36fccc1c683703b90 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 9 Oct 2023 19:53:23 -0700 Subject: [PATCH 2/4] Add AI note --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65220af25..cc268c6ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,6 +58,13 @@ Our community review process for `non-trivial` PRs is the following: This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler. +# AI-Generated Code + +This project does not specifically prohibit the use of AI-generated code _during the process_ of creating a PR, however: + +1. Any code present in the final PR that was generated using AI sources should be clearly attributed as such and must not violate copyright protections. +2. We will not accept PRs that are entirely or mostly AI-derived. + # Translating Paperless-ngx Some notes about translation: From e4054d684c1b635f3ba2235410acb3aec9a16d24 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 13 Oct 2023 09:16:17 -0700 Subject: [PATCH 3/4] Fix: correct set owner API location in docs, additional test (#4366) * Fix location of owner in API documentation * Add additional test for setting another owner --- docs/api.md | 25 +++++++++--------- src/documents/tests/test_api.py | 45 +++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 12 deletions(-) diff --git a/docs/api.md b/docs/api.md index df86ef1e5..c7377760d 100644 --- a/docs/api.md +++ b/docs/api.md @@ -272,19 +272,20 @@ consumption including the ID of a created document if consumption succeeded. ## Permissions All objects (documents, tags, etc.) allow setting object-level permissions -with an optional `set_permissions` parameter which is of the form: +with optional `owner` and / or a `set_permissions` parameters which are of +the form: ``` -{ - "owner": user_id, - "view": { - "users": [...], - "groups": [...], - }, - "change": { - "users": [...], - "groups": [...], - }, +"owner": ..., +"set_permissions": { + "view": { + "users": [...], + "groups": [...], + }, + "change": { + "users": [...], + "groups": [...], + }, } ``` @@ -292,7 +293,7 @@ with an optional `set_permissions` parameter which is of the form: Arrays should contain user or group ID numbers. -If this parameter is supplied the object's permissions will be overwritten, +If these parameters are supplied the object's permissions will be overwritten, assuming the authenticated user has permission to do so (the user must be the object owner or a superuser). diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index 88180d4d8..e2445bb26 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -4154,6 +4154,51 @@ class TestApiAuth(DirectoriesMixin, APITestCase): self.assertEqual(checker.has_perm("view_tag", tag1), True) self.assertIn("view_tag", get_perms(group1, tag1)) + def test_api_set_other_owner_w_permissions(self): + """ + GIVEN: + - API request to create an object (Tag) + WHEN: + - a different owner than is logged in is set + - view > groups is set + THEN: + - Object permissions are set appropriately + """ + user1 = User.objects.create_superuser(username="user1") + user2 = User.objects.create(username="user2") + group1 = Group.objects.create(name="group1") + + self.client.force_authenticate(user1) + + response = self.client.post( + "/api/tags/", + json.dumps( + { + "name": "test1", + "matching_algorithm": MatchingModel.MATCH_AUTO, + "owner": user2.id, + "set_permissions": { + "view": { + "users": None, + "groups": [group1.id], + }, + "change": { + "users": None, + "groups": None, + }, + }, + }, + ), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_201_CREATED) + + tag1 = Tag.objects.filter(name="test1").first() + + self.assertEqual(tag1.owner, user2) + self.assertIn("view_tag", get_perms(group1, tag1)) + def test_api_set_doc_permissions(self): """ GIVEN: From 5b83bd03f5adb409a1c1bebf218b38a9748b87a2 Mon Sep 17 00:00:00 2001 From: Rock Date: Thu, 9 Nov 2023 15:20:27 +0100 Subject: [PATCH 4/4] Documentation: clarify document_exporter includes settings (#4533) --- docs/administration.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/administration.md b/docs/administration.md index 7be462068..5b5ca2ff6 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -10,8 +10,8 @@ Before making backups, make sure that paperless is not running. Options available to any installation of paperless: - Use the [document exporter](#exporter). The document exporter exports all your documents, - thumbnails and metadata to a specific folder. You may import your - documents into a fresh instance of paperless again or store your + thumbnails, metadata, and database contents to a specific folder. You may import your + documents and settings into a fresh instance of paperless again or store your documents in another DMS with this export. - The document exporter is also able to update an already existing export. Therefore, incremental backups with `rsync` are entirely @@ -239,8 +239,9 @@ with the argument `--help`. ### Document exporter {#exporter} -The document exporter exports all your data from paperless into a folder -for backup or migration to another DMS. +The document exporter exports all your data (including your settings +and database contents) from paperless into a folder for backup or +migration to another DMS. If you use the document exporter within a cronjob to backup your data you might use the `-T` flag behind exec to suppress "The input device