[BACK]Return to lonhomework.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / homework
File:  [LON-CAPA] / loncom / homework / lonhomework.pm
Revision 1.51: download - view: text, annotated - select for diffs
Mon Aug 6 18:24:37 2001 UTC (22 years, 8 months ago) by harris41
Branches: MAIN
CVS tags: HEAD
beautify

# The LON-CAPA homework handler
# 
# Handles homework.
#
# YEAR=2000
# 7/25,8/2,8/7,8/8,8/11,9/14,9/19,10/2,10/5,10/11,11/7,11/21 Guy Albertelli
# 11/30 Gerd Kortemeyer
# 12/4,12/8,12/12,12/15,12/19,12/21 Guy Albertelli
# YEAR=2001
# 1/6,1/8,1/9,1/10,1/11,1/12,1/15,1/25,2/7,2/13,2/19,4/16,4/26 Guy Albertelli
# 5/4,5/13,5/21 Guy Albertelli
# 6/1 Gerd Kortemeyer
# 6/5,6/12,6/26,7/2,7/18 Guy Albertelli
# 8/6 Scott Harrison

package Apache::lonhomework;
use strict;
use Apache::style;
use Apache::lonxml;
use Apache::lonnet;
use Apache::inputtags;
use Apache::structuretags;
use Apache::response;
use Apache::hint;
use Apache::outputtags;
use Apache::Constants qw(:common);
#use Time::HiRes qw( gettimeofday tv_interval );

# ======================================================================= BEGIN
sub BEGIN {
  &Apache::lonxml::register_insert();
}

# =============================================== Get target (returns an array)
sub get_target {
    if ( $ENV{'request.state'} eq "published") {
	if ( defined $ENV{'form.submitted'}) {
	    return ('grade','web');
	} else {
	    return ('web');
	}
    } elsif ($ENV{'request.state'} eq "construct") {
	if ( defined $ENV{'form.preview'}) {
	    if ( defined $ENV{'form.submitted'}) {
		return ('grade','web');
	    } else {
		return ('web');
	    }
	} else {
	    if ( $ENV{'form.problemmode'} eq 'View' ) {
		if ( defined $ENV{'form.submitted'}) {
		    return ('grade','web');
		} else {
		    return ('web');
		}
	    } elsif ( $ENV{'form.problemmode'} eq 'Edit' ) {
		if ( $ENV{'form.submitted'} eq 'edit' ) {
		    return ('modified','edit');
		} else {
		    return ('edit');
		}
	    } else {
		return ('web');
	    }
	}
    }
    return ();
}

# ===================================== Set up variables (return scalar string)
sub setup_vars {
    my ($target) = @_;
    return ';'
#  return ';$external::target='.$target.';';
}

# ================================================================= Send header
sub send_header {
    my ($request) = @_;
    $request->print(&Apache::lontexconvert::header());
#  $request->print('<form name='.$ENV{'form.request.prefix'}.'lonhomework method="POST" action="'.$request->uri.'">');
}

# ================================================================= Create menu
sub createmenu {
    my ($which,$request) = @_;
    if ($which eq 'grade') {
	$request->print('<script language="JavaScript">'."\n".
 		       'hwkmenu=window.open("/res/adm/pages/homeworkmenu.html'.
		      '","homeworkremote","height=350,width=150,menubar=no");'.
		      '</script>');
    }
}

# ================================================================= Send footer
sub send_footer {
    my ($request) = @_;
#  $request->print('</form>');
    $request->print(&Apache::lontexconvert::footer());
}

$Apache::lonxml::browse = '';

# =============================================== Check date (returns an array)
sub check_date {
    my ($id) = @_;
    my $date ='';
    my $status = '';
    my $datemsg = '';
    my $lastdate = '';
    my $temp;
    my $type;
    my $passed;
    &Apache::lonxml::debug("checking for part :$id:");
    foreach $temp ("opendate","duedate","answerdate") {
	$lastdate = $date;
	$date = &Apache::lonnet::EXT("resource.$id.$temp");
	&Apache::lonxml::debug("found :$date: for :$temp:");
	if ($date eq '') {
	    $date = "an unknown date"; $passed = 0;
	} elsif ($date eq 'con_lost') {
	    $date = "an indeterminate date"; $passed = 0;
	} else {
	    if (time < $date) { $passed = 0; } else { $passed = 1; }
	    $date = localtime $date;
	}
	if (!$passed) { $type = $temp; last; }
    }
    &Apache::lonxml::debug("have :$type:$passed:");
    if ($passed) {
	$status = 'SHOW_ANSWER';
	$datemsg = $date;
    } elsif ($type eq 'opendate') {
	$status = 'CLOSED';
	$datemsg = "will open on $date";
    } elsif ($type eq 'duedate') {
	$status = 'CAN_ANSWER';
	$datemsg = "is due at $date";
    } elsif ($type eq 'answerdate') {
	$status = 'CLOSED';
	$datemsg = "was due on $lastdate, and answers will be available on ".
	           "$date";
    }
    if ($status eq 'CAN_ANSWER') {
	#check #tries
	my $tries = $Apache::lonhomework::history{"resource.$id.tries"};
	my $maxtries = &Apache::lonnet::EXT("resource.$id.maxtries");
	if ( $tries eq '' ) { $tries = '0'; }
	if ( $maxtries eq '' ) { $maxtries = '2'; } 
	if ($tries >= $maxtries) { $status = 'CANNOT_ANSWER'; } 
    }
    &Apache::lonxml::debug("sending back :$status:$datemsg:");
    if (($Apache::lonhomework::browse eq 'F') && ($status eq 'CLOSED')) {
	&Apache::lonxml::debug("should be allowed to browse a resource when ".
			       "closed");
	$status = 'CAN_ANSWER';
	$datemsg = 'is closed but you are allowed to view it';
    }
    if ($ENV{'request.state'} eq "construct") {
	&Apache::lonxml::debug("in construction ignoring dates");
	$status = 'CAN_ANSWER';
	$datemsg = 'is in under construction';
    }
    return ($status,$datemsg);
}

# ================================================================== Shows hash
sub showhash {
    my (%hash) = @_;
    my $resultkey;
    foreach $resultkey (sort keys %hash) {
	&Apache::lonxml::debug("$resultkey ---- $hash{$resultkey}");
    }
    &Apache::lonxml::debug("\n<br />restored values^</br>\n");
    return '';
}

# =========================================================== Setup permissions
sub setuppermissions {
    $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',
						     $ENV{'request.filename'});
    $Apache::lonhomework::viewgrades = &Apache::lonnet::allowed('vgr',
						    $ENV{'request.course.id'});
    return '';
}

# ================================================================ Setup header
sub setupheader {
    my $request = $_[0];
    if ($ENV{'browser.mathml'}) {
	$request->content_type('text/xml');
    } else {
	$request->content_type('text/html');
    }
    $request->send_http_header;
    return OK if $request->header_only;
    return '';
}

# ========================================================= Handle save or undo
sub handle_save_or_undo {
    my ($request,$problem,$result) = @_;
    my $fileout = &Apache::lonnet::filelocation("",$request->uri);
    my $filesave = $fileout.".bak";
    if ($ENV{'form.Undo'} eq 'undo') {
	if (copy($filesave,$fileout)) {
	    $request->print("<b>Undid changes, Copied $filesave to $fileout".
			    "<br /></b>");
	} else {
	    $request->print("<font color=\"red\" size=\"+1\"><b>Unable to ".
			    "undo, unable to copy $filesave to $fileout<br ".
			    "/></b></font>");
	}
    } else {
	my $fs=Apache::File->new(">$filesave");
	if (defined($fs)) {
	    print $fs $$problem;
	    $request->print("<b>Making Backup to $filesave</b><br />");
	} else {
	    $request->print("<font color=\"red\" size=\"+1\"><b>Unable to ".
			    "make backup $filesave</b></font>");
	}
	my $fh=Apache::File->new(">$fileout");
	if (defined($fh)) {
	    print $fh $$result;
	    $request->print("<b>Saving Modifications to $fileout</b><br />");
	} else {
	    $request->print("<font color=\"red\" size=\"+1\"><b>Unable to ".
			    "write to $fileout</b></font>");
	}
    }
}

# ================================================================= Render page
sub renderpage {
    my ($request,$file) = @_;
    
    my (@targets) = &get_target();
    foreach my $target (@targets) {
	#my $t0 = [&gettimeofday()];
	my $problem=&Apache::lonnet::getfile($file);
	if ($problem == -1) {
	    &Apache::lonxml::error("<b> Unable to find <i>$file</i></b>");
	    $problem='';
	}
	
	my %mystyle;
	my $result = '';
	&Apache::inputtags::initialize_inputtags;
	&Apache::edit::initialize_edit;
	%Apache::lonhomework::results=();
	%Apache::lonhomework::history=&Apache::lonnet::restore();
	#ignore error conditions
	my ($temp)=keys %Apache::lonhomework::history ;
	if ($temp =~ m/^error:.*/) { %Apache::lonhomework::history=(); } 
	if ($target eq 'web') {
	    if (&Apache::lonnet::symbread() eq '') {
		if ($ENV{'request.state'} eq "construct") {
		    $request->print("In construction space, submissions ".
				    "ignored<br />");
		} else {
		    $request->print("Browsing or <a href=\"/adm/ambiguous\">".
				    "ambiguous</a> reference, submissions ".
				    "ignored<br />");
		}
	    }
	    #if ($Apache::lonhomework::viewgrades eq 'F') {&createmenu('grade',$request); }
	}
	if ($target eq 'grade') { &showhash(%Apache::lonhomework::history); }
	
	my $default=&Apache::lonnet::getfile('/home/httpd/html/res/adm/'.
					     'includes/default_homework.lcpm');
	if ($default == -1) {
	    &Apache::lonxml::error("<b>Unable to find <i>default_homework.".
				   "lcpm</i></b>");
	    $default='';
	}
	$result = &Apache::lonxml::xmlparse($target, $problem,
					    $default.&setup_vars($target),
					    %mystyle);
	#$request->print("Result follows:");
	if ($target eq 'modified') {
	    &handle_save_or_undo($request,\$problem,\$result);
	} else {
	    #my $td=&tv_interval($t0);
	    #if ( $Apache::lonxml::debug) {
	    #$result =~ s:</body>::;
	    #$result.="<br />Spent $td seconds processing target $target\n</body>";
	    #}
	    $request->print($result);
	}
	#$request->print(":Result ends");
	if ($target eq 'grade') { &showhash(%Apache::lonhomework::results); }
	
	#store new values
	my ($temp) = keys %Apache::lonhomework::results;
	if ( $temp ne '' ) {
	    &Apache::lonxml::debug("Store return message:".
		      &Apache::lonnet::cstore(\%Apache::lonhomework::results));
	}
	#my $td=&tv_interval($t0);
    }
}

# =========================================================== Get template list
# with no arg it returns a HTML <option> list of the template titles
# with one arg it returns the filename associated with the arg passed
sub get_template_list {
    my ($namewanted,$extension) = @_;
    my $result;
    &Apache::lonxml::debug("Looking for :$extension:");
    foreach my $file
	(</home/httpd/html/res/adm/includes/templates/*.$extension>) {
	my $name=&Apache::lonnet::metadata($file,'title');
	if ($namewanted && ($name eq $namewanted)) {
	    $result=$file;
	    last;
	} else {
	    $result.="<option>$name</option>";
	}
    }
    return $result;
}

# ================================================================= New problem
sub newproblem {
    my ($request) = @_;
    my $extension = $request->uri;
    $extension =~ s:^.*\.([\w]+)$:$1:;
    &Apache::lonxml::debug("Looking for :$extension:");
    if ($ENV{'form.template'}) {
	use File::Copy;
	my $file = &get_template_list($ENV{'form.template'},$extension);
	my $dest = &Apache::lonnet::filelocation("",$request->uri);
	copy($file,$dest);
	&renderpage($request,$file);
    } else {
	my $templatelist = &get_template_list('',$extension);
	my $url = $request->uri;
	my $dest = &Apache::lonnet::filelocation("",$request->uri);
	$request->print(<<ENDNEWPROBLEM);
<body bgcolor="#FFFFFF">
The request file $url doesn\'t exist. You can create a new $extension <br />
<form action="$url" method="POST">
<input type="submit" value="New $extension"><br />
<select name="template">
$templatelist
</select>
</form>
</body>
ENDNEWPROBLEM
  }

  return '';
}

sub view_or_edit_menu {
    my ($request) = @_;
    my $url = $request->uri;
    $request->print(<<EDITMENU);
<body bgcolor="#FFFFFF">
<form action="$url" method="POST">
Would you like to <input type="submit" name="problemmode" value="View"> or
<input type="submit" name="problemmode" value="Edit"> the problem.
</form>
</body>
EDITMENU
}

# ===================================================================== Handler
sub handler {
    #my $t0 = [&gettimeofday()];
    my $request = $_[0];

    if ( $ENV{'user.name'} eq 'albertel' ) {$Apache::lonxml::debug = 1;}

  if (&setupheader($request)) { return OK; }
  $ENV{'request.uri'} = $request->uri;

  #setup permissions
    $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',
						     $ENV{'request.filename'});
    $Apache::lonhomework::viewgrades = &Apache::lonnet::allowed('vgr',
						    $ENV{'request.course.id'});
    &Apache::lonxml::debug("Permissions:".
			   $Apache::lonhomework::browse.":".
			   $Apache::lonhomework::viewgrades.":");

    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') {
	    #should know where we are, so ask
	    $request->internal_redirect('/adm/ambiguous'); return;
	}
    }

    if ($ENV{'request.state'} eq "construct") {
	if ( -e $file ) {
	    if (!(defined $ENV{'form.problemmode'})) {
		#first visit to problem in construction space
		&view_or_edit_menu($request);
		#&renderpage($request,$file);
	    } else {
		&renderpage($request,$file);
      }
	} else {
	    # requested file doesn't exist in contruction space
	    &newproblem($request);
	}
    } else {
	# just render the page normally outside of construction space
	&renderpage($request,$file);
    }
    #my $td=&tv_interval($t0);
    #&Apache::lonxml::debug("Spent $td seconds processing");
    # &Apache::lonhomework::send_footer($request);
    # always turn off debug messages
    $Apache::lonxml::debug=0;
    return OK;
}

1;

__END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>