X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/88049476fe496de3a3b767a4305d985f78a96db8..refs/pull/234/head:/app/Repos/BookRepo.php diff --git a/app/Repos/BookRepo.php b/app/Repos/BookRepo.php index 9d37cf952..b14cf0dab 100644 --- a/app/Repos/BookRepo.php +++ b/app/Repos/BookRepo.php @@ -1,38 +1,116 @@ book = $book; $this->pageRepo = $pageRepo; + $this->chapterRepo = $chapterRepo; + parent::__construct(); } + /** + * Base query for getting books. + * Takes into account any restrictions. + * @return mixed + */ + private function bookQuery() + { + return $this->permissionService->enforceBookRestrictions($this->book, 'view'); + } + + /** + * Get the book that has the given id. + * @param $id + * @return mixed + */ public function getById($id) { - return $this->book->findOrFail($id); + return $this->bookQuery()->findOrFail($id); + } + + /** + * Get all books, Limited by count. + * @param int $count + * @return mixed + */ + public function getAll($count = 10) + { + $bookQuery = $this->bookQuery()->orderBy('name', 'asc'); + if (!$count) return $bookQuery->get(); + return $bookQuery->take($count)->get(); + } + + /** + * Get all books paginated. + * @param int $count + * @return mixed + */ + public function getAllPaginated($count = 10) + { + return $this->bookQuery() + ->orderBy('name', 'asc')->paginate($count); } - public function getAll() + + /** + * Get the latest books. + * @param int $count + * @return mixed + */ + public function getLatest($count = 10) { - return $this->book->all(); + return $this->bookQuery()->orderBy('created_at', 'desc')->take($count)->get(); } + /** + * Gets the most recently viewed for a user. + * @param int $count + * @param int $page + * @return mixed + */ + public function getRecentlyViewed($count = 10, $page = 0) + { + return Views::getUserRecentlyViewed($count, $page, $this->book); + } + + /** + * Gets the most viewed books. + * @param int $count + * @param int $page + * @return mixed + */ + public function getPopular($count = 10, $page = 0) + { + return Views::getPopular($count, $page, $this->book); + } + + /** + * Get a book by slug + * @param $slug + * @return mixed + * @throws NotFoundException + */ public function getBySlug($slug) { - return $this->book->where('slug', '=', $slug)->first(); + $book = $this->bookQuery()->where('slug', '=', $slug)->first(); + if ($book === null) throw new NotFoundException(trans('errors.book_not_found')); + return $book; } /** @@ -42,67 +120,170 @@ class BookRepo */ public function exists($id) { - return $this->book->where('id', '=', $id)->exists(); + return $this->bookQuery()->where('id', '=', $id)->exists(); } /** * Get a new book instance from request input. - * @param $input + * @param array $input * @return Book */ - public function newFromInput($input) + public function createFromInput($input) { - return $this->book->fill($input); + $book = $this->book->newInstance($input); + $book->slug = $this->findSuitableSlug($book->name); + $book->created_by = user()->id; + $book->updated_by = user()->id; + $book->save(); + $this->permissionService->buildJointPermissionsForEntity($book); + return $book; } - public function countBySlug($slug) + /** + * Update the given book from user input. + * @param Book $book + * @param $input + * @return Book + */ + public function updateFromInput(Book $book, $input) { - return $this->book->where('slug', '=', $slug)->count(); + if ($book->name !== $input['name']) { + $book->slug = $this->findSuitableSlug($input['name'], $book->id); + } + $book->fill($input); + $book->updated_by = user()->id; + $book->save(); + $this->permissionService->buildJointPermissionsForEntity($book); + return $book; } - public function destroyBySlug($bookSlug) + /** + * Destroy the given book. + * @param Book $book + * @throws \Exception + */ + public function destroy(Book $book) { - $book = $this->getBySlug($bookSlug); - foreach($book->pages as $page) { - \Activity::removeEntity($page); - $page->delete(); + foreach ($book->pages as $page) { + $this->pageRepo->destroy($page); } - foreach($book->chapters as $chapter) { - \Activity::removeEntity($chapter); - $chapter->delete(); + foreach ($book->chapters as $chapter) { + $this->chapterRepo->destroy($chapter); } + $book->views()->delete(); + $book->permissions()->delete(); + $this->permissionService->deleteJointPermissionsForEntity($book); $book->delete(); } + /** + * Get the next child element priority. + * @param Book $book + * @return int + */ public function getNewPriority($book) { - $lastElem = $book->children()->pop(); + $lastElem = $this->getChildren($book)->pop(); return $lastElem ? $lastElem->priority + 1 : 0; } + /** + * @param string $slug + * @param bool|false $currentId + * @return bool + */ public function doesSlugExist($slug, $currentId = false) { $query = $this->book->where('slug', '=', $slug); - if($currentId) { + if ($currentId) { $query = $query->where('id', '!=', $currentId); } return $query->count() > 0; } + /** + * Provides a suitable slug for the given book name. + * Ensures the returned slug is unique in the system. + * @param string $name + * @param bool|false $currentId + * @return string + */ public function findSuitableSlug($name, $currentId = false) { - $slug = Str::slug($name); - while($this->doesSlugExist($slug, $currentId)) { + $slug = $this->nameToSlug($name); + while ($this->doesSlugExist($slug, $currentId)) { $slug .= '-' . substr(md5(rand(1, 500)), 0, 3); } return $slug; } - public function getBySearch($term) + /** + * Get all child objects of a book. + * Returns a sorted collection of Pages and Chapters. + * Loads the book slug onto child elements to prevent access database access for getting the slug. + * @param Book $book + * @param bool $filterDrafts + * @return mixed + */ + public function getChildren(Book $book, $filterDrafts = false) + { + $pageQuery = $book->pages()->where('chapter_id', '=', 0); + $pageQuery = $this->permissionService->enforcePageRestrictions($pageQuery, 'view'); + + if ($filterDrafts) { + $pageQuery = $pageQuery->where('draft', '=', false); + } + + $pages = $pageQuery->get(); + + $chapterQuery = $book->chapters()->with(['pages' => function ($query) use ($filterDrafts) { + $this->permissionService->enforcePageRestrictions($query, 'view'); + if ($filterDrafts) $query->where('draft', '=', false); + }]); + $chapterQuery = $this->permissionService->enforceChapterRestrictions($chapterQuery, 'view'); + $chapters = $chapterQuery->get(); + $children = $pages->values(); + foreach ($chapters as $chapter) { + $children->push($chapter); + } + $bookSlug = $book->slug; + + $children->each(function ($child) use ($bookSlug) { + $child->setAttribute('bookSlug', $bookSlug); + if ($child->isA('chapter')) { + $child->pages->each(function ($page) use ($bookSlug) { + $page->setAttribute('bookSlug', $bookSlug); + }); + $child->pages = $child->pages->sortBy(function ($child, $key) { + $score = $child->priority; + if ($child->draft) $score -= 100; + return $score; + }); + } + }); + + // Sort items with drafts first then by priority. + return $children->sortBy(function ($child, $key) { + $score = $child->priority; + if ($child->isA('page') && $child->draft) $score -= 100; + return $score; + }); + } + + /** + * Get books by search term. + * @param $term + * @param int $count + * @param array $paginationAppends + * @return mixed + */ + public function getBySearch($term, $count = 20, $paginationAppends = []) { - $terms = explode(' ', preg_quote(trim($term))); - $books = $this->book->fullTextSearch(['name', 'description'], $terms); - $words = join('|', $terms); + $terms = $this->prepareSearchTerms($term); + $bookQuery = $this->permissionService->enforceBookRestrictions($this->book->fullTextSearchQuery(['name', 'description'], $terms)); + $bookQuery = $this->addAdvancedSearchQueries($bookQuery, $term); + $books = $bookQuery->paginate($count)->appends($paginationAppends); + $words = join('|', explode(' ', preg_quote(trim($term), '/'))); foreach ($books as $book) { //highlight $result = preg_replace('#' . $words . '#iu', "\$0", $book->getExcerpt(100));