[BACK]Return to loncommon.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/loncommon.pm between versions 1.100 and 1.539

version 1.100, 2003/05/15 13:32:55 version 1.539, 2007/06/27 22:43:28
Line 25 Line 25
 #  #
 # http://www.lon-capa.org/  # 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  # Makes a table out of the previous attempts
 # Inputs result_from_symbread, user, domain, course_id  # Inputs result_from_symbread, user, domain, course_id
Line 47  Apache::loncommon - pile of common routi Line 40  Apache::loncommon - pile of common routi
   
 =head1 SYNOPSIS  =head1 SYNOPSIS
   
 Referenced by other mod_perl Apache modules.  Common routines for manipulating connections, student answers,
       domains, common Javascript fragments, etc.
   
 Invocation:  =head1 OVERVIEW
  &Apache::loncommon::SUBROUTINENAME(ARGUMENTS);  
   
 =head1 INTRODUCTION  A collection of commonly used subroutines that don't have a natural
   home anywhere else. This collection helps remove
 Common collection of used subroutines.  This collection helps remove  
 redundancy from other modules and increase efficiency of memory usage.  redundancy from other modules and increase efficiency of memory usage.
   
 Current things done:  
   
  Makes a table out of the previous homework attempts  
  Inputs result_from_symbread, user, domain, course_id  
  Reads in non-network-related .tab files  
   
 This is part of the LearningOnline Network with CAPA project  
 described at http://www.lon-capa.org.  
   
 =head2 General Subroutines  
   
 =over 4  
   
 =cut   =cut 
   
 # End of POD header  # End of POD header
 package Apache::loncommon;  package Apache::loncommon;
   
 use strict;  use strict;
 use Apache::lonnet();  use Apache::lonnet;
 use GDBM_File;  use GDBM_File;
 use POSIX qw(strftime mktime);  use POSIX qw(strftime mktime);
 use Apache::Constants qw(:common :http :methods);  
 use Apache::lonmsg();  
 use Apache::lonmenu();  use Apache::lonmenu();
 my $readit;  use Apache::lonenc();
   use Apache::lonlocal;
   use HTML::Entities;
   use Apache::lonhtmlcommon();
   use Apache::loncoursedata();
   use Apache::lontexconvert();
   use Apache::lonclonecourse();
   use LONCAPA qw(:DEFAULT :match);
   
 =pod   # ---------------------------------------------- Designs
   use vars qw(%defaultdesign);
   
 =item Global Variables  my $readit;
   
 =over 4  
   
 =cut  ##
   ## Global Variables
   ##
   
 # ----------------------------------------------- Filetypes/Languages/Copyright  # ----------------------------------------------- Filetypes/Languages/Copyright
 my %language;  my %language;
   my %supported_language;
 my %cprtag;  my %cprtag;
 my %fe; my %fd;  my %scprtag;
   my %fe; my %fd; my %fm;
 my %category_extensions;  my %category_extensions;
   
 # ---------------------------------------------- Designs  
   
 my %designhash;  
   
 # ---------------------------------------------- Thesaurus variables  # ---------------------------------------------- Thesaurus variables
   #
 =pod  # %Keywords:
   #      A hash used by &keyword to determine if a word is considered a keyword.
 =item %Keywords    # $thesaurus_db_file 
   #      Scalar containing the full path to the thesaurus database.
 A hash used by &keyword to determine if a word is considered a keyword.  
   
 =item $thesaurus_db_file  
   
 Scalar containing the full path to the thesaurus database.                   
   
 =cut  
   
 my %Keywords;  my %Keywords;
 my $thesaurus_db_file;  my $thesaurus_db_file;
   
   #
 =pod  # Initialize values from language.tab, copyright.tab, filetypes.tab,
   # thesaurus.tab, and filecategories.tab.
 =back  #
   
 =cut  
   
 # ----------------------------------------------------------------------- BEGIN  
   
 =pod  
   
 =item BEGIN()   
   
 Initialize values from language.tab, copyright.tab, filetypes.tab,  
 thesaurus.tab, and filecategories.tab.  
   
 =cut  
   
 # ----------------------------------------------------------------------- BEGIN  
   
 BEGIN {  BEGIN {
     # Variable initialization      # Variable initialization
     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";      $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
Line 145  BEGIN { Line 107  BEGIN {
     unless ($readit) {      unless ($readit) {
 # ------------------------------------------------------------------- languages  # ------------------------------------------------------------------- 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 (my $line = <$fh>) {
  next if /^\#/;                  next if ($line=~/^\#/);
  chomp;                  chomp($line);
  my ($key,$two,$country,$three,$enc,$val)=(split(/\t/,$_));                  my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
  $language{$key}=$val.' - '.$enc;                  $language{$key}=$val.' - '.$enc;
     }                  if ($sup) {
  }                      $supported_language{$key}=$sup;
                   }
               }
               close($fh);
           }
     }      }
 # ------------------------------------------------------------------ copyrights  # ------------------------------------------------------------------ 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 (my $line = <$fh>) {
  next if /^\#/;                  next if ($line=~/^\#/);
  chomp;                  chomp($line);
  my ($key,$val)=(split(/\s+/,$_,2));                  my ($key,$val)=(split(/\s+/,$line,2));
  $cprtag{$key}=$val;                  $cprtag{$key}=$val;
     }              }
  }              close($fh);
           }
     }      }
   # ----------------------------------------------------------- source copyrights
 # -------------------------------------------------------------- domain designs  
   
     my $filename;  
     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';  
     opendir(DIR,$designdir);  
     while ($filename=readdir(DIR)) {  
  my ($domain)=($filename=~/^(\w+)\./);  
     {      {
  my $fh=Apache::File->new($designdir.'/'.$filename);          my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
  if ($fh) {                                    '/source_copyright.tab';
     while (<$fh>) {          if ( open (my $fh,"<$sourcecopyrightfile") ) {
  next if /^\#/;              while (my $line = <$fh>) {
  chomp;                  next if ($line =~ /^\#/);
  my ($key,$val)=(split(/\=/,$_));                  chomp($line);
  if ($val) { $designhash{$domain.'.'.$key}=$val; }                  my ($key,$val)=(split(/\s+/,$line,2));
     }                  $scprtag{$key}=$val;
  }              }
               close($fh);
           }
     }      }
   
   # -------------------------------------------------------------- default domain designs
       my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
       my $designfile = $designdir.'/default.tab';
       if ( open (my $fh,"<$designfile") ) {
           while (my $line = <$fh>) {
               next if ($line =~ /^\#/);
               chomp($line);
               my ($key,$val)=(split(/\=/,$line));
               if ($val) { $defaultdesign{$key}=$val; }
           }
           close($fh);
     }      }
     closedir(DIR);  
   
   
 # ------------------------------------------------------------- file categories  # ------------------------------------------------------------- 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 (my $line = <$fh>) {
  next if /^\#/;   next if ($line =~ /^\#/);
  chomp;   chomp($line);
  my ($extension,$category)=(split(/\s+/,$_,2));                  my ($extension,$category)=(split(/\s+/,$line,2));
  push @{$category_extensions{lc($category)}},$extension;                  push @{$category_extensions{lc($category)}},$extension;
     }              }
  }              close($fh);
           }
   
     }      }
 # ------------------------------------------------------------------ file types  # ------------------------------------------------------------------ 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>) {              while (my $line = <$fh>) {
  next if (/^\#/);   next if ($line =~ /^\#/);
  chomp;   chomp($line);
  my ($ending,$emb,$descr)=split(/\s+/,$_,3);                  my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
  if ($descr ne '') {                   if ($descr ne '') {
     $fe{$ending}=lc($emb);                      $fe{$ending}=lc($emb);
     $fd{$ending}=$descr;                      $fd{$ending}=$descr;
  }                      if ($mime ne 'unk') { $fm{$ending}=$mime; }
     }                  }
  }              }
               close($fh);
           }
     }      }
     &Apache::lonnet::logthis(      &Apache::lonnet::logthis(
               "<font color=yellow>INFO: Read file types</font>");                "<font color=yellow>INFO: Read file types</font>");
Line 228  BEGIN { Line 203  BEGIN {
     }  # end of unless($readit)       }  # end of unless($readit) 
           
 }  }
 # ============================================================= END BEGIN BLOCK  
 ###############################################################  ###############################################################
 ##           HTML and Javascript Helper Functions            ##  ##           HTML and Javascript Helper Functions            ##
 ###############################################################  ###############################################################
   
 =pod   =pod 
   
 =item browser_and_searcher_javascript   =head1 HTML and Javascript Functions
   
 Returns scalar containing javascript to open a browser window  
 or a searcher window.  Also creates   
   
 =over 4  =over 4
   
 =item openbrowser(formname,elementname,only,omit) [javascript]  =item * browser_and_searcher_javascript ()
   
   X<browsing, javascript>X<searching, javascript>Returns a string
   containing javascript with two functions, C<openbrowser> and
   C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
   tags.
   
   =item * openbrowser(formname,elementname,only,omit) [javascript]
   
 inputs: formname, elementname, only, omit  inputs: formname, elementname, only, omit
   
Line 250  formname and elementname indicate the na Line 229  formname and elementname indicate the na
 the element that the results of the browsing selection are to be placed in.   the element that the results of the browsing selection are to be placed in. 
   
 Specifying 'only' will restrict the browser to displaying only files  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  Specifying 'omit' will restrict the browser to NOT displaying files
 with the given extension.  Can be a comma seperated list.  with the given extension.  Can be a comma separated list.
   
 =item opensearcher(formname, elementname) [javascript]  =item * opensearcher(formname, elementname) [javascript]
   
 Inputs: formname, elementname  Inputs: formname, elementname
   
 formname and elementname specify the name of the html form and the name  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.  of the element the selection from the search results will be placed in.
   
 =back  =back
   
 =cut  =cut
   
 ###############################################################  
 sub browser_and_searcher_javascript {  sub browser_and_searcher_javascript {
       my ($mode)=@_;
       if (!defined($mode)) { $mode='edit'; }
       my $resurl=&escape_single(&lastresurl());
     return <<END;      return <<END;
   // <!-- BEGIN LON-CAPA Internal
     var editbrowser = null;      var editbrowser = null;
     function openbrowser(formname,elementname,only,omit) {      function openbrowser(formname,elementname,only,omit,titleelement) {
         var url = '/res/?';          var url = '$resurl/?';
         if (editbrowser == null) {          if (editbrowser == null) {
             url += 'launch=1&';              url += 'launch=1&';
         }          }
         url += 'catalogmode=interactive&';          url += 'catalogmode=interactive&';
         url += 'mode=edit&';          url += 'mode=$mode&';
         url += 'form=' + formname + '&';          url += 'form=' + formname + '&';
         if (only != null) {          if (only != null) {
             url += 'only=' + only + '&';              url += 'only=' + only + '&';
         }           } else {
               url += 'only=&';
    }
         if (omit != null) {          if (omit != null) {
             url += 'omit=' + omit + '&';              url += 'omit=' + omit + '&';
         }          } else {
               url += 'omit=&';
    }
           if (titleelement != null) {
               url += 'titleelement=' + titleelement + '&';
           } else {
       url += 'titleelement=&';
    }
         url += 'element=' + elementname + '';          url += 'element=' + elementname + '';
         var title = 'Browser';          var title = 'Browser';
         var options = 'scrollbars=1,resizable=1,menubar=0';          var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
         options += ',width=700,height=600';          options += ',width=700,height=600';
         editbrowser = open(url,title,options,'1');          editbrowser = open(url,title,options,'1');
         editbrowser.focus();          editbrowser.focus();
     }      }
     var editsearcher;      var editsearcher;
     function opensearcher(formname,elementname) {      function opensearcher(formname,elementname,titleelement) {
         var url = '/adm/searchcat?';          var url = '/adm/searchcat?';
         if (editsearcher == null) {          if (editsearcher == null) {
             url += 'launch=1&';              url += 'launch=1&';
         }          }
         url += 'catalogmode=interactive&';          url += 'catalogmode=interactive&';
         url += 'mode=edit&';          url += 'mode=$mode&';
         url += 'form=' + formname + '&';          url += 'form=' + formname + '&';
           if (titleelement != null) {
               url += 'titleelement=' + titleelement + '&';
           } else {
       url += 'titleelement=&';
    }
         url += 'element=' + elementname + '';          url += 'element=' + elementname + '';
         var title = 'Search';          var title = 'Search';
         var options = 'scrollbars=1,resizable=1,menubar=0';          var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
         options += ',width=700,height=600';          options += ',width=700,height=600';
         editsearcher = open(url,title,options,'1');          editsearcher = open(url,title,options,'1');
         editsearcher.focus();          editsearcher.focus();
     }      }
   // END LON-CAPA Internal -->
 END  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 {  sub studentbrowser_javascript {
    unless ($ENV{'request.course.id'}) { return ''; }       unless (
    unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {              (($env{'request.course.id'}) && 
         return '';               (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
    }        || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
     '/'.$env{'request.course.sec'})
         ))
            || ($env{'request.role'}=~/^(au|dc|su)/)
             ) { return ''; }  
    return (<<'ENDSTDBRW');     return (<<'ENDSTDBRW');
 <script type="text/javascript" language="Javascript" >  <script type="text/javascript" language="Javascript" >
     var stdeditbrowser;      var stdeditbrowser;
     function openstdbrowser(formname,uname,udom) {      function openstdbrowser(formname,uname,udom,roleflag) {
         var url = '/adm/pickstudent?';          var url = '/adm/pickstudent?';
         var filter;          var filter;
         eval('filter=document.'+formname+'.'+uname+'.value;');          eval('filter=document.'+formname+'.'+uname+'.value;');
Line 329  sub studentbrowser_javascript { Line 345  sub studentbrowser_javascript {
         }          }
         url += 'form=' + formname + '&unameelement='+uname+          url += 'form=' + formname + '&unameelement='+uname+
                                     '&udomelement='+udom;                                      '&udomelement='+udom;
         var title = 'Student Browser';   if (roleflag) { url+="&roles=1"; }
           var title = 'Student_Browser';
         var options = 'scrollbars=1,resizable=1,menubar=0';          var options = 'scrollbars=1,resizable=1,menubar=0';
         options += ',width=700,height=600';          options += ',width=700,height=600';
         stdeditbrowser = open(url,title,options,'1');          stdeditbrowser = open(url,title,options,'1');
Line 340  ENDSTDBRW Line 357  ENDSTDBRW
 }  }
   
 sub selectstudent_link {  sub selectstudent_link {
     my ($form,$unameele,$udomele)=@_;     my ($form,$unameele,$udomele)=@_;
    unless ($ENV{'request.course.id'}) { return ''; }       if ($env{'request.course.id'}) {  
    unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {         if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
         return '';     && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
    '/'.$env{'request.course.sec'})) {
      return '';
          }
          return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
           '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
    }     }
     return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.     if ($env{'request.role'}=~/^(au|dc|su)/) {
         '","'.$udomele.'");'."'>Select User</a>";         return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
           '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
      }
      return '';
 }  }
   
 sub coursebrowser_javascript {  sub coursebrowser_javascript {
    return (<<'ENDSTDBRW');      my ($domainfilter,$sec_element,$formname)=@_;
 <script type="text/javascript" language="Javascript" >      my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
     var stdeditbrowser;     my $output = '
     function opencrsbrowser(formname,uname,udom) {  <script type="text/javascript">
       var stdeditbrowser;'."\n";
      $output .= <<"ENDSTDBRW";
       function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
         var url = '/adm/pickcourse?';          var url = '/adm/pickcourse?';
         var filter;          var domainfilter = '';
         if (filter != null) {          var formid = getFormIdByName(formname);
            if (filter != '') {          if (formid > -1) {
                url += 'filter='+filter+'&';              var domid = getIndexByName(formid,udom);
               if (domid > -1) {
                   if (document.forms[formid].elements[domid].type == 'select-one') {
                       domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                   }
                   if (document.forms[formid].elements[domid].type == 'hidden') {
                       domainfilter=document.forms[formid].elements[domid].value;
                   }
               }
           }
           if (domainfilter != null) {
              if (domainfilter != '') {
                  url += 'domainfilter='+domainfilter+'&';
    }     }
         }          }
         url += 'form=' + formname + '&cnumelement='+uname+          url += 'form=' + formname + '&cnumelement='+uname+
                                     '&cdomelement='+udom;                              '&cdomelement='+udom+
         var title = 'Course Browser';                                      '&cnameelement='+desc;
           if (extra_element !=null && extra_element != '') {
               if (formname == 'rolechoice') {
                   url += '&roleelement='+extra_element;
                   if (domainfilter == null || domainfilter == '') {
                       url += '&domainfilter='+extra_element;
                   }
               }
               else {
                   if (formname == 'portform') {
                       url += '&setroles='+extra_element;
                   }
               }     
           }
           if (multflag !=null && multflag != '') {
               url += '&multiple='+multflag;
           }
           if (crstype == 'Course/Group') {
               if (formname == 'cu') {
                   crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                   if (crstype == "") {
                       alert("$crs_or_grp_alert");
                       return;
                   }
               }
           }
           if (crstype !=null && crstype != '') {
               url += '&type='+crstype;
           }
           var title = 'Course_Browser';
         var options = 'scrollbars=1,resizable=1,menubar=0';          var options = 'scrollbars=1,resizable=1,menubar=0';
         options += ',width=700,height=600';          options += ',width=700,height=600';
         stdeditbrowser = open(url,title,options,'1');          stdeditbrowser = open(url,title,options,'1');
         stdeditbrowser.focus();          stdeditbrowser.focus();
     }      }
 </script>  
       function getFormIdByName(formname) {
           for (var i=0;i<document.forms.length;i++) {
               if (document.forms[i].name == formname) {
                   return i;
               }
           }
           return -1; 
       }
   
       function getIndexByName(formid,item) {
           for (var i=0;i<document.forms[formid].elements.length;i++) {
               if (document.forms[formid].elements[i].name == item) {
                   return i;
               }
           }
           return -1;
       }
 ENDSTDBRW  ENDSTDBRW
       if ($sec_element ne '') {
           $output .= &setsec_javascript($sec_element,$formname);
       }
       $output .= '
   </script>';
       return $output;
   }
   
   sub setsec_javascript {
       my ($sec_element,$formname) = @_;
       my $setsections = qq|
   function setSect(sectionlist) {
       var sectionsArray = sectionlist.split(",");
       var numSections = sectionsArray.length;
       document.$formname.$sec_element.length = 0;
       if (numSections == 0) {
           document.$formname.$sec_element.multiple=false;
           document.$formname.$sec_element.size=1;
           document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
       } else {
           if (numSections == 1) {
               document.$formname.$sec_element.multiple=false;
               document.$formname.$sec_element.size=1;
               document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
               document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
               document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
           } else {
               for (var i=0; i<numSections; i++) {
                   document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
               }
               document.$formname.$sec_element.multiple=true
               if (numSections < 3) {
                   document.$formname.$sec_element.size=numSections;
               } else {
                   document.$formname.$sec_element.size=3;
               }
               document.$formname.$sec_element.options[0].selected = false
           }
       }
   }
   |;
       return $setsections;
 }  }
   
   
 sub selectcourse_link {  sub selectcourse_link {
    my ($form,$unameele,$udomele)=@_;     my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
     return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.     return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
         '","'.$udomele.'");'."'>Select Course</a>";          '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&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  =pod
   
 =item linked_select_forms(...)  =item * linked_select_forms(...)
   
 linked_select_forms returns a string containing a <script></script> block  linked_select_forms returns a string containing a <script></script> block
 and html for two <select> menus.  The select menus will be linked in that  and html for two <select> menus.  The select menus will be linked in that
Line 395  linked_select_forms takes the following Line 547  linked_select_forms takes the following
   
 =over 4  =over 4
   
 =item $formname, the name of the <form> tag  =item * $formname, the name of the <form> tag
   
 =item $middletext, the text which appears between the <select> tags  =item * $middletext, the text which appears between the <select> tags
   
 =item $firstdefault, the default value for the first menu  =item * $firstdefault, the default value for the first menu
   
 =item $firstselectname, the name of the first <select> tag  =item * $firstselectname, the name of the first <select> tag
   
 =item $secondselectname, the name of the second <select> tag  =item * $secondselectname, the name of the second <select> tag
   
 =item $hashref, a reference to a hash containing the data for the menus.  =item * $hashref, a reference to a hash containing the data for the menus.
   
 =back   =back 
   
Line 416  first menu value is given in $menu{$choi Line 568  first menu value is given in $menu{$choi
 and text for the second menu are given in the hash pointed to by   and text for the second menu are given in the hash pointed to by 
 $menu{$choice1}->{'select2'}.    $menu{$choice1}->{'select2'}.  
   
 my %menu = ( A1 => { text =>"Choice A1" ,   my %menu = ( A1 => { text =>"Choice A1" ,
                       default => "B3",                         default => "B3",
                       select2 => {                          select2 => { 
                           B1 => "Choice B1",                             B1 => "Choice B1",
                           B2 => "Choice B2",                             B2 => "Choice B2",
                           B3 => "Choice B3",                             B3 => "Choice B3",
                           B4 => "Choice B4"                             B4 => "Choice B4"
                           }                             }
                   },                     },
               A2 => { text =>"Choice A2" ,                 A2 => { text =>"Choice A2" ,
                       default => "C2",                         default => "C2",
                       select2 => {                          select2 => { 
                           C1 => "Choice C1",                             C1 => "Choice C1",
                           C2 => "Choice C2",                             C2 => "Choice C2",
                           C3 => "Choice C3"                             C3 => "Choice C3"
                           }                             }
                   },                     },
               A3 => { text =>"Choice A3" ,                 A3 => { text =>"Choice A3" ,
                       default => "D6",                         default => "D6",
                       select2 => {                          select2 => { 
                           D1 => "Choice D1",                             D1 => "Choice D1",
                           D2 => "Choice D2",                             D2 => "Choice D2",
                           D3 => "Choice D3",                             D3 => "Choice D3",
                           D4 => "Choice D4",                             D4 => "Choice D4",
                           D5 => "Choice D5",                             D5 => "Choice D5",
                           D6 => "Choice D6",                             D6 => "Choice D6",
                           D7 => "Choice D7"                             D7 => "Choice D7"
                           }                             }
                   }                     }
               );                 );
   
 =cut  =cut
   
 # ------------------------------------------------  
   
 sub linked_select_forms {  sub linked_select_forms {
     my ($formname,      my ($formname,
         $middletext,          $middletext,
Line 463  sub linked_select_forms { Line 613  sub linked_select_forms {
     my $first = "document.$formname.$firstselectname";      my $first = "document.$formname.$firstselectname";
     # output the javascript to do the changing      # output the javascript to do the changing
     my $result = '';      my $result = '';
     $result.="<script>\n";      $result.="<script type=\"text/javascript\">\n";
     $result.="var select2data = new Object();\n";      $result.="var select2data = new Object();\n";
     $" = '","';      $" = '","';
     my $debug = '';      my $debug = '';
Line 499  function select1_changed() { Line 649  function select1_changed() {
     // in with the nuclear      // in with the nuclear
     for (i=0;i<values.length; i++) {      for (i=0;i<values.length; i++) {
         $second.options[i] = new Option(values[i]);          $second.options[i] = new Option(values[i]);
           $second.options[i].value = values[i];
         $second.options[i].text = texts[i];          $second.options[i].text = texts[i];
         if (values[i] == select2def) {          if (values[i] == select2def) {
             $second.options[i].selected = true;              $second.options[i].selected = true;
Line 511  END Line 662  END
     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";      $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
     foreach my $value (sort(keys(%$hashref))) {      foreach my $value (sort(keys(%$hashref))) {
         $result.="    <option value=\"$value\" ";          $result.="    <option value=\"$value\" ";
         $result.=" selected=\"true\" " if ($value eq $firstdefault);          $result.=" selected=\"selected\" " if ($value eq $firstdefault);
         $result.=">$hashref->{$value}->{'text'}</option>\n";          $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
     }      }
     $result .= "</select>\n";      $result .= "</select>\n";
     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};      my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
Line 521  END Line 672  END
     my $seconddefault = $hashref->{$firstdefault}->{'default'};      my $seconddefault = $hashref->{$firstdefault}->{'default'};
     foreach my $value (sort(keys(%select2))) {      foreach my $value (sort(keys(%select2))) {
         $result.="    <option value=\"$value\" ";                  $result.="    <option value=\"$value\" ";        
         $result.=" selected=\"true\" " if ($value eq $seconddefault);          $result.=" selected=\"selected\" " if ($value eq $seconddefault);
         $result.=">$select2{$value}</option>\n";          $result.=">".&mt($select2{$value})."</option>\n";
     }      }
     $result .= "</select>\n";      $result .= "</select>\n";
     #    return $debug;      #    return $debug;
     return $result;      return $result;
 }   #  end of sub linked_select_forms {  }   #  end of sub linked_select_forms {
   
 ###############################################################  
   
 =pod  =pod
   
 =item help_open_topic($topic, $text, $stayOnPage, $width, $height)  =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
   
 Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces.  
   
 $text will optionally be linked to the same topic, allowing you to link text in addition to the graphic. If you do not want to link text, but wish to specify one of the later parameters, pass an empty string.  Returns a string corresponding to an HTML link to the given help
   $topic, where $topic corresponds to the name of a .tex file in
 $stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.)  /home/httpd/html/adm/help/tex, with underscores replaced by
   spaces. 
 $width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included.  
   $text will optionally be linked to the same topic, allowing you to
   link text in addition to the graphic. If you do not want to link
   text, but wish to specify one of the later parameters, pass an
   empty string. 
   
   $stayOnPage is a value that will be interpreted as a boolean. If true,
   the link will not open a new window. If false, the link will open
   a new window using Javascript. (Default is false.) 
   
   $width and $height are optional numerical parameters that will
   override the width and height of the popped up window, which may
   be useful for certain help topics with big pictures included. 
   
 =cut  =cut
   
Line 549  sub help_open_topic { Line 708  sub help_open_topic {
     my ($topic, $text, $stayOnPage, $width, $height) = @_;      my ($topic, $text, $stayOnPage, $width, $height) = @_;
     $text = "" if (not defined $text);      $text = "" if (not defined $text);
     $stayOnPage = 0 if (not defined $stayOnPage);      $stayOnPage = 0 if (not defined $stayOnPage);
     if ($ENV{'browser.interface'} eq 'textual') {      if ($env{'browser.interface'} eq 'textual' ||
    $env{'environment.remote'} eq 'off' ) {
  $stayOnPage=1;   $stayOnPage=1;
     }      }
     $width = 350 if (not defined $width);      $width = 350 if (not defined $width);
Line 560  sub help_open_topic { Line 720  sub help_open_topic {
     my $template = "";      my $template = "";
     my $link;      my $link;
   
       $topic=~s/\W/\_/g;
   
     if (!$stayOnPage)      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'))";   $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
Line 574  sub help_open_topic { Line 736  sub help_open_topic {
     {      {
  $template .=    $template .= 
   "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".    "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
   "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";    "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
     }      }
   
     # Add the graphic      # Add the graphic
       my $title = &mt('Online Help');
       my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
     $template .= <<"ENDTEMPLATE";      $template .= <<"ENDTEMPLATE";
  <a href="$link"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: $topic)" /></a>   <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
 ENDTEMPLATE  ENDTEMPLATE
     if ($text ne '') { $template.='</td></tr></table>' };      if ($text ne '') { $template.='</td></tr></table>' };
     return $template;      return $template;
   
 }  }
   
   # This is a quicky function for Latex cheatsheet editing, since it 
   # appears in at least four places
   sub helpLatexCheatsheet {
       my $other = shift;
       my $addOther = '';
       if ($other) {
    $addOther = Apache::loncommon::help_open_topic($other, shift,
          undef, undef, 600) .
      '</td><td>';
       }
       return '<table><tr><td>'.
    $addOther .
    &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
       undef,undef,600)
    .'</td><td>'.
    &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
       undef,undef,600)
    .'</td></tr></table>';
   }
   
   sub general_help {
       my $helptopic='Student_Intro';
       if ($env{'request.role'}=~/^(ca|au)/) {
    $helptopic='Authoring_Intro';
       } elsif ($env{'request.role'}=~/^cc/) {
    $helptopic='Course_Coordination_Intro';
       }
       return $helptopic;
   }
   
   sub update_help_link {
       my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
       my $origurl = $ENV{'REQUEST_URI'};
       $origurl=~s|^/~|/priv/|;
       my $timestamp = time;
       foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
           $$datum = &escape($$datum);
       }
   
       my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
       my $output .= <<"ENDOUTPUT";
   <script type="text/javascript">
   banner_link = '$banner_link';
   </script>
   ENDOUTPUT
       return $output;
   }
   
   # now just updates the help link and generates a blue icon
   sub help_open_menu {
       my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
    = @_;
       
       $stayOnPage = 0 if (not defined $stayOnPage);
       if ($env{'browser.interface'} eq 'textual' ||
    $env{'environment.remote'} eq 'off' ) {
    $stayOnPage=1;
       }
       my $output;
       if ($component_help) {
    if (!$text) {
       $output=&help_open_topic($component_help,undef,$stayOnPage,
          $width,$height);
    } else {
       my $help_text;
       $help_text=&unescape($topic);
       $output='<table><tr><td>'.
    &help_open_topic($component_help,$help_text,$stayOnPage,
    $width,$height).'</td></tr></table>';
    }
       }
       my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
       return $output.$banner_link;
   }
   
   sub top_nav_help {
       my ($text) = @_;
   
       $text = &mt($text);
   
       my $stayOnPage = 
    ($env{'browser.interface'}  eq 'textual' ||
    $env{'environment.remote'} eq 'off' );
       my $link=  ($stayOnPage) ? "javascript:helpMenu('display')"
                        : "javascript:helpMenu('open')";
       my $banner_link = &update_help_link(undef,undef,undef,undef,$stayOnPage);
   
       my $title = &mt('Get help');
   
       return <<"END";
   $banner_link
    <a href="$link" title="$title">$text</a>
   END
   }
   
   sub help_menu_js {
       my ($text) = @_;
   
       my $stayOnPage = 
    ($env{'browser.interface'}  eq 'textual' ||
    $env{'environment.remote'} eq 'off' );
   
       my $width = 620;
       my $height = 600;
       my $helptopic=&general_help();
       my $details_link = '/adm/help/'.$helptopic.'.hlp';
       my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
       my $start_page =
           &Apache::loncommon::start_page('Help Menu', undef,
          {'frameset'    => 1,
    'js_ready'    => 1,
    'add_entries' => {
       'border' => '0',
       'rows'   => "105,*",},});
       my $end_page =
           &Apache::loncommon::end_page({'frameset' => 1,
         'js_ready' => 1,});
   
       my $template .= <<"ENDTEMPLATE";
   <script type="text/javascript">
   // <!-- BEGIN LON-CAPA Internal
   // <![CDATA[
   var banner_link = '';
   function helpMenu(target) {
       var caller = this;
       if (target == 'open') {
           var newWindow = null;
           try {
               newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
           }
           catch(error) {
               writeHelp(caller);
               return;
           }
           if (newWindow) {
               caller = newWindow;
           }
       }
       writeHelp(caller);
       return;
   }
   function writeHelp(caller) {
       caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
       caller.document.close()
       caller.focus()
   }
   // ]]>
   // END LON-CAPA Internal -->
   </script>
   ENDTEMPLATE
       return $template;
   }
   
   sub help_open_bug {
       my ($topic, $text, $stayOnPage, $width, $height) = @_;
       unless ($env{'user.adv'}) { return ''; }
       unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
       $text = "" if (not defined $text);
       $stayOnPage = 0 if (not defined $stayOnPage);
       if ($env{'browser.interface'} eq 'textual' ||
    $env{'environment.remote'} eq 'off' ) {
    $stayOnPage=1;
       }
       $width = 600 if (not defined $width);
       $height = 600 if (not defined $height);
   
       $topic=~s/\W+/\+/g;
       my $link='';
       my $template='';
       my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
    &escape($ENV{'REQUEST_URI'}).'&amp;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 target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
       }
   
       # Add the graphic
       my $title = &mt('Report a Bug');
       my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
       $template .= <<"ENDTEMPLATE";
    <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
   ENDTEMPLATE
       if ($text ne '') { $template.='</td></tr></table>' };
       return $template;
   
   }
   
   sub help_open_faq {
       my ($topic, $text, $stayOnPage, $width, $height) = @_;
       unless ($env{'user.adv'}) { return ''; }
       unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
       $text = "" if (not defined $text);
       $stayOnPage = 0 if (not defined $stayOnPage);
       if ($env{'browser.interface'} eq 'textual' ||
    $env{'environment.remote'} eq 'off' ) {
    $stayOnPage=1;
       }
       $width = 350 if (not defined $width);
       $height = 400 if (not defined $height);
   
       $topic=~s/\W+/\+/g;
       my $link='';
       my $template='';
       my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
       if (!$stayOnPage)
       {
    $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
       }
       else
       {
    $link = $url;
       }
   
       # Add the text
       if ($text ne "")
       {
    $template .= 
     "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
     "<td bgcolor='#448844'><a target=\"_top\" 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 target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
   ENDTEMPLATE
       if ($text ne '') { $template.='</td></tr></table>' };
       return $template;
   
   }
   
   ###############################################################
   ###############################################################
   
   =pod
   
   =item * change_content_javascript():
   
   This and the next function allow you to create small sections of an
   otherwise static HTML page that you can update on the fly with
   Javascript, even in Netscape 4.
   
   The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
   must be written to the HTML page once. It will prove the Javascript
   function "change(name, content)". Calling the change function with the
   name of the section 
   you want to update, matching the name passed to C<changable_area>, and
   the new content you want to put in there, will put the content into
   that area.
   
   B<Note>: Netscape 4 only reserves enough space for the changable area
   to contain room for the original contents. You need to "make space"
   for whatever changes you wish to make, and be B<sure> to check your
   code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
   it's adequate for updating a one-line status display, but little more.
   This script will set the space to 100% width, so you only need to
   worry about height in Netscape 4.
   
   Modern browsers are much less limiting, and if you can commit to the
   user not using Netscape 4, this feature may be used freely with
   pretty much any HTML.
   
   =cut
   
   sub change_content_javascript {
       # If we're on Netscape 4, we need to use Layer-based code
       if ($env{'browser.type'} eq 'netscape' &&
    $env{'browser.version'} =~ /^4\./) {
    return (<<NETSCAPE4);
    function change(name, content) {
       doc = document.layers[name+"___escape"].layers[0].document;
       doc.open();
       doc.write(content);
       doc.close();
    }
   NETSCAPE4
       } else {
    # Otherwise, we need to use semi-standards-compliant code
    # (technically, "innerHTML" isn't standard but the equivalent
    # is really scary, and every useful browser supports it
    return (<<DOMBASED);
    function change(name, content) {
       element = document.getElementById(name);
       element.innerHTML = content;
    }
   DOMBASED
       }
   }
   
   =pod
   
   =item * changable_area($name, $origContent):
   
   This provides a "changable area" that can be modified on the fly via
   the Javascript code provided in C<change_content_javascript>. $name is
   the name you will use to reference the area later; do not repeat the
   same name on a given HTML page more then once. $origContent is what
   the area will originally contain, which can be left blank.
   
   =cut
   
   sub changable_area {
       my ($name, $origContent) = @_;
   
       if ($env{'browser.type'} eq 'netscape' &&
    $env{'browser.version'} =~ /^4\./) {
    # If this is netscape 4, we need to use the Layer tag
    return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
       } else {
    return "<span id='$name'>$origContent</span>";
       }
   }
   
 =pod  =pod
   
 =item csv_translate($text)   =back
   
   =head1 Excel and CSV file utility routines
   
   =over 4
   
   =cut
   
 Translate $text to allow it to be output as a 'comma seperated values'   ###############################################################
   ###############################################################
   
   =pod
   
   =item * csv_translate($text) 
   
   Translate $text to allow it to be output as a 'comma separated values' 
 format.  format.
   
 =cut  =cut
   
   ###############################################################
   ###############################################################
 sub csv_translate {  sub csv_translate {
     my $text = shift;      my $text = shift;
     $text =~ s/\"/\"\"/g;      $text =~ s/\"/\"\"/g;
     $text =~ s/\n//g;      $text =~ s/\n/ /g;
     return $text;      return $text;
 }  }
   
 ###############################################################  ###############################################################
   ###############################################################
   
   =pod
   
   =item * define_excel_formats
   
   Define some commonly used Excel cell formats.
   
   Currently supported formats:
   
   =over 4
   
   =item header
   
   =item bold
   
   =item h1
   
   =item h2
   
   =item h3
   
   =item h4
   
   =item i
   
   =item date
   
   =back
   
   Inputs: $workbook
   
   Returns: $format, a hash reference.
   
   =cut
   
   ###############################################################
   ###############################################################
   sub define_excel_formats {
       my ($workbook) = @_;
       my $format;
       $format->{'header'} = $workbook->add_format(bold      => 1, 
                                                   bottom    => 1,
                                                   align     => 'center');
       $format->{'bold'} = $workbook->add_format(bold=>1);
       $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
       $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
       $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
       $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
       $format->{'i'}    = $workbook->add_format(italic=>1);
       $format->{'date'} = $workbook->add_format(num_format=>
                                               'mm/dd/yyyy hh:mm:ss');
       return $format;
   }
   
   ###############################################################
   ###############################################################
   
   =pod
   
   =item * create_workbook
   
   Create an Excel worksheet.  If it fails, output message on the
   request object and return undefs.
   
   Inputs: Apache request object
   
   Returns (undef) on failure, 
       Excel worksheet object, scalar with filename, and formats 
       from &Apache::loncommon::define_excel_formats on success
   
   =cut
   
   ###############################################################
   ###############################################################
   sub create_workbook {
       my ($r) = @_;
           #
       # Create the excel spreadsheet
       my $filename = '/prtspool/'.
           $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
           time.'_'.rand(1000000000).'.xls';
       my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
       if (! defined($workbook)) {
           $r->log_error("Error creating excel spreadsheet $filename: $!");
           $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                               "This error has been logged.  ".
                               "Please alert your LON-CAPA administrator").
                     '</p>');
           return (undef);
       }
       #
       $workbook->set_tempdir('/home/httpd/perl/tmp');
       #
       my $format = &Apache::loncommon::define_excel_formats($workbook);
       return ($workbook,$filename,$format);
   }
   
   ###############################################################
   ###############################################################
   
   =pod
   
   =item * create_text_file
   
   Create a file to write to and eventually make available to the usre.
   If file creation fails, outputs an error message on the request object and 
   return undefs.
   
   Inputs: Apache request object, and file suffix
   
   Returns (undef) on failure, 
       Filehandle and filename on success.
   
   =cut
   
   ###############################################################
   ###############################################################
   sub create_text_file {
       my ($r,$suffix) = @_;
       if (! defined($suffix)) { $suffix = 'txt'; };
       my $fh;
       my $filename = '/prtspool/'.
           $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
           time.'_'.rand(1000000000).'.'.$suffix;
       $fh = Apache::File->new('>/home/httpd'.$filename);
       if (! defined($fh)) {
           $r->log_error("Couldn't open $filename for output $!");
           $r->print("Problems occured in creating the output file.  ".
                     "This error has been logged.  ".
                     "Please alert your LON-CAPA administrator.");
       }
       return ($fh,$filename)
   }
   
   
   =pod 
   
   =back
   
   =cut
   
   ###############################################################
 ##        Home server <option> list generating code          ##  ##        Home server <option> list generating code          ##
 ###############################################################  ###############################################################
   
   # ------------------------------------------
   
   sub domain_select {
       my ($name,$value,$multiple)=@_;
       my %domains=map { 
    $_ => $_.' '. &Apache::lonnet::domain($_,'description') 
       } &Apache::lonnet::all_domains();
       if ($multiple) {
    $domains{''}=&mt('Any domain');
    return &multiple_select_form($name,$value,4,\%domains);
       } else {
    return &select_form($name,$value,%domains);
       }
   }
   
 #-------------------------------------------  #-------------------------------------------
   
 =pod  =pod
   
 =item get_domains()  =head1 Routines for form select boxes
   
 Returns an array containing each of the domains listed in the hosts.tab  =over 4
 file.  
   =cut
   
   =item * multiple_select_form($name,$value,$size,$hash,$order)
   
   Returns a string containing a <select> element int multiple mode
   
   
   Args:
     $name - name of the <select> element
     $value - scalar or array ref of values that should already be selected
     $size - number of rows long the select element is
     $hash - the elements should be 'option' => 'shown text'
             (shown text should already have been &mt())
     $order - (optional) array ref of the order to show the elements in
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub get_domains {  sub multiple_select_form {
     # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.      my ($name,$value,$size,$hash,$order)=@_;
     my @domains;      my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
     my %seen;      my $output='';
     foreach (sort values(%Apache::lonnet::hostdom)) {      if (! defined($size)) {
         push (@domains,$_) unless $seen{$_}++;          $size = 4;
           if (scalar(keys(%$hash))<4) {
               $size = scalar(keys(%$hash));
           }
       }
       $output.="\n<select name='$name' size='$size' multiple='1'>";
       my @order;
       if (ref($order) eq 'ARRAY')  {
           @order = @{$order};
       } else {
           @order = sort(keys(%$hash));
     }      }
     return @domains;      if (exists($$hash{'select_form_order'})) {
           @order = @{$$hash{'select_form_order'}};
       }
           
       foreach my $key (@order) {
           $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
           $output.='selected="selected" ' if ($selected{$key});
           $output.='>'.$hash->{$key}."</option>\n";
       }
       $output.="</select>\n";
       return $output;
 }  }
   
 #-------------------------------------------  #-------------------------------------------
   
 =pod  =pod
   
 =item select_form($defdom,$name,%hash)  =item * select_form($defdom,$name,%hash)
   
 Returns a string containing a <select name='$name' size='1'> form to   Returns a string containing a <select name='$name' size='1'> form to 
 allow a user to select options from a hash option_name => displayed text.    allow a user to select options from a hash option_name => displayed text.  
Line 643  See lonrights.pm for an example invocati Line 1340  See lonrights.pm for an example invocati
 sub select_form {  sub select_form {
     my ($def,$name,%hash) = @_;      my ($def,$name,%hash) = @_;
     my $selectform = "<select name=\"$name\" size=\"1\">\n";      my $selectform = "<select name=\"$name\" size=\"1\">\n";
     foreach (sort keys %hash) {      my @keys;
         $selectform.="<option value=\"$_\" ".      if (exists($hash{'select_form_order'})) {
             ($_ eq $def ? 'selected' : '').   @keys=@{$hash{'select_form_order'}};
                 ">".$hash{$_}."</option>\n";      } else {
    @keys=sort(keys(%hash));
       }
       foreach my $key (@keys) {
           $selectform.=
       '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
               ($key eq $def ? 'selected="selected" ' : '').
                   ">".&mt($hash{$key})."</option>\n";
     }      }
     $selectform.="</select>";      $selectform.="</select>";
     return $selectform;      return $selectform;
 }  }
   
   # For display filters
   
   sub display_filter {
       if (!$env{'form.show'}) { $env{'form.show'}=10; }
       if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
       return '<nobr><label>'.&mt('Records [_1]',
          &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
      (&mt('all'),10,20,50,100,1000,10000))).
      '</label></nobr> <nobr>'.
              &mt('Filter [_1]',
      &select_form($env{'form.displayfilter'},
    'displayfilter',
    ('currentfolder' => 'Current folder/page',
    'containing' => 'Containing phrase',
    'none' => 'None'))).
    '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
   }
   
   sub gradeleveldescription {
       my $gradelevel=shift;
       my %gradelevels=(0 => 'Not specified',
        1 => 'Grade 1',
        2 => 'Grade 2',
        3 => 'Grade 3',
        4 => 'Grade 4',
        5 => 'Grade 5',
        6 => 'Grade 6',
        7 => 'Grade 7',
        8 => 'Grade 8',
        9 => 'Grade 9',
        10 => 'Grade 10',
        11 => 'Grade 11',
        12 => 'Grade 12',
        13 => 'Grade 13',
        14 => '100 Level',
        15 => '200 Level',
        16 => '300 Level',
        17 => '400 Level',
        18 => 'Graduate Level');
       return &mt($gradelevels{$gradelevel});
   }
   
   sub select_level_form {
       my ($deflevel,$name)=@_;
       unless ($deflevel) { $deflevel=0; }
       my $selectform = "<select name=\"$name\" size=\"1\">\n";
       for (my $i=0; $i<=18; $i++) {
           $selectform.="<option value=\"$i\" ".
               ($i==$deflevel ? 'selected="selected" ' : '').
                   ">".&gradeleveldescription($i)."</option>\n";
       }
       $selectform.="</select>";
       return $selectform;
   }
   
 #-------------------------------------------  #-------------------------------------------
   
 =pod  =pod
   
 =item select_dom_form($defdom,$name,$includeempty)  =item * select_dom_form($defdom,$name,$includeempty)
   
 Returns a string containing a <select name='$name' size='1'> form to   Returns a string containing a <select name='$name' size='1'> form to 
 allow a user to select the domain to preform an operation in.    allow a user to select the domain to preform an operation in.  
Line 671  selected"); Line 1429  selected");
 #-------------------------------------------  #-------------------------------------------
 sub select_dom_form {  sub select_dom_form {
     my ($defdom,$name,$includeempty) = @_;      my ($defdom,$name,$includeempty) = @_;
     my @domains = get_domains();      my @domains = sort(&Apache::lonnet::all_domains());
     if ($includeempty) { @domains=('',@domains); }      if ($includeempty) { @domains=('',@domains); }
     my $selectdomain = "<select name=\"$name\" size=\"1\">\n";      my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
     foreach (@domains) {      foreach my $dom (@domains) {
         $selectdomain.="<option value=\"$_\" ".          $selectdomain.="<option value=\"$dom\" ".
             ($_ eq $defdom ? 'selected' : '').              ($dom eq $defdom ? 'selected="selected" ' : '').
                 ">$_</option>\n";                  ">$dom</option>\n";
     }      }
     $selectdomain.="</select>";      $selectdomain.="</select>";
     return $selectdomain;      return $selectdomain;
Line 687  sub select_dom_form { Line 1445  sub select_dom_form {
   
 =pod  =pod
   
 =item get_library_servers($domain)  =item * home_server_option_list($domain)
   
 Returns a hash which contains keys like '103l3' and values like   
 'kirk.lite.msu.edu'.  All of the keys will be for machines in the  
 given $domain.  
   
 =cut  
   
 #-------------------------------------------  
 sub get_library_servers {  
     my $domain = shift;  
     my %library_servers;  
     foreach (keys(%Apache::lonnet::libserv)) {  
         if ($Apache::lonnet::hostdom{$_} eq $domain) {  
             $library_servers{$_} = $Apache::lonnet::hostname{$_};  
         }  
     }  
     return %library_servers;  
 }  
   
 #-------------------------------------------  
   
 =pod  
   
 =item home_server_option_list($domain)  
   
 returns a string which contains an <option> list to be used in a   returns a string which contains an <option> list to be used in a 
 <select> form input.  See loncreateuser.pm for an example.  <select> form input.  See loncreateuser.pm for an example.
Line 721  returns a string which contains an <opti Line 1455  returns a string which contains an <opti
 #-------------------------------------------  #-------------------------------------------
 sub home_server_option_list {  sub home_server_option_list {
     my $domain = shift;      my $domain = shift;
     my %servers = &get_library_servers($domain);      my %servers = &Apache::lonnet::get_servers($domain,'library');
     my $result = '';      my $result = '';
     foreach (sort keys(%servers)) {      foreach my $hostid (sort(keys(%servers))) {
         $result.=          $result.=
             '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";              '<option value="'.$hostid.'">'.
       $hostid.' '.$servers{$hostid}."</option>\n";
     }      }
     return $result;      return $result;
 }  }
 ###############################################################  
 ##    End of home server <option> list generating code       ##  =pod
 ###############################################################  
   =back 
   
   =cut
   
 ###############################################################  ###############################################################
   ##                  Decoding User Agent                      ##
 ###############################################################  ###############################################################
   
 =pod  =pod
   
 =item &decode_user_agent()  =head1 Decoding the User Agent
   
   =over 4
   
   =item * &decode_user_agent()
   
 Inputs: $r  Inputs: $r
   
Line 746  Outputs: Line 1489  Outputs:
   
 =over 4  =over 4
   
 =item $httpbrowser  =item * $httpbrowser
   
 =item $clientbrowser  =item * $clientbrowser
   
 =item $clientversion  =item * $clientversion
   
 =item $clientmathml  =item * $clientmathml
   
 =item $clientunicode  =item * $clientunicode
   
 =item $clientos  =item * $clientos
   
 =back  =back
   
   =back 
   
 =cut  =cut
   
 ###############################################################  ###############################################################
 ###############################################################  ###############################################################
 sub decode_user_agent {  sub decode_user_agent {
       my ($r)=@_;
     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});      my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});      my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};      my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
       if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
     my $clientbrowser='unknown';      my $clientbrowser='unknown';
     my $clientversion='0';      my $clientversion='0';
     my $clientmathml='';      my $clientmathml='';
Line 799  sub decode_user_agent { Line 1546  sub decode_user_agent {
 }  }
   
 ###############################################################  ###############################################################
 ###############################################################  
   
   
 ###############################################################  
 ##    Authentication changing form generation subroutines    ##  ##    Authentication changing form generation subroutines    ##
 ###############################################################  ###############################################################
 ##  ##
Line 814  sub decode_user_agent { Line 1557  sub decode_user_agent {
   
 =pod  =pod
   
 =item authform_xxxxxx  =head1 Authentication Routines
   
   =over 4
   
   =item * authform_xxxxxx
   
 The authform_xxxxxx subroutines provide javascript and html forms which   The authform_xxxxxx subroutines provide javascript and html forms which 
 handle some of the conveniences required for authentication forms.    handle some of the conveniences required for authentication forms.  
Line 824  See loncreateuser.pm for invocation and Line 1571  See loncreateuser.pm for invocation and
   
 =over 4  =over 4
   
 =item authform_header  =item * authform_header
   
 =item authform_authorwarning  =item * authform_authorwarning
   
 =item authform_nochange  =item * authform_nochange
   
 =item authform_kerberos  =item * authform_kerberos
   
 =item authform_internal  =item * authform_internal
   
 =item authform_filesystem  =item * authform_filesystem
   
 =back  =back
   
   =back 
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
Line 865  END Line 1614  END
         $Javascript_toUpperCase = "";          $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";      $result.=<<"END";
 var current = new Object();  var current = new Object();
 current.radiovalue = 'nochange';  current.radiovalue = $radioval;
 current.argfield = null;  current.argfield = $argfield;
   
 function changed_radio(choice,currentform) {  function changed_radio(choice,currentform) {
     var choicearg = choice + 'arg';      var choicearg = choice + 'arg';
Line 928  END Line 1697  END
   
 sub authform_authorwarning{  sub authform_authorwarning{
     my $result='';      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;      return $result;
 }  }
   
Line 941  sub authform_nochange{ Line 1710  sub authform_nochange{
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               @_,                @_,
           );            );
     my $result='';      my $result = '<label>'.&mt('[_1] Do not change login data',
     $result.=<<"END";                       '<input type="radio" name="login" value="nochange" '.
 <input type="radio" name="login" value="nochange" checked="checked"                       'checked="checked" onclick="'.
        onclick="javascript:changed_radio('nochange',$in{'formname'});" />              "javascript:changed_radio('nochange',$in{'formname'});".'" />').
 Do not change login data      '</label>';
 END  
     return $result;      return $result;
 }  }
   
Line 957  sub authform_kerberos{ Line 1725  sub authform_kerberos{
               kerb_def_auth => 'krb4',                kerb_def_auth => 'krb4',
               @_,                @_,
               );                );
     my $result='';      my ($check4,$check5,$krbarg);
     my $check4;  
     my $check5;  
     if ($in{'kerb_def_auth'} eq 'krb5') {      if ($in{'kerb_def_auth'} eq 'krb5') {
        $check5 = " checked=\"on\"";         $check5 = " checked=\"on\"";
     } else {      } else {
        $check4 = " checked=\"on\"";         $check4 = " checked=\"on\"";
     }      }
     $result.=<<"END";      $krbarg = $in{'kerb_def_dom'};
 <input type="radio" name="login" value="krb"   
        onclick="javascript:changed_radio('krb',$in{'formname'});"      my $krbcheck = "";
        onchange="javascript:changed_radio('krb',$in{'formname'});" />      if ( grep/^curr_authtype$/,(keys %in) ) {
 Kerberos authenticated with domain          if ($in{'curr_authtype'} =~ m/^krb/) {
 <input type="text" size="10" name="krbarg" value="$in{'kerb_def_dom'}"              $krbcheck = " checked=\"on\"";
        onchange="javascript:changed_text('krb',$in{'formname'});" />              if ( grep/^curr_autharg$/,(keys %in) ) {
 <input type="radio" name="krbver" value="4" $check4 />Version 4                  $krbarg = $in{'curr_autharg'};
 <input type="radio" name="krbver" value="5" $check5 />Version 5              }
 END          }
       }
   
       my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
       my $result .= &mt
           ('[_1] Kerberos authenticated with domain [_2] '.
            '[_3] Version 4 [_4] Version 5 [_5]',
            '<label><input type="radio" name="login" value="krb" '.
                'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
            '</label><input type="text" size="10" name="krbarg" '.
                'value="'.$krbarg.'" '.
                'onchange="'.$jscall.'" />',
            '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
            '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
    '</label>');
     return $result;      return $result;
 }  }
   
Line 984  sub authform_internal{ Line 1764  sub authform_internal{
                 kerb_def_dom => 'MSU.EDU',                  kerb_def_dom => 'MSU.EDU',
                 @_,                  @_,
                 );                  );
     my $result='';  
     $result.=<<"END";      my $intcheck = "";
 <input type="radio" name="login" value="int"      my $intarg = 'value=""';
        onchange="javascript:changed_radio('int',$args{'formname'});"      if ( grep/^curr_authtype$/,(keys %args) ) {
        onclick="javascript:changed_radio('int',$args{'formname'});" />          if ($args{'curr_authtype'} eq 'int') {
 Internally authenticated (with initial password               $intcheck = " checked=\"on\"";
 <input type="text" size="10" name="intarg" value=""              if ( grep/^curr_autharg$/,(keys %args) ) {
        onchange="javascript:changed_text('int',$args{'formname'});" />)                  $intarg = "value=\"$args{'curr_autharg'}\"";
 END              }
           }
       }
   
       my $jscall = "javascript:changed_radio('int',$args{'formname'});";
       my $result.=&mt
           ('[_1] Internally authenticated (with initial password [_2])',
            '<label><input type="radio" name="login" value="int" '.$intcheck.
                ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
            '</label><input type="text" size="10" name="intarg" '.$intarg.
                ' onchange="'.$jscall.'" />');
     return $result;      return $result;
 }  }
   
Line 1002  sub authform_local{ Line 1792  sub authform_local{
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               @_,                @_,
               );                );
     my $result='';  
     $result.=<<"END";      my $loccheck = "";
 <input type="radio" name="login" value="loc"      my $locarg = 'value=""';
        onchange="javascript:changed_radio('loc',$in{'formname'});"      if ( grep/^curr_authtype$/,(keys %in) ) {
        onclick="javascript:changed_radio('loc',$in{'formname'});" />          if ($in{'curr_authtype'} eq 'loc') {
 Local Authentication with argument              $loccheck = " checked=\"on\"";
 <input type="text" size="10" name="locarg" value=""              if ( grep/^curr_autharg$/,(keys %in) ) {
        onchange="javascript:changed_text('loc',$in{'formname'});" />                  $locarg = "value=\"$in{'curr_autharg'}\"";
 END              }
           }
       }
   
       my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
       my $result.=&mt('[_1] Local Authentication with argument [_2]',
                       '<label><input type="radio" name="login" value="loc" '.$loccheck.
                           ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
                       '</label><input type="text" size="10" name="locarg" '.$locarg.
                           ' onchange="'.$jscall.'" />');
     return $result;      return $result;
 }  }
   
Line 1020  sub authform_filesystem{ Line 1819  sub authform_filesystem{
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               @_,                @_,
               );                );
     my $result='';      my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
     $result.=<<"END";      my $result.= &mt
 <input type="radio" name="login" value="fsys"           ('[_1] Filesystem Authenticated (with initial password [_2])',
        onchange="javascript:changed_radio('fsys',$in{'formname'});"           '<label><input type="radio" name="login" value="fsys" '.
        onclick="javascript:changed_radio('fsys',$in{'formname'});" />           'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
 Filesystem authenticated (with initial password            '</label><input type="text" size="10" name="fsysarg" value="" '.
 <input type="text" size="10" name="fsysarg" value=""                    'onchange="'.$jscall.'" />');
        onchange="javascript:changed_text('fsys',$in{'formname'});">)  
 END  
     return $result;      return $result;
 }  }
   
 ###############################################################  ###############################################################
 ##   End Authentication changing form generation functions   ##  
 ###############################################################  
   
 ###############################################################  
 ##    Get Authentication Defaults for Domain                 ##  ##    Get Authentication Defaults for Domain                 ##
 ###############################################################  ###############################################################
 ##  
 ## Returns default authentication type and an associated argument  
 ## as listed in file domain.tab  
 ##  
 #-------------------------------------------  
   
 =pod  =pod
   
 =item get_auth_defaults  =head1 Domains and Authentication
   
   Returns default authentication type and an associated argument as
   listed in file 'domain.tab'.
   
   =over 4
   
   =item * get_auth_defaults
   
 get_auth_defaults($target_domain) returns the default authentication  get_auth_defaults($target_domain) returns the default authentication
 type and an associated argument (initial password or a kerberos domain).  type and an associated argument (initial password or a kerberos domain).
Line 1057  These values are stored in lonTabs/domai Line 1852  These values are stored in lonTabs/domai
   
 If target_domain is not found in domain.tab, returns nothing ('').  If target_domain is not found in domain.tab, returns nothing ('').
   
 =over 4  
   
 =item get_auth_defaults  
   
 =back  
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub get_auth_defaults {  sub get_auth_defaults {
     my $domain=shift;      my $domain=shift;
     return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});      return (&Apache::lonnet::domain($domain,'auth_def'),
       &Apache::lonnet::domain($domain,'auth_arg_def'));
       
 }  }
 ###############################################################  ###############################################################
 ##   End Get Authentication Defaults for Domain              ##  ##   End Get Authentication Defaults for Domain              ##
Line 1086  sub get_auth_defaults { Line 1877  sub get_auth_defaults {
   
 =pod  =pod
   
 =item get_kerberos_defaults  =item * get_kerberos_defaults
   
 get_kerberos_defaults($target_domain) returns the default kerberos  get_kerberos_defaults($target_domain) returns the default kerberos
 version and domain. If not found in domain.tabs, it defaults to  version and domain. If not found in domain.tabs, it defaults to
Line 1094  version 4 and the domain of the server. Line 1885  version 4 and the domain of the server.
   
 ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);  ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
   
 =over 4  
   
 =item get_kerberos_defaults  
   
 =back  
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
Line 1115  sub get_kerberos_defaults { Line 1900  sub get_kerberos_defaults {
     }      }
     return ($krbdef,$krbdefdom);      return ($krbdef,$krbdefdom);
 }  }
 ###############################################################  
 ##   End Get Kerberos Defaults for Domain              ##  =pod
 ###############################################################  
   =back
   
   =cut
   
 ###############################################################  ###############################################################
 ##                Thesaurus Functions                        ##  ##                Thesaurus Functions                        ##
Line 1125  sub get_kerberos_defaults { Line 1913  sub get_kerberos_defaults {
   
 =pod  =pod
   
 =item initialize_keywords  =head1 Thesaurus Functions
   
   =over 4
   
   =item * initialize_keywords
   
 Initializes the package variable %Keywords if it is empty.  Uses the  Initializes the package variable %Keywords if it is empty.  Uses the
 package variable $thesaurus_db_file.  package variable $thesaurus_db_file.
Line 1160  sub initialize_keywords { Line 1952  sub initialize_keywords {
     }      }
     untie %thesaurus_db;      untie %thesaurus_db;
     # Remove special values from %Keywords.      # Remove special values from %Keywords.
     foreach ('total.count','average.count') {      foreach my $value ('total.count','average.count') {
         delete($Keywords{$_}) if (exists($Keywords{$_}));          delete($Keywords{$value}) if (exists($Keywords{$value}));
     }      }
     return 1;      return 1;
 }  }
Line 1170  sub initialize_keywords { Line 1962  sub initialize_keywords {
   
 =pod  =pod
   
 =item keyword($word)  =item * keyword($word)
   
 Returns true if $word is a keyword.  A keyword is a word that appears more   Returns true if $word is a keyword.  A keyword is a word that appears more 
 than the average number of times in the thesaurus database.  Calls   than the average number of times in the thesaurus database.  Calls 
Line 1191  sub keyword { Line 1983  sub keyword {
   
 =pod   =pod 
   
 =item get_related_words  =item * get_related_words
   
 Look up a word in the thesaurus.  Takes a scalar arguement and returns  Look up a word in the thesaurus.  Takes a scalar argument and returns
 an array of words.  If the keyword is not in the thesaurus, an empty array  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  will be returned.  The order of the words returned is determined by the
 database which holds them.  database which holds them.
Line 1216  sub get_related_words { Line 2008  sub get_related_words {
         return ();          return ();
     }       } 
     my @Words=();      my @Words=();
       my $count=0;
     if (exists($thesaurus_db{$keyword})) {      if (exists($thesaurus_db{$keyword})) {
         $_ = $thesaurus_db{$keyword};   # The first element is the number of times
         (undef,@Words) = split/:/;  # The first element is the number of times   # the word appears.  We do not need it now.
                                     # the word appears.  We do not need it now.   my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
         for (my $i=0;$i<=$#Words;$i++) {   my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
             ($Words[$i],undef)= split/\,/,$Words[$i];   my $threshold=$mostfrequentcount/10;
           foreach my $possibleword (@RelatedWords) {
               my ($word,$wordcount)=split(/\,/,$possibleword);
               if ($wordcount>$threshold) {
    push(@Words,$word);
                   $count++;
                   if ($count>10) { last; }
       }
         }          }
     }      }
     untie %thesaurus_db;      untie %thesaurus_db;
     return @Words;      return @Words;
 }  }
   
 ###############################################################  =pod
 ##              End Thesaurus Functions                      ##  
 ###############################################################  =back
   
   =cut
   
 # -------------------------------------------------------------- Plaintext name  # -------------------------------------------------------------- Plaintext name
 =pod  =pod
   
 =item plainname($uname,$udom)  =head1 User Name Functions
   
 Gets a users name and returns it as a string in  =over 4
 "first middle last generation"  
 form  =item * plainname($uname,$udom,$first)
   
   Takes a users logon name and returns it as a string in
   "first middle last generation" form 
   if $first is set to 'lastname' then it returns it as
   'lastname generation, firstname middlename' if their is a lastname
   
 =cut  =cut
   
   
 ###############################################################  ###############################################################
 sub plainname {  sub plainname {
     my ($uname,$udom)=@_;      my ($uname,$udom,$first)=@_;
     my %names=&Apache::lonnet::get('environment',      return if (!defined($uname) || !defined($udom));
                     ['firstname','middlename','lastname','generation'],      my %names=&getnames($uname,$udom);
  $udom,$uname);      my $name=&Apache::lonnet::format_name($names{'firstname'},
     my $name=$names{'firstname'}.' '.$names{'middlename'}.' '.    $names{'middlename'},
  $names{'lastname'}.' '.$names{'generation'};    $names{'lastname'},
     $names{'generation'},$first);
       $name=~s/^\s+//;
     $name=~s/\s+$//;      $name=~s/\s+$//;
     $name=~s/\s+/ /g;      $name=~s/\s+/ /g;
       if ($name !~ /\S/) { $name=$uname.':'.$udom; }
     return $name;      return $name;
 }  }
   
 # -------------------------------------------------------------------- Nickname  # -------------------------------------------------------------------- Nickname
 =pod  =pod
   
 =item nickname($uname,$udom)  =item * nickname($uname,$udom)
   
 Gets a users name and returns it as a string as  Gets a users name and returns it as a string as
   
Line 1275  if the user does not Line 2086  if the user does not
   
 sub nickname {  sub nickname {
     my ($uname,$udom)=@_;      my ($uname,$udom)=@_;
     my %names=&Apache::lonnet::get('environment',      return if (!defined($uname) || !defined($udom));
   ['nickname','firstname','middlename','lastname','generation'],$udom,$uname);      my %names=&getnames($uname,$udom);
     my $name=$names{'nickname'};      my $name=$names{'nickname'};
     if ($name) {      if ($name) {
        $name='&quot;'.$name.'&quot;';          $name='&quot;'.$name.'&quot;'; 
Line 1289  sub nickname { Line 2100  sub nickname {
     return $name;      return $name;
 }  }
   
   sub getnames {
       my ($uname,$udom)=@_;
       return if (!defined($uname) || !defined($udom));
       if ($udom eq 'public' && $uname eq 'public') {
    return ('lastname' => &mt('Public'));
       }
       my $id=$uname.':'.$udom;
       my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
       if ($cached) {
    return %{$names};
       } else {
    my %loadnames=&Apache::lonnet::get('environment',
                       ['firstname','middlename','lastname','generation','nickname'],
    $udom,$uname);
    &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
    return %loadnames;
       }
   }
   
   sub getemails {
       my ($uname,$udom)=@_;
       if ($udom eq 'public' && $uname eq 'public') {
    return;
       }
       if (!$udom) { $udom=$env{'user.domain'}; }
       if (!$uname) { $uname=$env{'user.name'}; }
       my $id=$uname.':'.$udom;
       my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
       if ($cached) {
    return %{$names};
       } else {
    my %loadnames=&Apache::lonnet::get('environment',
                         ['notification','critnotification',
       'permanentemail'],
      $udom,$uname);
    &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
    return %loadnames;
       }
   }
   
 # ------------------------------------------------------------------ Screenname  # ------------------------------------------------------------------ Screenname
   
 =pod  =pod
   
 =item screenname($uname,$udom)  =item * screenname($uname,$udom)
   
 Gets a users screenname and returns it as a string  Gets a users screenname and returns it as a string
   
Line 1302  Gets a users screenname and returns it a Line 2152  Gets a users screenname and returns it a
   
 sub screenname {  sub screenname {
     my ($uname,$udom)=@_;      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'};      return $names{'screenname'};
 }  }
   
   
 # ------------------------------------------------------------- Message Wrapper  # ------------------------------------------------------------- Message Wrapper
   
 sub messagewrapper {  sub messagewrapper {
     my ($link,$un,$do)=@_;      my ($link,$username,$domain,$subject,$text)=@_;
     return       return 
 "<a href='/adm/email?compose=individual&recname=$un&recdom=$do'>$link</a>";          '<a href="/adm/email?compose=individual&amp;'.
           'recname='.$username.'&amp;recdom='.$domain.
    '&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
           'title="'.&mt('Send message').'">'.$link.'</a>';
 }  }
 # --------------------------------------------------------------- Notes Wrapper  # --------------------------------------------------------------- Notes Wrapper
   
Line 1324  sub noteswrapper { Line 2179  sub noteswrapper {
 # ------------------------------------------------------------- Aboutme Wrapper  # ------------------------------------------------------------- Aboutme Wrapper
   
 sub aboutmewrapper {  sub aboutmewrapper {
     my ($link,$username,$domain)=@_;      my ($link,$username,$domain,$target)=@_;
     return "<a href='/adm/$domain/$username/aboutme'>$link</a>";      if (!defined($username)  && !defined($domain)) {
           return;
       }
       return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
    ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
 }  }
   
 # ------------------------------------------------------------ Syllabus Wrapper  # ------------------------------------------------------------ Syllabus Wrapper
   
   
 sub syllabuswrapper {  sub syllabuswrapper {
     my ($link,$un,$do,$tf)=@_;      my ($linktext,$coursedir,$domain,$fontcolor)=@_;
     if ($tf) { $link='<font color="'.$tf.'">'.$link.'</font>'; }      if ($fontcolor) { 
     return "<a href='/public/$do/$un/syllabus'>$link</a>";          $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>'; 
       }
       return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
 }  }
   
 # ---------------------------------------------------------------- Language IDs  sub track_student_link {
       my ($linktext,$sname,$sdom,$target,$start) = @_;
       my $link ="/adm/trackstudent?";
       my $title = 'View recent activity';
       if (defined($sname) && $sname !~ /^\s*$/ &&
           defined($sdom)  && $sdom  !~ /^\s*$/) {
           $link .= "selected_student=$sname:$sdom";
           $title .= ' of this student';
       } 
       if (defined($target) && $target !~ /^\s*$/) {
           $target = qq{target="$target"};
       } else {
           $target = '';
       }
       if ($start) { $link.='&amp;start='.$start; }
       
       return qq{<a href="$link" title="$title" $target>$linktext</a>}.
    &help_open_topic('View_recent_activity');
   }
   
   # ===================================================== Display a student photo
   
   
   sub student_image_tag {
       my ($domain,$user)=@_;
       my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
       if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
    return '<img src="'.$imgsrc.'" align="right" />';
       } else {
    return '';
       }
   }
   
   =pod
   
   =back
   
   =head1 Access .tab File Data
   
   =over 4
   
   =item * languageids() 
   
   returns list of all language ids
   
   =cut
   
 sub languageids {  sub languageids {
     return sort(keys(%language));      return sort(keys(%language));
 }  }
   
 # -------------------------------------------------------- Language Description  =pod
   
   =item * languagedescription() 
   
   returns description of a specified language id
   
   =cut
   
 sub languagedescription {  sub languagedescription {
     return $language{shift(@_)};      my $code=shift;
       return  ($supported_language{$code}?'* ':'').
               $language{$code}.
       ($supported_language{$code}?' ('.&mt('interface available').')':'');
 }  }
   
 # ----------------------------------------------------------- Display Languages  sub plainlanguagedescription {
 # returns a hash with all desired display languages      my $code=shift;
 #      return $language{$code};
   }
   
 sub display_languages {  sub supportedlanguagecode {
     my %languages=();      my $code=shift;
     if ($ENV{'environment.languages'}) {      return $supported_language{$code};
  foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'environment.languages'})) {  
     $languages{$_}=1;  
         }  
     }  
     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);  
     if ($ENV{'form.displaylanguage'}) {  
  foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'form.displaylanguage'})) {  
     $languages{$_}=1;  
         }  
     }  
     return %languages;  
 }  }
   
 # --------------------------------------------------------------- Copyright IDs  =pod
   
   =item * copyrightids() 
   
   returns list of all copyrights
   
   =cut
   
 sub copyrightids {  sub copyrightids {
     return sort(keys(%cprtag));      return sort(keys(%cprtag));
 }  }
   
 # ------------------------------------------------------- Copyright Description  =pod
   
   =item * copyrightdescription() 
   
   returns description of a specified copyright id
   
   =cut
   
 sub copyrightdescription {  sub copyrightdescription {
     return $cprtag{shift(@_)};      return &mt($cprtag{shift(@_)});
 }  }
   
 # ------------------------------------------------------------- File Categories  =pod
   
   =item * source_copyrightids() 
   
   returns list of all source copyrights
   
   =cut
   
   sub source_copyrightids {
       return sort(keys(%scprtag));
   }
   
   =pod
   
   =item * source_copyrightdescription() 
   
   returns description of a specified source copyright id
   
   =cut
   
   sub source_copyrightdescription {
       return &mt($scprtag{shift(@_)});
   }
   
   =pod
   
   =item * filecategories() 
   
   returns list of all file categories
   
   =cut
   
 sub filecategories {  sub filecategories {
     return sort(keys(%category_extensions));      return sort(keys(%category_extensions));
 }  }
   
 # -------------------------------------- File Types within a specified category  =pod
   
   =item * filecategorytypes() 
   
   returns list of file types belonging to a given file
   category
   
   =cut
   
 sub filecategorytypes {  sub filecategorytypes {
     return @{$category_extensions{lc($_[0])}};      my ($cat) = @_;
       return @{$category_extensions{lc($cat)}};
 }  }
   
 # ------------------------------------------------------------------ File Types  =pod
 sub fileextensions {  
     return sort(keys(%fe));  =item * fileembstyle() 
 }  
   returns embedding style for a specified file type
   
   =cut
   
 # ------------------------------------------------------------- Embedding Style  
 sub fileembstyle {  sub fileembstyle {
     return $fe{lc(shift(@_))};      return $fe{lc(shift(@_))};
 }  }
   
 # ------------------------------------------------------------ Description Text  sub filemimetype {
       return $fm{lc(shift(@_))};
   }
   
   
   sub filecategoryselect {
       my ($name,$value)=@_;
       return &select_form($value,$name,
    '' => &mt('Any category'),
    map { $_,$_ } sort(keys(%category_extensions)));
   }
   
   =pod
   
   =item * filedescription() 
   
   returns description for a specified file type
   
   =cut
   
 sub filedescription {  sub filedescription {
     return $fd{lc(shift(@_))};      my $file_description = $fd{lc(shift())};
       $file_description =~ s:([\[\]]):~$1:g;
       return &mt($file_description);
 }  }
   
 # ------------------------------------------------------------ Description Text  =pod
   
   =item * filedescriptionex() 
   
   returns description for a specified file type with
   extra formatting
   
   =cut
   
 sub filedescriptionex {  sub filedescriptionex {
     my $ex=shift;      my $ex=shift;
     return '.'.$ex.' '.$fd{lc($ex)};      my $file_description = $fd{lc($ex)};
       $file_description =~ s:([\[\]]):~$1:g;
       return '.'.$ex.' '.&mt($file_description);
   }
   
   # End of .tab access
   =pod
   
   =back
   
   =cut
   
   # ------------------------------------------------------------------ File Types
   sub fileextensions {
       return sort(keys(%fe));
 }  }
   
 # ---- Retrieve attempts by students  # ----------------------------------------------------------- Display Languages
 # input  # returns a hash with all desired display languages
 # $symb             - problem including path  
 # $username,$domain - that of the student  
 # $course           - course name  
 # $getattempt       - leave blank if want all attempts, else put something.  
 # $regexp           - regular expression. If string matches regexp send to  
 # $gradesub         - routine that process the string if it matches regexp  
 #   
 # output  
 # formatted as a table all the attempts, if any.  
 #  #
   
   sub display_languages {
       my %languages=();
       foreach my $lang (&preferred_languages()) {
    $languages{$lang}=1;
       }
       &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
       if ($env{'form.displaylanguage'}) {
    foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
       $languages{$lang}=1;
           }
       }
       return %languages;
   }
   
   sub preferred_languages {
       my @languages=();
       if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
    @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
            $env{'course.'.$env{'request.course.id'}.'.languages'}));
       }
       if ($env{'environment.languages'}) {
    @languages=(@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($env{'user.domain'},'lang_def')) {
    @languages=(@languages,
       &Apache::lonnet::domain($env{'user.domain'},
       'lang_def'));
       }
       if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {
    @languages=(@languages,
       &Apache::lonnet::domain($env{'request.role.domain'},
       'lang_def'));
       }
       if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
    'lang_def')) {
    @languages=(@languages,
       &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
       'lang_def'));
       }
   # turn "en-ca" into "en-ca,en"
       my @genlanguages;
       foreach my $lang (@languages) {
    unless ($lang=~/\w/) { next; }
    push (@genlanguages,$lang);
    if ($lang=~/(\-|\_)/) {
       push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
    }
       }
       return @genlanguages;
   }
   
   ###############################################################
   ##               Student Answer Attempts                     ##
   ###############################################################
   
   =pod
   
   =head1 Alternate Problem Views
   
   =over 4
   
   =item * get_previous_attempt($symb, $username, $domain, $course,
       $getattempt, $regexp, $gradesub)
   
   Return string with previous attempt on problem. Arguments:
   
   =over 4
   
   =item * $symb: Problem, including path
   
   =item * $username: username of the desired student
   
   =item * $domain: domain of the desired student
   
   =item * $course: Course ID
   
   =item * $getattempt: Leave blank for all attempts, otherwise put
       something
   
   =item * $regexp: if string matches this regexp, the string will be
       sent to $gradesub
   
   =item * $gradesub: routine that processes the string if it matches $regexp
   
   =back
   
   The output string is a table containing all desired attempts, if any.
   
   =cut
   
 sub get_previous_attempt {  sub get_previous_attempt {
   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;    my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
   my $prevattempts='';    my $prevattempts='';
Line 1431  sub get_previous_attempt { Line 2524  sub get_previous_attempt {
       my %lasthash=();        my %lasthash=();
       my $version;        my $version;
       for ($version=1;$version<=$returnhash{'version'};$version++) {        for ($version=1;$version<=$returnhash{'version'};$version++) {
         foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) {          foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
   $lasthash{$_}=$returnhash{$version.':'.$_};    $lasthash{$key}=$returnhash{$version.':'.$key};
         }          }
       }        }
       $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';        $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
       $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';        $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
       foreach (sort(keys %lasthash)) {        foreach my $key (sort(keys(%lasthash))) {
  my ($ign,@parts) = split(/\./,$_);   my ($ign,@parts) = split(/\./,$key);
  if ($#parts > 0) {   if ($#parts > 0) {
   my $data=$parts[-1];    my $data=$parts[-1];
   pop(@parts);    pop(@parts);
Line 1454  sub get_previous_attempt { Line 2547  sub get_previous_attempt {
       if ($getattempt eq '') {        if ($getattempt eq '') {
  for ($version=1;$version<=$returnhash{'version'};$version++) {   for ($version=1;$version<=$returnhash{'version'};$version++) {
   $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';    $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
     foreach (sort(keys %lasthash)) {      foreach my $key (sort(keys(%lasthash))) {
        my $value;         my $value;
        if ($_ =~ /timestamp/) {         if ($key =~ /timestamp/) {
   $value=scalar(localtime($returnhash{$version.':'.$_}));    $value=scalar(localtime($returnhash{$version.':'.$key}));
        } else {         } else {
   $value=$returnhash{$version.':'.$_};    $value=$returnhash{$version.':'.$key};
        }         }
        $prevattempts.='<td>'.$value.'&nbsp;</td>';            $prevattempts.='<td>'.&unescape($value).'&nbsp;</td>';   
     }      }
  }   }
       }        }
       $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';        $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
       foreach (sort(keys %lasthash)) {        foreach my $key (sort(keys(%lasthash))) {
  my $value;   my $value;
  if ($_ =~ /timestamp/) {   if ($key =~ /timestamp/) {
   $value=scalar(localtime($lasthash{$_}));    $value=scalar(localtime($lasthash{$key}));
  } else {   } else {
   $value=$lasthash{$_};    $value=$lasthash{$key};
  }   }
  if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}   $value=&unescape($value);
    if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
  $prevattempts.='<td>'.$value.'&nbsp;</td>';   $prevattempts.='<td>'.$value.'&nbsp;</td>';
       }        }
       $prevattempts.='</tr></table></td></tr></table>';        $prevattempts.='</tr></table></td></tr></table>';
Line 1485  sub get_previous_attempt { Line 2579  sub get_previous_attempt {
   }    }
 }  }
   
   sub relative_to_absolute {
       my ($url,$output)=@_;
       my $parser=HTML::TokeParser->new(\$output);
       my $token;
       my $thisdir=$url;
       my @rlinks=();
       while ($token=$parser->get_token) {
    if ($token->[0] eq 'S') {
       if ($token->[1] eq 'a') {
    if ($token->[2]->{'href'}) {
       $rlinks[$#rlinks+1]=$token->[2]->{'href'};
    }
       } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
    $rlinks[$#rlinks+1]=$token->[2]->{'src'};
       } elsif ($token->[1] eq 'base') {
    $thisdir=$token->[2]->{'href'};
       }
    }
       }
       $thisdir=~s-/[^/]*$--;
       foreach my $link (@rlinks) {
    unless (($link=~/^http:\/\//i) ||
    ($link=~/^\//) ||
    ($link=~/^javascript:/i) ||
    ($link=~/^mailto:/i) ||
    ($link=~/^\#/)) {
       my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
       $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
    }
       }
   # -------------------------------------------------- Deal with Applet codebases
       $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
       return $output;
   }
   
   =pod
   
   =item * get_student_view
   
   show a snapshot of what student was looking at
   
   =cut
   
 sub get_student_view {  sub get_student_view {
   my ($symb,$username,$domain,$courseid,$target) = @_;    my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
   my ($map,$id,$feedurl) = split(/___/,$symb);    my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
   my (%old,%moreenv);    my (%form);
   my @elements=('symb','courseid','domain','username');    my @elements=('symb','courseid','domain','username');
   foreach my $element (@elements) {    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});
   my $userview=&Apache::lonnet::ssi('/res/'.$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/\<\/body\>//gi;    $userview=~s/\<\/body\>//gi;
   $userview=~s/\<html\>//gi;    $userview=~s/\<html\>//gi;
Line 1508  sub get_student_view { Line 2643  sub get_student_view {
   $userview=~s/\<head\>//gi;    $userview=~s/\<head\>//gi;
   $userview=~s/\<\/head\>//gi;    $userview=~s/\<\/head\>//gi;
   $userview=~s/action\s*\=/would_be_action\=/gi;    $userview=~s/action\s*\=/would_be_action\=/gi;
     $userview=&relative_to_absolute($feedurl,$userview);
   return $userview;    return $userview;
 }  }
   
   =pod
   
   =item * get_student_answers() 
   
   show a snapshot of how student was answering problem
   
   =cut
   
 sub get_student_answers {  sub get_student_answers {
   my ($symb,$username,$domain,$courseid,%form) = @_;    my ($symb,$username,$domain,$courseid,%form) = @_;
   my ($map,$id,$feedurl) = split(/___/,$symb);    my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
   my (%old,%moreenv);    my (%moreenv);
   my @elements=('symb','courseid','domain','username');    my @elements=('symb','courseid','domain','username');
   foreach my $element (@elements) {    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);
     $feedurl = &Apache::lonnet::clutter($feedurl);
     &Apache::lonenc::check_encrypt(\$feedurl);
     my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
   return $userview;    return $userview;
 }  }
   
   =pod
   
   =item * &submlink()
   
   Inputs: $text $uname $udom $symb $target
   
   Returns: A link to grades.pm such as to see the SUBM view of a student
   
   =cut
   
   ###############################################
   sub submlink {
       my ($text,$uname,$udom,$symb,$target)=@_;
       if (!($uname && $udom)) {
    (my $cursymb, my $courseid,$udom,$uname)=
       &Apache::lonnet::whichuser($symb);
    if (!$symb) { $symb=$cursymb; }
       }
       if (!$symb) { $symb=&Apache::lonnet::symbread(); }
       $symb=&escape($symb);
       if ($target) { $target="target=\"$target\""; }
       return '<a href="/adm/grades?&command=submission&'.
    'symb='.$symb.'&student='.$uname.
    '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
   }
   ##############################################
   
   =pod
   
   =item * &pgrdlink()
   
   Inputs: $text $uname $udom $symb $target
   
   Returns: A link to grades.pm such as to see the PGRD view of a student
   
   =cut
   
   ###############################################
   sub pgrdlink {
       my $link=&submlink(@_);
       $link=~s/(&command=submission)/$1&showgrading=yes/;
       return $link;
   }
   ##############################################
   
   =pod
   
   =item * &pprmlink()
   
   Inputs: $text $uname $udom $symb $target
   
   Returns: A link to parmset.pm such as to see the PPRM view of a
   student and a specific resource
   
   =cut
   
   ###############################################
   sub pprmlink {
       my ($text,$uname,$udom,$symb,$target)=@_;
       if (!($uname && $udom)) {
    (my $cursymb, my $courseid,$udom,$uname)=
       &Apache::lonnet::whichuser($symb);
    if (!$symb) { $symb=$cursymb; }
       }
       if (!$symb) { $symb=&Apache::lonnet::symbread(); }
       $symb=&escape($symb);
       if ($target) { $target="target=\"$target\""; }
       return '<a href="/adm/parmset?&command=set&'.
    'symb='.$symb.'&uname='.$uname.
    '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
   }
   ##############################################
   
   =pod
   
   =back
   
   =cut
   
 ###############################################  ###############################################
   
   
Line 1546  sub timehash { Line 2766  sub timehash {
              'dlsav'   => $ltime[8] );               'dlsav'   => $ltime[8] );
 }  }
   
   sub utc_string {
       my ($date)=@_;
       return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
   }
   
 sub maketime {  sub maketime {
     my %th=@_;      my %th=@_;
     return POSIX::mktime(      return POSIX::mktime(
         ($th{'seconds'},$th{'minutes'},$th{'hours'},          ($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 {  sub findallcourses {
     my $timestamp=shift;      my ($roles,$uname,$udom) = @_;
     if ($timestamp=~/^(\d+)\-(\d+)\-(\d+)\s+(\d+)\:(\d+)\:(\d+)$/) {      my %roles;
        $timestamp=&maketime(      if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
    'year'=>$1,'month'=>$2,'day'=>$3,      my %courses;
            'hours'=>$4,'minutes'=>$5,'seconds'=>$6);      my $now=time;
       if (!defined($uname)) {
           $uname = $env{'user.name'};
       }
       if (!defined($udom)) {
           $udom = $env{'user.domain'};
     }      }
     return $timestamp;      if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
           my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
           if (!%roles) {
               %roles = (
                          cc => 1,
                          in => 1,
                          ep => 1,
                          ta => 1,
                          cr => 1,
                          st => 1,
                );
           }
           foreach my $entry (keys(%roleshash)) {
               my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
               if ($trole =~ /^cr/) { 
                   next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
               } else {
                   next if (!exists($roles{$trole}));
               }
               if ($tend) {
                   next if ($tend < $now);
               }
               if ($tstart) {
                   next if ($tstart > $now);
               }
               my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
               (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
               if ($secpart eq '') {
                   ($cnum,$role) = split(/_/,$cnumpart); 
                   $sec = 'none';
                   $realsec = '';
               } else {
                   $cnum = $cnumpart;
                   ($sec,$role) = split(/_/,$secpart);
                   $realsec = $sec;
               }
               $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
           }
       } else {
           foreach my $key (keys(%env)) {
       if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                    $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
           my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
           next if ($role eq 'ca' || $role eq 'aa');
           next if (%roles && !exists($roles{$role}));
           my ($starttime,$endtime)=split(/\./,$env{$key});
                   my $active=1;
                   if ($starttime) {
       if ($now<$starttime) { $active=0; }
                   }
                   if ($endtime) {
                       if ($now>$endtime) { $active=0; }
                   }
                   if ($active) {
                       if ($sec eq '') {
                           $sec = 'none';
                       }
                       $courses{$cdom.'_'.$cnum}{$sec} = 
                                        $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
                   }
               }
           }
       }
       return %courses;
 }  }
   
 #########################################  ###############################################
   
 sub findallcourses {  sub blockcheck {
     my %courses=();      my ($setters,$activity,$uname,$udom) = @_;
     my $now=time;  
     foreach (keys %ENV) {      if (!defined($udom)) {
  if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {          $udom = $env{'user.domain'};
     my ($starttime,$endtime)=$ENV{$_};      }
             my $active=1;      if (!defined($uname)) {
             if ($starttime) {          $uname = $env{'user.name'};
  if ($now<$starttime) { $active=0; }      }
   
       # If uname and udom are for a course, check for blocks in the course.
   
       if (&Apache::lonnet::is_course($udom,$uname)) {
           my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
           my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
           return ($startblock,$endblock);
       }
   
       my $startblock = 0;
       my $endblock = 0;
       my %live_courses = &findallcourses(undef,$uname,$udom);
   
       # If uname is for a user, and activity is course-specific, i.e.,
       # boards, chat or groups, check for blocking in current course only.
   
       if (($activity eq 'boards' || $activity eq 'chat' ||
            $activity eq 'groups') && ($env{'request.course.id'})) {
           foreach my $key (keys(%live_courses)) {
               if ($key ne $env{'request.course.id'}) {
                   delete($live_courses{$key});
             }              }
             if ($endtime) {          }
                 if ($now>$endtime) { $active=0; }      }
   
       my $otheruser = 0;
       my %own_courses;
       if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
           # Resource belongs to user other than current user.
           $otheruser = 1;
           # Gather courses for current user
           %own_courses = 
               &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
       }
   
       # Gather active course roles - course coordinator, instructor, 
       # exam proctor, ta, student, or custom role.
   
       foreach my $course (keys(%live_courses)) {
           my ($cdom,$cnum);
           if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
               $cdom = $env{'course.'.$course.'.domain'};
               $cnum = $env{'course.'.$course.'.num'};
           } else {
               ($cdom,$cnum) = split(/_/,$course); 
           }
           my $no_ownblock = 0;
           my $no_userblock = 0;
           if ($otheruser && $activity ne 'com') {
               # Check if current user has 'evb' priv for this
               if (defined($own_courses{$course})) {
                   foreach my $sec (keys(%{$own_courses{$course}})) {
                       my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                       if ($sec ne 'none') {
                           $checkrole .= '/'.$sec;
                       }
                       if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                           $no_ownblock = 1;
                           last;
                       }
                   }
               }
               # if they have 'evb' priv and are currently not playing student
               next if (($no_ownblock) &&
                    ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
           }
           foreach my $sec (keys(%{$live_courses{$course}})) {
               my $checkrole = 'cm./'.$cdom.'/'.$cnum;
               if ($sec ne 'none') {
                   $checkrole .= '/'.$sec;
               }
               if ($otheruser) {
                   # Resource belongs to user other than current user.
                   # Assemble privs for that user, and check for 'evb' priv.
                   my ($trole,$tdom,$tnum,$tsec);
                   my $entry = $live_courses{$course}{$sec};
                   if ($entry =~ /^cr/) {
                       ($trole,$tdom,$tnum,$tsec) = 
                         ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   } else {
                       ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   }
                   my ($spec,$area,$trest,%allroles,%userroles);
                   $area = '/'.$tdom.'/'.$tnum;
                   $trest = $tnum;
                   if ($tsec ne '') {
                       $area .= '/'.$tsec;
                       $trest .= '/'.$tsec;
                   }
                   $spec = $trole.'.'.$area;
                   if ($trole =~ /^cr/) {
                       &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                                                         $tdom,$spec,$trest,$area);
                   } else {
                       &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                                                          $tdom,$spec,$trest,$area);
                   }
                   my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                   if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                       if ($1) {
                           $no_userblock = 1;
                           last;
                       }
                   }
               } else {
                   # Resource belongs to current user
                   # Check for 'evb' priv via lonnet::allowed().
                   if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                       $no_ownblock = 1;
                       last;
                   }
               }
           }
           # if they have the evb priv and are currently not playing student
           next if (($no_ownblock) &&
                    ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
           next if ($no_userblock);
   
           # Retrieve blocking times and identity of blocker for course
           # of specified user, unless user has 'evb' privilege.
           
           my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
           if (($start != 0) && 
               (($startblock == 0) || ($startblock > $start))) {
               $startblock = $start;
           }
           if (($end != 0)  &&
               (($endblock == 0) || ($endblock < $end))) {
               $endblock = $end;
           }
       }
       return ($startblock,$endblock);
   }
   
   sub get_blocks {
       my ($setters,$activity,$cdom,$cnum) = @_;
       my $startblock = 0;
       my $endblock = 0;
       my $course = $cdom.'_'.$cnum;
       $setters->{$course} = {};
       $setters->{$course}{'staff'} = [];
       $setters->{$course}{'times'} = [];
       my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
       foreach my $record (keys(%records)) {
           my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
           if ($start <= time && $end >= time) {
               my ($staff_name,$staff_dom,$title,$blocks) =
                   &parse_block_record($records{$record});
               if ($blocks->{$activity} eq 'on') {
                   push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   if ( ($startblock == 0) || ($startblock > $start) ) {
                       $startblock = $start;
                   }
                   if ( ($endblock == 0) || ($endblock < $end) ) {
                       $endblock = $end;
                   }
             }              }
             if ($active) { $courses{$1.'_'.$2}=1; }  
         }          }
     }      }
     return keys %courses;      return ($startblock,$endblock);
   }
   
   sub parse_block_record {
       my ($record) = @_;
       my ($setuname,$setudom,$title,$blocks);
       if (ref($record) eq 'HASH') {
           ($setuname,$setudom) = split(/:/,$record->{'setter'});
           $title = &unescape($record->{'event'});
           $blocks = $record->{'blocks'};
       } else {
           my @data = split(/:/,$record,3);
           if (scalar(@data) eq 2) {
               $title = $data[1];
               ($setuname,$setudom) = split(/@/,$data[0]);
           } else {
               ($setuname,$setudom,$title) = @data;
           }
           $blocks = { 'com' => 'on' };
       }
       return ($setuname,$setudom,$title,$blocks);
   }
   
   sub build_block_table {
       my ($startblock,$endblock,$setters) = @_;
       my %lt = &Apache::lonlocal::texthash(
           'cacb' => 'Currently active communication blocks',
           'cour' => 'Course',
           'dura' => 'Duration',
           'blse' => 'Block set by'
       );
       my $output;
       $output = '<br />'.$lt{'cacb'}.':<br />';
       $output .= &start_data_table();
       $output .= '
   <tr>
    <th>'.$lt{'cour'}.'</th>
    <th>'.$lt{'dura'}.'</th>
    <th>'.$lt{'blse'}.'</th>
   </tr>
   ';
       foreach my $course (keys(%{$setters})) {
           my %courseinfo=&Apache::lonnet::coursedescription($course);
           for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
               my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
               my $fullname = &plainname($uname,$udom);
               if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   && $env{'user.name'} ne 'public' 
                   && $env{'user.domain'} ne 'public') {
                   $fullname = &aboutmewrapper($fullname,$uname,$udom);
               }
               my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
               $openblock = &Apache::lonlocal::locallocaltime($openblock);
               $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
               $output .= &Apache::loncommon::start_data_table_row().
                          '<td>'.$courseinfo{'description'}.'</td>'.
                          '<td>'.$openblock.' to '.$closeblock.'</td>'.
                          '<td>'.$fullname.'</td>'.
                           &Apache::loncommon::end_data_table_row();
           }
       }
       $output .= &end_data_table();
   }
   
   sub blocking_status {
       my ($activity,$uname,$udom) = @_;
       my %setters;
       my ($blocked,$output,$ownitem,$is_course);
       my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
       if ($startblock && $endblock) {
           $blocked = 1;
           if (wantarray) {
               my $category;
               if ($activity eq 'boards') {
                   $category = 'Discussion posts in this course';
               } elsif ($activity eq 'blogs') {
                   $category = 'Blogs';
               } elsif ($activity eq 'port') {
                   if (defined($uname) && defined($udom)) {
                       if ($uname eq $env{'user.name'} &&
                           $udom eq $env{'user.domain'}) {
                           $ownitem = 1;
                       }
                   }
                   $is_course = &Apache::lonnet::is_course($udom,$uname);
                   if ($ownitem) { 
                       $category = 'Your portfolio files';  
                   } elsif ($is_course) {
                       my $coursedesc;
                       foreach my $course (keys(%setters)) {
                           my %courseinfo =
                                &Apache::lonnet::coursedescription($course);
                           $coursedesc = $courseinfo{'description'};
                       }
                       $category = "Group files in the course '$coursedesc'";
                   } else {
                       $category = 'Portfolio files belonging to ';
                       if ($env{'user.name'} eq 'public' && 
                           $env{'user.domain'} eq 'public') {
                           $category .= &plainname($uname,$udom);
                       } else {
                           $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                       }
                   }
               } elsif ($activity eq 'groups') {
                   $category = 'Groups in this course';
               }
               my $showstart = &Apache::lonlocal::locallocaltime($startblock);
               my $showend = &Apache::lonlocal::locallocaltime($endblock);
               $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
               if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   $output .= &build_block_table($startblock,$endblock,\%setters);
               }
           }
       }
       if (wantarray) {
           return ($blocked,$output);
       } else {
           return $blocked;
       }
 }  }
   
 ###############################################  
 ###############################################  ###############################################
   
 =pod  =pod
   
 =item &determinedomain()  =head1 Domain Template Functions
   
   =over 4
   
   =item * &determinedomain()
   
 Inputs: $domain (usually will be undef)  Inputs: $domain (usually will be undef)
   
Line 1605  Returns: Determines which domain should Line 3170  Returns: Determines which domain should
 ###############################################  ###############################################
 sub determinedomain {  sub determinedomain {
     my $domain=shift;      my $domain=shift;
    if (! $domain) {      if (! $domain) {
         # Determine domain if we have not been given one          # Determine domain if we have not been given one
         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};          $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;      return $domain;
 }  }
 ###############################################  ###############################################
   
   sub devalidate_domconfig_cache {
       my ($udom)=@_;
       &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
   }
   
   # ---------------------- Get domain configuration for a domain
   sub get_domainconf {
       my ($udom) = @_;
       my $cachetime=1800;
       my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
       if (defined($cached)) { return %{$result}; }
   
       my %domconfig = &Apache::lonnet::get_dom('configuration',
        ['login','rolecolors'],$udom);
       my %designhash;
       if (keys(%domconfig) > 0) {
           if (ref($domconfig{'login'}) eq 'HASH') {
               foreach my $key (keys(%{$domconfig{'login'}})) {
                   $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
               }
           }
           if (ref($domconfig{'rolecolors'}) eq 'HASH') {
               foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                       foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                           $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                       }
                   }
               }
           }
       } else {
           my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
           my $designfile =  $designdir.'/'.$udom.'.tab';
           if (-e $designfile) {
               if ( open (my $fh,"<$designfile") ) {
                   while (my $line = <$fh>) {
                       next if ($line =~ /^\#/);
                       chomp($line);
                       my ($key,$val)=(split(/\=/,$line));
                       if ($val) { $designhash{$udom.'.'.$key}=$val; }
                   }
                   close($fh);
               }
           }
           if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
               $designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
           }
       }
       &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
     $cachetime);
       return %designhash;
   }
   
 =pod  =pod
   
 =item &domainlogo()  =item * &domainlogo()
   
 Inputs: $domain (usually will be undef)  Inputs: $domain (usually will be undef)
   
Line 1626  Returns: A link to a domain logo, if the Line 3245  Returns: A link to a domain logo, if the
 If the domain logo does not exist, a description of the domain.  If the domain logo does not exist, a description of the domain.
   
 =cut  =cut
   
 ###############################################  ###############################################
 sub domainlogo {  sub domainlogo {
     my $domain = &determinedomain(shift);          my $domain = &determinedomain(shift);
      # See if there is a logo      my %designhash = &get_domainconf($domain);    
     if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {      # See if there is a logo
  my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};      if ($designhash{$domain.'.login.domlogo'} ne '') {
  if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }          my $imgsrc = $designhash{$domain.'.login.domlogo'};
         return '<img src="http://'.$ENV{'HTTP_HOST'}.':'.$lonhttpdPort.          if ($imgsrc =~ m{^/(adm|res)/}) {
     '/adm/lonDomLogos/'.$domain.'.gif" />';      if ($imgsrc =~ m{^/res/}) {
     } elsif(exists($Apache::lonnet::domaindescription{$domain})) {   my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
         return $Apache::lonnet::domaindescription{$domain};   &Apache::lonnet::repcopy($local_name);
       }
      $imgsrc = &lonhttpdurl($imgsrc);
           } 
           return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
       } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
           return &Apache::lonnet::domain($domain,'description');
     } else {      } else {
         return '';          return '';
     }      }
Line 1645  sub domainlogo { Line 3271  sub domainlogo {
   
 =pod  =pod
   
 =item &designparm()  =item * &designparm()
   
 Inputs: $which parameter; $domain (usually will be undef)  Inputs: $which parameter; $domain (usually will be undef)
   
 Returns: value of designparamter $which  Returns: value of designparamter $which
   
 =cut  =cut
   
   
 ##############################################  ##############################################
 sub designparm {  sub designparm {
     my ($which,$domain)=@_;      my ($which,$domain)=@_;
     if ($ENV{'environment.color.'.$which}) {      if ($env{'browser.blackwhite'} eq 'on') {
  return $ENV{'environment.color.'.$which};   if ($which=~/\.(font|alink|vlink|link)$/) {
       return '#000000';
    }
    if ($which=~/\.(pgbg|sidebg)$/) {
       return '#FFFFFF';
    }
    if ($which=~/\.tabbg$/) {
       return '#CCCCCC';
    }
       }
       if (exists($env{'environment.color.'.$which})) {
    return $env{'environment.color.'.$which};
     }      }
     $domain=&determinedomain($domain);      $domain=&determinedomain($domain);
     if ($designhash{$domain.'.'.$which}) {      my %domdesign = &get_domainconf($domain);
  return $designhash{$domain.'.'.$which};      my $output;
       if ($domdesign{$domain.'.'.$which} ne '') {
    $output = $domdesign{$domain.'.'.$which};
     } else {      } else {
         return $designhash{'default.'.$which};          $output = $defaultdesign{$which};
     }      }
       if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
           ($which =~ /login\.(img|logo|domlogo)/)) {
           if ($output =~ m{^/(adm|res)/}) {
       if ($output =~ m{^/res/}) {
    my $local_name = &Apache::lonnet::filelocation('',$output);
    &Apache::lonnet::repcopy($local_name);
       }
               $output = &lonhttpdurl($output);
           }
       }
       return $output;
 }  }
   
 ###############################################  ###############################################
Line 1671  sub designparm { Line 3323  sub designparm {
   
 =pod  =pod
   
 =item &bodytag()  =back
   
   =head1 HTTP Helpers
   
   =over 4
   
   =item * &bodytag()
   
 Returns a uniform header for LON-CAPA web pages.  Returns a uniform header for LON-CAPA web pages.
   
 Inputs:   Inputs: 
   
  $title, A title to be displayed on the page.  =over 4
  $function, the current role (can be undef).  
  $addentries, extra parameters for the <body> tag.  =item * $title, A title to be displayed on the page.
  $bodyonly, if defined, only return the <body> tag.  
  $domain, if defined, force a given domain.  =item * $function, the current role (can be undef).
  $forcereg, if page should register as content page (relevant for   
   =item * $addentries, extra parameters for the <body> tag.
   
   =item * $bodyonly, if defined, only return the <body> tag.
   
   =item * $domain, if defined, force a given domain.
   
   =item * $forcereg, if page should register as content page (relevant for 
             text interface only)              text interface only)
   
   =item * $customtitle, alternate text to use instead of $title
                         in the title box that appears, this text
                         is not auto translated like the $title is
   
   =item * $notopbar, if true, keep the 'what is this' info but remove the
                      navigational links
   
   =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
   
   =item * $notitle, if true keep the nav controls, but remove the title bar
   
   =item * $no_inline_link, if true and in remote mode, don't show the 
            'Switch To Inline Menu' link
   
   =item * $args, optional argument valid values are
               no_auto_mt_title -> prevents &mt()ing the title arg
   
   =back
   
 Returns: A uniform header for LON-CAPA web pages.    Returns: A uniform header for LON-CAPA web pages.  
 If $bodyonly is nonzero, a string containing a <body> tag will be returned.  If $bodyonly is nonzero, a string containing a <body> tag will be returned.
 If $bodyonly is undef or zero, an html string containing a <body> tag and   If $bodyonly is undef or zero, an html string containing a <body> tag and 
Line 1692  other decorations will be returned. Line 3376  other decorations will be returned.
   
 =cut  =cut
   
 ###############################################  sub bodytag {
       my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
    $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
   
       if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
   
 ###############################################      $function = &get_users_function() if (!$function);
 sub bodytag {      my $img =    &designparm($function.'.img',$domain);
     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg)=@_;      my $font =   &designparm($function.'.font',$domain);
     unless ($function) {      my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
  $function='student';  
         if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {      my %design = ( 'style'   => 'margin-top: 0px',
     $function='coordinator';     'bgcolor' => $pgbg,
         }     'text'    => $font,
  if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) {                     'alink'   => &designparm($function.'.alink',$domain),
             $function='admin';     'vlink'   => &designparm($function.'.vlink',$domain),
         }     'link'    => &designparm($function.'.link',$domain),);
         if (($ENV{'request.role'}=~/^(au|ca)/) ||      @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
             ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {  
             $function='author';  
         }  
     }  
     my $img=&designparm($function.'.img',$domain);  
     my $pgbg=&designparm($function.'.pgbg',$domain);  
     my $tabbg=&designparm($function.'.tabbg',$domain);  
     my $font=&designparm($function.'.font',$domain);  
     my $link=&designparm($function.'.link',$domain);  
     my $alink=&designparm($function.'.alink',$domain);  
     my $vlink=&designparm($function.'.vlink',$domain);  
     my $sidebg=&designparm($function.'.sidebg',$domain);  
   
  # role and realm   # role and realm
     my ($role,$realm)      my ($role,$realm) = split(/\./,$env{'request.role'},2);
        =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]);      if ($role  eq 'ca') {
           my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
           $realm = &plainname($rname,$rdom);
       } 
 # realm  # realm
     if ($ENV{'request.course.id'}) {      if ($env{'request.course.id'}) {
  $realm=          if ($env{'request.role'} !~ /^cr/) {
          $ENV{'course.'.$ENV{'request.course.id'}.'.description'};              $role = &Apache::lonnet::plaintext($role,&course_type());
           }
    $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
       } else {
           $role = &Apache::lonnet::plaintext($role);
     }      }
     unless ($realm) { $realm='&nbsp;'; }  
       if (!$realm) { $realm='&nbsp;'; }
 # Set messages  # Set messages
     my $messages=&domainlogo($domain);      my $messages=&domainlogo($domain);
 # Output  # Port for miniserver
     my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};      my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
     if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }      if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
     my $bodytag = <<END;  
 <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"      my $extra_body_attr = &make_attr_string($forcereg,\%design);
 $addentries>  
 END  # construct main body tag
     my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.      my $bodytag = "<body $extra_body_attr>".
                    $lonhttpdPort.$img.'" />';   &Apache::lontexconvert::init_math_support();
   
     if ($bodyonly) {      if ($bodyonly) {
         return $bodytag;          return $bodytag;
     } elsif ($ENV{'browser.interface'} eq 'textual') {      } elsif ($env{'browser.interface'} eq 'textual') {
 # Accessibility  # Accessibility
         return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',            
                                                       $forcereg).   $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
                '<h1>LON-CAPA: '.$title.'</h1>';   if (!$notitle) {
     } elsif ($ENV{'environment.remote'} eq 'off') {      $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
 # No Remote   }
         return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',   return $bodytag;
                                                       $forcereg).      }
                '<table bgcolor="'.$pgbg.'" width="100%" border="0" cellspacing="3" cellpadding="3"><tr><td bgcolor="'.$tabbg.'"><font size="+3" color="'.$font.'"><b>'.$title.  
 '</b></font></td></tr></table>';      my $name = &plainname($env{'user.name'},$env{'user.domain'});
       if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
    undef($role);
       } else {
    $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
       }
       
       my $roleinfo=(<<ENDROLE);
   <td class="LC_title_bar_who">
   <div class="LC_title_bar_name">
       $name
       &nbsp;
   </div>
   <div class="LC_title_bar_role">
   $role&nbsp;
   </div>
   <div class="LC_title_bar_realm">
   $realm&nbsp;
   </div>
   </td>
   ENDROLE
   
       my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
       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 =~ s/\s+$//;
           $dc_info = '('.$dc_info.')';
       }
   
       if ($env{'environment.remote'} eq 'off') {
           # No Remote
    if ($env{'request.state'} eq 'construct') {
       $forcereg=1;
    }
   
    if (!$customtitle && $env{'request.state'} eq 'construct') {
       # this is for resources; directories have customtitle, and crumbs
               # and select recent are created in lonpubdir.pm  
       my ($uname,$thisdisfn)=
    ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
       my $formaction='/priv/'.$uname.'/'.$thisdisfn;
       $formaction=~s/\/+/\//g;
   
       my $parentpath = '';
       my $lastitem = '';
       if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
    $parentpath = $1;
    $lastitem = $2;
       } else {
    $lastitem = $thisdisfn;
       }
       $titleinfo = 
    &Apache::loncommon::help_open_menu('','',3,'Authoring').
    '<b>Construction Space</b>:&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();
           }
   
           my $titletable;
    if (!$notitle) {
       $titletable =
    '<table id="LC_title_bar">'.
                            "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
    '</tr></table>';
    }
    if ($notopbar) {
       $bodytag .= $titletable;
    } else {
       if ($env{'request.state'} eq 'construct') {
                   $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
     $titletable);
               } else {
                   $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
       $titletable;
               }
           }
           return $bodytag;
     }      }
   
 #  #
 # Top frame rendering, Remote is up  # Top frame rendering, Remote is up
 #  #
   
       my $imgsrc = $img;
       if ($img =~ /^\/adm/) {
           $imgsrc = 'http://'.$ENV{'HTTP_HOST'}.':'.$lonhttpdPort.$img;
       }
       my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
   
       # Explicit link to get inline menu
       my $menu= ($no_inline_link?''
          :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
       #
       if ($notitle) {
    return $bodytag;
       }
     return(<<ENDBODY);      return(<<ENDBODY);
 $bodytag  $bodytag
 <table width="100%" cellspacing="0" border="0" cellpadding="0">  <table id="LC_title_bar" class="LC_with_remote">
 <tr><td bgcolor="$sidebg">  <tr><td class="LC_title_bar_role_logo">$upperleft</td>
 $upperleft</td>      <td class="LC_title_bar_domain_logo">$messages&nbsp;</td>
 <td bgcolor="$sidebg" align="right">$messages&nbsp;</td>  
 </tr>  </tr>
 <tr>  <tr><td>$titleinfo $dc_info $menu</td>
 <td rowspan="3" bgcolor="$tabbg">  $roleinfo
 &nbsp;<font size="5"><b>$title</b></font>  
 <td bgcolor="$tabbg"  align="right">  
 <font size="2">  
     $ENV{'environment.firstname'}  
     $ENV{'environment.middlename'}  
     $ENV{'environment.lastname'}  
     $ENV{'environment.generation'}  
     </font>&nbsp;  
 </td>  
 </tr>  </tr>
 <tr><td bgcolor="$tabbg" align="right">  </table>
 <font size="2">$role</font>&nbsp;  
 </td></tr>  
 <tr>  
 <td bgcolor="$tabbg" align="right"><font size="2">$realm</font>&nbsp;</td></tr>  
 </table><br>  
 ENDBODY  ENDBODY
 }  }
   
   sub make_attr_string {
       my ($register,$attr_ref) = @_;
   
       if ($attr_ref && !ref($attr_ref)) {
    die("addentries Must be a hash ref ".
       join(':',caller(1))." ".
       join(':',caller(0))." ");
       }
   
       if ($register) {
    my ($on_load,$on_unload);
    foreach my $key (keys(%{$attr_ref})) {
       if      (lc($key) eq 'onload') {
    $on_load.=$attr_ref->{$key}.';';
    delete($attr_ref->{$key});
   
       } elsif (lc($key) eq 'onunload') {
    $on_unload.=$attr_ref->{$key}.';';
    delete($attr_ref->{$key});
       }
    }
    $attr_ref->{'onload'}  =
       &Apache::lonmenu::loadevents().  $on_load;
    $attr_ref->{'onunload'}=
       &Apache::lonmenu::unloadevents().$on_unload;
       }
   
   # Accessibility font enhance
       if ($env{'browser.fontenhance'} eq 'on') {
    my $style;
    foreach my $key (keys(%{$attr_ref})) {
       if (lc($key) eq 'style') {
    $style.=$attr_ref->{$key}.';';
    delete($attr_ref->{$key});
       }
    }
    $attr_ref->{'style'}=$style.'; font-size: x-large;';
       }
   
       if ($env{'browser.blackwhite'} eq 'on') {
    delete($attr_ref->{'font'});
    delete($attr_ref->{'link'});
    delete($attr_ref->{'alink'});
    delete($attr_ref->{'vlink'});
    delete($attr_ref->{'bgcolor'});
    delete($attr_ref->{'background'});
       }
   
       my $attr_string;
       foreach my $attr (keys(%$attr_ref)) {
    $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
       }
       return $attr_string;
   }
   
   
   ###############################################
 ###############################################  ###############################################
   
 sub get_posted_cgi {  =pod
     my $r=shift;  
   
     my $buffer;  =back
   
   =head1 HTML Helpers
   
   =over 4
   
   =item * &endbodytag()
   
   Returns a uniform footer for LON-CAPA web pages.
   
   Inputs: none
   
   =back
   
   =cut
   
   sub endbodytag {
       my $endbodytag='</body>';
       $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
       if ( exists( $env{'internal.head.redirect'} ) ) {
    $endbodytag=
       "<br /><a href=\"$env{'internal.head.redirect'}\">".
       &mt('Continue').'</a>'.
       $endbodytag;
       }
       return $endbodytag;
   }
   
   =pod
   
   =over 4
   
   =item * &standard_css()
   
   Returns a style sheet
   
   Inputs: (all optional)
               domain         -> force to color decorate a page for a specific
                                  domain
               function       -> force usage of a specific rolish color scheme
               bgcolor        -> override the default page bgcolor
   
   =back
   
   =cut
   
   sub standard_css {
       my ($function,$domain,$bgcolor) = @_;
       $function  = &get_users_function() if (!$function);
       my $img    = &designparm($function.'.img',   $domain);
       my $tabbg  = &designparm($function.'.tabbg', $domain);
       my $font   = &designparm($function.'.font',  $domain);
       my $sidebg = &designparm($function.'.sidebg',$domain);
       my $pgbg_or_bgcolor =
            $bgcolor ||
            &designparm($function.'.pgbg',  $domain);
       my $pgbg   = &designparm($function.'.pgbg',  $domain);
       my $alink  = &designparm($function.'.alink', $domain);
       my $vlink  = &designparm($function.'.vlink', $domain);
       my $link   = &designparm($function.'.link',  $domain);
   
       my $sans                 = 'Arial,Helvetica,sans-serif';
       my $mono                 = 'monospace';
       my $data_table_head      = $tabbg;
       my $data_table_light     = '#EEEEEE';
       my $data_table_dark      = '#DDDDDD';
       my $data_table_darker    = '#CCCCCC';
       my $data_table_highlight = '#FFFF00';
       my $mail_new             = '#FFBB77';
       my $mail_new_hover       = '#DD9955';
       my $mail_read            = '#BBBB77';
       my $mail_read_hover      = '#999944';
       my $mail_replied         = '#AAAA88';
       my $mail_replied_hover   = '#888855';
       my $mail_other           = '#99BBBB';
       my $mail_other_hover     = '#669999';
       my $table_header         = '#DDDDDD';
       my $feedback_link_bg     = '#BBBBBB';
   
       my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
                                                 : '0px 3px 0px 4px';
   
   
       return <<END;
   h1, h2, h3, th { font-family: $sans }
   a:focus { color: red; background: yellow } 
   table.thinborder,
   
   table.thinborder tr th {
     border-style: solid;
     border-width: 1px;
     background: $tabbg;
   }
   table.thinborder tr td {
     border-style: solid;
     border-width: 1px
   }
   
   form, .inline { display: inline; }
   .center { text-align: center; }
   .LC_filename {font-family: $mono;}
   .LC_error {
     color: red;
     font-size: larger;
   }
   .LC_warning,
   .LC_diff_removed {
     color: red;
   }
   
   .LC_info,
   .LC_success,
   .LC_diff_added {
     color: green;
   }
   .LC_icon {
     border: 0px;
   }
   .LC_indexer_icon {
     border: 0px;
     height: 22px;
   }
   
   .LC_internal_info {
     color: #999;
   }
   
   table.LC_pastsubmission {
     border: 1px solid black;
     margin: 2px;
   }
   
   table#LC_top_nav, table#LC_menubuttons {
     width: 100%;
     background: $pgbg;
     border: 2px;
     border-collapse: separate;
     padding: 0px;
   }
   
   table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,
   table#LC_title_bar.LC_with_remote {
     width: 100%;
     border-color: $pgbg;
     border-style: solid;
     border-width: $border;
   
     background: $pgbg;
     font-family: $sans;
     border-collapse: collapse;
     padding: 0px;
   }
   
   table.LC_docs_path {
     width: 100%;
     border: 0;
     background: $pgbg;
     font-family: $sans;
     border-collapse: collapse;
     padding: 0px;
   }
   
   table#LC_title_bar td {
     background: $tabbg;
   }
   table#LC_title_bar td.LC_title_bar_who {
     background: $tabbg;
     color: $font;
     font: small $sans;
     text-align: right;
   }
   span.LC_metadata {
       font-family: $sans;
   }
   span.LC_title_bar_title {
     font: bold x-large $sans;
   }
   table#LC_title_bar td.LC_title_bar_domain_logo {
     background: $sidebg;
     text-align: right;
     padding: 0px;
   }
   table#LC_title_bar td.LC_title_bar_role_logo {
     background: $sidebg;
     padding: 0px;
   }
   
   table#LC_menubuttons_mainmenu {
     width: 100%;
     border: 0px;
     border-spacing: 1px;
     padding: 0px 1px;
     margin: 0px;
     border-collapse: separate;
   }
   table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
     border: 0px;
   }
   table#LC_top_nav td {
     background: $tabbg;
     border: 0px;
     font-size: small;
   }
   table#LC_top_nav td a, div#LC_top_nav a {
     color: $font;
     font-family: $sans;
   }
   table#LC_top_nav td.LC_top_nav_logo {
     background: $tabbg;
     text-align: left;
     white-space: nowrap;
     width: 31px;
   }
   table#LC_top_nav td.LC_top_nav_logo img {
     border: 0px;
     vertical-align: bottom;
   }
   table#LC_top_nav td.LC_top_nav_exit,
   table#LC_top_nav td.LC_top_nav_help {
     width: 2.0em;
   }
   table#LC_top_nav td.LC_top_nav_login {
     width: 4.0em;
     text-align: center;
   }
   table.LC_breadcrumbs td, table.LC_docs_path td  {
     background: $tabbg;
     color: $font;
     font-family: $sans;
     font-size: smaller;
   }
   table.LC_breadcrumbs td.LC_breadcrumbs_component,
   table.LC_docs_path td.LC_docs_path_component {
     background: $tabbg;
     color: $font;
     font-family: $sans;
     font-size: larger;
     text-align: right;
   }
   td.LC_table_cell_checkbox {
     text-align: center;
   }
   
   table#LC_mainmenu td.LC_mainmenu_column {
       vertical-align: top;
   }
   
   .LC_menubuttons_inline_text {
     color: $font;
     font-family: $sans;
     font-size: smaller;
   }
   
   .LC_menubuttons_link {
     text-decoration: none;
   }
   
   .LC_menubuttons_category {
     color: $font;
     background: $pgbg;
     font-family: $sans;
     font-size: larger;
     font-weight: bold;
   }
   
   td.LC_menubuttons_text {
     width: 90%;
     color: $font;
     font-family: $sans;
   }
   
   td.LC_menubuttons_img {
   }
   
   .LC_current_location {
     font-family: $sans;
     background: $tabbg;
   }
   .LC_new_mail {
     font-family: $sans;
     font-weight: bold;
   }
   
   .LC_rolesmenu_is {
     font-family: $sans;
   }
   
   .LC_rolesmenu_selected {
     font-family: $sans;
   }
   
   .LC_rolesmenu_future {
     font-family: $sans;
   }
   
   
   .LC_rolesmenu_will {
     font-family: $sans;
   }
   
   .LC_rolesmenu_will_not {
     font-family: $sans;
   }
   
   .LC_rolesmenu_expired {
     font-family: $sans;
   }
   
   .LC_rolesinfo {
     font-family: $sans;
   }
   
   .LC_dropadd_labeltext {
     font-family: $sans;
     text-align: right;
   }
   
   .LC_preferences_labeltext {
     font-family: $sans;
     text-align: right;
   }
   
   table.LC_aboutme_port {
     border: 0px;
     border-collapse: collapse;
     border-spacing: 0px;
   }
   table.LC_data_table, table.LC_mail_list {
     border: 1px solid #000000;
     border-collapse: separate;
     border-spacing: 1px;
   }
   .LC_data_table_dense {
     font-size: small;
   }
   table.LC_nested_outer {
     border: 1px solid #000000;
     border-collapse: separate;
     border-spacing: 0px;
     width: 100%;
   }
   table.LC_nested {
     border: 0px;
     border-collapse: separate;
     border-spacing: 0px;
     width: 100%;
   }
   table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
   table.LC_prior_tries tr th {
     font-weight: bold;
     background-color: $data_table_head;
     font-size: smaller;
   }
   table.LC_data_table tr td, 
   table.LC_aboutme_port tr td {
     background-color: $data_table_light;
     padding: 2px;
   }
   table.LC_data_table tr.LC_even_row td,
   table.LC_aboutme_port tr.LC_even_row td {
     background-color: $data_table_dark;
   }
   table.LC_data_table tr.LC_data_table_highlight td {
     background-color: $data_table_darker;
   }
   table.LC_data_table tr.LC_empty_row td,
   table.LC_nested tr.LC_empty_row td {
     background-color: #FFFFFF;
     font-weight: bold;
     font-style: italic;
     text-align: center;
     padding: 8px;
   }
   table.LC_nested tr.LC_empty_row td {
     padding: 4ex
   }
   table.LC_nested_outer tr th {
     font-weight: bold;
     background-color: $data_table_head;
     font-size: smaller;
     border-bottom: 1px solid #000000;
   }
   table.LC_nested_outer tr td.LC_subheader {
     background-color: $data_table_head;
     font-weight: bold;
     font-size: small;
     border-bottom: 1px solid #000000;
     text-align: right;
   }
   table.LC_nested tr.LC_info_row td {
     background-color: #CCC;
     font-weight: bold;
     font-size: small;
     text-align: center;
   }
   table.LC_nested tr.LC_info_row td.LC_left_item {
     text-align: left;
   }
   table.LC_nested td {
     background-color: #FFF;
     font-size: small;
   }
   table.LC_nested_outer tr th.LC_right_item,
   table.LC_nested tr.LC_info_row td.LC_right_item,
   table.LC_nested tr.LC_odd_row td.LC_right_item,
   table.LC_nested tr td.LC_right_item {
     text-align: right;
   }
   
   table.LC_nested tr.LC_odd_row td {
     background-color: #EEE;
   }
   
   table.LC_createuser {
   }
   
   table.LC_createuser tr.LC_section_row td {
     font-size: smaller;
   }
   
   table.LC_createuser tr.LC_info_row td  {
     background-color: #CCC;
     font-weight: bold;
     text-align: center;
   }
   
   table.LC_calendar {
     border: 1px solid #000000;
     border-collapse: collapse;
   }
   table.LC_calendar_pickdate {
     font-size: xx-small;
   }
   table.LC_calendar tr td {
     border: 1px solid #000000;
     vertical-align: top;
   }
   table.LC_calendar tr td.LC_calendar_day_empty {
     background-color: $data_table_dark;
   }
   table.LC_calendar tr td.LC_calendar_day_current {
     background-color: $data_table_highlight;
   }
   
   table.LC_mail_list tr.LC_mail_new {
     background-color: $mail_new;
   }
   table.LC_mail_list tr.LC_mail_new:hover {
     background-color: $mail_new_hover;
   }
   table.LC_mail_list tr.LC_mail_read {
     background-color: $mail_read;
   }
   table.LC_mail_list tr.LC_mail_read:hover {
     background-color: $mail_read_hover;
   }
   table.LC_mail_list tr.LC_mail_replied {
     background-color: $mail_replied;
   }
   table.LC_mail_list tr.LC_mail_replied:hover {
     background-color: $mail_replied_hover;
   }
   table.LC_mail_list tr.LC_mail_other {
     background-color: $mail_other;
   }
   table.LC_mail_list tr.LC_mail_other:hover {
     background-color: $mail_other_hover;
   }
   table.LC_mail_list tr.LC_mail_even {
   }
   table.LC_mail_list tr.LC_mail_odd {
   }
   
   
   table#LC_portfolio_actions {
     width: auto;
     background: $pgbg;
     border: 0px;
     border-spacing: 2px 2px;
     padding: 0px;
     margin: 0px;
     border-collapse: separate;
   }
   table#LC_portfolio_actions td.LC_label {
     background: $tabbg;
     text-align: right;
   }
   table#LC_portfolio_actions td.LC_value {
     background: $tabbg;
   }
   
   table#LC_cstr_controls {
     width: 100%;
     border-collapse: collapse;
   }
   table#LC_cstr_controls tr td {
     border: 4px solid $pgbg;
     padding: 4px;
     text-align: center;
     background: $tabbg;
   }
   table#LC_cstr_controls tr th {
     border: 4px solid $pgbg;
     background: $table_header;
     text-align: center;
     font-family: $sans;
     font-size: smaller;
   }
   
   table#LC_browser {
    
   }
   table#LC_browser tr th {
     background: $table_header;
   }
   table#LC_browser tr td {
     padding: 2px;
   }
   table#LC_browser tr.LC_browser_file,
   table#LC_browser tr.LC_browser_file_published {
     background: #CCFF88;
   }
   table#LC_browser tr.LC_browser_file_locked,
   table#LC_browser tr.LC_browser_file_unpublished {
     background: #FFAA99;
   }
   table#LC_browser tr.LC_browser_file_obsolete {
     background: #AAAAAA;
   }
   table#LC_browser tr.LC_browser_file_modified,
   table#LC_browser tr.LC_browser_file_metamodified {
     background: #FFFF77;
   }
   table#LC_browser tr.LC_browser_folder {
     background: #CCCCFF;
   }
   span.LC_current_location {
     font-size: x-large;
     background: $pgbg;
   }
   
   span.LC_parm_menu_item {
     font-size: larger;
     font-family: $sans;
   }
   span.LC_parm_scope_all {
     color: red;
   }
   span.LC_parm_scope_folder {
     color: green;
   }
   span.LC_parm_scope_resource {
     color: orange;
   }
   span.LC_parm_part {
     color: blue;
   }
   span.LC_parm_folder, span.LC_parm_symb {
     font-size: x-small;
     font-family: $mono;
     color: #AAAAAA;
   }
   
   td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
   td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
     border: 1px solid black;
     border-collapse: collapse;
   }
   table.LC_parm_overview_restrictions td {
     border-width: 1px 4px 1px 4px;
     border-style: solid;
     border-color: $pgbg;
     text-align: center;
   }
   table.LC_parm_overview_restrictions th {
     background: $tabbg;
     border-width: 1px 4px 1px 4px;
     border-style: solid;
     border-color: $pgbg;
   }
   table#LC_helpmenu {
     border: 0px;
     height: 55px;
     border-spacing: 0px;
   }
   
   table#LC_helpmenu fieldset legend {
     font-size: larger;
     font-weight: bold;
   }
   table#LC_helpmenu_links {
     width: 100%;
     border: 1px solid black;
     background: $pgbg;
     padding: 0px;
     border-spacing: 1px;
   }
   table#LC_helpmenu_links tr td {
     padding: 1px;
     background: $tabbg;
     text-align: center;
     font-weight: bold;
   }
   
   table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
   table#LC_helpmenu_links a:active {
     text-decoration: none;
     color: $font;
   }
   table#LC_helpmenu_links a:hover {
     text-decoration: underline;
     color: $vlink;
   }
   
   .LC_chrt_popup_exists {
     border: 1px solid #339933;
     margin: -1px;
   }
   .LC_chrt_popup_up {
     border: 1px solid yellow;
     margin: -1px;
   }
   .LC_chrt_popup {
     border: 1px solid #8888FF;
     background: #CCCCFF;
   }
   
   table.LC_pick_box {
     width: 100%;
     border-collapse: separate;
     background: white;
     border: 1px solid black;
     border-spacing: 1px;
   }
   table.LC_pick_box td.LC_pick_box_title {
     background: $tabbg;
     font-weight: bold;
     text-align: right;
     width: 184px;
     padding: 8px;
   }
   table.LC_pick_box td.LC_pick_box_separator {
     padding: 0px;
     height: 1px;
     background: black;
   }
   table.LC_pick_box td.LC_pick_box_submit {
     text-align: right;
   }
   
   table.LC_group_priv_box {
     background: white;
     border: 1px solid black;
     border-spacing: 1px;
   }
   table.LC_group_priv_box td.LC_pick_box_title {
     background: $tabbg;
     font-weight: bold;
     text-align: right;
     width: 184px;
   }
   table.LC_group_priv_box td.LC_groups_fixed {
     background: $data_table_light;
     text-align: center;
   }
   table.LC_group_priv_box td.LC_groups_optional {
     background: $data_table_dark;
     text-align: center;
   }
   table.LC_group_priv_box td.LC_groups_functionality {
     background: $data_table_darker;
     text-align: center;
     font-weight: bold;
   }
   table.LC_group_priv td {
     text-align: left;
     padding: 0px;
   }
   
   table.LC_notify_front_page {
     background: white;
     border: 1px solid black;
     padding: 8px;
   }
   table.LC_notify_front_page td {
     padding: 8px;
   }
   .LC_navbuttons {
     margin: 2ex 0ex 2ex 0ex;
   }
   .LC_topic_bar {
     font-family: $sans;
     font-weight: bold;
     width: 100%;
     background: $tabbg;
     vertical-align: middle;
     margin: 2ex 0ex 2ex 0ex;
   }
   .LC_topic_bar span {
     vertical-align: middle;
   }
   .LC_topic_bar img {
     vertical-align: bottom;
   }
   table.LC_course_group_status {
     margin: 20px;
   }
   table.LC_status_selector td {
     vertical-align: top;
     text-align: center;
     padding: 4px;
   }
   table.LC_descriptive_input td.LC_description {
     vertical-align: top;
     text-align: right;
     font-weight: bold;
   }
   table.LC_feedback_link {
       background: $feedback_link_bg;
   }
   span.LC_feedback_link {
       background: $feedback_link_bg;
       font-size: larger;
   }
   
   table.LC_prior_tries {
     border: 1px solid #000000;
     border-collapse: separate;
     border-spacing: 1px;
   }
   
   table.LC_prior_tries td {
     padding: 2px;
   }
   
   .LC_answer_correct {
     background: #AAFFAA;
     color: black;
   }
   .LC_answer_charged_try {
     background: #FFAAAA ! important;
     color: black;
   }
   .LC_answer_not_charged_try, 
   .LC_answer_no_grade,
   .LC_answer_late {
     background: #FFFFAA;
     color: black;
   }
   .LC_answer_previous {
     background: #AAAAFF;
     color: black;
   }
   .LC_answer_no_message {
     background: #FFFFFF;
     color: black;
   }
   .LC_answer_unknown {
     background: orange;
     color: black;
   }
   
   
   span.LC_prior_numerical,
   span.LC_prior_string,
   span.LC_prior_custom,
   span.LC_prior_reaction,
   span.LC_prior_math {
     font-family: monospace;
     white-space: pre;
   }
   
   span.LC_prior_string {
     font-family: monospace;
     white-space: pre;
   }
   
   table.LC_prior_option {
     width: 100%;
     border-collapse: collapse;
   }
   table.LC_prior_rank, table.LC_prior_match {
     border-collapse: collapse;
   }
   table.LC_prior_option tr td,
   table.LC_prior_rank tr td,
   table.LC_prior_match tr td {
     border: 1px solid #000000;
   }
   
   span.LC_nobreak {
       white-space: nowrap;
   }
   
   END
   }
   
   =pod
   
   =over 4
   
   =item * &headtag()
   
   Returns a uniform footer for LON-CAPA web pages.
   
   Inputs: $title - optional title for the head
           $head_extra - optional extra HTML to put inside the <head>
           $args - optional arguments
               force_register - if is true call registerurl so the remote is 
                                informed
               redirect       -> array ref of
                                      1- seconds before redirect occurs
                                      2- url to redirect to
                                      3- whether the side effect should occur
                              (side effect of setting 
                                  $env{'internal.head.redirect'} to the url 
                                  redirected too)
               domain         -> force to color decorate a page for a specific
                                  domain
               function       -> force usage of a specific rolish color scheme
               bgcolor        -> override the default page bgcolor
               no_auto_mt_title
                              -> prevent &mt()ing the title arg
   
   =back
   
   =cut
   
   sub headtag {
       my ($title,$head_extra,$args) = @_;
           
     $r->read($buffer,$r->header_in('Content-length'),0);      my $function = $args->{'function'} || &get_users_function();
     unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {      my $domain   = $args->{'domain'}   || &determinedomain();
  my @pairs=split(/&/,$buffer);      my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
  my $pair;      my $url = join(':',$env{'user.name'},$env{'user.domain'},
  foreach $pair (@pairs) {     $Apache::lonnet::perlvar{'lonVersion'},
     my ($name,$value) = split(/=/,$pair);     #time(),
     $value =~ tr/+/ /;     $env{'environment.color.timestamp'},
     $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;     $function,$domain,$bgcolor);
     $name  =~ tr/+/ /;  
     $name  =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;      $url = '/adm/css/'.&escape($url).'.css';
     &add_to_env("form.$name",$value);  
  }      my $result =
     } else {   '<head>'.
  my $contentsep=$1;   &font_settings();
  my @lines = split (/\n/,$buffer);  
  my $name='';      if (!$args->{'frameset'}) {
  my $value='';   $result .= &Apache::lonhtmlcommon::htmlareaheaders();
  my $fname='';      }
  my $fmime='';      if ($args->{'force_register'}) {
  my $i;   $result .= &Apache::lonmenu::registerurl(1);
  for ($i=0;$i<=$#lines;$i++) {      }
     if ($lines[$i]=~/^$contentsep/) {      if (!$args->{'no_nav_bar'} 
  if ($name) {   && !$args->{'only_body'}
     chomp($value);   && !$args->{'frameset'}) {
     if ($fname) {   $result .= &help_menu_js();
  $ENV{"form.$name.filename"}=$fname;      }
  $ENV{"form.$name.mimetype"}=$fmime;  
     } else {      if (ref($args->{'redirect'})) {
  $value=~s/\s+$//s;   my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
     }   $url = &Apache::lonenc::check_encrypt($url);
     &add_to_env("form.$name",$value);   if (!$inhibit_continue) {
  }      $env{'internal.head.redirect'} = $url;
  if ($i<$#lines) {   }
     $i++;   $result.=<<ADDMETA
     $lines[$i]=~  <meta http-equiv="pragma" content="no-cache" />
  /Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;  <meta http-equiv="Refresh" content="$time; url=$url" />
     $name=$1;  ADDMETA
     $value='';      }
     if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {      if (!defined($title)) {
  $fname=$1;   $title = 'The LearningOnline Network with CAPA';
  if       }
                             ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {      if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
  $fmime=$1;      $result .= '<title> LON-CAPA '.$title.'</title>'
  $i++;   .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
     } else {   .$head_extra;
  $fmime='';      return $result;
     }  }
     } else {  
  $fname='';  =pod
  $fmime='';  
     }  =over 4
     $i++;  
  }  =item * &font_settings()
     } else {  
  $value.=$lines[$i]."\n";  Returns neccessary <meta> to set the proper encoding
   
   Inputs: none
   
   =back
   
   =cut
   
   sub font_settings {
       my $headerstring='';
       if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) { 
    $headerstring.=
       '<meta Content-Type="text/html; charset=x-mac-roman" />';
       } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
    $headerstring.=
       '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
       }
       return $headerstring;
   }
   
   =pod
   
   =over 4
   
   =item * &xml_begin()
   
   Returns the needed doctype and <html>
   
   Inputs: none
   
   =back
   
   =cut
   
   sub xml_begin {
       my $output='';
   
       &Apache::lonhtmlcommon::init_htmlareafields();
   
       if ($env{'browser.mathml'}) {
    $output='<?xml version="1.0"?>'
               #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
   #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
               
   #    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
       .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
               .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
       .'xmlns="http://www.w3.org/1999/xhtml">';
       } else {
    $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
       }
       return $output;
   }
   
   =pod
   
   =over 4
   
   =item * &endheadtag()
   
   Returns a uniform </head> for LON-CAPA web pages.
   
   Inputs: none
   
   =back
   
   =cut
   
   sub endheadtag {
       return '</head>';
   }
   
   =pod
   
   =over 4
   
   =item * &head()
   
   Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
   
   Inputs: $title - optional title for the page
           $head_extra - optional extra HTML to put inside the <head>
   
   =back
   
   =cut
   
   sub head {
       my ($title,$head_extra,$args) = @_;
       return &headtag($title,$head_extra,$args).&endheadtag();
   }
   
   =pod
   
   =over 4
   
   =item * &start_page()
   
   Returns a complete <html> .. <body> section for LON-CAPA web pages.
   
   Inputs: $title - optional title for the page
           $head_extra - optional extra HTML to incude inside the <head>
           $args - additional optional args supported are:
                     only_body      -> is true will set &bodytag() onlybodytag
                                       arg on
                     no_nav_bar     -> is true will set &bodytag() notopbar arg on
                     add_entries    -> additional attributes to add to the  <body>
                     domain         -> force to color decorate a page for a 
                                       specific domain
                     function       -> force usage of a specific rolish color
                                       scheme
                     redirect       -> see &headtag()
                     bgcolor        -> override the default page bg color
                     js_ready       -> return a string ready for being used in 
                                       a javascript writeln
                     html_encode    -> return a string ready for being used in 
                                       a html attribute
                     force_register -> if is true will turn on the &bodytag()
                                       $forcereg arg
                     body_title     -> alternate text to use instead of $title
                                       in the title box that appears, this text
                                       is not auto translated like the $title is
                     frameset       -> if true will start with a <frameset>
                                       rather than <body>
                     no_title       -> if true the title bar won't be shown
                     skip_phases    -> hash ref of 
                                       head -> skip the <html><head> generation
                                       body -> skip all <body> generation
   
                     no_inline_link -> if true and in remote mode, don't show the 
                                       'Switch To Inline Menu' link
   
                     no_auto_mt_title -> prevent &mt()ing the title arg
   
   =back
   
   =cut
   
   sub start_page {
       my ($title,$head_extra,$args) = @_;
       #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
       my %head_args;
       foreach my $arg ('redirect','force_register','domain','function',
        'bgcolor','frameset','no_nav_bar','only_body',
        'no_auto_mt_title') {
    if (defined($args->{$arg})) {
       $head_args{$arg} = $args->{$arg};
    }
       }
   
       $env{'internal.start_page'}++;
       my $result;
       if (! exists($args->{'skip_phases'}{'head'}) ) {
    $result.=
       &xml_begin().
       &headtag($title,$head_extra,\%head_args).&endheadtag();
       }
       
       if (! exists($args->{'skip_phases'}{'body'}) ) {
    if ($args->{'frameset'}) {
       my $attr_string = &make_attr_string($args->{'force_register'},
    $args->{'add_entries'});
       $result .= "\n<frameset $attr_string>\n";
    } else {
       $result .=
    &bodytag($title, 
    $args->{'function'},       $args->{'add_entries'},
    $args->{'only_body'},      $args->{'domain'},
    $args->{'force_register'}, $args->{'body_title'},
    $args->{'no_nav_bar'},     $args->{'bgcolor'},
    $args->{'no_title'},       $args->{'no_inline_link'},
    $args);
    }
       }
   
       if ($args->{'js_ready'}) {
    $result = &js_ready($result);
       }
       if ($args->{'html_encode'}) {
    $result = &html_encode($result);
       }
       return $result;
   }
   
   
   =pod
   
   =over 4
   
   =item * &head()
   
   Returns a complete </body></html> section for LON-CAPA web pages.
   
   Inputs:         $args - additional optional args supported are:
                    js_ready     -> return a string ready for being used in 
                                    a javascript writeln
                    html_encode  -> return a string ready for being used in 
                                    a html attribute
                    frameset     -> if true will start with a <frameset>
                                    rather than <body>
                    dicsussion   -> if true will get discussion from
                                     lonxml::xmlend
                                    (you can pass the target and parser arguments
                                     through optional 'target' and 'parser' args
                                     to this routine)
   
   =cut
   
   sub end_page {
       my ($args) = @_;
       $env{'internal.end_page'}++;
       my $result;
       if ($args->{'discussion'}) {
    my ($target,$parser);
    if (ref($args->{'discussion'})) {
       ($target,$parser) =($args->{'discussion'}{'target'},
    $args->{'discussion'}{'parser'});
    }
    $result .= &Apache::lonxml::xmlend($target,$parser);
       }
   
       if ($args->{'frameset'}) {
    $result .= '</frameset>';
       } else {
    $result .= &endbodytag();
       }
       $result .= "\n</html>";
   
       if ($args->{'js_ready'}) {
    $result = &js_ready($result);
       }
   
       if ($args->{'html_encode'}) {
    $result = &html_encode($result);
       }
   
       return $result;
   }
   
   sub html_encode {
       my ($result) = @_;
   
       $result = &HTML::Entities::encode($result,'<>&"');
       
       return $result;
   }
   sub js_ready {
       my ($result) = @_;
   
       $result =~ s/[\n\r]/ /xmsg;
       $result =~ s/\\/\\\\/xmsg;
       $result =~ s/'/\\'/xmsg;
       $result =~ s{</}{<\\/}xmsg;
       
       return $result;
   }
   
   sub validate_page {
       if (  exists($env{'internal.start_page'})
     &&     $env{'internal.start_page'} > 1) {
    &Apache::lonnet::logthis('start_page called multiple times '.
    $env{'internal.start_page'}.' '.
    $ENV{'request.filename'});
       }
       if (  exists($env{'internal.end_page'})
     &&     $env{'internal.end_page'} > 1) {
    &Apache::lonnet::logthis('end_page called multiple times '.
    $env{'internal.end_page'}.' '.
    $env{'request.filename'});
       }
       if (     exists($env{'internal.start_page'})
    && ! exists($env{'internal.end_page'})) {
    &Apache::lonnet::logthis('start_page called without end_page '.
    $env{'request.filename'});
       }
       if (   ! exists($env{'internal.start_page'})
    &&   exists($env{'internal.end_page'})) {
    &Apache::lonnet::logthis('end_page called without start_page'.
    $env{'request.filename'});
       }
   }
   
   sub simple_error_page {
       my ($r,$title,$msg) = @_;
       my $page =
    &Apache::loncommon::start_page($title).
    &mt($msg).
    &Apache::loncommon::end_page();
       if (ref($r)) {
    $r->print($page);
    return;
       }
       return $page;
   }
   
   {
       my $row_count;
       sub start_data_table {
    my ($add_class) = @_;
    my $css_class = (join(' ','LC_data_table',$add_class));
    undef($row_count);
    return '<table class="'.$css_class.'">'."\n";
       }
   
       sub end_data_table {
    undef($row_count);
    return '</table>'."\n";;
       }
   
       sub start_data_table_row {
    my ($add_class) = @_;
    $row_count++;
    my $css_class = ($row_count % 2)?'':'LC_even_row';
    $css_class = (join(' ',$css_class,$add_class));
    return  '<tr class="'.$css_class.'">'."\n";;
       }
       
       sub continue_data_table_row {
    my ($add_class) = @_;
    my $css_class = ($row_count % 2)?'':'LC_even_row';
    $css_class = (join(' ',$css_class,$add_class));
    return  '<tr class="'.$css_class.'">'."\n";;
       }
   
       sub end_data_table_row {
    return '</tr>'."\n";;
       }
   
       sub start_data_table_empty_row {
    $row_count++;
    return  '<tr class="LC_empty_row" >'."\n";;
       }
   
       sub end_data_table_empty_row {
    return '</tr>'."\n";;
       }
   
       sub start_data_table_header_row {
    return  '<tr class="LC_header_row">'."\n";;
       }
   
       sub end_data_table_header_row {
    return '</tr>'."\n";;
       }
   }
   
   ###############################################
   
   =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 ID.
   
   Outputs:
   role status: active, previous or future. 
   
   =cut
   
   sub check_user_status {
       my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
       my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
       my @uroles = keys %userinfo;
       my $srchstr;
       my $active_chk = 'none';
       my $now = time;
       if (@uroles > 0) {
           if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
               $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
           } else {
               $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
           }
           if (grep/^\Q$srchstr\E$/,@uroles) {
               my $role_end = 0;
               my $role_start = 0;
               $active_chk = 'active';
               if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   $role_end = $1;
                   if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                       $role_start = $1;
                   }
               }
               if ($role_start > 0) {
                   if ($now < $role_start) {
                       $active_chk = 'future';
                   }
               }
               if ($role_end > 0) {
                   if ($now > $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: 
   
   1. domain
   2. course number 
   3. reference to array containing roles for which sections should 
   be gathered (optional).
   4. reference to array containing status types for which sections 
   should be gathered (optional).
   
   If the third argument is undefined, sections are gathered for any role. 
   If the fourth argument is undefined, sections are gathered for any status.
   Permissible values are 'active' or 'future' or 'previous'.
    
   Returns section hash (keys are section IDs, values are
   number of users in each section), subject to the
   optional roles filter, optional status filter 
   
   =cut
   
   ###############################################
   sub get_sections {
       my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
       if (!defined($cdom) || !defined($cnum)) {
           my $cid =  $env{'request.course.id'};
   
    return if (!defined($cid));
   
           $cdom = $env{'course.'.$cid.'.domain'};
           $cnum = $env{'course.'.$cid.'.num'};
       }
   
       my %sectioncount;
       my $now = time;
   
       if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
    my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
    my $sec_index = &Apache::loncoursedata::CL_SECTION();
    my $status_index = &Apache::loncoursedata::CL_STATUS();
           my $start_index = &Apache::loncoursedata::CL_START();
           my $end_index = &Apache::loncoursedata::CL_END();
           my $status;
    while (my ($student,$data) = each(%$classlist)) {
       my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                        $data->[$status_index],
                                                        $data->[$start_index],
                                                        $data->[$end_index]);
               if ($stu_status eq 'Active') {
                   $status = 'active';
               } elsif ($end < $now) {
                   $status = 'previous';
               } elsif ($start > $now) {
                   $status = 'future';
               } 
       if ($section ne '-1' && $section !~ /^\s*$/) {
                   if ((!defined($possible_status)) || (($status ne '') && 
                       (grep/^\Q$status\E$/,@{$possible_status}))) { 
       $sectioncount{$section}++;
                   }
     }      }
  }   }
     }      }
     $ENV{'request.method'}=$ENV{'REQUEST_METHOD'};      my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
     $r->method_number(M_GET);      foreach my $user (sort(keys(%courseroles))) {
     $r->method('GET');   if ($user !~ /^(\w{2})/) { next; }
     $r->headers_in->unset('Content-length');   my ($role) = ($user =~ /^(\w{2})/);
    if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
    my ($section,$status);
    if ($role eq 'cr' &&
       $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
       $section=$1;
    }
    if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
    if (!defined($section) || $section eq '-1') { next; }
           my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
           if ($end == -1 && $start == -1) {
               next; #deleted role
           }
           if (!defined($possible_status)) { 
               $sectioncount{$section}++;
           } else {
               if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   $status = 'active';
               } elsif ($end < $now) {
                   $status = 'future';
               } elsif ($start > $now) {
                   $status = 'previous';
               }
               if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   $sectioncount{$section}++;
               }
           }
       }
       return %sectioncount;
 }  }
   
 ###############################################  ###############################################
   
   =pod
   
   =item * &get_course_users()
   
   Retrieves usernames:domains for users in the specified course
   with specific role(s), and access status. 
   
   Incoming parameters:
   1. course domain
   2. course number
   3. access status: users must have - either active, 
   previous, future, or all.
   4. reference to array of permissible roles
   5. reference to array of section restrictions (optional)
   6. reference to results object (hash of hashes).
   7. reference to optional userdata hash
   Keys of top level hash are roles.
   Keys of inner hashes are username:domain, with 
   values set to access type.
   Optional userdata hash returns an array with arguments in the 
   same order as loncoursedata::get_classlist() for student data.
   
   Entries for end, start, section and status are blank because
   of the possibility of multiple values for non-student roles.
   
   =cut
   
   ###############################################
   
   sub get_course_users {
       my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
       my %idx = ();
       my %seclists;
   
       $idx{udom} = &Apache::loncoursedata::CL_SDOM();
       $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
       $idx{end} = &Apache::loncoursedata::CL_END();
       $idx{start} = &Apache::loncoursedata::CL_START();
       $idx{id} = &Apache::loncoursedata::CL_ID();
       $idx{section} = &Apache::loncoursedata::CL_SECTION();
       $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
       $idx{status} = &Apache::loncoursedata::CL_STATUS();
   
       if (grep(/^st$/,@{$roles})) {
           my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
           my $now = time;
           foreach my $student (keys(%{$classlist})) {
               my $match = 0;
               my $secmatch = 0;
               my $section = $$classlist{$student}[$idx{section}];
               if ($section eq '') {
                   $section = 'none';
               }
               if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
                   if (grep(/^all$/,@{$sections})) {
                       $secmatch = 1;
                   } elsif ($$classlist{$student}[$idx{section}] eq '') {
                       if (grep(/^none$/,@{$sections})) {
                           $secmatch = 1;
                       }
                   } else {  
       if (grep(/^\Q$section\E$/,@{$sections})) {
           $secmatch = 1;
                       }
    }
                   if (!$secmatch) {
                       next;
                   }
               }
               push(@{$seclists{$student}},$section); 
               if (defined($$types{'active'})) {
                   if ($$classlist{$student}[$idx{status}] eq 'Active') {
                       push(@{$$users{st}{$student}},'active');
                       $match = 1;
                   }
               }
               if (defined($$types{'previous'})) {
                   if ($$classlist{$student}[$idx{end}] <= $now) {
                       push(@{$$users{st}{$student}},'previous');
                       $match = 1;
                   }
               }
               if (defined($$types{'future'})) {
                   if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
                       push(@{$$users{st}{$student}},'future');
                       $match = 1;
                   }
               }
               if ($match && ref($userdata) eq 'HASH') {
                   $$userdata{$student} = $$classlist{$student};
               }
           }
       }
       if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
           my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
           my $now = time;
           foreach my $person (sort(keys(%coursepersonnel))) {
               my $match = 0;
               my $secmatch = 0;
               my $status;
               my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
               $user =~ s/:$//;
               my ($end,$start) = split(/:/,$coursepersonnel{$person});
               if ($end == -1 || $start == -1) {
                   next;
               }
               if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
                   my ($uname,$udom) = split(/:/,$user);
                   if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
                       if (grep(/^all$/,@{$sections})) {
                           $secmatch = 1;
                       } elsif ($usec eq '') {
                           if (grep(/^none$/,@{$sections})) {
                               $secmatch = 1;
                           }
                       } else {
                           if (grep(/^\Q$usec\E$/,@{$sections})) {
                               $secmatch = 1;
                           }
                       }
                       if (!$secmatch) {
                           next;
                       }
                   }
                   if ($usec eq '') {
                       $usec = 'none';
                   }
                   if ($uname ne '' && $udom ne '') {
                       if ($end > 0 && $end < $now) {
                           $status = 'previous';
                       } elsif ($start > $now) {
                           $status = 'future';
                       } else {
                           $status = 'active';
                       }
                       foreach my $type (keys(%{$types})) { 
                           if ($status eq $type) {
                               if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
                                   push(@{$$users{$role}{$user}},$type);
                               }
                               $match = 1;
                           }
                       }
                       if (($match) && (ref($userdata) eq 'HASH')) {
                           if (!exists($$userdata{$uname.':'.$udom})) {
       &get_user_info($udom,$uname,\%idx,$userdata);
                           }
                           if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
                               push(@{$seclists{$uname.':'.$udom}},$usec);
                           }
                       }
                   }
               }
           }
           if (grep(/^ow$/,@{$roles})) {
               if ((defined($cdom)) && (defined($cnum))) {
                   my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   if ( defined($csettings{'internal.courseowner'}) ) {
                       my $owner = $csettings{'internal.courseowner'};
                       if ($owner !~ /^[^:]+:[^:]+$/) {
                           $owner = $owner.':'.$cdom;
                       }
                       @{$$users{'ow'}{$owner}} = 'any';
                       if (defined($userdata) && 
    !exists($$userdata{$owner.':'.$cdom})) {
    &get_user_info($cdom,$owner,\%idx,$userdata);
                           if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
                               push(@{$seclists{$owner.':'.$cdom}},'none');
                           }
       }
                   }
               }
           }
           foreach my $user (keys(%seclists)) {
               @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
               $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
           }
       }
       return;
   }
   
   sub get_user_info {
       my ($udom,$uname,$idx,$userdata) = @_;
       $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
    &plainname($uname,$udom,'lastname');
       $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
       $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
       return;
   }
   
   ###############################################
   
   =pod
   
   =item * &get_user_quota()
   
   Retrieves quota assigned for storage of portfolio files for a user  
   
   Incoming parameters:
   1. user's username
   2. user's domain
   
   Returns:
   1. Disk quota (in Mb) assigned to student.
   2. (Optional) Type of setting: custom or default
      (individually assigned or default for user's 
      institutional status).
   3. (Optional) - User's institutional status (e.g., faculty, staff
      or student - types as defined in localenroll::inst_usertypes 
      for user's domain, which determines default quota for user.
   4. (Optional) - Default quota which would apply to the user.
   
   If a value has been stored in the user's environment, 
   it will return that, otherwise it returns the maximal default
   defined for the user's instituional status(es) in the domain.
   
   =cut
   
   ###############################################
   
   
   sub get_user_quota {
       my ($uname,$udom) = @_;
       my ($quota,$quotatype,$settingstatus,$defquota);
       if (!defined($udom)) {
           $udom = $env{'user.domain'};
       }
       if (!defined($uname)) {
           $uname = $env{'user.name'};
       }
       if (($udom eq '' || $uname eq '') ||
           ($udom eq 'public') && ($uname eq 'public')) {
           $quota = 0;
           $quotatype = 'default';
           $defquota = 0; 
       } else {
           my $inststatus;
           if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
               $quota = $env{'environment.portfolioquota'};
               $inststatus = $env{'environment.inststatus'};
           } else {
               my %userenv = 
                   &Apache::lonnet::get('environment',['portfolioquota',
                                        'inststatus'],$udom,$uname);
               my ($tmp) = keys(%userenv);
               if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   $quota = $userenv{'portfolioquota'};
                   $inststatus = $userenv{'inststatus'};
               } else {
                   undef(%userenv);
               }
           }
           ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
           if ($quota eq '') {
               $quota = $defquota;
               $quotatype = 'default';
           } else {
               $quotatype = 'custom';
           }
       }
       if (wantarray) {
           return ($quota,$quotatype,$settingstatus,$defquota);
       } else {
           return $quota;
       }
   }
   
   ###############################################
   
   =pod
   
   =item * &default_quota()
   
   Retrieves default quota assigned for storage of user portfolio files,
   given an (optional) user's institutional status.
   
   Incoming parameters:
   1. domain
   2. (Optional) institutional status(es).  This is a : separated list of 
      status types (e.g., faculty, staff, student etc.)
      which apply to the user for whom the default is being retrieved.
      If the institutional status string in undefined, the domain
      default quota will be returned. 
   
   Returns:
   1. Default disk quota (in Mb) for user portfolios in the domain.
   2. (Optional) institutional type which determined the value of the
      default quota.
   
   If a value has been stored in the domain's configuration db,
   it will return that, otherwise it returns 20 (for backwards 
   compatibility with domains which have not set up a configuration
   db file; the original statically defined portfolio quota was 20 Mb). 
   
   If the user's status includes multiple types (e.g., staff and student),
   the largest default quota which applies to the user determines the
   default quota returned.
   
   =cut
   
   ###############################################
   
   
   sub default_quota {
       my ($udom,$inststatus) = @_;
       my ($defquota,$settingstatus);
       my %quotahash = &Apache::lonnet::get_dom('configuration',
                                               ['quota'],$udom);
       if (ref($quotahash{'quota'}) eq 'HASH') {
           if ($inststatus ne '') {
               my @statuses = split(/:/,$inststatus);
               foreach my $item (@statuses) {
                   if ($quotahash{'quota'}{$item} ne '') {
                       if ($defquota eq '') {
                           $defquota = $quotahash{'quota'}{$item};
                           $settingstatus = $item;
                       } elsif ($quotahash{'quota'}{$item} > $defquota) {
                           $defquota = $quotahash{'quota'}{$item};
                           $settingstatus = $item;
                       }
                   }
               }
           }
           if ($defquota eq '') {
               $defquota = $quotahash{'quota'}{'default'};
               $settingstatus = 'default';
           }
       } else {
           $settingstatus = 'default';
           $defquota = 20;
       }
       if (wantarray) {
           return ($defquota,$settingstatus);
       } else {
           return $defquota;
       }
   }
   
   sub get_secgrprole_info {
       my ($cdom,$cnum,$needroles,$type)  = @_;
       my %sections_count = &get_sections($cdom,$cnum);
       my @sections =  (sort {$a <=> $b} keys(%sections_count));
       my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
       my @groups = sort(keys(%curr_groups));
       my $allroles = [];
       my $rolehash;
       my $accesshash = {
                        active => 'Currently has access',
                        future => 'Will have future access',
                        previous => 'Previously had access',
                     };
       if ($needroles) {
           $rolehash = {'all' => 'all'};
           my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
    if (&Apache::lonnet::error(%user_roles)) {
       undef(%user_roles);
    }
           foreach my $item (keys(%user_roles)) {
               my ($role)=split(/\:/,$item,2);
               if ($role eq 'cr') { next; }
               if ($role =~ /^cr/) {
                   $$rolehash{$role} = (split('/',$role))[3];
               } else {
                   $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
               }
           }
           foreach my $key (sort(keys(%{$rolehash}))) {
               push(@{$allroles},$key);
           }
           push (@{$allroles},'st');
           $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
       }
       return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
   }
   
   =pod
   
   =item * get_unprocessed_cgi($query,$possible_names)
   
   Modify the %env hash to contain unprocessed CGI form parameters held in
   $query.  The parameters listed in $possible_names (an array reference),
   will be set in $env{'form.name'} if they do not already exist.
   
   Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
   $possible_names is an ref to an array of form element names.  As an example:
   get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
   will result in $env{'form.uname'} and $env{'form.udom'} being set.
   
   =cut
   
 sub get_unprocessed_cgi {  sub get_unprocessed_cgi {
   my ($query,$possible_names)= @_;    my ($query,$possible_names)= @_;
   # $Apache::lonxml::debug=1;    # $Apache::lonxml::debug=1;
   foreach (split(/&/,$query)) {    foreach my $pair (split(/&/,$query)) {
     my ($name, $value) = split(/=/,$_);      my ($name, $value) = split(/=/,$pair);
     $name = &Apache::lonnet::unescape($name);      $name = &unescape($name);
     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {      if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
       $value =~ tr/+/ /;        $value =~ tr/+/ /;
       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
       &Apache::lonxml::debug("Seting :$name: to :$value:");        unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
       unless (defined($ENV{'form.'.$name})) { &add_to_env('form.'.$name,$value) };  
     }      }
   }    }
 }  }
   
   =pod
   
   =item * cacheheader() 
   
   returns cache-controlling header code
   
   =cut
   
 sub cacheheader {  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="Cache-control" CONTENT="no-cache" />
                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';                  <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
   return $output;      return $output;
 }  }
   
   =pod
   
   =item * no_cache($r) 
   
   specifies header code to not have cache
   
   =cut
   
 sub no_cache {  sub no_cache {
   my ($r) = @_;      my ($r) = @_;
   unless ($ENV{'request.method'} eq 'GET') { return ''; }      if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
   #my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);   $env{'request.method'} ne 'GET') { return ''; }
   $r->no_cache(1);      my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
   $r->header_out("Pragma" => "no-cache");      $r->no_cache(1);
   #$r->header_out("Expires" => $date);      $r->header_out("Expires" => $date);
       $r->header_out("Pragma" => "no-cache");
   }
   
   sub content_type {
       my ($r,$type,$charset) = @_;
       if ($r) {
    #  Note that printout.pl calls this with undef for $r.
    &no_cache($r);
       }
       if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
       unless ($charset) {
    $charset=&Apache::lonlocal::current_encoding;
       }
       if ($charset) { $type.='; charset='.$charset; }
       if ($r) {
    $r->content_type($type);
       } else {
    print("Content-type: $type\n\n");
       }
 }  }
   
   =pod
   
   =item * add_to_env($name,$value) 
   
   adds $name to the %env hash with value
   $value, if $name already exists, the entry is converted to an array
   reference and $value is added to the array.
   
   =cut
   
 sub add_to_env {  sub add_to_env {
   my ($name,$value)=@_;    my ($name,$value)=@_;
   if (defined($ENV{$name})) {    if (defined($env{$name})) {
     if (ref($ENV{$name})) {      if (ref($env{$name})) {
       #already have multiple values        #already have multiple values
       push(@{ $ENV{$name} },$value);        push(@{ $env{$name} },$value);
     } else {      } else {
       #first time seeing multiple values, convert hash entry to an arrayref        #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 {    } else {
     $ENV{$name}=$value;      $env{$name}=$value;
   }    }
 }  }
   
 =pod  =pod
   
 =back   =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);
   }
   
 =head2 CSV Upload/Handling functions  
   =pod
   
   =back
   
   =head1 CSV Upload/Handling functions
   
 =over 4  =over 4
   
 =item  upfile_store($r)  =item * upfile_store($r)
   
 Store uploaded file, $r should be the HTTP Request object,  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  returns $datatoken to be put into hidden field
   
 =cut  =cut
   
 sub upfile_store {  sub upfile_store {
     my $r=shift;      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;      return $datatoken;
 }  }
   
 =pod  =pod
   
 =item load_tmp_file($r)  =item * load_tmp_file($r)
   
 Load uploaded file from tmp, $r should be the HTTP Request object,  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  =cut
   
Line 1956  sub load_tmp_file { Line 5599  sub load_tmp_file {
     my $r=shift;      my $r=shift;
     my @studentdata=();      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  =pod
   
 =item upfile_record_sep()  =item * upfile_record_sep()
   
 Separate uploaded file into records  Separate uploaded file into records
 returns array of records,  returns array of records,
 needs $ENV{'form.upfile'} and $ENV{'form.upfiletype'}  needs $env{'form.upfile'} and $env{'form.upfiletype'}
   
 =cut  =cut
   
 sub upfile_record_sep {  sub upfile_record_sep {
     if ($ENV{'form.upfiletype'} eq 'xml') {      if ($env{'form.upfiletype'} eq 'xml') {
     } else {      } else {
  return split(/\n/,$ENV{'form.upfile'});   my @records;
    foreach my $line (split(/\n/,$env{'form.upfile'})) {
       if ($line=~/^\s*$/) { next; }
       push(@records,$line);
    }
    return @records;
     }      }
 }  }
   
 =pod  =pod
   
 =item record_sep($record)  =item * record_sep($record)
   
 Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}  Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
   
 =cut  =cut
   
   sub takeleft {
       my $index=shift;
       return substr('0000'.$index,-4,4);
   }
   
 sub record_sep {  sub record_sep {
     my $record=shift;      my $record=shift;
     my %components=();      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;          my $i=0;
         foreach (split(/\s+/,$record)) {          foreach my $field (split(/\s+/,$record)) {
             my $field=$_;  
             $field=~s/^(\"|\')//;              $field=~s/^(\"|\')//;
             $field=~s/(\"|\')$//;              $field=~s/(\"|\')$//;
             $components{$i}=$field;              $components{&takeleft($i)}=$field;
             $i++;              $i++;
         }          }
     } elsif ($ENV{'form.upfiletype'} eq 'tab') {      } elsif ($env{'form.upfiletype'} eq 'tab') {
         my $i=0;          my $i=0;
         foreach (split(/\t+/,$record)) {          foreach my $field (split(/\t/,$record)) {
             my $field=$_;  
             $field=~s/^(\"|\')//;              $field=~s/^(\"|\')//;
             $field=~s/(\"|\')$//;              $field=~s/(\"|\')$//;
             $components{$i}=$field;              $components{&takeleft($i)}=$field;
             $i++;              $i++;
         }          }
     } else {      } else {
         my @allfields=split(/\,/,$record);          my @allfields;
           if ($env{'form.upfiletype'} eq 'semisv') {
               @allfields=split(/;/,$record,-1);
           } else {
               @allfields=split(/\,/,$record,-1);
           }
         my $i=0;          my $i=0;
         my $j;          my $j;
         for ($j=0;$j<=$#allfields;$j++) {          for ($j=0;$j<=$#allfields;$j++) {
Line 2027  sub record_sep { Line 5684  sub record_sep {
                 $field=~s/^\s*$delimiter//;                  $field=~s/^\s*$delimiter//;
                 $field=~s/$delimiter\s*$//;                  $field=~s/$delimiter\s*$//;
             }              }
             $components{$i}=$field;              $components{&takeleft($i)}=$field;
     $i++;      $i++;
         }          }
     }      }
     return %components;      return %components;
 }  }
   
   ######################################################
   ######################################################
   
 =pod  =pod
   
 =item upfile_select_html()  =item * upfile_select_html()
   
 return HTML code to select file and specify its type  Return HTML code to select a file from the users machine and specify 
   the file type.
   
 =cut  =cut
   
   ######################################################
   ######################################################
 sub upfile_select_html {  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">                   semisv => &mt('Semicolon separated values'),
 <option value="csv">CSV (comma separated values, spreadsheet)</option>                   space => &mt('Space separated'),
 <option value="space">Space separated</option>                   tab   => &mt('Tabulator separated'),
 <option value="tab">Tabulator separated</option>  #                 xml   => &mt('HTML/XML'),
 <option value="xml">HTML/XML</option>                   );
 </select>      my $Str = '<input type="file" name="upfile" size="50" />'.
 ENDUPFORM          '<br />Type: <select name="upfiletype">';
       foreach my $type (sort(keys(%Types))) {
           $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
       }
       $Str .= "</select>\n";
       return $Str;
   }
   
   sub get_samples {
       my ($records,$toget) = @_;
       my @samples=({});
       my $got=0;
       foreach my $rec (@$records) {
    my %temp = &record_sep($rec);
    if (! grep(/\S/, values(%temp))) { next; }
    if (%temp) {
       $samples[$got]=\%temp;
       $got++;
       if ($got == $toget) { last; }
    }
       }
       return \@samples;
 }  }
   
   ######################################################
   ######################################################
   
 =pod  =pod
   
 =item csv_print_samples($r,$records)  =item * csv_print_samples($r,$records)
   
 Prints a table of sample values from each column uploaded $r is an  Prints a table of sample values from each column uploaded $r is an
 Apache Request ref, $records is an arrayref from  Apache Request ref, $records is an arrayref from
Line 2064  Apache Request ref, $records is an array Line 5751  Apache Request ref, $records is an array
   
 =cut  =cut
   
   ######################################################
   ######################################################
 sub csv_print_samples {  sub csv_print_samples {
     my ($r,$records) = @_;      my ($r,$records) = @_;
     my (%sone,%stwo,%sthree);      my $samples = &get_samples($records,3);
     %sone=&record_sep($$records[0]);  
     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}  
     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}  
   
     $r->print('Samples<br /><table border="2"><tr>');      $r->print(&mt('Samples').'<br /><table border="2"><tr>');
     foreach (sort({$a <=> $b} keys(%sone))) { $r->print('<th>Column&nbsp;'.($_+1).'</th>'); }      foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
           $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
     $r->print('</tr>');      $r->print('</tr>');
     foreach my $hash (\%sone,\%stwo,\%sthree) {      foreach my $hash (@$samples) {
  $r->print('<tr>');   $r->print('<tr>');
  foreach (sort({$a <=> $b} keys(%sone))) {   foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
     $r->print('<td>');      $r->print('<td>');
     if (defined($$hash{$_})) { $r->print($$hash{$_}); }      if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
     $r->print('</td>');      $r->print('</td>');
  }   }
  $r->print('</tr>');   $r->print('</tr>');
Line 2086  sub csv_print_samples { Line 5773  sub csv_print_samples {
     $r->print('</tr></table><br />'."\n");      $r->print('</tr></table><br />'."\n");
 }  }
   
   ######################################################
   ######################################################
   
 =pod  =pod
   
 =item csv_print_select_table($r,$records,$d)  =item * csv_print_select_table($r,$records,$d)
   
 Prints a table to create associations between values and table columns.  Prints a table to create associations between values and table columns.
   
 $r is an Apache Request ref,  $r is an Apache Request ref,
 $records is an arrayref from &Apache::loncommon::upfile_record_sep,  $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  =cut
   
   ######################################################
   ######################################################
 sub csv_print_select_table {  sub csv_print_select_table {
     my ($r,$records,$d) = @_;      my ($r,$records,$d) = @_;
     my $i=0;my %sone;      my $i=0;
     %sone=&record_sep($$records[0]);      my $samples = &get_samples($records,1);
     $r->print('Associate columns with student attributes.'."\n".      $r->print(&mt('Associate columns with student attributes.')."\n".
      '<table border="2"><tr><th>Attribute</th><th>Column</th></tr>'."\n");       '<table border="2"><tr>'.
     foreach (@$d) {                '<th>'.&mt('Attribute').'</th>'.
  my ($value,$display)=@{ $_ };                '<th>'.&mt('Column').'</th></tr>'."\n");
       foreach my $array_ref (@$d) {
    my ($value,$display,$defaultcol)=@{ $array_ref };
  $r->print('<tr><td>'.$display.'</td>');   $r->print('<tr><td>'.$display.'</td>');
   
  $r->print('<td><select name=f'.$i.   $r->print('<td><select name=f'.$i.
   ' onchange="javascript:flip(this.form,'.$i.');">');    ' onchange="javascript:flip(this.form,'.$i.');">');
  $r->print('<option value="none"></option>');   $r->print('<option value="none"></option>');
  foreach (sort({$a <=> $b} keys(%sone))) {   foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
     $r->print('<option value="'.$_.'">Column '.($_+1).'</option>');      $r->print('<option value="'.$sample.'"'.
                         ($sample eq $defaultcol ? ' selected="selected" ' : '').
                         '>Column '.($sample+1).'</option>');
  }   }
  $r->print('</select></td></tr>'."\n");   $r->print('</select></td></tr>'."\n");
  $i++;   $i++;
Line 2120  sub csv_print_select_table { Line 5817  sub csv_print_select_table {
     return $i;      return $i;
 }  }
   
   ######################################################
   ######################################################
   
 =pod  =pod
   
 =item csv_samples_select_table($r,$records,$d)  =item * csv_samples_select_table($r,$records,$d)
   
 Prints a table of sample values from the upload and can make associate samples to internal names.  Prints a table of sample values from the upload and can make associate samples to internal names.
   
Line 2132  $d is an array of 2 element arrays (inte Line 5832  $d is an array of 2 element arrays (inte
   
 =cut  =cut
   
   ######################################################
   ######################################################
 sub csv_samples_select_table {  sub csv_samples_select_table {
     my ($r,$records,$d) = @_;      my ($r,$records,$d) = @_;
     my %sone; my %stwo; my %sthree;  
     my $i=0;      my $i=0;
       #
       my $samples = &get_samples($records,3);
       $r->print('<table border=2><tr><th>'.
                 &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
   
     $r->print('<table border=2><tr><th>Field</th><th>Samples</th></tr>');      foreach my $key (sort(keys(%{ $samples->[0] }))) {
     %sone=&record_sep($$records[0]);   $r->print('<tr><td><select name="f'.$i.'"'.
     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}  
     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}  
   
     foreach (sort keys %sone) {  
  $r->print('<tr><td><select name=f'.$i.  
   ' onchange="javascript:flip(this.form,'.$i.');">');    ' onchange="javascript:flip(this.form,'.$i.');">');
  foreach (@$d) {   foreach my $option (@$d) {
     my ($value,$display)=@{ $_ };      my ($value,$display,$defaultcol)=@{ $option };
     $r->print('<option value='.$value.'>'.$display.'</option>');      $r->print('<option value="'.$value.'"'.
                         ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
                         $display.'</option>');
  }   }
  $r->print('</select></td><td>');   $r->print('</select></td><td>');
  if (defined($sone{$_})) { $r->print($sone{$_}."</br>\n"); }   foreach my $line (0..2) {
  if (defined($stwo{$_})) { $r->print($stwo{$_}."</br>\n"); }      if (defined($samples->[$line]{$key})) { 
  if (defined($sthree{$_})) { $r->print($sthree{$_}."</br>\n"); }   $r->print($samples->[$line]{$key}."<br />\n"); 
       }
    }
  $r->print('</td></tr>');   $r->print('</td></tr>');
  $i++;   $i++;
     }      }
Line 2160  sub csv_samples_select_table { Line 5864  sub csv_samples_select_table {
     return($i);      return($i);
 }  }
   
   ######################################################
   ######################################################
   
 =pod  =pod
   
 =item check_if_partid_hidden($id,$symb,$udom,$uname)  =item clean_excel_name($name)
   
   Returns a replacement for $name which does not contain any illegal characters.
   
   =cut
   
   ######################################################
   ######################################################
   sub clean_excel_name {
       my ($name) = @_;
       $name =~ s/[:\*\?\/\\]//g;
       if (length($name) > 31) {
           $name = substr($name,0,31);
       }
       return $name;
   }
   
   =pod
   
   =item * check_if_partid_hidden($id,$symb,$udom,$uname)
   
 Returns either 1 or undef  Returns either 1 or undef
   
Line 2179  $uname, optional the username of the use Line 5905  $uname, optional the username of the use
   
 sub check_if_partid_hidden {  sub check_if_partid_hidden {
     my ($id,$symb,$udom,$uname) = @_;      my ($id,$symb,$udom,$uname) = @_;
     my $hiddenparts=&Apache::lonnet::EXT('resource.0.parameter_hiddenparts',      my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
  $symb,$udom,$uname);   $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);      my @hiddenlist=split(/,/,$hiddenparts);
     foreach my $checkid (@hiddenlist) {      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;
 }  }
   
   
   ############################################################
   ############################################################
   
 1;  =pod
 __END__;  
   =back 
   
   =head1 cgi-bin script and graphing routines
   
   =over 4
   
   =item get_cgi_id
   
   Inputs: none
   
   Returns an id which can be used to pass environment variables
   to various cgi-bin scripts.  These environment variables will
   be removed from the users environment after a given time by
   the routine &Apache::lonnet::transfer_profile_to_env.
   
   =cut
   
   ############################################################
   ############################################################
   my $uniq=0;
   sub get_cgi_id {
       $uniq=($uniq+1)%100000;
       return (time.'_'.$$.'_'.$uniq);
   }
   
   ############################################################
   ############################################################
   
 =pod  =pod
   
   =item DrawBarGraph
   
   Facilitates the plotting of data in a (stacked) bar graph.
   Puts plot definition data into the users environment in order for 
   graph.png to plot it.  Returns an <img> tag for the plot.
   The bars on the plot are labeled '1','2',...,'n'.
   
   Inputs:
   
   =over 4
   
   =item $Title: string, the title of the plot
   
   =item $xlabel: string, text describing the X-axis of the plot
   
   =item $ylabel: string, text describing the Y-axis of the plot
   
   =item $Max: scalar, the maximum Y value to use in the plot
   If $Max is < any data point, the graph will not be rendered.
   
   =item $colors: array ref holding the colors to be used for the data sets when
   they are plotted.  If undefined, default values will be used.
   
   =item $labels: array ref holding the labels to use on the x-axis for the bars.
   
   =item @Values: An array of array references.  Each array reference holds data
   to be plotted in a stacked bar chart.
   
   =item If the final element of @Values is a hash reference the key/value
   pairs will be added to the graph definition.
   
 =back  =back
   
 =head2 Access .tab File Data  Returns:
   
   An <img> tag which references graph.png and the appropriate identifying
   information for the plot.
   
   =cut
   
   ############################################################
   ############################################################
   sub DrawBarGraph {
       my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
       #
       if (! defined($colors)) {
           $colors = ['#33ff00', 
                     '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                     '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                     ]; 
       }
       my $extra_settings = {};
       if (ref($Values[-1]) eq 'HASH') {
           $extra_settings = pop(@Values);
       }
       #
       my $identifier = &get_cgi_id();
       my $id = 'cgi.'.$identifier;        
       if (! @Values || ref($Values[0]) ne 'ARRAY') {
           return '';
       }
       #
       my @Labels;
       if (defined($labels)) {
           @Labels = @$labels;
       } else {
           for (my $i=0;$i<@{$Values[0]};$i++) {
               push (@Labels,$i+1);
           }
       }
       #
       my $NumBars = scalar(@{$Values[0]});
       if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
       my %ValuesHash;
       my $NumSets=1;
       foreach my $array (@Values) {
           next if (! ref($array));
           $ValuesHash{$id.'.data.'.$NumSets++} = 
               join(',',@$array);
       }
       #
       my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
       if ($NumBars < 3) {
           $width = 120+$NumBars*32;
           $xskip = 1;
           $bar_width = 30;
       } elsif ($NumBars < 5) {
           $width = 120+$NumBars*20;
           $xskip = 1;
           $bar_width = 20;
       } elsif ($NumBars < 10) {
           $width = 120+$NumBars*15;
           $xskip = 1;
           $bar_width = 15;
       } elsif ($NumBars <= 25) {
           $width = 120+$NumBars*11;
           $xskip = 5;
           $bar_width = 8;
       } elsif ($NumBars <= 50) {
           $width = 120+$NumBars*8;
           $xskip = 5;
           $bar_width = 4;
       } else {
           $width = 120+$NumBars*8;
           $xskip = 5;
           $bar_width = 4;
       }
       #
       $Max = 1 if ($Max < 1);
       if ( int($Max) < $Max ) {
           $Max++;
           $Max = int($Max);
       }
       $Title  = '' if (! defined($Title));
       $xlabel = '' if (! defined($xlabel));
       $ylabel = '' if (! defined($ylabel));
       $ValuesHash{$id.'.title'}    = &escape($Title);
       $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
       $ValuesHash{$id.'.ylabel'}   = &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  =over 4
   
 =item languageids()   =item $Title: string, the title of the plot
   
 returns list of all language ids  =item $xlabel: string, text describing the X-axis of the plot
   
 =item languagedescription()   =item $ylabel: string, text describing the Y-axis of the plot
   
 returns description of a specified language id  =item $Max: scalar, the maximum Y value to use in the plot
   If $Max is < any data point, the graph will not be rendered.
   
 =item copyrightids()   =item $colors: Array ref containing the hex color codes for the data to be 
   plotted in.  If undefined, default values will be used.
   
 returns list of all copyrights  =item $Xlabels: Array ref containing the labels to be used for the X-axis.
   
 =item copyrightdescription()   =item $Ydata: Array ref containing Array refs.  
   Each of the contained arrays will be plotted as a separate curve.
   
 returns description of a specified copyright id  =item %Values: hash indicating or overriding any default values which are 
   passed to graph.png.  
   Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
   
 =item filecategories()   =back
   
 returns list of all file categories  Returns:
   
 =item filecategorytypes()   An <img> tag which references graph.png and the appropriate identifying
   information for the plot.
   
 returns list of file types belonging to a given file  =cut
 category  
   
 =item fileembstyle()   ############################################################
   ############################################################
   sub DrawXYGraph {
       my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
       #
       # Create the identifier for the graph
       my $identifier = &get_cgi_id();
       my $id = 'cgi.'.$identifier;
       #
       $Title  = '' if (! defined($Title));
       $xlabel = '' if (! defined($xlabel));
       $ylabel = '' if (! defined($ylabel));
       my %ValuesHash = 
           (
            $id.'.title'  => &escape($Title),
            $id.'.xlabel' => &escape($xlabel),
            $id.'.ylabel' => &escape($ylabel),
            $id.'.y_max_value'=> $Max,
            $id.'.labels'     => join(',',@$Xlabels),
            $id.'.PlotType'   => 'XY',
            );
       #
       if (defined($colors) && ref($colors) eq 'ARRAY') {
           $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
       }
       #
       if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
           return '';
       }
       my $NumSets=1;
       foreach my $array (@{$Ydata}){
           next if (! ref($array));
           $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
       }
       $ValuesHash{$id.'.NumSets'} = $NumSets-1;
       #
       # Deal with other parameters
       while (my ($key,$value) = each(%Values)) {
           $ValuesHash{$id.'.'.$key} = $value;
       }
       #
       &Apache::lonnet::appenv(%ValuesHash);
       return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
   }
   
 returns embedding style for a specified file type  ############################################################
   ############################################################
   
 =item filedescription()   =pod
   
 returns description for a specified file type  =item DrawXYYGraph
   
 =item filedescriptionex()   Facilitates the plotting of data in an XY graph with two Y axes.
   Puts plot definition data into the users environment in order for 
   graph.png to plot it.  Returns an <img> tag for the plot.
   
 returns description for a specified file type with  Inputs:
 extra formatting  
   =over 4
   
   =item $Title: string, the title of the plot
   
   =item $xlabel: string, text describing the X-axis of the plot
   
   =item $ylabel: string, text describing the Y-axis of the plot
   
   =item $colors: Array ref containing the hex color codes for the data to be 
   plotted in.  If undefined, default values will be used.
   
   =item $Xlabels: Array ref containing the labels to be used for the X-axis.
   
   =item $Ydata1: The first data set
   
   =item $Min1: The minimum value of the left Y-axis
   
   =item $Max1: The maximum value of the left Y-axis
   
   =item $Ydata2: The second data set
   
   =item $Min2: The minimum value of the right Y-axis
   
   =item $Max2: The maximum value of the left Y-axis
   
   =item %Values: hash indicating or overriding any default values which are 
   passed to graph.png.  
   Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
   
 =back  =back
   
 =head2 Alternate Problem Views  Returns:
   
   An <img> tag which references graph.png and the appropriate identifying
   information for the plot.
   
   =cut
   
   ############################################################
   ############################################################
   sub DrawXYYGraph {
       my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                                           $Ydata2,$Min2,$Max2,%Values)=@_;
       #
       # Create the identifier for the graph
       my $identifier = &get_cgi_id();
       my $id = 'cgi.'.$identifier;
       #
       $Title  = '' if (! defined($Title));
       $xlabel = '' if (! defined($xlabel));
       $ylabel = '' if (! defined($ylabel));
       my %ValuesHash = 
           (
            $id.'.title'  => &escape($Title),
            $id.'.xlabel' => &escape($xlabel),
            $id.'.ylabel' => &escape($ylabel),
            $id.'.labels' => join(',',@$Xlabels),
            $id.'.PlotType' => 'XY',
            $id.'.NumSets' => 2,
            $id.'.two_axes' => 1,
            $id.'.y1_max_value' => $Max1,
            $id.'.y1_min_value' => $Min1,
            $id.'.y2_max_value' => $Max2,
            $id.'.y2_min_value' => $Min2,
            );
       #
       if (defined($colors) && ref($colors) eq 'ARRAY') {
           $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
       }
       #
       if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
           ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
           return '';
       }
       my $NumSets=1;
       foreach my $array ($Ydata1,$Ydata2){
           next if (! ref($array));
           $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
       }
       #
       # Deal with other parameters
       while (my ($key,$value) = each(%Values)) {
           $ValuesHash{$id.'.'.$key} = $value;
       }
       #
       &Apache::lonnet::appenv(%ValuesHash);
       return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
   }
   
   ############################################################
   ############################################################
   
   =pod
   
   =back 
   
   =head1 Statistics helper routines?  
   
   Bad place for them but what the hell.
   
 =over 4  =over 4
   
 =item get_previous_attempt()   =item &chartlink
   
 return string with previous attempt on problem  Returns a link to the chart for a specific student.  
   
 =item get_student_view()   Inputs:
   
 show a snapshot of what student was looking at  =over 4
   
 =item get_student_answers()   =item $linktext: The text of the link
   
 show a snapshot of how student was answering problem  =item $sname: The students username
   
   =item $sdomain: The students domain
   
   =back
   
 =back  =back
   
 =head2 HTTP Helper  =cut
   
   ############################################################
   ############################################################
   sub chartlink {
       my ($linktext, $sname, $sdomain) = @_;
       my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
           '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
           '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
          '">'.$linktext.'</a>';
   }
   
   #######################################################
   #######################################################
   
   =pod
   
   =head1 Course Environment Routines
   
 =over 4  =over 4
   
 =item get_unprocessed_cgi($query,$possible_names)  =item &restore_course_settings 
   
 Modify the %ENV hash to contain unprocessed CGI form parameters held in  =item &store_course_settings
 $query.  The parameters listed in $possible_names (an array reference),  
 will be set in $ENV{'form.name'} if they do not already exist.  
   
 Typically called with $ENV{'QUERY_STRING'} as the first parameter.    Restores/Store indicated form parameters from the course environment.
 $possible_names is an ref to an array of form element names.  As an example:  Will not overwrite existing values of the form parameters.
 get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);  
 will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set.  
   
 =item cacheheader()   Inputs: 
   a scalar describing the data (e.g. 'chart', 'problem_analysis')
   
 returns cache-controlling header code  a hash ref describing the data to be stored.  For example:
      
   %Save_Parameters = ('Status' => 'scalar',
       'chartoutputmode' => 'scalar',
       'chartoutputdata' => 'scalar',
       'Section' => 'array',
       'Group' => 'array',
       'StudentData' => 'array',
       'Maps' => 'array');
   
 =item no_cache($r)   Returns: both routines return nothing
   
 specifies header code to not have cache  =cut
   
 =item add_to_env($name,$value)   #######################################################
   #######################################################
   sub store_course_settings {
       return &store_settings($env{'request.course.id'},@_);
   }
   
   sub store_settings {
       # save to the environment
       # appenv the same items, just to be safe
       my $udom  = $env{'user.domain'};
       my $uname = $env{'user.name'};
       my ($context,$prefix,$Settings) = @_;
       my %SaveHash;
       my %AppHash;
       while (my ($setting,$type) = each(%$Settings)) {
           my $basename = join('.','internal',$context,$prefix,$setting);
           my $envname = 'environment.'.$basename;
           if (exists($env{'form.'.$setting})) {
               # Save this value away
               if ($type eq 'scalar' &&
                   (! exists($env{$envname}) || 
                    $env{$envname} ne $env{'form.'.$setting})) {
                   $SaveHash{$basename} = $env{'form.'.$setting};
                   $AppHash{$envname}   = $env{'form.'.$setting};
               } elsif ($type eq 'array') {
                   my $stored_form;
                   if (ref($env{'form.'.$setting})) {
                       $stored_form = join(',',
                                           map {
                                               &escape($_);
                                           } sort(@{$env{'form.'.$setting}}));
                   } else {
                       $stored_form = 
                           &escape($env{'form.'.$setting});
                   }
                   # Determine if the array contents are the same.
                   if ($stored_form ne $env{$envname}) {
                       $SaveHash{$basename} = $stored_form;
                       $AppHash{$envname}   = $stored_form;
                   }
               }
           }
       }
       my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
                                             $udom,$uname);
       if ($put_result !~ /^(ok|delayed)/) {
           &Apache::lonnet::logthis('unable to save form parameters, '.
                                    'got error:'.$put_result);
       }
       # Make sure these settings stick around in this session, too
       &Apache::lonnet::appenv(%AppHash);
       return;
   }
   
 adds $name to the %ENV hash with value  sub restore_course_settings {
 $value, if $name already exists, the entry is converted to an array      return &restore_settings($env{'request.course.id'},@_);
 reference and $value is added to the array.  }
   
   sub restore_settings {
       my ($context,$prefix,$Settings) = @_;
       while (my ($setting,$type) = each(%$Settings)) {
           next if (exists($env{'form.'.$setting}));
           my $envname = 'environment.internal.'.$context.'.'.$prefix.
               '.'.$setting;
           if (exists($env{$envname})) {
               if ($type eq 'scalar') {
                   $env{'form.'.$setting} = $env{$envname};
               } elsif ($type eq 'array') {
                   $env{'form.'.$setting} = [ 
                                              map { 
                                                  &unescape($_); 
                                              } split(',',$env{$envname})
                                              ];
               }
           }
       }
   }
   
   ############################################################
   ############################################################
   
   sub commit_customrole {
       my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
       my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
                            ($start?', '.&mt('starting').' '.localtime($start):'').
                            ($end?', ending '.localtime($end):'').': <b>'.
                 &Apache::lonnet::assigncustomrole(
                    $udom,$uname,$url,$three,$four,$five,$end,$start).
                    '</b><br />';
       return $output;
   }
   
   sub commit_standardrole {
       my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_;
       my $output;
       my $logmsg;
       if ($three eq 'st') {
           my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec);
           if (($result =~ /^error/) || ($result eq 'not_in_class') || ($result eq 'unknown_course')) {
               $output = "Error: $result\n"; 
           } else {
               $output = &mt('Assigning').' '.$three.' in '.$url.
                  ($start?', '.&mt('starting').' '.localtime($start):'').
                  ($end?', '.&mt('ending').' '.localtime($end):'').
                  ': <b>'.$result.'</b><br />'.
                  &mt('Add to classlist').': <b>ok</b><br />';
           }
       } else {
           $output = &mt('Assigning').' '.$three.' in '.$url.
                  ($start?', '.&mt('starting').' '.localtime($start):'').
                  ($end?', '.&mt('ending').' '.localtime($end):'').': <b>'.
                  &Apache::lonnet::assignrole(
                      $udom,$uname,$url,$three,$end,$start).
                      '</b><br />';
       }
       return $output;
   }
   
   sub commit_studentrole {
       my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_;
       my $linefeed =  '<br />'."\n";
       my $result;
       if (defined($one) && defined($two)) {
           my $cid=$one.'_'.$two;
           my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
           my $secchange = 0;
           my $expire_role_result;
           my $modify_section_result;
           unless ($oldsec eq '-1') {
               unless ($sec eq $oldsec) {
                   $secchange = 1;
                   my $uurl='/'.$cid;
                   $uurl=~s/\_/\//g;
                   if ($oldsec) {
                       $uurl.='/'.$oldsec;
                   }
                   $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);
                   $result = $expire_role_result;
               }
           }
           if (($expire_role_result eq 'ok') || ($secchange == 0)) {
               $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
               if ($modify_section_result =~ /^ok/) {
                   if ($secchange == 1) {
                       $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;
                   } elsif ($oldsec eq '-1') {
                       $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;
                   } else {
                       $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;
                   }
               } else {
                   $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;
               }
               $result = $modify_section_result;
           } elsif ($secchange == 1) {
               $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;
           }
       } else {
           $$logmsg .= "Incomplete course id defined.  Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";
           $result = "error: incomplete course id\n";
       }
       return $result;
   }
   
   ############################################################
   ############################################################
   
   sub construct_course {
       my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname) = @_;
       my $outcome;
   
   #
   # Open course
   #
       my $crstype = lc($args->{'crstype'});
       my %cenv=();
       $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                                                $args->{'cdescr'},
                                                $args->{'curl'},
                                                $args->{'course_home'},
                                                $args->{'nonstandard'},
                                                $args->{'crscode'},
                                                $args->{'ccuname'}.':'.
                                                $args->{'ccdomain'},
                                                $args->{'crstype'});
   
       # Note: The testing routines depend on this being output; see 
       # Utils::Course. This needs to at least be output as a comment
       # if anyone ever decides to not show this, and Utils::Course::new
       # will need to be suitably modified.
       $outcome .= &mt('New LON-CAPA [_1] ID: [_2]<br />',$crstype,$$courseid);
   #
   # Check if created correctly
   #
       ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
       my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
       $outcome .= &mt('Created on').': '.$crsuhome.'<br>';
   #
   # Are we cloning?
   #
       my $cloneid='';
       if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
    $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
           my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
    my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
    if ($clonehome eq 'no_host') {
       $outcome .=
       '<br /><font color="red">'.&mt('Attempting to clone non-existing [_1]',$crstype).' '.$cloneid.'</font>';
    } else {
       $outcome .= 
       '<br /><font color="green">'.&mt('Cloning [_1] from [_2]',$crstype,$clonehome).'</font>';
       my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
   # Copy all files
       &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
   # Restore URL
       $cenv{'url'}=$oldcenv{'url'};
   # Restore title
       $cenv{'description'}=$oldcenv{'description'};
   # restore grading mode
       if (defined($oldcenv{'grading'})) {
    $cenv{'grading'}=$oldcenv{'grading'};
       }
   # Mark as cloned
       $cenv{'clonedfrom'}=$cloneid;
       delete($cenv{'default_enrollment_start_date'});
       delete($cenv{'default_enrollment_end_date'});
    }
       }
   #
   # Set environment (will override cloned, if existing)
   #
       my @sections = ();
       my @xlists = ();
       if ($args->{'crstype'}) {
           $cenv{'type'}=$args->{'crstype'};
       }
       if ($args->{'crsid'}) {
           $cenv{'courseid'}=$args->{'crsid'};
       }
       if ($args->{'crscode'}) {
           $cenv{'internal.coursecode'}=$args->{'crscode'};
       }
       if ($args->{'crsquota'} ne '') {
           $cenv{'internal.coursequota'}=$args->{'crsquota'};
       } else {
           $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
       }
       if ($args->{'ccuname'}) {
           $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                                           ':'.$args->{'ccdomain'};
       } else {
           $cenv{'internal.courseowner'} = $args->{'curruser'};
       }
   
       my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
       if ($args->{'crssections'}) {
           $cenv{'internal.sectionnums'} = '';
           if ($args->{'crssections'} =~ m/,/) {
               @sections = split/,/,$args->{'crssections'};
           } else {
               $sections[0] = $args->{'crssections'};
           }
           if (@sections > 0) {
               foreach my $item (@sections) {
                   my ($sec,$gp) = split/:/,$item;
                   my $class = $args->{'crscode'}.$sec;
                   my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   $cenv{'internal.sectionnums'} .= $item.',';
                   unless ($addcheck eq 'ok') {
                       push @badclasses, $class;
                   }
               }
               $cenv{'internal.sectionnums'} =~ s/,$//;
           }
       }
   # do not hide course coordinator from staff listing, 
   # even if privileged
       $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
   # add crosslistings
       if ($args->{'crsxlist'}) {
           $cenv{'internal.crosslistings'}='';
           if ($args->{'crsxlist'} =~ m/,/) {
               @xlists = split/,/,$args->{'crsxlist'};
           } else {
               $xlists[0] = $args->{'crsxlist'};
           }
           if (@xlists > 0) {
               foreach my $item (@xlists) {
                   my ($xl,$gp) = split/:/,$item;
                   my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   $cenv{'internal.crosslistings'} .= $item.',';
                   unless ($addcheck eq 'ok') {
                       push @badclasses, $xl;
                   }
               }
               $cenv{'internal.crosslistings'} =~ s/,$//;
           }
       }
       if ($args->{'autoadds'}) {
           $cenv{'internal.autoadds'}=$args->{'autoadds'};
       }
       if ($args->{'autodrops'}) {
           $cenv{'internal.autodrops'}=$args->{'autodrops'};
       }
   # check for notification of enrollment changes
       my @notified = ();
       if ($args->{'notify_owner'}) {
           if ($args->{'ccuname'} ne '') {
               push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
           }
       }
       if ($args->{'notify_dc'}) {
           if ($uname ne '') { 
               push(@notified,$uname.'@'.$udom);
           }
       }
       if (@notified > 0) {
           my $notifylist;
           if (@notified > 1) {
               $notifylist = join(',',@notified);
           } else {
               $notifylist = $notified[0];
           }
           $cenv{'internal.notifylist'} = $notifylist;
       }
       if (@badclasses > 0) {
           my %lt=&Apache::lonlocal::texthash(
                   'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.  However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
                   'dnhr' => 'does not have rights to access enrollment in these classes',
                   'adby' => 'as determined by the policies of your institution on access to official classlists'
           );
           $outcome .= '<font color="red">'.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').<br /><ul>'."\n";
           foreach (@badclasses) {
               $outcome .= "<li>$_</li>\n";
           }
           $outcome .= "</ul><br /><br /></font>\n";
       }
       if ($args->{'no_end_date'}) {
           $args->{'endaccess'} = 0;
       }
       $cenv{'internal.autostart'}=$args->{'enrollstart'};
       $cenv{'internal.autoend'}=$args->{'enrollend'};
       $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
       $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
       if ($args->{'showphotos'}) {
         $cenv{'internal.showphotos'}=$args->{'showphotos'};
       }
       $cenv{'internal.authtype'} = $args->{'authtype'};
       $cenv{'internal.autharg'} = $args->{'autharg'}; 
       if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
           if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
               $outcome .= '<font color="red" size="+1">'.
                         &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student').'</font></p>';
           }
       }
       if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
          if ($args->{'setpolicy'}) {
              $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
          }
          if ($args->{'setcontent'}) {
              $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
          }
       }
       if ($args->{'reshome'}) {
    $cenv{'reshome'}=$args->{'reshome'}.'/';
    $cenv{'reshome'}=~s/\/+$/\//;
       }
   #
   # course has keyed access
   #
       if ($args->{'setkeys'}) {
          $cenv{'keyaccess'}='yes';
       }
   # if specified, key authority is not course, but user
   # only active if keyaccess is yes
       if ($args->{'keyauth'}) {
    my ($user,$domain) = split(':',$args->{'keyauth'});
    $user = &LONCAPA::clean_username($user);
    $domain = &LONCAPA::clean_username($domain);
    if ($user ne '' && $domain ne '') {
       $cenv{'keyauth'}=$user.':'.$domain;
    }
       }
   
       if ($args->{'disresdis'}) {
           $cenv{'pch.roles.denied'}='st';
       }
       if ($args->{'disablechat'}) {
           $cenv{'plc.roles.denied'}='st';
       }
   
       # Record we've not yet viewed the Course Initialization Helper for this 
       # course
       $cenv{'course.helper.not.run'} = 1;
       #
       # Use new Randomseed
       #
       $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
       $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
       #
       # The encryption code and receipt prefix for this course
       #
       $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
       $cenv{'internal.encpref'}=100+int(9*rand(99));
       #
       # By default, use standard grading
       if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
   
       $outcome .= ('<br />'.&mt('Setting environment').': '.                 
             &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).'<br>');
   #
   # Open all assignments
   #
       if ($args->{'openall'}) {
          my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
          my %storecontent = ($storeunder         => time,
                              $storeunder.'.type' => 'date_start');
          
          $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
                    ('resourcedata',\%storecontent,$$crsudom,$$crsunum).'<br>';
      }
   #
   # Set first page
   #
       unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
       || ($cloneid)) {
    use LONCAPA::map;
    $outcome .= &mt('Setting first resource').': ';
   
    my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
           my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
   
           $outcome .= ($fatal?$errtext:'read ok').' - ';
           my $title; my $url;
           if ($args->{'firstres'} eq 'syl') {
       $title='Syllabus';
               $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
           } else {
               $title='Navigate Contents';
               $url='/adm/navmaps';
           }
   
           $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
    (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
   
    if ($errtext) { $fatal=2; }
           $outcome .= ($fatal?$errtext:'write ok').'<br />';
       }
       return $outcome;
   }
   
   ############################################################
   ############################################################
   
   sub course_type {
       my ($cid) = @_;
       if (!defined($cid)) {
           $cid = $env{'request.course.id'};
       }
       if (defined($env{'course.'.$cid.'.type'})) {
           return $env{'course.'.$cid.'.type'};
       } else {
           return 'Course';
       }
   }
   
   sub group_term {
       my $crstype = &course_type();
       my %names = (
                     'Course' => 'group',
                     'Group' => 'team',
                   );
       return $names{$crstype};
   }
   
   sub icon {
       my ($file)=@_;
       my $curfext = lc((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 = &escape(pop(@urlslices));
       return join('/',@urlslices).'/'.$lastitem;
   }
   
   # -------------------------------------------------------- Initliaze user login
   sub init_user_environment {
       my ($r, $username, $domain, $authhost, $form, $args) = @_;
       my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
   
       my $public=($username eq 'public' && $domain eq 'public');
   
   # See if old ID present, if so, remove
   
       my ($filename,$cookie,$userroles);
       my $now=time;
   
       if ($public) {
    my $max_public=100;
    my $oldest;
    my $oldest_time=0;
    for(my $next=1;$next<=$max_public;$next++) {
       if (-e $lonids."/publicuser_$next.id") {
    my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
    if ($mtime<$oldest_time || !$oldest_time) {
       $oldest_time=$mtime;
       $oldest=$next;
    }
       } else {
    $cookie="publicuser_$next";
    last;
       }
    }
    if (!$cookie) { $cookie="publicuser_$oldest"; }
       } else {
    # if this isn't a robot, kill any existing non-robot sessions
    if (!$args->{'robot'}) {
       opendir(DIR,$lonids);
       while ($filename=readdir(DIR)) {
    if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
       unlink($lonids.'/'.$filename);
    }
       }
       closedir(DIR);
    }
   # Give them a new cookie
    my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
                      : $now);
    $cookie="$username\_$id\_$domain\_$authhost";
       
   # Initialize roles
   
    $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
       }
   # ------------------------------------ Check browser type and MathML capability
   
       my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
           $clientunicode,$clientos) = &decode_user_agent($r);
   
   # -------------------------------------- Any accessibility options to remember?
       if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
    foreach my $option ('imagesuppress','appletsuppress',
       'embedsuppress','fontenhance','blackwhite') {
       if ($form->{$option} eq 'true') {
    &Apache::lonnet::put('environment',{$option => 'on'},
        $domain,$username);
       } else {
    &Apache::lonnet::del('environment',[$option],
        $domain,$username);
       }
    }
       }
   # ------------------------------------------------------------- Get environment
   
       my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
       my ($tmp) = keys(%userenv);
       if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
    # default remote control to off
    if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
       } else {
    undef(%userenv);
       }
       if (($userenv{'interface'}) && (!$form->{'interface'})) {
    $form->{'interface'}=$userenv{'interface'};
       }
       $env{'environment.remote'}=$userenv{'remote'};
       if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
   
   # --------------- Do not trust query string to be put directly into environment
       foreach my $option ('imagesuppress','appletsuppress',
    'embedsuppress','fontenhance','blackwhite',
    'interface','localpath','localres') {
    $form->{$option}=~s/[\n\r\=]//gs;
       }
   # --------------------------------------------------------- Write first profile
   
       {
    my %initial_env = 
       ("user.name"          => $username,
        "user.domain"        => $domain,
        "user.home"          => $authhost,
        "browser.type"       => $clientbrowser,
        "browser.version"    => $clientversion,
        "browser.mathml"     => $clientmathml,
        "browser.unicode"    => $clientunicode,
        "browser.os"         => $clientos,
        "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
        "request.course.fn"  => '',
        "request.course.uri" => '',
        "request.course.sec" => '',
        "request.role"       => 'cm',
        "request.role.adv"   => $env{'user.adv'},
        "request.host"       => $ENV{'REMOTE_ADDR'},);
   
           if ($form->{'localpath'}) {
       $initial_env{"browser.localpath"}  = $form->{'localpath'};
       $initial_env{"browser.localres"}   = $form->{'localres'};
           }
   
    if ($public) {
       $initial_env{"environment.remote"} = "off";
    }
    if ($form->{'interface'}) {
       $form->{'interface'}=~s/\W//gs;
       $initial_env{"browser.interface"} = $form->{'interface'};
       $env{'browser.interface'}=$form->{'interface'};
       foreach my $option ('imagesuppress','appletsuppress',
    'embedsuppress','fontenhance','blackwhite') {
    if (($form->{$option} eq 'true') ||
       ($userenv{$option} eq 'on')) {
       $initial_env{"browser.$option"} = "on";
    }
       }
    }
   
    $env{'user.environment'} = "$lonids/$cookie.id";
   
    if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
    &GDBM_WRCREAT(),0640)) {
       &_add_to_env(\%disk_env,\%initial_env);
       &_add_to_env(\%disk_env,\%userenv,'environment.');
       &_add_to_env(\%disk_env,$userroles);
       if (ref($args->{'extra_env'})) {
    &_add_to_env(\%disk_env,$args->{'extra_env'});
       }
       untie(%disk_env);
    } else {
       &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
      'Could not create environment storage in lonauth: '.$!.'</font>');
       return 'error: '.$!;
    }
       }
       $env{'request.role'}='cm';
       $env{'request.role.adv'}=$env{'user.adv'};
       $env{'browser.type'}=$clientbrowser;
   
       return $cookie;
   
   }
   
   sub _add_to_env {
       my ($idf,$env_data,$prefix) = @_;
       while (my ($key,$value) = each(%$env_data)) {
    $idf->{$prefix.$key} = $value;
    $env{$prefix.$key}   = $value;
       }
   }
   
   
   =pod
   
 =back  =back
   
 =cut  =cut
   
   1;
   __END__;
   
Removed from v.1.100  
changed lines
  Added in v.1.539

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