Remove wagtail-import-export (#495)

Author: vsalvino

coderedcms/admin_urls.py

@@ -1,12 +1,12 @@
 from django.urls import include, path, re_path
-from wagtailimportexport import urls as wagtailimportexport_urls
 from wagtail.admin import urls as wagtailadmin_urls
-from coderedcms.views import import_pages_from_csv_file
+from coderedcms.views import import_index, import_pages_from_csv_file
 
 
 urlpatterns = [
+    path('codered/import-export/',
+         import_index, name="import_index"),
     path('codered/import-export/import_from_csv/',
          import_pages_from_csv_file, name="import_from_csv"),
     re_path(r'', include(wagtailadmin_urls)),
-    re_path(r'', include(wagtailimportexport_urls)),
 ]

coderedcms/forms.py

@@ -3,8 +3,8 @@
 """
 import csv
 import os
-import re
 from django import forms
+from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.http import HttpResponse
@@ -172,16 +172,13 @@ class SearchForm(forms.Form):
 def get_page_model_choices():
     """
     Returns a list of tuples of all creatable Codered pages
-    in the format of ("Custom Codered Page", "CustomCoderedPage")
+    in the format of (app_label:model, "Verbose Name")
     """
     from coderedcms.models import get_page_models
-    return (
-        (
-            page.__name__,
-            re.sub(
-                r'((?<=[a-z])[A-Z]|(?<!\A)[A-Z](?=[a-z]))',
-                r' \1',
-                page.__name__
-            )
-        ) for page in get_page_models() if page.is_creatable
-    )
+
+    rval = []
+    for page in get_page_models():
+        if page.is_creatable:
+            ct = ContentType.objects.get_for_model(page)
+            rval.append((f"{ct.app_label}:{ct.model}", ct.name))
+    return rval

coderedcms/importexport.py

@@ -1,22 +1,73 @@
+"""
+This code is largely copied or extended upon the now defunct
+``wagtailimportexport`` package.
+
+In the future we may want to build a more robust import/exporter for CSV files,
+or simply deprecate all of this functionality.
+
+See: https://github.com/torchbox/wagtail-import-export/
+"""
 import csv
 import copy
 
 from django import forms
 from django.apps import apps
 from django.contrib.contenttypes.models import ContentType
-from django.db import transaction
-
+from django.db import models, transaction
+from django.utils.translation import ugettext as _
+from modelcluster.models import get_all_child_relations
+from wagtail.admin.widgets import AdminPageChooser
 from wagtail.core.models import Page
 
-from wagtailimportexport.forms import ImportFromFileForm
-from wagtailimportexport.importing import update_page_references
-
 from coderedcms.forms import get_page_model_choices
 
 
-class ImportPagesFromCSVFileForm(ImportFromFileForm):
+class ImportPagesFromCSVFileForm(forms.Form):
+    """
+    Mostly copied from:
+    https://github.com/torchbox/wagtail-import-export/blob/master/wagtailimportexport/forms.py#L29
+    with addition of ``page_type``.
+    """
     page_type = forms.ChoiceField(choices=get_page_model_choices)
 
+    file = forms.FileField(label=_("File to import"))
+
+    parent_page = forms.ModelChoiceField(
+        queryset=Page.objects.all(),
+        widget=AdminPageChooser(can_choose_root=True, show_edit_link=False),
+        label=_("Destination parent page"),
+        help_text=_("Imported pages will be created as children of this page.")
+    )
+
+
+def update_page_references(model, pages_by_original_id):
+    """
+    Copied from:
+    https://github.com/torchbox/wagtail-import-export/blob/master/wagtailimportexport/importing.py#L67
+    """
+    for field in model._meta.get_fields():
+        if isinstance(field, models.ForeignKey) and issubclass(field.related_model, Page):
+            linked_page_id = getattr(model, field.attname)
+            try:
+                # see if the linked page is one of the ones we're importing
+                linked_page = pages_by_original_id[linked_page_id]
+            except KeyError:
+                # any references to pages outside of the import should be left unchanged
+                continue
+
+            # update fk to the linked page's new ID
+            setattr(model, field.attname, linked_page.id)
+
+    # update references within inline child models, including the ParentalKey pointing back
+    # to the page
+    for rel in get_all_child_relations(model):
+        for child in getattr(model, rel.get_accessor_name()).all():
+            # reset the child model's PK so that it will be inserted as a new record
+            # rather than updating an existing one
+            child.pk = None
+            # update page references on the child model, including the ParentalKey
+            update_page_references(child, pages_by_original_id)
+
 
 @transaction.atomic()
 def import_pages(import_data, parent_page):
@@ -69,7 +120,7 @@ def import_pages(import_data, parent_page):
             strict_fks=False
         )
         base_page = pages_by_original_id[specific_page.id]
-        specific_page.page_ptr = base_page
+        specific_page.base_page_ptr = base_page
         specific_page.__dict__.update(base_page.__dict__)
         specific_page.content_type = ContentType.objects.get_for_model(model)
         update_page_references(specific_page, pages_by_original_id)
@@ -80,7 +131,12 @@ def import_pages(import_data, parent_page):
 
 def convert_csv_to_json(csv_file, page_type):
     pages_json = {"pages": []}
-    default_page_data = {"app_label": "website", "content": {"pk": None}, "model": page_type}
+    app_label, klass = page_type.split(":")
+    default_page_data = {
+        "app_label": app_label,
+        "content": {"pk": None},
+        "model": klass,
+    }
 
     pages_csv_dict = csv.DictReader(csv_file)
     for row in pages_csv_dict:

coderedcms/models/page_models.py

@@ -554,17 +554,6 @@ def body_preview(self):
         preview = body[:200] + "..." if len(body) > 200 else body
         return mark_safe(preview)
 
-    @property
-    def page_ptr(self):
-        """
-        Overwrite of `page_ptr` to make it compatible with wagtailimportexport.
-        """
-        return self.base_page_ptr
-
-    @page_ptr.setter
-    def page_ptr(self, value):
-        self.base_page_ptr = value
-
 
 class CoderedArticlePage(CoderedWebPage):
     """

coderedcms/project_template/basic/project_name/settings/base.py

@@ -34,7 +34,6 @@
     'modelcluster',
     'taggit',
     'wagtailcache',
-    'wagtailimportexport',
     'wagtailseo',
 
     # Wagtail

coderedcms/project_template/sass/project_name/settings/base.py

@@ -33,7 +33,6 @@
     'modelcluster',
     'taggit',
     'wagtailcache',
-    'wagtailimportexport',
     'wagtailseo',
 
     # Wagtail

coderedcms/templates/wagtailimportexport/export_to_file.html

@@ -14,14 +14,24 @@
     {% include "wagtailadmin/shared/header.html" with title=title_str icon="download" %}
 
     <div class="nice-padding">
-        <form action="{% url 'import_from_csv' %}" enctype="multipart/form-data" method="POST" novalidate>
+        <form action="{% url 'import_from_csv' %}" enctype="multipart/form-data" method="POST">
             {% csrf_token %}
             <ul class="fields">
                 {% for field in form %}
                     {% include "wagtailadmin/shared/field_as_li.html" %}
                 {% endfor %}
             </ul>
 
+            <br>
+            <p>
+              <b>{% trans "IMPORTANT:" %}</b>
+              {% trans "CSV file must be in the correct format before importing." %}
+              <a href="https://docs.coderedcorp.com/wagtail-crx/features/import_export.html">
+                {% trans "Read the importing guide." %}
+              </a>
+            </p>
+            <br>
+
             <input type="submit" value="{% trans 'Import' %}" class="button">
         </form>
     </div>