paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2026-01-30 23:08:59 -06:00
Code Issues Packages Projects Releases Wiki Activity

Backend to JSONField

Browse Source
This commit is contained in:
shamoon
2026-01-29 08:45:13 -08:00
parent 72df7fb1ee
commit 8cf6d9fa3c
4 changed files with 55 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/documents/migrations/0009_workflowaction_passwords_alter_workflowaction_type.py
View File

@@ -13,7 +13,7 @@ class Migration(migrations.Migration):
migrations.AddField( migrations.AddField(
model_name="workflowaction", model_name="workflowaction",
name="passwords", name="passwords",
field=models.TextField( field=models.JSONField(
blank=True, blank=True,
help_text="Passwords to try when removing PDF protection. Separate with commas or new lines.", help_text="Passwords to try when removing PDF protection. Separate with commas or new lines.",
null=True, null=True,

2
src/documents/models.py
View File

@@ -1638,7 +1638,7 @@ class WorkflowAction(models.Model):
verbose_name=_("webhook"), verbose_name=_("webhook"),
) )
passwords = models.TextField( passwords = models.JSONField(
_("passwords"), _("passwords"),
null=True, null=True,
blank=True, blank=True,

13
src/documents/serialisers.py
View File

@@ -2675,11 +2675,14 @@ class WorkflowActionSerializer(serializers.ModelSerializer):
and attrs["type"] == WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL and attrs["type"] == WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL
): ):
passwords = attrs.get("passwords") passwords = attrs.get("passwords")
if passwords is None or not isinstance(passwords, str): # ensure passwords is a non-empty list of non-empty strings
raise serializers.ValidationError( if (
"Passwords are required for password removal actions", passwords is None
) or not isinstance(passwords, list)
if not passwords.strip(): or len(passwords) == 0
or any(not isinstance(pw, str) for pw in passwords)
or any(len(pw.strip()) == 0 for pw in passwords)
):
raise serializers.ValidationError( raise serializers.ValidationError(
"Passwords are required for password removal actions", "Passwords are required for password removal actions",
) )

54
src/documents/tests/test_api_workflows.py
View File

@@ -848,13 +848,16 @@ class TestApiWorkflows(DirectoriesMixin, APITestCase):
THEN: THEN:
- The passwords field is correctly stored and retrieved - The passwords field is correctly stored and retrieved
""" """
passwords = "password1,password2\npassword3" passwords = ["password1", "password2", "password3"]
response = self.client.post( response = self.client.post(
"/api/workflow_actions/", "/api/workflow_actions/",
{ json.dumps(
"type": WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL, {
"passwords": passwords, "type": WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL,
}, "passwords": passwords,
},
),
content_type="application/json",
) )
self.assertEqual(response.status_code, status.HTTP_201_CREATED) self.assertEqual(response.status_code, status.HTTP_201_CREATED)
self.assertEqual(response.data["passwords"], passwords) self.assertEqual(response.data["passwords"], passwords)
@@ -882,10 +885,43 @@ class TestApiWorkflows(DirectoriesMixin, APITestCase):
) )
response = self.client.post( response = self.client.post(
"/api/workflow_actions/", "/api/workflow_actions/",
{ json.dumps(
"type": WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL, {
"passwords": "", "type": WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL,
}, "passwords": "",
},
),
content_type="application/json",
)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
self.assertIn(
"Passwords are required",
str(response.data["non_field_errors"][0]),
)
response = self.client.post(
"/api/workflow_actions/",
json.dumps(
{
"type": WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL,
"passwords": [],
},
),
content_type="application/json",
)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
self.assertIn(
"Passwords are required",
str(response.data["non_field_errors"][0]),
)
response = self.client.post(
"/api/workflow_actions/",
json.dumps(
{
"type": WorkflowAction.WorkflowActionType.PASSWORD_REMOVAL,
"passwords": ["", "password2"],
},
),
content_type="application/json",
) )
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
self.assertIn( self.assertIn(