X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/7d38c96a23f2d9127b4201f5ed80b5d75fefcefb..refs/pull/2700/head:/app/Uploads/ImageService.php diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php index 02afb2a76..010b531f1 100644 --- a/app/Uploads/ImageService.php +++ b/app/Uploads/ImageService.php @@ -1,7 +1,5 @@ image = $image; $this->imageTool = $imageTool; $this->fileSystem = $fileSystem; $this->cache = $cache; - $this->http = $http; } /** @@ -77,14 +72,9 @@ class ImageService /** * 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) { @@ -94,30 +84,11 @@ class ImageService 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'); @@ -138,6 +109,7 @@ class ImageService $storage->put($fullPath, $imageData); $storage->setVisibility($fullPath, 'public'); } catch (Exception $e) { + \Log::error('Error when attempting image upload:' . $e->getMessage()); throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath])); } @@ -168,7 +140,7 @@ class ImageService $name = str_replace(' ', '-', $name); $nameParts = explode('.', $name); $extension = array_pop($nameParts); - $name = implode('.', $nameParts); + $name = implode('-', $nameParts); $name = Str::slug($name); if (strlen($name) === 0) { @@ -327,78 +299,25 @@ class ImageService return (count($files) === 0 && count($folders) === 0); } - /** - * Save an avatar image from an external service. - * @throws Exception - */ - public function saveUserAvatar(User $user, int $size = 500): Image - { - $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. - */ - public function avatarFetchEnabled(): bool - { - $fetchUrl = $this->getAvatarUrl(); - return is_string($fetchUrl) && strpos($fetchUrl, 'http') === 0; - } - - /** - * Get the URL to fetch avatars from. - * @return string|mixed - */ - protected function getAvatarUrl() - { - $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; - } - /** * Delete gallery and drawings that are not within HTML content of pages or page revisions. * Checks based off of only the image name. * 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; + $inRevision = false; if ($checkRevisions) { $inRevision = DB::table('page_revisions') @@ -418,36 +337,25 @@ class ImageService /** * Convert a image URI to a Base64 encoded string. - * Attempts to find locally via set storage method first. + * 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): ?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; } @@ -459,6 +367,40 @@ class ImageService 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. * If s3-style store is in use it will default to guessing a public bucket URL.