File:
[LON-CAPA] /
loncom /
interface /
lonhelp.pm
Revision
1.39:
download - view:
text,
annotated -
select for diffs
Tue Jul 8 01:08:57 2008 UTC (16 years, 2 months ago) by
raeburn
Branches:
MAIN
CVS tags:
version_2_9_X,
version_2_9_99_0,
version_2_9_1,
version_2_9_0,
version_2_8_X,
version_2_8_99_1,
version_2_8_99_0,
version_2_8_2,
version_2_8_1,
version_2_8_0,
version_2_7_X,
version_2_7_99_1,
version_2_7_99_0,
version_2_7_1,
version_2_7_0,
version_2_6_99_1,
version_2_6_99_0,
version_2_10_0_RC1,
bz6209-base,
bz6209,
bz5969,
bz2851,
PRINT_INCOMPLETE_base,
PRINT_INCOMPLETE,
HEAD,
GCI_3,
GCI_2,
GCI_1,
BZ5971-printing-apage,
BZ5434-fox
- Move help.png help icon from /res into /adm/help so it is available for users are not logged into LON-CAPA on servers where lonhttpd points at port 80.
- Revert to use of calls to lonhttpd in in those cases where they had been eliminated in the switch of help icon to the current (tango) icon (3/24/2008).
1: # The LearningOnline Network with CAPA
2: #
3: # $Id: lonhelp.pm,v 1.39 2008/07/08 01:08:57 raeburn Exp $
4: #
5: # .tex help system web server handler
6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27: # http://www.lon-capa.org/
28: #
29: # .tex file help handler
30:
31:
32: package Apache::lonhelp;
33:
34: use strict;
35: use Apache::Constants qw(:common :http);
36: use Apache::File();
37: use Apache::loncommon();
38: use Apache::lonacc();
39: use Apache::lontexconvert();
40: use Apache::lonnavmaps; # for advancedUser
41: use Apache::lonlocal;
42: use Apache::lonnet;
43: use tth();
44: use GDBM_File();
45: use lib '/home/httpd/lib/perl/';
46: use LONCAPA;
47:
48:
49: # This sub takes the name of a label in, and converts it to something
50: # that is a valid anchor name.
51:
52: sub processLabelName {
53: my ($name) = @_;
54: $name =~ tr/a-zA-Z0-9/_/cs;
55: return $name;
56: }
57:
58: # Serve out the text
59: sub servetext {
60: my ($r,$text) = @_;
61: my $bugs=&Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug'));
62: my $morehelp;#=&Apache::loncommon::help_open_menu(undef,undef,1,undef,undef,undef,undef,'Help and Assistance Menu');
63: my $header=&mt('LON-CAPA Help');
64: $r->print(<<HEADER);
65: <h3 style="font: sans-serif"><img align="right" alt="help logo"
66: src="/adm/help/gif/lonhelpheader.gif"/>$header</h3><hr />
67: <!-- BEGIN -->
68: HEADER
69:
70: $r->print($text);
71:
72: if (&Apache::lonnavmaps::advancedUser()) {
73: my $search=&mt('Search LON-CAPA help');
74: my $query=&mt('Search');
75: my $uri = $r->uri;
76: $r->print(<<FOOTER);
77: <hr /><form action="$uri" method="post">
78: <label>$search: <input type="text" name="searchterm" size="40" /></label><input type="submit" value="$query" />
79: </form>
80: <br />
81: $bugs
82: $morehelp
83: FOOTER
84:
85: }
86:
87: $r->print(<<ENDBODY);
88: <!-- END -->
89: ENDBODY
90:
91: }
92:
93: # Render takes a tex fragment, transforms it for TtH, and returns the
94: # HTML equivalent
95: sub render {
96: my ($tex, $docroot) = @_;
97: tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0);
98:
99: # This tells TtH what to do with captions, labels, and other
100: # things
101: $tex = "\\documentclass{article}\n" . $tex;
102:
103: # We process these ourselves because TtH can't handle then without
104: # LaTeX .aux files
105: # absolute paths for use with help.loncapa.org
106: $tex =~ s| \\ref\{([^}]*)\}
107: |
108: my $label=$1;
109: if ($1!~/\.hlp$/) {
110: if ((!exists($fragmentLabels{$1})) && ($1!~/\.hlp$/)) {
111: &Apache::lonnet::logthis("ERROR: $1 not a valid help label");
112: $label='Error';
113: } else {
114: $label=substr($fragmentLabels{$1}, 0, -4);
115: }
116: } else {
117: $label=~s/\.hlp$//;
118: }
119: '\\begin{html}<a href="/adm/help/'.
120: $label .
121: '.hlp#' . &processLabelName($1) .
122: '"><img src="/adm/help/help.png" border="0" /></a>' .
123: '\\end{html}'
124: |gxe;
125:
126: # Backslashes
127: $tex =~ s|\\textbackslash|###BACKSLASH###|g;
128:
129: # Figures leftover without captions
130: $tex =~ s| \\includegraphics(\[[^]]*\])*\{([^}]*)\}
131: | '\\begin{html}<img src="/adm/help/gif/' . $2 . '.gif" border="2"'.
132: ' bordercolor="#000000"/>\\end{html}'
133: |gxe;
134:
135:
136: $tex=&Apache::lontexconvert::tth_converted(\$tex);
137:
138: # Finish backslashes
139: $tex =~ s/###BACKSLASH###/'\\'/ge;
140:
141: # Fix the pretty quotes
142: $tex =~ s/('')|(``)/"/g; #" to get emacs syntax highlighter happy
143:
144: # For some reason all captions come out as "Figure 0:", so
145: # just duck the issue...
146:
147: $tex =~ s/Figure 0://g;
148: $tex.=$Apache::lontexconvert::errorstring;
149: untie %fragmentLabels;
150:
151: return $tex;
152: }
153:
154: sub listmatches {
155: my ($docroot,$term,$subdir) =@_;
156: unless ($subdir) { $subdir=''; }
157: my $output='';
158: opendir(DIR,$docroot.'/adm/help/tex/'.$subdir);
159: foreach my $filename (sort readdir(DIR)) {
160: if ($filename=~/\.tex$/) {
161: open(FH,$docroot.'/adm/help/tex/'.$subdir.$filename);
162: my $quote='';
163: while (my $line=<FH>) {
164: if ($line=~/\Q$term\E/i) {
165: $line=~s/\\\w+//gs;
166: $line=~s/\{//gs;
167: $line=~s/\}//gs;
168: $line=~s/\\/ /gs;
169: $line=~s/\</\<\;/gs;
170: $line=~s/\>/\>\;/gs;
171: $line=~s/(\Q$term\E)/\<b\>$1\<\/b\>/gsi;
172: $quote.='<br />...'.$line.'...';
173: }
174: }
175: close(FH);
176: if ($quote) {
177: my $title=$filename;
178: $title=~s/\_/ /gs;
179: $title=~s/\.tex$//;
180: $filename=~s/\.tex$/\.hlp/;
181: $output.='<li><a href="/adm/help/tex/'.$subdir.$filename.'">'.$title.'</a>'.$quote.'</li>';
182: }
183: }
184: }
185: closedir(DIR);
186: return (($output?'<ul>'.$output.'</ul>':&mt('"[_1]" not found',$term)),$output);
187: }
188:
189: sub handler {
190: my $r = shift;
191:
192: my $docroot = $r->dir_config('lonDocRoot');
193:
194: &Apache::lonlocal::get_language_handle($r);
195: &Apache::loncommon::content_type($r,"text/html");
196: my $start_page=
197: &Apache::loncommon::start_page('LON-CAPA Help',undef,
198: {'only_body' => 1,});
199: my $text='';
200: if ($env{'form.searchterm'}=~/\w/) {
201: ($text,my $matches)=&listmatches($docroot,$env{'form.searchterm'},&Apache::lonlocal::current_language().'/');
202: if ($matches) {
203: my ($englishresult,$englishmatches)=&listmatches($docroot,$env{'form.searchterm'});
204: if ($englishmatches) {
205: $text.='<hr />'.$englishresult;
206: }
207: } else {
208: $text=&listmatches($docroot,$env{'form.searchterm'});
209: }
210: } else {
211: my $filenames = &unescape(substr($ENV{'REQUEST_URI'} ,
212: rindex($ENV{'REQUEST_URI'}, '/') + 1, -4));
213:
214: # Security check on the file; the whole filename must consist
215: # of nothing but alphanums, ' ,, or ., or the file
216: # will be "not found", no matter what.
217:
218: return HTTP_NOT_FOUND if ($filenames !~ /\A[-0-9a-zA-z_'',:.]+\Z/);
219:
220: # Join together the tex files, return HTTP_NOT_FOUND if any of
221: # them are not found
222: my $tex = '';
223: # Since in insertlist.tab I want to specify multiple files,
224: # and insertlist.tab also uses commas, I need something else
225: # so replace : with ,
226: $filenames =~ s/:/,/g;
227: my @files = split(/,/, $filenames);
228:
229: for my $filename (@files) {
230: if (-e $docroot.'/adm/help/tex/'.
231: &Apache::lonlocal::current_language().'/'.
232: $filename.'.tex') {
233: $filename=&Apache::lonlocal::current_language().'/'.$filename;
234: }
235: (my $file = Apache::File->new($docroot
236: . '/adm/help/tex/'.$filename.'.tex'))
237: or return HTTP_NOT_FOUND;
238: $tex .= join('', <$file>);
239: }
240:
241: $text = &render($tex, $docroot);
242: }
243:
244: $r->send_http_header;
245: $r->print($start_page);
246: &servetext($r,$text);
247: $r->print(&Apache::loncommon::end_page());
248:
249: return OK;
250: }
251:
252: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>