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.135 and 1.274

-version 1.135, 2003/10/24 21:09:24
+version 1.274, 2005/09/16 16:01:18
  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 62  redundancy from other modules and increa
+ Line 55  redundancy from other modules and increa
  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();
  use Apache::lonlocal;
+ use HTML::Entities;
  my $readit;
- =pod
+ ##
+ ## Global Variables
- =head1 Global Variables
+ ##
- =cut
  # ----------------------------------------------- Filetypes/Languages/Copyright
  my %language;
  my %supported_language;
  my %cprtag;
+ my %scprtag;
  my %fe; my %fd;
  my %category_extensions;
- Line 90  my %category_extensions;
+ Line 82  my %category_extensions;
  my %designhash;
  # ---------------------------------------------- Thesaurus variables
+ #
- # FIXME: I don't think it's necessary to document these things;
+ # %Keywords:
- # they're privately used - Jeremy
+ #      A hash used by &keyword to determine if a word is considered a keyword.
+ # $thesaurus_db_file
- =pod
+ #      Scalar containing the full path to the thesaurus database.
- =over 4
- =item * %Keywords
- 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.
- =back
- =cut
  my %Keywords;
  my $thesaurus_db_file;
- # ----------------------------------------------------------------------- BEGIN
+ #
+ # Initialize values from language.tab, copyright.tab, filetypes.tab,
- # FIXME: I don't think this needs to be documented, it prepares
+ # thesaurus.tab, and filecategories.tab.
- # private data structures - Jeremy
+ #
- =pod
- =head1 General Subroutines
- =over 4
- =item * BEGIN()
- Initialize values from language.tab, copyright.tab, filetypes.tab,
- thesaurus.tab, and filecategories.tab.
- =back
- =cut
- # ----------------------------------------------------------------------- BEGIN
  BEGIN {
      # Variable initialization
      $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
- Line 141  BEGIN {
+ Line 102  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,$sup)=(split(/\t/,$_));
+                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_));
- 		$language{$key}=$val.' - '.$enc;
+                 $language{$key}=$val.' - '.$enc;
- 		if ($sup) {
+                 if ($sup) {
- 		    $supported_language{$key}=$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 175  BEGIN {
+ Line 152  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 194  BEGIN {
+ Line 173  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 245  containing javascript with two functions
+ Line 227  containing javascript with two functions
  C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
  tags.
- =over 4
  =item * openbrowser(formname,elementname,only,omit) [javascript]
  inputs: formname, elementname, only, omit
- Line 255  formname and elementname indicate the na
+ Line 235  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]
- Line 267  Inputs: formname, elementname
+ Line 247  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,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();
- Line 305  sub browser_and_searcher_javascript {
+ Line 293  sub browser_and_searcher_javascript {
              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 317  sub browser_and_searcher_javascript {
+ Line 307  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'}) &&
+             (($env{'request.course.id'}) &&
-              (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})))
+              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})))
-          || ($ENV{'request.role'}=~/^(au|dc|su)/)
+          || ($env{'request.role'}=~/^(au|dc|su)/)
            ) { return ''; }
     return (<<'ENDSTDBRW');
  <script type="text/javascript" language="Javascript" >
- Line 353  ENDSTDBRW
+ Line 361  ENDSTDBRW
  sub selectstudent_link {
     my ($form,$unameele,$udomele)=@_;
-    if ($ENV{'request.course.id'}) {
+    if ($env{'request.course.id'}) {
-        unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+        unless (&Apache::lonnet::allowed('srm',$env{'request.course.id'})) {
  	   return '';
         }
         return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
          '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
     }
-    if ($ENV{'request.role'}=~/^(au|dc|su)/) {
+    if ($env{'request.role'}=~/^(au|dc|su)/) {
         return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
          '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
     }
- Line 372  sub coursebrowser_javascript {
+ Line 380  sub coursebrowser_javascript {
     return (<<ENDSTDBRW);
  <script type="text/javascript" language="Javascript" >
      var stdeditbrowser;
-     function opencrsbrowser(formname,uname,udom) {
+     function opencrsbrowser(formname,uname,udom,desc,extra_element) {
          var url = '/adm/pickcourse?';
          var filter;
          if (filter != null) {
- Line 387  sub coursebrowser_javascript {
+ Line 395  sub coursebrowser_javascript {
  	   }
          }
          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;
+             }
+         }
          var title = 'Course_Browser';
          var options = 'scrollbars=1,resizable=1,menubar=0';
          options += ',width=700,height=600';
- Line 399  ENDSTDBRW
+ Line 414  ENDSTDBRW
  }
  sub selectcourse_link {
-    my ($form,$unameele,$udomele)=@_;
+    my ($form,$unameele,$udomele,$desc,$extra_element)=@_;
      return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
-         '","'.$udomele.'");'."'>".&mt('Select Course')."</a>";
+         '","'.$udomele.'","'.$desc.'","'.$extra_element.'");'."'>".&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
- Line 484  sub linked_select_forms {
+ Line 524  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 520  function select1_changed() {
+ Line 560  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 532  END
+ Line 573  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.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
      }
      $result .= "</select>\n";
- Line 542  END
+ Line 583  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.=">".&mt($select2{$value})."</option>\n";
      }
      $result .= "</select>\n";
- Line 578  sub help_open_topic {
+ Line 619  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 590  sub help_open_topic {
+ Line 631  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 608  sub help_open_topic {
+ Line 651  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 636  sub helpLatexCheatsheet {
+ Line 681  sub helpLatexCheatsheet {
  	.'</td></tr></table>';
  }
- =pod
+ 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 $html=&Apache::lonxml::xmlbegin();
+     my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
+     $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('$html<head><title>LON-CAPA Help Menu</title><meta http-equiv="pragma" content="no-cache"></head>')
+     caller.document.writeln("<frameset rows='105,*' border='0'><frame name='bannerframe'  src='$banner_link'><frame name='bodyframe' src='$details_link'></frameset>")
+     caller.document.writeln("</html>")
+     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;
+ }
- =item * csv_translate($text)
+ 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);
- Translate $text to allow it to be output as a 'comma seperated values'
+     $topic=~s/\W+/\+/g;
- format.
+     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>";
+     }
- =cut
+     # 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 csv_translate {
-     my $text = shift;
-     $text =~ s/\"/\"\"/g;
-     $text =~ s/\n//g;
-     return $text;
  }
+ 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():
- Line 684  pretty much any HTML.
+ Line 891  pretty much any HTML.
  sub change_content_javascript {
      # If we're on Netscape 4, we need to use Layer-based code
-     if ($ENV{'browser.type'} eq 'netscape' &&
+     if ($env{'browser.type'} eq 'netscape' &&
- 	$ENV{'browser.version'} =~ /^4\./) {
+ 	$env{'browser.version'} =~ /^4\./) {
  	return (<<NETSCAPE4);
  	function change(name, content) {
  	    doc = document.layers[name+"___escape"].layers[0].document;
- Line 722  the area will originally contain, which
+ Line 929  the area will originally contain, which
  sub changable_area {
      my ($name, $origContent) = @_;
-     if ($ENV{'browser.type'} eq 'netscape' &&
+     if ($env{'browser.type'} eq 'netscape' &&
- 	$ENV{'browser.version'} =~ /^4\./) {
+ 	$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 {
- Line 735  sub changable_area {
+ Line 942  sub changable_area {
  =back
+ =head1 Excel and CSV file utility routines
+ =over 4
+ =cut
+ ###############################################################
+ ###############################################################
+ =pod
+ =item * csv_translate($text)
+ 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;
+     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
  ###############################################################
- Line 760  sub get_domains {
+ Line 1135  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);
+     }
+ }
+ sub multiple_select_form {
+     my ($name,$value,$size,%hash)=@_;
+     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'>";
+     foreach (sort(keys(%hash))) {
+         $output.='<option value="'.$_.'" ';
+         $output.='selected="selected" ' if ($selected{$_});
+         $output.='>'.$hash{$_}."</option>\n";
+     }
+     $output.="</select>\n";
+     return $output;
+ }
  #-------------------------------------------
  =pod
- Line 789  sub select_form {
+ Line 1199  sub select_form {
      }
      foreach (@keys) {
          $selectform.="<option value=\"$_\" ".
-             ($_ eq $def ? 'selected' : '').
+             ($_ eq $def ? 'selected="selected" ' : '').
                  ">".&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;
+ }
  #-------------------------------------------
- Line 820  sub select_dom_form {
+ Line 1266  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 912  Outputs:
+ Line 1358  Outputs:
  =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 950  sub decode_user_agent {
+ Line 1400  sub decode_user_agent {
              $clientunicode,$clientos,);
  }
- =pod
- =back
- =cut
  ###############################################################
  ##    Authentication changing form generation subroutines    ##
  ###############################################################
- Line 996  See loncreateuser.pm for invocation and
+ Line 1440  See loncreateuser.pm for invocation and
  =back
+ =back
  =cut
  #-------------------------------------------
- Line 1023  END
+ Line 1469  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 1086  END
+ Line 1552  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 1099  sub authform_nochange{
+ Line 1565  sub authform_nochange{
                kerb_def_dom => 'MSU.EDU',
                @_,
            );
-     my $result='';
+     my $result = &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
- END
      return $result;
  }
- Line 1115  sub authform_kerberos{
+ Line 1579  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',
+          '<input type="radio" name="login" value="krb" '.
+              'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
+          '<input type="text" size="10" name="krbarg" '.
+              'value="'.$krbarg.'" '.
+              'onchange="'.$jscall.'" />',
+          '<input type="radio" name="krbver" value="4" '.$check4.' />',
+          '<input type="radio" name="krbver" value="5" '.$check5.' />');
      return $result;
  }
- Line 1142  sub authform_internal{
+ Line 1617  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])',
+          '<input type="radio" name="login" value="int" '.$intcheck.
+              ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
+          '<input type="text" size="10" name="intarg" '.$intarg.
+              ' onchange="'.$jscall.'" />');
      return $result;
  }
- Line 1160  sub authform_local{
+ Line 1645  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]',
+                     '<input type="radio" name="login" value="loc" '.$loccheck.
+                         ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
+                     '<input type="text" size="10" name="locarg" '.$locarg.
+                         ' onchange="'.$jscall.'" />');
      return $result;
  }
- Line 1178  sub authform_filesystem{
+ Line 1672  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'});"
+          '<input type="radio" name="login" value="fsys" '.
-        onclick="javascript:changed_radio('fsys',$in{'formname'});" />
+          'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
- Filesystem authenticated (with initial password
+          '<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;
  }
- =pod
- =back
- =cut
  ###############################################################
  ##    Get Authentication Defaults for Domain                 ##
  ###############################################################
- Line 1350  sub keyword {
+ Line 1836  sub keyword {
  =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 1398  sub get_related_words {
+ Line 1884  sub get_related_words {
  =over 4
- =item * plainname($uname,$udom)
+ =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',
                      ['firstname','middlename','lastname','generation'],
  					 $udom,$uname);
-     my $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
+     my $name=&Apache::lonnet::format_name($names{'firstname'},
- 	$names{'lastname'}.' '.$names{'generation'};
+ 					  $names{'middlename'},
+ 					  $names{'lastname'},
+ 					  $names{'generation'},$first);
+     $name=~s/^\s+//;
      $name=~s/\s+$//;
      $name=~s/\s+/ /g;
+     if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
      return $name;
  }
- Line 1437  if the user does not
+ Line 1929  if the user does not
  sub nickname {
      my ($uname,$udom)=@_;
-     my %names=&Apache::lonnet::get('environment',
+     my %names;
-   ['nickname','firstname','middlename','lastname','generation'],$udom,$uname);
+     if ($uname eq $env{'user.name'} &&
+ 	$udom eq $env{'user.domain'}) {
+ 	%names=('nickname'   => $env{'environment.nickname'}  ,
+ 		'firstname'  => $env{'environment.firstname'} ,
+ 		'middlename' => $env{'environment.middlename'},
+ 		'lastname'   => $env{'environment.lastname'}  ,
+ 		'generation' => $env{'environment.generation'});
+     } else {
+ 	%names=&Apache::lonnet::get('environment',
+ 				    ['nickname','firstname','middlename',
+ 				     'lastname','generation'],$udom,$uname);
+     }
      my $name=$names{'nickname'};
      if ($name) {
         $name='&quot;'.$name.'&quot;';
- Line 1464  Gets a users screenname and returns it a
+ Line 1967  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 1486  sub noteswrapper {
+ Line 1993  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
- Line 1498  sub syllabuswrapper {
+ Line 2006  sub syllabuswrapper {
      if ($fontcolor) {
          $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
      }
-     return "<a href='/public/$domain/$coursedir/syllabus'>$linktext</a>";
+     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
+ }
+ 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
- Line 1534  sub languagedescription {
+ Line 2060  sub languagedescription {
  	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
  }
+ sub plainlanguagedescription {
+     my $code=shift;
+     return $language{$code};
+ }
+ sub supportedlanguagecode {
+     my $code=shift;
+     return $supported_language{$code};
+ }
  =pod
  =item * copyrightids()
- Line 1555  returns description of a specified copyr
+ Line 2091  returns description of a specified copyr
  =cut
  sub copyrightdescription {
-     return $cprtag{shift(@_)};
+     return &mt($cprtag{shift(@_)});
+ }
+ =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
- Line 1595  sub fileembstyle {
+ Line 2155  sub fileembstyle {
      return $fe{lc(shift(@_))};
  }
+ sub filecategoryselect {
+     my ($name,$value)=@_;
+     return &select_form($value,$name,
+ 			'' => &mt('Any category'),
+ 			map { $_,$_ } sort(keys(%category_extensions)));
+ }
  =pod
  =item * filedescription()
- Line 1604  returns description for a specified file
+ Line 2172  returns description for a specified file
  =cut
  sub filedescription {
-     return $fd{lc(shift(@_))};
+     my $file_description = $fd{lc(shift())};
+     $file_description =~ s:([\[\]]):~$1:g;
+     return &mt($file_description);
  }
  =pod
- Line 1618  extra formatting
+ Line 2188  extra formatting
  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
- Line 1643  sub display_languages {
+ Line 2215  sub display_languages {
  	$languages{$_}=1;
      }
      &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
-     if ($ENV{'form.displaylanguage'}) {
+     if ($env{'form.displaylanguage'}) {
- 	foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'form.displaylanguage'})) {
+ 	foreach (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
  	    $languages{$_}=1;
          }
      }
- Line 1653  sub display_languages {
+ Line 2225  sub display_languages {
  sub preferred_languages {
      my @languages=();
-     if ($ENV{'environment.languages'}) {
+     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
- 	@languages=split(/\s*(\,|\;|\:)\s*/,$ENV{'environment.languages'});
-     }
-     if ($ENV{'course.'.$ENV{'request.course.id'}.'.languages'}) {
  	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
- 	         $ENV{'course.'.$ENV{'request.course.id'}.'.languages'}));
+ 	         $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'}}) {
+     if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
  	@languages=(@languages,
- 		$Apache::lonnet::domain_lang_def{$ENV{'user.domain'}});
+ 		$Apache::lonnet::domain_lang_def{$env{'user.domain'}});
      }
-     if ($Apache::lonnet::domain_lang_def{$ENV{'request.role.domain'}}) {
+     if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
  	@languages=(@languages,
- 		$Apache::lonnet::domain_lang_def{$ENV{'request.role.domain'}});
+ 		$Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
      }
      if ($Apache::lonnet::domain_lang_def{
  	                          $Apache::lonnet::perlvar{'lonDefDomain'}}) {
- Line 1770  sub get_previous_attempt {
+ Line 2342  sub get_previous_attempt {
  	       } else {
  		  $value=$returnhash{$version.':'.$_};
  	       }
- 	       $prevattempts.='<td>'.$value.'&nbsp;</td>';
+ 	       $prevattempts.='<td>'.&Apache::lonnet::unescape($value).'&nbsp;</td>';
  	    }
  	 }
        }
- Line 1782  sub get_previous_attempt {
+ Line 2354  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 1838  show a snapshot of what student was look
+ Line 2411  show a snapshot of what student was look
  =cut
  sub get_student_view {
-   my ($symb,$username,$domain,$courseid,$target) = @_;
+   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
    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 1876  show a snapshot of how student was answe
+ Line 2446  show a snapshot of how student was answe
  sub get_student_answers {
    my ($symb,$username,$domain,$courseid,%form) = @_;
    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;
  }
- Line 1896  sub get_student_answers {
+ Line 2461  sub get_student_answers {
  =item * &submlink()
- Inputs: $text $uname $udom $symb
+ Inputs: $text $uname $udom $symb $target
  Returns: A link to grades.pm such as to see the SUBM view of a student
- Line 1904  Returns: A link to grades.pm such as to
+ Line 2469  Returns: A link to grades.pm such as to
  ###############################################
  sub submlink {
-     my ($text,$uname,$udom,$symb)=@_;
+     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 andn 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=&symbread(); }
+     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
-     return '<a href="/adm/grades?symb='.$symb.'&student='.$uname.
+     $symb=&Apache::lonnet::escape($symb);
- 	'&userdom='.$udom.'&command=submission">'.$text.'</a>';
+     if ($target) { $target="target=\"$target\""; }
+     return '<a href="/adm/parmset?&command=set&'.
+ 	'symb='.$symb.'&uname='.$uname.
+ 	'&udom='.$udom.'" '.$target.'>'.$text.'</a>';
  }
  ##############################################
- Line 1942  sub maketime {
+ Line 2556  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 1965  sub unsqltime {
+ Line 2564  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 2004  sub determinedomain {
+ Line 2603  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 2028  sub domainlogo {
+ Line 2627  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 2053  Returns: value of designparamter $which
+ Line 2650  Returns: value of designparamter $which
  ##############################################
  sub designparm {
      my ($which,$domain)=@_;
-     if ($ENV{'browser.blackwhite'} eq 'on') {
+     if ($env{'browser.blackwhite'} eq 'on') {
  	if ($which=~/\.(font|alink|vlink|link)$/) {
  	    return '#000000';
  	}
- Line 2064  sub designparm {
+ Line 2661  sub designparm {
  	    return '#CCCCCC';
  	}
      }
-     if ($ENV{'environment.color.'.$which}) {
+     if ($env{'environment.color.'.$which}) {
- 	return $ENV{'environment.color.'.$which};
+ 	return $env{'environment.color.'.$which};
      }
      $domain=&determinedomain($domain);
      if ($designhash{$domain.'.'.$which}) {
- Line 2117  other decorations will be returned.
+ Line 2714  other decorations will be returned.
  =cut
  sub bodytag {
-     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg)=@_;
+     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,$notopbar)=@_;
      $title=&mt($title);
-     unless ($function) {
+     $function = &get_users_function() if (!$function);
- 	$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';
-         }
-     }
      my $img=&designparm($function.'.img',$domain);
      my $pgbg=&designparm($function.'.pgbg',$domain);
      my $tabbg=&designparm($function.'.tabbg',$domain);
- Line 2142  sub bodytag {
+ Line 2727  sub bodytag {
      my $sidebg=&designparm($function.'.sidebg',$domain);
  # Accessibility font enhance
      unless ($addentries) { $addentries=''; }
-     if ($ENV{'browser.fontenhance'} eq 'on') {
+     my $addstyle='';
- 	$addentries.=' style="font-size: x-large"';
+     if ($env{'browser.fontenhance'} eq 'on') {
+ 	$addstyle=' font-size: x-large;';
      }
   # 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 2161  sub bodytag {
+ Line 2747  sub bodytag {
      if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
  # construct main body tag
      my $bodytag = <<END;
+ <style type="text/css">
+ h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
+ a:focus { color: red; background: yellow }
+ </style>
  <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
- $addentries>
+ style="margin-top: 0px;$addstyle" $addentries>
  END
+     &Apache::lontexconvert::jsMath_reset();
+     if ($env{'environment.texengine'} eq 'jsMath') {
+ 	$bodytag.=&Apache::lontexconvert::jsMath_header();
+     }
      my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
-                    $lonhttpdPort.$img.'" />';
+                    $lonhttpdPort.$img.'" alt="'.$function.'" />';
      if ($bodyonly) {
          return $bodytag;
-     } elsif ($ENV{'browser.interface'} eq 'textual') {
+     } elsif ($env{'browser.interface'} eq 'textual') {
  # Accessibility
          return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
                                                        $forcereg).
                 '<h1>LON-CAPA: '.$title.'</h1>';
-     } elsif ($ENV{'environment.remote'} eq 'off') {
+     } 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 = '<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,'web',$forcereg,$titletable);
+             }
+ 	} else {
+             if ($notopbar) {
+                 $bodytag .= $titletable;
+             } else {
+                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$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.')';
+     }
+     #
      return(<<ENDBODY);
  $bodytag
  <table width="100%" cellspacing="0" border="0" cellpadding="0">
- Line 2193  $upperleft</td>
+ Line 2865  $upperleft</td>
  </tr>
  <tr>
  <td rowspan="3" bgcolor="$tabbg">
- &nbsp;<font size="5"><b>$title</b></font>
+ $titleinfo $dc_info
- <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
  }
  ###############################################
+ ###############################################
+ =pod
+ =back
+ =head1 HTTP Helpers
+ =over 4
+ =item * &endbodytag()
+ Returns a uniform footer for LON-CAPA web pages.
+ Inputs:
+ =over 4
+ =back
+ Returns: A uniform footer for LON-CAPA web pages.
+ =cut
+ sub endbodytag {
+     my $endbodytag='</body>';
+     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
+     return $endbodytag;
+ }
+ ###############################################
+ =pod
+ =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 $cid = $cdom.'_'.$cnum;
+     my $numsections = 0;
+     if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
+ 	my ($classlist) = &Apache::loncoursedata::get_classlist($cid,$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}++;
+ 	    }
+ 	}
+     }
+     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
+     foreach my $user (sort(keys(%courseroles))) {
+ 	if ($user !~ /^(\w{2})/) { next; }
+ 	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;
+ }
+ ###############################################
  sub get_posted_cgi {
      my $r=shift;
      my $buffer;
+     if ($r->header_in('Content-length')) {
-     $r->read($buffer,$r->header_in('Content-length'),0);
+ 	$r->read($buffer,$r->header_in('Content-length'),0);
+     }
      unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
  	my @pairs=split(/&/,$buffer);
  	my $pair;
- Line 2244  sub get_posted_cgi {
+ Line 3086  sub get_posted_cgi {
  		if ($name) {
  		    chomp($value);
  		    if ($fname) {
- 			$ENV{"form.$name.filename"}=$fname;
+ 			$env{"form.$name.filename"}=$fname;
- 			$ENV{"form.$name.mimetype"}=$fmime;
+ 			$env{"form.$name.mimetype"}=$fmime;
  		    } else {
  			$value=~s/\s+$//s;
  		    }
- Line 2277  sub get_posted_cgi {
+ Line 3119  sub get_posted_cgi {
  	    }
  	}
      }
-     $ENV{'request.method'}=$ENV{'REQUEST_METHOD'};
+     $env{'request.method'}=$ENV{'REQUEST_METHOD'};
      $r->method_number(M_GET);
      $r->method('GET');
      $r->headers_in->unset('Content-length');
- Line 2287  sub get_posted_cgi {
+ Line 3129  sub get_posted_cgi {
  =item * get_unprocessed_cgi($query,$possible_names)
- Modify the %ENV hash to contain unprocessed CGI form parameters held in
+ 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.
+ 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.
+ will result in $env{'form.uname'} and $env{'form.udom'} being set.
  =cut
- Line 2307  sub get_unprocessed_cgi {
+ Line 3149  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) };
      }
    }
  }
- Line 2322  returns cache-controlling header code
+ Line 3163  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
- Line 2339  specifies header code to not have cache
+ Line 3180  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) = @_;
+     my ($r,$type,$charset) = @_;
-   unless ($charset) {
+     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
-       $charset=&Apache::lonlocal::current_encoding;
+     unless ($charset) {
-   }
+ 	$charset=&Apache::lonlocal::current_encoding;
-   $r->content_type($type.($charset?'; charset='.$charset:''));
+     }
+     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
+ 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.
- Line 2367  reference and $value is added to the arr
+ Line 3215  reference and $value is added to the arr
  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
  =head1 CSV Upload/Handling functions
- Line 2393  sub add_to_env {
+ Line 3267  sub add_to_env {
  =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;
  }
- Line 2420  sub upfile_store {
+ Line 3297  sub upfile_store {
  =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 2429  sub load_tmp_file {
+ Line 3306  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
- Line 2444  sub load_tmp_file {
+ Line 3322  sub load_tmp_file {
  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;
      }
  }
- Line 2459  sub upfile_record_sep {
+ Line 3342  sub upfile_record_sep {
  =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 2500  sub record_sep {
+ Line 3388  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()
- 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;
  }
+ ######################################################
+ ######################################################
  =pod
  =item * csv_print_samples($r,$records)
- Line 2537  Apache Request ref, $records is an array
+ Line 3438  Apache Request ref, $records is an array
  =cut
+ ######################################################
+ ######################################################
  sub csv_print_samples {
      my ($r,$records) = @_;
      my (%sone,%stwo,%sthree);
      %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(%sone))) {
+         $r->print('<th>'.&mt('Column&nbsp;[_1]',($_+1)).'</th>'); }
      $r->print('</tr>');
      foreach my $hash (\%sone,\%stwo,\%sthree) {
  	$r->print('<tr>');
- Line 2559  sub csv_print_samples {
+ Line 3463  sub csv_print_samples {
      $r->print('</tr></table><br />'."\n");
  }
+ ######################################################
+ ######################################################
  =pod
  =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;
      %sone=&record_sep($$records[0]);
-     $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))) {
- 	    $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 2593  sub csv_print_select_table {
+ Line 3507  sub csv_print_select_table {
      return $i;
  }
+ ######################################################
+ ######################################################
  =pod
  =item * csv_samples_select_table($r,$records,$d)
- Line 2605  $d is an array of 2 element arrays (inte
+ Line 3522  $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;
+     #
-     $r->print('<table border=2><tr><th>Field</th><th>Samples</th></tr>');
+     $r->print('<table border=2><tr><th>'.
+               &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
      %sone=&record_sep($$records[0]);
      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.
+ 	$r->print('<tr><td><select name="f'.$i.'"'.
  		  ' onchange="javascript:flip(this.form,'.$i.');">');
  	foreach (@$d) {
- 	    my ($value,$display)=@{ $_ };
+ 	    my ($value,$display,$defaultcol)=@{ $_ };
- 	    $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"); }
+ 	if (defined($sone{$_})) { $r->print($sone{$_}."<br />\n"); }
- 	if (defined($stwo{$_})) { $r->print($stwo{$_}."</br>\n"); }
+ 	if (defined($stwo{$_})) { $r->print($stwo{$_}."<br />\n"); }
- 	if (defined($sthree{$_})) { $r->print($sthree{$_}."</br>\n"); }
+ 	if (defined($sthree{$_})) { $r->print($sthree{$_}."<br />\n"); }
  	$r->print('</td></tr>');
  	$i++;
      }
- Line 2633  sub csv_samples_select_table {
+ Line 3555  sub csv_samples_select_table {
      return($i);
  }
+ ######################################################
+ ######################################################
  =pod
  =item clean_excel_name($name)
- Line 2641  Returns a replacement for $name which do
+ Line 3566  Returns a replacement for $name which do
  =cut
+ ######################################################
+ ######################################################
  sub clean_excel_name {
      my ($name) = @_;
      $name =~ s/[:\*\?\/\\]//g;
- Line 2671  sub check_if_partid_hidden {
+ Line 3598  sub check_if_partid_hidden {
      my ($id,$symb,$udom,$uname) = @_;
      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
+ =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);
  }
  ############################################################
- Line 2685  sub check_if_partid_hidden {
+ Line 3646  sub check_if_partid_hidden {
  =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
+ 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,@Values)=@_;
+     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
      #
      if (! defined($colors)) {
          $colors = ['#33ff00',
- Line 2699  sub DrawBarGraph {
+ Line 3695  sub DrawBarGraph {
                    '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                    ];
      }
+     my $extra_settings = {};
+     if (ref($Values[-1]) eq 'HASH') {
+         $extra_settings = pop(@Values);
+     }
      #
-     my $identifier = time.'_'.int(rand(1000));
+     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{'cgi.'.$identifier.'.data.'.$NumSets++} =
+         $ValuesHash{$id.'.data.'.$NumSets++} =
              join(',',@$array);
      }
      #
-     $Title  = '' if (! defined($Title));
+     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
-     $xlabel = '' if (! defined($xlabel));
+     if ($NumBars < 3) {
-     $ylabel = '' if (! defined($ylabel));
+         $width = 120+$NumBars*32;
-     $Title  = &Apache::lonnet::escape($Title);
+         $xskip = 1;
-     $xlabel = &Apache::lonnet::escape($xlabel);
+         $bar_width = 30;
-     $ylabel = &Apache::lonnet::escape($ylabel);
+     } 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 $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 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 $Ydata: Array ref containing Array refs.
+ Each of the contained arrays will be plotted as a separate curve.
+ =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
+ Returns:
+ An <img> tag which references graph.png and the appropriate identifying
+ information for the plot.
+ =cut
+ ############################################################
+ ############################################################
+ 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" />';
+ }
+ ############################################################
+ ############################################################
+ =pod
+ =item DrawXYYGraph
+ 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.
+ 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 $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
+ 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('cgi.'.$identifier.'.title'   => $Title,
+     &Apache::lonnet::appenv(%ValuesHash);
-                             'cgi.'.$identifier.'.xlabel'  => $xlabel,
-                             'cgi.'.$identifier.'.ylabel'  => $ylabel,
-                             'cgi.'.$identifier.'.Max'     => $Max,
-                             'cgi.'.$identifier.'.NumBars' => $NumBars,
-                             'cgi.'.$identifier.'.NumSets' => $NumSets,
-                             'cgi.'.$identifier.'.Colors'  => join(',',@{$colors}),
-                             %ValuesHash);
      return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
  }
- Line 2742  sub DrawBarGraph {
+ Line 3980  sub DrawBarGraph {
  =pod
+ =back
+ =head1 Statistics helper routines?
+ Bad place for them but what the hell.
+ =over 4
+ =item &chartlink
+ Returns a link to the chart for a specific student.
+ Inputs:
+ =over 4
+ =item $linktext: The text of the link
+ =item $sname: The students username
+ =item $sdomain: The students domain
+ =back
+ =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 &restore_course_settings
+ =item &store_course_settings
+ Restores/Store indicated form parameters from the course environment.
+ Will not overwrite existing values of the form parameters.
+ Inputs:
+ a scalar describing the data (e.g. 'chart', 'problem_analysis')
+ 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');
+ Returns: both routines return nothing
+ =cut
+ #######################################################
+ #######################################################
+ sub store_course_settings {
+     # save to the environment
+     # appenv the same items, just to be safe
+     my $courseid = $env{'request.course.id'};
+     my $coursedom = $env{'course.'.$courseid.'.domain'};
+     my ($prefix,$Settings) = @_;
+     my %SaveHash;
+     my %AppHash;
+     while (my ($setting,$type) = each(%$Settings)) {
+         my $basename = 'internal.'.$prefix.'.'.$setting;
+         my $envname = 'course.'.$courseid.'.'.$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,
+                                           $coursedom,
+                                           $env{'course.'.$courseid.'.num'});
+     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;
+ }
+ sub restore_course_settings {
+     my $courseid = $env{'request.course.id'};
+     my ($prefix,$Settings) = @_;
+     while (my ($setting,$type) = each(%$Settings)) {
+         next if (exists($env{'form.'.$setting}));
+         my $envname = 'course.'.$courseid.'.internal.'.$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

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

Removed from v.1.135
changed lines
	Added in v.1.274