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