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

1.1       albertel    1: # The LearningOnline Network with CAPA
                      2: # essay (ungraded) style responses
1.5       albertel    3: #
1.58    ! albertel    4: # $Id: essayresponse.pm,v 1.57 2004/12/21 22:46:27 banghart 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();
                     32: use Apache::lonnet();
                     33: use Apache::lonlocal;
1.1       albertel   34: 
1.6       harris41   35: BEGIN {
1.10      ng         36:     &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
1.1       albertel   37: }
                     38: 
                     39: sub start_essayresponse {
1.10      ng         40:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                     41:     my $result;
1.14      albertel   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') {
1.10      ng         46: 	my $part= $Apache::inputtags::part;
                     47: 	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
1.34      albertel   48: 	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.17      www        49: 	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
1.21      www        50:         $uploadedfiletypes=~s/[^\w\,]//g;
1.34      albertel   51: 	my $uploadedfile= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.uploadedfile"},'<>&"');
1.13      ng         52: 	$result='<br /><table border="1">';
1.22      www        53: 	$result.='<tr><td>'.
1.47      albertel   54: 	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
1.33      albertel   55: 	    &mt('Submit entries below as answer to receive credit').' <br />'.
1.47      albertel   56: 	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
1.33      albertel   57: 	    &mt('Save entries below as a draft answer (not submitting them for credit yet)').
                     58: 	    ' </td></tr>';
1.10      ng         59: 	if ($ncol > 0) {
1.13      ng         60: 	    $result .='<tr><td>'.
                     61: 		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
                     62: 		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
1.33      albertel   63: 		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$ENV{'user.domain'}).'<br />';
1.10      ng         64: 	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
1.13      ng         65: 	    $result .='</td></tr>';
1.10      ng         66: 	}
1.17      www        67:         if ($uploadedfiletypes) {
1.54      banghart   68: 	    $result.='<tr><td>'.&mt('Submit a file: (only one file can be uploaded)').
1.42      banghart   69: 		' <br /><input type="file" size="50" name="HWFILE'.
1.55      albertel   70: 		$part.'_'.$id.'" /><br />'.
1.42      banghart   71: 		&mt('Allowed filetypes: <b>[_1]</b>',$uploadedfiletypes).'<br />'.
1.53      banghart   72:                 '<strong>OR:</strong><br /><a href='."'".'javascript:void(window.open("/adm/portfolio?mode=selectfile&amp;fieldname=HWPORT'.$part.'_'.$id.'","cat","height=600,width=800,scrollbars=1,resizable=1,menubar=2,location=1"))'."'".'>Select Portfolio Files</a>'.
1.42      banghart   73:                 '<br />'.
                     74:                 '<input type="text" size="50" name="HWPORT'.$part.'_'.$id.'" value="" />'.
1.33      albertel   75: 		'<br />';
1.44      banghart   76: 	    if ($Apache::lonhomework::history{"resource.$part.$id.portfiles"}=~/[^\s]/){
1.52      banghart   77: 	        $result.="Portfolio files previously selected: <strong>".&Apache::lonnet::unescape($Apache::lonhomework::history{"resource.$part.$id.portfiles"})."</strong><br />";
1.43      banghart   78: 	    }
                     79: 
                     80:             if ($uploadedfile) {
1.35      albertel   81: 	       my $url=$Apache::lonhomework::history{"resource.$part.$id.uploadedurl"};
                     82: 	       push (@Apache::lonxml::extlinks,$url);
                     83: 	       &Apache::lonnet::allowuploaded('/adm/essayresponse',$url);
                     84: 	       my $curfile='<a href="'.$url.
1.33      albertel   85: 		   '"><img src="/adm/lonIcons/unknown.gif" border=0" /> '.
                     86: 		   $uploadedfile.'</a>';
                     87: 	       $result.=&mt('Currently submitted: <tt>[_1]</tt>',$curfile);
1.19      www        88:            } else {
1.33      albertel   89:               $result.=&mt('(Hand in a file you have prepared on your computer)');
1.19      www        90:            }
                     91:            $result.='</td></tr>'; 
1.17      www        92:         }
1.22      www        93:         $result.='</table>';
1.10      ng         94:     }
                     95:     return $result;
1.1       albertel   96: }
                     97: 
                     98: sub end_essayresponse {
1.10      ng         99:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.13      ng        100:     my $part          = $Apache::inputtags::part;
1.14      albertel  101:     my $id            = $Apache::inputtags::response[-1];
1.27      albertel  102:     my $increment     = 1;
1.15      albertel  103:     my $result;
1.10      ng        104:     if ( $target eq 'grade' ) {
1.14      albertel  105: 	my $collaborators = $ENV{'form.HWCOL'.$part.'_'.$id};	
                    106: 	if ($collaborators =~ /[^\s]/) {
1.34      albertel  107: 	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.14      albertel  108: 	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
                    109: 		if ($collaborators ne $previous_list);
                    110: 	}
1.58    ! albertel  111: 	if (  &Apache::response::submitted('scantron') ) {
1.31      albertel  112: 	    $increment=&Apache::response::scored_response($part,$id);
1.58    ! albertel  113: 	} elsif ( &Apache::response::submitted() ) {
1.26      albertel  114: 	    my $response      = $ENV{'form.HWVAL_'.$id};
1.22      www       115:             my $filename= $ENV{'form.HWFILE'.$part.'_'.$id.'.filename'};
1.42      banghart  116:             my $portfiles = $ENV{'form.HWPORT'.$part.'_'.$id};
                    117: 	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
1.22      www       118:  		my $award;
1.42      banghart  119:         	if ($ENV{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
1.14      albertel  120: 		    $award='SUBMITTED';
                    121: 		} else {
                    122: 		    $award='DRAFT';
                    123: 		}
1.22      www       124:                 my $uploadedflag=0;
                    125:                 if ($filename =~ /[^\s]/) {
1.54      banghart  126:  	            my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
                    127:                     $uploadedfiletypes=~s/[^\w\,]//g;
                    128:                     $uploadedfiletypes=','.$uploadedfiletypes.',';
                    129:                     my ($extension)=($filename=~/\.(\w+)$/);
                    130: 	            if ($uploadedfiletypes=~/\,$extension\,/i) {
                    131: 	                $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=$filename;
                    132:                         $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
                    133:                         &Apache::lonnet::userfileupload('HWFILE'.$part.'_'.$id,undef,'essayresponse');
                    134:                         $uploadedflag=1;
                    135: 		    } else {
                    136: 		        $award='INVALID_FILETYPE';
                    137:                     }
1.53      banghart  138: 	        } else {
                    139: 	           $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}="";
                    140:                    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}="";
1.22      www       141: 	        }
1.42      banghart  142:                 if ($portfiles =~ /[^\s]/) {
1.50      albertel  143:                     $portfiles =~s/,$//;
1.41      banghart  144:                     $Apache::lonhomework::results{"resource.$part.$id.portfiles"}=$portfiles;
1.45      banghart  145:                     my @submitted_files = split /,/,$portfiles;
1.48      banghart  146: 		    my ($dsymb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
                    147: 		    &Apache::lonnet::unmark_as_readonly($domain,$name,$dsymb.$crsid);
                    148:                     &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,$dsymb.$crsid);
1.51      banghart  149:                     &Apache::lonnet::clear_selected_files($name);
1.42      banghart  150:                     $uploadedflag=1;
1.53      banghart  151:     	        } else {
1.57      banghart  152: 		    my ($dsymb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
                    153:     	            &Apache::lonnet::unmark_as_readonly($domain,$name,$dsymb.$crsid);
1.53      banghart  154:     	            $Apache::lonhomework::results{"resource.$part.$id.portfiles"}="";
1.42      banghart  155:     	        }
1.10      ng        156: 		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
1.14      albertel  157: 		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
1.10      ng        158: 		my %previous=&Apache::response::check_for_previous($response,$part,$id);
1.22      www       159: 		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
1.32      www       160: #
                    161: # Store with resource author for similarity testing
                    162: #
                    163:                 if ($award eq 'SUBMITTED') {
                    164: 		    my ($symb,$crsid,$domain,$name)=
                    165: 			&Apache::lonxml::whichuser();
                    166: 		    if ($crsid) {
                    167: 			my $akey=$name.'.'.$domain.'.'.$crsid;
                    168: 			my $essayurl=
                    169: 			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
                    170: 			my ($adom,$aname,$apath)=
                    171: 			    ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
                    172:                         $apath=&Apache::lonnet::escape($apath);
                    173: 			$apath=~s/\W/\_/gs;
                    174: 			&Apache::lonnet::put('nohist_essay_'.$apath,
                    175: 					 { $akey => $response },$adom,$aname);
                    176: 		    }
1.42      banghart  177:                 }
1.10      ng        178: 	    }
1.42      banghart  179: 	} 
1.15      albertel  180:     } elsif ($target eq 'edit') {
                    181: 	$result.=&Apache::edit::end_table();
1.16      sakharuk  182:     } elsif ($target eq 'tex') {
                    183: 	if ($Apache::lonhomework::type eq 'exam') {
1.27      albertel  184: 	    my $repetition=&Apache::response::repetition();
1.25      sakharuk  185: 	    $result.='\begin{enumerate}';
1.36      sakharuk  186: 	    if ($ENV{'request.state'} eq "construct" ) {$result.='\item[\strut]';}
1.25      sakharuk  187: 	    for (my $i=0;$i<$repetition;$i++) {
1.27      albertel  188: 		$result.='\item[\textbf{'.($Apache::lonxml::counter+$i).
1.33      albertel  189: 		    '}.]\textit{'.&mt('Leave blank on scoring form').
                    190: 		    '}\vskip 0 mm';
1.25      sakharuk  191: 	    }
                    192: 	    $result.= '\end{enumerate}';
1.37      albertel  193: 	    $increment=$repetition;
1.16      sakharuk  194: 	}
1.10      ng        195:     }
1.27      albertel  196:     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
                    197: 	$target eq 'tex' || $target eq 'analyze') {
                    198: 	&Apache::lonxml::increment_counter($increment);
                    199:     }
1.10      ng        200:     &Apache::response::end_response;
1.42      banghart  201: 
1.15      albertel  202:     return $result;
1.10      ng        203: }
                    204: 
                    205: sub check_collaborators {
1.11      ng        206:     my ($ncol,$coll) = @_;
1.10      ng        207:     my %classlist=&Apache::lonnet::dump('classlist',
                    208: 					$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
                    209: 					$ENV{'course.'.$ENV{'request.course.id'}.'.num'});
                    210:     my (@badcollaborators,$result);
                    211:     my (@collaborators) = split(/\,?\s+/,$coll);
                    212:     foreach (@collaborators) {
                    213: 	my $collaborator = $_;
                    214: 	if (/@/) {
                    215: 	    $collaborator =~ s/@/:/;
                    216: 	} else {
                    217: 	    $collaborator = $_.':'.$ENV{'user.domain'};
                    218: 	}
                    219: 	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
                    220:     }
                    221:     
                    222:     if (scalar(@badcollaborators)) {
1.11      ng        223: 	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
                    224: 	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
                    225: 	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
1.10      ng        226:     }
                    227:     my $toomany = scalar(@collaborators) - $ncol;
                    228:     if ($toomany > 0) {
                    229: 	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
                    230: 	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
                    231: 	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
                    232:     }
                    233:     return $result;
1.1       albertel  234: }
1.2       albertel  235: 
                    236: 1;
                    237: __END__

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