Annotation of loncom/interface/printout.pl, revision 1.142

1.1       sakharuk    1: #!/usr/bin/perl
1.37      albertel    2: # CGI-script to run LaTeX, dvips, ps2ps, ps2pdf etc.
                      3: #
1.142   ! bisitz      4: # $Id: printout.pl,v 1.141 2009/04/17 10:02:49 foxr Exp $
1.37      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: #
                     28: 
1.39      sakharuk   29: use lib '/home/httpd/lib/perl';
1.76      albertel   30: use LONCAPA::loncgi;
1.38      sakharuk   31: use File::Path;
1.88      foxr       32: use File::Basename;
1.111     foxr       33: use File::Copy;
1.6       sakharuk   34: use IO::File;
1.7       sakharuk   35: use Image::Magick;
1.97      albertel   36: use Apache::lonhtmlcommon();
1.80      albertel   37: use Apache::lonnet;
1.97      albertel   38: use Apache::loncommon();
1.51      albertel   39: use Apache::lonlocal;
1.97      albertel   40: use Apache::lonmsg();
1.77      foxr       41: use LONCAPA::Enrollment;
1.123     albertel   42: use LONCAPA::Configuration;
1.47      sakharuk   43: 
1.59      albertel   44: use strict;
1.77      foxr       45: 
1.132     www        46: my $busy_wait_timeout = 30; 
1.81      foxr       47: 
1.141     foxr       48: 
                     49: my $debugging = 0;
                     50: 
1.135     foxr       51: sub debug {
1.141     foxr       52:     if ($debugging) {
                     53: 	my ($text) = @_;
                     54: 	print "$text <br />\n";
                     55:     }
1.135     foxr       56: }
                     57: 
1.77      foxr       58: #   Determine if a user is operating as a student for this course/domain.
                     59: #Parameters:
1.92      albertel   60: #    none
1.77      foxr       61: #Implicit:
                     62: #    $env{request.role} contains the role under which this user operated this
                     63: #                       this request.
                     64: sub is_student {
1.92      albertel   65:     return ($env{'request.role'}=~/^st\./);
1.77      foxr       66: }
                     67: 
                     68: #
                     69: #   Debugging:  Dump the environment for debugging.
                     70: #
                     71: sub dumpenv  {
1.84      albertel   72:     print "<br />-------------------<br />";
1.77      foxr       73:     foreach my $key (sort (keys %env)) {
1.84      albertel   74: 	print "<br />$key -> $env{$key}";
1.77      foxr       75:     }
1.84      albertel   76:     print "<br />-------------------<br />";
1.77      foxr       77: }
                     78: 
                     79: #
                     80: #   This sub sends a message to the appropriate person if there was an error
                     81: #   rendering the latex  At present, there's only one case to consider:
                     82: #   a student printing inside a course results in messages to the course coordinator.
                     83: #Parmaeters:
                     84: #    identifier -  The unique identifier of this cgi request.
1.81      foxr       85: #    badresource-  Filepath to most likely failing 
1.77      foxr       86: #    logfile    -  The contents of the log file (included in the message).
                     87: #    texfile    -  reference to an array containing the LaTeX input file
                     88: #                  (included in the message).
                     89: #Implicit inputs:
                     90: #   From the environment:
                     91: #       cgi.$identifier.user     - User doing the printing.
                     92: #       cgi.$identifier.domain   - Domain the user is logged in on with printing.
                     93: #       cgi.$identifier.courseid - Id of the course (if this is a course).
                     94: #       cgi.$identifier.coursedom- Domain in which course was constituted.
                     95: #       cgi.$identifier.resources - List of resource URL's for which the print
                     96: #                                  was attempted.
                     97: # 
                     98: sub send_error_mail {
1.81      foxr       99:     my ($identifier, $badresource, $logfile, $texfile) = @_;
1.77      foxr      100:     my $user     = $env{"cgi.$identifier.user"};
                    101:     my $domain   = $env{"cgi.$identifier.domain"};
                    102:     my $courseid = $env{"cgi.$identifier.courseid"};
                    103:     my $coursedom= $env{"cgi.$identifier.coursedom"};
                    104:     my $resources= $env{"cgi.$identifier.resources"};
                    105: 
1.81      foxr      106:     #  resource file->URL
                    107:     #
                    108:     my $badurl = &Apache::lonnet::declutter($badresource);
                    109: 
                    110:     # &dumpenv();
1.77      foxr      111: 
                    112: 
                    113: 
                    114:     #  Only continue if there is a user, domain, courseid, course domain
                    115:     #  and resources:
                    116: 
                    117:     if(defined($user)       && defined($domain) && defined($courseid) &&
                    118:        defined($coursedom)  && defined($resources) ){
                    119: 	   
                    120: 	#  Only mail if the conditions are ripe for it:
                    121: 	#  The user is a student in the course:
                    122: 	#
                    123: 	
1.92      albertel  124: 	if (&is_student()) {
1.77      foxr      125: 	    # build the subject and message body:
1.141     foxr      126: 	    &debug("sending message to course coordinators.");
1.81      foxr      127: 
                    128: 	    # Todo: Convert badurl into a url from file path:
                    129: 
                    130: 	    my $subject  = "Error [$badurl] Print failed for $user".'@'.$domain;
1.77      foxr      131: 	    my $message .= "Print failed to render LaTeX for $user".'@'."$domain\n";
                    132: 	    $message    .= "  User was attempting to print: \n";
1.91      albertel  133: 	    foreach my $resource (split(/:/,$resources)) {
                    134: 		$message    .= "       $resource\n";
                    135: 	    }
1.77      foxr      136: 	    $message    .= "--------------------LaTeX logfile:------------ \n";
                    137: 	    $message    .= $logfile;
                    138: 	    $message    .= "-----------------LaTeX source file: ------------\n";
                    139: 	    
                    140: 	    foreach my $line (@$texfile) {
                    141: 		$message .= "$line\n";
                    142: 	    }
1.122     albertel  143: 	    my (undef, %receivers) = &Apache::lonmsg::decide_receiver(undef, 0,
                    144: 								      1,1,1);
1.141     foxr      145: 	    &debug("sending...section:  $env{'request.course.sec'}");
1.81      foxr      146: 	    foreach my $dest (keys %receivers) {
1.141     foxr      147: 		&debug("dest is $dest");
1.77      foxr      148: 		my @destinfo = split(/:/,$dest);
                    149: 		my $user = $destinfo[0];
                    150: 		my $dom  = $destinfo[1];
                    151: 
                    152: 		&Apache::lonmsg::user_normal_msg($user, $dom,
                    153: 						 $subject, $message);
                    154: 		
                    155: 		# No point in looking at the return status as there's no good
                    156: 		# error action I can think of right now (log maybe?).
                    157: 	    }
                    158: 	}
                    159:     }
                    160: }
                    161: 
1.49      albertel  162: $|=1;
1.39      sakharuk  163: if (! &LONCAPA::loncgi::check_cookie_and_load_env()) {
                    164:     print <<END;
                    165: Content-type: text/html
                    166: 
                    167: <html>
                    168: <head><title>Bad Cookie</title></head>
                    169: <body>
1.40      sakharuk  170: Your cookie information is incorrect.
1.39      sakharuk  171: </body>
                    172: </html>
                    173: END
                    174:     return;
                    175: }
1.123     albertel  176: 
                    177: my %perlvar=%{&LONCAPA::Configuration::read_conf('loncapa.conf')};
1.133     foxr      178: &Apache::lonlocal::get_language_handle();
                    179: &Apache::loncommon::content_type(undef,'text/html');
1.128     albertel  180: $env{'request.noversionuri'} = '/cgi-bin/printout.pl';
1.133     foxr      181: print(&Apache::loncommon::start_page('Creating PDF'));
                    182: 
                    183: my $identifier = $ENV{'QUERY_STRING'};
                    184: my $texfile = $env{'cgi.'.$identifier.'.file'};
                    185: my $laystyle = $env{'cgi.'.$identifier.'.layout'};
                    186: my $numberofcolumns = $env{'cgi.'.$identifier.'.numcol'};
                    187: my $paper = $env{'cgi.'.$identifier.'.paper'};
                    188: my $selectionmade = $env{'cgi.'.$identifier.'.selection'};
                    189: my $tableofcontents = $env{'cgi.'.$identifier.'.tableofcontents'};
                    190: my $tableofindex = $env{'cgi.'.$identifier.'.tableofindex'};
                    191: my $advanced_role = $env{'cgi.'.$identifier.'.role'};
                    192: my $number_of_files = $env{'cgi.'.$identifier.'.numberoffiles'}+1;
                    193: my $student_names = $env{'cgi.'.$identifier.'.studentnames'};
                    194: my $backref = &Apache::lonnet::unescape($env{'cgi.'.$identifier.'.backref'});
                    195: 
                    196: 
                    197: my @names_pack=();
                    198: if ($student_names=~/_END_/) {  
                    199:     @names_pack=split(/_ENDPERSON_/,$student_names);
                    200: }
                    201: if ($backref) {
                    202:     print('<p>'.&mt("[_1]Return[_2] to editing resource.",
                    203: 		    "<a href=\"$backref\"><b>","</b></a>").'</p>');
                    204: }
                    205: my $figfile = $texfile;
                    206: $figfile =~ s/^(.*_printout)_\d+_\d+_\d+\.tex/$1\.dat/;
                    207: my $duefile = $texfile;
                    208: $duefile =~ s/^(.*_printout)_\d+_\d+_\d+\.tex/$1\.due/;
                    209: 
                    210: 
                    211: #-------------------------------------------------------------------------------------
                    212: #
                    213: #   Each print may have associated with it a file that contains a set of figures
                    214: #   that need to be converted to .eps from whatever form they were in when included
                    215: #   in the resource.  The name of the figure file is in $figfile.  If it exists,
                    216: #   it contains the names of the files that need to be converted, one per line.
                    217: #
                    218: 
1.141     foxr      219: &debug("Figure file is $figfile");
                    220: 
1.133     foxr      221: if (-e $figfile) {
1.141     foxr      222:     &debug( "Figure file exists");
                    223:     &debug("$figfile exists");
1.133     foxr      224:     my %done_conversion;
                    225:     my $temporary_file=IO::File->new($figfile) || die "Couldn't open fig file $figfile for reading: $!\n";
                    226:     my @content_of_file = <$temporary_file>;
                    227:     close $temporary_file;  
                    228:     my $noteps;
                    229:     my %prog_state;
                    230:     if ($advanced_role) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Converting Images to EPS','Picture Conversion Status',$#content_of_file,'inline','80');  }
                    231:     print('<br />');
                    232:     foreach my $not_eps (@content_of_file) {
                    233: 	chomp($not_eps);
1.141     foxr      234: 	&debug( "Being asked to convert $not_eps");
1.133     foxr      235: 	if ($not_eps ne '') {
                    236: 	    $not_eps=~s|\/\.\/|\/|g;
                    237: 	    if (!$done_conversion{$not_eps}) { #  Only convert multiple includes once.
                    238: 		&convert_figure($not_eps);
                    239: 		$done_conversion{$not_eps} = 1;
                    240: 	    }
                    241: 	}
                    242:     }
                    243:     if ($advanced_role) { 
                    244: 	&Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); 
                    245:     }
                    246:     unlink($figfile);
                    247: }
                    248: #     End of figure conversion section:
                    249: #
                    250: #--------------------------------------------------------------------------------------------
1.135     foxr      251: #
                    252: #  Figure out which Tex files we need to process.  If this is a large class e.g.
                    253: #  the instructor may have asked that the printout be by section, one section per file
                    254: #  in that case, the output tex fiels will be the base filename with 3 digit serial numbers
                    255: #  just prior to the .tex file type.
                    256: #  By the time this loop exits, @texfile is an array of the files to process.
                    257: #
1.133     foxr      258: 
1.135     foxr      259: my @texfile=($texfile);
                    260: if ($number_of_files>1) {
                    261:     @texfile=();
                    262:     for (my $i=1;$i<=$number_of_files;$i++) {
                    263: 	my $new_texfile=$texfile;
                    264: 	$new_texfile=~s/\.tex//;
                    265: 	$new_texfile = sprintf("%s_%03d.tex", $new_texfile,$i);
                    266: 	push @texfile,$new_texfile;
                    267:     } 
                    268: }
1.39      sakharuk  269: 
1.135     foxr      270: #--------------------------------------------------------------------------------------------
1.43      sakharuk  271: 
1.135     foxr      272: my $ind=-1;
1.98      albertel  273: 
1.49      albertel  274: my %prog_state;
1.135     foxr      275: if ($advanced_role) { 
1.136     bisitz    276:     %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Print Status',&mt('Class Print Status'),$number_of_files,'inline','80'); 
1.135     foxr      277: }
1.61      albertel  278: print "<br />";
1.135     foxr      279: my $num_files = @texfile;	# How does this differ from $number_of_files , can that be 0?
                    280: 
                    281: 
                    282: 
                    283: 
1.43      sakharuk  284: foreach $texfile (@texfile) {
1.49      albertel  285:   my $status_statement='';
                    286:   my $link_text='download PDF';
                    287:   $ind++;
1.135     foxr      288: 
                    289:   #---------------------------------------------------------------------------------------
                    290:   #  This chunk of code 
                    291:   #  determines the status message for the printout, and the download link text.
                    292:   #  If the print is for one or more students, both will contain the range of students
                    293:   #  covered by this file.
                    294:   #  
                    295: 
1.49      albertel  296:   my @stud_info=split(/_END_/,$names_pack[$ind]);
1.135     foxr      297:   my @tempo_array=split(/:/,$stud_info[0]);       # username:domain:section:full name:...
1.49      albertel  298:   my $name;
1.88      foxr      299:   my $name_range='';
1.135     foxr      300: 
                    301:   # $name       -> Either user's full name or username@domain
                    302:   # $name_range -> Either user's last name or usrname.
                    303: 
1.49      albertel  304:   if ($tempo_array[3]) {
                    305:       $name=$tempo_array[3];
1.89      foxr      306:       ($name_range) = split(/,/,$name, 2);
1.49      albertel  307:   } else {
                    308:       $name=$tempo_array[0].'@'.$tempo_array[1];
1.88      foxr      309:       $name_range = $tempo_array[0];
                    310:   }
1.135     foxr      311: 
                    312:   # If there truly is a name add it to the status text so we know which
                    313:   # user is getting printed.
                    314:   #
                    315: 
1.88      foxr      316:   if (($name ne "") && ($name ne '@') ) { # Could be printing codes...
                    317:       $link_text='<b>'.$name.'</b>';
                    318:       $status_statement.=$name;
1.49      albertel  319:   }
1.135     foxr      320: 
                    321:   # Group of students being printed...
                    322:   # $name_range -> first student's name - last student's name
                    323:   #
                    324: 
1.49      albertel  325:   if ($#stud_info>0) {
                    326:       @tempo_array=split(/:/,$stud_info[-1]);
1.48      albertel  327:       if ($tempo_array[3]) {
                    328: 	  $name=$tempo_array[3];
1.89      foxr      329: 	  my ($lastname) = split(/,/, $name,2);
                    330: 	  $name_range .= "-".$lastname;
1.48      albertel  331:       } else {
                    332: 	  $name=$tempo_array[0].'@'.$tempo_array[1];
1.88      foxr      333: 	  $name_range .= '-'.$tempo_array[0];
                    334:       }
                    335:       if (($name ne "") && ($name ne '@')) {
                    336: 	  $link_text.=' - <b>'.$name.'</b>';
                    337: 	  $status_statement.=' -  '.$name;
                    338:   
1.48      albertel  339:       }
1.88      foxr      340:   }
1.135     foxr      341: 
                    342:   # $name_range is the range of names in this file.
                    343:   # $name is the first of the names in this file.
                    344:   #
                    345:   #-----------------------------------------------------------------------
                    346: 
                    347:   #  If the number of files is > 1, but we don't have multiple
                    348:   #  student names, we must be printing an exam from codes.
                    349:   #  The download link becomes the filename (basename.tex
                    350:   #  The status info has the basename appended to it.
                    351:   #
                    352:   if(($num_files > 1) && ($link_text eq 'download PDF')) {
1.88      foxr      353:       $link_text = '<b>'.basename($texfile,'.tex').'.pdf</b>';
                    354:       $status_statement .= basename($texfile);
                    355:   }
1.135     foxr      356: 
                    357: 
                    358:   #------------------------------------------------------------------------
                    359: 
1.88      foxr      360:   $name_range =~ s/'//g;	# O'Neil -> ONeil e.g.
1.135     foxr      361: 
                    362: 
1.88      foxr      363:   print "<br/>";
1.135     foxr      364:   if ($advanced_role) { 
                    365:       &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,'Creating PDF for '.$status_statement); 
                    366:   }
                    367: 
                    368:   if (-e $texfile) {		# Ensure the tex file exists:
                    369: 
                    370:       #---------------------------------------------------------------------
                    371:       #
                    372:       #  Put username ranges into the original tex
                    373:       #  Tex filename from which they'll propagate into the other filenames as well.
                    374:       #
                    375: 
1.88      foxr      376:       if (($name_range ne '') && ($num_files > 1)) {
                    377: 	  my $newtexfile = $texfile;
                    378: 	  $newtexfile    =~ s/\.tex/$name_range\.tex/;
                    379: 	  rename($texfile, $newtexfile);
                    380: 	  $texfile       = $newtexfile;
                    381:       }
1.135     foxr      382: 
                    383:       #---------------------------------------------------------------------
                    384: 
1.29      sakharuk  385:       $texfile =~ m/^(.*)\/([^\/]+)$/; 
                    386:       my $name_file = $2;
                    387:       my $path_file = $1.'/';
                    388:       chdir $path_file;
1.132     www       389:       my $dvi_file= $name_file; $dvi_file =~ s/\.tex$/\.dvi/;
1.135     foxr      390:       &make_dvi_file($name_file,
                    391: 		     $dvi_file,
                    392: 		     $tableofcontents,
                    393: 		     $tableofindex,
                    394: 		     $status_statement,
                    395: 		     \%prog_state,
                    396: 		     $busy_wait_timeout);
1.90      foxr      397: 
                    398: 
1.135     foxr      399:       #Do we have a latex error in the log file?
1.35      sakharuk  400: 
1.105     foxr      401: 
1.135     foxr      402:       my $logfilename = $texfile; $logfilename =~ s/\.tex$/\.log/;
1.115     foxr      403: 
1.63      sakharuk  404: 
1.135     foxr      405:       if (&analyze_logfile($logfilename, $texfile, $advanced_role)) {
                    406: 	  
1.119     foxr      407: 
1.29      sakharuk  408: 	  #LaTeX successfully parsed tex file 
                    409: 	  $name_file =~ s/\.tex/\.dvi/;
                    410: 	  my $new_name_file = $name_file;
                    411: 	  $new_name_file =~ s/\.dvi/\.ps/;
1.67      sakharuk  412: 	  my $papera=$paper;
1.62      sakharuk  413: 	  if ($papera eq 'letter') {$papera='';}
                    414: 	  if ($papera ne '') {$papera='-t'.$papera;}
1.139     foxr      415: 	  my $extra_ps_header = $perlvar{'lonLib'} .'/includepsheader.ps';
                    416: 	  my $comma = "dvips $papera -h $extra_ps_header -Ppdf -G0 -o  $new_name_file";
1.59      albertel  417: 	  &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
                    418: 			     "for $status_statement now Converting to PS",
                    419: 			     \%prog_state,$new_name_file);
1.115     foxr      420: 	  #
                    421: 	  #  One last little hinky kinky thing.
                    422: 	  #  It's just possible that some fonts could not be maded
                    423: 	  #  at the resolution of the pdf print driver.
                    424: 	  #  In that case a file called missfont.log will have been
                    425: 	  #  created that will contain the commands that were attempted
                    426: 	  # to create the missing fonts.  If we basically
                    427: 	  # take all the 8000 strings in that file, and
                    428: 	  # replace them with 600 (the ljfour resolution)
                    429: 	  # run the commands in that file and redvips,
                    430: 	  # we'll be able to print the missing glyphs at 600dpi.
                    431: 	  #
                    432: 	  # Supposedly it is possible to tune TeX/Metafont to do this
                    433: 	  # right but I failed to get that to work when following the
                    434: 	  # docs at the tug site, hence this rather kludgey fix.
                    435: 	  #
1.135     foxr      436: 
1.115     foxr      437: 	  my $print_directory = dirname($name_file);
                    438: 	  my $missfonts_file  = $print_directory."/missfont.log";
1.116     albertel  439: 	  #print("<br /> Missing fonts file is: $missfonts_file");
1.115     foxr      440: 	  if (-e $missfonts_file) {
1.116     albertel  441: 	      #print("<br />Missing fonts file exists\n");
1.124     albertel  442: 	      &create_missing_fonts($missfonts_file,\%prog_state);
1.118     albertel  443: 	      &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
1.115     foxr      444: 				 "for $status_statement dvips generated missing fonts",
                    445: 				 \%prog_state, $new_name_file);
                    446: 	  }
1.29      sakharuk  447: 	  if (-e $new_name_file) {
1.102     foxr      448: 	      my $latex_file = $name_file;
                    449: 	      $latex_file =~ s/\.dvi/\.tex/;
                    450: 	      &repaginate($new_name_file, $latex_file,  $numberofcolumns);
1.135     foxr      451: 
                    452: 	      &make_dvi_file($latex_file,
                    453: 			     $name_file,
                    454: 			     $tableofcontents,
                    455: 			     $tableofindex,
                    456: 			     $status_statement,
                    457: 			     \%prog_state,
                    458: 			     $busy_wait_timeout);
                    459: 
                    460: 
1.102     foxr      461: 	      &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
                    462: 				 "for $status_statement dvips to repaginate",
                    463: 				 \%prog_state, $new_name_file);
1.115     foxr      464: 
1.61      albertel  465: 	      print "<br />";
1.29      sakharuk  466: 	      $new_name_file =~ m/^(.*)\./;
1.59      albertel  467: 	      my $ps_file = my $tempo_file = $1.'temporar.ps';
                    468: 	      my $pdf_file = $1.'.pdf';
1.82      albertel  469: 	      $papera=~s/t/p/;
1.29      sakharuk  470: 	      if ($laystyle eq 'album' and $numberofcolumns eq '2') {
1.141     foxr      471: 		  $comma = "fixps --force ".$new_name_file." | psnup $papera -2 -s1.0 ";
                    472: 		  &debug("PSNUP command: $comma");
                    473: 		  &busy_wait_command("$comma 1>$tempo_file  2>/dev/null",
1.59      albertel  474: 				     "for $status_statement now Modifying PS layout",
                    475: 				     \%prog_state,$tempo_file);
1.29      sakharuk  476: 	      } elsif ($laystyle eq 'book' and $numberofcolumns eq '2') {
1.141     foxr      477: 		  $comma = 'fixps --force '.$new_name_file.' | pstops '.$papera.' "2:0+1(0.48w,0)"';
                    478: 		  &debug("PSTOPS command: $comma ");
                    479: 
                    480: 		  &busy_wait_command("$comma 1>$tempo_file  2>/dev/null",
1.59      albertel  481: 				     "for $status_statement now Modifying PS layout",
                    482: 				     \%prog_state,$tempo_file); 
1.29      sakharuk  483: 	      } else {
1.59      albertel  484: 		  $ps_file=$new_name_file;
                    485: 	      }
1.67      sakharuk  486: 	      my $addtoPSfile={'legal'=>'<< /PageSize [612 1008] >> setpagedevice',
                    487:                                'tabloid'=>'<< /PageSize [792 1224] >> setpagedevice',
                    488:                                'executive'=>,'<< /PageSize [540 720] >> setpagedevice',
                    489:                                'a2'=>'<< /PageSize [1195.02 1690.09] >> setpagedevice',
                    490:                                'a3'=>'<< /PageSize [842 1195.02] >> setpagedevice',
                    491:                                'a4'=>'<< /PageSize [595.2 842] >> setpagedevice',
                    492:                                'a5'=>'<< /PageSize [421.1 595.2] >> setpagedevice',
                    493:                                'a6'=>'<< /PageSize [298.75 421.1] >> setpagedevice',
                    494: 			   };
                    495: 	      if ($paper ne 'letter') {
1.69      matthew   496: 		  open(FFH,'<',$ps_file) || die "Couldn't open ps file $ps_file for reading: $!\n";
1.63      sakharuk  497: 		  my $new_ps_file='new'.$ps_file;
1.69      matthew   498: 		  open(FFHS,'>',$new_ps_file) || die "Couldn't open new ps file $new_ps_file for reading: $!\n";
1.67      sakharuk  499: 		  print FFHS $addtoPSfile->{$paper}."\n";
1.63      sakharuk  500: 		  while (<FFH>) {
                    501: 		      print FFHS $_;
                    502: 		  }
1.62      sakharuk  503: 		  close(FFH);
1.63      sakharuk  504: 		  close(FFHS);
                    505: 		  $ps_file=$new_ps_file;	  
1.62      sakharuk  506: 	      }
1.141     foxr      507: 	      &busy_wait_command("ps2pdf13 $ps_file $pdf_file 1>/dev/null 2>/dev/null",
1.59      albertel  508: 				 "for $status_statement now Converting PS to PDF",
                    509: 				 \%prog_state,$pdf_file);
                    510: 	    
1.29      sakharuk  511: 	      my $texlog = $texfile;
                    512: 	      my $texaux = $texfile;
                    513: 	      my $texdvi = $texfile;
                    514: 	      my $texps = $texfile;
                    515: 	      $texlog =~ s/\.tex/\.log/;
                    516: 	      $texaux =~ s/\.tex/\.aux/;
                    517: 	      $texdvi =~ s/\.tex/\.dvi/;
                    518: 	      $texps =~ s/\.tex/\.ps/;
                    519: 	      my @garb = ($texlog,$texaux,$texdvi,$texps);
1.22      sakharuk  520: #	  unlink @garb;
1.120     albertel  521: 	      unlink($duefile);
1.68      sakharuk  522: 	      print "<a href=\"/prtspool/$pdf_file\">$link_text - click here to download pdf</a>";
1.29      sakharuk  523: 	      print "\n";
                    524: 	  }
1.120     albertel  525: 	  unlink($missfonts_file);
1.119     foxr      526: 
1.63      sakharuk  527:       }  
1.29      sakharuk  528:   } else {
                    529:       print "LaTeX file $texfile was not created successfully";
1.14      sakharuk  530:   }
1.43      sakharuk  531: }
1.45      sakharuk  532: print "<br />";
1.44      sakharuk  533: if ($number_of_files>1) {
1.45      sakharuk  534:     my $zipfile=$texfile[0];
                    535:     $zipfile=~s/\.tex/\.zip/;
                    536:     my $statement="zip $zipfile";
1.44      sakharuk  537:     foreach my $file (@texfile) {
1.45      sakharuk  538: 	$file=~s/\.tex/.\pdf/;
                    539: 	$statement.=' '.$file; 
1.44      sakharuk  540:     }
1.49      albertel  541:     print("<pre>Zip Output:\n");
                    542:     system($statement);
                    543:     print("</pre>");
1.123     albertel  544:     $zipfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.49      albertel  545:     print "<br /> A <a href=\"$zipfile\">ZIP file</a> of all the PDFs.";
1.44      sakharuk  546: }
1.92      albertel  547: if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); }
1.97      albertel  548: print(&Apache::loncommon::end_page());
1.59      albertel  549: my $done;
1.102     foxr      550: 
1.59      albertel  551: sub REAPER {
                    552:     $done=1;
                    553: }
1.129     foxr      554: #
                    555: #  Execute a command updating the status window as the command's
                    556: #  output file builds up (at intervals of a second).
                    557: #
                    558: #   If the timeout argument defined, then if that many seconds
                    559: #   elapses without an increase in the size of the output file,
                    560: #   the command will be killed (this deals with the case when
                    561: #   latex crawls into an infinite loop).
                    562: #
1.59      albertel  563: sub busy_wait_command {
1.129     foxr      564:     my ($command,$message,$progress_win,$output_file, $timeout)=@_;
1.59      albertel  565:     
                    566:     $SIG{CHLD} = \&REAPER;
                    567:     $done=0;
                    568:     my $pid=open(CMD,"$command |");
1.92      albertel  569:     if ($advanced_role) {
1.60      albertel  570: 	&Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,$message);
                    571:     }
1.129     foxr      572:     my $last_size      = 0;
                    573:     my $unchanged_time = 0;
1.59      albertel  574:     while(!$done) {
                    575: 	sleep 1;
                    576: 	my $extra_msg;
                    577: 	if ($output_file) {
                    578: 	    my $size=(stat($output_file))[7];
                    579: 	    $extra_msg=", $size bytes generated";
1.129     foxr      580: 	    if ($size == $last_size) {
                    581: 		$unchanged_time++;
                    582: 		if ($timeout && ($unchanged_time > $timeout)) {
1.132     www       583: 		    print "<h1>Operation timed out!</h1>\n";
1.131     www       584: 		    print "<p>Executing $command, the output file $output_file did not grow\n";
1.130     foxr      585: 		    print "after $timeout seconds.  This <em>may</em> indicate $command\n";
1.131     www       586: 		    print "is in an infinite loop.\n";
                    587: 		    print "See if printing fewer copies helps.  Please contact LON-CAPA\n";
                    588: 		    print "support about this in any event.";
1.130     foxr      589: 		    print "</p>";
1.129     foxr      590: 		    kill(9, $pid); # Reaper will do the rest...I hope there's errors in the log.
                    591: 		}
                    592: 	    } else {
                    593: 		$last_size      = $size;
                    594: 		$unchanged_time = 0;
                    595: 	    }
1.59      albertel  596: 	}
1.92      albertel  597: 	if ($advanced_role) {
1.60      albertel  598: 	    &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,
                    599: 						  $message.$extra_msg);
                    600: 	}
1.59      albertel  601:     }
                    602:     $SIG{CHLD}='IGNORE';
                    603:     close(CMD);
                    604: }
1.1       sakharuk  605: 
1.135     foxr      606: # Make the dvi file (or rather try to), from the latex file and the
                    607: # various bits and pieces that control how the latex file is processed:
                    608: # LaTeX is run as many times a needed to make this all happen... this may
                    609: # result in several runs of LaTeX that just are errors if the LaTeX is
1.136     bisitz    610: # bad, but the printing subsystem is _supposed_ to not do that.
1.135     foxr      611: #
                    612: # Parameters:
                    613: #   name_file        - Name of the LaTeX file to process.
                    614: #   dvi_file         - Name of resulting dvi file.
                    615: #   tableofcontents  - "yes" if we are supposed to make a table of contents.
                    616: #   tableofindex     - "yes" if we are suposed to make an index.
                    617: #   status_statement - Part of the status statement for ths status window.
                    618: #   prog_state       - Reference to the program state hash.
                    619: #   busy_wait_timeout- Seconds without any progress that imply a problem.
                    620: #
                    621: #
                    622: sub make_dvi_file {
                    623:     my ($name_file,
                    624: 	$dvi_file,
                    625: 	$tableofcontents,
                    626: 	$tableofindex,
                    627: 	$status_statement,
                    628: 	$prog_state,
                    629: 	$busy_wait_timeout) = @_;
                    630:     
                    631:     
                    632:     &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
                    633: 		       "for $status_statement now LaTeXing file",
                    634: 		       $prog_state,$dvi_file, $busy_wait_timeout);
                    635: 
                    636:     # If the tableof contents was requested, we need to run 
                    637:     # LaTex a couple more times to get all the references sorted out.
                    638: 
                    639:     if ($tableofcontents eq 'yes') {
                    640: 	&busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
                    641: 			   "for $status_statement First LaTeX of file for table of contents",
                    642: 			   $prog_state,$dvi_file, $busy_wait_timeout);
                    643: 	&busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
                    644: 			   "for $status_statement Second LaTeX of file for table of contents",
                    645: 			   $prog_state,$dvi_file,$busy_wait_timeout);
                    646:     } 
                    647: 
                    648:     # And makeindex and another run of LaTeX to incorporate it if the index
                    649:     # is enabled.
                    650: 
                    651: 
                    652:     if ($tableofindex eq 'yes') {
                    653: 	my $idxname=$name_file;
                    654: 	$idxname=~s/\.tex$/\.idx/;
                    655: 	&busy_wait_command("makeindex $idxname",
                    656: 			   "making index file",
                    657: 			   $prog_state,$idxname);
                    658: 	&busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
                    659: 			   "for $status_statement now LaTeXing file for index section",
                    660: 			   $prog_state,$dvi_file, $busy_wait_timeout);
                    661:     } 
                    662:     
                    663: }    
                    664: 
                    665: 
1.102     foxr      666: #  Repagninate
1.99      foxr      667: #  What we need to do:
                    668: #   - Count the number of pages in each student.
1.102     foxr      669: #   - Rewrite the latex file replacing the \specials that
                    670: #     mark the end of student with an appropriate number of newlines.
                    671: #   parameters:
                    672: #     psfile     - Postscript filename
                    673: #     latexfile  - LaTeX filename
                    674: #     columns    - number of columns.
                    675: sub repaginate {
1.100     foxr      676: 
                    677:     # We will try to do this in 2 passes through the postscript since
                    678:     # the postscript is potentially large, to do 2 passes, the first pass
                    679:     # must be able to calculate the total number of document pages so that
                    680:     # at the beginning of the second pass we already know how to replace
                    681:     #  %%Pages:
                    682: 
                    683:     #  Figure out
                    684:     #    1. Number of pages in the document
                    685:     #    2. Maximum number of pages in a student
                    686:     #    3. Number of pages in each student.
1.99      foxr      687: 
1.102     foxr      688:     my ($postscript_filename, $latex_filename, $num_columns) = @_;
1.99      foxr      689:     open(PSFILE, "<$postscript_filename");
1.100     foxr      690:     my $line;
                    691:     my $total_pages;		# Total pages in document.
                    692:     my $seen_pages        = 0;	# There are several %%Pages only the first is useful
                    693:     my @pages_in_student;	# For each student his/her initial page count.
                    694:     my $max_pages = 0;		# Pages in 'longest' student.
1.102     foxr      695:     my $page_number = 0;
1.104     foxr      696:     &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, 
1.110     albertel  697: 					  &mt("Counting pages for student: [_1]",1));
1.104     foxr      698: 
1.100     foxr      699:     while ($line = <PSFILE>) {
                    700: 	
                    701: 	# Check for total pages (%%Pages:)
                    702: 
1.101     albertel  703: 	if (($line =~ /^%%Pages:/) && (!$seen_pages)) {
1.100     foxr      704: 	    my @pageinfo = split(/ /,$line);
                    705: 	    $total_pages = $pageinfo[1];
                    706: 	    $seen_pages  = 1;
                    707: 	}
                    708: 	#  Check for %%Page: n m  $page_number will be the
                    709: 	#  biggest of these until we see an endofstudent.
                    710: 	#  Note that minipages generate spurious %Page: 1 1's so
                    711: 	#  we only are looking for the largest n (n is page number at the
                    712: 	#  bottom of the page, m the page number within the document.
                    713: 	#
1.102     foxr      714: 
1.127     albertel  715: 	if ($line =~ /^%%Page:\s+\d+\s+\d+/) {
1.120     albertel  716: 	    my @pageinfo = split(/\s+/, $line);
1.100     foxr      717: 	    if ($page_number < $pageinfo[1]) {
                    718: 		$page_number = $pageinfo[1];
1.110     albertel  719: 	    } elsif ($pageinfo[2] ne 1) {
                    720: 		#  current page count reset, and it's not because of a 
                    721: 		#    minipage 
                    722: 		# - save the page_number, reset and, if necessary
                    723: 		#    update max_pages.
                    724: 		push(@pages_in_student, $page_number);
                    725: 		&Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, 
                    726: 						      &mt("Counting pages for student: [_1]", scalar(@pages_in_student)));
                    727: 		if ($page_number > $max_pages) {
                    728: 		    $max_pages = $page_number;
                    729: 		}
                    730: 		$page_number = $pageinfo[1];
1.100     foxr      731: 	    }
                    732: 	}
                    733: 
                    734: 	
                    735:     }
1.110     albertel  736:     # file ended so one more student
                    737:     push(@pages_in_student, $page_number);
                    738:     &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, 
                    739: 					  &mt("Counting pages for student: [_1]",scalar(@pages_in_student)));
                    740:     if ($page_number > $max_pages) {
                    741: 	$max_pages = $page_number;
                    742:     }
                    743:     $page_number = 0;
                    744:     
1.99      foxr      745:     close(PSFILE);
1.102     foxr      746: 
                    747:     #  If 2 columns, max_pages must go to an even number of columns:
1.103     foxr      748: 
1.102     foxr      749:    
                    750:     if ($num_columns == 2) {
                    751: 	if ($max_pages % 2) {
                    752: 	    $max_pages++;
                    753: 	}
                    754:     }
1.100     foxr      755:     
1.102     foxr      756:     #  Now rewrite the LaTex file, substituting our \special
                    757:     #  with an appropriate number of \newpage directives.
                    758: 
                    759:     my $outfilename = $latex_filename."temp";
                    760: 
                    761:     open(LATEXIN, "<$latex_filename");
                    762:     open(LATEXOUT, ">$outfilename");
                    763: 
                    764: 
1.110     albertel  765:     my $student_number    = 0;	# Index of student we're working on.
1.104     foxr      766:     &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, 
                    767: 					  "Repaginating student ".$student_number+1);
1.102     foxr      768: 
                    769:     while (my $line = <LATEXIN>) {
                    770: 	if ($line eq "\\special{ps:ENDOFSTUDENTSTAMP}\n") {
                    771: 	    # only end of student stamp if next line is ENDOFSTUDENTSTAMP:
                    772: 
                    773: 
                    774: 	    # End of student replace with 0 or more newpages.
                    775: 	    
                    776: 	    my $addlines = $max_pages - $pages_in_student[$student_number];
                    777: 	    while($addlines)  {
1.108     albertel  778: 		print LATEXOUT '\clearpage \strut \clearpage';
1.105     foxr      779: 
1.102     foxr      780: 		$addlines--;
1.100     foxr      781: 	    }
1.102     foxr      782: 	    
1.100     foxr      783: 	    $student_number++;
1.104     foxr      784: 	    &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, 
                    785: 						  "Repaginating student ".$student_number+1);
1.102     foxr      786: 	    
                    787: 	} else {
                    788: 	    print LATEXOUT $line;
1.100     foxr      789: 	}
                    790:     }
                    791: 
1.102     foxr      792:     close(LATEXIN);
                    793:     close(LATEXOUT);
1.108     albertel  794:     rename($outfilename, $latex_filename);
1.100     foxr      795: 
1.99      foxr      796: }
1.4       sakharuk  797: 
1.115     foxr      798: #
                    799: #   Create missing fonts given a latex missfonts.log file.
                    800: #   This file will have lines like:
                    801: #
                    802: #   mktexpk --mfmode ljfour --bdpi 8000 --mag 1+0/8000 --dpi 8000 tcrm0500
                    803: #
                    804: #  We want to execute those lines with the 8000's changed to 600's
                    805: #  in order to match the resolution of the ljfour printer.
                    806: #  Of course if some wiseguy has changed the default printer from ljfour
                    807: #  in the dvips's config.ps file that will break so we'll also
                    808: #  ensure that --mfmode is ljfour.
                    809: #
                    810: sub create_missing_fonts {
                    811:     my ($fontfile, $state) = @_;
                    812: 
                    813:     # Open and read in the font file..we'll read it into the array
                    814:     #  font_commands.
                    815:     #
1.118     albertel  816:     open(my $font_handle, $fontfile);
1.115     foxr      817:     my @font_commands = <$font_handle>;
1.118     albertel  818: 
                    819:     # make the list contain each command only once
                    820:     my %uniq;
                    821:     @font_commands = map { $uniq{$_}++ == 0 ? $_ : () } @font_commands;
1.115     foxr      822: 
                    823:     #  Now process each command replacing the appropriate 8000's with
                    824:     #  600's ensuring that font names with 8000's in them are not corrupted.
                    825:     #  and if the --mfmode is not ljfour we turn it into ljfour.
                    826:     #   Then we execute the command.
                    827:     #
1.118     albertel  828:     
1.115     foxr      829:     foreach my $command (@font_commands) {
1.116     albertel  830: 	#print("<br />Raw command: $command");
1.115     foxr      831: 	$command =~ s/ 8000/ 600/g;    # dpi directives.
                    832: 	$command =~ s/\/8000/\/600/g;  # mag directives.
1.116     albertel  833: 	#print("<br />After dpi replacements: $command");
1.115     foxr      834: 
                    835: 	my @cmdarray = split(/ /,$command);
                    836: 	for (my $i =0; $i < scalar(@cmdarray); $i++) {
                    837: 	    if ($cmdarray[$i] eq '--mfmode') {
                    838: 		$cmdarray[$i+1] = "ljfour";
                    839: 	    }
                    840: 	}
1.116     albertel  841: 	#print("<br /> before reassembly : (@cmdarray)");
1.115     foxr      842: 	$command = join(" ", (@cmdarray));
                    843: 
1.116     albertel  844: 	#print("<br />Creating fonts via command: $command");
1.118     albertel  845: 	&busy_wait_command("$command 1>/dev/null 2>/dev/null",
1.115     foxr      846: 			   "Creating missing font",
1.124     albertel  847: 			   $state);
1.115     foxr      848: 			   
                    849:     }
                    850: 
                    851: }
1.133     foxr      852: #
                    853: #  Convert a figure file to encapsulated postscript:
                    854: #  At present, this is using a lot of file scoped globals to pass data around. 
                    855: # Parameters:
                    856: #    not_eps  - The name of the file to convert which, presumably, is not
                    857: #               already an eps file.
                    858: #
                    859: sub convert_figure {
                    860:     my ($not_eps) = @_;
1.141     foxr      861:     &debug("in convert_figure");
1.133     foxr      862: 
                    863:     my $status_statement='EPS picture for '.$not_eps;
                    864:     my $eps_f = $not_eps;
1.134     foxr      865: 
1.133     foxr      866:     if ($eps_f=~/\/home\/([^\/]+)\/public_html\//) {
                    867: 	$eps_f=~s/\/home\/([^\/]+)\/public_html/$1/;
                    868:     } elsif ($eps_f=~/$perlvar{'lonDocRoot'}\/res\//) {
1.134     foxr      869: 	$eps_f=~ s/$perlvar{'lonDocRoot'}\/res\/(.+)/$1/;
1.133     foxr      870:     } elsif ($eps_f=~/$perlvar{'lonUsersDir'}\//) {
1.134     foxr      871: 	$eps_f=~ s/$perlvar{'lonUsersDir'}\/([^\/]+)\/\w\/\w\/\w\/(.+)/$1\/$2/;
1.133     foxr      872:     }
1.134     foxr      873: 
                    874:     $eps_f = $perlvar{'lonPrtDir'}.'/'.$eps_f;
                    875: 
                    876:     # Spaces are problematic for system commands and LaTeX, replace with _
                    877: 
                    878:     $eps_f  =~ s/ /\_/g; 
                    879: 
1.133     foxr      880:     # 
1.134     foxr      881:     # If the file is already an .eps or .ps file (eps_f still has the original
                    882:     # file type),
1.133     foxr      883:     # We really just need to copy it from where it was to prtspool
                    884:     # but with the spaces substituted to _'s.
                    885:     #
1.134     foxr      886:     my ($nsname,$path, $sext) = &fileparse($eps_f, qr/\.(ps|eps)/i);
1.133     foxr      887:     if ($sext =~/ps$/i) {
                    888: 	&File::Path::mkpath($path,0,0777);
                    889: 	copy("$not_eps", "$eps_f"); 
                    890:     } else {
                    891: 	
                    892: 	$eps_f .= '.eps';	# Just append the eps ext.
1.134     foxr      893: 	my $path= &dirname($eps_f);
1.133     foxr      894: 	&File::Path::mkpath($path,0,0777);
                    895: 	$not_eps =~ s/^\s+//;
                    896: 	$not_eps =~ s/\s+$//;
                    897: 	$not_eps =~ s/ /\\ /g;
                    898: 	if ($advanced_role) {
                    899: 	    my $prettyname=$not_eps;
                    900: 	    $prettyname=~s|/home/([^/]+)/public_html|/priv/$1|;
                    901: 	    $prettyname=~s|$perlvar{'lonDocRoot'}/|/|;
                    902: 	    &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,
                    903: 						  'Converting to EPS '.$prettyname);
                    904: 	}
1.141     foxr      905: 	#
                    906: 	#  If the file is a PDF, need to use pdftops to convert it to a ps file.
                    907: 	#  otherwise use imagemagik:
                    908: 	#
                    909: 	if($not_eps =~/\.(pdf|PDF)$/) {
                    910: 
                    911: 	    #
                    912: 	    # For whatever reason, pure postscript conversions have to be
                    913: 	    # in the same dir as the base file:
                    914: 	    #
                    915: 	    $eps_f = &basename($eps_f);
                    916: 	    $eps_f = $perlvar{'lonPrtDir'}.'/'.$eps_f;
                    917: 
                    918: 	    &debug("Converting pdf $not_eps to postscript: $eps_f");
                    919: 	    system("pdftops $not_eps $eps_f");
                    920: 	} else {
                    921: 	    system("convert $not_eps $eps_f");
                    922: 	}
1.134     foxr      923: 
1.133     foxr      924: 	if (not -e $eps_f) {
                    925: 	    # converting an animated gif creates either:
                    926: 	    # anim.gif.eps.0
                    927: 	    # or
                    928: 	    # anim.gif-0.eps
                    929: 	    for (my $i=0;$i<10000;$i++) {
                    930: 		if (-e $eps_f.'.'.$i) {
                    931: 		    rename($eps_f.'.'.$i, $eps_f);
                    932: 		    last;
                    933: 		}
                    934: 		my $anim_eps = $eps_f;
                    935: 		$anim_eps =~ s/(\.[^.]*)\.eps$/$1-$i\.eps/i;
                    936: 		if (-e $anim_eps) {
                    937: 		    rename($anim_eps, $eps_f);
                    938: 		    last;
                    939: 		}
                    940: 	    }
                    941: 	}
                    942: 	
                    943: 	# imagemagick 6.2.0-6.2.7 fails to properly handle
                    944: 	# convert anim.gif anim.gif.eps
                    945: 	# it creates anim.eps instead. 
                    946: 	if (not -e $eps_f) {
                    947: 	    my $eps_f2 = $eps_f;
                    948: 	    $eps_f2 =~ s/\.[^.]*\.eps$/\.eps/i;
                    949: 	    if(-e $eps_f2) {
                    950: 		rename($eps_f2,$eps_f);
                    951: 	    }
                    952: 	}
                    953:     }
                    954:     
                    955: }
1.135     foxr      956: #
                    957: #   Analyze a LaTeX logfile producing appropriate  output on error and 
                    958: #   returning a boolean to let the caller know if, in our opinion, it's
                    959: #   worth continuing on to produce the PDF file.
                    960: #
                    961: # Parameters:
                    962: #   logfilename   - Name of the logfile.
                    963: #   texfile       - Name of the LaTeX file that was being processed.
                    964: #   advanced_role - True if the user is privileged with respect to the printout
                    965: #                   (e.g. is the course coordinator or some such thing).
                    966: # Returns:
                    967: #    1            - Caller is advised to continue to create the PDF.
                    968: #    0            - Caller need not bother creating the PDF.
                    969: # Side Effects:
                    970: #   Messages are printed to describe any errors that have been encountered.
                    971: # NOTE:
                    972: #    The current policy is to assume that if LaTeX decided to insert some text
                    973: #    it has salvaged the resource and the resource can be printed.. in that case
                    974: #    a message is emitted from this sub.
                    975: #
                    976: sub analyze_logfile {
                    977:     my ($logfilename, $texfile, $advanced_role) = @_;
                    978: 
                    979:     my $temporary_file=IO::File->new($logfilename) || die "Couldn't open log file $logfilename for reading: $!\n";
                    980:     my @content_of_file = <$temporary_file>;
                    981:     close $temporary_file; 
                    982:     my $body_log_file = join(' ',@content_of_file);
                    983:     $logfilename =~ s/\.log$/\.html/;
                    984:     $temporary_file = IO::File->new('>'.$logfilename); 
                    985:     print $temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_log_file.'</pre></body></html>'."\n";
                    986:     if ($body_log_file=~m/!\s+Emergency stop/) {
                    987: 	my $whereitbegins = rindex $body_log_file,'STAMPOFPASSEDRESOURCESTART';
                    988: 	my $whereitends = rindex $body_log_file,'STAMPOFPASSEDRESOURCEEND';
                    989: 	my $badresource;
                    990: 	my $badtext;
                    991: 	if ($whereitbegins!=-1 and $whereitends!=-1) {
                    992: 	    $badtext = substr($body_log_file,$whereitbegins+26, $whereitends-$whereitbegins-26);
                    993: 	    $whereitbegins  = rindex $badtext,'located in';
                    994: 	    if ($whereitbegins != -1) {
                    995: 		
                    996: 		$badresource = substr($badtext, $whereitbegins+27, 
                    997: 				      length($badtext) - $whereitbegins - 48);
                    998: 		# print "<br />failing resourcename: $badresource<br />";
                    999: 	    }
1.136     bisitz   1000:         }
1.135     foxr     1001: 
                   1002: 	# Guys with privileged roles get a more detailed error output:
                   1003: 
                   1004: 	if ($advanced_role) {  
                   1005: 	    #LaTeX failed to parse tex file 
1.138     biermanm 1006: 	    print "<h2>".&mt('LaTeX could not successfully parse your TeX file.')."</h2>";
1.136     bisitz   1007: 	    print &mt('It probably has errors in it.')."<br />";
                   1008: 	    if ($badtext) {
                   1009:                 print &mt('With very high probability this error occured in [_1].',$badtext)
                   1010:                      ."<br /><br />";
                   1011:             }
                   1012: 	    print &mt('Here are the error messages in the LaTeX log file:')
                   1013:                  ."<br /><pre>";
1.135     foxr     1014: 	    
                   1015: 	    my $sygnal = 0;
                   1016: 	    for (my $i=0;$i<=$#content_of_file;$i++) {
                   1017: 		if ($content_of_file[$i]=~m/^Runaway argument?/ or $content_of_file[$i]=~m/^!/) {
                   1018: 		    $sygnal = 1;
                   1019: 		} 
                   1020: 		if ($content_of_file[$i]=~m/Here is how much of/) {
                   1021: 		    $sygnal = 0;
                   1022: 		} 
                   1023: 		if ($sygnal) {
                   1024: 		    print "$content_of_file[$i]";
                   1025: 		}  
                   1026: 	    }
                   1027: 	    print "</pre>\n";
                   1028: 	    # print "<br /> Advanced role <br />";
                   1029: 	    $logfilename=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136     bisitz   1030: 	    print "<b><big>"
                   1031:                  .&mt('The link to [_1]Your log file[_2]','<a href="'.$logfilename.'">','</a>')
                   1032: 	         ."</big></b>\n";
1.135     foxr     1033: 	    #link to original LaTeX file
                   1034: 	    my $tex_temporary_file=IO::File->new($texfile) || die "Couldn't open tex file $texfile for reading: $!\n";
                   1035: 	    my @tex_content_of_file = <$tex_temporary_file>;
                   1036: 	    close $tex_temporary_file; 
                   1037: 	    my $body_tex_file = join(' ',@tex_content_of_file);
                   1038: 	    $texfile =~ s/\.tex$/aaaaa\.html/;
                   1039: 	    $tex_temporary_file = IO::File->new('>'.$texfile); 
                   1040: 	    print $tex_temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_tex_file.'</pre></body></html>'."\n";
                   1041: 	    print "<br /><br />";
                   1042: 	    $texfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136     bisitz   1043: 	    print "<b><big>"
                   1044:                  .&mt('The link to [_1]Your original LaTeX file[_2]','<a href="'.$texfile.'">','</a>')
                   1045: 	         ."</big></b><br /><br />\n";
                   1046: 	    my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", &mt('Help on printing'));
1.135     foxr     1047: 	    print ("$help_text");
                   1048: 
                   1049: 	    # Students on the other hand get a minimal error message, since they won't
                   1050: 	    # be able to correct the error message. A message is sent to the 
                   1051: 	    # instructor:
                   1052: 
                   1053: 	} else {		# Student role...
                   1054: 	    #  at this point:
                   1055: 	    #    $body_log_file - contains the log file.
                   1056: 	    #    $name_file     - is the name of the LaTeX file.
                   1057: 	    #    $identifier    - is the unique LaTeX identifier.l
                   1058: 	    
1.142   ! bisitz   1059:             print '<p class="LC_error">';
1.136     bisitz   1060: 	    if ($badtext) {
                   1061:                 print &mt('There are errors in [_1].',$badtext);
                   1062:             } else {
                   1063:                 print &mt('There are errors.');
                   1064:             }
1.142   ! bisitz   1065:             print '</p>'
        !          1066:                  .&mt('These errors prevent this resource from printing correctly.');
        !          1067: 
1.135     foxr     1068: 	    my $tex_handle = IO::File->new($texfile);
                   1069: 	    my @tex_contents = <$tex_handle>;
                   1070: 	    &send_error_mail($identifier, $badresource, $body_log_file, \@tex_contents);
1.136     bisitz   1071: 	    print "<p>"
                   1072:                  .&mt('A message has been sent to the instructor describing this failure.')
                   1073:                  ."</p>";
                   1074: 	    my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", &mt('Help on printing'));
1.135     foxr     1075: 	    print  ("$help_text");
                   1076: 	    
                   1077: 	  }
                   1078: 
                   1079: 	# Either way, an emergency stop does not allow us to continue so:
                   1080: 
                   1081: 	return 0;
                   1082: 	
                   1083: 	# The branch of code below is taken if it appears that 
                   1084: 	# there was no emergency stop but LaTeX had to correct the
                   1085: 	# input file to run.
                   1086: 	# In that case we need to provide error feedback, as the correction >may< not be
                   1087: 	# sufficient, we can let the game continue as there's a dvi file to process.
                   1088: 
                   1089:     } elsif ($body_log_file=~m/<inserted text>/) {
                   1090: 	my $whereitbegins = index $body_log_file,'<inserted text>';
1.136     bisitz   1091: 	print &mt('You are running LaTeX in [_1]batch mode[_2].','<b>','</b>');
1.135     foxr     1092: 	while ($whereitbegins != -1) {
                   1093: 	    my $tempobegin=$whereitbegins;
                   1094: 	    $whereitbegins = rindex $body_log_file,'STAMPOFPASSEDRESOURCESTART',$whereitbegins;
                   1095: 	    my $whereitends = index $body_log_file,'STAMPOFPASSEDRESOURCEEND',$whereitbegins;
1.136     bisitz   1096: 	    print "<br />"
                   1097:                  .&mt('It has found an error in [_1][_2]and corrected it.',substr($body_log_file,$whereitbegins+26,$whereitends-$whereitbegins-26),"<br />")."\n";
                   1098: 	    print &mt('Usually this correction is valid but you probably need to check the indicated resource one more time and implement neccessary corrections by yourself.')."\n";
1.135     foxr     1099: 	    $whereitbegins = index $body_log_file,'<inserted text>',$tempobegin+10;
                   1100: 	}
                   1101: 
                   1102: 	if ($advanced_role) {  
                   1103: 	    print "<br /><br />";
                   1104: 	    $logfilename=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136     bisitz   1105: 	    print "<b><big>"
                   1106:                  .&mt('The link to [_1]Your log file[_2]'
1.137     raeburn  1107:                      ,'<a href="'.$logfilename.'">','</a>')
1.136     bisitz   1108: 	         ."</big></b>\n";
1.135     foxr     1109: 	    #link to original LaTeX file
                   1110: 	    my $tex_temporary_file=IO::File->new($texfile) || die "Couldn't open tex file $texfile for reading: $!\n";
                   1111: 	    my @tex_content_of_file = <$tex_temporary_file>;
                   1112: 	    close $tex_temporary_file; 
                   1113: 	    my $body_tex_file = join(' ',@tex_content_of_file);
                   1114: 	    $texfile =~ s/\.tex$/aaaaa\.html/;
                   1115: 	    $tex_temporary_file = IO::File->new('>'.$texfile); 
                   1116: 	    print $tex_temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_tex_file.'</pre></body></html>'."\n";
                   1117: 	    print "<br /><br />";
                   1118: 	    $texfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136     bisitz   1119: 	    print "<b><big>"
                   1120:                   .&mt('The link to [_1]Your original LaTeX file[_2]','<a href="'.$texfile.'">','</a>');
                   1121: 	    print "</big></b>\n";
1.135     foxr     1122: 	}
                   1123: 	return 1;
                   1124:     }
                   1125:     return 1;			# NO log file issues at all.
                   1126: }

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