--- loncom/interface/lonindexer.pm	2001/08/13 14:50:35	1.17
+++ loncom/interface/lonindexer.pm	2002/03/19 19:55:52	1.39
@@ -1,7 +1,30 @@
 # The LearningOnline Network with CAPA
-#
 # Directory Indexer
 #
+# $Id: lonindexer.pm,v 1.39 2002/03/19 19:55:52 matthew Exp $
+#
+# Copyright Michigan State University Board of Trustees
+#
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
+#
+# LON-CAPA is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LON-CAPA is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with LON-CAPA; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# /home/httpd/html/adm/gpl.txt
+#
+# http://www.lon-capa.org/
+#
 # YEAR=1999
 # 5/21/99, 5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer)
 # 11/23 Gerd Kortemeyer
@@ -14,15 +37,39 @@
 # 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
+#
+###
+
+###############################################################################
+##                                                                           ##
+## ORGANIZATION OF THIS PERL MODULE                                          ##
+##                                                                           ##
+## 1. Description of functions                                               ##
+## 2. Modules used by this module                                            ##
+## 3. Choices for different output views (detailed, summary, xml, etc)       ##
+## 4. BEGIN block (to be run once after compilation)                         ##
+## 5. Handling routine called via Apache and mod_perl                        ##
+## 6. Other subroutines                                                      ##
+##                                                                           ##
+###############################################################################
 
 package Apache::lonindexer;
 
+# ------------------------------------------------- modules used by this module
 use strict;
 use Apache::lonnet();
+use Apache::loncommon();
 use Apache::Constants qw(:common);
 use Apache::File;
 use GDBM_File;
 
+# ---------------------------------------- variables used throughout the module
 my %hash; # tied to a user-specific gdbm file
 my %dirs; # keys are directories, values are the open/close status
 my %language; # has the reference information present in language.tab
@@ -33,17 +80,7 @@ my $extrafield; # default extra table ce
 my $fnum; # file counter
 my $dnum; # directory counter
 
-# ---------------------------------------------------------------------- BEGIN
-sub BEGIN {
-    my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
-			     '/language.tab');
-    map {
-	$_=~/(\w+)\s+([\w\s\-]+)/;
-	$language{$1}=$2;
-    } <$fh>;
-}
-
-# ---------------------------------------------------------------- Main Handler
+# ----------------------------- Handling routine called via Apache and mod_perl
 sub handler {
     my $r = shift;
     $r->content_type('text/html');
@@ -51,8 +88,9 @@ sub handler {
     return OK if $r->header_only;
     $fnum=0;
     $dnum=0;
+    untie %hash;
 
-# --------------------------------------------- machine configuration variables
+# ------------------------------------- read in machine configuration variables
     my $iconpath= $r->dir_config('lonIconsURL') . "/";
     my $domain  = $r->dir_config('lonDefDomain');
     my $role    = $r->dir_config('lonRole');
@@ -68,8 +106,10 @@ sub handler {
     my $uri=$r->uri;
 
 # -------------------------------------- see if called from an interactive mode
-    &get_unprocessed_cgi();
-
+    # Get the parameters from the query string
+    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+	     ['catalogmode','launch','acts','mode','form','element']);
+    #-------------------------------------------------------------------
     my $closebutton='';
     my $groupimportbutton='';
     my $colspan=''; 
@@ -116,35 +156,114 @@ END
 onClick="javascript:select_group()">
 END
         }
-
+	# Additions made by Matthew to make the browser a little easier to deal
+	# with in the future.
+	#
+	# $mode (at this time) indicates if we are in edit mode.
+	# $form is the name of the form that the URL is placed when the
+	#       selection is made.
+	# $element is the name of the element in $formname which receives
+	#       the URL.
+	# &Apache::lonxml::debug('Checking mode, form, element');
+	&setvalues(\%hash,'form_mode'   ,\%ENV,'form.mode'   );
+	&setvalues(\%hash,'form_form'   ,\%ENV,'form.form'   );
+	&setvalues(\%hash,'form_element',\%ENV,'form.element');
+
+	my $mode = $ENV{'form.mode'};
+	my ($form,$element);
+	if ($mode eq 'edit' || $mode eq 'parmset') {
+	    $form    = $ENV{'form.form'};
+	    $element = $ENV{'form.element'};
+	}
+	&Apache::lonxml::debug("mode=$mode form=$form element=$element");
 # ------ set catalogmodefunctions to have extra needed javascript functionality
 	my $catalogmodefunctions='';
 	if ($ENV{'form.catalogmode'} eq 'interactive' or
 	    $ENV{'form.catalogmode'} eq 'groupimport') {
-	    $catalogmodefunctions=<<END;
+	    # The if statement below sets us up to use the old version
+	    # by default (ie. if $mode is undefined).  This is the easy
+	    # way out.  Hopefully in the future I'll find a way to get 
+	    # the calls dealt with in a more comprehensive manner.
+	    if (!defined($mode) || ($mode ne 'edit' && $mode ne 'parmset')) {
+		$catalogmodefunctions=<<"END";
 function select_data(title,url) {
     changeTitle(title);
     changeURL(url);
     self.close();
 }
 function select_group() {
-    window.location="/adm/groupsort?acts="+document.forms.fileattr.acts.value;
+    window.location="/adm/groupsort?catalogmode=groupimport&acts="+document.forms.fileattr.acts.value;
 }
 function changeTitle(val) {
-    if (opener.inf.document.forms.resinfo.elements.t) {
-        opener.inf.document.forms.resinfo.elements.t.value=val;
+    if (opener.inf) {
+        if (opener.inf.document.forms.resinfo.elements.t) {
+            opener.inf.document.forms.resinfo.elements.t.value=val;
+        }
+    }
+}
+function changeURL(val) {
+    if (opener.inf) {
+        if (opener.inf.document.forms.resinfo.elements.u) {
+	    opener.inf.document.forms.resinfo.elements.u.value=val;
+        }
     }
 }
+END
+            } elsif ($mode eq 'edit') { # we are in 'edit' mode
+		$catalogmodefunctions=<<END;
+// mode = $mode
+function select_data(title,url) {
+    changeURL(url);
+    self.close();
+}
+
+function select_group() {
+    window.location="/adm/groupsort?catalogmode=interactive&form=$form&element=$element&mode=edit&acts="+document.forms.fileattr.acts.value;
+}
+
 function changeURL(val) {
-    if (opener.inf.document.forms.resinfo.elements.u) {
-	opener.inf.document.forms.resinfo.elements.u.value=val;
+    if (window.opener.document) {
+	window.opener.document.forms["$form"].elements["$element"].value=val;
+    } else {
+	    alert("The file you selected is: "+val);
     }
 }
+
 END
+            } elsif ($mode eq 'parmset') {
+		$catalogmodefunctions=<<END;
+// mode = $mode
+function select_data(title,url) {
+    changeURL(url);
+    self.close();
+}
+
+function select_group() {
+    window.location="/adm/groupsort?catalogmode=interactive&form=$form&element=$element&mode=parmset&acts="+document.forms.fileattr.acts.value;
+}
+
+function changeURL(val) {
+    if (window.opener.document) {
+        var elementname  = "$element"+"_value";
+        var checkboxname = "$element"+"_setparmval";
+	window.opener.document.forms["$form"].elements[elementname].value=val;
+        window.opener.document.forms["$form"].elements[checkboxname].checked=true;
+    } else {
+	    alert("The file you selected is: "+val);
+    }
+}
+
+END
+            }
         }
-	if ($ENV{'form.catalogmode'} eq 'groupimport') {
-	    $catalogmodefunctions.=<<END;
+        $catalogmodefunctions.=<<END;
 var acts='';
+function rep_dirpath(suffix,val) {
+    eval("document.forms.dirpath"+suffix+".acts.value=val");
+}
+END
+	if ($ENV{'form.catalogmode'} eq 'groupimport') {
+            $catalogmodefunctions.=<<END;
 function queue(val) {
     if (eval("document.forms."+val+".filelink.checked")) {
 	var l=val.length;
@@ -157,9 +276,6 @@ function queue(val) {
 	document.forms.fileattr.acts.value+='0a'+v+'b';
     }
 }
-function rep_dirpath(suffix,val) {
-    eval("document.forms.dirpath"+suffix+".acts.value=val");
-}
 END
 	}
 
@@ -169,7 +285,7 @@ END
 <head>
 <title>The LearningOnline Network With CAPA Directory Browser</title>
 
-<script language="javascript">
+<script type="text/javascript">
 $catalogmodefunctions
 function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
     var options = "width=" + w + ",height=" + h + ",";
@@ -195,14 +311,14 @@ ENDHEADER
 	    my %achash;
 	    my $ac=0;
 	    # some initial hashes for working with data
-	    map {
+	    foreach (@Acts) {
 		my ($state,$ref)=split(/a/);
 		$ahash{$ref}=$state;
 		$achash{$ref}=$ac;
 		$ac++;
-	    } (@Acts);
+	    }
 	    # sorting through the actions and changing the tied database hash
-	    map {
+	    foreach (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) {
 		my $key=$_;
 		if ($ahash{$key} eq '1') {
 		    $hash{'store_'.$hash{'pre_'.$key.'_link'}}=
@@ -216,9 +332,9 @@ ENDHEADER
 			delete $hash{'store_'.$hash{'pre_'.$key.'_link'}};
 		    }
 		}
-	    } sort {$achash{$a}<=>$achash{$b}} (keys %ahash);
+	    }
 	    # deleting the previously cached listing
-	    map {
+	    foreach (keys %hash) {
 		if ($_ =~ /^pre_/ && $_ =~/link$/) {
 		    my $key = $_;
 		    $key =~ s/^pre_//;
@@ -226,15 +342,15 @@ ENDHEADER
 		    delete $hash{'pre_'.$key.'_title'};
 		    delete $hash{'pre_'.$key.'_link'};
 		}
-	    } keys %hash;
+	    }
 	}
 	
-# output title
+# ---------------------------------------------------------------- output title
 	$r->print('<h2><font color="#888888">The LearningOnline With CAPA '.
 		  'Network Directory Browser</font></h2>'."\n");
-# get state of file attributes to be showing
+# ---------------------------------- get state of file attributes to be showing
 	if ($ENV{'form.attrs'} ne "") {
-	    for (my $i=0; $i<=5; $i++) {
+	    for (my $i=0; $i<=6; $i++) {
 		delete $hash{'display_attrs_'.$i};
 		if ($ENV{'form.attr'.$i} == 1) {
 		    $attrchk[$i] = "checked";
@@ -242,25 +358,25 @@ ENDHEADER
 		}
 	    }
 	} else {
-	    for (my $i=0; $i<=5; $i++) {
+	    for (my $i=0; $i<=6; $i++) {
 		$attrchk[$i] = "checked" if $hash{'display_attrs_'.$i} == 1;
 	    }
 	}
-# output state of file attributes to be showing
+# ------------------------------- output state of file attributes to be showing
 	$r->print(<<END);
 <b><font color="#666666">Display file attributes</font></b><br />
 <form method="post" name="fileattr" action="$uri"
  enctype="application/x-www-form-urlencoded">
 <table border=0><tr>
 <td><input type="checkbox" name="attr0" value="1" $attrchk[0] /> Size</td>
-<td><input type="checkbox" name="attr1" value="1" $attrchk[1] /> Last
- access</td>
-<td><input type="checkbox" name="attr2" value="1" $attrchk[2] /> Last
- modified</td>
+<td><input type="checkbox" name="attr1" value="1" $attrchk[1] /> Last access</td>
+<td><input type="checkbox" name="attr2" value="1" $attrchk[2] /> Last modified</td>
+<td><input type="checkbox" name="attr6" value="1" $attrchk[6] /> All versions</td>
 </tr><tr>
 <td><input type="checkbox" name="attr3" value="1" $attrchk[3] /> Author</td>
 <td><input type="checkbox" name="attr4" value="1" $attrchk[4] /> Keywords</td>
 <td><input type="checkbox" name="attr5" value="1" $attrchk[5] /> Language</td>
+<td>&nbsp;</td>
 </tr></table>
 <input type="hidden" name="dirPointer" value="on" />
 <input type="hidden" name="acts" value="" />
@@ -271,7 +387,7 @@ $groupimportbutton
 </form>
 END
 
-    # output starting row to the indexed file/directory hierarchy
+# ----------------- output starting row to the indexed file/directory hierarchy
         my $titleclr="#ddffff";
         $r->print("<table border=0><tr><td bgcolor=#eeeeee>\n");
 	$r->print("<table border=0><tr>\n");
@@ -290,14 +406,14 @@ END
 	    if ($hash{'display_attrs_5'} == 1);
 	$r->print("</tr>");
 
-	# read in what directories have previously been set to "open"
-	map {
+# ----------------- read in what directories have previously been set to "open"
+	foreach (keys %hash) {
 	    if ($_ =~ /^diropen_status_/) {
 		my $key = $_;
 		$key =~ s/^diropen_status_//;
 		$dirs{$key} = $hash{$_};
 	    }
-	} keys %hash;
+	}
 
 	if ($ENV{'form.openuri'}) {  # take care of review and refresh options
 	    my $uri=$ENV{'form.openuri'};
@@ -328,7 +444,7 @@ END
 	    $toplevel = $hash{'top.level'};
 	}
 
-	# if not at top level, provide an uplink arrow
+# -------------------------------- if not at top level, provide an uplink arrow
 	if ($toplevel ne "/res/"){
 	    my (@uri_com) = split(/\//,$uri);
 	    pop @uri_com;
@@ -338,18 +454,18 @@ END
 	    $indent = 1;
 	}
 
-	# recursively go through all the directories and output as appropriate
+# -------- recursively go through all the directories and output as appropriate
 	&scanDir ($r,$toplevel,$indent,\%hash);
 	
-	# information useful for group import
+# ---------------------------- embed hidden information useful for group import
 	$r->print("<form name='fnum'>");
 	$r->print("<input type='hidden' name='fnum' value='$fnum'></form>");
 
-	# end the tables
+# -------------------------------------------------------------- end the tables
 	$r->print("</table>");
 	$r->print("</td></tr></table>");
 
-	# end the output and return
+# --------------------------------------------------- end the output and return
 	$r->print("</body></html>\n");
 	untie(%hash);
     } else {
@@ -360,7 +476,6 @@ END
     return OK;
 }
 
-
 # ----------------------------------------------- recursive scan of a directory
 sub scanDir {
     my ($r,$startdir,$indent,$hashref)=@_;
@@ -373,6 +488,16 @@ sub scanDir {
     foreach my $line (@list) {
 	my ($strip,$dom,$foo,$testdir,$foo)=split(/\&/,$line,5); 
 	next if $strip =~ /.*\.meta$/;
+	my (@fileparts) = split(/\./,$strip);
+	if ($hash{'display_attrs_6'} != 1) {
+	    if (scalar(@fileparts) >= 3) {
+		my $fext = pop @fileparts;
+		my $ov = pop @fileparts;
+		my $fname = join ('.',@fileparts,$fext);
+		next if (grep /$fname/,@list and $ov =~ /\d+/);
+	    }
+	}
+
 	if ($dom eq "domain") {
 	    $compuri = join('',$strip,"/");  # dom list has /res/<domain name>
 	    $curdir = $compuri;
@@ -404,9 +529,9 @@ sub get_list {
     $luri =~ s/\//_/g;
 
     if ($ENV{'form.attrs'} eq "Refresh") {
-	map {
+	foreach (keys %hash) {
 	    delete $hash{$_} if ($_ =~ /^dirlist_files_/);
-	    } keys %hash;
+	    }
     }
 
     if ($hash{'dirlist_files'.$luri}) {
@@ -426,16 +551,6 @@ sub match_ext {
     my @fileext;
     my $dirptr=16384;
 
-    my $tabdir  = $r->dir_config('lonTabDir');
-    my $fn = $tabdir.'/filetypes.tab';
-    if (-e $fn) {
-	my $FH=Apache::File->new($fn);
-	my @content=<$FH>;
-	foreach my $line (@content) {
-	    (my $ext,my $foo) = split /\s+/,$line;
-	    push @fileext,$ext;
-	}
-    }
     foreach my $line (@packlist) {
 	chomp $line;
 	$line =~ s/^\/home\/httpd\/html//;
@@ -446,9 +561,9 @@ sub match_ext {
 	my $fext = pop(@filecom);
 	my $fnptr = $unpackline[3]&$dirptr;
  	if ($fnptr == 0 and $unpackline[3] ne "") {
-	    foreach my $nextline (@fileext) {
-		push @trimlist,$line if $nextline eq $fext;
-	    }
+	    my $embstyle = &Apache::loncommon::fileembstyle($fext);
+            push @trimlist,$line if (defined($embstyle) && 
+				     ($embstyle ne 'hdn' or $fext eq 'meta'));
 	} else {
 	    push @trimlist,$line;
 	}
@@ -458,7 +573,7 @@ sub match_ext {
 }
 
 # ------------------------------- displays one line in appropriate table format
-sub display_line{
+sub display_line {
     my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_;
     my (@pathfn, $fndir, $fnptr);
     my $dirptr=16384;
@@ -548,7 +663,14 @@ sub display_line{
 # display file
     if ($fnptr == 0 and $filecom[3] ne "") {
 	my @file_ext = split (/\./,$listname);
-	my $curfext = $file_ext[scalar(@file_ext)-1];
+	my $curfext = $file_ext[-1];
+	# 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');
+	#
 	my $filelink = $startdir.$filecom[0];
 	$r->print("<tr><td nowrap valign='bottom' bgcolor=$fileclr>");
 	my $metafile = grep /^$filecom[0]\.meta\&/, @list;
@@ -558,8 +680,10 @@ sub display_line{
 	    $title = &Apache::lonnet::metadata($filelink,'title')
 		if ($metafile == 1);
 	    $title=$listname unless $title;
-	    $r->print("<a href='javascript:select_data(\"",
-	              $title,'","',$filelink,"\")'>");
+	    my $titleesc=$title;
+	    $titleesc=~s/\'/\\'/; #' (clean up this spare quote
+            $r->print("<a href=\"javascript:select_data(\'",
+                      $titleesc,"','",$filelink,"')\">");
 	    $r->print("<img src='",$iconpath,"select.gif' border='0' /></a>".
 		      "\n");
 	    $r->print("</td><td valign='bottom' nowrap bgcolor=$fileclr>");
@@ -602,7 +726,7 @@ sub display_line{
 		      ".gif border='0' />\n") if $rem > 0;
 	}
 
-	$r->print("<img src=$iconpath$curfext.gif border='0' />\n");
+	$r->print("<img src=$iconpath$iconname border='0' />\n");
 	$r->print (" <a href=\"javascript:openWindow('".$filelink.
 		   "', 'metadatafile', '450', '500', 'no', 'yes')\";".
 		   " TARGET=_self>$listname</a> ");
@@ -639,7 +763,7 @@ sub display_line{
 	if ($hash{'display_attrs_5'} == 1) {
 	    my $lang = &Apache::lonnet::metadata($filelink,'language')
 		if ($metafile == 1);
-	    $lang = $language{$lang};
+	    $lang = &Apache::loncommon::languagedescription($lang);
 	    $lang = '&nbsp;' if (!$lang);
 	    $r->print("<td bgcolor=$fileclr valign=bottom> ".$lang.
 		      " </td>\n");
@@ -701,30 +825,174 @@ sub begin_form {
     $dnum++;
 }
 
-# ----------- grab unprocessed CGI variables that may have been appended to URL
-sub get_unprocessed_cgi {
-    map {
-       my ($name, $value) = split(/=/,$_);
-       $value =~ tr/+/ /;
-       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
-       if ($name eq 'catalogmode' or $name eq 'launch' or $name eq 'acts') {
-           $ENV{'form.'.$name}=$value;
-       }
-    } (split(/&/,$ENV{'QUERY_STRING'}));
-}
-
 # --------- settings whenever the user causes the indexer window to be launched
 sub start_fresh_session {
     delete $hash{'mode_catalog'};
-    map {
+    delete $hash{'form_mode'};
+    delete $hash{'form_form'};
+    delete $hash{'form_element'};
+    foreach (keys %hash) {
 	if ($_ =~ /^pre_/) {
 	    delete $hash{$_};
 	}
 	if ($_ =~ /^store/) {
 	    delete $hash{$_};
 	}
-    } keys %hash;    
+    }
+}
+
+# ------------------------------------------------------------------- setvalues
+sub setvalues {
+    # setvalues is used in registerurl to synchronize the database
+    # hash and environment hashes
+    my ($H1,$h1key,$H2,$h2key) =@_;
+    #
+    if (exists $H2->{$h2key}) {
+	$H1->{$h1key} = $H2->{$h2key};
+    } elsif (exists $H1->{$h1key}) {
+	$H2->{$h2key} = $H1->{$h1key};
+    } 
 }
 
 1;
-__END__
+
+=head1 NAME
+
+Apache::lonindexer - mod_perl module for cross server filesystem browsing
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <LocationMatch "^/res.*/$">
+ SetHandler perl-script
+ PerlHandler Apache::lonindexer
+ </LocationMatch>
+
+=head1 INTRODUCTION
+
+This module enables a scheme of browsing across a cross server.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 BEGIN SUBROUTINE
+
+This routine is only run once after compilation.
+
+=over 4
+
+=item *
+
+Initializes %language hash table.
+
+=back
+
+=head1 HANDLER SUBROUTINE
+
+This routine is called by Apache and mod_perl.
+
+=over 4
+
+=item *
+
+read in machine configuration variables
+
+=item *
+
+see if called from an interactive mode
+
+=item *
+
+refresh environment with user database values (in %hash)
+
+=item *
+
+define extra fields and buttons in case of special mode
+
+=item *
+
+set catalogmodefunctions to have extra needed javascript functionality
+
+=item *
+
+print header
+
+=item *
+
+evaluate actions from previous page (both cumulatively and chronologically)
+
+=item *
+
+output title
+
+=item *
+
+get state of file attributes to be showing
+
+=item *
+
+output state of file attributes to be showing
+
+=item *
+
+output starting row to the indexed file/directory hierarchy
+
+=item *
+
+read in what directories have previously been set to "open"
+
+=item *
+
+if not at top level, provide an uplink arrow
+
+=item *
+
+recursively go through all the directories and output as appropriate
+
+=item *
+
+information useful for group import
+
+=item *
+
+end the tables
+
+=item *
+
+end the output and return
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+scanDir - recursive scan of a directory
+
+=item *
+
+get_list - get complete matched list based on the uri (returns an array)
+
+=item *
+
+match_ext - filters out files based on extensions (returns an array)
+
+=item *
+
+display_line - displays one line in appropriate table format
+
+=item *
+
+begin_form - prints the beginning of a form for directory or file link
+
+=item *
+
+start_fresh_session - settings whenever the user causes the indexer window
+to be launched
+
+=back
+
+=cut