@gravityforms/utils/src/data/parse-url.js

JavaScript utilities for Gravity Forms development.

/* eslint-disable */
/**
 * @module parseUrl
 * @description Parses an URL and returns its individual components.
 *
 * @since 1.0.0
 *
 * @param {string} str       The URL to be parsed
 * @param {string} component Determines which URL component to be returned. If ommitted, an associative array with all URL components is returned.
 *                           Possible values: ( scheme, user, pass, host, path, query, fragment, source ).

 * @return {string|object} Returns the specified URL component. If the component parameter is ommitted, returns an associative array with all URL components.
 *
 * @example

 * import { parseUrl } from "@gravityforms/utils";
 *
 * function Example() {
 * 	 const url = 'http://username:password@hostname/path?arg=value#anchor';
 *
 * 	 const allComponents = parseUrl( url );
 * 	 const hostname      = parseUrl( url, 'host' );
 * }

 *
 */
export default function(str, component) {
	// example: parse_url('http://username:password@hostname/path?arg=value#anchor');
	// returns: {scheme: 'http', host: 'hostname', user: 'username', pass: 'password', path: '/path', query: 'arg=value', fragment: 'anchor'}

	let query;
	const key = ['source', 'scheme', 'authority', 'userInfo', 'user', 'pass', 'host', 'port', 'relative', 'path', 'directory', 'file', 'query', 'fragment'];
	const ini = {};
	const mode = (ini['phpjs.parse_url.mode'] && ini['phpjs.parse_url.mode'].local_value) || 'php';
	let parser = {
		php: /^(?:([^:\/?#]+):)?(?:\/\/()(?:(?:()(?:([^:@]*):?([^:@]*))?@)?([^:\/?#]*)(?::(\d*))?))?()(?:(()(?:(?:[^?#\/]*\/)*)()(?:[^?#]*))(?:\?([^#]*))?(?:#(.*))?)/,
		strict: /^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*):?([^:@]*))?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/,
		loose: /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/\/?)?((?:(([^:@]*):?([^:@]*))?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/, // Added one optional slash to post-scheme to catch file:/// (should restrict this)
	};

	const m = parser[mode].exec(str);
	const uri = {};
	let i = 14;
	let name;

	while (i--) {
		if (m[i]) {
			uri[key[i]] = m[i];
		}
	}

	if (component) {
		return uri[component.replace('PHP_URL_', '').toLowerCase()];
	}

	if (mode !== 'php') {
		name = (ini['phpjs.parse_url.queryKey'] && ini['phpjs.parse_url.queryKey'].local_value) || 'queryKey';
		parser = /(?:^|&)([^&=]*)=?([^&]*)/g;
		uri[name] = {};
		query = uri[key[12]] || '';
		query.replace(parser, ($0, $1, $2) => {
			if ($1) {
				uri[name][$1] = $2;
			}
		});
	}

	uri.source = null;
	return uri;
};