✨ Add new geocoding provider: Bing

[wlorenzetti]

Closes: #645

Add the capability to the end user of G3W-SUITE to set the provider for 'geocoding' map control (old 'nominatim').

I the section of 'Options and actions' of qdjango project form page, it was added a multi select box for choose the geoconding providers to use in the webgis client.

The providers can be set by the Django settings variable GEOCONDING_PROVIDERS who the default value is:

GEOCODING_PROVIDERS = {
  "nominatim": {
    "label": "Nominatim (OSM)",
    "url": "https://nominatim.openstreetmap.org/search",
  },
  "bing_streets": {
    "label": "Bing Streets",
    "url": "https://dev.virtualearth.net/REST/v1/Locations/",
  },
  "bing_places": {
    "label": "Bing Places",
    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/",
  },
}

NB: bing providers will be available in the Geoconding providers select box if a bing key it was set inside the Django settings VENDOR_KEYS

[wlorenzetti]

@volterra79 @Raruto a this point i suggest to rename nominatim mapcontrol in geocoding. It'd be possible?

[wlorenzetti]

@volterra79 @Raruto now in initconfig variable (or API REST) the mapcontrols property it was changed:

"mapcontrols": {
            "zoombox": {},
            "zoom": {},
            "zoomhistory": {},
            "zoomtoextent": {},
            "query": {},
            "querybbox": {},
            "querybypolygon": {},
            "querybydrawpolygon": {},
            "overview": {},
            "scaleline": {},
            "geolocation": {
                "nominatim": {
                    "label": "Nominatim (OSM)",
                    "url": "https://nominatim.openstreetmap.org/search"
                },
                "bing": {
                    "label": "Bing",
                    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/"
                }
            },
            "streetview": {},
            "nominatim": {
                "nominatim": {
                    "label": "Nominatim (OSM)",
                    "url": "https://nominatim.openstreetmap.org/search"
                },
                "bing": {
                    "label": "Bing",
                    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/"
                }
            },
            "addlayers": {},
            "length": {},
            "area": {},
            "mouseposition": {},
            "scale": {},
            "screenshot": {},
            "geoscreenshot": {}
        }

[Raruto]

@wlorenzetti perhaps you meant "geocoding" ?

"geolocation": { // <-- "geolocation" does not require custom providers
  "nominatim": {
      "label": "Nominatim (OSM)",
      "url": "https://nominatim.openstreetmap.org/search"
  },
  "bing": {
      "label": "Bing",
      "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/"
  }
},

I haven't tested it yet, but I think it's wrong within the PR code too.

[wlorenzetti]

@wlorenzetti perhaps you meant "geocoding" ?

"geolocation": { // <-- "geolocation" does not require custom providers
  "nominatim": {
      "label": "Nominatim (OSM)",
      "url": "https://nominatim.openstreetmap.org/search"
  },
  "bing": {
      "label": "Bing",
      "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/"
  }
},

I haven't tested it yet, but I think it's wrong within the PR code too.

@Raruto now it 'd work fine.

@wlorenzetti perhaps you meant "geocoding" ?

Yes :)

I haven't tested it yet, but I think it's wrong within the PR code too.

@Raruto try now it'd work fine now.

[Raruto]

@wlorenzetti hiding it can become difficult to use (and discover), I would recommend showing an informational message instead, eg:

<div class="help-block" style="color: red">
  ⚠️ No <a href="https://g3w-suite.readthedocs.io/en/latest/settings.html#vendors-settings" target="_blank"><code>VENDOR_KEYS</code></a> found for "Bing" provider
</div>

Correct me if I'm wrong, only Nominatim provider will be activated by default for each project (so it wouldn't send invalid provider configurations to the client anyway):

[wlorenzetti]

@Raruto for me is correct not show Bing if a a vendor key for it is not set inside the settings. It could be useful add a description for the find int he form writing a thing like this: "For use Bing geoding is necessary have a Bing API key "

Correct me if I'm wrong, only Nominatim provider will be activated by default for each project (so it wouldn't send invalid provider configurations to the client anyway):

No why? at most you will have a map control without provider in the configuration API

[Raruto]

hiding it can become difficult to use (and discover), I would recommend showing an informational message instead

for me is correct not show Bing if a a vendor key for it is not set inside the settings

I said that because it complicates development a bit.

API keys (and other server configurations) can also be added on the fly via JS.

If we also have to check the docker configuration it becomes an extra step (a "duplicated" step) which would require a dedicated documentation..

Even on the server side, a sysadmin might even be happy to simply do that:

GEOCONDING_PROVIDERS = {
  "bing": {
    "label": "Bing",
    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/?key=my.super.secret.key"
  }
}

which is equivalent to the wordy version:

VENDOR_KEYS = {
 'bing': 'my.super.secret.key'
}

GEOCONDING_PROVIDERS = {
  "bing": {
    "label": "Bing",
    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/"
  }
}

But without the risk to lose them in configuration files.

In essence, let's leave people a little more freedom on how to handle it.

[wlorenzetti]

@Raruto ok I can understand what you are saying me, but the VENDORS_KEYS are used also for other features i.e. base layers .. so I think if better leave one place where to set the VENDOR key.