mailheader.js

"use strict";
// An RFC 2822 email header parser
var logger = require('./logger');
var utils  = require('./utils');
var Iconv;
try { Iconv = require('iconv').Iconv }
catch (err) {
    logger.logdebug("No iconv available - install with 'npm install iconv'");
}

function Header (options) {
    this.headers = {};
    this.headers_decoded = {};
    this.header_list = [];
    this.options = options;
};

exports.Header = Header;
exports.Iconv  = Iconv;

Header.prototype.parse = function (lines) {
    var self = this;

    for (var i=0,l=lines.length; i < l; i++) {
        var line = lines[i];
        if (line.match(/^[ \t]/)) {
            // continuation
            this.header_list[this.header_list.length - 1] += line;
        }
        else {
            this.header_list.push(line);
        }
    }

    for (var i=0,l=this.header_list.length; i < l; i++) {
        var match = this.header_list[i].match(/^([^\s:]*):\s*([\s\S]*)$/);
        if (match) {
            var key = match[1].toLowerCase();
            var val = match[2];

            this._add_header(key, val, "push");
        }
        else {
            logger.logerror("Header did not look right: " + this.header_list[i]);
        }
    }

    // Now add decoded versions
    Object.keys(this.headers).forEach(function (key2) {
        self.headers[key2].forEach(function (val2) {
            self._add_header_decode(key2, val2, 'push');
        })
    })
};

function try_convert(data, encoding) {
    try {
        var converter = new Iconv(encoding, "UTF-8");
        data = converter.convert(data);
    }
    catch (err) {
        // TODO: raise a flag for this for possible scoring
        logger.logwarn("initial iconv conversion from " + encoding + " to UTF-8 failed: " + err.message);
        if (err.code !== 'EINVAL') {
            try {
                var converter = new Iconv(encoding, "UTF-8//TRANSLIT//IGNORE");
                data = converter.convert(data);
            }
            catch (e) {
                logger.logerror("iconv from " + encoding + " to UTF-8 failed: " + e.message);
            }
        }
    }

    return data;
}

function _decode_header (matched, encoding, lang, cte, data) {
    cte = cte.toUpperCase();

    switch (cte) {
        case 'Q':
            data = utils.decode_qp(data.replace(/_/g, ' '));
            break;
        case 'B':
            data = new Buffer(data, "base64");
            break;
        default:
            logger.logerror("Invalid header encoding type: " + cte);
    }

    // convert with iconv if encoding != UTF-8
    if (Iconv && !(/UTF-?8/i.test(encoding))) {
        data = try_convert(data, encoding);
    }

    return data.toString();
}

function _decode_rfc2231 (params) {
    return function (matched, str) {
        var sub_matches = /^(([^=]*)\*)(\d*)=(\s*".*?[^\\]";?|\S*)\s*$/.exec(str);
        if (!sub_matches) {
            return "\n " + str;
        }
        var key = sub_matches[1];
        var key_actual = sub_matches[2];
        var key_id = sub_matches[3] || '0';
        var value = sub_matches[4].replace(/;$/, '');

        var key_extract = /^(.*?)(\*(\d+)\*)$/.exec(key);
        if (key_extract) {
            key_actual = key_extract[1];
            key_id = key_extract[3];
        }

        var quote = /^\s*"(.*)"$/.exec(value);
        if (quote) {
            value = quote[1];
        }

        var lang_match = /^(.*?)'(.*?)'(.*)/.exec(value);
        if (lang_match) {
            if (key_actual == params.cur_key && lang_match[2] != params.cur_lang) {
                return ''; // same key, different lang, throw it away
            }
            params.cur_enc = lang_match[1];
            params.cur_lang = lang_match[2];
            value = lang_match[3];
        }
        else if (key_actual != params.cur_key) {
            params.cur_lang = '';
            params.cur_enc = '';
        }

        params.cur_key = key_actual;
        params.keys[key_actual] = '';
        value = decodeURIComponent(value);
        params.kv[key_actual + '*' + key_id] = params.cur_enc ? try_convert(value, params.cur_enc) : value;
        return '';
    }
}

Header.prototype.decode_header = function decode_header (val) {
    // Fold continuations
    var rfc2231_params = {
        kv: {},
        keys: {},
        cur_key: '',
        cur_enc: '',
        cur_lang: '', // Secondary languages are ignored for our purposes
    };
    val = val.replace(/\n[ \t]+([^\n]*)/g, _decode_rfc2231(rfc2231_params));
    for (var key in rfc2231_params.keys) {
        val = val + ' ' + key + '="';
        for (var i=0; true; i++) {
            var _key = key + '*' + i;
            var _val = rfc2231_params.kv[_key];
            if (_val === undefined) break;
            val = val + _val;
        }
        val = val + '";';
    }

    // remove end carriage return
    val = val.replace(/\r?\n$/, '');
    val = val.replace(/\([^\)]*\)/, ''); // strip 822 comments in the most basic way - does not support nested comments

    if (Iconv && !/^[\x00-\x7f]*$/.test(val)) {
        // 8 bit values in the header
        var matches = /\bcharset\s*=\s*["']?([\w_\-]*)/.exec(this.get('content-type'));
        if (matches && !/UTF-?8/i.test(matches[1])) {
            var encoding = matches[1];
            var source = new Buffer(val, 'binary');
            val = try_convert(source, encoding).toString();
        }
    }

    if (! (/=\?/.test(val)) ) {
        // no encoded stuff
        return val;
    }

    val = val.replace(/=\?([\w_-]+)(\*[\w_-]+)?\?([bqBQ])\?(.*?)\?=/g, _decode_header);

    return val;
}

Header.prototype.get = function (key) {
    return (this.headers[key.toLowerCase()] || []).join("\n");
};

Header.prototype.get_all = function (key) {
    return this.headers[key.toLowerCase()] || [];
};

Header.prototype.get_decoded = function (key) {
    return (this.headers_decoded[key.toLowerCase()] || []).join("\n");
};

Header.prototype.remove = function (key) {
    key = key.toLowerCase();
    delete this.headers[key];
    delete this.headers_decoded[key];

    this._remove_more(key);
}

Header.prototype._remove_more = function (key) {
    var key_len = key.length;
    for (var i=0,l=this.header_list.length; i < l; i++) {
        if (this.header_list[i].substring(0, key_len).toLowerCase() === key) {
            this.header_list.splice(i, 1);
            return this._remove_more(key);
        }
    }
};

Header.prototype._add_header = function (key, value, method) {
    this.headers[key] = this.headers[key] || [];
    this.headers[key][method](value);
};

Header.prototype._add_header_decode = function (key, value, method) {
    var val = this.decode_header(value);
    // console.log(key + ': ' + val);
    this.headers_decoded[key] = this.headers_decoded[key] || [];
    this.headers_decoded[key][method](val);
}

Header.prototype.add = function (key, value) {
    if (!key) key = 'X-Haraka-Blank';
    value = value.replace(/(\r?\n)*$/, '');
    if (/[^\x00-\x7f]/.test(value)) {
        // Need to QP encode this header value and assume UTF-8
        value = '=?UTF-8?q?' + utils.encode_qp(value) + '?=';
        value = value.replace(/\n/g, '\n '); // turn wraps into continuations
    }
    this._add_header(key.toLowerCase(), value, "unshift");
    this._add_header_decode(key.toLowerCase(), value, "unshift");
    this.header_list.unshift(key + ': ' + value + '\n');
};

Header.prototype.add_end = function (key, value) {
    if (!key) key = 'X-Haraka-Blank';
    value = value.replace(/(\r?\n)*$/, '');
    if (/[^\x00-\x7f]/.test(value)) {
        // Need to QP encode this header value and assume UTF-8
        value = '=?UTF-8?q?' + utils.encode_qp(value) + '?=';
        value = value.replace(/\n/g, ' \n'); // turn wraps into continuations
    }
    this._add_header(key.toLowerCase(), value, "push");
    this._add_header_decode(key.toLowerCase(), value, "push");
    this.header_list.push(key + ': ' + value + '\n');
}

Header.prototype.lines = function () {
    return this.header_list;
};

Header.prototype.toString = function () {
    return this.header_list.join("\n");
};