Add custom extent paramter to be used as default extent for generated projects

Author: nirvn

xlsformconverter/XLSFormConverter.py

@@ -85,6 +85,7 @@ class XLSFormConverter(QObject):
     preferred_language = None
     basemap = None
     crs = QgsCoordinateReferenceSystem("EPSG:3857")
+    extent = QgsRectangle()
     geometries = None
     groups_as_tabs = False
 
@@ -1020,7 +1021,13 @@ def set_basemap(self, basemap):
         self.basemap = basemap
 
     def set_crs(self, crs):
-        self.crs = crs
+        if crs.isValid():
+            self.crs = crs
+        else:
+            self.crs = QgsCoordinateReferenceSystem("EPSG:3857")
+
+    def set_extent(self, extent):
+        self.extent = extent
 
     def set_geometries(self, geometries):
         self.geometries = geometries
@@ -1647,7 +1654,9 @@ def convert(
                     )
                 )
 
-        if survey_extent:
+        if not self.extent.isEmpty():
+            survey_extent = self.extent
+        elif survey_extent:
             transform = QgsCoordinateTransform(
                 current_layer[0].crs(),
                 self.output_project.crs(),
@@ -1676,8 +1685,6 @@ def convert(
                 survey_extent = None
 
         if not survey_extent:
-            print("...")
-            print(self.output_project.crs().authid())
             if self.output_project.crs().authid() == "EPSG:3857":
                 survey_extent = QgsRectangle(-9.88, 33.41, 40.97, 61.11)
             else:
@@ -1710,10 +1717,7 @@ def convert(
                 self.output_project.crs(),
                 self.output_project.transformContext(),
             )
-            print(survey_extent)
             survey_extent = transform.transformBoundingBox(survey_extent)
-            print(survey_extent)
-            print("---")
 
         self.output_extent = survey_extent
 

xlsformconverter/XLSFormConverterAlgorithms.py

@@ -7,6 +7,7 @@
     QgsProcessingParameterCrs,
     QgsProcessingParameterDefinition,
     QgsProcessingParameterEnum,
+    QgsProcessingParameterExtent,
     QgsProcessingParameterFeatureSource,
     QgsProcessingParameterFile,
     QgsProcessingParameterFolderDestination,
@@ -37,6 +38,7 @@ class XLSFormConverterAlgorithm(QgsProcessingAlgorithm):
     GROUPS_AS_TABS = "GROUPS_AS_TABS"
     UPLOAD_TO_QFIELDCLOUD = "UPLOAD_TO_QFIELDCLOUD"
     CRS = "CRS"
+    EXTENT = "EXTENT"
     GEOMETRIES = "GEOMETRIES"
     OUTPUT = "OUTPUT"
 
@@ -133,6 +135,14 @@ def initAlgorithm(self, config=None):
         param.setFlags(param.flags() | QgsProcessingParameterDefinition.Flag.Advanced)
         self.addParameter(param)
 
+        param = QgsProcessingParameterExtent(
+            self.EXTENT,
+            self.tr("Project extent"),
+            optional=True,
+        )
+        param.setFlags(param.flags() | QgsProcessingParameterDefinition.Flag.Advanced)
+        self.addParameter(param)
+
         param = QgsProcessingParameterFeatureSource(
             self.GEOMETRIES,
             self.tr(
@@ -156,6 +166,7 @@ def processAlgorithm(self, parameters, context, feedback):
         title = self.parameterAsString(parameters, self.TITLE, context)
         language = self.parameterAsString(parameters, self.LANGUAGE, context)
         crs = self.parameterAsCrs(parameters, self.CRS, context)
+        extent = self.parameterAsExtent(parameters, self.EXTENT, context, crs)
         geometries = self.parameterAsSource(parameters, self.GEOMETRIES, context)
 
         basemap = "OpenStreetMap"
@@ -185,8 +196,14 @@ def processAlgorithm(self, parameters, context, feedback):
         converter.set_basemap(basemap)
         converter.set_geometries(geometries)
         converter.set_groups_as_tabs(groups_as_tabs)
-        if crs.isValid():
-            converter.set_crs(crs)
+        converter.set_crs(crs)
+        converter.set_extent(extent)
+        if not crs.isValid() and not extent.isEmpty():
+            feedback.pushWarning(
+                self.tr(
+                    "Project extent parameter ignored, a required project CRS parameter is missing."
+                )
+            )
 
         project_file = converter.convert(output_directory)