<?php
namespace WP_Statistics\Service\Analytics\Referrals;
use WP_STATISTICS\Helper;
use WP_STATISTICS\Pages;
use WP_STATISTICS\Option;
use WP_Statistics\Utils\Request;
use WP_Statistics\Utils\Url;
class Referrals
{
/**
* Returns the raw referrer URL from the current request.
*
* This function checks if the request is coming from a REST API call and if the 'referred' parameter is set.
* If so, it returns the 'referred' parameter. Otherwise, it returns the value of the 'HTTP_REFERER' server variable.
*
* @return string The raw referrer URL.
*/
public static function getRawUrl()
{
$referrer = $_SERVER['HTTP_REFERER'] ?? '';
if (Helper::is_rest_request() && Request::has('referred')) {
$referrer = Request::get('referred', '', 'raw');
if (Option::get('use_cache_plugin')) {
$referrer = base64_decode($referrer);
}
$referrer = urldecode($referrer);
}
// Return empty string if referrer is internal, otherwise return the referrer
return !Url::isInternal($referrer) ? $referrer : '';
}
/**
* Returns the referrer URL in a standard format.
*
* @param string|bool $referrer Optional referrer URL. By default it will get the referrer value of the current request.
*
* @return string The sanitized referrer URL.
*/
public static function getUrl($referrer = false)
{
// If referrer is not provided get it from the request
$referrer = empty($referrer) ? self::getRawUrl() : $referrer;
// If referrer is empty, or internal, return
if (empty($referrer)) return '';
// Sanitize url
$referrer = sanitize_url($referrer);
// Get protocol
$protocol = Url::getProtocol($referrer);
// For http, and https protocols we only want the domain
if (in_array($protocol, ['https', 'http'])) {
$referrer = Url::getDomain($referrer);
}
return $referrer;
}
/**
* Returns the source channel of the given referrer.
*
* @return SourceDetector
*/
public static function getSource()
{
$referrerUrl = self::getRawUrl();
$pageUrl = Pages::get_page_uri();
return new SourceDetector($referrerUrl, $pageUrl);
}
}