--- loncom/homework/radiobuttonresponse.pm 2012/01/24 12:05:12 1.153.6.5 +++ loncom/homework/radiobuttonresponse.pm 2016/01/22 22:42:51 1.160 @@ -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.160 2016/01/22 22:42:51 damieng Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,6 +25,8 @@ # http://www.lon-capa.org/ # + + package Apache::radiobuttonresponse; use strict; use HTML::Entities(); @@ -38,72 +40,71 @@ my @alphabet = ( 'A' .. 'Z' ); # Fo + BEGIN { - &Apache::lonxml::register( 'Apache::radiobuttonresponse', - ('radiobuttonresponse') ); + &Apache::lonxml::register('Apache::radiobuttonresponse',('radiobuttonresponse')); } +#--------------------------------------------------------------------------- +# +# Generic utility subs. + sub bubble_line_count { - my ( $numfoils, $bubbles_per_line ) = @_; + my ($numfoils, $bubbles_per_line) = @_; my $bubble_lines; - $bubble_lines = int( $numfoils / $bubbles_per_line ); - if ( ( $numfoils % $bubbles_per_line ) != 0 ) { - $bubble_lines++; + $bubble_lines = int($numfoils / $bubbles_per_line); + if (($numfoils % $bubbles_per_line) != 0) { + $bubble_lines++; } return $bubble_lines; - + } + + +#------------------------------------------------------------------------------ +# +# XML handlers. sub start_radiobuttonresponse { - my ( $target, $token, $tagstack, $parstack, $parser, $safeeval, $style ) = - @_; + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; #when in a radiobutton response use these - &Apache::lonxml::register( 'Apache::radiobuttonresponse', - ( 'foilgroup', 'foil', 'conceptgroup' ) ); - push( @Apache::lonxml::namespace, 'radiobuttonresponse' ); - my $id = &Apache::response::start_response( $parstack, $safeeval ); + &Apache::lonxml::register('Apache::radiobuttonresponse',('foilgroup','foil','conceptgroup')); + push (@Apache::lonxml::namespace,'radiobuttonresponse'); + my $id = &Apache::response::start_response($parstack,$safeeval); - %Apache::hint::radiobutton = (); + %Apache::hint::radiobutton=(); undef(%Apache::response::foilnames); - if ( $target eq 'meta' ) { - $result = &Apache::response::meta_package_write('radiobuttonresponse'); - } - elsif ( $target eq 'edit' ) { - $result .= - &Apache::edit::start_table($token) - . '' - . &Apache::lonxml::description($token) - . &Apache::loncommon::help_open_topic('Radio_Response_Problems') - . '' - . '' - . &mt('Delete?') . ' ' - . &Apache::edit::deletelist( $target, $token ) - . '' - . ' ' - . &Apache::edit::end_row() - . &Apache::edit::start_spanning_row(); - $result .= &Apache::edit::text_arg( 'Max Number Of Shown Foils:', - 'max', $token, '4' ) - . ' ' x 3 - . &Apache::edit::select_arg( 'Randomize Foil Order:', - 'randomize', [ 'yes', 'no' ], $token ) - . ' ' x 3 - . &Apache::edit::select_arg( - 'Display Direction:', 'direction', - [ 'vertical', 'horizontal' ], $token - ) - . &Apache::edit::end_row() - . &Apache::edit::start_spanning_row() . "\n"; - } - elsif ( $target eq 'modified' ) { - my $constructtag = - &Apache::edit::get_new_args( $token, $parstack, $safeeval, 'max', - 'randomize', 'direction' ); - if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } - } - elsif ( $target eq 'tex' ) { + if ($target eq 'meta') { + $result=&Apache::response::meta_package_write('radiobuttonresponse'); + } elsif ($target eq 'edit' ) { + $result.=&Apache::edit::start_table($token) + .''.&Apache::loncommon::insert_folding_button() + .&Apache::lonxml::description($token) + .&Apache::loncommon::help_open_topic('Radio_Response_Problems') + .'' + .''.&mt('Delete?').' ' + .&Apache::edit::deletelist($target,$token) + .'' + .' '.&Apache::edit::end_row() + .&Apache::edit::start_spanning_row(); + $result.= + &Apache::edit::text_arg('Max Number Of Shown Foils:','max', + $token,'4'). + &Apache::edit::select_arg('Randomize Foil Order:','randomize', + ['yes','no'],$token). + &Apache::edit::select_arg('Display Direction:','direction', + ['vertical','horizontal'],$token). + &Apache::edit::end_row(). + &Apache::edit::start_spanning_row()."\n"; + } elsif ($target eq 'modified') { + my $constructtag=&Apache::edit::get_new_args($token,$parstack, + $safeeval,'max', + 'randomize','direction'); + if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } + + } elsif ( $target eq 'tex' ) { my $type = &Apache::lonxml::get_param( 'TeXtype', $parstack, $safeeval, undef, 0 ); @@ -127,294 +128,237 @@ sub start_radiobuttonresponse { elsif ( $target eq 'analyze' ) { my $part_id = "$Apache::inputtags::part.$id"; $Apache::lonhomework::analyze{"$part_id.type"} = 'radiobuttonresponse'; - push( @{ $Apache::lonhomework::analyze{"parts"} }, $part_id ); + push (@{ $Apache::lonhomework::analyze{"parts"} },$part_id); } return $result; } sub end_radiobuttonresponse { - my ( $target, $token, $tagstack, $parstack, $parser, $safeeval, $style ) = - @_; + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; - if ( $target eq 'edit' ) { $result = &Apache::edit::end_table(); } - + if ( $target eq 'edit' ) { + $result = &Apache::edit::end_table(); + } &Apache::response::end_response; pop @Apache::lonxml::namespace; - &Apache::lonxml::deregister( 'Apache::radiobuttonresponse', - ( 'foilgroup', 'foil', 'conceptgroup' ) ); + &Apache::lonxml::deregister('Apache::radiobuttonresponse',('foilgroup','foil','conceptgroup')); undef(%Apache::response::foilnames); return $result; } -%Apache::response::foilgroup = (); - +%Apache::response::foilgroup=(); sub start_foilgroup { - my ( $target, $token, $tagstack, $parstack, $parser, $safeeval, $style ) = - @_; - %Apache::response::foilgroup = (); - $Apache::radiobuttonresponse::conceptgroup = 0; - &Apache::response::pushrandomnumber( undef, $target ); + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; + %Apache::response::foilgroup=(); + $Apache::radiobuttonresponse::conceptgroup=0; + &Apache::response::pushrandomnumber(undef,$target); return; } sub storesurvey { my ($style) = @_; if ( !&Apache::response::submitted() ) { return ''; } - my $response = $env{ 'form.HWVAL_' . $Apache::inputtags::response['-1'] }; + my $response = $env{'form.HWVAL_'.$Apache::inputtags::response['-1']}; &Apache::lonxml::debug("Here I am!:$response:"); - if ( $response !~ /[0-9]+/ ) { return ''; } - my $part = $Apache::inputtags::part; - my $id = $Apache::inputtags::response['-1']; - my @whichfoils = @{ $Apache::response::foilgroup{'names'} }; + if ( $response !~ /[0-9]+/) { return ''; } + my $part = $Apache::inputtags::part; + my $id = $Apache::inputtags::response['-1']; + my @whichfoils=@{ $Apache::response::foilgroup{'names'} }; my %responsehash; - $responsehash{ $whichfoils[$response] } = $response; - my $responsestr = &Apache::lonnet::hash2str(%responsehash); - $Apache::lonhomework::results{"resource.$part.$id.submission"} = - $responsestr; - my %previous = - &Apache::response::check_for_previous( $responsestr, $part, $id ); + $responsehash{$whichfoils[$response]}=$response; + my $responsestr=&Apache::lonnet::hash2str(%responsehash); + $Apache::lonhomework::results{"resource.$part.$id.submission"}= + $responsestr; + my %previous=&Apache::response::check_for_previous($responsestr,$part,$id); my $ad; - - if ( $style eq 'anonsurvey' ) { - $ad = $Apache::lonhomework::results{"resource.$part.$id.awarddetail"} = - 'ANONYMOUS'; - } - elsif ( $style eq 'anonsurveycred' ) { - $ad = $Apache::lonhomework::results{"resource.$part.$id.awarddetail"} = - 'ANONYMOUS_CREDIT'; - } - elsif ( $style eq 'surveycred' ) { - $ad = $Apache::lonhomework::results{"resource.$part.$id.awarddetail"} = - 'SUBMITTED_CREDIT'; - } - else { - $ad = $Apache::lonhomework::results{"resource.$part.$id.awarddetail"} = - 'SUBMITTED'; + if ($style eq 'anonsurvey') { + $ad=$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}='ANONYMOUS'; + } elsif ($style eq 'anonsurveycred') { + $ad=$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}='ANONYMOUS_CREDIT'; + } elsif ($style eq 'surveycred') { + $ad=$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}='SUBMITTED_CREDIT'; + } else { + $ad=$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}='SUBMITTED'; } - &Apache::response::handle_previous( \%previous, $ad ); + &Apache::response::handle_previous(\%previous,$ad); &Apache::lonxml::debug("submitted a $response
\n"); return ''; } + sub grade_response { - my ( $answer, $whichfoils, $bubbles_per_line ) = @_; + my ($answer, $whichfoils, $bubbles_per_line)=@_; if ( !&Apache::response::submitted() ) { return; } my $response; + + if ($env{'form.submitted'} eq 'scantron') { + $response = &Apache::response::getresponse(1,undef, + &bubble_line_count(scalar(@{ $whichfoils}), + $bubbles_per_line), + $bubbles_per_line); - if ( $env{'form.submitted'} eq 'scantron' ) { - $response = - &Apache::response::getresponse( 1, undef, - &bubble_line_count( scalar( @{$whichfoils} ), $bubbles_per_line ), - $bubbles_per_line ); - - } - else { - $response = $env{ 'form.HWVAL_' . $Apache::inputtags::response['-1'] }; + } else { + $response = $env{'form.HWVAL_'.$Apache::inputtags::response['-1']}; } - if ( $response !~ /[0-9]+/ ) { return; } - my $part = $Apache::inputtags::part; - my $id = $Apache::inputtags::response['-1']; + + if ( $response !~ /[0-9]+/) { return; } + my $part=$Apache::inputtags::part; + my $id = $Apache::inputtags::response['-1']; my %responsehash; - $responsehash{ $whichfoils->[$response] } = $response; - my $responsestr = &Apache::lonnet::hash2str(%responsehash); - my %previous = - &Apache::response::check_for_previous( $responsestr, $part, $id ); - $Apache::lonhomework::results{"resource.$part.$id.submission"} = - $responsestr; + $responsehash{$whichfoils->[$response]}=$response; + my $responsestr=&Apache::lonnet::hash2str(%responsehash); + my %previous=&Apache::response::check_for_previous($responsestr, + $part,$id); + $Apache::lonhomework::results{"resource.$part.$id.submission"}= + $responsestr; &Apache::lonxml::debug("submitted a $response
\n"); my $ad; - - if ( $response == $answer ) { - $ad = 'EXACT_ANS'; - } - else { - $ad = 'INCORRECT'; + if ($response == $answer) { + $ad='EXACT_ANS'; + } else { + $ad='INCORRECT'; } - $Apache::lonhomework::results{"resource.$part.$id.awarddetail"} = $ad; - &Apache::response::handle_previous( \%previous, $ad ); + $Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$ad; + &Apache::response::handle_previous(\%previous,$ad); } sub end_foilgroup { - my ( $target, $token, $tagstack, $parstack, $parser, $safeeval, $style ) = - @_; + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; my $bubble_lines; my $answer_count; - my $id = $Apache::inputtags::response['-1']; - my $part = $Apache::inputtags::part; - my $bubbles_per_line = &getbubblesnum( $part, $id ); - - if ( $target eq 'grade' - || $target eq 'web' - || $target eq 'answer' - || $target eq 'tex' - || $target eq 'analyze' ) - { - my $style = $Apache::lonhomework::type; - my $direction = - &Apache::lonxml::get_param( 'direction', $parstack, $safeeval, '-2' ); - if ( - ( - ( $style eq 'survey' ) - || ( $style eq 'surveycred' ) - || ( $style eq 'anonsurvey' ) - || ( $style eq 'anonsurveycred' ) - ) - && ( $target ne 'analyze' ) - ) - { - if ( $target eq 'web' || $target eq 'tex' ) { - $result = &displayallfoils( $direction, $target ); - } - elsif ( $target eq 'answer' ) { - $result = &displayallanswers(); - } - elsif ( $target eq 'grade' ) { - $result = &storesurvey($style); - } - $answer_count = - scalar( @{ $Apache::response::foilgroup{'names'} } ); + my $id = $Apache::inputtags::response['-1']; + my $part = $Apache::inputtags::part; + my $bubbles_per_line = &getbubblesnum($part,$id); - } - else { - my $name; - my $max = - &Apache::lonxml::get_param( 'max', $parstack, $safeeval, '-2' ); - my $randomize = - &Apache::lonxml::get_param( 'randomize', $parstack, $safeeval, - '-2' ); - my ( $answer, @shown ) = &whichfoils( $max, $randomize ); - $answer_count = scalar(@shown); - - if ( $target eq 'web' || $target eq 'tex' ) { - $result = - &displayfoils( $target, $answer, \@shown, $direction, - $bubbles_per_line ); - } - elsif ( $target eq 'answer' ) { - $result = - &displayanswers( $answer, \@shown, $bubbles_per_line ); - } - elsif ( $target eq 'grade' ) { - &grade_response( $answer, \@shown, $bubbles_per_line ); - } - elsif ( $target eq 'analyze' ) { - my $bubble_lines = - &bubble_line_count( $answer_count, $bubbles_per_line ); - &Apache::response::analyze_store_foilgroup( \@shown, - [ 'text', 'value', 'location' ] ); - my $part_id = "$part.$id"; - push( - @{ $Apache::lonhomework::analyze{"$part_id.options"} }, - ( 'true', 'false' ) - ); + if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || + $target eq 'tex' || $target eq 'analyze') { + my $style = $Apache::lonhomework::type; + my $direction = &Apache::lonxml::get_param('direction',$parstack, + $safeeval,'-2'); + if ( (($style eq 'survey') || ($style eq 'surveycred') || + ($style eq 'anonsurvey') || ($style eq 'anonsurveycred')) + && ($target ne 'analyze')) { + if ($target eq 'web' || $target eq 'tex') { + $result=&displayallfoils($direction, $target); + } elsif ( $target eq 'answer' ) { + $result=&displayallanswers(); + } elsif ( $target eq 'grade' ) { + $result=&storesurvey($style); + } + $answer_count = scalar(@{$Apache::response::foilgroup{'names'}}); - } - } - $Apache::lonxml::post_evaluate = 0; + } else { + + my $name; + my $max = &Apache::lonxml::get_param('max',$parstack,$safeeval, + '-2'); + my $randomize = &Apache::lonxml::get_param('randomize',$parstack, + $safeeval,'-2'); + my ($answer, @shown) = &whichfoils($max, $randomize); + $answer_count = scalar(@shown); + + if ($target eq 'web' || $target eq 'tex') { + $result=&displayfoils($target, + $answer, \@shown, + $direction, + $bubbles_per_line); + } elsif ($target eq 'answer' ) { + $result=&displayanswers($answer, \@shown, $bubbles_per_line); + } elsif ( $target eq 'grade') { + &grade_response($answer, \@shown, $bubbles_per_line); + } elsif ( $target eq 'analyze') { + my $bubble_lines = &bubble_line_count($answer_count, + $bubbles_per_line); + &Apache::response::analyze_store_foilgroup(\@shown, + ['text','value','location']); + my $part_id="$part.$id"; + push (@{ $Apache::lonhomework::analyze{"$part_id.options"} }, + ('true','false')); + + } + } + $Apache::lonxml::post_evaluate=0; } - if ( $target eq 'web' ) { - &Apache::response::setup_prior_tries_hash( \&format_prior_answer, - [ \%Apache::response::foilgroup ] ); + if ($target eq 'web') { + &Apache::response::setup_prior_tries_hash(\&format_prior_answer, + [\%Apache::response::foilgroup]); } &Apache::response::poprandomnumber(); - $bubble_lines = &bubble_line_count( $answer_count, $bubbles_per_line ); - &Apache::lonxml::increment_counter( $bubble_lines, "$part.$id" ); - if ( $target eq 'analyze' ) { - &Apache::lonhomework::set_bubble_lines(); + $bubble_lines = &bubble_line_count($answer_count, $bubbles_per_line); + &Apache::lonxml::increment_counter($bubble_lines, + "$part.$id"); + if ($target eq 'analyze') { + &Apache::lonhomework::set_bubble_lines(); } return $result; } - sub getbubblesnum { - my ( $part, $id ) = @_; + my ($part,$id) = @_; my $bubbles_per_line; my $default_numbubbles = $default_bubbles_per_line; - if ( ( $env{'form.bubbles_per_row'} =~ /^\d+$/ ) - && ( $env{'form.bubbles_per_row'} > 0 ) ) - { + if (($env{'form.bubbles_per_row'} =~ /^\d+$/) && + ($env{'form.bubbles_per_row'} > 0)) { $default_numbubbles = $env{'form.bubbles_per_row'}; } - $bubbles_per_line = &Apache::response::get_response_param( $part . "_$id", - 'numbubbles', $default_numbubbles ); + $bubbles_per_line = + &Apache::response::get_response_param($part."_$id",'numbubbles', + $default_numbubbles); return $bubbles_per_line; } sub getfoilcounts { my @names; - my $truecnt = 0; - my $falsecnt = 0; + my $truecnt=0; + my $falsecnt=0; my $name; if ( $Apache::response::foilgroup{'names'} ) { - @names = @{ $Apache::response::foilgroup{'names'} }; + @names= @{ $Apache::response::foilgroup{'names'} }; } foreach $name (@names) { - if ( $Apache::response::foilgroup{ $name . '.value' } eq 'true' ) { - $truecnt++; - } - elsif ( $Apache::response::foilgroup{ $name . '.value' } eq 'false' ) { - $falsecnt++; - } + if ($Apache::response::foilgroup{$name.'.value'} eq 'true') { + $truecnt++; + } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'false') { + $falsecnt++; + } } - return ( $truecnt, $falsecnt ); + return ($truecnt,$falsecnt); } sub format_prior_answer { - my ( $mode, $answer, $other_data ) = @_; + my ($mode,$answer,$other_data) = @_; my $foil_data = $other_data->[0]; - my %response = &Apache::lonnet::str2hash($answer); - my ($name) = keys(%response); - return - '' - . $foil_data->{ $name . '.text' } - . ''; + my %response = &Apache::lonnet::str2hash($answer); + my ($name) = keys(%response); + return ''. + $foil_data->{$name.'.text'}.''; } -## -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 ( ( ( @@ -433,360 +377,437 @@ sub displayallfoils{ } } $showanswer = &Apache::response::show_answer(); - unless ( - ( - ( - $Apache::lonhomework::history{"resource.$part.type"} eq - 'anonsurvey' - ) - || ( $Apache::lonhomework::history{"resource.$part.type"} eq - 'anonsurveycred' ) - ) - && ( defined( $env{'form.grade_symb'} ) ) - || ( $newvariation && !$showanswer ) - ) - { - $lastresponse = - $Apache::lonhomework::history{"resource.$part.$id.submission"}; + unless ($newvariation && !$showanswer) { + if ((($env{'form.grade_username'} eq '') && ($env{'form.grade_domain'} eq '')) || + (($env{'form.grade_username'} eq $env{'user.name'}) && + ($env{'form.grade_domain'} eq $env{'user.domain'}))) { + $lastresponse = $Apache::lonhomework::history{"resource.$part.$id.submission"}; + } else { + unless (($Apache::lonhomework::history{"resource.$part.type"} eq 'anonsurvey') || + ($Apache::lonhomework::history{"resource.$part.type"} eq 'anonsurveycred')) { + $lastresponse = $Apache::lonhomework::history{"resource.$part.$id.submission"}; + } + } } - if ( $direction eq 'horizontal' ) { $result .= ''; } 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
and each + # foil lives in a

+ # + + + my ($opening_html, $closing_html, $pre_foil, $post_foil) = + &html_direction_fragments($direction); + + $result = $opening_html; + + # Different rendering depending on whether answers are shown: + # I played with different factorings but this seems the most concise/clear... + # although I don't like the $showanswer conditino inside the loop. Other things I tried + # - two loops..much longer code..no gain in clarity. + # - Using a visitor patttern passing it the rendering code chunklets and + # an anonymous hash reference for state data etc. Very cool but + # quite a bit more code and quite a bit less clear. + + my $temp = 0; + foreach my $name (@{$names}) { + $result .= $pre_foil; + + if ($showanswer) { + my $foiltext = $Apache::response::foilgroup{$name . '.text'}; + + # Bold the prior response: + + if (defined($lastresponse->{$name})) { + $result .= '' . $foiltext . ''; + } else { + $result .= $foiltext; + } + } else { + $result .= &html_radiobutton( + $part, $Apache::inputtags::response['-1'], $name, $lastresponse, $temp + ); + } + + $result .= $post_foil; + $temp++; + } + + + $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) { - foreach my $name (@names) { - if ( $Apache::response::foilgroup{ $name . '.value' } ne 'unused' ) - { - if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) { - $result .= "

"; - } - } - } + $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}"; + } } - else { - foreach my $name (@names) { - if ( $Apache::response::foilgroup{ $name . '.value' } ne 'unused' ) - { - if ( $direction eq 'horizontal' ) { - $result .= ""; - } - } - else { - $result .= '\vskip 0 mm '; - } - } - } + 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'; + } +} + +## +# Figure out the key html fragments that depend on the rendering direction: +# +# @param $direction - 'horizontal' for horizontal direction. +# +# @return list +# @retval (part_start, part_end, foil_start, foil_end) +# Where: +# - part_start is the HTML to emit at the start of the part. +# - part_end is the HTML to emit at the end of the part. +# - foil_start is the HTML to emit prior to each foil. +# - foil_end is the HTML to emit after each foil +# +sub html_direction_fragments { + my $direction = shift; + if ($direction eq 'horizontal') { + return ('
"; - } - else { - if ( $target eq 'tex' ) { - $result .= '\item \vskip -2mm '; - } - else { - $result .= "
"; - } - } - if ( defined( $lastresponse{$name} ) ) { - if ( $target eq 'tex' ) { - $result .= '}'; - } - else { - $result .= ''; - } - } - $result .= $Apache::response::foilgroup{ $name . '.text' }; - if ( defined( $lastresponse{$name} ) && ( $target ne 'tex' ) ) { - $result .= ''; - } - if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) { - $result .= "		"; - } - 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 .= "
"; - } - } - 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 .= '
', '
', '', ''); + } else { + return ('', '', '
', '
'); } +} + +## +# +# 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 .= ''; + 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 ) = @_; + my ($max,$randomize)=@_; my @truelist; my @falselist; - my @whichfalse = (); - my ( $truecnt, $falsecnt ) = &getfoilcounts(); - my $count = 0; - + my @whichfalse =(); + my ($truecnt,$falsecnt) = &getfoilcounts(); + my $count=0; # we will add in 1 of the true statements - if ( $max > 0 && ( $falsecnt + 1 ) > $max ) { $count = $max } - else { $count = $falsecnt + 1; $max = $count; } - my $answer = int( &Math::Random::random_uniform() * ($count) ); + if ( $max>0 && ($falsecnt+1)>$max) { $count=$max } else { $count=$falsecnt+1; $max=$count; } + my $answer=int(&Math::Random::random_uniform() * ($count)); &Apache::lonxml::debug("Count is $count, $answer is $answer"); my @names; if ( $Apache::response::foilgroup{'names'} ) { - @names = @{ $Apache::response::foilgroup{'names'} }; - } - if ( &Apache::response::showallfoils() ) { - @whichfalse = @names; + @names= @{ $Apache::response::foilgroup{'names'} }; } - elsif ( $randomize eq 'no' ) { - &Apache::lonxml::debug("No randomization"); - my $havetrue = 0; - foreach my $name (@names) { - if ( $Apache::response::foilgroup{ $name . '.value' } eq 'true' ) { - if ( !$havetrue ) { - push( @whichfalse, $name ); - $havetrue++; - $answer = $#whichfalse; - } - } - elsif ( - $Apache::response::foilgroup{ $name . '.value' } eq 'false' ) - { - push( @whichfalse, $name ); - } - elsif ( - $Apache::response::foilgroup{ $name . '.value' } eq 'unused' ) - { - } - else { - &Apache::lonxml::error( - &HTML::Entities::encode( -"No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ", - '<>&"' - ) - ); - } - } - if ( ( !$havetrue ) - && ( $Apache::lonhomework::type ne 'survey' ) - && ( $Apache::lonhomework::type ne 'surveycred' ) - && ( $Apache::lonhomework::type ne 'anonsurvey' ) - && ( $Apache::lonhomework::type ne 'anonsurveycred' ) ) - { - &Apache::lonxml::error( - &mt('There are no true statements available.') . '
' ); - } - } - else { - my $current = 0; - &Apache::lonhomework::showhash(%Apache::response::foilgroup); - my ( %top, %bottom ); - - #first find out where everyone wants to be - foreach my $name (@names) { - $current++; - if ( $Apache::response::foilgroup{ $name . '.value' } eq 'true' ) { - push( @truelist, $name ); - if ( $Apache::response::foilgroup{ $name . '.location' } eq - 'top' ) - { - $top{$name} = $current; - } - elsif ( $Apache::response::foilgroup{ $name . '.location' } eq - 'bottom' ) - { - $bottom{$name} = $current; - } - } - elsif ( - $Apache::response::foilgroup{ $name . '.value' } eq 'false' ) - { - push( @falselist, $name ); - if ( $Apache::response::foilgroup{ $name . '.location' } eq - 'top' ) - { - $top{$name} = $current; - } - elsif ( $Apache::response::foilgroup{ $name . '.location' } eq - 'bottom' ) - { - $bottom{$name} = $current; - } - } - elsif ( - $Apache::response::foilgroup{ $name . '.value' } eq 'unused' ) - { - } - else { - &Apache::lonxml::error( - &HTML::Entities::encode( -"No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ", - '<>&"' - ) - ); - } - } - - #pick a true statement - my $notrue = 0; - if ( scalar(@truelist) == 0 ) { $notrue = 1; } - my $whichtrue = - int( &Math::Random::random_uniform() * ( $#truelist + 1 ) ); - &Apache::lonxml::debug( - "Max is $max, From $#truelist elms, picking $whichtrue"); - my ( @toplist, @bottomlist ); - my $topcount = 0; - my $bottomcount = 0; - - # assign everyone to either toplist/bottomlist or whichfalse - # which false is randomized, toplist bottomlist are in order - while (( ( $#whichfalse + $topcount + $bottomcount ) < $max - 2 ) - && ( $#falselist > -1 ) ) - { - &Apache::lonxml::debug("Have $#whichfalse max is $max"); - my $afalse = - int( &Math::Random::random_uniform() * ( $#falselist + 1 ) ); - &Apache::lonxml::debug("From $#falselist elms, picking $afalse"); - $afalse = splice( @falselist, $afalse, 1 ); - &Apache::lonxml::debug("Picked $afalse"); - &Apache::lonhomework::showhash( ( 'names' => \@names ) ); - &Apache::lonhomework::showhash(%top); - if ( $top{$afalse} ) { - $toplist[ $top{$afalse} ] = $afalse; - $topcount++; - } - elsif ( $bottom{$afalse} ) { - $bottomlist[ $bottom{$afalse} ] = $afalse; - $bottomcount++; - } - else { - push( @whichfalse, $afalse ); - } - } - &Apache::lonxml::debug("Answer wants $answer"); - my $truename = $truelist[$whichtrue]; - my $dosplice = 1; - if ( ($notrue) - && ( $Apache::lonhomework::type ne 'survey' ) - && ( $Apache::lonhomework::type ne 'surveycred' ) - && ( $Apache::lonhomework::type ne 'anonsurvey' ) - && ( $Apache::lonhomework::type ne 'anonsurveycred' ) ) - { - $dosplice = 0; - &Apache::lonxml::error( - &mt('There are no true statements available.') . '
' ); - } - - #insert the true statement, keeping track of where it wants to be - if ( $Apache::response::foilgroup{ $truename . '.location' } eq 'top' - && $dosplice ) - { - $toplist[ $top{$truename} ] = $truename; - $answer = -1; - foreach my $top ( reverse(@toplist) ) { - if ($top) { $answer++; } - if ( $top eq $truename ) { last; } - } - $dosplice = 0; - } - elsif ( - $Apache::response::foilgroup{ $truename . '.location' } eq 'bottom' - && $dosplice ) - { - $bottomlist[ $bottom{$truename} ] = $truename; - $answer = -1; - foreach my $bot (@bottomlist) { - if ($bot) { $answer++; } - if ( $bot eq $truename ) { last; } - } - $answer += $topcount + $#whichfalse + 1; - $dosplice = 0; - } - else { - if ( $topcount > 0 || $bottomcount > 0 ) { + if (&Apache::response::showallfoils()) { + @whichfalse=@names; + } elsif ($randomize eq 'no') { + &Apache::lonxml::debug("No randomization"); + my $havetrue=0; + foreach my $name (@names) { + if ($Apache::response::foilgroup{$name.'.value'} eq 'true') { + if (!$havetrue ) { + push(@whichfalse,$name); $havetrue++; $answer=$#whichfalse; + } + } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'false') { + push (@whichfalse,$name); + } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'unused') { + } else { + &Apache::lonxml::error(&HTML::Entities::encode("No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ",'<>&"')); + } + } + if ((!$havetrue) && + ($Apache::lonhomework::type ne 'survey') && + ($Apache::lonhomework::type ne 'surveycred') && + ($Apache::lonhomework::type ne 'anonsurvey') && + ($Apache::lonhomework::type ne 'anonsurveycred')) { + &Apache::lonxml::error(&mt('There are no true statements available.').'
'); + } + } else { + my $current=0; + &Apache::lonhomework::showhash(%Apache::response::foilgroup); + my (%top,%bottom); + #first find out where everyone wants to be + foreach my $name (@names) { + $current++; + if ($Apache::response::foilgroup{$name.'.value'} eq 'true') { + push (@truelist,$name); + if ($Apache::response::foilgroup{$name.'.location'} eq 'top') { + $top{$name}=$current; + } elsif ($Apache::response::foilgroup{$name.'.location'} eq 'bottom') { + $bottom{$name}=$current; + } + } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'false') { + push (@falselist,$name); + if ($Apache::response::foilgroup{$name.'.location'} eq 'top') { + $top{$name}=$current; + } elsif ($Apache::response::foilgroup{$name.'.location'} eq 'bottom') { + $bottom{$name}=$current; + } + } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'unused') { + } else { + &Apache::lonxml::error(&HTML::Entities::encode("No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ",'<>&"')); + } + } + #pick a true statement + my $notrue=0; + if (scalar(@truelist) == 0) { $notrue=1; } + my $whichtrue = int(&Math::Random::random_uniform() * ($#truelist+1)); + &Apache::lonxml::debug("Max is $max, From $#truelist elms, picking $whichtrue"); + my (@toplist, @bottomlist); + my $topcount=0; + my $bottomcount=0; + # assign everyone to either toplist/bottomlist or whichfalse + # which false is randomized, toplist bottomlist are in order + while ((($#whichfalse+$topcount+$bottomcount) < $max-2) && ($#falselist > -1)) { + &Apache::lonxml::debug("Have $#whichfalse max is $max"); + my $afalse=int(&Math::Random::random_uniform() * ($#falselist+1)); + &Apache::lonxml::debug("From $#falselist elms, picking $afalse"); + $afalse=splice(@falselist,$afalse,1); + &Apache::lonxml::debug("Picked $afalse"); + &Apache::lonhomework::showhash(('names'=>\@names)); + &Apache::lonhomework::showhash(%top); + if ($top{$afalse}) { + $toplist[$top{$afalse}]=$afalse; + $topcount++; + } elsif ($bottom{$afalse}) { + $bottomlist[$bottom{$afalse}]=$afalse; + $bottomcount++; + } else { + push (@whichfalse,$afalse); + } + } + &Apache::lonxml::debug("Answer wants $answer"); + my $truename=$truelist[$whichtrue]; + my $dosplice=1; + if (($notrue) && + ($Apache::lonhomework::type ne 'survey') && + ($Apache::lonhomework::type ne 'surveycred') && + ($Apache::lonhomework::type ne 'anonsurvey') && + ($Apache::lonhomework::type ne 'anonsurveycred')) { + $dosplice=0; + &Apache::lonxml::error(&mt('There are no true statements available.').'
'); + } + #insert the true statement, keeping track of where it wants to be + if ($Apache::response::foilgroup{$truename.'.location'} eq 'top' && $dosplice) { + $toplist[$top{$truename}]=$truename; + $answer=-1; + foreach my $top (reverse(@toplist)) { + if ($top) { $answer++;} + if ($top eq $truename) { last; } + } + $dosplice=0; + } elsif ($Apache::response::foilgroup{$truename.'.location'} eq 'bottom' && $dosplice) { + $bottomlist[$bottom{$truename}]=$truename; + $answer=-1; + foreach my $bot (@bottomlist) { + if ($bot) { $answer++;} + if ($bot eq $truename) { last; } + } + $answer+=$topcount+$#whichfalse+1; + $dosplice=0; + } else { + if ($topcount>0 || $bottomcount>0) { my $inc = 1; - if ( ( $bottomcount > 0 ) - && ( $Apache::lonhomework::type ne 'exam' ) ) - { + if (($bottomcount > 0) && ($Apache::lonhomework::type ne 'exam')) { $inc = 2; } - $answer = int( - &Math::Random::random_uniform() * ( $#whichfalse + $inc ) ) - + $topcount; - } - } - &Apache::lonxml::debug("Answer now wants $answer"); + $answer=int(&Math::Random::random_uniform() * ($#whichfalse+$inc)) + + $topcount; + } + } + &Apache::lonxml::debug("Answer now wants $answer"); + #add the top items to the top, bottom items to the bottom + for (my $i=0;$i<=$#toplist;$i++) { + if ($toplist[$i]) { unshift(@whichfalse,$toplist[$i]) } + } + for (my $i=0;$i<=$#bottomlist;$i++) { + if ($bottomlist[$i]) { push(@whichfalse,$bottomlist[$i]) } + } + #if the true statement is randomized insert it into the list + if ($dosplice) { splice(@whichfalse,$answer,0,$truelist[$whichtrue]); } + } + &Apache::lonxml::debug("Answer is $answer"); + return ($answer,@whichfalse); +} - #add the top items to the top, bottom items to the bottom - for ( my $i = 0 ; $i <= $#toplist ; $i++ ) { - if ( $toplist[$i] ) { unshift( @whichfalse, $toplist[$i] ) } - } - for ( my $i = 0 ; $i <= $#bottomlist ; $i++ ) { - if ( $bottomlist[$i] ) { push( @whichfalse, $bottomlist[$i] ) } - } +## +# 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; - #if the true statement is randomized insert it into the list - if ($dosplice) { - splice( @whichfalse, $answer, 0, $truelist[$whichtrue] ); - } + foreach my $name (@{$whichfoils}) { + push(@foil_texts, $Apache::response::foilgroup{$name . '.text'}); } - &Apache::lonxml::debug("Answer is $answer"); - return ( $answer, @whichfalse ); + return @foil_texts; } + ## # Generate the HTML for a single html foil. # @param $part - The part for which the response is being generated. @@ -804,10 +825,10 @@ sub html_radiobutton { my $result='