--- loncom/homework/essayresponse.pm 2003/04/18 07:12:13 1.27 +++ loncom/homework/essayresponse.pm 2008/11/10 13:18:19 1.90 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # essay (ungraded) style responses # -# $Id: essayresponse.pm,v 1.27 2003/04/18 07:12:13 albertel Exp $ +# $Id: essayresponse.pm,v 1.90 2008/11/10 13:18:19 jms Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,13 +25,29 @@ # # http://www.lon-capa.org/ # -# 4/3 Guy -# July, 2002, H. K. Ng -# + +=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. + +=cut + package Apache::essayresponse; use strict; -use Apache::lonxml; +use Apache::lonxml(); use Apache::lonnet; +use Apache::lonlocal; +use LONCAPA qw(:DEFAULT :match); + BEGIN { &Apache::lonxml::register('Apache::essayresponse',('essayresponse')); @@ -43,44 +59,71 @@ 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 $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"'); my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes"); $uploadedfiletypes=~s/[^\w\,]//g; - my $uploadedfile= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.uploadedfile"}); - $result='
'; - $result.=''; + if ( $Apache::lonhomework::type eq 'survey' ) { + $result.= ' '; + } + $result.='
'. - ''. - ' Submit entries below as answer to receive credit
'. - ''. - ' Save entries below as a draft answer (not submitting them for credit yet) '. - '
'; + if ( $Apache::lonhomework::type ne 'survey' ) { + $result.= ''; + } + if ($ncol > 0) { - $result .=''; } - if ($uploadedfiletypes) { - $result.= -''; - } + $result.=&Apache::inputtags::file_selector($part,$id, + $uploadedfiletypes,'both'); $result.='
'. + '
'. + ''. + '
'. - 'Collaborators:
'. - '(Enter maximum '.$ncol.' collaborators using username or username@domain, e.g. '. - 'smithje or smithje@'.$ENV{'user.domain'}.'.)
'; + $result .='
'.'
'; $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/); $result .='
Submit a file:
Allowed filetypes: '.$uploadedfiletypes.'
'; - if ($uploadedfile) { - $result.='Currently submitted: '.$uploadedfile.''; - } else { - $result.='(Hand in a file you have prepared on your computer)'; - } - $result.='
'; + } 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 .= ''.&mt('Collaborated with [_1]',$coll).''; + } + + my $file_submission = + &Apache::inputtags::show_past_file_submission($part,$id); + if ($file_submission) { + $result .= ''.$file_submission.''; + } + + my $port_submission = + &Apache::inputtags::show_past_portfile_submission($part,$id); + if ($port_submission) { + $result .= ''.$port_submission.''; + } + + if ($result ne '') { + $result = + ''.$result. + '
'; + } } return $result; } @@ -89,98 +132,215 @@ 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}; + my $collaborators = $env{'form.HWCOL'.$part.'_'.$id}; if ($collaborators =~ /[^\s]/) { - my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"}); + 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 ( defined($ENV{'form.submitted'}) && - $ENV{'form.submitted'}='scantron' ) { - my $repetition=&Apache::response::repetition(); - $increment=$repetition; - } elsif ( defined($ENV{'form.submitted'}) ) { - my $response = $ENV{'form.HWVAL_'.$id}; - my $filename= $ENV{'form.HWFILE'.$part.'_'.$id.'.filename'}; - if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/)) { - my $award; - if ($ENV{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') { + 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'; - } else { - $award='DRAFT'; } my $uploadedflag=0; - if ($filename =~ /[^\s]/) { - my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes"); - $uploadedfiletypes=~s/[^\w\,]//g; - $uploadedfiletypes=','.$uploadedfiletypes.','; - my ($extension)=($filename=~/\.(\w+)$/); - if ($uploadedfiletypes=~/\,$extension\,/i) { - $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=$filename; - $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}= - &Apache::lonnet::userfileupload('HWFILE'.$part.'_'.$id); - $uploadedflag=1; - } else { - $award='INVALID_FILETYPE'; - } - } + &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::lonnet::whichuser(); + if ($crsid) { + my $akey=join('.',&escape($name),&escape($domain), + &escape($crsid)); + my $essayurl= + &Apache::lonnet::declutter($ENV{'REQUEST_URI'}); + my ($adom,$aname,$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); + } + } } - } + } } 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}'; - for (my $i=0;$i<$repetition;$i++) { - $result.='\item[\textbf{'.($Apache::lonxml::counter+$i). - '}.]\textit{Leave blank on scoring form}\vskip 0 mm'; - } - $result.= '\end{enumerate}'; - } + + } 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.='
  • file icon '.$file. + '
    • '."\n"; + } + if ($file_list) { + $output.= &mt('Submitted Files').''; + } + if ($answer =~ /\S/) { + $output.='

    '.&mt('Submitted text'). + '

    '.$answer.'

    '; + } + + return '
    '.$output.'
    '; +} + +sub file_submission { + my ($part,$id,$which,$award,$uploadedflag)=@_; + 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 ($files =~ /[^\s]/) { + $files =~s/,$//; + $Apache::lonhomework::results{"resource.$part.$id.$which"}=$files; + + my @submitted_files = ($files); + if ( $which eq 'portfiles' ) { + @submitted_files = split(/\s*,\s*/,$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=~/\,\s*\Q$extension\E\s*\,/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::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') { + $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}= + $files; + $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}= + &Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef, + 'essayresponse'); + } + } elsif ($which eq 'portfiles' && + $Apache::lonhomework::history{"resource.$part.$id.$which"}) { + 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 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'}); + $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 = '
    The following user'. - (scalar(@badcollaborators) > 1 ? 's are' : ' is').' invalid: '. - join(', ',@badcollaborators).'. Please correct.
    '; + my $numbad = scalar(@badcollaborators); + if ($numbad) { + $result = '
    '; + 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.'). + '
    '; } my $toomany = scalar(@collaborators) - $ncol; if ($toomany > 0) { $result .= '
    '. - 'You have too many collaborators. Please remove '.$toomany.' collaborator'. - ($toomany > 1 ? 's' :'').'.
    '; + &mt('You have too many collaborators.').' '. + &mt('Please remove [quant,_1,collaborator].',$toomany). + ''; } return $result; }