|
|
|
@ -3,42 +3,45 @@
|
|
|
|
const winston = require('winston');
|
|
|
|
const winston = require('winston');
|
|
|
|
const async = require('async');
|
|
|
|
const async = require('async');
|
|
|
|
const utils = require('../utils');
|
|
|
|
const utils = require('../utils');
|
|
|
|
|
|
|
|
const plugins = require('.');
|
|
|
|
|
|
|
|
|
|
|
|
module.exports = function (Plugins) {
|
|
|
|
const Hooks = {};
|
|
|
|
Plugins.deprecatedHooks = {
|
|
|
|
module.exports = Hooks;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Hooks.deprecatedHooks = {
|
|
|
|
'filter:privileges:isUserAllowedTo': 'filter:privileges:isAllowedTo', // 👋 @ 1.16.0
|
|
|
|
'filter:privileges:isUserAllowedTo': 'filter:privileges:isAllowedTo', // 👋 @ 1.16.0
|
|
|
|
'filter:router.page': 'response:router.page', // 👋 @ 2.0.0
|
|
|
|
'filter:router.page': 'response:router.page', // 👋 @ 2.0.0
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
Plugins.internals = {
|
|
|
|
Hooks.internals = {
|
|
|
|
_register: function (data) {
|
|
|
|
_register: function (data) {
|
|
|
|
Plugins.loadedHooks[data.hook] = Plugins.loadedHooks[data.hook] || [];
|
|
|
|
plugins.loadedHooks[data.hook] = plugins.loadedHooks[data.hook] || [];
|
|
|
|
Plugins.loadedHooks[data.hook].push(data);
|
|
|
|
plugins.loadedHooks[data.hook].push(data);
|
|
|
|
},
|
|
|
|
},
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
const hookTypeToMethod = {
|
|
|
|
const hookTypeToMethod = {
|
|
|
|
filter: fireFilterHook,
|
|
|
|
filter: fireFilterHook,
|
|
|
|
action: fireActionHook,
|
|
|
|
action: fireActionHook,
|
|
|
|
static: fireStaticHook,
|
|
|
|
static: fireStaticHook,
|
|
|
|
response: fireResponseHook,
|
|
|
|
response: fireResponseHook,
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
/*
|
|
|
|
`data` is an object consisting of (* is required):
|
|
|
|
`data` is an object consisting of (* is required):
|
|
|
|
`data.hook`*, the name of the NodeBB hook
|
|
|
|
`data.hook`*, the name of the NodeBB hook
|
|
|
|
`data.method`*, the method called in that plugin (can be an array of functions)
|
|
|
|
`data.method`*, the method called in that plugin (can be an array of functions)
|
|
|
|
`data.priority`, the relative priority of the method when it is eventually called (default: 10)
|
|
|
|
`data.priority`, the relative priority of the method when it is eventually called (default: 10)
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
Plugins.registerHook = function (id, data) {
|
|
|
|
Hooks.register = function (id, data) {
|
|
|
|
if (!data.hook || !data.method) {
|
|
|
|
if (!data.hook || !data.method) {
|
|
|
|
winston.warn('[plugins/' + id + '] registerHook called with invalid data.hook/method', data);
|
|
|
|
winston.warn('[plugins/' + id + '] registerHook called with invalid data.hook/method', data);
|
|
|
|
return;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// `hasOwnProperty` needed for hooks with no alternative (set to null)
|
|
|
|
// `hasOwnProperty` needed for hooks with no alternative (set to null)
|
|
|
|
if (Plugins.deprecatedHooks.hasOwnProperty(data.hook)) {
|
|
|
|
if (Hooks.deprecatedHooks.hasOwnProperty(data.hook)) {
|
|
|
|
const deprecated = Plugins.deprecatedHooks[data.hook];
|
|
|
|
const deprecated = Hooks.deprecatedHooks[data.hook];
|
|
|
|
|
|
|
|
|
|
|
|
if (deprecated) {
|
|
|
|
if (deprecated) {
|
|
|
|
winston.warn(`[plugins/${id}] Hook "${data.hook}" is deprecated, please use "${deprecated}" instead.`);
|
|
|
|
winston.warn(`[plugins/${id}] Hook "${data.hook}" is deprecated, please use "${deprecated}" instead.`);
|
|
|
|
@ -56,7 +59,7 @@ module.exports = function (Plugins) {
|
|
|
|
// Go go gadget recursion!
|
|
|
|
// Go go gadget recursion!
|
|
|
|
data.method.forEach(function (method) {
|
|
|
|
data.method.forEach(function (method) {
|
|
|
|
const singularData = { ...data, method: method };
|
|
|
|
const singularData = { ...data, method: method };
|
|
|
|
Plugins.registerHook(id, singularData);
|
|
|
|
Hooks.register(id, singularData);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
} else if (typeof data.method === 'string' && data.method.length > 0) {
|
|
|
|
} else if (typeof data.method === 'string' && data.method.length > 0) {
|
|
|
|
const method = data.method.split('.').reduce(function (memo, prop) {
|
|
|
|
const method = data.method.split('.').reduce(function (memo, prop) {
|
|
|
|
@ -65,30 +68,30 @@ module.exports = function (Plugins) {
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// Couldn't find method by path, aborting
|
|
|
|
// Couldn't find method by path, aborting
|
|
|
|
return null;
|
|
|
|
return null;
|
|
|
|
}, Plugins.libraries[data.id]);
|
|
|
|
}, plugins.libraries[data.id]);
|
|
|
|
|
|
|
|
|
|
|
|
// Write the actual method reference to the hookObj
|
|
|
|
// Write the actual method reference to the hookObj
|
|
|
|
data.method = method;
|
|
|
|
data.method = method;
|
|
|
|
|
|
|
|
|
|
|
|
Plugins.internals._register(data);
|
|
|
|
Hooks.internals._register(data);
|
|
|
|
} else if (typeof data.method === 'function') {
|
|
|
|
} else if (typeof data.method === 'function') {
|
|
|
|
Plugins.internals._register(data);
|
|
|
|
Hooks.internals._register(data);
|
|
|
|
} else {
|
|
|
|
} else {
|
|
|
|
winston.warn('[plugins/' + id + '] Hook method mismatch: ' + data.hook + ' => ' + data.method);
|
|
|
|
winston.warn('[plugins/' + id + '] Hook method mismatch: ' + data.hook + ' => ' + data.method);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
Plugins.unregisterHook = function (id, hook, method) {
|
|
|
|
Hooks.unregister = function (id, hook, method) {
|
|
|
|
var hooks = Plugins.loadedHooks[hook] || [];
|
|
|
|
var hooks = plugins.loadedHooks[hook] || [];
|
|
|
|
Plugins.loadedHooks[hook] = hooks.filter(function (hookData) {
|
|
|
|
plugins.loadedHooks[hook] = hooks.filter(function (hookData) {
|
|
|
|
return hookData && hookData.id !== id && hookData.method !== method;
|
|
|
|
return hookData && hookData.id !== id && hookData.method !== method;
|
|
|
|
});
|
|
|
|
});
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
Plugins.fireHook = async function (hook, params) {
|
|
|
|
Hooks.fire = async function (hook, params) {
|
|
|
|
const hookList = Plugins.loadedHooks[hook];
|
|
|
|
const hookList = plugins.loadedHooks[hook];
|
|
|
|
const hookType = hook.split(':')[0];
|
|
|
|
const hookType = hook.split(':')[0];
|
|
|
|
if (global.env === 'development' && hook !== 'action:plugins.firehook') {
|
|
|
|
if (global.env === 'development' && hook !== 'action:plugins.fireHook') {
|
|
|
|
winston.verbose('[plugins/fireHook] ' + hook);
|
|
|
|
winston.verbose('[plugins/fireHook] ' + hook);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
@ -98,15 +101,19 @@ module.exports = function (Plugins) {
|
|
|
|
}
|
|
|
|
}
|
|
|
|
const result = await hookTypeToMethod[hookType](hook, hookList, params);
|
|
|
|
const result = await hookTypeToMethod[hookType](hook, hookList, params);
|
|
|
|
|
|
|
|
|
|
|
|
if (hook !== 'action:plugins.firehook') {
|
|
|
|
if (hook !== 'action:plugins.fireHook') {
|
|
|
|
Plugins.fireHook('action:plugins.firehook', { hook: hook, params: params });
|
|
|
|
Hooks.fire('action:plugins.fireHook', { hook: hook, params: params });
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (result !== undefined) {
|
|
|
|
if (result !== undefined) {
|
|
|
|
return result;
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Hooks.hasListeners = function (hook) {
|
|
|
|
|
|
|
|
return !!(plugins.loadedHooks[hook] && plugins.loadedHooks[hook].length > 0);
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
async function fireFilterHook(hook, hookList, params) {
|
|
|
|
async function fireFilterHook(hook, hookList, params) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
return params;
|
|
|
|
return params;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
@ -126,9 +133,9 @@ module.exports = function (Plugins) {
|
|
|
|
);
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
async function fireActionHook(hook, hookList, params) {
|
|
|
|
async function fireActionHook(hook, hookList, params) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
return;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
@ -142,9 +149,9 @@ module.exports = function (Plugins) {
|
|
|
|
await hookObj.method(params);
|
|
|
|
await hookObj.method(params);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
async function fireStaticHook(hook, hookList, params) {
|
|
|
|
async function fireStaticHook(hook, hookList, params) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
return;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
@ -184,9 +191,9 @@ module.exports = function (Plugins) {
|
|
|
|
callback(err);
|
|
|
|
callback(err);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
async function fireResponseHook(hook, hookList, params) {
|
|
|
|
async function fireResponseHook(hook, hookList, params) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
if (!Array.isArray(hookList) || !hookList.length) {
|
|
|
|
return;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
@ -205,9 +212,4 @@ module.exports = function (Plugins) {
|
|
|
|
|
|
|
|
|
|
|
|
await hookObj.method(params);
|
|
|
|
await hookObj.method(params);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
Plugins.hasListeners = function (hook) {
|
|
|
|
|
|
|
|
return !!(Plugins.loadedHooks[hook] && Plugins.loadedHooks[hook].length > 0);
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
Julian Lam
5 years ago