-<?php namespace BookStack\Uploads;
+<?php
+
+namespace BookStack\Uploads;
use BookStack\Exceptions\FileUploadException;
use Exception;
use Symfony\Component\HttpFoundation\File\UploadedFile;
-class AttachmentService extends UploadService
+class AttachmentService
{
+ public function __construct(
+ protected FileStorage $storage,
+ ) {
+ }
/**
- * Get the storage that will be used for storing files.
- * @return \Illuminate\Contracts\Filesystem\Filesystem
+ * Stream an attachment from storage.
+ *
+ * @return resource|null
*/
- protected function getStorage()
+ public function streamAttachmentFromStorage(Attachment $attachment)
{
- $storageType = config('filesystems.attachments');
-
- // Override default location if set to local public to ensure not visible.
- if ($storageType === 'local') {
- $storageType = 'local_secure';
- }
-
- return $this->fileSystem->disk($storageType);
+ return $this->storage->getReadStream($attachment->path);
}
/**
- * Get an attachment from storage.
- * @param Attachment $attachment
- * @return string
- * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+ * Read the file size of an attachment from storage, in bytes.
*/
- public function getAttachmentFromStorage(Attachment $attachment)
+ public function getAttachmentFileSize(Attachment $attachment): int
{
- return $this->getStorage()->get($attachment->path);
+ return $this->storage->getSize($attachment->path);
}
/**
* Store a new attachment upon user upload.
- * @param UploadedFile $uploadedFile
- * @param int $page_id
- * @return Attachment
+ *
* @throws FileUploadException
*/
- public function saveNewUpload(UploadedFile $uploadedFile, $page_id)
+ public function saveNewUpload(UploadedFile $uploadedFile, int $pageId): Attachment
{
$attachmentName = $uploadedFile->getClientOriginalName();
$attachmentPath = $this->putFileInStorage($uploadedFile);
- $largestExistingOrder = Attachment::where('uploaded_to', '=', $page_id)->max('order');
-
- $attachment = Attachment::forceCreate([
- 'name' => $attachmentName,
- 'path' => $attachmentPath,
- 'extension' => $uploadedFile->getClientOriginalExtension(),
- 'uploaded_to' => $page_id,
- 'created_by' => user()->id,
- 'updated_by' => user()->id,
- 'order' => $largestExistingOrder + 1
+ $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' => $pageId,
+ 'created_by' => user()->id,
+ 'updated_by' => user()->id,
+ 'order' => $largestExistingOrder + 1,
]);
return $attachment;
}
/**
- * Store a upload, saving to a file and deleting any existing uploads
+ * Store an upload, saving to a file and deleting any existing uploads
* attached to that file.
- * @param UploadedFile $uploadedFile
- * @param Attachment $attachment
- * @return Attachment
+ *
* @throws FileUploadException
*/
- public function saveUpdatedUpload(UploadedFile $uploadedFile, Attachment $attachment)
+ public function saveUpdatedUpload(UploadedFile $uploadedFile, Attachment $attachment): Attachment
{
if (!$attachment->external) {
$this->deleteFileInStorage($attachment);
$attachment->external = false;
$attachment->extension = $uploadedFile->getClientOriginalExtension();
$attachment->save();
+
return $attachment;
}
/**
* Save a new File attachment from a given link and name.
- * @param string $name
- * @param string $link
- * @param int $page_id
- * @return Attachment
*/
- public function saveNewFromLink($name, $link, $page_id)
+ public function saveNewFromLink(string $name, string $link, int $page_id): Attachment
{
$largestExistingOrder = Attachment::where('uploaded_to', '=', $page_id)->max('order');
+
return Attachment::forceCreate([
- 'name' => $name,
- 'path' => $link,
- 'external' => true,
- 'extension' => '',
+ 'name' => $name,
+ 'path' => $link,
+ 'external' => true,
+ 'extension' => '',
'uploaded_to' => $page_id,
- 'created_by' => user()->id,
- 'updated_by' => user()->id,
- 'order' => $largestExistingOrder + 1
+ 'created_by' => user()->id,
+ 'updated_by' => user()->id,
+ 'order' => $largestExistingOrder + 1,
]);
}
/**
- * Updates the file ordering for a listing of attached files.
- * @param array $attachmentList
- * @param $pageId
+ * Updates the ordering for a listing of attached files.
*/
- public function updateFileOrderWithinPage($attachmentList, $pageId)
+ public function updateFileOrderWithinPage(array $attachmentOrder, string $pageId)
{
- foreach ($attachmentList as $index => $attachment) {
- Attachment::where('uploaded_to', '=', $pageId)->where('id', '=', $attachment['id'])->update(['order' => $index]);
+ foreach ($attachmentOrder as $index => $attachmentId) {
+ Attachment::query()->where('uploaded_to', '=', $pageId)
+ ->where('id', '=', $attachmentId)
+ ->update(['order' => $index]);
}
}
-
/**
* Update the details of a file.
- * @param Attachment $attachment
- * @param $requestData
- * @return Attachment
*/
- public function updateFile(Attachment $attachment, $requestData)
+ public function updateFile(Attachment $attachment, array $requestData): Attachment
{
- $attachment->name = $requestData['name'];
- if (isset($requestData['link']) && trim($requestData['link']) !== '') {
- $attachment->path = $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 = $link;
}
+
$attachment->save();
- return $attachment;
+
+ return $attachment->refresh();
}
/**
* Delete a File from the database and storage.
- * @param Attachment $attachment
+ *
* @throws Exception
*/
public function deleteFile(Attachment $attachment)
{
- if ($attachment->external) {
- $attachment->delete();
- return;
+ if (!$attachment->external) {
+ $this->deleteFileInStorage($attachment);
}
-
- $this->deleteFileInStorage($attachment);
+
$attachment->delete();
}
/**
* Delete a file from the filesystem it sits on.
* Cleans any empty leftover folders.
- * @param Attachment $attachment
*/
- protected function deleteFileInStorage(Attachment $attachment)
+ public function deleteFileInStorage(Attachment $attachment): void
{
- $storage = $this->getStorage();
- $dirPath = dirname($attachment->path);
-
- $storage->delete($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
- * @param UploadedFile $uploadedFile
- * @return string
+ * Store a file in storage with the given filename.
+ *
* @throws FileUploadException
*/
- protected function putFileInStorage(UploadedFile $uploadedFile)
+ 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($basePath . $uploadFileName)) {
- $uploadFileName = str_random(3) . $uploadFileName;
- }
-
- $attachmentPath = $basePath . $uploadFileName;
- try {
- $storage->put($attachmentPath, $attachmentData);
- } catch (Exception $e) {
- throw new FileUploadException(trans('errors.path_not_writable', ['filePath' => $attachmentPath]));
- }
+ $basePath = 'uploads/files/' . date('Y-m-M') . '/';
+
+ 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)];
}
}
projects / bookstack / blobdiff