X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/8213ea9a7182df48ac9c12bb7b74098b5ad665a4..refs/pull/2513/head:/app/Uploads/ImageService.php diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php index 89744386d..92c3994a7 100644 --- a/app/Uploads/ImageService.php +++ b/app/Uploads/ImageService.php @@ -1,50 +1,41 @@ image = $image; $this->imageTool = $imageTool; + $this->fileSystem = $fileSystem; $this->cache = $cache; - $this->http = $http; - parent::__construct($fileSystem); } /** * Get the storage that will be used for storing images. - * @param string $type - * @return \Illuminate\Contracts\Filesystem\Filesystem */ - protected function getStorage($type = '') + protected function getStorage(string $type = ''): FileSystemInstance { $storageType = config('filesystems.images'); @@ -58,12 +49,6 @@ class ImageService extends UploadService /** * Saves a new image from an upload. - * @param UploadedFile $uploadedFile - * @param string $type - * @param int $uploadedTo - * @param int|null $resizeWidth - * @param int|null $resizeHeight - * @param bool $keepRatio * @return mixed * @throws ImageUploadException */ @@ -87,14 +72,9 @@ class ImageService extends UploadService /** * Save a new image from a uri-encoded base64 string of data. - * @param string $base64Uri - * @param string $name - * @param string $type - * @param int $uploadedTo - * @return Image * @throws ImageUploadException */ - public function saveNewFromBase64Uri(string $base64Uri, string $name, string $type, $uploadedTo = 0) + public function saveNewFromBase64Uri(string $base64Uri, string $name, string $type, int $uploadedTo = 0): Image { $splitData = explode(';base64,', $base64Uri); if (count($splitData) < 2) { @@ -104,30 +84,11 @@ class ImageService extends UploadService return $this->saveNew($name, $data, $type, $uploadedTo); } - /** - * Gets an image from url and saves it to the database. - * @param $url - * @param string $type - * @param bool|string $imageName - * @return mixed - * @throws \Exception - */ - private function saveNewFromUrl($url, $type, $imageName = false) - { - $imageName = $imageName ? $imageName : basename($url); - 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); - } - /** * Save a new image into storage. * @throws ImageUploadException */ - private function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image + public function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image { $storage = $this->getStorage($type); $secureUploads = setting('app-secure-images'); @@ -152,10 +113,10 @@ class ImageService extends UploadService } $imageDetails = [ - 'name' => $imageName, - 'path' => $fullPath, - 'url' => $this->getPublicUrl($fullPath), - 'type' => $type, + 'name' => $imageName, + 'path' => $fullPath, + 'url' => $this->getPublicUrl($fullPath), + 'type' => $type, 'uploaded_to' => $uploadedTo ]; @@ -185,15 +146,13 @@ class ImageService extends UploadService $name = Str::random(10); } - return $name . '.' . $extension; + return $name . '.' . $extension; } /** * Checks if the image is a gif. Returns true if it is, else false. - * @param Image $image - * @return boolean */ - protected function isGif(Image $image) + protected function isGif(Image $image): bool { return strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'gif'; } @@ -253,7 +212,7 @@ class ImageService extends UploadService try { $thumb = $this->imageTool->make($imageData); } catch (Exception $e) { - if ($e instanceof \ErrorException || $e instanceof NotSupportedException) { + if ($e instanceof ErrorException || $e instanceof NotSupportedException) { throw new ImageUploadException(trans('errors.cannot_create_thumbs')); } throw $e; @@ -281,11 +240,9 @@ class ImageService extends UploadService /** * Get the raw data content from an image. - * @param Image $image - * @return string - * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException + * @throws FileNotFoundException */ - public function getImageData(Image $image) + public function getImageData(Image $image): string { $imagePath = $image->path; $storage = $this->getStorage(); @@ -294,7 +251,6 @@ class ImageService extends UploadService /** * Destroy an image along with its revisions, thumbnails and remaining folders. - * @param Image $image * @throws Exception */ public function destroy(Image $image) @@ -324,7 +280,7 @@ class ImageService extends UploadService // Cleanup of empty folders $foldersInvolved = array_merge([$imageFolder], $storage->directories($imageFolder)); foreach ($foldersInvolved as $directory) { - if ($this->isFolderEmpty($directory)) { + if ($this->isFolderEmpty($storage, $directory)) { $storage->deleteDirectory($directory); } } @@ -333,57 +289,13 @@ class ImageService extends UploadService } /** - * Save an avatar image from an external service. - * @param \BookStack\Auth\User $user - * @param int $size - * @return Image - * @throws Exception - */ - public function saveUserAvatar(User $user, $size = 500) - { - $avatarUrl = $this->getAvatarUrl(); - $email = strtolower(trim($user->email)); - - $replacements = [ - '${hash}' => md5($email), - '${size}' => $size, - '${email}' => urlencode($email), - ]; - - $userAvatarUrl = strtr($avatarUrl, $replacements); - $imageName = str_replace(' ', '-', $user->name . '-avatar.png'); - $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; - } - - /** - * Check if fetching external avatars is enabled. - * @return bool - */ - public function avatarFetchEnabled() - { - $fetchUrl = $this->getAvatarUrl(); - return is_string($fetchUrl) && strpos($fetchUrl, 'http') === 0; - } - - /** - * Get the URL to fetch avatars from. - * @return string|mixed + * Check whether or not a folder is empty. */ - protected function getAvatarUrl() + protected function isFolderEmpty(FileSystemInstance $storage, string $path): bool { - $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; + $files = $storage->files($path); + $folders = $storage->directories($path); + return (count($files) === 0 && count($folders) === 0); } /** @@ -392,26 +304,23 @@ class ImageService extends UploadService * Could be much improved to be more specific but kept it generic for now to be safe. * * Returns the path of the images that would be/have been deleted. - * @param bool $checkRevisions - * @param bool $dryRun - * @param array $types - * @return array */ - public function deleteUnusedImages($checkRevisions = true, $dryRun = true, $types = ['gallery', 'drawio']) + public function deleteUnusedImages(bool $checkRevisions = true, bool $dryRun = true) { - $types = array_intersect($types, ['gallery', 'drawio']); + $types = ['gallery', 'drawio']; $deletedPaths = []; $this->image->newQuery()->whereIn('type', $types) - ->chunk(1000, function ($images) use ($types, $checkRevisions, &$deletedPaths, $dryRun) { + ->chunk(1000, function ($images) use ($checkRevisions, &$deletedPaths, $dryRun) { foreach ($images as $image) { $searchQuery = '%' . basename($image->path) . '%'; $inPage = DB::table('pages') - ->where('html', 'like', $searchQuery)->count() > 0; + ->where('html', 'like', $searchQuery)->count() > 0; + $inRevision = false; if ($checkRevisions) { - $inRevision = DB::table('page_revisions') - ->where('html', 'like', $searchQuery)->count() > 0; + $inRevision = DB::table('page_revisions') + ->where('html', 'like', $searchQuery)->count() > 0; } if (!$inPage && !$inRevision) { @@ -427,38 +336,25 @@ class ImageService extends UploadService /** * Convert a image URI to a Base64 encoded string. - * Attempts to find locally via set storage method first. - * @param string $uri - * @return null|string - * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException + * Attempts to convert the URL to a system storage url then + * fetch the data from the disk or storage location. + * Returns null if the image data cannot be fetched from storage. + * @throws FileNotFoundException */ - public function imageUriToBase64(string $uri) + public function imageUriToBase64(string $uri): ?string { - $isLocal = strpos(trim($uri), 'http') !== 0; - - // Attempt to find local files even if url not absolute - $base = url('/'); - if (!$isLocal && strpos($uri, $base) === 0) { - $isLocal = true; - $uri = str_replace($base, '', $uri); + $storagePath = $this->imageUrlToStoragePath($uri); + if (empty($uri) || is_null($storagePath)) { + return null; } + $storage = $this->getStorage(); $imageData = null; - - if ($isLocal) { - $uri = trim($uri, '/'); - $storage = $this->getStorage(); - if ($storage->exists($uri)) { - $imageData = $storage->get($uri); - } - } else { - try { - $imageData = $this->http->fetch($uri); - } catch (\Exception $e) { - } + if ($storage->exists($storagePath)) { + $imageData = $storage->get($storagePath); } - if ($imageData === null) { + if (is_null($imageData)) { return null; } @@ -470,12 +366,45 @@ class ImageService extends UploadService return 'data:image/' . $extension . ';base64,' . base64_encode($imageData); } + /** + * Get a storage path for the given image URL. + * Ensures the path will start with "uploads/images". + * Returns null if the url cannot be resolved to a local URL. + */ + private function imageUrlToStoragePath(string $url): ?string + { + $url = ltrim(trim($url), '/'); + + // Handle potential relative paths + $isRelative = strpos($url, 'http') !== 0; + if ($isRelative) { + if (strpos(strtolower($url), 'uploads/images') === 0) { + return trim($url, '/'); + } + return null; + } + + // Handle local images based on paths on the same domain + $potentialHostPaths = [ + url('uploads/images/'), + $this->getPublicUrl('/uploads/images/'), + ]; + + foreach ($potentialHostPaths as $potentialBasePath) { + $potentialBasePath = strtolower($potentialBasePath); + if (strpos(strtolower($url), $potentialBasePath) === 0) { + return 'uploads/images/' . trim(substr($url, strlen($potentialBasePath)), '/'); + } + } + + return null; + } + /** * Gets a public facing url for an image by checking relevant environment variables. - * @param string $filePath - * @return string + * If s3-style store is in use it will default to guessing a public bucket URL. */ - private function getPublicUrl($filePath) + private function getPublicUrl(string $filePath): string { if ($this->storageUrl === null) { $storageUrl = config('filesystems.url');