File Coverage

blib/lib/GD/Thumbnail.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

package GD::Thumbnail;
use strict;
use warnings;
use vars qw($VERSION %TMP);

$VERSION = '1.42';

use GD;
use Carp qw( croak );

use constant GIF_OK               => $GD::VERSION >= 2.15 || $GD::VERSION <= 1.19;
use constant DEFAULT_MIME         => 'png';
use constant BUFFER               => 2; # y-buffer for info strips in pixels
use constant BLACK                => [   0,   0,   0 ];
use constant WHITE                => [ 255, 255, 255 ];
use constant IMG_X                => 0;
use constant IMG_Y                => 1;
use constant ALL_MIME             => qw(gif png jpeg gd gd2 wbmp);

use constant KILOBYTE             => 1024;
use constant MEGABYTE             => 1024 * KILOBYTE;
use constant GIGABYTE             => 1024 * MEGABYTE;

use constant DEFAULT_MAX_PIXELS   =>   50;
use constant PATH_LENGTH          =>  255;
use constant MAX_JPEG_QUALITY     =>  100;
use constant MAX_PNG_COMPRESSION  =>    9;
use constant STAT_SIZE            =>    7;
use constant RATIO_CONSTANT       =>  100;
use constant RE_FILE_EXTENSION    => qr{ [.] (png|gif|jpg|jpe|jpeg) \z }xmsi;
use constant RE_RATIO             => qr{ (\d+)(?:\s+|)% }xms;

%TMP = ( # global template. so that one can change the text
   GB   => '%.2f GB',
   MB   => '%.2f MB',
   KB   => '%.2f KB',
   BY   => '%s bytes',
   TEXT => 'x ',
);

my %KNOWN = map { ($_, $_) } ALL_MIME;
   $KNOWN{'jpg'} = 'jpeg';
   $KNOWN{'jpe'} = 'jpeg';

my %IS_GD_FONT = map { ( lc($_), $_ ) } qw(Small Large MediumBold Tiny Giant);

GD::Image->trueColor(1) if GD::Image->can('trueColor');

sub new {
   my($class, @args)= @_;
   my %o    = @args % 2 ? () : @args;
   my $self = {
      DIMENSION            => [ 0, 0 ], # Thumbnail dimension
      DIMENSION_CONSTRAINT => 0,        # don't exceed w/h?
      FRAME_COLOR          => BLACK,
      FRAME                => 0,        # bool: add frame?
      FORCE_MIME           => q{},      # force output type?
      GD_FONT              => 'Tiny',   # info text color
      INFO_COLOR           => WHITE,
      MIME                 => q{},
      OVERLAY              => 0,        # bool: overlay info strips?
      STRIP_COLOR          => BLACK,
      SQUARE               => 0,        # bool: make square thumb?
   };

   $self->{FRAME}   = $o{frame}  ? 1          : 0;
   $self->{SQUARE}  = $o{square} ? $o{square} : 0;
   $self->{OVERLAY} = ($o{overlay} || $self->{SQUARE}) ? 1 : 0;

   for my $name ( qw( FORCE_MIME DIMENSION_CONSTRAINT ) ) {
      $self->{ $name } = $o{ lc $name } if defined $o{ lc $name };
   }

   if ( $o{font} and my $font = $IS_GD_FONT{ lc $o{font} } ) {
      $self->{GD_FONT} = $font;
   }

   for my $id ( qw( STRIP_COLOR INFO_COLOR FRAME_COLOR ) ) {
      if (my $color = $o{ lc $id }) {
         if ( ref $color && ref $color eq 'ARRAY' && $#{$color} == 2 ) {
            $self->{$id} = $color;
         }
      }
   }

   bless  $self, $class;
   return $self;
}

sub _check_type {
   my($self, $image) = @_;
   my $type;
   if ( length $image <= PATH_LENGTH && $image =~ RE_FILE_EXTENSION ) {
      $type = $KNOWN{lc $1};
      if ( $type eq 'gif' && !GIF_OK ) {
         # code will probably die at $gd assignment below
         warn "GIF format is not supported by this version ($GD::VERSION) of GD\n";
         $type = DEFAULT_MIME;
      }
   }

   $type = DEFAULT_MIME if ! $type;
   return $type;
}

sub _check_ratio {
   my($self, $max, $w, $h) = @_;
   my $ratio;
   if ( $max =~ RE_RATIO ) {
      $ratio = $1;
   }
   else {
      my $n = $self->{DIMENSION_CONSTRAINT}
            ? $w > $h ? $w : $h
            : $w
            ;
      $ratio = sprintf '%.1f', $max * RATIO_CONSTANT / $n;
   }
   croak 'Can not determine thumbnail ratio' if ! $ratio;
   return $ratio;
}

sub _get_iy {
   my($self, $info, $info2, $o, $y, $yy) = @_;
   return 0 if ! $info;
   return $o       ? $y - $yy
          : $info2 ? $y + $yy + BUFFER/2
          :          $y       + BUFFER/2
          ;
}

sub _strips {
   my($self, $info, $info2, $o, $x, $y, $yy) = @_;
   my $iy = $self->_get_iy( $info, $info2, $o, $y, $yy );
   my @strips;
   push @strips, [ $info , 0, $iy, 0, 0, $x, $y , RATIO_CONSTANT ] if $info;
   push @strips, [ $info2, 0,   0, 0, 0, $x, $yy, RATIO_CONSTANT ] if $info2;
   return @strips;
}

sub _alter_for_crop {
   my($self, $xsmall, $x_ref, $y_ref, $dx_ref, $dy_ref) = @_;
   if ( $xsmall ) {
      my $diff   = (${$y_ref} - ${$x_ref}) / ${$x_ref};
      ${$x_ref} += ${$x_ref} * $diff;
      ${$y_ref} += ${$y_ref} * $diff;
      ${$dy_ref} = -${$dx_ref} * (2 - ${$x_ref} / ${$y_ref})**2;
      ${$dx_ref} = 0;
   }
   else {
      my $diff   = (${$x_ref} - ${$y_ref}) / ${$y_ref};
      ${$x_ref} += ${$x_ref} * $diff;
      ${$y_ref} += ${$y_ref} * $diff;
      ${$dx_ref} = -${$dy_ref} * ( 2 - ${$y_ref}/${$x_ref} )**2;
      ${$dy_ref} = 0;
   }
   return;
}

sub _setup_parameters {
   my($self, $opt, $x_ref, $y_ref, $dx_ref, $dy_ref, $ty_ref ) = @_;
   if ( $opt->{square} ) {
      my $rx = $opt->{width} < $opt->{height} ? $opt->{width}/$opt->{height} : 1;
      my $ry = $opt->{width} < $opt->{height} ? 1 : $opt->{height}/$opt->{width};
      my $d;
      if ( $opt->{xsmall} ) {
         $d         =  ${$x_ref} * $rx;
         ${$dx_ref} = (${$x_ref} - $d) / 2;
         ${$x_ref}  = $d;
      }
      else {
         $d         = ${$y_ref} * $ry;
         ${$dy_ref} = (${$y_ref} - $d) / 2;
         ${$y_ref}  = $d;
      }
   }

   if ( ! $opt->{square} || ( $opt->{square} && $opt->{xsmall} ) ) {
      # does not work if square & y_is_small,
      # since we may have info bars which eat y space
      ${$ty_ref} = 0; # TODO. test this more and remove from below
      ${$y_ref}  = ${$y_ref} - ${$ty_ref} - BUFFER/2 if $opt->{overlay};
   }
   return;
}

sub create {
   my $self      = shift;
   my $image     = shift || croak 'Image parameter is missing';
   my $max       = shift || DEFAULT_MAX_PIXELS;
   my $info      = shift || 0;

   my $info2     = $info && $info == 2;
   my $type      = $self->_check_type( $image );
   my $o         = $self->{OVERLAY};
   my $size      = $info2 ? $self->_image_size( $image ) : 0;
   my $gd        = GD::Image->new($image) or croak "GD::Image->new error: $!";
   my($w, $h)    = $gd->getBounds         or croak "getBounds() failed: $!";
   my $ratio     = $self->_check_ratio($max, $w, $h);
   my $square    = $self->{SQUARE} || 0;
   my $crop      = $square && lc $square eq 'crop';

   my $x         = sprintf '%.0f', $w * $ratio / RATIO_CONSTANT;
   my $def_y     = sprintf '%.0f', $h * $ratio / RATIO_CONSTANT;
   my $y         = $square ? $x : $def_y;
   my $yy        = 0; # yy & yy2 has the same value
   my $yy2       = 0;

  ($info , $yy ) = $self->_strip($self->_text($w,$h,$type), $x) if $info;
  ($info2, $yy2) = $self->_strip($self->_size($size)      , $x) if $info2;

   my $ty        = $yy + $yy2;
   my $new_y     = $o ? $y : $y + $ty;
   my $thumb     = GD::Image->new( $x, $new_y );

   # RT#49353 | Alexander Vonk: prefill Thumbnail with strip color, as promised
   $thumb->fill( 0, 0, $thumb->colorAllocate( @{ $self->{STRIP_COLOR} } ) );

   $thumb->colorAllocate(@{ +WHITE }) if ! $info;

   my @strips = $self->_strips( $info, $info2, $o, $x, $y, $yy );
   my $dx     = 0;
   my $dy     = $yy2 || 0;
   my $xsmall = $x < $def_y;

   $self->_setup_parameters(
      {
         xsmall  => $xsmall,
         square  => $square,
         width   => $w,
         height  => $h,
         overlay => $o,
      },
      \$x, \$y, \$dx, \$dy, \$ty
   );

   $self->_alter_for_crop( $xsmall, \$x, \$y, \$dx, \$dy ) if $crop;

   my $resize = $thumb->can('copyResampled') ? 'copyResampled' : 'copyResized';

   $thumb->$resize($gd, $dx, $dy, 0, 0, $x, $y, $w, $h);
   $thumb->copyMerge( @{$_} ) for @strips;

   return $self->_finish( $thumb, $type );
}

sub _finish {
   my($self, $thumb, $type) = @_;
   my @dim = $thumb->getBounds;

   $self->{DIMENSION}[IMG_X] = $dim[IMG_X];
   $self->{DIMENSION}[IMG_Y] = $dim[IMG_Y];

   if ($self->{FRAME}) {
      my $color = $thumb->colorAllocate(@{ $self->{FRAME_COLOR} });
      $thumb->rectangle( 0, 0, $dim[IMG_X] - 1, $dim[IMG_Y] - 1, $color );
   }

   my $mime = $self->_force_mime($thumb);
      $type = $mime if $mime;
   $self->{MIME} = $type;
   my @iopt;
   push @iopt, MAX_JPEG_QUALITY    if $type eq 'jpeg';
   push @iopt, MAX_PNG_COMPRESSION if $type eq 'png';
   return $thumb->$type( @iopt );
}

sub width  { return shift->{DIMENSION}[IMG_X] }
sub height { return shift->{DIMENSION}[IMG_Y] }
sub mime   { return shift->{MIME}             }

sub _force_mime {
   my $self = shift;
   my $gd   = shift || return;
   return if ! $self->{FORCE_MIME};
   my %mime = map { ( $_, $_ ) } ALL_MIME;
   my $type = $mime{ lc $self->{FORCE_MIME} } || return;
   return unless $gd->can($type);
   return $type;
}

sub _text {
   my($self, $w, $h, $type) = @_;
   $type = uc $type;
   my $tmp = $TMP{TEXT} || croak 'TEXT template is not set';
   $tmp =~ s{}{$w}xmsg;
   $tmp =~ s{}{$h}xmsg;
   $tmp =~ s{}{$type}xmsg;
   return $tmp;
}

sub _image_size {
   my $self     = shift;
   my $image    = shift;
   my $img_size = 0;
   # don't do that at home. very dangerous :p
   my $is_image = GD::Image->can('_image_type')
                  && GD::Image::_image_type($image); ## no critic (ProtectPrivateSubs)
   if ( $is_image ) { # raw data
      use bytes;
      $img_size = length $image;
   }
   elsif ( defined fileno $image ) { # filehandle
      binmode $image;
      use bytes;
      local $/;
      $img_size = length <$image>;
   }
   else { # file
      $img_size = (stat $image)[STAT_SIZE] if -e $image && !-d _;
   }
   return $img_size;
}

sub _strip {
   my $self   = shift;
   my $string = shift;
   my $x      = shift;
   my $type   = $self->{GD_FONT};
   my $font   = GD::Font->$type();
   my $sw     = $font->width * length $string;
   my $sh     = $font->height;
   warn "Thumbnail width ($x) is too small for an info text\n" if $x < $sw;
   my $info   = GD::Image->new($x, $sh+BUFFER);
   my $color = $info->colorAllocate(@{ $self->{STRIP_COLOR} });
   $info->filledRectangle(0,0,$x,$sh+BUFFER,$color);
   $info->string($font, ($x - $sw)/2, 0, $string, $info->colorAllocate(@{ $self->{INFO_COLOR} }));
   return $info, $sh + BUFFER;
}

sub _size {
   my $self = shift;
   my $size = shift || return '0 bytes';
   return sprintf $TMP{GB}, $size / GIGABYTE if $size >= GIGABYTE;
   return sprintf $TMP{MB}, $size / MEGABYTE if $size >= MEGABYTE;
   return sprintf $TMP{KB}, $size / KILOBYTE if $size >= KILOBYTE;
   return sprintf $TMP{BY}, $size;
}

1;

__END__