From d488512ca030154e5651e1227d4513a6ce51788a Mon Sep 17 00:00:00 2001
From: Pascal Deklerck <pascal.deklerck@gmail.com>
Date: Thu, 7 Jun 2018 22:23:30 +0200
Subject: [PATCH 1/6] 5118 Create Javascript hook mechanism

---
 view/js/addon-hooks.js  | 12 ++++++++++++
 view/js/main.js         | 17 +++++++++++++++++
 view/templates/head.tpl |  4 ++++
 3 files changed, 33 insertions(+)
 create mode 100644 view/js/addon-hooks.js

diff --git a/view/js/addon-hooks.js b/view/js/addon-hooks.js
new file mode 100644
index 0000000000..b00285cb3a
--- /dev/null
+++ b/view/js/addon-hooks.js
@@ -0,0 +1,12 @@
+var addon_hooks={};
+
+function Addon_registerHook( type, hookfnstr )
+{
+	if (!addon_hooks.hasOwnProperty(type)) {
+		addon_hooks[type]=[];
+	}
+
+	addon_hooks[type].push( hookfnstr );
+	
+	console.log("addon_hooks type "+type+" has "+addon_hooks[type].length+" hooks registered");
+}
diff --git a/view/js/main.js b/view/js/main.js
index 475e810870..f0bab12806 100644
--- a/view/js/main.js
+++ b/view/js/main.js
@@ -395,6 +395,19 @@ function NavUpdate() {
 	timer = setTimeout(NavUpdate, updateInterval);
 }
 
+function callAddonHooks(typeOfHook) {
+	if (typeof addon_hooks !== 'undefined') {
+		var myTypeOfHooks = addon_hooks[typeOfHook]; 
+		if (typeof myTypeOfHooks !== 'undefined') {
+			for (addon_hook_idx = 0; addon_hook_idx < myTypeOfHooks.length; addon_hook_idx++) {
+				var hookfnstr = myTypeOfHooks[addon_hook_idx];
+				var hookfn = window[hookfnstr];
+				if (typeof hookfn === "function") hookfn();
+			}
+		}
+	} 
+}
+
 function liveUpdate(src) {
 	if ((src == null) || stopped || !profile_uid) {
 		$('.like-rotator').hide(); return;
@@ -460,6 +473,8 @@ function liveUpdate(src) {
 			prev = ident;
 		});
 
+		callAddonHooks("postprocess");
+
 		$('.like-rotator').hide();
 		if (commentBusy) {
 			commentBusy = false;
@@ -469,7 +484,9 @@ function liveUpdate(src) {
 		$(".comment-edit-form  textarea").editor_autocomplete(baseurl+"/acl");
 		/* autocomplete bbcode */
 		$(".comment-edit-form  textarea").bbco_autocomplete('bbcode');
+
 	});
+
 }
 
 function imgbright(node) {
diff --git a/view/templates/head.tpl b/view/templates/head.tpl
index c58b2b8290..75a676a91e 100644
--- a/view/templates/head.tpl
+++ b/view/templates/head.tpl
@@ -44,6 +44,10 @@
 <script type="text/javascript" src="view/asset/perfect-scrollbar/js/perfect-scrollbar.jquery.min.js" ></script>
 <script type="text/javascript" src="view/js/acl.js" ></script>
 <script type="text/javascript" src="view/asset/base64/base64.min.js" ></script>
+<script type="text/javascript" src="view/js/addon-hooks.js" ></script>
+{{foreach $addon_hooks as $addon_hook}}
+<script type="text/javascript" src="addon/{{$addon_hook}}/{{$addon_hook}}.js"></script>
+{{/foreach}}
 <script type="text/javascript" src="view/js/main.js" ></script>
 <script>
 

From ef01dfefd48c890dc2c2aae4f34ce5929714e983 Mon Sep 17 00:00:00 2001
From: Pascal Deklerck <pascal.deklerck@gmail.com>
Date: Thu, 7 Jun 2018 22:25:39 +0200
Subject: [PATCH 2/6] Remove console logging

---
 view/js/addon-hooks.js | 2 --
 1 file changed, 2 deletions(-)

diff --git a/view/js/addon-hooks.js b/view/js/addon-hooks.js
index b00285cb3a..2530f10bea 100644
--- a/view/js/addon-hooks.js
+++ b/view/js/addon-hooks.js
@@ -7,6 +7,4 @@ function Addon_registerHook( type, hookfnstr )
 	}
 
 	addon_hooks[type].push( hookfnstr );
-	
-	console.log("addon_hooks type "+type+" has "+addon_hooks[type].length+" hooks registered");
 }

From a11103a3a7c5ab1f2f4cef785862219c5b881363 Mon Sep 17 00:00:00 2001
From: Pascal Deklerck <pascal.deklerck@gmail.com>
Date: Wed, 13 Jun 2018 09:31:08 +0200
Subject: [PATCH 3/6] Code organisation and documentation of JS hook code

---
 view/js/addon-hooks.js | 28 ++++++++++++++++++++++++++++
 view/js/main.js        | 15 +--------------
 2 files changed, 29 insertions(+), 14 deletions(-)

diff --git a/view/js/addon-hooks.js b/view/js/addon-hooks.js
index 2530f10bea..8094a7d64a 100644
--- a/view/js/addon-hooks.js
+++ b/view/js/addon-hooks.js
@@ -1,5 +1,16 @@
+/**
+ * @file addon-hooks.js
+ * @brief Provide a way for add-ons to register a JavaScript hook
+ */
+
 var addon_hooks={};
 
+/**
+ * @brief Register a JavaScript hook to be called from other Javascript files
+ * @pre the .js file from which the hook will be called is included in the document response
+ * @param type which type of hook i.e. where should it be called along with other hooks of the same type
+ * @param hookfnstr name of the JavaScript function name that needs to be called
+ */
 function Addon_registerHook( type, hookfnstr )
 {
 	if (!addon_hooks.hasOwnProperty(type)) {
@@ -8,3 +19,20 @@ function Addon_registerHook( type, hookfnstr )
 
 	addon_hooks[type].push( hookfnstr );
 }
+
+/**
+ * @brief Call all registered hooks of a certain type, i.e. at the same point of the JavaScript code execution
+ * @param typeOfHook string indicating which type of hooks to be called among the registered hooks
+ */
+function callAddonHooks( typeOfHook ) {
+	if (typeof addon_hooks !== 'undefined') {
+		var myTypeOfHooks = addon_hooks[typeOfHook]; 
+		if (typeof myTypeOfHooks !== 'undefined') {
+			for (addon_hook_idx = 0; addon_hook_idx < myTypeOfHooks.length; addon_hook_idx++) {
+				var hookfnstr = myTypeOfHooks[addon_hook_idx];
+				var hookfn = window[hookfnstr];
+				if (typeof hookfn === "function") hookfn();
+			}
+		}
+	} 
+}
diff --git a/view/js/main.js b/view/js/main.js
index f0bab12806..b5043601ce 100644
--- a/view/js/main.js
+++ b/view/js/main.js
@@ -395,19 +395,6 @@ function NavUpdate() {
 	timer = setTimeout(NavUpdate, updateInterval);
 }
 
-function callAddonHooks(typeOfHook) {
-	if (typeof addon_hooks !== 'undefined') {
-		var myTypeOfHooks = addon_hooks[typeOfHook]; 
-		if (typeof myTypeOfHooks !== 'undefined') {
-			for (addon_hook_idx = 0; addon_hook_idx < myTypeOfHooks.length; addon_hook_idx++) {
-				var hookfnstr = myTypeOfHooks[addon_hook_idx];
-				var hookfn = window[hookfnstr];
-				if (typeof hookfn === "function") hookfn();
-			}
-		}
-	} 
-}
-
 function liveUpdate(src) {
 	if ((src == null) || stopped || !profile_uid) {
 		$('.like-rotator').hide(); return;
@@ -473,7 +460,7 @@ function liveUpdate(src) {
 			prev = ident;
 		});
 
-		callAddonHooks("postprocess");
+		callAddonHooks("postprocess_liveupdate");
 
 		$('.like-rotator').hide();
 		if (commentBusy) {

From b54d1b708ad2380598b695f3f603c663be0ae706 Mon Sep 17 00:00:00 2001
From: Pascal Deklerck <pascal.deklerck@gmail.com>
Date: Wed, 13 Jun 2018 21:03:19 +0200
Subject: [PATCH 4/6] Code standards updates

---
 view/js/addon-hooks.js | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/view/js/addon-hooks.js b/view/js/addon-hooks.js
index 8094a7d64a..3e1cb4849e 100644
--- a/view/js/addon-hooks.js
+++ b/view/js/addon-hooks.js
@@ -3,7 +3,7 @@
  * @brief Provide a way for add-ons to register a JavaScript hook
  */
 
-var addon_hooks={};
+var addon_hooks = {};
 
 /**
  * @brief Register a JavaScript hook to be called from other Javascript files
@@ -11,28 +11,31 @@ var addon_hooks={};
  * @param type which type of hook i.e. where should it be called along with other hooks of the same type
  * @param hookfnstr name of the JavaScript function name that needs to be called
  */
-function Addon_registerHook( type, hookfnstr )
+function Addon_registerHook(type, hookfnstr)
 {
 	if (!addon_hooks.hasOwnProperty(type)) {
-		addon_hooks[type]=[];
+		addon_hooks[type] = [];
 	}
 
-	addon_hooks[type].push( hookfnstr );
+	addon_hooks[type].push(hookfnstr);
 }
 
 /**
  * @brief Call all registered hooks of a certain type, i.e. at the same point of the JavaScript code execution
  * @param typeOfHook string indicating which type of hooks to be called among the registered hooks
  */
-function callAddonHooks( typeOfHook ) {
+function callAddonHooks(typeOfHook)
+{
 	if (typeof addon_hooks !== 'undefined') {
-		var myTypeOfHooks = addon_hooks[typeOfHook]; 
+		var myTypeOfHooks = addon_hooks[typeOfHook];
 		if (typeof myTypeOfHooks !== 'undefined') {
 			for (addon_hook_idx = 0; addon_hook_idx < myTypeOfHooks.length; addon_hook_idx++) {
 				var hookfnstr = myTypeOfHooks[addon_hook_idx];
 				var hookfn = window[hookfnstr];
-				if (typeof hookfn === "function") hookfn();
+				if (typeof hookfn === "function") {
+					hookfn();
+				}
 			}
 		}
-	} 
+	}
 }

From ba4ddb1d8d9492b73b0a8bda66391a3c65278271 Mon Sep 17 00:00:00 2001
From: Pascal Deklerck <pascal.deklerck@gmail.com>
Date: Wed, 13 Jun 2018 21:04:21 +0200
Subject: [PATCH 5/6] Test if addon_hooks is an array before using it

---
 view/templates/head.tpl | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/view/templates/head.tpl b/view/templates/head.tpl
index 75a676a91e..b3dfbc1f4e 100644
--- a/view/templates/head.tpl
+++ b/view/templates/head.tpl
@@ -45,9 +45,11 @@
 <script type="text/javascript" src="view/js/acl.js" ></script>
 <script type="text/javascript" src="view/asset/base64/base64.min.js" ></script>
 <script type="text/javascript" src="view/js/addon-hooks.js" ></script>
+{{if is_array($addon_hooks)}}
 {{foreach $addon_hooks as $addon_hook}}
 <script type="text/javascript" src="addon/{{$addon_hook}}/{{$addon_hook}}.js"></script>
 {{/foreach}}
+{{/if}}
 <script type="text/javascript" src="view/js/main.js" ></script>
 <script>
 

From 0eace1ffa45f1e6ebf39167dff29cdfc84458e03 Mon Sep 17 00:00:00 2001
From: Pascal Deklerck <pascal.deklerck@gmail.com>
Date: Wed, 13 Jun 2018 21:34:19 +0200
Subject: [PATCH 6/6] Add JavaScript addon hook documentation in doc/Addons.md

---
 doc/Addons.md | 48 ++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 38 insertions(+), 10 deletions(-)

diff --git a/doc/Addons.md b/doc/Addons.md
index f7d93aac7a..b3f42b892e 100644
--- a/doc/Addons.md
+++ b/doc/Addons.md
@@ -25,22 +25,24 @@ Addons should contain a comment block with the four following parameters:
      * Author: John Q. Public <john@myfriendicasite.com>
      */
 
+Please also add a README or README.md file to the addon directory.
+It will be displayed in the admin panel and should include some further information in addition to the header information.
+
+PHP addon hooks
+---
+
 Register your addon hooks during installation.
 
     Addon::registerHook($hookname, $file, $function);
 
-$hookname is a string and corresponds to a known Friendica hook.
+$hookname is a string and corresponds to a known Friendica PHP hook.
 
 $file is a pathname relative to the top-level Friendica directory.
-This *should* be 'addon/addon_name/addon_name.php' in most cases.
+This *should* be 'addon/*addon_name*/*addon_name*.php' in most cases.
 
 $function is a string and is the name of the function which will be executed when the hook is called.
 
-Please also add a README or README.md file to the addon directory.
-It will be displayed in the admin panel and should include some further information in addition to the header information.
-
-Arguments
----
+#### Arguments
 Your hook callback functions will be called with at least one and possibly two arguments
 
     function myhook_function(App $a, &$b) {
@@ -50,7 +52,7 @@ Your hook callback functions will be called with at least one and possibly two a
 
 If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration.
 
-#### $a
+##### $a
 $a is the Friendica 'App' class.
 It contains a wealth of information about the current state of Friendica:
 
@@ -61,11 +63,27 @@ It contains a wealth of information about the current state of Friendica:
 
 It is recommeded you call this '$a' to match its usage elsewhere.
 
-#### $b
+##### $b
 $b can be called anything you like.
 This is information specific to the hook currently being processed, and generally contains information that is being immediately processed or acted on that you can use, display, or alter.
 Remember to declare it with '&' if you wish to alter it.
 
+JavaScript addon hooks
+---
+
+Register your addon hooks in file 'addon/*addon_name*/*addon_name*.js'.
+
+    Addon_registerHook(type,hookfnstr);
+
+*type* is the name of the hook and corresponds to a known Friendica JavaScript hook.
+*hookfnstr* is the name of your JavaScript function to execute.
+
+No arguments are provided to your JavaScript callback function. Example:
+
+    function myhook_function() {
+  
+    }
+
 Modules
 ---
 
@@ -106,7 +124,7 @@ In your code, like in the function addon_name_content(), load the template file
 
 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
 
-Current hooks
+Current PHP hooks
 -------------
 
 ### 'authenticate'
@@ -316,6 +334,12 @@ Hook data:
     'item' => item array (input)
     'html' => converted item body (input/output)
 
+Current JavaScript hooks
+-------------
+
+### 'postprocess_liveupdate'
+Called at the end of the live update process (XmlHttpRequest)
+
 Complete list of hook callbacks
 ---
 
@@ -618,3 +642,7 @@ Here is a complete list of all hook callbacks with file locations (as of 01-Apr-
 
     Addon::callHooks('atom_feed_end', $atom);
     Addon::callHooks('atom_feed_end', $atom);
+
+### view/js/main.js
+
+    callAddonHooks("postprocess_liveupdate");
\ No newline at end of file