New OpenAir export format for aerial sensitive areas (#2372)

docs/changelog.rst

@@ -15,6 +15,9 @@ CHANGELOG
 - Fix missing update rights for Infrastructure Condition and Infrastructure Type with no structure in Admin Site (#3747)
 - Allow to load a signage with the year set to None, raise error if set to NaN (#3611)
 
+**New features**
+
+- Sensitivity: Add ``openair`` export format for aerial sensitive areas (#2372)
 
 2.100.2 (2023-09-12)
 ------------------------

geotrek/api/tests/test_v2.py

@@ -9,7 +9,7 @@
                                      Point, Polygon)
 from django.contrib.gis.geos.collections import GeometryCollection
 from django.db import connection
-from django.test.testcases import TestCase
+from django.test import TestCase, RequestFactory
 from django.test.utils import override_settings
 from django.urls import reverse
 from django.utils import timezone
@@ -18,6 +18,7 @@
 from rest_framework.test import APITestCase
 
 from geotrek import __version__
+from geotrek.api.v2.views.trekking import TrekViewSet
 from geotrek.authent import models as authent_models
 from geotrek.authent.tests import factories as authent_factory
 from geotrek.common import models as common_models
@@ -55,6 +56,10 @@
     'count', 'next', 'previous', 'features', 'type'
 ])
 
+GEOJSON_COLLECTION_STRUCTURE = sorted([
+    'features', 'type',
+])
+
 GEOJSON_STRUCTURE = sorted([
     'geometry',
     'type',
@@ -167,8 +172,9 @@
 
 SENSITIVE_AREA_PROPERTIES_JSON_STRUCTURE = sorted([
     'id', 'contact', 'create_datetime', 'description', 'elevation', 'geometry',
-    'info_url', 'kml_url', 'name', 'period', 'practices', 'provider', 'published', 'species_id',
-    'structure', 'update_datetime', 'url', 'attachments', 'rules'
+    'info_url', 'kml_url', 'openair_url', 'name', 'period', 'practices', 'provider',
+    'published', 'species_id', 'structure', 'update_datetime', 'url', 'attachments',
+    'rules'
 ])
 
 SENSITIVE_AREA_SPECIES_PROPERTIES_JSON_STRUCTURE = sorted([
@@ -818,6 +824,51 @@ def get_hdviewpoint_detail(self, id_hdviewpoint, params=None):
         return self.client.get(reverse('apiv2:hdviewpoint-detail', args=(id_hdviewpoint,)), params)
 
 
+class NoPaginationTestCase(BaseApiTest):
+    """
+    Integration tests for disabled pagination.
+    """
+
+    def setUp(self):
+        self.factory = RequestFactory()
+
+    def test_json_no_page(self):
+        request = self.factory.get(
+            reverse("apiv2:trek-list"),
+            {
+                "no_page": "true",
+            }
+        )
+        response = TrekViewSet.as_view({"get": "list"})(request)
+        self.assertEqual(response.status_code, 200)
+        self.assertIsInstance(response.data, list)
+        self.assertIsInstance(response.data[0], dict)
+        self.assertEqual(
+            len(response.data[0].get("geometry").get("coordinates")[0]),
+            3,
+        )
+
+    def test_geojson_no_page(self):
+        request = self.factory.get(
+            reverse("apiv2:trek-list"),
+            {
+                "no_page": "true",
+                "format": "geojson",
+            }
+        )
+        response = TrekViewSet.as_view({"get": "list"})(request)
+        self.assertEqual(response.status_code, 200)
+        self.assertIsInstance(response.data, dict)
+        self.assertEqual(sorted(response.data.keys()), GEOJSON_COLLECTION_STRUCTURE)
+        self.assertEqual(
+            len(response.data.get("features")), self.nb_treks, response.data
+        )
+        self.assertEqual(
+            sorted(response.data.get("features")[0].get("properties").keys()),
+            TREK_PROPERTIES_GEOJSON_STRUCTURE,
+        )
+
+
 class APIAccessAnonymousTestCase(BaseApiTest):
     """ TestCase for anonymous API profile """
 

geotrek/api/v2/pagination.py

@@ -31,3 +31,8 @@ def get_paginated_response(self, data):
             ]))
         else:
             return super().get_paginated_response(data)
+
+    def paginate_queryset(self, queryset, request, view=None):
+        if 'no_page' in request.query_params:
+            return None
+        return super().paginate_queryset(queryset, request, view)

geotrek/api/v2/serializers.py

@@ -954,6 +954,7 @@ class SensitiveAreaSerializer(DynamicFieldsMixin, TimeStampedSerializer):
         geometry = geo_serializers.GeometryField(read_only=True, source="geom_transformed", precision=7)
         species_id = serializers.SerializerMethodField()
         kml_url = serializers.SerializerMethodField()
+        openair_url = serializers.SerializerMethodField(read_only=True)
         rules = RuleSerializer(many=True)
         attachments = AttachmentSerializer(many=True)
 
@@ -978,11 +979,19 @@ def get_kml_url(self, obj):
             url = reverse('sensitivity:sensitivearea_kml_detail', kwargs={'lang': get_language(), 'pk': obj.pk})
             return build_url(self, url)
 
+        def get_openair_url(self, obj):
+            is_aerial = obj.species.practices.filter(name__in=settings.SENSITIVITY_OPENAIR_SPORT_PRACTICES).exists()
+            if is_aerial:
+                url = reverse('sensitivity:sensitivearea_openair_detail', kwargs={'lang': get_language(), 'pk': obj.pk})
+                return self.context['request'].build_absolute_uri(url)
+            else:
+                return None
+
         class Meta(TimeStampedSerializer.Meta):
             model = sensitivity_models.SensitiveArea
             fields = TimeStampedSerializer.Meta.fields + (
                 'id', 'contact', 'description', 'elevation',
-                'geometry', 'info_url', 'kml_url', 'name', 'period',
+                'geometry', 'info_url', 'kml_url', 'openair_url', 'name', 'period',
                 'practices', 'published', 'species_id', 'provider', 'structure',
                 'url', 'attachments', 'rules'
             )

geotrek/sensitivity/helpers.py

@@ -0,0 +1,39 @@
+from datetime import date
+from calendar import monthrange
+
+
+def openair_atimes(month: int) -> str:
+    """Format month number to OpenAir ATime item
+
+    :param month: Months (1-12)
+    :type month: int
+    :return: ATimes item
+    :rtype: str
+    """
+    year = date.today().year
+    str_lmonth = str(monthrange(year, month)[1]).zfill(2)
+    str_month = str(month).zfill(2)
+    tpl = '"{m}": ["UTC(01/{str_month}->{str_lmonth}/{str_month})", "ANY(00:00->23:59)"]'
+    return tpl.format(m=str(month), str_month=str_month, str_lmonth=str_lmonth)
+
+
+def openair_atimes_concat(row) -> str:
+    months_fields = [
+        row.species.period01,
+        row.species.period02,
+        row.species.period03,
+        row.species.period04,
+        row.species.period05,
+        row.species.period06,
+        row.species.period07,
+        row.species.period08,
+        row.species.period09,
+        row.species.period10,
+        row.species.period11,
+        row.species.period12,
+    ]
+    aatimes_list = []
+    for i in range(12):
+        if months_fields[i]:
+            aatimes_list.append(openair_atimes(i + 1))
+    return '{{{{{}}}}}'.format(','.join(aatimes_list))

geotrek/sensitivity/locale/de/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-02-14 14:36+0100\n"
+"POT-Creation-Date: 2023-09-06 15:28+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -186,3 +186,6 @@ msgstr ""
 
 msgid "Invalid geometry value."
 msgstr ""
+
+msgid "This is not an aerial area"
+msgstr ""

geotrek/sensitivity/locale/en/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-02-14 14:36+0100\n"
+"POT-Creation-Date: 2023-09-06 15:28+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -186,3 +186,6 @@ msgstr ""
 
 msgid "Invalid geometry value."
 msgstr ""
+
+msgid "This is not an aerial area"
+msgstr ""

geotrek/sensitivity/locale/es/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-02-14 14:36+0100\n"
+"POT-Creation-Date: 2023-09-06 15:28+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -186,3 +186,6 @@ msgstr ""
 
 msgid "Invalid geometry value."
 msgstr ""
+
+msgid "This is not an aerial area"
+msgstr ""

geotrek/sensitivity/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-02-14 14:36+0100\n"
+"POT-Creation-Date: 2023-09-06 15:28+0200\n"
 "PO-Revision-Date: 2020-04-22 07:48+0000\n"
 "Last-Translator: Emmanuelle Helly <[email protected]>\n"
 "Language-Team: French <https://weblate.makina-corpus.net/projects/geotrek-"
@@ -187,3 +187,6 @@ msgstr "Ajouter une zone réglementaire"
 
 msgid "Invalid geometry value."
 msgstr "Valeur de géométrie invalide"
+
+msgid "This is not an aerial area"
+msgstr "Ce n'est pas une zone à enjeux aériens"

geotrek/sensitivity/locale/it/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-02-14 14:36+0100\n"
+"POT-Creation-Date: 2023-09-06 15:28+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -186,3 +186,6 @@ msgstr ""
 
 msgid "Invalid geometry value."
 msgstr ""
+
+msgid "This is not an aerial area"
+msgstr ""

geotrek/sensitivity/locale/nl/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-02-14 14:36+0100\n"
+"POT-Creation-Date: 2023-09-06 15:28+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -186,3 +186,6 @@ msgstr ""
 
 msgid "Invalid geometry value."
 msgstr ""
+
+msgid "This is not an aerial area"
+msgstr ""

geotrek/sensitivity/models.py

@@ -4,20 +4,25 @@
 
 import datetime
 import simplekml
-
+import logging
 from django.conf import settings
 from django.contrib.gis.db import models
 from django.contrib.gis.geos import GEOSGeometry, Polygon
 from django.utils.translation import pgettext_lazy, gettext_lazy as _
 
 from mapentity.serializers import plain_text
+from pyopenair.factory import wkt2openair
+
 from geotrek.authent.models import StructureRelated
 from geotrek.common.mixins.models import (OptionalPictogramMixin, NoDeleteMixin, TimeStampedModelMixin,
                                           AddPropertyMixin, GeotrekMapEntityMixin, get_uuid_duplication)
 from geotrek.common.utils import intersecting, classproperty, queryset_or_model
 from geotrek.sensitivity.managers import SensitiveAreaManager
+from geotrek.sensitivity.helpers import openair_atimes_concat
 from geotrek.core.models import simplify_coords
 
+logger = logging.getLogger(__name__)
+
 
 class Rule(TimeStampedModelMixin, OptionalPictogramMixin):
     code = models.CharField(verbose_name=_("Code"), max_length=50, unique=True, blank=True, null=True)
@@ -218,6 +223,34 @@ def kml(self):
         line.style.linestyle.width = 4  # pixels
         return kml.kml()
 
+    def openair(self):
+        """Exports sensitivearea into OpenAir format"""
+        geom = self.geom
+        if geom.geom_type == 'Point':
+            geom = geom.buffer(self.species.radius or settings.SENSITIVITY_DEFAULT_RADIUS, 4)
+        geom = geom.transform(4326, clone=True)
+        geom = geom.simplify(0.001, preserve_topology=True)
+        other = {}
+        other['*AUID'] = f"GUId=! UId=! Id=(Identifiant-GeoTrek-sentivity) {str(self.pk)}"
+        adescr = (self.species.name,)
+        if self.publication_date:
+            adescr += (f"(published on {self.publication_date.strftime('%d/%m/%Y')})",)
+        other['*ADescr'] = " ".join(adescr)
+        other['*ATimes'] = openair_atimes_concat(self)
+        wkt = geom.wkt
+        data = {
+            'wkt': wkt,
+            'an': self.species.name,
+            'ac': 'ZSM',
+            'ah_unit': 'm',
+            'ah_alti': self.species.radius or settings.SENSITIVITY_DEFAULT_RADIUS,
+            'ah_mode': 'AGL',
+            'al_mode': 'SFC',
+            # 'comment': self.species.name + ' (published on '+self.publication_date.strftime("%d/%m/%Y")+')',
+            'other': other
+        }
+        return wkt2openair(**data)
+
     def is_public(self):
         return self.published
 

geotrek/sensitivity/serializers.py

@@ -57,15 +57,22 @@ class Meta(MapentityGeojsonModelSerializer.Meta):
 class SensitiveAreaAPISerializer(TranslatedModelSerializer):
     species = SpeciesSerializer()
     kml_url = rest_serializers.SerializerMethodField()
+    openair_url = rest_serializers.SerializerMethodField()
     attachments = AttachmentSerializer(many=True)
     rules = RuleSerializer(many=True)
 
     def get_kml_url(self, obj):
         return reverse('sensitivity:sensitivearea_kml_detail', kwargs={'lang': get_language(), 'pk': obj.pk})
 
+    def get_openair_url(self, obj):
+        return reverse('sensitivity:sensitivearea_openair_detail', kwargs={'lang': get_language(), 'pk': obj.pk})
+
     class Meta:
         model = sensitivity_models.SensitiveArea
-        fields = ('id', 'species', 'description', 'contact', 'published', 'publication_date', 'kml_url', 'attachments', 'rules')
+        fields = (
+            'id', 'species', 'description', 'contact', 'published', 'publication_date',
+            'kml_url', 'openair_url', 'attachments', 'rules'
+        )
 
 
 class SensitiveAreaAPIGeojsonSerializer(GeoFeatureModelSerializer, SensitiveAreaAPISerializer):

geotrek/sensitivity/tests/factories.py

@@ -42,7 +42,7 @@ def practices(obj, create, extracted=None, **kwargs):
             if not extracted:
                 practices = [
                     SportPracticeFactory.create(name="Practice1"),
-                    SportPracticeFactory.create(name="Practice2")
+                    SportPracticeFactory.create(name="Practice2"),
                 ]
             for practice in practices:
                 obj.practices.add(practice)

geotrek/sensitivity/tests/test_functional.py

@@ -29,11 +29,13 @@ def get_expected_geojson_attrs(self):
         }
 
     def get_expected_json_attrs(self):
+
         return {
             'attachments': [],
             'contact': '<a href="mailto:[email protected]">[email protected]</a>',
             'description': 'Blabla',
             'kml_url': '/api/en/sensitiveareas/{}.kml'.format(self.obj.pk),
+            'openair_url': '/api/en/sensitiveareas/{}/openair'.format(self.obj.pk),
             'publication_date': '2020-03-17',
             'published': True,
             'rules': [
@@ -127,6 +129,7 @@ def get_expected_json_attrs(self):
             'contact': '<a href="mailto:[email protected]">[email protected]</a>',
             'description': 'Blabla',
             'kml_url': '/api/en/sensitiveareas/{}.kml'.format(self.obj.pk),
+            'openair_url': '/api/en/sensitiveareas/{}/openair'.format(self.obj.pk),
             'publication_date': '2020-03-17',
             'published': True,
             'rules': [