-<?php namespace Oxbow\Repos;
+<?php namespace BookStack\Repos;
+use Activity;
+use BookStack\Book;
+use BookStack\Exceptions\NotFoundException;
use Illuminate\Support\Str;
-use Oxbow\Chapter;
+use BookStack\Chapter;
-class ChapterRepo
+class ChapterRepo extends EntityRepo
{
-
- protected $chapter;
+ protected $pageRepo;
/**
* ChapterRepo constructor.
- * @param $chapter
+ * @param $pageRepo
*/
- public function __construct(Chapter $chapter)
+ public function __construct(PageRepo $pageRepo)
{
- $this->chapter = $chapter;
+ $this->pageRepo = $pageRepo;
+ parent::__construct();
}
+ /**
+ * Base query for getting chapters, Takes permissions into account.
+ * @return mixed
+ */
+ private function chapterQuery()
+ {
+ return $this->permissionService->enforceChapterRestrictions($this->chapter, 'view');
+ }
+
+ /**
+ * Check if an id exists.
+ * @param $id
+ * @return bool
+ */
public function idExists($id)
{
- return $this->chapter->where('id', '=', $id)->count() > 0;
+ 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->chapter->findOrFail($id);
+ return $this->chapterQuery()->findOrFail($id);
}
+ /**
+ * Get all chapters.
+ * @return \Illuminate\Database\Eloquent\Collection|static[]
+ */
public function getAll()
{
- return $this->chapter->all();
+ 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)
{
- return $this->chapter->where('slug', '=', $slug)->where('book_id', '=', $bookId)->first();
+ $chapter = $this->chapterQuery()->where('slug', '=', $slug)->where('book_id', '=', $bookId)->first();
+ if ($chapter === null) throw new NotFoundException(trans('errors.chapter_not_found'));
+ return $chapter;
+ }
+
+ /**
+ * Get the child items for a chapter
+ * @param Chapter $chapter
+ */
+ public function getChildren(Chapter $chapter)
+ {
+ $pages = $this->permissionService->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;
+ });
}
- public function newFromInput($input)
+ /**
+ * Create a new chapter from request input.
+ * @param $input
+ * @param Book $book
+ * @return Chapter
+ */
+ public function createFromInput($input, Book $book)
{
- return $this->chapter->fill($input);
+ $chapter = $this->chapter->newInstance($input);
+ $chapter->slug = $this->findSuitableSlug($chapter->name, $book->id);
+ $chapter->created_by = user()->id;
+ $chapter->updated_by = user()->id;
+ $chapter = $book->chapters()->save($chapter);
+ $this->permissionService->buildJointPermissionsForEntity($chapter);
+ return $chapter;
}
- public function destroyById($id)
+ /**
+ * Destroy a chapter and its relations by providing its slug.
+ * @param Chapter $chapter
+ */
+ public function destroy(Chapter $chapter)
{
- $page = $this->getById($id);
- $page->delete();
+ if (count($chapter->pages) > 0) {
+ foreach ($chapter->pages as $page) {
+ $page->chapter_id = 0;
+ $page->save();
+ }
+ }
+ Activity::removeEntity($chapter);
+ $chapter->views()->delete();
+ $chapter->permissions()->delete();
+ $this->permissionService->deleteJointPermissionsForEntity($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) {
+ 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 = $this->nameToSlug($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);
+ $chapterQuery = $this->permissionService->enforceChapterRestrictions($this->chapter->fullTextSearchQuery(['name', 'description'], $terms, $whereTerms));
+ $chapterQuery = $this->addAdvancedSearchQueries($chapterQuery, $term);
+ $chapters = $chapterQuery->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
+ * @param bool $rebuildPermissions
+ * @return Chapter
+ */
+ public function changeBook($bookId, Chapter $chapter, $rebuildPermissions = false)
+ {
+ $chapter->book_id = $bookId;
+ // Update related activity
+ foreach ($chapter->activity as $activity) {
+ $activity->book_id = $bookId;
+ $activity->save();
+ }
+ $chapter->slug = $this->findSuitableSlug($chapter->name, $bookId, $chapter->id);
+ $chapter->save();
+ // Update all child pages
+ foreach ($chapter->pages as $page) {
+ $this->pageRepo->changeBook($bookId, $page);
+ }
+
+ // Update permissions if applicable
+ if ($rebuildPermissions) {
+ $chapter->load('book');
+ $this->permissionService->buildJointPermissionsForEntity($chapter->book);
+ }
+
+ return $chapter;
+ }
+
}
\ No newline at end of file
projects / bookstack / blobdiff