--- loncom/interface/lonindexer.pm 2001/06/26 21:11:18 1.12
+++ loncom/interface/lonindexer.pm 2006/03/16 22:42:58 1.141
@@ -1,47 +1,98 @@
# 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)
-# 11/23 Gerd Kortemeyer
-# 07/20-08/04 H.K. Ng
-#
-# 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
+#
+# $Id: lonindexer.pm,v 1.141 2006/03/16 22:42:58 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;
-my %hash;
-my %dirs;
-my %language;
-my $hidden;
-my $extrafield;
-my $fnum;
-sub BEGIN {
- my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.'/language.tab');
- map {
- $_=~/(\w+)\s+([\w\s\-]+)/;
- $language{$1}=$2;
- } <$fh>;
-}
+# ---------------------------------------- variables used throughout the module
+my %hash; # 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
+
+# ----- Used to include or exclude files with certain extensions.
+my @Only = ();
+my @Omit = ();
+
+
+
+# ----------------------------- Handling routine called via Apache and mod_perl
sub handler {
my $r = shift;
- $r->content_type('text/html');
+ 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;
+
+ # 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');
@@ -52,197 +103,443 @@ sub handler {
my $tabdir = $r->dir_config('lonTabDir');
my $fileclr='#ffffe6';
-# -------------------------------------- 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'}));
+ my $line;
+ my (@attrchk,@openpath);
+ my $uri=$r->uri;
- $hidden=''; my $closebutton='';
+# -------------------------------------- see if called from an interactive mode
+ # 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='';
- if ($ENV{'form.catalogmode'} eq 'interactive') {
- $extrafield='
';
+ $colspan=" colspan='2' ";
+ my $cl=&mt('Close');
+ my $gi=&mt('Import');
+ $closebutton=<
END
- $groupimportbutton=<
+ $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') {
+ # The if statement below sets us up to use the old version
+ # by default (ie. if $mode is undefined). This is the easy
+ # way out. Hopefully in the future I'll find a way to get
+ # the calls dealt with in a more comprehensive manner.
- my $catalogmodefunctions='';
- if ($ENV{'form.catalogmode'} eq 'interactive' or
- $ENV{'form.catalogmode'} eq 'groupimport') {
- $catalogmodefunctions=<print(<
-
-The LearningOnline Network With CAPA Directory Browser
-
-
-
-
-
+function gothere(val) {
+ window.location=val+'?acts='+document.forms.fileattr.acts.value;
+}
+
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)) {
-
- if ($ENV{'form.attrs'} ne "") {
- for (my $i=0; $i<=5; $i++) {
+ my ($headerdom)=($uri=~/^\/res\/(\w+)\//);
+ $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'};
+ 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 global 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'};
+ }
+ }
+ }
+
+# ---------------------------------- 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<=5; $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;
}
}
- $r->print(<Display file attributes
-
-END
- my $titleclr="#ddffff";
- $r->print("
\n");
- $r->print("
\n");
- $r->print("
Name
\n");
- $r->print("
Size (bytes)
\n") if ($hash{'display_attrs_0'} == 1);
- $r->print("
Last accessed
\n") if ($hash{'display_attrs_1'} == 1);
- $r->print("
Last modified
\n") if ($hash{'display_attrs_2'} == 1);
- $r->print("
Author(s)
\n") if ($hash{'display_attrs_3'} == 1);
- $r->print("
Keywords
\n") if ($hash{'display_attrs_4'} == 1);
- $r->print("
Language
\n") if ($hash{'display_attrs_5'} == 1);
- $r->print("
");
+# ------------------------------- 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(<
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+$closebutton $groupimportbutton
+END
+# -------------- 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 'groupimport')?
+ '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(&initdebug());
+ #$r->print(&writedebug("Omit:@Omit")) if (@Omit);
+ #$r->print(&writedebug("Only:@Only")) if (@Only);
+ $r->print('
'."\n");
+ $r->print('
'."\n");
+ $r->print("
".&mt('Name')."
\n");
+ $r->print("
".&mt('Title')."
\n")
+ if ($hash{'display_attrs_0'} == 1);
+ $r->print("
".&mt("Size")." (".&mt("bytes").") ".
+ "
\n") if ($hash{'display_attrs_1'} == 1);
+ $r->print("
".&mt("Last accessed")."
\n")
+ if ($hash{'display_attrs_2'} == 1);
+ $r->print("
".&mt("Last modified")."
\n")
+ if ($hash{'display_attrs_3'} == 1);
+ $r->print("
".&mt("Author(s)")."
\n")
+ if ($hash{'display_attrs_4'} == 1);
+ $r->print("
".&mt("Keywords")."
\n")
+ if ($hash{'display_attrs_5'} == 1);
+ $r->print("
".&mt("Language")."
\n")
+ if ($hash{'display_attrs_6'} == 1);
+ $r->print("
\n")
+ if ($hash{'display_attrs_8'} == 1);
+ $r->print("
".&mt("Source Available")."
\n")
+ if ($hash{'display_attrs_10'} == 1);
+ $r->print("
".&mt("Linked/Related Resources")."
\n")
+ if ($hash{'display_attrs_11'} == 1);
+ $r->print("
".&mt("Resource")."
\n")
+ if ($hash{'display_attrs_7'} == 1);
+ $r->print('
');
- 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';
@@ -257,92 +554,189 @@ END
}
}
- my $bredir = $ENV{'form.dirPointer'};
my $toplevel;
+ my $indent = 0;
$uri = $uri.'/' if $uri !~ /.*\/$/;
- if ($uri eq "/res/" or $bredir ne "on") {
- $hash{'top.level'} = $uri;
- $toplevel = $uri;
- } elsif ($bredir eq "on") {
- if ($hash{'top.level'} eq "/res/") {
- $toplevel = "/res/";
- } else {
- $toplevel = $uri;
- }
+
+ 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/'){
+ 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;
}
- my $indent = 0;
- &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("
