Annotation of loncom/interface/lonhelp.pm, revision 1.40
1.1 bowersj2 1: # The LearningOnline Network with CAPA
1.27 www 2: #
1.40 ! raeburn 3: # $Id: lonhelp.pm,v 1.39 2008/07/08 01:08:57 raeburn Exp $
1.27 www 4: #
1.1 bowersj2 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
1.27 www 30:
1.1 bowersj2 31:
32: package Apache::lonhelp;
33:
34: use strict;
35: use Apache::Constants qw(:common :http);
1.5 albertel 36: use Apache::File();
37: use Apache::loncommon();
38: use Apache::lonacc();
39: use Apache::lontexconvert();
1.9 bowersj2 40: use Apache::lonnavmaps; # for advancedUser
1.11 albertel 41: use Apache::lonlocal;
1.18 albertel 42: use Apache::lonnet;
1.5 albertel 43: use tth();
44: use GDBM_File();
1.27 www 45: use lib '/home/httpd/lib/perl/';
46: use LONCAPA;
47:
1.1 bowersj2 48:
49: # This sub takes the name of a label in, and converts it to something
50: # that is a valid anchor name.
1.20 www 51:
52: sub processLabelName {
1.1 bowersj2 53: my ($name) = @_;
54: $name =~ tr/a-zA-Z0-9/_/cs;
55: return $name;
56: }
57:
1.20 www 58: # Serve out the text
59: sub servetext {
60: my ($r,$text) = @_;
1.37 bisitz 61: my $bugs=&Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug'));
1.32 albertel 62: my $morehelp;#=&Apache::loncommon::help_open_menu(undef,undef,1,undef,undef,undef,undef,'Help and Assistance Menu');
1.14 www 63: my $header=&mt('LON-CAPA Help');
1.16 albertel 64: $r->print(<<HEADER);
1.26 albertel 65: <h3 style="font: sans-serif"><img align="right" alt="help logo"
1.30 www 66: src="/adm/help/gif/lonhelpheader.gif"/>$header</h3><hr />
1.2 bowersj2 67: <!-- BEGIN -->
1.1 bowersj2 68: HEADER
69:
1.20 www 70: $r->print($text);
1.1 bowersj2 71:
1.19 albertel 72: if (&Apache::lonnavmaps::advancedUser()) {
1.20 www 73: my $search=&mt('Search LON-CAPA help');
1.25 www 74: my $query=&mt('Search');
1.26 albertel 75: my $uri = $r->uri;
1.20 www 76: $r->print(<<FOOTER);
1.26 albertel 77: <hr /><form action="$uri" method="post">
1.35 www 78: <label>$search: <input type="text" name="searchterm" size="40" /></label><input type="submit" value="$query" />
1.26 albertel 79: </form>
80: <br />
1.30 www 81: $bugs
1.31 www 82: $morehelp
1.1 bowersj2 83: FOOTER
1.24 albertel 84:
85: }
86:
87: $r->print(<<ENDBODY);
1.9 bowersj2 88: <!-- END -->
1.20 www 89: ENDBODY
1.24 albertel 90:
1.1 bowersj2 91: }
92:
93: # Render takes a tex fragment, transforms it for TtH, and returns the
94: # HTML equivalent
1.20 www 95: sub render {
1.36 albertel 96: my ($tex, $docroot) = @_;
1.2 bowersj2 97: tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0);
1.1 bowersj2 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
1.2 bowersj2 105: # absolute paths for use with help.loncapa.org
1.1 bowersj2 106: $tex =~ s| \\ref\{([^}]*)\}
1.15 albertel 107: |
1.30 www 108: my $label=$1;
1.40 ! raeburn 109: my $icon='/adm/help/help.png';
! 110: my $ext;
1.30 www 111: if ($1!~/\.hlp$/) {
1.40 ! raeburn 112: if (($1 =~ /^\w+\.manual\.pdf$/) && (-e $docroot.'/adm/help/'.$1)) {
! 113: $icon = '/adm/lonIcons/pdf.gif';
! 114: } elsif ((!exists($fragmentLabels{$1})) && ($1!~/\.hlp$/)) {
1.30 www 115: &Apache::lonnet::logthis("ERROR: $1 not a valid help label");
116: $label='Error';
117: } else {
118: $label=substr($fragmentLabels{$1}, 0, -4);
1.40 ! raeburn 119: $ext = '.hlp#' . &processLabelName($1);
1.30 www 120: }
121: } else {
122: $label=~s/\.hlp$//;
1.40 ! raeburn 123: $ext = '.hlp#' . &processLabelName($1);
1.30 www 124: }
1.33 albertel 125: '\\begin{html}<a href="/adm/help/'.
1.30 www 126: $label .
1.40 ! raeburn 127: $ext .
! 128: '"><img src="'.$icon.'" border="0" /></a>' .
1.2 bowersj2 129: '\\end{html}'
1.1 bowersj2 130: |gxe;
131:
1.3 bowersj2 132: # Backslashes
133: $tex =~ s|\\textbackslash|###BACKSLASH###|g;
134:
1.1 bowersj2 135: # Figures leftover without captions
136: $tex =~ s| \\includegraphics(\[[^]]*\])*\{([^}]*)\}
1.33 albertel 137: | '\\begin{html}<img src="/adm/help/gif/' . $2 . '.gif" border="2"'.
1.1 bowersj2 138: ' bordercolor="#000000"/>\\end{html}'
139: |gxe;
140:
1.3 bowersj2 141:
1.17 albertel 142: $tex=&Apache::lontexconvert::tth_converted(\$tex);
1.5 albertel 143:
1.3 bowersj2 144: # Finish backslashes
145: $tex =~ s/###BACKSLASH###/'\\'/ge;
146:
147: # Fix the pretty quotes
148: $tex =~ s/('')|(``)/"/g; #" to get emacs syntax highlighter happy
1.1 bowersj2 149:
150: # For some reason all captions come out as "Figure 0:", so
151: # just duck the issue...
152:
153: $tex =~ s/Figure 0://g;
1.34 albertel 154: $tex.=$Apache::lontexconvert::errorstring;
1.1 bowersj2 155: untie %fragmentLabels;
156:
157: return $tex;
158: }
159:
1.22 www 160: sub listmatches {
1.25 www 161: my ($docroot,$term,$subdir) =@_;
162: unless ($subdir) { $subdir=''; }
1.22 www 163: my $output='';
1.25 www 164: opendir(DIR,$docroot.'/adm/help/tex/'.$subdir);
1.22 www 165: foreach my $filename (sort readdir(DIR)) {
166: if ($filename=~/\.tex$/) {
1.25 www 167: open(FH,$docroot.'/adm/help/tex/'.$subdir.$filename);
1.22 www 168: my $quote='';
169: while (my $line=<FH>) {
170: if ($line=~/\Q$term\E/i) {
171: $line=~s/\\\w+//gs;
172: $line=~s/\{//gs;
173: $line=~s/\}//gs;
174: $line=~s/\\/ /gs;
1.25 www 175: $line=~s/\</\<\;/gs;
176: $line=~s/\>/\>\;/gs;
1.29 albertel 177: $line=~s/(\Q$term\E)/\<b\>$1\<\/b\>/gsi;
1.22 www 178: $quote.='<br />...'.$line.'...';
179: }
180: }
181: close(FH);
182: if ($quote) {
183: my $title=$filename;
184: $title=~s/\_/ /gs;
185: $title=~s/\.tex$//;
186: $filename=~s/\.tex$/\.hlp/;
1.25 www 187: $output.='<li><a href="/adm/help/tex/'.$subdir.$filename.'">'.$title.'</a>'.$quote.'</li>';
1.22 www 188: }
189: }
190: }
191: closedir(DIR);
1.25 www 192: return (($output?'<ul>'.$output.'</ul>':&mt('"[_1]" not found',$term)),$output);
1.22 www 193: }
194:
1.20 www 195: sub handler {
1.1 bowersj2 196: my $r = shift;
197:
1.2 bowersj2 198: my $docroot = $r->dir_config('lonDocRoot');
199:
1.21 www 200: &Apache::lonlocal::get_language_handle($r);
1.28 albertel 201: &Apache::loncommon::content_type($r,"text/html");
1.36 albertel 202: my $start_page=
203: &Apache::loncommon::start_page('LON-CAPA Help',undef,
204: {'only_body' => 1,});
1.21 www 205: my $text='';
206: if ($env{'form.searchterm'}=~/\w/) {
1.25 www 207: ($text,my $matches)=&listmatches($docroot,$env{'form.searchterm'},&Apache::lonlocal::current_language().'/');
208: if ($matches) {
209: my ($englishresult,$englishmatches)=&listmatches($docroot,$env{'form.searchterm'});
210: if ($englishmatches) {
211: $text.='<hr />'.$englishresult;
212: }
213: } else {
214: $text=&listmatches($docroot,$env{'form.searchterm'});
215: }
1.21 www 216: } else {
1.32 albertel 217: my $filenames = &unescape(substr($ENV{'REQUEST_URI'} ,
218: rindex($ENV{'REQUEST_URI'}, '/') + 1, -4));
1.22 www 219:
220: # Security check on the file; the whole filename must consist
221: # of nothing but alphanums, ' ,, or ., or the file
222: # will be "not found", no matter what.
223:
224: return HTTP_NOT_FOUND if ($filenames !~ /\A[-0-9a-zA-z_'',:.]+\Z/);
225:
226: # Join together the tex files, return HTTP_NOT_FOUND if any of
227: # them are not found
228: my $tex = '';
229: # Since in insertlist.tab I want to specify multiple files,
230: # and insertlist.tab also uses commas, I need something else
231: # so replace : with ,
232: $filenames =~ s/:/,/g;
233: my @files = split(/,/, $filenames);
234:
235: for my $filename (@files) {
236: if (-e $docroot.'/adm/help/tex/'.
237: &Apache::lonlocal::current_language().'/'.
238: $filename.'.tex') {
239: $filename=&Apache::lonlocal::current_language().'/'.$filename;
240: }
241: (my $file = Apache::File->new($docroot
242: . '/adm/help/tex/'.$filename.'.tex'))
1.21 www 243: or return HTTP_NOT_FOUND;
244: $tex .= join('', <$file>);
1.22 www 245: }
1.28 albertel 246:
1.36 albertel 247: $text = &render($tex, $docroot);
1.5 albertel 248: }
249:
1.13 www 250: $r->send_http_header;
1.36 albertel 251: $r->print($start_page);
1.20 www 252: &servetext($r,$text);
1.36 albertel 253: $r->print(&Apache::loncommon::end_page());
254:
1.1 bowersj2 255: return OK;
256: }
257:
258: 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