TYPO3 v11 - Typo3ValetDriver.php needs upgrade?

[scuba303]

hi. in the latest version of typo3 v11 the rewrite for accessing the backend changed.
https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.0/Breaking-93048-BackendURLRewrites.html

i tried to adjust the /opt/homebrew/etc/nginx/valet/valet.conf like advised in the above link.
also tried this version:
https://markus-code.com/2021/03/typo3-11-upgrade-backend-404-not-found/

ended up in
`location ~ /typo3 {
rewrite ^([^.]*[^/])$ $1/ permanent;
}

location /typo3/ {
absolute_redirect off;
try_files $uri /typo3/index.php$is_args$args;
}
`
all with the same result: 404
it might have issues with the driver?!

[Konafets]

@scuba303 You have to add a LocalValetDriver.php to the root folder of your TYPO3 installation with this content:

Note: I changed the TLD to .loc in my Valet settings.

<?php

declare(strict_types=1);

use Valet\Drivers\LaravelValetDriver;

class LocalValetDriver extends Typo3ValetDriver
{
    protected $documentRoot = '/public';

    /**
     * Determine if the driver serves the request.
     */
    public function serves($sitePath, $siteName, $uri)
    {
        return true;
    }

    /**
     * Get the fully resolved path to the application's front controller.
     */
    public function frontControllerPath($sitePath, $siteName, $uri)
    {
        // without modifying the URI, redirect if necessary
        $this->handleRedirectBackendShorthandUris($uri);

        // from now on, remove trailing / for convenience for all the following join operations
        $uri = rtrim($uri, '/');

        if (file_exists($absoluteFilePath = $sitePath.$this->documentRoot.$uri)) {
            if (is_dir($absoluteFilePath)) {
                if (file_exists($absoluteFilePath.'/index.php')) {
                    // this folder can be served by index.php
                    return $this->serveScript($sitePath, $siteName, $uri.'/index.php');
                }

                if (file_exists($absoluteFilePath.'/index.html')) {
                    // this folder can be served by index.html
                    return $absoluteFilePath.'/index.html';
                }
            } elseif (pathinfo($absoluteFilePath, PATHINFO_EXTENSION) === 'php') {
                // this file can be served directly
                return $this->serveScript($sitePath, $siteName, $uri);
            }
        } elseif(str_contains($uri, '/typo3/')) {
            return $this->serveScript($sitePath, $siteName, '/typo3/index.php');
        }

        return $this->serveScript($sitePath, $siteName, '/index.php');
    }

    private function handleRedirectBackendShorthandUris($uri)
    {
        if (rtrim($uri, '/') === '/typo3/install') {
            header('Location: /typo3/sysext/install/Start/Install.php');
            exit();
        }
    }

    private function serveScript($sitePath, $siteName, $uri)
    {
        $docroot = $sitePath.$this->documentRoot;
        $abspath = $docroot.$uri;

        $_SERVER['SERVER_NAME'] = $siteName.'.loc';
        $_SERVER['DOCUMENT_ROOT'] = $docroot;
        $_SERVER['DOCUMENT_URI'] = $uri;
        $_SERVER['SCRIPT_FILENAME'] = $abspath;
        $_SERVER['SCRIPT_NAME'] = $uri;
        $_SERVER['PHP_SELF'] = $uri;

        return $abspath;
    }
}

and change the corresponding Nginx file for the domain to:

server {
    listen 127.0.0.1:80;
    #listen 127.0.0.1:80; # valet loopback
    server_name example.loc www.example.loc *.example.loc;
    return 301 https://$host$request_uri;
}

server {
    listen 127.0.0.1:443 ssl http2;
    #listen 127.0.0.1:443 ssl http2; # valet loopback
    server_name example.loc www.example.loc *.example.loc;
    root /;
    charset utf-8;
    client_max_body_size 512M;
    http2_push_preload on;

    location /41c270e4-5535-4daa-b23e-c269744c2f45/ {
        internal;
        alias /;
        try_files $uri $uri/;
    }

    ssl_certificate "/Users/$USER/.config/valet/Certificates/example.crt";
    ssl_certificate_key "/Users/$USER/.config/valet/Certificates/example.key";

    location / {
        rewrite ^ "/Users/$USER/.composer/vendor/laravel/valet/server.php" last;
    }

    # Compressing resource files will save bandwidth and so improve loading speed especially for users
    # with slower internet connections. TYPO3 can compress the .js and .css files for you.
    # *) Set $GLOBALS['TYPO3_CONF_VARS']['BE']['compressionLevel'] = 9 for the Backend
    # *) Set $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] = 9 together with the TypoScript properties
    #    config.compressJs and config.compressCss for GZIP compression of Frontend JS and CSS files.
    location ~ \.js\.gzip$ {
        add_header Content-Encoding gzip;
        gzip off;
        types { text/javascript gzip; }
    }

    location ~ \.css\.gzip$ {
        add_header Content-Encoding gzip;
        gzip off;
        types { text/css gzip; }
    }

    # TYPO3 - Rule for versioned static files, configured through:
    # - $GLOBALS['TYPO3_CONF_VARS']['BE']['versionNumberInFilename']
    # - $GLOBALS['TYPO3_CONF_VARS']['FE']['versionNumberInFilename']
    if (!-e $request_filename) {
        rewrite ^/(.+)\.(\d+)\.(php|js|css|png|jpg|gif|gzip)$ /$1.$3 last;
    }

    # TYPO3 - Block access to composer files
    location ~* composer\.(?:json|lock) {
        deny all;
    }

    # TYPO3 - Block access to flexform files
    location ~* flexform[^.]*\.xml {
        deny all;
    }

    # TYPO3 - Block access to language files
    location ~* locallang[^.]*\.(?:xml|xlf)$ {
        deny all;
    }

    # TYPO3 - Block access to static typoscript files
    location ~* ext_conf_template\.txt|ext_typoscript_constants\.txt|ext_typoscript_setup\.txt {
        deny all;
    }

    # TYPO3 - Block access to miscellaneous protected files
    location ~* /.*\.(?:bak|co?nf|cfg|ya?ml|ts|typoscript|tsconfig|dist|fla|in[ci]|log|sh|sql|sqlite)$ {
        deny all;
    }

    # TYPO3 - Block access to recycler and temporary directories
    location ~ _(?:recycler|temp)_/ {
        deny all;
    }

    # TYPO3 - Block access to configuration files stored in fileadmin
    location ~ fileadmin/(?:templates)/.*\.(?:txt|ts|typoscript)$ {
        deny all;
    }

    # TYPO3 - Block access to libraries, source and temporary compiled data
    location ~ ^(?:vendor|typo3_src|typo3temp/var) {
        deny all;
    }

    # TYPO3 - Block access to protected extension directories
    location ~ (?:typo3conf/ext|typo3/sysext|typo3/ext)/[^/]+/(?:Configuration|Resources/Private|Tests?|Documentation|docs?)/ {
        deny all;
    }

    location = /typo3 {
        rewrite ^ /typo3/;
    }

    location /typo3/ {
        absolute_redirect off;
        try_files $uri /typo3/index.php$is_args$args;
    }

    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }

    access_log off;
    error_log "/Users/$USER/.config/valet/Log/nginx-error.log" debug;

    error_page 404 "/Users/$USER/.composer/vendor/laravel/valet/server.php";

    location ~ [^/]\.php(/|$) {
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass "unix:/Users/$USER/.config/valet/valet.sock";
        fastcgi_index "/Users/$USER/.composer/vendor/laravel/valet/server.php";
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME "/Users/$USER/.composer/vendor/laravel/valet/server.php";
        fastcgi_param PATH_INFO $fastcgi_path_info;
    }

    location ~ /\.ht {
        deny all;
    }
}

server {
    listen 127.0.0.1:60;
    #listen 127.0.0.1:60; # valet loopback
    server_name example.loc www.example.loc *.example.loc;
    root /;
    charset utf-8;
    client_max_body_size 128M;

    add_header X-Robots-Tag 'noindex, nofollow, nosnippet, noarchive';

    location /41c270e4-5535-4daa-b23e-c269744c2f45/ {
        internal;
        alias /;
        try_files $uri $uri/;
    }

    location / {
        rewrite ^ "/Users/$USER/.composer/vendor/laravel/valet/server.php" last;
    }

    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }

    access_log off;
    error_log "/Users/$USER/.config/valet/Log/nginx-error.log";

    error_page 404 "/Users/$USER/.composer/vendor/laravel/valet/server.php";

    location ~ [^/]\.php(/|$) {
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass "unix:/Users/$USER/.config/valet/valet.sock";
        fastcgi_index "/Users/$USER/.composer/vendor/laravel/valet/server.php";
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME "/Users/$USER/.composer/vendor/laravel/valet/server.php";
        fastcgi_param PATH_INFO $fastcgi_path_info;
    }

    location ~ /\.ht {
        deny all;
    }
}

[OliverGrimsley]

@Konafets - thank you for this - I am trying to get TYPO3 v12 up in my plain vanilla valet dev environment - had no luck - the above got me such that the "backend" is working, but now the "frontend" is the 404 "Page Not Found The page did not exist or was inaccessible. Reason: No site configuration found."

Previous to implementing the above, the frontend worked fine, but I could not access the backend, I had that same 404 error. I have spent already too much time trying to find a basic config that works - wondering if you have any ideas?

The only differences from yours: I obviously am using my valet site as the server name, and I changed .loc to .test (which is what I use). I do have it running as a secure site, so the actual SSL certs valet generated are in the server config.

I can create pages and do all the things in the backend admin, but if I go to any page I create or the base page, I get the 404. . .

[OliverGrimsley]

Apparently the install had actually not created a default configuration. Not exactly sure what I did, but went to https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/SiteHandling/CreateNew.html# and using that documentation and going to Sites in the backend tool, and saving the home default site, apparently that generated the config file, so the above files worked for me on Valet v3.3.2 and TYPO3, v12.4.7

[scuba303]

@Konafets thx for the support. moved meanwhile to MAMP pro. Much easier to handle. valet gave me sometimes a hard time with stuff breaking due to brew related updates. loved to idea of valet, but MAMP simply works (beside lack of mysql 8 Support ;-). ).

[Konafets]

@OliverGrimsley Nice to hear, that it works for you now.
@scuba303 Also nice, that you find a solution that works for you.

I still have this topic on my todo list (#1423), adding another TYPO3 driver to Valet, which supports TYPO3 v11 and above. Let see how this turns out.