--- loncom/interface/lonindexer.pm 2001/08/08 03:00:11 1.16 +++ loncom/interface/lonindexer.pm 2002/06/20 21:22:20 1.44 @@ -1,47 +1,91 @@ # The LearningOnline Network with CAPA -# # Directory Indexer -# (Login Screen # -# 5/21/99,5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer) +# $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 +# YEAR=2000 # 07/20-08/04 H.K. Ng -# +# YEAR=2001 # 05/9-05/19/2001 H. K. Ng # 05/21/2001 H. K. Ng # 05/23/2001 H. K. Ng -# 05/31/2001 Scott Harrison -# 06/01/2001 Scott Harrison -# 06/02/2001 Scott Harrison -# 06/15/2001 Scott Harrison -# 06/26/2001 H. K. Ng -# 07/08/2001 H. K. Ng -# 8/6,8/7 Scott Harrison +# 5/31,6/1,6/2,6/15 Scott Harrison +# 6/26,7/8 H. K. Ng +# 8/6,8/7,8/10 Scott Harrison +# 8/14 H. K. Ng +# 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; -my %hash; -my %dirs; -my %language; -my $hidden; -my $extrafield; -my $fnum; -my $dnum; -sub BEGIN { - my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. - '/language.tab'); - map { - $_=~/(\w+)\s+([\w\s\-]+)/; - $language{$1}=$2; - } <$fh>; -} +# ---------------------------------------- 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 + +# ----- Values which are set by the handler subroutine and are accessible to +# ----- other methods. +my $extrafield; # default extra table cell +my $fnum; # file counter +my $dnum; # directory counter + +# ----- Used to include or exclude files with certain extensions. +my @Only = (); +my @Omit = (); + +# ----------------------------- Handling routine called via Apache and mod_perl sub handler { my $r = shift; $r->content_type('text/html'); @@ -49,6 +93,14 @@ sub handler { return OK if $r->header_only; $fnum=0; $dnum=0; + untie %hash; + + # 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'); @@ -64,44 +116,24 @@ sub handler { my $uri=$r->uri; # -------------------------------------- see if called from an interactive mode -# foreach my $key (sort(keys(%ENV))) { -# $r->print("$key is $ENV{$key}
"); -# } -# $r->print("END ENV"); - 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') { - $ENV{'form.'.$name}=$value; - } - if ($name eq 'launch') { - $ENV{'form.'.$name}=$value; - } - if ($name eq 'acts') { - $ENV{'form.'.$name}=$value; - } - } (split(/&/,$ENV{'QUERY_STRING'})); - - $hidden=''; my $closebutton=''; + # 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=''; $extrafield=''; - my $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; + my $diropendb = + "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { if ($ENV{'form.launch'} eq '1') { - delete $hash{'mode_catalog'}; - map { - if ($_ =~ /^pre_/) { - delete $hash{$_}; - } - if ($_ =~ /^store/) { - delete $hash{$_}; - } - } keys %hash; - } + &start_fresh_session(); + } +# -------------------- refresh environment with user database values (in %hash) if ($hash{'mode_catalog'} eq 'interactive') { $ENV{'form.catalogmode'}='interactive'; } @@ -109,15 +141,13 @@ sub handler { $ENV{'form.catalogmode'}='groupimport'; } +# --------------------- define extra fields and buttons in case of special mode if ($ENV{'form.catalogmode'} eq 'interactive') { $hash{'mode_catalog'}='interactive'; $extrafield=''. ''; + ' border="0" />'; $colspan=" colspan='2' "; - $hidden=< -END $closebutton=< END @@ -126,122 +156,168 @@ END $hash{'mode_catalog'}='groupimport'; $extrafield=''. ''; + ' border="0" />'; $colspan=" colspan='2' "; - $hidden=< -END $closebutton=< END $groupimportbutton=< + 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=<print(< The LearningOnline Network With CAPA Directory Browser - +ENDJS +} + +sub writedebug { + my $text = shift; + return ""; +} + +# -------------------- filters out files based on extensions (returns an array) sub match_ext { my ($r,@packlist)=@_; my @trimlist; @@ -498,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//; @@ -518,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; } @@ -529,8 +631,8 @@ sub match_ext { return @trimlist; } -#------------------- displays one line in appropriate table format -sub display_line{ +# ------------------------------- displays one line in appropriate table format +sub display_line { my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_; my (@pathfn, $fndir, $fnptr); my $dirptr=16384; @@ -548,26 +650,35 @@ sub display_line{ my $i=0; while ($i<=5) { - $tabtag=join('',$tabtag," ") if $hash{'display_attrs_'.$i} == 1; + $tabtag=join('',$tabtag," ") + if $hash{'display_attrs_'.$i} == 1; $i++; } + +# display uplink arrow if ($filecom[1] eq "viewOneUp") { $r->print("$extrafield"); $r->print("\n"); $r->print ('
'."\n"); - $r->print ($hidden.''."\n"); + $r->print (''."\n"); $r->print (''."\n"); $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); + $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. + "\n"); $r->print("Up $tabtag
\n"); return OK; } + +# display domain if ($filecom[1] eq "domain") { - $r->print (''."\n") if ($ENV{'form.dirPointer'} eq "on"); + $r->print (''."\n") + if ($ENV{'form.dirPointer'} eq "on"); $r->print("$extrafield"); $r->print(""); &begin_form ($r,$filecom[0].'/'); @@ -575,12 +686,17 @@ sub display_line{ $anchor =~ s/\///g; $r->print (''); $r->print (''); - $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); - $r->print ('print (' border="0">'."\n"); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + "\n"); + $r->print ('print (' border="0" />'."\n"); $r->print("Domain - $listname $tabtag\n"); return OK; + +# display user directory } if ($filecom[1] eq "user") { $r->print("$extrafield"); @@ -589,18 +705,39 @@ sub display_line{ my $anchor = $curdir; $anchor =~ s/\///g; &begin_form ($r,$curdir); - $r->print (''."\n"); + $r->print (''."\n"); $r->print (''); - $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); - $r->print (''); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + "\n"); + $r->print (''); $r->print ($listname.$tabtag.''."\n"); return OK; } + # 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; @@ -610,9 +747,12 @@ sub display_line{ $title = &Apache::lonnet::metadata($filelink,'title') if ($metafile == 1); $title=$listname unless $title; - $r->print(""); - $r->print("\n"); + my $titleesc=HTML::Entities::encode($title); + $titleesc=~s/\'/\\'/; #' (clean up this spare quote) + $r->print(""); + $r->print("". + "\n"); $r->print(""); } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { @@ -620,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++; } if ($indent > 0 and $indent < 11) { - $r->print("\n"); + $r->print("\n"); } elsif ($indent >0) { my $ten = int($indent/10.); my $rem = $indent%10.0; my $count = 0; while ($count < $ten) { - $r->print("\n"); + $r->print("\n"); $count++; } - $r->print("\n") if $rem > 0; + $r->print("\n") if $rem > 0; } - $r->print("\n"); - $r->print (" $listname "); - - $r->print (" (metadata) ") if ($metafile == 1); + $r->print("\n"); + $r->print (" $listname "); + + $r->print (" (metadata) ") if ($metafile == 1); $r->print("\n"); - $r->print(" ",$filecom[8]," \n") + $r->print(" ", + $filecom[8]," \n") if $hash{'display_attrs_0'} == 1; - $r->print(" ".(localtime($filecom[9]))." \n") + $r->print(" ". + (localtime($filecom[9]))." \n") if $hash{'display_attrs_1'} == 1; - $r->print(" ".(localtime($filecom[10]))." \n") + $r->print(" ". + (localtime($filecom[10]))." \n") if $hash{'display_attrs_2'} == 1; if ($hash{'display_attrs_3'} == 1) { - my $author = &Apache::lonnet::metadata($filelink,'author') if ($metafile == 1); + my $author = &Apache::lonnet::metadata($filelink,'author') + if ($metafile == 1); $author = ' ' if (!$author); - $r->print(" ".$author." \n"); + $r->print(" ".$author. + " \n"); } if ($hash{'display_attrs_4'} == 1) { - my $keywords = &Apache::lonnet::metadata($filelink,'keywords') if ($metafile == 1); + my $keywords = &Apache::lonnet::metadata($filelink,'keywords') + if ($metafile == 1); $keywords = ' ' if (!$keywords); - $r->print(" ".$keywords." \n"); + $r->print(" ".$keywords. + " \n"); } if ($hash{'display_attrs_5'} == 1) { - my $lang = &Apache::lonnet::metadata($filelink,'language') if ($metafile == 1); - $lang = $language{$lang}; + my $lang = &Apache::lonnet::metadata($filelink,'language') + if ($metafile == 1); + $lang = &Apache::loncommon::languagedescription($lang); $lang = ' ' if (!$lang); - $r->print(" ".$lang." \n"); + $r->print(" ".$lang. + " \n"); } $r->print("\n"); } + # -- display directory if ($fnptr == $dirptr) { my @file_ext = split (/\./,$listname); @@ -692,21 +850,28 @@ sub display_line{ &begin_form ($r,$curdir); my $indentm1 = $indent-1; if ($indentm1 < 11 and $indentm1 > 0) { - $r->print("\n"); + $r->print("\n"); } else { my $ten = int($indentm1/10.); my $rem = $indentm1%10.0; my $count = 0; while ($count < $ten) { - $r->print ("\n"); + $r->print ("\n"); $count++; } - $r->print ("\n") if $rem > 0; + $r->print ("\n") if $rem > 0; } $r->print (''); - $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); - $r->print (''."\n"); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + "\n"); + $r->print (''. + "\n"); $r->print ("$listname$tabtag\n"); } @@ -717,13 +882,187 @@ sub begin_form { my ($r,$uri) = @_; my $anchor = $uri; $anchor =~ s/\///g; - $r->print ('
print (''."\n"); - $r->print ($hidden.''."\n"); - $r->print (''."\n"); + $r->print (''. + "\n"); + $r->print (''."\n"); $dnum++; } +# --------- settings whenever the user causes the indexer window to be launched +sub start_fresh_session { + delete $hash{'mode_catalog'}; + 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{$_}; + } + } +} + +# ------------------------------------------------------------------- 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