From 645eb051eca434ee579ad651d97deb5223984105 Mon Sep 17 00:00:00 2001
From: Julian Lam <julian@designcreateplay.com>
Date: Wed, 16 Jul 2014 21:09:25 -0400
Subject: [PATCH] added new hook filter:app.load, and deprecated
 action:app.load, hopefully fixes #1822

---
 src/plugins.js      | 26 ++++++++++++++++++++++++--
 src/routes/index.js | 15 +++++++++------
 2 files changed, 33 insertions(+), 8 deletions(-)

diff --git a/src/plugins.js b/src/plugins.js
index f9c97bb180..5fb2b22af3 100644
--- a/src/plugins.js
+++ b/src/plugins.js
@@ -266,7 +266,6 @@ var fs = require('fs'),
 			`data` is an object consisting of (* is required):
 				`data.hook`*, the name of the NodeBB hook
 				`data.method`*, the method called in that plugin
-				`data.callbacked`, whether or not the hook expects a callback (true), or a return (false). Only used for filters. (Default: false)
 				`data.priority`, the relative priority of the method when it is eventually called (default: 10)
 		*/
 
@@ -327,6 +326,10 @@ var fs = require('fs'),
 									next(arguments[0], Array.prototype.slice.call(arguments, 1));
 								}));
 
+								/*
+									Backwards compatibility block for v0.5.0
+									Remove this once NodeBB enters v0.5.0-1
+								*/
 								if (value !== undefined && value !== callback) {
 									winston.warn('[plugins/' + hookObj.id + '] "callbacked" deprecated as of 0.4x. Use asynchronous method instead for hook: ' + hook);
 									next(null, [value]);
@@ -353,7 +356,17 @@ var fs = require('fs'),
 					});
 					break;
 				case 'action':
-					async.each(hookList, function(hookObj) {
+					var deprecationWarn = [];
+					async.each(hookList, function(hookObj, next) {
+						/*
+							Backwards compatibility block for v0.5.0
+							Remove this once NodeBB enters v0.5.0-1
+						*/
+						if (hook === 'action:app.load') {
+							deprecationWarn.push(hookObj.id);
+						}
+						/* End backwards compatibility block */
+
 						if (hookObj.method) {
 							hookObj.method.apply(Plugins, args);
 						} else {
@@ -361,6 +374,15 @@ var fs = require('fs'),
 								winston.info('[plugins] Expected method \'' + hookObj.method + '\' in plugin \'' + hookObj.id + '\' not found, skipping.');
 							}
 						}
+
+						next();
+					}, function() {
+						if (deprecationWarn.length) {
+							winston.warn('[plugins] The `action:app.load` hook is deprecated in favour of `filter:app.load`, please notify the developers of the following plugins:');
+							for(var x=0,numDeprec=deprecationWarn.length;x<numDeprec;x++) {
+								process.stdout.write('  * ' + deprecationWarn[x] + '\n');
+							}
+						}
 					});
 					break;
 				default:
diff --git a/src/routes/index.js b/src/routes/index.js
index 70142f9256..d2eead3c11 100644
--- a/src/routes/index.js
+++ b/src/routes/index.js
@@ -164,6 +164,7 @@ module.exports = function(app, middleware) {
 		router.all('/admin/*', middleware.admin.isAdmin);
 		router.get('/admin', middleware.admin.isAdmin);
 
+		// Deprecated as of v0.5.0, remove this hook call for NodeBB v0.6.0-1
 		plugins.fireHook('action:app.load', app, middleware, controllers);
 
 		adminRoutes(router, middleware, controllers);
@@ -186,13 +187,15 @@ module.exports = function(app, middleware) {
 		userRoutes(router, middleware, controllers);
 		groupRoutes(router, middleware, controllers);
 
-		app.use(nconf.get('relative_path'), router);
+		plugins.fireHook('filter:app.load', app, middleware, controllers, function() {
+			app.use(nconf.get('relative_path'), router);
 
-		app.use(nconf.get('relative_path'), express.static(path.join(__dirname, '../../', 'public'), {
-			maxAge: app.enabled('cache') ? 5184000000 : 0
-		}));
-		app.use(catch404);
-		app.use(handleErrors);
+			app.use(nconf.get('relative_path'), express.static(path.join(__dirname, '../../', 'public'), {
+				maxAge: app.enabled('cache') ? 5184000000 : 0
+			}));
+			app.use(catch404);
+			app.use(handleErrors);
+		});
 	});
 
 	if (process.env.NODE_ENV === 'development') {