Merge pull request #3005 from michalsn/uri_setSilent

Add setSilent() method to URI class

Author: MGatner

system/HTTP/URI.php

@@ -153,6 +153,13 @@ class URI
 	 */
 	protected $showPassword = false;
 
+	/**
+	 * If true, will continue instead of throwing exceptions.
+	 *
+	 * @var boolean
+	 */
+	protected $silent = false;
+
 	//--------------------------------------------------------------------
 
 	/**
@@ -172,6 +179,23 @@ public function __construct(string $uri = null)
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * If $silent == true, then will not throw exceptions and will
+	 * attempt to continue gracefully.
+	 *
+	 * @param boolean $silent
+	 *
+	 * @return URI
+	 */
+	public function setSilent(bool $silent = true)
+	{
+		$this->silent = $silent;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
 	/**
 	 * Sets and overwrites any current URI information.
 	 *
@@ -187,6 +211,11 @@ public function setURI(string $uri = null)
 
 			if ($parts === false)
 			{
+				if ($this->silent)
+				{
+					return $this;
+				}
+
 				throw HTTPException::forUnableToParseURI($uri);
 			}
 
@@ -480,7 +509,7 @@ public function getSegment(int $number): string
 		// but we still have to deal with a zero-based array.
 		$number -= 1;
 
-		if ($number > count($this->segments))
+		if ($number > count($this->segments) && ! $this->silent)
 		{
 			throw HTTPException::forURISegmentOutOfRange($number);
 		}
@@ -505,6 +534,11 @@ public function setSegment(int $number, $value)
 
 		if ($number > count($this->segments) + 1)
 		{
+			if ($this->silent)
+			{
+				return $this;
+			}
+
 			throw HTTPException::forURISegmentOutOfRange($number);
 		}
 
@@ -689,6 +723,11 @@ public function setPort(int $port = null)
 
 		if ($port <= 0 || $port > 65535)
 		{
+			if ($this->silent)
+			{
+				return $this;
+			}
+
 			throw HTTPException::forInvalidPort($port);
 		}
 
@@ -749,6 +788,11 @@ public function setQuery(string $query)
 	{
 		if (strpos($query, '#') !== false)
 		{
+			if ($this->silent)
+			{
+				return $this;
+			}
+
 			throw HTTPException::forMalformedQueryString();
 		}
 

tests/system/HTTP/URITest.php

@@ -65,6 +65,15 @@ public function testSegmentOutOfRange()
 
 	//--------------------------------------------------------------------
 
+	public function testSegmentOutOfRangeWithSilent()
+	{
+		$url = 'http://abc.com/a123/b/c';
+		$uri = new URI($url);
+		$this->assertEquals('', $uri->setSilent()->getSegment(22));
+	}
+
+	//--------------------------------------------------------------------
+
 	public function testCanCastAsString()
 	{
 		$url = 'http://username:password@hostname:9090/path?arg=value#anchor';
@@ -225,6 +234,18 @@ public function testSetPortInvalidValues()
 
 	//--------------------------------------------------------------------
 
+	public function testSetPortInvalidValuesSilent()
+	{
+		$url = 'http://example.com/path';
+		$uri = new URI($url);
+
+		$uri->setSilent()->setPort(70000);
+
+		$this->assertEquals(null, $uri->getPort());
+	}
+
+	//--------------------------------------------------------------------
+
 	public function testSetPortTooSmall()
 	{
 		$url = 'http://example.com/path';
@@ -372,6 +393,18 @@ public function testSetQueryThrowsErrorWhenFragmentPresent()
 
 	//--------------------------------------------------------------------
 
+	public function testSetQueryThrowsErrorWhenFragmentPresentSilent()
+	{
+		$url = 'http://example.com/path';
+		$uri = new URI($url);
+
+		$uri->setSilent()->setQuery('?key=value#fragment');
+
+		$this->assertEquals('', $uri->getQuery());
+	}
+
+	//--------------------------------------------------------------------
+
 	public function authorityInfo()
 	{
 		return [
@@ -783,6 +816,18 @@ public function testSetBadSegment()
 		$uri->setSegment(6, 'banana');
 	}
 
+	public function testSetBadSegmentSilent()
+	{
+		$base = 'http://example.com/foo/bar/baz';
+
+		$uri = new URI($base);
+
+		$segments = $uri->getSegments();
+		$uri->setSilent()->setSegment(6, 'banana');
+
+		$this->assertEquals($segments, $uri->getSegments());
+	}
+
 	//--------------------------------------------------------------------
 	// Exploratory testing, investigating https://github.com/codeigniter4/CodeIgniter4/issues/2016
 
@@ -856,4 +901,24 @@ public function testEmptyURIPath()
 		$this->assertEquals(0, $uri->getTotalSegments());
 	}
 
+	public function testSetURI()
+	{
+		$url = ':';
+		$uri = new URI();
+
+		$this->expectException(HTTPException::class);
+		$this->expectExceptionMessage(lang('HTTP.cannotParseURI', [$url]));
+
+		$uri->setURI($url);
+	}
+
+	public function testSetURISilent()
+	{
+		$url = ':';
+		$uri = new URI();
+		$uri->setSilent()->setURI($url);
+
+		$this->assertTrue(true);
+	}
+
 }

user_guide_src/source/libraries/uri.rst

@@ -248,3 +248,17 @@ Finally, you can retrieve an array of all of the segments::
 		1 => '15',
 		2 => 'profile'
 	]
+
+===========================
+Disable Throwing Exceptions
+===========================
+
+By default, some methods of this class may throw an exception. If you want to disable it, you can set a special flag
+that will prevent throwing exceptions.
+::
+
+	// Disable throwing exceptions
+	$uri->setSilent();
+
+	// Enable throwing exceptions (default)
+	$uri->setSilent(false);