loncom/homework/essayresponse.pm - view

File: [LON-CAPA] / loncom / homework / essayresponse.pm
Revision 1.93: download - view: text, annotated - select for diffs
Tue Dec 9 00:23:22 2008 UTC (15 years, 4 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- Bug 5839 (Ability to disable About-Me page and Portfolio)
  - set $which arg in &inputtags::file_selector() to "uploadonly" if Portfolio unavailable
    for student.
- Bug 5719 (Size limits for File Upload in Essayresponse)
  - send $maxfilesize as additional arg to &inputtags::file_selector()

1: # The LearningOnline Network with CAPA 2: # essay (ungraded) style responses 3: # 4: # $Id: essayresponse.pm,v 1.93 2008/12/09 00:23:22 raeburn Exp $ 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: # 28: 29: package Apache::essayresponse; 30: use strict; 31: use Apache::lonxml(); 32: use Apache::lonnet; 33: use Apache::lonlocal; 34: use LONCAPA qw(:DEFAULT :match); 35: 36: 37: BEGIN { 38: &Apache::lonxml::register('Apache::essayresponse',('essayresponse')); 39: } 40: 41: sub start_essayresponse { 42: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; 43: my $result; 44: my $id = &Apache::response::start_response($parstack,$safeeval); 45: if ($target eq 'meta') { 46: $result=&Apache::response::meta_package_write('essayresponse'); 47: } elsif ($target eq 'web' && 48: $Apache::inputtags::status[-1] eq 'CAN_ANSWER') { 49: my $part= $Apache::inputtags::part; 50: my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators"); 51: my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"'); 52: my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes"); 53: $uploadedfiletypes=~s/[^\w\,]//g; 54: my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize"); 55: if (!defined($maxfilesize)) { 56: $maxfilesize = 10.0; #FIXME This should become a domain configuration 57: } 58: if ( $Apache::lonhomework::type eq 'survey' ) { 59: $result.= '<input type="hidden" name="HWDRAFT'.$part.'_'.$id.'" value="yes" /> '; 60: } 61: $result.='<br /><table border="1">'; 62: if ( $Apache::lonhomework::type ne 'survey' ) { 63: $result.= '<tr><td>'. 64: '<label>'. 65: '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="yes" checked="checked" /> '. 66: &mt('Submit entries below as answer to receive credit'). 67: '</label> <br />'. 68: '<label>'. 69: '<input type="radio" name="HWDRAFT'.$part.'_'.$id.'" value="no" /> '. 70: &mt('Save entries below as a draft answer (not submitting them for credit yet)'). 71: '</label>'. 72: '</td></tr>'; 73: } 74: 75: if ($ncol > 0) { 76: $result .='<tr><td>'.'<label>'. 77: &mt('Collaborators:').' <input type="text" size="70" max="80" name="HWCOL'. 78: $part.'_'.$id.'" value="'.$coll.'" /><br />'. 79: &mt('(Enter a maximum of [quant,_1,collaborator] using username or username:domain, e.g. smithje or smithje:[_2].)',$ncol,$env{'user.domain'}); 80: if ($ncol > 1) { 81: $result .= '<br />'.&mt('If entering more than one, use spaces to separate the collaborators.'); 82: } 83: $result .= '</label><br />'; 84: $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/); 85: $result .='</td></tr>'; 86: } 87: my $filesfrom = 'both'; 88: my $stuname = &Apache::lonnet::EXT('user.name'); 89: my $studom = &Apache::lonnet::EXT('user.domain'); 90: if (!&Apache::lonnet::usertools_access($stuname,$studom,'portfolio')) { 91: $filesfrom = 'uploadonly'; 92: } 93: $result.=&Apache::inputtags::file_selector($part,$id,$uploadedfiletypes, 94: $filesfrom,undef,$maxfilesize); 95: $result.='</table>'; 96: } elsif ($target eq 'web' && 97: $Apache::inputtags::status[-1] ne 'CAN_ANSWER') { 98: my $part= $Apache::inputtags::part; 99: my @msgs; 100: if ($Apache::lonhomework::history{"resource.$part.$id.collaborators"} =~ /\S/) { 101: my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"'); 102: $result .= '<td>'.&mt('Collaborated with [_1]',$coll).'</td>'; 103: } 104: 105: my $file_submission = 106: &Apache::inputtags::show_past_file_submission($part,$id); 107: if ($file_submission) { 108: $result .= '<td>'.$file_submission.'</td>'; 109: } 110: 111: my $port_submission = 112: &Apache::inputtags::show_past_portfile_submission($part,$id); 113: if ($port_submission) { 114: $result .= '<td>'.$port_submission.'</td>'; 115: } 116: 117: if ($result ne '') { 118: $result = 119: '<table class="LC_pastsubmission"><tr>'.$result. 120: '</tr></table>'; 121: } 122: } 123: return $result; 124: } 125: 126: sub end_essayresponse { 127: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; 128: my $part = $Apache::inputtags::part; 129: my $id = $Apache::inputtags::response[-1]; 130: my $increment = &Apache::response::repetition(); 131: my $result; 132: if ( $target eq 'grade' ) { 133: my $collaborators = $env{'form.HWCOL'.$part.'_'.$id}; 134: if ($collaborators =~ /[^\s]/) { 135: my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"'); 136: $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators 137: if ($collaborators ne $previous_list); 138: } 139: if ( &Apache::response::submitted('scantron') ) { 140: $increment=&Apache::response::scored_response($part,$id); 141: } elsif ( &Apache::response::submitted() ) { 142: my $response = $env{'form.HWVAL_'.$id}; 143: my $filename = $env{'form.HWFILE'.$part.'_'.$id.'.filename'} || 144: $env{'form.HWFILETOOBIG'.$part.'_'.$id}; 145: my $portfiles = $env{'form.HWPORT'.$part.'_'.$id}; 146: if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) { 147: my $award='DRAFT'; 148: if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') { 149: $award='SUBMITTED'; 150: } 151: my $uploadedflag=0; 152: my $totalsize=0; 153: &file_submission($part,$id,'filename',\$award,\$uploadedflag,\$totalsize); 154: &file_submission($part,$id,'portfiles',\$award,\$uploadedflag,\$totalsize); 155: $Apache::lonhomework::results{"resource.$part.$id.submission"}=$response; 156: $Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award; 157: my %previous=&Apache::response::check_for_previous($response,$part,$id); 158: unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); } 159: # 160: # Store with resource author for similarity testing 161: # 162: if ($award eq 'SUBMITTED') { 163: my ($symb,$crsid,$domain,$name)= 164: &Apache::lonnet::whichuser(); 165: if ($crsid) { 166: my $akey=join('.',&escape($name),&escape($domain), 167: &escape($crsid)); 168: my $essayurl= 169: &Apache::lonnet::declutter($ENV{'REQUEST_URI'}); 170: my ($adom,$aname,$apath)= 171: ($essayurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\/(.*)$/); 172: $apath=&escape($apath); 173: $apath=~s/\W/\_/gs; 174: &Apache::lonnet::put('nohist_essay_'.$apath, 175: { $akey => $response },$adom,$aname); 176: } 177: } 178: } 179: } 180: } elsif ($target eq 'edit') { 181: $result.=&Apache::edit::end_table(); 182: 183: } elsif ($target eq 'tex' 184: && $Apache::lonhomework::type eq 'exam') { 185: $result .= &Apache::inputtags::exam_score_line($target); 186: 187: } elsif ($target eq 'answer') { 188: $result.=&Apache::response::answer_header($$tagstack[-1]); 189: my $answer = &mt('Essay will be hand graded.'); 190: $result.=&Apache::response::answer_part($$tagstack[-1],$answer, 191: {'no_verbatim' => 1}); 192: $result.=&Apache::response::answer_footer($$tagstack[-1]); 193: } 194: if ($target eq 'web') { 195: &Apache::response::setup_prior_tries_hash(\&format_prior_response, 196: ['portfiles', 197: 'uploadedurl']); 198: } 199: 200: if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || 201: $target eq 'tex' || $target eq 'analyze') { 202: &Apache::lonxml::increment_counter($increment, "$part.$id"); 203: 204: if ($target eq 'analyze') { 205: $Apache::lonhomework::analyze{"$part.$id.type"} = 'essayresponse'; 206: &Apache::lonhomework::set_bubble_lines(); 207: } 208: } 209: &Apache::response::end_response; 210: 211: return $result; 212: } 213: 214: sub format_prior_response { 215: my ($mode,$answer,$other_data) = @_; 216: my $output; 217: 218: my (undef,undef,$udom,$uname) = &Apache::lonnet::whichuser(); 219: my $port_url = '/uploaded/'.$udom.'/'.$uname.'/portfolio/'; 220: 221: my $file_list; 222: 223: foreach my $file (split(/\s*,\s*/, 224: $other_data->[0].','.$other_data->[1])) { 225: next if ($file!~/\S/); 226: if ($file !~ m{^/uploaded/}) { $file=$port_url.$file; } 227: $file=~s|/+|/|g; 228: &Apache::lonnet::allowuploaded('/adm/essayresponse',$file); 229: $file_list.='<li><span class="LC_nobreak"><a href="'.$file.'?rawmode=1" target="lonGRDs"><img src="'. 230: &Apache::loncommon::icon($file).'" alt="file icon" border="0" /> '.$file. 231: '</a></span></li>'."\n"; 232: } 233: if ($file_list) { 234: $output.= &mt('Submitted Files').'<ul>'.$file_list.'</ul>'; 235: } 236: if ($answer =~ /\S/) { 237: $output.='<p>'.&mt('Submitted text'). 238: '<blockquote>'.$answer.'</blockquote></p>'; 239: } 240: 241: return '<div class="LC_prior_essay">'.$output.'</div>'; 242: } 243: 244: sub file_submission { 245: my ($part,$id,$which,$award,$uploadedflag,$totalsize)=@_; 246: my $files; 247: my $jspart=$part; 248: $jspart=~s/\./_/g; 249: if ($which eq 'portfiles') { 250: $files= $env{'form.HWPORT'.$jspart.'_'.$id}; 251: } elsif ($which eq 'filename') { 252: if ($env{'form.HWFILETOOBIG'.$jspart.'_'.$id} ne '') { 253: $$award = 'EXCESS_FILESIZE'; 254: return; 255: } else { 256: $files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'}; 257: } 258: } 259: if ($files =~ /[^\s]/) { 260: $files =~s/,$//; 261: my (@submitted_files,@acceptable_files,@accepted_files); 262: if ($which eq 'portfiles') { 263: @submitted_files = split(/\s*,\s*/,$files); 264: } else { 265: @submitted_files = ($files); 266: } 267: my $uploadedfiletypes= 268: &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes"); 269: if ($uploadedfiletypes) { 270: $uploadedfiletypes=~s/[^\w\,]//g; 271: $uploadedfiletypes=','.$uploadedfiletypes.','; 272: foreach my $file (@submitted_files) { 273: my ($extension)=($file=~/\.(\w+)$/); 274: if ($uploadedfiletypes=~/\,\s*\Q$extension\E\s*\,/i) { 275: push(@acceptable_files,$file); 276: } else { 277: $$award='INVALID_FILETYPE'; 278: if ($which eq 'filename') { 279: &delete_form_items($jspart,$id); 280: } 281: } 282: } 283: } 284: my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize"); 285: if (!$maxfilesize) { 286: $maxfilesize = 10.0; #FIXME This should become a domain configuration 287: } 288: my %dirlist; 289: foreach my $file (@acceptable_files) { 290: if ($which eq 'filename') { 291: if (ref($totalsize)) { 292: $$totalsize += $env{'form.HWFILESIZE'.$jspart.'_'.$id}; 293: } 294: } else { 295: my ($symb,$crsid,$udom,$uname) = &Apache::lonnet::whichuser(); 296: my ($path,$filename) = ($file =~ m{^(.+)/([^/]+)$}); 297: my $fullpath = '/userfiles/portfolio'.$path; 298: if (!exists($dirlist{$fullpath})) { 299: my @list = &Apache::lonnet::dirlist($fullpath,$udom,$uname,1); 300: foreach my $dir_line (@list) { 301: my ($fname,$dom,undef,$testdir,undef,undef,undef,undef, 302: $size,undef,$mtime,undef,undef,undef,$obs,undef) = 303: split(/\&/,$dir_line,16); 304: if ($filename eq $fname) { 305: my $mbsize = $size/(1024.0*1024.0); 306: if (ref($totalsize)) { 307: $$totalsize += $mbsize; 308: } 309: last; 310: } 311: } 312: $dirlist{$fullpath} = \@list; 313: } 314: } 315: if (ref($totalsize)) { 316: if ($$totalsize > $maxfilesize) { 317: $$award='EXCESS_FILESIZE'; 318: if ($which eq 'filename') { 319: &delete_form_items($jspart,$id); 320: } 321: } 322: } else { 323: push(@accepted_files,$file); 324: } 325: } 326: my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes"); 327: $Apache::lonhomework::results{"resource.$part.$id.$which"}=join(',',@accepted_files); 328: if (($$award eq 'INVALID_FILETYPE') || ($award eq 'EXCESS_FILESIZE')) { 329: return; 330: } 331: if (ref($uploadedflag)) { 332: $$uploadedflag=1; 333: } 334: if ($which eq 'portfiles') { 335: my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser(); 336: &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]); 337: &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,[$symb,$crsid]); 338: &Apache::lonnet::clear_selected_files($name); 339: } 340: if ($which eq 'filename') { 341: $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}= 342: $files; 343: $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}= 344: &Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef, 345: 'essayresponse'); 346: &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id}); 347: } 348: } elsif ($which eq 'portfiles' && 349: $Apache::lonhomework::history{"resource.$part.$id.$which"}) { 350: my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser(); 351: &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]); 352: $Apache::lonhomework::results{"resource.$part.$id.$which"}=""; 353: } 354: } 355: 356: sub delete_form_items { 357: my ($jspart,$id) = @_; 358: &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id.'.filename'}); 359: &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id.'.mimetype'}); 360: &Apache::lonnet::delenv($env{'form.HWFILE'.$jspart.'_'.$id}); 361: } 362: 363: 364: sub check_collaborators { 365: my ($ncol,$coll) = @_; 366: my %classlist=&Apache::lonnet::dump('classlist', 367: $env{'course.'.$env{'request.course.id'}.'.domain'}, 368: $env{'course.'.$env{'request.course.id'}.'.num'}); 369: my (@badcollaborators,$result); 370: 371: my (@collaborators) = split(/,?\s+/,$coll); 372: foreach my $entry (@collaborators) { 373: my $collaborator; 374: if ($entry =~ /:/) { 375: $collaborator = $entry; 376: } else { 377: $collaborator = $entry.':'.$env{'user.domain'}; 378: } 379: if ($collaborator !~ /^$match_username:$match_domain$/) { 380: if (!grep(/^\Q$entry\E$/,@badcollaborators)) { 381: push(@badcollaborators,$entry); 382: } 383: } elsif (!grep(/^\Q$collaborator\E$/i,keys(%classlist))) { 384: if (!grep(/^\Q$entry\E$/,@badcollaborators)) { 385: push(@badcollaborators,$entry); 386: } 387: } 388: } 389: 390: my $numbad = scalar(@badcollaborators); 391: if ($numbad) { 392: $result = '<table border="0"><tr bgcolor="#ffbbbb"><td>'; 393: if ($numbad == 1) { 394: $result .= &mt('The following user is invalid:'); 395: } else { 396: $result .= &mt('The following [_1] users are invalid:',$numbad); 397: } 398: $result .= ' '.join(', ',@badcollaborators).'. '.&mt('Please correct.'). 399: '</td></tr></table>'; 400: } 401: my $toomany = scalar(@collaborators) - $ncol; 402: if ($toomany > 0) { 403: $result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'. 404: &mt('You have too many collaborators.').' '. 405: &mt('Please remove [quant,_1,collaborator].',$toomany). 406: '</td></tr></table>'; 407: } 408: return $result; 409: } 410: 411: 1; 412: __END__ 413: 414: 415: =pod 416: 417: =head1 NAME 418: 419: Apache::easyresponse 420: 421: =head1 SYNOPSIS 422: 423: Handler to evaluate essay (ungraded) style responses. 424: 425: This is part of the LearningOnline Network with CAPA project 426: described at http://www.lon-capa.org. 427: 428: =head1 SUBROUTINES 429: 430: =over 431: 432: =item start_essayresponse() 433: 434: =item end_essayresponse() 435: 436: =item format_prior_response() 437: 438: =item file_submission() 439: 440: =item delete_form_items() 441: 442: =item check_collaborators() 443: 444: =back 445: 446: =cut