2015-12-07 18:00:34 -05:00
|
|
|
<?php namespace BookStack\Repos;
|
|
|
|
|
|
|
|
use BookStack\Image;
|
2016-04-03 09:59:54 -04:00
|
|
|
use BookStack\Page;
|
2015-12-09 14:50:17 -05:00
|
|
|
use BookStack\Services\ImageService;
|
2016-05-01 16:20:50 -04:00
|
|
|
use BookStack\Services\PermissionService;
|
2015-12-07 18:00:34 -05:00
|
|
|
use Symfony\Component\HttpFoundation\File\UploadedFile;
|
|
|
|
|
|
|
|
class ImageRepo
|
|
|
|
{
|
|
|
|
|
|
|
|
protected $image;
|
2015-12-09 14:50:17 -05:00
|
|
|
protected $imageService;
|
2016-08-14 07:29:35 -04:00
|
|
|
protected $restrictionService;
|
2016-04-03 09:59:54 -04:00
|
|
|
protected $page;
|
2015-12-07 18:00:34 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ImageRepo constructor.
|
2016-03-13 09:30:47 -04:00
|
|
|
* @param Image $image
|
2015-12-09 14:50:17 -05:00
|
|
|
* @param ImageService $imageService
|
2016-05-01 16:20:50 -04:00
|
|
|
* @param PermissionService $permissionService
|
2016-04-03 09:59:54 -04:00
|
|
|
* @param Page $page
|
2015-12-07 18:00:34 -05:00
|
|
|
*/
|
2016-05-01 16:20:50 -04:00
|
|
|
public function __construct(Image $image, ImageService $imageService, PermissionService $permissionService, Page $page)
|
2015-12-07 18:00:34 -05:00
|
|
|
{
|
|
|
|
$this->image = $image;
|
2015-12-09 14:50:17 -05:00
|
|
|
$this->imageService = $imageService;
|
2016-08-14 07:29:35 -04:00
|
|
|
$this->restrictionService = $permissionService;
|
2016-04-03 09:59:54 -04:00
|
|
|
$this->page = $page;
|
2015-12-07 18:00:34 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get an image with the given id.
|
|
|
|
* @param $id
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function getById($id)
|
|
|
|
{
|
|
|
|
return $this->image->findOrFail($id);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-04-03 09:59:54 -04:00
|
|
|
* Execute a paginated query, returning in a standard format.
|
|
|
|
* Also runs the query through the restriction system.
|
|
|
|
* @param $query
|
2016-03-13 09:30:47 -04:00
|
|
|
* @param int $page
|
|
|
|
* @param int $pageSize
|
2015-12-07 18:00:34 -05:00
|
|
|
* @return array
|
|
|
|
*/
|
2016-04-03 09:59:54 -04:00
|
|
|
private function returnPaginated($query, $page = 0, $pageSize = 24)
|
2015-12-07 18:00:34 -05:00
|
|
|
{
|
2016-08-14 07:29:35 -04:00
|
|
|
$images = $this->restrictionService->filterRelatedPages($query, 'images', 'uploaded_to');
|
2015-12-09 17:30:55 -05:00
|
|
|
$images = $images->orderBy('created_at', 'desc')->skip($pageSize * $page)->take($pageSize + 1)->get();
|
2015-12-07 18:00:34 -05:00
|
|
|
$hasMore = count($images) > $pageSize;
|
|
|
|
|
|
|
|
$returnImages = $images->take(24);
|
|
|
|
$returnImages->each(function ($image) {
|
|
|
|
$this->loadThumbs($image);
|
|
|
|
});
|
|
|
|
|
|
|
|
return [
|
2015-12-09 17:30:55 -05:00
|
|
|
'images' => $returnImages,
|
2015-12-07 18:00:34 -05:00
|
|
|
'hasMore' => $hasMore
|
|
|
|
];
|
|
|
|
}
|
|
|
|
|
2016-04-03 09:59:54 -04:00
|
|
|
/**
|
|
|
|
* Gets a load images paginated, filtered by image type.
|
|
|
|
* @param string $type
|
|
|
|
* @param int $page
|
|
|
|
* @param int $pageSize
|
|
|
|
* @param bool|int $userFilter
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getPaginatedByType($type, $page = 0, $pageSize = 24, $userFilter = false)
|
|
|
|
{
|
|
|
|
$images = $this->image->where('type', '=', strtolower($type));
|
|
|
|
|
|
|
|
if ($userFilter !== false) {
|
|
|
|
$images = $images->where('created_by', '=', $userFilter);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->returnPaginated($images, $page, $pageSize);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Search for images by query, of a particular type.
|
|
|
|
* @param string $type
|
|
|
|
* @param int $page
|
|
|
|
* @param int $pageSize
|
|
|
|
* @param string $searchTerm
|
|
|
|
* @return array
|
|
|
|
*/
|
2018-01-28 11:58:52 -05:00
|
|
|
public function searchPaginatedByType($type, $searchTerm, $page = 0, $pageSize = 24)
|
2016-04-03 09:59:54 -04:00
|
|
|
{
|
|
|
|
$images = $this->image->where('type', '=', strtolower($type))->where('name', 'LIKE', '%' . $searchTerm . '%');
|
|
|
|
return $this->returnPaginated($images, $page, $pageSize);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get gallery images with a particular filter criteria such as
|
|
|
|
* being within the current book or page.
|
|
|
|
* @param $filter
|
|
|
|
* @param $pageId
|
2018-01-28 11:58:52 -05:00
|
|
|
* @param int $pageNum
|
|
|
|
* @param int $pageSize
|
2016-04-03 09:59:54 -04:00
|
|
|
* @return array
|
|
|
|
*/
|
2018-01-28 11:58:52 -05:00
|
|
|
public function getGalleryFiltered($filter, $pageId, $pageNum = 0, $pageSize = 24)
|
2016-04-03 09:59:54 -04:00
|
|
|
{
|
|
|
|
$images = $this->image->where('type', '=', 'gallery');
|
|
|
|
|
|
|
|
$page = $this->page->findOrFail($pageId);
|
|
|
|
|
|
|
|
if ($filter === 'page') {
|
|
|
|
$images = $images->where('uploaded_to', '=', $page->id);
|
|
|
|
} elseif ($filter === 'book') {
|
|
|
|
$validPageIds = $page->book->pages->pluck('id')->toArray();
|
|
|
|
$images = $images->whereIn('uploaded_to', $validPageIds);
|
|
|
|
}
|
|
|
|
|
2018-01-28 11:58:52 -05:00
|
|
|
return $this->returnPaginated($images, $pageNum, $pageSize);
|
2016-04-03 09:59:54 -04:00
|
|
|
}
|
|
|
|
|
2015-12-07 18:00:34 -05:00
|
|
|
/**
|
|
|
|
* Save a new image into storage and return the new image.
|
|
|
|
* @param UploadedFile $uploadFile
|
2016-03-13 09:30:47 -04:00
|
|
|
* @param string $type
|
|
|
|
* @param int $uploadedTo
|
2015-12-07 18:00:34 -05:00
|
|
|
* @return Image
|
2017-12-30 10:24:03 -05:00
|
|
|
* @throws \BookStack\Exceptions\ImageUploadException
|
|
|
|
* @throws \Exception
|
2015-12-07 18:00:34 -05:00
|
|
|
*/
|
2016-03-13 09:30:47 -04:00
|
|
|
public function saveNew(UploadedFile $uploadFile, $type, $uploadedTo = 0)
|
2015-12-07 18:00:34 -05:00
|
|
|
{
|
2016-03-13 09:30:47 -04:00
|
|
|
$image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo);
|
2015-12-07 18:00:34 -05:00
|
|
|
$this->loadThumbs($image);
|
|
|
|
return $image;
|
|
|
|
}
|
|
|
|
|
2017-12-30 10:24:03 -05:00
|
|
|
/**
|
|
|
|
* Save a drawing the the database;
|
|
|
|
* @param string $base64Uri
|
|
|
|
* @param int $uploadedTo
|
|
|
|
* @return Image
|
|
|
|
* @throws \BookStack\Exceptions\ImageUploadException
|
|
|
|
*/
|
|
|
|
public function saveDrawing(string $base64Uri, int $uploadedTo)
|
|
|
|
{
|
|
|
|
$name = 'Drawing-' . user()->getShortName(40) . '-' . strval(time()) . '.png';
|
2018-01-20 10:00:54 -05:00
|
|
|
$image = $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo);
|
2017-12-30 10:24:03 -05:00
|
|
|
return $image;
|
|
|
|
}
|
|
|
|
|
2018-01-20 09:01:35 -05:00
|
|
|
/**
|
|
|
|
* Replace the image content of a drawing.
|
|
|
|
* @param Image $image
|
|
|
|
* @param string $base64Uri
|
|
|
|
* @return Image
|
|
|
|
* @throws \BookStack\Exceptions\ImageUploadException
|
|
|
|
*/
|
|
|
|
public function replaceDrawingContent(Image $image, string $base64Uri)
|
|
|
|
{
|
|
|
|
return $this->imageService->replaceImageDataFromBase64Uri($image, $base64Uri);
|
|
|
|
}
|
|
|
|
|
2015-12-07 18:00:34 -05:00
|
|
|
/**
|
|
|
|
* Update the details of an image via an array of properties.
|
|
|
|
* @param Image $image
|
|
|
|
* @param array $updateDetails
|
|
|
|
* @return Image
|
2017-12-30 10:24:03 -05:00
|
|
|
* @throws \BookStack\Exceptions\ImageUploadException
|
|
|
|
* @throws \Exception
|
2015-12-07 18:00:34 -05:00
|
|
|
*/
|
|
|
|
public function updateImageDetails(Image $image, $updateDetails)
|
|
|
|
{
|
|
|
|
$image->fill($updateDetails);
|
|
|
|
$image->save();
|
|
|
|
$this->loadThumbs($image);
|
|
|
|
return $image;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Destroys an Image object along with its files and thumbnails.
|
|
|
|
* @param Image $image
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function destroyImage(Image $image)
|
|
|
|
{
|
2015-12-09 14:50:17 -05:00
|
|
|
$this->imageService->destroyImage($image);
|
2015-12-07 18:00:34 -05:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Load thumbnails onto an image object.
|
|
|
|
* @param Image $image
|
2017-12-30 10:24:03 -05:00
|
|
|
* @throws \BookStack\Exceptions\ImageUploadException
|
|
|
|
* @throws \Exception
|
2015-12-07 18:00:34 -05:00
|
|
|
*/
|
|
|
|
private function loadThumbs(Image $image)
|
|
|
|
{
|
|
|
|
$image->thumbs = [
|
|
|
|
'gallery' => $this->getThumbnail($image, 150, 150),
|
|
|
|
'display' => $this->getThumbnail($image, 840, 0, true)
|
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
2016-03-13 09:30:47 -04:00
|
|
|
* @param int $width
|
|
|
|
* @param int $height
|
|
|
|
* @param bool $keepRatio
|
2015-12-07 18:00:34 -05:00
|
|
|
* @return string
|
2017-12-30 10:24:03 -05:00
|
|
|
* @throws \BookStack\Exceptions\ImageUploadException
|
|
|
|
* @throws \Exception
|
2015-12-07 18:00:34 -05:00
|
|
|
*/
|
2015-12-08 17:04:59 -05:00
|
|
|
public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
|
2015-12-07 18:00:34 -05:00
|
|
|
{
|
2016-11-12 07:41:34 -05:00
|
|
|
try {
|
|
|
|
return $this->imageService->getThumbnail($image, $width, $height, $keepRatio);
|
2018-01-13 06:11:23 -05:00
|
|
|
} catch (\Exception $exception) {
|
|
|
|
return null;
|
2016-11-12 07:41:34 -05:00
|
|
|
}
|
2015-12-07 18:00:34 -05:00
|
|
|
}
|
|
|
|
|
2017-12-30 10:24:03 -05:00
|
|
|
/**
|
|
|
|
* Get the raw image data from an Image.
|
|
|
|
* @param Image $image
|
|
|
|
* @return null|string
|
|
|
|
*/
|
|
|
|
public function getImageData(Image $image)
|
|
|
|
{
|
|
|
|
try {
|
|
|
|
return $this->imageService->getImageData($image);
|
|
|
|
} catch (\Exception $exception) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-01-28 08:18:28 -05:00
|
|
|
/**
|
|
|
|
* Check if the provided image type is valid.
|
|
|
|
* @param $type
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isValidType($type)
|
|
|
|
{
|
|
|
|
$validTypes = ['drawing', 'gallery', 'cover', 'system', 'user'];
|
|
|
|
return in_array($type, $validTypes);
|
|
|
|
}
|
2018-01-28 11:58:52 -05:00
|
|
|
}
|