mirror of
https://github.com/Karaka-Management/jsOMS.git
synced 2026-01-11 17:58:41 +00:00
298 lines
8.1 KiB
JavaScript
298 lines
8.1 KiB
JavaScript
import { HttpUri } from './HttpUri.js';
|
|
import { FormView } from './../Views/FormView.js';
|
|
|
|
/**
|
|
* Uri factory.
|
|
*
|
|
* @copyright Dennis Eichhorn
|
|
* @license OMS License 1.0
|
|
* @version 1.0.0
|
|
* @since 1.0.0
|
|
*
|
|
* @todo Orange-Management/phpOMS#239
|
|
* Optional parameters
|
|
* Sometimes we need to define a list of optional parameters that will be filled if they exist and only if they exist.
|
|
* E.g. `u=` for unit `filter=` for filtering etc.
|
|
* Otherwise the url on some pages keeps getting longer and longer because parameters get appended.
|
|
*/
|
|
export class UriFactory
|
|
{
|
|
/**
|
|
* Set uri query
|
|
*
|
|
* @param {string} key Query key
|
|
* @param {string} value Query value
|
|
* @param {boolean} [overwrite] Overwrite if already exists?
|
|
*
|
|
* @return {boolean}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static setQuery (key, value, overwrite)
|
|
{
|
|
overwrite = typeof overwrite !== 'undefined' ? overwrite : true;
|
|
|
|
if (overwrite || !UriFactory.uri.hasOwnProperty(key)) {
|
|
UriFactory.uri[key] = value;
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Get query
|
|
*
|
|
* @param {string} key
|
|
*
|
|
* @return {null|string}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static getQuery (key)
|
|
{
|
|
return UriFactory.uri.hasOwnProperty(key) ? UriFactory.uri[key] : null;
|
|
};
|
|
|
|
/**
|
|
* Clear all uri components
|
|
*
|
|
* @return {boolean}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static clearAll ()
|
|
{
|
|
UriFactory.uri = {};
|
|
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* Clear uri component
|
|
*
|
|
* @param {string} key Uri key for component
|
|
*
|
|
* @return {boolean}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static clear (key)
|
|
{
|
|
if (UriFactory.uri.hasOwnProperty(key)) {
|
|
delete UriFactory.uri[key];
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Clear uri components that follow a certain pattern
|
|
*
|
|
* @param {string} pattern Uri key pattern to remove
|
|
*
|
|
* @return {boolean}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static clearLike (pattern)
|
|
{
|
|
let success = false;
|
|
const regexp = new RegExp(pattern);
|
|
|
|
for (const key in UriFactory.uri) {
|
|
if (UriFactory.uri.hasOwnProperty(key) && regexp.test(key)) {
|
|
delete UriFactory.uri[key];
|
|
success = true;
|
|
}
|
|
}
|
|
|
|
return success;
|
|
};
|
|
|
|
/**
|
|
* Remove multiple definitions of the same parameter
|
|
*
|
|
* The parameters will be recognized from right to left since it's easier to push at the end.
|
|
*
|
|
* @param {string} url Url
|
|
*
|
|
* @return {string}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static unique (url)
|
|
{
|
|
// @todo: there is a bug for uris which have a parameter without a value and a fragment e.g. ?debug#something.
|
|
// The fragment is ignored in such a case.
|
|
if (url.includes('?')) {
|
|
const parsed = HttpUri.parseUrl(url);
|
|
|
|
// unique queries
|
|
const parts = typeof parsed.query === 'undefined' ? [] : parsed.query.replace(/\?/g, '&').split('&'),
|
|
full = url.split('?')[0],
|
|
pars = [];
|
|
|
|
let comps = {},
|
|
spl = null,
|
|
length = parts.length;
|
|
|
|
for (let i = 0; i < length; ++i) {
|
|
spl = parts[i].split('=');
|
|
comps[spl[0]] = spl.length < 2 ? '' : spl[1];
|
|
}
|
|
|
|
for (const a in comps) {
|
|
if (comps.hasOwnProperty(a) && comps[a] !== '' && comps[a] !== null && typeof comps[a] !== 'undefined') {
|
|
pars.push(a + '=' + (comps[a].includes('%') ? comps[a] : encodeURIComponent(comps[a])));
|
|
} else if (comps.hasOwnProperty(a)) {
|
|
pars.push(a);
|
|
}
|
|
}
|
|
|
|
url = full + '?' + pars.join('&');
|
|
}
|
|
|
|
// unique fragments
|
|
const fragments = url.match(/\#[a-zA-Z0-9\-,]+/g),
|
|
fragLength = fragments !== null ? fragments.length : 0;
|
|
|
|
// @todo: don't remove fragments, some might be used = none tab fragments
|
|
|
|
for (let i = 0; i < fragLength - 1; ++i) {
|
|
// remove all from old url
|
|
url = url.replace(fragments[i], '');
|
|
}
|
|
|
|
return url;
|
|
};
|
|
|
|
/**
|
|
* Build uri
|
|
*
|
|
* # = DOM id
|
|
* . = DOM class
|
|
* / = Current path
|
|
* ? = Current query
|
|
* @ =
|
|
* $ = Other data
|
|
* % = Current url
|
|
*
|
|
* @param {string} uri Raw uri
|
|
* @param {Object} [toMatch] Key/value pair to replace in raw
|
|
*
|
|
* @return {string}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static build (uri, toMatch)
|
|
{
|
|
const current = HttpUri.parseUrl(window.location.href);
|
|
let parsed = uri.replace(new RegExp('\{[\/#\?%@\.\$\!][a-zA-Z0-9\-\#\.]*\}', 'g'), function (match) {
|
|
match = match.substr(1, match.length - 2);
|
|
|
|
if (typeof toMatch !== 'undefined' && toMatch.hasOwnProperty(match)) {
|
|
return toMatch[match];
|
|
} else if (typeof UriFactory.uri[match] !== 'undefined') {
|
|
return UriFactory.uri[match];
|
|
} else if (match.indexOf('!') === 0) {
|
|
const e = document.querySelector(match.substr(1));
|
|
|
|
if (!e) {
|
|
return '';
|
|
}
|
|
|
|
if (e.tagName.toLowerCase() !== 'form') {
|
|
return e.value;
|
|
}
|
|
|
|
let value = '';
|
|
const form = (new FormView(e.id)).getData();
|
|
|
|
for (let pair of form.entries()) {
|
|
value += '&' + pair[0] + '=' + pair[1];
|
|
}
|
|
|
|
return value;
|
|
} else if (match.indexOf('?') === 0) {
|
|
return HttpUri.getUriQueryParameter(current.query, match.substr(1));
|
|
} else if (match === '#') {
|
|
return current.fragment;
|
|
} else if (match.indexOf('#') === 0) {
|
|
const e = document.getElementById(match.substr(1));
|
|
if (e) {
|
|
if (e.tagName.toLowerCase() !== 'form') {
|
|
return e.value;
|
|
}
|
|
|
|
let value = '';
|
|
const form = (new FormView(e.id)).getData();
|
|
|
|
for (let pair of form.entries()) {
|
|
value += '&' + pair[0] + '=' + pair[1];
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
return '';
|
|
} else if (match.indexOf('?') === 0) {
|
|
return current.query();
|
|
} else if (match.indexOf('/') === 0) {
|
|
return current.path;
|
|
} else if (match.indexOf(':user') === 0) {
|
|
return current.user;
|
|
} else if (match.indexOf(':pass') === 0) {
|
|
return current.pass;
|
|
} else if (match.indexOf('/') === 0) {
|
|
return 'ERROR PATH';
|
|
} else if (match === '%') {
|
|
return window.location.href;
|
|
} else {
|
|
return match;
|
|
}
|
|
});
|
|
|
|
if (parsed.indexOf('?') === -1) {
|
|
parsed = parsed.replace('&', '?');
|
|
}
|
|
|
|
return UriFactory.unique(parsed);
|
|
};
|
|
|
|
/**
|
|
* Set uri builder components.
|
|
*
|
|
* @return {void}
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
static setupUriBuilder (uri)
|
|
{
|
|
UriFactory.setQuery('/scheme', uri.getScheme());
|
|
UriFactory.setQuery('/host', uri.getHost());
|
|
UriFactory.setQuery('/base', jsOMS.rtrim(uri.getBase(), '/'));
|
|
|
|
const query = uri.getQuery();
|
|
|
|
// @todo consider to move this to the build function like all the other components. The reason for this is that JS may change the query values on the fly on the frontend and therefore these values will not be the current values!
|
|
for (const key in query) {
|
|
if (query.hasOwnProperty(key)) {
|
|
UriFactory.setQuery('?' + key, query[key]);
|
|
}
|
|
}
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Uri values
|
|
*
|
|
* @var {Object}
|
|
* @since 1.0.0
|
|
*/
|
|
UriFactory.uri = {};
|
|
|