--- loncom/interface/lonhelp.pm 2002/07/05 16:12:31 1.1 +++ loncom/interface/lonhelp.pm 2006/04/03 02:04:55 1.25 @@ -31,47 +31,68 @@ 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(); # 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,$text) = @_; + my $bugs=&Apache::loncommon::help_open_bug('Documentation'); + my $start_page= + &Apache::loncommon::start_page('LON-CAPA Help',undef, + {'only_body' => 1,}); + my $end_page= + &Apache::loncommon::end_page(); + my $header=&mt('LON-CAPA Help'); + $r->print(<$header
$bugs + HEADER - $r->print($tex); + $r->print($text); -$r->print(< - + if (&Apache::lonnavmaps::advancedUser()) { + my $search=&mt('Search LON-CAPA help'); + my $about=&mt('About LON-CAPA help and More Help'); + my $query=&mt('Search'); + $r->print(<
+$search:
+$about FOOTER + + } + + $r->print(< + $end_page +ENDBODY + } # Render takes a tex fragment, transforms it for TtH, and returns the # HTML equivalent -sub render -{ - my ($tex) = @_; - tie (my %fragmentLabels, 'GDBM_File', '/home/httpd/html/adm/help/fragmentLabels.gdbm', 0, 0); +sub render { + my ($tex, $docroot, $serverroot) = @_; + tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0); # This tells TtH what to do with captions, labels, and other # things @@ -79,52 +100,154 @@ sub render # We process these ourselves because TtH can't handle then without # LaTeX .aux files + # absolute paths for use with help.loncapa.org $tex =~ s| \\ref\{([^}]*)\} - |'\\href{' . + | + if (not(exists($fragmentLabels{$1}))) { + &Apache::lonnet::logthis("ERROR: $1 not a valid help label"); + }; + '\\begin{html}' . + '\\end{html}' |gxe; + # Backslashes + $tex =~ s|\\textbackslash|###BACKSLASH###|g; + # 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; + + # Fix the pretty quotes + $tex =~ s/('')|(``)/"/g; #" to get emacs syntax highlighter happy # For some reason all captions come out as "Figure 0:", so # just duck the issue... $tex =~ s/Figure 0://g; - + $tex.=$Apache::lontexconvert::errorstring; untie %fragmentLabels; return $tex; } -# UNCOMMENT FOR HANDLER ONLY -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/(\Q$term\E)/\$1\<\/b\>/gsi; + $line=~s/\/\>\;/gs; + $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 $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("/home/httpd/html/adm/help/tex/".$filename.'.tex')) - or return 404; - my $tex = join('', <$file>); - $tex = render($tex); - $r->content_type("text/html"); - serveTex($tex, $r); + my $docroot = $r->dir_config('lonDocRoot'); + my $serverroot = $ENV{'HTTP_HOST'}; + + &Apache::lonlocal::get_language_handle($r); + my $text=''; + if ($env{'form.searchterm'}=~/\w/) { + &Apache::loncommon::content_type($r,"text/html"); + ($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 = &Apache::lonnet::unescape(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 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); + + 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>); + } + + if ($env{'browser.mathml'}) { + &Apache::loncommon::content_type($r,'text/xml'); + &tth::ttminit(); + if ($env{'browser.unicode'}) { + &tth::ttmoptions('-L -u1'); + } else { + &tth::ttmoptions('-L -u0'); + } + } else { + &Apache::loncommon::content_type($r,"text/html"); + &tth::tthinit(); + if ($env{'browser.unicode'}) { + &tth::tthoptions('-L -u1'); + } else { + &tth::tthoptions('-L -u0'); + } + } + $text = &render($tex, $docroot, $serverroot); + } + $r->send_http_header; + &servetext($r,$text); return OK; }