mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-08-28 21:22:30 +00:00
200 lines
5.8 KiB
PHP
200 lines
5.8 KiB
PHP
<?php namespace BookStack\Repos;
|
|
|
|
|
|
use Activity;
|
|
use BookStack\Book;
|
|
use BookStack\Exceptions\NotFoundException;
|
|
use Illuminate\Support\Str;
|
|
use BookStack\Chapter;
|
|
|
|
class ChapterRepo extends EntityRepo
|
|
{
|
|
/**
|
|
* Base query for getting chapters, Takes restrictions into account.
|
|
* @return mixed
|
|
*/
|
|
private function chapterQuery()
|
|
{
|
|
return $this->restrictionService->enforceChapterRestrictions($this->chapter, 'view');
|
|
}
|
|
|
|
/**
|
|
* Check if an id exists.
|
|
* @param $id
|
|
* @return bool
|
|
*/
|
|
public function idExists($id)
|
|
{
|
|
return $this->chapterQuery()->where('id', '=', $id)->count() > 0;
|
|
}
|
|
|
|
/**
|
|
* Get a chapter by a specific id.
|
|
* @param $id
|
|
* @return mixed
|
|
*/
|
|
public function getById($id)
|
|
{
|
|
return $this->chapterQuery()->findOrFail($id);
|
|
}
|
|
|
|
/**
|
|
* Get all chapters.
|
|
* @return \Illuminate\Database\Eloquent\Collection|static[]
|
|
*/
|
|
public function getAll()
|
|
{
|
|
return $this->chapterQuery()->all();
|
|
}
|
|
|
|
/**
|
|
* Get a chapter that has the given slug within the given book.
|
|
* @param $slug
|
|
* @param $bookId
|
|
* @return mixed
|
|
* @throws NotFoundException
|
|
*/
|
|
public function getBySlug($slug, $bookId)
|
|
{
|
|
$chapter = $this->chapterQuery()->where('slug', '=', $slug)->where('book_id', '=', $bookId)->first();
|
|
if ($chapter === null) throw new NotFoundException('Chapter not found');
|
|
return $chapter;
|
|
}
|
|
|
|
/**
|
|
* Get the child items for a chapter
|
|
* @param Chapter $chapter
|
|
*/
|
|
public function getChildren(Chapter $chapter)
|
|
{
|
|
$pages = $this->restrictionService->enforcePageRestrictions($chapter->pages())->get();
|
|
// Sort items with drafts first then by priority.
|
|
return $pages->sortBy(function($child, $key) {
|
|
$score = $child->priority;
|
|
if ($child->draft) $score -= 100;
|
|
return $score;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Create a new chapter from request input.
|
|
* @param $input
|
|
* @param Book $book
|
|
* @return Chapter
|
|
*/
|
|
public function createFromInput($input, Book $book)
|
|
{
|
|
$chapter = $this->chapter->newInstance($input);
|
|
$chapter->slug = $this->findSuitableSlug($chapter->name, $book->id);
|
|
$chapter->created_by = auth()->user()->id;
|
|
$chapter->updated_by = auth()->user()->id;
|
|
$chapter = $book->chapters()->save($chapter);
|
|
$this->restrictionService->buildEntityPermissionsForEntity($chapter);
|
|
return $chapter;
|
|
}
|
|
|
|
/**
|
|
* Destroy a chapter and its relations by providing its slug.
|
|
* @param Chapter $chapter
|
|
*/
|
|
public function destroy(Chapter $chapter)
|
|
{
|
|
if (count($chapter->pages) > 0) {
|
|
foreach ($chapter->pages as $page) {
|
|
$page->chapter_id = 0;
|
|
$page->save();
|
|
}
|
|
}
|
|
Activity::removeEntity($chapter);
|
|
$chapter->views()->delete();
|
|
$chapter->restrictions()->delete();
|
|
$this->restrictionService->deleteEntityPermissionsForEntity($chapter);
|
|
$chapter->delete();
|
|
}
|
|
|
|
/**
|
|
* Check if a chapter's slug exists.
|
|
* @param $slug
|
|
* @param $bookId
|
|
* @param bool|false $currentId
|
|
* @return bool
|
|
*/
|
|
public function doesSlugExist($slug, $bookId, $currentId = false)
|
|
{
|
|
$query = $this->chapter->where('slug', '=', $slug)->where('book_id', '=', $bookId);
|
|
if ($currentId) {
|
|
$query = $query->where('id', '!=', $currentId);
|
|
}
|
|
return $query->count() > 0;
|
|
}
|
|
|
|
/**
|
|
* Finds a suitable slug for the provided name.
|
|
* Checks database to prevent duplicate slugs.
|
|
* @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;
|
|
}
|
|
|
|
/**
|
|
* Get a new priority value for a new page to be added
|
|
* to the given chapter.
|
|
* @param Chapter $chapter
|
|
* @return int
|
|
*/
|
|
public function getNewPriority(Chapter $chapter)
|
|
{
|
|
$lastPage = $chapter->pages->last();
|
|
return $lastPage !== null ? $lastPage->priority + 1 : 0;
|
|
}
|
|
|
|
/**
|
|
* Get chapters by the given search term.
|
|
* @param string $term
|
|
* @param array $whereTerms
|
|
* @param int $count
|
|
* @param array $paginationAppends
|
|
* @return mixed
|
|
*/
|
|
public function getBySearch($term, $whereTerms = [], $count = 20, $paginationAppends = [])
|
|
{
|
|
$terms = $this->prepareSearchTerms($term);
|
|
$chapters = $this->restrictionService->enforceChapterRestrictions($this->chapter->fullTextSearchQuery(['name', 'description'], $terms, $whereTerms))
|
|
->paginate($count)->appends($paginationAppends);
|
|
$words = join('|', explode(' ', preg_quote(trim($term), '/')));
|
|
foreach ($chapters as $chapter) {
|
|
//highlight
|
|
$result = preg_replace('#' . $words . '#iu', "<span class=\"highlight\">\$0</span>", $chapter->getExcerpt(100));
|
|
$chapter->searchSnippet = $result;
|
|
}
|
|
return $chapters;
|
|
}
|
|
|
|
/**
|
|
* Changes the book relation of this chapter.
|
|
* @param $bookId
|
|
* @param Chapter $chapter
|
|
* @return Chapter
|
|
*/
|
|
public function changeBook($bookId, Chapter $chapter)
|
|
{
|
|
$chapter->book_id = $bookId;
|
|
foreach ($chapter->activity as $activity) {
|
|
$activity->book_id = $bookId;
|
|
$activity->save();
|
|
}
|
|
$chapter->slug = $this->findSuitableSlug($chapter->name, $bookId, $chapter->id);
|
|
$chapter->save();
|
|
return $chapter;
|
|
}
|
|
|
|
} |