File:  [LON-CAPA] / loncom / homework / essayresponse.pm
Revision 1.83: download - view: text, annotated - select for diffs
Fri Aug 10 20:09:30 2007 UTC (16 years, 8 months ago) by albertel
Branches: MAIN
CVS tags: version_2_5_X, version_2_5_2, version_2_5_1, version_2_5_0, HEAD
- eliminate unneeded global
- list the course the similar response came from (BUG#5363)
- handle usernames/domains properl by escaping them (as they can now have . in them)

    1: # The LearningOnline Network with CAPA
    2: # essay (ungraded) style responses
    3: #
    4: # $Id: essayresponse.pm,v 1.83 2007/08/10 20:09:30 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: use LONCAPA;
   35:  
   36: 
   37: BEGIN {
   38:     &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
   39: }
   40: 
   41: sub start_essayresponse {
   42:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   43:     my $result;
   44:     my $id = &Apache::response::start_response($parstack,$safeeval);
   45:     if ($target eq 'meta') {
   46: 	$result=&Apache::response::meta_package_write('essayresponse');
   47:     } elsif ($target eq 'web' &&
   48: 	     $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
   49: 	my $part= $Apache::inputtags::part;
   50: 	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
   51: 	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
   52: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
   53:         $uploadedfiletypes=~s/[^\w\,]//g;
   54: 	if ( $Apache::lonhomework::type eq 'survey' ) {
   55: 	    $result.= '<input type="hidden" name="HWDRAFT'.$part.'_'.$id.'" value="yes" /> ';
   56: 	}
   57: 	$result.='<br /><table border="1">';
   58: 	if ( $Apache::lonhomework::type ne 'survey' ) {
   59: 	    $result.= '<tr><td>'.
   60: 		'<label>'.
   61: 		'<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
   62: 		&mt('Submit entries below as answer to receive credit').
   63: 		'</label> <br />'.
   64: 		'<label>'.
   65: 		'<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
   66: 		&mt('Save entries below as a draft answer (not submitting them for credit yet)').
   67: 		'</label>'.
   68: 		'</td></tr>';
   69: 	}
   70: 
   71: 	if ($ncol > 0) {
   72: 	    $result .='<tr><td>'.'<label>'.
   73: 		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
   74: 		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
   75: 		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$env{'user.domain'}).
   76:                 '</label><br />';
   77: 	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
   78: 	    $result .='</td></tr>';
   79: 	}
   80: 	$result.=&Apache::inputtags::file_selector($part,$id,
   81: 						   $uploadedfiletypes,'both');
   82:         $result.='</table>';
   83:     } elsif ($target eq 'web' &&
   84: 	     $Apache::inputtags::status[-1] ne 'CAN_ANSWER') {
   85: 	my $part= $Apache::inputtags::part;
   86: 	my @msgs;
   87: 	if ($Apache::lonhomework::history{"resource.$part.$id.collaborators"} =~ /\S/) {
   88: 	    my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
   89: 	    $result .= '<td>'.&mt('Collaborated with [_1]',$coll).'</td>';
   90: 	}
   91: 
   92: 	my $file_submission = 
   93: 	    &Apache::inputtags::show_past_file_submission($part,$id);
   94: 	if ($file_submission) {
   95: 	    $result .= '<td>'.$file_submission.'</td>';
   96: 	}
   97: 
   98: 	my $port_submission = 
   99: 	    &Apache::inputtags::show_past_portfile_submission($part,$id);
  100: 	if ($port_submission) {
  101: 	    $result .= '<td>'.$port_submission.'</td>';
  102: 	}
  103: 
  104: 	if ($result ne '') {
  105: 	    $result = 
  106: 		'<table class="LC_pastsubmission"><tr>'.$result.
  107: 		'</tr></table>';
  108: 	}
  109:     }
  110:     return $result;
  111: }
  112: 
  113: sub end_essayresponse {
  114:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  115:     my $part          = $Apache::inputtags::part;
  116:     my $id            = $Apache::inputtags::response[-1];
  117:     my $increment     = &Apache::response::repetition();
  118:     my $result;
  119:     if ( $target eq 'grade' ) {
  120: 	my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};	
  121: 	if ($collaborators =~ /[^\s]/) {
  122: 	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
  123: 	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
  124: 		if ($collaborators ne $previous_list);
  125: 	}
  126: 	if (  &Apache::response::submitted('scantron') ) {
  127: 	    $increment=&Apache::response::scored_response($part,$id);
  128: 	} elsif ( &Apache::response::submitted() ) {
  129: 	    my $response      = $env{'form.HWVAL_'.$id};
  130:             my $filename= $env{'form.HWFILE'.$part.'_'.$id.'.filename'};
  131:             my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
  132: 	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
  133:  		my $award='DRAFT';
  134:         	if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
  135: 		    $award='SUBMITTED';
  136: 		}
  137:                 my $uploadedflag=0;
  138: 		&file_submission($part,$id,'filename',\$award,\$uploadedflag);
  139: 		&file_submission($part,$id,'portfiles',\$award,\$uploadedflag);
  140: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
  141: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
  142: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
  143: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
  144: #
  145: # Store with resource author for similarity testing
  146: #
  147:                 if ($award eq 'SUBMITTED') {
  148: 		    my ($symb,$crsid,$domain,$name)=
  149: 			&Apache::lonnet::whichuser();
  150: 		    if ($crsid) {
  151: 			my $akey=join('.',&escape($name),&escape($domain),
  152: 				      &escape($crsid));
  153: 			my $essayurl=
  154: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
  155: 			my ($adom,$aname,$apath)=
  156: 			    ($essayurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\/(.*)$/);
  157:                         $apath=&escape($apath);
  158: 			$apath=~s/\W/\_/gs;
  159: 			&Apache::lonnet::put('nohist_essay_'.$apath,
  160: 					 { $akey => $response },$adom,$aname);
  161: 		    }
  162:                 }
  163: 	    }
  164: 	} 
  165:     } elsif ($target eq 'edit') {
  166: 	$result.=&Apache::edit::end_table();
  167: 
  168:     } elsif ($target eq 'tex'
  169: 	     && $Apache::lonhomework::type eq 'exam') {
  170: 	$result .= &Apache::inputtags::exam_score_line($target);
  171: 
  172:     } elsif ($target eq 'answer') {
  173: 	$result.=&Apache::response::answer_header($$tagstack[-1]);
  174: 	my $answer = &mt('Essay will be hand graded.');
  175: 	$result.=&Apache::response::answer_part($$tagstack[-1],$answer,
  176: 						{'no_verbatim' => 1});
  177: 	$result.=&Apache::response::answer_footer($$tagstack[-1]);
  178:     }
  179:     if ($target eq 'web') {
  180: 	&Apache::response::setup_prior_tries_hash(\&format_prior_response,
  181: 						  ['portfiles',
  182: 						   'uploadedurl']);
  183:     }
  184: 
  185:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
  186: 	$target eq 'tex' || $target eq 'analyze') {
  187: 	&Apache::lonxml::increment_counter($increment);
  188:     }
  189:     &Apache::response::end_response;
  190: 
  191:     return $result;
  192: }
  193: 
  194: sub format_prior_response {
  195:     my ($mode,$answer,$other_data) = @_;
  196:     my $output;
  197: 
  198:     my (undef,undef,$udom,$uname) = &Apache::lonnet::whichuser();
  199:     my $port_url = '/uploaded/'.$udom.'/'.$uname.'/portfolio/';
  200: 
  201:     my $file_list;
  202: 
  203:     foreach my $file (split(/\s*,\s*/,
  204: 			    $other_data->[0].','.$other_data->[1])) {
  205: 	next if ($file!~/\S/);
  206: 	if ($file !~ m{^/uploaded/}) { $file=$port_url.$file; }
  207: 	$file=~s|/+|/|g;
  208: 	&Apache::lonnet::allowuploaded('/adm/essayresponse',$file);
  209: 	$file_list.='<li><span class="LC_nobreak"><a href="'.$file.'?rawmode=1" target="lonGRDs"><img src="'.
  210: 	    &Apache::loncommon::icon($file).'" alt="file icon" border="0" /> '.$file.
  211: 	    '</a></span></li>'."\n";
  212:     }
  213:     if ($file_list) {
  214: 	$output.= &mt('Submitted Files').'<ul>'.$file_list.'</ul>';
  215:     }
  216:     if ($answer =~ /\S/) {
  217: 	$output.='<p>'.&mt('Submitted text').
  218: 	    '<blockquote>'.$answer.'</blockquote></p>';
  219:     }
  220: 
  221:     return '<div class="LC_prior_essay">'.$output.'</div>';
  222: }
  223: 
  224: sub file_submission {
  225:     my ($part,$id,$which,$award,$uploadedflag)=@_;
  226:     my $files;
  227:     my $jspart=$part;
  228:     $jspart=~s/\./_/g;
  229:     if ($which eq 'portfiles') { $files= $env{'form.HWPORT'.$jspart.'_'.$id}; }
  230:     if ($which eq 'filename') {
  231: 	$files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
  232:     }
  233:     
  234:     if ($files =~ /[^\s]/) {
  235: 	$files =~s/,$//;
  236: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}=$files;
  237: 	
  238: 	my @submitted_files = ($files);
  239: 	if ( $which eq 'portfiles' ) {
  240: 	    @submitted_files = split(/\s*,\s*/,$files);
  241: 	}
  242: 
  243: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
  244: 	if ($uploadedfiletypes) {
  245: 	    $uploadedfiletypes=~s/[^\w\,]//g;
  246: 	    $uploadedfiletypes=','.$uploadedfiletypes.',';
  247: 	    foreach my $file (@submitted_files) {
  248: 		my ($extension)=($file=~/\.(\w+)$/);
  249: 		unless ($uploadedfiletypes=~/\,$extension\,/i) {
  250: 		    $$award='INVALID_FILETYPE';
  251: 		}
  252: 	    }
  253: 	}
  254: 	if ($$award ne 'INVALID_FILETYPE' && ref($uploadedflag)) {
  255: 	    $$uploadedflag=1;
  256: 	}
  257: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
  258: 	    my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
  259: 	    &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
  260: 	    &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,[$symb,$crsid]);
  261: 	    &Apache::lonnet::clear_selected_files($name);
  262: 	}
  263: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'filename') {
  264: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
  265: 		$files;
  266: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
  267: 		&Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef,
  268: 						'essayresponse');
  269: 	}
  270:     } elsif ($which eq 'portfiles' &&
  271: 	     $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
  272: 	my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
  273: 	&Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
  274: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
  275:     }
  276: }
  277: 
  278: sub check_collaborators {
  279:     my ($ncol,$coll) = @_;
  280:     my %classlist=&Apache::lonnet::dump('classlist',
  281: 					$env{'course.'.$env{'request.course.id'}.'.domain'},
  282: 					$env{'course.'.$env{'request.course.id'}.'.num'});
  283:     my (@badcollaborators,$result);
  284:     my (@collaborators) = split(/\,?\s+/,$coll);
  285:     foreach (@collaborators) {
  286: 	my $collaborator = $_;
  287: 	if (/@/) {
  288: 	    $collaborator =~ s/@/:/;
  289: 	} else {
  290: 	    $collaborator = $_.':'.$env{'user.domain'};
  291: 	}
  292: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
  293:     }
  294:     
  295:     if (scalar(@badcollaborators)) {
  296: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
  297: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
  298: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
  299:     }
  300:     my $toomany = scalar(@collaborators) - $ncol;
  301:     if ($toomany > 0) {
  302: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
  303: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
  304: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
  305:     }
  306:     return $result;
  307: }
  308: 
  309: 1;
  310: __END__

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