yiisoft / yii-web

src/Middleware/SubFolder.php

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Web\Middleware;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Yiisoft\Aliases\Aliases;
use Yiisoft\Router\UrlGeneratorInterface;
use Yiisoft\Yii\Web\Exception\BadUriPrefixException;

use function strlen;

/**
 * This middleware supports routing when webroot is not the same folder as public
 */
final class SubFolder implements MiddlewareInterface
{
    private UrlGeneratorInterface $uriGenerator;
    private Aliases $aliases;
    private ?string $prefix;
    private ?string $alias;

    public function __construct(
        UrlGeneratorInterface $uriGenerator,
        Aliases $aliases,
        ?string $prefix = null,
        ?string $alias = null
    ) {
        $this->uriGenerator = $uriGenerator;
        $this->aliases = $aliases;
        $this->prefix = $prefix;
        $this->alias = $alias;
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $uri = $request->getUri();
        $path = $uri->getPath();
        $prefix = $this->prefix;
        $auto = $prefix === null;
        $length = $auto ? 0 : strlen($prefix);

        if ($auto) {
            // automatically checks that the project is in a subfolder
            // and URI contains a prefix
            $scriptName = $request->getServerParams()['SCRIPT_NAME'];
            if (strpos($scriptName, '/', 1) !== false) {
                $tmpPrefix = substr($scriptName, 0, strrpos($scriptName, '/'));
                if (strpos($path, $tmpPrefix) === 0) {
                    $prefix = $tmpPrefix;
                    $length = strlen($prefix);
                }
            }
        } elseif ($length > 0) {
            if ($prefix[-1] === '/') {
                throw new BadUriPrefixException('Wrong URI prefix value');
            }
            if (strpos($path, $prefix) !== 0) {
                throw new BadUriPrefixException('URI prefix does not match');
            }
        }

        if ($length > 0) {
            $newPath = substr($path, $length);
            if ($newPath === '') {
                $newPath = '/';
            }
            if ($newPath[0] !== '/') {
                if (!$auto) {
                    throw new BadUriPrefixException('URI prefix does not match completely');
                }
            } else {
                $request = $request->withUri($uri->withPath($newPath));
                $this->uriGenerator->setUriPrefix($prefix);

It seems like $prefix can also be of type null; however, parameter $name of Yiisoft\Router\UrlGeneratorInterface::setUriPrefix() does only seem to accept string, maybe add an additional type check?

                if ($this->alias !== null) {
                    $this->aliases->set($this->alias, $prefix . '/');
                }
            }
        }

        return $handler->handle($request);
    }
}