src/Network/IHTTPRequest.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU APGL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Network;
  23
  24 /**
  25  * Interface for calling HTTP requests and returning their responses
  26  */
  27 interface IHTTPRequest
  28 {
  29         /**
  30          * Fetches the content of an URL
  31          *
  32          * If binary flag is true, return binary results.
  33          * Set the cookiejar argument to a string (e.g. "/tmp/friendica-cookies.txt")
  34          * to preserve cookies from one request to the next.
  35          *
  36          * @param string $url             URL to fetch
  37          *                                TRUE if asked to return binary results (file download)
  38          * @param int    $timeout         Timeout in seconds, default system config value or 60 seconds
  39          * @param string $accept_content  supply Accept: header with 'accept_content' as the value
  40          * @param string $cookiejar       Path to cookie jar file
  41          *
  42          * @return string The fetched content
  43          */
  44         public function fetch(string $url, int $timeout = 0, string $accept_content = '', string $cookiejar = '');
  45
  46         /**
  47          * Fetches the whole response of an URL.
  48          *
  49          * Inner workings and parameters are the same as @ref fetchUrl but returns an array with
  50          * all the information collected during the fetch.
  51          *
  52          * @param string $url             URL to fetch
  53          *                                TRUE if asked to return binary results (file download)
  54          * @param int    $timeout         Timeout in seconds, default system config value or 60 seconds
  55          * @param string $accept_content  supply Accept: header with 'accept_content' as the value
  56          * @param string $cookiejar       Path to cookie jar file
  57          *
  58          * @return CurlResult With all relevant information, 'body' contains the actual fetched content.
  59          */
  60         public function fetchFull(string $url, int $timeout = 0, string $accept_content = '', string $cookiejar = '');
  61
  62         /**
  63          * Send a GET to an URL.
  64          *
  65          * @param string $url        URL to fetch
  66          *                           TRUE if asked to return binary results (file download)
  67          * @param array  $opts       (optional parameters) assoziative array with:
  68          *                           'accept_content' => supply Accept: header with 'accept_content' as the value
  69          *                           'timeout' => int Timeout in seconds, default system config value or 60 seconds
  70          *                           'http_auth' => username:password
  71          *                           'novalidate' => do not validate SSL certs, default is to validate using our CA list
  72          *                           'nobody' => only return the header
  73          *                           'cookiejar' => path to cookie jar file
  74          *                           'header' => header array
  75          *
  76          * @return CurlResult
  77          */
  78         public function get(string $url, array $opts = []);
  79
  80         /**
  81          * Send POST request to an URL
  82          *
  83          * @param string $url     URL to post
  84          * @param mixed  $params  array of POST variables
  85          * @param array  $headers HTTP headers
  86          * @param int    $timeout The timeout in seconds, default system config value or 60 seconds
  87          *
  88          * @return CurlResult The content
  89          */
  90         public function post(string $url, $params, array $headers = [], int $timeout = 0);
  91
  92         /**
  93          * Returns the original URL of the provided URL
  94          *
  95          * This function strips tracking query params and follows redirections, either
  96          * through HTTP code or meta refresh tags. Stops after 10 redirections.
  97          *
  98          * @param string $url       A user-submitted URL
  99          * @param int    $depth     The current redirection recursion level (internal)
 100          * @param bool   $fetchbody Wether to fetch the body or not after the HEAD requests
 101          *
 102          * @return string A canonical URL
 103          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 104          * @see   ParseUrl::getSiteinfo
 105          *
 106          * @todo  Remove the $fetchbody parameter that generates an extraneous HEAD request
 107          */
 108         public function finalUrl(string $url, int $depth = 1, bool $fetchbody = false);
 109
 110         /**
 111          * Returns the current UserAgent as a String
 112          *
 113          * @return string the UserAgent as a String
 114          */
 115         public function getUserAgent();
 116 }