NOW MANAGED ON CODEBERG
API: Initial review pass of zip import/export endpoints
Dan Brownd15eb129b0a3
diff --git a/app/Exports/Controllers/BookExportApiController.php b/app/Exports/Controllers/BookExportApiController.phpindex 431afef14..e2d0addc3 100644--- a/app/Exports/Controllers/BookExportApiController.php+++ b/app/Exports/Controllers/BookExportApiController.php@@ -65,18 +65,14 @@ class BookExportApiController extends ApiControllerreturn $this->download()->directly($markdown, $book->slug . '.md');}-/*** Export a book to a contained ZIP export file.- * @throws NotFoundException*/public function exportZip(int $id, ZipExportBuilder $builder){$book = $this->queries->findVisibleByIdOrFail($id);- $bookName= $book->getShortName();-$zip = $builder->buildForBook($book);- return $this->download()->streamedFileDirectly($zip, $bookName . '.zip', filesize($zip), true);+ return $this->download()->streamedFileDirectly($zip, $book->slug . '.zip', true);}-}\ No newline at end of file+}diff --git a/app/Exports/Controllers/ChapterExportApiController.php b/app/Exports/Controllers/ChapterExportApiController.phpindex 58df4c9b0..66e2276b5 100644--- a/app/Exports/Controllers/ChapterExportApiController.php+++ b/app/Exports/Controllers/ChapterExportApiController.php@@ -68,9 +68,8 @@ class ChapterExportApiController extends ApiControllerpublic function exportZip(int $id, ZipExportBuilder $builder){$chapter = $this->queries->findVisibleByIdOrFail($id);- $chapterName= $chapter->getShortName();$zip = $builder->buildForChapter($chapter);- return $this->download()->streamedFileDirectly($zip, $chapterName . '.zip', filesize($zip), true);+ return $this->download()->streamedFileDirectly($zip, $chapter->slug . '.zip', true);}-}\ No newline at end of file+}diff --git a/app/Exports/Controllers/ImportApiController.php b/app/Exports/Controllers/ImportApiController.phpindex 682d340b3..13bc9d83e 100644--- a/app/Exports/Controllers/ImportApiController.php+++ b/app/Exports/Controllers/ImportApiController.php@@ -7,12 +7,13 @@ namespace BookStack\Exports\Controllers;use BookStack\Exceptions\ZipImportException;use BookStack\Exceptions\ZipValidationException;use BookStack\Exports\ImportRepo;-use BookStack\Http\Controller;+use BookStack\Http\ApiController;use BookStack\Uploads\AttachmentService;use Illuminate\Http\Request;use Illuminate\Http\JsonResponse;+use Illuminate\Http\Response;-class ImportApiController extends Controller+class ImportApiController extends ApiController{public function __construct(protected ImportRepo $imports,@@ -21,101 +22,94 @@ class ImportApiController extends Controller}/**- * List existing imports visible to the user.+ * List existing ZIP imports visible to the user.*/public function list(): JsonResponse{- $imports = $this->imports->getVisibleImports();+ $imports = $this->imports->getVisibleImports()->all();- return response()->json([- 'status' => 'success',- 'imports' => $imports,- ]);+ return response()->json($imports);}/**- * Upload, validate and store an import file.+ * Upload, validate and store a ZIP import file.+ * This does not run the import. That is performed via a separate endpoint.*/public function upload(Request $request): JsonResponse{- $this->validate($request, [- 'file' => ['required', ...AttachmentService::getFileValidationRules()]- ]);+ $this->validate($request, $this->rules()['upload']);$file = $request->file('file');try {$import = $this->imports->storeFromUpload($file);} catch (ZipValidationException $exception) {- return response()->json([- 'status' => 'error',- 'message' => 'Validation failed',- 'errors' => $exception->errors,- ], 422);+ $message = "ZIP upload failed with the following validation errors: \n" . implode("\n", $exception->errors);+ return $this->jsonError($message, 422);}- return response()->json([- 'status' => 'success',- 'import' => $import,- ], 201);+ return response()->json($import);}/**- * Show details of a pending import.+ * Read details of a pending ZIP import.*/public function read(int $id): JsonResponse{$import = $this->imports->findVisible($id);- return response()->json([- 'status' => 'success',- 'import' => $import,- 'data' => $import->decodeMetadata(),- ]);+ return response()->json($import);}/**- * Run the import process.+ * Run the import process for an uploaded ZIP import.+ * The parent_id and parent_type parameters are required when the import type is 'chapter' or 'page'.+ * On success, returns the imported item.*/- public function create(int $id, Request $request): JsonResponse+ public function run(int $id, Request $request): JsonResponse{$import = $this->imports->findVisible($id);$parent = null;+ $rules = $this->rules()['run'];if ($import->type === 'page' || $import->type === 'chapter') {- $data = $this->validate($request, [- 'parent' => ['required', 'string'],- ]);- $parent = $data['parent'];+ $rules['parent_type'][] = 'required';+ $rules['parent_id'][] = 'required';+ $data = $this->validate($request, $rules);+ $parent = "{$data['parent_type']}:{$data['parent_id']}";}try {$entity = $this->imports->runImport($import, $parent);} catch (ZipImportException $exception) {- return response()->json([- 'status' => 'error',- 'message' => 'Import failed',- 'errors' => $exception->errors,- ], 500);+ $message = "ZIP import failed with the following errors: \n" . implode("\n", $exception->errors);+ return $this->jsonError($message);}- return response()->json([- 'status' => 'success',- 'entity' => $entity,- ]);+ return response()->json($entity);}/**- * Delete a pending import.+ * Delete a pending ZIP import.*/- public function delete(int $id): JsonResponse+ public function delete(int $id): Response{$import = $this->imports->findVisible($id);$this->imports->deleteImport($import);- return response()->json([- 'status' => 'success',- 'message' => 'Import deleted successfully',- ]);+ return response('', 204);}-}\ No newline at end of file++ protected function rules(): array+ {+ return [+ 'upload' => [+ 'file' => ['required', ...AttachmentService::getFileValidationRules()],+ ],+ 'run' => [+ 'parent_type' => ['string', 'in:book,chapter'],+ 'parent_id' => ['int'],+ ],+ ];+ }+}diff --git a/app/Exports/Controllers/PageExportApiController.php b/app/Exports/Controllers/PageExportApiController.phpindex ef564da3e..d6412614c 100644--- a/app/Exports/Controllers/PageExportApiController.php+++ b/app/Exports/Controllers/PageExportApiController.php@@ -65,14 +65,11 @@ class PageExportApiController extends ApiControllerreturn $this->download()->directly($markdown, $page->slug . '.md');}--public function exportZip(int $id, ZipExportBuilder $builder){$page = $this->queries->findVisibleByIdOrFail($id);- $pageSlug = $page->slug;$zip = $builder->buildForPage($page);- return $this->download()->streamedFileDirectly($zip, $pageSlug . '.zip', filesize($zip), true);+ return $this->download()->streamedFileDirectly($zip, $page->slug . '.zip', true);}-}\ No newline at end of file+}diff --git a/routes/api.php b/routes/api.phpindex 5bdf53611..efb7b258c 100644--- a/routes/api.php+++ b/routes/api.php@@ -88,6 +88,12 @@ Route::get('roles/{id}', [RoleApiController::class, 'read']);Route::put('roles/{id}', [RoleApiController::class, 'update']);Route::delete('roles/{id}', [RoleApiController::class, 'delete']);+Route::get('import', [ExportControllers\ImportApiController::class, 'list']);+Route::post('import', [ExportControllers\ImportApiController::class, 'upload']);+Route::get('import/{id}', [ExportControllers\ImportApiController::class, 'read']);+Route::post('import/{id}', [ExportControllers\ImportApiController::class, 'run']);+Route::delete('import/{id}', [ExportControllers\ImportApiController::class, 'delete']);+Route::get('recycle-bin', [EntityControllers\RecycleBinApiController::class, 'list']);Route::put('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'restore']);Route::delete('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'destroy']);@@ -98,9 +104,3 @@ Route::put('content-permissions/{contentType}/{contentId}', [ContentPermissionApRoute::get('audit-log', [AuditLogApiController::class, 'list']);Route::get('system', [SystemApiController::class, 'read']);--Route::get('import', [ExportControllers\ImportApiController::class, 'list']);-Route::post('import', [ExportControllers\ImportApiController::class, 'upload']);-Route::get('import/{id}', [ExportControllers\ImportApiController::class, 'read']);-Route::post('import/{id}/create', [ExportControllers\ImportApiController::class, 'create']);-Route::delete('import/{id}', [ExportControllers\ImportApiController::class, 'destroy']);\ No newline at end of file