123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219 |
- 'use strict';
- const Transform = require('stream').Transform;
- /**
- * Encodes a Buffer into a Quoted-Printable encoded string
- *
- * @param {Buffer} buffer Buffer to convert
- * @returns {String} Quoted-Printable encoded string
- */
- function encode(buffer) {
- if (typeof buffer === 'string') {
- buffer = Buffer.from(buffer, 'utf-8');
- }
- // usable characters that do not need encoding
- let ranges = [
- // https://tools.ietf.org/html/rfc2045#section-6.7
- [0x09], // <TAB>
- [0x0a], // <LF>
- [0x0d], // <CR>
- [0x20, 0x3c], // <SP>!"#$%&'()*+,-./0123456789:;
- [0x3e, 0x7e] // >?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}
- ];
- let result = '';
- let ord;
- for (let i = 0, len = buffer.length; i < len; i++) {
- ord = buffer[i];
- // if the char is in allowed range, then keep as is, unless it is a WS in the end of a line
- if (checkRanges(ord, ranges) && !((ord === 0x20 || ord === 0x09) && (i === len - 1 || buffer[i + 1] === 0x0a || buffer[i + 1] === 0x0d))) {
- result += String.fromCharCode(ord);
- continue;
- }
- result += '=' + (ord < 0x10 ? '0' : '') + ord.toString(16).toUpperCase();
- }
- return result;
- }
- /**
- * Adds soft line breaks to a Quoted-Printable string
- *
- * @param {String} str Quoted-Printable encoded string that might need line wrapping
- * @param {Number} [lineLength=76] Maximum allowed length for a line
- * @returns {String} Soft-wrapped Quoted-Printable encoded string
- */
- function wrap(str, lineLength) {
- str = (str || '').toString();
- lineLength = lineLength || 76;
- if (str.length <= lineLength) {
- return str;
- }
- let pos = 0;
- let len = str.length;
- let match, code, line;
- let lineMargin = Math.floor(lineLength / 3);
- let result = '';
- // insert soft linebreaks where needed
- while (pos < len) {
- line = str.substr(pos, lineLength);
- if ((match = line.match(/\r\n/))) {
- line = line.substr(0, match.index + match[0].length);
- result += line;
- pos += line.length;
- continue;
- }
- if (line.substr(-1) === '\n') {
- // nothing to change here
- result += line;
- pos += line.length;
- continue;
- } else if ((match = line.substr(-lineMargin).match(/\n.*?$/))) {
- // truncate to nearest line break
- line = line.substr(0, line.length - (match[0].length - 1));
- result += line;
- pos += line.length;
- continue;
- } else if (line.length > lineLength - lineMargin && (match = line.substr(-lineMargin).match(/[ \t.,!?][^ \t.,!?]*$/))) {
- // truncate to nearest space
- line = line.substr(0, line.length - (match[0].length - 1));
- } else if (line.match(/[=][\da-f]{0,2}$/i)) {
- // push incomplete encoding sequences to the next line
- if ((match = line.match(/[=][\da-f]{0,1}$/i))) {
- line = line.substr(0, line.length - match[0].length);
- }
- // ensure that utf-8 sequences are not split
- while (line.length > 3 && line.length < len - pos && !line.match(/^(?:=[\da-f]{2}){1,4}$/i) && (match = line.match(/[=][\da-f]{2}$/gi))) {
- code = parseInt(match[0].substr(1, 2), 16);
- if (code < 128) {
- break;
- }
- line = line.substr(0, line.length - 3);
- if (code >= 0xc0) {
- break;
- }
- }
- }
- if (pos + line.length < len && line.substr(-1) !== '\n') {
- if (line.length === lineLength && line.match(/[=][\da-f]{2}$/i)) {
- line = line.substr(0, line.length - 3);
- } else if (line.length === lineLength) {
- line = line.substr(0, line.length - 1);
- }
- pos += line.length;
- line += '=\r\n';
- } else {
- pos += line.length;
- }
- result += line;
- }
- return result;
- }
- /**
- * Helper function to check if a number is inside provided ranges
- *
- * @param {Number} nr Number to check for
- * @param {Array} ranges An Array of allowed values
- * @returns {Boolean} True if the value was found inside allowed ranges, false otherwise
- */
- function checkRanges(nr, ranges) {
- for (let i = ranges.length - 1; i >= 0; i--) {
- if (!ranges[i].length) {
- continue;
- }
- if (ranges[i].length === 1 && nr === ranges[i][0]) {
- return true;
- }
- if (ranges[i].length === 2 && nr >= ranges[i][0] && nr <= ranges[i][1]) {
- return true;
- }
- }
- return false;
- }
- /**
- * Creates a transform stream for encoding data to Quoted-Printable encoding
- *
- * @constructor
- * @param {Object} options Stream options
- * @param {Number} [options.lineLength=76] Maximum lenght for lines, set to false to disable wrapping
- */
- class Encoder extends Transform {
- constructor(options) {
- super();
- // init Transform
- this.options = options || {};
- if (this.options.lineLength !== false) {
- this.options.lineLength = this.options.lineLength || 76;
- }
- this._curLine = '';
- this.inputBytes = 0;
- this.outputBytes = 0;
- }
- _transform(chunk, encoding, done) {
- let qp;
- if (encoding !== 'buffer') {
- chunk = Buffer.from(chunk, encoding);
- }
- if (!chunk || !chunk.length) {
- return done();
- }
- this.inputBytes += chunk.length;
- if (this.options.lineLength) {
- qp = this._curLine + encode(chunk);
- qp = wrap(qp, this.options.lineLength);
- qp = qp.replace(/(^|\n)([^\n]*)$/, (match, lineBreak, lastLine) => {
- this._curLine = lastLine;
- return lineBreak;
- });
- if (qp) {
- this.outputBytes += qp.length;
- this.push(qp);
- }
- } else {
- qp = encode(chunk);
- this.outputBytes += qp.length;
- this.push(qp, 'ascii');
- }
- done();
- }
- _flush(done) {
- if (this._curLine) {
- this.outputBytes += this._curLine.length;
- this.push(this._curLine, 'ascii');
- }
- done();
- }
- }
- // expose to the world
- module.exports = {
- encode,
- wrap,
- Encoder
- };
|