Improves and adds missing pt_BR strings

[bookstack] / app / Services / ImageService.php

diff --git a/app/Services/ImageService.php b/app/Services/ImageService.php
index e34b3fb2b7fb0d6a9db780badd849e6738ee7845..73a677ac23ecf144634b3447aff95c83b45c1fd8 100644 (file)
--- a/app/Services/ImageService.php
+++ b/app/Services/ImageService.php
@@ -3,11 +3,11 @@
 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Image;
 use BookStack\User;
 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Image;
 use BookStack\User;

+use DB;

 use Exception;
 use Intervention\Image\Exception\NotSupportedException;
 use Intervention\Image\ImageManager;
 use Illuminate\Contracts\Filesystem\Factory as FileSystem;
 use Exception;
 use Intervention\Image\Exception\NotSupportedException;
 use Intervention\Image\ImageManager;
 use Illuminate\Contracts\Filesystem\Factory as FileSystem;

-use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;

 use Illuminate\Contracts\Cache\Repository as Cache;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
 use Illuminate\Contracts\Cache\Repository as Cache;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 


@@ -17,20 +17,40 @@ class ImageService extends UploadService
     protected $imageTool;
     protected $cache;
     protected $storageUrl;
     protected $imageTool;
     protected $cache;
     protected $storageUrl;

+    protected $image;

 
     /**
      * ImageService constructor.
 
     /**
      * ImageService constructor.

-     * @param $imageTool
-     * @param $fileSystem
-     * @param $cache
+     * @param Image $image
+     * @param ImageManager $imageTool
+     * @param FileSystem $fileSystem
+     * @param Cache $cache

      */
      */

-    public function __construct(ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)
+    public function __construct(Image $image, ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)

     {
     {

+        $this->image = $image;

         $this->imageTool = $imageTool;
         $this->cache = $cache;
         parent::__construct($fileSystem);
     }
 
         $this->imageTool = $imageTool;
         $this->cache = $cache;
         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 = '')
+    {
+        $storageType = config('filesystems.default');
+
+        // Override default location if set to local public to ensure not visible.
+        if ($type === 'system' && $storageType === 'local_secure') {
+            $storageType = 'local';
+        }
+
+        return $this->fileSystem->disk($storageType);
+    }
+

     /**
      * Saves a new image from an upload.
      * @param UploadedFile $uploadedFile
     /**
      * Saves a new image from an upload.
      * @param UploadedFile $uploadedFile


@@ -46,6 +66,24 @@ class ImageService extends UploadService
         return $this->saveNew($imageName, $imageData, $type, $uploadedTo);
     }
 
         return $this->saveNew($imageName, $imageData, $type, $uploadedTo);
     }
 

+    /**
+     * 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)
+    {
+        $splitData = explode(';base64,', $base64Uri);
+        if (count($splitData) < 2) {
+            throw new ImageUploadException("Invalid base64 image data provided");
+        }
+        $data = base64_decode($splitData[1]);
+        return $this->saveNew($name, $data, $type, $uploadedTo);
+    }

 
     /**
      * Gets an image from url and saves it to the database.
 
     /**
      * Gets an image from url and saves it to the database.


@@ -59,7 +97,9 @@ class ImageService extends UploadService
     {
         $imageName = $imageName ? $imageName : basename($url);
         $imageData = file_get_contents($url);
     {
         $imageName = $imageName ? $imageName : basename($url);
         $imageData = file_get_contents($url);

-        if($imageData === false) throw new \Exception(trans('errors.cannot_get_image_from_url', ['url' => $url]));
+        if ($imageData === false) {
+            throw new \Exception(trans('errors.cannot_get_image_from_url', ['url' => $url]));
+        }

         return $this->saveNew($imageName, $imageData, $type);
     }
 
         return $this->saveNew($imageName, $imageData, $type);
     }
 


@@ -74,20 +114,20 @@ class ImageService extends UploadService
      */
     private function saveNew($imageName, $imageData, $type, $uploadedTo = 0)
     {
      */
     private function saveNew($imageName, $imageData, $type, $uploadedTo = 0)
     {

-        $storage = $this->getStorage();
+        $storage = $this->getStorage($type);

         $secureUploads = setting('app-secure-images');
         $imageName = str_replace(' ', '-', $imageName);
 
         $secureUploads = setting('app-secure-images');
         $imageName = str_replace(' ', '-', $imageName);
 

-        if ($secureUploads) $imageName = str_random(16) . '-' . $imageName;
-

         $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/';
 
         $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/';
 

-        if ($this->isLocal()) $imagePath = '/public' . $imagePath;
-

         while ($storage->exists($imagePath . $imageName)) {
             $imageName = str_random(3) . $imageName;
         }
         while ($storage->exists($imagePath . $imageName)) {
             $imageName = str_random(3) . $imageName;
         }

+

         $fullPath = $imagePath . $imageName;
         $fullPath = $imagePath . $imageName;

+        if ($secureUploads) {
+            $fullPath = $imagePath . str_random(16) . '-' . $imageName;
+        }

 
         try {
             $storage->put($fullPath, $imageData);
 
         try {
             $storage->put($fullPath, $imageData);


@@ -96,8 +136,6 @@ class ImageService extends UploadService
             throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath]));
         }
 
             throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath]));
         }
 

-        if ($this->isLocal()) $fullPath = str_replace_first('/public', '', $fullPath);
-

         $imageDetails = [
             'name'       => $imageName,
             'path'       => $fullPath,
         $imageDetails = [
             'name'       => $imageName,
             'path'       => $fullPath,


@@ -112,26 +150,26 @@ class ImageService extends UploadService
             $imageDetails['updated_by'] = $userId;
         }
 
             $imageDetails['updated_by'] = $userId;
         }
 

-        $image = Image::forceCreate($imageDetails);
-
+        $image = $this->image->newInstance();
+        $image->forceFill($imageDetails)->save();

         return $image;
     }
 
         return $image;
     }
 

+

     /**
     /**

-     * Get the storage path, Dependant of storage type.
+     * Checks if the image is a gif. Returns true if it is, else false.

      * @param Image $image
      * @param Image $image

-     * @return mixed|string
+     * @return boolean

      */
      */

-    protected function getPath(Image $image)
+    protected function isGif(Image $image)

     {
     {

-        return ($this->isLocal()) ? ('public/' . $image->path) : $image->path;
+        return strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'gif';

     }
 
     /**
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.
     }
 
     /**
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.

-     *

      * @param Image $image
      * @param int $width
      * @param int $height
      * @param Image $image
      * @param int $width
      * @param int $height


@@ -142,16 +180,19 @@ class ImageService extends UploadService
      */
     public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
     {
      */
     public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
     {

+        if ($keepRatio && $this->isGif($image)) {
+            return $this->getPublicUrl($image->path);
+        }
+

         $thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';
         $thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';

-        $imagePath = $this->getPath($image);
+        $imagePath = $image->path;

         $thumbFilePath = dirname($imagePath) . $thumbDirName . basename($imagePath);
 
         if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
 
         $thumbFilePath = dirname($imagePath) . $thumbDirName . basename($imagePath);
 
         if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
 

-        $storage = $this->getStorage();
-
+        $storage = $this->getStorage($image->type);

         if ($storage->exists($thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
         if ($storage->exists($thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }


@@ -161,9 +202,8 @@ class ImageService extends UploadService
         } catch (Exception $e) {
             if ($e instanceof \ErrorException || $e instanceof NotSupportedException) {
                 throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
         } catch (Exception $e) {
             if ($e instanceof \ErrorException || $e instanceof NotSupportedException) {
                 throw new ImageUploadException(trans('errors.cannot_create_thumbs'));

-            } else {
-                throw $e;

             }
             }

+            throw $e;

         }
 
         if ($keepRatio) {
         }
 
         if ($keepRatio) {


@@ -184,40 +224,67 @@ class ImageService extends UploadService
     }
 
     /**
     }
 
     /**

-     * Destroys an Image object along with its files and thumbnails.
+     * Get the raw data content from an image.
+     * @param Image $image
+     * @return string
+     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     */
+    public function getImageData(Image $image)
+    {
+        $imagePath = $image->path;
+        $storage = $this->getStorage();
+        return $storage->get($imagePath);
+    }
+
+    /**
+     * Destroy an image along with its revisions, thumbnails and remaining folders.

      * @param Image $image
      * @param Image $image

+     * @throws Exception
+     */
+    public function destroy(Image $image)
+    {
+        $this->destroyImagesFromPath($image->path);
+        $image->delete();
+    }
+
+    /**
+     * Destroys an image at the given path.
+     * Searches for image thumbnails in addition to main provided path..
+     * @param string $path

      * @return bool
      */
      * @return bool
      */

-    public function destroyImage(Image $image)
+    protected function destroyImagesFromPath(string $path)

     {
         $storage = $this->getStorage();
 
     {
         $storage = $this->getStorage();
 

-        $imageFolder = dirname($this->getPath($image));
-        $imageFileName = basename($this->getPath($image));
+        $imageFolder = dirname($path);
+        $imageFileName = basename($path);

         $allImages = collect($storage->allFiles($imageFolder));
 
         $allImages = collect($storage->allFiles($imageFolder));
 

+        // Delete image files

         $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {
             $expectedIndex = strlen($imagePath) - strlen($imageFileName);
             return strpos($imagePath, $imageFileName) === $expectedIndex;
         });
         $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {
             $expectedIndex = strlen($imagePath) - strlen($imageFileName);
             return strpos($imagePath, $imageFileName) === $expectedIndex;
         });

-

         $storage->delete($imagesToDelete->all());
 
         // Cleanup of empty folders
         $storage->delete($imagesToDelete->all());
 
         // Cleanup of empty folders

-        foreach ($storage->directories($imageFolder) as $directory) {
-            if ($this->isFolderEmpty($directory)) $storage->deleteDirectory($directory);
+        $foldersInvolved = array_merge([$imageFolder], $storage->directories($imageFolder));
+        foreach ($foldersInvolved as $directory) {
+            if ($this->isFolderEmpty($directory)) {
+                $storage->deleteDirectory($directory);
+            }

         }
         }

-        if ($this->isFolderEmpty($imageFolder)) $storage->deleteDirectory($imageFolder);

 
 

-        $image->delete();

         return true;
     }
 
     /**
      * Save a gravatar image and set a the profile image for a user.
      * @param User $user
         return true;
     }
 
     /**
      * Save a gravatar image and set a the profile image for a user.
      * @param User $user

-     * @param int  $size
+     * @param int $size

      * @return mixed
      * @return mixed

+     * @throws Exception

      */
     public function saveUserGravatar(User $user, $size = 500)
     {
      */
     public function saveUserGravatar(User $user, $size = 500)
     {


@@ -231,6 +298,93 @@ class ImageService extends UploadService
         return $image;
     }
 
         return $image;
     }
 

+
+    /**
+     * 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'])
+    {
+        $types = array_intersect($types, ['gallery', 'drawio']);
+        $deletedPaths = [];
+
+        $this->image->newQuery()->whereIn('type', $types)
+            ->chunk(1000, function($images) use ($types, $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')
+                             ->where('html', 'like', $searchQuery)->count() > 0;
+                 }
+
+                 if (!$inPage && !$inRevision) {
+                     $deletedPaths[] = $image->path;
+                     if (!$dryRun) {
+                         $this->destroy($image);
+                     }
+                 }
+             }
+        });
+        return $deletedPaths;
+    }
+
+    /**
+     * 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
+     */
+    public function imageUriToBase64(string $uri)
+    {
+        $isLocal = strpos(trim($uri), 'http') !== 0;
+
+        // Attempt to find local files even if url not absolute
+        $base = baseUrl('/');
+        if (!$isLocal && strpos($uri, $base) === 0) {
+            $isLocal = true;
+            $uri = str_replace($base, '', $uri);
+        }
+
+        $imageData = null;
+
+        if ($isLocal) {
+            $uri = trim($uri, '/');
+            $storage = $this->getStorage();
+            if ($storage->exists($uri)) {
+                $imageData = $storage->get($uri);
+            }
+        } 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);
+                }
+            } catch (\Exception $e) {
+            }
+        }
+
+        if ($imageData === null) {
+            return null;
+        }
+
+        return 'data:image/' . pathinfo($uri, PATHINFO_EXTENSION) . ';base64,' . base64_encode($imageData);
+    }
+

     /**
      * Gets a public facing url for an image by checking relevant environment variables.
      * @param string $filePath
     /**
      * Gets a public facing url for an image by checking relevant environment variables.
      * @param string $filePath


@@ -252,14 +406,10 @@ class ImageService extends UploadService
                     $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
                 }
             }
                     $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
                 }
             }

-

             $this->storageUrl = $storageUrl;
         }
 
             $this->storageUrl = $storageUrl;
         }
 

-        if ($this->isLocal()) $filePath = str_replace_first('public/', '', $filePath);
-
-        return ($this->storageUrl == false ? rtrim(baseUrl(''), '/') : rtrim($this->storageUrl, '/')) . $filePath;
+        $basePath = ($this->storageUrl == false) ? baseUrl('/') : $this->storageUrl;
+        return rtrim($basePath, '/') . $filePath;

     }
     }

-
-

 }
 }