[Fixes #14042] deprecate overwrite_existing_layers in favor of action… (#14043)

* [Fixes #14042] deprecate overwrite_existing_layers in favor of action usage

Author: mattiagiupponi

geonode/upload/api/serializer.py

@@ -51,12 +51,8 @@ class Meta:
         ref_name = "OverwriteImporterSerializer"
         model = ResourceBase
         view_name = "importer_upload"
-        fields = ImporterSerializer.Meta.fields + (
-            "overwrite_existing_layer",
-            "resource_pk",
-        )
+        fields = ImporterSerializer.Meta.fields + ("resource_pk",)
 
-    overwrite_existing_layer = serializers.BooleanField(required=True)
     resource_pk = serializers.IntegerField(required=True)
 
 

geonode/upload/celery_tasks.py

@@ -399,7 +399,7 @@ def publish_resource(
         )
         _exec = orchestrator.get_execution_object(execution_id)
         _files = _exec.input_params.get("files")
-        _overwrite = _exec.input_params.get("overwrite_existing_layer")
+        _overwrite = action == ira.REPLACE.value
 
         _publisher = DataPublisher(handler_module_path)
         kwargs.update({"exec_id": execution_id})
@@ -509,7 +509,7 @@ def create_geonode_resource(
         handler_module_path = handler_module_path or _exec.input_params.get("handler_module_path")
 
         handler = import_string(handler_module_path)()
-        _overwrite = _exec.input_params.get("overwrite_existing_layer")
+        _overwrite = action == ira.REPLACE.value
 
         if _overwrite:
             resource = handler.overwrite_geonode_resource(
@@ -975,7 +975,7 @@ def rollback(self, *args, **kwargs):
     )
 
     handler = import_string(handler_module_path)()
-    if exec_object.input_params.get("overwrite_existing_layer"):
+    if exec_object.action == ira.REPLACE.value:
         logger.warning("Rollback is skipped for the overwrite")
     else:
         handler.rollback(exec_id, rollback_from_step, action_to_rollback, *args, **kwargs)

geonode/upload/handlers/base.py

@@ -184,11 +184,25 @@ def perform_last_step(execution_id):
 
         return _exec
 
+    def evaluate_exec_prev_status(self, action, resource_pk=None):
+        """
+        Required to evaluate if the resource can be replaced/upsert
+        based on it's previous status. this is required for 3dtiles for example
+        but the handler can deny some operations on some resources
+        """
+        return True, None
+
     def pre_processing(self, files, execution_id, **kwargs):
         from geonode.upload.orchestrator import orchestrator
 
         _exec_obj = orchestrator.get_execution_object(execution_id)
         _data = _exec_obj.input_params.copy()
+
+        if _exec_obj.action in (ira.REPLACE.value, ira.UPSERT.value):
+            if resource_pk := _data.get("resource_pk"):
+                can_proceed, reason = self.evaluate_exec_prev_status(_exec_obj.action, resource_pk)
+                if not can_proceed:
+                    raise ImportException(reason)
         # unzipping the file
         if "zip_file" in files or "kmz_file" in files:
             # if a zipfile is provided, we need to unzip it before searching for an handler

geonode/upload/handlers/common/metadata.py

@@ -55,7 +55,6 @@ def extract_params_from_data(_data, action=None):
         return {
             "dataset_title": _data.pop("dataset_title", None),
             "skip_existing_layers": _data.pop("skip_existing_layers", "False"),
-            "overwrite_existing_layer": _data.pop("overwrite_existing_layer", False),
             "resource_pk": _data.pop("resource_pk", None),
             "store_spatial_file": _data.pop("store_spatial_files", "True"),
             "action": _data.pop("action"),

geonode/upload/handlers/common/raster.py

@@ -38,7 +38,7 @@
 from geonode.upload.handlers.utils import create_alternate, should_be_imported
 from geonode.upload.models import ResourceHandlerInfo
 from geonode.upload.orchestrator import orchestrator
-from geonode.upload.utils import find_key_recursively
+from geonode.upload.utils import find_key_recursively, ImporterRequestAction as ira
 from osgeo import gdal
 from geonode.upload.celery_app import importer_app
 from geonode.storage.manager import storage_manager
@@ -123,7 +123,6 @@ def extract_params_from_data(_data, action=None):
 
         return {
             "skip_existing_layers": _data.pop("skip_existing_layers", "False"),
-            "overwrite_existing_layer": _data.pop("overwrite_existing_layer", False),
             "resource_pk": _data.pop("resource_pk", None),
             "store_spatial_file": _data.pop("store_spatial_files", "True"),
             "action": _data.pop("action", "upload"),
@@ -276,7 +275,7 @@ def import_resource(self, files: dict, execution_id: str, **kwargs) -> str:
             # start looping on the layers available
             layer_name = self.fixup_name(filename)
 
-            should_be_overwritten = _exec.input_params.get("overwrite_existing_layer")
+            should_be_overwritten = _exec.action == ira.REPLACE.value
             # should_be_imported check if the user+layername already exists or not
             if should_be_imported(
                 layer_name,
@@ -318,7 +317,7 @@ def import_resource(self, files: dict, execution_id: str, **kwargs) -> str:
                         "geonode.upload.import_resource",
                         layer_name,
                         alternate,
-                        exa.UPLOAD.value,
+                        _input.get("action", exa.UPLOAD.value),
                     )
                 )
                 return layer_name, alternate, execution_id
@@ -350,7 +349,7 @@ def create_geonode_resource(
             getattr(settings, "CASCADE_WORKSPACE", "geonode"),
         )
 
-        _overwrite = _exec.input_params.get("overwrite_existing_layer", False)
+        _overwrite = _exec.action == ira.REPLACE.value
         # if the layer exists, we just update the information of the dataset by
         # let it recreate the catalogue
         if not saved_dataset.exists() and _overwrite:
@@ -398,7 +397,7 @@ def overwrite_geonode_resource(
 
         dataset = resource_type.objects.filter(alternate__icontains=alternate, owner=_exec.user)
 
-        _overwrite = _exec.input_params.get("overwrite_existing_layer", False)
+        _overwrite = _exec.action == ira.REPLACE.value
         # if the layer exists, we just update the information of the dataset by
         # let it recreate the catalogue
 

geonode/upload/handlers/common/remote.py

@@ -115,7 +115,6 @@ def extract_params_from_data(_data, action=None):
             "title": _data.pop("title", None),
             "url": _data.pop("url", None),
             "type": _data.pop("type", None),
-            "overwrite_existing_layer": _data.pop("overwrite_existing_layer", False),
         }, _data
 
     def pre_validation(self, files, execution_id, **kwargs):
@@ -144,7 +143,7 @@ def import_resource(self, files: dict, execution_id: str, **kwargs) -> str:
             # start looping on the layers available
             layer_name = self.fixup_name(title)
 
-            should_be_overwritten = _exec.input_params.get("overwrite_existing_layer")
+            should_be_overwritten = _exec.action == ira.REPLACE.value
 
             payload_alternate = params.get("remote_resource_id", None)
 
@@ -281,7 +280,7 @@ def overwrite_geonode_resource(
         _exec = self._get_execution_request_object(execution_id)
         resource = resource_type.objects.filter(alternate__icontains=alternate, owner=_exec.user)
 
-        _overwrite = _exec.input_params.get("overwrite_existing_layer", False)
+        _overwrite = _exec.action == ira.REPLACE.value
         # if the layer exists, we just update the information of the dataset by
         # let it recreate the catalogue
         if resource.exists() and _overwrite:

geonode/upload/handlers/common/serializer.py

@@ -27,7 +27,7 @@ class Meta:
         ref_name = "RemoteResourceSerializer"
         model = ResourceBase
         view_name = "importer_upload"
-        fields = ("url", "title", "type", "action", "overwrite_existing_layer")
+        fields = ("url", "title", "type", "action")
 
     url = serializers.URLField(required=True, help_text="URL of the remote service / resource")
     title = serializers.CharField(required=True, help_text="Title of the resource. Can be None or Empty")
@@ -36,5 +36,3 @@ class Meta:
         help_text="Remote resource type, for example wms or 3dtiles. Is used by the handler to understand if can handle the resource",
     )
     action = serializers.CharField(required=False, default=exa.UPLOAD.value)
-
-    overwrite_existing_layer = serializers.BooleanField(required=False, default=False)

geonode/upload/handlers/common/vector.py

@@ -193,7 +193,6 @@ def extract_params_from_data(_data, action=None):
 
         return {
             "skip_existing_layers": _data.pop("skip_existing_layers", "False"),
-            "overwrite_existing_layer": _data.pop("overwrite_existing_layer", False),
             "resource_pk": _data.pop("resource_pk", None),
             "store_spatial_file": _data.pop("store_spatial_files", "True"),
             "action": _data.pop("action", "upload"),
@@ -229,6 +228,17 @@ def pre_validation(self, files, execution_id, **kwargs):
         Maybe a file rename, assign the resource to the execution_id
         """
 
+    def evaluate_exec_prev_status(self, action, resource_pk):
+        if not resource_pk:
+            return True, None
+        res = ResourceBase.objects.filter(pk=resource_pk).first()
+        if not res:
+            return True, None
+        if res.subtype in ["3dtiles"] and action in (ira.REPLACE.value, ira.UPSERT.value):
+            reason = "Replace or Upsert are not possible on an existing 3Dtile"
+            return False, reason
+        return True, None
+
     def overwrite_geoserver_resource(self, resource, catalog, store, workspace):
         """
         We dont need to do anything for now.
@@ -456,7 +466,7 @@ def import_resource(self, files: dict, execution_id: str, **kwargs) -> str:
             for index, layer in enumerate(layers, start=1):
                 layer_name = self.fixup_name(layer.GetName())
 
-                should_be_overwritten = _exec.input_params.get("overwrite_existing_layer")
+                should_be_overwritten = _exec.action == ira.REPLACE.value
                 # should_be_imported check if the user+layername already exists or not
                 if (
                     should_be_imported(
@@ -790,7 +800,7 @@ def create_geonode_resource(
             getattr(settings, "CASCADE_WORKSPACE", "geonode"),
         )
 
-        _overwrite = _exec.input_params.get("overwrite_existing_layer", False)
+        _overwrite = _exec.action == ira.REPLACE.value
         # if the layer exists, we just update the information of the dataset by
         # let it recreate the catalogue
         if not saved_dataset.exists() and _overwrite:
@@ -843,7 +853,7 @@ def overwrite_geonode_resource(
 
         dataset = resource_type.objects.filter(pk=_exec.input_params.get("resource_pk"), owner=_exec.user)
 
-        _overwrite = _exec.input_params.get("overwrite_existing_layer", False)
+        _overwrite = _exec.action == ira.REPLACE.value
         # if the layer exists, we just update the information of the dataset by
         # let it recreate the catalogue
         if dataset.exists() and _overwrite:

geonode/upload/handlers/shapefile/handler.py

@@ -16,7 +16,6 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 #########################################################################
-import ast
 import json
 import logging
 import codecs
@@ -85,10 +84,7 @@ def has_serializer(data) -> bool:
         if data.get("action") == ira.UPSERT.value:
             return False
         if _base.endswith("shp") if isinstance(_base, str) else _base.name.endswith("shp"):
-            is_overwrite_flow = data.get("overwrite_existing_layer", False)
-            if isinstance(is_overwrite_flow, str):
-                is_overwrite_flow = ast.literal_eval(is_overwrite_flow.title())
-            return OverwriteShapeFileSerializer if is_overwrite_flow else ShapeFileSerializer
+            return OverwriteShapeFileSerializer if data.get("action") == ira.REPLACE.value else ShapeFileSerializer
         return False
 
     @staticmethod
@@ -103,7 +99,6 @@ def extract_params_from_data(_data, action=None):
 
         additional_params = {
             "skip_existing_layers": _data.pop("skip_existing_layers", "False"),
-            "overwrite_existing_layer": _data.pop("overwrite_existing_layer", False),
             "resource_pk": _data.pop("resource_pk", None),
             "store_spatial_file": _data.pop("store_spatial_files", "True"),
             "action": _data.pop("action", "upload"),

geonode/upload/handlers/shapefile/serializer.py

@@ -35,7 +35,6 @@ class Meta:
             "xml_file",
             "sld_file",
             "store_spatial_files",
-            "overwrite_existing_layer",
             "skip_existing_layers",
             "action",
         )
@@ -47,7 +46,6 @@ class Meta:
     xml_file = serializers.FileField(required=False)
     sld_file = serializers.FileField(required=False)
     store_spatial_files = serializers.BooleanField(required=False, default=True)
-    overwrite_existing_layer = serializers.BooleanField(required=False, default=False)
     skip_existing_layers = serializers.BooleanField(required=False, default=False)
     action = serializers.CharField(required=False, default=exa.UPLOAD.value)
 
@@ -57,10 +55,6 @@ class Meta:
         ref_name = "ShapeFileSerializer"
         model = ResourceBase
         view_name = "importer_upload"
-        fields = ShapeFileSerializer.Meta.fields + (
-            "overwrite_existing_layer",
-            "resource_pk",
-        )
+        fields = ShapeFileSerializer.Meta.fields + ("resource_pk",)
 
-    overwrite_existing_layer = serializers.BooleanField(required=True)
     resource_pk = serializers.IntegerField(required=True)