From b56a57e21cdaca3e93e98cabea63b7cf2e0b3b9a Mon Sep 17 00:00:00 2001 From: Vincent Petry Date: Mon, 13 Jul 2015 15:26:01 +0200 Subject: [PATCH] Add helper functions for host, port and webroot These should be used in the future instead of location.*. It will make it possible to stub these methods for writing unit tests and simulating different URL schemes. --- core/js/js.js | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/core/js/js.js b/core/js/js.js index ff52c8f1f3..1dfcb576c2 100644 --- a/core/js/js.js +++ b/core/js/js.js @@ -68,7 +68,17 @@ var OC={ PERMISSION_ALL:31, TAG_FAVORITE: '_$!!$_', /* jshint camelcase: false */ + /** + * Relative path to ownCloud root. + * For example: "/owncloud" + * + * @type string + * + * @deprecated since 8.2, use OC.getRootPath() instead + * @see OC#getRootPath + */ webroot:oc_webroot, + appswebroots:(typeof oc_appswebroots !== 'undefined') ? oc_appswebroots:false, currentUser:(typeof oc_current_user!=='undefined')?oc_current_user:false, config: window.oc_config, @@ -218,6 +228,41 @@ var OC={ return window.location.protocol.split(':')[0]; }, + /** + * Returns the host name used to access this ownCloud instance + * + * @return {string} host name + * + * @since 8.2 + */ + getHost: function() { + return window.location.host; + }, + + /** + * Returns the port number used to access this ownCloud instance + * + * @return {int} port number + * + * @since 8.2 + */ + getPort: function() { + return window.location.port; + }, + + /** + * Returns the web root path where this ownCloud instance + * is accessible, with a leading slash. + * For example "/owncloud". + * + * @return {string} web root path + * + * @since 8.2 + */ + getRootPath: function() { + return OC.webroot; + }, + /** * get the absolute path to an image file * if no extension is given for the image, it will automatically decide