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

Exports: Fixed issues with book text export format

Browse Source 
- Fixed missing page content for direct page children
- Fixed lack of book description.
- Fixed inconsistent spacing between items.
- Fixed lack of spacing between HTML items when HTML on same line.

For #4557
This commit is contained in:
Dan Brown 2023-09-24 18:03:37 +01:00
parent d5a3bdb7aa
commit e9664dc678
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
2 changed files with 68 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
app/Entities/Tools/ExportFormatter.php
View File

@ -254,17 +254,20 @@ class ExportFormatter
* Converts the page contents into simple plain text.
* This method filters any bad looking content to provide a nice final output.
*/
public function pageToPlainText(Page $page): string
public function pageToPlainText(Page $page, bool $pageRendered = false, bool $fromParent = false): string
{
$html = (new PageContent($page))->render();
$text = strip_tags($html);
$html = $pageRendered ? $page->html : (new PageContent($page))->render();
// Add proceeding spaces before tags so spaces remain between
// text within elements after stripping tags.
$html = str_replace('<', " <", $html);
$text = trim(strip_tags($html));
// Replace multiple spaces with single spaces
$text = preg_replace('/\ {2,}/', ' ', $text);
$text = preg_replace('/ {2,}/', ' ', $text);
// Reduce multiple horrid whitespace characters.
$text = preg_replace('/(\x0A|\xA0|\x0A|\r|\n){2,}/su', "\n\n", $text);
$text = html_entity_decode($text);
// Add title
$text = $page->name . "\n\n" . $text;
$text = $page->name . ($fromParent ? "\n" : "\n\n") . $text;
return $text;
}
@ -274,13 +277,15 @@ class ExportFormatter
*/
public function chapterToPlainText(Chapter $chapter): string
{
$text = $chapter->name . "\n\n";
$text .= $chapter->description . "\n\n";
$text = $chapter->name . "\n" . $chapter->description;
$text = trim($text) . "\n\n";
$parts = [];
foreach ($chapter->getVisiblePages() as $page) {
$text .= $this->pageToPlainText($page);
$parts[] = $this->pageToPlainText($page, false, true);
}
return $text;
return $text . implode("\n\n", $parts);
}
/**
@ -288,17 +293,20 @@ class ExportFormatter
*/
public function bookToPlainText(Book $book): string
{
$bookTree = (new BookContents($book))->getTree(false, false);
$text = $book->name . "\n\n";
$bookTree = (new BookContents($book))->getTree(false, true);
$text = $book->name . "\n" . $book->description;
$text = rtrim($text) . "\n\n";
$parts = [];
foreach ($bookTree as $bookChild) {
if ($bookChild->isA('chapter')) {
$text .= $this->chapterToPlainText($bookChild);
$parts[] = $this->chapterToPlainText($bookChild);
} else {
$text .= $this->pageToPlainText($bookChild);
$parts[] = $this->pageToPlainText($bookChild, true, true);
}
}
return $text;
return $text . implode("\n\n", $parts);
}
/**

49
tests/Entity/ExportTest.php
View File

@ -46,17 +46,43 @@ class ExportTest extends TestCase
public function test_book_text_export()
{
$page = $this->entities->page();
$book = $page->book;
$book = $this->entities->bookHasChaptersAndPages();
$directPage = $book->directPages()->first();
$chapter = $book->chapters()->first();
$chapterPage = $chapter->pages()->first();
$this->entities->updatePage($directPage, ['html' => '<p>My awesome page</p>']);
$this->entities->updatePage($chapterPage, ['html' => '<p>My little nested page</p>']);
$this->asEditor();
$resp = $this->get($book->getUrl('/export/plaintext'));
$resp->assertStatus(200);
$resp->assertSee($book->name);
$resp->assertSee($page->name);
$resp->assertSee($chapterPage->name);
$resp->assertSee($chapter->name);
$resp->assertSee($directPage->name);
$resp->assertSee('My awesome page');
$resp->assertSee('My little nested page');
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.txt"');
}
public function test_book_text_export_format()
{
$entities = $this->entities->createChainBelongingToUser($this->users->viewer());
$this->entities->updatePage($entities['page'], ['html' => '<p>My great page</p><p>Full of <strong>great</strong> stuff</p>', 'name' => 'My wonderful page!']);
$entities['chapter']->name = 'Export chapter';
$entities['chapter']->description = "A test chapter to be exported\nIt has loads of info within";
$entities['book']->name = 'Export Book';
$entities['book']->description = "This is a book with stuff to export";
$entities['chapter']->save();
$entities['book']->save();
$resp = $this->asEditor()->get($entities['book']->getUrl('/export/plaintext'));
$expected = "Export Book\nThis is a book with stuff to export\n\nExport chapter\nA test chapter to be exported\nIt has loads of info within\n\n";
$expected .= "My wonderful page!\nMy great page Full of great stuff";
$resp->assertSee($expected);
}
public function test_book_pdf_export()
{
$page = $this->entities->page();
@ -99,15 +125,32 @@ class ExportTest extends TestCase
{
$chapter = $this->entities->chapter();
$page = $chapter->pages[0];
$this->entities->updatePage($page, ['html' => '<p>This is content within the page!</p>']);
$this->asEditor();
$resp = $this->get($chapter->getUrl('/export/plaintext'));
$resp->assertStatus(200);
$resp->assertSee($chapter->name);
$resp->assertSee($page->name);
$resp->assertSee('This is content within the page!');
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $chapter->slug . '.txt"');
}
public function test_chapter_text_export_format()
{
$entities = $this->entities->createChainBelongingToUser($this->users->viewer());
$this->entities->updatePage($entities['page'], ['html' => '<p>My great page</p><p>Full of <strong>great</strong> stuff</p>', 'name' => 'My wonderful page!']);
$entities['chapter']->name = 'Export chapter';
$entities['chapter']->description = "A test chapter to be exported\nIt has loads of info within";
$entities['chapter']->save();
$resp = $this->asEditor()->get($entities['book']->getUrl('/export/plaintext'));
$expected = "Export chapter\nA test chapter to be exported\nIt has loads of info within\n\n";
$expected .= "My wonderful page!\nMy great page Full of great stuff";
$resp->assertSee($expected);
}
public function test_chapter_pdf_export()
{
$chapter = $this->entities->chapter();