--- loncom/interface/printout.pl 2005/03/23 22:37:46 1.75 +++ loncom/interface/printout.pl 2006/06/12 11:21:07 1.100 @@ -1,7 +1,6 @@ #!/usr/bin/perl # CGI-script to run LaTeX, dvips, ps2ps, ps2pdf etc. # -# $Id: printout.pl,v 1.75 2005/03/23 22:37:46 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,18 +26,126 @@ # 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::loncommon; +use Apache::lonhtmlcommon(); +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 "
-------------------
"; + foreach my $key (sort (keys %env)) { + print "
$key -> $env{$key}"; + } + print "
-------------------
"; +} + +# +# 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.
"; + + # 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 "
sending...section: $env{'request.course.sec'}"; + foreach my $dest (keys %receivers) { + # print "
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 <Return to last resource.

"; my $figfile = $texfile; $figfile =~ s/^([^\.]+printout)[^t]+\.tex/$1\.dat/; @@ -94,7 +198,8 @@ 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('
'); foreach my $not_eps (@content_of_file) { chomp($not_eps); if ($not_eps ne '') { @@ -103,7 +208,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; @@ -123,7 +229,7 @@ END $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'}/|/|; @@ -132,18 +238,39 @@ END $done_conversion{$not_eps}=1; # print "Converting $not_eps -> $eps_f"; # Debugging system("convert $not_eps $eps_f"); - #check is eps exist in prtspool - if(not -e $eps_f) { + # check is eps exist in prtspool + if (not -e $eps_f) { + # converting an animated gif creates either: + # anim.gif.eps.0 + # or + # anim.gif-0.eps for (my $i=0;$i<10000;$i++) { if (-e $eps_f.'.'.$i) { - rename $eps_f.'.'.$i, $eps_f; + rename($eps_f.'.'.$i, $eps_f); + last; + } + my $anim_eps = $eps_f; + $anim_eps =~ s/(\.[^.]*)\.eps$/$1-$i\.eps/i; + if (-e $anim_eps) { + rename($anim_eps, $eps_f); last; } } - } + } + # imagemagick 6.2.0-6.2.7 fails to properly handle + # convert anim.gif anim.gif.eps + # it creates anim.eps instead. + if (not -e $eps_f) { + my $eps_f2 = $eps_f; + $eps_f2 =~ s/\.[^.]*\.eps$/\.eps/i; + if(-e $eps_f2) { + rename($eps_f2,$eps_f); + } + } + } } - if ($adv) { + if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); } unlink($figfile); @@ -154,16 +281,17 @@ 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; } } my $ind=-1; my %prog_state; -print "Return to last resource.

"; -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 "
"; +my $num_files = @texfile; foreach $texfile (@texfile) { my $status_statement=''; my $link_text='download PDF'; @@ -171,36 +299,65 @@ 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=''.$name.''; + $status_statement.=$name; } - $link_text=''.$name.''; - $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.=' - '.$name.''; - $status_statement.=' - '.$name; - } - if ($adv) { &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,'Creating PDF for '.$status_statement); } + if (($name ne "") && ($name ne '@')) { + $link_text.=' - '.$name.''; + $status_statement.=' - '.$name; + + } + } + if(($num_files > 1) && ($link_text eq 'download PDF')) { # Printing codes + $link_text = ''.basename($texfile,'.tex').'.pdf'; + $status_statement .= basename($texfile); + } + $name_range =~ s/'//g; # O'Neil -> ONeil e.g. + print "
"; + 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); if ($tableofcontents eq 'yes') { &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null", - "for $status_statement now LaTeXing file for table of contents", + "for $status_statement First LaTeX of file for table of contents", + \%prog_state,$dvi_file); + &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null", + "for $status_statement Second LaTeX of file for table of contents", \%prog_state,$dvi_file); } #to create table of contents my $idxname=$name_file; @@ -223,29 +380,42 @@ foreach $texfile (@texfile) { $temporary_file = IO::File->new('>'.$logfilename); print $temporary_file 'LOGFILE
'.$body_log_file.'
'."\n"; if ($body_log_file=~m/!\s+Emergency stop/) { - #LaTeX failed to parse tex file - print "

LaTeX could not successfully parse your tex file.

"; - print "It probably has errors in it.
"; 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)."

"; - } - 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/^!/) {
-		  $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 "
failing resourcename: $badresource
"; + } } - print "
\n"; + if ($advanced_role) { + #LaTeX failed to parse tex file + print "

LaTeX could not successfully parse your tex file.

"; + print "It probably has errors in it.
"; + print "With very high probability this error occured in ".$badtext."

"; + 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/^!/) {
+		      $sygnal = 1;
+		  } 
+		  if ($content_of_file[$i]=~m/Here is how much of/) {
+		      $sygnal = 0;
+		  } 
+		  if ($sygnal) {
+		      print "$content_of_file[$i]";
+		  }  
+	      }
+	      print "
\n"; + # print "
Advanced role
"; print "The link to "; $logfilename=~s/\/home\/httpd//; print "Your log file "; @@ -263,6 +433,24 @@ foreach $texfile (@texfile) { $texfile=~s/\/home\/httpd//; 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"; + 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
"; + my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", "Help on printing"); + print ("$help_text"); + } } elsif ($body_log_file=~m//) { @@ -287,12 +475,16 @@ foreach $texfile (@texfile) { "for $status_statement now Converting to PS", \%prog_state,$new_name_file); if (-e $new_name_file) { + &repaginate_postscript($new_name_file); print "

PDF output file (see link below)

\n"; $new_name_file =~ m/^(.*)\./; 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); @@ -358,17 +550,18 @@ foreach $texfile (@texfile) { "for $status_statement now Converting to PS", \%prog_state,$new_name_file); if (-e $new_name_file) { + &repaginate_postscript($new_name_file); print "
"; $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", @@ -435,8 +628,8 @@ if ($number_of_files>1) { $zipfile=~s/\/home\/httpd//; 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; @@ -448,7 +641,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) { @@ -458,7 +651,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); } @@ -468,5 +661,127 @@ sub busy_wait_command { } +# Repagninate a postscript file. +# What we need to do: +# - Count the number of pages in each student. +# - Add pages between each student so that each student's output is +# the maximum number of pages. +# +sub repaginate_postscript { + + # 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) = @_; + 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 $student_number = 0; # Index of student we're working on. + my @pages_in_student; # For each student his/her initial page count. + my $max_pages = 0; # Pages in 'longest' student. + while ($line = ) { + my $page_number = 0; + + # 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:") { + my @pageinfo = split(/ /, $line); + if ($page_number < $pageinfo[1]) { + $page_number = $pageinfo[1]; + } + } + # ENDOFSTUDENTSTAMP - save the page_number, reset and, if necessary + # udpate max_pages. + # + if ($line =~ "ENDOFSTUDENTSTAMP") { + $pages_in_student[$student_number] = $page_number; + $student_number++; + + if ($page_number > $max_pages) { + $max_pages = $page_number; + } + $page_number = 0; + + } + + + } + close(PSFILE); + + # Figure out how many total pages we need to add and adjust the + # $total_pages accordingly: + # + my $add_pages = 0; + for (my $i =0; $i < $student_number; $i++) { + $add_pages += ($max_pages - $pages_in_student[$i]); + } + # If we don't need to add any pages, we're done! + # You might think that we don't need to do anything if + # there are no pages to add, however we still need to at least strip out + # the ENDOFSTUDENTSTAMP stamps...as they are not postscript comments!! + + + # Now pass 2; we're going to write the new. ps file: + # - Modify its first %%Pages: line so that it has the new correct number of + # pages + # - For each student, insert as many blank pages as needed (and + # associated structured comments) to expand a student out to + # max_pages pages. + # - Remove the ENDOFSTUDENTSTAMP lines. + # + + $total_pages += $add_pages; + $student_number = 0; + + open(PSFILE, "<$postscript_filename"); + open(PSOFILE,">$postscript_filename"."repaginating"); # unique if original fname is. + $seen_pages = 0; # Reset seen %%Pages flag... + while ($line = ) { + if (($line =~ "^%%Pages:") && (!$seen_pages)) { + $line = "%%Pages: $total_pages\n"; + $seen_pages = 1; + } + if ($line =~ "ENDOFSTUDENTSTAMP") { + $add_pages = ($max_pages - $pages_in_student[$student_number]); + $line = "\n"; + my $last_student_page = $pages_in_student[$student_number]; + my $last_total_page = $student_number*$max_pages + $last_student_page; + while ($add_pages) { + $line .= "%Page: $last_student_page $last_total_page\n"; + my $bop = $last_total_page-1; + $line .= "TeXDict begin $last_student_page $bop bop eop end\n"; + $last_student_page++; + $last_total_page++; + $add_pages--; + } + $student_number++; + } + print PSOFILE $line; + } + close PSOFILE; + close PSFILE; + + rename($postscript_filename."repaginating", $postscript_filename); +}