BookStack Code Mirror - bookstack/blobdiff - tests/Exports/ZipExportTest.php

index 6e8462f596f7ebc3b85f369471e88e1949c0b484..1310dcc24566b72bddd9bdc96d7027b665ae6ab9 100644 (file)

--- a/tests/Exports/ZipExportTest.php

+++ b/tests/Exports/ZipExportTest.php

@@ -7,6 +7,7 @@ use BookStack\Entities\Repos\BookRepo;

use BookStack\Entities\Tools\PageContent;

use BookStack\Uploads\Attachment;

use BookStack\Uploads\Image;

+use FilesystemIterator;

use Illuminate\Support\Carbon;

use Illuminate\Testing\TestResponse;

use Tests\TestCase;

@@ -40,7 +41,7 @@ class ZipExportTest extends TestCase

{

$page = $this->entities->page();

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$this->assertEquals($page->id, $zip->data['page']['id'] ?? null);

$this->assertArrayNotHasKey('book', $zip->data);

@@ -54,15 +55,35 @@ class ZipExportTest extends TestCase

$version = trim(file_get_contents(base_path('version')));

$this->assertEquals($version, $zip->data['instance']['version']);

- $instanceId = decrypt($zip->data['instance']['id_ciphertext']);

- $this->assertEquals('bookstack', $instanceId);

+ $zipInstanceId = $zip->data['instance']['id'];

+ $instanceId = setting('instance-id');

+ $this->assertNotEmpty($instanceId);

+ $this->assertEquals($instanceId, $zipInstanceId);

+ }

+ public function test_export_leaves_no_temp_files()

+ {

+ $tempDir = sys_get_temp_dir();

+ $startTempFileCount = iterator_count((new FileSystemIterator($tempDir, FilesystemIterator::SKIP_DOTS)));

+ $page = $this->entities->pageWithinChapter();

+ $this->asEditor();

+ $pageResp = $this->get($page->getUrl("/export/zip"));

+ $pageResp->streamedContent();

+ $pageResp->assertOk();

+ $this->get($page->chapter->getUrl("/export/zip"))->assertOk();

+ $this->get($page->book->getUrl("/export/zip"))->assertOk();

+ $afterTempFileCount = iterator_count((new FileSystemIterator($tempDir, FilesystemIterator::SKIP_DOTS)));

+ $this->assertEquals($startTempFileCount, $afterTempFileCount);

}

public function test_page_export()

{

$page = $this->entities->page();

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertEquals([

@@ -84,7 +105,7 @@ class ZipExportTest extends TestCase

$page->save();

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertEquals($markdown, $pageData['markdown']);

@@ -100,7 +121,7 @@ class ZipExportTest extends TestCase

]);

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertEquals([

@@ -126,7 +147,7 @@ class ZipExportTest extends TestCase

$image = Image::findOrFail($result['response']->id);

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertCount(1, $pageData['images']);

@@ -152,7 +173,7 @@ class ZipExportTest extends TestCase

$attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'PageAttachmentExport.txt', $contents, 'text/plain');

$zipResp = $this->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertCount(1, $pageData['attachments']);

@@ -182,7 +203,7 @@ class ZipExportTest extends TestCase

]);

$zipResp = $this->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertCount(1, $pageData['attachments']);

@@ -196,11 +217,11 @@ class ZipExportTest extends TestCase

public function test_book_export()

{

- $book = $this->entities->book();

+ $book = $this->entities->bookHasChaptersAndPages();

$book->tags()->saveMany(Tag::factory()->count(2)->make());

$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$this->assertArrayHasKey('book', $zip->data);

$bookData = $zip->data['book'];

@@ -222,7 +243,7 @@ class ZipExportTest extends TestCase

$coverImage = $book->cover()->first();

$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$this->assertArrayHasKey('cover', $zip->data['book']);

$coverRef = $zip->data['book']['cover'];

@@ -237,7 +258,7 @@ class ZipExportTest extends TestCase

$chapter->tags()->saveMany(Tag::factory()->count(2)->make());

$zipResp = $this->asEditor()->get($chapter->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$this->assertArrayHasKey('chapter', $zip->data);

$chapterData = $zip->data['chapter'];

@@ -249,6 +270,35 @@ class ZipExportTest extends TestCase

$this->assertCount($chapter->pages()->count(), $chapterData['pages']);

}

+ public function test_draft_pages_are_not_included()

+ {

+ $editor = $this->users->editor();

+ $entities = $this->entities->createChainBelongingToUser($editor);

+ $book = $entities['book'];

+ $page = $entities['page'];

+ $chapter = $entities['chapter'];

+ $book->tags()->saveMany(Tag::factory()->count(2)->make());

+ $page->created_by = $editor->id;

+ $page->draft = true;

+ $page->save();

+ $zipResp = $this->actingAs($editor)->get($book->getUrl("/export/zip"));

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

+ $this->assertCount(0, $zip->data['book']['chapters'][0]['pages'] ?? ['cat']);

+ $zipResp = $this->actingAs($editor)->get($chapter->getUrl("/export/zip"));

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

+ $this->assertCount(0, $zip->data['chapter']['pages'] ?? ['cat']);

+ $page->chapter_id = 0;

+ $page->save();

+ $zipResp = $this->actingAs($editor)->get($book->getUrl("/export/zip"));

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

+ $this->assertCount(0, $zip->data['book']['pages'] ?? ['cat']);

+ }

public function test_cross_reference_links_are_converted()

{

@@ -264,7 +314,7 @@ class ZipExportTest extends TestCase

$page->save();

$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$bookData = $zip->data['book'];

$chapterData = $bookData['chapters'][0];

$pageData = $chapterData['pages'][0];

@@ -292,7 +342,7 @@ class ZipExportTest extends TestCase

$chapter->save();

$zipResp = $this->get($book->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$bookData = $zip->data['book'];

$chapterData = $bookData['chapters'][0];

@@ -300,6 +350,30 @@ class ZipExportTest extends TestCase

$this->assertStringContainsString('href="[[bsexport:image:' . $image->id . ']]"', $chapterData['description_html']);

}

+ public function test_image_links_are_handled_when_using_external_storage_url()

+ {

+ $page = $this->entities->page();

+ $this->asEditor();

+ $this->files->uploadGalleryImageToPage($this, $page);

+ /** @var Image $image */

+ $image = Image::query()->where('type', '=', 'gallery')

+ ->where('uploaded_to', '=', $page->id)->first();

+ config()->set('filesystems.url', 'https://i.example.com/content');

+ $storageUrl = 'https://i.example.com/content/' . ltrim($image->path, '/');

+ $page->html = '<p><a href="' . $image->url . '">Original URL</a><a href="' . $storageUrl . '">Storage URL</a></p>';

+ $page->save();

+ $zipResp = $this->get($page->getUrl("/export/zip"));

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

+ $pageData = $zip->data['page'];

+ $ref = '[[bsexport:image:' . $image->id . ']]';

+ $this->assertStringContainsString("<a href=\"{$ref}\">Original URL</a><a href=\"{$ref}\">Storage URL</a>", $pageData['html']);

+ }

public function test_cross_reference_links_external_to_export_are_not_converted()

{

$page = $this->entities->page();

@@ -307,7 +381,7 @@ class ZipExportTest extends TestCase

$page->save();

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertStringContainsString('href="' . $page->book->getUrl() . '"', $pageData['html']);

@@ -328,7 +402,7 @@ class ZipExportTest extends TestCase

$page->save();

$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['page'];

$this->assertStringContainsString('href="[[bsexport:attachment:' . $attachment->id . ']]?open=true"', $pageData['html']);

@@ -343,35 +417,31 @@ class ZipExportTest extends TestCase

$page->save();

$zipResp = $this->asEditor()->get($chapter->getUrl("/export/zip"));

- $zip = $this->extractZipResponse($zipResp);

+ $zip = ZipTestHelper::extractFromZipResponse($zipResp);

$pageData = $zip->data['chapter']['pages'][0];

$this->assertStringContainsString("[Link to chapter]([[bsexport:chapter:{$chapter->id}]])", $pageData['markdown']);

}

- protected function extractZipResponse(TestResponse $response): ZipResultData

+ public function test_exports_rate_limited_low_for_guest_viewers()

{

- $zipData = $response->streamedContent();

- $zipFile = tempnam(sys_get_temp_dir(), 'bstest-');

+ $this->setSettings(['app-public' => 'true']);

- file_put_contents($zipFile, $zipData);

- $extractDir = tempnam(sys_get_temp_dir(), 'bstestextracted-');

- if (file_exists($extractDir)) {

- unlink($extractDir);

+ $page = $this->entities->page();

+ for ($i = 0; $i < 4; $i++) {

+ $this->get($page->getUrl("/export/zip"))->assertOk();

}

- mkdir($extractDir);

- $zip = new ZipArchive();

- $zip->open($zipFile, ZipArchive::RDONLY);

- $zip->extractTo($extractDir);

+ $this->get($page->getUrl("/export/zip"))->assertStatus(429);

+ }

- $dataJson = file_get_contents($extractDir . DIRECTORY_SEPARATOR . "data.json");

- $data = json_decode($dataJson, true);

+ public function test_exports_rate_limited_higher_for_logged_in_viewers()

+ {

+ $this->asAdmin();

- return new ZipResultData(

- $zipFile,

- $extractDir,

- $data,

- );

+ $page = $this->entities->page();

+ for ($i = 0; $i < 10; $i++) {

+ $this->get($page->getUrl("/export/zip"))->assertOk();

+ }

+ $this->get($page->getUrl("/export/zip"))->assertStatus(429);

}