Annotation of loncom/interface/lonhelp.pm, revision 1.12
1.1 bowersj2 1: # The LearningOnline Network with CAPA
2: # .tex help system web server handler
3: #
4: # Copyright Michigan State University Board of Trustees
5: #
6: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
7: #
8: # LON-CAPA is free software; you can redistribute it and/or modify
9: # it under the terms of the GNU General Public License as published by
10: # the Free Software Foundation; either version 2 of the License, or
11: # (at your option) any later version.
12: #
13: # LON-CAPA is distributed in the hope that it will be useful,
14: # but WITHOUT ANY WARRANTY; without even the implied warranty of
15: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: # GNU General Public License for more details.
17: #
18: # You should have received a copy of the GNU General Public License
19: # along with LON-CAPA; if not, write to the Free Software
20: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21: #
22: # /home/httpd/html/adm/gpl.txt
23: #
24: # http://www.lon-capa.org/
25: #
26: # .tex file help handler
27: # YEAR=2002
28: # 7/4 Jeremy Bowers
29:
30: package Apache::lonhelp;
31:
32: use strict;
33: use Apache::Constants qw(:common :http);
1.5 albertel 34: use Apache::File();
35: use Apache::loncommon();
36: use Apache::lonacc();
37: use Apache::lontexconvert();
1.9 bowersj2 38: use Apache::lonnavmaps; # for advancedUser
1.11 albertel 39: use Apache::lonlocal;
1.5 albertel 40: use tth();
41: use GDBM_File();
1.1 bowersj2 42:
43: # This sub takes the name of a label in, and converts it to something
44: # that is a valid anchor name.
45: sub processLabelName
46: {
47: my ($name) = @_;
48: $name =~ tr/a-zA-Z0-9/_/cs;
49: return $name;
50: }
51:
52: # Serve out the Tex
53: sub serveTex
54: {
55: my ($tex, $r) = @_;
56:
57: $r->print(<<HEADER);
58: <html>
59: <head>
60: <title>LON-CAPA Help</title>
61: </head>
62: <body bgcolor="#FFFFFF">
1.4 bowersj2 63: <h3 style="font: sans-serif"><img align="right"
64: src="/adm/help/gif/lonhelpheader.gif"/>LON-CAPA Help<hr /></h3>
1.2 bowersj2 65: <!-- BEGIN -->
1.1 bowersj2 66: HEADER
67:
68: $r->print($tex);
69:
1.9 bowersj2 70: if (Apache::lonnavmaps::advancedUser()) {
1.1 bowersj2 71: $r->print(<<FOOTER);
1.2 bowersj2 72: <!-- END -->
1.4 bowersj2 73: <hr />
74: <center><font size="-1"><a href="/adm/help/abouthelp.html">About
75: LON-CAPA help and More Help</a></font></center>
1.1 bowersj2 76: </body>
77: </html>
78: FOOTER
1.9 bowersj2 79: } else {
80: $r->print(<<FOOTER);
81: <!-- END -->
82: </body>
83: </html>
84: FOOTER
85: }
1.1 bowersj2 86: }
87:
88: # Render takes a tex fragment, transforms it for TtH, and returns the
89: # HTML equivalent
90: sub render
91: {
1.2 bowersj2 92: my ($tex, $docroot, $serverroot) = @_;
93: tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0);
1.1 bowersj2 94:
95: # This tells TtH what to do with captions, labels, and other
96: # things
97: $tex = "\\documentclass{article}\n" . $tex;
98:
99: # We process these ourselves because TtH can't handle then without
100: # LaTeX .aux files
1.2 bowersj2 101: # absolute paths for use with help.loncapa.org
1.1 bowersj2 102: $tex =~ s| \\ref\{([^}]*)\}
1.2 bowersj2 103: |'\\begin{html}<a href="http://' . $serverroot ."/adm/help/".
1.1 bowersj2 104: substr($fragmentLabels{$1}, 0, -4) .
1.2 bowersj2 105: '.hlp#' . processLabelName($1) .
106: '"><img src="http://' . $serverroot . '/adm/help/gif/smallHelp.gif" border="0" /></a>' .
107: '\\end{html}'
1.1 bowersj2 108: |gxe;
109:
1.3 bowersj2 110: # Backslashes
111: $tex =~ s|\\textbackslash|###BACKSLASH###|g;
112:
1.1 bowersj2 113: # Figures leftover without captions
114: $tex =~ s| \\includegraphics(\[[^]]*\])*\{([^}]*)\}
1.2 bowersj2 115: | '\\begin{html}<img src="http://' . $serverroot . '/adm/help/gif/' . $2 . '.gif" border="2"'.
1.1 bowersj2 116: ' bordercolor="#000000"/>\\end{html}'
117: |gxe;
118:
1.3 bowersj2 119:
1.5 albertel 120: $tex=&Apache::lontexconvert::converted(\$tex);
121:
1.3 bowersj2 122: # Finish backslashes
123: $tex =~ s/###BACKSLASH###/'\\'/ge;
124:
125: # Fix the pretty quotes
126: $tex =~ s/('')|(``)/"/g; #" to get emacs syntax highlighter happy
1.1 bowersj2 127:
128: # For some reason all captions come out as "Figure 0:", so
129: # just duck the issue...
130:
131: $tex =~ s/Figure 0://g;
1.5 albertel 132: $tex.=$Apache::lontexconvert::errorstring;
1.1 bowersj2 133: untie %fragmentLabels;
134:
135: return $tex;
136: }
137:
138: sub handler
139: {
140: my $r = shift;
141:
1.2 bowersj2 142: my $docroot = $r->dir_config('lonDocRoot');
143: my $serverroot = $ENV{'HTTP_HOST'};
144:
1.12 ! www 145: my $filenames = &Apache::lonnet::unescape(substr ($ENV{'REQUEST_URI'} ,
! 146: rindex($ENV{'REQUEST_URI'}, '/') + 1, -4));
1.1 bowersj2 147:
148: # Security check on the file; the whole filename must consist
149: # of nothing but alphanums, ' ,, or ., or the file
150: # will be "not found", no matter what.
151:
1.7 bowersj2 152: return HTTP_NOT_FOUND if ($filenames !~ /\A[-0-9a-zA-z_'',:.]+\Z/);
1.1 bowersj2 153:
1.10 www 154: &Apache::lonlocal::get_language_handle($r);
155:
1.6 bowersj2 156: # Join together the tex files, return HTTP_NOT_FOUND if any of
157: # them are not found
158: my $tex = '';
1.7 bowersj2 159: # Since in insertlist.tab I want to specify multiple files,
160: # and insertlist.tab also uses commas, I need something else
1.8 bowersj2 161: # so replace : with ,
1.7 bowersj2 162: $filenames =~ s/:/,/g;
1.6 bowersj2 163: my @files = split(/,/, $filenames);
164:
165: for my $filename (@files) {
1.11 albertel 166: if (-e $docroot.'/adm/help/tex/'.
167: &Apache::lonlocal::current_language().'/'.
168: $filename.'.tex') {
169: $filename=&Apache::lonlocal::current_language().'/'.$filename;
1.10 www 170: }
1.6 bowersj2 171: (my $file = Apache::File->new($docroot
172: . '/adm/help/tex/'.$filename.'.tex'))
173: or return HTTP_NOT_FOUND;
174: $tex .= join('', <$file>);
175: }
1.5 albertel 176:
177: # get me my environment if it exists
178: &Apache::lonacc::handler($r);
179:
180: if ($ENV{'browser.mathml'}) {
1.10 www 181: &Apache::loncommon::content_type($r,'text/xml');
1.5 albertel 182: &tth::ttminit();
183: if ($ENV{'browser.unicode'}) {
184: &tth::ttmoptions('-L -u1');
185: } else {
186: &tth::ttmoptions('-L -u0');
187: }
188: } else {
1.10 www 189: &Apache::loncommon::content_type($r,"text/html");
1.5 albertel 190: &tth::tthinit();
191: if ($ENV{'browser.unicode'}) {
192: &tth::tthoptions('-L -u1');
193: } else {
194: &tth::tthoptions('-L -u0');
195: }
196: }
197:
1.2 bowersj2 198: $tex = render($tex, $docroot, $serverroot);
1.1 bowersj2 199: serveTex($tex, $r);
200:
201: return OK;
202: }
203:
204: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonhelp.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface