# The LearningOnline Network with CAPA
# essay (ungraded) style responses
#
# $Id: essayresponse.pm,v 1.114 2011/01/29 19:41:41 raeburn Exp $
#
# 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/
#
package Apache::essayresponse;
use strict;
use Apache::lonxml();
use Apache::lonhtmlcommon;
use Apache::loncommon;
use Apache::lonnet;
use Apache::lonnavmaps;
use Apache::lonlocal;
use LONCAPA qw(:DEFAULT :match);
BEGIN {
&Apache::lonxml::register('Apache::essayresponse',('essayresponse'));
}
sub start_essayresponse {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result;
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;
my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize");
if (!defined($maxfilesize)) {
$maxfilesize = 10.0; #FIXME This should become a domain configuration
}
my $hiddendraft;
if (($Apache::lonhomework::type eq 'survey') ||
($Apache::lonhomework::type eq 'surveycred') ||
($Apache::lonhomework::type eq 'anonsurvey') ||
($Apache::lonhomework::type eq 'anonsurveycred')) {
$hiddendraft = '';
} else {
my $status_text = &mt('Submission type');
if ($Apache::lonhomework::history{"resource.$part.award"} eq 'DRAFT') {
$status_text .= ' '.&mt('(Currently -- draft)');
}
$result = &Apache::lonhtmlcommon::row_title($status_text);
my $closure;
unless ($ncol || $uploadedfiletypes) {
$closure = 1;
}
$result.=
' '.
''.
&Apache::lonhtmlcommon::row_closure($closure);
}
if ($ncol > 0) {
$result.= &Apache::lonhtmlcommon::row_title(&mt('Collaborators')).
' ';
$result .= &check_collaborators($ncol,$coll) if ($coll =~ /\w+/);
$result .= &Apache::lonhtmlcommon::row_closure();
}
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);
if ($result) {
$result =
'
'."\n";
}
if ($file_list) {
$output.= &mt('Submitted Files').'
'.$file_list.'
';
}
if ($answer =~ /\S/) {
$output.='
'.&mt('Submitted text').
'
'.$answer.'
';
}
return '
'.$output.'
';
}
sub file_submission {
my ($part,$id,$award,$uploadedflag,$totalsize,$deletions)=@_;
my $files;
my $jspart=$part;
$jspart=~s/\./_/g;
my ($symb,$crsid,$udom,$uname) = &Apache::lonnet::whichuser();
my %crsinfo = &Apache::lonnet::coursedescription($crsid);
my $cdom = $crsinfo{'domain'};
my $cnum = $crsinfo{'num'};
my (@portfiles,$uploadedurl,@submitted_portfiles,$submitted_upload,
@acceptable_portfiles,$acceptable_upload,@accepted_portfiles,
$accepted_upload,@savedportfiles,$stored_upload,@tolock,
%port_delete,$uploaded_delete);
if ($Apache::lonhomework::history{"resource.$part.$id.portfiles"} ||
$Apache::lonhomework::history{"resource.$part.$id.uploadedurl"}) {
if ($Apache::lonhomework::history{"resource.$part.$id.portfiles"}) {
@portfiles = split(/,/,$Apache::lonhomework::history{"resource.$part.$id.portfiles"});
}
$uploadedurl = $Apache::lonhomework::history{"resource.$part.$id.uploadedurl"};
if (ref($deletions) eq 'ARRAY') {
if (@{$deletions} > 0) {
foreach my $file (@{$deletions}) {
$file = &HTML::Entities::decode($file);
if (grep(/^\Q$file\E$/,@portfiles)) {
$port_delete{$file} = 1;
} elsif ($file =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/essayresponse/\Q$cdom\E/\Q$cnum\E/}) {
$uploaded_delete = $file;
} elsif ($file =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/essayresponse/[^/]+$}) {
$uploaded_delete = $file;
}
}
}
}
foreach my $current (@portfiles) {
unless ($port_delete{$current}) {
push(@savedportfiles,$current);
}
}
if ($uploaded_delete) {
if ($uploaded_delete eq $uploadedurl) {
$Apache::lonhomework::results{"resource.$part.$id.uploadedfile"} = "";
$Apache::lonhomework::results{"resource.$part.$id.uploadedurl"} = "";
} else {
undef($uploaded_delete);
}
}
}
if ($env{'form.HWPORT'.$jspart.'_'.$id} ne '') {
my $newfiles= $env{'form.HWPORT'.$jspart.'_'.$id};
$newfiles =~s/,$//;
if ($newfiles =~ /[^\s]/) {
foreach my $file (split(/\s*,\s*/,$newfiles)) {
if ($file =~ /[^\s]/) {
push(@submitted_portfiles,$file);
}
}
}
}
if ($env{'form.HWFILETOOBIG'.$part.'_'.$id} ne '') {
$$award = 'EXCESS_FILESIZE';
} elsif ($env{'form.HWFILE'.$jspart.'_'.$id.'.filename'} ne '') {
my $newfile = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'};
if ($newfile =~ /[^\s]/) {
$submitted_upload = $newfile;
}
}
if (@savedportfiles) {
foreach my $file (reverse(@savedportfiles)) {
unless(grep(/^\Q$file\E$/,@submitted_portfiles)) {
unshift(@submitted_portfiles,$file);
}
}
}
if (@submitted_portfiles || $submitted_upload) {
my $uploadedfiletypes=
&Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
if ($uploadedfiletypes ne '') {
$uploadedfiletypes=~s/[^\w\,]//g;
$uploadedfiletypes=','.$uploadedfiletypes.',';
if (@submitted_portfiles) {
foreach my $file (@submitted_portfiles) {
my ($extension)=($file=~/\.(\w+)$/);
if ($uploadedfiletypes=~/\,\s*\Q$extension\E\s*\,/i) {
push(@acceptable_portfiles,$file);
}
}
}
if ($submitted_upload) {
my ($upload_ext)=($submitted_upload=~/\.(\w+)$/);
if ($uploadedfiletypes=~/\,\s*\Q$upload_ext\E\s*\,/i) {
$acceptable_upload = $submitted_upload;
} else {
$$award='INVALID_FILETYPE';
&delete_form_items($jspart,$id);
}
}
} else {
@acceptable_portfiles = @submitted_portfiles;
$acceptable_upload = $submitted_upload;
}
}
if ((@acceptable_portfiles) || ($acceptable_upload ne '')) {
my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize");
if (!$maxfilesize) {
$maxfilesize = 10.0; #FIXME This should become a domain configuration
}
my %dirlist;
if (@acceptable_portfiles) {
foreach my $file (@acceptable_portfiles) {
my ($path,$filename) = ($file =~ m{^(.*/)([^/]+)$});
my $fullpath = '/userfiles/portfolio'.$path;
if (!exists($dirlist{$fullpath})) {
my @list = &Apache::lonnet::dirlist($fullpath,$udom,$uname,1);
$dirlist{$fullpath} = \@list;
}
if (ref($dirlist{$fullpath}) eq 'ARRAY') {
foreach my $dir_line (@{$dirlist{$fullpath}}) {
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;
}
}
}
if (ref($totalsize)) {
if ($$totalsize > $maxfilesize) {
$$award='EXCESS_FILESIZE';
&delete_form_items($jspart,$id);
} else {
push(@accepted_portfiles,$file);
}
} else {
push(@accepted_portfiles,$file);
}
}
}
if ($acceptable_upload ne '') {
if (ref($totalsize)) {
$$totalsize += $env{'form.HWFILESIZE'.$jspart.'_'.$id};
if ($$totalsize > $maxfilesize) {
$$award='EXCESS_FILESIZE';
delete($env{'form.HWFILE'.$jspart.'_'.$id});
} else {
$accepted_upload = $acceptable_upload;
}
} else {
$accepted_upload = $acceptable_upload;
}
}
}
if ($accepted_upload ne '') {
my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
my $turnindir;
my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
$turnindir = $userhash{'turnindir'};
if ($turnindir eq '') {
$turnindir = &mt('turned in');
$turnindir =~ s/\W+/_/g;
my %newhash = (
'turnindir' => $turnindir,
);
&Apache::lonnet::put('environment',\%newhash,$udom,$uname);
}
my $prefix = 'portfolio';
my $path = '/'.$turnindir.'/';
my $restitle=&Apache::lonnet::gettitle($symb);
$restitle =~ s/\W+/_/g;
if ($restitle eq '') {
$restitle = ($resurl =~ m{/[^/]+$});
if ($restitle eq '') {
$restitle = time;
}
}
my @pathitems;
my $navmap = Apache::lonnavmaps::navmap->new();
if (defined($navmap)) {
my $mapres = $navmap->getResourceByUrl($map);
if (ref($mapres)) {
my $pcslist = $mapres->map_hierarchy();
if ($pcslist ne '') {
foreach my $pc (split(/,/,$pcslist)) {
my $res = $navmap->getByMapPc($pc);
if (ref($res)) {
my $title = $res->compTitle();
$title =~ s/\W+/_/g;
if ($title ne '') {
push(@pathitems,$title);
}
}
}
}
my $maptitle = $mapres->compTitle();
$maptitle =~ s/\W+/_/g;
if ($maptitle ne '') {
push(@pathitems,$maptitle);
}
} else {
$$award = 'INTERNAL_ERROR';
}
} else {
$$award = 'INTERNAL_ERROR';
}
push(@pathitems,$restitle);
$path .= join('/',@pathitems);
my $formelement = 'HWFILE'.$jspart.'_'.$id;
my $fname = &Apache::lonnet::clean_filename($env{'form.'.$formelement.'.filename'});
my $url = '/uploaded/'.$udom.'/'.$uname.'/'.$prefix.$path.'/'.$fname;
my @stat = &Apache::lonnet::stat_file($url);
if (@stat && $stat[0] ne 'no_such_dir') {
$$award = 'FILENAME_INUSE';
} else {
my ($mode,%allfiles,%codebase);
my $result = &Apache::lonnet::userfileupload($formelement,'',
$prefix.$path,$mode,\%allfiles,\%codebase);
if ($result =~ m{^/uploaded/}) {
$stored_upload = $path.'/'.$fname;
$Apache::lonhomework::results{"resource.$part.$id.portfiles"} = $stored_upload;
push(@tolock,$stored_upload);
} else {
$$award = 'INTERNAL_ERROR';
}
}
delete($env{'form.HWFILE'.$jspart.'_'.$id});
}
if (@accepted_portfiles) {
if ($stored_upload) {
$Apache::lonhomework::results{"resource.$part.$id.portfiles"} .= ',';
}
$Apache::lonhomework::results{"resource.$part.$id.portfiles"}.=join(',',@accepted_portfiles);
push(@tolock,@accepted_portfiles);
}
if (!defined($Apache::lonhomework::results{"resource.$part.$id.portfiles"})) {
if (keys(%port_delete) > 0) {
$Apache::lonhomework::results{"resource.$part.$id.portfiles"} = "";
}
}
if (($Apache::lonhomework::history{"resource.$part.$id.portfiles"} ne
$Apache::lonhomework::results{"resource.$part.$id.portfiles"}) ||
($uploaded_delete)) {
if (ref($uploadedflag)) {
$$uploadedflag=1;
}
}
&Apache::lonnet::unmark_as_readonly($udom,$uname,[$symb,$crsid]);
&Apache::lonnet::mark_as_readonly($udom,$uname,[@tolock],[$symb,$crsid]);
&Apache::lonnet::clear_selected_files($uname);
return;
}
sub delete_form_items {
my ($jspart,$id) = @_;
delete($env{'form.HWFILE'.$jspart.'_'.$id.'.filename'});
delete($env{'form.HWFILE'.$jspart.'_'.$id.'.mimetype'});
delete($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 = '
';
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 .= '
'.
&mt('You have too many collaborators.').' '.
&mt('Please remove [quant,_1,collaborator].',$toomany).
'
';
}
return $result;
}
1;
__END__
=pod
=head1 NAME
Apache::essayresponse
=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
500 Internal Server Error
Internal Server Error
The server encountered an internal error or
misconfiguration and was unable to complete
your request.
Please contact the server administrator at
root@localhost to inform them of the time this error occurred,
and the actions you performed just before this error.
More information about this error may be available
in the server error log.