<?php
/**
*
* @package Duplicator
* @copyright (c) 2022, Snap Creek LLC
*/
namespace Duplicator\Libs\Snap;
class SnapURL
{
/** @var array<string, scalar> */
protected static $DEF_ARRAY_PARSE_URL = array(
'scheme' => false,
'host' => false,
'port' => false,
'user' => false,
'pass' => false,
'path' => '',
'query' => false,
'fragment' => false
);
/**
* Append a new query value to the end of a URL
*
* @param string $url The URL to append the new value to
* @param string $key The new key name
* @param ?scalar $value The new key name value
*
* @return string Returns the new URL with with the query string name and value
*/
public static function appendQueryValue($url, $key, $value)
{
$separator = (parse_url($url, PHP_URL_QUERY) == null) ? '?' : '&';
$modified_url = $url . "$separator$key=" . $value;
return $modified_url;
}
/**
* Add www. in url if don't have
*
* @param string $url input URL
*
* @return string
*/
public static function wwwAdd($url)
{
return preg_replace('/^((?:\w+\:)?\/\/)?(?!www\.)(.+)/', '$1www.$2', $url);
}
/**
* Remove www. in url if don't have
*
* @param string $url input URL
*
* @return string
*/
public static function wwwRemove($url)
{
return preg_replace('/^((?:\w+\:)?\/\/)?www\.(.+)/', '$1$2', $url);
}
/**
* Fetches current URL via PHP
*
* @param bool $queryString If true the query string will also be returned.
* @param boolean $requestUri If true check REQUEST_URI else SCRIPT_NAME
* @param int $getParentDirLevel If 0 get current script name or parent folder, if 1 parent folder if 2 parent of parent folder ...
*
* @return string The current page url
*/
public static function getCurrentUrl($queryString = true, $requestUri = false, $getParentDirLevel = 0)
{
// *** HOST
if (isset($_SERVER['HTTP_X_ORIGINAL_HOST'])) {
$host = $_SERVER['HTTP_X_ORIGINAL_HOST'];
} else {
$host = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_SERVER['SERVER_NAME']; //WAS SERVER_NAME and caused problems on some boxes
}
// *** PROTOCOL
if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https') {
$_SERVER ['HTTPS'] = 'on';
}
if (isset($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] === 'https') {
$_SERVER ['HTTPS'] = 'on';
}
if (isset($_SERVER['HTTP_CF_VISITOR'])) {
$visitor = json_decode($_SERVER['HTTP_CF_VISITOR']);
if (is_object($visitor) && property_exists($visitor, 'scheme') && $visitor->scheme == 'https') {
$_SERVER ['HTTPS'] = 'on';
}
}
$protocol = 'http' . ((isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) === 'on') ? 's' : '');
if ($requestUri) {
$serverUrlSelf = preg_replace('/\?.*$/', '', $_SERVER['REQUEST_URI']);
} else {
// *** SCRIPT NAME
$serverUrlSelf = $_SERVER['SCRIPT_NAME'];
for ($i = 0; $i < $getParentDirLevel; $i++) {
$serverUrlSelf = preg_match('/^[\\\\\/]?$/', dirname($serverUrlSelf)) ? '' : dirname($serverUrlSelf);
}
}
// *** QUERY STRING
$query = ($queryString && isset($_SERVER['QUERY_STRING']) && strlen($_SERVER['QUERY_STRING']) > 0 ) ? '?' . $_SERVER['QUERY_STRING'] : '';
return $protocol . '://' . $host . $serverUrlSelf . $query;
}
/**
* Get current query string data array
*
* @return string[]
*/
public static function getCurrentQueryURLdata()
{
$result = array();
if (!isset($_SERVER['QUERY_STRING']) || strlen($_SERVER['QUERY_STRING']) == 0) {
return $result;
}
parse_str($_SERVER['QUERY_STRING'], $result);
return $result;
}
/**
* this function is a native PHP parse_url wrapper
* this function returns an associative array with all the keys present and the values = false if they do not exist.
*
* @param string $url <p>The URL to parse. Invalid characters are replaced by <i>_</i>.</p>
* @param int $component if != 1 return specific URL component
*
* @return mixed[]|string|int|null|false <p>On seriously malformed URLs, <b>parse_url()</b> may return <b><code>FALSE</code></b>.</p>
* <p>If the <code>component</code> parameter is omitted, an associative <code>array</code> is returned.
* At least one element will be present within the array. Potential keys within this array are:</p>
* <ul>
* <li> scheme - e.g. http </li>
* <li> host </li>
* <li> port </li>
* <li> user </li>
* <li> pass </li>
* <li> path </li>
* <li> query - after the question mark <i>?</i> </li>
* <li> fragment - after the hashmark <i>#</i> </li>
* </ul>
* <p>If the <code>component</code> parameter is specified,
* <b>parse_url()</b> returns a <code>string</code> (or an <code>integer</code>,
* in the case of <b><code>PHP_URL_PORT</code></b>) instead of an <code>array</code>.
* If the requested component doesn't exist within the given URL, <b><code>NULL</code></b> will be returned.</p>
*/
public static function parseUrl($url, $component = -1)
{
if (preg_match('/^([a-zA-Z0-9]+\:)?\/\//', $url) !== 1) {
// fix invalid URL for only host string ex. 'myhost.com'
$url = '//' . $url;
}
$result = parse_url($url, $component);
if (is_array($result)) {
$result = array_merge(self::$DEF_ARRAY_PARSE_URL, $result);
}
return $result;
}
/**
* Remove scheme from URL
*
* @param string $url source url
* @param bool $removeWww if true remove www
*
* @return string
*/
public static function removeScheme($url, $removeWww = false)
{
$parts = self::parseUrl($url);
unset($parts['scheme']);
$result = self::buildUrl($parts);
if ($removeWww) {
$result = self::wwwRemove($result);
}
return ltrim($result, '/');
}
/**
* this function build a url from array result of parse url.
* if work with both parse_url native function result and snap parseUrl result
*
* @param array<string, mixed> $parts url parts from parseUrl
*
* @return bool|string return false if param isn't array
*/
public static function buildUrl($parts)
{
if (!is_array($parts)) {
return false;
}
$result = '';
$result .= (isset($parts['scheme']) && $parts['scheme'] !== false) ? $parts['scheme'] . ':' : '';
$result .= (
(isset($parts['user']) && $parts['user'] !== false) ||
(isset($parts['host']) && $parts['host'] !== false)) ? '//' : '';
$result .= (isset($parts['user']) && $parts['user'] !== false) ? $parts['user'] : '';
$result .= (isset($parts['pass']) && $parts['pass'] !== false) ? ':' . $parts['pass'] : '';
$result .= (isset($parts['user']) && $parts['user'] !== false) ? '@' : '';
$result .= (isset($parts['host']) && $parts['host'] !== false) ? $parts['host'] : '';
$result .= (isset($parts['port']) && $parts['port'] !== false) ? ':' . $parts['port'] : '';
$result .= (isset($parts['path']) && $parts['path'] !== false) ? $parts['path'] : '';
$result .= (isset($parts['query']) && $parts['query'] !== false) ? '?' . $parts['query'] : '';
$result .= (isset($parts['fragment']) && $parts['fragment'] !== false) ? '#' . $parts['fragment'] : '';
return $result;
}
/**
* Encode alla chars
*
* @param string $url input URL
*
* @return string
*/
public static function urlEncodeAll($url)
{
$hex = unpack('H*', urldecode($url));
return preg_replace('~..~', '%$0', strtoupper($hex[1]));
}
}
|