Files
espocrm/client/src/router.js
Taras Machyshyn 124cce55bd 2021 license
2021-01-25 16:37:54 +02:00

419 lines
14 KiB
JavaScript

/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
define('router', [], function () {
var Router = Backbone.Router.extend({
routeList: [
{
route: "clearCache",
resolution: "clearCache"
},
{
route: ":controller/view/:id/:options",
resolution: "view"
},
{
route: ":controller/view/:id",
resolution: "view"
},
{
route: ":controller/edit/:id/:options",
resolution: "edit"
},
{
route: ":controller/edit/:id",
resolution: "edit"
},
{
route: ":controller/create",
resolution: "create"
},
{
route: ":controller/:action/:options",
resolution: "action",
order: 100
},
{
route: ":controller/:action",
resolution: "action",
order: 200
},
{
route: ":controller",
resolution: "defaultAction",
order: 300
},
{
route: "*actions",
resolution: "home",
order: 500
}
],
_bindRoutes: function() {},
setupRoutes: function () {
this.routeParams = {};
if (this.options.routes) {
var routeList = [];
Object.keys(this.options.routes).forEach(function (route) {
var item = this.options.routes[route];
routeList.push({
route: route,
resolution: item.resolution || 'defaultRoute',
order: item.order || 0
});
this.routeParams[route] = item.params || {};
}, this);
this.routeList = Espo.Utils.clone(this.routeList);
routeList.forEach(function (item) {
this.routeList.push(item);
}, this);
this.routeList = this.routeList.sort(function (v1, v2) {
return (v1.order || 0) - (v2.order || 0);
});
}
this.routeList.reverse().forEach(function (item) {
this.route(item.route, item.resolution);
}, this);
},
_last: null,
confirmLeaveOut: false,
backProcessed: false,
confirmLeaveOutMessage: 'Are you sure?',
confirmLeaveOutConfirmText: 'Yes',
confirmLeaveOutCancelText: 'No',
initialize: function (options) {
this.options = options || {};
this.setupRoutes();
this.history = [];
var detectBackOrForward = function(onBack, onForward) {
hashHistory = [window.location.hash];
historyLength = window.history.length;
return function () {
var hash = window.location.hash, length = window.history.length;
if (hashHistory.length && historyLength == length) {
if (hashHistory[hashHistory.length - 2] == hash) {
hashHistory = hashHistory.slice(0, -1);
if (onBack) {
onBack();
}
} else {
hashHistory.push(hash);
if (onForward) {
onForward();
}
}
} else {
hashHistory.push(hash);
historyLength = length;
}
}
};
window.addEventListener('hashchange', detectBackOrForward(function () {
this.backProcessed = true;
setTimeout(function () {
this.backProcessed = false;
}.bind(this), 50);
}.bind(this)));
this.on('route', function (name, args) {
this.history.push(Backbone.history.fragment);
});
window.addEventListener('beforeunload', function (e) {
e = e || window.event;
if (this.confirmLeaveOut) {
e.preventDefault();
e.returnValue = this.confirmLeaveOutMessage;
return this.confirmLeaveOutMessage;
}
}.bind(this));
},
getCurrentUrl: function () {
return '#' + Backbone.history.fragment;
},
checkConfirmLeaveOut: function (callback, context, navigateBack) {
if (this.confirmLeaveOutDisplayed) {
this.navigateBack({trigger: false});
this.confirmLeaveOutCanceled = true;
return;
}
context = context || this;
if (this.confirmLeaveOut) {
this.confirmLeaveOutDisplayed = true;
this.confirmLeaveOutCanceled = false;
Espo.Ui.confirm(this.confirmLeaveOutMessage, {
confirmText: this.confirmLeaveOutConfirmText,
cancelText: this.confirmLeaveOutCancelText,
backdrop: true,
cancelCallback: function () {
this.confirmLeaveOutDisplayed = false;
if (navigateBack) {
this.navigateBack({trigger: false});
}
}.bind(this)
}, function () {
this.confirmLeaveOutDisplayed = false;
this.confirmLeaveOut = false;
if (!this.confirmLeaveOutCanceled) {
callback.call(context);
}
}.bind(this));
} else {
callback.call(context);
}
},
route: function (route, name, callback) {
var routeOriginal = route;
if (!_.isRegExp(route)) route = this._routeToRegExp(route);
if (_.isFunction(name)) {
callback = name;
name = '';
}
if (!callback) callback = this[name];
var router = this;
Backbone.history.route(route, function (fragment) {
var args = router._extractParameters(route, fragment);
var options = {};
if (name === 'defaultRoute') {
var keyList = [];
routeOriginal.split('/').forEach(function (key) {
if (key && key.indexOf(':') === 0) keyList.push(key.substr(1));
});
keyList.forEach(function (key, i) {
options[key] = args[i];
});
}
if (router.execute(callback, args, name, routeOriginal, options) !== false) {
router.trigger.apply(router, ['route:' + name].concat(args));
router.trigger('route', name, args);
Backbone.history.trigger('route', router, name, args);
}
});
return this;
},
execute: function (callback, args, name, routeOriginal, options) {
this.checkConfirmLeaveOut(function () {
if (name === 'defaultRoute') {
this.defaultRoute(this.routeParams[routeOriginal], options);
return;
}
Backbone.Router.prototype.execute.call(this, callback, args, name);
}, null, true);
},
navigate: function (fragment, options) {
this.history.push(fragment);
return Backbone.Router.prototype.navigate.call(this, fragment, options);
},
navigateBack: function (options) {
var url;
if (this.history.length > 1) {
url = this.history[this.history.length - 2];
} else {
url = this.history[0];
}
this.navigate(url, options);
},
_parseOptionsParams: function (string) {
if (!string) {
return {};
}
if (string.indexOf('&') === -1 && string.indexOf('=') === -1) {
return string;
}
var options = {};
if (typeof string !== 'undefined') {
string.split('&').forEach(function (item, i) {
var p = item.split('=');
options[p[0]] = true;
if (p.length > 1) {
options[p[0]] = p[1];
}
});
}
return options;
},
defaultRoute: function (params, options) {
var controller = params.controller || options.controller;
var action = params.action || options.action;
this.dispatch(controller, action, options);
},
record: function (controller, action, id, options) {
var options = this._parseOptionsParams(options);
options.id = id;
this.dispatch(controller, action, options);
},
view: function (controller, id, options) {
this.record(controller, 'view', id, options);
},
edit: function (controller, id, options) {
this.record(controller, 'edit', id, options);
},
create: function (controller, options) {
this.record(controller, 'create', null, options);
},
action: function (controller, action, options) {
this.dispatch(controller, action, this._parseOptionsParams(options));
},
defaultAction: function (controller) {
this.dispatch(controller, null);
},
home: function () {
this.dispatch('Home', null);
},
logout: function () {
this.dispatch(null, 'logout');
this.navigate('', {trigger: false});
},
clearCache: function () {
this.dispatch(null, 'clearCache');
},
dispatch: function (controller, action, options) {
var o = {
controller: controller,
action: action,
options: options
}
this._last = o;
this.trigger('routed', o);
},
getLast: function () {
return this._last;
}
});
return Router;
});
function isIOS9UIWebView() {
var userAgent = window.navigator.userAgent;
return /(iPhone|iPad|iPod).* OS 9_\d/.test(userAgent) && !/Version\/9\./.test(userAgent);
}
//override the backbone.history.loadUrl() and backbone.history.navigate()
//to fix the navigation issue (location.hash not change immediately) on iOS9
if (isIOS9UIWebView()) {
Backbone.history.loadUrl = function (fragment, oldHash) {
fragment = this.fragment = this.getFragment(fragment);
return _.any(this.handlers, function (handler) {
if (handler.route.test(fragment)) {
function runCallback() {
handler.callback(fragment);
}
function wait() {
if (oldHash === location.hash) {
window.setTimeout(wait, 50);
} else {
runCallback();
}
}
wait();
return true;
}
});
};
Backbone.history.navigate = function (fragment, options) {
var pathStripper = /#.*$/;
if (!Backbone.History.started) return false;
if (!options || options === true) options = { trigger: !!options };
var url = this.root + '#' + (fragment = this.getFragment(fragment || ''));
fragment = fragment.replace(pathStripper, '');
if (this.fragment === fragment) return;
this.fragment = fragment;
if (fragment === '' && url !== '/') url = url.slice(0, -1);
var oldHash = location.hash;
if (this._hasPushState) {
this.history[options.replace ? 'replaceState' : 'pushState']({}, document.title, url);
} else if (this._wantsHashChange) {
this._updateHash(this.location, fragment, options.replace);
if (this.iframe && (fragment !== this.getFragment(this.getHash(this.iframe)))) {
if (!options.replace) this.iframe.document.open().close();
this._updateHash(this.iframe.location, fragment, options.replace);
}
} else {
return this.location.assign(url);
}
if (options.trigger) return this.loadUrl(fragment, oldHash);
}
}