replace GPL diff lib with MIT lib

[bookstack] / app / Repos / BookRepo.php

diff --git a/app/Repos/BookRepo.php b/app/Repos/BookRepo.php
index b7189aaf0fbf7712c61838a04499aa4cb9dc4e03..a11ed2763c9ce51ad7efc23d1678e1f06eeb9af1 100644 (file)
--- a/app/Repos/BookRepo.php
+++ b/app/Repos/BookRepo.php
@@ -1,28 +1,36 @@
 <?php namespace BookStack\Repos;
 
 <?php namespace BookStack\Repos;
 

-use Activity;
+use Alpha\B;
+use BookStack\Exceptions\NotFoundException;

 use Illuminate\Support\Str;
 use BookStack\Book;
 use Views;
 
 use Illuminate\Support\Str;
 use BookStack\Book;
 use Views;
 

-class BookRepo
+class BookRepo extends EntityRepo

 {
 {

-
-    protected $book;

     protected $pageRepo;
     protected $chapterRepo;
 
     /**
      * BookRepo constructor.
     protected $pageRepo;
     protected $chapterRepo;
 
     /**
      * BookRepo constructor.

-     * @param Book        $book
-     * @param PageRepo    $pageRepo
+     * @param PageRepo $pageRepo

      * @param ChapterRepo $chapterRepo
      */
      * @param ChapterRepo $chapterRepo
      */

-    public function __construct(Book $book, PageRepo $pageRepo, ChapterRepo $chapterRepo)
+    public function __construct(PageRepo $pageRepo, ChapterRepo $chapterRepo)

     {
     {

-        $this->book = $book;

         $this->pageRepo = $pageRepo;
         $this->chapterRepo = $chapterRepo;
         $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');

     }
 
     /**
     }
 
     /**


@@ -32,7 +40,7 @@ class BookRepo
      */
     public function getById($id)
     {
      */
     public function getById($id)
     {

-        return $this->book->findOrFail($id);
+        return $this->bookQuery()->findOrFail($id);

     }
 
     /**
     }
 
     /**


@@ -42,7 +50,9 @@ class BookRepo
      */
     public function getAll($count = 10)
     {
      */
     public function getAll($count = 10)
     {

-        return $this->book->orderBy('name', 'asc')->take($count)->get();
+        $bookQuery = $this->bookQuery()->orderBy('name', 'asc');
+        if (!$count) return $bookQuery->get();
+        return $bookQuery->take($count)->get();

     }
 
     /**
     }
 
     /**


@@ -52,7 +62,8 @@ class BookRepo
      */
     public function getAllPaginated($count = 10)
     {
      */
     public function getAllPaginated($count = 10)
     {

-        return $this->book->orderBy('name', 'asc')->paginate($count);
+        return $this->bookQuery()
+            ->orderBy('name', 'asc')->paginate($count);

     }
 
 
     }
 
 


@@ -63,7 +74,7 @@ class BookRepo
      */
     public function getLatest($count = 10)
     {
      */
     public function getLatest($count = 10)
     {

-        return $this->book->orderBy('created_at', 'desc')->take($count)->get();
+        return $this->bookQuery()->orderBy('created_at', 'desc')->take($count)->get();

     }
 
     /**
     }
 
     /**


@@ -77,14 +88,28 @@ class BookRepo
         return Views::getUserRecentlyViewed($count, $page, $this->book);
     }
 
         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
     /**
      * Get a book by slug
      * @param $slug
      * @return mixed

+     * @throws NotFoundException

      */
     public function getBySlug($slug)
     {
      */
     public function getBySlug($slug)
     {

-        return $this->book->where('slug', '=', $slug)->first();
+        $book = $this->bookQuery()->where('slug', '=', $slug)->first();
+        if ($book === null) throw new NotFoundException('Book not found');
+        return $book;

     }
 
     /**
     }
 
     /**


@@ -94,36 +119,48 @@ class BookRepo
      */
     public function exists($id)
     {
      */
     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.
     }
 
     /**
      * Get a new book instance from request input.

-     * @param $input
+     * @param array $input

      * @return Book
      */
      * @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 = auth()->user()->id;
+        $book->updated_by = auth()->user()->id;
+        $book->save();
+        $this->permissionService->buildJointPermissionsForEntity($book);
+        return $book;

     }
 
     /**
     }
 
     /**

-     * Count the amount of books that have a specific slug.
-     * @param $slug
-     * @return mixed
+     * Update the given book from user input.
+     * @param Book $book
+     * @param $input
+     * @return Book

      */
      */

-    public function countBySlug($slug)
+    public function updateFromInput(Book $book, $input)

     {
     {

-        return $this->book->where('slug', '=', $slug)->count();
+        $book->fill($input);
+        $book->slug = $this->findSuitableSlug($book->name, $book->id);
+        $book->updated_by = auth()->user()->id;
+        $book->save();
+        $this->permissionService->buildJointPermissionsForEntity($book);
+        return $book;

     }
 
     /**
     }
 
     /**

-     * Destroy a book identified by the given slug.
-     * @param $bookSlug
+     * Destroy the given book.
+     * @param Book $book
+     * @throws \Exception

      */
      */

-    public function destroyBySlug($bookSlug)
+    public function destroy(Book $book)

     {
     {

-        $book = $this->getBySlug($bookSlug);

         foreach ($book->pages as $page) {
             $this->pageRepo->destroy($page);
         }
         foreach ($book->pages as $page) {
             $this->pageRepo->destroy($page);
         }


@@ -131,9 +168,20 @@ class BookRepo
             $this->chapterRepo->destroy($chapter);
         }
         $book->views()->delete();
             $this->chapterRepo->destroy($chapter);
         }
         $book->views()->delete();

+        $book->permissions()->delete();
+        $this->permissionService->deleteJointPermissionsForEntity($book);

         $book->delete();
     }
 
         $book->delete();
     }
 

+    /**
+     * Alias method to update the book jointPermissions in the PermissionService.
+     * @param Book $book
+     */
+    public function updateBookPermissions(Book $book)
+    {
+        $this->permissionService->buildJointPermissionsForEntity($book);
+    }
+

     /**
      * Get the next child element priority.
      * @param Book $book
     /**
      * Get the next child element priority.
      * @param Book $book


@@ -141,12 +189,12 @@ class BookRepo
      */
     public function getNewPriority($book)
     {
      */
     public function getNewPriority($book)
     {

-        $lastElem = $book->children()->pop();
+        $lastElem = $this->getChildren($book)->pop();

         return $lastElem ? $lastElem->priority + 1 : 0;
     }
 
     /**
         return $lastElem ? $lastElem->priority + 1 : 0;
     }
 
     /**

-     * @param string     $slug
+     * @param string $slug

      * @param bool|false $currentId
      * @return bool
      */
      * @param bool|false $currentId
      * @return bool
      */


@@ -162,7 +210,7 @@ class BookRepo
     /**
      * Provides a suitable slug for the given book name.
      * Ensures the returned slug is unique in the system.
     /**
      * Provides a suitable slug for the given book name.
      * Ensures the returned slug is unique in the system.

-     * @param string     $name
+     * @param string $name

      * @param bool|false $currentId
      * @return string
      */
      * @param bool|false $currentId
      * @return string
      */


@@ -178,16 +226,73 @@ class BookRepo
         return $slug;
     }
 
         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
+     * @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
     /**
      * Get books by search term.
      * @param $term

+     * @param int $count
+     * @param array $paginationAppends

      * @return mixed
      */
      * @return mixed
      */

-    public function getBySearch($term)
+    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', "<span class=\"highlight\">\$0</span>", $book->getExcerpt(100));
         foreach ($books as $book) {
             //highlight
             $result = preg_replace('#' . $words . '#iu', "<span class=\"highlight\">\$0</span>", $book->getExcerpt(100));