[BACK]Return to randomlylabel.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / homework
File:  [LON-CAPA] / loncom / homework / randomlylabel.pm
Revision 1.37: download - view: text, annotated - select for diffs
Tue Apr 9 18:47:23 2024 UTC (7 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, version_2_11_X, HEAD
- Remove trailing white space.

# The LearningOnline Network with CAPA
# randomlabel.png: composite together text and images into 1 image
#
# $Id: randomlylabel.pm,v 1.37 2024/04/09 18:47:23 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#

=pod

=head1 Syntax of randomlylabel commands

Required items are: (one of BGIMG or SIZE) and OBJCOUNT

=over 4

=item BGIMG

/home/... file
/res/ ... URL
or href (href must contain http://...)
Expected to be HTTP escaped

=item SIZE

width:height

Creates a blank canvas of size width,height.

=item BGCOLOR

either I<transparent> or a color hexstring

Sets the background color, if SIZE is used to create a new canvas,
I<trasparent> makes the background transparent.

=item OBJCOUNT

a number

=item OBJTYPE

a colon seperated list of types, supported types are

         B<LINE> B<RECTANGLE> B<POLYGON> B<ARC> B<FILL> B<IMAGE> B<LABEL>

=item OBJI<num>

arguments for this OBJ

some common arguments are

=over 4

=item x y thickness

are pixel values

=item color

a hexstring, without with out a leading # or x)

=item filled

boolean, (1 or 0)

=back

The argumants for the possible object types are

=over 4

=item LINE

x1:y1:x2:y2:color:thickness

=item RECTANGLE

x1:y1:x2:y2:color:thickness:filled

=item ARC

x:y:width:height:start:end:color:thickness:filled

=over 4

=item start, end

start and ends of the arc (in degrees)

=back

=item FILL

x:y:color

=item IMAGE

x:y:file:transparent:srcX:srcY:destW:destH:srcW:srcH

=over 4

=item srcX,srcY,srcW,srcH

the start and extant of the region in file to copy to x,y with width/height
           destW destH

=back

=item LABEL

x:y:text:font:color:direction:rotation

=over 4

=item text

HTTP escaped string of the text to place on the image

=item font

one of B<tiny>, B<small>, B<medium>, B<large>, B<giant>, or an
installed TTF font and point size

=item direction

either B<horizontal> or B<vertical>

=item rotation

number of degrees to rotate the text, relative to the horizontal.
only used if font attribute is set to a freetype font (e.g., helvetica 12),
and in that case, if set to a valid value, overrides value set for direction.

=back

=item  POLYGON

color:width:open:filled

=over 4

=item open

boolean, (1 or 0)

=back

=back


=item OBJEXTRAI<num>

extra arguments for object I<num>

The possible values for this for the different object types are

=over 4

=item POLYGON

a list of coords in the form

     (x,y)-(x,y)-(x,y)

(there can be arbitrarily many of these)

=back

=back

=head1 Example

 BGIMG=file
 OBJTYPE=LINE:LINE:LINE:LINE
 OBJCOUNT=4
 OBJ0=xmin:ymin:xmax:ymax:FFFFFF:3
 OBJ1=xmin:ymax:xmax:ymin:FFFFFF:3
 OBJ2=xmin:ymin:xmax:ymax:FF0000:1
 OBJ3=xmin:ymax:xmax:ymin:FF0000:1

=cut

package Apache::randomlylabel;

use strict;
use Image::Magick;
use Apache::Constants qw(:common);
use Apache::loncommon();
use Math::Trig();
use GD;
use GD::Polyline();
use Apache::lonnet;
use lib '/home/httpd/lib/perl/';
use LONCAPA;
use LONCAPA::LWPReq;

#
# Note: Math::Trig is included in the standard perl package for many distros.
#
# For distros which use rpm the following command will show whether Trig.pm is
# included in the system perl: rpm -q --provides perl |grep Math::Trig
#
# For distros which use deb the following command will show whether Trig.pm is
# included in the system perl: dpkg -S perl |grep Math\/Trig\.pm
#

sub get_image {
    my ($imgsrc,$set_trans)=@_;
    my $image;
    if ($imgsrc !~ m|^(/home/)|) {
	if ($imgsrc !~ /^https?\:/) {
	    $imgsrc=&Apache::lonnet::absolute_url($ENV{'HTTP_HOST'}).$imgsrc;
	}
	my $request=new HTTP::Request('GET',"$imgsrc");
	$request->header(Cookie => $ENV{'HTTP_COOKIE'});
	my $file="/tmp/imagetmp".$$;
        my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
        my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,$file,'','','',1);
	if ($response->is_success) {
	    if ($response->content_type !~ m-/(png|jpg|jpeg)$-i) {
		my $conv_image = Image::Magick->new;
		my $current_figure = $conv_image->Read('filename'=>$file);
		$conv_image->Set('type'=>'TrueColor');
		$conv_image->Set('magick'=>'png');
		my @blobs=$conv_image->ImageToBlob();
		undef $conv_image;
		$image = GD::Image->new($blobs[0]);
	    } else {
		GD::Image->trueColor(1);
		$image = GD::Image->new($file);
	    }
	}
    } elsif ($imgsrc !~ /\.(png|jpg|jpeg)$/i) {
	my $conv_image = Image::Magick->new;
	my $current_figure = $conv_image->Read('filename'=>$imgsrc);
	$conv_image->Set('type'=>'TrueColor');
	$conv_image->Set('magick'=>'png');
	my @blobs=$conv_image->ImageToBlob();
	undef $conv_image;
	$image = GD::Image->new($blobs[0]);
    } else {
	$image = GD::Image->trueColor(1);
	$image = GD::Image->new($imgsrc);
    }
    if ($set_trans && defined($image)) {
	my $white=$image->colorExact(255,255,255);
	if ($white != -1) { $image->transparent($white); }
    }
    return $image;
}

sub get_color_from_hexstring {
    my ($image,$color)=@_;
    if (!$color) { $color='000000'; }
    $color=~s/^[x\#]//;
    my (undef,$red,undef,$green,undef,$blue)=split(/(..)/,$color);
    $red=hex($red);$green=hex($green);$blue=hex($blue);
    my $imcolor;
    if (!($imcolor = $image->colorResolve($red,$green,$blue))) {
	$imcolor = $image->colorClosestHWB($red,$green,$blue);
    }
    return $imcolor;
}

sub add_click {
    my ($image) = @_;

    my $length=6;
    my $bgcolor=&get_color_from_hexstring($image,'FFFFFF');
    my $fgcolor=&get_color_from_hexstring($image,'009999');

    my ($x,$y) = split(':',$env{'form.clickdata'});

    $image->setThickness(3);
    $image->line($x-$length,$y,        $x+$length,$y,        $bgcolor);
    $image->line($x,        $y-$length,$x,        $y+$length,$bgcolor);
    $image->setThickness(1);
    $image->line($x-$length,$y,        $x+$length,$y,        $fgcolor);
    $image->line($x,        $y-$length,$x,        $y+$length,$fgcolor);
}

sub handler {
    my $r = shift;

    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});

    my $prefix;
    if ($ENV{'QUERY_STRING'}=~/OBJCOUNT\=/) {
	$prefix='form.';
    } else {
	$prefix="cgi.$env{'form.token'}.";
    }
    my $epsfile;
    if (defined($env{$prefix."EPSFILE"})) {
        my $user = $env{'user.name'}.'_'.$env{'user.domain'};
        if ($env{$prefix."EPSFILE"} =~ /^\Q$user\E_\d+_\d+_\d+_drawimage\.eps$/) {
            $epsfile = $Apache::lonnet::perlvar{'lonPrtDir'}.'/'.$env{$prefix."EPSFILE"};
        } else {
            &Apache::lonnet::logthis('Unable to create eps file for image object for -'.
                                     $env{'form.token'}.'- for '.$user.' as EPSFILE has '.
                                     'unexpected value');
            return OK;
        }
    }
    unless ($epsfile) {
        $r->content_type('image/png');
        $r->send_http_header;
    }

    my $image;
    if (defined($env{$prefix."BGIMG"})) {
	my $bgimg=&unescape($env{$prefix."BGIMG"});
	#&Apache::lonnet::logthis("BGIMG is ".$bgimg);
	$image=&get_image($bgimg,0);
	if (! defined($image)) {
	    &Apache::lonnet::logthis('Unable to create image object for -'.
				     $env{'form.token'}.'-'.$bgimg);
	    return OK;
	}
    } elsif (defined($env{$prefix."SIZE"})) {
	my ($width,$height)=split(':',$env{$prefix."SIZE"});
	$image = new GD::Image($width,$height,1);
	my ($bgcolor)=split(':',$env{$prefix."BGCOLOR"});
	if ($bgcolor ne 'transparent') {
	    $bgcolor=&get_color_from_hexstring($image,$bgcolor);
#	$image->rectangle(0,0,$width,$height,$bgcolor);
	    $image->fill(0,0,$bgcolor);
	} else {
	    $bgcolor=&get_color_from_hexstring($image,'FFFFFF');
	    $image->fill(0,0,$bgcolor);
	    $image->transparent($bgcolor);
	}
    } else {
	&Apache::lonnet::logthis('Unable to create image object, no info '.$prefix);
	return OK;
    }
    #binmode(STDOUT);
    my @objtypes=split(':',$env{$prefix."OBJTYPE"});
    foreach(my $i=0;$i<$env{$prefix."OBJCOUNT"};$i++) {
	my $type=shift(@objtypes);
	if ($type eq 'LINE') {
	    my ($x1,$y1,$x2,$y2,$color,$thickness)=
		split(':',$env{$prefix."OBJ$i"});
	    my $imcolor=&get_color_from_hexstring($image,$color);
	    if (!defined($thickness)) { $thickness=1; }
	    $image->setThickness($thickness);
#	    $image->setAntiAliased($imcolor);
	    $image->line($x1,$y1,$x2,$y2,$imcolor);
	} elsif ($type eq 'RECTANGLE') {
	    my ($x1,$y1,$x2,$y2,$color,$thickness,$filled)=
		split(':',$env{$prefix."OBJ$i"});
	    if ($x1 > $x2) { my $temp=$x1;$x1=$x2;$x2=$temp; }
	    if ($y1 > $y2) { my $temp=$y1;$y1=$y2;$y2=$temp; }
	    my $imcolor=&get_color_from_hexstring($image,$color);
	    if (!defined($thickness)) { $thickness=1; }
	    $image->setThickness($thickness);
#	    $image->setAntiAliased($imcolor);
	    if ($filled) {
		$image->filledRectangle($x1,$y1,$x2,$y2,$imcolor);
	    } else {
		$image->rectangle($x1,$y1,$x2,$y2,$imcolor);
	    }
	} elsif ($type eq 'POLYGON') {
	    my ($color,$width,$open,$filled)=split(':',$env{$prefix."OBJ$i"});
	    my $imcolor=&get_color_from_hexstring($image,$color);
	    my $polygon = (($open && lc ($open ne 'no')) ?
			   (new GD::Polyline) : (new GD::Polygon));
	    my $added=0;
	    foreach my $coord (split('-',$env{$prefix."OBJEXTRA$i"})) {
		my ($x,$y)=($coord=~m/\(([0-9]+),([0-9]+)\)/);
		$polygon->addPt($x,$y);
		$added++;
	    }
	    $image->setThickness($width);
	    if ($added) {
		if ($open && lc($open) ne 'no') {
		    $image->polydraw($polygon,$imcolor);
		} elsif ($filled && lc($filled) ne 'no') {
		    $image->filledPolygon($polygon,$imcolor);
		} else {
		    $image->polygon($polygon,$imcolor);
		}
	    }
	} elsif ($type eq 'ARC') {
	    my ($x,$y,$width,$height,$start,$end,$color,$thickness,$filled)=
		split(':',$env{$prefix."OBJ$i"});
	    if (!$color) { $color='000000'; }
	    my $imcolor=&get_color_from_hexstring($image,$color);
	    if (!defined($thickness)) { $thickness=1; }
	    $image->setThickness($thickness);
#	    $image->setAntiAliased($imcolor);
	    if ($filled) {
		$image->filledArc($x,$y,$width,$height,$start,$end,
				  $imcolor);
	    } else {
		$image->arc($x,$y,$width,$height,$start,$end,$imcolor);
	    }
	} elsif ($type eq 'FILL') {
	    my ($x,$y,$color)=split(':',$env{$prefix."OBJ$i"});
	    if (!$color) { $color='000000'; }
	    my $imcolor=&get_color_from_hexstring($image,$color);
	    $image->fill($x,$y,$imcolor);
	} elsif ($type eq 'IMAGE') {
	    my ($x,$y,$file,$transparent,$srcX,$srcY,$destW,$destH,$srcW,
		$srcH)=split(':',$env{$prefix."OBJ$i"});
	    $file=&unescape($file);
	    if (!defined($transparent)) { $transparent=1; }
	    my $subimage=&get_image($file,$transparent);
	    if (!defined($subimage)) {
		&Apache::lonnet::logthis('Unable to create image object for '.
					 $file);
		next;
	    }
	    if (!defined($srcW) or !$srcW) {$srcW=($subimage->getBounds())[0];}
	    if (!defined($srcH) or !$srcH) {$srcH=($subimage->getBounds())[1];}
	    if (!defined($destW) or !$destW) { $destW=$srcW; }
	    if (!defined($destH) or !$destH) { $destH=$srcH; }
	    $image->copyResized($subimage,$x,$y,$srcX,$srcY,$destW,$destH,
				$srcW,$srcH);
	} elsif ($type eq 'LABEL') {
	    my ($x,$y,$text,$font,$color,$direction,$rotation)=
		split(':',$env{$prefix."OBJ$i"});
	    $text=&unescape($text);
	    my $imcolor=&get_color_from_hexstring($image,$color);
	    my $type='normal';
	    my ($height,$fontref);
	    if ($font eq 'tiny') {
		$height=GD::Font->Tiny->height;
		$fontref=GD::gdTinyFont;
	    } elsif ($font eq 'small') {
		$height=GD::Font->Small->height;
		$fontref=GD::gdSmallFont;
	    } elsif ($font eq 'medium') {
		$height=GD::Font->MediumBold->height;
		$fontref=GD::gdMediumBoldFont;
	    } elsif ($font eq 'large') {
		$height=GD::Font->Large->height;
		$fontref=GD::gdLargeFont;
	    } elsif ($font eq 'giant' || !$font) {
		$height=GD::Font->Giant->height;
		$fontref=GD::gdGiantFont;
	    } elsif ($image->useFontConfig(1)) {
		$type='ttf';
	    }
	    if ($type eq 'normal' && $direction eq 'vertical') {
		$image->stringUp($fontref,$x,$y-$height,$text,$imcolor);
	    } elsif ($type eq 'normal') {
		$image->string($fontref,$x,$y-$height,$text,$imcolor);
	    } elsif ($type eq 'ttf') {
		my ($fontname,$ptsize)=split(/\s+/,$font);
                my $angle = 0;
                if ($rotation =~ /^(\-|\+|)\d+(|\.\d*)$/) {
                    $angle = Math::Trig::deg2rad($rotation);
                } elsif ($direction eq 'vertical') {
                    $angle = Math::Trig::deg2rad(90);
                } elsif ($direction eq 'horizontal') {
                    $angle = 0;
                }
		$image->stringFT($imcolor,$fontname,$ptsize,$angle,$x,$y,$text);
	    }
	} else {
	    &Apache::lonnet::logthis("randomlylabel unable to handle object of type $type");
	}
    }
    if (exists($env{'form.clickdata'})) { &add_click($image); }
    $image->setThickness(1);
    if ($epsfile) {
        if (open(my $pipe, "| convert png:- $epsfile")) {
            print $pipe $image->png;
            close($pipe);
        } else {
            &Apache::lonnet::logthis("randomlylabel unable to open pipe to convert png to eps");
        }
    } else {
        $r->print($image->png);
    }
    return OK;
}

1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>