--- loncom/homework/structuretags.pm 2001/05/04 21:21:45 1.36
+++ loncom/homework/structuretags.pm 2004/08/25 19:16:25 1.265
@@ -1,380 +1,1356 @@
# The LearningOnline Network with CAPA
# definition of tags that give a structure to a document
-# 2/19 Guy
+#
+# $Id: structuretags.pm,v 1.265 2004/08/25 19:16:25 sakharuk 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::structuretags;
use strict;
use Apache::lonnet;
+use Apache::File();
+use Apache::lonmenu;
+use Apache::lonlocal;
+use Apache::lonxml;
-sub BEGIN {
- &Apache::lonxml::register('Apache::structuretags',('block','while','randomlist','problem','web','tex','part','preduedate','postanswerdate','solved','notsolved','startouttext','endouttext'));
+BEGIN {
+ &Apache::lonxml::register('Apache::structuretags',('block','languageblock','instructorcomment','while','randomlist','problem','library','web','tex','part','preduedate','postanswerdate','solved','notsolved','problemtype','startouttext','endouttext','simpleeditbutton','definetag'));
}
sub start_web {
- my ($target,$token,$parstack,$parser,$safeeval)=@_;
- my $bodytext=&Apache::lonxml::get_all_text("/web",$$parser[$#$parser]);
- if ($target eq 'web') {
- return $bodytext;
- }
- return '';
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
+ my $bodytext=&Apache::lonxml::get_all_text("/web",$parser);
+ if ($target eq 'web') {
+ return $bodytext;
+ }
+ return '';
}
sub end_web {
+ return '';
}
sub start_tex {
- my ($target,$token,$parstack,$parser,$safeeval)=@_;
- my $bodytext=&Apache::lonxml::get_all_text("/tex",$$parser[$#$parser]);
- if ($target eq 'tex') {
- return $bodytext
- }
- return '';
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
+ my $result='';
+ my $bodytext=&Apache::lonxml::get_all_text("/tex",$parser);
+ if ($target eq 'tex') {
+ return $bodytext.' ';
+ }
+ return $result;;
}
sub end_tex {
+ return '';
+}
+
+sub page_start {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
+ my %found;
+ foreach my $taginside (@$tagstack) {
+ foreach my $taglookedfor ('html','body','form') {
+ if ($taginside =~ /^$taglookedfor$/i) {$found{$taglookedfor} = 1;}
+ }
+ }
+
+ my $result;
+ my $head_tag_start;
+ if (!defined($found{'html'})) {
+ $result=&Apache::londefdef::start_html($target,$token,$tagstack,
+ $parstack,$parser,$safeeval);
+ $head_tag_start='
'.&Apache::lonmenu::registerurl(undef,$target).
+ &Apache::lonhtmlcommon::htmlareaheaders().
+ &Apache::lonhtmlcommon::spellheader();
+ }
+ my $body_tag_start;
+ if (!defined($found{'body'})) {
+ $body_tag_start=''.&Apache::lonmenu::menubuttons(undef,$target,1);
+ if ($target eq 'web' && $ENV{'request.state'} ne 'construct') {
+ my ($symb,undef,undef,undef,$publicuser)=
+ &Apache::lonxml::whichuser();
+ if ($symb eq '' && !$publicuser) {
+ my $help = &Apache::loncommon::help_open_topic("Ambiguous_Reference");
+ $help=&mt("Browsing resource, all submissions are temporary.")." ";
+ $body_tag_start.=$help;
+ }
+ }
+ $body_tag_start.=&Apache::lonxml::message_location();
+ }
+ my $form_tag_start;
+ if (!defined($found{'form'})) {
+ $form_tag_start='\n\n";
+}
+
+sub option {
+ my ($value,$name) = @_;
+ my $result ="
+ ".&option('CAN_ANSWER' ,'problemstate').&mt("Answerable")."
+ ".&option('CANNOT_ANSWER_tries' ,'problemstate').&mt("Open with full tries")."
+ ".&option('CANNOT_ANSWER_correct','problemstate').&mt("Open and correct")."
+ ".&option('SHOW_ANSWER' ,'problemstate').&mt("Show Answer")."
+
+
+
+Problem Type:
+
+
+
+Feedback Mode:
+
+
+
+";
+ my $numtoanalyze=$ENV{'form.numtoanalyze'};
+ if (!$numtoanalyze) { $numtoanalyze=20; }
+ $result.= ' for
+ '.&mt('versions of this problem').
+ '.'.&Apache::loncommon::help_open_topic("Analyze_Problem",
+ '',undef,undef,300).
+ '';
+ return $result;
+}
+
+sub initialize_storage {
+ %Apache::lonhomework::results=();
+ %Apache::lonhomework::history=();
+ my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
+ if ($ENV{'request.state'} eq 'construct' || $symb eq '') {
+ %Apache::lonhomework::history=
+ &Apache::lonnet::tmprestore($ENV{'request.uri'},'',$domain,$name);
+ my ($temp)=keys %Apache::lonhomework::history ;
+ &Apache::lonxml::debug("Return message of $temp");
+ } else {
+ %Apache::lonhomework::history=
+ &Apache::lonnet::restore($symb,$courseid,$domain,$name);
+ }
+ #ignore error conditions
+ my ($temp)=keys %Apache::lonhomework::history ;
+ if ($temp =~ m/^error:.*/) { %Apache::lonhomework::history=(); }
+}
+
+# -------------------------------------------------------------finalize_storage
+# Stores away the result has to a student's environment
+# checks form.grade_ for specific values, other wises stores
+# to the running users environment
+sub finalize_storage {
+ my $result;
+ my ($temp) = keys %Apache::lonhomework::results;
+ if ( $temp ne '' ) {
+ my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
+ if ($ENV{'request.state'} eq 'construct' || $symb eq '') {
+ $Apache::lonhomework::results{'rndseed'}=$ENV{'form.rndseed'};
+ $result=&Apache::lonnet::tmpstore(\%Apache::lonhomework::results,
+ $ENV{'request.uri'},'',$domain,$name);
+ &Apache::lonxml::debug('Construct Store return message:'.$result);
+ } else {
+ $result=&Apache::lonnet::cstore(\%Apache::lonhomework::results,
+ $symb,$courseid,$domain,$name);
+ &Apache::lonxml::debug('Store return message:'.$result);
+ }
+ }
+ return $result;
+}
+
+sub checkout_msg {
+ my %lt=&Apache::lonlocal::texthash(
+ 'resource'=>'The resource needs to be checked out',
+ 'id_expln'=>'As a resource gets checked out, a unique timestamped ID is given to it, and a permanent record is left in the system.',
+ 'warning'=>'Checking out resources is subject to course policies, and may exclude future credit even if done erroneously.',
+ 'checkout'=>'Check out Exam for Viewing',
+ 'checkout?'=>'Check out Exam?');
+ return (<$lt{'resource'}
+
$lt{'id_expln'}
+
+
$lt{'warning'}
+
+
+ENDCHECKOUT
+}
+
+sub firstaccess_msg {
+ my ($time,$symb)=@_;
+ my ($map)=&Apache::lonnet::decode_symb($symb);
+ my $foldertitle=&Apache::lonnet::gettitle($map);
+ &Apache::lonxml::debug("map is $map title is $foldertitle");
+ return (<The resources in "$foldertitle" are open for a limited time. Once you click the 'Show Resource' button below you have $time to complete all resources "$foldertitle".
+
+ENDCHECKOUT
+}
+
+sub init_problem_globals {
+ my ($type)=@_;
+ #initialize globals
+ if ($type eq 'problem') {
+ $Apache::inputtags::part='0';
+ @Apache::inputtags::partlist=('0');
+
+ $Apache::lonhomework::problemstatus=&get_problem_status('0')
+ } else {
+ $Apache::inputtags::part='';
+ @Apache::inputtags::partlist=();
+ $Apache::lonhomework::problemstatus='';
+ }
+ @Apache::inputtags::responselist = ();
+ @Apache::inputtags::importlist = ();
+ @Apache::inputtags::previous=();
+ @Apache::inputtags::previous_version=();
+ $Apache::structuretags::printanswer='No';
+ @Apache::structuretags::whileconds=();
+ @Apache::structuretags::whilebody=();
+ @Apache::structuretags::whileline=();
+ $Apache::lonhomework::scantronmode=0;
+ undef($Apache::lonhomework::name);
+
+}
+
+sub reset_problem_globals {
+ my ($type)=@_;
+ undef(%Apache::lonhomework::history);
+ undef(%Apache::lonhomework::results);
+ undef($Apache::inputtags::part);
+#don't undef this, lonhomework.pm takes care of this, we use this to
+#detect if we try to do 2 problems in one file
+# undef($Apache::lonhomework::parsing_a_problem);
+ undef($Apache::lonhomework::name);
+}
+
+sub set_problem_state {
+ my ($part)=@_;
+ if ($ENV{'form.problemstate'} eq 'CANNOT_ANSWER_correct') {
+ $Apache::lonhomework::history{"resource.$part.solved"}=
+ 'correct_by_student';
+ }
+}
+
+sub get_problem_status {
+ my ($part)=@_;
+ my $problem_status=&Apache::lonnet::EXT("resource.$part.problemstatus");
+ &Apache::lonxml::debug("problem status for $part is $problem_status");
+ &Apache::lonxml::debug("env probstat is ".$ENV{'form.problemstatus'});
+ if ($ENV{'request.state'} eq 'construct' &&
+ defined($ENV{'form.problemstatus'})) {
+ $problem_status=$ENV{'form.problemstatus'};
+ }
+ return $problem_status;
}
sub start_problem {
- my ($target,$token,$parstack,$parser,$safeeval)=@_;
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
-#intialize globals
- $Apache::inputtags::part='0';
- @Apache::inputtags::responselist = ();
-
-#adeed vars to the scripting enviroment
- my $expression='$external::part='.$Apache::inputtags::part.';';
- &Apache::run::run($expression,$safeeval);
- my $status;
- my $datemsg;
-
- my $result=&Apache::londefdef::start_html($target,$token,$parstack,$parser,$safeeval);
-
- if ($target eq 'web' || $target eq 'grade') {
- ($status,$datemsg) = &Apache::lonhomework::check_date('0');
- push (@Apache::inputtags::status,$status);
- my $expression='$external::datestatus="'.$status.'";';
- $expression.='$external::gradestatus="'.$Apache::lonhomework::history{"resource.0.solved"}.'";';
+ if ( $Apache::inputtags::part ne '' ||
+ $Apache::lonhomework::parsing_a_problem) {
+ &Apache::lonxml::error('Only one <problem> allowed in a .problem file');
+ #my $bodytext=&Apache::lonxml::get_all_text("/problem",$parser);
+ return '';
+ }
+
+ $Apache::lonhomework::parsing_a_problem=1;
+ &init_problem_globals('problem');
+
+ if (defined($ENV{'scantron.maxquest'})) {
+ $Apache::lonhomework::scantronmode=1;
+ }
+
+ &initialize_storage();
+ if ($target ne 'analyze') {
+ if ($target eq 'web') {
+ &Apache::lonhomework::showhash(%Apache::lonhomework::history);
+ }
+ if ($ENV{'request.state'} eq 'construct') { &set_problem_state('0'); }
+ $Apache::lonhomework::type=&Apache::lonnet::EXT('resource.0.type');
+ if (($ENV{'request.state'} eq 'construct') &&
+ defined($ENV{'form.problemtype'})) {
+ $Apache::lonhomework::type=$ENV{'form.problemtype'};
+ }
+ &Apache::lonxml::debug("Found this to be of type :$Apache::ltonhomework::type:");
+ }
+ if ($Apache::lonhomework::type eq '' ) {
+ my $uri=$ENV{'request.uri'};
+ if ($uri=~/\.(\w+)$/) {
+ $Apache::lonhomework::type=$1;
+ &Apache::lonxml::debug("Using type of $1");
+ } else {
+ $Apache::lonhomework::type='problem';
+ &Apache::lonxml::debug("Using default type, problem, :$uri:");
+ }
+ }
+
+ #added vars to the scripting enviroment
+ my $expression='$external::part=\''.$Apache::inputtags::part.'\';';
+ $expression.='$external::type=\''.$Apache::lonhomework::type.'\';';
&Apache::run::run($expression,$safeeval);
- if ( $status eq 'CLOSED' ) {
- my $bodytext=&Apache::lonxml::get_all_text("/problem",$$parser[$#$parser]);
- if ( $target eq "web" ) {
- return $result." Problem is not open to be viewed. The problem $datemsg ";
- }
- }
- }
- if ($target eq 'web') {
- my $args ='';
- if ( $#$parstack > -1 ) { $args=$$parstack[$#$parstack]; }
- my $name = &Apache::run::run("{$args;".'return $name}',$safeeval);
- if ($name eq '') {
- $name=&Apache::lonnet::EXT('resource.title');
- if ($name eq 'con_lost') { $name = ''; }
+ my $status;
+ my $accessmsg;
+
+ #should get back a or the neccesary stuff to start XML/MathML
+ my ($result,$head_tag_start,$body_tag_start,$form_tag_start)=
+ &page_start($target,$token,$tagstack,$parstack,$parser,$safeeval);
+ if ($target eq 'tex' and $ENV{'request.symb'} =~ m/\.page_/) {$result='';}
+
+ if ($target eq 'analyze') { my $rndseed=&setup_rndseed($safeeval); }
+ if ($target eq 'web' || $target eq 'grade' || $target eq 'answer' ||
+ $target eq 'tex') {
+ #handle exam checkout
+ if ($Apache::lonhomework::type eq 'exam') {
+ my $token=
+ $Apache::lonhomework::history{"resource.0.outtoken"};
+ if (($ENV{'form.doescheckout'}) && (!$token)) {
+ $token=&Apache::lonxml::maketoken();
+ $Apache::lonhomework::history{"resource.0.outtoken"}=
+ $token;
+ }
+ $body_tag_start.=&Apache::lonxml::printtokenheader($target,$token);
+ }
+ if ($ENV{'form.markaccess'}) {
+ &Apache::lonnet::set_first_access('map');
+ }
+ #handle rand seed in construction space
+ my $rndseed=&setup_rndseed($safeeval);
+ my ($symb)=&Apache::lonxml::whichuser();
+ if ($ENV{'request.state'} ne "construct" && $symb eq '') {
+ $form_tag_start.=''.
+ ''.
+ ' ';
+ }
+ ($status,$accessmsg) = &Apache::lonhomework::check_access('0');
+ push (@Apache::inputtags::status,$status);
+ my $expression='$external::datestatus="'.$status.'";';
+ $expression.='$external::gradestatus="'.$Apache::lonhomework::history{"resource.0.solved"}.'";';
+ &Apache::run::run($expression,$safeeval);
+ &Apache::lonxml::debug("Got $status");
+ if (( $status eq 'CLOSED' ) ||
+ ( $status eq 'UNCHECKEDOUT') ||
+ ( $status eq 'NOT_YET_VIEWED') ||
+ ( $status eq 'BANNED') ||
+ ( $status eq 'UNAVAILABLE') ||
+ ( $status eq 'INVALID_ACCESS')) {
+ my $bodytext=&Apache::lonxml::get_all_text("/problem",$parser);
+ if ( $target eq "web" ) {
+ $result.= $head_tag_start.'';
+ my $msg=$body_tag_start;
+ if ($status eq 'UNAVAILABLE') {
+ $msg.='
'.&mt('Unable to determine if this resource is open due to network problems. Please try again later.').'
';
+ } elsif ($status ne 'NOT_YET_VIEWED') {
+ $msg.='
'.&mt('Not open to be viewed').'
';
+ }
+ if ($status eq 'CLOSED' || $status eq 'INVALID_ACCESS') {
+ $msg.='The problem '.$accessmsg;
+ } elsif ($status eq 'UNCHECKEDOUT') {
+ $msg.=&checkout_msg;
+ } elsif ($status eq 'NOT_YET_VIEWED') {
+ $msg.=&firstaccess_msg($accessmsg,$symb);
+ }
+ $result.=$msg.' ';
+ } elsif ($target eq 'tex') {
+ $result.='\begin{document}\noindent \vskip 1 mm \begin{minipage}{\textwidth}\vskip 0 mm';
+ if ($status eq 'UNAVAILABLE') {
+ $result.=&mt('Unable to determine if this resource is open due to network problems. Please try again later.').'\vskip 0 mm ';
+ } else {
+ $result.=&mt('Problem is not open to be viewed. It')." $accessmsg \\vskip 0 mm ";
+ }
+ }
+ } elsif ($target eq 'web') {
+ my $name= &get_resource_name($parstack,$safeeval);
+ $result.="$head_tag_start$name
+ $body_tag_start \n $form_tag_start".
+ '';
+ # create a page header and exit
+ if ($ENV{'request.state'} eq "construct") {
+ $result.= &problem_web_to_edit_header($ENV{'form.rndseed'});
+ }
+ # if we are viewing someone else preserve that info
+ if (defined $ENV{'form.grade_symb'}) {
+ foreach my $field ('symb','courseid','domain','username') {
+ $result .= ''."\n";
+ }
+ }
+ } elsif ($target eq 'tex') {
+ my $startminipage = '';
+ if (not $ENV{'form.problem_split'}=~/yes/) {
+ $startminipage = '\begin{minipage}{\textwidth}';
+ }
+ my $id = $Apache::inputtags::part;
+ my $weight = &Apache::lonnet::EXT("resource.$id.weight");
+ my $packages=&Apache::lonnet::metadata($ENV{'request.uri'},'packages');
+ my @packages = split /,/,$packages;
+ my $allow_print_points = 0;
+ foreach my $partial_key (@packages) {
+ if ($partial_key=~m/^part_0$/) {
+ $allow_print_points=1;
+ }
+ }
+ my $duedate = &Apache::lonnet::EXT("resource.$id.duedate");
+ $duedate = POSIX::strftime("%c",localtime($duedate));
+ my $temp_file;
+ my $filename = "/home/httpd/prtspool/$ENV{'user.name'}_$ENV{'user.domain'}_printout.due";
+ if (-e $filename) {
+ $temp_file = Apache::File->new($filename);
+ } else {
+ $temp_file = Apache::File->new('>>'.$filename);
+ }
+ my @due_file_content = <$temp_file>;
+ my $due_file_content = $due_file_content[$#due_file_content];
+ chomp $due_file_content;
+ my $name_of_resourse= &Apache::lonxml::latex_special_symbols(&get_resource_name($parstack,$safeeval),'header');
+ if ($due_file_content ne $duedate) {
+ $temp_file = Apache::File->new('>'.$filename);
+ print $temp_file "$duedate\n";
+ if (not $ENV{'request.symb'} =~ m/\.page_/) {
+ if(not $duedate=~m/1969/ and $Apache::lonhomework::type ne 'exam') {
+ $result .= '\begin{document} \typeout{STAMPOFPASSEDRESOURCESTART Resource