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

Diff for /loncom/interface/loncommon.pm between versions 1.358 and 1.948.2.11

version 1.358, 2006/05/01 19:28:21 version 1.948.2.11, 2010/09/27 01:16:22
Line 59  use Apache::lonnet; Line 59  use Apache::lonnet;
 use GDBM_File;  use GDBM_File;
 use POSIX qw(strftime mktime);  use POSIX qw(strftime mktime);
 use Apache::lonmenu();  use Apache::lonmenu();
   use Apache::lonenc();
 use Apache::lonlocal;  use Apache::lonlocal;
   use Apache::lonnet();
 use HTML::Entities;  use HTML::Entities;
 use Apache::lonhtmlcommon();  use Apache::lonhtmlcommon();
 use Apache::loncoursedata();  use Apache::loncoursedata();
 use Apache::lontexconvert();  use Apache::lontexconvert();
   use Apache::lonclonecourse();
   use LONCAPA qw(:DEFAULT :match);
   use DateTime::TimeZone;
   use DateTime::Locale::Catalog;
   
   # ---------------------------------------------- Designs
   use vars qw(%defaultdesign);
   
 my $readit;  my $readit;
   
   
 ##  ##
 ## Global Variables  ## Global Variables
 ##  ##
   
   
   # ----------------------------------------------- SSI with retries:
   #
   
   =pod
   
   =head1 Server Side include with retries:
   
   =over 4
   
   =item * &ssi_with_retries(resource,retries form)
   
   Performs an ssi with some number of retries.  Retries continue either
   until the result is ok or until the retry count supplied by the
   caller is exhausted.  
   
   Inputs:
   
   =over 4
   
   resource   - Identifies the resource to insert.
   
   retries    - Count of the number of retries allowed.
   
   form       - Hash that identifies the rendering options.
   
   =back
   
   Returns:
   
   =over 4
   
   content    - The content of the response.  If retries were exhausted this is empty.
   
   response   - The response from the last attempt (which may or may not have been successful.
   
   =back
   
   =back
   
   =cut
   
   sub ssi_with_retries {
       my ($resource, $retries, %form) = @_;
   
   
       my $ok = 0; # True if we got a good response.
       my $content;
       my $response;
   
       # Try to get the ssi done. within the retries count:
   
       do {
    ($content, $response) = &Apache::lonnet::ssi($resource, %form);
    $ok      = $response->is_success;
           if (!$ok) {
               &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
           }
    $retries--;
       } while (!$ok && ($retries > 0));
   
       if (!$ok) {
    $content = ''; # On error return an empty content.
       }
       return ($content, $response);
   
   }
   
   
   
 # ----------------------------------------------- Filetypes/Languages/Copyright  # ----------------------------------------------- Filetypes/Languages/Copyright
 my %language;  my %language;
 my %supported_language;  my %supported_language;
Line 79  my %scprtag; Line 159  my %scprtag;
 my %fe; my %fd; my %fm;  my %fe; my %fd; my %fm;
 my %category_extensions;  my %category_extensions;
   
 # ---------------------------------------------- Designs  
   
 my %designhash;  
   
 # ---------------------------------------------- Thesaurus variables  # ---------------------------------------------- Thesaurus variables
 #  #
 # %Keywords:  # %Keywords:
Line 148  BEGIN { Line 224  BEGIN {
         }          }
     }      }
   
 # -------------------------------------------------------------- domain designs  # -------------------------------------------------------------- default domain designs
   
     my $filename;  
     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';      my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
     opendir(DIR,$designdir);      my $designfile = $designdir.'/default.tab';
     while ($filename=readdir(DIR)) {      if ( open (my $fh,"<$designfile") ) {
  if ($filename!~/\.tab$/) { next; }          while (my $line = <$fh>) {
  my ($domain)=($filename=~/^(\w+)\./);              next if ($line =~ /^\#/);
  {              chomp($line);
     my $designfile = $designdir.'/'.$filename;              my ($key,$val)=(split(/\=/,$line));
     if ( open (my $fh,"<$designfile") ) {              if ($val) { $defaultdesign{$key}=$val; }
  while (my $line = <$fh>) {          }
     next if ($line =~ /^\#/);          close($fh);
     chomp($line);  
     my ($key,$val)=(split(/\=/,$line));  
     if ($val) { $designhash{$domain.'.'.$key}=$val; }  
  }  
  close($fh);  
     }  
  }  
   
     }      }
     closedir(DIR);  
   
   
 # ------------------------------------------------------------- file categories  # ------------------------------------------------------------- file categories
     {      {
Line 207  BEGIN { Line 271  BEGIN {
         }          }
     }      }
     &Apache::lonnet::logthis(      &Apache::lonnet::logthis(
               "<font color=yellow>INFO: Read file types</font>");               "<span style='color:yellow;'>INFO: Read file types</span>");
     $readit=1;      $readit=1;
     }  # end of unless($readit)       }  # end of unless($readit) 
           
Line 223  BEGIN { Line 287  BEGIN {
   
 =over 4  =over 4
   
 =item * browser_and_searcher_javascript ()  =item * &browser_and_searcher_javascript()
   
 X<browsing, javascript>X<searching, javascript>Returns a string  X<browsing, javascript>X<searching, javascript>Returns a string
 containing javascript with two functions, C<openbrowser> and  containing javascript with two functions, C<openbrowser> and
 C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>  C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
 tags.  tags.
   
 =item * openbrowser(formname,elementname,only,omit) [javascript]  =item * &openbrowser(formname,elementname,only,omit) [javascript]
   
 inputs: formname, elementname, only, omit  inputs: formname, elementname, only, omit
   
Line 243  with the given extension.  Can be a comm Line 307  with the given extension.  Can be a comm
 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 separated 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
   
Line 255  of the element the selection from the se Line 319  of the element the selection from the se
 sub browser_and_searcher_javascript {  sub browser_and_searcher_javascript {
     my ($mode)=@_;      my ($mode)=@_;
     if (!defined($mode)) { $mode='edit'; }      if (!defined($mode)) { $mode='edit'; }
     my $resurl=&lastresurl();      my $resurl=&escape_single(&lastresurl());
     return <<END;      return <<END;
 // <!-- BEGIN LON-CAPA Internal  // <!-- BEGIN LON-CAPA Internal
     var editbrowser = null;      var editbrowser = null;
Line 266  sub browser_and_searcher_javascript { Line 330  sub browser_and_searcher_javascript {
         }          }
         url += 'catalogmode=interactive&';          url += 'catalogmode=interactive&';
         url += 'mode=$mode&';          url += 'mode=$mode&';
           url += 'inhibitmenu=yes&';
         url += 'form=' + formname + '&';          url += 'form=' + formname + '&';
         if (only != null) {          if (only != null) {
             url += 'only=' + only + '&';              url += 'only=' + only + '&';
Line 284  sub browser_and_searcher_javascript { Line 349  sub browser_and_searcher_javascript {
  }   }
         url += 'element=' + elementname + '';          url += 'element=' + elementname + '';
         var title = 'Browser';          var title = 'Browser';
         var options = 'scrollbars=1,resizable=1,menubar=1,location=1';          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();
Line 305  sub browser_and_searcher_javascript { Line 370  sub browser_and_searcher_javascript {
  }   }
         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();
Line 327  sub storeresurl { Line 392  sub storeresurl {
     unless ($resurl=~/^\/res/) { return 0; }      unless ($resurl=~/^\/res/) { return 0; }
     $resurl=~s/\/$//;      $resurl=~s/\/$//;
     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});      &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
     &Apache::lonnet::appenv('environment.lastresurl' => $resurl);      &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
     return 1;      return 1;
 }  }
   
Line 341  sub studentbrowser_javascript { Line 406  sub studentbrowser_javascript {
          || ($env{'request.role'}=~/^(au|dc|su)/)           || ($env{'request.role'}=~/^(au|dc|su)/)
           ) { return ''; }              ) { return ''; }  
    return (<<'ENDSTDBRW');     return (<<'ENDSTDBRW');
 <script type="text/javascript" language="Javascript" >  <script type="text/javascript" language="Javascript">
   // <![CDATA[
     var stdeditbrowser;      var stdeditbrowser;
     function openstdbrowser(formname,uname,udom,roleflag) {      function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
         var url = '/adm/pickstudent?';          var url = '/adm/pickstudent?';
         var filter;          var filter;
         eval('filter=document.'+formname+'.'+uname+'.value;');   if (!ignorefilter) {
       eval('filter=document.'+formname+'.'+uname+'.value;');
    }
         if (filter != null) {          if (filter != null) {
            if (filter != '') {             if (filter != '') {
                url += 'filter='+filter+'&';                 url += 'filter='+filter+'&';
Line 355  sub studentbrowser_javascript { Line 423  sub studentbrowser_javascript {
         url += 'form=' + formname + '&unameelement='+uname+          url += 'form=' + formname + '&unameelement='+uname+
                                     '&udomelement='+udom;                                      '&udomelement='+udom;
  if (roleflag) { url+="&roles=1"; }   if (roleflag) { url+="&roles=1"; }
           if (courseadvonly) { url+="&courseadvonly=1"; }
         var title = 'Student_Browser';          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');
         stdeditbrowser.focus();          stdeditbrowser.focus();
     }      }
   // ]]>
 </script>  </script>
 ENDSTDBRW  ENDSTDBRW
 }  }
   
 sub selectstudent_link {  sub selectstudent_link {
    my ($form,$unameele,$udomele)=@_;     my ($form,$unameele,$udomele,$courseadvonly)=@_;
      my $callargs = "'".$form."','".$unameele."','".$udomele."'";
    if ($env{'request.course.id'}) {       if ($env{'request.course.id'}) {  
        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})         if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
    && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.     && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
  '/'.$env{'request.course.sec'})) {   '/'.$env{'request.course.sec'})) {
    return '';     return '';
        }         }
        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.         if ($courseadvonly)  {
         '","'.$udomele.'");'."'>".&mt('Select User')."</a>";             $callargs .= ",'',1,1";
          }
          return '<span class="LC_nobreak">'.
                 '<a href="javascript:openstdbrowser('.$callargs.');">'.
                 &mt('Select User').'</a></span>';
    }     }
    if ($env{'request.role'}=~/^(au|dc|su)/) {     if ($env{'request.role'}=~/^(au|dc|su)/) {
        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.         $callargs .= ",1"; 
         '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";         return '<span class="LC_nobreak">'.
                 '<a href="javascript:openstdbrowser('.$callargs.');">'.
                 &mt('Select User').'</a></span>';
    }     }
    return '';     return '';
 }  }
   
   sub authorbrowser_javascript {
       return <<"ENDAUTHORBRW";
   <script type="text/javascript" language="JavaScript">
   // <![CDATA[
   var stdeditbrowser;
   
   function openauthorbrowser(formname,udom) {
       var url = '/adm/pickauthor?';
       url += 'form='+formname+'&roledom='+udom;
       var title = 'Author_Browser';
       var options = 'scrollbars=1,resizable=1,menubar=0';
       options += ',width=700,height=600';
       stdeditbrowser = open(url,title,options,'1');
       stdeditbrowser.focus();
   }
   
   // ]]>
   </script>
   ENDAUTHORBRW
   }
   
 sub coursebrowser_javascript {  sub coursebrowser_javascript {
     my ($domainfilter)=@_;      my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
    return (<<ENDSTDBRW);      my $wintitle = 'Course_Browser';
 <script type="text/javascript" language="Javascript" >      if ($crstype eq 'Community') {
     var stdeditbrowser;          $wintitle = 'Community_Browser';
     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag) {      }
       my $id_functions = &javascript_index_functions();
       my $output = '
   <script type="text/javascript" language="JavaScript">
   // <![CDATA[
       var stdeditbrowser;'."\n";
   
       $output .= <<"ENDSTDBRW";
       function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
         var url = '/adm/pickcourse?';          var url = '/adm/pickcourse?';
         var filter;          var formid = getFormIdByName(formname);
         if (filter != null) {          var domainfilter = getDomainFromSelectbox(formname,udom);
            if (filter != '') {  
                url += 'filter='+filter+'&';  
    }  
         }  
         var domainfilter='$domainfilter';  
         if (domainfilter != null) {          if (domainfilter != null) {
            if (domainfilter != '') {             if (domainfilter != '') {
                url += 'domainfilter='+domainfilter+'&';                 url += 'domainfilter='+domainfilter+'&';
Line 405  sub coursebrowser_javascript { Line 506  sub coursebrowser_javascript {
         url += 'form=' + formname + '&cnumelement='+uname+          url += 'form=' + formname + '&cnumelement='+uname+
                             '&cdomelement='+udom+                              '&cdomelement='+udom+
                                     '&cnameelement='+desc;                                      '&cnameelement='+desc;
         if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {          if (extra_element !=null && extra_element != '') {
             url += '&roleelement='+extra_element;              if (formname == 'rolechoice' || formname == 'studentform') {
             if (domainfilter == null || domainfilter == '') {                  url += '&roleelement='+extra_element;
                 url += '&domainfilter='+extra_element;                  if (domainfilter == null || domainfilter == '') {
                       url += '&domainfilter='+extra_element;
                   }
             }              }
               else {
                   if (formname == 'portform') {
                       url += '&setroles='+extra_element;
                   } else {
                       if (formname == 'rules') {
                           url += '&fixeddom='+extra_element; 
                       }
                   }
               }     
           }
           if (type != null && type != '') {
               url += '&type='+type;
           }
           if (type_elem != null && type_elem != '') {
               url += '&typeelement='+type_elem;
           }
           if (formname == 'ccrs') {
               var ownername = document.forms[formid].ccuname.value;
               var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
               url += '&cloner='+ownername+':'+ownerdom;
         }          }
         if (multflag !=null && multflag != '') {          if (multflag !=null && multflag != '') {
             url += '&multiple='+multflag;              url += '&multiple='+multflag;
         }          }
         var title = 'Course_Browser';          var title = '$wintitle';
         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>  $id_functions
 ENDSTDBRW  ENDSTDBRW
       if (($sec_element ne '') || ($role_element ne '')) {
           $output .= &setsec_javascript($sec_element,$formname,$role_element);
       }
       $output .= '
   // ]]>
   </script>';
       return $output;
   }
   
   sub javascript_index_functions {
       return <<"ENDJS";
   
   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;
   }
   
   function getDomainFromSelectbox(formname,udom) {
       var userdom;
       var formid = getFormIdByName(formname);
       if (formid > -1) {
           var domid = getIndexByName(formid,udom);
           if (domid > -1) {
               if (document.forms[formid].elements[domid].type == 'select-one') {
                   userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
               }
               if (document.forms[formid].elements[domid].type == 'hidden') {
                   userdom=document.forms[formid].elements[domid].value;
               }
           }
       }
       return userdom;
   }
   
   ENDJS
   
   }
   
   sub userbrowser_javascript {
       my $id_functions = &javascript_index_functions();
       return <<"ENDUSERBRW";
   
   function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
       var url = '/adm/pickuser?';
       var userdom = getDomainFromSelectbox(formname,udom);
       if (userdom != null) {
          if (userdom != '') {
              url += 'srchdom='+userdom+'&';
          }
       }
       url += 'form=' + formname + '&unameelement='+uname+
                                   '&udomelement='+udom+
                                   '&ulastelement='+ulast+
                                   '&ufirstelement='+ufirst+
                                   '&uemailelement='+uemail+
                                   '&hideudomelement='+hideudom+
                                   '&coursedom='+crsdom;
       if ((caller != null) && (caller != undefined)) {
           url += '&caller='+caller;
       }
       var title = 'User_Browser';
       var options = 'scrollbars=1,resizable=1,menubar=0';
       options += ',width=700,height=600';
       var stdeditbrowser = open(url,title,options,'1');
       stdeditbrowser.focus();
   }
   
   function fix_domain (formname,udom,origdom,uname) {
       var formid = getFormIdByName(formname);
       if (formid > -1) {
           var unameid = getIndexByName(formid,uname);
           var domid = getIndexByName(formid,udom);
           var hidedomid = getIndexByName(formid,origdom);
           if (hidedomid > -1) {
               var fixeddom = document.forms[formid].elements[hidedomid].value;
               var unameval = document.forms[formid].elements[unameid].value;
               if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                   if (domid > -1) {
                       var slct = document.forms[formid].elements[domid];
                       if (slct.type == 'select-one') {
                           var i;
                           for (i=0;i<slct.length;i++) {
                               if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                           }
                       }
                       if (slct.type == 'hidden') {
                           slct.value = fixeddom;
                       }
                   }
               }
           }
       }
       return;
   }
   
   $id_functions
   ENDUSERBRW
   }
   
   sub setsec_javascript {
       my ($sec_element,$formname,$role_element) = @_;
       my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
           $communityrolestr);
       if ($role_element ne '') {
           my @allroles = ('st','ta','ep','in','ad');
           foreach my $crstype ('Course','Community') {
               if ($crstype eq 'Community') {
                   foreach my $role (@allroles) {
                       push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                   }
                   push(@communityrolenames,&Apache::lonnet::plaintext('co'));
               } else {
                   foreach my $role (@allroles) {
                       push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                   }
                   push(@courserolenames,&Apache::lonnet::plaintext('cc'));
               }
           }
           $rolestr = '"'.join('","',@allroles).'"';
           $courserolestr = '"'.join('","',@courserolenames).'"';
           $communityrolestr = '"'.join('","',@communityrolenames).'"';
       }
       my $setsections = qq|
   function setSect(sectionlist) {
       var sectionsArray = new Array();
       if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
           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
           }
       }
   }
   
   function setRole(crstype) {
   |;
       if ($role_element eq '') {
           $setsections .= '    return;
   }
   ';
       } else {
           $setsections .= qq|
       var elementLength = document.$formname.$role_element.length;
       var allroles = Array($rolestr);
       var courserolenames = Array($courserolestr);
       var communityrolenames = Array($communityrolestr);
       if (elementLength != undefined) {
           if (document.$formname.$role_element.options[5].value == 'cc') {
               if (crstype == 'Course') {
                   return;
               } else {
                   allroles[5] = 'co';
                   for (var i=0; i<6; i++) {
                       document.$formname.$role_element.options[i].value = allroles[i];
                       document.$formname.$role_element.options[i].text = communityrolenames[i];
                   }
               }
           } else {
               if (crstype == 'Community') {
                   return;
               } else {
                   allroles[5] = 'cc';
                   for (var i=0; i<6; i++) {
                       document.$formname.$role_element.options[i].value = allroles[i];
                       document.$formname.$role_element.options[i].text = courserolenames[i];
                   }
               }
           }
       }
       return;
   }
   |;
       }
       return $setsections;
 }  }
   
 sub selectcourse_link {  sub selectcourse_link {
    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag)=@_;     my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
     return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.         $typeelement) = @_;
         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'");'."'>".&mt('Select Course')."</a>";     my $type = $selecttype;
      my $linktext = &mt('Select Course');
      if ($selecttype eq 'Community') {
          $linktext = &mt('Select Community');
      } elsif ($selecttype eq 'Course/Community') {
          $linktext = &mt('Select Course/Community');
          $type = '';
      }
      return '<span class="LC_nobreak">'
            ."<a href='"
            .'javascript:opencrsbrowser("'.$form.'","'.$unameele
            .'","'.$udomele.'","'.$desc.'","'.$extra_element
            .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
            ."'>".$linktext.'</a>'
            .'</span>';
   }
   
   sub selectauthor_link {
      my ($form,$udom)=@_;
      return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
             &mt('Select Author').'</a>';
   }
   
   sub selectuser_link {
       my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
           $coursedom,$linktext,$caller) = @_;
       return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
              "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
              ');">'.$linktext.'</a>';
 }  }
   
 sub check_uncheck_jscript {  sub check_uncheck_jscript {
Line 446  function uncheckAll(field) { Line 806  function uncheckAll(field) {
     if (field.length > 0) {      if (field.length > 0) {
         for (i = 0; i < field.length; i++) {          for (i = 0; i < field.length; i++) {
             field[i].checked = false ;              field[i].checked = false ;
         }     } else {          }
       } else {
         field.checked = false ;          field.checked = false ;
     }      }
 }  }
Line 454  ENDSCRT Line 815  ENDSCRT
     return $jscript;      return $jscript;
 }  }
   
   sub select_timezone {
      my ($name,$selected,$onchange,$includeempty)=@_;
      my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
      if ($includeempty) {
          $output .= '<option value=""';
          if (($selected eq '') || ($selected eq 'local')) {
              $output .= ' selected="selected" ';
          }
          $output .= '> </option>';
      }
      my @timezones = DateTime::TimeZone->all_names;
      foreach my $tzone (@timezones) {
          $output.= '<option value="'.$tzone.'"';
          if ($tzone eq $selected) {
              $output.=' selected="selected"';
          }
          $output.=">$tzone</option>\n";
      }
      $output.="</select>";
      return $output;
   }
   
   sub select_datelocale {
       my ($name,$selected,$onchange,$includeempty)=@_;
       my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
       if ($includeempty) {
           $output .= '<option value=""';
           if ($selected eq '') {
               $output .= ' selected="selected" ';
           }
           $output .= '> </option>';
       }
       my (@possibles,%locale_names);
       my @locales = DateTime::Locale::Catalog::Locales;
       foreach my $locale (@locales) {
           if (ref($locale) eq 'HASH') {
               my $id = $locale->{'id'};
               if ($id ne '') {
                   my $en_terr = $locale->{'en_territory'};
                   my $native_terr = $locale->{'native_territory'};
                   my @languages = &Apache::lonlocal::preferred_languages();
                   if (grep(/^en$/,@languages) || !@languages) {
                       if ($en_terr ne '') {
                           $locale_names{$id} = '('.$en_terr.')';
                       } elsif ($native_terr ne '') {
                           $locale_names{$id} = $native_terr;
                       }
                   } else {
                       if ($native_terr ne '') {
                           $locale_names{$id} = $native_terr.' ';
                       } elsif ($en_terr ne '') {
                           $locale_names{$id} = '('.$en_terr.')';
                       }
                   }
                   push (@possibles,$id);
               }
           }
       }
       foreach my $item (sort(@possibles)) {
           $output.= '<option value="'.$item.'"';
           if ($item eq $selected) {
               $output.=' selected="selected"';
           }
           $output.=">$item";
           if ($locale_names{$item} ne '') {
               $output.="  $locale_names{$item}</option>\n";
           }
           $output.="</option>\n";
       }
       $output.="</select>";
       return $output;
   }
   
   sub select_language {
       my ($name,$selected,$includeempty) = @_;
       my %langchoices;
       if ($includeempty) {
           %langchoices = ('' => 'No language preference');
       }
       foreach my $id (&languageids()) {
           my $code = &supportedlanguagecode($id);
           if ($code) {
               $langchoices{$code} = &plainlanguagedescription($id);
           }
       }
       return &select_form($selected,$name,\%langchoices);
   }
   
 =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
 changing the value of the first menu will result in new values being placed  changing the value of the first menu will result in new values being placed
 in the second menu.  The values in the select menu will appear in alphabetical  in the second menu.  The values in the select menu will appear in alphabetical
 order.  order unless a defined order is provided.
   
 linked_select_forms takes the following ordered inputs:  linked_select_forms takes the following ordered inputs:
   
Line 481  linked_select_forms takes the following Line 929  linked_select_forms takes the following
   
 =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.
   
   =item * $menuorder, the order of values in the first menu
   
 =back   =back 
   
 Below is an example of such a hash.  Only the 'text', 'default', and   Below is an example of such a hash.  Only the 'text', 'default', and 
Line 497  $menu{$choice1}->{'select2'}. Line 947  $menu{$choice1}->{'select2'}.
                            B2 => "Choice B2",                             B2 => "Choice B2",
                            B3 => "Choice B3",                             B3 => "Choice B3",
                            B4 => "Choice B4"                             B4 => "Choice B4"
                            }                             },
                          order => ['B4','B3','B1','B2'],
                    },                     },
                A2 => { text =>"Choice A2" ,                 A2 => { text =>"Choice A2" ,
                        default => "C2",                         default => "C2",
Line 505  $menu{$choice1}->{'select2'}. Line 956  $menu{$choice1}->{'select2'}.
                            C1 => "Choice C1",                             C1 => "Choice C1",
                            C2 => "Choice C2",                             C2 => "Choice C2",
                            C3 => "Choice C3"                             C3 => "Choice C3"
                            }                             },
                          order => ['C2','C1','C3'],
                    },                     },
                A3 => { text =>"Choice A3" ,                 A3 => { text =>"Choice A3" ,
                        default => "D6",                         default => "D6",
Line 517  $menu{$choice1}->{'select2'}. Line 969  $menu{$choice1}->{'select2'}.
                            D5 => "Choice D5",                             D5 => "Choice D5",
                            D6 => "Choice D6",                             D6 => "Choice D6",
                            D7 => "Choice D7"                             D7 => "Choice D7"
                            }                             },
                          order => ['D4','D3','D2','D1','D7','D6','D5'],
                    }                     }
                );                 );
   
Line 529  sub linked_select_forms { Line 982  sub linked_select_forms {
         $firstdefault,          $firstdefault,
         $firstselectname,          $firstselectname,
         $secondselectname,           $secondselectname, 
         $hashref          $hashref,
           $menuorder,
         ) = @_;          ) = @_;
     my $second = "document.$formname.$secondselectname";      my $second = "document.$formname.$secondselectname";
     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 type=\"text/javascript\">\n";      $result.='<script type="text/javascript" language="JavaScript">'."\n";
       $result.="// <![CDATA[\n";
     $result.="var select2data = new Object();\n";      $result.="var select2data = new Object();\n";
     $" = '","';      $" = '","';
     my $debug = '';      my $debug = '';
Line 543  sub linked_select_forms { Line 998  sub linked_select_forms {
         $result.="select2data.d_$s1 = new Object();\n";                  $result.="select2data.d_$s1 = new Object();\n";        
         $result.="select2data.d_$s1.def = new String('".          $result.="select2data.d_$s1.def = new String('".
             $hashref->{$s1}->{'default'}."');\n";              $hashref->{$s1}->{'default'}."');\n";
         $result.="select2data.d_$s1.values = new Array(";                  $result.="select2data.d_$s1.values = new Array(";
         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));          my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
           if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
               @s2values = @{$hashref->{$s1}->{'order'}};
           }
         $result.="\"@s2values\");\n";          $result.="\"@s2values\");\n";
         $result.="select2data.d_$s1.texts = new Array(";                  $result.="select2data.d_$s1.texts = new Array(";        
         my @s2texts;          my @s2texts;
Line 578  function select1_changed() { Line 1036  function select1_changed() {
         }          }
     }      }
 }  }
   // ]]>
 </script>  </script>
 END  END
     # output the initial values for the selection lists      # output the initial values for the selection lists
     $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))) {      my @order = sort(keys(%{$hashref}));
       if (ref($menuorder) eq 'ARRAY') {
           @order = @{$menuorder};
       }
       foreach my $value (@order) {
         $result.="    <option value=\"$value\" ";          $result.="    <option value=\"$value\" ";
         $result.=" selected=\"selected\" " if ($value eq $firstdefault);          $result.=" selected=\"selected\" " if ($value eq $firstdefault);
         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";          $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
Line 592  END Line 1055  END
     $result .= $middletext;      $result .= $middletext;
     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";      $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
     my $seconddefault = $hashref->{$firstdefault}->{'default'};      my $seconddefault = $hashref->{$firstdefault}->{'default'};
     foreach my $value (sort(keys(%select2))) {      
       my @secondorder = sort(keys(%select2));
       if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
           @secondorder = @{$hashref->{$firstdefault}->{'order'}};
       }
       foreach my $value (@secondorder) {
         $result.="    <option value=\"$value\" ";                  $result.="    <option value=\"$value\" ";        
         $result.=" selected=\"selected\" " if ($value eq $seconddefault);          $result.=" selected=\"selected\" " if ($value eq $seconddefault);
         $result.=">".&mt($select2{$value})."</option>\n";          $result.=">".&mt($select2{$value})."</option>\n";
Line 604  END Line 1072  END
   
 =pod  =pod
   
 =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)  =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
   
 Returns a string corresponding to an HTML link to the given help  Returns a string corresponding to an HTML link to the given help
 $topic, where $topic corresponds to the name of a .tex file in  $topic, where $topic corresponds to the name of a .tex file in
Line 627  be useful for certain help topics with b Line 1095  be useful for certain help topics with b
 =cut  =cut
   
 sub help_open_topic {  sub help_open_topic {
     my ($topic, $text, $stayOnPage, $width, $height) = @_;      my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
     $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' ||  
  $env{'environment.remote'} eq 'off' ) {  
  $stayOnPage=1;  
     }  
     $width = 350 if (not defined $width);      $width = 350 if (not defined $width);
     $height = 400 if (not defined $height);      $height = 400 if (not defined $height);
     my $filename = $topic;      my $filename = $topic;
Line 641  sub help_open_topic { Line 1105  sub help_open_topic {
   
     my $template = "";      my $template = "";
     my $link;      my $link;
       
     $topic=~s/\W/\_/g;      $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'))";
     }      } else {
     else  
     {  
  $link = "/adm/help/${filename}.hlp";   $link = "/adm/help/${filename}.hlp";
     }      }
   
     # Add the text      # Add the text
     if ($text ne "")      if ($text ne "") {
     {   $template.='<span class="LC_help_open_topic">'
  $template .=                     .'<a target="_top" href="'.$link.'">'
   "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".                    .$text.'</a>';
   "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";  
     }      }
   
     # Add the graphic      # (Always) Add the graphic
     my $title = &mt('Online Help');      my $title = &mt('Online Help');
     my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");      my $helpicon=&lonhttpdurl("/adm/help/help.png");
     $template .= <<"ENDTEMPLATE";      if ($imgid ne '') {
  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>          $imgid = ' id="'.$imgid.'"';
 ENDTEMPLATE      }
     if ($text ne '') { $template.='</td></tr></table>' };      $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                 .'<img src="'.$helpicon.'" border="0"'
                 .' alt="'.&mt('Help: [_1]',$topic).'"'
                 .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
                 .' /></a>';
       if ($text ne "") {
           $template.='</span>';
       }
     return $template;      return $template;
   
 }  }
Line 675  ENDTEMPLATE Line 1142  ENDTEMPLATE
 # This is a quicky function for Latex cheatsheet editing, since it   # This is a quicky function for Latex cheatsheet editing, since it 
 # appears in at least four places  # appears in at least four places
 sub helpLatexCheatsheet {  sub helpLatexCheatsheet {
     my $other = shift;      my ($topic,$text,$not_author) = @_;
       my $out;
     my $addOther = '';      my $addOther = '';
     if ($other) {      if ($topic) {
  $addOther = Apache::loncommon::help_open_topic($other, shift,   $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
        undef, undef, 600) .         undef, undef, 600).
    '</td><td>';     '</span> ';
     }      }
     return '<table><tr><td>'.      $out = '<span>' # Start cheatsheet
  $addOther .    .$addOther
  &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',            .'<span>'
     undef,undef,600)    .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
  .'</td><td>'.         undef,undef,600)
  &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',    .'</span> <span>'
     undef,undef,600)    .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
  .'</td></tr></table>';         undef,undef,600)
     .'</span>';
       unless ($not_author) {
           $out .= ' <span>'
          .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                                               undef,undef,600)
          .'</span>';
       }
       $out .= '</span>'; # End cheatsheet
       return $out;
   }
   
   sub general_help {
       my $helptopic='Student_Intro';
       if ($env{'request.role'}=~/^(ca|au)/) {
    $helptopic='Authoring_Intro';
       } elsif ($env{'request.role'}=~/^(cc|co)/) {
    $helptopic='Course_Coordination_Intro';
       } elsif ($env{'request.role'}=~/^dc/) {
           $helptopic='Domain_Coordination_Intro';
       }
       return $helptopic;
 }  }
   
 sub help_open_menu {  sub update_help_link {
     my ($color,$topic,$component_help,$function,$faq,$bug,$stayOnPage,$width,$height,$text) = @_;      my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
     $text = "" if (not defined $text);  
     $stayOnPage = 0 if (not defined $stayOnPage);  
     if ($env{'browser.interface'} eq 'textual' ||  
         $env{'environment.remote'} eq 'off' ) {  
         $stayOnPage=1;  
     }  
     $width = 620 if (not defined $width);  
     $height = 600 if (not defined $height);  
     my $link='';  
     my $title = &mt('Get help');  
     my $origurl = $ENV{'REQUEST_URI'};      my $origurl = $ENV{'REQUEST_URI'};
     $origurl=~s|^/~|/priv/|;      $origurl=~s|^/~|/priv/|;
     my $timestamp = time;      my $timestamp = time;
     foreach my $datum (\$color,\$function,\$topic,\$component_help,\$faq,      foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
        \$bug,\$origurl) {          $$datum = &escape($$datum);
         $$datum = &Apache::lonnet::escape($$datum);  
     }      }
     if (!$stayOnPage) {  
          $link = "javascript:helpMenu('open')";      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";
     } else {      my $output .= <<"ENDOUTPUT";
         $link = "javascript:helpMenu('display')";  <script type="text/javascript">
   // <![CDATA[
   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);
       # only use pop-up help (stayOnPage == 0)
       # if environment.remote is on (using remote control UI)
       if ($env{'environment.remote'} eq 'off' ) {
           $stayOnPage=1;
     }      }
     my $banner_link = "/adm/helpmenu?page=banner&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";      my $output;
     my $details_link = "/adm/helpmenu?page=body&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp";      if ($component_help) {
     my $template;   if (!$text) {
     if ($text ne "") {      $output=&help_open_topic($component_help,undef,$stayOnPage,
  $template .=          $width,$height);
   "<table bgcolor='#CC3300' cellspacing='1' cellpadding='1' border='0'><tr>".   } else {
   "<td bgcolor='#CC6600'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";      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 $stay_on_page = 
    ($env{'environment.remote'} eq 'off' );
       my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                        : "javascript:helpMenu('open')";
       my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
   
       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{'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 $nothing=&Apache::lonhtmlcommon::javascript_nothing();
     my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");  
     my $start_page =      my $start_page =
         &Apache::loncommon::start_page('Help Menu', undef,          &Apache::loncommon::start_page('Help Menu', undef,
        {'frameset'    => 1,         {'frameset'    => 1,
  'js_ready'    => 1,   'js_ready'    => 1,
  'add_entries' => {   'add_entries' => {
     'border' => '0',      'border' => '0',
     'rows'   => "105,*",},});      'rows'   => "110,*",},});
     my $end_page =      my $end_page =
         &Apache::loncommon::end_page({'frameset' => 1,          &Apache::loncommon::end_page({'frameset' => 1,
       'js_ready' => 1,});        'js_ready' => 1,});
   
     $template .= <<"ENDTEMPLATE";      my $template .= <<"ENDTEMPLATE";
  <script type="text/javascript">  <script type="text/javascript">
 // <!-- BEGIN LON-CAPA Internal  
 // <![CDATA[  // <![CDATA[
   // <!-- BEGIN LON-CAPA Internal
   var banner_link = '';
 function helpMenu(target) {  function helpMenu(target) {
     var caller = this;      var caller = this;
     if (target == 'open') {      if (target == 'open') {
Line 760  function helpMenu(target) { Line 1291  function helpMenu(target) {
     return;      return;
 }  }
 function writeHelp(caller) {  function writeHelp(caller) {
     caller.document.writeln('$start_page<frame name="bannerframe"  src="$banner_link" /><frame name="bodyframe" src="$details_link" /> $end_page')      caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
     caller.document.close()      caller.document.close()
     caller.focus()      caller.focus()
 }  }
 // ]]>  
 // END LON-CAPA Internal -->  // END LON-CAPA Internal -->
  </script>  // ]]>
  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help Menu)" /></a>  </script>
 ENDTEMPLATE  ENDTEMPLATE
     if ($component_help) {  
  if (!$text) {  
     $template=&help_open_topic($component_help,undef,$stayOnPage,  
        $width,$height).' '.$template;  
  } else {  
     my $help_text;  
     $help_text=&Apache::lonnet::unescape($topic);  
     $template='<table><tr><td>'.  
  &help_open_topic($component_help,$help_text,$stayOnPage,  
  $width,$height).'</td><td>'.$template.  
  '</td></tr></table>';  
  }  
     }  
     if ($text ne '') { $template.='</td></tr></table>' };  
     return $template;      return $template;
 }  }
   
Line 792  sub help_open_bug { Line 1308  sub help_open_bug {
     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }      unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
     $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{'environment.remote'} eq 'off' ) {
  $env{'environment.remote'} eq 'off' ) {  
  $stayOnPage=1;   $stayOnPage=1;
     }      }
     $width = 600 if (not defined $width);      $width = 600 if (not defined $width);
Line 802  sub help_open_bug { Line 1317  sub help_open_bug {
     $topic=~s/\W+/\+/g;      $topic=~s/\W+/\+/g;
     my $link='';      my $link='';
     my $template='';      my $template='';
     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.      my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
  &Apache::lonnet::escape($ENV{'REQUEST_URI'}).'&component='.$topic;   &escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
     if (!$stayOnPage)      if (!$stayOnPage)
     {      {
  $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";   $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
Line 817  sub help_open_bug { Line 1332  sub help_open_bug {
     {      {
  $template .=    $template .= 
   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".    "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
   "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";    "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
     }      }
   
     # Add the graphic      # Add the graphic
     my $title = &mt('Report a Bug');      my $title = &mt('Report a Bug');
     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");      my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
     $template .= <<"ENDTEMPLATE";      $template .= <<"ENDTEMPLATE";
  <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>   <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
 ENDTEMPLATE  ENDTEMPLATE
     if ($text ne '') { $template.='</td></tr></table>' };      if ($text ne '') { $template.='</td></tr></table>' };
     return $template;      return $template;
Line 837  sub help_open_faq { Line 1352  sub help_open_faq {
     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }      unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
     $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{'environment.remote'} eq 'off' ) {
  $env{'environment.remote'} eq 'off' ) {  
  $stayOnPage=1;   $stayOnPage=1;
     }      }
     $width = 350 if (not defined $width);      $width = 350 if (not defined $width);
Line 862  sub help_open_faq { Line 1376  sub help_open_faq {
     {      {
  $template .=    $template .= 
   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".    "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
   "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";    "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
     }      }
   
     # Add the graphic      # Add the graphic
     my $title = &mt('View the FAQ');      my $title = &mt('View the FAQ');
     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");      my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
     $template .= <<"ENDTEMPLATE";      $template .= <<"ENDTEMPLATE";
  <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>   <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
 ENDTEMPLATE  ENDTEMPLATE
     if ($text ne '') { $template.='</td></tr></table>' };      if ($text ne '') { $template.='</td></tr></table>' };
     return $template;      return $template;
Line 881  ENDTEMPLATE Line 1395  ENDTEMPLATE
   
 =pod  =pod
   
 =item * change_content_javascript():  =item * &change_content_javascript():
   
 This and the next function allow you to create small sections of an  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  otherwise static HTML page that you can update on the fly with
Line 936  DOMBASED Line 1450  DOMBASED
   
 =pod  =pod
   
 =item * changable_area($name, $origContent):  =item * &changable_area($name,$origContent):
   
 This provides a "changable area" that can be modified on the fly via  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 Javascript code provided in C<change_content_javascript>. $name is
Line 960  sub changable_area { Line 1474  sub changable_area {
   
 =pod  =pod
   
   =item * &viewport_geometry_js 
   
   Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
   
   =cut
   
   
   sub viewport_geometry_js { 
       return <<"GEOMETRY";
   var Geometry = {};
   function init_geometry() {
       if (Geometry.init) { return };
       Geometry.init=1;
       if (window.innerHeight) {
           Geometry.getViewportHeight   = function() { return window.innerHeight; };
           Geometry.getViewportWidth   = function() { return window.innerWidth; };
           Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
           Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
       }
       else if (document.documentElement && document.documentElement.clientHeight) {
           Geometry.getViewportHeight =
               function() { return document.documentElement.clientHeight; };
           Geometry.getViewportWidth =
               function() { return document.documentElement.clientWidth; };
   
           Geometry.getHorizontalScroll =
               function() { return document.documentElement.scrollLeft; };
           Geometry.getVerticalScroll =
               function() { return document.documentElement.scrollTop; };
       }
       else if (document.body.clientHeight) {
           Geometry.getViewportHeight =
               function() { return document.body.clientHeight; };
           Geometry.getViewportWidth =
               function() { return document.body.clientWidth; };
           Geometry.getHorizontalScroll =
               function() { return document.body.scrollLeft; };
           Geometry.getVerticalScroll =
               function() { return document.body.scrollTop; };
       }
   }
   
   GEOMETRY
   }
   
   =pod
   
   =item * &viewport_size_js()
   
   Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
   
   =cut
   
   sub viewport_size_js {
       my $geometry = &viewport_geometry_js();
       return <<"DIMS";
   
   $geometry
   
   function getViewportDims(width,height) {
       init_geometry();
       width.value = Geometry.getViewportWidth();
       height.value = Geometry.getViewportHeight();
       return;
   }
   
   DIMS
   }
   
   =pod
   
   =item * &resize_textarea_js()
   
   emits the needed javascript to resize a textarea to be as big as possible
   
   creates a function resize_textrea that takes two IDs first should be
   the id of the element to resize, second should be the id of a div that
   surrounds everything that comes after the textarea, this routine needs
   to be attached to the <body> for the onload and onresize events.
   
 =back  =back
   
   =cut
   
   sub resize_textarea_js {
       my $geometry = &viewport_geometry_js();
       return <<"RESIZE";
       <script type="text/javascript">
   // <![CDATA[
   $geometry
   
   function getX(element) {
       var x = 0;
       while (element) {
    x += element.offsetLeft;
    element = element.offsetParent;
       }
       return x;
   }
   function getY(element) {
       var y = 0;
       while (element) {
    y += element.offsetTop;
    element = element.offsetParent;
       }
       return y;
   }
   
   
   function resize_textarea(textarea_id,bottom_id) {
       init_geometry();
       var textarea        = document.getElementById(textarea_id);
       //alert(textarea);
   
       var textarea_top    = getY(textarea);
       var textarea_height = textarea.offsetHeight;
       var bottom          = document.getElementById(bottom_id);
       var bottom_top      = getY(bottom);
       var bottom_height   = bottom.offsetHeight;
       var window_height   = Geometry.getViewportHeight();
       var fudge           = 23;
       var new_height      = window_height-fudge-textarea_top-bottom_height;
       if (new_height < 300) {
    new_height = 300;
       }
       textarea.style.height=new_height+'px';
   }
   // ]]>
   </script>
   RESIZE
   
   }
   
   =pod
   
 =head1 Excel and CSV file utility routines  =head1 Excel and CSV file utility routines
   
 =over 4  =over 4
Line 973  sub changable_area { Line 1620  sub changable_area {
   
 =pod  =pod
   
 =item * csv_translate($text)   =item * &csv_translate($text) 
   
 Translate $text to allow it to be output as a 'comma separated values'   Translate $text to allow it to be output as a 'comma separated values' 
 format.  format.
Line 994  sub csv_translate { Line 1641  sub csv_translate {
   
 =pod  =pod
   
 =item * define_excel_formats  =item * &define_excel_formats()
   
 Define some commonly used Excel cell formats.  Define some commonly used Excel cell formats.
   
Line 1050  sub define_excel_formats { Line 1697  sub define_excel_formats {
   
 =pod  =pod
   
 =item * create_workbook  =item * &create_workbook()
   
 Create an Excel worksheet.  If it fails, output message on the  Create an Excel worksheet.  If it fails, output message on the
 request object and return undefs.  request object and return undefs.
Line 1075  sub create_workbook { Line 1722  sub create_workbook {
     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);      my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
     if (! defined($workbook)) {      if (! defined($workbook)) {
         $r->log_error("Error creating excel spreadsheet $filename: $!");          $r->log_error("Error creating excel spreadsheet $filename: $!");
         $r->print('<p>'.&mt("Unable to create new Excel file.  ".          $r->print(
                             "This error has been logged.  ".              '<p class="LC_error">'
                             "Please alert your LON-CAPA administrator").             .&mt('Problems occurred in creating the new Excel file.')
                   '</p>');             .' '.&mt('This error has been logged.')
              .' '.&mt('Please alert your LON-CAPA administrator.')
              .'</p>'
           );
         return (undef);          return (undef);
     }      }
     #      #
Line 1093  sub create_workbook { Line 1743  sub create_workbook {
   
 =pod  =pod
   
 =item * create_text_file  =item * &create_text_file()
   
 Create a file to write to and eventually make available to the usre.  Create a file to write to and eventually make available to the user.
 If file creation fails, outputs an error message on the request object and   If file creation fails, outputs an error message on the request object and 
 return undefs.  return undefs.
   
Line 1118  sub create_text_file { Line 1768  sub create_text_file {
     $fh = Apache::File->new('>/home/httpd'.$filename);      $fh = Apache::File->new('>/home/httpd'.$filename);
     if (! defined($fh)) {      if (! defined($fh)) {
         $r->log_error("Couldn't open $filename for output $!");          $r->log_error("Couldn't open $filename for output $!");
         $r->print("Problems occured in creating the output file.  ".          $r->print(
                   "This error has been logged.  ".              '<p class="LC_error">'
                   "Please alert your LON-CAPA administrator.");             .&mt('Problems occurred in creating the output file.')
              .' '.&mt('This error has been logged.')
              .' '.&mt('Please alert your LON-CAPA administrator.')
              .'</p>'
           );
     }      }
     return ($fh,$filename)      return ($fh,$filename)
 }  }
Line 1136  sub create_text_file { Line 1790  sub create_text_file {
 ##        Home server <option> list generating code          ##  ##        Home server <option> list generating code          ##
 ###############################################################  ###############################################################
   
 =pod  
   
 =head1 Home Server option list generating code  
   
 =over 4  
   
 =item * get_domains()  
   
 Returns an array containing each of the domains listed in the hosts.tab  
 file.  
   
 =cut  
   
 #-------------------------------------------  
 sub get_domains {  
     # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.  
     my @domains;  
     my %seen;  
     foreach my $dom (sort(values(%Apache::lonnet::hostdom))) {  
  push(@domains,$dom) unless $seen{$dom}++;  
     }  
     return @domains;  
 }  
   
 # ------------------------------------------  # ------------------------------------------
   
 sub domain_select {  sub domain_select {
     my ($name,$value,$multiple)=@_;      my ($name,$value,$multiple)=@_;
     my %domains=map {       my %domains=map { 
  $_ => $_.' '.$Apache::lonnet::domaindescription{$_}    $_ => $_.' '. &Apache::lonnet::domain($_,'description') 
     } &get_domains;      } &Apache::lonnet::all_domains();
     if ($multiple) {      if ($multiple) {
  $domains{''}=&mt('Any domain');   $domains{''}=&mt('Any domain');
    $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
  return &multiple_select_form($name,$value,4,\%domains);   return &multiple_select_form($name,$value,4,\%domains);
     } else {      } else {
  return &select_form($name,$value,%domains);   $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
    return &select_form($name,$value,\%domains);
     }      }
 }  }
   
Line 1179  sub domain_select { Line 1811  sub domain_select {
   
 =pod  =pod
   
 =item * multiple_select_form($name,$value,$size,$hash,$order)  =head1 Routines for form select boxes
   
   =over 4
   
   =item * &multiple_select_form($name,$value,$size,$hash,$order)
   
 Returns a string containing a <select> element int multiple mode  Returns a string containing a <select> element int multiple mode
   
   
 Args:  Args:
   $name - name of the <select> element    $name - name of the <select> element
   $value - sclara or array ref of values that should already be selected    $value - scalar or array ref of values that should already be selected
   $size - number of rows long the select element is    $size - number of rows long the select element is
   $hash - the elements should be 'option' => 'shown text'    $hash - the elements should be 'option' => 'shown text'
           (shown text should already have been &mt())            (shown text should already have been &mt())
   $order - (optional) array ref of the order to show the elments in    $order - (optional) array ref of the order to show the elements in
   
 =cut  =cut
   
Line 1205  sub multiple_select_form { Line 1841  sub multiple_select_form {
             $size = scalar(keys(%$hash));              $size = scalar(keys(%$hash));
         }          }
     }      }
     $output.="\n<select name='$name' size='$size' multiple='1'>";      $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
     my @order = ref($order) ? @$order      my @order;
                             : sort(keys(%$hash));      if (ref($order) eq 'ARRAY')  {
           @order = @{$order};
       } else {
           @order = sort(keys(%$hash));
       }
       if (exists($$hash{'select_form_order'})) {
           @order = @{$$hash{'select_form_order'}};
       }
           
     foreach my $key (@order) {      foreach my $key (@order) {
         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';          $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
         $output.='selected="selected" ' if ($selected{$key});          $output.='selected="selected" ' if ($selected{$key});
Line 1221  sub multiple_select_form { Line 1865  sub multiple_select_form {
   
 =pod  =pod
   
 =item * select_form($defdom,$name,%hash)  =item * &select_form($defdom,$name,$hashref,$onchange)
   
 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 ref to a hash containing:
   option_name => displayed text. An optional $onchange can include
   a javascript onchange item, e.g., onchange="this.form.submit();"
   
 See lonrights.pm for an example invocation and use.  See lonrights.pm for an example invocation and use.
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub select_form {  sub select_form {
     my ($def,$name,%hash) = @_;      my ($def,$name,$hashref,$onchange) = @_;
     my $selectform = "<select name=\"$name\" size=\"1\">\n";      return unless (ref($hashref) eq 'HASH');
       if ($onchange) {
           $onchange = ' onchange="'.$onchange.'"';
       }
       my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
     my @keys;      my @keys;
     if (exists($hash{'select_form_order'})) {      if (exists($hashref->{'select_form_order'})) {
  @keys=@{$hash{'select_form_order'}};          @keys=@{$hashref->{'select_form_order'}};
     } else {      } else {
  @keys=sort(keys(%hash));          @keys=sort(keys(%{$hashref}));
     }      }
     foreach my $key (@keys) {      foreach my $key (@keys) {
         $selectform.=          $selectform.=
     '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.      '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
             ($key eq $def ? 'selected="selected" ' : '').              ($key eq $def ? 'selected="selected" ' : '').
                 ">".&mt($hash{$key})."</option>\n";                  ">".$hashref->{$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 '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
          &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
      (&mt('all'),10,20,50,100,1000,10000))).
      '</label></span> <span class="LC_nobreak">'.
              &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'}).'" /></span>';
   }
   
 sub gradeleveldescription {  sub gradeleveldescription {
     my $gradelevel=shift;      my $gradelevel=shift;
     my %gradelevels=(0 => 'Not specified',      my %gradelevels=(0 => 'Not specified',
Line 1290  sub select_level_form { Line 1959  sub select_level_form {
   
 =pod  =pod
   
 =item * select_dom_form($defdom,$name,$includeempty)  =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
   
 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 1299  See loncreateuser.pm for an example invo Line 1968  See loncreateuser.pm for an example invo
 If the $includeempty flag is set, it also includes an empty choice ("no domain  If the $includeempty flag is set, it also includes an empty choice ("no domain
 selected");  selected");
   
   If the $showdomdesc flag is set, the domain name is followed by the domain description.
   
   The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
   
   The optional $incdoms is a reference to an array of domains which will be the only available options. 
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub select_dom_form {  sub select_dom_form {
     my ($defdom,$name,$includeempty) = @_;      my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
     my @domains = get_domains();      if ($onchange) {
           $onchange = ' onchange="'.$onchange.'"';
       }
       my @domains;
       if (ref($incdoms) eq 'ARRAY') {
           @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
       } else {
           @domains = sort {lc($a) cmp lc($b)} (&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\"$onchange>\n";
     foreach my $dom (@domains) {      foreach my $dom (@domains) {
         $selectdomain.="<option value=\"$dom\" ".          $selectdomain.="<option value=\"$dom\" ".
             ($dom eq $defdom ? 'selected="selected" ' : '').              ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                 ">$dom</option>\n";          if ($showdomdesc) {
               if ($dom ne '') {
                   my $domdesc = &Apache::lonnet::domain($dom,'description');
                   if ($domdesc ne '') {
                       $selectdomain .= ' ('.$domdesc.')';
                   }
               } 
           }
           $selectdomain .= "</option>\n";
     }      }
     $selectdomain.="</select>";      $selectdomain.="</select>";
     return $selectdomain;      return $selectdomain;
Line 1320  sub select_dom_form { Line 2011  sub select_dom_form {
   
 =pod  =pod
   
 =item * get_library_servers($domain)  =item * &home_server_form_item($domain,$name,$defaultflag)
   
 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  input: 4 arguments (two required, two optional) - 
       $domain - domain of new user
 #-------------------------------------------      $name - name of form element
 sub get_library_servers {      $default - Value of 'default' causes a default item to be first 
     my $domain = shift;                              option, and selected by default. 
     my %library_servers;      $hide - Value of 'hide' causes hiding of the name of the server, 
     foreach my $hostid (keys(%Apache::lonnet::libserv)) {                              if 1 server found, or default, if 0 found.
         if ($Apache::lonnet::hostdom{$hostid} eq $domain) {  output: returns 2 items: 
             $library_servers{$hostid} = $Apache::lonnet::hostname{$hostid};  (a) form element which contains either:
         }     (i) <select name="$name">
     }          <option value="$hostid1">$hostid $servers{$hostid}</option>
     return %library_servers;          <option value="$hostid2">$hostid $servers{$hostid}</option>       
 }         </select>
          form item if there are multiple library servers in $domain, or
 #-------------------------------------------     (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
          if there is only one library server in $domain.
 =pod  
   
 =item * home_server_option_list($domain)  (b) number of library servers found.
   
 returns a string which contains an <option> list to be used in a   See loncreateuser.pm for example of use.
 <select> form input.  See loncreateuser.pm for an example.  
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub home_server_option_list {  sub home_server_form_item {
     my $domain = shift;      my ($domain,$name,$default,$hide) = @_;
     my %servers = &get_library_servers($domain);      my %servers = &Apache::lonnet::get_servers($domain,'library');
     my $result = '';      my $result;
     foreach my $hostid (sort(keys(%servers))) {      my $numlib = keys(%servers);
         $result.=      if ($numlib > 1) {
             '<option value="'.$hostid.'">'.          $result .= '<select name="'.$name.'" />'."\n";
     $hostid.' '.$servers{$hostid}."</option>\n";          if ($default) {
               $result .= '<option value="default" selected="selected">'.&mt('default').
                          '</option>'."\n";
           }
           foreach my $hostid (sort(keys(%servers))) {
               $result.= '<option value="'.$hostid.'">'.
                 $hostid.' '.$servers{$hostid}."</option>\n";
           }
           $result .= '</select>'."\n";
       } elsif ($numlib == 1) {
           my $hostid;
           foreach my $item (keys(%servers)) {
               $hostid = $item;
           }
           $result .= '<input type="hidden" name="'.$name.'" value="'.
                      $hostid.'" />';
                      if (!$hide) {
                          $result .= $hostid.' '.$servers{$hostid};
                      }
                      $result .= "\n";
       } elsif ($default) {
           $result .= '<input type="hidden" name="'.$name.
                      '" value="default" />';
                      if (!$hide) {
                          $result .= &mt('default');
                      }
                      $result .= "\n";
     }      }
     return $result;      return ($result,$numlib);
 }  }
   
 =pod  =pod
   
 =back  =back 
   
 =cut  =cut
   
Line 1460  sub decode_user_agent { Line 2171  sub decode_user_agent {
   
 =over 4  =over 4
   
 =item * authform_xxxxxx  =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.  
 This is not an optimal method, but it works.    This is not an optimal method, but it works.  
   
 See loncreateuser.pm for invocation and use examples.  
   
 =over 4  =over 4
   
 =item * authform_header  =item * authform_header
Line 1484  See loncreateuser.pm for invocation and Line 2193  See loncreateuser.pm for invocation and
   
 =back  =back
   
 =back   See loncreateuser.pm for invocation and use examples.
   
 =cut  =cut
   
Line 1514  END Line 2223  END
     }      }
   
     my $radioval = "'nochange'";      my $radioval = "'nochange'";
     if (exists($in{'curr_authtype'}) &&      if (defined($in{'curr_authtype'})) {
         defined($in{'curr_authtype'}) &&          if ($in{'curr_authtype'} ne '') {
         $in{'curr_authtype'} ne '') {              $radioval = "'".$in{'curr_authtype'}."arg'";
         $radioval = "'$in{'curr_authtype'}arg'";          }
     }      }
     my $argfield = 'null';      my $argfield = 'null';
     if ( grep/^mode$/,(keys %in) ) {      if (defined($in{'mode'})) {
         if ($in{'mode'} eq 'modifycourse')  {          if ($in{'mode'} eq 'modifycourse')  {
             if ( grep/^curr_authtype$/,(keys %in) ) {              if (defined($in{'curr_autharg'})) {
                 $radioval = "'$in{'curr_authtype'}'";                  if ($in{'curr_autharg'} ne '') {
             }  
             if ( grep/^curr_autharg$/,(keys %in) ) {  
                 unless ($in{'curr_autharg'} eq '') {  
                     $argfield = "'$in{'curr_autharg'}'";                      $argfield = "'$in{'curr_autharg'}'";
                 }                  }
             }              }
Line 1609  sub authform_nochange{ Line 2315  sub authform_nochange{
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               @_,                @_,
           );            );
     my $result = '<label>'.&mt('[_1] Do not change login data',      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                      '<input type="radio" name="login" value="nochange" '.      my $result;
                      'checked="checked" onclick="'.      if (keys(%can_assign) == 0) {
           $result = &mt('Under you current role you are not permitted to change login settings for this user');  
       } else {
           $result = '<label>'.&mt('[_1] Do not change login data',
                     '<input type="radio" name="login" value="nochange" '.
                     'checked="checked" onclick="'.
             "javascript:changed_radio('nochange',$in{'formname'});".'" />').              "javascript:changed_radio('nochange',$in{'formname'});".'" />').
     '</label>';      '</label>';
       }
     return $result;      return $result;
 }  }
   
 sub authform_kerberos{    sub authform_kerberos {
     my %in = (      my %in = (
               formname => 'document.cu',                formname => 'document.cu',
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               kerb_def_auth => 'krb4',                kerb_def_auth => 'krb4',
               @_,                @_,
               );                );
     my ($check4,$check5,$krbarg);      my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
           $autharg,$jscall);
       my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
     if ($in{'kerb_def_auth'} eq 'krb5') {      if ($in{'kerb_def_auth'} eq 'krb5') {
        $check5 = " checked=\"on\"";         $check5 = ' checked="checked"';
     } else {      } else {
        $check4 = " checked=\"on\"";         $check4 = ' checked="checked"';
     }      }
     $krbarg = $in{'kerb_def_dom'};      $krbarg = $in{'kerb_def_dom'};
       if (defined($in{'curr_authtype'})) {
     my $krbcheck = "";          if ($in{'curr_authtype'} eq 'krb') {
     if ( grep/^curr_authtype$/,(keys %in) ) {              $krbcheck = ' checked="checked"';
         if ($in{'curr_authtype'} =~ m/^krb/) {              if (defined($in{'mode'})) {
             $krbcheck = " checked=\"on\"";                  if ($in{'mode'} eq 'modifyuser') {
             if ( grep/^curr_autharg$/,(keys %in) ) {                      $krbcheck = '';
                   }
               }
               if (defined($in{'curr_kerb_ver'})) {
                   if ($in{'curr_krb_ver'} eq '5') {
                       $check5 = ' checked="checked"';
                       $check4 = '';
                   } else {
                       $check4 = ' checked="checked"';
                       $check5 = '';
                   }
               }
               if (defined($in{'curr_autharg'})) {
                 $krbarg = $in{'curr_autharg'};                  $krbarg = $in{'curr_autharg'};
             }              }
               if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   if (defined($in{'curr_autharg'})) {
                       $result = 
       &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
           $in{'curr_autharg'},$krbver);
                   } else {
                       $result =
       &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   }
                   return $result; 
               }
           }
       } else {
           if ($authnum == 1) {
               $authtype = '<input type="hidden" name="login" value="krb" />';
         }          }
     }      }
       if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
     my $jscall = "javascript:changed_radio('krb',$in{'formname'});";          return;
     my $result .= &mt      } elsif ($authtype eq '') {
           if (defined($in{'mode'})) {
               if ($in{'mode'} eq 'modifycourse') {
                   if ($authnum == 1) {
                       $authtype = '<input type="hidden" name="login" value="krb" />';
                   }
               }
           }
       }
       $jscall = "javascript:changed_radio('krb',$in{'formname'});";
       if ($authtype eq '') {
           $authtype = '<input type="radio" name="login" value="krb" '.
                       'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                       $krbcheck.' />';
       }
       if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
           ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
            $in{'curr_authtype'} eq 'krb5') ||
           (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
            $in{'curr_authtype'} eq 'krb4')) {
           $result .= &mt
         ('[_1] Kerberos authenticated with domain [_2] '.          ('[_1] Kerberos authenticated with domain [_2] '.
          '[_3] Version 4 [_4] Version 5 [_5]',           '[_3] Version 4 [_4] Version 5 [_5]',
          '<label><input type="radio" name="login" value="krb" '.           '<label>'.$authtype,
              'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',  
          '</label><input type="text" size="10" name="krbarg" '.           '</label><input type="text" size="10" name="krbarg" '.
              'value="'.$krbarg.'" '.               'value="'.$krbarg.'" '.
              'onchange="'.$jscall.'" />',               'onchange="'.$jscall.'" />',
          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',           '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',           '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
  '</label>');   '</label>');
       } elsif ($can_assign{'krb4'}) {
           $result .= &mt
           ('[_1] Kerberos authenticated with domain [_2] '.
            '[_3] Version 4 [_4]',
            '<label>'.$authtype,
            '</label><input type="text" size="10" name="krbarg" '.
                'value="'.$krbarg.'" '.
                'onchange="'.$jscall.'" />',
            '<label><input type="hidden" name="krbver" value="4" />',
            '</label>');
       } elsif ($can_assign{'krb5'}) {
           $result .= &mt
           ('[_1] Kerberos authenticated with domain [_2] '.
            '[_3] Version 5 [_4]',
            '<label>'.$authtype,
            '</label><input type="text" size="10" name="krbarg" '.
                'value="'.$krbarg.'" '.
                'onchange="'.$jscall.'" />',
            '<label><input type="hidden" name="krbver" value="5" />',
            '</label>');
       }
     return $result;      return $result;
 }  }
   
 sub authform_internal{    sub authform_internal{  
     my %args = (      my %in = (
                 formname => 'document.cu',                  formname => 'document.cu',
                 kerb_def_dom => 'MSU.EDU',                  kerb_def_dom => 'MSU.EDU',
                 @_,                  @_,
                 );                  );
       my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
     my $intcheck = "";      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
     my $intarg = 'value=""';      if (defined($in{'curr_authtype'})) {
     if ( grep/^curr_authtype$/,(keys %args) ) {          if ($in{'curr_authtype'} eq 'int') {
         if ($args{'curr_authtype'} eq 'int') {              if ($can_assign{'int'}) {
             $intcheck = " checked=\"on\"";                  $intcheck = 'checked="checked" ';
             if ( grep/^curr_autharg$/,(keys %args) ) {                  if (defined($in{'mode'})) {
                 $intarg = "value=\"$args{'curr_autharg'}\"";                      if ($in{'mode'} eq 'modifyuser') {
                           $intcheck = '';
                       }
                   }
                   if (defined($in{'curr_autharg'})) {
                       $intarg = $in{'curr_autharg'};
                   }
               } else {
                   $result = &mt('Currently internally authenticated.');
                   return $result;
             }              }
         }          }
       } else {
           if ($authnum == 1) {
               $authtype = '<input type="hidden" name="login" value="int" />';
           }
     }      }
       if (!$can_assign{'int'}) {
     my $jscall = "javascript:changed_radio('int',$args{'formname'});";          return;
     my $result.=&mt      } elsif ($authtype eq '') {
           if (defined($in{'mode'})) {
               if ($in{'mode'} eq 'modifycourse') {
                   if ($authnum == 1) {
                       $authtype = '<input type="hidden" name="login" value="int" />';
                   }
               }
           }
       }
       $jscall = "javascript:changed_radio('int',$in{'formname'});";
       if ($authtype eq '') {
           $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                       ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
       }
       $autharg = '<input type="password" size="10" name="intarg" value="'.
                  $intarg.'" onchange="'.$jscall.'" />';
       $result = &mt
         ('[_1] Internally authenticated (with initial password [_2])',          ('[_1] Internally authenticated (with initial password [_2])',
          '<label><input type="radio" name="login" value="int" '.$intcheck.           '<label>'.$authtype,'</label>'.$autharg);
              ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',      $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
          '</label><input type="text" size="10" name="intarg" '.$intarg.  
              ' onchange="'.$jscall.'" />');  
     return $result;      return $result;
 }  }
   
Line 1691  sub authform_local{ Line 2499  sub authform_local{
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               @_,                @_,
               );                );
       my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
     my $loccheck = "";      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
     my $locarg = 'value=""';      if (defined($in{'curr_authtype'})) {
     if ( grep/^curr_authtype$/,(keys %in) ) {  
         if ($in{'curr_authtype'} eq 'loc') {          if ($in{'curr_authtype'} eq 'loc') {
             $loccheck = " checked=\"on\"";              if ($can_assign{'loc'}) {
             if ( grep/^curr_autharg$/,(keys %in) ) {                  $loccheck = 'checked="checked" ';
                 $locarg = "value=\"$in{'curr_autharg'}\"";                  if (defined($in{'mode'})) {
                       if ($in{'mode'} eq 'modifyuser') {
                           $loccheck = '';
                       }
                   }
                   if (defined($in{'curr_autharg'})) {
                       $locarg = $in{'curr_autharg'};
                   }
               } else {
                   $result = &mt('Currently using local (institutional) authentication.');
                   return $result;
             }              }
         }          }
       } else {
           if ($authnum == 1) {
               $authtype = '<input type="hidden" name="login" value="loc" />';
           }
     }      }
       if (!$can_assign{'loc'}) {
     my $jscall = "javascript:changed_radio('loc',$in{'formname'});";          return;
     my $result.=&mt('[_1] Local Authentication with argument [_2]',      } elsif ($authtype eq '') {
                     '<label><input type="radio" name="login" value="loc" '.$loccheck.          if (defined($in{'mode'})) {
                         ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',              if ($in{'mode'} eq 'modifycourse') {
                     '</label><input type="text" size="10" name="locarg" '.$locarg.                  if ($authnum == 1) {
                         ' onchange="'.$jscall.'" />');                      $authtype = '<input type="hidden" name="login" value="loc" />';
                   }
               }
           }
       }
       $jscall = "javascript:changed_radio('loc',$in{'formname'});";
       if ($authtype eq '') {
           $authtype = '<input type="radio" name="login" value="loc" '.
                       $loccheck.' onchange="'.$jscall.'" onclick="'.
                       $jscall.'" />';
       }
       $autharg = '<input type="text" size="10" name="locarg" value="'.
                  $locarg.'" onchange="'.$jscall.'" />';
       $result = &mt('[_1] Local Authentication with argument [_2]',
                     '<label>'.$authtype,'</label>'.$autharg);
     return $result;      return $result;
 }  }
   
Line 1718  sub authform_filesystem{ Line 2553  sub authform_filesystem{
               kerb_def_dom => 'MSU.EDU',                kerb_def_dom => 'MSU.EDU',
               @_,                @_,
               );                );
     my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";      my ($fsyscheck,$result,$authtype,$autharg,$jscall);
     my $result.= &mt      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
       if (defined($in{'curr_authtype'})) {
           if ($in{'curr_authtype'} eq 'fsys') {
               if ($can_assign{'fsys'}) {
                   $fsyscheck = 'checked="checked" ';
                   if (defined($in{'mode'})) {
                       if ($in{'mode'} eq 'modifyuser') {
                           $fsyscheck = '';
                       }
                   }
               } else {
                   $result = &mt('Currently Filesystem Authenticated.');
                   return $result;
               }           
           }
       } else {
           if ($authnum == 1) {
               $authtype = '<input type="hidden" name="login" value="fsys" />';
           }
       }
       if (!$can_assign{'fsys'}) {
           return;
       } elsif ($authtype eq '') {
           if (defined($in{'mode'})) {
               if ($in{'mode'} eq 'modifycourse') {
                   if ($authnum == 1) {
                       $authtype = '<input type="hidden" name="login" value="fsys" />';
                   }
               }
           }
       }
       $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
       if ($authtype eq '') {
           $authtype = '<input type="radio" name="login" value="fsys" '.
                       $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                       $jscall.'" />';
       }
       $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                  ' onchange="'.$jscall.'" />';
       $result = &mt
         ('[_1] Filesystem Authenticated (with initial password [_2])',          ('[_1] Filesystem Authenticated (with initial password [_2])',
          '<label><input type="radio" name="login" value="fsys" '.           '<label><input type="radio" name="login" value="fsys" '.
          'onchange="'.$jscall.'" onclick="'.$jscall.'" />',           $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
          '</label><input type="text" size="10" name="fsysarg" value="" '.           '</label><input type="password" size="10" name="fsysarg" value="" '.
                   'onchange="'.$jscall.'" />');                    'onchange="'.$jscall.'" />');
     return $result;      return $result;
 }  }
   
 ###############################################################  sub get_assignable_auth {
 ##    Get Authentication Defaults for Domain                 ##      my ($dom) = @_;
 ###############################################################      if ($dom eq '') {
           $dom = $env{'request.role.domain'};
 =pod      }
       my %can_assign = (
 =head1 Domains and Authentication                            krb4 => 1,
                             krb5 => 1,
 Returns default authentication type and an associated argument as                            int  => 1,
 listed in file 'domain.tab'.                            loc  => 1,
                        );
 =over 4      my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
       if (ref($domconfig{'usercreation'}) eq 'HASH') {
 =item * get_auth_defaults          if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
               my $authhash = $domconfig{'usercreation'}{'authtypes'};
 get_auth_defaults($target_domain) returns the default authentication              my $context;
 type and an associated argument (initial password or a kerberos domain).              if ($env{'request.role'} =~ /^au/) {
 These values are stored in lonTabs/domain.tab                  $context = 'author';
               } elsif ($env{'request.role'} =~ /^dc/) {
 ($def_auth, $def_arg) = &get_auth_defaults($target_domain);                  $context = 'domain';
               } elsif ($env{'request.course.id'}) {
 If target_domain is not found in domain.tab, returns nothing ('').                  $context = 'course';
               }
 =cut              if ($context) {
                   if (ref($authhash->{$context}) eq 'HASH') {
 #-------------------------------------------                     %can_assign = %{$authhash->{$context}}; 
 sub get_auth_defaults {                  }
     my $domain=shift;              }
     return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});          }
       }
       my $authnum = 0;
       foreach my $key (keys(%can_assign)) {
           if ($can_assign{$key}) {
               $authnum ++;
           }
       }
       if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
           $authnum --;
       }
       return ($authnum,%can_assign);
 }  }
 ###############################################################  
 ##   End Get Authentication Defaults for Domain              ##  
 ###############################################################  
   
 ###############################################################  ###############################################################
 ##    Get Kerberos Defaults for Domain                 ##  ##    Get Kerberos Defaults for Domain                 ##
Line 1774  sub get_auth_defaults { Line 2656  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, it defaults to version 4 and the 
 version 4 and the domain of the server.  domain of the server.
   
   =over 4
   
 ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);  ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
   
   =back
   
   =back
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub get_kerberos_defaults {  sub get_kerberos_defaults {
     my $domain=shift;      my $domain=shift;
     my ($krbdef,$krbdefdom) =      my ($krbdef,$krbdefdom);
         &Apache::loncommon::get_auth_defaults($domain);      my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
     unless ($krbdef =~/^krb/ && $krbdefdom) {      if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
           $krbdef = $domdefaults{'auth_def'};
           $krbdefdom = $domdefaults{'auth_arg_def'};
       } else {
         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;          $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
         my $krbdefdom=$1;          my $krbdefdom=$1;
         $krbdefdom=~tr/a-z/A-Z/;          $krbdefdom=~tr/a-z/A-Z/;
Line 1798  sub get_kerberos_defaults { Line 2689  sub get_kerberos_defaults {
     return ($krbdef,$krbdefdom);      return ($krbdef,$krbdefdom);
 }  }
   
 =pod  
   
 =back  
   
 =cut  
   
 ###############################################################  ###############################################################
 ##                Thesaurus Functions                        ##  ##                Thesaurus Functions                        ##
Line 1814  sub get_kerberos_defaults { Line 2700  sub get_kerberos_defaults {
   
 =over 4  =over 4
   
 =item * initialize_keywords  =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 1851  sub initialize_keywords { Line 2737  sub initialize_keywords {
     # Remove special values from %Keywords.      # Remove special values from %Keywords.
     foreach my $value ('total.count','average.count') {      foreach my $value ('total.count','average.count') {
         delete($Keywords{$value}) if (exists($Keywords{$value}));          delete($Keywords{$value}) if (exists($Keywords{$value}));
     }    }
     return 1;      return 1;
 }  }
   
Line 1859  sub initialize_keywords { Line 2745  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 1880  sub keyword { Line 2766  sub keyword {
   
 =pod   =pod 
   
 =item * get_related_words  =item * &get_related_words()
   
 Look up a word in the thesaurus.  Takes a scalar argument 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
Line 1905  sub get_related_words { Line 2791  sub get_related_words {
         return ();          return ();
     }       } 
     my @Words=();      my @Words=();
       my $count=0;
     if (exists($thesaurus_db{$keyword})) {      if (exists($thesaurus_db{$keyword})) {
  # The first element is the number of times   # 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.
  (undef,@Words) = (split(/:/,$thesaurus_db{$keyword}));   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;
Line 1930  sub get_related_words { Line 2824  sub get_related_words {
   
 =over 4  =over 4
   
 =item * plainname($uname,$udom,$first)  =item * &plainname($uname,$udom,$first)
   
 Takes a users logon name and returns it as a string in  Takes a users logon name and returns it as a string in
 "first middle last generation" form   "first middle last generation" form 
Line 1943  if $first is set to 'lastname' then it r Line 2837  if $first is set to 'lastname' then it r
 ###############################################################  ###############################################################
 sub plainname {  sub plainname {
     my ($uname,$udom,$first)=@_;      my ($uname,$udom,$first)=@_;
       return if (!defined($uname) || !defined($udom));
     my %names=&getnames($uname,$udom);      my %names=&getnames($uname,$udom);
     my $name=&Apache::lonnet::format_name($names{'firstname'},      my $name=&Apache::lonnet::format_name($names{'firstname'},
   $names{'middlename'},    $names{'middlename'},
Line 1958  sub plainname { Line 2853  sub plainname {
 # -------------------------------------------------------------------- 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 1974  if the user does not Line 2869  if the user does not
   
 sub nickname {  sub nickname {
     my ($uname,$udom)=@_;      my ($uname,$udom)=@_;
       return if (!defined($uname) || !defined($udom));
     my %names=&getnames($uname,$udom);      my %names=&getnames($uname,$udom);
     my $name=$names{'nickname'};      my $name=$names{'nickname'};
     if ($name) {      if ($name) {
Line 1989  sub nickname { Line 2885  sub nickname {
   
 sub getnames {  sub getnames {
     my ($uname,$udom)=@_;      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 $id=$uname.':'.$udom;
     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);      my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
     if ($cached) {      if ($cached) {
Line 2002  sub getnames { Line 2902  sub getnames {
     }      }
 }  }
   
   # -------------------------------------------------------------------- getemails
   
   =pod
   
   =item * &getemails($uname,$udom)
   
   Gets a user's email information and returns it as a hash with keys:
   notification, critnotification, permanentemail
   
   For notification and critnotification, values are comma-separated lists 
   of e-mail addresses; for permanentemail, value is a single e-mail address.
    
   
   =cut
   
   
   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;
       }
   }
   
   sub flush_email_cache {
       my ($uname,$udom)=@_;
       if (!$udom)  { $udom =$env{'user.domain'}; }
       if (!$uname) { $uname=$env{'user.name'};   }
       return if ($udom eq 'public' && $uname eq 'public');
       my $id=$uname.':'.$udom;
       &Apache::lonnet::devalidate_cache_new('emailscache',$id);
   }
   
   # -------------------------------------------------------------------- getlangs
   
   =pod
   
   =item * &getlangs($uname,$udom)
   
   Gets a user's language preference and returns it as a hash with key:
   language.
   
   =cut
   
   
   sub getlangs {
       my ($uname,$udom) = @_;
       if (!$udom)  { $udom =$env{'user.domain'}; }
       if (!$uname) { $uname=$env{'user.name'};   }
       my $id=$uname.':'.$udom;
       my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
       if ($cached) {
           return %{$langs};
       } else {
           my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                                              $udom,$uname);
           &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
           return %loadlangs;
       }
   }
   
   sub flush_langs_cache {
       my ($uname,$udom)=@_;
       if (!$udom)  { $udom =$env{'user.domain'}; }
       if (!$uname) { $uname=$env{'user.name'};   }
       return if ($udom eq 'public' && $uname eq 'public');
       my $id=$uname.':'.$udom;
       &Apache::lonnet::devalidate_cache_new('userlangs',$id);
   }
   
 # ------------------------------------------------------------------ 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 2021  sub screenname { Line 3004  sub screenname {
 }  }
   
   
   # ------------------------------------------------------------- Confirm Wrapper
   =pod
   
   =item confirmwrapper
   
   Wrap messages about completion of operation in box
   
   =cut
   
   sub confirmwrapper {
       my ($message)=@_;
       if ($message) {
           return "\n".'<div class="LC_confirm_box">'."\n"
                  .$message."\n"
                  .'</div>'."\n";
       } else {
           return $message;
       }
   }
   
 # ------------------------------------------------------------- Message Wrapper  # ------------------------------------------------------------- Message Wrapper
   
 sub messagewrapper {  sub messagewrapper {
     my ($link,$username,$domain)=@_;      my ($link,$username,$domain,$subject,$text)=@_;
     return       return 
         '<a href="/adm/email?compose=individual&'.          '<a href="/adm/email?compose=individual&amp;'.
         'recname='.$username.'&recdom='.$domain.'" '.          'recname='.$username.'&amp;recdom='.$domain.
    '&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
         'title="'.&mt('Send message').'">'.$link.'</a>';          'title="'.&mt('Send message').'">'.$link.'</a>';
 }  }
   
 # --------------------------------------------------------------- Notes Wrapper  # --------------------------------------------------------------- Notes Wrapper
   
 sub noteswrapper {  sub noteswrapper {
     my ($link,$un,$do)=@_;      my ($link,$un,$do)=@_;
     return       return 
 "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";  "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
 }  }
   
 # ------------------------------------------------------------- Aboutme Wrapper  # ------------------------------------------------------------- Aboutme Wrapper
   
 sub aboutmewrapper {  sub aboutmewrapper {
     my ($link,$username,$domain,$target)=@_;      my ($link,$username,$domain,$target)=@_;
     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.      if (!defined($username)  && !defined($domain)) {
  ($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';          return;
       }
       return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
    ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
 }  }
   
 # ------------------------------------------------------------ Syllabus Wrapper  # ------------------------------------------------------------ Syllabus Wrapper
   
   
 sub syllabuswrapper {  sub syllabuswrapper {
     my ($linktext,$coursedir,$domain,$fontcolor)=@_;      my ($linktext,$coursedir,$domain)=@_;
     if ($fontcolor) {   
         $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';   
     }  
     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};      return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
 }  }
   
   # -----------------------------------------------------------------------------
   
 sub track_student_link {  sub track_student_link {
     my ($linktext,$sname,$sdom,$target,$start) = @_;      my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
     my $link ="/adm/trackstudent?";      my $link ="/adm/trackstudent?";
     my $title = 'View recent activity';      my $title = 'View recent activity';
     if (defined($sname) && $sname !~ /^\s*$/ &&      if (defined($sname) && $sname !~ /^\s*$/ &&
Line 2071  sub track_student_link { Line 3078  sub track_student_link {
         $target = '';          $target = '';
     }      }
     if ($start) { $link.='&amp;start='.$start; }      if ($start) { $link.='&amp;start='.$start; }
       if ($only_body) { $link .= '&amp;only_body=1'; }
       $title = &mt($title);
       $linktext = &mt($linktext);
       return qq{<a href="$link" title="$title" $target>$linktext</a>}.
    &help_open_topic('View_recent_activity');
   }
   
   sub slot_reservations_link {
       my ($linktext,$sname,$sdom,$target) = @_;
       my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
       my $title = 'View slot reservation history';
       if (defined($sname) && $sname !~ /^\s*$/ &&
           defined($sdom)  && $sdom  !~ /^\s*$/) {
           $link .= "&amp;uname=$sname&amp;udom=$sdom";
           $title .= ' of this student';
       }
       if (defined($target) && $target !~ /^\s*$/) {
           $target = qq{target="$target"};
       } else {
           $target = '';
       }
       $title = &mt($title);
       $linktext = &mt($linktext);
     return qq{<a href="$link" title="$title" $target>$linktext</a>};      return qq{<a href="$link" title="$title" $target>$linktext</a>};
   # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
   
   }
   
   # ===================================================== 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  =pod
Line 2082  sub track_student_link { Line 3127  sub track_student_link {
   
 =over 4  =over 4
   
 =item * languageids()   =item * &languageids() 
   
 returns list of all language ids  returns list of all language ids
   
Line 2094  sub languageids { Line 3139  sub languageids {
   
 =pod  =pod
   
 =item * languagedescription()   =item * &languagedescription() 
   
 returns description of a specified language id  returns description of a specified language id
   
Line 2119  sub supportedlanguagecode { Line 3164  sub supportedlanguagecode {
   
 =pod  =pod
   
 =item * copyrightids()   =item * &copyrightids() 
   
 returns list of all copyrights  returns list of all copyrights
   
Line 2131  sub copyrightids { Line 3176  sub copyrightids {
   
 =pod  =pod
   
 =item * copyrightdescription()   =item * &copyrightdescription() 
   
 returns description of a specified copyright id  returns description of a specified copyright id
   
Line 2143  sub copyrightdescription { Line 3188  sub copyrightdescription {
   
 =pod  =pod
   
 =item * source_copyrightids()   =item * &source_copyrightids() 
   
 returns list of all source copyrights  returns list of all source copyrights
   
Line 2155  sub source_copyrightids { Line 3200  sub source_copyrightids {
   
 =pod  =pod
   
 =item * source_copyrightdescription()   =item * &source_copyrightdescription() 
   
 returns description of a specified source copyright id  returns description of a specified source copyright id
   
Line 2167  sub source_copyrightdescription { Line 3212  sub source_copyrightdescription {
   
 =pod  =pod
   
 =item * filecategories()   =item * &filecategories() 
   
 returns list of all file categories  returns list of all file categories
   
Line 2179  sub filecategories { Line 3224  sub filecategories {
   
 =pod  =pod
   
 =item * filecategorytypes()   =item * &filecategorytypes() 
   
 returns list of file types belonging to a given file  returns list of file types belonging to a given file
 category  category
Line 2193  sub filecategorytypes { Line 3238  sub filecategorytypes {
   
 =pod  =pod
   
 =item * fileembstyle()   =item * &fileembstyle() 
   
 returns embedding style for a specified file type  returns embedding style for a specified file type
   
Line 2212  sub filecategoryselect { Line 3257  sub filecategoryselect {
     my ($name,$value)=@_;      my ($name,$value)=@_;
     return &select_form($value,$name,      return &select_form($value,$name,
  '' => &mt('Any category'),   '' => &mt('Any category'),
  map { $_,$_ } sort(keys(%category_extensions)));   {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
 }  }
   
 =pod  =pod
   
 =item * filedescription()   =item * &filedescription() 
   
 returns description for a specified file type  returns description for a specified file type
   
Line 2231  sub filedescription { Line 3276  sub filedescription {
   
 =pod  =pod
   
 =item * filedescriptionex()   =item * &filedescriptionex() 
   
 returns description for a specified file type with  returns description for a specified file type with
 extra formatting  extra formatting
Line 2263  sub fileextensions { Line 3308  sub fileextensions {
   
 sub display_languages {  sub display_languages {
     my %languages=();      my %languages=();
     foreach my $lang (&preferred_languages()) {      foreach my $lang (&Apache::lonlocal::preferred_languages()) {
  $languages{$lang}=1;   $languages{$lang}=1;
     }      }
     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);      &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
Line 2275  sub display_languages { Line 3320  sub display_languages {
     return %languages;      return %languages;
 }  }
   
 sub preferred_languages {  sub languages {
     my @languages=();      my ($possible_langs) = @_;
     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {      my @preferred_langs = &Apache::lonlocal::preferred_languages();
  @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,      if (!ref($possible_langs)) {
          $env{'course.'.$env{'request.course.id'}.'.languages'}));   if( wantarray ) {
     }      return @preferred_langs;
     if ($env{'environment.languages'}) {   } else {
  @languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});      return $preferred_langs[0];
     }   }
     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];      }
     if ($browser) {      my %possibilities = map { $_ => 1 } (@$possible_langs);
  @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));      my @preferred_possibilities;
     }      foreach my $preferred_lang (@preferred_langs) {
     if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {   if (exists($possibilities{$preferred_lang})) {
  @languages=(@languages,      push(@preferred_possibilities, $preferred_lang);
  $Apache::lonnet::domain_lang_def{$env{'user.domain'}});  
     }  
     if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {  
  @languages=(@languages,  
  $Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});  
     }  
     if ($Apache::lonnet::domain_lang_def{  
                           $Apache::lonnet::perlvar{'lonDefDomain'}}) {  
  @languages=(@languages,  
  $Apache::lonnet::domain_lang_def{  
                                   $Apache::lonnet::perlvar{'lonDefDomain'}});  
     }  
 # turn "en-ca" into "en-ca,en"  
     my @genlanguages;  
     foreach my $lang (@languages) {  
  unless ($lang=~/\w/) { next; }  
  push (@genlanguages,$lang);  
  if ($lang=~/(\-|\_)/) {  
     push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);  
  }   }
     }      }
     return @genlanguages;      if( wantarray ) {
    return @preferred_possibilities;
       }
       return $preferred_possibilities[0];
 }  }
   
   sub user_lang {
       my ($touname,$toudom,$fromcid) = @_;
       my @userlangs;
       if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
           @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                       $env{'course.'.$fromcid.'.languages'}));
       } else {
           my %langhash = &getlangs($touname,$toudom);
           if ($langhash{'languages'} ne '') {
               @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
           } else {
               my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
               if ($domdefs{'lang_def'} ne '') {
                   @userlangs = ($domdefs{'lang_def'});
               }
           }
       }
       my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
       my $user_lh = Apache::localize->get_handle(@languages);
       return $user_lh;
   }
   
   
 ###############################################################  ###############################################################
 ##               Student Answer Attempts                     ##  ##               Student Answer Attempts                     ##
 ###############################################################  ###############################################################
Line 2324  sub preferred_languages { Line 3376  sub preferred_languages {
   
 =over 4  =over 4
   
 =item * get_previous_attempt($symb, $username, $domain, $course,  =item * &get_previous_attempt($symb, $username, $domain, $course,
     $getattempt, $regexp, $gradesub)      $getattempt, $regexp, $gradesub)
   
 Return string with previous attempt on problem. Arguments:  Return string with previous attempt on problem. Arguments:
Line 2368  sub get_previous_attempt { Line 3420  sub get_previous_attempt {
   $lasthash{$key}=$returnhash{$version.':'.$key};    $lasthash{$key}=$returnhash{$version.':'.$key};
         }          }
       }        }
       $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';        $prevattempts=&start_data_table().&start_data_table_header_row();
       $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';        $prevattempts.='<th>'.&mt('History').'</th>';
         my (%typeparts,%lasthidden);
         my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
       foreach my $key (sort(keys(%lasthash))) {        foreach my $key (sort(keys(%lasthash))) {
  my ($ign,@parts) = split(/\./,$key);   my ($ign,@parts) = split(/\./,$key);
  if ($#parts > 0) {   if ($#parts > 0) {
   my $data=$parts[-1];    my $data=$parts[-1];
   pop(@parts);    pop(@parts);
   $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.'&nbsp;</td>';            if ($data eq 'type') {
                 unless ($showsurv) {
                     my $id = join(',',@parts);
                     $typeparts{$ign.'.'.$id} = $lasthash{$key};
                     if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                         $lasthidden{$ign.'.'.$id} = 1;
                     }
                 }
                 delete($lasthash{$key});
             } else {
         $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
             }
  } else {   } else {
   if ($#parts == 0) {    if ($#parts == 0) {
     $prevattempts.='<th>'.$parts[0].'</th>';      $prevattempts.='<th>'.$parts[0].'</th>';
Line 2384  sub get_previous_attempt { Line 3449  sub get_previous_attempt {
   }    }
  }   }
       }        }
         $prevattempts.=&end_data_table_header_row();
       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>';              my @hidden;
     foreach my $key (sort(keys(%lasthash))) {              if (%typeparts) {
        my $value;                  foreach my $id (keys(%typeparts)) {
        if ($key =~ /timestamp/) {                      if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
   $value=scalar(localtime($returnhash{$version.':'.$key}));                          push(@hidden,$id);
        } else {                      }
   $value=$returnhash{$version.':'.$key};                  }
        }              }
        $prevattempts.='<td>'.&Apache::lonnet::unescape($value).'&nbsp;</td>';                 $prevattempts.=&start_data_table_row().
     }                             '<td>'.&mt('Transaction [_1]',$version).'</td>';
               if (@hidden) {
                   foreach my $key (sort(keys(%lasthash))) {
                       my $hide;
                       foreach my $id (@hidden) {
                           if ($key =~ /^\Q$id\E/) {
                               $hide = 1;
                               last;
                           }
                       }
                       if ($hide) {
                           my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                           if (($data eq 'award') || ($data eq 'awarddetail')) {
                               my $value = &format_previous_attempt_value($key,
                                                $returnhash{$version.':'.$key});
                               $prevattempts.='<td>'.$value.'&nbsp;</td>';
                           } else {
                               $prevattempts.='<td>&nbsp;</td>';
                           }
                       } else {
                           if ($key =~ /\./) {
                               my $value = &format_previous_attempt_value($key,
                                                 $returnhash{$version.':'.$key});
                               $prevattempts.='<td>'.$value.'&nbsp;</td>';
                           } else {
                               $prevattempts.='<td>&nbsp;</td>';
                           }
                       }
                   }
               } else {
           foreach my $key (sort(keys(%lasthash))) {
       my $value = &format_previous_attempt_value($key,
               $returnhash{$version.':'.$key});
       $prevattempts.='<td>'.$value.'&nbsp;</td>';
           }
               }
       $prevattempts.=&end_data_table_row();
  }   }
       }        }
       $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';        my @currhidden = keys(%lasthidden);
         $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
       foreach my $key (sort(keys(%lasthash))) {        foreach my $key (sort(keys(%lasthash))) {
  my $value;            if (%typeparts) {
  if ($key =~ /timestamp/) {                my $hidden;
   $value=scalar(localtime($lasthash{$key}));                foreach my $id (@currhidden) {
  } else {                    if ($key =~ /^\Q$id\E/) {
   $value=$lasthash{$key};                        $hidden = 1;
  }                        last;
  $value=&Apache::lonnet::unescape($value);                    }
  if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}                }
  $prevattempts.='<td>'.$value.'&nbsp;</td>';                if ($hidden) {
                     my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                     if (($data eq 'award') || ($data eq 'awarddetail')) {
                         my $value = &format_previous_attempt_value($key,$lasthash{$key});
                         if ($key =~/$regexp$/ && (defined &$gradesub)) {
                             $value = &$gradesub($value);
                         }
                         $prevattempts.='<td>'.$value.'&nbsp;</td>';
                     } else {
                         $prevattempts.='<td>&nbsp;</td>';
                     }
                 } else {
                     my $value = &format_previous_attempt_value($key,$lasthash{$key});
                     if ($key =~/$regexp$/ && (defined &$gradesub)) {
                         $value = &$gradesub($value);
                     }
                     $prevattempts.='<td>'.$value.'&nbsp;</td>';
                 }
             } else {
         my $value = &format_previous_attempt_value($key,$lasthash{$key});
         if ($key =~/$regexp$/ && (defined &$gradesub)) {
                     $value = &$gradesub($value);
                 }
         $prevattempts.='<td>'.$value.'&nbsp;</td>';
             }
       }        }
       $prevattempts.='</tr></table></td></tr></table>';        $prevattempts.= &end_data_table_row().&end_data_table();
     } else {      } else {
       $prevattempts='Nothing submitted - no attempts.';        $prevattempts=
     &start_data_table().&start_data_table_row().
     '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
     &end_data_table_row().&end_data_table();
     }      }
   } else {    } else {
     $prevattempts='No data.';      $prevattempts=
     &start_data_table().&start_data_table_row().
     '<td>'.&mt('No data.').'</td>'.
     &end_data_table_row().&end_data_table();
   }    }
 }  }
   
   sub format_previous_attempt_value {
       my ($key,$value) = @_;
       if ($key =~ /timestamp/) {
    $value = &Apache::lonlocal::locallocaltime($value);
       } elsif (ref($value) eq 'ARRAY') {
    $value = '('.join(', ', @{ $value }).')';
       } else {
    $value = &unescape($value);
       }
       return $value;
   }
   
   
 sub relative_to_absolute {  sub relative_to_absolute {
     my ($url,$output)=@_;      my ($url,$output)=@_;
     my $parser=HTML::TokeParser->new(\$output);      my $parser=HTML::TokeParser->new(\$output);
Line 2440  sub relative_to_absolute { Line 3586  sub relative_to_absolute {
     }      }
     $thisdir=~s-/[^/]*$--;      $thisdir=~s-/[^/]*$--;
     foreach my $link (@rlinks) {      foreach my $link (@rlinks) {
  unless (($link=~/^http:\/\//i) ||   unless (($link=~/^https?\:\/\//i) ||
  ($link=~/^\//) ||   ($link=~/^\//) ||
  ($link=~/^javascript:/i) ||   ($link=~/^javascript:/i) ||
  ($link=~/^mailto:/i) ||   ($link=~/^mailto:/i) ||
Line 2456  sub relative_to_absolute { Line 3602  sub relative_to_absolute {
   
 =pod  =pod
   
 =item * get_student_view  =item * &get_student_view()
   
 show a snapshot of what student was looking at  show a snapshot of what student was looking at
   
Line 2475  sub get_student_view { Line 3621  sub get_student_view {
   }    }
   if (defined($target)) { $form{'grade_target'} = $target; }    if (defined($target)) { $form{'grade_target'} = $target; }
   $feedurl=&Apache::lonnet::clutter($feedurl);    $feedurl=&Apache::lonnet::clutter($feedurl);
   my $userview=&Apache::lonnet::ssi_body($feedurl,%form);    my ($userview,$response)=&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 2484  sub get_student_view { Line 3630  sub get_student_view {
   $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);    $userview=&relative_to_absolute($feedurl,$userview);
   return $userview;    if (wantarray) {
        return ($userview,$response);
     } else {
        return $userview;
     }
   }
   
   sub get_student_view_with_retries {
     my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
   
       my $ok = 0;                 # True if we got a good response.
       my $content;
       my $response;
   
       # Try to get the student_view done. within the retries count:
       
       do {
            ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
            $ok      = $response->is_success;
            if (!$ok) {
               &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
            }
            $retries--;
       } while (!$ok && ($retries > 0));
       
       if (!$ok) {
          $content = '';          # On error return an empty content.
       }
       if (wantarray) {
          return ($content, $response);
       } else {
          return $content;
       }
 }  }
   
 =pod  =pod
   
 =item * get_student_answers()   =item * &get_student_answers() 
   
 show a snapshot of how student was answering problem  show a snapshot of how student was answering problem
   
Line 2505  sub get_student_answers { Line 3683  sub get_student_answers {
   }    }
   $moreenv{'grade_target'}='answer';    $moreenv{'grade_target'}='answer';
   %moreenv=(%form,%moreenv);    %moreenv=(%form,%moreenv);
   my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);    $feedurl = &Apache::lonnet::clutter($feedurl);
     my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
   return $userview;    return $userview;
 }  }
   
Line 2524  sub submlink { Line 3703  sub submlink {
     my ($text,$uname,$udom,$symb,$target)=@_;      my ($text,$uname,$udom,$symb,$target)=@_;
     if (!($uname && $udom)) {      if (!($uname && $udom)) {
  (my $cursymb, my $courseid,$udom,$uname)=   (my $cursymb, my $courseid,$udom,$uname)=
     &Apache::lonxml::whichuser($symb);      &Apache::lonnet::whichuser($symb);
  if (!$symb) { $symb=$cursymb; }   if (!$symb) { $symb=$cursymb; }
     }      }
     if (!$symb) { $symb=&Apache::lonnet::symbread(); }      if (!$symb) { $symb=&Apache::lonnet::symbread(); }
     $symb=&Apache::lonnet::escape($symb);      $symb=&escape($symb);
     if ($target) { $target="target=\"$target\""; }      if ($target) { $target=" target=\"$target\""; }
     return '<a href="/adm/grades?&command=submission&'.      return
  'symb='.$symb.'&student='.$uname.          '<a href="/adm/grades?command=submission'.
  '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';          '&amp;symb='.$symb.
           '&amp;student='.$uname.
           '&amp;userdom='.$udom.'"'.
           $target.'>'.$text.'</a>';
 }  }
 ##############################################  ##############################################
   
Line 2570  sub pprmlink { Line 3752  sub pprmlink {
     my ($text,$uname,$udom,$symb,$target)=@_;      my ($text,$uname,$udom,$symb,$target)=@_;
     if (!($uname && $udom)) {      if (!($uname && $udom)) {
  (my $cursymb, my $courseid,$udom,$uname)=   (my $cursymb, my $courseid,$udom,$uname)=
     &Apache::lonxml::whichuser($symb);      &Apache::lonnet::whichuser($symb);
  if (!$symb) { $symb=$cursymb; }   if (!$symb) { $symb=$cursymb; }
     }      }
     if (!$symb) { $symb=&Apache::lonnet::symbread(); }      if (!$symb) { $symb=&Apache::lonnet::symbread(); }
     $symb=&Apache::lonnet::escape($symb);      $symb=&escape($symb);
     if ($target) { $target="target=\"$target\""; }      if ($target) { $target="target=\"$target\""; }
     return '<a href="/adm/parmset?&command=set&'.      return '<a href="/adm/parmset?command=set&amp;'.
  'symb='.$symb.'&uname='.$uname.   'symb='.$symb.'&amp;uname='.$uname.
  '&udom='.$udom.'" '.$target.'>'.$text.'</a>';   '&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
 }  }
 ##############################################  ##############################################
   
Line 2592  sub pprmlink { Line 3774  sub pprmlink {
   
   
 sub timehash {  sub timehash {
     my @ltime=localtime(shift);      my ($thistime) = @_;
     return ( 'seconds' => $ltime[0],      my $timezone = &Apache::lonlocal::gettimezone();
              'minutes' => $ltime[1],      my $dt = DateTime->from_epoch(epoch => $thistime)
              'hours'   => $ltime[2],                       ->set_time_zone($timezone);
              'day'     => $ltime[3],      my $wday = $dt->day_of_week();
              'month'   => $ltime[4]+1,      if ($wday == 7) { $wday = 0; }
              'year'    => $ltime[5]+1900,      return ( 'second' => $dt->second(),
              'weekday' => $ltime[6],               'minute' => $dt->minute(),
              'dayyear' => $ltime[7]+1,               'hour'   => $dt->hour(),
              'dlsav'   => $ltime[8] );               'day'     => $dt->day_of_month(),
                'month'   => $dt->month(),
                'year'    => $dt->year(),
                'weekday' => $wday,
                'dayyear' => $dt->day_of_year(),
                'dlsav'   => $dt->is_dst() );
   }
   
   sub utc_string {
       my ($date)=@_;
       return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
 }  }
   
 sub maketime {  sub maketime {
     my %th=@_;      my %th=@_;
       my ($epoch_time,$timezone,$dt);
       $timezone = &Apache::lonlocal::gettimezone();
       eval {
           $dt = DateTime->new( year   => $th{'year'},
                                month  => $th{'month'},
                                day    => $th{'day'},
                                hour   => $th{'hour'},
                                minute => $th{'minute'},
                                second => $th{'second'},
                                time_zone => $timezone,
                            );
       };
       if (!$@) {
           $epoch_time = $dt->epoch;
           if ($epoch_time) {
               return $epoch_time;
           }
       }
     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,-1));           $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
Line 2614  sub maketime { Line 3824  sub maketime {
 #########################################  #########################################
   
 sub findallcourses {  sub findallcourses {
     my ($roles) = @_;      my ($roles,$uname,$udom) = @_;
     my %roles;      my %roles;
     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }      if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
     my %courses;      my %courses;
     my $now=time;      my $now=time;
     foreach my $key (keys(%env)) {      if (!defined($uname)) {
  if ( $key=~m{^user\.role\.(\w+)\./(\w+)/(\w+)} ) {          $uname = $env{'user.name'};
     my ($role,$domain,$id) = ($1,$2,$3);      }
     next if ($role eq 'ca' || $role eq 'aa');      if (!defined($udom)) {
     next if (%roles && !exists($roles{$role}));          $udom = $env{'user.domain'};
     my ($starttime,$endtime)=split(/\./,$env{$key});      }
             my $active=1;      if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
             if ($starttime) {          my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
  if ($now<$starttime) { $active=0; }          my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
                                                 $extra);
           if (!%roles) {
               %roles = (
                          cc => 1,
                          co => 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 ($endtime) {              if ($tend) {
                 if ($now>$endtime) { $active=0; }                  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 blockcheck {
       my ($setters,$activity,$uname,$udom) = @_;
   
       if (!defined($udom)) {
           $udom = $env{'user.domain'};
       }
       if (!defined($uname)) {
           $uname = $env{'user.name'};
       }
   
       # 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});
               }
           }
       }
   
       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 locker 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{$domain.'_'.$id}=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 blocking_status {
     my ($activity,$uname,$udom) = @_;
     my %setters;
   
     # check for active blocking
     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
   
     my $blocked = $startblock && $endblock ? 1 : 0;
   
     # caller just wants to know whether a block is active
     if (!wantarray) { return $blocked; }
   
     # build a link to a popup window containing the details
     my $querystring  = "?activity=$activity";
     # $uname and $udom decide whose portfolio the user is trying to look at
        $querystring .= "&amp;udom=$udom"      if $udom;
        $querystring .= "&amp;uname=$uname"    if $uname;
   
     my $output .= <<'END_MYBLOCK';
       function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
           var options = "width=" + w + ",height=" + h + ",";
           options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
           options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
           var newWin = window.open(url, wdwName, options);
           newWin.focus();
       }
   END_MYBLOCK
   
     $output = Apache::lonhtmlcommon::scripttag($output);
     
     my $popupUrl = "/adm/blockingstatus/$querystring";
     my $text = mt('Communication Blocked');
   
     $output .= <<"END_BLOCK";
   <div class='LC_comblock'>
     <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
     title='$text'>
     <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
     <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
     title='$text'>$text</a>
   </div>
   
   END_BLOCK
   
     return ($blocked, $output);
 }  }
   
 ###############################################  ###############################################
   
   sub check_ip_acc {
       my ($acc)=@_;
       &Apache::lonxml::debug("acc is $acc");
       if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
           return 1;
       }
       my $allowed=0;
       my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
   
       my $name;
       foreach my $pattern (split(',',$acc)) {
           $pattern =~ s/^\s*//;
           $pattern =~ s/\s*$//;
           if ($pattern =~ /\*$/) {
               #35.8.*
               $pattern=~s/\*//;
               if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
           } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
               #35.8.3.[34-56]
               my $low=$2;
               my $high=$3;
               $pattern=$1;
               if ($ip =~ /^\Q$pattern\E/) {
                   my $last=(split(/\./,$ip))[3];
                   if ($last <=$high && $last >=$low) { $allowed=1; }
               }
           } elsif ($pattern =~ /^\*/) {
               #*.msu.edu
               $pattern=~s/\*//;
               if (!defined($name)) {
                   use Socket;
                   my $netaddr=inet_aton($ip);
                   ($name)=gethostbyaddr($netaddr,AF_INET);
               }
               if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
           } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
               #127.0.0.1
               if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
           } else {
               #some.name.com
               if (!defined($name)) {
                   use Socket;
                   my $netaddr=inet_aton($ip);
                   ($name)=gethostbyaddr($netaddr,AF_INET);
               }
               if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
           }
           if ($allowed) { last; }
       }
       return $allowed;
   }
   
 ###############################################  ###############################################
   
 =pod  =pod
Line 2658  Returns: Determines which domain should Line 4218  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::default_login_domain();
         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'}; 
Line 2669  sub determinedomain { Line 4229  sub determinedomain {
     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','autoenroll'],$udom);
       my (%designhash,%legacy);
       if (keys(%domconfig) > 0) {
           if (ref($domconfig{'login'}) eq 'HASH') {
               if (keys(%{$domconfig{'login'}})) {
                   foreach my $key (keys(%{$domconfig{'login'}})) {
                       if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                           if ($key eq 'loginvia') {
                               if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
                                   my @ids = &Apache::lonnet::current_machine_ids();
                                   foreach my $hostname (@ids) {
                                       if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                                           if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                                               my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                                               $designhash{$udom.'.login.loginvia'} = $server;
                                               if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
   
                                                   $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                                               } else {
                                                    $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                                               }
                                               if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                                                   $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                                               }
                                           }
                                       }
                                   }
                               }
                           } else {
                               foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                                   $designhash{$udom.'.login.'.$key.'_'.$img} = 
                                       $domconfig{'login'}{$key}{$img};
                               }
                           }
                       } else {
                           $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                       }
                   }
               } else {
                   $legacy{'login'} = 1;
               }
           } else {
               $legacy{'login'} = 1;
           }
           if (ref($domconfig{'rolecolors'}) eq 'HASH') {
               if (keys(%{$domconfig{'rolecolors'}})) {
                   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 {
                   $legacy{'rolecolors'} = 1;
               }
           } else {
               $legacy{'rolecolors'} = 1;
           }
           if (ref($domconfig{'autoenroll'}) eq 'HASH') {
               if ($domconfig{'autoenroll'}{'co-owners'}) {
                   $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
               }
           }
           if (keys(%legacy) > 0) {
               my %legacyhash = &get_legacy_domconf($udom);
               foreach my $item (keys(%legacyhash)) {
                   if ($item =~ /^\Q$udom\E\.login/) {
                       if ($legacy{'login'}) { 
                           $designhash{$item} = $legacyhash{$item};
                       }
                   } else {
                       if ($legacy{'rolecolors'}) {
                           $designhash{$item} = $legacyhash{$item};
                       }
                   }
               }
           }
       } else {
           %designhash = &get_legacy_domconf($udom); 
       }
       &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
     $cachetime);
       return %designhash;
   }
   
   sub get_legacy_domconf {
       my ($udom) = @_;
       my %legacyhash;
       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) { $legacyhash{$udom.'.'.$key}=$val; }
               }
               close($fh);
           }
       }
       if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
           $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
       }
       return %legacyhash;
   }
   
 =pod  =pod
   
 =item * &domainlogo()  =item * &domainlogo()
Line 2682  If the domain logo does not exist, a des Line 4364  If the domain logo does not exist, a des
   
 ###############################################  ###############################################
 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 $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");      if ($designhash{$domain.'.login.domlogo'} ne '') {
         return '<img src="'.$logo.'" alt="'.$domain.'" />';          my $imgsrc = $designhash{$domain.'.login.domlogo'};
     } elsif(exists($Apache::lonnet::domaindescription{$domain})) {          if ($imgsrc =~ m{^/(adm|res)/}) {
         return $Apache::lonnet::domaindescription{$domain};      if ($imgsrc =~ m{^/res/}) {
    my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
    &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 2705  Returns: value of designparamter $which Line 4395  Returns: value of designparamter $which
   
 =cut  =cut
   
   
 ##############################################  ##############################################
 sub designparm {  sub designparm {
     my ($which,$domain)=@_;      my ($which,$domain)=@_;
     if ($env{'browser.blackwhite'} eq 'on') {      if (exists($env{'environment.color.'.$which})) {
  if ($which=~/\.(font|alink|vlink|link)$/) {          return $env{'environment.color.'.$which};
     return '#000000';  
  }  
  if ($which=~/\.(pgbg|sidebg)$/) {  
     return '#FFFFFF';  
  }  
  if ($which=~/\.tabbg$/) {  
     return '#CCCCCC';  
  }  
     }  
     if ($env{'environment.color.'.$which}) {  
  return $env{'environment.color.'.$which};  
     }      }
     $domain=&determinedomain($domain);      $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 {
           $output = $defaultdesign{$which};
       }
       if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
           ($which =~ /login\.(img|logo|domlogo|login)/)) {
           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;
   }
   
   ##############################################
   =pod
   
   =item * &authorspace()
   
   Inputs: ./.
   
   Returns: Path to the Construction Space of the current user's
            accessed author space
            The author space will be that of the current user
            when accessing the own author space
            and that of the co-author/assistent co-author
            when accessing the co-author's/assistent co-author's
            space
   
   =cut
   
   sub authorspace {
       my $caname = '';
       if ($env{'request.role'} =~ /^ca|^aa/) {
           (undef,$caname) =
               ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
       } else {
           $caname = $env{'user.name'};
       }
       return '/priv/'.$caname.'/';
   }
   
   ##############################################
   =pod
   
   =item * &head_subbox()
   
   Inputs: $content (contains HTML code with page functions, etc.)
   
   Returns: HTML div with $content
            To be included in page header
   
   =cut
   
   sub head_subbox {
       my ($content)=@_;
       my $output =
           '<div id="LC_head_subbox">'
          .$content
          .'</div>'
   }
   
   ##############################################
   =pod
   
   =item * &CSTR_pageheader()
   
   Inputs: ./.
   
   Returns: HTML div with CSTR path and recent box
            To be included on Construction Space pages
   
   =cut
   
   sub CSTR_pageheader {
       # 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 {      } else {
         return $designhash{'default.'.$which};          $lastitem = $thisdisfn;
     }      }
   
       my $output =
            '<div>'
           .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
           .'<b>'.&mt('Construction Space:').'</b> '
           .'<form name="dirs" method="post" action="'.$formaction
           .'" target="_top">' #FIXME lonpubdir: target="_parent"
           .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
   
       if ($lastitem) {
           $output .=
                '<span class="LC_filename">'
               .$lastitem
               .'</span>';
       }
       $output .=
            '<br />'
           #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
           .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
           .'</form>'
           .&Apache::lonmenu::constspaceform()
           .'</div>';
   
       return $output;
 }  }
   
 ###############################################  ###############################################
Line 2737  sub designparm { Line 4532  sub designparm {
   
 =back  =back
   
 =head1 HTTP Helpers  =head1 HTML Helpers
   
 =over 4  =over 4
   
Line 2762  Inputs: Line 4557  Inputs:
 =item * $forcereg, if page should register as content page (relevant for   =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  =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                       in the title box that appears, this text                       navigational links
                       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 * $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
               inherit_jsmath -> when creating popup window in a page,
                                 should it have jsmath forced on by the
                                 current page
   
 =back  =back
   
Line 2784  other decorations will be returned. Line 4581  other decorations will be returned.
 =cut  =cut
   
 sub bodytag {  sub bodytag {
     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,      my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
  $notopbar,$bgcolor,$notitle)=@_;          $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
   
     $title=&mt($title);      my $public;
       if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
           || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
           $public = 1;
       }
       if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
   
     $function = &get_users_function() if (!$function);      $function = &get_users_function() if (!$function);
     my $img =    &designparm($function.'.img',$domain);      my $img =    &designparm($function.'.img',$domain);
     my $tabbg =  &designparm($function.'.tabbg',$domain);  
     my $font =   &designparm($function.'.font',$domain);      my $font =   &designparm($function.'.font',$domain);
     my $sidebg = &designparm($function.'.sidebg',$domain);  
     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);      my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
   
     my %design = ( 'style'   => 'margin-top: 0px',      my %design = ( 'style'   => 'margin-top: 0',
    'bgcolor' => $pgbg,     'bgcolor' => $pgbg,
    'text'    => $font,     'text'    => $font,
                    'alink'   => &designparm($function.'.alink',$domain),                     'alink'   => &designparm($function.'.alink',$domain),
    'vlink'   => &designparm($function.'.vlink',$domain),     'vlink'   => &designparm($function.'.vlink',$domain),
    'link'    => &designparm($function.'.link',$domain),);     'link'    => &designparm($function.'.link',$domain),);
     @$addentries{keys(%design)} = @design{keys(%design)};      @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
   
  # 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());
           }
           if ($env{'request.course.sec'}) {
               $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
           }   
    $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);
 # Port for miniserver  
     my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};  
     if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }  
   
     my $extra_body_attr = &make_attr_string($forcereg,$addentries);      my $extra_body_attr = &make_attr_string($forcereg,\%design);
   
 # construct main body tag  # construct main body tag
     my $bodytag = <<END;      my $bodytag = "<body $extra_body_attr>".
 <body $extra_body_attr>   &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
 END  
   
     $bodytag .= &Apache::lontexconvert::init_math_support();  
   
     my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.      if ($bodyonly) {
                    $lonhttpdPort.$img.'" alt="'.$function.'" />';  
     if ($bodyonly   
  || ($env{'request.state'} eq 'construct'   
     && $env{'environment.remote'} ne 'off' )) {  
         return $bodytag;          return $bodytag;
     } elsif ($env{'browser.interface'} eq 'textual') {      } 
 # Accessibility  
             
  $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);  
  if (!$notitle) {  
     $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';  
  }  
  return $bodytag;  
     } elsif ($env{'environment.remote'} eq 'off') {  
 # No Remote  
  my $roleinfo=(<<ENDROLE);  
 <td bgcolor="$tabbg" align="right">  
 <font size="2" face="Arial, Helvetica, sans-serif">  
     $env{'environment.firstname'}  
     $env{'environment.middlename'}  
     $env{'environment.lastname'}  
     $env{'environment.generation'}  
     </font>&nbsp;  
 <br />  
 <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;  
 <br />  
 <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;  
 </td>  
 ENDROLE  
         my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.  
  $font.'"><b>'.$title.'</b></font>';  
         if ($customtitle) {  
             $titleinfo = $customtitle;  
         }  
   
  if ($env{'request.state'} eq 'construct') {  
     my ($uname,$thisdisfn)=  
  ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);  
     my $formaction='/priv/'.$uname.'/'.$thisdisfn;  
     $formaction=~s/\/+/\//g;  
             unless ($customtitle) {  #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm    
                 my $parentpath = '';  
                 my $lastitem = '';  
                 if ($thisdisfn =~ m-(.+/)([^/]*)$-) {  
                     $parentpath = $1;  
                     $lastitem = $2;  
                 } else {  
                     $lastitem = $thisdisfn;  
                 }  
         $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').  
                       '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font>&nbsp;'.   
                       '<form name="dirs" method="post" action="'.$formaction  
     .'" target="_top"><tt><b>'  
     .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"  
     .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')  
     .'</form>'  
     .&Apache::lonmenu::constspaceform();  
   
             }  
     $forcereg=1;  
         }  
         my $titletable;  
  if (!$notitle) {  
     $titletable =  
  '<table bgcolor="'.$pgbg.'" width="100%" border="0" '.  
                          'cellspacing="3" cellpadding="3">'.  
                          '<tr><td bgcolor="'.$tabbg.'">'.  
                          $titleinfo.'</td>'.$roleinfo.'</tr></table>';  
  }  
  if ($env{'request.state'} eq 'construct') {  
             if ($notopbar) {  
                 $bodytag .= $titletable;  
             } else {  
                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,  
   $titletable);  
             }  
  } else {  
             if ($notopbar) {  
                 $bodytag .= $titletable;  
             } else {  
                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).  
                         $titletable;  
             }  
         }  
         return $bodytag;  
     }  
   
 #      my $name = &plainname($env{'user.name'},$env{'user.domain'});
 # Top frame rendering, Remote is up      if ($public) {
 #   undef($role);
     my $titleinfo = '&nbsp;<font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';      } else {
     if ($customtitle) {   $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
         $titleinfo = $customtitle;  
     }      }
   
       my $titleinfo = '<h1>'.$title.'</h1>';
     #      #
     # Extra info if you are the DC      # Extra info if you are the DC
     my $dc_info = '';      my $dc_info = '';
Line 2930  ENDROLE Line 4652  ENDROLE
                         $env{'course.'.$env{'request.course.id'}.                          $env{'course.'.$env{'request.course.id'}.
                                  '.domain'}.'/'})) {                                   '.domain'}.'/'})) {
         my $cid = $env{'request.course.id'};          my $cid = $env{'request.course.id'};
         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};          $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
         $dc_info = '('.$dc_info.')';          $dc_info =~ s/\s+$//;
       }
   
       $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
       &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
   
       if ($env{'environment.remote'} eq 'off') {
           # No Remote
           if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
               return $bodytag; 
           } 
   
           if ($env{'request.state'} eq 'construct') { $forcereg=1; }
   
           #    if ($env{'request.state'} eq 'construct') {
           #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
           #    }
   
   
   
           if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                if ($dc_info) {
                    $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                }
                $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   <em>$realm</em> $dc_info</div>|;
               return $bodytag;
           }
   
           unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
               $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
           }
   
           $bodytag .= Apache::lonhtmlcommon::scripttag(
               Apache::lonmenu::utilityfunctions(), 'start');
   
           $bodytag .= Apache::lonmenu::primary_menu();
   
           if ($dc_info) {
               $dc_info = &dc_courseid_toggle($dc_info);
           }
           $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
   
           #don't show menus for public users
           if (!$public){
               $bodytag .= Apache::lonmenu::secondary_menu();
               $bodytag .= Apache::lonmenu::serverform();
               $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
               if ($env{'request.state'} eq 'construct') {
                   $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
                                   $args->{'bread_crumbs'});
               } elsif ($forcereg) { 
                   $bodytag .= &Apache::lonmenu::innerregister($forcereg);
               }
           }else{
               # this is to seperate menu from content when there's no secondary
               # menu. Especially needed for public accessible ressources.
               $bodytag .= '<hr style="clear:both" />';
               $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
           }
   
           return $bodytag;
     }      }
   
   #
   # Top frame rendering, Remote is up
   #
   
       my $imgsrc = $img;
       if ($img =~ /^\/adm/) {
           $imgsrc = &lonhttpdurl($img);
       }
       my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
   
     # Explicit link to get inline menu      # Explicit link to get inline menu
     my $menu='<br /><font size="2" face="Arial, Helvetica, sans-serif">&nbsp;<a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a></font>';      my $menu= ($no_inline_link?''
     #         :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
     if ($notitle) {  
  return $bodytag;      if ($dc_info) {
           $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
     }      }
   
       $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
               <ol class="LC_primary_menu LC_right">
                   <li>$menu</li>
               </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
     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>$upperleft</td>
 $upperleft</td>      <td>$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">  
 $titleinfo $dc_info $menu  
 </td><td bgcolor="$tabbg" align="right">  
 <font size="2" face="Arial, Helvetica, sans-serif">  
     $env{'environment.firstname'}  
     $env{'environment.middlename'}  
     $env{'environment.lastname'}  
     $env{'environment.generation'}  
     </font>&nbsp;  
 </td>  
 </tr>  </tr>
 <tr><td bgcolor="$tabbg" align="right">  
 <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;  
 </td></tr>  
 <tr>  
 <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;</td></tr>  
 </table>  </table>
 ENDBODY  ENDBODY
 }  }
   
   sub dc_courseid_toggle {
       my ($dc_info) = @_;
       return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
              '<a href="javascript:showCourseID();">'.
              &mt('(More ...)').'</a></span>'.
              '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
   }
   
 sub make_attr_string {  sub make_attr_string {
     my ($register,$attr_ref) = @_;      my ($register,$attr_ref) = @_;
   
Line 3006  sub make_attr_string { Line 4798  sub make_attr_string {
  $attr_ref->{'style'}=$style.'; font-size: x-large;';   $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;      my $attr_string;
     foreach my $attr (keys(%$attr_ref)) {      foreach my $attr (keys(%$attr_ref)) {
  $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';   $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
Line 3028  sub make_attr_string { Line 4811  sub make_attr_string {
   
 =pod  =pod
   
 =back  
   
 =head1 HTML Helpers  
   
 =over 4  
   
 =item * &endbodytag()  =item * &endbodytag()
   
 Returns a uniform footer for LON-CAPA web pages.  Returns a uniform footer for LON-CAPA web pages.
   
 Inputs: none  Inputs: 1 - optional reference to an args hash
   If in the hash, key for noredirectlink has a value which evaluates to true,
 =back  a 'Continue' link is not displayed if the page contains an
   internal redirect in the <head></head> section,
   i.e., $env{'internal.head.redirect'} exists   
   
 =cut  =cut
   
 sub endbodytag {  sub endbodytag {
       my ($args) = @_;
     my $endbodytag='</body>';      my $endbodytag='</body>';
     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;      $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
     if ( exists( $env{'internal.head.redirect'} ) ) {      if ( exists( $env{'internal.head.redirect'} ) ) {
  $endbodytag=          if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
     "<br /><a href=\"$env{'internal.head.redirect'}\">".      $endbodytag=
     &mt('Continue').'</a>'.          "<br /><a href=\"$env{'internal.head.redirect'}\">".
     $endbodytag;          &mt('Continue').'</a>'.
           $endbodytag;
           }
     }      }
     return $endbodytag;      return $endbodytag;
 }  }
   
 =pod  =pod
   
 =over 4  
   
 =item * &standard_css()  =item * &standard_css()
   
 Returns a style sheet  Returns a style sheet
Line 3070  Inputs: (all optional) Line 4850  Inputs: (all optional)
             function       -> force usage of a specific rolish color scheme              function       -> force usage of a specific rolish color scheme
             bgcolor        -> override the default page bgcolor              bgcolor        -> override the default page bgcolor
   
 =back  
   
 =cut  =cut
   
 sub standard_css {  sub standard_css {
Line 3080  sub standard_css { Line 4858  sub standard_css {
     my $img    = &designparm($function.'.img',   $domain);      my $img    = &designparm($function.'.img',   $domain);
     my $tabbg  = &designparm($function.'.tabbg', $domain);      my $tabbg  = &designparm($function.'.tabbg', $domain);
     my $font   = &designparm($function.'.font',  $domain);      my $font   = &designparm($function.'.font',  $domain);
       my $fontmenu = &designparm($function.'.fontmenu', $domain);
   #second colour for later usage
     my $sidebg = &designparm($function.'.sidebg',$domain);      my $sidebg = &designparm($function.'.sidebg',$domain);
     my $pgbg   = $bgcolor ||      my $pgbg_or_bgcolor =
            $bgcolor ||
          &designparm($function.'.pgbg',  $domain);           &designparm($function.'.pgbg',  $domain);
       my $pgbg   = &designparm($function.'.pgbg',  $domain);
     my $alink  = &designparm($function.'.alink', $domain);      my $alink  = &designparm($function.'.alink', $domain);
     my $vlink  = &designparm($function.'.vlink', $domain);      my $vlink  = &designparm($function.'.vlink', $domain);
     my $link   = &designparm($function.'.link',  $domain);      my $link   = &designparm($function.'.link',  $domain);
   
     my $sans                 = 'Arial,Helvetica,sans-serif';      my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
     my $data_table_head      = $tabbg;      my $mono                 = 'monospace';
     my $data_table_light     = '#EEEEEE';      my $data_table_head      = $sidebg;
     my $data_table_dark      = '#DDD';      my $data_table_light     = '#FAFAFA';
       my $data_table_dark      = '#F0F0F0';
       my $data_table_darker    = '#CCCCCC';
     my $data_table_highlight = '#FFFF00';      my $data_table_highlight = '#FFFF00';
     my $mail_new             = '#FFBB77';      my $mail_new             = '#FFBB77';
     my $mail_new_hover       = '#DD9955';      my $mail_new_hover       = '#DD9955';
Line 3100  sub standard_css { Line 4884  sub standard_css {
     my $mail_replied_hover   = '#888855';      my $mail_replied_hover   = '#888855';
     my $mail_other           = '#99BBBB';      my $mail_other           = '#99BBBB';
     my $mail_other_hover     = '#669999';      my $mail_other_hover     = '#669999';
       my $table_header         = '#DDDDDD';
       my $feedback_link_bg     = '#BBBBBB';
       my $lg_border_color      = '#C8C8C8';
       my $button_hover         = '#BF2317';
   
       my $border = ($env{'browser.type'} eq 'explorer' ||
         $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                                                : '0 3px 0 4px';
   
     return <<END;      return <<END;
 <style type="text/css">  
 h1, h2, h3, th { font-family: $sans }  /* needed for iframe to allow 100% height in FF */
 a:focus { color: red; background: yellow }   body, html { 
 table.thinborder { border-collapse: collapse; }      margin: 0;
 table.thinborder tr th, table.thinborder tr td { border-style: solid; border-width: 1px}      padding: 0 0.5%;
 form, .inline { display: inline; }      height: 99%; /* to avoid scrollbars */
 .center { text-align: center; }  }
 .filename {font-family: monospace;}  
   body {
     font-family: $sans;
     line-height:130%;
     font-size:0.83em;
     color:$font;
   }
   
   a:focus,
   a:focus img {
     color: red;
     background: yellow;
   }
   
   form, .inline {
     display: inline;
   }
   
   .LC_right {
     text-align:right;
   }
   
   .LC_middle {
     vertical-align:middle;
   }
   
   .LC_400Box {
     width:400px;
   }
   
   .LC_iframecontainer {
       width: 98%;
       margin: 0;
       position: fixed;
       top: 8.5em;
       bottom: 0;
   }
   
   .LC_iframecontainer iframe{
       border: none;
       width: 100%;
       height: 100%;
   }
   
   .LC_filename {
     font-family: $mono;
     white-space:pre;
     font-size: 120%;
   }
   
   .LC_fileicon {
     border: none;
     height: 1.3em;
     vertical-align: text-bottom;
     margin-right: 0.3em;
     text-decoration:none;
   }
   
 .LC_error {  .LC_error {
   color: red;    color: red;
   font-size: larger;    font-size: larger;
 }  }
 .LC_success {  
   .LC_warning,
   .LC_diff_removed {
     color: red;
   }
   
   .LC_info,
   .LC_success,
   .LC_diff_added {
   color: green;    color: green;
 }  }
   
 table#LC_top_nav, table#LC_menubuttons, table#LC_nav_location, table#LC_breadcrumbs {  div.LC_confirm_box {
     background-color: #FAFAFA;
     border: 1px solid $lg_border_color;
     margin-right: 0;
     padding: 5px;
   }
   
   div.LC_confirm_box .LC_error img,
   div.LC_confirm_box .LC_success img {
     vertical-align: middle;
   }
   
   .LC_icon {
     border: none;
     vertical-align: middle;
   }
   
   .LC_docs_spacer {
     width: 25px;
     height: 1px;
     border: none;
   }
   
   .LC_internal_info {
     color: #999999;
   }
   
   .LC_discussion {
     background: $tabbg;
     border: 1px solid black;
     margin: 2px;
   }
   
   .LC_disc_action_links_bar {
     background: $tabbg;
     border: none;
     margin: 4px;
   }
   
   .LC_disc_action_left {
     text-align: left;
   }
   
   .LC_disc_action_right {
     text-align: right;
   }
   
   .LC_disc_new_item {
     background: white;
     border: 2px solid red;
     margin: 2px;
   }
   
   .LC_disc_old_item {
     background: white;
     border: 1px solid black;
     margin: 2px;
   }
   
   table.LC_pastsubmission {
     border: 1px solid black;
     margin: 2px;
   }
   
   table#LC_menubuttons {
   width: 100%;    width: 100%;
   background: $pgbg;    background: $pgbg;
   border: 0px;    border: 2px;
   border-spacing: 1px;  
   padding: 0px;  
   margin: 0px;  
   border-collapse: separate;    border-collapse: separate;
     padding: 0;
 }  }
 table#LC_menubuttons_mainmenu {  
   table#LC_title_bar a {
     color: $fontmenu;
   }
   
   table#LC_title_bar {
     clear: both;
     display: none;
   }
   
   table#LC_title_bar,
   table.LC_breadcrumbs, /* obsolete? */
   table#LC_title_bar.LC_with_remote {
     width: 100%;
     border-color: $pgbg;
     border-style: solid;
     border-width: $border;
   background: $pgbg;    background: $pgbg;
   border: 0px;    color: $fontmenu;
   border-spacing: 1px;    border-collapse: collapse;
   padding: 0px;    padding: 0;
   margin: 0px;    margin: 0;
   border-collapse: separate;  
 }  }
 table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {  
   border: 0px;  ul.LC_breadcrumb_tools_outerlist {
       margin: 0;
       padding: 0;
       position: relative;
       list-style: none;
 }  }
 table#LC_top_nav td {  ul.LC_breadcrumb_tools_outerlist li {
   background: $tabbg;      display: inline;
 }  }
 table#LC_top_nav td a, div#LC_top_nav a {  
   color: $font;  .LC_breadcrumb_tools_navigation {
   font-family: $sans;      padding: 0;
       margin: 0;
       float: left;
 }  }
 table#LC_breadcrumbs td {  .LC_breadcrumb_tools_tools {
   background: $tabbg;      padding: 0;
   color: $font;      margin: 0;
   font-family: $sans;      float: right;
   font-size: smaller;  
 }  }
 table#LC_breadcrumbs td.LC_breadcrumb_component {  
   table#LC_title_bar td {
   background: $tabbg;    background: $tabbg;
   color: $font;  
   font-family: $sans;  
   font-size: larger;  
   text-align: right;  
 }  }
   
   table#LC_menubuttons img {
     border: none;
   }
   
   .LC_breadcrumbs_component {
     float: right;
     margin: 0 1em;
   }
   .LC_breadcrumbs_component img {
     vertical-align: middle;
   }
   
   td.LC_table_cell_checkbox {
     text-align: center;
   }
   
   .LC_fontsize_small {
     font-size: 70%;
   }
   
   #LC_breadcrumbs {
     clear:both;
     background: $sidebg;
     border-bottom: 1px solid $lg_border_color;
     line-height: 2.5em;
     overflow: hidden;
     margin: 0;
     padding: 0;
   }
   
   /* Preliminary fix to hide breadcrumbs inside remote control window */
   #LC_remote #LC_breadcrumbs {
     display:none;
   }
   
   #LC_head_subbox {
     clear:both;
     background: #F8F8F8; /* $sidebg; */
     border: 1px solid $sidebg;
     margin: 0 0 10px 0;      
     padding: 3px;
   }
   
   .LC_fontsize_medium {
     font-size: 85%;
   }
   
   .LC_fontsize_large {
     font-size: 120%;
   }
   
 .LC_menubuttons_inline_text {  .LC_menubuttons_inline_text {
   color: $font;    color: $font;
   font-family: $sans;    font-size: 90%;
   font-size: smaller;    padding-left:3px;
 }  }
   
 td.LC_menubuttons_text {  .LC_menubuttons_inline_text img{
     vertical-align: middle;
   }
   
   li.LC_menubuttons_inline_text img,a {
     cursor:pointer;
   }
   
   .LC_menubuttons_link {
     text-decoration: none;
   }
   
   .LC_menubuttons_category {
   color: $font;    color: $font;
   font-family: $sans;    background: $pgbg;
     font-size: larger;
     font-weight: bold;
 }  }
 td.LC_menubuttons_img {  
   background: $tabbg;  td.LC_menubuttons_text {
     color: $font;
 }  }
   
 .LC_current_location {  .LC_current_location {
   font-family: $sans;  
   background: $tabbg;    background: $tabbg;
 }  }
 .LC_new_mail {  
   font-family: $sans;  table.LC_data_table {
   font-weight: bold;    border: 1px solid #000000;
     border-collapse: separate;
     border-spacing: 1px;
     background: $pgbg;
 }  }
   
 table.LC_data_table, table.LC_mail_list {  .LC_data_table_dense {
     font-size: small;
   }
   
   table.LC_nested_outer {
   border: 1px solid #000000;    border: 1px solid #000000;
   border-collapse: seperate;    border-collapse: collapse;
     border-spacing: 0;
     width: 100%;
 }  }
 table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th {  
   table.LC_innerpickbox,
   table.LC_nested {
     border: none;
     border-collapse: collapse;
     border-spacing: 0;
     width: 100%;
   }
   
   .ui-accordion,
   .ui-accordion table.LC_data_table,
   .ui-accordion table.LC_nested_outer{
     border: 0px;
     border-spacing: 0px;
     margin: 3px;
   }
   
   table.LC_data_table tr th,
   table.LC_calendar tr th,
   table.LC_prior_tries tr th,
   table.LC_innerpickbox tr th {
   font-weight: bold;    font-weight: bold;
   background-color: $data_table_head;    background-color: $data_table_head;
     color:$fontmenu;
     font-size:90%;
 }  }
 table.LC_data_table tr td {  
   table.LC_innerpickbox tr th,
   table.LC_innerpickbox tr td {
     vertical-align: top;
   }
   
   table.LC_data_table tr.LC_info_row > td {
     background-color: #CCCCCC;
     font-weight: bold;
     text-align: left;
   }
   
   table.LC_data_table tr.LC_odd_row > td {
   background-color: $data_table_light;    background-color: $data_table_light;
     padding: 2px;
     vertical-align: top;
   }
   
   table.LC_pick_box tr > td.LC_odd_row {
     background-color: $data_table_light;
     vertical-align: top;
 }  }
 table.LC_data_table tr.LC_even_row td {  
   table.LC_data_table tr.LC_even_row > td {
     background-color: $data_table_dark;
     padding: 2px;
     vertical-align: top;
   }
   
   table.LC_pick_box tr > td.LC_even_row {
   background-color: $data_table_dark;    background-color: $data_table_dark;
     vertical-align: top;
   }
   
   table.LC_data_table tr.LC_data_table_highlight td {
     background-color: $data_table_darker;
   }
   
   table.LC_data_table tr td.LC_leftcol_header {
     background-color: $data_table_head;
     font-weight: bold;
   }
   
   table.LC_data_table tr.LC_empty_row td,
   table.LC_nested tr.LC_empty_row td {
     font-weight: bold;
     font-style: italic;
     text-align: center;
     padding: 8px;
   }
   
   table.LC_data_table tr.LC_empty_row td {
     background-color: $sidebg;
 }  }
 table.LC_data_table tr.LC_empty td {  
   table.LC_nested tr.LC_empty_row td {
   background-color: #FFFFFF;    background-color: #FFFFFF;
 }  }
   
   table.LC_caption {
   }
   
   table.LC_nested tr.LC_empty_row td {
     padding: 4ex
   }
   
   table.LC_nested_outer tr th {
     font-weight: bold;
     color:$fontmenu;
     background-color: $data_table_head;
     font-size: small;
     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: #CCCCCC;
     font-weight: bold;
     font-size: small;
     text-align: center;
   }
   
   table.LC_nested tr.LC_info_row td.LC_left_item,
   table.LC_nested_outer tr th.LC_left_item {
     text-align: left;
   }
   
   table.LC_nested td {
     background-color: #FFFFFF;
     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;
   }
   
   .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
   .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
     text-align: right;
     width: 40%;
     padding-right:10px;
     vertical-align: top;
     padding: 5px;
   }
   
   .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
   .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
     text-align: left;
     width: 60%;
     padding: 2px 4px;
   }
   
   table.LC_nested tr.LC_odd_row td {
     background-color: #EEEEEE;
   }
   
   table.LC_createuser {
   }
   
   table.LC_createuser tr.LC_section_row td {
     font-size: small;
   }
   
   table.LC_createuser tr.LC_info_row td  {
     background-color: #CCCCCC;
     font-weight: bold;
     text-align: center;
   }
   
 table.LC_calendar {  table.LC_calendar {
   border: 1px solid #000000;    border: 1px solid #000000;
   border-collapse: collapse;    border-collapse: collapse;
     width: 98%;
 }  }
   
 table.LC_calendar_pickdate {  table.LC_calendar_pickdate {
   font-size: xx-small;    font-size: xx-small;
 }  }
   
 table.LC_calendar tr td {  table.LC_calendar tr td {
   border: 1px solid #000000;    border: 1px solid #000000;
   vertical-align: top;    vertical-align: top;
     width: 14%;
 }  }
   
 table.LC_calendar tr td.LC_calendar_day_empty {  table.LC_calendar tr td.LC_calendar_day_empty {
   background-color: $data_table_dark;    background-color: $data_table_dark;
 }  }
   
 table.LC_calendar tr td.LC_calendar_day_current {  table.LC_calendar tr td.LC_calendar_day_current {
   background-color: $data_table_highlight;    background-color: $data_table_highlight;
 }  }
   
 table.LC_mail_list tr.LC_mail_new {  table.LC_data_table tr td.LC_mail_new {
   background-color: $mail_new;    background-color: $mail_new;
 }  }
 table.LC_mail_list tr.LC_mail_new:hover {  
   table.LC_data_table tr.LC_mail_new:hover {
   background-color: $mail_new_hover;    background-color: $mail_new_hover;
 }  }
 table.LC_mail_list tr.LC_mail_read {  
   table.LC_data_table tr td.LC_mail_read {
   background-color: $mail_read;    background-color: $mail_read;
 }  }
 table.LC_mail_list tr.LC_mail_read:hover {  
   /*
   table.LC_data_table tr.LC_mail_read:hover {
   background-color: $mail_read_hover;    background-color: $mail_read_hover;
 }  }
 table.LC_mail_list tr.LC_mail_replied {  */
   
   table.LC_data_table tr td.LC_mail_replied {
   background-color: $mail_replied;    background-color: $mail_replied;
 }  }
 table.LC_mail_list tr.LC_mail_replied:hover {  
   /*
   table.LC_data_table tr.LC_mail_replied:hover {
   background-color: $mail_replied_hover;    background-color: $mail_replied_hover;
 }  }
 table.LC_mail_list tr.LC_mail_other {  */
   
   table.LC_data_table tr td.LC_mail_other {
   background-color: $mail_other;    background-color: $mail_other;
 }  }
 table.LC_mail_list tr.LC_mail_other:hover {  
   /*
   table.LC_data_table tr.LC_mail_other:hover {
   background-color: $mail_other_hover;    background-color: $mail_other_hover;
 }  }
 </style>  */
   
   table.LC_data_table tr > td.LC_browser_file,
   table.LC_data_table tr > td.LC_browser_file_published {
     background: #AAEE77;
   }
   
   table.LC_data_table tr > td.LC_browser_file_locked,
   table.LC_data_table tr > td.LC_browser_file_unpublished {
     background: #FFAA99;
   }
   
   table.LC_data_table tr > td.LC_browser_file_obsolete {
     background: #888888;
   }
   
   table.LC_data_table tr > td.LC_browser_file_modified,
   table.LC_data_table tr > td.LC_browser_file_metamodified {
     background: #F8F866;
   }
   
   table.LC_data_table tr.LC_browser_folder > td {
     background: #E0E8FF;
   }
   
   table.LC_data_table tr > td.LC_roles_is {
     /* background: #77FF77; */
   }
   
   table.LC_data_table tr > td.LC_roles_future {
     border-right: 8px solid #FFFF77;
   }
   
   table.LC_data_table tr > td.LC_roles_will {
     border-right: 8px solid #FFAA77;
   }
   
   table.LC_data_table tr > td.LC_roles_expired {
     border-right: 8px solid #FF7777;
   }
   
   table.LC_data_table tr > td.LC_roles_will_not {
     border-right: 8px solid #AAFF77;
   }
   
   table.LC_data_table tr > td.LC_roles_selected {
     border-right: 8px solid #11CC55;
   }
   
   span.LC_current_location {
     font-size:larger;
     background: $pgbg;
   }
   
   span.LC_parm_menu_item {
     font-size: larger;
   }
   
   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;
   }
   
   ul.LC_parm_parmlist li {
     display: inline-block;
     padding: 0.3em 0.8em;
     vertical-align: top;
     width: 150px;
     border-top:1px solid $lg_border_color;
   }
   
   td.LC_parm_overview_level_menu,
   td.LC_parm_overview_map_menu,
   td.LC_parm_overview_parm_selectors,
   td.LC_parm_overview_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: none;
     height: 55px;
     border-spacing: 0;
   }
   
   table#LC_helpmenu fieldset legend {
     font-size: larger;
   }
   
   table#LC_helpmenu_links {
     width: 100%;
     border: 1px solid black;
     background: $pgbg;
     padding: 0;
     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 {
     border-collapse: separate;
     background: white;
     border: 1px solid black;
     border-spacing: 1px;
   }
   
   table.LC_pick_box td.LC_pick_box_title {
     background: $sidebg;
     font-weight: bold;
     text-align: left;
     vertical-align: top;
     width: 184px;
     padding: 8px;
   }
   
   table.LC_pick_box td.LC_pick_box_value {
     text-align: left;
     padding: 8px;
   }
   
   table.LC_pick_box td.LC_pick_box_select {
     text-align: left;
     padding: 8px;
   }
   
   table.LC_pick_box td.LC_pick_box_separator {
     padding: 0;
     height: 1px;
     background: black;
   }
   
   table.LC_pick_box td.LC_pick_box_submit {
     text-align: right;
   }
   
   table.LC_pick_box td.LC_evenrow_value {
     text-align: left;
     padding: 8px;
     background-color: $data_table_light;
   }
   
   table.LC_pick_box td.LC_oddrow_value {
     text-align: left;
     padding: 8px;
     background-color: $data_table_light;
   }
   
   span.LC_helpform_receipt_cat {
     font-weight: bold;
   }
   
   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: 0;
   }
   
   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-weight: bold;
     background: $tabbg;
     margin: 1em 0em 1em 2em;
     padding: 3px;
     font-size: 1.2em;
   }
   
   .LC_topic_bar span {
     left: 0.5em;
     position: absolute;
     vertical-align: middle;
     font-size: 1.2em;
   }
   
   table.LC_course_group_status {
     margin: 20px;
   }
   
   table.LC_status_selector td {
     vertical-align: top;
     text-align: center;
     padding: 4px;
   }
   
   div.LC_feedback_link {
     clear: both;
     background: $sidebg;
     width: 100%;
     padding-bottom: 10px;
     border: 1px $tabbg solid;
     height: 22px;
     line-height: 22px;
     padding-top: 5px;
   }
   
   div.LC_feedback_link img {
     height: 22px;
     vertical-align:middle;
   }
   
   div.LC_feedback_link a {
     text-decoration: none;
   }
   
   div.LC_comblock {
     display:inline;
     color:$font;
     font-size:90%;
   }
   
   div.LC_feedback_link div.LC_comblock {
     padding-left:5px;
   }
   
   div.LC_feedback_link div.LC_comblock a {
     color:$font;
   }
   
   span.LC_feedback_link {
     /* background: $feedback_link_bg; */
     font-size: larger;
   }
   
   span.LC_message_link {
     /* background: $feedback_link_bg; */
     font-size: larger;
     position: absolute;
     right: 1em;
   }
   
   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: lightgreen;
     color: darkgreen;
     padding: 6px;
   }
   
   .LC_answer_charged_try {
     background: #FFAAAA;
     color: darkred;
     padding: 6px;
   }
   
   .LC_answer_not_charged_try,
   .LC_answer_no_grade,
   .LC_answer_late {
     background: lightyellow;
     color: black;
     padding: 6px;
   }
   
   .LC_answer_previous {
     background: lightblue;
     color: darkblue;
     padding: 6px;
   }
   
   .LC_answer_no_message {
     background: #FFFFFF;
     color: black;
     padding: 6px;
   }
   
   .LC_answer_unknown {
     background: orange;
     color: black;
     padding: 6px;
   }
   
   span.LC_prior_numerical,
   span.LC_prior_string,
   span.LC_prior_custom,
   span.LC_prior_reaction,
   span.LC_prior_math {
     font-family: $mono;
     white-space: pre;
   }
   
   span.LC_prior_string {
     font-family: $mono;
     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;
   }
   
   .LC_nobreak {
     white-space: nowrap;
   }
   
   span.LC_cusr_emph {
     font-style: italic;
   }
   
   span.LC_cusr_subheading {
     font-weight: normal;
     font-size: 85%;
   }
   
   div.LC_docs_entry_move {
     border: 1px solid #BBBBBB;
     background: #DDDDDD;
     width: 22px;
     padding: 1px;
     margin: 0;
   }
   
   table.LC_data_table tr > td.LC_docs_entry_commands,
   table.LC_data_table tr > td.LC_docs_entry_parameter {
     background: #DDDDDD;
     font-size: x-small;
   }
   
   .LC_docs_entry_parameter {
     white-space: nowrap;
   }
   
   .LC_docs_copy {
     color: #000099;
   }
   
   .LC_docs_cut {
     color: #550044;
   }
   
   .LC_docs_rename {
     color: #009900;
   }
   
   .LC_docs_remove {
     color: #990000;
   }
   
   .LC_docs_reinit_warn,
   .LC_docs_ext_edit {
     font-size: x-small;
   }
   
   table.LC_docs_adddocs td,
   table.LC_docs_adddocs th {
     border: 1px solid #BBBBBB;
     padding: 4px;
     background: #DDDDDD;
   }
   
   table.LC_sty_begin {
     background: #BBFFBB;
   }
   
   table.LC_sty_end {
     background: #FFBBBB;
   }
   
   table.LC_double_column {
     border-width: 0;
     border-collapse: collapse;
     width: 100%;
     padding: 2px;
   }
   
   table.LC_double_column tr td.LC_left_col {
     top: 2px;
     left: 2px;
     width: 47%;
     vertical-align: top;
   }
   
   table.LC_double_column tr td.LC_right_col {
     top: 2px;
     right: 2px;
     width: 47%;
     vertical-align: top;
   }
   
   div.LC_left_float {
     float: left;
     padding-right: 5%;
     padding-bottom: 4px;
   }
   
   div.LC_clear_float_header {
     padding-bottom: 2px;
   }
   
   div.LC_clear_float_footer {
     padding-top: 10px;
     clear: both;
   }
   
   div.LC_grade_show_user {
   /*  border-left: 5px solid $sidebg; */
     border-top: 5px solid #000000;
     margin: 50px 0 0 0;
     padding: 15px 0 5px 10px;
   }
   
   div.LC_grade_show_user_odd_row {
   /*  border-left: 5px solid #000000; */
   }
   
   div.LC_grade_show_user div.LC_Box {
     margin-right: 50px;
   }
   
   div.LC_grade_submissions,
   div.LC_grade_message_center,
   div.LC_grade_info_links {
     margin: 5px;
     width: 99%;
     background: #FFFFFF;
   }
   
   div.LC_grade_submissions_header,
   div.LC_grade_message_center_header {
     font-weight: bold;
     font-size: large;
   }
   
   div.LC_grade_submissions_body,
   div.LC_grade_message_center_body {
     border: 1px solid black;
     width: 99%;
     background: #FFFFFF;
   }
   
   table.LC_scantron_action {
     width: 100%;
   }
   
   table.LC_scantron_action tr th {
     font-weight:bold;
     font-style:normal;
   }
   
   .LC_edit_problem_header,
   div.LC_edit_problem_footer {
     font-weight: normal;
     font-size:  medium;
     margin: 2px;
   }
   
   div.LC_edit_problem_header,
   div.LC_edit_problem_header div,
   div.LC_edit_problem_footer,
   div.LC_edit_problem_footer div,
   div.LC_edit_problem_editxml_header,
   div.LC_edit_problem_editxml_header div {
     margin-top: 5px;
   }
   
   div.LC_edit_problem_header_title {
     font-weight: bold;
     font-size: larger;
     background: $tabbg;
     padding: 3px;
   }
   
   table.LC_edit_problem_header_title {
     width: 100%;
     background: $tabbg;
   }
   
   div.LC_edit_problem_discards {
     float: left;
     padding-bottom: 5px;
   }
   
   div.LC_edit_problem_saves {
     float: right;
     padding-bottom: 5px;
   }
   
   img.stift {
     border-width: 0;
     vertical-align: middle;
   }
   
   table td.LC_mainmenu_col_fieldset {
     vertical-align: top;
   }
   
   div.LC_createcourse {
     margin: 10px 10px 10px 10px;
   }
   
   .LC_dccid {
     margin: 0.2em 0 0 0;
     padding: 0;
     font-size: 90%;
     display:none;
   }
   
   a:hover,
   ol.LC_primary_menu a:hover,
   ol#LC_MenuBreadcrumbs a:hover,
   ol#LC_PathBreadcrumbs a:hover,
   ul#LC_secondary_menu a:hover,
   .LC_FormSectionClearButton input:hover
   ul.LC_TabContent   li:hover a {
     color:$button_hover;
     text-decoration:none;
   }
   
   h1 {
     padding: 0;
     line-height:130%;
   }
   
   h2,
   h3,
   h4,
   h5,
   h6 {
     margin: 5px 0 5px 0;
     padding: 0;
     line-height:130%;
   }
   
   .LC_hcell {
     padding:3px 15px 3px 15px;
     margin: 0;
     background-color:$tabbg;
     color:$fontmenu;
     border-bottom:solid 1px $lg_border_color;
   }
   
   .LC_Box > .LC_hcell {
     margin: 0 -10px 10px -10px;
   }
   
   .LC_noBorder {
     border: 0;
   }
   
   .LC_FormSectionClearButton input {
     background-color:transparent;
     border: none;
     cursor:pointer;
     text-decoration:underline;
   }
   
   .LC_help_open_topic {
     color: #FFFFFF;
     background-color: #EEEEFF;
     margin: 1px;
     padding: 4px;
     border: 1px solid #000033;
     white-space: nowrap;
     /* vertical-align: middle; */
   }
   
   dl,
   ul,
   div,
   fieldset {
     margin: 10px 10px 10px 0;
     /* overflow: hidden; */
   }
   
   fieldset > legend {
     font-weight: bold;
     padding: 0 5px 0 5px;
   }
   
   #LC_nav_bar {
     float: left;
     margin: 0 0 2px 0;
   }
   
   #LC_realm {
     margin: 0.2em 0 0 0;
     padding: 0;
     font-weight: bold;
     text-align: center;
   }
   
   #LC_nav_bar em {
     font-weight: bold;
     font-style: normal;
   }
   
   /* Preliminary fix to hide nav_bar inside bookmarks window */
   #LC_bookmarks #LC_nav_bar {
     display:none;
   }
   
   ol.LC_primary_menu {
     float: right;
     margin: 0;
   }
   
   span.LC_new_message{
     font-weight:bold;
     color: darkred;
   }
   
   ol#LC_PathBreadcrumbs {
     margin: 0;
   }
   
   ol.LC_primary_menu li {
     display: inline;
     padding: 5px 5px 0 10px;
     vertical-align: top;
   }
   
   ol.LC_primary_menu li img {
     vertical-align: bottom;
     height: 1.1em;
   }
   
   ol.LC_primary_menu a {
     color: RGB(80, 80, 80);
     text-decoration: none;
   }
   
   ol.LC_docs_parameters {
     margin-left: 0;
     padding: 0;
     list-style: none;
   }
   
   ol.LC_docs_parameters li {
     margin: 0;
     padding-right: 20px;
     display: inline;
   }
   
   ol.LC_docs_parameters li:before {
     content: "\\002022 \\0020";
   }
   
   li.LC_docs_parameters_title {
     font-weight: bold;
   }
   
   ol.LC_docs_parameters li.LC_docs_parameters_title:before {
     content: "";
   }
   
   ul#LC_secondary_menu {
     clear: both;
     color: $fontmenu;
     background: $tabbg;
     list-style: none;
     padding: 0;
     margin: 0;
     width: 100%;
   }
   
   ul#LC_secondary_menu li {
     font-weight: bold;
     line-height: 1.8em;
     padding: 0 0.8em;
     border-right: 1px solid black;
     display: inline;
     vertical-align: middle;
   }
   
   ul.LC_TabContent {
     display:block;
     background: $sidebg;
     border-bottom: solid 1px $lg_border_color;
     list-style:none;
     margin: 0 -10px;
     padding: 0;
   }
   
   ul.LC_TabContent li,
   ul.LC_TabContentBigger li {
     float:left;
   }
   
   ul#LC_secondary_menu li a {
     color: $fontmenu;
     text-decoration: none;
   }
   
   ul.LC_TabContent {
     min-height:20px;
   }
   
   ul.LC_TabContent li {
     vertical-align:middle;
     padding: 0 16px 0 10px;
     background-color:$tabbg;
     border-bottom:solid 1px $lg_border_color;
     border-right: solid 1px $font;
   }
   
   ul.LC_TabContent .right {
     float:right;
   }
   
   ul.LC_TabContent li a,
   ul.LC_TabContent li {
     color:rgb(47,47,47);
     text-decoration:none;
     font-size:95%;
     font-weight:bold;
     min-height:20px;
   }
   
   ul.LC_TabContent li a:hover,
   ul.LC_TabContent li a:focus {
     color: $button_hover;
     background:none;
     outline:none;
   }
   
   ul.LC_TabContent li:hover {
     color: $button_hover;
     cursor:pointer;
   }
   
   ul.LC_TabContent li.active {
     color: $font;
     background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
     border-bottom:solid 1px #FFFFFF;
     cursor: default;
   }
   
   ul.LC_TabContent li.active a {
     color:$font;
     background:#FFFFFF;
     outline: none;
   }
   #maincoursedoc {
     clear:both;
   }
   
   ul.LC_TabContentBigger {
     display:block;
     list-style:none;
     padding: 0;
   }
   
   ul.LC_TabContentBigger li {
     vertical-align:bottom;
     height: 30px;
     font-size:110%;
     font-weight:bold;
     color: #737373;
   }
   
   ul.LC_TabContentBigger li.active {
     position: relative;
     top: 1px;
   }
   
   ul.LC_TabContentBigger li a {
     background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
     height: 30px;
     line-height: 30px;
     text-align: center;
     display: block;
     text-decoration: none;
     outline: none;
   }
   
   ul.LC_TabContentBigger li.active a {
     background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
     color:$font;
   }
   
   ul.LC_TabContentBigger li b {
     background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
     display: block;
     float: left;
     padding: 0 30px;
     border-bottom: 1px solid $lg_border_color;
   }
   
   ul.LC_TabContentBigger li:hover b {
     color:$button_hover;
   }
   
   ul.LC_TabContentBigger li.active b {
     background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
     color:$font;
     border: 0;
     cursor:default;
   }
   
   ul.LC_CourseBreadcrumbs {
     background: $sidebg;
     line-height: 32px;
     padding-left: 10px;
     margin: 0 0 10px 0;
     list-style-position: inside;
   
   }
   
   ol#LC_MenuBreadcrumbs,
   ol#LC_PathBreadcrumbs {
     padding-left: 10px;
     margin: 0;
     height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
   }
   
   ol#LC_MenuBreadcrumbs li,
   ol#LC_PathBreadcrumbs li,
   ul.LC_CourseBreadcrumbs li {
     display: inline;
     white-space: normal;  
   }
   
   ol#LC_MenuBreadcrumbs li a,
   ul.LC_CourseBreadcrumbs li a {
     text-decoration: none;
     font-size:90%;
   }
   
   ol#LC_MenuBreadcrumbs h1 {
     display: inline;
     font-size: 90%;
     line-height: 2.5em;
     margin: 0;
     padding: 0;
   }
   
   ol#LC_PathBreadcrumbs li a {
     text-decoration:none;
     font-size:100%;
     font-weight:bold;
   }
   
   .LC_Box {
     border: solid 1px $lg_border_color;
     padding: 0 10px 10px 10px;
   }
   
   .LC_AboutMe_Image {
     float:left;
     margin-right:10px;
   }
   
   .LC_Clear_AboutMe_Image {
     clear:left;
   }
   
   dl.LC_ListStyleClean dt {
     padding-right: 5px;
     display: table-header-group;
   }
   
   dl.LC_ListStyleClean dd {
     display: table-row;
   }
   
   .LC_ListStyleClean,
   .LC_ListStyleSimple,
   .LC_ListStyleNormal,
   .LC_ListStyleSpecial {
     /* display:block; */
     list-style-position: inside;
     list-style-type: none;
     overflow: hidden;
     padding: 0;
   }
   
   .LC_ListStyleSimple li,
   .LC_ListStyleSimple dd,
   .LC_ListStyleNormal li,
   .LC_ListStyleNormal dd,
   .LC_ListStyleSpecial li,
   .LC_ListStyleSpecial dd {
     margin: 0;
     padding: 5px 5px 5px 10px;
     clear: both;
   }
   
   .LC_ListStyleClean li,
   .LC_ListStyleClean dd {
     padding-top: 0;
     padding-bottom: 0;
   }
   
   .LC_ListStyleSimple dd,
   .LC_ListStyleSimple li {
     border-bottom: solid 1px $lg_border_color;
   }
   
   .LC_ListStyleSpecial li,
   .LC_ListStyleSpecial dd {
     list-style-type: none;
     background-color: RGB(220, 220, 220);
     margin-bottom: 4px;
   }
   
   table.LC_SimpleTable {
     margin:5px;
     border:solid 1px $lg_border_color;
   }
   
   table.LC_SimpleTable tr {
     padding: 0;
     border:solid 1px $lg_border_color;
   }
   
   table.LC_SimpleTable thead {
     background:rgb(220,220,220);
   }
   
   div.LC_columnSection {
     display: block;
     clear: both;
     overflow: hidden;
     margin: 0;
   }
   
   div.LC_columnSection>* {
     float: left;
     margin: 10px 20px 10px 0;
     overflow:hidden;
   }
   
   table em {
     font-weight: bold;
     font-style: normal;
   }
   
   table.LC_tableBrowseRes,
   table.LC_tableOfContent {
     border:none;
     border-spacing: 1px;
     padding: 3px;
     background-color: #FFFFFF;
     font-size: 90%;
   }
   
   table.LC_tableOfContent {
     border-collapse: collapse;
   }
   
   table.LC_tableBrowseRes a,
   table.LC_tableOfContent a {
     background-color: transparent;
     text-decoration: none;
   }
   
   table.LC_tableOfContent img {
     border: none;
     height: 1.3em;
     vertical-align: text-bottom;
     margin-right: 0.3em;
   }
   
   a#LC_content_toolbar_firsthomework {
     background-image:url(/res/adm/pages/open-first-problem.gif);
   }
   
   a#LC_content_toolbar_launchnav {
     background-image:url(/res/adm/pages/start-navigation.gif);
   }
   
   a#LC_content_toolbar_closenav {
     background-image:url(/res/adm/pages/close-navigation.gif);
   }
   
   a#LC_content_toolbar_everything {
     background-image:url(/res/adm/pages/show-all.gif);
   }
   
   a#LC_content_toolbar_uncompleted {
     background-image:url(/res/adm/pages/show-incomplete-problems.gif);
   }
   
   #LC_content_toolbar_clearbubbles {
     background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
   }
   
   a#LC_content_toolbar_changefolder {
     background : url(/res/adm/pages/close-all-folders.gif) top center ;
   }
   
   a#LC_content_toolbar_changefolder_toggled {
     background-image:url(/res/adm/pages/open-all-folders.gif);
   }
   
   ul#LC_toolbar li a:hover {
     background-position: bottom center;
   }
   
   ul#LC_toolbar {
     padding: 0;
     margin: 2px;
     list-style:none;
     position:relative;
     background-color:white;
   }
   
   ul#LC_toolbar li {
     border:1px solid white;
     padding: 0;
     margin: 0;
     float: left;
     display:inline;
     vertical-align:middle;
   }
   
   
   a.LC_toolbarItem {
     display:block;
     padding: 0;
     margin: 0;
     height: 32px;
     width: 32px;
     color:white;
     border: none;
     background-repeat:no-repeat;
     background-color:transparent;
   }
   
   ul.LC_funclist {
       margin: 0;
       padding: 0.5em 1em 0.5em 0;
   }
   
   ul.LC_funclist > li:first-child {
       font-weight:bold; 
       margin-left:0.8em;
   }
   
   ul.LC_funclist + ul.LC_funclist {
       /* 
          left border as a seperator if we have more than
          one list 
       */
       border-left: 1px solid $sidebg;
       /* 
          this hides the left border behind the border of the 
          outer box if element is wrapped to the next 'line' 
       */
       margin-left: -1px;
   }
   
   ul.LC_funclist li {
     display: inline;
     white-space: nowrap;
     margin: 0 0 0 25px;
     line-height: 150%;
   }
   
   .ui-accordion .LC_advanced_toggle {
     float: right;
     font-size: 90%;
     padding: 0px 4px
   }
   
 END  END
 }  }
   
 =pod  =pod
   
 =over 4  
   
 =item * &headtag()  =item * &headtag()
   
 Returns a uniform footer for LON-CAPA web pages.  Returns a uniform footer for LON-CAPA web pages.
Line 3257  Inputs: $title - optional title for the Line 6611  Inputs: $title - optional title for the
         $args - optional arguments          $args - optional arguments
             force_register - if is true call registerurl so the remote is               force_register - if is true call registerurl so the remote is 
                              informed                               informed
             redirect       -> array ref of seconds before redirect occurs              redirect       -> array ref of
                                     url to redirect to                                     1- seconds before redirect occurs
                                      2- url to redirect to
                                      3- whether the side effect should occur
                            (side effect of setting                              (side effect of setting 
                                $env{'internal.head.redirect'} to the url                                  $env{'internal.head.redirect'} to the url 
                                redirected too)                                 redirected too)
Line 3266  Inputs: $title - optional title for the Line 6622  Inputs: $title - optional title for the
                                domain                                 domain
             function       -> force usage of a specific rolish color scheme              function       -> force usage of a specific rolish color scheme
             bgcolor        -> override the default page bgcolor              bgcolor        -> override the default page bgcolor
               no_auto_mt_title
 =back                             -> prevent &mt()ing the title arg
   
 =cut  =cut
   
 sub headtag {  sub headtag {
     my ($title,$head_extra,$args) = @_;      my ($title,$head_extra,$args) = @_;
           
       my $function = $args->{'function'} || &get_users_function();
       my $domain   = $args->{'domain'}   || &determinedomain();
       my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
       my $url = join(':',$env{'user.name'},$env{'user.domain'},
      $Apache::lonnet::perlvar{'lonVersion'},
      #time(),
      $env{'environment.color.timestamp'},
      $function,$domain,$bgcolor);
   
       $url = '/adm/css/'.&escape($url).'.css';
   
     my $result =      my $result =
  '<head>'.   '<head>'.
  &standard_css($args->{'function'},$args->{'domain'},   &font_settings();
       $args->{'bgcolor'}).  
  &font_settings().  
  &Apache::lonhtmlcommon::htmlareaheaders();  
   
       if (!$args->{'frameset'}) {
    $result .= &Apache::lonhtmlcommon::htmlareaheaders();
       }
     if ($args->{'force_register'}) {      if ($args->{'force_register'}) {
  $result .= &Apache::lonmenu::registerurl(1);   $result .= &Apache::lonmenu::registerurl(1);
     }      }
       if (!$args->{'no_nav_bar'} 
    && !$args->{'only_body'}
    && !$args->{'frameset'}) {
    $result .= &help_menu_js();
       }
   
     if (ref($args->{'redirect'})) {      if (ref($args->{'redirect'})) {
  my ($time,$url) = @{$args->{'redirect'}};   my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
  $url = &Apache::lonenc::check_encrypt($url);   $url = &Apache::lonenc::check_encrypt($url);
  $env{'internal.head.redirect'} = $url;   if (!$inhibit_continue) {
       $env{'internal.head.redirect'} = $url;
    }
  $result.=<<ADDMETA   $result.=<<ADDMETA
 <meta http-equiv="pragma" content="no-cache" />  <meta http-equiv="pragma" content="no-cache" />
 <meta http-equiv="Refresh" content="$time; url=$url" />  <meta http-equiv="Refresh" content="$time; url=$url" />
Line 3297  ADDMETA Line 6671  ADDMETA
     if (!defined($title)) {      if (!defined($title)) {
  $title = 'The LearningOnline Network with CAPA';   $title = 'The LearningOnline Network with CAPA';
     }      }
           if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
     $result .= '<title> LON-CAPA '.&mt($title).'</title>'.$head_extra;      $result .= '<title> LON-CAPA '.$title.'</title>'
    .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
    .$head_extra;
     return $result;      return $result;
 }  }
   
 =pod  =pod
   
 =over 4  
   
 =item * &font_settings()  =item * &font_settings()
   
 Returns neccessary <meta> to set the proper encoding  Returns neccessary <meta> to set the proper encoding
   
 Inputs: none  Inputs: none
   
 =back  
   
 =cut  =cut
   
 sub font_settings {  sub font_settings {
     my $headerstring='';      my $headerstring='';
     if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {       if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
  $headerstring.=  
     '<meta Content-Type="text/html; charset=x-mac-roman" />';  
     } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {  
  $headerstring.=   $headerstring.=
     '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';      '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
     }      }
Line 3330  sub font_settings { Line 6699  sub font_settings {
   
 =pod  =pod
   
 =over 4  
   
 =item * &xml_begin()  =item * &xml_begin()
   
 Returns the needed doctype and <html>  Returns the needed doctype and <html>
   
 Inputs: none  Inputs: none
   
 =back  
   
 =cut  =cut
   
 sub xml_begin {  sub xml_begin {
     my $output='';      my $output='';
   
     &Apache::lonhtmlcommon::init_htmlareafields();  
   
     if ($env{'browser.mathml'}) {      if ($env{'browser.mathml'}) {
  $output='<?xml version="1.0"?>'   $output='<?xml version="1.0"?>'
             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"              #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
Line 3357  sub xml_begin { Line 6720  sub xml_begin {
             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '               .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
     .'xmlns="http://www.w3.org/1999/xhtml">';      .'xmlns="http://www.w3.org/1999/xhtml">';
     } else {      } else {
  $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';   $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
              .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
     }      }
     return $output;      return $output;
 }  }
   
 =pod  =pod
   
 =over 4  
   
 =item * &endheadtag()  =item * &endheadtag()
   
 Returns a uniform </head> for LON-CAPA web pages.  Returns a uniform </head> for LON-CAPA web pages.
   
 Inputs: none  Inputs: none
   
 =back  
   
 =cut  =cut
   
 sub endheadtag {  sub endheadtag {
Line 3382  sub endheadtag { Line 6742  sub endheadtag {
   
 =pod  =pod
   
 =over 4  
   
 =item * &head()  =item * &head()
   
 Returns a uniform complete <head>..</head> section for LON-CAPA web pages.  Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
   
 Inputs: $title - optional title for the page  Inputs:
         $head_extra - optional extra HTML to put inside the <head>  
   =over 4
   
   $title - optional title for the page
   
   $head_extra - optional extra HTML to put inside the <head>
   
 =back  =back
   
 =cut  =cut
Line 3401  sub head { Line 6765  sub head {
   
 =pod  =pod
   
 =over 4  
   
 =item * &start_page()  =item * &start_page()
   
 Returns a complete <html> .. <body> section for LON-CAPA web pages.  Returns a complete <html> .. <body> section for LON-CAPA web pages.
   
 Inputs: $title - optional title for the page  Inputs:
         $head_extra - optional extra HTML to incude inside the <head>  
         $args - additional optional args supported are:  =over 4
                   only_body      -> is true will set &bodytag() onlybodytag  
   $title - optional title for the page
   
   $head_extra - optional extra HTML to incude inside the <head>
   
   $args - additional optional args supported are:
   
   =over 8
   
                only_body      -> is true will set &bodytag() onlybodytag
                                     arg on                                      arg on
                   no_nav_bar     -> is true will set &bodytag() notopbar arg on               no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
                   add_entries    -> additional attributes to add to the  <body>               add_entries    -> additional attributes to add to the  <body>
                   domain         -> force to color decorate a page for a                domain         -> force to color decorate a page for a 
                                     specific domain                                      specific domain
                   function       -> force usage of a specific rolish color               function       -> force usage of a specific rolish color
                                     scheme                                      scheme
                   redirect       -> see &headtag()               redirect       -> see &headtag()
                   bgcolor        -> override the default page bg color               bgcolor        -> override the default page bg color
                   js_ready       -> return a string ready for being used in                js_ready       -> return a string ready for being used in 
                                     a javascript writeln                                      a javascript writeln
                   html_encode    -> return a string ready for being used in                html_encode    -> return a string ready for being used in 
                                     a html attribute                                      a html attribute
                   force_register -> if is true will turn on the &bodytag()               force_register -> if is true will turn on the &bodytag()
                                     $forcereg arg                                      $forcereg arg
                   body_title     -> alternate text to use instead of $title               frameset       -> if true will start with a <frameset>
                                     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>                                      rather than <body>
                   no_title       -> if true the title bar won't be shown               skip_phases    -> hash ref of 
                   skip_phases    -> hash ref of   
                                     head -> skip the <html><head> generation                                      head -> skip the <html><head> generation
                                     body -> skip all <body> 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
                inherit_jsmath -> when creating popup window in a page,
                                       should it have jsmath forced on by the
                                       current page
                bread_crumbs ->             Array containing breadcrumbs
                bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
   
   =back
   
 =back  =back
   
Line 3445  sub start_page { Line 6822  sub start_page {
     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));      #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
     my %head_args;      my %head_args;
     foreach my $arg ('redirect','force_register','domain','function',      foreach my $arg ('redirect','force_register','domain','function',
      'bgcolor') {       'bgcolor','frameset','no_nav_bar','only_body',
        'no_auto_mt_title') {
  if (defined($args->{$arg})) {   if (defined($args->{$arg})) {
     $head_args{$arg} = $args->{$arg};      $head_args{$arg} = $args->{$arg};
  }   }
Line 3464  sub start_page { Line 6842  sub start_page {
     my $attr_string = &make_attr_string($args->{'force_register'},      my $attr_string = &make_attr_string($args->{'force_register'},
  $args->{'add_entries'});   $args->{'add_entries'});
     $result .= "\n<frameset $attr_string>\n";      $result .= "\n<frameset $attr_string>\n";
  } else {          } else {
     $result .=              $result .=
  &bodytag($title,                   &bodytag($title, 
  $args->{'function'},       $args->{'add_entries'},                           $args->{'function'},       $args->{'add_entries'},
  $args->{'only_body'},      $args->{'domain'},                           $args->{'only_body'},      $args->{'domain'},
  $args->{'force_register'}, $args->{'body_title'},                           $args->{'force_register'}, $args->{'no_nav_bar'},
  $args->{'no_nav_bar'},     $args->{'bgcolor'},                           $args->{'bgcolor'},        $args->{'no_inline_link'},
  $args->{'no_title'});                           $args);
  }          }
     }      }
   
     if ($args->{'js_ready'}) {      if ($args->{'js_ready'}) {
  $result = &js_ready($result);   $result = &js_ready($result);
     }      }
     if ($args->{'html_encode'}) {      if ($args->{'html_encode'}) {
  $result = &html_encode($result);   $result = &html_encode($result);
       }
   
       # Preparation for new and consistent functionlist at top of screen
       # if ($args->{'functionlist'}) {
       #            $result .= &build_functionlist();
       #}
   
       # Don't add anything more if only_body wanted
       return $result if $args->{'only_body'};
   
       #Breadcrumbs for Construction Space provided by &bodytag. 
       if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
           return $result;
       }
    
       #Breadcrumbs
       if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
    &Apache::lonhtmlcommon::clear_breadcrumbs();
    #if any br links exists, add them to the breadcrumbs
    if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
    foreach my $crumb (@{$args->{'bread_crumbs'}}){
    &Apache::lonhtmlcommon::add_breadcrumb($crumb);
    }
    }
   
    #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
    if(exists($args->{'bread_crumbs_component'})){
    $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
    }else{
    $result .= &Apache::lonhtmlcommon::breadcrumbs();
    }
     }      }
     return $result;      return $result;
 }  }
Line 3487  sub start_page { Line 6896  sub start_page {
   
 =pod  =pod
   
 =over 4  
   
 =item * &head()  =item * &head()
   
 Returns a complete </body></html> section for LON-CAPA web pages.  Returns a complete </body></html> section for LON-CAPA web pages.
Line 3500  Inputs:         $args - additional optio Line 6907  Inputs:         $args - additional optio
                                  a html attribute                                   a html attribute
                  frameset     -> if true will start with a <frameset>                   frameset     -> if true will start with a <frameset>
                                  rather than <body>                                   rather than <body>
 =back                   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  =cut
   
 sub end_page {  sub end_page {
     my ($args) = @_;      my ($args) = @_;
     #&Apache::lonnet::logthis("end_page ".join(':',caller(0)));  
     $env{'internal.end_page'}++;      $env{'internal.end_page'}++;
     my $result;      my $result;
     if ($args->{'discussion'}) {      if ($args->{'discussion'}) {
Line 3521  sub end_page { Line 6931  sub end_page {
     if ($args->{'frameset'}) {      if ($args->{'frameset'}) {
  $result .= '</frameset>';   $result .= '</frameset>';
     } else {      } else {
  $result .= &endbodytag();   $result .= &endbodytag($args);
     }      }
     $result .= "\n</html>";      $result .= "\n</html>";
   
Line 3549  sub js_ready { Line 6959  sub js_ready {
     $result =~ s/[\n\r]/ /xmsg;      $result =~ s/[\n\r]/ /xmsg;
     $result =~ s/\\/\\\\/xmsg;      $result =~ s/\\/\\\\/xmsg;
     $result =~ s/'/\\'/xmsg;      $result =~ s/'/\\'/xmsg;
     $result =~ s{</script>}{</scrip'+'t>}xmsg;      $result =~ s{</}{<\\/}xmsg;
           
     return $result;      return $result;
 }  }
Line 3593  sub simple_error_page { Line 7003  sub simple_error_page {
 }  }
   
 {  {
     my $row_count;      my @row_count;
   
       sub start_data_table_count {
           unshift(@row_count, 0);
           return;
       }
   
       sub end_data_table_count {
           shift(@row_count);
           return;
       }
   
     sub start_data_table {      sub start_data_table {
  undef($row_count);   my ($add_class) = @_;
  return '<table class="LC_data_table">';   my $css_class = (join(' ','LC_data_table',$add_class));
           &start_data_table_count();
    return '<table class="'.$css_class.'">'."\n";
     }      }
   
     sub end_data_table {      sub end_data_table {
  undef($row_count);          &end_data_table_count();
  return '</table>';   return '</table>'."\n";;
     }      }
   
     sub start_data_table_row {      sub start_data_table_row {
  $row_count++;   my ($add_class) = @_;
  return  '<tr '.(($row_count % 2)?'':'class="LC_even_row"').'>';   $row_count[0]++;
    my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
    $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
    return  '<tr class="'.$css_class.'">'."\n";;
       }
       
       sub continue_data_table_row {
    my ($add_class) = @_;
    my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
    $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
    return  '<tr class="'.$css_class.'">'."\n";;
     }      }
   
     sub end_data_table_row {      sub end_data_table_row {
  return '</tr>';   return '</tr>'."\n";;
       }
   
       sub start_data_table_empty_row {
   # $row_count[0]++;
    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";;
       }
   
       sub data_table_caption {
           my $caption = shift;
           return "<caption class=\"LC_caption\">$caption</caption>";
       }
   }
   
   =pod
   
   =item * &inhibit_menu_check($arg)
   
   Checks for a inhibitmenu state and generates output to preserve it
   
   Inputs:         $arg - can be any of
                        - undef - in which case the return value is a string 
                                  to add  into arguments list of a uri
                        - 'input' - in which case the return value is a HTML
                                    <form> <input> field of type hidden to
                                    preserve the value
                        - a url - in which case the return value is the url with
                                  the neccesary cgi args added to preserve the
                                  inhibitmenu state
                        - a ref to a url - no return value, but the string is
                                           updated to include the neccessary cgi
                                           args to preserve the inhibitmenu state
   
   =cut
   
   sub inhibit_menu_check {
       my ($arg) = @_;
       &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
       if ($arg eq 'input') {
    if ($env{'form.inhibitmenu'}) {
       return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
    } else {
       return
    }
       }
       if ($env{'form.inhibitmenu'}) {
    if (ref($arg)) {
       $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
    } elsif ($arg eq '') {
       $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
    } else {
       $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
    }
       }
       if (!ref($arg)) {
    return $arg;
     }      }
 }  }
   
Line 3618  sub simple_error_page { Line 7118  sub simple_error_page {
   
 =pod  =pod
   
   =back
   
   =head1 User Information Routines
   
 =over 4  =over 4
   
 =item get_users_function  =item * &get_users_function()
   
 Used by &bodytag to determine the current users primary role.  Used by &bodytag to determine the current users primary role.
 Returns either 'student','coordinator','admin', or 'author'.  Returns either 'student','coordinator','admin', or 'author'.
Line 3629  Returns either 'student','coordinator',' Line 7133  Returns either 'student','coordinator','
   
 ###############################################  ###############################################
 sub get_users_function {  sub get_users_function {
     my $function = 'student';      my $function = 'norole';
     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {      if ($env{'request.role'}=~/^(st)/) {
           $function='student';
       }
       if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
         $function='coordinator';          $function='coordinator';
     }      }
     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {      if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
         $function='admin';          $function='admin';
     }      }
     if (($env{'request.role'}=~/^(au|ca)/) ||      if (($env{'request.role'}=~/^(au|ca|aa)/) ||
         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {          ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
         $function='author';          $function='author';
     }      }
Line 3647  sub get_users_function { Line 7154  sub get_users_function {
   
 =pod  =pod
   
 =item check_user_status  =item * &show_course()
   
   Used by lonmenu.pm and lonroles.pm to determine whether to use the word
   'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
   
   Inputs:
   None
   
   Outputs:
   Scalar: 1 if 'Course' to be used, 0 otherwise.
   
   =cut
   
   ###############################################
   sub show_course {
       my $course = !$env{'user.adv'};
       if (!$env{'user.adv'}) {
           foreach my $env (keys(%env)) {
               next if ($env !~ m/^user\.priv\./);
               if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   $course = 0;
                   last;
               }
           }
       }
       return $course;
   }
   
   ###############################################
   
   =pod
   
   =item * &check_user_status()
   
 Determines current status of supplied role for a  Determines current status of supplied role for a
 specific user. Roles can be active, previous or future.  specific user. Roles can be active, previous or future.
   
 Inputs:   Inputs: 
 user's domain, user's username, course's domain,  user's domain, user's username, course's domain,
 course's number, optional section/group.  course's number, optional section ID.
   
 Outputs:  Outputs:
 role status: active, previous or future.   role status: active, previous or future. 
Line 3662  role status: active, previous or future. Line 7201  role status: active, previous or future.
 =cut  =cut
   
 sub check_user_status {  sub check_user_status {
     my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_;      my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);      my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
       my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
     my @uroles = keys %userinfo;      my @uroles = keys %userinfo;
     my $srchstr;      my $srchstr;
     my $active_chk = 'none';      my $active_chk = 'none';
       my $now = time;
     if (@uroles > 0) {      if (@uroles > 0) {
         if (($role eq 'cc') || ($secgrp eq '') || (!defined($secgrp))) {          if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;              $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
         } else {          } else {
             $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role;         }              $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
         if (grep/^$srchstr$/,@uroles) {          }
           if (grep/^\Q$srchstr\E$/,@uroles) {
             my $role_end = 0;              my $role_end = 0;
             my $role_start = 0;              my $role_start = 0;
             $active_chk = 'active';              $active_chk = 'active';
             if ($userinfo{$srchstr} =~ m/^($role)_(\d+)/) {              if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                 $role_end = $2;                  $role_end = $1;
                 if ($userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/) {                  if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                     $role_start = $3;                      $role_start = $1;
                 }                  }
             }              }
             if ($role_start > 0) {              if ($role_start > 0) {
                 if (time < $role_start) {                  if ($now < $role_start) {
                     $active_chk = 'future';                      $active_chk = 'future';
                 }                  }
             }              }
             if ($role_end > 0) {              if ($role_end > 0) {
                 if (time > $role_end) {                  if ($now > $role_end) {
                     $active_chk = 'previous';                      $active_chk = 'previous';
                 }                  }
             }              }
Line 3701  sub check_user_status { Line 7243  sub check_user_status {
   
 =pod  =pod
   
 =item get_sections  =item * &get_sections()
   
 Determines all the sections for a course including  Determines all the sections for a course including
 sections with students and sections containing other roles.  sections with students and sections containing other roles.
 Incoming parameters: domain, course number, reference to   Incoming parameters: 
 section hash (keys to be section/group IDs), reference to   
 array containing roles for which sections should be gathered  1. domain
 (optional). If the fourth argument is undefined, sections  2. course number 
 are gathered for any role.  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 number of sections.  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  =cut
   
 ###############################################  ###############################################
 sub get_sections {  sub get_sections {
     my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;      my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
     if (!($cdom && $cnum)) { return 0; }      if (!defined($cdom) || !defined($cnum)) {
     my $numsections = 0;          my $cid =  $env{'request.course.id'};
   
    return if (!defined($cid));
   
           $cdom = $env{'course.'.$cid.'.domain'};
           $cnum = $env{'course.'.$cid.'.num'};
       }
   
     if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {      my %sectioncount;
       my $now = time;
   
       if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
  my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);   my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
  my $sec_index = &Apache::loncoursedata::CL_SECTION();   my $sec_index = &Apache::loncoursedata::CL_SECTION();
  my $status_index = &Apache::loncoursedata::CL_STATUS();   my $status_index = &Apache::loncoursedata::CL_STATUS();
  while (my ($student,$data) = each %$classlist) {          my $start_index = &Apache::loncoursedata::CL_START();
     my ($section,$status) = ($data->[$sec_index],          my $end_index = &Apache::loncoursedata::CL_END();
      $data->[$status_index]);          my $status;
     unless ($section eq '-1' || $section =~ /^\s*$/) {   while (my ($student,$data) = each(%$classlist)) {
  if (!defined($$sectioncount{$section})) { $numsections++; }      my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
  $$sectioncount{$section}++;                       $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}++;
                   }
     }      }
  }   }
     }      }
Line 3739  sub get_sections { Line 7313  sub get_sections {
  if ($user !~ /^(\w{2})/) { next; }   if ($user !~ /^(\w{2})/) { next; }
  my ($role) = ($user =~ /^(\w{2})/);   my ($role) = ($user =~ /^(\w{2})/);
  if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }   if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
  my $section;   my ($section,$status);
  if ($role eq 'cr' &&   if ($role eq 'cr' &&
     $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {      $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
     $section=$1;      $section=$1;
  }   }
  if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }   if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
  if (!defined($section) || $section eq '-1') { next; }   if (!defined($section) || $section eq '-1') { next; }
  if (!defined($$sectioncount{$section})) { $numsections++; }           my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
  $$sectioncount{$section}++;          if ($end == -1 && $start == -1) {
     }              next; #deleted role
     return $numsections;  
 }  
   
 ###############################################  
                                                                                     
 =pod  
                                                                                     
 =item coursegroups  
   
 Retrieve information about groups in a course,  
   
 Input:  
 1. Reference to hash to populate with group information.   
 2. Optional course domain  
 3. Optional course number  
 4. Optional group name  
   
 Course domain and number will be taken from user's  
 environment if not supplied. Optional group name will'  
 be passed to lonnet::get_coursegroups() as a regexp to  
 use in the call to the dump function.  
   
 Output  
 Returns number of groups in the course (subject to the  
 optional group name filter).  
   
 Side effects:  
 Populates the referenced curr_groups hash, with key,  
 value pairs. Keys are group names, corresponding values  
 are scalars containing group information in XML. This  
 can be sent to &get_group_settings() to be parsed.       
   
 =cut   
   
 ###############################################  
   
 sub coursegroups {  
     my ($curr_groups,$cdom,$cnum,$group) = @_;  
     my $numgroups;  
     if (!defined($cdom) || !defined($cnum)) {  
         my $cid =  $env{'request.course.id'};  
         $cdom = $env{'course.'.$cid.'.domain'};  
         $cnum = $env{'course.'.$cid.'.num'};  
     }  
     %{$curr_groups} = &Apache::lonnet::get_coursegroups($cdom,$cnum,$group);  
     my ($tmp) = keys(%{$curr_groups});  
     if ($tmp=~/^error:/) {  
         unless ($tmp eq 'error: 2 tie(GDBM) Failed while attempting dump') {  
             &logthis('Error retrieving groups: '.$tmp.' in '.$cnum.':'.  
                                                                    $cdom);  
         }          }
         $numgroups = 0;          if (!defined($possible_status)) { 
     } else {              $sectioncount{$section}++;
         $numgroups = keys(%{$curr_groups});          } else {
     }              if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
     return $numgroups;                  $status = 'active';
 }              } elsif ($end < $now) {
                   $status = 'future';
 ###############################################              } elsif ($start > $now) {
                   $status = 'previous';
 =pod  
   
 =item get_group_settings  
   
 Uses TokeParser to extract group information from the  
 XML used to describe course groups.  
   
 Input:  
 Scalar containing XML  - as retrieved from &coursegroups().  
   
 Output:  
 Hash containing group information as key=values for (a), and  
 hash of hashes for (b)  
   
 Keys (in two categories):  
 (a) groupname, creator, creation, modified, startdate,enddate.  
 Corresponding values are name of the group, creator of the group  
 (username:domain), UNIX time for date group was created, and  
 settings were last modified, and default start and end access  
 times for group members.  
   
 (b) functions returned in hash of hashes.  
 Outer hash key is functions.  
 Inner hash keys are chat,discussion,email,files,homepage,roster.  
 Corresponding values are either on or off, depending on  
 whether this type of functionality is available for the group.  
   
 =cut  
                                                                                    
 ###############################################  
   
 sub get_group_settings {  
     my ($groupinfo)=@_;  
     my $parser=HTML::TokeParser->new(\$groupinfo);  
     my $token;  
     my $tool = '';  
     my $role = '';  
     my %content=();  
     while ($token=$parser->get_token) {  
         if ($token->[0] eq 'S')  {  
             my $entry=$token->[1];  
             if ($entry eq 'functions' || $entry eq 'autosec') {  
                 %{$content{$entry}} = ();  
                 $tool = $entry;  
             } elsif ($entry eq 'role') {  
                 if ($tool eq 'autosec') {  
                     $role = $token->[2]{id};  
                 }  
             } else {  
                 my $value=$parser->get_text('/'.$entry);  
                 if ($entry eq 'name') {  
                     if ($tool eq 'functions') {  
                         my $function = $token->[2]{id};  
                         $content{$tool}{$function} = $value;  
                     }  
                 } elsif ($entry eq 'groupname') {  
                     $content{$entry}=&Apache::lonnet::unescape($value);  
                 } elsif (($entry eq 'roles') || ($entry eq 'types') ||  
                          ($entry eq 'sectionpick') || ($entry eq 'defpriv')) {  
                     push(@{$content{$entry}},$value);  
                 } elsif ($entry eq 'section') {  
                     if ($tool eq 'autosec'  && $role ne '') {  
                         push(@{$content{$tool}{$role}},$value);  
                     }  
                 } else {  
                     $content{$entry}=$value;  
                 }  
             }              }
         } elsif ($token->[0] eq 'E') {              if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
             if ($token->[1] eq 'functions' || $token->[1] eq 'autosec') {                  $sectioncount{$section}++;
                 $tool = '';  
             } elsif ($token->[1] eq 'role') {  
                 $role = '';  
             }              }
   
         }          }
     }      }
     return %content;      return %sectioncount;
 }  
   
 sub check_group_access {  
     my ($group) = @_;  
     my $access = 1;  
     my $now = time;  
     my ($start,$end) = split(/\./,$env{'user.role.gr/'.$env{'request.course,id'}.'/'.$group});  
     if (($end!=0) && ($end<$now)) { $access = 0; }  
     if (($start!=0) && ($start>$now)) { $access=0; }  
     return $access;  
 }  }
   
 ###############################################  ###############################################
   
 =pod  =pod
                                                                                   
 =item get_course_users  =item * &get_course_users()
                                                                                   
 Retrieves usernames:domains for users in the specified course  Retrieves usernames:domains for users in the specified course
 with specific role(s), and access status.   with specific role(s), and access status. 
   
Line 3917  previous, future, or all. Line 7360  previous, future, or all.
 5. reference to array of section restrictions (optional)  5. reference to array of section restrictions (optional)
 6. reference to results object (hash of hashes).  6. reference to results object (hash of hashes).
 7. reference to optional userdata hash  7. reference to optional userdata hash
 Keys of top level hash are roles.  8. reference to optional statushash
   9. flag if privileged users (except those set to unhide in
      course settings) should be excluded    
   Keys of top level results hash are roles.
 Keys of inner hashes are username:domain, with   Keys of inner hashes are username:domain, with 
 values set to access type.  values set to access type.
 Optional userdata hash returns an array with arguments in the   Optional userdata hash returns an array with arguments in the 
 same order as loncoursedata::get_classlist() for student data.  same order as loncoursedata::get_classlist() for student data.
   
   Optional statushash returns
   
 Entries for end, start, section and status are blank because  Entries for end, start, section and status are blank because
 of the possibility of multiple values for non-student roles.  of the possibility of multiple values for non-student roles.
   
 =cut  =cut
                                                                                   
 ###############################################  ###############################################
                                                                                   
 sub get_course_users {  sub get_course_users {
     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;      my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
     my %idx = ();      my %idx = ();
       my %seclists;
   
     $idx{udom} = &Apache::loncoursedata::CL_SDOM();      $idx{udom} = &Apache::loncoursedata::CL_SDOM();
     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();      $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
Line 3948  sub get_course_users { Line 7397  sub get_course_users {
         my $now = time;          my $now = time;
         foreach my $student (keys(%{$classlist})) {          foreach my $student (keys(%{$classlist})) {
             my $match = 0;              my $match = 0;
               my $secmatch = 0;
               my $section = $$classlist{$student}[$idx{section}];
               my $status = $$classlist{$student}[$idx{status}];
               if ($section eq '') {
                   $section = 'none';
               }
             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {              if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
  unless(grep(/^\Q$$classlist{$student}[$idx{section}]\E$/,                  if (grep(/^all$/,@{$sections})) {
     @{$sections})) {                      $secmatch = 1;
     next;                  } elsif ($$classlist{$student}[$idx{section}] eq '') {
                       if (grep(/^none$/,@{$sections})) {
                           $secmatch = 1;
                       }
                   } else {  
       if (grep(/^\Q$section\E$/,@{$sections})) {
           $secmatch = 1;
                       }
  }   }
             }                   if (!$secmatch) {
                       next;
                   }
               }
             if (defined($$types{'active'})) {              if (defined($$types{'active'})) {
                 if ($$classlist{$student}[$idx{status}] eq 'Active') {                  if ($$classlist{$student}[$idx{status}] eq 'Active') {
                     push(@{$$users{st}{$student}},'active');                      push(@{$$users{st}{$student}},'active');
Line 3961  sub get_course_users { Line 7426  sub get_course_users {
                 }                  }
             }              }
             if (defined($$types{'previous'})) {              if (defined($$types{'previous'})) {
                 if ($$classlist{$student}[$idx{end}] <= $now) {                  if ($$classlist{$student}[$idx{status}] eq 'Expired') {
                     push(@{$$users{st}{$student}},'previous');                      push(@{$$users{st}{$student}},'previous');
                     $match = 1;                      $match = 1;
                 }                  }
             }              }
             if (defined($$types{'future'})) {              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 '')) {                  if ($$classlist{$student}[$idx{status}] eq 'Future') {
                     push(@{$$users{st}{$student}},'future');                      push(@{$$users{st}{$student}},'future');
                     $match = 1;                      $match = 1;
                 }                  }
             }              }
             if ($match && defined($userdata)) {              if ($match) {
                 $$userdata{$student} = $$classlist{$student};                  push(@{$seclists{$student}},$section);
                   if (ref($userdata) eq 'HASH') {
                       $$userdata{$student} = $$classlist{$student};
                   }
                   if (ref($statushash) eq 'HASH') {
                       $statushash->{$student}{'st'}{$section} = $status;
                   }
             }              }
         }          }
     }      }
     if ((@{$roles} > 0) && (@{$roles} ne "st")) {      if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
         my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);          my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
         foreach my $person (@coursepersonnel) {          my $now = time;
           my %displaystatus = ( previous => 'Expired',
                                 active   => 'Active',
                                 future   => 'Future',
                               );
           my %nothide;
           if ($hidepriv) {
               my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
               foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   if ($user !~ /:/) {
                       $nothide{join(':',split(/[\@]/,$user))}=1;
                   } else {
                       $nothide{$user} = 1;
                   }
               }
           }
           foreach my $person (sort(keys(%coursepersonnel))) {
             my $match = 0;              my $match = 0;
             my ($role,$user) = ($person =~ /^([^:]*):([^:]+:[^:]+)/);              my $secmatch = 0;
               my $status;
               my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
             $user =~ s/:$//;              $user =~ s/:$//;
             if (($role) && (grep(/^\Q$role\E$/,@{$roles}))) {              my ($end,$start) = split(/:/,$coursepersonnel{$person});
                 my ($uname,$udom,$usec) = split(/:/,$user);              if ($end == -1 || $start == -1) {
                 if ($usec ne '' && (ref($sections) eq 'ARRAY') &&                   next;
     @{$sections} > 0) {              }
     unless(grep(/^\Q$usec\E$/,@{$sections})) {              if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
  next;                  (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 ($uname ne '' && $udom ne '') {
                     my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role);                      if ($hidepriv) {
                           if ((&Apache::lonnet::privileged($uname,$udom)) &&
                               (!$nothide{$uname.':'.$udom})) {
                               next;
                           }
                       }
                       if ($end > 0 && $end < $now) {
                           $status = 'previous';
                       } elsif ($start > $now) {
                           $status = 'future';
                       } else {
                           $status = 'active';
                       }
                     foreach my $type (keys(%{$types})) {                       foreach my $type (keys(%{$types})) { 
                         if ($status eq $type) {                          if ($status eq $type) {
                             @{$$users{$role}{$user}} = $type;                              if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
                                   push(@{$$users{$role}{$user}},$type);
                               }
                             $match = 1;                              $match = 1;
                         }                          }
                     }                      }
                     if ($match && defined($userdata) &&                      if (($match) && (ref($userdata) eq 'HASH')) {
                         !exists($$userdata{$uname.':'.$udom})) {                          if (!exists($$userdata{$uname.':'.$udom})) {
  &get_user_info($udom,$uname,\%idx,$userdata);      &get_user_info($udom,$uname,\%idx,$userdata);
                           }
                           if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
                               push(@{$seclists{$uname.':'.$udom}},$usec);
                           }
                           if (ref($statushash) eq 'HASH') {
                               $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                           }
                     }                      }
                 }                  }
             }              }
Line 4011  sub get_course_users { Line 7539  sub get_course_users {
                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);                  my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                 if ( defined($csettings{'internal.courseowner'}) ) {                  if ( defined($csettings{'internal.courseowner'}) ) {
                     my $owner = $csettings{'internal.courseowner'};                      my $owner = $csettings{'internal.courseowner'};
                     @{$$users{'ow'}{$owner.':'.$cdom}} = 'any';                      next if ($owner eq '');
                       my ($ownername,$ownerdom);
                       if ($owner =~ /^([^:]+):([^:]+)$/) {
                           $ownername = $1;
                           $ownerdom = $2;
                       } else {
                           $ownername = $owner;
                           $ownerdom = $cdom;
                           $owner = $ownername.':'.$ownerdom;
                       }
                       @{$$users{'ow'}{$owner}} = 'any';
                     if (defined($userdata) &&                       if (defined($userdata) && 
  !exists($$userdata{$owner.':'.$cdom})) {   !exists($$userdata{$owner})) {
  &get_user_info($cdom,$owner,\%idx,$userdata);   &get_user_info($ownerdom,$ownername,\%idx,$userdata);
                           if (!grep(/^none$/,@{$seclists{$owner}})) {
                               push(@{$seclists{$owner}},'none');
                           }
                           if (ref($statushash) eq 'HASH') {
                               $statushash->{$owner}{'ow'}{'none'} = 'Any';
                           }
     }      }
                 }                  }
             }              }
         }          }
           foreach my $user (keys(%seclists)) {
               @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
               $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
           }
     }      }
     return;      return;
 }  }
Line 4029  sub get_user_info { Line 7577  sub get_user_info {
  &plainname($uname,$udom,'lastname');   &plainname($uname,$udom,'lastname');
     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;      $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;      $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
       my %idhash =  &Apache::lonnet::idrget($udom,($uname));
       $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
       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.
   
   =back
   
   =cut
   
   ###############################################
   
   
   sub default_quota {
       my ($udom,$inststatus) = @_;
       my ($defquota,$settingstatus);
       my %quotahash = &Apache::lonnet::get_dom('configuration',
                                               ['quotas'],$udom);
       if (ref($quotahash{'quotas'}) eq 'HASH') {
           if ($inststatus ne '') {
               my @statuses = map { &unescape($_); } split(/:/,$inststatus);
               foreach my $item (@statuses) {
                   if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                       if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                           if ($defquota eq '') {
                               $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                               $settingstatus = $item;
                           } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                               $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                               $settingstatus = $item;
                           }
                       }
                   } else {
                       if ($quotahash{'quotas'}{$item} ne '') {
                           if ($defquota eq '') {
                               $defquota = $quotahash{'quotas'}{$item};
                               $settingstatus = $item;
                           } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                               $defquota = $quotahash{'quotas'}{$item};
                               $settingstatus = $item;
                           }
                       }
                   }
               }
           }
           if ($defquota eq '') {
               if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
               } else {
                   $defquota = $quotahash{'quotas'}{'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);
   }
   
   sub user_picker {
       my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
       my $currdom = $dom;
       my %curr_selected = (
                           srchin => 'dom',
                           srchby => 'lastname',
                         );
       my $srchterm;
       if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
           if ($srch->{'srchby'} ne '') {
               $curr_selected{'srchby'} = $srch->{'srchby'};
           }
           if ($srch->{'srchin'} ne '') {
               $curr_selected{'srchin'} = $srch->{'srchin'};
           }
           if ($srch->{'srchtype'} ne '') {
               $curr_selected{'srchtype'} = $srch->{'srchtype'};
           }
           if ($srch->{'srchdomain'} ne '') {
               $currdom = $srch->{'srchdomain'};
           }
           $srchterm = $srch->{'srchterm'};
       }
       my %lt=&Apache::lonlocal::texthash(
                       'usr'       => 'Search criteria',
                       'doma'      => 'Domain/institution to search',
                       'uname'     => 'username',
                       'lastname'  => 'last name',
                       'lastfirst' => 'last name, first name',
                       'crs'       => 'in this course',
                       'dom'       => 'in selected LON-CAPA domain', 
                       'alc'       => 'all LON-CAPA',
                       'instd'     => 'in institutional directory for selected domain',
                       'exact'     => 'is',
                       'contains'  => 'contains',
                       'begins'    => 'begins with',
                       'youm'      => "You must include some text to search for.",
                       'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                       'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                       'yomc'      => "You must choose a domain when using an institutional directory search.",
                       'ymcd'      => "You must choose a domain when using a domain search.",
                       'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                       'whse'      => "When searching by last,first you must include at least one character in the first name.",
                        'thfo'     => "The following need to be corrected before the search can be run:",
                                          );
       my $domform = &select_dom_form($currdom,'srchdomain',1,1);
       my $srchinsel = ' <select name="srchin">';
   
       my @srchins = ('crs','dom','alc','instd');
   
       foreach my $option (@srchins) {
           # FIXME 'alc' option unavailable until 
           #       loncreateuser::print_user_query_page()
           #       has been completed.
           next if ($option eq 'alc');
           next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
           next if ($option eq 'crs' && !$env{'request.course.id'});
           if ($curr_selected{'srchin'} eq $option) {
               $srchinsel .= ' 
      <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
           } else {
               $srchinsel .= '
      <option value="'.$option.'">'.$lt{$option}.'</option>';
           }
       }
       $srchinsel .= "\n  </select>\n";
   
       my $srchbysel =  ' <select name="srchby">';
       foreach my $option ('lastname','lastfirst','uname') {
           if ($curr_selected{'srchby'} eq $option) {
               $srchbysel .= '
      <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
           } else {
               $srchbysel .= '
      <option value="'.$option.'">'.$lt{$option}.'</option>';
            }
       }
       $srchbysel .= "\n  </select>\n";
   
       my $srchtypesel = ' <select name="srchtype">';
       foreach my $option ('begins','contains','exact') {
           if ($curr_selected{'srchtype'} eq $option) {
               $srchtypesel .= '
      <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
           } else {
               $srchtypesel .= '
      <option value="'.$option.'">'.$lt{$option}.'</option>';
           }
       }
       $srchtypesel .= "\n  </select>\n";
   
       my ($newuserscript,$new_user_create);
   
       if ($forcenewuser) {
           if (ref($srch) eq 'HASH') {
               if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
                   if ($cancreate) {
                       $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
                   } else {
                       my $helplink = 'javascript:helpMenu('."'display'".')';
                       my %usertypetext = (
                           official   => 'institutional',
                           unofficial => 'non-institutional',
                       );
                       $new_user_create = '<p class="LC_warning">'
                                         .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                                         .' '
                                         .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                                             ,'<a href="'.$helplink.'">','</a>')
                                         .'</p><br />';
                   }
               }
           }
   
           $newuserscript = <<"ENDSCRIPT";
   
   function setSearch(createnew,callingForm) {
       if (createnew == 1) {
           for (var i=0; i<callingForm.srchby.length; i++) {
               if (callingForm.srchby.options[i].value == 'uname') {
                   callingForm.srchby.selectedIndex = i;
               }
           }
           for (var i=0; i<callingForm.srchin.length; i++) {
               if ( callingForm.srchin.options[i].value == 'dom') {
    callingForm.srchin.selectedIndex = i;
               }
           }
           for (var i=0; i<callingForm.srchtype.length; i++) {
               if (callingForm.srchtype.options[i].value == 'exact') {
                   callingForm.srchtype.selectedIndex = i;
               }
           }
           for (var i=0; i<callingForm.srchdomain.length; i++) {
               if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   callingForm.srchdomain.selectedIndex = i;
               }
           }
       }
   }
   ENDSCRIPT
   
       }
   
       my $output = <<"END_BLOCK";
   <script type="text/javascript">
   // <![CDATA[
   function validateEntry(callingForm) {
   
       var checkok = 1;
       var srchin;
       for (var i=0; i<callingForm.srchin.length; i++) {
    if ( callingForm.srchin[i].checked ) {
       srchin = callingForm.srchin[i].value;
    }
       }
   
       var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
       var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
       var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
       var srchterm =  callingForm.srchterm.value;
       var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
       var msg = "";
   
       if (srchterm == "") {
           checkok = 0;
           msg += "$lt{'youm'}\\n";
       }
   
       if (srchtype== 'begins') {
           if (srchterm.length < 2) {
               checkok = 0;
               msg += "$lt{'thte'}\\n";
           }
       }
   
       if (srchtype== 'contains') {
           if (srchterm.length < 3) {
               checkok = 0;
               msg += "$lt{'thet'}\\n";
           }
       }
       if (srchin == 'instd') {
           if (srchdomain == '') {
               checkok = 0;
               msg += "$lt{'yomc'}\\n";
           }
       }
       if (srchin == 'dom') {
           if (srchdomain == '') {
               checkok = 0;
               msg += "$lt{'ymcd'}\\n";
           }
       }
       if (srchby == 'lastfirst') {
           if (srchterm.indexOf(",") == -1) {
               checkok = 0;
               msg += "$lt{'whus'}\\n";
           }
           if (srchterm.indexOf(",") == srchterm.length -1) {
               checkok = 0;
               msg += "$lt{'whse'}\\n";
           }
       }
       if (checkok == 0) {
           alert("$lt{'thfo'}\\n"+msg);
           return;
       }
       if (checkok == 1) {
           callingForm.submit();
       }
   }
   
   $newuserscript
   
   // ]]>
   </script>
   
   $new_user_create
   
   END_BLOCK
   
       $output .= &Apache::lonhtmlcommon::start_pick_box().
                  &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                  $domform.
                  &Apache::lonhtmlcommon::row_closure().
                  &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                  $srchbysel.
                  $srchtypesel. 
                  '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                  $srchinsel.
                  &Apache::lonhtmlcommon::row_closure(1). 
                  &Apache::lonhtmlcommon::end_pick_box().
                  '<br />';
       return $output;
   }
   
   sub user_rule_check {
       my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
       my $response;
       if (ref($usershash) eq 'HASH') {
           foreach my $user (keys(%{$usershash})) {
               my ($uname,$udom) = split(/:/,$user);
               next if ($udom eq '' || $uname eq '');
               my ($id,$newuser);
               if (ref($usershash->{$user}) eq 'HASH') {
                   $newuser = $usershash->{$user}->{'newuser'};
                   $id = $usershash->{$user}->{'id'};
               }
               my $inst_response;
               if (ref($checks) eq 'HASH') {
                   if (defined($checks->{'username'})) {
                       ($inst_response,%{$inst_results->{$user}}) = 
                           &Apache::lonnet::get_instuser($udom,$uname);
                   } elsif (defined($checks->{'id'})) {
                       ($inst_response,%{$inst_results->{$user}}) =
                           &Apache::lonnet::get_instuser($udom,undef,$id);
                   }
               } else {
                   ($inst_response,%{$inst_results->{$user}}) =
                       &Apache::lonnet::get_instuser($udom,$uname);
                   return;
               }
               if (!$got_rules->{$udom}) {
                   my %domconfig = &Apache::lonnet::get_dom('configuration',
                                                     ['usercreation'],$udom);
                   if (ref($domconfig{'usercreation'}) eq 'HASH') {
                       foreach my $item ('username','id') {
                           if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                               $$curr_rules{$udom}{$item} = 
                                   $domconfig{'usercreation'}{$item.'_rule'};
                           }
                       }
                   }
                   $got_rules->{$udom} = 1;  
               }
               foreach my $item (keys(%{$checks})) {
                   if (ref($$curr_rules{$udom}) eq 'HASH') {
                       if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                           if (@{$$curr_rules{$udom}{$item}} > 0) {
                               my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                               foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                                   if ($rule_check{$rule}) {
                                       $$rulematch{$user}{$item} = $rule;
                                       if ($inst_response eq 'ok') {
                                           if (ref($inst_results) eq 'HASH') {
                                               if (ref($inst_results->{$user}) eq 'HASH') {
                                                   if (keys(%{$inst_results->{$user}}) == 0) {
                                                       $$alerts{$item}{$udom}{$uname} = 1;
                                                   }
                                               }
                                           }
                                       }
                                       last;
                                   }
                               }
                           }
                       }
                   }
               }
           }
       }
     return;      return;
 }  }
   
   sub user_rule_formats {
       my ($domain,$domdesc,$curr_rules,$check) = @_;
       my %text = ( 
                    'username' => 'Usernames',
                    'id'       => 'IDs',
                  );
       my $output;
       my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
       if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
           if (@{$ruleorder} > 0) {
               $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
               foreach my $rule (@{$ruleorder}) {
                   if (ref($curr_rules) eq 'ARRAY') {
                       if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                           if (ref($rules->{$rule}) eq 'HASH') {
                               $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                                           $rules->{$rule}{'desc'}.'</li>';
                           }
                       }
                   }
               }
               $output .= '</ul>';
           }
       }
       return $output;
   }
   
   sub instrule_disallow_msg {
       my ($checkitem,$domdesc,$count,$mode) = @_;
       my $response;
       my %text = (
                     item   => 'username',
                     items  => 'usernames',
                     match  => 'matches',
                     do     => 'does',
                     action => 'a username',
                     one    => 'one',
                  );
       if ($count > 1) {
           $text{'item'} = 'usernames';
           $text{'match'} ='match';
           $text{'do'} = 'do';
           $text{'action'} = 'usernames',
           $text{'one'} = 'ones';
       }
       if ($checkitem eq 'id') {
           $text{'items'} = 'IDs';
           $text{'item'} = 'ID';
           $text{'action'} = 'an ID';
           if ($count > 1) {
               $text{'item'} = 'IDs';
               $text{'action'} = 'IDs';
           }
       }
       $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
       if ($mode eq 'upload') {
           if ($checkitem eq 'username') {
               $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
           } elsif ($checkitem eq 'id') {
               $response .= &mt("Either upload a file which includes $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
           }
       } elsif ($mode eq 'selfcreate') {
           if ($checkitem eq 'id') {
               $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
           }
       } else {
           if ($checkitem eq 'username') {
               $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
           } elsif ($checkitem eq 'id') {
               $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
           }
       }
       return $response;
   }
   
   sub personal_data_fieldtitles {
       my %fieldtitles = &Apache::lonlocal::texthash (
                           id => 'Student/Employee ID',
                           permanentemail => 'E-mail address',
                           lastname => 'Last Name',
                           firstname => 'First Name',
                           middlename => 'Middle Name',
                           generation => 'Generation',
                           gen => 'Generation',
                           inststatus => 'Affiliation',
                      );
       return %fieldtitles;
   }
   
   sub sorted_inst_types {
       my ($dom) = @_;
       my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
       my $othertitle = &mt('All users');
       if ($env{'request.course.id'}) {
           $othertitle  = &mt('Any users');
       }
       my @types;
       if (ref($order) eq 'ARRAY') {
           @types = @{$order};
       }
       if (@types == 0) {
           if (ref($usertypes) eq 'HASH') {
               @types = sort(keys(%{$usertypes}));
           }
       }
       if (keys(%{$usertypes}) > 0) {
           $othertitle = &mt('Other users');
       }
       return ($othertitle,$usertypes,\@types);
   }
   
   sub get_institutional_codes {
       my ($settings,$allcourses,$LC_code) = @_;
   # Get complete list of course sections to update
       my @currsections = ();
       my @currxlists = ();
       my $coursecode = $$settings{'internal.coursecode'};
   
       if ($$settings{'internal.sectionnums'} ne '') {
           @currsections = split(/,/,$$settings{'internal.sectionnums'});
       }
   
       if ($$settings{'internal.crosslistings'} ne '') {
           @currxlists = split(/,/,$$settings{'internal.crosslistings'});
       }
   
       if (@currxlists > 0) {
           foreach (@currxlists) {
               if (m/^([^:]+):(\w*)$/) {
                   unless (grep/^$1$/,@{$allcourses}) {
                       push @{$allcourses},$1;
                       $$LC_code{$1} = $2;
                   }
               }
           }
       }
    
       if (@currsections > 0) {
           foreach (@currsections) {
               if (m/^(\w+):(\w*)$/) {
                   my $sec = $coursecode.$1;
                   my $lc_sec = $2;
                   unless (grep/^$sec$/,@{$allcourses}) {
                       push @{$allcourses},$sec;
                       $$LC_code{$sec} = $lc_sec;
                   }
               }
           }
       }
       return;
   }
   
   sub get_standard_codeitems {
       return ('Year','Semester','Department','Number','Section');
   }
   
   =pod
   
   =head1 Slot Helpers
   
   =over 4
   
   =item * sorted_slots()
   
   Sorts an array of slot names in order of slot start time (earliest first). 
   
   Inputs:
   
   =over 4
   
   slotsarr  - Reference to array of unsorted slot names.
   
   slots     - Reference to hash of hash, where outer hash keys are slot names.
   
   =back
   
   Returns:
   
   =over 4
   
   sorted   - An array of slot names sorted by the start time of the slot.
   
   =back
   
   =back
   
   =cut
   
   
   sub sorted_slots {
       my ($slotsarr,$slots) = @_;
       my @sorted;
       if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
           @sorted =
               sort {
                        if (ref($slots->{$a}) && ref($slots->{$b})) {
                            return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                        }
                        if (ref($slots->{$a})) { return -1;}
                        if (ref($slots->{$b})) { return 1;}
                        return 0;
                    } @{$slotsarr};
       }
       return @sorted;
   }
   
   
 =pod  =pod
   
 =item * get_unprocessed_cgi($query,$possible_names)  =head1 HTTP Helpers
   
   =over 4
   
   =item * &get_unprocessed_cgi($query,$possible_names)
   
 Modify the %env hash to contain unprocessed CGI form parameters held in  Modify the %env hash to contain unprocessed CGI form parameters held in
 $query.  The parameters listed in $possible_names (an array reference),  $query.  The parameters listed in $possible_names (an array reference),
Line 4052  sub get_unprocessed_cgi { Line 8321  sub get_unprocessed_cgi {
   # $Apache::lonxml::debug=1;    # $Apache::lonxml::debug=1;
   foreach my $pair (split(/&/,$query)) {    foreach my $pair (split(/&/,$query)) {
     my ($name, $value) = split(/=/,$pair);      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;
Line 4063  sub get_unprocessed_cgi { Line 8332  sub get_unprocessed_cgi {
   
 =pod  =pod
   
 =item * cacheheader()   =item * &cacheheader() 
   
 returns cache-controlling header code  returns cache-controlling header code
   
Line 4080  sub cacheheader { Line 8349  sub cacheheader {
   
 =pod  =pod
   
 =item * no_cache($r)   =item * &no_cache($r) 
   
 specifies header code to not have cache  specifies header code to not have cache
   
Line 4116  sub content_type { Line 8385  sub content_type {
   
 =pod  =pod
   
 =item * add_to_env($name,$value)   =item * &add_to_env($name,$value) 
   
 adds $name to the %env hash with value  adds $name to the %env hash with value
 $value, if $name already exists, the entry is converted to an array  $value, if $name already exists, the entry is converted to an array
Line 4143  sub add_to_env { Line 8412  sub add_to_env {
   
 =pod  =pod
   
 =item * get_env_multiple($name)   =item * &get_env_multiple($name) 
   
 gets $name from the %env hash, it seemlessly handles the cases where multiple  gets $name from the %env hash, it seemlessly handles the cases where multiple
 values may be defined and end up as an array ref.  values may be defined and end up as an array ref.
Line 4166  sub get_env_multiple { Line 8435  sub get_env_multiple {
     return(@values);      return(@values);
 }  }
   
   sub ask_for_embedded_content {
       my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
       my $upload_output = '
      <form name="upload_embedded" action="'.$actionurl.'"
                     method="post" enctype="multipart/form-data">';
       $upload_output .= $state;
       $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
   
       my $num = 0;
       foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
           $upload_output .= &start_data_table_row().
               '<td>'.$embed_file.'</td><td>';
           if ($args->{'ignore_remote_references'}
               && $embed_file =~ m{^\w+://}) {
               $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
           } elsif ($args->{'error_on_invalid_names'}
               && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
   
               $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
   
           } else {
               $upload_output .='
              <input name="embedded_item_'.$num.'" type="file" value="" />
              <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
               my $attrib = join(':',@{$$allfiles{$embed_file}});
               $upload_output .=
                   "\n\t\t".
                   '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   $attrib.'" />';
               if (exists($$codebase{$embed_file})) {
                   $upload_output .=
                       "\n\t\t".
                       '<input name="codebase_'.$num.'" type="hidden" value="'.
                       &escape($$codebase{$embed_file}).'" />';
               }
           }
           $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
           $num++;
       }
       $upload_output .= &Apache::loncommon::end_data_table().'<br />
      <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
      <input type ="submit" value="'.&mt('Upload Listed Files').'" />
      '.&mt('(only files for which a location has been provided will be uploaded)').'
      </form>';
       return $upload_output;
   }
   
   sub upload_embedded {
       my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
           $current_disk_usage) = @_;
       my $output;
       for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
           next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
           my $orig_uploaded_filename =
               $env{'form.embedded_item_'.$i.'.filename'};
   
           $env{'form.embedded_orig_'.$i} =
               &unescape($env{'form.embedded_orig_'.$i});
           my ($path,$fname) =
               ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
           # no path, whole string is fname
           if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
   
           $path = $env{'form.currentpath'}.$path;
           $fname = &Apache::lonnet::clean_filename($fname);
           # See if there is anything left
           next if ($fname eq '');
   
           # Check if file already exists as a file or directory.
           my ($state,$msg);
           if ($context eq 'portfolio') {
               my $port_path = $dirpath;
               if ($group ne '') {
                   $port_path = "groups/$group/$port_path";
               }
               ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                                                 $dir_root,$port_path,$disk_quota,
                                                 $current_disk_usage,$uname,$udom);
               if ($state eq 'will_exceed_quota'
                   || $state eq 'file_locked'
                   || $state eq 'file_exists' ) {
                   $output .= $msg;
                   next;
               }
           } elsif (($context eq 'author') || ($context eq 'testbank')) {
               ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
               if ($state eq 'exists') {
                   $output .= $msg;
                   next;
               }
           }
           # Check if extension is valid
           if (($fname =~ /\.(\w+)$/) &&
               (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
               $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
               next;
           } elsif (($fname =~ /\.(\w+)$/) &&
                    (!defined(&Apache::loncommon::fileembstyle($1)))) {
               $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
               next;
           } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
               $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
               next;
           }
   
           $env{'form.embedded_item_'.$i.'.filename'}=$fname;
           if ($context eq 'portfolio') {
               my $result=
                   &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                                                   $dirpath.$path);
               if ($result !~ m|^/uploaded/|) {
                   $output .= '<span class="LC_error">'
                         .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                              ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                         .'</span><br />';
                   next;
               } else {
                   $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                              $path.$fname.'</span>').'</p>';     
               }
           } else {
   # Save the file
               my $target = $env{'form.embedded_item_'.$i};
               my $fullpath = $dir_root.$dirpath.'/'.$path;
               my $dest = $fullpath.$fname;
               my $url = $url_root.$dirpath.'/'.$path.$fname;
               my @parts=split(/\//,$fullpath);
               my $count;
               my $filepath = $dir_root;
               for ($count=4;$count<=$#parts;$count++) {
                   $filepath .= "/$parts[$count]";
                   if ((-e $filepath)!=1) {
                       mkdir($filepath,0770);
                   }
               }
               my $fh;
               if (!open($fh,'>'.$dest)) {
                   &Apache::lonnet::logthis('Failed to create '.$dest);
                   $output .= '<span class="LC_error">'.
                              &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                              '</span><br />';
               } else {
                   if (!print $fh $env{'form.embedded_item_'.$i}) {
                       &Apache::lonnet::logthis('Failed to write to '.$dest);
                       $output .= '<span class="LC_error">'.
                                 &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                                 '</span><br />';
                   } else {
                       if ($context eq 'testbank') {
                           $output .= &mt('Embedded file uploaded successfully:').
                                      '&nbsp;<a href="'.$url.'">'.
                                      $orig_uploaded_filename.'</a><br />';
                       } else {
                           $output .= '<span class=\"LC_fontsize_large\">'.
                                      &mt('View embedded file: [_1]','<a href="'.$url.'">'.
                                      $orig_uploaded_filename.'</a>').'</span><br />';
                       }
                   }
                   close($fh);
               }
           }
       }
       return $output;
   }
   
   sub check_for_existing {
       my ($path,$fname,$element) = @_;
       my ($state,$msg);
       if (-d $path.'/'.$fname) {
           $state = 'exists';
           $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
       } elsif (-e $path.'/'.$fname) {
           $state = 'exists';
           $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
       }
       if ($state eq 'exists') {
           $msg = '<span class="LC_error">'.$msg.'</span><br />';
       }
       return ($state,$msg);
   }
   
   sub check_for_upload {
       my ($path,$fname,$group,$element,$portfolio_root,$port_path,
           $disk_quota,$current_disk_usage,$uname,$udom) = @_;
       my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
       my $getpropath = 1;
       my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                                               $getpropath);
       my $found_file = 0;
       my $locked_file = 0;
       foreach my $line (@dir_list) {
           my ($file_name)=split(/\&/,$line,2);
           if ($file_name eq $fname){
               $file_name = $path.$file_name;
               if ($group ne '') {
                   $file_name = $group.$file_name;
               }
               $found_file = 1;
               if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   $locked_file = 1;
               }
           }
       }
       if (($current_disk_usage + $filesize) > $disk_quota){
           my $msg = '<span class="LC_error">'.
                   &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                     '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
           return ('will_exceed_quota',$msg);
       } elsif ($found_file) {
           if ($locked_file) {
               my $msg = '<span class="LC_error">';
               $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
               $msg .= '</span><br />';
               $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
               return ('file_locked',$msg);
           } else {
               my $msg = '<span class="LC_error">';
               $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
               $msg .= '</span>';
               $msg .= '<br />';
               $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
               return ('file_exists',$msg);
           }
       }
   }
   
   
 =pod  =pod
   
 =back   =back
   
 =head1 CSV Upload/Handling functions  =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'}
Line 4205  sub upfile_store { Line 8700  sub upfile_store {
   
 =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'},
Line 4229  sub load_tmp_file { Line 8724  sub load_tmp_file {
   
 =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,
Line 4251  sub upfile_record_sep { Line 8746  sub upfile_record_sep {
   
 =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'}
   
Line 4283  sub record_sep { Line 8778  sub record_sep {
             $i++;              $i++;
         }          }
     } else {      } else {
         my @allfields=split(/\,/,$record);          my $separator=',';
           if ($env{'form.upfiletype'} eq 'semisv') {
               $separator=';';
           }
         my $i=0;          my $i=0;
         my $j;  # the character we are looking for to indicate the end of a quote or a record 
         for ($j=0;$j<=$#allfields;$j++) {          my $looking_for=$separator;
             my $field=$allfields[$j];  # do not add the characters to the fields
             if ($field=~/^\s*(\"|\')/) {          my $ignore=0;
  my $delimiter=$1;  # we just encountered a separator (or the beginning of the record)
                 while (($field!~/$delimiter$/) && ($j<$#allfields)) {          my $just_found_separator=1;
     $j++;  # store the field we are working on here
     $field.=','.$allfields[$j];          my $field='';
  }  # work our way through all characters in record
                 $field=~s/^\s*$delimiter//;          foreach my $character ($record=~/(.)/g) {
                 $field=~s/$delimiter\s*$//;              if ($character eq $looking_for) {
                  if ($character ne $separator) {
   # Found the end of a quote, again looking for separator
                     $looking_for=$separator;
                     $ignore=1;
                  } else {
   # Found a separator, store away what we got
                     $components{&takeleft($i)}=$field;
             $i++;
                     $just_found_separator=1;
                     $ignore=0;
                     $field='';
                  }
                  next;
             }              }
             $components{&takeleft($i)}=$field;  # single or double quotation marks after a separator indicate beginning of a quote
     $i++;  # we are now looking for the end of the quote and need to ignore separators
               if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                  $looking_for=$character;
                  next;
               }
   # ignore would be true after we reached the end of a quote
               if ($ignore) { next; }
               if (($just_found_separator) && ($character=~/\s/)) { next; }
               $field.=$character;
               $just_found_separator=0; 
         }          }
   # catch the very last entry, since we never encountered the separator
           $components{&takeleft($i)}=$field;
     }      }
     return %components;      return %components;
 }  }
Line 4309  sub record_sep { Line 8831  sub record_sep {
   
 =pod  =pod
   
 =item * upfile_select_html()  =item * &upfile_select_html()
   
 Return HTML code to select a file from the users machine and specify   Return HTML code to select a file from the users machine and specify 
 the file type.  the file type.
Line 4321  the file type. Line 8843  the file type.
 sub upfile_select_html {  sub upfile_select_html {
     my %Types = (      my %Types = (
                  csv   => &mt('CSV (comma separated values, spreadsheet)'),                   csv   => &mt('CSV (comma separated values, spreadsheet)'),
                    semisv => &mt('Semicolon separated values'),
                  space => &mt('Space separated'),                   space => &mt('Space separated'),
                  tab   => &mt('Tabulator separated'),                   tab   => &mt('Tabulator separated'),
 #                 xml   => &mt('HTML/XML'),  #                 xml   => &mt('HTML/XML'),
                  );                   );
     my $Str = '<input type="file" name="upfile" size="50" />'.      my $Str = '<input type="file" name="upfile" size="50" />'.
         '<br />Type: <select name="upfiletype">';          '<br />'.&mt('Type').': <select name="upfiletype">';
     foreach my $type (sort(keys(%Types))) {      foreach my $type (sort(keys(%Types))) {
         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";          $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
     }      }
Line 4355  sub get_samples { Line 8878  sub get_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 4367  Apache Request ref, $records is an array Line 8890  Apache Request ref, $records is an array
 ######################################################  ######################################################
 sub csv_print_samples {  sub csv_print_samples {
     my ($r,$records) = @_;      my ($r,$records) = @_;
     my $samples = &get_samples($records,3);      my $samples = &get_samples($records,5);
   
     $r->print(&mt('Samples').'<br /><table border="2"><tr>');      $r->print(&mt('Samples').'<br />'.&start_data_table().
                 &start_data_table_header_row());
     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {       foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }          $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
     $r->print('</tr>');      $r->print(&end_data_table_header_row());
     foreach my $hash (@$samples) {      foreach my $hash (@$samples) {
  $r->print('<tr>');   $r->print(&start_data_table_row());
  foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {   foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
     $r->print('<td>');      $r->print('<td>');
     if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }      if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
     $r->print('</td>');      $r->print('</td>');
  }   }
  $r->print('</tr>');   $r->print(&end_data_table_row());
     }      }
     $r->print('</tr></table><br />'."\n");      $r->print(&end_data_table().'<br />'."\n");
 }  }
   
 ######################################################  ######################################################
Line 4390  sub csv_print_samples { Line 8914  sub csv_print_samples {
   
 =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.
   
Line 4407  sub csv_print_select_table { Line 8931  sub csv_print_select_table {
     my $i=0;      my $i=0;
     my $samples = &get_samples($records,1);      my $samples = &get_samples($records,1);
     $r->print(&mt('Associate columns with student attributes.')."\n".      $r->print(&mt('Associate columns with student attributes.')."\n".
      '<table border="2"><tr>'.        &start_data_table().&start_data_table_header_row().
               '<th>'.&mt('Attribute').'</th>'.                '<th>'.&mt('Attribute').'</th>'.
               '<th>'.&mt('Column').'</th></tr>'."\n");                '<th>'.&mt('Column').'</th>'.
                 &end_data_table_header_row()."\n");
     foreach my $array_ref (@$d) {      foreach my $array_ref (@$d) {
  my ($value,$display,$defaultcol)=@{ $array_ref };   my ($value,$display,$defaultcol)=@{ $array_ref };
  $r->print('<tr><td>'.$display.'</td>');   $r->print(&start_data_table_row().'<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 my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {   foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
     $r->print('<option value="'.$sample.'"'.      $r->print('<option value="'.$sample.'"'.
                       ($sample eq $defaultcol ? ' selected="selected" ' : '').                        ($sample eq $defaultcol ? ' selected="selected" ' : '').
                       '>Column '.($sample+1).'</option>');                        '>'.&mt('Column [_1]',($sample+1)).'</option>');
  }   }
  $r->print('</select></td></tr>'."\n");   $r->print('</select></td>'.&end_data_table_row()."\n");
  $i++;   $i++;
     }      }
       $r->print(&end_data_table());
     $i--;      $i--;
     return $i;      return $i;
 }  }
Line 4434  sub csv_print_select_table { Line 8960  sub csv_print_select_table {
   
 =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 4450  sub csv_samples_select_table { Line 8976  sub csv_samples_select_table {
     my ($r,$records,$d) = @_;      my ($r,$records,$d) = @_;
     my $i=0;      my $i=0;
     #      #
     my $samples = &get_samples($records,3);      my $max_samples = 5;
     $r->print('<table border=2><tr><th>'.      my $samples = &get_samples($records,$max_samples);
               &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');      $r->print(&start_data_table().
                 &start_data_table_header_row().'<th>'.
                 &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                 &end_data_table_header_row());
   
     foreach my $key (sort(keys(%{ $samples->[0] }))) {      foreach my $key (sort(keys(%{ $samples->[0] }))) {
  $r->print('<tr><td><select name="f'.$i.'"'.   $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
   ' onchange="javascript:flip(this.form,'.$i.');">');    ' onchange="javascript:flip(this.form,'.$i.');">');
  foreach my $option (@$d) {   foreach my $option (@$d) {
     my ($value,$display,$defaultcol)=@{ $option };      my ($value,$display,$defaultcol)=@{ $option };
Line 4464  sub csv_samples_select_table { Line 8993  sub csv_samples_select_table {
                       $display.'</option>');                        $display.'</option>');
  }   }
  $r->print('</select></td><td>');   $r->print('</select></td><td>');
  foreach my $line (0..2) {   foreach my $line (0..($max_samples-1)) {
     if (defined($samples->[$line]{$key})) {       if (defined($samples->[$line]{$key})) { 
  $r->print($samples->[$line]{$key}."<br />\n");    $r->print($samples->[$line]{$key}."<br />\n"); 
     }      }
  }   }
  $r->print('</td></tr>');   $r->print('</td>'.&end_data_table_row());
  $i++;   $i++;
     }      }
       $r->print(&end_data_table());
     $i--;      $i--;
     return($i);      return($i);
 }  }
Line 4481  sub csv_samples_select_table { Line 9011  sub csv_samples_select_table {
   
 =pod  =pod
   
 =item clean_excel_name($name)  =item * &clean_excel_name($name)
   
 Returns a replacement for $name which does not contain any illegal characters.  Returns a replacement for $name which does not contain any illegal characters.
   
Line 4500  sub clean_excel_name { Line 9030  sub clean_excel_name {
   
 =pod  =pod
   
 =item * check_if_partid_hidden($id,$symb,$udom,$uname)  =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
   
 Returns either 1 or undef  Returns either 1 or undef
   
Line 4541  sub check_if_partid_hidden { Line 9071  sub check_if_partid_hidden {
   
 =over 4  =over 4
   
 =item get_cgi_id  =item * &get_cgi_id()
   
 Inputs: none  Inputs: none
   
Line 4565  sub get_cgi_id { Line 9095  sub get_cgi_id {
   
 =pod  =pod
   
 =item DrawBarGraph  =item * &DrawBarGraph()
   
 Facilitates the plotting of data in a (stacked) bar graph.  Facilitates the plotting of data in a (stacked) bar graph.
 Puts plot definition data into the users environment in order for   Puts plot definition data into the users environment in order for 
Line 4681  sub DrawBarGraph { Line 9211  sub DrawBarGraph {
     $Title  = '' if (! defined($Title));      $Title  = '' if (! defined($Title));
     $xlabel = '' if (! defined($xlabel));      $xlabel = '' if (! defined($xlabel));
     $ylabel = '' if (! defined($ylabel));      $ylabel = '' if (! defined($ylabel));
     $ValuesHash{$id.'.title'}    = &Apache::lonnet::escape($Title);      $ValuesHash{$id.'.title'}    = &escape($Title);
     $ValuesHash{$id.'.xlabel'}   = &Apache::lonnet::escape($xlabel);      $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
     $ValuesHash{$id.'.ylabel'}   = &Apache::lonnet::escape($ylabel);      $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
     $ValuesHash{$id.'.y_max_value'} = $Max;      $ValuesHash{$id.'.y_max_value'} = $Max;
     $ValuesHash{$id.'.NumBars'}  = $NumBars;      $ValuesHash{$id.'.NumBars'}  = $NumBars;
     $ValuesHash{$id.'.NumSets'}  = $NumSets;      $ValuesHash{$id.'.NumSets'}  = $NumSets;
Line 4700  sub DrawBarGraph { Line 9230  sub DrawBarGraph {
         $ValuesHash{$id.'.'.$key} = $value;          $ValuesHash{$id.'.'.$key} = $value;
     }      }
     #      #
     &Apache::lonnet::appenv(%ValuesHash);      &Apache::lonnet::appenv(\%ValuesHash);
     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';      return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
 }  }
   
Line 4709  sub DrawBarGraph { Line 9239  sub DrawBarGraph {
   
 =pod  =pod
   
 =item DrawXYGraph  =item * &DrawXYGraph()
   
 Facilitates the plotting of data in an XY graph.  Facilitates the plotting of data in an XY graph.
 Puts plot definition data into the users environment in order for   Puts plot definition data into the users environment in order for 
Line 4763  sub DrawXYGraph { Line 9293  sub DrawXYGraph {
     $ylabel = '' if (! defined($ylabel));      $ylabel = '' if (! defined($ylabel));
     my %ValuesHash =       my %ValuesHash = 
         (          (
          $id.'.title'  => &Apache::lonnet::escape($Title),           $id.'.title'  => &escape($Title),
          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),           $id.'.xlabel' => &escape($xlabel),
          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),           $id.'.ylabel' => &escape($ylabel),
          $id.'.y_max_value'=> $Max,           $id.'.y_max_value'=> $Max,
          $id.'.labels'     => join(',',@$Xlabels),           $id.'.labels'     => join(',',@$Xlabels),
          $id.'.PlotType'   => 'XY',           $id.'.PlotType'   => 'XY',
Line 4790  sub DrawXYGraph { Line 9320  sub DrawXYGraph {
         $ValuesHash{$id.'.'.$key} = $value;          $ValuesHash{$id.'.'.$key} = $value;
     }      }
     #      #
     &Apache::lonnet::appenv(%ValuesHash);      &Apache::lonnet::appenv(\%ValuesHash);
     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';      return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
 }  }
   
Line 4799  sub DrawXYGraph { Line 9329  sub DrawXYGraph {
   
 =pod  =pod
   
 =item DrawXYYGraph  =item * &DrawXYYGraph()
   
 Facilitates the plotting of data in an XY graph with two Y axes.  Facilitates the plotting of data in an XY graph with two Y axes.
 Puts plot definition data into the users environment in order for   Puts plot definition data into the users environment in order for 
Line 4860  sub DrawXYYGraph { Line 9390  sub DrawXYYGraph {
     $ylabel = '' if (! defined($ylabel));      $ylabel = '' if (! defined($ylabel));
     my %ValuesHash =       my %ValuesHash = 
         (          (
          $id.'.title'  => &Apache::lonnet::escape($Title),           $id.'.title'  => &escape($Title),
          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),           $id.'.xlabel' => &escape($xlabel),
          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),           $id.'.ylabel' => &escape($ylabel),
          $id.'.labels' => join(',',@$Xlabels),           $id.'.labels' => join(',',@$Xlabels),
          $id.'.PlotType' => 'XY',           $id.'.PlotType' => 'XY',
          $id.'.NumSets' => 2,           $id.'.NumSets' => 2,
Line 4892  sub DrawXYYGraph { Line 9422  sub DrawXYYGraph {
         $ValuesHash{$id.'.'.$key} = $value;          $ValuesHash{$id.'.'.$key} = $value;
     }      }
     #      #
     &Apache::lonnet::appenv(%ValuesHash);      &Apache::lonnet::appenv(\%ValuesHash);
     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';      return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
 }  }
   
Line 4909  Bad place for them but what the hell. Line 9439  Bad place for them but what the hell.
   
 =over 4  =over 4
   
 =item &chartlink  =item * &chartlink()
   
 Returns a link to the chart for a specific student.    Returns a link to the chart for a specific student.  
   
Line 4934  Inputs: Line 9464  Inputs:
 sub chartlink {  sub chartlink {
     my ($linktext, $sname, $sdomain) = @_;      my ($linktext, $sname, $sdomain) = @_;
     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.      my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
         '&amp;SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).          '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').          '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
        '">'.$linktext.'</a>';         '">'.$linktext.'</a>';
 }  }
Line 4948  sub chartlink { Line 9478  sub chartlink {
   
 =over 4  =over 4
   
 =item &restore_course_settings   =item * &restore_course_settings()
   
 =item &store_course_settings  =item * &store_course_settings()
   
 Restores/Store indicated form parameters from the course environment.  Restores/Store indicated form parameters from the course environment.
 Will not overwrite existing values of the form parameters.  Will not overwrite existing values of the form parameters.
Line 4964  a hash ref describing the data to be sto Line 9494  a hash ref describing the data to be sto
     'chartoutputmode' => 'scalar',      'chartoutputmode' => 'scalar',
     'chartoutputdata' => 'scalar',      'chartoutputdata' => 'scalar',
     'Section' => 'array',      'Section' => 'array',
       'Group' => 'array',
     'StudentData' => 'array',      'StudentData' => 'array',
     'Maps' => 'array');      'Maps' => 'array');
   
 Returns: both routines return nothing  Returns: both routines return nothing
   
   =back
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub store_course_settings {  sub store_course_settings {
       return &store_settings($env{'request.course.id'},@_);
   }
   
   sub store_settings {
     # save to the environment      # save to the environment
     # appenv the same items, just to be safe      # appenv the same items, just to be safe
     my $courseid = $env{'request.course.id'};  
     my $udom  = $env{'user.domain'};      my $udom  = $env{'user.domain'};
     my $uname = $env{'user.name'};      my $uname = $env{'user.name'};
     my ($prefix,$Settings) = @_;      my ($context,$prefix,$Settings) = @_;
     my %SaveHash;      my %SaveHash;
     my %AppHash;      my %AppHash;
     while (my ($setting,$type) = each(%$Settings)) {      while (my ($setting,$type) = each(%$Settings)) {
         my $basename = join('.','internal',$courseid,$prefix,$setting);          my $basename = join('.','internal',$context,$prefix,$setting);
         my $envname = 'environment.'.$basename;          my $envname = 'environment.'.$basename;
         if (exists($env{'form.'.$setting})) {          if (exists($env{'form.'.$setting})) {
             # Save this value away              # Save this value away
Line 4997  sub store_course_settings { Line 9533  sub store_course_settings {
                 if (ref($env{'form.'.$setting})) {                  if (ref($env{'form.'.$setting})) {
                     $stored_form = join(',',                      $stored_form = join(',',
                                         map {                                          map {
                                             &Apache::lonnet::escape($_);                                              &escape($_);
                                         } sort(@{$env{'form.'.$setting}}));                                          } sort(@{$env{'form.'.$setting}}));
                 } else {                  } else {
                     $stored_form =                       $stored_form = 
                         &Apache::lonnet::escape($env{'form.'.$setting});                          &escape($env{'form.'.$setting});
                 }                  }
                 # Determine if the array contents are the same.                  # Determine if the array contents are the same.
                 if ($stored_form ne $env{$envname}) {                  if ($stored_form ne $env{$envname}) {
Line 5018  sub store_course_settings { Line 9554  sub store_course_settings {
                                  'got error:'.$put_result);                                   'got error:'.$put_result);
     }      }
     # Make sure these settings stick around in this session, too      # Make sure these settings stick around in this session, too
     &Apache::lonnet::appenv(%AppHash);      &Apache::lonnet::appenv(\%AppHash);
     return;      return;
 }  }
   
 sub restore_course_settings {  sub restore_course_settings {
     my $courseid = $env{'request.course.id'};      return &restore_settings($env{'request.course.id'},@_);
     my ($prefix,$Settings) = @_;  }
   
   sub restore_settings {
       my ($context,$prefix,$Settings) = @_;
     while (my ($setting,$type) = each(%$Settings)) {      while (my ($setting,$type) = each(%$Settings)) {
         next if (exists($env{'form.'.$setting}));          next if (exists($env{'form.'.$setting}));
         my $envname = 'environment.internal.'.$courseid.'.'.$prefix.          my $envname = 'environment.internal.'.$context.'.'.$prefix.
             '.'.$setting;              '.'.$setting;
         if (exists($env{$envname})) {          if (exists($env{$envname})) {
             if ($type eq 'scalar') {              if ($type eq 'scalar') {
Line 5035  sub restore_course_settings { Line 9574  sub restore_course_settings {
             } elsif ($type eq 'array') {              } elsif ($type eq 'array') {
                 $env{'form.'.$setting} = [                   $env{'form.'.$setting} = [ 
                                            map {                                              map { 
                                                &Apache::lonnet::unescape($_);                                                  &unescape($_); 
                                            } split(',',$env{$envname})                                             } split(',',$env{$envname})
                                            ];                                             ];
             }              }
Line 5043  sub restore_course_settings { Line 9582  sub restore_course_settings {
     }      }
 }  }
   
   #######################################################
   #######################################################
   
   =pod
   
   =head1 Domain E-mail Routines  
   
   =over 4
   
   =item * &build_recipient_list()
   
   Build recipient lists for five types of e-mail:
   (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
   (d) Help requests, (e) Course requests needing approval,  generated by
   lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
   loncoursequeueadmin.pm respectively.
   
   Inputs:
   defmail (scalar - email address of default recipient), 
   mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
   defdom (domain for which to retrieve configuration settings),
   origmail (scalar - email address of recipient from loncapa.conf, 
   i.e., predates configuration by DC via domainprefs.pm 
   
   Returns: comma separated list of addresses to which to send e-mail.
   
   =back
   
   =cut
   
 ############################################################  ############################################################
 ############################################################  ############################################################
   sub build_recipient_list {
       my ($defmail,$mailing,$defdom,$origmail) = @_;
       my @recipients;
       my $otheremails;
       my %domconfig =
            &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
       if (ref($domconfig{'contacts'}) eq 'HASH') {
           if (exists($domconfig{'contacts'}{$mailing})) {
               if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   my @contacts = ('adminemail','supportemail');
                   foreach my $item (@contacts) {
                       if ($domconfig{'contacts'}{$mailing}{$item}) {
                           my $addr = $domconfig{'contacts'}{$item}; 
                           if (!grep(/^\Q$addr\E$/,@recipients)) {
                               push(@recipients,$addr);
                           }
                       }
                       $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   }
               }
           } elsif ($origmail ne '') {
               push(@recipients,$origmail);
           }
       } elsif ($origmail ne '') {
           push(@recipients,$origmail);
       }
       if (defined($defmail)) {
           if ($defmail ne '') {
               push(@recipients,$defmail);
           }
       }
       if ($otheremails) {
           my @others;
           if ($otheremails =~ /,/) {
               @others = split(/,/,$otheremails);
           } else {
               push(@others,$otheremails);
           }
           foreach my $addr (@others) {
               if (!grep(/^\Q$addr\E$/,@recipients)) {
                   push(@recipients,$addr);
               }
           }
       }
       my $recipientlist = join(',',@recipients); 
       return $recipientlist;
   }
   
 sub propath {  ############################################################
     my ($udom,$uname)=@_;  ############################################################
     $udom=~s/\W//g;  
     $uname=~s/\W//g;  =pod
     my $subdir=$uname.'__';  
     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;  =head1 Course Catalog Routines
     my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";  
     return $proname;  =over 4
 }   
   =item * &gather_categories()
   
   Converts category definitions - keys of categories hash stored in  
   coursecategories in configuration.db on the primary library server in a 
   domain - to an array.  Also generates javascript and idx hash used to 
   generate Domain Coordinator interface for editing Course Categories.
   
   Inputs:
   
   categories (reference to hash of category definitions).
   
   cats (reference to array of arrays/hashes which encapsulates hierarchy of
         categories and subcategories).
   
   idx (reference to hash of counters used in Domain Coordinator interface for 
         editing Course Categories).
   
   jsarray (reference to array of categories used to create Javascript arrays for
            Domain Coordinator interface for editing Course Categories).
   
   Returns: nothing
   
   Side effects: populates cats, idx and jsarray. 
   
   =cut
   
   sub gather_categories {
       my ($categories,$cats,$idx,$jsarray) = @_;
       my %counters;
       my $num = 0;
       foreach my $item (keys(%{$categories})) {
           my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
           if ($container eq '' && $depth == 0) {
               $cats->[$depth][$categories->{$item}] = $cat;
           } else {
               $cats->[$depth]{$container}[$categories->{$item}] = $cat;
           }
           my ($escitem,$tail) = split(/:/,$item,2);
           if ($counters{$tail} eq '') {
               $counters{$tail} = $num;
               $num ++;
           }
           if (ref($idx) eq 'HASH') {
               $idx->{$item} = $counters{$tail};
           }
           if (ref($jsarray) eq 'ARRAY') {
               push(@{$jsarray->[$counters{$tail}]},$item);
           }
       }
       return;
   }
   
   =pod
   
   =item * &extract_categories()
   
   Used to generate breadcrumb trails for course categories.
   
   Inputs:
   
   categories (reference to hash of category definitions).
   
   cats (reference to array of arrays/hashes which encapsulates hierarchy of
         categories and subcategories).
   
   trails (reference to array of breacrumb trails for each category).
   
   allitems (reference to hash - key is category key 
            (format: escaped(name):escaped(parent category):depth in hierarchy).
   
   idx (reference to hash of counters used in Domain Coordinator interface for
         editing Course Categories).
   
   jsarray (reference to array of categories used to create Javascript arrays for
            Domain Coordinator interface for editing Course Categories).
   
   subcats (reference to hash of arrays containing all subcategories within each 
            category, -recursive)
   
   Returns: nothing
   
   Side effects: populates trails and allitems hash references.
   
   =cut
   
   sub extract_categories {
       my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
       if (ref($categories) eq 'HASH') {
           &gather_categories($categories,$cats,$idx,$jsarray);
           if (ref($cats->[0]) eq 'ARRAY') {
               for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   my $name = $cats->[0][$i];
                   my $item = &escape($name).'::0';
                   my $trailstr;
                   if ($name eq 'instcode') {
                       $trailstr = &mt('Official courses (with institutional codes)');
                   } elsif ($name eq 'communities') {
                       $trailstr = &mt('Communities');
                   } else {
                       $trailstr = $name;
                   }
                   if ($allitems->{$item} eq '') {
                       push(@{$trails},$trailstr);
                       $allitems->{$item} = scalar(@{$trails})-1;
                   }
                   my @parents = ($name);
                   if (ref($cats->[1]{$name}) eq 'ARRAY') {
                       for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                           my $category = $cats->[1]{$name}[$j];
                           if (ref($subcats) eq 'HASH') {
                               push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                           }
                           &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                       }
                   } else {
                       if (ref($subcats) eq 'HASH') {
                           $subcats->{$item} = [];
                       }
                   }
               }
           }
       }
       return;
   }
   
   =pod
   
   =item *&recurse_categories()
   
   Recursively used to generate breadcrumb trails for course categories.
   
   Inputs:
   
   cats (reference to array of arrays/hashes which encapsulates hierarchy of
         categories and subcategories).
   
   depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
   
   category (current course category, for which breadcrumb trail is being generated).
   
   trails (reference to array of breadcrumb trails for each category).
   
   allitems (reference to hash - key is category key
            (format: escaped(name):escaped(parent category):depth in hierarchy).
   
   parents (array containing containers directories for current category, 
            back to top level). 
   
   Returns: nothing
   
   Side effects: populates trails and allitems hash references
   
   =cut
   
   sub recurse_categories {
       my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
       my $shallower = $depth - 1;
       if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
           for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
               my $name = $cats->[$depth]{$category}[$k];
               my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
               my $trailstr = join(' -&gt; ',(@{$parents},$category));
               if ($allitems->{$item} eq '') {
                   push(@{$trails},$trailstr);
                   $allitems->{$item} = scalar(@{$trails})-1;
               }
               my $deeper = $depth+1;
               push(@{$parents},$category);
               if (ref($subcats) eq 'HASH') {
                   my $subcat = &escape($name).':'.$category.':'.$depth;
                   for (my $j=@{$parents}; $j>=0; $j--) {
                       my $higher;
                       if ($j > 0) {
                           $higher = &escape($parents->[$j]).':'.
                                     &escape($parents->[$j-1]).':'.$j;
                       } else {
                           $higher = &escape($parents->[$j]).'::'.$j;
                       }
                       push(@{$subcats->{$higher}},$subcat);
                   }
               }
               &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                                   $subcats);
               pop(@{$parents});
           }
       } else {
           my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
           my $trailstr = join(' -&gt; ',(@{$parents},$category));
           if ($allitems->{$item} eq '') {
               push(@{$trails},$trailstr);
               $allitems->{$item} = scalar(@{$trails})-1;
           }
       }
       return;
   }
   
   =pod
   
   =item *&assign_categories_table()
   
   Create a datatable for display of hierarchical categories in a domain,
   with checkboxes to allow a course to be categorized. 
   
   Inputs:
   
   cathash - reference to hash of categories defined for the domain (from
             configuration.db)
   
   currcat - scalar with an & separated list of categories assigned to a course. 
   
   type    - scalar contains course type (Course or Community).
   
   Returns: $output (markup to be displayed) 
   
   =cut
   
   sub assign_categories_table {
       my ($cathash,$currcat,$type) = @_;
       my $output;
       if (ref($cathash) eq 'HASH') {
           my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
           &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
           $maxdepth = scalar(@cats);
           if (@cats > 0) {
               my $itemcount = 0;
               if (ref($cats[0]) eq 'ARRAY') {
                   my @currcategories;
                   if ($currcat ne '') {
                       @currcategories = split('&',$currcat);
                   }
                   my $table;
                   for (my $i=0; $i<@{$cats[0]}; $i++) {
                       my $parent = $cats[0][$i];
                       next if ($parent eq 'instcode');
                       if ($type eq 'Community') {
                           next unless ($parent eq 'communities');
                       } else {
                           next if ($parent eq 'communities');
                       }
                       my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                       my $item = &escape($parent).'::0';
                       my $checked = '';
                       if (@currcategories > 0) {
                           if (grep(/^\Q$item\E$/,@currcategories)) {
                               $checked = ' checked="checked"';
                           }
                       }
                       my $parent_title = $parent;
                       if ($parent eq 'communities') {
                           $parent_title = &mt('Communities');
                       }
                       $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                                 '<input type="checkbox" name="usecategory" value="'.
                                 $item.'"'.$checked.' />'.$parent_title.'</span>'.
                                 '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
                       my $depth = 1;
                       push(@path,$parent);
                       $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                       pop(@path);
                       $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                       $itemcount ++;
                   }
                   if ($itemcount) {
                       $output = &Apache::loncommon::start_data_table().
                                 $table.
                                 &Apache::loncommon::end_data_table();
                   }
               }
           }
       }
       return $output;
   }
   
   =pod
   
   =item *&assign_category_rows()
   
   Create a datatable row for display of nested categories in a domain,
   with checkboxes to allow a course to be categorized,called recursively.
   
   Inputs:
   
   itemcount - track row number for alternating colors
   
   cats - reference to array of arrays/hashes which encapsulates hierarchy of
         categories and subcategories.
   
   depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
   
   parent - parent of current category item
   
   path - Array containing all categories back up through the hierarchy from the
          current category to the top level.
   
   currcategories - reference to array of current categories assigned to the course
   
   Returns: $output (markup to be displayed).
   
   =cut
   
   sub assign_category_rows {
       my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
       my ($text,$name,$item,$chgstr);
       if (ref($cats) eq 'ARRAY') {
           my $maxdepth = scalar(@{$cats});
           if (ref($cats->[$depth]) eq 'HASH') {
               if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   my $numchildren = @{$cats->[$depth]{$parent}};
                   my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   $text .= '<td><table class="LC_datatable">';
                   for (my $j=0; $j<$numchildren; $j++) {
                       $name = $cats->[$depth]{$parent}[$j];
                       $item = &escape($name).':'.&escape($parent).':'.$depth;
                       my $deeper = $depth+1;
                       my $checked = '';
                       if (ref($currcategories) eq 'ARRAY') {
                           if (@{$currcategories} > 0) {
                               if (grep(/^\Q$item\E$/,@{$currcategories})) {
                                   $checked = ' checked="checked"';
                               }
                           }
                       }
                       $text .= '<tr><td><span class="LC_nobreak"><label>'.
                                '<input type="checkbox" name="usecategory" value="'.
                                $item.'"'.$checked.' />'.$name.'</label></span>'.
                                '<input type="hidden" name="catname" value="'.$name.'" />'.
                                '</td><td>';
                       if (ref($path) eq 'ARRAY') {
                           push(@{$path},$name);
                           $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                           pop(@{$path});
                       }
                       $text .= '</td></tr>';
                   }
                   $text .= '</table></td>';
               }
           }
       }
       return $text;
   }
   
   ############################################################
   ############################################################
   
   
   sub commit_customrole {
       my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
       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,undef,undef,$context).
                    '</b><br />';
       return $output;
   }
   
   sub commit_standardrole {
       my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
       my ($output,$logmsg,$linefeed);
       if ($context eq 'auto') {
           $linefeed = "\n";
       } else {
           $linefeed = "<br />\n";
       }  
       if ($three eq 'st') {
           my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                                            $one,$two,$sec,$context);
           if (($result =~ /^error/) || ($result eq 'not_in_class') || 
               ($result eq 'unknown_course') || ($result eq 'refused')) {
               $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
           } else {
               $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
                  ($start?', '.&mt('starting').' '.localtime($start):'').
                  ($end?', '.&mt('ending').' '.localtime($end):'').': ';
               if ($context eq 'auto') {
                   $output .= $result.$linefeed.&mt('Add to classlist').': ok';
               } else {
                  $output .= '<b>'.$result.'</b>'.$linefeed.
                  &mt('Add to classlist').': <b>ok</b>';
               }
               $output .= $linefeed;
           }
       } else {
           $output = &mt('Assigning').' '.$three.' in '.$url.
                  ($start?', '.&mt('starting').' '.localtime($start):'').
                  ($end?', '.&mt('ending').' '.localtime($end):'').': ';
           my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
           if ($context eq 'auto') {
               $output .= $result.$linefeed;
           } else {
               $output .= '<b>'.$result.'</b>'.$linefeed;
           }
       }
       return $output;
   }
   
   sub commit_studentrole {
       my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
       my ($result,$linefeed,$oldsecurl,$newsecurl);
       if ($context eq 'auto') {
           $linefeed = "\n";
       } else {
           $linefeed = '<br />'."\n";
       }
       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;
           if ($oldsec ne '-1') { 
               if ($oldsec ne $sec) {
                   $secchange = 1;
                   my $now = time;
                   my $uurl='/'.$cid;
                   $uurl=~s/\_/\//g;
                   if ($oldsec) {
                       $uurl.='/'.$oldsec;
                   }
                   $oldsecurl = $uurl;
                   $expire_role_result = 
                       &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
                   if ($env{'request.course.sec'} ne '') { 
                       if ($expire_role_result eq 'refused') {
                           my @roles = ('st');
                           my @statuses = ('previous');
                           my @roledoms = ($one);
                           my $withsec = 1;
                           my %roleshash = 
                               &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                                                 \@statuses,\@roles,\@roledoms,$withsec);
                           if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                               my ($oldstart,$oldend) = 
                                   split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                               if ($oldend > 0 && $oldend <= $now) {
                                   $expire_role_result = 'ok';
                               }
                           }
                       }
                   }
                   $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,'',$context);
               if ($modify_section_result =~ /^ok/) {
                   if ($secchange == 1) {
                       if ($sec eq '') {
                           $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                       } else {
                           $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                       }
                   } elsif ($oldsec eq '-1') {
                       if ($sec eq '') {
                           $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                       } else {
                           $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                       }
                   } else {
                       if ($sec eq '') {
                           $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                       } else {
                           $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                       }
                   }
               } else {
                   if ($secchange) {       
                       $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
                   } else {
                       $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   }
               }
               $result = $modify_section_result;
           } elsif ($secchange == 1) {
               if ($oldsec eq '') {
                   $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
               } else {
                   $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
               }
               if ($expire_role_result eq 'refused') {
                   my $newsecurl = '/'.$cid;
                   $newsecurl =~ s/\_/\//g;
                   if ($sec ne '') {
                       $newsecurl.='/'.$sec;
                   }
                   if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                       if ($sec eq '') {
                           $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
                       } else {
                           $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
                       }
                   }
               }
           }
       } else {
           $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
           $result = "error: incomplete course id\n";
       }
       return $result;
   }
   
   ############################################################
   ############################################################
   
   sub check_clone {
       my ($args,$linefeed) = @_;
       my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
       my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
       my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
       my $clonemsg;
       my $can_clone = 0;
       my $lctype = lc($args->{'crstype'});
       if ($lctype ne 'community') {
           $lctype = 'course';
       }
       if ($clonehome eq 'no_host') {
           if ($args->{'crstype'} eq 'Community') {
               $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
           } else {
               $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
           }     
       } else {
    my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
           if ($args->{'crstype'} eq 'Community') {
               if ($clonedesc{'type'} ne 'Community') {
                    $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   return ($can_clone, $clonemsg, $cloneid, $clonehome);
               }
           }
    if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
               (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
       $can_clone = 1;
    } else {
       my %clonehash = &Apache::lonnet::get('environment',['cloners'],
    $args->{'clonedomain'},$args->{'clonecourse'});
       my @cloners = split(/,/,$clonehash{'cloners'});
               if (grep(/^\*$/,@cloners)) {
                   $can_clone = 1;
               } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   $can_clone = 1;
               } else {
                   my $ccrole = 'cc';
                   if ($args->{'crstype'} eq 'Community') {
                       $ccrole = 'co';
                   }
           my %roleshash =
       &Apache::lonnet::get_my_roles($args->{'ccuname'},
    $args->{'ccdomain'},
                                            'userroles',['active'],[$ccrole],
    [$args->{'clonedomain'}]);
           if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                       $can_clone = 1;
                   } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                       $can_clone = 1;
                   } else {
                       if ($args->{'crstype'} eq 'Community') {
                           $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                       } else {
                           $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                       }
           }
       }
           }
       }
       return ($can_clone, $clonemsg, $cloneid, $clonehome);
   }
   
   sub construct_course {
       my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
       my $outcome;
       my $linefeed =  '<br />'."\n";
       if ($context eq 'auto') {
           $linefeed = "\n";
       }
   
   #
   # Are we cloning?
   #
       my ($can_clone, $clonemsg, $cloneid, $clonehome);
       if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
    ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
    if ($context ne 'auto') {
               if ($clonemsg ne '') {
           $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
               }
    }
    $outcome .= $clonemsg.$linefeed;
   
           if (!$can_clone) {
       return (0,$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'},
                                                $cnum,$context,$category);
   
       # 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]',$crstype,$$courseid).$linefeed;
       if ($$courseid =~ /^error:/) {
           return (0,$outcome);
       }
   
   #
   # Check if created correctly
   #
       ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
       my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
       if ($crsuhome eq 'no_host') {
           $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
           return (0,$outcome);
       }
       $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
   
   #
   # Do the cloning
   #   
       if ($can_clone && $cloneid) {
    $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
    if ($context ne 'auto') {
       $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
    }
    $outcome .= $clonemsg.$linefeed;
    my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
   # Copy all files
    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
   # Restore URL
    $cenv{'url'}=$oldcenv{'url'};
   # Restore title
    $cenv{'description'}=$oldcenv{'description'};
   # Restore creation date, creator and creation context.
           $cenv{'internal.created'}=$oldcenv{'internal.created'};
           $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
           $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
   # Mark as cloned
    $cenv{'clonedfrom'}=$cloneid;
   # Need to clone grading mode
           my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
           $cenv{'grading'}=$newenv{'grading'};
   # Do not clone these environment entries
           &Apache::lonnet::del('environment',
                     ['default_enrollment_start_date',
                      'default_enrollment_end_date',
                      'question.email',
                      'policy.email',
                      'comment.email',
                      'pch.users.denied',
                      'plc.users.denied',
                      'hidefromcat',
                      'categories'],
                      $$crsudom,$$crsunum);
       }
   
   #
   # 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'
           );
           my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                              ' ('.$lt{'adby'}.')';
           if ($context eq 'auto') {
               $outcome .= $badclass_msg.$linefeed;
               $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
               foreach my $item (@badclasses) {
                   if ($context eq 'auto') {
                       $outcome .= " - $item\n";
                   } else {
                       $outcome .= "<li>$item</li>\n";
                   }
               }
               if ($context eq 'auto') {
                   $outcome .= $linefeed;
               } else {
                   $outcome .= "</ul><br /><br /></div>\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 '') {
               my $krb_msg = &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'); 
               if ($context eq 'auto') {
                   $outcome .= $krb_msg;
               } else {
                   $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
               }
               $outcome .= $linefeed;
           }
       }
       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 .= $linefeed.&mt('Setting environment').': '.                 
             &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
   #
   # 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).$linefeed;
      }
   #
   # 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=&mt('Syllabus');
               $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
           } else {
               $title=&mt('Table of 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').$linefeed;
       }
   
       return (1,$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',
                     'Community' => 'group',
                   );
       return $names{$crstype};
   }
   
   sub course_types {
       my @types = ('official','unofficial','community');
       my %typename = (
                            official   => 'Official course',
                            unofficial => 'Unofficial course',
                            community  => 'Community',
                      );
       return (\@types,\%typename);
   }
   
 sub icon {  sub icon {
     my ($file)=@_;      my ($file)=@_;
     my $curfext = (split(/\./,$file))[-1];      my $curfext = lc((split(/\./,$file))[-1]);
     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';      my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
     my $embstyle = &Apache::loncommon::fileembstyle($curfext);      my $embstyle = &Apache::loncommon::fileembstyle($curfext);
     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {      if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
Line 5073  sub icon { Line 10631  sub icon {
 }   } 
   
 sub lonhttpdurl {  sub lonhttpdurl {
   #
   # Had been used for "small fry" static images on separate port 8080.
   # Modify here if lightweight http functionality desired again.
   # Currently eliminated due to increasing firewall issues.
   #
     my ($url)=@_;      my ($url)=@_;
     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};      return $url;
     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }  
     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;  
 }  }
   
 sub connection_aborted {  sub connection_aborted {
Line 5108  sub escape_double { Line 10669  sub escape_double {
 sub escape_url {  sub escape_url {
     my ($url)   = @_;      my ($url)   = @_;
     my @urlslices = split(/\//, $url,-1);      my @urlslices = split(/\//, $url,-1);
     my $lastitem = &Apache::lonnet::escape(pop(@urlslices));      my $lastitem = &escape(pop(@urlslices));
     return join('/',@urlslices).'/'.$lastitem;      return join('/',@urlslices).'/'.$lastitem;
 }  }
   
   sub compare_arrays {
       my ($arrayref1,$arrayref2) = @_;
       my (@difference,%count);
       @difference = ();
       %count = ();
       if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
           foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
           foreach my $element (keys(%count)) {
               if ($count{$element} == 1) {
                   push(@difference,$element);
               }
           }
       }
       return @difference;
   }
   
   # -------------------------------------------------------- Initialize 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.$$.int(rand(10000)));
    $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);
   
   # ------------------------------------------------------------- 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 ('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'};
    }
           my %is_adv = ( is_adv => $env{'user.adv'} );
           my %domdef = &Apache::lonnet::get_domain_defaults($domain);
   
           foreach my $tool ('aboutme','blog','portfolio') {
               $userenv{'availabletools.'.$tool} = 
                   &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                                                     undef,\%userenv,\%domdef,\%is_adv);
           }
   
           foreach my $crstype ('official','unofficial','community') {
               $userenv{'canrequest.'.$crstype} =
                   &Apache::lonnet::usertools_access($username,$domain,$crstype,
                                                     'reload','requestcourses',
                                                     \%userenv,\%domdef,\%is_adv);
           }
   
    $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("<span style=\"color:blue;\">WARNING: ".
      'Could not create environment storage in lonauth: '.$!.'</span>');
       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) = @_;
       if (ref($env_data) eq 'HASH') {
           while (my ($key,$value) = each(%$env_data)) {
       $idf->{$prefix.$key} = $value;
       $env{$prefix.$key}   = $value;
           }
       }
   }
   
   # --- Get the symbolic name of a problem and the url
   sub get_symb {
       my ($request,$silent) = @_;
       (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
       my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
       if ($symb eq '') {
           if (!$silent) {
               $request->print("Unable to handle ambiguous references:$url:.");
               return ();
           }
       }
       &Apache::lonenc::check_decrypt(\$symb);
       return ($symb);
   }
   
   # --------------------------------------------------------------Get annotation
   
   sub get_annotation {
       my ($symb,$enc) = @_;
   
       my $key = $symb;
       if (!$enc) {
           $key =
               &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
       }
       my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
       return $annotation{$key};
   }
   
   sub clean_symb {
       my ($symb,$delete_enc) = @_;
   
       &Apache::lonenc::check_decrypt(\$symb);
       my $enc = $env{'request.enc'};
       if ($delete_enc) {
           delete($env{'request.enc'});
       }
   
       return ($symb,$enc);
   }
   
 =pod  =pod
   
 =back  =back
Removed from v.1.358  
changed lines
  Added in v.1.948.2.11

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