libmime 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.2.0 2015-10-05
+
+Added support for emojis in header params (eg. filenames)
+
 ## v1.1.0 2015-09-24
 
 Updated encoded word encoding with quoted printable, should be more like required in https://tools.ietf.org/html/rfc2047#section-5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "libmime",
   "description": "Encode and decode quoted printable and base64 strings",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "src/libmime",
   "homepage": "https://github.com/andris9/libmime",
   "repository": {
@@ -19,7 +19,7 @@
     "test": "grunt"
   },
   "dependencies": {
-    "iconv-lite": "^0.4.11",
+    "iconv-lite": "^0.4.13",
     "libbase64": "^0.1.0",
     "libqp": "^1.1.0"
   },

package/src/libmime.js

@@ -110,6 +110,7 @@ var libmime = module.exports = {
         }
 
         if (mimeWordEncoding === 'Q') {
+            // https://tools.ietf.org/html/rfc2047#section-5 rule (3)
             encodedStr = libqp.encode(data).replace(/[^a-z0-9!*+\-\/=]/ig, function(chr) {
                 var ord = chr.charCodeAt(0).toString(16).toUpperCase();
                 if (chr === ' ') {
@@ -465,10 +466,12 @@ var libmime = module.exports = {
     buildHeaderParam: function(key, data, maxLength, fromCharset) {
         var list = [];
         var encodedStr = typeof data === 'string' ? data : libmime.decode(data, fromCharset);
-        var chr;
+        var encodedStrArr;
+        var chr, ord;
         var line;
         var startPos = 0;
         var isEncoded = false;
+        var i, len;
 
         maxLength = maxLength || 50;
 
@@ -498,21 +501,39 @@ var libmime = module.exports = {
 
         } else {
 
+            if (/[\uD800-\uDBFF]/.test(encodedStr)) {
+                // string containts surrogate pairs, so normalize it to an array of bytes
+                encodedStrArr = [];
+                for (i = 0, len = encodedStr.length; i < len; i++) {
+                    chr = encodedStr.charAt(i);
+                    ord = chr.charCodeAt(0);
+                    if (ord >= 0xD800 && ord <= 0xDBFF && i < len - 1) {
+                        chr += encodedStr.charAt(i + 1);
+                        encodedStrArr.push(chr);
+                        i++;
+                    } else {
+                        encodedStrArr.push(chr);
+                    }
+                }
+                encodedStr = encodedStrArr;
+            }
+
             // first line includes the charset and language info and needs to be encoded
             // even if it does not contain any unicode characters
             line = 'utf-8\'\'';
             isEncoded = true;
             startPos = 0;
+
             // process text with unicode or special chars
-            for (var i = 0, len = encodedStr.length; i < len; i++) {
+            for (i = 0, len = encodedStr.length; i < len; i++) {
 
                 chr = encodedStr[i];
 
                 if (isEncoded) {
-                    chr = encodeURIComponent(chr);
+                    chr = safeEncodeURIComponent(chr);
                 } else {
                     // try to urlencode current char
-                    chr = chr === ' ' ? chr : encodeURIComponent(chr);
+                    chr = chr === ' ' ? chr : safeEncodeURIComponent(chr);
                     // By default it is not required to encode a line, the need
                     // only appears when the string contains unicode or special chars
                     // in this case we start processing the line over and encode all chars
@@ -520,7 +541,7 @@ var libmime = module.exports = {
                         // Check if it is even possible to add the encoded char to the line
                         // If not, there is no reason to use this line, just push it to the list
                         // and start a new line with the char that needs encoding
-                        if ((encodeURIComponent(line) + chr).length >= maxLength) {
+                        if ((safeEncodeURIComponent(line) + chr).length >= maxLength) {
                             list.push({
                                 line: line,
                                 encoded: isEncoded
@@ -542,7 +563,7 @@ var libmime = module.exports = {
                         line: line,
                         encoded: isEncoded
                     });
-                    line = chr = encodedStr[i] === ' ' ? ' ' : encodeURIComponent(encodedStr[i]);
+                    line = chr = encodedStr[i] === ' ' ? ' ' : safeEncodeURIComponent(encodedStr[i]);
                     if (chr === encodedStr[i]) {
                         isEncoded = false;
                         startPos = i - 1;
@@ -573,6 +594,7 @@ var libmime = module.exports = {
         });
     },
 
+
     /**
      * Returns file extension for a content type string. If no suitable extensions
      * are found, 'bin' is used as the default extension
@@ -724,4 +746,38 @@ function splitMimeEncodedString(str, maxlen) {
     }
 
     return lines;
+}
+
+function encodeURICharComponent(chr) {
+    var i, len, ord;
+    var res = '';
+
+    ord = chr.charCodeAt(0).toString(16).toUpperCase();
+    if (ord.length % 2) {
+        ord = '0' + ord;
+    }
+    if (ord.length > 2) {
+        for (i = 0, len = ord.length / 2; i < len; i++) {
+            res += '%' + ord.substr(i, 2);
+        }
+    } else {
+        res += '%' + ord;
+    }
+
+    return res;
+}
+
+function safeEncodeURIComponent(str) {
+    str = (str || '').toString();
+
+    try {
+        // might throw if we try to encode invalid sequences, eg. partial emoji
+        str = encodeURIComponent(str);
+    } catch (E) {
+        // should never run
+        return str.replace(/[^\x00-\x1F *'()<>@,;:\\"\[\]?=\u007F-\uFFFF]+/g, '');
+    }
+
+    // ensure chars that are not handled by encodeURICompent are converted as well
+    return str.replace(/[\x00-\x1F *'()<>@,;:\\"\[\]?=\u007F-\uFFFF]/g, encodeURICharComponent);
 }