# The LearningOnline Network with CAPA
# Full matching style response
#
# $Id: matchresponse.pm,v 1.78 2009/12/09 11:30:45 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::matchresponse;
use strict;
use HTML::Entities();
use Math::Random();
use Apache::optionresponse();
use Apache::lonlocal;
use Apache::lonnet;
use Apache::lonxml;
BEGIN {
&Apache::lonxml::register('Apache::matchresponse',('matchresponse'));
}
sub start_matchresponse {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result;
#when in a matchresponse use these
&Apache::lonxml::register('Apache::matchresponse',
('foilgroup','foil','conceptgroup','item',
'itemgroup'));
push (@Apache::lonxml::namespace,'matchresponse');
my $id = &Apache::response::start_response($parstack,$safeeval);
%Apache::hint::match=();
undef(%Apache::response::foilnames);
if ($target eq 'meta') {
$result=&Apache::response::meta_package_write('matchresponse');
} elsif ($target eq 'edit' ) {
$result.=&Apache::edit::start_table($token).
'
'.&Apache::edit::end_row()
.&Apache::edit::start_spanning_row()."\n";
}
return $result;
}
sub end_foilgroup {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result;
my $part = $Apache::inputtags::part;
my $response_id = $Apache::inputtags::response[-1];
if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || $target eq 'tex' || $target eq 'analyze') {
my $max = &Apache::lonxml::get_param('max',$parstack,$safeeval,'-2');
my $randomize = &Apache::lonxml::get_param('randomize',$parstack,
$safeeval,'-2');
if ($target eq 'web' || $target eq 'tex') {
$result=&displayfoils($target,$max,$randomize);
$Apache::lonxml::post_evaluate=0;
} elsif ($target eq 'answer' ) {
$result=&displayanswers($max,$randomize);
} elsif ( $target eq 'grade') {
&grade_response($max,$randomize);
} elsif ( $target eq 'analyze') {
my @shown=&whichfoils($max,$randomize);
&Apache::response::analyze_store_foilgroup(\@shown,
['text','value','location']);
#FIXME need to store options in some way
}
&Apache::lonxml::increment_counter(&getfoilcounts($max),
"$part.$response_id");
if ($target eq 'analyze') {
&Apache::lonhomework::set_bubble_lines();
}
} elsif ($target eq 'edit') {
$result=&Apache::edit::end_table();
}
&Apache::response::poprandomnumber();
return $result;
}
sub whichfoils {
my ($max,$randomize)=@_;
return &Apache::response::whichorder(&getfoilcounts($max),
$randomize,
&Apache::response::showallfoils(),
\%Apache::response::foilgroup);
}
sub displayanswers {
my ($max,$randomize,@opt)=@_;
if (!defined(@{ $Apache::response::foilgroup{'names'} })) { return; }
my @names = @{ $Apache::response::foilgroup{'names'} };
my @whichfoils = &Apache::response::whichorder(&getfoilcounts($max),
$randomize,
&Apache::response::showallfoils(),
\%Apache::response::foilgroup);
my %name_letter_map;
if (defined(%{ $Apache::response::itemgroup{'name_letter_map'} })) {
%name_letter_map=
%{ $Apache::response::itemgroup{'name_letter_map'} };
}
my $result;
if ($Apache::lonhomework::type eq 'exam') {
my $i=0;
foreach my $name (@whichfoils) {
$result.=&Apache::response::answer_header('matchresponse',$i++);
my $value_name=$Apache::response::foilgroup{$name.'.value'};
my $letter=$name_letter_map{$value_name};
$result.=&Apache::response::answer_part('matchresponse',$letter);
$result.=&Apache::response::answer_footer('matchresponse');
}
} else {
$result=&Apache::response::answer_header('matchresponse');
foreach my $name (@whichfoils) {
my $value_name=$Apache::response::foilgroup{$name.'.value'};
my $letter=$name_letter_map{$value_name};
$result.=&Apache::response::answer_part('matchresponse',$letter);
}
$result.=&Apache::response::answer_footer('matchresponse');
}
return $result;
}
sub grade_response {
my ($max,$randomize)=@_;
my (@whichfoils)=&Apache::response::whichorder(&getfoilcounts($max),
$randomize,
&Apache::response::showallfoils(),
\%Apache::response::foilgroup);
if (!&Apache::response::submitted()) { return; }
my %responsehash;
my %grade;
my ($temp,$right,$wrong,$ignored)=(1,0,0,0);
my %letter_name_map;
if (defined(%{ $Apache::response::itemgroup{'letter_name_map'} })) {
%letter_name_map=
%{ $Apache::response::itemgroup{'letter_name_map'} };
}
my @items;
foreach my $name (@whichfoils) {
my $response = &Apache::response::getresponse($temp,'letter');
push(@items,$response);
my $responsename = $letter_name_map{$response};
my $value=$Apache::response::foilgroup{$name.'.value'};
if ( $response =~ /[^\s]/) {
$responsehash{$name}=$responsename;
&Apache::lonxml::debug("submitted a $response($responsename) for $value \n");
if ($value eq $responsename) {
$grade{$name}='1'; $right++;
} else {
$grade{$name}='0'; $wrong++;
}
} else {
$ignored++;
}
$temp++;
}
my $part=$Apache::inputtags::part;
my $id = $Apache::inputtags::response['-1'];
my $responsestr=&Apache::lonnet::hash2str(%responsehash);
my $itemstr =&Apache::lonnet::array2str(@items);
my $gradestr =&Apache::lonnet::hash2str(%grade);
my %previous=&Apache::response::check_for_previous($responsestr,$part,$id);
&Apache::lonxml::debug("Got $right right and $wrong wrong, and $ignored were ignored ");
$Apache::lonhomework::results{"resource.$part.$id.submission"}=
$responsestr;
$Apache::lonhomework::results{"resource.$part.$id.submissionitems"}=
$itemstr;
$Apache::lonhomework::results{"resource.$part.$id.submissiongrading"}=
$gradestr;
if ($Apache::lonhomework::type eq 'survey') {
if ($ignored == 0) {
my $ad=$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}='SUBMITTED';
&Apache::response::handle_previous(\%previous,$ad);
} elsif ($wrong==0 && $right==0) {
} else {
my $ad=$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}='MISSING_ANSWER';
&Apache::response::handle_previous(\%previous,$ad);
}
} elsif (!$Apache::lonhomework::scantronmode) {
my $ad;
if ($wrong==0 && $ignored==0) {
$ad='EXACT_ANS';
} elsif ($wrong==0 && $right==0) {
#nothing submitted
} else {
if ($ignored==0) {
$ad='INCORRECT';
} else {
$ad='MISSING_ANSWER';
}
}
$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$ad;
&Apache::response::handle_previous(\%previous,$ad);
} else {
my $ad;
if ($wrong==0 && $right==0) {
#nothing submitted
} else {
$ad='ASSIGNED_SCORE';
$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=
$ad;
$Apache::lonhomework::results{"resource.$part.$id.awarded"}=
$right/(scalar(@whichfoils));
$Apache::lonhomework::results{"resource.$part.$id.numfoils"}=
scalar(@whichfoils);
}
}
}
sub format_prior_answer {
my ($mode,$answer,$other_data) = @_;
my %answer =&Apache::lonnet::str2hash($answer);
my $foil_order =$other_data->[0];
my %grading =&Apache::lonnet::str2hash($other_data->[1]);
my @items =&Apache::lonnet::str2array($other_data->[2]);
my $output;
foreach my $name (@{ $foil_order }) {
my $item=shift(@items);
$output .= '
'.$item.'
';
}
return if (!defined($output));
$output = '
'.$output.'
';
return $output;
}
sub itemdisplay {
my ($location)=@_;
if ($location eq 'top' &&
!defined($Apache::matchresponse::itemtable{'location'})) {
return $Apache::matchresponse::itemtable{'display'};
}
if ($Apache::matchresponse::itemtable{'location'} eq $location) {
return $Apache::matchresponse::itemtable{'display'};
}
return undef;
}
sub displayfoils {
my ($target,$max,$randomize)=@_;
my ($tabsize, $lefttabsize, $righttabsize);
my $result;
my $question;
my (@whichfoils)=&Apache::response::whichorder(&getfoilcounts($max),
$randomize,
&Apache::response::showallfoils(),
\%Apache::response::foilgroup);
my $part=$Apache::inputtags::part;
my $solved=$Apache::lonhomework::history{"resource.$part.solved"};
my %letter_name_map;
if (defined(%{ $Apache::response::itemgroup{'letter_name_map'} })) {
%letter_name_map=
%{ $Apache::response::itemgroup{'letter_name_map'} };
}
my %name_letter_map;
if (defined(%{ $Apache::response::itemgroup{'name_letter_map'} })) {
%name_letter_map=
%{ $Apache::response::itemgroup{'name_letter_map'} };
}
if ( &Apache::response::show_answer() && ($target ne 'tex')) {
foreach my $name (@whichfoils) {
my $text=$Apache::response::foilgroup{$name.'.text'};
my $value=$Apache::response::foilgroup{$name.'.value'};
my $letter=$name_letter_map{$value};
if ($target eq 'tex') {
$question.=' \\\\ '.$letter.':'.$text;
} else {
$question.=' '.$letter.': '.$text;
}
}
} else {
my $i = 0;
my $temp=1;
my $id=$Apache::inputtags::response[-1];
my $part=$Apache::inputtags::part;
my $lastresponse=$Apache::lonhomework::history{"resource.$part.$id.submission"};
my %lastresponse=&Apache::lonnet::str2hash($lastresponse);
my @alphabet=('A'..'Z');
my @used_letters=sort(keys(%letter_name_map));
my $internal_counter=$Apache::lonxml::counter;
foreach my $name (@whichfoils) {
my $lastopt=$lastresponse{$name};
my $last_letter=$name_letter_map{$lastopt};
my $optionlist = '';
if ($target ne 'tex') {
$optionlist="\n";
} else {
if ($Apache::lonhomework::type ne 'exam') {
if($env{'form.pdfFormFields'} eq 'yes'
&& $Apache::inputtags::status['-1'] eq 'CAN_ANSWER') {
my $fieldname = $env{'request.symb'} . '&part_'. $Apache::inputtags::part .'&matchresponse'. '&HWVAL_' . $Apache::inputtags::response['-1'] . ':' . $temp . '&submit_' . $Apache::inputtags::part . '&';
$optionlist = &Apache::lonxml::print_pdf_start_combobox($fieldname);
} else {
$optionlist='\framebox[10 mm][s]{\tiny\strut}';
}
}
}
my $option;
foreach $option (@used_letters) {
if ($option eq $last_letter) {
if ($target ne 'tex') {
$optionlist.="\n";
} elsif ($target eq 'tex' && $env{'form.pdfFormFields'} eq 'yes'
&& $Apache::inputtags::status['-1'] eq 'CAN_ANSWER') {
$optionlist .= &Apache::lonxml::print_pdf_add_combobox_option($option);
}
} else {
if ($target ne 'tex') {
$optionlist.="\n";
} elsif ($target eq 'tex' && $env{'form.pdfFormFields'} eq 'yes'
&& $Apache::inputtags::status['-1'] eq 'CAN_ANSWER') {
$optionlist .= &Apache::lonxml::print_pdf_add_combobox_option($option);
}
}
}
if ($target ne 'tex' && $Apache::lonhomework::type ne 'exam') {
$optionlist='\n";
}
my $text=$Apache::response::foilgroup{$name.'.text'};
#
# Factor out the tex computations of the left/right 1/2 minipage
# widths for left or right positioning. This allows us
# to, if necessary constrain the bubble widths:
#
if ($target eq 'tex' &&
(&itemdisplay('left') || &itemdisplay('right'))) {
$tabsize=&Apache::londefdef::recalc($env{'form.textwidth'});
($lefttabsize,$righttabsize)=(0,0);
if ($Apache::matchresponse::TeXitemgroupwidth ne '') {
$Apache::matchresponse::TeXitemgroupwidth=~/(\d*.?\d*)/;
$lefttabsize=$tabsize*$1/100;
$righttabsize=0.95*($tabsize-$lefttabsize);
} else {
$tabsize=~/(\d+\.?\d*)/;
$lefttabsize=$1/2.1;
$righttabsize=0.95*($1-$lefttabsize);
}
}
if ($target ne 'tex') {
if ($Apache::lonhomework::type ne 'exam') {
$question.=" \n".$optionlist.$text;
} else {
$question.=" \n".$text;
}
if ($Apache::lonhomework::type eq 'exam') {
my @blank;
$question.=&Apache::optionresponse::webbubbles(\@used_letters,\@blank,$temp,$last_letter);
}
} else {
# Note that if left or right positioned, we must
# confine the bubbles to righttabsize:
#
if ($Apache::lonhomework::type eq 'exam' && $env{'form.pdfFormFields'} ne 'yes') {
$question.=' '.$optionlist.$text."\n";
my @emptyItems = ();
for (my $i=0;$i<=$#used_letters;$i++) {push @emptyItems, ' ';}
$question.='\vskip -1 mm\noindent\begin{list}{}{\setlength{\listparindent}{0mm}\setlength{\leftmargin}{2mm}}'
.'\item \hskip -3mm \textbf{'.$internal_counter.'}';
if (&itemdisplay('left') || &itemdisplay('right')) {
$question .= '\vskip -4 mm' . &Apache::optionresponse::bubbles(\@used_letters,\@emptyItems, "", $righttabsize);
}
else {
$question .= '\vskip -4 mm' . &Apache::optionresponse::bubbles(\@used_letters,\@emptyItems);
}
$question .= '\end{list} \vskip -8 mm \strut ';
$internal_counter++;
} else {
if($env{'form.pdfFormFields'} eq 'yes'
&& $Apache::inputtags::status['-1'] eq 'CAN_ANSWER') {
$question .= " $optionlist ". &Apache::lonxml::print_pdf_end_combobox($text).'\strut';
} else {
$question.=' '.$optionlist.$text.'\strut\\\\\strut '."\n";
}
}
}
$temp++;
}
}
if ($result=&itemdisplay('top')) {
$result.=$question;
} elsif ($result=&itemdisplay('bottom')) {
$result=$question.$result;
} elsif ($result=&itemdisplay('right')) {
if ($target ne 'tex') {
#remove the first
$question=~s| ||;
$result='
'.$question.
'
'.$result.'
';
} else {
$lefttabsize.=' mm ';
$righttabsize.=' mm ';
$result='\setlength{\tabcolsep}{1 mm}\begin{tabular}{p{'.$righttabsize.'}p{'.$lefttabsize.'}}\begin{minipage}{'.$righttabsize.'}'.$question.'\end{minipage}&\begin{minipage}{'.$lefttabsize.'}'.$result.'\end{minipage}\end{tabular}';
}
} elsif ($result=&itemdisplay('left')) {
if ($target ne 'tex') {
#remove the first
$question=~s| ||;
$result='
'.$result.
'
'.$question.'
';
} else {
$lefttabsize.=' mm ';
$righttabsize.=' mm ';
$result='\setlength{\tabcolsep}{1 mm}\begin{tabular}{p{'.$lefttabsize.'}p{'.$righttabsize.'}}\begin{minipage}{'.$lefttabsize.'}'.$result.'\end{minipage}&\begin{minipage}{'.$righttabsize.'}'.$question.'\end{minipage}\end{tabular}';
}
}
if ($target eq 'web') {
&Apache::response::setup_prior_tries_hash(\&format_prior_answer,
[\@whichfoils,
'submissiongrading',
'submissionitems']);
}
if ($target ne 'tex') {$result.=" ";} else {$result.=' \\\\ ';}
return $result;
}
sub getfoilcounts {
my ($max)=@_;
# +1 since instructors will count from 1
my $count = $#{ $Apache::response::foilgroup{'names'} }+1;
if (&Apache::response::showallfoils()) { $max=$count; }
if ($count>$max) { $count=$max }
&Apache::lonxml::debug("Count is $count from $max");
return $count;
}
sub start_conceptgroup {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
$Apache::matchresponse::conceptgroup=1;
%Apache::response::conceptgroup=();
my $result;
if ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,
"Concept Grouped Foils");
$result.=&Apache::edit::text_arg('Concept:','concept',$token,'50').
&Apache::edit::end_row().&Apache::edit::start_spanning_row();
}
if ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args($token,$parstack,
$safeeval,'concept');
if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); }
}
return $result;
}
sub end_conceptgroup {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
$Apache::matchresponse::conceptgroup=0;
my $result='';
if ($target eq 'web' || $target eq 'grade' || $target eq 'answer' ||
$target eq 'tex' || $target eq 'analyze') {
&Apache::response::pick_foil_for_concept($target,
['value','text','location'],
\%Apache::hint::match,
$parstack,$safeeval);
} elsif ($target eq 'edit') {
$result=&Apache::edit::end_table();
}
return $result;
}
sub insert_conceptgroup {
my $result="\n\t\t".&insert_foil()."\n\t\t\n";
return $result;
}
sub start_foil {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') {
&Apache::lonxml::startredirection;
if ($target eq 'analyze') {
&Apache::response::check_if_computed($token,$parstack,$safeeval,'value');
}
} elsif ($target eq 'edit') {
$result=&Apache::edit::tag_start($target,$token,"Foil");
my $level='-2';
if ($$tagstack[-2] eq 'conceptgroup') { $level = '-3'; }
$result.=&Apache::edit::text_arg('Name:','name',$token);
my @names;
if (defined(@{ $Apache::response::itemgroup{'names'} })) {
@names=@{ $Apache::response::itemgroup{'names'} };
}
$result.= &Apache::edit::select_or_text_arg('Correct Option:','value',['unused',@names],$token,'15');
my $randomize=&Apache::lonxml::get_param('randomize',$parstack,
$safeeval,'-3');
if ($randomize ne 'no') {
$result.=&Apache::edit::select_arg('Location:','location',
['random','top','bottom'],$token);
}
$result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args($token,$parstack,
$safeeval,'value',
'name','location');
if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); }
}
return $result;
}
sub end_foil {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $text ='';
my $result = '';
if ($target eq 'web' || $target eq 'tex' || $target eq 'analyze') {
$text=&Apache::lonxml::endredirection;
}
if ($target eq 'web' || $target eq 'grade' || $target eq 'answer' ||
$target eq 'tex' || $target eq 'analyze') {
if ($target eq 'tex' && $Apache::lonhomework::type eq 'exam') {
$text='\vskip 5mm $\triangleright$ '.$text;
}
my $value = &Apache::lonxml::get_param('value',$parstack,$safeeval);
if ($value ne 'unused') {
my $name = &Apache::lonxml::get_param('name',$parstack,$safeeval);
&Apache::lonxml::debug("Got a name of :$name:");
if (!$name) {
&Apache::lonxml::warning(&mt('Foils without names exist. This can cause problems to malfunction.'));
$name=$Apache::lonxml::curdepth;
}
&Apache::lonxml::debug("Using a name of :$name:");
if (defined($Apache::response::foilnames{$name})) {
&Apache::lonxml::error(&mt("Foil name [_1] appears more than once. Foil names need to be unique.",''.$name.''));
}
$Apache::response::foilnames{$name}++;
my $location =&Apache::lonxml::get_param('location',$parstack,
$safeeval);
if ( $Apache::matchresponse::conceptgroup
&& !&Apache::response::showallfoils() ) {
push @{ $Apache::response::conceptgroup{'names'} }, $name;
$Apache::response::conceptgroup{"$name.value"} = $value;
$Apache::response::conceptgroup{"$name.text"} = $text;
$Apache::response::conceptgroup{"$name.location"} = $location;
} else {
push @{ $Apache::response::foilgroup{'names'} }, $name;
$Apache::response::foilgroup{"$name.value"} = $value;
$Apache::response::foilgroup{"$name.text"} = $text;
$Apache::response::foilgroup{"$name.location"} = $location;
}
}
}
if ($target eq 'edit') {
$result.= &Apache::edit::tag_end($target,$token,'');
}
return $result;
}
sub insert_foil {
return '
';
}
1;
__END__