Merge branch 'dev' into main

Author: AlterTobi

README.md

@@ -14,6 +14,7 @@ Install [WFES Base](https://github.com/AlterTobi/WFES/raw/main/wfes-base.user.js
 ## List of scripts
 * [showcase](https://github.com/AlterTobi/WFES/raw/main/wfes-showcase.user.js)
     - shows wayspot description and the game used for submitting
+    ![](./assets/showcase.png)
 
 ## Developer documentation
 Documentation for devs is available in the [Wiki](https://github.com/AlterTobi/Wayfarer-Extension-Scripts/wiki/WFES-Base).

assets/showcase.png

@@ -1,7 +1,7 @@
 // ==UserScript==
 // @name         WFES - Base
 // @namespace    https://gitlab.com/fotofreund0815/WFES
-// @version      0.1.0
+// @version      0.2.1
 // @description  basic functionality for WFES
 // @author       fotofreund0815
 // @match        https://wayfarer.nianticlabs.com/*
@@ -12,32 +12,54 @@
 (function() {
 	'use strict';
 
+/* WFES data structures */
 	const PREFIX = '/api/v1/vault/';
+	const sStoreReview = 'wfes_Reviews';
 
     window.wfes = {};
     window.wfes.showcase = {};
+    window.wfes.review = {};
+    window.wfes.review.decision = {};
 
-	// window.wfes.showcase;
+/* overwrite XHR */
 
-	let openOrig = window.XMLHttpRequest.prototype.open,
+    let openOrig = window.XMLHttpRequest.prototype.open,
 	    sendOrig = window.XMLHttpRequest.prototype.send;
 
 	function openReplacement(method, url, async, user, password) {
 		  this._url = url;
-		  console.log( "WFES OPEN: ", method, url );
+		  this._method = method;
+		  // console.log( "WFES OPEN: ", method, url );
 		  this.addEventListener('load', handleLoadEvent);
 		  return openOrig.apply(this, arguments);
-		}
+	}
 
-	function sendReplacement(data) {
-		  if(this.onreadystatechange) {
-		    this._onreadystatechange = this.onreadystatechange;
-		  }
-		  //console.log( "WFES SEND: ", data );
-		  //console.dir( data );
-		  // this.onreadystatechange = onReadyStateChangeReplacement;
-		  return sendOrig.apply(this, arguments);
+	function sendReplacement(daten) {
+		let candidate, json;
+		// handle only POST requests
+		if ('POST' === this._method) {
+			  switch (this._url) {
+			  	case PREFIX + 'review':
+                    json = JSON.parse(daten);
+			  		candidate = window.wfes.review.sessionHist[json.id];
+			  		window.wfes.review.decision.candidate = candidate;
+			  		window.wfes.review.decision.decision = json;
+			  		window.dispatchEvent(new Event("WFESReviewDecisionSent"));
+			  		break;
+			  	case PREFIX + 'skip':
+                    json = JSON.parse(daten);
+			  		candidate = window.wfes.review.sessionHist[json.id];
+			  		window.wfes.review.decision.candidate = candidate;
+			  		json.skipped = true;
+			  		window.wfes.review.decision.decision = json;
+			  		window.dispatchEvent(new Event("WFESReviewDecisionSent"));
+			  		break;
+			  	default:
+			  		break;
+			  }
 		}
+		return sendOrig.apply(this, arguments);
+	}
 
 	function handleLoadEvent(e) {
         let json;
@@ -49,22 +71,52 @@
 					window.wfes.showcase.list = json.result.showcase;
 					window.dispatchEvent(new Event("WFESHomePageLoaded"));
 					break;
+				case PREFIX + 'review':
+					if ('GET' === this._method) {
+						json = JSON.parse(response);
+						handleReviewData(json.result);
+					}
+					break;
+				default:
+					break;
 			}
 		} catch (e)	{
-			console.log(e);
+			console.warn(e);
 		}
 	}
 
-	/*
-	function onReadyStateChangeReplacement() {
-		   // PLACE HERE YOUR CODE FOR READYSTATECHANGE
-		  if(this._onreadystatechange) {
-		    return this._onreadystatechange.apply(this, arguments);
-		  }
-		}
-	*/
-
 	window.XMLHttpRequest.prototype.open = openReplacement;
 	window.XMLHttpRequest.prototype.send = sendReplacement;
+
+/* handle data */
+
+	//Useful to make comparing easier. Essentially this function iterates over all items
+	//and uses it's unique ID as key and stores relevant values under that key.
+	//This way on checking we can simply find the ID when looking at a current item
+	function makeIDbasedDictionary(itemList){
+		let dict = {};
+		for (let i = 0; i < itemList.length; i++){
+			let item = itemList[i];
+			dict[item.id] = item;
+		}
+		return dict;
+	}
+
+	function handleReviewData(result) {
+		// save review data in ...pagedata and sessionstore
+		let reviewSessionHist = JSON.parse(sessionStorage.getItem(sStoreReview)) || []
+		window.wfes.review.sessionHist = makeIDbasedDictionary(reviewSessionHist);
+
+		if (undefined === window.wfes.review.sessionHist[result.id]) {
+			reviewSessionHist.push(result);
+			sessionStorage.setItem(sStoreReview,JSON.stringify(reviewSessionHist));
+			window.wfes.review.sessionHist[result.id] = result;
+		}
+
+		window.wfes.review.pageData = result;
+		window.dispatchEvent(new Event("WFESReviewPageLoaded"));
+	}
+
+/* we are done :-) */
 	console.log( "WFES BASE loaded");
 })();

wfes-base.user.js

@@ -62,7 +62,6 @@ msqzhMX9D7VJotwvKKA1oVMgNaNJDNsjZTvo2WdEpXjaryj2PFGizxWvVQjbPzdTzPg88biHDRZF\
 ao7gTYkYY4ufrWjxhNVUQhcNLyHFFPN89trIG7UviJSZLPv8Hdh37+8x2JqqqjJMj4GiMKaq9unf\
 IYqHgkTBHM2N/P+MPR7hIjB3OzN427/WvgQYAPTTeKqgtlNiAAAAAElFTkSuQmCC');
             	}
-            	
     `;
             headElem.appendChild(customStyleElem);
     	}
@@ -72,7 +71,7 @@ IYqHgkTBHM2N/P+MPR7hIjB3OzN427/WvgQYAPTTeKqgtlNiAAAAAElFTkSuQmCC');
 		// console.log( "WFES showDetails", details);
 		let myDescID = "wfesDescrition";
 		let myGameID = "wfesGame";
-		
+
 		if ( null === document.getElementById(myDescID)) {
 			let descriptionText = document.createElement("div");
 			descriptionText.setAttribute('id',myDescID);
@@ -90,7 +89,7 @@ IYqHgkTBHM2N/P+MPR7hIjB3OzN427/WvgQYAPTTeKqgtlNiAAAAAElFTkSuQmCC');
 			gameLogo.setAttribute('id',myGameID);
 			userBox.appendChild(gameLogo);
 		}
-		
+
 		switch (details.discovererGame) {
 			case '': // no logo
 				klasse = 'bgNone';