t_a/cavepaintingsFork
1
Fork 0
forked from Cavemanon/cavepaintings
Code Issues Pull Requests Packages Projects Releases Wiki Activity

formatting pass

Browse Source
This commit is contained in:
Shish
2019-06-14 13:47:50 +01:00
parent d1102cd635
commit 064b24ffc1
18 changed files with 265 additions and 255 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
ext/transcode/main.php
View File

@@ -7,7 +7,7 @@
* Version: 1.0
* Documentation:
* Can transcode on-demand and automatically on upload. Config screen allows choosing an output format for each of the supported input formats.
* Supports GD and ImageMagick. Both support bmp, gif, jpg, png, and webp as inputs, and jpg, png, and lossy webp as outputs.
* Supports GD and ImageMagick. Both support bmp, gif, jpg, png, and webp as inputs, and jpg, png, and lossy webp as outputs.
* ImageMagick additionally supports tiff and psd inputs, and webp lossless output.
* If and image is uanble to be transcoded for any reason, the upload will continue unaffected.
*/
@@ -15,7 +15,9 @@
/*
* This is used by the image transcoding code when there is an error while transcoding
*/
class ImageTranscodeException extends SCoreException{ }
class ImageTranscodeException extends SCoreException
{
}
class TranscodeImage extends Extension
@@ -103,7 +105,7 @@ class TranscodeImage extends Extension
$config->set_default_string('transcode_engine', "gd");
$config->set_default_int('transcode_quality', 80);
foreach(array_values(self::INPUT_FORMATS) as $format) {
foreach (array_values(self::INPUT_FORMATS) as $format) {
$config->set_default_string('transcode_upload_'.$format, "");
}
}
@@ -114,7 +116,7 @@ class TranscodeImage extends Extension
if ($user->is_admin() && $config->get_bool("resize_enabled")) {
$engine = $config->get_string("transcode_engine");
if($this->can_convert_format($engine,$event->image->ext)) {
if ($this->can_convert_format($engine, $event->image->ext)) {
$options = $this->get_supported_output_formats($engine, $event->image->ext);
$event->add_part($this->theme->get_transcode_html($event->image, $options));
}
@@ -131,12 +133,12 @@ class TranscodeImage extends Extension
$sb = new SetupBlock("Image Transcode");
$sb->add_bool_option("transcode_enabled", "Allow transcoding images: ");
$sb->add_bool_option("transcode_upload", "<br>Transcode on upload: ");
$sb->add_choice_option('transcode_engine',self::CONVERSION_ENGINES,"<br />Transcode engine: ");
foreach(self::INPUT_FORMATS as $display=>$format) {
if(in_array($format, self::ENGINE_INPUT_SUPPORT[$engine])) {
$sb->add_choice_option('transcode_engine', self::CONVERSION_ENGINES, "<br />Transcode engine: ");
foreach (self::INPUT_FORMATS as $display=>$format) {
if (in_array($format, self::ENGINE_INPUT_SUPPORT[$engine])) {
$outputs = $this->get_supported_output_formats($engine, $format);
$sb->add_choice_option('transcode_upload_'.$format,$outputs,"<br />$display to: ");
}
$sb->add_choice_option('transcode_upload_'.$format, $outputs, "<br />$display to: ");
}
}
$sb->add_int_option("transcode_quality", "<br/>Lossy format quality: ");
$event->panel->add_block($sb);
@@ -146,31 +148,31 @@ class TranscodeImage extends Extension
{
global $config, $page;
if ($config->get_bool("transcode_upload") == true) {
if ($config->get_bool("transcode_upload") == true) {
$ext = strtolower($event->type);
$ext = $this->clean_format($ext);
if($event->type=="gif"&&is_animated_gif($event->tmpname)) {
if ($event->type=="gif"&&is_animated_gif($event->tmpname)) {
return;
}
if(in_array($ext, array_values(self::INPUT_FORMATS))) {
if (in_array($ext, array_values(self::INPUT_FORMATS))) {
$target_format = $config->get_string("transcode_upload_".$ext);
if(empty($target_format)) {
if (empty($target_format)) {
return;
}
try {
$new_image = $this->transcode_image($event->tmpname, $ext, $target_format);
$event->set_type($this->determine_ext($target_format));
$event->set_tmpname($new_image);
} catch(Exception $e) {
log_error("transcode","Error while performing upload transcode: ".$e->getMessage());
// We don't want to interfere with the upload process,
} catch (Exception $e) {
log_error("transcode", "Error while performing upload transcode: ".$e->getMessage());
// We don't want to interfere with the upload process,
// so if something goes wrong the untranscoded image jsut continues
}
}
}
}
}
@@ -180,30 +182,29 @@ class TranscodeImage extends Extension
global $page, $user;
if ($event->page_matches("transcode") && $user->is_admin()) {
$image_id = int_escape($event->get_arg(0));
if (empty($image_id)) {
$image_id = isset($_POST['image_id']) ? int_escape($_POST['image_id']) : null;
}
// Try to get the image ID
if (empty($image_id)) {
throw new ImageTranscodeException("Can not resize Image: No valid Image ID given.");
}
$image_obj = Image::by_id($image_id);
if (is_null($image_obj)) {
$this->theme->display_error(404, "Image not found", "No image in the database has the ID #$image_id");
} else {
if (isset($_POST['transcode_format'])) {
try {
$image_id = int_escape($event->get_arg(0));
if (empty($image_id)) {
$image_id = isset($_POST['image_id']) ? int_escape($_POST['image_id']) : null;
}
// Try to get the image ID
if (empty($image_id)) {
throw new ImageTranscodeException("Can not resize Image: No valid Image ID given.");
}
$image_obj = Image::by_id($image_id);
if (is_null($image_obj)) {
$this->theme->display_error(404, "Image not found", "No image in the database has the ID #$image_id");
} else {
if (isset($_POST['transcode_format'])) {
try {
$this->transcode_and_replace_image($image_obj, $_POST['transcode_format']);
$page->set_mode("redirect");
$page->set_redirect(make_link("post/view/".$image_id));
} catch (ImageTranscodeException $e) {
$this->theme->display_transcode_error($page, "Error Transcoding", $e->getMessage());
}
}
}
}
} catch (ImageTranscodeException $e) {
$this->theme->display_transcode_error($page, "Error Transcoding", $e->getMessage());
}
}
}
}
}
@@ -214,16 +215,15 @@ class TranscodeImage extends Extension
$engine = $config->get_string("transcode_engine");
if ($user->is_admin()) {
$event->add_action("bulk_transcode","Transcode","",$this->theme->get_transcode_picker_html($this->get_supported_output_formats($engine)));
$event->add_action("bulk_transcode", "Transcode", "", $this->theme->get_transcode_picker_html($this->get_supported_output_formats($engine)));
}
}
public function onBulkAction(BulkActionEvent $event)
{
global $user, $database;
switch($event->action) {
switch ($event->action) {
case "bulk_transcode":
if (!isset($_POST['transcode_format'])) {
return;
@@ -235,7 +235,7 @@ class TranscodeImage extends Extension
try {
$database->beginTransaction();
$image = Image::by_id($id);
if($image==null) {
if ($image==null) {
continue;
}
@@ -244,56 +244,57 @@ class TranscodeImage extends Extension
// otherwise the image entries will be stuck pointing to missing image files
$database->commit();
$total++;
} catch(Exception $e) {
} catch (Exception $e) {
log_error("transcode", "Error while bulk transcode on item $id to $format: ".$e->getMessage());
try {
$database->rollback();
} catch (Exception $e) {}
} catch (Exception $e) {
}
}
}
flash_message("Transcoded $total items");
}
break;
}
}
private function clean_format($format): ?string {
if(array_key_exists($format, self::FORMAT_ALIASES)) {
private function clean_format($format): ?string
{
if (array_key_exists($format, self::FORMAT_ALIASES)) {
return self::FORMAT_ALIASES[$format];
}
return $format;
}
private function can_convert_format($engine, $format): bool
private function can_convert_format($engine, $format): bool
{
$format = $this->clean_format($format);
if(!in_array($format, self::ENGINE_INPUT_SUPPORT[$engine])) {
if (!in_array($format, self::ENGINE_INPUT_SUPPORT[$engine])) {
return false;
}
return true;
}
private function get_supported_output_formats($engine, ?String $omit_format = null): array
private function get_supported_output_formats($engine, ?String $omit_format = null): array
{
$omit_format = $this->clean_format($omit_format);
$output = [];
foreach(self::OUTPUT_FORMATS as $key=>$value) {
if($value=="") {
foreach (self::OUTPUT_FORMATS as $key=>$value) {
if ($value=="") {
$output[$key] = $value;
continue;
}
if(in_array($value, self::ENGINE_OUTPUT_SUPPORT[$engine])
if (in_array($value, self::ENGINE_OUTPUT_SUPPORT[$engine])
&&(empty($omit_format)||$omit_format!=$this->determine_ext($value))) {
$output[$key] = $value;
}
}
}
return $output;
}
private function determine_ext(String $format): String
private function determine_ext(String $format): String
{
switch($format) {
switch ($format) {
case "webp-lossless":
case "webp-lossy":
return "webp";
@@ -327,15 +328,14 @@ class TranscodeImage extends Extension
@unlink($tmp_filename);
send_event(new ImageReplaceEvent($image_obj->id, $new_image));
}
}
private function transcode_image(String $source_name, String $source_format, string $target_format): string
{
global $config;
if($source_format==$this->determine_ext($target_format)) {
if ($source_format==$this->determine_ext($target_format)) {
throw new ImageTranscodeException("Source and target formats are the same: ".$source_format);
}
@@ -343,20 +343,19 @@ class TranscodeImage extends Extension
if(!$this->can_convert_format($engine,$source_format)) {
if (!$this->can_convert_format($engine, $source_format)) {
throw new ImageTranscodeException("Engine $engine does not support input format $source_format");
}
if(!in_array($target_format, self::ENGINE_OUTPUT_SUPPORT[$engine])) {
if (!in_array($target_format, self::ENGINE_OUTPUT_SUPPORT[$engine])) {
throw new ImageTranscodeException("Engine $engine does not support output format $target_format");
}
switch($engine) {
switch ($engine) {
case "gd":
return $this->transcode_image_gd($source_name, $source_format, $target_format);
case "convert":
return $this->transcode_image_convert($source_name, $source_format, $target_format);
}
}
private function transcode_image_gd(String $source_name, String $source_format, string $target_format): string
@@ -370,7 +369,7 @@ class TranscodeImage extends Extension
$image = imagecreatefromstring(file_get_contents($source_name));
try {
$result = false;
switch($target_format) {
switch ($target_format) {
case "webp-lossy":
$result = imagewebp($image, $tmp_name, $q);
break;
@@ -382,18 +381,18 @@ class TranscodeImage extends Extension
$width = imagesx($image);
$height = imagesy($image);
$new_image = imagecreatetruecolor($width, $height);
if($new_image===false) {
if ($new_image===false) {
throw new ImageTranscodeException("Could not create image with dimensions $width x $height");
}
try{
$black = imagecolorallocate($new_image, 0, 0, 0);
if($black===false) {
try {
$black = imagecolorallocate($new_image, 0, 0, 0);
if ($black===false) {
throw new ImageTranscodeException("Could not allocate background color");
}
if(imagefilledrectangle($new_image, 0, 0, $width, $height, $black)===false) {
if (imagefilledrectangle($new_image, 0, 0, $width, $height, $black)===false) {
throw new ImageTranscodeException("Could not fill background color");
}
if(imagecopy($new_image, $image, 0, 0, 0, 0, $width, $height)===false) {
if (imagecopy($new_image, $image, 0, 0, 0, 0, $width, $height)===false) {
throw new ImageTranscodeException("Could not copy source image to new image");
}
$result = imagejpeg($new_image, $tmp_name, $q);
@@ -402,7 +401,7 @@ class TranscodeImage extends Extension
}
break;
}
if($result===false) {
if ($result===false) {
throw new ImageTranscodeException("Error while transcoding ".$source_name." to ".$target_format);
}
return $tmp_name;
@@ -418,15 +417,14 @@ class TranscodeImage extends Extension
$q = $config->get_int("transcode_quality");
$convert = $config->get_string("thumb_convert_path");
if($convert==null||$convert=="")
{
if ($convert==null||$convert=="") {
throw new ImageTranscodeException("ImageMagick path not configured");
}
$ext = $this->determine_ext($target_format);
$args = " -flatten ";
$bg = "none";
switch($target_format) {
switch ($target_format) {
case "webp-lossless":
$args .= '-define webp:lossless=true';
break;
@@ -449,11 +447,10 @@ class TranscodeImage extends Extension
log_debug('transcode', "Transcoding with command `$cmd`, returns $ret");
if($ret!==0) {
if ($ret!==0) {
throw new ImageTranscodeException("Transcoding failed with command ".$cmd);
}
return $tmp_name;
}
}