refactor: current URI creation

Author: kenjis

system/Config/Services.php

@@ -38,6 +38,7 @@
 use CodeIgniter\HTTP\RequestInterface;
 use CodeIgniter\HTTP\Response;
 use CodeIgniter\HTTP\ResponseInterface;
+use CodeIgniter\HTTP\SiteURIFactory;
 use CodeIgniter\HTTP\URI;
 use CodeIgniter\HTTP\UserAgent;
 use CodeIgniter\Images\Handlers\BaseHandler;
@@ -52,6 +53,7 @@
 use CodeIgniter\Session\Handlers\Database\PostgreHandler;
 use CodeIgniter\Session\Handlers\DatabaseHandler;
 use CodeIgniter\Session\Session;
+use CodeIgniter\Superglobals;
 use CodeIgniter\Throttle\Throttler;
 use CodeIgniter\Typography\Typography;
 use CodeIgniter\Validation\Validation;
@@ -744,14 +746,21 @@ public static function toolbar(?ToolbarConfig $config = null, bool $getShared =
      *
      * @param string $uri
      *
-     * @return URI
+     * @return URI The current URI if $uri is null.
      */
     public static function uri(?string $uri = null, bool $getShared = true)
     {
         if ($getShared) {
             return static::getSharedInstance('uri', $uri);
         }
 
+        if ($uri === null) {
+            $appConfig = config(App::class);
+            $factory   = new SiteURIFactory($appConfig, new Superglobals());
+
+            return $factory->createFromGlobals();
+        }
+
         return new URI($uri);
     }
 

system/HTTP/IncomingRequest.php

@@ -175,7 +175,12 @@ public function __construct($config, ?URI $uri = null, $body = 'php://input', ?U
 
         parent::__construct($config);
 
-        $this->detectURI($config->uriProtocol, $config->baseURL);
+        if ($uri instanceof SiteURI) {
+            $this->setPath($uri->getRoutePath());
+        } else {
+            $this->setPath($uri->getPath());
+        }
+
         $this->detectLocale($config);
     }
 
@@ -227,9 +232,9 @@ public function detectLocale($config)
      * either provided by the user in the baseURL Config setting, or
      * determined from the environment as needed.
      *
-     * @deprecated $protocol and $baseURL are deprecated. No longer used.
-     *
      * @return void
+     *
+     * @deprecated No longer used.
      */
     protected function detectURI(string $protocol, string $baseURL)
     {
@@ -447,7 +452,7 @@ public function isSecure(): bool
     }
 
     /**
-     * Sets the relative path and updates the URI object.
+     * Sets the URI path relative to baseURL.
      *
      * Note: Since current_url() accesses the shared request
      * instance, this can be used to change the "current URL"
@@ -457,51 +462,13 @@ public function isSecure(): bool
      * @param App|null $config Optional alternate config to use
      *
      * @return $this
+     *
+     * @deprecated This method will be private. The parameter $config is deprecated. No longer used.
      */
     public function setPath(string $path, ?App $config = null)
     {
         $this->path = $path;
 
-        // @TODO remove this. The path of the URI object should be a full URI path,
-        //      not a URI path relative to baseURL.
-        $this->uri->setPath($path);
-
-        $config ??= $this->config;
-
-        // It's possible the user forgot a trailing slash on their
-        // baseURL, so let's help them out.
-        $baseURL = ($config->baseURL === '') ? $config->baseURL : rtrim($config->baseURL, '/ ') . '/';
-
-        // Based on our baseURL and allowedHostnames provided by the developer
-        // and HTTP_HOST, set our current domain name, scheme.
-        if ($baseURL !== '') {
-            $host = $this->determineHost($config, $baseURL);
-
-            // Set URI::$baseURL
-            $uri            = new URI($baseURL);
-            $currentBaseURL = (string) $uri->setHost($host);
-            $this->uri->setBaseURL($currentBaseURL);
-
-            $this->uri->setScheme(parse_url($baseURL, PHP_URL_SCHEME));
-            $this->uri->setHost($host);
-            $this->uri->setPort(parse_url($baseURL, PHP_URL_PORT));
-
-            // Ensure we have any query vars
-            $this->uri->setQuery($_SERVER['QUERY_STRING'] ?? '');
-
-            // Check if the scheme needs to be coerced into its secure version
-            if ($config->forceGlobalSecureRequests && $this->uri->getScheme() === 'http') {
-                $this->uri->setScheme('https');
-            }
-        } elseif (! is_cli()) {
-            // Do not change exit() to exception; Request is initialized before
-            // setting the exception handler, so if an exception is raised, an
-            // error will be displayed even if in the production environment.
-            // @codeCoverageIgnoreStart
-            exit('You have an empty or invalid baseURL. The baseURL value must be set in app/Config/App.php, or through the .env file.');
-            // @codeCoverageIgnoreEnd
-        }
-
         return $this;
     }
 
@@ -535,10 +502,6 @@ private function determineHost(App $config, string $baseURL): string
      */
     public function getPath(): string
     {
-        if ($this->path === null) {
-            $this->detectPath($this->config->uriProtocol);
-        }
-
         return $this->path;
     }
 

system/HTTP/URI.php

@@ -94,11 +94,6 @@ class URI
     /**
      * URI path.
      *
-     * Note: The constructor of the IncomingRequest class changes the path of
-     *      the URI object held by the IncomingRequest class to a path relative
-     *      to the baseURL. If the baseURL contains subfolders, this value
-     *      will be different from the current URI path.
-     *
      * @var string
      */
     protected $path;

system/Test/FeatureTestTrait.php

@@ -15,6 +15,7 @@
 use CodeIgniter\HTTP\Exceptions\RedirectException;
 use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\HTTP\Request;
+use CodeIgniter\HTTP\SiteURI;
 use CodeIgniter\HTTP\URI;
 use Config\App;
 use Config\Services;
@@ -265,15 +266,23 @@ public function options(string $path, ?array $params = null)
      */
     protected function setupRequest(string $method, ?string $path = null): IncomingRequest
     {
-        $path    = URI::removeDotSegments($path);
-        $config  = config(App::class);
-        $request = Services::request($config, false);
+        $config = config(App::class);
+        $uri    = new SiteURI($config);
 
         // $path may have a query in it
-        $parts                   = explode('?', $path);
-        $_SERVER['QUERY_STRING'] = $parts[1] ?? '';
+        $path  = URI::removeDotSegments($path);
+        $parts = explode('?', $path);
+        $path  = $parts[0];
+        $query = $parts[1] ?? '';
+
+        $_SERVER['QUERY_STRING'] = $query;
+
+        $uri->setPath($path);
+
+        Services::injectMock('uri', $uri);
+
+        $request = Services::request($config, false);
 
-        $request->setPath($parts[0]);
         $request->setMethod($method);
         $request->setProtocolVersion('1.1');
 

tests/_support/Config/Services.php

@@ -11,7 +11,10 @@
 
 namespace Tests\Support\Config;
 
+use CodeIgniter\HTTP\SiteURIFactory;
 use CodeIgniter\HTTP\URI;
+use CodeIgniter\Superglobals;
+use Config\App;
 use Config\Services as BaseServices;
 use RuntimeException;
 
@@ -41,6 +44,13 @@ public static function uri(?string $uri = null, bool $getShared = true)
             return static::getSharedInstance('uri', $uri);
         }
 
+        if ($uri === null) {
+            $appConfig = config(App::class);
+            $factory   = new SiteURIFactory($appConfig, new Superglobals());
+
+            return $factory->createFromGlobals();
+        }
+
         return new URI($uri);
     }
 }