Merge pull request #521 from digitalfabrik/feature/export-to-csv

Feature/export to csv

Author: KateGithub12

CHANGELOG.md

@@ -2,10 +2,7 @@ UNRELEASED
 ----------
 
 * [ [#353](https://github.com/digitalfabrik/lunes-cms/issues/353) ] Filter feedback by creator of related objects
-
-
-2024.5.1
---------
+* [ [#468](https://github.com/digitalfabrik/lunes-cms/issues/468) ] Excel list out of existing vocabulary in cms
 
 
 2024.5.0

lunes_cms/cms/admins/discipline_admin.py

@@ -1,14 +1,21 @@
 from __future__ import absolute_import, unicode_literals
 
+import io
+import re
+from zipfile import ZipFile
+
 from django.contrib import admin
 from django.db.models import Count, Q
 from django.db.models.functions import Greatest
+from django.http import HttpResponse
 from django.urls import reverse
 from django.utils.safestring import mark_safe
 from django.utils.translation import ugettext_lazy as _
 from mptt.admin import DraggableMPTTAdmin
+from tablib import Dataset
 
-from ..models import Discipline, Static
+from ..models import Discipline, Document, Static
+from .document_resource import DocumentResource
 
 
 class DisciplineAdmin(DraggableMPTTAdmin):
@@ -39,7 +46,12 @@ class DisciplineAdmin(DraggableMPTTAdmin):
     ]
     list_display_links = ["indented_title"]
     list_filter = ["released"]
-    actions = ["delete_selected", "make_released", "make_unreleased"]
+    actions = [
+        "delete_selected",
+        "make_released",
+        "make_unreleased",
+        "make_export_to_CSV",
+    ]
     list_per_page = 25
 
     def get_list_display(self, request):
@@ -269,6 +281,45 @@ def make_unreleased(self, request, queryset):
         """
         queryset.update(released=False)
 
+    @admin.action(description=_("Export all vocabulary for this discipline to CSV"))
+    def make_export_to_CSV(self, request, queryset):
+        """
+        Export the documents of the selected disciplines.
+
+        :param request: current user request
+        :type request: django.http.request
+        :param queryset: current queryset
+        :type queryset: QuerySet
+        """
+        csvs = {}
+
+        for profession in queryset:
+            if profession.children.exists():
+                continue
+            resource = DocumentResource()
+
+            dataset = Dataset(
+                *(
+                    resource.export_resource(obj)
+                    for obj in Document.objects.filter(
+                        training_sets__discipline=profession
+                    )
+                ),
+                headers=resource.export().headers,
+            )
+
+            csvs[profession] = dataset.csv
+
+        zip_buffer = io.BytesIO()
+
+        with ZipFile(zip_buffer, "w") as zipfile:
+            for profession, csv in csvs.items():
+                zipfile.writestr(f"{make_safe_filename(profession.title)}.csv", csv)
+
+        response = HttpResponse(zip_buffer.getvalue(), content_type="application/zip")
+        response["Content-Disposition"] = 'attachment; filename="Lunes_vocabulary.zip"'
+        return response
+
     @admin.display(
         description=_("released modules"),
         ordering="modules_released_order",
@@ -357,3 +408,10 @@ class Media:
         """
 
         js = ("js/image_preview.js",)
+
+
+def make_safe_filename(unsafe):
+    """
+    Method to create a safe filename with regex.
+    """
+    return re.sub(r"[^a-zA-Z0-9.äöüÄÖÜ]+", "_", unsafe)

lunes_cms/cms/admins/document_resource.py

@@ -0,0 +1,106 @@
+from django.utils.translation import ugettext_lazy as _
+from import_export import fields, resources
+from import_export.admin import ExportActionMixin
+
+from ..models import Document
+from ..models.static import Static
+
+
+class DocumentResource(resources.ModelResource):
+    """
+    Resource to export Documents from the discipline view.
+    """
+
+    # pylint: disable=pointless-statement
+    ExportActionMixin.export_admin_action
+
+    # pylint: disable=super-init-not-called
+    def __init__(self, for_profession=None):
+        self.for_profession = for_profession
+        self.relevant_training_sets = (
+            for_profession.get_nested_training_sets() if for_profession else None
+        )
+
+    word = fields.Field(column_name=_("Word"), attribute="word")
+
+    word_type = fields.Field(column_name=_("Word type"), attribute="word_type")
+
+    singular_article = fields.Field(
+        column_name=_("Singular Article"),
+        attribute="singular_article",
+    )
+
+    def dehydrate_singular_article(self, document):
+        """
+        Method to show the actual singular article and not their integer.
+        """
+        for x in Static.singular_article_choices:
+            if x[0] == document.singular_article:
+                return x[1]
+        return "-"
+
+    plural_article = fields.Field(
+        column_name=_("Plural Article"),
+        attribute="plural_article_choices",
+    )
+
+    def dehydrate_plural_article(self, document):
+        """
+        Method to show the actual plural article and not their integer.
+        """
+        for x in Static.plural_article_choices:
+            if x[0] == document.plural_article:
+                return x[1]
+        return "-"
+
+    has_audio = fields.Field(column_name=_("Has audio?"), attribute="word")
+
+    def dehydrate_has_audio(self, document):
+        """
+        Returns yes if audio exists and no if it doesn't.
+        """
+        if bool(document.audio) is True:
+            return _("Yes")
+        return _("No")
+
+    example_sentence = fields.Field(
+        column_name=_("Example sentence"), attribute="example_sentence"
+    )
+
+    creation_date = fields.Field(
+        column_name=_("Creation date"), attribute="creation_date"
+    )
+
+    def dehydrate_creation_date(self, document):
+        """
+        Only show first 16 characters of date (date, and hours & minutes).
+        """
+        return str(document.creation_date)[:16]
+
+    training_sets = fields.Field(
+        column_name=_("Training Sets"), attribute="training_sets"
+    )
+
+    def dehydrate_training_sets(self, document):
+        """
+        Method to get relevant training sets.
+        """
+        relevant_training_sets = (
+            self.relevant_training_sets
+            if self.relevant_training_sets
+            else document.training_sets.values_list("id", flat=True)
+        )
+        return " | ".join(
+            [
+                t.title
+                for t in document.training_sets.filter(id__in=relevant_training_sets)
+            ]
+        )
+
+    class Meta:
+        """
+        Meta class of Document resource
+        """
+
+        model = Document
+        fields = ()

lunes_cms/core/settings.py

@@ -61,6 +61,7 @@
     "pydub",
     "rest_framework",
     "qr_code",
+    "import_export",
 ]
 
 #: Activated middlewares (see :setting:`django:MIDDLEWARE`)

lunes_cms/locale/de/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-05-22 08:52+0000\n"
+"POT-Creation-Date: 2024-06-02 09:04+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -55,27 +55,31 @@ msgstr "API Keys"
 msgid "feedback"
 msgstr "Feedback"
 
-#: cms/admins/discipline_admin.py:246
+#: cms/admins/discipline_admin.py:258
 msgid "Release selected disciplines"
 msgstr "Ausgewählte Modulgruppen veröffentlichen"
 
-#: cms/admins/discipline_admin.py:259
+#: cms/admins/discipline_admin.py:271
 msgid "Unrelease selected disciplines"
 msgstr "Ausgewählte Modulgruppen zurückhalten"
 
-#: cms/admins/discipline_admin.py:273
+#: cms/admins/discipline_admin.py:284
+msgid "Export all vocabulary for this discipline to CSV"
+msgstr "Alle Vokabeln dieser Modulgruppe als CSV exportieren"
+
+#: cms/admins/discipline_admin.py:324
 msgid "released modules"
 msgstr "veröffentlichte Module"
 
-#: cms/admins/discipline_admin.py:294
+#: cms/admins/discipline_admin.py:345
 msgid "unreleased modules"
 msgstr "unveröffentlichte Module"
 
-#: cms/admins/discipline_admin.py:315
+#: cms/admins/discipline_admin.py:366
 msgid "published words in released modules"
 msgstr "veröffentlichte Vokabeln in veröffentlichten Modulen"
 
-#: cms/admins/discipline_admin.py:336 cms/admins/document_admin.py:177
+#: cms/admins/discipline_admin.py:387 cms/admins/document_admin.py:177
 #: cms/admins/training_set_admin.py:376
 msgid "creator group"
 msgstr "Besitzergruppe"
@@ -98,6 +102,46 @@ msgstr "Bild"
 msgid "singular article"
 msgstr "Singular-Artikel"
 
+#: cms/admins/document_resource.py:24
+msgid "Word"
+msgstr "Vokabel"
+
+#: cms/admins/document_resource.py:26
+msgid "Word type"
+msgstr "Wortart"
+
+#: cms/admins/document_resource.py:29
+msgid "Singular Article"
+msgstr "Singular Artikel"
+
+#: cms/admins/document_resource.py:43
+msgid "Plural Article"
+msgstr "Plural Artikel"
+
+#: cms/admins/document_resource.py:56
+msgid "Has audio?"
+msgstr "Audio"
+
+#: cms/admins/document_resource.py:63
+msgid "Yes"
+msgstr "Ja"
+
+#: cms/admins/document_resource.py:64
+msgid "No"
+msgstr "Nein"
+
+#: cms/admins/document_resource.py:67
+msgid "Example sentence"
+msgstr "Beispielsatz"
+
+#: cms/admins/document_resource.py:71
+msgid "Creation date"
+msgstr "Erstellt am"
+
+#: cms/admins/document_resource.py:81
+msgid "Training Sets"
+msgstr "Module"
+
 #: cms/admins/feedback_admin.py:34
 msgid "Mark as read"
 msgstr "Als gelesen markieren"
@@ -571,28 +615,31 @@ msgstr "Datei zu groß! Max. 5 MB"
 msgid "Only use one file extension!"
 msgstr "Nur maximal ein Dateityp erlaubt!"
 
-#: core/settings.py:203
+#: core/settings.py:204
 msgid "English"
 msgstr "Englisch"
 
-#: core/settings.py:204
+#: core/settings.py:205
 msgid "German"
 msgstr "Deutsch"
 
-#: core/settings.py:444 core/settings.py:445 core/settings.py:447
+#: core/settings.py:445 core/settings.py:446 core/settings.py:448
 msgid "Lunes Administration"
 msgstr "Lunes-Verwaltung"
 
-#: core/settings.py:446
+#: core/settings.py:447
 msgid "Welcome to the vocabulary management of Lunes!"
 msgstr "Willkommen bei der Vokabelverwaltung von Lunes!"
 
 #: help/apps.py:13
 msgid "help"
 msgstr "Hilfe"
 
-#~ msgid "article"
-#~ msgstr "Artikel"
+#~ msgid "Article"
+#~ msgstr "Arikel"
+
+#~ msgid "Export to CSV"
+#~ msgstr "Als CSV exportieren"
 
 #~ msgid "assigned & unassigned"
 #~ msgstr "Zugewiesen & unzugewiesen"

setup.cfg

@@ -46,6 +46,7 @@ packages =
 	lunes_cms
 install_requires =
 	django==3.2.21
+	django-import-export==3.3.7
 	django-jazzmin==2.6.0
 	django-mptt==0.15.0
 	django-qr-code==3.1.1