Merge pull request #202 from perry-mitchell/bugfix/encoded_paths

Use 'he'/browser-utils to handle html entities - fixes #198

.babelrc

@@ -2,7 +2,7 @@
     "presets": [
         ["@babel/preset-env", {
             "targets": {
-                "node": 6
+                "node": 10
             },
             "debug": true
         }]

README.md

@@ -14,7 +14,7 @@ Please read the [contribution guide](CONTRIBUTING.md) if you plan on making an i
 
 ### Node support
 
-This library is compatibale with NodeJS version 10 and above (For version 6/8 support, use versions in the range of `2.*`. For version 4 support, use versions in the range of `1.*`). Version 2.x is now in maintenance mode and will receive no further feature additions. It will receive the odd bug fix when necessary. Version 1.x is no longer supported.
+This library is compatibale with **NodeJS version 10** and above (For version 6/8 support, use versions in the range of `2.*`. For version 4 support, use versions in the range of `1.*`). Version 2.x is now in maintenance mode and will receive no further feature additions. It will receive the odd bug fix when necessary. Version 1.x is no longer supported.
 
 ### Usage in the Browser
 

package.json

@@ -54,6 +54,7 @@
     "axios": "^0.19.2",
     "base-64": "^0.1.0",
     "fast-xml-parser": "^3.16.0",
+    "he": "^1.2.0",
     "hot-patcher": "^0.5.0",
     "minimatch": "^3.0.4",
     "nested-property": "^1.0.4",

source/encode.js

@@ -1,5 +1,18 @@
 const { decode, encode } = require("base-64");
 
+function decodeHTMLEntities(str) {
+    if (typeof WEB === "undefined") {
+        // Node
+        const he = require("he");
+        return he.decode(str);
+    } else {
+        // Nasty browser way
+        const txt = document.createElement("textarea");
+        txt.innerHTML = str;
+        return txt.value;
+    }
+}
+
 function fromBase64(str) {
     return decode(str);
 }
@@ -9,6 +22,7 @@ function toBase64(str) {
 }
 
 module.exports = {
+    decodeHTMLEntities,
     fromBase64,
     toBase64
 };

source/interface/dav.js

@@ -1,5 +1,6 @@
 const xmlParser = require("fast-xml-parser");
 const nestedProp = require("nested-property");
+const { decodeHTMLEntities } = require("../encode.js");
 
 function getPropertyOfType(obj, prop, type) {
     const val = nestedProp.get(obj, prop);
@@ -39,12 +40,16 @@ function parseXML(xml) {
         const result = xmlParser.parse(xml, {
             arrayMode: false,
             ignoreNameSpace: true
+            // // We don't use the processors here as decoding is done manually
+            // // later on - decoding early would break some path checks.
+            // attrValueProcessor: val => decodeHTMLEntities(decodeURIComponent(val)),
+            // tagValueProcessor: val => decodeHTMLEntities(decodeURIComponent(val))
         });
         resolve(normaliseResult(result));
     });
 }
 
-function propsToStat(props, filename, isDetailed = false) {
+function prepareFileFromProps(props, rawFilename, isDetailed = false) {
     const path = require("path-posix");
     // Last modified time, raw size, item type and mime
     const {
@@ -58,6 +63,7 @@ function propsToStat(props, filename, isDetailed = false) {
         resourceType && typeof resourceType === "object" && typeof resourceType.collection !== "undefined"
             ? "directory"
             : "file";
+    const filename = decodeHTMLEntities(rawFilename);
     const stat = {
         filename: filename,
         basename: path.basename(filename),
@@ -91,6 +97,6 @@ function translateDiskSpace(value) {
 
 module.exports = {
     parseXML,
-    propsToStat,
+    prepareFileFromProps,
     translateDiskSpace
 };

source/interface/directoryContents.js

@@ -2,7 +2,7 @@ const pathPosix = require("path-posix");
 const { merge } = require("../merge.js");
 const { handleResponseCode, processGlobFilter, processResponsePayload } = require("../response.js");
 const { normaliseHREF, normalisePath } = require("../url.js");
-const { parseXML, propsToStat } = require("./dav.js");
+const { parseXML, prepareFileFromProps } = require("./dav.js");
 const { encodePath, joinURL, prepareRequestOptions, request } = require("../request.js");
 
 function getDirectoryContents(remotePath, options) {
@@ -40,24 +40,22 @@ function getDirectoryFiles(result, serverBasePath, requestPath, isDetailed = fal
         responseItems
             // Filter out the item pointing to the current directory (not needed)
             .filter(item => {
-                // let href = getSingleValue(getValueForKey("href", item));
                 let href = item.href;
                 href = pathPosix.join(normalisePath(normaliseHREF(href)), "/");
                 return href !== serverBase && href !== remoteTargetPath;
             })
             // Map all items to a consistent output structure (results)
             .map(item => {
                 // HREF is the file path (in full)
-                let href = item.href;
-                href = normaliseHREF(href);
+                const href = normaliseHREF(item.href);
                 // Each item should contain a stat object
                 const {
                     propstat: { prop: props }
                 } = item;
                 // Process the true full filename (minus the base server path)
                 const filename =
                     serverBase === "/" ? normalisePath(href) : normalisePath(pathPosix.relative(serverBase, href));
-                return propsToStat(props, filename, isDetailed);
+                return prepareFileFromProps(props, filename, isDetailed);
             })
     );
 }

source/interface/stat.js

@@ -1,6 +1,6 @@
 const { merge } = require("../merge.js");
 const { handleResponseCode, processResponsePayload } = require("../response.js");
-const { parseXML, propsToStat } = require("./dav.js");
+const { parseXML, prepareFileFromProps } = require("./dav.js");
 const urlTools = require("../url.js");
 const { encodePath, joinURL, prepareRequestOptions, request } = require("../request.js");
 
@@ -41,7 +41,7 @@ function parseStat(result, filename, isDetailed = false) {
         propstat: { prop: props }
     } = responseItem;
     const filePath = urlTools.normalisePath(filename);
-    return propsToStat(props, filePath, isDetailed);
+    return prepareFileFromProps(props, filePath, isDetailed);
 }
 
 module.exports = {

test/serverContents/file&name.txt

@@ -0,0 +1 @@
+test

test/specs/getDirectoryContents.spec.js

@@ -56,12 +56,12 @@ describe("getDirectoryContents", function() {
 
     it("returns correct file results", function() {
         return this.client.getDirectoryContents("/").then(function(contents) {
-            const sub1 = contents.find(function(item) {
-                return item.basename === "alrighty.jpg";
-            });
+            const sub1 = contents.find(item =>item.basename === "alrighty.jpg");
+            const sub2 = contents.find(item => item.basename === "file&name.txt");
             expect(sub1.filename).to.equal("/alrighty.jpg");
             expect(sub1.size).to.equal(52130);
             expect(sub1.type).to.equal("file");
+            expect(sub2.filename).to.equal("/file&name.txt");
         });
     });
 
@@ -101,7 +101,7 @@ describe("getDirectoryContents", function() {
     });
 
     it("returns correct directory contents when path contains encoded sequences (issue #93)", function() {
-        return this.client.getDirectoryContents("/two%20words").then(function(contents) {
+        return this.client.getDirectoryContents("/two%20words").then(contents => {
             expect(contents).to.have.lengthOf(1);
             expect(contents[0].basename).to.equal("file2.txt");
         });