'; protected function setUp(): void { parent::setUp(); Director::config()->set('alternate_base_folder', __DIR__ . '/SSViewerTest'); Director::config()->set('alternate_base_url', 'http://www.mysite.com/basedir/'); Director::config()->set('alternate_public_dir', 'public'); // Enforce public dir // Add public as a theme in itself SSViewer::set_themes([SSViewer::PUBLIC_THEME, SSViewer::DEFAULT_THEME]); TestAssetStore::activate('RequirementsTest'); // Set backend root to /RequirementsTest $this->oldThemeResourceLoader = ThemeResourceLoader::inst(); } protected function tearDown(): void { ThemeResourceLoader::set_instance($this->oldThemeResourceLoader); TestAssetStore::reset(); parent::tearDown(); } public function testExternalUrls() { /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $backend->setCombinedFilesEnabled(true); $backend->javascript('http://www.mydomain.com/test.js'); $backend->javascript('https://www.mysecuredomain.com/test.js'); $backend->javascript('//scheme-relative.example.com/test.js'); $backend->javascript('http://www.mydomain.com:3000/test.js'); $backend->css('http://www.mydomain.com/test.css'); $backend->css('https://www.mysecuredomain.com/test.css'); $backend->css('//scheme-relative.example.com/test.css'); $backend->css('http://www.mydomain.com:3000/test.css'); $html = $backend->includeInHTML(RequirementsTest::$html_template); $this->assertStringContainsString('http://www.mydomain.com/test.js', $html, 'Load external javascript URL'); $this->assertStringContainsString('https://www.mysecuredomain.com/test.js', $html, 'Load external secure javascript URL'); $this->assertStringContainsString('//scheme-relative.example.com/test.js', $html, 'Load external scheme-relative JS'); $this->assertStringContainsString('http://www.mydomain.com:3000/test.js', $html, 'Load external with port'); $this->assertStringContainsString('http://www.mydomain.com/test.css', $html, 'Load external CSS URL'); $this->assertStringContainsString('https://www.mysecuredomain.com/test.css', $html, 'Load external secure CSS URL'); $this->assertStringContainsString('//scheme-relative.example.com/test.css', $html, 'Load scheme-relative CSS URL'); $this->assertStringContainsString('http://www.mydomain.com:3000/test.css', $html, 'Load external with port'); } public function testResolveCSSReferencesDisabled() { /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $this->setupRequirements($backend); Config::forClass(get_class($backend))->set('resolve_relative_css_refs', false); $backend->combineFiles( 'RequirementsTest_pc.css', [ 'css/RequirementsTest_d.css', 'css/deep/deeper/RequirementsTest_p.css' ] ); $backend->includeInHTML(RequirementsTest::$html_template); // we get the file path here $allCSS = $backend->getCSS(); $this->assertCount( 1, $allCSS, 'only one combined file' ); $files = array_keys($allCSS); $combinedFileName = $files[0]; $combinedFileName = str_replace('/' . ASSETS_DIR . '/', '/', $combinedFileName); $combinedFilePath = TestAssetStore::base_path() . $combinedFileName; $content = file_get_contents($combinedFilePath); /* DISABLED COMBINED CSS URL RESOLVER IGNORED ONE DOT */ $this->assertStringContainsString( ".p0 { background: url(./zero.gif); }", $content, 'disabled combined css url resolver ignored one dot' ); /* DISABLED COMBINED CSS URL RESOLVER IGNORED DOUBLE-DOT */ $this->assertStringContainsString( ".p1 { background: url(../one.gif); }", $content, 'disabled combined css url resolver ignored double-dot' ); } public function testResolveCSSReferences() { /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $this->setupRequirements($backend); Config::forClass(get_class($backend))->set('resolve_relative_css_refs', true); $backend->combineFiles( 'RequirementsTest_pc.css', [ 'css/RequirementsTest_d.css', 'css/deep/deeper/RequirementsTest_p.css' ] ); $backend->includeInHTML(RequirementsTest::$html_template); // we get the file path here $allCSS = $backend->getCSS(); $this->assertCount( 1, $allCSS, 'only one combined file' ); $files = array_keys($allCSS); $combinedFileName = $files[0]; $combinedFileName = str_replace('/' . ASSETS_DIR . '/', '/', $combinedFileName); $combinedFilePath = TestAssetStore::base_path() . $combinedFileName; /* COMBINED JAVASCRIPT FILE EXISTS */ $this->assertTrue( file_exists($combinedFilePath), 'combined css file exists' ); $content = file_get_contents($combinedFilePath); /* COMBINED CSS URL RESOLVER IGNORE FULL URLS */ $this->assertStringContainsString( ".url { background: url(http://example.com/zero.gif); }", $content, 'combined css url resolver ignore full urls' ); /* COMBINED CSS URL RESOLVER DECODED ONE DOT */ $this->assertStringContainsString( ".p0 { background: url(/css/deep/deeper/zero.gif); }", $content, 'combined css url resolver decoded one dot' ); /* COMBINED CSS URL RESOLVER DECODED NO DOTS */ $this->assertStringContainsString( ".p0-plain { background: url(/css/deep/deeper/zero.gif); }", $content, 'combined css url resolver decoded no dots' ); /* COMBINED CSS URL RESOLVER DAMAGED A QUERYSTRING */ $this->assertStringContainsString( ".p0-qs { background: url(/css/deep/deeper/zero.gif?some=param); }", $content, 'combined css url resolver damaged a querystring' ); /* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH SINGLE QUOTES */ $this->assertStringContainsString( ".p0sq { background: url('/css/deep/deeper/zero-sq.gif'); }", $content, 'combined css url resolver decoded one dot with single quotes' ); /* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES */ $this->assertStringContainsString( ".p0dq { background: url(\"/css/deep/deeper/zero-dq.gif\"); }", $content, 'combined css url resolver decoded one dot with double quotes' ); /* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES AND SPACES NEW LINE */ $this->assertStringContainsString( "\n \"/css/deep/deeper/zero-dq-nls.gif\"\n", $content, 'combined css url resolver decoded one dot with double quotes and spaces new line' ); /* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES NEW LINE */ $this->assertStringContainsString( "\"/css/deep/deeper/zero-dq-nl.gif\"", $content, 'combined css url resolver decoded one dot with double quotes new line' ); /* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES NEW LINE WITH SPACES */ $this->assertStringContainsString( "\"/css/deep/deeper/zero-dq-nls.gif\"", $content, 'combined css url resolver decoded one dot with double quotes new line with spaces' ); /* COMBINED CSS URL RESOLVER DECODED 1 DOUBLE-DOT */ $this->assertStringContainsString( ".p1 { background: url(/css/deep/one.gif); }", $content, 'combined css url resolver decoded 1 double-dot' ); /* COMBINED CSS URL RESOLVER DECODED 2 DOUBLE-DOT */ $this->assertStringContainsString( ".p2 { background: url(/css/two.gif); }", $content, 'combined css url resolver decoded 2 double-dot' ); /* COMBINED CSS URL RESOLVER DECODED 2 DOUBLE-DOT SINGLE QUOTES */ $this->assertStringContainsString( ".p2sq { background: url('/css/two-sq.gif'); }", $content, 'combined css url resolver decoded 2 double-dot single quotes' ); /* COMBINED CSS URL RESOLVER DECODED 2 DOUBLE-DOT DOUBLE QUOTES */ $this->assertStringContainsString( ".p2dq { background: url(\"/css/two-dq.gif\"); }", $content, 'combined css url resolver decoded 2 double-dot double quotes' ); /* COMBINED CSS URL RESOLVER SHOULD NOT TOUCH ABSOLUTE PATH */ $this->assertStringContainsString( ".p2abs { background: url(/foo/bar/../../two-abs.gif); }", $content, 'combined css url resolver should not touch absolute path' ); /* COMBINED CSS URL RESOLVER SHOULD NOT TOUCH ABSOLUTE PATH ON NEW LINE */ $this->assertStringContainsString( "\n /foo/bar/../../two-abs-ln.gif\n", $content, 'combined css url resolver should not touch absolute path on new line' ); /* COMBINED CSS URL RESOLVER DECODED 3 DOUBLE-DOT */ $this->assertStringContainsString( ".p3 { background: url(/three.gif); }", $content, 'combined css url resolver decoded 3 double-dot' ); /* COMBINED CSS URL RESOLVER DECODED 4 DOUBLE-DOT WHEN ONLY 3 LEVELS AVAILABLE*/ $this->assertStringContainsString( ".p4 { background: url(/four.gif); }", $content, 'combined css url resolver decoded 4 double-dot when only 3 levels available' ); /* COMBINED CSS URL RESOLVER MODIFIED AN ARBITRARY VALUE */ $this->assertStringContainsString( ".weird { content: \"./keepme.gif\"; }", $content, 'combined css url resolver modified an arbitrary value' ); } /** * Setup new backend * * @param Requirements_Backend $backend */ protected function setupRequirements($backend) { // Flush requirements $backend->clear(); $backend->clearCombinedFiles(); $backend->setCombinedFilesFolder('_combinedfiles'); $backend->setCombinedFilesEnabled(true); Requirements::flush(); } /** * Setup combined and non-combined js with the backend * * @param Requirements_Backend $backend */ protected function setupCombinedRequirements($backend) { $this->setupRequirements($backend); // require files normally (e.g. called from a FormField instance) $backend->javascript('javascript/RequirementsTest_a.js'); $backend->javascript('javascript/RequirementsTest_b.js'); $backend->javascript('javascript/RequirementsTest_c.js'); // Public resources may or may not be specified with `public/` prefix $backend->javascript('javascript/RequirementsTest_d.js'); $backend->javascript('public/javascript/RequirementsTest_e.js'); // require two of those files as combined includes $backend->combineFiles( 'RequirementsTest_bc.js', [ 'javascript/RequirementsTest_b.js', 'javascript/RequirementsTest_c.js' ] ); } /** * Setup combined files with the backend * * @param Requirements_Backend $backend */ protected function setupCombinedNonrequiredRequirements($backend) { $this->setupRequirements($backend); // require files as combined includes $backend->combineFiles( 'RequirementsTest_bc.js', [ 'javascript/RequirementsTest_b.js', 'javascript/RequirementsTest_c.js' ] ); } /** * @param Requirements_Backend $backend * @param bool $async * @param bool $defer */ protected function setupCombinedRequirementsJavascriptAsyncDefer($backend, $async, $defer) { $this->setupRequirements($backend); // require files normally (e.g. called from a FormField instance) $backend->javascript('javascript/RequirementsTest_a.js'); $backend->javascript('javascript/RequirementsTest_b.js'); $backend->javascript('javascript/RequirementsTest_c.js'); // require two of those files as combined includes $backend->combineFiles( 'RequirementsTest_bc.js', [ 'javascript/RequirementsTest_b.js', 'javascript/RequirementsTest_c.js' ], [ 'async' => $async, 'defer' => $defer, ] ); } public function testCustomType() { /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $this->setupRequirements($backend); // require files normally (e.g. called from a FormField instance) $backend->javascript( 'javascript/RequirementsTest_a.js', [ 'type' => 'application/json' ] ); $backend->javascript('javascript/RequirementsTest_b.js'); $result = $backend->includeInHTML(RequirementsTest::$html_template); $this->assertMatchesRegularExpression( '#\n", $html); } public function testIncludedJsIsNotCommentedOut() { $template = ''; /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $this->setupRequirements($backend); $backend->javascript('javascript/RequirementsTest_a.js'); $html = $backend->includeInHTML($template); //wiping out commented-out html $html = preg_replace('//Uis', '', $html ?? ''); $this->assertStringContainsString("RequirementsTest_a.js", $html); } public function testCommentedOutScriptTagIsIgnored() { /// Disable nonce $urlGenerator = new SimpleResourceURLGenerator(); Injector::inst()->registerService($urlGenerator, ResourceURLGenerator::class); $template = '' . '

more content

'; /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $this->setupRequirements($backend); $src = 'javascript/RequirementsTest_a.js'; $backend->javascript($src); $html = $backend->includeInHTML($template); $urlSrc = $urlGenerator->urlForResource($src); $this->assertEquals( '' . '

more content

\n", $html ); } public function testForceJsToBottom() { /** @var Requirements_Backend $backend */ $backend = Injector::inst()->create(Requirements_Backend::class); $this->setupRequirements($backend); $backend->javascript('http://www.mydomain.com/test.js'); $backend->customScript( <<<'EOS' var globalvar = { pattern: '\\$custom\\1' }; EOS ); // Test matching with HTML5
tags as well $template = '
My header

Body

'; // The expected outputs $expectedScripts = "\n" . "\n"; $JsInHead = "$expectedScripts
My header

Body

"; $JsInBody = "
My header

Body$expectedScripts

"; $JsAtEnd = "
My header

Body

$expectedScripts"; // Test if the script is before the head tag, not before the body. // Expected: $JsInHead $backend->setWriteJavascriptToBody(false); $backend->setForceJSToBottom(false); $html = $backend->includeInHTML($template); $this->assertNotEquals($JsInBody, $html); $this->assertNotEquals($JsAtEnd, $html); $this->assertEquals($JsInHead, $html); // Test if the script is before the first #s", $html, 'customScript is displaying latest write' ); $this->assertDoesNotMatchRegularExpression( "##s", $html, 'customScript is correctly not displaying original write' ); /* customScriptWithAttributes is overwritten by customScript */ $this->assertMatchesRegularExpression( "##s", $html, 'customScript is displaying latest write and clearing attributes' ); $this->assertDoesNotMatchRegularExpression( "##s", $html, 'customScript is displaying latest write' ); /* customCSS is overwritten */ $this->assertMatchesRegularExpression( "##", $html, 'customCSS is displaying latest write' ); $this->assertDoesNotMatchRegularExpression( "##", $html, 'customCSS is correctly not displaying original write' ); /* Head Tags is overwritten */ $this->assertMatchesRegularExpression( '#Override#', $html, 'Head Tag is displaying latest write' ); $this->assertDoesNotMatchRegularExpression( '#Do Not Display#', $html, 'Head Tag is correctly not displaying original write' ); } }