loncom/interface/loncommon.pm - diff

Return to loncommon.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/loncommon.pm between versions 1.108 and 1.344

-version 1.108, 2003/07/16 14:21:56
+version 1.344, 2006/04/20 02:24:08
  Line 25
  #
  # http://www.lon-capa.org/
  #
- # YEAR=2001
- # 2/13-12/7 Guy Albertelli
- # 12/21 Gerd Kortemeyer
- # 12/25,12/28 Gerd Kortemeyer
- # YEAR=2002
- # 1/4 Gerd Kortemeyer
- # 6/24,7/2 H. K. Ng
  # Makes a table out of the previous attempts
  # Inputs result_from_symbread, user, domain, course_id
- Line 47  Apache::loncommon - pile of common routi
+ Line 40  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:
+ =head1 OVERVIEW
-  &Apache::loncommon::SUBROUTINENAME(ARGUMENTS);
- =head1 INTRODUCTION
+ A collection of commonly used subroutines that don't have a natural
+ home anywhere else. This collection helps remove
- Common collection of used subroutines.  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
  package Apache::loncommon;
  use strict;
- use Apache::lonnet();
+ use Apache::lonnet;
  use GDBM_File;
  use POSIX qw(strftime mktime);
- use Apache::Constants qw(:common :http :methods);
- use Apache::lonmsg();
  use Apache::lonmenu();
- my $readit;
+ use Apache::lonlocal;
+ use HTML::Entities;
- =pod
+ use Apache::lonhtmlcommon();
+ use Apache::loncoursedata();
+ use Apache::lontexconvert();
- =item Global Variables
+ my $readit;
- =over 4
+ ##
+ ## Global Variables
+ ##
- =cut
  # ----------------------------------------------- Filetypes/Languages/Copyright
  my %language;
+ my %supported_language;
  my %cprtag;
+ my %scprtag;
  my %fe; my %fd;
  my %category_extensions;
- Line 102  my %category_extensions;
+ Line 84  my %category_extensions;
  my %designhash;
  # ---------------------------------------------- Thesaurus variables
+ #
- =pod
+ # %Keywords:
+ #      A hash used by &keyword to determine if a word is considered a keyword.
- =item %Keywords
+ # $thesaurus_db_file
+ #      Scalar containing the full path to the thesaurus database.
- A hash used by &keyword to determine if a word is considered a keyword.
- =item $thesaurus_db_file
- Scalar containing the full path to the thesaurus database.
- =cut
  my %Keywords;
  my $thesaurus_db_file;
+ #
- =pod
+ # Initialize values from language.tab, copyright.tab, filetypes.tab,
+ # thesaurus.tab, and filecategories.tab.
- =back
+ #
- =cut
- # ----------------------------------------------------------------------- BEGIN
- =pod
- =item BEGIN()
- Initialize values from language.tab, copyright.tab, filetypes.tab,
- thesaurus.tab, and filecategories.tab.
- =cut
- # ----------------------------------------------------------------------- BEGIN
  BEGIN {
      # Variable initialization
      $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
- Line 145  BEGIN {
+ Line 104  BEGIN {
      unless ($readit) {
  # ------------------------------------------------------------------- languages
      {
- 	my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
+         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
- 				 '/language.tab');
+                                    '/language.tab';
- 	if ($fh) {
+         if ( open(my $fh,"<$langtabfile") ) {
- 	    while (<$fh>) {
+             while (<$fh>) {
- 		next if /^\#/;
+                 next if /^\#/;
- 		chomp;
+                 chomp;
- 		my ($key,$two,$country,$three,$enc,$val)=(split(/\t/,$_));
+                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_));
- 		$language{$key}=$val.' - '.$enc;
+                 $language{$key}=$val.' - '.$enc;
- 	    }
+                 if ($sup) {
- 	}
+                     $supported_language{$key}=$sup;
+                 }
+             }
+             close($fh);
+         }
      }
  # ------------------------------------------------------------------ copyrights
      {
- 	my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonIncludes'}.
+         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
- 				  '/copyright.tab');
+                                   '/copyright.tab';
- 	if ($fh) {
+         if ( open (my $fh,"<$copyrightfile") ) {
- 	    while (<$fh>) {
+             while (<$fh>) {
- 		next if /^\#/;
+                 next if /^\#/;
- 		chomp;
+                 chomp;
- 		my ($key,$val)=(split(/\s+/,$_,2));
+                 my ($key,$val)=(split(/\s+/,$_,2));
- 		$cprtag{$key}=$val;
+                 $cprtag{$key}=$val;
- 	    }
+             }
- 	}
+             close($fh);
+         }
+     }
+ # ------------------------------------------------------------------ source copyrights
+     {
+         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
+                                   '/source_copyright.tab';
+         if ( open (my $fh,"<$sourcecopyrightfile") ) {
+             while (<$fh>) {
+                 next if /^\#/;
+                 chomp;
+                 my ($key,$val)=(split(/\s+/,$_,2));
+                 $scprtag{$key}=$val;
+             }
+             close($fh);
+         }
      }
  # -------------------------------------------------------------- domain designs
- Line 176  BEGIN {
+ Line 154  BEGIN {
      my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
      opendir(DIR,$designdir);
      while ($filename=readdir(DIR)) {
+ 	if ($filename!~/\.tab$/) { next; }
  	my ($domain)=($filename=~/^(\w+)\./);
-     {
+ 	{
- 	my $fh=Apache::File->new($designdir.'/'.$filename);
+ 	    my $designfile = $designdir.'/'.$filename;
- 	if ($fh) {
+ 	    if ( open (my $fh,"<$designfile") ) {
- 	    while (<$fh>) {
+ 		while (<$fh>) {
- 		next if /^\#/;
+ 		    next if /^\#/;
- 		chomp;
+ 		    chomp;
- 		my ($key,$val)=(split(/\=/,$_));
+ 		    my ($key,$val)=(split(/\=/,$_));
- 		if ($val) { $designhash{$domain.'.'.$key}=$val; }
+ 		    if ($val) { $designhash{$domain.'.'.$key}=$val; }
+ 		}
+ 		close($fh);
  	    }
  	}
-     }
      }
      closedir(DIR);
- Line 195  BEGIN {
+ Line 175  BEGIN {
  # ------------------------------------------------------------- file categories
      {
- 	my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
+         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
- 				  '/filecategories.tab');
+                                   '/filecategories.tab';
- 	if ($fh) {
+         if ( open (my $fh,"<$categoryfile") ) {
- 	    while (<$fh>) {
+             while (<$fh>) {
- 		next if /^\#/;
+                 next if /^\#/;
- 		chomp;
+                 chomp;
- 		my ($extension,$category)=(split(/\s+/,$_,2));
+                 my ($extension,$category)=(split(/\s+/,$_,2));
- 		push @{$category_extensions{lc($category)}},$extension;
+                 push @{$category_extensions{lc($category)}},$extension;
- 	    }
+             }
- 	}
+             close($fh);
+         }
      }
  # ------------------------------------------------------------------ file types
      {
- 	my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
+         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
- 	       '/filetypes.tab');
+                '/filetypes.tab';
- 	if ($fh) {
+         if ( open (my $fh,"<$typesfile") ) {
              while (<$fh>) {
- 		next if (/^\#/);
+                 next if (/^\#/);
- 		chomp;
+                 chomp;
- 		my ($ending,$emb,$descr)=split(/\s+/,$_,3);
+                 my ($ending,$emb,$descr)=split(/\s+/,$_,3);
- 		if ($descr ne '') {
+                 if ($descr ne '') {
- 		    $fe{$ending}=lc($emb);
+                     $fe{$ending}=lc($emb);
- 		    $fd{$ending}=$descr;
+                     $fd{$ending}=$descr;
- 		}
+                 }
- 	    }
+             }
- 	}
+             close($fh);
+         }
      }
      &Apache::lonnet::logthis(
                "<font color=yellow>INFO: Read file types</font>");
- Line 228  BEGIN {
+ Line 211  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 openbrowser(formname,elementname,only,omit) [javascript]
+ =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.
+ =item * openbrowser(formname,elementname,only,omit) [javascript]
  inputs: formname, elementname, only, omit
- Line 250  formname and elementname indicate the na
+ Line 237  formname and elementname indicate the na
  the element that the results of the browsing selection are to be placed in.
  Specifying 'only' will restrict the browser to displaying only files
- with the given extension.  Can be a comma seperated list.
+ with the given extension.  Can be a comma separated list.
  Specifying 'omit' will restrict the browser to NOT displaying files
- with the given extension.  Can be a comma seperated list.
+ with the given extension.  Can be a comma separated list.
- =item opensearcher(formname, elementname) [javascript]
+ =item * opensearcher(formname, elementname) [javascript]
  Inputs: formname, elementname
  formname and elementname specify the name of the html form and the name
  of the element the selection from the search results will be placed in.
- =back
  =cut
- ###############################################################
  sub browser_and_searcher_javascript {
+     my ($mode)=@_;
+     if (!defined($mode)) { $mode='edit'; }
+     my $resurl=&lastresurl();
      return <<END;
+ // <!-- BEGIN LON-CAPA Internal
      var editbrowser = null;
-     function openbrowser(formname,elementname,only,omit) {
+     function openbrowser(formname,elementname,only,omit,titleelement) {
-         var url = '/res/?';
+         var url = '$resurl/?';
          if (editbrowser == null) {
              url += 'launch=1&';
          }
          url += 'catalogmode=interactive&';
-         url += 'mode=edit&';
+         url += 'mode=$mode&';
          url += 'form=' + formname + '&';
          if (only != null) {
              url += 'only=' + only + '&';
-         }
+         } else {
+             url += 'only=&';
+ 	}
          if (omit != null) {
              url += 'omit=' + omit + '&';
-         }
+         } else {
+             url += 'omit=&';
+ 	}
+         if (titleelement != null) {
+             url += 'titleelement=' + titleelement + '&';
+         } else {
+ 	    url += 'titleelement=&';
+ 	}
          url += 'element=' + elementname + '';
          var title = 'Browser';
-         var options = 'scrollbars=1,resizable=1,menubar=0';
+         var options = 'scrollbars=1,resizable=1,menubar=1,location=1';
          options += ',width=700,height=600';
          editbrowser = open(url,title,options,'1');
          editbrowser.focus();
      }
      var editsearcher;
-     function opensearcher(formname,elementname) {
+     function opensearcher(formname,elementname,titleelement) {
          var url = '/adm/searchcat?';
          if (editsearcher == null) {
              url += 'launch=1&';
          }
          url += 'catalogmode=interactive&';
-         url += 'mode=edit&';
+         url += 'mode=$mode&';
          url += 'form=' + formname + '&';
+         if (titleelement != null) {
+             url += 'titleelement=' + titleelement + '&';
+         } else {
+ 	    url += 'titleelement=&';
+ 	}
          url += 'element=' + elementname + '';
          var title = 'Search';
          var options = 'scrollbars=1,resizable=1,menubar=0';
- Line 307  sub browser_and_searcher_javascript {
+ Line 309  sub browser_and_searcher_javascript {
          editsearcher = open(url,title,options,'1');
          editsearcher.focus();
      }
+ // END LON-CAPA Internal -->
  END
  }
+ sub lastresurl {
+     if ($env{'environment.lastresurl'}) {
+ 	return $env{'environment.lastresurl'}
+     } else {
+ 	return '/res';
+     }
+ }
+ sub storeresurl {
+     my $resurl=&Apache::lonnet::clutter(shift);
+     unless ($resurl=~/^\/res/) { return 0; }
+     $resurl=~s/\/$//;
+     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
+     &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
+     return 1;
+ }
  sub studentbrowser_javascript {
-    unless ($ENV{'request.course.id'}) { return ''; }
+    unless (
-    unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+             (($env{'request.course.id'}) &&
-         return '';
+              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
-    }
+ 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
+ 					  '/'.$env{'request.course.sec'})
+ 	      ))
+          || ($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;');
- Line 329  sub studentbrowser_javascript {
+ Line 353  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';
- Line 340  ENDSTDBRW
+ Line 365  ENDSTDBRW
  }
  sub selectstudent_link {
-     my ($form,$unameele,$udomele)=@_;
+    my ($form,$unameele,$udomele)=@_;
-    unless ($ENV{'request.course.id'}) { return ''; }
+    if ($env{'request.course.id'}) {
-    unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
-         return '';
+ 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
+ 					'/'.$env{'request.course.sec'})) {
+ 	   return '';
+        }
+        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
+         '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
     }
-     return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
+    if ($env{'request.role'}=~/^(au|dc|su)/) {
-         '","'.$udomele.'");'."'>Select User</a>";
+        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
+         '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
+    }
+    return '';
  }
  sub coursebrowser_javascript {
-    return (<<'ENDSTDBRW');
+     my ($domainfilter)=@_;
+    return (<<ENDSTDBRW);
  <script type="text/javascript" language="Javascript" >
      var stdeditbrowser;
-     function opencrsbrowser(formname,uname,udom) {
+     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag) {
          var url = '/adm/pickcourse?';
          var filter;
          if (filter != null) {
- Line 361  sub coursebrowser_javascript {
+ Line 395  sub coursebrowser_javascript {
                 url += 'filter='+filter+'&';
  	   }
          }
+         var domainfilter='$domainfilter';
+         if (domainfilter != null) {
+            if (domainfilter != '') {
+                url += 'domainfilter='+domainfilter+'&';
+ 	   }
+         }
          url += 'form=' + formname + '&cnumelement='+uname+
-                                     '&cdomelement='+udom;
+ 	                            '&cdomelement='+udom+
+                                     '&cnameelement='+desc;
+         if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
+             url += '&roleelement='+extra_element;
+             if (domainfilter == null || domainfilter == '') {
+                 url += '&domainfilter='+extra_element;
+             }
+         }
+         if (multflag !=null && multflag != '') {
+             url += '&multiple='+multflag;
+         }
          var title = 'Course_Browser';
          var options = 'scrollbars=1,resizable=1,menubar=0';
          options += ',width=700,height=600';
- Line 374  ENDSTDBRW
+ Line 424  ENDSTDBRW
  }
  sub selectcourse_link {
-    my ($form,$unameele,$udomele)=@_;
+    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag)=@_;
      return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
-         '","'.$udomele.'");'."'>Select Course</a>";
+         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'");'."'>".&mt('Select Course')."</a>";
+ }
+ sub check_uncheck_jscript {
+     my $jscript = <<"ENDSCRT";
+ function checkAll(field) {
+     if (field.length > 0) {
+         for (i = 0; i < field.length; i++) {
+             field[i].checked = true ;
+         }
+     } else {
+         field.checked = true
+     }
+ }
+ function uncheckAll(field) {
+     if (field.length > 0) {
+         for (i = 0; i < field.length; i++) {
+             field[i].checked = false ;
+         }     } else {
+         field.checked = false ;
+     }
+ }
+ ENDSCRT
+     return $jscript;
  }
- ###############################################################
  =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
- Line 395  linked_select_forms takes the following
+ Line 468  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
- Line 416  first menu value is given in $menu{$choi
+ Line 489  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" ,
+  my %menu = ( A1 => { text =>"Choice A1" ,
-                       default => "B3",
+                        default => "B3",
-                       select2 => {
+                        select2 => {
-                           B1 => "Choice B1",
+                            B1 => "Choice B1",
-                           B2 => "Choice B2",
+                            B2 => "Choice B2",
-                           B3 => "Choice B3",
+                            B3 => "Choice B3",
-                           B4 => "Choice B4"
+                            B4 => "Choice B4"
-                           }
+                            }
-                   },
+                    },
-               A2 => { text =>"Choice A2" ,
+                A2 => { text =>"Choice A2" ,
-                       default => "C2",
+                        default => "C2",
-                       select2 => {
+                        select2 => {
-                           C1 => "Choice C1",
+                            C1 => "Choice C1",
-                           C2 => "Choice C2",
+                            C2 => "Choice C2",
-                           C3 => "Choice C3"
+                            C3 => "Choice C3"
-                           }
+                            }
-                   },
+                    },
-               A3 => { text =>"Choice A3" ,
+                A3 => { text =>"Choice A3" ,
-                       default => "D6",
+                        default => "D6",
-                       select2 => {
+                        select2 => {
-                           D1 => "Choice D1",
+                            D1 => "Choice D1",
-                           D2 => "Choice D2",
+                            D2 => "Choice D2",
-                           D3 => "Choice D3",
+                            D3 => "Choice D3",
-                           D4 => "Choice D4",
+                            D4 => "Choice D4",
-                           D5 => "Choice D5",
+                            D5 => "Choice D5",
-                           D6 => "Choice D6",
+                            D6 => "Choice D6",
-                           D7 => "Choice D7"
+                            D7 => "Choice D7"
-                           }
+                            }
-                   }
+                    }
-               );
+                );
  =cut
- # ------------------------------------------------
  sub linked_select_forms {
      my ($formname,
          $middletext,
- Line 463  sub linked_select_forms {
+ Line 534  sub linked_select_forms {
      my $first = "document.$formname.$firstselectname";
      # output the javascript to do the changing
      my $result = '';
-     $result.="<script>\n";
+     $result.="<script type=\"text/javascript\">\n";
      $result.="var select2data = new Object();\n";
      $" = '","';
      my $debug = '';
- Line 499  function select1_changed() {
+ Line 570  function select1_changed() {
      // in with the nuclear
      for (i=0;i<values.length; i++) {
          $second.options[i] = new Option(values[i]);
+         $second.options[i].value = values[i];
          $second.options[i].text = texts[i];
          if (values[i] == select2def) {
              $second.options[i].selected = true;
- Line 511  END
+ Line 583  END
      $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
      foreach my $value (sort(keys(%$hashref))) {
          $result.="    <option value=\"$value\" ";
-         $result.=" selected=\"true\" " if ($value eq $firstdefault);
+         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
-         $result.=">$hashref->{$value}->{'text'}</option>\n";
+         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
      }
      $result .= "</select>\n";
      my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
- Line 521  END
+ Line 593  END
      my $seconddefault = $hashref->{$firstdefault}->{'default'};
      foreach my $value (sort(keys(%select2))) {
          $result.="    <option value=\"$value\" ";
-         $result.=" selected=\"true\" " if ($value eq $seconddefault);
+         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
-         $result.=">$select2{$value}</option>\n";
+         $result.=">".&mt($select2{$value})."</option>\n";
      }
      $result .= "</select>\n";
      #    return $debug;
      return $result;
  }   #  end of sub linked_select_forms {
- ###############################################################
  =pod
- =item help_open_topic($topic, $text, $stayOnPage, $width, $height)
+ =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.
+ Returns a string corresponding to an HTML link to the given help
+ $topic, where $topic corresponds to the name of a .tex file in
- $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.)
+ /home/httpd/html/adm/help/tex, with underscores replaced by
+ spaces.
- $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.
+ $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
- Line 549  sub help_open_topic {
+ Line 629  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' ) {
+ 	$env{'environment.remote'} eq 'off' ) {
  	$stayOnPage=1;
      }
      $width = 350 if (not defined $width);
- Line 561  sub help_open_topic {
+ Line 641  sub help_open_topic {
      my $template = "";
      my $link;
+     $topic=~s/\W/\_/g;
      if (!$stayOnPage)
      {
  	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
- Line 579  sub help_open_topic {
+ Line 661  sub help_open_topic {
      }
      # Add the graphic
+     my $title = &mt('Online Help');
+     my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
      $template .= <<"ENDTEMPLATE";
-  <a href="$link"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: $topic)" /></a>
+  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
  ENDTEMPLATE
      if ($text ne '') { $template.='</td></tr></table>' };
      return $template;
- Line 607  sub helpLatexCheatsheet {
+ Line 691  sub helpLatexCheatsheet {
  	.'</td></tr></table>';
  }
+ sub help_open_menu {
+     my ($color,$topic,$component_help,$function,$faq,$bug,$stayOnPage,$width,$height,$text) = @_;
+     $text = "" if (not defined $text);
+     $stayOnPage = 0 if (not defined $stayOnPage);
+     if ($env{'browser.interface'} eq 'textual' ||
+         $env{'environment.remote'} eq 'off' ) {
+         $stayOnPage=1;
+     }
+     $width = 620 if (not defined $width);
+     $height = 600 if (not defined $height);
+     my $link='';
+     my $title = &mt('Get help');
+     my $origurl = $ENV{'REQUEST_URI'};
+     $origurl=~s|^/~|/priv/|;
+     my $timestamp = time;
+     foreach (\$color,\$function,\$topic,\$component_help,\$faq,\$bug,\$origurl) {
+         $$_ = &Apache::lonnet::escape($$_);
+     }
+     if (!$stayOnPage) {
+          $link = "javascript:helpMenu('open')";
+     } else {
+         $link = "javascript:helpMenu('display')";
+     }
+     my $banner_link = "/adm/helpmenu?page=banner&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
+     my $details_link = "/adm/helpmenu?page=body&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp";
+     my $template;
+     if ($text ne "") {
+ 	$template .=
+   "<table bgcolor='#CC3300' cellspacing='1' cellpadding='1' border='0'><tr>".
+   "<td bgcolor='#CC6600'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
+     }
+     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
+     my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
+     my $start_page =
+         &Apache::loncommon::start_page('Help Menu', undef,
+ 				       {'frameset'    => 1,
+ 					'js_ready'    => 1,
+ 					'add_entries' => {
+ 					    'border' => '0',
+ 					    'rows'   => "105,*",},});
+     my $end_page =
+         &Apache::loncommon::end_page({'frameset' => 1,
+ 				      'js_ready' => 1,});
+     $template .= <<"ENDTEMPLATE";
+  <script type="text/javascript">
+ // <!-- BEGIN LON-CAPA Internal
+ // <![CDATA[
+ function helpMenu(target) {
+     var caller = this;
+     if (target == 'open') {
+         var newWindow = null;
+         try {
+             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
+         }
+         catch(error) {
+             writeHelp(caller);
+             return;
+         }
+         if (newWindow) {
+             caller = newWindow;
+         }
+     }
+     writeHelp(caller);
+     return;
+ }
+ function writeHelp(caller) {
+     caller.document.writeln('$start_page<frame name="bannerframe"  src="$banner_link" /><frame name="bodyframe" src="$details_link" /> $end_page')
+     caller.document.close()
+     caller.focus()
+ }
+ // ]]>
+ // END LON-CAPA Internal -->
+  </script>
+  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help Menu)" /></a>
+ ENDTEMPLATE
+     if ($component_help) {
+ 	if (!$text) {
+ 	    $template=&help_open_topic($component_help,undef,$stayOnPage,
+ 				       $width,$height).' '.$template;
+ 	} else {
+ 	    my $help_text;
+ 	    $help_text=&Apache::lonnet::unescape($topic);
+ 	    $template='<table><tr><td>'.
+ 		&help_open_topic($component_help,$help_text,$stayOnPage,
+ 				 $width,$height).'</td><td>'.$template.
+ 				 '</td></tr></table>';
+ 	}
+     }
+     if ($text ne '') { $template.='</td></tr></table>' };
+     return $template;
+ }
+ sub help_open_bug {
+     my ($topic, $text, $stayOnPage, $width, $height) = @_;
+     unless ($env{'user.adv'}) { return ''; }
+     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
+     $text = "" if (not defined $text);
+     $stayOnPage = 0 if (not defined $stayOnPage);
+     if ($env{'browser.interface'} eq 'textual' ||
+ 	$env{'environment.remote'} eq 'off' ) {
+ 	$stayOnPage=1;
+     }
+     $width = 600 if (not defined $width);
+     $height = 600 if (not defined $height);
+     $topic=~s/\W+/\+/g;
+     my $link='';
+     my $template='';
+     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
+ 	&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'&component='.$topic;
+     if (!$stayOnPage)
+     {
+ 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
+     }
+     else
+     {
+ 	$link = $url;
+     }
+     # Add the text
+     if ($text ne "")
+     {
+ 	$template .=
+   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
+   "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
+     }
+     # Add the graphic
+     my $title = &mt('Report a Bug');
+     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
+     $template .= <<"ENDTEMPLATE";
+  <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
+ ENDTEMPLATE
+     if ($text ne '') { $template.='</td></tr></table>' };
+     return $template;
+ }
+ sub help_open_faq {
+     my ($topic, $text, $stayOnPage, $width, $height) = @_;
+     unless ($env{'user.adv'}) { return ''; }
+     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
+     $text = "" if (not defined $text);
+     $stayOnPage = 0 if (not defined $stayOnPage);
+     if ($env{'browser.interface'} eq 'textual' ||
+ 	$env{'environment.remote'} eq 'off' ) {
+ 	$stayOnPage=1;
+     }
+     $width = 350 if (not defined $width);
+     $height = 400 if (not defined $height);
+     $topic=~s/\W+/\+/g;
+     my $link='';
+     my $template='';
+     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
+     if (!$stayOnPage)
+     {
+ 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
+     }
+     else
+     {
+ 	$link = $url;
+     }
+     # Add the text
+     if ($text ne "")
+     {
+ 	$template .=
+   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
+   "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
+     }
+     # Add the graphic
+     my $title = &mt('View the FAQ');
+     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
+     $template .= <<"ENDTEMPLATE";
+  <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
+ ENDTEMPLATE
+     if ($text ne '') { $template.='</td></tr></table>' };
+     return $template;
+ }
+ ###############################################################
+ ###############################################################
+ =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
+ =head1 Excel and CSV file utility routines
+ =over 4
+ =cut
+ ###############################################################
+ ###############################################################
  =pod
- =item csv_translate($text)
+ =item * csv_translate($text)
- Translate $text to allow it to be output as a 'comma seperated values'
+ Translate $text to allow it to be output as a 'comma separated values'
  format.
  =cut
+ ###############################################################
+ ###############################################################
  sub csv_translate {
      my $text = shift;
      $text =~ s/\"/\"\"/g;
-     $text =~ s/\n//g;
+     $text =~ s/\n/ /g;
      return $text;
  }
  ###############################################################
+ ###############################################################
+ =pod
+ =item * define_excel_formats
+ Define some commonly used Excel cell formats.
+ Currently supported formats:
+ =over 4
+ =item header
+ =item bold
+ =item h1
+ =item h2
+ =item h3
+ =item h4
+ =item i
+ =item date
+ =back
+ Inputs: $workbook
+ Returns: $format, a hash reference.
+ =cut
+ ###############################################################
+ ###############################################################
+ sub define_excel_formats {
+     my ($workbook) = @_;
+     my $format;
+     $format->{'header'} = $workbook->add_format(bold      => 1,
+                                                 bottom    => 1,
+                                                 align     => 'center');
+     $format->{'bold'} = $workbook->add_format(bold=>1);
+     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
+     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
+     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
+     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
+     $format->{'i'}    = $workbook->add_format(italic=>1);
+     $format->{'date'} = $workbook->add_format(num_format=>
+                                             'mm/dd/yyyy hh:mm:ss');
+     return $format;
+ }
+ ###############################################################
+ ###############################################################
+ =pod
+ =item * create_workbook
+ Create an Excel worksheet.  If it fails, output message on the
+ request object and return undefs.
+ Inputs: Apache request object
+ Returns (undef) on failure,
+     Excel worksheet object, scalar with filename, and formats
+     from &Apache::loncommon::define_excel_formats on success
+ =cut
+ ###############################################################
+ ###############################################################
+ sub create_workbook {
+     my ($r) = @_;
+         #
+     # Create the excel spreadsheet
+     my $filename = '/prtspool/'.
+         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
+         time.'_'.rand(1000000000).'.xls';
+     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
+     if (! defined($workbook)) {
+         $r->log_error("Error creating excel spreadsheet $filename: $!");
+         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
+                             "This error has been logged.  ".
+                             "Please alert your LON-CAPA administrator").
+                   '</p>');
+         return (undef);
+     }
+     #
+     $workbook->set_tempdir('/home/httpd/perl/tmp');
+     #
+     my $format = &Apache::loncommon::define_excel_formats($workbook);
+     return ($workbook,$filename,$format);
+ }
+ ###############################################################
+ ###############################################################
+ =pod
+ =item * create_text_file
+ Create a file to write to and eventually make available to the usre.
+ If file creation fails, outputs an error message on the request object and
+ return undefs.
+ Inputs: Apache request object, and file suffix
+ Returns (undef) on failure,
+     Filehandle and filename on success.
+ =cut
+ ###############################################################
+ ###############################################################
+ sub create_text_file {
+     my ($r,$suffix) = @_;
+     if (! defined($suffix)) { $suffix = 'txt'; };
+     my $fh;
+     my $filename = '/prtspool/'.
+         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
+         time.'_'.rand(1000000000).'.'.$suffix;
+     $fh = Apache::File->new('>/home/httpd'.$filename);
+     if (! defined($fh)) {
+         $r->log_error("Couldn't open $filename for output $!");
+         $r->print("Problems occured in creating the output file.  ".
+                   "This error has been logged.  ".
+                   "Please alert your LON-CAPA administrator.");
+     }
+     return ($fh,$filename)
+ }
+ =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.
- Line 643  sub get_domains {
+ Line 1153  sub get_domains {
      my @domains;
      my %seen;
      foreach (sort values(%Apache::lonnet::hostdom)) {
-         push (@domains,$_) unless $seen{$_}++;
+ 	push (@domains,$_) unless $seen{$_}++;
      }
      return @domains;
  }
+ # ------------------------------------------
+ sub domain_select {
+     my ($name,$value,$multiple)=@_;
+     my %domains=map {
+ 	$_ => $_.' '.$Apache::lonnet::domaindescription{$_}
+     } &get_domains;
+     if ($multiple) {
+ 	$domains{''}=&mt('Any domain');
+ 	return &multiple_select_form($name,$value,4,\%domains);
+     } else {
+ 	return &select_form($name,$value,%domains);
+     }
+ }
+ #-------------------------------------------
+ =pod
+ =item * multiple_select_form($name,$value,$size,$hash,$order)
+ Returns a string containing a <select> element int multiple mode
+ Args:
+   $name - name of the <select> element
+   $value - sclara or array ref of values that should already be selected
+   $size - number of rows long the select element is
+   $hash - the elements should be 'option' => 'shown text'
+           (shown text should already have been &mt())
+   $order - (optional) array ref of the order to show the elments in
+ =cut
+ #-------------------------------------------
+ sub multiple_select_form {
+     my ($name,$value,$size,$hash,$order)=@_;
+     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
+     my $output='';
+     if (! defined($size)) {
+         $size = 4;
+         if (scalar(keys(%$hash))<4) {
+             $size = scalar(keys(%$hash));
+         }
+     }
+     $output.="\n<select name='$name' size='$size' multiple='1'>";
+     my @order = ref($order) ? @$order
+                             : sort(keys(%$hash));
+     foreach my $key (@order) {
+         $output.='<option value="'.$key.'" ';
+         $output.='selected="selected" ' if ($selected{$key});
+         $output.='>'.$hash->{$key}."</option>\n";
+     }
+     $output.="</select>\n";
+     return $output;
+ }
  #-------------------------------------------
  =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.
- Line 664  See lonrights.pm for an example invocati
+ Line 1231  See lonrights.pm for an example invocati
  sub select_form {
      my ($def,$name,%hash) = @_;
      my $selectform = "<select name=\"$name\" size=\"1\">\n";
-     foreach (sort keys %hash) {
+     my @keys;
+     if (exists($hash{'select_form_order'})) {
+ 	@keys=@{$hash{'select_form_order'}};
+     } else {
+ 	@keys=sort(keys(%hash));
+     }
+     foreach (@keys) {
          $selectform.="<option value=\"$_\" ".
-             ($_ eq $def ? 'selected' : '').
+             ($_ eq $def ? 'selected="selected" ' : '').
-                 ">".$hash{$_}."</option>\n";
+                 ">".&mt($hash{$_})."</option>\n";
      }
      $selectform.="</select>";
      return $selectform;
  }
+ sub gradeleveldescription {
+     my $gradelevel=shift;
+     my %gradelevels=(0 => 'Not specified',
+=> 'Grade 1',
+=> 'Grade 2',
+=> 'Grade 3',
+=> 'Grade 4',
+=> 'Grade 5',
+=> 'Grade 6',
+=> 'Grade 7',
+=> 'Grade 8',
+=> 'Grade 9',
+=> 'Grade 10',
+=> 'Grade 11',
+=> 'Grade 12',
+=> 'Grade 13',
+=> '100 Level',
+=> '200 Level',
+=> '300 Level',
+=> '400 Level',
+=> 'Graduate Level');
+     return &mt($gradelevels{$gradelevel});
+ }
+ sub select_level_form {
+     my ($deflevel,$name)=@_;
+     unless ($deflevel) { $deflevel=0; }
+     my $selectform = "<select name=\"$name\" size=\"1\">\n";
+     for (my $i=0; $i<=18; $i++) {
+         $selectform.="<option value=\"$i\" ".
+             ($i==$deflevel ? 'selected="selected" ' : '').
+                 ">".&gradeleveldescription($i)."</option>\n";
+     }
+     $selectform.="</select>";
+     return $selectform;
+ }
  #-------------------------------------------
  =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.
- Line 697  sub select_dom_form {
+ Line 1306  sub select_dom_form {
      my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
      foreach (@domains) {
          $selectdomain.="<option value=\"$_\" ".
-             ($_ eq $defdom ? 'selected' : '').
+             ($_ eq $defdom ? 'selected="selected" ' : '').
                  ">$_</option>\n";
      }
      $selectdomain.="</select>";
- Line 708  sub select_dom_form {
+ Line 1317  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
- Line 732  sub get_library_servers {
+ Line 1341  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.
- Line 750  sub home_server_option_list {
+ Line 1359  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
- Line 767  Outputs:
+ Line 1384  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
+ =back
  =cut
  ###############################################################
  ###############################################################
  sub decode_user_agent {
+     my ($r)=@_;
      my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
      my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
      my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
+     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
      my $clientbrowser='unknown';
      my $clientversion='0';
      my $clientmathml='';
- Line 820  sub decode_user_agent {
+ Line 1441  sub decode_user_agent {
  }
  ###############################################################
- ###############################################################
- ###############################################################
  ##    Authentication changing form generation subroutines    ##
  ###############################################################
  ##
- Line 835  sub decode_user_agent {
+ Line 1452  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.
- Line 845  See loncreateuser.pm for invocation and
+ Line 1466  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
+ =back
  =cut
  #-------------------------------------------
- Line 886  END
+ Line 1509  END
          $Javascript_toUpperCase = "";
      }
+     my $radioval = "'nochange'";
+     if (exists($in{'curr_authtype'}) &&
+         defined($in{'curr_authtype'}) &&
+         $in{'curr_authtype'} ne '') {
+         $radioval = "'$in{'curr_authtype'}arg'";
+     }
+     my $argfield = 'null';
+     if ( grep/^mode$/,(keys %in) ) {
+         if ($in{'mode'} eq 'modifycourse')  {
+             if ( grep/^curr_authtype$/,(keys %in) ) {
+                 $radioval = "'$in{'curr_authtype'}'";
+             }
+             if ( grep/^curr_autharg$/,(keys %in) ) {
+                 unless ($in{'curr_autharg'} eq '') {
+                     $argfield = "'$in{'curr_autharg'}'";
+                 }
+             }
+         }
+     }
      $result.=<<"END";
  var current = new Object();
- current.radiovalue = 'nochange';
+ current.radiovalue = $radioval;
- current.argfield = null;
+ current.argfield = $argfield;
  function changed_radio(choice,currentform) {
      var choicearg = choice + 'arg';
- Line 949  END
+ Line 1592  END
  sub authform_authorwarning{
      my $result='';
-     $result=<<"END";
+     $result='<i>'.
- <i>As a general rule, only authors or co-authors should be filesystem
+         &mt('As a general rule, only authors or co-authors should be '.
- authenticated (which allows access to the server filesystem).</i>
+             'filesystem authenticated '.
- END
+             '(which allows access to the server filesystem).')."</i>\n";
      return $result;
  }
- Line 962  sub authform_nochange{
+ Line 1605  sub authform_nochange{
                kerb_def_dom => 'MSU.EDU',
                @_,
            );
-     my $result='';
+     my $result = '<label>'.&mt('[_1] Do not change login data',
-     $result.=<<"END";
+                      '<input type="radio" name="login" value="nochange" '.
- <input type="radio" name="login" value="nochange" checked="checked"
+                      'checked="checked" onclick="'.
-        onclick="javascript:changed_radio('nochange',$in{'formname'});" />
+             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
- Do not change login data
+ 	    '</label>';
- END
      return $result;
  }
- Line 978  sub authform_kerberos{
+ Line 1620  sub authform_kerberos{
                kerb_def_auth => 'krb4',
                @_,
                );
-     my $result='';
+     my ($check4,$check5,$krbarg);
-     my $check4;
-     my $check5;
      if ($in{'kerb_def_auth'} eq 'krb5') {
         $check5 = " checked=\"on\"";
      } else {
         $check4 = " checked=\"on\"";
      }
-     $result.=<<"END";
+     $krbarg = $in{'kerb_def_dom'};
- <input type="radio" name="login" value="krb"
-        onclick="javascript:changed_radio('krb',$in{'formname'});"
+     my $krbcheck = "";
-        onchange="javascript:changed_radio('krb',$in{'formname'});" />
+     if ( grep/^curr_authtype$/,(keys %in) ) {
- Kerberos authenticated with domain
+         if ($in{'curr_authtype'} =~ m/^krb/) {
- <input type="text" size="10" name="krbarg" value="$in{'kerb_def_dom'}"
+             $krbcheck = " checked=\"on\"";
-        onchange="javascript:changed_text('krb',$in{'formname'});" />
+             if ( grep/^curr_autharg$/,(keys %in) ) {
- <input type="radio" name="krbver" value="4" $check4 />Version 4
+                 $krbarg = $in{'curr_autharg'};
- <input type="radio" name="krbver" value="5" $check5 />Version 5
+             }
- END
+         }
+     }
+     my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
+     my $result .= &mt
+         ('[_1] Kerberos authenticated with domain [_2] '.
+          '[_3] Version 4 [_4] Version 5 [_5]',
+          '<label><input type="radio" name="login" value="krb" '.
+              'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
+          '</label><input type="text" size="10" name="krbarg" '.
+              'value="'.$krbarg.'" '.
+              'onchange="'.$jscall.'" />',
+          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
+          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
+ 	 '</label>');
      return $result;
  }
- Line 1005  sub authform_internal{
+ Line 1659  sub authform_internal{
                  kerb_def_dom => 'MSU.EDU',
                  @_,
                  );
-     my $result='';
-     $result.=<<"END";
+     my $intcheck = "";
- <input type="radio" name="login" value="int"
+     my $intarg = 'value=""';
-        onchange="javascript:changed_radio('int',$args{'formname'});"
+     if ( grep/^curr_authtype$/,(keys %args) ) {
-        onclick="javascript:changed_radio('int',$args{'formname'});" />
+         if ($args{'curr_authtype'} eq 'int') {
- Internally authenticated (with initial password
+             $intcheck = " checked=\"on\"";
- <input type="text" size="10" name="intarg" value=""
+             if ( grep/^curr_autharg$/,(keys %args) ) {
-        onchange="javascript:changed_text('int',$args{'formname'});" />)
+                 $intarg = "value=\"$args{'curr_autharg'}\"";
- END
+             }
+         }
+     }
+     my $jscall = "javascript:changed_radio('int',$args{'formname'});";
+     my $result.=&mt
+         ('[_1] Internally authenticated (with initial password [_2])',
+          '<label><input type="radio" name="login" value="int" '.$intcheck.
+              ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
+          '</label><input type="text" size="10" name="intarg" '.$intarg.
+              ' onchange="'.$jscall.'" />');
      return $result;
  }
- Line 1023  sub authform_local{
+ Line 1687  sub authform_local{
                kerb_def_dom => 'MSU.EDU',
                @_,
                );
-     my $result='';
-     $result.=<<"END";
+     my $loccheck = "";
- <input type="radio" name="login" value="loc"
+     my $locarg = 'value=""';
-        onchange="javascript:changed_radio('loc',$in{'formname'});"
+     if ( grep/^curr_authtype$/,(keys %in) ) {
-        onclick="javascript:changed_radio('loc',$in{'formname'});" />
+         if ($in{'curr_authtype'} eq 'loc') {
- Local Authentication with argument
+             $loccheck = " checked=\"on\"";
- <input type="text" size="10" name="locarg" value=""
+             if ( grep/^curr_autharg$/,(keys %in) ) {
-        onchange="javascript:changed_text('loc',$in{'formname'});" />
+                 $locarg = "value=\"$in{'curr_autharg'}\"";
- END
+             }
+         }
+     }
+     my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
+     my $result.=&mt('[_1] Local Authentication with argument [_2]',
+                     '<label><input type="radio" name="login" value="loc" '.$loccheck.
+                         ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
+                     '</label><input type="text" size="10" name="locarg" '.$locarg.
+                         ' onchange="'.$jscall.'" />');
      return $result;
  }
- Line 1041  sub authform_filesystem{
+ Line 1714  sub authform_filesystem{
                kerb_def_dom => 'MSU.EDU',
                @_,
                );
-     my $result='';
+     my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
-     $result.=<<"END";
+     my $result.= &mt
- <input type="radio" name="login" value="fsys"
+         ('[_1] Filesystem Authenticated (with initial password [_2])',
-        onchange="javascript:changed_radio('fsys',$in{'formname'});"
+          '<label><input type="radio" name="login" value="fsys" '.
-        onclick="javascript:changed_radio('fsys',$in{'formname'});" />
+          'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
- Filesystem authenticated (with initial password
+          '</label><input type="text" size="10" name="fsysarg" value="" '.
- <input type="text" size="10" name="fsysarg" value=""
+                   'onchange="'.$jscall.'" />');
-        onchange="javascript:changed_text('fsys',$in{'formname'});">)
- END
      return $result;
  }
  ###############################################################
- ##   End Authentication changing form generation functions   ##
- ###############################################################
- ###############################################################
  ##    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).
- Line 1078  These values are stored in lonTabs/domai
+ Line 1747  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
  #-------------------------------------------
- Line 1107  sub get_auth_defaults {
+ Line 1770  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
- Line 1115  version 4 and the domain of the server.
+ Line 1778  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
  #-------------------------------------------
- Line 1136  sub get_kerberos_defaults {
+ Line 1793  sub get_kerberos_defaults {
      }
      return ($krbdef,$krbdefdom);
  }
- ###############################################################
- ##   End Get Kerberos Defaults for Domain              ##
+ =pod
- ###############################################################
+ =back
+ =cut
  ###############################################################
  ##                Thesaurus Functions                        ##
- Line 1146  sub get_kerberos_defaults {
+ Line 1806  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.
- Line 1191  sub initialize_keywords {
+ Line 1855  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
- Line 1212  sub keyword {
+ Line 1876  sub keyword {
  =pod
- =item get_related_words
+ =item * get_related_words
- Look up a word in the thesaurus.  Takes a scalar arguement and returns
+ Look up a word in the thesaurus.  Takes a scalar argument and returns
  an array of words.  If the keyword is not in the thesaurus, an empty array
  will be returned.  The order of the words returned is determined by the
  database which holds them.
- Line 1249  sub get_related_words {
+ Line 1913  sub get_related_words {
      return @Words;
  }
- ###############################################################
+ =pod
- ##              End Thesaurus Functions                      ##
- ###############################################################
+ =back
+ =cut
  # -------------------------------------------------------------- Plaintext name
  =pod
- =item plainname($uname,$udom)
+ =head1 User Name Functions
- Gets a users name and returns it as a string in
+ =over 4
- "first middle last generation"
- form
+ =item * plainname($uname,$udom,$first)
+ Takes a users logon name and returns it as a string in
+ "first middle last generation" form
+ if $first is set to 'lastname' then it returns it as
+ 'lastname generation, firstname middlename' if their is a lastname
  =cut
  ###############################################################
  sub plainname {
-     my ($uname,$udom)=@_;
+     my ($uname,$udom,$first)=@_;
-     my %names=&Apache::lonnet::get('environment',
+     my %names=&getnames($uname,$udom);
-                     ['firstname','middlename','lastname','generation'],
+     my $name=&Apache::lonnet::format_name($names{'firstname'},
- 					 $udom,$uname);
+ 					  $names{'middlename'},
-     my $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
+ 					  $names{'lastname'},
- 	$names{'lastname'}.' '.$names{'generation'};
+ 					  $names{'generation'},$first);
+     $name=~s/^\s+//;
      $name=~s/\s+$//;
      $name=~s/\s+/ /g;
+     if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
      return $name;
  }
  # -------------------------------------------------------------------- Nickname
  =pod
- =item nickname($uname,$udom)
+ =item * nickname($uname,$udom)
  Gets a users name and returns it as a string as
- Line 1296  if the user does not
+ Line 1970  if the user does not
  sub nickname {
      my ($uname,$udom)=@_;
-     my %names=&Apache::lonnet::get('environment',
+     my %names=&getnames($uname,$udom);
-   ['nickname','firstname','middlename','lastname','generation'],$udom,$uname);
      my $name=$names{'nickname'};
      if ($name) {
         $name='&quot;'.$name.'&quot;';
- Line 1310  sub nickname {
+ Line 1983  sub nickname {
      return $name;
  }
+ sub getnames {
+     my ($uname,$udom)=@_;
+     my $id=$uname.':'.$udom;
+     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
+     if ($cached) {
+ 	return %{$names};
+     } else {
+ 	my %loadnames=&Apache::lonnet::get('environment',
+                     ['firstname','middlename','lastname','generation','nickname'],
+ 					 $udom,$uname);
+ 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
+ 	return %loadnames;
+     }
+ }
  # ------------------------------------------------------------------ Screenname
  =pod
- =item screenname($uname,$udom)
+ =item * screenname($uname,$udom)
  Gets a users screenname and returns it as a string
- Line 1323  Gets a users screenname and returns it a
+ Line 2010  Gets a users screenname and returns it a
  sub screenname {
      my ($uname,$udom)=@_;
-     my %names=
+     if ($uname eq $env{'user.name'} &&
-  &Apache::lonnet::get('environment',['screenname'],$udom,$uname);
+ 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
+     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
      return $names{'screenname'};
  }
  # ------------------------------------------------------------- Message Wrapper
  sub messagewrapper {
-     my ($link,$un,$do)=@_;
+     my ($link,$username,$domain)=@_;
      return
- "<a href='/adm/email?compose=individual&recname=$un&recdom=$do'>$link</a>";
+         '<a href="/adm/email?compose=individual&'.
+         'recname='.$username.'&recdom='.$domain.'" '.
+         'title="'.&mt('Send message').'">'.$link.'</a>';
  }
  # --------------------------------------------------------------- Notes Wrapper
- Line 1345  sub noteswrapper {
+ Line 2036  sub noteswrapper {
  # ------------------------------------------------------------- Aboutme Wrapper
  sub aboutmewrapper {
-     my ($link,$username,$domain)=@_;
+     my ($link,$username,$domain,$target)=@_;
-     return "<a href='/adm/$domain/$username/aboutme'>$link</a>";
+     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
+ 	($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
  }
  # ------------------------------------------------------------ Syllabus Wrapper
  sub syllabuswrapper {
-     my ($link,$un,$do,$tf)=@_;
+     my ($linktext,$coursedir,$domain,$fontcolor)=@_;
-     if ($tf) { $link='<font color="'.$tf.'">'.$link.'</font>'; }
+     if ($fontcolor) {
-     return "<a href='/public/$do/$un/syllabus'>$link</a>";
+         $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
+     }
+     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
  }
- # ---------------------------------------------------------------- Language IDs
+ sub track_student_link {
+     my ($linktext,$sname,$sdom,$target,$start) = @_;
+     my $link ="/adm/trackstudent?";
+     my $title = 'View recent activity';
+     if (defined($sname) && $sname !~ /^\s*$/ &&
+         defined($sdom)  && $sdom  !~ /^\s*$/) {
+         $link .= "selected_student=$sname:$sdom";
+         $title .= ' of this student';
+     }
+     if (defined($target) && $target !~ /^\s*$/) {
+         $target = qq{target="$target"};
+     } else {
+         $target = '';
+     }
+     if ($start) { $link.='&amp;start='.$start; }
+     return qq{<a href="$link" title="$title" $target>$linktext</a>};
+ }
+ =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(@_)};
+     my $code=shift;
+     return  ($supported_language{$code}?'* ':'').
+             $language{$code}.
+ 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
  }
- # ----------------------------------------------------------- Display Languages
+ sub plainlanguagedescription {
- # returns a hash with all desired display languages
+     my $code=shift;
- #
+     return $language{$code};
+ }
- sub display_languages {
+ sub supportedlanguagecode {
-     my %languages=();
+     my $code=shift;
-     if ($ENV{'environment.languages'}) {
+     return $supported_language{$code};
- 	foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'environment.languages'})) {
- 	    $languages{$_}=1;
-         }
-     }
-     if ($ENV{'course.'.$ENV{'request.course.id'}.'.languages'}) {
- 	foreach (split(/\s*(\,|\;|\:)\s*/,
- 	$ENV{'course.'.$ENV{'request.course.id'}.'.languages'})) {
- 	    $languages{$_}=1;
-         }
-     }
-     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
-     if ($ENV{'form.displaylanguage'}) {
- 	foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'form.displaylanguage'})) {
- 	    $languages{$_}=1;
-         }
-     }
-     return %languages;
  }
- # --------------------------------------------------------------- Copyright IDs
+ =pod
+ =item * copyrightids()
+ returns list of all copyrights
+ =cut
  sub copyrightids {
      return sort(keys(%cprtag));
  }
- # ------------------------------------------------------- Copyright Description
+ =pod
+ =item * copyrightdescription()
+ returns description of a specified copyright id
+ =cut
  sub copyrightdescription {
-     return $cprtag{shift(@_)};
+     return &mt($cprtag{shift(@_)});
  }
- # ------------------------------------------------------------- File Categories
+ =pod
+ =item * source_copyrightids()
+ returns list of all source copyrights
+ =cut
+ sub source_copyrightids {
+     return sort(keys(%scprtag));
+ }
+ =pod
+ =item * source_copyrightdescription()
+ returns description of a specified source copyright id
+ =cut
+ sub source_copyrightdescription {
+     return &mt($scprtag{shift(@_)});
+ }
+ =pod
+ =item * filecategories()
+ returns list of all file categories
+ =cut
  sub filecategories {
      return sort(keys(%category_extensions));
  }
- # -------------------------------------- File Types within a specified category
+ =pod
+ =item * filecategorytypes()
+ returns list of file types belonging to a given file
+ category
+ =cut
  sub filecategorytypes {
      return @{$category_extensions{lc($_[0])}};
  }
- # ------------------------------------------------------------------ File Types
+ =pod
- sub fileextensions {
-     return sort(keys(%fe));
+ =item * fileembstyle()
- }
+ returns embedding style for a specified file type
+ =cut
- # ------------------------------------------------------------- Embedding Style
  sub fileembstyle {
      return $fe{lc(shift(@_))};
  }
- # ------------------------------------------------------------ Description Text
+ sub filecategoryselect {
+     my ($name,$value)=@_;
+     return &select_form($value,$name,
+ 			'' => &mt('Any category'),
+ 			map { $_,$_ } sort(keys(%category_extensions)));
+ }
+ =pod
+ =item * filedescription()
+ returns description for a specified file type
+ =cut
  sub filedescription {
-     return $fd{lc(shift(@_))};
+     my $file_description = $fd{lc(shift())};
+     $file_description =~ s:([\[\]]):~$1:g;
+     return &mt($file_description);
  }
- # ------------------------------------------------------------ Description Text
+ =pod
+ =item * filedescriptionex()
+ returns description for a specified file type with
+ extra formatting
+ =cut
  sub filedescriptionex {
      my $ex=shift;
-     return '.'.$ex.' '.$fd{lc($ex)};
+     my $file_description = $fd{lc($ex)};
+     $file_description =~ s:([\[\]]):~$1:g;
+     return '.'.$ex.' '.&mt($file_description);
+ }
+ # End of .tab access
+ =pod
+ =back
+ =cut
+ # ------------------------------------------------------------------ File Types
+ sub fileextensions {
+     return sort(keys(%fe));
  }
- # ---- Retrieve attempts by students
+ # ----------------------------------------------------------- Display Languages
- # input
+ # returns a hash with all desired display languages
- # $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 display_languages {
+     my %languages=();
+     foreach (&preferred_languages()) {
+ 	$languages{$_}=1;
+     }
+     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
+     if ($env{'form.displaylanguage'}) {
+ 	foreach (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
+ 	    $languages{$_}=1;
+         }
+     }
+     return %languages;
+ }
+ sub preferred_languages {
+     my @languages=();
+     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
+ 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
+ 	         $env{'course.'.$env{'request.course.id'}.'.languages'}));
+     }
+     if ($env{'environment.languages'}) {
+ 	@languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});
+     }
+     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
+     if ($browser) {
+ 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
+     }
+     if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
+ 	@languages=(@languages,
+ 		$Apache::lonnet::domain_lang_def{$env{'user.domain'}});
+     }
+     if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
+ 	@languages=(@languages,
+ 		$Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
+     }
+     if ($Apache::lonnet::domain_lang_def{
+ 	                          $Apache::lonnet::perlvar{'lonDefDomain'}}) {
+ 	@languages=(@languages,
+ 		$Apache::lonnet::domain_lang_def{
+                                   $Apache::lonnet::perlvar{'lonDefDomain'}});
+     }
+ # turn "en-ca" into "en-ca,en"
+     my @genlanguages;
+     foreach (@languages) {
+ 	unless ($_=~/\w/) { next; }
+ 	push (@genlanguages,$_);
+ 	if ($_=~/(\-|\_)/) {
+ 	    push (@genlanguages,(split(/(\-|\_)/,$_))[0]);
+ 	}
+     }
+     return @genlanguages;
+ }
+ ###############################################################
+ ##               Student Answer Attempts                     ##
+ ###############################################################
+ =pod
+ =head1 Alternate Problem Views
+ =over 4
+ =item * get_previous_attempt($symb, $username, $domain, $course,
+     $getattempt, $regexp, $gradesub)
+ Return string with previous attempt on problem. Arguments:
+ =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
  sub get_previous_attempt {
    my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
    my $prevattempts='';
- Line 1488  sub get_previous_attempt {
+ Line 2385  sub get_previous_attempt {
  	       } else {
  		  $value=$returnhash{$version.':'.$_};
  	       }
- 	       $prevattempts.='<td>'.$value.'&nbsp;</td>';
+ 	       $prevattempts.='<td>'.&Apache::lonnet::unescape($value).'&nbsp;</td>';
  	    }
  	 }
        }
- Line 1500  sub get_previous_attempt {
+ Line 2397  sub get_previous_attempt {
  	} else {
  	  $value=$lasthash{$_};
  	}
+ 	$value=&Apache::lonnet::unescape($value);
  	if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
  	$prevattempts.='<td>'.$value.'&nbsp;</td>';
        }
- Line 1547  sub relative_to_absolute {
+ Line 2445  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 ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
-   my ($map,$id,$feedurl) = split(/___/,$symb);
+   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
-   my (%old,%moreenv);
+   my (%form);
    my @elements=('symb','courseid','domain','username');
    foreach my $element (@elements) {
-     $old{$element}=$ENV{'form.grade_'.$element};
+       $form{'grade_'.$element}=eval '$'.$element #'
-     $moreenv{'form.grade_'.$element}=eval '$'.$element #'
    }
-   if ($target eq 'tex') {$moreenv{'form.grade_target'} = 'tex';}
+   if (defined($moreenv)) {
-   &Apache::lonnet::appenv(%moreenv);
+       %form=(%form,%{$moreenv});
-   $feedurl=&Apache::lonnet::clutter($feedurl);
-   my $userview=&Apache::lonnet::ssi_body($feedurl);
-   &Apache::lonnet::delenv('form.grade_');
-   foreach my $element (@elements) {
-     $ENV{'form.grade_'.$element}=$old{$element};
    }
+   if (defined($target)) { $form{'grade_target'} = $target; }
+   $feedurl=&Apache::lonnet::clutter($feedurl);
+   my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
    $userview=~s/\<body[^\>]*\>//gi;
    $userview=~s/\<\/body\>//gi;
    $userview=~s/\<html\>//gi;
- Line 1575  sub get_student_view {
+ Line 2478  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 (%moreenv);
    my @elements=('symb','courseid','domain','username');
    foreach my $element (@elements) {
-     $old{$element}=$ENV{'form.grade_'.$element};
+     $moreenv{'grade_'.$element}=eval '$'.$element #'
-     $moreenv{'form.grade_'.$element}=eval '$'.$element #'
-   }
-   $moreenv{'form.grade_target'}='answer';
-   &Apache::lonnet::appenv(%moreenv);
-   my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%form);
-   &Apache::lonnet::delenv('form.grade_');
-   foreach my $element (@elements) {
-     $ENV{'form.grade_'.$element}=$old{$element};
    }
+   $moreenv{'grade_target'}='answer';
+   %moreenv=(%form,%moreenv);
+   my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
    return $userview;
  }
+ =pod
+ =item * &submlink()
+ Inputs: $text $uname $udom $symb $target
+ Returns: A link to grades.pm such as to see the SUBM view of a student
+ =cut
+ ###############################################
+ sub submlink {
+     my ($text,$uname,$udom,$symb,$target)=@_;
+     if (!($uname && $udom)) {
+ 	(my $cursymb, my $courseid,$udom,$uname)=
+ 	    &Apache::lonxml::whichuser($symb);
+ 	if (!$symb) { $symb=$cursymb; }
+     }
+     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
+     $symb=&Apache::lonnet::escape($symb);
+     if ($target) { $target="target=\"$target\""; }
+     return '<a href="/adm/grades?&command=submission&'.
+ 	'symb='.$symb.'&student='.$uname.
+ 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
+ }
+ ##############################################
+ =pod
+ =item * &pgrdlink()
+ Inputs: $text $uname $udom $symb $target
+ Returns: A link to grades.pm such as to see the PGRD view of a student
+ =cut
+ ###############################################
+ sub pgrdlink {
+     my $link=&submlink(@_);
+     $link=~s/(&command=submission)/$1&showgrading=yes/;
+     return $link;
+ }
+ ##############################################
+ =pod
+ =item * &pprmlink()
+ Inputs: $text $uname $udom $symb $target
+ Returns: A link to parmset.pm such as to see the PPRM view of a
+ student and a specific resource
+ =cut
+ ###############################################
+ sub pprmlink {
+     my ($text,$uname,$udom,$symb,$target)=@_;
+     if (!($uname && $udom)) {
+ 	(my $cursymb, my $courseid,$udom,$uname)=
+ 	    &Apache::lonxml::whichuser($symb);
+ 	if (!$symb) { $symb=$cursymb; }
+     }
+     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
+     $symb=&Apache::lonnet::escape($symb);
+     if ($target) { $target="target=\"$target\""; }
+     return '<a href="/adm/parmset?&command=set&'.
+ 	'symb='.$symb.'&uname='.$uname.
+ 	'&udom='.$udom.'" '.$target.'>'.$text.'</a>';
+ }
+ ##############################################
+ =pod
+ =back
+ =cut
  ###############################################
- Line 1614  sub maketime {
+ Line 2599  sub maketime {
      my %th=@_;
      return POSIX::mktime(
          ($th{'seconds'},$th{'minutes'},$th{'hours'},
-          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,$th{'dlsav'}));
+          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
- }
- #########################################
- #
- # Retro-fixing of un-backward-compatible time format
- sub unsqltime {
-     my $timestamp=shift;
-     if ($timestamp=~/^(\d+)\-(\d+)\-(\d+)\s+(\d+)\:(\d+)\:(\d+)$/) {
-        $timestamp=&maketime(
- 	   'year'=>$1,'month'=>$2,'day'=>$3,
-            'hours'=>$4,'minutes'=>$5,'seconds'=>$6);
-     }
-     return $timestamp;
  }
  #########################################
- Line 1637  sub unsqltime {
+ Line 2607  sub unsqltime {
  sub findallcourses {
      my %courses=();
      my $now=time;
-     foreach (keys %ENV) {
+     foreach (keys %env) {
  	if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
- 	    my ($starttime,$endtime)=$ENV{$_};
+ 	    my ($starttime,$endtime)=$env{$_};
              my $active=1;
              if ($starttime) {
  		if ($now<$starttime) { $active=0; }
- Line 1658  sub findallcourses {
+ Line 2628  sub findallcourses {
  =pod
- =item &determinedomain()
+ =head1 Domain Template Functions
+ =over 4
+ =item * &determinedomain()
  Inputs: $domain (usually will be undef)
- Line 1672  sub determinedomain {
+ Line 2646  sub determinedomain {
     if (! $domain) {
          # Determine domain if we have not been given one
          $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
-         if ($ENV{'user.domain'}) { $domain=$ENV{'user.domain'}; }
+         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
-         if ($ENV{'request.role.domain'}) {
+         if ($env{'request.role.domain'}) {
-             $domain=$ENV{'request.role.domain'};
+             $domain=$env{'request.role.domain'};
          }
      }
      return $domain;
- Line 1682  sub determinedomain {
+ Line 2656  sub determinedomain {
  ###############################################
  =pod
- =item &domainlogo()
+ =item * &domainlogo()
  Inputs: $domain (usually will be undef)
- Line 1690  Returns: A link to a domain logo, if the
+ Line 2664  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);
       # See if there is a logo
      if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
- 	my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
+ 	my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
- 	if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
+         return '<img src="'.$logo.'" alt="'.$domain.'" />';
-         return '<img src="http://'.$ENV{'HTTP_HOST'}.':'.$lonhttpdPort.
- 	    '/adm/lonDomLogos/'.$domain.'.gif" />';
      } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
          return $Apache::lonnet::domaindescription{$domain};
      } else {
- Line 1709  sub domainlogo {
+ Line 2682  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{'environment.color.'.$which}) {
+     if ($env{'browser.blackwhite'} eq 'on') {
- 	return $ENV{'environment.color.'.$which};
+ 	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};
      }
      $domain=&determinedomain($domain);
      if ($designhash{$domain.'.'.$which}) {
- Line 1735  sub designparm {
+ Line 2720  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.
+ =over 4
-  $function, the current role (can be undef).
-  $addentries, extra parameters for the <body> tag.
+ =item * $title, A title to be displayed on the page.
-  $bodyonly, if defined, only return the <body> tag.
-  $domain, if defined, force a given domain.
+ =item * $function, the current role (can be undef).
-  $forcereg, if page should register as content page (relevant for
+ =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)
+ =item * $customtitle, alternate text to use instead of $title
+                       in the title box that appears, this text
+                       is not auto translated like the $title is
+ =item * $notopbar, if true, keep the 'what is this' info but remove the
+                    navigational links
+ =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
+ =item * $notitle, if true keep the nav controls, but remove the title bar
+ =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
- Line 1756  other decorations will be returned.
+ Line 2768  other decorations will be returned.
  =cut
- ###############################################
+ sub bodytag {
+     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
+ 	$notopbar,$bgcolor,$notitle)=@_;
+     $title=&mt($title);
- ###############################################
+     $function = &get_users_function() if (!$function);
- sub bodytag {
+     my $img =    &designparm($function.'.img',$domain);
-     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg)=@_;
+     my $tabbg =  &designparm($function.'.tabbg',$domain);
-     unless ($function) {
+     my $font =   &designparm($function.'.font',$domain);
- 	$function='student';
+     my $sidebg = &designparm($function.'.sidebg',$domain);
-         if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {
+     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
- 	    $function='coordinator';
-         }
+     my %design = ( 'style'   => 'margin-top: 0px',
- 	if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) {
+ 		   'bgcolor' => $pgbg,
-             $function='admin';
+ 		   'text'    => $font,
-         }
+                    'alink'   => &designparm($function.'.alink',$domain),
-         if (($ENV{'request.role'}=~/^(au|ca)/) ||
+ 		   'vlink'   => &designparm($function.'.vlink',$domain),
-             ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
+ 		   'link'    => &designparm($function.'.link',$domain),);
-             $function='author';
+     @$addentries{keys(%design)} = @design{keys(%design)};
-         }
-     }
-     my $img=&designparm($function.'.img',$domain);
-     my $pgbg=&designparm($function.'.pgbg',$domain);
-     my $tabbg=&designparm($function.'.tabbg',$domain);
-     my $font=&designparm($function.'.font',$domain);
-     my $link=&designparm($function.'.link',$domain);
-     my $alink=&designparm($function.'.alink',$domain);
-     my $vlink=&designparm($function.'.vlink',$domain);
-     my $sidebg=&designparm($function.'.sidebg',$domain);
   # role and realm
      my ($role,$realm)
-        =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]);
+        =&Apache::lonnet::plaintext((split(/\./,$env{'request.role'}))[0]);
  # realm
-     if ($ENV{'request.course.id'}) {
+     if ($env{'request.course.id'}) {
  	$realm=
-          $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
+          $env{'course.'.$env{'request.course.id'}.'.description'};
      }
      unless ($realm) { $realm='&nbsp;'; }
  # Set messages
- Line 1798  sub bodytag {
+ Line 2803  sub bodytag {
  # Port for miniserver
      my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
      if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
+     my $extra_body_attr = &make_attr_string($forcereg,$addentries);
  # construct main body tag
      my $bodytag = <<END;
- <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
+ <body $extra_body_attr>
- $addentries>
  END
+     $bodytag .= &Apache::lontexconvert::init_math_support();
      my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
-                    $lonhttpdPort.$img.'" />';
+                    $lonhttpdPort.$img.'" alt="'.$function.'" />';
-     if ($bodyonly) {
+     if ($bodyonly
+ 	|| ($env{'request.state'} eq 'construct'
+ 	    && $env{'environment.remote'} ne 'off' )) {
          return $bodytag;
-     } elsif ($ENV{'browser.interface'} eq 'textual') {
+     } elsif ($env{'browser.interface'} eq 'textual') {
  # Accessibility
-         return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
-                                                       $forcereg).
+ 	$bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
-                '<h1>LON-CAPA: '.$title.'</h1>';
+ 	if (!$notitle) {
-     } elsif ($ENV{'environment.remote'} eq 'off') {
+ 	    $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
+ 	}
+ 	return $bodytag;
+     } elsif ($env{'environment.remote'} eq 'off') {
  # No Remote
-         return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
+ 	my $roleinfo=(<<ENDROLE);
-                                                       $forcereg).
+ <td bgcolor="$tabbg" align="right">
-                '<table bgcolor="'.$pgbg.'" width="100%" border="0" cellspacing="3" cellpadding="3"><tr><td bgcolor="'.$tabbg.'"><font size="+3" color="'.$font.'"><b>'.$title.
+ <font size="2" face="Arial, Helvetica, sans-serif">
- '</b></font></td></tr></table>';
+     $env{'environment.firstname'}
+     $env{'environment.middlename'}
+     $env{'environment.lastname'}
+     $env{'environment.generation'}
+     </font>&nbsp;
+ <br />
+ <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;
+ <br />
+ <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;
+ </td>
+ ENDROLE
+         my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.
+ 		$font.'"><b>'.$title.'</b></font>';
+         if ($customtitle) {
+             $titleinfo = $customtitle;
+         }
+ 	if ($env{'request.state'} eq 'construct') {
+ 	    my ($uname,$thisdisfn)=
+ 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
+ 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
+ 	    $formaction=~s/\/+/\//g;
+             unless ($customtitle) {  #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm
+                 my $parentpath = '';
+                 my $lastitem = '';
+                 if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
+                     $parentpath = $1;
+                     $lastitem = $2;
+                 } else {
+                     $lastitem = $thisdisfn;
+                 }
+ 	        $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
+                       '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font>&nbsp;'.
+                       '<form name="dirs" method="post" action="'.$formaction
+ 		    .'" target="_top"><tt><b>'
+ 		    .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
+ 		    .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
+ 		    .'</form>'
+ 		    .&Apache::lonmenu::constspaceform();
+             }
+ 	    $forcereg=1;
+         }
+         my $titletable;
+ 	if (!$notitle) {
+ 	    $titletable =
+ 		'<table bgcolor="'.$pgbg.'" width="100%" border="0" '.
+                          'cellspacing="3" cellpadding="3">'.
+                          '<tr><td bgcolor="'.$tabbg.'">'.
+                          $titleinfo.'</td>'.$roleinfo.'</tr></table>';
+ 	}
+ 	if ($env{'request.state'} eq 'construct') {
+             if ($notopbar) {
+                 $bodytag .= $titletable;
+             } else {
+                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
+ 							  $titletable);
+             }
+ 	} else {
+             if ($notopbar) {
+                 $bodytag .= $titletable;
+             } else {
+                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
+                         $titletable;
+             }
+         }
+         return $bodytag;
      }
  #
  # Top frame rendering, Remote is up
  #
+     my $titleinfo = '&nbsp;<font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';
+     if ($customtitle) {
+         $titleinfo = $customtitle;
+     }
+     #
+     # Extra info if you are the DC
+     my $dc_info = '';
+     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
+                         $env{'course.'.$env{'request.course.id'}.
+                                  '.domain'}.'/'})) {
+         my $cid = $env{'request.course.id'};
+         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
+         $dc_info = '('.$dc_info.')';
+     }
+     # Explicit link to get inline menu
+     my $menu='<br /><font size="2" face="Arial, Helvetica, sans-serif">&nbsp;<a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a></font>';
+     #
+     if ($notitle) {
+ 	return $bodytag;
+     }
      return(<<ENDBODY);
  $bodytag
  <table width="100%" cellspacing="0" border="0" cellpadding="0">
- Line 1832  $upperleft</td>
+ Line 2933  $upperleft</td>
  </tr>
  <tr>
  <td rowspan="3" bgcolor="$tabbg">
- &nbsp;<font size="5"><b>$title</b></font>
+ $titleinfo $dc_info $menu
- <td bgcolor="$tabbg"  align="right">
+ </td><td bgcolor="$tabbg" align="right">
- <font size="2">
+ <font size="2" face="Arial, Helvetica, sans-serif">
-     $ENV{'environment.firstname'}
+     $env{'environment.firstname'}
-     $ENV{'environment.middlename'}
+     $env{'environment.middlename'}
-     $ENV{'environment.lastname'}
+     $env{'environment.lastname'}
-     $ENV{'environment.generation'}
+     $env{'environment.generation'}
      </font>&nbsp;
  </td>
  </tr>
  <tr><td bgcolor="$tabbg" align="right">
- <font size="2">$role</font>&nbsp;
+ <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;
  </td></tr>
  <tr>
- <td bgcolor="$tabbg" align="right"><font size="2">$realm</font>&nbsp;</td></tr>
+ <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;</td></tr>
- </table><br>
+ </table><br />
  ENDBODY
  }
+ sub make_attr_string {
+     my ($register,$attr_ref) = @_;
+     if ($attr_ref && !ref($attr_ref)) {
+ 	die("addentries Must be a hash ref ".
+ 	    join(':',caller(1))." ".
+ 	    join(':',caller(0))." ");
+     }
+     if ($register) {
+ 	my ($on_load,$on_unload);
+ 	foreach my $key (keys(%{$attr_ref})) {
+ 	    if      (lc($key) eq 'onload') {
+ 		$on_load.=$attr_ref->{$key}.';';
+ 		delete($attr_ref->{$key});
+ 	    } elsif (lc($key) eq 'onunload') {
+ 		$on_unload.=$attr_ref->{$key}.';';
+ 		delete($attr_ref->{$key});
+ 	    }
+ 	}
+ 	$attr_ref->{'onload'}  =
+ 	    &Apache::lonmenu::loadevents().  $on_load;
+ 	$attr_ref->{'onunload'}=
+ 	    &Apache::lonmenu::unloadevents().$on_unload;
+     }
+ # Accessibility font enhance
+     if ($env{'browser.fontenhance'} eq 'on') {
+ 	my $style;
+ 	foreach my $key (keys(%{$attr_ref})) {
+ 	    if (lc($key) eq 'style') {
+ 		$style.=$attr_ref->{$key}.';';
+ 		delete($attr_ref->{$key});
+ 	    }
+ 	}
+ 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
+     }
+     if ($env{'browser.blackwhite'} eq 'on') {
+ 	delete($attr_ref->{'font'});
+ 	delete($attr_ref->{'link'});
+ 	delete($attr_ref->{'alink'});
+ 	delete($attr_ref->{'vlink'});
+ 	delete($attr_ref->{'bgcolor'});
+ 	delete($attr_ref->{'background'});
+     }
+     my $attr_string;
+     foreach my $attr (keys(%$attr_ref)) {
+ 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
+     }
+     return $attr_string;
+ }
+ ###############################################
  ###############################################
- sub get_posted_cgi {
+ =pod
-     my $r=shift;
+ =back
+ =head1 HTML Helpers
+ =over 4
+ =item * &endbodytag()
+ Returns a uniform footer for LON-CAPA web pages.
+ Inputs: none
+ =back
+ =cut
+ sub endbodytag {
+     my $endbodytag='</body>';
+     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
+     if ( exists( $env{'internal.head.redirect'} ) ) {
+ 	$endbodytag=
+ 	    "<br /><a href=\"$env{'internal.head.redirect'}\">".
+ 	    &mt('Continue').'</a>'.
+ 	    $endbodytag;
+     }
+     return $endbodytag;
+ }
-     my $buffer;
+ sub standard_css {
+     return <<END;
+ <style type="text/css">
+ h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
+ a:focus { color: red; background: yellow }
+ table.thinborder { border-collapse: collapse; }
+ table.thinborder tr th, table.thinborder tr td { border-style: solid; border-width: 1px}
+ form, .inline { display: inline; }
+ .center { text-align: center; }
+ .filename {font-family: monospace;}
+ </style>
+ END
+ }
+ =pod
+ =over 4
+ =item * &headtag()
+ Returns a uniform footer for LON-CAPA web pages.
+ Inputs: $title - optional title for the head
+         $head_extra - optional extra HTML to put inside the <head>
+         $args - optional arguments
+             force_register - if is true call registerurl so the remote is
+                              informed
+             redirect - array ref of seconds before redirect occurs
+                                     url to redirect to
+                            (side effect of setting
+                                $env{'internal.head.redirect'} to the url
+                                redirected too)
+ =back
+ =cut
+ sub headtag {
+     my ($title,$head_extra,$args) = @_;
-     $r->read($buffer,$r->header_in('Content-length'),0);
+     my $result =
-     unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
+ 	'<head>'.
- 	my @pairs=split(/&/,$buffer);
+ 	&standard_css().
- 	my $pair;
+ 	&font_settings().
- 	foreach $pair (@pairs) {
+ 	&Apache::lonhtmlcommon::htmlareaheaders();
- 	    my ($name,$value) = split(/=/,$pair);
- 	    $value =~ tr/+/ /;
+     if ($args->{'force_register'}) {
- 	    $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
+ 	$result .= &Apache::lonmenu::registerurl(1);
- 	    $name  =~ tr/+/ /;
+     }
- 	    $name  =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
- 	    &add_to_env("form.$name",$value);
+     if (ref($args->{'redirect'})) {
- 	}
+ 	my ($time,$url) = @{$args->{'redirect'}};
-     } else {
+ 	$url = &Apache::lonenc::check_encrypt($url);
- 	my $contentsep=$1;
+ 	$env{'internal.head.redirect'} = $url;
- 	my @lines = split (/\n/,$buffer);
+ 	$result.=<<ADDMETA
- 	my $name='';
+ <meta http-equiv="pragma" content="no-cache" />
- 	my $value='';
+ <meta http-equiv="Refresh" content="$time; url=$url" />
- 	my $fname='';
+ ADDMETA
- 	my $fmime='';
+     }
- 	my $i;
+     if (!defined($title)) {
- 	for ($i=0;$i<=$#lines;$i++) {
+ 	$title = 'The LearningOnline Network with CAPA';
- 	    if ($lines[$i]=~/^$contentsep/) {
+     }
- 		if ($name) {
- 		    chomp($value);
+     $result .= '<title> LON-CAPA '.&mt($title).'</title>'.$head_extra;
- 		    if ($fname) {
+     return $result;
- 			$ENV{"form.$name.filename"}=$fname;
+ }
- 			$ENV{"form.$name.mimetype"}=$fmime;
- 		    } else {
+ =pod
- 			$value=~s/\s+$//s;
- 		    }
+ =over 4
- 		    &add_to_env("form.$name",$value);
- 		}
+ =item * &font_settings()
- 		if ($i<$#lines) {
- 		    $i++;
+ Returns neccessary <meta> to set the proper encoding
- 		    $lines[$i]=~
- 		/Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
+ Inputs: none
- 		    $name=$1;
- 		    $value='';
+ =back
- 		    if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
- 			$fname=$1;
+ =cut
- 			if
-                             ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
+ sub font_settings {
- 				$fmime=$1;
+     my $headerstring='';
- 				$i++;
+     if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
- 			    } else {
+ 	$headerstring.=
- 				$fmime='';
+ 	    '<meta Content-Type="text/html; charset=x-mac-roman" />';
- 			    }
+     } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
- 		    } else {
+ 	$headerstring.=
- 			$fname='';
+ 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
- 			$fmime='';
+     }
- 		    }
+     return $headerstring;
- 		    $i++;
+ }
- 		}
- 	    } else {
+ =pod
- 		$value.=$lines[$i]."\n";
+ =over 4
+ =item * &xml_begin()
+ Returns the needed doctype and <html>
+ Inputs: none
+ =back
+ =cut
+ sub xml_begin {
+     my $output='';
+     &Apache::lonhtmlcommon::init_htmlareafields();
+     if ($env{'browser.mathml'}) {
+ 	$output='<?xml version="1.0"?>'
+             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
+ #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
+ #	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
+ 	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
+             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
+ 	    .'xmlns="http://www.w3.org/1999/xhtml">';
+     } else {
+ 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
+     }
+     return $output;
+ }
+ =pod
+ =over 4
+ =item * &endheadtag()
+ Returns a uniform </head> for LON-CAPA web pages.
+ Inputs: none
+ =back
+ =cut
+ sub endheadtag {
+     return '</head>';
+ }
+ =pod
+ =over 4
+ =item * &head()
+ Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
+ Inputs: $title - optional title for the page
+         $head_extra - optional extra HTML to put inside the <head>
+ =back
+ =cut
+ sub head {
+     my ($title,$head_extra,$args) = @_;
+     return &headtag($title,$head_extra,$args).&endheadtag();
+ }
+ =pod
+ =over 4
+ =item * &start_page()
+ Returns a complete <html> .. <body> section for LON-CAPA web pages.
+ Inputs: $title - optional title for the page
+         $head_extra - optional extra HTML to incude inside the <head>
+         $args - additional optional args supported are:
+                   only_body      -> is true will set &bodytag() onlybodytag
+                                     arg on
+                   no_nav_bar     -> is true will set &bodytag() notopbar arg on
+                   add_entries    -> additional attributes to add to the  <body>
+                   domain         -> force to color decorate a page for a
+                                     specific domain
+                   function       -> force usage of a specific rolish color
+                                     scheme
+                   redirect       -> see &headtag()
+                   bgcolor        -> override the default page bg color
+                   js_ready       -> return a string ready for being used in
+                                     a javascript writeln
+                   html_encode    -> return a string ready for being used in
+                                     a html attribute
+                   force_register -> if is true will turn on the &bodytag()
+                                     $forcereg arg
+                   body_title     -> alternate text to use instead of $title
+                                     in the title box that appears, this text
+                                     is not auto translated like the $title is
+                   frameset       -> if true will start with a <frameset>
+                                     rather than <body>
+                   no_title       -> if true the title bar won't be shown
+                   skip_phases    -> hash ref of
+                                     head -> skip the <html><head> generation
+                                     body -> skip all <body> generation
+ =back
+ =cut
+ sub start_page {
+     my ($title,$head_extra,$args) = @_;
+     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
+     my %head_args;
+     foreach my $arg ('redirect','force_register') {
+ 	if (defined($args->{$arg})) {
+ 	    $head_args{$arg} = $args->{$arg};
+ 	}
+     }
+     $env{'internal.start_page'}++;
+     my $result;
+     if (! exists($args->{'skip_phases'}{'head'}) ) {
+ 	$result.=
+ 	    &xml_begin().
+ 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
+     }
+     if (! exists($args->{'skip_phases'}{'body'}) ) {
+ 	if ($args->{'frameset'}) {
+ 	    my $attr_string = &make_attr_string($args->{'force_register'},
+ 						$args->{'add_entries'});
+ 	    $result .= "\n<frameset $attr_string>\n";
+ 	} else {
+ 	    $result .=
+ 		&bodytag($title,
+ 			 $args->{'function'},       $args->{'add_entries'},
+ 			 $args->{'only_body'},      $args->{'domain'},
+ 			 $args->{'force_register'}, $args->{'body_title'},
+ 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
+ 			 $args->{'no_title'});
+ 	}
+     }
+     if ($args->{'js_ready'}) {
+ 	$result = &js_ready($result);
+     }
+     if ($args->{'html_encode'}) {
+ 	$result = &html_encode($result);
+     }
+     return $result;
+ }
+ =pod
+ =over 4
+ =item * &head()
+ Returns a complete </body></html> section for LON-CAPA web pages.
+ Inputs:         $args - additional optional args supported are:
+                  js_ready     -> return a string ready for being used in
+                                  a javascript writeln
+                  html_encode  -> return a string ready for being used in
+                                  a html attribute
+                  frameset     -> if true will start with a <frameset>
+                                  rather than <body>
+ =back
+ =cut
+ sub end_page {
+     my ($args) = @_;
+     #&Apache::lonnet::logthis("end_page ".join(':',caller(0)));
+     $env{'internal.end_page'}++;
+     my $result;
+     if ($args->{'discussion'}) {
+ 	my ($target,$parser);
+ 	if (ref($args->{'discussion'})) {
+ 	    ($target,$parser) =($args->{'discussion'}{'target'},
+ 				$args->{'discussion'}{'parser'});
+ 	}
+ 	$result .= &Apache::lonxml::xmlend($target,$parser);
+     }
+     if ($args->{'frameset'}) {
+ 	$result .= '</frameset>';
+     } else {
+ 	$result .= &endbodytag();
+     }
+     $result .= "\n</html>";
+     if ($args->{'js_ready'}) {
+ 	$result = &js_ready($result);
+     }
+     if ($args->{'html_encode'}) {
+ 	$result = &html_encode($result);
+     }
+     return $result;
+ }
+ sub html_encode {
+     my ($result) = @_;
+     $result = &HTML::Entities::encode($result,'<>&"');
+     return $result;
+ }
+ sub js_ready {
+     my ($result) = @_;
+     $result =~ s/[\n\r]/ /xmsg;
+     $result =~ s/\\/\\\\/xmsg;
+     $result =~ s/'/\\'/xmsg;
+     $result =~ s{</script>}{</scrip'+'t>}xmsg;
+     return $result;
+ }
+ sub validate_page {
+     if (  exists($env{'internal.start_page'})
+ 	  &&     $env{'internal.start_page'} > 1) {
+ 	&Apache::lonnet::logthis('start_page called multiple times '.
+ 				 $env{'internal.start_page'}.' '.
+ 				 $ENV{'request.filename'});
+     }
+     if (  exists($env{'internal.end_page'})
+ 	  &&     $env{'internal.end_page'} > 1) {
+ 	&Apache::lonnet::logthis('end_page called multiple times '.
+ 				 $env{'internal.end_page'}.' '.
+ 				 $env{'request.filename'});
+     }
+     if (     exists($env{'internal.start_page'})
+ 	&& ! exists($env{'internal.end_page'})) {
+ 	&Apache::lonnet::logthis('start_page called without end_page '.
+ 				 $env{'request.filename'});
+     }
+     if (   ! exists($env{'internal.start_page'})
+ 	&&   exists($env{'internal.end_page'})) {
+ 	&Apache::lonnet::logthis('end_page called without start_page'.
+ 				 $env{'request.filename'});
+     }
+ }
+ sub simple_error_page {
+     my ($r,$title,$msg) = @_;
+     my $page =
+ 	&Apache::loncommon::start_page($title).
+ 	&mt($msg).
+ 	&Apache::loncommon::end_page();
+     if (ref($r)) {
+ 	$r->print($page);
+ 	return;
+     }
+     return $page;
+ }
+ ###############################################
+ =pod
+ =over 4
+ =item get_users_function
+ Used by &bodytag to determine the current users primary role.
+ Returns either 'student','coordinator','admin', or 'author'.
+ =cut
+ ###############################################
+ sub get_users_function {
+     my $function = 'student';
+     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
+         $function='coordinator';
+     }
+     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
+         $function='admin';
+     }
+     if (($env{'request.role'}=~/^(au|ca)/) ||
+         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
+         $function='author';
+     }
+     return $function;
+ }
+ ###############################################
+ =pod
+ =item check_user_status
+ Determines current status of supplied role for a
+ specific user. Roles can be active, previous or future.
+ Inputs:
+ user's domain, user's username, course's domain,
+ course's number, optional section/group.
+ Outputs:
+ role status: active, previous or future.
+ =cut
+ sub check_user_status {
+     my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_;
+     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
+     my @uroles = keys %userinfo;
+     my $srchstr;
+     my $active_chk = 'none';
+     if (@uroles > 0) {
+         if (($role eq 'cc') || ($secgrp eq '') || (!defined($secgrp))) {
+             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
+         } else {
+             $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role;         }
+         if (grep/^$srchstr$/,@uroles) {
+             my $role_end = 0;
+             my $role_start = 0;
+             $active_chk = 'active';
+             if ($userinfo{$srchstr} =~ m/^($role)_(\d+)/) {
+                 $role_end = $2;
+                 if ($userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/) {
+                     $role_start = $3;
+                 }
+             }
+             if ($role_start > 0) {
+                 if (time < $role_start) {
+                     $active_chk = 'future';
+                 }
+             }
+             if ($role_end > 0) {
+                 if (time > $role_end) {
+                     $active_chk = 'previous';
+                 }
+             }
+         }
+     }
+     return $active_chk;
+ }
+ ###############################################
+ =pod
+ =item get_sections
+ Determines all the sections for a course including
+ sections with students and sections containing other roles.
+ Incoming parameters: domain, course number, reference to
+ section hash (keys to be section/group IDs), reference to
+ array containing roles for which sections should be gathered
+ (optional). If the fourth argument is undefined, sections
+ are gathered for any role.
+ Returns number of sections.
+ =cut
+ ###############################################
+ sub get_sections {
+     my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;
+     if (!($cdom && $cnum)) { return 0; }
+     my $numsections = 0;
+     if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
+ 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
+ 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
+ 	my $status_index = &Apache::loncoursedata::CL_STATUS();
+ 	while (my ($student,$data) = each %$classlist) {
+ 	    my ($section,$status) = ($data->[$sec_index],
+ 				     $data->[$status_index]);
+ 	    unless ($section eq '-1' || $section =~ /^\s*$/) {
+ 		if (!defined($$sectioncount{$section})) { $numsections++; }
+ 		$$sectioncount{$section}++;
  	    }
  	}
      }
-     $ENV{'request.method'}=$ENV{'REQUEST_METHOD'};
+     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
-     $r->method_number(M_GET);
+     foreach my $user (sort(keys(%courseroles))) {
-     $r->method('GET');
+ 	if ($user !~ /^(\w{2})/) { next; }
-     $r->headers_in->unset('Content-length');
+ 	my ($role) = ($user =~ /^(\w{2})/);
+ 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
+ 	my $section;
+ 	if ($role eq 'cr' &&
+ 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
+ 	    $section=$1;
+ 	}
+ 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
+ 	if (!defined($section) || $section eq '-1') { next; }
+ 	if (!defined($$sectioncount{$section})) { $numsections++; }
+ 	$$sectioncount{$section}++;
+     }
+     return $numsections;
+ }
+ ###############################################
+ =pod
+ =item coursegroups
+ Retrieve information about groups in a course,
+ Input:
+. Reference to hash to populate with group information.
+. Optional course domain
+. Optional course number
+. Optional group name
+ Course domain and number will be taken from user's
+ environment if not supplied. Optional group name will'
+ be passed to lonnet::get_coursegroups() as a regexp to
+ use in the call to the dump function.
+ Output
+ Returns number of groups in the course (subject to the
+ optional group name filter).
+ Side effects:
+ Populates the referenced curr_groups hash, with key,
+ value pairs. Keys are group names, corresponding values
+ are scalars containing group information in XML. This
+ can be sent to &get_group_settings() to be parsed.
+ =cut
+ ###############################################
+ sub coursegroups {
+     my ($curr_groups,$cdom,$cnum,$group) = @_;
+     my $numgroups;
+     if (!defined($cdom) || !defined($cnum)) {
+         my $cid =  $env{'request.course.id'};
+         $cdom = $env{'course.'.$cid.'.domain'};
+         $cnum = $env{'course.'.$cid.'.num'};
+     }
+     %{$curr_groups} = &Apache::lonnet::get_coursegroups($cdom,$cnum,$group);
+     my ($tmp) = keys(%{$curr_groups});
+     if ($tmp=~/^error:/) {
+         unless ($tmp eq 'error: 2 tie(GDBM) Failed while attempting dump') {
+             &logthis('Error retrieving groups: '.$tmp.' in '.$cnum.':'.
+                                                                    $cdom);
+         }
+         $numgroups = 0;
+     } else {
+         $numgroups = keys(%{$curr_groups});
+     }
+     return $numgroups;
+ }
+ ###############################################
+ =pod
+ =item get_group_settings
+ Uses TokeParser to extract group information from the
+ XML used to describe course groups.
+ Input:
+ Scalar containing XML  - as retrieved from &coursegroups().
+ Output:
+ Hash containing group information as key=values for (a), and
+ hash of hashes for (b)
+ Keys (in two categories):
+ (a) groupname, creator, creation, modified, startdate,enddate.
+ Corresponding values are name of the group, creator of the group
+ (username:domain), UNIX time for date group was created, and
+ settings were last modified, and default start and end access
+ times for group members.
+ (b) functions returned in hash of hashes.
+ Outer hash key is functions.
+ Inner hash keys are chat,discussion,email,files,homepage,roster.
+ Corresponding values are either on or off, depending on
+ whether this type of functionality is available for the group.
+ =cut
+ ###############################################
+ sub get_group_settings {
+     my ($groupinfo)=@_;
+     my $parser=HTML::TokeParser->new(\$groupinfo);
+     my $token;
+     my $tool = '';
+     my $role = '';
+     my %content=();
+     while ($token=$parser->get_token) {
+         if ($token->[0] eq 'S')  {
+             my $entry=$token->[1];
+             if ($entry eq 'functions' || $entry eq 'autosec') {
+                 %{$content{$entry}} = ();
+                 $tool = $entry;
+             } elsif ($entry eq 'role') {
+                 if ($tool eq 'autosec') {
+                     $role = $token->[2]{id};
+                 }
+             } else {
+                 my $value=$parser->get_text('/'.$entry);
+                 if ($entry eq 'name') {
+                     if ($tool eq 'functions') {
+                         my $function = $token->[2]{id};
+                         $content{$tool}{$function} = $value;
+                     }
+                 } elsif ($entry eq 'groupname') {
+                     $content{$entry}=&Apache::lonnet::unescape($value);
+                 } elsif (($entry eq 'roles') || ($entry eq 'types') ||
+                          ($entry eq 'sectionpick') || ($entry eq 'defpriv')) {
+                     push(@{$content{$entry}},$value);
+                 } elsif ($entry eq 'section') {
+                     if ($tool eq 'autosec'  && $role ne '') {
+                         push(@{$content{$tool}{$role}},$value);
+                     }
+                 } else {
+                     $content{$entry}=$value;
+                 }
+             }
+         } elsif ($token->[0] eq 'E') {
+             if ($token->[1] eq 'functions' || $token->[1] eq 'autosec') {
+                 $tool = '';
+             } elsif ($token->[1] eq 'role') {
+                 $role = '';
+             }
+         }
+     }
+     return %content;
+ }
+ sub check_group_access {
+     my ($group) = @_;
+     my $access = 1;
+     my $now = time;
+     my ($start,$end) = split(/\./,$env{'user.role.gr/'.$env{'request.course,id'}.'/'.$group});
+     if (($end!=0) && ($end<$now)) { $access = 0; }
+     if (($start!=0) && ($start>$now)) { $access=0; }
+     return $access;
  }
  ###############################################
+ =pod
+ =item get_course_users
+ Retrieves usernames:domains for users in the specified course
+ with specific role(s), and access status.
+ Incoming parameters:
+. course domain
+. course number
+. access status: users must have - either active,
+ previous, future, or all.
+. reference to array of permissible roles
+. reference to array of section restrictions (optional)
+. reference to results object (hash of hashes).
+. reference to optional userdata hash
+ Keys of top level hash are roles.
+ Keys of inner hashes are username:domain, with
+ values set to access type.
+ Optional userdata hash returns an array with arguments in the
+ same order as loncoursedata::get_classlist() for student data.
+ Entries for end, start, section and status are blank because
+ of the possibility of multiple values for non-student roles.
+ =cut
+ ###############################################
+ sub get_course_users {
+     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
+     my %idx = ();
+     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
+     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
+     $idx{end} = &Apache::loncoursedata::CL_END();
+     $idx{start} = &Apache::loncoursedata::CL_START();
+     $idx{id} = &Apache::loncoursedata::CL_ID();
+     $idx{section} = &Apache::loncoursedata::CL_SECTION();
+     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
+     $idx{status} = &Apache::loncoursedata::CL_STATUS();
+     if (grep(/^st$/,@{$roles})) {
+         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
+         my $now = time;
+         foreach my $student (keys(%{$classlist})) {
+             my $match = 0;
+             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
+ 		unless(grep(/^\Q$$classlist{$student}[$idx{section}]\E$/,
+ 			    @{$sections})) {
+ 		    next;
+ 		}
+             }
+             if (defined($$types{'active'})) {
+                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
+                     push(@{$$users{st}{$student}},'active');
+                     $match = 1;
+                 }
+             }
+             if (defined($$types{'previous'})) {
+                 if ($$classlist{$student}[$idx{end}] <= $now) {
+                     push(@{$$users{st}{$student}},'previous');
+                     $match = 1;
+                 }
+             }
+             if (defined($$types{'future'})) {
+                 if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
+                     push(@{$$users{st}{$student}},'future');
+                     $match = 1;
+                 }
+             }
+             if ($match && defined($userdata)) {
+                 $$userdata{$student} = $$classlist{$student};
+             }
+         }
+     }
+     if ((@{$roles} > 0) && (@{$roles} ne "st")) {
+         my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);
+         foreach my $person (@coursepersonnel) {
+             my $match = 0;
+             my ($role,$user) = ($person =~ /^([^:]*):([^:]+:[^:]+)/);
+             $user =~ s/:$//;
+             if (($role) && (grep(/^\Q$role\E$/,@{$roles}))) {
+                 my ($uname,$udom,$usec) = split(/:/,$user);
+                 if ($usec ne '' && (ref($sections) eq 'ARRAY') &&
+ 		    @{$sections} > 0) {
+ 		    unless(grep(/^\Q$usec\E$/,@{$sections})) {
+ 			next;
+ 		    }
+                 }
+                 if ($uname ne '' && $udom ne '') {
+                     my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role);
+                     foreach my $type (keys(%{$types})) {
+                         if ($status eq $type) {
+                             @{$$users{$role}{$user}} = $type;
+                             $match = 1;
+                         }
+                     }
+                     if ($match && defined($userdata) &&
+                         !exists($$userdata{$uname.':'.$udom})) {
+ 			&get_user_info($udom,$uname,\%idx,$userdata);
+                     }
+                 }
+             }
+         }
+         if (grep(/^ow$/,@{$roles})) {
+             if ((defined($cdom)) && (defined($cnum))) {
+                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
+                 if ( defined($csettings{'internal.courseowner'}) ) {
+                     my $owner = $csettings{'internal.courseowner'};
+                     @{$$users{'ow'}{$owner.':'.$cdom}} = 'any';
+                     if (defined($userdata) &&
+ 			!exists($$userdata{$owner.':'.$cdom})) {
+ 			&get_user_info($cdom,$owner,\%idx,$userdata);
+ 		    }
+                 }
+             }
+         }
+     }
+     return;
+ }
+ sub get_user_info {
+     my ($udom,$uname,$idx,$userdata) = @_;
+     $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
+ 	&plainname($uname,$udom,'lastname');
+     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
+     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
+     return;
+ }
+ =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)= @_;
    # $Apache::lonxml::debug=1;
- Line 1933  sub get_unprocessed_cgi {
+ Line 3837  sub get_unprocessed_cgi {
      if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
        $value =~ tr/+/ /;
        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
-       &Apache::lonxml::debug("Seting :$name: to :$value:");
+       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
-       unless (defined($ENV{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
      }
    }
  }
+ =pod
+ =item * cacheheader()
+ returns cache-controlling header code
+ =cut
  sub cacheheader {
-   unless ($ENV{'request.method'} eq 'GET') { return ''; }
+     unless ($env{'request.method'} eq 'GET') { return ''; }
-   my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
+     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
-   my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
+     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
                  <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                  <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
-   return $output;
+     return $output;
  }
+ =pod
+ =item * no_cache($r)
+ specifies header code to not have cache
+ =cut
  sub no_cache {
-   my ($r) = @_;
+     my ($r) = @_;
-   unless ($ENV{'request.method'} eq 'GET') { return ''; }
+     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
-   #my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
+ 	$env{'request.method'} ne 'GET') { return ''; }
-   $r->no_cache(1);
+     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
-   $r->header_out("Pragma" => "no-cache");
+     $r->no_cache(1);
-   #$r->header_out("Expires" => $date);
+     $r->header_out("Expires" => $date);
+     $r->header_out("Pragma" => "no-cache");
+ }
+ sub content_type {
+     my ($r,$type,$charset) = @_;
+     if ($r) {
+ 	#  Note that printout.pl calls this with undef for $r.
+ 	&no_cache($r);
+     }
+     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
+     unless ($charset) {
+ 	$charset=&Apache::lonlocal::current_encoding;
+     }
+     if ($charset) { $type.='; charset='.$charset; }
+     if ($r) {
+ 	$r->content_type($type);
+     } else {
+ 	print("Content-type: $type\n\n");
+     }
  }
+ =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})) {
+   if (defined($env{$name})) {
-     if (ref($ENV{$name})) {
+     if (ref($env{$name})) {
        #already have multiple values
-       push(@{ $ENV{$name} },$value);
+       push(@{ $env{$name} },$value);
      } else {
        #first time seeing multiple values, convert hash entry to an arrayref
-       my $first=$ENV{$name};
+       my $first=$env{$name};
-       undef($ENV{$name});
+       undef($env{$name});
-       push(@{ $ENV{$name} },$first,$value);
+       push(@{ $env{$name} },$first,$value);
      }
    } else {
-     $ENV{$name}=$value;
+     $env{$name}=$value;
    }
  }
  =pod
+ =item * get_env_multiple($name)
+ gets $name from the %env hash, it seemlessly handles the cases where multiple
+ values may be defined and end up as an array ref.
+ returns an array of values
+ =cut
+ sub get_env_multiple {
+     my ($name) = @_;
+     my @values;
+     if (defined($env{$name})) {
+         # exists is it an array
+         if (ref($env{$name})) {
+             @values=@{ $env{$name} };
+         } else {
+             $values[0]=$env{$name};
+         }
+     }
+     return(@values);
+ }
+ =pod
  =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'}
+ needs $env{'form.upfile'}
  returns $datatoken to be put into hidden field
  =cut
  sub upfile_store {
      my $r=shift;
-     $ENV{'form.upfile'}=~s/\r/\n/gs;
+     $env{'form.upfile'}=~s/\r/\n/gs;
-     $ENV{'form.upfile'}=~s/\f/\n/gs;
+     $env{'form.upfile'}=~s/\f/\n/gs;
-     $ENV{'form.upfile'}=~s/\n+/\n/gs;
+     $env{'form.upfile'}=~s/\n+/\n/gs;
-     $ENV{'form.upfile'}=~s/\n+$//gs;
+     $env{'form.upfile'}=~s/\n+$//gs;
-     my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
+     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
- 	'_enroll_'.$ENV{'request.course.id'}.'_'.time.'_'.$$;
+ 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
      {
- 	my $fh=Apache::File->new('>'.$r->dir_config('lonDaemons').
+         my $datafile = $r->dir_config('lonDaemons').
- 				 '/tmp/'.$datatoken.'.tmp');
+                            '/tmp/'.$datatoken.'.tmp';
- 	print $fh $ENV{'form.upfile'};
+         if ( open(my $fh,">$datafile") ) {
+             print $fh $env{'form.upfile'};
+             close($fh);
+         }
      }
      return $datatoken;
  }
  =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'},
+ needs $env{'form.datatoken'},
- sets $ENV{'form.upfile'} to the contents of the file
+ sets $env{'form.upfile'} to the contents of the file
  =cut
- Line 2021  sub load_tmp_file {
+ Line 3998  sub load_tmp_file {
      my $r=shift;
      my @studentdata=();
      {
- 	my $fh;
+         my $studentfile = $r->dir_config('lonDaemons').
- 	if ($fh=Apache::File->new($r->dir_config('lonDaemons').
+                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
- 				  '/tmp/'.$ENV{'form.datatoken'}.'.tmp')) {
+         if ( open(my $fh,"<$studentfile") ) {
- 	    @studentdata=<$fh>;
+             @studentdata=<$fh>;
- 	}
+             close($fh);
+         }
      }
-     $ENV{'form.upfile'}=join('',@studentdata);
+     $env{'form.upfile'}=join('',@studentdata);
  }
  =pod
- =item upfile_record_sep()
+ =item * upfile_record_sep()
  Separate uploaded file into records
  returns array of records,
- needs $ENV{'form.upfile'} and $ENV{'form.upfiletype'}
+ needs $env{'form.upfile'} and $env{'form.upfiletype'}
  =cut
  sub upfile_record_sep {
-     if ($ENV{'form.upfiletype'} eq 'xml') {
+     if ($env{'form.upfiletype'} eq 'xml') {
      } else {
- 	return split(/\n/,$ENV{'form.upfile'});
+ 	my @records;
+ 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
+ 	    if ($line=~/^\s*$/) { next; }
+ 	    push(@records,$line);
+ 	}
+ 	return @records;
      }
  }
  =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'}
+ Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
  =cut
+ sub takeleft {
+     my $index=shift;
+     return substr('0000'.$index,-4,4);
+ }
  sub record_sep {
      my $record=shift;
      my %components=();
-     if ($ENV{'form.upfiletype'} eq 'xml') {
+     if ($env{'form.upfiletype'} eq 'xml') {
-     } elsif ($ENV{'form.upfiletype'} eq 'space') {
+     } elsif ($env{'form.upfiletype'} eq 'space') {
          my $i=0;
          foreach (split(/\s+/,$record)) {
              my $field=$_;
              $field=~s/^(\"|\')//;
              $field=~s/(\"|\')$//;
-             $components{$i}=$field;
+             $components{&takeleft($i)}=$field;
              $i++;
          }
-     } elsif ($ENV{'form.upfiletype'} eq 'tab') {
+     } elsif ($env{'form.upfiletype'} eq 'tab') {
          my $i=0;
-         foreach (split(/\t+/,$record)) {
+         foreach (split(/\t/,$record)) {
              my $field=$_;
              $field=~s/^(\"|\')//;
              $field=~s/(\"|\')$//;
-             $components{$i}=$field;
+             $components{&takeleft($i)}=$field;
              $i++;
          }
      } else {
- Line 2092  sub record_sep {
+ Line 4080  sub record_sep {
                  $field=~s/^\s*$delimiter//;
                  $field=~s/$delimiter\s*$//;
              }
-             $components{$i}=$field;
+             $components{&takeleft($i)}=$field;
  	    $i++;
          }
      }
      return %components;
  }
+ ######################################################
+ ######################################################
  =pod
- =item upfile_select_html()
+ =item * upfile_select_html()
- return HTML code to select file and specify its type
+ Return HTML code to select a file from the users machine and specify
+ the file type.
  =cut
+ ######################################################
+ ######################################################
  sub upfile_select_html {
-     return (<<'ENDUPFORM');
+     my %Types = (
- <input type="file" name="upfile" size="50" />
+                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
- <br />Type: <select name="upfiletype">
+                  space => &mt('Space separated'),
- <option value="csv">CSV (comma separated values, spreadsheet)</option>
+                  tab   => &mt('Tabulator separated'),
- <option value="space">Space separated</option>
+ #                 xml   => &mt('HTML/XML'),
- <option value="tab">Tabulator separated</option>
+                  );
- <option value="xml">HTML/XML</option>
+     my $Str = '<input type="file" name="upfile" size="50" />'.
- </select>
+         '<br />Type: <select name="upfiletype">';
- ENDUPFORM
+     foreach my $type (sort(keys(%Types))) {
+         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
+     }
+     $Str .= "</select>\n";
+     return $Str;
+ }
+ sub get_samples {
+     my ($records,$toget) = @_;
+     my @samples=({});
+     my $got=0;
+     foreach my $rec (@$records) {
+ 	my %temp = &record_sep($rec);
+ 	if (! grep(/\S/, values(%temp))) { next; }
+ 	if (%temp) {
+ 	    $samples[$got]=\%temp;
+ 	    $got++;
+ 	    if ($got == $toget) { last; }
+ 	}
+     }
+     return \@samples;
  }
+ ######################################################
+ ######################################################
  =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
- Line 2129  Apache Request ref, $records is an array
+ Line 4146  Apache Request ref, $records is an array
  =cut
+ ######################################################
+ ######################################################
  sub csv_print_samples {
      my ($r,$records) = @_;
-     my (%sone,%stwo,%sthree);
+     my $samples = &get_samples($records,3);
-     %sone=&record_sep($$records[0]);
-     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
-     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
-     $r->print('Samples<br /><table border="2"><tr>');
+     $r->print(&mt('Samples').'<br /><table border="2"><tr>');
-     foreach (sort({$a <=> $b} keys(%sone))) { $r->print('<th>Column&nbsp;'.($_+1).'</th>'); }
+     foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
+         $r->print('<th>'.&mt('Column&nbsp;[_1]',($_+1)).'</th>'); }
      $r->print('</tr>');
-     foreach my $hash (\%sone,\%stwo,\%sthree) {
+     foreach my $hash (@$samples) {
  	$r->print('<tr>');
- 	foreach (sort({$a <=> $b} keys(%sone))) {
+ 	foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
  	    $r->print('<td>');
  	    if (defined($$hash{$_})) { $r->print($$hash{$_}); }
  	    $r->print('</td>');
- Line 2151  sub csv_print_samples {
+ Line 4168  sub csv_print_samples {
      $r->print('</tr></table><br />'."\n");
  }
+ ######################################################
+ ######################################################
  =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,
  $records is an arrayref from &Apache::loncommon::upfile_record_sep,
- $d is an array of 2 element arrays (internal name, displayed name)
+ $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
  =cut
+ ######################################################
+ ######################################################
  sub csv_print_select_table {
      my ($r,$records,$d) = @_;
-     my $i=0;my %sone;
+     my $i=0;
-     %sone=&record_sep($$records[0]);
+     my $samples = &get_samples($records,1);
-     $r->print('Associate columns with student attributes.'."\n".
+     $r->print(&mt('Associate columns with student attributes.')."\n".
- 	     '<table border="2"><tr><th>Attribute</th><th>Column</th></tr>'."\n");
+ 	     '<table border="2"><tr>'.
+               '<th>'.&mt('Attribute').'</th>'.
+               '<th>'.&mt('Column').'</th></tr>'."\n");
      foreach (@$d) {
- 	my ($value,$display)=@{ $_ };
+ 	my ($value,$display,$defaultcol)=@{ $_ };
  	$r->print('<tr><td>'.$display.'</td>');
  	$r->print('<td><select name=f'.$i.
  		  ' onchange="javascript:flip(this.form,'.$i.');">');
  	$r->print('<option value="none"></option>');
- 	foreach (sort({$a <=> $b} keys(%sone))) {
+ 	foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
- 	    $r->print('<option value="'.$_.'">Column '.($_+1).'</option>');
+ 	    $r->print('<option value="'.$_.'"'.
+                       ($_ eq $defaultcol ? ' selected="selected" ' : '').
+                       '>Column '.($_+1).'</option>');
  	}
  	$r->print('</select></td></tr>'."\n");
  	$i++;
- Line 2185  sub csv_print_select_table {
+ Line 4212  sub csv_print_select_table {
      return $i;
  }
+ ######################################################
+ ######################################################
  =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.
- Line 2197  $d is an array of 2 element arrays (inte
+ Line 4227  $d is an array of 2 element arrays (inte
  =cut
+ ######################################################
+ ######################################################
  sub csv_samples_select_table {
      my ($r,$records,$d) = @_;
-     my %sone; my %stwo; my %sthree;
      my $i=0;
+     #
+     my $samples = &get_samples($records,3);
+     $r->print('<table border=2><tr><th>'.
+               &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
-     $r->print('<table border=2><tr><th>Field</th><th>Samples</th></tr>');
+     foreach my $key (sort(keys(%{ $samples->[0] }))) {
-     %sone=&record_sep($$records[0]);
+ 	$r->print('<tr><td><select name="f'.$i.'"'.
-     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
-     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
-     foreach (sort keys %sone) {
- 	$r->print('<tr><td><select name=f'.$i.
  		  ' onchange="javascript:flip(this.form,'.$i.');">');
- 	foreach (@$d) {
+ 	foreach my $option (@$d) {
- 	    my ($value,$display)=@{ $_ };
+ 	    my ($value,$display,$defaultcol)=@{ $option };
- 	    $r->print('<option value='.$value.'>'.$display.'</option>');
+ 	    $r->print('<option value="'.$value.'"'.
+                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
+                       $display.'</option>');
  	}
  	$r->print('</select></td><td>');
- 	if (defined($sone{$_})) { $r->print($sone{$_}."</br>\n"); }
+ 	foreach my $line (0..2) {
- 	if (defined($stwo{$_})) { $r->print($stwo{$_}."</br>\n"); }
+ 	    if (defined($samples->[$line]{$key})) {
- 	if (defined($sthree{$_})) { $r->print($sthree{$_}."</br>\n"); }
+ 		$r->print($samples->[$line]{$key}."<br />\n");
+ 	    }
+ 	}
  	$r->print('</td></tr>');
  	$i++;
      }
- Line 2225  sub csv_samples_select_table {
+ Line 4259  sub csv_samples_select_table {
      return($i);
  }
+ ######################################################
+ ######################################################
  =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
- Line 2244  $uname, optional the username of the use
+ Line 4300  $uname, optional the username of the use
  sub check_if_partid_hidden {
      my ($id,$symb,$udom,$uname) = @_;
-     my $hiddenparts=&Apache::lonnet::EXT('resource.0.parameter_hiddenparts',
+     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
  					 $symb,$udom,$uname);
+     my $truth=1;
+     #if the string starts with !, then the list is the list to show not hide
+     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
      my @hiddenlist=split(/,/,$hiddenparts);
      foreach my $checkid (@hiddenlist) {
- 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return 1; }
+ 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
      }
-     return undef;
+     return !$truth;
  }
+ ############################################################
+ ############################################################
-;
+ =pod
- __END__;
+ =back
+ =head1 cgi-bin script and graphing routines
+ =over 4
+ =item get_cgi_id
+ Inputs: none
+ Returns an id which can be used to pass environment variables
+ to various cgi-bin scripts.  These environment variables will
+ be removed from the users environment after a given time by
+ the routine &Apache::lonnet::transfer_profile_to_env.
+ =cut
+ ############################################################
+ ############################################################
+ my $uniq=0;
+ sub get_cgi_id {
+     $uniq=($uniq+1)%100000;
+     return (time.'_'.$$.'_'.$uniq);
+ }
+ ############################################################
+ ############################################################
  =pod
+ =item DrawBarGraph
+ Facilitates the plotting of data in a (stacked) bar graph.
+ Puts plot definition data into the users environment in order for
+ graph.png to plot it.  Returns an <img> tag for the plot.
+ The bars on the plot are labeled '1','2',...,'n'.
+ Inputs:
+ =over 4
+ =item $Title: string, the title of the plot
+ =item $xlabel: string, text describing the X-axis of the plot
+ =item $ylabel: string, text describing the Y-axis of the plot
+ =item $Max: scalar, the maximum Y value to use in the plot
+ If $Max is < any data point, the graph will not be rendered.
+ =item $colors: array ref holding the colors to be used for the data sets when
+ they are plotted.  If undefined, default values will be used.
+ =item $labels: array ref holding the labels to use on the x-axis for the bars.
+ =item @Values: An array of array references.  Each array reference holds data
+ to be plotted in a stacked bar chart.
+ =item If the final element of @Values is a hash reference the key/value
+ pairs will be added to the graph definition.
  =back
- =head2 Access .tab File Data
+ Returns:
+ An <img> tag which references graph.png and the appropriate identifying
+ information for the plot.
+ =cut
+ ############################################################
+ ############################################################
+ sub DrawBarGraph {
+     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
+     #
+     if (! defined($colors)) {
+         $colors = ['#33ff00',
+                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
+                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
+                   ];
+     }
+     my $extra_settings = {};
+     if (ref($Values[-1]) eq 'HASH') {
+         $extra_settings = pop(@Values);
+     }
+     #
+     my $identifier = &get_cgi_id();
+     my $id = 'cgi.'.$identifier;
+     if (! @Values || ref($Values[0]) ne 'ARRAY') {
+         return '';
+     }
+     #
+     my @Labels;
+     if (defined($labels)) {
+         @Labels = @$labels;
+     } else {
+         for (my $i=0;$i<@{$Values[0]};$i++) {
+             push (@Labels,$i+1);
+         }
+     }
+     #
+     my $NumBars = scalar(@{$Values[0]});
+     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
+     my %ValuesHash;
+     my $NumSets=1;
+     foreach my $array (@Values) {
+         next if (! ref($array));
+         $ValuesHash{$id.'.data.'.$NumSets++} =
+             join(',',@$array);
+     }
+     #
+     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
+     if ($NumBars < 3) {
+         $width = 120+$NumBars*32;
+         $xskip = 1;
+         $bar_width = 30;
+     } elsif ($NumBars < 5) {
+         $width = 120+$NumBars*20;
+         $xskip = 1;
+         $bar_width = 20;
+     } elsif ($NumBars < 10) {
+         $width = 120+$NumBars*15;
+         $xskip = 1;
+         $bar_width = 15;
+     } elsif ($NumBars <= 25) {
+         $width = 120+$NumBars*11;
+         $xskip = 5;
+         $bar_width = 8;
+     } elsif ($NumBars <= 50) {
+         $width = 120+$NumBars*8;
+         $xskip = 5;
+         $bar_width = 4;
+     } else {
+         $width = 120+$NumBars*8;
+         $xskip = 5;
+         $bar_width = 4;
+     }
+     #
+     $Max = 1 if ($Max < 1);
+     if ( int($Max) < $Max ) {
+         $Max++;
+         $Max = int($Max);
+     }
+     $Title  = '' if (! defined($Title));
+     $xlabel = '' if (! defined($xlabel));
+     $ylabel = '' if (! defined($ylabel));
+     $ValuesHash{$id.'.title'}    = &Apache::lonnet::escape($Title);
+     $ValuesHash{$id.'.xlabel'}   = &Apache::lonnet::escape($xlabel);
+     $ValuesHash{$id.'.ylabel'}   = &Apache::lonnet::escape($ylabel);
+     $ValuesHash{$id.'.y_max_value'} = $Max;
+     $ValuesHash{$id.'.NumBars'}  = $NumBars;
+     $ValuesHash{$id.'.NumSets'}  = $NumSets;
+     $ValuesHash{$id.'.PlotType'} = 'bar';
+     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
+     $ValuesHash{$id.'.height'}   = $height;
+     $ValuesHash{$id.'.width'}    = $width;
+     $ValuesHash{$id.'.xskip'}    = $xskip;
+     $ValuesHash{$id.'.bar_width'} = $bar_width;
+     $ValuesHash{$id.'.labels'} = join(',',@Labels);
+     #
+     # Deal with other parameters
+     while (my ($key,$value) = each(%$extra_settings)) {
+         $ValuesHash{$id.'.'.$key} = $value;
+     }
+     #
+     &Apache::lonnet::appenv(%ValuesHash);
+     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
+ }
+ ############################################################
+ ############################################################
+ =pod
+ =item DrawXYGraph
+ Facilitates the plotting of data in an XY graph.
+ Puts plot definition data into the users environment in order for
+ graph.png to plot it.  Returns an <img> tag for the plot.
+ Inputs:
  =over 4
- =item languageids()
+ =item $Title: string, the title of the plot
- returns list of all language ids
+ =item $xlabel: string, text describing the X-axis of the plot
- =item languagedescription()
+ =item $ylabel: string, text describing the Y-axis of the plot
- returns description of a specified language id
+ =item $Max: scalar, the maximum Y value to use in the plot
+ If $Max is < any data point, the graph will not be rendered.
- =item copyrightids()
+ =item $colors: Array ref containing the hex color codes for the data to be
+ plotted in.  If undefined, default values will be used.
- returns list of all copyrights
+ =item $Xlabels: Array ref containing the labels to be used for the X-axis.
- =item copyrightdescription()
+ =item $Ydata: Array ref containing Array refs.
+ Each of the contained arrays will be plotted as a separate curve.
- returns description of a specified copyright id
+ =item %Values: hash indicating or overriding any default values which are
+ passed to graph.png.
+ Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
- =item filecategories()
+ =back
- returns list of all file categories
+ Returns:
- =item filecategorytypes()
+ An <img> tag which references graph.png and the appropriate identifying
+ information for the plot.
- returns list of file types belonging to a given file
+ =cut
- category
- =item fileembstyle()
+ ############################################################
+ ############################################################
+ sub DrawXYGraph {
+     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
+     #
+     # Create the identifier for the graph
+     my $identifier = &get_cgi_id();
+     my $id = 'cgi.'.$identifier;
+     #
+     $Title  = '' if (! defined($Title));
+     $xlabel = '' if (! defined($xlabel));
+     $ylabel = '' if (! defined($ylabel));
+     my %ValuesHash =
+         (
+          $id.'.title'  => &Apache::lonnet::escape($Title),
+          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
+          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
+          $id.'.y_max_value'=> $Max,
+          $id.'.labels'     => join(',',@$Xlabels),
+          $id.'.PlotType'   => 'XY',
+          );
+     #
+     if (defined($colors) && ref($colors) eq 'ARRAY') {
+         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
+     }
+     #
+     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
+         return '';
+     }
+     my $NumSets=1;
+     foreach my $array (@{$Ydata}){
+         next if (! ref($array));
+         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
+     }
+     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
+     #
+     # Deal with other parameters
+     while (my ($key,$value) = each(%Values)) {
+         $ValuesHash{$id.'.'.$key} = $value;
+     }
+     #
+     &Apache::lonnet::appenv(%ValuesHash);
+     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
+ }
- returns embedding style for a specified file type
+ ############################################################
+ ############################################################
- =item filedescription()
+ =pod
- returns description for a specified file type
+ =item DrawXYYGraph
- =item filedescriptionex()
+ Facilitates the plotting of data in an XY graph with two Y axes.
+ Puts plot definition data into the users environment in order for
+ graph.png to plot it.  Returns an <img> tag for the plot.
- returns description for a specified file type with
+ Inputs:
- extra formatting
+ =over 4
+ =item $Title: string, the title of the plot
+ =item $xlabel: string, text describing the X-axis of the plot
+ =item $ylabel: string, text describing the Y-axis of the plot
+ =item $colors: Array ref containing the hex color codes for the data to be
+ plotted in.  If undefined, default values will be used.
+ =item $Xlabels: Array ref containing the labels to be used for the X-axis.
+ =item $Ydata1: The first data set
+ =item $Min1: The minimum value of the left Y-axis
+ =item $Max1: The maximum value of the left Y-axis
+ =item $Ydata2: The second data set
+ =item $Min2: The minimum value of the right Y-axis
+ =item $Max2: The maximum value of the left Y-axis
+ =item %Values: hash indicating or overriding any default values which are
+ passed to graph.png.
+ Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
  =back
- =head2 Alternate Problem Views
+ Returns:
+ An <img> tag which references graph.png and the appropriate identifying
+ information for the plot.
+ =cut
+ ############################################################
+ ############################################################
+ sub DrawXYYGraph {
+     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
+                                         $Ydata2,$Min2,$Max2,%Values)=@_;
+     #
+     # Create the identifier for the graph
+     my $identifier = &get_cgi_id();
+     my $id = 'cgi.'.$identifier;
+     #
+     $Title  = '' if (! defined($Title));
+     $xlabel = '' if (! defined($xlabel));
+     $ylabel = '' if (! defined($ylabel));
+     my %ValuesHash =
+         (
+          $id.'.title'  => &Apache::lonnet::escape($Title),
+          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
+          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
+          $id.'.labels' => join(',',@$Xlabels),
+          $id.'.PlotType' => 'XY',
+          $id.'.NumSets' => 2,
+          $id.'.two_axes' => 1,
+          $id.'.y1_max_value' => $Max1,
+          $id.'.y1_min_value' => $Min1,
+          $id.'.y2_max_value' => $Max2,
+          $id.'.y2_min_value' => $Min2,
+          );
+     #
+     if (defined($colors) && ref($colors) eq 'ARRAY') {
+         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
+     }
+     #
+     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
+         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
+         return '';
+     }
+     my $NumSets=1;
+     foreach my $array ($Ydata1,$Ydata2){
+         next if (! ref($array));
+         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
+     }
+     #
+     # Deal with other parameters
+     while (my ($key,$value) = each(%Values)) {
+         $ValuesHash{$id.'.'.$key} = $value;
+     }
+     #
+     &Apache::lonnet::appenv(%ValuesHash);
+     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
+ }
+ ############################################################
+ ############################################################
+ =pod
+ =back
+ =head1 Statistics helper routines?
+ Bad place for them but what the hell.
  =over 4
- =item get_previous_attempt()
+ =item &chartlink
- return string with previous attempt on problem
+ Returns a link to the chart for a specific student.
- =item get_student_view()
+ Inputs:
- show a snapshot of what student was looking at
+ =over 4
- =item get_student_answers()
+ =item $linktext: The text of the link
- show a snapshot of how student was answering problem
+ =item $sname: The students username
+ =item $sdomain: The students domain
  =back
- =head2 HTTP Helper
+ =back
+ =cut
+ ############################################################
+ ############################################################
+ sub chartlink {
+     my ($linktext, $sname, $sdomain) = @_;
+     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
+         '&amp;SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).
+         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
+        '">'.$linktext.'</a>';
+ }
+ #######################################################
+ #######################################################
+ =pod
+ =head1 Course Environment Routines
  =over 4
- =item get_unprocessed_cgi($query,$possible_names)
+ =item &restore_course_settings
- Modify the %ENV hash to contain unprocessed CGI form parameters held in
+ =item &store_course_settings
- $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.
+ Restores/Store indicated form parameters from the course environment.
- $possible_names is an ref to an array of form element names.  As an example:
+ Will not overwrite existing values of the form parameters.
- get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
- will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set.
- =item cacheheader()
+ Inputs:
+ a scalar describing the data (e.g. 'chart', 'problem_analysis')
- returns cache-controlling header code
+ a hash ref describing the data to be stored.  For example:
+ %Save_Parameters = ('Status' => 'scalar',
+     'chartoutputmode' => 'scalar',
+     'chartoutputdata' => 'scalar',
+     'Section' => 'array',
+     'StudentData' => 'array',
+     'Maps' => 'array');
- =item no_cache($r)
+ Returns: both routines return nothing
- specifies header code to not have cache
+ =cut
- =item add_to_env($name,$value)
+ #######################################################
+ #######################################################
+ sub store_course_settings {
+     # save to the environment
+     # appenv the same items, just to be safe
+     my $courseid = $env{'request.course.id'};
+     my $udom  = $env{'user.domain'};
+     my $uname = $env{'user.name'};
+     my ($prefix,$Settings) = @_;
+     my %SaveHash;
+     my %AppHash;
+     while (my ($setting,$type) = each(%$Settings)) {
+         my $basename = join('.','internal',$courseid,$prefix,$setting);
+         my $envname = 'environment.'.$basename;
+         if (exists($env{'form.'.$setting})) {
+             # Save this value away
+             if ($type eq 'scalar' &&
+                 (! exists($env{$envname}) ||
+                  $env{$envname} ne $env{'form.'.$setting})) {
+                 $SaveHash{$basename} = $env{'form.'.$setting};
+                 $AppHash{$envname}   = $env{'form.'.$setting};
+             } elsif ($type eq 'array') {
+                 my $stored_form;
+                 if (ref($env{'form.'.$setting})) {
+                     $stored_form = join(',',
+                                         map {
+                                             &Apache::lonnet::escape($_);
+                                         } sort(@{$env{'form.'.$setting}}));
+                 } else {
+                     $stored_form =
+                         &Apache::lonnet::escape($env{'form.'.$setting});
+                 }
+                 # Determine if the array contents are the same.
+                 if ($stored_form ne $env{$envname}) {
+                     $SaveHash{$basename} = $stored_form;
+                     $AppHash{$envname}   = $stored_form;
+                 }
+             }
+         }
+     }
+     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
+                                           $udom,$uname);
+     if ($put_result !~ /^(ok|delayed)/) {
+         &Apache::lonnet::logthis('unable to save form parameters, '.
+                                  'got error:'.$put_result);
+     }
+     # Make sure these settings stick around in this session, too
+     &Apache::lonnet::appenv(%AppHash);
+     return;
+ }
- adds $name to the %ENV hash with value
+ sub restore_course_settings {
- $value, if $name already exists, the entry is converted to an array
+     my $courseid = $env{'request.course.id'};
- reference and $value is added to the array.
+     my ($prefix,$Settings) = @_;
+     while (my ($setting,$type) = each(%$Settings)) {
+         next if (exists($env{'form.'.$setting}));
+         my $envname = 'environment.internal.'.$courseid.'.'.$prefix.
+             '.'.$setting;
+         if (exists($env{$envname})) {
+             if ($type eq 'scalar') {
+                 $env{'form.'.$setting} = $env{$envname};
+             } elsif ($type eq 'array') {
+                 $env{'form.'.$setting} = [
+                                            map {
+                                                &Apache::lonnet::unescape($_);
+                                            } split(',',$env{$envname})
+                                            ];
+             }
+         }
+     }
+ }
+ ############################################################
+ ############################################################
+ sub propath {
+     my ($udom,$uname)=@_;
+     $udom=~s/\W//g;
+     $uname=~s/\W//g;
+     my $subdir=$uname.'__';
+     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
+     my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
+     return $proname;
+ }
+ sub icon {
+     my ($file)=@_;
+     my $curfext = (split(/\./,$file))[-1];
+     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
+     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
+     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
+ 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
+ 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
+ 	            $curfext.".gif") {
+ 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
+ 		$curfext.".gif";
+ 	}
+     }
+     return &lonhttpdurl($iconname);
+ }
+ sub lonhttpdurl {
+     my ($url)=@_;
+     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
+     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
+     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
+ }
+ sub connection_aborted {
+     my ($r)=@_;
+     $r->print(" ");$r->rflush();
+     my $c = $r->connection;
+     return $c->aborted();
+ }
+ #    Escapes strings that may have embedded 's that will be put into
+ #    strings as 'strings'.
+ sub escape_single {
+     my ($input) = @_;
+     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
+     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
+     return $input;
+ }
+ #  Same as escape_single, but escape's "'s  This
+ #  can be used for  "strings"
+ sub escape_double {
+     my ($input) = @_;
+     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
+     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
+     return $input;
+ }
+ #   Escapes the last element of a full URL.
+ sub escape_url {
+     my ($url)   = @_;
+     my @urlslices = split(/\//, $url,-1);
+     my $lastitem = &Apache::lonnet::escape(pop(@urlslices));
+     return join('/',@urlslices).'/'.$lastitem;
+ }
+ =pod
  =back
  =cut
+;
+ __END__;

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

Removed from v.1.108
changed lines
	Added in v.1.344