# The LearningOnline Network with CAPA
# mutliple choice style responses
#
# $Id: radiobuttonresponse.pm,v 1.153.6.4 2012/01/23 12:00:13 foxr 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/
#
package Apache::radiobuttonresponse;
use strict;
use HTML::Entities();
use Apache::lonlocal;
use Apache::lonnet;
use Apache::response;
my $default_bubbles_per_line = 10;
my @alphabet = ( 'A' .. 'Z' ); # Foil labels.
BEGIN {
&Apache::lonxml::register( 'Apache::radiobuttonresponse',
('radiobuttonresponse') );
}
sub bubble_line_count {
my ( $numfoils, $bubbles_per_line ) = @_;
my $bubble_lines;
$bubble_lines = int( $numfoils / $bubbles_per_line );
if ( ( $numfoils % $bubbles_per_line ) != 0 ) {
$bubble_lines++;
}
return $bubble_lines;
}
sub start_radiobuttonresponse {
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::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)
. '
';
}
return $result;
}
sub whichfoils {
my ( $max, $randomize ) = @_;
my @truelist;
my @falselist;
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) );
&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;
}
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' ) )
{
$inc = 2;
}
$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 );
}
##
# Generate the HTML for a single html foil.
# @param $part - The part for which the response is being generated.
# @param $fieldname - The basename of the radiobutton field
# @param $name - The foilname.
# @param $last_responses - Reference to a hash that holds the most recent
# responses.
# @param $value - radiobutton value.
#
# @return text
# @retval The generated html.
#
sub html_radiobutton {
my ($part, $fieldname, $name, $last_responses, $value) = @_;
my $result='';
return $result;
}
##
# Return a reference to the last response hash. This hash has exactly
# one or zero entries. The one entry is keyed by the foil 'name' of
# the prior response
#
# @param $part - Number of the problem part.
#
# @return reference to a hash.
# @retval see above.
#
sub get_last_response {
my ($part) = @_;
my $id = $Apache::inputtags::response['-1'];
my ( $lastresponse, $newvariation );
if ((( $Apache::lonhomework::history{"resource.$part.type"} eq 'randomizetry')
|| ( $Apache::lonhomework::type eq 'randomizetry' )
)
&& ( $Apache::inputtags::status[-1] eq 'CAN_ANSWER' )
)
{
if ( $env{ 'form.' . $part . '.rndseed' } ne
$Apache::lonhomework::history{"resource.$part.rndseed"} )
{
$newvariation = 1;
}
}
unless ($newvariation) {
$lastresponse =
$Apache::lonhomework::history{"resource.$part.$id.submission"};
}
my %lastresponse = &Apache::lonnet::str2hash($lastresponse);
return \%lastresponse;
}
##
# Display foils in html rendition.:
#
# @param $whichfoils - Set of foils to display.
# @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 $result;
# if the answers get shown, we need to label each item as correct or
# incorrect.
if ($show_answer) {
my $item_pretext = ' '; # html prior to each item
my $item_posttext = ''; # html after each item.
my $finalclose = ''; # html to close off the whole shebang
# Horizontal layout is a table with each foil in a cell
if ($direction eq 'horizontal') {
$result = '
';
$item_pretext = '
' . $item_pretext;
$item_posttext = '
';
$finalclose = '
';
}
foreach my $name (@{$whichfoils}) {
# If the item gets further surrounded by tags, this
# holds the closures for those tages.
my $item_closetag = '';
$result .= $item_pretext;
# Label each foil as correct or incorrect:
if ($Apache::response::foilgroup{$name . '.value'} eq 'true') {
$result .= &mt('Correct:') . '';
$item_closetag .= '';
} else {
$result .= &mt('Incorrect');
}
# Web rendition encloses the
# item text in a label tag as well:
if ($target eq 'web') {
$result .= '' . $item_closetag;
}
$result .= $Apache::response::foilgroup{$name . '.text'};
$result .= $item_closetag;
$result .= $item_posttext;
$result .= "\n"; # make the html a bit more readable.
}
$result .= $finalclose;
} else {
$result .= ' '; # end line prior to foilgroup:
# Not showing the answers, we need to generate the HTML appropriate
# to allowing the student to respond.
my $item_pretext;
my $item_posttext;
my $lastresponse = &get_last_response($part);
if ( $direction eq 'horizontal' ) {
$item_pretext = '