--- loncom/interface/printout.pl 2009/11/17 01:21:08 1.137.2.1
+++ loncom/interface/printout.pl 2017/11/12 15:41:45 1.165
@@ -1,7 +1,7 @@
#!/usr/bin/perl
# CGI-script to run LaTeX, dvips, ps2ps, ps2pdf etc.
#
-# $Id: printout.pl,v 1.137.2.1 2009/11/17 01:21:08 raeburn Exp $
+# $Id: printout.pl,v 1.165 2017/11/12 15:41:45 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -40,14 +40,20 @@ use Apache::lonlocal;
use Apache::lonmsg();
use LONCAPA::Enrollment;
use LONCAPA::Configuration;
+use LONCAPA;
use strict;
my $busy_wait_timeout = 30;
+my $pdfs_converted = 0; # non zero if PDF includes (need to fixps).
+
+my $debugging = 0;
sub debug {
- my ($text) = @_;
- print "$text
\n";
+ if ($debugging) {
+ my ($text) = @_;
+ print "$text
\n";
+ }
}
# Determine if a user is operating as a student for this course/domain.
@@ -118,12 +124,12 @@ sub send_error_mail {
if (&is_student()) {
# build the subject and message body:
- # print "sending message to course coordinators.
";
+ &debug("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";
+ 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";
foreach my $resource (split(/:/,$resources)) {
$message .= " $resource\n";
@@ -137,9 +143,9 @@ sub send_error_mail {
}
my (undef, %receivers) = &Apache::lonmsg::decide_receiver(undef, 0,
1,1,1);
- # print "
sending...section: $env{'request.course.sec'}";
+ &debug("sending...section: $env{'request.course.sec'}");
foreach my $dest (keys %receivers) {
- # print "
dest is $dest";
+ &debug("dest is $dest");
my @destinfo = split(/:/,$dest);
my $user = $destinfo[0];
my $dom = $destinfo[1];
@@ -173,7 +179,17 @@ my %perlvar=%{&LONCAPA::Configuration::r
&Apache::lonlocal::get_language_handle();
&Apache::loncommon::content_type(undef,'text/html');
$env{'request.noversionuri'} = '/cgi-bin/printout.pl';
-print(&Apache::loncommon::start_page('Creating PDF'));
+# Breadcrumbs
+#FIXME: Choose better/different breadcrumbs?!? Links?
+my $brcrum = [{'href' => '',
+ 'text' => 'Helper'}, #FIXME: Different origin possible than print out helper?
+ {'href' => '',
+ 'text' => 'Preparing Printout'},
+ {'href' => '',
+ 'text' => 'Creating PDF'}];
+print(&Apache::loncommon::start_page('Creating PDF',
+ undef,
+ {'bread_crumbs' => $brcrum,}));
my $identifier = $ENV{'QUERY_STRING'};
my $texfile = $env{'cgi.'.$identifier.'.file'};
@@ -186,7 +202,7 @@ my $tableofindex = $env{'cgi.'.$identifi
my $advanced_role = $env{'cgi.'.$identifier.'.role'};
my $number_of_files = $env{'cgi.'.$identifier.'.numberoffiles'}+1;
my $student_names = $env{'cgi.'.$identifier.'.studentnames'};
-my $backref = &Apache::lonnet::unescape($env{'cgi.'.$identifier.'.backref'});
+my $backref = &unescape($env{'cgi.'.$identifier.'.backref'});
my @names_pack=();
@@ -194,8 +210,10 @@ if ($student_names=~/_END_/) {
@names_pack=split(/_ENDPERSON_/,$student_names);
}
if ($backref) {
- print('
'.&mt("[_1]Return[_2] to editing resource.",
+ print('
'.&mt("[_1]Return[_2] to resource.",
"","").'
');
+ print(''.
+ &mt("Change Printing Options").'
'."\n");
}
my $figfile = $texfile;
$figfile =~ s/^(.*_printout)_\d+_\d+_\d+\.tex/$1\.dat/;
@@ -211,18 +229,22 @@ $duefile =~ s/^(.*_printout)_\d+_\d+_\d+
# it contains the names of the files that need to be converted, one per line.
#
+&debug("Figure file is $figfile");
+
if (-e $figfile) {
- # print "$figfile exists\n";
+ &debug( "Figure file exists");
+ &debug("$figfile exists");
my %done_conversion;
my $temporary_file=IO::File->new($figfile) || die "Couldn't open fig file $figfile for reading: $!\n";
my @content_of_file = <$temporary_file>;
close $temporary_file;
my $noteps;
my %prog_state;
- if ($advanced_role) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Converting Images to EPS','Picture Conversion Status',$#content_of_file,'inline','80'); }
+ if ($advanced_role) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('',$#content_of_file); }
print('
');
foreach my $not_eps (@content_of_file) {
chomp($not_eps);
+ &debug( "Being asked to convert $not_eps");
if ($not_eps ne '') {
$not_eps=~s|\/\.\/|\/|g;
if (!$done_conversion{$not_eps}) { # Only convert multiple includes once.
@@ -264,7 +286,7 @@ my $ind=-1;
my %prog_state;
if ($advanced_role) {
- %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Print Status',&mt('Class Print Status'),$number_of_files,'inline','80');
+ %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('',$number_of_files);
}
print "
";
my $num_files = @texfile; # How does this differ from $number_of_files , can that be 0?
@@ -289,14 +311,23 @@ foreach $texfile (@texfile) {
my $name;
my $name_range='';
- # $name -> Either user's full name or username@domain
- # $name_range -> Either user's last name or usrname.
+ # $name -> Either user's full name or username:domain
+ # $name_range -> Either user's last name or username.
if ($tempo_array[3]) {
$name=$tempo_array[3];
- ($name_range) = split(/,/,$name, 2);
+ $name =~ s{^\s+|\s+$}{}g;
+ if ($name =~ /,/) {
+ ($name_range) = split(/,/,$name, 2);
+ } elsif ($name =~ /\s/) {
+ $name_range = $name;
+ $name_range =~ s/\s+/_/;
+ } else {
+ $name_range = $name;
+ }
+ $name_range =~ s/[^\w\:\-]+//g;
} else {
- $name=$tempo_array[0].'@'.$tempo_array[1];
+ $name=$tempo_array[0].':'.$tempo_array[1];
$name_range = $tempo_array[0];
}
@@ -304,7 +335,7 @@ foreach $texfile (@texfile) {
# user is getting printed.
#
- if (($name ne "") && ($name ne '@') ) { # Could be printing codes...
+ if (($name ne "") && ($name ne ':') ) { # Could be printing codes...
$link_text=''.$name.'';
$status_statement.=$name;
}
@@ -317,13 +348,23 @@ foreach $texfile (@texfile) {
@tempo_array=split(/:/,$stud_info[-1]);
if ($tempo_array[3]) {
$name=$tempo_array[3];
- my ($lastname) = split(/,/, $name,2);
+ $name =~ s{^\s+|\s+$}{}g;
+ my $lastname;
+ if ($name =~ /,/) {
+ ($lastname) = split(/,/, $name,2);
+ } elsif ($name =~ /\s/) {
+ $lastname = $name;
+ $lastname =~ s/\s+/_/;
+ } else {
+ $lastname = $name;
+ }
$name_range .= "-".$lastname;
+ $name_range =~ s/[^\w\:\-]+//g;
} else {
- $name=$tempo_array[0].'@'.$tempo_array[1];
+ $name=$tempo_array[0].':'.$tempo_array[1];
$name_range .= '-'.$tempo_array[0];
}
- if (($name ne "") && ($name ne '@')) {
+ if (($name ne "") && ($name ne ':')) {
$link_text.=' - '.$name.'';
$status_statement.=' - '.$name;
@@ -353,7 +394,7 @@ foreach $texfile (@texfile) {
print "
";
if ($advanced_role) {
- &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,'Creating PDF for '.$status_statement);
+ &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt('Creating PDF for: [_1]',$status_statement));
}
if (-e $texfile) { # Ensure the tex file exists:
@@ -400,10 +441,16 @@ foreach $texfile (@texfile) {
$name_file =~ s/\.tex/\.dvi/;
my $new_name_file = $name_file;
$new_name_file =~ s/\.dvi/\.ps/;
+# Explicitly include a switch for papertype, otherwise dvips will default
+# to whatever is listed first in config.ps (which in most cases is a4).
+# Historically (since 2004) LON-CAPA printing expected to use the default,
+# i.e., a papertype of a4, when the user selected letter [8 1/2 x 11 in]
+# in the Layout options, so I follow that convention if $papera is letter.
my $papera=$paper;
- if ($papera eq 'letter') {$papera='';}
+ if ($papera eq 'letter') {$papera='a4';}
if ($papera ne '') {$papera='-t'.$papera;}
- my $comma = "dvips $papera -Ppdf -G0 -o $new_name_file";
+ my $extra_ps_header = $perlvar{'lonLib'} .'/includepsheader.ps';
+ my $comma = "dvips $papera -h $extra_ps_header -Ppdf -G0 -o $new_name_file";
&busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
"for $status_statement now Converting to PS",
\%prog_state,$new_name_file);
@@ -457,14 +504,41 @@ foreach $texfile (@texfile) {
my $ps_file = my $tempo_file = $1.'temporar.ps';
my $pdf_file = $1.'.pdf';
$papera=~s/t/p/;
+#----
+# The code below uses fixps to make pdf include in sequences work.
+#
+# $comma = "fixps --force $new_name_file";
+# &debug("FIXPS command: $comma");
+# &busy_wait_command("$comma 1>$tempo_file 2>/dev/null",
+# "for $status_statement now validating PS",
+# \%prog_state,$tempo_file);
+
+#---
+# The code below uses gs to make pdf includes in sequences work
+
+ # Use gs to fix the postscript -> level 1.5
+ # .. if pdfs were included
+
+ if ($pdfs_converted > 0) {
+ $comma = "gs -sDEVICE=pswrite -dLanguageLevel=1.5 ";
+ &busy_wait_command("$comma -o $tempo_file $new_name_file 2>/dev/null 1>/dev/null",
+ "for $status_statement now validating PS",
+ \%prog_state, $tempo_file);
+
+#---
+ &busy_wait_command("mv $tempo_file $new_name_file",
+ 'File move', \%prog_state, $new_name_file);
+ }
if ($laystyle eq 'album' and $numberofcolumns eq '2') {
$comma = "psnup $papera -2 -s1.0 $new_name_file";
+ &debug("PSNUP command: $comma");
&busy_wait_command("$comma $tempo_file 1>/dev/null 2>/dev/null",
"for $status_statement now Modifying PS layout",
\%prog_state,$tempo_file);
} elsif ($laystyle eq 'book' and $numberofcolumns eq '2') {
- $comma = 'pstops '.$papera.' "2:0+1(0.48w,0)"';
- &busy_wait_command("$comma $new_name_file $tempo_file 1>/dev/null 2>/dev/null",
+ $comma = 'pstops '.$papera.' "2:0+1(0.48w,0)" '.$new_name_file;
+ &debug("PSTOPS command: $comma ");
+ &busy_wait_command("$comma $tempo_file 1>/dev/null 2>/dev/null",
"for $status_statement now Modifying PS layout",
\%prog_state,$tempo_file);
} else {
@@ -491,7 +565,7 @@ foreach $texfile (@texfile) {
close(FFHS);
$ps_file=$new_ps_file;
}
- &busy_wait_command("ps2pdf $ps_file $pdf_file 1>/dev/null 2>/dev/null",
+ &busy_wait_command("ps2pdf13 $ps_file $pdf_file 1>/dev/null 2>/dev/null",
"for $status_statement now Converting PS to PDF",
\%prog_state,$pdf_file);
@@ -506,14 +580,21 @@ foreach $texfile (@texfile) {
my @garb = ($texlog,$texaux,$texdvi,$texps);
# unlink @garb;
unlink($duefile);
- print "$link_text - click here to download pdf";
- print "\n";
+ print
+ ''
+ .&mt('[_1] - [_2]Your PDF file[_3] is ready for download.',
+ $link_text,'','')
+ .'
'."\n";
}
unlink($missfonts_file);
}
} else {
- print "LaTeX file $texfile was not created successfully";
+ print
+ ''
+ .&mt('The LaTeX file [_1] was not created successfully.',
+ ''.$texfile.'')
+ .'
';
}
}
print "
";
@@ -525,11 +606,15 @@ if ($number_of_files>1) {
$file=~s/\.tex/.\pdf/;
$statement.=' '.$file;
}
- print("Zip Output:\n");
+ print(''.&mt('Zip Output:')."\n
\n");
system($statement);
- print("
");
+ print("
\n");
$zipfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
- print "
A ZIP file of all the PDFs.";
+ print
+ ''
+ .&mt('A [_1]ZIP file[_2] of all the PDF files is ready for download.',
+ '','')
+ .'
';
}
if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); }
print(&Apache::loncommon::end_page());
@@ -567,7 +652,7 @@ sub busy_wait_command {
if ($size == $last_size) {
$unchanged_time++;
if ($timeout && ($unchanged_time > $timeout)) {
- print "Operation timed out!
\n";
+ print ''.&mt('Operation timed out!')."
\n";
print "Executing $command, the output file $output_file did not grow\n";
print "after $timeout seconds. This may indicate $command\n";
print "is in an infinite loop.\n";
@@ -582,8 +667,7 @@ sub busy_wait_command {
}
}
if ($advanced_role) {
- &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,
- $message.$extra_msg);
+ &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,$message.$extra_msg);
}
}
$SIG{CHLD}='IGNORE';
@@ -680,8 +764,7 @@ sub repaginate {
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));
+ &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Counting pages for student: [_1]",1));
while ($line = ) {
@@ -709,8 +792,7 @@ sub repaginate {
# - 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)));
+ &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;
}
@@ -722,8 +804,7 @@ sub repaginate {
}
# 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)));
+ &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;
}
@@ -750,8 +831,7 @@ sub repaginate {
my $student_number = 0; # Index of student we're working on.
- &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,
- "Repaginating student ".$student_number+1);
+ &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Repaginating student: [_1]",$student_number+1));
while (my $line = ) {
if ($line eq "\\special{ps:ENDOFSTUDENTSTAMP}\n") {
@@ -768,8 +848,7 @@ sub repaginate {
}
$student_number++;
- &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,
- "Repaginating student ".$student_number+1);
+ &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Repaginating student: [_1]",$student_number+1));
} else {
print LATEXOUT $line;
@@ -845,12 +924,13 @@ sub create_missing_fonts {
#
sub convert_figure {
my ($not_eps) = @_;
+ &debug("in convert_figure");
my $status_statement='EPS picture for '.$not_eps;
my $eps_f = $not_eps;
- if ($eps_f=~/\/home\/([^\/]+)\/public_html\//) {
- $eps_f=~s/\/home\/([^\/]+)\/public_html/$1/;
+ if ($eps_f=~/\/home\/httpd\/html\/priv\/[^\/]+\/([^\/]+)\//) {
+ $eps_f=~s/\/home\/httpd\/html\/priv\/[^\/]+\/([^\/]+)/$1/;
} elsif ($eps_f=~/$perlvar{'lonDocRoot'}\/res\//) {
$eps_f=~ s/$perlvar{'lonDocRoot'}\/res\/(.+)/$1/;
} elsif ($eps_f=~/$perlvar{'lonUsersDir'}\//) {
@@ -861,7 +941,7 @@ sub convert_figure {
# Spaces are problematic for system commands and LaTeX, replace with _
- $eps_f =~ s/ /\_/g;
+ $eps_f =~ s/ /\_/g;
#
# If the file is already an .eps or .ps file (eps_f still has the original
@@ -881,14 +961,49 @@ sub convert_figure {
$not_eps =~ s/^\s+//;
$not_eps =~ s/\s+$//;
$not_eps =~ s/ /\\ /g;
+ my $prettyname=$not_eps;
if ($advanced_role) {
- my $prettyname=$not_eps;
- $prettyname=~s|/home/([^/]+)/public_html|/priv/$1|;
$prettyname=~s|$perlvar{'lonDocRoot'}/|/|;
- &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,
- 'Converting to EPS '.$prettyname);
+ &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt('Converting to EPS: [_1]',$prettyname));
+ }
+ #
+ # If the file is a PDF, need to use pdftops to convert it to a ps file.
+ # otherwise use imagemagik:
+ #
+ if($not_eps =~/\.(pdf|PDF)$/) {
+
+ #
+ # For whatever reason, pure postscript conversions have to be
+ # in the same dir as the base file:
+ #
+ $eps_f = &basename($eps_f);
+ $eps_f = $perlvar{'lonPrtDir'}.'/'.$eps_f;
+
+ &debug("Converting pdf $not_eps to postscript: $eps_f");
+ my @args = ('pdftops',$not_eps,$eps_f);
+ system({$args[0]} @args); # Indirect object forces list processing mode.
+ # See perlfunc documentation for exec().
+ if ($? and $advanced_role) {
+ print ''
+ .&mt('An error occurred during the conversion of [_1] to postscript.',
+ ''.$prettyname.'')
+ .'
';
+ } else {
+ $pdfs_converted++; # Need to fix ps in last pass.
+ }
+ } else {
+ my @args = ('convert',$not_eps,$eps_f);
+ system({$args[0]} @args); # Indirect object forces list processing mode.
+ # See perlfunc documentation for exec().
+ if ($? and $advanced_role) {
+ print ''
+ .&mt('An error occurred during the conversion of [_1].',
+ ''.$prettyname.'')
+ .'
'
+ .&mt('If possible try to save this image using different settings and republish it.')
+ .'
';
+ }
}
- system("convert $not_eps $eps_f");
if (not -e $eps_f) {
# converting an animated gif creates either:
@@ -972,10 +1087,10 @@ sub analyze_logfile {
if ($advanced_role) {
#LaTeX failed to parse tex file
- print "".&mt('LaTeX could not successfully parse your tex file.')."
";
+ print "".&mt('LaTeX could not successfully parse your TeX file.')."
";
print &mt('It probably has errors in it.')."
";
if ($badtext) {
- print &mt('With very high probability this error occured in [_1].',$badtext)
+ print &mt('With very high probability this error occurred in [_1].',$badtext)
."
";
}
print &mt('Here are the error messages in the LaTeX log file:')
@@ -1025,13 +1140,15 @@ sub analyze_logfile {
# $name_file - is the name of the LaTeX file.
# $identifier - is the unique LaTeX identifier.l
- print "
";
+ print '';
if ($badtext) {
print &mt('There are errors in [_1].',$badtext);
} else {
print &mt('There are errors.');
}
- print "
".&mt('These errors prevent this resource from printing correctly.');
+ print '
'
+ .&mt('These errors prevent this resource from printing correctly.');
+
my $tex_handle = IO::File->new($texfile);
my @tex_contents = <$tex_handle>;
&send_error_mail($identifier, $badresource, $body_log_file, \@tex_contents);
@@ -1062,7 +1179,7 @@ sub analyze_logfile {
my $whereitends = index $body_log_file,'STAMPOFPASSEDRESOURCEEND',$whereitbegins;
print "
"
.&mt('It has found an error in [_1][_2]and corrected it.',substr($body_log_file,$whereitbegins+26,$whereitends-$whereitbegins-26),"
")."\n";
- 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";
+ print &mt('Usually this correction is valid but you probably need to check the indicated resource one more time and implement necessary corrections by yourself.')."\n";
$whereitbegins = index $body_log_file,'',$tempobegin+10;
}