Skip to content

Commit d1f69fe

Browse files
ssddanbrownssddanbrown
committed
ZIP Exports: Tested each type and model of export
1 parent 484342f commit d1f69fe

File tree

5 files changed

+274
-5
lines changed

5 files changed

+274
-5
lines changed

‎app/Exports/ZipExports/Models/ZipExportAttachment.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ public static function fromModel(Attachment $model, ZipExportFiles $files): self
1818
$instance = new self();
1919
$instance->id = $model->id;
2020
$instance->name = $model->name;
21+
$instance->order = $model->order;
2122

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

‎app/Exports/ZipExports/ZipExportReferences.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public function addChapter(ZipExportChapter $chapter): void
6262
public function addBook(ZipExportBook $book): void
6363
{
6464
if ($book->id) {
65-
$this->chapters[$book->id] = $book;
65+
$this->books[$book->id] = $book;
6666
}
6767

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

‎app/Exports/ZipExports/ZipReferenceParser.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public function __construct(EntityQueries $queries)
3838
public function parse(string $content, callable $handler): string
3939
{
4040
$escapedBase = preg_quote(url('/'), '/');
41-
$linkRegex = "/({$escapedBase}.*?)[\\t\\n\\f>\"'=?#]/";
41+
$linkRegex = "/({$escapedBase}.*?)[\\t\\n\\f>\"'=?#()]/";
4242
$matches = [];
4343
preg_match_all($linkRegex, $content, $matches);
4444

‎tests/Exports/ZipExportTest.php

Lines changed: 262 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
namespace Tests\Exports;
44

5+
use BookStack\Activity\Models\Tag;
6+
use BookStack\Entities\Repos\BookRepo;
7+
use BookStack\Entities\Tools\PageContent;
8+
use BookStack\Uploads\Attachment;
9+
use BookStack\Uploads\Image;
510
use Illuminate\Support\Carbon;
611
use Illuminate\Testing\TestResponse;
712
use Tests\TestCase;
@@ -55,17 +60,271 @@ public function test_export_metadata()
5560

5661
public function test_page_export()
5762
{
58-
// TODO
63+
$page = $this->entities->page();
64+
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
65+
$zip = $this->extractZipResponse($zipResp);
66+
67+
$pageData = $zip->data['page'];
68+
$this->assertEquals([
69+
'id' => $page->id,
70+
'name' => $page->name,
71+
'html' => (new PageContent($page))->render(),
72+
'priority' => $page->priority,
73+
'attachments' => [],
74+
'images' => [],
75+
'tags' => [],
76+
], $pageData);
77+
}
78+
79+
public function test_page_export_with_markdown()
80+
{
81+
$page = $this->entities->page();
82+
$markdown = "# My page\n\nwritten in markdown for export\n";
83+
$page->markdown = $markdown;
84+
$page->save();
85+
86+
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
87+
$zip = $this->extractZipResponse($zipResp);
88+
89+
$pageData = $zip->data['page'];
90+
$this->assertEquals($markdown, $pageData['markdown']);
91+
$this->assertNotEmpty($pageData['html']);
92+
}
93+
94+
public function test_page_export_with_tags()
95+
{
96+
$page = $this->entities->page();
97+
$page->tags()->saveMany([
98+
new Tag(['name' => 'Exporty', 'value' => 'Content', 'order' => 1]),
99+
new Tag(['name' => 'Another', 'value' => '', 'order' => 2]),
100+
]);
101+
102+
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
103+
$zip = $this->extractZipResponse($zipResp);
104+
105+
$pageData = $zip->data['page'];
106+
$this->assertEquals([
107+
[
108+
'name' => 'Exporty',
109+
'value' => 'Content',
110+
'order' => 1,
111+
],
112+
[
113+
'name' => 'Another',
114+
'value' => '',
115+
'order' => 2,
116+
]
117+
], $pageData['tags']);
118+
}
119+
120+
public function test_page_export_with_images()
121+
{
122+
$this->asEditor();
123+
$page = $this->entities->page();
124+
$result = $this->files->uploadGalleryImageToPage($this, $page);
125+
$displayThumb = $result['response']->thumbs->gallery ?? '';
126+
$page->html = '<p><img src="' . $displayThumb . '" alt="My image"></p>';
127+
$page->save();
128+
$image = Image::findOrFail($result['response']->id);
129+
130+
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
131+
$zip = $this->extractZipResponse($zipResp);
132+
$pageData = $zip->data['page'];
133+
134+
$this->assertCount(1, $pageData['images']);
135+
$imageData = $pageData['images'][0];
136+
$this->assertEquals($image->id, $imageData['id']);
137+
$this->assertEquals($image->name, $imageData['name']);
138+
$this->assertEquals('gallery', $imageData['type']);
139+
$this->assertNotEmpty($imageData['file']);
140+
141+
$filePath = $zip->extractPath("files/{$imageData['file']}");
142+
$this->assertFileExists($filePath);
143+
$this->assertEquals(file_get_contents(public_path($image->path)), file_get_contents($filePath));
144+
145+
$this->assertEquals('<p><img src="[[bsexport:image:' . $imageData['id'] . ']]" alt="My image"></p>', $pageData['html']);
146+
}
147+
148+
public function test_page_export_file_attachments()
149+
{
150+
$contents = 'My great attachment content!';
151+
152+
$page = $this->entities->page();
153+
$this->asAdmin();
154+
$attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'PageAttachmentExport.txt', $contents, 'text/plain');
155+
156+
$zipResp = $this->get($page->getUrl("/export/zip"));
157+
$zip = $this->extractZipResponse($zipResp);
158+
159+
$pageData = $zip->data['page'];
160+
$this->assertCount(1, $pageData['attachments']);
161+
162+
$attachmentData = $pageData['attachments'][0];
163+
$this->assertEquals('PageAttachmentExport.txt', $attachmentData['name']);
164+
$this->assertEquals($attachment->id, $attachmentData['id']);
165+
$this->assertEquals(1, $attachmentData['order']);
166+
$this->assertArrayNotHasKey('link', $attachmentData);
167+
$this->assertNotEmpty($attachmentData['file']);
168+
169+
$fileRef = $attachmentData['file'];
170+
$filePath = $zip->extractPath("/files/$fileRef");
171+
$this->assertFileExists($filePath);
172+
$this->assertEquals($contents, file_get_contents($filePath));
173+
}
174+
175+
public function test_page_export_link_attachments()
176+
{
177+
$page = $this->entities->page();
178+
$this->asEditor();
179+
$attachment = Attachment::factory()->create([
180+
'name' => 'My link attachment for export',
181+
'path' => 'https://example.com/cats',
182+
'external' => true,
183+
'uploaded_to' => $page->id,
184+
'order' => 1,
185+
]);
186+
187+
$zipResp = $this->get($page->getUrl("/export/zip"));
188+
$zip = $this->extractZipResponse($zipResp);
189+
190+
$pageData = $zip->data['page'];
191+
$this->assertCount(1, $pageData['attachments']);
192+
193+
$attachmentData = $pageData['attachments'][0];
194+
$this->assertEquals('My link attachment for export', $attachmentData['name']);
195+
$this->assertEquals($attachment->id, $attachmentData['id']);
196+
$this->assertEquals(1, $attachmentData['order']);
197+
$this->assertEquals('https://example.com/cats', $attachmentData['link']);
198+
$this->assertArrayNotHasKey('file', $attachmentData);
59199
}
60200

61201
public function test_book_export()
62202
{
63-
// TODO
203+
$book = $this->entities->book();
204+
$book->tags()->saveMany(Tag::factory()->count(2)->make());
205+
206+
$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));
207+
$zip = $this->extractZipResponse($zipResp);
208+
$this->assertArrayHasKey('book', $zip->data);
209+
210+
$bookData = $zip->data['book'];
211+
$this->assertEquals($book->id, $bookData['id']);
212+
$this->assertEquals($book->name, $bookData['name']);
213+
$this->assertEquals($book->descriptionHtml(), $bookData['description_html']);
214+
$this->assertCount(2, $bookData['tags']);
215+
$this->assertCount($book->directPages()->count(), $bookData['pages']);
216+
$this->assertCount($book->chapters()->count(), $bookData['chapters']);
217+
$this->assertArrayNotHasKey('cover', $bookData);
218+
}
219+
220+
public function test_book_export_with_cover_image()
221+
{
222+
$book = $this->entities->book();
223+
$bookRepo = $this->app->make(BookRepo::class);
224+
$coverImageFile = $this->files->uploadedImage('cover.png');
225+
$bookRepo->updateCoverImage($book, $coverImageFile);
226+
$coverImage = $book->cover()->first();
227+
228+
$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));
229+
$zip = $this->extractZipResponse($zipResp);
230+
231+
$this->assertArrayHasKey('cover', $zip->data['book']);
232+
$coverRef = $zip->data['book']['cover'];
233+
$coverPath = $zip->extractPath("/files/$coverRef");
234+
$this->assertFileExists($coverPath);
235+
$this->assertEquals(file_get_contents(public_path($coverImage->path)), file_get_contents($coverPath));
64236
}
65237

66238
public function test_chapter_export()
67239
{
68-
// TODO
240+
$chapter = $this->entities->chapter();
241+
$chapter->tags()->saveMany(Tag::factory()->count(2)->make());
242+
243+
$zipResp = $this->asEditor()->get($chapter->getUrl("/export/zip"));
244+
$zip = $this->extractZipResponse($zipResp);
245+
$this->assertArrayHasKey('chapter', $zip->data);
246+
247+
$chapterData = $zip->data['chapter'];
248+
$this->assertEquals($chapter->id, $chapterData['id']);
249+
$this->assertEquals($chapter->name, $chapterData['name']);
250+
$this->assertEquals($chapter->descriptionHtml(), $chapterData['description_html']);
251+
$this->assertCount(2, $chapterData['tags']);
252+
$this->assertEquals($chapter->priority, $chapterData['priority']);
253+
$this->assertCount($chapter->pages()->count(), $chapterData['pages']);
254+
}
255+
256+
257+
public function test_cross_reference_links_are_converted()
258+
{
259+
$book = $this->entities->bookHasChaptersAndPages();
260+
$chapter = $book->chapters()->first();
261+
$page = $chapter->pages()->first();
262+
263+
$book->description_html = '<p><a href="' . $chapter->getUrl() . '">Link to chapter</a></p>';
264+
$book->save();
265+
$chapter->description_html = '<p><a href="' . $page->getUrl() . '#section2">Link to page</a></p>';
266+
$chapter->save();
267+
$page->html = '<p><a href="' . $book->getUrl() . '?view=true">Link to book</a></p>';
268+
$page->save();
269+
270+
$zipResp = $this->asEditor()->get($book->getUrl("/export/zip"));
271+
$zip = $this->extractZipResponse($zipResp);
272+
$bookData = $zip->data['book'];
273+
$chapterData = $bookData['chapters'][0];
274+
$pageData = $chapterData['pages'][0];
275+
276+
$this->assertStringContainsString('href="[[bsexport:chapter:' . $chapter->id . ']]"', $bookData['description_html']);
277+
$this->assertStringContainsString('href="[[bsexport:page:' . $page->id . ']]#section2"', $chapterData['description_html']);
278+
$this->assertStringContainsString('href="[[bsexport:book:' . $book->id . ']]?view=true"', $pageData['html']);
279+
}
280+
281+
public function test_cross_reference_links_external_to_export_are_not_converted()
282+
{
283+
$page = $this->entities->page();
284+
$page->html = '<p><a href="' . $page->book->getUrl() . '">Link to book</a></p>';
285+
$page->save();
286+
287+
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
288+
$zip = $this->extractZipResponse($zipResp);
289+
$pageData = $zip->data['page'];
290+
291+
$this->assertStringContainsString('href="' . $page->book->getUrl() . '"', $pageData['html']);
292+
}
293+
294+
public function test_attachments_links_are_converted()
295+
{
296+
$page = $this->entities->page();
297+
$attachment = Attachment::factory()->create([
298+
'name' => 'My link attachment for export reference',
299+
'path' => 'https://example.com/cats/ref',
300+
'external' => true,
301+
'uploaded_to' => $page->id,
302+
'order' => 1,
303+
]);
304+
305+
$page->html = '<p><a href="' . url("/attachments/{$attachment->id}") . '?open=true">Link to attachment</a></p>';
306+
$page->save();
307+
308+
$zipResp = $this->asEditor()->get($page->getUrl("/export/zip"));
309+
$zip = $this->extractZipResponse($zipResp);
310+
$pageData = $zip->data['page'];
311+
312+
$this->assertStringContainsString('href="[[bsexport:attachment:' . $attachment->id . ']]?open=true"', $pageData['html']);
313+
}
314+
315+
public function test_links_in_markdown_are_parsed()
316+
{
317+
$chapter = $this->entities->chapterHasPages();
318+
$page = $chapter->pages()->first();
319+
320+
$page->markdown = "[Link to chapter]({$chapter->getUrl()})";
321+
$page->save();
322+
323+
$zipResp = $this->asEditor()->get($chapter->getUrl("/export/zip"));
324+
$zip = $this->extractZipResponse($zipResp);
325+
$pageData = $zip->data['chapter']['pages'][0];
326+
327+
$this->assertStringContainsString("[Link to chapter]([[bsexport:chapter:{$chapter->id}]])", $pageData['markdown']);
69328
}
70329

71330
protected function extractZipResponse(TestResponse $response): ZipResultData

‎tests/Exports/ZipResultData.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,13 @@ public function __construct(
1010
public array $data,
1111
) {
1212
}
13+
14+
/**
15+
* Build a path to a location the extracted content, using the given relative $path.
16+
*/
17+
public function extractPath(string $path): string
18+
{
19+
$relPath = implode(DIRECTORY_SEPARATOR, explode('/', $path));
20+
return $this->extractedDirPath . DIRECTORY_SEPARATOR . ltrim($relPath, DIRECTORY_SEPARATOR);
21+
}
1322
}

0 commit comments

Comments
 (0)