encode URI paths with slashes

It's fine for query parameters to have visible / in them, and it makes it easier to work with the ungit URLs
FredrikNoren · May 27, 2020 · a71033b · a71033b
1 parent 2454e95
commit a71033b
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 18 deletions.
diff --git a/bin/ungit b/bin/ungit
@@ -8,6 +8,7 @@ const config = require('../source/config');
 const open = require('open');
 const path = require('path');
 const child_process = require('child_process');
+const encodePath = require('../source/utils/encode-path');
 
 const BugTracker = require('../source/bugtracker');
 const bugtracker = new BugTracker('launcher');
@@ -35,9 +36,9 @@ const openUngitBrowser = (pathToNavigateTo) => {
 const navigate = () => {
   let url = config.urlBase + ':' + config.port;
   if (config.forcedLaunchPath === undefined) {
-    url += '/#/repository?path=' + encodeURIComponent(process.cwd());
+    url += '/#/repository?path=' + encodePath(process.cwd());
   } else if (config.forcedLaunchPath !== null && config.forcedLaunchPath !== '') {
-    url += '/#/repository?path=' + encodeURIComponent(config.forcedLaunchPath);
+    url += '/#/repository?path=' + encodePath(config.forcedLaunchPath);
   }
 
   if (config.launchCommand) {

diff --git a/clicktests/environment.js b/clicktests/environment.js
@@ -7,6 +7,7 @@ const request = require('superagent');
 const mkdirp = require('mkdirp');
 const util = require('util');
 const rimraf = util.promisify(require('rimraf'));
+const encodePath = require('../source/utils/encode-path');
 const portrange = 45032;
 
 module.exports = (config) => new Environment(config);
@@ -237,7 +238,7 @@ class Environment {
   }
 
   async openUngit(tempDirPath) {
-    await this.goto(`${this.getRootUrl()}/#/repository?path=${encodeURIComponent(tempDirPath)}`);
+    await this.goto(`${this.getRootUrl()}/#/repository?path=${encodePath(tempDirPath)}`);
     await this.waitForElementVisible('.repository-actions');
     await this.wait(1000);
   }

diff --git a/clicktests/spec.remotes.js b/clicktests/spec.remotes.js
@@ -3,6 +3,7 @@ const environment = require('./environment')();
 const mkdirp = require('mkdirp');
 const util = require('util');
 const rimraf = util.promisify(require('rimraf'));
+const encodePath = require('../source/utils/encode-path');
 const testRepoPaths = [];
 
 describe('[REMOTES]', () => {
@@ -62,7 +63,7 @@ describe('[REMOTES]', () => {
   // ----------- CLONING -------------
   it('navigate to empty folder path', async () => {
     await environment.goto(
-      `${environment.getRootUrl()}/#/repository?path=${encodeURIComponent(testRepoPaths[2])}`
+      `${environment.getRootUrl()}/#/repository?path=${encodePath(testRepoPaths[2])}`
     );
     await environment.waitForElementVisible('.uninited');
   });

diff --git a/clicktests/spec.screens.js b/clicktests/spec.screens.js
@@ -3,6 +3,7 @@ const environment = require('./environment')();
 const mkdirp = require('mkdirp');
 const util = require('util');
 const rimraf = util.promisify(require('rimraf'));
+const encodePath = require('../source/utils/encode-path');
 const testRepoPaths = [];
 
 describe('[SCREENS]', () => {
@@ -19,7 +20,7 @@ describe('[SCREENS]', () => {
     testRepoPaths.push(await environment.createTempFolder());
 
     await environment.goto(
-      `${environment.getRootUrl()}/#/repository?path=${encodeURIComponent(testRepoPaths[0])}`
+      `${environment.getRootUrl()}/#/repository?path=${encodePath(testRepoPaths[0])}`
     );
     await environment.waitForElementVisible('.uninited');
   });
@@ -65,7 +66,7 @@ describe('[SCREENS]', () => {
     await mkdirp(specialRepoPath);
 
     await environment.goto(
-      `${environment.getRootUrl()}/#/repository?path=${encodeURIComponent(specialRepoPath)}`
+      `${environment.getRootUrl()}/#/repository?path=${encodePath(specialRepoPath)}`
     );
 
     await environment.waitForElementVisible('.uninited');

diff --git a/components/header/header.js b/components/header/header.js
@@ -3,6 +3,7 @@ const octicons = require('octicons');
 const components = require('ungit-components');
 const navigation = require('ungit-navigation');
 const programEvents = require('ungit-program-events');
+const encodePath = require('../../source/utils/encode-path');
 
 components.register('header', (args) => new HeaderViewModel(args.app));
 
@@ -25,7 +26,7 @@ class HeaderViewModel {
   }
 
   submitPath() {
-    navigation.browseTo(`repository?path=${encodeURIComponent(this.path())}`);
+    navigation.browseTo(`repository?path=${encodePath(this.path())}`);
   }
 
   onProgramEvent(event) {

diff --git a/components/home/home.js b/components/home/home.js
@@ -1,6 +1,7 @@
 const ko = require('knockout');
 const octicons = require('octicons');
 const components = require('ungit-components');
+const encodePath = require('../../source/utils/encode-path');
 
 components.register('home', (args) => new HomeViewModel(args.app));
 
@@ -11,7 +12,7 @@ class HomeRepositoryViewModel {
     this.server = this.app.server;
     this.path = path;
     this.title = path;
-    this.link = `${ungit.config.rootPath}/#/repository?path=${encodeURIComponent(path)}`;
+    this.link = `${ungit.config.rootPath}/#/repository?path=${encodePath(path)}`;
     this.pathRemoved = ko.observable(false);
     this.remote = ko.observable('...');
     this.updateState();
@@ -21,13 +22,13 @@ class HomeRepositoryViewModel {
 
   updateState() {
     this.server
-      .getPromise(`/fs/exists?path=${encodeURIComponent(this.path)}`)
+      .getPromise(`/fs/exists?path=${encodePath(this.path)}`)
       .then((exists) => {
         this.pathRemoved(!exists);
       })
       .catch((e) => this.server.unhandledRejection(e));
     this.server
-      .getPromise(`/remotes/origin?path=${encodeURIComponent(this.path)}`)
+      .getPromise(`/remotes/origin?path=${encodePath(this.path)}`)
       .then((remote) => {
         this.remote(remote.address.replace(/\/\/.*?@/, '//***@'));
       })

diff --git a/components/imagediff/imagediff.js b/components/imagediff/imagediff.js
@@ -1,3 +1,4 @@
+const encodePath = require('../../source/utils/encode-path');
 const ko = require('knockout');
 const octicons = require('octicons');
 const components = require('ungit-components');
@@ -17,7 +18,7 @@ class ImageDiffViewModel {
       if (this.isRemoved()) return 'removed';
       return 'changed';
     });
-    const gitDiffURL = `${ungit.config.rootPath}/api/diff/image?path=${encodeURIComponent(
+    const gitDiffURL = `${ungit.config.rootPath}/api/diff/image?path=${encodePath(
       this.repoPath()
     )}`;
     this.oldImageSrc =

diff --git a/components/path/path.js b/components/path/path.js
@@ -1,3 +1,4 @@
+const encodePath = require('../../source/utils/encode-path');
 const ko = require('knockout');
 const components = require('ungit-components');
 const addressParser = require('ungit-address-parser');
@@ -90,7 +91,7 @@ class PathViewModel {
         destinationDir: dest,
         isRecursiveSubmodule: this.isRecursiveSubmodule(),
       })
-      .then((res) => navigation.browseTo('repository?path=' + encodeURIComponent(res.path)))
+      .then((res) => navigation.browseTo('repository?path=' + encodePath(res.path)))
       .catch((e) => this.server.unhandledRejection(e))
       .finally(() => {
         programEvents.dispatch({ event: 'working-tree-changed' });

diff --git a/components/repository/repository.js b/components/repository/repository.js
@@ -1,3 +1,4 @@
+const encodePath = require('../../source/utils/encode-path');
 const ko = require('knockout');
 const octicons = require('octicons');
 const components = require('ungit-components');
@@ -77,9 +78,7 @@ class RepositoryViewModel {
                 for (let n = 0; n < submodules.length; n++) {
                   if (submodules[n].path === baseName) {
                     this.parentModulePath(baseRepoPath.path);
-                    this.parentModuleLink(
-                      `/#/repository?path=${encodeURIComponent(baseRepoPath.path)}`
-                    );
+                    this.parentModuleLink(`/#/repository?path=${encodePath(baseRepoPath.path)}`);
                     return;
                   }
                 }

diff --git a/public/main.js b/public/main.js
@@ -4,6 +4,7 @@ var child_process = require('child_process');
 var path = require('path');
 // eslint-disable-next-line no-unused-vars -- Imported for side effects
 var winston = require('../source/utils/winston');
+const encodePath = require('../source/utils/encode-path');
 var config = require('../source/config');
 var BugTracker = require('../source/bugtracker');
 var bugtracker = new BugTracker('electron');
@@ -24,9 +25,9 @@ function openUngitBrowser(pathToNavigateTo) {
 function launch(callback) {
   var url = config.urlBase + ':' + config.port;
   if (config.forcedLaunchPath === undefined) {
-    url += '/#/repository?path=' + encodeURIComponent(process.cwd());
+    url += '/#/repository?path=' + encodePath(process.cwd());
   } else if (config.forcedLaunchPath !== null && config.forcedLaunchPath !== '') {
-    url += '/#/repository?path=' + encodeURIComponent(config.forcedLaunchPath);
+    url += '/#/repository?path=' + encodePath(config.forcedLaunchPath);
   }
 
   if (config.launchCommand) {

diff --git a/public/source/main.js b/public/source/main.js
@@ -1,3 +1,4 @@
+var encodePath = require('../../source/utils/encode-path');
 var _ = require('lodash');
 var $ = require('jquery');
 jQuery = $; // this is for old backward compatability of bootrap modules
@@ -93,7 +94,7 @@ ko.bindingHandlers.autocomplete = {
       } else if (event.keyCode === 13) {
         // enter key is struck, navigate to the path
         event.preventDefault();
-        navigation.browseTo(`repository?path=${encodeURIComponent(value)}`);
+        navigation.browseTo(`repository?path=${encodePath(value)}`);
       } else if (value === '' && storage.getItem('repositories')) {
         // if path is emptied out, show save path options
         const folderNames = JSON.parse(storage.getItem('repositories')).map((value) => {

diff --git a/source/utils/encode-path.js b/source/utils/encode-path.js
@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = (path) => encodeURIComponent(path).replace(/%2F/g, '/');