diff --git a/docs/index.rst b/docs/index.rst index 715fef588..735804560 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,7 +44,7 @@ resources in the documentation: learn about how paperless automates all tagging using machine learning. * Paperless now comes with a :ref:`proper email consumer ` that's fully tested and production ready. -* Paperless creates searchable PDF/A documents from whatever you you put into +* Paperless creates searchable PDF/A documents from whatever you put into the consumption directory. This means that you can select text in image-only documents coming from your scanner. * See :ref:`this note ` about GnuPG encryption in diff --git a/src-ui/cypress/e2e/documents/document-detail.cy.ts b/src-ui/cypress/e2e/documents/document-detail.cy.ts index cc269655a..a836ffa92 100644 --- a/src-ui/cypress/e2e/documents/document-detail.cy.ts +++ b/src-ui/cypress/e2e/documents/document-detail.cy.ts @@ -17,6 +17,32 @@ describe('document-detail', () => { req.reply({ result: 'OK' }) }).as('saveDoc') + cy.fixture('documents/1/comments.json').then((commentsJson) => { + cy.intercept( + 'GET', + 'http://localhost:8000/api/documents/1/comments/', + (req) => { + req.reply(commentsJson.filter((c) => c.id != 10)) // 3 + } + ) + + cy.intercept( + 'DELETE', + 'http://localhost:8000/api/documents/1/comments/?id=9', + (req) => { + req.reply(commentsJson.filter((c) => c.id != 9 && c.id != 10)) // 2 + } + ) + + cy.intercept( + 'POST', + 'http://localhost:8000/api/documents/1/comments/', + (req) => { + req.reply(commentsJson) // 4 + } + ) + }) + cy.viewport(1024, 1024) cy.visit('/documents/1/') }) @@ -39,4 +65,30 @@ describe('document-detail', () => { cy.contains('button', 'Save').click().wait('@saveDoc').wait(2000) // navigates away after saving cy.contains('You have unsaved changes').should('not.exist') }) + + it('should show a list of comments', () => { + cy.wait(1000).get('a').contains('Comments').click().wait(1000) + cy.get('app-document-comments').find('.card').its('length').should('eq', 3) + }) + + it('should support comment deletion', () => { + cy.wait(1000).get('a').contains('Comments').click().wait(1000) + cy.get('app-document-comments') + .find('.card') + .first() + .find('button') + .click({ force: true }) + .wait(500) + cy.get('app-document-comments').find('.card').its('length').should('eq', 2) + }) + + it('should support comment insertion', () => { + cy.wait(1000).get('a').contains('Comments').click().wait(1000) + cy.get('app-document-comments') + .find('form textarea') + .type('Testing new comment') + .wait(500) + cy.get('app-document-comments').find('form button').click().wait(1500) + cy.get('app-document-comments').find('.card').its('length').should('eq', 4) + }) }) diff --git a/src-ui/cypress/fixtures/documents/1/comments.json b/src-ui/cypress/fixtures/documents/1/comments.json new file mode 100644 index 000000000..73e932187 --- /dev/null +++ b/src-ui/cypress/fixtures/documents/1/comments.json @@ -0,0 +1,46 @@ +[ + { + "id": 10, + "comment": "Testing new comment", + "created": "2022-08-08T04:24:55.176008Z", + "user": { + "id": 1, + "username": "user2", + "firstname": "", + "lastname": "" + } + }, + { + "id": 9, + "comment": "Testing one more time", + "created": "2022-02-18T04:24:55.176008Z", + "user": { + "id": 2, + "username": "user1", + "firstname": "", + "lastname": "" + } + }, + { + "id": 8, + "comment": "Another comment", + "created": "2021-11-08T04:24:47.925042Z", + "user": { + "id": 2, + "username": "user33", + "firstname": "", + "lastname": "" + } + }, + { + "id": 7, + "comment": "Cupcake ipsum dolor sit amet cheesecake candy cookie tiramisu. Donut chocolate chupa chups macaroon brownie halvah pie cheesecake gummies. Sweet chocolate bar candy donut gummi bears bear claw liquorice bonbon shortbread.\n\nDonut chocolate bar candy wafer wafer tiramisu. Gummies chocolate cake muffin toffee carrot cake macaroon. Toffee toffee jelly beans danish lollipop cake.", + "created": "2021-02-08T02:37:49.724132Z", + "user": { + "id": 3, + "username": "admin", + "firstname": "", + "lastname": "" + } + } +] diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index b17b0ee10..3080e8b84 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -395,7 +395,7 @@ src/app/components/manage/settings/settings.component.html - 150 + 158 @@ -701,7 +701,7 @@ src/app/components/manage/settings/settings.component.html - 157 + 165 src/app/components/manage/tasks/tasks.component.html @@ -816,7 +816,7 @@ src/app/components/document-detail/document-detail.component.html - 178 + 184 src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html @@ -824,7 +824,7 @@ src/app/components/manage/settings/settings.component.html - 189 + 197 @@ -1304,6 +1304,41 @@ 1 + + Enter comment + + src/app/components/document-comments/document-comments.component.html + 4 + + + + Please enter a comment. + + src/app/components/document-comments/document-comments.component.html + 5,7 + + + + Add comment + + src/app/components/document-comments/document-comments.component.html + 10 + + + + Error saving comment: + + src/app/components/document-comments/document-comments.component.ts + 57 + + + + Error deleting comment: + + src/app/components/document-comments/document-comments.component.ts + 72 + + Page @@ -1370,7 +1405,7 @@ src/app/components/manage/settings/settings.component.html - 175 + 183 @@ -1634,21 +1669,32 @@ src/app/components/document-detail/document-detail.component.html - 196 + 202 + + + + Comments + + src/app/components/document-detail/document-detail.component.html + 173 + + + src/app/components/manage/settings/settings.component.html + 128 Discard src/app/components/document-detail/document-detail.component.html - 176 + 182 Save & next src/app/components/document-detail/document-detail.component.html - 177 + 183 @@ -1832,7 +1878,7 @@ src/app/components/manage/settings/settings.component.html - 174 + 182 src/app/components/manage/tasks/tasks.component.html @@ -2310,14 +2356,14 @@ View "" saved successfully. src/app/components/document-list/document-list.component.ts - 180 + 176 View "" created successfully. src/app/components/document-list/document-list.component.ts - 210 + 206 @@ -2454,7 +2500,7 @@ src/app/components/manage/settings/settings.component.html - 169 + 177 @@ -2465,7 +2511,7 @@ src/app/components/manage/settings/settings.component.html - 165 + 173 @@ -2840,123 +2886,130 @@ 124 + + Enable comments + + src/app/components/manage/settings/settings.component.html + 132 + + Notifications src/app/components/manage/settings/settings.component.html - 132 + 140 Document processing src/app/components/manage/settings/settings.component.html - 135 + 143 Show notifications when new documents are detected src/app/components/manage/settings/settings.component.html - 139 + 147 Show notifications when document processing completes successfully src/app/components/manage/settings/settings.component.html - 140 + 148 Show notifications when document processing fails src/app/components/manage/settings/settings.component.html - 141 + 149 Suppress notifications on dashboard src/app/components/manage/settings/settings.component.html - 142 + 150 This will suppress all messages about document processing status on the dashboard. src/app/components/manage/settings/settings.component.html - 142 + 150 Appears on src/app/components/manage/settings/settings.component.html - 162 + 170 No saved views defined. src/app/components/manage/settings/settings.component.html - 179 + 187 Saved view "" deleted. src/app/components/manage/settings/settings.component.ts - 174 + 176 Settings saved src/app/components/manage/settings/settings.component.ts - 247 + 253 Settings were saved successfully. src/app/components/manage/settings/settings.component.ts - 248 + 254 Settings were saved successfully. Reload is required to apply some changes. src/app/components/manage/settings/settings.component.ts - 252 + 258 Reload now src/app/components/manage/settings/settings.component.ts - 253 + 259 An error occurred while saving settings. src/app/components/manage/settings/settings.component.ts - 263 + 269 Use system language src/app/components/manage/settings/settings.component.ts - 271 + 277 Use date format of display language src/app/components/manage/settings/settings.component.ts - 278 + 284 @@ -2965,7 +3018,7 @@ )"/> src/app/components/manage/settings/settings.component.ts - 298,300 + 304,306 @@ -3211,7 +3264,7 @@ Warning: You have unsaved changes to your document(s). src/app/guards/dirty-doc.guard.ts - 18 + 17 diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index edbd261f6..9840deb58 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -67,6 +67,7 @@ import { ApiVersionInterceptor } from './interceptors/api-version.interceptor' import { ColorSliderModule } from 'ngx-color/slider' import { ColorComponent } from './components/common/input/color/color.component' import { DocumentAsnComponent } from './components/document-asn/document-asn.component' +import { DocumentCommentsComponent } from './components/document-comments/document-comments.component' import { DirtyDocGuard } from './guards/dirty-doc.guard' import localeBe from '@angular/common/locales/be' @@ -173,6 +174,7 @@ function initializeApp(settings: SettingsService) { DateComponent, ColorComponent, DocumentAsnComponent, + DocumentCommentsComponent, TasksComponent, ], imports: [ diff --git a/src-ui/src/app/components/document-comments/document-comments.component.html b/src-ui/src/app/components/document-comments/document-comments.component.html new file mode 100644 index 000000000..9a2e7debb --- /dev/null +++ b/src-ui/src/app/components/document-comments/document-comments.component.html @@ -0,0 +1,27 @@ +
+
+
+ +
+ Please enter a comment. +
+
+
+ +
+
+
+
+
+

{{comment.comment}}

+
+
+ {{displayName(comment)}} - {{ comment.created | customDate}} + +
+
+
diff --git a/src-ui/src/app/components/document-comments/document-comments.component.scss b/src-ui/src/app/components/document-comments/document-comments.component.scss new file mode 100644 index 000000000..d7e21e14e --- /dev/null +++ b/src-ui/src/app/components/document-comments/document-comments.component.scss @@ -0,0 +1,9 @@ +.card-body { + max-height: 12rem; + overflow: scroll; + white-space: pre-wrap; +} + +.card:hover .fade { + opacity: 1; +} diff --git a/src-ui/src/app/components/document-comments/document-comments.component.ts b/src-ui/src/app/components/document-comments/document-comments.component.ts new file mode 100644 index 000000000..5362e1661 --- /dev/null +++ b/src-ui/src/app/components/document-comments/document-comments.component.ts @@ -0,0 +1,90 @@ +import { Component, Input, OnInit } from '@angular/core' +import { DocumentCommentsService } from 'src/app/services/rest/document-comments.service' +import { PaperlessDocumentComment } from 'src/app/data/paperless-document-comment' +import { FormControl, FormGroup } from '@angular/forms' +import { first } from 'rxjs/operators' +import { ToastService } from 'src/app/services/toast.service' + +@Component({ + selector: 'app-document-comments', + templateUrl: './document-comments.component.html', + styleUrls: ['./document-comments.component.scss'], +}) +export class DocumentCommentsComponent implements OnInit { + commentForm: FormGroup = new FormGroup({ + newComment: new FormControl(''), + }) + + networkActive = false + comments: PaperlessDocumentComment[] = [] + newCommentError: boolean = false + + @Input() + documentId: number + + constructor( + private commentsService: DocumentCommentsService, + private toastService: ToastService + ) {} + + ngOnInit(): void { + this.commentsService + .getComments(this.documentId) + .pipe(first()) + .subscribe((comments) => (this.comments = comments)) + } + + addComment() { + const comment: string = this.commentForm + .get('newComment') + .value.toString() + .trim() + if (comment.length == 0) { + this.newCommentError = true + return + } + this.newCommentError = false + this.networkActive = true + this.commentsService.addComment(this.documentId, comment).subscribe({ + next: (result) => { + this.comments = result + this.commentForm.get('newComment').reset() + this.networkActive = false + }, + error: (e) => { + this.networkActive = false + this.toastService.showError( + $localize`Error saving comment: ${e.toString()}` + ) + }, + }) + } + + deleteComment(commentId: number) { + this.commentsService.deleteComment(this.documentId, commentId).subscribe({ + next: (result) => { + this.comments = result + this.networkActive = false + }, + error: (e) => { + this.networkActive = false + this.toastService.showError( + $localize`Error deleting comment: ${e.toString()}` + ) + }, + }) + } + + displayName(comment: PaperlessDocumentComment): string { + if (!comment.user) return '' + let nameComponents = [] + if (comment.user.firstname) nameComponents.unshift(comment.user.firstname) + if (comment.user.lastname) nameComponents.unshift(comment.user.lastname) + if (comment.user.username) { + if (nameComponents.length > 0) + nameComponents.push(`(${comment.user.username})`) + else nameComponents.push(comment.user.username) + } + return nameComponents.join(' ') + } +} diff --git a/src-ui/src/app/components/document-detail/document-detail.component.html b/src-ui/src/app/components/document-detail/document-detail.component.html index b20f3facd..6934801a4 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.html +++ b/src-ui/src/app/components/document-detail/document-detail.component.html @@ -170,6 +170,12 @@ +
  • + Comments + + + +
    • diff --git a/src-ui/src/app/components/document-detail/document-detail.component.ts b/src-ui/src/app/components/document-detail/document-detail.component.ts index 203a56f04..ff0a5303b 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.ts +++ b/src-ui/src/app/components/document-detail/document-detail.component.ts @@ -551,4 +551,8 @@ export class DocumentDetailComponent this.password = (event.target as HTMLInputElement).value } } + + get commentsEnabled(): boolean { + return this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED) + } } diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 002cc4eed..f72587139 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -125,6 +125,14 @@ +

    Comments

    + +
    +
    + +
    +
    + diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 22ecfe9bb..bb7244663 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -44,6 +44,7 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { notificationsConsumerSuccess: new FormControl(null), notificationsConsumerFailed: new FormControl(null), notificationsConsumerSuppressOnDashboard: new FormControl(null), + commentsEnabled: new FormControl(null), }) savedViews: PaperlessSavedView[] @@ -116,6 +117,7 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { notificationsConsumerSuppressOnDashboard: this.settings.get( SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD ), + commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), } for (let view of this.savedViews) { @@ -234,6 +236,10 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD, this.settingsForm.value.notificationsConsumerSuppressOnDashboard ) + this.settings.set( + SETTINGS_KEYS.COMMENTS_ENABLED, + this.settingsForm.value.commentsEnabled + ) this.settings.setLanguage(this.settingsForm.value.displayLanguage) this.settings .storeSettings() diff --git a/src-ui/src/app/data/paperless-document-comment.ts b/src-ui/src/app/data/paperless-document-comment.ts new file mode 100644 index 000000000..14085cf32 --- /dev/null +++ b/src-ui/src/app/data/paperless-document-comment.ts @@ -0,0 +1,8 @@ +import { ObjectWithId } from './object-with-id' +import { User } from './user' + +export interface PaperlessDocumentComment extends ObjectWithId { + created?: Date + comment?: string + user?: User +} diff --git a/src-ui/src/app/data/paperless-uisettings.ts b/src-ui/src/app/data/paperless-uisettings.ts index 75aec2a51..e3d977687 100644 --- a/src-ui/src/app/data/paperless-uisettings.ts +++ b/src-ui/src/app/data/paperless-uisettings.ts @@ -36,6 +36,7 @@ export const SETTINGS_KEYS = { 'general-settings:notifications:consumer-failed', NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD: 'general-settings:notifications:consumer-suppress-on-dashboard', + COMMENTS_ENABLED: 'general-settings:comments-enabled', } export const SETTINGS: PaperlessUiSetting[] = [ @@ -114,4 +115,9 @@ export const SETTINGS: PaperlessUiSetting[] = [ type: 'boolean', default: true, }, + { + key: SETTINGS_KEYS.COMMENTS_ENABLED, + type: 'boolean', + default: true, + }, ] diff --git a/src-ui/src/app/data/user.ts b/src-ui/src/app/data/user.ts new file mode 100644 index 000000000..adf00e86b --- /dev/null +++ b/src-ui/src/app/data/user.ts @@ -0,0 +1,7 @@ +import { ObjectWithId } from './object-with-id' + +export interface User extends ObjectWithId { + username: string + firstname: string + lastname: string +} diff --git a/src-ui/src/app/services/rest/document-comments.service.ts b/src-ui/src/app/services/rest/document-comments.service.ts new file mode 100644 index 000000000..a697c0e93 --- /dev/null +++ b/src-ui/src/app/services/rest/document-comments.service.ts @@ -0,0 +1,37 @@ +import { Injectable } from '@angular/core' +import { HttpClient, HttpParams } from '@angular/common/http' +import { PaperlessDocumentComment } from 'src/app/data/paperless-document-comment' +import { AbstractPaperlessService } from './abstract-paperless-service' +import { Observable } from 'rxjs' + +@Injectable({ + providedIn: 'root', +}) +export class DocumentCommentsService extends AbstractPaperlessService { + constructor(http: HttpClient) { + super(http, 'documents') + } + + getComments(documentId: number): Observable { + return this.http.get( + this.getResourceUrl(documentId, 'comments') + ) + } + + addComment(id: number, comment): Observable { + return this.http.post( + this.getResourceUrl(id, 'comments'), + { comment: comment } + ) + } + + deleteComment( + documentId: number, + commentId: number + ): Observable { + return this.http.delete( + this.getResourceUrl(documentId, 'comments'), + { params: new HttpParams({ fromString: `id=${commentId}` }) } + ) + } +} diff --git a/src/documents/management/commands/document_exporter.py b/src/documents/management/commands/document_exporter.py index 526d59368..dc53a690e 100644 --- a/src/documents/management/commands/document_exporter.py +++ b/src/documents/management/commands/document_exporter.py @@ -12,6 +12,7 @@ from django.core import serializers from django.core.management.base import BaseCommand from django.core.management.base import CommandError from django.db import transaction +from documents.models import Comment from documents.models import Correspondent from documents.models import Document from documents.models import DocumentType @@ -126,6 +127,10 @@ class Command(BaseCommand): serializers.serialize("json", DocumentType.objects.all()), ) + manifest += json.loads( + serializers.serialize("json", Comment.objects.all()), + ) + documents = Document.objects.order_by("id") document_map = {d.pk: d for d in documents} document_manifest = json.loads(serializers.serialize("json", documents)) diff --git a/src/documents/migrations/1023_add_comments.py b/src/documents/migrations/1023_add_comments.py new file mode 100644 index 000000000..124e4777c --- /dev/null +++ b/src/documents/migrations/1023_add_comments.py @@ -0,0 +1,28 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("documents", "1022_paperlesstask"), + ] + + operations = [ + migrations.CreateModel( + name="Comment", + fields=[ + ( + "id", + models.AutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name="ID", + ), + ), + ("comment", models.TextField()), + ("created", models.DateTimeField(auto_now_add=True)), + ("document_id", models.PositiveIntegerField()), + ("user_id", models.PositiveIntegerField()), + ], + ) + ] diff --git a/src/documents/migrations/1024_merge_20220824_1341.py b/src/documents/migrations/1024_merge_20220824_1341.py new file mode 100644 index 000000000..4a2b9706a --- /dev/null +++ b/src/documents/migrations/1024_merge_20220824_1341.py @@ -0,0 +1,13 @@ +# Generated by Django 4.0.6 on 2022-08-24 13:41 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("documents", "1023_add_comments"), + ("documents", "1023_document_original_filename"), + ] + + operations = [] diff --git a/src/documents/models.py b/src/documents/models.py index f6df273ad..b2070d2f1 100644 --- a/src/documents/models.py +++ b/src/documents/models.py @@ -537,3 +537,43 @@ class PaperlessTask(models.Model): blank=True, ) acknowledged = models.BooleanField(default=False) + + +class Comment(models.Model): + comment = models.TextField( + _("content"), + blank=True, + help_text=_("Comment for the document"), + ) + + created = models.DateTimeField( + _("created"), + default=timezone.now, + db_index=True, + ) + + document = models.ForeignKey( + Document, + blank=True, + null=True, + related_name="documents", + on_delete=models.CASCADE, + verbose_name=_("document"), + ) + + user = models.ForeignKey( + User, + blank=True, + null=True, + related_name="users", + on_delete=models.SET_NULL, + verbose_name=_("user"), + ) + + class Meta: + ordering = ("created",) + verbose_name = _("comment") + verbose_name_plural = _("comments") + + def __str__(self): + return self.content diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index b6fa69699..4fc90b72e 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -32,6 +32,7 @@ from documents.models import SavedView from documents.models import StoragePath from documents.models import Tag from documents.models import UiSettings +from documents.models import Comment from documents.models import StoragePath from documents.tests.utils import DirectoriesMixin from paperless import version @@ -1357,6 +1358,133 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): 1, ) + def test_get_existing_comments(self): + """ + GIVEN: + - A document with a single comment + WHEN: + - API reuqest for document comments is made + THEN: + - The associated comment is returned + """ + doc = Document.objects.create( + title="test", + mime_type="application/pdf", + content="this is a document which will have comments!", + ) + comment = Comment.objects.create( + comment="This is a comment.", + document=doc, + user=self.user, + ) + + response = self.client.get( + f"/api/documents/{doc.pk}/comments/", + format="json", + ) + + self.assertEqual(response.status_code, 200) + + resp_data = response.json() + + self.assertEqual(len(resp_data), 1) + + resp_data = resp_data[0] + del resp_data["created"] + + self.assertDictEqual( + resp_data, + { + "id": comment.id, + "comment": comment.comment, + "user": { + "id": comment.user.id, + "username": comment.user.username, + "firstname": comment.user.first_name, + "lastname": comment.user.last_name, + }, + }, + ) + + def test_create_comment(self): + """ + GIVEN: + - Existing document + WHEN: + - API request is made to add a comment + THEN: + - Comment is created and associated with document + """ + doc = Document.objects.create( + title="test", + mime_type="application/pdf", + content="this is a document which will have comments added", + ) + resp = self.client.post( + f"/api/documents/{doc.pk}/comments/", + data={"comment": "this is a posted comment"}, + ) + self.assertEqual(resp.status_code, 200) + + response = self.client.get( + f"/api/documents/{doc.pk}/comments/", + format="json", + ) + + self.assertEqual(response.status_code, 200) + + resp_data = response.json() + + self.assertEqual(len(resp_data), 1) + + resp_data = resp_data[0] + + self.assertEqual(resp_data["comment"], "this is a posted comment") + + def test_delete_comment(self): + """ + GIVEN: + - Existing document + WHEN: + - API request is made to add a comment + THEN: + - Comment is created and associated with document + """ + doc = Document.objects.create( + title="test", + mime_type="application/pdf", + content="this is a document which will have comments!", + ) + comment = Comment.objects.create( + comment="This is a comment.", + document=doc, + user=self.user, + ) + + response = self.client.delete( + f"/api/documents/{doc.pk}/comments/?id={comment.pk}", + format="json", + ) + + self.assertEqual(response.status_code, 200) + + self.assertEqual(len(Comment.objects.all()), 0) + + def test_get_comments_no_doc(self): + """ + GIVEN: + - A request to get comments from a non-existent document + WHEN: + - API request for document comments is made + THEN: + - HTTP 404 is returned + """ + response = self.client.get( + "/api/documents/500/comments/", + format="json", + ) + self.assertEqual(response.status_code, 404) + class TestDocumentApiV2(DirectoriesMixin, APITestCase): def setUp(self): diff --git a/src/documents/tests/test_management_exporter.py b/src/documents/tests/test_management_exporter.py index a9dcabc4d..92f1d3b62 100644 --- a/src/documents/tests/test_management_exporter.py +++ b/src/documents/tests/test_management_exporter.py @@ -10,10 +10,12 @@ from django.core.management import call_command from django.test import override_settings from django.test import TestCase from documents.management.commands import document_exporter +from documents.models import Comment from documents.models import Correspondent from documents.models import Document from documents.models import DocumentType from documents.models import Tag +from documents.models import User from documents.sanity_checker import check_sanity from documents.settings import EXPORTER_FILE_NAME from documents.tests.utils import DirectoriesMixin @@ -25,6 +27,8 @@ class TestExportImport(DirectoriesMixin, TestCase): self.target = tempfile.mkdtemp() self.addCleanup(shutil.rmtree, self.target) + self.user = User.objects.create(username="temp_admin") + self.d1 = Document.objects.create( content="Content", checksum="42995833e01aea9b3edee44bbfdd7ce1", @@ -57,6 +61,12 @@ class TestExportImport(DirectoriesMixin, TestCase): storage_type=Document.STORAGE_TYPE_GPG, ) + self.comment = Comment.objects.create( + comment="This is a comment. amaze.", + document=self.d1, + user=self.user, + ) + self.t1 = Tag.objects.create(name="t") self.dt1 = DocumentType.objects.create(name="dt") self.c1 = Correspondent.objects.create(name="c") @@ -110,7 +120,7 @@ class TestExportImport(DirectoriesMixin, TestCase): manifest = self._do_export(use_filename_format=use_filename_format) - self.assertEqual(len(manifest), 8) + self.assertEqual(len(manifest), 10) self.assertEqual( len(list(filter(lambda e: e["model"] == "documents.document", manifest))), 4, @@ -171,6 +181,11 @@ class TestExportImport(DirectoriesMixin, TestCase): checksum = hashlib.md5(f.read()).hexdigest() self.assertEqual(checksum, element["fields"]["archive_checksum"]) + elif element["model"] == "documents.comment": + self.assertEqual(element["fields"]["comment"], self.comment.comment) + self.assertEqual(element["fields"]["document"], self.d1.id) + self.assertEqual(element["fields"]["user"], self.user.id) + with paperless_environment() as dirs: self.assertEqual(Document.objects.count(), 4) Document.objects.all().delete() diff --git a/src/documents/views.py b/src/documents/views.py index 51a6ed23a..e301ab5f6 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -64,6 +64,7 @@ from .matching import match_correspondents from .matching import match_document_types from .matching import match_storage_paths from .matching import match_tags +from .models import Comment from .models import Correspondent from .models import Document from .models import DocumentType @@ -387,6 +388,67 @@ class DocumentViewSet( except (FileNotFoundError, Document.DoesNotExist): raise Http404() + def getComments(self, doc): + return [ + { + "id": c.id, + "comment": c.comment, + "created": c.created, + "user": { + "id": c.user.id, + "username": c.user.username, + "firstname": c.user.first_name, + "lastname": c.user.last_name, + }, + } + for c in Comment.objects.filter(document=doc).order_by("-created") + ] + + @action(methods=["get", "post", "delete"], detail=True) + def comments(self, request, pk=None): + try: + doc = Document.objects.get(pk=pk) + except Document.DoesNotExist: + raise Http404() + + currentUser = request.user + + if request.method == "GET": + try: + return Response(self.getComments(doc)) + except Exception as e: + logger.warning(f"An error occurred retrieving comments: {str(e)}") + return Response( + {"error": "Error retreiving comments, check logs for more detail."}, + ) + elif request.method == "POST": + try: + c = Comment.objects.create( + document=doc, + comment=request.data["comment"], + user=currentUser, + ) + c.save() + + return Response(self.getComments(doc)) + except Exception as e: + logger.warning(f"An error occurred saving comment: {str(e)}") + return Response( + { + "error": "Error saving comment, check logs for more detail.", + }, + ) + elif request.method == "DELETE": + comment = Comment.objects.get(id=int(request.GET.get("id"))) + comment.delete() + return Response(self.getComments(doc)) + + return Response( + { + "error": "error", + }, + ) + class SearchResultSerializer(DocumentSerializer): def to_representation(self, instance):