class MapViewSet(DynamicModelViewSet):
"""
API endpoint that allows maps to be viewed or edited.
"""
authentication_classes = [
SessionAuthentication, BasicAuthentication, OAuth2Authentication
]
permission_classes = [IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly]
filter_backends = [
DynamicFilterBackend, DynamicSortingFilter, DynamicSearchFilter,
ExtentFilter, MapPermissionsFilter
]
queryset = Map.objects.all().order_by('-date')
serializer_class = MapSerializer
pagination_class = GeoNodeApiPagination
@extend_schema(
methods=['get'],
responses={200: MapLayerSerializer(many=True)},
description="API endpoint allowing to retrieve the MapLayers list.")
@action(detail=True, methods=['get'])
def datasets(self, request, pk=None):
map = self.get_object()
resources = map.datasets
return Response(
MapLayerSerializer(embed=True,
many=True).to_representation(resources))
@extend_schema(
methods=['get'],
responses={200: DatasetSerializer(many=True)},
description="API endpoint allowing to retrieve the local MapLayers.")
@action(detail=True, methods=['get'])
def local_datasets(self, request, pk=None):
map = self.get_object()
resources = map.local_datasets
return Response(
DatasetSerializer(embed=True,
many=True).to_representation(resources))
def perform_create(self, serializer):
if serializer.is_valid():
hookset().perform_create(self, serializer)
return serializer
def perform_update(self, serializer):
""" Associate current user as task owner """
if serializer.is_valid():
hookset().perform_update(self, serializer)
return serializer
class MapViewSet(DynamicModelViewSet):
"""
API endpoint that allows maps to be viewed or edited.
"""
http_method_names = ['get', 'patch', 'post', 'put']
authentication_classes = [
SessionAuthentication, BasicAuthentication, OAuth2Authentication
]
permission_classes = [IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly]
filter_backends = [
DynamicFilterBackend,
DynamicSortingFilter,
DynamicSearchFilter,
ExtentFilter,
MapPermissionsFilter,
]
queryset = Map.objects.all().order_by('-last_updated')
serializer_class = MapSerializer
pagination_class = GeoNodeApiPagination
def list(self, request, *args, **kwargs):
# Avoid overfetching removing mapslayer of the list.
request.query_params.add("exclude[]", "maplayers")
return super(MapViewSet, self).list(request, *args, **kwargs)
@transaction.atomic
def update(self, request, *args, **kwargs):
"""
Changes in the m2m `maplayers` are committed before object changes.
To protect the db, this action is done within an atomic tansation.
"""
return super(MapViewSet, self).update(request, *args, **kwargs)
@transaction.atomic
def create(self, request, *args, **kwargs):
"""
Changes in the m2m `maplayers` are committed before object changes.
To protect the db, this action is done within an atomic tansation.
"""
return super(MapViewSet, self).create(request, *args, **kwargs)
@extend_schema(
methods=["get"],
responses={200: MapLayerSerializer(many=True)},
description="API endpoint allowing to retrieve the MapLayers list.",
)
@action(detail=True, methods=["get"])
def maplayers(self, request, pk=None):
map = self.get_object()
resources = map.maplayers
return Response(
MapLayerSerializer(embed=True,
many=True).to_representation(resources))
@extend_schema(
methods=["get"],
responses={200: DatasetSerializer(many=True)},
description="API endpoint allowing to retrieve the local MapLayers.",
)
@action(detail=True, methods=["get"])
def datasets(self, request, pk=None):
map = self.get_object()
resources = map.datasets
return Response(
DatasetSerializer(embed=True,
many=True).to_representation(resources))
def perform_create(self, serializer):
# Thumbnail will be handled later
post_creation_data = {
"thumbnail": serializer.validated_data.pop("thumbnail_url", "")
}
instance = serializer.save(
owner=self.request.user,
resource_type="map",
uuid=str(uuid4()),
)
# events and resouce routines
self._post_change_routines(
instance=instance,
create_action_perfomed=True,
additional_data=post_creation_data,
)
# Handle thumbnail generation
resource_manager.set_thumbnail(instance.uuid,
instance=instance,
overwrite=False)
def perform_update(self, serializer):
# Check instance permissions with resolve_object
mapid = serializer.instance.id
key = "urlsuffix" if Map.objects.filter(
urlsuffix=mapid).exists() else "pk"
map_obj = resolve_object(self.request,
Map, {key: mapid},
permission="base.change_resourcebase",
permission_msg=_PERMISSION_MSG_SAVE)
instance = serializer.instance
if instance != map_obj:
raise ValidationError()
# Thumbnail will be handled later
post_change_data = {
"thumbnail":
serializer.validated_data.pop("thumbnail_url", ""),
"dataset_names_before_changes":
[lyr.alternate for lyr in instance.datasets],
}
instance = serializer.save()
# thumbnail, events and resouce routines
self._post_change_routines(
instance=instance,
create_action_perfomed=False,
additional_data=post_change_data,
)
def _post_change_routines(self, instance: Map,
create_action_perfomed: bool,
additional_data: dict):
# Step 1: Handle Maplayers signals if this is and update action
if not create_action_perfomed:
dataset_names_before_changes = additional_data.pop(
"dataset_names_before_changes", [])
dataset_names_after_changes = [
lyr.alternate for lyr in instance.datasets
]
if dataset_names_before_changes != dataset_names_after_changes:
map_changed_signal.send_robust(sender=instance,
what_changed="datasets")
# Step 2: Register Event
event_type = EventType.EVENT_CREATE if create_action_perfomed else EventType.EVENT_CHANGE
register_event(self.request, event_type, instance)
# Step 3: Resource Manager
resource_manager.update(instance.uuid, instance=instance, notify=True)
def datasets(self, request, pk=None):
map = self.get_object()
resources = map.datasets
return Response(
DatasetSerializer(embed=True,
many=True).to_representation(resources))