mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
ff8dadefee
Made the following changes, many of these are just to align with existing conventions. - Updated urls to be hypenated, instead of underscored, to match other system endpoints. - Updated URL parameter to be `deletionId` instead of `id`, and removed the ID-based comment on controller methods, so the required ID model is clear from the URL alone, since its not clear from the URL endpoint alone like existing endpoints. This follows the pattern used in the "web" routes. - Added extra detail on some controller method comments, and copied permission comment to each method. - Removed existing field visibility mechanisms to use simpler model-based visibility since we didn't need anything too special here (After some of my other changes). - Allowed the "deletable" model to be shown in response to provide a little more detail on the main deleted item. - Updated parent/child-count loading to be on the "deletable" model instead of additional properties which results in simpler controller logic and enforces the idea these are relations on the deletable, not the deletion itself. It also removes additional exposure of model namespacing. - Updated (int) casts to intval, just since that's our most common conversion method in the codebase. - Testing: Removed `actingAsAuthorizedUser` and used the admin user instead to prevent extra auth steps on each test. - Testing: Cut logic/data-checks from tests if already covered by other tests. - Testing: Added simple assertions for delete/restore response data. - Examples: Updated list example to reflect changes. Review of PR #3377 To be followed up with changes to polymorphic relations to hide namespacing.
91 lines
3.0 KiB
PHP
91 lines
3.0 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Http\Controllers\Api;
|
|
|
|
use BookStack\Entities\Models\Book;
|
|
use BookStack\Entities\Models\BookChild;
|
|
use BookStack\Entities\Models\Chapter;
|
|
use BookStack\Entities\Models\Deletion;
|
|
use BookStack\Entities\Repos\DeletionRepo;
|
|
use Closure;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
|
|
class RecycleBinApiController extends ApiController
|
|
{
|
|
public function __construct()
|
|
{
|
|
$this->middleware(function ($request, $next) {
|
|
$this->checkPermission('settings-manage');
|
|
$this->checkPermission('restrictions-manage-all');
|
|
|
|
return $next($request);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get a top-level listing of the items in the recycle bin.
|
|
* The "deletable" property will reflect the main item deleted.
|
|
* For books and chapters, counts of child pages/chapters will
|
|
* be loaded within this "deletable" data.
|
|
* For chapters & pages, the parent item will be loaded within this "deletable" data.
|
|
* Requires permission to manage both system settings and permissions.
|
|
*/
|
|
public function list()
|
|
{
|
|
return $this->apiListingResponse(Deletion::query()->with('deletable'), [
|
|
'id',
|
|
'deleted_by',
|
|
'created_at',
|
|
'updated_at',
|
|
'deletable_type',
|
|
'deletable_id',
|
|
], [Closure::fromCallable([$this, 'listFormatter'])]);
|
|
}
|
|
|
|
/**
|
|
* Restore a single deletion from the recycle bin.
|
|
* Requires permission to manage both system settings and permissions.
|
|
*/
|
|
public function restore(DeletionRepo $deletionRepo, string $deletionId)
|
|
{
|
|
$restoreCount = $deletionRepo->restore(intval($deletionId));
|
|
|
|
return response()->json(['restore_count' => $restoreCount]);
|
|
}
|
|
|
|
/**
|
|
* Remove a single deletion from the recycle bin.
|
|
* Use this endpoint carefully as it will entirely remove the underlying deleted items from the system.
|
|
* Requires permission to manage both system settings and permissions.
|
|
*/
|
|
public function destroy(DeletionRepo $deletionRepo, string $deletionId)
|
|
{
|
|
$deleteCount = $deletionRepo->destroy(intval($deletionId));
|
|
|
|
return response()->json(['delete_count' => $deleteCount]);
|
|
}
|
|
|
|
/**
|
|
* Load some related details for the deletion listing.
|
|
*/
|
|
protected function listFormatter(Deletion $deletion)
|
|
{
|
|
$deletable = $deletion->deletable;
|
|
$withTrashedQuery = fn(Builder $query) => $query->withTrashed();
|
|
|
|
if ($deletable instanceof BookChild) {
|
|
$parent = $deletable->getParent();
|
|
$parent->setAttribute('type', $parent->getType());
|
|
$deletable->setRelation('parent', $parent);
|
|
}
|
|
|
|
if ($deletable instanceof Book || $deletable instanceof Chapter) {
|
|
$countsToLoad = ['pages' => $withTrashedQuery];
|
|
if ($deletable instanceof Book) {
|
|
$countsToLoad['chapters'] = $withTrashedQuery;
|
|
}
|
|
$deletable->loadCount($countsToLoad);
|
|
}
|
|
}
|
|
}
|