<?php namespace BookStack\Uploads;
-use BookStack\Exceptions\ImageUploadException;
-use BookStack\Uploads\Image;
use BookStack\Auth\User;
-use BookStack\Uploads\UploadService;
+use BookStack\Exceptions\HttpFetchException;
+use BookStack\Exceptions\ImageUploadException;
use DB;
use Exception;
+use Illuminate\Contracts\Cache\Repository as Cache;
+use Illuminate\Contracts\Filesystem\Factory as FileSystem;
+use Illuminate\Support\Str;
use Intervention\Image\Exception\NotSupportedException;
use Intervention\Image\ImageManager;
-use Illuminate\Contracts\Filesystem\Factory as FileSystem;
-use Illuminate\Contracts\Cache\Repository as Cache;
+use phpDocumentor\Reflection\Types\Integer;
use Symfony\Component\HttpFoundation\File\UploadedFile;
class ImageService extends UploadService
protected $cache;
protected $storageUrl;
protected $image;
+ protected $http;
/**
* ImageService constructor.
* @param ImageManager $imageTool
* @param FileSystem $fileSystem
* @param Cache $cache
+ * @param HttpFetcher $http
*/
- public function __construct(Image $image, ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)
+ public function __construct(Image $image, ImageManager $imageTool, FileSystem $fileSystem, Cache $cache, HttpFetcher $http)
{
$this->image = $image;
$this->imageTool = $imageTool;
$this->cache = $cache;
+ $this->http = $http;
parent::__construct($fileSystem);
}
*/
protected function getStorage($type = '')
{
- $storageType = config('filesystems.default');
+ $storageType = config('filesystems.images');
- // Override default location if set to local public to ensure not visible.
+ // Ensure system images (App logo) are uploaded to a public space
if ($type === 'system' && $storageType === 'local_secure') {
$storageType = 'local';
}
/**
* Saves a new image from an upload.
* @param UploadedFile $uploadedFile
- * @param string $type
+ * @param string $type
* @param int $uploadedTo
+ * @param int|null $resizeWidth
+ * @param int|null $resizeHeight
+ * @param bool $keepRatio
* @return mixed
* @throws ImageUploadException
*/
- public function saveNewFromUpload(UploadedFile $uploadedFile, $type, $uploadedTo = 0)
- {
+ public function saveNewFromUpload(
+ UploadedFile $uploadedFile,
+ string $type,
+ int $uploadedTo = 0,
+ int $resizeWidth = null,
+ int $resizeHeight = null,
+ bool $keepRatio = true
+ ) {
$imageName = $uploadedFile->getClientOriginalName();
$imageData = file_get_contents($uploadedFile->getRealPath());
+
+ if ($resizeWidth !== null || $resizeHeight !== null) {
+ $imageData = $this->resizeImage($imageData, $resizeWidth, $resizeHeight, $keepRatio);
+ }
+
return $this->saveNew($imageName, $imageData, $type, $uploadedTo);
}
private function saveNewFromUrl($url, $type, $imageName = false)
{
$imageName = $imageName ? $imageName : basename($url);
- $imageData = file_get_contents($url);
- if ($imageData === false) {
+ 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);
$secureUploads = setting('app-secure-images');
$imageName = str_replace(' ', '-', $imageName);
- $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/';
+ $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m') . '/';
while ($storage->exists($imagePath . $imageName)) {
- $imageName = str_random(3) . $imageName;
+ $imageName = Str::random(3) . $imageName;
}
$fullPath = $imagePath . $imageName;
if ($secureUploads) {
- $fullPath = $imagePath . str_random(16) . '-' . $imageName;
+ $fullPath = $imagePath . Str::random(16) . '-' . $imageName;
}
try {
return $this->getPublicUrl($thumbFilePath);
}
+ $thumbData = $this->resizeImage($storage->get($imagePath), $width, $height, $keepRatio);
+
+ $storage->put($thumbFilePath, $thumbData);
+ $storage->setVisibility($thumbFilePath, 'public');
+ $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 60 * 72);
+
+ return $this->getPublicUrl($thumbFilePath);
+ }
+
+ /**
+ * Resize image data.
+ * @param string $imageData
+ * @param int $width
+ * @param int $height
+ * @param bool $keepRatio
+ * @return string
+ * @throws ImageUploadException
+ */
+ protected function resizeImage(string $imageData, $width = 220, $height = null, bool $keepRatio = true)
+ {
try {
- $thumb = $this->imageTool->make($storage->get($imagePath));
+ $thumb = $this->imageTool->make($imageData);
} catch (Exception $e) {
if ($e instanceof \ErrorException || $e instanceof NotSupportedException) {
throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
}
if ($keepRatio) {
- $thumb->resize($width, null, function ($constraint) {
+ $thumb->resize($width, $height, function ($constraint) {
$constraint->aspectRatio();
$constraint->upsize();
});
}
$thumbData = (string)$thumb->encode();
- $storage->put($thumbFilePath, $thumbData);
- $storage->setVisibility($thumbFilePath, 'public');
- $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 72);
- return $this->getPublicUrl($thumbFilePath);
+ // Use original image data if we're keeping the ratio
+ // and the resizing does not save any space.
+ if ($keepRatio && strlen($thumbData) > strlen($imageData)) {
+ return $imageData;
+ }
+
+ return $thumbData;
}
/**
}
/**
- * Save a gravatar image and set a the profile image for a user.
+ * Save an avatar image from an external service.
* @param \BookStack\Auth\User $user
* @param int $size
- * @return mixed
+ * @return Image
* @throws Exception
*/
- public function saveUserGravatar(User $user, $size = 500)
+ public function saveUserAvatar(User $user, $size = 500)
{
- $emailHash = md5(strtolower(trim($user->email)));
- $url = 'https://www.gravatar.com/avatar/' . $emailHash . '?s=' . $size . '&d=identicon';
- $imageName = str_replace(' ', '-', $user->name . '-gravatar.png');
- $image = $this->saveNewFromUrl($url, 'user', $imageName);
+ $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
+ */
+ 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.
$isLocal = strpos(trim($uri), 'http') !== 0;
// Attempt to find local files even if url not absolute
- $base = baseUrl('/');
+ $base = url('/');
if (!$isLocal && strpos($uri, $base) === 0) {
$isLocal = true;
$uri = str_replace($base, '', $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);
- }
+ $imageData = $this->http->fetch($uri);
} catch (\Exception $e) {
}
}
return null;
}
- return 'data:image/' . pathinfo($uri, PATHINFO_EXTENSION) . ';base64,' . base64_encode($imageData);
+ $extension = pathinfo($uri, PATHINFO_EXTENSION);
+ if ($extension === 'svg') {
+ $extension = 'svg+xml';
+ }
+
+ return 'data:image/' . $extension . ';base64,' . base64_encode($imageData);
}
/**
// Get the standard public s3 url if s3 is set as storage type
// Uses the nice, short URL if bucket name has no periods in otherwise the longer
// region-based url will be used to prevent http issues.
- if ($storageUrl == false && config('filesystems.default') === 's3') {
+ if ($storageUrl == false && config('filesystems.images') === 's3') {
$storageDetails = config('filesystems.disks.s3');
if (strpos($storageDetails['bucket'], '.') === false) {
$storageUrl = 'https://' . $storageDetails['bucket'] . '.s3.amazonaws.com';
$this->storageUrl = $storageUrl;
}
- $basePath = ($this->storageUrl == false) ? baseUrl('/') : $this->storageUrl;
+ $basePath = ($this->storageUrl == false) ? url('/') : $this->storageUrl;
return rtrim($basePath, '/') . $filePath;
}
}
projects / bookstack / blobdiff