BookStack/app/Repos/BookRepo.php

260 lines
7.2 KiB
PHP
Raw Normal View History

<?php namespace BookStack\Repos;
2015-07-12 21:01:42 +02:00
use BookStack\Exceptions\NotFoundException;
use Illuminate\Support\Str;
use BookStack\Book;
use Views;
2015-07-12 21:01:42 +02:00
class BookRepo extends EntityRepo
2015-07-12 21:01:42 +02:00
{
2015-07-12 22:31:15 +02:00
protected $pageRepo;
protected $chapterRepo;
2015-07-12 21:01:42 +02:00
/**
* BookRepo constructor.
* @param PageRepo $pageRepo
* @param ChapterRepo $chapterRepo
2015-07-12 21:01:42 +02:00
*/
public function __construct(PageRepo $pageRepo, ChapterRepo $chapterRepo)
2015-07-12 21:01:42 +02:00
{
2015-07-12 22:31:15 +02:00
$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->restrictionService->enforceBookRestrictions($this->book, 'view');
2015-07-12 21:01:42 +02:00
}
/**
* Get the book that has the given id.
* @param $id
* @return mixed
*/
2015-07-12 21:01:42 +02:00
public function getById($id)
{
return $this->bookQuery()->findOrFail($id);
2015-07-12 21:01:42 +02:00
}
/**
* Get all books, Limited by count.
* @param int $count
* @return mixed
*/
public function getAll($count = 10)
2015-07-12 21:01:42 +02:00
{
$bookQuery = $this->bookQuery()->orderBy('name', 'asc');
if (!$count) return $bookQuery->get();
return $bookQuery->take($count)->get();
2015-07-12 21:01:42 +02:00
}
2015-11-09 20:46:04 +01:00
/**
* Get all books paginated.
2015-11-09 20:46:04 +01:00
* @param int $count
* @return mixed
*/
public function getAllPaginated($count = 10)
{
return $this->bookQuery()
->orderBy('name', 'asc')->paginate($count);
2015-11-09 20:46:04 +01:00
}
/**
* Get the latest books.
* @param int $count
* @return mixed
*/
public function getLatest($count = 10)
{
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
*/
2015-07-12 21:01:42 +02:00
public function getBySlug($slug)
{
$book = $this->bookQuery()->where('slug', '=', $slug)->first();
if ($book === null) throw new NotFoundException('Book not found');
2015-12-28 18:19:23 +01:00
return $book;
2015-07-12 21:01:42 +02:00
}
2015-09-06 15:35:53 +02:00
/**
* Checks if a book exists.
* @param $id
* @return bool
*/
public function exists($id)
{
return $this->bookQuery()->where('id', '=', $id)->exists();
2015-09-06 15:35:53 +02:00
}
/**
* Get a new book instance from request input.
* @param $input
* @return Book
*/
2015-07-12 21:01:42 +02:00
public function newFromInput($input)
{
return $this->book->newInstance($input);
2015-07-12 21:01:42 +02:00
}
/**
* Destroy a book identified by the given slug.
* @param $bookSlug
*/
public function destroyBySlug($bookSlug)
2015-07-12 21:01:42 +02:00
{
$book = $this->getBySlug($bookSlug);
2015-11-09 20:46:04 +01:00
foreach ($book->pages as $page) {
$this->pageRepo->destroy($page);
2015-07-31 00:18:48 +02:00
}
2015-11-09 20:46:04 +01:00
foreach ($book->chapters as $chapter) {
$this->chapterRepo->destroy($chapter);
2015-07-12 22:31:15 +02:00
}
$book->views()->delete();
$book->restrictions()->delete();
2015-07-12 21:01:42 +02:00
$book->delete();
}
/**
* Get the next child element priority.
* @param Book $book
* @return int
*/
public function getNewPriority($book)
2015-07-20 23:05:26 +02:00
{
$lastElem = $this->getChildren($book)->pop();
return $lastElem ? $lastElem->priority + 1 : 0;
2015-07-20 23:05:26 +02:00
}
/**
* @param string $slug
* @param bool|false $currentId
* @return bool
*/
public function doesSlugExist($slug, $currentId = false)
{
$query = $this->book->where('slug', '=', $slug);
2015-11-09 20:46:04 +01:00
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)
{
2015-09-29 22:25:03 +02:00
$originalSlug = Str::slug($name);
$slug = $originalSlug;
$count = 2;
2015-11-09 20:46:04 +01:00
while ($this->doesSlugExist($slug, $currentId)) {
2015-09-29 22:25:03 +02:00
$slug = $originalSlug . '-' . $count;
$count++;
}
return $slug;
}
/**
* Get all child objects of a book.
* Returns a sorted collection of Pages and Chapters.
* Loads the bookslug onto child elements to prevent access database access for getting the slug.
* @param Book $book
* @return mixed
*/
public function getChildren(Book $book)
{
$pageQuery = $book->pages()->where('chapter_id', '=', 0);
$pageQuery = $this->restrictionService->enforcePageRestrictions($pageQuery, 'view');
$pages = $pageQuery->get();
$chapterQuery = $book->chapters()->with(['pages' => function($query) {
$this->restrictionService->enforcePageRestrictions($query, 'view');
}]);
$chapterQuery = $this->restrictionService->enforceChapterRestrictions($chapterQuery, 'view');
$chapters = $chapterQuery->get();
$children = $pages->merge($chapters);
$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 = $this->prepareSearchTerms($term);
$books = $this->restrictionService->enforceBookRestrictions($this->book->fullTextSearchQuery(['name', 'description'], $terms))
->paginate($count)->appends($paginationAppends);
$words = join('|', explode(' ', preg_quote(trim($term), '/')));
foreach ($books as $book) {
//highlight
$result = preg_replace('#' . $words . '#iu', "<span class=\"highlight\">\$0</span>", $book->getExcerpt(100));
$book->searchSnippet = $result;
}
return $books;
}
2015-07-12 21:01:42 +02:00
}