Merge pull request #2695 from DenverCoder544/publisher_tools_reactifi…

…cation

Publisher tools reactification

bundles/framework/publisher2/resources/locale/en.js

@@ -65,7 +65,6 @@ Oskari.registerLocalization(
                 "label": "Tools",
                 "tooltip": "Select available map tools. Check a placement in the map preview.",
                 "AnnouncementsPlugin": "Announcements",
-                "ScaleBarPlugin": "Scale bar",
                 "TimeseriesControlPlugin": "Time series player",
                 "IndexMapPlugin": "Index map",
                 "PanButtons": "Move to the original map view",

bundles/framework/publisher2/resources/locale/fi.js

@@ -65,7 +65,6 @@ Oskari.registerLocalization(
                 "label": "Kartalla näytettävät työkalut",
                 "tooltip": "Valitse kartalla käytettävissä olevat työkalut. Tarkista asettelu esikatselukartasta.",
                 "AnnouncementsPlugin": "Ilmoitukset",
-                "ScaleBarPlugin": "Mittakaavajana",
                 "TimeseriesControlPlugin": "Aikasarjatoistin",
                 "IndexMapPlugin": "Indeksikartta",
                 "PanButtons": "Palaa alkutilaan",

bundles/framework/publisher2/resources/locale/sv.js

@@ -65,7 +65,6 @@ Oskari.registerLocalization(
                 "label": "Verktyg",
                 "tooltip": "Välj verktygen som visas på kartan. Du kan se deras placering på den förhandsvisade kartan.",
                 "AnnouncementsPlugin": "Aviseringar",
-                "ScaleBarPlugin": "Skalstock",
                 "TimeseriesControlPlugin": "Tidseriespelare",
                 "IndexMapPlugin": "Indexkarta",
                 "PanButtons": "Gå tillbaka till standardvyn för kartvyn",

bundles/framework/publisher2/tools/AbstractPublisherTool.js

@@ -37,6 +37,12 @@ export class AbstractPublisherTool {
             config: this.state.pluginConfig || {}
         };
     }
+
+    // override when the tool has a component / handler
+    getComponent () {
+        return {};
+    };
+
     // deprecated - new (React based) tools should use getTool().title instead
     getTitle () {
         const toolTitle = this.getTool().title;
@@ -45,9 +51,11 @@ export class AbstractPublisherTool {
         }
         return this.__loc[toolTitle];
     }
+
     getGroup () {
         return this.group;
     }
+
     getIndex () {
         return this.index;
     }
@@ -57,11 +65,13 @@ export class AbstractPublisherTool {
         // assume it's in mapfull bundles plugins array as most of the default tools are stored there
         return data?.configuration?.mapfull?.conf?.plugins?.find(plugin => toolId === plugin.id);
     }
+
     storePluginConf (conf) {
         this.state.pluginConfig = conf || {};
     }
+
     setEnabled (enabled) {
-        var tool = this.getTool();
+        const tool = this.getTool();
 
         // state actually hasn't changed -> do nothing
         if (this.isEnabled() === enabled) {
@@ -81,23 +91,25 @@ export class AbstractPublisherTool {
         // Stop checks if we are already disabled so toggle the value after
         this.state.enabled = enabled;
         // notify publisher tool layout panel in case tool placement dragging needs to be toggled
-        var event = Oskari.eventBuilder('Publisher2.ToolEnabledChangedEvent')(this);
+        const event = Oskari.eventBuilder('Publisher2.ToolEnabledChangedEvent')(this);
         this.getSandbox().notifyAll(event);
         return true;
     }
 
     isEnabled () {
         return !!this.state.enabled;
     }
+
     getValues () {
         // override
         return null;
     }
+
     stop () {
         if (!this.isEnabled()) {
             return;
         }
-        var tool = this.getTool();
+        const tool = this.getTool();
         if (tool.hasNoPlugin !== true) {
             const plugin = this.getPlugin();
             if (!plugin) {
@@ -110,6 +122,7 @@ export class AbstractPublisherTool {
             this.__plugin = null;
         }
     }
+
     /**
     * Is displayed. We can use this to tell when tool is displayed.
     * For example if stats layers are added to map when opening publisher we can tell at then this tool need to be shown (ShowStatsTableTool).
@@ -123,6 +136,7 @@ export class AbstractPublisherTool {
     isDisplayed () {
         return true;
     }
+
     /**
     * Is this tool available.
     * @method isDisabled
@@ -133,6 +147,7 @@ export class AbstractPublisherTool {
     isDisabled (data) {
         return false;
     }
+
     validate () {
         // always valid by default
         // could return false if there's something wrong that should require stopping the user from saving
@@ -142,15 +157,19 @@ export class AbstractPublisherTool {
     getPlugin () {
         return this.__plugin;
     }
+
     getSandbox () {
         return this.__sandbox;
     }
+
     getMapmodule () {
         return this.__mapmodule;
     }
+
     getAllowedLocations () {
         return this.allowedLocations;
     }
+
     // old tools return jQuery object that renders the extra options for this tool
     getExtraOptions () {
         return null;

bundles/mapping/mapmodule/plugin/logo/publisher/LogoTool.js

@@ -0,0 +1,87 @@
+import { AbstractPublisherTool } from '../../../../../framework/publisher2/tools/AbstractPublisherTool';
+
+class LogoTool extends AbstractPublisherTool {
+    constructor (...args) {
+        super(...args);
+        this.index = 1;
+        this.group = 'additional';
+        this.config = null;
+    }
+
+    init (data) {
+        const plugin = this.findPluginFromInitData(data);
+        if (plugin) {
+            this.storePluginConf(plugin.config);
+            // when we enter publisher:
+            // restore saved location for plugin that is not stopped nor started
+            this.getPlugin().setLocation(plugin.config?.location?.classes);
+        }
+    }
+
+    getTool () {
+        return {
+            id: 'Oskari.mapframework.bundle.mapmodule.plugin.LogoPlugin',
+            title: 'LogoPlugin',
+            config: this.state.pluginConfig || {}
+        };
+    }
+
+    // not displayed on tool panels so user can't disable it
+    isDisplayed () {
+        return false;
+    }
+
+    getPlugin () {
+        // always use the instance on map, not a new copy
+        return this.getMapmodule().getPluginInstances('LogoPlugin');
+    }
+
+    // always enabled, use the instance that is on map
+    isEnabled () {
+        return true;
+    }
+
+    stop () {
+        // when we exit publisher:
+        // move plugin back to bottom left if it was dragged during publisher
+        this.getPlugin()?.setLocation('bottom left');
+    }
+
+    /**
+    * Get values.
+    * @method getValues
+    * @public
+    *
+    * @returns {Object} tool value object
+    */
+    getValues () {
+        const plugin = this.getPlugin();
+        if (!plugin) {
+            return null;
+        }
+        return {
+            configuration: {
+                mapfull: {
+                    conf: {
+                        plugins: [{
+                            id: this.getTool().id,
+                            config: {
+                                location: plugin.getConfig()?.location
+                            }
+                        }]
+                    }
+                }
+            }
+        };
+    }
+}
+
+// Attach protocol to make this discoverable by Oskari publisher
+Oskari.clazz.defineES('Oskari.publisher.LogoTool',
+    LogoTool,
+    {
+        protocol: ['Oskari.mapframework.publisher.Tool']
+    }
+);
+
+export { LogoTool };