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