--- loncom/homework/randomlabel.pm 2003/09/23 21:20:42 1.49
+++ loncom/homework/randomlabel.pm 2005/05/24 10:10:16 1.75
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# random labelling tool
#
-# $Id: randomlabel.pm,v 1.49 2003/09/23 21:20:42 albertel Exp $
+# $Id: randomlabel.pm,v 1.75 2005/05/24 10:10:16 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,9 +25,6 @@
#
# http://www.lon-capa.org/
#
-# 7/20/2001 Isaac Tsai, initial syntax
-# 8/10/2001 Isaac Tsai,
-# 8/30/2001 Isaac Tsai,
# SYNTAX:
# <randomlabel bgimg="URL" width="12" height="45" texwidth="50">
# <labelgroup name="GroupOne" type="image">
@@ -62,9 +59,16 @@ 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;
BEGIN {
- &Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label'));
+ &Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label','bgimg'));
}
sub check_int {
@@ -79,61 +83,30 @@ sub check_int {
return $num;
}
+my ($height_param,$width_param);
sub start_randomlabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
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 ( $bgimg !~ /^http:/ ) {
+ if ( defined($bgimg) && $bgimg !~ /^http:/ ) {
$bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg);
- if (&Apache::lonnet::repcopy($bgimg) ne OK) {
+ if (&Apache::lonnet::repcopy($bgimg) ne 'ok') {
$bgimg='/home/httpd/html/adm/lonKaputt/lonlogo_broken.gif';
}
}
- my $w= &check_int(&Apache::lonxml::get_param('width',$parstack,$safeeval));
- my $h= &check_int(&Apache::lonxml::get_param('height',$parstack,$safeeval));
- my $texwidth= &Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1);
- if (!$texwidth) { $texwidth=90; }
- $Apache::randomlabel::tlabel_cnt=0;
- $Apache::randomlabel::ilabel_cnt=0;
+ $Apache::randomlabel::obj_cnt=0;
if ($target eq 'web') {
- &Apache::lonxml::startredirection();
- $result.="BGIMG=".&Apache::lonnet::escape($bgimg);
- } elsif ($target eq 'tex') {
- my $newbgimg = $bgimg;
- $bgimg=~s/\.(gif|jpg|png|jpeg)$/\.eps/i;
- $bgimg= &Apache::lonnet::filelocation($bgimg);
- $bgimg=~s/http:\/[^\/]*/\/home\/httpd\/html/;
- $bgimg=~s/\/$//;
- #if no eps file try to replicate it
- if (not-e $bgimg) {
- if (&Apache::lonnet::repcopy($bgimg) ne OK ) {
- #if replication failed try to find ps file
- $bgimg=~s/\.eps$/\.ps/;
- #if no ps file try to replicate it
- if (not -e $bgimg &&
- &Apache::lonnet::repcopy($bgimg) ne OK) {
- #if replication failed try to produce eps file dynamically
- $bgimg=~s/\.ps$/\.eps/;
- my $temp_file;
- my $filename = "/home/httpd/prtspool/$ENV{'user.name'}_$ENV{'user.domain'}_printout.dat";
- $temp_file = Apache::File->new('>>'.$filename);
- $newbgimg =~ s/(.*)\/res\//\/home\/httpd\/html\/res\//;
- print $temp_file "$newbgimg\n";
- $bgimg =~ m/\/([^\/]+)$/;
- $bgimg = '/home/httpd/prtspool/'.$1;
- }
- }
- }
- $bgimg=~s/\/$//;
- my $dirtywidth=$texwidth+5;
- if ($texwidth==90) {
- $result.='\vspace*{2mm}\noindent \parbox{'.$dirtywidth.' mm}{ \noindent \epsfxsize='.$texwidth.' mm \epsffile{'.
- $bgimg.'}\setlength{\unitlength}{1mm} \begin{picture}('.$texwidth.','.$texwidth*$h/$w.')(0,-'.$texwidth*$h/$w.')';
- } else {
- $result.='\vspace*{2mm}\noindent \parbox{'.$dirtywidth.' mm}{ \noindent \epsfxsize='.$texwidth.' mm \epsffile{'.
- $bgimg.'}\setlength{\unitlength}{1mm} \begin{picture}('.$texwidth.','.$texwidth*$h/$w.')(0,-'.$texwidth*$h/$w.')';
- }
+ $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') {
$result.=&Apache::edit::tag_start($target,$token);
$Apache::edit::bgimgsrc=
@@ -164,31 +137,116 @@ sub end_randomlabel {
my $count;
pop @Apache::lonxml::namespace;
if ($target eq 'web') {
- my $args=&Apache::lonxml::endredirection();
- $args=~s/\s*&/&/g;
- $args=~s/\s*$//;
- $count = $Apache::randomlabel::tlabel_cnt;
- if( $count != 0) { $args.= "&COUNT=$count"; }
- $count = $Apache::randomlabel::ilabel_cnt;
- if( $count != 0) { $args.= "&ICOUNT=$count"; }
- my $token=$Apache::lonxml::curdepth.'_'.$$;
- $result.='<img src="/adm/randomlabel.png?token='.$token;
- $result.='" /><br />'."\n";
- &Apache::lonnet::appenv(("imagerequest.$token"=>&Apache::lonnet::escape($args)));
+ $count = $Apache::randomlabel::obj_cnt;
+ if( $count != 0) { $args{"cgi.$cgi_id.OBJCOUNT"}=$count; }
+ $result.='<img src="/adm/randomlabel.png?token='.$cgi_id.'" /><br />'."\n";
+ &Apache::lonnet::appenv(%args);
} elsif ($target eq 'tex') {
$result='\end{picture}\\\\';
- my $height=&Apache::lonxml::get_param('height',$parstack,$safeeval);
- my $width=&Apache::lonxml::get_param('width',$parstack,$safeeval);
- my $texwidth=&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1);
- if (!$texwidth) { $texwidth=90; }
- my $howtoskipback = $texwidth*$height/$width;
- $result.= ' \vskip -'.$howtoskipback.' mm } \\\\ ';
+ $result.= ' \vskip -'.$height_param.' mm } \\\\ ';
} elsif ($target eq 'edit') {
$result.=&Apache::edit::end_table;
}
return $result;
}
+sub start_bgimg {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result='';
+ if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') {
+ &Apache::lonxml::startredirection();
+ }
+ return $result;
+}
+
+sub end_bgimg {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result='';
+ 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 ( ($bgimg =~ /dynamically generated plot/) &&
+ ($bgimg =~ /cgi-bin\/plot.gif\?/) ) {
+ &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') {
+ # 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 ($src =~ /^\\graphicspath/) {
+ $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.
+ ' mm}{ \noindent \epsfxsize='.$width_param.
+ ' 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;
+}
+
sub start_labelgroup {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
@@ -206,15 +264,25 @@ sub start_labelgroup {
@Apache::randomlabel::ycoord = ();
@Apache::randomlabel::value = ();
@Apache::randomlabel::label_arr = ();
- @Apache::randomlabel::decription = ();
+ @Apache::randomlabel::description = ();
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token);
$result.=&Apache::edit::text_arg('Name:','name',$token).
- &Apache::edit::select_arg('Type:','type',['text','image'],$token).
- &Apache::edit::end_row().&Apache::edit::start_spanning_row();
+ &Apache::edit::select_arg('Type:','type',['text','image'],$token);
+ if (!defined($token->[2]{'TeXsize'})) {
+ $token->[2]{'TeXsize'}='\normalsize';
+ }
+ $result.=&Apache::edit::select_arg('TeX font size:','TeXsize',
+ ['\tiny','\scriptsize',
+ '\footnotesize','\small',
+ '\normalsize','\large','\Large',
+ '\LARGE','\huge','\Huge'],
+ $token);
+ $result.=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args($token,$parstack,
- $safeeval,'name','type');
+ $safeeval,'name','type',
+ 'TeXsize');
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
$result.=&Apache::edit::handle_insert();
@@ -223,8 +291,27 @@ 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; }
my $code = '${'.$name."}{'".($order+1)."'}='".$label."';";
my $out=Apache::run::run($code,$safeeval);
if ($value) {
@@ -253,53 +340,34 @@ sub end_labelgroup {
&Apache::structuretags::shuffle(\@idx_arr);
for(0 .. $#Apache::randomlabel::label_arr) {
my $str;
- my $xstr;
- my $ystr;
my $label = "$Apache::randomlabel::label_arr[ $idx_arr[$_] ]";
my $x = $Apache::randomlabel::xcoord[$_];
my $y = $Apache::randomlabel::ycoord[$_];
my $value = $Apache::randomlabel::value[$_];
+ my $i=$Apache::randomlabel::obj_cnt++;
if( $type eq 'text') {
&add_vars($gname,$_,$label,$idx_arr[$_],$value,'',$safeeval);
- $str = 'LB'.$Apache::randomlabel::tlabel_cnt;
- $xstr = 'X'.$Apache::randomlabel::tlabel_cnt;
- $ystr = 'Y'.$Apache::randomlabel::tlabel_cnt;
- $Apache::randomlabel::tlabel_cnt += 1;
+ $str = join(':',$x,$y,&Apache::lonnet::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 = 'IMG'.$Apache::randomlabel::ilabel_cnt;
- $xstr = 'IX'.$Apache::randomlabel::ilabel_cnt;
- $ystr = 'IY'.$Apache::randomlabel::ilabel_cnt;
- $Apache::randomlabel::ilabel_cnt += 1;
+ $str = join(':',$x,$y,&Apache::lonnet::escape($label));
+ $args{"cgi.$cgi_id.OBJTYPE"}.='IMAGE:';
} else {
&Apache::lonxml::error('Unknown type of label :'.$type.':');
}
- if ($target eq 'web') {
- $result .= '&'. $str .'='.&Apache::lonnet::escape($label);
- $result .= '&'. $xstr .'='.$x;
- $result .= '&'. $ystr .'='.$y;
- }
+ if ($target eq 'web') { $args{"cgi.$cgi_id.OBJ$i"} =$str; }
}
} elsif ($target eq 'tex') {
my $WX1=0; # Web x-coord. of upper left corner (ULC)
my $WY1=0; # Web y-coord. of (ULC)
my $wwidth=&Apache::lonxml::get_param('width',$parstack,$safeeval,-2);
my $wheight=&Apache::lonxml::get_param('height',$parstack,$safeeval,-2);
- my $texwidth=&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,-2,1);
- if (!$texwidth) { $texwidth=90; }
- my $TX1=0;
- my $TY1=$texwidth*($wheight/$wwidth);
- my $TX2=$texwidth;
- my $TY2=0;
-
-
- my $slopex=($wwidth-$WX1)/($TX2-$TX1);
- my $slopey=($wheight-$WY1)/($TY2-($TY1-1.0));
- my $cstx=$wwidth-$slopex*($TX2);
- my $csty=$wheight-$slopey*($TY2);
-
+ my $TeXsize=&Apache::lonxml::get_param('TeXsize',$parstack,$safeeval);
+ if (!defined($TeXsize)) { $TeXsize='\\normalsize'; }
+
my @idx_arr = (0 .. $#Apache::randomlabel::label_arr);
&Apache::structuretags::shuffle(\@idx_arr);
@@ -307,19 +375,27 @@ sub end_labelgroup {
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];
- my $y = $Apache::randomlabel::ycoord[$i];
+ # FIXME the 3.5 here is the 'height' of the letter in TeX
+ my $y = $Apache::randomlabel::ycoord[$i]-3.5;
my $value = $Apache::randomlabel::value[$i];
#x latex coordinate
- my $tcX=($x)*($texwidth/$wwidth);
+ my $tcX=($x)*($width_param/$wwidth);
#y latex coordinate
# my $ratio=($wwidth > 0 ? $wheight/$wwidth : 1 );
- my $tcY=$TY1-$y*($TY1/$wheight);
+ my $tcY=$height_param-$y*($height_param/$wheight);
$tcX=sprintf('%.2f',$tcX);
$tcY=sprintf('%.2f',$tcY);
- $result.='\put('.$tcX.','.$tcY.'){\normalsize \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);
@@ -338,6 +414,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);
@@ -376,18 +458,7 @@ sub start_label {
my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval,-2);
if ($target eq 'web' || $target eq 'tex' ||
$target eq 'grade' || $target eq 'answer' || $target eq 'analyze') {
- my $ltext=&Apache::lonxml::get_all_text("/label",$parser);
- $ltext=&Apache::run::evaluate($ltext,$safeeval,$$parstack[-1]);
- if ($type eq 'image') {
- &Apache::lonxml::debug("Turning $ltext, $Apache::lonxml::pwd[-1]");
- $ltext=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],
- $ltext);
- &Apache::lonxml::debug("into $ltext");
- my $description = &Apache::lonxml::get_param('description',
- $parstack,$safeeval);
- push(@Apache::randomlabel::description,$description);
- }
- push(@Apache::randomlabel::label_arr,$ltext);
+ &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);
@@ -402,7 +473,6 @@ sub start_label {
$result.=&Apache::edit::editline('',$text,'',50).
&Apache::edit::end_table();
} elsif ($target eq 'modified') {
- my $text=$$parser[-1]->get_text("/label");
$result = '<label>';
if ($type eq 'image') {
my $constructtag=&Apache::edit::get_new_args($token,$parstack,
@@ -414,7 +484,7 @@ sub start_label {
$result = $token->[4];
}
}
- $result.=&Apache::edit::modifiedfield($token);
+ $result.=&Apache::edit::modifiedfield("/label",$parser);
}
return $result;
}
@@ -422,7 +492,35 @@ sub start_label {
sub end_label {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my @result;
- if ($target eq 'edit') { @result=('','no') }
+ if ($target eq 'edit') {
+ @result=('','no') ;
+ } elsif ($target eq 'web' || $target eq 'tex' || $target eq 'grade' ||
+ $target eq 'answer' || $target eq 'analyze') {
+ my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval,-2);
+ my $ltext=&Apache::lonxml::endredirection;
+ if ($type eq 'image') {
+ if ($target eq 'tex') {
+ # 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");
+ my $description = &Apache::lonxml::get_param('description',
+ $parstack,$safeeval);
+ push(@Apache::randomlabel::description,$description);
+ } else {
+ $ltext=~s/[\r\n]*//gs
+ }
+ push(@Apache::randomlabel::label_arr,$ltext);
+ }
return @result;
}