--- loncom/homework/essayresponse.pm	2001/04/04 19:17:50	1.1
+++ loncom/homework/essayresponse.pm	2005/04/07 06:56:21	1.62
@@ -1,30 +1,226 @@
 # The LearningOnline Network with CAPA
 # essay (ungraded) style responses
-# 4/3 Guy
+#
+# $Id: essayresponse.pm,v 1.62 2005/04/07 06:56:21 albertel Exp $
+#
+# Copyright Michigan State University Board of Trustees
+#
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
+#
+# LON-CAPA is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LON-CAPA is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with LON-CAPA; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# /home/httpd/html/adm/gpl.txt
+#
+# http://www.lon-capa.org/
+#
+
 package Apache::essayresponse;
 use strict;
+use Apache::lonxml();
+use Apache::lonnet;
+use Apache::lonlocal;
 
-sub BEGIN {
-  &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
+BEGIN {
+    &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
 }
 
 sub start_essayresponse {
-  my ($target,$token,$parstack,$parser,$safeeval,$style)=@_;
-  my $id = &Apache::response::start_response($parstack,$safeeval);
-  return '';
+    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+    my $result;
+    my $id = &Apache::response::start_response($parstack,$safeeval);
+    if ($target eq 'meta') {
+	$result=&Apache::response::meta_package_write('essayresponse');
+    } elsif ($target eq 'web') {
+	my $part= $Apache::inputtags::part;
+	my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
+	my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
+	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
+        $uploadedfiletypes=~s/[^\w\,]//g;
+	$result='<br /><table border="1">';
+	$result.='<tr><td>'.
+	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
+	    &mt('Submit entries below as answer to receive credit').' <br />'.
+	    '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
+	    &mt('Save entries below as a draft answer (not submitting them for credit yet)').
+	    ' </td></tr>';
+	if ($ncol > 0) {
+	    $result .='<tr><td>'.
+		'Collaborators: <input type="text" size="70" max="80" name="HWCOL'.
+		$part.'_'.$id.'" value="'.$coll.'" /><br />'.
+		&mt('(Enter maximum [_1] collaborators using username or username@domain, e.g. smithje or smithje@[_2].)',$ncol,$env{'user.domain'}).'<br />';
+	    $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
+	    $result .='</td></tr>';
+	}
+	$result.=&Apache::inputtags::file_selector($part,$id,
+						   $uploadedfiletypes,'both');
+        $result.='</table>';
+    }
+    return $result;
 }
 
 sub end_essayresponse {
-  my ($target,$token,$parstack,$parser,$safeeval,$style)=@_;
-  if ( $target eq 'grade' ) {
-    if ( defined $ENV{'form.submitted'}) {
-      my $id = $Apache::inputtags::response['-1'];
-      $Apache::lonhomework::results{"resource.$Apache::inputtags::part.$id.submission"}=$response;
-      $Apache::lonhomework::results{"resource.$Apache::inputtags::part.$id.awarddetail"}="SUBMITTED";
-      
+    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+    my $part          = $Apache::inputtags::part;
+    my $id            = $Apache::inputtags::response[-1];
+    my $increment     = 1;
+    my $result;
+    if ( $target eq 'grade' ) {
+	my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};	
+	if ($collaborators =~ /[^\s]/) {
+	    my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
+	    $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
+		if ($collaborators ne $previous_list);
+	}
+	if (  &Apache::response::submitted('scantron') ) {
+	    $increment=&Apache::response::scored_response($part,$id);
+	} elsif ( &Apache::response::submitted() ) {
+	    my $response      = $env{'form.HWVAL_'.$id};
+            my $filename= $env{'form.HWFILE'.$part.'_'.$id.'.filename'};
+            my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
+	    if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
+ 		my $award='DRAFT';
+        	if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
+		    $award='SUBMITTED';
+		}
+                my $uploadedflag=0;
+		&file_submission($part,$id,'filename',$award,\$uploadedflag);
+		&file_submission($part,$id,'portfiles',$award,\$uploadedflag);
+		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
+		$Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
+		my %previous=&Apache::response::check_for_previous($response,$part,$id);
+		unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
+#
+# Store with resource author for similarity testing
+#
+                if ($award eq 'SUBMITTED') {
+		    my ($symb,$crsid,$domain,$name)=
+			&Apache::lonxml::whichuser();
+		    if ($crsid) {
+			my $akey=$name.'.'.$domain.'.'.$crsid;
+			my $essayurl=
+			    &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
+			my ($adom,$aname,$apath)=
+			    ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
+                        $apath=&Apache::lonnet::escape($apath);
+			$apath=~s/\W/\_/gs;
+			&Apache::lonnet::put('nohist_essay_'.$apath,
+					 { $akey => $response },$adom,$aname);
+		    }
+                }
+	    }
+	} 
+    } elsif ($target eq 'edit') {
+	$result.=&Apache::edit::end_table();
+    } elsif ($target eq 'tex') {
+	if ($Apache::lonhomework::type eq 'exam') {
+	    my $repetition=&Apache::response::repetition();
+	    $result.='\begin{enumerate}';
+	    if ($env{'request.state'} eq "construct" ) {$result.='\item[\strut]';}
+	    for (my $i=0;$i<$repetition;$i++) {
+		$result.='\item[\textbf{'.($Apache::lonxml::counter+$i).
+		    '}.]\textit{'.&mt('Leave blank on scoring form').
+		    '}\vskip 0 mm';
+	    }
+	    $result.= '\end{enumerate}';
+	    $increment=$repetition;
+	}
     }
-  }
+    if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
+	$target eq 'tex' || $target eq 'analyze') {
+	&Apache::lonxml::increment_counter($increment);
+    }
+    &Apache::response::end_response;
 
-  &Apache::response::end_response;
-  return '';
+    return $result;
+}
+
+sub file_submission {
+    my ($part,$id,$which,$award,$uploadedflag)=@_;
+    my $files;
+    if ($which eq 'portfiles') { $files= $env{'form.HWPORT'.$part.'_'.$id}; }
+    if ($which eq 'filename') {
+	$files = $env{'form.HWFILE'.$part.'_'.$id.'.filename'};
+    }
+    
+    if ($files =~ /[^\s]/) {
+	$files =~s/,$//;
+	$Apache::lonhomework::results{"resource.$part.$id.$which"}=$files;
+	my @submitted_files = split(/,/,$files);
+	my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
+	$uploadedfiletypes=~s/[^\w\,]//g;
+	$uploadedfiletypes=','.$uploadedfiletypes.',';
+	foreach my $file (@submitted_files) {
+	    my ($extension)=($file=~/\.(\w+)$/);
+	    unless ($uploadedfiletypes=~/\,$extension\,/i) {
+		$award='INVALID_FILETYPE';
+	    }
+	}
+	if ($award ne 'INVALID_FILETYPE' && ref($uploadedflag)) {
+	    $$uploadedflag=1;
+	}
+	if ($award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
+	    my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
+	    &Apache::lonnet::unmark_as_readonly($domain,$name,$symb.$crsid);
+	    &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,$symb.$crsid);
+	    &Apache::lonnet::clear_selected_files($name);
+	}
+	if ($award ne 'INVALID_FILETYPE' && $which eq 'filename') {
+	    $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
+		$files;
+	    $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
+		&Apache::lonnet::userfileupload('HWFILE'.$part.'_'.$id,undef,
+						'essayresponse');
+	}
+    } elsif ($which eq 'portfiles' &&
+	     $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
+	my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
+	&Apache::lonnet::unmark_as_readonly($domain,$name,$symb.$crsid);
+	$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
+    }
 }
+
+sub check_collaborators {
+    my ($ncol,$coll) = @_;
+    my %classlist=&Apache::lonnet::dump('classlist',
+					$env{'course.'.$env{'request.course.id'}.'.domain'},
+					$env{'course.'.$env{'request.course.id'}.'.num'});
+    my (@badcollaborators,$result);
+    my (@collaborators) = split(/\,?\s+/,$coll);
+    foreach (@collaborators) {
+	my $collaborator = $_;
+	if (/@/) {
+	    $collaborator =~ s/@/:/;
+	} else {
+	    $collaborator = $_.':'.$env{'user.domain'};
+	}
+	push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
+    }
+    
+    if (scalar(@badcollaborators)) {
+	$result = '<table border="0"><tr bgcolor="#ffbbbb"><td> The following user'.
+	    (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '.
+	    join(', ',@badcollaborators).'. Please correct.</td></tr></table>';
+    }
+    my $toomany = scalar(@collaborators) - $ncol;
+    if ($toomany > 0) {
+	$result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
+	    'You have too many collaborators. Please remove '.$toomany.' collaborator'.
+	    ($toomany > 1 ? 's' :'').'.</td></tr></table>';
+    }
+    return $result;
+}
+
+1;
+__END__