mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-12-05 15:53:37 +08:00
f634b4ea57
Not totally happy with implementation as is requires extra service to be injected to core controllers, but does the job. Included test to cover. Updated some controller properties to be typed while there.
293 lines
9.1 KiB
PHP
293 lines
9.1 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Http\Controllers;
|
|
|
|
use BookStack\Actions\ActivityQueries;
|
|
use BookStack\Actions\ActivityType;
|
|
use BookStack\Actions\View;
|
|
use BookStack\Entities\Models\Bookshelf;
|
|
use BookStack\Entities\Repos\BookRepo;
|
|
use BookStack\Entities\Tools\BookContents;
|
|
use BookStack\Entities\Tools\Cloner;
|
|
use BookStack\Entities\Tools\HierarchyTransformer;
|
|
use BookStack\Entities\Tools\PermissionsUpdater;
|
|
use BookStack\Entities\Tools\ShelfContext;
|
|
use BookStack\Exceptions\ImageUploadException;
|
|
use BookStack\Exceptions\NotFoundException;
|
|
use BookStack\Facades\Activity;
|
|
use BookStack\References\ReferenceFetcher;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Validation\ValidationException;
|
|
use Throwable;
|
|
|
|
class BookController extends Controller
|
|
{
|
|
protected BookRepo $bookRepo;
|
|
protected ShelfContext $shelfContext;
|
|
protected ReferenceFetcher $referenceFetcher;
|
|
|
|
public function __construct(ShelfContext $entityContextManager, BookRepo $bookRepo, ReferenceFetcher $referenceFetcher)
|
|
{
|
|
$this->bookRepo = $bookRepo;
|
|
$this->shelfContext = $entityContextManager;
|
|
$this->referenceFetcher = $referenceFetcher;
|
|
}
|
|
|
|
/**
|
|
* Display a listing of the book.
|
|
*/
|
|
public function index()
|
|
{
|
|
$view = setting()->getForCurrentUser('books_view_type');
|
|
$sort = setting()->getForCurrentUser('books_sort', 'name');
|
|
$order = setting()->getForCurrentUser('books_sort_order', 'asc');
|
|
|
|
$books = $this->bookRepo->getAllPaginated(18, $sort, $order);
|
|
$recents = $this->isSignedIn() ? $this->bookRepo->getRecentlyViewed(4) : false;
|
|
$popular = $this->bookRepo->getPopular(4);
|
|
$new = $this->bookRepo->getRecentlyCreated(4);
|
|
|
|
$this->shelfContext->clearShelfContext();
|
|
|
|
$this->setPageTitle(trans('entities.books'));
|
|
|
|
return view('books.index', [
|
|
'books' => $books,
|
|
'recents' => $recents,
|
|
'popular' => $popular,
|
|
'new' => $new,
|
|
'view' => $view,
|
|
'sort' => $sort,
|
|
'order' => $order,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Show the form for creating a new book.
|
|
*/
|
|
public function create(string $shelfSlug = null)
|
|
{
|
|
$this->checkPermission('book-create-all');
|
|
|
|
$bookshelf = null;
|
|
if ($shelfSlug !== null) {
|
|
$bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail();
|
|
$this->checkOwnablePermission('bookshelf-update', $bookshelf);
|
|
}
|
|
|
|
$this->setPageTitle(trans('entities.books_create'));
|
|
|
|
return view('books.create', [
|
|
'bookshelf' => $bookshelf,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Store a newly created book in storage.
|
|
*
|
|
* @throws ImageUploadException
|
|
* @throws ValidationException
|
|
*/
|
|
public function store(Request $request, string $shelfSlug = null)
|
|
{
|
|
$this->checkPermission('book-create-all');
|
|
$validated = $this->validate($request, [
|
|
'name' => ['required', 'string', 'max:255'],
|
|
'description' => ['string', 'max:1000'],
|
|
'image' => array_merge(['nullable'], $this->getImageValidationRules()),
|
|
'tags' => ['array'],
|
|
]);
|
|
|
|
$bookshelf = null;
|
|
if ($shelfSlug !== null) {
|
|
$bookshelf = Bookshelf::visible()->where('slug', '=', $shelfSlug)->firstOrFail();
|
|
$this->checkOwnablePermission('bookshelf-update', $bookshelf);
|
|
}
|
|
|
|
$book = $this->bookRepo->create($validated);
|
|
|
|
if ($bookshelf) {
|
|
$bookshelf->appendBook($book);
|
|
Activity::add(ActivityType::BOOKSHELF_UPDATE, $bookshelf);
|
|
}
|
|
|
|
return redirect($book->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Display the specified book.
|
|
*/
|
|
public function show(Request $request, ActivityQueries $activities, string $slug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($slug);
|
|
$bookChildren = (new BookContents($book))->getTree(true);
|
|
$bookParentShelves = $book->shelves()->scopes('visible')->get();
|
|
|
|
View::incrementFor($book);
|
|
if ($request->has('shelf')) {
|
|
$this->shelfContext->setShelfContext(intval($request->get('shelf')));
|
|
}
|
|
|
|
$this->setPageTitle($book->getShortName());
|
|
|
|
return view('books.show', [
|
|
'book' => $book,
|
|
'current' => $book,
|
|
'bookChildren' => $bookChildren,
|
|
'bookParentShelves' => $bookParentShelves,
|
|
'activity' => $activities->entityActivity($book, 20, 1),
|
|
'referenceCount' => $this->referenceFetcher->getPageReferenceCountToEntity($book),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Show the form for editing the specified book.
|
|
*/
|
|
public function edit(string $slug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($slug);
|
|
$this->checkOwnablePermission('book-update', $book);
|
|
$this->setPageTitle(trans('entities.books_edit_named', ['bookName'=>$book->getShortName()]));
|
|
|
|
return view('books.edit', ['book' => $book, 'current' => $book]);
|
|
}
|
|
|
|
/**
|
|
* Update the specified book in storage.
|
|
*
|
|
* @throws ImageUploadException
|
|
* @throws ValidationException
|
|
* @throws Throwable
|
|
*/
|
|
public function update(Request $request, string $slug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($slug);
|
|
$this->checkOwnablePermission('book-update', $book);
|
|
|
|
$validated = $this->validate($request, [
|
|
'name' => ['required', 'string', 'max:255'],
|
|
'description' => ['string', 'max:1000'],
|
|
'image' => array_merge(['nullable'], $this->getImageValidationRules()),
|
|
'tags' => ['array'],
|
|
]);
|
|
|
|
if ($request->has('image_reset')) {
|
|
$validated['image'] = null;
|
|
} elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {
|
|
unset($validated['image']);
|
|
}
|
|
|
|
$book = $this->bookRepo->update($book, $validated);
|
|
|
|
return redirect($book->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Shows the page to confirm deletion.
|
|
*/
|
|
public function showDelete(string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('book-delete', $book);
|
|
$this->setPageTitle(trans('entities.books_delete_named', ['bookName' => $book->getShortName()]));
|
|
|
|
return view('books.delete', ['book' => $book, 'current' => $book]);
|
|
}
|
|
|
|
/**
|
|
* Remove the specified book from the system.
|
|
*
|
|
* @throws Throwable
|
|
*/
|
|
public function destroy(string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('book-delete', $book);
|
|
|
|
$this->bookRepo->destroy($book);
|
|
|
|
return redirect('/books');
|
|
}
|
|
|
|
/**
|
|
* Show the permissions view.
|
|
*/
|
|
public function showPermissions(string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('restrictions-manage', $book);
|
|
|
|
return view('books.permissions', [
|
|
'book' => $book,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Set the restrictions for this book.
|
|
*
|
|
* @throws Throwable
|
|
*/
|
|
public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('restrictions-manage', $book);
|
|
|
|
$permissionsUpdater->updateFromPermissionsForm($book, $request);
|
|
|
|
$this->showSuccessNotification(trans('entities.books_permissions_updated'));
|
|
|
|
return redirect($book->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Show the view to copy a book.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function showCopy(string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('book-view', $book);
|
|
|
|
session()->flashInput(['name' => $book->name]);
|
|
|
|
return view('books.copy', [
|
|
'book' => $book,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Create a copy of a book within the requested target destination.
|
|
*
|
|
* @throws NotFoundException
|
|
*/
|
|
public function copy(Request $request, Cloner $cloner, string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('book-view', $book);
|
|
$this->checkPermission('book-create-all');
|
|
|
|
$newName = $request->get('name') ?: $book->name;
|
|
$bookCopy = $cloner->cloneBook($book, $newName);
|
|
$this->showSuccessNotification(trans('entities.books_copy_success'));
|
|
|
|
return redirect($bookCopy->getUrl());
|
|
}
|
|
|
|
/**
|
|
* Convert the chapter to a book.
|
|
*/
|
|
public function convertToShelf(HierarchyTransformer $transformer, string $bookSlug)
|
|
{
|
|
$book = $this->bookRepo->getBySlug($bookSlug);
|
|
$this->checkOwnablePermission('book-update', $book);
|
|
$this->checkOwnablePermission('book-delete', $book);
|
|
$this->checkPermission('bookshelf-create-all');
|
|
$this->checkPermission('book-create-all');
|
|
|
|
$shelf = $transformer->transformBookToShelf($book);
|
|
|
|
return redirect($shelf->getUrl());
|
|
}
|
|
}
|