Merge pull request #3958 from GeotrekCE/feat_cirkwi_filter_eids

✨ [FEAT] Add  filter to Cirkwi trek exports (refs #3947)

docs/changelog.rst

@@ -5,6 +5,11 @@ CHANGELOG
 2.102.1+dev (XXXX-XX-XX)
 ------------------------
 
+**New features**
+
+- Add `include_externals` filter to Cirkwi trek exports, to allow excluding treks with an external id (eid) (#3947)
+
+
 2.102.1 (2024-02-20)
 --------------------
 

docs/usage/externals-apis.rst

@@ -23,7 +23,10 @@ Il est également possible de filtrer les randonnées du flux par structure et p
 ou ``?portals=<identifian_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?portals=3``).
 Tout comme les pois Vous pouvez filtrer avec plusieurs structures et portails : en séparant les identifiants par des virgules.
 
-Il est possible de filtrer les randonnées par portail et structure en même temps en séparant les 2 filtres par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1``).
+Il est également possible d'exclure du flux les randonnées provenant de sources externes à Geotrek-Admin. Ce filtre est notamment nécessaire pour
+ne pas renvoyer à Cirkwi les randonnées qui en proviennent déjà. Pour cela, ajouter le paramètre ``?include_externals=false`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?include_externals=false``).
+
+Il est possible de cumuler ces différents filtres, en séparant les valeurs par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1&include_externals=false``).
 
 Le référentiel CIRKWI a été intégré dans 3 tables accessibles dans l'Adminsite (à ne pas modifier) :
 

geotrek/cirkwi/filters.py

@@ -1,4 +1,7 @@
+from django.db.models.query_utils import Q
 from django_filters import FilterSet
+from django_filters.filters import BooleanFilter
+
 from geotrek.authent.models import Structure
 from geotrek.common.filters import ComaSeparatedMultipleModelChoiceFilter
 from geotrek.common.models import TargetPortal
@@ -19,6 +22,12 @@ class CirkwiTrekFilterSet(FilterSet):
                                                         queryset=Structure.objects.all())
     portals = ComaSeparatedMultipleModelChoiceFilter(field_name='portal', required=False,
                                                      queryset=TargetPortal.objects.all())
+    include_externals = BooleanFilter(field_name='eid', method='filter_include_externals', required=False)
+
+    def filter_include_externals(self, queryset, name, value):
+        if not value:
+            return queryset.filter(Q(eid__isnull=True) | Q(eid__exact=''))
+        return queryset
 
     class Meta:
         model = Trek

geotrek/cirkwi/tests/test_filters.py

@@ -2,13 +2,11 @@
 from django.contrib.gis.geos import LineString, Point
 from django.test import TestCase
 
-from geotrek.common.tests.factories import TargetPortalFactory
-
 from geotrek.authent.tests.factories import StructureFactory
+from geotrek.cirkwi.filters import CirkwiPOIFilterSet, CirkwiTrekFilterSet
+from geotrek.common.tests.factories import TargetPortalFactory
 from geotrek.core.tests.factories import PathFactory
-
 from geotrek.trekking.tests.factories import POIFactory, TrekFactory
-from geotrek.cirkwi.filters import CirkwiPOIFilterSet, CirkwiTrekFilterSet
 
 
 class CirkwiFilterTest(TestCase):
@@ -46,6 +44,19 @@ def test_trek_filters_portals(self):
         qs = CirkwiTrekFilterSet(data={"portals": 'a'}).qs
         self.assertEqual(qs.count(), 1)
 
+    def test_treks_include_externals(self):
+        self.trek.eid = "test_eid"
+        self.trek.save()
+        # Treks with eid are not excluded by default
+        qs = CirkwiTrekFilterSet().qs
+        self.assertEqual(qs.count(), 1)
+        # Treks with eid are not excluded
+        qs = CirkwiTrekFilterSet(data={"include_externals": "true"}).qs
+        self.assertEqual(qs.count(), 1)
+        # Treks with eid are excluded
+        qs = CirkwiTrekFilterSet(data={"include_externals": "false"}).qs
+        self.assertEqual(qs.count(), 0)
+
     def test_poi_filters_structures(self):
         other_structure = StructureFactory.create()
         qs = CirkwiPOIFilterSet(data={"structures": f'{self.poi.structure.pk}'}).qs

geotrek/cirkwi/views.py

@@ -1,9 +1,10 @@
 from django.http import HttpResponse
-
 from django.views.generic import ListView
-from geotrek.trekking.models import Trek, POI
+
 from geotrek.cirkwi.filters import CirkwiPOIFilterSet, CirkwiTrekFilterSet
-from geotrek.cirkwi.serializers import CirkwiTrekSerializer, CirkwiPOISerializer
+from geotrek.cirkwi.serializers import (CirkwiPOISerializer,
+                                        CirkwiTrekSerializer)
+from geotrek.trekking.models import POI, Trek
 
 
 class CirkwiTrekView(ListView):