Chore: clean up excessive debug messages

Many were useful during debugging, but not any more.

Author: GwynethLlewelyn

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ... are most welcome!
 
-Mora _complex_ ones should be (preferably!) as a Pull Request (PR) on GitHub.
+More _complex_ ones should be (preferably!) as a Pull Request (PR) on GitHub.
 
 And don't forget to (automatically) add yourself as a contributor: https://allcontributors.org/docs/en/bot/usage
 
@@ -14,4 +14,6 @@ I used to zip things properly (on a Mac) with:
 
 However, since having found that GitHub _will_ deal with automatically creating the zip file *without* even needing an intermediate step when packaging everything together. My new command is now:
 
-`git archive -9 -o postlocalstorage.zip HEAD gwynethllewelyn/** `
+`git archive -9 -o postlocalstorage.zip HEAD gwynethllewelyn/** `
+
+It's still somewhat experimental, though...

gwynethllewelyn/postlocalstorage/composer.json

@@ -4,7 +4,7 @@
 	"description": "A simple phpBB3 extension to locally store the content of a post being written, to avoid losing everything after a crash or session expiration.",
 	"homepage": "https://github.com/GwynethLlewelyn/post-local-storage",
 	"version": "1.2.1",
-	"time": "2024-04-22",
+	"time": "2024-04-26",
 	"license": "GPL-2.0-only",
 	"keywords": [
 		"phpbb",

gwynethllewelyn/postlocalstorage/event/listener.php

@@ -75,7 +75,12 @@ static public function getSubscribedEvents()
 	 */
 	public function check_expiry_time($event)
 	{
-		error_log('[phpBB3 postlocalstorage] checking for expiry time...' . empty($event) ? '(empty event data)' : '(we got something on the event data)');
+		// The following code is unneeded, it's just here to avoid errors/warnings
+		// from the many code-checking tools. (gwyneth 20230426)
+		if (!empty($event))
+		{
+			error_log('[phpBB3 postlocalstorage] checking for expiry time... (we got something on the event data)');
+		}
 
 		try
 		{
@@ -89,19 +94,19 @@ public function check_expiry_time($event)
 		}
 		catch (Exception $e)
 		{
-			error_log('[phpBB3 postlocalstorage] Something is wrong with session_length: ' . $e->getMessage());
+			error_log('[phpBB3 postlocalstorage] Something is wrong with `\$session_length`: ' . $e->getMessage());
 			$session_length = 0;
 		}
 		$session_expiry_time = $this->time_now + $session_length;
 
-		error_log(
+/* 		error_log(
 			'[phpBB3 postlocalstorage] check_expiry_time: $this->time_now is '
 			. $this->time_now
 			. ' $session_length is '
 			. $session_length
 			. '; Total is: '
 			. $session_expiry_time
-		);
+		); */
 
 		$this->template->assign_vars(array(
 			'EXPIRY_TIME' => $session_expiry_time,

gwynethllewelyn/postlocalstorage/styles/all/template/postlocalstorage_functions.js

@@ -23,7 +23,7 @@
 
 	// If there is no localStorage support, give up
 	if (!message.localStorage) {
-		console.debug("no local storage support");
+		console.debug("[phpBB3 postlocalstorage] no local storage support");
 		return;
 	}
 	/**
@@ -33,7 +33,7 @@
 	const textarea = document.querySelector('textarea[name="message"]');
 	// no point in being around if this is nil; also: avoids crashing below (gwyneth 20220303)
 	if (!textarea) {
-		console.debug("no phpBB3 content body textarea found, skipping");
+		console.debug("[phpBB3 postlocalstorage] no phpBB3 content body textarea found, skipping");
 		return;
 	}
 	/**
@@ -42,7 +42,7 @@
 	 */
 	const subject = document.querySelector('input[name="subject"]');
 	if (!subject) {
-		console.debug("no phpBB3 subject line found");
+		console.debug("[phpBB3 postlocalstorage] no phpBB3 subject line found");
 		// I have not decided what to do in this case! Possibly just:
 		// subject = "(no subject)";
 	}
@@ -56,16 +56,16 @@
 	// @see https://www.phpbb.com/customise/db/extension/postlocalstorage/support/topic/246616?p=877489#p877489
 	//if key.includes (viewforum.php) then exit
 	if (key.includes("viewforum.php")) {
-		console.debug("viewforum, no message box");
+	//	console.debug("[phpBB3 postlocalstorage] viewforum, no message box");
 		return;
 	}
 
-	// POSTING
-	//possible key formats
-	//./phpBB3/posting.php?mode=edit&p=xxxxx#preview#preview#preview#preview .......
-	//./phpBB3/posting.php?mode=quote&p=xxxxx#preview#preview#preview#preview .......
-	//./phpBB3/posting.php?mode=reply&t=yyyyy#preview#preview#preview#preview .......
-	//Remove all "#preview" strings at the end
+	// ## POSTING
+	// possible key formats
+	// ./phpBB3/posting.php?mode=edit&p=xxxxx#preview#preview#preview#preview .......
+	// ./phpBB3/posting.php?mode=quote&p=xxxxx#preview#preview#preview#preview .......
+	//. /phpBB3/posting.php?mode=reply&t=yyyyy#preview#preview#preview#preview .......
+	// Remove all "#preview" strings at the end
 	else if (key.includes("posting.php?mode=")) {
 		if (key.endsWith("#preview")) {
 			var count_hash = key.split("#").length - 1;
@@ -75,65 +75,69 @@
 		}
 	}
 
-	// PM'ing
-	//possible key formats
+	// ## PM'ing
+	// possible key formats
 
-	//1st case
-	//./phpBB3/ucp.php?i=pm&mode=compose
-	//do nothing
+	// - 1st case
+	// ./phpBB3/ucp.php?i=pm&mode=compose
+	// do nothing
 
-	//2nd case
-	//./phpBB3/ucp.php?i=ucp_pm&mode=compose returns
-	//./phpBB3/ucp.php?i=pm&mode=compose
+	// - 2nd case
+	// ./phpBB3/ucp.php?i=ucp_pm&mode=compose returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose
 	else if (key.includes("ucp.php?i=ucp_pm&mode=compose")) {
 		key = key.split("?")[0].concat("?i=pm&mode=compose");
 	}
 
-	//3rd case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=post&sid=sssssssssssssssssssssssssss returns
-	//./phpBB3/ucp.php?i=pm&mode=compose
+	// - 3rd case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=post&sid=sssssssssssssssssssssssssss returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose
 	else if (key.includes("ucp.php?i=pm&mode=compose&action=post")) {
 		key = key.split("?")[0].concat("?i=pm&mode=compose");
 	}
 
-	//4th case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=reply&f=xxx&p=yyy returns
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=reply&p=yyy
-	//5th case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=forward&f=xxx&p=yyy returns
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=forward&p=yyy
-	//6th case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=quote&f=xxx&p=yyy returns
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=quote&p=yyy
-
-	else if (key.includes("ucp.php?i=pm&mode=compose&action=reply&f=") || key.includes("ucp.php?i=pm&mode=compose&action=forward&f=") || key.includes("ucp.php?i=pm&mode=compose&action=quote&f=")) {
+	// - 4th case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=reply&f=xxx&p=yyy returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=reply&p=yyy
+	// - 5th case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=forward&f=xxx&p=yyy returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=forward&p=yyy
+	// - 6th case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=quote&f=xxx&p=yyy returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=quote&p=yyy
+	else if (
+		   key.includes("ucp.php?i=pm&mode=compose&action=reply&f=")
+		|| key.includes("ucp.php?i=pm&mode=compose&action=forward&f=")
+		|| key.includes("ucp.php?i=pm&mode=compose&action=quote&f=")) {
 		var fpos = key.indexOf("&f="),
 			ppos = key.indexOf("&p=");
 		if (fpos > -1 && ppos > fpos) {
 			key = key.substring(0, fpos) + key.substring(ppos);
 		}
 	}
 
-	//7th case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=reply&sid=sssssssssssssssssssssssssss&p=yyy returns
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=reply&p=yyy
-	//8th case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=forward&sid=sssssssssssssssssssssssssss&p=yyy returns
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=forward&p=yyy
-	//9th case
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=quote&sid=sssssssssssssssssssssssssss&p=yyy returns
-	//./phpBB3/ucp.php?i=pm&mode=compose&action=quote&p=yyy
-	else if (key.includes("ucp.php?i=pm&mode=compose&action=reply&sid=")
+	// - 7th case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=reply&sid=sssssssssssssssssssssssssss&p=yyy returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=reply&p=yyy
+	// - 8th case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=forward&sid=sssssssssssssssssssssssssss&p=yyy returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=forward&p=yyy
+	// - 9th case
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=quote&sid=sssssssssssssssssssssssssss&p=yyy returns
+	// ./phpBB3/ucp.php?i=pm&mode=compose&action=quote&p=yyy
+	else if (
+		key.includes("ucp.php?i=pm&mode=compose&action=reply&sid=")
 		|| key.includes("ucp.php?i=pm&mode=compose&action=forward&sid=")
-		|| key.includes("ucp.php?i=pm&mode=compose&action=quote&sid=")) {
+		|| key.includes("ucp.php?i=pm&mode=compose&action=quote&sid=")
+	) {
 		var sipos = key.indexOf("&sid="),
 			pipos = key.indexOf("&p=");
 		if (sipos > -1 && pipos > sipos) {
 			key = key.substring(0, sipos) + key.substring(pipos);
 		}
 	}
 	else {
-		console.debug("no appropriate message key or pm key found");
+		console.debug("[phpBB3 postlocalstorage] no appropriate post message key or PM key found");
 	}
 
 	/**
@@ -172,15 +176,15 @@
 			if (Date.now() - data.timestamp > FRESHNESS_INTERVAL) {
 				// Remove stale data. A new item will be added as soon as the user clicks a key.
 				message.localStorage.removeItem(key);
-				console.debug("stale data found; removing from localStorage");
+				console.debug("[phpBB3 postlocalstorage] stale data found; removing from localStorage");
 				return;
 			}
 			// Data is still considered "fresh" enough, so we replace the value of the textarea with
 			// what we have on the localStorage.
 			textarea.value = data?.content ?? "";
 			// same checking for subject.
 			subject.value = data?.subject ?? "";
-			console.debug("textarea content successfully restored");
+			console.debug("[phpBB3 postlocalstorage] textarea content successfully restored");
 		} else {
 			// We don't know if the existing data is stale or not, since it comes from pre-1.1.0 times.
 			// So, upgrade object to the new format, i.e. add a timestamp to existing content.
@@ -205,15 +209,15 @@
 		// Note: if the visibilitychange event is being used, one should check to see if the visibilityState
 		// is 'hidden' or 'visible'; but we're going to save to storage in both cases.
 		if (message.visibilityState === "hidden") {
-			console.debug("Saving existing text before moving tab to background");
+			console.debug("[phpBB3 postlocalstorage] Saving existing text before moving tab to background");
 		}
 		if (textarea.value) {
 			item = JSON.stringify({ "content": textarea.value, "subject": (subject?.value ?? ""), "timestamp": Date.now() });
 			message.localStorage.setItem(key, item);
-			console.debug("Existing subject & content saved to localStorage");
+			// console.debug("[phpBB3 postlocalstorage] Existing subject & content saved to localStorage");
 		} else {
 			message.localStorage.removeItem(key);
-			console.debug("Empty textarea -- remove existing content & subject in localStorage");
+			console.debug("[phpBB3 postlocalstorage] Empty textarea -- remove existing content & subject in localStorage");
 		}
 	}
 	// When the user presses a key just *once* inside the textarea, run the storage function when the page is unloaded.
@@ -262,7 +266,7 @@
 			 */
 			const expiryTime = parseInt(document.getElementById('expiry-time')?.innerText.trim(), 10);
 			const dateNow = Math.floor(Date.now() / 1000); // we get milliseconds, so we need to convert to seconds.
-			console.debug("Date.now() in seconds is " + dateNow + " and expiryTime is " + expiryTime);
+			// console.debug("[phpBB3 postlocalstorage] `Date.now()` in seconds is " + dateNow + " and `expiryTime` is " + expiryTime);
 
 			//the if statement for deleting local storage in PM'ing, because expiryTime = 0, it must be fixed
 			//if (!key.includes("ucp.php")) {
@@ -282,11 +286,14 @@
 			// Kudos to @kylesands for this (gwyneth 20240416)
 			// Fixed lack of translation issue by using the 'name' value instead, but if either does
 			// not exist, localStorage will remain untouched.
-			if (document.activeElement.tagName?.toLowerCase() == "input" && document.activeElement.name?.toLowerCase() == "post") { // Added to only clear on Input button with Submit value
+			if (
+				document.activeElement.tagName?.toLowerCase() == "input"
+				&& document.activeElement.name?.toLowerCase() == "post"
+			) { // Added to only clear on Input button with Submit value
 				message.localStorage.removeItem(key);
 				message.removeEventListener(unloadEvent, updateStorage);
-				console.debug("Text submitted (not in preview!); removed from localStorage");
+				// console.debug("[phpBB3 postlocalstorage] Text submitted (not in preview!); removed from localStorage");
 			}
 		}
 	);
-})(this, this.document);
+})(this, this.document);