Http.php

Go to the documentation of this file.

<?php

namespace Rsi;

/**
 *  HTTP request helpers.
 */
class Http{

  /**
   * Document root.
   * @return string  Document root without trailing delimiter.
   */
  public static function docRoot(){
    static $root = null;
    if($root === null){
      $root = $_SERVER['DOCUMENT_ROOT'] ?? null;
      if(!$root && ($filename = $_SERVER['SCRIPT_FILENAME'] ?? null))
        $root = str_replace('\\','/',\substr($filename,0,-strlen($_SERVER['PHP_SELF'] ?? null)));
      if(!$root && ($path = $_SERVER['PATH_TRANSLATED'] ?? null))
        $root = str_replace(['\\','\\\\'],'/',substr($path,0,-strlen($_SERVER['PHP_SELF'] ?? null)));
      $root = rtrim($root,'/');
    }
    return $root;
  }
  /**
   * Protocol version.
   * @return float  Protocol version (false if unknown).
   */
  public static function version(){
    static $version = null;
    if($version === null) $version = ($protocol = $_SERVER['SERVER_PROTOCOL']) && ($i = strpos($protocol,'/'))
      ? (float)substr($protocol,$i + 1)
      : false;
    return $version;
  }
  /**
   * Request method.
   * @return string  Requested method, in uppercase.
   */
  public static function method(){
    return strtoupper(preg_replace('/\\W+/','',$_SERVER['REQUEST_METHOD'] ?? null));
  }
  /**
   * Check if the request was made over a secure connection.
   * @return bool  True if the request was made over a secure connection.
   */
  public static function secure(){
    return !strcasecmp($_SERVER['HTTPS'] ?? null,'on');
  }
  /**
   * Host name.
   * @param bool $complete  Include protocol and port number.
   * @return string
   */
  public static function host($complete = false){
    $host = ($_SERVER['SERVER_NAME'] ?? null) ?: gethostname();
    if($complete){
      $host = (($secure = self::secure()) ? 'https' : 'http') . '://' . $host;
      if(($port = $_SERVER['SERVER_PORT'] ?? null) && ($port != ($secure ? 443 : 80))) $host .= ':' . $port;
    }
    return $host;
  }
  /**
   * Translate a HTTP response code to a description.
   * @param int $code  HTTP response code.
   * @return string  Description (null if not found).
   */
  public static function codeDescr($code){
    return array_key_exists($code,$codes = require(__DIR__ . '/../../data/httpcode.php')) ? $codes[$code] : null;
  }
  /**
   * Make sure a URL starts with a protocol. Add one if not present.
   * @param string $url  Base URL.
   * @param string $protocol  Protocol to add if none present.
   * @return string  URL with protocol.
   */
  public static function ensureProtocol($url,$protocol = 'http'){
    return strpos($url,'://') ? $url : $protocol . ':' . (substr($url,0,2) == '//' ? '' : '//') . $url;
  }
  /**
   * Remove double dots from a URL.
   * @param string $url  Base URL.
   * @return string  URL with double dots removed (including the directory before it).
   */
  public static function realUrl($url){
    do $url = preg_replace('/\/[^\/]*\/\.\.\//','/',$url,-1,$count);
    while($count);
    return $url;
  }
  /**
   * Add parameters to a URL.
   * @param string $url  Base URL.
   * @param mixed $params  Array will beconverted to string.
   * @return string  URL with parameters added.
   */
  public static function addParams($url,$params){
    $hash = null;
    if(($i = strpos($url,'#')) !== false){
      $hash = substr($url,$i);
      $url = substr($url,0,$i);
    }
    return $url . (parse_url($url,PHP_URL_QUERY) ? '&' : '?') . (is_array($params) ? http_build_query($params) : $params) . $hash;
  }
  /**
   * Check if the maximum POST size was exceeded.
   * @param int $size  Size of POST.
   * @param int $max  Maximum size.
   * @return bool
   */
  public static function postExceeded(&$size = null,&$max = null){
    $size = $max = null;
    return
      !$_POST &&
      !$_FILES &&
      ($size = $_SERVER['CONTENT_LENGTH'] ?? null) &&
      ($max = \Rsi\Number::shorthandBytes(ini_get('post_max_size'),false)) &&
      ($size > $max);
  }
  /**
   * Set a cookie.
   * The cookie is also directly added to the global $_COOKIE array.
   * @param string $key  Cookie key.
   * @param mixed $value  Cookie value.
   * @param int $days  Cookie lifetime (in days).
   * @param array $options  Cookie options (see https://www.php.net/setcookie; when 'secure' is undefined, the value is
   *   automaticly set to true when the request was made using a secure connection).
   * @return bool  True when successful.
   */
  public static function setCookie($key,$value,$days = 365,$options = null){
    $_COOKIE[$key] = $value;
    $options = ($options ?: []) +
      ['expires' => $days ? time() + $days * 86400 : 0,'path' => '/','domain' => '','httponly' => true];
    if(!array_key_exists('secure',$options)) $options['secure'] = self::secure();
    return \Rsi::version('7.3.0')
      ? setcookie($key,$value,$options)
      : setcookie($key,$value,$options['expires'],$options['path'],$options['domain'],$options['secure'],$options['httponly']);
  }
  /**
   * Retrieve a cookie.
   * @param string $key  Cookie key.
   * @param mixed $default  Default value if the key does not exist.
   * @return mixed  Found value, or default value if the key does not exist.
   */
  public static function getCookie($key,$default = null){
    return Record::get($_COOKIE,$key,$default);
  }
  /**
   * Get the prefered language from the client.
   * @param array $accepted  Accepted languages (with or without locale; empty = all).
   * @param float $quality  Minimal quality a language must have.
   * @return string  Language preference (empty = none found).
   */
  public static function lang($accepted = null,$quality = 0){
    $lang = null;
    if(preg_match_all(
      '/([a-z]{1,8})(-[a-z]{1,8})?\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i',
      $_SERVER['HTTP_ACCEPT_LANGUAGE'] ?? null,
      $client_accepted,
      PREG_SET_ORDER
    )) foreach($client_accepted as $client_accept){
      $client_lang = $client_accept[1] . ($client_accept[2] ?? null);
      if(
        (!$accepted || in_array($client_lang,$accepted) || in_array($client_lang = $client_accept[1],$accepted)) &&
        (($client_quality = Record::get($client_accept,4,1)) > $quality)
      ){
        $lang = $client_lang;
        $quality = $client_quality;
      }
    }
    return $lang;
  }
  /**
   * Expand an abbreviated IPv6 address to its full representation.
   * @param string $addr  Basic address.
   * @return string  Expanded address (IPv4 addresses are untouched).
   */
  public static function expandAddr($addr){
    if(count($groups = explode(':',$addr)) > 1){
      $addr = [];
      foreach($groups as $index => $group) if(!$index || ($group !== '')) $addr[] = Str::pad($group,4);
      else $addr = array_merge($addr,array_fill(0,9 - count($groups),'0000'));
      $addr = implode(':',$addr);
    }
    return $addr;
  }
  /**
   * Returns the expanded, remote address (if available).
   * @return string
   */
  public static function remoteAddr(){
    static $remote_addr = null;
    if($remote_addr === null) $remote_addr = self::expandAddr($_SERVER['REMOTE_ADDR'] ?? null);
    return $remote_addr;
  }
  /**
   * Check if an IP-adres lies within a certain subnet.
   * @param string|array $subnets  One or more subnet(s) in CIDR notation (e.g. 127.0.0.0/24).
   * @param string $remote_addr  The IP-address to check (defaults to remoteAddr()).
   * @return bool
   */
  public static function inSubnet($subnets,$remote_addr = null){
    foreach((array)$subnets as $subnet) switch(count($cidr = explode('/',$subnet))){
      case 1:
        $cidr = [$subnet,strlen(inet_pton($subnet)) << 3];
      case 2:
        if(strlen($ip = bin2hex(inet_pton($remote_addr ?: self::remoteAddr()))) == strlen($subnet = bin2hex(inet_pton($cidr[0])))){
          $nibbles = $cidr[1] >> 2;
          if((substr($ip,0,$nibbles) == substr($subnet,0,$nibbles)) && (
            ($nibbles == strlen($ip)) ||
            !($mask = (0xf0 >> ($cidr[1] - ($nibbles << 2)) & 0xf)) ||
            ((hexdec($ip[$nibbles]) & $mask) == (hexdec($subnet[$nibbles]) & $mask))
          )) return true;
        }
    }
    return false;
  }
  /**
   * Add a redirection header.
   * @param string $url  URL to redirect to.
   * @param bool $permanent  True to make the redirection permanent (HTTP code 301; defaul is 302).
   */
  public static function redirHeader($url,$permanent = false){
    header('Location: ' . $url,true,$permanent ? 301 : 302);
  }
  /**
   * Add a push header.
   * @param string $src  Location of the resource.
   * @param string $type  Type of the resource.
   * @return bool  True if push is supported and the header is set, false otherwise.
   */
  public static function pushHeader($src,$type){
    if($push = self::version() >= 2) header("Link: <$src>; rel=preload; as=$type",false);
    return $push;
  }
  /**
   * Send download headers.
   * @param string $filename  Filename of the attached file.
   * @param string $content_type  Content type (defaults to 'application/' + extension of filename).
   * @param int $size  Size of the download (gives user progress indication).
   */
  public static function downloadHeaders($filename,$content_type = null,$size = null){
    header('Content-Type: ' . ($content_type ?: File::mime($filename)));
    header('Content-Transfer-Encoding: binary');
    header('Content-Disposition: attachment; filename="' . basename($filename) . '"');
    if(($size !== null) || is_file($filename)) header('Content-Length: ' . ($size === null ? filesize($filename) : $size));
    header('Expires: 0');
    header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); //HTTP/1.1
    header('Pragma: public'); //HTTP/1.0
  }
  /**
   * Get content from URL.
   * @param string $url  URL to make request to.
   * @param array $post  Data to post with request (key =&gt; value pairs).
   * @param array $headers  Extra HTTP headers to add to request (key = header name, value = header value).
   * @param array $options  Extra cURL options (key = option name, value = option value).
   * @param int $timeout  Request timeout in seconds.
   * @param int $max_redirs  Maximum number of redirections to follow.
   * @return mixed  Response text if susccessful (200) or false if not found (404). Exceptions thrown on cURL error or other
   *   response codes.
   */
  public static function urlGetContents($url,$post = null,$headers = null,$options = null,$timeout = null,$max_redirs = null){
    $ch = curl_init($url);
    curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);
    if($post){
      curl_setopt($ch,CURLOPT_POST,true);
      curl_setopt($ch,CURLOPT_POSTFIELDS,$post);
    }
    if($headers){
      foreach($headers as $key => &$value) $value = $key . ': ' . $value;
      unset($value);
      curl_setopt($ch,CURLOPT_HTTPHEADER,$headers);
    }
    if($options) curl_setopt_array($ch,$options);
    curl_setopt($ch,CURLOPT_TIMEOUT,$timeout ?: ini_get('default_socket_timeout'));
    if($max_redirs){
      curl_setopt($ch,CURLOPT_FOLLOWLOCATION,true);
      curl_setopt($ch,CURLOPT_MAXREDIRS,$max_redirs);
    }
    $result = curl_exec($ch);
    $message = ($error = curl_errno($ch)) ? curl_error($ch) : null;
    $code = curl_getinfo($ch,CURLINFO_HTTP_CODE);
    curl_close($ch);
    if($error) throw new \Exception("cURL error: $message ($error)");
    switch($code){
      case 200: return $result;
      case 404: return false;
      default: throw new \Exception("unexpected response ($code): $result");
    }
  }

}