--- loncom/homework/randomlabel.pm 2005/04/12 09:56:07 1.69 +++ loncom/homework/randomlabel.pm 2005/05/31 22:14:32 1.76 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # random labelling tool # -# $Id: randomlabel.pm,v 1.69 2005/04/12 09:56:07 foxr Exp $ +# $Id: randomlabel.pm,v 1.76 2005/05/31 22:14:32 foxr Exp $ # # Copyright Michigan State University Board of Trustees # @@ -59,14 +59,27 @@ use strict; use Apache::edit; use Apache::File(); use Apache::Constants qw(:common :http); +use Image::Magick; +use Apache::lonplot; 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 tag is encountered: +# +sub gnuplot_handler { + $gnuplot_background = 1; +} + sub check_int { # utility function to do error checking on a integer. my ($num,$default) = @_; @@ -81,10 +94,15 @@ sub check_int { 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); + $label_xscale = 1.0; # Assume image size not overridden. + $label_yscale = 1.0; my $bgimg= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval); if ( defined($bgimg) && $bgimg !~ /^http:/ ) { $bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg); @@ -97,6 +115,8 @@ sub start_randomlabel { $cgi_id=&Apache::loncommon::get_cgi_id(); %args=(); $args{"cgi.$cgi_id.BGIMG"}=&Apache::lonnet::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)) { $result.=&make_eps_image($bgimg,$parstack,$safeeval); } elsif ($target eq 'edit') { @@ -139,6 +159,7 @@ sub end_randomlabel { } elsif ($target eq 'edit') { $result.=&Apache::edit::end_table; } + &Apache::lonplot::clear_callback(); return $result; } @@ -157,21 +178,72 @@ 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; + } + &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); } elsif ($target eq 'tex') { - $result.=&make_eps_image($bgimg,$parstack,$safeeval,-2); + # Some bg images can create latex for us... e.g. gnuplot. + # If it looks like we have some latex use that, + # otherwise, assume this is a resource name that must + # be converted into the latex to create an eps insertion. + # + 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'}; + $scale_factor = $width_param / $initial_width; + $height_param = $height_param*$scale_factor; + &Apache::lonxml::debug("height $height_param"); + &Apache::lonxml::debug("Width $width_param"); + + my $dirty_width = $width_param + 5; + $result .= '\parbox{'.$dirty_width.'mm}{'; + $result .= $src."\n"; + $result .= '\setlength{\unitlength}{1mm}'."\n"; + $result .= '\begin{picture}('."$height_param,$width_param)"; + $result .= "(0,-$height_param)"; + $result .= "\n"; + + } else { + + + $result.=&make_eps_image($bgimg,$parstack,$safeeval,-2); + } } } return $result; } - sub make_eps_image { my ($bgimg,$parstack,$safeeval,$depth)=@_; + &Apache::lonxml::debug("image prior to get_eps_image: $bgimg"); my ($path,$file) = &Apache::londefdef::get_eps_image($bgimg); + &Apache::lonxml::debug("image after: $bgimg"); ($height_param,$width_param)= &Apache::londefdef::image_size($bgimg,0.3,$parstack,$safeeval, $depth,1); + + &Apache::lonxml::debug("Image size: $height_param x $width_param"); + my $dirtywidth=$width_param+5; my $result ="\n".'\vspace*{2mm}\noindent'."\n". '\parbox{'.$dirtywidth. @@ -179,6 +251,11 @@ sub make_eps_image { ' mm \epsffile{'.$path.$file. '}\setlength{\unitlength}{1mm}'."\n".' \begin{picture}('. $width_param.','.$height_param.')(0,-'.$height_param.')'."\n"; + my $magick = Image::Magick->new; + $magick->Read($bgimg); + my $initial_width = $magick->Get('width'); + &Apache::lonxml::debug("ImageMagick thinks width is; $initial_width"); + $scale_factor = $width_param / $initial_width; return $result; } @@ -226,6 +303,24 @@ sub start_labelgroup { return $result; } +# +# Utility sub to compute the width of a label. +# +sub get_label_width { + 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_width = $magick->Get('width'); + return $pixel_width * $scale_factor; + + +} sub add_vars { my ($name,$order,$label,$labelorder,$value,$image,$safeeval) = @_; if (!defined($name) || $name eq '') { return; } @@ -302,10 +397,17 @@ sub end_labelgroup { my $tcY=$height_param-$y*($height_param/$wheight); $tcX=sprintf('%.2f',$tcX); $tcY=sprintf('%.2f',$tcY); - $result.='\put('.$tcX.','.$tcY.'){'.$TeXsize.' \bf '.$label.'}'."\n"; + $result .= '\put('.$tcX.','.$tcY.'){'; if( $type eq 'text') { + $result.= $TeXsize.' \bf '.$label."}\n"; &add_vars($gname,$i,$label,$idx_arr[$i],$value,'',$safeeval); } 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); + + $result .= '\includegraphics[width='.$label_width.'mm]{' + .$image_name."}}\n"; &add_vars($gname,$i, $Apache::randomlabel::description[$idx_arr[$i]], $idx_arr[$i],$value,$label,$safeeval); @@ -324,6 +426,12 @@ sub start_location { 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); + &Apache::lonxml::debug("x = $x y = $y"); + $x = $x*$label_xscale; + $y = $y*$label_yscale; + &Apache::lonxml::debug(" H = $height_param W = $width_param"); + &Apache::lonxml::debug(" XS = $label_xscale YS = $label_yscale"); + &Apache::lonxml::debug(" X = $x Y = $y"); my $value= &Apache::lonxml::get_param('value',$parstack,$safeeval); my $result=''; push(@Apache::randomlabel::xcoord,$x); @@ -403,13 +511,17 @@ sub end_label { my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval,-2); my $ltext=&Apache::lonxml::endredirection; if ($type eq 'image') { - &Apache::lonxml::debug("Turning $ltext, $Apache::lonxml::pwd[-1]"); - $ltext=&Apache::imageresponse::clean_up_image($ltext); - # In .tex output mode, at least _ has to be replaced with - # \_ if ($target eq 'tex') { - $ltext =~ s/\_/\\\_/g; + # For tex targets, our image url has been potentially corrupted + # by prepending \'s in front of special latex symbols. + # For now we only worry about the _ case (most common?) + # There's a whole host of theim in lonxml::latex_special_symbols + # that could potentially have to be re-done. + + $ltext =~ s/\\_/_/g; } + &Apache::lonxml::debug("Turning $ltext, $Apache::lonxml::pwd[-1]"); + $ltext=&Apache::imageresponse::clean_up_image($ltext); # $ltext=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1], # $ltext); &Apache::lonxml::debug("into $ltext");