mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-08-25 11:45:58 +00:00
![Dan Brown](/assets/img/avatar_default.png)
Added search result pages for pages, chapters and books. Limited the results on the global search as it just listed out an infinate amount. Fixed styling on new detailed page listings and also removed the 'bars' from the side to create a cleaner view. Fixed bad sql fulltext query format that may have thrown off searches. Reduced the number of database queries down a thousand or so.
387 lines
11 KiB
PHP
387 lines
11 KiB
PHP
<?php namespace BookStack\Repos;
|
|
|
|
|
|
use Activity;
|
|
use BookStack\Book;
|
|
use BookStack\Chapter;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Support\Facades\Auth;
|
|
use Illuminate\Support\Facades\Log;
|
|
use Illuminate\Support\Str;
|
|
use BookStack\Page;
|
|
use BookStack\PageRevision;
|
|
|
|
class PageRepo
|
|
{
|
|
protected $page;
|
|
protected $pageRevision;
|
|
|
|
/**
|
|
* PageRepo constructor.
|
|
* @param Page $page
|
|
* @param PageRevision $pageRevision
|
|
*/
|
|
public function __construct(Page $page, PageRevision $pageRevision)
|
|
{
|
|
$this->page = $page;
|
|
$this->pageRevision = $pageRevision;
|
|
}
|
|
|
|
/**
|
|
* Check if a page id exists.
|
|
* @param $id
|
|
* @return bool
|
|
*/
|
|
public function idExists($id)
|
|
{
|
|
return $this->page->where('page_id', '=', $id)->count() > 0;
|
|
}
|
|
|
|
/**
|
|
* Get a page via a specific ID.
|
|
* @param $id
|
|
* @return mixed
|
|
*/
|
|
public function getById($id)
|
|
{
|
|
return $this->page->findOrFail($id);
|
|
}
|
|
|
|
/**
|
|
* Get all pages.
|
|
* @return \Illuminate\Database\Eloquent\Collection|static[]
|
|
*/
|
|
public function getAll()
|
|
{
|
|
return $this->page->all();
|
|
}
|
|
|
|
/**
|
|
* Get a page identified by the given slug.
|
|
* @param $slug
|
|
* @param $bookId
|
|
* @return mixed
|
|
*/
|
|
public function getBySlug($slug, $bookId)
|
|
{
|
|
$page = $this->page->where('slug', '=', $slug)->where('book_id', '=', $bookId)->first();
|
|
if ($page === null) abort(404);
|
|
return $page;
|
|
}
|
|
|
|
/**
|
|
* @param $input
|
|
* @return Page
|
|
*/
|
|
public function newFromInput($input)
|
|
{
|
|
$page = $this->page->fill($input);
|
|
return $page;
|
|
}
|
|
|
|
/**
|
|
* Count the pages with a particular slug within a book.
|
|
* @param $slug
|
|
* @param $bookId
|
|
* @return mixed
|
|
*/
|
|
public function countBySlug($slug, $bookId)
|
|
{
|
|
return $this->page->where('slug', '=', $slug)->where('book_id', '=', $bookId)->count();
|
|
}
|
|
|
|
/**
|
|
* Save a new page into the system.
|
|
* Input validation must be done beforehand.
|
|
* @param array $input
|
|
* @param Book $book
|
|
* @param int $chapterId
|
|
* @return Page
|
|
*/
|
|
public function saveNew(array $input, Book $book, $chapterId = null)
|
|
{
|
|
$page = $this->newFromInput($input);
|
|
$page->slug = $this->findSuitableSlug($page->name, $book->id);
|
|
|
|
if ($chapterId) $page->chapter_id = $chapterId;
|
|
|
|
$page->html = $this->formatHtml($input['html']);
|
|
$page->text = strip_tags($page->html);
|
|
$page->created_by = auth()->user()->id;
|
|
$page->updated_by = auth()->user()->id;
|
|
|
|
$book->pages()->save($page);
|
|
return $page;
|
|
}
|
|
|
|
/**
|
|
* Formats a page's html to be tagged correctly
|
|
* within the system.
|
|
* @param string $htmlText
|
|
* @return string
|
|
*/
|
|
protected function formatHtml($htmlText)
|
|
{
|
|
if($htmlText == '') return $htmlText;
|
|
libxml_use_internal_errors(true);
|
|
$doc = new \DOMDocument();
|
|
$doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
|
|
|
|
$container = $doc->documentElement;
|
|
$body = $container->childNodes->item(0);
|
|
$childNodes = $body->childNodes;
|
|
|
|
// Ensure no duplicate ids are used
|
|
$idArray = [];
|
|
|
|
foreach ($childNodes as $index => $childNode) {
|
|
/** @var \DOMElement $childNode */
|
|
if (get_class($childNode) !== 'DOMElement') continue;
|
|
|
|
// Overwrite id if not a BookStack custom id
|
|
if ($childNode->hasAttribute('id')) {
|
|
$id = $childNode->getAttribute('id');
|
|
if (strpos($id, 'bkmrk') === 0 && array_search($id, $idArray) === false) {
|
|
$idArray[] = $id;
|
|
continue;
|
|
};
|
|
}
|
|
|
|
// Create an unique id for the element
|
|
// Uses the content as a basis to ensure output is the same every time
|
|
// the same content is passed through.
|
|
$contentId = 'bkmrk-' . substr(strtolower(preg_replace('/\s+/', '-', trim($childNode->nodeValue))), 0, 20);
|
|
$newId = urlencode($contentId);
|
|
$loopIndex = 0;
|
|
while (in_array($newId, $idArray)) {
|
|
$newId = urlencode($contentId . '-' . $loopIndex);
|
|
$loopIndex++;
|
|
}
|
|
|
|
$childNode->setAttribute('id', $newId);
|
|
$idArray[] = $newId;
|
|
}
|
|
|
|
// Generate inner html as a string
|
|
$html = '';
|
|
foreach ($childNodes as $childNode) {
|
|
$html .= $doc->saveHTML($childNode);
|
|
}
|
|
|
|
return $html;
|
|
}
|
|
|
|
|
|
/**
|
|
* Gets pages by a search term.
|
|
* Highlights page content for showing in results.
|
|
* @param string $term
|
|
* @param array $whereTerms
|
|
* @param int $count
|
|
* @param array $paginationAppends
|
|
* @return mixed
|
|
*/
|
|
public function getBySearch($term, $whereTerms = [], $count = 20, $paginationAppends = [])
|
|
{
|
|
$terms = explode(' ', $term);
|
|
$pages = $this->page->fullTextSearchQuery(['name', 'text'], $terms, $whereTerms)
|
|
->paginate($count)->appends($paginationAppends);
|
|
|
|
// Add highlights to page text.
|
|
$words = join('|', explode(' ', preg_quote(trim($term), '/')));
|
|
//lookahead/behind assertions ensures cut between words
|
|
$s = '\s\x00-/:-@\[-`{-~'; //character set for start/end of words
|
|
|
|
foreach ($pages as $page) {
|
|
preg_match_all('#(?<=[' . $s . ']).{1,30}((' . $words . ').{1,30})+(?=[' . $s . '])#uis', $page->text, $matches, PREG_SET_ORDER);
|
|
//delimiter between occurrences
|
|
$results = [];
|
|
foreach ($matches as $line) {
|
|
$results[] = htmlspecialchars($line[0], 0, 'UTF-8');
|
|
}
|
|
$matchLimit = 6;
|
|
if (count($results) > $matchLimit) {
|
|
$results = array_slice($results, 0, $matchLimit);
|
|
}
|
|
$result = join('... ', $results);
|
|
|
|
//highlight
|
|
$result = preg_replace('#' . $words . '#iu', "<span class=\"highlight\">\$0</span>", $result);
|
|
if (strlen($result) < 5) {
|
|
$result = $page->getExcerpt(80);
|
|
}
|
|
$page->searchSnippet = $result;
|
|
}
|
|
return $pages;
|
|
}
|
|
|
|
/**
|
|
* Search for image usage.
|
|
* @param $imageString
|
|
* @return mixed
|
|
*/
|
|
public function searchForImage($imageString)
|
|
{
|
|
$pages = $this->page->where('html', 'like', '%' . $imageString . '%')->get();
|
|
foreach ($pages as $page) {
|
|
$page->url = $page->getUrl();
|
|
$page->html = '';
|
|
$page->text = '';
|
|
}
|
|
return count($pages) > 0 ? $pages : false;
|
|
}
|
|
|
|
/**
|
|
* Updates a page with any fillable data and saves it into the database.
|
|
* @param Page $page
|
|
* @param int $book_id
|
|
* @param string $input
|
|
* @return Page
|
|
*/
|
|
public function updatePage(Page $page, $book_id, $input)
|
|
{
|
|
// Save a revision before updating
|
|
if ($page->html !== $input['html'] || $page->name !== $input['name']) {
|
|
$this->saveRevision($page);
|
|
}
|
|
|
|
// Update with new details
|
|
$page->fill($input);
|
|
$page->slug = $this->findSuitableSlug($page->name, $book_id, $page->id);
|
|
$page->html = $this->formatHtml($input['html']);
|
|
$page->text = strip_tags($page->html);
|
|
$page->updated_by = auth()->user()->id;
|
|
$page->save();
|
|
return $page;
|
|
}
|
|
|
|
/**
|
|
* Restores a revision's content back into a page.
|
|
* @param Page $page
|
|
* @param Book $book
|
|
* @param int $revisionId
|
|
* @return Page
|
|
*/
|
|
public function restoreRevision(Page $page, Book $book, $revisionId)
|
|
{
|
|
$this->saveRevision($page);
|
|
$revision = $this->getRevisionById($revisionId);
|
|
$page->fill($revision->toArray());
|
|
$page->slug = $this->findSuitableSlug($page->name, $book->id, $page->id);
|
|
$page->text = strip_tags($page->html);
|
|
$page->updated_by = auth()->user()->id;
|
|
$page->save();
|
|
return $page;
|
|
}
|
|
|
|
/**
|
|
* Saves a page revision into the system.
|
|
* @param Page $page
|
|
* @return $this
|
|
*/
|
|
public function saveRevision(Page $page)
|
|
{
|
|
$revision = $this->pageRevision->fill($page->toArray());
|
|
$revision->page_id = $page->id;
|
|
$revision->created_by = auth()->user()->id;
|
|
$revision->created_at = $page->updated_at;
|
|
$revision->save();
|
|
// Clear old revisions
|
|
if ($this->pageRevision->where('page_id', '=', $page->id)->count() > 50) {
|
|
$this->pageRevision->where('page_id', '=', $page->id)
|
|
->orderBy('created_at', 'desc')->skip(50)->take(5)->delete();
|
|
}
|
|
return $revision;
|
|
}
|
|
|
|
/**
|
|
* Gets a single revision via it's id.
|
|
* @param $id
|
|
* @return mixed
|
|
*/
|
|
public function getRevisionById($id)
|
|
{
|
|
return $this->pageRevision->findOrFail($id);
|
|
}
|
|
|
|
/**
|
|
* Checks if a slug exists within a book already.
|
|
* @param $slug
|
|
* @param $bookId
|
|
* @param bool|false $currentId
|
|
* @return bool
|
|
*/
|
|
public function doesSlugExist($slug, $bookId, $currentId = false)
|
|
{
|
|
$query = $this->page->where('slug', '=', $slug)->where('book_id', '=', $bookId);
|
|
if ($currentId) $query = $query->where('id', '!=', $currentId);
|
|
return $query->count() > 0;
|
|
}
|
|
|
|
/**
|
|
* Changes the related book for the specified page.
|
|
* Changes the book id of any relations to the page that store the book id.
|
|
* @param int $bookId
|
|
* @param Page $page
|
|
* @return Page
|
|
*/
|
|
public function changeBook($bookId, Page $page)
|
|
{
|
|
$page->book_id = $bookId;
|
|
foreach ($page->activity as $activity) {
|
|
$activity->book_id = $bookId;
|
|
$activity->save();
|
|
}
|
|
$page->slug = $this->findSuitableSlug($page->name, $bookId, $page->id);
|
|
$page->save();
|
|
return $page;
|
|
}
|
|
|
|
/**
|
|
* Gets a suitable slug for the resource
|
|
* @param $name
|
|
* @param $bookId
|
|
* @param bool|false $currentId
|
|
* @return string
|
|
*/
|
|
public function findSuitableSlug($name, $bookId, $currentId = false)
|
|
{
|
|
$slug = Str::slug($name);
|
|
while ($this->doesSlugExist($slug, $bookId, $currentId)) {
|
|
$slug .= '-' . substr(md5(rand(1, 500)), 0, 3);
|
|
}
|
|
return $slug;
|
|
}
|
|
|
|
/**
|
|
* Destroy a given page along with its dependencies.
|
|
* @param $page
|
|
*/
|
|
public function destroy($page)
|
|
{
|
|
Activity::removeEntity($page);
|
|
$page->views()->delete();
|
|
$page->revisions()->delete();
|
|
$page->delete();
|
|
}
|
|
|
|
/**
|
|
* Get the latest pages added to the system.
|
|
* @param $count
|
|
*/
|
|
public function getRecentlyCreatedPaginated($count = 20)
|
|
{
|
|
return $this->page->orderBy('created_at', 'desc')->paginate($count);
|
|
}
|
|
|
|
/**
|
|
* Get the latest pages added to the system.
|
|
* @param $count
|
|
*/
|
|
public function getRecentlyUpdatedPaginated($count = 20)
|
|
{
|
|
return $this->page->orderBy('updated_at', 'desc')->paginate($count);
|
|
}
|
|
|
|
}
|