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

Diff for /loncom/interface/lonhelp.pm between versions 1.5 and 1.48

version 1.5, 2003/02/25 22:50:11 version 1.48, 2022/05/29 20:48:57
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;
   
Line 35  use Apache::File(); Line 37  use Apache::File();
 use Apache::loncommon();  use Apache::loncommon();
 use Apache::lonacc();  use Apache::lonacc();
 use Apache::lontexconvert();  use Apache::lontexconvert();
   use Apache::lonnavmaps; # for advancedUser
   use Apache::lonlocal;
   use Apache::lonnet;
 use tth();  use tth();
 use GDBM_File();  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,$uri,$text,$is_mobile,$firstfile) = @_;
     my ($tex, $r) = @_;      my $bugs;
       my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'],
 $r->print(<<HEADER);                                                $env{'request.role.domain'});
 <html>      if (ref($helpconfig{'helpsettings'}) eq 'HASH') {
     <head>          if ($helpconfig{'helpsettings'}{'submitbugs'} eq '1') {
         <title>LON-CAPA Help</title>              $bugs = &Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug'));
     </head>          }
     <body bgcolor="#FFFFFF">      }
     <h3 style="font: sans-serif"><img align="right"      my %lt = &Apache::lonlocal::texthash(
     src="/adm/help/gif/lonhelpheader.gif"/>LON-CAPA Help<hr /></h3>                                             header  => 'LON-CAPA Help',
                                              search  => 'Search LON-CAPA help',
                                              query   => 'Search',
                                           );
       my $goback;
       if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
           (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
           my $backicon = &Apache::loncommon::lonhttpdurl($r->dir_config('lonIconsURL').'/').'clickhere.gif';
           $goback = '<a href="javascript:history.go(-1);" class="LC_menubuttons_link" title="Go Back">'.
                     '<img src="'.$backicon.'" alt="'.&mt('Go Back').'" class="LC_icon" border="0" />'.
                     '</a>&nbsp;';
       }
       $r->print(<<HEADER);
       <h3 style="font: sans-serif"><img align="right" alt="help logo"
       src="/adm/help/gif/lonhelpheader.gif" />$goback$lt{'header'}</h3><hr />
     <!-- BEGIN -->      <!-- BEGIN -->
 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('<div id="helpwrapper" style="height:'.$height.'px; width:'.$width.'px; overflow: auto;">'.
                     $text.
                     '</div>');
       } else {
           $r->print($text);
       }
   
       if (&Apache::lonnavmaps::advancedUser()) {
           $r->print(<<FOOTER);
       <hr /><div class="LC_left_float">
       <form action="$uri" method="post">
       <fieldset><legend>$lt{'search'}</legend>
       <input type="text" name="searchterm" size="40" />
       <input type="submit" value="$lt{'query'}" />
       </fieldset>
       </form>
       </div>
       <div class="LC_left_float">
       </div>
       <div style="padding:0;clear:both;margin:0;border:0"></div>
   $bugs
   FOOTER
       }
   
     $r->print($tex);      $r->print(<<ENDBODY);
   
 $r->print(<<FOOTER);  
     <!-- END -->      <!-- END -->
     <hr />  ENDBODY
     <center><font size="-1"><a href="/adm/help/abouthelp.html">About  
     LON-CAPA help and More Help</a></font></center>  
     </body>  
 </html>  
 FOOTER  
 }  }
   
 # 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, $docroot, $serverroot) = @_;  
     tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0);      tie (my %fragmentLabels, 'GDBM_File', $docroot . '/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
Line 90  sub render Line 137  sub render
     # LaTeX .aux files      # LaTeX .aux files
     # absolute paths for use with help.loncapa.org      # absolute paths for use with help.loncapa.org
     $tex =~ s|  \\ref\{([^}]*)\}      $tex =~ s|  \\ref\{([^}]*)\}
              |'\\begin{html}<a href="http://' . $serverroot ."/adm/help/".               |
               substr($fragmentLabels{$1}, 0, -4) .                my $label=$1;
               '.hlp#' . processLabelName($1) .                 my $icon='/adm/help/help.png';
              '"><img src="http://' . $serverroot . '/adm/help/gif/smallHelp.gif" border="0" /></a>' .                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" alt="'.&mt('Help').'" /></a>' .
              '\\end{html}'               '\\end{html}'
              |gxe;               |gxe;
   
Line 102  sub render Line 167  sub render
   
     # Figures leftover without captions      # Figures leftover without captions
     $tex =~ s|  \\includegraphics(\[[^]]*\])*\{([^}]*)\}      $tex =~ s|  \\includegraphics(\[[^]]*\])*\{([^}]*)\}
              |  '\\begin{html}<img src="http://' . $serverroot . '/adm/help/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=&Apache::lontexconvert::converted(\$tex);      $tex=&Apache::lontexconvert::tth_converted(\$tex);
           
     # Finish backslashes      # Finish backslashes
     $tex =~ s/###BACKSLASH###/'\\'/ge;      $tex =~ s/###BACKSLASH###/'\\'/ge;
Line 115  sub render Line 180  sub render
     # Fix the pretty quotes      # Fix the pretty quotes
     $tex =~ s/('')|(``)/&quot;/g; #" to get emacs syntax highlighter happy      $tex =~ s/('')|(``)/&quot;/g; #" to get emacs syntax highlighter happy
   
       $tex =~ s/`/'/g;
   
     # 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;      $tex.=$Apache::lontexconvert::errorstring;
     untie %fragmentLabels;      untie %fragmentLabels;
   
     return $tex;      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=<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 $docroot = $r->dir_config('lonDocRoot');       my $docroot = $r->dir_config('lonDocRoot');
      my $serverroot = $ENV{'HTTP_HOST'};  
   
      my $filename = substr ($ENV{'REQUEST_URI'} ,        &Apache::lonlocal::get_language_handle($r);
     rindex($ENV{'REQUEST_URI'}, '/') + 1, -4);       &Apache::loncommon::content_type($r,"text/html");
             my $caller;
      # Security check on the file; the whole filename must consist       if ($env{'form.searchterm'}=~/\w/) {
      # of nothing but alphanums, ' ,, or ., or the file          $caller = 'search';
      # will be "not found", no matter what.       }
        
      return HTTP_NOT_FOUND if ($filename !~ /\A[-0-9a-zA-z_'',.]+\Z/);       my $starthash;
   
      (my $file = Apache::File->new($docroot . "/adm/help/tex/".$filename.'.tex'))       if ($env{'browser.mobile'}) {
  or return HTTP_NOT_FOUND;           $starthash = {
                           only_body   => 1,
      # get me my environment if it exists                          add_entries => {
      &Apache::lonacc::handler($r);                                           'onload' => "javascript:expand_div('$caller');",
                                          },
      if ($ENV{'browser.mathml'}) {                        };
  $r->content_type('text/xml');       } else {
  &tth::ttminit();           $starthash = {
  if ($ENV{'browser.unicode'}) {                          only_body   => 1,
      &tth::ttmoptions('-L -u1');                        };
  } else {       }
      &tth::ttmoptions('-L -u0');       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.='<hr />'.$englishresult;
                }
            } else {
                $text=&listmatches($docroot,$env{'form.searchterm'}); 
            }
      } else {       } else {
  $r->content_type("text/html");           my $filenames = &unescape(substr($uri,rindex($uri,'/')+1,-4));
  &tth::tthinit();    
  if ($ENV{'browser.unicode'}) {   # Security check on the file; the whole filename must consist
      &tth::tthoptions('-L -u1');   # of nothing but alphanums, ' ,, or ., or the file
  } else {   # will be "not found", no matter what.
      &tth::tthoptions('-L -u0');    
    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';
            my $count = 0;
   
    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>);
                $count ++;
                if (scalar(@files) > $count) {
                    $tex .= '\hrulefill';
                }
  }   }
   
    $text = &render($tex, $docroot);
      }       }
   
      my $tex = join('', <$file>);       $r->send_http_header;
      $tex = render($tex, $docroot, $serverroot);       $r->print($start_page);
      serveTex($tex, $r);       &servetext($r,$uri,$text,$env{'browser.mobile'},$firstfile);
        $r->print(&Apache::loncommon::end_page());
   
      return OK;       return OK;
 }  }
Removed from v.1.5  
changed lines
  Added in v.1.48

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