# The LearningOnline Network with CAPA
# definition of tags that give a structure to a document
#
# $Id: structuretags.pm,v 1.83 2002/03/01 00:23:04 albertel 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/
#
# 2/19 Guy
# 6/26/2001 fixed extra web display at end of tags
# 8/17,8/18,8/20 Gerd Kortemeyer
package Apache::structuretags;
use strict;
use Apache::lonnet;
BEGIN {
&Apache::lonxml::register('Apache::structuretags',('block','while','randomlist','problem','library','web','tex','part','preduedate','postanswerdate','solved','notsolved','startouttext','endouttext'));
# &Apache::lonxml::register_insert('problem','',('part','postanswerdate','preduedate'))
}
sub start_web {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
my $bodytext=&Apache::lonxml::get_all_text("/web",$$parser[$#$parser]);
if ($target eq 'web') {
return $bodytext;
}
return '';
}
sub end_web {
return '';
}
sub start_tex {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
my $bodytext=&Apache::lonxml::get_all_text("/tex",$$parser[$#$parser]);
if ($target eq 'tex') {
return $bodytext
}
return '';
}
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::lonxml::registerurl();
}
my $body_tag_start;
if (!defined($found{'body'})) {
$body_tag_start='';
}
return ($result,$head_tag_start,$body_tag_start);
}
sub initialize_storage {
%Apache::lonhomework::results=();
my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
if ($ENV{'request.state'} eq 'construct') {
%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') {
$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 {
return (<The resource needs to be checked out
As a resource gets checked out, a unique timestamped ID is given to it, and a
permanent record is left in the system.
Checking out resources is subject to course policies, and may exclude future
credit even if done erroneously.
ENDCHECKOUT
}
sub start_problem {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
# meta is called from lonpublisher, which doesn't uses the normal
# lonhomework method of parsing the file which means that inputtags
# won't get reset
if ( $Apache::inputtags::part ne '' && $target != 'meta' ) {
&Apache::lonxml::error('Only one problem allowed in a .problem file');
my $bodytext=&Apache::lonxml::get_all_text("/problem",$$parser[-1]);
return '';
}
#intialize globals
$Apache::inputtags::part='0';
@Apache::inputtags::responselist = ();
@Apache::inputtags::previous=();
&initialize_storage();
if ($target eq 'web') {
&Apache::lonhomework::showhash(%Apache::lonhomework::history);
}
$Apache::lonhomework::type=&Apache::lonnet::EXT('resource.0.type');
&Apache::lonxml::debug("Found this to be of type :$Apache::lonhomework::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.';';
&Apache::run::run($expression,$safeeval);
my $status;
my $accessmsg;
#should get back a or the neccesary stuff to start XML/MathML
my ($result,$head_tag_start,$body_tag_start)=
&page_start($target,$token,$tagstack,$parstack,$parser,$safeeval);
if ($target eq 'web' || $target eq 'grade' || $target eq 'answer') {
#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);
}
#handle rand seed in construction space
my $rndseed;
if ($ENV{'request.state'} eq "construct") {
$rndseed=$ENV{'form.rndseed'};
if (!$rndseed) {
$rndseed=time;
$ENV{'form.rndseed'}=$rndseed;
}
&Apache::run::run('$external::randomseed='.$rndseed.';',$safeeval);
}
($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);
if (( $status eq 'CLOSED' ) ||
( $status eq 'UNCHECKEDOUT') ||
( $status eq 'BANNED')) {
my $bodytext=&Apache::lonxml::get_all_text("/problem",$$parser[$#$parser]);
if ( $target eq "web" ) {
$result.= $head_tag_start.'';
my $msg=$body_tag_start.
'Not open to be viewed
';
if ($status eq 'CLOSED') {
$msg.='The problem '.$accessmsg;
} elsif ($status eq 'UNCHECKEDOUT') {
$msg.=&checkout_msg;
}
$result.=$msg.'
';
}
} elsif ($target eq 'web') {
my $name= &Apache::lonxml::get_param('name',$parstack,$safeeval);
if ($name eq '') {
$name=&Apache::lonnet::EXT('resource.title');
if ($name eq 'con_lost') { $name = ''; }
}
$Apache::lonhomework::name=$name;
if ($status eq 'CAN_ANSWER') {
# create a page header and exit
$result.="$head_tag_start$name\n
$body_tag_start\n