X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/eda9e89c55caf6a98ab57a084d1ce03e0c5fe993..refs/pull/4322/head:/tests/Entity/ExportTest.php diff --git a/tests/Entity/ExportTest.php b/tests/Entity/ExportTest.php index 32077aebc..2b5244bf0 100644 --- a/tests/Entity/ExportTest.php +++ b/tests/Entity/ExportTest.php @@ -2,10 +2,10 @@ namespace Tests\Entity; -use BookStack\Auth\Role; use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Chapter; use BookStack\Entities\Models\Page; +use BookStack\Entities\Tools\PdfGenerator; use Illuminate\Support\Facades\Storage; use Illuminate\Support\Str; use Tests\TestCase; @@ -14,7 +14,7 @@ class ExportTest extends TestCase { public function test_page_text_export() { - $page = Page::query()->first(); + $page = $this->entities->page(); $this->asEditor(); $resp = $this->get($page->getUrl('/export/plaintext')); @@ -25,7 +25,7 @@ class ExportTest extends TestCase public function test_page_pdf_export() { - $page = Page::query()->first(); + $page = $this->entities->page(); $this->asEditor(); $resp = $this->get($page->getUrl('/export/pdf')); @@ -35,7 +35,7 @@ class ExportTest extends TestCase public function test_page_html_export() { - $page = Page::query()->first(); + $page = $this->entities->page(); $this->asEditor(); $resp = $this->get($page->getUrl('/export/html')); @@ -46,7 +46,7 @@ class ExportTest extends TestCase public function test_book_text_export() { - $page = Page::query()->first(); + $page = $this->entities->page(); $book = $page->book; $this->asEditor(); @@ -59,7 +59,7 @@ class ExportTest extends TestCase public function test_book_pdf_export() { - $page = Page::query()->first(); + $page = $this->entities->page(); $book = $page->book; $this->asEditor(); @@ -70,7 +70,7 @@ class ExportTest extends TestCase public function test_book_html_export() { - $page = Page::query()->first(); + $page = $this->entities->page(); $book = $page->book; $this->asEditor(); @@ -84,7 +84,7 @@ class ExportTest extends TestCase public function test_book_html_export_shows_chapter_descriptions() { $chapterDesc = 'My custom test chapter description ' . Str::random(12); - $chapter = Chapter::query()->first(); + $chapter = $this->entities->chapter(); $chapter->description = $chapterDesc; $chapter->save(); @@ -97,7 +97,7 @@ class ExportTest extends TestCase public function test_chapter_text_export() { - $chapter = Chapter::query()->first(); + $chapter = $this->entities->chapter(); $page = $chapter->pages[0]; $this->asEditor(); @@ -110,7 +110,7 @@ class ExportTest extends TestCase public function test_chapter_pdf_export() { - $chapter = Chapter::query()->first(); + $chapter = $this->entities->chapter(); $this->asEditor(); $resp = $this->get($chapter->getUrl('/export/pdf')); @@ -120,7 +120,7 @@ class ExportTest extends TestCase public function test_chapter_html_export() { - $chapter = Chapter::query()->first(); + $chapter = $this->entities->chapter(); $page = $chapter->pages[0]; $this->asEditor(); @@ -133,41 +133,41 @@ class ExportTest extends TestCase public function test_page_html_export_contains_custom_head_if_set() { - $page = Page::query()->first(); + $page = $this->entities->page(); $customHeadContent = ''; $this->setSettings(['app-custom-head' => $customHeadContent]); $resp = $this->asEditor()->get($page->getUrl('/export/html')); - $resp->assertSee($customHeadContent); + $resp->assertSee($customHeadContent, false); } public function test_page_html_export_does_not_break_with_only_comments_in_custom_head() { - $page = Page::query()->first(); + $page = $this->entities->page(); $customHeadContent = ''; $this->setSettings(['app-custom-head' => $customHeadContent]); $resp = $this->asEditor()->get($page->getUrl('/export/html')); $resp->assertStatus(200); - $resp->assertSee($customHeadContent); + $resp->assertSee($customHeadContent, false); } public function test_page_html_export_use_absolute_dates() { - $page = Page::query()->first(); + $page = $this->entities->page(); $resp = $this->asEditor()->get($page->getUrl('/export/html')); - $resp->assertSee($page->created_at->formatLocalized('%e %B %Y %H:%M:%S')); + $resp->assertSee($page->created_at->isoFormat('D MMMM Y HH:mm:ss')); $resp->assertDontSee($page->created_at->diffForHumans()); - $resp->assertSee($page->updated_at->formatLocalized('%e %B %Y %H:%M:%S')); + $resp->assertSee($page->updated_at->isoFormat('D MMMM Y HH:mm:ss')); $resp->assertDontSee($page->updated_at->diffForHumans()); } public function test_page_export_does_not_include_user_or_revision_links() { - $page = Page::query()->first(); + $page = $this->entities->page(); $resp = $this->asEditor()->get($page->getUrl('/export/html')); $resp->assertDontSee($page->getUrl('/revisions')); @@ -177,7 +177,7 @@ class ExportTest extends TestCase public function test_page_export_sets_right_data_type_for_svg_embeds() { - $page = Page::query()->first(); + $page = $this->entities->page(); Storage::disk('local')->makeDirectory('uploads/images/gallery'); Storage::disk('local')->put('uploads/images/gallery/svg_test.svg', ''); $page->html = ''; @@ -188,12 +188,12 @@ class ExportTest extends TestCase Storage::disk('local')->delete('uploads/images/gallery/svg_test.svg'); $resp->assertStatus(200); - $resp->assertSee('first(); + $page = $this->entities->page(); Storage::disk('local')->makeDirectory('uploads/images/gallery'); Storage::disk('local')->put('uploads/images/gallery/svg_test.svg', ''); Storage::disk('local')->put('uploads/images/gallery/svg_test2.svg', ''); @@ -209,7 +209,7 @@ class ExportTest extends TestCase public function test_page_export_contained_html_image_fetches_only_run_when_url_points_to_image_upload_folder() { - $page = Page::query()->first(); + $page = $this->entities->page(); $page->html = '' . '' . ''; @@ -224,9 +224,37 @@ class ExportTest extends TestCase $storageDisk->delete('uploads/images/gallery/svg_test.svg'); $storageDisk->delete('uploads/svg_test.svg'); - $resp->assertDontSee('http://localhost/uploads/images/gallery/svg_test.svg'); + $resp->assertDontSee('http://localhost/uploads/images/gallery/svg_test.svg', false); $resp->assertSee('http://localhost/uploads/svg_test.svg'); - $resp->assertSee('src="/uploads/svg_test.svg"'); + $resp->assertSee('src="/uploads/svg_test.svg"', false); + } + + public function test_page_export_contained_html_does_not_allow_upward_traversal_with_local() + { + $contents = file_get_contents(public_path('.htaccess')); + config()->set('filesystems.images', 'local'); + + $page = $this->entities->page(); + $page->html = ''; + $page->save(); + + $resp = $this->asEditor()->get($page->getUrl('/export/html')); + $resp->assertDontSee(base64_encode($contents)); + } + + public function test_page_export_contained_html_does_not_allow_upward_traversal_with_local_secure() + { + $testFilePath = storage_path('logs/test.txt'); + config()->set('filesystems.images', 'local_secure'); + file_put_contents($testFilePath, 'I am a cat'); + + $page = $this->entities->page(); + $page->html = ''; + $page->save(); + + $resp = $this->asEditor()->get($page->getUrl('/export/html')); + $resp->assertDontSee(base64_encode('I am a cat')); + unlink($testFilePath); } public function test_exports_removes_scripts_from_custom_head() @@ -239,15 +267,15 @@ class ExportTest extends TestCase foreach ($entities as $entity) { $resp = $this->asEditor()->get($entity->getUrl('/export/html')); $resp->assertDontSee('window.donkey'); - $resp->assertDontSee('script'); + $resp->assertDontSee('assertSee('.my-test-class { color: red; }'); } } public function test_page_export_with_deleted_creator_and_updater() { - $user = $this->getViewer(['name' => 'ExportWizardTheFifth']); - $page = Page::query()->first(); + $user = $this->users->viewer(['name' => 'ExportWizardTheFifth']); + $page = $this->entities->page(); $page->created_by = $user->id; $page->updated_by = $user->id; $page->save(); @@ -261,9 +289,46 @@ class ExportTest extends TestCase $resp->assertDontSee('ExportWizardTheFifth'); } + public function test_page_pdf_export_converts_iframes_to_links() + { + $page = Page::query()->first()->forceFill([ + 'html' => '', + ]); + $page->save(); + + $pdfHtml = ''; + $mockPdfGenerator = $this->mock(PdfGenerator::class); + $mockPdfGenerator->shouldReceive('fromHtml') + ->with(\Mockery::capture($pdfHtml)) + ->andReturn(''); + $mockPdfGenerator->shouldReceive('getActiveEngine')->andReturn(PdfGenerator::ENGINE_DOMPDF); + + $this->asEditor()->get($page->getUrl('/export/pdf')); + $this->assertStringNotContainsString('iframe>', $pdfHtml); + $this->assertStringContainsString('

https://www.youtube.com/embed/ShqUjt33uOs

', $pdfHtml); + } + + public function test_page_pdf_export_opens_details_blocks() + { + $page = $this->entities->page()->forceFill([ + 'html' => '
Hello

Content!

', + ]); + $page->save(); + + $pdfHtml = ''; + $mockPdfGenerator = $this->mock(PdfGenerator::class); + $mockPdfGenerator->shouldReceive('fromHtml') + ->with(\Mockery::capture($pdfHtml)) + ->andReturn(''); + $mockPdfGenerator->shouldReceive('getActiveEngine')->andReturn(PdfGenerator::ENGINE_DOMPDF); + + $this->asEditor()->get($page->getUrl('/export/pdf')); + $this->assertStringContainsString('
first(); + $page = $this->entities->page(); $resp = $this->asEditor()->get($page->getUrl('/export/markdown')); $resp->assertStatus(200); @@ -273,7 +338,7 @@ class ExportTest extends TestCase public function test_page_markdown_export_uses_existing_markdown_if_apparent() { - $page = Page::query()->first()->forceFill([ + $page = $this->entities->page()->forceFill([ 'markdown' => '# A header', 'html' => '

Dogcat

', ]); @@ -286,7 +351,7 @@ class ExportTest extends TestCase public function test_page_markdown_export_converts_html_where_no_markdown() { - $page = Page::query()->first()->forceFill([ + $page = $this->entities->page()->forceFill([ 'markdown' => '', 'html' => '

Dogcat

Some bold text

', ]); @@ -296,33 +361,9 @@ class ExportTest extends TestCase $resp->assertSee("# Dogcat\n\nSome **bold** text"); } - public function test_page_markdown_export_does_not_convert_callouts() - { - $page = Page::query()->first()->forceFill([ - 'markdown' => '', - 'html' => '

Dogcat

Some callout text

Another line

', - ]); - $page->save(); - - $resp = $this->asEditor()->get($page->getUrl('/export/markdown')); - $resp->assertSee("# Dogcat\n\n

Some callout text

\n\nAnother line"); - } - - public function test_page_markdown_export_handles_bookstacks_wysiwyg_codeblock_format() - { - $page = Page::query()->first()->forceFill([ - 'markdown' => '', - 'html' => '

Dogcat

' . "\r\n" . '
var a = \'cat\';

Another line

', - ]); - $page->save(); - - $resp = $this->asEditor()->get($page->getUrl('/export/markdown')); - $resp->assertSee("# Dogcat\n\n```JavaScript\nvar a = 'cat';\n```\n\nAnother line"); - } - public function test_chapter_markdown_export() { - $chapter = Chapter::query()->first(); + $chapter = $this->entities->chapter(); $page = $chapter->pages()->first(); $resp = $this->asEditor()->get($chapter->getUrl('/export/markdown')); @@ -342,28 +383,83 @@ class ExportTest extends TestCase $resp->assertSee('# ' . $page->name); } + public function test_book_markdown_export_concats_immediate_pages_with_newlines() + { + /** @var Book $book */ + $book = Book::query()->whereHas('pages')->first(); + + $this->asEditor()->get($book->getUrl('/create-page')); + $this->get($book->getUrl('/create-page')); + + [$pageA, $pageB] = $book->pages()->where('chapter_id', '=', 0)->get(); + $pageA->html = '

hello tester

'; + $pageA->save(); + $pageB->name = 'The second page in this test'; + $pageB->save(); + + $resp = $this->get($book->getUrl('/export/markdown')); + $resp->assertDontSee('hello tester# The second page in this test'); + $resp->assertSee("hello tester\n\n# The second page in this test"); + } + public function test_export_option_only_visible_and_accessible_with_permission() { $book = Book::query()->whereHas('pages')->whereHas('chapters')->first(); $chapter = $book->chapters()->first(); $page = $chapter->pages()->first(); $entities = [$book, $chapter, $page]; - $user = $this->getViewer(); + $user = $this->users->viewer(); $this->actingAs($user); foreach ($entities as $entity) { $resp = $this->get($entity->getUrl()); - $resp->assertSee("/export/pdf"); + $resp->assertSee('/export/pdf'); } - /** @var Role $role */ - $this->removePermissionFromUser($user, 'content-export'); + $this->permissions->removeUserRolePermissions($user, ['content-export']); foreach ($entities as $entity) { $resp = $this->get($entity->getUrl()); - $resp->assertDontSee("/export/pdf"); - $resp = $this->get($entity->getUrl("/export/pdf")); + $resp->assertDontSee('/export/pdf'); + $resp = $this->get($entity->getUrl('/export/pdf')); $this->assertPermissionError($resp); } } + + public function test_wkhtmltopdf_only_used_when_allow_untrusted_is_true() + { + $page = $this->entities->page(); + + config()->set('snappy.pdf.binary', '/abc123'); + config()->set('app.allow_untrusted_server_fetching', false); + + $resp = $this->asEditor()->get($page->getUrl('/export/pdf')); + $resp->assertStatus(200); // Sucessful response with invalid snappy binary indicates dompdf usage. + + config()->set('app.allow_untrusted_server_fetching', true); + $resp = $this->get($page->getUrl('/export/pdf')); + $resp->assertStatus(500); // Bad response indicates wkhtml usage + } + + public function test_html_exports_contain_csp_meta_tag() + { + $entities = [ + $this->entities->page(), + $this->entities->book(), + $this->entities->chapter(), + ]; + + foreach ($entities as $entity) { + $resp = $this->asEditor()->get($entity->getUrl('/export/html')); + $this->withHtml($resp)->assertElementExists('head meta[http-equiv="Content-Security-Policy"][content*="script-src "]'); + } + } + + public function test_html_exports_contain_body_classes_for_export_identification() + { + $page = $this->entities->page(); + + $resp = $this->asEditor()->get($page->getUrl('/export/html')); + $this->withHtml($resp)->assertElementExists('body.export.export-format-html.export-engine-none'); + } }