inliner/inliner.js
remy 10fcbea9ca - fixed requests including query strings
- fixed bug with jsdom encountering empty script tag and bombing out (Closes #4)
- fixed @import in inline style using relative path
- added command line option 'nocompress' to leave whitespace in CSS and HTML (for debugging)
2011-05-29 15:37:52 +01:00

449 lines
14 KiB
JavaScript
Executable File

var URL = require('url'),
util = require('util'),
events = require('events'),
Buffer = require('buffer').Buffer,
jsdom = require('jsdom'),
jsp = require('uglify-js/lib/parse-js'),
pro = require('uglify-js/lib/process'),
uncompress = require('compress-buffer').uncompress,
http = {
http: require('http'),
https: require('https')
},
defaults = { compressCSS: true, collapseWhitespace: true };
function makeRequest(url) {
var oURL = URL.parse(url),
options = {
host: oURL.hostname,
port: oURL.port === undefined ? (oURL.protocol+'').indexOf('https') === 0 ? 443 : 80 : oURL.port,
path: oURL.pathname + (oURL.search || ''),
method: 'GET'
};
return http[oURL.protocol.slice(0, -1) || 'http'].request(options);
}
function decompress(gzip, input) {
}
function getter(parent) {
return function get(url, rules, callback) {
var request = makeRequest(url),
body = '';
if (typeof rules == 'function') {
callback = rules;
rules = {};
}
request.on('response', function (res) {
res.on('data', function (chunk) {
if (res.statusCode == 200) body += chunk;
});
res.on('error', function () {
console.error('err');
console.error(arguments);
});
res.on('end', function () {
if (rules && rules.not) {
if (res.headers['content-type'].indexOf(rules.not) !== -1) {
body = '';
}
}
if (res.headers['location']) {
return get(res.headers['location'], rules, callback);
} else if (res.headers['content-encoding'] == 'gzip') {
// console.log('decode');
// body = uncompress(body);
// console.log(body);
}
if (body) {
parent.emit('progress', 'get ' + url);
}
callback && callback(body);
});
}).end();
}
}
function img2base64(url, callback) {
var request = makeRequest(url),
body = '';
request.on('response', function (res) {
var type = res.headers['content-type'],
prefix = 'data:' + type + ';base64,',
body = '';
res.setEncoding('binary');
res.on('end', function () {
var base64 = new Buffer(body, 'binary').toString('base64'),
data = prefix + base64;
callback(data);
});
res.on('data', function (chunk) {
if (res.statusCode == 200) body += chunk;
else console.log('fail on ' + url);
});
}).end()
}
function compressCSS(css) {
return css
.replace(/\s+/g, ' ')
.replace(/:\s+/g, ':')
.replace(/\/\*.*?\*\//g, '')
.replace(/\} /g, '}')
.replace(/ \{/g, '{')
// .replace(/\{ /g, '{')
.replace(/; /g, ';')
.replace(/\n+/g, '');
}
function getImagesFromCSS(inliner, rooturl, rawCSS, callback) {
var images = {},
urlMatch = /url\((?:['"]*)(?!['"]*data:)(.*?)(?:['"]*)\)/g,
singleURLMatch = /url\((?:['"]*)(?!['"]*data:)(.*?)(?:['"]*)\)/,
matches = rawCSS.match(urlMatch),
imageCount = matches === null ? 0 : matches.length; // TODO check!
inliner.total += imageCount;
inliner.todo += imageCount;
function checkFinished() {
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
if (imageCount < 0) {
console.log('something went wrong :-S');
} else if (imageCount == 0) {
callback(rawCSS.replace(urlMatch, function (m, url) {
return 'url(' + images[url] + ')';
}));
}
}
if (imageCount) {
matches.forEach(function (url) {
url = url.match(singleURLMatch)[1];
var resolvedURL = URL.resolve(rooturl, url);
if (images[url] === undefined) {
img2base64(resolvedURL, function (dataurl) {
inliner.emit('progress', 'encode ' + resolvedURL);
imageCount--;
inliner.todo--;
if (images[url] === undefined) images[url] = dataurl;
checkFinished();
});
} else {
imageCount--;
inliner.todo--;
checkFinished();
}
});
} else {
callback(rawCSS);
}
}
function removeComments(element) {
var nodes = element.childNodes,
i = nodes.length;
while (i--) {
if (nodes[i].nodeName === '#comment' && nodes[i].nodeValue.indexOf('[') !== 0) {
element.removeChild(nodes[i]);
}
removeComments(nodes[i]);
}
}
function Inliner(url, options, callback) {
var root = url,
inliner = this,
get = getter(this);
events.EventEmitter.call(this);
if (typeof options == 'function') {
callback = options;
options = defaults;
} else if (options === undefined) {
options = defaults;
}
inliner.total = 1;
inliner.todo = 1;
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
get(url, function (html) {
inliner.todo--;
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
// workaround for https://github.com/tmpvar/jsdom/issues/172
// need to remove empty script tags as it casues jsdom to skip the env callback
html = html.replace(/<script(:? type=['"|].*?['"|])><\/script>/ig, '');
if (!html) {
inliner.emit('end', '');
callback && callback();
} else {
jsdom.env(html, '', [
'http://code.jquery.com/jquery.min.js'
], function(errors, window) {
// remove jQuery that was included with jsdom
window.$('script:last').remove();
var todo = { scripts: true, images: true, links: true, styles: true },
assets = {
scripts: window.$('script'),
images: window.$('img').filter(function(){ return this.src.indexOf('data:') == -1; }),
links: window.$('link[rel=stylesheet]'),
styles: window.$('style')
},
breakdown = {},
images = {};
inliner.total = 1;
for (var key in todo) {
if (todo[key] === true && assets[key]) {
breakdown[key] = assets[key].length;
inliner.total += assets[key].length;
inliner.todo += assets[key].length;
}
}
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
function finished() {
var items = 0;
for (var key in breakdown) {
items += breakdown[key];
}
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
if (items === 0) {
// manually remove the comments
var els = removeComments(window.document.documentElement);
// collapse the white space
var html = window.document.innerHTML;
if (options.collapseWhitespace) {
html = html.replace(/\s+/g, ' ');
}
// console.log(html);
html = '<!DOCTYPE html>' + html;
callback && callback(html);
inliner.emit('end', html);
} else if (items < 0) {
console.log('something went wrong on finish');
console.dir(breakdown);
}
}
todo.images && assets.images.each(function () {
var img = this,
resolvedURL = URL.resolve(url, img.src);
img2base64(resolvedURL, function (dataurl) {
inliner.emit('progress', 'encode ' + resolvedURL);
if (dataurl) images[img.src] = dataurl;
img.src = dataurl;
breakdown.images--;
inliner.todo--;
finished();
});
});
function getImportCSS(css, callback, rooturl) {
var position = css.indexOf('@import');
if (position !== -1) {
var match = css.match(/@import\s*(.*)/);
if (match !== null && match.length) {
var url = window.$.trim(match[1].replace(/url/, '').replace(/['}"]/g, '').replace(/;/, '')).split(' '); // clean up
// if url has a length > 1, then we have media types to target
var resolvedURL = URL.resolve(root, url[0]);
get(resolvedURL, function (importedCSS) {
inliner.emit('progress', 'import ' + resolvedURL);
if (url.length > 1) {
url.shift();
importedCSS = '@media ' + url.join(' ') + '{' + importedCSS + '}';
}
css = css.replace(/@(import.*$)/, '/* $1 */\n' + importedCSS);
getImportCSS(css, callback);
});
}
} else {
if (options.compressCSS) css = compressCSS(css);
callback(css, rooturl);
}
}
todo.styles && assets.styles.each(function () {
var style = this;
getImportCSS(this.innerHTML, function (css, url) {
getImagesFromCSS(inliner, url, css, function (css) {
if (options.compressCSS) inliner.emit('progress', 'compress inline css');
style.innerHTML = css;
breakdown.styles--;
inliner.todo--;
// console.log('style finished');
finished();
});
});
});
todo.links && assets.links.each(function () {
var link = this,
linkURL = URL.resolve(url, link.href);
get(linkURL, function (css) {
getImagesFromCSS(inliner, linkURL, css, function (css) {
getImportCSS(css, function (css) {
if (options.compressCSS) inliner.emit('progress', 'compress ' + linkURL);
breakdown.links--;
inliner.todo--;
var style = '',
media = link.getAttribute('media');
if (media) {
style = '<style>@media ' + media + '{' + css + '}</style>';
} else {
style = '<style>' + css + '</style>';
}
window.$(link).replaceWith(style);
// console.log('link finished');
finished();
});
});
});
});
function scriptsFinished() {
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
if (breakdown.scripts == 0) {
// now compress the source JavaScript
assets.scripts.each(function () {
var $script = window.$(this),
src = $script.attr('src'),
orig_code = this.innerHTML;
// only remove the src if we have a script body
if (orig_code) {
$script.removeAttr('src');
}
// don't compress already minified code
if(!/\bmin\b/.test(src) && !/google-analytics/.test(src)) {
inliner.todo++;
inliner.total++;
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
try {
var ast = jsp.parse(orig_code); // parse code and get the initial AST
ast = pro.ast_mangle(ast); // get a new AST with mangled names
ast = pro.ast_squeeze(ast); // get an AST with compression optimizations
var final_code = pro.gen_code(ast);
// some protection against putting script tags in the body
final_code = final_code.replace(/<\/script>/gi, '<\\/script>');
window.$(this).text(final_code);
if (src) {
inliner.emit('progress', 'compress ' + URL.resolve(root, src));
} else {
inliner.emit('progress', 'compress inline script');
}
} catch (e) {
}
inliner.todo--;
inliner.emit('jobs', (inliner.total - inliner.todo) + '/' + inliner.total);
}
});
finished();
}
}
// basically this is the jQuery instance we tacked on to the request,
// but we're just being extra sure before we do zap it out
todo.scripts && assets.scripts.each(function () {
var $script = window.$(this),
scriptURL = URL.resolve(url, this.src);
if (scriptURL.indexOf('google-analytics.com') !== -1) { // ignore google
breakdown.scripts--;
inliner.todo--;
scriptsFinished();
} else {
get(scriptURL, { not: 'text/html' }, function (data) {
if (data) $script.text(data);
// $script.before('<!-- ' + scriptURL + ' -->');
breakdown.scripts--;
inliner.todo--;
scriptsFinished();
});
}
});
// edge case - if there's no images, nor scripts, nor links - we call finished manually
if (assets.links.length == 0 &&
assets.styles.length == 0 &&
assets.images.length == 0 &&
assets.scripts.length == 0) {
finished();
}
/** Inliner jobs:
* 1. get all inline images and base64 encode
* 2. get all external style sheets and move to inline
* 3. get all image references in CSS and base64 encode and replace urls
* 4. get all external scripts and move to inline
* 5. compress JavaScript
* 6. compress CSS & support media queries
* 7. compress HTML (/>\s+</g, '> <');
*
* FUTURE ITEMS:
* - support for @import
* - javascript validation - i.e. not throwing errors
*/
});
}
});
}
util.inherits(Inliner, events.EventEmitter);
Inliner.prototype.version = JSON.parse(require('fs').readFileSync(__dirname + '/package.json').toString()).version;
module.exports = Inliner;
if (!module.parent) {
if (process.argv[2] === undefined) {
console.log('Usage: inliner http://yoursite.com\ninliner [nocompress]\nThis will output the inlined HTML, CSS, images and JavaScript');
process.exit();
}
(function () {
var options;
if (process.argv[3] === 'nocompress') {
options = { compressCSS: false, collapseWhitespace: false };
}
var inliner = new Inliner(process.argv[2], options, function (html) {
console.log(html);
});
})();
}