DSRC-62: Document block

config/settings/base.py

@@ -305,6 +305,8 @@
     }
 }
 
+WAGTAILDOCS_DOCUMENT_MODEL = "core.CustomDocument"
+
 WAGTAILIMAGES_IMAGE_MODEL = "images.CustomImage"
 
 # Custom password template for private pages

etna/core/blocks/__init__.py

@@ -1,5 +1,6 @@
 from .base import SectionDepthAwareStructBlock
 from .cta import ButtonBlock, CallToActionBlock, LargeCardLinksBlock
+from .document import DocumentsBlock
 from .featured_content import (
     FeaturedCollectionBlock,
     FeaturedRecordArticleBlock,
@@ -27,6 +28,7 @@
     "ButtonBlock",
     "CallToActionBlock",
     "ContentImageBlock",
+    "DocumentsBlock",
     "DoDontListBlock",
     "FeaturedRecordArticleBlock",
     "FeaturedCollectionBlock",

etna/core/blocks/document.py

@@ -0,0 +1,45 @@
+from wagtail import blocks
+from wagtail.documents.blocks import DocumentChooserBlock
+
+
+class DocumentBlock(blocks.StructBlock):
+    """
+    A block for embedding a document file in a page.
+    """
+
+    file = DocumentChooserBlock(required=True)
+
+    def get_api_representation(self, value, context=None):
+        representation = super().get_api_representation(value, context)
+
+        file = value.get("file")
+
+        if file:
+            representation["file"] = {
+                "id": file.id,
+                "title": file.title,
+                "description": file.description or None,
+                "file_size": file.file_size,
+                "pretty_file_size": file.pretty_file_size,
+                "type": file.file_extension,
+                "extent": file.extent,
+                "url": file.file.url,
+            }
+
+        return representation
+
+    class Meta:
+        icon = "doc-full"
+        label = "Document"
+
+
+class DocumentsBlock(blocks.StructBlock):
+    """
+    A block for embedding multiple document files in a page.
+    """
+
+    documents = blocks.ListBlock(DocumentBlock())
+
+    class Meta:
+        icon = "doc-full"
+        label = "Documents"

etna/core/migrations/0004_customdocument.py

@@ -0,0 +1,88 @@
+# Generated by Django 5.0.6 on 2024-07-02 15:35
+
+import django.db.models.deletion
+import taggit.managers
+import wagtail.models.media
+import wagtail.search.index
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0003_set_page_uuid"),
+        (
+            "taggit",
+            "0006_rename_taggeditem_content_type_object_id_taggit_tagg_content_8fc721_idx",
+        ),
+        ("wagtailcore", "0093_uploadedfile"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="CustomDocument",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, verbose_name="title")),
+                ("file", models.FileField(upload_to="documents", verbose_name="file")),
+                (
+                    "created_at",
+                    models.DateTimeField(auto_now_add=True, verbose_name="created at"),
+                ),
+                ("file_size", models.PositiveIntegerField(editable=False, null=True)),
+                (
+                    "file_hash",
+                    models.CharField(blank=True, editable=False, max_length=40),
+                ),
+                ("extent", models.CharField(blank=True, null=True)),
+                ("description", models.TextField(blank=True, null=True)),
+                (
+                    "collection",
+                    models.ForeignKey(
+                        default=wagtail.models.media.get_root_collection_id,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="+",
+                        to="wagtailcore.collection",
+                        verbose_name="collection",
+                    ),
+                ),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        blank=True,
+                        help_text=None,
+                        through="taggit.TaggedItem",
+                        to="taggit.Tag",
+                        verbose_name="tags",
+                    ),
+                ),
+                (
+                    "uploaded_by_user",
+                    models.ForeignKey(
+                        blank=True,
+                        editable=False,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to=settings.AUTH_USER_MODEL,
+                        verbose_name="uploaded by user",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "document",
+                "verbose_name_plural": "documents",
+                "abstract": False,
+            },
+            bases=(wagtail.search.index.Indexed, models.Model),
+        ),
+    ]

etna/core/models/__init__.py

@@ -1,4 +1,5 @@
 from .basepage import *  # noqa
+from .documents import *  # noqa
 from .forms import *  # noqa
 from .mixins import *  # noqa
 from .settings import *  # noqa

etna/core/models/documents.py

@@ -0,0 +1,23 @@
+from django.db import models
+
+from wagtail.documents.models import AbstractDocument, Document
+
+
+class CustomDocument(AbstractDocument):
+    extent = models.CharField(blank=True, null=True)
+    description = models.TextField(blank=True, null=True)
+
+    @property
+    def pretty_file_size(self):
+        suffixes = ["B", "KB", "MB", "GB"]
+        i = 0
+        pretty_file_size = self.file_size
+        while pretty_file_size >= 1000 and i < len(suffixes) - 1:
+            pretty_file_size /= 1000
+            i += 1
+        return f"{pretty_file_size:.1f}{suffixes[i]}"
+
+    admin_form_fields = Document.admin_form_fields + (
+        "extent",
+        "description",
+    )

etna/generic_pages/blocks.py

@@ -4,6 +4,7 @@
     ButtonBlock,
     CallToActionBlock,
     ContentImageBlock,
+    DocumentsBlock,
     DoDontListBlock,
     FeaturedRecordArticleBlock,
     InsetTextBlock,
@@ -23,6 +24,7 @@
 class SectionContentBlock(blocks.StreamBlock):
     button = ButtonBlock()
     call_to_action = CallToActionBlock()
+    document = DocumentsBlock()
     do_dont_list = DoDontListBlock()
     featured_record_article = FeaturedRecordArticleBlock()
     image = ContentImageBlock()