Annotation of loncom/homework/essayresponse.pm, revision 1.86

1.1       albertel    1: # The LearningOnline Network with CAPA
                      2: # essay (ungraded) style responses
1.5       albertel    3: #
1.86    ! foxr        4: # $Id: essayresponse.pm,v 1.85 2007/10/08 09:22:50 foxr Exp $
1.5       albertel    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: #
1.33      albertel   28: 
1.1       albertel   29: package Apache::essayresponse;
                     30: use strict;
1.33      albertel   31: use Apache::lonxml();
1.62      albertel   32: use Apache::lonnet;
1.33      albertel   33: use Apache::lonlocal;
1.72      www        34: use LONCAPA;
                     35:  
1.1       albertel   36: 
1.6       harris41   37: BEGIN {
1.10      ng         38:     &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
1.1       albertel   39: }
                     40: 
                     41: sub start_essayresponse {
1.10      ng         42:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                     43:     my $result;
1.14      albertel   44:     my $id = &Apache::response::start_response($parstack,$safeeval);
                     45:     if ($target eq 'meta') {
                     46: 	$result=&Apache::response::meta_package_write('essayresponse');
1.69      albertel   47:     } elsif ($target eq 'web' &&
                     48: 	     $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
1.10      ng         49: 	my $part= $Apache::inputtags::part;
                     50: 	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
1.34      albertel   51: 	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.17      www        52: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
1.21      www        53:         $uploadedfiletypes=~s/[^\w\,]//g;
1.75      albertel   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: 
1.10      ng         71: 	if ($ncol > 0) {
1.64      matthew    72: 	    $result .='<tr><td>'.'<label>'.
1.13      ng         73: 		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
                     74: 		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
1.64      matthew    75: 		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$env{'user.domain'}).
                     76:                 '</label><br />';
1.10      ng         77: 	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
1.13      ng         78: 	    $result .='</td></tr>';
1.10      ng         79: 	}
1.60      albertel   80: 	$result.=&Apache::inputtags::file_selector($part,$id,
                     81: 						   $uploadedfiletypes,'both');
1.22      www        82:         $result.='</table>';
1.74      albertel   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: 	}
1.10      ng        109:     }
                    110:     return $result;
1.1       albertel  111: }
                    112: 
                    113: sub end_essayresponse {
1.10      ng        114:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.13      ng        115:     my $part          = $Apache::inputtags::part;
1.14      albertel  116:     my $id            = $Apache::inputtags::response[-1];
1.70      albertel  117:     my $increment     = &Apache::response::repetition();
1.15      albertel  118:     my $result;
1.10      ng        119:     if ( $target eq 'grade' ) {
1.62      albertel  120: 	my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};	
1.14      albertel  121: 	if ($collaborators =~ /[^\s]/) {
1.34      albertel  122: 	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.14      albertel  123: 	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
                    124: 		if ($collaborators ne $previous_list);
                    125: 	}
1.58      albertel  126: 	if (  &Apache::response::submitted('scantron') ) {
1.31      albertel  127: 	    $increment=&Apache::response::scored_response($part,$id);
1.58      albertel  128: 	} elsif ( &Apache::response::submitted() ) {
1.62      albertel  129: 	    my $response      = $env{'form.HWVAL_'.$id};
                    130:             my $filename= $env{'form.HWFILE'.$part.'_'.$id.'.filename'};
                    131:             my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
1.42      banghart  132: 	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
1.61      albertel  133:  		my $award='DRAFT';
1.62      albertel  134:         	if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
1.14      albertel  135: 		    $award='SUBMITTED';
                    136: 		}
1.22      www       137:                 my $uploadedflag=0;
1.63      albertel  138: 		&file_submission($part,$id,'filename',\$award,\$uploadedflag);
                    139: 		&file_submission($part,$id,'portfiles',\$award,\$uploadedflag);
1.10      ng        140: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
1.14      albertel  141: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
1.10      ng        142: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
1.22      www       143: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
1.32      www       144: #
                    145: # Store with resource author for similarity testing
                    146: #
                    147:                 if ($award eq 'SUBMITTED') {
                    148: 		    my ($symb,$crsid,$domain,$name)=
1.77      albertel  149: 			&Apache::lonnet::whichuser();
1.32      www       150: 		    if ($crsid) {
1.83      albertel  151: 			my $akey=join('.',&escape($name),&escape($domain),
                    152: 				      &escape($crsid));
1.32      www       153: 			my $essayurl=
                    154: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
                    155: 			my ($adom,$aname,$apath)=
1.80      albertel  156: 			    ($essayurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\/(.*)$/);
1.72      www       157:                         $apath=&escape($apath);
1.32      www       158: 			$apath=~s/\W/\_/gs;
                    159: 			&Apache::lonnet::put('nohist_essay_'.$apath,
                    160: 					 { $akey => $response },$adom,$aname);
                    161: 		    }
1.42      banghart  162:                 }
1.10      ng        163: 	    }
1.42      banghart  164: 	} 
1.15      albertel  165:     } elsif ($target eq 'edit') {
                    166: 	$result.=&Apache::edit::end_table();
1.71      albertel  167: 
                    168:     } elsif ($target eq 'tex'
                    169: 	     && $Apache::lonhomework::type eq 'exam') {
                    170: 	$result .= &Apache::inputtags::exam_score_line($target);
                    171: 
1.70      albertel  172:     } elsif ($target eq 'answer') {
1.78      albertel  173: 	$result.=&Apache::response::answer_header($$tagstack[-1]);
1.81      foxr      174: 	my $answer = &mt('Essay will be hand graded.');
1.78      albertel  175: 	$result.=&Apache::response::answer_part($$tagstack[-1],$answer,
                    176: 						{'no_verbatim' => 1});
                    177: 	$result.=&Apache::response::answer_footer($$tagstack[-1]);
1.10      ng        178:     }
1.82      albertel  179:     if ($target eq 'web') {
                    180: 	&Apache::response::setup_prior_tries_hash(\&format_prior_response,
                    181: 						  ['portfiles',
                    182: 						   'uploadedurl']);
                    183:     }
1.71      albertel  184: 
1.27      albertel  185:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
                    186: 	$target eq 'tex' || $target eq 'analyze') {
1.86    ! foxr      187: 	&Apache::lonxml::increment_counter($increment, "$part.$id");
1.85      foxr      188: 
                    189: 	if ($target eq 'analyze') {
                    190: 	    &Apache::lonhomework::set_bubble_lines();
                    191: 	}
1.27      albertel  192:     }
1.10      ng        193:     &Apache::response::end_response;
1.42      banghart  194: 
1.15      albertel  195:     return $result;
1.10      ng        196: }
                    197: 
1.82      albertel  198: sub format_prior_response {
                    199:     my ($mode,$answer,$other_data) = @_;
                    200:     my $output;
                    201: 
                    202:     my (undef,undef,$udom,$uname) = &Apache::lonnet::whichuser();
                    203:     my $port_url = '/uploaded/'.$udom.'/'.$uname.'/portfolio/';
                    204: 
                    205:     my $file_list;
                    206: 
                    207:     foreach my $file (split(/\s*,\s*/,
                    208: 			    $other_data->[0].','.$other_data->[1])) {
                    209: 	next if ($file!~/\S/);
                    210: 	if ($file !~ m{^/uploaded/}) { $file=$port_url.$file; }
                    211: 	$file=~s|/+|/|g;
                    212: 	&Apache::lonnet::allowuploaded('/adm/essayresponse',$file);
                    213: 	$file_list.='<li><span class="LC_nobreak"><a href="'.$file.'?rawmode=1" target="lonGRDs"><img src="'.
                    214: 	    &Apache::loncommon::icon($file).'" alt="file icon" border="0" /> '.$file.
                    215: 	    '</a></span></li>'."\n";
                    216:     }
                    217:     if ($file_list) {
                    218: 	$output.= &mt('Submitted Files').'<ul>'.$file_list.'</ul>';
                    219:     }
                    220:     if ($answer =~ /\S/) {
                    221: 	$output.='<p>'.&mt('Submitted text').
                    222: 	    '<blockquote>'.$answer.'</blockquote></p>';
                    223:     }
                    224: 
                    225:     return '<div class="LC_prior_essay">'.$output.'</div>';
                    226: }
                    227: 
1.61      albertel  228: sub file_submission {
                    229:     my ($part,$id,$which,$award,$uploadedflag)=@_;
                    230:     my $files;
1.67      albertel  231:     my $jspart=$part;
                    232:     $jspart=~s/\./_/g;
                    233:     if ($which eq 'portfiles') { $files= $env{'form.HWPORT'.$jspart.'_'.$id}; }
1.61      albertel  234:     if ($which eq 'filename') {
1.67      albertel  235: 	$files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
1.61      albertel  236:     }
                    237:     
                    238:     if ($files =~ /[^\s]/) {
                    239: 	$files =~s/,$//;
                    240: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}=$files;
1.68      albertel  241: 	
                    242: 	my @submitted_files = ($files);
                    243: 	if ( $which eq 'portfiles' ) {
1.73      albertel  244: 	    @submitted_files = split(/\s*,\s*/,$files);
1.68      albertel  245: 	}
                    246: 
1.61      albertel  247: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
1.65      albertel  248: 	if ($uploadedfiletypes) {
                    249: 	    $uploadedfiletypes=~s/[^\w\,]//g;
                    250: 	    $uploadedfiletypes=','.$uploadedfiletypes.',';
                    251: 	    foreach my $file (@submitted_files) {
                    252: 		my ($extension)=($file=~/\.(\w+)$/);
1.84      albertel  253: 		unless ($uploadedfiletypes=~/\,\s*\Q$extension\E\s*\,/i) {
1.65      albertel  254: 		    $$award='INVALID_FILETYPE';
                    255: 		}
1.61      albertel  256: 	    }
                    257: 	}
1.63      albertel  258: 	if ($$award ne 'INVALID_FILETYPE' && ref($uploadedflag)) {
1.61      albertel  259: 	    $$uploadedflag=1;
                    260: 	}
1.63      albertel  261: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
1.77      albertel  262: 	    my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
1.66      albertel  263: 	    &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
                    264: 	    &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,[$symb,$crsid]);
1.61      albertel  265: 	    &Apache::lonnet::clear_selected_files($name);
                    266: 	}
1.63      albertel  267: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'filename') {
1.61      albertel  268: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
                    269: 		$files;
                    270: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
1.67      albertel  271: 		&Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef,
1.61      albertel  272: 						'essayresponse');
                    273: 	}
                    274:     } elsif ($which eq 'portfiles' &&
                    275: 	     $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
1.77      albertel  276: 	my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
1.66      albertel  277: 	&Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
1.61      albertel  278: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
                    279:     }
                    280: }
                    281: 
1.10      ng        282: sub check_collaborators {
1.11      ng        283:     my ($ncol,$coll) = @_;
1.10      ng        284:     my %classlist=&Apache::lonnet::dump('classlist',
1.62      albertel  285: 					$env{'course.'.$env{'request.course.id'}.'.domain'},
                    286: 					$env{'course.'.$env{'request.course.id'}.'.num'});
1.10      ng        287:     my (@badcollaborators,$result);
                    288:     my (@collaborators) = split(/\,?\s+/,$coll);
                    289:     foreach (@collaborators) {
                    290: 	my $collaborator = $_;
                    291: 	if (/@/) {
                    292: 	    $collaborator =~ s/@/:/;
                    293: 	} else {
1.62      albertel  294: 	    $collaborator = $_.':'.$env{'user.domain'};
1.10      ng        295: 	}
                    296: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
                    297:     }
                    298:     
                    299:     if (scalar(@badcollaborators)) {
1.11      ng        300: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
                    301: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
                    302: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
1.10      ng        303:     }
                    304:     my $toomany = scalar(@collaborators) - $ncol;
                    305:     if ($toomany > 0) {
                    306: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
                    307: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
                    308: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
                    309:     }
                    310:     return $result;
1.1       albertel  311: }
1.2       albertel  312: 
                    313: 1;
                    314: __END__

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