joomla-platform / libraries / joomla / client / http.php

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Client
 *
 * @copyright   Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

jimport('joomla.environment.uri');

/**
 * HTTP client class.
 *
 * @package     Joomla.Platform
 * @since       11.1
 * @subpackage  Client
 */
class JHttp
{
	/**
	 * Server connection resources array.
	 *
	 * @var    array
	 * @since  11.1
	 */
	protected $_connections = array();

	/**
	 * Timeout limit in seconds for the server connection.
	 *
	 * @var    int
	 * @since  11.1
	 */
	protected $_timeout = 5;

	/**
	 * Server response string.
	 *
	 * @var    string
	 * @since  11.1
	 */
	protected $_response;

	/**
	 * Constructor.
	 *
	 * @param   array  $options  Array of configuration options for the client.
	 *
	 * @return  void
	 *
	 * @since   11.1
	 */
	public function __construct($options = array())
	{
		// If a connection timeout is set, use it.
		if (isset($options['timeout'])) {
			$this->_timeout = $options['timeout'];
		}
	}

	/**
	 * Destructor.
	 *
	 * @return  void
	 *
	 * @since   11.1
	 */
	public function __destruct()
	{
		// Close all the connections.
		foreach ($this->_connections as $connection)
		{
			fclose($connection);
		}
	}

	/**
	 * Method to send the HEAD command to the server.
	 *
	 * @param   string  $url  Path to the resource.
	 *
	 * @return  bool    True on success.
	 *
	 * @since   11.1
	 * @throws  JException
	 */
	public function head($url)
	{
		// Parse the request url.
		$uri = JUri::getInstance($url);

		try {
			$connection = $this->_connect($uri);
		}
		catch (JException $e) {
			return false;
		}

		// Send the command to the server.
		if (!$this->_sendRequest($connection, 'HEAD', $uri)) {
			return false;
		}

		return $this->_getResponseObject();
	}

	/**
	 * Method to send the GET command to the server.
	 *
	 * @param   string  $url  Path to the resource.
	 *
	 * @return  bool    True on success.
	 *
	 * @since   11.1
	 * @throws  JException
	 */
	public function get($url)
	{
		// Parse the request url.
		$uri = JUri::getInstance($url);

		try {
			$connection = $this->_connect($uri);
		}
		catch (JException $e) {
			return false;
		}

		// Send the command to the server.
		if (!$this->_sendRequest($connection, 'GET', $uri)) {
			return false;
		}

		return $this->_getResponseObject();
	}

	/**
	 * Method to send the POST command to the server.
	 *
	 * @param   string  $url   Path to the resource.
	 * @param   array   $data  Associative array of key/value pairs to send as post values.
	 *
	 * @return  bool    True on success.
	 *
	 * @since   11.1
	 * @throws  JException
	 */
	public function post($url, $data)
	{
		// Parse the request url.
		$uri = JUri::getInstance($url);

		try {
			$connection = $this->_connect($uri);
		}
		catch (JException $e) {
			return false;
		}

		// Send the command to the server.
		if (!$this->_sendRequest($connection, 'POST', $uri, $data)) {
			return false;
		}

		return $this->_getResponseObject();
	}

	/**
	 * Send a command to the server and validate an expected response.
	 *
	 * @param   string  Command to send to the server.
	 * @param   mixed   Valid response code or array of response codes.
	 *
	 * @return 	bool  True on success.
	 *
	 * @since   11.1
	 * @throws  JException
	 */
	protected function _sendRequest($connection, $method, JUri $uri, $data = null, $headers = null)
	{
		// Make sure the connection is a valid resource.
		if (is_resource($connection))
		{
			// Make sure the connection has not timed out.
			$meta = stream_get_meta_data($connection);
			if ($meta['timed_out']) {
				throw new JException('Server connection timed out.', 0, E_WARNING);
			}
		}
		else {
			throw new JException('Not connected to server.', 0, E_WARNING);
		}

		// Get the request path from the URI object.
		$path = $uri->toString(array('path', 'query'));

		// Build the request payload.
		$request = array();
		$request[] = strtoupper($method).' '.((empty($path)) ? '/' : $path).' HTTP/1.0';
		$request[] = 'Host: '.$uri->getHost();
		$request[] = 'User-Agent: JHttp | Joomla/2.0';

		// If there are custom headers to send add them to the request payload.
		if (is_array($headers))
		{
			foreach ($headers as $k => $v)
			{
				$request[] = $k.': '.$v;
			}
		}

		// If we have data to send add it to the request payload.
		if (!empty($data))
		{
			// If the data is an array, build the request query string.
			if (is_array($data)) {
				$data = http_build_query($data);
			}

			$request[] = 'Content-Type: application/x-www-form-urlencoded; charset=utf-8';
			$request[] = 'Content-Length: '.strlen($data);
			$request[] = null;
			$request[] = $data;
		}

		// Send the request to the server.
		fwrite($connection, implode("\r\n", $request)."\r\n\r\n");

		// Get the response data from the server.
		$this->_response = null;
		while (!feof($connection))
		{
		    $this->_response .= fgets($connection, 4096);
		}

		return true;
	}

	/**
	 * Method to get a response object from a server response.
	 *
	 * @return	JHttpResponse
	 *
	 * @since   11.1
	 * @throws  JException
	 */
	protected function _getResponseObject()
	{
		// Create the response object.
		$return = new JHttpResponse();

		// Split the response into headers and body.
		$response = explode("\r\n\r\n", $this->_response, 2);

		// Get the response headers as an array.
		$headers = explode("\r\n", $response[0]);

		// Get the response code from the first offset of the response headers.
		preg_match('/[0-9]{3}/', array_shift($headers), $matches);
		$code = $matches[0];
		if (is_numeric($code)) {
			$return->code = (int) $code;
		}
		// No valid response code was detected.
		else {
			throw new JException('Invalid server response.', 0, E_WARNING, $this->_response);
		}

		// Add the response headers to the response object.
		foreach ($headers as $header)
		{
			$pos = strpos($header, ':');
			$return->headers[trim(substr($header, 0, $pos))] = trim(substr($header, ($pos + 1)));
		}

		// Set the response body if it exists.
		if (!empty($response[1])) {
			$return->body = $response[1];
		}

		return $return;
	}

	/**
	 * Method to connect to a server and get the resource.
	 *
	 * @param   JUri   $uri  The URI to connect with.
	 *
	 * @return  mixed  Connection resource on success or boolean false on failure.
	 *
	 * @since   11.1
	 */
	protected function _connect(JUri $uri)
	{
		// Initialize variables.
		$errno = null;
		$err = null;

		// Get the host from the uri.
		$host = ($uri->isSSL()) ? 'ssl://'.$uri->getHost() : $uri->getHost();

		// If the port is not explicitly set in the URI detect it.
		if (!$uri->getPort())
		{
			$port = ($uri->getScheme() == 'https') ? 443 : 80;
		}
		// Use the set port.
		else {
			$port = $uri->getPort();
		}

		// Build the connection key for resource memory caching.
		$key = md5($host.$port);

		// If the connection already exists, use it.
		if (!empty($this->_connections[$key]) && is_resource($this->_connections[$key]))
		{
			// Make sure the connection has not timed out.
			$meta = stream_get_meta_data($this->_connections[$key]);
			if (!$meta['timed_out']) {
				return $this->_connections[$key];
			}
		}

		// Attempt to connect to the server.
		if ($this->_connections[$key] = fsockopen($host, $port, $errno, $err, $this->_timeout)) {
			stream_set_timeout($this->_connections[$key], $this->_timeout);
		}

		return $this->_connections[$key];
	}
}

/**
 * HTTP response data object class.
 *
 * @package     Joomla.Platform
 * @since       11.1
 * @subpackage  Client
 */
class JHttpResponse
{
	/**
	 * The server response code.
	 *
	 * @var    int
	 * @since  11.1
	 */
	public $code;

	/**
	 * Response headers.
	 *
	 * @var    array
	 * @since  11.1
	 */
	public $headers = array();

	/**
	 * Server response body.
	 *
	 * @var    string
	 * @since  11.1
	 */
	public $body;
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.