2008-07-21 13:59:24 +02:00
|
|
|
<?php
|
|
|
|
|
|
2016-10-14 03:30:05 +02:00
|
|
|
namespace SilverStripe\View\Tests;
|
|
|
|
|
|
|
|
|
|
use SilverStripe\Control\Controller;
|
2016-08-19 00:51:35 +02:00
|
|
|
use SilverStripe\Core\Convert;
|
|
|
|
|
use SilverStripe\Dev\SapphireTest;
|
2016-10-14 03:30:05 +02:00
|
|
|
use SilverStripe\ORM\DataObject;
|
2017-06-22 12:50:45 +02:00
|
|
|
use SilverStripe\View\Requirements;
|
2016-08-19 00:51:35 +02:00
|
|
|
use SilverStripe\View\SSViewer;
|
2016-10-14 03:30:05 +02:00
|
|
|
use SilverStripe\View\Tests\SSViewerTest\SSViewerTestModel;
|
2016-12-30 00:27:20 +01:00
|
|
|
use SilverStripe\View\Tests\SSViewerTest\SSViewerTestModelController;
|
2024-09-26 06:16:04 +02:00
|
|
|
use SilverStripe\View\Tests\SSViewerTest\DummyTemplateEngine;
|
2016-06-15 06:03:16 +02:00
|
|
|
|
2017-05-11 00:17:54 +02:00
|
|
|
class SSViewerTest extends SapphireTest
|
2016-12-16 05:34:21 +01:00
|
|
|
{
|
2024-09-26 06:16:04 +02:00
|
|
|
protected $usesDatabase = false;
|
2016-12-16 05:34:21 +01:00
|
|
|
|
|
|
|
|
/**
|
2024-09-26 06:16:04 +02:00
|
|
|
* Tests for themes helper functions, ensuring they behave as defined in the RFC at
|
|
|
|
|
* https://github.com/silverstripe/silverstripe-framework/issues/5604
|
2016-12-16 05:34:21 +01:00
|
|
|
*/
|
2024-09-26 06:16:04 +02:00
|
|
|
public function testThemesHelpers()
|
2017-05-11 00:17:54 +02:00
|
|
|
{
|
2024-09-26 06:16:04 +02:00
|
|
|
// Test set_themes()
|
|
|
|
|
SSViewer::set_themes(['mytheme', '$default']);
|
|
|
|
|
$this->assertEquals(['mytheme', '$default'], SSViewer::get_themes());
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
// Ensure add_themes() prepends
|
|
|
|
|
SSViewer::add_themes(['my_more_important_theme']);
|
|
|
|
|
$this->assertEquals(['my_more_important_theme', 'mytheme', '$default'], SSViewer::get_themes());
|
2024-05-24 02:51:14 +02:00
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
// Ensure add_themes() on theme already in cascade promotes it to the top
|
|
|
|
|
SSViewer::add_themes(['mytheme']);
|
|
|
|
|
$this->assertEquals(['mytheme', 'my_more_important_theme', '$default'], SSViewer::get_themes());
|
2024-05-24 02:51:14 +02:00
|
|
|
}
|
|
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
public function testRequirementsInjected()
|
2024-05-24 02:51:14 +02:00
|
|
|
{
|
2024-09-26 06:16:04 +02:00
|
|
|
Requirements::clear();
|
2024-05-24 02:51:14 +02:00
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
try {
|
|
|
|
|
Requirements::customCSS('pretend this is real css');
|
|
|
|
|
$viewer = new SSViewer([], new DummyTemplateEngine());
|
|
|
|
|
$result1 = $viewer->process('pretend this is a model')->getValue();
|
|
|
|
|
// if we disable the requirements then we should get nothing
|
|
|
|
|
$viewer->includeRequirements(false);
|
|
|
|
|
$result2 = $viewer->process('pretend this is a model')->getValue();
|
|
|
|
|
} finally {
|
|
|
|
|
Requirements::restore();
|
2024-05-24 02:51:14 +02:00
|
|
|
}
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2017-05-11 00:17:54 +02:00
|
|
|
$this->assertEqualIgnoringWhitespace(
|
2024-09-26 06:16:04 +02:00
|
|
|
'<html><head><style type="text/css">pretend this is real css</style></head><body></body></html>',
|
|
|
|
|
$result1
|
2017-05-11 00:17:54 +02:00
|
|
|
);
|
|
|
|
|
$this->assertEqualIgnoringWhitespace(
|
2024-09-26 06:16:04 +02:00
|
|
|
'<html><head></head><body></body></html>',
|
|
|
|
|
$result2
|
2017-05-11 00:17:54 +02:00
|
|
|
);
|
|
|
|
|
}
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2017-05-11 00:17:54 +02:00
|
|
|
public function testGetTemplatesByClass()
|
|
|
|
|
{
|
|
|
|
|
$this->useTestTheme(
|
2017-05-12 05:17:23 +02:00
|
|
|
__DIR__ . '/SSViewerTest',
|
|
|
|
|
'layouttest',
|
|
|
|
|
function () {
|
2024-09-26 06:16:04 +02:00
|
|
|
// Test passing a string
|
2017-05-12 05:17:23 +02:00
|
|
|
$templates = SSViewer::get_templates_by_class(
|
|
|
|
|
SSViewerTestModelController::class,
|
|
|
|
|
'',
|
|
|
|
|
Controller::class
|
|
|
|
|
);
|
|
|
|
|
$this->assertEquals(
|
|
|
|
|
[
|
2016-12-30 00:27:20 +01:00
|
|
|
SSViewerTestModelController::class,
|
2016-12-16 05:34:21 +01:00
|
|
|
[
|
2017-05-10 06:24:30 +02:00
|
|
|
'type' => 'Includes',
|
2016-12-30 00:27:20 +01:00
|
|
|
SSViewerTestModelController::class,
|
2017-05-10 06:24:30 +02:00
|
|
|
],
|
|
|
|
|
SSViewerTestModel::class,
|
|
|
|
|
Controller::class,
|
|
|
|
|
[
|
|
|
|
|
'type' => 'Includes',
|
2016-12-30 00:27:20 +01:00
|
|
|
Controller::class,
|
2016-12-16 05:34:21 +01:00
|
|
|
],
|
2017-05-12 05:17:23 +02:00
|
|
|
],
|
|
|
|
|
$templates
|
|
|
|
|
);
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
// Test to ensure we're stopping at the base class.
|
2017-05-12 05:17:23 +02:00
|
|
|
$templates = SSViewer::get_templates_by_class(
|
|
|
|
|
SSViewerTestModelController::class,
|
|
|
|
|
'',
|
|
|
|
|
SSViewerTestModelController::class
|
|
|
|
|
);
|
|
|
|
|
$this->assertEquals(
|
|
|
|
|
[
|
2016-12-30 00:27:20 +01:00
|
|
|
SSViewerTestModelController::class,
|
2016-12-16 05:34:21 +01:00
|
|
|
[
|
2017-05-10 06:24:30 +02:00
|
|
|
'type' => 'Includes',
|
2016-12-30 00:27:20 +01:00
|
|
|
SSViewerTestModelController::class,
|
2016-12-16 05:34:21 +01:00
|
|
|
],
|
|
|
|
|
SSViewerTestModel::class,
|
2017-05-12 05:17:23 +02:00
|
|
|
],
|
|
|
|
|
$templates
|
|
|
|
|
);
|
2017-05-10 06:24:30 +02:00
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
// Make sure we can search templates by suffix.
|
2017-05-12 05:17:23 +02:00
|
|
|
$templates = SSViewer::get_templates_by_class(
|
|
|
|
|
SSViewerTestModel::class,
|
|
|
|
|
'Controller',
|
|
|
|
|
DataObject::class
|
|
|
|
|
);
|
|
|
|
|
$this->assertEquals(
|
|
|
|
|
[
|
2017-05-10 06:24:30 +02:00
|
|
|
SSViewerTestModelController::class,
|
2016-12-16 05:34:21 +01:00
|
|
|
[
|
2017-05-10 06:24:30 +02:00
|
|
|
'type' => 'Includes',
|
2016-12-30 00:27:20 +01:00
|
|
|
SSViewerTestModelController::class,
|
2017-05-10 06:24:30 +02:00
|
|
|
],
|
|
|
|
|
DataObject::class . 'Controller',
|
|
|
|
|
[
|
|
|
|
|
'type' => 'Includes',
|
2016-12-30 00:27:20 +01:00
|
|
|
DataObject::class . 'Controller',
|
2016-12-16 05:34:21 +01:00
|
|
|
],
|
2017-05-12 05:17:23 +02:00
|
|
|
],
|
|
|
|
|
$templates
|
|
|
|
|
);
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2017-05-12 05:17:23 +02:00
|
|
|
// Let's throw something random in there.
|
2021-10-27 04:39:47 +02:00
|
|
|
$this->expectException(\InvalidArgumentException::class);
|
2024-09-26 06:16:04 +02:00
|
|
|
SSViewer::get_templates_by_class('no-class');
|
2017-05-12 05:17:23 +02:00
|
|
|
}
|
2017-05-11 00:17:54 +02:00
|
|
|
);
|
|
|
|
|
}
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2017-05-11 00:17:54 +02:00
|
|
|
public function testRewriteHashlinks()
|
|
|
|
|
{
|
2017-09-21 03:42:28 +02:00
|
|
|
SSViewer::setRewriteHashLinksDefault(true);
|
2024-09-26 06:16:04 +02:00
|
|
|
$oldServerVars = $_SERVER;
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
$_SERVER['REQUEST_URI'] = '//file.com?foo"onclick="alert(\'xss\')""';
|
|
|
|
|
|
|
|
|
|
// Note that leading double slashes have been rewritten to prevent these being mis-interepreted
|
|
|
|
|
// as protocol-less absolute urls
|
|
|
|
|
$base = Convert::raw2att('/file.com?foo"onclick="alert(\'xss\')""');
|
|
|
|
|
|
|
|
|
|
$engine = new DummyTemplateEngine();
|
|
|
|
|
$engine->setOutput(
|
|
|
|
|
'<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head><base href="http://www.example.com/"></head>
|
|
|
|
|
<body>
|
|
|
|
|
<a class="external-inline" href="http://google.com#anchor">ExternalInlineLink</a>
|
|
|
|
|
<a class="external-inserted" href="http://google.com#anchor">ExternalInsertedLink</a>
|
|
|
|
|
<a class="inline" href="#anchor">InlineLink</a>
|
|
|
|
|
<a class="inserted" href="#anchor">InsertedLink</a>
|
|
|
|
|
<svg><use xlink:href="#sprite"></use></svg>
|
|
|
|
|
<body>
|
|
|
|
|
</html>'
|
|
|
|
|
);
|
|
|
|
|
$tmpl = new SSViewer([], $engine);
|
|
|
|
|
$result = $tmpl->process('pretend this is a model');
|
|
|
|
|
$this->assertStringContainsString(
|
|
|
|
|
'<a class="inserted" href="' . $base . '#anchor">InsertedLink</a>',
|
|
|
|
|
$result
|
|
|
|
|
);
|
|
|
|
|
$this->assertStringContainsString(
|
|
|
|
|
'<a class="external-inserted" href="http://google.com#anchor">ExternalInsertedLink</a>',
|
|
|
|
|
$result
|
|
|
|
|
);
|
|
|
|
|
$this->assertStringContainsString(
|
|
|
|
|
'<a class="inline" href="' . $base . '#anchor">InlineLink</a>',
|
|
|
|
|
$result
|
|
|
|
|
);
|
|
|
|
|
$this->assertStringContainsString(
|
|
|
|
|
'<a class="external-inline" href="http://google.com#anchor">ExternalInlineLink</a>',
|
|
|
|
|
$result
|
|
|
|
|
);
|
|
|
|
|
$this->assertStringContainsString(
|
|
|
|
|
'<svg><use xlink:href="#sprite"></use></svg>',
|
|
|
|
|
$result,
|
|
|
|
|
'SSTemplateParser should only rewrite anchor hrefs'
|
|
|
|
|
);
|
|
|
|
|
} finally {
|
|
|
|
|
$_SERVER = $oldServerVars;
|
|
|
|
|
}
|
2017-05-11 00:17:54 +02:00
|
|
|
}
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2017-05-11 00:17:54 +02:00
|
|
|
public function testRewriteHashlinksInPhpMode()
|
|
|
|
|
{
|
2017-09-21 03:42:28 +02:00
|
|
|
SSViewer::setRewriteHashLinksDefault('php');
|
2024-09-26 06:16:04 +02:00
|
|
|
$engine = new DummyTemplateEngine();
|
|
|
|
|
$engine->setOutput(
|
2017-05-12 05:17:23 +02:00
|
|
|
'<!DOCTYPE html>
|
2024-09-26 06:16:04 +02:00
|
|
|
<html>
|
|
|
|
|
<head><base href="http://www.example.com/"></head>
|
|
|
|
|
<body>
|
|
|
|
|
<a class="inline" href="#anchor">InlineLink</a>
|
|
|
|
|
<a class="inserted" href="#anchor">InsertedLink</a>
|
|
|
|
|
<svg><use xlink:href="#sprite"></use></svg>
|
|
|
|
|
<body>
|
|
|
|
|
</html>'
|
|
|
|
|
);
|
|
|
|
|
$tmpl = new SSViewer([], $engine);
|
|
|
|
|
$result = $tmpl->process('pretend this is a model');
|
2016-12-16 05:34:21 +01:00
|
|
|
|
2017-05-11 00:17:54 +02:00
|
|
|
$code = <<<'EOC'
|
2016-08-19 00:51:35 +02:00
|
|
|
<a class="inserted" href="<?php echo \SilverStripe\Core\Convert::raw2att(preg_replace("/^(\/)+/", "/", $_SERVER['REQUEST_URI'])); ?>#anchor">InsertedLink</a>
|
2015-10-28 23:53:44 +01:00
|
|
|
EOC;
|
2021-10-27 04:39:47 +02:00
|
|
|
$this->assertStringContainsString($code, $result);
|
|
|
|
|
$this->assertStringContainsString(
|
2017-05-12 05:17:23 +02:00
|
|
|
'<svg><use xlink:href="#sprite"></use></svg>',
|
|
|
|
|
$result,
|
|
|
|
|
'SSTemplateParser should only rewrite anchor hrefs'
|
2017-05-11 00:17:54 +02:00
|
|
|
);
|
2024-05-24 02:51:14 +02:00
|
|
|
}
|
2024-09-26 07:16:47 +02:00
|
|
|
|
2024-09-26 06:16:04 +02:00
|
|
|
private function assertEqualIgnoringWhitespace(string $a, string $b, string $message = ''): void
|
2024-09-26 07:16:47 +02:00
|
|
|
{
|
2024-09-26 06:16:04 +02:00
|
|
|
$this->assertEquals(preg_replace('/\s+/', '', $a ), preg_replace('/\s+/', '', $b), $message);
|
2024-09-26 07:16:47 +02:00
|
|
|
}
|
2009-01-04 23:20:36 +01:00
|
|
|
}
|
