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 Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;
use Illuminate\Contracts\Cache\Repository as Cache;
-use Setting;
use Symfony\Component\HttpFoundation\File\UploadedFile;
-class ImageService
+class ImageService extends UploadService
{
protected $imageTool;
- protected $fileSystem;
protected $cache;
-
- /**
- * @var FileSystemInstance
- */
- protected $storageInstance;
protected $storageUrl;
+ protected $image;
/**
* 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->fileSystem = $fileSystem;
$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);
}
/**
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.
{
$imageName = $imageName ? $imageName : basename($url);
$imageData = file_get_contents($url);
- if($imageData === false) throw new \Exception('Cannot get image from ' . $url);
+ if ($imageData === false) {
+ throw new \Exception(trans('errors.cannot_get_image_from_url', ['url' => $url]));
+ }
return $this->saveNew($imageName, $imageData, $type);
}
*/
private function saveNew($imageName, $imageData, $type, $uploadedTo = 0)
{
- $storage = $this->getStorage();
+ $storage = $this->getStorage($type);
$secureUploads = setting('app-secure-images');
$imageName = str_replace(' ', '-', $imageName);
- if ($secureUploads) $imageName = str_random(16) . '-' . $imageName;
-
$imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/';
+
while ($storage->exists($imagePath . $imageName)) {
$imageName = str_random(3) . $imageName;
}
+
$fullPath = $imagePath . $imageName;
+ if ($secureUploads) {
+ $fullPath = $imagePath . str_random(16) . '-' . $imageName;
+ }
try {
$storage->put($fullPath, $imageData);
$storage->setVisibility($fullPath, 'public');
} catch (Exception $e) {
- throw new ImageUploadException('Image Path ' . $fullPath . ' is not writable by the server.');
+ throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath]));
}
$imageDetails = [
'uploaded_to' => $uploadedTo
];
- if (auth()->user() && auth()->user()->id !== 0) {
- $userId = auth()->user()->id;
+ if (user()->id !== 0) {
+ $userId = user()->id;
$imageDetails['created_by'] = $userId;
$imageDetails['updated_by'] = $userId;
}
- $image = Image::forceCreate($imageDetails);
-
+ $image = $this->image->newInstance();
+ $image->forceFill($imageDetails)->save();
return $image;
}
+
+ /**
+ * Checks if the image is a gif. Returns true if it is, else false.
+ * @param Image $image
+ * @return boolean
+ */
+ protected function isGif(Image $image)
+ {
+ 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.
- *
* @param Image $image
* @param int $width
* @param int $height
*/
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 . '/';
- $thumbFilePath = dirname($image->path) . $thumbDirName . basename($image->path);
+ $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);
}
- $storage = $this->getStorage();
-
+ $storage = $this->getStorage($image->type);
if ($storage->exists($thumbFilePath)) {
return $this->getPublicUrl($thumbFilePath);
}
try {
- $thumb = $this->imageTool->make($storage->get($image->path));
+ $thumb = $this->imageTool->make($storage->get($imagePath));
} catch (Exception $e) {
if ($e instanceof \ErrorException || $e instanceof NotSupportedException) {
- throw new ImageUploadException('The server cannot create thumbnails. Please check you have the GD PHP extension installed.');
- } else {
- throw $e;
+ throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
}
+ throw $e;
}
if ($keepRatio) {
}
/**
- * 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
+ * @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
*/
- public function destroyImage(Image $image)
+ protected function destroyImagesFromPath(string $path)
{
$storage = $this->getStorage();
- $imageFolder = dirname($image->path);
- $imageFileName = basename($image->path);
+ $imageFolder = dirname($path);
+ $imageFileName = basename($path);
$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;
});
-
$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
- * @param int $size
+ * @param int $size
* @return mixed
+ * @throws Exception
*/
public function saveUserGravatar(User $user, $size = 500)
{
$emailHash = md5(strtolower(trim($user->email)));
- $url = 'http://www.gravatar.com/avatar/' . $emailHash . '?s=' . $size . '&d=identicon';
+ $url = 'https://www.gravatar.com/avatar/' . $emailHash . '?s=' . $size . '&d=identicon';
$imageName = str_replace(' ', '-', $user->name . '-gravatar.png');
$image = $this->saveNewFromUrl($url, 'user', $imageName);
$image->created_by = $user->id;
return $image;
}
+
/**
- * Get the storage that will be used for storing images.
- * @return FileSystemInstance
+ * 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
*/
- private function getStorage()
+ public function deleteUnusedImages($checkRevisions = true, $dryRun = true, $types = ['gallery', 'drawio'])
{
- if ($this->storageInstance !== null) return $this->storageInstance;
-
- $storageType = config('filesystems.default');
- $this->storageInstance = $this->fileSystem->disk($storageType);
-
- return $this->storageInstance;
+ $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;
}
/**
- * Check whether or not a folder is empty.
- * @param $path
- * @return int
+ * 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
*/
- private function isFolderEmpty($path)
+ public function imageUriToBase64(string $uri)
{
- $files = $this->getStorage()->files($path);
- $folders = $this->getStorage()->directories($path);
- return count($files) === 0 && count($folders) === 0;
+ $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 $filePath
+ * @param string $filePath
* @return string
*/
private function getPublicUrl($filePath)
$storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
}
}
-
$this->storageUrl = $storageUrl;
}
- return ($this->storageUrl == false ? '' : rtrim($this->storageUrl, '/')) . $filePath;
+ $basePath = ($this->storageUrl == false) ? baseUrl('/') : $this->storageUrl;
+ return rtrim($basePath, '/') . $filePath;
}
-
-
}
projects / bookstack / blobdiff