--- loncom/interface/lonindexer.pm 2001/10/16 17:03:45 1.20 +++ loncom/interface/lonindexer.pm 2001/12/13 13:59:22 1.30 @@ -1,7 +1,30 @@ # The LearningOnline Network with CAPA -# # Directory Indexer # +# $Id: lonindexer.pm,v 1.30 2001/12/13 13:59:22 harris41 Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA 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. +# +# LON-CAPA 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 LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# # YEAR=1999 # 5/21/99, 5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer) # 11/23 Gerd Kortemeyer @@ -15,16 +38,36 @@ # 6/26,7/8 H. K. Ng # 8/6,8/7,8/10 Scott Harrison # 8/14 H. K. Ng -# 8/28 Scott Harrison +# 8/28,10/15,11/28,11/29 Scott Harrison +# 11/30 Matthew Hall +# 12/11,12/13 Scott Harrison +# +### + +############################################################################### +## ## +## ORGANIZATION OF THIS PERL MODULE ## +## ## +## 1. Description of functions ## +## 2. Modules used by this module ## +## 3. Choices for different output views (detailed, summary, xml, etc) ## +## 4. BEGIN block (to be run once after compilation) ## +## 5. Handling routine called via Apache and mod_perl ## +## 6. Other subroutines ## +## ## +############################################################################### package Apache::lonindexer; +# ------------------------------------------------- modules used by this module use strict; use Apache::lonnet(); +use Apache::loncommon(); use Apache::Constants qw(:common); use Apache::File; use GDBM_File; +# ---------------------------------------- variables used throughout the module my %hash; # tied to a user-specific gdbm file my %dirs; # keys are directories, values are the open/close status my %language; # has the reference information present in language.tab @@ -37,15 +80,9 @@ my $dnum; # directory counter # ---------------------------------------------------------------------- BEGIN sub BEGIN { - my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. - '/language.tab'); - map { - $_=~/(\w+)\s+([\w\s\-]+)/; - $language{$1}=$2; - } <$fh>; } -# ---------------------------------------------------------------- Main Handler +# ----------------------------- Handling routine called via Apache and mod_perl sub handler { my $r = shift; $r->content_type('text/html'); @@ -53,8 +90,9 @@ sub handler { return OK if $r->header_only; $fnum=0; $dnum=0; + untie %hash; -# --------------------------------------------- machine configuration variables +# ------------------------------------- read in machine configuration variables my $iconpath= $r->dir_config('lonIconsURL') . "/"; my $domain = $r->dir_config('lonDefDomain'); my $role = $r->dir_config('lonRole'); @@ -197,14 +235,14 @@ ENDHEADER my %achash; my $ac=0; # some initial hashes for working with data - map { + foreach (@Acts) { my ($state,$ref)=split(/a/); $ahash{$ref}=$state; $achash{$ref}=$ac; $ac++; - } (@Acts); + } # sorting through the actions and changing the tied database hash - map { + foreach (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) { my $key=$_; if ($ahash{$key} eq '1') { $hash{'store_'.$hash{'pre_'.$key.'_link'}}= @@ -218,9 +256,9 @@ ENDHEADER delete $hash{'store_'.$hash{'pre_'.$key.'_link'}}; } } - } sort {$achash{$a}<=>$achash{$b}} (keys %ahash); + } # deleting the previously cached listing - map { + foreach (keys %hash) { if ($_ =~ /^pre_/ && $_ =~/link$/) { my $key = $_; $key =~ s/^pre_//; @@ -228,13 +266,13 @@ ENDHEADER delete $hash{'pre_'.$key.'_title'}; delete $hash{'pre_'.$key.'_link'}; } - } keys %hash; + } } -# output title +# ---------------------------------------------------------------- output title $r->print('

The LearningOnline With CAPA '. 'Network Directory Browser

'."\n"); -# get state of file attributes to be showing +# ---------------------------------- get state of file attributes to be showing if ($ENV{'form.attrs'} ne "") { for (my $i=0; $i<=6; $i++) { delete $hash{'display_attrs_'.$i}; @@ -248,7 +286,7 @@ ENDHEADER $attrchk[$i] = "checked" if $hash{'display_attrs_'.$i} == 1; } } -# output state of file attributes to be showing +# ------------------------------- output state of file attributes to be showing $r->print(<Display file attributes
END - # output starting row to the indexed file/directory hierarchy +# ----------------- output starting row to the indexed file/directory hierarchy my $titleclr="#ddffff"; $r->print("
\n"); $r->print("\n"); @@ -292,14 +330,14 @@ END if ($hash{'display_attrs_5'} == 1); $r->print(""); - # read in what directories have previously been set to "open" - map { +# ----------------- read in what directories have previously been set to "open" + foreach (keys %hash) { if ($_ =~ /^diropen_status_/) { my $key = $_; $key =~ s/^diropen_status_//; $dirs{$key} = $hash{$_}; } - } keys %hash; + } if ($ENV{'form.openuri'}) { # take care of review and refresh options my $uri=$ENV{'form.openuri'}; @@ -330,7 +368,7 @@ END $toplevel = $hash{'top.level'}; } - # if not at top level, provide an uplink arrow +# -------------------------------- if not at top level, provide an uplink arrow if ($toplevel ne "/res/"){ my (@uri_com) = split(/\//,$uri); pop @uri_com; @@ -340,18 +378,18 @@ END $indent = 1; } - # recursively go through all the directories and output as appropriate +# -------- recursively go through all the directories and output as appropriate &scanDir ($r,$toplevel,$indent,\%hash); - # information useful for group import +# ---------------------------- embed hidden information useful for group import $r->print(""); $r->print(""); - # end the tables +# -------------------------------------------------------------- end the tables $r->print("
"); $r->print("
"); - # end the output and return +# --------------------------------------------------- end the output and return $r->print("\n"); untie(%hash); } else { @@ -362,7 +400,6 @@ END return OK; } - # ----------------------------------------------- recursive scan of a directory sub scanDir { my ($r,$startdir,$indent,$hashref)=@_; @@ -416,9 +453,9 @@ sub get_list { $luri =~ s/\//_/g; if ($ENV{'form.attrs'} eq "Refresh") { - map { + foreach (keys %hash) { delete $hash{$_} if ($_ =~ /^dirlist_files_/); - } keys %hash; + } } if ($hash{'dirlist_files'.$luri}) { @@ -438,16 +475,6 @@ sub match_ext { my @fileext; my $dirptr=16384; - my $tabdir = $r->dir_config('lonTabDir'); - my $fn = $tabdir.'/filetypes.tab'; - if (-e $fn) { - my $FH=Apache::File->new($fn); - my @content=<$FH>; - foreach my $line (@content) { - (my $ext,my $foo) = split /\s+/,$line; - push @fileext,$ext; - } - } foreach my $line (@packlist) { chomp $line; $line =~ s/^\/home\/httpd\/html//; @@ -458,9 +485,9 @@ sub match_ext { my $fext = pop(@filecom); my $fnptr = $unpackline[3]&$dirptr; if ($fnptr == 0 and $unpackline[3] ne "") { - foreach my $nextline (@fileext) { - push @trimlist,$line if $nextline eq $fext; - } + my $embstyle = &Apache::loncommon::fileembstyle($fext); + push @trimlist,$line if (defined($embstyle) && + $embstyle ne 'hdn' ); } else { push @trimlist,$line; } @@ -470,7 +497,7 @@ sub match_ext { } # ------------------------------- displays one line in appropriate table format -sub display_line{ +sub display_line { my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_; my (@pathfn, $fndir, $fnptr); my $dirptr=16384; @@ -560,7 +587,14 @@ sub display_line{ # display file if ($fnptr == 0 and $filecom[3] ne "") { my @file_ext = split (/\./,$listname); - my $curfext = $file_ext[scalar(@file_ext)-1]; + my $curfext = $file_ext[-1]; + # Set the icon for the file + my $iconname = "unknown.gif"; + my $embstyle = &Apache::loncommon::fileembstyle($curfext); + # The unless conditional that follows is a bit of overkill + $iconname = $curfext.".gif" unless + (!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn'); + # my $filelink = $startdir.$filecom[0]; $r->print(""); my $metafile = grep /^$filecom[0]\.meta\&/, @list; @@ -614,7 +648,7 @@ sub display_line{ ".gif border='0' />\n") if $rem > 0; } - $r->print("\n"); + $r->print("\n"); $r->print (" $listname "); @@ -651,7 +685,7 @@ sub display_line{ if ($hash{'display_attrs_5'} == 1) { my $lang = &Apache::lonnet::metadata($filelink,'language') if ($metafile == 1); - $lang = $language{$lang}; + $lang = &Apache::loncommon::languagedescription($lang); $lang = ' ' if (!$lang); $r->print(" ".$lang. " \n"); @@ -715,28 +749,173 @@ sub begin_form { # ----------- grab unprocessed CGI variables that may have been appended to URL sub get_unprocessed_cgi { - map { + foreach (split(/&/,$ENV{'QUERY_STRING'})) { my ($name, $value) = split(/=/,$_); $value =~ tr/+/ /; $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; if ($name eq 'catalogmode' or $name eq 'launch' or $name eq 'acts') { $ENV{'form.'.$name}=$value; } - } (split(/&/,$ENV{'QUERY_STRING'})); + } } # --------- settings whenever the user causes the indexer window to be launched sub start_fresh_session { delete $hash{'mode_catalog'}; - map { + foreach (keys %hash) { if ($_ =~ /^pre_/) { delete $hash{$_}; } if ($_ =~ /^store/) { delete $hash{$_}; } - } keys %hash; + } } 1; -__END__ + +=head1 NAME + +Apache::lonindexer - mod_perl module for cross server filesystem browsing + +=head1 SYNOPSIS + +Invoked by /etc/httpd/conf/srm.conf: + + + SetHandler perl-script + PerlHandler Apache::lonindexer + + +=head1 INTRODUCTION + +This module enables a scheme of browsing across a cross server. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 BEGIN SUBROUTINE + +This routine is only run once after compilation. + +=over 4 + +=item * + +Initializes %language hash table. + +=back + +=head1 HANDLER SUBROUTINE + +This routine is called by Apache and mod_perl. + +=over 4 + +=item * + +read in machine configuration variables + +=item * + +see if called from an interactive mode + +=item * + +refresh environment with user database values (in %hash) + +=item * + +define extra fields and buttons in case of special mode + +=item * + +set catalogmodefunctions to have extra needed javascript functionality + +=item * + +print header + +=item * + +evaluate actions from previous page (both cumulatively and chronologically) + +=item * + +output title + +=item * + +get state of file attributes to be showing + +=item * + +output state of file attributes to be showing + +=item * + +output starting row to the indexed file/directory hierarchy + +=item * + +read in what directories have previously been set to "open" + +=item * + +if not at top level, provide an uplink arrow + +=item * + +recursively go through all the directories and output as appropriate + +=item * + +information useful for group import + +=item * + +end the tables + +=item * + +end the output and return + +=back + +=head1 OTHER SUBROUTINES + +=over 4 + +=item * + +scanDir - recursive scan of a directory + +=item * + +get_list - get complete matched list based on the uri (returns an array) + +=item * + +match_ext - filters out files based on extensions (returns an array) + +=item * + +display_line - displays one line in appropriate table format + +=item * + +begin_form - prints the beginning of a form for directory or file link + +=item * + +get_unprocessed_cgi - grab unprocessed CGI variables that may have been +appended to URL + +=item * + +start_fresh_session - settings whenever the user causes the indexer window +to be launched + +=back + +=cut