File:  [LON-CAPA] / loncom / interface / lonindexer.pm
Revision 1.59: download - view: text, annotated - select for diffs
Mon Feb 3 18:03:52 2003 UTC (21 years, 4 months ago) by harris41
Branches: MAIN
CVS tags: HEAD
best wishes to all.

    1: # The LearningOnline Network with CAPA
    2: # Directory Indexer
    3: #
    4: # $Id: lonindexer.pm,v 1.59 2003/02/03 18:03:52 harris41 Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: # YEAR=1999
   29: # 5/21/99, 5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer)
   30: # 11/23 Gerd Kortemeyer
   31: # YEAR=2000
   32: # 07/20-08/04 H.K. Ng
   33: # YEAR=2001
   34: # 05/9-05/19/2001 H. K. Ng
   35: # 05/21/2001 H. K. Ng
   36: # 05/23/2001 H. K. Ng
   37: # 6/26,7/8 H. K. Ng
   38: # 8/14 H. K. Ng
   39: # 11/30 Matthew Hall
   40: # YEAR=2002
   41: # 6/29/2002 H. K. Ng
   42: #
   43: ###
   44: 
   45: ###############################################################################
   46: ##                                                                           ##
   47: ## ORGANIZATION OF THIS PERL MODULE                                          ##
   48: ##                                                                           ##
   49: ## 1. Description of functions                                               ##
   50: ## 2. Modules used by this module                                            ##
   51: ## 3. Choices for different output views (detailed, summary, xml, etc)       ##
   52: ## 4. BEGIN block (to be run once after compilation)                         ##
   53: ## 5. Handling routine called via Apache and mod_perl                        ##
   54: ## 6. Other subroutines                                                      ##
   55: ##                                                                           ##
   56: ###############################################################################
   57: 
   58: package Apache::lonindexer;
   59: 
   60: # ------------------------------------------------- modules used by this module
   61: use strict;
   62: use Apache::lonnet();
   63: use Apache::loncommon();
   64: use Apache::Constants qw(:common);
   65: use Apache::File;
   66: use GDBM_File;
   67: 
   68: # ---------------------------------------- variables used throughout the module
   69: my %hash; # tied to a user-specific gdbm file
   70: my %dirs; # keys are directories, values are the open/close status
   71: my %language; # has the reference information present in language.tab
   72: 
   73: # ----- Values which are set by the handler subroutine and are accessible to
   74: # -----     other methods.
   75: my $extrafield; # default extra table cell
   76: my $fnum; # file counter
   77: my $dnum; # directory counter
   78: 
   79: # ----- Used to include or exclude files with certain extensions.
   80: my @Only = ();
   81: my @Omit = ();
   82: 
   83: 
   84: # ----------------------------- Handling routine called via Apache and mod_perl
   85: sub handler {
   86:     my $r = shift;
   87:     $r->content_type('text/html');
   88:     &Apache::loncommon::no_cache($r);
   89:     $r->send_http_header;
   90:     return OK if $r->header_only;
   91:     $fnum=0;
   92:     $dnum=0;
   93:     untie %hash;
   94: 
   95:     # Deal with stupid global variables (is there a way around making
   96:     # these global to this package?  It is just so wrong....)
   97:     undef (@Only);
   98:     undef (@Omit);
   99: 
  100: # ------------------------------------- read in machine configuration variables
  101:     my $iconpath= $r->dir_config('lonIconsURL') . "/";
  102:     my $domain  = $r->dir_config('lonDefDomain');
  103:     my $role    = $r->dir_config('lonRole');
  104:     my $loadlim = $r->dir_config('lonLoadLim');
  105:     my $servadm = $r->dir_config('lonAdmEMail');
  106:     my $sysadm  = $r->dir_config('lonSysEMail');
  107:     my $lonhost = $r->dir_config('lonHostID');
  108:     my $tabdir  = $r->dir_config('lonTabDir');
  109: 
  110:     my $fileclr='#ffffe6';
  111:     my $line;
  112:     my (@attrchk,@openpath);
  113:     my $uri=$r->uri;
  114: 
  115: # -------------------------------------- see if called from an interactive mode
  116:     # Get the parameters from the query string
  117:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  118: 	     ['catalogmode','launch','acts','mode','form','element',
  119:               'only','omit']);
  120:     #-------------------------------------------------------------------
  121:     my $closebutton='';
  122:     my $groupimportbutton='';
  123:     my $colspan=''; 
  124: 
  125:     $extrafield='';
  126:     my $diropendb = 
  127: 	"/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db";
  128: 
  129:     if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
  130: 	if ($ENV{'form.launch'} eq '1') {
  131: 	    &start_fresh_session();
  132:         }
  133: # -------------------- refresh environment with user database values (in %hash)
  134: 	&setvalues(\%hash,'form.catalogmode',\%ENV,'form.catalogmode'   );
  135: 
  136: # --------------------- define extra fields and buttons in case of special mode
  137: 	if ($ENV{'form.catalogmode'} eq 'interactive') {
  138: 	    $extrafield='<td bgcolor="'.$fileclr.'" valign="bottom">'.
  139: 		'<a name="$anchor"><img src="'.$iconpath.'whitespace1.gif"'.
  140: 		' border="0" /></td>';
  141: 	    $colspan=" colspan='2' ";
  142:             $closebutton=<<END;
  143: <input type="button" name="close" value='CLOSE' onClick="self.close()">
  144: END
  145:         }
  146: 	elsif ($ENV{'form.catalogmode'} eq 'groupimport') {
  147: 	    $extrafield='<td bgcolor="'.$fileclr.'" valign="bottom">'.
  148: 		'<a name="$anchor"><img src="'.$iconpath.'whitespace1.gif"'.
  149: 		' border="0" /></td>';
  150: 	    $colspan=" colspan='2' ";
  151:             $closebutton=<<END;
  152: <input type="button" name="close" value='CLOSE' onClick="self.close()">
  153: END
  154:             $groupimportbutton=<<END;
  155: <input type="button" name="groupimport" value='GROUP IMPORT'
  156: onClick="javascript:select_group()">
  157: END
  158:         }
  159: 	# Additions made by Matthew to make the browser a little easier to deal
  160: 	# with in the future.
  161: 	#
  162: 	# $mode (at this time) indicates if we are in edit mode.
  163: 	# $form is the name of the form that the URL is placed when the
  164: 	#       selection is made.
  165: 	# $element is the name of the element in $formname which receives
  166: 	#       the URL.
  167: 	# &Apache::lonxml::debug('Checking mode, form, element');
  168: 	&setvalues(\%hash,'form.mode'   ,\%ENV,'form.mode'   );
  169: 	&setvalues(\%hash,'form.form'   ,\%ENV,'form.form'   );
  170: 	&setvalues(\%hash,'form.element',\%ENV,'form.element');
  171: 	&setvalues(\%hash,'form.only'   ,\%ENV,'form.only'   );
  172: 	&setvalues(\%hash,'form.omit'   ,\%ENV,'form.omit'   );
  173: 
  174:         # Deal with 'omit' and 'only' 
  175:         if (exists $ENV{'form.omit'}) {
  176:             @Omit = split(',',$ENV{'form.omit'});
  177:         }
  178:         if (exists $ENV{'form.only'}) {
  179:             @Only = split(',',$ENV{'form.only'});
  180:         }
  181:         
  182: 	my $mode = $ENV{'form.mode'};
  183: 	my ($form,$element);
  184: 	if ($mode eq 'edit' || $mode eq 'parmset') {
  185: 	    $form    = $ENV{'form.form'};
  186: 	    $element = $ENV{'form.element'};
  187: 	}
  188: 	&Apache::lonxml::debug("mode=$mode form=$form element=$element");
  189: # ------ set catalogmodefunctions to have extra needed javascript functionality
  190: 	my $catalogmodefunctions='';
  191: 	if ($ENV{'form.catalogmode'} eq 'interactive' or
  192: 	    $ENV{'form.catalogmode'} eq 'groupimport') {
  193: 	    # The if statement below sets us up to use the old version
  194: 	    # by default (ie. if $mode is undefined).  This is the easy
  195: 	    # way out.  Hopefully in the future I'll find a way to get 
  196: 	    # the calls dealt with in a more comprehensive manner.
  197: 
  198: #
  199: # There is now also mode "simple", which is for the simple version of the rat
  200: #
  201: #
  202: 	    if (!defined($mode) || ($mode ne 'edit' && $mode ne 'parmset')) {
  203:                 my $location = "/adm/groupsort?catalogmode=groupimport&";
  204:                 $location .= "mode=".$mode."&";
  205:                 $location .= "acts=";
  206: 		$catalogmodefunctions=<<"END";
  207: function select_data(title,url) {
  208:     changeTitle(title);
  209:     changeURL(url);
  210:     self.close();
  211: }
  212: function select_group() {
  213:     window.location="$location"+document.forms.fileattr.acts.value;
  214: }
  215: function changeTitle(val) {
  216:     if (opener.inf) {
  217:         if (opener.inf.document.forms.resinfo.elements.t) {
  218:             opener.inf.document.forms.resinfo.elements.t.value=val;
  219:         }
  220:     }
  221: }
  222: function changeURL(val) {
  223:     if (opener.inf) {
  224:         if (opener.inf.document.forms.resinfo.elements.u) {
  225: 	    opener.inf.document.forms.resinfo.elements.u.value=val;
  226:         }
  227:     }
  228: }
  229: END
  230:             } elsif ($mode eq 'edit') { # we are in 'edit' mode
  231:                 my $location = "/adm/groupsort?catalogmode=interactive&";
  232:                 $location .= "form=$form&element=$element&mode=edit&acts=";
  233: 		$catalogmodefunctions=<<END;
  234: // mode = $mode
  235: function select_data(title,url) {
  236:     changeURL(url);
  237:     self.close();
  238: }
  239: 
  240: function select_group() {
  241:     window.location="$location"+document.forms.fileattr.acts.value;
  242: }
  243: 
  244: function changeURL(val) {
  245:     if (window.opener.document) {
  246: 	window.opener.document.forms["$form"].elements["$element"].value=val;
  247:     } else {
  248: 	    alert("The file you selected is: "+val);
  249:     }
  250: }
  251: 
  252: END
  253:             } elsif ($mode eq 'parmset') {
  254:                 my $location = "/adm/groupsort?catalogmode=interactive&";
  255:                 $location .= "form=$form&element=$element&mode=parmset&acts=";
  256: 		$catalogmodefunctions=<<END;
  257: // mode = $mode
  258: function select_data(title,url) {
  259:     changeURL(url);
  260:     self.close();
  261: }
  262: 
  263: function select_group() {
  264:     window.location="$location"+document.forms.fileattr.acts.value;
  265: }
  266: 
  267: function changeURL(val) {
  268:     if (window.opener.document) {
  269:         var elementname  = "$element"+"_value";
  270:         var checkboxname = "$element"+"_setparmval";
  271: 	window.opener.document.forms["$form"].elements[elementname].value=val;
  272:         window.opener.document.forms["$form"].elements[checkboxname].checked=true;
  273:     } else {
  274: 	    alert("The file you selected is: "+val);
  275:     }
  276: }
  277: 
  278: END
  279:             }
  280:         }
  281:         $catalogmodefunctions.=<<END;
  282: var acts='';
  283: function rep_dirpath(suffix,val) {
  284:     eval("document.forms.dirpath"+suffix+".acts.value=val");
  285: }
  286: END
  287: 	if ($ENV{'form.catalogmode'} eq 'groupimport') {
  288:             $catalogmodefunctions.=<<END;
  289: function queue(val) {
  290:     if (eval("document.forms."+val+".filelink.checked")) {
  291: 	var l=val.length;
  292: 	var v=val.substring(4,l);
  293: 	document.forms.fileattr.acts.value+='1a'+v+'b';
  294:     }
  295:     else {
  296: 	var l=val.length;
  297: 	var v=val.substring(4,l);
  298: 	document.forms.fileattr.acts.value+='0a'+v+'b';
  299:     }
  300: }
  301: END
  302: 	}
  303: 
  304: # ---------------------------------------------------------------- Print Header
  305: 	$r->print(<<ENDHEADER);
  306: <html>
  307: <head>
  308: <title>The LearningOnline Network With CAPA Directory Browser</title>
  309: 
  310: <script type="text/javascript">
  311: $catalogmodefunctions
  312: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
  313:     var options = "width=" + w + ",height=" + h + ",";
  314:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
  315:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
  316:     var newWin = window.open(url, wdwName, options);
  317:     newWin.focus();
  318: }
  319: function gothere(val) {
  320:     window.location=val+'?acts='+document.forms.fileattr.acts.value;
  321: }
  322: </script>
  323: 
  324: </head>
  325: ENDHEADER
  326: $r->print(&Apache::loncommon::bodytag('Browse Resources'));
  327: # - Evaluate actions from previous page (both cumulatively and chronologically)
  328:         if ($ENV{'form.catalogmode'} eq 'groupimport') {
  329: 	    my $acts=$ENV{'form.acts'};
  330: 	    my @Acts=split(/b/,$acts);
  331: 	    my %ahash;
  332: 	    my %achash;
  333: 	    my $ac=0;
  334: 	    # some initial hashes for working with data
  335: 	    foreach (@Acts) {
  336: 		my ($state,$ref)=split(/a/);
  337: 		$ahash{$ref}=$state;
  338: 		$achash{$ref}=$ac;
  339: 		$ac++;
  340: 	    }
  341: 	    # sorting through the actions and changing the tied database hash
  342: 	    foreach (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) {
  343: 		my $key=$_;
  344: 		if ($ahash{$key} eq '1') {
  345: 		    $hash{'store_'.$hash{'pre_'.$key.'_link'}}=
  346: 			$hash{'pre_'.$key.'_title'};
  347: 		    $hash{'storectr_'.$hash{'pre_'.$key.'_link'}}=
  348: 			$hash{'storectr'}+0;
  349: 		    $hash{'storectr'}++;
  350: 		}
  351: 		if ($ahash{$key} eq '0') {
  352: 		    if ($hash{'store_'.$hash{'pre_'.$key.'_link'}}) {
  353: 			delete $hash{'store_'.$hash{'pre_'.$key.'_link'}};
  354: 		    }
  355: 		}
  356: 	    }
  357: 	    # deleting the previously cached listing
  358: 	    foreach (keys %hash) {
  359: 		if ($_ =~ /^pre_/ && $_ =~/link$/) {
  360: 		    my $key = $_;
  361: 		    $key =~ s/^pre_//;
  362: 		    $key =~ s/_[^_]*$//;
  363: 		    delete $hash{'pre_'.$key.'_title'};
  364: 		    delete $hash{'pre_'.$key.'_link'};
  365: 		}
  366: 	    }
  367: 	}
  368: 	
  369: # ---------------------------------- get state of file attributes to be showing
  370: 	if ($ENV{'form.attrs'} ne '') {
  371: 	    for (my $i=0; $i<=8; $i++) {
  372: 		delete $hash{'display_attrs_'.$i};
  373: 		if ($ENV{'form.attr'.$i} == 1) {
  374: 		    $attrchk[$i] = 'checked';
  375: 		    $hash{'display_attrs_'.$i} = 1;
  376: 		}
  377: 	    }
  378: 	} else {
  379: 	    for (my $i=0; $i<=8; $i++) {
  380: 		$attrchk[$i] = 'checked' if $hash{'display_attrs_'.$i} == 1;
  381: 	    }
  382: 	}
  383: # ------------------------------- output state of file attributes to be showing
  384: 	$r->print(<<END);
  385: <form method="post" name="fileattr" action="$uri"
  386:  enctype="application/x-www-form-urlencoded">
  387: <b><font color="#666666">Display file attributes</font></b><br />
  388: <table border=0><tr>
  389: <td><input type="checkbox" name="attr0" value="1" $attrchk[0] /> Title</td>
  390: <td><input type="checkbox" name="attr1" value="1" $attrchk[1] /> Size</td>
  391: <td><input type="checkbox" name="attr2" value="1" $attrchk[2] /> Last access</td>
  392: <td><input type="checkbox" name="attr3" value="1" $attrchk[3] /> Last modified</td>
  393: <td rowspan="2"><input type="checkbox" name="attr8" value="1" $attrchk[8] /> Show Resource</td></tr><tr>
  394: <td><input type="checkbox" name="attr4" value="1" $attrchk[4] /> Author</td>
  395: <td><input type="checkbox" name="attr5" value="1" $attrchk[5] /> Keywords</td>
  396: <td><input type="checkbox" name="attr6" value="1" $attrchk[6] /> Language</td>
  397: <td><input type="checkbox" name="attr7" value="1" $attrchk[7] /> All versions</td>
  398: </tr></table>
  399: <input type="hidden" name="dirPointer" value="on" />
  400: <input type="hidden" name="acts" value="" />
  401: <input type="submit" name="attrs" value="Review" />&nbsp;
  402: <input type="submit" name="attrs" value="Refresh" />
  403: $closebutton
  404: $groupimportbutton
  405: </form>
  406: END
  407: 
  408: # ----------------- output starting row to the indexed file/directory hierarchy
  409:         my $titleclr="#ddffff";
  410: #        $r->print(&initdebug());
  411: #        $r->print(&writedebug("Omit:@Omit")) if (@Omit);
  412: #        $r->print(&writedebug("Only:@Only")) if (@Only);
  413:         $r->print("<table width='100\%' border=0><tr><td bgcolor=#777777>\n");
  414: 	$r->print("<table width='100\%' border=0><tr bgcolor=$titleclr>\n");
  415: 	$r->print("<td $colspan><b>Name</b></td>\n");
  416: 	$r->print("<td><b>Title</b></td>\n") 
  417: 	    if ($hash{'display_attrs_0'} == 1);
  418: 	$r->print("<td align=right><b>Size (bytes) ".
  419: 		  "</b></td>\n") if ($hash{'display_attrs_1'} == 1);
  420: 	$r->print("<td><b>Last accessed</b></td>\n") 
  421: 	    if ($hash{'display_attrs_2'} == 1);
  422: 	$r->print("<td><b>Last modified</b></td>\n")
  423: 	    if ($hash{'display_attrs_3'} == 1);
  424: 	$r->print("<td><b>Author(s)</b></td>\n")
  425: 	    if ($hash{'display_attrs_4'} == 1);
  426: 	$r->print("<td><b>Keywords</b></td>\n")
  427: 	    if ($hash{'display_attrs_5'} == 1);
  428: 	$r->print("<td><b>Language</b></td>\n")
  429: 	    if ($hash{'display_attrs_6'} == 1);
  430: 	$r->print("<td><b>Resource</b></td>\n")
  431: 	    if ($hash{'display_attrs_8'} == 1);
  432: 	$r->print('</tr>');
  433: 
  434: # ----------------- read in what directories have previously been set to "open"
  435: 	foreach (keys %hash) {
  436: 	    if ($_ =~ /^diropen_status_/) {
  437: 		my $key = $_;
  438: 		$key =~ s/^diropen_status_//;
  439: 		$dirs{$key} = $hash{$_};
  440: 	    }
  441: 	}
  442: 
  443: 	if ($ENV{'form.openuri'}) {  # take care of review and refresh options
  444: 	    my $uri=$ENV{'form.openuri'};
  445: 	    if (exists($hash{'diropen_status_'.$uri})) {
  446: 		my $cursta = $hash{'diropen_status_'.$uri};
  447: 		$dirs{$uri} = 'open';
  448: 		$hash{'diropen_status_'.$uri} = 'open';
  449: 		if ($cursta eq 'open') {
  450: 		    $dirs{$uri} = 'closed';
  451: 		    $hash{'diropen_status_'.$uri} = 'closed';
  452: 		}
  453: 	    } else {
  454: 		$hash{'diropen_status_'.$uri} = 'open';
  455: 		$dirs{$uri} = 'open';
  456: 	    }
  457: 	}
  458: 	
  459: 	my $bredir = $ENV{'form.dirPointer'};
  460: 	my $toplevel;
  461: 	my $indent = 0;
  462: 	$uri = $uri.'/' if $uri !~ /.*\/$/;
  463: 
  464: 	if ($bredir ne 'on') {
  465: 	    $hash{'top.level'} = $uri;
  466: 	    $toplevel = $uri;
  467: 
  468: 	} else {
  469: 	    $toplevel = $hash{'top.level'};
  470: 	}
  471: 
  472: # -------------------------------- if not at top level, provide an uplink arrow
  473: 	if ($toplevel ne '/res/'){
  474: 	    my (@uri_com) = split(/\//,$uri);
  475: 	    pop @uri_com;
  476: 	    my $upone = join('/',@uri_com);
  477: 	    my @list = qw (0);
  478: 	    &display_line ($r,'opened',$upone.'&viewOneUp',0,$upone,@list);
  479: 	    $indent = 1;
  480: 	}
  481: 
  482: # -------- recursively go through all the directories and output as appropriate
  483: 	&scanDir ($r,$toplevel,$indent,\%hash);
  484: 	
  485: # ---------------------------- embed hidden information useful for group import
  486: 	$r->print("<form name='fnum'>");
  487: 	$r->print("<input type='hidden' name='fnum' value='$fnum'></form>");
  488: 
  489: # -------------------------------------------------------------- end the tables
  490: 	$r->print('</table>');
  491: 	$r->print('</td></tr></table>');
  492: 
  493: # --------------------------------------------------- end the output and return
  494: 	$r->print('</body></html>'."\n");
  495: 	untie(%hash);
  496:     } else {
  497: 	$r->print('<html><head></head><body>Unable to tie hash to db '.
  498: 		  'file</body></html>');
  499: 	return OK;
  500:     }
  501:     return OK;
  502: }
  503: 
  504: # ----------------------------------------------- recursive scan of a directory
  505: sub scanDir {
  506:     my ($r,$startdir,$indent,$hashref)=@_;
  507:     my ($compuri,$curdir);
  508:     my $dirptr=16384;
  509:     $indent++;
  510: 
  511:     my %dupdirs = %dirs;
  512:     my @list=&get_list($r,$startdir);
  513:     foreach my $line (@list) {
  514: 	my ($strip,$dom,undef,$testdir,undef)=split(/\&/,$line,5); 
  515: 	next if $strip =~ /.*\.meta$/;
  516: 	my (@fileparts) = split(/\./,$strip);
  517: 	if ($hash{'display_attrs_7'} != 1) {
  518: 	    if (scalar(@fileparts) >= 3) {
  519: 		my $fext = pop @fileparts;
  520: 		my $ov = pop @fileparts;
  521: 		my $fname = join ('.',@fileparts,$fext);
  522: 		next if (grep /$fname/,@list and $ov =~ /\d+/);
  523: 	    }
  524: 	}
  525: 
  526: 	if ($dom eq 'domain') {
  527: 	    $compuri = join('',$strip,'/');  # dom list has /res/<domain name>
  528: 	    $curdir = $compuri;
  529: 	} else {
  530: 	    # user, dir & file have name only, i.e., w/o path
  531: 	    $compuri = join('',$startdir,$strip,'/');
  532: 	    $curdir = $startdir;
  533: 	}
  534: 	my $diropen = 'closed';
  535: 	if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/)) {
  536: 	    while (my ($key,$val)= each %dupdirs) {
  537: 		if ($key eq $compuri and $val eq "open") {
  538: 		    $diropen = "opened";
  539: 		    delete($dupdirs{$key});
  540: 		    delete($dirs{$key});
  541: 		}
  542: 	    }
  543: 	}
  544: 	&display_line($r,$diropen,$line,$indent,$curdir,$hashref,@list);
  545: 	&scanDir ($r,$compuri,$indent) if $diropen eq 'opened';
  546:     }
  547:     $indent--;
  548: }
  549: 
  550: # --------------- get complete matched list based on the uri (returns an array)
  551: sub get_list {
  552:     my ($r,$uri)=@_;
  553:     my @list;
  554:     (my $luri = $uri) =~ s/\//_/g;
  555: 
  556:     if ($ENV{'form.attrs'} eq 'Refresh') {
  557: 	foreach (keys %hash) {
  558: 	    delete $hash{$_} if ($_ =~ /^dirlist_files_/);
  559: 	    }
  560:     }
  561: 
  562:     if ($hash{'dirlist_files'.$luri}) {
  563: 	@list = split(/\n/,$hash{'dirlist_files_'.$luri});
  564:     } else {
  565: 	@list = &Apache::lonnet::dirlist($uri);
  566: 	$hash{'dirlist_files_'.$luri} = join('\n',@list);
  567:     }
  568:     return @list=&match_ext($r,@list);
  569: }
  570: 
  571: sub initdebug {
  572:     return <<ENDJS;
  573: <script>
  574: var debugging = true;
  575: if (debugging) {
  576:     var debuggingWindow = window.open('','Debug','width=400,height=300',true);
  577: } 
  578: 
  579: function output(text) {
  580:     if (debugging) {
  581:         debuggingWindow.document.writeln(text);
  582:     }
  583: }
  584: output("<html><head><title>Debugging Window</title></head><body><pre>");   
  585: </script>
  586: ENDJS
  587: }
  588: 
  589: sub writedebug {
  590:     my $text = shift;
  591:     return "<script>output('$text');</script>";
  592: }
  593: 
  594: # -------------------- filters out files based on extensions (returns an array)
  595: sub match_ext {
  596:     my ($r,@packlist)=@_;
  597:     my @trimlist;
  598:     my $nextline;
  599:     my @fileext;
  600:     my $dirptr=16384;
  601: 
  602:     foreach my $line (@packlist) {
  603: 	chomp $line;
  604: 	$line =~ s/^\/home\/httpd\/html//;
  605: 	my @unpackline = split (/\&/,$line);
  606: 	next if ($unpackline[0] eq '.');
  607: 	next if ($unpackline[0] eq '..');
  608: 	my @filecom = split (/\./,$unpackline[0]);
  609: 	my $fext = pop(@filecom);
  610: 	my $fnptr = $unpackline[3]&$dirptr;
  611:  	if ($fnptr == 0 and $unpackline[3] ne "") {
  612: 	    my $embstyle = &Apache::loncommon::fileembstyle($fext);
  613:             push @trimlist,$line if (defined($embstyle) && 
  614: 				     ($embstyle ne 'hdn' or $fext eq 'meta'));
  615: 	} else {
  616: 	    push @trimlist,$line;
  617: 	}
  618:     }
  619:     @trimlist = sort (@trimlist);
  620:     return @trimlist;
  621: }
  622: 
  623: # ------------------------------- displays one line in appropriate table format
  624: sub display_line {
  625:     my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_;
  626:     my (@pathfn, $fndir);
  627:     my $dirptr=16384;
  628:     my $fileclr="#ffffe6";
  629:     my $iconpath= $r->dir_config('lonIconsURL') . '/';
  630: 
  631:     my @filecom = split (/\&/,$line);
  632:     my @pathcom = split (/\//,$filecom[0]);
  633:     my $listname = $pathcom[scalar(@pathcom)-1];
  634:     my $fnptr = $filecom[3]&$dirptr;
  635:     my $msg = 'View '.$filecom[0].' resources';
  636:     $msg = 'Close '.$filecom[0].' directory' if $diropen eq 'opened';
  637: 
  638:     my $tabtag='</td>';
  639:     my $i=0;
  640: 
  641:     while ($i<=6) {
  642: 	$tabtag=join('',$tabtag,"<td>&nbsp;</td>")
  643: 	    if $hash{'display_attrs_'.$i} == 1;
  644: 	$i++;
  645:     }
  646: 
  647: # display uplink arrow
  648:     if ($filecom[1] eq 'viewOneUp') {
  649: 	$r->print("<tr bgcolor=$fileclr>$extrafield");
  650: 	$r->print("<td valign=bottom>\n");
  651: 	$r->print ('<form method="post" name="dirpathUP" action="'.$startdir.
  652: 		   '/" '.
  653: 		   'onSubmit="return rep_dirpath(\'UP\','.
  654: 		   'document.forms.fileattr.acts.value)" '.
  655: 		   'enctype="application/x-www-form-urlencoded"'.
  656:                    '>'."\n");
  657: 	$r->print ('<input type=hidden name=openuri value="'.
  658: 		   $startdir.'">'."\n");
  659: 	$r->print ('<input type="hidden" name="acts" value="">'."\n");
  660: 	$r->print ('<input src="'.$iconpath.'arrow_up.gif"');
  661: 	$r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
  662: 		   "\n");
  663: 	$r->print("Up $tabtag</tr></form>\n");
  664: 	return OK;
  665:     }
  666: 
  667: # display domain
  668:     if ($filecom[1] eq 'domain') {
  669: 	$r->print ('<input type="hidden" name="dirPointer" value="on">'."\n")
  670: 	    if ($ENV{'form.dirPointer'} eq "on");
  671: 	$r->print("<tr bgcolor=$fileclr>$extrafield");
  672: 	$r->print("<td valign=bottom>");
  673: 	&begin_form ($r,$filecom[0].'/');
  674: 	my $anchor = $filecom[0].'/';
  675: 	$anchor =~ s/\///g;
  676: 	$r->print ('<a name="'.$anchor.'">');
  677: 	$r->print ('<input type="hidden" name="acts" value="">');
  678: 	$r->print ('<input src="'.$iconpath.'folder_pointer_'.
  679: 		   $diropen.'.gif"'); 
  680: 	$r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
  681: 		   "\n");
  682: 	$r->print ('<a href="javascript:gothere(\''.$filecom[0].
  683: 		   '/\')"><img src="'.$iconpath.'server.gif"');
  684: 	$r->print (' border="0" /></a>'."\n");
  685: 	$r->print("Domain - $listname (".
  686:       $Apache::lonnet::domaindescription{$listname}.") $tabtag</tr></form>\n");
  687: 	return OK;
  688: 
  689: # display user directory
  690:     }
  691:     if ($filecom[1] eq 'user') {
  692: 	$r->print("<tr bgcolor=$fileclr>$extrafield");
  693: 	$r->print("<td valign=bottom nowrap>\n");
  694: 	my $curdir = $startdir.$filecom[0].'/';
  695: 	my $anchor = $curdir;
  696: 	$anchor =~ s/\///g;
  697: 	&begin_form ($r,$curdir);
  698: 	$r->print ('<a name="'.$anchor.'"><img src="'.$iconpath.
  699: 		   'whitespace1.gif" border="0" />'."\n");
  700: 	$r->print ('<input type="hidden" name="acts" value="">');
  701: 	$r->print ('<input src="'.$iconpath.'folder_pointer_'.$diropen.
  702: 		   '.gif"'); 
  703: 	$r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
  704: 		   "\n");
  705: 	$r->print ('<a href="javascript:gothere(\''.$curdir.'\')"><img src='.
  706: 		   $iconpath.'quill.gif border="0" name="'.$msg.
  707: 		   '" height="22" /></a>');
  708: 	$r->print ($listname.$tabtag.'</tr></form>'."\n");
  709: 	return OK;
  710:     }
  711: 
  712: # display file
  713:     if ($fnptr == 0 and $filecom[3] ne '') {
  714: 	my $filelink = $startdir.$filecom[0];
  715: 	return OK if (!&Apache::lonnet::allowed('bre',$filelink));
  716: 	my @file_ext = split (/\./,$listname);
  717: 	my $curfext = $file_ext[-1];
  718:         if (@Omit) {
  719:             foreach (@Omit) { return OK if ($curfext eq $_); }
  720:         }
  721:         if (@Only) {
  722:             my $skip = 1;
  723:             foreach (@Only) { $skip = 0 if ($curfext eq $_); }
  724:             return OK if ($skip > 0);
  725:         }
  726: 	# Set the icon for the file
  727: 	my $iconname = "unknown.gif";
  728: 	my $embstyle = &Apache::loncommon::fileembstyle($curfext);
  729: 	# The unless conditional that follows is a bit of overkill
  730: 	$iconname = $curfext.".gif" unless
  731: 	    (!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn');
  732: 	#
  733: 	$r->print("<tr bgcolor=$fileclr><td nowrap valign='bottom'>");
  734: 	my $metafile = grep /^$filecom[0]\.meta\&/, @list;
  735: 	my $title;
  736:         if ($ENV{'form.catalogmode'} eq 'interactive') {
  737: 	    $title=$listname;
  738: 	    $title = &Apache::lonnet::metadata($filelink,'title')
  739: 		if ($metafile == 1);
  740: 	    $title=$listname unless $title;
  741: 	    my $titleesc=HTML::Entities::encode($title);
  742: 	    $titleesc=~s/\'/\\'/; #' (clean up this spare quote)
  743:             $r->print("<a href=\"javascript:select_data(\'",
  744:                       $titleesc,"','",$filelink,"')\">");
  745: 	    $r->print("<img src='",$iconpath,"select.gif' border='0' /></a>".
  746: 		      "\n");
  747: 	    $r->print("</td><td valign='bottom' nowrap>");
  748: 	}
  749:         elsif ($ENV{'form.catalogmode'} eq 'groupimport') {
  750: 	    $title=$listname;
  751: 	    $title = &Apache::lonnet::metadata($filelink,'title')
  752: 		if ($metafile == 1);
  753: 	    $title=$listname unless $title;
  754: 	    my $titleesc=&HTML::Entities::encode($title);
  755: 	    $r->print("<form name='form$fnum'>\n");
  756: 	    $r->print("<input type='checkbox' name='filelink"."' ".
  757: 		      "value='$filelink' onClick='".
  758: 		      "javascript:queue(\"form$fnum\")' ");
  759: 	    if ($hash{'store_'.$filelink}) {
  760: 		$r->print("checked");
  761: 	    }
  762: 	    $r->print(">\n");
  763: 	    $r->print("<input type='hidden' name='title"."' ".
  764: 		      "value='$titleesc'>\n");
  765: 	    $r->print("</form>\n");
  766: 	    $r->print("</td><td valign='bottom' nowrap>");
  767: 	    $hash{"pre_${fnum}_link"}=$filelink;
  768: 	    $hash{"pre_${fnum}_title"}=$titleesc;
  769:   	    $fnum++;
  770: 	}
  771: 
  772: 	if ($indent > 0 and $indent < 11) {
  773: 	    $r->print("<img src=",$iconpath,"whitespace",$indent,
  774: 		      ".gif border='0' />\n");
  775: 	} elsif ($indent >0) {
  776: 	    my $ten = int($indent/10.);
  777: 	    my $rem = $indent%10.0;
  778: 	    my $count = 0;
  779: 	    while ($count < $ten) {
  780: 		$r->print("<img src=",$iconpath,
  781: 			  "whitespace10.gif border='0' />\n");
  782: 	    $count++;
  783: 	    }
  784: 	    $r->print("<img src=",$iconpath,"whitespace",$rem,
  785: 		      ".gif border='0' />\n") if $rem > 0;
  786: 	}
  787: 
  788: 	$r->print("<img src=$iconpath$iconname border='0' />\n");
  789: 	$r->print (" <a href=\"javascript:openWindow('".$filelink.
  790: 		   "', 'metadatafile', '450', '500', 'no', 'yes')\";".
  791: 		   " TARGET=_self>$listname</a> ");
  792: 
  793: 	$r->print (" (<a href=\"javascript:openWindow('".$filelink.
  794: 		   ".meta', 'metadatafile', '400', '450', 'no', 'yes')\"; ".
  795: 		   "TARGET=_self>metadata</a>) ") if ($metafile == 1);
  796: 
  797: 	$r->print("</td>\n");
  798: 	if ($hash{'display_attrs_0'} == 1) {
  799: 	    my $title = &Apache::lonnet::metadata($filelink,'title')
  800: 		if ($metafile == 1);
  801: 	    $r->print('<td valign=bottom> '.($title eq '' ? '&nbsp;' : $title).
  802: 		      ' </td>'."\n");
  803: 	}
  804: 	$r->print('<td align=right valign=bottom> ',
  805: 		  $filecom[8]," </td>\n") 
  806: 	    if $hash{'display_attrs_1'} == 1;
  807: 	$r->print('<td valign=bottom> '.
  808: 		  (localtime($filecom[9]))." </td>\n") 
  809: 	    if $hash{'display_attrs_2'} == 1;
  810: 	$r->print('<td valign=bottom> '.
  811: 		  (localtime($filecom[10]))." </td>\n") 
  812: 	    if $hash{'display_attrs_3'} == 1;
  813: 
  814: 	if ($hash{'display_attrs_4'} == 1) {
  815: 	    my $author = &Apache::lonnet::metadata($filelink,'author')
  816: 		if ($metafile == 1);
  817: 	    $r->print('<td valign=bottom> '.($author eq '' ? '&nbsp;' : $author).
  818: 		      " </td>\n");
  819: 	}
  820: 	if ($hash{'display_attrs_5'} == 1) {
  821: 	    my $keywords = &Apache::lonnet::metadata($filelink,'keywords')
  822: 		if ($metafile == 1);
  823: 	    # $keywords = '&nbsp;' if (!$keywords);
  824: 	    $r->print('<td valign=bottom> '.($keywords eq '' ? '&nbsp;' : $keywords).
  825: 		      " </td>\n");
  826: 	}
  827: 	if ($hash{'display_attrs_6'} == 1) {
  828: 	    my $lang = &Apache::lonnet::metadata($filelink,'language')
  829: 		if ($metafile == 1);
  830: 	    $lang = &Apache::loncommon::languagedescription($lang);
  831: 	    $r->print('<td valign=bottom> '.($lang eq '' ? '&nbsp;' : $lang).
  832: 		      " </td>\n");
  833: 	}
  834:         if ($hash{'display_attrs_8'} == 1) {
  835:             my $output='';
  836:             my $embstyle=&Apache::loncommon::fileembstyle($curfext);
  837: 	    if ($embstyle eq 'ssi') {
  838: 	       $output=&Apache::lonnet::ssi($filelink);
  839:                $output=~s/^.*\<body[^\>]*\>//si;
  840:                $output=~s/\<\/body\s*\>.*$//si;
  841:                $output='<font size="-2">'.$output.'</font>';
  842: 	   } elsif ($embstyle eq 'img') {
  843:                $output='<img src="'.$filelink.'" />';
  844:            } elsif ($filelink=~/^\/res\/(\w+)\/(\w+)\//) {
  845:                $output='<img src="http://'.
  846: 		 $Apache::lonnet::hostname{&Apache::lonnet::homeserver($2,$1)}.
  847:                  '/cgi-bin/thumbnail.gif?url='.$filelink.'" />';
  848:            }
  849: 	   $r->print('<td valign=bottom> '.($output eq '' ? '&nbsp;':$output).
  850: 		      " </td>\n");
  851:         }
  852: 	$r->print("</tr>\n");
  853:     }
  854: 
  855: # -- display directory
  856:     if ($fnptr == $dirptr) {
  857: 	my @file_ext = split (/\./,$listname);
  858: 	my $curfext = $file_ext[scalar(@file_ext)-1];
  859: 	my $curdir = $startdir.$filecom[0].'/';
  860: 	my $anchor = $curdir;
  861: 	$anchor =~ s/\///g;
  862: 	$r->print("<tr bgcolor=$fileclr>$extrafield<td valign=bottom>");
  863: 	&begin_form ($r,$curdir);
  864: 	my $indentm1 = $indent-1;
  865: 	if ($indentm1 < 11 and $indentm1 > 0) {
  866: 	    $r->print("<img src=",$iconpath,"whitespace",$indentm1,
  867: 		      ".gif border='0' />\n");
  868: 	} else {
  869: 	    my $ten = int($indentm1/10.);
  870: 	    my $rem = $indentm1%10.0;
  871: 	    my $count = 0;
  872: 	    while ($count < $ten) {
  873: 		$r->print ("<img src=",$iconpath
  874: 			   ,"whitespace10.gif border='0' />\n");
  875: 		$count++;
  876: 	    }
  877: 	    $r->print ("<img src=",$iconpath,"whitespace",$rem,
  878: 		       ".gif border='0' />\n") if $rem > 0;
  879: 	}
  880: 	$r->print ('<input type="hidden" name="acts" value="">');
  881: 	$r->print ('<a name="'.$anchor.'"><input src="'.$iconpath.
  882: 		   'folder_pointer_'.$diropen.'.gif"');
  883: 	$r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
  884: 		   "\n");
  885: 	$r->print ('<a href="javascript:gothere(\''.$curdir.'\')"><img src="'.
  886: 		   $iconpath.'folder_'.$diropen.'.gif" border="0" /></a>'.
  887: 		   "\n");
  888: 	$r->print ("$listname$tabtag</tr></form>\n");
  889:     }
  890: 
  891: }
  892: 
  893: # ------------------- prints the beginning of a form for directory or file link
  894: sub begin_form {
  895:     my ($r,$uri) = @_;
  896:     my $anchor = $uri;
  897:     $anchor =~ s/\///g;
  898:     $r->print ('<form method="post" name="dirpath'.$dnum.'" action="'.$uri.
  899: 	       '#'.$anchor.
  900: 	       '" onSubmit="return rep_dirpath(\''.$dnum.'\''.
  901: 	       ',document.forms.fileattr.acts.value)" '.
  902: 	       'enctype="application/x-www-form-urlencoded">'."\n");
  903:     $r->print ('<input type="hidden" name="openuri" value="'.$uri.'">'.
  904: 	       "\n");
  905:     $r->print ('<input type="hidden" name="dirPointer" value="on">'."\n");
  906:     $dnum++;
  907: }
  908: 
  909: # --------- settings whenever the user causes the indexer window to be launched
  910: sub start_fresh_session {
  911:     delete $hash{'form.catalogmode'};
  912:     delete $hash{'form.mode'};
  913:     delete $hash{'form.form'};
  914:     delete $hash{'form.element'};
  915:     delete $hash{'form.omit'};
  916:     delete $hash{'form.only'};
  917:     foreach (keys %hash) {
  918:         delete $hash{$_} if (/^(pre_|store)/);
  919:     }
  920: }
  921: 
  922: # ------------------------------------------------------------------- setvalues
  923: sub setvalues {
  924:     # setvalues is used in registerurl to synchronize the database
  925:     # hash and environment hashes
  926:     my ($H1,$h1key,$H2,$h2key) =@_;
  927:     #
  928:     if (exists $H2->{$h2key}) {
  929: 	$H1->{$h1key} = $H2->{$h2key};
  930:     } elsif (exists $H1->{$h1key}) {
  931: 	$H2->{$h2key} = $H1->{$h1key};
  932:     } 
  933: }
  934: 
  935: 1;
  936: 
  937: sub cleanup {
  938:     if (tied(%hash)){
  939: 	&Apache::lonnet::logthis('Cleanup indexer: hash');
  940:         unless (untie(%hash)) {
  941: 	    &Apache::lonnet::logthis('Failed cleanup indexer: hash');
  942:         }
  943:     }
  944: }
  945: 
  946: =head1 NAME
  947: 
  948: Apache::lonindexer - mod_perl module for cross server filesystem browsing
  949: 
  950: =head1 SYNOPSIS
  951: 
  952: Invoked by /etc/httpd/conf/srm.conf:
  953: 
  954:  <LocationMatch "^/res.*/$">
  955:  SetHandler perl-script
  956:  PerlHandler Apache::lonindexer
  957:  </LocationMatch>
  958: 
  959: =head1 INTRODUCTION
  960: 
  961: This module enables a scheme of browsing across a cross server.
  962: 
  963: This is part of the LearningOnline Network with CAPA project
  964: described at http://www.lon-capa.org.
  965: 
  966: =head1 BEGIN SUBROUTINE
  967: 
  968: This routine is only run once after compilation.
  969: 
  970: =over 4
  971: 
  972: =item *
  973: 
  974: Initializes %language hash table.
  975: 
  976: =back
  977: 
  978: =head1 HANDLER SUBROUTINE
  979: 
  980: This routine is called by Apache and mod_perl.
  981: 
  982: =over 4
  983: 
  984: =item *
  985: 
  986: read in machine configuration variables
  987: 
  988: =item *
  989: 
  990: see if called from an interactive mode
  991: 
  992: =item *
  993: 
  994: refresh environment with user database values (in %hash)
  995: 
  996: =item *
  997: 
  998: define extra fields and buttons in case of special mode
  999: 
 1000: =item *
 1001: 
 1002: set catalogmodefunctions to have extra needed javascript functionality
 1003: 
 1004: =item *
 1005: 
 1006: print header
 1007: 
 1008: =item *
 1009: 
 1010: evaluate actions from previous page (both cumulatively and chronologically)
 1011: 
 1012: =item *
 1013: 
 1014: output title
 1015: 
 1016: =item *
 1017: 
 1018: get state of file attributes to be showing
 1019: 
 1020: =item *
 1021: 
 1022: output state of file attributes to be showing
 1023: 
 1024: =item *
 1025: 
 1026: output starting row to the indexed file/directory hierarchy
 1027: 
 1028: =item *
 1029: 
 1030: read in what directories have previously been set to "open"
 1031: 
 1032: =item *
 1033: 
 1034: if not at top level, provide an uplink arrow
 1035: 
 1036: =item *
 1037: 
 1038: recursively go through all the directories and output as appropriate
 1039: 
 1040: =item *
 1041: 
 1042: information useful for group import
 1043: 
 1044: =item *
 1045: 
 1046: end the tables
 1047: 
 1048: =item *
 1049: 
 1050: end the output and return
 1051: 
 1052: =back
 1053: 
 1054: =head1 OTHER SUBROUTINES
 1055: 
 1056: =over 4
 1057: 
 1058: =item *
 1059: 
 1060: scanDir - recursive scan of a directory
 1061: 
 1062: =item *
 1063: 
 1064: get_list - get complete matched list based on the uri (returns an array)
 1065: 
 1066: =item *
 1067: 
 1068: match_ext - filters out files based on extensions (returns an array)
 1069: 
 1070: =item *
 1071: 
 1072: display_line - displays one line in appropriate table format
 1073: 
 1074: =item *
 1075: 
 1076: begin_form - prints the beginning of a form for directory or file link
 1077: 
 1078: =item *
 1079: 
 1080: start_fresh_session - settings whenever the user causes the indexer window
 1081: to be launched
 1082: 
 1083: =back
 1084: 
 1085: =cut

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>