Julian Lam
12 years ago
commit
235553eaf6
@ -0,0 +1,38 @@
|
|||||||
|
var nodebb_admin = nodebb_admin || {};
|
||||||
|
|
||||||
|
(function() {
|
||||||
|
var plugins = {
|
||||||
|
init: function() {
|
||||||
|
var pluginsList = $('.plugins'),
|
||||||
|
numPlugins = pluginsList[0].querySelectorAll('li').length,
|
||||||
|
pluginID, pluginTgl;
|
||||||
|
|
||||||
|
if (numPlugins > 0) {
|
||||||
|
pluginsList.on('click', 'button[data-action="toggleActive"]', function() {
|
||||||
|
pluginID = $(this).parents('li').attr('data-plugin-id');
|
||||||
|
socket.emit('api:admin.plugins.toggle', pluginID);
|
||||||
|
});
|
||||||
|
|
||||||
|
socket.on('api:admin.plugins.toggle', function(status) {
|
||||||
|
pluginTgl = document.querySelector('.plugins li[data-plugin-id="' + status.id + '"] button');
|
||||||
|
pluginTgl.innerHTML = '<i class="icon-off"></i> ' + (status.active ? 'Dea' : 'A') + 'ctivate';
|
||||||
|
|
||||||
|
app.alert({
|
||||||
|
alert_id: 'plugin_toggled_' + status.id,
|
||||||
|
title: 'Plugin Enabled',
|
||||||
|
message: 'You may need to restart NodeBB in order for these changes to be reflected.',
|
||||||
|
type: 'notify',
|
||||||
|
timeout: 5000
|
||||||
|
})
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
pluginsList.append('<li><p><i>No plugins found.</i></p></li>');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
jQuery(document).ready(function() {
|
||||||
|
nodebb_admin.plugins = plugins;
|
||||||
|
nodebb_admin.plugins.init();
|
||||||
|
});
|
||||||
|
})();
|
||||||
@ -0,0 +1,25 @@
|
|||||||
|
<h1>Plugins</h1>
|
||||||
|
|
||||||
|
<ul class="plugins">
|
||||||
|
<!-- BEGIN plugins -->
|
||||||
|
<li data-plugin-id="{plugins.id}">
|
||||||
|
<h2>{plugins.name}</h2>
|
||||||
|
<div class="pull-right">
|
||||||
|
<button data-action="toggleActive" class="btn btn-primary">{plugins.activeText}</button>
|
||||||
|
</div>
|
||||||
|
<p>{plugins.description}</p>
|
||||||
|
<p>For more information: <a href="{plugins.url}">{plugins.url}</a></p>
|
||||||
|
</li>
|
||||||
|
<!-- END plugins -->
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<div class="alert">
|
||||||
|
<p>
|
||||||
|
<strong>Interesed in writing plugins for NodeBB?</strong>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Full documentation regarding plugin authoring can be found in the <a target="_blank" href="https://github.com/designcreateplay/NodeBB/wiki/Writing-Plugins-for-NodeBB">NodeBB Wiki</a>.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="{relative_path}/src/forum/admin/plugins.js"></script>
|
||||||
@ -0,0 +1,203 @@
|
|||||||
|
var fs = require('fs'),
|
||||||
|
path = require('path'),
|
||||||
|
RDB = require('./redis.js'),
|
||||||
|
async = require('async'),
|
||||||
|
plugins = {
|
||||||
|
libraries: [],
|
||||||
|
loadedHooks: {},
|
||||||
|
init: function() {
|
||||||
|
if (this.initialized) return;
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Initializing plugins system');
|
||||||
|
|
||||||
|
var _self = this;
|
||||||
|
|
||||||
|
// Read the list of activated plugins and require their libraries
|
||||||
|
async.waterfall([
|
||||||
|
function(next) {
|
||||||
|
RDB.smembers('plugins:active', next);
|
||||||
|
},
|
||||||
|
function(plugins, next) {
|
||||||
|
async.each(plugins, function(plugin) {
|
||||||
|
// TODO: Update this check to also check node_modules
|
||||||
|
var pluginPath = path.join(__dirname, '../plugins/', plugin);
|
||||||
|
fs.exists(pluginPath, function(exists) {
|
||||||
|
if (exists) {
|
||||||
|
fs.readFile(path.join(pluginPath, 'plugin.json'), function(err, data) {
|
||||||
|
if (err) return next(err);
|
||||||
|
|
||||||
|
var pluginData = JSON.parse(data);
|
||||||
|
_self.libraries[pluginData.id] = require(path.join(pluginPath, pluginData.library));
|
||||||
|
if (pluginData.hooks) {
|
||||||
|
for(var x=0,numHooks=pluginData.hooks.length;x<numHooks;x++) {
|
||||||
|
_self.registerHook(pluginData.id, pluginData.hooks[x]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Loaded plugin: ' + pluginData.id);
|
||||||
|
|
||||||
|
next();
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Plugin \'' + plugin + '\' not found');
|
||||||
|
next(); // Ignore this plugin silently
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}, next);
|
||||||
|
}
|
||||||
|
], function(err) {
|
||||||
|
if (err) {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] NodeBB encountered a problem while loading plugins', err.message);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Plugins OK');
|
||||||
|
});
|
||||||
|
},
|
||||||
|
initialized: false,
|
||||||
|
registerHook: function(id, data) {
|
||||||
|
/*
|
||||||
|
`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)
|
||||||
|
(Not implemented) `data.priority`, the relative priority of the method when it is eventually called (default: 10)
|
||||||
|
*/
|
||||||
|
var _self = this;
|
||||||
|
|
||||||
|
if (data.hook && data.method) {
|
||||||
|
_self.loadedHooks[data.hook] = _self.loadedHooks[data.hook] || [];
|
||||||
|
_self.loadedHooks[data.hook].push([id, data.method]);
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Hook registered: ' + data.hook + ' will call ' + id);
|
||||||
|
} else return;
|
||||||
|
},
|
||||||
|
fireHook: function(hook, args, callback) {
|
||||||
|
// TODO: Implement priority hook firing
|
||||||
|
var _self = this
|
||||||
|
hookList = this.loadedHooks[hook];
|
||||||
|
|
||||||
|
if (hookList && Array.isArray(hookList)) {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Firing hook: \'' + hook + '\'');
|
||||||
|
var hookType = hook.split(':')[0];
|
||||||
|
switch(hookType) {
|
||||||
|
case 'filter':
|
||||||
|
// Filters only take one argument, so only args[0] will be passed in
|
||||||
|
var returnVal = (Array.isArray(args) ? args[0] : args);
|
||||||
|
|
||||||
|
async.each(hookList, function(hookObj, next) {
|
||||||
|
if (hookObj.callbacked) {
|
||||||
|
_self.libraries[hookObj[0]][hookObj[1]](returnVal, function(err, afterVal) {
|
||||||
|
returnVal = afterVal;
|
||||||
|
next(err);
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
returnVal = _self.libraries[hookObj[0]][hookObj[1]](returnVal);
|
||||||
|
next();
|
||||||
|
}
|
||||||
|
}, function(err) {
|
||||||
|
if (err) {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Problem executing hook: ' + hook);
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(returnVal);
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
case 'action':
|
||||||
|
async.each(hookList, function(hookObj) {
|
||||||
|
if (
|
||||||
|
_self.libraries[hookObj[0]] &&
|
||||||
|
_self.libraries[hookObj[0]][hookObj[1]] &&
|
||||||
|
typeof _self.libraries[hookObj[0]][hookObj[1]] === 'function'
|
||||||
|
) {
|
||||||
|
_self.libraries[hookObj[0]][hookObj[1]].apply(_self.libraries[hookObj[0]], args);
|
||||||
|
} else {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Expected method \'' + hookObj[1] + '\' in plugin \'' + hookObj[0] + '\' not found, skipping.');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
// Do nothing...
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Otherwise, this hook contains no methods
|
||||||
|
var returnVal = (Array.isArray(args) ? args[0] : args);
|
||||||
|
if (callback) callback(returnVal);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
isActive: function(id, callback) {
|
||||||
|
RDB.sismember('plugins:active', id, callback);
|
||||||
|
},
|
||||||
|
toggleActive: function(id, callback) {
|
||||||
|
this.isActive(id, function(err, active) {
|
||||||
|
if (err) {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Could not toggle active state on plugin \'' + id + '\'');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
RDB[(active ? 'srem' : 'sadd')]('plugins:active', id, function(err, success) {
|
||||||
|
if (err) {
|
||||||
|
if (global.env === 'development') console.log('Info: [plugins] Could not toggle active state on plugin \'' + id + '\'');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
callback({
|
||||||
|
id: id,
|
||||||
|
active: !active
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
},
|
||||||
|
showInstalled: function(callback) {
|
||||||
|
// TODO: Also check /node_modules
|
||||||
|
var _self = this;
|
||||||
|
moduleBasePath = path.join(__dirname, '../plugins');
|
||||||
|
|
||||||
|
async.waterfall([
|
||||||
|
function(next) {
|
||||||
|
fs.readdir(moduleBasePath, next);
|
||||||
|
},
|
||||||
|
function(files, next) {
|
||||||
|
var plugins = [];
|
||||||
|
|
||||||
|
async.each(files, function(file, next) {
|
||||||
|
var modulePath = path.join(moduleBasePath, file),
|
||||||
|
configPath;
|
||||||
|
|
||||||
|
async.waterfall([
|
||||||
|
function(next) {
|
||||||
|
fs.stat(path.join(moduleBasePath, file), next);
|
||||||
|
},
|
||||||
|
function(stats, next) {
|
||||||
|
if (stats.isDirectory()) fs.readFile(path.join(modulePath, 'plugin.json'), next);
|
||||||
|
else next(new Error('not-a-directory'));
|
||||||
|
},
|
||||||
|
function(configJSON, next) {
|
||||||
|
var config = JSON.parse(configJSON);
|
||||||
|
_self.isActive(config.id, function(err, active) {
|
||||||
|
if (err) next(new Error('no-active-state'));
|
||||||
|
|
||||||
|
delete config.library;
|
||||||
|
delete config.hooks;
|
||||||
|
config.active = active;
|
||||||
|
config.activeText = '<i class="icon-off"></i> ' + (active ? 'Dea' : 'A') + 'ctivate';
|
||||||
|
next(null, config);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
], function(err, config) {
|
||||||
|
if (err) return next(); // Silently fail
|
||||||
|
|
||||||
|
plugins.push(config);
|
||||||
|
next();
|
||||||
|
});
|
||||||
|
}, function(err) {
|
||||||
|
next(null, plugins);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
], function(err, plugins) {
|
||||||
|
callback(err, plugins);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
plugins.init();
|
||||||
|
|
||||||
|
module.exports = plugins;
|
||||||
Loading…
Reference in New Issue