--- loncom/interface/printout.pl 2005/07/05 10:23:35 1.83
+++ loncom/interface/printout.pl 2007/10/11 22:49:49 1.128
@@ -1,6 +1,7 @@
#!/usr/bin/perl
# CGI-script to run LaTeX, dvips, ps2ps, ps2pdf etc.
#
+# $Id: printout.pl,v 1.128 2007/10/11 22:49:49 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,42 +29,40 @@
use lib '/home/httpd/lib/perl';
use LONCAPA::loncgi;
use File::Path;
+use File::Basename;
+use File::Copy;
use IO::File;
use Image::Magick;
-use Apache::lonhtmlcommon;
+use Apache::lonhtmlcommon();
use Apache::lonnet;
-use Apache::loncommon;
+use Apache::loncommon();
use Apache::lonlocal;
-use Apache::lonmsg;
+use Apache::lonmsg();
use LONCAPA::Enrollment;
+use LONCAPA::Configuration;
use strict;
-#
# Determine if a user is operating as a student for this course/domain.
-#
-#
#Parameters:
-# course - The course id.
-# cdom - The course domain.
-#
+# none
#Implicit:
# $env{request.role} contains the role under which this user operated this
# this request.
sub is_student {
- return (! $env{'request.role.adv'});
+ return ($env{'request.role'}=~/^st\./);
}
#
# Debugging: Dump the environment for debugging.
#
sub dumpenv {
- print "
-------------------
";
+ print "
-------------------
";
foreach my $key (sort (keys %env)) {
- print "
$key -> $env{$key}";
+ print "
$key -> $env{$key}";
}
- print "
-------------------
";
+ print "
-------------------
";
}
#
@@ -111,16 +110,18 @@ sub send_error_mail {
# The user is a student in the course:
#
- if (&is_student( $courseid, $coursedom)) {
+ if (&is_student()) {
# build the subject and message body:
- # print "sending message to course coordinators.
";
+ # print "sending message to course coordinators.
";
# Todo: Convert badurl into a url from file path:
my $subject = "Error [$badurl] Print failed for $user".'@'.$domain;
my $message .= "Print failed to render LaTeX for $user".'@'."$domain\n";
$message .= " User was attempting to print: \n";
- $message .= " $resources\n";
+ foreach my $resource (split(/:/,$resources)) {
+ $message .= " $resource\n";
+ }
$message .= "--------------------LaTeX logfile:------------ \n";
$message .= $logfile;
$message .= "-----------------LaTeX source file: ------------\n";
@@ -128,11 +129,11 @@ sub send_error_mail {
foreach my $line (@$texfile) {
$message .= "$line\n";
}
- my (undef, %receivers) = &Apache::lonfeedback::decide_receiver(undef, 0,
- 1,1,1);
- # print "
sending...section: $env{'request.course.sec'}";
+ my (undef, %receivers) = &Apache::lonmsg::decide_receiver(undef, 0,
+ 1,1,1);
+ # print "
sending...section: $env{'request.course.sec'}";
foreach my $dest (keys %receivers) {
- # print "
dest is $dest";
+ # print "
dest is $dest";
my @destinfo = split(/:/,$dest);
my $user = $destinfo[0];
my $dom = $destinfo[1];
@@ -161,10 +162,12 @@ Your cookie information is incorrect.
END
return;
}
+
+my %perlvar=%{&LONCAPA::Configuration::read_conf('loncapa.conf')};
&Apache::lonlocal::get_language_handle();
&Apache::loncommon::content_type(undef,'text/html');
- my $bodytag=&Apache::loncommon::bodytag('Creating PDF','','');
- print $bodytag;
+$env{'request.noversionuri'} = '/cgi-bin/printout.pl';
+ print(&Apache::loncommon::start_page('Creating PDF'));
my $identifier = $ENV{'QUERY_STRING'};
my $texfile = $env{'cgi.'.$identifier.'.file'};
@@ -179,18 +182,19 @@ END
my $student_names = $env{'cgi.'.$identifier.'.studentnames'};
my $backref = &Apache::lonnet::unescape($env{'cgi.'.$identifier.'.backref'});
-
- my $adv = $env{'request.role.adv'};
my @names_pack=();
if ($student_names=~/_END_/) {
@names_pack=split(/_ENDPERSON_/,$student_names);
}
-
+ if ($backref) {
+ print('
'.&mt("[_1]Return[_2] to editing resource.", + "","").'
'); + } my $figfile = $texfile; - $figfile =~ s/^([^\.]+printout)[^t]+\.tex/$1\.dat/; + $figfile =~ s/^(.*_printout)_\d+_\d+_\d+\.tex/$1\.dat/; my $duefile = $texfile; - $duefile =~ s/^([^\.]+printout)[^t]+\.tex/$1\.due/; + $duefile =~ s/^(.*_printout)_\d+_\d+_\d+\.tex/$1\.due/; #do we have figures? # print "Figure file: $figfile\n"; if (-e $figfile) { @@ -201,56 +205,100 @@ END close $temporary_file; my $noteps; my %prog_state; - if ($adv) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Coverting Images to EPS','Picture Conversion Status',$#content_of_file,'inline','80'); } + if ($advanced_role) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Coverting Images to EPS','Picture Conversion Status',$#content_of_file,'inline','80'); } + print('"; + print "Here are the error messages in the LaTeX log file"; + my $sygnal = 0; for (my $i=0;$i<=$#content_of_file;$i++) { if ($content_of_file[$i]=~m/^Runaway argument?/ or $content_of_file[$i]=~m/^!/) { @@ -364,9 +443,9 @@ foreach $texfile (@texfile) { } } print "\n"; - # print "
Advanced role
"; + # print "
Advanced role
"; print "The link to "; - $logfilename=~s/\/home\/httpd//; + $logfilename=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool}; print "Your log file "; print "\n"; #link tooriginal LaTeX file (included according Michael Hamlin desire) @@ -379,21 +458,27 @@ foreach $texfile (@texfile) { print $tex_temporary_file 'LOGFILE '.$body_tex_file.''."\n"; print "
"; print "The link to "; - $texfile=~s/\/home\/httpd//; + $texfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool}; print "Your original LaTeX file "; print "\n"; + my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", "Help on printing"); + print ("$help_text"); + } else { # Student role... # at this point: # $body_log_file - contains the log file. # $name_file - is the name of the LaTeX file. # $identifier - is the unique LaTeX identifier.l - print "
There are errors in $badtext"; - print "
These errors prevent this resource from printing correctly"; + print "
There are errors in $badtext"; + print "
These errors prevent this resource from printing correctly"; my $tex_handle = IO::File->new($name_file); my @tex_contents = <$tex_handle>; &send_error_mail($identifier, $badresource, $body_log_file, \@tex_contents); - print "
A message has been sent to the instructor describing this failure
" + print "
A message has been sent to the instructor describing this failure
"; + my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", "Help on printing"); + print ("$help_text"); + } } elsif ($body_log_file=~m//) { @@ -418,7 +503,74 @@ foreach $texfile (@texfile) { "for $status_statement now Converting to PS", \%prog_state,$new_name_file); if (-e $new_name_file) { - print " PDF output file (see link below)
\n"; + my $latex_file = $name_file; + $latex_file =~ s/\.dvi/\.tex/; + &repaginate($new_name_file, $latex_file, $numberofcolumns); + # + # Now have to re-latex, re dvips again to + # get the repaginated postscript. + # + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement first latex to repaginate", + \%prog_state, $name_file); + if ($tableofcontents eq 'yes') { + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement second latex to repaginate", + \%prog_state, $name_file); + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement third latex to repaginate", + \%prog_state, $name_file); + } + if ($tableofindex eq 'yes') { + my $idxname = $latex_file; + $idxname =~ s/\.tex$/\.idx/; + &busy_wait_command("makeindex $idxname", + "Re-creating index file", + \%prog_state, $idxname); + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement now Recreting index (latex)", + \%prog_state, $dvi_file); + + } + &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null", + "for $status_statement dvips to repaginate", + \%prog_state, $new_name_file); + # + # One last little hinky kinky thing. + # It's just possible that some fonts could not be maded + # at the resolution of the pdf print driver. + # In that case a file called missfont.log will have been + # created that will contain the commands that were attempted + # to create the missing fonts. If we basically + # take all the 8000 strings in that file, and + # replace them with 600 (the ljfour resolution) + # run the commands in that file and redvips, + # we'll be able to print the missing glyphs at 600dpi. + # + # Supposedly it is possible to tune TeX/Metafont to do this + # right but I failed to get that to work when following the + # docs at the tug site, hence this rather kludgey fix. + # + # We make the (I think) reasonable assumption that + # missing glyphs won't change the pagination and I think + # this is true because TeX/dvips will leave a space + # instead of these glyphs based on the font metrics + # (fancy way to say there will be a blank the size of the missing + # glyphs). + # + my $print_directory = dirname($name_file); + my $missfonts_file = $print_directory."/missfont.log"; + #print("
Missing fonts file is: $missfonts_file"); + if (-e $missfonts_file) { + #print("
Missing fonts file exists\n"); + &create_missing_fonts($missfonts_file,\%prog_state); + &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null", + "for $status_statement dvips generated missing fonts", + \%prog_state, $new_name_file); + } + + # + print "\nPDF output file (see link below)
\n"; $new_name_file =~ m/^(.*)\./; my $ps_file = my $tempo_file = $1.'temporar.ps'; my $pdf_file = $1.'.pdf'; @@ -456,13 +608,15 @@ foreach $texfile (@texfile) { $texps =~ s/\.tex/\.ps/; my @garb = ($texaux,$texdvi,$texps); # unlink @garb; - unlink $duefile; + unlink($duefile); print "Your PDF document"; + unlink($missfonts_file); + } if ($advanced_role) { print "
"; print "The link to "; - $logfilename=~s/\/home\/httpd//; + $logfilename=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool}; print "Your log file "; print "\n"; #link tooriginal LaTeX file (included according Michael Hamlin desire) @@ -475,10 +629,11 @@ foreach $texfile (@texfile) { print $tex_temporary_file 'LOGFILE '.$body_tex_file.''."\n"; print "
"; print "The link to "; - $texfile=~s/\/home\/httpd//; + $texfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool}; print "Your original LaTeX file "; print "\n"; } + } else { #LaTeX successfully parsed tex file $name_file =~ s/\.tex/\.dvi/; @@ -491,7 +646,68 @@ foreach $texfile (@texfile) { &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null", "for $status_statement now Converting to PS", \%prog_state,$new_name_file); + # + # One last little hinky kinky thing. + # It's just possible that some fonts could not be maded + # at the resolution of the pdf print driver. + # In that case a file called missfont.log will have been + # created that will contain the commands that were attempted + # to create the missing fonts. If we basically + # take all the 8000 strings in that file, and + # replace them with 600 (the ljfour resolution) + # run the commands in that file and redvips, + # we'll be able to print the missing glyphs at 600dpi. + # + # Supposedly it is possible to tune TeX/Metafont to do this + # right but I failed to get that to work when following the + # docs at the tug site, hence this rather kludgey fix. + # + # We make the (I think) reasonable assumption that + # missing glyphs won't change the pagination and I think + # this is true because TeX/dvips will leave a space + # instead of these glyphs based on the font metrics + # (fancy way to say there will be a blank the size of the missing + # glyphs). + # + my $print_directory = dirname($name_file); + my $missfonts_file = $print_directory."/missfont.log"; + #print("
Missing fonts file is: $missfonts_file"); + if (-e $missfonts_file) { + #print("
Missing fonts file exists\n"); + &create_missing_fonts($missfonts_file,\%prog_state); + &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null", + "for $status_statement dvips generated missing fonts", + \%prog_state, $new_name_file); + } if (-e $new_name_file) { + my $latex_file = $name_file; + $latex_file =~ s/\.dvi/\.tex/; + &repaginate($new_name_file, $latex_file, $numberofcolumns); + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement first latex to repaginate", + \%prog_state, $name_file); + if ($tableofcontents eq 'yes') { + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement second latex to repaginate", + \%prog_state, $name_file); + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement third latex to repaginate", + \%prog_state, $name_file); + } + if ($tableofindex eq 'yes') { + my $idxname = $latex_file; + $idxname =~ s/\.tex$/\.idx/; + &busy_wait_command("makeindex $idxname", + "Re-creating index file", + \%prog_state, $idxname); + &busy_wait_command("latex $latex_file 1>/dev/null 2>/dev/null", + "for $status_statement now Recreting index (latex)", + \%prog_state, $dvi_file); + } + &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null", + "for $status_statement dvips to repaginate", + \%prog_state, $new_name_file); + print "
"; $new_name_file =~ m/^(.*)\./; my $ps_file = my $tempo_file = $1.'temporar.ps'; @@ -545,10 +761,12 @@ foreach $texfile (@texfile) { $texps =~ s/\.tex/\.ps/; my @garb = ($texlog,$texaux,$texdvi,$texps); # unlink @garb; - unlink $duefile; + unlink($duefile); print "$link_text - click here to download pdf"; print "\n"; } + unlink($missfonts_file); + } } else { print "LaTeX file $texfile was not created successfully"; @@ -566,12 +784,13 @@ if ($number_of_files>1) { print("Zip Output:\n"); system($statement); print(""); - $zipfile=~s/\/home\/httpd//; + $zipfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool}; print "
A ZIP file of all the PDFs."; } -if ($adv) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); } - +if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); } +print(&Apache::loncommon::end_page()); my $done; + sub REAPER { $done=1; } @@ -582,7 +801,7 @@ sub busy_wait_command { $SIG{CHLD} = \&REAPER; $done=0; my $pid=open(CMD,"$command |"); - if ($adv) { + if ($advanced_role) { &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,$message); } while(!$done) { @@ -592,7 +811,7 @@ sub busy_wait_command { my $size=(stat($output_file))[7]; $extra_msg=", $size bytes generated"; } - if ($adv) { + if ($advanced_role) { &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win, $message.$extra_msg); } @@ -601,6 +820,189 @@ sub busy_wait_command { close(CMD); } +# Repagninate +# What we need to do: +# - Count the number of pages in each student. +# - Rewrite the latex file replacing the \specials that +# mark the end of student with an appropriate number of newlines. +# parameters: +# psfile - Postscript filename +# latexfile - LaTeX filename +# columns - number of columns. +sub repaginate { + + # We will try to do this in 2 passes through the postscript since + # the postscript is potentially large, to do 2 passes, the first pass + # must be able to calculate the total number of document pages so that + # at the beginning of the second pass we already know how to replace + # %%Pages: + + # Figure out + # 1. Number of pages in the document + # 2. Maximum number of pages in a student + # 3. Number of pages in each student. + + my ($postscript_filename, $latex_filename, $num_columns) = @_; + open(PSFILE, "<$postscript_filename"); + my $line; + my $total_pages; # Total pages in document. + my $seen_pages = 0; # There are several %%Pages only the first is useful + my @pages_in_student; # For each student his/her initial page count. + my $max_pages = 0; # Pages in 'longest' student. + my $page_number = 0; + &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, + &mt("Counting pages for student: [_1]",1)); + while ($line =) { + + # Check for total pages (%%Pages:) + if (($line =~ /^%%Pages:/) && (!$seen_pages)) { + my @pageinfo = split(/ /,$line); + $total_pages = $pageinfo[1]; + $seen_pages = 1; + } + # Check for %%Page: n m $page_number will be the + # biggest of these until we see an endofstudent. + # Note that minipages generate spurious %Page: 1 1's so + # we only are looking for the largest n (n is page number at the + # bottom of the page, m the page number within the document. + # + if ($line =~ /^%%Page:\s+\d+\s+\d+/) { + my @pageinfo = split(/\s+/, $line); + if ($page_number < $pageinfo[1]) { + $page_number = $pageinfo[1]; + } elsif ($pageinfo[2] ne 1) { + # current page count reset, and it's not because of a + # minipage + # - save the page_number, reset and, if necessary + # update max_pages. + push(@pages_in_student, $page_number); + &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, + &mt("Counting pages for student: [_1]", scalar(@pages_in_student))); + if ($page_number > $max_pages) { + $max_pages = $page_number; + } + $page_number = $pageinfo[1]; + } + } + + + } + # file ended so one more student + push(@pages_in_student, $page_number); + &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, + &mt("Counting pages for student: [_1]",scalar(@pages_in_student))); + if ($page_number > $max_pages) { + $max_pages = $page_number; + } + $page_number = 0; + + close(PSFILE); + + # If 2 columns, max_pages must go to an even number of columns: + + + if ($num_columns == 2) { + if ($max_pages % 2) { + $max_pages++; + } + } + + # Now rewrite the LaTex file, substituting our \special + # with an appropriate number of \newpage directives. + + my $outfilename = $latex_filename."temp"; + + open(LATEXIN, "<$latex_filename"); + open(LATEXOUT, ">$outfilename"); + + + my $student_number = 0; # Index of student we're working on. + &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, + "Repaginating student ".$student_number+1); + + while (my $line = ) { + if ($line eq "\\special{ps:ENDOFSTUDENTSTAMP}\n") { + # only end of student stamp if next line is ENDOFSTUDENTSTAMP: + + + # End of student replace with 0 or more newpages. + + my $addlines = $max_pages - $pages_in_student[$student_number]; + while($addlines) { + print LATEXOUT '\clearpage \strut \clearpage'; + + $addlines--; + } + + $student_number++; + &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state, + "Repaginating student ".$student_number+1); + + } else { + print LATEXOUT $line; + } + } + + close(LATEXIN); + close(LATEXOUT); + rename($outfilename, $latex_filename); + +} + +# +# Create missing fonts given a latex missfonts.log file. +# This file will have lines like: +# +# mktexpk --mfmode ljfour --bdpi 8000 --mag 1+0/8000 --dpi 8000 tcrm0500 +# +# We want to execute those lines with the 8000's changed to 600's +# in order to match the resolution of the ljfour printer. +# Of course if some wiseguy has changed the default printer from ljfour +# in the dvips's config.ps file that will break so we'll also +# ensure that --mfmode is ljfour. +# +sub create_missing_fonts { + my ($fontfile, $state) = @_; + + # Open and read in the font file..we'll read it into the array + # font_commands. + # + open(my $font_handle, $fontfile); + my @font_commands = <$font_handle>; + + # make the list contain each command only once + my %uniq; + @font_commands = map { $uniq{$_}++ == 0 ? $_ : () } @font_commands; + + # Now process each command replacing the appropriate 8000's with + # 600's ensuring that font names with 8000's in them are not corrupted. + # and if the --mfmode is not ljfour we turn it into ljfour. + # Then we execute the command. + # + + foreach my $command (@font_commands) { + #print("
Raw command: $command"); + $command =~ s/ 8000/ 600/g; # dpi directives. + $command =~ s/\/8000/\/600/g; # mag directives. + #print("
After dpi replacements: $command"); + + my @cmdarray = split(/ /,$command); + for (my $i =0; $i < scalar(@cmdarray); $i++) { + if ($cmdarray[$i] eq '--mfmode') { + $cmdarray[$i+1] = "ljfour"; + } + } + #print("
before reassembly : (@cmdarray)"); + $command = join(" ", (@cmdarray)); + + #print("
Creating fonts via command: $command"); + &busy_wait_command("$command 1>/dev/null 2>/dev/null", + "Creating missing font", + $state); + + } + +}