# The LearningOnline Network with CAPA # Directory Indexer # # $Id: lonindexer.pm,v 1.34 2002/01/17 14:10:44 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 # 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 # 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; # ---------------------------------------- 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 # ----------------------------- 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'); my $loadlim = $r->dir_config('lonLoadLim'); my $servadm = $r->dir_config('lonAdmEMail'); my $sysadm = $r->dir_config('lonSysEMail'); my $lonhost = $r->dir_config('lonHostID'); 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 &get_unprocessed_cgi(); my $closebutton=''; my $groupimportbutton=''; my $colspan=''; $extrafield=''; 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') { &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'; } # --------------------- define extra fields and buttons in case of special mode if ($ENV{'form.catalogmode'} eq 'interactive') { $hash{'mode_catalog'}='interactive'; $extrafield=''. ''; $colspan=" colspan='2' "; $closebutton=< END } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { $hash{'mode_catalog'}='groupimport'; $extrafield=''. ''; $colspan=" colspan='2' "; $closebutton=< END $groupimportbutton=< END } # ------ 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 ENDHEADER # - 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 foreach (@Acts) { my ($state,$ref)=split(/a/); $ahash{$ref}=$state; $achash{$ref}=$ac; $ac++; } # sorting through the actions and changing the tied database hash foreach (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) { 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'}}; } } } # deleting the previously cached listing foreach (keys %hash) { if ($_ =~ /^pre_/ && $_ =~/link$/) { my $key = $_; $key =~ s/^pre_//; $key =~ s/_[^_]*$//; delete $hash{'pre_'.$key.'_title'}; delete $hash{'pre_'.$key.'_link'}; } } } # ---------------------------------------------------------------- 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<=6; $i++) { delete $hash{'display_attrs_'.$i}; if ($ENV{'form.attr'.$i} == 1) { $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; } } # ------------------------------- output state of file attributes to be showing $r->print(<Display file attributes
Size Last access Last modified All versions
Author Keywords Language  
  $closebutton $groupimportbutton
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") 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" foreach (keys %hash) { if ($_ =~ /^diropen_status_/) { my $key = $_; $key =~ s/^diropen_status_//; $dirs{$key} = $hash{$_}; } } if ($ENV{'form.openuri'}) { # take care of review and refresh options my $uri=$ENV{'form.openuri'}; if (exists($hash{'diropen_status_'.$uri})) { my $cursta = $hash{'diropen_status_'.$uri}; $dirs{$uri} = 'open'; $hash{'diropen_status_'.$uri} = 'open'; if ($cursta eq 'open') { $dirs{$uri} = 'closed'; $hash{'diropen_status_'.$uri} = 'closed'; } } else { $hash{'diropen_status_'.$uri} = 'open'; $dirs{$uri} = 'open'; } } my $bredir = $ENV{'form.dirPointer'}; my $toplevel; my $indent = 0; $uri = $uri.'/' if $uri !~ /.*\/$/; if ($bredir ne "on") { $hash{'top.level'} = $uri; $toplevel = $uri; } 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; my $upone = join('/',@uri_com); my @list = qw (0); &display_line ($r,'opened',$upone.'&viewOneUp',0,$upone,@list); $indent = 1; } # -------- 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'); return OK; } return OK; } # ----------------------------------------------- recursive scan of a directory sub scanDir { my ($r,$startdir,$indent,$hashref)=@_; my ($compuri,$curdir); my $dirptr=16384; $indent++; my %dupdirs = %dirs; my @list=&get_list($r,$startdir); 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,"/"); # dom list has /res/ $curdir = $compuri; } else { # user, dir & file have name only, i.e., w/o path $compuri = join('',$startdir,$strip,"/"); $curdir = $startdir; } my $diropen = "closed"; if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/)) { while (my ($key,$val)= each %dupdirs) { if ($key eq $compuri and $val eq "open") { $diropen = "opened"; delete $dupdirs{key},$dirs{$key}; } } } &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 (returns an array) sub get_list { my ($r,$uri)=@_; my @list; my $luri = $uri; $luri =~ s/\//_/g; if ($ENV{'form.attrs'} eq "Refresh") { foreach (keys %hash) { delete $hash{$_} if ($_ =~ /^dirlist_files_/); } } if ($hash{'dirlist_files'.$luri}) { @list = split(/\n/,$hash{'dirlist_files_'.$luri}); } else { @list = &Apache::lonnet::dirlist($uri); $hash{'dirlist_files_'.$luri} = join('\n',@list); } return @list=&match_ext($r,@list); } # -------------------- filters out files based on extensions (returns an array) sub match_ext { my ($r,@packlist)=@_; my @trimlist; my $nextline; my @fileext; my $dirptr=16384; 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 ".."); my @filecom = split (/\./,$unpackline[0]); my $fext = pop(@filecom); my $fnptr = $unpackline[3]&$dirptr; if ($fnptr == 0 and $unpackline[3] ne "") { my $embstyle = &Apache::loncommon::fileembstyle($fext); push @trimlist,$line if (defined($embstyle) && ($embstyle ne 'hdn' or $fext eq 'meta')); } else { push @trimlist,$line; } } @trimlist = sort (@trimlist); return @trimlist; } # ------------------------------- 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"; 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"; my $tabtag=""; my $i=0; while ($i<=5) { $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 (''."\n"); $r->print (''."\n"); $r->print ('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("$extrafield"); $r->print(""); &begin_form ($r,$filecom[0].'/'); my $anchor = $filecom[0].'/'; $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("Domain - $listname $tabtag\n"); return OK; # display user directory } if ($filecom[1] eq "user") { $r->print("$extrafield"); $r->print("\n"); my $curdir = $startdir.$filecom[0].'/'; my $anchor = $curdir; $anchor =~ s/\///g; &begin_form ($r,$curdir); $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); 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; my $title; if ($ENV{'form.catalogmode'} eq 'interactive') { $title=$listname; $title = &Apache::lonnet::metadata($filelink,'title') if ($metafile == 1); $title=$listname unless $title; my $titleesc=$title; $titleesc=~s/\'/\\'/; $r->print(""); $r->print("". "\n"); $r->print(""); } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { $title=$listname; $title = &Apache::lonnet::metadata($filelink,'title') if ($metafile == 1); $title=$listname unless $title; $r->print("
\n"); $r->print("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"); } elsif ($indent >0) { my $ten = int($indent/10.); my $rem = $indent%10.0; my $count = 0; while ($count < $ten) { $r->print("\n"); $count++; } $r->print("\n") if $rem > 0; } $r->print("\n"); $r->print (" $listname "); $r->print (" (metadata) ") if ($metafile == 1); $r->print("\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") if $hash{'display_attrs_2'} == 1; if ($hash{'display_attrs_3'} == 1) { my $author = &Apache::lonnet::metadata($filelink,'author') if ($metafile == 1); $author = ' ' if (!$author); $r->print(" ".$author. " \n"); } if ($hash{'display_attrs_4'} == 1) { my $keywords = &Apache::lonnet::metadata($filelink,'keywords') if ($metafile == 1); $keywords = ' ' if (!$keywords); $r->print(" ".$keywords. " \n"); } if ($hash{'display_attrs_5'} == 1) { my $lang = &Apache::lonnet::metadata($filelink,'language') if ($metafile == 1); $lang = &Apache::loncommon::languagedescription($lang); $lang = ' ' if (!$lang); $r->print(" ".$lang. " \n"); } $r->print("\n"); } # -- display directory if ($fnptr == $dirptr) { my @file_ext = split (/\./,$listname); my $curfext = $file_ext[scalar(@file_ext)-1]; my $curdir = $startdir.$filecom[0].'/'; my $anchor = $curdir; $anchor =~ s/\///g; $r->print("$extrafield"); &begin_form ($r,$curdir); my $indentm1 = $indent-1; if ($indentm1 < 11 and $indentm1 > 0) { $r->print("\n"); } else { my $ten = int($indentm1/10.); my $rem = $indentm1%10.0; my $count = 0; while ($count < $ten) { $r->print ("\n"); $count++; } $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 ("$listname$tabtag\n"); } } # ------------------- prints the beginning of a form for directory or file link sub begin_form { my ($r,$uri) = @_; my $anchor = $uri; $anchor =~ s/\///g; $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 { 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; } } } # --------- settings whenever the user causes the indexer window to be launched sub start_fresh_session { delete $hash{'mode_catalog'}; foreach (keys %hash) { if ($_ =~ /^pre_/) { delete $hash{$_}; } if ($_ =~ /^store/) { delete $hash{$_}; } } } 1; =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