--- loncom/homework/radiobuttonresponse.pm	2012/01/24 12:05:12	1.153.6.5
+++ loncom/homework/radiobuttonresponse.pm	2012/02/04 20:40:07	1.153.6.9
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # mutliple choice style responses
 #
-# $Id: radiobuttonresponse.pm,v 1.153.6.5 2012/01/24 12:05:12 foxr Exp $
+# $Id: radiobuttonresponse.pm,v 1.153.6.9 2012/02/04 20:40:07 foxr Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -247,6 +247,7 @@ sub end_foilgroup {
     my $part             = $Apache::inputtags::part;
     my $bubbles_per_line = &getbubblesnum( $part, $id );
 
+
     if (   $target eq 'grade'
         || $target eq 'web'
         || $target eq 'answer'
@@ -375,46 +376,25 @@ sub format_prior_answer {
 
 }
 
-##
-sub displayallfoils{
-    my ( $direction, $target ) = @_;
-    my $result;
-    &Apache::lonxml::debug("survey style display");
-    my @names;
-    if ( $Apache::response::foilgroup{'names'} ) {
-        @names = @{ $Apache::response::foilgroup{'names'} };
-    }
-
-    # Figure out how to bracket the list of foils for
-    # the TeX target:
-    #
-
-    my $begin_environment;
-    my $end_environment;
-    
-    if ($target eq 'tex') {
-
-	# Decide how to bracket the list of foils:
-
+## 
+# Return the last survey response.  The logic is slightly different than that of 
+# get_last_responses.  TODO: See if there are chunks of code betweenthis and
+# get_last_reponses that are common and can be factored.
+#
+# @param $part - Problem part under consideration.
+# @param $showanswer - True if answers should be shown.
+# @param $id         - Problem id.
+#
+# @return hash reference.
+# @retval reference to the has indexed by answer selection that 
+#         indicates the most recent answer.
+#
+sub get_last_survey_response {
+    my ($part, $showanswer, $id) = @_;
 
-        if (   $env{'form.pdfFormFields'} eq 'yes'
-            && $Apache::inputtags::status[-1] eq 'CAN_ANSWER' )
-        {
-            $begin_environment = '\begin{itemize}';
-	    $end_environment   = '\end{itemize}';
-        }
-        else {
-            $begin_environment = '\begin{enumerate}';
-	    $end_environment   = '\end{enumerate}';
-        }	
-	$result .= $begin_environment;
-    }
+    my $newvariation;
+    my $lastresponse;		# stringified last response.
 
-    my $temp = 0;
-    my $i    = 0;
-    my $id   = $Apache::inputtags::response['-1'];
-    my $part = $Apache::inputtags::part;
-    my ( $lastresponse, $newvariation, $showanswer );
     if (
         (
             (
@@ -432,7 +412,6 @@ sub displayallfoils{
             $newvariation = 1;
         }
     }
-    $showanswer = &Apache::response::show_answer();
     unless (
         (
             (
@@ -449,128 +428,262 @@ sub displayallfoils{
         $lastresponse =
           $Apache::lonhomework::history{"resource.$part.$id.submission"};
     }
-    if ( $direction eq 'horizontal' ) { $result .= '<table><tr>'; }
     my %lastresponse = &Apache::lonnet::str2hash($lastresponse);
+   
+
+    return \%lastresponse;
+
+}
+##
+# Removes the names from a foil group that are marked as unused.
+#
+# @param $names - reference to the array of names to filter.
+#
+# @return arrayref
+# @retval reference to the filtered array.
+#
+sub remove_unused {
+    my ($names) = @_;
+    my @result;
+
+    foreach my $name (@{$names}) {
+	if ($Apache::response::foilgroup{$name . '.value'} ne 'unused') {
+	    push(@result, $name);
+	}
+    }
+    return \@result;
+}
+## 
+# Displays all foils in a survey type problem for HTML rendition.
+# TODO: See if there is any logic in this sub that can be shared
+#      with display_foils_html
+#
+# @param $names        - ref to array of names of the foils to display.
+# @param $part         - Problem part number.
+# @param $showanswer   - If true, show the answers.
+# @param $lastresponse - Ref to the last response hash.
+# @param $direction    - Display direction of the radiobuttons.
+#
+# @return string
+# @retval HTML required to display the resource in a browser.
+#
+sub display_survey_html {
+    my ($names, $part, $showanswer, $lastresponse, $direction) = @_;
+    my $result;
+
+    # Figure out a few fragments of html that depend onthe 
+    # orientation of the radiobuttons:
+    # closing_html - HTML to emit at the end of the resource.
+    # pre_foil     - HTML to emit prior to each foil.
+    # post_foil    - HTML to emit following each foil.
+    #
+    #  The opening HTML is just added to the $result now
+    #
+    #  Figuring these outin advance compresses the loop over foils into something
+    #  pretty simple:
+    #
+    # NOTE: There's probably a really cool way to do this with style sheets
+    #       and picking the selector based on the orientation, if someone wants to puzzle
+    #       that out.  In that case, probably the whole thing lives in a <div> and each
+    #       foil lives in a <p>
+    #
+
+    my $closing_html;
+    my $pre_foil;
+    my $post_foil;
+	
+    if ($direction eq 'horizontal') {
+	$result       .= '<table><tr>';
+	$closing_html = '</tr></table>';
+	$pre_foil     = '<td>';
+	$post_foil    = '</td>';
+    } else {
+	$pre_foil     = '<br />';
+    }
+    # Different rendering depending on whether answers are shown:
+
+
     if ($showanswer) {
-        foreach my $name (@names) {
-            if ( $Apache::response::foilgroup{ $name . '.value' } ne 'unused' )
-            {
-                if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) {
-                    $result .= "<td>";
-                }
-                else {
-                    if ( $target eq 'tex' ) {
-                        $result .= '\item \vskip -2mm ';
-                    }
-                    else {
-                        $result .= "<br />";
-                    }
-                }
-                if ( defined( $lastresponse{$name} ) ) {
-                    if ( $target eq 'tex' ) {
-                        $result .= '}';
-                    }
-                    else {
-                        $result .= '<b>';
-                    }
-                }
-                $result .= $Apache::response::foilgroup{ $name . '.text' };
-                if ( defined( $lastresponse{$name} ) && ( $target ne 'tex' ) ) {
-                    $result .= '</b>';
-                }
-                if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) {
-                    $result .= "</td>";
-                }
-            }
-        }
+	foreach my $name (@{$names}) {
+
+	    $result .= $pre_foil;
+	    my $foiltext =  $Apache::response::foilgroup{$name . '.text'};
+
+	    # Bold the prior  response:
+
+	    if (defined($lastresponse->{$name})) {
+		$result .= '<b>' . $foiltext . '</b>';
+	    } else {
+		$result .= $foiltext;
+	    }
+
+	    $result .= $post_foil;
+	}
+    } else {
+	my $temp = 0;
+	foreach my $name (@{$names}) {
+	    $result .=  $pre_foil;
+
+	    $result .= &html_radiobutton(
+		$part, $Apache::inputtags::response['-1'], $name, $lastresponse, $temp
+	     );
+
+	    $result .= $post_foil;
+	    $temp++;
+				       
+	}
     }
-    else {
-        foreach my $name (@names) {
-            if ( $Apache::response::foilgroup{ $name . '.value' } ne 'unused' )
-            {
-                if ( $direction eq 'horizontal' ) {
-                    $result .= "<td>";
-                }
-                else {
-                    if ( $target eq 'tex' ) {
-                        if (   $env{'form.pdfFormFields'} eq 'yes'
-                            && $Apache::inputtags::status[-1] eq 'CAN_ANSWER' )
-                        {
-                            my $fieldname =
-                                $env{'request.symb'} 
-                              . '&part_'
-                              . $Apache::inputtags::part
-                              . '&radiobuttonresponse'
-                              . '&HWVAL_'
-                              . $Apache::inputtags::response['-1'];
-                            $result .= '\item[{'
-                              . &Apache::lonxml::print_pdf_radiobutton(
-                                $fieldname, $temp )
-                              . '}]'
-                              . $Apache::response::foilgroup{ $name . '.text' }
-                              . "\n";
-                        }
-                        else {
-                            $result .= '\item \vskip -2mm ';
-                        }
-                    }
-                    else {
-                        $result .= "<br />";
-                    }
-                }
-                if ( $target eq 'tex' ) {
-                    if (   $env{'form.pdfFormFields'} ne 'yes'
-                        or $Apache::inputtags::status[-1] ne 'CAN_ANSWER' )
-                    {
-                        $result .=
-                            '$\bigcirc$'
-                          . $Apache::response::foilgroup{ $name . '.text' }
-                          . '\\\\';    #' stupid emacs
-                    }
-                    $i++;
-                }
-                else {
-                    $result .= '<label>';
-                    $result .= "<input
-                       onchange=\"javascript:setSubmittedPart('$part');\"
-                       type=\"radio\"
-                       name=\"HWVAL_$Apache::inputtags::response['-1']\"
-                       value=\"$temp\"";
-
-                    if ( defined( $lastresponse{$name} ) ) {
-                        $result .= ' checked="checked"';
-                    }
-                    $result .= ' />'
-                      . $Apache::response::foilgroup{ $name . '.text' }
-                      . '</label>';
-                }
-                $temp++;
-                if ( $target ne 'tex' ) {
-                    if (   ( $direction eq 'horizontal' )
-                        && ( $target ne 'tex' ) )
-                    {
-                        $result .= "</td>";
-                    }
-                }
-                else {
-                    $result .= '\vskip 0 mm ';
-                }
-            }
-        }
+
+    $result .= $closing_html;
+    return $result;
+
+}
+
+##
+#  Generate LaTeX for surveys.
+#  
+#   @param $names - names of the foils to display.
+#   @param $showanswer - flag that is true to display answers.
+#   @param $lastresponse - Reference to a hash the indicates the last response.
+#   @param $direction    - Orientation of foils ('horiztonal' or otherwise).
+#   @param $venv         - LaTeX name for vertical env.
+#
+#   @return string
+#   @retval LaTeX rendering of the survey question.
+
+sub latex_survey {
+    my ($names, $showanswer, $lastresponse, $direction, $venv) = @_;
+
+    my $result;
+
+	
+ 
+
+    if ($showanswer) {
+	
+	$result .= "\\begin{$venv}";
+	foreach my $name (@{$names}) {
+	    
+	    
+	    $result .= '\item \vskip -2mm ';
+	    
+	    if ( defined( $lastresponse->{$name} ) ) {
+		$result .= '}';
+	    }
+	    $result .= $Apache::response::foilgroup{ $name . '.text' } . ' ';
+	}
+	$result .= "\\end{$venv}";
+
+    } elsif ( $env{'form.pdfFormFields'} eq 'yes'
+	      && $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
+	$result .= &display_pdf_form($names, $direction, $venv);
+    } else {
+	if ($direction eq 'horizontal') {
+	    my @foil_texts = &get_foil_texts($names);
+	    $result .=  &Apache::caparesponse::make_horizontal_latex_bubbles(
+	    $names, \@foil_texts, '$\bigcirc$');
+	} else {
+	    $result .= "\\begin{$venv}";
+
+	    my $temp = 0;
+	    my $i    = 0;
+	    foreach my $name (@{$names}) {
+
+		$result .= '\item \vskip -2mm ';
+		
+		if ($env{'form.pdfFormFields'} ne 'yes'
+		    or $Apache::inputtags::status[-1] ne 'CAN_ANSWER' )
+		{
+		    $result .=
+			'$\bigcirc$'
+			. $Apache::response::foilgroup{ $name . '.text' }
+		    . '\\\\';    #' stupid emacs
+		}
+		
+		$i++;	    
+		$temp++;
+		
+		$result .= '\vskip 0 mm ';
+	    }
+	    $result .= "\\end{$venv}";
+	}
+	
+	
     }
+    
+    return $result;
+
+    
+}
+##
+#  Figure out the LaTeX environment in which to wrap the LaTeX vertical output.
+#
+# @return string
+# @retval the environment name.  The LaTeX should be wrapped a 
+#    \begin{retval} \end{retval} pair.
+#
+sub latex_vertical_environment {
+    if ($env{'form.pdfFormFields'} eq 'yes'
+	&& $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
+	return 'itemize';
+    } else {
+	return 'enumerate';
+    }
+}
+
+
+
+##
+#
+#  Displays all the foils of a problem in a format suitable for
+#   surveys, surveys for credit, anonymous surveys and anonymous surveys for credit.
+#
+#  @param $direction - Display direction of the choices ('horiztonal' or not).
+#  @param $target    - Rendering target.
+#
+#  @return string
+#  @retval Text that renders for the selected target.
+# 
+sub displayallfoils{
+    my ( $direction, $target ) = @_;
+    my $result;
+    &Apache::lonxml::debug("survey style display");
+
+    my @names;
 
-    if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) {
-        $result .= '</tr></table>';
+    if ( $Apache::response::foilgroup{'names'} ) {
+        @names = @{ $Apache::response::foilgroup{'names'} };
     }
 
-    # Close tex bracketing:
 
-    if ($target eq 'tex') {
-	$result .= $end_environment;
+    my $id   = $Apache::inputtags::response['-1'];
+    my $part = $Apache::inputtags::part;
+    
+    my $showanswer = &Apache::response::show_answer();
+    my $lastresponse = &get_last_survey_response($part, $showanswer, $id);
+    my $used_names = &remove_unused(\@names);
+
+
+    if ($target ne 'tex') {
+	$result .= &display_survey_html(
+	    $used_names, $part, $showanswer, $lastresponse, $direction
+	);
+    } else {	
+
+	my $vertical_env = &latex_vertical_environment();
+	$result .= &latex_survey(
+	    $used_names, $showanswer, $lastresponse, $direction, $vertical_env
+	);
+
     }
+
+
+
     return $result;
 }
 
+
+
 sub whichfoils {
     my ( $max, $randomize ) = @_;
 
@@ -787,6 +900,25 @@ sub whichfoils {
     &Apache::lonxml::debug("Answer is $answer");
     return ( $answer, @whichfalse );
 }
+
+## 
+#  Return a list  of foil texts given foil names.
+#  
+# @param $whichfoils - Reference to a list of foil names.
+#
+# @return array
+# @retval foil texts
+#
+sub get_foil_texts {
+    my ($whichfoils) = @_;
+    my @foil_texts;
+
+    foreach my $name (@{$whichfoils}) {
+	push(@foil_texts, $Apache::response::foilgroup{$name . '.text'});
+    }
+    return @foil_texts;
+}
+
 ##
 # Generate the HTML for a single html foil.
 # @param $part           - The part for which the response is being generated.
@@ -864,14 +996,13 @@ sub get_last_response {
 # @param $target     - Rendition target...there are several html targets.
 # @param $direction  - 'horizontal' if layout is horizontal.
 # @param $part       - Part of the problem that's being displayed.
-# @param $solved     - Solution state of the problem.
 # @param $show_answer- True if answers should be shown.
 #
 # @return string
 # @retval generated html.
 #
 sub display_foils_html {
-    my ($whichfoils, $target, $direction, $part, $solved, $show_answer) = @_;
+    my ($whichfoils, $target, $direction, $part, $show_answer) = @_;
     my $result;
 
     # if the answers get shown, we need to label each item as correct or
@@ -969,38 +1100,33 @@ sub display_foils_html {
 # @param $whichfoils       - Reference to an array that contains the foil names to display
 # @param $bubbles_per_line - Number of bubbles on a line.
 # @param $direction        - Rendering direction 'horizontal' is what we're looking for.
-# @param $vbegin           - Start latex fragment in vertical rendering.
-# @param $vend             - End latex fragmentin vertical rendering.
+# @param $venv             - Name of LaTeX environment to use for vertical rendering.
 #
 # @return string
 # @return the latex rendering of the exam problem.
 #
 #
 sub display_latex_exam {
-    my ($whichfoils, $bubbles_per_line, $direction, $vbegin, $vend) = @_;
+    my ($whichfoils, $bubbles_per_line, $direction, $venv) = @_;
     my $result;
     my $numlines;
     my $bubble_number = 0;
     my $line          = 0;
     my $i             = 0;
 
-    &Apache::lonnet::logthis("LaTeX exam:  $direction  $vbegin $vend");
 
     if ($direction eq  'horizontal') {
 
 	# Marshall the display text for each foil and turn things over to
 	# Apache::response::make_horizontal_bubbles:
 
-	my @foil_texts;
-	foreach my $name (@{$whichfoils}) {
-	    push(@foil_texts, $Apache::response::foilgroup{$name . '.text'});
-	}
+	my @foil_texts = &get_foil_texts($whichfoils);
 	$result .= &Apache::caparesponse::make_horizontal_latex_bubbles(
 	    $whichfoils, \@foil_texts, '$\bigcirc$');
 
 
     } else {
-	$result .= $vbegin;
+	$result .= "\\begin{$venv}";
 	
 	# This section puts out the prefix that tells the user
 	# (if necessary) to only choose one bubble in the next n lines
@@ -1054,7 +1180,7 @@ sub display_latex_exam {
 	    $i++;
 	    $bubble_number++;
 	}
-	$result .= $vend
+	$result .= "\\end{$venv}";
 
     }	
 
@@ -1067,24 +1193,35 @@ sub display_latex_exam {
 #
 #  @param $whichfoils - The foils to display
 #  @param $direction  - Display direction ('horizontal' is what matters to us).
-#  @param $vbegin     - Begin the vertical environment being used.
+#  @param $venv       - Vertical env. to use for vertical rendering.
 #  @param  $vend      - End the vertical environment being used.
 #
 #  @return string
 #  @retval - The LaTeX rendering of the resource.'
 #
 sub display_latex {
-    my ($whichfoils, $direction, $vbegin, $vend) = @_;
+    my ($whichfoils, $direction, $venv) = @_;
     my $result;
 
-    $result .= $vbegin;
-    foreach my $name (@{$whichfoils}) {
-	$result .=  '\vspace*{-2 mm}\item '
-	    . $Apache::response::foilgroup{ $name . '.text' };
-    }
+    # how we render depends on the direction.
+    # Vertical is some kind of list environment determined by vbegin/vend.
+    # Horizontal is a table that is generated by 
+    # Apache::caparesponse::make_horizontal_latex_bubbles with an empty string
+    # for the actual bubble text.
 
-    $result .= $vend;
+    if ($direction eq 'horizontal') {
+	my @foil_texts = &get_foil_texts($whichfoils);
+	$result .= &Apache::caparesponse::make_horizontal_latex_bubbles(
+	    $whichfoils, \@foil_texts, '');
+    } else {
+	$result .= "\\begin{$venv}";
+	foreach my $name (@{$whichfoils}) {
+	    $result .=  '\vspace*{-2 mm}\item '
+		. $Apache::response::foilgroup{ $name . '.text' };
+	}
 	
+	$result .= "\\end{$venv}";
+    }
     return $result;
 }
 
@@ -1098,15 +1235,19 @@ sub display_latex {
 #                     they should be displayed.
 # @param $direction  - Rendering direction.  'horiztonal' means inputs are laid out
 #                      horizontally otherwise they are stacked vertically.
+# @param $venv       - Vertical environment in which to wrap the foils.
 #
 # @return string
 # @retval String containing the rendering of the resource.
 #
+# TODO: Take into account direction!!!
+#
 sub display_pdf_form {
-    my ($whichfoils) = @_;
+    my ($whichfoils, $direction, $venv) = @_;
     my $temp = 0;
     my $result;
 
+    $result .= "\\begin{$venv}";
     foreach my $name ( @{$whichfoils} ) {
 	
 	my $fieldname =
@@ -1125,6 +1266,7 @@ sub display_pdf_form {
 	
 	$temp++;
     }
+    $result .= "\\end{$venv}";
 
     return $result;
 }
@@ -1158,7 +1300,7 @@ sub displayfoils {
     {
 
 	$result = &display_foils_html(
-	    $whichfoils, $target, $direction, $part, $solved, 1);
+	    $whichfoils, $target, $direction, $part,  1);
 	
 	# other html
     }  elsif ($target ne 'tex') {
@@ -1168,40 +1310,21 @@ sub displayfoils {
        # LaTeX rendering:
     } else {
 
-        my $i             = 0;
-        my $bubble_number = 0;
-        my $line          = 0;
-        my $temp          = 0;
+
         my $id            = $Apache::inputtags::response['-1'];
         my $part          = $Apache::inputtags::part;
-
-	
-	
 	my $numlines;
 	
 	# Decide how to bracket the list of foils:
 
-	my $begin_environment;
-	my $end_environment;
+	my $vertical_env = &latex_vertical_environment();
 
-        if (   $env{'form.pdfFormFields'} eq 'yes'
-            && $Apache::inputtags::status[-1] eq 'CAN_ANSWER' )
-        {
-            $begin_environment = '\begin{itemize}';
-	    $end_environment   = '\end{itemize}';
-        }
-        else {
-            $begin_environment = '\begin{enumerate}';
-	    $end_environment   = '\end{enumerate}';
-        }	
-	
 	# Rendering for latex exams.
 	
 	if ( ( $Apache::lonhomework::type eq 'exam' ) )
 	{
 	    $result .= &display_latex_exam(
-		$whichfoils, $bubbles_per_line, $direction, $begin_environment, 
-		$end_environment);
+		$whichfoils, $bubbles_per_line, $direction, $vertical_env);
 
 	    $result .= '\vskip 0mm ';
 	    
@@ -1214,13 +1337,9 @@ sub displayfoils {
 	    if ( ($env{'form.pdfFormFields'} eq 'yes')
 		    && ($Apache::inputtags::status[-1] eq 'CAN_ANSWER'))
 	    {
-		$result .= $begin_environment;
-		$result .= &display_pdf_form($whichfoils, $direction);
-		$result .= $end_environment;
+		$result .= &display_pdf_form($whichfoils, $direction, $vertical_env);
 	    } else {
-		$result .= &display_latex(
-		     $whichfoils,  $direction, $begin_environment, $end_environment
-		    );
+		$result .= &display_latex($whichfoils,  $direction, $vertical_env );
 	    }
 	    $result .= '\vskip 0 mm ';