Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 05:36:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'page_transclusion'

Browse Source 
Closes #123
This commit is contained in:
Dan Brown 2017-01-21 16:17:33 +00:00
commit 5c60f27a7d
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
17 changed files with 170 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
app/Http/Controllers/PageController.php
View File

@ -158,13 +158,16 @@ class PageController extends Controller
$this->checkOwnablePermission('page-view', $page); $this->checkOwnablePermission('page-view', $page);
$pageContent = $this->entityRepo->renderPage($page);
$sidebarTree = $this->entityRepo->getBookChildren($page->book); $sidebarTree = $this->entityRepo->getBookChildren($page->book);
$pageNav = $this->entityRepo->getPageNav($page); $pageNav = $this->entityRepo->getPageNav($pageContent);
Views::add($page); Views::add($page);
$this->setPageTitle($page->getShortName()); $this->setPageTitle($page->getShortName());
return view('pages/show', ['page' => $page, 'book' => $page->book, return view('pages/show', [
'current' => $page, 'sidebarTree' => $sidebarTree, 'pageNav' => $pageNav]); 'page' => $page,'book' => $page->book,
'current' => $page, 'sidebarTree' => $sidebarTree,
'pageNav' => $pageNav, 'pageContent' => $pageContent]);
} }
/** /**
@ -430,6 +433,7 @@ class PageController extends Controller
{ {
$page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug); $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
$pdfContent = $this->exportService->pageToPdf($page); $pdfContent = $this->exportService->pageToPdf($page);
// return $pdfContent;
return response()->make($pdfContent, 200, [ return response()->make($pdfContent, 200, [
'Content-Type' => 'application/octet-stream', 'Content-Type' => 'application/octet-stream',
'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.pdf' 'Content-Disposition' => 'attachment; filename="' . $pageSlug . '.pdf'

56
app/Repos/EntityRepo.php
View File

@ -139,7 +139,7 @@ class EntityRepo
*/ */
public function getById($type, $id, $allowDrafts = false) public function getById($type, $id, $allowDrafts = false)
{ {
return $this->entityQuery($type, $allowDrafts)->findOrFail($id); return $this->entityQuery($type, $allowDrafts)->find($id);
} }
/** /**
@ -796,6 +796,52 @@ class EntityRepo
return $html; return $html;
} }
/**
* Render the page for viewing, Parsing and performing features such as page transclusion.
* @param Page $page
* @return mixed|string
*/
public function renderPage(Page $page)
{
$content = $page->html;
$matches = [];
preg_match_all("/{{@\s?([0-9].*?)}}/", $content, $matches);
if (count($matches[0]) === 0) return $content;
foreach ($matches[1] as $index => $includeId) {
$splitInclude = explode('#', $includeId, 2);
$pageId = intval($splitInclude[0]);
if (is_nan($pageId)) continue;
$page = $this->getById('page', $pageId);
if ($page === null) {
$content = str_replace($matches[0][$index], '', $content);
continue;
}
if (count($splitInclude) === 1) {
$content = str_replace($matches[0][$index], $page->html, $content);
continue;
}
$doc = new DOMDocument();
$doc->loadHTML(mb_convert_encoding('<body>'.$page->html.'</body>', 'HTML-ENTITIES', 'UTF-8'));
$matchingElem = $doc->getElementById($splitInclude[1]);
if ($matchingElem === null) {
$content = str_replace($matches[0][$index], '', $content);
continue;
}
$innerContent = '';
foreach ($matchingElem->childNodes as $childNode) {
$innerContent .= $doc->saveHTML($childNode);
}
$content = str_replace($matches[0][$index], trim($innerContent), $content);
}
return $content;
}
/** /**
* Get a new draft page instance. * Get a new draft page instance.
* @param Book $book * @param Book $book
@ -835,15 +881,15 @@ class EntityRepo
/** /**
* Parse the headers on the page to get a navigation menu * Parse the headers on the page to get a navigation menu
* @param Page $page * @param String $pageContent
* @return array * @return array
*/ */
public function getPageNav(Page $page) public function getPageNav($pageContent)
{ {
if ($page->html == '') return []; if ($pageContent == '') return [];
libxml_use_internal_errors(true); libxml_use_internal_errors(true);
$doc = new DOMDocument(); $doc = new DOMDocument();
$doc->loadHTML(mb_convert_encoding($page->html, 'HTML-ENTITIES', 'UTF-8')); $doc->loadHTML(mb_convert_encoding($pageContent, 'HTML-ENTITIES', 'UTF-8'));
$xPath = new DOMXPath($doc); $xPath = new DOMXPath($doc);
$headers = $xPath->query("//h1|//h2|//h3|//h4|//h5|//h6"); $headers = $xPath->query("//h1|//h2|//h3|//h4|//h5|//h6");

27
app/Services/ExportService.php
View File

@ -1,10 +1,22 @@
<?php namespace BookStack\Services; <?php namespace BookStack\Services;
use BookStack\Page; use BookStack\Page;
use BookStack\Repos\EntityRepo;
class ExportService class ExportService
{ {
protected $entityRepo;
/**
* ExportService constructor.
* @param $entityRepo
*/
public function __construct(EntityRepo $entityRepo)
{
$this->entityRepo = $entityRepo;
}
/** /**
* Convert a page to a self-contained HTML file. * Convert a page to a self-contained HTML file.
* Includes required CSS & image content. Images are base64 encoded into the HTML. * Includes required CSS & image content. Images are base64 encoded into the HTML.
@ -14,7 +26,7 @@ class ExportService
public function pageToContainedHtml(Page $page) public function pageToContainedHtml(Page $page)
{ {
$cssContent = file_get_contents(public_path('/css/export-styles.css')); $cssContent = file_get_contents(public_path('/css/export-styles.css'));
$pageHtml = view('pages/export', ['page' => $page, 'css' => $cssContent])->render(); $pageHtml = view('pages/export', ['page' => $page, 'pageContent' => $this->entityRepo->renderPage($page), 'css' => $cssContent])->render();
return $this->containHtml($pageHtml); return $this->containHtml($pageHtml);
} }
@ -26,7 +38,8 @@ class ExportService
public function pageToPdf(Page $page) public function pageToPdf(Page $page)
{ {
$cssContent = file_get_contents(public_path('/css/export-styles.css')); $cssContent = file_get_contents(public_path('/css/export-styles.css'));
$pageHtml = view('pages/pdf', ['page' => $page, 'css' => $cssContent])->render(); $pageHtml = view('pages/pdf', ['page' => $page, 'pageContent' => $this->entityRepo->renderPage($page), 'css' => $cssContent])->render();
// return $pageHtml;
$useWKHTML = config('snappy.pdf.binary') !== false; $useWKHTML = config('snappy.pdf.binary') !== false;
$containedHtml = $this->containHtml($pageHtml); $containedHtml = $this->containHtml($pageHtml);
if ($useWKHTML) { if ($useWKHTML) {
@ -59,9 +72,13 @@ class ExportService
$pathString = $srcString; $pathString = $srcString;
} }
if ($isLocal && !file_exists($pathString)) continue; if ($isLocal && !file_exists($pathString)) continue;
try {
$imageContent = file_get_contents($pathString); $imageContent = file_get_contents($pathString);
$imageEncoded = 'data:image/' . pathinfo($pathString, PATHINFO_EXTENSION) . ';base64,' . base64_encode($imageContent); $imageEncoded = 'data:image/' . pathinfo($pathString, PATHINFO_EXTENSION) . ';base64,' . base64_encode($imageContent);
$newImageString = str_replace($srcString, $imageEncoded, $oldImgString); $newImageString = str_replace($srcString, $imageEncoded, $oldImgString);
} catch (\ErrorException $e) {
$newImageString = '';
}
$htmlContent = str_replace($oldImgString, $newImageString, $htmlContent); $htmlContent = str_replace($oldImgString, $newImageString, $htmlContent);
} }
} }
@ -88,14 +105,14 @@ class ExportService
/** /**
* Converts the page contents into simple plain text. * Converts the page contents into simple plain text.
* This method filters any bad looking content to * This method filters any bad looking content to provide a nice final output.
* provide a nice final output.
* @param Page $page * @param Page $page
* @return mixed * @return mixed
*/ */
public function pageToPlainText(Page $page) public function pageToPlainText(Page $page)
{ {
$text = $page->text; $html = $this->entityRepo->renderPage($page);
$text = strip_tags($html);
// Replace multiple spaces with single spaces // Replace multiple spaces with single spaces
$text = preg_replace('/\ {2,}/', ' ', $text); $text = preg_replace('/\ {2,}/', ' ', $text);
// Reduce multiple horrid whitespace characters. // Reduce multiple horrid whitespace characters.

5
app/Services/PermissionService.php
View File

@ -157,7 +157,7 @@ class PermissionService
*/ */
public function buildJointPermissionsForEntity(Entity $entity) public function buildJointPermissionsForEntity(Entity $entity)
{ {
$roles = $this->role->with('jointPermissions')->get(); $roles = $this->role->get();
$entities = collect([$entity]); $entities = collect([$entity]);
if ($entity->isA('book')) { if ($entity->isA('book')) {
@ -177,7 +177,7 @@ class PermissionService
*/ */
public function buildJointPermissionsForEntities(Collection $entities) public function buildJointPermissionsForEntities(Collection $entities)
{ {
$roles = $this->role->with('jointPermissions')->get(); $roles = $this->role->get();
$this->deleteManyJointPermissionsForEntities($entities); $this->deleteManyJointPermissionsForEntities($entities);
$this->createManyJointPermissions($entities, $roles); $this->createManyJointPermissions($entities, $roles);
} }
@ -564,6 +564,7 @@ class PermissionService
}); });
}); });
}); });
$this->clean();
return $q; return $q;
} }

6
package.json
View File

@ -16,7 +16,9 @@
"laravel-elixir": "^6.0.0-11", "laravel-elixir": "^6.0.0-11",
"laravel-elixir-browserify-official": "^0.1.3", "laravel-elixir-browserify-official": "^0.1.3",
"marked": "^0.3.5", "marked": "^0.3.5",
"moment": "^2.12.0", "moment": "^2.12.0"
"zeroclipboard": "^2.2.0" },
"dependencies": {
"clipboard": "^1.5.16"
} }
} }

BIN
public/ZeroClipboard.swf
View File

Binary file not shown.

42
resources/assets/js/pages/page-show.js
View File

@ -1,13 +1,16 @@
"use strict"; "use strict";
// Configure ZeroClipboard // Configure ZeroClipboard
import ZeroClipBoard from "zeroclipboard"; import Clipboard from "clipboard";
export default window.setupPageShow = function (pageId) { export default window.setupPageShow = function (pageId) {
// Set up pointer // Set up pointer
let $pointer = $('#pointer').detach(); let $pointer = $('#pointer').detach();
let pointerShowing = false;
let $pointerInner = $pointer.children('div.pointer').first(); let $pointerInner = $pointer.children('div.pointer').first();
let isSelection = false; let isSelection = false;
let pointerModeLink = true;
let pointerSectionId = '';
// Select all contents on input click // Select all contents on input click
$pointer.on('click', 'input', function (e) { $pointer.on('click', 'input', function (e) {
@ -15,19 +18,34 @@ export default window.setupPageShow = function (pageId) {
e.stopPropagation(); e.stopPropagation();
}); });
// Set up copy-to-clipboard // Pointer mode toggle
ZeroClipBoard.config({ $pointer.on('click', 'span.icon', event => {
swfPath: window.baseUrl('/ZeroClipboard.swf') let $icon = $(event.currentTarget);
pointerModeLink = !pointerModeLink;
$icon.html(pointerModeLink ? '<i class="zmdi zmdi-link"></i>' : '<i class="zmdi zmdi-square-down"></i>');
updatePointerContent();
}); });
new ZeroClipBoard($pointer.find('button').first()[0]);
// Set up clipboard
let clipboard = new Clipboard('#pointer button');
// Hide pointer when clicking away // Hide pointer when clicking away
$(document.body).find('*').on('click focus', function (e) { $(document.body).find('*').on('click focus', event => {
if (!isSelection) { if (!pointerShowing || isSelection) return;
let target = $(event.target);
if (target.is('.zmdi') || $(event.target).closest('#pointer').length === 1) return;
$pointer.detach(); $pointer.detach();
} pointerShowing = false;
}); });
function updatePointerContent() {
let inputText = pointerModeLink ? window.baseUrl(`/link/${pageId}#${pointerSectionId}`) : `{{@${pageId}#${pointerSectionId}}}`;
if (pointerModeLink && inputText.indexOf('http') !== 0) inputText = window.location.protocol + "//" + window.location.host + inputText;
$pointer.find('input').val(inputText);
}
// Show pointer when selecting a single block of tagged content // Show pointer when selecting a single block of tagged content
$('.page-content [id^="bkmrk"]').on('mouseup keyup', function (e) { $('.page-content [id^="bkmrk"]').on('mouseup keyup', function (e) {
e.stopPropagation(); e.stopPropagation();
@ -36,12 +54,12 @@ export default window.setupPageShow = function (pageId) {
// Show pointer and set link // Show pointer and set link
let $elem = $(this); let $elem = $(this);
let link = window.baseUrl('/link/' + pageId + '#' + $elem.attr('id')); pointerSectionId = $elem.attr('id');
if (link.indexOf('http') !== 0) link = window.location.protocol + "//" + window.location.host + link; updatePointerContent();
$pointer.find('input').val(link);
$pointer.find('button').first().attr('data-clipboard-text', link);
$elem.before($pointer); $elem.before($pointer);
$pointer.show(); $pointer.show();
pointerShowing = true;
// Set pointer to sit near mouse-up position // Set pointer to sit near mouse-up position
let pointerLeftOffset = (e.pageX - $elem.offset().left - ($pointerInner.width() / 2)); let pointerLeftOffset = (e.pageX - $elem.offset().left - ($pointerInner.width() / 2));

3
resources/assets/sass/_blocks.scss
View File

@ -136,9 +136,6 @@
background-color: #EEE; background-color: #EEE;
padding: $-s; padding: $-s;
display: block; display: block;
> * {
display: inline-block;
}
&:before { &:before {
font-family: 'Material-Design-Iconic-Font'; font-family: 'Material-Design-Iconic-Font';
padding-right: $-s; padding-right: $-s;

1
resources/assets/sass/_buttons.scss
View File

@ -109,4 +109,3 @@ $button-border-radius: 2px;
box-shadow: none; box-shadow: none;
} }
} }

3
resources/assets/sass/_components.scss
View File

@ -70,9 +70,6 @@ body.flexbox-support #entity-selector-wrap .popup-body .form-group {
#entity-selector-wrap .popup-body .form-group { #entity-selector-wrap .popup-body .form-group {
margin: 0; margin: 0;
} }
//body.ie #entity-selector-wrap .popup-body .form-group {
// min-height: 60vh;
//}
.image-manager-body { .image-manager-body {
min-height: 70vh; min-height: 70vh;

4
resources/assets/sass/_pages.scss
View File

@ -138,6 +138,10 @@
font-size: 18px; font-size: 18px;
padding-top: 4px; padding-top: 4px;
} }
span.icon {
cursor: pointer;
user-select: none;
}
.button { .button {
line-height: 1; line-height: 1;
margin: 0 0 0 -4px; margin: 0 0 0 -4px;

2
resources/assets/sass/export-styles.scss
View File

@ -1,4 +1,4 @@
//@import "reset"; @import "reset";
@import "variables"; @import "variables";
@import "mixins"; @import "mixins";
@import "html"; @import "html";

2
resources/views/pages/page-display.blade.php
View File

@ -7,6 +7,6 @@
@if (isset($diff) && $diff) @if (isset($diff) && $diff)
{!! $diff !!} {!! $diff !!}
@else @else
{!! $page->html !!} {!! isset($pageContent) ? $pageContent : $page->html !!}
@endif @endif
</div> </div>

6
resources/views/pages/show.blade.php
View File

@ -53,9 +53,9 @@
<div class="pointer-container" id="pointer"> <div class="pointer-container" id="pointer">
<div class="pointer anim"> <div class="pointer anim">
<i class="zmdi zmdi-link"></i> <span class="icon text-primary"><i class="zmdi zmdi-link"></i></span>
<input readonly="readonly" type="text" placeholder="url"> <input readonly="readonly" type="text" id="pointer-url" placeholder="url">
<button class="button icon" title="{{ trans('entities.pages_copy_link') }}" data-clipboard-text=""><i class="zmdi zmdi-copy"></i></button> <button class="button icon" data-clipboard-target="#pointer-url" type="button" title="{{ trans('entities.pages_copy_link') }}"><i class="zmdi zmdi-copy"></i></button>
</div> </div>
</div> </div>

33
tests/Entity/PageContentTest.php Normal file
View File

@ -0,0 +1,33 @@
<?php
class PageContentTest extends TestCase
{
public function test_page_includes()
{
$page = \BookStack\Page::first();
$secondPage = \BookStack\Page::all()->get(2);
$secondPage->html = "<p id='section1'>Hello, This is a test</p><p id='section2'>This is a second block of content</p>";
$secondPage->save();
$this->asAdmin()->visit($page->getUrl())
->dontSee('Hello, This is a test');
$originalHtml = $page->html;
$page->html .= "{{@{$secondPage->id}}}";
$page->save();
$this->asAdmin()->visit($page->getUrl())
->see('Hello, This is a test')
->see('This is a second block of content');
$page->html = $originalHtml . " Well {{@{$secondPage->id}#section2}}";
$page->save();
$this->asAdmin()->visit($page->getUrl())
->dontSee('Hello, This is a test')
->see('Well This is a second block of content');
}
}

55
tests/Entity/TagTests.php → tests/Entity/TagTest.php
View File

@ -4,7 +4,7 @@ use BookStack\Tag;
use BookStack\Page; use BookStack\Page;
use BookStack\Services\PermissionService; use BookStack\Services\PermissionService;
class TagTests extends \TestCase class TagTest extends \TestCase
{ {
protected $defaultTagCount = 20; protected $defaultTagCount = 20;
@ -86,61 +86,16 @@ class TagTests extends \TestCase
$attrs = $attrs->merge(factory(Tag::class, 5)->make(['name' => 'color'])); $attrs = $attrs->merge(factory(Tag::class, 5)->make(['name' => 'color']));
$page = $this->getPageWithTags($attrs); $page = $this->getPageWithTags($attrs);
$this->asAdmin()->get('/ajax/tags/suggest?search=co')->seeJsonEquals(['color', 'country']); $this->asAdmin()->get('/ajax/tags/suggest/names?search=co')->seeJsonEquals(['color', 'country']);
$this->asEditor()->get('/ajax/tags/suggest?search=co')->seeJsonEquals(['color', 'country']); $this->asEditor()->get('/ajax/tags/suggest/names?search=co')->seeJsonEquals(['color', 'country']);
// Set restricted permission the page // Set restricted permission the page
$page->restricted = true; $page->restricted = true;
$page->save(); $page->save();
$permissionService->buildJointPermissionsForEntity($page); $permissionService->buildJointPermissionsForEntity($page);
$this->asAdmin()->get('/ajax/tags/suggest?search=co')->seeJsonEquals(['color', 'country']); $this->asAdmin()->get('/ajax/tags/suggest/names?search=co')->seeJsonEquals(['color', 'country']);
$this->asEditor()->get('/ajax/tags/suggest?search=co')->seeJsonEquals([]); $this->asEditor()->get('/ajax/tags/suggest/names?search=co')->seeJsonEquals([]);
}
public function test_entity_tag_updating()
{
$page = $this->getPageWithTags();
$testJsonData = [
['name' => 'color', 'value' => 'red'],
['name' => 'color', 'value' => ' blue '],
['name' => 'city', 'value' => 'London '],
['name' => 'country', 'value' => ' England'],
];
$testResponseJsonData = [
['name' => 'color', 'value' => 'red'],
['name' => 'color', 'value' => 'blue'],
['name' => 'city', 'value' => 'London'],
['name' => 'country', 'value' => 'England'],
];
// Do update request
$this->asAdmin()->json("POST", "/ajax/tags/update/page/" . $page->id, ['tags' => $testJsonData]);
$updateData = json_decode($this->response->getContent());
// Check data is correct
$testDataCorrect = true;
foreach ($updateData->tags as $data) {
$testItem = ['name' => $data->name, 'value' => $data->value];
if (!in_array($testItem, $testResponseJsonData)) $testDataCorrect = false;
}
$testMessage = "Expected data was not found in the response.\nExpected Data: %s\nRecieved Data: %s";
$this->assertTrue($testDataCorrect, sprintf($testMessage, json_encode($testResponseJsonData), json_encode($updateData)));
$this->assertTrue(isset($updateData->message), "No message returned in tag update response");
// Do get request
$this->asAdmin()->get("/ajax/tags/get/page/" . $page->id);
$getResponseData = json_decode($this->response->getContent());
// Check counts
$this->assertTrue(count($getResponseData) === count($testJsonData), "The received tag count is incorrect");
// Check data is correct
$testDataCorrect = true;
foreach ($getResponseData as $data) {
$testItem = ['name' => $data->name, 'value' => $data->value];
if (!in_array($testItem, $testResponseJsonData)) $testDataCorrect = false;
}
$testMessage = "Expected data was not found in the response.\nExpected Data: %s\nRecieved Data: %s";
$this->assertTrue($testDataCorrect, sprintf($testMessage, json_encode($testResponseJsonData), json_encode($getResponseData)));
} }
} }

2
tests/TestCase.php
View File

@ -60,7 +60,7 @@ class TestCase extends Illuminate\Foundation\Testing\TestCase
*/ */
public function asEditor() public function asEditor()
{ {
if($this->editor === null) { if ($this->editor === null) {
$this->editor = $this->getEditor(); $this->editor = $this->getEditor();
} }
return $this->actingAs($this->editor); return $this->actingAs($this->editor);