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