X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/866187830afa103a8e31d9b59c573c75dfc14033..refs/pull/2393/head:/app/Uploads/ImageService.php diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php index d5f4068ef..89744386d 100644 --- a/app/Uploads/ImageService.php +++ b/app/Uploads/ImageService.php @@ -1,13 +1,16 @@ image = $image; $this->imageTool = $imageTool; $this->cache = $cache; + $this->http = $http; parent::__construct($fileSystem); } @@ -40,9 +46,9 @@ class ImageService extends UploadService */ protected function getStorage($type = '') { - $storageType = config('filesystems.default'); + $storageType = config('filesystems.images'); - // Override default location if set to local public to ensure not visible. + // Ensure system images (App logo) are uploaded to a public space if ($type === 'system' && $storageType === 'local_secure') { $storageType = 'local'; } @@ -53,15 +59,29 @@ class ImageService extends UploadService /** * Saves a new image from an upload. * @param UploadedFile $uploadedFile - * @param string $type + * @param string $type * @param int $uploadedTo + * @param int|null $resizeWidth + * @param int|null $resizeHeight + * @param bool $keepRatio * @return mixed * @throws ImageUploadException */ - public function saveNewFromUpload(UploadedFile $uploadedFile, $type, $uploadedTo = 0) - { + public function saveNewFromUpload( + UploadedFile $uploadedFile, + string $type, + int $uploadedTo = 0, + int $resizeWidth = null, + int $resizeHeight = null, + bool $keepRatio = true + ) { $imageName = $uploadedFile->getClientOriginalName(); $imageData = file_get_contents($uploadedFile->getRealPath()); + + if ($resizeWidth !== null || $resizeHeight !== null) { + $imageData = $this->resizeImage($imageData, $resizeWidth, $resizeHeight, $keepRatio); + } + return $this->saveNew($imageName, $imageData, $type, $uploadedTo); } @@ -95,37 +115,33 @@ class ImageService extends UploadService private function saveNewFromUrl($url, $type, $imageName = false) { $imageName = $imageName ? $imageName : basename($url); - $imageData = file_get_contents($url); - if ($imageData === false) { + try { + $imageData = $this->http->fetch($url); + } catch (HttpFetchException $exception) { throw new \Exception(trans('errors.cannot_get_image_from_url', ['url' => $url])); } return $this->saveNew($imageName, $imageData, $type); } /** - * Saves a new image - * @param string $imageName - * @param string $imageData - * @param string $type - * @param int $uploadedTo - * @return Image + * Save a new image into storage. * @throws ImageUploadException */ - private function saveNew($imageName, $imageData, $type, $uploadedTo = 0) + private function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image { $storage = $this->getStorage($type); $secureUploads = setting('app-secure-images'); - $imageName = str_replace(' ', '-', $imageName); + $fileName = $this->cleanImageFileName($imageName); - $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/'; + $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m') . '/'; - while ($storage->exists($imagePath . $imageName)) { - $imageName = str_random(3) . $imageName; + while ($storage->exists($imagePath . $fileName)) { + $fileName = Str::random(3) . $fileName; } - $fullPath = $imagePath . $imageName; + $fullPath = $imagePath . $fileName; if ($secureUploads) { - $fullPath = $imagePath . str_random(16) . '-' . $imageName; + $fullPath = $imagePath . Str::random(16) . '-' . $fileName; } try { @@ -154,6 +170,23 @@ class ImageService extends UploadService return $image; } + /** + * Clean up an image file name to be both URL and storage safe. + */ + protected function cleanImageFileName(string $name): string + { + $name = str_replace(' ', '-', $name); + $nameParts = explode('.', $name); + $extension = array_pop($nameParts); + $name = implode('.', $nameParts); + $name = Str::slug($name); + + if (strlen($name) === 0) { + $name = Str::random(10); + } + + return $name . '.' . $extension; + } /** * Checks if the image is a gif. Returns true if it is, else false. @@ -196,8 +229,29 @@ class ImageService extends UploadService return $this->getPublicUrl($thumbFilePath); } + $thumbData = $this->resizeImage($storage->get($imagePath), $width, $height, $keepRatio); + + $storage->put($thumbFilePath, $thumbData); + $storage->setVisibility($thumbFilePath, 'public'); + $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 60 * 72); + + + return $this->getPublicUrl($thumbFilePath); + } + + /** + * Resize image data. + * @param string $imageData + * @param int $width + * @param int $height + * @param bool $keepRatio + * @return string + * @throws ImageUploadException + */ + protected function resizeImage(string $imageData, $width = 220, $height = null, bool $keepRatio = true) + { try { - $thumb = $this->imageTool->make($storage->get($imagePath)); + $thumb = $this->imageTool->make($imageData); } catch (Exception $e) { if ($e instanceof \ErrorException || $e instanceof NotSupportedException) { throw new ImageUploadException(trans('errors.cannot_create_thumbs')); @@ -206,7 +260,7 @@ class ImageService extends UploadService } if ($keepRatio) { - $thumb->resize($width, null, function ($constraint) { + $thumb->resize($width, $height, function ($constraint) { $constraint->aspectRatio(); $constraint->upsize(); }); @@ -215,11 +269,14 @@ class ImageService extends UploadService } $thumbData = (string)$thumb->encode(); - $storage->put($thumbFilePath, $thumbData); - $storage->setVisibility($thumbFilePath, 'public'); - $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 72); - return $this->getPublicUrl($thumbFilePath); + // Use original image data if we're keeping the ratio + // and the resizing does not save any space. + if ($keepRatio && strlen($thumbData) > strlen($imageData)) { + return $imageData; + } + + return $thumbData; } /** @@ -248,11 +305,9 @@ class ImageService extends UploadService /** * Destroys an image at the given path. - * Searches for image thumbnails in addition to main provided path.. - * @param string $path - * @return bool + * Searches for image thumbnails in addition to main provided path. */ - protected function destroyImagesFromPath(string $path) + protected function destroyImagesFromPath(string $path): bool { $storage = $this->getStorage(); @@ -262,8 +317,7 @@ class ImageService extends UploadService // Delete image files $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) { - $expectedIndex = strlen($imagePath) - strlen($imageFileName); - return strpos($imagePath, $imageFileName) === $expectedIndex; + return basename($imagePath) === $imageFileName; }); $storage->delete($imagesToDelete->all()); @@ -301,6 +355,7 @@ class ImageService extends UploadService $image = $this->saveNewFromUrl($userAvatarUrl, 'user', $imageName); $image->created_by = $user->id; $image->updated_by = $user->id; + $image->uploaded_to = $user->id; $image->save(); return $image; @@ -322,7 +377,13 @@ class ImageService extends UploadService */ protected function getAvatarUrl() { - return trim(config('services.avatar_url')); + $url = trim(config('services.avatar_url')); + + if (empty($url) && !config('services.disable_services')) { + $url = 'https://www.gravatar.com/avatar/${hash}?s=${size}&d=identicon'; + } + + return $url; } /** @@ -376,7 +437,7 @@ class ImageService extends UploadService $isLocal = strpos(trim($uri), 'http') !== 0; // Attempt to find local files even if url not absolute - $base = baseUrl('/'); + $base = url('/'); if (!$isLocal && strpos($uri, $base) === 0) { $isLocal = true; $uri = str_replace($base, '', $uri); @@ -392,14 +453,7 @@ class ImageService extends UploadService } } else { try { - $ch = curl_init(); - curl_setopt_array($ch, [CURLOPT_URL => $uri, CURLOPT_RETURNTRANSFER => 1, CURLOPT_CONNECTTIMEOUT => 5]); - $imageData = curl_exec($ch); - $err = curl_error($ch); - curl_close($ch); - if ($err) { - throw new \Exception("Image fetch failed, Received error: " . $err); - } + $imageData = $this->http->fetch($uri); } catch (\Exception $e) { } } @@ -408,7 +462,12 @@ class ImageService extends UploadService return null; } - return 'data:image/' . pathinfo($uri, PATHINFO_EXTENSION) . ';base64,' . base64_encode($imageData); + $extension = pathinfo($uri, PATHINFO_EXTENSION); + if ($extension === 'svg') { + $extension = 'svg+xml'; + } + + return 'data:image/' . $extension . ';base64,' . base64_encode($imageData); } /** @@ -424,7 +483,7 @@ class ImageService extends UploadService // Get the standard public s3 url if s3 is set as storage type // Uses the nice, short URL if bucket name has no periods in otherwise the longer // region-based url will be used to prevent http issues. - if ($storageUrl == false && config('filesystems.default') === 's3') { + if ($storageUrl == false && config('filesystems.images') === 's3') { $storageDetails = config('filesystems.disks.s3'); if (strpos($storageDetails['bucket'], '.') === false) { $storageUrl = 'https://' . $storageDetails['bucket'] . '.s3.amazonaws.com'; @@ -435,7 +494,7 @@ class ImageService extends UploadService $this->storageUrl = $storageUrl; } - $basePath = ($this->storageUrl == false) ? baseUrl('/') : $this->storageUrl; + $basePath = ($this->storageUrl == false) ? url('/') : $this->storageUrl; return rtrim($basePath, '/') . $filePath; } }