URL-Command for controlled maps

[wellemut]

Problem

If we just include a normal iframe on https://einewelt-einekarte.de/#kvm any user could modify all entries, which is not intended. The Organisations of that webpage want to have more control.
Therefore Uwe prepared the backend to create a list of changes, which the organization can approve. kartevonmorgen/openfairdb#269
The Iframe should show only approved entries!

Solution

The Frontend has to add the org_tag to the search string, which it sends to the backend. (API is documented on Swagger)
The shall be given in the URL-Command, which should be called org_tag=XXXX

Example: https://kartevonmorgen.org/#/?center=51.324,8.866&zoom=6.00&search=%23einewelt&org_tag=eineweltnrw Please mind the last command in URL

Helpful hints:

The API is documented in swagger:

• go to https://editor.swagger.io
  

• go to File -> import URL
  

• enter https://raw.githubusercontent.com/kartevonmorgen/openfairdb/master/openapi.yaml
  

• See the first section "Search"
  

More about this on this issue: #409

[uklotzde]

I forgot to add the new parameter to the GET entries/{ids} request that is primarily used by the Kvm frontend for retrieving entries!
kartevonmorgen/openfairdb#282

[uklotzde]

kartevonmorgen/openfairdb#283

The same parameter org_tag is used for both requests to apply the filtering, i.e. to virtually turn back time.

[uklotzde]

OpenFairDB v0.9.1 has been released and is live.

[navid-kalaei]

deployed on the second test domain

sample: https://test2.kartevonmorgen.org/#/?center=51.324,8.866&zoom=6.00&search=%23einewelt&orgTag=eineweltnrw

[wellemut]

The function itself is working great: https://test2.kartevonmorgen.org/#/?center=51.413,6.801&zoom=6.00&search=%23ideenwerkstattvonmorgen&orgTag=ideenwerkstattvonmorgen

But why is the combination of several commands not working?

• Not Working with &fixedTags= before the &orgTag https://test2.kartevonmorgen.org/#/?center=51.413,6.801&zoom=6.00&search=%23ideenwerkstattvonmorgen&fixedTags=ideenwerkstattvonmorgen&orgTag=ideenwerkstattvonmorgen

  • But if &orgTag= comes first, it works: https://test2.kartevonmorgen.org/#/?center=51.413,6.801&zoom=6.00&search=%23ideenwerkstattvonmorgen&orgTag=ideenwerkstattvonmorgen&fixedTags=ideenwerkstattvonmorgen

• Not Working with &left=hide at the end https://test2.kartevonmorgen.org/#/?center=51.413,6.801&zoom=6.00&search=%23ideenwerkstattvonmorgen&orgTag=ideenwerkstattvonmorgen&fixedTags=ideenwerkstattvonmorgen&left=hide

  • But &left=hide in the beginning it works: https://test2.kartevonmorgen.org/#/?center=51.413,6.801&zoom=6.00&search=%23ideenwerkstattvonmorgen&left=hide&orgTag=ideenwerkstattvonmorgen&fixedTags=ideenwerkstattvonmorgen

Problem:

when you start zooming, the order of the command is changing and it is no more working!!! Bug!
&orgTag= and &fixedTags= is not working together But we need both functions in one iframe!

Why is the order important?

User-Dokumentation of the feature ist done: https://blog.vonmorgen.org/iframes/#vollstaendiges-karten-widget-mit-suchleiste

[navid-kalaei]

I am extremely sorry for introducing this bug and thank you so much for bringing that to the attention. The reason for this dysfunctionality is the nature of the fixed tags that is a string combined from multiple strings separated with commas. and when the front end parses the URL, converts the comma-separated string of the fixed tags to an array of string with each element an individual tag. and as we have many many params in the URL the "try to convert string to array" procedure may be applied on the fixed tags twice. so you can guess if it has been converted to an array before, applying the convert procedure which is -developed for strings on it breaks the map. Therefore, if the fixedTags are at the end, it's the last param to parse so the loop won't iterate on it twice.

The functionality is fixed and alive on test2.kartevonmorge.org
and the branch has been kept on my local repo on the branch feature/orgtags.

as we discussed to keep the pull requests on git-flow I kindly inquire you to guide me through the process. should I make a pull request from the branch feature/orgtags or should I merge it into the branch develop and then make the pull request?

[wellemut]

Just Documented this function for Endusers: https://blog.vonmorgen.org/kontrollierte-karten/

[wellemut]

@navid-kalaei Even on this (old) test-Domain, the orgTags are not working anymore: https://test2.kartevonmorgen.org/#/?entry=f6c3511d3c564f7ab181c9183a50de88&center=51.413,6.801&zoom=6.00&search=%23ideenwerkstattvonmorgen&fixedTags=ideenwerkstattvonmorgen&orgTag=ideenwerkstattvonmorgen

[wellemut]

How to test its functionality?

1. use an entry with a #test hashtag like https://kartevonmorgen.org/#/?entry=8b66f2ae745f45c49c40393b111e93a7
2. Just edit anything, (in the title, which is the easiest to see)
3. The Follwoing to URLs should show a different version
   3.1 approved version: https://kartevonmorgen.org/#/?entry=8b66f2ae745f45c49c40393b111e93a7&center=42.790,10.333&zoom=15.00&orgTag=test
   3.2 newest unapproved versoin: https://kartevonmorgen.org/#/?entry=8b66f2ae745f45c49c40393b111e93a7
4. check on https://openfairdb.org/clearance by using the test-token 24vGG9gyYuVanmjJBJCRzZ51Qt5GBYGxkEGu1BxNQhQBgQ7 what the unapproved difference is.

this feature is normally used with a fixedTags URL-Command: https://test2.kartevonmorgen.org/#/?entry=8b66f2ae745f45c49c40393b111e93a7&center=42.788,10.332&zoom=15.00&search=%23test&fixedTags=test&orgTag=test

[navid-kalaei]

deployed on the beta domain:

with org tag: https://beta.kartevonmorgen.org/#/?entry=8b66f2ae745f45c49c40393b111e93a7&center=42.790,10.333&zoom=15.00&orgTag=test&dropdowns=kvm

without the org tag: https://beta.kartevonmorgen.org/#/?entry=8b66f2ae745f45c49c40393b111e93a7&center=42.790,10.333&zoom=15.00&dropdowns=kvm

[wellemut]

Great, That does exactly, what it should!

Do you have a pull-request for @regenduft