--- loncom/interface/loncommon.pm	2003/06/24 22:16:32	1.107
+++ loncom/interface/loncommon.pm	2003/09/16 19:23:47	1.117
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.107 2003/06/24 22:16:32 albertel Exp $
+# $Id: loncommon.pm,v 1.117 2003/09/16 19:23:47 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -47,29 +47,15 @@ Apache::loncommon - pile of common routi
 
 =head1 SYNOPSIS
 
-Referenced by other mod_perl Apache modules.
+Common routines for manipulating connections, student answers,
+    domains, common Javascript fragments, etc.
 
-Invocation:
- &Apache::loncommon::SUBROUTINENAME(ARGUMENTS);
+=head1 OVERVIEW
 
-=head1 INTRODUCTION
-
-Common collection of used subroutines.  This collection helps remove
+A collection of commonly used subroutines that don't have a natural
+home anywhere else. This collection helps remove
 redundancy from other modules and increase efficiency of memory usage.
 
-Current things done:
-
- Makes a table out of the previous homework attempts
- Inputs result_from_symbread, user, domain, course_id
- Reads in non-network-related .tab files
-
-This is part of the LearningOnline Network with CAPA project
-described at http://www.lon-capa.org.
-
-=head2 General Subroutines
-
-=over 4
-
 =cut 
 
 # End of POD header
@@ -82,15 +68,16 @@ use POSIX qw(strftime mktime);
 use Apache::Constants qw(:common :http :methods);
 use Apache::lonmsg();
 use Apache::lonmenu();
+use Apache::lonlocal;
+
 my $readit;
 
 =pod 
 
-=item Global Variables
-
-=over 4
+=head1 Global Variables
 
 =cut
+
 # ----------------------------------------------- Filetypes/Languages/Copyright
 my %language;
 my %cprtag;
@@ -103,37 +90,45 @@ my %designhash;
 
 # ---------------------------------------------- Thesaurus variables
 
+# FIXME: I don't think it's necessary to document these things;
+# they're privately used - Jeremy
+
 =pod
 
-=item %Keywords  
+=over 4
+
+=item * %Keywords  
 
 A hash used by &keyword to determine if a word is considered a keyword.
 
-=item $thesaurus_db_file
+=item * $thesaurus_db_file
 
 Scalar containing the full path to the thesaurus database.                 
 
+=back
+
 =cut
 
 my %Keywords;
 my $thesaurus_db_file;
 
+# ----------------------------------------------------------------------- BEGIN
 
+# FIXME: I don't think this needs to be documented, it prepares
+# private data structures - Jeremy
 =pod
 
-=back
-
-=cut
-
-# ----------------------------------------------------------------------- BEGIN
+=head1 General Subroutines
 
-=pod
+=over 4
 
-=item BEGIN() 
+=item * BEGIN() 
 
 Initialize values from language.tab, copyright.tab, filetypes.tab,
 thesaurus.tab, and filecategories.tab.
 
+=back
+
 =cut
 
 # ----------------------------------------------------------------------- BEGIN
@@ -228,21 +223,27 @@ BEGIN {
     }  # end of unless($readit) 
     
 }
-# ============================================================= END BEGIN BLOCK
+
 ###############################################################
 ##           HTML and Javascript Helper Functions            ##
 ###############################################################
 
 =pod 
 
-=item browser_and_searcher_javascript 
+=head1 HTML and Javascript Functions
 
-Returns scalar containing javascript to open a browser window
-or a searcher window.  Also creates 
+=over 4
+
+=item * browser_and_searcher_javascript ()
+
+X<browsing, javascript>X<searching, javascript>Returns a string
+containing javascript with two functions, C<openbrowser> and
+C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
+tags.
 
 =over 4
 
-=item openbrowser(formname,elementname,only,omit) [javascript]
+=item * openbrowser(formname,elementname,only,omit) [javascript]
 
 inputs: formname, elementname, only, omit
 
@@ -255,7 +256,7 @@ with the given extension.  Can be a comm
 Specifying 'omit' will restrict the browser to NOT displaying files
 with the given extension.  Can be a comma seperated list.
 
-=item opensearcher(formname, elementname) [javascript]
+=item * opensearcher(formname, elementname) [javascript]
 
 Inputs: formname, elementname
 
@@ -266,7 +267,6 @@ of the element the selection from the se
 
 =cut
 
-###############################################################
 sub browser_and_searcher_javascript {
     return <<END;
     var editbrowser = null;
@@ -311,14 +311,15 @@ END
 }
 
 sub studentbrowser_javascript {
-   unless ($ENV{'request.course.id'}) { return ''; }  
-   unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
-        return '';
-   }
+   unless (
+            (($ENV{'request.course.id'}) && 
+             (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})))
+         || ($ENV{'request.role'}=~/^(au|dc|su)/)
+          ) { return ''; }  
    return (<<'ENDSTDBRW');
 <script type="text/javascript" language="Javascript" >
     var stdeditbrowser;
-    function openstdbrowser(formname,uname,udom) {
+    function openstdbrowser(formname,uname,udom,roleflag) {
         var url = '/adm/pickstudent?';
         var filter;
         eval('filter=document.'+formname+'.'+uname+'.value;');
@@ -329,6 +330,7 @@ sub studentbrowser_javascript {
         }
         url += 'form=' + formname + '&unameelement='+uname+
                                     '&udomelement='+udom;
+	if (roleflag) { url+="&roles=1"; }
         var title = 'Student_Browser';
         var options = 'scrollbars=1,resizable=1,menubar=0';
         options += ',width=700,height=600';
@@ -340,13 +342,19 @@ ENDSTDBRW
 }
 
 sub selectstudent_link {
-    my ($form,$unameele,$udomele)=@_;
-   unless ($ENV{'request.course.id'}) { return ''; }  
-   unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
-        return '';
-   }
-    return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
+   my ($form,$unameele,$udomele)=@_;
+   if ($ENV{'request.course.id'}) {  
+       unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+	   return '';
+       }
+       return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
         '","'.$udomele.'");'."'>Select User</a>";
+   }
+   if ($ENV{'request.role'}=~/^(au|dc|su)/) {
+       return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
+        '","'.$udomele.'",1);'."'>Select User</a>";
+   }
+   return '';
 }
 
 sub coursebrowser_javascript {
@@ -379,11 +387,9 @@ sub selectcourse_link {
         '","'.$udomele.'");'."'>Select Course</a>";
 }
 
-###############################################################
-
 =pod
 
-=item linked_select_forms(...)
+=item * linked_select_forms(...)
 
 linked_select_forms returns a string containing a <script></script> block
 and html for two <select> menus.  The select menus will be linked in that
@@ -395,17 +401,17 @@ linked_select_forms takes the following
 
 =over 4
 
-=item $formname, the name of the <form> tag
+=item * $formname, the name of the <form> tag
 
-=item $middletext, the text which appears between the <select> tags
+=item * $middletext, the text which appears between the <select> tags
 
-=item $firstdefault, the default value for the first menu
+=item * $firstdefault, the default value for the first menu
 
-=item $firstselectname, the name of the first <select> tag
+=item * $firstselectname, the name of the first <select> tag
 
-=item $secondselectname, the name of the second <select> tag
+=item * $secondselectname, the name of the second <select> tag
 
-=item $hashref, a reference to a hash containing the data for the menus.
+=item * $hashref, a reference to a hash containing the data for the menus.
 
 =back 
 
@@ -416,41 +422,39 @@ first menu value is given in $menu{$choi
 and text for the second menu are given in the hash pointed to by 
 $menu{$choice1}->{'select2'}.  
 
-my %menu = ( A1 => { text =>"Choice A1" ,
-                      default => "B3",
-                      select2 => { 
-                          B1 => "Choice B1",
-                          B2 => "Choice B2",
-                          B3 => "Choice B3",
-                          B4 => "Choice B4"
-                          }
-                  },
-              A2 => { text =>"Choice A2" ,
-                      default => "C2",
-                      select2 => { 
-                          C1 => "Choice C1",
-                          C2 => "Choice C2",
-                          C3 => "Choice C3"
-                          }
-                  },
-              A3 => { text =>"Choice A3" ,
-                      default => "D6",
-                      select2 => { 
-                          D1 => "Choice D1",
-                          D2 => "Choice D2",
-                          D3 => "Choice D3",
-                          D4 => "Choice D4",
-                          D5 => "Choice D5",
-                          D6 => "Choice D6",
-                          D7 => "Choice D7"
-                          }
-                  }
-              );
+ my %menu = ( A1 => { text =>"Choice A1" ,
+                       default => "B3",
+                       select2 => { 
+                           B1 => "Choice B1",
+                           B2 => "Choice B2",
+                           B3 => "Choice B3",
+                           B4 => "Choice B4"
+                           }
+                   },
+               A2 => { text =>"Choice A2" ,
+                       default => "C2",
+                       select2 => { 
+                           C1 => "Choice C1",
+                           C2 => "Choice C2",
+                           C3 => "Choice C3"
+                           }
+                   },
+               A3 => { text =>"Choice A3" ,
+                       default => "D6",
+                       select2 => { 
+                           D1 => "Choice D1",
+                           D2 => "Choice D2",
+                           D3 => "Choice D3",
+                           D4 => "Choice D4",
+                           D5 => "Choice D5",
+                           D6 => "Choice D6",
+                           D7 => "Choice D7"
+                           }
+                   }
+               );
 
 =cut
 
-# ------------------------------------------------
-
 sub linked_select_forms {
     my ($formname,
         $middletext,
@@ -529,19 +533,27 @@ END
     return $result;
 }   #  end of sub linked_select_forms {
 
-###############################################################
-
 =pod
 
-=item help_open_topic($topic, $text, $stayOnPage, $width, $height)
-
-Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces.
-
-$text will optionally be linked to the same topic, allowing you to link text in addition to the graphic. If you do not want to link text, but wish to specify one of the later parameters, pass an empty string.
-
-$stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.)
+=item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
 
-$width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included.
+Returns a string corresponding to an HTML link to the given help
+$topic, where $topic corresponds to the name of a .tex file in
+/home/httpd/html/adm/help/tex, with underscores replaced by
+spaces. 
+
+$text will optionally be linked to the same topic, allowing you to
+link text in addition to the graphic. If you do not want to link
+text, but wish to specify one of the later parameters, pass an
+empty string. 
+
+$stayOnPage is a value that will be interpreted as a boolean. If true,
+the link will not open a new window. If false, the link will open
+a new window using Javascript. (Default is false.) 
+
+$width and $height are optional numerical parameters that will
+override the width and height of the popped up window, which may
+be useful for certain help topics with big pictures included. 
 
 =cut
 
@@ -549,7 +561,8 @@ sub help_open_topic {
     my ($topic, $text, $stayOnPage, $width, $height) = @_;
     $text = "" if (not defined $text);
     $stayOnPage = 0 if (not defined $stayOnPage);
-    if ($ENV{'browser.interface'} eq 'textual') {
+    if ($ENV{'browser.interface'} eq 'textual' ||
+	$ENV{'environment.remote'} eq 'off' ) {
 	$stayOnPage=1;
     }
     $width = 350 if (not defined $width);
@@ -608,7 +621,7 @@ sub helpLatexCheatsheet {
 
 =pod
 
-=item csv_translate($text) 
+=item * csv_translate($text) 
 
 Translate $text to allow it to be output as a 'comma seperated values' 
 format.
@@ -622,14 +635,102 @@ sub csv_translate {
     return $text;
 }
 
+=pod
+
+=item * change_content_javascript():
+
+This and the next function allow you to create small sections of an
+otherwise static HTML page that you can update on the fly with
+Javascript, even in Netscape 4.
+
+The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
+must be written to the HTML page once. It will prove the Javascript
+function "change(name, content)". Calling the change function with the
+name of the section 
+you want to update, matching the name passed to C<changable_area>, and
+the new content you want to put in there, will put the content into
+that area.
+
+B<Note>: Netscape 4 only reserves enough space for the changable area
+to contain room for the original contents. You need to "make space"
+for whatever changes you wish to make, and be B<sure> to check your
+code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
+it's adequate for updating a one-line status display, but little more.
+This script will set the space to 100% width, so you only need to
+worry about height in Netscape 4.
+
+Modern browsers are much less limiting, and if you can commit to the
+user not using Netscape 4, this feature may be used freely with
+pretty much any HTML.
+
+=cut
+
+sub change_content_javascript {
+    # If we're on Netscape 4, we need to use Layer-based code
+    if ($ENV{'browser.type'} eq 'netscape' &&
+	$ENV{'browser.version'} =~ /^4\./) {
+	return (<<NETSCAPE4);
+	function change(name, content) {
+	    doc = document.layers[name+"___escape"].layers[0].document;
+	    doc.open();
+	    doc.write(content);
+	    doc.close();
+	}
+NETSCAPE4
+    } else {
+	# Otherwise, we need to use semi-standards-compliant code
+	# (technically, "innerHTML" isn't standard but the equivalent
+	# is really scary, and every useful browser supports it
+	return (<<DOMBASED);
+	function change(name, content) {
+	    element = document.getElementById(name);
+	    element.innerHTML = content;
+	}
+DOMBASED
+    }
+}
+
+=pod
+
+=item * changable_area($name, $origContent):
+
+This provides a "changable area" that can be modified on the fly via
+the Javascript code provided in C<change_content_javascript>. $name is
+the name you will use to reference the area later; do not repeat the
+same name on a given HTML page more then once. $origContent is what
+the area will originally contain, which can be left blank.
+
+=cut
+
+sub changable_area {
+    my ($name, $origContent) = @_;
+
+    if ($ENV{'browser.type'} eq 'netscape' &&
+	$ENV{'browser.version'} =~ /^4\./) {
+	# If this is netscape 4, we need to use the Layer tag
+	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
+    } else {
+	return "<span id='$name'>$origContent</span>";
+    }
+}
+
+=pod
+
+=back
+
+=cut
+
 ###############################################################
 ##        Home server <option> list generating code          ##
 ###############################################################
-#-------------------------------------------
 
 =pod
 
-=item get_domains()
+=head1 Home Server option list generating code
+
+=over 4
+
+=item * get_domains()
 
 Returns an array containing each of the domains listed in the hosts.tab
 file.
@@ -651,7 +752,7 @@ sub get_domains {
 
 =pod
 
-=item select_form($defdom,$name,%hash)
+=item * select_form($defdom,$name,%hash)
 
 Returns a string containing a <select name='$name' size='1'> form to 
 allow a user to select options from a hash option_name => displayed text.  
@@ -677,7 +778,7 @@ sub select_form {
 
 =pod
 
-=item select_dom_form($defdom,$name,$includeempty)
+=item * select_dom_form($defdom,$name,$includeempty)
 
 Returns a string containing a <select name='$name' size='1'> form to 
 allow a user to select the domain to preform an operation in.  
@@ -707,7 +808,7 @@ sub select_dom_form {
 
 =pod
 
-=item get_library_servers($domain)
+=item * get_library_servers($domain)
 
 Returns a hash which contains keys like '103l3' and values like 
 'kirk.lite.msu.edu'.  All of the keys will be for machines in the
@@ -731,7 +832,7 @@ sub get_library_servers {
 
 =pod
 
-=item home_server_option_list($domain)
+=item * home_server_option_list($domain)
 
 returns a string which contains an <option> list to be used in a 
 <select> form input.  See loncreateuser.pm for an example.
@@ -749,16 +850,24 @@ sub home_server_option_list {
     }
     return $result;
 }
-###############################################################
-##    End of home server <option> list generating code       ##
-###############################################################
+
+=pod
+
+=back
+
+=cut
 
 ###############################################################
+##                  Decoding User Agent                      ##
 ###############################################################
 
 =pod
 
-=item &decode_user_agent()
+=head1 Decoding the User Agent
+
+=over 4
+
+=item * &decode_user_agent()
 
 Inputs: $r
 
@@ -766,17 +875,17 @@ Outputs:
 
 =over 4
 
-=item $httpbrowser
+=item * $httpbrowser
 
-=item $clientbrowser
+=item * $clientbrowser
 
-=item $clientversion
+=item * $clientversion
 
-=item $clientmathml
+=item * $clientmathml
 
-=item $clientunicode
+=item * $clientunicode
 
-=item $clientos
+=item * $clientos
 
 =back
 
@@ -818,9 +927,11 @@ sub decode_user_agent {
             $clientunicode,$clientos,);
 }
 
-###############################################################
-###############################################################
+=pod
+
+=back
 
+=cut
 
 ###############################################################
 ##    Authentication changing form generation subroutines    ##
@@ -834,7 +945,11 @@ sub decode_user_agent {
 
 =pod
 
-=item authform_xxxxxx
+=head1 Authentication Routines
+
+=over 4
+
+=item * authform_xxxxxx
 
 The authform_xxxxxx subroutines provide javascript and html forms which 
 handle some of the conveniences required for authentication forms.  
@@ -844,17 +959,17 @@ See loncreateuser.pm for invocation and
 
 =over 4
 
-=item authform_header
+=item * authform_header
 
-=item authform_authorwarning
+=item * authform_authorwarning
 
-=item authform_nochange
+=item * authform_nochange
 
-=item authform_kerberos
+=item * authform_kerberos
 
-=item authform_internal
+=item * authform_internal
 
-=item authform_filesystem
+=item * authform_filesystem
 
 =back
 
@@ -1052,22 +1167,26 @@ END
     return $result;
 }
 
-###############################################################
-##   End Authentication changing form generation functions   ##
-###############################################################
+=pod
+
+=back
+
+=cut
 
 ###############################################################
 ##    Get Authentication Defaults for Domain                 ##
 ###############################################################
-##
-## Returns default authentication type and an associated argument
-## as listed in file domain.tab
-##
-#-------------------------------------------
 
 =pod
 
-=item get_auth_defaults
+=head1 Domains and Authentication
+
+Returns default authentication type and an associated argument as
+listed in file 'domain.tab'.
+
+=over 4
+
+=item * get_auth_defaults
 
 get_auth_defaults($target_domain) returns the default authentication
 type and an associated argument (initial password or a kerberos domain).
@@ -1077,12 +1196,6 @@ These values are stored in lonTabs/domai
 
 If target_domain is not found in domain.tab, returns nothing ('').
 
-=over 4
-
-=item get_auth_defaults
-
-=back
-
 =cut
 
 #-------------------------------------------
@@ -1106,7 +1219,7 @@ sub get_auth_defaults {
 
 =pod
 
-=item get_kerberos_defaults
+=item * get_kerberos_defaults
 
 get_kerberos_defaults($target_domain) returns the default kerberos
 version and domain. If not found in domain.tabs, it defaults to
@@ -1114,12 +1227,6 @@ version 4 and the domain of the server.
 
 ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
 
-=over 4
-
-=item get_kerberos_defaults
-
-=back
-
 =cut
 
 #-------------------------------------------
@@ -1135,9 +1242,12 @@ sub get_kerberos_defaults {
     }
     return ($krbdef,$krbdefdom);
 }
-###############################################################
-##   End Get Kerberos Defaults for Domain              ##
-###############################################################
+
+=pod
+
+=back
+
+=cut
 
 ###############################################################
 ##                Thesaurus Functions                        ##
@@ -1145,7 +1255,11 @@ sub get_kerberos_defaults {
 
 =pod
 
-=item initialize_keywords
+=head1 Thesaurus Functions
+
+=over 4
+
+=item * initialize_keywords
 
 Initializes the package variable %Keywords if it is empty.  Uses the
 package variable $thesaurus_db_file.
@@ -1190,7 +1304,7 @@ sub initialize_keywords {
 
 =pod
 
-=item keyword($word)
+=item * keyword($word)
 
 Returns true if $word is a keyword.  A keyword is a word that appears more 
 than the average number of times in the thesaurus database.  Calls 
@@ -1211,7 +1325,7 @@ sub keyword {
 
 =pod 
 
-=item get_related_words
+=item * get_related_words
 
 Look up a word in the thesaurus.  Takes a scalar arguement and returns
 an array of words.  If the keyword is not in the thesaurus, an empty array
@@ -1248,18 +1362,23 @@ sub get_related_words {
     return @Words;
 }
 
-###############################################################
-##              End Thesaurus Functions                      ##
-###############################################################
+=pod
+
+=back
+
+=cut
 
 # -------------------------------------------------------------- Plaintext name
 =pod
 
-=item plainname($uname,$udom)
+=head1 User Name Functions
 
-Gets a users name and returns it as a string in
-"first middle last generation"
-form
+=over 4
+
+=item * plainname($uname,$udom)
+
+Takes a users logon name and returns it as a string in
+"first middle last generation" form
 
 =cut
 
@@ -1279,7 +1398,7 @@ sub plainname {
 # -------------------------------------------------------------------- Nickname
 =pod
 
-=item nickname($uname,$udom)
+=item * nickname($uname,$udom)
 
 Gets a users name and returns it as a string as
 
@@ -1314,7 +1433,7 @@ sub nickname {
 
 =pod
 
-=item screenname($uname,$udom)
+=item * screenname($uname,$udom)
 
 Gets a users screenname and returns it as a string
 
@@ -1352,21 +1471,142 @@ sub aboutmewrapper {
 
 
 sub syllabuswrapper {
-    my ($link,$un,$do,$tf)=@_;
-    if ($tf) { $link='<font color="'.$tf.'">'.$link.'</font>'; }
-    return "<a href='/public/$do/$un/syllabus'>$link</a>";
+    my ($linktext,$coursedir,$domain,$fontcolor)=@_;
+    if ($fontcolor) { 
+        $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>'; 
+    }
+    return "<a href='/public/$domain/$coursedir/syllabus'>$linktext</a>";
 }
 
-# ---------------------------------------------------------------- Language IDs
+=pod
+
+=back
+
+=head1 Access .tab File Data
+
+=over 4
+
+=item * languageids() 
+
+returns list of all language ids
+
+=cut
+
 sub languageids {
     return sort(keys(%language));
 }
 
-# -------------------------------------------------------- Language Description
+=pod
+
+=item * languagedescription() 
+
+returns description of a specified language id
+
+=cut
+
 sub languagedescription {
     return $language{shift(@_)};
 }
 
+=pod
+
+=item * copyrightids() 
+
+returns list of all copyrights
+
+=cut
+
+sub copyrightids {
+    return sort(keys(%cprtag));
+}
+
+=pod
+
+=item * copyrightdescription() 
+
+returns description of a specified copyright id
+
+=cut
+
+sub copyrightdescription {
+    return $cprtag{shift(@_)};
+}
+
+=pod
+
+=item * filecategories() 
+
+returns list of all file categories
+
+=cut
+
+sub filecategories {
+    return sort(keys(%category_extensions));
+}
+
+=pod
+
+=item * filecategorytypes() 
+
+returns list of file types belonging to a given file
+category
+
+=cut
+
+sub filecategorytypes {
+    return @{$category_extensions{lc($_[0])}};
+}
+
+=pod
+
+=item * fileembstyle() 
+
+returns embedding style for a specified file type
+
+=cut
+
+sub fileembstyle {
+    return $fe{lc(shift(@_))};
+}
+
+=pod
+
+=item * filedescription() 
+
+returns description for a specified file type
+
+=cut
+
+sub filedescription {
+    return $fd{lc(shift(@_))};
+}
+
+=pod
+
+=item * filedescriptionex() 
+
+returns description for a specified file type with
+extra formatting
+
+=cut
+
+sub filedescriptionex {
+    my $ex=shift;
+    return '.'.$ex.' '.$fd{lc($ex)};
+}
+
+# End of .tab access
+=pod
+
+=back
+
+=cut
+
+# ------------------------------------------------------------------ File Types
+sub fileextensions {
+    return sort(keys(%fe));
+}
+
 # ----------------------------------------------------------- Display Languages
 # returns a hash with all desired display languages
 #
@@ -1393,59 +1633,57 @@ sub display_languages {
     return %languages;
 }
 
-# --------------------------------------------------------------- Copyright IDs
-sub copyrightids {
-    return sort(keys(%cprtag));
+sub preferred_languages {
+    my @languages=();
+    if ($ENV{'environment.languages'}) {
+	@languages=split(/\s*(\,|\;|\:)\s*/,$ENV{'environment.languages'});
+    }
+    if ($ENV{'course.'.$ENV{'request.course.id'}.'.languages'}) {
+	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
+	         $ENV{'course.'.$ENV{'request.course.id'}.'.languages'}));
+    }
+    return (@languages,'en-US');
 }
 
-# ------------------------------------------------------- Copyright Description
-sub copyrightdescription {
-    return $cprtag{shift(@_)};
-}
+###############################################################
+##               Student Answer Attempts                     ##
+###############################################################
 
-# ------------------------------------------------------------- File Categories
-sub filecategories {
-    return sort(keys(%category_extensions));
-}
+=pod
 
-# -------------------------------------- File Types within a specified category
-sub filecategorytypes {
-    return @{$category_extensions{lc($_[0])}};
-}
+=head1 Alternate Problem Views
 
-# ------------------------------------------------------------------ File Types
-sub fileextensions {
-    return sort(keys(%fe));
-}
+=over 4
 
-# ------------------------------------------------------------- Embedding Style
-sub fileembstyle {
-    return $fe{lc(shift(@_))};
-}
+=item * get_previous_attempt($symb, $username, $domain, $course,
+    $getattempt, $regexp, $gradesub)
 
-# ------------------------------------------------------------ Description Text
-sub filedescription {
-    return $fd{lc(shift(@_))};
-}
+Return string with previous attempt on problem. Arguments:
 
-# ------------------------------------------------------------ Description Text
-sub filedescriptionex {
-    my $ex=shift;
-    return '.'.$ex.' '.$fd{lc($ex)};
-}
+=over 4
+
+=item * $symb: Problem, including path
+
+=item * $username: username of the desired student
+
+=item * $domain: domain of the desired student
+
+=item * $course: Course ID
+
+=item * $getattempt: Leave blank for all attempts, otherwise put
+    something
+
+=item * $regexp: if string matches this regexp, the string will be
+    sent to $gradesub
+
+=item * $gradesub: routine that processes the string if it matches $regexp
+
+=back
+
+The output string is a table containing all desired attempts, if any.
+
+=cut
 
-# ---- Retrieve attempts by students
-# input
-# $symb             - problem including path
-# $username,$domain - that of the student
-# $course           - course name
-# $getattempt       - leave blank if want all attempts, else put something.
-# $regexp           - regular expression. If string matches regexp send to
-# $gradesub         - routine that process the string if it matches regexp
-# 
-# output
-# formatted as a table all the attempts, if any.
-#
 sub get_previous_attempt {
   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
   my $prevattempts='';
@@ -1546,9 +1784,17 @@ sub relative_to_absolute {
     return $output;
 }
 
+=pod
+
+=item * get_student_view
+
+show a snapshot of what student was looking at
+
+=cut
+
 sub get_student_view {
   my ($symb,$username,$domain,$courseid,$target) = @_;
-  my ($map,$id,$feedurl) = split(/___/,$symb);
+  my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
   my (%old,%moreenv);
   my @elements=('symb','courseid','domain','username');
   foreach my $element (@elements) {
@@ -1574,9 +1820,17 @@ sub get_student_view {
   return $userview;
 }
 
+=pod
+
+=item * get_student_answers() 
+
+show a snapshot of how student was answering problem
+
+=cut
+
 sub get_student_answers {
   my ($symb,$username,$domain,$courseid,%form) = @_;
-  my ($map,$id,$feedurl) = split(/___/,$symb);
+  my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
   my (%old,%moreenv);
   my @elements=('symb','courseid','domain','username');
   foreach my $element (@elements) {
@@ -1593,6 +1847,36 @@ sub get_student_answers {
   return $userview;
 }
 
+=pod
+
+=item * &submlink()
+
+Inputs: $text $uname $udom $symb
+
+Returns: A link to grades.pm such as to see the SUBM view of a student
+
+=cut
+
+###############################################
+sub submlink {
+    my ($text,$uname,$udom,$symb)=@_;
+    if (!($uname && $udom)) {
+	(my $cursymb, my $courseid,$udom,$uname)=
+	    &Apache::lonxml::whichuser($symb);
+	if (!$symb) { $symb=$cursymb; }
+    }
+    if (!$symb) { $symb=&symbread(); }
+    return '<a href="/adm/grades?symb='.$symb.'&student='.$uname.
+	'&userdom='.$udom.'&command=submission">'.$text.'</a>';
+}
+##############################################
+
+=pod
+
+=back
+
+=cut
+
 ###############################################
 
 
@@ -1657,7 +1941,11 @@ sub findallcourses {
 
 =pod
 
-=item &determinedomain()
+=head1 Domain Template Functions
+
+=over 4
+
+=item * &determinedomain()
 
 Inputs: $domain (usually will be undef)
 
@@ -1681,7 +1969,7 @@ sub determinedomain {
 ###############################################
 =pod
 
-=item &domainlogo()
+=item * &domainlogo()
 
 Inputs: $domain (usually will be undef)
 
@@ -1689,6 +1977,7 @@ Returns: A link to a domain logo, if the
 If the domain logo does not exist, a description of the domain.
 
 =cut
+
 ###############################################
 sub domainlogo {
     my $domain = &determinedomain(shift);    
@@ -1708,16 +1997,28 @@ sub domainlogo {
 
 =pod
 
-=item &designparm()
+=item * &designparm()
 
 Inputs: $which parameter; $domain (usually will be undef)
 
 Returns: value of designparamter $which
 
 =cut
+
 ##############################################
 sub designparm {
     my ($which,$domain)=@_;
+    if ($ENV{'browser.blackwhite'} eq 'on') {
+	if ($which=~/\.(font|alink|vlink|link)$/) {
+	    return '#000000';
+	}
+	if ($which=~/\.(pgbg|sidebg)$/) {
+	    return '#FFFFFF';
+	}
+	if ($which=~/\.tabbg$/) {
+	    return '#CCCCCC';
+	}
+    }
     if ($ENV{'environment.color.'.$which}) {
 	return $ENV{'environment.color.'.$which};
     }
@@ -1734,20 +2035,35 @@ sub designparm {
 
 =pod
 
-=item &bodytag()
+=back
+
+=head1 HTTP Helpers
+
+=over 4
+
+=item * &bodytag()
 
 Returns a uniform header for LON-CAPA web pages.
 
 Inputs: 
 
- $title, A title to be displayed on the page.
- $function, the current role (can be undef).
- $addentries, extra parameters for the <body> tag.
- $bodyonly, if defined, only return the <body> tag.
- $domain, if defined, force a given domain.
- $forcereg, if page should register as content page (relevant for 
+=over 4
+
+=item * $title, A title to be displayed on the page.
+
+=item * $function, the current role (can be undef).
+
+=item * $addentries, extra parameters for the <body> tag.
+
+=item * $bodyonly, if defined, only return the <body> tag.
+
+=item * $domain, if defined, force a given domain.
+
+=item * $forcereg, if page should register as content page (relevant for 
             text interface only)
 
+=back
+
 Returns: A uniform header for LON-CAPA web pages.  
 If $bodyonly is nonzero, a string containing a <body> tag will be returned.
 If $bodyonly is undef or zero, an html string containing a <body> tag and 
@@ -1755,12 +2071,9 @@ other decorations will be returned.
 
 =cut
 
-###############################################
-
-
-###############################################
 sub bodytag {
     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg)=@_;
+    $title=&mt($title);
     unless ($function) {
 	$function='student';
         if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {
@@ -1782,7 +2095,11 @@ sub bodytag {
     my $alink=&designparm($function.'.alink',$domain);
     my $vlink=&designparm($function.'.vlink',$domain);
     my $sidebg=&designparm($function.'.sidebg',$domain);
-
+# Accessibility font enhance
+    unless ($addentries) { $addentries=''; }
+    if ($ENV{'browser.fontenhance'} eq 'on') {
+	$addentries.=' style="font-size: x-large"';
+    }
  # role and realm
     my ($role,$realm)
        =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]);
@@ -1921,7 +2238,20 @@ sub get_posted_cgi {
     $r->headers_in->unset('Content-length');
 }
 
-###############################################
+=pod
+
+=item * get_unprocessed_cgi($query,$possible_names)
+
+Modify the %ENV hash to contain unprocessed CGI form parameters held in
+$query.  The parameters listed in $possible_names (an array reference),
+will be set in $ENV{'form.name'} if they do not already exist.
+
+Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
+$possible_names is an ref to an array of form element names.  As an example:
+get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
+will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set.
+
+=cut
 
 sub get_unprocessed_cgi {
   my ($query,$possible_names)= @_;
@@ -1938,6 +2268,14 @@ sub get_unprocessed_cgi {
   }
 }
 
+=pod
+
+=item * cacheheader() 
+
+returns cache-controlling header code
+
+=cut
+
 sub cacheheader {
   unless ($ENV{'request.method'} eq 'GET') { return ''; }
   my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
@@ -1947,6 +2285,14 @@ sub cacheheader {
   return $output;
 }
 
+=pod
+
+=item * no_cache($r) 
+
+specifies header code to not have cache
+
+=cut
+
 sub no_cache {
   my ($r) = @_;
   unless ($ENV{'request.method'} eq 'GET') { return ''; }
@@ -1956,6 +2302,16 @@ sub no_cache {
   #$r->header_out("Expires" => $date);
 }
 
+=pod
+
+=item * add_to_env($name,$value) 
+
+adds $name to the %ENV hash with value
+$value, if $name already exists, the entry is converted to an array
+reference and $value is added to the array.
+
+=cut
+
 sub add_to_env {
   my ($name,$value)=@_;
   if (defined($ENV{$name})) {
@@ -1977,11 +2333,11 @@ sub add_to_env {
 
 =back 
 
-=head2 CSV Upload/Handling functions
+=head1 CSV Upload/Handling functions
 
 =over 4
 
-=item  upfile_store($r)
+=item * upfile_store($r)
 
 Store uploaded file, $r should be the HTTP Request object,
 needs $ENV{'form.upfile'}
@@ -2008,7 +2364,7 @@ sub upfile_store {
 
 =pod
 
-=item load_tmp_file($r)
+=item * load_tmp_file($r)
 
 Load uploaded file from tmp, $r should be the HTTP Request object,
 needs $ENV{'form.datatoken'},
@@ -2031,7 +2387,7 @@ sub load_tmp_file {
 
 =pod
 
-=item upfile_record_sep()
+=item * upfile_record_sep()
 
 Separate uploaded file into records
 returns array of records,
@@ -2048,7 +2404,7 @@ sub upfile_record_sep {
 
 =pod
 
-=item record_sep($record)
+=item * record_sep($record)
 
 Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}
 
@@ -2100,7 +2456,7 @@ sub record_sep {
 
 =pod
 
-=item upfile_select_html()
+=item * upfile_select_html()
 
 return HTML code to select file and specify its type
 
@@ -2120,7 +2476,7 @@ ENDUPFORM
 
 =pod
 
-=item csv_print_samples($r,$records)
+=item * csv_print_samples($r,$records)
 
 Prints a table of sample values from each column uploaded $r is an
 Apache Request ref, $records is an arrayref from
@@ -2152,7 +2508,7 @@ sub csv_print_samples {
 
 =pod
 
-=item csv_print_select_table($r,$records,$d)
+=item * csv_print_select_table($r,$records,$d)
 
 Prints a table to create associations between values and table columns.
 $r is an Apache Request ref,
@@ -2186,7 +2542,7 @@ sub csv_print_select_table {
 
 =pod
 
-=item csv_samples_select_table($r,$records,$d)
+=item * csv_samples_select_table($r,$records,$d)
 
 Prints a table of sample values from the upload and can make associate samples to internal names.
 
@@ -2226,7 +2582,24 @@ sub csv_samples_select_table {
 
 =pod
 
-=item check_if_partid_hidden($id,$symb,$udom,$uname)
+=item clean_excel_name($name)
+
+Returns a replacement for $name which does not contain any illegal characters.
+
+=cut
+
+sub clean_excel_name {
+    my ($name) = @_;
+    $name =~ s/[:\*\?\/\\]//g;
+    if (length($name) > 31) {
+        $name = substr($name,0,31);
+    }
+    return $name;
+}
+
+=pod
+
+=item * check_if_partid_hidden($id,$symb,$udom,$uname)
 
 Returns either 1 or undef
 
@@ -2252,106 +2625,12 @@ sub check_if_partid_hidden {
     return undef;
 }
 
-
-
-1;
-__END__;
-
 =pod
 
 =back
 
-=head2 Access .tab File Data
-
-=over 4
-
-=item languageids() 
-
-returns list of all language ids
-
-=item languagedescription() 
-
-returns description of a specified language id
-
-=item copyrightids() 
-
-returns list of all copyrights
-
-=item copyrightdescription() 
-
-returns description of a specified copyright id
-
-=item filecategories() 
-
-returns list of all file categories
-
-=item filecategorytypes() 
-
-returns list of file types belonging to a given file
-category
-
-=item fileembstyle() 
-
-returns embedding style for a specified file type
-
-=item filedescription() 
-
-returns description for a specified file type
-
-=item filedescriptionex() 
-
-returns description for a specified file type with
-extra formatting
-
-=back
-
-=head2 Alternate Problem Views
-
-=over 4
-
-=item get_previous_attempt() 
-
-return string with previous attempt on problem
-
-=item get_student_view() 
-
-show a snapshot of what student was looking at
-
-=item get_student_answers() 
-
-show a snapshot of how student was answering problem
-
-=back
-
-=head2 HTTP Helper
-
-=over 4
-
-=item get_unprocessed_cgi($query,$possible_names)
-
-Modify the %ENV hash to contain unprocessed CGI form parameters held in
-$query.  The parameters listed in $possible_names (an array reference),
-will be set in $ENV{'form.name'} if they do not already exist.
-
-Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
-$possible_names is an ref to an array of form element names.  As an example:
-get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
-will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set.
-
-=item cacheheader() 
-
-returns cache-controlling header code
-
-=item no_cache($r) 
-
-specifies header code to not have cache
-
-=item add_to_env($name,$value) 
-
-adds $name to the %ENV hash with value
-$value, if $name already exists, the entry is converted to an array
-reference and $value is added to the array.
+=cut
 
-=back
+1;
+__END__;
 
-=cut