use BookStack\Exceptions\FileUploadException;
use Exception;
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
-use Illuminate\Contracts\Filesystem\Filesystem as Storage;
-use Illuminate\Filesystem\FilesystemManager;
-use Illuminate\Support\Facades\Log;
-use Illuminate\Support\Str;
-use League\Flysystem\Util;
use Symfony\Component\HttpFoundation\File\UploadedFile;
class AttachmentService
{
- protected FilesystemManager $fileSystem;
-
- /**
- * AttachmentService constructor.
- */
- public function __construct(FilesystemManager $fileSystem)
- {
- $this->fileSystem = $fileSystem;
- }
-
- /**
- * Get the storage that will be used for storing files.
- */
- protected function getStorageDisk(): Storage
- {
- 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;
- }
-
- /**
- * Change the originally provided path to fit any disk-specific requirements.
- * This also ensures the path is kept to the expected root folders.
- */
- protected function adjustPathForStorageDisk(string $path): string
- {
- $path = Util::normalizePath(str_replace('uploads/files/', '', $path));
-
- if ($this->getStorageDiskName() === 'local_secure_attachments') {
- return $path;
- }
-
- return 'uploads/files/' . $path;
+ public function __construct(
+ protected FileStorage $storage,
+ ) {
}
/**
- * Get an attachment from storage.
+ * Stream an attachment from storage.
*
- * @throws FileNotFoundException
+ * @return resource|null
*/
- public function getAttachmentFromStorage(Attachment $attachment): string
+ public function streamAttachmentFromStorage(Attachment $attachment)
{
- return $this->getStorageDisk()->get($this->adjustPathForStorageDisk($attachment->path));
+ return $this->storage->getReadStream($attachment->path);
}
/**
- * Stream an attachment from storage.
- *
- * @throws FileNotFoundException
- *
- * @return resource|null
+ * Read the file size of an attachment from storage, in bytes.
*/
- public function streamAttachmentFromStorage(Attachment $attachment)
+ public function getAttachmentFileSize(Attachment $attachment): int
{
- return $this->getStorageDisk()->readStream($this->adjustPathForStorageDisk($attachment->path));
+ return $this->storage->getSize($attachment->path);
}
/**
*/
public function updateFile(Attachment $attachment, array $requestData): Attachment
{
- $attachment->name = $requestData['name'];
- $link = trim($requestData['link'] ?? '');
+ if (isset($requestData['name'])) {
+ $attachment->name = $requestData['name'];
+ }
+ $link = trim($requestData['link'] ?? '');
if (!empty($link)) {
if (!$attachment->external) {
$this->deleteFileInStorage($attachment);
$attachment->external = true;
$attachment->extension = '';
}
- $attachment->path = $requestData['link'];
+ $attachment->path = $link;
}
$attachment->save();
* 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->getStorageDisk();
- $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);
}
/**
*/
protected function putFileInStorage(UploadedFile $uploadedFile): string
{
- $storage = $this->getStorageDisk();
$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;
- }
-
- $attachmentStream = fopen($uploadedFile->getRealPath(), 'r');
- $attachmentPath = $basePath . $uploadFileName;
-
- try {
- $storage->writeStream($this->adjustPathForStorageDisk($attachmentPath), $attachmentStream);
- } catch (Exception $e) {
- Log::error('Error when attempting file upload:' . $e->getMessage());
-
- throw new FileUploadException(trans('errors.path_not_writable', ['filePath' => $attachmentPath]));
- }
-
- return $attachmentPath;
+ return $this->storage->uploadFile(
+ $uploadedFile,
+ $basePath,
+ $uploadedFile->getClientOriginalExtension(),
+ ''
+ );
}
/**
* Get the file validation rules for attachments.
*/
- public function getFileValidationRules(): array
+ public static function getFileValidationRules(): array
{
return ['file', 'max:' . (config('app.upload_limit') * 1000)];
}