--- loncom/interface/lonindexer.pm 2001/05/21 18:11:31 1.5
+++ loncom/interface/lonindexer.pm 2003/10/24 21:09:24 1.79
@@ -1,40 +1,106 @@
# 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.79 2003/10/24 21:09:24 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/
+#
+# 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
+# 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::lonmeta;
use Apache::File;
+use Apache::lonlocal;
use GDBM_File;
-my %hash;
-my %dirs;
-my %language;
-
-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');
+ 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;
- my $iconpath= $r->dir_config('lonIconsURL');
+ # 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');
my $loadlim = $r->dir_config('lonLoadLim');
@@ -43,75 +109,392 @@ sub handler {
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 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/$ENV{'user.domain'}_$ENV{'user.name'}_indexer.db";
+ %hash = ();
+ {
+ my %dbfile;
+ if (tie(%dbfile,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
+ while(my($key,$value)=each(%dbfile)) {
+ $hash{$key}=$value;
+ }
+ untie(%dbfile);
+ }
+ }
+ {
+ if ($ENV{'form.launch'} eq '1') {
+ &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') {
+ $extrafield='
'.
+ ' | ';
+ $colspan=" colspan='2' ";
+ my $cl=&mt('Close');
+ $closebutton=<
+END
+ }
+ elsif ($ENV{'form.catalogmode'} eq 'groupimport') {
+ $extrafield=''.
+ ' | ';
+ $colspan=" colspan='2' ";
+ my $cl=&mt('Close');
+ my $gi=&mt('Group 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') {
+ # 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.
+
+#
+# There is now also mode "simple", which is for the simple version of the rat
+#
+#
+ if (!defined($mode) || ($mode ne 'edit' && $mode ne 'parmset')) {
+ my $location = "/adm/groupsort?catalogmode=groupimport&";
+ $location .= "mode=".$mode."&";
+ $location .= "acts=";
+ $catalogmodefunctions=<<"END";
+function select_data(title,url) {
+ changeTitle(title);
+ changeURL(url);
+ self.close();
+}
+function select_group() {
+ window.location="$location"+document.forms.fileattr.acts.value;
+}
+function changeTitle(val) {
+ if (opener.inf) {
+ if (opener.inf.document.forms.resinfo.elements.t) {
+ opener.inf.document.forms.resinfo.elements.t.value=val;
+ }
+ }
+}
+function changeURL(val) {
+ if (opener.inf) {
+ if (opener.inf.document.forms.resinfo.elements.u) {
+ opener.inf.document.forms.resinfo.elements.u.value=val;
+ }
+ }
+}
+END
+ } elsif ($mode eq 'edit') { # we are in 'edit' mode
+ my $location = "/adm/groupsort?catalogmode=interactive&";
+ $location .= "form=$form&element=$element&mode=edit&acts=";
+ $catalogmodefunctions=<print(<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;
- my $iconpath="/res/adm/pages/indexericons/";
-
- $r->print("The LearningOnline With CAPA Network Directory Browser
\n");
-
- for (my $i=0; $i<=5; $i++) {
- $attrchk[$i] = "checked" if $ENV{'form.attr'.$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 ($ENV{'form.attr0'} == 1);
- $r->print("Last accessed | \n") if ($ENV{'form.attr1'} == 1);
- $r->print("Last modified | \n") if ($ENV{'form.attr2'} == 1);
- $r->print("Author(s) | \n") if ($ENV{'form.attr3'} == 1);
- $r->print("Keywords | \n") if ($ENV{'form.attr4'} == 1);
- $r->print("Language | \n") if ($ENV{'form.attr5'} == 1);
- $r->print(" ");
+# ----------------- 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("".&mt("Resource")." | \n")
+ if ($hash{'display_attrs_7'} == 1);
+ $r->print("".&mt("Usage Statistics")." (".
+ &mt("Courses/Network Hits").") | \n")
+ if ($hash{'display_attrs_8'} == 1);
+ $r->print(' ');
- my $diropen = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db";
-
- if (tie(%hash,'GDBM_File',$diropen,&GDBM_WRCREAT,0640)) {
- 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'};
@@ -128,24 +511,65 @@ END
$dirs{$uri} = 'open';
}
}
-
- my $toplevel = "/res/";
+
+ my $bredir = $ENV{'form.dirPointer'};
+ my $toplevel;
my $indent = 0;
- &scanDir ($r,$toplevel,$indent);
+ $uri = $uri.'/' if $uri !~ /.*\/$/;
- $r->print(" ");
- $r->print(" | ");
- $r->print("
|