BookStack Code Mirror - bookstack/blob - app/Uploads/ImageService.php

   1 <?php
   2
   3 namespace BookStack\Uploads;
   4
   5 use BookStack\Exceptions\ImageUploadException;
   6 use ErrorException;
   7 use Exception;
   8 use Illuminate\Contracts\Cache\Repository as Cache;
   9 use Illuminate\Contracts\Filesystem\Factory as FileSystem;
  10 use Illuminate\Contracts\Filesystem\FileNotFoundException;
  11 use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;
  12 use Illuminate\Contracts\Filesystem\Filesystem as Storage;
  13 use Illuminate\Support\Facades\DB;
  14 use Illuminate\Support\Facades\Log;
  15 use Illuminate\Support\Str;
  16 use Intervention\Image\Exception\NotSupportedException;
  17 use Intervention\Image\ImageManager;
  18 use League\Flysystem\Util;
  19 use Psr\SimpleCache\InvalidArgumentException;
  20 use Symfony\Component\HttpFoundation\File\UploadedFile;
  21 use Symfony\Component\HttpFoundation\StreamedResponse;
  22
  23 class ImageService
  24 {
  25     protected $imageTool;
  26     protected $cache;
  27     protected $storageUrl;
  28     protected $image;
  29     protected $fileSystem;
  30
  31     protected static $supportedExtensions = ['jpg', 'jpeg', 'png', 'gif', 'webp'];
  32
  33     /**
  34      * ImageService constructor.
  35      */
  36     public function __construct(Image $image, ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)
  37     {
  38         $this->image = $image;
  39         $this->imageTool = $imageTool;
  40         $this->fileSystem = $fileSystem;
  41         $this->cache = $cache;
  42     }
  43
  44     /**
  45      * Get the storage that will be used for storing images.
  46      */
  47     protected function getStorageDisk(string $imageType = ''): FileSystemInstance
  48     {
  49         return $this->fileSystem->disk($this->getStorageDiskName($imageType));
  50     }
  51
  52     /**
  53      * Check if local secure image storage (Fetched behind authentication)
  54      * is currently active in the instance.
  55      */
  56     protected function usingSecureImages(): bool
  57     {
  58         return $this->getStorageDiskName('gallery') === 'local_secure_images';
  59     }
  60
  61     /**
  62      * Change the originally provided path to fit any disk-specific requirements.
  63      * This also ensures the path is kept to the expected root folders.
  64      */
  65     protected function adjustPathForStorageDisk(string $path, string $imageType = ''): string
  66     {
  67         $path = Util::normalizePath(str_replace('uploads/images/', '', $path));
  68
  69         if ($this->getStorageDiskName($imageType) === 'local_secure_images') {
  70             return $path;
  71         }
  72
  73         return 'uploads/images/' . $path;
  74     }
  75
  76     /**
  77      * Get the name of the storage disk to use.
  78      */
  79     protected function getStorageDiskName(string $imageType): string
  80     {
  81         $storageType = config('filesystems.images');
  82
  83         // Ensure system images (App logo) are uploaded to a public space
  84         if ($imageType === 'system' && $storageType === 'local_secure') {
  85             $storageType = 'local';
  86         }
  87
  88         if ($storageType === 'local_secure') {
  89             $storageType = 'local_secure_images';
  90         }
  91
  92         return $storageType;
  93     }
  94
  95     /**
  96      * Saves a new image from an upload.
  97      *
  98      * @throws ImageUploadException
  99      *
 100      * @return mixed
 101      */
 102     public function saveNewFromUpload(
 103         UploadedFile $uploadedFile,
 104         string $type,
 105         int $uploadedTo = 0,
 106         int $resizeWidth = null,
 107         int $resizeHeight = null,
 108         bool $keepRatio = true
 109     ) {
 110         $imageName = $uploadedFile->getClientOriginalName();
 111         $imageData = file_get_contents($uploadedFile->getRealPath());
 112
 113         if ($resizeWidth !== null || $resizeHeight !== null) {
 114             $imageData = $this->resizeImage($imageData, $resizeWidth, $resizeHeight, $keepRatio);
 115         }
 116
 117         return $this->saveNew($imageName, $imageData, $type, $uploadedTo);
 118     }
 119
 120     /**
 121      * Save a new image from a uri-encoded base64 string of data.
 122      *
 123      * @throws ImageUploadException
 124      */
 125     public function saveNewFromBase64Uri(string $base64Uri, string $name, string $type, int $uploadedTo = 0): Image
 126     {
 127         $splitData = explode(';base64,', $base64Uri);
 128         if (count($splitData) < 2) {
 129             throw new ImageUploadException('Invalid base64 image data provided');
 130         }
 131         $data = base64_decode($splitData[1]);
 132
 133         return $this->saveNew($name, $data, $type, $uploadedTo);
 134     }
 135
 136     /**
 137      * Save a new image into storage.
 138      *
 139      * @throws ImageUploadException
 140      */
 141     public function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image
 142     {
 143         $storage = $this->getStorageDisk($type);
 144         $secureUploads = setting('app-secure-images');
 145         $fileName = $this->cleanImageFileName($imageName);
 146
 147         $imagePath = '/uploads/images/' . $type . '/' . date('Y-m') . '/';
 148
 149         while ($storage->exists($this->adjustPathForStorageDisk($imagePath . $fileName, $type))) {
 150             $fileName = Str::random(3) . $fileName;
 151         }
 152
 153         $fullPath = $imagePath . $fileName;
 154         if ($secureUploads) {
 155             $fullPath = $imagePath . Str::random(16) . '-' . $fileName;
 156         }
 157
 158         try {
 159             $this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($fullPath, $type), $imageData);
 160         } catch (Exception $e) {
 161             Log::error('Error when attempting image upload:' . $e->getMessage());
 162
 163             throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath]));
 164         }
 165
 166         $imageDetails = [
 167             'name'        => $imageName,
 168             'path'        => $fullPath,
 169             'url'         => $this->getPublicUrl($fullPath),
 170             'type'        => $type,
 171             'uploaded_to' => $uploadedTo,
 172         ];
 173
 174         if (user()->id !== 0) {
 175             $userId = user()->id;
 176             $imageDetails['created_by'] = $userId;
 177             $imageDetails['updated_by'] = $userId;
 178         }
 179
 180         $image = $this->image->newInstance();
 181         $image->forceFill($imageDetails)->save();
 182
 183         return $image;
 184     }
 185
 186     /**
 187      * Save image data for the given path in the public space, if possible,
 188      * for the provided storage mechanism.
 189      */
 190     protected function saveImageDataInPublicSpace(Storage $storage, string $path, string $data)
 191     {
 192         $storage->put($path, $data);
 193
 194         // Set visibility when a non-AWS-s3, s3-like storage option is in use.
 195         // Done since this call can break s3-like services but desired for other image stores.
 196         // Attempting to set ACL during above put request requires different permissions
 197         // hence would technically be a breaking change for actual s3 usage.
 198         $usingS3 = strtolower(config('filesystems.images')) === 's3';
 199         $usingS3Like = $usingS3 && !is_null(config('filesystems.disks.s3.endpoint'));
 200         if (!$usingS3Like) {
 201             $storage->setVisibility($path, 'public');
 202         }
 203     }
 204
 205     /**
 206      * Clean up an image file name to be both URL and storage safe.
 207      */
 208     protected function cleanImageFileName(string $name): string
 209     {
 210         $name = str_replace(' ', '-', $name);
 211         $nameParts = explode('.', $name);
 212         $extension = array_pop($nameParts);
 213         $name = implode('-', $nameParts);
 214         $name = Str::slug($name);
 215
 216         if (strlen($name) === 0) {
 217             $name = Str::random(10);
 218         }
 219
 220         return $name . '.' . $extension;
 221     }
 222
 223     /**
 224      * Checks if the image is a gif. Returns true if it is, else false.
 225      */
 226     protected function isGif(Image $image): bool
 227     {
 228         return strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'gif';
 229     }
 230
 231     /**
 232      * Get the thumbnail for an image.
 233      * If $keepRatio is true only the width will be used.
 234      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.
 235      * @throws Exception
 236      * @throws InvalidArgumentException
 237      */
 238     public function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio = false): string
 239     {
 240         if ($keepRatio && $this->isGif($image)) {
 241             return $this->getPublicUrl($image->path);
 242         }
 243
 244         $thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';
 245         $imagePath = $image->path;
 246         $thumbFilePath = dirname($imagePath) . $thumbDirName . basename($imagePath);
 247
 248         if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) {
 249             return $this->getPublicUrl($thumbFilePath);
 250         }
 251
 252         $storage = $this->getStorageDisk($image->type);
 253         if ($storage->exists($this->adjustPathForStorageDisk($thumbFilePath, $image->type))) {
 254             return $this->getPublicUrl($thumbFilePath);
 255         }
 256
 257         $thumbData = $this->resizeImage($storage->get($this->adjustPathForStorageDisk($imagePath, $image->type)), $width, $height, $keepRatio);
 258
 259         $this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($thumbFilePath, $image->type), $thumbData);
 260         $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 60 * 72);
 261
 262         return $this->getPublicUrl($thumbFilePath);
 263     }
 264
 265     /**
 266      * Resize the image of given data to the specified size, and return the new image data.
 267      *
 268      * @throws ImageUploadException
 269      */
 270     protected function resizeImage(string $imageData, ?int $width, ?int $height, bool $keepRatio): string
 271     {
 272         try {
 273             $thumb = $this->imageTool->make($imageData);
 274         } catch (ErrorException | NotSupportedException $e) {
 275             throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
 276         }
 277
 278         if ($keepRatio) {
 279             $thumb->resize($width, $height, function ($constraint) {
 280                 $constraint->aspectRatio();
 281                 $constraint->upsize();
 282             });
 283         } else {
 284             $thumb->fit($width, $height);
 285         }
 286
 287         $thumbData = (string) $thumb->encode();
 288
 289         // Use original image data if we're keeping the ratio
 290         // and the resizing does not save any space.
 291         if ($keepRatio && strlen($thumbData) > strlen($imageData)) {
 292             return $imageData;
 293         }
 294
 295         return $thumbData;
 296     }
 297
 298     /**
 299      * Get the raw data content from an image.
 300      *
 301      * @throws FileNotFoundException
 302      */
 303     public function getImageData(Image $image): string
 304     {
 305         $storage = $this->getStorageDisk();
 306
 307         return $storage->get($this->adjustPathForStorageDisk($image->path, $image->type));
 308     }
 309
 310     /**
 311      * Destroy an image along with its revisions, thumbnails and remaining folders.
 312      *
 313      * @throws Exception
 314      */
 315     public function destroy(Image $image)
 316     {
 317         $this->destroyImagesFromPath($image->path, $image->type);
 318         $image->delete();
 319     }
 320
 321     /**
 322      * Destroys an image at the given path.
 323      * Searches for image thumbnails in addition to main provided path.
 324      */
 325     protected function destroyImagesFromPath(string $path, string $imageType): bool
 326     {
 327         $path = $this->adjustPathForStorageDisk($path, $imageType);
 328         $storage = $this->getStorageDisk($imageType);
 329
 330         $imageFolder = dirname($path);
 331         $imageFileName = basename($path);
 332         $allImages = collect($storage->allFiles($imageFolder));
 333
 334         // Delete image files
 335         $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {
 336             return basename($imagePath) === $imageFileName;
 337         });
 338         $storage->delete($imagesToDelete->all());
 339
 340         // Cleanup of empty folders
 341         $foldersInvolved = array_merge([$imageFolder], $storage->directories($imageFolder));
 342         foreach ($foldersInvolved as $directory) {
 343             if ($this->isFolderEmpty($storage, $directory)) {
 344                 $storage->deleteDirectory($directory);
 345             }
 346         }
 347
 348         return true;
 349     }
 350
 351     /**
 352      * Check whether a folder is empty.
 353      */
 354     protected function isFolderEmpty(FileSystemInstance $storage, string $path): bool
 355     {
 356         $files = $storage->files($path);
 357         $folders = $storage->directories($path);
 358
 359         return count($files) === 0 && count($folders) === 0;
 360     }
 361
 362     /**
 363      * Delete gallery and drawings that are not within HTML content of pages or page revisions.
 364      * Checks based off of only the image name.
 365      * Could be much improved to be more specific but kept it generic for now to be safe.
 366      *
 367      * Returns the path of the images that would be/have been deleted.
 368      */
 369     public function deleteUnusedImages(bool $checkRevisions = true, bool $dryRun = true)
 370     {
 371         $types = ['gallery', 'drawio'];
 372         $deletedPaths = [];
 373
 374         $this->image->newQuery()->whereIn('type', $types)
 375             ->chunk(1000, function ($images) use ($checkRevisions, &$deletedPaths, $dryRun) {
 376                 foreach ($images as $image) {
 377                     $searchQuery = '%' . basename($image->path) . '%';
 378                     $inPage = DB::table('pages')
 379                             ->where('html', 'like', $searchQuery)->count() > 0;
 380
 381                     $inRevision = false;
 382                     if ($checkRevisions) {
 383                         $inRevision = DB::table('page_revisions')
 384                                 ->where('html', 'like', $searchQuery)->count() > 0;
 385                     }
 386
 387                     if (!$inPage && !$inRevision) {
 388                         $deletedPaths[] = $image->path;
 389                         if (!$dryRun) {
 390                             $this->destroy($image);
 391                         }
 392                     }
 393                 }
 394             });
 395
 396         return $deletedPaths;
 397     }
 398
 399     /**
 400      * Convert an image URI to a Base64 encoded string.
 401      * Attempts to convert the URL to a system storage url then
 402      * fetch the data from the disk or storage location.
 403      * Returns null if the image data cannot be fetched from storage.
 404      *
 405      * @throws FileNotFoundException
 406      */
 407     public function imageUriToBase64(string $uri): ?string
 408     {
 409         $storagePath = $this->imageUrlToStoragePath($uri);
 410         if (empty($uri) || is_null($storagePath)) {
 411             return null;
 412         }
 413
 414         $storagePath = $this->adjustPathForStorageDisk($storagePath);
 415         $storage = $this->getStorageDisk();
 416         $imageData = null;
 417         if ($storage->exists($storagePath)) {
 418             $imageData = $storage->get($storagePath);
 419         }
 420
 421         if (is_null($imageData)) {
 422             return null;
 423         }
 424
 425         $extension = pathinfo($uri, PATHINFO_EXTENSION);
 426         if ($extension === 'svg') {
 427             $extension = 'svg+xml';
 428         }
 429
 430         return 'data:image/' . $extension . ';base64,' . base64_encode($imageData);
 431     }
 432
 433     /**
 434      * Check if the given path exists in the local secure image system.
 435      * Returns false if local_secure is not in use.
 436      */
 437     public function pathExistsInLocalSecure(string $imagePath): bool
 438     {
 439         $disk = $this->getStorageDisk('gallery');
 440
 441         // Check local_secure is active
 442         return $this->usingSecureImages()
 443             // Check the image file exists
 444             && $disk->exists($imagePath)
 445             // Check the file is likely an image file
 446             && strpos($disk->getMimetype($imagePath), 'image/') === 0;
 447     }
 448
 449     /**
 450      * For the given path, if existing, provide a response that will stream the image contents.
 451      */
 452     public function streamImageFromStorageResponse(string $imageType, string $path): StreamedResponse
 453     {
 454         $disk = $this->getStorageDisk($imageType);
 455         return $disk->response($path);
 456     }
 457
 458     /**
 459      * Check if the given image extension is supported by BookStack.
 460      * The extension must not be altered in this function. This check should provide a guarantee
 461      * that the provided extension is safe to use for the image to be saved.
 462      */
 463     public static function isExtensionSupported(string $extension): bool
 464     {
 465         return in_array($extension, static::$supportedExtensions);
 466     }
 467
 468     /**
 469      * Get a storage path for the given image URL.
 470      * Ensures the path will start with "uploads/images".
 471      * Returns null if the url cannot be resolved to a local URL.
 472      */
 473     private function imageUrlToStoragePath(string $url): ?string
 474     {
 475         $url = ltrim(trim($url), '/');
 476
 477         // Handle potential relative paths
 478         $isRelative = strpos($url, 'http') !== 0;
 479         if ($isRelative) {
 480             if (strpos(strtolower($url), 'uploads/images') === 0) {
 481                 return trim($url, '/');
 482             }
 483
 484             return null;
 485         }
 486
 487         // Handle local images based on paths on the same domain
 488         $potentialHostPaths = [
 489             url('uploads/images/'),
 490             $this->getPublicUrl('/uploads/images/'),
 491         ];
 492
 493         foreach ($potentialHostPaths as $potentialBasePath) {
 494             $potentialBasePath = strtolower($potentialBasePath);
 495             if (strpos(strtolower($url), $potentialBasePath) === 0) {
 496                 return 'uploads/images/' . trim(substr($url, strlen($potentialBasePath)), '/');
 497             }
 498         }
 499
 500         return null;
 501     }
 502
 503     /**
 504      * Gets a public facing url for an image by checking relevant environment variables.
 505      * If s3-style store is in use it will default to guessing a public bucket URL.
 506      */
 507     private function getPublicUrl(string $filePath): string
 508     {
 509         if (is_null($this->storageUrl)) {
 510             $storageUrl = config('filesystems.url');
 511
 512             // Get the standard public s3 url if s3 is set as storage type
 513             // Uses the nice, short URL if bucket name has no periods in otherwise the longer
 514             // region-based url will be used to prevent http issues.
 515             if ($storageUrl == false && config('filesystems.images') === 's3') {
 516                 $storageDetails = config('filesystems.disks.s3');
 517                 if (strpos($storageDetails['bucket'], '.') === false) {
 518                     $storageUrl = 'https://' . $storageDetails['bucket'] . '.s3.amazonaws.com';
 519                 } else {
 520                     $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
 521                 }
 522             }
 523
 524             $this->storageUrl = $storageUrl;
 525         }
 526
 527         $basePath = ($this->storageUrl == false) ? url('/') : $this->storageUrl;
 528
 529         return rtrim($basePath, '/') . $filePath;
 530     }
 531 }