--- loncom/interface/printout.pl 2005/03/14 23:51:20 1.73
+++ loncom/interface/printout.pl 2005/11/15 20:53:06 1.93
@@ -1,7 +1,6 @@
#!/usr/bin/perl
# CGI-script to run LaTeX, dvips, ps2ps, ps2pdf etc.
#
-# $Id: printout.pl,v 1.73 2005/03/14 23:51:20 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,19 +25,130 @@
# http://www.lon-capa.org/
#
+BEGIN {
+ eval "use Apache2::compat();";
+};
use lib '/home/httpd/lib/perl';
-use LONCAPA::loncgi();
+use LONCAPA::loncgi;
use File::Path;
+use File::Basename;
use IO::File;
use Image::Magick;
use Apache::lonhtmlcommon;
-use Apache::lonnet();
+use Apache::lonnet;
use Apache::loncommon;
use Apache::lonlocal;
+use Apache::lonmsg;
+use LONCAPA::Enrollment;
use strict;
+
+
+# Determine if a user is operating as a student for this course/domain.
+#Parameters:
+# none
+#Implicit:
+# $env{request.role} contains the role under which this user operated this
+# this request.
+sub is_student {
+ return ($env{'request.role'}=~/^st\./);
+}
+
+#
+# Debugging: Dump the environment for debugging.
+#
+sub dumpenv {
+ print "<br />-------------------<br />";
+ foreach my $key (sort (keys %env)) {
+ print "<br />$key -> $env{$key}";
+ }
+ print "<br />-------------------<br />";
+}
+
+#
+# This sub sends a message to the appropriate person if there was an error
+# rendering the latex At present, there's only one case to consider:
+# a student printing inside a course results in messages to the course coordinator.
+#Parmaeters:
+# identifier - The unique identifier of this cgi request.
+# badresource- Filepath to most likely failing
+# logfile - The contents of the log file (included in the message).
+# texfile - reference to an array containing the LaTeX input file
+# (included in the message).
+#Implicit inputs:
+# From the environment:
+# cgi.$identifier.user - User doing the printing.
+# cgi.$identifier.domain - Domain the user is logged in on with printing.
+# cgi.$identifier.courseid - Id of the course (if this is a course).
+# cgi.$identifier.coursedom- Domain in which course was constituted.
+# cgi.$identifier.resources - List of resource URL's for which the print
+# was attempted.
+#
+sub send_error_mail {
+ my ($identifier, $badresource, $logfile, $texfile) = @_;
+ my $user = $env{"cgi.$identifier.user"};
+ my $domain = $env{"cgi.$identifier.domain"};
+ my $courseid = $env{"cgi.$identifier.courseid"};
+ my $coursedom= $env{"cgi.$identifier.coursedom"};
+ my $resources= $env{"cgi.$identifier.resources"};
+
+ # resource file->URL
+ #
+ my $badurl = &Apache::lonnet::declutter($badresource);
+
+ # &dumpenv();
+
+
+
+ # Only continue if there is a user, domain, courseid, course domain
+ # and resources:
+
+ if(defined($user) && defined($domain) && defined($courseid) &&
+ defined($coursedom) && defined($resources) ){
+
+ # Only mail if the conditions are ripe for it:
+ # The user is a student in the course:
+ #
+
+ if (&is_student()) {
+ # build the subject and message body:
+ # print "sending message to course coordinators.<br />";
+
+ # 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";
+ foreach my $resource (split(/:/,$resources)) {
+ $message .= " $resource\n";
+ }
+ $message .= "--------------------LaTeX logfile:------------ \n";
+ $message .= $logfile;
+ $message .= "-----------------LaTeX source file: ------------\n";
+
+ foreach my $line (@$texfile) {
+ $message .= "$line\n";
+ }
+ my (undef, %receivers) = &Apache::lonfeedback::decide_receiver(undef, 0,
+ 1,1,1);
+ # print "<br /> sending...section: $env{'request.course.sec'}";
+ foreach my $dest (keys %receivers) {
+ # print "<br /> dest is $dest";
+ my @destinfo = split(/:/,$dest);
+ my $user = $destinfo[0];
+ my $dom = $destinfo[1];
+
+ &Apache::lonmsg::user_normal_msg($user, $dom,
+ $subject, $message);
+
+ # No point in looking at the return status as there's no good
+ # error action I can think of right now (log maybe?).
+ }
+ }
+ }
+}
+
$|=1;
-my %origENV=%ENV;
if (! &LONCAPA::loncgi::check_cookie_and_load_env()) {
print <<END;
Content-type: text/html
@@ -58,27 +168,23 @@ END
print $bodytag;
my $identifier = $ENV{'QUERY_STRING'};
- my $texfile = $ENV{'cgi.'.$identifier.'.file'};
- my $laystyle = $ENV{'cgi.'.$identifier.'.layout'};
- my $numberofcolumns = $ENV{'cgi.'.$identifier.'.numcol'};
- my $paper = $ENV{'cgi.'.$identifier.'.paper'};
- my $selectionmade = $ENV{'cgi.'.$identifier.'.selection'};
- my $tableofcontents = $ENV{'cgi.'.$identifier.'tableofcontents'};
- my $tableofindex = $ENV{'cgi.'.$identifier.'tableofindex'};
- my $advans_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 $texfile = $env{'cgi.'.$identifier.'.file'};
+ my $laystyle = $env{'cgi.'.$identifier.'.layout'};
+ my $numberofcolumns = $env{'cgi.'.$identifier.'.numcol'};
+ my $paper = $env{'cgi.'.$identifier.'.paper'};
+ my $selectionmade = $env{'cgi.'.$identifier.'.selection'};
+ my $tableofcontents = $env{'cgi.'.$identifier.'.tableofcontents'};
+ my $tableofindex = $env{'cgi.'.$identifier.'.tableofindex'};
+ 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 $adv = $ENV{'request.role.adv'};
my @names_pack=();
if ($student_names=~/_END_/) {
@names_pack=split(/_ENDPERSON_/,$student_names);
}
- #got what we needed reset ENV in case it is to big for system
- %ENV=%origENV;
my $figfile = $texfile;
$figfile =~ s/^([^\.]+printout)[^t]+\.tex/$1\.dat/;
@@ -94,7 +200,7 @@ 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'); }
foreach my $not_eps (@content_of_file) {
chomp($not_eps);
if ($not_eps ne '') {
@@ -103,7 +209,8 @@ END
# print "$status_statement\n";
$not_eps=~s|\/\.\/|\/|g;
my $eps_f = $not_eps;
- $eps_f =~ s/\.[^.]*$/\.eps/i;
+ # $eps_f =~ s/\.[^.]*$/\.eps/i;
+ $eps_f .= '.eps'; # Just append the eps ext.
if ($eps_f=~/\/home\/([^\/]+)\/public_html\//) {
$eps_f=~s/\/home\/([^\/]+)\/public_html/$1/;
$eps_f = '/home/httpd/prtspool/'.$eps_f;
@@ -114,14 +221,16 @@ END
$eps_f=~/$Apache::lonnet::perlvar{'lonUsersDir'}\/([^\/]+)\/\w\/\w\/\w\/(.+)/;
$eps_f = '/home/httpd/prtspool/'.$1.'/'.$2;
}
+ $eps_f =~ s/ /\_/g; # Spaces are problematic for system commands and LaTeX.
my $path=$eps_f;
- $path=~s/\/([^\/]+)\.eps$//;
+ $path =~ s/\/([^\/]+)\.eps$//;
# print "Final file path: $path "; # Debugging
File::Path::mkpath($path,0,0777);
$not_eps =~ s/^\s+//;
$not_eps =~ s/\s+$//;
+ $not_eps =~ s/ /\\ /g;
if ( exists($done_conversion{$not_eps})) { next; }
- if ($adv) {
+ if ($advanced_role) {
my $prettyname=$not_eps;
$prettyname=~s|/home/([^/]+)/public_html|/priv/$1|;
$prettyname=~s|$Apache::lonnet::perlvar{'lonDocRoot'}/|/|;
@@ -141,7 +250,9 @@ END
}
}
}
- if ($adv) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); }
+ if ($advanced_role) {
+ &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state);
+ }
unlink($figfile);
}
#print "$texfile\n"; #name of the tex file for debugging only
@@ -150,7 +261,8 @@ END
@texfile=();
for (my $i=1;$i<=$number_of_files;$i++) {
my $new_texfile=$texfile;
- $new_texfile=~s/\.tex/_$i\.tex/;
+ $new_texfile=~s/\.tex//;
+ $new_texfile = sprintf("%s_%03d.tex", $new_texfile,$i);
push @texfile,$new_texfile;
}
}
@@ -158,8 +270,9 @@ END
my $ind=-1;
my %prog_state;
print "<a href=\"$backref\"><b>Return</b></a> to last resource.<br /><br />";
-if ($adv) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Print Status','Class Print Status',$number_of_files,'inline','80'); }
+if ($advanced_role) { %prog_state=&Apache::lonhtmlcommon::Create_PrgWin('','Print Status','Class Print Status',$number_of_files,'inline','80'); }
print "<br />";
+my $num_files = @texfile;
foreach $texfile (@texfile) {
my $status_statement='';
my $link_text='download PDF';
@@ -167,30 +280,56 @@ foreach $texfile (@texfile) {
my @stud_info=split(/_END_/,$names_pack[$ind]);
my @tempo_array=split(/:/,$stud_info[0]);
my $name;
+ my $name_range='';
if ($tempo_array[3]) {
$name=$tempo_array[3];
+ ($name_range) = split(/,/,$name, 2);
} else {
$name=$tempo_array[0].'@'.$tempo_array[1];
+ $name_range = $tempo_array[0];
+ }
+ if (($name ne "") && ($name ne '@') ) { # Could be printing codes...
+ $link_text='<b>'.$name.'</b>';
+ $status_statement.=$name;
}
- $link_text='<b>'.$name.'</b>';
- $status_statement.=$name;
if ($#stud_info>0) {
@tempo_array=split(/:/,$stud_info[-1]);
if ($tempo_array[3]) {
$name=$tempo_array[3];
+ my ($lastname) = split(/,/, $name,2);
+ $name_range .= "-".$lastname;
} else {
$name=$tempo_array[0].'@'.$tempo_array[1];
+ $name_range .= '-'.$tempo_array[0];
}
- $link_text.=' - <b>'.$name.'</b>';
- $status_statement.=' - '.$name;
- }
- if ($adv) { &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,'Creating PDF for '.$status_statement); }
+ if (($name ne "") && ($name ne '@')) {
+ $link_text.=' - <b>'.$name.'</b>';
+ $status_statement.=' - '.$name;
+
+ }
+ }
+ if(($num_files > 1) && ($link_text eq 'download PDF')) { # Printing codes
+ $link_text = '<b>'.basename($texfile,'.tex').'.pdf</b>';
+ $status_statement .= basename($texfile);
+ }
+ $name_range =~ s/'//g; # O'Neil -> ONeil e.g.
+ print "<br/>";
+ if ($advanced_role) { &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,'Creating PDF for '.$status_statement); }
+ # This little piece of dirt puts username ranges into the original tex
+ # Tex filename from which they'll propagate into the other filenames as well.
+ #
if (-e $texfile) {
+ if (($name_range ne '') && ($num_files > 1)) {
+ my $newtexfile = $texfile;
+ $newtexfile =~ s/\.tex/$name_range\.tex/;
+ rename($texfile, $newtexfile);
+ $texfile = $newtexfile;
+ }
$texfile =~ m/^(.*)\/([^\/]+)$/;
my $name_file = $2;
my $path_file = $1.'/';
chdir $path_file;
- my $dvi_file= $name_file; $dvi_file =~ s/\.tex/\.dvi/;
+ my $dvi_file= $name_file; $dvi_file =~ s/\.tex/$name_range\.dvi/;
&busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
"for $status_statement now LaTeXing file",
\%prog_state,$dvi_file);
@@ -219,29 +358,42 @@ foreach $texfile (@texfile) {
$temporary_file = IO::File->new('>'.$logfilename);
print $temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_log_file.'</pre></body></html>'."\n";
if ($body_log_file=~m/!\s+Emergency stop/) {
- #LaTeX failed to parse tex file
- print "<h2>LaTeX could not successfully parse your tex file.</h2>";
- print "It probably has errors in it.<br />";
my $whereitbegins = rindex $body_log_file,'STAMPOFPASSEDRESOURCESTART';
my $whereitends = rindex $body_log_file,'STAMPOFPASSEDRESOURCEEND';
+ my $badresource;
+ my $badtext;
if ($whereitbegins!=-1 and $whereitends!=-1) {
- print "With very high probability this error occured in ".substr($body_log_file,$whereitbegins+26,$whereitends-$whereitbegins-26)."<br /><br />";
- }
- print "Here are the error messages in the LaTeX log file</br><br /><pre>";
- 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/^!/) {
- $sygnal = 1;
- }
- if ($content_of_file[$i]=~m/Here is how much of/) {
- $sygnal = 0;
- }
- if ($sygnal) {
- print "$content_of_file[$i]";
- }
+ $badtext = substr($body_log_file,$whereitbegins+26, $whereitends-$whereitbegins-26);
+ $whereitbegins = rindex $badtext,'located in';
+ if ($whereitbegins != -1) {
+
+ $badresource = substr($badtext, $whereitbegins+27,
+ length($badtext) - $whereitbegins - 48);
+ # print "<br />failing resourcename: $badresource<br />";
+ }
}
- print "</pre>\n";
- if ($advans_role) {
+
+ if ($advanced_role) {
+ #LaTeX failed to parse tex file
+ print "<h2>LaTeX could not successfully parse your tex file.</h2>";
+ print "It probably has errors in it.<br />";
+ print "With very high probability this error occured in ".$badtext."<br /><br />";
+ print "Here are the error messages in the LaTeX log file<br /><pre>";
+
+ 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/^!/) {
+ $sygnal = 1;
+ }
+ if ($content_of_file[$i]=~m/Here is how much of/) {
+ $sygnal = 0;
+ }
+ if ($sygnal) {
+ print "$content_of_file[$i]";
+ }
+ }
+ print "</pre>\n";
+ # print "<br /> Advanced role <br />";
print "<b><big>The link to ";
$logfilename=~s/\/home\/httpd//;
print "<a href=\"$logfilename\">Your log file </a></big></b>";
@@ -259,6 +411,24 @@ foreach $texfile (@texfile) {
$texfile=~s/\/home\/httpd//;
print "<a href=\"$texfile\">Your original LaTeX file </a></big></b>";
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 "<br />There are errors in $badtext";
+ print "<br />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 "<br />A message has been sent to the instructor describing this failure<br />";
+ my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", "Help on printing");
+ print ("$help_text");
+
}
} elsif ($body_log_file=~m/<inserted text>/) {
@@ -288,7 +458,10 @@ foreach $texfile (@texfile) {
my $ps_file = my $tempo_file = $1.'temporar.ps';
my $pdf_file = $1.'.pdf';
if ($laystyle eq 'album' and $numberofcolumns eq '2') {
- $comma = "psnup -2 -s1.0 $new_name_file";
+ my $papera=$paper;
+ if ($papera eq 'letter') {$papera='';}
+ if ($papera ne '') {$papera='-p'.$papera;}
+ $comma = "psnup $papera -2 -s1.0 $new_name_file";
&busy_wait_command("$comma $tempo_file 1>/dev/null 2>/dev/null",
"for $status_statement now Modifying PS layout",
\%prog_state,$tempo_file);
@@ -320,26 +493,26 @@ foreach $texfile (@texfile) {
# unlink @garb;
unlink $duefile;
print "<a href=\"/prtspool/$pdf_file\">Your PDF document</a>";
- if ($advans_role) {
- print "<br /><br />";
- print "<b><big>The link to ";
- $logfilename=~s/\/home\/httpd//;
- print "<a href=\"$logfilename\">Your log file </a></big></b>";
- print "\n";
- #link tooriginal LaTeX file (included according Michael Hamlin desire)
- my $tex_temporary_file=IO::File->new($texfile) || die "Couldn't open tex file $texfile for reading: $!\n";
- my @tex_content_of_file = <$tex_temporary_file>;
- close $tex_temporary_file;
- my $body_tex_file = join(' ',@tex_content_of_file);
- $texfile =~ s/\.tex$/aaaaa\.html/;
- $tex_temporary_file = IO::File->new('>'.$texfile);
- print $tex_temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_tex_file.'</pre></body></html>'."\n";
- print "<br /><br />";
- print "<b><big>The link to ";
- $texfile=~s/\/home\/httpd//;
- print "<a href=\"$texfile\">Your original LaTeX file </a></big></b>";
- print "\n";
- }
+ }
+ if ($advanced_role) {
+ print "<br /><br />";
+ print "<b><big>The link to ";
+ $logfilename=~s/\/home\/httpd//;
+ print "<a href=\"$logfilename\">Your log file </a></big></b>";
+ print "\n";
+ #link tooriginal LaTeX file (included according Michael Hamlin desire)
+ my $tex_temporary_file=IO::File->new($texfile) || die "Couldn't open tex file $texfile for reading: $!\n";
+ my @tex_content_of_file = <$tex_temporary_file>;
+ close $tex_temporary_file;
+ my $body_tex_file = join(' ',@tex_content_of_file);
+ $texfile =~ s/\.tex$/aaaaa\.html/;
+ $tex_temporary_file = IO::File->new('>'.$texfile);
+ print $tex_temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_tex_file.'</pre></body></html>'."\n";
+ print "<br /><br />";
+ print "<b><big>The link to ";
+ $texfile=~s/\/home\/httpd//;
+ print "<a href=\"$texfile\">Your original LaTeX file </a></big></b>";
+ print "\n";
}
} else {
#LaTeX successfully parsed tex file
@@ -358,13 +531,13 @@ foreach $texfile (@texfile) {
$new_name_file =~ m/^(.*)\./;
my $ps_file = my $tempo_file = $1.'temporar.ps';
my $pdf_file = $1.'.pdf';
+ $papera=~s/t/p/;
if ($laystyle eq 'album' and $numberofcolumns eq '2') {
- $comma = "psnup -2 -s1.0 $new_name_file";
+ $comma = "psnup $papera -2 -s1.0 $new_name_file";
&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') {
- $papera=~s/t/p/;
$comma = 'pstops '.$papera.' "2:0+1(0.48w,0)"';
&busy_wait_command("$comma $new_name_file $tempo_file 1>/dev/null 2>/dev/null",
"for $status_statement now Modifying PS layout",
@@ -431,7 +604,7 @@ if ($number_of_files>1) {
$zipfile=~s/\/home\/httpd//;
print "<br /> A <a href=\"$zipfile\">ZIP file</a> of all the PDFs.";
}
-if ($adv) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); }
+if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); }
my $done;
sub REAPER {
@@ -444,7 +617,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) {
@@ -454,7 +627,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);
}