File:  [LON-CAPA] / loncom / homework / essayresponse.pm
Revision 1.61: download - view: text, annotated - select for diffs
Tue Apr 5 15:38:57 2005 UTC (19 years ago) by albertel
Branches: MAIN
CVS tags: HEAD
- refactor the essayresponse so that the file_submission logging checking can be reused

    1: # The LearningOnline Network with CAPA
    2: # essay (ungraded) style responses
    3: #
    4: # $Id: essayresponse.pm,v 1.61 2005/04/05 15:38:57 albertel Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: 
   29: package Apache::essayresponse;
   30: use strict;
   31: use Apache::lonxml();
   32: use Apache::lonnet();
   33: use Apache::lonlocal;
   34: 
   35: BEGIN {
   36:     &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
   37: }
   38: 
   39: sub start_essayresponse {
   40:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   41:     my $result;
   42:     my $id = &Apache::response::start_response($parstack,$safeeval);
   43:     if ($target eq 'meta') {
   44: 	$result=&Apache::response::meta_package_write('essayresponse');
   45:     } elsif ($target eq 'web') {
   46: 	my $part= $Apache::inputtags::part;
   47: 	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
   48: 	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
   49: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
   50:         $uploadedfiletypes=~s/[^\w\,]//g;
   51: 	$result='<br /><table border="1">';
   52: 	$result.='<tr><td>'.
   53: 	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
   54: 	    &mt('Submit entries below as answer to receive credit').' <br />'.
   55: 	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
   56: 	    &mt('Save entries below as a draft answer (not submitting them for credit yet)').
   57: 	    ' </td></tr>';
   58: 	if ($ncol > 0) {
   59: 	    $result .='<tr><td>'.
   60: 		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
   61: 		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
   62: 		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$ENV{'user.domain'}).'<br />';
   63: 	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
   64: 	    $result .='</td></tr>';
   65: 	}
   66: 	$result.=&Apache::inputtags::file_selector($part,$id,
   67: 						   $uploadedfiletypes,'both');
   68:         $result.='</table>';
   69:     }
   70:     return $result;
   71: }
   72: 
   73: sub end_essayresponse {
   74:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   75:     my $part          = $Apache::inputtags::part;
   76:     my $id            = $Apache::inputtags::response[-1];
   77:     my $increment     = 1;
   78:     my $result;
   79:     if ( $target eq 'grade' ) {
   80: 	my $collaborators = $ENV{'form.HWCOL'.$part.'_'.$id};	
   81: 	if ($collaborators =~ /[^\s]/) {
   82: 	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
   83: 	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
   84: 		if ($collaborators ne $previous_list);
   85: 	}
   86: 	if (  &Apache::response::submitted('scantron') ) {
   87: 	    $increment=&Apache::response::scored_response($part,$id);
   88: 	} elsif ( &Apache::response::submitted() ) {
   89: 	    my $response      = $ENV{'form.HWVAL_'.$id};
   90:             my $filename= $ENV{'form.HWFILE'.$part.'_'.$id.'.filename'};
   91:             my $portfiles = $ENV{'form.HWPORT'.$part.'_'.$id};
   92: 	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
   93:  		my $award='DRAFT';
   94:         	if ($ENV{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
   95: 		    $award='SUBMITTED';
   96: 		}
   97:                 my $uploadedflag=0;
   98: 		&file_submission($part,$id,'filename',$award,\$uploadedflag);
   99: 		&file_submission($part,$id,'portfiles',$award,\$uploadedflag);
  100: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
  101: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
  102: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
  103: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
  104: #
  105: # Store with resource author for similarity testing
  106: #
  107:                 if ($award eq 'SUBMITTED') {
  108: 		    my ($symb,$crsid,$domain,$name)=
  109: 			&Apache::lonxml::whichuser();
  110: 		    if ($crsid) {
  111: 			my $akey=$name.'.'.$domain.'.'.$crsid;
  112: 			my $essayurl=
  113: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
  114: 			my ($adom,$aname,$apath)=
  115: 			    ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
  116:                         $apath=&Apache::lonnet::escape($apath);
  117: 			$apath=~s/\W/\_/gs;
  118: 			&Apache::lonnet::put('nohist_essay_'.$apath,
  119: 					 { $akey => $response },$adom,$aname);
  120: 		    }
  121:                 }
  122: 	    }
  123: 	} 
  124:     } elsif ($target eq 'edit') {
  125: 	$result.=&Apache::edit::end_table();
  126:     } elsif ($target eq 'tex') {
  127: 	if ($Apache::lonhomework::type eq 'exam') {
  128: 	    my $repetition=&Apache::response::repetition();
  129: 	    $result.='\begin{enumerate}';
  130: 	    if ($ENV{'request.state'} eq "construct" ) {$result.='\item[\strut]';}
  131: 	    for (my $i=0;$i<$repetition;$i++) {
  132: 		$result.='\item[\textbf{'.($Apache::lonxml::counter+$i).
  133: 		    '}.]\textit{'.&mt('Leave blank on scoring form').
  134: 		    '}\vskip 0 mm';
  135: 	    }
  136: 	    $result.= '\end{enumerate}';
  137: 	    $increment=$repetition;
  138: 	}
  139:     }
  140:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
  141: 	$target eq 'tex' || $target eq 'analyze') {
  142: 	&Apache::lonxml::increment_counter($increment);
  143:     }
  144:     &Apache::response::end_response;
  145: 
  146:     return $result;
  147: }
  148: 
  149: sub file_submission {
  150:     my ($part,$id,$which,$award,$uploadedflag)=@_;
  151:     my $files;
  152:     if ($which eq 'portfiles') { $files= $ENV{'form.HWPORT'.$part.'_'.$id}; }
  153:     if ($which eq 'filename') {
  154: 	$files = $ENV{'form.HWFILE'.$part.'_'.$id.'.filename'};
  155:     }
  156:     
  157:     if ($files =~ /[^\s]/) {
  158: 	$files =~s/,$//;
  159: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}=$files;
  160: 	my @submitted_files = split(/,/,$files);
  161: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
  162: 	$uploadedfiletypes=~s/[^\w\,]//g;
  163: 	$uploadedfiletypes=','.$uploadedfiletypes.',';
  164: 	foreach my $file (@submitted_files) {
  165: 	    my ($extension)=($file=~/\.(\w+)$/);
  166: 	    unless ($uploadedfiletypes=~/\,$extension\,/i) {
  167: 		$award='INVALID_FILETYPE';
  168: 	    }
  169: 	}
  170: 	if ($award ne 'INVALID_FILETYPE' && ref($uploadedflag)) {
  171: 	    $$uploadedflag=1;
  172: 	}
  173: 	if ($award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
  174: 	    my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
  175: 	    &Apache::lonnet::unmark_as_readonly($domain,$name,$symb.$crsid);
  176: 	    &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,$symb.$crsid);
  177: 	    &Apache::lonnet::clear_selected_files($name);
  178: 	}
  179: 	if ($award ne 'INVALID_FILETYPE' && $which eq 'filename') {
  180: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
  181: 		$files;
  182: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
  183: 		&Apache::lonnet::userfileupload('HWFILE'.$part.'_'.$id,undef,
  184: 						'essayresponse');
  185: 	}
  186:     } elsif ($which eq 'portfiles' &&
  187: 	     $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
  188: 	my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
  189: 	&Apache::lonnet::unmark_as_readonly($domain,$name,$symb.$crsid);
  190: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
  191:     }
  192: }
  193: 
  194: sub check_collaborators {
  195:     my ($ncol,$coll) = @_;
  196:     my %classlist=&Apache::lonnet::dump('classlist',
  197: 					$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
  198: 					$ENV{'course.'.$ENV{'request.course.id'}.'.num'});
  199:     my (@badcollaborators,$result);
  200:     my (@collaborators) = split(/\,?\s+/,$coll);
  201:     foreach (@collaborators) {
  202: 	my $collaborator = $_;
  203: 	if (/@/) {
  204: 	    $collaborator =~ s/@/:/;
  205: 	} else {
  206: 	    $collaborator = $_.':'.$ENV{'user.domain'};
  207: 	}
  208: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
  209:     }
  210:     
  211:     if (scalar(@badcollaborators)) {
  212: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
  213: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
  214: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
  215:     }
  216:     my $toomany = scalar(@collaborators) - $ncol;
  217:     if ($toomany > 0) {
  218: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
  219: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
  220: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
  221:     }
  222:     return $result;
  223: }
  224: 
  225: 1;
  226: __END__

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