--- loncom/homework/randomlabel.pm 2005/05/31 22:14:32 1.76
+++ loncom/homework/randomlabel.pm 2006/08/29 10:42:59 1.83
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# random labelling tool
#
-# $Id: randomlabel.pm,v 1.76 2005/05/31 22:14:32 foxr Exp $
+# $Id: randomlabel.pm,v 1.83 2006/08/29 10:42:59 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -61,24 +61,22 @@ use Apache::File();
use Apache::Constants qw(:common :http);
use Image::Magick;
use Apache::lonplot;
+use lib '/home/httpd/lib/perl/';
+use LONCAPA;
+
my %args;
my $cgi_id;
my $scale_factor; # image scale factor.
my $label_xscale; # Label scale factor (needed for gnuplot).
my $label_yscale;
-my $gnuplot_background; # This will be true if a gnuplot backgound
BEGIN {
&Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label','bgimg'));
}
-# Gnuplot calback called if a </gnuplot> tag is encountered:
-#
-sub gnuplot_handler {
- $gnuplot_background = 1;
-}
+
sub check_int {
# utility function to do error checking on a integer.
@@ -92,12 +90,41 @@ sub check_int {
return $num;
}
+# Get width/height from an image tag...
+#
+# Parameters:
+# tag - tag potentially containing height/width attributes.
+# def_width - Default width.
+# def_height - Default height.
+# Returns:
+# list containing width/height.
+#
+sub extract_tag_sizes {
+ my ($tag, $dw, $dh) = @_;
+ $tag =~ s/\s+/ /g; # Collapse whitespace.
+ $tag =~ s/\s*=\s*/=/g; # kill space around ='s.
+ $tag =~ s/[<>\"]//g; # Get rid of the <">'s too.
+
+ &Apache::lonxml::debug("Compressed tag: $tag");
+ my @taglist = split(/ /,$tag);
+ foreach my $attribute (@taglist) {
+ if ($attribute =~ /^width/i) {
+ my ($e, $s)= split(/=/,$attribute);
+ $dw = $s;
+ }
+ if ($attribute =~ /^height/i) {
+ my ($e, $s) = split(/=/,$attribute);
+ $dh = $s;
+ }
+ }
+ return($dw, $dh);
+
+}
+
my ($height_param,$width_param);
sub start_randomlabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
- $gnuplot_background = 0;
- &Apache::lonplot::register_callback(\&gnuplot_handler);
my $result='';
push (@Apache::lonxml::namespace,'randomlabel');
($height_param,$width_param)=(0,0);
@@ -114,7 +141,7 @@ sub start_randomlabel {
if ($target eq 'web') {
$cgi_id=&Apache::loncommon::get_cgi_id();
%args=();
- $args{"cgi.$cgi_id.BGIMG"}=&Apache::lonnet::escape($bgimg);
+ $args{"cgi.$cgi_id.BGIMG"}=&escape($bgimg);
$height_param = &Apache::lonxml::get_param('height',$parstack, $safeeval);
$width_param = &Apache::lonxml::get_param('width', $parstack, $safeeval);
} elsif ($target eq 'tex' && defined($bgimg)) {
@@ -159,10 +186,10 @@ sub end_randomlabel {
} elsif ($target eq 'edit') {
$result.=&Apache::edit::end_table;
}
- &Apache::lonplot::clear_callback();
return $result;
}
+
sub start_bgimg {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
@@ -178,24 +205,28 @@ sub end_bgimg {
if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') {
my $bgimg=&Apache::lonxml::endredirection();
if ($target eq 'web') {
- # Try to determine if this is a gnu plot image in which
- # case it's size overrides the web size.
- # If it's a gnuplot the uncleaned image will have
- # the text "dynamically generated plot"
- # and "cgi-bin/plot.gif?"
- if ( $gnuplot_background) {
- &Apache::lonxml::debug("Gnuplot image!");
- my $plot_x = $Apache::lonplot::plot{'width'};
- my $plot_y = $Apache::lonplot::plot{'height'};
- &Apache::lonxml::debug(" H = $plot_y W = $plot_x");
- &Apache::lonxml::debug("PH = $height_param, PW = $width_param");
- $label_xscale = $plot_x/$width_param;
- $label_yscale = $plot_y/$height_param;
+
+ # If the tag produced has sizes, they override ours.
+ # (for now anyway).
+ #
+ &Apache::lonxml::debug("Base sizes: $width_param x $height_param");
+
+ my ($plot_x, $plot_y) = &extract_tag_sizes($bgimg,
+ $width_param,
+ $height_param);
+ &Apache::lonxml::debug("Extracted sizes: $plot_x x $plot_y");
+ if ($width_param) {
+ $label_xscale = $plot_x / $width_param;
}
+ if ($height_param) {
+ $label_yscale = $plot_y / $height_param;
+ }
+ &Apache::lonxml::debug("Scale factors: $label_xscale $label_yscale");
+
&Apache::lonxml::debug("Image: $bgimg");
$bgimg=&Apache::imageresponse::clean_up_image($bgimg);
&Apache::lonxml::debug("Cleaned image: $bgimg");
- $args{"cgi.$cgi_id.BGIMG"}=&Apache::lonnet::escape($bgimg);
+ $args{"cgi.$cgi_id.BGIMG"}=&escape($bgimg);
} elsif ($target eq 'tex') {
# Some bg images can create latex for us... e.g. gnuplot.
# If it looks like we have some latex use that,
@@ -205,28 +236,48 @@ sub end_bgimg {
my $src = $bgimg;
$src =~ s/\s+$//s;
$src =~ s/^\s+//s;
-
- if ($gnuplot_background) {
- $height_param = $Apache::lonplot::plot{'height'};
- my $initial_width= $Apache::lonplot::plot{'width'};
- $width_param = $Apache::lonplot::plot{'texwidth'};
+ #If this is a dynamically generated image, it will
+ #be in latex already, with a comment header that
+ #describes the dimensions:
+
+ if($src =~ /^%DYNAMICIMAGE:/) {
+ $Apache::lonxml::debug = 0;
+ &Apache::lonxml::debug("Dynamic image");
+ my ($commentline, $junk) = split(/\n/, $src);
+ &Apache::lonxml::debug("Comment line was: $commentline");
+ my $trash;
+ my $initial_width;
+ ($trash, $initial_width, $height_param, $width_param) =
+ split(/:/,$commentline);
+ &Apache::lonxml::debug("internal web Width/height: $initial_width $height_param");
+ &Apache::lonxml::debug("Texwitdh: $width_param");
+ if($initial_width == 0) {
+ $initial_width = $width_param;
+ }
+ # strip off the comments since output does not always
+ # preserve \n's:
+ #
+ $src =~ s/$commentline//;
$scale_factor = $width_param / $initial_width;
$height_param = $height_param*$scale_factor;
+
+ $label_xscale = 1.0; # $scale_factor;
+ $label_yscale = 1.0; # $scale_factor;
+
&Apache::lonxml::debug("height $height_param");
&Apache::lonxml::debug("Width $width_param");
-
+ &Apache::lonxml::debug("Scale factors: $label_xscale $label_yscale");
my $dirty_width = $width_param + 5;
$result .= '\parbox{'.$dirty_width.'mm}{';
- $result .= $src."\n";
+ $result .= " $src \n";
$result .= '\setlength{\unitlength}{1mm}'."\n";
$result .= '\begin{picture}('."$height_param,$width_param)";
$result .= "(0,-$height_param)";
$result .= "\n";
+ $Apache::lonxml::debug = 0;
} else {
-
-
$result.=&make_eps_image($bgimg,$parstack,$safeeval,-2);
}
}
@@ -245,10 +296,20 @@ sub make_eps_image {
&Apache::lonxml::debug("Image size: $height_param x $width_param");
my $dirtywidth=$width_param+5;
+ #
+ # Note that lonprintout/prinout will conspire to replace
+ # spaces in paths and names with _'s since spacess cause problems
+ # for latex included filenames. Therefore:
+ #
+ my $safe_path = $path;
+ $safe_path =~ s/ /\_/g;
+ my $safe_file = $file;
+ $safe_file =~ s/ /\_/g;
+
my $result ="\n".'\vspace*{2mm}\noindent'."\n".
'\parbox{'.$dirtywidth.
' mm}{ \noindent \epsfxsize='.$width_param.
- ' mm \epsffile{'.$path.$file.
+ ' mm \epsffile{'.$safe_path.$safe_file.
'}\setlength{\unitlength}{1mm}'."\n".' \begin{picture}('.
$width_param.','.$height_param.')(0,-'.$height_param.')'."\n";
my $magick = Image::Magick->new;
@@ -321,6 +382,21 @@ sub get_label_width {
}
+
+sub get_label_height {
+ my $label = shift;
+ &Apache::lonxml::debug("image label = $label");
+ if (-e $label) {
+ &Apache::lonxml::debug("$label exists");
+ } else {
+ &Apache::lonxml::debug("$label does not exist");
+ }
+ my $magick = Image::Magick->new;
+ $magick->Read($label);
+ my $pixel_height = $magick->Get('height');
+ return $pixel_height * $scale_factor;
+}
+
sub add_vars {
my ($name,$order,$label,$labelorder,$value,$image,$safeeval) = @_;
if (!defined($name) || $name eq '') { return; }
@@ -359,13 +435,13 @@ sub end_labelgroup {
my $i=$Apache::randomlabel::obj_cnt++;
if( $type eq 'text') {
&add_vars($gname,$_,$label,$idx_arr[$_],$value,'',$safeeval);
- $str = join(':',$x,$y,&Apache::lonnet::escape($label));
+ $str = join(':',$x,$y,&escape($label));
$args{"cgi.$cgi_id.OBJTYPE"}.='LABEL:';
} elsif ( $type eq 'image') {
&add_vars($gname,$_,
$Apache::randomlabel::description[$idx_arr[$_]],
$idx_arr[$_],$value,$label,$safeeval);
- $str = join(':',$x,$y,&Apache::lonnet::escape($label));
+ $str = join(':',$x,$y,&escape($label));
$args{"cgi.$cgi_id.OBJTYPE"}.='IMAGE:';
} else {
&Apache::lonxml::error('Unknown type of label :'.$type.':');
@@ -384,17 +460,29 @@ sub end_labelgroup {
&Apache::structuretags::shuffle(\@idx_arr);
&Apache::lonxml::debug("Array is:".$#Apache::randomlabel::label_arr.":");
+ $Apache::lonxml::debug = 0;
for(my $i=0;$i <= $#Apache::randomlabel::label_arr; $i++) {
my $label = "$Apache::randomlabel::label_arr[ $idx_arr[$i] ]";
my $x = $Apache::randomlabel::xcoord[$i];
- # FIXME the 3.5 here is the 'height' of the letter in TeX
- my $y = $Apache::randomlabel::ycoord[$i]-3.5;
+ my $y = $Apache::randomlabel::ycoord[$i];
+ if ( $type eq 'text' ) {
+ # FIXME the 3.5 here is the 'height' of the letter in TeX
+ $y=$y-3.5;
+ }
+ &Apache::lonxml::debug("initially: x= $x y= $y");
my $value = $Apache::randomlabel::value[$i];
#x latex coordinate
my $tcX=($x)*($width_param/$wwidth);
+ &Apache::lonxml::debug("wparam = $width_param wwidth = $wwidth, texx = $tcX");
#y latex coordinate
# my $ratio=($wwidth > 0 ? $wheight/$wwidth : 1 );
my $tcY=$height_param-$y*($height_param/$wheight);
+ if ( $type eq 'image') {
+ my $label_height = &get_label_height($label);
+ $tcY=$tcY-$label_height;
+ }
+
+ &Apache::lonxml::debug("hparam = $height_param wheight = $wheight texy = $tcY");
$tcX=sprintf('%.2f',$tcX);
$tcY=sprintf('%.2f',$tcY);
$result .= '\put('.$tcX.','.$tcY.'){';
@@ -404,7 +492,12 @@ sub end_labelgroup {
} elsif ( $type eq 'image') {
my ($path,$file) = &Apache::londefdef::get_eps_image($label);
my $image_name = $path.$file;
- my $label_width = get_label_width($label);
+ #
+ # Note that spaces in e.. \includegraphics cause problems for Latex
+ # so they get replaced by _'s by lonprintout/printout and us:
+ #
+ $image_name =~ s/ /\_/g;
+ my $label_width = &get_label_width($label);
$result .= '\includegraphics[width='.$label_width.'mm]{'
.$image_name."}}\n";
@@ -415,6 +508,7 @@ sub end_labelgroup {
&Apache::lonxml::error('Unknown type of label :'.$type.':');
}
}
+ $Apache::lonxml::debug =0;
} elsif ($target eq 'edit') {
$result.=&Apache::edit::end_table;
}
@@ -423,6 +517,7 @@ sub end_labelgroup {
# <location x="123" y="456" value="some value"/>
sub start_location {
+ $Apache::lonxml::debug = 0;
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $x= &check_int(&Apache::lonxml::get_param('x',$parstack,$safeeval),50);
my $y= &check_int(&Apache::lonxml::get_param('y',$parstack,$safeeval),50);
@@ -453,6 +548,7 @@ sub start_location {
$result.=&Apache::edit::handle_insert();
}
}
+ $Apache::lonxml::debug = 0;
return $result;
}
@@ -473,7 +569,7 @@ sub start_label {
&Apache::lonxml::startredirection;
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,"$type Label");
- my $text=&Apache::lonxml::get_all_text("/label",$parser);
+ my $text=&Apache::lonxml::get_all_text("/label",$parser,$style);
if ($type eq 'image') {
$result.=&Apache::edit::end_row().
&Apache::edit::start_spanning_row();