#9250: Share plugin - Permalink functionality (#9288)

docs/developer-guide/mapstore-migration-guide.md

@@ -93,6 +93,110 @@ The old spring maven repositories that do not exist anymore have been removed fr
 -        </repository>
 ```
 
+### New Permalink plugin
+
+As part this release, permalink plugin is added to MapStore. The new plugin is already configured in standard MapStore application, but if you are working on a project or if you customized the configuration files, you may need to update them to introduce the new plugin.
+
+In any case on an existing installation you **must** update the database adding the category to make the plugin work.
+
+#### Add Permalink plugin to localConfig.json
+
+In the case you customized your `configs/localConfig.json` file in your project/installation, to add the permalink plugin you will have to update it as following:
+
+- Add the "Permalink" plugin to the pages you want to use this plugin. Pages plugins are in the `plugins` section in the root of `localConfig.json`,  so you have to add "Permalink" entry to `desktop`, `dashboard` and `geostory` arrays, like this:
+
+```json
+{
+    "desktop": [
+        ...
+        "Permalink",
+        ...
+    ],
+    "dashboard": [
+        ...
+        "Permalink",
+        ...
+    ],
+    "geostory": [
+        ...
+        "Permalink",
+        ...
+    ]
+}
+```
+
+- To activate the functionality, you must add a new `permalink` section to `plugins` root object of `localConfig.json`, as shown below
+
+```json
+{
+    "permalink": [
+        "Permalink",
+        "FeedbackMask"
+    ]
+}
+```
+
+#### Using Permalink in new contexts
+
+The plugins available for contexts are listed in the file `configs/pluginsConfig.json`. In your project/installation, you may need to edit this configuration to make the plugin selectable for your context.
+Existing contexts need to be updated separately, after applying these changes
+
+- Find the "Share" plugin configuration in the `plugins` array in the root of  `pluginsConfig.json` configuration file and modify it as shown below (adding `children` and `autoEnableChildren` sections:
+
+```json
+    {
+      "name": "Share",
+      "glyph": "share",
+      "title": "plugins.Share.title",
+      "description": "plugins.Share.description",
+      "dependencies": [
+        "SidebarMenu"
+      ],
+      "children": [
+        "Permalink"
+      ],
+      "autoEnableChildren": [
+        "Permalink"
+      ]
+    }
+```
+
+- Add "Permalink" plugin configuration to the `plugins` array in the root of `pluginsConfig.json`
+
+```json
+    {
+      "name": "Permalink",
+      "glyph": "link",
+      "title": "plugins.Permalink.title",
+      "description": "plugins.Permalink.description"
+    },
+```
+
+#### Database Update
+
+Add new category `PERMALINK` to `gs_category` table. To update your database you need to apply this SQL scripts to your database
+
+##### PostgreSQL
+
+```sql
+-- New PERMALINK category
+INSERT INTO geostore.gs_category(id, name) VALUES (nextval('geostore.hibernate_sequence'), 'PERMALINK') ON CONFLICT DO NOTHING;
+```
+
+##### H2
+
+```sql
+-- New PERMALINK category
+INSERT INTO gs_category(name) VALUES ('PERMALINK');
+```
+
+##### Oracle
+
+```sql
+-- New PERMALINK category
+INSERT INTO gs_category(id, name) VALUES (hibernate_sequence.nextval, ‘PERMALINK');
+```
+
 ## Migration from 2022.02.02 to 2023.01.00
 
 ### Log4j update to Log4j2

java/web/src/main/resources/sample_categories.xml

@@ -24,4 +24,7 @@
     <Category>
         <name>USERSESSION</name>
     </Category>
+    <Category>
+        <name>PERMALINK</name>
+    </Category>
 </CategoryList>

project/standard/templates/configs/pluginsConfig.json

@@ -152,8 +152,21 @@
       "description": "plugins.Share.description",
       "dependencies": [
         "SidebarMenu"
+      ],
+      "children": [
+        "Permalink"
+      ],
+      "autoEnableChildren": [
+        "Permalink"
       ]
     },
+    {
+      "name": "Permalink",
+      "glyph": "link",
+      "title": "plugins.Permalink.title",
+      "description": "plugins.Permalink.description",
+      "denyUserSelection": true
+    },
     {
       "name": "BackgroundSelector",
       "title": "plugins.BackgroundSelector.title",

project/standard/templates/web/src/main/resources/sample_categories.xml

@@ -24,4 +24,7 @@
     <Category>
         <name>USERSESSION</name>
     </Category>
+    <Category>
+        <name>PERMALINK</name>
+    </Category>
 </CategoryList>

web/client/actions/__tests__/permalink-test.js

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2023, GeoSolutions Sas.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import expect from "expect";
+
+import {
+    LOAD_PERMALINK,
+    LOAD_PERMALINK_ERROR,
+    PERMALINK_LOADED,
+    LOADING,
+    RESET,
+    SAVE_PERMALINK,
+    UPDATE_SETTINGS,
+    loadPermalink,
+    loadPermalinkError,
+    permalinkLoaded,
+    permalinkLoading,
+    resetPermalink,
+    savePermalink,
+    updatePermalinkSettings
+} from "../permalink";
+
+describe("Test correctness of the permalink actions", () => {
+    it("loadPermalink", () => {
+        const action = loadPermalink("test");
+        expect(action.type).toBe(LOAD_PERMALINK);
+        expect(action.id).toBe("test");
+    });
+    it("loadPermalinkError", () => {
+        const error = {message: "error"};
+        const action = loadPermalinkError(error);
+        expect(action.type).toBe(LOAD_PERMALINK_ERROR);
+        expect(action.error).toEqual(error);
+    });
+    it("permalinkLoaded", () => {
+        const action = permalinkLoaded();
+        expect(action.type).toBe(PERMALINK_LOADED);
+    });
+    it("permalinkLoading", () => {
+        const action = permalinkLoading(true);
+        expect(action.type).toBe(LOADING);
+        expect(action.loading).toBeTruthy();
+    });
+    it("resetPermalink", () => {
+        const action = resetPermalink();
+        expect(action.type).toBe(RESET);
+    });
+    it("savePermalink", () => {
+        const saveObj = {name: "test"};
+        const action = savePermalink(saveObj);
+        expect(action.type).toBe(SAVE_PERMALINK);
+        expect(action.value).toEqual(saveObj);
+    });
+    it("updatePermalinkSettings", () => {
+        const settings = {title: "test"};
+        const action = updatePermalinkSettings(settings);
+        expect(action.type).toBe(UPDATE_SETTINGS);
+        expect(action.settings).toEqual(settings);
+    });
+});

web/client/actions/permalink.js

@@ -0,0 +1,80 @@
+/**
+ * Copyright 2023, GeoSolutions Sas.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export const LOAD_PERMALINK = "PERMALINK:LOAD";
+export const PERMALINK_LOADED = "PERMALINK:LOADED";
+export const LOAD_PERMALINK_ERROR = "PERMALINK:LOAD_ERROR";
+export const SAVE_PERMALINK = "PERMALINK:SAVE";
+export const UPDATE_SETTINGS = "PERMALINK:UPDATE_SETTINGS";
+export const LOADING = "PERMALINK:LOADING";
+export const RESET = "PERMALINK:RESET";
+
+/**
+ * Load permalink
+ * @param {string} id
+ * @memberof actions.permalink
+*/
+export const loadPermalink = (id) => ({
+    type: LOAD_PERMALINK,
+    id
+});
+
+/**
+ * Trigger on permalink loaded
+ * @memberof actions.permalink
+*/
+export const permalinkLoaded = () => ({
+    type: PERMALINK_LOADED
+});
+
+/**
+ * Trigger on permalink load error
+ * @param {Object} error
+ * @memberof actions.permalink
+*/
+export const loadPermalinkError = (error) => ({
+    type: LOAD_PERMALINK_ERROR,
+    error
+});
+
+/**
+ * Trigger on save permalink
+ * @param {Object} value
+ * @memberof actions.permalink
+*/
+export const savePermalink = (value) => ({
+    type: SAVE_PERMALINK,
+    value
+});
+
+/**
+ * Trigger on update permalink settings
+ * @param {Object} settings
+ * @memberof actions.permalink
+*/
+export const updatePermalinkSettings = (settings) => ({
+    type: UPDATE_SETTINGS,
+    settings
+});
+
+/**
+ * Trigger on loading a permalink
+ * @param {boolean} loading
+ * @memberof actions.permalink
+*/
+export const permalinkLoading = (loading) => ({
+    type: LOADING,
+    loading
+});
+
+/**
+ * Trigger on permalink reset
+ * @memberof actions.permalink
+*/
+export const resetPermalink = () => ({
+    type: RESET
+});