includes/functions-http.php

   1 <?php
   2 /**
   3  * Functions that relate to HTTP requests
   4  *
   5  */
   6
   7 /**
   8  * On functions using the 3rd party library Requests:
   9  *
  10  * The goal here is to provide convenient wrapper functions to the Requests library. There are
  11  * 2 types of functions for each METHOD, where METHOD is 'get' or 'post' (implement more as needed)
  12  *     - yourls_http_METHOD() :
  13  *         Return a complete Response object (with ->body, ->headers, ->status_code, etc...) or
  14  *         a simple string (error message)
  15  *     - yourls_http_METHOD_body() :
  16  *         Return a string (response body) or null if there was an error
  17  *
  18  * @since 1.7
  19  */
  20
  21 /**
  22  * Perform a GET request, return response object or error string message
  23  *
  24  * Notable object properties: body, headers, status_code
  25  *
  26  * @since 1.7
  27  * @see yourls_http_request
  28  * @return mixed Response object, or error string
  29  */
  30 function yourls_http_get( $url, $headers = array(), $data = array(), $options = array() ) {
  31         return yourls_http_request( 'GET', $url, $headers, $data, $options );
  32 }
  33
  34 /**
  35  * Perform a GET request, return body or null if there was an error
  36  *
  37  * @since 1.7
  38  * @see yourls_http_request
  39  * @return mixed String (page body) or null if error
  40  */
  41 function yourls_http_get_body( $url, $headers = array(), $data = array(), $options = array() ) {
  42         $return = yourls_http_get( $url, $headers, $data, $options );
  43         return isset( $return->body ) ? $return->body : null;
  44 }
  45
  46 /**
  47  * Perform a POST request, return response object
  48  *
  49  * Notable object properties: body, headers, status_code
  50  *
  51  * @since 1.7
  52  * @see yourls_http_request
  53  * @return mixed Response object, or error string
  54  */
  55 function yourls_http_post( $url, $headers = array(), $data = array(), $options = array() ) {
  56         return yourls_http_request( 'POST', $url, $headers, $data, $options );
  57 }
  58
  59 /**
  60  * Perform a POST request, return body
  61  *
  62  * Wrapper for yourls_http_request()
  63  *
  64  * @since 1.7
  65  * @see yourls_http_request
  66  * @return mixed String (page body) or null if error
  67  */
  68 function yourls_http_post_body( $url, $headers = array(), $data = array(), $options = array() ) {
  69         $return = yourls_http_post( $url, $headers, $data, $options );
  70         return isset( $return->body ) ? $return->body : null;
  71 }
  72
  73 /**
  74  * Default HTTP requests options for YOURLS
  75  *
  76  * For a list of all available options, see function request() in /includes/Requests/Requests.php
  77  *
  78  * @uses YOURLS_PROXY
  79  * @uses YOURLS_PROXY_USERNAME
  80  * @uses YOURLS_PROXY_PASSWORD
  81  * @since 1.7
  82  * @return array Options
  83  */
  84 function yourls_http_default_options() {
  85         $options = array(
  86                 'timeout'          => yourls_apply_filter( 'http_default_options_timeout', 3 ),
  87                 'useragent'        => yourls_http_user_agent(),
  88                 'follow_redirects' => true,
  89                 'redirects'        => 3,
  90         );
  91
  92         if( defined( 'YOURLS_PROXY' ) ) {
  93                 if( defined( 'YOURLS_PROXY_USERNAME' ) && defined( 'YOURLS_PROXY_PASSWORD' ) ) {
  94                         $options['proxy'] = array( YOURLS_PROXY, YOURLS_PROXY_USERNAME, YOURLS_PROXY_PASSWORD );
  95                 } else {
  96                         $options['proxy'] = YOURLS_PROXY;
  97                 }
  98         }
  99
 100         return yourls_apply_filter( 'http_default_options', $options );
 101 }
 102
 103 /**
 104  * Whether URL should be sent through the proxy server.
 105  *
 106  * Concept stolen from WordPress. The idea is to allow some URLs, including localhost and the YOURLS install itself,
 107  * to be requested directly and bypassing any defined proxy.
 108  *
 109  * @uses YOURLS_PROXY
 110  * @uses YOURLS_PROXY_BYPASS_HOSTS
 111  * @since 1.7
 112  * @param string $url URL to check
 113  * @return bool true to request through proxy, false to request directly
 114  */
 115 function yourls_send_through_proxy( $url ) {
 116
 117         // Allow plugins to short-circuit the whole function
 118         $pre = yourls_apply_filter( 'shunt_send_through_proxy', null, $url );
 119         if ( null !== $pre )
 120                 return $pre;
 121
 122         $check = @parse_url( $url );
 123
 124         // Malformed URL, can not process, but this could mean ssl, so let through anyway.
 125         if ( $check === false )
 126                 return true;
 127
 128         // Self and loopback URLs are considered local (':' is parse_url() host on '::1')
 129         $home = parse_url( YOURLS_SITE );
 130         $local = array( 'localhost', '127.0.0.1', '127.1', '[::1]', ':', $home['host'] );
 131
 132         if( in_array( $check['host'], $local ) )
 133                 return false;
 134
 135         if ( !defined( 'YOURLS_PROXY_BYPASS_HOSTS' ) )
 136                 return true;
 137
 138         // Check YOURLS_PROXY_BYPASS_HOSTS
 139         static $bypass_hosts;
 140         static $wildcard_regex = false;
 141         if ( null == $bypass_hosts ) {
 142                         $bypass_hosts = preg_split( '|,\s*|', YOURLS_PROXY_BYPASS_HOSTS );
 143
 144                         if ( false !== strpos( YOURLS_PROXY_BYPASS_HOSTS, '*' ) ) {
 145                                         $wildcard_regex = array();
 146                                         foreach ( $bypass_hosts as $host )
 147                                                         $wildcard_regex[] = str_replace( '\*', '.+', preg_quote( $host, '/' ) );
 148                                         $wildcard_regex = '/^(' . implode( '|', $wildcard_regex ) . ')$/i';
 149                         }
 150         }
 151
 152         if ( !empty( $wildcard_regex ) )
 153                 return !preg_match( $wildcard_regex, $check['host'] );
 154         else
 155                 return !in_array( $check['host'], $bypass_hosts );
 156 }
 157
 158 /**
 159  * Perform a HTTP request, return response object
 160  *
 161  * @since 1.7
 162  * @param string $var Stuff
 163  * @return string Result
 164  */
 165 function yourls_http_request( $type, $url, $headers, $data, $options ) {
 166         yourls_http_load_library();
 167
 168         $options = array_merge( yourls_http_default_options(), $options );
 169
 170         if( defined( 'YOURLS_PROXY' ) && !yourls_send_through_proxy( $url ) )
 171                 unset( $options['proxy'] );
 172
 173         try {
 174                 $result = Requests::request( $url, $headers, $data, $type, $options );
 175         } catch( Requests_Exception $e ) {
 176                 $result = yourls_debug_log( $e->getMessage() . ' (' . $type . ' on ' . $url . ')' );
 177         };
 178
 179         return $result;
 180 }
 181
 182 /**
 183  * Check if Requests class is defined, include Requests library if need be
 184  *
 185  * All HTTP functions should perform that check prior to any operation. This is to avoid
 186  * include()-ing all the Requests files on every YOURLS instance disregarding whether needed or not.
 187  *
 188  * @since 1.7
 189  */
 190 function yourls_http_load_library() {
 191         if ( !class_exists( 'Requests', false ) ) {
 192                 require_once dirname( __FILE__ ) . '/Requests/Requests.php';
 193                 Requests::register_autoloader();
 194         }
 195 }
 196
 197 /**
 198  * Deprecated. Get remote content via a GET request using best transport available
 199  * Returns $content (might be an error message) or false if no transport available
 200  *
 201  */
 202 function yourls_get_remote_content( $url,  $maxlen = 4096, $timeout = 5 ) {
 203         yourls_deprecated_function( __FUNCTION__, '1.7', 'yourls_http_get' );
 204         return yourls_http_get_body( $url );
 205 }
 206
 207 /**
 208  * Return funky user agent string
 209  *
 210  */
 211 function yourls_http_user_agent() {
 212         return yourls_apply_filter( 'http_user_agent', 'YOURLS v'.YOURLS_VERSION.' +http://yourls.org/ (running on '.YOURLS_SITE.')' );
 213 }
 214
 215 /**
 216  * Check api.yourls.org if there's a newer version of YOURLS
 217  *
 218  * This function collects various stats to help us improve YOURLS. See https://gist.github.com/ozh/5518761
 219  * Results of requests sent to api.yourls.org are stored in option 'core_version_checks' and is an object
 220  * with the following properties:
 221  *    - failed_attempts : number of consecutive failed attempts
 222  *    - last_attempt    : time() of last attempt
 223  *    - last_result     : content retrieved from api.yourls.org during previous check
 224  *    - version_checked : installed YOURLS version that was last checked
 225  *
 226  * @since 1.7
 227  * @return boolean True if api.yourls.org successfully requested, false otherwise
 228  */
 229 function yourls_check_core_version() {
 230
 231         if( defined( 'YOURLS_NO_VERSION_CHECK' ) && YOURLS_NO_VERSION_CHECK )
 232                 return false;
 233
 234         global $ydb, $yourls_user_passwords;
 235
 236         $checks = yourls_get_option( 'core_version_checks' );
 237
 238         // Invalidate check data when YOURLS version changes
 239         if ( is_object( $checks ) && YOURLS_VERSION != $checks->version_checked ) {
 240                 $checks = false;
 241         }
 242
 243         if( !is_object( $checks ) ) {
 244                 $checks = new stdClass;
 245                 $checks->failed_attempts = 0;
 246                 $checks->last_attempt    = 0;
 247                 $checks->last_result     = '';
 248                 $checks->version_checked = YOURLS_VERSION;
 249         }
 250
 251         // Config file location ('u' for '/user' or 'i' for '/includes')
 252         $conf_loc = str_replace( YOURLS_ABSPATH, '', YOURLS_CONFIGFILE );
 253         $conf_loc = str_replace( '/config.php', '', $conf_loc );
 254         $conf_loc = ( $conf_loc == '/user' ? 'u' : 'i' );
 255
 256         // The collection of stuff to report
 257         $stuff = array(
 258                 'md5'                => md5( YOURLS_SITE . YOURLS_ABSPATH ),  // globally unique site identifier
 259
 260                 'failed_attempts'    => $checks->failed_attempts,
 261                 'yourls_site'        => YOURLS_SITE,
 262                 'yourls_version'     => YOURLS_VERSION,
 263                 'php_version'        => phpversion(),
 264                 'mysql_version'      => $ydb->mysql_version(),
 265                 'locale'             => yourls_get_locale(),
 266
 267                 'db_driver'          => YOURLS_DB_DRIVER,
 268                 'db_ext_pdo'         => extension_loaded( 'pdo_mysql' ) ? 1 : 0,
 269                 'db_ext_mysql'       => extension_loaded( 'mysql' )     ? 1 : 0,
 270                 'db_ext_mysqli'      => extension_loaded( 'mysqli' )    ? 1 : 0,
 271                 'ext_curl'           => extension_loaded( 'curl' )      ? 1 : 0,
 272
 273                 'num_users'          => count( $yourls_user_passwords ),
 274                 'config_location'    => $conf_loc,
 275                 'yourls_private'     => YOURLS_PRIVATE     ? 1 : 0,
 276                 'yourls_unique'      => YOURLS_UNIQUE_URLS ? 1 : 0,
 277                 'yourls_url_convert' => YOURLS_URL_CONVERT,
 278                 'num_active_plugins' => yourls_has_active_plugins(),
 279         );
 280
 281         $stuff = yourls_apply_filter( 'version_check_stuff', $stuff );
 282
 283         // Send it in
 284         $checks->last_attempt = time();
 285         $url = 'https://api.yourls.org/core/version/1.0/';
 286         $req = yourls_http_post( $url, array(), $stuff );
 287
 288         // Unexpected results ?
 289         if( is_string( $req ) or !$req->success ) {
 290                 $checks->failed_attempts = $checks->failed_attempts + 1;
 291                 $checks->last_result     = '';
 292                 yourls_update_option( 'core_version_checks', $checks );
 293                 return false;
 294         }
 295
 296         // Parse response
 297         $json = json_decode( trim( $req->body ) );
 298
 299         if( isset( $json->latest ) && isset( $json->zipurl ) ) {
 300                 // All went OK - mark this down
 301                 $checks->failed_attempts = 0;
 302                 $checks->last_result     = $json;
 303                 $checks->version_checked = YOURLS_VERSION;
 304                 yourls_update_option( 'core_version_checks', $checks );
 305
 306                 return true;
 307         }
 308
 309         // Request returned actual result, but not what we expected
 310         return false;
 311 }
 312
 313
 314 /**
 315  * Determine if we need to check for a newer YOURLS version
 316  *
 317  * Longer description
 318  *
 319  * @since
 320  * @param unknown_type $a    TODO
 321  * @return unknown           TODO
 322  */
 323 function yourls_maybe_check_core_version() {
 324
 325         /* Let's check if :
 326          - we're viewing an admin page
 327          AND one of these cases:
 328          - last_result not set
 329          - failed_attempts = 0 && last_attempt > 24h  ( 24 * 3600 > ( time() - $check->last_attempt )
 330          - failed_attempts > 0 && last_attempt >  2h
 331          - version_checked != YOURLS_VERSION
 332
 333          In the future, maybe check with cronjob emulation instead of limiting to when viewing an admin page
 334         */
 335
 336
 337 }