--- loncom/interface/lonindexer.pm 2001/08/07 14:02:27 1.14 +++ loncom/interface/lonindexer.pm 2001/11/28 16:47:25 1.23 @@ -1,36 +1,59 @@ # 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) +# 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 +# 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 Scott Harrison +# +# $Id: lonindexer.pm,v 1.23 2001/11/28 16:47:25 harris41 Exp $ +### + +############################################################################### +## ## +## 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::Constants qw(:common); use Apache::File; use GDBM_File; -my %hash; -my %dirs; -my %language; -my $hidden; -my $extrafield; -my $fnum; +# ---------------------------------------- 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 + +# ---------------------------------------------------------------------- BEGIN sub BEGIN { my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. '/language.tab'); @@ -40,12 +63,17 @@ sub BEGIN { } <$fh>; } +# ----------------------------- Handling routine called via Apache and mod_perl sub handler { my $r = shift; $r->content_type('text/html'); $r->send_http_header; return OK if $r->header_only; $fnum=0; + $dnum=0; + untie %hash; + +# ------------------------------------- read in machine configuration variables my $iconpath= $r->dir_config('lonIconsURL') . "/"; my $domain = $r->dir_config('lonDefDomain'); my $role = $r->dir_config('lonRole'); @@ -56,99 +84,72 @@ sub handler { my $tabdir = $r->dir_config('lonTabDir'); my $fileclr='#ffffe6'; + my $line; + my (@attrchk,@openpath); + my $uri=$r->uri; + # -------------------------------------- see if called from an interactive mode - 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; - } - } (split(/&/,$ENV{'QUERY_STRING'})); + &get_unprocessed_cgi(); - $hidden=''; my $closebutton=''; + my $closebutton=''; my $groupimportbutton=''; my $colspan=''; $extrafield=''; - if ($ENV{'form.catalogmode'} eq 'interactive') { - $extrafield=''. - ''; - $colspan=" colspan='2' "; - $hidden=< -END - $closebutton=<'. + ''; + $colspan=" colspan='2' "; + $closebutton=< END - } - elsif ($ENV{'form.catalogmode'} eq 'groupimport') { - $extrafield=''. - ''; - $colspan=" colspan='2' "; - $hidden=< -END - $closebutton=<'. + ''; + $colspan=" colspan='2' "; + $closebutton=< END - $groupimportbutton=< + $groupimportbutton=< END - } + } - my $catalogmodefunctions=''; - if ($ENV{'form.catalogmode'} eq 'interactive' or - $ENV{'form.catalogmode'} eq 'groupimport') { - $catalogmodefunctions=<print(<print(< The LearningOnline Network With CAPA Directory Browser - ENDHEADER - my $line; - my (@attrchk,@openpath); - my $uri=$r->uri; - - $r->print('

The LearningOnline With CAPA Network Directory Browser

'."\n"); - - my $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; - - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { - +# - Evaluate actions from previous page (both cumulatively and chronologically) + if ($ENV{'form.catalogmode'} eq 'groupimport') { + my $acts=$ENV{'form.acts'}; + my @Acts=split(/b/,$acts); + my %ahash; + my %achash; + my $ac=0; + # some initial hashes for working with data + map { + my ($state,$ref)=split(/a/); + $ahash{$ref}=$state; + $achash{$ref}=$ac; + $ac++; + } (@Acts); + # sorting through the actions and changing the tied database hash + map { + my $key=$_; + if ($ahash{$key} eq '1') { + $hash{'store_'.$hash{'pre_'.$key.'_link'}}= + $hash{'pre_'.$key.'_title'}; + $hash{'storectr_'.$hash{'pre_'.$key.'_link'}}= + $hash{'storectr'}+0; + $hash{'storectr'}++; + } + if ($ahash{$key} eq '0') { + if ($hash{'store_'.$hash{'pre_'.$key.'_link'}}) { + delete $hash{'store_'.$hash{'pre_'.$key.'_link'}}; + } + } + } sort {$achash{$a}<=>$achash{$b}} (keys %ahash); + # deleting the previously cached listing + map { + if ($_ =~ /^pre_/ && $_ =~/link$/) { + my $key = $_; + $key =~ s/^pre_//; + $key =~ s/_[^_]*$//; + delete $hash{'pre_'.$key.'_title'}; + delete $hash{'pre_'.$key.'_link'}; + } + } keys %hash; + } + +# ---------------------------------------------------------------- output title + $r->print('

The LearningOnline With CAPA '. + 'Network Directory Browser

'."\n"); +# ---------------------------------- get state of file attributes to be showing if ($ENV{'form.attrs'} ne "") { - for (my $i=0; $i<=5; $i++) { + for (my $i=0; $i<=6; $i++) { delete $hash{'display_attrs_'.$i}; if ($ENV{'form.attr'.$i} == 1) { $attrchk[$i] = "checked"; @@ -203,43 +263,55 @@ ENDHEADER } } } else { - for (my $i=0; $i<=5; $i++) { + for (my $i=0; $i<=6; $i++) { $attrchk[$i] = "checked" if $hash{'display_attrs_'.$i} == 1; } } - $r->print(<Display file attributes
-
+# ------------------------------- output state of file attributes to be showing + $r->print(<Display file attributes
+ - - - + + + + - - - + + + +
Size Last access Last modified Size Last access Last modified All versions
Author Keywords Language Author Keywords Language 
- -  - -$hidden + + +  + $closebutton $groupimportbutton END - my $titleclr="#ddffff"; - $r->print("") 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"); 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("\n"); return OK; + +# display user directory } if ($filecom[1] eq "user") { $r->print("$extrafield"); @@ -448,13 +561,20 @@ sub display_line{ my $anchor = $curdir; $anchor =~ s/\///g; &begin_form ($r,$curdir); - $r->print (''."\n"); - $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); - $r->print (''); + $r->print (''."\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); @@ -470,7 +590,8 @@ sub display_line{ $title=$listname unless $title; $r->print(""); - $r->print("\n"); + $r->print("". + "\n"); $r->print("\n"); - $r->print("\n") + $r->print("\n") if $hash{'display_attrs_0'} == 1; - $r->print("\n") + $r->print("\n") if $hash{'display_attrs_1'} == 1; - $r->print("\n") + $r->print("\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("\n"); + $r->print("\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("\n"); + $r->print("\n"); } if ($hash{'display_attrs_5'} == 1) { - my $lang = &Apache::lonnet::metadata($filelink,'language') if ($metafile == 1); + my $lang = &Apache::lonnet::metadata($filelink,'language') + if ($metafile == 1); $lang = $language{$lang}; $lang = ' ' if (!$lang); - $r->print("\n"); + $r->print("\n"); } $r->print("\n"); } + # -- display directory if ($fnptr == $dirptr) { my @file_ext = split (/\./,$listname); @@ -543,20 +688,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 ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); - $r->print (''."\n"); + $r->print (''); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + "\n"); + $r->print (''. + "\n"); $r->print ("$listname$tabtag\n"); } @@ -567,11 +720,186 @@ sub begin_form { my ($r,$uri) = @_; my $anchor = $uri; $anchor =~ s/\///g; - $r->print (''."\n"); - $r->print ($hidden.''."\n"); - $r->print (''."\n"); + $r->print (''."\n"); + $r->print (''. + "\n"); + $r->print (''."\n"); + $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; } 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
\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") if ($hash{'display_attrs_3'} == 1); - $r->print("\n") if ($hash{'display_attrs_4'} == 1); - $r->print("\n") if ($hash{'display_attrs_5'} == 1); - $r->print(""); +# ----------------- output starting row to the indexed file/directory hierarchy + my $titleclr="#ddffff"; + $r->print("
NameSize (bytes) Last accessedLast modifiedAuthor(s)KeywordsLanguage
\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") + if ($hash{'display_attrs_3'} == 1); + $r->print("\n") + if ($hash{'display_attrs_4'} == 1); + $r->print("\n") + if ($hash{'display_attrs_5'} == 1); + $r->print(""); +# ----------------- read in what directories have previously been set to "open" map { if ($_ =~ /^diropen_status_/) { my $key = $_; @@ -268,6 +340,7 @@ END my $toplevel; my $indent = 0; $uri = $uri.'/' if $uri !~ /.*\/$/; + if ($bredir ne "on") { $hash{'top.level'} = $uri; $toplevel = $uri; @@ -275,6 +348,8 @@ END } else { $toplevel = $hash{'top.level'}; } + +# -------------------------------- if not at top level, provide an uplink arrow if ($toplevel ne "/res/"){ my (@uri_com) = split(/\//,$uri); pop @uri_com; @@ -283,24 +358,32 @@ END &display_line ($r,'opened',$upone.'&viewOneUp',0,$upone,@list); $indent = 1; } - &scanDir ($r,$toplevel,$indent); + +# -------- recursively go through all the directories and output as appropriate + &scanDir ($r,$toplevel,$indent,\%hash); +# ---------------------------- embed hidden information useful for group import $r->print(""); $r->print(""); + +# -------------------------------------------------------------- end the tables $r->print("
NameSize (bytes) ". + "Last accessedLast modifiedAuthor(s)KeywordsLanguage
"); $r->print("
"); + +# --------------------------------------------------- end the output and return $r->print("\n"); untie(%hash); } else { - $r->print("Unable to tie hash to db file"); + $r->print('Unable to tie hash to db '. + 'file'); + return OK; } return OK; } - -# --------------------recursive scan of a directory +# ----------------------------------------------- recursive scan of a directory sub scanDir { - my ($r,$startdir,$indent)=@_; + my ($r,$startdir,$indent,$hashref)=@_; my ($compuri,$curdir); my $dirptr=16384; $indent++; @@ -310,11 +393,22 @@ sub scanDir { foreach my $line (@list) { my ($strip,$dom,$foo,$testdir,$foo)=split(/\&/,$line,5); next if $strip =~ /.*\.meta$/; + my (@fileparts) = split(/\./,$strip); + if ($hash{'display_attrs_6'} != 1) { + if (scalar(@fileparts) >= 3) { + my $fext = pop @fileparts; + my $ov = pop @fileparts; + my $fname = join ('.',@fileparts,$fext); + next if (grep /$fname/,@list and $ov =~ /\d+/); + } + } + if ($dom eq "domain") { - $compuri = join('',$strip,"/"); # domain list has /res/ + $compuri = join('',$strip,"/"); # dom list has /res/ $curdir = $compuri; } else { - $compuri = join('',$startdir,$strip,"/"); # user, dir & file have name only, i.e., w/o path + # user, dir & file have name only, i.e., w/o path + $compuri = join('',$startdir,$strip,"/"); $curdir = $startdir; } my $diropen = "closed"; @@ -326,13 +420,13 @@ sub scanDir { } } } - &display_line($r,$diropen,$line,$indent,$curdir,@list); + &display_line($r,$diropen,$line,$indent,$curdir,$hashref,@list); &scanDir ($r,$compuri,$indent) if $diropen eq "opened"; } $indent--; } -# ----------------- get complete matched list based on the uri ------ +# --------------- get complete matched list based on the uri (returns an array) sub get_list { my ($r,$uri)=@_; my @list; @@ -354,7 +448,7 @@ sub get_list { return @list=&match_ext($r,@list); } -#-------------------------- filters out files based on extensions +# -------------------- filters out files based on extensions (returns an array) sub match_ext { my ($r,@packlist)=@_; my @trimlist; @@ -393,9 +487,9 @@ sub match_ext { return @trimlist; } -#------------------- displays one line in appropriate table format -sub display_line{ - my ($r,$diropen,$line,$indent,$startdir,@list)=@_; +# ------------------------------- 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; my $fileclr="#ffffe6"; @@ -412,34 +506,53 @@ sub display_line{ my $i=0; while ($i<=5) { - $tabtag=join('',$tabtag,"		  
\n"); - $r->print ('
'."\n"); - $r->print ($hidden.''."\n"); + $r->print (''."\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
"); &begin_form ($r,$filecom[0].'/'); my $anchor = $filecom[0].'/'; $anchor =~ s/\///g; $r->print (''); - $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'."\n"); - $r->print ('print (' border="0">'."\n"); + $r->print (''); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + "\n"); + $r->print ('print (' border="0" />'."\n"); $r->print("Domain - $listname $tabtag
"); } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { @@ -480,58 +601,82 @@ sub display_line{ $title=$listname unless $title; $r->print("
\n"); $r->print("\n"); + "value='$filelink' onClick='". + "javascript:queue(\"form$fnum\")' "); + if ($hash{'store_'.$filelink}) { + $r->print("checked"); + } + $r->print(">\n"); $r->print("\n"); $r->print("
\n"); $r->print("		"); + $hash{"pre_${fnum}_link"}=$filelink; + $hash{"pre_${fnum}_title"}=$title; $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(" ",$filecom[8]," ", + $filecom[8]," ".(localtime($filecom[9]))." ". + (localtime($filecom[9]))." ".(localtime($filecom[10]))." ". + (localtime($filecom[10]))." ".$author." ".$author. + " ".$keywords." ".$keywords. + " ".$lang." ".$lang. + "