Make this an iframe

Author: KillerX

README.md

@@ -1,35 +1,37 @@
+# Cantemo iframe plugin
 
-# TODO:
-- ✅ Create buttons with javascript 
-- ✅ Get user role from cantemo
-- ✅ Get item id from cantemo
-- ✅ Create a startManualRule function which takes a process_id 
-- ✅ Create buttons based on config file.
-- ✅ Clean up names (no myplugin)
--[ ]
-<br/>
+This Cantemo plugin embeds an external tool as an `<iframe>` in the media item
+view. It hooks into `MediaViewItemTechMetadataTop` and renders the iframe with
+the current item's ID appended as a query parameter, e.g.:
 
-## METADATA
-- ✅ generate different buttons depending on item type (maby through metadat, different itemtypes have different metadata)
+```
+https://tools.bcc.media/cantemo/?id=VX-2
+```
 
-<br/>
+## Changing the target URL
 
-## BUGS
-- when portal window is in mobile view you can´t click the buttons
+Edit the `src` of the iframe in
+[`templates/manual_rule_button_plugin.html`](templates/manual_rule_button_plugin.html).
+`{{ item_id }}` is the Cantemo item id (e.g. `VX-2`) supplied by the plugin
+context.
 
-<br/>
+## Install
+
+Run `install.sh` as root on the Cantemo host. It copies the plugin into
+`/opt/cantemo/portal/portal/plugins/`, runs `syncdata`, and restarts portal.
 
 ## The args object
 
-The args object on `IPluginBlock.return_str`.
+The `args` object on `IPluginBlock.return_string` (hook
+`MediaViewItemTechMetadataTop`):
 
 ```json
-[ // This is a tuple
+[
     [
         "pluginblock",
         "MediaViewItemTechMetadataTop"
     ],
-    { // This is a dict
+    {
         "item": "<<non-serializable: VSItem>>",
         "user": "<<non-serializable: SimpleLazyObject>>",
         "request": "<<non-serializable: Request>>",
@@ -44,5 +46,3 @@ The args object on `IPluginBlock.return_str`.
     }
 ]
 ```
-
-User groups: {{user_groups}}

__init__.py

@@ -3,4 +3,4 @@
 '''
 from .plugin import *
 
-__version__ = "1.0.1"
+__version__ = "1.1.0"

install.sh

@@ -1,9 +1,7 @@
 #!/bin/bash
 set -o pipefail
 
-# path to config file that you wnat to use
 PORTAL_ROOT="/opt/cantemo/portal"
-CONFIG_FILE="$PORTAL_ROOT/portal_media/js/bccm-config.js"
 PLUGIN_NAME="ManualRuleButtonPlugin"
 
 if [ $(id -u) -ne 0 ]
@@ -20,14 +18,6 @@ fi
 
 mkdir -pv $PORTAL_ROOT/portal/plugins/$PLUGIN_NAME
 cp -rv $DIR/* $PORTAL_ROOT/portal/plugins/$PLUGIN_NAME
-cp -rv $DIR/js/* $PORTAL_ROOT/portal_media/js/
-
-if [ -f "$CONFIG_FILE" ]; then
-    echo "$CONFIG_FILE exists."
-else 
-    echo "$CONFIG_FILE does not exist."
-    cp -v $DIR/js/bccm-example-config.js $CONFIG_FILE
-fi
 
 echo "Done."