[BACK]Return to lonhelp.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonhelp.pm between versions 1.1 and 1.40

version 1.1, 2002/07/05 16:12:31 version 1.40, 2011/01/04 21:53:23
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
   #
   # $Id$
   #
 # .tex help system web server handler  # .tex help system web server handler
 #  #
 # Copyright Michigan State University Board of Trustees  # Copyright Michigan State University Board of Trustees
Line 24 Line 27
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # .tex file help handler  # .tex file help handler
 # YEAR=2002  
 # 7/4 Jeremy Bowers  
   
 package Apache::lonhelp;  package Apache::lonhelp;
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
 use Apache::File;  use Apache::File();
 use Apache::loncommon;  use Apache::loncommon();
 use tth;  use Apache::lonacc();
 use GDBM_File;  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  # This sub takes the name of a label in, and converts it to something
 # that is a valid anchor name.  # that is a valid anchor name.
 sub processLabelName   
 {  sub processLabelName {
     my ($name) = @_;      my ($name) = @_;
     $name =~ tr/a-zA-Z0-9/_/cs;      $name =~ tr/a-zA-Z0-9/_/cs;
     return $name;      return $name;
 }  }
   
 # Serve out the Tex  # Serve out the text
 sub serveTex  sub servetext {
 {      my ($r,$text) = @_;
     my ($tex, $r) = @_;      my $bugs=&Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug'));
       my $morehelp;#=&Apache::loncommon::help_open_menu(undef,undef,1,undef,undef,undef,undef,'Help and Assistance Menu');
 $r->print(<<HEADER);      my $header=&mt('LON-CAPA Help');
 <html>      $r->print(<<HEADER);
     <head>      <h3 style="font: sans-serif"><img align="right" alt="help logo"
         <title>LON-CAPA Help</title>      src="/adm/help/gif/lonhelpheader.gif"/>$header</h3><hr />
     </head>      <!-- BEGIN -->
     <body bgcolor="#FFFFFF">  
 HEADER  HEADER
   
     $r->print($tex);      $r->print($text);
   
 $r->print(<<FOOTER);      if (&Apache::lonnavmaps::advancedUser()) {
     </body>   my $search=&mt('Search LON-CAPA help');
 </html>          my $query=&mt('Search');
    my $uri = $r->uri;
    $r->print(<<FOOTER);
       <hr /><form action="$uri" method="post">
   <label>$search: <input type="text" name="searchterm" size="40" /></label><input type="submit" value="$query" />
   </form>
   <br />
   $bugs
   $morehelp
 FOOTER  FOOTER
    
       }
   
       $r->print(<<ENDBODY);
       <!-- END -->
   ENDBODY
   
 }  }
   
 # Render takes a tex fragment, transforms it for TtH, and returns the  # Render takes a tex fragment, transforms it for TtH, and returns the
 # HTML equivalent  # HTML equivalent
 sub render   sub render {
 {      my ($tex, $docroot) = @_;
     my ($tex) = @_;      tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0);
     tie (my %fragmentLabels, 'GDBM_File', '/home/httpd/html/adm/help/fragmentLabels.gdbm', 0, 0);  
   
     # This tells TtH what to do with captions, labels, and other      # This tells TtH what to do with captions, labels, and other
     # things      # things
Line 79  sub render Line 102  sub render
   
     # We process these ourselves because TtH can't handle then without      # We process these ourselves because TtH can't handle then without
     # LaTeX .aux files      # LaTeX .aux files
       # absolute paths for use with help.loncapa.org
     $tex =~ s|  \\ref\{([^}]*)\}      $tex =~ s|  \\ref\{([^}]*)\}
              |'\\href{' .                |
               substr($fragmentLabels{$1}, 0, -4) .                my $label=$1;
               '#' . processLabelName($1) .                 my $icon='/adm/help/help.png';
              '}{graphic}'                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}<a href="/adm/help/'.
                 $label .
                 $ext . 
                '"><img src="'.$icon.'" border="0" /></a>' .
                '\\end{html}'
              |gxe;               |gxe;
   
       # Backslashes
       $tex =~ s|\\textbackslash|###BACKSLASH###|g;
   
     # Figures leftover without captions      # Figures leftover without captions
     $tex =~ s|  \\includegraphics(\[[^]]*\])*\{([^}]*)\}      $tex =~ s|  \\includegraphics(\[[^]]*\])*\{([^}]*)\}
              |  '\\begin{html}<img src="gif/' . $2 . '.gif" border="2"'.               |  '\\begin{html}<img src="/adm/help/gif/' . $2 . '.gif" border="2"'.
                 ' bordercolor="#000000"/>\\end{html}'                  ' bordercolor="#000000"/>\\end{html}'
              |gxe;               |gxe;
   
     $tex = tth::tth($tex);  
       $tex=&Apache::lontexconvert::tth_converted(\$tex);
       
       # Finish backslashes
       $tex =~ s/###BACKSLASH###/'\\'/ge;
    
       # Fix the pretty quotes
       $tex =~ s/('')|(``)/&quot;/g; #" to get emacs syntax highlighter happy
   
     # For some reason all captions come out as "Figure 0:", so      # For some reason all captions come out as "Figure 0:", so
     # just duck the issue...      # just duck the issue...
   
     $tex =~ s/Figure 0://g;      $tex =~ s/Figure 0://g;
       $tex.=$Apache::lontexconvert::errorstring;
     untie %fragmentLabels;      untie %fragmentLabels;
   
     return $tex;      return $tex;
 }  }
   
 # UNCOMMENT FOR HANDLER ONLY  sub listmatches {
 sub handler      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=<FH>) {
    if ($line=~/\Q$term\E/i) {
       $line=~s/\\\w+//gs;
       $line=~s/\{//gs;
       $line=~s/\}//gs;
       $line=~s/\\/ /gs;
                       $line=~s/\</\&lt\;/gs;
                       $line=~s/\>/\&gt\;/gs;
       $line=~s/(\Q$term\E)/\<b\>$1\<\/b\>/gsi;
       $quote.='<br />...'.$line.'...';
    }
       }
       close(FH);
       if ($quote) {
    my $title=$filename;
                   $title=~s/\_/ /gs;
                   $title=~s/\.tex$//;
                   $filename=~s/\.tex$/\.hlp/;
    $output.='<li><a href="/adm/help/tex/'.$subdir.$filename.'">'.$title.'</a>'.$quote.'</li>';
       }
    }
       }
       closedir(DIR);
       return (($output?'<ul>'.$output.'</ul>':&mt('"[_1]" not found',$term)),$output);
   }
   
   sub handler {
      my $r = shift;       my $r = shift;
   
      my $filename = substr ($ENV{'REQUEST_URI'} ,        my $docroot = $r->dir_config('lonDocRoot');
     rindex($ENV{'REQUEST_URI'}, '/') + 1, -4);  
             &Apache::lonlocal::get_language_handle($r);
      # Security check on the file; the whole filename must consist       &Apache::loncommon::content_type($r,"text/html");
      # of nothing but alphanums, ' ,, or ., or the file       my $start_page=
      # will be "not found", no matter what.   &Apache::loncommon::start_page('LON-CAPA Help',undef,
         {'only_body' => 1,});
      return 404 if ($filename !~ /\A[-0-9a-zA-z_'',.]+\Z/);       my $text='';
        if ($env{'form.searchterm'}=~/\w/) {
      (my $file = Apache::File->new("/home/httpd/html/adm/help/tex/".$filename.'.tex'))   ($text,my $matches)=&listmatches($docroot,$env{'form.searchterm'},&Apache::lonlocal::current_language().'/');
  or return 404;           if ($matches) {
      my $tex = join('', <$file>);               my ($englishresult,$englishmatches)=&listmatches($docroot,$env{'form.searchterm'});
      $tex = render($tex);               if ($englishmatches) {
      $r->content_type("text/html");                  $text.='<hr />'.$englishresult;
      serveTex($tex, $r);               }
            } else {
                $text=&listmatches($docroot,$env{'form.searchterm'}); 
            }
        } else {
    my $filenames = &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>);
    }
   
    $text = &render($tex, $docroot);
        }
   
        $r->send_http_header;
        $r->print($start_page);
        &servetext($r,$text);
        $r->print(&Apache::loncommon::end_page());
   
      return OK;       return OK;
 }  }
Removed from v.1.1  
changed lines
  Added in v.1.40

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>