mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 05:36:00 +00:00
0627efe5e9
To ensure it works with all storage types and follows the format of manually uploaded image content
547 lines
19 KiB
PHP
547 lines
19 KiB
PHP
<?php namespace Tests\Entity;
|
|
|
|
use BookStack\Entities\Tools\PageContent;
|
|
use BookStack\Entities\Models\Page;
|
|
use Tests\TestCase;
|
|
use Tests\Uploads\UsesImages;
|
|
|
|
class PageContentTest extends TestCase
|
|
{
|
|
use UsesImages;
|
|
|
|
protected $base64Jpeg = '/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=';
|
|
|
|
public function test_page_includes()
|
|
{
|
|
$page = Page::first();
|
|
$secondPage = Page::where('id', '!=', $page->id)->first();
|
|
|
|
$secondPage->html = "<p id='section1'>Hello, This is a test</p><p id='section2'>This is a second block of content</p>";
|
|
$secondPage->save();
|
|
|
|
$this->asEditor();
|
|
|
|
$pageContent = $this->get($page->getUrl());
|
|
$pageContent->assertDontSee('Hello, This is a test');
|
|
|
|
$originalHtml = $page->html;
|
|
$page->html .= "{{@{$secondPage->id}}}";
|
|
$page->save();
|
|
|
|
$pageContent = $this->get($page->getUrl());
|
|
$pageContent->assertSee('Hello, This is a test');
|
|
$pageContent->assertSee('This is a second block of content');
|
|
|
|
$page->html = $originalHtml . " Well {{@{$secondPage->id}#section2}}";
|
|
$page->save();
|
|
|
|
$pageContent = $this->get($page->getUrl());
|
|
$pageContent->assertDontSee('Hello, This is a test');
|
|
$pageContent->assertSee('Well This is a second block of content');
|
|
}
|
|
|
|
public function test_saving_page_with_includes()
|
|
{
|
|
$page = Page::first();
|
|
$secondPage = Page::where('id', '!=', $page->id)->first();
|
|
|
|
$this->asEditor();
|
|
$includeTag = '{{@' . $secondPage->id . '}}';
|
|
$page->html = '<p>' . $includeTag . '</p>';
|
|
|
|
$resp = $this->put($page->getUrl(), ['name' => $page->name, 'html' => $page->html, 'summary' => '']);
|
|
|
|
$resp->assertStatus(302);
|
|
|
|
$page = Page::find($page->id);
|
|
$this->assertStringContainsString($includeTag, $page->html);
|
|
$this->assertEquals('', $page->text);
|
|
}
|
|
|
|
public function test_page_includes_do_not_break_tables()
|
|
{
|
|
$page = Page::first();
|
|
$secondPage = Page::where('id', '!=', $page->id)->first();
|
|
|
|
$content = '<table id="table"><tbody><tr><td>test</td></tr></tbody></table>';
|
|
$secondPage->html = $content;
|
|
$secondPage->save();
|
|
|
|
$page->html = "{{@{$secondPage->id}#table}}";
|
|
$page->save();
|
|
|
|
$this->asEditor();
|
|
$pageResp = $this->get($page->getUrl());
|
|
$pageResp->assertSee($content);
|
|
}
|
|
|
|
public function test_page_includes_rendered_on_book_export()
|
|
{
|
|
$page = Page::query()->first();
|
|
$secondPage = Page::query()
|
|
->where('book_id', '!=', $page->book_id)
|
|
->first();
|
|
|
|
$content = '<p id="bkmrk-meow">my cat is awesome and scratchy</p>';
|
|
$secondPage->html = $content;
|
|
$secondPage->save();
|
|
|
|
$page->html = "{{@{$secondPage->id}#bkmrk-meow}}";
|
|
$page->save();
|
|
|
|
$this->asEditor();
|
|
$htmlContent = $this->get($page->book->getUrl('/export/html'));
|
|
$htmlContent->assertSee('my cat is awesome and scratchy');
|
|
}
|
|
|
|
public function test_page_content_scripts_removed_by_default()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
$script = 'abc123<script>console.log("hello-test")</script>abc123';
|
|
$page->html = "escape {$script}";
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertDontSee($script);
|
|
$pageView->assertSee('abc123abc123');
|
|
}
|
|
|
|
public function test_more_complex_content_script_escaping_scenarios()
|
|
{
|
|
$checks = [
|
|
"<p>Some script</p><script>alert('cat')</script>",
|
|
"<div><div><div><div><p>Some script</p><script>alert('cat')</script></div></div></div></div>",
|
|
"<p>Some script<script>alert('cat')</script></p>",
|
|
"<p>Some script <div><script>alert('cat')</script></div></p>",
|
|
"<p>Some script <script><div>alert('cat')</script></div></p>",
|
|
"<p>Some script <script><div>alert('cat')</script><script><div>alert('cat')</script></p><script><div>alert('cat')</script>",
|
|
];
|
|
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
foreach ($checks as $check) {
|
|
$page->html = $check;
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertElementNotContains('.page-content', '<script>');
|
|
$pageView->assertElementNotContains('.page-content', '</script>');
|
|
}
|
|
|
|
}
|
|
|
|
public function test_iframe_js_and_base64_urls_are_removed()
|
|
{
|
|
$checks = [
|
|
'<iframe src="javascript:alert(document.cookie)"></iframe>',
|
|
'<iframe SRC=" javascript: alert(document.cookie)"></iframe>',
|
|
'<iframe src="data:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg==" frameborder="0"></iframe>',
|
|
'<iframe src=" data:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg==" frameborder="0"></iframe>',
|
|
'<iframe srcdoc="<script>window.alert(document.cookie)</script>"></iframe>'
|
|
];
|
|
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
foreach ($checks as $check) {
|
|
$page->html = $check;
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertElementNotContains('.page-content', '<iframe>');
|
|
$pageView->assertElementNotContains('.page-content', '</iframe>');
|
|
$pageView->assertElementNotContains('.page-content', 'src=');
|
|
$pageView->assertElementNotContains('.page-content', 'javascript:');
|
|
$pageView->assertElementNotContains('.page-content', 'data:');
|
|
$pageView->assertElementNotContains('.page-content', 'base64');
|
|
}
|
|
|
|
}
|
|
|
|
public function test_javascript_uri_links_are_removed()
|
|
{
|
|
$checks = [
|
|
'<a id="xss" href="javascript:alert(document.cookie)>Click me</a>',
|
|
'<a id="xss" href="javascript: alert(document.cookie)>Click me</a>'
|
|
];
|
|
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
foreach ($checks as $check) {
|
|
$page->html = $check;
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertElementNotContains('.page-content', '<a id="xss">');
|
|
$pageView->assertElementNotContains('.page-content', 'href=javascript:');
|
|
}
|
|
}
|
|
public function test_form_actions_with_javascript_are_removed()
|
|
{
|
|
$checks = [
|
|
'<form><input id="xss" type=submit formaction=javascript:alert(document.domain) value=Submit><input></form>',
|
|
'<form ><button id="xss" formaction=javascript:alert(document.domain)>Click me</button></form>',
|
|
'<form id="xss" action=javascript:alert(document.domain)><input type=submit value=Submit></form>'
|
|
];
|
|
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
foreach ($checks as $check) {
|
|
$page->html = $check;
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertElementNotContains('.page-content', '<button id="xss"');
|
|
$pageView->assertElementNotContains('.page-content', '<input id="xss"');
|
|
$pageView->assertElementNotContains('.page-content', '<form id="xss"');
|
|
$pageView->assertElementNotContains('.page-content', 'action=javascript:');
|
|
$pageView->assertElementNotContains('.page-content', 'formaction=javascript:');
|
|
}
|
|
}
|
|
|
|
public function test_metadata_redirects_are_removed()
|
|
{
|
|
$checks = [
|
|
'<meta http-equiv="refresh" content="0; url=//external_url">',
|
|
];
|
|
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
foreach ($checks as $check) {
|
|
$page->html = $check;
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertElementNotContains('.page-content', '<meta>');
|
|
$pageView->assertElementNotContains('.page-content', '</meta>');
|
|
$pageView->assertElementNotContains('.page-content', 'content=');
|
|
$pageView->assertElementNotContains('.page-content', 'external_url');
|
|
}
|
|
}
|
|
public function test_page_inline_on_attributes_removed_by_default()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
$script = '<p onmouseenter="console.log(\'test\')">Hello</p>';
|
|
$page->html = "escape {$script}";
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertDontSee($script);
|
|
$pageView->assertSee('<p>Hello</p>');
|
|
}
|
|
|
|
public function test_more_complex_inline_on_attributes_escaping_scenarios()
|
|
{
|
|
$checks = [
|
|
'<p onclick="console.log(\'test\')">Hello</p>',
|
|
'<div>Lorem ipsum dolor sit amet.</div><p onclick="console.log(\'test\')">Hello</p>',
|
|
'<div>Lorem ipsum dolor sit amet.<p onclick="console.log(\'test\')">Hello</p></div>',
|
|
'<div><div><div><div>Lorem ipsum dolor sit amet.<p onclick="console.log(\'test\')">Hello</p></div></div></div></div>',
|
|
'<div onclick="console.log(\'test\')">Lorem ipsum dolor sit amet.</div><p onclick="console.log(\'test\')">Hello</p><div></div>',
|
|
'<a a="<img src=1 onerror=\'alert(1)\'> ',
|
|
];
|
|
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
foreach ($checks as $check) {
|
|
$page->html = $check;
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertStatus(200);
|
|
$pageView->assertElementNotContains('.page-content', 'onclick');
|
|
}
|
|
|
|
}
|
|
|
|
public function test_page_content_scripts_show_when_configured()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
config()->push('app.allow_content_scripts', 'true');
|
|
|
|
$script = 'abc123<script>console.log("hello-test")</script>abc123';
|
|
$page->html = "no escape {$script}";
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertSee($script);
|
|
$pageView->assertDontSee('abc123abc123');
|
|
}
|
|
|
|
public function test_page_inline_on_attributes_show_if_configured()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
config()->push('app.allow_content_scripts', 'true');
|
|
|
|
$script = '<p onmouseenter="console.log(\'test\')">Hello</p>';
|
|
$page->html = "escape {$script}";
|
|
$page->save();
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertSee($script);
|
|
$pageView->assertDontSee('<p>Hello</p>');
|
|
}
|
|
|
|
public function test_duplicate_ids_does_not_break_page_render()
|
|
{
|
|
$this->asEditor();
|
|
$pageA = Page::first();
|
|
$pageB = Page::query()->where('id', '!=', $pageA->id)->first();
|
|
|
|
$content = '<ul id="bkmrk-xxx-%28"></ul> <ul id="bkmrk-xxx-%28"></ul>';
|
|
$pageA->html = $content;
|
|
$pageA->save();
|
|
|
|
$pageB->html = '<ul id="bkmrk-xxx-%28"></ul> <p>{{@'. $pageA->id .'#test}}</p>';
|
|
$pageB->save();
|
|
|
|
$pageView = $this->get($pageB->getUrl());
|
|
$pageView->assertSuccessful();
|
|
}
|
|
|
|
public function test_duplicate_ids_fixed_on_page_save()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
$content = '<ul id="bkmrk-test"><li>test a</li><li><ul id="bkmrk-test"><li>test b</li></ul></li></ul>';
|
|
$pageSave = $this->put($page->getUrl(), [
|
|
'name' => $page->name,
|
|
'html' => $content,
|
|
'summary' => ''
|
|
]);
|
|
$pageSave->assertRedirect();
|
|
|
|
$updatedPage = Page::where('id', '=', $page->id)->first();
|
|
$this->assertEquals(substr_count($updatedPage->html, "bkmrk-test\""), 1);
|
|
}
|
|
|
|
public function test_anchors_referencing_non_bkmrk_ids_rewritten_after_save()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::first();
|
|
|
|
$content = '<h1 id="non-standard-id">test</h1><p><a href="#non-standard-id">link</a></p>';
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name,
|
|
'html' => $content,
|
|
'summary' => ''
|
|
]);
|
|
|
|
$updatedPage = Page::where('id', '=', $page->id)->first();
|
|
$this->assertStringContainsString('id="bkmrk-test"', $updatedPage->html);
|
|
$this->assertStringContainsString('href="#bkmrk-test"', $updatedPage->html);
|
|
}
|
|
|
|
public function test_get_page_nav_sets_correct_properties()
|
|
{
|
|
$content = '<h1 id="testa">Hello</h1><h2 id="testb">There</h2><h3 id="testc">Donkey</h3>';
|
|
$pageContent = new PageContent(new Page(['html' => $content]));
|
|
$navMap = $pageContent->getNavigation($content);
|
|
|
|
$this->assertCount(3, $navMap);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h1',
|
|
'link' => '#testa',
|
|
'text' => 'Hello',
|
|
'level' => 1,
|
|
], $navMap[0]);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h2',
|
|
'link' => '#testb',
|
|
'text' => 'There',
|
|
'level' => 2,
|
|
], $navMap[1]);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h3',
|
|
'link' => '#testc',
|
|
'text' => 'Donkey',
|
|
'level' => 3,
|
|
], $navMap[2]);
|
|
}
|
|
|
|
public function test_get_page_nav_does_not_show_empty_titles()
|
|
{
|
|
$content = '<h1 id="testa">Hello</h1><h2 id="testb"> </h2><h3 id="testc"></h3>';
|
|
$pageContent = new PageContent(new Page(['html' => $content]));
|
|
$navMap = $pageContent->getNavigation($content);
|
|
|
|
$this->assertCount(1, $navMap);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h1',
|
|
'link' => '#testa',
|
|
'text' => 'Hello'
|
|
], $navMap[0]);
|
|
}
|
|
|
|
public function test_get_page_nav_shifts_headers_if_only_smaller_ones_are_used()
|
|
{
|
|
$content = '<h4 id="testa">Hello</h4><h5 id="testb">There</h5><h6 id="testc">Donkey</h6>';
|
|
$pageContent = new PageContent(new Page(['html' => $content]));
|
|
$navMap = $pageContent->getNavigation($content);
|
|
|
|
$this->assertCount(3, $navMap);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h4',
|
|
'level' => 1,
|
|
], $navMap[0]);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h5',
|
|
'level' => 2,
|
|
], $navMap[1]);
|
|
$this->assertArrayMapIncludes([
|
|
'nodeName' => 'h6',
|
|
'level' => 3,
|
|
], $navMap[2]);
|
|
}
|
|
|
|
public function test_page_text_decodes_html_entities()
|
|
{
|
|
$page = Page::query()->first();
|
|
|
|
$this->actingAs($this->getAdmin())
|
|
->put($page->getUrl(''), [
|
|
'name' => 'Testing',
|
|
'html' => '<p>"Hello & welcome"</p>',
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertEquals('"Hello & welcome"', $page->text);
|
|
}
|
|
|
|
public function test_page_markdown_table_rendering()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::query()->first();
|
|
|
|
$content = '| Syntax | Description |
|
|
| ----------- | ----------- |
|
|
| Header | Title |
|
|
| Paragraph | Text |';
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name, 'markdown' => $content,
|
|
'html' => '', 'summary' => ''
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertStringContainsString('</tbody>', $page->html);
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertElementExists('.page-content table tbody td');
|
|
}
|
|
|
|
public function test_page_markdown_task_list_rendering()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::query()->first();
|
|
|
|
$content = '- [ ] Item a
|
|
- [x] Item b';
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name, 'markdown' => $content,
|
|
'html' => '', 'summary' => ''
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertStringContainsString('input', $page->html);
|
|
$this->assertStringContainsString('type="checkbox"', $page->html);
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertElementExists('.page-content input[type=checkbox]');
|
|
}
|
|
|
|
public function test_page_markdown_strikethrough_rendering()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::query()->first();
|
|
|
|
$content = '~~some crossed out text~~';
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name, 'markdown' => $content,
|
|
'html' => '', 'summary' => ''
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertStringMatchesFormat('%A<s%A>some crossed out text</s>%A', $page->html);
|
|
|
|
$pageView = $this->get($page->getUrl());
|
|
$pageView->assertElementExists('.page-content p > s');
|
|
}
|
|
|
|
public function test_base64_images_get_extracted_from_page_content()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::query()->first();
|
|
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name, 'summary' => '',
|
|
'html' => '<p>test<img src="data:image/jpeg;base64,'.$this->base64Jpeg.'"/></p>',
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertStringMatchesFormat('%A<p%A>test<img src="http://localhost/uploads/images/gallery/%A.jpeg">%A</p>%A', $page->html);
|
|
|
|
$matches = [];
|
|
preg_match('/src="http:\/\/localhost(.*?)"/', $page->html, $matches);
|
|
$imagePath = $matches[1];
|
|
$imageFile = public_path($imagePath);
|
|
$this->assertEquals(base64_decode($this->base64Jpeg), file_get_contents($imageFile));
|
|
|
|
$this->deleteImage($imagePath);
|
|
}
|
|
|
|
public function test_base64_images_get_extracted_when_containing_whitespace()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::query()->first();
|
|
|
|
$base64PngWithWhitespace = "iVBORw0KGg\noAAAANSUhE\tUgAAAAEAAAA BCA YAAAAfFcSJAAA\n\t ACklEQVR4nGMAAQAABQAB";
|
|
$base64PngWithoutWhitespace = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQAB';
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name, 'summary' => '',
|
|
'html' => '<p>test<img src="data:image/png;base64,'.$base64PngWithWhitespace.'"/></p>',
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertStringMatchesFormat('%A<p%A>test<img src="http://localhost/uploads/images/gallery/%A.png">%A</p>%A', $page->html);
|
|
|
|
$matches = [];
|
|
preg_match('/src="http:\/\/localhost(.*?)"/', $page->html, $matches);
|
|
$imagePath = $matches[1];
|
|
$imageFile = public_path($imagePath);
|
|
$this->assertEquals(base64_decode($base64PngWithoutWhitespace), file_get_contents($imageFile));
|
|
|
|
$this->deleteImage($imagePath);
|
|
}
|
|
|
|
public function test_base64_images_blanked_if_not_supported_extension_for_extract()
|
|
{
|
|
$this->asEditor();
|
|
$page = Page::query()->first();
|
|
|
|
$this->put($page->getUrl(), [
|
|
'name' => $page->name, 'summary' => '',
|
|
'html' => '<p>test<img src="data:image/jiff;base64,'.$this->base64Jpeg.'"/></p>',
|
|
]);
|
|
|
|
$page->refresh();
|
|
$this->assertStringContainsString('<img src=""', $page->html);
|
|
}
|
|
}
|