Fix upload .qgz project file (#544)

* Create temporary .qgz file.

* Typo.

* Remove django-file-form temporary file.

* Add test for qgz.

* Add test for qgz.

---------

Co-authored-by: wlorenzetti <lorenzett@gis3w.it>

g3w-admin/core/forms.py

@@ -225,7 +225,6 @@ def __init__(self, *args, **kwargs):
                             'suite_logo',
                             'form_id',
                             'upload_url',
-                            'delete_url',
                             HTML(
                                 """{% if form.suite_logo.value %}<img class="img-responsive img-thumbnail" src="{{ MEDIA_URL }}{{ form.suite_logo.value }}">{% endif %}""", ),
                             PrependedText('url_suite_logo', '<i class="fa fa-link"></i>'),

g3w-admin/core/views.py

@@ -158,7 +158,7 @@ def get_success_url(self):
     def form_valid(self, form):
         res = super(GroupCreateView, self).form_valid(form)
 
-        # delete tempory file form files
+        # delete temporary file form files
         form.delete_temporary_files()
         return res
 
@@ -352,6 +352,14 @@ def get_object(self, queryset=None):
     def get_success_url(self):
         return reverse('home')
 
+    def form_valid(self, form):
+        res = super().form_valid(form)
+
+        # Delete django-file-form temporary files
+        form.delete_temporary_files()
+
+        return res
+
 
 # for MACROGROUPS
 # ---------------------------------------------

g3w-admin/qdjango/forms/projects.py

@@ -1,3 +1,5 @@
+import os
+
 from qgis.core import QgsProject
 import re
 import zipfile
@@ -28,6 +30,8 @@
 from qdjango.utils.data import QgisProject
 from qdjango.utils.validators import ProjectExists
 
+import shutil
+
 
 class QdjangoProjectFormMixin(object):
     """
@@ -59,8 +63,12 @@ def clean_qgis_file(self):
                 qgis_file = ContentFile(zfile.open(
                     qzfile, 'r').read(), name=qzfile)
 
-                # Update path property for QGIS api
-                qgis_file.path = self.cleaned_data['qgis_file'].file.path
+                # For QGIS Python API to recognize a .qgz file type, the file must have the extension `.qgz`
+                # So with current django-file-form version (3.5.0) is necessary make a copy of temporary file uploaded
+                # adding the .qgz extension
+                qgis_file.path = f"{self.cleaned_data['qgis_file'].file.path}.qgz"
+                shutil.copy(self.cleaned_data['qgis_file'].file.path, qgis_file.path)
+
 
             if self.instance.pk:
                 kwargs['instance'] = self.instance
@@ -75,6 +83,11 @@ def clean_qgis_file(self):
 
             self.qgisProject = QgisProject(qgis_file, **kwargs)
             self.qgisProject.clean()
+
+            # Delete the .qgz copy
+            if file_extension.lower() == '.qgz':
+                os.remove(qgis_file.path)
+
         except Exception as e:
             raise ValidationError(str(e))
         return qgis_file
@@ -194,7 +207,6 @@ def __init__(self, *args, **kwargs):
                             'qgis_file-uploads',
                             'form_id',
                             'upload_url',
-                            'delete_url',
                             css_class='box-body',
 
                         ),

g3w-admin/qdjango/mixins/views.py

@@ -17,6 +17,10 @@ def form_valid(self, form):
         form.qgisProject.save(**form.cleaned_data)
         if not form.instance.pk:
             form.instance = form.qgisProject.instance
+
+        # Delete django-file-form temporary files
+        form.delete_temporary_files()
+
         form.save()
         return HttpResponseRedirect(self.get_success_url())
 

g3w-admin/qdjango/tests/test_forms.py

@@ -19,7 +19,7 @@
 from core.models import MapControl, ProjectMapUrlAlias
 from core.forms import GroupForm
 from .base import QdjangoTestBase, G3W_VIEWER1
-from .utils import create_dff_project
+from .utils import create_dff_project, create_dff_project_qgz
 from editing.models import EDITING_ATOMIC_PERMISSIONS
 from copy import copy
 
@@ -254,3 +254,28 @@ def test_qdjango_project_form(self):
         self.assertTrue(new_viewer.has_perm('qdjango.view_project', p))
 
 
+        # TEST UPLOAD QGZ PROJECT FILE
+        # =================================================
+
+        # upload qgis_file
+        uf = create_dff_project_qgz('qgis_file')
+
+        # Test Create
+        # =========================================
+
+        form_data = {
+            'form_id': uf.form_id,
+            'feature_count_wms': 10,
+            'multilayer_query': 'single',
+            'multilayer_querybybbox': 'single',
+            'multilayer_querybypolygon': 'single',
+            'toc_tab_default': 'layers',
+            'toc_layers_init_status': 'not_collapsed',
+            'toc_themes_init_status': 'collapsed',
+            'legend_position': 'tab',
+            'url_alias': 'test_url_alias_name_qgz'
+        }
+
+        form = QdjangoProjectForm(request=self.request, group=self.project_group, data=form_data)
+        self.assertTrue(form.is_valid())
+

g3w-admin/qdjango/tests/utils.py

@@ -44,6 +44,30 @@ def create_dff_project(field_name, original_filename=None):
 
     return uf
 
+def create_dff_project_qgz(field_name, original_filename=None):
+    """
+    Create a fake record django_file_form qgis project (.qgz) for form using it
+    :param field_name:
+    :param original_filename:
+    :return: UploadedFile model object
+    """
+
+    project = open('{}test_qgz_project_328.qgz'.format(CURRENT_PATH + TEST_BASE_PATH), 'rb')
+
+    form_id = uuid.uuid4()
+    file_id=uuid.uuid4()
+
+    uf = UploadedFile(
+        form_id=form_id,
+        file_id=file_id,
+        field_name=field_name,
+        original_filename=original_filename if original_filename else 'test_qgz_project_328.qgz',
+        uploaded_file=File(project, name='test_qgz_project_328.qgz')
+    )
+    uf.save()
+
+    return uf
+
 
 def clear_dff_project():
     """

requirements.txt

@@ -3,7 +3,7 @@ django-formtools==2.2
 django-crispy-forms==1.8.1
 django-extensions==3.1.5
 #---------------------------------------------------------------------------
-# django-file-form: to replace with PyPi version where thi patch is present:
+# django-file-form: to replace with PyPi version where this patch is present:
 # https://github.com/mbraak/django-file-form/pull/638
 git+https://github.com/gis3w/django-file-form.git@fix_filefield_not_required
 #---------------------------------------------------------------------------