webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-31 15:24:31 +03:00
Code Activity

Merge branch 'markdown-export' of https://github.com/nikhiljha/BookStack-1 into nikhiljha-markdown-export

Browse Source
This commit is contained in:
Dan Brown
2021-06-22 19:12:24 +01:00
parent 3dda622f0a e287d965f5
commit 9af636bd48
9 changed files with 124 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,7 +7,9 @@ use BookStack\Uploads\ImageService;
use DomPDF;
use Exception;
use SnappyPDF;
use League\HTMLToMarkdown\HtmlConverter;
use Throwable;
use ZipArchive;
class ExportFormatter
{
@ -226,4 +228,72 @@ class ExportFormatter
}
return $text;
}
/**
* Convert a page to a Markdown file.
* @throws Throwable
*/
public function pageToMarkdown(Page $page)
{
if (property_exists($page, 'markdown') && $page->markdown != '') {
return "# " . $page->name . "\n\n" . $page->markdown;
} else {
$converter = new HtmlConverter();
return "# " . $page->name . "\n\n" . $converter->convert($page->html);
}
}
/**
* Convert a chapter to a Markdown file.
* @throws Throwable
*/
public function chapterToMarkdown(Chapter $chapter)
{
$text = "# " . $chapter->name . "\n\n";
$text .= $chapter->description . "\n\n";
foreach ($chapter->pages as $page) {
$text .= $this->pageToMarkdown($page);
}
return $text;
}
/**
* Convert a book into a plain text string.
*/
public function bookToMarkdown(Book $book): string
{
$bookTree = (new BookContents($book))->getTree(false, true);
$text = "# " . $book->name . "\n\n";
foreach ($bookTree as $bookChild) {
if ($bookChild->isA('chapter')) {
$text .= $this->chapterToMarkdown($bookChild);
} else {
$text .= $this->pageToMarkdown($bookChild);
}
}
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";
}
}