feat(router): allow to generate OCS URL for a given base (current ins…

…tance by default)

Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>

__tests__/urls.spec.ts

@@ -38,11 +38,27 @@ describe('URL generation', () => {
 		}
 	})
 
-	test('generateRemoteUrl', () => {
-		window._oc_webroot = '/nextcloud'
-		expect(generateRemoteUrl('dav')).toBe(`${window.location.href}nextcloud/remote.php/dav`)
+	describe('generateRemoteUrl', () => {
+		beforeEach(() => {
+			window._oc_webroot = ''
+		})
+
+		it('uses base URL by default', () => {
+			expect(generateRemoteUrl('dav')).toBe(`${window.location.origin}/remote.php/dav`)
+		})
+
+		it('replaces base URL with given one', () => {
+			const baseURL = 'https://remote-url.com'
+			expect(generateRemoteUrl('dav', { baseURL })).toBe(`${baseURL}/remote.php/dav`)
+		})
+
+		it('includes webroot', () => {
+			window._oc_webroot = '/nextcloud'
+			expect(generateRemoteUrl('dav')).toBe(`${window.location.origin}/nextcloud/remote.php/dav`)
+		})
 	})
 
+
 	describe('generateOcsUrl', () => {
 		beforeEach(() => {
 			window._oc_webroot = ''
@@ -56,6 +72,11 @@ describe('URL generation', () => {
 			expect(generateOcsUrl('/foo/bar', undefined, { ocsVersion: 1 })).toBe(`${window.location.href}ocs/v1.php/foo/bar`)
 		})
 
+		it('replaces base URL with given one', () => {
+			const baseURL = 'https://remote-url.com'
+			expect(generateOcsUrl('/foo/bar', undefined, { baseURL })).toBe(`${baseURL}/ocs/v2.php/foo/bar`)
+		})
+
 		it('starts with webroot', () => {
 			window._oc_webroot = '/nextcloud'
 			expect(generateOcsUrl('/foo/bar')).toBe(`${window.location.href}nextcloud/ocs/v2.php/foo/bar`)
@@ -83,6 +104,11 @@ describe('URL generation', () => {
 			expect(generateUrl('foo')).toBe('/foo')
 		})
 
+		it('replaces base URL with given one', () => {
+			const baseURL = 'https://remote-url.com'
+			expect(generateUrl('/foo/bar', undefined, { baseURL })).toBe(`${baseURL}/index.php/foo/bar`)
+		})
+
 		it('respects disabled mod-rewrite', () => {
 			expect(generateUrl('/foo/bar')).toMatch(/index\.php/)
 		})

lib/index.ts

@@ -19,6 +19,13 @@ export interface UrlOptions {
 	 * @default 2
 	 */
 	ocsVersion?: number
+
+
+    /**
+     * URL to use as a base (defaults to current instance)
+     * @default ''
+     */
+    baseURL?: string
 }
 
 /**
@@ -42,8 +49,12 @@ const linkToRemoteBase = (service: string) => '/remote.php/' + service
  * Creates an absolute url for remote use
  * @param {string} service id
  * @return {string} the url
+ * @param {UrlOptions} [options] options for the parameter replacement
  */
-export const generateRemoteUrl = (service: string) => getBaseUrl() + linkToRemoteBase(service)
+export const generateRemoteUrl = (service: string, options?: UrlOptions) => {
+    const baseURL = options?.baseURL ?? getBaseUrl()
+    return baseURL + linkToRemoteBase(service)
+}
 
 /**
  * Get the base path for the given OCS API service
@@ -59,10 +70,12 @@ export const generateOcsUrl = (url: string, params?: object, options?: UrlOption
 	}, options || {})
 
 	const version = (allOptions.ocsVersion === 1) ? 1 : 2
+	const baseURL = options?.baseURL ?? getBaseUrl()
 
-	return getBaseUrl() + '/ocs/v' + version + '.php' + _generateUrlPath(url, params, options)
+	return baseURL + '/ocs/v' + version + '.php' + _generateUrlPath(url, params, options)
 }
 
+
 /**
  * Generate a url path, which can contain parameters
  *
@@ -101,6 +114,7 @@ const _generateUrlPath = (url: string, params?: object, options?: UrlOptions) =>
 
 /**
  * Generate the url with webroot for the given relative url, which can contain parameters
+ * If options.baseURL is provided, generate the absolute url pointing ro remote server
  *
  * Parameters will be URL encoded automatically
  *
@@ -114,11 +128,13 @@ export const generateUrl = (url: string, params?: object, options?: UrlOptions)
 		noRewrite: false,
 	}, options || {})
 
+	const baseOrRootURL = options?.baseURL ?? getRootUrl()
+
 	if (window?.OC?.config?.modRewriteWorking === true && !allOptions.noRewrite) {
-		return getRootUrl() + _generateUrlPath(url, params, options)
+		return baseOrRootURL + _generateUrlPath(url, params, options)
 	}
 
-	return getRootUrl() + '/index.php' + _generateUrlPath(url, params, options)
+	return baseOrRootURL + '/index.php' + _generateUrlPath(url, params, options)
 }
 
 /**