Bommels05/Mozilla
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adding dawn@cannibal.mi.org's mods to add the option to grab file

Browse Source 
and directory descriptions from README.html files. Descriptions of
directories are enclosed by <SPAN CLASS=LXRLONGDESC>...</SPAN> and file
descriptions by <SPAN CLASS=LXRSHORTDESC>...</SPAN>


git-svn-id: svn://10.0.0.236/trunk@14426 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
leaf%mozilla.org
1998-11-11 17:33:24 +00:00
parent 04604b55c5
commit 99e1c93a53
2 changed files with 139 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
mozilla/webtools/lxr/INSTALL
View File

@@ -1,3 +1,8 @@
This INSTALL file is customized for the version of lxr used by
mozilla.org. The original version can be found at
http://lxr.linux.no/
In order to install LXR, you will need:
- Perl version 5 or later.
@@ -25,33 +30,42 @@ featured webservers should do as well.
To install LXR itself:
- Set the variables PERLBIN and INSTALLPREFIX in the makefile to
reflect where the Perl 5 binary is located on your system and where
you want the LXR files to be installed.
- Retrieve the lxr source via anonymous cvs from mozilla.org's
server from mozilla/webtools/lxr. Find out about anonymous
cvs at mozilla.org at http://www.mozilla.org/cvs.html
- Do "make install".
- Edit lxr.conf to fit your source code installations and needs.
- Edit $(INSTALLPREFIX)/http/lxr.conf to fit your source code
installations and needs.
- Make sure the files in http can be reached via your webserver.
Make sure your webserver executes the files search, source, ident
and diff as cgi-scripts. With the Apache webserver this can be
accomplished by making .htaccess contain the following lines:
- Make sure the files in $(INSTALLPREFIX)/http can be reached via
your webserver. Make sure your webserver executes the files
search, source, ident and diff as cgi-scripts. With the Apache
webserver this can be accomplished by making
$(INSTALLPREFIX)/http/.htaccess contain the following lines:
<Files ~ (search|source|ident|diff)$>
SetHandler cgi-script
</Files>
<Files ~ (search|source|ident|diff)$>
SetHandler cgi-script
</Files>
You may also need to edit these Apache config files appropriately
srm.conf
AddHandler cgi-script .cgi
access.conf
Options <whatever> # setting to all will work
AllowOverride Options
Its also recommended to set up a robots.txt file on your server to
discourage robots from traversing your source tree and performing
an identifier lookup for each identifier in your code. This will
take up a lot of cpu time and probably several gigabytes of files.
- Generate the identifier database. Go to the directory you
configured as "dbdir" and do "$(INSTALLPREFIX)/bin/genxref foo",
where foo is the subdirectory containing the actual source code.
configured as "dbdir" in lxr.conf and do "genxref foo", where foo
is the subdirectory containing the actual source code.
- (Optional) Generate the Glimpse database. Go to the directory you
configured as "dbdir" and do "glimpseindex -H . foo", where foo is
the same as above. You might want to add other options to the
commandline (e.g. "-n"), see the Glimpse documentation for details.
configured as "dbdir" in lxr.conf and do "glimpseindex -H . foo",
where foo is the same as above. You might want to add other options
to the commandline (e.g. "-n"), see the Glimpse documentation for details.
If it doesn't work:
@@ -72,19 +86,38 @@ The lxr.conf file:
LXR recognizes the following options in the configuration file.
baseurl
The url for the root directory of your source.
htmlhead
The header of all html files. This is a template that
contains mainly html code but it can also contain some special
directives, these are documented below.
sourcehead
A special version of htmlhead used for source code listings.
sourcedirhead
A special version of htmlhead used for directory listings.
htmltail
Template for bottom of pages.
htmldir
Template for the directory listing.
Template file for the directory listings.
sourceroot
The root of the source that you want to index.
The root directory of the source to be indexed. If you're indexing
several version you could include a variable in the path.
sourceroot: /usr/local/lxr/source/$v/linux/
virtroot
This is prepended to the path name when forming the url in links.
bonsaihome
If bonsai is set up for your code then set this as the url prefix. If not,
then remove the bonsai related code in the htmlhead file and ignore this.
More info on bonsai can be found at http://www.mozilla.org/bonsai.html
sourcerootname
The name of the root (more....)
@@ -103,15 +136,22 @@ The lxr.conf file:
This defines a variable that can be used in templates and
the config file. The syntax is
variable: <name>, <text>, <values>, <default>
<name> is the name of the variable, <text> is a textual description,
<name> is the name of the variable, <text> is a textual description,
<values> are the possible values of the variable.
<default> is the default value of the variable.
<default> is the default value of the variable.
The <values> field can either be a list starting with a "(" and
ending with a ")", with elements separated with ",", or it can be
[ <filename> ]. In this case the values are read from a file with
one value on each line.
EXAMPLE:
# Define typed variable "v", read valueset from file.
variable: v, Version, [/local/lxr/source/versions], [/local/lxr/source/defversion]
# Define typed variable "a". First value is default.
variable: a, Architecture, (i386, alpha, m68k, mips, ppc, sparc, sparc64)
map - This makes it possible to rewrite directories using variables.
The linux sourcecode for instance contains several different
architectures, the include files for each of these are found in the

102
mozilla/webtools/lxr/Local.pm
View File

@@ -1,22 +1,9 @@
#!/usr/bonsaitools/bin/perl
# $Id: Local.pm,v 1.2 1998-09-09 05:14:57 jwz%mozilla.org Exp $
# $Id: Local.pm,v 1.3 1998-11-11 17:33:24 leaf%mozilla.org Exp $
# Local.pm -- Subroutines that need to be customized for each installation
#
# Dawn Endico <dawn@cannibal.mi.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
######################################################################
# This package is for placing subroutines that are likely to need
# to be customized for each installation. In particular, the file
@@ -232,6 +219,27 @@ sub descexpand {
my $linecount=0;
local $desc= "";
if (open(DESC, $Path->{'real'}. $filename."/README.html")) {
undef $/;
$desc = <DESC>;
$/ = "\n";
close(DESC);
# Make sure there is no <span> embedded in our string. If so
# then we've matched against the wrong /span and this string is junk
# so we'll throw it away and refrain from writing a descrioption.
# Disallowing embedded spans theoretically removes some flexibility
# but this seems to be a little used tag and doing this makes lxr
# a lot faster.
if ($desc =~ /<SPAN CLASS=LXRSHORTDESC>(.*?)<\/SPAN>/is) {
$short = $1;
if (!($short =~ /\<span/is)) {
return ($short);
}
}
}
$desc = "";
if (open(FILE, $Path->{'real'}. $filename."README")) {
$path = $Path->{'virt'}.$filename;
$path =~ s#/(.+)/#$1#;
@@ -278,7 +286,54 @@ sub descexpand {
# inventing strict rules which create gobbeldygook when they're broken.
sub dirdesc {
my ($path) = @_;
my $string;
if (-f $Path->{'real'}."/README") {
descreadme($path);
} elsif (-f $Path->{'real'}."/README.html") {
descreadmehtml($path);
}
}
sub descreadmehtml {
my ($path) = @_;
my $string = "";
if (!(open(DESC, $Path->{'real'}."/README.html"))) {
return;
}
undef $/;
$string = <DESC>;
$/ = "\n";
close(DESC);
# if the README is 0 length then give up
if (!$string) {
return;
}
# check if there's a short desc nested inside the long desc. If not, do
# a non-greedy search for a long desc. assume there are no other stray
# spans within the description.
if ($string =~ /<SPAN CLASS=LXRLONGDESC>(.*?<SPAN CLASS=LXRSHORTDESC>.*?<\/SPAN>.*?)<\/SPAN>/is) {
$long = $1;
if (!($long =~ /<span.*?\<span/is)) {
print($long . "<P>\nSEE ALSO: <A HREF=\"README.html\">README</A>\n");
}
} elsif ($string =~ /<SPAN CLASS=LXRLONGDESC>(.*?)<\/SPAN>/is) {
$long = $1;
if (!($long =~ /\<span/is)) {
print($long . "<P>\nSEE ALSO: <A HREF=\"README.html\">README</A>\n");
}
}
}
sub descreadme {
my ($path) = @_;
my $string = "";
# $string =~ s#(</?([^>^\s]+[^>]*)>.*$)#($2~/B|A|IMG|FONT|BR|EM|I|TT/i)?$1:""#sg;
my $n;
my $count;
my $temp;
@@ -287,20 +342,13 @@ sub dirdesc {
my $minlines = 5; # Too small. Go back and add another paragraph.
my $chopto = 10; # Truncate long READMEs to this length
if (-f $Path->{'real'}."/README") {
if (!(open(DESC, $Path->{'real'}."/README"))) {
return;
}
# dme: mozillaism: need to name the readme in the root directory
# something else since there is already a directory by that name.
} elsif (!(open(DESC, $Path->{'real'}."/README.moz"))) {
return;
if (!(open(DESC, $Path->{'real'}."/README"))) {
return;
}
while(<DESC>){
$string = $string . $_;
}
undef $/;
$string = <DESC>;
$/ = "\n";
close(DESC);
# if the README is 0 length then give up