Annotation of loncom/homework/essayresponse.pm, revision 1.98
1.1 albertel 1: # The LearningOnline Network with CAPA
2: # essay (ungraded) style responses
1.5 albertel 3: #
1.98 ! raeburn 4: # $Id: essayresponse.pm,v 1.97 2009/01/01 16:45:32 raeburn Exp $
1.5 albertel 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: #
1.33 albertel 28:
1.1 albertel 29: package Apache::essayresponse;
30: use strict;
1.33 albertel 31: use Apache::lonxml();
1.62 albertel 32: use Apache::lonnet;
1.33 albertel 33: use Apache::lonlocal;
1.88 raeburn 34: use LONCAPA qw(:DEFAULT :match);
1.72 www 35:
1.1 albertel 36:
1.6 harris41 37: BEGIN {
1.10 ng 38: &Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
1.1 albertel 39: }
40:
41: sub start_essayresponse {
1.10 ng 42: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
43: my $result;
1.14 albertel 44: my $id = &Apache::response::start_response($parstack,$safeeval);
45: if ($target eq 'meta') {
46: $result=&Apache::response::meta_package_write('essayresponse');
1.69 albertel 47: } elsif ($target eq 'web' &&
48: $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
1.10 ng 49: my $part= $Apache::inputtags::part;
50: my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
1.34 albertel 51: my $coll= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.17 www 52: my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
1.21 www 53: $uploadedfiletypes=~s/[^\w\,]//g;
1.93 raeburn 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: }
1.75 albertel 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:
1.10 ng 75: if ($ncol > 0) {
1.64 matthew 76: $result .='<tr><td>'.'<label>'.
1.88 raeburn 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 />';
1.10 ng 84: $result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
1.13 ng 85: $result .='</td></tr>';
1.10 ng 86: }
1.93 raeburn 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);
1.22 www 95: $result.='</table>';
1.74 albertel 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: }
1.10 ng 122: }
123: return $result;
1.1 albertel 124: }
125:
126: sub end_essayresponse {
1.10 ng 127: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.13 ng 128: my $part = $Apache::inputtags::part;
1.14 albertel 129: my $id = $Apache::inputtags::response[-1];
1.70 albertel 130: my $increment = &Apache::response::repetition();
1.15 albertel 131: my $result;
1.10 ng 132: if ( $target eq 'grade' ) {
1.62 albertel 133: my $collaborators = $env{'form.HWCOL'.$part.'_'.$id};
1.14 albertel 134: if ($collaborators =~ /[^\s]/) {
1.34 albertel 135: my $previous_list= &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
1.14 albertel 136: $Apache::lonhomework::results{"resource.$part.$id.collaborators"}=$collaborators
137: if ($collaborators ne $previous_list);
138: }
1.58 albertel 139: if ( &Apache::response::submitted('scantron') ) {
1.31 albertel 140: $increment=&Apache::response::scored_response($part,$id);
1.58 albertel 141: } elsif ( &Apache::response::submitted() ) {
1.62 albertel 142: my $response = $env{'form.HWVAL_'.$id};
1.91 raeburn 143: my $filename = $env{'form.HWFILE'.$part.'_'.$id.'.filename'} ||
144: $env{'form.HWFILETOOBIG'.$part.'_'.$id};
1.62 albertel 145: my $portfiles = $env{'form.HWPORT'.$part.'_'.$id};
1.42 banghart 146: if (( $response =~ /[^\s]/) || ($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/)) {
1.61 albertel 147: my $award='DRAFT';
1.62 albertel 148: if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
1.14 albertel 149: $award='SUBMITTED';
150: }
1.22 www 151: my $uploadedflag=0;
1.91 raeburn 152: my $totalsize=0;
153: &file_submission($part,$id,'filename',\$award,\$uploadedflag,\$totalsize);
154: &file_submission($part,$id,'portfiles',\$award,\$uploadedflag,\$totalsize);
1.10 ng 155: $Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
1.14 albertel 156: $Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
1.10 ng 157: my %previous=&Apache::response::check_for_previous($response,$part,$id);
1.22 www 158: unless ($uploadedflag) { &Apache::response::handle_previous(\%previous,$award); }
1.32 www 159: #
160: # Store with resource author for similarity testing
161: #
162: if ($award eq 'SUBMITTED') {
163: my ($symb,$crsid,$domain,$name)=
1.77 albertel 164: &Apache::lonnet::whichuser();
1.32 www 165: if ($crsid) {
1.83 albertel 166: my $akey=join('.',&escape($name),&escape($domain),
167: &escape($crsid));
1.32 www 168: my $essayurl=
169: &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
170: my ($adom,$aname,$apath)=
1.80 albertel 171: ($essayurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\/(.*)$/);
1.72 www 172: $apath=&escape($apath);
1.32 www 173: $apath=~s/\W/\_/gs;
174: &Apache::lonnet::put('nohist_essay_'.$apath,
175: { $akey => $response },$adom,$aname);
176: }
1.42 banghart 177: }
1.10 ng 178: }
1.42 banghart 179: }
1.15 albertel 180: } elsif ($target eq 'edit') {
181: $result.=&Apache::edit::end_table();
1.71 albertel 182:
183: } elsif ($target eq 'tex'
184: && $Apache::lonhomework::type eq 'exam') {
185: $result .= &Apache::inputtags::exam_score_line($target);
186:
1.70 albertel 187: } elsif ($target eq 'answer') {
1.78 albertel 188: $result.=&Apache::response::answer_header($$tagstack[-1]);
1.81 foxr 189: my $answer = &mt('Essay will be hand graded.');
1.78 albertel 190: $result.=&Apache::response::answer_part($$tagstack[-1],$answer,
191: {'no_verbatim' => 1});
192: $result.=&Apache::response::answer_footer($$tagstack[-1]);
1.10 ng 193: }
1.82 albertel 194: if ($target eq 'web') {
195: &Apache::response::setup_prior_tries_hash(\&format_prior_response,
196: ['portfiles',
197: 'uploadedurl']);
198: }
1.71 albertel 199:
1.27 albertel 200: if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
201: $target eq 'tex' || $target eq 'analyze') {
1.86 foxr 202: &Apache::lonxml::increment_counter($increment, "$part.$id");
1.85 foxr 203:
204: if ($target eq 'analyze') {
1.87 raeburn 205: $Apache::lonhomework::analyze{"$part.$id.type"} = 'essayresponse';
1.96 raeburn 206: push (@{ $Apache::lonhomework::analyze{"parts"} },"$part.$id");
1.85 foxr 207: &Apache::lonhomework::set_bubble_lines();
208: }
1.27 albertel 209: }
1.10 ng 210: &Apache::response::end_response;
1.42 banghart 211:
1.15 albertel 212: return $result;
1.10 ng 213: }
214:
1.82 albertel 215: sub format_prior_response {
216: my ($mode,$answer,$other_data) = @_;
217: my $output;
218:
219: my (undef,undef,$udom,$uname) = &Apache::lonnet::whichuser();
220: my $port_url = '/uploaded/'.$udom.'/'.$uname.'/portfolio/';
221:
222: my $file_list;
223:
224: foreach my $file (split(/\s*,\s*/,
225: $other_data->[0].','.$other_data->[1])) {
226: next if ($file!~/\S/);
227: if ($file !~ m{^/uploaded/}) { $file=$port_url.$file; }
228: $file=~s|/+|/|g;
229: &Apache::lonnet::allowuploaded('/adm/essayresponse',$file);
230: $file_list.='<li><span class="LC_nobreak"><a href="'.$file.'?rawmode=1" target="lonGRDs"><img src="'.
231: &Apache::loncommon::icon($file).'" alt="file icon" border="0" /> '.$file.
232: '</a></span></li>'."\n";
233: }
234: if ($file_list) {
235: $output.= &mt('Submitted Files').'<ul>'.$file_list.'</ul>';
236: }
237: if ($answer =~ /\S/) {
238: $output.='<p>'.&mt('Submitted text').
239: '<blockquote>'.$answer.'</blockquote></p>';
240: }
241:
242: return '<div class="LC_prior_essay">'.$output.'</div>';
243: }
244:
1.61 albertel 245: sub file_submission {
1.91 raeburn 246: my ($part,$id,$which,$award,$uploadedflag,$totalsize)=@_;
1.61 albertel 247: my $files;
1.67 albertel 248: my $jspart=$part;
249: $jspart=~s/\./_/g;
1.91 raeburn 250: if ($which eq 'portfiles') {
251: $files= $env{'form.HWPORT'.$jspart.'_'.$id};
252: } elsif ($which eq 'filename') {
253: if ($env{'form.HWFILETOOBIG'.$jspart.'_'.$id} ne '') {
254: $$award = 'EXCESS_FILESIZE';
255: return;
256: } else {
257: $files = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
258: }
1.61 albertel 259: }
260: if ($files =~ /[^\s]/) {
261: $files =~s/,$//;
1.91 raeburn 262: my (@submitted_files,@acceptable_files,@accepted_files);
263: if ($which eq 'portfiles') {
264: @submitted_files = split(/\s*,\s*/,$files);
265: } else {
266: @submitted_files = ($files);
267: }
268: my $uploadedfiletypes=
269: &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
270: if ($uploadedfiletypes) {
271: $uploadedfiletypes=~s/[^\w\,]//g;
272: $uploadedfiletypes=','.$uploadedfiletypes.',';
273: foreach my $file (@submitted_files) {
274: my ($extension)=($file=~/\.(\w+)$/);
275: if ($uploadedfiletypes=~/\,\s*\Q$extension\E\s*\,/i) {
276: push(@acceptable_files,$file);
277: } else {
278: $$award='INVALID_FILETYPE';
279: if ($which eq 'filename') {
280: &delete_form_items($jspart,$id);
281: }
282: }
283: }
284: }
285: my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize");
286: if (!$maxfilesize) {
1.93 raeburn 287: $maxfilesize = 10.0; #FIXME This should become a domain configuration
1.91 raeburn 288: }
289: my %dirlist;
290: foreach my $file (@acceptable_files) {
291: if ($which eq 'filename') {
292: if (ref($totalsize)) {
293: $$totalsize += $env{'form.HWFILESIZE'.$jspart.'_'.$id};
294: }
295: } else {
296: my ($symb,$crsid,$udom,$uname) = &Apache::lonnet::whichuser();
1.97 raeburn 297: my ($path,$filename) = ($file =~ m{^(.*/)([^/]+)$});
1.91 raeburn 298: my $fullpath = '/userfiles/portfolio'.$path;
299: if (!exists($dirlist{$fullpath})) {
300: my @list = &Apache::lonnet::dirlist($fullpath,$udom,$uname,1);
1.97 raeburn 301: $dirlist{$fullpath} = \@list;
302: }
303: if (ref($dirlist{$fullpath}) eq 'ARRAY') {
304: foreach my $dir_line (@{$dirlist{$fullpath}}) {
1.91 raeburn 305: my ($fname,$dom,undef,$testdir,undef,undef,undef,undef,
306: $size,undef,$mtime,undef,undef,undef,$obs,undef) =
307: split(/\&/,$dir_line,16);
308: if ($filename eq $fname) {
309: my $mbsize = $size/(1024.0*1024.0);
310: if (ref($totalsize)) {
311: $$totalsize += $mbsize;
312: }
313: last;
314: }
315: }
316: }
317: }
318: if (ref($totalsize)) {
319: if ($$totalsize > $maxfilesize) {
320: $$award='EXCESS_FILESIZE';
321: if ($which eq 'filename') {
322: &delete_form_items($jspart,$id);
323: }
1.97 raeburn 324: last;
1.94 raeburn 325: } else {
326: push(@accepted_files,$file);
1.91 raeburn 327: }
328: } else {
329: push(@accepted_files,$file);
330: }
331: }
332: $Apache::lonhomework::results{"resource.$part.$id.$which"}=join(',',@accepted_files);
333: if (($$award eq 'INVALID_FILETYPE') || ($award eq 'EXCESS_FILESIZE')) {
334: return;
335: }
336: if (ref($uploadedflag)) {
1.61 albertel 337: $$uploadedflag=1;
338: }
1.95 raeburn 339: my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
1.91 raeburn 340: if ($which eq 'portfiles') {
1.66 albertel 341: &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
342: &Apache::lonnet::mark_as_readonly($domain,$name,\@submitted_files,[$symb,$crsid]);
1.61 albertel 343: &Apache::lonnet::clear_selected_files($name);
344: }
1.91 raeburn 345: if ($which eq 'filename') {
1.61 albertel 346: $Apache::lonhomework::results{"resource.$part.$id.uploadedfile"}=
347: $files;
1.95 raeburn 348: my $cleanpart = $part;
349: $cleanpart =~ s/\W/_/g;
350: my $cleanid = $id;
351: $cleanid =~ s/\W/_/g;
352: my ($map,$resid,$res)=&Apache::lonnet::decode_symb($symb);
353: my $container;
354: if ($map =~ /^uploaded/) {
355: (my $prefix,$container) = ($map =~ m{^uploaded/[^/]+/[^/]+/(default|supplemental)_?([^.]*)\.(?:sequence|page)$});
356: if (length($container) > 10) {
357: $container = substr($container,-10,10);
358: }
359: if ($container ne '') {
360: $container = $prefix.'_'.$container;
361: } else {
362: $container = $prefix;
363: }
364: } else {
365: ($container) = ($map =~ m{(.+)\.(?:sequence|page)$});
366: $container =~ s/\W/_/g;
367: if (length($container) > 255) {
368: $container = substr($container,0,254);
369: }
370: }
371: my $subdir = 'essayresponse';
372: my %crsdesc = &Apache::lonnet::coursedescription($crsid);
373: foreach my $item ($crsdesc{'domain'},$crsdesc{'num'},$container,$resid,$cleanpart,$cleanid) {
374: if ($item ne '') {
375: $subdir .= '/'.$item;
376: }
377: }
1.61 albertel 378: $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"}=
1.67 albertel 379: &Apache::lonnet::userfileupload('HWFILE'.$jspart.'_'.$id,undef,
1.95 raeburn 380: $subdir);
1.98 ! raeburn 381: delete($env{'form.HWFILE'.$jspart.'_'.$id});
1.61 albertel 382: }
383: } elsif ($which eq 'portfiles' &&
384: $Apache::lonhomework::history{"resource.$part.$id.$which"}) {
1.77 albertel 385: my ($symb,$crsid,$domain,$name)=&Apache::lonnet::whichuser();
1.66 albertel 386: &Apache::lonnet::unmark_as_readonly($domain,$name,[$symb,$crsid]);
1.61 albertel 387: $Apache::lonhomework::results{"resource.$part.$id.$which"}="";
388: }
389: }
390:
1.91 raeburn 391: sub delete_form_items {
392: my ($jspart,$id) = @_;
1.98 ! raeburn 393: delete($env{'form.HWFILE'.$jspart.'_'.$id.'.filename'});
! 394: delete($env{'form.HWFILE'.$jspart.'_'.$id.'.mimetype'});
! 395: delete($env{'form.HWFILE'.$jspart.'_'.$id});
1.91 raeburn 396: }
397:
398:
1.10 ng 399: sub check_collaborators {
1.11 ng 400: my ($ncol,$coll) = @_;
1.10 ng 401: my %classlist=&Apache::lonnet::dump('classlist',
1.62 albertel 402: $env{'course.'.$env{'request.course.id'}.'.domain'},
403: $env{'course.'.$env{'request.course.id'}.'.num'});
1.10 ng 404: my (@badcollaborators,$result);
1.88 raeburn 405:
406: my (@collaborators) = split(/,?\s+/,$coll);
407: foreach my $entry (@collaborators) {
408: my $collaborator;
409: if ($entry =~ /:/) {
410: $collaborator = $entry;
1.10 ng 411: } else {
1.88 raeburn 412: $collaborator = $entry.':'.$env{'user.domain'};
1.10 ng 413: }
1.88 raeburn 414: if ($collaborator !~ /^$match_username:$match_domain$/) {
415: if (!grep(/^\Q$entry\E$/,@badcollaborators)) {
416: push(@badcollaborators,$entry);
417: }
418: } elsif (!grep(/^\Q$collaborator\E$/i,keys(%classlist))) {
419: if (!grep(/^\Q$entry\E$/,@badcollaborators)) {
420: push(@badcollaborators,$entry);
421: }
422: }
1.10 ng 423: }
424:
1.88 raeburn 425: my $numbad = scalar(@badcollaborators);
426: if ($numbad) {
427: $result = '<table border="0"><tr bgcolor="#ffbbbb"><td>';
428: if ($numbad == 1) {
429: $result .= &mt('The following user is invalid:');
430: } else {
431: $result .= &mt('The following [_1] users are invalid:',$numbad);
432: }
433: $result .= ' '.join(', ',@badcollaborators).'. '.&mt('Please correct.').
434: '</td></tr></table>';
1.10 ng 435: }
436: my $toomany = scalar(@collaborators) - $ncol;
437: if ($toomany > 0) {
438: $result .= '<table border="0"><tr bgcolor="#ffbbbb"><td>'.
1.88 raeburn 439: &mt('You have too many collaborators.').' '.
440: &mt('Please remove [quant,_1,collaborator].',$toomany).
441: '</td></tr></table>';
1.10 ng 442: }
443: return $result;
1.1 albertel 444: }
1.2 albertel 445:
446: 1;
447: __END__
1.92 jms 448:
449:
450: =pod
451:
452: =head1 NAME
453:
454: Apache::easyresponse
455:
456: =head1 SYNOPSIS
457:
458: Handler to evaluate essay (ungraded) style responses.
459:
460: This is part of the LearningOnline Network with CAPA project
461: described at http://www.lon-capa.org.
462:
463: =head1 SUBROUTINES
464:
465: =over
466:
467: =item start_essayresponse()
468:
469: =item end_essayresponse()
470:
471: =item format_prior_response()
472:
473: =item file_submission()
474:
475: =item delete_form_items()
476:
477: =item check_collaborators()
478:
479: =back
480:
1.93 raeburn 481: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to essayresponse.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / homework