# The LearningOnline Network with CAPA
# The LON-CAPA Homework handler
#
# $Id: lonhomework.pm,v 1.302 2009/02/17 15:25:18 jms 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::lonhomework;
use strict;
use Apache::style();
use Apache::lonxml();
use Apache::lonnet;
use Apache::lonplot();
use Apache::inputtags();
use Apache::structuretags();
use Apache::randomlabel();
use Apache::response();
use Apache::hint();
use Apache::outputtags();
use Apache::caparesponse();
use Apache::radiobuttonresponse();
use Apache::optionresponse();
use Apache::imageresponse();
use Apache::essayresponse();
use Apache::externalresponse();
use Apache::rankresponse();
use Apache::matchresponse();
use Apache::chemresponse();
use Apache::drawimage();
use Apache::Constants qw(:common);
use Apache::loncommon();
use Apache::lonlocal;
use Time::HiRes qw( gettimeofday tv_interval );
use HTML::Entities();
use File::Copy();
# FIXME - improve commenting
BEGIN {
&Apache::lonxml::register_insert();
}
=pod
=item set_bubble_lines()
Called at analysis time to set the bubble lines
hash for the problem.. This should be called in the
end_problemtype tag in analysis mode.
We fetch the hash of part id counters from lonxml
and push them into analyze:{part_id.bubble_lines}.
=cut
sub set_bubble_lines {
my %bubble_counters = &Apache::lonxml::get_bubble_line_hash();
foreach my $key (keys(%bubble_counters)) {
$Apache::lonhomework::analyze{"$key.bubble_lines"} =
$bubble_counters{"$key"};
}
}
#
# Decides what targets to render for.
# Implicit inputs:
# Various session environment variables:
# request.state - published - is a /res/ resource
# uploaded - is a /uploaded/ resource
# contruct - is a /priv/ resource
# form.grade_target - a form parameter requesting a specific target
sub get_target {
&Apache::lonxml::debug("request.state = $env{'request.state'}");
if( defined($env{'form.grade_target'})) {
&Apache::lonxml::debug("form.grade_target= $env{'form.grade_target'}");
} else {
&Apache::lonxml::debug("form.grade_target ".
&mt("Undid changes, Switched [_1] and [_2]",
''.$filebak.
'',
''.$file.
'')." ".
&mt("Unable to undo, unable to switch [_1] and [_2]",
''.
$filebak.'',
''.
$file.'')." '.&mt('Response').' '.$part.' '.
&mt('is not analyzable at this time').' '.&mt('Found no analyzable responses in this problem, currently only Numerical, Formula and String response styles are supported.').'
";
$string.= &showhashsubset($elm,'.');
} else {
$string.="$elm,"
}
}
chop($string);
$string.=")";
return $string;
}
sub showhashsubset {
my ($hash,$keyre) = @_;
my $resultkey;
foreach $resultkey (sort keys %$hash) {
if ($resultkey !~ /$keyre/) { next; }
if (ref($$hash{$resultkey}) eq 'ARRAY' ) {
&Apache::lonxml::debug("$resultkey ---- ".
&showarray($$hash{$resultkey}));
} elsif (ref($$hash{$resultkey}) eq 'HASH' ) {
&Apache::lonxml::debug("$resultkey ---- $$hash{$resultkey}");
&showhashsubset($$hash{$resultkey},'.');
} else {
&Apache::lonxml::debug("$resultkey ---- $$hash{$resultkey}");
}
}
&Apache::lonxml::debug("\n
restored values^\n");
return '';
}
sub setuppermissions {
$Apache::lonhomework::browse= &Apache::lonnet::allowed('bre',$env{'request.filename'});
my $viewgrades = &Apache::lonnet::allowed('vgr',$env{'request.course.id'});
if (! $viewgrades &&
exists($env{'request.course.sec'}) &&
$env{'request.course.sec'} !~ /^\s*$/) {
$viewgrades = &Apache::lonnet::allowed('vgr',$env{'request.course.id'}.
'/'.$env{'request.course.sec'});
}
$Apache::lonhomework::viewgrades = $viewgrades;
if ($Apache::lonhomework::browse eq 'F' &&
$env{'form.devalidatecourseresdata'} eq 'on') {
my (undef,$courseid) = &Apache::lonnet::whichuser();
&Apache::lonnet::devalidatecourseresdata($env{"course.$courseid.num"},
$env{"course.$courseid.domain"});
}
my $modifygrades = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
if (! $modifygrades &&
exists($env{'request.course.sec'}) &&
$env{'request.course.sec'} !~ /^\s*$/) {
$modifygrades =
&Apache::lonnet::allowed('mgr',$env{'request.course.id'}.
'/'.$env{'request.course.sec'});
}
$Apache::lonhomework::modifygrades = $modifygrades;
my $queuegrade = &Apache::lonnet::allowed('mqg',$env{'request.course.id'});
if (! $queuegrade &&
exists($env{'request.course.sec'}) &&
$env{'request.course.sec'} !~ /^\s*$/) {
$queuegrade =
&Apache::lonnet::allowed('qgr',$env{'request.course.id'}.
'/'.$env{'request.course.sec'});
}
$Apache::lonhomework::queuegrade = $queuegrade;
return '';
}
sub unset_permissions {
undef($Apache::lonhomework::queuegrade);
undef($Apache::lonhomework::modifygrades);
undef($Apache::lonhomework::viewgrades);
undef($Apache::lonhomework::browse);
}
sub setupheader {
my $request=$_[0];
&Apache::loncommon::content_type($request,'text/html');
if (!$Apache::lonxml::debug && ($ENV{'REQUEST_METHOD'} eq 'GET')) {
&Apache::loncommon::no_cache($request);
}
# $request->set_last_modified(&Apache::lonnet::metadata($request->uri,
# 'lastrevisiondate'));
$request->send_http_header;
return OK if $request->header_only;
return ''
}
sub handle_save_or_undo {
my ($request,$problem,$result) = @_;
my $file = &Apache::lonnet::filelocation("",$request->uri);
my $filebak =$file.".bak";
my $filetmp =$file.".tmp";
my $error=0;
if ($env{'form.Undo'} eq &mt('undo')) {
my $error=0;
if (!&File::Copy::copy($file,$filetmp)) { $error=1; }
if ((!$error) && (!&File::Copy::copy($filebak,$file))) { $error=1; }
if ((!$error) && (!&File::Copy::move($filetmp,$filebak))) { $error=1; }
if (!$error) {
&Apache::lonxml::info("
'.&mt('List of possible answers').': ');
foreach my $part (sort(keys(%allparts))) {
if (defined(@{ $overall{$part.'.answer'} })) {
for (my $i=0;$i
');
}
} else {
$request->print(' ');
my %frequency;
foreach my $answer (sort {$a->[0] <=> $b->[0]} (@{ $overall{$part.'.answer'}[$i] })) {
$frequency{join("\0",@{ $answer })}++;
}
$request->print(''.&mt('Part').' '.$part);
if (scalar(@{ $overall{$part.'.answer'} }) > 1) {
$request->print(&mt(' Answer [_1]',$i+1));
}
$request->print(' ');
foreach my $answer (sort {(split("\0",$a))[0] <=> (split("\0",$b))[0]} (keys(%frequency))) {
$request->print(''.&mt('Answer').' '.&mt('Frequency').'
('
.&mt('click for example').') ');
}
$request->print(''.
join(' ',split("\0",$answer)).
' '.$frequency{$answer}.
'
';
if ($cols > 80) { $cols = 80; }
if ($cols < 70) { $cols = 70; }
if ($rows < 20) { $rows = 20; }
my $js =
&Apache::edit::js_change_detection().
&Apache::loncommon::resize_textarea_js().
&Apache::structuretags::setmode_javascript().
&Apache::lonhtmlcommon::dragmath_js("EditMathPopup");
my $only_body = ($env{'environment.remote'} eq 'off')? 0 : 1;
my $dragmath_button =
&Apache::lonhtmlcommon::dragmath_button("LC_editxmltext",1);
my $start_page =
&Apache::loncommon::start_page(&mt("EditXML [_1]",$file),$js,
{'no_auto_mt_title' => 1,
'only_body' => $only_body,
'add_entries' => {
'onresize' => q[resize_textarea('LC_editxmltext','LC_aftertextarea')],
'onload' => q[resize_textarea('LC_editxmltext','LC_aftertextarea')],
}});
$result.=$start_page.
&renderpage($request,$file,['no_output_web'],1).
''.&Apache::loncommon::end_page();
&Apache::lonxml::add_messages(\$result);
$request->print($result);
}
return '';
}
#
# Render the page in whatever target desired.
#
sub renderpage {
my ($request,$file,$targets,$return_string) = @_;
my @targets = @{$targets || [&get_target()]};
&Apache::lonhomework::showhashsubset(\%env,'form.');
&Apache::lonxml::debug("Running targets ".join(':',@targets));
my $overall_result;
foreach my $target (@targets) {
# FIXME need to do something intelligent when a problem goes
# from viewable to not viewable due to map conditions
#&setuppermissions();
#if ( $Apache::lonhomework::browse ne '2'
# && $Apache::lonhomework::browse ne 'F' ) {
# $request->print(" You most likely shouldn't see me.");
#}
#my $t0 = [&gettimeofday()];
my $output=1;
if ($target eq 'no_output_web') {
$target = 'web'; $output=0;
}
my $problem=&Apache::lonnet::getfile($file);
my $result;
if ($problem eq -1) {
$problem='';
my $filename=(split('/',$file))[-1];
my $error =
" ".&mt('Unable to find [_1]',
' '.$filename.'')
."";
$result.=
&Apache::loncommon::simple_error_page($request,'Not available',
$error);
return;
}
my %mystyle;
if ($target eq 'analyze') { %Apache::lonhomework::analyze=(); }
if ($target eq 'answer') { &showhash(%Apache::lonhomework::history); }
if ($target eq 'web') {&Apache::lonhomework::showhashsubset(\%env,'^form');}
&Apache::lonxml::debug("Should be parsing now");
$result .= &Apache::lonxml::xmlparse($request, $target, $problem,
&setup_vars($target),%mystyle);
&finished_parsing();
if (!$output) { $result = ''; }
#$request->print("Result follows:");
if ($target eq 'modified') {
&handle_save_or_undo($request,\$problem,\$result);
} else {
if ($target eq 'analyze') {
$result=&Apache::lonnet::hashref2str(\%Apache::lonhomework::analyze);
undef(%Apache::lonhomework::analyze);
}
#my $td=&tv_interval($t0);
#if ( $Apache::lonxml::debug) {
#$result =~ s:'.
&Apache::loncommon::helpLatexCheatsheet("Problem_Editor_XML_Index",
"Problem Editing Help").
' '.
&Apache::loncommon::help_open_menu(undef,undef,5,'Authoring').
'
The server encountered an internal error or misconfiguration and was unable to complete your request.
Please contact the server administrator at root@localhost to inform them of the time this error occurred, and the actions you performed just before this error.
More information about this error may be available in the server error log.
::;
#$result.="
Spent $td seconds processing target $target\n";
#}
# $request->print($result);
$overall_result.=$result;
# $request->rflush();
}
#$request->print(":Result ends");
#my $td=&tv_interval($t0);
}
if (!$return_string) {
&Apache::lonxml::add_messages(\$overall_result);
$request->print($overall_result);
$request->rflush();
} else {
return $overall_result;
}
}
sub finished_parsing {
undef($Apache::lonhomework::parsing_a_problem);
undef($Apache::lonhomework::parsing_a_task);
}
sub get_template_list {
my ($extension) = @_;
my $result;
my @allnames;
&Apache::lonxml::debug("Looking for :$extension:");
my $glob_extension = $extension;
if ($extension eq 'survey' || $extension eq 'exam') {
$glob_extension = 'problem';
}
my @files = glob($Apache::lonnet::perlvar{'lonIncludes'}.
'/templates/*.'.$glob_extension);
@files = map {[$_,&mt(&Apache::lonnet::metadata($_, 'title')),
(&Apache::lonnet::metadata($_, 'category')?&mt(&Apache::lonnet::metadata($_, 'category')):&mt('Miscellaneous')),
&mt(&Apache::lonnet::metadata($_, 'help'))]} (@files);
@files = sort {$a->[2].$a->[1] cmp $b->[2].$b->[1]} (@files);
my ($midpoint,$seconddiv,$numfiles);
$numfiles = 0;
foreach my $file (@files) {
next if ($file->[1] !~ /\S/);
$numfiles ++;
}
if ($numfiles > 0) {
$result = '
'."\n".'
'."\n".'
'."\n"; } return $result; } sub newproblem { my ($request) = @_; if ($env{'form.template'}) { my $file = $env{'form.template'}; my $dest = &Apache::lonnet::filelocation("",$request->uri); &File::Copy::copy($file,$dest); &renderpage($request,$dest); return; } my ($extension) = ($request->uri =~ m/\.(\w+)$/); &Apache::lonxml::debug("Looking for :$extension:"); my $templatelist=&get_template_list($extension); if ($env{'form.newfile'} && !$templatelist) { # no templates found my $templatefilename = $request->dir_config('lonIncludes').'/templates/blank.'.$extension; &Apache::lonxml::debug("$templatefilename"); my $dest = &Apache::lonnet::filelocation("",$request->uri); &File::Copy::copy($templatefilename,$dest); &renderpage($request,$dest); } else { my $url=&HTML::Entities::encode($request->uri,'<>&"'); my $shownurl=$url; $shownurl=~s-^/~-/priv/-; my $dest = &Apache::lonnet::filelocation("",$request->uri); my $errormsg; my $instructions; my $start_page = &Apache::loncommon::start_page("Create New $extension"); $request->print(" $start_page
$errormsg ".&mt("The requested file [_1] currently does not exist.", "$shownurl")."
".&mt("To create a new $extension, select a template from the". " list below. Then click on the \"Create $extension\" button.")."
".&Apache::loncommon::end_page()); } return; } sub update_construct_style { if ($env{'request.state'} eq "construct" && $env{'form.problemmode'} eq 'view' && defined($env{'form.submitted'}) && !defined($env{'form.resetdata'}) && !defined($env{'form.newrandomization'})) { if ((!$env{'form.style_file'} && $env{'construct.style'}) ||$env{'form.clear_style_file'}) { &Apache::lonnet::delenv('construct\\.style'); } elsif ($env{'form.style_file'} && $env{'construct.style'} ne $env{'form.style_file'}) { &Apache::lonnet::appenv({'construct.style' => $env{'form.style_file'}}); } } } sub handler { #my $t0 = [&gettimeofday()]; my $request=$_[0]; $Apache::lonxml::request=$request; $Apache::lonxml::debug=$env{'user.debug'}; $env{'request.uri'}=$request->uri; &setuppermissions(); my $file=&Apache::lonnet::filelocation("",$request->uri); #check if we know where we are if ($env{'request.course.fn'} && !&Apache::lonnet::symbread()) { # if we are browsing we might not be able to know where we are if ($Apache::lonhomework::browse ne 'F' && $env{'request.state'} ne "construct") { #should know where we are, so ask &unset_permissions(); $request->internal_redirect('/adm/ambiguous'); return OK; } } if (&setupheader($request)) { &unset_permissions(); return OK; } &Apache::lonxml::debug("Permissions:$Apache::lonhomework::browse:$Apache::lonhomework::viewgrades:$Apache::lonhomework::modifygrades:$Apache::lonhomework::queuegrade"); &Apache::lonxml::debug("Problem Mode ".$env{'form.problemmode'}); my ($symb) = &Apache::lonnet::whichuser(); &Apache::lonxml::debug('symb is '.$symb); if ($env{'request.state'} eq "construct") { if ( -e $file ) { &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['problemmode']); if (!(defined $env{'form.problemmode'})) { #first visit to problem in construction space $env{'form.problemmode'}= 'view'; &renderpage($request,$file); } elsif ($env{'form.problemmode'} eq 'editxml') { &editxmlmode($request,$file); } elsif ($env{'form.problemmode'} eq 'calcanswers') { &analyze($request,$file); } else { &update_construct_style(); &renderpage($request,$file); } } else { # requested file doesn't exist in contruction space &newproblem($request); } } else { # just render the page normally outside of construction space &Apache::lonxml::debug("not construct"); &renderpage($request,$file); } #my $td=&tv_interval($t0); #&Apache::lonxml::debug("Spent $td seconds processing"); # always turn off debug messages $Apache::lonxml::debug=0; &unset_permissions(); return OK; } 1; __END__