Merge pull request #15291 from nextcloud/refactor/js-routing-helpers-bundle

Move the OC routing helper functions to the bundle
This commit is contained in:
John Molakvoæ 2019-05-02 13:10:54 +02:00 committed by GitHub
commit 95269e7e85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 166 additions and 155 deletions

29
core/js/dist/main.js vendored

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -65,136 +65,6 @@ Object.assign(window.OC, {
requestToken: oc_requesttoken,
menuSpeed: 50,
/**
* Get an absolute url to a file in an app
* @param {string} app the id of the app the file belongs to
* @param {string} file the file path relative to the app folder
* @return {string} Absolute URL to a file
*/
linkTo:function(app,file){
return OC.filePath(app,'',file);
},
/**
* Creates a relative url for remote use
* @param {string} service id
* @return {string} the url
*/
linkToRemoteBase:function(service) {
return OC.getRootPath() + '/remote.php/' + service;
},
/**
* @brief Creates an absolute url for remote use
* @param {string} service id
* @return {string} the url
*/
linkToRemote:function(service) {
return window.location.protocol + '//' + window.location.host + OC.linkToRemoteBase(service);
},
/**
* Gets the base path for the given OCS API service.
* @param {string} service name
* @param {int} version OCS API version
* @return {string} OCS API base path
*/
linkToOCS: function(service, version) {
version = (version !== 2) ? 1 : 2;
return window.location.protocol + '//' + window.location.host + OC.getRootPath() + '/ocs/v' + version + '.php/' + service + '/';
},
/**
* Generates the absolute url for the given relative url, which can contain parameters.
* Parameters will be URL encoded automatically.
* @param {string} url
* @param [params] params
* @param [options] options
* @param {bool} [options.escape=true] enable/disable auto escape of placeholders (by default enabled)
* @return {string} Absolute URL for the given relative URL
*/
generateUrl: function(url, params, options) {
var defaultOptions = {
escape: true
},
allOptions = options || {};
_.defaults(allOptions, defaultOptions);
var _build = function (text, vars) {
vars = vars || [];
return text.replace(/{([^{}]*)}/g,
function (a, b) {
var r = (vars[b]);
if(allOptions.escape) {
return (typeof r === 'string' || typeof r === 'number') ? encodeURIComponent(r) : encodeURIComponent(a);
} else {
return (typeof r === 'string' || typeof r === 'number') ? r : a;
}
}
);
};
if (url.charAt(0) !== '/') {
url = '/' + url;
}
if(OC.config.modRewriteWorking == true) {
return OC.getRootPath() + _build(url, params);
}
return OC.getRootPath() + '/index.php' + _build(url, params);
},
/**
* Get the absolute url for a file in an app
* @param {string} app the id of the app
* @param {string} type the type of the file to link to (e.g. css,img,ajax.template)
* @param {string} file the filename
* @return {string} Absolute URL for a file in an app
*/
filePath:function(app,type,file){
var isCore=OC.coreApps.indexOf(app)!==-1,
link=OC.getRootPath();
if(file.substring(file.length-3) === 'php' && !isCore){
link+='/index.php/apps/' + app;
if (file != 'index.php') {
link+='/';
if(type){
link+=encodeURI(type + '/');
}
link+= file;
}
}else if(file.substring(file.length-3) !== 'php' && !isCore){
link=OC.appswebroots[app];
if(type){
link+= '/'+type+'/';
}
if(link.substring(link.length-1) !== '/'){
link+='/';
}
link+=file;
}else{
if ((app == 'settings' || app == 'core' || app == 'search') && type == 'ajax') {
link+='/index.php/';
}
else {
link+='/';
}
if(!isCore){
link+='apps/';
}
if (app !== '') {
app+='/';
link+=app;
}
if(type){
link+=type+'/';
}
link+=file;
}
return link;
},
/**
* Check if a user file is allowed to be handled.
* @param {string} file to check

View File

@ -27,6 +27,14 @@ import ContactsMenu from './contactsmenu'
import Dialogs from './dialogs'
import EventSource from './eventsource'
import L10N from './l10n'
import {
generateUrl,
filePath,
linkTo,
linkToOCS,
linkToRemote,
linkToRemoteBase,
} from './routing'
import msg from './msg'
import Notification from './notification'
import PasswordConfirmation from './password-confirmation'
@ -51,6 +59,12 @@ export default {
Plugins,
search,
Util,
generateUrl,
filePath,
redirect,
reload,
linkTo,
linkToOCS,
linkToRemote,
linkToRemoteBase,
}

146
core/src/OC/routing.js Normal file
View File

@ -0,0 +1,146 @@
/*
* @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import _ from 'underscore'
import OC from './index'
/**
* Get an absolute url to a file in an app
* @param {string} app the id of the app the file belongs to
* @param {string} file the file path relative to the app folder
* @return {string} Absolute URL to a file
*/
export const linkTo = (app, file) => filePath(app, '', file)
/**
* Creates a relative url for remote use
* @param {string} service id
* @return {string} the url
*/
export const linkToRemoteBase = service => OC.getRootPath() + '/remote.php/' + service
/**
* @brief Creates an absolute url for remote use
* @param {string} service id
* @return {string} the url
*/
export const linkToRemote = service => window.location.protocol + '//' + window.location.host + linkToRemoteBase(service)
/**
* Gets the base path for the given OCS API service.
* @param {string} service name
* @param {int} version OCS API version
* @return {string} OCS API base path
*/
export const linkToOCS = (service, version) => {
version = (version !== 2) ? 1 : 2
return window.location.protocol + '//' + window.location.host + OC.getRootPath() + '/ocs/v' + version + '.php/' + service + '/'
}
/**
* Generates the absolute url for the given relative url, which can contain parameters.
* Parameters will be URL encoded automatically.
* @param {string} url
* @param [params] params
* @param [options] options
* @param {bool} [options.escape=true] enable/disable auto escape of placeholders (by default enabled)
* @return {string} Absolute URL for the given relative URL
*/
export const generateUrl = (url, params, options) => {
const defaultOptions = {
escape: true
},
allOptions = options || {};
_.defaults(allOptions, defaultOptions);
const _build = function (text, vars) {
vars = vars || [];
return text.replace(/{([^{}]*)}/g,
function (a, b) {
var r = (vars[b]);
if (allOptions.escape) {
return (typeof r === 'string' || typeof r === 'number') ? encodeURIComponent(r) : encodeURIComponent(a);
} else {
return (typeof r === 'string' || typeof r === 'number') ? r : a;
}
}
);
};
if (url.charAt(0) !== '/') {
url = '/' + url;
}
if (oc_config.modRewriteWorking === true) {
return OC.getRootPath() + _build(url, params);
}
return OC.getRootPath() + '/index.php' + _build(url, params);
}
/**
* Get the absolute url for a file in an app
* @param {string} app the id of the app
* @param {string} type the type of the file to link to (e.g. css,img,ajax.template)
* @param {string} file the filename
* @return {string} Absolute URL for a file in an app
*/
export const filePath = (app, type, file) => {
const isCore = OC.coreApps.indexOf(app) !== -1
let link = OC.getRootPath()
if (file.substring(file.length - 3) === 'php' && !isCore) {
link += '/index.php/apps/' + app;
if (file !== 'index.php') {
link += '/'
if (type) {
link += encodeURI(type + '/')
}
link += file
}
} else if (file.substring(file.length - 3) !== 'php' && !isCore) {
link = OC.appswebroots[app];
if (type) {
link += '/' + type + '/'
}
if (link.substring(link.length - 1) !== '/') {
link += '/'
}
link += file
} else {
if ((app === 'settings' || app === 'core' || app === 'search') && type === 'ajax') {
link += '/index.php/'
} else {
link += '/'
}
if (!isCore) {
link += 'apps/'
}
if (app !== '') {
app += '/'
link += app
}
if (type) {
link += type + '/'
}
link += file
}
return link
}