Annotation of loncom/interface/printout.pl, revision 1.171
1.1 sakharuk 1: #!/usr/bin/perl
1.37 albertel 2: # CGI-script to run LaTeX, dvips, ps2ps, ps2pdf etc.
3: #
1.171 ! raeburn 4: # $Id: printout.pl,v 1.170 2024/07/11 12:15:16 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).
450: # Historically (since 2004) LON-CAPA printing expected to use the default,
451: # i.e., a papertype of a4, when the user selected letter [8 1/2 x 11 in]
452: # in the Layout options, so I follow that convention if $papera is letter.
1.67 sakharuk 453: my $papera=$paper;
1.163 raeburn 454: if ($papera eq 'letter') {$papera='a4';}
1.62 sakharuk 455: if ($papera ne '') {$papera='-t'.$papera;}
1.139 foxr 456: my $extra_ps_header = $perlvar{'lonLib'} .'/includepsheader.ps';
457: my $comma = "dvips $papera -h $extra_ps_header -Ppdf -G0 -o $new_name_file";
1.59 albertel 458: &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
459: "for $status_statement now Converting to PS",
460: \%prog_state,$new_name_file);
1.115 foxr 461: #
462: # One last little hinky kinky thing.
463: # It's just possible that some fonts could not be maded
464: # at the resolution of the pdf print driver.
465: # In that case a file called missfont.log will have been
466: # created that will contain the commands that were attempted
467: # to create the missing fonts. If we basically
468: # take all the 8000 strings in that file, and
469: # replace them with 600 (the ljfour resolution)
470: # run the commands in that file and redvips,
471: # we'll be able to print the missing glyphs at 600dpi.
472: #
473: # Supposedly it is possible to tune TeX/Metafont to do this
474: # right but I failed to get that to work when following the
475: # docs at the tug site, hence this rather kludgey fix.
476: #
1.135 foxr 477:
1.115 foxr 478: my $print_directory = dirname($name_file);
479: my $missfonts_file = $print_directory."/missfont.log";
1.116 albertel 480: #print("<br /> Missing fonts file is: $missfonts_file");
1.115 foxr 481: if (-e $missfonts_file) {
1.116 albertel 482: #print("<br />Missing fonts file exists\n");
1.124 albertel 483: &create_missing_fonts($missfonts_file,\%prog_state);
1.118 albertel 484: &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
1.115 foxr 485: "for $status_statement dvips generated missing fonts",
486: \%prog_state, $new_name_file);
487: }
1.29 sakharuk 488: if (-e $new_name_file) {
1.102 foxr 489: my $latex_file = $name_file;
490: $latex_file =~ s/\.dvi/\.tex/;
491: &repaginate($new_name_file, $latex_file, $numberofcolumns);
1.135 foxr 492:
493: &make_dvi_file($latex_file,
494: $name_file,
495: $tableofcontents,
496: $tableofindex,
497: $status_statement,
498: \%prog_state,
499: $busy_wait_timeout);
500:
501:
1.102 foxr 502: &busy_wait_command("$comma $name_file 1>/dev/null 2>/dev/null",
503: "for $status_statement dvips to repaginate",
504: \%prog_state, $new_name_file);
1.115 foxr 505:
1.61 albertel 506: print "<br />";
1.29 sakharuk 507: $new_name_file =~ m/^(.*)\./;
1.59 albertel 508: my $ps_file = my $tempo_file = $1.'temporar.ps';
509: my $pdf_file = $1.'.pdf';
1.82 albertel 510: $papera=~s/t/p/;
1.148 foxr 511: #----
512: # The code below uses fixps to make pdf include in sequences work.
513: #
514: # $comma = "fixps --force $new_name_file";
515: # &debug("FIXPS command: $comma");
516: # &busy_wait_command("$comma 1>$tempo_file 2>/dev/null",
517: # "for $status_statement now validating PS",
518: # \%prog_state,$tempo_file);
519:
520: #---
521: # The code below uses gs to make pdf includes in sequences work
522:
523: # Use gs to fix the postscript -> level 1.5
1.149 foxr 524: # .. if pdfs were included
1.169 raeburn 525: #
526: # pswrite device was removed from ghostscript 9.09 and later,
527: # (ps2write device is used instead).
528: # check which device is available, and use as the value
529: # passed via -sDEVICE= arg in gs call to fix the postscript.
530: #
1.148 foxr 531:
1.149 foxr 532: if ($pdfs_converted > 0) {
1.169 raeburn 533: my @possdevices = qw(ps2write pswrite);
534: my $device;
535: foreach my $poss (@possdevices) {
536: if (open(PIPE,"gs -h |grep ' $poss ' 2>&1 |")) {
537: my $output = <PIPE>;
538: close(PIPE);
539: chomp($output);
540: if ($output =~ /\Q $poss \E/) {
541: $device = $poss;
542: }
543: }
544: last if ($device ne '');
545: }
546: if ($device ne '') {
1.171 ! raeburn 547: $comma = "gs -sDEVICE=$device -dLanguageLevel=1.5 --permit-file-read=* ";
1.169 raeburn 548: &busy_wait_command("$comma -o $tempo_file $new_name_file 2>/dev/null 1>/dev/null",
549: "for $status_statement now validating PS",
550: \%prog_state, $tempo_file);
551:
1.148 foxr 552: #---
1.169 raeburn 553: if (-e $tempo_file) {
554: &busy_wait_command("mv $tempo_file $new_name_file",
555: 'File move', \%prog_state, $new_name_file);
556: }
557: }
1.149 foxr 558: }
1.29 sakharuk 559: if ($laystyle eq 'album' and $numberofcolumns eq '2') {
1.144 raeburn 560: $comma = "psnup $papera -2 -s1.0 $new_name_file";
1.141 foxr 561: &debug("PSNUP command: $comma");
1.144 raeburn 562: &busy_wait_command("$comma $tempo_file 1>/dev/null 2>/dev/null",
1.59 albertel 563: "for $status_statement now Modifying PS layout",
564: \%prog_state,$tempo_file);
1.29 sakharuk 565: } elsif ($laystyle eq 'book' and $numberofcolumns eq '2') {
1.144 raeburn 566: $comma = 'pstops '.$papera.' "2:0+1(0.48w,0)" '.$new_name_file;
1.141 foxr 567: &debug("PSTOPS command: $comma ");
1.144 raeburn 568: &busy_wait_command("$comma $tempo_file 1>/dev/null 2>/dev/null",
1.59 albertel 569: "for $status_statement now Modifying PS layout",
570: \%prog_state,$tempo_file);
1.29 sakharuk 571: } else {
1.59 albertel 572: $ps_file=$new_name_file;
573: }
1.67 sakharuk 574: my $addtoPSfile={'legal'=>'<< /PageSize [612 1008] >> setpagedevice',
575: 'tabloid'=>'<< /PageSize [792 1224] >> setpagedevice',
576: 'executive'=>,'<< /PageSize [540 720] >> setpagedevice',
577: 'a2'=>'<< /PageSize [1195.02 1690.09] >> setpagedevice',
578: 'a3'=>'<< /PageSize [842 1195.02] >> setpagedevice',
579: 'a4'=>'<< /PageSize [595.2 842] >> setpagedevice',
580: 'a5'=>'<< /PageSize [421.1 595.2] >> setpagedevice',
581: 'a6'=>'<< /PageSize [298.75 421.1] >> setpagedevice',
582: };
583: if ($paper ne 'letter') {
1.69 matthew 584: open(FFH,'<',$ps_file) || die "Couldn't open ps file $ps_file for reading: $!\n";
1.63 sakharuk 585: my $new_ps_file='new'.$ps_file;
1.69 matthew 586: open(FFHS,'>',$new_ps_file) || die "Couldn't open new ps file $new_ps_file for reading: $!\n";
1.67 sakharuk 587: print FFHS $addtoPSfile->{$paper}."\n";
1.63 sakharuk 588: while (<FFH>) {
589: print FFHS $_;
590: }
1.62 sakharuk 591: close(FFH);
1.63 sakharuk 592: close(FFHS);
593: $ps_file=$new_ps_file;
1.62 sakharuk 594: }
1.141 foxr 595: &busy_wait_command("ps2pdf13 $ps_file $pdf_file 1>/dev/null 2>/dev/null",
1.59 albertel 596: "for $status_statement now Converting PS to PDF",
597: \%prog_state,$pdf_file);
598:
1.29 sakharuk 599: my $texlog = $texfile;
600: my $texaux = $texfile;
601: my $texdvi = $texfile;
602: my $texps = $texfile;
603: $texlog =~ s/\.tex/\.log/;
604: $texaux =~ s/\.tex/\.aux/;
605: $texdvi =~ s/\.tex/\.dvi/;
606: $texps =~ s/\.tex/\.ps/;
607: my @garb = ($texlog,$texaux,$texdvi,$texps);
1.22 sakharuk 608: # unlink @garb;
1.120 albertel 609: unlink($duefile);
1.153 bisitz 610: print
611: '<p>'
612: .&mt('[_1] - [_2]Your PDF file[_3] is ready for download.',
613: $link_text,'<a href="/prtspool/'.$pdf_file.'">','</a>')
614: .'</p>'."\n";
1.29 sakharuk 615: }
1.120 albertel 616: unlink($missfonts_file);
1.119 foxr 617:
1.63 sakharuk 618: }
1.29 sakharuk 619: } else {
1.153 bisitz 620: print
621: '<p class="LC_error">'
622: .&mt('The LaTeX file [_1] was not created successfully.',
623: '<span class="LC_filename">'.$texfile.'</span>')
624: .'</p>';
1.14 sakharuk 625: }
1.43 sakharuk 626: }
1.166 raeburn 627: if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%prog_state); }
1.45 sakharuk 628: print "<br />";
1.44 sakharuk 629: if ($number_of_files>1) {
1.166 raeburn 630: print('<p>'.&mt('Zip Output:')."\n");
631: my %zip_prog_state;
632: if ($advanced_role) { %zip_prog_state=&Apache::lonhtmlcommon::Create_PrgWin('',$number_of_files); }
1.45 sakharuk 633: my $zipfile=$texfile[0];
634: $zipfile=~s/\.tex/\.zip/;
1.166 raeburn 635: my $zip = Archive::Zip->new();
636: my $counter = 0;
1.44 sakharuk 637: foreach my $file (@texfile) {
1.166 raeburn 638: $file=~s/\.tex/.\pdf/;
639: my $dest=$file;
640: $dest=~s{^\Q$perlvar{'lonPrtDir'}\E}{prtspool};
641: $zip->addFile($file,$dest);
642: $dest=~s/^prtspool//;
643: $counter ++;
644: if ($advanced_role) {
645: &Apache::lonhtmlcommon::Update_PrgWin('',\%zip_prog_state,
646: &mt('[_1] added to zip archive ([_2] of [_3]',
647: $dest,$counter,$number_of_files));
648: }
649: }
650: if ($advanced_role) {
651: &Apache::lonhtmlcommon::Update_PrgWin('',\%zip_prog_state,&mt('Writing zip file'));
1.44 sakharuk 652: }
1.166 raeburn 653: if ($zip->writeToFileNamed($zipfile) == AZ_OK) {
654: $zipfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
655: print
656: '<p>'
657: .&mt('A [_1]ZIP file[_2] of all the PDF files is ready for download.',
658: '<a href="'.$zipfile.'">','</a>')
659: .'</p>';
660: } else {
661: print '<p class="LC_error">'.
662: &mt('An error occurred creating a ZIP file of all the PDF files').
663: '</p>';
664: }
665: if ($advanced_role) { &Apache::lonhtmlcommon::Close_PrgWin('',\%zip_prog_state); }
1.44 sakharuk 666: }
1.97 albertel 667: print(&Apache::loncommon::end_page());
1.59 albertel 668: my $done;
1.102 foxr 669:
1.59 albertel 670: sub REAPER {
671: $done=1;
672: }
1.129 foxr 673: #
674: # Execute a command updating the status window as the command's
675: # output file builds up (at intervals of a second).
676: #
677: # If the timeout argument defined, then if that many seconds
678: # elapses without an increase in the size of the output file,
679: # the command will be killed (this deals with the case when
680: # latex crawls into an infinite loop).
681: #
1.59 albertel 682: sub busy_wait_command {
1.129 foxr 683: my ($command,$message,$progress_win,$output_file, $timeout)=@_;
1.59 albertel 684:
685: $SIG{CHLD} = \&REAPER;
686: $done=0;
687: my $pid=open(CMD,"$command |");
1.92 albertel 688: if ($advanced_role) {
1.60 albertel 689: &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,$message);
690: }
1.129 foxr 691: my $last_size = 0;
692: my $unchanged_time = 0;
1.59 albertel 693: while(!$done) {
694: sleep 1;
695: my $extra_msg;
696: if ($output_file) {
697: my $size=(stat($output_file))[7];
698: $extra_msg=", $size bytes generated";
1.129 foxr 699: if ($size == $last_size) {
700: $unchanged_time++;
701: if ($timeout && ($unchanged_time > $timeout)) {
1.152 golterma 702: print '<p class="LC_error">'.&mt('Operation timed out!')."</p>\n";
1.131 www 703: print "<p>Executing $command, the output file $output_file did not grow\n";
1.130 foxr 704: print "after $timeout seconds. This <em>may</em> indicate $command\n";
1.131 www 705: print "is in an infinite loop.\n";
706: print "See if printing fewer copies helps. Please contact LON-CAPA\n";
707: print "support about this in any event.";
1.130 foxr 708: print "</p>";
1.129 foxr 709: kill(9, $pid); # Reaper will do the rest...I hope there's errors in the log.
710: }
711: } else {
712: $last_size = $size;
713: $unchanged_time = 0;
714: }
1.59 albertel 715: }
1.92 albertel 716: if ($advanced_role) {
1.151 www 717: &Apache::lonhtmlcommon::Update_PrgWin('',$progress_win,$message.$extra_msg);
1.60 albertel 718: }
1.59 albertel 719: }
720: $SIG{CHLD}='IGNORE';
721: close(CMD);
722: }
1.1 sakharuk 723:
1.135 foxr 724: # Make the dvi file (or rather try to), from the latex file and the
725: # various bits and pieces that control how the latex file is processed:
726: # LaTeX is run as many times a needed to make this all happen... this may
727: # result in several runs of LaTeX that just are errors if the LaTeX is
1.136 bisitz 728: # bad, but the printing subsystem is _supposed_ to not do that.
1.135 foxr 729: #
730: # Parameters:
731: # name_file - Name of the LaTeX file to process.
732: # dvi_file - Name of resulting dvi file.
733: # tableofcontents - "yes" if we are supposed to make a table of contents.
734: # tableofindex - "yes" if we are suposed to make an index.
735: # status_statement - Part of the status statement for ths status window.
736: # prog_state - Reference to the program state hash.
737: # busy_wait_timeout- Seconds without any progress that imply a problem.
738: #
739: #
740: sub make_dvi_file {
741: my ($name_file,
742: $dvi_file,
743: $tableofcontents,
744: $tableofindex,
745: $status_statement,
746: $prog_state,
747: $busy_wait_timeout) = @_;
748:
749:
750: &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
751: "for $status_statement now LaTeXing file",
752: $prog_state,$dvi_file, $busy_wait_timeout);
753:
754: # If the tableof contents was requested, we need to run
755: # LaTex a couple more times to get all the references sorted out.
756:
757: if ($tableofcontents eq 'yes') {
758: &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
759: "for $status_statement First LaTeX of file for table of contents",
760: $prog_state,$dvi_file, $busy_wait_timeout);
761: &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
762: "for $status_statement Second LaTeX of file for table of contents",
763: $prog_state,$dvi_file,$busy_wait_timeout);
764: }
765:
766: # And makeindex and another run of LaTeX to incorporate it if the index
767: # is enabled.
768:
769:
770: if ($tableofindex eq 'yes') {
771: my $idxname=$name_file;
772: $idxname=~s/\.tex$/\.idx/;
773: &busy_wait_command("makeindex $idxname",
774: "making index file",
775: $prog_state,$idxname);
776: &busy_wait_command("latex $name_file 1>/dev/null 2>/dev/null",
777: "for $status_statement now LaTeXing file for index section",
778: $prog_state,$dvi_file, $busy_wait_timeout);
779: }
780:
781: }
782:
783:
1.102 foxr 784: # Repagninate
1.99 foxr 785: # What we need to do:
786: # - Count the number of pages in each student.
1.102 foxr 787: # - Rewrite the latex file replacing the \specials that
788: # mark the end of student with an appropriate number of newlines.
789: # parameters:
790: # psfile - Postscript filename
791: # latexfile - LaTeX filename
792: # columns - number of columns.
793: sub repaginate {
1.100 foxr 794:
795: # We will try to do this in 2 passes through the postscript since
796: # the postscript is potentially large, to do 2 passes, the first pass
797: # must be able to calculate the total number of document pages so that
798: # at the beginning of the second pass we already know how to replace
799: # %%Pages:
800:
801: # Figure out
802: # 1. Number of pages in the document
803: # 2. Maximum number of pages in a student
804: # 3. Number of pages in each student.
1.99 foxr 805:
1.102 foxr 806: my ($postscript_filename, $latex_filename, $num_columns) = @_;
1.99 foxr 807: open(PSFILE, "<$postscript_filename");
1.100 foxr 808: my $line;
809: my $total_pages; # Total pages in document.
810: my $seen_pages = 0; # There are several %%Pages only the first is useful
811: my @pages_in_student; # For each student his/her initial page count.
812: my $max_pages = 0; # Pages in 'longest' student.
1.102 foxr 813: my $page_number = 0;
1.151 www 814: &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Counting pages for student: [_1]",1));
1.104 foxr 815:
1.100 foxr 816: while ($line = <PSFILE>) {
817:
818: # Check for total pages (%%Pages:)
819:
1.101 albertel 820: if (($line =~ /^%%Pages:/) && (!$seen_pages)) {
1.100 foxr 821: my @pageinfo = split(/ /,$line);
822: $total_pages = $pageinfo[1];
823: $seen_pages = 1;
824: }
825: # Check for %%Page: n m $page_number will be the
826: # biggest of these until we see an endofstudent.
827: # Note that minipages generate spurious %Page: 1 1's so
828: # we only are looking for the largest n (n is page number at the
829: # bottom of the page, m the page number within the document.
830: #
1.102 foxr 831:
1.127 albertel 832: if ($line =~ /^%%Page:\s+\d+\s+\d+/) {
1.120 albertel 833: my @pageinfo = split(/\s+/, $line);
1.100 foxr 834: if ($page_number < $pageinfo[1]) {
835: $page_number = $pageinfo[1];
1.110 albertel 836: } elsif ($pageinfo[2] ne 1) {
837: # current page count reset, and it's not because of a
838: # minipage
839: # - save the page_number, reset and, if necessary
840: # update max_pages.
841: push(@pages_in_student, $page_number);
1.151 www 842: &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Counting pages for student: [_1]", scalar(@pages_in_student)));
1.110 albertel 843: if ($page_number > $max_pages) {
844: $max_pages = $page_number;
845: }
846: $page_number = $pageinfo[1];
1.100 foxr 847: }
848: }
849:
850:
851: }
1.110 albertel 852: # file ended so one more student
853: push(@pages_in_student, $page_number);
1.151 www 854: &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Counting pages for student: [_1]",scalar(@pages_in_student)));
1.110 albertel 855: if ($page_number > $max_pages) {
856: $max_pages = $page_number;
857: }
858: $page_number = 0;
859:
1.99 foxr 860: close(PSFILE);
1.102 foxr 861:
862: # If 2 columns, max_pages must go to an even number of columns:
1.103 foxr 863:
1.102 foxr 864:
865: if ($num_columns == 2) {
866: if ($max_pages % 2) {
867: $max_pages++;
868: }
869: }
1.100 foxr 870:
1.102 foxr 871: # Now rewrite the LaTex file, substituting our \special
872: # with an appropriate number of \newpage directives.
873:
874: my $outfilename = $latex_filename."temp";
875:
876: open(LATEXIN, "<$latex_filename");
877: open(LATEXOUT, ">$outfilename");
878:
879:
1.110 albertel 880: my $student_number = 0; # Index of student we're working on.
1.151 www 881: &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Repaginating student: [_1]",$student_number+1));
1.102 foxr 882:
883: while (my $line = <LATEXIN>) {
884: if ($line eq "\\special{ps:ENDOFSTUDENTSTAMP}\n") {
885: # only end of student stamp if next line is ENDOFSTUDENTSTAMP:
886:
887:
888: # End of student replace with 0 or more newpages.
889:
890: my $addlines = $max_pages - $pages_in_student[$student_number];
891: while($addlines) {
1.108 albertel 892: print LATEXOUT '\clearpage \strut \clearpage';
1.105 foxr 893:
1.102 foxr 894: $addlines--;
1.100 foxr 895: }
1.102 foxr 896:
1.100 foxr 897: $student_number++;
1.151 www 898: &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt("Repaginating student: [_1]",$student_number+1));
1.102 foxr 899:
900: } else {
901: print LATEXOUT $line;
1.100 foxr 902: }
903: }
904:
1.102 foxr 905: close(LATEXIN);
906: close(LATEXOUT);
1.108 albertel 907: rename($outfilename, $latex_filename);
1.100 foxr 908:
1.99 foxr 909: }
1.4 sakharuk 910:
1.115 foxr 911: #
912: # Create missing fonts given a latex missfonts.log file.
913: # This file will have lines like:
914: #
915: # mktexpk --mfmode ljfour --bdpi 8000 --mag 1+0/8000 --dpi 8000 tcrm0500
916: #
917: # We want to execute those lines with the 8000's changed to 600's
918: # in order to match the resolution of the ljfour printer.
919: # Of course if some wiseguy has changed the default printer from ljfour
920: # in the dvips's config.ps file that will break so we'll also
921: # ensure that --mfmode is ljfour.
922: #
923: sub create_missing_fonts {
924: my ($fontfile, $state) = @_;
925:
926: # Open and read in the font file..we'll read it into the array
927: # font_commands.
928: #
1.118 albertel 929: open(my $font_handle, $fontfile);
1.115 foxr 930: my @font_commands = <$font_handle>;
1.118 albertel 931:
932: # make the list contain each command only once
933: my %uniq;
934: @font_commands = map { $uniq{$_}++ == 0 ? $_ : () } @font_commands;
1.115 foxr 935:
936: # Now process each command replacing the appropriate 8000's with
937: # 600's ensuring that font names with 8000's in them are not corrupted.
938: # and if the --mfmode is not ljfour we turn it into ljfour.
939: # Then we execute the command.
940: #
1.118 albertel 941:
1.115 foxr 942: foreach my $command (@font_commands) {
1.116 albertel 943: #print("<br />Raw command: $command");
1.115 foxr 944: $command =~ s/ 8000/ 600/g; # dpi directives.
945: $command =~ s/\/8000/\/600/g; # mag directives.
1.116 albertel 946: #print("<br />After dpi replacements: $command");
1.115 foxr 947:
948: my @cmdarray = split(/ /,$command);
949: for (my $i =0; $i < scalar(@cmdarray); $i++) {
950: if ($cmdarray[$i] eq '--mfmode') {
951: $cmdarray[$i+1] = "ljfour";
952: }
953: }
1.116 albertel 954: #print("<br /> before reassembly : (@cmdarray)");
1.115 foxr 955: $command = join(" ", (@cmdarray));
956:
1.116 albertel 957: #print("<br />Creating fonts via command: $command");
1.118 albertel 958: &busy_wait_command("$command 1>/dev/null 2>/dev/null",
1.115 foxr 959: "Creating missing font",
1.124 albertel 960: $state);
1.115 foxr 961:
962: }
963:
964: }
1.133 foxr 965: #
966: # Convert a figure file to encapsulated postscript:
967: # At present, this is using a lot of file scoped globals to pass data around.
968: # Parameters:
969: # not_eps - The name of the file to convert which, presumably, is not
970: # already an eps file.
971: #
972: sub convert_figure {
973: my ($not_eps) = @_;
1.141 foxr 974: &debug("in convert_figure");
1.133 foxr 975:
976: my $status_statement='EPS picture for '.$not_eps;
977: my $eps_f = $not_eps;
1.134 foxr 978:
1.150 www 979: if ($eps_f=~/\/home\/httpd\/html\/priv\/[^\/]+\/([^\/]+)\//) {
980: $eps_f=~s/\/home\/httpd\/html\/priv\/[^\/]+\/([^\/]+)/$1/;
1.133 foxr 981: } elsif ($eps_f=~/$perlvar{'lonDocRoot'}\/res\//) {
1.134 foxr 982: $eps_f=~ s/$perlvar{'lonDocRoot'}\/res\/(.+)/$1/;
1.133 foxr 983: } elsif ($eps_f=~/$perlvar{'lonUsersDir'}\//) {
1.134 foxr 984: $eps_f=~ s/$perlvar{'lonUsersDir'}\/([^\/]+)\/\w\/\w\/\w\/(.+)/$1\/$2/;
1.133 foxr 985: }
1.134 foxr 986:
987: $eps_f = $perlvar{'lonPrtDir'}.'/'.$eps_f;
988:
989: # Spaces are problematic for system commands and LaTeX, replace with _
990:
1.160 raeburn 991: $eps_f =~ s/ /\_/g;
1.134 foxr 992:
1.133 foxr 993: #
1.134 foxr 994: # If the file is already an .eps or .ps file (eps_f still has the original
995: # file type),
1.133 foxr 996: # We really just need to copy it from where it was to prtspool
997: # but with the spaces substituted to _'s.
998: #
1.134 foxr 999: my ($nsname,$path, $sext) = &fileparse($eps_f, qr/\.(ps|eps)/i);
1.133 foxr 1000: if ($sext =~/ps$/i) {
1001: &File::Path::mkpath($path,0,0777);
1002: copy("$not_eps", "$eps_f");
1003: } else {
1004:
1005: $eps_f .= '.eps'; # Just append the eps ext.
1.134 foxr 1006: my $path= &dirname($eps_f);
1.133 foxr 1007: &File::Path::mkpath($path,0,0777);
1008: $not_eps =~ s/^\s+//;
1009: $not_eps =~ s/\s+$//;
1.147 droeschl 1010: my $prettyname=$not_eps;
1.133 foxr 1011: if ($advanced_role) {
1012: $prettyname=~s|$perlvar{'lonDocRoot'}/|/|;
1.151 www 1013: &Apache::lonhtmlcommon::Update_PrgWin('',\%prog_state,&mt('Converting to EPS: [_1]',$prettyname));
1.133 foxr 1014: }
1.141 foxr 1015: #
1016: # If the file is a PDF, need to use pdftops to convert it to a ps file.
1017: # otherwise use imagemagik:
1018: #
1019: if($not_eps =~/\.(pdf|PDF)$/) {
1020:
1021: #
1022: # For whatever reason, pure postscript conversions have to be
1023: # in the same dir as the base file:
1024: #
1025: $eps_f = &basename($eps_f);
1026: $eps_f = $perlvar{'lonPrtDir'}.'/'.$eps_f;
1027:
1028: &debug("Converting pdf $not_eps to postscript: $eps_f");
1.165 raeburn 1029: my @args = ('pdftops',$not_eps,$eps_f);
1030: system({$args[0]} @args); # Indirect object forces list processing mode.
1031: # See perlfunc documentation for exec().
1032: if ($? and $advanced_role) {
1033: print '<p class="LC_warning">'
1034: .&mt('An error occurred during the conversion of [_1] to postscript.',
1035: '<span class="LC_filename">'.$prettyname.'</span>')
1036: .'</p>';
1037: } else {
1038: $pdfs_converted++; # Need to fix ps in last pass.
1039: }
1.141 foxr 1040: } else {
1.165 raeburn 1041: my @args = ('convert',$not_eps,$eps_f);
1042: system({$args[0]} @args); # Indirect object forces list processing mode.
1043: # See perlfunc documentation for exec().
1044: if ($? and $advanced_role) {
1045: print '<p class="LC_warning">'
1046: .&mt('An error occurred during the conversion of [_1].',
1.155 bisitz 1047: '<span class="LC_filename">'.$prettyname.'</span>')
1.165 raeburn 1048: .'<br />'
1049: .&mt('If possible try to save this image using different settings and republish it.')
1050: .'</p>';
1051: }
1.141 foxr 1052: }
1.134 foxr 1053:
1.133 foxr 1054: if (not -e $eps_f) {
1055: # converting an animated gif creates either:
1056: # anim.gif.eps.0
1057: # or
1058: # anim.gif-0.eps
1059: for (my $i=0;$i<10000;$i++) {
1060: if (-e $eps_f.'.'.$i) {
1061: rename($eps_f.'.'.$i, $eps_f);
1062: last;
1063: }
1064: my $anim_eps = $eps_f;
1065: $anim_eps =~ s/(\.[^.]*)\.eps$/$1-$i\.eps/i;
1066: if (-e $anim_eps) {
1067: rename($anim_eps, $eps_f);
1068: last;
1069: }
1070: }
1071: }
1072:
1073: # imagemagick 6.2.0-6.2.7 fails to properly handle
1074: # convert anim.gif anim.gif.eps
1075: # it creates anim.eps instead.
1076: if (not -e $eps_f) {
1077: my $eps_f2 = $eps_f;
1078: $eps_f2 =~ s/\.[^.]*\.eps$/\.eps/i;
1079: if(-e $eps_f2) {
1080: rename($eps_f2,$eps_f);
1081: }
1082: }
1083: }
1084:
1085: }
1.135 foxr 1086: #
1087: # Analyze a LaTeX logfile producing appropriate output on error and
1088: # returning a boolean to let the caller know if, in our opinion, it's
1089: # worth continuing on to produce the PDF file.
1090: #
1091: # Parameters:
1092: # logfilename - Name of the logfile.
1093: # texfile - Name of the LaTeX file that was being processed.
1094: # advanced_role - True if the user is privileged with respect to the printout
1095: # (e.g. is the course coordinator or some such thing).
1096: # Returns:
1097: # 1 - Caller is advised to continue to create the PDF.
1098: # 0 - Caller need not bother creating the PDF.
1099: # Side Effects:
1100: # Messages are printed to describe any errors that have been encountered.
1101: # NOTE:
1102: # The current policy is to assume that if LaTeX decided to insert some text
1103: # it has salvaged the resource and the resource can be printed.. in that case
1104: # a message is emitted from this sub.
1105: #
1106: sub analyze_logfile {
1107: my ($logfilename, $texfile, $advanced_role) = @_;
1108:
1109: my $temporary_file=IO::File->new($logfilename) || die "Couldn't open log file $logfilename for reading: $!\n";
1110: my @content_of_file = <$temporary_file>;
1111: close $temporary_file;
1112: my $body_log_file = join(' ',@content_of_file);
1113: $logfilename =~ s/\.log$/\.html/;
1114: $temporary_file = IO::File->new('>'.$logfilename);
1115: print $temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_log_file.'</pre></body></html>'."\n";
1116: if ($body_log_file=~m/!\s+Emergency stop/) {
1117: my $whereitbegins = rindex $body_log_file,'STAMPOFPASSEDRESOURCESTART';
1118: my $whereitends = rindex $body_log_file,'STAMPOFPASSEDRESOURCEEND';
1119: my $badresource;
1120: my $badtext;
1121: if ($whereitbegins!=-1 and $whereitends!=-1) {
1122: $badtext = substr($body_log_file,$whereitbegins+26, $whereitends-$whereitbegins-26);
1123: $whereitbegins = rindex $badtext,'located in';
1124: if ($whereitbegins != -1) {
1125:
1126: $badresource = substr($badtext, $whereitbegins+27,
1127: length($badtext) - $whereitbegins - 48);
1128: # print "<br />failing resourcename: $badresource<br />";
1129: }
1.136 bisitz 1130: }
1.135 foxr 1131:
1132: # Guys with privileged roles get a more detailed error output:
1133:
1134: if ($advanced_role) {
1135: #LaTeX failed to parse tex file
1.138 biermanm 1136: print "<h2>".&mt('LaTeX could not successfully parse your TeX file.')."</h2>";
1.136 bisitz 1137: print &mt('It probably has errors in it.')."<br />";
1138: if ($badtext) {
1.156 raeburn 1139: print &mt('With very high probability this error occurred in [_1].',$badtext)
1.136 bisitz 1140: ."<br /><br />";
1141: }
1142: print &mt('Here are the error messages in the LaTeX log file:')
1143: ."<br /><pre>";
1.135 foxr 1144:
1145: my $sygnal = 0;
1146: for (my $i=0;$i<=$#content_of_file;$i++) {
1147: if ($content_of_file[$i]=~m/^Runaway argument?/ or $content_of_file[$i]=~m/^!/) {
1148: $sygnal = 1;
1149: }
1150: if ($content_of_file[$i]=~m/Here is how much of/) {
1151: $sygnal = 0;
1152: }
1153: if ($sygnal) {
1154: print "$content_of_file[$i]";
1155: }
1156: }
1157: print "</pre>\n";
1158: # print "<br /> Advanced role <br />";
1159: $logfilename=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136 bisitz 1160: print "<b><big>"
1161: .&mt('The link to [_1]Your log file[_2]','<a href="'.$logfilename.'">','</a>')
1162: ."</big></b>\n";
1.135 foxr 1163: #link to original LaTeX file
1164: my $tex_temporary_file=IO::File->new($texfile) || die "Couldn't open tex file $texfile for reading: $!\n";
1165: my @tex_content_of_file = <$tex_temporary_file>;
1166: close $tex_temporary_file;
1167: my $body_tex_file = join(' ',@tex_content_of_file);
1168: $texfile =~ s/\.tex$/aaaaa\.html/;
1169: $tex_temporary_file = IO::File->new('>'.$texfile);
1170: print $tex_temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_tex_file.'</pre></body></html>'."\n";
1171: print "<br /><br />";
1172: $texfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136 bisitz 1173: print "<b><big>"
1174: .&mt('The link to [_1]Your original LaTeX file[_2]','<a href="'.$texfile.'">','</a>')
1175: ."</big></b><br /><br />\n";
1176: my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", &mt('Help on printing'));
1.135 foxr 1177: print ("$help_text");
1178:
1179: # Students on the other hand get a minimal error message, since they won't
1180: # be able to correct the error message. A message is sent to the
1181: # instructor:
1182:
1183: } else { # Student role...
1184: # at this point:
1185: # $body_log_file - contains the log file.
1186: # $name_file - is the name of the LaTeX file.
1187: # $identifier - is the unique LaTeX identifier.l
1188:
1.142 bisitz 1189: print '<p class="LC_error">';
1.136 bisitz 1190: if ($badtext) {
1191: print &mt('There are errors in [_1].',$badtext);
1192: } else {
1193: print &mt('There are errors.');
1194: }
1.142 bisitz 1195: print '</p>'
1196: .&mt('These errors prevent this resource from printing correctly.');
1197:
1.135 foxr 1198: my $tex_handle = IO::File->new($texfile);
1199: my @tex_contents = <$tex_handle>;
1200: &send_error_mail($identifier, $badresource, $body_log_file, \@tex_contents);
1.136 bisitz 1201: print "<p>"
1202: .&mt('A message has been sent to the instructor describing this failure.')
1203: ."</p>";
1204: my $help_text = &Apache::loncommon::help_open_topic("Print_Resource", &mt('Help on printing'));
1.135 foxr 1205: print ("$help_text");
1206:
1207: }
1208:
1209: # Either way, an emergency stop does not allow us to continue so:
1210:
1211: return 0;
1212:
1213: # The branch of code below is taken if it appears that
1214: # there was no emergency stop but LaTeX had to correct the
1215: # input file to run.
1216: # In that case we need to provide error feedback, as the correction >may< not be
1217: # sufficient, we can let the game continue as there's a dvi file to process.
1218:
1219: } elsif ($body_log_file=~m/<inserted text>/) {
1220: my $whereitbegins = index $body_log_file,'<inserted text>';
1.136 bisitz 1221: print &mt('You are running LaTeX in [_1]batch mode[_2].','<b>','</b>');
1.135 foxr 1222: while ($whereitbegins != -1) {
1223: my $tempobegin=$whereitbegins;
1224: $whereitbegins = rindex $body_log_file,'STAMPOFPASSEDRESOURCESTART',$whereitbegins;
1225: my $whereitends = index $body_log_file,'STAMPOFPASSEDRESOURCEEND',$whereitbegins;
1.136 bisitz 1226: print "<br />"
1227: .&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 1228: 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 1229: $whereitbegins = index $body_log_file,'<inserted text>',$tempobegin+10;
1230: }
1231:
1232: if ($advanced_role) {
1233: print "<br /><br />";
1234: $logfilename=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136 bisitz 1235: print "<b><big>"
1236: .&mt('The link to [_1]Your log file[_2]'
1.137 raeburn 1237: ,'<a href="'.$logfilename.'">','</a>')
1.136 bisitz 1238: ."</big></b>\n";
1.135 foxr 1239: #link to original LaTeX file
1240: my $tex_temporary_file=IO::File->new($texfile) || die "Couldn't open tex file $texfile for reading: $!\n";
1241: my @tex_content_of_file = <$tex_temporary_file>;
1242: close $tex_temporary_file;
1243: my $body_tex_file = join(' ',@tex_content_of_file);
1244: $texfile =~ s/\.tex$/aaaaa\.html/;
1245: $tex_temporary_file = IO::File->new('>'.$texfile);
1246: print $tex_temporary_file '<html><head><title>LOGFILE</title></head><body><pre>'.$body_tex_file.'</pre></body></html>'."\n";
1247: print "<br /><br />";
1248: $texfile=~s{^\Q$perlvar{'lonPrtDir'}\E}{/prtspool};
1.136 bisitz 1249: print "<b><big>"
1250: .&mt('The link to [_1]Your original LaTeX file[_2]','<a href="'.$texfile.'">','</a>');
1251: print "</big></b>\n";
1.135 foxr 1252: }
1253: return 1;
1254: }
1255: return 1; # NO log file issues at all.
1256: }
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