--- loncom/interface/lonindexer.pm 2001/07/08 18:31:10 1.13
+++ loncom/interface/lonindexer.pm 2025/03/18 19:36:59 1.232
@@ -1,250 +1,639 @@
# 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
-# 07/08/2001 H. K. Ng
+#
+# $Id: lonindexer.pm,v 1.232 2025/03/18 19:36:59 raeburn 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. Handling routine called via Apache and mod_perl ##
+## 5. 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 Apache::groupsort();
use GDBM_File;
+use LONCAPA qw(:match);
+
+# ---------------------------------------- variables used throughout the module
+my %hash; # global user-specific gdbm file
+my %dirs; # keys are directories, values are the open/close status
+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 = ();
-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>;
-}
+
+
+# ----------------------------- 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();
+
+# --------------------------------------------------------------- get icon path
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 $defdom = &Apache::lonnet::default_login_domain();
- 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'}));
+#SB my $fileclr='#ffffe6';
+ my $line;
+ my (@attrchk,@openpath,$typeselect);
+ 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 'import') {
+ # 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$inhibit_menu;
+}
+// ]]>
+
ENDHEADER
- my $line;
- my (@attrchk,@openpath);
- my $uri=$r->uri;
-
- $r->print('
The LearningOnline With CAPA Network Directory Browser
'."\n");
+ my ($headerdom)=($uri=~m{^/res/($match_domain)/});
- my $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db";
-
- if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) {
+ if ($env{'form.catalogmode'}) {
+ # "Popup mode"
+ $r->print(&Apache::loncommon::start_page('Browse published resources',$js,
+ {'only_body' => 1, 'add_wishlist'=>1, 'add_modal' =>1,
+ 'domain' => $headerdom,}));
+ } else {
+ # Only display page header and breadcrumbs in non-popup mode
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ &Apache::lonhtmlcommon::add_breadcrumb({
+ 'text' => 'Browse published resources',
+ 'href' => '/res/'.$headerdom.'/?launch=1',
+ });
+ $r->print(&Apache::loncommon::start_page('Browse published resources',$js,
+ {'domain' => $headerdom,})
+ .&Apache::lonhtmlcommon::breadcrumbs()
+ );
+ }
+
+# ---------------------------------- get state of file types to be showing
+ if ($env{'form.only'}) {
+ $typeselect = $env{'form.only'};
+ } else {
+ $typeselect = '';
+ }
- if ($ENV{'form.attrs'} ne "") {
- for (my $i=0; $i<=5; $i++) {
+# ---------------------------------- get state of file attributes to be showing
+ if ($env{'form.attrs'}) {
+ for (my $i=0; $i<=16; $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<=16; $i++) {
+ $attrchk[$i] = 'checked="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("
");
+ my @file_categories = &Apache::loncommon::filecategories();
+ my %select_file_categories;
+ my @select_form_order = ('');
+ $select_file_categories{''} = &mt('All file types');
+ foreach my $cat (@file_categories) {
+ my $types = join(",",&Apache::loncommon::filecategorytypes($cat));
+ $select_file_categories{$types} = &mt($cat);
+ push(@select_form_order,$types);
+ }
+ $select_file_categories{'select_form_order'} = \@select_form_order;
+ my $onchange = 'this.form.submit();';
+ my $type_element=
+ &Apache::loncommon::select_form(
+ $typeselect,
+ 'only',
+ \%select_file_categories,$onchange);
+ my $type_selector = '';
+
+# ------------------------------- 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(
+ 'av' => 'All versions',
+ 'ud' => 'Update Display',
+ 'pr' => 'Problems',
+ 'gr' => 'Graphics',
+ 'at' => 'All types',
+ 'hd' => 'Display Options'
+ );
+ my @disp_order = ('0','4','5','6','13','1','2','3','10','14','8','11','7','12','15','16');
+ my %disp_options = &Apache::lonlocal::texthash (
+ 0 => 'Title',
+ 4 => 'Author',
+ 5 => 'Keywords',
+ 6 => 'Language',
+ 13 => 'Notes',
+ 1 => 'Size',
+ 2 => 'Last access',
+ 3 => 'Last modified',
+ 10 => 'Source Available',
+ 14 => 'Abstract',
+ 8 => 'Statistics',
+ 11 => 'Linked/Related Resources',
+ 7 => 'Show resource',
+ 12 => 'Subject',
+ 15 => 'Grade Level',
+ 16 => 'Standards',
+ );
+ my $cell = 0;
+ my $numinrow = 4;
+ $r->print('
+');
+# ------------------------------------------------------ Remember where we were
+ &Apache::loncommon::storeresurl($storeuri);
+ &Apache::lonhtmlcommon::store_recent('residx',$storeuri,$storeuri);
+# -------------------------------------------------- Check All and Uncheck all
+ if ($env{'form.catalogmode'} eq 'import') {
+ $r->print('
');
+ $r->print('
');
+ }
+# ----------------- output starting row to the indexed file/directory hierarchy
+ #$r->print(&initdebug());
+ #$r->print(&writedebug("Omit:@Omit")) if (@Omit);
+ #$r->print(&writedebug("Only:@Only")) if (@Only);
+ $r->print(&Apache::loncommon::start_data_table("LC_tableBrowseRes")
+ .&Apache::loncommon::start_data_table_header_row());
+ $r->print("
".&mt('Name')."
\n");
+ $r->print('
'.&mt('Add to Stored Links')."
\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("
".&mt("Subject")."
\n")
+ if ($hash{'display_attrs_12'} == 1);
+ $r->print("
".&mt("Notes")."
\n")
+ if ($hash{'display_attrs_13'} == 1);
+ $r->print("
".&mt("Abstract")."
\n")
+ if ($hash{'display_attrs_14'} == 1);
+ $r->print("
".&mt("Grade Level")."
\n")
+ if ($hash{'display_attrs_15'} == 1);
+ $r->print("
".&mt("Standards")."
\n")
+ if ($hash{'display_attrs_16'} == 1);
+
+ $r->print(&Apache::loncommon::end_data_table_header_row());
+
+
- 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';
@@ -259,97 +648,213 @@ 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 ($toplevel ne "/res/"){
+ 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);
+ &display_line ($r,$defdom,'opened',$upone.'&viewOneUp',0,$upone,@list);
$indent = 1;
}
- &scanDir ($r,$toplevel,$indent);
-
- $r->print("");
- $r->print("