--- loncom/interface/lonindexer.pm 2003/01/15 23:58:58 1.56 +++ loncom/interface/lonindexer.pm 2004/10/21 11:18:41 1.128 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Directory Indexer # -# $Id: lonindexer.pm,v 1.56 2003/01/15 23:58:58 www Exp $ +# $Id: lonindexer.pm,v 1.128 2004/10/21 11:18:41 foxr Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,26 +25,6 @@ # # 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 -# 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,10/15,11/28,11/29 Scott Harrison -# 11/30 Matthew Hall -# 12/11,12/13 Scott Harrison -# YEAR=2002 -# 1/17 Scott Harrison -# 6/29/2002 H. K. Ng -# ### ############################################################################### @@ -66,15 +46,22 @@ package Apache::lonindexer; use strict; 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; # ---------------------------------------- variables used throughout the module -my %hash; # tied to a user-specific gdbm file +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 @@ -86,21 +73,24 @@ 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; - 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); + %fieldnames=&Apache::lonmeta::fieldnames(); # ------------------------------------- read in machine configuration variables my $iconpath= $r->dir_config('lonIconsURL') . "/"; @@ -121,7 +111,7 @@ sub handler { # Get the parameters from the query string &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['catalogmode','launch','acts','mode','form','element', - 'only','omit']); + 'only','omit','titleelement']); #------------------------------------------------------------------- my $closebutton=''; my $groupimportbutton=''; @@ -129,12 +119,51 @@ sub handler { $extrafield=''; my $diropendb = - "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; - - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) { + "/home/httpd/perl/tmp/$ENV{'user.domain'}_$ENV{'user.name'}_indexer.db"; + %hash = (); + { + my %dbfile; + if (tie(%dbfile,'GDBM_File',$diropendb,&GDBM_READER(),0640)) { + while(my($key,$value)=each(%dbfile)) { + $hash{$key}=$value; + } + untie(%dbfile); + } + } + { if ($ENV{'form.launch'} eq '1') { &start_fresh_session(); - } + } + #Hijack lonindexer to verify a title and be close down. + if ($ENV{'form.launch'} eq '2') { + $r->content_type('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.'\';'; + } + $r->print(< + + + + + +ENDSUBM + return OK; + } + # -------------------- refresh environment with user database values (in %hash) &setvalues(\%hash,'form.catalogmode',\%ENV,'form.catalogmode' ); @@ -144,8 +173,9 @@ sub handler { ''; $colspan=" colspan='2' "; + my $cl=&mt('Close'); $closebutton=< + END } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { @@ -153,11 +183,13 @@ END ''; $colspan=" colspan='2' "; + my $cl=&mt('Close'); + my $gi=&mt('Import'); $closebutton=< + END $groupimportbutton=< END } @@ -169,12 +201,13 @@ END # 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' ); + #&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'}) { @@ -185,12 +218,13 @@ END } my $mode = $ENV{'form.mode'}; - my ($form,$element); + my ($form,$element,$titleelement); if ($mode eq 'edit' || $mode eq 'parmset') { - $form = $ENV{'form.form'}; - $element = $ENV{'form.element'}; + $form = $ENV{'form.form'}; + $element = $ENV{'form.element'}; + $titleelement = $ENV{'form.titleelement'}; } - &Apache::lonxml::debug("mode=$mode form=$form element=$element"); + #&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 @@ -209,21 +243,13 @@ END $location .= "mode=".$mode."&"; $location .= "acts="; $catalogmodefunctions=<<"END"; -function select_data(title,url) { - changeTitle(title); +function select_data(url) { 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) { @@ -237,11 +263,10 @@ END $location .= "form=$form&element=$element&mode=edit&acts="; $catalogmodefunctions=< The LearningOnline Network With CAPA Directory Browser + + ENDJS } @@ -612,7 +755,7 @@ sub match_ext { 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 "") { my $embstyle = &Apache::loncommon::fileembstyle($fext); push @trimlist,$line if (defined($embstyle) && @@ -621,7 +764,7 @@ sub match_ext { push @trimlist,$line; } } - @trimlist = sort (@trimlist); + @trimlist = sort {uc($a) cmp uc($b)} (@trimlist); return @trimlist; } @@ -629,6 +772,17 @@ sub match_ext { sub display_line { my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_; 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') . '/'; @@ -637,23 +791,28 @@ sub display_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 $i=0; - - while ($i<=6) { + 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 ('print ('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].'/'; + $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 (''); @@ -684,18 +849,23 @@ sub display_line { $diropen.'.gif"'); $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. "\n"); - $r->print ('print ('print (' border="0" />'."\n"); - $r->print("Domain - $listname (". - $Apache::lonnet::domaindescription{$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"); + $r->print("$extrafield"); + $r->print("\n"); my $curdir = $startdir.$filecom[0].'/'; my $anchor = $curdir; $anchor =~ s/\///g; @@ -707,17 +877,22 @@ sub display_line { '.gif"'); $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 '') { - my $filelink = $startdir.$filecom[0]; - return OK if (!&Apache::lonnet::allowed('bre',$filelink)); + if (($fnptr == 0 and $filecom[3] ne '') or $absolute) { + my $filelink = $pathprefix.$filecom[0]; my @file_ext = split (/\./,$listname); my $curfext = $file_ext[-1]; if (@Omit) { @@ -729,34 +904,17 @@ sub display_line { return OK if ($skip > 0); } # Set the icon for the file - my $iconname = "unknown.gif"; - my $embstyle = &Apache::loncommon::fileembstyle($curfext); - # The unless conditional that follows is a bit of overkill - $iconname = $curfext.".gif" unless - (!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn'); - # - $r->print(""); - my $metafile = grep /^$filecom[0]\.meta\&/, @list; - my $title; + my $iconname = &Apache::loncommon::icon($listname); + $r->print(""); + if ($ENV{'form.catalogmode'} eq 'interactive') { - $title=$listname; - $title = &Apache::lonnet::metadata($filelink,'title') - if ($metafile == 1); - $title=$listname unless $title; - my $titleesc=HTML::Entities::encode($title); - $titleesc=~s/\'/\\'/; #' (clean up this spare quote) + my $quotable_filelink = &Apache::loncommon::escape_single($filelink); $r->print(""); + $quotable_filelink,"')\">"); $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; - my $titleesc=&HTML::Entities::encode($title); + $r->print(""); + } elsif ($ENV{'form.catalogmode'} eq 'groupimport') { $r->print("
\n"); $r->print("\n"); $r->print("
\n"); - $r->print(""); + $r->print(""); $hash{"pre_${fnum}_link"}=$filelink; - $hash{"pre_${fnum}_title"}=$titleesc; $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("\n"); @@ -789,62 +952,136 @@ sub display_line { $r->print("\n") if $rem > 0; } +# 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"); +# Close form to open/close sequence + if ($filelink=~/\.(page|sequence)$/) { + $r->print(''); + } + my $quotable_filelink = &Apache::loncommon::escape_single($filelink); - $r->print("\n"); - $r->print (" $listname "); - $r->print (" (metadata) ") if ($metafile == 1); + $r->print (" $listname "); + $r->print (" (metadata) "); $r->print("\n"); if ($hash{'display_attrs_0'} == 1) { - my $title = &Apache::lonnet::metadata($filelink,'title') - if ($metafile == 1); - $r->print(' '.($title eq '' ? ' ' : $title). + my $title = &Apache::lonnet::gettitle($filelink,'title'); + $r->print(' '.($title eq '' ? ' ' : $title). ' '."\n"); } - $r->print(' ', + $r->print(' ', $filecom[8]," \n") if $hash{'display_attrs_1'} == 1; - $r->print(' '. + $r->print(' '. (localtime($filecom[9]))." \n") if $hash{'display_attrs_2'} == 1; - $r->print(' '. + $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') - if ($metafile == 1); - $r->print(' '.($author eq '' ? ' ' : $author). + 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') - if ($metafile == 1); + my $keywords = &Apache::lonnet::metadata($filelink,'keywords'); # $keywords = ' ' if (!$keywords); - $r->print(' '.($keywords eq '' ? ' ' : $keywords). + $r->print(' '.($keywords eq '' ? ' ' : $keywords). " \n"); } +#' + if ($hash{'display_attrs_6'} == 1) { - my $lang = &Apache::lonnet::metadata($filelink,'language') - if ($metafile == 1); + my $lang = &Apache::lonnet::metadata($filelink,'language'); $lang = &Apache::loncommon::languagedescription($lang); - $r->print(' '.($lang eq '' ? ' ' : $lang). + $r->print(' '.($lang eq '' ? ' ' : $lang). " \n"); } - if ($hash{'display_attrs_8'} == 1) { + 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(''); + &dynmetaprint($r,$filelink,'goto_list'); + &dynmetaprint($r,$filelink,'comefrom_list'); + &dynmetaprint($r,$filelink,'sequsage_list'); + &dynmetaprint($r,$filelink,'dependencies'); + $r->print(''); + } + if ($hash{'display_attrs_7'} == 1) { +# Show resource my $output=''; - if (&Apache::loncommon::fileembstyle($curfext) eq 'ssi') { - $output=&Apache::lonnet::ssi($filelink); - $output=~s/^.*\]*\>//si; - $output=~s/\<\/body\s*\>.*$//si; - $output=''.$output.''; - } - $r->print(' '.($output eq '' ? ' ':$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 { + $output=&Apache::lonnet::ssi_body($filelink); + open(FH,">$cache"); + print FH $output; + close(FH); + } + $output=''.$output.''; + } elsif ($embstyle eq 'img') { + $output=''; + } elsif ($filelink=~/^\/res\/(\w+)\/(\w+)\//) { + $output=''; + } + $r->print(' '.($output eq '' ? ' ':$output). " \n"); } $r->print("\n"); @@ -852,12 +1089,10 @@ sub display_line { # -- 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) { @@ -880,14 +1115,76 @@ sub display_line { 'folder_pointer_'.$diropen.'.gif"'); $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. "\n"); - $r->print (''. "\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 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 'groupimport')?'preview':''), + '', + (($ENV{'form.catalogmode'} eq 'groupimport')?'document.forms.fileattr':''),1)); + } +} + # ------------------- prints the beginning of a form for directory or file link sub begin_form { my ($r,$uri) = @_; @@ -935,12 +1232,13 @@ sub setvalues { sub cleanup { if (tied(%hash)){ &Apache::lonnet::logthis('Cleanup indexer: hash'); - unless (untie(%hash)) { - &Apache::lonnet::logthis('Failed cleanup indexer: hash'); - } } } + + + + =head1 NAME Apache::lonindexer - mod_perl module for cross server filesystem browsing