File:  [LON-CAPA] / loncom / homework / essayresponse.pm
Revision 1.70: download - view: text, annotated - select for diffs
Thu Mar 9 01:07:04 2006 UTC (18 years, 1 month ago) by albertel
Branches: MAIN
CVS tags: HEAD
- essay response emits an answer line now and consumes correct number of lines

    1: # The LearningOnline Network with CAPA
    2: # essay (ungraded) style responses
    3: #
    4: # $Id: essayresponse.pm,v 1.70 2006/03/09 01:07:04 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: 	     $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
   47: 	my $part= $Apache::inputtags::part;
   48: 	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
   49: 	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
   50: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
   51:         $uploadedfiletypes=~s/[^\w\,]//g;
   52: 	$result='<br /><table border="1">';
   53: 	$result.='<tr><td>'.
   54:             '<label>'.
   55: 	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
   56: 	    &mt('Submit entries below as answer to receive credit').
   57:             '</label> <br />'.
   58: 	    '<label>'.
   59:             '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
   60: 	    &mt('Save entries below as a draft answer (not submitting them for credit yet)').
   61: 	    '</label>'.
   62:             ' </td></tr>';
   63: 	if ($ncol > 0) {
   64: 	    $result .='<tr><td>'.'<label>'.
   65: 		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
   66: 		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
   67: 		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$env{'user.domain'}).
   68:                 '</label><br />';
   69: 	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
   70: 	    $result .='</td></tr>';
   71: 	}
   72: 	$result.=&Apache::inputtags::file_selector($part,$id,
   73: 						   $uploadedfiletypes,'both');
   74:         $result.='</table>';
   75:     }
   76:     return $result;
   77: }
   78: 
   79: sub end_essayresponse {
   80:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   81:     my $part          = $Apache::inputtags::part;
   82:     my $id            = $Apache::inputtags::response[-1];
   83:     my $increment     = &Apache::response::repetition();
   84:     my $result;
   85:     if ( $target eq 'grade' ) {
   86: 	my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};	
   87: 	if ($collaborators =~ /[^\s]/) {
   88: 	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
   89: 	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
   90: 		if ($collaborators ne $previous_list);
   91: 	}
   92: 	if (  &Apache::response::submitted('scantron') ) {
   93: 	    $increment=&Apache::response::scored_response($part,$id);
   94: 	} elsif ( &Apache::response::submitted() ) {
   95: 	    my $response      = $env{'form.HWVAL_'.$id};
   96:             my $filename= $env{'form.HWFILE'.$part.'_'.$id.'.filename'};
   97:             my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
   98: 	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
   99:  		my $award='DRAFT';
  100:         	if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
  101: 		    $award='SUBMITTED';
  102: 		}
  103:                 my $uploadedflag=0;
  104: 		&file_submission($part,$id,'filename',\$award,\$uploadedflag);
  105: 		&file_submission($part,$id,'portfiles',\$award,\$uploadedflag);
  106: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
  107: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
  108: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
  109: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
  110: #
  111: # Store with resource author for similarity testing
  112: #
  113:                 if ($award eq 'SUBMITTED') {
  114: 		    my ($symb,$crsid,$domain,$name)=
  115: 			&Apache::lonxml::whichuser();
  116: 		    if ($crsid) {
  117: 			my $akey=$name.'.'.$domain.'.'.$crsid;
  118: 			my $essayurl=
  119: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
  120: 			my ($adom,$aname,$apath)=
  121: 			    ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
  122:                         $apath=&Apache::lonnet::escape($apath);
  123: 			$apath=~s/\W/\_/gs;
  124: 			&Apache::lonnet::put('nohist_essay_'.$apath,
  125: 					 { $akey => $response },$adom,$aname);
  126: 		    }
  127:                 }
  128: 	    }
  129: 	} 
  130:     } elsif ($target eq 'edit') {
  131: 	$result.=&Apache::edit::end_table();
  132:     } elsif ($target eq 'tex') {
  133: 	if ($Apache::lonhomework::type eq 'exam') {
  134: 	    my $repetition=&Apache::response::repetition();
  135: 	    $result.='\begin{enumerate}';
  136: 	    if ($env{'request.state'} eq "construct" ) {$result.='\item[\strut]';}
  137: 	    for (my $i=0;$i<$repetition;$i++) {
  138: 		$result.='\item[\textbf{'.($Apache::lonxml::counter+$i).
  139: 		    '}.]\textit{'.&mt('Leave blank on scoring form').
  140: 		    '}\vskip 0 mm';
  141: 	    }
  142: 	    $result.= '\end{enumerate}';
  143: 	    $increment=$repetition;
  144: 	}
  145:     } elsif ($target eq 'answer') {
  146: 	$result.=&Apache::response::answer_header($$tagstack[-1]);
  147: 	$result.=&Apache::response::answer_part($$tagstack[-1],'');
  148: 	$result.=&Apache::response::answer_footer($$tagstack[-1]);
  149:     }
  150:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
  151: 	$target eq 'tex' || $target eq 'analyze') {
  152: 	&Apache::lonxml::increment_counter($increment);
  153:     }
  154:     &Apache::response::end_response;
  155: 
  156:     return $result;
  157: }
  158: 
  159: sub file_submission {
  160:     my ($part,$id,$which,$award,$uploadedflag)=@_;
  161:     my $files;
  162:     my $jspart=$part;
  163:     $jspart=~s/\./_/g;
  164:     if ($which eq 'portfiles') { $files= $env{'form.HWPORT'.$jspart.'_'.$id}; }
  165:     if ($which eq 'filename') {
  166: 	$files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
  167:     }
  168:     
  169:     if ($files =~ /[^\s]/) {
  170: 	$files =~s/,$//;
  171: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}=$files;
  172: 	
  173: 	my @submitted_files = ($files);
  174: 	if ( $which eq 'portfiles' ) {
  175: 	    @submitted_files = split(/,/,$files);
  176: 	}
  177: 
  178: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
  179: 	if ($uploadedfiletypes) {
  180: 	    $uploadedfiletypes=~s/[^\w\,]//g;
  181: 	    $uploadedfiletypes=','.$uploadedfiletypes.',';
  182: 	    foreach my $file (@submitted_files) {
  183: 		my ($extension)=($file=~/\.(\w+)$/);
  184: 		unless ($uploadedfiletypes=~/\,$extension\,/i) {
  185: 		    $$award='INVALID_FILETYPE';
  186: 		}
  187: 	    }
  188: 	}
  189: 	if ($$award ne 'INVALID_FILETYPE' && ref($uploadedflag)) {
  190: 	    $$uploadedflag=1;
  191: 	}
  192: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
  193: 	    my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
  194: 	    &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
  195: 	    &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,[$symb,$crsid]);
  196: 	    &Apache::lonnet::clear_selected_files($name);
  197: 	}
  198: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'filename') {
  199: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
  200: 		$files;
  201: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
  202: 		&Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef,
  203: 						'essayresponse');
  204: 	}
  205:     } elsif ($which eq 'portfiles' &&
  206: 	     $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
  207: 	my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
  208: 	&Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
  209: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
  210:     }
  211: }
  212: 
  213: sub check_collaborators {
  214:     my ($ncol,$coll) = @_;
  215:     my %classlist=&Apache::lonnet::dump('classlist',
  216: 					$env{'course.'.$env{'request.course.id'}.'.domain'},
  217: 					$env{'course.'.$env{'request.course.id'}.'.num'});
  218:     my (@badcollaborators,$result);
  219:     my (@collaborators) = split(/\,?\s+/,$coll);
  220:     foreach (@collaborators) {
  221: 	my $collaborator = $_;
  222: 	if (/@/) {
  223: 	    $collaborator =~ s/@/:/;
  224: 	} else {
  225: 	    $collaborator = $_.':'.$env{'user.domain'};
  226: 	}
  227: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
  228:     }
  229:     
  230:     if (scalar(@badcollaborators)) {
  231: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
  232: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
  233: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
  234:     }
  235:     my $toomany = scalar(@collaborators) - $ncol;
  236:     if ($toomany > 0) {
  237: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
  238: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
  239: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
  240:     }
  241:     return $result;
  242: }
  243: 
  244: 1;
  245: __END__

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