Merge branch 'master' into release

Author: ssddanbrown

.env.example

@@ -14,14 +14,28 @@ CACHE_DRIVER=file
 SESSION_DRIVER=file
 QUEUE_DRIVER=sync
 
+# Storage
+STORAGE_TYPE=local
+# Amazon S3 Config
+STORAGE_S3_KEY=false
+STORAGE_S3_SECRET=false
+STORAGE_S3_REGION=false
+STORAGE_S3_BUCKET=false
+# Storage URL
+# Used to prefix image urls for when using custom domains/cdns
+STORAGE_URL=false
+
 # Social Authentication information. Defaults as off.
 GITHUB_APP_ID=false
 GITHUB_APP_SECRET=false
 GOOGLE_APP_ID=false
 GOOGLE_APP_SECRET=false
-# URL for social login redirects, NO TRAILING SLASH
+# URL used for social login redirects, NO TRAILING SLASH
 APP_URL=http://bookstack.dev
 
+# External services
+USE_GRAVATAR=true
+
 # Mail settings
 MAIL_DRIVER=smtp
 MAIL_HOST=localhost

app/Entity.php

@@ -7,23 +7,7 @@
 abstract class Entity extends Model
 {
 
-    /**
-     * Relation for the user that created this entity.
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function createdBy()
-    {
-        return $this->belongsTo('BookStack\User', 'created_by');
-    }
-
-    /**
-     * Relation for the user that updated this entity.
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function updatedBy()
-    {
-        return $this->belongsTo('BookStack\User', 'updated_by');
-    }
+    use Ownable;
 
     /**
      * Compares this entity to another given entity.
@@ -97,18 +81,29 @@ public function userViews()
      */
     public static function isA($type)
     {
-        return static::getName() === strtolower($type);
+        return static::getClassName() === strtolower($type);
     }
 
     /**
      * Gets the class name.
      * @return string
      */
-    public static function getName()
+    public static function getClassName()
     {
         return strtolower(array_slice(explode('\\', static::class), -1, 1)[0]);
     }
 
+    /**
+     *Gets a limited-length version of the entities name.
+     * @param int $length
+     * @return string
+     */
+    public function getShortName($length = 25)
+    {
+        if(strlen($this->name) <= $length) return $this->name;
+        return substr($this->name, 0, $length-3) . '...';
+    }
+
     /**
      * Perform a full-text search on this entity.
      * @param string[] $fieldsToSearch
@@ -123,20 +118,20 @@ public static function fullTextSearch($fieldsToSearch, $terms, $wheres = [])
             $termString .= $term . '* ';
         }
         $fields = implode(',', $fieldsToSearch);
-        $search = static::whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
+        $termStringEscaped = \DB::connection()->getPdo()->quote($termString);
+        $search = static::addSelect(\DB::raw('*, MATCH(name) AGAINST('.$termStringEscaped.' IN BOOLEAN MODE) AS title_relevance'));
+        $search = $search->whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
+
+        // Add additional where terms
         foreach ($wheres as $whereTerm) {
             $search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
         }
 
-        if (!static::isA('book')) {
-            $search = $search->with('book');
-        }
-
-        if (static::isA('page')) {
-            $search = $search->with('chapter');
-        }
+        // Load in relations
+        if (!static::isA('book')) $search = $search->with('book');
+        if (static::isA('page'))  $search = $search->with('chapter');
 
-        return $search->get();
+        return $search->orderBy('title_relevance', 'desc')->get();
     }
 
     /**

app/Http/Controllers/BookController.php

@@ -42,8 +42,10 @@ public function __construct(BookRepo $bookRepo, PageRepo $pageRepo, ChapterRepo
     public function index()
     {
         $books = $this->bookRepo->getAllPaginated(10);
-        $recents = $this->signedIn ? $this->bookRepo->getRecentlyViewed(10, 0) : false;
-        return view('books/index', ['books' => $books, 'recents' => $recents]);
+        $recents = $this->signedIn ? $this->bookRepo->getRecentlyViewed(4, 0) : false;
+        $popular = $this->bookRepo->getPopular(4, 0);
+        $this->setPageTitle('Books');
+        return view('books/index', ['books' => $books, 'recents' => $recents, 'popular' => $popular]);
     }
 
     /**
@@ -54,6 +56,7 @@ public function index()
     public function create()
     {
         $this->checkPermission('book-create');
+        $this->setPageTitle('Create New Book');
         return view('books/create');
     }
 
@@ -88,8 +91,9 @@ public function store(Request $request)
     public function show($slug)
     {
         $book = $this->bookRepo->getBySlug($slug);
-        Views::add($book);
         $bookChildren = $this->bookRepo->getChildren($book);
+        Views::add($book);
+        $this->setPageTitle($book->getShortName());
         return view('books/show', ['book' => $book, 'current' => $book, 'bookChildren' => $bookChildren]);
     }
 
@@ -103,6 +107,7 @@ public function edit($slug)
     {
         $this->checkPermission('book-update');
         $book = $this->bookRepo->getBySlug($slug);
+        $this->setPageTitle('Edit Book ' . $book->getShortName());
         return view('books/edit', ['book' => $book, 'current' => $book]);
     }
 
@@ -138,6 +143,7 @@ public function showDelete($bookSlug)
     {
         $this->checkPermission('book-delete');
         $book = $this->bookRepo->getBySlug($bookSlug);
+        $this->setPageTitle('Delete Book ' . $book->getShortName());
         return view('books/delete', ['book' => $book, 'current' => $book]);
     }
 
@@ -152,9 +158,16 @@ public function sort($bookSlug)
         $book = $this->bookRepo->getBySlug($bookSlug);
         $bookChildren = $this->bookRepo->getChildren($book);
         $books = $this->bookRepo->getAll();
+        $this->setPageTitle('Sort Book ' . $book->getShortName());
         return view('books/sort', ['book' => $book, 'current' => $book, 'books' => $books, 'bookChildren' => $bookChildren]);
     }
 
+    /**
+     * Shows the sort box for a single book.
+     * Used via AJAX when loading in extra books to a sort.
+     * @param $bookSlug
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     */
     public function getSortItem($bookSlug)
     {
         $book = $this->bookRepo->getBySlug($bookSlug);

app/Http/Controllers/ChapterController.php

@@ -40,6 +40,7 @@ public function create($bookSlug)
     {
         $this->checkPermission('chapter-create');
         $book = $this->bookRepo->getBySlug($bookSlug);
+        $this->setPageTitle('Create New Chapter');
         return view('chapters/create', ['book' => $book, 'current' => $book]);
     }
 
@@ -79,6 +80,7 @@ public function show($bookSlug, $chapterSlug)
         $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
         $sidebarTree = $this->bookRepo->getChildren($book);
         Views::add($chapter);
+        $this->setPageTitle($chapter->getShortName());
         return view('chapters/show', ['book' => $book, 'chapter' => $chapter, 'current' => $chapter, 'sidebarTree' => $sidebarTree]);
     }
 
@@ -93,6 +95,7 @@ public function edit($bookSlug, $chapterSlug)
         $this->checkPermission('chapter-update');
         $book = $this->bookRepo->getBySlug($bookSlug);
         $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
+        $this->setPageTitle('Edit Chapter' . $chapter->getShortName());
         return view('chapters/edit', ['book' => $book, 'chapter' => $chapter, 'current' => $chapter]);
     }
 
@@ -127,6 +130,7 @@ public function showDelete($bookSlug, $chapterSlug)
         $this->checkPermission('chapter-delete');
         $book = $this->bookRepo->getBySlug($bookSlug);
         $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
+        $this->setPageTitle('Delete Chapter' . $chapter->getShortName());
         return view('chapters/delete', ['book' => $book, 'chapter' => $chapter, 'current' => $chapter]);
     }
 

app/Http/Controllers/Controller.php

@@ -42,6 +42,15 @@ public function __construct()
         $this->signedIn = auth()->check();
     }
 
+    /**
+     * Adds the page title into the view.
+     * @param $title
+     */
+    public function setPageTitle($title)
+    {
+        view()->share('pageTitle', $title);
+    }
+
     /**
      * Checks for a permission.
      *