HtaccessTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\System;

use Drupal\Tests\BrowserTestBase;

/**
 * Tests .htaccess is working correctly.
 *
 * @group system
 */
class HtaccessTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'path',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Get an array of file paths for access testing.
     *
     * @return int[]
     *   An array keyed by file paths. Each value is the expected response code,
     *   for example, 200 or 403.
     */
    protected function getProtectedFiles() {
        $path = $this->getModulePath('system') . '/tests/fixtures/HtaccessTest';
        // Tests the FilesMatch directive which denies access to certain file
        // extensions.
        $file_exts_to_deny = [
            'engine',
            'inc',
            'install',
            'make',
            'module',
            'module~',
            'module.bak',
            'module.orig',
            'module.save',
            'module.swo',
            'module.swp',
            'php~',
            'php.bak',
            'php.orig',
            'php.save',
            'php.swo',
            'php.swp',
            'profile',
            'po',
            'sh',
            'sql',
            'theme',
            'twig',
            'tpl.php',
            'xtmpl',
            'yml',
        ];
        foreach ($file_exts_to_deny as $file_ext) {
            $file_paths["{$path}/access_test.{$file_ext}"] = 403;
        }
        // Tests the .htaccess file in vendor and created by a Composer script.
        // Try and access a non PHP file in the vendor directory.
        // @see Drupal\\Core\\Composer\\Composer::ensureHtaccess
        $file_paths['vendor/composer/installed.json'] = 403;
        // Tests the rewrite conditions and rule that denies access to php files.
        $file_paths['core/lib/Drupal.php'] = 403;
        $file_paths['vendor/autoload.php'] = 403;
        $file_paths['autoload.php'] = 403;
        // Test extensions that should be permitted.
        $file_exts_to_allow = [
            'php-info.txt',
        ];
        foreach ($file_exts_to_allow as $file_ext) {
            $file_paths["{$path}/access_test.{$file_ext}"] = 200;
        }
        // Ensure composer.json and composer.lock cannot be accessed.
        $file_paths["{$path}/composer.json"] = 403;
        $file_paths["{$path}/composer.lock"] = 403;
        // Ensure package.json and yarn.lock cannot be accessed.
        $file_paths["{$path}/package.json"] = 403;
        $file_paths["{$path}/yarn.lock"] = 403;
        // Ensure web server configuration files cannot be accessed.
        $file_paths["{$path}/.htaccess"] = 403;
        $file_paths["{$path}/web.config"] = 403;
        return $file_paths;
    }
    
    /**
     * Iterates over protected files and calls assertNoFileAccess().
     */
    public function testFileAccess() : void {
        foreach ($this->getProtectedFiles() as $file => $response_code) {
            $this->assertFileAccess($file, $response_code);
        }
        // Test that adding "/1" to a .php URL does not make it accessible.
        $this->drupalGet('core/lib/Drupal.php/1');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Test that it is possible to have path aliases containing .php.
        $type = $this->drupalCreateContentType();
        // Create a node aliased to test.php.
        $node = $this->drupalCreateNode([
            'title' => 'This is a node',
            'type' => $type->id(),
            'path' => '/test.php',
        ]);
        $node->save();
        $this->drupalGet('test.php');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('This is a node');
        // Update node's alias to test.php/test.
        $node->path = '/test.php/test';
        $node->save();
        $this->drupalGet('test.php/test');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('This is a node');
    }
    
    /**
     * Asserts that a file exists and requesting it returns a specific response.
     *
     * @param string $path
     *   Path to file. Without leading slash.
     * @param int $response_code
     *   The expected response code. For example: 200, 403 or 404.
     *
     * @internal
     */
    protected function assertFileAccess(string $path, int $response_code) : void {
        $this->assertFileExists(\Drupal::root() . '/' . $path);
        $this->drupalGet($path);
        $this->assertEquals($response_code, $this->getSession()
            ->getStatusCode(), "Response code to {$path} should be {$response_code}");
    }
    
    /**
     * Tests that SVGZ files are served with Content-Encoding: gzip.
     */
    public function testSvgzContentEncoding() : void {
        $this->drupalGet('core/modules/system/tests/logo.svgz');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Use x-encoded-content-encoding because of Content-Encoding responses
        // (gzip, deflate, etc.) are automatically decoded by Guzzle.
        $this->assertSession()
            ->responseHeaderEquals('x-encoded-content-encoding', 'gzip');
    }

}