File:  [LON-CAPA] / loncom / homework / bridgetask.pm
Revision 1.15: download - view: text, annotated - select for diffs
Tue May 3 05:31:51 2005 UTC (18 years, 11 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- if uploaded filetypes isn't set can upload any file
- added a lot of debuggin info
- actaully compiles now
- wroks correctly in the null case
- add non-fuctional submissions buttons to improve the look of grade mode
- if no user to grade don't show criteria

# The LearningOnline Network with CAPA 
# definition of tags that give a structure to a document
#
# $Id: bridgetask.pm,v 1.15 2005/05/03 05:31:51 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/
#
###


package Apache::bridgetask; 

use strict;
use Apache::lonnet;
use Apache::File();
use Apache::lonmenu;
use Apache::lonlocal;
use Apache::lonxml;
use Time::HiRes qw( gettimeofday tv_interval );

BEGIN {
    &Apache::lonxml::register('Apache::bridgetask',('Task','IntroParagraph','Dimension','Instance','InstanceText','Criteria','ClosingParagraph'));
}

sub initialize_bridgetask {
    # id of current Dimension, 0 means that no dimension is current 
    # (inside <Task> only)
    $Apache::bridgetask::dimension='';
    # list of all Dimension ids seen
    @Apache::bridgetask::dimensionlist=();
    # list of all current Instance ids
    @Apache::bridgetask::instance=();
    # list of all Instance ids seen in this problem
    @Apache::bridgetask::instancelist=();
    # key of queud user data that we are currently grading
    $Apache::bridgetask::queue_key='';
}

sub proctor_check_auth {
    my ($slot)=@_;
    my $user=$env{'form.proctorname'};
    my $domain=$env{'form.proctordomain'};
    
    my @allowed=split(",",$slot->{'proctor'});
    foreach my $possible (@allowed) {
	my ($puser,$pdom)=(split('@',$possible));
	if ($puser eq $user && $pdom eq $domain) {
	    my $authhost=&Apache::lonnet::authenticate($puser,$env{'form.proctorpassword'},$pdom);
	    if ($authhost ne 'no_host') {
		$Apache::lonhomework::results{'resource.checkedin'}=
		    $user.'@'.$domain;
		return 1;
	    }
	}
    }
    return 0;
}

sub add_previous_version_button {
    my $result;
    $result.=&mt(' Show a previously done version: [_1]','<select name="previousversion">
<option>Pick one</option>
</select>');
    return $result;
}

sub add_grading_button {
    my $result;
    $result.=' <input type="submit" name="gradeasubmission" value="'.
	&mt("Get a submission to grade").'" />';
    $result.='<input type="hidden" name="grade_target" value="webgrade" />';
    return $result;
}

sub start_Task {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;

    &Apache::structuretags::initialize_storage();
    &Apache::lonhomework::showhash(%Apache::lonhomework::history);
    my ($status,$accessmsg,$slot);
    $Apache::lonhomework::parsing_a_task=1;
    #should get back a <html> or the neccesary stuff to start XML/MathML
    my ($result,$head_tag_start,$body_tag_start,$form_tag_start)=
	&Apache::structuretags::page_start($target,$token,$tagstack,$parstack,$parser,$safeeval);

    if ($target eq 'web') {
	$body_tag_start.=&add_previous_version_button();
	if ($Apache::lonhomework::modifygrades) {
	    $body_tag_start.='<form name="gradesubmission" method="POST" action="';
	    my $uri=$env{'request.uri'};
	    if ($env{'request.enc'}) { $uri=&Apache::lonenc::encrypted($uri); }
	    $body_tag_start.=$uri.'">'.&add_grading_button()."</form>";
	}
    }
    if ($target eq 'web' || $target eq 'grade' || $target eq 'answer' ||
	$target eq 'tex') {
	($status,$accessmsg,my $slot_name,$slot) = 
	    &Apache::lonhomework::check_task_access('0');
	push(@Apache::inputtags::status,$status);
	$Apache::inputtags::slot_name=$slot_name;
	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 'BANNED') ||
	    ( $status eq 'UNAVAILABLE') ||
	    ( $status eq 'NOT_IN_A_SLOT') ||
	    ( $status eq 'NEEDS_CHECKIN') ||
	    ( $status eq 'INVALID_ACCESS')) {
	    my $bodytext=&Apache::lonxml::get_all_text("/task",$parser);
	    if ( $target eq "web" ) {
		$result.= $head_tag_start.'</head>'.$body_tag_start;
		my $msg;
		if ($status eq 'UNAVAILABLE') {
		    $msg.='<h1>'.&mt('Unable to determine if this resource is open due to network problems. Please try again later.').'</h1>';
		} elsif ($status eq 'NOT_IN_A_SLOT') {
		    $msg.='<h1>'.&mt('You are not currently signed up to work at this time and/or place.').'</h1>';
		} elsif ($status eq 'NEEDS_CHECKIN') {
		    $msg.='<h1>'.&mt('You need the Proctor to validate you.').
			'</h1>'.&proctor_validation_screen($slot);
		} elsif ($status ne 'NOT_YET_VIEWED') {
		    $msg.='<h1>'.&mt('Not open to be viewed').'</h1>';
		}
		if ($status eq 'CLOSED' || $status eq 'INVALID_ACCESS') {
		    $msg.='The problem '.$accessmsg;
		}
		$result.=$msg.'<br />';
	    } 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 'grade') {
		if ($status eq 'NEEDS_CHECKIN') {
		    if (&proctor_check_auth($slot)) {
			#FIXME immeadiatly add this to the grading queue
                        #      with slot->{'endtime'} for when grading can 
                        #      begin on this resource
 		    }
		}
	    }
	} elsif ($target eq 'web') {
	    my $name= &Apache::structuretags::get_resource_name($parstack,$safeeval);
	    $result.="$head_tag_start<title>$name</title></head>
              $body_tag_start \n $form_tag_start".	
	      '<input type="hidden" name="submitted" value="yes" />';
	    # if we are viewing someone else preserve that info
	    if (defined $env{'form.grade_symb'}) {
		foreach my $field ('symb','courseid','domain','username') {
		    $result .= '<input type="hidden" name="grade_'.$field.
			'" value="'.$env{"form.grade_$field"}.'" />'."\n";
		}
	    }
	}
    } elsif ($target eq 'webgrade') {
	$result.=$head_tag_start.$body_tag_start.$form_tag_start;
	$result.=&show_queue();
	my $todo=&get_from_queue();
	if ($todo) {
	    my ($symb,$uname,$udom)=&decode_queue_key($todo);
	    $result.="\n".'<table><tr><td>Found'.
		$symb.':'.$uname.':'.$udom.'</td></tr></table>';
	    $result.='<input type="hidden" name="gradingkey" value="'.
		&HTML::Entites::encode($todo).'" />';
	    $Apache::bridgetask::queue_key=$todo;
	} else {
	    $result.="\n".
		'<table><tr><td>No user to be graded.</td></tr></table>';
	    my $bodytext=&Apache::lonxml::get_all_text("/task",$parser);
	}
	
    } else {
	# page_start returned a starting result, delete it if we don't need it
	$result = '';
    }
    return $result;
}

sub end_Task {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $result='';
    my $status=$Apache::inputtags::status['-1'];
    if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
	$target eq 'tex') {
	if (
	    (($target eq 'web') && ($env{'request.state'} ne 'construct')) ||
	    ($target eq 'answer') || ($target eq 'tex')
	   ) {
	    if ($target eq 'web') {
		if ($status eq 'CAN_ANSWER') {
		    $result.="\n".'<table border="1">'.
			&Apache::inputtags::file_selector('0',"bridgetask","*",
							  'portfolioonly').
							  "</table>";
		    $result.=&Apache::inputtags::gradestatus('0');
		}
	    } 
	    if ($target eq 'web' || $target eq 'webgrade') {
		$result.=&Apache::lonxml::xmlend().'</html>';
	    }
	}
	if ($target eq 'grade') {
	    my $award='SUBMITTED';
	    &Apache::essayresponse::file_submission('0','bridgetask','portfiles',\$award);
	    if ($award eq 'SUBMITTED' &&
		$Apache::lonhomework::results{"resource.0.bridgetask.portfiles"}) {
		$Apache::lonhomework::results{"resource.0.tries"}=
		    1+$Apache::lonhomework::history{"resource.0.tries"};
	    }
	    $Apache::lonhomework::results{"resource.0.award"}=$award;
	    &Apache::lonhomework::showhash(%Apache::lonhomework::results);
	    &Apache::structuretags::finalize_storage();
	    if ($award eq 'SUBMITTED') {
		&add_to_queue();
	    }
	}
    } elsif ($target eq 'webgrade') {
	$result.="\n<hr />";
	$result.='<input type="submit" name="next" value="'.
	    &mt('Save & Next').'" /> ';
	$result.='<input type="submit" name="end" value="'.
	    &mt('Save & Stop Grading').'" /> ';
	$result.='<input type="submit" name="end" value="'.
	    &mt('Throw Away & Stop Grading').'" /> ';
	$result.='</form>'.&Apache::loncommon::endbodytag().'</html>';
    } elsif ($target eq 'meta') {
	$result.='<parameter part="0" package="Task"></parameter>'."\n";
	#$result.=&Apache::response::meta_part_order();
	#$result.=&Apache::response::meta_response_order();
    }
    undef($Apache::lonhomework::parsing_a_task);
    return $result;
}

sub add_to_queue {
    my ($symb,$cid,$udom,$uname)=&Apache::lonxml::whichuser();
    my $cnum=$env{'course.'.$cid.'.num'};
    my $cdom=$env{'course.'.$cid.'.domain'};
    my %data;
    #$data{"$symb\0timestamp"}=time;
    $data{"$symb\0queue\0$uname\@$udom"}=[$Apache::inputtags::slot_name];
    &Apache::lonnet::put('gradingqueue',\%data,$cdom,$cnum);
}

sub show_queue {
    my $result;
    my ($symb,$cid,$udom,$uname)=&Apache::lonxml::whichuser();
    my $cnum=$env{'course.'.$cid.'.num'};
    my $cdom=$env{'course.'.$cid.'.domain'};
    my $regexp="^$symb\0queue";
    my %queue=&Apache::lonnet::dump('gradingqueue',$cdom,$cnum,$regexp);
    $result.="\n<h3>Current Queue</h3><table><tr><th>resource</th><th>user</th><th>Time available for grading</th></tr>";
    foreach my $key (sort(keys(%queue))) {
	my ($symb,undef,$user) = split("\0",$key);
	my ($uname,$udom) = split('@',$user);
	my $title=&Apache::lonnet::gettitle($symb);
	$result.="<tr><td>$title</td><td>$uname</td><td>";
	my $slot=$queue{$key}->[0];
	my %slot_data=&Apache::lonnet::get_slot($slot);
	$result.="End time: ".&Apache::lonlocal::locallocaltime($slot_data{'endtime'})."</td></tr>";
    }
    $result.="</table><hr />\n";
    return $result;
}

sub decode_queue_key {
    my ($key)=@_;
    my ($symb,undef,$user) = split("\0",$key);
    my ($uname,$udom) = split('@',$user);
    return ($symb,$uname,$udom);
}

sub queue_key_locked {
    my ($key,$cdom,$cnum)=@_;
    my ($key_locked,$value)=
	&Apache::lonnet::get('gradingqueue',["$key\0locked"],$cdom,$cnum);
    if ($key_locked eq "$key\0locked") {
	return $value;
    }
    return undef;
}

sub pick_from_queue_data {
    my ($check_section,$queue,$cdom,$cnum)=@_;
    foreach my $key (sort(keys(%$queue))) {
	my ($symb,$uname,$udom)=&decode_queue_key($key);
	if ($check_section) {
	    my $section=&Apache::lonnet::getsection($uname,$udom);
	    if ($section ne $check_section) {
		&Apache::lonnet::logthis("not my sec");
		next;
	    }
	}
	my $slot=$queue->{$key}[0];
	my %slot_data=&Apache::lonnet::get_slot($slot);
	if ($slot_data{'endtime'} > time) { 
	    &Apache::lonnet::logthis("not time");
	    next;
	}
	if (&queue_key_locked($key,$cdom,$cnum)) {
	    &Apache::lonnet::logthis("someone already has um.");
	    next;
	}
	return $key;
    }
    return undef;
}

sub find_mid_grade {
    my ($symb,$cdom,$cnum)=@_;
    my $todo=$env{'form.gradingkey'};
    my $me=$env{'user.name'}.'@'.$env{'user.domain'};
    if ($todo) {
	my $who=&queue_key_locked($todo,$cdom,$cnum);
	if ($who eq $me) { return $todo; }
    }
    my $regexp="^$symb\0.*\0locked\$";
    my %locks=&Apache::lonnet::dump('gradingqueue',$cdom,$cnum,$regexp);
    foreach my $key (keys(%locks)) {
	my $who=$locks{$key};
	if ($who eq $me) {
	    $todo=$key;
	    $todo=~s/\0locked$//;
	    return $todo;
	}
    }
    return undef;
}

sub get_from_queue {
    my $result;
    my ($symb,$cid,$udom,$uname)=&Apache::lonxml::whichuser();
    my $cnum=$env{'course.'.$cid.'.num'};
    my $cdom=$env{'course.'.$cid.'.domain'};
    my $todo;
    # FIXME need to find if I am 'mid grading'
    $todo=&find_mid_grade($symb,$cdom,$cnum);
    &Apache::lonnet::logthis("found ".join(':',&decode_queue_key($todo)));
    while (1) {
	my $starttime=time;
	&Apache::lonnet::put('gradingqueue',{"$symb\0timestamp"=>$starttime},
			     $cdom,$cnum);
	&Apache::lonnet::logthis("$starttime");
	my $regexp="^$symb\0queue\0";
	my %queue=&Apache::lonnet::dump('gradingqueue',$cdom,$cnum,$regexp);
	#make a pass looking for a user in my section
	if ($env{'request.course.sec'}) {
	    &Apache::lonnet::logthis("sce");
	    $todo=&pick_from_queue_data($env{'request.course.sec'},\%queue,
					$cdom,$cnum);
	    &Apache::lonnet::logthis("sce $todo");
	}
	# no one in our section so look for any user that is ready for grading
	if (!$todo) {
	    &Apache::lonnet::logthis("no sce");
	    $todo=&pick_from_queue_data($env{'request.course.sec'},\%queue,
					$cdom,$cnum);
	    &Apache::lonnet::logthis("no sce $todo");
	}
	# no user to grade 
	if (!$todo) { last; }
	&Apache::lonnet::logthis("got $todo");
	# otherwise found someone so lets try to lock them
	my $success=&Apache::lonnet::newput('gradingqueue',
					    {"$todo\0locked"=>
						 $env{'user.name'}.'@'.$env{'user.domain'}},
					   $cdom,$cnum);
	# someone else already picked them
	&Apache::lonnet::logthis("success $todo");
	if ($success ne 'ok') { next; }
	my (undef,$endtime)=
	    &Apache::lonnet::get('gradingqueue',["$symb\0timestamp"],
				 $cdom,$cnum);
	&Apache::lonnet::logthis("emd  $endtime");
	# someone else already modified the queue, 
	# perhaps our picked user wass already fully graded between
	# when we picked him and when we locked his record? so lets
	# double check.
	if ($endtime != $starttime) {
	    my ($key,$value)=
		&Apache::lonnet::get('gradingqueue',["$todo"],
				     $cdom,$cnum);
	    &Apache::lonnet::logthis("check  $key .. $value");
	    if ($key eq $todo && ref($value)) {
	    } else {
		&Apache::lonnet::del('gradingqueue',["$todo\0locked"],
				     $cdom,$cnum);
		&Apache::lonnet::logthis("del");
		next;
	    }
	}
	&Apache::lonnet::logthis("last $todo");
	last;
    }
    return $todo;
}

sub start_ClosingParagraph {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $result;
    if ($target eq 'web') {
    } elsif ($target eq 'webgrade') {
	&Apache::lonxml::startredirection();
    }
    return $result;
}

sub end_ClosingParagraph {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $result;
    if ($target eq 'web') {
    } elsif ($target eq 'webgrade') {
	&Apache::lonxml::endredirection();
    }
    return $result;
}

my %dimension;
sub start_Dimension {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    undef(%dimension);
    my $dim_id=$Apache::lonxml::curdepth;
    $Apache::bridgetask::dimension=$dim_id;
    push(@Apache::bridgetask::dimensionlist,$dim_id);
    undef(@Apache::bridgetask::instance);
    return '';
}

sub get_instance {
    #FIXME just grabbing the first one for now, need
    #to randomly pick one until all have been seen
    #then start repicking
    &Apache::response::pushrandomnumber();
    my @order=&Math::Random::random_permutation(@{$dimension{'instances'}});
    return $order[0];
}

sub end_Dimension {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $result;
    if ($target eq 'web') {
	my $instance=&get_instance();
	$result=$dimension{'intro'}.$dimension{$instance.'.text'};
    } elsif ($target eq 'webgrade') {
	my $instance=&get_instance();
	$result.="\n".'<table>';
	foreach my $id (@{$dimension{$instance.'.criterias'}}) {
	    $result.='<tr><td>'.
		$dimension{$instance.'.criteria.'.$id}.'</td></tr>';
	}
	$result.='</table>';
    }
    return $result;
}

sub start_IntroParagraph {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $result;
    if ($target eq 'web' || $target eq 'webgrade') {
	if ($tagstack->[-2] eq 'Dimension' || $target eq 'webgrade') {
	    &Apache::lonxml::startredirection();
	}
    }
    return $result;
}

sub end_IntroParagraph {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $result;
    if ($target eq 'web' || $target eq 'webgrade') {
	if ($tagstack->[-2] eq 'Dimension' || $target eq 'webgrade') {
	    $dimension{'intro'}=&Apache::lonxml::endredirection();
	}
    }
    return $result;
}

sub start_Instance {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    push(@{$dimension{'instances'}},$Apache::lonxml::curdepth);
    push(@Apache::bridgetask::instance,$Apache::lonxml::curdepth);
    push(@Apache::bridgetask::instancelist,$Apache::lonxml::curdepth);
    return '';
}

sub end_Instance {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    return '';
}

sub start_InstanceText {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    if ($target eq 'web' || $target eq 'webgrade') {
	&Apache::lonxml::startredirection();
    }
    return '';
}

sub end_InstanceText {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $instance_id=$Apache::bridgetask::instance[-1];
    if ($target eq 'web' || $target eq 'webgrade') {
	$dimension{$instance_id.'.text'}=&Apache::lonxml::endredirection();
    }
    return '';
}

sub start_Criteria {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    if ($target eq 'web' || $target eq 'webgrade') {
	&Apache::lonxml::startredirection();
    }
    return '';
}

sub end_Criteria {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
    my $instance_id=$Apache::bridgetask::instance[-1];
    if ($target eq 'web' || $target eq 'webgrade') {
	my $criteria=&Apache::lonxml::endredirection();
	my $id=$Apache::lonxml::curdepth;
	$dimension{$instance_id.'.criteria.'.$id}=$criteria;
	push(@{$dimension{$instance_id.'.criterias'}},$id);
    }
    return '';
}

sub proctor_validation_screen {
    my ($slot) = @_;
    my (undef,undef,$domain,$user) = &Apache::lonxml::whichuser();
    my $url=&Apache::lonnet::studentphoto($domain,$user,'jpg');
    $user=$env{'form.proctorname'};
    if ($env{'form.proctordomain'}) { $domain=$env{'form.proctordomain'}; }
    my $msg;
    if ($env{'form.proctorpassword'}) {
	$msg='<p><font color="red">'.&mt("Failed to authenticate the proctor.")
	    .'</font></p>';
    }
    my $result= (<<ENDCHECKOUT);
<h2>Proctor Validation</h2>
    <p>Your room's proctor needs to validate your access to this resource.</p>
    $msg
<form name="checkout" method="POST" action="$env{'request.uri'}">
<input type="hidden" name="validate" value="yes" />
<input type="hidden" name="submitted" value="yes" />
<table>
  <tr><td>Proctor's Username:</td><td><input type="string" name="proctorname" value="$user" /></td></tr>
  <tr><td>Password:</td><td><input type="password" name="proctorpassword" value="" /></td></tr>
  <tr><td>Proctor's Domain:</td><td><input type="string" name="proctordomain" value="$domain" /></td></tr>
</table>
<input type="submit" name="checkoutbutton" value="Validate"  /><br />
Student who should be logged in is:<br />
<img src="$url" /><br />
</form>
ENDCHECKOUT
    return $result;
}

1;
__END__

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