--- loncom/interface/lonindexer.pm 2001/08/08 03:00:11 1.16
+++ loncom/interface/lonindexer.pm 2003/02/20 19:41:26 1.61
@@ -1,54 +1,103 @@
# 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)
+# $Id: lonindexer.pm,v 1.61 2003/02/20 19:41:26 www 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
-# 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
-# 8/6,8/7 Scott Harrison
+# 6/26,7/8 H. K. Ng
+# 8/14 H. K. Ng
+# 11/30 Matthew Hall
+# YEAR=2002
+# 6/29/2002 H. K. Ng
+#
+###
+
+###############################################################################
+## ##
+## 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;
-my %hash;
-my %dirs;
-my %language;
-my $hidden;
-my $extrafield;
-my $fnum;
-my $dnum;
-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; # 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
+
+# ----- 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');
+ &Apache::loncommon::no_cache($r);
$r->send_http_header;
return OK if $r->header_only;
$fnum=0;
$dnum=0;
+ untie %hash;
+
+ # Deal with stupid global variables (is there a way around making
+ # these global to this package? It is just so wrong....)
+ undef (@Only);
+ undef (@Omit);
+
+# ------------------------------------- read in machine configuration variables
my $iconpath= $r->dir_config('lonIconsURL') . "/";
my $domain = $r->dir_config('lonDefDomain');
my $role = $r->dir_config('lonRole');
@@ -64,184 +113,201 @@ sub handler {
my $uri=$r->uri;
# -------------------------------------- see if called from an interactive mode
-# foreach my $key (sort(keys(%ENV))) {
-# $r->print("$key is $ENV{$key} ");
-# }
-# $r->print("END ENV");
- 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;
- }
- if ($name eq 'launch') {
- $ENV{'form.'.$name}=$value;
- }
- if ($name eq 'acts') {
- $ENV{'form.'.$name}=$value;
- }
- } (split(/&/,$ENV{'QUERY_STRING'}));
-
- $hidden=''; my $closebutton='';
+ # Get the parameters from the query string
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ ['catalogmode','launch','acts','mode','form','element',
+ 'only','omit']);
+ #-------------------------------------------------------------------
+ my $closebutton='';
my $groupimportbutton='';
my $colspan='';
$extrafield='';
- my $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db";
+ my $diropendb =
+ "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db";
- if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
if ($ENV{'form.launch'} eq '1') {
- delete $hash{'mode_catalog'};
- map {
- if ($_ =~ /^pre_/) {
- delete $hash{$_};
- }
- if ($_ =~ /^store/) {
- delete $hash{$_};
- }
- } keys %hash;
- }
- if ($hash{'mode_catalog'} eq 'interactive') {
- $ENV{'form.catalogmode'}='interactive';
- }
- if ($hash{'mode_catalog'} eq 'groupimport') {
- $ENV{'form.catalogmode'}='groupimport';
- }
+ &start_fresh_session();
+ }
+# -------------------- refresh environment with user database values (in %hash)
+ &setvalues(\%hash,'form.catalogmode',\%ENV,'form.catalogmode' );
+# --------------------- define extra fields and buttons in case of special mode
if ($ENV{'form.catalogmode'} eq 'interactive') {
- $hash{'mode_catalog'}='interactive';
$extrafield='
';
+ ' border="0" />';
$colspan=" colspan='2' ";
- $hidden=<
-END
$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.only' ,\%ENV,'form.only' );
+ &setvalues(\%hash,'form.omit' ,\%ENV,'form.omit' );
+
+ # Deal with 'omit' and 'only'
+ if (exists $ENV{'form.omit'}) {
+ @Omit = split(',',$ENV{'form.omit'});
+ }
+ if (exists $ENV{'form.only'}) {
+ @Only = split(',',$ENV{'form.only'});
+ }
+
+ my $mode = $ENV{'form.mode'};
+ my ($form,$element);
+ if ($mode eq 'edit' || $mode eq 'parmset') {
+ $form = $ENV{'form.form'};
+ $element = $ENV{'form.element'};
+ }
+ &Apache::lonxml::debug("mode=$mode form=$form element=$element");
+# ------ set catalogmodefunctions to have extra needed javascript functionality
my $catalogmodefunctions='';
if ($ENV{'form.catalogmode'} eq 'interactive' or
$ENV{'form.catalogmode'} eq 'groupimport') {
- $catalogmodefunctions=<print(<The LearningOnline Network With CAPA Directory Browser
-
-
ENDHEADER
+$r->print(&Apache::loncommon::bodytag('Browse Resources'));
+# - Evaluate actions from previous page (both cumulatively and chronologically)
if ($ENV{'form.catalogmode'} eq 'groupimport') {
-# $r->print($ENV{'form.acts'}." ");
my $acts=$ENV{'form.acts'};
my @Acts=split(/b/,$acts);
my %ahash;
my %achash;
my $ac=0;
- map {
+ # some initial hashes for working with data
+ foreach (@Acts) {
my ($state,$ref)=split(/a/);
$ahash{$ref}=$state;
$achash{$ref}=$ac;
$ac++;
- } (@Acts);
- map {
+ }
+ # 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') {
-# $r->print("NEW: ");
-# $r->print($hash{'pre_'.$key.'_title'});
-# $r->print(" : ");
-# $r->print($hash{'pre_'.$key.'_link'});
-# $r->print(" ");
$hash{'store_'.$hash{'pre_'.$key.'_link'}}=
$hash{'pre_'.$key.'_title'};
$hash{'storectr_'.$hash{'pre_'.$key.'_link'}}=
@@ -290,99 +353,92 @@ ENDHEADER
delete $hash{'store_'.$hash{'pre_'.$key.'_link'}};
}
}
- } sort {$achash{$a}<=>$achash{$b}} (keys %ahash);
- map {
- if ($_ =~ /^store_/) {
- my $key=$_;
- $key=~s/^store_//;
-# $r->print("STORE: ");
-# $r->print($hash{'storectr_'.$key});
-# $r->print(':');
-# $r->print($hash{'store_'.$key});
-# $r->print(':');
-# $r->print($key);
-# $r->print(" ");
- }
- } keys %hash;
- map {
+ }
+ # deleting the previously cached listing
+ foreach (keys %hash) {
if ($_ =~ /^pre_/ && $_ =~/link$/) {
my $key = $_;
$key =~ s/^pre_//;
$key =~ s/_[^_]*$//;
-# $r->print($key);
-# $r->print(':');
-# $r->print($hash{'pre_'.$key.'_title'});
-# $r->print(':');
-# $r->print($hash{'pre_'.$key.'_link'});
-# $r->print(' ');
delete $hash{'pre_'.$key.'_title'};
delete $hash{'pre_'.$key.'_link'};
}
- } keys %hash;
+ }
}
- $r->print('
The LearningOnline With CAPA Network Directory Browser
'."\n");
- } else {
- $r->print('Unable to tie hash to db file');
- return OK;
- }
- untie %hash;
- if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
-
- if ($ENV{'form.attrs'} ne "") {
- for (my $i=0; $i<=5; $i++) {
+# ---------------------------------- get state of file attributes to be showing
+ if ($ENV{'form.attrs'} ne '') {
+ for (my $i=0; $i<=8; $i++) {
delete $hash{'display_attrs_'.$i};
if ($ENV{'form.attr'.$i} == 1) {
- $attrchk[$i] = "checked";
+ $attrchk[$i] = 'checked';
$hash{'display_attrs_'.$i} = 1;
}
}
} else {
- for (my $i=0; $i<=5; $i++) {
- $attrchk[$i] = "checked" if $hash{'display_attrs_'.$i} == 1;
+ for (my $i=0; $i<=8; $i++) {
+ $attrchk[$i] = 'checked' if $hash{'display_attrs_'.$i} == 1;
}
}
+# ------------------------------- output state of file attributes to be showing
$r->print(<Display file attributes
-
END
+# ----------------- output starting row to the indexed file/directory hierarchy
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("
");
+# $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("
Name
\n");
+ $r->print("
Title
\n")
+ if ($hash{'display_attrs_0'} == 1);
+ $r->print("
Size (bytes) ".
+ "
\n") if ($hash{'display_attrs_1'} == 1);
+ $r->print("
Last accessed
\n")
+ if ($hash{'display_attrs_2'} == 1);
+ $r->print("
Last modified
\n")
+ if ($hash{'display_attrs_3'} == 1);
+ $r->print("
Author(s)
\n")
+ if ($hash{'display_attrs_4'} == 1);
+ $r->print("
Keywords
\n")
+ if ($hash{'display_attrs_5'} == 1);
+ $r->print("
Language
\n")
+ if ($hash{'display_attrs_6'} == 1);
+ $r->print("
Resource
\n")
+ if ($hash{'display_attrs_8'} == 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'};
@@ -404,14 +460,17 @@ END
my $toplevel;
my $indent = 0;
$uri = $uri.'/' if $uri !~ /.*\/$/;
- if ($bredir ne "on") {
+
+ if ($bredir ne 'on') {
$hash{'top.level'} = $uri;
$toplevel = $uri;
} else {
$toplevel = $hash{'top.level'};
}
- 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);
@@ -419,22 +478,30 @@ END
&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("