refactor to simplify plugin and focus on xkcd

Author: jtobard

.gitignore

@@ -1,2 +1 @@
-.gradle
 /build

Makefile

@@ -0,0 +1,11 @@
+all: install
+
+clean:
+	rm -rf build
+
+build:
+	mkdir -p build/libs build/zip-content/xkcd-ui
+	cp -r resources plugin.yaml build/zip-content/xkcd-ui
+	cd build/zip-content; zip -r xkcd-ui.zip *
+	mv build/zip-content/xkcd-ui.zip build/libs
+

README.md

@@ -1,35 +1,29 @@
-# Hello World - UI plugin demo
+# XKCD - UI plugin demo
 
-This plugin includes some basic UI demostrations:
+This plugin uses javascript + a mocked ajax request to modify Jobs list page
 
-* Usage of i18n to get messages
-* Usage of javascript to modify Main Page
-* Usage of javascript + ajax request to modify Jobs list page
-* Usage of javascript + css to modify the execution page
-
-### Hello World. 
-
-(Disabled by default. It can be enabled on `main.js` code)
-Display `Hello world` text from `messages.properties`, if the user change the language to Spanish on Rundeck, the message changes to `Hola Mundo`.
-
-### XKCD random image.
-
-(Enabled by default)
 On the jobs page, it adds on top of the job list, a random image from a json source file.
 To retrieve this image, the code uses a ajax call to a local file, this can be replaced with a call to a webservice on the same server as the rundeck instance.
 
-Since rundeck 3.0.12 you need to add this to `rundeck-config.properties`:
-`rundeck.security.httpHeaders.provider.csp.config.img-src=self https://imgs.xkcd.com`
-
-### Panic mode
-
-(Disabled by default. It can be enabled on `main.js` code)
-On the execution page, changes the header to red when a failed execution is open.
-
-
 
 ## Update the xkcd source
 
 Edit `getSources.sh` Set TODAY to the latest xkcd comic of the day.
 Run:
 `./getSources.sh > xkcdsource.json`
+
+## Build
+
+Using make:
+```
+make clean build
+```
+
+## Install
+
+```
+cp build/libs/xkcd-ui.zip $RDECK_BASE/libext
+```
+
+XKCD is A webcomic of romance, sarcasm, math, and language. By Randall Munroe, see more about xkcd here => https://xkcd.com
+

build.gradle

@@ -1,5 +1,5 @@
 #!/bin/bash
-TODAY=2109
+TODAY=2165
 START=$TODAY-365
 echo "{ \"list\": ["
 

getSources.sh

@@ -0,0 +1,25 @@
+name: xkcd-ui
+rundeckPluginVersion: 2.0
+author: Rundeck Dev
+description: Describe your plugin here
+rundeckCompatibilityVersion: 3.x
+targetHostCompatibility: unix
+license: Apache 2.0
+tags:
+    - script
+    - UI
+date: 2019-06-14T20:45:04.155Z
+version: 1.0.0
+providers:
+    - name: xkcd-ui
+      service: UI
+      plugin-type: ui
+      title: XKCD UI
+      description: Rundeck UI test
+      ui:
+        - pages: '*'
+          scripts:
+            - js/xkcd-init.js
+            - js/main.js
+          styles:
+            - css/ui-example-styles.css

plugin.yaml

@@ -0,0 +1,30 @@
+body {
+    font-variant:small-caps;
+	font-family:Lucida,Helvetica,sans-serif;
+	font-weight:500;
+}
+/* line 1, paper/_typography.scss */
+h1, .h1, h2, .h2, h3, .h3, h4, .h4, h5, .h5, h6, .h6, p, .navbar, .brand, a, .td-name, td {
+	font-variant:small-caps;
+	font-family:Lucida,Helvetica,sans-serif;
+	font-weight:500;
+	text-decoration: none;
+}
+
+.sidebar .logo a.home {
+  font-family:Lucida,Helvetica,sans-serif;
+}
+
+.mainbar {
+	background-image: url('../icon.png');
+  text-transform: uppercase;
+  color: #ffffff;
+  padding-left: 80px;
+
+  background-size: 80px;
+  background-repeat: no-repeat;
+  width: 100%;
+  display: block;
+  background-position-y: 10px;
+  background-position-x: 20px;
+}

resources/css/ui-example-styles.css

@@ -0,0 +1,56 @@
+
+function initXKCD() {
+	var project = rundeckPage.project();
+	var path = rundeckPage.path();
+	var para = document.createElement("div");
+	
+	para.style.fontSize = "150%";
+	para.style.textAlign = "center";
+	para.style.marginBottom = "10px";
+
+	var xkcd = document.createElement("div");
+	xkcd.id = "xkcdfield";
+	para.appendChild(xkcd);
+
+	var x = jQuery(".main-panel .content").prepend(para);
+
+	if(rundeckPage.path() === "menu/jobs"){
+		//on any project page
+		jQuery.ajax({
+			beforeSend: function(xhr){
+			    if (xhr.overrideMimeType)
+			    {
+			      xhr.overrideMimeType("application/json");
+			    }
+			  },
+			dataType: 'json',
+	        url: url_path(rundeckPage.pluginBasei18nUrl('xkcd-ui'))+'/service/xkcdsource.json',
+	        success: function (data) {
+	            var imgCount = data.list.length;
+	            var n = Math.floor(Math.random() * imgCount);
+	            var image = data.list[n];
+	            if(image.img){
+	            	jQuery("#xkcdfield").prepend(jQuery('<img>',{id:'xcdImg',src:image.img, title:image.alt}));
+	            }
+	        }
+	    });
+	}
+};
+
+function url_path(baseUrl) {
+    if (baseUrl.indexOf('/') == 0) {
+        return baseUrl;
+    }
+    if (baseUrl.toLowerCase().indexOf('http') == 0) {
+        var len = baseUrl.indexOf('://');
+        if (len > 0) {
+            var absurl = baseUrl.substring(len + 3);
+            if (absurl.indexOf('/') >= 0) {
+                absurl = absurl.substring(absurl.indexOf('/'));
+                return absurl;
+            } else {
+                return '';
+            }
+        }
+    }
+}

resources/icon.png

@@ -0,0 +1,3 @@
+jQuery(document).on('load.rundeck.page', function () {
+    initXKCD()
+});