Return to randomlabel.pm CVS log

Up to [LON-CAPA] / loncom / homework

Bug 2287 (automatic eps generation needs to preserves paths) is corrected for randomlabel problems. The only issue remains - how to individualize the name of eps file. It is neccessary if more then one student is trying to print the same problem at the same time and this problem contains different pictures with the same generic name. But may be this is impossible situation.

# The LearningOnline Network with CAPA
# random labelling tool
#
# $Id: randomlabel.pm,v 1.51 2003/10/16 19:23:58 sakharuk 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/
#
# 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">
#      <location x="123" y="456" />
#      <location x="321" y="654" />
#      <location x="213" y="546" />
#      <label description="TEXT-1">IMG-URL</label>
#      <label description="TEXT-2">IMG-URL</label>
#      <label description="TEXT-3">IMG-URL</label>
#    </labelgroup>
#    <labelgroup name="GroupTwo" type="text">
#      <location x="12" y="45" />
#      <location x="32" y="65" />
#      <location x="21" y="54" />
#      <label>TEXT-1</label>
#      <label>TEXT-2</label>
#      <label>TEXT-3</label>
#    </labelgroup>
#   </randomlabel>
#  ===========================================
#  side effect:
#    location (123,456): $GroupOne[0] = 2  # images give out indexes
#             (321,654): $GroupOne[1] = 1
#             (213,546): $GroupOne[2] = 0
#    location (12,45)  : $GroupTwo[0] = "TEXT-3"
#             (32,65)  : $GroupTwo[1] = "TEXT-1"
#             (21,54)  : $GroupTwo[2] = "TEXT-2"
#  ===========================================
package Apache::randomlabel;
use Apache::lonnet;
use strict;
use Apache::edit;
use Apache::File();
use Apache::Constants qw(:common :http);

BEGIN {
    &Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label'));
}

sub check_int {
    # utility function to do error checking on a integer.
    my ($num,$default) = @_;
    $default = 100 if (! defined($default));
    $num =~ s/\s+//g;  # We dont need no stinkin white space!
    # If it is a real, just grab the integer part.
    ($num,undef) = split (/\./,$num) if ($num =~ /\./); 
    # set to default if what we have left doesn't match anything...
    $num = $default unless ($num =~/^\d+$/);
    return $num;
}

sub start_randomlabel {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result='';
    push (@Apache::lonxml::namespace,'randomlabel');
    my $bgimg= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval);
    if ( $bgimg !~ /^http:/ ) {
	$bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg);
	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=&adjust_textwidth(&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1));
    if (!$texwidth) { $texwidth=90; }
    $Apache::randomlabel::tlabel_cnt=0;
    $Apache::randomlabel::ilabel_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=~s/\/home\/httpd\/html\/res/\/home\/httpd\/prtspool/;		}
	    }
	}
	$bgimg=~s/\/$//;
	my $dirtywidth=$texwidth+5;
	$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.')';
    } elsif ($target eq 'edit') {
	$result.=&Apache::edit::tag_start($target,$token);
	$Apache::edit::bgimgsrc=
	    &Apache::lonxml::get_param('bgimg',$parstack,$safeeval);
	$Apache::edit::bgimgsrccurdepth=$Apache::lonxml::curdepth;
	$result.=&Apache::edit::text_arg('Image:','bgimg',$token,75).' ';
	$result.=&Apache::edit::browse('bgimg').' ';
	$result.=&Apache::edit::search('bgimg').'<br />'.
	    &Apache::edit::text_arg('Width(pixel):' ,'width'   ,$token,6).
	    &Apache::edit::text_arg('Height(pixel):','height'  ,$token,6).
	    &Apache::edit::text_arg('TeXWidth(mm):' ,'texwidth',$token,6).
	    &Apache::edit::end_row().&Apache::edit::start_spanning_row();     
    } elsif ($target eq 'modified') {
	my $constructtag=&Apache::edit::get_new_args($token,$parstack,
						     $safeeval,'bgimg','width',
						     'height','texwidth');
	if ($constructtag) {
	    $result = &Apache::edit::rebuild_tag($token);
	    $result.=&Apache::edit::handle_insert();
	}
    }
    return $result;
}

sub end_randomlabel {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result='';
    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)));
    } 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=&adjust_textwidth(&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1));
        if (!$texwidth) { $texwidth=90; }
	my $howtoskipback = $texwidth*$height/$width;
	$result.= ' \vskip -'.$howtoskipback.' mm }  \\\\ ';
    } elsif ($target eq 'edit') {
	$result.=&Apache::edit::end_table;
    }
    return $result;
}

sub adjust_textwidth {
    my $texwidth=shift; 
    my $pagewidth=$ENV{'form.textwidth'};
    $pagewidth=~s/\s*mm\s*$//;
    if ($texwidth>$pagewidth) {$texwidth=$pagewidth;}
    return $texwidth;
}

sub start_labelgroup {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result='';
    my $name = &Apache::lonxml::get_param('name',$parstack,$safeeval);
    my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval);
    $type =~tr/A-Z/a-z/;
    if ($target ne 'modified' && ($name =~ /\W/ || $name =~ /^[0-9]/)) {
	&Apache::lonxml::error("Only _ a-z A-Z and 0-9 are allowed in the name to a labelgroup, and the first character can not be a number.<br />");
    }
    if ($target eq 'web' || $target eq 'tex' ||
	$target eq 'grade' || $target eq 'answer' || $target eq 'analyze') {
	$Apache::randomlabel::groupname=$name;
	$Apache::randomlabel::type=$type;
	@Apache::randomlabel::xcoord = ();
	@Apache::randomlabel::ycoord = ();
	@Apache::randomlabel::value = ();
	@Apache::randomlabel::label_arr  = ();
	@Apache::randomlabel::decription  = ();
    } 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();
    } elsif ($target eq 'modified') {
	my $constructtag=&Apache::edit::get_new_args($token,$parstack,
						     $safeeval,'name','type');
	if ($constructtag) {
	    $result = &Apache::edit::rebuild_tag($token);
	    $result.=&Apache::edit::handle_insert();
	}
    }
    return $result;
}

sub add_vars {
    my ($name,$order,$label,$labelorder,$value,$image,$safeeval) = @_;
    my $code = '${'.$name."}{'".($order+1)."'}='".$label."';";
    my $out=Apache::run::run($code,$safeeval);
    if ($value) {
	$code = '${'.$name."}{'value_".($order+1)."'}='".$value."';";
	$out=Apache::run::run($code,$safeeval);
	$code = '${'.$name."}{'labelvalue_".($labelorder+1)."'}='".$value."';";
	$out=Apache::run::run($code,$safeeval);
    }
    if ($image) {
	my $code = '${'.$name."}{'image_".($order+1)."'}='".$image."';";
	my $out=Apache::run::run($code,$safeeval);
    }
    $code = '${'.$name."}{'numlocations'}='".($order+1)."';";
    $out=Apache::run::run($code,$safeeval);
}

# begin to assign labels to locations
sub end_labelgroup {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $gname = $Apache::randomlabel::groupname;
    my $type  = $Apache::randomlabel::type;
    my $result='';
    if ($target eq 'web' || $target eq 'answer' || $target eq 'grade' ||
	$target eq 'analyze') {
	my @idx_arr = (0 .. $#Apache::randomlabel::label_arr);
	&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[$_];
	    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;
	    } 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;
	    } 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;
	    }
	}
    } 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=&adjust_textwidth(&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 @idx_arr = (0 .. $#Apache::randomlabel::label_arr);
	&Apache::structuretags::shuffle(\@idx_arr);

	&Apache::lonxml::debug("Array is:".$#Apache::randomlabel::label_arr.":");
	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];
	    my $value = $Apache::randomlabel::value[$i];
	    #x latex coordinate
	    my $tcX=($x)*($texwidth/$wwidth);
	    #y latex coordinate
            #      my $ratio=($wwidth > 0 ? $wheight/$wwidth : 1 );
	    my $tcY=$TY1-$y*($TY1/$wheight);
	    $tcX=sprintf('%.2f',$tcX);
	    $tcY=sprintf('%.2f',$tcY);
	    $result.='\put('.$tcX.','.$tcY.'){\normalsize \bf '.$label.'}'."\n";
	    if( $type eq 'text') {
		&add_vars($gname,$i,$label,$idx_arr[$i],$value,'',$safeeval);
	    } elsif ( $type eq 'image') {
		&add_vars($gname,$i,
			  $Apache::randomlabel::description[$idx_arr[$i]],
			  $idx_arr[$i],$value,$label,$safeeval);
	    } else {
		&Apache::lonxml::error('Unknown type of label :'.$type.':');
	    }
	}
    } elsif ($target eq 'edit') {
	$result.=&Apache::edit::end_table;
    }
    return $result;
}

# <location x="123" y="456" value="some value"/>
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);
    my $value= &Apache::lonxml::get_param('value',$parstack,$safeeval);
    my $result='';
    push(@Apache::randomlabel::xcoord,$x);
    push(@Apache::randomlabel::ycoord,$y);
    push(@Apache::randomlabel::value,$value);
    if ($target eq 'edit') {
	$result.=&Apache::edit::tag_start($target,$token);
	$result.=&Apache::edit::text_arg('X:','x',$token,4).
	    &Apache::edit::text_arg('Y:','y',$token,4).
	    &Apache::edit::entercoords('x','y','attribute','width','height').'&nbsp;&nbsp;&nbsp;'.
	    &Apache::edit::text_arg('Value:','value',$token).
	    &Apache::edit::end_row();
	$result.=&Apache::edit::end_table;
    } elsif ($target eq 'modified') {
	my $constructtag=&Apache::edit::get_new_args($token,$parstack,
						    $safeeval,'x','y','value');
	if ($constructtag) {
	    $result = &Apache::edit::rebuild_tag($token);
	    $result.=&Apache::edit::handle_insert();
	}
    }
    return $result;
}

sub end_location {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my @result;
    if ($target eq 'edit') { @result=('','no') }
    return @result;
}

# <label>$var_abc</label>
sub start_label {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result='';
    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);
    } elsif ($target eq 'edit') {
	$result.=&Apache::edit::tag_start($target,$token,"$type Label");
	my $text=&Apache::lonxml::get_all_text("/label",$parser);
	if ($type eq 'image') {
	    $result.=&Apache::edit::end_row().
		&Apache::edit::start_spanning_row();
	    $result.=&Apache::edit::text_arg('Description:','description',
					     $token);
	}
	if ($type eq 'text') { $result.="Label Text:"; }
	if ($type eq 'image') { $result.="Path to image:&nbsp;"; }
	$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,
							 $safeeval,
							 'description');
	    if ($constructtag) {
		$result = &Apache::edit::rebuild_tag($token);
	    } else {
		$result = $token->[4];
	    }
	}
	$result.=&Apache::edit::modifiedfield($token);
    }
    return $result;
}

sub end_label {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my @result;
    if ($target eq 'edit') { @result=('','no') }
    return @result;
}

1;
__END__