| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296 |
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
| 'use strict';
var fs = require('fs'),
path = require('path'),
semver = require('semver'),
async = require('async'),
winston = require('winston'),
nconf = require('nconf'),
_ = require('underscore'),
file = require('../file');
var utils = require('../../public/src/utils'),
meta = require('../meta');
module.exports = function(Plugins) {
Plugins.loadPlugin = function(pluginPath, callback) {
Plugins.loadPluginInfo(pluginPath, function(err, pluginData) {
if (err) {
if (err.message === '[[error:parse-error]]') {
return callback();
}
return callback(pluginPath.match('nodebb-theme') ? null : err);
}
checkVersion(pluginData);
async.parallel([
function(next) {
registerHooks(pluginData, pluginPath, next);
},
function(next) {
mapStaticDirectories(pluginData, pluginPath, next);
},
function(next) {
mapFiles(pluginData, 'css', 'cssFiles', next);
},
function(next) {
mapFiles(pluginData, 'less', 'lessFiles', next);
},
function(next) {
mapClientSideScripts(pluginData, next);
},
function(next) {
mapClientModules(pluginData, next);
},
function(next) {
loadLanguages(pluginData, next);
}
], function(err) {
if (err) {
winston.verbose('[plugins] Could not load plugin : ' + pluginData.id);
return callback(err);
}
winston.verbose('[plugins] Loaded plugin: ' + pluginData.id);
callback();
});
});
};
function checkVersion(pluginData) {
function add() {
if (Plugins.versionWarning.indexOf(pluginData.id) === -1) {
Plugins.versionWarning.push(pluginData.id);
}
}
if (pluginData.nbbpm && pluginData.nbbpm.compatibility && semver.validRange(pluginData.nbbpm.compatibility)) {
if (!semver.satisfies(nconf.get('version'), pluginData.nbbpm.compatibility)) {
add();
}
} else {
add();
}
}
function registerHooks(pluginData, pluginPath, callback) {
if (!pluginData.library) {
return callback();
}
var libraryPath = path.join(pluginPath, pluginData.library);
try {
if (!Plugins.libraries[pluginData.id]) {
Plugins.requireLibrary(pluginData.id, libraryPath);
}
if (Array.isArray(pluginData.hooks) && pluginData.hooks.length > 0) {
async.each(pluginData.hooks, function(hook, next) {
Plugins.registerHook(pluginData.id, hook, next);
}, callback);
} else {
callback();
}
} catch(err) {
winston.error(err.stack);
winston.warn('[plugins] Unable to parse library for: ' + pluginData.id);
callback();
}
}
function mapStaticDirectories(pluginData, pluginPath, callback) {
function mapStaticDirs(mappedPath, callback) {
if (Plugins.staticDirs[mappedPath]) {
winston.warn('[plugins/' + pluginData.id + '] Mapped path (' + mappedPath + ') already specified!');
callback();
} else if (!validMappedPath.test(mappedPath)) {
winston.warn('[plugins/' + pluginData.id + '] Invalid mapped path specified: ' + mappedPath + '. Path must adhere to: ' + validMappedPath.toString());
callback();
} else {
var realPath = pluginData.staticDirs[mappedPath];
var staticDir = path.join(pluginPath, realPath);
file.exists(staticDir, function(exists) {
if (exists) {
Plugins.staticDirs[pluginData.id + '/' + mappedPath] = staticDir;
} else {
winston.warn('[plugins/' + pluginData.id + '] Mapped path \'' + mappedPath + ' => ' + staticDir + '\' not found.');
}
callback();
});
}
}
var validMappedPath = /^[\w\-_]+$/;
pluginData.staticDirs = pluginData.staticDirs || {};
var dirs = Object.keys(pluginData.staticDirs);
async.each(dirs, mapStaticDirs, callback);
}
function mapFiles(pluginData, type, globalArray, callback) {
if (Array.isArray(pluginData[type])) {
if (global.env === 'development') {
winston.verbose('[plugins] Found ' + pluginData[type].length + ' ' + type + ' file(s) for plugin ' + pluginData.id);
}
Plugins[globalArray] = Plugins[globalArray].concat(pluginData[type].map(function(file) {
return path.join(pluginData.id, file);
}));
}
callback();
}
function mapClientSideScripts(pluginData, callback) {
if (Array.isArray(pluginData.scripts)) {
if (global.env === 'development') {
winston.verbose('[plugins] Found ' + pluginData.scripts.length + ' js file(s) for plugin ' + pluginData.id);
}
Plugins.clientScripts = Plugins.clientScripts.concat(pluginData.scripts.map(function(file) {
return path.join(__dirname, '../../node_modules/', pluginData.id, file);
}));
}
if (Array.isArray(pluginData.acpScripts)) {
if (global.env === 'development') {
winston.verbose('[plugins] Found ' + pluginData.acpScripts.length + ' js file(s) for plugin ' + pluginData.id);
}
Plugins.acpScripts = Plugins.acpScripts.concat(pluginData.acpScripts.map(function(file) {
return path.join(__dirname, '../../node_modules/', pluginData.id, file);
}));
}
callback();
};
function mapClientModules(pluginData, callback) {
if (!pluginData.hasOwnProperty('modules')) {
return callback();
}
var modules = {};
if (Array.isArray(pluginData.modules)) {
if (global.env === 'development') {
winston.verbose('[plugins] Found ' + pluginData.modules.length + ' AMD-style module(s) for plugin ' + pluginData.id);
}
var strip = pluginData.hasOwnProperty('modulesStrip') ? parseInt(pluginData.modulesStrip, 10) : 0;
pluginData.modules.forEach(function(file) {
if (strip) {
modules[file.replace(new RegExp('\.?(\/[^\/]+){' + strip + '}\/'), '')] = path.join('./node_modules/', pluginData.id, file);
} else {
modules[path.basename(file)] = path.join('./node_modules/', pluginData.id, file);
}
});
meta.js.scripts.modules = _.extend(meta.js.scripts.modules, modules);
} else {
var keys = Object.keys(pluginData.modules);
if (global.env === 'development') {
winston.verbose('[plugins] Found ' + keys.length + ' AMD-style module(s) for plugin ' + pluginData.id);
}
for (var name in pluginData.modules) {
modules[name] = path.join('./node_modules/', pluginData.id, pluginData.modules[name]);
}
meta.js.scripts.modules = _.extend(meta.js.scripts.modules, modules);
}
callback();
};
function loadLanguages(pluginData, callback) {
if (typeof pluginData.languages !== 'string') {
return callback();
}
var pathToFolder = path.join(__dirname, '../../node_modules/', pluginData.id, pluginData.languages),
fallbackMap = {};
utils.walk(pathToFolder, function(err, languages) {
var arr = [];
async.each(languages, function(pathToLang, next) {
fs.readFile(pathToLang, function(err, file) {
if (err) {
return next(err);
}
var json;
try {
json = JSON.parse(file.toString());
} catch (err) {
winston.error('[plugins] Unable to parse custom language file: ' + pathToLang + '\r\n' + err.stack);
return next(err);
}
arr.push({
file: json,
route: pathToLang.replace(pathToFolder, '')
});
if (pluginData.defaultLang && pathToLang.endsWith(pluginData.defaultLang + '/' + path.basename(pathToLang))) {
fallbackMap[path.basename(pathToLang, '.json')] = path.join(pathToFolder, pluginData.defaultLang, path.basename(pathToLang));
}
next();
});
}, function(err) {
if (err) {
return callback(err);
}
Plugins.customLanguages = Plugins.customLanguages.concat(arr);
_.extendOwn(Plugins.customLanguageFallbacks, fallbackMap);
callback();
});
});
}
Plugins.loadPluginInfo = function(pluginPath, callback) {
async.parallel({
package: function(next) {
fs.readFile(path.join(pluginPath, 'package.json'), next);
},
plugin: function(next) {
fs.readFile(path.join(pluginPath, 'plugin.json'), next);
}
}, function(err, results) {
if (err) {
return callback(err);
}
try {
var pluginData = JSON.parse(results.plugin);
var packageData = JSON.parse(results.package);
pluginData.id = packageData.name;
pluginData.name = packageData.name;
pluginData.description = packageData.description;
pluginData.version = packageData.version;
pluginData.repository = packageData.repository;
pluginData.nbbpm = packageData.nbbpm;
callback(null, pluginData);
} catch(err) {
var pluginDir = pluginPath.split(path.sep);
pluginDir = pluginDir[pluginDir.length -1];
winston.error('[plugins/' + pluginDir + '] Error in plugin.json or package.json! ' + err.message);
callback(new Error('[[error:parse-error]]'));
}
});
};
}; |