File:  [LON-CAPA] / loncom / interface / lonindexer.pm
Revision 1.48: download - view: text, annotated - select for diffs
Thu Aug 8 13:07:17 2002 UTC (21 years, 10 months ago) by matthew
Branches: MAIN
CVS tags: HEAD
Minor cleanups and name changes.

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

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