--- loncom/interface/lonindexer.pm 2001/11/29 20:31:45 1.24 +++ loncom/interface/lonindexer.pm 2002/08/12 18:21:42 1.49 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Directory Indexer # -# $Id: lonindexer.pm,v 1.24 2001/11/29 20:31:45 harris41 Exp $ +# $Id: lonindexer.pm,v 1.49 2002/08/12 18:21:42 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -39,6 +39,11 @@ # 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 +# 6/29/2002 H. K. Ng # ### @@ -60,6 +65,7 @@ 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; @@ -75,15 +81,10 @@ 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 = (); + # ----------------------------- Handling routine called via Apache and mod_perl sub handler { @@ -95,6 +96,11 @@ sub handler { $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'); @@ -111,8 +117,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=''; @@ -121,22 +130,15 @@ sub handler { my $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + 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'; - } - if ($hash{'mode_catalog'} eq 'groupimport') { - $ENV{'form.catalogmode'}='groupimport'; - } + &setvalues(\%hash,'form.catalogmode',\%ENV,'form.catalogmode' ); # --------------------- define extra fields and buttons in case of special mode if ($ENV{'form.catalogmode'} eq 'interactive') { - $hash{'mode_catalog'}='interactive'; $extrafield=''. ''; @@ -146,7 +148,6 @@ sub handler { END } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { - $hash{'mode_catalog'}='groupimport'; $extrafield=''. ''; @@ -159,35 +160,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'}}= @@ -259,9 +358,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_//; @@ -269,41 +368,42 @@ ENDHEADER delete $hash{'pre_'.$key.'_title'}; delete $hash{'pre_'.$key.'_link'}; } - } keys %hash; + } } # ---------------------------------------------------------------- output title - $r->print('

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

The LearningOnline Network with CAPA '. 'Network Directory Browser

'."\n"); # ---------------------------------- get state of file attributes to be showing - if ($ENV{'form.attrs'} ne "") { - for (my $i=0; $i<=6; $i++) { + if ($ENV{'form.attrs'} ne '') { + for (my $i=0; $i<=7; $i++) { delete $hash{'display_attrs_'.$i}; if ($ENV{'form.attr'.$i} == 1) { - $attrchk[$i] = "checked"; + $attrchk[$i] = 'checked'; $hash{'display_attrs_'.$i} = 1; } } } else { - for (my $i=0; $i<=6; $i++) { - $attrchk[$i] = "checked" if $hash{'display_attrs_'.$i} == 1; + for (my $i=0; $i<=7; $i++) { + $attrchk[$i] = 'checked' if $hash{'display_attrs_'.$i} == 1; } } # ------------------------------- output state of file attributes to be showing $r->print(<Display file attributes
+Display file attributes
- - - - + + + + - - - - + + + +
Size Last access Last modified All versions Title Size Last access Last modified
Author Keywords Language  Author Keywords Language All versions
@@ -316,31 +416,36 @@ END # ----------------- output starting row to the indexed file/directory hierarchy my $titleclr="#ddffff"; - $r->print("
\n"); - $r->print("\n"); - $r->print("\n"); - $r->print("\n") if ($hash{'display_attrs_0'} == 1); - $r->print("\n") - if ($hash{'display_attrs_1'} == 1); - $r->print("\n") +# $r->print(&initdebug()); +# $r->print(&writedebug("Omit:@Omit")) if (@Omit); +# $r->print(&writedebug("Only:@Only")) if (@Only); + $r->print("
NameSize (bytes) ". - "Last accessedLast modified
\n"); + $r->print("\n"); + $r->print("\n"); + $r->print("\n") + if ($hash{'display_attrs_0'} == 1); + $r->print("\n") if ($hash{'display_attrs_1'} == 1); + $r->print("\n") if ($hash{'display_attrs_2'} == 1); - $r->print("\n") + $r->print("\n") if ($hash{'display_attrs_3'} == 1); - $r->print("\n") + $r->print("\n") if ($hash{'display_attrs_4'} == 1); - $r->print("\n") + $r->print("\n") if ($hash{'display_attrs_5'} == 1); - $r->print(""); + $r->print("\n") + if ($hash{'display_attrs_6'} == 1); + $r->print(''); # ----------------- read in what directories have previously been set to "open" - map { + 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'}; @@ -363,7 +468,7 @@ END my $indent = 0; $uri = $uri.'/' if $uri !~ /.*\/$/; - if ($bredir ne "on") { + if ($bredir ne 'on') { $hash{'top.level'} = $uri; $toplevel = $uri; @@ -372,7 +477,7 @@ END } # -------------------------------- if not at top level, provide an uplink arrow - if ($toplevel ne "/res/"){ + if ($toplevel ne '/res/'){ my (@uri_com) = split(/\//,$uri); pop @uri_com; my $upone = join('/',@uri_com); @@ -389,11 +494,11 @@ END $r->print(""); # -------------------------------------------------------------- end the tables - $r->print("
NameTitleSize (bytes) ". + "Last accessedAuthor(s)Last modifiedKeywordsAuthor(s)LanguageKeywords
Language
"); - $r->print("
"); + $r->print('
'); + $r->print(''); # --------------------------------------------------- end the output and return - $r->print("\n"); + $r->print(''."\n"); untie(%hash); } else { $r->print('Unable to tie hash to db '. @@ -416,7 +521,7 @@ sub scanDir { my ($strip,$dom,$foo,$testdir,$foo)=split(/\&/,$line,5); next if $strip =~ /.*\.meta$/; my (@fileparts) = split(/\./,$strip); - if ($hash{'display_attrs_6'} != 1) { + if ($hash{'display_attrs_7'} != 1) { if (scalar(@fileparts) >= 3) { my $fext = pop @fileparts; my $ov = pop @fileparts; @@ -425,15 +530,15 @@ sub scanDir { } } - if ($dom eq "domain") { - $compuri = join('',$strip,"/"); # dom list has /res/ + if ($dom eq 'domain') { + $compuri = join('',$strip,'/'); # dom list has /res/ $curdir = $compuri; } else { # user, dir & file have name only, i.e., w/o path - $compuri = join('',$startdir,$strip,"/"); + $compuri = join('',$startdir,$strip,'/'); $curdir = $startdir; } - my $diropen = "closed"; + my $diropen = 'closed'; if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/)) { while (my ($key,$val)= each %dupdirs) { if ($key eq $compuri and $val eq "open") { @@ -443,7 +548,7 @@ sub scanDir { } } &display_line($r,$diropen,$line,$indent,$curdir,$hashref,@list); - &scanDir ($r,$compuri,$indent) if $diropen eq "opened"; + &scanDir ($r,$compuri,$indent) if $diropen eq 'opened'; } $indent--; } @@ -452,13 +557,12 @@ sub scanDir { sub get_list { my ($r,$uri)=@_; my @list; - my $luri = $uri; - $luri =~ s/\//_/g; + (my $luri = $uri) =~ s/\//_/g; - if ($ENV{'form.attrs'} eq "Refresh") { - map { + if ($ENV{'form.attrs'} eq 'Refresh') { + foreach (keys %hash) { delete $hash{$_} if ($_ =~ /^dirlist_files_/); - } keys %hash; + } } if ($hash{'dirlist_files'.$luri}) { @@ -470,6 +574,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)=@_;
@@ -478,29 +605,19 @@ 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//;
 	my @unpackline = split (/\&/,$line);
-	next if ($unpackline[0] eq ".");
-	next if ($unpackline[0] eq "..");
+	next if ($unpackline[0] eq '.');
+	next if ($unpackline[0] eq '..');
 	my @filecom = split (/\./,$unpackline[0]);
 	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;
 	}
@@ -515,28 +632,28 @@ sub display_line {
     my (@pathfn, $fndir, $fnptr);
     my $dirptr=16384;
     my $fileclr="#ffffe6";
-    my $iconpath= $r->dir_config('lonIconsURL') . "/";
+    my $iconpath= $r->dir_config('lonIconsURL') . '/';
 
     my @filecom = split (/\&/,$line);
     my @pathcom = split (/\//,$filecom[0]);
     my $listname = $pathcom[scalar(@pathcom)-1];
     my $fnptr = $filecom[3]&$dirptr;
     my $msg = 'View '.$filecom[0].' resources';
-    $msg = 'Close '.$filecom[0].' directory' if $diropen eq "opened";
+    $msg = 'Close '.$filecom[0].' directory' if $diropen eq 'opened';
 
-    my $tabtag="";
+    my $tabtag='';
     my $i=0;
 
-    while ($i<=5) {
-	$tabtag=join('',$tabtag," ")
+    while ($i<=6) {
+	$tabtag=join('',$tabtag," ")
 	    if $hash{'display_attrs_'.$i} == 1;
 	$i++;
     }
 
 # display uplink arrow
-    if ($filecom[1] eq "viewOneUp") {
-	$r->print("$extrafield");
-	$r->print("\n");
+    if ($filecom[1] eq 'viewOneUp') {
+	$r->print("$extrafield");
+	$r->print("\n");
 	$r->print ('
print (''."\n") if ($ENV{'form.dirPointer'} eq "on"); - $r->print("$extrafield"); - $r->print(""); + $r->print("$extrafield"); + $r->print(""); &begin_form ($r,$filecom[0].'/'); my $anchor = $filecom[0].'/'; $anchor =~ s/\///g; @@ -576,9 +693,9 @@ sub display_line { # display user directory } - if ($filecom[1] eq "user") { - $r->print("$extrafield"); - $r->print("\n"); + if ($filecom[1] eq 'user') { + $r->print("$extrafield"); + $r->print("\n"); my $curdir = $startdir.$filecom[0].'/'; my $anchor = $curdir; $anchor =~ s/\///g; @@ -598,11 +715,27 @@ 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]; + if ($fnptr == 0 and $filecom[3] ne '') { my $filelink = $startdir.$filecom[0]; - $r->print(""); + return OK if (!&Apache::lonnet::allowed('bre',$filelink)); + my @file_ext = split (/\./,$listname); + 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'); + # + $r->print(""); my $metafile = grep /^$filecom[0]\.meta\&/, @list; my $title; if ($ENV{'form.catalogmode'} eq 'interactive') { @@ -610,17 +743,20 @@ 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(""); + $r->print(""); } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { $title=$listname; $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(""); + $r->print(""); $hash{"pre_${fnum}_link"}=$filelink; - $hash{"pre_${fnum}_title"}=$title; + $hash{"pre_${fnum}_title"}=$titleesc; $fnum++; } @@ -654,7 +790,7 @@ sub display_line { ".gif border='0' />\n") if $rem > 0; } - $r->print("\n"); + $r->print("\n"); $r->print (" $listname "); @@ -664,36 +800,40 @@ sub display_line { "TARGET=_self>metadata) ") if ($metafile == 1); $r->print("\n"); - $r->print(" ", + if ($hash{'display_attrs_0'} == 1) { + my $title = &Apache::lonnet::metadata($filelink,'title') + if ($metafile == 1); + $r->print(' '.($title eq '' ? ' ' : $title). + ' '."\n"); + } + $r->print(' ', $filecom[8]," \n") - if $hash{'display_attrs_0'} == 1; - $r->print(" ". - (localtime($filecom[9]))." \n") if $hash{'display_attrs_1'} == 1; - $r->print(" ". - (localtime($filecom[10]))." \n") + $r->print(' '. + (localtime($filecom[9]))." \n") if $hash{'display_attrs_2'} == 1; + $r->print(' '. + (localtime($filecom[10]))." \n") + if $hash{'display_attrs_3'} == 1; - if ($hash{'display_attrs_3'} == 1) { + if ($hash{'display_attrs_4'} == 1) { my $author = &Apache::lonnet::metadata($filelink,'author') if ($metafile == 1); - $author = ' ' if (!$author); - $r->print(" ".$author. + $r->print(' '.($author eq '' ? ' ' : $author). " \n"); } - if ($hash{'display_attrs_4'} == 1) { + if ($hash{'display_attrs_5'} == 1) { my $keywords = &Apache::lonnet::metadata($filelink,'keywords') if ($metafile == 1); - $keywords = ' ' if (!$keywords); - $r->print(" ".$keywords. + # $keywords = ' ' if (!$keywords); + $r->print(' '.($keywords eq '' ? ' ' : $keywords). " \n"); } - if ($hash{'display_attrs_5'} == 1) { + if ($hash{'display_attrs_6'} == 1) { my $lang = &Apache::lonnet::metadata($filelink,'language') if ($metafile == 1); - $lang = $language{$lang}; - $lang = ' ' if (!$lang); - $r->print(" ".$lang. + $lang = &Apache::loncommon::languagedescription($lang); + $r->print(' '.($lang eq '' ? ' ' : $lang). " \n"); } $r->print("\n"); @@ -706,7 +846,7 @@ sub display_line { my $curdir = $startdir.$filecom[0].'/'; my $anchor = $curdir; $anchor =~ s/\///g; - $r->print("$extrafield"); + $r->print("$extrafield"); &begin_form ($r,$curdir); my $indentm1 = $indent-1; if ($indentm1 < 11 and $indentm1 > 0) { @@ -753,29 +893,30 @@ 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 { - if ($_ =~ /^pre_/) { - delete $hash{$_}; - } - if ($_ =~ /^store/) { - delete $hash{$_}; - } - } keys %hash; + delete $hash{'form.catalogmode'}; + delete $hash{'form.mode'}; + delete $hash{'form.form'}; + delete $hash{'form.element'}; + delete $hash{'form.omit'}; + delete $hash{'form.only'}; + foreach (keys %hash) { + delete $hash{$_} if (/^(pre_|store)/); + } +} + +# ------------------------------------------------------------------- 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; @@ -914,11 +1055,6 @@ begin_form - prints the beginning of a f =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