Annotation of loncom/interface/lonhelp.pm, revision 1.46
1.1 bowersj2 1: # The LearningOnline Network with CAPA
1.27 www 2: #
1.46 ! raeburn 3: # $Id: lonhelp.pm,v 1.45 2016/08/20 14:28:52 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 {
1.42 raeburn 60: my ($r,$uri,$text,$is_mobile,$firstfile) = @_;
61: my $bugs;
62: my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'],
63: $env{'request.role.domain'});
64: if (ref($helpconfig{'helpsettings'}) eq 'HASH') {
65: if ($helpconfig{'helpsettings'}{'submitbugs'} eq '1') {
66: $bugs = &Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug'));
67: }
68: }
69: my %lt = &Apache::lonlocal::texthash(
70: header => 'LON-CAPA Help',
71: search => 'Search LON-CAPA help',
72: query => 'Search',
73: );
1.16 albertel 74: $r->print(<<HEADER);
1.26 albertel 75: <h3 style="font: sans-serif"><img align="right" alt="help logo"
1.42 raeburn 76: src="/adm/help/gif/lonhelpheader.gif" />$lt{'header'}</h3><hr />
1.2 bowersj2 77: <!-- BEGIN -->
1.1 bowersj2 78: HEADER
1.41 raeburn 79: if ($is_mobile) {
80: my $width = 500;
81: my $height = 400;
82: my $machine = &Apache::lonnet::absolute_url();
83: $r->print(&Apache::loncommon::nicescroll_javascript('helpwrapper',
84: {cursorcolor => '#00F',
85: railalign => 'right',
86: railoffset => '{top:5,left:40}'},
87: undef,1,$machine.$firstfile));
88: $r->print('<div id="helpwrapper" style="height:'.$height.'px; width:'.$width.'px; overflow: auto;">'.
89: $text.
90: '</div>');
91: } else {
92: $r->print($text);
93: }
1.1 bowersj2 94:
1.19 albertel 95: if (&Apache::lonnavmaps::advancedUser()) {
1.42 raeburn 96: $r->print(<<FOOTER);
97: <hr /><div class="LC_left_float">
98: <form action="$uri" method="post">
99: <fieldset><legend>$lt{'search'}</legend>
100: <input type="text" name="searchterm" size="40" />
101: <input type="submit" value="$lt{'query'}" />
102: </fieldset>
103: </form>
104: </div>
1.44 bisitz 105: <div class="LC_left_float">
1.42 raeburn 106: </div>
107: <div style="padding:0;clear:both;margin:0;border:0"></div>
1.30 www 108: $bugs
1.1 bowersj2 109: FOOTER
1.24 albertel 110: }
111:
112: $r->print(<<ENDBODY);
1.9 bowersj2 113: <!-- END -->
1.20 www 114: ENDBODY
1.24 albertel 115:
1.1 bowersj2 116: }
117:
118: # Render takes a tex fragment, transforms it for TtH, and returns the
119: # HTML equivalent
1.20 www 120: sub render {
1.36 albertel 121: my ($tex, $docroot) = @_;
1.2 bowersj2 122: tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0);
1.1 bowersj2 123:
124: # This tells TtH what to do with captions, labels, and other
125: # things
126: $tex = "\\documentclass{article}\n" . $tex;
127:
128: # We process these ourselves because TtH can't handle then without
129: # LaTeX .aux files
1.2 bowersj2 130: # absolute paths for use with help.loncapa.org
1.1 bowersj2 131: $tex =~ s| \\ref\{([^}]*)\}
1.15 albertel 132: |
1.30 www 133: my $label=$1;
1.40 raeburn 134: my $icon='/adm/help/help.png';
135: my $ext;
1.30 www 136: if ($1!~/\.hlp$/) {
1.40 raeburn 137: if (($1 =~ /^\w+\.manual\.pdf$/) && (-e $docroot.'/adm/help/'.$1)) {
138: $icon = '/adm/lonIcons/pdf.gif';
139: } elsif ((!exists($fragmentLabels{$1})) && ($1!~/\.hlp$/)) {
1.30 www 140: &Apache::lonnet::logthis("ERROR: $1 not a valid help label");
141: $label='Error';
142: } else {
143: $label=substr($fragmentLabels{$1}, 0, -4);
1.40 raeburn 144: $ext = '.hlp#' . &processLabelName($1);
1.30 www 145: }
146: } else {
147: $label=~s/\.hlp$//;
1.40 raeburn 148: $ext = '.hlp#' . &processLabelName($1);
1.30 www 149: }
1.33 albertel 150: '\\begin{html}<a href="/adm/help/'.
1.30 www 151: $label .
1.40 raeburn 152: $ext .
1.44 bisitz 153: '"><img src="'.$icon.'" border="0" alt="'.&mt('Help').'" /></a>' .
1.2 bowersj2 154: '\\end{html}'
1.1 bowersj2 155: |gxe;
156:
1.3 bowersj2 157: # Backslashes
158: $tex =~ s|\\textbackslash|###BACKSLASH###|g;
159:
1.1 bowersj2 160: # Figures leftover without captions
161: $tex =~ s| \\includegraphics(\[[^]]*\])*\{([^}]*)\}
1.33 albertel 162: | '\\begin{html}<img src="/adm/help/gif/' . $2 . '.gif" border="2"'.
1.1 bowersj2 163: ' bordercolor="#000000"/>\\end{html}'
164: |gxe;
165:
1.3 bowersj2 166:
1.17 albertel 167: $tex=&Apache::lontexconvert::tth_converted(\$tex);
1.5 albertel 168:
1.3 bowersj2 169: # Finish backslashes
170: $tex =~ s/###BACKSLASH###/'\\'/ge;
171:
172: # Fix the pretty quotes
173: $tex =~ s/('')|(``)/"/g; #" to get emacs syntax highlighter happy
1.1 bowersj2 174:
1.45 raeburn 175: $tex =~ s/`/'/g;
176:
1.1 bowersj2 177: # For some reason all captions come out as "Figure 0:", so
178: # just duck the issue...
179:
180: $tex =~ s/Figure 0://g;
1.34 albertel 181: $tex.=$Apache::lontexconvert::errorstring;
1.1 bowersj2 182: untie %fragmentLabels;
183:
184: return $tex;
185: }
186:
1.22 www 187: sub listmatches {
1.25 www 188: my ($docroot,$term,$subdir) =@_;
189: unless ($subdir) { $subdir=''; }
1.22 www 190: my $output='';
1.25 www 191: opendir(DIR,$docroot.'/adm/help/tex/'.$subdir);
1.22 www 192: foreach my $filename (sort readdir(DIR)) {
193: if ($filename=~/\.tex$/) {
1.25 www 194: open(FH,$docroot.'/adm/help/tex/'.$subdir.$filename);
1.22 www 195: my $quote='';
196: while (my $line=<FH>) {
197: if ($line=~/\Q$term\E/i) {
198: $line=~s/\\\w+//gs;
199: $line=~s/\{//gs;
200: $line=~s/\}//gs;
201: $line=~s/\\/ /gs;
1.25 www 202: $line=~s/\</\<\;/gs;
203: $line=~s/\>/\>\;/gs;
1.29 albertel 204: $line=~s/(\Q$term\E)/\<b\>$1\<\/b\>/gsi;
1.22 www 205: $quote.='<br />...'.$line.'...';
206: }
207: }
208: close(FH);
209: if ($quote) {
210: my $title=$filename;
211: $title=~s/\_/ /gs;
212: $title=~s/\.tex$//;
213: $filename=~s/\.tex$/\.hlp/;
1.25 www 214: $output.='<li><a href="/adm/help/tex/'.$subdir.$filename.'">'.$title.'</a>'.$quote.'</li>';
1.22 www 215: }
216: }
217: }
218: closedir(DIR);
1.25 www 219: return (($output?'<ul>'.$output.'</ul>':&mt('"[_1]" not found',$term)),$output);
1.22 www 220: }
221:
1.20 www 222: sub handler {
1.1 bowersj2 223: my $r = shift;
224:
1.2 bowersj2 225: my $docroot = $r->dir_config('lonDocRoot');
226:
1.21 www 227: &Apache::lonlocal::get_language_handle($r);
1.28 albertel 228: &Apache::loncommon::content_type($r,"text/html");
1.41 raeburn 229: my $caller;
230: if ($env{'form.searchterm'}=~/\w/) {
231: $caller = 'search';
232: }
233:
1.43 raeburn 234: my $starthash;
235:
236: if ($env{'browser.mobile'}) {
237: $starthash = {
238: only_body => 1,
239: add_entries => {
240: 'onload' => "javascript:expand_div('$caller');",
241: },
242: };
243: } else {
244: $starthash = {
245: only_body => 1,
246: };
247: }
1.41 raeburn 248: my $firstfile;
1.36 albertel 249: my $start_page=
1.41 raeburn 250: &Apache::loncommon::start_page('LON-CAPA Help',undef,$starthash);
1.21 www 251: my $text='';
1.42 raeburn 252: my $uri = $r->uri;
1.21 www 253: if ($env{'form.searchterm'}=~/\w/) {
1.25 www 254: ($text,my $matches)=&listmatches($docroot,$env{'form.searchterm'},&Apache::lonlocal::current_language().'/');
255: if ($matches) {
256: my ($englishresult,$englishmatches)=&listmatches($docroot,$env{'form.searchterm'});
257: if ($englishmatches) {
258: $text.='<hr />'.$englishresult;
259: }
260: } else {
261: $text=&listmatches($docroot,$env{'form.searchterm'});
262: }
1.21 www 263: } else {
1.42 raeburn 264: my $filenames = &unescape(substr($uri,rindex($uri,'/')+1,-4));
1.22 www 265:
266: # Security check on the file; the whole filename must consist
267: # of nothing but alphanums, ' ,, or ., or the file
268: # will be "not found", no matter what.
269:
270: return HTTP_NOT_FOUND if ($filenames !~ /\A[-0-9a-zA-z_'',:.]+\Z/);
271:
272: # Join together the tex files, return HTTP_NOT_FOUND if any of
273: # them are not found
274: my $tex = '';
275: # Since in insertlist.tab I want to specify multiple files,
276: # and insertlist.tab also uses commas, I need something else
277: # so replace : with ,
278: $filenames =~ s/:/,/g;
279: my @files = split(/,/, $filenames);
1.41 raeburn 280: $firstfile = '/adm/help/'.$files[0].'.hlp';
1.46 ! raeburn 281: my $count = 0;
1.41 raeburn 282:
1.22 www 283: for my $filename (@files) {
284: if (-e $docroot.'/adm/help/tex/'.
285: &Apache::lonlocal::current_language().'/'.
286: $filename.'.tex') {
287: $filename=&Apache::lonlocal::current_language().'/'.$filename;
288: }
289: (my $file = Apache::File->new($docroot
290: . '/adm/help/tex/'.$filename.'.tex'))
1.21 www 291: or return HTTP_NOT_FOUND;
292: $tex .= join('', <$file>);
1.46 ! raeburn 293: $count ++;
! 294: if (scalar(@files) > $count) {
! 295: $tex .= '\hrulefill';
! 296: }
1.22 www 297: }
1.28 albertel 298:
1.36 albertel 299: $text = &render($tex, $docroot);
1.5 albertel 300: }
301:
1.13 www 302: $r->send_http_header;
1.36 albertel 303: $r->print($start_page);
1.42 raeburn 304: &servetext($r,$uri,$text,$env{'browser.mobile'},$firstfile);
1.36 albertel 305: $r->print(&Apache::loncommon::end_page());
306:
1.1 bowersj2 307: return OK;
308: }
309:
310: 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