github-mirror/BookStack
2
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-11-25 09:42:10 +08:00
Code Issues Actions 24 Packages Projects Releases Wiki Activity

ZIP Exports: Tested each type and model of export
Some checks failed
test-migrations / build (8.1) (push) Has been cancelled
Details
test-migrations / build (8.2) (push) Has been cancelled
Details
analyse-php / build (push) Has been cancelled
Details
lint-php / build (push) Has been cancelled
Details
test-migrations / build (8.3) (push) Has been cancelled
Details
test-php / build (8.1) (push) Has been cancelled
Details
test-php / build (8.2) (push) Has been cancelled
Details
test-php / build (8.3) (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Dan Brown 2024-10-27 14:33:43 +00:00
parent 484342f26a
commit d1f69feb4a
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
5 changed files with 274 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/Exports/ZipExports/Models/ZipExportAttachment.php
View File

@ -18,6 +18,7 @@ class ZipExportAttachment extends ZipExportModel
$instance = new self();
$instance->id = $model->id;
$instance->name = $model->name;
$instance->order = $model->order;
if ($model->external) {
$instance->link = $model->path;

2
app/Exports/ZipExports/ZipExportReferences.php
View File

@ -62,7 +62,7 @@ class ZipExportReferences
public function addBook(ZipExportBook $book): void
{
if ($book->id) {
$this->chapters[$book->id] = $book;
$this->books[$book->id] = $book;
}
foreach ($book->pages as $page) {

2
app/Exports/ZipExports/ZipReferenceParser.php
View File

@ -38,7 +38,7 @@ class ZipReferenceParser
public function parse(string $content, callable $handler): string
{
$escapedBase = preg_quote(url('/'), '/');
$linkRegex = "/({$escapedBase}.*?)[\\t\\n\\f>\"'=?#]/";
$linkRegex = "/({$escapedBase}.*?)[\\t\\n\\f>\"'=?#()]/";
$matches = [];
preg_match_all($linkRegex, $content, $matches);

265
tests/Exports/ZipExportTest.php
View File

@ -2,6 +2,11 @@
namespace Tests\Exports;
use BookStack\Activity\Models\Tag;
use BookStack\Entities\Repos\BookRepo;
use BookStack\Entities\Tools\PageContent;
use BookStack\Uploads\Attachment;
use BookStack\Uploads\Image;
use Illuminate\Support\Carbon;
use Illuminate\Testing\TestResponse;
use Tests\TestCase;
@ -55,17 +60,271 @@ class ZipExportTest extends TestCase
public function test_page_export()
{
// TODO
$page = $this->entities->page();
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertEquals([
'id' => $page->id,
'name' => $page->name,
'html' => (new PageContent($page))->render(),
'priority' => $page->priority,
'attachments' => [],
'images' => [],
'tags' => [],
], $pageData);
}
public function test_page_export_with_markdown()
{
$page = $this->entities->page();
$markdown = "# My page\n\nwritten in markdown for export\n";
$page->markdown = $markdown;
$page->save();
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertEquals($markdown, $pageData['markdown']);
$this->assertNotEmpty($pageData['html']);
}
public function test_page_export_with_tags()
{
$page = $this->entities->page();
$page->tags()->saveMany([
new Tag(['name' => 'Exporty', 'value' => 'Content', 'order' => 1]),
new Tag(['name' => 'Another', 'value' => '', 'order' => 2]),
]);
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertEquals([
[
'name' => 'Exporty',
'value' => 'Content',
'order' => 1,
],
[
'name' => 'Another',
'value' => '',
'order' => 2,
]
], $pageData['tags']);
}
public function test_page_export_with_images()
{
$this->asEditor();
$page = $this->entities->page();
$result = $this->files->uploadGalleryImageToPage($this, $page);
$displayThumb = $result['response']->thumbs->gallery ?? '';
$page->html = '<p><img src="' . $displayThumb . '" alt="My image"></p>';
$page->save();
$image = Image::findOrFail($result['response']->id);
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertCount(1, $pageData['images']);
$imageData = $pageData['images'][0];
$this->assertEquals($image->id, $imageData['id']);
$this->assertEquals($image->name, $imageData['name']);
$this->assertEquals('gallery', $imageData['type']);
$this->assertNotEmpty($imageData['file']);
$filePath = $zip->extractPath("files/{$imageData['file']}");
$this->assertFileExists($filePath);
$this->assertEquals(file_get_contents(public_path($image->path)), file_get_contents($filePath));
$this->assertEquals('<p><img src="[[bsexport:image:' . $imageData['id'] . ']]" alt="My image"></p>', $pageData['html']);
}
public function test_page_export_file_attachments()
{
$contents = 'My great attachment content!';
$page = $this->entities->page();
$this->asAdmin();
$attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'PageAttachmentExport.txt', $contents, 'text/plain');
$zipResp = $this->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertCount(1, $pageData['attachments']);
$attachmentData = $pageData['attachments'][0];
$this->assertEquals('PageAttachmentExport.txt', $attachmentData['name']);
$this->assertEquals($attachment->id, $attachmentData['id']);
$this->assertEquals(1, $attachmentData['order']);
$this->assertArrayNotHasKey('link', $attachmentData);
$this->assertNotEmpty($attachmentData['file']);
$fileRef = $attachmentData['file'];
$filePath = $zip->extractPath("/files/$fileRef");
$this->assertFileExists($filePath);
$this->assertEquals($contents, file_get_contents($filePath));
}
public function test_page_export_link_attachments()
{
$page = $this->entities->page();
$this->asEditor();
$attachment = Attachment::factory()->create([
'name' => 'My link attachment for export',
'path' => 'https://example.com/cats',
'external' => true,
'uploaded_to' => $page->id,
'order' => 1,
]);
$zipResp = $this->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertCount(1, $pageData['attachments']);
$attachmentData = $pageData['attachments'][0];
$this->assertEquals('My link attachment for export', $attachmentData['name']);
$this->assertEquals($attachment->id, $attachmentData['id']);
$this->assertEquals(1, $attachmentData['order']);
$this->assertEquals('https://example.com/cats', $attachmentData['link']);
$this->assertArrayNotHasKey('file', $attachmentData);
}
public function test_book_export()
{
// TODO
$book = $this->entities->book();
$book->tags()->saveMany(Tag::factory()->count(2)->make());
$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$this->assertArrayHasKey('book', $zip->data);
$bookData = $zip->data['book'];
$this->assertEquals($book->id, $bookData['id']);
$this->assertEquals($book->name, $bookData['name']);
$this->assertEquals($book->descriptionHtml(), $bookData['description_html']);
$this->assertCount(2, $bookData['tags']);
$this->assertCount($book->directPages()->count(), $bookData['pages']);
$this->assertCount($book->chapters()->count(), $bookData['chapters']);
$this->assertArrayNotHasKey('cover', $bookData);
}
public function test_book_export_with_cover_image()
{
$book = $this->entities->book();
$bookRepo = $this->app->make(BookRepo::class);
$coverImageFile = $this->files->uploadedImage('cover.png');
$bookRepo->updateCoverImage($book, $coverImageFile);
$coverImage = $book->cover()->first();
$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$this->assertArrayHasKey('cover', $zip->data['book']);
$coverRef = $zip->data['book']['cover'];
$coverPath = $zip->extractPath("/files/$coverRef");
$this->assertFileExists($coverPath);
$this->assertEquals(file_get_contents(public_path($coverImage->path)), file_get_contents($coverPath));
}
public function test_chapter_export()
{
// TODO
$chapter = $this->entities->chapter();
$chapter->tags()->saveMany(Tag::factory()->count(2)->make());
$zipResp = $this->asEditor()->get($chapter->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$this->assertArrayHasKey('chapter', $zip->data);
$chapterData = $zip->data['chapter'];
$this->assertEquals($chapter->id, $chapterData['id']);
$this->assertEquals($chapter->name, $chapterData['name']);
$this->assertEquals($chapter->descriptionHtml(), $chapterData['description_html']);
$this->assertCount(2, $chapterData['tags']);
$this->assertEquals($chapter->priority, $chapterData['priority']);
$this->assertCount($chapter->pages()->count(), $chapterData['pages']);
}
public function test_cross_reference_links_are_converted()
{
$book = $this->entities->bookHasChaptersAndPages();
$chapter = $book->chapters()->first();
$page = $chapter->pages()->first();
$book->description_html = '<p><a href="' . $chapter->getUrl() . '">Link to chapter</a></p>';
$book->save();
$chapter->description_html = '<p><a href="' . $page->getUrl() . '#section2">Link to page</a></p>';
$chapter->save();
$page->html = '<p><a href="' . $book->getUrl() . '?view=true">Link to book</a></p>';
$page->save();
$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$bookData = $zip->data['book'];
$chapterData = $bookData['chapters'][0];
$pageData = $chapterData['pages'][0];
$this->assertStringContainsString('href="[[bsexport:chapter:' . $chapter->id . ']]"', $bookData['description_html']);
$this->assertStringContainsString('href="[[bsexport:page:' . $page->id . ']]#section2"', $chapterData['description_html']);
$this->assertStringContainsString('href="[[bsexport:book:' . $book->id . ']]?view=true"', $pageData['html']);
}
public function test_cross_reference_links_external_to_export_are_not_converted()
{
$page = $this->entities->page();
$page->html = '<p><a href="' . $page->book->getUrl() . '">Link to book</a></p>';
$page->save();
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertStringContainsString('href="' . $page->book->getUrl() . '"', $pageData['html']);
}
public function test_attachments_links_are_converted()
{
$page = $this->entities->page();
$attachment = Attachment::factory()->create([
'name' => 'My link attachment for export reference',
'path' => 'https://example.com/cats/ref',
'external' => true,
'uploaded_to' => $page->id,
'order' => 1,
]);
$page->html = '<p><a href="' . url("/attachments/{$attachment->id}") . '?open=true">Link to attachment</a></p>';
$page->save();
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['page'];
$this->assertStringContainsString('href="[[bsexport:attachment:' . $attachment->id . ']]?open=true"', $pageData['html']);
}
public function test_links_in_markdown_are_parsed()
{
$chapter = $this->entities->chapterHasPages();
$page = $chapter->pages()->first();
$page->markdown = "[Link to chapter]({$chapter->getUrl()})";
$page->save();
$zipResp = $this->asEditor()->get($chapter->getUrl("/export/zip"));
$zip = $this->extractZipResponse($zipResp);
$pageData = $zip->data['chapter']['pages'][0];
$this->assertStringContainsString("[Link to chapter]([[bsexport:chapter:{$chapter->id}]])", $pageData['markdown']);
}
protected function extractZipResponse(TestResponse $response): ZipResultData

9
tests/Exports/ZipResultData.php
View File

@ -10,4 +10,13 @@ class ZipResultData
public array $data,
) {
}
/**
* Build a path to a location the extracted content, using the given relative $path.
*/
public function extractPath(string $path): string
{
$relPath = implode(DIRECTORY_SEPARATOR, explode('/', $path));
return $this->extractedDirPath . DIRECTORY_SEPARATOR . ltrim($relPath, DIRECTORY_SEPARATOR);
}
}