ZIP Exports: Tested each type and model of export

diff --git a/app/Exports/ZipExports/Models/ZipExportAttachment.php b/app/Exports/ZipExports/Models/ZipExportAttachment.php
index 8c89ae11f145bf03621d6e0316a2d5e8a785417f..283ffa751c9a152679df1733e0cd75651efb3848 100644 (file)
--- a/app/Exports/ZipExports/Models/ZipExportAttachment.php
+++ b/app/Exports/ZipExports/Models/ZipExportAttachment.php
@@ -18,6 +18,7 @@ class ZipExportAttachment extends ZipExportModel
         $instance = new self();
         $instance->id = $model->id;
         $instance->name = $model->name;
         $instance = new self();
         $instance->id = $model->id;
         $instance->name = $model->name;

+        $instance->order = $model->order;

 
         if ($model->external) {
             $instance->link = $model->path;
 
         if ($model->external) {
             $instance->link = $model->path;

diff --git a/app/Exports/ZipExports/ZipExportReferences.php b/app/Exports/ZipExports/ZipExportReferences.php
index 8b3a4b612fe04439c39bbb71b47ae49abb5894e0..c630c832b372370a3bad04f606d708e0c1968590 100644 (file)
--- a/app/Exports/ZipExports/ZipExportReferences.php
+++ b/app/Exports/ZipExports/ZipExportReferences.php
@@ -62,7 +62,7 @@ class ZipExportReferences
     public function addBook(ZipExportBook $book): void
     {
         if ($book->id) {
     public function addBook(ZipExportBook $book): void
     {
         if ($book->id) {

-            $this->chapters[$book->id] = $book;
+            $this->books[$book->id] = $book;

         }
 
         foreach ($book->pages as $page) {
         }
 
         foreach ($book->pages as $page) {

diff --git a/app/Exports/ZipExports/ZipReferenceParser.php b/app/Exports/ZipExports/ZipReferenceParser.php
index 4d16dbc6110f0db34fecf237d322c5ec55e2b9a1..da43d1b366bbf9e5ffc30c26f52fe7bd1cdc900b 100644 (file)
--- a/app/Exports/ZipExports/ZipReferenceParser.php
+++ b/app/Exports/ZipExports/ZipReferenceParser.php
@@ -38,7 +38,7 @@ class ZipReferenceParser
     public function parse(string $content, callable $handler): string
     {
         $escapedBase = preg_quote(url('/'), '/');
     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);
 
         $matches = [];
         preg_match_all($linkRegex, $content, $matches);
 

diff --git a/tests/Exports/ZipExportTest.php b/tests/Exports/ZipExportTest.php
index 536e23806f6afba9e60ae5bbac18f3832068d6c9..ac07b33aef5f7c5567ea3afb2f8ff7938937a5b2 100644 (file)
--- a/tests/Exports/ZipExportTest.php
+++ b/tests/Exports/ZipExportTest.php
@@ -2,6 +2,11 @@
 
 namespace Tests\Exports;
 
 
 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;
 use Illuminate\Support\Carbon;
 use Illuminate\Testing\TestResponse;
 use Tests\TestCase;


@@ -55,17 +60,271 @@ class ZipExportTest extends TestCase
 
     public function test_page_export()
     {
 
     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()
     {
     }
 
     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()
     {
     }
 
     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
     }
 
     protected function extractZipResponse(TestResponse $response): ZipResultData

diff --git a/tests/Exports/ZipResultData.php b/tests/Exports/ZipResultData.php
index b5cc2b4ca61a84adfa4bc72cd0c78692ed3e745a..7725004c7be66c00e1198e78dca53cdf40e9ad40 100644 (file)
--- a/tests/Exports/ZipResultData.php
+++ b/tests/Exports/ZipResultData.php
@@ -10,4 +10,13 @@ class ZipResultData
         public array $data,
     ) {
     }
         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);
+    }

 }
 }