[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Functions that relate to HTTP requests
   5   *
   6   * On functions using the 3rd party library Requests:
   7   * Their goal here is to provide convenient wrapper functions to the Requests library. There are
   8   * 2 types of functions for each METHOD, where METHOD is 'get' or 'post' (implement more as needed)
   9   *     - yourls_http_METHOD() :
  10   *         Return a complete Response object (with ->body, ->headers, ->status_code, etc...) or
  11   *         a simple string (error message)
  12   *     - yourls_http_METHOD_body() :
  13   *         Return a string (response body) or null if there was an error
  14   *
  15   * @since 1.7
  16   */
  17  
  18  use WpOrg\Requests\Requests;
  19  
  20  /**
  21   * Perform a GET request, return response object or error string message
  22   *
  23   * Notable object properties: body, headers, status_code
  24   *
  25   * @since 1.7
  26   * @see yourls_http_request
  27   * @param string $url     URL to request
  28   * @param array $headers  HTTP headers to send
  29   * @param array $data     GET data
  30   * @param array $options  Options to pass to Requests
  31   * @return mixed Response object, or error string
  32   */
  33  function yourls_http_get( $url, $headers = array(), $data = array(), $options = array() ) {
  34      return yourls_http_request( 'GET', $url, $headers, $data, $options );
  35  }
  36  
  37  /**
  38   * Perform a GET request, return body or null if there was an error
  39   *
  40   * @since 1.7
  41   * @see yourls_http_request
  42   * @param string $url     URL to request
  43   * @param array $headers  HTTP headers to send
  44   * @param array $data     GET data
  45   * @param array $options  Options to pass to Requests
  46   * @return mixed String (page body) or null if error
  47   */
  48  function yourls_http_get_body( $url, $headers = array(), $data = array(), $options = array() ) {
  49      $return = yourls_http_get( $url, $headers, $data, $options );
  50      return isset( $return->body ) ? $return->body : null;
  51  }
  52  
  53  /**
  54   * Perform a POST request, return response object
  55   *
  56   * Notable object properties: body, headers, status_code
  57   *
  58   * @since 1.7
  59   * @see yourls_http_request
  60   * @param string $url     URL to request
  61   * @param array $headers  HTTP headers to send
  62   * @param array $data     POST data
  63   * @param array $options  Options to pass to Requests
  64   * @return mixed Response object, or error string
  65   */
  66  function yourls_http_post( $url, $headers = array(), $data = array(), $options = array() ) {
  67      return yourls_http_request( 'POST', $url, $headers, $data, $options );
  68  }
  69  
  70  /**
  71   * Perform a POST request, return body
  72   *
  73   * Wrapper for yourls_http_request()
  74   *
  75   * @since 1.7
  76   * @see yourls_http_request
  77   * @param string $url     URL to request
  78   * @param array $headers  HTTP headers to send
  79   * @param array $data     POST data
  80   * @param array $options  Options to pass to Requests
  81   * @return mixed String (page body) or null if error
  82   */
  83  function yourls_http_post_body( $url, $headers = array(), $data = array(), $options = array() ) {
  84      $return = yourls_http_post( $url, $headers, $data, $options );
  85      return isset( $return->body ) ? $return->body : null;
  86  }
  87  
  88  /**
  89   * Get proxy information
  90   *
  91   * @since 1.7.1
  92   * @return mixed false if no proxy is defined, or string like '10.0.0.201:3128' or array like ('10.0.0.201:3128', 'username', 'password')
  93   */
  94  function yourls_http_get_proxy() {
  95      $proxy = false;
  96  
  97      if( defined( 'YOURLS_PROXY' ) ) {
  98          $proxy = YOURLS_PROXY;
  99          if( defined( 'YOURLS_PROXY_USERNAME' ) && defined( 'YOURLS_PROXY_PASSWORD' ) ) {
 100              $proxy = array( YOURLS_PROXY, YOURLS_PROXY_USERNAME, YOURLS_PROXY_PASSWORD );
 101          }
 102      }
 103  
 104      return yourls_apply_filter( 'http_get_proxy', $proxy );
 105  }
 106  
 107  /**
 108   * Get list of hosts that should bypass the proxy
 109   *
 110   * @since 1.7.1
 111   * @return mixed false if no host defined, or string like "example.com, *.mycorp.com"
 112   */
 113  function yourls_http_get_proxy_bypass_host() {
 114      $hosts = defined( 'YOURLS_PROXY_BYPASS_HOSTS' ) ? YOURLS_PROXY_BYPASS_HOSTS : false;
 115  
 116      return yourls_apply_filter( 'http_get_proxy_bypass_host', $hosts );
 117  }
 118  
 119  /**
 120   * Default HTTP requests options for YOURLS
 121   *
 122   * For a list of all available options, see function request() in /includes/Requests/Requests.php
 123   *
 124   * @since 1.7
 125   * @return array Options
 126   */
 127  function yourls_http_default_options() {
 128      $options = array(
 129          'timeout'          => yourls_apply_filter( 'http_default_options_timeout', 3 ),
 130          'useragent'        => yourls_http_user_agent(),
 131          'follow_redirects' => true,
 132          'redirects'        => 3,
 133      );
 134  
 135      if( yourls_http_get_proxy() ) {
 136          $options['proxy'] = yourls_http_get_proxy();
 137      }
 138  
 139      return yourls_apply_filter( 'http_default_options', $options );
 140  }
 141  
 142  /**
 143   * Whether URL should be sent through the proxy server.
 144   *
 145   * Concept stolen from WordPress. The idea is to allow some URLs, including localhost and the YOURLS install itself,
 146   * to be requested directly and bypassing any defined proxy.
 147   *
 148   * @since 1.7
 149   * @param string $url URL to check
 150   * @return bool true to request through proxy, false to request directly
 151   */
 152  function yourls_send_through_proxy( $url ) {
 153  
 154      // Allow plugins to short-circuit the whole function
 155      $pre = yourls_apply_filter( 'shunt_send_through_proxy', yourls_shunt_default(), $url );
 156      if ( yourls_shunt_default() !== $pre ) {
 157          return $pre;
 158      }
 159  
 160      $check = @parse_url( $url );
 161  
 162      if( !isset( $check['host'] ) ) {
 163          return false;
 164      }
 165  
 166      // Malformed URL, can not process, but this could mean ssl, so let through anyway.
 167      if ( $check === false )
 168          return true;
 169  
 170      // Self and loopback URLs are considered local (':' is parse_url() host on '::1')
 171      $home = parse_url( yourls_get_yourls_site() );
 172      $local = array( 'localhost', '127.0.0.1', '127.1', '[::1]', ':', $home['host'] );
 173  
 174      if( in_array( $check['host'], $local ) )
 175          return false;
 176  
 177      $bypass = yourls_http_get_proxy_bypass_host();
 178  
 179      if( $bypass === false OR $bypass === '' ) {
 180          return true;
 181      }
 182  
 183      // Build array of hosts to bypass
 184      static $bypass_hosts;
 185      static $wildcard_regex = false;
 186      if ( null == $bypass_hosts ) {
 187          $bypass_hosts = preg_split( '|\s*,\s*|', $bypass );
 188  
 189          if ( false !== strpos( $bypass, '*' ) ) {
 190              $wildcard_regex = array();
 191              foreach ( $bypass_hosts as $host ) {
 192                  $wildcard_regex[] = str_replace( '\*', '.+', preg_quote( $host, '/' ) );
 193                  if ( false !== strpos( $host, '*' ) ) {
 194                      $wildcard_regex[] = str_replace( '\*\.', '', preg_quote( $host, '/' ) );
 195                  }
 196              }
 197              $wildcard_regex = '/^(' . implode( '|', $wildcard_regex ) . ')$/i';
 198          }
 199      }
 200  
 201      if ( !empty( $wildcard_regex ) )
 202          return !preg_match( $wildcard_regex, $check['host'] );
 203      else
 204          return !in_array( $check['host'], $bypass_hosts );
 205  }
 206  
 207  /**
 208   * Perform a HTTP request, return response object
 209   *
 210   * @since 1.7
 211   * @param string $type HTTP request type (GET, POST)
 212   * @param string $url URL to request
 213   * @param array $headers Extra headers to send with the request
 214   * @param array $data Data to send either as a query string for GET requests, or in the body for POST requests
 215   * @param array $options Options for the request (see /includes/Requests/Requests.php:request())
 216   * @return object WpOrg\Requests\Response object
 217   */
 218  function yourls_http_request( $type, $url, $headers, $data, $options ) {
 219  
 220      // Allow plugins to short-circuit the whole function
 221      $pre = yourls_apply_filter( 'shunt_yourls_http_request', yourls_shunt_default(), $type, $url, $headers, $data, $options );
 222      if ( yourls_shunt_default() !== $pre ) {
 223          return $pre;
 224      }
 225  
 226      $options = array_merge( yourls_http_default_options(), $options );
 227  
 228      if( yourls_http_get_proxy() && !yourls_send_through_proxy( $url ) ) {
 229          unset( $options['proxy'] );
 230      }
 231  
 232      // filter everything
 233      $type    = yourls_apply_filter('http_request_type', $type);
 234      $url     = yourls_apply_filter('http_request_url', $url);
 235      $headers = yourls_apply_filter('http_request_headers', $headers);
 236      $data    = yourls_apply_filter('http_request_data', $data);
 237      $options = yourls_apply_filter('http_request_options', $options);
 238  
 239      try {
 240          $result = Requests::request( $url, $headers, $data, $type, $options );
 241      } catch( \WpOrg\Requests\Exception $e ) {
 242          $result = yourls_debug_log( $e->getMessage() . ' (' . $type . ' on ' . $url . ')' );
 243      };
 244  
 245      return $result;
 246  }
 247  
 248  /**
 249   * Return funky user agent string
 250   *
 251   * @since 1.5
 252   * @return string UA string
 253   */
 254  function yourls_http_user_agent() {
 255      return yourls_apply_filter( 'http_user_agent', 'YOURLS v'.YOURLS_VERSION.' +http://yourls.org/ (running on '.yourls_get_yourls_site().')' );
 256  }
 257  
 258  /**
 259   * Check api.yourls.org if there's a newer version of YOURLS
 260   *
 261   * This function collects various stats to help us improve YOURLS. See the blog post about it:
 262   * http://blog.yourls.org/2014/01/on-yourls-1-7-and-api-yourls-org/
 263   * Results of requests sent to api.yourls.org are stored in option 'core_version_checks' and is an object
 264   * with the following properties:
 265   *    - failed_attempts : number of consecutive failed attempts
 266   *    - last_attempt    : time() of last attempt
 267   *    - last_result     : content retrieved from api.yourls.org during previous check
 268   *    - version_checked : installed YOURLS version that was last checked
 269   *
 270   * @since 1.7
 271   * @return mixed JSON data if api.yourls.org successfully requested, false otherwise
 272   */
 273  function yourls_check_core_version() {
 274  
 275      global $yourls_user_passwords;
 276  
 277      $checks = yourls_get_option( 'core_version_checks' );
 278  
 279      // Invalidate check data when YOURLS version changes
 280      if ( is_object( $checks ) && YOURLS_VERSION != $checks->version_checked ) {
 281          $checks = false;
 282      }
 283  
 284      if( !is_object( $checks ) ) {
 285          $checks = new stdClass;
 286          $checks->failed_attempts = 0;
 287          $checks->last_attempt    = 0;
 288          $checks->last_result     = '';
 289          $checks->version_checked = YOURLS_VERSION;
 290      }
 291  
 292      // Total number of links and clicks
 293      list( $total_urls, $total_clicks ) = array_values(yourls_get_db_stats());
 294  
 295      // The collection of stuff to report
 296      $stuff = array(
 297          // Globally uniquish site identifier
 298          // This uses const YOURLS_SITE and not yourls_get_yourls_site() to prevent creating another id for an already known install
 299          'md5'                => md5( YOURLS_SITE . YOURLS_ABSPATH ),
 300  
 301          // Install information
 302          'failed_attempts'    => $checks->failed_attempts,
 303          'yourls_site'        => defined( 'YOURLS_SITE' ) ? yourls_get_yourls_site() : 'unknown',
 304          'yourls_version'     => defined( 'YOURLS_VERSION' ) ? YOURLS_VERSION : 'unknown',
 305          'php_version'        => PHP_VERSION,
 306          'mysql_version'      => yourls_get_db('read-check_core_version')->mysql_version(),
 307          'locale'             => yourls_get_locale(),
 308  
 309          // custom DB driver if any, and useful common PHP extensions
 310          'db_driver'          => defined( 'YOURLS_DB_DRIVER' ) ? YOURLS_DB_DRIVER : 'unset',
 311          'db_ext_pdo'         => extension_loaded( 'PDO' )     ? 1 : 0,
 312          'db_ext_mysql'       => extension_loaded( 'mysql' )   ? 1 : 0,
 313          'db_ext_mysqli'      => extension_loaded( 'mysqli' )  ? 1 : 0,
 314          'ext_curl'           => extension_loaded( 'curl' )    ? 1 : 0,
 315  
 316          // Config information
 317          'yourls_private'     => defined( 'YOURLS_PRIVATE' ) && YOURLS_PRIVATE ? 1 : 0,
 318          'yourls_unique'      => defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS ? 1 : 0,
 319          'yourls_url_convert' => defined( 'YOURLS_URL_CONVERT' ) ? YOURLS_URL_CONVERT : 'unknown',
 320  
 321          // Usage information
 322          'num_users'          => count( $yourls_user_passwords ),
 323          'num_active_plugins' => yourls_has_active_plugins(),
 324          'num_pages'          => defined( 'YOURLS_PAGEDIR' ) ? count( (array) glob( YOURLS_PAGEDIR .'/*.php') ) : 0,
 325          'num_links'          => $total_urls,
 326          'num_clicks'         => $total_clicks,
 327      );
 328  
 329      $stuff = yourls_apply_filter( 'version_check_stuff', $stuff );
 330  
 331      // Send it in
 332      $url = 'http://api.yourls.org/core/version/1.1/';
 333      if( yourls_can_http_over_ssl() ) {
 334          $url = yourls_set_url_scheme($url, 'https');
 335      }
 336      $req = yourls_http_post( $url, array(), $stuff );
 337  
 338      $checks->last_attempt = time();
 339      $checks->version_checked = YOURLS_VERSION;
 340  
 341      // Unexpected results ?
 342      if( is_string( $req ) or !$req->success ) {
 343          $checks->failed_attempts = $checks->failed_attempts + 1;
 344          yourls_update_option( 'core_version_checks', $checks );
 345          if( is_string($req) ) {
 346              yourls_debug_log('Version check failed: ' . $req);
 347          }
 348          return false;
 349      }
 350  
 351      // Parse response
 352      $json = json_decode( trim( $req->body ) );
 353  
 354      if( yourls_validate_core_version_response($json) ) {
 355          // All went OK - mark this down
 356          $checks->failed_attempts = 0;
 357          $checks->last_result     = $json;
 358          yourls_update_option( 'core_version_checks', $checks );
 359  
 360          return $json;
 361      }
 362  
 363      // Request returned actual result, but not what we expected
 364      return false;
 365  }
 366  
 367  /**
 368   *  Make sure response from api.yourls.org is valid
 369   *
 370   *  1) we should get a json object with two following properties:
 371   *    'latest' => a string representing a YOURLS version number, eg '1.2.3'
 372   *    'zipurl' => a string for a zip package URL, from github, eg 'https://api.github.com/repos/YOURLS/YOURLS/zipball/1.2.3'
 373   *  2) 'latest' and version extracted from 'zipurl' should match
 374   *  3) the object should not contain any other key
 375   *
 376   *  @since 1.7.7
 377   *  @param object $json  JSON object to check
 378   *  @return bool   true if seems legit, false otherwise
 379   */
 380  function yourls_validate_core_version_response($json) {
 381      return (
 382          yourls_validate_core_version_response_keys($json)
 383       && $json->latest === yourls_sanitize_version($json->latest)
 384       && $json->zipurl === yourls_sanitize_url($json->zipurl)
 385       && $json->latest === yourls_get_version_from_zipball_url($json->zipurl)
 386       && yourls_is_valid_github_repo_url($json->zipurl)
 387      );
 388  }
 389  
 390  /**
 391   * Get version number from Github zipball URL (last part of URL, really)
 392   *
 393   * @since 1.8.3
 394   * @param string $zipurl eg 'https://api.github.com/repos/YOURLS/YOURLS/zipball/1.2.3'
 395   * @return string
 396   */
 397  function yourls_get_version_from_zipball_url($zipurl) {
 398      $version = '';
 399      $parts = explode('/', parse_url(yourls_sanitize_url($zipurl), PHP_URL_PATH) ?? '');
 400      // expect at least 1 slash in path, return last part
 401      if( count($parts) > 1 ) {
 402          $version = end($parts);
 403      }
 404      return $version;
 405  }
 406  
 407  /**
 408   * Check if URL is from YOURLS/YOURLS repo on github
 409   *
 410   * @since 1.8.3
 411   * @param string $url  URL to check
 412   * @return bool
 413   */
 414  function yourls_is_valid_github_repo_url($url) {
 415      $url = yourls_sanitize_url($url);
 416      return (
 417          join('.',array_slice(explode('.', parse_url($url, PHP_URL_HOST) ?? ''), -2, 2)) === 'github.com'
 418              // explodes on '.' (['api','github','com']) and keeps the last two elements
 419              // to make sure domain is either github.com or one of its subdomain (api.github.com for instance)
 420              // TODO: keep an eye on Github API to make sure it doesn't change some day to another domain (githubapi.com, ...)
 421          && substr( parse_url($url, PHP_URL_PATH), 0, 21 ) === '/repos/YOURLS/YOURLS/'
 422              // make sure path starts with '/repos/YOURLS/YOURLS/'
 423      );
 424  }
 425  
 426  /**
 427   * Check if object has only expected keys 'latest' and 'zipurl' containing strings
 428   *
 429   * @since 1.8.3
 430   * @param object $json
 431   * @return bool
 432   */
 433  function yourls_validate_core_version_response_keys($json) {
 434      $keys = array('latest', 'zipurl');
 435      return (
 436          count(array_diff(array_keys((array)$json), $keys)) === 0
 437          && isset($json->latest)
 438          && isset($json->zipurl)
 439          && is_string($json->latest)
 440          && is_string($json->zipurl)
 441      );
 442  }
 443  
 444  /**
 445   * Determine if we want to check for a newer YOURLS version (and check if applicable)
 446   *
 447   * Currently checks are performed every 24h and only when someone is visiting an admin page.
 448   * In the future (1.8?) maybe check with cronjob emulation instead.
 449   *
 450   * @since 1.7
 451   * @return bool true if a check was needed and successfully performed, false otherwise
 452   */
 453  function yourls_maybe_check_core_version() {
 454      // Allow plugins to short-circuit the whole function
 455      $pre = yourls_apply_filter( 'shunt_maybe_check_core_version', yourls_shunt_default() );
 456      if ( yourls_shunt_default() !== $pre ) {
 457          return $pre;
 458      }
 459  
 460      if (yourls_skip_version_check()) {
 461          return false;
 462      }
 463  
 464      if (!yourls_is_admin()) {
 465          return false;
 466      }
 467  
 468      $checks = yourls_get_option( 'core_version_checks' );
 469  
 470      /* We don't want to check if :
 471       - last_result is set (a previous check was performed)
 472       - and it was less than 24h ago (or less than 2h ago if it wasn't successful)
 473       - and version checked matched version running
 474       Otherwise, we want to check.
 475      */
 476      if( !empty( $checks->last_result )
 477          AND
 478          (
 479              ( $checks->failed_attempts == 0 && ( ( time() - $checks->last_attempt ) < 24 * 3600 ) )
 480              OR
 481              ( $checks->failed_attempts > 0  && ( ( time() - $checks->last_attempt ) <  2 * 3600 ) )
 482          )
 483          AND ( $checks->version_checked == YOURLS_VERSION )
 484      )
 485          return false;
 486  
 487      // We want to check if there's a new version
 488      $new_check = yourls_check_core_version();
 489  
 490      // Could not check for a new version, and we don't have ancient data
 491      if( false == $new_check && !isset( $checks->last_result->latest ) )
 492          return false;
 493  
 494      return true;
 495  }
 496  
 497  /**
 498   * Check if user setting for skipping version check is set
 499   *
 500   * @since 1.8.2
 501   * @return bool
 502   */
 503  function yourls_skip_version_check() {
 504      return yourls_apply_filter('skip_version_check', defined('YOURLS_NO_VERSION_CHECK') && YOURLS_NO_VERSION_CHECK);
 505  }
 506  
 507  /**
 508   * Check if server can perform HTTPS requests, return bool
 509   *
 510   * @since 1.7.1
 511   * @return bool whether the server can perform HTTP requests over SSL
 512   */
 513  function yourls_can_http_over_ssl() {
 514      $ssl_curl = $ssl_socket = false;
 515  
 516      if( function_exists( 'curl_exec' ) ) {
 517          $curl_version  = curl_version();
 518          $ssl_curl = ( $curl_version['features'] & CURL_VERSION_SSL );
 519      }
 520  
 521      if( function_exists( 'stream_socket_client' ) ) {
 522          $ssl_socket = extension_loaded( 'openssl' ) && function_exists( 'openssl_x509_parse' );
 523      }
 524  
 525      return ( $ssl_curl OR $ssl_socket );
 526  }