Skip to content

Commit f7d6142

Browse files
ddevsrpaulbalandan
ddevsr
and
paulbalandan
authored
feat: add dns_cache_timeout for option CURLRequest (#9553)
* feat: added dns_cache_timeout for option CURLRequest * tests: added option when set to not numeric * docs: added dns_cache_timeout options to CURLRequest * Update user_guide_src/source/libraries/curlrequest.rst Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com> * fix: more test coverage dns_cache_timeout options CURLRequest * fix: specified variable doctype * fix: more coverage * tests: added more coverage * docs: added notes libcurl * docs: remove notes PHP * Update tests/system/HTTP/CURLRequestTest.php Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com> * Update tests/system/HTTP/CURLRequestTest.php Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com> * Update user_guide_src/source/libraries/curlrequest.rst Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com> --------- Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com>
1 parent ac89c61 commit f7d6142

File tree

5 files changed

+96
-7
lines changed

5 files changed

+96
-7
lines changed

‎system/HTTP/CURLRequest.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,11 @@ protected function setCURLOptions(array $curlOptions = [], array $config = [])
616616
}
617617
}
618618

619+
// DNS Cache Timeout
620+
if (isset($config['dns_cache_timeout']) && is_numeric($config['dns_cache_timeout']) && $config['dns_cache_timeout'] >= -1) {
621+
$curlOptions[CURLOPT_DNS_CACHE_TIMEOUT] = (int) $config['dns_cache_timeout'];
622+
}
623+
619624
// Timeout
620625
$curlOptions[CURLOPT_TIMEOUT_MS] = (float) $config['timeout'] * 1000;
621626

‎tests/system/HTTP/CURLRequestTest.php‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
use Config\CURLRequest as ConfigCURLRequest;
2323
use CURLFile;
2424
use PHPUnit\Framework\Attributes\BackupGlobals;
25+
use PHPUnit\Framework\Attributes\DataProvider;
2526
use PHPUnit\Framework\Attributes\Group;
2627

2728
/**
@@ -1212,6 +1213,76 @@ public function testForceResolveIPUnknown(): void
12121213
$this->assertSame(\CURL_IPRESOLVE_WHATEVER, $options[CURLOPT_IPRESOLVE]);
12131214
}
12141215

1216+
/**
1217+
* @return iterable<string, array{input: int|string|null, expectedHasKey: bool, expectedValue?: int}>
1218+
*
1219+
* @see https://curl.se/libcurl/c/CURLOPT_DNS_CACHE_TIMEOUT.html
1220+
*/
1221+
public static function provideDNSCacheTimeout(): iterable
1222+
{
1223+
yield from [
1224+
'valid timeout (integer)' => [
1225+
'input' => 160,
1226+
'expectedHasKey' => true,
1227+
'expectedValue' => 160,
1228+
],
1229+
'valid timeout (numeric string)' => [
1230+
'input' => '180',
1231+
'expectedHasKey' => true,
1232+
'expectedValue' => 180,
1233+
],
1234+
'valid timeout (zero / disabled)' => [
1235+
'input' => 0,
1236+
'expectedHasKey' => true,
1237+
'expectedValue' => 0,
1238+
],
1239+
'valid timeout (zero / disabled using string)' => [
1240+
'input' => '0',
1241+
'expectedHasKey' => true,
1242+
'expectedValue' => 0,
1243+
],
1244+
'valid timeout (forever)' => [
1245+
'input' => -1,
1246+
'expectedHasKey' => true,
1247+
'expectedValue' => -1,
1248+
],
1249+
'valid timeout (forever using string)' => [
1250+
'input' => '-1',
1251+
'expectedHasKey' => true,
1252+
'expectedValue' => -1,
1253+
],
1254+
'invalid timeout (null)' => [
1255+
'input' => null,
1256+
'expectedHasKey' => false,
1257+
],
1258+
'invalid timeout (string)' => [
1259+
'input' => 'is_wrong',
1260+
'expectedHasKey' => false,
1261+
],
1262+
'invalid timeout (negative number / below -1)' => [
1263+
'input' => -2,
1264+
'expectedHasKey' => false,
1265+
],
1266+
];
1267+
}
1268+
1269+
#[DataProvider('provideDNSCacheTimeout')]
1270+
public function testDNSCacheTimeoutOption(int|string|null $input, bool $expectedHasKey, ?int $expectedValue = null): void
1271+
{
1272+
$this->request->request('POST', '/post', [
1273+
'dns_cache_timeout' => $input,
1274+
]);
1275+
1276+
$options = $this->request->curl_options;
1277+
1278+
if ($expectedHasKey) {
1279+
$this->assertArrayHasKey(CURLOPT_DNS_CACHE_TIMEOUT, $options);
1280+
$this->assertSame($expectedValue, $options[CURLOPT_DNS_CACHE_TIMEOUT]);
1281+
} else {
1282+
$this->assertArrayNotHasKey(CURLOPT_DNS_CACHE_TIMEOUT, $options);
1283+
}
1284+
}
1285+
12151286
public function testCookieOption(): void
12161287
{
12171288
$holder = SUPPORTPATH . 'HTTP/Files/CookiesHolder.txt';

‎user_guide_src/source/changelogs/v4.7.0.rst‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ Enhancements
3838
Libraries
3939
=========
4040

41+
- **CURLRequest:** Added ``dns_cache_timeout`` option to change default DNS cache timeout.
42+
- **Email:** Added support for choosing the SMTP authorization method. You can change it via ``Config\Email::$SMTPAuthMethod`` option.
43+
- **Image:** The ``ImageMagickHandler`` has been rewritten to rely solely on the PHP ``imagick`` extension.
44+
- **Image:** Added ``ImageMagickHandler::clearMetadata()`` method to remove image metadata for privacy protection.
4145
- **Time:** added methods ``Time::addCalendarMonths()`` and ``Time::subCalendarMonths()``
4246

4347
Commands
@@ -61,13 +65,6 @@ Others
6165
Model
6266
=====
6367

64-
Libraries
65-
=========
66-
67-
**Email:** Added support for choosing the SMTP authorization method. You can change it via ``Config\Email::$SMTPAuthMethod`` option.
68-
**Image:** The ``ImageMagickHandler`` has been rewritten to rely solely on the PHP ``imagick`` extension.
69-
**Image:** Added ``ImageMagickHandler::clearMetadata()`` method to remove image metadata for privacy protection.
70-
7168
Helpers and Functions
7269
=====================
7370

‎user_guide_src/source/libraries/curlrequest.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,18 @@ Allows you to pause a number of milliseconds before sending the request:
251251

252252
.. literalinclude:: curlrequest/023.php
253253

254+
dns_cache_timeout
255+
=================
256+
257+
.. versionadded:: 4.7.0
258+
259+
By default, CodeIgniter does not change the DNS Cache Timeout value (``120`` seconds). If you need to
260+
modify this value, you can do so by passing an amount of time in seconds with the ``dns_cache_timeout`` option.
261+
262+
.. literalinclude:: curlrequest/037.php
263+
264+
.. note:: Based on the `libcurl <https://curl.se/libcurl/c/CURLOPT_DNS_CACHE_TIMEOUT.html>`__ documentation, you can set to zero (``0``) to completely disable caching, or set to ``-1`` to make the cached entries remain forever.
265+
254266
form_params
255267
===========
256268

‎user_guide_src/source/libraries/curlrequest/037.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<?php
2+
3+
// Modify default DNS Cache Timeout
4+
$client->request('GET', '/', ['dns_cache_timeout' => 360]); // seconds

0 commit comments

Comments
 (0)