--- loncom/interface/lonhelp.pm 2002/07/26 19:58:52 1.3 +++ loncom/interface/lonhelp.pm 2013/12/18 01:23:21 1.42 @@ -1,4 +1,7 @@ # The LearningOnline Network with CAPA +# +# $Id: lonhelp.pm,v 1.42 2013/12/18 01:23:21 raeburn Exp $ +# # .tex help system web server handler # # Copyright Michigan State University Board of Trustees @@ -24,55 +27,98 @@ # http://www.lon-capa.org/ # # .tex file help handler -# YEAR=2002 -# 7/4 Jeremy Bowers + package Apache::lonhelp; use strict; use Apache::Constants qw(:common :http); -use Apache::File; -use Apache::loncommon; -use tth; -use GDBM_File; +use Apache::File(); +use Apache::loncommon(); +use Apache::lonacc(); +use Apache::lontexconvert(); +use Apache::lonnavmaps; # for advancedUser +use Apache::lonlocal; +use Apache::lonnet; +use tth(); +use GDBM_File(); +use lib '/home/httpd/lib/perl/'; +use LONCAPA; + # This sub takes the name of a label in, and converts it to something # that is a valid anchor name. -sub processLabelName -{ + +sub processLabelName { my ($name) = @_; $name =~ tr/a-zA-Z0-9/_/cs; return $name; } -# Serve out the Tex -sub serveTex -{ - my ($tex, $r) = @_; - -$r->print(< - - LON-CAPA Help - - +# Serve out the text +sub servetext { + my ($r,$uri,$text,$is_mobile,$firstfile) = @_; + my $bugs; + my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'], + $env{'request.role.domain'}); + if (ref($helpconfig{'helpsettings'}) eq 'HASH') { + if ($helpconfig{'helpsettings'}{'submitbugs'} eq '1') { + $bugs = &Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug')); + } + } + my %lt = &Apache::lonlocal::texthash( + header => 'LON-CAPA Help', + search => 'Search LON-CAPA help', + query => 'Search', + ); + $r->print(<help logo$lt{'header'}
HEADER + if ($is_mobile) { + my $width = 500; + my $height = 400; + my $machine = &Apache::lonnet::absolute_url(); + $r->print(&Apache::loncommon::nicescroll_javascript('helpwrapper', + {cursorcolor => '#00F', + railalign => 'right', + railoffset => '{top:5,left:40}'}, + undef,1,$machine.$firstfile)); + $r->print('
'. + $text. + '
'); + } else { + $r->print($text); + } + + if (&Apache::lonnavmaps::advancedUser()) { + $r->print(<
+
+
$lt{'search'} + + +
+
+
+
+
+
+$bugs +FOOTER + } - $r->print($tex); - -$r->print(<print(< - - -FOOTER +ENDBODY + } # Render takes a tex fragment, transforms it for TtH, and returns the # HTML equivalent -sub render -{ - my ($tex, $docroot, $serverroot) = @_; +sub render { + my ($tex, $docroot) = @_; tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0); # This tells TtH what to do with captions, labels, and other @@ -83,10 +129,28 @@ sub render # LaTeX .aux files # absolute paths for use with help.loncapa.org $tex =~ s| \\ref\{([^}]*)\} - |'\\begin{html}' . + | + my $label=$1; + my $icon='/adm/help/help.png'; + my $ext; + if ($1!~/\.hlp$/) { + if (($1 =~ /^\w+\.manual\.pdf$/) && (-e $docroot.'/adm/help/'.$1)) { + $icon = '/adm/lonIcons/pdf.gif'; + } elsif ((!exists($fragmentLabels{$1})) && ($1!~/\.hlp$/)) { + &Apache::lonnet::logthis("ERROR: $1 not a valid help label"); + $label='Error'; + } else { + $label=substr($fragmentLabels{$1}, 0, -4); + $ext = '.hlp#' . &processLabelName($1); + } + } else { + $label=~s/\.hlp$//; + $ext = '.hlp#' . &processLabelName($1); + } + '\\begin{html}' . '\\end{html}' |gxe; @@ -95,12 +159,13 @@ sub render # Figures leftover without captions $tex =~ s| \\includegraphics(\[[^]]*\])*\{([^}]*)\} - | '\\begin{html}\\end{html}' |gxe; - $tex = tth::tth($tex); + $tex=&Apache::lontexconvert::tth_converted(\$tex); + # Finish backslashes $tex =~ s/###BACKSLASH###/'\\'/ge; @@ -111,34 +176,118 @@ sub render # just duck the issue... $tex =~ s/Figure 0://g; - + $tex.=$Apache::lontexconvert::errorstring; untie %fragmentLabels; return $tex; } -sub handler -{ +sub listmatches { + my ($docroot,$term,$subdir) =@_; + unless ($subdir) { $subdir=''; } + my $output=''; + opendir(DIR,$docroot.'/adm/help/tex/'.$subdir); + foreach my $filename (sort readdir(DIR)) { + if ($filename=~/\.tex$/) { + open(FH,$docroot.'/adm/help/tex/'.$subdir.$filename); + my $quote=''; + while (my $line=) { + if ($line=~/\Q$term\E/i) { + $line=~s/\\\w+//gs; + $line=~s/\{//gs; + $line=~s/\}//gs; + $line=~s/\\/ /gs; + $line=~s/\/\>\;/gs; + $line=~s/(\Q$term\E)/\$1\<\/b\>/gsi; + $quote.='
...'.$line.'...'; + } + } + close(FH); + if ($quote) { + my $title=$filename; + $title=~s/\_/ /gs; + $title=~s/\.tex$//; + $filename=~s/\.tex$/\.hlp/; + $output.='
  • '.$title.''.$quote.'
    • '; + } + } + } + closedir(DIR); + return (($output?'
      '.$output.'
    ':&mt('"[_1]" not found',$term)),$output); +} + +sub handler { my $r = shift; my $docroot = $r->dir_config('lonDocRoot'); - my $serverroot = $ENV{'HTTP_HOST'}; - my $filename = substr ($ENV{'REQUEST_URI'} , - rindex($ENV{'REQUEST_URI'}, '/') + 1, -4); - - # Security check on the file; the whole filename must consist - # of nothing but alphanums, ' ,, or ., or the file - # will be "not found", no matter what. - - return 404 if ($filename !~ /\A[-0-9a-zA-z_'',.]+\Z/); - - (my $file = Apache::File->new($docroot . "/adm/help/tex/".$filename.'.tex')) - or return 404; - my $tex = join('', <$file>); - $tex = render($tex, $docroot, $serverroot); - $r->content_type("text/html"); - serveTex($tex, $r); + &Apache::lonlocal::get_language_handle($r); + &Apache::loncommon::content_type($r,"text/html"); + my $caller; + if ($env{'form.searchterm'}=~/\w/) { + $caller = 'search'; + } + my $starthash = { + only_body => 1, + add_entries => { + 'onload' => "javascript:expand_div('$caller');", + }, + }; + + my $firstfile; + my $start_page= + &Apache::loncommon::start_page('LON-CAPA Help',undef,$starthash); + my $text=''; + my $uri = $r->uri; + if ($env{'form.searchterm'}=~/\w/) { + ($text,my $matches)=&listmatches($docroot,$env{'form.searchterm'},&Apache::lonlocal::current_language().'/'); + if ($matches) { + my ($englishresult,$englishmatches)=&listmatches($docroot,$env{'form.searchterm'}); + if ($englishmatches) { + $text.='
    '.$englishresult; + } + } else { + $text=&listmatches($docroot,$env{'form.searchterm'}); + } + } else { + my $filenames = &unescape(substr($uri,rindex($uri,'/')+1,-4)); + + # Security check on the file; the whole filename must consist + # of nothing but alphanums, ' ,, or ., or the file + # will be "not found", no matter what. + + return HTTP_NOT_FOUND if ($filenames !~ /\A[-0-9a-zA-z_'',:.]+\Z/); + + # Join together the tex files, return HTTP_NOT_FOUND if any of + # them are not found + my $tex = ''; + # Since in insertlist.tab I want to specify multiple files, + # and insertlist.tab also uses commas, I need something else + # so replace : with , + $filenames =~ s/:/,/g; + my @files = split(/,/, $filenames); + $firstfile = '/adm/help/'.$files[0].'.hlp'; + + for my $filename (@files) { + if (-e $docroot.'/adm/help/tex/'. + &Apache::lonlocal::current_language().'/'. + $filename.'.tex') { + $filename=&Apache::lonlocal::current_language().'/'.$filename; + } + (my $file = Apache::File->new($docroot + . '/adm/help/tex/'.$filename.'.tex')) + or return HTTP_NOT_FOUND; + $tex .= join('', <$file>); + } + + $text = &render($tex, $docroot); + } + + $r->send_http_header; + $r->print($start_page); + &servetext($r,$uri,$text,$env{'browser.mobile'},$firstfile); + $r->print(&Apache::loncommon::end_page()); return OK; }