X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/7224fbcc89f00f2b71644e36bb1b1d96addd1d5a..refs/pull/5349/head:/app/Uploads/AttachmentService.php diff --git a/app/Uploads/AttachmentService.php b/app/Uploads/AttachmentService.php index c957e8bea..033f23341 100644 --- a/app/Uploads/AttachmentService.php +++ b/app/Uploads/AttachmentService.php @@ -4,91 +4,50 @@ namespace BookStack\Uploads; use BookStack\Exceptions\FileUploadException; use Exception; -use Illuminate\Contracts\Filesystem\Factory as FileSystem; -use Illuminate\Contracts\Filesystem\FileNotFoundException; -use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance; -use Illuminate\Support\Facades\Log; -use Illuminate\Support\Str; -use League\Flysystem\Util; use Symfony\Component\HttpFoundation\File\UploadedFile; class AttachmentService { - protected $fileSystem; - - /** - * AttachmentService constructor. - */ - public function __construct(FileSystem $fileSystem) - { - $this->fileSystem = $fileSystem; - } - - /** - * Get the storage that will be used for storing files. - */ - protected function getStorage(): FileSystemInstance - { - return $this->fileSystem->disk($this->getStorageDiskName()); - } - - /** - * Get the name of the storage disk to use. - */ - protected function getStorageDiskName(): string - { - $storageType = config('filesystems.attachments'); - - // Change to our secure-attachment disk if any of the local options - // are used to prevent escaping that location. - if ($storageType === 'local' || $storageType === 'local_secure') { - $storageType = 'local_secure_attachments'; - } - - return $storageType; + public function __construct( + protected FileStorage $storage, + ) { } /** - * Change the originally provided path to fit any disk-specific requirements. - * This also ensures the path is kept to the expected root folders. + * Stream an attachment from storage. + * + * @return resource|null */ - protected function adjustPathForStorageDisk(string $path): string + public function streamAttachmentFromStorage(Attachment $attachment) { - $path = Util::normalizePath(str_replace('uploads/files/', '', $path)); - - if ($this->getStorageDiskName() === 'local_secure_attachments') { - return $path; - } - - return 'uploads/files/' . $path; + return $this->storage->getReadStream($attachment->path); } /** - * Get an attachment from storage. - * - * @throws FileNotFoundException + * Read the file size of an attachment from storage, in bytes. */ - public function getAttachmentFromStorage(Attachment $attachment): string + public function getAttachmentFileSize(Attachment $attachment): int { - return $this->getStorage()->get($this->adjustPathForStorageDisk($attachment->path)); + return $this->storage->getSize($attachment->path); } /** * Store a new attachment upon user upload. + * * @throws FileUploadException */ - public function saveNewUpload(UploadedFile $uploadedFile, int $page_id): Attachment + public function saveNewUpload(UploadedFile $uploadedFile, int $pageId): Attachment { $attachmentName = $uploadedFile->getClientOriginalName(); $attachmentPath = $this->putFileInStorage($uploadedFile); - $largestExistingOrder = Attachment::query()->where('uploaded_to', '=', $page_id)->max('order'); + $largestExistingOrder = Attachment::query()->where('uploaded_to', '=', $pageId)->max('order'); /** @var Attachment $attachment */ $attachment = Attachment::query()->forceCreate([ 'name' => $attachmentName, 'path' => $attachmentPath, 'extension' => $uploadedFile->getClientOriginalExtension(), - 'uploaded_to' => $page_id, + 'uploaded_to' => $pageId, 'created_by' => user()->id, 'updated_by' => user()->id, 'order' => $largestExistingOrder + 1, @@ -158,33 +117,33 @@ class AttachmentService public function updateFile(Attachment $attachment, array $requestData): Attachment { $attachment->name = $requestData['name']; + $link = trim($requestData['link'] ?? ''); - if (isset($requestData['link']) && trim($requestData['link']) !== '') { - $attachment->path = $requestData['link']; + if (!empty($link)) { if (!$attachment->external) { $this->deleteFileInStorage($attachment); $attachment->external = true; + $attachment->extension = ''; } + $attachment->path = $requestData['link']; } $attachment->save(); - return $attachment; + return $attachment->refresh(); } /** * Delete a File from the database and storage. + * * @throws Exception */ public function deleteFile(Attachment $attachment) { - if ($attachment->external) { - $attachment->delete(); - - return; + if (!$attachment->external) { + $this->deleteFileInStorage($attachment); } - $this->deleteFileInStorage($attachment); $attachment->delete(); } @@ -192,43 +151,33 @@ class AttachmentService * Delete a file from the filesystem it sits on. * Cleans any empty leftover folders. */ - protected function deleteFileInStorage(Attachment $attachment) + public function deleteFileInStorage(Attachment $attachment): void { - $storage = $this->getStorage(); - $dirPath = $this->adjustPathForStorageDisk(dirname($attachment->path)); - - $storage->delete($this->adjustPathForStorageDisk($attachment->path)); - if (count($storage->allFiles($dirPath)) === 0) { - $storage->deleteDirectory($dirPath); - } + $this->storage->delete($attachment->path); } /** * Store a file in storage with the given filename. + * * @throws FileUploadException */ protected function putFileInStorage(UploadedFile $uploadedFile): string { - $attachmentData = file_get_contents($uploadedFile->getRealPath()); - - $storage = $this->getStorage(); $basePath = 'uploads/files/' . date('Y-m-M') . '/'; - $uploadFileName = Str::random(16) . '.' . $uploadedFile->getClientOriginalExtension(); - while ($storage->exists($this->adjustPathForStorageDisk($basePath . $uploadFileName))) { - $uploadFileName = Str::random(3) . $uploadFileName; - } - - $attachmentPath = $basePath . $uploadFileName; - - try { - $storage->put($this->adjustPathForStorageDisk($attachmentPath), $attachmentData); - } catch (Exception $e) { - Log::error('Error when attempting file upload:' . $e->getMessage()); - - throw new FileUploadException(trans('errors.path_not_writable', ['filePath' => $attachmentPath])); - } + return $this->storage->uploadFile( + $uploadedFile, + $basePath, + $uploadedFile->getClientOriginalExtension(), + '' + ); + } - return $attachmentPath; + /** + * Get the file validation rules for attachments. + */ + public static function getFileValidationRules(): array + { + return ['file', 'max:' . (config('app.upload_limit') * 1000)]; } }