✨ Add new geocoding provider: Bing

g3w-admin/base/settings/base_geo_settings.py

@@ -46,3 +46,15 @@
   }
 }
 
+# Geocoding providers
+GEOCONDING_PROVIDERS = {
+  "nominatim": {
+    "label": "Nominatim (OSM)",
+    "url": "https://nominatim.openstreetmap.org/search"
+  },
+  "bing": {
+    "label": "Bing",
+    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/"
+  }
+}
+

g3w-admin/client/tests/test_api.py

@@ -134,7 +134,7 @@ def testGroupConfigApiView(self):
             'extent': [-180.0, -90.0, 180.0, 90.0]
         })
         print(resp["group"]["mapcontrols"])
-        self.assertEqual(resp["group"]["mapcontrols"], ['zoom', 'zoombox', 'zoomtoextent', 'query', 'querybbox', 'querybypolygon', 'overview', 'scaleline', 'geolocation', 'streetview', 'nominatim', 'addlayers', 'length', 'area', 'mouseposition', 'scale'])
+        self.assertEqual(resp["group"]["mapcontrols"], {'zoom': {}, 'zoombox': {}, 'zoomtoextent': {}, 'query': {}, 'querybbox': {}, 'querybypolygon': {}, 'overview': {}, 'scaleline': {}, 'geolocation': {}, 'streetview': {}, 'nominatim': {}, 'addlayers': {}, 'length': {}, 'area': {}, 'mouseposition': {}, 'scale': {}})
         self.assertEqual(resp["group"]["header_logo_img"], "logo_img/qgis-logo.png")
         self.assertEqual(resp["group"]["name"], "Gruppo 1")
         self.assertIsNone(resp["group"]["header_logo_link"])

g3w-admin/core/api/serializers.py

@@ -14,6 +14,7 @@
 
 from qgis.core import QgsCoordinateReferenceSystem, QgsCoordinateTransform, QgsCoordinateTransformContext
 from copy import copy
+import json
 
 
 def update_serializer_data(serializer_data, data):
@@ -116,9 +117,6 @@ def to_representation(self, instance):
             'extent': extent
         }
 
-        # map controls
-        ret['mapcontrols'] = [mapcontrol.name for mapcontrol in instance.mapcontrols.all()]
-
         # add projects to group
         ret['projects'] = []
         self.projects = {}
@@ -258,6 +256,22 @@ def to_representation(self, instance):
         if layout_right_panel:
             ret['layout']['rightpanel'] = layout_right_panel
 
+        # Mapcontrols
+        ret['mapcontrols'] = {}
+        for mapcontrol in instance.mapcontrols.all():
+            options = {}
+            if mapcontrol.name in ('nominatim', 'geocoding') and self.project.geocoding_providers:
+                options = {'providers': {}}
+                for gp in json.loads(self.project.geocoding_providers):
+                    if gp in settings.GEOCONDING_PROVIDERS:
+                        options['providers'].update({
+                            gp: settings.GEOCONDING_PROVIDERS[gp]
+                        })
+
+            ret['mapcontrols'].update({
+                mapcontrol.name: options
+            })
+
         return ret
 
     class Meta:

g3w-admin/qdjango/forms/projects.py

@@ -30,8 +30,10 @@
 from qdjango.models import *
 from qdjango.utils.data import QgisProject
 from qdjango.utils.validators import ProjectExists
+from qdjango.utils.models import get_geocoding_providers
 
 import shutil
+import json
 
 
 class QdjangoProjectFormMixin(object):
@@ -160,6 +162,8 @@ class QdjangoProjectForm(TranslationModelForm, QdjangoProjectFormMixin, G3WFormM
 
     description = BleachField(required=False)
 
+    geocoding_providers = forms.MultipleChoiceField(choices=get_geocoding_providers,required=False)
+
     def __init__(self, *args, **kwargs):
 
         if 'instance' in kwargs and hasattr(kwargs['instance'], 'url_alias'):
@@ -268,6 +272,7 @@ def __init__(self, *args, **kwargs):
                             'multilayer_query',
                             'multilayer_querybybbox',
                             'multilayer_querybypolygon',
+                            Field('geocoding_providers', css_class='select2', style="width:100%;"),
                             css_class='box-body',
 
                         ),
@@ -321,12 +326,21 @@ class Meta:
             'use_map_extent_as_init_extent',
             'context_base_legend',
             'title_ur',
+            'geocoding_providers'
         )
         field_classes = dict(
             qgis_file=UploadedFileField,
             thumbnail=UploadedFileField
         )
 
+    def clean_geocoding_providers(self):
+        """
+        Make the cleaned data for geocoding_providers:
+        make it a Json serializable
+        """
+
+        return json.dumps(self.cleaned_data['geocoding_providers'])
+
     def _setEditorUserQueryset(self):
         """
         Set query set for editors chosen fields
@@ -383,6 +397,8 @@ def save(self, commit=True):
 
         self._save_url_alias()
 
+
+
         # add permission to Editor level 1 and 2 if current user is Editor level 1 or 2
         if userHasGroups(self.request.user, [G3W_EDITOR1, G3W_EDITOR2]):
             self.instance.addPermissionsToEditor(self.request.user)

g3w-admin/qdjango/migrations/0115_project_geocoding_providers.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.23 on 2023-11-08 10:35
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('qdjango', '0114_alter_sessiontokenfilter_token'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='geocoding_providers',
+            field=models.TextField(blank=True, null=True, verbose_name='Geocoding providers'),
+        ),
+
+        # Rename map control nominatim in geocoding
+        migrations.RunSQL(
+            "UPDATE core_mapcontrol SET name='geocoding' WHERE name='nominatim'"
+        ),
+        migrations.RunSQL(
+            "UPDATE qdjango_project SET geocoding_providers='[\"nominatim\"]'"
+        ),
+    ]

g3w-admin/qdjango/models/projects.py

@@ -278,6 +278,7 @@ class Project(G3WProjectMixins, G3WACLModelMixins, TimeStampedModel):
 
     order = models.PositiveIntegerField(_('Fields to se order'), default=0, blank=True, null=True)
 
+    geocoding_providers = models.TextField(_('Geocoding providers'), blank=True, null=True)
 
     class Meta:
         verbose_name = _('Project')

g3w-admin/qdjango/utils/models.py

@@ -163,4 +163,19 @@ def get_view_layer_ids(user, project):
             set([l.qgs_layer_id for l in get_objects_for_user(get_anonymous_user(), 'qdjango.view_layer', Layer).
                 filter(project=project)])
         )
-    )
+    )
+
+def get_geocoding_providers():
+    """
+    Return al tuple for qdjango project form field geocoding_providers
+
+    :return: tuple of items for a django form select
+    """
+
+    ret = []
+    for gp, p in settings.GEOCONDING_PROVIDERS.items():
+        if gp == 'bing' and 'bing' not in settings.VENDOR_KEYS:
+            continue
+        ret.append((gp, p['label']))
+
+    return ret

g3w-admin/qdjango/views/projects.py

@@ -95,6 +95,14 @@ class QdjangoProjectCreateView(QdjangoProjectCUViewMixin, G3WGroupViewMixin, G3W
     def dispatch(self, *args, **kwargs):
         return super(QdjangoProjectCreateView, self).dispatch(*args, **kwargs)
 
+    def get_initial(self):
+        initial = super().get_initial()
+
+        # Get intial for geocoding_providers: default 'nominatim'
+        initial['geocoding_providers'] = ["nominatim"]
+
+        return initial
+
 
 class QdjangoProjectUpdateView(QdjangoProjectCUViewMixin, G3WGroupViewMixin, G3WRequestViewMixin, G3WACLViewMixin,
                                UpdateView):
@@ -113,6 +121,15 @@ class QdjangoProjectUpdateView(QdjangoProjectCUViewMixin, G3WGroupViewMixin, G3W
     def dispatch(self, *args, **kwargs):
         return super(QdjangoProjectUpdateView, self).dispatch(*args, **kwargs)
 
+    def get_initial(self):
+        initial = super().get_initial()
+
+        # Get intial for geocoding_providers
+        if self.object.geocoding_providers:
+            initial['geocoding_providers'] = json.loads(self.object.geocoding_providers)
+
+        return initial
+
     def get_context_data(self, **kwargs):
         context = super(QdjangoProjectUpdateView,
                         self).get_context_data(**kwargs)