--- loncom/interface/lonpdfupload.pm 2009/04/04 21:47:41 1.3 +++ loncom/interface/lonpdfupload.pm 2012/09/14 11:24:06 1.22 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA -# Publication Handler +# PDF Form Upload Handler # -# $Id: lonpdfupload.pm,v 1.3 2009/04/04 21:47:41 bisitz Exp $ +# $Id: lonpdfupload.pm,v 1.22 2012/09/14 11:24:06 goltermann Exp $ # # Copyright Michigan State University Board of Trustees # @@ -29,50 +29,76 @@ package Apache::lonpdfupload; use lib '/home/httpd/lib/perl'; use Apache::Constants qw(:common :http); -use LONCAPA; -use LONCAPA::loncgi; -use File::Path; -use File::Basename; -use File::Copy; -use IO::File; -use Image::Magick; -use Apache::lonacc; -use Apache::lonxml; -use Apache::lonhtmlcommon(); use Apache::lonnet; +use Apache::lonhtmlcommon(); use Apache::loncommon(); +use Apache::lonnavmaps(); use Apache::lonlocal; -use Apache::lonmsg(); -use Apache::lonhomework; -use LONCAPA::Enrollment; -use LONCAPA::Configuration; +use File::MMagic; use CAM::PDF; +use LONCAPA qw(:DEFAULT :match); use strict; sub handler() { my $r = shift; - - # check user permissions - if(!&checkpermission($r)) { - # stop processing - return OK; + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + return OK if $r->header_only; + + # Needs to be in a course + if (!$env{'request.course.fn'}) { + # Not in a course + $env{'user.error.msg'}="/adm/pdfupload:bre:0:0:Cannot upload PDF forms unless in a course"; + return HTTP_NOT_ACCEPTABLE; } - $Apache::lonxml::request=$r; - $Apache::lonxml::debug=$env{'user.debug'}; - - $env{'request.uri'}=$r->uri; - $r->content_type('text/html'); - $r->send_http_header(); - $r->print(&Apache::loncommon::start_page('Upload-PDF-Form')); + # Breadcrumbs + my $brcrum = [{'href' => '/adm/pdfupload', + 'text' => 'Upload PDF Form'}]; + if ($env{'form.Uploaded'} && $env{'form.file'}) { + push(@{$brcrum},{'href' => '', + 'text' => 'PDF upload result'}); + } - #load post data into environment - &Apache::lonacc::get_posted_cgi($r); + $r->print(&Apache::loncommon::start_page('Upload PDF Form', + undef, + {'bread_crumbs' => $brcrum,}) + ); + + if ($env{'request.course.id'}) { + my $permission = $env{'course.'.$env{'request.course.id'}.'.canuse_pdfforms'}; + if ($permission eq '') { + my %domdefs = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'}); + $permission = $domdefs{'canuse_pdfforms'}; + } + unless ($permission) { + $r->print('

'. + &mt('Upload of PDF forms is not permitted for this course.'). + '

'. + &Apache::loncommon::end_page()); + return OK; + } + } else { + $r->print('

'. + &mt('Could not determine identity of this course.').' '. + &mt('You may need to [_1]re-select[_2] the course.','',''). + '

'. + &Apache::loncommon::end_page()); + return OK; + } # if a file was upload if($env{'form.Uploaded'} && $env{'form.file'}) { - $r->print(&processPDF); + my $mm = new File::MMagic; + my $mime_type = $mm->checktype_contents($env{'form.file'}); + if ($mime_type eq 'application/pdf') { + $r->print(&processPDF); + } else { + $r->print('

' + .&mt("The uploaded file does not appear to be a PDF file.") + .'

'); + } } else { # print upload form $r->print(&get_javascripts); @@ -80,57 +106,38 @@ sub handler() { } #link to course-content - $r->print("
\n \n ".&mt("Navigate Contents")."\n \n
"); + $r->print('
' + .'

'."\n" + .''."\n" + .&mt('Course Contents')."\n" + .''."\n" + .'

'."\n" + ); #&dumpenv($r); #debug -> prints the environment - $r->print(" \n\n"); + $r->print(&Apache::loncommon::end_page()); return OK; } - -sub checkpermission() { - my $r = shift; - if (! &LONCAPA::loncgi::check_cookie_and_load_env()) { - my $result = < - - - Bad Cookie - - - - Your cookie information is incorrect. - - -END -; - $r->print($result); - return 0; - } else { - return 1; - } -} - - sub get_javascripts() { - my $message = &mt('Please choose a PDF-File'); + my $message = &mt('Please choose a PDF-File.'); # simple test if the upload ends with ".pdf" # it's only for giving a message to the user my $result .= < +// END ; @@ -139,42 +146,30 @@ END sub get_uploadform() { - my $result = < -

-
- -
- - - - -
- - - - - - - - - - - -
- PDF-Formular einsenden -
- Datei auswählen - - -
- -
-
-
-
-END -; + + my %lt = &Apache::lonlocal::texthash( + 'title' => 'Upload a PDF Form with filled Form Fields', + 'chFile' => 'File', + 'submit' => 'Upload', + ); + + my $result = + '
' + .'
' + .&Apache::lonhtmlcommon::start_pick_box() + .&Apache::lonhtmlcommon::row_headline() + .'

'.$lt{'title'}.'

' + .&Apache::lonhtmlcommon::row_closure() + .&Apache::lonhtmlcommon::row_title($lt{'chFile'}) + .'' + .&Apache::lonhtmlcommon::row_closure(1) + .&Apache::lonhtmlcommon::end_pick_box() + .'

' + .'' + .'

' + .'
' + .'
'; + return $result; } @@ -187,7 +182,9 @@ sub processPDF { if (scalar @pdfdata) { &grade_pdf(@pdfdata); } else { - $result .= "

".&mt("Can't find any valid PDF-formfields")."

"; + $result .= '

' + .&mt("Can't find any valid PDF formfields.") + .'

'; } } @@ -195,60 +192,80 @@ sub get_pdf_data() { my @data = (); my $pdf = CAM::PDF->new($env{'form.file'}); - my @formFields = $pdf->getFormFieldList(); #get names of formfields - - foreach my $field (@formFields) { - my $dict = $pdf->getFormFieldDict($pdf->getFormField($field)); # get formfield dictonary + if($pdf) { + my @formFields = $pdf->getFormFieldList(); #get names of formfields - # - # this is nessesary 'cause CAM::PDF has a problem with formfieldnames which include a - # dot in fieldnames. So a fieldname like "i.am.aFormfield" will offer three fieldnames "i", "i.am" - # and "i.am.aFormfield". The fragmentary names keep no values and will be ignored. - if($dict->{'V'}) { - push(@data, $field."?". $dict->{'V'}{'value'}); #binding fieldname with value + foreach my $field (@formFields) { + my $dict = $pdf->getFormFieldDict($pdf->getFormField($field)); # get formfield dictonary + + # this is necessary because CAM::PDF has a problem with formfieldnames which include a + # dot in fieldnames. So a fieldname like "i.am.aFormfield" will offer three fieldnames + # "i", "i.am" and "i.am.aFormfield". The fragmentary names keep no values and will be ignored. + if($dict->{'V'}) { + push(@data, $field."?". $dict->{'V'}{'value'}); #binding fieldname with value + } } - } + } return @data; } sub grade_pdf { - my $result = (); my @pdfdata = @_; - - my $meta = (); - my %grades = (); - my %problems = (); - - my $debug = (); + my ($result,$meta,%grades,%problems,%foreigncourse,$debug); + my $navmap = Apache::lonnavmaps::navmap->new(); + if (!defined($navmap)) { + $result = '

'.&mt('Verification of PDF form items failed').'

'. + '
'. + &mt('Unable to retrieve information about course contents').' '. + &mt('You may need to [_1]re-select[_2] the course.','',''). + '
'; + return $result; + } + my %restitles; + foreach my $res ($navmap->retrieveResources()) { + my $symb = $res->symb; + $restitles{$symb} = $res->compTitle(); + } + $debug .= "Found: ". scalar @pdfdata." Entries \n"; - $result .= "\n"; + foreach my $entry (sort(@pdfdata)) { if ($entry =~ /^meta.*/) { $debug .= 'found: metadata -> '.$entry . "
"; my ($label, $value) = ($entry =~ /^([^?]*)\?(.*)/); my ($domain, $user) = split('&', $value); - $user =~ s/(.*)\n/$1/; #TODO find an other way - + $user =~ s/(.*)\n/$1/; #TODO is that equals to chomp? if($user ne $env{'user.name'} or $domain ne $env{'user.domain'}) { - return "
".&mt('Wrong username in PDF-File').": $user $domain -> $env{'user.domain'} $env{'user.name'}
"; + return '

' + .&mt('Wrong username ([_1]) found in PDF file. Expected username: [_2]' + ,$user.':'.$domain + ,$env{'user.domain'}.':'.$env{'user.name'}) + .'

'; } - } elsif($entry =~ /^upload.*/) { + } elsif ($entry =~ /^upload.*/) { $debug .= 'found: a problem -> '.$entry; my ($label, $value) = ($entry =~ /^([^?]*)\?(.*)/); my ($symb, $part, $type, $HWVAL) = split('&', $label); - my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb); + my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb); + if ($map =~ m{^uploaded/($match_domain)/($match_courseid)/default(_?\d*)\.(page|sequence)}) { + my $mapcid = $1.'_'.$2; + if ($mapcid ne $env{'request.course.id'}) { + push(@{$foreigncourse{$mapcid}},$symb); + } + } + next unless (exists($restitles{$symb})); $value =~ s/(.*)\n/$1/; - #fehlerhafte Radiobuttons rausfiltern (Bug in CABAReT Stage) - if($type eq 'radiobuttonresponse' && $value eq 'Off' ) { + #filter incorrect radiobuttons (Bug in CABAReT Stage) + if ($type eq 'radiobuttonresponse' && $value eq 'Off' ) { next; } my $submit = $part; $submit =~ s/part_(.*)/submit_$1/; - if($problems{$symb.$part}) { + if ($problems{$symb.$part}) { $problems{$symb.$part}{$HWVAL} = $value; } else { $problems{$symb.$part} = { 'resource' => $resource, @@ -262,44 +279,117 @@ sub grade_pdf { next; } } - $result .= $debug; + #$result .= $debug; - foreach my $key (sort (keys %problems)) { - my %problem = %{$problems{$key}}; - my ($problemname, $grade) = &grade_problem(%problem); - $result .= ""; + $result .= '

'.&mt('Result of PDF Form upload').'

'; + if (keys(%problems) > 0) { + $result .= &Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .'' + .'' + .&Apache::loncommon::start_data_table_header_row() + .&Apache::loncommon::end_data_table_header_row(); + + foreach my $key (sort(keys(%problems))) { + my %problem = %{$problems{$key}}; + my ($problemname, $grade) = &grade_problem(%problem); + + $result .= &Apache::loncommon::start_data_table_row(); + $result .= ''; + $result .= &Apache::loncommon::end_data_table_row(); + } + $result .= &Apache::loncommon::end_data_table(); + } else { + $result .= '

'. + &mt('As no gradable form items were found, no submissions have been recorded.'). + '

'; + } + if (keys(%foreigncourse)) { + my ($numother,$othercrsmsg); + foreach my $cid (sort(keys(%foreigncourse))) { + my %coursehash = &Apache::lonnet::coursedescription($cid, + {'one_time' => 1}); + if (ref($foreigncourse{$cid}) eq 'ARRAY') { + if ($numother) { + $othercrsmsg .= '
  • '; + } + $othercrsmsg .= ''.$coursehash{'description'}.'
      '."\n"; + foreach my $symb (@{$foreigncourse{$cid}}) { + my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb); + $othercrsmsg .= '
    • '.$resource.'
      • '; + } + $othercrsmsg .= '
    '; + $numother ++; + } + } + if ($numother) { + $result .= '
    '; + if ($numother > 1) { + $result .= &mt('Your uploaded PDF form contained the following resource(s) from [_1] different courses:',''.$numother.'')."\n".'
    • '. + $othercrsmsg.'
    '; + } else { + $result .= &mt('Your uploaded PDF form contained the following resource(s) from a different course:').' '.$othercrsmsg. + &mt('Did you download the PDF form from another course and upload it to the wrong course?'); + } + $result .= '
    '; + } } - $result .= "\n
    • $problemname$grade
    '.&mt('Problem Name').''.&mt('Grading').''). + '">'.$problemname.'
    "; - return $result; + return $result; } sub grade_problem { my %problem = @_; + my ($title, $part) = (); - my ($content) = &Apache::loncommon::ssi_with_retries('/res/'. - $problem{'resource'}, 5, %problem); - - $content =~ s/.*class="LC_current_location".*>(.*)<\/td>.*/$1/g; - $content = $1; + &Apache::loncommon::ssi_with_retries('/res/'.$problem{'resource'}, 5, %problem); - my $part = $problem{submitted}; + $title = &Apache::lonnet::gettitle($problem{'symb'}); + $part = $problem{submitted}; $part =~ s/part_(.*)/$1/; - $content .= " - Part $part"; + unless($part eq '0') { + #add information about part number + $title .= " - Part $part"; + } my %problemhash = &Apache::lonnet::restore($problem{'symb'}); my $grade = $problemhash{"resource.$part.award"}; - return ($content, $grade); + return ($title, $grade); +} + +sub parse_grade_answer { + my ($shortcut) = @_; + my %answerhash = ('EXACT_ANS' => &mt('You are correct.'), + 'APPROX_ANS' => &mt('You are correct.'), + 'INCORRECT' => &mt('You are incorrect'), + 'DRAFT' => &mt('Copy saved but not submitted.'), + ); + + foreach my $key (keys %answerhash) { + if($shortcut eq $key) { + return $answerhash{$shortcut}; + } + } + return &mt('See course contents for further information.'); + } + sub dumpenv { my $r = shift;