HTTP.php

<?php

/*
This file is part of Peachy MediaWiki Bot API

Peachy is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file
 * HTTP object
 * Stores all cURL functions
 */

/**
 * HTTP Class, stores cURL functions
 */
class HTTP {

	/**
	 * Curl object
	 *
	 * @var resource a cURL handle
	 * @access private
	 */
	private $curl_instance;

	/**
	 * Hash to use for cookies
	 *
	 * @var string
	 * @access private
	 */
	private $cookie_hash;

	/**
	 * Whether or not to enable GET:, POST:, and DLOAD: messages being sent to the terminal.
	 *
	 * @var bool
	 * @access private
	 */
	private $echo;

	/**
	 * Useragent
	 *
	 * @var mixed
	 * @access private
	 */
	private $user_agent;

	/**
	 * Temporary file where cookies are stored
	 *
	 * @var mixed
	 * @access private
	 */
	private $cookie_jar;

	/**
	 * @var string|null
	 */
	private $lastHeader = null;

	/**
	 * Construction method for the HTTP class
	 *
	 * @access public
	 *
	 * @param bool $echo Whether or not to enable GET:, POST:, and DLOAD: messages being sent to the terminal. Default false;
	 *
	 * @note please consider using HTTP::getDefaultInstance() instead
	 *
	 * @throws RuntimeException
	 * @throws DependencyError
	 *
	 * @return HTTP
	 */
	public function __construct($echo = false)
	{
		if( !function_exists( 'curl_init' ) ) {
			throw new DependencyError( "cURL", "http://us2.php.net/manual/en/curl.requirements.php" );
		}

		$this->echo = $echo;
		$this->curl_instance = curl_init();
		if( $this->curl_instance === false ) {
			throw new RuntimeException( 'Failed to initialize curl' );
		}
		$this->cookie_hash = md5( time() . '-' . rand( 0, 999 ) );
		$this->cookie_jar = sys_get_temp_dir() . 'peachy.cookies.' . $this->cookie_hash . '.dat';

		$userAgent = 'Peachy MediaWiki Bot API';
		if( defined( 'PEACHYVERSION' ) ) $userAgent .= ' Version ' . PEACHYVERSION;
		$this->setUserAgent( $userAgent );

		Hooks::runHook( 'HTTPNewCURLInstance', array( &$this, &$echo ) );

		$this->setCookieJar( $this->cookie_jar );

		curl_setopt( $this->curl_instance, CURLOPT_MAXCONNECTS, 100 );
		curl_setopt( $this->curl_instance, CURLOPT_MAXREDIRS, 10 );
		$this->setCurlHeaders();
		curl_setopt( $this->curl_instance, CURLOPT_ENCODING, 'gzip' );
		curl_setopt( $this->curl_instance, CURLOPT_RETURNTRANSFER, 1 );
		curl_setopt( $this->curl_instance, CURLOPT_HEADER, 1 );
		curl_setopt( $this->curl_instance, CURLOPT_TIMEOUT, 10 );
		curl_setopt( $this->curl_instance, CURLOPT_CONNECTTIMEOUT, 10 );

		global $pgProxy;
		if( isset( $pgProxy ) && count( $pgProxy ) ) {
			curl_setopt( $this->curl_instance, CURLOPT_PROXY, $pgProxy['addr'] );
			if( isset( $pgProxy['type'] ) ) {
				curl_setopt( $this->curl_instance, CURLOPT_PROXYTYPE, $pgProxy['type'] );
			}
			if( isset( $pgProxy['userpass'] ) ) {
				curl_setopt( $this->curl_instance, CURLOPT_PROXYUSERPWD, $pgProxy['userpass'] );
			}
			if( isset( $pgProxy['port'] ) ) {
				curl_setopt( $this->curl_instance, CURLOPT_PROXYPORT, $pgProxy['port'] );
			}
		}
	}

	/**
	 * @param array $extraHeaders
     */
	private function setCurlHeaders( $extraHeaders = array() ) {
		curl_setopt( $this->curl_instance, CURLOPT_HTTPHEADER, array_merge( array( 'Expect:' ), $extraHeaders ) );
	}

	/**
	 * @param boolean $verifyssl
	 */
	private function setVerifySSL( $verifyssl = null ) {
		if( is_null( $verifyssl ) ) {
			global $verifyssl;
		}
		if( !$verifyssl ) {
			curl_setopt( $this->curl_instance, CURLOPT_SSL_VERIFYPEER, false );
			curl_setopt( $this->curl_instance, CURLOPT_SSL_VERIFYHOST, 0 );
		} else {
			curl_setopt( $this->curl_instance, CURLOPT_SSL_VERIFYPEER, true );
			//support for value of 1 will be removed in cURL 7.28.1
			curl_setopt( $this->curl_instance, CURLOPT_SSL_VERIFYHOST, 2 );
		}
	}

	/**
	 * @param string $cookie_file
	 */
	public function setCookieJar($cookie_file)
	{
		$this->cookie_jar = $cookie_file;

		Hooks::runHook( 'HTTPSetCookieJar', array( &$cookie_file ) );

		curl_setopt( $this->curl_instance, CURLOPT_COOKIEJAR, $cookie_file );
		curl_setopt( $this->curl_instance, CURLOPT_COOKIEFILE, $cookie_file );
	}

	/**
	 * @param null $user_agent
	 * @throws BadEntryError
	 * @throws HookError
     */
	public function setUserAgent($user_agent = null)
	{
		$this->user_agent = $user_agent;

		Hooks::runHook( 'HTTPSetUserAgent', array( &$user_agent ) );

		curl_setopt( $this->curl_instance, CURLOPT_USERAGENT, $user_agent );
	}

	/**
	 * @return string|bool Data. False on failure.
	 * @throws CURLError
	 */
	private function doCurlExecWithRetrys() {
		$data = false;
		for( $i = 0; $i <= 20; $i++ ){
			try{
				$response = curl_exec( $this->curl_instance );
				$header_size = curl_getinfo( $this->curl_instance, CURLINFO_HEADER_SIZE );
				$this->lastHeader = substr( $response, 0, $header_size );
				$data = substr( $response, $header_size );
			} catch( Exception $e ){
				if( curl_errno( $this->curl_instance ) != 0 ) {
					throw new CURLError( curl_errno( $this->curl_instance ), curl_error( $this->curl_instance ) );
				}
				if( $i == 20 ) {
					pecho( "Warning: A CURL error occurred.  Attempted 20 times.  Terminating attempts.", PECHO_WARN );
					return false;
				} else {
					pecho( "Warning: A CURL error occurred.  Details can be found in the PHP error log.  Retrying...", PECHO_WARN );
				}
				continue;
			}
			if( !is_null( $data ) && $data !== false ) {
				break;
			}
		}
		return $data;
	}

	/**
	 * Get an url with HTTP GET
	 *
	 * @access public
	 *
	 * @param string $url URL to get
	 * @param array|null $data Array of data to pass. Gets transformed into the URL inside the function. Default null.
	 * @param array $headers Array of headers to pass to curl
	 * @param bool $verifyssl override for the global verifyssl value
	 *
	 * @return bool|string Result
	 */
	public function get( $url, $data = null, $headers = array(), $verifyssl = null ) {
		global $argv, $displayGetOutData;

		if( is_string( $headers ) ) curl_setopt( $this->curl_instance, CURLOPT_HTTPHEADER, array( $headers ) );
		else $this->setCurlHeaders( $headers );
		$this->setVerifySSL( $verifyssl );

		curl_setopt( $this->curl_instance, CURLOPT_FOLLOWLOCATION, 1 );
		curl_setopt( $this->curl_instance, CURLOPT_HTTPGET, 1 );
		curl_setopt( $this->curl_instance, CURLOPT_POST, 0 );

		/*if( !is_null( $this->use_cookie ) ) {
			curl_setopt($this->curl_instance,CURLOPT_COOKIE, $this->use_cookie);
		}*/

		if( !is_null( $data ) && is_array( $data ) && !empty( $data ) ) {
			$url .= '?' . http_build_query( $data );
		}

		curl_setopt( $this->curl_instance, CURLOPT_URL, $url );

		if( ( !is_null( $argv ) && in_array( 'peachyecho', $argv ) ) || $this->echo ) {
			if( $displayGetOutData ) {
				pecho( "GET: $url\n", PECHO_NORMAL );
			}
		}

		Hooks::runHook( 'HTTPGet', array( &$this, &$url, &$data ) );

		return $this->doCurlExecWithRetrys();

	}

	/**
	 * Returns the HTTP code of the last request
	 *
	 * @access public
	 * @return int HTTP code
	 */
	public function get_HTTP_code()
	{
		$ci = curl_getinfo( $this->curl_instance );
		return $ci['http_code'];
	}

	/**
	 * Sends data via HTTP POST
	 *
	 * @access public
	 *
	 * @param string $url URL to send
	 * @param array $data Array of data to pass.
	 * @param array $headers Array of headers to pass to curl
	 *
	 * @param bool|null $verifyssl override for global verifyssl value
	 *
	 * @return bool|string Result
	 */
	public function post($url, $data, $headers = array(), $verifyssl = null)
	{
		global $argv, $displayPostOutData;

		if( is_string( $headers ) ) curl_setopt( $this->curl_instance, CURLOPT_HTTPHEADER, array( $headers ) );
		else $this->setCurlHeaders( $headers );
		$this->setVerifySSL( $verifyssl );

		curl_setopt( $this->curl_instance, CURLOPT_FOLLOWLOCATION, 0 );
		curl_setopt( $this->curl_instance, CURLOPT_HTTPGET, 0 );
		curl_setopt( $this->curl_instance, CURLOPT_POST, 1 );
		curl_setopt( $this->curl_instance, CURLOPT_POSTFIELDS, $data );

		/*if( !is_null( $this->use_cookie ) ) {
			curl_setopt($this->curl_instance,CURLOPT_COOKIE, $this->use_cookie);
		}*/

		curl_setopt( $this->curl_instance, CURLOPT_URL, $url );

		if( ( !is_null( $argv ) && in_array( 'peachyecho', $argv ) ) || $this->echo ) {
			if( $displayPostOutData ) {
				pecho( "POST: $url\n", PECHO_NORMAL );
			}
		}

		Hooks::runHook( 'HTTPPost', array( &$this, &$url, &$data ) );

		return $this->doCurlExecWithRetrys();
	}

	/**
	 * Downloads an URL to the local disk
	 *
	 * @access public
	 *
	 * @param string $url URL to get
	 * @param string $local Local filename to download to
	 * @param array $headers Array of headers to pass to curl
	 * @param bool|null $verifyssl
	 *
	 * @return bool
	 */
	function download( $url, $local, $headers = array(), $verifyssl = null ) {
		global $argv;

		$out = fopen( $local, 'wb' );

		if( is_string( $headers ) ) curl_setopt( $this->curl_instance, CURLOPT_HTTPHEADER, array( $headers ) );
		else $this->setCurlHeaders( $headers );
		$this->setVerifySSL( $verifyssl );

		// curl_setopt($this->curl_instance, CURLOPT_FILE, $out);
		curl_setopt( $this->curl_instance, CURLOPT_HTTPGET, 1 );
		curl_setopt( $this->curl_instance, CURLOPT_POST, 0 );
		curl_setopt( $this->curl_instance, CURLOPT_URL, $url );
		curl_setopt( $this->curl_instance, CURLOPT_HEADER, 0 );

		if( ( !is_null( $argv ) && in_array( 'peachyecho', $argv ) ) || $this->echo ) {
			pecho( "DLOAD: $url\n", PECHO_NORMAL );
		}

		Hooks::runHook( 'HTTPDownload', array( &$this, &$url, &$local ) );

		fwrite( $out, $this->doCurlExecWithRetrys() );
		fclose( $out );

		return true;

	}

	/**
	 * Gets the Header for the last request made
	 * @return null|string
	 */
	public function getLastHeader() {
		return $this->lastHeader;
	}

	/**
	 * Destructor, deletes cookies and closes cURL class
	 *
	 * @access public
	 * @return void
	 */
	public function __destruct()
	{
		Hooks::runHook( 'HTTPClose', array( &$this ) );

		curl_close( $this->curl_instance );

		//@unlink($this->cookie_jar);
	}

	/**
	 * The below allows us to only have one instance of this class
	 */
	private static $defaultInstance = null;
	private static $defaultInstanceWithEcho = null;

	/**
	 * @param bool|false $echo
	 * @return HTTP|null
     */
	public static function getDefaultInstance($echo = false)
	{
		if( $echo ) {
			if( is_null( self::$defaultInstanceWithEcho ) ) {
				self::$defaultInstanceWithEcho = new Http( $echo );
			}
			return self::$defaultInstanceWithEcho;
		} else {
			if( is_null( self::$defaultInstance ) ) {
				self::$defaultInstance = new Http( $echo );
			}
			return self::$defaultInstance;
		}
	}

}