From d96a8c7b11042bdfc571469e07a1c28f664fd00a Mon Sep 17 00:00:00 2001
From: Ramon Wenger <ramon.wenger@iterativ.ch>
Date: Wed, 7 Sep 2022 08:41:06 +0200
Subject: [PATCH 1/3] Add document to solution, add more generic document block

---
 server/basicknowledge/models.py     |  6 +++---
 server/books/blocks.py              | 16 ++++++++++++++++
 server/books/models/contentblock.py | 10 ++++++----
 3 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/server/basicknowledge/models.py b/server/basicknowledge/models.py
index b0386d29..45fa3e1f 100644
--- a/server/basicknowledge/models.py
+++ b/server/basicknowledge/models.py
@@ -2,10 +2,10 @@ from django.db import models
 from django.utils.text import slugify
 from wagtail.admin.edit_handlers import FieldPanel, StreamFieldPanel
 from wagtail.core.fields import RichTextField, StreamField
-from wagtail.documents.blocks import DocumentChooserBlock
 from wagtail.images.blocks import ImageChooserBlock
 
-from books.blocks import DocumentBlock, GeniallyBlock, InfogramBlock, InstrumentTextBlock, LinkBlock, SectionTitleBlock, \
+from books.blocks import CMSDocumentBlock, DocumentBlock, GeniallyBlock, InfogramBlock, InstrumentTextBlock, LinkBlock, \
+    SectionTitleBlock, \
     SubtitleBlock, ThinglinkBlock, VideoBlock
 from core.constants import DEFAULT_RICH_TEXT_FEATURES
 from core.wagtail_utils import StrictHierarchyPage
@@ -53,7 +53,7 @@ class BasicKnowledge(StrictHierarchyPage):
         ('genially_block', GeniallyBlock()),
         ('thinglink_block', ThinglinkBlock()),
         ('subtitle', SubtitleBlock()),
-        ('cms_document_block', DocumentChooserBlock()),
+        ('cms_document_block', CMSDocumentBlock()),
     ], null=True, blank=True)
 
     new_type = models.ForeignKey(InstrumentType, null=True, on_delete=models.PROTECT, related_name='instruments')
diff --git a/server/books/blocks.py b/server/books/blocks.py
index 8ec10659..3b312850 100644
--- a/server/books/blocks.py
+++ b/server/books/blocks.py
@@ -1,4 +1,5 @@
 from wagtail.core import blocks
+from wagtail.documents.blocks import DocumentChooserBlock
 from wagtail.snippets.blocks import SnippetChooserBlock
 
 from assignments.models import Assignment
@@ -6,6 +7,11 @@ from core.constants import DEFAULT_RICH_TEXT_FEATURES, INSTRUMENTS_RICH_TEXT_FEA
 from surveys.models import Survey
 
 
+class CMSDocumentBlock(DocumentChooserBlock):
+    class Meta:
+        label = 'CMS Document'
+
+
 # link_block
 class LinkBlock(blocks.StructBlock):
     class Meta:
@@ -23,6 +29,14 @@ class TextBlock(blocks.StructBlock):
     text = blocks.RichTextBlock(features=DEFAULT_RICH_TEXT_FEATURES)
 
 
+class SolutionBlock(blocks.StructBlock):
+    class Meta:
+        icon = 'tick'
+
+    text = blocks.RichTextBlock(features=DEFAULT_RICH_TEXT_FEATURES)
+    document = CMSDocumentBlock()
+
+
 # 'basic_knowledge'
 class BasicKnowledgeBlock(blocks.StructBlock):
     class Meta:
@@ -115,6 +129,8 @@ class InstructionBlock(blocks.StructBlock):
 
     url = blocks.URLBlock()
     text = blocks.TextBlock(required=False)
+    document = DocumentChooserBlock()
+
 
 # 'text_block' 'task' 'basic_knowledge' 'student_entry' 'image_block'
 #
diff --git a/server/books/models/contentblock.py b/server/books/models/contentblock.py
index 804cf0b4..1bd999b6 100644
--- a/server/books/models/contentblock.py
+++ b/server/books/models/contentblock.py
@@ -4,11 +4,11 @@ from django.db import models
 from wagtail.admin.edit_handlers import FieldPanel, TabbedInterface, ObjectList, StreamFieldPanel
 from wagtail.core.blocks import StreamBlock
 from wagtail.core.fields import StreamField
-from wagtail.documents.blocks import DocumentChooserBlock
 from wagtail.images.blocks import ImageChooserBlock
 
 from core.wagtail_utils import get_default_settings
-from books.blocks import TextBlock, BasicKnowledgeBlock, LinkBlock, VideoBlock, DocumentBlock, \
+from books.blocks import CMSDocumentBlock, SolutionBlock, TextBlock, BasicKnowledgeBlock, LinkBlock, VideoBlock, \
+    DocumentBlock, \
     ImageUrlBlock, AssignmentBlock, InfogramBlock, GeniallyBlock, SubtitleBlock, SurveyBlock, ModuleRoomSlugBlock, \
     ThinglinkBlock, InstructionBlock
 from books.utils import get_type_and_value
@@ -56,7 +56,8 @@ class ContentBlock(StrictHierarchyPage):
         ('image_block', ImageChooserBlock()),
         ('image_url_block', ImageUrlBlock()),
         ('link_block', LinkBlock()),
-        ('solution', TextBlock(icon='tick')),
+        # ('solution', TextBlock(icon='tick')),
+        ('solution', SolutionBlock()),
         ('video_block', VideoBlock()),
         ('document_block', DocumentBlock()),
         ('infogram_block', InfogramBlock()),
@@ -65,7 +66,8 @@ class ContentBlock(StrictHierarchyPage):
         ('subtitle', SubtitleBlock()),
         ('instruction', InstructionBlock()),
         ('module_room_slug', ModuleRoomSlugBlock()),
-        ('cms_document_block', DocumentChooserBlock())
+        # ('cms_document_block', DocumentChooserBlock(label='CMS Document'))
+        ('cms_document_block', CMSDocumentBlock())
     ]
 
     content_list_item = StreamBlock(content_blocks)

From 7fae6555431f14e0b1e467b58d23a2b118c2f24f Mon Sep 17 00:00:00 2001
From: Ramon Wenger <ramon.wenger@iterativ.ch>
Date: Thu, 8 Sep 2022 12:28:37 +0200
Subject: [PATCH 2/3] Add documents to client view

---
 .../content-blocks/CmsDocumentBlock.vue       | 24 ++++++++++++-
 .../components/content-blocks/Instruction.vue |  5 ++-
 .../components/content-blocks/Solution.vue    | 24 +++++++++----
 server/api/graphene_wagtail.py                | 34 +++++++++++++------
 server/books/blocks.py                        |  6 ++--
 5 files changed, 72 insertions(+), 21 deletions(-)

diff --git a/client/src/components/content-blocks/CmsDocumentBlock.vue b/client/src/components/content-blocks/CmsDocumentBlock.vue
index 8a0645b1..70817717 100644
--- a/client/src/components/content-blocks/CmsDocumentBlock.vue
+++ b/client/src/components/content-blocks/CmsDocumentBlock.vue
@@ -1,5 +1,8 @@
 <template>
-  <div class="cms-document-block">
+  <div
+    :class="{'cms-document-block--solution': solution}"
+    class="cms-document-block"
+  >
     <document-icon class="cms-document-block__icon" />
     <a
       :href="value.url"
@@ -15,6 +18,10 @@
   export default {
     props: {
       value: Object,
+      solution: {
+        type: Boolean,
+        default: false,
+      },
     },
 
     components: {
@@ -37,8 +44,23 @@
       height: 30px;
     }
 
+
     &__link {
       text-decoration: underline;
     }
+
+    $parent: &;
+
+    &--solution {
+      margin-bottom: $small-spacing;
+
+      #{$parent}__link {
+        color: $color-silver-dark;
+      }
+      #{$parent}__icon {
+        fill: $color-silver-dark;
+      }
+
+    }
   }
 </style>
diff --git a/client/src/components/content-blocks/Instruction.vue b/client/src/components/content-blocks/Instruction.vue
index c269ca77..7765762d 100644
--- a/client/src/components/content-blocks/Instruction.vue
+++ b/client/src/components/content-blocks/Instruction.vue
@@ -5,7 +5,7 @@
   >
     <bulb-icon class="instruction__icon" />
     <a
-      :href="value.url"
+      :href="url"
       class="instruction__link"
     >{{ text }}</a>
   </div>
@@ -27,6 +27,9 @@
     computed: {
       text() {
         return this.value.text ? this.value.text : 'Anweisungen';
+      },
+      url() {
+        return this.value.document ? this.value.document.url : this.value.url;
       }
     }
   };
diff --git a/client/src/components/content-blocks/Solution.vue b/client/src/components/content-blocks/Solution.vue
index 8c07d3a9..13427645 100644
--- a/client/src/components/content-blocks/Solution.vue
+++ b/client/src/components/content-blocks/Solution.vue
@@ -13,22 +13,34 @@
       <template v-else>ausblenden</template>
     </a>
     <transition name="fade">
-      <p
-        class="solution__text solution-text fade"
-        data-cy="solution-text"
-
+      <div
+        class="solution__hidden fade"
         v-if="visible"
-        v-html="sanitizedText"
-      />
+      >
+        <p
+          class="solution__text solution-text"
+          data-cy="solution-text"
+
+          v-html="sanitizedText"
+        />
+        <cms-document-block
+          :solution="true"
+          class="solution__document"
+          :value="value.document"
+          v-if="value.document"
+        />
+      </div>
     </transition>
   </div>
 </template>
 
 <script>
   import {sanitizeAsHtml} from '@/helpers/text';
+  import CmsDocumentBlock from '@/components/content-blocks/CmsDocumentBlock';
 
   export default {
     props: ['value'],
+    components: {CmsDocumentBlock},
 
     data() {
       return {
diff --git a/server/api/graphene_wagtail.py b/server/api/graphene_wagtail.py
index 25eb0122..2729788e 100644
--- a/server/api/graphene_wagtail.py
+++ b/server/api/graphene_wagtail.py
@@ -17,12 +17,26 @@ from surveys.models import Survey
 logger = logging.getLogger(__name__)
 
 
+# todo: replace this with the newer method from https://wagtail.org/blog/graphql-with-streamfield/
 class GenericStreamFieldType(Scalar):
     @staticmethod
     def serialize(stream_value):
         raw_data = stream_value.raw_data
         return list(augment_fields(raw_data))
 
+def get_document_json(document_id):
+    document = CustomDocument.objects.get(id=document_id)
+    value = {
+        'value': document_id,
+        'id': document.id,
+        'file_name': document.filename,
+        'file_extension': document.file_extension,
+        'url': document.url,
+        'title': document.title,
+        'display_text': document.display_text
+    }
+    return value
+
 
 def augment_fields(raw_data):
     for data in raw_data:
@@ -90,19 +104,19 @@ def augment_fields(raw_data):
             if _type == 'cms_document_block':
                 try:
                     _value = data['value']
-                    document = CustomDocument.objects.get(id=_value)
-                    value = {
-                        'value': _value,
-                        'id': document.id,
-                        'file_name': document.filename,
-                        'file_extension': document.file_extension,
-                        'url': document.url,
-                        'title': document.title,
-                        'display_text': document.display_text
-                    }
+                    value = get_document_json(_value)
                     data['value'] = value
                 except CustomDocument.DoesNotExist:
                     logger.error('CustomDocument {} does not exist'.format(_value))
+            if _type == 'solution' or _type == 'instruction':
+                _value = data['value']
+                document_id = _value.get('document')
+                if document_id is not None:
+                    document = get_document_json(document_id)
+                    _value['document'] = document
+                data['value'] = _value
+
+
 
     return raw_data
 
diff --git a/server/books/blocks.py b/server/books/blocks.py
index 3b312850..28725f1b 100644
--- a/server/books/blocks.py
+++ b/server/books/blocks.py
@@ -34,7 +34,7 @@ class SolutionBlock(blocks.StructBlock):
         icon = 'tick'
 
     text = blocks.RichTextBlock(features=DEFAULT_RICH_TEXT_FEATURES)
-    document = CMSDocumentBlock()
+    document = CMSDocumentBlock(required=False)
 
 
 # 'basic_knowledge'
@@ -127,9 +127,9 @@ class InstructionBlock(blocks.StructBlock):
     class Meta:
         icon = 'help'
 
-    url = blocks.URLBlock()
+    url = blocks.URLBlock(required=False)
     text = blocks.TextBlock(required=False)
-    document = DocumentChooserBlock()
+    document = DocumentChooserBlock(required=False)
 
 
 # 'text_block' 'task' 'basic_knowledge' 'student_entry' 'image_block'

From 759cece268850d5de6468f1c06aeaca5f89b78ae Mon Sep 17 00:00:00 2001
From: Ramon Wenger <ramon.wenger@iterativ.ch>
Date: Tue, 13 Sep 2022 16:39:24 +0200
Subject: [PATCH 3/3] Refactor code

---
 server/api/graphene_wagtail.py | 37 ++++++++++++++++++----------------
 1 file changed, 20 insertions(+), 17 deletions(-)

diff --git a/server/api/graphene_wagtail.py b/server/api/graphene_wagtail.py
index 2729788e..4f335910 100644
--- a/server/api/graphene_wagtail.py
+++ b/server/api/graphene_wagtail.py
@@ -25,17 +25,21 @@ class GenericStreamFieldType(Scalar):
         return list(augment_fields(raw_data))
 
 def get_document_json(document_id):
-    document = CustomDocument.objects.get(id=document_id)
-    value = {
-        'value': document_id,
-        'id': document.id,
-        'file_name': document.filename,
-        'file_extension': document.file_extension,
-        'url': document.url,
-        'title': document.title,
-        'display_text': document.display_text
-    }
-    return value
+    try:
+        document = CustomDocument.objects.get(id=document_id)
+        value = {
+            'value': document_id,
+            'id': document.id,
+            'file_name': document.filename,
+            'file_extension': document.file_extension,
+            'url': document.url,
+            'title': document.title,
+            'display_text': document.display_text
+        }
+        return value
+    except CustomDocument.DoesNotExist:
+        logger.error('CustomDocument {} does not exist'.format(document_id))
+        return None
 
 
 def augment_fields(raw_data):
@@ -102,18 +106,17 @@ def augment_fields(raw_data):
                 data['value'] = augment_fields(item_data)
 
             if _type == 'cms_document_block':
-                try:
-                    _value = data['value']
-                    value = get_document_json(_value)
+                _value = data['value']
+                value = get_document_json(_value)
+                if value is not None:
                     data['value'] = value
-                except CustomDocument.DoesNotExist:
-                    logger.error('CustomDocument {} does not exist'.format(_value))
             if _type == 'solution' or _type == 'instruction':
                 _value = data['value']
                 document_id = _value.get('document')
                 if document_id is not None:
                     document = get_document_json(document_id)
-                    _value['document'] = document
+                    if document is not None:
+                        _value['document'] = document
                 data['value'] = _value