Diff for /loncom/homework/randomlabel.pm between versions 1.62 and 1.76

version 1.62, 2004/11/13 19:39:45 version 1.76, 2005/05/31 22:14:32
Line 25 Line 25
 #  #
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # 7/20/2001 Isaac Tsai, initial syntax  
 # 8/10/2001 Isaac Tsai,   
 # 8/30/2001 Isaac Tsai,   
 # SYNTAX:  # SYNTAX:
 # <randomlabel bgimg="URL" width="12" height="45" texwidth="50">  # <randomlabel bgimg="URL" width="12" height="45" texwidth="50">
 #    <labelgroup name="GroupOne" type="image">  #    <labelgroup name="GroupOne" type="image">
Line 62  use strict; Line 59  use strict;
 use Apache::edit;  use Apache::edit;
 use Apache::File();  use Apache::File();
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
   use Image::Magick;
   use Apache::lonplot;
   
 my %args;  my %args;
 my $cgi_id;  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 {  BEGIN {
     &Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label','bgimg'));      &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 {  sub check_int {
     # utility function to do error checking on a integer.      # utility function to do error checking on a integer.
     my ($num,$default) = @_;      my ($num,$default) = @_;
Line 82  sub check_int { Line 92  sub check_int {
     return $num;      return $num;
 }  }
   
   my ($height_param,$width_param);
 sub start_randomlabel {  sub start_randomlabel {
   
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
       $gnuplot_background = 0;
       &Apache::lonplot::register_callback(\&gnuplot_handler);
     my $result='';      my $result='';
     push (@Apache::lonxml::namespace,'randomlabel');      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);      my $bgimg= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval);
     if ( defined($bgimg) && $bgimg !~ /^http:/ ) {      if ( defined($bgimg) && $bgimg !~ /^http:/ ) {
  $bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg);   $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';      $bgimg='/home/httpd/html/adm/lonKaputt/lonlogo_broken.gif';
  }   }
     }      }
Line 98  sub start_randomlabel { Line 115  sub start_randomlabel {
  $cgi_id=&Apache::loncommon::get_cgi_id();   $cgi_id=&Apache::loncommon::get_cgi_id();
  %args=();   %args=();
  $args{"cgi.$cgi_id.BGIMG"}=&Apache::lonnet::escape($bgimg);   $args{"cgi.$cgi_id.BGIMG"}=&Apache::lonnet::escape($bgimg);
     } elsif ($target eq 'tex') {   $height_param = &Apache::lonxml::get_param('height',$parstack, $safeeval);
  my $w= &check_int(&Apache::lonxml::get_param('width',$parstack,$safeeval));   $width_param  = &Apache::lonxml::get_param('width', $parstack, $safeeval);
  my $h= &check_int(&Apache::lonxml::get_param('height',$parstack,$safeeval));      } elsif ($target eq 'tex' && defined($bgimg)) {
  my $texwidth=&adjust_textwidth(&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1));   $result.=&make_eps_image($bgimg,$parstack,$safeeval);
  if (!$texwidth) { $texwidth=90; }  
  $result.=&make_eps_image($bgimg,$texwidth,$h,$w);  
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result.=&Apache::edit::tag_start($target,$token);   $result.=&Apache::edit::tag_start($target,$token);
  $Apache::edit::bgimgsrc=   $Apache::edit::bgimgsrc=
Line 140  sub end_randomlabel { Line 155  sub end_randomlabel {
  &Apache::lonnet::appenv(%args);   &Apache::lonnet::appenv(%args);
     } elsif ($target eq 'tex') {      } elsif ($target eq 'tex') {
  $result='\end{picture}\\\\';   $result='\end{picture}\\\\';
  my $height=&Apache::lonxml::get_param('height',$parstack,$safeeval);   $result.= ' \vskip -'.$height_param.' mm }  \\\\ ';
  my $width=&Apache::lonxml::get_param('width',$parstack,$safeeval);  
  my $texwidth=&adjust_textwidth(&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1));  
         if (!$texwidth) { $texwidth=90; }  
  # what if width is undefined?  
  my $howtoskipback = $texwidth*$height/$width;  
  $result.= ' \vskip -'.$howtoskipback.' mm }  \\\\ ';  
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result.=&Apache::edit::end_table;   $result.=&Apache::edit::end_table;
     }      }
       &Apache::lonplot::clear_callback();
     return $result;      return $result;
 }  }
   
Line 157  sub start_bgimg { Line 167  sub start_bgimg {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') {       if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') { 
  &Apache::lonxml::startredirection;    &Apache::lonxml::startredirection(); 
     }      }
     return $result;      return $result;
 }  }
Line 166  sub end_bgimg { Line 176  sub end_bgimg {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') {       if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') { 
  my $bgimg=&Apache::lonxml::endredirection;    my $bgimg=&Apache::lonxml::endredirection(); 
  if ($target eq 'web') {   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);      $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"}=&Apache::lonnet::escape($bgimg);
  } elsif ($target eq 'tex') {   } elsif ($target eq 'tex') {
     my $w=&check_int(&Apache::lonxml::get_param('width',$parstack,$safeeval,-2));      #   Some bg images can create latex for us... e.g. gnuplot.
     my $h=&check_int(&Apache::lonxml::get_param('height',$parstack,$safeeval,-2));      #   If it looks like we have some latex use that, 
     my $texwidth=&adjust_textwidth(&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,-2));      #   otherwise, assume this is a resource name that must
     if (!$texwidth) { $texwidth=90; }      #   be converted into the latex to create an eps insertion.
     $result.=&make_eps_image($bgimg,$texwidth,$h,$w);      #
  }      my $src = $bgimg;
     }      $src =~ s/\s+$//s;
     return $result;      $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";
   
 sub make_eps_image {      } else {
     my ($bgimg,$texwidth,$h,$w)=@_;  
     my $newbgimg = $bgimg;  
     $bgimg=~s/\.(gif|jpg|png|jpeg)$/\.eps/i;   $result.=&make_eps_image($bgimg,$parstack,$safeeval,-2);
     $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=~s|/home/httpd/html/res|/home/httpd/prtspool|;  
  $bgimg=~s|/home/([^/]*)/public_html/|/home/httpd/prtspool/$1/|;  
     }      }
  }   }
     }      }
     $bgimg=~s|/$||;  
     my $dirtywidth=$texwidth+5;  
     my $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.')';  
     return $result;      return $result;
 }  }
   sub make_eps_image {
 sub adjust_textwidth {      my ($bgimg,$parstack,$safeeval,$depth)=@_;
     my $texwidth=shift;       &Apache::lonxml::debug("image prior to get_eps_image: $bgimg");
     my $pagewidth=$ENV{'form.textwidth'};      my ($path,$file) = &Apache::londefdef::get_eps_image($bgimg);
     $pagewidth=~s/\s*mm\s*$//;      &Apache::lonxml::debug("image after:  $bgimg");
     if ($texwidth>$pagewidth) {$texwidth=$pagewidth;}      ($height_param,$width_param)=
     return $texwidth;   &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 {  sub start_labelgroup {
Line 242  sub start_labelgroup { Line 276  sub start_labelgroup {
  @Apache::randomlabel::ycoord = ();   @Apache::randomlabel::ycoord = ();
  @Apache::randomlabel::value = ();   @Apache::randomlabel::value = ();
  @Apache::randomlabel::label_arr  = ();   @Apache::randomlabel::label_arr  = ();
  @Apache::randomlabel::decription  = ();   @Apache::randomlabel::description  = ();
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result.=&Apache::edit::tag_start($target,$token);   $result.=&Apache::edit::tag_start($target,$token);
  $result.=&Apache::edit::text_arg('Name:','name',$token).   $result.=&Apache::edit::text_arg('Name:','name',$token).
     &Apache::edit::select_arg('Type:','type',['text','image'],$token).      &Apache::edit::select_arg('Type:','type',['text','image'],$token);
     &Apache::edit::end_row().&Apache::edit::start_spanning_row();   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') {      } elsif ($target eq 'modified') {
  my $constructtag=&Apache::edit::get_new_args($token,$parstack,   my $constructtag=&Apache::edit::get_new_args($token,$parstack,
      $safeeval,'name','type');       $safeeval,'name','type',
        'TeXsize');
  if ($constructtag) {   if ($constructtag) {
     $result = &Apache::edit::rebuild_tag($token);      $result = &Apache::edit::rebuild_tag($token);
     $result.=&Apache::edit::handle_insert();      $result.=&Apache::edit::handle_insert();
Line 259  sub start_labelgroup { Line 303  sub start_labelgroup {
     return $result;      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 {  sub add_vars {
     my ($name,$order,$label,$labelorder,$value,$image,$safeeval) = @_;      my ($name,$order,$label,$labelorder,$value,$image,$safeeval) = @_;
     if (!defined($name) || $name eq '') { return; }      if (!defined($name) || $name eq '') { return; }
Line 315  sub end_labelgroup { Line 377  sub end_labelgroup {
  my $WY1=0; #  Web y-coord. of (ULC)   my $WY1=0; #  Web y-coord. of (ULC)
  my $wwidth=&Apache::lonxml::get_param('width',$parstack,$safeeval,-2);   my $wwidth=&Apache::lonxml::get_param('width',$parstack,$safeeval,-2);
  my $wheight=&Apache::lonxml::get_param('height',$parstack,$safeeval,-2);   my $wheight=&Apache::lonxml::get_param('height',$parstack,$safeeval,-2);
  my $texwidth=&adjust_textwidth(&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,-2,1));   my $TeXsize=&Apache::lonxml::get_param('TeXsize',$parstack,$safeeval);
  if (!$texwidth) { $texwidth=90; }   if (!defined($TeXsize)) { $TeXsize='\\normalsize'; }
  my $texheight=$texwidth*($wheight/$wwidth);  
   
  my @idx_arr = (0 .. $#Apache::randomlabel::label_arr);   my @idx_arr = (0 .. $#Apache::randomlabel::label_arr);
  &Apache::structuretags::shuffle(\@idx_arr);   &Apache::structuretags::shuffle(\@idx_arr);
Line 330  sub end_labelgroup { Line 391  sub end_labelgroup {
     my $y = $Apache::randomlabel::ycoord[$i]-3.5;      my $y = $Apache::randomlabel::ycoord[$i]-3.5;
     my $value = $Apache::randomlabel::value[$i];      my $value = $Apache::randomlabel::value[$i];
     #x latex coordinate      #x latex coordinate
     my $tcX=($x)*($texwidth/$wwidth);      my $tcX=($x)*($width_param/$wwidth);
     #y latex coordinate      #y latex coordinate
             #      my $ratio=($wwidth > 0 ? $wheight/$wwidth : 1 );              #      my $ratio=($wwidth > 0 ? $wheight/$wwidth : 1 );
     my $tcY=$texheight-$y*($texheight/$wheight);      my $tcY=$height_param-$y*($height_param/$wheight);
     $tcX=sprintf('%.2f',$tcX);      $tcX=sprintf('%.2f',$tcX);
     $tcY=sprintf('%.2f',$tcY);      $tcY=sprintf('%.2f',$tcY);
     $result.='\put('.$tcX.','.$tcY.'){\normalsize \bf '.$label.'}'."\n";      $result .= '\put('.$tcX.','.$tcY.'){';
     if( $type eq 'text') {      if( $type eq 'text') {
    $result.= $TeXsize.' \bf '.$label."}\n";
  &add_vars($gname,$i,$label,$idx_arr[$i],$value,'',$safeeval);   &add_vars($gname,$i,$label,$idx_arr[$i],$value,'',$safeeval);
     } elsif ( $type eq 'image') {      } 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,   &add_vars($gname,$i,
   $Apache::randomlabel::description[$idx_arr[$i]],    $Apache::randomlabel::description[$idx_arr[$i]],
   $idx_arr[$i],$value,$label,$safeeval);    $idx_arr[$i],$value,$label,$safeeval);
Line 358  sub start_location { Line 426  sub start_location {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $x= &check_int(&Apache::lonxml::get_param('x',$parstack,$safeeval),50);      my $x= &check_int(&Apache::lonxml::get_param('x',$parstack,$safeeval),50);
     my $y= &check_int(&Apache::lonxml::get_param('y',$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 $value= &Apache::lonxml::get_param('value',$parstack,$safeeval);
     my $result='';      my $result='';
     push(@Apache::randomlabel::xcoord,$x);      push(@Apache::randomlabel::xcoord,$x);
Line 437  sub end_label { Line 511  sub end_label {
  my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval,-2);   my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval,-2);
  my $ltext=&Apache::lonxml::endredirection;    my $ltext=&Apache::lonxml::endredirection; 
  if ($type eq 'image') {   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]");      &Apache::lonxml::debug("Turning $ltext, $Apache::lonxml::pwd[-1]");
     $ltext=&Apache::imageresponse::clean_up_image($ltext);      $ltext=&Apache::imageresponse::clean_up_image($ltext);
 #    $ltext=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],  #    $ltext=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],

Removed from v.1.62  
changed lines
  Added in v.1.76


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