--- loncom/interface/lonindexer.pm 2001/11/01 15:59:11 1.22 +++ loncom/interface/lonindexer.pm 2002/06/20 21:22:20 1.44 @@ -1,7 +1,30 @@ # The LearningOnline Network with CAPA -# # Directory Indexer # +# $Id: lonindexer.pm,v 1.44 2002/06/20 21:22:20 ng 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,38 @@ # 6/26,7/8 H. K. Ng # 8/6,8/7,8/10 Scott Harrison # 8/14 H. K. Ng -# 8/28,10/15 Scott Harrison +# 8/28,10/15,11/28,11/29 Scott Harrison +# 11/30 Matthew Hall +# 12/11,12/13 Scott Harrison +# YEAR=2002 +# 1/17 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 @@ -35,17 +80,12 @@ my $extrafield; # default extra table ce my $fnum; # file counter 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>; -} +# ----- Used to include or exclude files with certain extensions. +my @Only = (); +my @Omit = (); + -# ---------------------------------------------------------------- Main Handler +# ----------------------------- Handling routine called via Apache and mod_perl sub handler { my $r = shift; $r->content_type('text/html'); @@ -55,7 +95,12 @@ sub handler { $dnum=0; untie %hash; -# --------------------------------------------- machine configuration variables + # Deal with stupid global variables (is there a way around making + # these global to this package? It is just so wrong....) + undef (@Only); + undef (@Omit); + +# ------------------------------------- read in machine configuration variables my $iconpath= $r->dir_config('lonIconsURL') . "/"; my $domain = $r->dir_config('lonDefDomain'); my $role = $r->dir_config('lonRole'); @@ -71,8 +116,11 @@ sub handler { my $uri=$r->uri; # -------------------------------------- see if called from an interactive mode - &get_unprocessed_cgi(); - + # Get the parameters from the query string + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['catalogmode','launch','acts','mode','form','element', + 'only','omit']); + #------------------------------------------------------------------- my $closebutton=''; my $groupimportbutton=''; my $colspan=''; @@ -84,8 +132,7 @@ sub handler { if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { if ($ENV{'form.launch'} eq '1') { &start_fresh_session(); - } - + } # -------------------- refresh environment with user database values (in %hash) if ($hash{'mode_catalog'} eq 'interactive') { $ENV{'form.catalogmode'}='interactive'; @@ -119,35 +166,136 @@ END onClick="javascript:select_group()"> END } - + # Additions made by Matthew to make the browser a little easier to deal + # with in the future. + # + # $mode (at this time) indicates if we are in edit mode. + # $form is the name of the form that the URL is placed when the + # selection is made. + # $element is the name of the element in $formname which receives + # the URL. + # &Apache::lonxml::debug('Checking mode, form, element'); + &setvalues(\%hash,'form_mode' ,\%ENV,'form.mode' ); + &setvalues(\%hash,'form_form' ,\%ENV,'form.form' ); + &setvalues(\%hash,'form_element',\%ENV,'form.element'); + &setvalues(\%hash,'form_only' ,\%ENV,'form.only' ); + &setvalues(\%hash,'form_omit' ,\%ENV,'form.omit' ); + + # Deal with 'omit' and 'only' + if (exists $ENV{'form.omit'}) { + @Omit = split(',',$ENV{'form.omit'}); + } + if (exists $ENV{'form.only'}) { + @Only = split(',',$ENV{'form.only'}); + } + + my $mode = $ENV{'form.mode'}; + my ($form,$element); + if ($mode eq 'edit' || $mode eq 'parmset') { + $form = $ENV{'form.form'}; + $element = $ENV{'form.element'}; + } + &Apache::lonxml::debug("mode=$mode form=$form element=$element"); # ------ set catalogmodefunctions to have extra needed javascript functionality my $catalogmodefunctions=''; if ($ENV{'form.catalogmode'} eq 'interactive' or $ENV{'form.catalogmode'} eq 'groupimport') { - $catalogmodefunctions=<$achash{$b}} (keys %ahash)) { my $key=$_; if ($ahash{$key} eq '1') { $hash{'store_'.$hash{'pre_'.$key.'_link'}}= @@ -219,9 +364,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_//; @@ -229,13 +374,14 @@ ENDHEADER delete $hash{'pre_'.$key.'_title'}; delete $hash{'pre_'.$key.'_link'}; } - } keys %hash; + } } -# output title - $r->print('

The LearningOnline With CAPA '. +# ---------------------------------------------------------------- output title + $r->print( +'

The LearningOnline Network 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}; @@ -249,7 +395,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"); @@ -714,30 +893,176 @@ sub begin_form { $dnum++; } -# ----------- grab unprocessed CGI variables that may have been appended to URL -sub get_unprocessed_cgi { - map { - 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 { + delete $hash{'form_mode'}; + delete $hash{'form_form'}; + delete $hash{'form_element'}; + delete $hash{'form_omit'}; + delete $hash{'form_only'}; + foreach (keys %hash) { if ($_ =~ /^pre_/) { delete $hash{$_}; } if ($_ =~ /^store/) { delete $hash{$_}; } - } keys %hash; + } +} + +# ------------------------------------------------------------------- setvalues +sub setvalues { + # setvalues is used in registerurl to synchronize the database + # hash and environment hashes + my ($H1,$h1key,$H2,$h2key) =@_; + # + if (exists $H2->{$h2key}) { + $H1->{$h1key} = $H2->{$h2key}; + } elsif (exists $H1->{$h1key}) { + $H2->{$h2key} = $H1->{$h1key}; + } } 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 * + +start_fresh_session - settings whenever the user causes the indexer window +to be launched + +=back + +=cut
\n"); - $r->print("\n"); +# $r->print(&initdebug()); +# $r->print(&writedebug("Omit:@Omit")) if (@Omit); +# $r->print(&writedebug("Only:@Only")) if (@Only); + $r->print("
\n"); + $r->print("\n"); $r->print("\n"); $r->print("\n") if ($hash{'display_attrs_0'} == 1); @@ -293,14 +442,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'}; @@ -331,7 +480,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; @@ -341,18 +490,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("
NameSize (bytes) ". "
"); $r->print("
"); - # end the output and return +# --------------------------------------------------- end the output and return $r->print("\n"); untie(%hash); } else { @@ -363,7 +512,6 @@ END return OK; } - # ----------------------------------------------- recursive scan of a directory sub scanDir { my ($r,$startdir,$indent,$hashref)=@_; @@ -417,9 +565,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}) { @@ -431,6 +579,29 @@ sub get_list { return @list=&match_ext($r,@list); } +sub initdebug { + return < +var debugging = true; +if (debugging) { + var debuggingWindow = window.open('','Debug','width=400,height=300',true); +} + +function output(text) { + if (debugging) { + debuggingWindow.document.writeln(text); + } +} +output("Debugging Window
");   
+
+ENDJS
+}
+
+sub writedebug {
+    my $text = shift;
+    return "";
+}
+
 # -------------------- filters out files based on extensions (returns an array)
 sub match_ext {
     my ($r,@packlist)=@_;
@@ -439,16 +610,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//;
@@ -459,9 +620,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' or $fext eq 'meta'));
 	} else {
 	    push @trimlist,$line;
 	}
@@ -471,7 +632,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;
@@ -561,7 +722,22 @@ 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];
+        if (@Omit) {
+            foreach (@Omit) { return OK if ($curfext eq $_); }
+        }
+        if (@Only) {
+            my $skip = 1;
+            foreach (@Only) { $skip = 0 if ($curfext eq $_); }
+            return OK if ($skip > 0);
+        }
+	# 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; @@ -571,8 +747,10 @@ sub display_line{ $title = &Apache::lonnet::metadata($filelink,'title') if ($metafile == 1); $title=$listname unless $title; - $r->print(""); + my $titleesc=HTML::Entities::encode($title); + $titleesc=~s/\'/\\'/; #' (clean up this spare quote) + $r->print(""); $r->print("". "\n"); $r->print(""); @@ -582,6 +760,7 @@ sub display_line{ $title = &Apache::lonnet::metadata($filelink,'title') if ($metafile == 1); $title=$listname unless $title; + my $titleesc=&HTML::Entities::encode($title); $r->print("
\n"); $r->print("\n"); + "value='$titleesc'>\n"); $r->print("
\n"); $r->print("		"); $hash{"pre_${fnum}_link"}=$filelink; - $hash{"pre_${fnum}_title"}=$title; + $hash{"pre_${fnum}_title"}=$titleesc; $fnum++; } @@ -615,7 +794,7 @@ sub display_line{ ".gif border='0' />\n") if $rem > 0; } - $r->print("\n"); + $r->print("\n"); $r->print (" $listname "); @@ -652,7 +831,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. "