Merge pull request #3710 from curbengh/encode-url-helper

fix(helpers, tag plugins): encode url by default

Author: curbengh

lib/plugins/helper/relative_url.js

@@ -1,29 +1,7 @@
 'use strict';
 
-function relativeUrlHelper(from = '', to = '') {
-  const fromParts = from.split('/');
-  const toParts = to.split('/');
-  const length = Math.min(fromParts.length, toParts.length);
-  let i = 0;
+const { relative_url } = require('hexo-util');
 
-  for (; i < length; i++) {
-    if (fromParts[i] !== toParts[i]) break;
-  }
-
-  let out = toParts.slice(i);
-
-  for (let j = fromParts.length - i - 1; j > 0; j--) {
-    out.unshift('..');
-  }
-
-  const outLength = out.length;
-
-  // If the last 2 elements of `out` is empty strings, replace them with `index.html`.
-  if (outLength > 1 && !out[outLength - 1] && !out[outLength - 2]) {
-    out = out.slice(0, outLength - 2).concat('index.html');
-  }
-
-  return out.join('/').replace(/\/{2,}/g, '/');
-}
-
-module.exports = relativeUrlHelper;
+module.exports = function(from, to) {
+  return relative_url(from, to);
+};

lib/plugins/helper/url_for.js

@@ -1,35 +1,7 @@
 'use strict';
 
-const url = require('url');
-const relative_url = require('./relative_url');
+const { url_for } = require('hexo-util');
 
-function urlForHelper(path = '/', options) {
-  if (path[0] === '#' || path.startsWith('//')) {
-    return path;
-  }
-
-  const { config } = this;
-  const { root } = config;
-  const data = url.parse(path);
-
-  options = Object.assign({
-    relative: config.relative_link
-  }, options);
-
-  // Exit if this is an external path
-  if (data.protocol) {
-    return path;
-  }
-
-  // Resolve relative url
-  if (options.relative) {
-    return relative_url(this.path, path);
-  }
-
-  // Prepend root path
-  path = root + path;
-
-  return path.replace(/\/{2,}/g, '/');
-}
-
-module.exports = urlForHelper;
+module.exports = function(path, options) {
+  return url_for.call(this, path, options);
+};

lib/plugins/tag/asset_img.js

@@ -1,7 +1,8 @@
 'use strict';
 
-const url = require('url');
+const { resolve } = require('url');
 const img = require('./img');
+const { encodeURL } = require('hexo-util');
 
 /**
  * Asset image tag
@@ -19,7 +20,7 @@ module.exports = ctx => {
     for (let i = 0; i < len; i++) {
       const asset = PostAsset.findOne({post: this._id, slug: args[i]});
       if (asset) {
-        args[i] = url.resolve('/', asset.path);
+        args[i] = encodeURL(resolve('/', asset.path));
         return img(ctx)(args);
       }
     }

lib/plugins/tag/asset_link.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const url = require('url');
-const { escapeHTML } = require('hexo-util');
+const { encodeURL, escapeHTML } = require('hexo-util');
+const { resolve } = require('url');
 
 /**
  * Asset link tag
@@ -30,6 +30,8 @@ module.exports = ctx => {
     const attrTitle = escapeHTML(title);
     if (escape === 'true') title = attrTitle;
 
-    return `<a href="${url.resolve(ctx.config.root, asset.path)}" title="${attrTitle}">${title}</a>`;
+    const link = encodeURL(resolve(ctx.config.root, asset.path));
+
+    return `<a href="${link}" title="${attrTitle}">${title}</a>`;
   };
 };

lib/plugins/tag/asset_path.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const url = require('url');
+const { resolve } = require('url');
+const { encodeURL } = require('hexo-util');
 
 /**
  * Asset path tag
@@ -18,6 +19,8 @@ module.exports = ctx => {
     const asset = PostAsset.findOne({post: this._id, slug});
     if (!asset) return;
 
-    return url.resolve(ctx.config.root, asset.path);
+    const path = encodeURL(resolve(ctx.config.root, asset.path));
+
+    return path;
   };
 };

lib/plugins/tag/post_link.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const { escapeHTML } = require('hexo-util');
+const { encodeURL, escapeHTML } = require('hexo-util');
+const { resolve } = require('url');
 
 /**
  * Post link tag
@@ -29,6 +30,8 @@ module.exports = ctx => {
     const attrTitle = escapeHTML(title);
     if (escape === 'true') title = attrTitle;
 
-    return `<a href="${ctx.config.root}${post.path}" title="${attrTitle}">${title}</a>`;
+    const link = encodeURL(resolve(ctx.config.root, post.path));
+
+    return `<a href="${link}" title="${attrTitle}">${title}</a>`;
   };
 };

lib/plugins/tag/post_path.js

@@ -1,5 +1,8 @@
 'use strict';
 
+const { resolve } = require('url');
+const { encodeURL } = require('hexo-util');
+
 /**
  * Post path tag
  *
@@ -16,6 +19,8 @@ module.exports = ctx => {
     const post = Post.findOne({slug});
     if (!post) return;
 
-    return ctx.config.root + post.path;
+    const link = encodeURL(resolve(ctx.config.root, post.path));
+
+    return link;
   };
 };

test/scripts/helpers/relative_url.js

@@ -27,4 +27,8 @@ describe('relative_url', () => {
     relativeURL('foo/', '/').should.eql('../index.html');
     relativeURL('foo/index.html', '/').should.eql('../index.html');
   });
+
+  it('should encode path', () => {
+    relativeURL('foo/', 'css/fôo.css').should.eql('../css/f%C3%B4o.css');
+  });
 });

test/scripts/helpers/url_for.js

@@ -8,6 +8,14 @@ describe('url_for', () => {
 
   const urlFor = require('../../../lib/plugins/helper/url_for').bind(ctx);
 
+  it('should encode path', () => {
+    ctx.config.root = '/';
+    urlFor('fôo.html').should.eql('/f%C3%B4o.html');
+
+    ctx.config.root = '/fôo/';
+    urlFor('bár.html').should.eql('/f%C3%B4o/b%C3%A1r.html');
+  });
+
   it('internal url (relative off)', () => {
     ctx.config.root = '/';
     urlFor('index.html').should.eql('/index.html');

test/scripts/tags/asset_img.js

@@ -28,6 +28,11 @@ describe('asset_img', () => {
         slug: 'bar',
         post: post._id
       }),
+      PostAsset.insert({
+        _id: 'bár',
+        slug: 'bár',
+        post: post._id
+      }),
       PostAsset.insert({
         _id: 'spaced asset',
         slug: 'spaced asset',
@@ -40,6 +45,10 @@ describe('asset_img', () => {
     assetImg('bar').should.eql('<img src="/foo/bar" class="">');
   });
 
+  it('should encode path', () => {
+    assetImg('bár').should.eql('<img src="/foo/b%C3%A1r" class="">');
+  });
+
   it('default', () => {
     assetImg('bar title').should.eql('<img src="/foo/bar" class="" title="title">');
   });