[BACK]Return to essayresponse.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / homework

Diff for /loncom/homework/essayresponse.pm between versions 1.3 and 1.91

version 1.3, 2001/06/02 03:59:59 version 1.91, 2008/11/16 02:46:25
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # essay (ungraded) style responses  # essay (ungraded) style responses
 # 4/3 Guy  #
   # $Id$
   #
   # 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/
   #
   
   =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;  package Apache::essayresponse;
 use strict;  use strict;
   use Apache::lonxml();
   use Apache::lonnet;
   use Apache::lonlocal;
   use LONCAPA qw(:DEFAULT :match);
    
   
 sub BEGIN {  BEGIN {
   &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));      &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
 }  }
   
 sub start_essayresponse {  sub start_essayresponse {
   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   my $id = &Apache::response::start_response($parstack,$safeeval);      my $result;
   return '';      my $id = &Apache::response::start_response($parstack,$safeeval);
       if ($target eq 'meta') {
    $result=&Apache::response::meta_package_write('essayresponse');
       } 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;
    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>'.
         &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');
           $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;
 }  }
   
 sub end_essayresponse {  sub end_essayresponse {
   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   if ( $target eq 'grade' ) {      my $part          = $Apache::inputtags::part;
     if ( defined $ENV{'form.submitted'}) {      my $id            = $Apache::inputtags::response[-1];
       my $id = $Apache::inputtags::response['-1'];      my $increment     = &Apache::response::repetition();
       my $response = $ENV{'form.HWVAL'.$Apache::inputtags::response['-1']};      my $result;
       if ( $response =~ /[^\s]/) {      if ( $target eq 'grade' ) {
  $Apache::lonhomework::results{"resource.$Apache::inputtags::part.$id.submission"}=$response;   my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};
  $Apache::lonhomework::results{"resource.$Apache::inputtags::part.$id.awarddetail"}="SUBMITTED";   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);
   &Apache::response::end_response;   }
   return '';   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'} || 
                              $env{'form.HWFILETOOBIG'.$part.'_'.$id};
               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;
                   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);
    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'
        && $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, "$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,$totalsize)=@_;
       my $files;
       my $jspart=$part;
       $jspart=~s/\./_/g;
       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/,$//;
           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 = 100.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);
               }
           }
    my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
           $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 ($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 ($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::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 my $entry (@collaborators) {
           my $collaborator;
    if ($entry =~ /:/) {
       $collaborator = $entry;
    } else {
       $collaborator = $entry.':'.$env{'user.domain'};
    }
           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);
               }
           }
       }
       
       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>'.
              &mt('You have too many collaborators.').' '.
                      &mt('Please remove [quant,_1,collaborator].',$toomany).
              '</td></tr></table>';
       }
       return $result;
 }  }
   
 1;  1;
Removed from v.1.3  
changed lines
  Added in v.1.91

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