File:  [LON-CAPA] / loncom / homework / essayresponse.pm
Revision 1.60: download - view: text, annotated - select for diffs
Thu Mar 31 21:24:29 2005 UTC (19 years, 1 month ago) by albertel
Branches: MAIN
CVS tags: HEAD
- some cleanups/improvments to the file submission layout
- modularize the file submission code
- allow a user to submit a portfolio file

    1: # The LearningOnline Network with CAPA
    2: # essay (ungraded) style responses
    3: #
    4: # $Id: essayresponse.pm,v 1.60 2005/03/31 21:24:29 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;
   94:         	if ($ENV{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
   95: 		    $award='SUBMITTED';
   96: 		} else {
   97: 		    $award='DRAFT';
   98: 		}
   99:                 my $uploadedflag=0;
  100:                 if ($filename =~ /[^\s]/) {
  101:  	            my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
  102:                     $uploadedfiletypes=~s/[^\w\,]//g;
  103:                     $uploadedfiletypes=','.$uploadedfiletypes.',';
  104:                     my ($extension)=($filename=~/\.(\w+)$/);
  105: 	            if ($uploadedfiletypes=~/\,$extension\,/i) {
  106: 	                $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=$filename;
  107:                         $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
  108:                         &Apache::lonnet::userfileupload('HWFILE'.$part.'_'.$id,undef,'essayresponse');
  109:                         $uploadedflag=1;
  110: 		    } else {
  111: 		        $award='INVALID_FILETYPE';
  112:                     }
  113: 	        } else {
  114: 	           $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}="";
  115:                    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}="";
  116: 	        }
  117:                 if ($portfiles =~ /[^\s]/) {
  118:                     $portfiles =~s/,$//;
  119:                     $Apache::lonhomework::results{"resource.$part.$id.portfiles"}=$portfiles;
  120:                     my @submitted_files = split /,/,$portfiles;
  121:  	            my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
  122:                     $uploadedfiletypes=~s/[^\w\,]//g;
  123:                     $uploadedfiletypes=','.$uploadedfiletypes.',';
  124:                     foreach (@submitted_files) {
  125:                         my ($extension)=($_=~/\.(\w+)$/);
  126: 	                unless ($uploadedfiletypes=~/\,$extension\,/i) {
  127: 	                    $award='INVALID_FILETYPE';
  128:                         }
  129:                     }
  130:                     if ($award ne 'INVALID_FILETYPE'){
  131:         		my ($dsymb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
  132:         		&Apache::lonnet::unmark_as_readonly($domain,$name,$dsymb.$crsid);
  133:                         &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,$dsymb.$crsid);
  134:                         &Apache::lonnet::clear_selected_files($name);
  135:                         $uploadedflag=1;
  136:                     }
  137:     	        } else {
  138: 		    my ($dsymb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
  139:     	            &Apache::lonnet::unmark_as_readonly($domain,$name,$dsymb.$crsid);
  140:     	            $Apache::lonhomework::results{"resource.$part.$id.portfiles"}="";
  141:     	        }
  142: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
  143: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
  144: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
  145: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
  146: #
  147: # Store with resource author for similarity testing
  148: #
  149:                 if ($award eq 'SUBMITTED') {
  150: 		    my ($symb,$crsid,$domain,$name)=
  151: 			&Apache::lonxml::whichuser();
  152: 		    if ($crsid) {
  153: 			my $akey=$name.'.'.$domain.'.'.$crsid;
  154: 			my $essayurl=
  155: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
  156: 			my ($adom,$aname,$apath)=
  157: 			    ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
  158:                         $apath=&Apache::lonnet::escape($apath);
  159: 			$apath=~s/\W/\_/gs;
  160: 			&Apache::lonnet::put('nohist_essay_'.$apath,
  161: 					 { $akey => $response },$adom,$aname);
  162: 		    }
  163:                 }
  164: 	    }
  165: 	} 
  166:     } elsif ($target eq 'edit') {
  167: 	$result.=&Apache::edit::end_table();
  168:     } elsif ($target eq 'tex') {
  169: 	if ($Apache::lonhomework::type eq 'exam') {
  170: 	    my $repetition=&Apache::response::repetition();
  171: 	    $result.='\begin{enumerate}';
  172: 	    if ($ENV{'request.state'} eq "construct" ) {$result.='\item[\strut]';}
  173: 	    for (my $i=0;$i<$repetition;$i++) {
  174: 		$result.='\item[\textbf{'.($Apache::lonxml::counter+$i).
  175: 		    '}.]\textit{'.&mt('Leave blank on scoring form').
  176: 		    '}\vskip 0 mm';
  177: 	    }
  178: 	    $result.= '\end{enumerate}';
  179: 	    $increment=$repetition;
  180: 	}
  181:     }
  182:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
  183: 	$target eq 'tex' || $target eq 'analyze') {
  184: 	&Apache::lonxml::increment_counter($increment);
  185:     }
  186:     &Apache::response::end_response;
  187: 
  188:     return $result;
  189: }
  190: 
  191: sub check_collaborators {
  192:     my ($ncol,$coll) = @_;
  193:     my %classlist=&Apache::lonnet::dump('classlist',
  194: 					$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
  195: 					$ENV{'course.'.$ENV{'request.course.id'}.'.num'});
  196:     my (@badcollaborators,$result);
  197:     my (@collaborators) = split(/\,?\s+/,$coll);
  198:     foreach (@collaborators) {
  199: 	my $collaborator = $_;
  200: 	if (/@/) {
  201: 	    $collaborator =~ s/@/:/;
  202: 	} else {
  203: 	    $collaborator = $_.':'.$ENV{'user.domain'};
  204: 	}
  205: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
  206:     }
  207:     
  208:     if (scalar(@badcollaborators)) {
  209: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
  210: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
  211: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
  212:     }
  213:     my $toomany = scalar(@collaborators) - $ncol;
  214:     if ($toomany > 0) {
  215: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
  216: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
  217: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
  218:     }
  219:     return $result;
  220: }
  221: 
  222: 1;
  223: __END__

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