Added the allow_redirects option to CURLRequest.

Author: lonnieezell

system/HTTP/CURLRequest.php

@@ -26,12 +26,25 @@ class CURLRequest extends Request
 
 	/**
 	 * The setting values
+	 *
 	 * @var array
 	 */
 	protected $config = [
 		'timeout'         => 0.0,
 		'connect_timeout' => 150,
-	    'debug' => false
+		'debug'           => false,
+	];
+
+	/**
+	 * Default values for when 'allow_redirects'
+	 * option is true.
+	 *
+	 * @var array
+	 */
+	protected $redirectDefaults = [
+		'max'       => 5,
+		'strict'    => true,
+		'protocols' => ['http', 'https'],
 	];
 
 	//--------------------------------------------------------------------
@@ -264,7 +277,6 @@ public function method($upper = false): string
 
 	//--------------------------------------------------------------------
 
-
 	/**
 	 * Fires the actual cURL request.
 	 *
@@ -320,7 +332,10 @@ protected function applyRequestHeaders(array $curl_options=[]): array
 	{
 		$headers = $this->headers();
 
-		if (empty($head)) return $curl_options;
+		if (empty($head))
+		{
+			return $curl_options;
+		}
 
 		$set = [];
 
@@ -349,6 +364,7 @@ protected function applyMethod($method, array $curl_options): array
 		if ($size === null || $size > 0)
 		{
 			$curl_options = $this->applyBody($curl_options);
+
 			return $curl_options;
 		}
 
@@ -480,6 +496,40 @@ protected function setCURLOptions(array $curl_options=[], array $config=[])
 			}
 		}
 
+		// Allow Redirects
+		if (array_key_exists('allow_redirects', $config))
+		{
+			$settings = $this->redirectDefaults;
+
+			if (is_array($config['allow_redirects']))
+			{
+				$settings = array_merge($settings, $config['allow_redirects']);
+			}
+
+			if ($config['allow_redirects'] === false)
+			{
+				$curl_options[CURLOPT_FOLLOWLOCATION] = 0;
+			}
+			else
+			{
+				$curl_options[CURLOPT_FOLLOWLOCATION] = 1;
+				$curl_options[CURLOPT_MAXREDIRS]      = $settings['max'];
+
+				if ($settings['strict'] == true)
+				{
+					$curl_options[CURLOPT_POSTREDIR] = 1|2|4;
+				}
+
+				$protocols = 0;
+				foreach ($settings['protocols'] as $proto)
+				{
+					$protocols += constant('CURLPROTO_'.strtoupper($proto));
+				}
+
+				$curl_options[CURLOPT_REDIR_PROTOCOLS] = $protocols;
+			}
+		}
+
 		// Timeout
 		$curl_options[CURLOPT_TIMEOUT_MS] = (float)$config['timeout'] * 1000;
 

tests/HTTP/CURLRequestTest.php

@@ -322,4 +322,56 @@ public function testDebugOption()
 
 	//--------------------------------------------------------------------
 
+	public function testAllowRedirectsOptionFalse()
+	{
+		$response = $this->request->request('get', 'http://example.com', [
+				'allow_redirects' => false
+		]);
+
+		$options = $this->request->curl_options;
+
+		$this->assertTrue(isset($options[CURLOPT_FOLLOWLOCATION]));
+		$this->assertEquals(0, $options[CURLOPT_FOLLOWLOCATION]);
+
+		$this->assertFalse(isset($options[CURLOPT_MAXREDIRS]));
+		$this->assertFalse(isset($options[CURLOPT_REDIR_PROTOCOLS]));
+	}
+
+	//--------------------------------------------------------------------
+
+	public function testAllowRedirectsOptionTrue()
+	{
+		$response = $this->request->request('get', 'http://example.com', [
+				'allow_redirects' => true
+		]);
+
+		$options = $this->request->curl_options;
+
+		$this->assertTrue(isset($options[CURLOPT_FOLLOWLOCATION]));
+		$this->assertEquals(1, $options[CURLOPT_FOLLOWLOCATION]);
+
+		$this->assertTrue(isset($options[CURLOPT_MAXREDIRS]));
+		$this->assertEquals(5, $options[CURLOPT_MAXREDIRS]);
+		$this->assertTrue(isset($options[CURLOPT_REDIR_PROTOCOLS]));
+		$this->assertEquals(CURLPROTO_HTTP|CURLPROTO_HTTPS, $options[CURLOPT_REDIR_PROTOCOLS]);
+	}
+
+	//--------------------------------------------------------------------
+
+	public function testAllowRedirectsOptionDefaults()
+	{
+		$response = $this->request->request('get', 'http://example.com', [
+				'allow_redirects' => true
+		]);
+
+		$options = $this->request->curl_options;
+
+		$this->assertTrue(isset($options[CURLOPT_FOLLOWLOCATION]));
+		$this->assertEquals(1, $options[CURLOPT_FOLLOWLOCATION]);
+
+		$this->assertTrue(isset($options[CURLOPT_MAXREDIRS]));
+		$this->assertTrue(isset($options[CURLOPT_REDIR_PROTOCOLS]));
+	}
+
+	//--------------------------------------------------------------------
 }

user_guide_src/source/libraries/curlrequest.rst

@@ -159,8 +159,34 @@ Request Options
 This section describes all of the available options you may pass into the constructor, the ``request()`` method,
 or any of the shortcut methods.
 
+allow_redirects
+===============
+
+By default, cURL will follow all "Location:" headers the remote servers send back. The ``allow_redirects`` option
+allows you to modify how that works.
+
+If you set the value to ``false``, then it will not follow any redirects at all::
+
+	$client->request('GET', 'http://example.com', ['allow_redirects' => false]);
+
+Setting it to ``true`` will apply the default settings to the request::
+
+	$client->request('GET', 'http://example.com', ['allow_redirects' => true]);
 
-Auth
+	// Sets the following defaults:
+	'max'       => 5,   // Maximum number of redirects to follow before stopping
+	'strict' => true,   // Ensure POST requests stay POST requests through redirects
+	'protocols' => ['http', 'https'] // Restrict redirects to one or more protocols
+
+You can pass in array as the value of the ``allow_redirects`` option to specify new settings in place of the defaults::
+
+	$client->request('GET', 'http://example.com', ['allow_redirects' => [
+		'max' => 10,
+		'protocols => ['https'] // Force HTTPS domains only.
+	]]);
+
+.. :note::  Following redirects does not work when PHP is in safe_mode or open_basedir is enabled.
+auth
 ====
 
 Allows you to provide Authentication details for `HTTP Basic <http://www.ietf.org/rfc/rfc2069.txt>`_ and
@@ -171,7 +197,7 @@ the type of authentication to use, either ``basic`` or ``digest``.::
 
 	$client->request('GET', 'http://example.com', ['auth' => ['username', 'password', 'digest']]);
 
-Body
+body
 ====
 
 There are two ways to set the body of the request for request types that support them, like PUT, OR POST.
@@ -187,25 +213,25 @@ and functions the exact same way as the previous example. The value must be a st
 
 
 
-Certificates
-============
+cert
+====
 
 To specify the location of a PEM formatted client-side certificate, pass a string with the full path to the
 file as the ``cert`` option. If a password is required, set the value to an array with the first element
  as the path to the certificate, and the second as the password::
 
     $client->request('get', '/', ['cert' => ['/path/server.pem', 'password']);
 
-Connection Timeout
-==================
+Connect_timeout
+===============
 
 By default, CodeIgniter does not impose a limit for cURL to attempt to connect to a website. If you need to
 modify this value, you can do so by passing the amount of time in seconds with the ``connect_timeout`` option.
 You can pass 0 to wait indefinitely::
 
 	$response->request('GET', 'http://example.com', ['connect_timeout' => 0]);
 
-Debug
+debug
 =====
 
 When ``debug`` is passed and set to ``true``, this will enable additional debugging to echo to STDOUT during the
@@ -217,7 +243,7 @@ You can pass a filename as the value for debug to have the output written to a f
 
 	$response->request('GET', 'http://example.com', ['debug' => '/usr/local/curl_log.txt']);
 
-Headers
+headers
 =======
 
 While you can set any headers this request needs by using the ``setHeader()`` method, you can also pass an associative
@@ -235,7 +261,7 @@ representing the header field values.::
 If headers are passed into the constructor they are treated as default values that will be overridden later by any
 further headers arrays or calls to ``setHeader()``.
 
-Timeout
+timeout
 =======
 
 By default, cURL functions are allowed to run as long as they take, with no time limit. You can modify this with the ``timeout``