-
Notifications
You must be signed in to change notification settings - Fork 2
/
engine.js
414 lines (366 loc) · 14 KB
/
engine.js
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/**
* Copyright (c) 2012 eBay Inc.
* Author: Senthil Padmanabhan
*
* Released under the MIT License
* http://www.opensource.org/licenses/MIT
*/
// Defining the Global spof object, will be used in non-node environments
var spof = {};
! function(exports) {
/**
* An instance of Report is used to report results of the
* verification back to the main spof API.
* @class Reporter
* @constructor
*/
function Reporter() {
/**
* List of messages being reported.
* @property messages
* @type String[]
* @private
*/
this._messages = [];
}
Reporter.prototype = {
constructor: Reporter,
/**
* Report a finding.
* @param {String} message The message to store.
* @param {String} entity The entity which caused the issue.
* @param {int} score The score for this spof entity.
* @param {Object} rule The rule this message relates to.
* @param {String} type (optional) The type of the finding, default is info.
* @method report
*/
report: function(message, entity, score, rule, type) {
this._messages.push({
type: type || "info",
message: message,
entity: entity,
score: score,
rule: rule || {}
});
},
/**
* Report an error.
* @param {String} message The message to store.
* @param {String} entity The entity which caused the issue.
* @param {int} score The score for this spof entity.
* @param {Object} rule The rule this message relates to.
* @method report
*/
error: function(message, entity, score, rule) {
this.report(message, entity, score, rule, 'error');
},
/**
* Report a warning.
* @param {String} message The message to store.
* @param {String} entity The entity which caused the issue.
* @param {int} score The score for this spof entity.
* @param {Object} rule The rule this message relates to.
* @method report
*/
warn: function(message, entity, score, rule) {
this.report(message, entity, score, rule, 'warning');
},
/**
* Returns the list of messages.
* @return {Array} Reported messages.
* @method getMessages
*/
getMessages: function() {
return this._messages;
}
};
/**
* Main spof api object.
* @Object spofApi
* @static
*/
var spofApi = function() {
var rulesset = [], // Stack to hold the rules
formatters = []; // Stack to hold the formatters
return {
/**
* Performs a SPOF analysis on the page
* @param {Object} $ The DOM handler (jQuery) for the page.
* @param {String} cssContent Externalized CSS content for the page.
* @param {Object} rules (Optional) List of rules to apply. If null, then
* all registered rules are used.
* @return {Object} Results of the analysis.
* @method analyze
*/
analyze: function($, cssContent, rules) {
// Use the provided list of rules if available, else get all registered rules
rules = rules || this.getRules();
// If empty ruleset throw error and return
if (!rules.length) {
throw new Error("Empty ruleset.");
}
// Create a reporter instance
var reporter = new Reporter();
// Execute each rule
rules.forEach(function(rule) {
rule.check && rule.check($, cssContent, reporter);
});
return {
messages: reporter.getMessages()
};
},
/**
* Merges the rules passed in the parameters, in addition to deduping them
* @param {Array} empty Arrays of rules to me merged
* @return {Array} The rules to be applied.
* @method mergeRules
*/
mergeRules: function() {
// Return immediately if no arguments
if (!arguments.length) {
return;
}
// Concatenate them first
var rules = Array.prototype.concat.apply([], arguments),
idHash = {};
// Dedupe them
return rules.filter(function(rule) {
if (!idHash[rule.id]) {
idHash[rule.id] = 1;
return true;
}
return false;
});
},
/**
* Returns the rules array
* @return {Array} The rules to be applied.
* @method getRules
*/
getRules: function() {
return rulesset;
},
/**
* Reset the rules to the original empty array
* @method clearRules
*/
resetRules: function() {
rulesset = [];
},
/**
* Registers the given rule(s) - appends the provided rules with existing ones
* @param {Array|String} rules The rules to be applied.
* @method registerRules
*/
registerRules: function(rules) {
rules = Array.isArray(rules) ? rules : [rules];
rulesset = this.mergeRules(rulesset, rules);
},
/**
* Add a formatter to the formatter stack
* @param {Object} formatter The formatter object
* @method addFormatter
*/
addFormatter: function(formatter) {
formatter && (formatters[formatter.id] = formatter);
},
/**
* Retrieves a formatter for use.
* @param {String} formatId The name of the format to retrieve.
* @return {Object} The formatter or undefined.
* @method getFormatter
*/
getFormatter: function(formatId) {
return formatters[formatId];
}
};
}();
// Adding formatters to the spof api
spofApi.addFormatter({
// Formatter metadata
id: "junit-xml",
name: "JUNIT XML format",
extension: "xml",
/**
* Return opening root XML tag.
* @return {String} to prepend before all results
*/
startFormat: function() {
return "<?xml version=\"1.0\" encoding=\"utf-8\"?><testsuites>";
},
/**
* Return closing root XML tag.
* @return {String} to append after all results
*/
endFormat: function() {
return "</testsuites>";
},
/**
* Given spof results for a url, return output for this format.
* @param {Object} results with error and warning messages
* @param {String} url The url for which the spof ran
* @return {String} output for results
*/
formatResults: function(results, url) {
var messages = results.messages,
output = [],
tests = {
'error': 0,
'failure': 0
};
/**
* Generate a source string for a rule.
* JUNIT source strings usually resemble Java class names e.g
* net.spof.SomeRuleName
* @param {Object} rule
* @return rule source as {String}
*/
var generateSource = function(rule) {
if (!rule || !('name' in rule)) {
return "";
}
return 'net.spof.' + rule.name.replace(/\s/g, '');
};
/**
* Replace special characters before write to output.
*
* Rules:
* - single quotes is the escape sequence for double-quotes
* - < is the escape sequence for <
* - > is the escape sequence for >
*
* @param {String} message to escape
* @return escaped message as {String}
*/
var escapeSpecialCharacters = function(str) {
if (!str || str.constructor !== String) {
return "";
}
return str.replace(/\"/g, "'").replace(/</g, "<").replace(/>/g, ">");
};
if (messages.length > 0) {
messages.forEach(function(message, i) {
// since junit has no warning class
// all issues as errors
var type = message.type === 'warning' ? 'error' : message.type;
// build the test case seperately, once joined
// we'll add it to a custom array filtered by type
output.push("<testcase time=\"0\" name=\"" + generateSource(message.rule) + "\">");
output.push("<" + type + " message=\"" + escapeSpecialCharacters(message.message + " Fix: " + message.rule.desc) + "\"><![CDATA[" + 'entity=' + message.entity + ':score=' + message.score + "%]]></" + type + ">");
output.push("</testcase>");
tests[type] += 1;
});
output.unshift("<testsuite time=\"0\" tests=\"" + messages.length + "\" skipped=\"0\" errors=\"" + tests.error + "\" failures=\"" + tests.failure + "\" package=\"net.spof\" name=\"" + url + "\">");
output.push("</testsuite>");
}
return output.join("");
}
});
spofApi.addFormatter({
// Formatter metadata
id: "text",
name: "Plain Text",
extension: "text",
/**
* Return content to be printed before all file results.
* @return {String} to prepend before all results
*/
startFormat: function() {
return "";
},
/**
* Return content to be printed after all file results.
* @return {String} to append after all results
*/
endFormat: function() {
return "";
},
/**
* Given spof results for a url, return output for this format.
* @param {Object} results with error and warning messages
* @param {String} url The url for which the spof ran
* @return {String} output for results
*/
formatResults: function(results, url) {
var messages = results.messages,
output = "",
length = messages.length;
if (messages.length === 0) {
return "\nspof: " + url + " is SPOF free.";
}
output = "\nspof: There " + (length > 1 ? "are" : "is") + " " + length + " problem" + (length > 1 ? "s" : "") + " in " + url;
messages.forEach(function(message, i) {
output += "\n\n" + (i + 1) + ". " + message.message;
output += "\n" + "Severity: " + message.type;
output += "\n" + "Entity: " + message.entity;
output += "\n" + "Score: " + message.score;
output += "\n" + "Fix: " + message.rule.desc;
});
output += "\n";
return output;
}
});
spofApi.addFormatter({
// Formatter metadata
id: "spof-xml",
name: "SPOF XML format",
extension: "xml",
/**
* Return content to be printed before all file results.
* @return {String} to prepend before all results
*/
startFormat: function() {
return "<?xml version=\"1.0\" encoding=\"utf-8\"?><spof>";
},
/**
* Return content to be printed after all file results.
* @return {String} to append after all results
*/
endFormat: function() {
return "</spof>";
},
/**
* Given spof results for a url, return output for this format.
* @param {Object} results with error and warning messages
* @param {String} url The url for which the spof ran
* @return {String} output for results
*/
formatResults: function(results, url) {
var messages = results.messages,
output = [];
/**
* Replace special characters before write to output.
*
* Rules:
* - single quotes is the escape sequence for double-quotes
* - & is the escape sequence for &
* - < is the escape sequence for <
* - > is the escape sequence for >
*
* @param {String} message to escape
* @return escaped message as {String}
*/
var escapeSpecialCharacters = function(str) {
if (!str || str.constructor !== String) {
return "";
}
return str.replace(/\"/g, "'").replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
};
if (messages.length > 0) {
output.push("<url location=\"" + url + "\">");
messages.forEach(function(message, i) {
output.push("<issue enity=\"" + message.entity + "\" score=\"" + message.score + "\" severity=\"" + message.type + "\"" +
" reason=\"" + escapeSpecialCharacters(message.message) + "\" fix=\"" + escapeSpecialCharacters(message.rule.desc) + "\"/>");
});
output.push("</url>");
}
return output.join("");
}
});
// Exporting the spof api to the global scope, based on environment
if (typeof exports != 'undefined') {
exports.spof = spofApi;
} else {
spof = spofApi;
}
}(exports);