#9250: Share plugin - Permalink functionality

[dsuren1]

Description

This PR introduces permalink functionality to Share

Please check if the PR fulfills these requirements

• The commit message follows our guidelines: https://github.com/geosolutions-it/MapStore2/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (check one with "x", remove the others)

• Feature

Issue

What is the current behavior?

• Share plugin - Permalink - Add a permalink functionality #9250

What is the new behavior?
User can create permalink of the current state of the map, dashboard, geostory, context map. The permalink resources are saved as PERMALINK category and has unique resource id. The title attribute is shown in Save/SaveAs modal and TOC

Breaking change

Does this PR introduce a breaking change? (check one with "x", remove the other)

• Yes, and I documented them in migration notes
• No

Other useful information

[offtherailz]

can you update this pr with latest master, so It can pass the checks, thank you.

[offtherailz]

• see my comments inline
• Title can not be saved or searched. I see you make it work on cards too, and this is great, but for the moment the title functionality is not supported sufficiently for resources to make this title visible everywhere. So for the moment, as I asked, show the title input only if the title already exists as attribute (so only for the case of permalinks). After merging this PR, let's open a new issue to improve the title functionality.
  title_not_saved.webm
  Here the point of the issue telling this

• It could be a nice to have to have the title editor in save form too. IT should be shown for the moment only if it is present as attribute (also an empty string is ok for showing the editor, but if it is an empty string in the layer tree or where it is shown as a string,you should show the name isntead.

• I notice the controlLabel is not correct. "Via a direct link" . Please fix (use something like "Permalink generated", maybe a subtitle "share the resource using the generated address"

-[ ] The permalinks URL should contain the hash in the URL (name), instead here I see the ID.

Because of this inconsistency above, any futher test will not be valid because after refactoring I'd need to test all again. Generally the rest seems to work well (please double check the part of the session I commented inline).

• I noticed the share plugin to create permalink is not shown if the map is new ... It may be acceptable @tdipisa ?

[dsuren1]

• Title can not be saved or searched. I see you make it work on cards too, and this is great, but for the moment the title functionality is not supported sufficiently for resources to make this title visible everywhere. So for the moment, as I asked, show the title input only if the title already exists as attribute (so only for the case of permalinks). After merging this PR, let's open a new issue to improve the title functionality.

The code is already present to show title from the resource on the card. Will make name take precedence on resources and hide input when title is not present

[offtherailz]

@tdipisa we should be ready to go. Anyway our installation do not contain the PERMALINK category. Now we have docker and some other items.
The migration guidelines has been provided, but we have to provide them in our installation. Should we ask to alessandro ?

[offtherailz]

Everything works. Only some minor issues:

• Save button has a fixed size as the "create new" button, in certain languages, this is not enough. Expecially in french where this have to be used mostly. So please
  • Make these buttons growing with the text
  • I think that strings should be : "Generate permalink" and "Create a new permalink..." (with ... suggesting to do more).
  • Create new permalink should stay below the QR Code, on the right.
    
    

[dsuren1]

Updated:

[dsuren1]

Doc build is complaining about missing configuration file. It worked a while back. Strange!

[offtherailz]

Doc build is complaining about missing configuration file. It worked a while back. Strange!

I think is a new requirement.
https://docs.readthedocs.io/en/stable/config-file/v2.html

Can you open an issue for that? @tdipisa I'll review the PR in the meanwhile, but for merging it requires this to be fixed on the main project
adding a file like .readthedocs.yml to the root of the project, with something like this may work, but we have to do some tests with a PR.

version: 2

python:
  install:
    - requirements: docs/requirements.txt
  system_packages: true

mkdocs:
  configuration: mkdocs.yml
  fail_on_warning: false

@tdipisa can you assign this task to someone?

[offtherailz]

I applied the fixes in review by myself, please take a look

[offtherailz]

here I added a draft PR to fix the issue of readthedocs, you can start from this. I can not dedicate time today on this, hope it works.
#9297

[offtherailz]

Hi @tdipisa , there was a missing comment I noticed you didn't replied, so just to double check, I ask for confirmation

• I noticed the share plugin to create permalink is not shown if the map is new ... It may be acceptable @tdipisa ?

I mean that the share plugin do not show when the map is new. So the permalink will not be visible too. Is this acceptable?

[tdipisa]

Hi @tdipisa , there was a missing comment I noticed you didn't replied, so just to double check, I ask for confirmation

• I noticed the share plugin to create permalink is not shown if the map is new ... It may be acceptable @tdipisa ?

I mean that the share plugin do not show when the map is new. So the permalink will not be visible too. Is this acceptable?

yes

[offtherailz]

closed and reopen to re-run checks

[tdipisa]

@ElenaGallo please test this carefully on DEV once deployed.

[ElenaGallo]

@dsuren1 some notes after testing the permalink:

• the permalink description is not reported in the save panel
  

• if the permalink is saved it is not found as a map on the homepage, is that correct?
  

• the Details in the permalink are not visible
  

• the permalink generated from a context does not have the save panel filled in correctly (no name, tile and public rule)
  

[offtherailz]

My feedback on this:

• Description could be saved as an metadata so it can be analogue to the map's one and visible in the save form. We can apply this fix.
• Permalink should not be listed in maps. For the moment are links, if you do not have the reference, you will not be allowed to use it.
• the Details in the permalink are not visible --> good catch. Anyway the detail is part of the saved resource, so even cloning the map with save as makes it lost. So I think not saving it is the correct behavior too.

Ther rest is up to @dsuren1

[dsuren1]

@ElenaGallo

the permalink generated from a context does not have the save panel filled in correctly (no name, tile and public rule)

Save as panel will not have name and description. This is an expected behavior.