2019-12-28 15:58:07 +01:00
|
|
|
<?php namespace BookStack\Http\Controllers\Api;
|
|
|
|
|
|
|
|
use BookStack\Entities\Book;
|
2020-01-12 15:45:54 +01:00
|
|
|
use BookStack\Entities\Repos\BookRepo;
|
2020-01-15 21:18:02 +01:00
|
|
|
use BookStack\Exceptions\NotifyException;
|
2020-01-12 15:45:54 +01:00
|
|
|
use BookStack\Facades\Activity;
|
2020-01-15 21:18:02 +01:00
|
|
|
use Illuminate\Contracts\Container\BindingResolutionException;
|
2020-01-12 15:45:54 +01:00
|
|
|
use Illuminate\Http\Request;
|
2020-01-15 21:18:02 +01:00
|
|
|
use Illuminate\Validation\ValidationException;
|
2019-12-28 15:58:07 +01:00
|
|
|
|
2020-05-23 01:28:41 +02:00
|
|
|
class BookApiController extends ApiController
|
2019-12-28 15:58:07 +01:00
|
|
|
{
|
2020-01-12 15:45:54 +01:00
|
|
|
|
|
|
|
protected $bookRepo;
|
|
|
|
|
|
|
|
protected $rules = [
|
2020-01-01 17:33:47 +01:00
|
|
|
'create' => [
|
2020-01-12 15:45:54 +01:00
|
|
|
'name' => 'required|string|max:255',
|
|
|
|
'description' => 'string|max:1000',
|
2020-05-23 01:28:41 +02:00
|
|
|
'tags' => 'array',
|
2020-01-01 17:33:47 +01:00
|
|
|
],
|
|
|
|
'update' => [
|
2020-01-12 15:45:54 +01:00
|
|
|
'name' => 'string|min:1|max:255',
|
|
|
|
'description' => 'string|max:1000',
|
2020-05-23 01:28:41 +02:00
|
|
|
'tags' => 'array',
|
2020-01-01 17:33:47 +01:00
|
|
|
],
|
|
|
|
];
|
|
|
|
|
2020-01-12 15:45:54 +01:00
|
|
|
/**
|
|
|
|
* BooksApiController constructor.
|
|
|
|
*/
|
|
|
|
public function __construct(BookRepo $bookRepo)
|
|
|
|
{
|
|
|
|
$this->bookRepo = $bookRepo;
|
|
|
|
}
|
|
|
|
|
2019-12-28 15:58:07 +01:00
|
|
|
/**
|
|
|
|
* Get a listing of books visible to the user.
|
|
|
|
*/
|
2020-01-18 15:03:11 +01:00
|
|
|
public function list()
|
2019-12-28 15:58:07 +01:00
|
|
|
{
|
|
|
|
$books = Book::visible();
|
|
|
|
return $this->apiListingResponse($books, [
|
2020-01-12 15:45:54 +01:00
|
|
|
'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'image_id',
|
2019-12-28 15:58:07 +01:00
|
|
|
]);
|
|
|
|
}
|
2020-01-01 17:33:47 +01:00
|
|
|
|
2020-01-12 15:45:54 +01:00
|
|
|
/**
|
2020-01-15 21:18:02 +01:00
|
|
|
* Create a new book in the system.
|
|
|
|
* @throws ValidationException
|
2020-01-12 15:45:54 +01:00
|
|
|
*/
|
|
|
|
public function create(Request $request)
|
2020-01-01 17:33:47 +01:00
|
|
|
{
|
2020-01-12 15:45:54 +01:00
|
|
|
$this->checkPermission('book-create-all');
|
|
|
|
$requestData = $this->validate($request, $this->rules['create']);
|
|
|
|
|
|
|
|
$book = $this->bookRepo->create($requestData);
|
|
|
|
Activity::add($book, 'book_create', $book->id);
|
|
|
|
|
|
|
|
return response()->json($book);
|
2020-01-01 17:33:47 +01:00
|
|
|
}
|
|
|
|
|
2020-01-12 15:45:54 +01:00
|
|
|
/**
|
|
|
|
* View the details of a single book.
|
|
|
|
*/
|
|
|
|
public function read(string $id)
|
2020-01-01 17:33:47 +01:00
|
|
|
{
|
2020-01-12 15:45:54 +01:00
|
|
|
$book = Book::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy'])->findOrFail($id);
|
|
|
|
return response()->json($book);
|
2020-01-01 17:33:47 +01:00
|
|
|
}
|
|
|
|
|
2020-01-12 15:45:54 +01:00
|
|
|
/**
|
|
|
|
* Update the details of a single book.
|
2020-01-15 21:18:02 +01:00
|
|
|
* @throws ValidationException
|
2020-01-12 15:45:54 +01:00
|
|
|
*/
|
|
|
|
public function update(Request $request, string $id)
|
2020-01-01 17:33:47 +01:00
|
|
|
{
|
2020-01-12 15:45:54 +01:00
|
|
|
$book = Book::visible()->findOrFail($id);
|
|
|
|
$this->checkOwnablePermission('book-update', $book);
|
|
|
|
|
|
|
|
$requestData = $this->validate($request, $this->rules['update']);
|
|
|
|
$book = $this->bookRepo->update($book, $requestData);
|
|
|
|
Activity::add($book, 'book_update', $book->id);
|
|
|
|
|
|
|
|
return response()->json($book);
|
2020-01-01 17:33:47 +01:00
|
|
|
}
|
|
|
|
|
2020-01-12 15:45:54 +01:00
|
|
|
/**
|
2020-01-15 21:18:02 +01:00
|
|
|
* Delete a single book from the system.
|
|
|
|
* @throws NotifyException
|
|
|
|
* @throws BindingResolutionException
|
2020-01-12 15:45:54 +01:00
|
|
|
*/
|
|
|
|
public function delete(string $id)
|
2020-01-01 17:33:47 +01:00
|
|
|
{
|
2020-01-12 15:45:54 +01:00
|
|
|
$book = Book::visible()->findOrFail($id);
|
|
|
|
$this->checkOwnablePermission('book-delete', $book);
|
|
|
|
|
|
|
|
$this->bookRepo->destroy($book);
|
|
|
|
Activity::addMessage('book_delete', $book->name);
|
|
|
|
|
|
|
|
return response('', 204);
|
2020-01-01 17:33:47 +01:00
|
|
|
}
|
2019-12-28 15:58:07 +01:00
|
|
|
}
|