request.php

<?php

/**
 * Instaphp
 *
 * Copyright (c) 2011 randy sesser <randy@instaphp.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @author randy sesser <randy@instaphp.com>
 * @copyright 2011, randy sesser
 * @license http://www.opensource.org/licenses/mit-license The MIT License
 * @package Instaphp
 * @filesource
 */

namespace Instaphp {

    use Instaphp\Config;
	use Instaphp\Cache;
	use Instaphp\WebRequest;
    /**
     * Request
     * The Request class performs simple curl requests to a URL optionally passing
     * parameters on the querystring. Currently, it supports GET,POST and DELETE requests.
     * @package Instaphp
     * @version 1.0
     * @author randy sesser <randy@instaphp.com>
     */
    class Request
    {

        /**
         * Associative array of key/value pairs to pass to the Instagram API
         * @var Array
         * @access public
         */
        public $parameters = array();
        /**
         * The URL in which to make the request
         * @var String
         * @access public
         */
        public $url = null;
        /**
         * A var to store whether or not to use curl
         * @var boolean
         * @access private
         */
        private $useCurl = false;

		/**
		 *
		 * @var iCache Cache object used for caching
		 * @access private
		 */
		private $_cache = null;

        /**
         * The constructor contructs
         * @param string $url A URL in which to create a new request (optional)
         * @param Array $params An associated array of key/value pairs to pass to said URL (optional)
         */
        public function __construct($url = null, $params = array())
        {
            $this->useCurl = self::HasCurl();
            $this->parameters = $params;
            $this->url = $url;

/*
			$cacheConfig = Config::Instance()->GetSection("Instaphp/Cache");
			if (!empty($cacheConfig) && count($cacheConfig) > 0) {
				$cacheConfig = $cacheConfig[0];
				if ($cacheConfig["Enabled"]) {
					$engine = (string)$cacheConfig["Engine"];
                    $this->_cache = Cache\Cache::Instance($engine);
					// $method = new \ReflectionMethod("Instaphp\\Cache\\".$engine, 'Instance');
					// $this->_cache = $method->invoke(null, null);
					// $this->_cache = Cache\File::Instance();
				}

			}
*/
        }


        /**
         * Makes a GET request
         * @param string $url A URL in which to make a GET request
         * @param Array $params An associative array of key/value pairs to pass to said URL
         * @return Request
         */
        public function Get($url = null, $params = array())
        {
            if (null !== $url)
                $this->url = $url;

			if (!empty($params))
				$this->parameters = $params;
			$query = '';
			foreach ($this->parameters as $k => $v)
				$query .= ((strlen ($query) == 0) ? '?' : '&') . sprintf('%s=%s', $k, $v);

			if (null !== $this->_cache) {
				$key = sha1($url.$query);

				if (false === ($response = $this->_cache->Get($key))) {
					$response = $this->GetResponse();
					if (empty ($response->error)) {
						$this->_cache->Set($key, $response);
					}
				}
			} else {
				$response = $this->GetResponse();
			}

            $this->response = $response;
            return $this;
        }

        /**
         * Makes a POST request
         * @param string $url A URL in which to make a POST request
         * @param Array $params An associative array of key/value pairs to pass to said URL
         * @return Request
         */
        public function Post($url = null, $params = array())
        {
            if (null !== $url)
                $this->url = $url;

			if (!empty($params))
				$this->parameters = $params;

            $this->response = $this->GetResponse('POST');
            return $this;
        }

        /**
         * Makes a PUT request (currently unused)
         * @param string $url A URL in which to make a PUT request
         * @param Array $params An associative array of key/value pairs to pass to said URL
         * @return void
         */
        public function Put($url = null, $params = array())
        {

        }

        /**
         * Makes a DELETE request
         * @param string $url A URL in which to make a DELETE request
         * @param Array $params An associative array of key/value pairs to pass to said URL
         * @return Request
         */
        public function Delete($url = null, $params = array())
        {
            if (null !== $url)
                $this->url = $url;

			if (!empty($params))
				$this->parameters = $params;

            $this->response = $this->GetResponse('DELETE');
            return $this;
        }

        /**
         * Makes a request
         * @param string $url A URL in which to make a GET request
         * @param Array $params An associative array of key/value pairs to pass to said URL
         * @access private
         * @return Response
         */
        private function GetResponse($method = 'GET')
        {
            //-- since there's no option to use anything other curl, this check is kinda useless
            //-- I had high hopes with this one using sockets and whatnot, but alas, time is of
            //-- the essence... in internet time
            if ($this->useCurl) {

				$response = new Response;

				$http = WebRequest::Instance();
				$res = $http->Create($this->url, $method, $this->parameters);

				if ($res instanceof Error)
					return $res;

				$response->info = $res->Info;
				$response->json = $res->Content;
				$response = Response::Create($this, $response);
                return $response;
            }
        }

        /**
         * Checks to see if cURL extension is available
         * @access private
         * @return boolean
         */
        private static function HasCurl()
        {
            return function_exists('curl_init');
        }

        /**
         * Determines whether or not curl will follow redirects over SSL
         * See the constructor for details, but there are cases in which
         * if curl can't verify the certificate of an SSL request, AND
         * PHP is in safe_mode OR there are open_basedir restrictions, it will
         * not follow a redirect. There's a fix for this that involves
         * parsing all the response headers from a request and detecting
         * a Location header, but that's kind of a hack as it bypasses the
         * whole point of SSL. This method left for posterity. Or something...
         *
         * @return boolean
         * @access private
         **/
        private function WillFollowRedirects()
        {
            $open_basedir = ini_get('open_basedir');
            $safe_mode = strtolower(ini_get('safe_mode'));
            if (empty($open_basedir) && $safe_mode == 'off') {
                return true;
            }
            return false;
        }

    }
}