gnu-social/plugins/ImageEncoder/ImageEncoder.php
Diogo Peralta Cordeiro 2f137f8b44 [ATTACHMENTS] Even more further refactoring
Introduce Encoder plugins Instead of abstract upload and thumb modules

Ported attachment routes. In v3 thumbnail depends on existing attachment
so route updated accordingly.
2021-04-19 13:22:04 +01:00

114 lines
3.7 KiB
PHP

<?php
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace Plugin\ImageEncoder;
use App\Core\Event;
use function App\Core\I18n\_m;
use App\Core\Log;
use App\Core\Modules\Plugin;
use App\Entity\Attachment;
use App\Entity\AttachmentThumbnail;
use App\Util\Common;
use Exception;
use Jcupitt\Vips;
use Symfony\Component\HttpFoundation\File\File as SymfonyFile;
class ImageEncoder extends Plugin
{
/**
* Several obscure file types should be normalized to WebP on resize.
*
* Keeps only GIF (if animated) and WebP formats
*
* @return int
*/
public function preferredType(): int
{
if ($this->type == IMAGETYPE_GIF && $this->animated) {
return $this->type;
}
return IMAGETYPE_WEBP;
}
/**
* Encodes the image to self::preferredType() format ensuring it's valid.
*
* @param SymfonyFile $sfile i/o
* @param null|string $mimetype out
*
* @return bool
*/
public function onAttachmentValidation(SymfonyFile &$sfile, ?string &$mimetype = null): bool
{
$original_mimetype = $mimetype ?? $sfile->getMimeType();
// TODO: Encode in place
$mimetype = self::preferredType();
return Event::stop;
}
/**
* Resizes an image. It will encode the image in the
* `self::preferredType()` format. This only applies henceforward,
* not retroactively
*
* Increases the 'memory_limit' to the one in the 'attachments' section in the config, to
* enable the handling of bigger images, which can cause a peak of memory consumption, while
* encoding
*
* @param Attachment $attachment
* @param AttachmentThumbnail $thumbnail
* @param int $width
* @param int $height
* @param bool $crop
*
* @throws Exception
* @throws Vips\Exception
*
* @return bool
*
*/
public function onResizeImage(Attachment $attachment, AttachmentThumbnail $thumbnail, int $width, int $height, bool $crop): bool
{
$old_limit = ini_set('memory_limit', Common::config('attachments', 'memory_limit'));
try {
// -1 means load all pages, 'sequential' access means decode pixels on demand
// $image = Vips\Image::newFromFile(self::getPath($attachment), ['n' => -1, 'access' => 'sequential']);
$image = Vips\Image::thumbnail($attachment->getPath(), $width, ['height' => $height]);
} catch (Exception $e) {
Log::error(__METHOD__ . ' encountered exception: ' . print_r($e, true));
// TRANS: Exception thrown when trying to resize an unknown file type.
throw new Exception(_m('Unknown file type'));
}
if ($attachment->getPath() === $thumbnail->getPath()) {
@unlink($thumbnail->getPath());
}
$image->writeToFile($thumbnail->getPath());
unset($image);
ini_set('memory_limit', $old_limit); // Restore the old memory limit
return Event::next;
}
}