--- loncom/interface/lonindexer.pm 2001/10/16 17:03:45 1.20 +++ loncom/interface/lonindexer.pm 2006/12/05 02:55:53 1.154 @@ -1,60 +1,99 @@ # The LearningOnline Network with CAPA -# # Directory Indexer # -# 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 Scott Harrison +# $Id: lonindexer.pm,v 1.154 2006/12/05 02:55:53 albertel 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/ +# +### + +############################################################################### +## ## +## 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::lonnet; +use Apache::loncommon(); +use Apache::lonhtmlcommon(); +use Apache::lonsequence(); use Apache::Constants qw(:common); +use Apache::lonmeta; use Apache::File; +use Apache::lonlocal; +use Apache::lonsource(); use GDBM_File; +use LONCAPA qw(:match); -my %hash; # tied to a user-specific gdbm file +# ---------------------------------------- variables used throughout the module +my %hash; # global 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 - +my %dynhash; # hash of hashes for dynamic metadata +my %dynread; # hash of directories already read for dynamic metadata +my %fieldnames; # Metadata fieldnames # ----- 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'); - 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'); + my $c = $r->connection(); + &Apache::loncommon::content_type($r,'text/html'); + &Apache::loncommon::no_cache($r); $r->send_http_header; return OK if $r->header_only; $fnum=0; $dnum=0; -# --------------------------------------------- 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); + %fieldnames=&Apache::lonmeta::fieldnames(); + +# ------------------------------------- read in machine configuration variables my $iconpath= $r->dir_config('lonIconsURL') . "/"; my $domain = $r->dir_config('lonDefDomain'); my $role = $r->dir_config('lonRole'); @@ -70,83 +109,228 @@ 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','titleelement']); + #------------------------------------------------------------------- my $closebutton=''; my $groupimportbutton=''; my $colspan=''; - + $extrafield=''; my $diropendb = - "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; + "/home/httpd/perl/tmp/$env{'user.domain'}_$env{'user.name'}_sel_res.db"; + %hash = (); + { + my %dbfile; + if (tie(%dbfile,'GDBM_File',$diropendb,&GDBM_WRITER(),0640)) { + if ($env{'form.launch'} eq '1') { + &start_fresh_session(\%dbfile); + } - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { - if ($ENV{'form.launch'} eq '1') { - &start_fresh_session(); + while(my($key,$value)=each(%dbfile)) { + $hash{$key}=$value; + } + untie(%dbfile); } - + } + { + #Hijack lonindexer to verify a title and be close down. + if ($env{'form.launch'} eq '2') { + &Apache::loncommon::content_type($r,'text/html'); + my $extra=''; + if (defined($env{'form.titleelement'}) && + $env{'form.titleelement'} ne '') { + my $verify_title = &Apache::lonnet::gettitle($env{'form.acts'}); +# &Apache::lonnet::logthis("Hrrm $env{'form.acts'} -- $verify_title"); + $verify_title=~s/'/\\'/g; + $extra='window.opener.document.forms["'.$env{'form.form'}.'"].elements["'.$env{'form.titleelement'}.'"].value=\''.$verify_title.'\';'; + } + my $js = < + function load() { + window.opener.document.forms["$env{'form.form'}"] + .elements["$env{'form.element'}"] + .value='$env{'form.acts'}'; + $extra + window.close(); + } + +ENDSUBM + $r->print(&Apache::loncommon::start_page(undef,$js, + {'only_body' =>1, + 'add_entries' => + {'onload' => "load();"},} + ). + &Apache::loncommon::end_page()); + return OK; + } + # -------------------- 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'; + if ($env{'form.catalogmode'} eq 'interactive') { $extrafield=''. - ''; $colspan=" colspan='2' "; + my $cl=&mt('Close'); $closebutton=< + END } - elsif ($ENV{'form.catalogmode'} eq 'groupimport') { - $hash{'mode_catalog'}='groupimport'; + elsif ($env{'form.catalogmode'} eq 'import') { $extrafield=''. - ''; $colspan=" colspan='2' "; + my $cl=&mt('Close'); + my $gi=&mt('Import'); $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.titleelement',\%env,'form.titleelement'); + &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,$titleelement); + if ($mode eq 'edit' || $mode eq 'parmset') { + $form = $env{'form.form'}; + $element = $env{'form.element'}; + $titleelement = $env{'form.titleelement'}; + } + #&Apache::lonxml::debug("mode=$mode form=$form element=$element titleelement=$titleelement"); # ------ 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 - + my $js = <<"ENDHEADER"; - - - ENDHEADER + my ($headerdom)=($uri=~m{^/res/($match_domain)/}); + $r->print(&Apache::loncommon::start_page('Browse Resources',$js, + {'domain' => $headerdom,})); # - Evaluate actions from previous page (both cumulatively and chronologically) - if ($ENV{'form.catalogmode'} eq 'groupimport') { - my $acts=$ENV{'form.acts'}; + if ($env{'form.catalogmode'} eq 'import') { + 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 { + foreach (@Acts) { my ($state,$ref)=split(/a/); $ahash{$ref}=$state; $achash{$ref}=$ac; $ac++; - } (@Acts); - # sorting through the actions and changing the tied database hash - map { + } + # sorting through the actions and changing the global database hash + foreach (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) { my $key=$_; if ($ahash{$key} eq '1') { $hash{'store_'.$hash{'pre_'.$key.'_link'}}= @@ -218,9 +399,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_//; @@ -228,81 +409,140 @@ ENDHEADER 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<=6; $i++) { +# ---------------------------------- get state of file attributes to be showing + if ($env{'form.attrs'}) { + for (my $i=0; $i<=11; $i++) { delete $hash{'display_attrs_'.$i}; - if ($ENV{'form.attr'.$i} == 1) { - $attrchk[$i] = "checked"; + 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; + for (my $i=0; $i<=11; $i++) { + $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 +# All versions has to the last item +# since it does not take an extra col + my %lt=&Apache::lonlocal::texthash( + 'ti' => 'Title', + 'si' => 'Size', + 'la' => 'Last access', + 'lm' => 'Last modified', + 'st' => 'Statistics', + 'au' => 'Author', + 'kw' => 'Keywords', + 'ln' => 'Language', + 'sa' => 'Source Available', + 'sr' => 'Show resource', + 'li' => 'Linked/Related Resources', + 'av' => 'All versions', + 'ud' => 'Update Display' + ); $r->print(<Display file attributes
- - - - - - - - - + +
Size Last access Last modified All versions
Author Keywords Language
+ + + + + + + + + + + + + + + + -
 
- + + + + -  - -$closebutton -$groupimportbutton -
+$closebutton $groupimportbutton END - - # output starting row to the indexed file/directory hierarchy +# -------------- Filter out sequence containment in crumbs and "recent folders" + my $storeuri=$uri; + $storeuri='/'.(split(/\.(page|sequence)\/\//,$uri))[-1]; + $storeuri=~s/\/+/\//g; +# ---------------------------------------------------------------- Bread crumbs + $r->print(&Apache::lonhtmlcommon::crumbs($storeuri,'','', + (($env{'form.catalogmode'} eq 'import')? + 'document.forms.fileattr':'')). + &Apache::lonhtmlcommon::select_recent('residx','resrecent', +'window.status=this.form.resrecent.options[this.form.resrecent.selectedIndex].value;this.form.action=this.form.resrecent.options[this.form.resrecent.selectedIndex].value;this.form.submit();')); +# -------------------------------------------------------- Resource Home Button + my $reshome=$env{'course.'.$env{'request.course.id'}.'.reshome'}; + if ($reshome) { + $r->print("
print('javascript:document.forms.fileattr.action="'.$reshome.'";document.forms.fileattr.submit();'); + } else { + $r->print($reshome); + } + $r->print("'>".&mt('Home').''); + } + $r->print(''); +# ------------------------------------------------------ Remember where we were + &Apache::loncommon::storeresurl($storeuri); + &Apache::lonhtmlcommon::store_recent('residx',$storeuri,$storeuri); +# ----------------- 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("\n") + if ($hash{'display_attrs_8'} == 1); + $r->print("\n") + if ($hash{'display_attrs_10'} == 1); + $r->print("\n") + if ($hash{'display_attrs_11'} == 1); + $r->print("\n") + if ($hash{'display_attrs_7'} == 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'}; + 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'; @@ -317,21 +557,19 @@ END } } - 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 ($env{'form.dirPointer'} 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/"){ +# -------------------------------- 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); @@ -340,70 +578,82 @@ 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 - $r->print(""); - $r->print(""); - - # end the tables - $r->print("
".&mt('Name')."".&mt('Title')."".&mt("Size")." (".&mt("bytes").") ". + "".&mt("Last accessed")."Author(s)".&mt("Last modified")."Keywords".&mt("Author(s)")."Language".&mt("Keywords")."
".&mt("Language")."".&mt("Usage Statistics")."
(". + &mt("Courses/Network Hits").")
".&mt('updated periodically')."
".&mt("Source Available")."".&mt("Linked/Related Resources")."".&mt("Resource")."
"); - $r->print("
"); - - # end the output and return - $r->print("\n"); - untie(%hash); - } else { - $r->print('Unable to tie hash to db '. - 'file'); - return OK; + +# -------------------------------------------------------------- end the tables + $r->print('
'); +# ---------------------------- embed hidden information useful for group import + $r->print("
"); + $r->print("
"); +# -------------------------------------------------------------- end the tables + $r->print(''); + +# --------------------------------------------------- end the output and return + $r->print(&Apache::loncommon::end_page()."\n"); } + if(! $c->aborted()) { +# write back into the temporary file + my %dbfile; + if (tie(%dbfile,'GDBM_File',$diropendb,&GDBM_NEWDB(),0640)) { + while (my($key,$value) = each(%hash)) { + $dbfile{$key}=$value; + } + untie(%dbfile); + } + } + return OK; } - # ----------------------------------------------- recursive scan of a directory sub scanDir { my ($r,$startdir,$indent,$hashref)=@_; + my $c = $r->connection(); my ($compuri,$curdir); my $dirptr=16384; + my $obs; $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$/; + return if ($c->aborted()); + #This is a kludge, sorry aboot this + my ($strip,$dom,undef,$testdir,undef,undef,undef,undef,undef,undef,undef,undef,undef,undef,$obs,undef)=split(/\&/,$line,16); + next if($strip =~ /.*\.meta$/ | $obs eq '1'); my (@fileparts) = split(/\./,$strip); - if ($hash{'display_attrs_6'} != 1) { + if ($hash{'display_attrs_9'} != 1) { +# if not all versions to be shown 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+/); + next if (grep /\Q$fname\E/,@list and $ov =~ /^\d+$/); } } - if ($dom eq "domain") { - $compuri = join('',$strip,"/"); # dom list has /res/ - $curdir = $compuri; + if ($dom eq 'domain') { + # dom list has full path /res// already + $curdir=''; + $compuri = (split(/\&/,$line))[0]; } 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"; - if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/)) { + my $diropen = 'closed'; + if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/) or ($compuri=~/\.(sequence|page)\/$/)) { while (my ($key,$val)= each %dupdirs) { if ($key eq $compuri and $val eq "open") { $diropen = "opened"; - delete $dupdirs{key},$dirs{$key}; + delete($dupdirs{$key}); + delete($dirs{$key}); } } } &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--; } @@ -411,25 +661,85 @@ sub scanDir { # --------------- 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") { - map { + my @list=(); + (my $luri = $uri) =~ s/\//_/g; + if ($env{'form.updatedisplay'}) { + foreach (keys %hash) { delete $hash{$_} if ($_ =~ /^dirlist_files_/); - } keys %hash; + delete $hash{$_} if ($_ =~ /^dirlist_timestamp_files_/); + } } - if ($hash{'dirlist_files'.$luri}) { + if (defined($hash{'dirlist_files_'.$luri}) && + $hash{'dirlist_timestamp_files_'.$luri}+600 > (time)) { @list = split(/\n/,$hash{'dirlist_files_'.$luri}); + } elsif ($uri=~/\.(page|sequence)\/$/) { +# is a page or a sequence + $uri=~s/\/$//; + $uri='/'.(split(/\.(page|sequence)\/\//,$uri))[-1]; + $uri=~s/\/+/\//g; + foreach (&Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$uri))) { + my @ratpart=split(/\:/,$_); + push @list,$ratpart[1]; + } + $hash{'dirlist_files_'.$luri} = join("\n",@list); } else { +# is really a directory @list = &Apache::lonnet::dirlist($uri); - $hash{'dirlist_files_'.$luri} = join('\n',@list); + $hash{'dirlist_files_'.$luri} = join("\n",@list); + $hash{'dirlist_timestamp_files_'.$luri} = time; } return @list=&match_ext($r,@list); } +sub dynmetaread { + my $uri=shift; + if (($hash{'display_attrs_8'}==1) || ($hash{'display_attrs_11'}==1)) { +# We don't want the filename + $uri=~s/\/[^\/]+$//; +# Did we already see this? + my $builddir=$uri; + while ($builddir) { + if ($dynread{$builddir}) { + return 0; + } + $builddir=~s/\/[^\/]+$//; + } +# Actually get the data + %dynhash= + (%dynhash,&Apache::lonmeta::get_dynamic_metadata_from_sql($uri.'/')); +# Remember that we got it + $dynread{$uri}=1; + } +} + +sub initdebug { + my $start_page= + &Apache::loncommon::start_page('Debug',undef, + {'only_body' => 1,}); + $start_page =~ s/\n/ /g; + 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('$start_page
');   
+
+ENDJS
+}
+
+sub writedebug {
+    my ($text) = @_;
+    return "";
+}
+
 # -------------------- filters out files based on extensions (returns an array)
 sub match_ext {
     my ($r,@packlist)=@_;
@@ -438,265 +748,478 @@ 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;
+	my $fnptr = ($unpackline[3]&$dirptr) || ($fext=~/\.(page|sequence)$/);
  	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;
 	}
     }
-    @trimlist = sort (@trimlist);
+    @trimlist = sort {uc($a) cmp uc($b)} (@trimlist);
     return @trimlist;
 }
 
 # ------------------------------- 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 (@pathfn, $fndir);
+# there could be relative paths (files actually belonging into this directory)
+# or absolute paths (for example, from sequences)
+    my $absolute;
+    my $pathprefix;
+    if ($line=~m|^/res/| && $startdir ne '') {
+	$absolute=1;
+	$pathprefix='';
+    } else {
+	$absolute=0;
+	$pathprefix=$startdir;
+    }
     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";
+    my $msg = &mt('View').' '.$filecom[0].' '.&mt('resources');
+    $msg = &mt('Close').' '.$filecom[0].' '.&mt('directory') if $diropen eq 'opened';
 
-    my $tabtag="";
+    my $tabtag='';
     my $i=0;
-
-    while ($i<=5) {
-	$tabtag=join('',$tabtag," ")
+    while ($i<=11) {
+	$tabtag=join('',$tabtag," ")
 	    if $hash{'display_attrs_'.$i} == 1;
 	$i++;
     }
+    my $valign = ($hash{'display_attrs_7'} == 1 ? 'top' : 'bottom');
 
 # display uplink arrow
-    if ($filecom[1] eq "viewOneUp") {
-	$r->print("$extrafield");
-	$r->print("\n");
-	$r->print ('
print("$extrafield"); + $r->print("\n"); + $r->print (''."\n"); $r->print (''."\n"); - $r->print (''."\n"); + $startdir.'" />'."\n"); + $r->print (''."\n"); $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + $r->print (' name="'.$msg.'" height="22" type="image" border="0" />'. "\n"); - $r->print("Up $tabtag
\n"); + $r->print(&mt("Up")."$tabtag\n"); return OK; } +# Do we have permission to look at this? + + if($filecom[15] ne '1') { return OK if (!&Apache::lonnet::allowed('bre',$pathprefix.$filecom[0])); } + +# make absolute links appear on different background + if ($absolute) { $fileclr='#ccdd99'; } # 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].'/'; + 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 (''); + $r->print (''); $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + $r->print (' name="'.$msg.'" height="22" type="image" border="0" />'. "\n"); - $r->print ('print ('print (' border="0" />'."\n"); - $r->print("Domain - $listname $tabtag\n"); + $r->print (&mt("Domain")." - $listname "); + if ($Apache::lonnet::domaindescription{$listname}) { + $r->print("(".$Apache::lonnet::domaindescription{$listname}. + ")"); + } + $r->print ("$tabtag\n"); return OK; # 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; &begin_form ($r,$curdir); - $r->print (''."\n"); - $r->print (''); + $r->print (''); $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + $r->print (' name="'.$msg.'" height="22" type="image" border="0" />'. "\n"); - $r->print (''); - $r->print ($listname.$tabtag.''."\n"); + my $domain=(split(m|/|,$startdir))[2]; + my $plainname=&Apache::loncommon::plainname($listname,$domain); + $r->print ($listname); + if (defined($plainname) && $plainname) { $r->print(" ($plainname) "); } + $r->print (''.$tabtag.''."\n"); return OK; } # display file - if ($fnptr == 0 and $filecom[3] ne "") { + if (($fnptr == 0 and $filecom[3] ne '') or $absolute) { + my $filelink = $pathprefix.$filecom[0]; my @file_ext = split (/\./,$listname); - my $curfext = $file_ext[scalar(@file_ext)-1]; - 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; - $r->print(""); - $r->print("". + 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 = &Apache::loncommon::icon($listname); + $r->print(""); + + if ($env{'form.catalogmode'} eq 'interactive') { + my $quotable_filelink = &Apache::loncommon::escape_single($filelink); + $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(""); + } elsif ($env{'form.catalogmode'} eq 'import') { + $r->print("\n"); $r->print("print("checked"); } - $r->print(">\n"); - $r->print("\n"); - $r->print("
\n"); - $r->print(""); + $r->print(" />\n"); + $r->print(""); $hash{"pre_${fnum}_link"}=$filelink; - $hash{"pre_${fnum}_title"}=$title; $fnum++; } - +# Form to open or close sequences + if ($filelink=~/\.(page|sequence)$/) { + my $curdir = $startdir.$filecom[0].'/'; + my $anchor = $curdir; + $anchor =~ s/\///g; + &begin_form($r,$curdir); + $indent--; + } +# General indentation if ($indent > 0 and $indent < 11) { - $r->print("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("print("\"\"\n") if $rem > 0; } - - $r->print("\n"); - $r->print (" $listname "); - - $r->print (" (metadata) ") if ($metafile == 1); - +# Sequence open/close icon + if ($filelink=~/\.(page|sequence)$/) { + my $curdir = $startdir.$filecom[0].'/'; + my $anchor = $curdir; + $anchor =~ s/\///g; + $r->print (''); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0" />'. + "\n"); + } +# Filetype icons + $r->print("\"\"\n"); + my $quotable_filelink = &Apache::loncommon::escape_single($filelink); + + + $r->print (" $listname "); + + $r->print (" (metadata) "); +# Close form to open/close sequence + if ($filelink=~/\.(page|sequence)$/) { + $r->print(''); + } $r->print("\n"); - $r->print(" ", + if ($hash{'display_attrs_0'} == 1) { + my $title = &Apache::lonnet::gettitle($filelink,'title'); + $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) { - 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. + my $author = &Apache::lonnet::metadata($filelink,'author'); + $r->print(' '.($author eq '' ? ' ' : $author). " \n"); } if ($hash{'display_attrs_5'} == 1) { - my $lang = &Apache::lonnet::metadata($filelink,'language') - if ($metafile == 1); - $lang = $language{$lang}; - $lang = ' ' if (!$lang); - $r->print(" ".$lang. + my $keywords = &Apache::lonnet::metadata($filelink,'keywords'); + # $keywords = ' ' if (!$keywords); + $r->print(' '.($keywords eq '' ? ' ' : $keywords). + " \n"); + } +#' + + if ($hash{'display_attrs_6'} == 1) { + my $lang = &Apache::lonnet::metadata($filelink,'language'); + $lang = &Apache::loncommon::languagedescription($lang); + $r->print(' '.($lang eq '' ? ' ' : $lang). " \n"); } + if ($hash{'display_attrs_8'} == 1) { +# statistics + &dynmetaread($filelink); + $r->print(""); + &dynmetaprint($r,$filelink,'count'); + &dynmetaprint($r,$filelink,'course'); + &dynmetaprint($r,$filelink,'stdno'); + &dynmetaprint($r,$filelink,'avetries'); + &dynmetaprint($r,$filelink,'difficulty'); + &dynmetaprint($r,$filelink,'disc'); + &dynmetaprint($r,$filelink,'clear'); + &dynmetaprint($r,$filelink,'technical'); + &dynmetaprint($r,$filelink,'correct'); + &dynmetaprint($r,$filelink,'helpful'); + &dynmetaprint($r,$filelink,'depth'); + $r->print(" \n"); + + } + if ($hash{'display_attrs_10'} == 1) { + my $source = &Apache::lonnet::metadata($filelink,'sourceavail'); + if($source eq 'open') { + my $sourcelink = &Apache::lonsource::make_link($filelink,$listname); + my $quotable_sourcelink = &Apache::loncommon::escape_single($sourcelink); + $r->print(''."Yes "."\n"); + } else { #A cuddled else. :P + $r->print(" \n"); + } + } + if ($hash{'display_attrs_11'} == 1) { +# links + &dynmetaread($filelink); + $r->print(''); + &coursecontext($r,$filelink); + &dynmetaprint($r,$filelink,'goto_list'); + &dynmetaprint($r,$filelink,'comefrom_list'); + &dynmetaprint($r,$filelink,'sequsage_list'); + &dynmetaprint($r,$filelink,'dependencies'); + &dynmetaprint($r,$filelink,'course_list'); + $r->print(''); + } + if ($hash{'display_attrs_7'} == 1) { +# Show resource + my $output=&showpreview($filelink); + $r->print(' '.($output eq '' ? ' ':$output). + " \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"); + $r->print("$extrafield"); &begin_form ($r,$curdir); my $indentm1 = $indent-1; if ($indentm1 < 11 and $indentm1 > 0) { - $r->print("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 ("print ("\"\"\n") if $rem > 0; } - $r->print (''); - $r->print (''); + $r->print ('print (' name="'.$msg.'" height="22" type="image" border="0">'. + $r->print (' name="'.$msg.'" height="22" type="image" border="0" />'. "\n"); - $r->print ('' + .''.&mt('Open Folder').''. "\n"); - $r->print ("$listname$tabtag\n"); + $r->print ("$listname\n"); +# Attributes + my $filelink = $startdir.$filecom[0].'/default'; + + if ($hash{'display_attrs_0'} == 1) { + my $title = &Apache::lonnet::gettitle($filelink,'title'); + $r->print(' '.($title eq '' ? ' ' : $title). + ' '."\n"); + } + $r->print(' ', + $filecom[8]," \n") + if $hash{'display_attrs_1'} == 1; + $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_4'} == 1) { + my $author = &Apache::lonnet::metadata($filelink,'author'); + $r->print(' '.($author eq '' ? ' ' : $author). + " \n"); + } + if ($hash{'display_attrs_5'} == 1) { + my $keywords = &Apache::lonnet::metadata($filelink,'keywords'); + # $keywords = ' ' if (!$keywords); + $r->print(' '.($keywords eq '' ? ' ' : $keywords). + " \n"); + } + if ($hash{'display_attrs_6'} == 1) { + my $lang = &Apache::lonnet::metadata($filelink,'language'); + $lang = &Apache::loncommon::languagedescription($lang); + $r->print(' '.($lang eq '' ? ' ' : $lang). + " \n"); + } + if ($hash{'display_attrs_8'} == 1) { + $r->print(' '); + } + if ($hash{'display_attrs_10'} == 1) { + $r->print(' '); + } + if ($hash{'display_attrs_11'} == 1) { + $r->print(' '); + } + if ($hash{'display_attrs_7'} == 1) { + $r->print(' '); + } + $r->print(''); } } +sub coursecontext { + my ($r,$filelink)=@_; + my $filesymb=&Apache::lonnet::symbread($filelink); + if ($filesymb) { + my ($map,$index,$resource)=&Apache::lonnet::decode_symb($filesymb); + $r->print(&mt('Already in this course:
[_1] in folder/map [_2].
', + &Apache::lonnet::gettitle($resource), + &Apache::lonnet::gettitle($map))); + } +} + +sub showpreview { + my ($filelink)=@_; + if ($filelink=~m-^(/ext/|http://)-) { + return &mt('External Resource, preview not enabled'); + } + my ($curfext)=($filelink=~/\.(\w+)$/); + my $output=''; + my $embstyle=&Apache::loncommon::fileembstyle($curfext); + if ($embstyle eq 'ssi') { + my $cache=$Apache::lonnet::perlvar{'lonDocRoot'}.$filelink. + '.tmp'; + if ((!$env{'form.updatedisplay'}) && + (-e $cache)) { + open(FH,$cache); + $output=join("\n",); + close(FH); + } else { +# In update display mode, remove old cache. This is done to retroactively +# clean up course context renderings. + if (-e $cache) { + unlink($cache); + } + $output=&Apache::lonnet::ssi_body($filelink); +# Is access denied? Don't render, don't store + if ($output=~/LONCAPAACCESSCONTROLERRORSCREEN/s) { + $output=''; +# Was this rendered in course content? Don't store + } elsif (!&Apache::lonnet::symbread($filelink)) { + open(FH,">$cache"); + print FH $output; + close(FH); + } + } + $output=''.$output.''; + } elsif ($embstyle eq 'img') { + $output=''.&mt('Preview').''; + } elsif ($filelink=~m{^/res/($match_domain)/($match_username)/}) { + $output=''.&mt('Preview').''; + } + return $output; +} + +sub dynmetaprint { + my ($r,$filelink,$item)=@_; + if ($dynhash{$filelink}->{$item}) { + $r->print("\n
".$fieldnames{$item}.': '. + &Apache::lonmeta::prettyprint($item, + $dynhash{$filelink}->{$item}, + (($env{'form.catalogmode'} ne 'import')?'preview':''), + '', + (($env{'form.catalogmode'} eq 'import')?'document.forms.fileattr':''),1)); + } +} + # ------------------- prints the beginning of a form for directory or file link sub begin_form { my ($r,$uri) = @_; @@ -707,36 +1230,189 @@ sub begin_form { '" onSubmit="return rep_dirpath(\''.$dnum.'\''. ',document.forms.fileattr.acts.value)" '. 'enctype="application/x-www-form-urlencoded">'."\n"); - $r->print (''. + $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; + my ($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; -__END__ + +sub cleanup { + if (tied(%hash)){ + &Apache::lonnet::logthis('Cleanup indexer: hash'); + } + return OK; +} + + + + + +=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