3 namespace Tests\Entity;
5 use BookStack\Entities\Models\Page;
6 use BookStack\Entities\Tools\PageContent;
8 use Tests\Uploads\UsesImages;
10 class PageContentTest extends TestCase
14 protected $base64Jpeg = '/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=';
16 public function test_page_includes()
18 $page = Page::query()->first();
19 $secondPage = Page::query()->where('id', '!=', $page->id)->first();
21 $secondPage->html = "<p id='section1'>Hello, This is a test</p><p id='section2'>This is a second block of content</p>";
26 $pageContent = $this->get($page->getUrl());
27 $pageContent->assertDontSee('Hello, This is a test');
29 $originalHtml = $page->html;
30 $page->html .= "{{@{$secondPage->id}}}";
33 $pageContent = $this->get($page->getUrl());
34 $pageContent->assertSee('Hello, This is a test');
35 $pageContent->assertSee('This is a second block of content');
37 $page->html = $originalHtml . " Well {{@{$secondPage->id}#section2}}";
40 $pageContent = $this->get($page->getUrl());
41 $pageContent->assertDontSee('Hello, This is a test');
42 $pageContent->assertSee('Well This is a second block of content');
45 public function test_saving_page_with_includes()
47 $page = Page::query()->first();
48 $secondPage = Page::query()->where('id', '!=', $page->id)->first();
51 $includeTag = '{{@' . $secondPage->id . '}}';
52 $page->html = '<p>' . $includeTag . '</p>';
54 $resp = $this->put($page->getUrl(), ['name' => $page->name, 'html' => $page->html, 'summary' => '']);
56 $resp->assertStatus(302);
58 $page = Page::find($page->id);
59 $this->assertStringContainsString($includeTag, $page->html);
60 $this->assertEquals('', $page->text);
63 public function test_page_includes_do_not_break_tables()
65 $page = Page::query()->first();
66 $secondPage = Page::query()->where('id', '!=', $page->id)->first();
68 $content = '<table id="table"><tbody><tr><td>test</td></tr></tbody></table>';
69 $secondPage->html = $content;
72 $page->html = "{{@{$secondPage->id}#table}}";
76 $pageResp = $this->get($page->getUrl());
77 $pageResp->assertSee($content, false);
80 public function test_page_includes_rendered_on_book_export()
82 $page = Page::query()->first();
83 $secondPage = Page::query()
84 ->where('book_id', '!=', $page->book_id)
87 $content = '<p id="bkmrk-meow">my cat is awesome and scratchy</p>';
88 $secondPage->html = $content;
91 $page->html = "{{@{$secondPage->id}#bkmrk-meow}}";
95 $htmlContent = $this->get($page->book->getUrl('/export/html'));
96 $htmlContent->assertSee('my cat is awesome and scratchy');
99 public function test_page_content_scripts_removed_by_default()
102 $page = Page::query()->first();
103 $script = 'abc123<script>console.log("hello-test")</script>abc123';
104 $page->html = "escape {$script}";
107 $pageView = $this->get($page->getUrl());
108 $pageView->assertStatus(200);
109 $pageView->assertDontSee($script, false);
110 $pageView->assertSee('abc123abc123');
113 public function test_more_complex_content_script_escaping_scenarios()
116 "<p>Some script</p><script>alert('cat')</script>",
117 "<div><div><div><div><p>Some script</p><script>alert('cat')</script></div></div></div></div>",
118 "<p>Some script<script>alert('cat')</script></p>",
119 "<p>Some script <div><script>alert('cat')</script></div></p>",
120 "<p>Some script <script><div>alert('cat')</script></div></p>",
121 "<p>Some script <script><div>alert('cat')</script><script><div>alert('cat')</script></p><script><div>alert('cat')</script>",
125 $page = Page::query()->first();
127 foreach ($checks as $check) {
128 $page->html = $check;
131 $pageView = $this->get($page->getUrl());
132 $pageView->assertStatus(200);
133 $pageView->assertElementNotContains('.page-content', '<script>');
134 $pageView->assertElementNotContains('.page-content', '</script>');
138 public function test_js_and_base64_src_urls_are_removed()
141 '<iframe src="javascript:alert(document.cookie)"></iframe>',
142 '<iframe src="JavAScRipT:alert(document.cookie)"></iframe>',
143 '<iframe src="JavAScRipT:alert(document.cookie)"></iframe>',
144 '<iframe SRC=" javascript: alert(document.cookie)"></iframe>',
145 '<iframe src="data:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg==" frameborder="0"></iframe>',
146 '<iframe src="DaTa:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg==" frameborder="0"></iframe>',
147 '<iframe src=" data:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg==" frameborder="0"></iframe>',
148 '<img src="javascript:alert(document.cookie)"/>',
149 '<img src="JavAScRipT:alert(document.cookie)"/>',
150 '<img src="JavAScRipT:alert(document.cookie)"/>',
151 '<img SRC=" javascript: alert(document.cookie)"/>',
152 '<img src="data:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg=="/>',
153 '<img src="DaTa:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg=="/>',
154 '<img src=" data:text/html;base64,PHNjcmlwdD5hbGVydCgnaGVsbG8nKTwvc2NyaXB0Pg=="/>',
155 '<iframe srcdoc="<script>window.alert(document.cookie)</script>"></iframe>',
156 '<iframe SRCdoc="<script>window.alert(document.cookie)</script>"></iframe>',
157 '<IMG SRC=`javascript:alert("RSnake says, \'XSS\'")`>',
161 $page = Page::query()->first();
163 foreach ($checks as $check) {
164 $page->html = $check;
167 $pageView = $this->get($page->getUrl());
168 $pageView->assertStatus(200);
169 $pageView->assertElementNotContains('.page-content', '<iframe>');
170 $pageView->assertElementNotContains('.page-content', '<img');
171 $pageView->assertElementNotContains('.page-content', '</iframe>');
172 $pageView->assertElementNotContains('.page-content', 'src=');
173 $pageView->assertElementNotContains('.page-content', 'javascript:');
174 $pageView->assertElementNotContains('.page-content', 'data:');
175 $pageView->assertElementNotContains('.page-content', 'base64');
179 public function test_javascript_uri_links_are_removed()
182 '<a id="xss" href="javascript:alert(document.cookie)>Click me</a>',
183 '<a id="xss" href="javascript: alert(document.cookie)>Click me</a>',
184 '<a id="xss" href="JaVaScRiPt: alert(document.cookie)>Click me</a>',
185 '<a id="xss" href=" JaVaScRiPt: alert(document.cookie)>Click me</a>',
189 $page = Page::query()->first();
191 foreach ($checks as $check) {
192 $page->html = $check;
195 $pageView = $this->get($page->getUrl());
196 $pageView->assertStatus(200);
197 $pageView->assertElementNotContains('.page-content', '<a id="xss"');
198 $pageView->assertElementNotContains('.page-content', 'href=javascript:');
202 public function test_form_actions_with_javascript_are_removed()
205 '<form><input id="xss" type=submit formaction=javascript:alert(document.domain) value=Submit><input></form>',
206 '<form ><button id="xss" formaction="JaVaScRiPt:alert(document.domain)">Click me</button></form>',
207 '<form ><button id="xss" formaction=javascript:alert(document.domain)>Click me</button></form>',
208 '<form id="xss" action=javascript:alert(document.domain)><input type=submit value=Submit></form>',
209 '<form id="xss" action="JaVaScRiPt:alert(document.domain)"><input type=submit value=Submit></form>',
213 $page = Page::query()->first();
215 foreach ($checks as $check) {
216 $page->html = $check;
219 $pageView = $this->get($page->getUrl());
220 $pageView->assertStatus(200);
221 $pageView->assertElementNotContains('.page-content', '<button id="xss"');
222 $pageView->assertElementNotContains('.page-content', '<input id="xss"');
223 $pageView->assertElementNotContains('.page-content', '<form id="xss"');
224 $pageView->assertElementNotContains('.page-content', 'action=javascript:');
225 $pageView->assertElementNotContains('.page-content', 'formaction=javascript:');
229 public function test_metadata_redirects_are_removed()
232 '<meta http-equiv="refresh" content="0; url=//external_url">',
233 '<meta http-equiv="refresh" ConTeNt="0; url=//external_url">',
234 '<meta http-equiv="refresh" content="0; UrL=//external_url">',
238 $page = Page::query()->first();
240 foreach ($checks as $check) {
241 $page->html = $check;
244 $pageView = $this->get($page->getUrl());
245 $pageView->assertStatus(200);
246 $pageView->assertElementNotContains('.page-content', '<meta>');
247 $pageView->assertElementNotContains('.page-content', '</meta>');
248 $pageView->assertElementNotContains('.page-content', 'content=');
249 $pageView->assertElementNotContains('.page-content', 'external_url');
253 public function test_page_inline_on_attributes_removed_by_default()
256 $page = Page::query()->first();
257 $script = '<p onmouseenter="console.log(\'test\')">Hello</p>';
258 $page->html = "escape {$script}";
261 $pageView = $this->get($page->getUrl());
262 $pageView->assertStatus(200);
263 $pageView->assertDontSee($script, false);
264 $pageView->assertSee('<p>Hello</p>', false);
267 public function test_more_complex_inline_on_attributes_escaping_scenarios()
270 '<p onclick="console.log(\'test\')">Hello</p>',
271 '<p OnCliCk="console.log(\'test\')">Hello</p>',
272 '<div>Lorem ipsum dolor sit amet.</div><p onclick="console.log(\'test\')">Hello</p>',
273 '<div>Lorem ipsum dolor sit amet.<p onclick="console.log(\'test\')">Hello</p></div>',
274 '<div><div><div><div>Lorem ipsum dolor sit amet.<p onclick="console.log(\'test\')">Hello</p></div></div></div></div>',
275 '<div onclick="console.log(\'test\')">Lorem ipsum dolor sit amet.</div><p onclick="console.log(\'test\')">Hello</p><div></div>',
276 '<a a="<img src=1 onerror=\'alert(1)\'> ',
277 '\<a onclick="alert(document.cookie)"\>xss link\</a\>',
281 $page = Page::query()->first();
283 foreach ($checks as $check) {
284 $page->html = $check;
287 $pageView = $this->get($page->getUrl());
288 $pageView->assertStatus(200);
289 $pageView->assertElementNotContains('.page-content', 'onclick');
293 public function test_page_content_scripts_show_when_configured()
296 $page = Page::query()->first();
297 config()->push('app.allow_content_scripts', 'true');
299 $script = 'abc123<script>console.log("hello-test")</script>abc123';
300 $page->html = "no escape {$script}";
303 $pageView = $this->get($page->getUrl());
304 $pageView->assertSee($script, false);
305 $pageView->assertDontSee('abc123abc123');
308 public function test_svg_xlink_hrefs_are_removed()
311 '<svg id="test" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="100" height="100"><a xlink:href="javascript:alert(document.domain)"><rect x="0" y="0" width="100" height="100" /></a></svg>',
312 '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><use xlink:href="data:application/xml;base64 ,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIj4KPGRlZnM+CjxjaXJjbGUgaWQ9InRlc3QiIHI9IjAiIGN4PSIwIiBjeT0iMCIgc3R5bGU9ImZpbGw6ICNGMDAiPgo8c2V0IGF0dHJpYnV0ZU5hbWU9ImZpbGwiIGF0dHJpYnV0ZVR5cGU9IkNTUyIgb25iZWdpbj0nYWxlcnQoZG9jdW1lbnQuZG9tYWluKScKb25lbmQ9J2FsZXJ0KCJvbmVuZCIpJyB0bz0iIzAwRiIgYmVnaW49IjBzIiBkdXI9Ijk5OXMiIC8+CjwvY2lyY2xlPgo8L2RlZnM+Cjx1c2UgeGxpbms6aHJlZj0iI3Rlc3QiLz4KPC9zdmc+#test"/></svg>',
316 $page = Page::query()->first();
318 foreach ($checks as $check) {
319 $page->html = $check;
322 $pageView = $this->get($page->getUrl());
323 $pageView->assertStatus(200);
324 $pageView->assertElementNotContains('.page-content', 'alert');
325 $pageView->assertElementNotContains('.page-content', 'xlink:href');
326 $pageView->assertElementNotContains('.page-content', 'application/xml');
330 public function test_page_inline_on_attributes_show_if_configured()
333 $page = Page::query()->first();
334 config()->push('app.allow_content_scripts', 'true');
336 $script = '<p onmouseenter="console.log(\'test\')">Hello</p>';
337 $page->html = "escape {$script}";
340 $pageView = $this->get($page->getUrl());
341 $pageView->assertSee($script, false);
342 $pageView->assertDontSee('<p>Hello</p>', false);
345 public function test_duplicate_ids_does_not_break_page_render()
348 $pageA = Page::query()->first();
349 $pageB = Page::query()->where('id', '!=', $pageA->id)->first();
351 $content = '<ul id="bkmrk-xxx-%28"></ul> <ul id="bkmrk-xxx-%28"></ul>';
352 $pageA->html = $content;
355 $pageB->html = '<ul id="bkmrk-xxx-%28"></ul> <p>{{@' . $pageA->id . '#test}}</p>';
358 $pageView = $this->get($pageB->getUrl());
359 $pageView->assertSuccessful();
362 public function test_duplicate_ids_fixed_on_page_save()
365 $page = Page::query()->first();
367 $content = '<ul id="bkmrk-test"><li>test a</li><li><ul id="bkmrk-test"><li>test b</li></ul></li></ul>';
368 $pageSave = $this->put($page->getUrl(), [
369 'name' => $page->name,
373 $pageSave->assertRedirect();
375 $updatedPage = Page::query()->where('id', '=', $page->id)->first();
376 $this->assertEquals(substr_count($updatedPage->html, 'bkmrk-test"'), 1);
379 public function test_anchors_referencing_non_bkmrk_ids_rewritten_after_save()
382 $page = Page::query()->first();
384 $content = '<h1 id="non-standard-id">test</h1><p><a href="#non-standard-id">link</a></p>';
385 $this->put($page->getUrl(), [
386 'name' => $page->name,
391 $updatedPage = Page::query()->where('id', '=', $page->id)->first();
392 $this->assertStringContainsString('id="bkmrk-test"', $updatedPage->html);
393 $this->assertStringContainsString('href="#bkmrk-test"', $updatedPage->html);
396 public function test_get_page_nav_sets_correct_properties()
398 $content = '<h1 id="testa">Hello</h1><h2 id="testb">There</h2><h3 id="testc">Donkey</h3>';
399 $pageContent = new PageContent(new Page(['html' => $content]));
400 $navMap = $pageContent->getNavigation($content);
402 $this->assertCount(3, $navMap);
403 $this->assertArrayMapIncludes([
409 $this->assertArrayMapIncludes([
415 $this->assertArrayMapIncludes([
423 public function test_get_page_nav_does_not_show_empty_titles()
425 $content = '<h1 id="testa">Hello</h1><h2 id="testb"> </h2><h3 id="testc"></h3>';
426 $pageContent = new PageContent(new Page(['html' => $content]));
427 $navMap = $pageContent->getNavigation($content);
429 $this->assertCount(1, $navMap);
430 $this->assertArrayMapIncludes([
437 public function test_get_page_nav_shifts_headers_if_only_smaller_ones_are_used()
439 $content = '<h4 id="testa">Hello</h4><h5 id="testb">There</h5><h6 id="testc">Donkey</h6>';
440 $pageContent = new PageContent(new Page(['html' => $content]));
441 $navMap = $pageContent->getNavigation($content);
443 $this->assertCount(3, $navMap);
444 $this->assertArrayMapIncludes([
448 $this->assertArrayMapIncludes([
452 $this->assertArrayMapIncludes([
458 public function test_page_text_decodes_html_entities()
460 $page = Page::query()->first();
462 $this->actingAs($this->getAdmin())
463 ->put($page->getUrl(''), [
465 'html' => '<p>"Hello & welcome"</p>',
469 $this->assertEquals('"Hello & welcome"', $page->text);
472 public function test_page_markdown_table_rendering()
475 $page = Page::query()->first();
477 $content = '| Syntax | Description |
478 | ----------- | ----------- |
480 | Paragraph | Text |';
481 $this->put($page->getUrl(), [
482 'name' => $page->name, 'markdown' => $content,
483 'html' => '', 'summary' => '',
487 $this->assertStringContainsString('</tbody>', $page->html);
489 $pageView = $this->get($page->getUrl());
490 $pageView->assertElementExists('.page-content table tbody td');
493 public function test_page_markdown_task_list_rendering()
496 $page = Page::query()->first();
498 $content = '- [ ] Item a
500 $this->put($page->getUrl(), [
501 'name' => $page->name, 'markdown' => $content,
502 'html' => '', 'summary' => '',
506 $this->assertStringContainsString('input', $page->html);
507 $this->assertStringContainsString('type="checkbox"', $page->html);
509 $pageView = $this->get($page->getUrl());
510 $pageView->assertElementExists('.page-content li.task-list-item input[type=checkbox]');
511 $pageView->assertElementExists('.page-content li.task-list-item input[type=checkbox][checked=checked]');
514 public function test_page_markdown_strikethrough_rendering()
517 $page = Page::query()->first();
519 $content = '~~some crossed out text~~';
520 $this->put($page->getUrl(), [
521 'name' => $page->name, 'markdown' => $content,
522 'html' => '', 'summary' => '',
526 $this->assertStringMatchesFormat('%A<s%A>some crossed out text</s>%A', $page->html);
528 $pageView = $this->get($page->getUrl());
529 $pageView->assertElementExists('.page-content p > s');
532 public function test_page_markdown_single_html_comment_saving()
535 $page = Page::query()->first();
537 $content = '<!-- Test Comment -->';
538 $this->put($page->getUrl(), [
539 'name' => $page->name, 'markdown' => $content,
540 'html' => '', 'summary' => '',
544 $this->assertStringMatchesFormat($content, $page->html);
546 $pageView = $this->get($page->getUrl());
547 $pageView->assertStatus(200);
548 $pageView->assertSee($content, false);
551 public function test_base64_images_get_extracted_from_page_content()
554 $page = Page::query()->first();
556 $this->put($page->getUrl(), [
557 'name' => $page->name, 'summary' => '',
558 'html' => '<p>test<img src="data:image/jpeg;base64,' . $this->base64Jpeg . '"/></p>',
562 $this->assertStringMatchesFormat('%A<p%A>test<img src="http://localhost/uploads/images/gallery/%A.jpeg">%A</p>%A', $page->html);
565 preg_match('/src="https:\/\/p.rizon.top:443\/http\/localhost(.*?)"/', $page->html, $matches);
566 $imagePath = $matches[1];
567 $imageFile = public_path($imagePath);
568 $this->assertEquals(base64_decode($this->base64Jpeg), file_get_contents($imageFile));
570 $this->deleteImage($imagePath);
573 public function test_base64_images_get_extracted_when_containing_whitespace()
576 $page = Page::query()->first();
578 $base64PngWithWhitespace = "iVBORw0KGg\noAAAANSUhE\tUgAAAAEAAAA BCA YAAAAfFcSJAAA\n\t ACklEQVR4nGMAAQAABQAB";
579 $base64PngWithoutWhitespace = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQAB';
580 $this->put($page->getUrl(), [
581 'name' => $page->name, 'summary' => '',
582 'html' => '<p>test<img src="data:image/png;base64,' . $base64PngWithWhitespace . '"/></p>',
586 $this->assertStringMatchesFormat('%A<p%A>test<img src="http://localhost/uploads/images/gallery/%A.png">%A</p>%A', $page->html);
589 preg_match('/src="https:\/\/p.rizon.top:443\/http\/localhost(.*?)"/', $page->html, $matches);
590 $imagePath = $matches[1];
591 $imageFile = public_path($imagePath);
592 $this->assertEquals(base64_decode($base64PngWithoutWhitespace), file_get_contents($imageFile));
594 $this->deleteImage($imagePath);
597 public function test_base64_images_within_html_blanked_if_not_supported_extension_for_extract()
599 // Relevant to https://github.com/BookStackApp/BookStack/issues/3010 and other cases
601 'jiff', 'pngr', 'png ', ' png', '.png', 'png.', 'p.ng', ',png',
602 'data:image/png', ',data:image/png',
605 foreach ($extensions as $extension) {
607 $page = Page::query()->first();
609 $this->put($page->getUrl(), [
610 'name' => $page->name, 'summary' => '',
611 'html' => '<p>test<img src="data:image/' . $extension . ';base64,' . $this->base64Jpeg . '"/></p>',
615 $this->assertStringContainsString('<img src=""', $page->html);
619 public function test_base64_images_get_extracted_from_markdown_page_content()
622 $page = Page::query()->first();
624 $this->put($page->getUrl(), [
625 'name' => $page->name, 'summary' => '',
626 'markdown' => 'test ',
630 $this->assertStringMatchesFormat('%A<p%A>test <img src="http://localhost/uploads/images/gallery/%A.jpeg" alt="test">%A</p>%A', $page->html);
633 preg_match('/src="https:\/\/p.rizon.top:443\/http\/localhost(.*?)"/', $page->html, $matches);
634 $imagePath = $matches[1];
635 $imageFile = public_path($imagePath);
636 $this->assertEquals(base64_decode($this->base64Jpeg), file_get_contents($imageFile));
638 $this->deleteImage($imagePath);
641 public function test_base64_images_within_markdown_blanked_if_not_supported_extension_for_extract()
644 $page = Page::query()->first();
646 $this->put($page->getUrl(), [
647 'name' => $page->name, 'summary' => '',
648 'markdown' => 'test ',
652 $this->assertStringContainsString('<img src=""', $page->html);