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

1.1       albertel    1: # The LearningOnline Network with CAPA
                      2: # essay (ungraded) style responses
1.5       albertel    3: #
1.75    ! albertel    4: # $Id: essayresponse.pm,v 1.74 2006/09/21 21:23:19 albertel 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 lib '/home/httpd/lib/perl/';
                     35: use LONCAPA;
                     36:  
1.1       albertel   37: 
1.6       harris41   38: BEGIN {
1.10      ng         39:     &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
1.1       albertel   40: }
                     41: 
                     42: sub start_essayresponse {
1.10      ng         43:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                     44:     my $result;
1.14      albertel   45:     my $id = &Apache::response::start_response($parstack,$safeeval);
                     46:     if ($target eq 'meta') {
                     47: 	$result=&Apache::response::meta_package_write('essayresponse');
1.69      albertel   48:     } elsif ($target eq 'web' &&
                     49: 	     $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
1.10      ng         50: 	my $part= $Apache::inputtags::part;
                     51: 	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
1.34      albertel   52: 	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.17      www        53: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
1.21      www        54:         $uploadedfiletypes=~s/[^\w\,]//g;
1.75    ! albertel   55: 	if ( $Apache::lonhomework::type eq 'survey' ) {
        !            56: 	    $result.= '<input type="hidden" name="HWDRAFT'.$part.'_'.$id.'" value="yes" /> ';
        !            57: 	}
        !            58: 	$result.='<br /><table border="1">';
        !            59: 	if ( $Apache::lonhomework::type ne 'survey' ) {
        !            60: 	    $result.= '<tr><td>'.
        !            61: 		'<label>'.
        !            62: 		'<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
        !            63: 		&mt('Submit entries below as answer to receive credit').
        !            64: 		'</label> <br />'.
        !            65: 		'<label>'.
        !            66: 		'<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
        !            67: 		&mt('Save entries below as a draft answer (not submitting them for credit yet)').
        !            68: 		'</label>'.
        !            69: 		'</td></tr>';
        !            70: 	}
        !            71: 
1.10      ng         72: 	if ($ncol > 0) {
1.64      matthew    73: 	    $result .='<tr><td>'.'<label>'.
1.13      ng         74: 		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
                     75: 		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
1.64      matthew    76: 		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$env{'user.domain'}).
                     77:                 '</label><br />';
1.10      ng         78: 	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
1.13      ng         79: 	    $result .='</td></tr>';
1.10      ng         80: 	}
1.60      albertel   81: 	$result.=&Apache::inputtags::file_selector($part,$id,
                     82: 						   $uploadedfiletypes,'both');
1.22      www        83:         $result.='</table>';
1.74      albertel   84:     } elsif ($target eq 'web' &&
                     85: 	     $Apache::inputtags::status[-1] ne 'CAN_ANSWER') {
                     86: 	my $part= $Apache::inputtags::part;
                     87: 	my @msgs;
                     88: 	if ($Apache::lonhomework::history{"resource.$part.$id.collaborators"} =~ /\S/) {
                     89: 	    my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
                     90: 	    $result .= '<td>'.&mt('Collaborated with [_1]',$coll).'</td>';
                     91: 	}
                     92: 
                     93: 	my $file_submission = 
                     94: 	    &Apache::inputtags::show_past_file_submission($part,$id);
                     95: 	if ($file_submission) {
                     96: 	    $result .= '<td>'.$file_submission.'</td>';
                     97: 	}
                     98: 
                     99: 	my $port_submission = 
                    100: 	    &Apache::inputtags::show_past_portfile_submission($part,$id);
                    101: 	if ($port_submission) {
                    102: 	    $result .= '<td>'.$port_submission.'</td>';
                    103: 	}
                    104: 
                    105: 	if ($result ne '') {
                    106: 	    $result = 
                    107: 		'<table class="LC_pastsubmission"><tr>'.$result.
                    108: 		'</tr></table>';
                    109: 	}
1.10      ng        110:     }
                    111:     return $result;
1.1       albertel  112: }
                    113: 
                    114: sub end_essayresponse {
1.10      ng        115:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.13      ng        116:     my $part          = $Apache::inputtags::part;
1.14      albertel  117:     my $id            = $Apache::inputtags::response[-1];
1.70      albertel  118:     my $increment     = &Apache::response::repetition();
1.15      albertel  119:     my $result;
1.10      ng        120:     if ( $target eq 'grade' ) {
1.62      albertel  121: 	my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};	
1.14      albertel  122: 	if ($collaborators =~ /[^\s]/) {
1.34      albertel  123: 	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.14      albertel  124: 	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
                    125: 		if ($collaborators ne $previous_list);
                    126: 	}
1.58      albertel  127: 	if (  &Apache::response::submitted('scantron') ) {
1.31      albertel  128: 	    $increment=&Apache::response::scored_response($part,$id);
1.58      albertel  129: 	} elsif ( &Apache::response::submitted() ) {
1.62      albertel  130: 	    my $response      = $env{'form.HWVAL_'.$id};
                    131:             my $filename= $env{'form.HWFILE'.$part.'_'.$id.'.filename'};
                    132:             my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
1.42      banghart  133: 	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
1.61      albertel  134:  		my $award='DRAFT';
1.62      albertel  135:         	if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
1.14      albertel  136: 		    $award='SUBMITTED';
                    137: 		}
1.22      www       138:                 my $uploadedflag=0;
1.63      albertel  139: 		&file_submission($part,$id,'filename',\$award,\$uploadedflag);
                    140: 		&file_submission($part,$id,'portfiles',\$award,\$uploadedflag);
1.10      ng        141: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
1.14      albertel  142: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
1.10      ng        143: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
1.22      www       144: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
1.32      www       145: #
                    146: # Store with resource author for similarity testing
                    147: #
                    148:                 if ($award eq 'SUBMITTED') {
                    149: 		    my ($symb,$crsid,$domain,$name)=
                    150: 			&Apache::lonxml::whichuser();
                    151: 		    if ($crsid) {
                    152: 			my $akey=$name.'.'.$domain.'.'.$crsid;
                    153: 			my $essayurl=
                    154: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
                    155: 			my ($adom,$aname,$apath)=
                    156: 			    ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
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') {
                    173: 	$result.=&Apache::response::answer_header($$tagstack[-1]);
                    174: 	$result.=&Apache::response::answer_part($$tagstack[-1],'');
                    175: 	$result.=&Apache::response::answer_footer($$tagstack[-1]);
1.10      ng        176:     }
1.71      albertel  177: 
1.27      albertel  178:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
                    179: 	$target eq 'tex' || $target eq 'analyze') {
                    180: 	&Apache::lonxml::increment_counter($increment);
                    181:     }
1.10      ng        182:     &Apache::response::end_response;
1.42      banghart  183: 
1.15      albertel  184:     return $result;
1.10      ng        185: }
                    186: 
1.61      albertel  187: sub file_submission {
                    188:     my ($part,$id,$which,$award,$uploadedflag)=@_;
                    189:     my $files;
1.67      albertel  190:     my $jspart=$part;
                    191:     $jspart=~s/\./_/g;
                    192:     if ($which eq 'portfiles') { $files= $env{'form.HWPORT'.$jspart.'_'.$id}; }
1.61      albertel  193:     if ($which eq 'filename') {
1.67      albertel  194: 	$files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
1.61      albertel  195:     }
                    196:     
                    197:     if ($files =~ /[^\s]/) {
                    198: 	$files =~s/,$//;
                    199: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}=$files;
1.68      albertel  200: 	
                    201: 	my @submitted_files = ($files);
                    202: 	if ( $which eq 'portfiles' ) {
1.73      albertel  203: 	    @submitted_files = split(/\s*,\s*/,$files);
1.68      albertel  204: 	}
                    205: 
1.61      albertel  206: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
1.65      albertel  207: 	if ($uploadedfiletypes) {
                    208: 	    $uploadedfiletypes=~s/[^\w\,]//g;
                    209: 	    $uploadedfiletypes=','.$uploadedfiletypes.',';
                    210: 	    foreach my $file (@submitted_files) {
                    211: 		my ($extension)=($file=~/\.(\w+)$/);
                    212: 		unless ($uploadedfiletypes=~/\,$extension\,/i) {
                    213: 		    $$award='INVALID_FILETYPE';
                    214: 		}
1.61      albertel  215: 	    }
                    216: 	}
1.63      albertel  217: 	if ($$award ne 'INVALID_FILETYPE' && ref($uploadedflag)) {
1.61      albertel  218: 	    $$uploadedflag=1;
                    219: 	}
1.63      albertel  220: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
1.61      albertel  221: 	    my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
1.66      albertel  222: 	    &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
                    223: 	    &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,[$symb,$crsid]);
1.61      albertel  224: 	    &Apache::lonnet::clear_selected_files($name);
                    225: 	}
1.63      albertel  226: 	if ($$award ne 'INVALID_FILETYPE' && $which eq 'filename') {
1.61      albertel  227: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
                    228: 		$files;
                    229: 	    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
1.67      albertel  230: 		&Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef,
1.61      albertel  231: 						'essayresponse');
                    232: 	}
                    233:     } elsif ($which eq 'portfiles' &&
                    234: 	     $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
                    235: 	my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
1.66      albertel  236: 	&Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
1.61      albertel  237: 	$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
                    238:     }
                    239: }
                    240: 
1.10      ng        241: sub check_collaborators {
1.11      ng        242:     my ($ncol,$coll) = @_;
1.10      ng        243:     my %classlist=&Apache::lonnet::dump('classlist',
1.62      albertel  244: 					$env{'course.'.$env{'request.course.id'}.'.domain'},
                    245: 					$env{'course.'.$env{'request.course.id'}.'.num'});
1.10      ng        246:     my (@badcollaborators,$result);
                    247:     my (@collaborators) = split(/\,?\s+/,$coll);
                    248:     foreach (@collaborators) {
                    249: 	my $collaborator = $_;
                    250: 	if (/@/) {
                    251: 	    $collaborator =~ s/@/:/;
                    252: 	} else {
1.62      albertel  253: 	    $collaborator = $_.':'.$env{'user.domain'};
1.10      ng        254: 	}
                    255: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
                    256:     }
                    257:     
                    258:     if (scalar(@badcollaborators)) {
1.11      ng        259: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
                    260: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
                    261: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
1.10      ng        262:     }
                    263:     my $toomany = scalar(@collaborators) - $ncol;
                    264:     if ($toomany > 0) {
                    265: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
                    266: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
                    267: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
                    268:     }
                    269:     return $result;
1.1       albertel  270: }
1.2       albertel  271: 
                    272: 1;
                    273: __END__

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