--- loncom/homework/essayresponse.pm 2005/05/20 18:53:53 1.67
+++ loncom/homework/essayresponse.pm 2008/12/15 20:00:21 1.94
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# essay (ungraded) style responses
#
-# $Id: essayresponse.pm,v 1.67 2005/05/20 18:53:53 albertel Exp $
+# $Id: essayresponse.pm,v 1.94 2008/12/15 20:00:21 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -31,6 +31,8 @@ use strict;
use Apache::lonxml();
use Apache::lonnet;
use Apache::lonlocal;
+use LONCAPA qw(:DEFAULT :match);
+
BEGIN {
&Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
@@ -42,35 +44,81 @@ sub start_essayresponse {
my $id = &Apache::response::start_response($parstack,$safeeval);
if ($target eq 'meta') {
$result=&Apache::response::meta_package_write('essayresponse');
- } elsif ($target eq 'web') {
+ } elsif ($target eq 'web' &&
+ $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
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>'.
- '<label>'.
- '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
- &mt('Submit entries below as answer to receive credit').
- '</label> <br />'.
- '<label>'.
- '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
- &mt('Save entries below as a draft answer (not submitting them for credit yet)').
- '</label>'.
- ' </td></tr>';
+ my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize");
+ if (!defined($maxfilesize)) {
+ $maxfilesize = 10.0; #FIXME This should become a domain configuration
+ }
+ if ( $Apache::lonhomework::type eq 'survey' ) {
+ $result.= '<input type="hidden" name="HWDRAFT'.$part.'_'.$id.'" value="yes" /> ';
+ }
+ $result.='<br /><table border="1">';
+ if ( $Apache::lonhomework::type ne 'survey' ) {
+ $result.= '<tr><td>'.
+ '<label>'.
+ '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '.
+ &mt('Submit entries below as answer to receive credit').
+ '</label> <br />'.
+ '<label>'.
+ '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '.
+ &mt('Save entries below as a draft answer (not submitting them for credit yet)').
+ '</label>'.
+ '</td></tr>';
+ }
+
if ($ncol > 0) {
$result .='<tr><td>'.'<label>'.
- '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'}).
- '</label><br />';
+ &mt('Collaborators:').' <input type="text" size="70" max="80" name="HWCOL'.
+ $part.'_'.$id.'" value="'.$coll.'" /><br />'.
+ &mt('(Enter a maximum of [quant,_1,collaborator] using username or username:domain, e.g. smithje or smithje:[_2].)',$ncol,$env{'user.domain'});
+ if ($ncol > 1) {
+ $result .= '<br />'.&mt('If entering more than one, use spaces to separate the collaborators.');
+ }
+ $result .= '</label><br />';
$result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
$result .='</td></tr>';
}
- $result.=&Apache::inputtags::file_selector($part,$id,
- $uploadedfiletypes,'both');
+ my $filesfrom = 'both';
+ my $stuname = &Apache::lonnet::EXT('user.name');
+ my $studom = &Apache::lonnet::EXT('user.domain');
+ if (!&Apache::lonnet::usertools_access($stuname,$studom,'portfolio')) {
+ $filesfrom = 'uploadonly';
+ }
+ $result.=&Apache::inputtags::file_selector($part,$id,$uploadedfiletypes,
+ $filesfrom,undef,$maxfilesize);
$result.='</table>';
+ } elsif ($target eq 'web' &&
+ $Apache::inputtags::status[-1] ne 'CAN_ANSWER') {
+ my $part= $Apache::inputtags::part;
+ my @msgs;
+ if ($Apache::lonhomework::history{"resource.$part.$id.collaborators"} =~ /\S/) {
+ my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
+ $result .= '<td>'.&mt('Collaborated with [_1]',$coll).'</td>';
+ }
+
+ my $file_submission =
+ &Apache::inputtags::show_past_file_submission($part,$id);
+ if ($file_submission) {
+ $result .= '<td>'.$file_submission.'</td>';
+ }
+
+ my $port_submission =
+ &Apache::inputtags::show_past_portfile_submission($part,$id);
+ if ($port_submission) {
+ $result .= '<td>'.$port_submission.'</td>';
+ }
+
+ if ($result ne '') {
+ $result =
+ '<table class="LC_pastsubmission"><tr>'.$result.
+ '</tr></table>';
+ }
}
return $result;
}
@@ -79,7 +127,7 @@ sub end_essayresponse {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $part = $Apache::inputtags::part;
my $id = $Apache::inputtags::response[-1];
- my $increment = 1;
+ my $increment = &Apache::response::repetition();
my $result;
if ( $target eq 'grade' ) {
my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};
@@ -92,7 +140,8 @@ sub end_essayresponse {
$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 $filename = $env{'form.HWFILE'.$part.'_'.$id.'.filename'} ||
+ $env{'form.HWFILETOOBIG'.$part.'_'.$id};
my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
my $award='DRAFT';
@@ -100,8 +149,9 @@ sub end_essayresponse {
$award='SUBMITTED';
}
my $uploadedflag=0;
- &file_submission($part,$id,'filename',\$award,\$uploadedflag);
- &file_submission($part,$id,'portfiles',\$award,\$uploadedflag);
+ my $totalsize=0;
+ &file_submission($part,$id,'filename',\$award,\$uploadedflag,\$totalsize);
+ &file_submission($part,$id,'portfiles',\$award,\$uploadedflag,\$totalsize);
$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);
@@ -111,14 +161,15 @@ sub end_essayresponse {
#
if ($award eq 'SUBMITTED') {
my ($symb,$crsid,$domain,$name)=
- &Apache::lonxml::whichuser();
+ &Apache::lonnet::whichuser();
if ($crsid) {
- my $akey=$name.'.'.$domain.'.'.$crsid;
+ my $akey=join('.',&escape($name),&escape($domain),
+ &escape($crsid));
my $essayurl=
&Apache::lonnet::declutter($ENV{'REQUEST_URI'});
my ($adom,$aname,$apath)=
- ($essayurl=~/^(\w+)\/(\w+)\/(.*)$/);
- $apath=&Apache::lonnet::escape($apath);
+ ($essayurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\/(.*)$/);
+ $apath=&escape($apath);
$apath=~s/\W/\_/gs;
&Apache::lonnet::put('nohist_essay_'.$apath,
{ $akey => $response },$adom,$aname);
@@ -128,108 +179,269 @@ sub end_essayresponse {
}
} 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;
- }
+
+ } elsif ($target eq 'tex'
+ && $Apache::lonhomework::type eq 'exam') {
+ $result .= &Apache::inputtags::exam_score_line($target);
+
+ } elsif ($target eq 'answer') {
+ $result.=&Apache::response::answer_header($$tagstack[-1]);
+ my $answer = &mt('Essay will be hand graded.');
+ $result.=&Apache::response::answer_part($$tagstack[-1],$answer,
+ {'no_verbatim' => 1});
+ $result.=&Apache::response::answer_footer($$tagstack[-1]);
}
+ if ($target eq 'web') {
+ &Apache::response::setup_prior_tries_hash(\&format_prior_response,
+ ['portfiles',
+ 'uploadedurl']);
+ }
+
if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
$target eq 'tex' || $target eq 'analyze') {
- &Apache::lonxml::increment_counter($increment);
+ &Apache::lonxml::increment_counter($increment, "$part.$id");
+
+ if ($target eq 'analyze') {
+ $Apache::lonhomework::analyze{"$part.$id.type"} = 'essayresponse';
+ &Apache::lonhomework::set_bubble_lines();
+ }
}
&Apache::response::end_response;
return $result;
}
+sub format_prior_response {
+ my ($mode,$answer,$other_data) = @_;
+ my $output;
+
+ my (undef,undef,$udom,$uname) = &Apache::lonnet::whichuser();
+ my $port_url = '/uploaded/'.$udom.'/'.$uname.'/portfolio/';
+
+ my $file_list;
+
+ foreach my $file (split(/\s*,\s*/,
+ $other_data->[0].','.$other_data->[1])) {
+ next if ($file!~/\S/);
+ if ($file !~ m{^/uploaded/}) { $file=$port_url.$file; }
+ $file=~s|/+|/|g;
+ &Apache::lonnet::allowuploaded('/adm/essayresponse',$file);
+ $file_list.='<li><span class="LC_nobreak"><a href="'.$file.'?rawmode=1" target="lonGRDs"><img src="'.
+ &Apache::loncommon::icon($file).'" alt="file icon" border="0" /> '.$file.
+ '</a></span></li>'."\n";
+ }
+ if ($file_list) {
+ $output.= &mt('Submitted Files').'<ul>'.$file_list.'</ul>';
+ }
+ if ($answer =~ /\S/) {
+ $output.='<p>'.&mt('Submitted text').
+ '<blockquote>'.$answer.'</blockquote></p>';
+ }
+
+ return '<div class="LC_prior_essay">'.$output.'</div>';
+}
+
sub file_submission {
- my ($part,$id,$which,$award,$uploadedflag)=@_;
+ my ($part,$id,$which,$award,$uploadedflag,$totalsize)=@_;
my $files;
my $jspart=$part;
$jspart=~s/\./_/g;
- if ($which eq 'portfiles') { $files= $env{'form.HWPORT'.$jspart.'_'.$id}; }
- if ($which eq 'filename') {
- $files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
+ if ($which eq 'portfiles') {
+ $files= $env{'form.HWPORT'.$jspart.'_'.$id};
+ } elsif ($which eq 'filename') {
+ if ($env{'form.HWFILETOOBIG'.$jspart.'_'.$id} ne '') {
+ $$award = 'EXCESS_FILESIZE';
+ return;
+ } else {
+ $files = $env{'form.HWFILE'.$jspart.'_'.$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");
- if ($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)) {
+ my (@submitted_files,@acceptable_files,@accepted_files);
+ if ($which eq 'portfiles') {
+ @submitted_files = split(/\s*,\s*/,$files);
+ } else {
+ @submitted_files = ($files);
+ }
+ my $uploadedfiletypes=
+ &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
+ if ($uploadedfiletypes) {
+ $uploadedfiletypes=~s/[^\w\,]//g;
+ $uploadedfiletypes=','.$uploadedfiletypes.',';
+ foreach my $file (@submitted_files) {
+ my ($extension)=($file=~/\.(\w+)$/);
+ if ($uploadedfiletypes=~/\,\s*\Q$extension\E\s*\,/i) {
+ push(@acceptable_files,$file);
+ } else {
+ $$award='INVALID_FILETYPE';
+ if ($which eq 'filename') {
+ &delete_form_items($jspart,$id);
+ }
+ }
+ }
+ }
+ my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize");
+ if (!$maxfilesize) {
+ $maxfilesize = 10.0; #FIXME This should become a domain configuration
+ }
+ my %dirlist;
+ foreach my $file (@acceptable_files) {
+ if ($which eq 'filename') {
+ if (ref($totalsize)) {
+ $$totalsize += $env{'form.HWFILESIZE'.$jspart.'_'.$id};
+ }
+ } else {
+ my ($symb,$crsid,$udom,$uname) = &Apache::lonnet::whichuser();
+ my ($path,$filename) = ($file =~ m{^(.+)/([^/]+)$});
+ my $fullpath = '/userfiles/portfolio'.$path;
+ if (!exists($dirlist{$fullpath})) {
+ my @list = &Apache::lonnet::dirlist($fullpath,$udom,$uname,1);
+ foreach my $dir_line (@list) {
+ my ($fname,$dom,undef,$testdir,undef,undef,undef,undef,
+ $size,undef,$mtime,undef,undef,undef,$obs,undef) =
+ split(/\&/,$dir_line,16);
+ if ($filename eq $fname) {
+ my $mbsize = $size/(1024.0*1024.0);
+ if (ref($totalsize)) {
+ $$totalsize += $mbsize;
+ }
+ last;
+ }
+ }
+ $dirlist{$fullpath} = \@list;
+ }
+ }
+ if (ref($totalsize)) {
+ if ($$totalsize > $maxfilesize) {
+ $$award='EXCESS_FILESIZE';
+ if ($which eq 'filename') {
+ &delete_form_items($jspart,$id);
+ }
+ } else {
+ push(@accepted_files,$file);
+ }
+ } else {
+ push(@accepted_files,$file);
+ }
+ }
+ $Apache::lonhomework::results{"resource.$part.$id.$which"}=join(',',@accepted_files);
+ if (($$award eq 'INVALID_FILETYPE') || ($award eq 'EXCESS_FILESIZE')) {
+ return;
+ }
+ if (ref($uploadedflag)) {
$$uploadedflag=1;
}
- if ($$award ne 'INVALID_FILETYPE' && $which eq 'portfiles') {
- my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
+ if ($which eq 'portfiles') {
+ my ($symb,$crsid,$domain,$name)=&Apache::lonnet::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') {
+ if ($which eq 'filename') {
$Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
$files;
$Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
&Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef,
'essayresponse');
+ &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id});
}
} elsif ($which eq 'portfiles' &&
$Apache::lonhomework::history{"resource.$part.$id.$which"}) {
- my ($symb,$crsid,$domain,$name)=&Apache::lonxml::whichuser();
+ my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
&Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
$Apache::lonhomework::results{"resource.$part.$id.$which"}="";
}
}
+sub delete_form_items {
+ my ($jspart,$id) = @_;
+ &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id.'.filename'});
+ &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id.'.mimetype'});
+ &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id});
+}
+
+
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/@/:/;
+
+ my (@collaborators) = split(/,?\s+/,$coll);
+ foreach my $entry (@collaborators) {
+ my $collaborator;
+ if ($entry =~ /:/) {
+ $collaborator = $entry;
} else {
- $collaborator = $_.':'.$env{'user.domain'};
+ $collaborator = $entry.':'.$env{'user.domain'};
}
- push @badcollaborators, $_ if (!grep /^$collaborator/i,keys %classlist);
+ if ($collaborator !~ /^$match_username:$match_domain$/) {
+ if (!grep(/^\Q$entry\E$/,@badcollaborators)) {
+ push(@badcollaborators,$entry);
+ }
+ } elsif (!grep(/^\Q$collaborator\E$/i,keys(%classlist))) {
+ if (!grep(/^\Q$entry\E$/,@badcollaborators)) {
+ push(@badcollaborators,$entry);
+ }
+ }
}
- 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 $numbad = scalar(@badcollaborators);
+ if ($numbad) {
+ $result = '<table border="0"><tr bgcolor="#ffbbbb"><td>';
+ if ($numbad == 1) {
+ $result .= &mt('The following user is invalid:');
+ } else {
+ $result .= &mt('The following [_1] users are invalid:',$numbad);
+ }
+ $result .= ' '.join(', ',@badcollaborators).'. '.&mt('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>';
+ &mt('You have too many collaborators.').' '.
+ &mt('Please remove [quant,_1,collaborator].',$toomany).
+ '</td></tr></table>';
}
return $result;
}
1;
__END__
+
+
+=pod
+
+=head1 NAME
+
+Apache::easyresponse
+
+=head1 SYNOPSIS
+
+Handler to evaluate essay (ungraded) style responses.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=item start_essayresponse()
+
+=item end_essayresponse()
+
+=item format_prior_response()
+
+=item file_submission()
+
+=item delete_form_items()
+
+=item check_collaborators()
+
+=back
+
+=cut