File:  [LON-CAPA] / loncom / interface / lonpdfupload.pm
Revision 1.12: download - view: text, annotated - select for diffs
Mon May 25 12:54:18 2009 UTC (15 years, 1 month ago) by bisitz
Branches: MAIN
CVS tags: HEAD
- Corrected handler info text
- First check for valid user, then start data_table
- Optimized wrong-username-message:
    - Standard error style
    - Standard format username:domain
    - Optimized &mt usage

    1: # The LearningOnline Network with CAPA
    2: # PDF Form Upload Handler
    3: #
    4: # $Id: lonpdfupload.pm,v 1.12 2009/05/25 12:54:18 bisitz 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: package Apache::lonpdfupload;
   29: 
   30: use lib '/home/httpd/lib/perl';
   31: use Apache::Constants qw(:common :http);
   32: use LONCAPA;
   33: use LONCAPA::loncgi;
   34: use File::Path;
   35: use File::Basename;
   36: use File::Copy;
   37: use IO::File;
   38: use Image::Magick;
   39: use Apache::lonacc;
   40: use Apache::lonxml;
   41: use Apache::lonhtmlcommon();
   42: use Apache::lonnet;
   43: use Apache::loncommon();
   44: use Apache::lonlocal;
   45: use Apache::lonmsg();
   46: use Apache::lonhomework;
   47: use LONCAPA::Enrollment;
   48: use LONCAPA::Configuration;
   49: use CAM::PDF;
   50: 
   51: use strict;
   52: 
   53: sub handler() {
   54:     my $r = shift;
   55: 
   56:     # check user permissions 
   57:     if(!&checkpermission($r)) {
   58:         # stop processing 
   59:         return OK;
   60:     }
   61: 
   62:     $Apache::lonxml::request=$r;
   63:     $Apache::lonxml::debug=$env{'user.debug'};
   64: 
   65:     $env{'request.uri'}=$r->uri;
   66:     $r->content_type('text/html');
   67:     $r->send_http_header();
   68:     $r->print(&Apache::loncommon::start_page('Upload PDF Form'));
   69: 
   70:     #load post data into environment
   71:     &Apache::lonacc::get_posted_cgi($r);
   72: 
   73:     # if a file was upload
   74:     if($env{'form.Uploaded'} && $env{'form.file'}) {
   75:         $r->print(&processPDF);
   76:     } else { 
   77:         # print upload form
   78:         $r->print(&get_javascripts);
   79:         $r->print(&get_uploadform);
   80:     }
   81: 
   82:     #link to course-content
   83:     $r->print('<hr />'
   84:              .'<p>'."\n"
   85:              .'<a href="/adm/navmaps">'."\n"
   86:              .&mt("Navigate Contents")."\n"
   87:              .'</a>'."\n"
   88:              .'</p>'."\n"
   89:     );
   90: 
   91:     #&dumpenv($r); #debug -> prints the environment
   92:     $r->print(&Apache::loncommon::end_page());
   93:     return OK;
   94: }
   95: 
   96: 
   97: sub checkpermission() {
   98:     my $r = shift;
   99:     if (! &LONCAPA::loncgi::check_cookie_and_load_env()) {
  100:         my $result  = <<END
  101: Content-type: text/html
  102: 
  103: <html>
  104:   <head>
  105:     <title>
  106:       Bad Cookie
  107:     </title>
  108:   </head>
  109:   <body>
  110:     Your cookie information is incorrect.
  111:   </body>
  112: </html>
  113: END
  114: ;
  115:         $r->print($result);
  116:         return 0;
  117:     } else {
  118:         return 1;
  119:     }
  120: }
  121: 
  122: 
  123: sub get_javascripts() {
  124:     
  125:     my $message = &mt('Please choose a PDF-File.');
  126: 
  127:     # simple test if the upload ends with ".pdf"
  128:     # it's only for giving a message to the user
  129:     my $result .= <<END
  130:   <script type="text/javascript">
  131:     function checkFilename(form) {
  132:         var fileExt = form.file.value;
  133:         fileExt = fileExt.match(/[.]pdf\$/g);
  134:         if(fileExt) {
  135:             return true;
  136:         }
  137:         alert("$message");
  138:         return false;
  139:     }
  140:   </script>
  141: END
  142: ;
  143:     return $result; 
  144: }
  145: 
  146: 
  147: sub get_uploadform() {
  148:     
  149:     my %lt = &Apache::lonlocal::texthash(
  150:                  'title'  => 'Upload a PDF Form with filled Form Fields', 
  151:                  'chFile' => 'File',
  152:                  'submit' => 'Upload',
  153:              );
  154: 
  155:     my $result = 
  156:         '<br />'
  157:        .'<form method="post" enctype="multipart/form-data" onsubmit="return checkFilename(this);">'
  158:        .'<input type="hidden" name="type" value="upload" />'
  159:        .&Apache::lonhtmlcommon::start_pick_box()
  160:        .&Apache::lonhtmlcommon::row_headline()
  161:        .'<h2>'.$lt{'title'}.'</h2>'
  162:        .&Apache::lonhtmlcommon::row_closure()
  163:        .&Apache::lonhtmlcommon::row_title($lt{'chFile'})
  164:        .'<input type="file" name="file" id="filename" />'
  165:        .&Apache::lonhtmlcommon::row_closure(1)
  166:        .&Apache::lonhtmlcommon::end_pick_box()
  167:        .'<input type="submit" name="Uploaded" value="'.$lt{'submit'}.'" />'
  168:        .'</form>'
  169:        .'<br />';
  170: 
  171:   return $result;
  172: }
  173: 
  174: sub processPDF {
  175:     my $result = ();  # message for Browser
  176:     my @pdfdata = (); # answers from PDF-Forms
  177:     
  178:     @pdfdata = &get_pdf_data(); # get answers from PDF-Form
  179:     
  180:     if (scalar @pdfdata) {    
  181:         &grade_pdf(@pdfdata);
  182:     } else {
  183:         $result .= '<p class="LC_error">'
  184:                   .&mt("Can't find any valid PDF formfields.")
  185:                   .'</p>';
  186:     }
  187: }
  188: 
  189: sub get_pdf_data() {
  190:     my @data = ();
  191:     my $pdf = CAM::PDF->new($env{'form.file'});
  192: 
  193:     my @formFields = $pdf->getFormFieldList(); #get names of formfields
  194:     
  195:     foreach my $field (@formFields) {
  196: 	my $dict = $pdf->getFormFieldDict($pdf->getFormField($field)); # get formfield dictonary
  197: 
  198:         #
  199:         # this is nessesary 'cause CAM::PDF has a problem with formfieldnames which include a
  200:         # dot in fieldnames. So a fieldname like "i.am.aFormfield" will offer three fieldnames "i", "i.am" 
  201:         # and "i.am.aFormfield". The fragmentary names keep no values and will be ignored.
  202:         if($dict->{'V'}) {
  203:             push(@data, $field."?". $dict->{'V'}{'value'}); #binding fieldname with value
  204:         }
  205:     } 
  206:     return @data;
  207: }
  208: 
  209: sub grade_pdf {
  210:     my $result = ();
  211:     my @pdfdata = @_;
  212:    
  213:     my $meta = ();
  214:     my %grades = ();
  215:     my %problems = ();
  216:         
  217:     my $debug = ();
  218: 
  219:     $debug  .= "Found: ". scalar @pdfdata." Entries \n";
  220: 
  221:     foreach my $entry (sort(@pdfdata)) {
  222:         if ($entry =~ /^meta.*/) {
  223:             $debug .= 'found: metadata -> '.$entry . "<br />";
  224:             my ($label, $value) = ($entry =~ /^([^?]*)\?(.*)/);
  225:             my ($domain, $user) = split('&', $value);
  226:             $user =~ s/(.*)\n/$1/; #TODO is that equals to chomp?
  227:             
  228:             if($user ne $env{'user.name'} or  $domain ne $env{'user.domain'}) {
  229:                 return '<p class="LC_error">'
  230:                       .&mt('Wrong username ([_1]) found in PDF file. Expected username: [_2]'
  231:                           ,$user.':'.$domain
  232:                           ,$env{'user.domain'}.':'.$env{'user.name'})
  233:                       .'</p>';
  234:             }
  235: 
  236:         } elsif($entry =~ /^upload.*/)  {
  237:             $debug .= 'found: a problem -> '.$entry;
  238:             my ($label, $value) = ($entry =~ /^([^?]*)\?(.*)/);
  239:             my ($symb, $part, $type, $HWVAL) = split('&', $label);
  240:             my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);  
  241:             $value =~ s/(.*)\n/$1/; 
  242: 
  243:             #filter incorrect radiobuttons (Bug in CABAReT Stage)
  244:             if($type eq 'radiobuttonresponse' && $value eq 'Off' ) {
  245:                 next;
  246:             }
  247:  
  248:             my $submit = $part;
  249:             $submit =~ s/part_(.*)/submit_$1/;
  250:             if($problems{$symb.$part}) {
  251:                  $problems{$symb.$part}{$HWVAL} = $value;
  252:             } else {
  253:                  $problems{$symb.$part} =  { 'resource' => $resource,
  254:                                         'symb' => $symb,
  255:                                         'submitted' => $part,
  256:                                         $submit => 'Answer',
  257:                                         $HWVAL => $value};
  258:             }
  259:         } else {
  260:             $debug .= 'found: -> '.$entry;
  261:             next;
  262:         }
  263:     }
  264:     #$result .= $debug;
  265: 
  266:     $result .= '<h2>'.&mt('Results of PDF Form problems').'</h2>';
  267:     $result .= &Apache::loncommon::start_data_table()
  268:               .&Apache::loncommon::start_data_table_header_row()
  269:               .'<th>'.&mt('Problem Name').'</th>'
  270:               .'<th>'.&mt('Grading').'</th>'
  271:               .&Apache::loncommon::start_data_table_header_row()
  272:               .&Apache::loncommon::end_data_table_header_row();
  273: 
  274:     foreach my $key (sort (keys %problems)) {
  275:         my %problem = %{$problems{$key}};
  276:         my ($problemname, $grade) = &grade_problem(%problem);
  277: 
  278:         $result .= &Apache::loncommon::start_data_table_row();
  279:         $result .= "<td>$problemname</td><td class='";
  280:         if($grade eq "EXACT_ANS" || $grade eq "APPROX_ANS") {
  281:             $result .= "LC_answer_correct";
  282:         } else { 
  283:             $result .= "LC_answer_charged_try";
  284:         }
  285:         $grade = &parse_grade_answer($grade);
  286:         $result .= "'>$grade</span></td>";
  287:         $result .= &Apache::loncommon::end_data_table_row();
  288:     }
  289:     $result .= &Apache::loncommon::end_data_table();
  290: 
  291: 
  292:     return $result;        
  293: }
  294: 
  295: sub grade_problem {
  296:     my %problem = @_;
  297:     my ($title, $part) = ();
  298: 
  299:     &Apache::loncommon::ssi_with_retries('/res/'.$problem{'resource'}, 5, %problem);
  300: 
  301:     $title = &Apache::lonnet::gettitle($problem{'symb'});    
  302:     $part = $problem{submitted};
  303:     $part =~ s/part_(.*)/$1/;
  304:     unless($part eq '0') {
  305:         #add information about part number
  306:         $title .= " - Part $part";
  307:     }
  308:  
  309:     my %problemhash = &Apache::lonnet::restore($problem{'symb'});
  310:     my $grade = $problemhash{"resource.$part.award"};
  311: 
  312:     return ($title, $grade);    
  313: }
  314: 
  315: sub parse_grade_answer {
  316:     my ($shortcut) = @_;
  317:      my %answerhash = ('EXACT_ANS' => &mt('You are correct.'),
  318:                        'APPROX_ANS' => &mt('You are correct.'),
  319:                        'INCORRECT' => &mt('You are incorrect'),
  320:      );
  321: 
  322:     foreach my $key (keys %answerhash) {
  323:         if($shortcut eq $key) {
  324:             return $answerhash{$shortcut};
  325:         }  
  326:     }
  327:     return &mt('See course contents for further information.');
  328: 
  329: }
  330: 
  331: 
  332: sub dumpenv  {
  333:     my $r = shift;
  334: 
  335:     $r->print ("<br />-------------------<br />");
  336:     foreach my $key (sort (keys %env)) {
  337:         $r->print ("<br />$key -> $env{$key}");
  338:     }
  339:     $r->print ("<br />-------------------<br />");
  340:     $r->print ("<br />-------------------<br />");
  341:     foreach my $key (sort (keys %ENV)) {
  342:         $r->print ("<br />$key -> $ENV{$key}");
  343:     }
  344:     $r->print ("<br />-------------------<br />");
  345:     
  346: }	
  347: 
  348: 1;
  349: __END__
  350: 

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