--- loncom/homework/imageresponse.pm	2006/11/06 23:44:42	1.80
+++ loncom/homework/imageresponse.pm	2012/10/12 12:45:46	1.104
@@ -1,8 +1,8 @@
-
+#
 # The LearningOnline Network with CAPA
 # image click response style
 #
-# $Id: imageresponse.pm,v 1.80 2006/11/06 23:44:42 foxr Exp $
+# $Id: imageresponse.pm,v 1.104 2012/10/12 12:45:46 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -29,6 +29,87 @@
 #FIXME LATER assumes multiple possible submissions but only one is possible 
 #currently
 
+
+=head1 NAME
+
+Apache::imageresponse
+
+=head1 SYNOPSIS
+
+Coordinates the response to clicking an image.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=item start_imageresponse()
+
+=item end_imageresponse()
+
+=item start_foilgroup()
+
+=item getfoilcounts()
+
+=item whichfoils()
+
+=item prep_image()
+
+=item draw_image()
+
+=item displayfoils()
+
+=item format_prior_response()
+
+=item display_answers()
+
+=item clean_up_image()
+
+=item gradefoils()
+
+=item stringify_submission()
+
+=item get_submission()
+
+=item end_foilgroup()
+
+=item start_conceptgroup()
+
+=item end_conceptgroup()
+
+=item insert_foil()
+
+=item start_foil()
+
+=item end_foil()
+
+=item start_text()
+
+=item end_text()
+
+=item start_image()
+
+=item end_image()
+
+=item start_rectangle()
+
+=item grade_rectangle()
+
+=item end_rectangle()
+
+=item start_polygon()
+
+=item grade_polygon()
+
+=item end_polygon()
+
+=back
+
+=cut
+
+
 package Apache::imageresponse;
 use strict;
 use Image::Magick();
@@ -59,7 +140,20 @@ sub start_imageresponse {
 	$result=&Apache::response::meta_package_write('imageresponse');
     } elsif ($target eq 'analyze') {
 	my $part_id="$Apache::inputtags::part.$id";
+        $Apache::lonhomework::analyze{"$part_id.type"} = 'imageresponse';
 	push (@{ $Apache::lonhomework::analyze{"parts"} },$part_id);
+	push (@{ $Apache::lonhomework::analyze{"$part_id.bubble_lines"} },
+	      1);
+    } elsif ( $target eq 'edit' ) {
+	$result .= &Apache::edit::tag_start($target,$token).
+	    &Apache::edit::text_arg('Max Number Of Shown Foils:',
+				    'max',$token,'4').
+	    &Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row();
+    } elsif ( $target eq 'modified' ) {
+	my $constructtag=
+	    &Apache::edit::get_new_args($token,$parstack,$safeeval,'max');
+	if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); }
     }
     return $result;
 }
@@ -67,6 +161,9 @@ sub start_imageresponse {
 sub end_imageresponse {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
 
+    my $part_id     = $Apache::inputtags::part;
+    my $response_id = $Apache::inputtags::response[-1]; 
+
     pop(@Apache::lonxml::namespace);
     &Apache::lonxml::deregister('Apache::imageresponse',('foilgroup','foil','text','image','rectangle','conceptgroup'));
 
@@ -82,18 +179,24 @@ sub end_imageresponse {
     
     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || 
 	$target eq 'tex' || $target eq 'analyze') {
-	&Apache::lonxml::increment_counter(&Apache::response::repetition());
+        my $repetition = &Apache::response::repetition();
+	&Apache::lonxml::increment_counter($repetition, 
+					   "$part_id.$response_id");
+	if ($target eq 'analyze') {
+	    &Apache::lonhomework::set_bubble_lines();
+	}
+	
     }
     &Apache::response::end_response();
-
     return $result;
 }
 
 %Apache::response::foilgroup=();
 sub start_foilgroup {
+    my ($target) = @_;
     %Apache::response::foilgroup=();
     $Apache::imageresponse::conceptgroup=0;
-    &Apache::response::pushrandomnumber();
+    &Apache::response::pushrandomnumber(undef,$target);
     return '';
 }
 
@@ -103,44 +206,56 @@ sub getfoilcounts {
     my $max = &Apache::lonxml::get_param('max',$parstack,$safeeval,'-2');
     # +1 since instructors will count from 1
     my $count = $#{ $Apache::response::foilgroup{'names'} }+1;
-    #if (&Apache::response::showallfoils()) { $max=$count; }
+    if (&Apache::response::showallfoils()) { $max=$count; }
     return ($count,$max);
 }
 
 sub whichfoils {
     my ($max)=@_;
-    if (!defined(@{ $Apache::response::foilgroup{'names'} })) { return; }
-    my @names = @{ $Apache::response::foilgroup{'names'} };
-    my @whichopt =();
+    my @names;
+    if (ref($Apache::response::foilgroup{'names'}) eq 'ARRAY') {
+        @names = @{ $Apache::response::foilgroup{'names'} };
+    }
+    return if (!@names);
+    my @whichopt;
     while ((($#whichopt+1) < $max) && ($#names > -1)) {
 	&Apache::lonxml::debug("Have $#whichopt max is $max");
 	my $aopt;
-#	if (&Apache::response::showallfoils()) {
-#	    $aopt=0;
-#	} else {
+	if (&Apache::response::showallfoils()) {
+	    $aopt=0;
+	} else {
 	    $aopt=int(&Math::Random::random_uniform() * ($#names+1));
-#	}
+	}
 	&Apache::lonxml::debug("From $#names elms, picking $aopt");
 	$aopt=splice(@names,$aopt,1);
 	&Apache::lonxml::debug("Picked $aopt");
-	push (@whichopt,$aopt);
+	push(@whichopt,$aopt);
     }
     return @whichopt;
 }
 
 sub prep_image {
     my ($image,$mode,$name)=@_;
-    my $part=$Apache::inputtags::part;
-    my $respid=$Apache::inputtags::response['-1'];
+
+    my ($x,$y)= &get_submission($name);
+    &Apache::lonxml::debug("for $name drawing click at $x and $y");
+    &draw_image($mode,$image,$x,$y,$Apache::response::foilgroup{"$name.area"});
+}
+
+sub draw_image {
+    my ($mode,$image,$x,$y,$areas) = @_;
+
     my $id=&Apache::loncommon::get_cgi_id();
+
     my (%x,$i);
     $x{"cgi.$id.BGIMG"}=&escape($image);
-    my ($x,$y)=split(/:/,$Apache::lonhomework::history{"resource.$part.$respid.submission"});
+
     #draws 2 xs on the image at the clicked location
     #one in white and then one in red on top of the one in white
+
     if (defined($x)    && $x =~/\S/ 
 	&& defined($y) && $y =~/\S/ 
-	&& !&Apache::response::show_answer()
+	&& ($mode eq 'submission' || !&Apache::response::show_answer())
 	&& $mode ne 'answeronly') {
 	my $length = 6;
 	my $width = 1;
@@ -170,8 +285,7 @@ sub prep_image {
     if ($mode eq 'answer' || $mode eq 'answeronly') {
 	my $width = 1;
 	my $extrawidth = 2;
-	my @areas = @{ $Apache::response::foilgroup{"$name.area"} };
-	foreach my $area (@areas) {
+	foreach my $area (@{ $areas }) {
 	    if ($area=~/^rectangle:/) {
 		$x{"cgi.$id.OBJTYPE"}.='RECTANGLE:';
 		$i=$x{"cgi.$id.OBJCOUNT"}++;
@@ -194,24 +308,26 @@ sub prep_image {
 	    }
 	}
     }
-    &Apache::lonnet::appenv(%x);
+    &Apache::lonnet::appenv(\%x);
     return $id;
 }
 
 sub displayfoils {
     my ($target,@whichopt) = @_;
     my $result ='';
-    my $name;
     my $temp=1;
-    foreach $name (@whichopt) {
+    my @images;
+    foreach my $name (@whichopt) {
 	$result.=$Apache::response::foilgroup{"$name.text"};
 	&Apache::lonxml::debug("Text is $result");
 	if ($target eq 'tex') {$result.="\\vskip 0 mm \n";} else {$result.="<br />\n";}
 	my $image=$Apache::response::foilgroup{"$name.image"};
 	&Apache::lonxml::debug("image is $image");
-	if ( $target eq 'web' && $image !~ /^http:/ ) {
+	if ( ($target eq 'web' || $target eq 'answer') 
+	     && $image !~ /^https?\:/ ) {
 	    $image=&clean_up_image($image);
-	} 
+	}
+	push(@images,$image);
 	&Apache::lonxml::debug("image is $image");
 	if ( &Apache::response::show_answer() ) {
 	    if ($target eq 'tex') {
@@ -224,34 +340,101 @@ sub displayfoils {
 	    if ($target eq 'tex') {
 		$result.=$Apache::response::foilgroup{"$name.image"}."\\vskip 0 mm \n";
 	    } else {
-		my $id=$Apache::inputtags::response['-1'];
-		my $token=&prep_image($image);
-		my $temp=1;
-		$result.="<input type=\"image\" name=\"HWVAL_$id:$temp\" ".
-		    "src=\"/adm/randomlabel.png?token=$token\" /><br />\n";
+		my $respid=$Apache::inputtags::response['-1'];
+		my $token=&prep_image($image,'submission',$name);
+		my $input_id = "HWVAL_$respid:$temp";
+		my $id = $env{'form.request.prefix'}.$input_id;
+		$result.='<img onclick="image_response_click(\''.$id.'\',event);"
+	                       src="/adm/randomlabel.png?token='.$token.'" 
+                               id="'.$id.'_imageresponse"
+                                />'.
+			       '<br />'.
+			       '<input type="hidden" name="'.$input_id.'_token" value="'.$token.'" />'.
+			       '<input type="hidden" name="'.$input_id.'" value="'.
+			       join(':',&get_submission($name)).'" />';
 	    }
 	}
 	$temp++;
     }
+    if ($target eq 'web') {
+        &get_prior_options(\@images,\@whichopt);
+    }
+    return $result;
+}
+
+sub get_prior_options {
+    my ($currimages,$curropt) = @_;
+    return unless((ref($curropt) eq 'ARRAY') && 
+                  (ref($currimages) eq 'ARRAY'));
+    my $part = $Apache::inputtags::part;
+    my $respid   = $Apache::inputtags::response[-1];
+    foreach my $i (1..$Apache::lonhomework::history{'version'}) {
+        my $partprefix = "$i:resource.$part";
+        my $sub_key = "$partprefix.$respid.submission";
+        next if (!exists($Apache::lonhomework::history{$sub_key}));
+        my $type_key = "$partprefix.type";
+        my @whichopt = ();
+        my @images = ();
+        if ($Apache::lonhomework::history{$type_key} eq 'randomizetry') {
+            my $order_key = "$partprefix.$respid.foilorder";
+            @whichopt = &Apache::lonnet::str2array($Apache::lonhomework::history{$order_key});
+            if (@whichopt > 0) {
+                foreach my $name (@whichopt) {
+                    my $image=$Apache::response::foilgroup{"$name.image"};
+                    if ($image !~ /^https?\:/ ) {
+                        $image=&clean_up_image($image);
+                    }
+                    push(@images,$image);
+                }
+            }
+        } else {
+            @whichopt = @{$curropt};
+            @images = @{$currimages};
+        }
+        my $submission = $Apache::lonhomework::history{$sub_key};
+        my $output =  &format_prior_response('grade',$submission,
+                                             [\@images,\@whichopt]);
+        if (defined($output)) {
+            $Apache::inputtags::submission_display{$sub_key} = $output;
+        }
+    }
+}
+
+sub format_prior_response {
+    my ($mode,$answer,$other_data) = @_;
+    
+    my $result;
+
+    # make a copy of the data in the refs
+    my @images = @{ $other_data->[0] };
+    my @foils = @{ $other_data->[1] };
+    foreach my $name (@foils) {
+	my $image = pop(@images);
+	my ($x,$y) = &get_submission($name,$answer);
+	my $token = &draw_image('submission',$image,$x,$y);
+	$result .=
+	    '<img class="LC_prior_image"
+                  src="/adm/randomlabel.png?token='.$token.'" /><br />';
+    }
     return $result;
 }
 
 sub display_answers {
     my ($target,$whichopt)=@_;
 
-    my $result;
+    my $result=&Apache::response::answer_header('imageresponse');
     foreach my $name (@$whichopt) {
 	my $image=$Apache::response::foilgroup{"$name.image"};
 	&Apache::lonxml::debug("image is $image");
-	if ( $target eq 'web' && $image !~ /^http:/ ) {
+	if ( ($target eq 'web' || $target eq 'answer')
+	     && $image !~ /^https?\:/ ) {
 	    $image = &clean_up_image($image);
 	} 
 	my $token=&prep_image($image,'answeronly',$name);
 
-	$result.=&Apache::response::answer_header('imageresponse');
 	$result.=&Apache::response::answer_part('imageresponse',"<img src=\"/adm/randomlabel.png?token=$token\" /><br />\n");
-	$result.=&Apache::response::answer_footer('imageresponse');
     }
+    $result.=&Apache::response::answer_footer('imageresponse');
     return $result;
 }
 
@@ -259,7 +442,7 @@ sub clean_up_image {
     my ($image)=@_;
     if ($image =~ /\s*<img\s*/) {
 	($image) = ($image =~ /src\s*=\s*[\"\']([^\"\']+)[\"\']/i);
-	if ($image !~ /^http:/) {
+	if ($image !~ /^https?\:/) {
 	    $image=&Apache::lonnet::hreflocation('',$image);
 	}
 	if (!$image) {
@@ -286,17 +469,18 @@ sub gradefoils {
 	return;
     }
     
-    my $x;
-    my $y;
-    my $result;
+    my @results;
     my $temp=1;
+    my %response;
     foreach my $name (@whichopt) {
-	$x=$env{"form.HWVAL_$id:$temp.x"};
-	$y=$env{"form.HWVAL_$id:$temp.y"};
+	my ($x,$y) = split(':',$env{"form.HWVAL_$id:$temp"});
+	$response{$name} = $env{"form.HWVAL_$id:$temp"};
 	&Apache::lonxml::debug("Got a x of $x and a y of $y for $name");
-	if (defined($x) && defined($y) &&
-	    defined(@{ $Apache::response::foilgroup{"$name.area"} })) {
-	    my @areas = @{ $Apache::response::foilgroup{"$name.area"} };
+        my @areas; 
+        if (ref($Apache::response::foilgroup{"$name.area"}) eq 'ARRAY') {
+            @areas = @{ $Apache::response::foilgroup{"$name.area"} };
+        }
+	if (defined($x) && defined($y) && @areas) {
 	    my $grade="INCORRECT";
 	    foreach my $area (@areas) {
 		&Apache::lonxml::debug("Area is $area for $name");
@@ -307,29 +491,70 @@ sub gradefoils {
 		} elsif ($1 eq 'polygon') {
 		    $grade=&grade_polygon($area,$x,$y);
 		} else {
-		    &Apache::lonxml::error("Unknown area style $area");
+		    &Apache::lonxml::error(&mt('Unknown area style [_1]',$area));
 		}
 		&Apache::lonxml::debug("Area said $grade");
 		if ($grade eq 'APPROX_ANS') { last; }
 	    }
 	    &Apache::lonxml::debug("Foil was $grade");
-	    if ($grade eq 'INCORRECT') { $result= 'INCORRECT'; }
-	    if (($grade eq 'APPROX_ANS') && ($result ne 'APPROX_ANS')) { $result=$grade; }
-	    &Apache::lonxml::debug("Question is $result");
-	    $temp++;
+	    push(@results, $grade)
+	} else {
+	    push(@results, 'MISSING_ANSWER')
 	}
+	$temp++;
+    }
+    if ($Apache::lonhomework::type eq 'randomizetry') {
+        $Apache::lonhomework::results{"resource.$partid.$id.foilorder"} = &Apache::lonnet::array2str(@whichopt);
     }
-    my $responsestr="$x:$y";
+    my ($result) = &Apache::inputtags::finalizeawards(\@results,[]);
+    &Apache::lonxml::debug("Question is $result");
+
     my $part=$Apache::inputtags::part;
-    my %previous=&Apache::response::check_for_previous($responsestr,$part,$id);
-    if ($result 
-	&& $Apache::lonhomework::type eq 'survey') { $result='SUBMITTED'; }
+    my %previous=
+	&Apache::response::check_for_previous(&stringify_submission(\%response),
+					      $part,$id);
+    if ($result) { 
+	if ($Apache::lonhomework::type eq 'survey') { 
+            $result='SUBMITTED';
+        } elsif ($Apache::lonhomework::type eq 'surveycred') { 
+            $result='SUBMITTED_CREDIT'; 
+        } elsif ($Apache::lonhomework::type eq 'anonsurvey') { 
+            $result='ANONYMOUS'; 
+        } elsif ($Apache::lonhomework::type eq 'anonsurveycred') { 
+            $result='ANONYMOUS_CREDIT'; 
+        }
+    }
+
     &Apache::response::handle_previous(\%previous,$result);
-    $Apache::lonhomework::results{"resource.$part.$id.submission"}=$responsestr;
+    $Apache::lonhomework::results{"resource.$part.$id.submission"}=
+	&stringify_submission(\%response);
     $Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$result;
     return;
 }
 
+sub stringify_submission {
+    my ($response) = @_;
+    return &Apache::lonnet::hash2str(%{ $response });
+}
+
+sub get_submission {
+    my ($name,$string) = @_;
+
+    if (!defined($string)) {
+	my $part=$Apache::inputtags::part;
+	my $respid=$Apache::inputtags::response['-1'];
+   	$string = 
+	    $Apache::lonhomework::history{"resource.$part.$respid.submission"};
+    }
+
+    if ($string !~ /=/) {
+	return split(':',$string);
+    } else {
+	my %response = &Apache::lonnet::str2hash($string);
+	return split(':',$response{$name});
+    }
+}
+
 sub end_foilgroup {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';
@@ -346,6 +571,12 @@ sub end_foilgroup {
 
 	if ($target eq 'web' || $target eq 'tex') {
 	    $result=&displayfoils($target,@whichopt);
+            if ($Apache::lonhomework::type eq 'randomizetry') {
+                if ($target eq 'web') {
+                    &get_prior_options($target,@whichopt);
+                }
+            }
+	    $Apache::lonxml::post_evaluate=0;
 	} elsif ($target eq 'grade') {
 	    if ( defined $env{'form.submitted'}) { &gradefoils(@whichopt); }
 	} elsif ( $target eq 'analyze') {
@@ -403,15 +634,16 @@ sub start_foil {
 	$target eq 'analyze' || $target eq 'answer') {
 	my $name = &Apache::lonxml::get_param('name',$parstack,$safeeval);
 	if ($name eq "") {
-	    &Apache::lonxml::warning("Foils without names exist. This can cause problems to malfunction.");
+	    &Apache::lonxml::warning(&mt('Foils without names exist. This can cause problems to malfunction.'));
 	    $name=$Apache::lonxml::curdepth;
 	}
 	if (defined($Apache::response::foilnames{$name})) {
-	    &Apache::lonxml::error(&mt("Foil name <b><tt>[_1]</tt></b> appears more than once. Foil names need to be unique.",$name));
+	    &Apache::lonxml::error(&mt("Foil name [_1] appears more than once. Foil names need to be unique."
+                                      ,'<b><tt>'.$name.'</tt></b>'));
 	}
 	$Apache::response::foilnames{$name}++;
 	if ( $Apache::imageresponse::conceptgroup
-	     #&& !&Apache::response::showallfoils()
+	     && !&Apache::response::showallfoils()
 	     ) {
 	    push(@{ $Apache::response::conceptgroup{'names'} }, $name);
 	} else {
@@ -464,7 +696,7 @@ sub end_text {
 	|| $target eq 'answer') {
 	my $name = $Apache::imageresponse::curname;
 	if ( $Apache::imageresponse::conceptgroup
-	     #&& !&Apache::response::showallfoils()
+	     && !&Apache::response::showallfoils()
 	     ) {
 	    $Apache::response::conceptgroup{"$name.text"} = &Apache::lonxml::endredirection;
 	} else {
@@ -479,6 +711,7 @@ sub end_text {
 sub start_image {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';
+    my $only = join(',',&Apache::loncommon::filecategorytypes('Pictures'));
     if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze'
 	|| $target eq 'answer') { 
 	&Apache::lonxml::startredirection; 
@@ -489,7 +722,7 @@ sub start_image {
 
 	$result=&Apache::edit::tag_start($target,$token,'Clickable Image').
 	    &Apache::edit::editline($token->[1],$bgimg,'Image Source File',40);
-	$result.=&Apache::edit::browse(undef,'textnode').' ';
+	$result.=&Apache::edit::browse(undef,'textnode',undef,$only).' ';
 	$result.=&Apache::edit::search(undef,'textnode').
 	    &Apache::edit::end_row();
     } elsif ($target eq "modified") {
@@ -506,7 +739,7 @@ sub end_image {
 	my $image = &Apache::lonxml::endredirection();
 	&Apache::lonxml::debug("original image is $image");
 	if ( $Apache::imageresponse::conceptgroup
-	     #&& !&Apache::response::showallfoils()
+	     && !&Apache::response::showallfoils()
 	     ) {
 	    $Apache::response::conceptgroup{"$name.image"} = $image;
 	} else {
@@ -515,7 +748,7 @@ sub end_image {
     } elsif ($target eq 'analyze') {
 	my $image = &Apache::lonxml::endredirection();
 	if ( $Apache::imageresponse::conceptgroup
-	     #&& !&Apache::response::showallfoils()
+	     && !&Apache::response::showallfoils()
 	     ) {
 	    $Apache::response::conceptgroup{"$name.image"} = $image;
 	} else {
@@ -542,11 +775,13 @@ sub end_image {
 	    my ($commentline, $restofstuff) = split(/\n/, $src);
 	    $graphinclude = $src;
 	    $graphinclude =~ s/^$commentline//;
-	} else {
+	} elsif (!($src =~ /\\/)) {
 	    my ($path,$file) = &Apache::londefdef::get_eps_image($src);
 	    my ($height_param,$width_param)=
 		&Apache::londefdef::image_size($src,0.3,$parstack,$safeeval);
 	    $graphinclude = '\graphicspath{{'.$path.'}}\includegraphics[width='.$width_param.' mm]{'.$file.'}';
+	} else {
+	    $graphinclude = $src;   # Already fully formed.
 	}
 	$Apache::response::foilgroup{"$name.image"} ='\vskip 0 mm \noindent '.$graphinclude;
     } 
@@ -595,7 +830,7 @@ sub end_rectangle {
 	$area=~s/\s//g;
 	&Apache::lonxml::debug("out is $area for $name");
 	if ( $Apache::imageresponse::conceptgroup
-	     #&& !&Apache::response::showallfoils()
+	     && !&Apache::response::showallfoils()
 	     ) {
 	    push @{ $Apache::response::conceptgroup{"$name.area"} },"rectangle:$area";
 	} else {
@@ -676,7 +911,7 @@ sub end_polygon {
 	$area=~s/\s*//g;
 	&Apache::lonxml::debug("out is $area for $name");
 	if ( $Apache::imageresponse::conceptgroup
-	     #&& !&Apache::response::showallfoils()
+	     && !&Apache::response::showallfoils()
 	     ) {
 	    push @{ $Apache::response::conceptgroup{"$name.area"} },"polygon:$area";
 	} else {