webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2026-01-03 23:42:28 +03:00
Code Activity

Updated markdown export implementation

Browse Source 
- Removed ZIP system for now, until the idea can be fleshed out.
- Added testing to cover.
- Upgraded used library.
- Added custom handling for BookStack callouts.
- Added HTML cleanup to better produce output for things like code
  blocks.
This commit is contained in:
Dan Brown
2021-06-22 21:02:18 +01:00
parent 9af636bd48
commit 57ea2e92ec
10 changed files with 344 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3,13 +3,12 @@
use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Page;
use BookStack\Entities\Tools\Markdown\HtmlToMarkdown;
use BookStack\Uploads\ImageService;
use DomPDF;
use Exception;
use SnappyPDF;
use League\HTMLToMarkdown\HtmlConverter;
use Throwable;
use ZipArchive;
class ExportFormatter
{
@@ -231,23 +230,20 @@ class ExportFormatter
/**
* Convert a page to a Markdown file.
* @throws Throwable
*/
public function pageToMarkdown(Page $page)
public function pageToMarkdown(Page $page): string
{
if (property_exists($page, 'markdown') && $page->markdown != '') {
if ($page->markdown) {
return "# " . $page->name . "\n\n" . $page->markdown;
} else {
$converter = new HtmlConverter();
return "# " . $page->name . "\n\n" . $converter->convert($page->html);
}
return "# " . $page->name . "\n\n" . (new HtmlToMarkdown($page->html))->convert();
}
/**
* Convert a chapter to a Markdown file.
* @throws Throwable
*/
public function chapterToMarkdown(Chapter $chapter)
public function chapterToMarkdown(Chapter $chapter): string
{
$text = "# " . $chapter->name . "\n\n";
$text .= $chapter->description . "\n\n";
@@ -265,7 +261,7 @@ class ExportFormatter
$bookTree = (new BookContents($book))->getTree(false, true);
$text = "# " . $book->name . "\n\n";
foreach ($bookTree as $bookChild) {
if ($bookChild->isA('chapter')) {
if ($bookChild instanceof Chapter) {
$text .= $this->chapterToMarkdown($bookChild);
} else {
$text .= $this->pageToMarkdown($bookChild);
@@ -273,27 +269,4 @@ class ExportFormatter
}
return $text;
}
/**
* Convert a book into a zip file.
*/
public function bookToZip(Book $book): string
{
// TODO: Is not unlinking the file a security risk?
$z = new ZipArchive();
$z->open("book.zip", \ZipArchive::CREATE | \ZipArchive::OVERWRITE);
$bookTree = (new BookContents($book))->getTree(false, true);
foreach ($bookTree as $bookChild) {
if ($bookChild->isA('chapter')) {
$z->addEmptyDir($bookChild->name);
foreach ($bookChild->pages as $page) {
$filename = $bookChild->name . "/" . $page->name . ".md";
$z->addFromString($filename, $this->pageToMarkdown($page));
}
} else {
$z->addFromString($bookChild->name . ".md", $this->pageToMarkdown($bookChild));
}
}
return "book.zip";
}
}